@vcp-dev/contracts 0.4.9 → 0.6.0

package/dist/site-edit-render-document.d.ts

@@ -8,38 +8,65 @@ export declare const SiteEditOperationSummarySchema: z.ZodObject<{
 export type SiteEditOperationSummary = z.infer<typeof SiteEditOperationSummarySchema>;
 export declare const SiteEditRenderEntrySchema: z.ZodObject<{
     key: z.ZodString;
-    tag: z.ZodString;
-    label: z.ZodString;
-    parentKey: z.ZodNullable<z.ZodString>;
-    childKeys: z.ZodArray<z.ZodString>;
+    pageCompositionUnitKey: z.ZodOptional<z.ZodString>;
     operationSummary: z.ZodObject<{
         canUpdateText: z.ZodBoolean;
         canInsertChild: z.ZodBoolean;
         canMove: z.ZodBoolean;
         canRemove: z.ZodBoolean;
     }, z.core.$strip>;
-}, z.core.$strip>;
+}, z.core.$strict>;
 export type SiteEditRenderEntry = z.infer<typeof SiteEditRenderEntrySchema>;
 export declare const SiteEditRenderDocumentSchema: z.ZodObject<{
     siteId: z.ZodString;
     snapshotId: z.ZodString;
     routeId: z.ZodString;
     version: z.ZodNumber;
-    rootKeys: z.ZodArray<z.ZodString>;
     entries: z.ZodArray<z.ZodObject<{
         key: z.ZodString;
-        tag: z.ZodString;
-        label: z.ZodString;
-        parentKey: z.ZodNullable<z.ZodString>;
-        childKeys: z.ZodArray<z.ZodString>;
+        pageCompositionUnitKey: z.ZodOptional<z.ZodString>;
         operationSummary: z.ZodObject<{
             canUpdateText: z.ZodBoolean;
             canInsertChild: z.ZodBoolean;
             canMove: z.ZodBoolean;
             canRemove: z.ZodBoolean;
         }, z.core.$strip>;
-    }, z.core.$strip>>;
-}, z.core.$strip>;
+    }, z.core.$strict>>;
+    pageComposition: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        status: z.ZodLiteral<"supported">;
+        containerKey: z.ZodString;
+        hasBusinessMembers: z.ZodBoolean;
+        placementUnitKeys: z.ZodArray<z.ZodString>;
+        placements: z.ZodArray<z.ZodObject<{
+            placementKey: z.ZodString;
+            placementUnitKey: z.ZodString;
+            relation: z.ZodEnum<{
+                before: "before";
+                after: "after";
+                prepend: "prepend";
+                append: "append";
+            }>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>, z.ZodObject<{
+        status: z.ZodLiteral<"unsupported">;
+        reason: z.ZodEnum<{
+            VERSION_STALE: "VERSION_STALE";
+            RECOVERY_REQUIRED: "RECOVERY_REQUIRED";
+            MULTIPLE_PAGE_RETURNS: "MULTIPLE_PAGE_RETURNS";
+            INDIRECT_RETURN_ONLY: "INDIRECT_RETURN_ONLY";
+            PAGE_CONTAINER_AMBIGUOUS: "PAGE_CONTAINER_AMBIGUOUS";
+            NO_SAFE_PAGE_PLACEMENT: "NO_SAFE_PAGE_PLACEMENT";
+            MEMBER_NOT_INDEPENDENT: "MEMBER_NOT_INDEPENDENT";
+            UNSUPPORTED_ROUTE_STRUCTURE: "UNSUPPORTED_ROUTE_STRUCTURE";
+            RUNTIME_ANCHOR_UNRESOLVED: "RUNTIME_ANCHOR_UNRESOLVED";
+            ROUTE_RETURN_NOT_FOUND: "ROUTE_RETURN_NOT_FOUND";
+        }>;
+        diagnostics: z.ZodArray<z.ZodObject<{
+            code: z.ZodString;
+            message: z.ZodString;
+        }, z.core.$strict>>;
+    }, z.core.$strict>], "status">;
+}, z.core.$strict>;
 export type SiteEditRenderDocument = z.infer<typeof SiteEditRenderDocumentSchema>;
 export declare const SiteEditExternalSourceKindSchema: z.ZodEnum<{
     "api-field": "api-field";
@@ -260,6 +287,7 @@ export declare const SiteEditStyleModelSchema: z.ZodUnion<readonly [z.ZodRecord<
             transform: "transform";
             width: "width";
             height: "height";
+            order: "order";
             display: "display";
             position: "position";
             top: "top";
@@ -272,7 +300,6 @@ export declare const SiteEditStyleModelSchema: z.ZodUnion<readonly [z.ZodRecord<
             flexGrow: "flexGrow";
             flexShrink: "flexShrink";
             flexBasis: "flexBasis";
-            order: "order";
             gridTemplateColumns: "gridTemplateColumns";
             gridTemplateRows: "gridTemplateRows";
             columns: "columns";
@@ -376,10 +403,10 @@ export declare const SiteEditStyleModelSchema: z.ZodUnion<readonly [z.ZodRecord<
             message: z.ZodString;
         }, z.core.$strip>>>;
         operationBoundary: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+            "insert-child": "insert-child";
             "update-text": "update-text";
             "update-array-item": "update-array-item";
             "remove-node": "remove-node";
-            "insert-child": "insert-child";
             "move-node": "move-node";
             "set-class-name-source": "set-class-name-source";
             "set-props": "set-props";
@@ -394,16 +421,16 @@ export declare const SiteEditStyleSourceSchema: z.ZodObject<{
     className: z.ZodString;
     sourceKind: z.ZodEnum<{
         missing: "missing";
+        "dynamic-expression": "dynamic-expression";
         "static-attribute": "static-attribute";
         "static-expression": "static-expression";
-        "dynamic-expression": "dynamic-expression";
     }>;
     editable: z.ZodBoolean;
     operationBoundary: z.ZodArray<z.ZodEnum<{
+        "insert-child": "insert-child";
         "update-text": "update-text";
         "update-array-item": "update-array-item";
         "remove-node": "remove-node";
-        "insert-child": "insert-child";
         "move-node": "move-node";
         "set-class-name-source": "set-class-name-source";
         "set-props": "set-props";
@@ -626,16 +653,16 @@ export declare const SiteEditObjectDetailSchema: z.ZodObject<{
         className: z.ZodString;
         sourceKind: z.ZodEnum<{
             missing: "missing";
+            "dynamic-expression": "dynamic-expression";
             "static-attribute": "static-attribute";
             "static-expression": "static-expression";
-            "dynamic-expression": "dynamic-expression";
         }>;
         editable: z.ZodBoolean;
         operationBoundary: z.ZodArray<z.ZodEnum<{
+            "insert-child": "insert-child";
             "update-text": "update-text";
             "update-array-item": "update-array-item";
             "remove-node": "remove-node";
-            "insert-child": "insert-child";
             "move-node": "move-node";
             "set-class-name-source": "set-class-name-source";
             "set-props": "set-props";
@@ -749,6 +776,26 @@ export declare const SiteEditObjectSummarySchema: z.ZodObject<{
 export type SiteEditObjectSummary = z.infer<typeof SiteEditObjectSummarySchema>;
 export declare const SiteEditObjectEditContextSchema: z.ZodObject<{
     key: z.ZodString;
+    tag: z.ZodString;
+    label: z.ZodString;
+    sourceLocator: z.ZodOptional<z.ZodObject<{
+        sourceFile: z.ZodString;
+        componentName: z.ZodString;
+        openingElementRange: z.ZodObject<{
+            startLine: z.ZodNumber;
+            startColumn: z.ZodNumber;
+            endLine: z.ZodNumber;
+            endColumn: z.ZodNumber;
+        }, z.core.$strip>;
+        structuralPath: z.ZodString;
+        textPreview: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    isOpaque: z.ZodBoolean;
+    ancestors: z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        label: z.ZodString;
+        tag: z.ZodString;
+    }, z.core.$strip>>;
     componentName: z.ZodString;
     sourceFile: z.ZodString;
     capabilities: z.ZodObject<{
@@ -813,91 +860,7 @@ export declare const SiteEditObjectEditContextSchema: z.ZodObject<{
             message: z.ZodString;
         }, z.core.$strip>>;
     }, z.core.$strip>;
-    writeTarget: z.ZodObject<{
-        kind: z.ZodEnum<{
-            "jsx-node": "jsx-node";
-            "component-proxy": "component-proxy";
-            "value-binding": "value-binding";
-            "route-export": "route-export";
-        }>;
-        file: z.ZodString;
-        componentName: z.ZodString;
-        isProxy: z.ZodBoolean;
-    }, z.core.$strip>;
-    effectiveWriteTarget: z.ZodOptional<z.ZodObject<{
-        kind: z.ZodEnum<{
-            "jsx-node": "jsx-node";
-            "route-export": "route-export";
-            "value-path": "value-path";
-            "external-entry": "external-entry";
-        }>;
-        file: z.ZodOptional<z.ZodString>;
-        isProxy: z.ZodBoolean;
-        displayPath: z.ZodOptional<z.ZodString>;
-        sourceType: z.ZodOptional<z.ZodEnum<{
-            "api-field": "api-field";
-            "cms-field": "cms-field";
-            "i18n-message": "i18n-message";
-            "config-entry": "config-entry";
-        }>>;
-        sourceId: z.ZodOptional<z.ZodString>;
-    }, z.core.$strip>>;
     provenanceChain: z.ZodOptional<z.ZodObject<{
-        finalSource: z.ZodNullable<z.ZodObject<{
-            kind: z.ZodUnion<readonly [z.ZodEnum<{
-                binding: "binding";
-                "imported-binding": "imported-binding";
-                "repeat-template": "repeat-template";
-                "jsx-literal": "jsx-literal";
-                "component-prop": "component-prop";
-                "object-field": "object-field";
-                "array-item": "array-item";
-                "conditional-branch": "conditional-branch";
-            }>, z.ZodEnum<{
-                "api-field": "api-field";
-                "cms-field": "cms-field";
-                "i18n-message": "i18n-message";
-                "config-entry": "config-entry";
-            }>]>;
-            file: z.ZodString;
-            displayPath: z.ZodString;
-            externalSource: z.ZodOptional<z.ZodObject<{
-                sourceType: z.ZodEnum<{
-                    "api-field": "api-field";
-                    "cms-field": "cms-field";
-                    "i18n-message": "i18n-message";
-                    "config-entry": "config-entry";
-                }>;
-                sourceId: z.ZodString;
-                adapterId: z.ZodOptional<z.ZodString>;
-            }, z.core.$strip>>;
-        }, z.core.$strip>>;
-        chain: z.ZodArray<z.ZodObject<{
-            kind: z.ZodUnion<readonly [z.ZodEnum<{
-                binding: "binding";
-                "imported-binding": "imported-binding";
-                "repeat-template": "repeat-template";
-                "jsx-literal": "jsx-literal";
-                "component-prop": "component-prop";
-                "object-field": "object-field";
-                "array-item": "array-item";
-                "conditional-branch": "conditional-branch";
-            }>, z.ZodEnum<{
-                "api-field": "api-field";
-                "cms-field": "cms-field";
-                "i18n-message": "i18n-message";
-                "config-entry": "config-entry";
-            }>]>;
-            file: z.ZodString;
-            displayName: z.ZodString;
-            canEditHere: z.ZodBoolean;
-        }, z.core.$strip>>;
-        confidence: z.ZodEnum<{
-            unknown: "unknown";
-            exact: "exact";
-            "safe-derived": "safe-derived";
-            partial: "partial";
-        }>;
         editMode: z.ZodEnum<{
             readonly: "readonly";
             direct: "direct";
@@ -910,23 +873,15 @@ export declare const SiteEditObjectEditContextSchema: z.ZodObject<{
             message: z.ZodString;
         }, z.core.$strip>>;
     }, z.core.$strip>>;
-    componentSemantic: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     textSegments: z.ZodArray<z.ZodObject<{
         index: z.ZodNumber;
-        value: z.ZodString;
         editable: z.ZodBoolean;
-        source: z.ZodNullable<z.ZodObject<{
-            kind: z.ZodEnum<{
-                literal: "literal";
-                binding: "binding";
-                "imported-binding": "imported-binding";
-                "repeat-template": "repeat-template";
-            }>;
-            file: z.ZodString;
-            expression: z.ZodString;
-            bindingName: z.ZodOptional<z.ZodString>;
-            path: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>>;
-        }, z.core.$strip>>;
+        sourceKind: z.ZodNullable<z.ZodEnum<{
+            literal: "literal";
+            binding: "binding";
+            "imported-binding": "imported-binding";
+            "repeat-template": "repeat-template";
+        }>>;
     }, z.core.$strip>>;
     boundaryKind: z.ZodNullable<z.ZodEnum<{
         "component-boundary": "component-boundary";
@@ -935,16 +890,6 @@ export declare const SiteEditObjectEditContextSchema: z.ZodObject<{
         "fragment-region": "fragment-region";
         "opaque-region": "opaque-region";
     }>>;
-    children: z.ZodArray<z.ZodObject<{
-        key: z.ZodString;
-        label: z.ZodString;
-        tag: z.ZodString;
-    }, z.core.$strip>>;
-    siblings: z.ZodArray<z.ZodObject<{
-        key: z.ZodString;
-        label: z.ZodString;
-        tag: z.ZodString;
-    }, z.core.$strip>>;
 }, z.core.$strip>;
 export type SiteEditObjectEditContext = z.infer<typeof SiteEditObjectEditContextSchema>;
 export declare const SiteEditObjectStyleDetailSchema: z.ZodObject<{
@@ -955,16 +900,16 @@ export declare const SiteEditObjectStyleDetailSchema: z.ZodObject<{
         className: z.ZodString;
         sourceKind: z.ZodEnum<{
             missing: "missing";
+            "dynamic-expression": "dynamic-expression";
             "static-attribute": "static-attribute";
             "static-expression": "static-expression";
-            "dynamic-expression": "dynamic-expression";
         }>;
         editable: z.ZodBoolean;
         operationBoundary: z.ZodArray<z.ZodEnum<{
+            "insert-child": "insert-child";
             "update-text": "update-text";
             "update-array-item": "update-array-item";
             "remove-node": "remove-node";
-            "insert-child": "insert-child";
             "move-node": "move-node";
             "set-class-name-source": "set-class-name-source";
             "set-props": "set-props";
@@ -983,13 +928,3 @@ export declare const SiteEditObjectStyleDetailSchema: z.ZodObject<{
     }, z.core.$strip>>;
 }, z.core.$strip>;
 export type SiteEditObjectStyleDetail = z.infer<typeof SiteEditObjectStyleDetailSchema>;
-export declare const SiteEditObjectContentDetailSchema: z.ZodObject<{
-    key: z.ZodString;
-    contentModel: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-}, z.core.$strip>;
-export type SiteEditObjectContentDetail = z.infer<typeof SiteEditObjectContentDetailSchema>;
-export declare const SiteEditObjectMediaDetailSchema: z.ZodObject<{
-    key: z.ZodString;
-    mediaModel: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-}, z.core.$strip>;
-export type SiteEditObjectMediaDetail = z.infer<typeof SiteEditObjectMediaDetailSchema>;

package/dist/site-edit-render-page-composition.d.ts

@@ -0,0 +1,84 @@
+import { z } from "zod";
+export declare const SiteEditRenderPagePlacementSchema: z.ZodObject<{
+    placementKey: z.ZodString;
+    placementUnitKey: z.ZodString;
+    relation: z.ZodEnum<{
+        before: "before";
+        after: "after";
+        prepend: "prepend";
+        append: "append";
+    }>;
+}, z.core.$strict>;
+export type SiteEditRenderPagePlacement = z.infer<typeof SiteEditRenderPagePlacementSchema>;
+export declare const SiteEditRenderPageCompositionSupportedSchema: z.ZodObject<{
+    status: z.ZodLiteral<"supported">;
+    containerKey: z.ZodString;
+    hasBusinessMembers: z.ZodBoolean;
+    placementUnitKeys: z.ZodArray<z.ZodString>;
+    placements: z.ZodArray<z.ZodObject<{
+        placementKey: z.ZodString;
+        placementUnitKey: z.ZodString;
+        relation: z.ZodEnum<{
+            before: "before";
+            after: "after";
+            prepend: "prepend";
+            append: "append";
+        }>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type SiteEditRenderPageCompositionSupported = z.infer<typeof SiteEditRenderPageCompositionSupportedSchema>;
+export declare const SiteEditRenderPageCompositionUnsupportedSchema: z.ZodObject<{
+    status: z.ZodLiteral<"unsupported">;
+    reason: z.ZodEnum<{
+        VERSION_STALE: "VERSION_STALE";
+        RECOVERY_REQUIRED: "RECOVERY_REQUIRED";
+        MULTIPLE_PAGE_RETURNS: "MULTIPLE_PAGE_RETURNS";
+        INDIRECT_RETURN_ONLY: "INDIRECT_RETURN_ONLY";
+        PAGE_CONTAINER_AMBIGUOUS: "PAGE_CONTAINER_AMBIGUOUS";
+        NO_SAFE_PAGE_PLACEMENT: "NO_SAFE_PAGE_PLACEMENT";
+        MEMBER_NOT_INDEPENDENT: "MEMBER_NOT_INDEPENDENT";
+        UNSUPPORTED_ROUTE_STRUCTURE: "UNSUPPORTED_ROUTE_STRUCTURE";
+        RUNTIME_ANCHOR_UNRESOLVED: "RUNTIME_ANCHOR_UNRESOLVED";
+        ROUTE_RETURN_NOT_FOUND: "ROUTE_RETURN_NOT_FOUND";
+    }>;
+    diagnostics: z.ZodArray<z.ZodObject<{
+        code: z.ZodString;
+        message: z.ZodString;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type SiteEditRenderPageCompositionUnsupported = z.infer<typeof SiteEditRenderPageCompositionUnsupportedSchema>;
+export declare const SiteEditRenderPageCompositionSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    status: z.ZodLiteral<"supported">;
+    containerKey: z.ZodString;
+    hasBusinessMembers: z.ZodBoolean;
+    placementUnitKeys: z.ZodArray<z.ZodString>;
+    placements: z.ZodArray<z.ZodObject<{
+        placementKey: z.ZodString;
+        placementUnitKey: z.ZodString;
+        relation: z.ZodEnum<{
+            before: "before";
+            after: "after";
+            prepend: "prepend";
+            append: "append";
+        }>;
+    }, z.core.$strict>>;
+}, z.core.$strict>, z.ZodObject<{
+    status: z.ZodLiteral<"unsupported">;
+    reason: z.ZodEnum<{
+        VERSION_STALE: "VERSION_STALE";
+        RECOVERY_REQUIRED: "RECOVERY_REQUIRED";
+        MULTIPLE_PAGE_RETURNS: "MULTIPLE_PAGE_RETURNS";
+        INDIRECT_RETURN_ONLY: "INDIRECT_RETURN_ONLY";
+        PAGE_CONTAINER_AMBIGUOUS: "PAGE_CONTAINER_AMBIGUOUS";
+        NO_SAFE_PAGE_PLACEMENT: "NO_SAFE_PAGE_PLACEMENT";
+        MEMBER_NOT_INDEPENDENT: "MEMBER_NOT_INDEPENDENT";
+        UNSUPPORTED_ROUTE_STRUCTURE: "UNSUPPORTED_ROUTE_STRUCTURE";
+        RUNTIME_ANCHOR_UNRESOLVED: "RUNTIME_ANCHOR_UNRESOLVED";
+        ROUTE_RETURN_NOT_FOUND: "ROUTE_RETURN_NOT_FOUND";
+    }>;
+    diagnostics: z.ZodArray<z.ZodObject<{
+        code: z.ZodString;
+        message: z.ZodString;
+    }, z.core.$strict>>;
+}, z.core.$strict>], "status">;
+export type SiteEditRenderPageComposition = z.infer<typeof SiteEditRenderPageCompositionSchema>;

package/dist/site-edit-session.d.ts

@@ -0,0 +1,15 @@
+import { z } from "zod";
+/**
+ * Binds a preview transport to the Designer editing session and activates one
+ * route before returning the session's first coherent document/history view.
+ */
+export declare const SiteEditInitializeSessionInputSchema: z.ZodObject<{
+    routeId: z.ZodString;
+    mutationContext: z.ZodOptional<z.ZodObject<{
+        editingSessionId: z.ZodString;
+        lockId: z.ZodString;
+        ownerId: z.ZodString;
+        leaseAssertion: z.ZodString;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type SiteEditInitializeSessionInput = z.infer<typeof SiteEditInitializeSessionInputSchema>;

package/dist/site-edit-version.d.ts

@@ -5,7 +5,7 @@
  *
  * 由 release-edit-engine-packages.ts 在 bump 版本时自动更新。
  */
-export declare const CURRENT_EDIT_ENGINE_VERSION = "0.4.9";
+export declare const CURRENT_EDIT_ENGINE_VERSION = "0.6.0";
 export declare const EDIT_ENGINE_VERSION_HEADER = "x-vcp-edit-engine-version";
 export declare const EDIT_ENGINE_VERSION_SOURCE_HEADER = "x-vcp-edit-engine-version-source";
 export type EditEngineVersionSource = "explicit" | "fallback_current" | "system_current";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vcp-dev/contracts",
-  "version": "0.4.9",
+  "version": "0.6.0",
   "type": "module",
   "license": "UNLICENSED",
   "repository": {