@uniformdev/mesh-sdk 20.66.5-alpha.2 → 20.66.6-alpha.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -1,5 +1,5 @@
1
1
  import { ApiClient, ClientOptions, ExceptProject } from '@uniformdev/context/api';
2
- import { AssetParamValue, DataType, DataSource, DataResourceVariables, DataSourceVariantsKeys, ComponentDefinition, RootComponentInstance, ComponentInstance, ComponentDefinitionParameter, DataVariableDefinition, Locale, EntryData, ComponentParameter, VisibilityCriteriaGroup } from '@uniformdev/canvas';
2
+ import { AssetParamValue, DataType, DataSource, DataResourceVariables, DataSourceVariantsKeys, RootComponentInstance, ComponentInstance, ComponentDefinitionParameter, DataVariableDefinition, Locale, ComponentDefinition, EntryData, ComponentParameter, VisibilityCriteriaGroup } from '@uniformdev/canvas';
3
3
  export { AssetParamValue, AssetParamValueItem } from '@uniformdev/canvas';
4
4
  import { ProjectMapNode } from '@uniformdev/project-map';
5
5
  import { AssetDefinitionType } from '@uniformdev/assets';
@@ -1578,17 +1578,7 @@ type DataTypeLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetad
1578
1578
  }, TIntegrationConfiguration>;
1579
1579
  type DataTypeLocation = MeshLocationCore<DataTypeLocationValue, DataTypeLocationMetadata, DataTypeLocationValue, 'dataType'> & GetDataResourceLocation;
1580
1580
 
1581
- type DataResourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
1582
- /**
1583
- * The release ID of the currently edited entity.
1584
- * This can be undefined when a release is active but the entity has not been copied to that release yet.
1585
- */
1586
- releaseId?: string;
1587
- /**
1588
- * The currently active release ID from editor context.
1589
- * This reflects release selection regardless of whether the edited entity exists in that release.
1590
- */
1591
- activeReleaseId?: string;
1581
+ type DataResourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<CanvasEditorContextMetadata & {
1592
1582
  dataType: DataType;
1593
1583
  /** The data type's archetype value. */
1594
1584
  archetype: string;
@@ -1598,12 +1588,10 @@ type DataResourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonM
1598
1588
  dataSource: DataSource;
1599
1589
  /** The data connector type of the current data resource's data source */
1600
1590
  dataConnector: DataConnectorInfo;
1601
- /** Current dynamic inputs that are configured on the composition (if any). */
1602
- dynamicInputs: DynamicInputs;
1603
1591
  /** Which Data Source variant is being resolved and used for getDataResource (unless overriden explicitly via providing "undefined") */
1604
1592
  dataSourceVariant?: DataSourceVariantsKeys;
1605
1593
  }, TIntegrationConfiguration>;
1606
- type DataResourceLocation = MeshLocationCore<DataResourceVariables, DataResourceLocationMetadata, DataResourceVariables, 'dataResource'> & GetDataResourceLocation;
1594
+ type DataResourceLocation = MeshLocationCore<DataResourceVariables, DataResourceLocationMetadata, DataResourceVariables, 'dataResource'> & GetDataResourceLocation & GetEditorStateLocationMaybe;
1607
1595
 
1608
1596
  /**
1609
1597
  * Metadata for the dataResourceSelector location.
@@ -1611,7 +1599,7 @@ type DataResourceLocation = MeshLocationCore<DataResourceVariables, DataResource
1611
1599
  * replacing the default JSON tree viewer in the dynamic token picker.
1612
1600
  * @deprecated This is experimental functionality and is subject to change without notice.
1613
1601
  */
1614
- type DataResourceSelectorLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
1602
+ type DataResourceSelectorLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<CanvasEditorContextMetadata & {
1615
1603
  /** The resolved data for the currently selected data resource */
1616
1604
  dataResourceValue: unknown;
1617
1605
  /** The name of the currently selected data resource */
@@ -1622,8 +1610,6 @@ type DataResourceSelectorLocationMetadata<TIntegrationConfiguration = unknown> =
1622
1610
  archetype: string;
1623
1611
  /** Allowed bindable types for the parameter being connected */
1624
1612
  allowedTypes: BindableTypes[];
1625
- /** Component definitions index, keyed by public id. */
1626
- componentDefinitions: Record<string, ComponentDefinition | undefined>;
1627
1613
  }, TIntegrationConfiguration>;
