@uniformdev/mesh-sdk 20.50.2-alpha.149 → 20.50.2-alpha.180
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 +76 -148
- package/dist/index.d.ts +76 -148
- package/dist/index.esm.js +7 -105
- package/dist/index.js +13 -110
- package/dist/index.mjs +7 -105
- package/dist/server/index.d.mts +386 -0
- package/dist/server/index.mjs +354 -0
- package/package.json +33 -12
package/dist/index.d.mts
CHANGED
|
@@ -1,73 +1,10 @@
|
|
|
1
1
|
import { ApiClient, ClientOptions, ExceptProject } from '@uniformdev/context/api';
|
|
2
|
-
import { AssetParamValue, DataType, DataSource, DataResourceVariables, DataSourceVariantsKeys,
|
|
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';
|
|
6
6
|
import { Emitter } from 'mitt';
|
|
7
7
|
|
|
8
|
-
/** @deprecated This beta identity delegation API may change with breaking changes. */
|
|
9
|
-
interface DelegationTokenClientOptions {
|
|
10
|
-
/** Uniform API host (e.g. 'https://uniform.app'). */
|
|
11
|
-
apiHost: string;
|
|
12
|
-
/** UUID of the integration definition. */
|
|
13
|
-
integrationId: string;
|
|
14
|
-
/** Plaintext app secret for this integration. */
|
|
15
|
-
integrationSecret: string;
|
|
16
|
-
}
|
|
17
|
-
/** @deprecated This beta identity delegation API may change with breaking changes. */
|
|
18
|
-
interface DelegationTokenResponse {
|
|
19
|
-
/** Bearer access token that can be used to call Uniform APIs on behalf of the user. */
|
|
20
|
-
accessToken: string;
|
|
21
|
-
/** Refresh token for obtaining a new access token when the current one expires. Absent when the session was minted with `allowRefresh: false`. */
|
|
22
|
-
refreshToken?: string;
|
|
23
|
-
/** Always 'Bearer'. */
|
|
24
|
-
tokenType: 'Bearer';
|
|
25
|
-
/** Token lifetime in seconds. */
|
|
26
|
-
expiresIn: number;
|
|
27
|
-
}
|
|
28
|
-
/**
|
|
29
|
-
* Stable, low-detail kinds of token-exchange failures. Callers branch on these
|
|
30
|
-
* instead of parsing arbitrary upstream message text, and integrators surface a
|
|
31
|
-
* sanitised public message rather than whatever the server happened to return.
|
|
32
|
-
*/
|
|
33
|
-
type DelegationTokenErrorKind = 'bad_request' | 'unauthenticated' | 'forbidden' | 'not_found' | 'rate_limited' | 'server_error' | 'unknown';
|
|
34
|
-
/** @deprecated This beta identity delegation API may change with breaking changes. */
|
|
35
|
-
declare class DelegationTokenError extends Error {
|
|
36
|
-
readonly status: number;
|
|
37
|
-
readonly kind: DelegationTokenErrorKind;
|
|
38
|
-
constructor(status: number, kind: DelegationTokenErrorKind, publicMessage: string);
|
|
39
|
-
}
|
|
40
|
-
/**
|
|
41
|
-
* Server-side client for the Uniform token exchange endpoint.
|
|
42
|
-
* Use this in your integration's backend to exchange a session token (obtained from the
|
|
43
|
-
* Mesh SDK iframe context) for a delegation token, or to refresh an existing delegation token.
|
|
44
|
-
*
|
|
45
|
-
* @deprecated This beta identity delegation API may change with breaking changes.
|
|
46
|
-
*/
|
|
47
|
-
declare class DelegationTokenClient {
|
|
48
|
-
#private;
|
|
49
|
-
constructor(options: DelegationTokenClientOptions);
|
|
50
|
-
/**
|
|
51
|
-
* Exchanges a short-lived session token for a delegation token and refresh token.
|
|
52
|
-
* The session token is obtained by the integration's frontend via `sdk.getSessionToken()`.
|
|
53
|
-
*
|
|
54
|
-
* @deprecated This beta identity delegation API may change with breaking changes.
|
|
55
|
-
*/
|
|
56
|
-
exchangeSessionToken(sessionToken: string): Promise<DelegationTokenResponse>;
|
|
57
|
-
/**
|
|
58
|
-
* Exchanges a refresh token for a new delegation token and a new refresh token.
|
|
59
|
-
*
|
|
60
|
-
* Replay posture: refresh tokens are bearer credentials that are valid until
|
|
61
|
-
* their server-side expiry. They are NOT single-use — a captured refresh token can be
|
|
62
|
-
* replayed by an attacker that also has the integration secret until it expires.
|
|
63
|
-
* Single-use enforcement (refresh-token storage, family/jti tracking, replay revocation)
|
|
64
|
-
* is tracked in `UNI-9279`.
|
|
65
|
-
*
|
|
66
|
-
* @deprecated This beta identity delegation API may change with breaking changes.
|
|
67
|
-
*/
|
|
68
|
-
refreshDelegationToken(refreshToken: string): Promise<DelegationTokenResponse>;
|
|
69
|
-
}
|
|
70
|
-
|
|
71
8
|
interface paths$2 {
|
|
72
9
|
"/api/v1/integration-credentials": {
|
|
73
10
|
parameters: {
|
|
@@ -318,6 +255,7 @@ interface paths$1 {
|
|
|
318
255
|
identityDelegation?: boolean;
|
|
319
256
|
/** Format: uuid */
|
|
320
257
|
integrationId?: string;
|
|
258
|
+
hasAppSecret?: boolean;
|
|
321
259
|
baseLocationUrl?: string;
|
|
322
260
|
locations: {
|
|
323
261
|
install?: {
|
|
@@ -915,6 +853,7 @@ interface paths$1 {
|
|
|
915
853
|
* @description Stable id for this integration definition. Required for identity delegation token exchange.
|
|
916
854
|
*/
|
|
917
855
|
integrationId: string;
|
|
856
|
+
hasAppSecret?: boolean;
|
|
918
857
|
baseLocationUrl?: string;
|
|
919
858
|
locations: {
|
|
920
859
|
install?: {
|
|
@@ -1573,6 +1512,7 @@ declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
|
|
|
1573
1512
|
scopes?: string[];
|
|
1574
1513
|
identityDelegation?: boolean;
|
|
1575
1514
|
integrationId: string;
|
|
1515
|
+
hasAppSecret?: boolean;
|
|
1576
1516
|
baseLocationUrl?: string;
|
|
1577
1517
|
locations: {
|
|
1578
1518
|
install?: {
|
|
@@ -1855,6 +1795,26 @@ declare class IntegrationInstallationClient extends ApiClient {
|
|
|
1855
1795
|
remove(body: ExceptProject<IntegrationInstallationDeleteParameters>): Promise<void>;
|
|
1856
1796
|
}
|
|
1857
1797
|
|
|
1798
|
+
/**
|
|
1799
|
+
* Default custom-header name partners attach on every state-changing call
|
|
1800
|
+
* to the BFF. Any fixed, non-CORS-safelisted header name works — the value
|
|
1801
|
+
* is irrelevant to the security argument; only its presence matters.
|
|
1802
|
+
*
|
|
1803
|
+
* The browser will not attach a non-safelisted header on a cross-origin
|
|
1804
|
+
* request without a CORS preflight, so any request that arrives with the
|
|
1805
|
+
* header must have originated from same-origin JavaScript.
|
|
1806
|
+
*
|
|
1807
|
+
* The constant is exported so the BFF and the consumer's browser fetch
|
|
1808
|
+
* helper share one source of truth.
|
|
1809
|
+
*/
|
|
1810
|
+
declare const CSRF_HEADER_NAME = "x-mesh-csrf";
|
|
1811
|
+
/**
|
|
1812
|
+
* Default expected value for the custom CSRF header. Constant; the security
|
|
1813
|
+
* argument is presence-of-header, not value-secrecy. Kept as `'1'` so the
|
|
1814
|
+
* value is trivial to recognise in logs and developer tooling.
|
|
1815
|
+
*/
|
|
1816
|
+
declare const CSRF_HEADER_VALUE = "1";
|
|
1817
|
+
|
|
1858
1818
|
/** @deprecated experimental */
|
|
1859
1819
|
type FunctionCallResponse = {
|
|
1860
1820
|
message: string;
|
|
@@ -1888,6 +1848,7 @@ declare function parseFunctionCall<Parameters extends Record<string, string>, Se
|
|
|
1888
1848
|
name: string;
|
|
1889
1849
|
type: "function_call";
|
|
1890
1850
|
id?: string;
|
|
1851
|
+
namespace?: string;
|
|
1891
1852
|
status?: "in_progress" | "completed" | "incomplete";
|
|
1892
1853
|
};
|
|
1893
1854
|
settings: Settings;
|
|
@@ -1939,17 +1900,7 @@ type DataTypeLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetad
|
|
|
1939
1900
|
}, TIntegrationConfiguration>;
|
|
1940
1901
|
type DataTypeLocation = MeshLocationCore<DataTypeLocationValue, DataTypeLocationMetadata, DataTypeLocationValue, 'dataType'> & GetDataResourceLocation;
|
|
1941
1902
|
|
|
1942
|
-
type DataResourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
|
|
1943
|
-
/**
|
|
1944
|
-
* The release ID of the currently edited entity.
|
|
1945
|
-
* This can be undefined when a release is active but the entity has not been copied to that release yet.
|
|
1946
|
-
*/
|
|
1947
|
-
releaseId?: string;
|
|
1948
|
-
/**
|
|
1949
|
-
* The currently active release ID from editor context.
|
|
1950
|
-
* This reflects release selection regardless of whether the edited entity exists in that release.
|
|
1951
|
-
*/
|
|
1952
|
-
activeReleaseId?: string;
|
|
1903
|
+
type DataResourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<CanvasEditorContextMetadata & {
|
|
1953
1904
|
dataType: DataType;
|
|
1954
1905
|
/** The data type's archetype value. */
|
|
1955
1906
|
archetype: string;
|
|
@@ -1959,12 +1910,10 @@ type DataResourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonM
|
|
|
1959
1910
|
dataSource: DataSource;
|
|
1960
1911
|
/** The data connector type of the current data resource's data source */
|
|
1961
1912
|
dataConnector: DataConnectorInfo;
|
|
1962
|
-
/** Current dynamic inputs that are configured on the composition (if any). */
|
|
1963
|
-
dynamicInputs: DynamicInputs;
|
|
1964
1913
|
/** Which Data Source variant is being resolved and used for getDataResource (unless overriden explicitly via providing "undefined") */
|
|
1965
1914
|
dataSourceVariant?: DataSourceVariantsKeys;
|
|
1966
1915
|
}, TIntegrationConfiguration>;
|
|
1967
|
-
type DataResourceLocation = MeshLocationCore<DataResourceVariables, DataResourceLocationMetadata, DataResourceVariables, 'dataResource'> & GetDataResourceLocation;
|
|
1916
|
+
type DataResourceLocation = MeshLocationCore<DataResourceVariables, DataResourceLocationMetadata, DataResourceVariables, 'dataResource'> & GetDataResourceLocation & GetEditorStateLocationMaybe;
|
|
1968
1917
|
|
|
1969
1918
|
/**
|
|
1970
1919
|
* Metadata for the dataResourceSelector location.
|
|
@@ -1972,7 +1921,7 @@ type DataResourceLocation = MeshLocationCore<DataResourceVariables, DataResource
|
|
|
1972
1921
|
* replacing the default JSON tree viewer in the dynamic token picker.
|
|
1973
1922
|
* @deprecated This is experimental functionality and is subject to change without notice.
|
|
1974
1923
|
*/
|
|
1975
|
-
type DataResourceSelectorLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
|
|
1924
|
+
type DataResourceSelectorLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<CanvasEditorContextMetadata & {
|
|
1976
1925
|
/** The resolved data for the currently selected data resource */
|
|
1977
1926
|
dataResourceValue: unknown;
|
|
1978
1927
|
/** The name of the currently selected data resource */
|
|
@@ -1983,8 +1932,6 @@ type DataResourceSelectorLocationMetadata<TIntegrationConfiguration = unknown> =
|
|
|
1983
1932
|
archetype: string;
|
|
1984
1933
|
/** Allowed bindable types for the parameter being connected */
|
|
1985
1934
|
allowedTypes: BindableTypes[];
|
|
1986
|
-
/** Component definitions index, keyed by public id. */
|
|
1987
|
-
componentDefinitions: Record<string, ComponentDefinition | undefined>;
|
|
1988
1935
|
}, TIntegrationConfiguration>;
|
|
1989
1936
|
/**
|
|
1990
1937
|
* Location for custom data resource selector UI.
|
|
@@ -1996,14 +1943,7 @@ type DataResourceSelectorLocationMetadata<TIntegrationConfiguration = unknown> =
|
|
|
1996
1943
|
* editorState: Imperative API for inspecting/mutating the underlying composition / entry tree
|
|
1997
1944
|
* @deprecated This is experimental functionality and is subject to change without notice.
|
|
1998
1945
|
*/
|
|
1999
|
-
type DataResourceSelectorLocation = MeshLocationCore<string, DataResourceSelectorLocationMetadata, string, 'dataResourceSelector'> & GetDataResourceLocation &
|
|
2000
|
-
/**
|
|
2001
|
-
* Imperative API for interacting with the composition/entry editor state.
|
|
2002
|
-
* Provides non-reactive access to read and modify the editor state.
|
|
2003
|
-
* @deprecated This is experimental functionality and is subject to change without notice.
|
|
2004
|
-
*/
|
|
2005
|
-
editorState: EditorStateApi;
|
|
2006
|
-
};
|
|
1946
|
+
type DataResourceSelectorLocation = MeshLocationCore<string, DataResourceSelectorLocationMetadata, string, 'dataResourceSelector'> & GetDataResourceLocation & GetEditorStateLocationMaybe;
|
|
2007
1947
|
|
|
2008
1948
|
type DataSourceLocationValue = Pick<DataSource, 'baseUrl' | 'custom' | 'customPublic' | 'headers' | 'parameters' | 'variables' | 'enableUnpublishedMode' | 'variants'>;
|
|
2009
1949
|
type DataSourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
|
|
@@ -2015,20 +1955,14 @@ type DataSourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonMet
|
|
|
2015
1955
|
}, TIntegrationConfiguration>;
|
|
2016
1956
|
type DataSourceLocation = MeshLocationCore<DataSourceLocationValue, DataSourceLocationMetadata, DataSourceLocationValue, 'dataSource'>;
|
|
2017
1957
|
|
|
2018
|
-
type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfiguration = unknown> = CommonMetadata<{
|
|
1958
|
+
type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfiguration = unknown> = CommonMetadata<CanvasEditorContextMetadata & {
|
|
2019
1959
|
/** editorState is an experimental replacement for rootNode. This may become deprecated in the future. */
|
|
2020
1960
|
rootNode: Omit<RootComponentInstance, 'slots' | '_data'> & {
|
|
2021
1961
|
_editionId?: string;
|
|
2022
1962
|
};
|
|
2023
1963
|
parameterConfiguration: TParamConfiguration;
|
|
2024
1964
|
component: Omit<ComponentInstance, 'slots'>;
|
|
2025
|
-
componentDefinitions: Record<string, ComponentDefinition | undefined>;
|
|
2026
1965
|
parameterDefinition: ComponentDefinitionParameter;
|
|
2027
|
-
/**
|
|
2028
|
-
* Current dynamic inputs that are configured on the composition (if any).
|
|
2029
|
-
* Use the <ParamTypeDynamicDataProvider> to wire up dynamic data in your parameter.
|
|
2030
|
-
*/
|
|
2031
|
-
dynamicInputs: DynamicInputs;
|
|
2032
1966
|
/**
|
|
2033
1967
|
* The connected data for the current component. Connected data is provided as a map
|
|
2034
1968
|
* of the binding expression text to the value of that binding expression. For example,
|
|
@@ -2045,11 +1979,6 @@ type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfig
|
|
|
2045
1979
|
* Note that setValue() always sets the target language automatically.
|
|
2046
1980
|
*/
|
|
2047
1981
|
targetLocale: string | undefined;
|
|
2048
|
-
/**
|
|
2049
|
-
* The current locale selected in the editor UI.
|
|
2050
|
-
* Unlike targetLocale, this reflects the editor's global locale state.
|
|
2051
|
-
*/
|
|
2052
|
-
currentLocale: string | undefined;
|
|
2053
1982
|
/**
|
|
2054
1983
|
* When editing a conditional value, this is the index in the parent parameter of the conditional value.
|
|
2055
1984
|
* If this is -1, then the editor is not editing a conditional value.
|
|
@@ -2062,13 +1991,7 @@ type ParamTypeLocation<TParamValue = unknown, TParamConfiguration = unknown, TPa
|
|
|
2062
1991
|
* Returns the result of the dialog. Useful to build data-enabled parameter types.
|
|
2063
1992
|
*/
|
|
2064
1993
|
editConnectedData: Awaited<ReturnType<typeof connectToParent>>['parent']['editConnectedData'];
|
|
2065
|
-
|
|
2066
|
-
* Imperative API for interacting with the composition/entry editor state.
|
|
2067
|
-
* Provides non-reactive access to read and modify the editor state.
|
|
2068
|
-
* @deprecated This is experimental functionality and is subject to change without notice.
|
|
2069
|
-
*/
|
|
2070
|
-
editorState: EditorStateApi;
|
|
2071
|
-
};
|
|
1994
|
+
} & GetEditorStateLocation;
|
|
2072
1995
|
|
|
2073
1996
|
type SettingsLocationMetadata = CommonMetadata;
|
|
2074
1997
|
type SettingsLocation<TSettingsType> = MeshLocationCore<TSettingsType, SettingsLocationMetadata, TSettingsType, 'settings'>;
|
|
@@ -2363,6 +2286,28 @@ type CommonMetadata<ExtendedMetadata = unknown, TIntegrationConfiguration = unkn
|
|
|
2363
2286
|
/** List if enabled Uniform Project locales */
|
|
2364
2287
|
locales: Locale[];
|
|
2365
2288
|
} & ExtendedMetadata;
|
|
2289
|
+
/**
|
|
2290
|
+
* Serializable metadata fields available in Canvas/Entry editor context.
|
|
2291
|
+
* {@link EditorStateApi} is not part of metadata; it is provided on the location object via mesh-sdk comms.
|
|
2292
|
+
*/
|
|
2293
|
+
type CanvasEditorContextMetadata = {
|
|
2294
|
+
/** Component definitions index, keyed by public id. */
|
|
2295
|
+
componentDefinitions: Record<string, ComponentDefinition | undefined>;
|
|
2296
|
+
/** Current dynamic inputs configured on the composition (if any). */
|
|
2297
|
+
dynamicInputs: DynamicInputs;
|
|
2298
|
+
/** The current locale selected in the editor UI */
|
|
2299
|
+
currentLocale: string | undefined;
|
|
2300
|
+
/**
|
|
2301
|
+
* The release ID of the currently edited entity.
|
|
2302
|
+
* Can be undefined when a release is active but the entity has not been copied to that release yet.
|
|
2303
|
+
*/
|
|
2304
|
+
releaseId?: string;
|
|
2305
|
+
/**
|
|
2306
|
+
* The currently active release ID from editor context.
|
|
2307
|
+
* This reflects release selection regardless of whether the edited entity exists in that release.
|
|
2308
|
+
*/
|
|
2309
|
+
activeReleaseId?: string;
|
|
2310
|
+
};
|
|
2366
2311
|
type MeshLocationUserPermissions =
|
|
2367
2312
|
/** Uniform Context:Enrichments:Create */
|
|
2368
2313
|
'ENRICHMENTS_CREATE'
|
|
@@ -2440,16 +2385,6 @@ type MeshLocationUserPermissions =
|
|
|
2440
2385
|
| 'ENTRIES_MANAGE_SCHEMA'
|
|
2441
2386
|
/** Uniform Canvas:AI Prompts:Manage|Create, update, and delete AI prompts */
|
|
2442
2387
|
| 'PROMPTS_MANAGE_SCHEMA'
|
|
2443
|
-
/** Uniform Canvas:Labels:Create */
|
|
2444
|
-
| 'LABELS_CREATE'
|
|
2445
|
-
/** Uniform Canvas:Labels:Update */
|
|
2446
|
-
| 'LABELS_UPDATE'
|
|
2447
|
-
/** Uniform Canvas:Labels:Delete */
|
|
2448
|
-
| 'LABELS_DELETE'
|
|
2449
|
-
/** Uniform Automations:Manage|Create, update, delete, and toggle automations. */
|
|
2450
|
-
| 'AUTOMATIONS_MANAGE'
|
|
2451
|
-
/** Uniform Canvas:Workflows:Manage|Create, update, and delete workflow definitions. */
|
|
2452
|
-
| 'WORKFLOWS_MANAGE'
|
|
2453
2388
|
/** UTM Mapper:Read|Read UTM mapper configuration */
|
|
2454
2389
|
| 'UTM_MAPPER_READ'
|
|
2455
2390
|
/** UTM Mapper:Read|Create, update and delete UTM mapper configuration */
|
|
@@ -2475,6 +2410,25 @@ type SetValueMessage = {
|
|
|
2475
2410
|
type GetDataResourceLocation = {
|
|
2476
2411
|
getDataResource: Awaited<ReturnType<typeof connectToParent>>['parent']['getDataResource'];
|
|
2477
2412
|
};
|
|
2413
|
+
type GetEditorStateLocation = {
|
|
2414
|
+
/**
|
|
2415
|
+
* Imperative API for interacting with the composition/entry editor state.
|
|
2416
|
+
* Provides non-reactive access to read and modify the editor state.
|
|
2417
|
+
* @deprecated This is experimental functionality and is subject to change without notice.
|
|
2418
|
+
*/
|
|
2419
|
+
editorState: EditorStateApi;
|
|
2420
|
+
};
|
|
2421
|
+
type GetEditorStateLocationMaybe = {
|
|
2422
|
+
/**
|
|
2423
|
+
* Imperative API for interacting with the composition/entry editor state.
|
|
2424
|
+
* Provides non-reactive access to read and modify the editor state.
|
|
2425
|
+
*
|
|
2426
|
+
* "undefined" means that the location is rendered outside of Canvas Editor context, e.g. Data Type testing.
|
|
2427
|
+
*
|
|
2428
|
+
* @deprecated This is experimental functionality and is subject to change without notice.
|
|
2429
|
+
*/
|
|
2430
|
+
editorState: EditorStateApi | undefined;
|
|
2431
|
+
};
|
|
2478
2432
|
/**
|
|
2479
2433
|
* Dynamic inputs come from project map and represent path or query based dynamic values
|
|
2480
2434
|
* These can be connected to from within a Mesh location by setting a data resource variable to contain ex:
|
|
@@ -2638,7 +2592,7 @@ type UpdateRootNodeOptions = {
|
|
|
2638
2592
|
};
|
|
2639
2593
|
/**
|
|
2640
2594
|
* Imperative API for interacting with the composition/entry editor state.
|
|
2641
|
-
* Available on `canvasEditorTools` and `
|
|
2595
|
+
* Available on `canvasEditorTools`, `paramType`, `dataResource`, and `dataResourceSelector` locations.
|
|
2642
2596
|
*
|
|
2643
2597
|
* All methods use object parameters for consistency across client, wire format, and server.
|
|
2644
2598
|
*/
|
|
@@ -2760,27 +2714,8 @@ type PromptSettingsLocationMetadata<TIntegrationConfiguration = unknown> = Commo
|
|
|
2760
2714
|
type AIGenerateLocation<TType> = MeshLocationCore<TType, AIGenerateLocationMetadata, TType, 'aiGenerate'>;
|
|
2761
2715
|
type AIPromptMetadataLocation = MeshLocationCore<Record<string, unknown>, PromptSettingsLocationMetadata, Record<string, unknown>, 'aiMetadata'>;
|
|
2762
2716
|
|
|
2763
|
-
type CanvasEditorToolsLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
|
|
2764
|
-
/**
|
|
2765
|
-
* The release ID of the currently edited entity.
|
|
2766
|
-
* This can be undefined when a release is active but the entity has not been copied to that release yet.
|
|
2767
|
-
*/
|
|
2768
|
-
releaseId?: string;
|
|
2769
|
-
/**
|
|
2770
|
-
* The currently active release ID from editor context.
|
|
2771
|
-
* This reflects release selection regardless of whether the edited entity exists in that release.
|
|
2772
|
-
*/
|
|
2773
|
-
activeReleaseId?: string;
|
|
2717
|
+
type CanvasEditorToolsLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<CanvasEditorContextMetadata & {
|
|
2774
2718
|
state?: number;
|
|
2775
|
-
/** The current locale selected in the editor UI */
|
|
2776
|
-
currentLocale: string | undefined;
|
|
2777
|
-
/**
|
|
2778
|
-
* Current dynamic inputs configured on the composition (if any).
|
|
2779
|
-
* Dynamic inputs come from project map nodes and represent path or query based dynamic values.
|
|
2780
|
-
*/
|
|
2781
|
-
dynamicInputs: DynamicInputs;
|
|
2782
|
-
/** Component definitions index, keyed by public id. */
|
|
2783
|
-
componentDefinitions: Record<string, ComponentDefinition | undefined>;
|
|
2784
2719
|
}, TIntegrationConfiguration>;
|
|
2785
2720
|
type CanvasEditorToolsReferenceData = {
|
|
2786
2721
|
name: string;
|
|
@@ -2799,14 +2734,7 @@ type CanvasEditorToolsData = {
|
|
|
2799
2734
|
rootEntity: EntryData;
|
|
2800
2735
|
entityType: 'entry' | 'entryPattern';
|
|
2801
2736
|
});
|
|
2802
|
-
type CanvasEditorToolsLocation = MeshLocationCore<CanvasEditorToolsData, CanvasEditorToolsLocationMetadata, CanvasEditorToolsData, 'canvasEditorTools'> & GetDataResourceLocation &
|
|
2803
|
-
/**
|
|
2804
|
-
* Imperative API for interacting with the composition/entry editor state.
|
|
2805
|
-
* Provides non-reactive access to read and modify the editor state.
|
|
2806
|
-
* @deprecated This is experimental functionality and is subject to change without notice.
|
|
2807
|
-
*/
|
|
2808
|
-
editorState: EditorStateApi;
|
|
2809
|
-
};
|
|
2737
|
+
type CanvasEditorToolsLocation = MeshLocationCore<CanvasEditorToolsData, CanvasEditorToolsLocationMetadata, CanvasEditorToolsData, 'canvasEditorTools'> & GetDataResourceLocation & GetEditorStateLocation;
|
|
2810
2738
|
|
|
2811
2739
|
/**
|
|
2812
2740
|
* @deprecated Alpha version of the Embedded Editor location. This location is not yet available for use in the Mesh SDK.
|
|
@@ -2984,4 +2912,4 @@ declare const hasPermissions: (permissions: MeshLocationUserPermissions | MeshLo
|
|
|
2984
2912
|
*/
|
|
2985
2913
|
declare const hasRole: (role: string, user: UniformUser) => boolean;
|
|
2986
2914
|
|
|
2987
|
-
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 ConnectToParentResult, 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,
|
|
2915
|
+
export { type AIGenerateLocation, type AIGenerateLocationMetadata, type AIPromptMetadataLocation, type AssetLibraryLocation, type AssetLibraryLocationMetadata, type AssetParameterLocation, type AssetParameterLocationMetadata, type BindableTypes, CSRF_HEADER_NAME, CSRF_HEADER_VALUE, type CSSHeight, type CanvasEditorContextMetadata, type CanvasEditorEntityType, type CanvasEditorToolsData, type CanvasEditorToolsLocation, type CanvasEditorToolsLocationMetadata, type CloseDialogMessage, type CloseLocationDialogOptions, type CommonMetadata, type ConnectToParentResult, 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, type IntegrationCredentialRevokeParameters, type IntegrationCredentialRotateParameters, type IntegrationCredentialRotateResponse, 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 MeshParentConnection, 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 };
|