@uniformdev/mesh-sdk 17.1.1-alpha.498 → 17.1.1-alpha.752

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { Emitter } from 'mitt';
-import { RootComponentInstance, ComponentInstance, ComponentDefinition, ComponentDefinitionParameter, DataConnection, DataConnectionInfo, DataType, CompositionDataVariables } from '@uniformdev/canvas';
+import { RootComponentInstance, ComponentInstance, ComponentDefinition, ComponentDefinitionParameter, DataSource, DataSourceInfo, DataType, DataResourceVariables } from '@uniformdev/canvas';
 
 /** Core shared generic for a mesh location context */
 interface MeshLocationCore<TValue = unknown, TMetadata = unknown, TSetValue = TValue, TType extends MeshLocationTypes = MeshLocationTypes> {
@@ -26,6 +26,7 @@ interface MeshLocationCore<TValue = unknown, TMetadata = unknown, TSetValue = TV
     metadata: TMetadata;
     /**
      * Instructs Uniform to set the validity of the location in the parent app.
+     * @deprecated - use setValue(value, validationResult) instead
      */
     setValidationResult: (value: ValidationResult) => Promise<void>;
     /**
@@ -37,14 +38,18 @@ interface MeshLocationCore<TValue = unknown, TMetadata = unknown, TSetValue = TV
      * This is undefined when the current location is not a dialog.
      */
     dialogContext?: DialogContext & {
+        /** Parameters passed to the dialog when it was opened */
         params: unknown;
+        /**
+         * Returns a result to the dialog opener.
+         */
         returnDialogValue: (value: unknown) => Promise<void>;
     };
 }
 /**
  * Known location types that can be passed to a mesh location
  */