1628
1614
  /**
1629
1615
  * Location for custom data resource selector UI.
@@ -1635,14 +1621,7 @@ type DataResourceSelectorLocationMetadata<TIntegrationConfiguration = unknown> =
1635
1621
  * editorState: Imperative API for inspecting/mutating the underlying composition / entry tree
1636
1622
  * @deprecated This is experimental functionality and is subject to change without notice.
1637
1623
  */
1638
- type DataResourceSelectorLocation = MeshLocationCore<string, DataResourceSelectorLocationMetadata, string, 'dataResourceSelector'> & GetDataResourceLocation & {
1639
- /**
1640
- * Imperative API for interacting with the composition/entry editor state.
1641
- * Provides non-reactive access to read and modify the editor state.
1642
- * @deprecated This is experimental functionality and is subject to change without notice.
1643
- */
1644
- editorState: EditorStateApi;
1645
- };
1624
+ type DataResourceSelectorLocation = MeshLocationCore<string, DataResourceSelectorLocationMetadata, string, 'dataResourceSelector'> & GetDataResourceLocation & GetEditorStateLocationMaybe;
1646
1625
 
1647
1626
  type DataSourceLocationValue = Pick<DataSource, 'baseUrl' | 'custom' | 'customPublic' | 'headers' | 'parameters' | 'variables' | 'enableUnpublishedMode' | 'variants'>;
1648
1627
  type DataSourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
@@ -1654,20 +1633,14 @@ type DataSourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonMet
1654
1633
  }, TIntegrationConfiguration>;
1655
1634
  type DataSourceLocation = MeshLocationCore<DataSourceLocationValue, DataSourceLocationMetadata, DataSourceLocationValue, 'dataSource'>;
1656
1635
 
1657
- type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfiguration = unknown> = CommonMetadata<{
1636
+ type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfiguration = unknown> = CommonMetadata<CanvasEditorContextMetadata & {
1658
1637
  /** editorState is an experimental replacement for rootNode. This may become deprecated in the future. */
1659
1638
  rootNode: Omit<RootComponentInstance, 'slots' | '_data'> & {
1660
1639
  _editionId?: string;
1661
1640
  };
1662
1641
  parameterConfiguration: TParamConfiguration;
1663
1642
  component: Omit<ComponentInstance, 'slots'>;
1664
- componentDefinitions: Record<string, ComponentDefinition | undefined>;
1665
1643
  parameterDefinition: ComponentDefinitionParameter;
1666
- /**
1667
- * Current dynamic inputs that are configured on the composition (if any).
1668
- * Use the <ParamTypeDynamicDataProvider> to wire up dynamic data in your parameter.
1669
- */
1670
- dynamicInputs: DynamicInputs;
1671
1644
  /**
1672
1645
  * The connected data for the current component. Connected data is provided as a map
1673
1646
  * of the binding expression text to the value of that binding expression. For example,
@@ -1684,11 +1657,6 @@ type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfig
1684
1657
  * Note that setValue() always sets the target language automatically.
1685
1658
  */
1686
1659
  targetLocale: string | undefined;
1687
- /**
1688
- * The current locale selected in the editor UI.
1689
- * Unlike targetLocale, this reflects the editor's global locale state.
1690
- */
1691
- currentLocale: string | undefined;
1692
1660
  /**
1693
1661
  * When editing a conditional value, this is the index in the parent parameter of the conditional value.
1694
1662
  * If this is -1, then the editor is not editing a conditional value.
@@ -1701,13 +1669,7 @@ type ParamTypeLocation<TParamValue = unknown, TParamConfiguration = unknown, TPa
1701
1669
  * Returns the result of the dialog. Useful to build data-enabled parameter types.
1702
1670
  */
1703
1671
  editConnectedData: Awaited<ReturnType<typeof connectToParent>>['parent']['editConnectedData'];
1704
- /**
1705
- * Imperative API for interacting with the composition/entry editor state.
1706
- * Provides non-reactive access to read and modify the editor state.
1707
- * @deprecated This is experimental functionality and is subject to change without notice.
1708
- */
1709
- editorState: EditorStateApi;
1710
- };
1672
+ } & GetEditorStateLocation;
1711
1673
 
1712
1674
  type SettingsLocationMetadata = CommonMetadata;
