@uniformdev/mesh-sdk 19.173.1-alpha.17 → 19.173.2-alpha.258
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 +157 -62
- package/dist/index.d.ts +157 -62
- package/dist/index.esm.js +1 -1
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +6 -6
package/dist/index.d.mts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { ApiClient, ClientOptions, ExceptProject } from '@uniformdev/context/api';
|
|
2
2
|
import { ProjectMapNode } from '@uniformdev/project-map';
|
|
3
|
-
import { AssetParamValue, DataType, DataSource, DataResourceVariables, RootComponentInstance, ComponentInstance, ComponentDefinition, ComponentDefinitionParameter, Locale, DataVariableDefinition, EntryData } from '@uniformdev/canvas';
|
|
3
|
+
import { AssetParamValue, DataType, DataSource, DataSourceVariantsKeys, DataResourceVariables, RootComponentInstance, ComponentInstance, ComponentDefinition, ComponentDefinitionParameter, Locale, DataVariableDefinition, EntryData } from '@uniformdev/canvas';
|
|
4
4
|
export { AssetParamValue, AssetParamValueItem } from '@uniformdev/canvas';
|
|
5
5
|
import { Emitter } from 'mitt';
|
|
6
6
|
|
|
@@ -67,6 +67,7 @@ interface paths$1 {
|
|
|
67
67
|
renderableInPropertyPanel?: boolean;
|
|
68
68
|
/** @enum {string} */
|
|
69
69
|
localizable?: "default-yes" | "default-no" | "yes" | "no";
|
|
70
|
+
allowedPlacement?: ("parameter" | "field")[];
|
|
70
71
|
}[];
|
|
71
72
|
editorTools?: {
|
|
72
73
|
composition?: {
|
|
@@ -90,6 +91,8 @@ interface paths$1 {
|
|
|
90
91
|
type: string;
|
|
91
92
|
displayName: string;
|
|
92
93
|
dataSourceEditorUrl?: string;
|
|
94
|
+
supportsUnpublishedData?: boolean;
|
|
95
|
+
contextualEditing?: string;
|
|
93
96
|
dataSourceEditorLocations?: {
|
|
94
97
|
[key: string]: {
|
|
95
98
|
url: string;
|
|
@@ -117,6 +120,11 @@ interface paths$1 {
|
|
|
117
120
|
assetLibrary?: {
|
|
118
121
|
assetLibraryUrl: string;
|
|
119
122
|
assetParameterUrl: string;
|
|
123
|
+
assetLibraryLocations?: {
|
|
124
|
+
[key: string]: {
|
|
125
|
+
url: string;
|
|
126
|
+
};
|
|
127
|
+
};
|
|
120
128
|
unstable_dynamicAssets?: {
|
|
121
129
|
dataConnectorId: string;
|
|
122
130
|
assetsListArchetypeId: string;
|
|
@@ -236,6 +244,7 @@ interface paths$1 {
|
|
|
236
244
|
renderableInPropertyPanel?: boolean;
|
|
237
245
|
/** @enum {string} */
|
|
238
246
|
localizable?: "default-yes" | "default-no" | "yes" | "no";
|
|
247
|
+
allowedPlacement?: ("parameter" | "field")[];
|
|
239
248
|
}[];
|
|
240
249
|
editorTools?: {
|
|
241
250
|
composition?: {
|
|
@@ -259,6 +268,8 @@ interface paths$1 {
|
|
|
259
268
|
type: string;
|
|
260
269
|
displayName: string;
|
|
261
270
|
dataSourceEditorUrl?: string;
|
|
271
|
+
supportsUnpublishedData?: boolean;
|
|
272
|
+
contextualEditing?: string;
|
|
262
273
|
dataSourceEditorLocations?: {
|
|
263
274
|
[key: string]: {
|
|
264
275
|
url: string;
|
|
@@ -286,6 +297,11 @@ interface paths$1 {
|
|
|
286
297
|
assetLibrary?: {
|
|
287
298
|
assetLibraryUrl: string;
|
|
288
299
|
assetParameterUrl: string;
|
|
300
|
+
assetLibraryLocations?: {
|
|
301
|
+
[key: string]: {
|
|
302
|
+
url: string;
|
|
303
|
+
};
|
|
304
|
+
};
|
|
289
305
|
unstable_dynamicAssets?: {
|
|
290
306
|
dataConnectorId: string;
|
|
291
307
|
assetsListArchetypeId: string;
|
|
@@ -404,6 +420,7 @@ interface paths$1 {
|
|
|
404
420
|
renderableInPropertyPanel?: boolean;
|
|
405
421
|
/** @enum {string} */
|
|
406
422
|
localizable?: "default-yes" | "default-no" | "yes" | "no";
|
|
423
|
+
allowedPlacement?: ("parameter" | "field")[];
|
|
407
424
|
}[];
|
|
408
425
|
editorTools?: {
|
|
409
426
|
composition?: {
|
|
@@ -427,6 +444,8 @@ interface paths$1 {
|
|
|
427
444
|
type: string;
|
|
428
445
|
displayName: string;
|
|
429
446
|
dataSourceEditorUrl?: string;
|
|
447
|
+
supportsUnpublishedData?: boolean;
|
|
448
|
+
contextualEditing?: string;
|
|
430
449
|
dataSourceEditorLocations?: {
|
|
431
450
|
[key: string]: {
|
|
432
451
|
url: string;
|
|
@@ -454,6 +473,11 @@ interface paths$1 {
|
|
|
454
473
|
assetLibrary?: {
|
|
455
474
|
assetLibraryUrl: string;
|
|
456
475
|
assetParameterUrl: string;
|
|
476
|
+
assetLibraryLocations?: {
|
|
477
|
+
[key: string]: {
|
|
478
|
+
url: string;
|
|
479
|
+
};
|
|
480
|
+
};
|
|
457
481
|
unstable_dynamicAssets?: {
|
|
458
482
|
dataConnectorId: string;
|
|
459
483
|
assetsListArchetypeId: string;
|
|
@@ -782,111 +806,119 @@ declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
|
|
|
782
806
|
upsert(body: Omit<IntegrationDefinitionPutParameters, 'teamId'>): Promise<{
|
|
783
807
|
type: string;
|
|
784
808
|
displayName: string;
|
|
785
|
-
logoIconUrl?: string
|
|
786
|
-
badgeIconUrl?: string
|
|
787
|
-
category?: "analytics" | "cdn" | "classic" | "commerce" | "content" | "comingSoon" | "data" | "deprecated" | "email" | "framework" | "search" | "starters" | "translation" | "uniform" | "ai" | "unknown"
|
|
788
|
-
public?: boolean
|
|
789
|
-
scopes?: string[]
|
|
790
|
-
baseLocationUrl?: string
|
|
809
|
+
logoIconUrl?: string;
|
|
810
|
+
badgeIconUrl?: string;
|
|
811
|
+
category?: "analytics" | "cdn" | "classic" | "commerce" | "content" | "comingSoon" | "data" | "deprecated" | "email" | "framework" | "search" | "starters" | "translation" | "uniform" | "ai" | "unknown";
|
|
812
|
+
public?: boolean;
|
|
813
|
+
scopes?: string[];
|
|
814
|
+
baseLocationUrl?: string;
|
|
791
815
|
locations: {
|
|
792
816
|
install?: {
|
|
793
|
-
description?: string[]
|
|
794
|
-
informationUrl?: string
|
|
795
|
-
canvasPackageUrl?: string
|
|
796
|
-
}
|
|
817
|
+
description?: string[];
|
|
818
|
+
informationUrl?: string;
|
|
819
|
+
canvasPackageUrl?: string;
|
|
820
|
+
};
|
|
797
821
|
settings?: {
|
|
798
822
|
url: string;
|
|
799
823
|
locations?: {
|
|
800
824
|
[key: string]: {
|
|
801
825
|
url: string;
|
|
802
826
|
};
|
|
803
|
-
}
|
|
804
|
-
}
|
|
827
|
+
};
|
|
828
|
+
};
|
|
805
829
|
canvas?: {
|
|
806
830
|
parameterTypes: {
|
|
807
831
|
type: string;
|
|
808
832
|
displayName: string;
|
|
809
|
-
configureUrl?: string
|
|
833
|
+
configureUrl?: string;
|
|
810
834
|
editorUrl: string;
|
|
811
835
|
configurationLocations?: {
|
|
812
836
|
[key: string]: {
|
|
813
837
|
url: string;
|
|
814
838
|
};
|
|
815
|
-
}
|
|
839
|
+
};
|
|
816
840
|
editorLocations?: {
|
|
817
841
|
[key: string]: {
|
|
818
842
|
url: string;
|
|
819
843
|
};
|
|
820
|
-
}
|
|
821
|
-
renderableInPropertyPanel?: boolean
|
|
822
|
-
localizable?: "default-yes" | "default-no" | "yes" | "no"
|
|
844
|
+
};
|
|
845
|
+
renderableInPropertyPanel?: boolean;
|
|
846
|
+
localizable?: "default-yes" | "default-no" | "yes" | "no";
|
|
847
|
+
allowedPlacement?: ("parameter" | "field")[];
|
|
823
848
|
}[];
|
|
824
849
|
editorTools?: {
|
|
825
850
|
composition?: {
|
|
826
851
|
url: string;
|
|
827
|
-
}
|
|
852
|
+
};
|
|
828
853
|
componentPattern?: {
|
|
829
854
|
url: string;
|
|
830
|
-
}
|
|
855
|
+
};
|
|
831
856
|
compositionDefaults?: {
|
|
832
857
|
url: string;
|
|
833
|
-
}
|
|
858
|
+
};
|
|
834
859
|
entry?: {
|
|
835
860
|
url: string;
|
|
836
|
-
}
|
|
861
|
+
};
|
|
837
862
|
entryPattern?: {
|
|
838
863
|
url: string;
|
|
839
|
-
}
|
|
840
|
-
}
|
|
841
|
-
}
|
|
864
|
+
};
|
|
865
|
+
};
|
|
866
|
+
};
|
|
842
867
|
dataConnectors?: {
|
|
843
868
|
type: string;
|
|
844
869
|
displayName: string;
|
|
845
|
-
dataSourceEditorUrl?: string
|
|
870
|
+
dataSourceEditorUrl?: string;
|
|
871
|
+
supportsUnpublishedData?: boolean;
|
|
872
|
+
contextualEditing?: string;
|
|
846
873
|
dataSourceEditorLocations?: {
|
|
847
874
|
[key: string]: {
|
|
848
875
|
url: string;
|
|
849
876
|
};
|
|
850
|
-
}
|
|
877
|
+
};
|
|
851
878
|
dataArchetypes?: {
|
|
852
879
|
[key: string]: {
|
|
853
880
|
displayName: string;
|
|
854
|
-
typeEditorUrl?: string
|
|
881
|
+
typeEditorUrl?: string;
|
|
855
882
|
typeEditorLocations?: {
|
|
856
883
|
[key: string]: {
|
|
857
884
|
url: string;
|
|
858
885
|
};
|
|
859
|
-
}
|
|
860
|
-
dataEditorUrl?: string
|
|
886
|
+
};
|
|
887
|
+
dataEditorUrl?: string;
|
|
861
888
|
dataEditorUrlLocations?: {
|
|
862
889
|
[key: string]: {
|
|
863
890
|
url: string;
|
|
864
891
|
};
|
|
865
|
-
}
|
|
892
|
+
};
|
|
866
893
|
};
|
|
867
|
-
}
|
|
868
|
-
badgeIconUrl?: string
|
|
869
|
-
}[]
|
|
894
|
+
};
|
|
895
|
+
badgeIconUrl?: string;
|
|
896
|
+
}[];
|
|
870
897
|
assetLibrary?: {
|
|
871
898
|
assetLibraryUrl: string;
|
|
872
899
|
assetParameterUrl: string;
|
|
900
|
+
assetLibraryLocations?: {
|
|
901
|
+
[key: string]: {
|
|
902
|
+
url: string;
|
|
903
|
+
};
|
|
904
|
+
};
|
|
873
905
|
unstable_dynamicAssets?: {
|
|
874
906
|
dataConnectorId: string;
|
|
875
907
|
assetsListArchetypeId: string;
|
|
876
908
|
singleAssetArchetypeId: string;
|
|
877
|
-
}
|
|
878
|
-
}
|
|
909
|
+
};
|
|
910
|
+
};
|
|
879
911
|
unstable_assetLibrary?: {
|
|
880
912
|
url: string;
|
|
881
913
|
dynamicAssets?: {
|
|
882
914
|
dataConnectorId: string;
|
|
883
915
|
assetsListArchetypeId: string;
|
|
884
916
|
singleAssetArchetypeId: string;
|
|
885
|
-
}
|
|
886
|
-
}
|
|
917
|
+
};
|
|
918
|
+
};
|
|
887
919
|
ai?: {
|
|
888
920
|
generateUrl: string;
|
|
889
|
-
metadataUrl?: string
|
|
921
|
+
metadataUrl?: string;
|
|
890
922
|
prompts?: {
|
|
891
923
|
id: string;
|
|
892
924
|
name: string;
|
|
@@ -895,20 +927,20 @@ declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
|
|
|
895
927
|
arguments?: {
|
|
896
928
|
[key: string]: {
|
|
897
929
|
type: string;
|
|
898
|
-
displayName?: string | null
|
|
899
|
-
helpText?: string | null
|
|
900
|
-
default?: string | null
|
|
930
|
+
displayName?: string | null;
|
|
931
|
+
helpText?: string | null;
|
|
932
|
+
default?: string | null;
|
|
901
933
|
};
|
|
902
|
-
} | null
|
|
903
|
-
metadata?: unknown;
|
|
904
|
-
} | null
|
|
934
|
+
} | null;
|
|
935
|
+
metadata?: unknown | null;
|
|
936
|
+
} | null;
|
|
905
937
|
parameterTypes: string[];
|
|
906
|
-
}[]
|
|
907
|
-
}
|
|
938
|
+
}[];
|
|
939
|
+
};
|
|
908
940
|
unstable_ai?: {
|
|
909
941
|
generateUrl: string;
|
|
910
|
-
metadataUrl?: string
|
|
911
|
-
}
|
|
942
|
+
metadataUrl?: string;
|
|
943
|
+
};
|
|
912
944
|
};
|
|
913
945
|
unstable_prompts?: {
|
|
914
946
|
id: string;
|
|
@@ -918,15 +950,15 @@ declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
|
|
|
918
950
|
arguments?: {
|
|
919
951
|
[key: string]: {
|
|
920
952
|
type: string;
|
|
921
|
-
displayName?: string | null
|
|
922
|
-
helpText?: string | null
|
|
923
|
-
default?: string | null
|
|
953
|
+
displayName?: string | null;
|
|
954
|
+
helpText?: string | null;
|
|
955
|
+
default?: string | null;
|
|
924
956
|
};
|
|
925
|
-
} | null
|
|
926
|
-
metadata?: unknown;
|
|
927
|
-
} | null
|
|
957
|
+
} | null;
|
|
958
|
+
metadata?: unknown | null;
|
|
959
|
+
} | null;
|
|
928
960
|
parameterTypes: string[];
|
|
929
|
-
}[]
|
|
961
|
+
}[];
|
|
930
962
|
}>;
|
|
931
963
|
/** Deletes a mesh app from a team */
|
|
932
964
|
remove(body: Omit<IntegrationDefinitionDeleteParameters, 'teamId'>): Promise<void>;
|
|
@@ -996,11 +1028,19 @@ type DataResourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonM
|
|
|
996
1028
|
dataConnector: DataConnectorInfo;
|
|
997
1029
|
/** Current dynamic inputs that are configured on the composition (if any). */
|
|
998
1030
|
dynamicInputs: DynamicInputs;
|
|
1031
|
+
/** Which Data Source variant is being resolved and used for getDataResource (unless overriden explicitly via providing "undefined") */
|
|
1032
|
+
dataSourceVariant?: DataSourceVariantsKeys;
|
|
999
1033
|
}, TIntegrationConfiguration>;
|
|
1000
1034
|
type DataResourceLocation = MeshLocationCore<DataResourceVariables, DataResourceLocationMetadata, DataResourceVariables, 'dataResource'> & GetDataResourceLocation;
|
|
1001
1035
|
|
|
1002
|
-
type DataSourceLocationValue = Pick<DataSource, 'baseUrl' | 'custom' | 'customPublic' | 'headers' | 'parameters' | 'variables'>;
|
|
1003
|
-
type DataSourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<
|
|
1036
|
+
type DataSourceLocationValue = Pick<DataSource, 'baseUrl' | 'custom' | 'customPublic' | 'headers' | 'parameters' | 'variables' | 'enableUnpublishedMode' | 'variants'>;
|
|
1037
|
+
type DataSourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
|
|
1038
|
+
/**
|
|
1039
|
+
* If true, the data source should provide additional configuration to support the unpublished mode and save "unpublish" Data Source variant.
|
|
1040
|
+
* E.g. inputs for Preview API Token + Preview Environment.
|
|
1041
|
+
*/
|
|
1042
|
+
enableUnpublishedMode: DataSourceLocationValue['enableUnpublishedMode'];
|
|
1043
|
+
}, TIntegrationConfiguration>;
|
|
1004
1044
|
type DataSourceLocation = MeshLocationCore<DataSourceLocationValue, DataSourceLocationMetadata, DataSourceLocationValue, 'dataSource'>;
|
|
1005
1045
|
|
|
1006
1046
|
type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfiguration = unknown> = CommonMetadata<{
|
|
@@ -1053,7 +1093,7 @@ type SettingsLocation<TSettingsType> = MeshLocationCore<TSettingsType, SettingsL
|
|
|
1053
1093
|
* Defines methods used for interacting with a Mesh location
|
|
1054
1094
|
* To receive useful typings, check the `type` property of the location to narrow the typing.
|
|
1055
1095
|
*/
|
|
1056
|
-
type MeshLocation<TValue = unknown, TSetValue = TValue> = ParamTypeLocation<TValue, unknown, TSetValue> | ParamTypeConfigLocation<TValue> | SettingsLocation<TValue> | AssetLibraryLocation | AssetParameterLocation | DataSourceLocation | DataTypeLocation | DataResourceLocation | CanvasEditorToolsLocation | AIGenerateLocation<TValue> | AIPromptMetadataLocation;
|
|
1096
|
+
type MeshLocation<TValue = unknown, TSetValue = TValue> = ParamTypeLocation<TValue, unknown, TSetValue> | ParamTypeConfigLocation<TValue> | SettingsLocation<TValue> | AssetLibraryLocation | AssetParameterLocation | DataSourceLocation | DataTypeLocation | DataResourceLocation | CanvasEditorToolsLocation | ContextualEditingLocation | AIGenerateLocation<TValue> | AIPromptMetadataLocation;
|
|
1057
1097
|
interface MeshContextData {
|
|
1058
1098
|
locationKey: string;
|
|
1059
1099
|
locationType: MeshLocationTypes;
|
|
@@ -1165,7 +1205,13 @@ type CloseDialogMessage = {
|
|
|
1165
1205
|
dialogType: DialogType;
|
|
1166
1206
|
dialogData?: unknown;
|
|
1167
1207
|
};
|
|
1168
|
-
type GetDataResourceMessage = Pick<DataType, 'path' | 'archetype' | 'headers' | 'parameters' | 'body' | 'method'
|
|
1208
|
+
type GetDataResourceMessage = Pick<DataType, 'path' | 'archetype' | 'headers' | 'parameters' | 'body' | 'method'> & {
|
|
1209
|
+
/**
|
|
1210
|
+
* Ability to override Data Source variant for particular getDataResource request,
|
|
1211
|
+
* because by default it will use Canvas Editor global. But sometimes you don't want to switch to Unpublished Data and stick to standard one.
|
|
1212
|
+
*/
|
|
1213
|
+
dataSourceVariant?: DataSourceVariantsKeys | 'standard';
|
|
1214
|
+
};
|
|
1169
1215
|
/** Primitive data types that a parameter type accepts to be bound to composition data */
|
|
1170
1216
|
type BindableTypes = 'string' | 'number' | 'boolean' | 'object' | 'array';
|
|
1171
1217
|
/** Message to parent to create a data connection expression to insert in a param type */
|
|
@@ -1360,7 +1406,7 @@ type MeshLocationUserPermissions =
|
|
|
1360
1406
|
/**
|
|
1361
1407
|
* Known location types that can be passed to a mesh location
|
|
1362
1408
|
*/
|
|
1363
|
-
type MeshLocationTypes = 'paramType' | 'paramTypeConfig' | 'assetLibrary' | 'assetParameter' | 'settings' | 'dataSource' | 'dataType' | 'dataResource' | 'aiGenerate' | 'canvasEditorTools' | 'aiMetadata';
|
|
1409
|
+
type MeshLocationTypes = 'paramType' | 'paramTypeConfig' | 'assetLibrary' | 'assetParameter' | 'settings' | 'dataSource' | 'dataType' | 'dataResource' | 'aiGenerate' | 'contextualEditing' | 'canvasEditorTools' | 'aiMetadata';
|
|
1364
1410
|
type SetValueOptions = ValidationResult;
|
|
1365
1411
|
type SetValueMessage = {
|
|
1366
1412
|
uniformMeshLocationValue: unknown;
|
|
@@ -1421,6 +1467,55 @@ type CanvasEditorToolsData = {
|
|
|
1421
1467
|
});
|
|
1422
1468
|
type CanvasEditorToolsLocation = MeshLocationCore<CanvasEditorToolsData, CanvasEditorToolsLocationMetadata, CanvasEditorToolsData, 'canvasEditorTools'> & GetDataResourceLocation;
|
|
1423
1469
|
|
|
1470
|
+
/**
|
|
1471
|
+
* @deprecated Alpha version of the Contextual Editing location. This location is not yet available for use in the Mesh SDK.
|
|
1472
|
+
* And only available for internal use.
|
|
1473
|
+
*/
|
|
1474
|
+
type ContextualEditingLocationValue<TResolvedData = unknown> = {
|
|
1475
|
+
/**
|
|
1476
|
+
* The resolved data for the data resource.
|
|
1477
|
+
*/
|
|
1478
|
+
resolvedData: TResolvedData;
|
|
1479
|
+
/**
|
|
1480
|
+
* The variables for the data resource. Contains things like entry Id
|
|
1481
|
+
*/
|
|
1482
|
+
dataResourceVariables: DataResourceVariables;
|
|
1483
|
+
/**
|
|
1484
|
+
* The JSON pointer to the data resource. If contextual editing is triggered from the bound value,
|
|
1485
|
+
* the pointer is provided to for example focus on particular field
|
|
1486
|
+
*/
|
|
1487
|
+
jsonPointer?: string;
|
|
1488
|
+
};
|
|
1489
|
+
/**
|
|
1490
|
+
* @deprecated Alpha version of the Contextual Editing location. This location is not yet available for use in the Mesh SDK.
|
|
1491
|
+
* And only available for internal use.
|
|
1492
|
+
*/
|
|
1493
|
+
type ContextualEditingLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
|
|
1494
|
+
/**
|
|
1495
|
+
* Contains useful info like archetype or default content type filters
|
|
1496
|
+
*/
|
|
1497
|
+
dataType: DataType;
|
|
1498
|
+
/**
|
|
1499
|
+
* The current data resource's data source. NOTE: param and header values are not available in this context.
|
|
1500
|
+
*/
|
|
1501
|
+
dataSource: DataSource;
|
|
1502
|
+
/**
|
|
1503
|
+
* To explicitly show the difference between Add and Edit actions
|
|
1504
|
+
*/
|
|
1505
|
+
actionType: 'edit' | 'create';
|
|
1506
|
+
}, TIntegrationConfiguration>;
|
|
1507
|
+
/**
|
|
1508
|
+
* @deprecated Alpha version of the Contextual Editing location. This location is not yet available for use in the Mesh SDK.
|
|
1509
|
+
*
|
|
1510
|
+
* Useful in case when creating new content item and we want to set this new item as Data Resource variable.
|
|
1511
|
+
*/
|
|
1512
|
+
type ContextualEditingLocationSetValue = DataResourceVariables;
|
|
1513
|
+
/**
|
|
1514
|
+
* @deprecated Alpha version of the Contextual Editing location. This location is not yet available for use in the Mesh SDK.
|
|
1515
|
+
* And only available for internal use.
|
|
1516
|
+
*/
|
|
1517
|
+
type ContextualEditingLocation = MeshLocationCore<ContextualEditingLocationValue, ContextualEditingLocationMetadata, ContextualEditingLocationSetValue, 'contextualEditing'> & GetDataResourceLocation;
|
|
1518
|
+
|
|
1424
1519
|
type ParamTypeConfigLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
|
|
1425
1520
|
/** The Uniform project ID */
|
|
1426
1521
|
componentDefinition: ComponentDefinition;
|
|
@@ -1530,4 +1625,4 @@ declare const hasPermissions: (permissions: MeshLocationUserPermissions | MeshLo
|
|
|
1530
1625
|
*/
|
|
1531
1626
|
declare const hasRole: (role: string, user: UniformUser) => boolean;
|
|
1532
1627
|
|
|
1533
|
-
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 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 };
|
|
1628
|
+
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 ContextualEditingLocation, type ContextualEditingLocationMetadata, type ContextualEditingLocationSetValue, type ContextualEditingLocationValue, 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
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { ApiClient, ClientOptions, ExceptProject } from '@uniformdev/context/api';
|
|
2
2
|
import { ProjectMapNode } from '@uniformdev/project-map';
|
|
3
|
-
import { AssetParamValue, DataType, DataSource, DataResourceVariables, RootComponentInstance, ComponentInstance, ComponentDefinition, ComponentDefinitionParameter, Locale, DataVariableDefinition, EntryData } from '@uniformdev/canvas';
|
|
3
|
+
import { AssetParamValue, DataType, DataSource, DataSourceVariantsKeys, DataResourceVariables, RootComponentInstance, ComponentInstance, ComponentDefinition, ComponentDefinitionParameter, Locale, DataVariableDefinition, EntryData } from '@uniformdev/canvas';
|
|
4
4
|
export { AssetParamValue, AssetParamValueItem } from '@uniformdev/canvas';
|
|
5
5
|
import { Emitter } from 'mitt';
|
|
6
6
|
|
|
@@ -67,6 +67,7 @@ interface paths$1 {
|
|
|
67
67
|
renderableInPropertyPanel?: boolean;
|
|
68
68
|
/** @enum {string} */
|
|
69
69
|
localizable?: "default-yes" | "default-no" | "yes" | "no";
|
|
70
|
+
allowedPlacement?: ("parameter" | "field")[];
|
|
70
71
|
}[];
|
|
71
72
|
editorTools?: {
|
|
72
73
|
composition?: {
|
|
@@ -90,6 +91,8 @@ interface paths$1 {
|
|
|
90
91
|
type: string;
|
|
91
92
|
displayName: string;
|
|
92
93
|
dataSourceEditorUrl?: string;
|
|
94
|
+
supportsUnpublishedData?: boolean;
|
|
95
|
+
contextualEditing?: string;
|
|
93
96
|
dataSourceEditorLocations?: {
|
|
94
97
|
[key: string]: {
|
|
95
98
|
url: string;
|
|
@@ -117,6 +120,11 @@ interface paths$1 {
|
|
|
117
120
|
assetLibrary?: {
|
|
118
121
|
assetLibraryUrl: string;
|
|
119
122
|
assetParameterUrl: string;
|
|
123
|
+
assetLibraryLocations?: {
|
|
124
|
+
[key: string]: {
|
|
125
|
+
url: string;
|
|
126
|
+
};
|
|
127
|
+
};
|
|
120
128
|
unstable_dynamicAssets?: {
|
|
121
129
|
dataConnectorId: string;
|
|
122
130
|
assetsListArchetypeId: string;
|
|
@@ -236,6 +244,7 @@ interface paths$1 {
|
|
|
236
244
|
renderableInPropertyPanel?: boolean;
|
|
237
245
|
/** @enum {string} */
|
|
238
246
|
localizable?: "default-yes" | "default-no" | "yes" | "no";
|
|
247
|
+
allowedPlacement?: ("parameter" | "field")[];
|
|
239
248
|
}[];
|
|
240
249
|
editorTools?: {
|
|
241
250
|
composition?: {
|
|
@@ -259,6 +268,8 @@ interface paths$1 {
|
|
|
259
268
|
type: string;
|
|
260
269
|
displayName: string;
|
|
261
270
|
dataSourceEditorUrl?: string;
|
|
271
|
+
supportsUnpublishedData?: boolean;
|
|
272
|
+
contextualEditing?: string;
|
|
262
273
|
dataSourceEditorLocations?: {
|
|
263
274
|
[key: string]: {
|
|
264
275
|
url: string;
|
|
@@ -286,6 +297,11 @@ interface paths$1 {
|
|
|
286
297
|
assetLibrary?: {
|
|
287
298
|
assetLibraryUrl: string;
|
|
288
299
|
assetParameterUrl: string;
|
|
300
|
+
assetLibraryLocations?: {
|
|
301
|
+
[key: string]: {
|
|
302
|
+
url: string;
|
|
303
|
+
};
|
|
304
|
+
};
|
|
289
305
|
unstable_dynamicAssets?: {
|
|
290
306
|
dataConnectorId: string;
|
|
291
307
|
assetsListArchetypeId: string;
|
|
@@ -404,6 +420,7 @@ interface paths$1 {
|
|
|
404
420
|
renderableInPropertyPanel?: boolean;
|
|
405
421
|
/** @enum {string} */
|
|
406
422
|
localizable?: "default-yes" | "default-no" | "yes" | "no";
|
|
423
|
+
allowedPlacement?: ("parameter" | "field")[];
|
|
407
424
|
}[];
|
|
408
425
|
editorTools?: {
|
|
409
426
|
composition?: {
|
|
@@ -427,6 +444,8 @@ interface paths$1 {
|
|
|
427
444
|
type: string;
|
|
428
445
|
displayName: string;
|
|
429
446
|
dataSourceEditorUrl?: string;
|
|
447
|
+
supportsUnpublishedData?: boolean;
|
|
448
|
+
contextualEditing?: string;
|
|
430
449
|
dataSourceEditorLocations?: {
|
|
431
450
|
[key: string]: {
|
|
432
451
|
url: string;
|
|
@@ -454,6 +473,11 @@ interface paths$1 {
|
|
|
454
473
|
assetLibrary?: {
|
|
455
474
|
assetLibraryUrl: string;
|
|
456
475
|
assetParameterUrl: string;
|
|
476
|
+
assetLibraryLocations?: {
|
|
477
|
+
[key: string]: {
|
|
478
|
+
url: string;
|
|
479
|
+
};
|
|
480
|
+
};
|
|
457
481
|
unstable_dynamicAssets?: {
|
|
458
482
|
dataConnectorId: string;
|
|
459
483
|
assetsListArchetypeId: string;
|
|
@@ -782,111 +806,119 @@ declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
|
|
|
782
806
|
upsert(body: Omit<IntegrationDefinitionPutParameters, 'teamId'>): Promise<{
|
|
783
807
|
type: string;
|
|
784
808
|
displayName: string;
|
|
785
|
-
logoIconUrl?: string
|
|
786
|
-
badgeIconUrl?: string
|
|
787
|
-
category?: "analytics" | "cdn" | "classic" | "commerce" | "content" | "comingSoon" | "data" | "deprecated" | "email" | "framework" | "search" | "starters" | "translation" | "uniform" | "ai" | "unknown"
|
|
788
|
-
public?: boolean
|
|
789
|
-
scopes?: string[]
|
|
790
|
-
baseLocationUrl?: string
|
|
809
|
+
logoIconUrl?: string;
|
|
810
|
+
badgeIconUrl?: string;
|
|
811
|
+
category?: "analytics" | "cdn" | "classic" | "commerce" | "content" | "comingSoon" | "data" | "deprecated" | "email" | "framework" | "search" | "starters" | "translation" | "uniform" | "ai" | "unknown";
|
|
812
|
+
public?: boolean;
|
|
813
|
+
scopes?: string[];
|
|
814
|
+
baseLocationUrl?: string;
|
|
791
815
|
locations: {
|
|
792
816
|
install?: {
|
|
793
|
-
description?: string[]
|
|
794
|
-
informationUrl?: string
|
|
795
|
-
canvasPackageUrl?: string
|
|
796
|
-
}
|
|
817
|
+
description?: string[];
|
|
818
|
+
informationUrl?: string;
|
|
819
|
+
canvasPackageUrl?: string;
|
|
820
|
+
};
|
|
797
821
|
settings?: {
|
|
798
822
|
url: string;
|
|
799
823
|
locations?: {
|
|
800
824
|
[key: string]: {
|
|
801
825
|
url: string;
|
|
802
826
|
};
|
|
803
|
-
}
|
|
804
|
-
}
|
|
827
|
+
};
|
|
828
|
+
};
|
|
805
829
|
canvas?: {
|
|
806
830
|
parameterTypes: {
|
|
807
831
|
type: string;
|
|
808
832
|
displayName: string;
|
|
809
|
-
configureUrl?: string
|
|
833
|
+
configureUrl?: string;
|
|
810
834
|
editorUrl: string;
|
|
811
835
|
configurationLocations?: {
|
|
812
836
|
[key: string]: {
|
|
813
837
|
url: string;
|
|
814
838
|
};
|
|
815
|
-
}
|
|
839
|
+
};
|
|
816
840
|
editorLocations?: {
|
|
817
841
|
[key: string]: {
|
|
818
842
|
url: string;
|
|
819
843
|
};
|
|
820
|
-
}
|
|
821
|
-
renderableInPropertyPanel?: boolean
|
|
822
|
-
localizable?: "default-yes" | "default-no" | "yes" | "no"
|
|
844
|
+
};
|
|
845
|
+
renderableInPropertyPanel?: boolean;
|
|
846
|
+
localizable?: "default-yes" | "default-no" | "yes" | "no";
|
|
847
|
+
allowedPlacement?: ("parameter" | "field")[];
|
|
823
848
|
}[];
|
|
824
849
|
editorTools?: {
|
|
825
850
|
composition?: {
|
|
826
851
|
url: string;
|
|
827
|
-
}
|
|
852
|
+
};
|
|
828
853
|
componentPattern?: {
|
|
829
854
|
url: string;
|
|
830
|
-
}
|
|
855
|
+
};
|
|
831
856
|
compositionDefaults?: {
|
|
832
857
|
url: string;
|
|
833
|
-
}
|
|
858
|
+
};
|
|
834
859
|
entry?: {
|
|
835
860
|
url: string;
|
|
836
|
-
}
|
|
861
|
+
};
|
|
837
862
|
entryPattern?: {
|
|
838
863
|
url: string;
|
|
839
|
-
}
|
|
840
|
-
}
|
|
841
|
-
}
|
|
864
|
+
};
|
|
865
|
+
};
|
|
866
|
+
};
|
|
842
867
|
dataConnectors?: {
|
|
843
868
|
type: string;
|
|
844
869
|
displayName: string;
|
|
845
|
-
dataSourceEditorUrl?: string
|
|
870
|
+
dataSourceEditorUrl?: string;
|
|
871
|
+
supportsUnpublishedData?: boolean;
|
|
872
|
+
contextualEditing?: string;
|
|
846
873
|
dataSourceEditorLocations?: {
|
|
847
874
|
[key: string]: {
|
|
848
875
|
url: string;
|
|
849
876
|
};
|
|
850
|
-
}
|
|
877
|
+
};
|
|
851
878
|
dataArchetypes?: {
|
|
852
879
|
[key: string]: {
|
|
853
880
|
displayName: string;
|
|
854
|
-
typeEditorUrl?: string
|
|
881
|
+
typeEditorUrl?: string;
|
|
855
882
|
typeEditorLocations?: {
|
|
856
883
|
[key: string]: {
|
|
857
884
|
url: string;
|
|
858
885
|
};
|
|
859
|
-
}
|
|
860
|
-
dataEditorUrl?: string
|
|
886
|
+
};
|
|
887
|
+
dataEditorUrl?: string;
|
|
861
888
|
dataEditorUrlLocations?: {
|
|
862
889
|
[key: string]: {
|
|
863
890
|
url: string;
|
|
864
891
|
};
|
|
865
|
-
}
|
|
892
|
+
};
|
|
866
893
|
};
|
|
867
|
-
}
|
|
868
|
-
badgeIconUrl?: string
|
|
869
|
-
}[]
|
|
894
|
+
};
|
|
895
|
+
badgeIconUrl?: string;
|
|
896
|
+
}[];
|
|
870
897
|
assetLibrary?: {
|
|
871
898
|
assetLibraryUrl: string;
|
|
872
899
|
assetParameterUrl: string;
|
|
900
|
+
assetLibraryLocations?: {
|
|
901
|
+
[key: string]: {
|
|
902
|
+
url: string;
|
|
903
|
+
};
|
|
904
|
+
};
|
|
873
905
|
unstable_dynamicAssets?: {
|
|
874
906
|
dataConnectorId: string;
|
|
875
907
|
assetsListArchetypeId: string;
|
|
876
908
|
singleAssetArchetypeId: string;
|
|
877
|
-
}
|
|
878
|
-
}
|
|
909
|
+
};
|
|
910
|
+
};
|
|
879
911
|
unstable_assetLibrary?: {
|
|
880
912
|
url: string;
|
|
881
913
|
dynamicAssets?: {
|
|
882
914
|
dataConnectorId: string;
|
|
883
915
|
assetsListArchetypeId: string;
|
|
884
916
|
singleAssetArchetypeId: string;
|
|
885
|
-
}
|
|
886
|
-
}
|
|
917
|
+
};
|
|
918
|
+
};
|
|
887
919
|
ai?: {
|
|
888
920
|
generateUrl: string;
|
|
889
|
-
metadataUrl?: string
|
|
921
|
+
metadataUrl?: string;
|
|
890
922
|
prompts?: {
|
|
891
923
|
id: string;
|
|
892
924
|
name: string;
|
|
@@ -895,20 +927,20 @@ declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
|
|
|
895
927
|
arguments?: {
|
|
896
928
|
[key: string]: {
|
|
897
929
|
type: string;
|
|
898
|
-
displayName?: string | null
|
|
899
|
-
helpText?: string | null
|
|
900
|
-
default?: string | null
|
|
930
|
+
displayName?: string | null;
|
|
931
|
+
helpText?: string | null;
|
|
932
|
+
default?: string | null;
|
|
901
933
|
};
|
|
902
|
-
} | null
|
|
903
|
-
metadata?: unknown;
|
|
904
|
-
} | null
|
|
934
|
+
} | null;
|
|
935
|
+
metadata?: unknown | null;
|
|
936
|
+
} | null;
|
|
905
937
|
parameterTypes: string[];
|
|
906
|
-
}[]
|
|
907
|
-
}
|
|
938
|
+
}[];
|
|
939
|
+
};
|
|
908
940
|
unstable_ai?: {
|
|
909
941
|
generateUrl: string;
|
|
910
|
-
metadataUrl?: string
|
|
911
|
-
}
|
|
942
|
+
metadataUrl?: string;
|
|
943
|
+
};
|
|
912
944
|
};
|
|
913
945
|
unstable_prompts?: {
|
|
914
946
|
id: string;
|
|
@@ -918,15 +950,15 @@ declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
|
|
|
918
950
|
arguments?: {
|
|
919
951
|
[key: string]: {
|
|
920
952
|
type: string;
|
|
921
|
-
displayName?: string | null
|
|
922
|
-
helpText?: string | null
|
|
923
|
-
default?: string | null
|
|
953
|
+
displayName?: string | null;
|
|
954
|
+
helpText?: string | null;
|
|
955
|
+
default?: string | null;
|
|
924
956
|
};
|
|
925
|
-
} | null
|
|
926
|
-
metadata?: unknown;
|
|
927
|
-
} | null
|
|
957
|
+
} | null;
|
|
958
|
+
metadata?: unknown | null;
|
|
959
|
+
} | null;
|
|
928
960
|
parameterTypes: string[];
|
|
929
|
-
}[]
|
|
961
|
+
}[];
|
|
930
962
|
}>;
|
|
931
963
|
/** Deletes a mesh app from a team */
|
|
932
964
|
remove(body: Omit<IntegrationDefinitionDeleteParameters, 'teamId'>): Promise<void>;
|
|
@@ -996,11 +1028,19 @@ type DataResourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonM
|
|
|
996
1028
|
dataConnector: DataConnectorInfo;
|
|
997
1029
|
/** Current dynamic inputs that are configured on the composition (if any). */
|
|
998
1030
|
dynamicInputs: DynamicInputs;
|
|
1031
|
+
/** Which Data Source variant is being resolved and used for getDataResource (unless overriden explicitly via providing "undefined") */
|
|
1032
|
+
dataSourceVariant?: DataSourceVariantsKeys;
|
|
999
1033
|
}, TIntegrationConfiguration>;
|
|
1000
1034
|
type DataResourceLocation = MeshLocationCore<DataResourceVariables, DataResourceLocationMetadata, DataResourceVariables, 'dataResource'> & GetDataResourceLocation;
|
|
1001
1035
|
|
|
1002
|
-
type DataSourceLocationValue = Pick<DataSource, 'baseUrl' | 'custom' | 'customPublic' | 'headers' | 'parameters' | 'variables'>;
|
|
1003
|
-
type DataSourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<
|
|
1036
|
+
type DataSourceLocationValue = Pick<DataSource, 'baseUrl' | 'custom' | 'customPublic' | 'headers' | 'parameters' | 'variables' | 'enableUnpublishedMode' | 'variants'>;
|
|
1037
|
+
type DataSourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
|
|
1038
|
+
/**
|
|
1039
|
+
* If true, the data source should provide additional configuration to support the unpublished mode and save "unpublish" Data Source variant.
|
|
1040
|
+
* E.g. inputs for Preview API Token + Preview Environment.
|
|
1041
|
+
*/
|
|
1042
|
+
enableUnpublishedMode: DataSourceLocationValue['enableUnpublishedMode'];
|
|
1043
|
+
}, TIntegrationConfiguration>;
|
|
1004
1044
|
type DataSourceLocation = MeshLocationCore<DataSourceLocationValue, DataSourceLocationMetadata, DataSourceLocationValue, 'dataSource'>;
|
|
1005
1045
|
|
|
1006
1046
|
type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfiguration = unknown> = CommonMetadata<{
|
|
@@ -1053,7 +1093,7 @@ type SettingsLocation<TSettingsType> = MeshLocationCore<TSettingsType, SettingsL
|
|
|
1053
1093
|
* Defines methods used for interacting with a Mesh location
|
|
1054
1094
|
* To receive useful typings, check the `type` property of the location to narrow the typing.
|
|
1055
1095
|
*/
|
|
1056
|
-
type MeshLocation<TValue = unknown, TSetValue = TValue> = ParamTypeLocation<TValue, unknown, TSetValue> | ParamTypeConfigLocation<TValue> | SettingsLocation<TValue> | AssetLibraryLocation | AssetParameterLocation | DataSourceLocation | DataTypeLocation | DataResourceLocation | CanvasEditorToolsLocation | AIGenerateLocation<TValue> | AIPromptMetadataLocation;
|
|
1096
|
+
type MeshLocation<TValue = unknown, TSetValue = TValue> = ParamTypeLocation<TValue, unknown, TSetValue> | ParamTypeConfigLocation<TValue> | SettingsLocation<TValue> | AssetLibraryLocation | AssetParameterLocation | DataSourceLocation | DataTypeLocation | DataResourceLocation | CanvasEditorToolsLocation | ContextualEditingLocation | AIGenerateLocation<TValue> | AIPromptMetadataLocation;
|
|
1057
1097
|
interface MeshContextData {
|
|
1058
1098
|
locationKey: string;
|
|
1059
1099
|
locationType: MeshLocationTypes;
|
|
@@ -1165,7 +1205,13 @@ type CloseDialogMessage = {
|
|
|
1165
1205
|
dialogType: DialogType;
|
|
1166
1206
|
dialogData?: unknown;
|
|
1167
1207
|
};
|
|
1168
|
-
type GetDataResourceMessage = Pick<DataType, 'path' | 'archetype' | 'headers' | 'parameters' | 'body' | 'method'
|
|
1208
|
+
type GetDataResourceMessage = Pick<DataType, 'path' | 'archetype' | 'headers' | 'parameters' | 'body' | 'method'> & {
|
|
1209
|
+
/**
|
|
1210
|
+
* Ability to override Data Source variant for particular getDataResource request,
|
|
1211
|
+
* because by default it will use Canvas Editor global. But sometimes you don't want to switch to Unpublished Data and stick to standard one.
|
|
1212
|
+
*/
|
|
1213
|
+
dataSourceVariant?: DataSourceVariantsKeys | 'standard';
|
|
1214
|
+
};
|
|
1169
1215
|
/** Primitive data types that a parameter type accepts to be bound to composition data */
|
|
1170
1216
|
type BindableTypes = 'string' | 'number' | 'boolean' | 'object' | 'array';
|
|
1171
1217
|
/** Message to parent to create a data connection expression to insert in a param type */
|
|
@@ -1360,7 +1406,7 @@ type MeshLocationUserPermissions =
|
|
|
1360
1406
|
/**
|
|
1361
1407
|
* Known location types that can be passed to a mesh location
|
|
1362
1408
|
*/
|
|
1363
|
-
type MeshLocationTypes = 'paramType' | 'paramTypeConfig' | 'assetLibrary' | 'assetParameter' | 'settings' | 'dataSource' | 'dataType' | 'dataResource' | 'aiGenerate' | 'canvasEditorTools' | 'aiMetadata';
|
|
1409
|
+
type MeshLocationTypes = 'paramType' | 'paramTypeConfig' | 'assetLibrary' | 'assetParameter' | 'settings' | 'dataSource' | 'dataType' | 'dataResource' | 'aiGenerate' | 'contextualEditing' | 'canvasEditorTools' | 'aiMetadata';
|
|
1364
1410
|
type SetValueOptions = ValidationResult;
|
|
1365
1411
|
type SetValueMessage = {
|
|
1366
1412
|
uniformMeshLocationValue: unknown;
|
|
@@ -1421,6 +1467,55 @@ type CanvasEditorToolsData = {
|
|
|
1421
1467
|
});
|
|
1422
1468
|
type CanvasEditorToolsLocation = MeshLocationCore<CanvasEditorToolsData, CanvasEditorToolsLocationMetadata, CanvasEditorToolsData, 'canvasEditorTools'> & GetDataResourceLocation;
|
|
1423
1469
|
|
|
1470
|
+
/**
|
|
1471
|
+
* @deprecated Alpha version of the Contextual Editing location. This location is not yet available for use in the Mesh SDK.
|
|
1472
|
+
* And only available for internal use.
|
|
1473
|
+
*/
|
|
1474
|
+
type ContextualEditingLocationValue<TResolvedData = unknown> = {
|
|
1475
|
+
/**
|
|
1476
|
+
* The resolved data for the data resource.
|
|
1477
|
+
*/
|
|
1478
|
+
resolvedData: TResolvedData;
|
|
1479
|
+
/**
|
|
1480
|
+
* The variables for the data resource. Contains things like entry Id
|
|
1481
|
+
*/
|
|
1482
|
+
dataResourceVariables: DataResourceVariables;
|
|
1483
|
+
/**
|
|
1484
|
+
* The JSON pointer to the data resource. If contextual editing is triggered from the bound value,
|
|
1485
|
+
* the pointer is provided to for example focus on particular field
|
|
1486
|
+
*/
|
|
1487
|
+
jsonPointer?: string;
|
|
1488
|
+
};
|
|
1489
|
+
/**
|
|
1490
|
+
* @deprecated Alpha version of the Contextual Editing location. This location is not yet available for use in the Mesh SDK.
|
|
1491
|
+
* And only available for internal use.
|
|
1492
|
+
*/
|
|
1493
|
+
type ContextualEditingLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
|
|
1494
|
+
/**
|
|
1495
|
+
* Contains useful info like archetype or default content type filters
|
|
1496
|
+
*/
|
|
1497
|
+
dataType: DataType;
|
|
1498
|
+
/**
|
|
1499
|
+
* The current data resource's data source. NOTE: param and header values are not available in this context.
|
|
1500
|
+
*/
|
|
1501
|
+
dataSource: DataSource;
|
|
1502
|
+
/**
|
|
1503
|
+
* To explicitly show the difference between Add and Edit actions
|
|
1504
|
+
*/
|
|
1505
|
+
actionType: 'edit' | 'create';
|
|
1506
|
+
}, TIntegrationConfiguration>;
|
|
1507
|
+
/**
|
|
1508
|
+
* @deprecated Alpha version of the Contextual Editing location. This location is not yet available for use in the Mesh SDK.
|
|
1509
|
+
*
|
|
1510
|
+
* Useful in case when creating new content item and we want to set this new item as Data Resource variable.
|
|
1511
|
+
*/
|
|
1512
|
+
type ContextualEditingLocationSetValue = DataResourceVariables;
|
|
1513
|
+
/**
|
|
1514
|
+
* @deprecated Alpha version of the Contextual Editing location. This location is not yet available for use in the Mesh SDK.
|
|
1515
|
+
* And only available for internal use.
|
|
1516
|
+
*/
|
|
1517
|
+
type ContextualEditingLocation = MeshLocationCore<ContextualEditingLocationValue, ContextualEditingLocationMetadata, ContextualEditingLocationSetValue, 'contextualEditing'> & GetDataResourceLocation;
|
|
1518
|
+
|
|
1424
1519
|
type ParamTypeConfigLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
|
|
1425
1520
|
/** The Uniform project ID */
|
|
1426
1521
|
componentDefinition: ComponentDefinition;
|
|
@@ -1530,4 +1625,4 @@ declare const hasPermissions: (permissions: MeshLocationUserPermissions | MeshLo
|
|
|
1530
1625
|
*/
|
|
1531
1626
|
declare const hasRole: (role: string, user: UniformUser) => boolean;
|
|
1532
1627
|
|
|
1533
|
-
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 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 };
|
|
1628
|
+
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 ContextualEditingLocation, type ContextualEditingLocationMetadata, type ContextualEditingLocationSetValue, type ContextualEditingLocationValue, 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.esm.js
CHANGED
package/dist/index.js
CHANGED
package/dist/index.mjs
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@uniformdev/mesh-sdk",
|
|
3
|
-
"version": "19.173.
|
|
3
|
+
"version": "19.173.2-alpha.258+e8775b83de",
|
|
4
4
|
"description": "Uniform Mesh Framework SDK",
|
|
5
5
|
"license": "SEE LICENSE IN LICENSE.txt",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -34,14 +34,14 @@
|
|
|
34
34
|
"access": "public"
|
|
35
35
|
},
|
|
36
36
|
"dependencies": {
|
|
37
|
-
"@uniformdev/canvas": "19.173.
|
|
38
|
-
"@uniformdev/context": "19.173.
|
|
39
|
-
"@uniformdev/project-map": "19.173.
|
|
37
|
+
"@uniformdev/canvas": "19.173.2-alpha.258+e8775b83de",
|
|
38
|
+
"@uniformdev/context": "19.173.2-alpha.258+e8775b83de",
|
|
39
|
+
"@uniformdev/project-map": "19.173.2-alpha.258+e8775b83de",
|
|
40
40
|
"imagesloaded": "^5.0.0",
|
|
41
|
-
"mitt": "^3.0.
|
|
41
|
+
"mitt": "^3.0.1"
|
|
42
42
|
},
|
|
43
43
|
"devDependencies": {
|
|
44
44
|
"@types/imagesloaded": "^4.1.2"
|
|
45
45
|
},
|
|
46
|
-
"gitHead": "
|
|
46
|
+
"gitHead": "e8775b83dec606ce6e2198182152d8b386e15f94"
|
|
47
47
|
}
|