@uniformdev/mesh-sdk 20.12.1-alpha.23 → 20.12.1-alpha.28
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 +52 -14
- package/dist/index.d.ts +52 -14
- package/dist/index.esm.js +11 -5
- package/dist/index.js +11 -5
- package/dist/index.mjs +11 -5
- package/package.json +7 -7
package/dist/index.d.mts
CHANGED
|
@@ -233,9 +233,10 @@ interface paths$1 {
|
|
|
233
233
|
definition: {
|
|
234
234
|
name: string;
|
|
235
235
|
description: string;
|
|
236
|
-
parameters
|
|
236
|
+
parameters: {
|
|
237
237
|
[key: string]: unknown;
|
|
238
238
|
};
|
|
239
|
+
strict: boolean;
|
|
239
240
|
};
|
|
240
241
|
systemParameters?: "pageHtml"[];
|
|
241
242
|
includedAgents?: ("scout" | "sage")[];
|
|
@@ -248,6 +249,12 @@ interface paths$1 {
|
|
|
248
249
|
url: string;
|
|
249
250
|
iconUrl?: string;
|
|
250
251
|
}[];
|
|
252
|
+
projectTools?: {
|
|
253
|
+
id: string;
|
|
254
|
+
name: string;
|
|
255
|
+
url: string;
|
|
256
|
+
iconUrl?: string;
|
|
257
|
+
}[];
|
|
251
258
|
};
|
|
252
259
|
unstable_prompts?: {
|
|
253
260
|
/** Format: uuid */
|
|
@@ -492,9 +499,10 @@ interface paths$1 {
|
|
|
492
499
|
definition: {
|
|
493
500
|
name: string;
|
|
494
501
|
description: string;
|
|
495
|
-
parameters
|
|
502
|
+
parameters: {
|
|
496
503
|
[key: string]: unknown;
|
|
497
504
|
};
|
|
505
|
+
strict: boolean;
|
|
498
506
|
};
|
|
499
507
|
systemParameters?: "pageHtml"[];
|
|
500
508
|
includedAgents?: ("scout" | "sage")[];
|
|
@@ -507,6 +515,12 @@ interface paths$1 {
|
|
|
507
515
|
url: string;
|
|
508
516
|
iconUrl?: string;
|
|
509
517
|
}[];
|
|
518
|
+
projectTools?: {
|
|
519
|
+
id: string;
|
|
520
|
+
name: string;
|
|
521
|
+
url: string;
|
|
522
|
+
iconUrl?: string;
|
|
523
|
+
}[];
|
|
510
524
|
};
|
|
511
525
|
unstable_prompts?: {
|
|
512
526
|
/** Format: uuid */
|
|
@@ -736,9 +750,10 @@ interface paths$1 {
|
|
|
736
750
|
definition: {
|
|
737
751
|
name: string;
|
|
738
752
|
description: string;
|
|
739
|
-
parameters
|
|
753
|
+
parameters: {
|
|
740
754
|
[key: string]: unknown;
|
|
741
755
|
};
|
|
756
|
+
strict: boolean;
|
|
742
757
|
};
|
|
743
758
|
systemParameters?: "pageHtml"[];
|
|
744
759
|
includedAgents?: ("scout" | "sage")[];
|
|
@@ -751,6 +766,12 @@ interface paths$1 {
|
|
|
751
766
|
url: string;
|
|
752
767
|
iconUrl?: string;
|
|
753
768
|
}[];
|
|
769
|
+
projectTools?: {
|
|
770
|
+
id: string;
|
|
771
|
+
name: string;
|
|
772
|
+
url: string;
|
|
773
|
+
iconUrl?: string;
|
|
774
|
+
}[];
|
|
754
775
|
};
|
|
755
776
|
unstable_prompts?: {
|
|
756
777
|
/** Format: uuid */
|
|
@@ -1329,9 +1350,10 @@ declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
|
|
|
1329
1350
|
definition: {
|
|
1330
1351
|
name: string;
|
|
1331
1352
|
description: string;
|
|
1332
|
-
parameters
|
|
1353
|
+
parameters: {
|
|
1333
1354
|
[key: string]: unknown;
|
|
1334
1355
|
};
|
|
1356
|
+
strict: boolean;
|
|
1335
1357
|
};
|
|
1336
1358
|
systemParameters?: "pageHtml"[];
|
|
1337
1359
|
includedAgents?: ("scout" | "sage")[];
|
|
@@ -1344,6 +1366,12 @@ declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
|
|
|
1344
1366
|
url: string;
|
|
1345
1367
|
iconUrl?: string;
|
|
1346
1368
|
}[];
|
|
1369
|
+
projectTools?: {
|
|
1370
|
+
id: string;
|
|
1371
|
+
name: string;
|
|
1372
|
+
url: string;
|
|
1373
|
+
iconUrl?: string;
|
|
1374
|
+
}[];
|
|
1347
1375
|
};
|
|
1348
1376
|
unstable_prompts?: {
|
|
1349
1377
|
id: string;
|
|
@@ -1412,7 +1440,11 @@ type FunctionCallSystemParameter = (typeof functionCallSystemParameters)[number]
|
|
|
1412
1440
|
declare function parseFunctionCall<Parameters extends Record<string, string>, Settings = Record<string, string>>(request: Pick<Request, 'body'>): {
|
|
1413
1441
|
functionCall: {
|
|
1414
1442
|
arguments: Parameters;
|
|
1443
|
+
call_id: string;
|
|
1415
1444
|
name: string;
|
|
1445
|
+
type: "function_call";
|
|
1446
|
+
id?: string;
|
|
1447
|
+
status?: "in_progress" | "completed" | "incomplete";
|
|
1416
1448
|
};
|
|
1417
1449
|
settings: Settings;
|
|
1418
1450
|
systemParameters: Record<FunctionCallSystemParameter, string | undefined>;
|
|
@@ -1535,7 +1567,7 @@ type SettingsLocation<TSettingsType> = MeshLocationCore<TSettingsType, SettingsL
|
|
|
1535
1567
|
* Defines methods used for interacting with a Mesh location
|
|
1536
1568
|
* To receive useful typings, check the `type` property of the location to narrow the typing.
|
|
1537
1569
|
*/
|
|
1538
|
-
type MeshLocation<TValue = unknown, TSetValue = TValue> = ParamTypeLocation<TValue, unknown, TSetValue> | ParamTypeConfigLocation<TValue> | SettingsLocation<TValue> | AssetLibraryLocation | AssetParameterLocation | DataSourceLocation | DataTypeLocation | DataResourceLocation | CanvasEditorToolsLocation | EmbeddedEditorLocation | AIGenerateLocation<TValue> | AIPromptMetadataLocation | PersonalizationCriteriaLocation<TValue> |
|
|
1570
|
+
type MeshLocation<TValue = unknown, TSetValue = TValue> = ParamTypeLocation<TValue, unknown, TSetValue> | ParamTypeConfigLocation<TValue> | SettingsLocation<TValue> | AssetLibraryLocation | AssetParameterLocation | DataSourceLocation | DataTypeLocation | DataResourceLocation | CanvasEditorToolsLocation | EmbeddedEditorLocation | AIGenerateLocation<TValue> | AIPromptMetadataLocation | PersonalizationCriteriaLocation<TValue> | ProjectToolLocation<TValue>;
|
|
1539
1571
|
interface MeshContextData {
|
|
1540
1572
|
locationKey: string;
|
|
1541
1573
|
locationType: MeshLocationTypes;
|
|
@@ -1544,6 +1576,7 @@ interface MeshContextData {
|
|
|
1544
1576
|
locationMetadata: any;
|
|
1545
1577
|
uniformApiVersion: string;
|
|
1546
1578
|
dialogContext?: DialogContext;
|
|
1579
|
+
fullScreenHeight?: boolean;
|
|
1547
1580
|
}
|
|
1548
1581
|
interface DialogContext {
|
|
1549
1582
|
dialogId: string;
|
|
@@ -1645,6 +1678,7 @@ type OpenDialogMessage = {
|
|
|
1645
1678
|
type NavigateMessage = {
|
|
1646
1679
|
path: string;
|
|
1647
1680
|
options?: {
|
|
1681
|
+
projectId?: string;
|
|
1648
1682
|
target?: '_blank';
|
|
1649
1683
|
};
|
|
1650
1684
|
};
|
|
@@ -1750,8 +1784,6 @@ interface MeshLocationCore<TValue = unknown, TMetadata = unknown, TSetValue = TV
|
|
|
1750
1784
|
metadata: TMetadata;
|
|
1751
1785
|
/**
|
|
1752
1786
|
* A router object that can be used to navigate parent frame (Uniform App) to other page within current project and other methods.
|
|
1753
|
-
*
|
|
1754
|
-
* @deprecated Is not stable yet so can contain breaking changes in the future
|
|
1755
1787
|
*/
|
|
1756
1788
|
router: MeshRouter;
|
|
1757
1789
|
/**
|
|
@@ -1778,9 +1810,13 @@ type MeshRouter = {
|
|
|
1778
1810
|
* So router.navigate('/canvas/edit/{compositionId}') will navigate will open the composition editor for the given composition ID in the parent frame.
|
|
1779
1811
|
* Be aware that most of the time it will close your mesh app, so you should use it with caution.
|
|
1780
1812
|
*
|
|
1781
|
-
* @
|
|
1813
|
+
* @param path - The path to navigate to. You don't need to specify /projects/${projectId} as it is prepended automatically with the current project ID.
|
|
1814
|
+
* @param options - The options for the navigation.
|
|
1815
|
+
* @param options.projectId - You can specify project ID to navigate to. By default the current project ID is used.
|
|
1816
|
+
* @param options.target - Allows to open a new tab instead of navigating the current one.
|
|
1782
1817
|
*/
|
|
1783
1818
|
navigatePlatform: (path: string, options?: {
|
|
1819
|
+
projectId?: string;
|
|
1784
1820
|
target?: '_blank';
|
|
1785
1821
|
}) => void;
|
|
1786
1822
|
};
|
|
@@ -1864,6 +1900,10 @@ type MeshLocationUserPermissions =
|
|
|
1864
1900
|
| 'COMPOSITIONS_READ_DRAFT'
|
|
1865
1901
|
/** Uniform Canvas:Component Library:Manage|Create, update, and delete component library data */
|
|
1866
1902
|
| 'COMPOSITIONS_MANAGE_SCHEMA'
|
|
1903
|
+
/** Uniform Canvas:Content Types:Manage|Create, update, and delete content types */
|
|
1904
|
+
| 'ENTRIES_MANAGE_SCHEMA'
|
|
1905
|
+
/** Uniform Canvas:AI Prompts:Manage|Create, update, and delete AI prompts */
|
|
1906
|
+
| 'PROMPTS_MANAGE_SCHEMA'
|
|
1867
1907
|
/** UTM Mapper:Read|Read UTM mapper configuration */
|
|
1868
1908
|
| 'UTM_MAPPER_READ'
|
|
1869
1909
|
/** UTM Mapper:Read|Create, update and delete UTM mapper configuration */
|
|
@@ -1879,7 +1919,7 @@ type MeshLocationUserPermissions =
|
|
|
1879
1919
|
/**
|
|
1880
1920
|
* Known location types that can be passed to a mesh location
|
|
1881
1921
|
*/
|
|
1882
|
-
type MeshLocationTypes = 'paramType' | 'paramTypeConfig' | 'assetLibrary' | 'assetParameter' | 'settings' | 'dataSource' | 'dataType' | 'dataResource' | 'aiGenerate' | 'embeddedEditor' | 'canvasEditorTools' | 'aiMetadata' | 'personalizationCriteria' | '
|
|
1922
|
+
type MeshLocationTypes = 'paramType' | 'paramTypeConfig' | 'assetLibrary' | 'assetParameter' | 'settings' | 'dataSource' | 'dataType' | 'dataResource' | 'aiGenerate' | 'embeddedEditor' | 'canvasEditorTools' | 'aiMetadata' | 'personalizationCriteria' | 'projectTool';
|
|
1883
1923
|
type SetValueOptions = ValidationResult;
|
|
1884
1924
|
type SetValueMessage = {
|
|
1885
1925
|
uniformMeshLocationValue: unknown;
|
|
@@ -1999,10 +2039,8 @@ type PersonalizationCriteriaLocationMetadata<TIntegrationConfiguration = unknown
|
|
|
1999
2039
|
/** @deprecated Experimental functionality is subject to change in minor versions. */
|
|
2000
2040
|
type PersonalizationCriteriaLocation<TCriteriaValue, TIntegrationConfiguration = unknown> = MeshLocationCore<TCriteriaValue | undefined, PersonalizationCriteriaLocationMetadata<TIntegrationConfiguration>, TCriteriaValue, 'personalizationCriteria'>;
|
|
2001
2041
|
|
|
2002
|
-
|
|
2003
|
-
type
|
|
2004
|
-
/** @deprecated Experimental functionality is subject to change in minor versions. */
|
|
2005
|
-
type ToolLocation<TTool, TIntegrationConfiguration = unknown> = MeshLocationCore<TTool, ToolLocationMetadata<TIntegrationConfiguration>, TTool, 'tool'>;
|
|
2042
|
+
type ProjectToolLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<unknown, TIntegrationConfiguration>;
|
|
2043
|
+
type ProjectToolLocation<TTool, TIntegrationConfiguration = unknown> = MeshLocationCore<TTool, ProjectToolLocationMetadata<TIntegrationConfiguration>, TTool, 'projectTool'>;
|
|
2006
2044
|
|
|
2007
2045
|
interface SdkWindow {
|
|
2008
2046
|
/** The current window object. */
|
|
@@ -2107,4 +2145,4 @@ declare const hasPermissions: (permissions: MeshLocationUserPermissions | MeshLo
|
|
|
2107
2145
|
*/
|
|
2108
2146
|
declare const hasRole: (role: string, user: UniformUser) => boolean;
|
|
2109
2147
|
|
|
2110
|
-
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 DataConnectorInfo, type DataResourceLocation, type DataResourceLocationMetadata, type DataSourceLocation, type DataSourceLocationMetadata, type DataSourceLocationValue, type DataTypeLocation, type DataTypeLocationMetadata, type DataTypeLocationValue, type DialogContext, type DialogOptions, type DialogParamValue, type DialogParams, type DialogResponseData, type DialogResponseHandler, type DialogResponseHandlers, type DialogType, type DynamicInput, type DynamicInputs, type EditConnectedDataMessage, type EditConnectedDataResponse, type EditConnectedDataResponseCancellationContext, type EmbeddedEditorLocation, type EmbeddedEditorLocationMetadata, type EmbeddedEditorLocationSetValue, type EmbeddedEditorLocationValue, type FunctionCallResponse, type FunctionCallSystemParameter, type GetDataResourceLocation, type GetDataResourceMessage, IntegrationDefinitionClient, type IntegrationDefinitionDeleteParameters, type IntegrationDefinitionGetParameters, type IntegrationDefinitionGetResponse, type IntegrationDefinitionPutParameters, type IntegrationDefinitionPutResponse, IntegrationInstallationClient, type IntegrationInstallationDeleteParameters, type IntegrationInstallationGetParameters, type IntegrationInstallationGetResponse, type IntegrationInstallationPutParameters, type LocationDialogResponse, type MeshContextData, type MeshLocation, type MeshLocationCore, type MeshLocationTypes, type MeshLocationUserPermissions, type MeshRouter, type MeshSDKEventInterface, type NavigateMessage, type OpenConfirmationDialogOptions, type OpenConfirmationDialogResult, type OpenDialogMessage, type OpenDialogResult, type OpenLocationDialogOptions, type ParamTypeConfigLocation, type ParamTypeConfigLocationMetadata, type ParamTypeLocation, type ParamTypeLocationMetadata, type PersonalizationCriteriaLocation, type PersonalizationCriteriaLocationMetadata, type
|
|
2148
|
+
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 DataConnectorInfo, type DataResourceLocation, type DataResourceLocationMetadata, type DataSourceLocation, type DataSourceLocationMetadata, type DataSourceLocationValue, type DataTypeLocation, type DataTypeLocationMetadata, type DataTypeLocationValue, type DialogContext, type DialogOptions, type DialogParamValue, type DialogParams, type DialogResponseData, type DialogResponseHandler, type DialogResponseHandlers, type DialogType, type DynamicInput, type DynamicInputs, type EditConnectedDataMessage, type EditConnectedDataResponse, type EditConnectedDataResponseCancellationContext, type EmbeddedEditorLocation, type EmbeddedEditorLocationMetadata, type EmbeddedEditorLocationSetValue, type EmbeddedEditorLocationValue, type FunctionCallResponse, type FunctionCallSystemParameter, type GetDataResourceLocation, type GetDataResourceMessage, IntegrationDefinitionClient, type IntegrationDefinitionDeleteParameters, type IntegrationDefinitionGetParameters, type IntegrationDefinitionGetResponse, type IntegrationDefinitionPutParameters, type IntegrationDefinitionPutResponse, IntegrationInstallationClient, type IntegrationInstallationDeleteParameters, type IntegrationInstallationGetParameters, type IntegrationInstallationGetResponse, type IntegrationInstallationPutParameters, type LocationDialogResponse, type MeshContextData, type MeshLocation, type MeshLocationCore, type MeshLocationTypes, type MeshLocationUserPermissions, type MeshRouter, type MeshSDKEventInterface, type NavigateMessage, type OpenConfirmationDialogOptions, type OpenConfirmationDialogResult, type OpenDialogMessage, type OpenDialogResult, type OpenLocationDialogOptions, type ParamTypeConfigLocation, type ParamTypeConfigLocationMetadata, type ParamTypeLocation, type ParamTypeLocationMetadata, type PersonalizationCriteriaLocation, type PersonalizationCriteriaLocationMetadata, type ProjectToolLocation, type ProjectToolLocationMetadata, type PromptSettingsLocationMetadata, type SdkWindow, type SetLocationFunction, type SetValueMessage, type SetValueOptions, type SettingsLocation, type SettingsLocationMetadata, type UniformMeshSDK, type UniformMeshSDKEvents, type UniformUser, type ValidationResult, functionCallSystemParameters, hasPermissions, hasRole, initializeUniformMeshSDK, parseFunctionCall };
|
package/dist/index.d.ts
CHANGED
|
@@ -233,9 +233,10 @@ interface paths$1 {
|
|
|
233
233
|
definition: {
|
|
234
234
|
name: string;
|
|
235
235
|
description: string;
|
|
236
|
-
parameters
|
|
236
|
+
parameters: {
|
|
237
237
|
[key: string]: unknown;
|
|
238
238
|
};
|
|
239
|
+
strict: boolean;
|
|
239
240
|
};
|
|
240
241
|
systemParameters?: "pageHtml"[];
|
|
241
242
|
includedAgents?: ("scout" | "sage")[];
|
|
@@ -248,6 +249,12 @@ interface paths$1 {
|
|
|
248
249
|
url: string;
|
|
249
250
|
iconUrl?: string;
|
|
250
251
|
}[];
|
|
252
|
+
projectTools?: {
|
|
253
|
+
id: string;
|
|
254
|
+
name: string;
|
|
255
|
+
url: string;
|
|
256
|
+
iconUrl?: string;
|
|
257
|
+
}[];
|
|
251
258
|
};
|
|
252
259
|
unstable_prompts?: {
|
|
253
260
|
/** Format: uuid */
|
|
@@ -492,9 +499,10 @@ interface paths$1 {
|
|
|
492
499
|
definition: {
|
|
493
500
|
name: string;
|
|
494
501
|
description: string;
|
|
495
|
-
parameters
|
|
502
|
+
parameters: {
|
|
496
503
|
[key: string]: unknown;
|
|
497
504
|
};
|
|
505
|
+
strict: boolean;
|
|
498
506
|
};
|
|
499
507
|
systemParameters?: "pageHtml"[];
|
|
500
508
|
includedAgents?: ("scout" | "sage")[];
|
|
@@ -507,6 +515,12 @@ interface paths$1 {
|
|
|
507
515
|
url: string;
|
|
508
516
|
iconUrl?: string;
|
|
509
517
|
}[];
|
|
518
|
+
projectTools?: {
|
|
519
|
+
id: string;
|
|
520
|
+
name: string;
|
|
521
|
+
url: string;
|
|
522
|
+
iconUrl?: string;
|
|
523
|
+
}[];
|
|
510
524
|
};
|
|
511
525
|
unstable_prompts?: {
|
|
512
526
|
/** Format: uuid */
|
|
@@ -736,9 +750,10 @@ interface paths$1 {
|
|
|
736
750
|
definition: {
|
|
737
751
|
name: string;
|
|
738
752
|
description: string;
|
|
739
|
-
parameters
|
|
753
|
+
parameters: {
|
|
740
754
|
[key: string]: unknown;
|
|
741
755
|
};
|
|
756
|
+
strict: boolean;
|
|
742
757
|
};
|
|
743
758
|
systemParameters?: "pageHtml"[];
|
|
744
759
|
includedAgents?: ("scout" | "sage")[];
|
|
@@ -751,6 +766,12 @@ interface paths$1 {
|
|
|
751
766
|
url: string;
|
|
752
767
|
iconUrl?: string;
|
|
753
768
|
}[];
|
|
769
|
+
projectTools?: {
|
|
770
|
+
id: string;
|
|
771
|
+
name: string;
|
|
772
|
+
url: string;
|
|
773
|
+
iconUrl?: string;
|
|
774
|
+
}[];
|
|
754
775
|
};
|
|
755
776
|
unstable_prompts?: {
|
|
756
777
|
/** Format: uuid */
|
|
@@ -1329,9 +1350,10 @@ declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
|
|
|
1329
1350
|
definition: {
|
|
1330
1351
|
name: string;
|
|
1331
1352
|
description: string;
|
|
1332
|
-
parameters
|
|
1353
|
+
parameters: {
|
|
1333
1354
|
[key: string]: unknown;
|
|
1334
1355
|
};
|
|
1356
|
+
strict: boolean;
|
|
1335
1357
|
};
|
|
1336
1358
|
systemParameters?: "pageHtml"[];
|
|
1337
1359
|
includedAgents?: ("scout" | "sage")[];
|
|
@@ -1344,6 +1366,12 @@ declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
|
|
|
1344
1366
|
url: string;
|
|
1345
1367
|
iconUrl?: string;
|
|
1346
1368
|
}[];
|
|
1369
|
+
projectTools?: {
|
|
1370
|
+
id: string;
|
|
1371
|
+
name: string;
|
|
1372
|
+
url: string;
|
|
1373
|
+
iconUrl?: string;
|
|
1374
|
+
}[];
|
|
1347
1375
|
};
|
|
1348
1376
|
unstable_prompts?: {
|
|
1349
1377
|
id: string;
|
|
@@ -1412,7 +1440,11 @@ type FunctionCallSystemParameter = (typeof functionCallSystemParameters)[number]
|
|
|
1412
1440
|
declare function parseFunctionCall<Parameters extends Record<string, string>, Settings = Record<string, string>>(request: Pick<Request, 'body'>): {
|
|
1413
1441
|
functionCall: {
|
|
1414
1442
|
arguments: Parameters;
|
|
1443
|
+
call_id: string;
|
|
1415
1444
|
name: string;
|
|
1445
|
+
type: "function_call";
|
|
1446
|
+
id?: string;
|
|
1447
|
+
status?: "in_progress" | "completed" | "incomplete";
|
|
1416
1448
|
};
|
|
1417
1449
|
settings: Settings;
|
|
1418
1450
|
systemParameters: Record<FunctionCallSystemParameter, string | undefined>;
|
|
@@ -1535,7 +1567,7 @@ type SettingsLocation<TSettingsType> = MeshLocationCore<TSettingsType, SettingsL
|
|
|
1535
1567
|
* Defines methods used for interacting with a Mesh location
|
|
1536
1568
|
* To receive useful typings, check the `type` property of the location to narrow the typing.
|
|
1537
1569
|
*/
|
|
1538
|
-
type MeshLocation<TValue = unknown, TSetValue = TValue> = ParamTypeLocation<TValue, unknown, TSetValue> | ParamTypeConfigLocation<TValue> | SettingsLocation<TValue> | AssetLibraryLocation | AssetParameterLocation | DataSourceLocation | DataTypeLocation | DataResourceLocation | CanvasEditorToolsLocation | EmbeddedEditorLocation | AIGenerateLocation<TValue> | AIPromptMetadataLocation | PersonalizationCriteriaLocation<TValue> |
|
|
1570
|
+
type MeshLocation<TValue = unknown, TSetValue = TValue> = ParamTypeLocation<TValue, unknown, TSetValue> | ParamTypeConfigLocation<TValue> | SettingsLocation<TValue> | AssetLibraryLocation | AssetParameterLocation | DataSourceLocation | DataTypeLocation | DataResourceLocation | CanvasEditorToolsLocation | EmbeddedEditorLocation | AIGenerateLocation<TValue> | AIPromptMetadataLocation | PersonalizationCriteriaLocation<TValue> | ProjectToolLocation<TValue>;
|
|
1539
1571
|
interface MeshContextData {
|
|
1540
1572
|
locationKey: string;
|
|
1541
1573
|
locationType: MeshLocationTypes;
|
|
@@ -1544,6 +1576,7 @@ interface MeshContextData {
|
|
|
1544
1576
|
locationMetadata: any;
|
|
1545
1577
|
uniformApiVersion: string;
|
|
1546
1578
|
dialogContext?: DialogContext;
|
|
1579
|
+
fullScreenHeight?: boolean;
|
|
1547
1580
|
}
|
|
1548
1581
|
interface DialogContext {
|
|
1549
1582
|
dialogId: string;
|
|
@@ -1645,6 +1678,7 @@ type OpenDialogMessage = {
|
|
|
1645
1678
|
type NavigateMessage = {
|
|
1646
1679
|
path: string;
|
|
1647
1680
|
options?: {
|
|
1681
|
+
projectId?: string;
|
|
1648
1682
|
target?: '_blank';
|
|
1649
1683
|
};
|
|
1650
1684
|
};
|
|
@@ -1750,8 +1784,6 @@ interface MeshLocationCore<TValue = unknown, TMetadata = unknown, TSetValue = TV
|
|
|
1750
1784
|
metadata: TMetadata;
|
|
1751
1785
|
/**
|
|
1752
1786
|
* A router object that can be used to navigate parent frame (Uniform App) to other page within current project and other methods.
|
|
1753
|
-
*
|
|
1754
|
-
* @deprecated Is not stable yet so can contain breaking changes in the future
|
|
1755
1787
|
*/
|
|
1756
1788
|
router: MeshRouter;
|
|
1757
1789
|
/**
|
|
@@ -1778,9 +1810,13 @@ type MeshRouter = {
|
|
|
1778
1810
|
* So router.navigate('/canvas/edit/{compositionId}') will navigate will open the composition editor for the given composition ID in the parent frame.
|
|
1779
1811
|
* Be aware that most of the time it will close your mesh app, so you should use it with caution.
|
|
1780
1812
|
*
|
|
1781
|
-
* @
|
|
1813
|
+
* @param path - The path to navigate to. You don't need to specify /projects/${projectId} as it is prepended automatically with the current project ID.
|
|
1814
|
+
* @param options - The options for the navigation.
|
|
1815
|
+
* @param options.projectId - You can specify project ID to navigate to. By default the current project ID is used.
|
|
1816
|
+
* @param options.target - Allows to open a new tab instead of navigating the current one.
|
|
1782
1817
|
*/
|
|
1783
1818
|
navigatePlatform: (path: string, options?: {
|
|
1819
|
+
projectId?: string;
|
|
1784
1820
|
target?: '_blank';
|
|
1785
1821
|
}) => void;
|
|
1786
1822
|
};
|
|
@@ -1864,6 +1900,10 @@ type MeshLocationUserPermissions =
|
|
|
1864
1900
|
| 'COMPOSITIONS_READ_DRAFT'
|
|
1865
1901
|
/** Uniform Canvas:Component Library:Manage|Create, update, and delete component library data */
|
|
1866
1902
|
| 'COMPOSITIONS_MANAGE_SCHEMA'
|
|
1903
|
+
/** Uniform Canvas:Content Types:Manage|Create, update, and delete content types */
|
|
1904
|
+
| 'ENTRIES_MANAGE_SCHEMA'
|
|
1905
|
+
/** Uniform Canvas:AI Prompts:Manage|Create, update, and delete AI prompts */
|
|
1906
|
+
| 'PROMPTS_MANAGE_SCHEMA'
|
|
1867
1907
|
/** UTM Mapper:Read|Read UTM mapper configuration */
|
|
1868
1908
|
| 'UTM_MAPPER_READ'
|
|
1869
1909
|
/** UTM Mapper:Read|Create, update and delete UTM mapper configuration */
|
|
@@ -1879,7 +1919,7 @@ type MeshLocationUserPermissions =
|
|
|
1879
1919
|
/**
|
|
1880
1920
|
* Known location types that can be passed to a mesh location
|
|
1881
1921
|
*/
|
|
1882
|
-
type MeshLocationTypes = 'paramType' | 'paramTypeConfig' | 'assetLibrary' | 'assetParameter' | 'settings' | 'dataSource' | 'dataType' | 'dataResource' | 'aiGenerate' | 'embeddedEditor' | 'canvasEditorTools' | 'aiMetadata' | 'personalizationCriteria' | '
|
|
1922
|
+
type MeshLocationTypes = 'paramType' | 'paramTypeConfig' | 'assetLibrary' | 'assetParameter' | 'settings' | 'dataSource' | 'dataType' | 'dataResource' | 'aiGenerate' | 'embeddedEditor' | 'canvasEditorTools' | 'aiMetadata' | 'personalizationCriteria' | 'projectTool';
|
|
1883
1923
|
type SetValueOptions = ValidationResult;
|
|
1884
1924
|
type SetValueMessage = {
|
|
1885
1925
|
uniformMeshLocationValue: unknown;
|
|
@@ -1999,10 +2039,8 @@ type PersonalizationCriteriaLocationMetadata<TIntegrationConfiguration = unknown
|
|
|
1999
2039
|
/** @deprecated Experimental functionality is subject to change in minor versions. */
|
|
2000
2040
|
type PersonalizationCriteriaLocation<TCriteriaValue, TIntegrationConfiguration = unknown> = MeshLocationCore<TCriteriaValue | undefined, PersonalizationCriteriaLocationMetadata<TIntegrationConfiguration>, TCriteriaValue, 'personalizationCriteria'>;
|
|
2001
2041
|
|
|
2002
|
-
|
|
2003
|
-
type
|
|
2004
|
-
/** @deprecated Experimental functionality is subject to change in minor versions. */
|
|
2005
|
-
type ToolLocation<TTool, TIntegrationConfiguration = unknown> = MeshLocationCore<TTool, ToolLocationMetadata<TIntegrationConfiguration>, TTool, 'tool'>;
|
|
2042
|
+
type ProjectToolLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<unknown, TIntegrationConfiguration>;
|
|
2043
|
+
type ProjectToolLocation<TTool, TIntegrationConfiguration = unknown> = MeshLocationCore<TTool, ProjectToolLocationMetadata<TIntegrationConfiguration>, TTool, 'projectTool'>;
|
|
2006
2044
|
|
|
2007
2045
|
interface SdkWindow {
|
|
2008
2046
|
/** The current window object. */
|
|
@@ -2107,4 +2145,4 @@ declare const hasPermissions: (permissions: MeshLocationUserPermissions | MeshLo
|
|
|
2107
2145
|
*/
|
|
2108
2146
|
declare const hasRole: (role: string, user: UniformUser) => boolean;
|
|
2109
2147
|
|
|
2110
|
-
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 DataConnectorInfo, type DataResourceLocation, type DataResourceLocationMetadata, type DataSourceLocation, type DataSourceLocationMetadata, type DataSourceLocationValue, type DataTypeLocation, type DataTypeLocationMetadata, type DataTypeLocationValue, type DialogContext, type DialogOptions, type DialogParamValue, type DialogParams, type DialogResponseData, type DialogResponseHandler, type DialogResponseHandlers, type DialogType, type DynamicInput, type DynamicInputs, type EditConnectedDataMessage, type EditConnectedDataResponse, type EditConnectedDataResponseCancellationContext, type EmbeddedEditorLocation, type EmbeddedEditorLocationMetadata, type EmbeddedEditorLocationSetValue, type EmbeddedEditorLocationValue, type FunctionCallResponse, type FunctionCallSystemParameter, type GetDataResourceLocation, type GetDataResourceMessage, IntegrationDefinitionClient, type IntegrationDefinitionDeleteParameters, type IntegrationDefinitionGetParameters, type IntegrationDefinitionGetResponse, type IntegrationDefinitionPutParameters, type IntegrationDefinitionPutResponse, IntegrationInstallationClient, type IntegrationInstallationDeleteParameters, type IntegrationInstallationGetParameters, type IntegrationInstallationGetResponse, type IntegrationInstallationPutParameters, type LocationDialogResponse, type MeshContextData, type MeshLocation, type MeshLocationCore, type MeshLocationTypes, type MeshLocationUserPermissions, type MeshRouter, type MeshSDKEventInterface, type NavigateMessage, type OpenConfirmationDialogOptions, type OpenConfirmationDialogResult, type OpenDialogMessage, type OpenDialogResult, type OpenLocationDialogOptions, type ParamTypeConfigLocation, type ParamTypeConfigLocationMetadata, type ParamTypeLocation, type ParamTypeLocationMetadata, type PersonalizationCriteriaLocation, type PersonalizationCriteriaLocationMetadata, type
|
|
2148
|
+
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 DataConnectorInfo, type DataResourceLocation, type DataResourceLocationMetadata, type DataSourceLocation, type DataSourceLocationMetadata, type DataSourceLocationValue, type DataTypeLocation, type DataTypeLocationMetadata, type DataTypeLocationValue, type DialogContext, type DialogOptions, type DialogParamValue, type DialogParams, type DialogResponseData, type DialogResponseHandler, type DialogResponseHandlers, type DialogType, type DynamicInput, type DynamicInputs, type EditConnectedDataMessage, type EditConnectedDataResponse, type EditConnectedDataResponseCancellationContext, type EmbeddedEditorLocation, type EmbeddedEditorLocationMetadata, type EmbeddedEditorLocationSetValue, type EmbeddedEditorLocationValue, type FunctionCallResponse, type FunctionCallSystemParameter, type GetDataResourceLocation, type GetDataResourceMessage, IntegrationDefinitionClient, type IntegrationDefinitionDeleteParameters, type IntegrationDefinitionGetParameters, type IntegrationDefinitionGetResponse, type IntegrationDefinitionPutParameters, type IntegrationDefinitionPutResponse, IntegrationInstallationClient, type IntegrationInstallationDeleteParameters, type IntegrationInstallationGetParameters, type IntegrationInstallationGetResponse, type IntegrationInstallationPutParameters, type LocationDialogResponse, type MeshContextData, type MeshLocation, type MeshLocationCore, type MeshLocationTypes, type MeshLocationUserPermissions, type MeshRouter, type MeshSDKEventInterface, type NavigateMessage, type OpenConfirmationDialogOptions, type OpenConfirmationDialogResult, type OpenDialogMessage, type OpenDialogResult, type OpenLocationDialogOptions, type ParamTypeConfigLocation, type ParamTypeConfigLocationMetadata, type ParamTypeLocation, type ParamTypeLocationMetadata, type PersonalizationCriteriaLocation, type PersonalizationCriteriaLocationMetadata, type ProjectToolLocation, type ProjectToolLocationMetadata, type PromptSettingsLocationMetadata, type SdkWindow, type SetLocationFunction, type SetValueMessage, type SetValueOptions, type SettingsLocation, type SettingsLocationMetadata, type UniformMeshSDK, type UniformMeshSDKEvents, type UniformUser, type ValidationResult, functionCallSystemParameters, hasPermissions, hasRole, initializeUniformMeshSDK, parseFunctionCall };
|
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.
|
|
134
|
+
var UNIFORM_MESH_SDK_VERSION = "20.18.0";
|
|
135
135
|
|
|
136
136
|
// src/framepost/constants.ts
|
|
137
137
|
var DEFAULT_REQUEST_TIMEOUT = 5e3;
|
|
@@ -552,9 +552,11 @@ var createSdkWindow = ({
|
|
|
552
552
|
}
|
|
553
553
|
const windowInstance = window;
|
|
554
554
|
const updateHeight = (height) => {
|
|
555
|
-
if (height
|
|
556
|
-
oldHeight
|
|
557
|
-
|
|
555
|
+
if (height) {
|
|
556
|
+
if (height !== oldHeight) {
|
|
557
|
+
oldHeight = height;
|
|
558
|
+
onHeightChange == null ? void 0 : onHeightChange(height);
|
|
559
|
+
}
|
|
558
560
|
return;
|
|
559
561
|
}
|
|
560
562
|
let maxBottom = windowInstance.document.documentElement.getBoundingClientRect().height;
|
|
@@ -625,6 +627,7 @@ var createSdkWindow = ({
|
|
|
625
627
|
childList: true,
|
|
626
628
|
subtree: true
|
|
627
629
|
});
|
|
630
|
+
updateHeight();
|
|
628
631
|
},
|
|
629
632
|
disableAutoResizing: () => {
|
|
630
633
|
observer == null ? void 0 : observer.disconnect();
|
|
@@ -742,7 +745,10 @@ async function initializeUniformMeshSDK({
|
|
|
742
745
|
// then we disable autoResizing for the dialog location.
|
|
743
746
|
// Otherwise, autoResizing will likely "overwrite" the specified `contentHeight` value, making
|
|
744
747
|
// developers very sad and confused. No one wants a sad and confused developer.
|
|
745
|
-
autoResizingDisabled
|
|
748
|
+
// Another case for explicit autoResizingDisabled flag is Full Screen Height from the parent (e.g. asset library location),
|
|
749
|
+
// so by default it will be stretch to the maximum height of the parent.
|
|
750
|
+
// Can still be manually enabled by calling sdk.currentWindow?.enableAutoResizing() in mesh app.
|
|
751
|
+
autoResizingDisabled: ((_a = contextData.dialogContext) == null ? void 0 : _a.contentHeight) || contextData.fullScreenHeight ? true : autoResizingDisabled
|
|
746
752
|
}),
|
|
747
753
|
version: contextData.uniformApiVersion,
|
|
748
754
|
openLocationDialog: async ({
|
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.
|
|
175
|
+
var UNIFORM_MESH_SDK_VERSION = "20.18.0";
|
|
176
176
|
|
|
177
177
|
// src/framepost/constants.ts
|
|
178
178
|
var DEFAULT_REQUEST_TIMEOUT = 5e3;
|
|
@@ -593,9 +593,11 @@ var createSdkWindow = ({
|
|
|
593
593
|
}
|
|
594
594
|
const windowInstance = window;
|
|
595
595
|
const updateHeight = (height) => {
|
|
596
|
-
if (height
|
|
597
|
-
oldHeight
|
|
598
|
-
|
|
596
|
+
if (height) {
|
|
597
|
+
if (height !== oldHeight) {
|
|
598
|
+
oldHeight = height;
|
|
599
|
+
onHeightChange == null ? void 0 : onHeightChange(height);
|
|
600
|
+
}
|
|
599
601
|
return;
|
|
600
602
|
}
|
|
601
603
|
let maxBottom = windowInstance.document.documentElement.getBoundingClientRect().height;
|
|
@@ -666,6 +668,7 @@ var createSdkWindow = ({
|
|
|
666
668
|
childList: true,
|
|
667
669
|
subtree: true
|
|
668
670
|
});
|
|
671
|
+
updateHeight();
|
|
669
672
|
},
|
|
670
673
|
disableAutoResizing: () => {
|
|
671
674
|
observer == null ? void 0 : observer.disconnect();
|
|
@@ -783,7 +786,10 @@ async function initializeUniformMeshSDK({
|
|
|
783
786
|
// then we disable autoResizing for the dialog location.
|
|
784
787
|
// Otherwise, autoResizing will likely "overwrite" the specified `contentHeight` value, making
|
|
785
788
|
// developers very sad and confused. No one wants a sad and confused developer.
|
|
786
|
-
autoResizingDisabled
|
|
789
|
+
// Another case for explicit autoResizingDisabled flag is Full Screen Height from the parent (e.g. asset library location),
|
|
790
|
+
// so by default it will be stretch to the maximum height of the parent.
|
|
791
|
+
// Can still be manually enabled by calling sdk.currentWindow?.enableAutoResizing() in mesh app.
|
|
792
|
+
autoResizingDisabled: ((_a = contextData.dialogContext) == null ? void 0 : _a.contentHeight) || contextData.fullScreenHeight ? true : autoResizingDisabled
|
|
787
793
|
}),
|
|
788
794
|
version: contextData.uniformApiVersion,
|
|
789
795
|
openLocationDialog: async ({
|
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.
|
|
134
|
+
var UNIFORM_MESH_SDK_VERSION = "20.18.0";
|
|
135
135
|
|
|
136
136
|
// src/framepost/constants.ts
|
|
137
137
|
var DEFAULT_REQUEST_TIMEOUT = 5e3;
|
|
@@ -552,9 +552,11 @@ var createSdkWindow = ({
|
|
|
552
552
|
}
|
|
553
553
|
const windowInstance = window;
|
|
554
554
|
const updateHeight = (height) => {
|
|
555
|
-
if (height
|
|
556
|
-
oldHeight
|
|
557
|
-
|
|
555
|
+
if (height) {
|
|
556
|
+
if (height !== oldHeight) {
|
|
557
|
+
oldHeight = height;
|
|
558
|
+
onHeightChange == null ? void 0 : onHeightChange(height);
|
|
559
|
+
}
|
|
558
560
|
return;
|
|
559
561
|
}
|
|
560
562
|
let maxBottom = windowInstance.document.documentElement.getBoundingClientRect().height;
|
|
@@ -625,6 +627,7 @@ var createSdkWindow = ({
|
|
|
625
627
|
childList: true,
|
|
626
628
|
subtree: true
|
|
627
629
|
});
|
|
630
|
+
updateHeight();
|
|
628
631
|
},
|
|
629
632
|
disableAutoResizing: () => {
|
|
630
633
|
observer == null ? void 0 : observer.disconnect();
|
|
@@ -742,7 +745,10 @@ async function initializeUniformMeshSDK({
|
|
|
742
745
|
// then we disable autoResizing for the dialog location.
|
|
743
746
|
// Otherwise, autoResizing will likely "overwrite" the specified `contentHeight` value, making
|
|
744
747
|
// developers very sad and confused. No one wants a sad and confused developer.
|
|
745
|
-
autoResizingDisabled
|
|
748
|
+
// Another case for explicit autoResizingDisabled flag is Full Screen Height from the parent (e.g. asset library location),
|
|
749
|
+
// so by default it will be stretch to the maximum height of the parent.
|
|
750
|
+
// Can still be manually enabled by calling sdk.currentWindow?.enableAutoResizing() in mesh app.
|
|
751
|
+
autoResizingDisabled: ((_a = contextData.dialogContext) == null ? void 0 : _a.contentHeight) || contextData.fullScreenHeight ? true : autoResizingDisabled
|
|
746
752
|
}),
|
|
747
753
|
version: contextData.uniformApiVersion,
|
|
748
754
|
openLocationDialog: async ({
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@uniformdev/mesh-sdk",
|
|
3
|
-
"version": "20.12.1-alpha.
|
|
3
|
+
"version": "20.12.1-alpha.28+28cc2dd35d",
|
|
4
4
|
"description": "Uniform Mesh Framework SDK",
|
|
5
5
|
"license": "SEE LICENSE IN LICENSE.txt",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -34,16 +34,16 @@
|
|
|
34
34
|
"access": "public"
|
|
35
35
|
},
|
|
36
36
|
"dependencies": {
|
|
37
|
-
"@uniformdev/assets": "20.12.1-alpha.
|
|
38
|
-
"@uniformdev/canvas": "20.12.1-alpha.
|
|
39
|
-
"@uniformdev/context": "20.12.1-alpha.
|
|
40
|
-
"@uniformdev/project-map": "20.12.1-alpha.
|
|
37
|
+
"@uniformdev/assets": "20.12.1-alpha.28+28cc2dd35d",
|
|
38
|
+
"@uniformdev/canvas": "20.12.1-alpha.28+28cc2dd35d",
|
|
39
|
+
"@uniformdev/context": "20.12.1-alpha.28+28cc2dd35d",
|
|
40
|
+
"@uniformdev/project-map": "20.12.1-alpha.28+28cc2dd35d",
|
|
41
41
|
"imagesloaded": "^5.0.0",
|
|
42
42
|
"mitt": "^3.0.1"
|
|
43
43
|
},
|
|
44
44
|
"devDependencies": {
|
|
45
45
|
"@types/imagesloaded": "^4.1.2",
|
|
46
|
-
"openai": "
|
|
46
|
+
"openai": "4.94.0"
|
|
47
47
|
},
|
|
48
|
-
"gitHead": "
|
|
48
|
+
"gitHead": "28cc2dd35d9b1ec7c31e72bd0c562341765cef9d"
|
|
49
49
|
}
|