@uniformdev/mesh-sdk 19.3.0 → 19.6.0

package/dist/index.d.ts

@@ -1,5 +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 { ProjectMapNode } from '@uniformdev/project-map';
 import { DataType } from '@uniformdev/canvas/.';
 import { Emitter } from 'mitt';
 
@@ -645,10 +646,15 @@ type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfig
     settings: TIntegrationConfiguration;
     /** The Uniform project ID */
     projectId: string;
+    /** Current dynamic inputs that are configured on the composition (if any). */
+    dynamicInputs: DynamicInputs;
 };
 type ParamTypeLocation<TParamValue = unknown, TParamConfiguration = unknown, TParamSetValue = TParamValue, TIntegrationConfiguration = unknown> = MeshLocationCore<TParamValue | undefined, ParamTypeLocationMetadata<TParamConfiguration, TIntegrationConfiguration>, TParamSetValue, 'paramType'>;
 
-type SettingsLocation<TSettingsType> = MeshLocationCore<TSettingsType, undefined, TSettingsType, 'settings'>;
+type SettingsLocationMetadata = {
+    projectId: string;
+};
+type SettingsLocation<TSettingsType> = MeshLocationCore<TSettingsType, SettingsLocationMetadata, TSettingsType, 'settings'>;
 
 /**
  * Defines methods used for interacting with a Mesh location
@@ -821,6 +827,21 @@ type SetValueMessage = {
 type GetDataResourceLocation = {
     getDataResource: Awaited<ReturnType<typeof connectToParent>>['parent']['getDataResource'];
 };
+/**
+ * Dynamic inputs come from project map and represent path or query based dynamic values
+ * These can be connected to from within a Mesh location by setting a data resource variable to contain ex:
+ * ${inputName} expression(s).
+ *
+ * Dynamic inputs only work at runtime when using the route endpoint to fetch data.
+ */
+type DynamicInput = {
+    value: string;
+    defaultValue: string;
+    source: ProjectMapNode;
+    type: 'query' | 'path';
+};
+/** 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 DataConnectorInfo = {
@@ -858,6 +879,8 @@ type DataResourceLocationMetadata<TIntegrationConfiguration = unknown> = {
     dataConnector: DataConnectorInfo;
     /** The Uniform project ID */
     projectId: string;
+    /** Current dynamic inputs that are configured on the composition (if any). */
+    dynamicInputs: DynamicInputs;
 };
 type DataResourceLocation = MeshLocationCore<DataResourceVariables, DataResourceLocationMetadata, DataResourceVariables, 'dataResource'> & GetDataResourceLocation;
 
@@ -967,4 +990,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, 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 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/mesh-sdk",
-  "version": "19.3.0",
+  "version": "19.6.0",
   "description": "Uniform Mesh Framework SDK",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -32,9 +32,10 @@
     "access": "public"
   },
   "dependencies": {
-    "@uniformdev/canvas": "19.3.0",
-    "@uniformdev/context": "19.3.0",
+    "@uniformdev/canvas": "19.6.0",
+    "@uniformdev/context": "19.6.0",
+    "@uniformdev/project-map": "19.6.0",
     "mitt": "^3.0.0"
   },
-  "gitHead": "57552ffe10ca66f905d8908c82dde39935fb1803"
+  "gitHead": "a14550dd1caa33fa1310ada642d06ce79bbe4eac"
 }