@uniformdev/mesh-sdk 19.184.1-alpha.0 → 19.184.1-alpha.22

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import { ApiClient, ClientOptions, ExceptProject } from '@uniformdev/context/api';
 import { ProjectMapNode } from '@uniformdev/project-map';
-import { AssetParamValue, DataType, DataSource, DataResourceVariables, RootComponentInstance, ComponentInstance, ComponentDefinition, ComponentDefinitionParameter, Locale, DataVariableDefinition, EntryData } from '@uniformdev/canvas';
+import { AssetParamValue, DataType, DataSource, DataSourceVariantsKeys, DataResourceVariables, RootComponentInstance, ComponentInstance, ComponentDefinition, ComponentDefinitionParameter, Locale, DataVariableDefinition, EntryData } from '@uniformdev/canvas';
 export { AssetParamValue, AssetParamValueItem } from '@uniformdev/canvas';
 import { Emitter } from 'mitt';
 
@@ -90,6 +90,7 @@ interface paths$1 {
                                         type: string;
                                         displayName: string;
                                         dataSourceEditorUrl?: string;
+                                        supportsUnpublishedData?: boolean;
                                         dataSourceEditorLocations?: {
                                             [key: string]: {
                                                 url: string;
@@ -264,6 +265,7 @@ interface paths$1 {
                                     type: string;
                                     displayName: string;
                                     dataSourceEditorUrl?: string;
+                                    supportsUnpublishedData?: boolean;
                                     dataSourceEditorLocations?: {
                                         [key: string]: {
                                             url: string;
@@ -437,6 +439,7 @@ interface paths$1 {
                                     type: string;
                                     displayName: string;
                                     dataSourceEditorUrl?: string;
+                                    supportsUnpublishedData?: boolean;
                                     dataSourceEditorLocations?: {
                                         [key: string]: {
                                             url: string;
@@ -858,6 +861,7 @@ declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
                 type: string;
                 displayName: string;
                 dataSourceEditorUrl?: string;
+                supportsUnpublishedData?: boolean;
                 dataSourceEditorLocations?: {
                     [key: string]: {
                         url: string;
@@ -1016,11 +1020,19 @@ type DataResourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonM
     dataConnector: DataConnectorInfo;
     /** Current dynamic inputs that are configured on the composition (if any). */
     dynamicInputs: DynamicInputs;
+    /** Which Data Source variant is being resolved and used for getDataResource (unless overriden explicitly) */
+    dataSourceVariant?: DataSourceVariantsKeys;
 }, TIntegrationConfiguration>;
 type DataResourceLocation = MeshLocationCore<DataResourceVariables, DataResourceLocationMetadata, DataResourceVariables, 'dataResource'> & GetDataResourceLocation;
 
-type DataSourceLocationValue = Pick<DataSource, 'baseUrl' | 'custom' | 'customPublic' | 'headers' | 'parameters' | 'variables'>;
-type DataSourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<unknown, TIntegrationConfiguration>;
+type DataSourceLocationValue = Pick<DataSource, 'baseUrl' | 'custom' | 'customPublic' | 'headers' | 'parameters' | 'variables' | 'enableUnpublishedMode' | 'variants'>;
+type DataSourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
+    /**
+     * If true, the data source should provide additional configuration to support the unpublished mode and save "unpublish" Data Source variant.
+     * E.g. inputs for Preview API Token + Preview Environment.
+     */
+    enableUnpublishedMode: DataSourceLocationValue['enableUnpublishedMode'];
+}, TIntegrationConfiguration>;
 type DataSourceLocation = MeshLocationCore<DataSourceLocationValue, DataSourceLocationMetadata, DataSourceLocationValue, 'dataSource'>;
 
 type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfiguration = unknown> = CommonMetadata<{
@@ -1185,7 +1197,13 @@ type CloseDialogMessage = {
     dialogType: DialogType;
     dialogData?: unknown;
 };
-type GetDataResourceMessage = Pick<DataType, 'path' | 'archetype' | 'headers' | 'parameters' | 'body' | 'method'>;
+type GetDataResourceMessage = Pick<DataType, 'path' | 'archetype' | 'headers' | 'parameters' | 'body' | 'method'> & {
+    /**
+     * Ability to override Data Source variant for particular getDataResource request,
+     * 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.
+     */
+    dataSourceVariant?: DataSourceVariantsKeys | 'standard';
+};
 /** Primitive data types that a parameter type accepts to be bound to composition data */
 type BindableTypes = 'string' | 'number' | 'boolean' | 'object' | 'array';
 /** Message to parent to create a data connection expression to insert in a param type */

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { ApiClient, ClientOptions, ExceptProject } from '@uniformdev/context/api';
 import { ProjectMapNode } from '@uniformdev/project-map';
-import { AssetParamValue, DataType, DataSource, DataResourceVariables, RootComponentInstance, ComponentInstance, ComponentDefinition, ComponentDefinitionParameter, Locale, DataVariableDefinition, EntryData } from '@uniformdev/canvas';
+import { AssetParamValue, DataType, DataSource, DataSourceVariantsKeys, DataResourceVariables, RootComponentInstance, ComponentInstance, ComponentDefinition, ComponentDefinitionParameter, Locale, DataVariableDefinition, EntryData } from '@uniformdev/canvas';
 export { AssetParamValue, AssetParamValueItem } from '@uniformdev/canvas';
 import { Emitter } from 'mitt';
 
@@ -90,6 +90,7 @@ interface paths$1 {
                                         type: string;
                                         displayName: string;
                                         dataSourceEditorUrl?: string;
+                                        supportsUnpublishedData?: boolean;
                                         dataSourceEditorLocations?: {
                                             [key: string]: {
                                                 url: string;
@@ -264,6 +265,7 @@ interface paths$1 {
                                     type: string;
                                     displayName: string;
                                     dataSourceEditorUrl?: string;
+                                    supportsUnpublishedData?: boolean;
                                     dataSourceEditorLocations?: {
                                         [key: string]: {
                                             url: string;
@@ -437,6 +439,7 @@ interface paths$1 {
                                     type: string;
                                     displayName: string;
                                     dataSourceEditorUrl?: string;
+                                    supportsUnpublishedData?: boolean;
                                     dataSourceEditorLocations?: {
                                         [key: string]: {
                                             url: string;
@@ -858,6 +861,7 @@ declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
                 type: string;
                 displayName: string;
                 dataSourceEditorUrl?: string;
+                supportsUnpublishedData?: boolean;
                 dataSourceEditorLocations?: {
                     [key: string]: {
                         url: string;
@@ -1016,11 +1020,19 @@ type DataResourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonM
     dataConnector: DataConnectorInfo;
     /** Current dynamic inputs that are configured on the composition (if any). */
     dynamicInputs: DynamicInputs;
+    /** Which Data Source variant is being resolved and used for getDataResource (unless overriden explicitly) */
+    dataSourceVariant?: DataSourceVariantsKeys;
 }, TIntegrationConfiguration>;
 type DataResourceLocation = MeshLocationCore<DataResourceVariables, DataResourceLocationMetadata, DataResourceVariables, 'dataResource'> & GetDataResourceLocation;
 
-type DataSourceLocationValue = Pick<DataSource, 'baseUrl' | 'custom' | 'customPublic' | 'headers' | 'parameters' | 'variables'>;
-type DataSourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<unknown, TIntegrationConfiguration>;
+type DataSourceLocationValue = Pick<DataSource, 'baseUrl' | 'custom' | 'customPublic' | 'headers' | 'parameters' | 'variables' | 'enableUnpublishedMode' | 'variants'>;
+type DataSourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
+    /**
+     * If true, the data source should provide additional configuration to support the unpublished mode and save "unpublish" Data Source variant.
+     * E.g. inputs for Preview API Token + Preview Environment.
+     */
+    enableUnpublishedMode: DataSourceLocationValue['enableUnpublishedMode'];
+}, TIntegrationConfiguration>;
 type DataSourceLocation = MeshLocationCore<DataSourceLocationValue, DataSourceLocationMetadata, DataSourceLocationValue, 'dataSource'>;
 
 type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfiguration = unknown> = CommonMetadata<{
@@ -1185,7 +1197,13 @@ type CloseDialogMessage = {
     dialogType: DialogType;
     dialogData?: unknown;
 };
-type GetDataResourceMessage = Pick<DataType, 'path' | 'archetype' | 'headers' | 'parameters' | 'body' | 'method'>;
+type GetDataResourceMessage = Pick<DataType, 'path' | 'archetype' | 'headers' | 'parameters' | 'body' | 'method'> & {
+    /**
+     * Ability to override Data Source variant for particular getDataResource request,
+     * 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.
+     */
+    dataSourceVariant?: DataSourceVariantsKeys | 'standard';
+};
 /** Primitive data types that a parameter type accepts to be bound to composition data */
 type BindableTypes = 'string' | 'number' | 'boolean' | 'object' | 'array';
 /** Message to parent to create a data connection expression to insert in a param type */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/mesh-sdk",
-  "version": "19.184.1-alpha.0+1f5a1fa7b2",
+  "version": "19.184.1-alpha.22+a7fd564cd5",
   "description": "Uniform Mesh Framework SDK",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -34,14 +34,14 @@
     "access": "public"
   },
   "dependencies": {
-    "@uniformdev/canvas": "19.184.1-alpha.0+1f5a1fa7b2",
-    "@uniformdev/context": "19.184.1-alpha.0+1f5a1fa7b2",
-    "@uniformdev/project-map": "19.184.1-alpha.0+1f5a1fa7b2",
+    "@uniformdev/canvas": "19.184.1-alpha.22+a7fd564cd5",
+    "@uniformdev/context": "19.184.1-alpha.22+a7fd564cd5",
+    "@uniformdev/project-map": "19.184.1-alpha.22+a7fd564cd5",
     "imagesloaded": "^5.0.0",
     "mitt": "^3.0.1"
   },
   "devDependencies": {
     "@types/imagesloaded": "^4.1.2"
   },
-  "gitHead": "1f5a1fa7b28d2161b8f29891a12a13d026766bc0"
+  "gitHead": "a7fd564cd599786d0a9504495b7330cd77072039"
 }