@uniformdev/mesh-sdk 19.35.2 → 19.35.3-alpha.82

package/dist/index.d.ts

@@ -1,7 +1,6 @@
 import { ApiClient, ClientOptions, ExceptProject } from '@uniformdev/context/api';
-import { DataSource, RootComponentInstance, ComponentInstance, ComponentDefinition, ComponentDefinitionParameter, DataType as DataType$1, DataResourceVariables } from '@uniformdev/canvas';
+import { DataSource, RootComponentInstance, ComponentInstance, ComponentDefinition, ComponentDefinitionParameter, DataType, DataVariableDefinition, DataResourceVariables } from '@uniformdev/canvas';
 import { ProjectMapNode } from '@uniformdev/project-map';
-import { DataType } from '@uniformdev/canvas/.';
 import { Emitter } from 'mitt';
 
 /**
@@ -646,10 +645,28 @@ type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfig
     settings: TIntegrationConfiguration;
     /** The Uniform project ID */
     projectId: string;
-    /** Current dynamic inputs that are configured on the composition (if any). */
+    /**
+     * Current dynamic inputs that are configured on the composition (if any).
+     * Use the <ParamTypeDynamicDataProvider> to wire up dynamic data in your parameter.
+     */
     dynamicInputs: DynamicInputs;
+    /**
+     * The connected data for the current component. Connected data is provided as a map
+     * of the binding expression text to the value of that binding expression. For example,
+     * if the value is "Hello ${#jptr:/MyData/fields/name}" then this value would be:
+     * { "#jptr:/MyData/fields/name": "value-of-connected-data" }
+     *
+     * Use the <ParamTypeDynamicDataProvider> to wire up dynamic data in your parameter.
+     */
+    connectedData: Record<string, unknown>;
+};
+type ParamTypeLocation<TParamValue = unknown, TParamConfiguration = unknown, TParamSetValue = TParamValue, TIntegrationConfiguration = unknown> = MeshLocationCore<TParamValue | undefined, ParamTypeLocationMetadata<TParamConfiguration, TIntegrationConfiguration>, TParamSetValue, 'paramType'> & {
+    /**
+     * Opens a dialog on the Uniform platform to edit or select a data element to connect to.
+     * Returns the result of the dialog. Useful to build data-enabled parameter types.
+     */
+    editConnectedData: Awaited<ReturnType<typeof connectToParent>>['parent']['editConnectedData'];
 };
