@uniformdev/mesh-sdk 18.35.1-alpha.26 → 18.38.1-alpha.10

package/dist/index.d.ts

@@ -654,7 +654,7 @@ type SettingsLocation<TSettingsType> = MeshLocationCore<TSettingsType, undefined
  * Defines methods used for interacting with a Mesh location
  * To receive useful typings, check the `type` property of the location to narrow the typing.
  */
-type MeshLocation<TValue = unknown, TSetValue = TValue> = ParamTypeLocation<TValue, unknown, TSetValue> | ParamTypeConfigLocation<TValue> | SettingsLocation<TValue> | DataSourceLocation | DataTypeLocation | 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;
@@ -779,6 +779,8 @@ interface MeshLocationCore<TValue = unknown, TMetadata = unknown, TSetValue = TV
     type: TType;
     /** If true, any editable fields on the current location should be disabled as the user does not have permission or otherwise cannot change them. */
     isReadOnly: boolean;
+    /** @deprecated use value property instead */
+    getValue: () => TValue;
     /** The current value of the location. Some locations have fixed types (i.e. dataType), and others have user-selected types (i.e. paramType) */
     value: TValue;
     /**
@@ -787,11 +789,18 @@ interface MeshLocationCore<TValue = unknown, TMetadata = unknown, TSetValue = TV
      * 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: SetLocationFunction<TSetValue>;
+    /** @deprecated use metadata property instead */
+    getMetadata: () => TMetadata;
     /**
      * Gets the current location metadata, context data which is provided from the Uniform app to assist in rendering the Mesh UI
      * Each location has a specific type of metadata that it is provided, which is typed automatically when the location is known.
      */
     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>;
     /**
      * Context of a location when it is rendering inside a dialog in the Uniform app.
      * This is set when:
@@ -812,7 +821,9 @@ interface MeshLocationCore<TValue = unknown, TMetadata = unknown, TSetValue = TV
 /**
  * Known location types that can be passed to a mesh location
  */
