@zephytiju/juntai-typescript-sdk 3.5.0 → 3.7.0

package/dist/generated/prism.composition/types.gen.d.ts

@@ -53,6 +53,590 @@ export type ApplyVariant = {
      */
     key: string;
 };
+/**
+ * AuthoringCapabilities
+ */
+export type AuthoringCapabilities = {
+    /**
+     * Aspectratio
+     */
+    aspectRatio?: number | null;
+    maximumSpan?: AuthoringSpan | null;
+    minimumSpan?: AuthoringSpan | null;
+    /**
+     * Overflow
+     */
+    overflow?: 'host' | 'component' | 'clip' | null;
+    preferredSpan?: AuthoringSpan | null;
+    /**
+     * Resizable
+     */
+    resizable?: boolean | null;
+    /**
+     * Responsive
+     */
+    responsive?: boolean | null;
+    /**
+     * Supportedroles
+     */
+    supportedRoles: Array<string>;
+};
+/**
+ * AuthoringContext
+ */
+export type AuthoringContext = {
+    insertion: Compatibility;
+    /**
+     * Instanceid
+     */
+    instanceId?: string | null;
+    /**
+     * Releasekey
+     */
+    releaseKey: string;
+    /**
+     * Requirescustomlayout
+     */
+    requiresCustomLayout: boolean;
+    /**
+     * Targetslotid
+     */
+    targetSlotId: string;
+    /**
+     * Variants
+     */
+    variants: Array<VariantCompatibility>;
+};
+/**
+ * AuthoringDefinition
+ */
+export type AuthoringDefinition = {
+    /**
+     * Definition
+     */
+    definition: {
+        [key: string]: JsonValue;
+    } | boolean;
+    /**
+     * ExactSchemaRef
+     */
+    reference: {
+        /**
+         * Catalog
+         */
+        catalog: string;
+        /**
+         * Digest
+         */
+        digest: string;
+        /**
+         * Schema
+         */
+        schema: string;
+        /**
+         * Version
+         */
+        version: string;
+    };
+};
+/**
+ * AuthoringPresentation
+ */
+export type AuthoringPresentation = {
+    /**
+     * Category
+     */
+    category: string;
+    /**
+     * Compatibledistributions
+     */
+    compatibleDistributions: Array<string>;
+    /**
+     * Compatiblelayoutroles
+     */
+    compatibleLayoutRoles?: Array<string> | null;
+    /**
+     * Compatibleslotroles
+     */
+    compatibleSlotRoles?: Array<string> | null;
+    /**
+     * Description
+     */
+    description?: string | null;
+    /**
+     * Documentationurl
+     */
+    documentationUrl?: string | null;
+    /**
+     * Iconref
+     */
+    iconRef?: string | null;
+    /**
+     * Label
+     */
+    label: string;
+    /**
+     * Previewfixture
+     */
+    previewFixture?: string | null;
+    /**
+     * Requiredcapabilities
+     */
+    requiredCapabilities?: Array<string> | null;
+    /**
+     * Searchterms
+     */
+    searchTerms: Array<string>;
+};
+/**
+ * AuthoringProjection
+ *
+ * Snapshot only: at most 1 MiB, 128 contexts, 32 releases, 256 definitions.
+ *
+ * Over-limit/dependency failures return an explicit HTTP error. Select one
+ * instance or exact candidate to bound a page-wide read; nothing is truncated.
+ */
+export type AuthoringProjection = {
+    /**
+     * Contexts
+     */
+    contexts: Array<AuthoringContext>;
+    /**
+     * Definitions
+     */
+    definitions: Array<AuthoringDefinition>;
+    /**
+     * Evaluateddraftetag
+     */
+    evaluatedDraftEtag: string;
+    /**
+     * Releases
+     */
+    releases: Array<AuthoringRelease>;
+    templateRelease: TemplateRef;
+    /**
+     * Version
+     */
+    version: 1;
+};
+/**
+ * AuthoringRelease
+ */
+export type AuthoringRelease = {
+    /**
+     * Bindingfingerprint
+     */
+    bindingFingerprint: string;
+    componentRelease: ComponentRelease;
+    /**
+     * SchemaContract
+     *
+     * Resolved immutable declarations, with no local definition names to interpret.
+     */
+    declarations: {
+        /**
+         * Actions
+         */
+        actions: Array<{
+            /**
+             * Key
+             */
+            key: string;
+            /**
+             * Label
+             */
+            label: string;
+            /**
+             * ExactSchemaRef
+             */
+            request_schema_ref: {
+                /**
+                 * Catalog
+                 */
+                catalog: string;
+                /**
+                 * Digest
+                 */
+                digest: string;
+                /**
+                 * Schema
+                 */
+                schema: string;
+                /**
+                 * Version
+                 */
+                version: string;
+            };
+            response_schema_ref: {
+                /**
+                 * Catalog
+                 */
+                catalog: string;
+                /**
+                 * Digest
+                 */
+                digest: string;
+                /**
+                 * Schema
+                 */
+                schema: string;
+                /**
+                 * Version
+                 */
+                version: string;
+            } | null;
+        }>;
+        /**
+         * ConfigurationSchema[ExactSchemaRef]
+         */
+        configuration: {
+            defaults: unknown;
+            /**
+             * Inspector Hints
+             */
+            inspector_hints: {
+                [key: string]: unknown;
+            };
+            /**
+             * ExactSchemaRef
+             */
+            schema_ref: {
+                /**
+                 * Catalog
+                 */
+                catalog: string;
+                /**
+                 * Digest
+                 */
+                digest: string;
+                /**
+                 * Schema
+                 */
+                schema: string;
+                /**
+                 * Version
+                 */
+                version: string;
+            };
+        };
+        /**
+         * Events
+         */
+        events: Array<{
+            /**
+             * Key
+             */
+            key: string;
+            /**
+             * Label
+             */
+            label: string;
+            /**
+             * ExactSchemaRef
+             */
+            payload_schema_ref: {
+                /**
+                 * Catalog
+                 */
+                catalog: string;
+                /**
+                 * Digest
+                 */
+                digest: string;
+                /**
+                 * Schema
+                 */
+                schema: string;
+                /**
+                 * Version
+                 */
+                version: string;
+            };
+        }>;
+        /**
+         * Inputs
+         */
+        inputs: Array<{
+            /**
+             * Key
+             */
+            key: string;
+            /**
+             * Label
+             */
+            label: string;
+            /**
+             * Max Bytes
+             */
+            max_bytes: number | null;
+            /**
+             * Required
+             */
+            required: boolean;
+            /**
+             * ExactSchemaRef
+             */
+            schema_ref: {
+                /**
+                 * Catalog
+                 */
+                catalog: string;
+                /**
+                 * Digest
+                 */
+                digest: string;
+                /**
+                 * Schema
+                 */
+                schema: string;
+                /**
+                 * Version
+                 */
+                version: string;
+            };
+            /**
+             * Value Semantics
+             */
+            value_semantics: 'stable-identifier' | 'bounded-value';
+        }>;
+        /**
+         * Intents
+         */
+        intents: Array<{
+            /**
+             * Key
+             */
+            key: string;
+            /**
+             * Label
+             */
+            label: string;
+            /**
+             * ExactSchemaRef
+             */
+            payload_schema_ref: {
+                /**
+                 * Catalog
+                 */
+                catalog: string;
+                /**
+                 * Digest
+                 */
+                digest: string;
+                /**
+                 * Schema
+                 */
+                schema: string;
+                /**
+                 * Version
+                 */
+                version: string;
+            };
+        }>;
+        /**
+         * Outputs
+         */
+        outputs: Array<{
+            /**
+             * Key
+             */
+            key: string;
+            /**
+             * Label
+             */
+            label: string;
+            /**
+             * Max Bytes
+             */
+            max_bytes: number | null;
+            /**
+             * ExactSchemaRef
+             */
+            schema_ref: {
+                /**
+                 * Catalog
+                 */
+                catalog: string;
+                /**
+                 * Digest
+                 */
+                digest: string;
+                /**
+                 * Schema
+                 */
+                schema: string;
+                /**
+                 * Version
+                 */
+                version: string;
+            };
+            /**
+             * Value Semantics
+             */
+            value_semantics: 'stable-identifier' | 'bounded-value';
+        }>;
+        /**
+         * Slots
+         */
+        slots: Array<{
+            /**
+             * Accepted Roles
+             */
+            accepted_roles: Array<string>;
+            /**
+             * Cardinality
+             */
+            cardinality: 'zero-or-one' | 'exactly-one' | 'zero-or-more' | 'one-or-more';
+            /**
+             * Key
+             */
+            key: string;
+            /**
+             * Label
+             */
+            label: string;
+            /**
+             * Nesting Depth
+             */
+            nesting_depth: number;
+            /**
+             * ExactSchemaRef
+             */
+            payload_schema_ref: {
+                /**
+                 * Catalog
+                 */
+                catalog: string;
+                /**
+                 * Digest
+                 */
+                digest: string;
+                /**
+                 * Schema
+                 */
+                schema: string;
+                /**
+                 * Version
+                 */
+                version: string;
+            };
+        }>;
+        /**
+         * State
+         */
+        state: Array<{
+            /**
+             * Key
+             */
+            key: string;
+            /**
+             * Label
+             */
+            label: string;
+            /**
+             * Max Bytes
+             */
+            max_bytes: number | null;
+            /**
+             * ExactSchemaRef
+             */
+            schema_ref: {
+                /**
+                 * Catalog
+                 */
+                catalog: string;
+                /**
+                 * Digest
+                 */
+                digest: string;
+                /**
+                 * Schema
+                 */
+                schema: string;
+                /**
+                 * Version
+                 */
+                version: string;
+            };
+            /**
+             * Value Semantics
+             */
+            value_semantics: 'stable-identifier' | 'bounded-value';
+        }>;
+    };
+    /**
+     * Defaultvariantkey
+     */
+    defaultVariantKey: string | null;
+    layoutCapabilities: AuthoringCapabilities;
+    presentation: AuthoringPresentation;
+    /**
+     * Releasekey
+     */
+    releaseKey: string;
+    /**
+     * Sdkmajor
+     */
+    sdkMajor: number;
+    /**
+     * Variants
+     */
+    variants: Array<AuthoringVariant>;
+};
+/**
+ * AuthoringSpan
+ */
+export type AuthoringSpan = {
+    /**
+     * Columns
+     */
+    columns: number;
+    /**
+     * Rows
+     */
+    rows: number;
+};
+/**
+ * AuthoringVariant
+ */
+export type AuthoringVariant = {
+    /**
+     * Description
+     */
+    description?: string | null;
+    /**
+     * Isdefault
+     */
+    isDefault: boolean;
+    /**
+     * Key
+     */
+    key: string;
+    /**
+     * Label
+     */
+    label: string;
+    /**
+     * Layoutconfig
+     */
+    layoutConfig: ({
+        kind: 'alignment';
+    } & AlignmentConfig) | ({
+        kind: 'stack';
+    } & StackConfigOutput) | ({
+        kind: 'grid';
+    } & GridConfigOutput) | ({
+        kind: 'responsive';
+    } & ResponsiveConfigOutput);
+    /**
+     * Layoutconfigdigest
+     */
+    layoutConfigDigest: string;
+    /**
+     * Layoutconfigversion
+     */
+    layoutConfigVersion: 1;
+};
 /**
  * Binding
  */