1713
1675
  type SettingsLocation<TSettingsType> = MeshLocationCore<TSettingsType, SettingsLocationMetadata, TSettingsType, 'settings'>;
@@ -1983,6 +1945,28 @@ type CommonMetadata<ExtendedMetadata = unknown, TIntegrationConfiguration = unkn
1983
1945
  /** List if enabled Uniform Project locales */
1984
1946
  locales: Locale[];
1985
1947
  } & ExtendedMetadata;
1948
+ /**
1949
+ * Serializable metadata fields available in Canvas/Entry editor context.
1950
+ * {@link EditorStateApi} is not part of metadata; it is provided on the location object via mesh-sdk comms.
1951
+ */
1952
+ type CanvasEditorContextMetadata = {
1953
+ /** Component definitions index, keyed by public id. */
1954
+ componentDefinitions: Record<string, ComponentDefinition | undefined>;
1955
+ /** Current dynamic inputs configured on the composition (if any). */
1956
+ dynamicInputs: DynamicInputs;
1957
+ /** The current locale selected in the editor UI */
1958
+ currentLocale: string | undefined;
1959
+ /**
1960
+ * The release ID of the currently edited entity.
1961
+ * Can be undefined when a release is active but the entity has not been copied to that release yet.
1962
+ */
1963
+ releaseId?: string;
1964
+ /**
1965
+ * The currently active release ID from editor context.
1966
+ * This reflects release selection regardless of whether the edited entity exists in that release.
1967
+ */
1968
+ activeReleaseId?: string;
1969
+ };
1986
1970
  type MeshLocationUserPermissions =
1987
1971
  /** Uniform Context:Enrichments:Create */
1988
1972
  'ENRICHMENTS_CREATE'
