weseek__growi/packages/core/src/interfaces/page.ts

import type { Ref } from './common';
import type { HasObjectId } from './has-object-id';
import type {
  HasRevisionShortbody,
  IRevision,
  IRevisionHasId,
} from './revision';
import type { SubscriptionStatusType } from './subscription';
import type { ITag } from './tag';
import type { IUser, IUserGroup, IUserGroupHasId, IUserHasId } from './user';

export const GroupType = {
  userGroup: 'UserGroup',
  externalUserGroup: 'ExternalUserGroup',
} as const;
export type GroupType = (typeof GroupType)[keyof typeof GroupType];

export type IGrantedGroup = {
  type: GroupType;
  item: Ref<IUserGroup>;
};

export type IPage = {
  path: string;
  status: string;
  revision?: Ref<IRevision>;
  tags: Ref<ITag>[];
  creator?: Ref<IUser>;
  createdAt: Date;
  updatedAt: Date;
  seenUsers: Ref<IUser>[];
  parent: Ref<IPage> | null;
  descendantCount: number;
  isEmpty: boolean;
  grant: PageGrant;
  grantedUsers: Ref<IUser>[];
  grantedGroups: IGrantedGroup[];
  lastUpdateUser?: Ref<IUser>;
  liker: Ref<IUser>[];
  commentCount: number;
  slackChannels: string;
  deleteUser: Ref<IUser>;
  deletedAt: Date;
  latestRevision?: Ref<IRevision>;
  latestRevisionBodyLength?: number;
  expandContentWidth?: boolean;
  wip?: boolean;
  ttlTimestamp?: Date;
};

export type IPagePopulatedToShowRevision = Omit<
  IPageHasId,
  | 'lastUpdateUser'
  | 'creator'
  | 'deleteUser'
  | 'grantedGroups'
  | 'revision'
  | 'author'
> & {
  lastUpdateUser?: IUserHasId;
  creator?: IUserHasId;
  deleteUser: IUserHasId;
  grantedGroups: { type: GroupType; item: IUserGroupHasId }[];
  revision?: IRevisionHasId;
  author: IUserHasId;
};

export const PageGrant = {
  GRANT_PUBLIC: 1,
  GRANT_RESTRICTED: 2,
  GRANT_SPECIFIED: 3, // DEPRECATED
  GRANT_OWNER: 4,
  GRANT_USER_GROUP: 5,
} as const;
type UnionPageGrantKeys = keyof typeof PageGrant;
export type PageGrant = (typeof PageGrant)[UnionPageGrantKeys];

export const PageStatus = {
  STATUS_PUBLISHED: 'published',
  STATUS_DELETED: 'deleted',
} as const;
export type PageStatus = (typeof PageStatus)[keyof typeof PageStatus];

export type IPageHasId = IPage & HasObjectId;

export type IPageNotFoundInfo = {
  isNotFound: true;
  isForbidden: boolean;
  isEmpty?: true;
};

export type IPageInfo = {
  isNotFound: boolean;
  isV5Compatible: boolean;
  isEmpty: boolean;
  isMovable: boolean;
  isDeletable: boolean;
  isAbleToDeleteCompletely: boolean;
  isRevertible: boolean;
  bookmarkCount: number;
};

export type IPageInfoForEntity = Omit<IPageInfo, 'isNotFound' | 'isEmpty'> & {
  isNotFound: false;
  isEmpty: false;
  sumOfLikers: number;
  likerIds: string[];
  sumOfSeenUsers: number;
  seenUserIds: string[];
  contentAge: number;
  descendantCount: number;
  commentCount: number;
  latestRevisionId: Ref<IRevision>;
};

export type IPageInfoForOperation = IPageInfoForEntity & {
  isBookmarked?: boolean;
  isLiked?: boolean;
  subscriptionStatus?: SubscriptionStatusType;
};

export type IPageInfoForListing = IPageInfoForEntity & HasRevisionShortbody;

export type IPageInfoExt =
  | IPageInfo
  | IPageInfoForEntity
  | IPageInfoForOperation
  | IPageInfoForListing;

export const isIPageNotFoundInfo = (
  // biome-ignore lint/suspicious/noExplicitAny: ignore
  pageInfo: any | undefined,
): pageInfo is IPageNotFoundInfo => {
  return (
    pageInfo != null &&
    pageInfo instanceof Object &&
    pageInfo.isNotFound === true
  );
};

export const isIPageInfo = (
  // biome-ignore lint/suspicious/noExplicitAny: ignore
  pageInfo: any | undefined,
): pageInfo is IPageInfo => {
  return (
    pageInfo != null && pageInfo instanceof Object && 'isEmpty' in pageInfo
  );
};

export const isIPageInfoForEntity = (
  // biome-ignore lint/suspicious/noExplicitAny: ignore
  pageInfo: any | undefined,
): pageInfo is IPageInfoForEntity => {
  return isIPageInfo(pageInfo) && pageInfo.isEmpty === false;
};

export const isIPageInfoForOperation = (
  // biome-ignore lint/suspicious/noExplicitAny: ignore
  pageInfo: any | undefined,
): pageInfo is IPageInfoForOperation => {
  return (
    isIPageInfoForEntity(pageInfo) &&
    ('isBookmarked' in pageInfo ||
      'isLiked' in pageInfo ||
      'subscriptionStatus' in pageInfo)
  );
};

export const isIPageInfoForListing = (
  // biome-ignore lint/suspicious/noExplicitAny: ignore
  pageInfo: any | undefined,
): pageInfo is IPageInfoForListing => {
  return isIPageInfoForEntity(pageInfo) && 'revisionShortBody' in pageInfo;
};

export type IDataWithMeta<D = unknown, M = unknown> = {
  data: D;
  meta?: M;
};
export type IDataWithRequiredMeta<D = unknown, M = unknown> = IDataWithMeta<
  D,
  M
> & { meta: M };

export type IPageWithMeta<M = IPageInfoExt> = IDataWithMeta<IPageHasId, M>;

export type IPageToDeleteWithMeta<T = IPageInfoForEntity | unknown> =
  IDataWithMeta<
    HasObjectId & (IPage | { path: string; revision: string | null }),
    T
  >;
export type IPageToRenameWithMeta<T = IPageInfoForEntity | unknown> =
  IPageToDeleteWithMeta<T>;