@@ -128,6 +712,40 @@ export type BreakpointOutput = {
      */
     minWidth: number;
 };
+/**
+ * Compatibility
+ */
+export type Compatibility = {
+    /**
+     * Reasons
+     */
+    reasons: Array<CompatibilityReason>;
+    /**
+     * Status
+     */
+    status: 'compatible' | 'incompatible';
+};
+/**
+ * CompatibilityReason
+ */
+export type CompatibilityReason = {
+    /**
+     * Code
+     */
+    code: string;
+    /**
+     * Message
+     */
+    message: string;
+    /**
+     * Path
+     */
+    path: string;
+    /**
+     * Targetid
+     */
+    targetId: string;
+};
 /**
  * Component
  */
@@ -561,6 +1179,12 @@ export type LayoutNodeInput = {
      * Slotname
      */
     slotName?: string | null;
+    /**
+     * Splitallocation
+     *
+     * Optional selected shares for a template-declared resizable split. Positive integer units total 1000000; immediate child IDs occur exactly once in child order. Omit for legacy behavior; explicit null is invalid. Requires compatible readers.
+     */
+    splitAllocation?: SplitAllocation;
 };
 /**
  * LayoutNode
@@ -595,6 +1219,12 @@ export type LayoutNodeOutput = {
      * Slotname
      */
     slotName?: string | null;
