@uniformdev/mesh-sdk 18.26.0 → 18.27.1-alpha.12

package/dist/index.d.ts

@@ -638,7 +638,7 @@ type DataSourceLocation = MeshLocationCore<DataSourceLocationValue, DataSourceLo
 type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfiguration = unknown> = {
     rootNode: Omit<RootComponentInstance, 'slots' | '_data'>;
     parameterConfiguration: TParamConfiguration;
-    component: Omit<ComponentInstance, 'slots' | '_parameters' | '_id'>;
+    component: Omit<ComponentInstance, 'slots'>;
     componentDefinitions: Record<string, ComponentDefinition | undefined>;
     parameterDefinition: ComponentDefinitionParameter;
     /** Settings defined at the integration level (arbitrary type used on settings location) */
@@ -749,19 +749,23 @@ type CloseDialogMessage = {
 };
 type GetDataResourceMessage = Pick<DataType, 'path' | 'headers' | 'parameters' | 'body' | 'method'>;
 
+type MeshSDKEventInterface = Awaited<ReturnType<typeof connectToParent>>['parent'] & {
+    initialize: () => Promise<MeshContextData>;
+};
 /**
  * Imports the iframe communications library and provides an interface for interacting with
  * the parent window via said communications library.
  */
-declare function connectToParent({ dialogResponseHandlers, }: {
+declare function connectToParent({ dialogResponseHandlers, onMetadataUpdated, }: {
     dialogResponseHandlers: DialogResponseHandlers;
+    onMetadataUpdated: (metadata: unknown) => void;
 }): Promise<{
     initData: MeshContextData;
     parent: {
-        resize: (height: CSSHeight) => Promise<void>;
-        getValue: () => Promise<unknown>;
-        setValue: (value: unknown, options?: SetValueOptions) => Promise<void>;
-        getMetadata: () => Promise<unknown>;
+        resize: ({ height }: {
+            height: CSSHeight;
+        }) => Promise<void>;
+        setValue: (value: SetValueMessage) => Promise<void>;
         openDialog: (message: OpenDialogMessage) => Promise<Pick<DialogResponseData, "value" | "dialogId"> | undefined>;
         closeDialog: (message: CloseDialogMessage) => Promise<void>;
         getDataResource: <TExpectedResult>(message: GetDataResourceMessage) => Promise<TExpectedResult>;
@@ -877,6 +881,7 @@ type ParamTypeConfigLocationMetadata<TIntegrationConfiguration = unknown> = {
     settings: TIntegrationConfiguration;
     /** The Uniform project ID */
     projectId: string;
+    componentDefinition: ComponentDefinition;
 };
 type ParamTypeConfigLocation<TParamValue = unknown, TIntegrationConfiguration = unknown> = MeshLocationCore<TParamValue | undefined, ParamTypeConfigLocationMetadata<TIntegrationConfiguration>, TParamValue, 'paramTypeConfig'>;
 
@@ -936,6 +941,10 @@ type UniformMeshSDKEvents = {
     onValueChanged: {
         newValue: unknown;
     };
+    /** Fired when the location metadata value has been updated */
+    onMetadataChanged: {
+        newValue: unknown;
+    };
 };
 interface UniformMeshSDK {
     events: Emitter<UniformMeshSDKEvents>;
@@ -975,4 +984,4 @@ declare function initializeUniformMeshSDK({ autoResizingDisabled, }?: {
     autoResizingDisabled?: boolean;
 }): Promise<UniformMeshSDK | undefined>;
 
-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, 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

@@ -451,7 +451,8 @@ var ChildClient = class extends SharedClient {
 
 // src/sdkComms.ts
 async function connectToParent({
-  dialogResponseHandlers
+  dialogResponseHandlers,
+  onMetadataUpdated
 }) {
   const client = new ChildClient({ debug: false });
   window.parent.postMessage("parents just don't understand", "*");
@@ -468,23 +469,15 @@ async function connectToParent({
     }
     delete dialogResponseHandlers[data.dialogId];
   });
+  client.onRequest("metadata-value", onMetadataUpdated);
   return {
     initData,
     parent: {
-      resize: async (height) => {
-        await client.request("resize", { height });
+      resize: async ({ height }) => {
+        await client.request("resize", height);
       },
-      getValue: async () => {
-        const res = await client.request("getValue");
-        return res == null ? void 0 : res.data;
-      },
-      setValue: async (value, options) => {
-        const message = { uniformMeshLocationValue: value, options };
-        await client.request("setValue", message);
-      },
-      getMetadata: async () => {
-        const res = await client.request("getMetadata");
-        return res == null ? void 0 : res.data;
+      setValue: async (value) => {
+        await client.request("setValue", value);
       },
       openDialog: async (message) => {
         var _a;
@@ -594,12 +587,20 @@ async function initializeUniformMeshSDK({
       );
     }
     initializing = true;
+    let currentMetadata = void 0;
+    const events = mitt();
     const connectResult = await connectToParent({
-      dialogResponseHandlers: sdkDialogResponseHandlers
+      dialogResponseHandlers: sdkDialogResponseHandlers,
+      onMetadataUpdated: (newMeta) => {
+        console.debug("Received metadata update", newMeta);
+        currentMetadata = newMeta;
+        events.emit("onMetadataChanged", { newValue: newMeta });
+      }
     });
     const { initData: contextData, parent } = connectResult;
+    currentMetadata = contextData.locationMetadata;
     const sdk = {
-      events: mitt(),
+      events,
       getCurrentLocation: () => {
         const location = {
           getDataResource: parent.getDataResource,
@@ -617,21 +618,21 @@ async function initializeUniformMeshSDK({
             }
             contextData.locationValue = value;
             sdk.events.emit("onValueChanged", { newValue: value });
-            await parent.setValue(value, options);
+            await parent.setValue({ uniformMeshLocationValue: value, options });
           },
           // DEPRECATED
-          getMetadata: () => contextData.locationMetadata,
-          metadata: contextData.locationMetadata,
+          getMetadata: () => currentMetadata,
+          metadata: currentMetadata,
           setValidationResult: async (value) => {
             await location.setValue(contextData.locationValue, value);
           },
           dialogContext: contextData.dialogContext ? {
             ...contextData.dialogContext,
-            params: contextData.locationMetadata.dialogParams,
+            params: currentMetadata.dialogParams,
             returnDialogValue: async (value) => {
               contextData.locationValue = value;
               sdk.events.emit("onValueChanged", { newValue: value });
-              await parent.setValue(value);
+              await parent.setValue({ uniformMeshLocationValue: value });
             }
           } : void 0
         };
@@ -639,7 +640,7 @@ async function initializeUniformMeshSDK({
       },
       currentWindow: createSdkWindow({
         onHeightChange: (height) => {
-          parent.resize(height);
+          parent.resize({ height });
         },
         // If we're in a dialog context and the dialog was opened with a specified `contentHeight`,
         // then we disable autoResizing for the dialog location.

package/dist/index.js

@@ -488,7 +488,8 @@ var ChildClient = class extends SharedClient {
 
 // src/sdkComms.ts
 async function connectToParent({
-  dialogResponseHandlers
+  dialogResponseHandlers,
+  onMetadataUpdated
 }) {
   const client = new ChildClient({ debug: false });
   window.parent.postMessage("parents just don't understand", "*");
@@ -505,23 +506,15 @@ async function connectToParent({
     }
     delete dialogResponseHandlers[data.dialogId];
   });
+  client.onRequest("metadata-value", onMetadataUpdated);
   return {
     initData,
     parent: {
-      resize: async (height) => {
-        await client.request("resize", { height });
+      resize: async ({ height }) => {
+        await client.request("resize", height);
       },
-      getValue: async () => {
-        const res = await client.request("getValue");
-        return res == null ? void 0 : res.data;
-      },
-      setValue: async (value, options) => {
-        const message = { uniformMeshLocationValue: value, options };
-        await client.request("setValue", message);
-      },
-      getMetadata: async () => {
-        const res = await client.request("getMetadata");
-        return res == null ? void 0 : res.data;
+      setValue: async (value) => {
+        await client.request("setValue", value);
       },
       openDialog: async (message) => {
         var _a;
@@ -631,12 +624,20 @@ async function initializeUniformMeshSDK({
       );
     }
     initializing = true;
+    let currentMetadata = void 0;
+    const events = (0, import_mitt.default)();
     const connectResult = await connectToParent({
-      dialogResponseHandlers: sdkDialogResponseHandlers
+      dialogResponseHandlers: sdkDialogResponseHandlers,
+      onMetadataUpdated: (newMeta) => {
+        console.debug("Received metadata update", newMeta);
+        currentMetadata = newMeta;
+        events.emit("onMetadataChanged", { newValue: newMeta });
+      }
     });
     const { initData: contextData, parent } = connectResult;
+    currentMetadata = contextData.locationMetadata;
     const sdk = {
-      events: (0, import_mitt.default)(),
+      events,
       getCurrentLocation: () => {
         const location = {
           getDataResource: parent.getDataResource,
@@ -654,21 +655,21 @@ async function initializeUniformMeshSDK({
             }
             contextData.locationValue = value;
             sdk.events.emit("onValueChanged", { newValue: value });
-            await parent.setValue(value, options);
+            await parent.setValue({ uniformMeshLocationValue: value, options });
           },
           // DEPRECATED
-          getMetadata: () => contextData.locationMetadata,
-          metadata: contextData.locationMetadata,
+          getMetadata: () => currentMetadata,
+          metadata: currentMetadata,
           setValidationResult: async (value) => {
             await location.setValue(contextData.locationValue, value);
           },
           dialogContext: contextData.dialogContext ? {
             ...contextData.dialogContext,
-            params: contextData.locationMetadata.dialogParams,
+            params: currentMetadata.dialogParams,
             returnDialogValue: async (value) => {
               contextData.locationValue = value;
               sdk.events.emit("onValueChanged", { newValue: value });
-              await parent.setValue(value);
+              await parent.setValue({ uniformMeshLocationValue: value });
             }
           } : void 0
         };
@@ -676,7 +677,7 @@ async function initializeUniformMeshSDK({
       },
       currentWindow: createSdkWindow({
         onHeightChange: (height) => {
-          parent.resize(height);
+          parent.resize({ height });
         },
         // If we're in a dialog context and the dialog was opened with a specified `contentHeight`,
         // then we disable autoResizing for the dialog location.

package/dist/index.mjs

@@ -451,7 +451,8 @@ var ChildClient = class extends SharedClient {
 
 // src/sdkComms.ts
 async function connectToParent({
-  dialogResponseHandlers
+  dialogResponseHandlers,
+  onMetadataUpdated
 }) {
   const client = new ChildClient({ debug: false });
   window.parent.postMessage("parents just don't understand", "*");
@@ -468,23 +469,15 @@ async function connectToParent({
     }
     delete dialogResponseHandlers[data.dialogId];
   });
+  client.onRequest("metadata-value", onMetadataUpdated);
   return {
     initData,
     parent: {
-      resize: async (height) => {
-        await client.request("resize", { height });
+      resize: async ({ height }) => {
+        await client.request("resize", height);
       },
-      getValue: async () => {
-        const res = await client.request("getValue");
-        return res == null ? void 0 : res.data;
-      },
-      setValue: async (value, options) => {
-        const message = { uniformMeshLocationValue: value, options };
-        await client.request("setValue", message);
-      },
-      getMetadata: async () => {
-        const res = await client.request("getMetadata");
-        return res == null ? void 0 : res.data;
+      setValue: async (value) => {
+        await client.request("setValue", value);
       },
       openDialog: async (message) => {
         var _a;
@@ -594,12 +587,20 @@ async function initializeUniformMeshSDK({
       );
     }
     initializing = true;
+    let currentMetadata = void 0;
+    const events = mitt();
     const connectResult = await connectToParent({
-      dialogResponseHandlers: sdkDialogResponseHandlers
+      dialogResponseHandlers: sdkDialogResponseHandlers,
+      onMetadataUpdated: (newMeta) => {
+        console.debug("Received metadata update", newMeta);
+        currentMetadata = newMeta;
+        events.emit("onMetadataChanged", { newValue: newMeta });
+      }
     });
     const { initData: contextData, parent } = connectResult;
+    currentMetadata = contextData.locationMetadata;
     const sdk = {
-      events: mitt(),
+      events,
       getCurrentLocation: () => {
         const location = {
           getDataResource: parent.getDataResource,
@@ -617,21 +618,21 @@ async function initializeUniformMeshSDK({
             }
             contextData.locationValue = value;
             sdk.events.emit("onValueChanged", { newValue: value });
-            await parent.setValue(value, options);
+            await parent.setValue({ uniformMeshLocationValue: value, options });
           },
           // DEPRECATED
-          getMetadata: () => contextData.locationMetadata,
-          metadata: contextData.locationMetadata,
+          getMetadata: () => currentMetadata,
+          metadata: currentMetadata,
           setValidationResult: async (value) => {
             await location.setValue(contextData.locationValue, value);
           },
           dialogContext: contextData.dialogContext ? {
             ...contextData.dialogContext,
-            params: contextData.locationMetadata.dialogParams,
+            params: currentMetadata.dialogParams,
             returnDialogValue: async (value) => {
               contextData.locationValue = value;
               sdk.events.emit("onValueChanged", { newValue: value });
-              await parent.setValue(value);
+              await parent.setValue({ uniformMeshLocationValue: value });
             }
           } : void 0
         };
@@ -639,7 +640,7 @@ async function initializeUniformMeshSDK({
       },
       currentWindow: createSdkWindow({
         onHeightChange: (height) => {
-          parent.resize(height);
+          parent.resize({ height });
         },
         // If we're in a dialog context and the dialog was opened with a specified `contentHeight`,
         // then we disable autoResizing for the dialog location.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/mesh-sdk",
-  "version": "18.26.0",
+  "version": "18.27.1-alpha.12+a2ae84d4d",
   "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.26.0",
-    "@uniformdev/context": "18.26.0",
+    "@uniformdev/canvas": "18.27.1-alpha.12+a2ae84d4d",
+    "@uniformdev/context": "18.27.1-alpha.12+a2ae84d4d",
     "mitt": "^3.0.0"
   },
-  "gitHead": "776654d5b12c24cf597acd66cde039d6b0111419"
+  "gitHead": "a2ae84d4d88dab29f6291a75d7628663dc2df8bd"
 }