@uniformdev/mesh-sdk 20.63.0 → 20.63.1-alpha.17

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { ApiClient, ClientOptions, ExceptProject } from '@uniformdev/context/api';
-import { AssetParamValue, DataType, DataSource, DataSourceVariantsKeys, DataResourceVariables, RootComponentInstance, ComponentInstance, ComponentDefinition, ComponentDefinitionParameter, DataVariableDefinition, Locale, EntryData } from '@uniformdev/canvas';
+import { AssetParamValue, DataType, DataSource, DataResourceVariables, DataSourceVariantsKeys, ComponentDefinition, RootComponentInstance, ComponentInstance, ComponentDefinitionParameter, DataVariableDefinition, Locale, EntryData, ComponentParameter, VisibilityCriteriaGroup } from '@uniformdev/canvas';
 export { AssetParamValue, AssetParamValueItem } from '@uniformdev/canvas';
 import { ProjectMapNode } from '@uniformdev/project-map';
 import { AssetDefinitionType } from '@uniformdev/assets';
@@ -17,8 +17,11 @@ interface paths$1 {
         get: {
             parameters: {
                 query: {
+                    /** @description The team ID */
                     teamId: string;
+                    /** @description Whether to include Mesh apps that are shared publicly to all teams, or only custom apps registered on this team. */
                     includePublic?: boolean | null;
+                    /** @description Whether to use team-specific integration types or team-agnostic types (for serialization across projects) */
                     teamSpecificType?: boolean | null;
                 };
                 header?: never;
@@ -174,6 +177,18 @@ interface paths$1 {
                                                     };
                                                 };
                                                 embeddedEditor?: string;
+                                                dataResourceSelectorUrl?: string;
+                                                dataResourceSelectorLocations?: {
+                                                    [key: string]: {
+                                                        url: string;
+                                                        layout?: {
+                                                            /** @enum {string} */
+                                                            height?: "full-height";
+                                                            /** @enum {string} */
+                                                            width?: "wide";
+                                                        };
+                                                    };
+                                                };
                                             };
                                         };
                                         badgeIconUrl?: string;