@@ -2085,6 +2069,25 @@ type SetValueMessage = {
2085
2069
  type GetDataResourceLocation = {
2086
2070
  getDataResource: Awaited<ReturnType<typeof connectToParent>>['parent']['getDataResource'];
2087
2071
  };
2072
+ type GetEditorStateLocation = {
2073
+ /**
2074
+ * Imperative API for interacting with the composition/entry editor state.
2075
+ * Provides non-reactive access to read and modify the editor state.
2076
+ * @deprecated This is experimental functionality and is subject to change without notice.
2077
+ */
2078
+ editorState: EditorStateApi;
2079
+ };
2080
+ type GetEditorStateLocationMaybe = {
2081
+ /**
2082
+ * Imperative API for interacting with the composition/entry editor state.
2083
+ * Provides non-reactive access to read and modify the editor state.
2084
+ *
2085
+ * "undefined" means that the location is rendered outside of Canvas Editor context, e.g. Data Type testing.
2086
+ *
2087
+ * @deprecated This is experimental functionality and is subject to change without notice.
2088
+ */
2089
+ editorState: EditorStateApi | undefined;
2090
+ };
2088
2091
  /**
2089
2092
  * Dynamic inputs come from project map and represent path or query based dynamic values
2090
2093
  * These can be connected to from within a Mesh location by setting a data resource variable to contain ex:
@@ -2248,7 +2251,7 @@ type UpdateRootNodeOptions = {
2248
2251
  };
2249
2252
  /**
2250
2253
  * Imperative API for interacting with the composition/entry editor state.
2251
- * Available on `canvasEditorTools` and `paramType` locations.
2254
+ * Available on `canvasEditorTools`, `paramType`, `dataResource`, and `dataResourceSelector` locations.
2252
2255
  *
2253
2256
  * All methods use object parameters for consistency across client, wire format, and server.
2254
2257
  */
@@ -2370,27 +2373,8 @@ type PromptSettingsLocationMetadata<TIntegrationConfiguration = unknown> = Commo
2370
2373
  type AIGenerateLocation<TType> = MeshLocationCore<TType, AIGenerateLocationMetadata, TType, 'aiGenerate'>;
2371
2374
  type AIPromptMetadataLocation = MeshLocationCore<Record<string, unknown>, PromptSettingsLocationMetadata, Record<string, unknown>, 'aiMetadata'>;
2372
2375
 
2373
- type CanvasEditorToolsLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
2374
- /**
2375
- * The release ID of the currently edited entity.
2376
- * This can be undefined when a release is active but the entity has not been copied to that release yet.
2377
- */
2378
- releaseId?: string;
2379
- /**
2380
- * The currently active release ID from editor context.
2381
- * This reflects release selection regardless of whether the edited entity exists in that release.
2382
- */
2383
- activeReleaseId?: string;
2376
+ type CanvasEditorToolsLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<CanvasEditorContextMetadata & {
2384
2377
  state?: number;
2385
- /** The current locale selected in the editor UI */
2386
- currentLocale: string | undefined;
2387
- /**
2388
- * Current dynamic inputs configured on the composition (if any).
2389
- * Dynamic inputs come from project map nodes and represent path or query based dynamic values.
2390
- */
2391
- dynamicInputs: DynamicInputs;
2392
- /** Component definitions index, keyed by public id. */
2393
- componentDefinitions: Record<string, ComponentDefinition | undefined>;
2394
2378
  }, TIntegrationConfiguration>;
2395
2379
  type CanvasEditorToolsReferenceData = {
2396
2380
  name: string;
@@ -2409,14 +2393,7 @@ type CanvasEditorToolsData = {
2409
2393
  rootEntity: EntryData;
2410
2394
  entityType: 'entry' | 'entryPattern';
2411
2395
  });
2412
- type CanvasEditorToolsLocation = MeshLocationCore<CanvasEditorToolsData, CanvasEditorToolsLocationMetadata, CanvasEditorToolsData, 'canvasEditorTools'> & GetDataResourceLocation & {
2413
- /**
2414
- * Imperative API for interacting with the composition/entry editor state.
2415
- * Provides non-reactive access to read and modify the editor state.
2416
- * @deprecated This is experimental functionality and is subject to change without notice.
2417
- */
2418
- editorState: EditorStateApi;
2419
- };
2396
+ type CanvasEditorToolsLocation = MeshLocationCore<CanvasEditorToolsData, CanvasEditorToolsLocationMetadata, CanvasEditorToolsData, 'canvasEditorTools'> & GetDataResourceLocation & GetEditorStateLocation;
2420
2397
 
2421
2398
  /**
2422
2399
  * @deprecated Alpha version of the Embedded Editor location. This location is not yet available for use in the Mesh SDK.
@@ -2584,4 +2561,4 @@ declare const hasPermissions: (permissions: MeshLocationUserPermissions | MeshLo
2584
2561
  */
2585
2562
  declare const hasRole: (role: string, user: UniformUser) => boolean;
2586
2563
 
2587
- 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 };
2564
+ export { type AIGenerateLocation, type AIGenerateLocationMetadata, type AIPromptMetadataLocation, type AssetLibraryLocation, type AssetLibraryLocationMetadata, type AssetParameterLocation, type AssetParameterLocationMetadata, type BindableTypes, type CSSHeight, type CanvasEditorContextMetadata, 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 GetEditorStateLocation, type GetEditorStateLocationMaybe, 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 };
package/dist/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import { ApiClient, ClientOptions, ExceptProject } from '@uniformdev/context/api';
2
- import { AssetParamValue, DataType, DataSource, DataResourceVariables, DataSourceVariantsKeys, ComponentDefinition, RootComponentInstance, ComponentInstance, ComponentDefinitionParameter, DataVariableDefinition, Locale, EntryData, ComponentParameter, VisibilityCriteriaGroup } from '@uniformdev/canvas';
2
+ import { AssetParamValue, DataType, DataSource, DataResourceVariables, DataSourceVariantsKeys, RootComponentInstance, ComponentInstance, ComponentDefinitionParameter, DataVariableDefinition, Locale, ComponentDefinition, EntryData, ComponentParameter, VisibilityCriteriaGroup } from '@uniformdev/canvas';
3
3
  export { AssetParamValue, AssetParamValueItem } from '@uniformdev/canvas';
4
4
  import { ProjectMapNode } from '@uniformdev/project-map';
5
5
  import { AssetDefinitionType } from '@uniformdev/assets';
@@ -1578,17 +1578,7 @@ type DataTypeLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetad
1578
1578
  }, TIntegrationConfiguration>;
1579
1579
  type DataTypeLocation = MeshLocationCore<DataTypeLocationValue, DataTypeLocationMetadata, DataTypeLocationValue, 'dataType'> & GetDataResourceLocation;
1580
1580
 
