@crowi/api-contract 2.0.0-alpha.19 → 2.0.0-alpha.20

package/dist/index.js

@@ -153,6 +153,8 @@ __export(index_exports, {
   GetBacklinksRequestSchema: () => GetBacklinksRequestSchema,
   GetBacklinksResponseSchema: () => GetBacklinksResponseSchema,
   GetBookmarkRequestSchema: () => GetBookmarkRequestSchema,
+  GetBookmarkResponseSchema: () => GetBookmarkResponseSchema,
+  GetBookmarkSchema: () => GetBookmarkSchema,
   GetLikersRequestSchema: () => GetLikersRequestSchema,
   GetMailSettingsResponseSchema: () => GetMailSettingsResponseSchema,
   GetPageRequestSchema: () => GetPageRequestSchema,
@@ -3512,7 +3514,6 @@ var PageSchema = import_zod_openapi32.z.object({
   grantedUsers: import_zod_openapi32.z.array(import_zod_openapi32.z.string()).optional(),
   creator: import_zod_openapi32.z.union([import_zod_openapi32.z.string(), PageUserSchema]).nullable().optional(),
   lastUpdateUser: import_zod_openapi32.z.union([import_zod_openapi32.z.string(), PageUserSchema]).nullable().optional(),
-  liker: import_zod_openapi32.z.array(import_zod_openapi32.z.string()).optional(),
   commentCount: import_zod_openapi32.z.number().default(0),
   extended: PageExtendedSchema,
   createdAt: import_zod_openapi32.z.string(),
@@ -3528,8 +3529,15 @@ var PageSchema = import_zod_openapi32.z.object({
   yjsCheckpointAt: import_zod_openapi32.z.string().nullable().optional(),
   // dynamic fields
   latestRevision: import_zod_openapi32.z.string().optional(),
-  likerCount: import_zod_openapi32.z.number().optional(),
-  seenUsersCount: import_zod_openapi32.z.number().optional()
+  // feature-page-relations-collections D-2 — Like / Seen are independent
+  // relation collections now; the wire no longer carries the full liker
+  // ID array (removed above), only these derived, viewer-scoped fields.
+  // Required (not optional): every response path routes through
+  // `populatePageRelationData` before serialising a Page, so these are
+  // always present.
+  likerCount: import_zod_openapi32.z.number().int().nonnegative(),
+  seenUsersCount: import_zod_openapi32.z.number().int().nonnegative(),
+  isLiked: import_zod_openapi32.z.boolean()
 });
 var PageWithRevisionSchema = PageSchema.extend({
   revision: RevisionSchema,
@@ -3627,10 +3635,20 @@ var PageChildSegmentSchema = import_zod_openapi32.z.object({
 var ListPageChildrenRequestSchema = import_zod_openapi32.z.object({
   // Portal path to list children of. Trailing slash optional — the
   // handler normalises it. '/' lists the top-level segments.
-  path: import_zod_openapi32.z.string()
+  path: import_zod_openapi32.z.string(),
+  // How many levels below `path` to return (default 1 — immediate children
+  // only, the original behaviour). The server scans the whole subtree
+  // either way, so a deeper request costs no extra query; it only widens
+  // what is grouped into the response. The sidebar asks for 2 at a
+  // `YYYY/MM/` node so it can open every day of the month at once.
+  depth: import_zod_openapi32.z.coerce.number().int().min(1).max(2).optional()
 });
 var ListPageChildrenResponseSchema = import_zod_openapi32.z.object({
-  // Sorted alphabetically by segment.
+  // Depth-first, siblings sorted alphabetically by segment — so a node is
+  // immediately followed by its own subtree. With the default `depth` of 1
+  // this is simply the alphabetical first-level listing. Deeper levels are
+  // NOT nested: every row sits in this one flat array and carries its full
+  // `path`, which is what places it in the tree.
   children: import_zod_openapi32.z.array(PageChildSegmentSchema)
 });
 var CreatePageRequestSchema = import_zod_openapi32.z.object({
@@ -3807,6 +3825,15 @@ var GetBookmarkRequestSchema = import_zod_openapi34.z.object({
 var BookmarkResponseSchema = import_zod_openapi34.z.object({
   bookmark: BookmarkSchema.nullable()
 });
+var GetBookmarkSchema = import_zod_openapi34.z.object({
+  _id: import_zod_openapi34.z.string(),
+  page: import_zod_openapi34.z.string().nullable(),
+  user: import_zod_openapi34.z.union([import_zod_openapi34.z.string(), UserPublicSchema]),
+  createdAt: import_zod_openapi34.z.string()
+});
+var GetBookmarkResponseSchema = import_zod_openapi34.z.object({
+  bookmark: GetBookmarkSchema.nullable()
+});
 var ListMyBookmarksResponseSchema = import_zod_openapi34.z.object({
   bookmarks: import_zod_openapi34.z.array(BookmarkSchema),
   pager: PagerSchema,
@@ -3859,10 +3886,14 @@ var UserPageResponseSchema = import_zod_openapi35.z.object({
   createdPagesCount: import_zod_openapi35.z.number(),
   bookmarksCount: import_zod_openapi35.z.number(),
   // feature-profile-stats-and-page-total — the target user's OWN actions:
-  // pages they liked (`Page.liker` contains their id) and comments they
-  // wrote (`Comment.creator` is their id). NOT activity their own pages
-  // received from others, and not re-filtered by the viewer's grants —
-  // see the spec's "プロフィール統計の主語と API 契約" section.
+  // pages they liked and comments they wrote (`Comment.creator` is their
+  // id). NOT activity their own pages received from others, and not
+  // re-filtered by the viewer's grants — see the spec's "プロフィール統計の
+  // 主語と API 契約" section. feature-page-relations-collections D-6:
+  // `likesCount` is the count of `likes` relation rows whose Page still
+  // exists (an existence-filtered aggregate, not a raw row count) — a
+  // best-effort post-delete cleanup failure can leave an orphaned `likes`
+  // row, and that row must not inflate this number.
   likesCount: import_zod_openapi35.z.number(),
   commentsCount: import_zod_openapi35.z.number(),
   // Optionally include recent items for initial display
@@ -3898,8 +3929,8 @@ var getBookmarkRoute = (0, import_zod_openapi36.createRoute)({
   },
   responses: {
     200: {
-      description: "Bookmark for the page (or null when not bookmarked)",
-      content: { "application/json": { schema: BookmarkResponseSchema } }
+      description: "Bookmark for the page (or null when not bookmarked). `page` is a bare page id \u2014 this route never populates the page (feature-page-relations-collections D-2).",
+      content: { "application/json": { schema: GetBookmarkResponseSchema } }
     },
     400: {
       description: "Invalid page_id",
@@ -5615,13 +5646,13 @@ var listPageChildrenRoute = (0, import_zod_openapi56.createRoute)({
   path: "/pages/children",
   tags: ["page"],
   security: [{ bearerAuth: [] }],
-  summary: "List immediate child segments under a portal path (sidebar tree)",
+  summary: "List child segments under a portal path, up to `depth` levels (sidebar tree)",
   request: {
     query: ListPageChildrenRequestSchema
   },
   responses: {
     200: {
-      description: "First-level child segments (alphabetical) under the path",
+      description: "Child segments under the path, depth-first with siblings alphabetical, spanning `depth` levels (default 1). Flat \u2014 a row's own `path` places it in the tree.",
       content: { "application/json": { schema: ListPageChildrenResponseSchema } }
     },
     401: {
@@ -5783,7 +5814,7 @@ var likePageRoute = (0, import_zod_openapi56.createRoute)({
   path: "/pages/like",
   tags: ["page"],
   security: [{ bearerAuth: [] }],
-  summary: "Add the current user to the page liker list",
+  summary: "Add the current user to the page like relation",
   request: {
     body: {
       content: { "application/json": { schema: PageIdBodySchema } }
@@ -5791,7 +5822,7 @@ var likePageRoute = (0, import_zod_openapi56.createRoute)({
   },
   responses: {
     200: {
-      description: "The page with the updated liker list",
+      description: "The page, viewer-scoped: `likerCount` / `seenUsersCount` are the current relation counts (not a liker ID array \u2014 feature-page-relations-collections D-2), `isLiked` reflects the caller's own membership as of this response.",
       content: { "application/json": { schema: PageResponseSchema } }
     },
     400: {
@@ -5813,7 +5844,7 @@ var unlikePageRoute = (0, import_zod_openapi56.createRoute)({
   path: "/pages/unlike",
   tags: ["page"],
   security: [{ bearerAuth: [] }],
-  summary: "Remove the current user from the page liker list",
+  summary: "Remove the current user from the page like relation",
   request: {
     body: {
       content: { "application/json": { schema: PageIdBodySchema } }
@@ -5821,7 +5852,7 @@ var unlikePageRoute = (0, import_zod_openapi56.createRoute)({
   },
   responses: {
     200: {
-      description: "The page with the updated liker list",
+      description: "The page, viewer-scoped: `likerCount` / `seenUsersCount` are the current relation counts (not a liker ID array \u2014 feature-page-relations-collections D-2), `isLiked` reflects the caller's own membership as of this response.",
       content: { "application/json": { schema: PageResponseSchema } }
     },
     400: {
@@ -6355,7 +6386,7 @@ var getLikersRoute = (0, import_zod_openapi60.createRoute)({
   },
   responses: {
     200: {
-      description: "Liker list (newest-liked first when known) with full totalCount",
+      description: "Liker list (newest-liked first when known) with full totalCount. Sourced from the `likes` relation collection; `likedAt` falls back to a best-effort `ACTION_LIKE` Activity join only for a migrated row with a null relation timestamp (feature-page-relations-collections D-1/D-3).",
       content: { "application/json": { schema: LikersResponseSchema } }
     },
     400: {
@@ -8061,6 +8092,7 @@ var stubListUsers = {
   total: 0
 };
 var stubBookmarkResponse = { bookmark: null };
+var stubGetBookmarkResponse = { bookmark: null };
 var stubListMyBookmarks = { bookmarks: [], pager: stubPager, total: 0 };
 var stubRemoveBookmark = { ok: true };
 var stubBacklinks = { backlinks: [], hasNext: false };
@@ -8112,7 +8144,10 @@ var stubPage = {
   _id: "",
   path: "",
   commentCount: 0,
-  createdAt: ""
+  createdAt: "",
+  likerCount: 0,
+  seenUsersCount: 0,
+  isLiked: false
 };
 var stubPageWithRevision = {
   page: {
@@ -8126,7 +8161,10 @@ var stubPageWithRevision = {
       createdAt: ""
     },
     commentCount: 0,
-    createdAt: ""
+    createdAt: "",
+    likerCount: 0,
+    seenUsersCount: 0,
+    isLiked: false
   }
 };
 var stubPageResponse = { page: stubPage };
@@ -8267,7 +8305,7 @@ var appAuthMeUserChain = new import_zod_openapi84.OpenAPIHono().openapi(
   meRoutes.updatePasswordRoute,
   (c) => c.json({ status: "ok", message: "", accessToken: "", refreshToken: "", expiresIn: 0 }, 200)
 ).openapi(meRoutes.recentlyViewedPagesRoute, (c) => c.json({ pages: [] }, 200)).openapi(accessTokenRoutes.listAccessTokensRoute, (c) => c.json({ accessTokens: [] }, 200)).openapi(accessTokenRoutes.createAccessTokenRoute, (c) => c.json(stubCreateAccessToken, 201)).openapi(accessTokenRoutes.deleteAccessTokenRoute, (c) => c.json(stubAccessToken, 200)).openapi(userRoutes.getUserPageRoute, (c) => c.json(stubUserPage, 200)).openapi(userRoutes.getUserBookmarksRoute, (c) => c.json(stubUserBookmarks, 200)).openapi(userRoutes.getUserPagesRoute, (c) => c.json(stubUserPages, 200)).openapi(userRoutes.getUserSubpagesRoute, (c) => c.json(stubUserPages, 200)).openapi(userRoutes.listMembersRoute, (c) => c.json(stubListUsers, 200));
-var bookmarkBacklinkCommentRevisionChain = new import_zod_openapi84.OpenAPIHono().openapi(bookmarkRoutes.getBookmarkRoute, (c) => c.json(stubBookmarkResponse, 200)).openapi(bookmarkRoutes.listMyBookmarksRoute, (c) => c.json(stubListMyBookmarks, 200)).openapi(bookmarkRoutes.addBookmarkRoute, (c) => c.json(stubBookmarkResponse, 200)).openapi(bookmarkRoutes.removeBookmarkRoute, (c) => c.json(stubRemoveBookmark, 200)).openapi(backlinkRoutes.getBacklinksRoute, (c) => c.json(stubBacklinks, 200)).openapi(commentRoutes.listCommentsRoute, (c) => c.json(stubListComments, 200)).openapi(commentRoutes.addCommentRoute, (c) => c.json(stubAddComment, 200)).openapi(commentRoutes.deleteCommentRoute, (c) => c.json(stubDeleteComment, 200)).openapi(revisionRoutes.listRevisionsRoute, (c) => c.json(stubListRevisions, 200)).openapi(revisionRoutes.getRevisionsRoute, (c) => c.json(stubGetRevisions, 200)).openapi(revisionRoutes.getRevisionRoute, (c) => c.json(stubGetRevision, 200)).openapi(getPageHistoryRoute, (c) => c.json(stubPageHistory, 200));
+var bookmarkBacklinkCommentRevisionChain = new import_zod_openapi84.OpenAPIHono().openapi(bookmarkRoutes.getBookmarkRoute, (c) => c.json(stubGetBookmarkResponse, 200)).openapi(bookmarkRoutes.listMyBookmarksRoute, (c) => c.json(stubListMyBookmarks, 200)).openapi(bookmarkRoutes.addBookmarkRoute, (c) => c.json(stubBookmarkResponse, 200)).openapi(bookmarkRoutes.removeBookmarkRoute, (c) => c.json(stubRemoveBookmark, 200)).openapi(backlinkRoutes.getBacklinksRoute, (c) => c.json(stubBacklinks, 200)).openapi(commentRoutes.listCommentsRoute, (c) => c.json(stubListComments, 200)).openapi(commentRoutes.addCommentRoute, (c) => c.json(stubAddComment, 200)).openapi(commentRoutes.deleteCommentRoute, (c) => c.json(stubDeleteComment, 200)).openapi(revisionRoutes.listRevisionsRoute, (c) => c.json(stubListRevisions, 200)).openapi(revisionRoutes.getRevisionsRoute, (c) => c.json(stubGetRevisions, 200)).openapi(revisionRoutes.getRevisionRoute, (c) => c.json(stubGetRevision, 200)).openapi(getPageHistoryRoute, (c) => c.json(stubPageHistory, 200));
 var pageChain = new import_zod_openapi84.OpenAPIHono().openapi(pageRoutes.getPageRoute, (c) => c.json(stubPageWithRevision, 200)).openapi(pageRoutes.listPagesRoute, (c) => c.json(stubListPages, 200)).openapi(pageRoutes.listPageChildrenRoute, (c) => c.json(stubListPageChildren, 200)).openapi(pageRoutes.createPageRoute, (c) => c.json(stubPageResponse, 200)).openapi(pageRoutes.updatePageRoute, (c) => c.json(stubPageResponse, 200)).openapi(pageRoutes.setPageGrantRoute, (c) => c.json(stubPageResponse, 200)).openapi(pageRoutes.seenPageRoute, (c) => c.json(stubSeenUsers, 200)).openapi(pageRoutes.getSeenUsersRoute, (c) => c.json(stubSeenUsers, 200)).openapi(pageRoutes.likePageRoute, (c) => c.json(stubPageResponse, 200)).openapi(pageRoutes.unlikePageRoute, (c) => c.json(stubPageResponse, 200)).openapi(pageRoutes.claimPageLinkAccessRoute, (c) => c.json({ ...stubPageWithRevision, granted: false }, 200)).openapi(pageRoutes.getWatchStatusRoute, (c) => c.json(stubWatchStatus, 200)).openapi(pageRoutes.setWatchStatusRoute, (c) => c.json(stubWatchStatus, 200)).openapi(pageRoutes.deletePageRoute, (c) => c.json(stubPageResponse, 200)).openapi(pageRoutes.revertDeletedPageRoute, (c) => c.json(stubPageResponse, 200)).openapi(pageRoutes.revertToRevisionRoute, (c) => c.json(stubPageResponse, 200)).openapi(pageRoutes.renamePageRoute, (c) => c.json({ ...stubPageResponse, renamed_count: 1 }, 200)).openapi(pageRoutes.renameSubtreeRoute, (c) => c.json({ renamed_count: 0 }, 200)).openapi(pagePreviewRoutes.previewPageRoute, (c) => c.json(stubPreview, 200)).openapi(pageCollabRoutes.getYjsTokenRoute, (c) => c.json(stubWsToken, 200)).openapi(presenceRoutes.getPresenceTokenRoute, (c) => c.json(stubPresenceToken, 200)).openapi(presenceRoutes.getLikersRoute, (c) => c.json(stubLikers, 200));
 var lateContractApp = new import_zod_openapi84.OpenAPIHono().openapi(draftRoutes.createDraftRoute, (c) => c.json(stubCreateDraft, 201)).openapi(draftRoutes.listDraftsRoute, (c) => c.json(stubListDrafts, 200)).openapi(draftRoutes.cancelDraftRoute, (c) => c.json(stubCreateDraft, 200)).openapi(autocompleteRoutes.autocompleteUsersRoute, (c) => c.json(stubAutocomplete, 200)).openapi(autocompleteRoutes.autocompletePagesRoute, (c) => c.json(stubAutocomplete, 200)).openapi(attachmentRoutes.getAttachmentUsageRoute, (c) => c.json(stubAttachmentUsage, 200)).openapi(attachmentRoutes.listAttachmentsRoute, (c) => c.json(stubListAttachments, 200)).openapi(attachmentRoutes.addAttachmentRoute, (c) => c.json(stubAddAttachment, 200)).openapi(attachmentRoutes.uploadAttachmentRoute, (c) => c.json(stubUploadAttachment, 200)).openapi(attachmentRoutes.getAttachmentMetaRoute, (c) => c.json(stubAttachmentMeta, 200)).openapi(attachmentRoutes.removeAttachmentRoute, (c) => c.json(stubRemoveAttachment, 200)).openapi(attachmentRoutes.getUploadPolicyRoute, (c) => c.json(stubUploadPolicy, 200)).openapi(searchRoutes.searchPagesRoute, (c) => c.json(stubSearchPages, 200)).openapi(adminCryptoRoutes.getCryptoStatusRoute, (c) => c.json(stubCryptoStatus, 200)).openapi(adminCryptoRoutes.reencryptAllRoute, (c) => c.json(stubReencrypt, 200)).openapi(notificationRoutes.listNotificationsRoute, (c) => c.json(stubListNotifications, 200)).openapi(notificationRoutes.markAllAsReadRoute, (c) => c.json(stubMarkAllAsRead, 200)).openapi(notificationRoutes.getNotificationsTokenRoute, (c) => c.json(stubNotificationsToken, 200)).openapi(notificationRoutes.getUnreadCountRoute, (c) => c.json(stubNotificationStatus, 200)).openapi(notificationRoutes.openNotificationRoute, (c) => c.json(stubOpenNotification, 200));
 var adminSettingsContractApp = new import_zod_openapi84.OpenAPIHono().openapi(adminAppRoutes.getAppSettingsRoute, (c) => c.json(stubGetAppSettings, 200)).openapi(adminAppRoutes.updateAppSettingsRoute, (c) => c.json(stubUpdateAppSettings, 200)).openapi(adminAuthRoutes.getAuthSettingsRoute, (c) => c.json(stubAuthSettings, 200)).openapi(adminAuthRoutes.updateAuthSettingsRoute, (c) => c.json(stubAuthSettings, 200)).openapi(adminSecurityRoutes.getSecuritySettingsRoute, (c) => c.json(stubSecuritySettings, 200)).openapi(adminSecurityRoutes.updateSecuritySettingsRoute, (c) => c.json(stubSecuritySettings, 200)).openapi(adminMailRoutes.getMailSettingsRoute, (c) => c.json(stubMailSettings, 200)).openapi(adminMailRoutes.updateMailSettingsRoute, (c) => c.json(stubUpdateMailSettings, 200)).openapi(adminMailRoutes.sendTestMailRoute, (c) => c.json(stubSendTestMail, 200)).openapi(adminStorageRoutes.getStorageStatusRoute, (c) => c.json(stubStorageStatus, 200)).openapi(adminSearchRoutes.getSearchStatusRoute, (c) => c.json(stubSearchStatus, 200));
@@ -8624,6 +8662,8 @@ var WS_CLOSE_CODES = {
   GetBacklinksRequestSchema,
   GetBacklinksResponseSchema,
   GetBookmarkRequestSchema,
+  GetBookmarkResponseSchema,
+  GetBookmarkSchema,
   GetLikersRequestSchema,
   GetMailSettingsResponseSchema,
   GetPageRequestSchema,