@@ -210,7 +225,6 @@ interface paths$1 {
                                         generateUrl: string;
                                         metadataUrl?: string;
                                         prompts?: {
-                                            /** Format: uuid */
                                             id: string;
                                             name: string;
                                             text: string;
@@ -269,7 +283,6 @@ interface paths$1 {
                                     }[];
                                 };
                                 unstable_prompts?: {
-                                    /** Format: uuid */
                                     id: string;
                                     name: string;
                                     text: string;
@@ -308,10 +321,7 @@ interface paths$1 {
             requestBody: {
                 content: {
                     "application/json": {
-                        /**
-                         * Format: uuid
-                         * @description The team ID
-                         */
+                        /** @description The team ID */
                         teamId: string;
                         data: {
                             type: string;
@@ -452,6 +462,18 @@ interface paths$1 {
                                                 };
                                             };
                                             embeddedEditor?: string;
+                                            dataResourceSelectorUrl?: string;
+                                            dataResourceSelectorLocations?: {
+                                                [key: string]: {
+                                                    url: string;
+                                                    layout?: {
+                                                        /** @enum {string} */
+                                                        height?: "full-height";
+                                                        /** @enum {string} */
+                                                        width?: "wide";
+                                                    };
+                                                };
+                                            };
                                         };
                                     };
                                     badgeIconUrl?: string;
@@ -488,7 +510,6 @@ interface paths$1 {
                                     generateUrl: string;
                                     metadataUrl?: string;
                                     prompts?: {
-                                        /** Format: uuid */
                                         id: string;
                                         name: string;
                                         text: string;
@@ -547,7 +568,6 @@ interface paths$1 {
                                 }[];
                             };
                             unstable_prompts?: {
-                                /** Format: uuid */
                                 id: string;
                                 name: string;
                                 text: string;
@@ -715,6 +735,18 @@ interface paths$1 {
                                                 };
                                             };
                                             embeddedEditor?: string;
+                                            dataResourceSelectorUrl?: string;
+                                            dataResourceSelectorLocations?: {
+                                                [key: string]: {
+                                                    url: string;
+                                                    layout?: {
+                                                        /** @enum {string} */
+                                                        height?: "full-height";
+                                                        /** @enum {string} */
+                                                        width?: "wide";
+                                                    };
+                                                };
+                                            };
                                         };
                                     };
                                     badgeIconUrl?: string;
@@ -751,7 +783,6 @@ interface paths$1 {
                                     generateUrl: string;
                                     metadataUrl?: string;
                                     prompts?: {
-                                        /** Format: uuid */
                                         id: string;
                                         name: string;
                                         text: string;
@@ -810,7 +841,6 @@ interface paths$1 {
                                 }[];
                             };
                             unstable_prompts?: {
-                                /** Format: uuid */
                                 id: string;
                                 name: string;
                                 text: string;
@@ -849,10 +879,7 @@ interface paths$1 {
             requestBody: {
                 content: {
                     "application/json": {
-                        /**
-                         * Format: uuid
-                         * @description The team ID
-                         */
+                        /** @description The team ID */
                         teamId: string;
                         /** @description The integration type to remove */
                         type: string;
@@ -973,9 +1000,13 @@ interface paths {
         get: {
             parameters: {
                 query: {
+                    /** @description The project ID */
                     projectId: string;
+                    /** @description Limit results to a single integration type */
                     type?: string;
+                    /** @description Whether to match the passed type exactly or to treat the type as a prefix */
                     exactType?: boolean | null;
+                    /** @description Whether to use team-specific integration types or team-agnostic types (for serialization across projects) */
                     teamSpecificType?: boolean | null;
                 };
                 header?: never;
@@ -1018,11 +1049,9 @@ interface paths {
             requestBody: {
                 content: {
                     "application/json": {
-                        /**
-                         * Format: uuid
-                         * @description The project ID
-                         */
+                        /** @description The project ID */
                         projectId: string;
+                        /** @description Whether to match the passed type exactly or to treat the type as a prefix */
                         exactType?: boolean | null;
                         type: string;
                         data?: {
@@ -1058,13 +1087,11 @@ interface paths {
             requestBody: {
                 content: {
                     "application/json": {
-                        /**
-                         * Format: uuid
-                         * @description The project ID
-                         */
+                        /** @description The project ID */
                         projectId: string;
                         /** @description The integration type to remove */
                         type: string;
+                        /** @description Whether to match the passed type exactly or to treat the type as a prefix */
                         exactType?: boolean | null;
                     };
                 };
@@ -1328,6 +1355,16 @@ declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
                             };
                         };
                         embeddedEditor?: string;
+                        dataResourceSelectorUrl?: string;
+                        dataResourceSelectorLocations?: {
+                            [key: string]: {
+                                url: string;
+                                layout?: {
+                                    height?: "full-height";
+                                    width?: "wide";
+                                };
+                            };
+                        };
                     };
                 };
                 badgeIconUrl?: string;
@@ -1568,6 +1605,45 @@ type DataResourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonM
 }, TIntegrationConfiguration>;
 type DataResourceLocation = MeshLocationCore<DataResourceVariables, DataResourceLocationMetadata, DataResourceVariables, 'dataResource'> & GetDataResourceLocation;
 
+/**
+ * Metadata for the dataResourceSelector location.
+ * This location type allows custom UI for selecting JSON pointers within a data resource,
+ * replacing the default JSON tree viewer in the dynamic token picker.
+ * @deprecated This is experimental functionality and is subject to change without notice.
+ */
+type DataResourceSelectorLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
+    /** The resolved data for the currently selected data resource */
+    dataResourceValue: unknown;
+    /** The name of the currently selected data resource */
+    dataResourceName: string;
+    /** The data type ID for the current data resource */
+    dataTypeId: string;
+    /** The data type's archetype value (useful for apps sharing a selector across archetypes) */
+    archetype: string;
+    /** Allowed bindable types for the parameter being connected */
+    allowedTypes: BindableTypes[];
+    /** Component definitions index, keyed by public id. */
+    componentDefinitions: Record<string, ComponentDefinition | undefined>;
+}, TIntegrationConfiguration>;
+/**
+ * Location for custom data resource selector UI.
+ * Replaces the default JSON tree viewer when selecting dynamic tokens from a data resource.
+ *
+ * Value: The selected JSON pointer string (e.g., "/moves/0/move/name")
+ * setValue: Call with a valid JSON pointer to select that path
+ * getDataResource: Fetch data from the data connector using the current data source
+ * editorState: Imperative API for inspecting/mutating the underlying composition / entry tree
+ * @deprecated This is experimental functionality and is subject to change without notice.
+ */
+type DataResourceSelectorLocation = MeshLocationCore<string, DataResourceSelectorLocationMetadata, string, 'dataResourceSelector'> & GetDataResourceLocation & {
+    /**
+     * Imperative API for interacting with the composition/entry editor state.
+     * Provides non-reactive access to read and modify the editor state.
+     * @deprecated This is experimental functionality and is subject to change without notice.
+     */
+    editorState: EditorStateApi;
+};
+
 type DataSourceLocationValue = Pick<DataSource, 'baseUrl' | 'custom' | 'customPublic' | 'headers' | 'parameters' | 'variables' | 'enableUnpublishedMode' | 'variants'>;
 type DataSourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
     /**
@@ -1579,6 +1655,7 @@ type DataSourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonMet
 type DataSourceLocation = MeshLocationCore<DataSourceLocationValue, DataSourceLocationMetadata, DataSourceLocationValue, 'dataSource'>;
 
 type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfiguration = unknown> = CommonMetadata<{
+    /** editorState is an experimental replacement for rootNode. This may become deprecated in the future. */
     rootNode: Omit<RootComponentInstance, 'slots' | '_data'> & {
         _editionId?: string;
     };
@@ -1607,6 +1684,11 @@ type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfig
      * Note that setValue() always sets the target language automatically.
      */
     targetLocale: string | undefined;
+    /**
+     * The current locale selected in the editor UI.
+     * Unlike targetLocale, this reflects the editor's global locale state.
+     */
+    currentLocale: string | undefined;
     /**
      * When editing a conditional value, this is the index in the parent parameter of the conditional value.
      * If this is -1, then the editor is not editing a conditional value.
@@ -1619,6 +1701,12 @@ type ParamTypeLocation<TParamValue = unknown, TParamConfiguration = unknown, TPa
      * Returns the result of the dialog. Useful to build data-enabled parameter types.
      */
     editConnectedData: Awaited<ReturnType<typeof connectToParent>>['parent']['editConnectedData'];
+    /**
+     * Imperative API for interacting with the composition/entry editor state.
+     * Provides non-reactive access to read and modify the editor state.
+     * @deprecated This is experimental functionality and is subject to change without notice.
+     */
+    editorState: EditorStateApi;
 };
 
 type SettingsLocationMetadata = CommonMetadata;
@@ -1628,7 +1716,7 @@ type SettingsLocation<TSettingsType> = MeshLocationCore<TSettingsType, SettingsL
  * Defines methods used for interacting with a Mesh location
  * To receive useful typings, check the `type` property of the location to narrow the typing.
  */
-type MeshLocation<TValue = unknown, TSetValue = TValue> = ParamTypeLocation<TValue, unknown, TSetValue> | ParamTypeConfigLocation<TValue> | SettingsLocation<TValue> | AssetLibraryLocation | AssetParameterLocation | DataSourceLocation | DataTypeLocation | DataResourceLocation | CanvasEditorToolsLocation | EmbeddedEditorLocation | AIGenerateLocation<TValue> | AIPromptMetadataLocation | PersonalizationCriteriaLocation<TValue> | DashboardToolLocation<TValue> | ProjectToolLocation<TValue>;
+type MeshLocation<TValue = unknown, TSetValue = TValue> = ParamTypeLocation<TValue, unknown, TSetValue> | ParamTypeConfigLocation<TValue> | SettingsLocation<TValue> | AssetLibraryLocation | AssetParameterLocation | DataSourceLocation | DataTypeLocation | DataResourceLocation | DataResourceSelectorLocation | CanvasEditorToolsLocation | EmbeddedEditorLocation | AIGenerateLocation<TValue> | AIPromptMetadataLocation | PersonalizationCriteriaLocation<TValue> | DashboardToolLocation<TValue> | ProjectToolLocation<TValue>;
 interface MeshContextData {
     locationKey: string;
     locationType: MeshLocationTypes;
@@ -1820,6 +1908,7 @@ declare function connectToParent({ dialogResponseHandlers, onMetadataUpdated, on
         navigate: (message: NavigateMessage) => Promise<void>;
         reloadLocation: () => Promise<void>;
         editConnectedData: (message: EditConnectedDataMessage) => Promise<EditConnectedDataResponse>;
+        editorState: EditorStateApi;
     };
 }>;
 
@@ -1986,7 +2075,7 @@ type MeshLocationUserPermissions =
 /**
  * Known location types that can be passed to a mesh location
  */
-type MeshLocationTypes = 'paramType' | 'paramTypeConfig' | 'assetLibrary' | 'assetParameter' | 'settings' | 'dataSource' | 'dataType' | 'dataResource' | 'aiGenerate' | 'embeddedEditor' | 'canvasEditorTools' | 'aiMetadata' | 'personalizationCriteria' | 'dashboardTool' | 'projectTool';
+type MeshLocationTypes = 'paramType' | 'paramTypeConfig' | 'assetLibrary' | 'assetParameter' | 'settings' | 'dataSource' | 'dataType' | 'dataResource' | 'dataResourceSelector' | 'aiGenerate' | 'embeddedEditor' | 'canvasEditorTools' | 'aiMetadata' | 'personalizationCriteria' | 'dashboardTool' | 'projectTool';
 type SetValueOptions = ValidationResult;
 type SetValueMessage = {
     uniformMeshLocationValue: unknown;
@@ -2011,6 +2100,262 @@ type DynamicInput = {
 };
 /** Record of dynamic inputs keyed by the input name */
 type DynamicInputs = Record<string, DynamicInput>;
+/** Metadata about the composition (description, category, workflow, etc.) */
+type EditorRootMetadata = {
+    description?: string;
+    previewImageUrl?: string;
+    categoryId?: string;
+    workflowId?: string;
+    workflowStageId?: string;
+    editionName?: string;
+    editionPriority?: number;
+};
+/** Root node metadata (name and slug) */
+type EditorRootNodeMetadata = {
+    _name: string;
+    _slug: string | null | undefined;
+};
+/** Options for exporting the tree */
+type EditorExportOptions = {
+    /** If true, includes pattern descendant data in export */
+    keepPatternData?: boolean;
+};
+/** A component instance without slots/params (indexed separately) */
+type EditorComponentInstance = Omit<ComponentInstance, 'slots' | 'parameters' | '_id'>;
+/** An indexed node within the editor state */
+type EditorNode = {
+    nodeId: string;
+    parentId?: string;
+    isBlock?: boolean;
+    value: EditorComponentInstance;
+    /** If part of a pattern, the pattern ID */
+    partOfPattern?: string;
+    /** If part of a nested pattern */
+    partOfNestedPattern?: string;
+    /** UI expansion state */
+    isExpandedInUI?: boolean;
+};
+/** Child node IDs indexed by slot name */
+type EditorNodeChildren = {
+    [slotName: string]: string[];
+};
+/** A component parameter value */
+type EditorComponentParameter<T = unknown> = Omit<ComponentParameter<T>, 'connectedData'>;
+/** Parent info for a node */
+type EditorNodeParentInfo = {
+    parentId: string;
+    parentName: string;
+    targetIndexInParent: number;
+    value: EditorComponentInstance;
+    parentChildIds: string[];
+    parentType: 'slot' | 'block';
+};
+/** Options for updateNodeProperty */
+type UpdateNodePropertyOptions = {
+    nodeId: string;
+    property: string;
+    /**
+     * The new value to set. Pass the final value directly.
+     * - `undefined` to soft-delete (remove current locale/condition value)
+     * - `null` to hard-delete (remove entire parameter)
+     * - any other value to set
+     *
+     * For read-modify-write, call getNodeProperty() first to get current value.
+     */
+    value: unknown | undefined | null;
+    /** Parameter type (required for new parameters) */
+    type?: string;
+    /** Target locale, or undefined for invariant value */
+    locale: string | undefined;
+    /** Condition index (-1 for base value, >= 0 for conditional) */
+    conditionIndex: number;
+    /** Condition definition (required when conditionIndex >= 0) */
+    conditionDefinition?: VisibilityCriteriaGroup | null;
+};
+/** Options for insertNode */
+type InsertNodeOptions = {
+    node: EditorComponentInstance;
+    parentNodeId: string;
+    parentSlot: string;
+    targetIndexInSlot?: number;
+};
+/** Options for moveNode */
+type MoveNodeOptions = {
+    movedNodeId: string;
+    parentNodeId: string;
+    parentSlot: string;
+    targetIndexInSlot: number;
+};
+/** Options for deleteNode */
+type DeleteNodeOptions = {
+    nodeId: string;
+    /**
+     * When true, deletes a block entry without slot-parent bookkeeping.
+     * Pass this when removing nodes from a block parameter.
+     */
+    isBlock?: boolean;
+};
+/**
+ * Common fields for {@link EditorStateApi.setPropertyLocalizability}.
+ */
+interface SetPropertyLocalizabilityCommonParams {
+    /** The node owning the parameter. */
+    nodeId: string;
+    /** The parameter id. */
+    property: string;
+    /**
+     * The component-definition parameter for `(nodeId, property)`. Required: the bridge
+     * uses this to enforce localizability business rules (refuses to localize a parameter
+     * whose definition disallows it) and to resolve the parameter type for value fan-out.
+     *
+     * Mesh integrations must resolve this from the Uniform public API (using a service
+     * account API key today, or identity delegation in the future) — the editor frame does
+     * not expose component definitions to mesh apps.
+     */
+    propertyDefinition: ComponentDefinitionParameter;
+}
+/**
+ * Discriminated-union params for {@link EditorStateApi.setPropertyLocalizability}.
+ *
+ * - `isLocalized: true` (toggle ON): per-locale values are written to every enabled
+ *   locale of the composition.
+ * - `isLocalized: false` (toggle OFF): per-locale values are collapsed back into a
+ *   single invariant value, copying from `copyFromLocale` (or the first defined locale).
+ */
+type SetPropertyLocalizabilityParams = (SetPropertyLocalizabilityCommonParams & {
+    /** Toggle ON: convert the invariant value to per-locale values. */
+    isLocalized: true;
+}) | (SetPropertyLocalizabilityCommonParams & {
+    /** Toggle OFF: collapse per-locale values back to a single invariant value. */
+    isLocalized: false;
+    /**
+     * The locale whose value becomes the new invariant value. Defaults to the first
+     * locale with a defined value on the parameter.
+     */
+    copyFromLocale?: string;
+});
+/** Options for insertPattern */
+type InsertPatternOptions = {
+    pattern: RootComponentInstance;
+    parentNodeId: string;
+    parentSlot: string;
+    targetIndexInSlot?: number;
+    patternInstanceId?: string;
+};
+/** Options for updateRootNode */
+type UpdateRootNodeOptions = {
+    update: Partial<EditorRootNodeMetadata>;
+};
+/**
+ * Imperative API for interacting with the composition/entry editor state.
+ * Available on `canvasEditorTools` and `paramType` locations.
+ *
+ * All methods use object parameters for consistency across client, wire format, and server.
+ */
+interface EditorStateApi {
+    getRootNodeId(): Promise<string>;
+    exportTree(params?: EditorExportOptions): Promise<RootComponentInstance | EntryData>;
+    exportSubtree(params: {
+        nodeId: string;
+        options?: EditorExportOptions;
+    }): Promise<ComponentInstance | EntryData>;
+    exportMetadata(): Promise<EditorRootMetadata>;
+    exportRootNodeMetadata(): Promise<EditorRootNodeMetadata>;
+    getNodeById(params: {
+        nodeId: string;
+    }): Promise<EditorNode | undefined>;
+    getNodeChildren(params: {
+        nodeId: string;
+    }): Promise<EditorNodeChildren | undefined>;
+    getNodeProperty<T = unknown>(params: {
+        nodeId: string;
+        property: string;
+    }): Promise<EditorComponentParameter<T> | undefined>;
+    getNodeProperties(params: {
+        nodeId: string;
+    }): Promise<Record<string, EditorComponentParameter>>;
+    getParentInfo(params: {
+        nodeId: string;
+    }): Promise<EditorNodeParentInfo | undefined>;
+    getSelectedNodeId(): Promise<string | undefined>;
+    setSelectedNodeId(params: {
+        nodeId: string | undefined;
+    }): Promise<void>;
+    getSelectedParameterId(): Promise<string | undefined>;
+    setSelectedParameterId(params: {
+        parameterId: string | undefined;
+    }): Promise<void>;
+    getPristine(): Promise<boolean>;
+    insertNode(params: InsertNodeOptions): Promise<string>;
+    deleteNode(params: DeleteNodeOptions): Promise<void>;
+    moveNode(params: MoveNodeOptions): Promise<void>;
+    updateNodeProperty(params: UpdateNodePropertyOptions): Promise<void>;
+    updateRootMetadata(params: {
+        metadata: Partial<EditorRootMetadata>;
+    }): Promise<void>;
+    updateRootNode(params: UpdateRootNodeOptions): Promise<void>;
+    insertPattern(params: InsertPatternOptions): Promise<string>;
+    isPatternPropertyOverridden(params: {
+        nodeId: string;
+        property: string;
+        locale?: string;
+    }): Promise<boolean>;
+    resetPatternPropertyOverride(params: {
+        nodeId: string;
+        property: string;
+        locale: string | undefined;
+    }): Promise<void>;
+    /**
+     * Toggles a parameter between "shared" (single invariant value) and "localized"
+     * (per-locale values) — the same operation as the dashboard "Use locale-specific values"
+     * switch on the parameter's locale drawer.
+     *
+     * - `isLocalized: true` copies the current invariant value (and its conditions) into
+     *   each locale enabled on the composition.
+     * - `isLocalized: false` copies the value from `copyFromLocale` (or the first defined
+     *   locale, if omitted) back into the invariant slot and drops the per-locale values.
+     *
+     * The migration handles pattern parameter overrides, `contentReference` data resource
+     * forking, and the per-node localizability metadata, so the resulting state matches
+     * what the dashboard UI would produce for the same toggle. The whole migration is one
+     * editor mutation, which keeps it as a single undo step for the user.
+     *
+     * The caller must supply `propertyDefinition` — the component-definition parameter for
+     * `(nodeId, property)`. This is required so the bridge can enforce localizability
+     * business rules (e.g. refusing to localize a parameter whose definition forbids it)
+     * and resolve the parameter type for value fan-out. Resolve it from the Uniform public
+     * API using your service account API key (or, in the future, identity delegation) and
+     * cache it client-side as needed.
+     *
+     * No-ops if the parameter is already in the requested state; if the parameter does not
+     * exist on the node; if (when localizing) no locales are enabled; or if (when
+     * localizing) the supplied `propertyDefinition.localizable` is `false`.
+     *
+     * @beta This is beta functionality. It is intentionally exposed as `@deprecated` so
+     * consumers do not depend on it from production integrations — the signature and
+     * behaviour may change without notice.
+     * @deprecated Beta. Subject to change without notice; do not rely on this API in
+     * production integrations.
+     */
+    setPropertyLocalizability(params: SetPropertyLocalizabilityParams): Promise<void>;
+    enableLocale(params: {
+        locale: string | string[];
+    }): Promise<void>;
+    disableLocale(params: {
+        locale: string;
+    }): Promise<void>;
+    /** Sets the currently active locale in the editor UI */
+    setCurrentLocale(params: {
+        locale: string;
+    }): Promise<void>;
+    /**
+     * Sets the current preview value for a dynamic input.
+     */
+    setDynamicInputPreviewValue(params: {
+        name: string;
+        value: string;
+    }): Promise<void>;
+}
 
 type AIGenerateLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
     prompt: string;
@@ -2037,6 +2382,15 @@ type CanvasEditorToolsLocationMetadata<TIntegrationConfiguration = unknown> = Co
      */
     activeReleaseId?: string;
     state?: number;
+    /** The current locale selected in the editor UI */
+    currentLocale: string | undefined;
+    /**
+     * Current dynamic inputs configured on the composition (if any).
+     * Dynamic inputs come from project map nodes and represent path or query based dynamic values.
+     */
+    dynamicInputs: DynamicInputs;
+    /** Component definitions index, keyed by public id. */
+    componentDefinitions: Record<string, ComponentDefinition | undefined>;
 }, TIntegrationConfiguration>;
 type CanvasEditorToolsReferenceData = {
     name: string;
@@ -2047,13 +2401,22 @@ type CanvasEditorToolsData = {
     entryNamesIndex?: Record<string, CanvasEditorToolsReferenceData>;
     entityType: CanvasEditorEntityType;
 } & ({
+    /** editorState is an experimental replacement for rootEntity. This may become deprecated in the future. */
     rootEntity: RootComponentInstance;
     entityType: 'composition' | 'componentPattern' | 'compositionDefaults';
 } | {
+    /** editorState is an experimental replacement for rootEntity. This may become deprecated in the future. */
     rootEntity: EntryData;
     entityType: 'entry' | 'entryPattern';
 });
-type CanvasEditorToolsLocation = MeshLocationCore<CanvasEditorToolsData, CanvasEditorToolsLocationMetadata, CanvasEditorToolsData, 'canvasEditorTools'> & GetDataResourceLocation;
+type CanvasEditorToolsLocation = MeshLocationCore<CanvasEditorToolsData, CanvasEditorToolsLocationMetadata, CanvasEditorToolsData, 'canvasEditorTools'> & GetDataResourceLocation & {
+    /**
+     * Imperative API for interacting with the composition/entry editor state.
+     * Provides non-reactive access to read and modify the editor state.
+     * @deprecated This is experimental functionality and is subject to change without notice.
+     */
+    editorState: EditorStateApi;
+};
 
 /**
  * @deprecated Alpha version of the Embedded Editor location. This location is not yet available for use in the Mesh SDK.
@@ -2221,4 +2584,4 @@ declare const hasPermissions: (permissions: MeshLocationUserPermissions | MeshLo
  */
 declare const hasRole: (role: string, user: UniformUser) => boolean;
 
-export { type AIGenerateLocation, type AIGenerateLocationMetadata, type AIPromptMetadataLocation, type AssetLibraryLocation, type AssetLibraryLocationMetadata, type AssetParameterLocation, type AssetParameterLocationMetadata, type BindableTypes, type CSSHeight, type CanvasEditorEntityType, type CanvasEditorToolsData, type CanvasEditorToolsLocation, type CanvasEditorToolsLocationMetadata, type CloseDialogMessage, type CloseLocationDialogOptions, type CommonMetadata, type DashboardToolLocation, type DashboardToolLocationMetadata, type DataConnectorInfo, type DataResourceLocation, type DataResourceLocationMetadata, type DataSourceLocation, type DataSourceLocationMetadata, type DataSourceLocationValue, type DataTypeLocation, type DataTypeLocationMetadata, type DataTypeLocationValue, type DialogContext, type DialogOptions, type DialogParamValue, type DialogParams, type DialogResponseData, type DialogResponseHandler, type DialogResponseHandlers, type DialogType, type DynamicInput, type DynamicInputs, type EditConnectedDataMessage, type EditConnectedDataResponse, type EditConnectedDataResponseCancellationContext, type EmbeddedEditorLocation, type EmbeddedEditorLocationMetadata, type EmbeddedEditorLocationSetValue, type EmbeddedEditorLocationValue, type FunctionCallResponse, type FunctionCallSystemParameter, type GetDataResourceLocation, type GetDataResourceMessage, IntegrationDefinitionClient, type IntegrationDefinitionDeleteParameters, type IntegrationDefinitionGetParameters, type IntegrationDefinitionGetResponse, type IntegrationDefinitionPutParameters, type IntegrationDefinitionPutResponse, IntegrationInstallationClient, type IntegrationInstallationDeleteParameters, type IntegrationInstallationGetParameters, type IntegrationInstallationGetResponse, type IntegrationInstallationPutParameters, type LocationDialogResponse, type MeshContextData, type MeshLocation, type MeshLocationCore, type MeshLocationTypes, type MeshLocationUserPermissions, type MeshRouter, type MeshSDKEventInterface, type NavigateMessage, type OpenConfirmationDialogOptions, type OpenConfirmationDialogResult, type OpenDialogMessage, type OpenDialogResult, type OpenLocationDialogOptions, type ParamTypeConfigLocation, type ParamTypeConfigLocationMetadata, type ParamTypeLocation, type ParamTypeLocationMetadata, type PersonalizationCriteriaLocation, type PersonalizationCriteriaLocationMetadata, type ProjectToolLocation, type ProjectToolLocationMetadata, type PromptSettingsLocationMetadata, type SdkWindow, type SetLocationFunction, type SetValueMessage, type SetValueOptions, type SettingsLocation, type SettingsLocationMetadata, type UniformMeshSDK, type UniformMeshSDKEvents, type UniformUser, type ValidationResult, functionCallSystemParameters, hasPermissions, hasRole, initializeUniformMeshSDK, parseFunctionCall };
+export { type AIGenerateLocation, type AIGenerateLocationMetadata, type AIPromptMetadataLocation, type AssetLibraryLocation, type AssetLibraryLocationMetadata, type AssetParameterLocation, type AssetParameterLocationMetadata, type BindableTypes, type CSSHeight, type CanvasEditorEntityType, type CanvasEditorToolsData, type CanvasEditorToolsLocation, type CanvasEditorToolsLocationMetadata, type CloseDialogMessage, type CloseLocationDialogOptions, type CommonMetadata, type DashboardToolLocation, type DashboardToolLocationMetadata, type DataConnectorInfo, type DataResourceLocation, type DataResourceLocationMetadata, type DataResourceSelectorLocation, type DataResourceSelectorLocationMetadata, type DataSourceLocation, type DataSourceLocationMetadata, type DataSourceLocationValue, type DataTypeLocation, type DataTypeLocationMetadata, type DataTypeLocationValue, type DeleteNodeOptions, type DialogContext, type DialogOptions, type DialogParamValue, type DialogParams, type DialogResponseData, type DialogResponseHandler, type DialogResponseHandlers, type DialogType, type DynamicInput, type DynamicInputs, type EditConnectedDataMessage, type EditConnectedDataResponse, type EditConnectedDataResponseCancellationContext, type EditorComponentInstance, type EditorComponentParameter, type EditorExportOptions, type EditorNode, type EditorNodeChildren, type EditorNodeParentInfo, type EditorRootMetadata, type EditorRootNodeMetadata, type EditorStateApi, type EmbeddedEditorLocation, type EmbeddedEditorLocationMetadata, type EmbeddedEditorLocationSetValue, type EmbeddedEditorLocationValue, type FunctionCallResponse, type FunctionCallSystemParameter, type GetDataResourceLocation, type GetDataResourceMessage, type InsertNodeOptions, type InsertPatternOptions, IntegrationDefinitionClient, type IntegrationDefinitionDeleteParameters, type IntegrationDefinitionGetParameters, type IntegrationDefinitionGetResponse, type IntegrationDefinitionPutParameters, type IntegrationDefinitionPutResponse, IntegrationInstallationClient, type IntegrationInstallationDeleteParameters, type IntegrationInstallationGetParameters, type IntegrationInstallationGetResponse, type IntegrationInstallationPutParameters, type LocationDialogResponse, type MeshContextData, type MeshLocation, type MeshLocationCore, type MeshLocationTypes, type MeshLocationUserPermissions, type MeshRouter, type MeshSDKEventInterface, type MoveNodeOptions, type NavigateMessage, type OpenConfirmationDialogOptions, type OpenConfirmationDialogResult, type OpenDialogMessage, type OpenDialogResult, type OpenLocationDialogOptions, type ParamTypeConfigLocation, type ParamTypeConfigLocationMetadata, type ParamTypeLocation, type ParamTypeLocationMetadata, type PersonalizationCriteriaLocation, type PersonalizationCriteriaLocationMetadata, type ProjectToolLocation, type ProjectToolLocationMetadata, type PromptSettingsLocationMetadata, type SdkWindow, type SetLocationFunction, type SetPropertyLocalizabilityCommonParams, type SetPropertyLocalizabilityParams, type SetValueMessage, type SetValueOptions, type SettingsLocation, type SettingsLocationMetadata, type UniformMeshSDK, type UniformMeshSDKEvents, type UniformUser, type UpdateNodePropertyOptions, type UpdateRootNodeOptions, type ValidationResult, functionCallSystemParameters, hasPermissions, hasRole, initializeUniformMeshSDK, parseFunctionCall };