1581
- type DataResourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
1582
- /**
1583
- * The release ID of the currently edited entity.
1584
- * This can be undefined when a release is active but the entity has not been copied to that release yet.
1585
- */
1586
- releaseId?: string;
1587
- /**
1588
- * The currently active release ID from editor context.
1589
- * This reflects release selection regardless of whether the edited entity exists in that release.
1590
- */
1591
- activeReleaseId?: string;
1581
+ type DataResourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<CanvasEditorContextMetadata & {
1592
1582
  dataType: DataType;
1593
1583
  /** The data type's archetype value. */
1594
1584
  archetype: string;
@@ -1598,12 +1588,10 @@ type DataResourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonM
1598
1588
  dataSource: DataSource;
1599
1589
  /** The data connector type of the current data resource's data source */
1600
1590
  dataConnector: DataConnectorInfo;
1601
- /** Current dynamic inputs that are configured on the composition (if any). */
1602
- dynamicInputs: DynamicInputs;
1603
1591
  /** Which Data Source variant is being resolved and used for getDataResource (unless overriden explicitly via providing "undefined") */
1604
1592
  dataSourceVariant?: DataSourceVariantsKeys;
1605
1593
  }, TIntegrationConfiguration>;
1606
- type DataResourceLocation = MeshLocationCore<DataResourceVariables, DataResourceLocationMetadata, DataResourceVariables, 'dataResource'> & GetDataResourceLocation;
1594
+ type DataResourceLocation = MeshLocationCore<DataResourceVariables, DataResourceLocationMetadata, DataResourceVariables, 'dataResource'> & GetDataResourceLocation & GetEditorStateLocationMaybe;
1607
1595
 
1608
1596
  /**
1609
1597
  * Metadata for the dataResourceSelector location.
@@ -1611,7 +1599,7 @@ type DataResourceLocation = MeshLocationCore<DataResourceVariables, DataResource
1611
1599
  * replacing the default JSON tree viewer in the dynamic token picker.
1612
1600
  * @deprecated This is experimental functionality and is subject to change without notice.
1613
1601
  */
1614
- type DataResourceSelectorLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
1602
+ type DataResourceSelectorLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<CanvasEditorContextMetadata & {
1615
1603
  /** The resolved data for the currently selected data resource */
1616
1604
  dataResourceValue: unknown;
1617
1605
  /** The name of the currently selected data resource */
@@ -1622,8 +1610,6 @@ type DataResourceSelectorLocationMetadata<TIntegrationConfiguration = unknown> =
1622
1610
  archetype: string;
1623
1611
  /** Allowed bindable types for the parameter being connected */
1624
1612
  allowedTypes: BindableTypes[];
1625
- /** Component definitions index, keyed by public id. */
1626
- componentDefinitions: Record<string, ComponentDefinition | undefined>;
1627
1613
  }, TIntegrationConfiguration>;
1628
1614
  /**
1629
1615
  * Location for custom data resource selector UI.
@@ -1635,14 +1621,7 @@ type DataResourceSelectorLocationMetadata<TIntegrationConfiguration = unknown> =
1635
1621
  * editorState: Imperative API for inspecting/mutating the underlying composition / entry tree
1636
1622
  * @deprecated This is experimental functionality and is subject to change without notice.
1637
1623
  */
1638
- type DataResourceSelectorLocation = MeshLocationCore<string, DataResourceSelectorLocationMetadata, string, 'dataResourceSelector'> & GetDataResourceLocation & {
1639
- /**
1640
- * Imperative API for interacting with the composition/entry editor state.
1641
- * Provides non-reactive access to read and modify the editor state.
1642
- * @deprecated This is experimental functionality and is subject to change without notice.
1643
- */
1644
- editorState: EditorStateApi;
1645
- };
1624
+ type DataResourceSelectorLocation = MeshLocationCore<string, DataResourceSelectorLocationMetadata, string, 'dataResourceSelector'> & GetDataResourceLocation & GetEditorStateLocationMaybe;
1646
1625
 
1647
1626
  type DataSourceLocationValue = Pick<DataSource, 'baseUrl' | 'custom' | 'customPublic' | 'headers' | 'parameters' | 'variables' | 'enableUnpublishedMode' | 'variants'>;
1648
1627
  type DataSourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
@@ -1654,20 +1633,14 @@ type DataSourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonMet
1654
1633
  }, TIntegrationConfiguration>;
