@uniformdev/mesh-sdk 19.149.0 → 19.149.1-alpha.1

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.
Files changed (3) hide show
  1. package/dist/index.d.mts +36 -4
  2. package/dist/index.d.ts +36 -4
  3. package/package.json +5 -5
package/dist/index.d.mts CHANGED
@@ -68,6 +68,9 @@ interface paths$1 {
68
68
  /** @enum {string} */
69
69
  localizable?: "default-yes" | "default-no" | "yes" | "no";
70
70
  }[];
71
+ sideRail?: {
72
+ url: string;
73
+ };
71
74
  };
72
75
  dataConnectors?: {
73
76
  type: string;
@@ -220,6 +223,9 @@ interface paths$1 {
220
223
  /** @enum {string} */
221
224
  localizable?: "default-yes" | "default-no" | "yes" | "no";
222
225
  }[];
226
+ sideRail?: {
227
+ url: string;
228
+ };
223
229
  };
224
230
  dataConnectors?: {
225
231
  type: string;
@@ -371,6 +377,9 @@ interface paths$1 {
371
377
  /** @enum {string} */
372
378
  localizable?: "default-yes" | "default-no" | "yes" | "no";
373
379
  }[];
380
+ sideRail?: {
381
+ url: string;
382
+ };
374
383
  };
375
384
  dataConnectors?: {
376
385
  type: string;
@@ -770,6 +779,9 @@ declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
770
779
  renderableInPropertyPanel?: boolean | undefined;
771
780
  localizable?: "default-yes" | "default-no" | "yes" | "no" | undefined;
772
781
  }[];
782
+ sideRail?: {
783
+ url: string;
784
+ } | undefined;
773
785
  } | undefined;
774
786
  dataConnectors?: {
775
787
  type: string;
@@ -971,14 +983,20 @@ type ParamTypeLocation<TParamValue = unknown, TParamConfiguration = unknown, TPa
971
983
  editConnectedData: Awaited<ReturnType<typeof connectToParent>>['parent']['editConnectedData'];
972
984
  };
973
985
 
974
- type SettingsLocationMetadata = CommonMetadata;
986
+ type SettingsLocationMetadata = CommonMetadata & {
987
+ locales: {
988
+ locale: string;
989
+ displayName: string;
990
+ isDefault: boolean;
991
+ }[];
992
+ };
975
993
  type SettingsLocation<TSettingsType> = MeshLocationCore<TSettingsType, SettingsLocationMetadata, TSettingsType, 'settings'>;
976
994
 
977
995
  /**
978
996
  * Defines methods used for interacting with a Mesh location
979
997
  * To receive useful typings, check the `type` property of the location to narrow the typing.
980
998
  */
