@uniformdev/mesh-sdk 19.185.1-alpha.8 → 19.186.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 (6) hide show
  1. package/dist/index.d.mts +22 -4
  2. package/dist/index.d.ts +22 -4
  3. package/dist/index.esm.js +1 -1
  4. package/dist/index.js +1 -1
  5. package/dist/index.mjs +1 -1
  6. package/package.json +5 -5
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
 
@@ -91,6 +91,7 @@ interface paths$1 {
91
91
  type: string;
92
92
  displayName: string;
93
93
  dataSourceEditorUrl?: string;
94
+ supportsUnpublishedData?: boolean;
94
95
  dataSourceEditorLocations?: {
95
96
  [key: string]: {
96
97
  url: string;
@@ -266,6 +267,7 @@ interface paths$1 {
266
267
  type: string;
267
268
  displayName: string;
268
269
  dataSourceEditorUrl?: string;
270
+ supportsUnpublishedData?: boolean;
269
271
  dataSourceEditorLocations?: {
270
272
  [key: string]: {
271
273
  url: string;
@@ -440,6 +442,7 @@ interface paths$1 {
440
442
  type: string;
441
443
  displayName: string;
442
444
  dataSourceEditorUrl?: string;
445
+ supportsUnpublishedData?: boolean;
443
446
  dataSourceEditorLocations?: {
444
447
  [key: string]: {
445
448
  url: string;
@@ -862,6 +865,7 @@ declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
862
865
  type: string;
863
866
  displayName: string;
864
867
  dataSourceEditorUrl?: string;
868
+ supportsUnpublishedData?: boolean;
865
869
  dataSourceEditorLocations?: {
866
870
  [key: string]: {
867
871
  url: string;
@@ -1020,11 +1024,19 @@ type DataResourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonM
1020
1024
  dataConnector: DataConnectorInfo;
1021
1025
  /** Current dynamic inputs that are configured on the composition (if any). */
1022
1026
  dynamicInputs: DynamicInputs;
1027
+ /** Which Data Source variant is being resolved and used for getDataResource (unless overriden explicitly) */
1028
+ dataSourceVariant?: DataSourceVariantsKeys;
1023
1029
  }, TIntegrationConfiguration>;
1024
1030
  type DataResourceLocation = MeshLocationCore<DataResourceVariables, DataResourceLocationMetadata, DataResourceVariables, 'dataResource'> & GetDataResourceLocation;
1025
1031
 
1026
- type DataSourceLocationValue = Pick<DataSource, 'baseUrl' | 'custom' | 'customPublic' | 'headers' | 'parameters' | 'variables'>;
1027
- type DataSourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<unknown, TIntegrationConfiguration>;
1032
+ type DataSourceLocationValue = Pick<DataSource, 'baseUrl' | 'custom' | 'customPublic' | 'headers' | 'parameters' | 'variables' | 'enableUnpublishedMode' | 'variants'>;
1033
+ type DataSourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
1034
+ /**
1035
+ * If true, the data source should provide additional configuration to support the unpublished mode and save "unpublish" Data Source variant.
1036
+ * E.g. inputs for Preview API Token + Preview Environment.
1037
+ */
1038
+ enableUnpublishedMode: DataSourceLocationValue['enableUnpublishedMode'];
1039
+ }, TIntegrationConfiguration>;
1028
1040
  type DataSourceLocation = MeshLocationCore<DataSourceLocationValue, DataSourceLocationMetadata, DataSourceLocationValue, 'dataSource'>;
1029
1041
 
1030
1042
  type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfiguration = unknown> = CommonMetadata<{
@@ -1189,7 +1201,13 @@ type CloseDialogMessage = {
1189
1201
  dialogType: DialogType;
1190
1202
  dialogData?: unknown;
1191
1203
  };
1192
- type GetDataResourceMessage = Pick<DataType, 'path' | 'archetype' | 'headers' | 'parameters' | 'body' | 'method'>;
1204
+ type GetDataResourceMessage = Pick<DataType, 'path' | 'archetype' | 'headers' | 'parameters' | 'body' | 'method'> & {
1205
+ /**
1206
+ * Ability to override Data Source variant for particular getDataResource request,
1207
+ * 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.
1208
+ */
1209
+ dataSourceVariant?: DataSourceVariantsKeys | 'standard';
1210
+ };
1193
1211
  /** Primitive data types that a parameter type accepts to be bound to composition data */
1194
1212
  type BindableTypes = 'string' | 'number' | 'boolean' | 'object' | 'array';
1195
1213
  /** Message to parent to create a data connection expression to insert in a param type */
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
 
@@ -91,6 +91,7 @@ interface paths$1 {
91
91
  type: string;
92
92
  displayName: string;
93
93
  dataSourceEditorUrl?: string;
94
+ supportsUnpublishedData?: boolean;
94
95
  dataSourceEditorLocations?: {
95
96
  [key: string]: {
96
97
  url: string;
@@ -266,6 +267,7 @@ interface paths$1 {
266
267
  type: string;
267
268
  displayName: string;
268
269
  dataSourceEditorUrl?: string;
270
+ supportsUnpublishedData?: boolean;
269
271
  dataSourceEditorLocations?: {
270
272
  [key: string]: {
271
273
  url: string;
@@ -440,6 +442,7 @@ interface paths$1 {
440
442
  type: string;
441
443
  displayName: string;
442
444
  dataSourceEditorUrl?: string;
445
+ supportsUnpublishedData?: boolean;
443
446
  dataSourceEditorLocations?: {
444
447
  [key: string]: {
445
448
  url: string;
@@ -862,6 +865,7 @@ declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
862
865
  type: string;
863
866
  displayName: string;
864
867
  dataSourceEditorUrl?: string;
868
+ supportsUnpublishedData?: boolean;
865
869
  dataSourceEditorLocations?: {
866
870
  [key: string]: {
867
871
  url: string;
@@ -1020,11 +1024,19 @@ type DataResourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonM
1020
1024
  dataConnector: DataConnectorInfo;
1021
1025
  /** Current dynamic inputs that are configured on the composition (if any). */
1022
1026
  dynamicInputs: DynamicInputs;
1027
+ /** Which Data Source variant is being resolved and used for getDataResource (unless overriden explicitly) */
1028
+ dataSourceVariant?: DataSourceVariantsKeys;
1023
1029
  }, TIntegrationConfiguration>;
1024
1030
  type DataResourceLocation = MeshLocationCore<DataResourceVariables, DataResourceLocationMetadata, DataResourceVariables, 'dataResource'> & GetDataResourceLocation;
1025
1031
 
1026
- type DataSourceLocationValue = Pick<DataSource, 'baseUrl' | 'custom' | 'customPublic' | 'headers' | 'parameters' | 'variables'>;
1027
- type DataSourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<unknown, TIntegrationConfiguration>;
1032
+ type DataSourceLocationValue = Pick<DataSource, 'baseUrl' | 'custom' | 'customPublic' | 'headers' | 'parameters' | 'variables' | 'enableUnpublishedMode' | 'variants'>;
1033
+ type DataSourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
1034
+ /**
1035
+ * If true, the data source should provide additional configuration to support the unpublished mode and save "unpublish" Data Source variant.
1036
+ * E.g. inputs for Preview API Token + Preview Environment.
1037
+ */
1038
+ enableUnpublishedMode: DataSourceLocationValue['enableUnpublishedMode'];
1039
+ }, TIntegrationConfiguration>;
1028
1040
  type DataSourceLocation = MeshLocationCore<DataSourceLocationValue, DataSourceLocationMetadata, DataSourceLocationValue, 'dataSource'>;
1029
1041
 
1030
1042
  type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfiguration = unknown> = CommonMetadata<{
@@ -1189,7 +1201,13 @@ type CloseDialogMessage = {
1189
1201
  dialogType: DialogType;
1190
1202
  dialogData?: unknown;
1191
1203
  };
1192
- type GetDataResourceMessage = Pick<DataType, 'path' | 'archetype' | 'headers' | 'parameters' | 'body' | 'method'>;
1204
+ type GetDataResourceMessage = Pick<DataType, 'path' | 'archetype' | 'headers' | 'parameters' | 'body' | 'method'> & {
1205
+ /**
1206
+ * Ability to override Data Source variant for particular getDataResource request,
1207
+ * 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.
1208
+ */
1209
+ dataSourceVariant?: DataSourceVariantsKeys | 'standard';
1210
+ };
1193
1211
  /** Primitive data types that a parameter type accepts to be bound to composition data */
1194
1212
  type BindableTypes = 'string' | 'number' | 'boolean' | 'object' | 'array';
1195
1213
  /** Message to parent to create a data connection expression to insert in a param type */
package/dist/index.esm.js CHANGED
@@ -113,7 +113,7 @@ var getLogger = (prefix, debug) => {
113
113
  };
114
114
 
115
115
  // src/temp/version.ts
116
- var UNIFORM_MESH_SDK_VERSION = "19.185.0";
116
+ var UNIFORM_MESH_SDK_VERSION = "19.186.1";
117
117
 
118
118
  // src/framepost/constants.ts
119
119
  var DEFAULT_REQUEST_TIMEOUT = 5e3;
package/dist/index.js CHANGED
@@ -152,7 +152,7 @@ var getLogger = (prefix, debug) => {
152
152
  };
153
153
 
154
154
  // src/temp/version.ts
155
- var UNIFORM_MESH_SDK_VERSION = "19.185.0";
155
+ var UNIFORM_MESH_SDK_VERSION = "19.186.1";
156
156
 
157
157
  // src/framepost/constants.ts
158
158
  var DEFAULT_REQUEST_TIMEOUT = 5e3;
package/dist/index.mjs CHANGED
@@ -113,7 +113,7 @@ var getLogger = (prefix, debug) => {
113
113
  };
114
114
 
115
115
  // src/temp/version.ts
116
- var UNIFORM_MESH_SDK_VERSION = "19.185.0";
116
+ var UNIFORM_MESH_SDK_VERSION = "19.186.1";
117
117
 
118
118
  // src/framepost/constants.ts
119
119
  var DEFAULT_REQUEST_TIMEOUT = 5e3;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uniformdev/mesh-sdk",
3
- "version": "19.185.1-alpha.8+53f7f96124",
3
+ "version": "19.186.1",
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.185.1-alpha.8+53f7f96124",
38
- "@uniformdev/context": "19.185.1-alpha.8+53f7f96124",
39
- "@uniformdev/project-map": "19.185.1-alpha.8+53f7f96124",
37
+ "@uniformdev/canvas": "19.186.1",
38
+ "@uniformdev/context": "19.186.1",
39
+ "@uniformdev/project-map": "19.186.1",
40
40
  "imagesloaded": "^5.0.0",
41
41
  "mitt": "^3.0.1"
42
42
  },
43
43
  "devDependencies": {
44
44
  "@types/imagesloaded": "^4.1.2"
45
45
  },
46
- "gitHead": "53f7f961242f3518b103e55337ada7ad91c18dd7"
46
+ "gitHead": "12ca61d140d99b4f2de67428425076cecbc6577b"
47
47
  }