1655
1634
  type DataSourceLocation = MeshLocationCore<DataSourceLocationValue, DataSourceLocationMetadata, DataSourceLocationValue, 'dataSource'>;
1656
1635
 
1657
- type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfiguration = unknown> = CommonMetadata<{
1636
+ type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfiguration = unknown> = CommonMetadata<CanvasEditorContextMetadata & {
1658
1637
  /** editorState is an experimental replacement for rootNode. This may become deprecated in the future. */
1659
1638
  rootNode: Omit<RootComponentInstance, 'slots' | '_data'> & {
1660
1639
  _editionId?: string;
1661
1640
  };
1662
1641
  parameterConfiguration: TParamConfiguration;
1663
1642
  component: Omit<ComponentInstance, 'slots'>;
1664
- componentDefinitions: Record<string, ComponentDefinition | undefined>;
1665
1643
  parameterDefinition: ComponentDefinitionParameter;
1666
- /**
1667
- * Current dynamic inputs that are configured on the composition (if any).
1668
- * Use the <ParamTypeDynamicDataProvider> to wire up dynamic data in your parameter.
1669
- */
1670
- dynamicInputs: DynamicInputs;
1671
1644
  /**
1672
1645
  * The connected data for the current component. Connected data is provided as a map
1673
1646
  * of the binding expression text to the value of that binding expression. For example,
@@ -1684,11 +1657,6 @@ type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfig
1684
1657
  * Note that setValue() always sets the target language automatically.
1685
1658
  */
1686
1659
  targetLocale: string | undefined;
1687
- /**
1688
- * The current locale selected in the editor UI.
1689
- * Unlike targetLocale, this reflects the editor's global locale state.
1690
- */
1691
- currentLocale: string | undefined;
1692
1660
  /**
1693
1661
  * When editing a conditional value, this is the index in the parent parameter of the conditional value.
1694
1662
  * If this is -1, then the editor is not editing a conditional value.
@@ -1701,13 +1669,7 @@ type ParamTypeLocation<TParamValue = unknown, TParamConfiguration = unknown, TPa
1701
1669
  * Returns the result of the dialog. Useful to build data-enabled parameter types.
1702
1670
  */
1703
1671
  editConnectedData: Awaited<ReturnType<typeof connectToParent>>['parent']['editConnectedData'];
1704
- /**
1705
- * Imperative API for interacting with the composition/entry editor state.
1706
- * Provides non-reactive access to read and modify the editor state.
1707
- * @deprecated This is experimental functionality and is subject to change without notice.
1708
- */
1709
- editorState: EditorStateApi;
1710
- };
1672
+ } & GetEditorStateLocation;
1711
1673
 
1712
1674
  type SettingsLocationMetadata = CommonMetadata;
1713
1675
  type SettingsLocation<TSettingsType> = MeshLocationCore<TSettingsType, SettingsLocationMetadata, TSettingsType, 'settings'>;
@@ -1983,6 +1945,28 @@ type CommonMetadata<ExtendedMetadata = unknown, TIntegrationConfiguration = unkn
1983
1945
  /** List if enabled Uniform Project locales */
1984
1946
  locales: Locale[];
1985
1947
  } & ExtendedMetadata;
1948
+ /**
1949
+ * Serializable metadata fields available in Canvas/Entry editor context.
1950
+ * {@link EditorStateApi} is not part of metadata; it is provided on the location object via mesh-sdk comms.
1951
+ */
1952
+ type CanvasEditorContextMetadata = {
1953
+ /** Component definitions index, keyed by public id. */
1954
+ componentDefinitions: Record<string, ComponentDefinition | undefined>;
1955
+ /** Current dynamic inputs configured on the composition (if any). */
1956
+ dynamicInputs: DynamicInputs;
1957
+ /** The current locale selected in the editor UI */
1958
+ currentLocale: string | undefined;
1959
+ /**
1960
+ * The release ID of the currently edited entity.
1961
+ * Can be undefined when a release is active but the entity has not been copied to that release yet.
1962
+ */
1963
+ releaseId?: string;
1964
+ /**
1965
+ * The currently active release ID from editor context.
1966
+ * This reflects release selection regardless of whether the edited entity exists in that release.
1967
+ */
1968
+ activeReleaseId?: string;
1969
+ };
1986
1970
  type MeshLocationUserPermissions =
1987
1971
  /** Uniform Context:Enrichments:Create */
