@uniformdev/mesh-sdk 20.66.6-alpha.13 → 20.66.7-alpha.0
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 +75 -52
- package/dist/index.d.ts +75 -52
- package/dist/index.esm.js +1 -1
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +6 -6
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, RootComponentInstance, ComponentInstance, ComponentDefinitionParameter, DataVariableDefinition, Locale,
|
|
2
|
+
import { AssetParamValue, DataType, DataSource, DataResourceVariables, DataSourceVariantsKeys, ComponentDefinition, RootComponentInstance, ComponentInstance, ComponentDefinitionParameter, DataVariableDefinition, Locale, 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,7 +1578,17 @@ 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<
|
|
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;
|
|
1582
1592
|
dataType: DataType;
|
|
1583
1593
|
/** The data type's archetype value. */
|
|
1584
1594
|
archetype: string;
|
|
@@ -1588,10 +1598,12 @@ type DataResourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonM
|
|
|
1588
1598
|
dataSource: DataSource;
|
|
1589
1599
|
/** The data connector type of the current data resource's data source */
|
|
1590
1600
|
dataConnector: DataConnectorInfo;
|
|
1601
|
+
/** Current dynamic inputs that are configured on the composition (if any). */
|
|
1602
|
+
dynamicInputs: DynamicInputs;
|
|
1591
1603
|
/** Which Data Source variant is being resolved and used for getDataResource (unless overriden explicitly via providing "undefined") */
|
|
1592
1604
|
dataSourceVariant?: DataSourceVariantsKeys;
|
|
1593
1605
|
}, TIntegrationConfiguration>;
|
|
1594
|
-
type DataResourceLocation = MeshLocationCore<DataResourceVariables, DataResourceLocationMetadata, DataResourceVariables, 'dataResource'> & GetDataResourceLocation
|
|
1606
|
+
type DataResourceLocation = MeshLocationCore<DataResourceVariables, DataResourceLocationMetadata, DataResourceVariables, 'dataResource'> & GetDataResourceLocation;
|
|
1595
1607
|
|
|
1596
1608
|
/**
|
|
1597
1609
|
* Metadata for the dataResourceSelector location.
|
|
@@ -1599,7 +1611,7 @@ type DataResourceLocation = MeshLocationCore<DataResourceVariables, DataResource
|
|
|
1599
1611
|
* replacing the default JSON tree viewer in the dynamic token picker.
|
|
1600
1612
|
* @deprecated This is experimental functionality and is subject to change without notice.
|
|
1601
1613
|
*/
|
|
1602
|
-
type DataResourceSelectorLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<
|
|
1614
|
+
type DataResourceSelectorLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
|
|
1603
1615
|
/** The resolved data for the currently selected data resource */
|
|
1604
1616
|
dataResourceValue: unknown;
|
|
1605
1617
|
/** The name of the currently selected data resource */
|
|
@@ -1610,6 +1622,8 @@ type DataResourceSelectorLocationMetadata<TIntegrationConfiguration = unknown> =
|
|
|
1610
1622
|
archetype: string;
|
|
1611
1623
|
/** Allowed bindable types for the parameter being connected */
|
|
1612
1624
|
allowedTypes: BindableTypes[];
|
|
1625
|
+
/** Component definitions index, keyed by public id. */
|
|
1626
|
+
componentDefinitions: Record<string, ComponentDefinition | undefined>;
|
|
1613
1627
|
}, TIntegrationConfiguration>;
|
|
1614
1628
|
/**
|
|
1615
1629
|
* Location for custom data resource selector UI.
|
|
@@ -1621,7 +1635,14 @@ type DataResourceSelectorLocationMetadata<TIntegrationConfiguration = unknown> =
|
|
|
1621
1635
|
* editorState: Imperative API for inspecting/mutating the underlying composition / entry tree
|
|
1622
1636
|
* @deprecated This is experimental functionality and is subject to change without notice.
|
|
1623
1637
|
*/
|
|
1624
|
-
type DataResourceSelectorLocation = MeshLocationCore<string, DataResourceSelectorLocationMetadata, string, 'dataResourceSelector'> & GetDataResourceLocation &
|
|
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
|
+
};
|
|
1625
1646
|
|
|
1626
1647
|
type DataSourceLocationValue = Pick<DataSource, 'baseUrl' | 'custom' | 'customPublic' | 'headers' | 'parameters' | 'variables' | 'enableUnpublishedMode' | 'variants'>;
|
|
1627
1648
|
type DataSourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
|
|
@@ -1633,14 +1654,20 @@ type DataSourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonMet
|
|
|
1633
1654
|
}, TIntegrationConfiguration>;
|
|
1634
1655
|
type DataSourceLocation = MeshLocationCore<DataSourceLocationValue, DataSourceLocationMetadata, DataSourceLocationValue, 'dataSource'>;
|
|
1635
1656
|
|
|
1636
|
-
type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfiguration = unknown> = CommonMetadata<
|
|
1657
|
+
type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfiguration = unknown> = CommonMetadata<{
|
|
1637
1658
|
/** editorState is an experimental replacement for rootNode. This may become deprecated in the future. */
|
|
1638
1659
|
rootNode: Omit<RootComponentInstance, 'slots' | '_data'> & {
|
|
1639
1660
|
_editionId?: string;
|
|
1640
1661
|
};
|
|
1641
1662
|
parameterConfiguration: TParamConfiguration;
|
|
1642
1663
|
component: Omit<ComponentInstance, 'slots'>;
|
|
1664
|
+
componentDefinitions: Record<string, ComponentDefinition | undefined>;
|
|
1643
1665
|
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;
|
|
1644
1671
|
/**
|
|
1645
1672
|
* The connected data for the current component. Connected data is provided as a map
|
|
1646
1673
|
* of the binding expression text to the value of that binding expression. For example,
|
|
@@ -1657,6 +1684,11 @@ type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfig
|
|
|
1657
1684
|
* Note that setValue() always sets the target language automatically.
|
|
1658
1685
|
*/
|
|
1659
1686
|
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;
|
|
1660
1692
|
/**
|
|
1661
1693
|
* When editing a conditional value, this is the index in the parent parameter of the conditional value.
|
|
1662
1694
|
* If this is -1, then the editor is not editing a conditional value.
|
|
@@ -1669,7 +1701,13 @@ type ParamTypeLocation<TParamValue = unknown, TParamConfiguration = unknown, TPa
|
|
|
1669
1701
|
* Returns the result of the dialog. Useful to build data-enabled parameter types.
|
|
1670
1702
|
*/
|
|
1671
1703
|
editConnectedData: Awaited<ReturnType<typeof connectToParent>>['parent']['editConnectedData'];
|
|
1672
|
-
|
|
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
|
+
};
|
|
1673
1711
|
|
|
1674
1712
|
type SettingsLocationMetadata = CommonMetadata;
|
|
1675
1713
|
type SettingsLocation<TSettingsType> = MeshLocationCore<TSettingsType, SettingsLocationMetadata, TSettingsType, 'settings'>;
|
|
@@ -1945,28 +1983,6 @@ type CommonMetadata<ExtendedMetadata = unknown, TIntegrationConfiguration = unkn
|
|
|
1945
1983
|
/** List if enabled Uniform Project locales */
|
|
1946
1984
|
locales: Locale[];
|
|
1947
1985
|
} & 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
|
-
};
|
|
1970
1986
|
type MeshLocationUserPermissions =
|
|
1971
1987
|
/** Uniform Context:Enrichments:Create */
|
|
1972
1988
|
'ENRICHMENTS_CREATE'
|
|
@@ -2069,25 +2085,6 @@ type SetValueMessage = {
|
|
|
2069
2085
|
type GetDataResourceLocation = {
|
|
2070
2086
|
getDataResource: Awaited<ReturnType<typeof connectToParent>>['parent']['getDataResource'];
|
|
2071
2087
|
};
|
|
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
|
-
};
|
|
2091
2088
|
/**
|
|
2092
2089
|
* Dynamic inputs come from project map and represent path or query based dynamic values
|
|
2093
2090
|
* These can be connected to from within a Mesh location by setting a data resource variable to contain ex:
|
|
@@ -2251,7 +2248,7 @@ type UpdateRootNodeOptions = {
|
|
|
2251
2248
|
};
|
|
2252
2249
|
/**
|
|
2253
2250
|
* Imperative API for interacting with the composition/entry editor state.
|
|
2254
|
-
* Available on `canvasEditorTools
|
|
2251
|
+
* Available on `canvasEditorTools` and `paramType` locations.
|
|
2255
2252
|
*
|
|
2256
2253
|
* All methods use object parameters for consistency across client, wire format, and server.
|
|
2257
2254
|
*/
|
|
@@ -2373,8 +2370,27 @@ type PromptSettingsLocationMetadata<TIntegrationConfiguration = unknown> = Commo
|
|
|
2373
2370
|
type AIGenerateLocation<TType> = MeshLocationCore<TType, AIGenerateLocationMetadata, TType, 'aiGenerate'>;
|
|
2374
2371
|
type AIPromptMetadataLocation = MeshLocationCore<Record<string, unknown>, PromptSettingsLocationMetadata, Record<string, unknown>, 'aiMetadata'>;
|
|
2375
2372
|
|
|
2376
|
-
type CanvasEditorToolsLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<
|
|
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;
|
|
2377
2384
|
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>;
|
|
2378
2394
|
}, TIntegrationConfiguration>;
|
|
2379
2395
|
type CanvasEditorToolsReferenceData = {
|
|
2380
2396
|
name: string;
|
|
@@ -2393,7 +2409,14 @@ type CanvasEditorToolsData = {
|
|
|
2393
2409
|
rootEntity: EntryData;
|
|
2394
2410
|
entityType: 'entry' | 'entryPattern';
|
|
2395
2411
|
});
|
|
2396
|
-
type CanvasEditorToolsLocation = MeshLocationCore<CanvasEditorToolsData, CanvasEditorToolsLocationMetadata, CanvasEditorToolsData, 'canvasEditorTools'> & GetDataResourceLocation &
|
|
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
|
+
};
|
|
2397
2420
|
|
|
2398
2421
|
/**
|
|
2399
2422
|
* @deprecated Alpha version of the Embedded Editor location. This location is not yet available for use in the Mesh SDK.
|
|
@@ -2561,4 +2584,4 @@ declare const hasPermissions: (permissions: MeshLocationUserPermissions | MeshLo
|
|
|
2561
2584
|
*/
|
|
2562
2585
|
declare const hasRole: (role: string, user: UniformUser) => boolean;
|
|
2563
2586
|
|
|
2564
|
-
export { type AIGenerateLocation, type AIGenerateLocationMetadata, type AIPromptMetadataLocation, type AssetLibraryLocation, type AssetLibraryLocationMetadata, type AssetParameterLocation, type AssetParameterLocationMetadata, type BindableTypes, type CSSHeight, type
|
|
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 };
|
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, RootComponentInstance, ComponentInstance, ComponentDefinitionParameter, DataVariableDefinition, Locale,
|
|
2
|
+
import { AssetParamValue, DataType, DataSource, DataResourceVariables, DataSourceVariantsKeys, ComponentDefinition, RootComponentInstance, ComponentInstance, ComponentDefinitionParameter, DataVariableDefinition, Locale, 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,7 +1578,17 @@ 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<
|
|
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;
|
|
1582
1592
|
dataType: DataType;
|
|
1583
1593
|
/** The data type's archetype value. */
|
|
1584
1594
|
archetype: string;
|
|
@@ -1588,10 +1598,12 @@ type DataResourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonM
|
|
|
1588
1598
|
dataSource: DataSource;
|
|
1589
1599
|
/** The data connector type of the current data resource's data source */
|
|
1590
1600
|
dataConnector: DataConnectorInfo;
|
|
1601
|
+
/** Current dynamic inputs that are configured on the composition (if any). */
|
|
1602
|
+
dynamicInputs: DynamicInputs;
|
|
1591
1603
|
/** Which Data Source variant is being resolved and used for getDataResource (unless overriden explicitly via providing "undefined") */
|
|
1592
1604
|
dataSourceVariant?: DataSourceVariantsKeys;
|
|
1593
1605
|
}, TIntegrationConfiguration>;
|
|
1594
|
-
type DataResourceLocation = MeshLocationCore<DataResourceVariables, DataResourceLocationMetadata, DataResourceVariables, 'dataResource'> & GetDataResourceLocation
|
|
1606
|
+
type DataResourceLocation = MeshLocationCore<DataResourceVariables, DataResourceLocationMetadata, DataResourceVariables, 'dataResource'> & GetDataResourceLocation;
|
|
1595
1607
|
|
|
1596
1608
|
/**
|
|
1597
1609
|
* Metadata for the dataResourceSelector location.
|
|
@@ -1599,7 +1611,7 @@ type DataResourceLocation = MeshLocationCore<DataResourceVariables, DataResource
|
|
|
1599
1611
|
* replacing the default JSON tree viewer in the dynamic token picker.
|
|
1600
1612
|
* @deprecated This is experimental functionality and is subject to change without notice.
|
|
1601
1613
|
*/
|
|
1602
|
-
type DataResourceSelectorLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<
|
|
1614
|
+
type DataResourceSelectorLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
|
|
1603
1615
|
/** The resolved data for the currently selected data resource */
|
|
1604
1616
|
dataResourceValue: unknown;
|
|
1605
1617
|
/** The name of the currently selected data resource */
|
|
@@ -1610,6 +1622,8 @@ type DataResourceSelectorLocationMetadata<TIntegrationConfiguration = unknown> =
|
|
|
1610
1622
|
archetype: string;
|
|
1611
1623
|
/** Allowed bindable types for the parameter being connected */
|
|
1612
1624
|
allowedTypes: BindableTypes[];
|
|
1625
|
+
/** Component definitions index, keyed by public id. */
|
|
1626
|
+
componentDefinitions: Record<string, ComponentDefinition | undefined>;
|
|
1613
1627
|
}, TIntegrationConfiguration>;
|
|
1614
1628
|
/**
|
|
1615
1629
|
* Location for custom data resource selector UI.
|
|
@@ -1621,7 +1635,14 @@ type DataResourceSelectorLocationMetadata<TIntegrationConfiguration = unknown> =
|
|
|
1621
1635
|
* editorState: Imperative API for inspecting/mutating the underlying composition / entry tree
|
|
1622
1636
|
* @deprecated This is experimental functionality and is subject to change without notice.
|
|
1623
1637
|
*/
|
|
1624
|
-
type DataResourceSelectorLocation = MeshLocationCore<string, DataResourceSelectorLocationMetadata, string, 'dataResourceSelector'> & GetDataResourceLocation &
|
|
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
|
+
};
|
|
1625
1646
|
|
|
1626
1647
|
type DataSourceLocationValue = Pick<DataSource, 'baseUrl' | 'custom' | 'customPublic' | 'headers' | 'parameters' | 'variables' | 'enableUnpublishedMode' | 'variants'>;
|
|
1627
1648
|
type DataSourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
|
|
@@ -1633,14 +1654,20 @@ type DataSourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonMet
|
|
|
1633
1654
|
}, TIntegrationConfiguration>;
|
|
1634
1655
|
type DataSourceLocation = MeshLocationCore<DataSourceLocationValue, DataSourceLocationMetadata, DataSourceLocationValue, 'dataSource'>;
|
|
1635
1656
|
|
|
1636
|
-
type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfiguration = unknown> = CommonMetadata<
|
|
1657
|
+
type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfiguration = unknown> = CommonMetadata<{
|
|
1637
1658
|
/** editorState is an experimental replacement for rootNode. This may become deprecated in the future. */
|
|
1638
1659
|
rootNode: Omit<RootComponentInstance, 'slots' | '_data'> & {
|
|
1639
1660
|
_editionId?: string;
|
|
1640
1661
|
};
|
|
1641
1662
|
parameterConfiguration: TParamConfiguration;
|
|
1642
1663
|
component: Omit<ComponentInstance, 'slots'>;
|
|
1664
|
+
componentDefinitions: Record<string, ComponentDefinition | undefined>;
|
|
1643
1665
|
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;
|
|
1644
1671
|
/**
|
|
1645
1672
|
* The connected data for the current component. Connected data is provided as a map
|
|
1646
1673
|
* of the binding expression text to the value of that binding expression. For example,
|
|
@@ -1657,6 +1684,11 @@ type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfig
|
|
|
1657
1684
|
* Note that setValue() always sets the target language automatically.
|
|
1658
1685
|
*/
|
|
1659
1686
|
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;
|
|
1660
1692
|
/**
|
|
1661
1693
|
* When editing a conditional value, this is the index in the parent parameter of the conditional value.
|
|
1662
1694
|
* If this is -1, then the editor is not editing a conditional value.
|
|
@@ -1669,7 +1701,13 @@ type ParamTypeLocation<TParamValue = unknown, TParamConfiguration = unknown, TPa
|
|
|
1669
1701
|
* Returns the result of the dialog. Useful to build data-enabled parameter types.
|
|
1670
1702
|
*/
|
|
1671
1703
|
editConnectedData: Awaited<ReturnType<typeof connectToParent>>['parent']['editConnectedData'];
|
|
1672
|
-
|
|
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
|
+
};
|
|
1673
1711
|
|
|
1674
1712
|
type SettingsLocationMetadata = CommonMetadata;
|
|
1675
1713
|
type SettingsLocation<TSettingsType> = MeshLocationCore<TSettingsType, SettingsLocationMetadata, TSettingsType, 'settings'>;
|
|
@@ -1945,28 +1983,6 @@ type CommonMetadata<ExtendedMetadata = unknown, TIntegrationConfiguration = unkn
|
|
|
1945
1983
|
/** List if enabled Uniform Project locales */
|
|
1946
1984
|
locales: Locale[];
|
|
1947
1985
|
} & 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
|
-
};
|
|
1970
1986
|
type MeshLocationUserPermissions =
|
|
1971
1987
|
/** Uniform Context:Enrichments:Create */
|
|
1972
1988
|
'ENRICHMENTS_CREATE'
|
|
@@ -2069,25 +2085,6 @@ type SetValueMessage = {
|
|
|
2069
2085
|
type GetDataResourceLocation = {
|
|
2070
2086
|
getDataResource: Awaited<ReturnType<typeof connectToParent>>['parent']['getDataResource'];
|
|
2071
2087
|
};
|
|
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
|
-
};
|
|
2091
2088
|
/**
|
|
2092
2089
|
* Dynamic inputs come from project map and represent path or query based dynamic values
|
|
2093
2090
|
* These can be connected to from within a Mesh location by setting a data resource variable to contain ex:
|
|
@@ -2251,7 +2248,7 @@ type UpdateRootNodeOptions = {
|
|
|
2251
2248
|
};
|
|
2252
2249
|
/**
|
|
2253
2250
|
* Imperative API for interacting with the composition/entry editor state.
|
|
2254
|
-
* Available on `canvasEditorTools
|
|
2251
|
+
* Available on `canvasEditorTools` and `paramType` locations.
|
|
2255
2252
|
*
|
|
2256
2253
|
* All methods use object parameters for consistency across client, wire format, and server.
|
|
2257
2254
|
*/
|
|
@@ -2373,8 +2370,27 @@ type PromptSettingsLocationMetadata<TIntegrationConfiguration = unknown> = Commo
|
|
|
2373
2370
|
type AIGenerateLocation<TType> = MeshLocationCore<TType, AIGenerateLocationMetadata, TType, 'aiGenerate'>;
|
|
2374
2371
|
type AIPromptMetadataLocation = MeshLocationCore<Record<string, unknown>, PromptSettingsLocationMetadata, Record<string, unknown>, 'aiMetadata'>;
|
|
2375
2372
|
|
|
2376
|
-
type CanvasEditorToolsLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<
|
|
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;
|
|
2377
2384
|
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>;
|
|
2378
2394
|
}, TIntegrationConfiguration>;
|
|
2379
2395
|
type CanvasEditorToolsReferenceData = {
|
|
2380
2396
|
name: string;
|
|
@@ -2393,7 +2409,14 @@ type CanvasEditorToolsData = {
|
|
|
2393
2409
|
rootEntity: EntryData;
|
|
2394
2410
|
entityType: 'entry' | 'entryPattern';
|
|
2395
2411
|
});
|
|
2396
|
-
type CanvasEditorToolsLocation = MeshLocationCore<CanvasEditorToolsData, CanvasEditorToolsLocationMetadata, CanvasEditorToolsData, 'canvasEditorTools'> & GetDataResourceLocation &
|
|
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
|
+
};
|
|
2397
2420
|
|
|
2398
2421
|
/**
|
|
2399
2422
|
* @deprecated Alpha version of the Embedded Editor location. This location is not yet available for use in the Mesh SDK.
|
|
@@ -2561,4 +2584,4 @@ declare const hasPermissions: (permissions: MeshLocationUserPermissions | MeshLo
|
|
|
2561
2584
|
*/
|
|
2562
2585
|
declare const hasRole: (role: string, user: UniformUser) => boolean;
|
|
2563
2586
|
|
|
2564
|
-
export { type AIGenerateLocation, type AIGenerateLocationMetadata, type AIPromptMetadataLocation, type AssetLibraryLocation, type AssetLibraryLocationMetadata, type AssetParameterLocation, type AssetParameterLocationMetadata, type BindableTypes, type CSSHeight, type
|
|
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 };
|
package/dist/index.esm.js
CHANGED
package/dist/index.js
CHANGED
package/dist/index.mjs
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@uniformdev/mesh-sdk",
|
|
3
|
-
"version": "20.66.
|
|
3
|
+
"version": "20.66.7-alpha.0+51401eab0f",
|
|
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.
|
|
36
|
-
"@uniformdev/canvas": "20.66.
|
|
37
|
-
"@uniformdev/context": "20.66.
|
|
38
|
-
"@uniformdev/project-map": "20.66.
|
|
35
|
+
"@uniformdev/assets": "20.66.7-alpha.0+51401eab0f",
|
|
36
|
+
"@uniformdev/canvas": "20.66.7-alpha.0+51401eab0f",
|
|
37
|
+
"@uniformdev/context": "20.66.7-alpha.0+51401eab0f",
|
|
38
|
+
"@uniformdev/project-map": "20.66.7-alpha.0+51401eab0f",
|
|
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": "
|
|
46
|
+
"gitHead": "51401eab0fae8080724e81781e406f8c1ecba8cf"
|
|
47
47
|
}
|