@crowi/api-contract 2.0.0-alpha.2 → 2.0.0-alpha.5

package/dist/index.d.mts

@@ -23033,6 +23033,7 @@ declare const AdminSidebarSection: z.ZodEnum<{
     mail: "mail";
     auth: "auth";
     renderer: "renderer";
+    platform: "platform";
 }>;
 type AdminSidebarSectionValue = z.infer<typeof AdminSidebarSection>;
 declare const PluginAdminPlacementSchema: z.ZodObject<{
@@ -23045,6 +23046,7 @@ declare const PluginAdminPlacementSchema: z.ZodObject<{
         mail: "mail";
         auth: "auth";
         renderer: "renderer";
+        platform: "platform";
     }>;
     label: z.ZodString;
     icon: z.ZodOptional<z.ZodString>;
@@ -23066,6 +23068,7 @@ declare const PluginInfoSchema: z.ZodObject<{
             mail: "mail";
             auth: "auth";
             renderer: "renderer";
+            platform: "platform";
         }>;
         label: z.ZodString;
         icon: z.ZodOptional<z.ZodString>;
@@ -23090,6 +23093,7 @@ declare const ListPluginsResponseSchema: z.ZodObject<{
                 mail: "mail";
                 auth: "auth";
                 renderer: "renderer";
+                platform: "platform";
             }>;
             label: z.ZodString;
             icon: z.ZodOptional<z.ZodString>;
@@ -23226,6 +23230,7 @@ declare const listPluginsRoute: {
                                     mail: "mail";
                                     auth: "auth";
                                     renderer: "renderer";
+                                    platform: "platform";
                                 }>;
                                 label: z.ZodString;
                                 icon: z.ZodOptional<z.ZodString>;
@@ -23693,6 +23698,7 @@ declare const adminPluginsRoutes: {
                                         mail: "mail";
                                         auth: "auth";
                                         renderer: "renderer";
+                                        platform: "platform";
                                     }>;
                                     label: z.ZodString;
                                     icon: z.ZodOptional<z.ZodString>;
@@ -37886,7 +37892,7 @@ declare const adminUsersPluginsContractApp: OpenAPIHono<hono.Env, {
                     hasConfig: boolean;
                     registers: string[];
                     adminPlacement: {
-                        section: "search" | "notification" | "settings" | "shared" | "storage" | "mail" | "auth" | "renderer";
+                        section: "search" | "notification" | "settings" | "shared" | "storage" | "mail" | "auth" | "renderer" | "platform";
                         label: string;
                         icon?: string | undefined;
                     };
@@ -42676,7 +42682,7 @@ type AutocompleteRateLimitError = z.infer<typeof AutocompleteRateLimitErrorSchem
  *
  * Keeping the types here (and not in `page.ts`) keeps the
  * collaborative additions discoverable as one bundle and avoids
- * polluting the legacy page contract with v2.1-only fields.
+ * polluting the legacy page contract with v2.0-only fields.
  */
 /**
  * Public user shape surfaced for collaboration UI (Save author /
@@ -42734,6 +42740,12 @@ type RevisionType = z.infer<typeof RevisionTypeSchema>;
  *                     readonly clients still subscribe to live
  *                     updates but their writes are rejected by
  *                     Hocuspocus.
+ *
+ * Round 2 (Decision 1): the save optimistic lock moved SERVER-SIDE — it is
+ * now anchored to the revision the server's Hocuspocus document was
+ * materialised from, not to a client-pinned base. The wsToken response no
+ * longer carries `currentRevision` (the client never pins / echoes a base
+ * any more).
  */
 declare const WsTokenResponseSchema: z.ZodObject<{
     wsToken: z.ZodString;
@@ -42770,8 +42782,15 @@ type WsTokenPayload = z.infer<typeof WsTokenPayloadSchema>;
  * dispatcher; Phase 8 wires it to the Save button.
  *
  * `message` is the optional checkpoint message (currently unused in
- * the v2.1 UI per spec open question 1, but reserved on the wire so
+ * the v2.0 UI per spec open question 1, but reserved on the wire so
  * we can light it up without a wire-format break).
+ *
+ * Round 2 (Decision 1): the save optimistic lock is anchored SERVER-SIDE
+ * to the revision the server's Hocuspocus document was materialised from,
+ * so the client no longer sends a `baseRevisionId` — the field was
+ * removed. A divergence (an out-of-band save moved `currentRevision`) is
+ * caught by the server's compare-and-set pointer write and surfaced as
+ * `crowi:save-error` `code: 'CONFLICT'`.
  */
 declare const CollabSaveMessageSchema: z.ZodObject<{
     kind: z.ZodLiteral<"crowi:save">;
@@ -42794,7 +42813,12 @@ type CollabSaveOk = z.infer<typeof CollabSaveOkSchema>;
  * fails. The Phase 8 Save UI surfaces `message` in a toast. `code`
  * lets the client branch on retry vs surface-and-stop (e.g.
  * `'RENDERER_FAILED'` is a hard error from the RFC-0002 renderer; the
- * client should not retry).
+ * client should not retry). `code: 'CONFLICT'` is the
+ * editor-preview-reliability server-doc-lock rejection (round 2, Decision
+ * 1) — the page's live `currentRevision` diverged from the revision the
+ * server doc was materialised from (an out-of-band save), so the client
+ * must prompt a reload rather than retry, mirroring the HTTP
+ * `PageRevisionConflictError`.
  */
 declare const CollabSaveErrorSchema: z.ZodObject<{
     kind: z.ZodLiteral<"crowi:save-error">;

package/dist/index.d.ts

@@ -23033,6 +23033,7 @@ declare const AdminSidebarSection: z.ZodEnum<{
     mail: "mail";
     auth: "auth";
     renderer: "renderer";
+    platform: "platform";
 }>;
 type AdminSidebarSectionValue = z.infer<typeof AdminSidebarSection>;
 declare const PluginAdminPlacementSchema: z.ZodObject<{
@@ -23045,6 +23046,7 @@ declare const PluginAdminPlacementSchema: z.ZodObject<{
         mail: "mail";
         auth: "auth";
         renderer: "renderer";
+        platform: "platform";
     }>;
     label: z.ZodString;
     icon: z.ZodOptional<z.ZodString>;
@@ -23066,6 +23068,7 @@ declare const PluginInfoSchema: z.ZodObject<{
             mail: "mail";
             auth: "auth";
             renderer: "renderer";
+            platform: "platform";
         }>;
         label: z.ZodString;
         icon: z.ZodOptional<z.ZodString>;
@@ -23090,6 +23093,7 @@ declare const ListPluginsResponseSchema: z.ZodObject<{
                 mail: "mail";
                 auth: "auth";
                 renderer: "renderer";
+                platform: "platform";
             }>;
             label: z.ZodString;
             icon: z.ZodOptional<z.ZodString>;
@@ -23226,6 +23230,7 @@ declare const listPluginsRoute: {
                                     mail: "mail";
                                     auth: "auth";
                                     renderer: "renderer";
+                                    platform: "platform";
                                 }>;
                                 label: z.ZodString;
                                 icon: z.ZodOptional<z.ZodString>;
@@ -23693,6 +23698,7 @@ declare const adminPluginsRoutes: {
                                         mail: "mail";
                                         auth: "auth";
                                         renderer: "renderer";
+                                        platform: "platform";
                                     }>;
                                     label: z.ZodString;
                                     icon: z.ZodOptional<z.ZodString>;
@@ -37886,7 +37892,7 @@ declare const adminUsersPluginsContractApp: OpenAPIHono<hono.Env, {
                     hasConfig: boolean;
                     registers: string[];
                     adminPlacement: {
-                        section: "search" | "notification" | "settings" | "shared" | "storage" | "mail" | "auth" | "renderer";
+                        section: "search" | "notification" | "settings" | "shared" | "storage" | "mail" | "auth" | "renderer" | "platform";
                         label: string;
                         icon?: string | undefined;
                     };
@@ -42676,7 +42682,7 @@ type AutocompleteRateLimitError = z.infer<typeof AutocompleteRateLimitErrorSchem
  *
  * Keeping the types here (and not in `page.ts`) keeps the
  * collaborative additions discoverable as one bundle and avoids
- * polluting the legacy page contract with v2.1-only fields.
+ * polluting the legacy page contract with v2.0-only fields.
  */
 /**
  * Public user shape surfaced for collaboration UI (Save author /
@@ -42734,6 +42740,12 @@ type RevisionType = z.infer<typeof RevisionTypeSchema>;
  *                     readonly clients still subscribe to live
  *                     updates but their writes are rejected by
  *                     Hocuspocus.
+ *
+ * Round 2 (Decision 1): the save optimistic lock moved SERVER-SIDE — it is
+ * now anchored to the revision the server's Hocuspocus document was
+ * materialised from, not to a client-pinned base. The wsToken response no
+ * longer carries `currentRevision` (the client never pins / echoes a base
+ * any more).
  */
 declare const WsTokenResponseSchema: z.ZodObject<{
     wsToken: z.ZodString;
@@ -42770,8 +42782,15 @@ type WsTokenPayload = z.infer<typeof WsTokenPayloadSchema>;
  * dispatcher; Phase 8 wires it to the Save button.
  *
  * `message` is the optional checkpoint message (currently unused in
- * the v2.1 UI per spec open question 1, but reserved on the wire so
+ * the v2.0 UI per spec open question 1, but reserved on the wire so
  * we can light it up without a wire-format break).
+ *
+ * Round 2 (Decision 1): the save optimistic lock is anchored SERVER-SIDE
+ * to the revision the server's Hocuspocus document was materialised from,
+ * so the client no longer sends a `baseRevisionId` — the field was
+ * removed. A divergence (an out-of-band save moved `currentRevision`) is
+ * caught by the server's compare-and-set pointer write and surfaced as
+ * `crowi:save-error` `code: 'CONFLICT'`.
  */
 declare const CollabSaveMessageSchema: z.ZodObject<{
     kind: z.ZodLiteral<"crowi:save">;
@@ -42794,7 +42813,12 @@ type CollabSaveOk = z.infer<typeof CollabSaveOkSchema>;
  * fails. The Phase 8 Save UI surfaces `message` in a toast. `code`
  * lets the client branch on retry vs surface-and-stop (e.g.
  * `'RENDERER_FAILED'` is a hard error from the RFC-0002 renderer; the
- * client should not retry).
+ * client should not retry). `code: 'CONFLICT'` is the
+ * editor-preview-reliability server-doc-lock rejection (round 2, Decision
+ * 1) — the page's live `currentRevision` diverged from the revision the
+ * server doc was materialised from (an out-of-band save), so the client
+ * must prompt a reload rather than retry, mirroring the HTTP
+ * `PageRevisionConflictError`.
  */
 declare const CollabSaveErrorSchema: z.ZodObject<{
     kind: z.ZodLiteral<"crowi:save-error">;

package/dist/index.js

@@ -5323,7 +5323,7 @@ var PluginFieldSchema = import_zod_openapi61.z.object({
   }).optional(),
   optional: import_zod_openapi61.z.boolean()
 });
-var AdminSidebarSection = import_zod_openapi61.z.enum(["settings", "shared", "storage", "mail", "notification", "auth", "search", "renderer"]);
+var AdminSidebarSection = import_zod_openapi61.z.enum(["settings", "shared", "storage", "mail", "notification", "auth", "search", "renderer", "platform"]);
 var PluginAdminPlacementSchema = import_zod_openapi61.z.object({
   /**
    * Sidebar section to surface this plugin under. The runtime fills