@uniformdev/mesh-sdk 19.79.0 → 19.79.1-alpha.7
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 +69 -85
- package/dist/index.d.ts +69 -85
- package/package.json +5 -5
package/dist/index.d.mts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { ApiClient, ClientOptions, ExceptProject } from '@uniformdev/context/api';
|
|
2
2
|
import { ProjectMapNode } from '@uniformdev/project-map';
|
|
3
|
-
import {
|
|
3
|
+
import { AssetParamValue, DataType, DataSource, DataResourceVariables, RootComponentInstance, ComponentInstance, ComponentDefinition, ComponentDefinitionParameter, DataVariableDefinition } from '@uniformdev/canvas';
|
|
4
|
+
export { AssetParamValue, AssetParamValueItem } from '@uniformdev/canvas';
|
|
4
5
|
import { Emitter } from 'mitt';
|
|
5
6
|
|
|
6
7
|
/**
|
|
@@ -63,6 +64,8 @@ interface paths$1 {
|
|
|
63
64
|
};
|
|
64
65
|
};
|
|
65
66
|
renderableInPropertyPanel?: boolean;
|
|
67
|
+
/** @enum {string} */
|
|
68
|
+
localizable?: "default-yes" | "default-no" | "yes" | "no";
|
|
66
69
|
}[];
|
|
67
70
|
};
|
|
68
71
|
dataConnectors?: {
|
|
@@ -93,6 +96,15 @@ interface paths$1 {
|
|
|
93
96
|
};
|
|
94
97
|
badgeIconUrl?: string;
|
|
95
98
|
}[];
|
|
99
|
+
assetLibrary?: {
|
|
100
|
+
assetLibraryUrl: string;
|
|
101
|
+
assetParameterUrl: string;
|
|
102
|
+
unstable_dynamicAssets?: {
|
|
103
|
+
dataConnectorId: string;
|
|
104
|
+
assetsListArchetypeId: string;
|
|
105
|
+
singleAssetArchetypeId: string;
|
|
106
|
+
};
|
|
107
|
+
};
|
|
96
108
|
unstable_assetLibrary?: {
|
|
97
109
|
url: string;
|
|
98
110
|
dynamicAssets?: {
|
|
@@ -203,6 +215,8 @@ interface paths$1 {
|
|
|
203
215
|
};
|
|
204
216
|
};
|
|
205
217
|
renderableInPropertyPanel?: boolean;
|
|
218
|
+
/** @enum {string} */
|
|
219
|
+
localizable?: "default-yes" | "default-no" | "yes" | "no";
|
|
206
220
|
}[];
|
|
207
221
|
};
|
|
208
222
|
dataConnectors?: {
|
|
@@ -233,6 +247,15 @@ interface paths$1 {
|
|
|
233
247
|
};
|
|
234
248
|
badgeIconUrl?: string;
|
|
235
249
|
}[];
|
|
250
|
+
assetLibrary?: {
|
|
251
|
+
assetLibraryUrl: string;
|
|
252
|
+
assetParameterUrl: string;
|
|
253
|
+
unstable_dynamicAssets?: {
|
|
254
|
+
dataConnectorId: string;
|
|
255
|
+
assetsListArchetypeId: string;
|
|
256
|
+
singleAssetArchetypeId: string;
|
|
257
|
+
};
|
|
258
|
+
};
|
|
236
259
|
unstable_assetLibrary?: {
|
|
237
260
|
url: string;
|
|
238
261
|
dynamicAssets?: {
|
|
@@ -342,6 +365,8 @@ interface paths$1 {
|
|
|
342
365
|
};
|
|
343
366
|
};
|
|
344
367
|
renderableInPropertyPanel?: boolean;
|
|
368
|
+
/** @enum {string} */
|
|
369
|
+
localizable?: "default-yes" | "default-no" | "yes" | "no";
|
|
345
370
|
}[];
|
|
346
371
|
};
|
|
347
372
|
dataConnectors?: {
|
|
@@ -372,6 +397,15 @@ interface paths$1 {
|
|
|
372
397
|
};
|
|
373
398
|
badgeIconUrl?: string;
|
|
374
399
|
}[];
|
|
400
|
+
assetLibrary?: {
|
|
401
|
+
assetLibraryUrl: string;
|
|
402
|
+
assetParameterUrl: string;
|
|
403
|
+
unstable_dynamicAssets?: {
|
|
404
|
+
dataConnectorId: string;
|
|
405
|
+
assetsListArchetypeId: string;
|
|
406
|
+
singleAssetArchetypeId: string;
|
|
407
|
+
};
|
|
408
|
+
};
|
|
375
409
|
unstable_assetLibrary?: {
|
|
376
410
|
url: string;
|
|
377
411
|
dynamicAssets?: {
|
|
@@ -730,6 +764,7 @@ declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
|
|
|
730
764
|
};
|
|
731
765
|
} | undefined;
|
|
732
766
|
renderableInPropertyPanel?: boolean | undefined;
|
|
767
|
+
localizable?: "default-yes" | "default-no" | "yes" | "no" | undefined;
|
|
733
768
|
}[];
|
|
734
769
|
} | undefined;
|
|
735
770
|
dataConnectors?: {
|
|
@@ -760,6 +795,15 @@ declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
|
|
|
760
795
|
} | undefined;
|
|
761
796
|
badgeIconUrl?: string | undefined;
|
|
762
797
|
}[] | undefined;
|
|
798
|
+
assetLibrary?: {
|
|
799
|
+
assetLibraryUrl: string;
|
|
800
|
+
assetParameterUrl: string;
|
|
801
|
+
unstable_dynamicAssets?: {
|
|
802
|
+
dataConnectorId: string;
|
|
803
|
+
assetsListArchetypeId: string;
|
|
804
|
+
singleAssetArchetypeId: string;
|
|
805
|
+
} | undefined;
|
|
806
|
+
} | undefined;
|
|
763
807
|
unstable_assetLibrary?: {
|
|
764
808
|
url: string;
|
|
765
809
|
dynamicAssets?: {
|
|
@@ -839,14 +883,16 @@ type AssetLibraryLocationMetadata<TIntegrationConfiguration = unknown> = {
|
|
|
839
883
|
projectId: string;
|
|
840
884
|
/** The current Uniform integration source ID */
|
|
841
885
|
sourceId: string;
|
|
886
|
+
};
|
|
887
|
+
type AssetParameterLocationMetadata<TIntegrationConfiguration = unknown> = {
|
|
888
|
+
/** Settings defined at the integration level (arbitrary type used on settings location) */
|
|
889
|
+
settings: TIntegrationConfiguration;
|
|
890
|
+
/** The Uniform project ID */
|
|
891
|
+
projectId: string;
|
|
892
|
+
/** The current Uniform integration source ID */
|
|
893
|
+
sourceId: string;
|
|
842
894
|
/** The resolved data if this source is connected to a data resource */
|
|
843
895
|
dataResourceData?: unknown;
|
|
844
|
-
/**
|
|
845
|
-
* Asset Library location is used in two places: Global Asset Library and Asset Parameter.
|
|
846
|
-
* This flag is necessary to distinguish between the two, because Parameter context requires
|
|
847
|
-
* "value" and "setValue" properties to manipulate the value of the parameter.
|
|
848
|
-
*/
|
|
849
|
-
isAssetParameterContext: boolean;
|
|
850
896
|
/**
|
|
851
897
|
* The maximum number of assets that can be selected in the Asset Library.
|
|
852
898
|
*
|
|
@@ -854,81 +900,8 @@ type AssetLibraryLocationMetadata<TIntegrationConfiguration = unknown> = {
|
|
|
854
900
|
*/
|
|
855
901
|
maxAssets?: number;
|
|
856
902
|
};
|
|
857
|
-
type
|
|
858
|
-
type
|
|
859
|
-
type: string;
|
|
860
|
-
_id: string;
|
|
861
|
-
/**
|
|
862
|
-
* Internal Uniform source ID or
|
|
863
|
-
* dataType ID of the global integration library
|
|
864
|
-
* which created this asset item
|
|
865
|
-
*/
|
|
866
|
-
_source?: string;
|
|
867
|
-
fields: {
|
|
868
|
-
url: {
|
|
869
|
-
type: 'text';
|
|
870
|
-
value: string;
|
|
871
|
-
};
|
|
872
|
-
id?: {
|
|
873
|
-
type: 'text';
|
|
874
|
-
value: string | undefined;
|
|
875
|
-
};
|
|
876
|
-
title?: {
|
|
877
|
-
type: 'text';
|
|
878
|
-
value: string | undefined;
|
|
879
|
-
};
|
|
880
|
-
description?: {
|
|
881
|
-
type: 'text';
|
|
882
|
-
value: string | undefined;
|
|
883
|
-
};
|
|
884
|
-
mediaType?: {
|
|
885
|
-
type: 'text';
|
|
886
|
-
value: string | undefined;
|
|
887
|
-
};
|
|
888
|
-
/**
|
|
889
|
-
* The width of the original asset
|
|
890
|
-
*
|
|
891
|
-
* Should resolve to a number but might
|
|
892
|
-
* be a string with a pointer reference
|
|
893
|
-
*/
|
|
894
|
-
width?: {
|
|
895
|
-
type: 'number';
|
|
896
|
-
value: number | string | undefined;
|
|
897
|
-
};
|
|
898
|
-
/**
|
|
899
|
-
* The height of the original asset
|
|
900
|
-
*
|
|
901
|
-
* Should resolve to a number but might
|
|
902
|
-
* be a string with a pointer reference
|
|
903
|
-
*/
|
|
904
|
-
height?: {
|
|
905
|
-
type: 'number';
|
|
906
|
-
value: number | string | undefined;
|
|
907
|
-
};
|
|
908
|
-
/**
|
|
909
|
-
* The size in bytes of the original asset
|
|
910
|
-
*
|
|
911
|
-
* Should resolve to a number but might
|
|
912
|
-
* be a string with a pointer reference
|
|
913
|
-
*/
|
|
914
|
-
size?: {
|
|
915
|
-
type: 'number';
|
|
916
|
-
value: number | string | undefined;
|
|
917
|
-
};
|
|
918
|
-
/**
|
|
919
|
-
* Any key/value properties which the source
|
|
920
|
-
* wants to attach to the asset data
|
|
921
|
-
*/
|
|
922
|
-
custom?: {
|
|
923
|
-
type: string;
|
|
924
|
-
value: Record<string, unknown>;
|
|
925
|
-
};
|
|
926
|
-
};
|
|
927
|
-
_overrides?: {
|
|
928
|
-
fields: ComponentOverride['parameters'];
|
|
929
|
-
};
|
|
930
|
-
};
|
|
931
|
-
type AssetLibraryLocation = MeshLocationCore<AssetParamValue, AssetLibraryLocationMetadata, AssetParamValue, 'assetLibrary'> & GetDataResourceLocation;
|
|
903
|
+
type AssetLibraryLocation = MeshLocationCore<unknown, AssetLibraryLocationMetadata, unknown, 'assetLibrary'> & GetDataResourceLocation;
|
|
904
|
+
type AssetParameterLocation = MeshLocationCore<AssetParamValue, AssetParameterLocationMetadata, AssetParamValue, 'assetParameter'> & GetDataResourceLocation;
|
|
932
905
|
|
|
933
906
|
type DataTypeLocationValue = Pick<DataType, 'body' | 'method' | 'path' | 'custom' | 'headers' | 'parameters' | 'variables'>;
|
|
934
907
|
type DataConnectorInfo = {
|
|
@@ -1004,6 +977,13 @@ type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfig
|
|
|
1004
977
|
* Use the <ParamTypeDynamicDataProvider> to wire up dynamic data in your parameter.
|
|
1005
978
|
*/
|
|
1006
979
|
connectedData: Record<string, unknown>;
|
|
980
|
+
/**
|
|
981
|
+
* The target locale being edited.
|
|
982
|
+
* If the parameter is not defined as localizable, then this is always undefined.
|
|
983
|
+
* If the parameter is localizable, then this is the current editor language.
|
|
984
|
+
* Note that setValue() always sets the target language automatically.
|
|
985
|
+
*/
|
|
986
|
+
targetLocale: string | undefined;
|
|
1007
987
|
};
|
|
1008
988
|
type ParamTypeLocation<TParamValue = unknown, TParamConfiguration = unknown, TParamSetValue = TParamValue, TIntegrationConfiguration = unknown> = MeshLocationCore<TParamValue | undefined, ParamTypeLocationMetadata<TParamConfiguration, TIntegrationConfiguration>, TParamSetValue, 'paramType'> & {
|
|
1009
989
|
/**
|
|
@@ -1022,7 +1002,7 @@ type SettingsLocation<TSettingsType> = MeshLocationCore<TSettingsType, SettingsL
|
|
|
1022
1002
|
* Defines methods used for interacting with a Mesh location
|
|
1023
1003
|
* To receive useful typings, check the `type` property of the location to narrow the typing.
|
|
1024
1004
|
*/
|
|
1025
|
-
type MeshLocation<TValue = unknown, TSetValue = TValue> = ParamTypeLocation<TValue, unknown, TSetValue> | ParamTypeConfigLocation<TValue> | SettingsLocation<TValue> | AssetLibraryLocation | DataSourceLocation | DataTypeLocation | DataResourceLocation | AIGenerateLocation<TValue> | AIPromptMetadataLocation;
|
|
1005
|
+
type MeshLocation<TValue = unknown, TSetValue = TValue> = ParamTypeLocation<TValue, unknown, TSetValue> | ParamTypeConfigLocation<TValue> | SettingsLocation<TValue> | AssetLibraryLocation | AssetParameterLocation | DataSourceLocation | DataTypeLocation | DataResourceLocation | AIGenerateLocation<TValue> | AIPromptMetadataLocation;
|
|
1026
1006
|
interface MeshContextData {
|
|
1027
1007
|
locationKey: string;
|
|
1028
1008
|
locationType: MeshLocationTypes;
|
|
@@ -1211,7 +1191,7 @@ interface MeshLocationCore<TValue = unknown, TMetadata = unknown, TSetValue = TV
|
|
|
1211
1191
|
/**
|
|
1212
1192
|
* Known location types that can be passed to a mesh location
|
|
1213
1193
|
*/
|
|
1214
|
-
type MeshLocationTypes = 'paramType' | 'paramTypeConfig' | 'assetLibrary' | 'settings' | 'dataSource' | 'dataType' | 'dataResource' | 'aiGenerate' | 'aiMetadata';
|
|
1194
|
+
type MeshLocationTypes = 'paramType' | 'paramTypeConfig' | 'assetLibrary' | 'assetParameter' | 'settings' | 'dataSource' | 'dataType' | 'dataResource' | 'aiGenerate' | 'aiMetadata';
|
|
1215
1195
|
type SetValueOptions = ValidationResult;
|
|
1216
1196
|
type SetValueMessage = {
|
|
1217
1197
|
uniformMeshLocationValue: unknown;
|
|
@@ -1244,9 +1224,13 @@ type AIGenerateLocationMetadata<TIntegrationConfiguration = unknown> = {
|
|
|
1244
1224
|
projectId: string;
|
|
1245
1225
|
prompt: string;
|
|
1246
1226
|
promptMetadata: Record<string, unknown>;
|
|
1227
|
+
/** Useful to differentiate AI Generate UI between text and image */
|
|
1228
|
+
promptOutputType: 'text' | 'image';
|
|
1247
1229
|
};
|
|
1248
1230
|
type PromptSettingsLocationMetadata<TIntegrationConfiguration = unknown> = {
|
|
1249
1231
|
settings: TIntegrationConfiguration;
|
|
1232
|
+
/** Useful to differentiate metadata settings between text and image generation */
|
|
1233
|
+
promptOutputType: 'text' | 'image';
|
|
1250
1234
|
};
|
|
1251
1235
|
type AIGenerateLocation<TType> = MeshLocationCore<TType, AIGenerateLocationMetadata, TType, 'aiGenerate'>;
|
|
1252
1236
|
type AIPromptMetadataLocation = MeshLocationCore<Record<string, unknown>, PromptSettingsLocationMetadata, Record<string, unknown>, 'aiMetadata'>;
|
|
@@ -1357,4 +1341,4 @@ declare function initializeUniformMeshSDK({ autoResizingDisabled, }?: {
|
|
|
1357
1341
|
autoResizingDisabled?: boolean;
|
|
1358
1342
|
}): Promise<UniformMeshSDK | undefined>;
|
|
1359
1343
|
|
|
1360
|
-
export { AIGenerateLocation, AIGenerateLocationMetadata, AIPromptMetadataLocation, AssetLibraryLocation, AssetLibraryLocationMetadata,
|
|
1344
|
+
export { type AIGenerateLocation, type AIGenerateLocationMetadata, type AIPromptMetadataLocation, type AssetLibraryLocation, type AssetLibraryLocationMetadata, type AssetParameterLocation, type AssetParameterLocationMetadata, type BindableTypes, type CSSHeight, type CloseDialogMessage, type CloseLocationDialogOptions, 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 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 ValidationResult, initializeUniformMeshSDK };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { ApiClient, ClientOptions, ExceptProject } from '@uniformdev/context/api';
|
|
2
2
|
import { ProjectMapNode } from '@uniformdev/project-map';
|
|
3
|
-
import {
|
|
3
|
+
import { AssetParamValue, DataType, DataSource, DataResourceVariables, RootComponentInstance, ComponentInstance, ComponentDefinition, ComponentDefinitionParameter, DataVariableDefinition } from '@uniformdev/canvas';
|
|
4
|
+
export { AssetParamValue, AssetParamValueItem } from '@uniformdev/canvas';
|
|
4
5
|
import { Emitter } from 'mitt';
|
|
5
6
|
|
|
6
7
|
/**
|
|
@@ -63,6 +64,8 @@ interface paths$1 {
|
|
|
63
64
|
};
|
|
64
65
|
};
|
|
65
66
|
renderableInPropertyPanel?: boolean;
|
|
67
|
+
/** @enum {string} */
|
|
68
|
+
localizable?: "default-yes" | "default-no" | "yes" | "no";
|
|
66
69
|
}[];
|
|
67
70
|
};
|
|
68
71
|
dataConnectors?: {
|
|
@@ -93,6 +96,15 @@ interface paths$1 {
|
|
|
93
96
|
};
|
|
94
97
|
badgeIconUrl?: string;
|
|
95
98
|
}[];
|
|
99
|
+
assetLibrary?: {
|
|
100
|
+
assetLibraryUrl: string;
|
|
101
|
+
assetParameterUrl: string;
|
|
102
|
+
unstable_dynamicAssets?: {
|
|
103
|
+
dataConnectorId: string;
|
|
104
|
+
assetsListArchetypeId: string;
|
|
105
|
+
singleAssetArchetypeId: string;
|
|
106
|
+
};
|
|
107
|
+
};
|
|
96
108
|
unstable_assetLibrary?: {
|
|
97
109
|
url: string;
|
|
98
110
|
dynamicAssets?: {
|
|
@@ -203,6 +215,8 @@ interface paths$1 {
|
|
|
203
215
|
};
|
|
204
216
|
};
|
|
205
217
|
renderableInPropertyPanel?: boolean;
|
|
218
|
+
/** @enum {string} */
|
|
219
|
+
localizable?: "default-yes" | "default-no" | "yes" | "no";
|
|
206
220
|
}[];
|
|
207
221
|
};
|
|
208
222
|
dataConnectors?: {
|
|
@@ -233,6 +247,15 @@ interface paths$1 {
|
|
|
233
247
|
};
|
|
234
248
|
badgeIconUrl?: string;
|
|
235
249
|
}[];
|
|
250
|
+
assetLibrary?: {
|
|
251
|
+
assetLibraryUrl: string;
|
|
252
|
+
assetParameterUrl: string;
|
|
253
|
+
unstable_dynamicAssets?: {
|
|
254
|
+
dataConnectorId: string;
|
|
255
|
+
assetsListArchetypeId: string;
|
|
256
|
+
singleAssetArchetypeId: string;
|
|
257
|
+
};
|
|
258
|
+
};
|
|
236
259
|
unstable_assetLibrary?: {
|
|
237
260
|
url: string;
|
|
238
261
|
dynamicAssets?: {
|
|
@@ -342,6 +365,8 @@ interface paths$1 {
|
|
|
342
365
|
};
|
|
343
366
|
};
|
|
344
367
|
renderableInPropertyPanel?: boolean;
|
|
368
|
+
/** @enum {string} */
|
|
369
|
+
localizable?: "default-yes" | "default-no" | "yes" | "no";
|
|
345
370
|
}[];
|
|
346
371
|
};
|
|
347
372
|
dataConnectors?: {
|
|
@@ -372,6 +397,15 @@ interface paths$1 {
|
|
|
372
397
|
};
|
|
373
398
|
badgeIconUrl?: string;
|
|
374
399
|
}[];
|
|
400
|
+
assetLibrary?: {
|
|
401
|
+
assetLibraryUrl: string;
|
|
402
|
+
assetParameterUrl: string;
|
|
403
|
+
unstable_dynamicAssets?: {
|
|
404
|
+
dataConnectorId: string;
|
|
405
|
+
assetsListArchetypeId: string;
|
|
406
|
+
singleAssetArchetypeId: string;
|
|
407
|
+
};
|
|
408
|
+
};
|
|
375
409
|
unstable_assetLibrary?: {
|
|
376
410
|
url: string;
|
|
377
411
|
dynamicAssets?: {
|
|
@@ -730,6 +764,7 @@ declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
|
|
|
730
764
|
};
|
|
731
765
|
} | undefined;
|
|
732
766
|
renderableInPropertyPanel?: boolean | undefined;
|
|
767
|
+
localizable?: "default-yes" | "default-no" | "yes" | "no" | undefined;
|
|
733
768
|
}[];
|
|
734
769
|
} | undefined;
|
|
735
770
|
dataConnectors?: {
|
|
@@ -760,6 +795,15 @@ declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
|
|
|
760
795
|
} | undefined;
|
|
761
796
|
badgeIconUrl?: string | undefined;
|
|
762
797
|
}[] | undefined;
|
|
798
|
+
assetLibrary?: {
|
|
799
|
+
assetLibraryUrl: string;
|
|
800
|
+
assetParameterUrl: string;
|
|
801
|
+
unstable_dynamicAssets?: {
|
|
802
|
+
dataConnectorId: string;
|
|
803
|
+
assetsListArchetypeId: string;
|
|
804
|
+
singleAssetArchetypeId: string;
|
|
805
|
+
} | undefined;
|
|
806
|
+
} | undefined;
|
|
763
807
|
unstable_assetLibrary?: {
|
|
764
808
|
url: string;
|
|
765
809
|
dynamicAssets?: {
|
|
@@ -839,14 +883,16 @@ type AssetLibraryLocationMetadata<TIntegrationConfiguration = unknown> = {
|
|
|
839
883
|
projectId: string;
|
|
840
884
|
/** The current Uniform integration source ID */
|
|
841
885
|
sourceId: string;
|
|
886
|
+
};
|
|
887
|
+
type AssetParameterLocationMetadata<TIntegrationConfiguration = unknown> = {
|
|
888
|
+
/** Settings defined at the integration level (arbitrary type used on settings location) */
|
|
889
|
+
settings: TIntegrationConfiguration;
|
|
890
|
+
/** The Uniform project ID */
|
|
891
|
+
projectId: string;
|
|
892
|
+
/** The current Uniform integration source ID */
|
|
893
|
+
sourceId: string;
|
|
842
894
|
/** The resolved data if this source is connected to a data resource */
|
|
843
895
|
dataResourceData?: unknown;
|
|
844
|
-
/**
|
|
845
|
-
* Asset Library location is used in two places: Global Asset Library and Asset Parameter.
|
|
846
|
-
* This flag is necessary to distinguish between the two, because Parameter context requires
|
|
847
|
-
* "value" and "setValue" properties to manipulate the value of the parameter.
|
|
848
|
-
*/
|
|
849
|
-
isAssetParameterContext: boolean;
|
|
850
896
|
/**
|
|
851
897
|
* The maximum number of assets that can be selected in the Asset Library.
|
|
852
898
|
*
|
|
@@ -854,81 +900,8 @@ type AssetLibraryLocationMetadata<TIntegrationConfiguration = unknown> = {
|
|
|
854
900
|
*/
|
|
855
901
|
maxAssets?: number;
|
|
856
902
|
};
|
|
857
|
-
type
|
|
858
|
-
type
|
|
859
|
-
type: string;
|
|
860
|
-
_id: string;
|
|
861
|
-
/**
|
|
862
|
-
* Internal Uniform source ID or
|
|
863
|
-
* dataType ID of the global integration library
|
|
864
|
-
* which created this asset item
|
|
865
|
-
*/
|
|
866
|
-
_source?: string;
|
|
867
|
-
fields: {
|
|
868
|
-
url: {
|
|
869
|
-
type: 'text';
|
|
870
|
-
value: string;
|
|
871
|
-
};
|
|
872
|
-
id?: {
|
|
873
|
-
type: 'text';
|
|
874
|
-
value: string | undefined;
|
|
875
|
-
};
|
|
876
|
-
title?: {
|
|
877
|
-
type: 'text';
|
|
878
|
-
value: string | undefined;
|
|
879
|
-
};
|
|
880
|
-
description?: {
|
|
881
|
-
type: 'text';
|
|
882
|
-
value: string | undefined;
|
|
883
|
-
};
|
|
884
|
-
mediaType?: {
|
|
885
|
-
type: 'text';
|
|
886
|
-
value: string | undefined;
|
|
887
|
-
};
|
|
888
|
-
/**
|
|
889
|
-
* The width of the original asset
|
|
890
|
-
*
|
|
891
|
-
* Should resolve to a number but might
|
|
892
|
-
* be a string with a pointer reference
|
|
893
|
-
*/
|
|
894
|
-
width?: {
|
|
895
|
-
type: 'number';
|
|
896
|
-
value: number | string | undefined;
|
|
897
|
-
};
|
|
898
|
-
/**
|
|
899
|
-
* The height of the original asset
|
|
900
|
-
*
|
|
901
|
-
* Should resolve to a number but might
|
|
902
|
-
* be a string with a pointer reference
|
|
903
|
-
*/
|
|
904
|
-
height?: {
|
|
905
|
-
type: 'number';
|
|
906
|
-
value: number | string | undefined;
|
|
907
|
-
};
|
|
908
|
-
/**
|
|
909
|
-
* The size in bytes of the original asset
|
|
910
|
-
*
|
|
911
|
-
* Should resolve to a number but might
|
|
912
|
-
* be a string with a pointer reference
|
|
913
|
-
*/
|
|
914
|
-
size?: {
|
|
915
|
-
type: 'number';
|
|
916
|
-
value: number | string | undefined;
|
|
917
|
-
};
|
|
918
|
-
/**
|
|
919
|
-
* Any key/value properties which the source
|
|
920
|
-
* wants to attach to the asset data
|
|
921
|
-
*/
|
|
922
|
-
custom?: {
|
|
923
|
-
type: string;
|
|
924
|
-
value: Record<string, unknown>;
|
|
925
|
-
};
|
|
926
|
-
};
|
|
927
|
-
_overrides?: {
|
|
928
|
-
fields: ComponentOverride['parameters'];
|
|
929
|
-
};
|
|
930
|
-
};
|
|
931
|
-
type AssetLibraryLocation = MeshLocationCore<AssetParamValue, AssetLibraryLocationMetadata, AssetParamValue, 'assetLibrary'> & GetDataResourceLocation;
|
|
903
|
+
type AssetLibraryLocation = MeshLocationCore<unknown, AssetLibraryLocationMetadata, unknown, 'assetLibrary'> & GetDataResourceLocation;
|
|
904
|
+
type AssetParameterLocation = MeshLocationCore<AssetParamValue, AssetParameterLocationMetadata, AssetParamValue, 'assetParameter'> & GetDataResourceLocation;
|
|
932
905
|
|
|
933
906
|
type DataTypeLocationValue = Pick<DataType, 'body' | 'method' | 'path' | 'custom' | 'headers' | 'parameters' | 'variables'>;
|
|
934
907
|
type DataConnectorInfo = {
|
|
@@ -1004,6 +977,13 @@ type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfig
|
|
|
1004
977
|
* Use the <ParamTypeDynamicDataProvider> to wire up dynamic data in your parameter.
|
|
1005
978
|
*/
|
|
1006
979
|
connectedData: Record<string, unknown>;
|
|
980
|
+
/**
|
|
981
|
+
* The target locale being edited.
|
|
982
|
+
* If the parameter is not defined as localizable, then this is always undefined.
|
|
983
|
+
* If the parameter is localizable, then this is the current editor language.
|
|
984
|
+
* Note that setValue() always sets the target language automatically.
|
|
985
|
+
*/
|
|
986
|
+
targetLocale: string | undefined;
|
|
1007
987
|
};
|
|
1008
988
|
type ParamTypeLocation<TParamValue = unknown, TParamConfiguration = unknown, TParamSetValue = TParamValue, TIntegrationConfiguration = unknown> = MeshLocationCore<TParamValue | undefined, ParamTypeLocationMetadata<TParamConfiguration, TIntegrationConfiguration>, TParamSetValue, 'paramType'> & {
|
|
1009
989
|
/**
|
|
@@ -1022,7 +1002,7 @@ type SettingsLocation<TSettingsType> = MeshLocationCore<TSettingsType, SettingsL
|
|
|
1022
1002
|
* Defines methods used for interacting with a Mesh location
|
|
1023
1003
|
* To receive useful typings, check the `type` property of the location to narrow the typing.
|
|
1024
1004
|
*/
|
|
1025
|
-
type MeshLocation<TValue = unknown, TSetValue = TValue> = ParamTypeLocation<TValue, unknown, TSetValue> | ParamTypeConfigLocation<TValue> | SettingsLocation<TValue> | AssetLibraryLocation | DataSourceLocation | DataTypeLocation | DataResourceLocation | AIGenerateLocation<TValue> | AIPromptMetadataLocation;
|
|
1005
|
+
type MeshLocation<TValue = unknown, TSetValue = TValue> = ParamTypeLocation<TValue, unknown, TSetValue> | ParamTypeConfigLocation<TValue> | SettingsLocation<TValue> | AssetLibraryLocation | AssetParameterLocation | DataSourceLocation | DataTypeLocation | DataResourceLocation | AIGenerateLocation<TValue> | AIPromptMetadataLocation;
|
|
1026
1006
|
interface MeshContextData {
|
|
1027
1007
|
locationKey: string;
|
|
1028
1008
|
locationType: MeshLocationTypes;
|
|
@@ -1211,7 +1191,7 @@ interface MeshLocationCore<TValue = unknown, TMetadata = unknown, TSetValue = TV
|
|
|
1211
1191
|
/**
|
|
1212
1192
|
* Known location types that can be passed to a mesh location
|
|
1213
1193
|
*/
|
|
1214
|
-
type MeshLocationTypes = 'paramType' | 'paramTypeConfig' | 'assetLibrary' | 'settings' | 'dataSource' | 'dataType' | 'dataResource' | 'aiGenerate' | 'aiMetadata';
|
|
1194
|
+
type MeshLocationTypes = 'paramType' | 'paramTypeConfig' | 'assetLibrary' | 'assetParameter' | 'settings' | 'dataSource' | 'dataType' | 'dataResource' | 'aiGenerate' | 'aiMetadata';
|
|
1215
1195
|
type SetValueOptions = ValidationResult;
|
|
1216
1196
|
type SetValueMessage = {
|
|
1217
1197
|
uniformMeshLocationValue: unknown;
|
|
@@ -1244,9 +1224,13 @@ type AIGenerateLocationMetadata<TIntegrationConfiguration = unknown> = {
|
|
|
1244
1224
|
projectId: string;
|
|
1245
1225
|
prompt: string;
|
|
1246
1226
|
promptMetadata: Record<string, unknown>;
|
|
1227
|
+
/** Useful to differentiate AI Generate UI between text and image */
|
|
1228
|
+
promptOutputType: 'text' | 'image';
|
|
1247
1229
|
};
|
|
1248
1230
|
type PromptSettingsLocationMetadata<TIntegrationConfiguration = unknown> = {
|
|
1249
1231
|
settings: TIntegrationConfiguration;
|
|
1232
|
+
/** Useful to differentiate metadata settings between text and image generation */
|
|
1233
|
+
promptOutputType: 'text' | 'image';
|
|
1250
1234
|
};
|
|
1251
1235
|
type AIGenerateLocation<TType> = MeshLocationCore<TType, AIGenerateLocationMetadata, TType, 'aiGenerate'>;
|
|
1252
1236
|
type AIPromptMetadataLocation = MeshLocationCore<Record<string, unknown>, PromptSettingsLocationMetadata, Record<string, unknown>, 'aiMetadata'>;
|
|
@@ -1357,4 +1341,4 @@ declare function initializeUniformMeshSDK({ autoResizingDisabled, }?: {
|
|
|
1357
1341
|
autoResizingDisabled?: boolean;
|
|
1358
1342
|
}): Promise<UniformMeshSDK | undefined>;
|
|
1359
1343
|
|
|
1360
|
-
export { AIGenerateLocation, AIGenerateLocationMetadata, AIPromptMetadataLocation, AssetLibraryLocation, AssetLibraryLocationMetadata,
|
|
1344
|
+
export { type AIGenerateLocation, type AIGenerateLocationMetadata, type AIPromptMetadataLocation, type AssetLibraryLocation, type AssetLibraryLocationMetadata, type AssetParameterLocation, type AssetParameterLocationMetadata, type BindableTypes, type CSSHeight, type CloseDialogMessage, type CloseLocationDialogOptions, 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 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 ValidationResult, initializeUniformMeshSDK };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@uniformdev/mesh-sdk",
|
|
3
|
-
"version": "19.79.
|
|
3
|
+
"version": "19.79.1-alpha.7+bd4b0c6f4",
|
|
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.79.
|
|
37
|
-
"@uniformdev/context": "19.79.
|
|
38
|
-
"@uniformdev/project-map": "19.79.
|
|
36
|
+
"@uniformdev/canvas": "19.79.1-alpha.7+bd4b0c6f4",
|
|
37
|
+
"@uniformdev/context": "19.79.1-alpha.7+bd4b0c6f4",
|
|
38
|
+
"@uniformdev/project-map": "19.79.1-alpha.7+bd4b0c6f4",
|
|
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": "
|
|
45
|
+
"gitHead": "bd4b0c6f4a67549f8eb7e127a85927c798e7eed0"
|
|
46
46
|
}
|