-declare type MeshLocationTypes = 'paramType' | 'paramTypeConfig' | 'settings' | 'dataConnection' | 'dataType' | 'dataTypeInstance';
+declare type MeshLocationTypes = 'paramType' | 'paramTypeConfig' | 'settings' | 'dataSource' | 'dataType' | 'dataTypeInstance';
 declare type SetValueOptions = ValidationResult;
 
 declare type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfiguration = unknown> = {
@@ -66,12 +71,12 @@ declare type ParamTypeConfigLocation<TParamValue = unknown, TIntegrationConfigur
 
 declare type SettingsLocation<TSettingsType> = MeshLocationCore<TSettingsType, undefined, TSettingsType, 'settings'>;
 
-declare type DataConnectionLocationValue = Pick<DataConnection, 'baseUrl' | 'custom' | 'headers' | 'parameters' | 'variables'>;
-declare type DataConnectionLocationMetadata<TIntegrationConfiguration = unknown> = {
+declare type DataSourceLocationValue = Pick<DataSource, 'baseUrl' | 'custom' | 'headers' | 'parameters' | 'variables'>;
+declare type DataSourceLocationMetadata<TIntegrationConfiguration = unknown> = {
     settings: TIntegrationConfiguration;
     projectId: string;
 };
-declare type DataConnectionLocation = MeshLocationCore<DataConnectionLocationValue, DataConnectionLocationMetadata, DataConnectionLocationValue, 'dataConnection'>;
+declare type DataSourceLocation = MeshLocationCore<DataSourceLocationValue, DataSourceLocationMetadata, DataSourceLocationValue, 'dataSource'>;
 
 declare type DataTypeValue = Pick<DataType, 'body' | 'method' | 'path' | 'custom' | 'headers' | 'parameters' | 'variables'>;
 declare type DataConnectorInfo = {
@@ -82,7 +87,7 @@ declare type DataConnectorInfo = {
 declare type DataTypeLocationMetadata<TIntegrationConfiguration = unknown> = {
     settings: TIntegrationConfiguration;
     projectId: string;
-    dataConnection: DataConnectionInfo;
+    dataSource: DataSourceInfo;
     dataConnector: DataConnectorInfo;
 };
 declare type DataTypeLocation = MeshLocationCore<DataTypeValue, DataTypeLocationMetadata, DataTypeValue, 'dataType'>;
@@ -93,13 +98,13 @@ declare type DataTypeInstanceLocationMetadata<TIntegrationConfiguration = unknow
     dataConnector: DataConnectorInfo;
     projectId: string;
 };
-declare type DataTypeInstanceLocation = MeshLocationCore<CompositionDataVariables, DataTypeInstanceLocationMetadata, CompositionDataVariables, 'dataTypeInstance'>;
+declare type DataTypeInstanceLocation = MeshLocationCore<DataResourceVariables, DataTypeInstanceLocationMetadata, DataResourceVariables, 'dataTypeInstance'>;
 
 /**
  * Defines methods used for interacting with a Mesh location
  * To receive useful typings, check the `type` property of the location to narrow the typing.
  */
-declare type MeshLocation<TValue = unknown, TSetValue = TValue> = ParamTypeLocation<TValue, unknown, TSetValue> | ParamTypeConfigLocation<TValue> | SettingsLocation<TValue> | DataConnectionLocation | DataTypeLocation | DataTypeInstanceLocation;
+declare type MeshLocation<TValue = unknown, TSetValue = TValue> = ParamTypeLocation<TValue, unknown, TSetValue> | ParamTypeConfigLocation<TValue> | SettingsLocation<TValue> | DataSourceLocation | DataTypeLocation | DataTypeInstanceLocation;
 interface MeshContextData {
     locationKey: string;
     locationType: MeshLocationTypes;
@@ -176,10 +181,12 @@ declare type DialogParams = {
     [paramName: string]: DialogParamValue;
 };
 declare type CSSHeight = '-moz-initial' | 'inherit' | 'initial' | 'revert' | 'unset' | '-moz-max-content' | '-moz-min-content' | '-webkit-fit-content' | 'auto' | 'fit-content' | 'max-content' | 'min-content' | `${number}${'px' | 'em' | 'rem' | 'vh'}`;
-interface ValidationResult {
-    isValid?: boolean;
-    validationMessage?: string;
-}
+declare type ValidationResult = {
+    isValid: false;
+    validationMessage: string;
+} | {
+    isValid: true;
+};
 
 interface SdkWindow {
     /** The current window object. */
@@ -276,4 +283,4 @@ declare function initializeUniformMeshSDK({ autoResizingDisabled, }?: {
     autoResizingDisabled?: boolean;
 }): Promise<UniformMeshSDK | undefined>;
 
-export { CSSHeight, CloseLocationDialogOptions, DataConnectionLocation, DataConnectionLocationMetadata, DataConnectionLocationValue, DataConnectorInfo, DataTypeInstanceLocation, DataTypeInstanceLocationMetadata, DataTypeLocation, DataTypeLocationMetadata, DialogContext, DialogOptions, DialogParamValue, DialogParams, DialogResponseData, DialogResponseHandler, DialogResponseHandlers, DialogType, LocationDialogResponse, MeshContextData, MeshLocation, MeshLocationCore, MeshLocationTypes, OpenConfirmationDialogOptions, OpenConfirmationDialogResult, OpenDialogResult, OpenLocationDialogOptions, ParamTypeConfigLocation, ParamTypeConfigLocationMetadata, ParamTypeLocation, ParamTypeLocationMetadata, SdkWindow, SetValueOptions, SettingsLocation, UniformMeshSDK, UniformMeshSDKEvents, ValidationResult, initializeUniformMeshSDK };
+export { CSSHeight, CloseLocationDialogOptions, DataConnectorInfo, DataSourceLocation, DataSourceLocationMetadata, DataSourceLocationValue, DataTypeInstanceLocation, DataTypeInstanceLocationMetadata, DataTypeLocation, DataTypeLocationMetadata, DialogContext, DialogOptions, DialogParamValue, DialogParams, DialogResponseData, DialogResponseHandler, DialogResponseHandlers, DialogType, LocationDialogResponse, MeshContextData, MeshLocation, MeshLocationCore, MeshLocationTypes, OpenConfirmationDialogOptions, OpenConfirmationDialogResult, OpenDialogResult, OpenLocationDialogOptions, ParamTypeConfigLocation, ParamTypeConfigLocationMetadata, ParamTypeLocation, ParamTypeLocationMetadata, SdkWindow, SetValueOptions, SettingsLocation, UniformMeshSDK, UniformMeshSDKEvents, ValidationResult, initializeUniformMeshSDK };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/mesh-sdk",
-  "version": "17.1.1-alpha.498+8b406a3f5",
+  "version": "17.1.1-alpha.752+3e63e24bd",
   "description": "Uniform Mesh Framework SDK",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -29,8 +29,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@uniformdev/canvas": "^17.1.1-alpha.498+8b406a3f5",
+    "@uniformdev/canvas": "^17.1.1-alpha.752+3e63e24bd",
     "mitt": "^3.0.0"
   },
-  "gitHead": "8b406a3f5371b2910459a25883bd14ff5c94cd69"
+  "gitHead": "3e63e24bdfe658b80cc14a2dbc84748694637c52"
 }