-type MeshLocationTypes = 'paramType' | 'paramTypeConfig' | 'settings' | 'dataSource' | 'dataType' | 'dataResource';
+type MeshLocationTypes = 'paramType' | 'paramTypeConfig' | 'settings' | 'dataSource' | 'dataType'
+/** @deprecated use dataResource */
+ | 'dataTypeInstance' | 'dataResource';
 type SetValueOptions = ValidationResult;
 type SetValueMessage = {
     uniformMeshLocationValue: unknown;
@@ -843,6 +854,8 @@ type DataTypeLocationMetadata<TIntegrationConfiguration = unknown> = {
 };
 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;
@@ -860,6 +873,8 @@ type DataResourceLocationMetadata<TIntegrationConfiguration = unknown> = {
     projectId: string;
 };
 type DataResourceLocation = MeshLocationCore<DataResourceVariables, DataResourceLocationMetadata, DataResourceVariables, 'dataResource'> & GetDataResourceLocation;
+/** @deprecated use DataResourceLocation */
+type DataTypeInstanceLocation = MeshLocationCore<DataResourceVariables, DataResourceLocationMetadata, DataResourceVariables, 'dataTypeInstance'>;
 
 type ParamTypeConfigLocationMetadata<TIntegrationConfiguration = unknown> = {
     /** Settings defined at the integration level (arbitrary type used on settings location) */
@@ -953,6 +968,8 @@ interface UniformMeshSDK {
     }>['setValue']>[0]> | undefined>;
     /** Explicitly close a location dialog. Called when rendering current location in the dialog. */
     closeCurrentLocationDialog(): Promise<void>;
+    /** @deprecated prefer getCurrentLocation().dialogContext */
+    dialogContext?: DialogContext;
 }
 declare global {
     interface Window {
@@ -967,4 +984,4 @@ declare function initializeUniformMeshSDK({ autoResizingDisabled, }?: {
     autoResizingDisabled?: boolean;
 }): Promise<UniformMeshSDK | undefined>;
 
-export { CSSHeight, CloseDialogMessage, CloseLocationDialogOptions, DataConnectorInfo, DataResourceLocation, DataResourceLocationMetadata, DataSourceLocation, DataSourceLocationMetadata, DataSourceLocationValue, DataTypeLocation, DataTypeLocationMetadata, DataTypeLocationValue, DialogContext, DialogOptions, DialogParamValue, DialogParams, DialogResponseData, DialogResponseHandler, DialogResponseHandlers, DialogType, GetDataResourceLocation, GetDataResourceMessage, IntegrationDefinitionClient, IntegrationDefinitionDeleteParameters, IntegrationDefinitionGetParameters, IntegrationDefinitionGetResponse, IntegrationDefinitionPutParameters, IntegrationDefinitionPutResponse, IntegrationInstallationClient, IntegrationInstallationDeleteParameters, IntegrationInstallationGetParameters, IntegrationInstallationGetResponse, IntegrationInstallationPutParameters, LocationDialogResponse, MeshContextData, MeshLocation, MeshLocationCore, MeshLocationTypes, MeshSDKEventInterface, OpenConfirmationDialogOptions, OpenConfirmationDialogResult, OpenDialogMessage, OpenDialogResult, OpenLocationDialogOptions, ParamTypeConfigLocation, ParamTypeConfigLocationMetadata, ParamTypeLocation, ParamTypeLocationMetadata, SdkWindow, SetLocationFunction, SetValueMessage, 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, IntegrationDefinitionClient, IntegrationDefinitionDeleteParameters, IntegrationDefinitionGetParameters, IntegrationDefinitionGetResponse, IntegrationDefinitionPutParameters, IntegrationDefinitionPutResponse, IntegrationInstallationClient, IntegrationInstallationDeleteParameters, IntegrationInstallationGetParameters, IntegrationInstallationGetResponse, IntegrationInstallationPutParameters, LocationDialogResponse, MeshContextData, MeshLocation, MeshLocationCore, MeshLocationTypes, MeshSDKEventInterface, OpenConfirmationDialogOptions, OpenConfirmationDialogResult, OpenDialogMessage, OpenDialogResult, OpenLocationDialogOptions, ParamTypeConfigLocation, ParamTypeConfigLocationMetadata, ParamTypeLocation, ParamTypeLocationMetadata, SdkWindow, SetLocationFunction, SetValueMessage, SetValueOptions, SettingsLocation, UniformMeshSDK, UniformMeshSDKEvents, ValidationResult, initializeUniformMeshSDK };

package/dist/index.esm.js

@@ -606,6 +606,9 @@ async function initializeUniformMeshSDK({
           getDataResource: parent.getDataResource,
           type: contextData.locationType,
           isReadOnly: contextData.isReadOnly,
+          getValue: () => {
+            return location.value;
+          },
           value: contextData.locationValue,
           setValue: async (value, options) => {
             if (contextData.dialogContext) {
@@ -617,7 +620,12 @@ async function initializeUniformMeshSDK({
             sdk.events.emit("onValueChanged", { newValue: value });
             await parent.setValue({ uniformMeshLocationValue: value, options });
           },
+          // DEPRECATED
+          getMetadata: () => currentMetadata,
           metadata: currentMetadata,
+          setValidationResult: async (value) => {
+            await location.setValue(contextData.locationValue, value);
+          },
           dialogContext: contextData.dialogContext ? {
             ...contextData.dialogContext,
             params: currentMetadata.dialogParams,
@@ -676,6 +684,8 @@ async function initializeUniformMeshSDK({
           return;
         }
         return {
+          /** @deprecated don't use this */
+          dialogId: result.dialogId,
           value: result.value,
           closeDialog: async () => {
             await parent.closeDialog({ dialogId: void 0, dialogType: "confirm" });
@@ -704,7 +714,8 @@ async function initializeUniformMeshSDK({
       },
       closeCurrentLocationDialog: async () => {
         await parent.closeDialog({ dialogId: void 0, dialogType: "location" });
-      }
+      },
+      dialogContext: contextData.dialogContext
     };
     window.UniformMeshSDK = sdk;
     initializing = false;

package/dist/index.js

@@ -643,6 +643,9 @@ async function initializeUniformMeshSDK({
           getDataResource: parent.getDataResource,
           type: contextData.locationType,
           isReadOnly: contextData.isReadOnly,
+          getValue: () => {
+            return location.value;
+          },
           value: contextData.locationValue,
           setValue: async (value, options) => {
             if (contextData.dialogContext) {
@@ -654,7 +657,12 @@ async function initializeUniformMeshSDK({
             sdk.events.emit("onValueChanged", { newValue: value });
             await parent.setValue({ uniformMeshLocationValue: value, options });
           },
+          // DEPRECATED
+          getMetadata: () => currentMetadata,
           metadata: currentMetadata,
+          setValidationResult: async (value) => {
+            await location.setValue(contextData.locationValue, value);
+          },
           dialogContext: contextData.dialogContext ? {
             ...contextData.dialogContext,
             params: currentMetadata.dialogParams,
@@ -713,6 +721,8 @@ async function initializeUniformMeshSDK({
           return;
         }
         return {
+          /** @deprecated don't use this */
+          dialogId: result.dialogId,
           value: result.value,
           closeDialog: async () => {
             await parent.closeDialog({ dialogId: void 0, dialogType: "confirm" });
@@ -741,7 +751,8 @@ async function initializeUniformMeshSDK({
       },
       closeCurrentLocationDialog: async () => {
         await parent.closeDialog({ dialogId: void 0, dialogType: "location" });
-      }
+      },
+      dialogContext: contextData.dialogContext
     };
     window.UniformMeshSDK = sdk;
     initializing = false;

package/dist/index.mjs

@@ -606,6 +606,9 @@ async function initializeUniformMeshSDK({
           getDataResource: parent.getDataResource,
           type: contextData.locationType,
           isReadOnly: contextData.isReadOnly,
+          getValue: () => {
+            return location.value;
+          },
           value: contextData.locationValue,
           setValue: async (value, options) => {
             if (contextData.dialogContext) {
@@ -617,7 +620,12 @@ async function initializeUniformMeshSDK({
             sdk.events.emit("onValueChanged", { newValue: value });
             await parent.setValue({ uniformMeshLocationValue: value, options });
           },
+          // DEPRECATED
+          getMetadata: () => currentMetadata,
           metadata: currentMetadata,
+          setValidationResult: async (value) => {
+            await location.setValue(contextData.locationValue, value);
+          },
           dialogContext: contextData.dialogContext ? {
             ...contextData.dialogContext,
             params: currentMetadata.dialogParams,
@@ -676,6 +684,8 @@ async function initializeUniformMeshSDK({
           return;
         }
         return {
+          /** @deprecated don't use this */
+          dialogId: result.dialogId,
           value: result.value,
           closeDialog: async () => {
             await parent.closeDialog({ dialogId: void 0, dialogType: "confirm" });
@@ -704,7 +714,8 @@ async function initializeUniformMeshSDK({
       },
       closeCurrentLocationDialog: async () => {
         await parent.closeDialog({ dialogId: void 0, dialogType: "location" });
-      }
+      },
+      dialogContext: contextData.dialogContext
     };
     window.UniformMeshSDK = sdk;
     initializing = false;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/mesh-sdk",
-  "version": "18.35.1-alpha.26+277d77ae3",
+  "version": "18.38.1-alpha.10+13f006c1d",
   "description": "Uniform Mesh Framework SDK",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -32,9 +32,9 @@
     "access": "public"
   },
   "dependencies": {
-    "@uniformdev/canvas": "18.35.1-alpha.26+277d77ae3",
-    "@uniformdev/context": "18.35.1-alpha.26+277d77ae3",
+    "@uniformdev/canvas": "18.38.1-alpha.10+13f006c1d",
+    "@uniformdev/context": "18.38.1-alpha.10+13f006c1d",
     "mitt": "^3.0.0"
   },
-  "gitHead": "277d77ae3e30655fb8319c7f221757981e8e00af"
+  "gitHead": "13f006c1d5ebbe593d33f3446a8de84b4a2d42d1"
 }