@uniformdev/mesh-sdk 17.7.0 → 17.7.1-alpha.167

package/dist/index.d.ts

@@ -1,46 +1,36 @@
-import { DataType, DataSource, DataResourceVariables, RootComponentInstance, ComponentInstance, ComponentDefinition, ComponentDefinitionParameter } from '@uniformdev/canvas';
+import { DataSource, RootComponentInstance, ComponentInstance, ComponentDefinition, ComponentDefinitionParameter, DataType as DataType$1, DataResourceVariables } from '@uniformdev/canvas';
+import { DataType } from '@uniformdev/canvas/.';
 import { Emitter } from 'mitt';
 
-declare type DataTypeLocationValue = Pick<DataType, 'body' | 'method' | 'path' | 'custom' | 'headers' | 'parameters' | 'variables'>;
-declare type DataConnectorInfo = {
-    type: string;
-    displayName: string;
-    installedIntegrationId: string;
-};
-declare type DataTypeLocationMetadata<TIntegrationConfiguration = unknown> = {
-    settings: TIntegrationConfiguration;
-    projectId: string;
-    dataSource: DataSource;
-    dataConnector: DataConnectorInfo;
-};
-declare type DataTypeLocation = MeshLocationCore<DataTypeLocationValue, DataTypeLocationMetadata, DataTypeLocationValue, 'dataType'>;
-
-declare type DataTypeInstanceLocationMetadata<TIntegrationConfiguration = unknown> = {
+type DataSourceLocationValue = Pick<DataSource, 'baseUrl' | 'custom' | 'headers' | 'parameters' | 'variables'>;
+type DataSourceLocationMetadata<TIntegrationConfiguration = unknown> = {
+    /** Settings defined at the integration level (arbitrary type used on settings location) */
     settings: TIntegrationConfiguration;
-    dataType: DataType;
-    dataConnector: DataConnectorInfo;
+    /** The Uniform project ID */
     projectId: string;
 };
-declare type DataTypeInstanceLocation = MeshLocationCore<DataResourceVariables, DataTypeInstanceLocationMetadata, DataResourceVariables, 'dataTypeInstance'>;
+type DataSourceLocation = MeshLocationCore<DataSourceLocationValue, DataSourceLocationMetadata, DataSourceLocationValue, 'dataSource'>;
 
-declare type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfiguration = unknown> = {
+type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfiguration = unknown> = {
     rootNode: Omit<RootComponentInstance, 'slots' | '_data'>;
     parameterConfiguration: TParamConfiguration;
     component: Omit<ComponentInstance, 'slots' | '_parameters' | '_id'>;
     componentDefinitions: Record<string, ComponentDefinition | undefined>;
     parameterDefinition: ComponentDefinitionParameter;
+    /** Settings defined at the integration level (arbitrary type used on settings location) */
     settings: TIntegrationConfiguration;
+    /** The Uniform project ID */
     projectId: string;
 };
-declare type ParamTypeLocation<TParamValue = unknown, TParamConfiguration = unknown, TParamSetValue = TParamValue, TIntegrationConfiguration = unknown> = MeshLocationCore<TParamValue, ParamTypeLocationMetadata<TParamConfiguration, TIntegrationConfiguration>, TParamSetValue, 'paramType'>;
+type ParamTypeLocation<TParamValue = unknown, TParamConfiguration = unknown, TParamSetValue = TParamValue, TIntegrationConfiguration = unknown> = MeshLocationCore<TParamValue, ParamTypeLocationMetadata<TParamConfiguration, TIntegrationConfiguration>, TParamSetValue, 'paramType'>;
 
-declare type SettingsLocation<TSettingsType> = MeshLocationCore<TSettingsType, undefined, TSettingsType, 'settings'>;
+type SettingsLocation<TSettingsType> = MeshLocationCore<TSettingsType, undefined, TSettingsType, 'settings'>;
 
 /**
  * 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> | DataSourceLocation | DataTypeLocation | DataTypeInstanceLocation;
+type MeshLocation<TValue = unknown, TSetValue = TValue> = ParamTypeLocation<TValue, unknown, TSetValue> | ParamTypeConfigLocation<TValue> | SettingsLocation<TValue> | DataSourceLocation | DataTypeLocation | DataTypeInstanceLocation | DataResourceLocation;
 interface MeshContextData {
     locationKey: string;
     locationType: MeshLocationTypes;
@@ -67,8 +57,8 @@ interface DialogResponseData {
     dialogId: string;
     error?: string;
 }
-declare type DialogType = 'location' | 'confirm';
-declare type OpenDialogResult = {
+type DialogType = 'location' | 'confirm';
+type OpenDialogResult = {
     /** Unique ID of this dialog which can be used to close it */
     dialogId: string;
     /**
@@ -110,20 +100,51 @@ interface DialogOptions<TDialogParams = DialogParams> {
      */
     contentHeight?: CSSHeight;
 }
-declare type DialogParamValue = string | number | boolean | null | DialogParamValue[] | {
+type DialogParamValue = string | number | boolean | null | DialogParamValue[] | {
     [key: string]: DialogParamValue;
 };
-declare type DialogParams = {
+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'}`;
-declare type ValidationResult = {
+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'}`;
+type ValidationResult = {
     isValid: false;
     validationMessage: string;
 } | {
     isValid: true;
 };
+type OpenDialogMessage = {
+    dialogType: DialogType;
+    dialogData: unknown;
+    options?: DialogOptions;
+};
+type CloseDialogMessage = {
+    dialogId: string | undefined;
+    dialogType: DialogType;
+    dialogData?: unknown;
+};
+type GetDataResourceMessage = Pick<DataType, 'path' | 'headers' | 'parameters' | 'body' | 'method'>;
 
+/**
+ * Imports the iframe communications library and provides an interface for interacting with
+ * the parent window via said communications library.
+ */
+declare function connectToParent({ dialogResponseHandlers, }: {
+    dialogResponseHandlers: DialogResponseHandlers;
+}): Promise<{
+    initData: MeshContextData;
+    parent: {
+        resize: (height: CSSHeight) => Promise<void>;
+        getValue: () => Promise<unknown>;
+        setValue: (value: unknown, options?: SetValueOptions) => Promise<void>;
+        getMetadata: () => Promise<unknown>;
+        openDialog: (message: OpenDialogMessage) => Promise<Pick<DialogResponseData, "value" | "dialogId"> | undefined>;
+        closeDialog: (message: CloseDialogMessage) => Promise<void>;
+        getDataResource: <TExpectedResult>(message: GetDataResourceMessage) => Promise<TExpectedResult>;
+    };
+}>;
+
+type SetLocationFunction<TSetValue> = (value: TSetValue, options?: SetValueOptions) => Promise<void> | void;
 /** Core shared generic for a mesh location context */
 interface MeshLocationCore<TValue = unknown, TMetadata = unknown, TSetValue = TValue, TType extends MeshLocationTypes = MeshLocationTypes> {
     /** The current location type (where in the Uniform app the mesh app is rendering) */
@@ -139,7 +160,7 @@ interface MeshLocationCore<TValue = unknown, TMetadata = unknown, TSetValue = TV
      * All locations other than 'settings' update into a parent form state and should be updated live as changes occur in the Mesh app.
      * The 'settings' location writes to the database each time its value is set, and it should be treated as a form with a submit button.
      */
-    setValue: (value: TSetValue, options?: SetValueOptions) => Promise<void>;
+    setValue: SetLocationFunction<TSetValue>;
     /** @deprecated use metadata property instead */
     getMetadata: () => TMetadata;
     /**
@@ -172,21 +193,69 @@ interface MeshLocationCore<TValue = unknown, TMetadata = unknown, TSetValue = TV
 /**
  * Known location types that can be passed to a mesh location
  */
-declare type MeshLocationTypes = 'paramType' | 'paramTypeConfig' | 'settings' | 'dataSource' | 'dataType' | 'dataTypeInstance';
-declare type SetValueOptions = ValidationResult;
+type MeshLocationTypes = 'paramType' | 'paramTypeConfig' | 'settings' | 'dataSource' | 'dataType'
+/** @deprecated use dataResource */
+ | 'dataTypeInstance' | 'dataResource';
+type SetValueOptions = ValidationResult;
+type SetValueMessage = {
+    uniformMeshLocationValue: unknown;
+    options?: SetValueOptions;
+};
+type GetDataResourceLocation = {
+    getDataResource: Awaited<ReturnType<typeof connectToParent>>['parent']['getDataResource'];
+};
 
-declare type DataSourceLocationValue = Pick<DataSource, 'baseUrl' | 'custom' | 'headers' | 'parameters' | 'variables'>;
-declare type DataSourceLocationMetadata<TIntegrationConfiguration = unknown> = {
+type DataTypeLocationValue = Pick<DataType$1, 'body' | 'method' | 'path' | 'custom' | 'headers' | 'parameters' | 'variables'>;
+type DataConnectorInfo = {
+    type: string;
+    displayName: string;
+    installedIntegrationId: string;
+};
+type DataTypeLocationMetadata<TIntegrationConfiguration = unknown> = {
+    /** Settings defined at the integration level (arbitrary type used on settings location) */
     settings: TIntegrationConfiguration;
+    /** The Uniform project ID */
+    projectId: string;
+    /**
+     * The current data type's data source. NOTE: param and header values are not available in this context.
+     */
+    dataSource: DataSource;
+    /** The data connector type of the current data type's data source */
+    dataConnector: DataConnectorInfo;
+    /** The data type's archetype value. */
+    archetype: string;
+};
+type DataTypeLocation = MeshLocationCore<DataTypeLocationValue, DataTypeLocationMetadata, DataTypeLocationValue, 'dataType'> & GetDataResourceLocation;
+
+/** @deprecated use DataResourceLocationMetadata */
+type DataTypeInstanceLocationMetadata<TIntegrationConfiguration = unknown> = DataResourceLocationMetadata<TIntegrationConfiguration>;
+type DataResourceLocationMetadata<TIntegrationConfiguration = unknown> = {
+    /** Settings defined at the integration level (arbitrary type used on settings location) */
+    settings: TIntegrationConfiguration;
+    /** The current data resource's data type */
+    dataType: DataType$1;
+    /** The data type's archetype value. */
+    archetype: string;
+    /**
+     * The current data resource's data source. NOTE: param and header values are not available in this context.
+     */
+    dataSource: DataSource;
+    /** The data connector type of the current data resource's data source */
+    dataConnector: DataConnectorInfo;
+    /** The Uniform project ID */
     projectId: string;
 };
-declare type DataSourceLocation = MeshLocationCore<DataSourceLocationValue, DataSourceLocationMetadata, DataSourceLocationValue, 'dataSource'>;
+type DataResourceLocation = MeshLocationCore<DataResourceVariables, DataResourceLocationMetadata, DataResourceVariables, 'dataResource'> & GetDataResourceLocation;
+/** @deprecated use DataResourceLocation */
+type DataTypeInstanceLocation = MeshLocationCore<DataResourceVariables, DataResourceLocationMetadata, DataResourceVariables, 'dataTypeInstance'>;
 
-declare type ParamTypeConfigLocationMetadata<TIntegrationConfiguration = unknown> = {
+type ParamTypeConfigLocationMetadata<TIntegrationConfiguration = unknown> = {
+    /** Settings defined at the integration level (arbitrary type used on settings location) */
     settings: TIntegrationConfiguration;
+    /** The Uniform project ID */
     projectId: string;
 };
-declare type ParamTypeConfigLocation<TParamValue = unknown, TIntegrationConfiguration = unknown> = MeshLocationCore<TParamValue | undefined, ParamTypeConfigLocationMetadata<TIntegrationConfiguration>, TParamValue, 'paramTypeConfig'>;
+type ParamTypeConfigLocation<TParamValue = unknown, TIntegrationConfiguration = unknown> = MeshLocationCore<TParamValue | undefined, ParamTypeConfigLocationMetadata<TIntegrationConfiguration>, TParamValue, 'paramTypeConfig'>;
 
 interface SdkWindow {
     /** The current window object. */
@@ -205,7 +274,7 @@ interface SdkWindow {
     updateHeight: (height: CSSHeight) => void;
 }
 
-declare type OpenLocationDialogOptions<TDialogParams> = {
+type OpenLocationDialogOptions<TDialogParams> = {
     /**
      * Name of the location key in the Mesh App definition (stored on uniform.app) to open in a dialog.
      * For example if the current location is integration settings, this would be an object key on:
@@ -216,16 +285,16 @@ declare type OpenLocationDialogOptions<TDialogParams> = {
     locationKey: string;
     options?: DialogOptions<TDialogParams>;
 };
-declare type OpenConfirmationDialogOptions = {
+type OpenConfirmationDialogOptions = {
     titleText: string;
     bodyText: string;
     options?: Omit<DialogOptions<void>, 'disableCloseDialogOnSetValue' | 'params'>;
 };
-declare type OpenConfirmationDialogResult = {
+type OpenConfirmationDialogResult = {
     value: 'confirm' | 'cancel';
     closeDialog: () => Promise<void>;
 };
-declare type CloseLocationDialogOptions = {
+type CloseLocationDialogOptions = {
     /** Id of the dialog to close. If no dialog with the given id exists, nothing will happen. */
     dialogId: string;
 };
@@ -239,7 +308,7 @@ interface LocationDialogResponse<TDialogValue> {
     closeDialog: () => Promise<void>;
 }
 /** Events that can be emitted from the Mesh SDK */
-declare type UniformMeshSDKEvents = {
+type UniformMeshSDKEvents = {
     /** Fired when the location value has changed */
     onValueChanged: {
         newValue: unknown;
@@ -283,4 +352,4 @@ declare function initializeUniformMeshSDK({ autoResizingDisabled, }?: {
     autoResizingDisabled?: boolean;
 }): Promise<UniformMeshSDK | undefined>;
 
-export { CSSHeight, CloseLocationDialogOptions, DataConnectorInfo, DataSourceLocation, DataSourceLocationMetadata, DataSourceLocationValue, DataTypeInstanceLocation, DataTypeInstanceLocationMetadata, DataTypeLocation, DataTypeLocationMetadata, DataTypeLocationValue, 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, CloseDialogMessage, CloseLocationDialogOptions, DataConnectorInfo, DataResourceLocation, DataResourceLocationMetadata, DataSourceLocation, DataSourceLocationMetadata, DataSourceLocationValue, DataTypeInstanceLocation, DataTypeInstanceLocationMetadata, DataTypeLocation, DataTypeLocationMetadata, DataTypeLocationValue, DialogContext, DialogOptions, DialogParamValue, DialogParams, DialogResponseData, DialogResponseHandler, DialogResponseHandlers, DialogType, GetDataResourceLocation, GetDataResourceMessage, LocationDialogResponse, MeshContextData, MeshLocation, MeshLocationCore, MeshLocationTypes, OpenConfirmationDialogOptions, OpenConfirmationDialogResult, OpenDialogMessage, OpenDialogResult, OpenLocationDialogOptions, ParamTypeConfigLocation, ParamTypeConfigLocationMetadata, ParamTypeLocation, ParamTypeLocationMetadata, SdkWindow, SetLocationFunction, SetValueMessage, SetValueOptions, SettingsLocation, UniformMeshSDK, UniformMeshSDKEvents, ValidationResult, initializeUniformMeshSDK };