@contentful/experience-design-system-types 2.42.1-dev-build-f69db6bf.0 → 2.43.0-alpha.0

package/dist/src/cdf/schema.d.ts

@@ -1,11 +1,4 @@
 export declare const CDF_SCHEMA_URL = "https://contentful.com/schemas/cdf";
-/**
- * Components and design tokens live in one recursive tree. A leaf's `$type`
- * decides what it is ('component' vs. a DESIGN_TOKEN_TYPES member), so the
- * same `group` container can hold either kind side by side. There is no
- * separate manifest envelope — this document is the single file/wire
- * payload sent to preview/apply.
- */
 export declare const cdfJsonSchema: {
     readonly $schema: "http://json-schema.org/draft-07/schema#";
     readonly $id: "https://contentful.com/schemas/cdf";
@@ -48,6 +41,15 @@ export declare const cdfJsonSchema: {
                         readonly $ref: "#/definitions/property";
                     };
                 };
+                readonly $model: {
+                    readonly $ref: "#/definitions/modelBinding";
+                };
+                readonly $representationPlans: {
+                    readonly type: "object";
+                    readonly additionalProperties: {
+                        readonly $ref: "#/definitions/representationPlan";
+                    };
+                };
                 readonly $slots: {
                     readonly type: "object";
                     readonly additionalProperties: {
@@ -59,15 +61,60 @@ export declare const cdfJsonSchema: {
         };
         readonly property: {
             readonly type: "object";
+            readonly allOf: readonly [{
+                if: {
+                    required: string[];
+                };
+                then: {
+                    anyOf: {
+                        properties: {
+                            $type: {
+                                const: string;
+                            };
+                            $values: {
+                                type: string;
+                                minItems: number;
+                                uniqueItems: boolean;
+                                items: {
+                                    type: string;
+                                };
+                            };
+                        };
+                    }[];
+                };
+            }];
             readonly required: readonly ["$type", "$category"];
             readonly properties: {
-                readonly $type: {
+                readonly '$token.allowed': {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                };
+                readonly value: {};
+                readonly valueType: {
+                    readonly $ref: "#/definitions/field";
+                };
+                readonly discriminator: {
                     readonly type: "string";
-                    readonly enum: readonly ["string", "richtext", "number", "media", "link", "enum", "token", "boolean"];
+                    readonly minLength: 1;
                 };
-                readonly $category: {
+                readonly members: {
+                    readonly type: "array";
+                    readonly minItems: 2;
+                    readonly items: {
+                        readonly $ref: "#/definitions/field";
+                    };
+                };
+                readonly allowedResources: {
+                    readonly $ref: "#/definitions/allowedResources";
+                };
+                readonly $sourceInput: {
+                    readonly $ref: "#/definitions/sourceInput";
+                };
+                readonly '$token.kind': {
                     readonly type: "string";
-                    readonly enum: readonly ["content", "design", "state", "unattached"];
+                    readonly minLength: 1;
                 };
                 readonly $description: {
                     readonly type: "string";
@@ -78,19 +125,25 @@ export declare const cdfJsonSchema: {
                 readonly $default: {};
                 readonly $values: {
                     readonly type: "array";
-                    readonly items: {
-                        readonly type: "string";
+                    readonly minItems: 1;
+                };
+                readonly $items: {
+                    readonly $ref: "#/definitions/field";
+                };
+                readonly $fields: {
+                    readonly type: "object";
+                    readonly minProperties: 1;
+                    readonly additionalProperties: {
+                        readonly $ref: "#/definitions/field";
                     };
                 };
-                readonly '$token.kind': {
+                readonly $type: {
                     readonly type: "string";
-                    readonly minLength: 1;
+                    readonly enum: readonly ["string", "richtext", "number", "media", "link", "token", "boolean", "array", "record", "Integer", "DateTime", "Literal", "RichText", "JSON", "ResourceLink", "DiscriminatedUnion"];
                 };
-                readonly '$token.allowed': {
-                    readonly type: "array";
-                    readonly items: {
-                        readonly type: "string";
-                    };
+                readonly $category: {
+                    readonly type: "string";
+                    readonly enum: readonly ["content", "design", "state", "unattached"];
                 };
             };
             readonly if: {
@@ -108,9 +161,714 @@ export declare const cdfJsonSchema: {
             };
             readonly additionalProperties: false;
         };
+        readonly field: {
+            readonly type: "object";
+            readonly allOf: readonly [{
+                if: {
+                    required: string[];
+                };
+                then: {
+                    anyOf: {
+                        properties: {
+                            $type: {
+                                const: string;
+                            };
+                            $values: {
+                                type: string;
+                                minItems: number;
+                                uniqueItems: boolean;
+                                items: {
+                                    type: string;
+                                };
+                            };
+                        };
+                    }[];
+                };
+            }];
+            readonly required: readonly ["$type"];
+            readonly properties: {
+                readonly '$token.allowed': {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                };
+                readonly value: {};
+                readonly valueType: {
+                    readonly $ref: "#/definitions/field";
+                };
+                readonly discriminator: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                };
+                readonly members: {
+                    readonly type: "array";
+                    readonly minItems: 2;
+                    readonly items: {
+                        readonly $ref: "#/definitions/field";
+                    };
+                };
+                readonly allowedResources: {
+                    readonly $ref: "#/definitions/allowedResources";
+                };
+                readonly '$token.kind': {
+                    readonly type: "string";
+                };
+                readonly $description: {
+                    readonly type: "string";
+                };
+                readonly $required: {
+                    readonly type: "boolean";
+                };
+                readonly $default: {};
+                readonly $values: {
+                    readonly type: "array";
+                    readonly minItems: 1;
+                };
+                readonly $items: {
+                    readonly $ref: "#/definitions/field";
+                };
+                readonly $fields: {
+                    readonly type: "object";
+                    readonly minProperties: 1;
+                    readonly additionalProperties: {
+                        readonly $ref: "#/definitions/field";
+                    };
+                };
+                readonly $type: {
+                    readonly enum: readonly ["string", "richtext", "number", "media", "link", "token", "boolean", "array", "record", "Integer", "DateTime", "Literal", "RichText", "JSON", "ResourceLink", "DiscriminatedUnion"];
+                };
+                readonly $category: {
+                    readonly enum: readonly ["content", "design", "state", "unattached"];
+                };
+            };
+            readonly additionalProperties: false;
+        };
+        readonly allowedResources: {
+            readonly type: "array";
+            readonly minItems: 1;
+            readonly items: {
+                readonly type: "object";
+                readonly required: readonly ["type", "source"];
+                readonly properties: {
+                    readonly type: {
+                        readonly enum: readonly ["Contentful:Entry", "Contentful:Asset"];
+                    };
+                    readonly source: {
+                        readonly const: "crn:contentful:::content:spaces/$self/environments/$self";
+                    };
+                    readonly allowedTypes: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                    };
+                };
+                readonly allOf: readonly [{
+                    readonly if: {
+                        readonly properties: {
+                            readonly type: {
+                                readonly const: "Contentful:Entry";
+                            };
+                        };
+                    };
+                    readonly then: {
+                        readonly required: readonly ["allowedTypes"];
+                    };
+                    readonly else: {
+                        readonly not: {
+                            readonly required: readonly ["allowedTypes"];
+                        };
+                    };
+                }];
+                readonly additionalProperties: false;
+            };
+        };
+        readonly sourceInput: {
+            readonly type: "object";
+            readonly required: readonly ["schemaVersion", "componentId", "componentDeclarationId", "rootSymbolId", "inputName", "inputPath"];
+            readonly properties: {
+                readonly schemaVersion: {
+                    readonly const: 1;
+                };
+                readonly componentId: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                };
+                readonly componentDeclarationId: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                };
+                readonly rootSymbolId: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                };
+                readonly inputName: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                };
+                readonly inputPath: {
+                    readonly type: "array";
+                    readonly minItems: 1;
+                    readonly items: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                    };
+                };
+            };
+            readonly additionalProperties: false;
+        };
+        readonly modelBinding: {
+            readonly type: "object";
+            readonly required: readonly ["planId", "componentId", "propertyId", "nodeId"];
+            readonly properties: {
+                readonly planId: {
+                    readonly type: "string";
+                };
+                readonly componentId: {
+                    readonly type: "string";
+                };
+                readonly propertyId: {
+                    readonly type: "string";
+                };
+                readonly nodeId: {
+                    readonly type: "string";
+                };
+                readonly sourceNodeId: {
+                    readonly type: "string";
+                };
+            };
+            readonly additionalProperties: false;
+        };
+        readonly modelCardinality: {
+            readonly type: "object";
+            readonly required: readonly ["min", "max", "ordered"];
+            readonly properties: {
+                readonly min: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                };
+                readonly max: {
+                    readonly type: readonly ["integer", "null"];
+                    readonly minimum: 0;
+                };
+                readonly ordered: {
+                    readonly type: "boolean";
+                };
+                readonly tuplePosition: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                };
+                readonly rest: {
+                    readonly type: "boolean";
+                };
+            };
+            readonly additionalProperties: false;
+        };
+        readonly targetDefinition: {
+            readonly type: "object";
+            readonly required: readonly ["type"];
+            readonly properties: {
+                readonly values: {
+                    readonly type: "array";
+                    readonly items: {};
+                };
+                readonly defaultValue: {};
+                readonly items: {
+                    readonly $ref: "#/definitions/targetDefinition";
+                };
+                readonly fields: {
+                    readonly type: "object";
+                    readonly additionalProperties: {
+                        readonly $ref: "#/definitions/targetDefinition";
+                    };
+                };
+                readonly allowedResources: {
+                    readonly $ref: "#/definitions/allowedResources";
+                };
+                readonly value: {};
+                readonly valueType: {
+                    readonly $ref: "#/definitions/targetDefinition";
+                };
+                readonly discriminator: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                };
+                readonly members: {
+                    readonly type: "array";
+                    readonly minItems: 2;
+                    readonly items: {
+                        readonly $ref: "#/definitions/targetDefinition";
+                    };
+                };
+                readonly id: {
+                    readonly type: "string";
+                };
+                readonly name: {
+                    readonly type: "string";
+                };
+                readonly description: {
+                    readonly type: "string";
+                };
+                readonly required: {
+                    readonly type: "boolean";
+                };
+                readonly type: {
+                    readonly enum: readonly ["String", "Number", "Boolean", "Array", "Record", "Integer", "DateTime", "RichText", "JSON", "ResourceLink", "Literal", "DiscriminatedUnion"];
+                };
+            };
+            readonly additionalProperties: false;
+        };
+        readonly representationProposal: {
+            readonly type: "object";
+            readonly required: readonly ["componentId", "propertyId", "key", "name", "sourceRevision", "sourceNodeIds", "declaredConstraints", "provenConstraints", "observations", "judgment", "desiredType", "desiredDefinition"];
+            readonly properties: {
+                readonly componentId: {
+                    readonly type: "string";
+                };
+                readonly propertyId: {
+                    readonly type: "string";
+                };
+                readonly key: {
+                    readonly type: "string";
+                };
+                readonly name: {
+                    readonly type: "string";
+                };
+                readonly sourceRevision: {
+                    readonly type: "string";
+                };
+                readonly sourceNodeIds: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                };
+                readonly declaredConstraints: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly required: readonly ["nodeId", "statement"];
+                        readonly properties: {
+                            readonly nodeId: {
+                                readonly type: "string";
+                            };
+                            readonly statement: {
+                                readonly type: "string";
+                            };
+                        };
+                        readonly additionalProperties: false;
+                    };
+                };
+                readonly provenConstraints: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly required: readonly ["nodeId", "statement"];
+                        readonly properties: {
+                            readonly nodeId: {
+                                readonly type: "string";
+                            };
+                            readonly statement: {
+                                readonly type: "string";
+                            };
+                        };
+                        readonly additionalProperties: false;
+                    };
+                };
+                readonly observations: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly required: readonly ["nodeId", "value"];
+                        readonly properties: {
+                            readonly nodeId: {
+                                readonly type: "string";
+                            };
+                            readonly value: {};
+                        };
+                        readonly additionalProperties: false;
+                    };
+                };
+                readonly judgment: {
+                    readonly type: "string";
+                };
+                readonly desiredType: {
+                    readonly enum: readonly ["String", "Number", "Boolean", "Array", "Record", "Integer", "DateTime", "RichText", "JSON", "ResourceLink", "Literal", "DiscriminatedUnion"];
+                };
+                readonly desiredDefinition: {
+                    readonly $ref: "#/definitions/targetDefinition";
+                };
+                readonly compatibility: {
+                    readonly type: "object";
+                    readonly required: readonly ["status", "sourceUseRefs", "unresolvedRequirements"];
+                    readonly properties: {
+                        readonly status: {
+                            readonly enum: readonly ["judged-compatible", "unresolved", "contradicted"];
+                        };
+                        readonly sourceUseRefs: {
+                            readonly type: "array";
+                            readonly uniqueItems: true;
+                            readonly items: {
+                                readonly type: "string";
+                                readonly minLength: 1;
+                            };
+                        };
+                        readonly unresolvedRequirements: {
+                            readonly type: "array";
+                            readonly items: {
+                                readonly type: "string";
+                                readonly minLength: 1;
+                            };
+                        };
+                    };
+                    readonly additionalProperties: false;
+                };
+            };
+            readonly additionalProperties: false;
+        };
+        readonly representationPlan: {
+            readonly type: "object";
+            readonly required: readonly ["schemaVersion", "id", "kind", "identity", "sourceModel", "sourceDigest", "contextDigest", "logicalGraph", "category", "defaultIntent", "models", "mappings", "issues", "sdkValid", "requirements"];
+            readonly properties: {
+                readonly proposal: {
+                    readonly $ref: "#/definitions/representationProposal";
+                };
+                readonly schemaVersion: {
+                    readonly const: 1;
+                };
+                readonly id: {
+                    readonly type: "string";
+                };
+                readonly kind: {
+                    readonly enum: readonly ["native", "component-model"];
+                };
+                readonly identity: {
+                    readonly type: "object";
+                    readonly required: readonly ["componentId", "propertyId", "key", "sourceRevision", "nodeId"];
+                    readonly properties: {
+                        readonly componentId: {
+                            readonly type: "string";
+                        };
+                        readonly propertyId: {
+                            readonly type: "string";
+                        };
+                        readonly key: {
+                            readonly type: "string";
+                        };
+                        readonly sourceRevision: {
+                            readonly type: "string";
+                        };
+                        readonly nodeId: {
+                            readonly type: "string";
+                        };
+                    };
+                    readonly additionalProperties: false;
+                };
+                readonly logicalGraph: {
+                    readonly type: "object";
+                };
+                readonly sourceModel: {
+                    readonly type: "object";
+                };
+                readonly contextSnapshot: {};
+                readonly sourceDigest: {
+                    readonly type: "string";
+                };
+                readonly contextDigest: {
+                    readonly type: "string";
+                };
+                readonly category: {
+                    readonly enum: readonly ["content", "design", "state", "unattached"];
+                };
+                readonly defaultIntent: {
+                    readonly oneOf: readonly [{
+                        readonly type: "object";
+                        readonly required: readonly ["action"];
+                        readonly properties: {
+                            readonly action: {
+                                readonly enum: readonly ["absent", "clear"];
+                            };
+                        };
+                        readonly additionalProperties: false;
+                    }, {
+                        readonly type: "object";
+                        readonly required: readonly ["action", "value"];
+                        readonly properties: {
+                            readonly action: {
+                                readonly const: "set";
+                            };
+                            readonly value: {};
+                        };
+                        readonly additionalProperties: false;
+                    }];
+                };
+                readonly sourceDefault: {
+                    readonly type: "object";
+                };
+                readonly nativeDefinition: {
+                    readonly $ref: "#/definitions/property";
+                };
+                readonly models: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly required: readonly ["key", "originalKey", "nodeId", "entry"];
+                        readonly properties: {
+                            readonly key: {
+                                readonly type: "string";
+                            };
+                            readonly originalKey: {
+                                readonly type: "string";
+                            };
+                            readonly nodeId: {
+                                readonly type: "string";
+                            };
+                            readonly entry: {
+                                readonly $ref: "#/definitions/component";
+                            };
+                        };
+                        readonly additionalProperties: false;
+                    };
+                };
+                readonly modelExplorations: {
+                    readonly type: "array";
+                    readonly items: {
+                        schemas: Record<string, import("zod/v4/core").ZodStandardJSONSchemaPayload<import("zod/v4/core").$ZodType>>;
+                    };
+                };
+                readonly attachment: {
+                    readonly type: "object";
+                    readonly required: readonly ["slot", "definition"];
+                    readonly properties: {
+                        readonly slot: {
+                            readonly type: "string";
+                        };
+                        readonly definition: {
+                            readonly $ref: "#/definitions/slot";
+                        };
+                    };
+                    readonly additionalProperties: false;
+                };
+                readonly mappings: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly required: readonly ["nodeId", "path", "required", "nullable", "undefinable", "disposition"];
+                        readonly properties: {
+                            readonly nodeId: {
+                                readonly type: "string";
+                            };
+                            readonly sourceNodeId: {
+                                readonly type: "string";
+                            };
+                            readonly readonly: {
+                                readonly type: "boolean";
+                            };
+                            readonly occurrenceReadonly: {
+                                readonly type: "boolean";
+                            };
+                            readonly intrinsicReadonly: {
+                                readonly type: "boolean";
+                            };
+                            readonly defaultIntent: {
+                                readonly type: "object";
+                            };
+                            readonly path: {
+                                readonly type: "array";
+                                readonly items: {
+                                    readonly type: "object";
+                                };
+                            };
+                            readonly required: {
+                                readonly type: "boolean";
+                            };
+                            readonly nullable: {
+                                readonly type: readonly ["boolean", "null"];
+                            };
+                            readonly undefinable: {
+                                readonly type: readonly ["boolean", "null"];
+                            };
+                            readonly disposition: {
+                                readonly enum: readonly ["native-field", "model", "slot", "reference", "reconstruction", "held"];
+                            };
+                            readonly reconstruction: {
+                                readonly oneOf: readonly [{
+                                    readonly type: "object";
+                                    readonly required: readonly ["kind", "value"];
+                                    readonly properties: {
+                                        readonly kind: {
+                                            readonly const: "fixed-value";
+                                        };
+                                        readonly value: {};
+                                    };
+                                    readonly additionalProperties: false;
+                                }, {
+                                    readonly type: "object";
+                                    readonly required: readonly ["kind", "valueNodeId"];
+                                    readonly properties: {
+                                        readonly kind: {
+                                            readonly const: "optional-value";
+                                        };
+                                        readonly valueNodeId: {
+                                            readonly type: "string";
+                                        };
+                                    };
+                                    readonly additionalProperties: false;
+                                }, {
+                                    readonly type: "object";
+                                    readonly required: readonly ["kind", "field", "valueNodeId"];
+                                    readonly properties: {
+                                        readonly kind: {
+                                            readonly const: "object-envelope";
+                                        };
+                                        readonly field: {
+                                            readonly type: "string";
+                                        };
+                                        readonly valueNodeId: {
+                                            readonly type: "string";
+                                        };
+                                    };
+                                    readonly additionalProperties: false;
+                                }, {
+                                    readonly type: "object";
+                                    readonly required: readonly ["kind", "itemNodeId"];
+                                    readonly properties: {
+                                        readonly kind: {
+                                            readonly const: "ordered-array";
+                                        };
+                                        readonly itemNodeId: {
+                                            readonly type: "string";
+                                        };
+                                    };
+                                    readonly additionalProperties: false;
+                                }, {
+                                    readonly type: "object";
+                                    readonly required: readonly ["kind", "state"];
+                                    readonly properties: {
+                                        readonly kind: {
+                                            readonly const: "empty-value";
+                                        };
+                                        readonly state: {
+                                            readonly enum: readonly ["null", "undefined", "never"];
+                                        };
+                                    };
+                                    readonly additionalProperties: false;
+                                }];
+                            };
+                            readonly componentKey: {
+                                readonly type: "string";
+                            };
+                            readonly field: {
+                                readonly type: "string";
+                            };
+                            readonly slot: {
+                                readonly type: "string";
+                            };
+                            readonly targetNodeId: {
+                                readonly type: "string";
+                            };
+                            readonly reason: {
+                                readonly type: "string";
+                            };
+                            readonly withinValue: {
+                                readonly type: "object";
+                                readonly required: readonly ["ownerNodeId", "path"];
+                                readonly properties: {
+                                    readonly ownerNodeId: {
+                                        readonly type: "string";
+                                    };
+                                    readonly path: {
+                                        readonly type: "array";
+                                        readonly items: {
+                                            readonly type: "object";
+                                        };
+                                    };
+                                };
+                                readonly additionalProperties: false;
+                            };
+                            readonly branchConditions: {
+                                readonly type: "array";
+                                readonly items: {
+                                    readonly type: "object";
+                                };
+                            };
+                            readonly variant: {
+                                readonly type: "object";
+                                readonly required: readonly ["wrapperKey", "slot", "componentKey"];
+                                readonly properties: {
+                                    readonly wrapperKey: {
+                                        readonly type: "string";
+                                    };
+                                    readonly slot: {
+                                        readonly type: "string";
+                                    };
+                                    readonly componentKey: {
+                                        readonly type: "string";
+                                    };
+                                };
+                                readonly additionalProperties: false;
+                            };
+                        };
+                        readonly additionalProperties: false;
+                    };
+                };
+                readonly issues: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly required: readonly ["path", "message"];
+                        readonly properties: {
+                            readonly path: {
+                                readonly type: "string";
+                            };
+                            readonly message: {
+                                readonly type: "string";
+                            };
+                        };
+                        readonly additionalProperties: false;
+                    };
+                };
+                readonly sdkValid: {
+                    readonly type: "boolean";
+                };
+                readonly branchSelections: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "object";
+                    };
+                };
+                readonly requirements: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly required: readonly ["path", "capability"];
+                        readonly properties: {
+                            readonly path: {
+                                readonly type: "string";
+                            };
+                            readonly capability: {
+                                readonly type: "string";
+                            };
+                        };
+                        readonly additionalProperties: false;
+                    };
+                };
+            };
+            readonly additionalProperties: false;
+        };
         readonly slot: {
             readonly type: "object";
             readonly properties: {
+                readonly $sourceInput: {
+                    readonly $ref: "#/definitions/sourceInput";
+                };
+                readonly $modelBinding: {
+                    readonly $ref: "#/definitions/modelBinding";
+                };
+                readonly $cardinality: {
+                    readonly $ref: "#/definitions/modelCardinality";
+                };
                 readonly $description: {
                     readonly type: "string";
                 };