@crowi/api 2.0.0-alpha.0

package/dist/models/page.d.ts

@@ -0,0 +1,200 @@
+import { Document, Model, Types } from 'mongoose';
+import Crowi from '../crowi';
+export declare const GRANT_PUBLIC = 1;
+export declare const GRANT_RESTRICTED = 2;
+export declare const GRANT_SPECIFIED = 3;
+export declare const GRANT_OWNER = 4;
+export declare const GRANTS: readonly [1, 2, 3, 4];
+export declare const PAGE_GRANT_ERROR = 1;
+export declare const STATUS_WIP = "wip";
+export declare const STATUS_PUBLISHED = "published";
+export declare const STATUS_DELETED = "deleted";
+export declare const STATUS_DEPRECATED = "deprecated";
+/**
+ * RFC-0004: first-class draft state. A page created via `POST
+ * /api/v2/pages/drafts` (Phase 3) starts as `draft` and transitions to
+ * `published` exactly once when the author first saves. The transition
+ * is one-way — there is no path back to `draft`. Draft pages are
+ * visible only to their author: listing / search / backlink queries
+ * exclude other users' drafts (see `findListByStartWith` /
+ * `findListByCreator`), and collab WebSocket connections to a draft
+ * page are rejected for non-authors (see `routes/ts-rest/page-collab.ts`
+ * + `@crowi/collab` `onAuthenticate`).
+ */
+export declare const STATUS_DRAFT = "draft";
+export declare const STATUSES: readonly ["wip", "published", "deleted", "deprecated", "draft"];
+/**
+ * A user's home page (`/user/<username>`). Its path is bound to the
+ * username, so it can be neither renamed nor deleted (it is also not a
+ * valid rename *destination*). Tolerates an optional trailing slash for
+ * defence-in-depth. Deeper pages under the home (`/user/<name>/memo`)
+ * are normal pages and are NOT matched. Shared by `isDeletableName` /
+ * `isRenamableName` so the two guards never drift; mirrors the web
+ * `isUserHomePath`.
+ */
+export declare const USER_HOME_PAGE_PATH: RegExp;
+/**
+ * `$or` status clause for "pages visible to a given viewer" (RFC-0004):
+ * published and legacy-null pages are always visible; a `draft` page is
+ * visible only to its creator.
+ *
+ * When the surrounding query is already pinned to a single `creator`,
+ * pass that as `creatorId` — the draft clause is then a bare
+ * `{ status: 'draft' }`, included only when `viewerId === creatorId`.
+ * When the query spans multiple creators, omit `creatorId` — the draft
+ * clause carries its own `creator: viewerId` constraint.
+ */
+export declare function visiblePageStatusOr(viewerId: Types.ObjectId | string, creatorId?: Types.ObjectId | string): Array<Record<string, unknown>>;
+/**
+ * `$or` grant clause for "pages readable by a given user": public and
+ * legacy-null pages are always readable; restricted / specified / owner
+ * pages only when the user is in `grantedUsers`.
+ */
+export declare function visiblePageGrantOr(userId: Types.ObjectId | string): Array<Record<string, unknown>>;
+export declare const TYPE_PORTAL = "portal";
+export declare const TYPE_USER = "user";
+export declare const TYPE_PUBLIC = "public";
+export declare const TYPES: readonly ["portal", "user", "public"];
+export interface PageDocument extends Document {
+    _id: Types.ObjectId;
+    path: string;
+    revision: Types.ObjectId;
+    redirectTo: string;
+    status: string;
+    grant: number;
+    grantedUsers: Types.ObjectId[];
+    creator: Types.ObjectId;
+    lastUpdateUser: Types.ObjectId;
+    liker: Types.ObjectId[];
+    seenUsers: Types.ObjectId[];
+    commentCount: number;
+    extended: Record<string, any>;
+    createdAt: Date;
+    updatedAt: Date;
+    /**
+     * RFC-0003: pointer to the most recent `Revision` produced by the
+     * collaborative save flow. Semantically identical to the legacy
+     * `revision` field; introduced as a separate name to make the new
+     * code path explicit. Phase 5 will populate it alongside `revision`
+     * inside the save transaction; older pages and pages saved before
+     * Phase 5 lands return `null` here and read code should fall back to
+     * `revision`. The duplication is intentional during the v2.1
+     * transition — see `openQuestions[0]` in the Phase 1 task file.
+     */
+    currentRevision?: Types.ObjectId | null;
+    /**
+     * RFC-0003: binary snapshot of the page's Y.Doc (output of
+     * `Y.encodeStateAsUpdate`). Phase 3 reads this in `onLoadDocument`
+     * to restore the doc; Phase 4's compaction writes it. `null` means
+     * "no live Yjs state yet — build a fresh doc from the latest
+     * revision's body". External writers that bypass Yjs MUST also
+     * set this to `null` so connected clients are force-reloaded
+     * (Phase 6).
+     *
+     * Subject to MongoDB's 16 MB BSON document cap. Phase 4's
+     * compaction step keeps the snapshot bounded; Phase 1 ships
+     * without a runtime size guard.
+     */
+    yjsState?: Buffer | null;
+    /** RFC-0003: timestamp of the most recent `yjsState` checkpoint. */
+    yjsCheckpointAt?: Date | null;
+    latestRevision?: Types.ObjectId;
+    likerCount?: number;
+    seenUsersCount?: number;
+    isPublished(): boolean;
+    isDeleted(): boolean;
+    isDeprecated(): boolean;
+    isDraft(): boolean;
+    isPublic(): boolean;
+    isPortal(): boolean;
+    isCreator(user: any): boolean;
+    isGrantedFor(user: any): boolean;
+    isLatestRevision(): boolean;
+    isUpdatable(previousRevision: any): boolean;
+    isLiked(user: any): boolean;
+    isRedirectOriginPage(): boolean;
+    isUnlinkable(user: any): boolean;
+    isWIP(): boolean;
+    like(user: any): any;
+    unlike(user: any): any;
+    unlink(user: any): any;
+    isSeenUser(user: any): any;
+    seen(user: any): any;
+    getSlackChannel(): any;
+    updateSlackChannel(slackChannel: string): any;
+    updateExtended(extended: Record<string, any>): any;
+    getNotificationTargetUsers(): any;
+}
+export interface PageModel extends Model<PageDocument> {
+    GRANT_PUBLIC: number;
+    GRANT_RESTRICTED: number;
+    GRANT_SPECIFIED: number;
+    GRANT_OWNER: number;
+    PAGE_GRANT_ERROR: number;
+    TYPE_PORTAL: string;
+    TYPE_PUBLIC: string;
+    TYPE_USER: string;
+    populatePageData(pageData: any, revisionId?: Types.ObjectId | null): Promise<PageDocument>;
+    populatePagesRevision(pages: any, revisions: any): any;
+    populatePageListToAnyObjects(pageIdObjectArray: any): any;
+    updateCommentCount(page: any, num: any): any;
+    hasPortalPage(path: any, user: any, revisionId?: any): Promise<boolean>;
+    findPortalPage(path: any, user: any, revisionId?: any): Promise<PageDocument | null>;
+    getGrantLabels(): any;
+    normalizePath(path: any): any;
+    getUserPagePath(user: any): any;
+    getDeletedPageName(path: any): any;
+    getRevertDeletedPageName(path: any): any;
+    isDeletableName(path: any): any;
+    isRenamableName(path: any): any;
+    isCreatableName(name: any): any;
+    fixToCreatableName(path: any): any;
+    updateRevision(pageId: any, revisionId: any, cb: any): any;
+    exists(query: any): any;
+    findUpdatedList(offset: any, limit: any, cb: any): any;
+    findPageById(id: any): Promise<PageDocument>;
+    findPageByIdAndGrantedUser(id: any, userData: any): Promise<PageDocument>;
+    findPage(path: any, userData: any, revisionId?: any, ignoreNotFound?: any): Promise<PageDocument | null>;
+    findPageByPath(path: any): Promise<PageDocument>;
+    isExistByPath(path: any): any;
+    isExistById(id: any): any;
+    isNonExistentUserPage(path: string): Promise<boolean>;
+    isNonExistentUserTrashPage(path: string): Promise<boolean>;
+    findListByPageIds(ids: any, options: any): any;
+    findPageByRedirectTo(path: any): any;
+    findPagesByIds(ids: any): any;
+    findListByCreator(user: any, option: any, currentUser: any): any;
+    getStreamOfFindAll(options?: any): any;
+    findListByStartWith(path: any, userData: any, option: any): Promise<PageDocument[]>;
+    findChildrenByPath(path: any, userData: any, option: any): any;
+    findChildSegments(path: any, userData: any): Promise<Array<{
+        segment: string;
+        path: string;
+        isPage: boolean;
+        hasPortal: boolean;
+        count: number;
+    }>>;
+    findUnfurlablePages(type: any, array: any, grants?: number[]): any;
+    findUnfurlablePagesByIds(ids: any): any;
+    findUnfurlablePagesByPaths(paths: any): any;
+    updatePageProperty(page: any, updateData: any): any;
+    updateGrant(page: any, grant: any, userData: any): any;
+    pushToGrantedUsers(page: any, userData: any): any;
+    pushRevision(pageData: any, newRevision: any, user: any): any;
+    createPage(path: any, body: any, user: any, options: any): any;
+    updatePage(pageData: PageDocument, body: any, user: any, options: any): any;
+    deletePage(pageData: PageDocument, user: any): any;
+    revertDeletedPage(pageData: PageDocument, user: any): Promise<PageDocument>;
+    completelyDeletePage(pageData: PageDocument, user?: any): Promise<PageDocument>;
+    removePage(pageData: PageDocument): any;
+    removePageById(pageId: any): any;
+    removePageByPath(pagePath: any): any;
+    removeRedirectOriginPageByPath(pagePath: any): any;
+    rename(pageData: any, newPagePath: any, user: any, options: any): any;
+    getPathMap(paths: any, search: any, replace: any): any;
+    checkPagesRenamable(paths: any, user: any): any;
+    renameTree(pathMap: any, user: any, options: any): any;
+    allPageCount(): any;
+}
+declare const _default: (crowi: Crowi) => PageModel;
+export default _default;