@uniformdev/canvas 19.46.1-alpha.8 → 19.47.1-alpha.11

package/dist/index.d.ts

@@ -170,6 +170,22 @@ interface components$5 {
             entryName?: string | null;
             /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
             fields?: components$5["schemas"]["ComponentDefinitionParameter"][];
+            /**
+             * Format: uuid
+             * @description Reference to the category this component definition belongs to
+             * @default null
+             */
+            categoryId?: string | null;
+            /**
+             * @description Description of the component definition
+             * @default null
+             */
+            description?: string;
+            /**
+             * @description Description of the component definition
+             * @default null
+             */
+            previewImageUrl?: string;
             /** @description Created date string for this content type (ignored for writes) */
             created?: string;
             /** @description Last modified date string for this content type (ignored for writes) */
@@ -820,6 +836,22 @@ interface external$c {
                     entryName?: string | null;
                     /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
                     fields?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
+                    /**
+                     * Format: uuid
+                     * @description Reference to the category this component definition belongs to
+                     * @default null
+                     */
+                    categoryId?: string | null;
+                    /**
+                     * @description Description of the component definition
+                     * @default null
+                     */
+                    description?: string;
+                    /**
+                     * @description Description of the component definition
+                     * @default null
+                     */
+                    previewImageUrl?: string;
                     /** @description Created date string for this content type (ignored for writes) */
                     created?: string;
                     /** @description Last modified date string for this content type (ignored for writes) */
@@ -1471,6 +1503,22 @@ interface external$b {
                     entryName?: string | null;
                     /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
                     fields?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
+                    /**
+                     * Format: uuid
+                     * @description Reference to the category this component definition belongs to
+                     * @default null
+                     */
+                    categoryId?: string | null;
+                    /**
+                     * @description Description of the component definition
+                     * @default null
+                     */
+                    description?: string;
+                    /**
+                     * @description Description of the component definition
+                     * @default null
+                     */
+                    previewImageUrl?: string;
                     /** @description Created date string for this content type (ignored for writes) */
                     created?: string;
                     /** @description Last modified date string for this content type (ignored for writes) */
@@ -2131,6 +2179,22 @@ interface external$a {
                     entryName?: string | null;
                     /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
                     fields?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
+                    /**
+                     * Format: uuid
+                     * @description Reference to the category this component definition belongs to
+                     * @default null
+                     */
+                    categoryId?: string | null;
+                    /**
+                     * @description Description of the component definition
+                     * @default null
+                     */
+                    description?: string;
+                    /**
+                     * @description Description of the component definition
+                     * @default null
+                     */
+                    previewImageUrl?: string;
                     /** @description Created date string for this content type (ignored for writes) */
                     created?: string;
                     /** @description Last modified date string for this content type (ignored for writes) */
@@ -2927,6 +2991,22 @@ interface external$9 {
                     entryName?: string | null;
                     /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
                     fields?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
+                    /**
+                     * Format: uuid
+                     * @description Reference to the category this component definition belongs to
+                     * @default null
+                     */
+                    categoryId?: string | null;
+                    /**
+                     * @description Description of the component definition
+                     * @default null
+                     */
+                    description?: string;
+                    /**
+                     * @description Description of the component definition
+                     * @default null
+                     */
+                    previewImageUrl?: string;
                     /** @description Created date string for this content type (ignored for writes) */
                     created?: string;
                     /** @description Last modified date string for this content type (ignored for writes) */
@@ -3573,6 +3653,22 @@ interface external$8 {
                     entryName?: string | null;
                     /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
                     fields?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
+                    /**
+                     * Format: uuid
+                     * @description Reference to the category this component definition belongs to
+                     * @default null
+                     */
+                    categoryId?: string | null;
+                    /**
+                     * @description Description of the component definition
+                     * @default null
+                     */
+                    description?: string;
+                    /**
+                     * @description Description of the component definition
+                     * @default null
+                     */
+                    previewImageUrl?: string;
                     /** @description Created date string for this content type (ignored for writes) */
                     created?: string;
                     /** @description Last modified date string for this content type (ignored for writes) */
@@ -4163,6 +4259,22 @@ interface external$7 {
                     entryName?: string | null;
                     /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
                     fields?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
+                    /**
+                     * Format: uuid
+                     * @description Reference to the category this component definition belongs to
+                     * @default null
+                     */
+                    categoryId?: string | null;
+                    /**
+                     * @description Description of the component definition
+                     * @default null
+                     */
+                    description?: string;
+                    /**
+                     * @description Description of the component definition
+                     * @default null
+                     */
+                    previewImageUrl?: string;
                     /** @description Created date string for this content type (ignored for writes) */
                     created?: string;
                     /** @description Last modified date string for this content type (ignored for writes) */
@@ -4788,6 +4900,22 @@ interface external$6 {
                     entryName?: string | null;
                     /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
                     fields?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
+                    /**
+                     * Format: uuid
+                     * @description Reference to the category this component definition belongs to
+                     * @default null
+                     */
+                    categoryId?: string | null;
+                    /**
+                     * @description Description of the component definition
+                     * @default null
+                     */
+                    description?: string;
+                    /**
+                     * @description Description of the component definition
+                     * @default null
+                     */
+                    previewImageUrl?: string;
                     /** @description Created date string for this content type (ignored for writes) */
                     created?: string;
                     /** @description Last modified date string for this content type (ignored for writes) */
@@ -5842,6 +5970,22 @@ interface external$5 {
                     entryName?: string | null;
                     /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
                     fields?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
+                    /**
+                     * Format: uuid
+                     * @description Reference to the category this component definition belongs to
+                     * @default null
+                     */
+                    categoryId?: string | null;
+                    /**
+                     * @description Description of the component definition
+                     * @default null
+                     */
+                    description?: string;
+                    /**
+                     * @description Description of the component definition
+                     * @default null
+                     */
+                    previewImageUrl?: string;
                     /** @description Created date string for this content type (ignored for writes) */
                     created?: string;
                     /** @description Last modified date string for this content type (ignored for writes) */
@@ -6300,10 +6444,24 @@ interface external$4 {
 
 interface components$1 {
     schemas: {
-        CompositionResolvedGetResponse: components$1["schemas"]["EdgehancerResult"] & external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"];
-        EntryResolvedGetResponse: components$1["schemas"]["EdgehancerResult"] & external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["schemas"]["EntryApiResponse"];
-        EdgehancerResult: {
-            diagnostics?: components$1["schemas"]["CompositionDiagnostics"];
+        CompositionResolvedGetResponse: components$1["schemas"]["EdgehancersResolutionInfo"] & external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"];
+        CompositionResolvedListResponse: {
+            diagnostics?: components$1["schemas"]["CompositionDiagnostics"] & {
+                data?: {
+                    [key: string]: components$1["schemas"]["DataDiagnostic"][];
+                };
+            };
+            errors?: {
+                [key: string]: components$1["schemas"]["CompositionIssue"][];
+            };
+            warnings?: {
+                [key: string]: components$1["schemas"]["CompositionIssue"][];
+            };
+        } & external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionListResponse"];
+        EdgehancersResolutionInfo: {
+            diagnostics?: components$1["schemas"]["CompositionDiagnostics"] & {
+                [key: string]: unknown;
+            };
             errors?: components$1["schemas"]["CompositionIssue"][];
             warnings?: components$1["schemas"]["CompositionIssue"][];
         };
@@ -6372,7 +6530,6 @@ interface components$1 {
                 /** @description How many data type configs were retrieved */
                 dataTypeCount: number;
             };
-            data?: components$1["schemas"]["DataDiagnostic"][];
         };
         CompositionIssue: {
             componentPath?: string;
@@ -6386,13 +6543,6 @@ interface components$1 {
             inputName?: string;
             code?: string;
         };
-        InvalidationResult: {
-            ok: boolean;
-        };
-        BatchInvalidationResult: {
-            ok: number;
-            failed: number;
-        };
     };
     responses: {
         /** Invalid caller input came with the request */
@@ -6401,11 +6551,13 @@ interface components$1 {
                 "application/json": components$1["schemas"]["UniformError"];
             };
         };
+        /** Provided token or API key does not have access to the requested resource */
         UnauthorizedError: {
             content: {
                 "application/json": components$1["schemas"]["UniformError"];
             };
         };
+        /** Provided token or API key does not allow this action */
         ForbiddenError: {
             content: {
                 "application/json": components$1["schemas"]["UniformError"];
@@ -6429,6 +6581,7 @@ interface components$1 {
                 "application/json": components$1["schemas"]["UniformError"];
             };
         };
+        /** The endpoint is called too often */
         RateLimitError: {
             content: {
                 "application/json": components$1["schemas"]["UniformError"];
@@ -6440,39 +6593,6 @@ interface components$1 {
                 "application/json": components$1["schemas"]["UniformError"];
             };
         };
-        CompositionResult: {
-            content: {
-                "application/json": {
-                    diagnostics?: components$1["schemas"]["CompositionDiagnostics"];
-                    errors?: components$1["schemas"]["CompositionIssue"][];
-                    warnings?: components$1["schemas"]["CompositionIssue"][];
-                } & external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"];
-            };
-        };
-        /** Edge route response */
-        EdgeRouteResponse: {
-            content: {
-                "application/json": external$3["../../../lambda/functions/v1-route.swagger.yml"]["components"]["schemas"]["RouteResponseRedirect"] | external$3["../../../lambda/functions/v1-route.swagger.yml"]["components"]["schemas"]["RouteResponseNotFound"] | {
-                    matchedRoute?: string;
-                    dynamicInputs?: external$3["../../../lambda/functions/v1-route.swagger.yml"]["components"]["schemas"]["RouteDynamicInputs"];
-                    /** @enum {string} */
-                    type?: "composition";
-                    compositionApiResponse?: components$1["schemas"]["CompositionResolvedGetResponse"];
-                };
-            };
-        };
-        /** Invalidation request was processed; ok indicates if it succeeded */
-        InvalidationResult: {
-            content: {
-                "application/json": components$1["schemas"]["InvalidationResult"];
-            };
-        };
-        /** Batch invalidation request was processed; number of successful and failed jobs is included */
-        BatchInvalidationResult: {
-            content: {
-                "application/json": components$1["schemas"]["BatchInvalidationResult"];
-            };
-        };
     };
 }
 interface external$3 {
@@ -6684,6 +6804,22 @@ interface external$3 {
                     entryName?: string | null;
                     /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
                     fields?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
+                    /**
+                     * Format: uuid
+                     * @description Reference to the category this component definition belongs to
+                     * @default null
+                     */
+                    categoryId?: string | null;
+                    /**
+                     * @description Description of the component definition
+                     * @default null
+                     */
+                    description?: string;
+                    /**
+                     * @description Description of the component definition
+                     * @default null
+                     */
+                    previewImageUrl?: string;
                     /** @description Created date string for this content type (ignored for writes) */
                     created?: string;
                     /** @description Last modified date string for this content type (ignored for writes) */
@@ -7499,246 +7635,6 @@ interface external$3 {
         };
         operations: {};
     };
-    "../../../lambda/functions/v1-entries.swagger.yml": {
-        paths: {
-            "/api/v1/entries": {
-                get: {
-                    parameters: {
-                        query: {
-                            /** Specify multiple entry IDs to fetch. Response type will be a list. */
-                            entryIDs?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["entryIDs"];
-                            /** Filters entry lists by the user who created them. The user is specified by their identity subject. */
-                            createdBy?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["createdBy"];
-                            /** Max number of records to return */
-                            limit?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["limit"];
-                            /** Number of records to skip */
-                            offset?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["offset"];
-                            /** Sets the sorting of the results. If unspecified, results are sorted by name ascending. */
-                            orderBy?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["orderBy"];
-                            /** The project the entry/entries are on. */
-                            projectId: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["projectId"];
-                            /** Publishing state to fetch. 0 = draft, 64 = published. */
-                            state?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["state"];
-                            /** The content type ID to filter by. */
-                            type?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["type"];
-                            /**
-                             * @deprecated Filters entries lists by the UI status of the entry.
-                             * This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
-                             */
-                            uiStatus?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["uiStatus"];
-                            /** Filters entry lists by the user who last updated them. The user is specified by their identity subject. */
-                            updatedBy?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["updatedBy"];
-                            /**
-                             * Controls whether the total count of results will be returned along with the current results page in a list.
-                             * Has no effect when not fetching a list. This does impact performance when enabled.
-                             */
-                            withTotalCount?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["withTotalCount"];
-                            /**
-                             * @deprecated Returns the UI status string of the entry.
-                             * This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
-                             */
-                            withUIStatus?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["withUIStatus"];
-                        };
-                    };
-                    responses: {
-                        /** OK */
-                        200: {
-                            content: {
-                                "application/json": external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["schemas"]["EntryListResponse"];
-                            };
-                        };
-                        400: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["BadRequestError"];
-                        401: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["UnauthorizedError"];
-                        403: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["ForbiddenError"];
-                        /** Entry not found */
-                        404: {
-                            content: {
-                                "text/plain": string;
-                            };
-                        };
-                        429: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["RateLimitError"];
-                        500: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["InternalServerError"];
-                    };
-                };
-                /** Upserts an entry */
-                put: {
-                    responses: {
-                        /** OK */
-                        204: never;
-                        400: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["BadRequestError"];
-                        401: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["UnauthorizedError"];
-                        403: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["ForbiddenError"];
-                        429: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["RateLimitError"];
-                        500: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["InternalServerError"];
-                    };
-                    requestBody: {
-                        content: {
-                            "application/json": {
-                                /**
-                                 * Format: uuid
-                                 * @description The project ID to upsert the entry to
-                                 */
-                                projectId: string;
-                                /** @description The publishing state to upsert into. 0 = draft, 64 = published */
-                                state: number;
-                                entry: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["schemas"]["EntryInput"];
-                                /** @description Ignored if present */
-                                created?: string;
-                                /** @description Ignored if present */
-                                modified?: string;
-                            };
-                        };
-                    };
-                };
-                /** Deletes or unpublishes an entry */
-                delete: {
-                    responses: {
-                        /** OK */
-                        204: never;
-                        400: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["BadRequestError"];
-                        401: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["UnauthorizedError"];
-                        403: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["ForbiddenError"];
-                        429: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["RateLimitError"];
-                        500: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["InternalServerError"];
-                    };
-                    requestBody: {
-                        content: {
-                            "application/json": {
-                                /**
-                                 * Format: uuid
-                                 * @description The ID of the entry to delete
-                                 */
-                                entryId: string;
-                                /**
-                                 * Format: uuid
-                                 * @description The ID of the project the entry to delete belongs to
-                                 */
-                                projectId: string;
-                                /** @description The state to delete (0 = draft, 64 = published [causes unpublishing], unspecified = all) */
-                                state?: number;
-                            };
-                        };
-                    };
-                };
-                /** Handles preflight requests. This endpoint allows CORS. */
-                options: {
-                    responses: {
-                        /** OK */
-                        204: never;
-                    };
-                };
-            };
-        };
-        components: {
-            schemas: {
-                /** @description Defines the shape of the entry */
-                Entry: {
-                    /** @description Content type of the entry. */
-                    type: string;
-                    /**
-                     * Format: uuid
-                     * @description The public UUID of the entry.
-                     */
-                    _id: string;
-                    /** @description The name of the entry. */
-                    _name?: string;
-                    /** @description The slug of the entry, automatically generated. */
-                    _slug?: string;
-                    /** @description Name of the author of the most recent change. */
-                    _author?: string;
-                    /** @description Entry field values. */
-                    fields?: {
-                        [key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
-                    };
-                    _dataResources?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
-                };
-                /** @description Defines the shape of the entry input */
-                EntryInput: {
-                    /** @description Content type of the entry. */
-                    type: string;
-                    /**
-                     * Format: uuid
-                     * @description The public UUID of the entry.
-                     */
-                    _id?: string;
-                    /** @description Entry field values. */
-                    fields?: {
-                        [key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
-                    };
-                    _dataResources?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
-                };
-                EntryApiResponse: {
-                    /** @description Publishing state to fetch. 0 = draft, 64 = published. */
-                    state: number;
-                    /**
-                     * @deprecated
-                     * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withUIStatus` option is true.
-                     * @enum {string}
-                     */
-                    uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | "Previous";
-                    /**
-                     * Format: uuid
-                     * @description The project ID that this layout data is part of
-                     */
-                    projectId: string;
-                    /**
-                     * Format: date-time,
-                     * @description Created date string for this definition
-                     */
-                    created: string;
-                    /**
-                     * Format: date-time,
-                     * @description Modified date string for this definition
-                     */
-                    modified: string;
-                    entry: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["schemas"]["Entry"];
-                };
-                EntryListResponse: {
-                    entries: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["schemas"]["EntryApiResponse"][];
-                    /** @description Total number of entries that match the query. Only present when `withTotalCount` option is true. */
-                    totalCount?: number;
-                };
-            };
-            parameters: {
-                /** @description The project the entry/entries are on. */
-                projectId: string;
-                /** @description Specify multiple entry IDs to fetch. Response type will be a list. */
-                entryIDs: string[];
-                /** @description The content type ID to filter by. */
-                type: string[];
-                /** @description Publishing state to fetch. 0 = draft, 64 = published. */
-                state: number;
-                /** @description Number of records to skip */
-                offset: number;
-                /** @description Max number of records to return */
-                limit: number;
-                /** @description Sets the sorting of the results. If unspecified, results are sorted by name ascending. */
-                orderBy: ("updated_at_DESC" | "updated_at_ASC" | "created_at_DESC" | "created_at_ASC" | "name_DESC" | "name_ASC")[];
-                /**
-                 * @deprecated
-                 * @description Returns the UI status string of the entry.
-                 * This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
-                 */
-                withUIStatus: boolean;
-                /**
-                 * @deprecated
-                 * @description Filters entries lists by the UI status of the entry.
-                 * This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
-                 */
-                uiStatus: ("Draft" | "Modified" | "Published" | "Orphan")[];
-                /** @description Filters entry lists by the user who created them. The user is specified by their identity subject. */
-                createdBy: string;
-                /** @description Filters entry lists by the user who last updated them. The user is specified by their identity subject. */
-                updatedBy: string;
-                /**
-                 * @description Controls whether the total count of results will be returned along with the current results page in a list.
-                 * Has no effect when not fetching a list. This does impact performance when enabled.
-                 */
-                withTotalCount: boolean;
-            };
-        };
-        operations: {};
-    };
     "../../../lambda/functions/v1-redirect.swagger.yml": {
         paths: {
             "/api/v1/redirect": {
@@ -8435,6 +8331,22 @@ interface external$2 {
                     entryName?: string | null;
                     /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
                     fields?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
+                    /**
+                     * Format: uuid
+                     * @description Reference to the category this component definition belongs to
+                     * @default null
+                     */
+                    categoryId?: string | null;
+                    /**
+                     * @description Description of the component definition
+                     * @default null
+                     */
+                    description?: string;
+                    /**
+                     * @description Description of the component definition
+                     * @default null
+                     */
+                    previewImageUrl?: string;
                     /** @description Created date string for this content type (ignored for writes) */
                     created?: string;
                     /** @description Last modified date string for this content type (ignored for writes) */
@@ -9605,6 +9517,7 @@ type CompositionDiagnostics = components$1['schemas']['CompositionDiagnostics'];
 type CompositionDataDiagnostic = components$1['schemas']['DataDiagnostic'];
 /** Response as it comes from uniform.global/api/v1/composition */
 type CompositionResolvedGetResponse = components$1['schemas']['CompositionResolvedGetResponse'];
+type CompositionResolvedListResponse = components$1['schemas']['CompositionResolvedListResponse'];
 /** All valid response types */
 type CompositionGetValidResponses = CompositionGetResponse | CompositionResolvedGetResponse;
 /** The GET response from /api/v1/route */
@@ -9614,8 +9527,6 @@ type RouteGetResponseComposition = components['schemas']['RouteResponseCompositi
 type RouteGetResponseRedirect = components['schemas']['RouteResponseRedirect'];
 type RouteGetResponseNotFound = components['schemas']['RouteResponseNotFound'];
 type RouteDynamicInputs = components['schemas']['RouteDynamicInputs'];
-/** Response as it comes from uniform.global/api/v1/composition */
-type EntryResolvedGetResponse = components$1['schemas']['EntryResolvedGetResponse'];
 /** The GET response from /api/v1/entries */
 type EntriesGetParameters = paths$8['/api/v1/entries']['get']['parameters']['query'] & DataResolutionParameters;
 type EntriesGetResponse = components$4['schemas']['EntryListResponse'];
@@ -10286,7 +10197,6 @@ type ComponentParameterEnhancer<TRawValue = unknown, TOutputValue = unknown, TCo
 
 type schemas = components$1['schemas'];
 type InvalidationPayload = schemas['InvalidationPayload'];
-type InvalidationResult = schemas['InvalidationResult'];
 type BatchInvalidationPayload = schemas['BatchInvalidationPayload'];
 
 type LinkParameterType = 'projectMapNode' | 'url' | 'tel' | 'email';
@@ -10824,8 +10734,12 @@ declare const CANVAS_PERSONALIZATION_PARAM = "$pzCrit";
 declare const CANVAS_TEST_VARIANT_PARAM = "$tstVrnt";
 /** Public ID of the Uniform Context enrichment tag parameter on Canvas components */
 declare const CANVAS_ENRICHMENT_TAG_PARAM = "$enr";
-/** The name of the query string used to detect if we are in in-context editing mode */
+/** The name of the query string used to detect if we are in contextual editing mode */
 declare const IN_CONTEXT_EDITOR_QUERY_STRING_PARAM = "is_incontext_editing_mode";
+/** The name of the query string used to indicate that we want to use the playground for preview */
+declare const IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM = "is_incontext_editing_playground";
+/** The name of the query string used to get the config from the preview url  */
+declare const IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM = "is_config_check";
 /** The value of "data-role" in the component start `<script>` tag */
 declare const IN_CONTEXT_EDITOR_COMPONENT_START_ROLE = "uniform-component-start";
 /** The value of "data-role" in the component end `<script>` tag */
@@ -10990,6 +10904,12 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
     } | undefined;
 }>;
 
+/**
+ * Converts a content entry to a put content entry body that has only the properties expected to the PUT API.
+ * Removes things like author, stats, etc.
+ */
+declare function convertEntryToPutEntry(entry: Entry): PutEntryBody;
+
 declare const ATTRIBUTE_COMPONENT_ID = "data-uniform-component-id";
 declare const ATTRIBUTE_PARAMETER_ID = "data-uniform-parameter-id";
 declare const ATTRIBUTE_PARAMETER_VALUE = "data-uniform-parameter-value";
@@ -11097,4 +11017,4 @@ declare function parseVariableExpression(serialized: string, onToken?: (token: s
 
 declare const CanvasClientError: typeof ApiClientError;
 
-export { ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, AddComponentMessage, BatchEnhancer, BatchEntry, BatchInvalidationPayload, BindVariablesOptions, BindVariablesResult, BindVariablesToObjectOptions, CANVAS_DRAFT_STATE, CANVAS_EDITOR_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CanvasClient, CanvasClientError, CanvasDefinitions, CategoriesDeleteParameters, CategoriesGetParameters, CategoriesGetResponse, CategoriesPutParameters, Category, CategoryClient, Channel, ChannelMessage, ChannelSubscription, ChildEnhancerBuilder, ComponentDefinition, ComponentDefinitionDeleteParameters, ComponentDefinitionGetParameters, ComponentDefinitionGetResponse, ComponentDefinitionParameter, ComponentDefinitionPermission, ComponentDefinitionPutParameters, ComponentDefinitionSlot, ComponentDefinitionSlugSettings, ComponentDefinitionVariant, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentInstance, ComponentInstanceContextualEditing, ComponentInstanceHistoryEntry, ComponentInstanceHistoryGetParameters, ComponentInstanceHistoryGetResponse, ComponentLocationReference, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterContextualEditing, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionDataDiagnostic, CompositionDeleteParameters, CompositionDiagnostics, CompositionGetByComponentIdParameters, CompositionGetByIdParameters, CompositionGetByNodeIdParameters, CompositionGetByNodePathParameters, CompositionGetBySlugParameters, CompositionGetListResponse, CompositionGetOrderBy, CompositionGetParameters, CompositionGetResponse, CompositionGetValidResponses, CompositionIssue, CompositionPatternIssue, CompositionPutParameters, CompositionRelationshipsClientOptions, CompositionRelationshipsDDefinitionGetResponse, CompositionRelationshipsDefinitionApi, CompositionRelationshipsDefinitionGetParameters, CompositionResolvedGetResponse, CompositionUIStatus, ContentClient, ContentType, ContentTypeField, ContextualEditingComponentReference, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionOption, DataResolutionOptionNegative, DataResolutionOptionPositive, DataResolutionParameters, DataResourceDefinition, DataResourceDefinitions, DataResourceIssue, DataResourceVariables, DataSource, DataSourceClient, DataSourceDeleteParameters, DataSourceGetParameters, DataSourceGetResponse, DataSourcePutParameters, DataSourcesGetParameters, DataSourcesGetResponse, DataType, DataTypeClient, DataTypeDeleteParameters, DataTypeGetParameters, DataTypeGetResponse, DataTypePutParameters, DataVariableDefinition, DeleteContentTypeOptions, DeleteEntryOptions, DismissPlaceholderMessage, DynamicInputIssue, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_DEFAULT_L2_CACHE_TTL_IN_HOURS, EDGE_MAX_CACHE_TTL, EDGE_MAX_L2_CACHE_TTL_IN_HOURS, EDGE_MIN_CACHE_TTL, EDGE_MIN_L2_CACHE_TTL_IN_HOURS, EMPTY_COMPOSITION, EditorStateUpdatedMessage, EnhancerBuilder, EnhancerContext, EnhancerError, EntriesGetParameters, EntriesGetResponse, Entry, EntryResolvedGetResponse, EventNames, GetContentTypesOptions, GetContentTypesResponse, GetEntriesOptions, GetEntriesResponse, GetParameterAttributesProps, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, InvalidationPayload, InvalidationResult, LimitPolicy, LinkComponentParameterValue, LinkParamConfiguration, LinkParamValue, LinkParameterType, LinkTypeConfiguration, MessageHandler, MoveComponentMessage, NonProjectMapLinkParamValue, OverrideOptions, PLACEHOLDER_ID, PreviewEventBus, PreviewPanelSettings, ProjectMapLinkComponentParameterValue, ProjectMapLinkParamValue, PutContentTypeBody, PutEntryBody, ReadyMessage, ReportRenderedCompositionsMessage, ResolvedRouteGetResponse, RichTextBuiltInElement, RichTextBuiltInFormat, RichTextParamConfiguration, RichTextParamValue, RootComponentInstance, RouteClient, RouteDynamicInputs, RouteGetParameters, RouteGetResponse, RouteGetResponseComposition, RouteGetResponseEdgehancedComposition, RouteGetResponseNotFound, RouteGetResponseRedirect, SelectComponentMessage, SelectParameterMessage, SpecificProjectMap, SubscribeToCompositionOptions, TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UniqueBatchEntries, UnsubscribeCallback, UpdateComponentParameterMessage, UpdateCompositionInternalMessage, UpdateCompositionMessage, UpdateContextualEditingStateInternalMessage, UpdatePreviewSettingsMessage, UsageTrackingApi, UsageTrackingGetParameters, UsageTrackingGetResponse, UsageTrackingPostParameters, UsageTrackingPostResponse, WalkComponentTreeActions, bindVariables, bindVariablesToObject, compose, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, createVariableReference, enhance, extractLocales, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, getParameterAttributes, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSelectParameterMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, parseVariableExpression, subscribeToComposition, unstable_CompositionRelationshipClient, walkComponentTree };
+export { ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, AddComponentMessage, BatchEnhancer, BatchEntry, BatchInvalidationPayload, BindVariablesOptions, BindVariablesResult, BindVariablesToObjectOptions, CANVAS_DRAFT_STATE, CANVAS_EDITOR_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CanvasClient, CanvasClientError, CanvasDefinitions, CategoriesDeleteParameters, CategoriesGetParameters, CategoriesGetResponse, CategoriesPutParameters, Category, CategoryClient, Channel, ChannelMessage, ChannelSubscription, ChildEnhancerBuilder, ComponentDefinition, ComponentDefinitionDeleteParameters, ComponentDefinitionGetParameters, ComponentDefinitionGetResponse, ComponentDefinitionParameter, ComponentDefinitionPermission, ComponentDefinitionPutParameters, ComponentDefinitionSlot, ComponentDefinitionSlugSettings, ComponentDefinitionVariant, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentInstance, ComponentInstanceContextualEditing, ComponentInstanceHistoryEntry, ComponentInstanceHistoryGetParameters, ComponentInstanceHistoryGetResponse, ComponentLocationReference, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterContextualEditing, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionDataDiagnostic, CompositionDeleteParameters, CompositionDiagnostics, CompositionGetByComponentIdParameters, CompositionGetByIdParameters, CompositionGetByNodeIdParameters, CompositionGetByNodePathParameters, CompositionGetBySlugParameters, CompositionGetListResponse, CompositionGetOrderBy, CompositionGetParameters, CompositionGetResponse, CompositionGetValidResponses, CompositionIssue, CompositionPatternIssue, CompositionPutParameters, CompositionRelationshipsClientOptions, CompositionRelationshipsDDefinitionGetResponse, CompositionRelationshipsDefinitionApi, CompositionRelationshipsDefinitionGetParameters, CompositionResolvedGetResponse, CompositionResolvedListResponse, CompositionUIStatus, ContentClient, ContentType, ContentTypeField, ContextualEditingComponentReference, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionOption, DataResolutionOptionNegative, DataResolutionOptionPositive, DataResolutionParameters, DataResourceDefinition, DataResourceDefinitions, DataResourceIssue, DataResourceVariables, DataSource, DataSourceClient, DataSourceDeleteParameters, DataSourceGetParameters, DataSourceGetResponse, DataSourcePutParameters, DataSourcesGetParameters, DataSourcesGetResponse, DataType, DataTypeClient, DataTypeDeleteParameters, DataTypeGetParameters, DataTypeGetResponse, DataTypePutParameters, DataVariableDefinition, DeleteContentTypeOptions, DeleteEntryOptions, DismissPlaceholderMessage, DynamicInputIssue, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_DEFAULT_L2_CACHE_TTL_IN_HOURS, EDGE_MAX_CACHE_TTL, EDGE_MAX_L2_CACHE_TTL_IN_HOURS, EDGE_MIN_CACHE_TTL, EDGE_MIN_L2_CACHE_TTL_IN_HOURS, EMPTY_COMPOSITION, EditorStateUpdatedMessage, EnhancerBuilder, EnhancerContext, EnhancerError, EntriesGetParameters, EntriesGetResponse, Entry, EventNames, GetContentTypesOptions, GetContentTypesResponse, GetEntriesOptions, GetEntriesResponse, GetParameterAttributesProps, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, InvalidationPayload, LimitPolicy, LinkComponentParameterValue, LinkParamConfiguration, LinkParamValue, LinkParameterType, LinkTypeConfiguration, MessageHandler, MoveComponentMessage, NonProjectMapLinkParamValue, OverrideOptions, PLACEHOLDER_ID, PreviewEventBus, PreviewPanelSettings, ProjectMapLinkComponentParameterValue, ProjectMapLinkParamValue, PutContentTypeBody, PutEntryBody, ReadyMessage, ReportRenderedCompositionsMessage, ResolvedRouteGetResponse, RichTextBuiltInElement, RichTextBuiltInFormat, RichTextParamConfiguration, RichTextParamValue, RootComponentInstance, RouteClient, RouteDynamicInputs, RouteGetParameters, RouteGetResponse, RouteGetResponseComposition, RouteGetResponseEdgehancedComposition, RouteGetResponseNotFound, RouteGetResponseRedirect, SelectComponentMessage, SelectParameterMessage, SpecificProjectMap, SubscribeToCompositionOptions, TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UniqueBatchEntries, UnsubscribeCallback, UpdateComponentParameterMessage, UpdateCompositionInternalMessage, UpdateCompositionMessage, UpdateContextualEditingStateInternalMessage, UpdatePreviewSettingsMessage, UsageTrackingApi, UsageTrackingGetParameters, UsageTrackingGetResponse, UsageTrackingPostParameters, UsageTrackingPostResponse, WalkComponentTreeActions, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, createVariableReference, enhance, extractLocales, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, getParameterAttributes, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSelectParameterMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, parseVariableExpression, subscribeToComposition, unstable_CompositionRelationshipClient, walkComponentTree };