+    /**
+     * Splitallocation
+     *
+     * Optional selected shares for a template-declared resizable split. Positive integer units total 1000000; immediate child IDs occur exactly once in child order. Omit for legacy behavior; explicit null is invalid. Requires compatible readers.
+     */
+    splitAllocation?: SplitAllocation;
 };
 /**
  * LayoutRegion
@@ -890,6 +1520,37 @@ export type PageDocumentOutput = {
     navigationStyle: 'left' | 'top' | 'both';
     templateRelease: TemplateRef;
 };
+/**
+ * PageDraftResponse
+ */
+export type PageDraftResponse = {
+    authoring?: AuthoringProjection | null;
+    /**
+     * Digest
+     */
+    digest?: string | null;
+    document: PageDocumentOutput;
+    /**
+     * Etag
+     */
+    etag?: string | null;
+    /**
+     * Id
+     */
+    id: string;
+    /**
+     * Lasteditedat
+     */
+    lastEditedAt?: string | null;
+    /**
+     * Lasteditorid
+     */
+    lastEditorId?: string | null;
+    /**
+     * State
+     */
+    state?: string | null;
+};
 /**
  * PageIdentity
  */
@@ -1337,6 +1998,32 @@ export type SchemaPin = {
      */
     version: string;
 };
+/**
+ * SplitAllocation
+ */
+export type SplitAllocation = {
+    /**
+     * Shares
+     */
+    shares: Array<SplitShare>;
+    /**
+     * Version
+     */
+    version: 1;
+};
+/**
+ * SplitShare
+ */
+export type SplitShare = {
+    /**
+     * Childid
+     */
+    childId: string;
+    /**
+     * Units
+     */
+    units: number;
+};
 /**
  * StackConfig
  */