981
- type MeshLocation<TValue = unknown, TSetValue = TValue> = ParamTypeLocation<TValue, unknown, TSetValue> | ParamTypeConfigLocation<TValue> | SettingsLocation<TValue> | AssetLibraryLocation | AssetParameterLocation | DataSourceLocation | DataTypeLocation | DataResourceLocation | AIGenerateLocation<TValue> | AIPromptMetadataLocation;
999
+ type MeshLocation<TValue = unknown, TSetValue = TValue> = ParamTypeLocation<TValue, unknown, TSetValue> | ParamTypeConfigLocation<TValue> | SettingsLocation<TValue> | AssetLibraryLocation | AssetParameterLocation | DataSourceLocation | DataTypeLocation | DataResourceLocation | CanvasEditorSideRailLocation | AIGenerateLocation<TValue> | AIPromptMetadataLocation;
982
1000
  interface MeshContextData {
983
1001
  locationKey: string;
984
1002
  locationType: MeshLocationTypes;
@@ -1282,7 +1300,7 @@ type MeshLocationUserPermissions =
1282
1300
  /**
1283
1301
  * Known location types that can be passed to a mesh location
1284
1302
  */
1285
- type MeshLocationTypes = 'paramType' | 'paramTypeConfig' | 'assetLibrary' | 'assetParameter' | 'settings' | 'dataSource' | 'dataType' | 'dataResource' | 'aiGenerate' | 'aiMetadata';
1303
+ type MeshLocationTypes = 'paramType' | 'paramTypeConfig' | 'assetLibrary' | 'assetParameter' | 'settings' | 'dataSource' | 'dataType' | 'dataResource' | 'aiGenerate' | 'canvasEditorSideRail' | 'aiMetadata';
1286
1304
  type SetValueOptions = ValidationResult;
1287
1305
  type SetValueMessage = {
1288
1306
  uniformMeshLocationValue: unknown;
@@ -1321,6 +1339,20 @@ type PromptSettingsLocationMetadata<TIntegrationConfiguration = unknown> = Commo
1321
1339
  type AIGenerateLocation<TType> = MeshLocationCore<TType, AIGenerateLocationMetadata, TType, 'aiGenerate'>;
1322
1340
  type AIPromptMetadataLocation = MeshLocationCore<Record<string, unknown>, PromptSettingsLocationMetadata, Record<string, unknown>, 'aiMetadata'>;
1323
1341
 
1342
+ type CanvasEditorSideRailLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
1343
+ projectMapNode?: any;
1344
+ locales: {
1345
+ locale: string;
1346
+ displayName: string;
1347
+ isDefault: boolean;
1348
+ }[];
1349
+ }, TIntegrationConfiguration>;
1350
+ type CanvasEditorSideRailData = {
1351
+ rootEntity: any;
1352
+ references: any[];
1353
+ };
1354
+ type CanvasEditorSideRailLocation = MeshLocationCore<CanvasEditorSideRailData, CanvasEditorSideRailLocationMetadata, CanvasEditorSideRailData, 'canvasEditorSideRail'> & GetDataResourceLocation;
1355
+
1324
1356
  type ParamTypeConfigLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
1325
1357
  /** The Uniform project ID */
1326
1358
  componentDefinition: ComponentDefinition;
@@ -1430,4 +1462,4 @@ declare const hasPermissions: (permissions: MeshLocationUserPermissions | MeshLo
1430
1462
  */
1431
1463
  declare const hasRole: (role: string, user: UniformUser) => boolean;
1432
1464
 
1433
- export { type AIGenerateLocation, type AIGenerateLocationMetadata, type AIPromptMetadataLocation, type AssetLibraryLocation, type AssetLibraryLocationMetadata, type AssetParameterLocation, type AssetParameterLocationMetadata, type BindableTypes, type CSSHeight, 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 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 MeshSDKEventInterface, type OpenConfirmationDialogOptions, type OpenConfirmationDialogResult, type OpenDialogMessage, type OpenDialogResult, type OpenLocationDialogOptions, type ParamTypeConfigLocation, type ParamTypeConfigLocationMetadata, type ParamTypeLocation, type ParamTypeLocationMetadata, type PromptSettingsLocationMetadata, type SdkWindow, type SetLocationFunction, type SetValueMessage, type SetValueOptions, type SettingsLocation, type SettingsLocationMetadata, type UniformMeshSDK, type UniformMeshSDKEvents, type UniformUser, type ValidationResult, hasPermissions, hasRole, initializeUniformMeshSDK };
1465
+ export { type AIGenerateLocation, type AIGenerateLocationMetadata, type AIPromptMetadataLocation, type AssetLibraryLocation, type AssetLibraryLocationMetadata, type AssetParameterLocation, type AssetParameterLocationMetadata, type BindableTypes, type CSSHeight, type CanvasEditorSideRailData, type CanvasEditorSideRailLocation, type CanvasEditorSideRailLocationMetadata, 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 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 MeshSDKEventInterface, type OpenConfirmationDialogOptions, type OpenConfirmationDialogResult, type OpenDialogMessage, type OpenDialogResult, type OpenLocationDialogOptions, type ParamTypeConfigLocation, type ParamTypeConfigLocationMetadata, type ParamTypeLocation, type ParamTypeLocationMetadata, type PromptSettingsLocationMetadata, type SdkWindow, type SetLocationFunction, type SetValueMessage, type SetValueOptions, type SettingsLocation, type SettingsLocationMetadata, type UniformMeshSDK, type UniformMeshSDKEvents, type UniformUser, type ValidationResult, hasPermissions, hasRole, initializeUniformMeshSDK };
package/dist/index.d.ts CHANGED
@@ -68,6 +68,9 @@ interface paths$1 {
68
68
  /** @enum {string} */
69
69
  localizable?: "default-yes" | "default-no" | "yes" | "no";
70
70
  }[];
71
+ sideRail?: {
72
+ url: string;
73
+ };
71
74
  };
72
75
  dataConnectors?: {
73
76
  type: string;
@@ -220,6 +223,9 @@ interface paths$1 {
220
223
  /** @enum {string} */
221
224
  localizable?: "default-yes" | "default-no" | "yes" | "no";
222
225
  }[];
226
+ sideRail?: {
227
+ url: string;
228
+ };
223
229
  };
224
230
  dataConnectors?: {
225
231
  type: string;
@@ -371,6 +377,9 @@ interface paths$1 {
371
377
  /** @enum {string} */
372
378
  localizable?: "default-yes" | "default-no" | "yes" | "no";
373
379
  }[];
380
+ sideRail?: {
381
+ url: string;
382
+ };
374
383
  };
375
384
  dataConnectors?: {
376
385
  type: string;
@@ -770,6 +779,9 @@ declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
770
779
  renderableInPropertyPanel?: boolean | undefined;
771
780
  localizable?: "default-yes" | "default-no" | "yes" | "no" | undefined;
772
781
  }[];
782
+ sideRail?: {
783
+ url: string;
784
+ } | undefined;
773
785
  } | undefined;
