@uniformdev/mesh-sdk 17.7.1-alpha.34 → 18.0.1-alpha.3

package/LICENSE.txt

@@ -1,2 +1,2 @@
-© 2022 Uniform Systems, Inc. All Rights Reserved.
+© 2023 Uniform Systems, Inc. All Rights Reserved.
 See details of Uniform Systems, Inc. Master Subscription Agreement here: https://uniform.dev/eula

package/dist/index.d.ts

@@ -2,16 +2,16 @@ import { DataSource, RootComponentInstance, ComponentInstance, ComponentDefiniti
 import { DataType } from '@uniformdev/canvas/.';
 import { Emitter } from 'mitt';
 
-declare type DataSourceLocationValue = Pick<DataSource, 'baseUrl' | 'custom' | 'headers' | 'parameters' | 'variables'>;
-declare type DataSourceLocationMetadata<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;
     /** The Uniform project ID */
     projectId: string;
 };
-declare type DataSourceLocation = MeshLocationCore<DataSourceLocationValue, DataSourceLocationMetadata, DataSourceLocationValue, 'dataSource'>;
+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'>;
@@ -22,15 +22,15 @@ declare type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrati
     /** 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 | DataResourceLocation;
+type MeshLocation<TValue = unknown, TSetValue = TValue> = ParamTypeLocation<TValue, unknown, TSetValue> | ParamTypeConfigLocation<TValue> | SettingsLocation<TValue> | DataSourceLocation | DataTypeLocation | DataTypeInstanceLocation | DataResourceLocation;
 interface MeshContextData {
     locationKey: string;
     locationType: MeshLocationTypes;
@@ -57,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;
     /**
@@ -100,30 +100,30 @@ 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;
 };
-declare type OpenDialogMessage = {
+type OpenDialogMessage = {
     dialogType: DialogType;
     dialogData: unknown;
     options?: DialogOptions;
 };
-declare type CloseDialogMessage = {
+type CloseDialogMessage = {
     dialogId: string | undefined;
     dialogType: DialogType;
     dialogData?: unknown;
 };
-declare type GetDataResourceMessage = Pick<DataType, 'path' | 'headers' | 'parameters' | 'body' | 'method'>;
+type GetDataResourceMessage = Pick<DataType, 'path' | 'headers' | 'parameters' | 'body' | 'method'>;
 
 /**
  * Imports the iframe communications library and provides an interface for interacting with
@@ -144,7 +144,7 @@ declare function connectToParent({ dialogResponseHandlers, }: {
     };
 }>;
 
-declare type SetLocationFunction<TSetValue> = (value: TSetValue, options?: SetValueOptions) => Promise<void> | void;
+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) */
@@ -193,25 +193,25 @@ 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'
+type MeshLocationTypes = 'paramType' | 'paramTypeConfig' | 'settings' | 'dataSource' | 'dataType'
 /** @deprecated use dataResource */
  | 'dataTypeInstance' | 'dataResource';
-declare type SetValueOptions = ValidationResult;
-declare type SetValueMessage = {
+type SetValueOptions = ValidationResult;
+type SetValueMessage = {
     uniformMeshLocationValue: unknown;
     options?: SetValueOptions;
 };
-declare type GetDataResourceLocation = {
+type GetDataResourceLocation = {
     getDataResource: Awaited<ReturnType<typeof connectToParent>>['parent']['getDataResource'];
 };
 
-declare type DataTypeLocationValue = Pick<DataType$1, 'body' | 'method' | 'path' | 'custom' | 'headers' | 'parameters' | 'variables'>;
-declare type DataConnectorInfo = {
+type DataTypeLocationValue = Pick<DataType$1, 'body' | 'method' | 'path' | 'custom' | 'headers' | 'parameters' | 'variables'>;
+type DataConnectorInfo = {
     type: string;
     displayName: string;
     installedIntegrationId: string;
 };
-declare type DataTypeLocationMetadata<TIntegrationConfiguration = unknown> = {
+type DataTypeLocationMetadata<TIntegrationConfiguration = unknown> = {
     /** Settings defined at the integration level (arbitrary type used on settings location) */
     settings: TIntegrationConfiguration;
     /** The Uniform project ID */
@@ -225,11 +225,11 @@ declare type DataTypeLocationMetadata<TIntegrationConfiguration = unknown> = {
     /** The data type's archetype value. */
     archetype: string;
 };
-declare type DataTypeLocation = MeshLocationCore<DataTypeLocationValue, DataTypeLocationMetadata, DataTypeLocationValue, 'dataType'> & GetDataResourceLocation;
+type DataTypeLocation = MeshLocationCore<DataTypeLocationValue, DataTypeLocationMetadata, DataTypeLocationValue, 'dataType'> & GetDataResourceLocation;
 
 /** @deprecated use DataResourceLocationMetadata */
-declare type DataTypeInstanceLocationMetadata<TIntegrationConfiguration = unknown> = DataResourceLocationMetadata<TIntegrationConfiguration>;
-declare type DataResourceLocationMetadata<TIntegrationConfiguration = unknown> = {
+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 */
@@ -245,17 +245,17 @@ declare type DataResourceLocationMetadata<TIntegrationConfiguration = unknown> =
     /** The Uniform project ID */
     projectId: string;
 };
-declare type DataResourceLocation = MeshLocationCore<DataResourceVariables, DataResourceLocationMetadata, DataResourceVariables, 'dataResource'> & GetDataResourceLocation;
+type DataResourceLocation = MeshLocationCore<DataResourceVariables, DataResourceLocationMetadata, DataResourceVariables, 'dataResource'> & GetDataResourceLocation;
 /** @deprecated use DataResourceLocation */
-declare type DataTypeInstanceLocation = MeshLocationCore<DataResourceVariables, DataResourceLocationMetadata, DataResourceVariables, 'dataTypeInstance'>;
+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. */
@@ -274,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:
@@ -285,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;
 };
@@ -308,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;