@uniformdev/mesh-sdk 17.5.1-alpha.7 → 17.6.0

package/dist/index.d.ts

@@ -1,82 +1,5 @@
+import { DataSourceInfo, DataType, DataResourceVariables, RootComponentInstance, ComponentInstance, ComponentDefinition, ComponentDefinitionParameter, DataSource } from '@uniformdev/canvas';
 import { Emitter } from 'mitt';
-import { RootComponentInstance, ComponentInstance, ComponentDefinition, ComponentDefinitionParameter, DataSource, DataSourceInfo, DataType, DataResourceVariables } from '@uniformdev/canvas';
-
-/** 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) */
-    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;
-    /**
-     * Sets the current value of the location.
-     * All locations other than 'settings' update into a parent form state and should be updated live as changes occur in the Mesh app.
-     * 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: (value: TSetValue, options?: SetValueOptions) => Promise<void>;
-    /** @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:
-     * - You pop out the app using sdk.openCurrentLocationDialog() so the location is rendered in a dialog for more screen space
-     * - The current location is a named dialog that was opened from the location using sdk.openLocationDialog()
-     *
-     * This is undefined when the current location is not a dialog.
-     */
-    dialogContext?: DialogContext & {
-        /** Parameters passed to the dialog when it was opened */
-        params: unknown;
-        /**
-         * Returns a result to the dialog opener.
-         */
-        returnDialogValue: (value: unknown) => Promise<void>;
-    };
-}
-/**
- * Known location types that can be passed to a mesh location
- */
-declare type MeshLocationTypes = 'paramType' | 'paramTypeConfig' | 'settings' | 'dataSource' | 'dataType' | 'dataTypeInstance';
-declare type SetValueOptions = ValidationResult;
-
-declare type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfiguration = unknown> = {
-    rootNode: Omit<RootComponentInstance, 'slots' | '_data'>;
-    parameterConfiguration: TParamConfiguration;
-    component: Omit<ComponentInstance, 'slots' | '_parameters' | '_id'>;
-    componentDefinitions: Record<string, ComponentDefinition | undefined>;
-    parameterDefinition: ComponentDefinitionParameter;
-    settings: TIntegrationConfiguration;
-    projectId: string;
-};
-declare type ParamTypeLocation<TParamValue = unknown, TParamConfiguration = unknown, TParamSetValue = TParamValue, TIntegrationConfiguration = unknown> = MeshLocationCore<TParamValue, ParamTypeLocationMetadata<TParamConfiguration, TIntegrationConfiguration>, TParamSetValue, 'paramType'>;
-
-declare type ParamTypeConfigLocationMetadata<TIntegrationConfiguration = unknown> = {
-    settings: TIntegrationConfiguration;
-    projectId: string;
-};
-declare type ParamTypeConfigLocation<TParamValue = unknown, TIntegrationConfiguration = unknown> = MeshLocationCore<TParamValue | undefined, ParamTypeConfigLocationMetadata<TIntegrationConfiguration>, TParamValue, 'paramTypeConfig'>;
-
-declare type SettingsLocation<TSettingsType> = MeshLocationCore<TSettingsType, undefined, TSettingsType, 'settings'>;
-
-declare type DataSourceLocationValue = Pick<DataSource, 'baseUrl' | 'custom' | 'headers' | 'parameters' | 'variables'>;
-declare type DataSourceLocationMetadata<TIntegrationConfiguration = unknown> = {
-    settings: TIntegrationConfiguration;
-    projectId: string;
-};
-declare type DataSourceLocation = MeshLocationCore<DataSourceLocationValue, DataSourceLocationMetadata, DataSourceLocationValue, 'dataSource'>;
 
 declare type DataTypeValue = Pick<DataType, 'body' | 'method' | 'path' | 'custom' | 'headers' | 'parameters' | 'variables'>;
 declare type DataConnectorInfo = {
@@ -100,6 +23,19 @@ declare type DataTypeInstanceLocationMetadata<TIntegrationConfiguration = unknow
 };
 declare type DataTypeInstanceLocation = MeshLocationCore<DataResourceVariables, DataTypeInstanceLocationMetadata, DataResourceVariables, 'dataTypeInstance'>;
 
+declare type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfiguration = unknown> = {
+    rootNode: Omit<RootComponentInstance, 'slots' | '_data'>;
+    parameterConfiguration: TParamConfiguration;
+    component: Omit<ComponentInstance, 'slots' | '_parameters' | '_id'>;
+    componentDefinitions: Record<string, ComponentDefinition | undefined>;
+    parameterDefinition: ComponentDefinitionParameter;
+    settings: TIntegrationConfiguration;
+    projectId: string;
+};
+declare 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'>;
+
 /**
  * Defines methods used for interacting with a Mesh location
  * To receive useful typings, check the `type` property of the location to narrow the typing.
@@ -188,6 +124,70 @@ declare type ValidationResult = {
     isValid: true;
 };
 
+/** 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) */
+    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;
+    /**
+     * Sets the current value of the location.
+     * All locations other than 'settings' update into a parent form state and should be updated live as changes occur in the Mesh app.
+     * 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: (value: TSetValue, options?: SetValueOptions) => Promise<void>;
+    /** @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:
+     * - You pop out the app using sdk.openCurrentLocationDialog() so the location is rendered in a dialog for more screen space
+     * - The current location is a named dialog that was opened from the location using sdk.openLocationDialog()
+     *
+     * This is undefined when the current location is not a dialog.
+     */
+    dialogContext?: DialogContext & {
+        /** Parameters passed to the dialog when it was opened */
+        params: unknown;
+        /**
+         * Returns a result to the dialog opener.
+         */
+        returnDialogValue: (value: unknown) => Promise<void>;
+    };
+}
+/**
+ * Known location types that can be passed to a mesh location
+ */
+declare type MeshLocationTypes = 'paramType' | 'paramTypeConfig' | 'settings' | 'dataSource' | 'dataType' | 'dataTypeInstance';
+declare type SetValueOptions = ValidationResult;
+
+declare type DataSourceLocationValue = Pick<DataSource, 'baseUrl' | 'custom' | 'headers' | 'parameters' | 'variables'>;
+declare type DataSourceLocationMetadata<TIntegrationConfiguration = unknown> = {
+    settings: TIntegrationConfiguration;
+    projectId: string;
+};
+declare type DataSourceLocation = MeshLocationCore<DataSourceLocationValue, DataSourceLocationMetadata, DataSourceLocationValue, 'dataSource'>;
+
+declare type ParamTypeConfigLocationMetadata<TIntegrationConfiguration = unknown> = {
+    settings: TIntegrationConfiguration;
+    projectId: string;
+};
+declare type ParamTypeConfigLocation<TParamValue = unknown, TIntegrationConfiguration = unknown> = MeshLocationCore<TParamValue | undefined, ParamTypeConfigLocationMetadata<TIntegrationConfiguration>, TParamValue, 'paramTypeConfig'>;
+
 interface SdkWindow {
     /** The current window object. */
     instance: Window;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/mesh-sdk",
-  "version": "17.5.1-alpha.7+ab97e4ba9",
+  "version": "17.6.0",
   "description": "Uniform Mesh Framework SDK",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -29,8 +29,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@uniformdev/canvas": "^17.5.1-alpha.7+ab97e4ba9",
+    "@uniformdev/canvas": "^17.6.0",
     "mitt": "^3.0.0"
   },
-  "gitHead": "ab97e4ba97e3842e6c7f208c4c96be3f9f74337e"
+  "gitHead": "8346fa3ffe24fa0f81fb0c8b0d12e27806ae321b"
 }