774
786
  dataConnectors?: {
775
787
  type: string;
@@ -971,14 +983,20 @@ type ParamTypeLocation<TParamValue = unknown, TParamConfiguration = unknown, TPa
971
983
  editConnectedData: Awaited<ReturnType<typeof connectToParent>>['parent']['editConnectedData'];
972
984
  };
973
985
 
974
- type SettingsLocationMetadata = CommonMetadata;
986
+ type SettingsLocationMetadata = CommonMetadata & {
987
+ locales: {
988
+ locale: string;
989
+ displayName: string;
990
+ isDefault: boolean;
991
+ }[];
992
+ };
975
993
  type SettingsLocation<TSettingsType> = MeshLocationCore<TSettingsType, SettingsLocationMetadata, TSettingsType, 'settings'>;
976
994
 
977
995
  /**
978
996
  * Defines methods used for interacting with a Mesh location
979
997
  * To receive useful typings, check the `type` property of the location to narrow the typing.
980
998
  */
981
- type MeshLocation<TValue = unknown, TSetValue = TValue> = ParamTypeLocation<TValue, unknown, TSetValue> | ParamTypeConfigLocation<TValue> | SettingsLocation<TValue> | AssetLibraryLocation | AssetParameterLocation | DataSourceLocation | DataTypeLocation | DataResourceLocation | AIGenerateLocation<TValue> | AIPromptMetadataLocation;
999
+ type MeshLocation<TValue = unknown, TSetValue = TValue> = ParamTypeLocation<TValue, unknown, TSetValue> | ParamTypeConfigLocation<TValue> | SettingsLocation<TValue> | AssetLibraryLocation | AssetParameterLocation | DataSourceLocation | DataTypeLocation | DataResourceLocation | CanvasEditorSideRailLocation | AIGenerateLocation<TValue> | AIPromptMetadataLocation;
982
1000
  interface MeshContextData {
983
1001
  locationKey: string;
984
1002
  locationType: MeshLocationTypes;
@@ -1282,7 +1300,7 @@ type MeshLocationUserPermissions =
1282
1300
  /**
1283
1301
  * Known location types that can be passed to a mesh location
1284
1302
  */
1285
- type MeshLocationTypes = 'paramType' | 'paramTypeConfig' | 'assetLibrary' | 'assetParameter' | 'settings' | 'dataSource' | 'dataType' | 'dataResource' | 'aiGenerate' | 'aiMetadata';
1303
+ type MeshLocationTypes = 'paramType' | 'paramTypeConfig' | 'assetLibrary' | 'assetParameter' | 'settings' | 'dataSource' | 'dataType' | 'dataResource' | 'aiGenerate' | 'canvasEditorSideRail' | 'aiMetadata';
1286
1304
  type SetValueOptions = ValidationResult;
1287
1305
  type SetValueMessage = {
1288
1306
  uniformMeshLocationValue: unknown;
@@ -1321,6 +1339,20 @@ type PromptSettingsLocationMetadata<TIntegrationConfiguration = unknown> = Commo
1321
1339
  type AIGenerateLocation<TType> = MeshLocationCore<TType, AIGenerateLocationMetadata, TType, 'aiGenerate'>;
1322
1340
  type AIPromptMetadataLocation = MeshLocationCore<Record<string, unknown>, PromptSettingsLocationMetadata, Record<string, unknown>, 'aiMetadata'>;
1323
1341
 
1342
+ type CanvasEditorSideRailLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
1343
+ projectMapNode?: any;
1344
+ locales: {
1345
+ locale: string;
1346
+ displayName: string;
1347
+ isDefault: boolean;
1348
+ }[];
1349
+ }, TIntegrationConfiguration>;
1350
+ type CanvasEditorSideRailData = {
1351
+ rootEntity: any;
1352
+ references: any[];
1353
+ };
1354
+ type CanvasEditorSideRailLocation = MeshLocationCore<CanvasEditorSideRailData, CanvasEditorSideRailLocationMetadata, CanvasEditorSideRailData, 'canvasEditorSideRail'> & GetDataResourceLocation;
1355
+
1324
1356
  type ParamTypeConfigLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
1325
1357
  /** The Uniform project ID */
1326
1358
  componentDefinition: ComponentDefinition;
@@ -1430,4 +1462,4 @@ declare const hasPermissions: (permissions: MeshLocationUserPermissions | MeshLo
1430
1462
  */
1431
1463
  declare const hasRole: (role: string, user: UniformUser) => boolean;
1432
1464
 
1433
- export { type AIGenerateLocation, type AIGenerateLocationMetadata, type AIPromptMetadataLocation, type AssetLibraryLocation, type AssetLibraryLocationMetadata, type AssetParameterLocation, type AssetParameterLocationMetadata, type BindableTypes, type CSSHeight, 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 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 MeshSDKEventInterface, type OpenConfirmationDialogOptions, type OpenConfirmationDialogResult, type OpenDialogMessage, type OpenDialogResult, type OpenLocationDialogOptions, type ParamTypeConfigLocation, type ParamTypeConfigLocationMetadata, type ParamTypeLocation, type ParamTypeLocationMetadata, type PromptSettingsLocationMetadata, type SdkWindow, type SetLocationFunction, type SetValueMessage, type SetValueOptions, type SettingsLocation, type SettingsLocationMetadata, type UniformMeshSDK, type UniformMeshSDKEvents, type UniformUser, type ValidationResult, hasPermissions, hasRole, initializeUniformMeshSDK };
1465
+ export { type AIGenerateLocation, type AIGenerateLocationMetadata, type AIPromptMetadataLocation, type AssetLibraryLocation, type AssetLibraryLocationMetadata, type AssetParameterLocation, type AssetParameterLocationMetadata, type BindableTypes, type CSSHeight, type CanvasEditorSideRailData, type CanvasEditorSideRailLocation, type CanvasEditorSideRailLocationMetadata, 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 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 MeshSDKEventInterface, type OpenConfirmationDialogOptions, type OpenConfirmationDialogResult, type OpenDialogMessage, type OpenDialogResult, type OpenLocationDialogOptions, type ParamTypeConfigLocation, type ParamTypeConfigLocationMetadata, type ParamTypeLocation, type ParamTypeLocationMetadata, type PromptSettingsLocationMetadata, type SdkWindow, type SetLocationFunction, type SetValueMessage, type SetValueOptions, type SettingsLocation, type SettingsLocationMetadata, type UniformMeshSDK, type UniformMeshSDKEvents, type UniformUser, type ValidationResult, hasPermissions, hasRole, initializeUniformMeshSDK };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uniformdev/mesh-sdk",
3
- "version": "19.149.0",
3
+ "version": "19.149.1-alpha.1+55ee398800",
4
4
  "description": "Uniform Mesh Framework SDK",
5
5
  "license": "SEE LICENSE IN LICENSE.txt",
6
6
  "main": "./dist/index.js",
@@ -33,14 +33,14 @@
33
33
  "access": "public"
34
34
  },
35
35
  "dependencies": {
36
- "@uniformdev/canvas": "19.149.0",
37
- "@uniformdev/context": "19.149.0",
38
- "@uniformdev/project-map": "19.149.0",
36
+ "@uniformdev/canvas": "19.149.1-alpha.1+55ee398800",
37
+ "@uniformdev/context": "19.149.1-alpha.1+55ee398800",
38
+ "@uniformdev/project-map": "19.149.1-alpha.1+55ee398800",
39
39
  "imagesloaded": "^5.0.0",
40
40
  "mitt": "^3.0.0"
41
41
  },
42
42
  "devDependencies": {
43
43
  "@types/imagesloaded": "^4.1.2"
44
44
  },
45
- "gitHead": "fb8b8ed8fe0f1872070ef3ece9961f2970f7f17a"
45
+ "gitHead": "55ee398800ebfebe4d493572e47f5474b6125ddf"
46
46
  }