1988
1972
  'ENRICHMENTS_CREATE'
@@ -2085,6 +2069,25 @@ type SetValueMessage = {
2085
2069
  type GetDataResourceLocation = {
2086
2070
  getDataResource: Awaited<ReturnType<typeof connectToParent>>['parent']['getDataResource'];
2087
2071
  };
2072
+ type GetEditorStateLocation = {
2073
+ /**
2074
+ * Imperative API for interacting with the composition/entry editor state.
2075
+ * Provides non-reactive access to read and modify the editor state.
2076
+ * @deprecated This is experimental functionality and is subject to change without notice.
2077
+ */
2078
+ editorState: EditorStateApi;
2079
+ };
2080
+ type GetEditorStateLocationMaybe = {
2081
+ /**
2082
+ * Imperative API for interacting with the composition/entry editor state.
2083
+ * Provides non-reactive access to read and modify the editor state.
2084
+ *
2085
+ * "undefined" means that the location is rendered outside of Canvas Editor context, e.g. Data Type testing.
2086
+ *
2087
+ * @deprecated This is experimental functionality and is subject to change without notice.
2088
+ */
2089
+ editorState: EditorStateApi | undefined;
2090
+ };
2088
2091
  /**
2089
2092
  * Dynamic inputs come from project map and represent path or query based dynamic values
2090
2093
  * These can be connected to from within a Mesh location by setting a data resource variable to contain ex:
@@ -2248,7 +2251,7 @@ type UpdateRootNodeOptions = {
2248
2251
  };
2249
2252
  /**
2250
2253
  * Imperative API for interacting with the composition/entry editor state.
2251
- * Available on `canvasEditorTools` and `paramType` locations.
2254
+ * Available on `canvasEditorTools`, `paramType`, `dataResource`, and `dataResourceSelector` locations.
2252
2255
  *
2253
2256
  * All methods use object parameters for consistency across client, wire format, and server.
2254
2257
  */
@@ -2370,27 +2373,8 @@ type PromptSettingsLocationMetadata<TIntegrationConfiguration = unknown> = Commo
2370
2373
  type AIGenerateLocation<TType> = MeshLocationCore<TType, AIGenerateLocationMetadata, TType, 'aiGenerate'>;
2371
2374
  type AIPromptMetadataLocation = MeshLocationCore<Record<string, unknown>, PromptSettingsLocationMetadata, Record<string, unknown>, 'aiMetadata'>;
2372
2375
 
2373
- type CanvasEditorToolsLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
2374
- /**
2375
- * The release ID of the currently edited entity.
2376
- * This can be undefined when a release is active but the entity has not been copied to that release yet.
2377
- */
2378
- releaseId?: string;
2379
- /**
2380
- * The currently active release ID from editor context.
2381
- * This reflects release selection regardless of whether the edited entity exists in that release.
2382
- */
2383
- activeReleaseId?: string;
2376
+ type CanvasEditorToolsLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<CanvasEditorContextMetadata & {
2384
2377
  state?: number;
2385
- /** The current locale selected in the editor UI */
2386
- currentLocale: string | undefined;
2387
- /**
2388
- * Current dynamic inputs configured on the composition (if any).
2389
- * Dynamic inputs come from project map nodes and represent path or query based dynamic values.
2390
- */
2391
- dynamicInputs: DynamicInputs;
2392
- /** Component definitions index, keyed by public id. */
2393
- componentDefinitions: Record<string, ComponentDefinition | undefined>;
2394
2378
  }, TIntegrationConfiguration>;
2395
2379
  type CanvasEditorToolsReferenceData = {
2396
2380
  name: string;
@@ -2409,14 +2393,7 @@ type CanvasEditorToolsData = {
2409
2393
  rootEntity: EntryData;
2410
2394
  entityType: 'entry' | 'entryPattern';
2411
2395
  });
2412
- type CanvasEditorToolsLocation = MeshLocationCore<CanvasEditorToolsData, CanvasEditorToolsLocationMetadata, CanvasEditorToolsData, 'canvasEditorTools'> & GetDataResourceLocation & {
2413
- /**
2414
- * Imperative API for interacting with the composition/entry editor state.
2415
- * Provides non-reactive access to read and modify the editor state.
2416
- * @deprecated This is experimental functionality and is subject to change without notice.
2417
- */
2418
- editorState: EditorStateApi;
2419
- };
2396
+ type CanvasEditorToolsLocation = MeshLocationCore<CanvasEditorToolsData, CanvasEditorToolsLocationMetadata, CanvasEditorToolsData, 'canvasEditorTools'> & GetDataResourceLocation & GetEditorStateLocation;
2420
2397
 
2421
2398
  /**
2422
2399
  * @deprecated Alpha version of the Embedded Editor location. This location is not yet available for use in the Mesh SDK.
@@ -2584,4 +2561,4 @@ declare const hasPermissions: (permissions: MeshLocationUserPermissions | MeshLo
2584
2561
  */
2585
2562
  declare const hasRole: (role: string, user: UniformUser) => boolean;
2586
2563
 
2587
- 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 };
2564
+ export { type AIGenerateLocation, type AIGenerateLocationMetadata, type AIPromptMetadataLocation, type AssetLibraryLocation, type AssetLibraryLocationMetadata, type AssetParameterLocation, type AssetParameterLocationMetadata, type BindableTypes, type CSSHeight, type CanvasEditorContextMetadata, 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 GetEditorStateLocation, type GetEditorStateLocationMaybe, 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 };
package/dist/index.esm.js CHANGED
@@ -131,7 +131,7 @@ var getLogger = (prefix, debug) => {
131
131
  };
