@uniformdev/canvas 19.51.0 → 19.51.1-alpha.1

package/dist/index.d.ts

@@ -190,6 +190,7 @@ interface components$5 {
             created?: string;
             /** @description Last modified date string for this content type (ignored for writes) */
             updated?: string;
+            slugSettings?: components$5["schemas"]["ComponentDefinitionSlugSettings"];
         };
         /** @description Defines an editable parameter on a component. */
         ComponentParameter: {
@@ -856,6 +857,7 @@ interface external$c {
                     created?: string;
                     /** @description Last modified date string for this content type (ignored for writes) */
                     updated?: string;
+                    slugSettings?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
                 };
                 /** @description Defines an editable parameter on a component. */
                 ComponentParameter: {
@@ -1523,6 +1525,7 @@ interface external$b {
                     created?: string;
                     /** @description Last modified date string for this content type (ignored for writes) */
                     updated?: string;
+                    slugSettings?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
                 };
                 /** @description Defines an editable parameter on a component. */
                 ComponentParameter: {
@@ -2199,6 +2202,7 @@ interface external$a {
                     created?: string;
                     /** @description Last modified date string for this content type (ignored for writes) */
                     updated?: string;
+                    slugSettings?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
                 };
                 /** @description Defines an editable parameter on a component. */
                 ComponentParameter: {
@@ -2550,8 +2554,10 @@ interface paths$8 {
         get: {
             parameters: {
                 query: {
-                    /** Specify multiple entry IDs to fetch. Response type will be a list. */
+                    /** Specify multiple entry IDs to fetch. */
                     entryIDs?: components$4["parameters"]["entryIDs"];
+                    /** Specify a single entry to fetch by slug. */
+                    slug?: components$4["parameters"]["slug"];
                     /** Filters entry lists by the user who created them. The user is specified by their identity subject. */
                     createdBy?: components$4["parameters"]["createdBy"];
                     /** Max number of records to return */
@@ -2747,8 +2753,10 @@ interface components$4 {
     parameters: {
         /** @description The project the entry/entries are on. */
         projectId: string;
-        /** @description Specify multiple entry IDs to fetch. Response type will be a list. */
+        /** @description Specify multiple entry IDs to fetch. */
         entryIDs: string[];
+        /** @description Specify a single entry to fetch by slug. */
+        slug: string;
         /** @description The content type ID to filter by. */
         type: string[];
         /** @description Publishing state to fetch. 0 = draft, 64 = published. */
@@ -3011,6 +3019,7 @@ interface external$9 {
                     created?: string;
                     /** @description Last modified date string for this content type (ignored for writes) */
                     updated?: string;
+                    slugSettings?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
                 };
                 /** @description Defines an editable parameter on a component. */
                 ComponentParameter: {
@@ -3673,6 +3682,7 @@ interface external$8 {
                     created?: string;
                     /** @description Last modified date string for this content type (ignored for writes) */
                     updated?: string;
+                    slugSettings?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
                 };
                 /** @description Defines an editable parameter on a component. */
                 ComponentParameter: {
@@ -4279,6 +4289,7 @@ interface external$7 {
                     created?: string;
                     /** @description Last modified date string for this content type (ignored for writes) */
                     updated?: string;
+                    slugSettings?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
                 };
                 /** @description Defines an editable parameter on a component. */
                 ComponentParameter: {
@@ -4920,6 +4931,7 @@ interface external$6 {
                     created?: string;
                     /** @description Last modified date string for this content type (ignored for writes) */
                     updated?: string;
+                    slugSettings?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
                 };
                 /** @description Defines an editable parameter on a component. */
                 ComponentParameter: {
@@ -5990,6 +6002,7 @@ interface external$5 {
                     created?: string;
                     /** @description Last modified date string for this content type (ignored for writes) */
                     updated?: string;
+                    slugSettings?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
                 };
                 /** @description Defines an editable parameter on a component. */
                 ComponentParameter: {
@@ -6446,24 +6459,37 @@ interface components$1 {
     schemas: {
         CompositionResolvedGetResponse: components$1["schemas"]["EdgehancersResolutionInfo"] & external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"];
         CompositionResolvedListResponse: {
-            diagnostics?: components$1["schemas"]["CompositionDiagnostics"] & {
+            diagnostics?: components$1["schemas"]["EdgehancersDiagnostics"] & {
                 data?: {
                     [key: string]: components$1["schemas"]["DataDiagnostic"][];
                 };
             };
             errors?: {
-                [key: string]: components$1["schemas"]["CompositionIssue"][];
+                [key: string]: components$1["schemas"]["DataResolutionIssue"][];
             };
             warnings?: {
-                [key: string]: components$1["schemas"]["CompositionIssue"][];
+                [key: string]: components$1["schemas"]["DataResolutionIssue"][];
             };
         } & external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionListResponse"];
+        EntryResolvedListResponse: {
+            diagnostics?: components$1["schemas"]["EdgehancersDiagnostics"] & {
+                data?: {
+                    [key: string]: components$1["schemas"]["DataDiagnostic"][];
+                };
+            };
+            errors?: {
+                [key: string]: components$1["schemas"]["DataResolutionIssue"][];
+            };
+            warnings?: {
+                [key: string]: components$1["schemas"]["DataResolutionIssue"][];
+            };
+        } & external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["schemas"]["EntryListResponse"];
         EdgehancersResolutionInfo: {
-            diagnostics?: components$1["schemas"]["CompositionDiagnostics"] & {
+            diagnostics?: components$1["schemas"]["EdgehancersDiagnostics"] & {
                 [key: string]: unknown;
             };
-            errors?: components$1["schemas"]["CompositionIssue"][];
-            warnings?: components$1["schemas"]["CompositionIssue"][];
+            errors?: components$1["schemas"]["DataResolutionIssue"][];
+            warnings?: components$1["schemas"]["DataResolutionIssue"][];
         };
         EdgehancersError: {
             message: string;
@@ -6502,36 +6528,36 @@ interface components$1 {
         /**
          * @description Diagnostic information about request processing, including origin/config/data
          * * timings, edge locations, cache statuses and raw data.
-         * * Only set when diagnostics=true is passed to the options.
+         * * Only present when diagnostics=true is passed to the options.
          */
-        CompositionDiagnostics: {
+        EdgehancersDiagnostics: {
             /** @description Edge location where the request was processed */
             edgeLocation?: string;
-            compositionFetch?: {
-                /** @description How long it took to fetch the composition (ms) */
+            originFetch?: {
+                /** @description How long it took to fetch from the origin (ms) */
                 duration: number;
-                /** @description Indicates if the composition was fetched from the cache */
+                /** @description Indicates if the origin response was cached */
                 cacheHit: boolean;
-                /** @description Indicates if the request results in a valid composition */
-                hasValidComposition: boolean;
+                /** @description Indicates if the request results in a valid response */
+                isValid: boolean;
                 /**
-                 * @description Cache from which the composition was resolved
+                 * @description Source cache used
                  * @enum {string}
                  */
                 sourceCache?: "edge-cdn-cache" | "long-term-cache" | "api-cache";
                 /** @description Edge cache location used */
                 cacheLocation?: string;
-                /** @description Uniform-specifc request identifiers */
+                /** @description Uniform-specifc request identifier */
                 requestId?: string;
             };
             configRetrieval?: {
-                /** @description How long it took to retrieve the config (ms, in parallel to composition fetch) */
+                /** @description How long it took to retrieve the config (ms, in parallel to origin fetch) */
                 duration: number;
                 /** @description How many data type configs were retrieved */
                 dataTypeCount: number;
             };
         };
-        CompositionIssue: {
+        DataResolutionIssue: {
             componentPath?: string;
             componentType?: string;
             message: string;
@@ -6824,6 +6850,7 @@ interface external$3 {
                     created?: string;
                     /** @description Last modified date string for this content type (ignored for writes) */
                     updated?: string;
+                    slugSettings?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
                 };
                 /** @description Defines an editable parameter on a component. */
                 ComponentParameter: {
@@ -7635,6 +7662,250 @@ interface external$3 {
         };
         operations: {};
     };
+    "../../../lambda/functions/v1-entries.swagger.yml": {
+        paths: {
+            "/api/v1/entries": {
+                get: {
+                    parameters: {
+                        query: {
+                            /** Specify multiple entry IDs to fetch. */
+                            entryIDs?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["entryIDs"];
+                            /** Specify a single entry to fetch by slug. */
+                            slug?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["slug"];
+                            /** 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. */
+                entryIDs: string[];
+                /** @description Specify a single entry to fetch by slug. */
+                slug: 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": {
@@ -8351,6 +8622,7 @@ interface external$2 {
                     created?: string;
                     /** @description Last modified date string for this content type (ignored for writes) */
                     updated?: string;
+                    slugSettings?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
                 };
                 /** @description Defines an editable parameter on a component. */
                 ComponentParameter: {
@@ -9480,21 +9752,25 @@ type DataResolutionParameters = {
     diagnostics?: boolean;
 };
 /** Types of issue that can occur when fetching composition data */
-type CompositionIssue = CompositionPatternIssue | DataResourceIssue | DataElementBindingIssue | DynamicInputIssue | DataResolutionConfigIssue;
-type CompositionIssueCore = components$1['schemas']['CompositionIssue'];
+type DataResolutionIssue = PatternIssue | DataResourceIssue | DataElementBindingIssue | DynamicInputIssue | DataResolutionConfigIssue;
+/** @deprecated use DataResolutionIssue instead */
+type CompositionIssue = DataResolutionIssue;
+type DataResolutionIssueCore = components$1['schemas']['DataResolutionIssue'];
 /** An error that occured resolving a pattern that is referenced on the composition */
-type CompositionPatternIssue = CompositionIssueCore & {
+type PatternIssue = DataResolutionIssueCore & {
     type: 'pattern';
     code: NonNullable<ComponentInstance['_patternError']>;
 };
+/** @deprecated use PatternIssue instead */
+type CompositionPatternIssue = PatternIssue;
 /** An error while binding a dynamic token from a data resource to a component parameter (i.e. a missing property in the data resource) */
-type DataElementBindingIssue = CompositionIssueCore & {
+type DataElementBindingIssue = DataResolutionIssueCore & {
     type: 'binding';
     parameterName: string;
     expression?: DataElementConnectionDefinition;
 };
 /** An error that occurred fetching a data defined on the composition or a pattern within */
-type DataResourceIssue = CompositionIssueCore & {
+type DataResourceIssue = DataResolutionIssueCore & {
     type: 'data';
     dataName: string;
     dataType: string;
@@ -9503,7 +9779,7 @@ type DataResourceIssue = CompositionIssueCore & {
  * An issue that occurred while binding dynamic inputs to composition data resources,
  * specifically when an expected dynamic input did not have a value.
  */
-type DynamicInputIssue = CompositionIssueCore & {
+type DynamicInputIssue = DataResolutionIssueCore & {
     type: 'input';
 };
 /** Error in data resolution configuration (internal error) */
@@ -9512,9 +9788,13 @@ type DataResolutionConfigIssue = {
     type: 'config';
 };
 /** Diagnostics about edge request processing */
-type CompositionDiagnostics = components$1['schemas']['CompositionDiagnostics'];
+type EdgehancersDiagnostics = components$1['schemas']['EdgehancersDiagnostics'];
+/** @deprecated use EdgehancersDiagnostics instead */
+type CompositionDiagnostics = EdgehancersDiagnostics;
 /** Diagnostic data about the load performance of attached composition datas */
-type CompositionDataDiagnostic = components$1['schemas']['DataDiagnostic'];
+type DataDiagnostic = components$1['schemas']['DataDiagnostic'];
+/** @deprecated use DataDiagnostic instead */
+type CompositionDataDiagnostic = DataDiagnostic;
 /** Response as it comes from uniform.global/api/v1/composition */
 type CompositionResolvedGetResponse = components$1['schemas']['CompositionResolvedGetResponse'];
 type CompositionResolvedListResponse = components$1['schemas']['CompositionResolvedListResponse'];
@@ -9530,6 +9810,7 @@ type RouteDynamicInputs = components['schemas']['RouteDynamicInputs'];
 /** The GET response from /api/v1/entries */
 type EntriesGetParameters = paths$8['/api/v1/entries']['get']['parameters']['query'] & DataResolutionParameters;
 type EntriesGetResponse = components$4['schemas']['EntryListResponse'];
+type EntriesResolvedListResponse = components$1['schemas']['EntryResolvedListResponse'];
 /** GET response from uniform.global/api/v1/route when result is a composition */
 type RouteGetResponseEdgehancedComposition = Omit<RouteGetResponseComposition, 'compositionApiResponse'> & {
     compositionApiResponse: CompositionResolvedGetResponse;
@@ -10104,15 +10385,24 @@ type PreviewPanelSettings = {
     isInteractive: boolean;
 };
 type ContextualEditingComponentReference = {
-    elements: HTMLElement[];
     id: string;
-    slotName?: string;
-    componentIndex?: number;
-    totalComponents?: number;
-    componentName?: string;
-    componentTitle?: string;
+    icon?: string;
+    type?: string;
+    title?: string;
+    name?: string;
+    parameters?: Record<string, {
+        id: string;
+        type: string;
+        name?: string;
+        isReadOnly?: boolean;
+    }>;
     parentId?: string;
     parentType?: string;
+    parentSlot?: {
+        id?: string;
+        componentIndex?: number;
+        totalComponents?: number;
+    };
     isLocalized?: boolean;
     isReadOnly?: boolean | undefined;
 };
@@ -10546,8 +10836,8 @@ type SelectComponentMessage = {
 };
 type SelectParameterMessage = {
     type: 'select-parameter';
-    parameterId: string;
-    componentId: string;
+    parameterId?: string;
+    componentId?: string;
 };
 type ReadyMessage = {
     type: 'ready';
@@ -10555,6 +10845,15 @@ type ReadyMessage = {
     /** A non-semantic version of the contextual editing SDK. */
     version?: number;
 };
+type TriggerComponentActionMessage = {
+    type: 'trigger-component-action';
+    actionType: 'insert-before' | 'insert-after' | 'duplicate' | 'delete';
+    componentReference: Omit<ContextualEditingComponentReference, 'elements'>;
+};
+type UpdateComponentReferencesMessage = {
+    type: 'update-component-references';
+    referencesById: Record<string, ContextualEditingComponentReference>;
+};
 type UpdateCompositionMessage = {
     type: 'update-composition';
     composition: RootComponentInstance;
@@ -10578,6 +10877,11 @@ type MoveComponentMessage = {
     index: number;
     direction: 'up' | 'down';
 };
+type OpenParameterEditorMessage = {
+    type: 'open-parameter-editor';
+    componentId: string;
+    parameterId: string;
+};
 type UpdateComponentParameterMessage = {
     type: 'update-component-parameter';
     componentId: string;
@@ -10611,9 +10915,10 @@ type ReportRenderedCompositionsMessage = {
 type EditorStateUpdatedMessage = {
     type: 'editor-state-updated';
 };
-type ChannelMessage = SelectComponentMessage | ReadyMessage | UpdateCompositionMessage | UpdateCompositionInternalMessage | AddComponentMessage | MoveComponentMessage | TriggerCompositionActionMessage | UpdatePreviewSettingsMessage | ReportRenderedCompositionsMessage | UpdateComponentParameterMessage | UpdateContextualEditingStateInternalMessage | SelectParameterMessage | DismissPlaceholderMessage | EditorStateUpdatedMessage;
+type ChannelMessage = SelectComponentMessage | ReadyMessage | UpdateCompositionMessage | UpdateCompositionInternalMessage | TriggerComponentActionMessage | AddComponentMessage | MoveComponentMessage | TriggerCompositionActionMessage | UpdatePreviewSettingsMessage | ReportRenderedCompositionsMessage | UpdateComponentParameterMessage | UpdateContextualEditingStateInternalMessage | SelectParameterMessage | DismissPlaceholderMessage | UpdateComponentReferencesMessage | OpenParameterEditorMessage | EditorStateUpdatedMessage;
 declare const isSelectComponentMessage: (message: ChannelMessage) => message is SelectComponentMessage;
 declare const isReadyMessage: (message: ChannelMessage) => message is ReadyMessage;
+declare const isComponentActionMessage: (message: ChannelMessage) => message is TriggerComponentActionMessage;
 declare const isUpdateCompositionMessage: (message: ChannelMessage) => message is UpdateCompositionMessage;
 declare const isUpdateCompositionInternalMessage: (message: ChannelMessage) => message is UpdateCompositionInternalMessage;
 declare const isAddComponentMessage: (message: ChannelMessage) => message is AddComponentMessage;
@@ -10625,13 +10930,17 @@ declare const isUpdatePreviewSettingsMessage: (message: ChannelMessage) => messa
 declare const isUpdateContextualEditingStateInternalMessage: (message: ChannelMessage) => message is UpdateContextualEditingStateInternalMessage;
 declare const isReportRenderedCompositionsMessage: (message: ChannelMessage) => message is ReportRenderedCompositionsMessage;
 declare const isSelectParameterMessage: (message: ChannelMessage) => message is SelectParameterMessage;
+declare const isOpenParameterEditorMessage: (message: ChannelMessage) => message is OpenParameterEditorMessage;
+declare const isUpdateComponentReferencesMessage: (message: ChannelMessage) => message is UpdateComponentReferencesMessage;
 type MessageHandler = (message: ChannelMessage, originalEvent: MessageEvent) => void;
 type Channel = {
     on: (types: ChannelMessage['type'][] | ChannelMessage['type'], handler: MessageHandler) => () => void;
     ready: () => void;
     destroy: () => void;
+    triggerComponentAction: (options: Omit<TriggerComponentActionMessage, 'type'>) => void;
     selectComponent: (id: string) => void;
     selectParameter: (options: Omit<SelectParameterMessage, 'type'>) => void;
+    openParameterEditor: (options: Omit<OpenParameterEditorMessage, 'type'>) => void;
     updateComposition: (composition: RootComponentInstance, secret?: string) => void;
     updateCompositionInternal: (composition: RootComponentInstance, hash?: number) => void;
     addComponent: (options: Omit<AddComponentMessage, 'type'>) => void;
@@ -10642,6 +10951,7 @@ type Channel = {
     updatePreviewSettings: (options: Omit<UpdatePreviewSettingsMessage, 'type'>) => void;
     updateContextualEditingStateInternal: (options: Omit<UpdateContextualEditingStateInternalMessage, 'type'>) => void;
     reportRenderedCompositions: (options: Omit<ReportRenderedCompositionsMessage, 'type'>) => void;
+    updateComponentReferences: (options: Omit<UpdateComponentReferencesMessage, 'type'>) => void;
     editorStateUpdated: () => void;
 };
 declare const createCanvasChannel: ({ listenTo, broadcastTo, }: {
@@ -11017,4 +11327,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, 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 };
+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, DataDiagnostic, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionIssue, 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, EdgehancersDiagnostics, EditorStateUpdatedMessage, EnhancerBuilder, EnhancerContext, EnhancerError, EntriesGetParameters, EntriesGetResponse, EntriesResolvedListResponse, 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, OpenParameterEditorMessage, OverrideOptions, PLACEHOLDER_ID, PatternIssue, 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, TriggerComponentActionMessage, TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UniqueBatchEntries, UnsubscribeCallback, UpdateComponentParameterMessage, UpdateComponentReferencesMessage, 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, isComponentActionMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isOpenParameterEditorMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSelectParameterMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateComponentReferencesMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, parseVariableExpression, subscribeToComposition, unstable_CompositionRelationshipClient, walkComponentTree };