@@ -1460,6 +2147,16 @@ export type ValidationError = {
      */
     type: string;
 };
+/**
+ * VariantCompatibility
+ */
+export type VariantCompatibility = {
+    compatibility: Compatibility;
+    /**
+     * Key
+     */
+    key: string;
+};
 /**
  * _HTTPErrorDetails
  */
@@ -2429,13 +3126,40 @@ export type ApplyLayoutVariantResponses = {
 export type ApplyLayoutVariantResponse = ApplyLayoutVariantResponses[keyof ApplyLayoutVariantResponses];
 export type GetUiPageDraftData = {
     body?: never;
+    headers?: {
+        /**
+         * Optional current Draft ETag for an authoring projection.
+         */
+        'If-Match'?: string;
+    };
     path: {
         /**
          * Page Id
          */
         page_id: string;
     };
-    query?: never;
+    query?: {
+        /**
+         * Includeauthoring
+         */
+        includeAuthoring?: boolean;
+        /**
+         * Blueprintassetid
+         */
+        blueprintAssetId?: string | null;
+        /**
+         * Blueprintversionid
+         */
+        blueprintVersionId?: string | null;
+        /**
+         * Targetslotid
+         */
+        targetSlotId?: string | null;
+        /**
+         * Instanceid
+         */
+        instanceId?: string | null;
+    };
     url: '/v1/ui-pages/{page_id}/draft';
 };
 export type GetUiPageDraftErrors = {
@@ -2485,7 +3209,7 @@ export type GetUiPageDraftResponses = {
     /**
      * Successful Response
      */
-    200: ResourceDocumentPageDocument;
+    200: PageDraftResponse;
 };
 export type GetUiPageDraftResponse = GetUiPageDraftResponses[keyof GetUiPageDraftResponses];
 export type UpdateUiPageDraftData = {