132
132
 
133
133
  // src/temp/version.ts
134
- var UNIFORM_MESH_SDK_VERSION = "20.66.4";
134
+ var UNIFORM_MESH_SDK_VERSION = "20.66.5";
135
135
 
136
136
  // src/framepost/constants.ts
137
137
  var DEFAULT_REQUEST_TIMEOUT = 5e3;
package/dist/index.js CHANGED
@@ -172,7 +172,7 @@ var getLogger = (prefix, debug) => {
172
172
  };
173
173
 
174
174
  // src/temp/version.ts
175
- var UNIFORM_MESH_SDK_VERSION = "20.66.4";
175
+ var UNIFORM_MESH_SDK_VERSION = "20.66.5";
176
176
 
177
177
  // src/framepost/constants.ts
178
178
  var DEFAULT_REQUEST_TIMEOUT = 5e3;
package/dist/index.mjs CHANGED
@@ -131,7 +131,7 @@ var getLogger = (prefix, debug) => {
131
131
  };
132
132
 
133
133
  // src/temp/version.ts
134
- var UNIFORM_MESH_SDK_VERSION = "20.66.4";
134
+ var UNIFORM_MESH_SDK_VERSION = "20.66.5";
135
135
 
136
136
  // src/framepost/constants.ts
137
137
  var DEFAULT_REQUEST_TIMEOUT = 5e3;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uniformdev/mesh-sdk",
3
- "version": "20.66.5-alpha.2+f702224f0d",
3
+ "version": "20.66.6-alpha.13+fe28111153",
4
4
  "description": "Uniform Mesh Framework SDK",
5
5
  "license": "SEE LICENSE IN LICENSE.txt",
6
6
  "main": "./dist/index.js",
@@ -32,10 +32,10 @@
32
32
  "access": "public"
33
33
  },
34
34
  "dependencies": {
35
- "@uniformdev/assets": "20.66.5-alpha.2+f702224f0d",
36
- "@uniformdev/canvas": "20.66.5-alpha.2+f702224f0d",
37
- "@uniformdev/context": "20.66.5-alpha.2+f702224f0d",
38
- "@uniformdev/project-map": "20.66.5-alpha.2+f702224f0d",
35
+ "@uniformdev/assets": "20.66.6-alpha.13+fe28111153",
36
+ "@uniformdev/canvas": "20.66.6-alpha.13+fe28111153",
37
+ "@uniformdev/context": "20.66.6-alpha.13+fe28111153",
38
+ "@uniformdev/project-map": "20.66.6-alpha.13+fe28111153",
39
39
  "imagesloaded": "^5.0.0",
40
40
  "mitt": "^3.0.1"
41
41
  },
@@ -43,5 +43,5 @@
43
43
  "@types/imagesloaded": "^4.1.2",
44
44
  "openai": "4.94.0"
45
45
  },
46
- "gitHead": "f702224f0d6ddf8a533aae5eeb4045419cc28cdb"
46
+ "gitHead": "fe28111153c9c1db9a7025cc18512fc4239c2b5c"
47
47
  }