-type ParamTypeLocation<TParamValue = unknown, TParamConfiguration = unknown, TParamSetValue = TParamValue, TIntegrationConfiguration = unknown> = MeshLocationCore<TParamValue | undefined, ParamTypeLocationMetadata<TParamConfiguration, TIntegrationConfiguration>, TParamSetValue, 'paramType'>;
 
 type SettingsLocationMetadata = {
     projectId: string;
@@ -687,7 +704,7 @@ interface DialogResponseData {
     dialogId: string;
     error?: string;
 }
-type DialogType = 'location' | 'confirm';
+type DialogType = 'location' | 'confirm' | 'currentLocation';
 type OpenDialogResult = {
     /** Unique ID of this dialog which can be used to close it */
     dialogId: string;
@@ -754,6 +771,25 @@ type CloseDialogMessage = {
     dialogData?: unknown;
 };
 type GetDataResourceMessage = Pick<DataType, 'path' | 'headers' | 'parameters' | 'body' | 'method'>;
+/** 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 */
+type EditConnectedDataMessage = {
+    /** Bind expression for existing connected data */
+    existingConnectedData?: string;
+    allowedTypes: BindableTypes[];
+};
+/** Response from parent when creating a data connection expression */
+type EditConnectedDataResponse = {
+    canceled: false;
+    /** Bind expression for selected data connection */
+    connectedData: DataVariableDefinition & {
+        name: string;
+    };
+} | {
+    /** User cancelled selecting data element */
+    canceled: true;
+};
 
 type MeshSDKEventInterface = Awaited<ReturnType<typeof connectToParent>>['parent'] & {
     initialize: () => Promise<MeshContextData>;
@@ -775,6 +811,7 @@ declare function connectToParent({ dialogResponseHandlers, onMetadataUpdated, }:
         openDialog: (message: OpenDialogMessage) => Promise<Pick<DialogResponseData, "value" | "dialogId"> | undefined>;
         closeDialog: (message: CloseDialogMessage) => Promise<void>;
         getDataResource: <TExpectedResult>(message: GetDataResourceMessage) => Promise<TExpectedResult>;
+        editConnectedData: (message: EditConnectedDataMessage) => Promise<EditConnectedDataResponse>;
     };
 }>;
 
@@ -823,6 +860,7 @@ type SetValueOptions = ValidationResult;
 type SetValueMessage = {
     uniformMeshLocationValue: unknown;
     options?: SetValueOptions;
+    closeDialog?: boolean;
 };
 type GetDataResourceLocation = {
     getDataResource: Awaited<ReturnType<typeof connectToParent>>['parent']['getDataResource'];
@@ -843,7 +881,7 @@ type DynamicInput = {
 /** Record of dynamic inputs keyed by the input name */
 type DynamicInputs = Record<string, DynamicInput>;
 
-type DataTypeLocationValue = Pick<DataType$1, 'body' | 'method' | 'path' | 'custom' | 'headers' | 'parameters' | 'variables'>;
+type DataTypeLocationValue = Pick<DataType, 'body' | 'method' | 'path' | 'custom' | 'headers' | 'parameters' | 'variables'>;
 type DataConnectorInfo = {
     type: string;
     displayName: string;
@@ -868,7 +906,7 @@ 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;
+    dataType: DataType;
     /** The data type's archetype value. */
     archetype: string;
     /**
@@ -990,4 +1028,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, DynamicInput, DynamicInputs, 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, SettingsLocationMetadata, UniformMeshSDK, UniformMeshSDKEvents, ValidationResult, initializeUniformMeshSDK };
+export { BindableTypes, CSSHeight, CloseDialogMessage, CloseLocationDialogOptions, DataConnectorInfo, DataResourceLocation, DataResourceLocationMetadata, DataSourceLocation, DataSourceLocationMetadata, DataSourceLocationValue, DataTypeLocation, DataTypeLocationMetadata, DataTypeLocationValue, DialogContext, DialogOptions, DialogParamValue, DialogParams, DialogResponseData, DialogResponseHandler, DialogResponseHandlers, DialogType, DynamicInput, DynamicInputs, EditConnectedDataMessage, EditConnectedDataResponse, 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, SettingsLocationMetadata, UniformMeshSDK, UniformMeshSDKEvents, ValidationResult, initializeUniformMeshSDK };

package/dist/index.esm.js

@@ -124,8 +124,8 @@ var DEFAULT_REQUEST_TIMEOUT = 5e3;
 
 // src/framepost/errors.ts
 var RequestTimeoutError = class _RequestTimeoutError extends Error {
-  constructor() {
-    super("Request timed out");
+  constructor(message) {
+    super("Request timed out: " + message);
     Object.setPrototypeOf(this, _RequestTimeoutError.prototype);
     this.name = "RequestTimeoutError";
   }
@@ -171,7 +171,7 @@ var serializeError = (error) => {
 var deserializeError = ({ name, message, stack }) => {
   switch (name) {
     case RequestTimeoutError.name: {
-      return new RequestTimeoutError();
+      return new RequestTimeoutError(message);
     }
     default: {
       const e = new Error(message);
@@ -277,7 +277,7 @@ var SharedClient = class {
       timer = setTimeout(() => {
         unsubscribeResponseHandler();
         clearOnDestroy();
-        reject(new RequestTimeoutError());
+        reject(new RequestTimeoutError(requestKey));
       }, options.timeout || this.requestTimeout);
     });
   }
@@ -503,6 +503,18 @@ async function connectToParent({
         return await client.request("getDataResource", message, {
           timeout: 3e4
         });
+      },
+      editConnectedData: async (message) => {
+        return await client.request(
+          "editConnectedData",
+          message,
+          {
+            timeout: (
+              // 24 hours in ms
+              864e5
+            )
+          }
+        );
       }
     }
   };
@@ -536,9 +548,12 @@ var createSdkWindow = ({
       onHeightChange == null ? void 0 : onHeightChange(height);
       return;
     }
-    const windowHeight = `${Math.ceil(
-      windowInstance.document.documentElement.getBoundingClientRect().height
-    )}px`;
+    let maxBottom = windowInstance.document.documentElement.getBoundingClientRect().height;
+    windowInstance.document.querySelectorAll("div, section, article, menu, nav, footer").forEach((div) => {
+      const bottom = div.getBoundingClientRect().bottom;
+      maxBottom = Math.max(maxBottom, bottom);
+    });
+    const windowHeight = `${Math.ceil(maxBottom)}px`;
     if (windowHeight !== oldHeight) {
       oldHeight = windowHeight;
       onHeightChange == null ? void 0 : onHeightChange(windowHeight);
@@ -604,15 +619,11 @@ async function initializeUniformMeshSDK({
       getCurrentLocation: () => {
         const location = {
           getDataResource: parent.getDataResource,
+          editConnectedData: parent.editConnectedData,
           type: contextData.locationType,
           isReadOnly: contextData.isReadOnly,
           value: contextData.locationValue,
           setValue: async (value, options) => {
-            if (contextData.dialogContext) {
-              console.warn(
-                "Using setValue() inside a dialog is deprecated. Use dialogContext.returnDialogValue() instead."
-              );
-            }
             contextData.locationValue = value;
             sdk.events.emit("onValueChanged", { newValue: value });
             await parent.setValue({ uniformMeshLocationValue: value, options });
@@ -624,7 +635,7 @@ async function initializeUniformMeshSDK({
             returnDialogValue: async (value) => {
               contextData.locationValue = value;
               sdk.events.emit("onValueChanged", { newValue: value });
-              await parent.setValue({ uniformMeshLocationValue: value });
+              await parent.setValue({ uniformMeshLocationValue: value, closeDialog: true });
             }
           } : void 0
         };
@@ -684,26 +695,28 @@ async function initializeUniformMeshSDK({
       },
       openCurrentLocationDialog: async (options) => {
         const result = await parent.openDialog({
-          dialogType: "location",
+          dialogType: "currentLocation",
           dialogData: {},
           options: options == null ? void 0 : options.options
         });
         if (!result) {
           return;
         }
+        contextData.locationValue = result.value;
+        sdk.events.emit("onValueChanged", { newValue: result.value });
         return {
           dialogId: result.dialogId,
           value: result.value,
           closeDialog: async () => {
             await parent.closeDialog({
               dialogId: void 0,
-              dialogType: "location"
+              dialogType: "currentLocation"
             });
           }
         };
       },
       closeCurrentLocationDialog: async () => {
-        await parent.closeDialog({ dialogId: void 0, dialogType: "location" });
+        await parent.closeDialog({ dialogId: void 0, dialogType: "currentLocation" });
       }
     };
     window.UniformMeshSDK = sdk;

package/dist/index.js

@@ -161,8 +161,8 @@ var DEFAULT_REQUEST_TIMEOUT = 5e3;
 
 // src/framepost/errors.ts
 var RequestTimeoutError = class _RequestTimeoutError extends Error {
-  constructor() {
-    super("Request timed out");
+  constructor(message) {
+    super("Request timed out: " + message);
     Object.setPrototypeOf(this, _RequestTimeoutError.prototype);
     this.name = "RequestTimeoutError";
   }
@@ -208,7 +208,7 @@ var serializeError = (error) => {
 var deserializeError = ({ name, message, stack }) => {
   switch (name) {
     case RequestTimeoutError.name: {
-      return new RequestTimeoutError();
+      return new RequestTimeoutError(message);
     }
     default: {
       const e = new Error(message);
@@ -314,7 +314,7 @@ var SharedClient = class {
       timer = setTimeout(() => {
         unsubscribeResponseHandler();
         clearOnDestroy();
-        reject(new RequestTimeoutError());
+        reject(new RequestTimeoutError(requestKey));
       }, options.timeout || this.requestTimeout);
     });
   }
@@ -540,6 +540,18 @@ async function connectToParent({
         return await client.request("getDataResource", message, {
           timeout: 3e4
         });
+      },
+      editConnectedData: async (message) => {
+        return await client.request(
+          "editConnectedData",
+          message,
+          {
+            timeout: (
+              // 24 hours in ms
+              864e5
+            )
+          }
+        );
       }
     }
   };
@@ -573,9 +585,12 @@ var createSdkWindow = ({
       onHeightChange == null ? void 0 : onHeightChange(height);
       return;
     }
-    const windowHeight = `${Math.ceil(
-      windowInstance.document.documentElement.getBoundingClientRect().height
-    )}px`;
+    let maxBottom = windowInstance.document.documentElement.getBoundingClientRect().height;
+    windowInstance.document.querySelectorAll("div, section, article, menu, nav, footer").forEach((div) => {
+      const bottom = div.getBoundingClientRect().bottom;
+      maxBottom = Math.max(maxBottom, bottom);
+    });
+    const windowHeight = `${Math.ceil(maxBottom)}px`;
     if (windowHeight !== oldHeight) {
       oldHeight = windowHeight;
       onHeightChange == null ? void 0 : onHeightChange(windowHeight);
@@ -641,15 +656,11 @@ async function initializeUniformMeshSDK({
       getCurrentLocation: () => {
         const location = {
           getDataResource: parent.getDataResource,
+          editConnectedData: parent.editConnectedData,
           type: contextData.locationType,
           isReadOnly: contextData.isReadOnly,
           value: contextData.locationValue,
           setValue: async (value, options) => {
-            if (contextData.dialogContext) {
-              console.warn(
-                "Using setValue() inside a dialog is deprecated. Use dialogContext.returnDialogValue() instead."
-              );
-            }
             contextData.locationValue = value;
             sdk.events.emit("onValueChanged", { newValue: value });
             await parent.setValue({ uniformMeshLocationValue: value, options });
@@ -661,7 +672,7 @@ async function initializeUniformMeshSDK({
             returnDialogValue: async (value) => {
               contextData.locationValue = value;
               sdk.events.emit("onValueChanged", { newValue: value });
-              await parent.setValue({ uniformMeshLocationValue: value });
+              await parent.setValue({ uniformMeshLocationValue: value, closeDialog: true });
             }
           } : void 0
         };
@@ -721,26 +732,28 @@ async function initializeUniformMeshSDK({
       },
       openCurrentLocationDialog: async (options) => {
         const result = await parent.openDialog({
-          dialogType: "location",
+          dialogType: "currentLocation",
           dialogData: {},
           options: options == null ? void 0 : options.options
         });
         if (!result) {
           return;
         }
+        contextData.locationValue = result.value;
+        sdk.events.emit("onValueChanged", { newValue: result.value });
         return {
           dialogId: result.dialogId,
           value: result.value,
           closeDialog: async () => {
             await parent.closeDialog({
               dialogId: void 0,
-              dialogType: "location"
+              dialogType: "currentLocation"
             });
           }
         };
       },
       closeCurrentLocationDialog: async () => {
-        await parent.closeDialog({ dialogId: void 0, dialogType: "location" });
+        await parent.closeDialog({ dialogId: void 0, dialogType: "currentLocation" });
       }
     };
     window.UniformMeshSDK = sdk;

package/dist/index.mjs

@@ -124,8 +124,8 @@ var DEFAULT_REQUEST_TIMEOUT = 5e3;
 
 // src/framepost/errors.ts
 var RequestTimeoutError = class _RequestTimeoutError extends Error {
-  constructor() {
-    super("Request timed out");
+  constructor(message) {
+    super("Request timed out: " + message);
     Object.setPrototypeOf(this, _RequestTimeoutError.prototype);
     this.name = "RequestTimeoutError";
   }
@@ -171,7 +171,7 @@ var serializeError = (error) => {
 var deserializeError = ({ name, message, stack }) => {
   switch (name) {
     case RequestTimeoutError.name: {
-      return new RequestTimeoutError();
+      return new RequestTimeoutError(message);
     }
     default: {
       const e = new Error(message);
@@ -277,7 +277,7 @@ var SharedClient = class {
       timer = setTimeout(() => {
         unsubscribeResponseHandler();
         clearOnDestroy();
-        reject(new RequestTimeoutError());
+        reject(new RequestTimeoutError(requestKey));
       }, options.timeout || this.requestTimeout);
     });
   }
@@ -503,6 +503,18 @@ async function connectToParent({
         return await client.request("getDataResource", message, {
           timeout: 3e4
         });
+      },
+      editConnectedData: async (message) => {
+        return await client.request(
+          "editConnectedData",
+          message,
+          {
+            timeout: (
+              // 24 hours in ms
+              864e5
+            )
+          }
+        );
       }
     }
   };
@@ -536,9 +548,12 @@ var createSdkWindow = ({
       onHeightChange == null ? void 0 : onHeightChange(height);
       return;
     }
-    const windowHeight = `${Math.ceil(
-      windowInstance.document.documentElement.getBoundingClientRect().height
-    )}px`;
+    let maxBottom = windowInstance.document.documentElement.getBoundingClientRect().height;
+    windowInstance.document.querySelectorAll("div, section, article, menu, nav, footer").forEach((div) => {
+      const bottom = div.getBoundingClientRect().bottom;
+      maxBottom = Math.max(maxBottom, bottom);
+    });
+    const windowHeight = `${Math.ceil(maxBottom)}px`;
     if (windowHeight !== oldHeight) {
       oldHeight = windowHeight;
       onHeightChange == null ? void 0 : onHeightChange(windowHeight);
@@ -604,15 +619,11 @@ async function initializeUniformMeshSDK({
       getCurrentLocation: () => {
         const location = {
           getDataResource: parent.getDataResource,
+          editConnectedData: parent.editConnectedData,
           type: contextData.locationType,
           isReadOnly: contextData.isReadOnly,
           value: contextData.locationValue,
           setValue: async (value, options) => {
-            if (contextData.dialogContext) {
-              console.warn(
-                "Using setValue() inside a dialog is deprecated. Use dialogContext.returnDialogValue() instead."
-              );
-            }
             contextData.locationValue = value;
             sdk.events.emit("onValueChanged", { newValue: value });
             await parent.setValue({ uniformMeshLocationValue: value, options });
@@ -624,7 +635,7 @@ async function initializeUniformMeshSDK({
             returnDialogValue: async (value) => {
               contextData.locationValue = value;
               sdk.events.emit("onValueChanged", { newValue: value });
-              await parent.setValue({ uniformMeshLocationValue: value });
+              await parent.setValue({ uniformMeshLocationValue: value, closeDialog: true });
             }
           } : void 0
         };
@@ -684,26 +695,28 @@ async function initializeUniformMeshSDK({
       },
       openCurrentLocationDialog: async (options) => {
         const result = await parent.openDialog({
-          dialogType: "location",
+          dialogType: "currentLocation",
           dialogData: {},
           options: options == null ? void 0 : options.options
         });
         if (!result) {
           return;
         }
+        contextData.locationValue = result.value;
+        sdk.events.emit("onValueChanged", { newValue: result.value });
         return {
           dialogId: result.dialogId,
           value: result.value,
           closeDialog: async () => {
             await parent.closeDialog({
               dialogId: void 0,
-              dialogType: "location"
+              dialogType: "currentLocation"
             });
           }
         };
       },
       closeCurrentLocationDialog: async () => {
-        await parent.closeDialog({ dialogId: void 0, dialogType: "location" });
+        await parent.closeDialog({ dialogId: void 0, dialogType: "currentLocation" });
       }
     };
     window.UniformMeshSDK = sdk;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/mesh-sdk",
-  "version": "19.35.2",
+  "version": "19.35.3-alpha.82+4bc341093",
   "description": "Uniform Mesh Framework SDK",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -32,10 +32,10 @@
     "access": "public"
   },
   "dependencies": {
-    "@uniformdev/canvas": "19.35.2",
-    "@uniformdev/context": "19.35.2",
-    "@uniformdev/project-map": "19.35.2",
+    "@uniformdev/canvas": "19.35.3-alpha.82+4bc341093",
+    "@uniformdev/context": "19.35.3-alpha.82+4bc341093",
+    "@uniformdev/project-map": "19.35.3-alpha.82+4bc341093",
     "mitt": "^3.0.0"
   },
-  "gitHead": "64d3270175087c87cfaa29a283aa4a7b0a98fd2c"
+  "gitHead": "4bc341093bc946900df2646fe53eca4bcddc693c"
 }