@uniformdev/mesh-sdk 20.7.1-alpha.26 → 20.7.1-alpha.32

package/dist/index.d.mts

@@ -1,7 +1,7 @@
 import { ApiClient, ClientOptions, ExceptProject } from '@uniformdev/context/api';
-import { ProjectMapNode } from '@uniformdev/project-map';
-import { AssetParamValue, DataType, DataSource, DataSourceVariantsKeys, DataResourceVariables, RootComponentInstance, ComponentInstance, ComponentDefinition, ComponentDefinitionParameter, Locale, DataVariableDefinition, EntryData } from '@uniformdev/canvas';
+import { AssetParamValue, DataType, DataSource, DataSourceVariantsKeys, DataResourceVariables, RootComponentInstance, ComponentInstance, ComponentDefinition, ComponentDefinitionParameter, DataVariableDefinition, Locale, EntryData } from '@uniformdev/canvas';
 export { AssetParamValue, AssetParamValueItem } from '@uniformdev/canvas';
+import { ProjectMapNode } from '@uniformdev/project-map';
 import { AssetDefinitionType } from '@uniformdev/assets';
 import { Emitter } from 'mitt';
 
@@ -233,15 +233,22 @@ interface paths$1 {
                                                 definition: {
                                                     name: string;
                                                     description: string;
-                                                    parameters?: {
+                                                    parameters: {
                                                         [key: string]: unknown;
                                                     };
+                                                    strict: boolean;
                                                 };
                                                 systemParameters?: "pageHtml"[];
                                                 includedAgents?: ("scout" | "sage")[];
                                             }[];
                                         };
                                     };
+                                    tools?: {
+                                        id: string;
+                                        name: string;
+                                        url: string;
+                                        iconUrl?: string;
+                                    }[];
                                 };
                                 unstable_prompts?: {
                                     /** Format: uuid */
@@ -486,15 +493,22 @@ interface paths$1 {
                                             definition: {
                                                 name: string;
                                                 description: string;
-                                                parameters?: {
+                                                parameters: {
                                                     [key: string]: unknown;
                                                 };
+                                                strict: boolean;
                                             };
                                             systemParameters?: "pageHtml"[];
                                             includedAgents?: ("scout" | "sage")[];
                                         }[];
                                     };
                                 };
+                                tools?: {
+                                    id: string;
+                                    name: string;
+                                    url: string;
+                                    iconUrl?: string;
+                                }[];
                             };
                             unstable_prompts?: {
                                 /** Format: uuid */
@@ -724,15 +738,22 @@ interface paths$1 {
                                             definition: {
                                                 name: string;
                                                 description: string;
-                                                parameters?: {
+                                                parameters: {
                                                     [key: string]: unknown;
                                                 };
+                                                strict: boolean;
                                             };
                                             systemParameters?: "pageHtml"[];
                                             includedAgents?: ("scout" | "sage")[];
                                         }[];
                                     };
                                 };
+                                tools?: {
+                                    id: string;
+                                    name: string;
+                                    url: string;
+                                    iconUrl?: string;
+                                }[];
                             };
                             unstable_prompts?: {
                                 /** Format: uuid */
@@ -1311,15 +1332,22 @@ declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
                         definition: {
                             name: string;
                             description: string;
-                            parameters?: {
+                            parameters: {
                                 [key: string]: unknown;
                             };
+                            strict: boolean;
                         };
                         systemParameters?: "pageHtml"[];
                         includedAgents?: ("scout" | "sage")[];
                     }[];
                 };
             };
+            tools?: {
+                id: string;
+                name: string;
+                url: string;
+                iconUrl?: string;
+            }[];
         };
         unstable_prompts?: {
             id: string;
@@ -1388,7 +1416,11 @@ type FunctionCallSystemParameter = (typeof functionCallSystemParameters)[number]
 declare function parseFunctionCall<Parameters extends Record<string, string>, Settings = Record<string, string>>(request: Pick<Request, 'body'>): {
     functionCall: {
         arguments: Parameters;
+        call_id: string;
         name: string;
+        type: "function_call";
+        id?: string;
+        status?: "in_progress" | "completed" | "incomplete";
     };
     settings: Settings;
     systemParameters: Record<FunctionCallSystemParameter, string | undefined>;
@@ -1504,16 +1536,14 @@ type ParamTypeLocation<TParamValue = unknown, TParamConfiguration = unknown, TPa
     editConnectedData: Awaited<ReturnType<typeof connectToParent>>['parent']['editConnectedData'];
 };
 
-type SettingsLocationMetadata = CommonMetadata & {
-    locales: Locale[];
-};
+type SettingsLocationMetadata = CommonMetadata;
 type SettingsLocation<TSettingsType> = MeshLocationCore<TSettingsType, SettingsLocationMetadata, 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.
  */
-type MeshLocation<TValue = unknown, TSetValue = TValue> = ParamTypeLocation<TValue, unknown, TSetValue> | ParamTypeConfigLocation<TValue> | SettingsLocation<TValue> | AssetLibraryLocation | AssetParameterLocation | DataSourceLocation | DataTypeLocation | DataResourceLocation | CanvasEditorToolsLocation | EmbeddedEditorLocation | AIGenerateLocation<TValue> | AIPromptMetadataLocation | PersonalizationCriteriaLocation<TValue>;
+type MeshLocation<TValue = unknown, TSetValue = TValue> = ParamTypeLocation<TValue, unknown, TSetValue> | ParamTypeConfigLocation<TValue> | SettingsLocation<TValue> | AssetLibraryLocation | AssetParameterLocation | DataSourceLocation | DataTypeLocation | DataResourceLocation | CanvasEditorToolsLocation | EmbeddedEditorLocation | AIGenerateLocation<TValue> | AIPromptMetadataLocation | PersonalizationCriteriaLocation<TValue> | ToolLocation<TValue>;
 interface MeshContextData {
     locationKey: string;
     locationType: MeshLocationTypes;
@@ -1522,6 +1552,7 @@ interface MeshContextData {
     locationMetadata: any;
     uniformApiVersion: string;
     dialogContext?: DialogContext;
+    fullScreenHeight?: boolean;
 }
 interface DialogContext {
     dialogId: string;
@@ -1620,6 +1651,12 @@ type OpenDialogMessage = {
     dialogData: unknown;
     options?: DialogOptions;
 };
+type NavigateMessage = {
+    path: string;
+    options?: {
+        target?: '_blank';
+    };
+};
 type CloseDialogMessage = {
     dialogId: string | undefined;
     dialogType: DialogType;
@@ -1694,6 +1731,8 @@ declare function connectToParent({ dialogResponseHandlers, onMetadataUpdated, on
         openDialog: (message: OpenDialogMessage) => Promise<Pick<DialogResponseData, "value" | "dialogId"> | undefined>;
         closeDialog: (message: CloseDialogMessage) => Promise<void>;
         getDataResource: <TExpectedResult>(message: GetDataResourceMessage) => Promise<TExpectedResult>;
+        navigate: (message: NavigateMessage) => Promise<void>;
+        reloadLocation: () => Promise<void>;
         editConnectedData: (message: EditConnectedDataMessage) => Promise<EditConnectedDataResponse>;
     };
 }>;
@@ -1718,6 +1757,12 @@ interface MeshLocationCore<TValue = unknown, TMetadata = unknown, TSetValue = TV
      * Each location has a specific type of metadata that it is provided, which is typed automatically when the location is known.
      */
     metadata: TMetadata;
+    /**
+     * A router object that can be used to navigate parent frame (Uniform App) to other page within current project and other methods.
+     *
+     * @deprecated Is not stable yet so can contain breaking changes in the future
+     */
+    router: MeshRouter;
     /**
      * Context of a location when it is rendering inside a dialog in the Uniform app.
      * This is set when:
@@ -1735,6 +1780,19 @@ interface MeshLocationCore<TValue = unknown, TMetadata = unknown, TSetValue = TV
         returnDialogValue: (value: unknown) => Promise<void>;
     };
 }
+type MeshRouter = {
+    /**
+     * Navigate parent frame (Uniform App) to a new path within current project.
+     *
+     * So router.navigate('/canvas/edit/{compositionId}') will navigate will open the composition editor for the given composition ID in the parent frame.
+     * Be aware that most of the time it will close your mesh app, so you should use it with caution.
+     *
+     * @deprecated Is not stable yet so can contain breaking changes in the future
+     */
+    navigatePlatform: (path: string, options?: {
+        target?: '_blank';
+    }) => void;
+};
 /** Common metadata for all mesh locations */
 type CommonMetadata<ExtendedMetadata = unknown, TIntegrationConfiguration = unknown> = {
     /** The current Uniform user context. Contains name, email and context to check for permissions */
@@ -1745,6 +1803,8 @@ type CommonMetadata<ExtendedMetadata = unknown, TIntegrationConfiguration = unkn
     dashboardOrigin: string;
     /** Settings defined at the integration level (arbitrary type used on settings location) */
     settings: TIntegrationConfiguration;
+    /** List if enabled Uniform Project locales */
+    locales: Locale[];
 } & ExtendedMetadata;
 type MeshLocationUserPermissions = 
 /** Uniform Context:Enrichments:Create */
@@ -1828,7 +1888,7 @@ type MeshLocationUserPermissions =
 /**
  * Known location types that can be passed to a mesh location
  */
-type MeshLocationTypes = 'paramType' | 'paramTypeConfig' | 'assetLibrary' | 'assetParameter' | 'settings' | 'dataSource' | 'dataType' | 'dataResource' | 'aiGenerate' | 'embeddedEditor' | 'canvasEditorTools' | 'aiMetadata' | 'personalizationCriteria';
+type MeshLocationTypes = 'paramType' | 'paramTypeConfig' | 'assetLibrary' | 'assetParameter' | 'settings' | 'dataSource' | 'dataType' | 'dataResource' | 'aiGenerate' | 'embeddedEditor' | 'canvasEditorTools' | 'aiMetadata' | 'personalizationCriteria' | 'tool';
 type SetValueOptions = ValidationResult;
 type SetValueMessage = {
     uniformMeshLocationValue: unknown;
@@ -1870,7 +1930,6 @@ type AIPromptMetadataLocation = MeshLocationCore<Record<string, unknown>, Prompt
 type CanvasEditorToolsLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
     releaseId?: string;
     state?: number;
-    locales: Locale[];
 }, TIntegrationConfiguration>;
 type CanvasEditorToolsReferenceData = {
     name: string;
@@ -1949,6 +2008,11 @@ type PersonalizationCriteriaLocationMetadata<TIntegrationConfiguration = unknown
 /** @deprecated Experimental functionality is subject to change in minor versions. */
 type PersonalizationCriteriaLocation<TCriteriaValue, TIntegrationConfiguration = unknown> = MeshLocationCore<TCriteriaValue | undefined, PersonalizationCriteriaLocationMetadata<TIntegrationConfiguration>, TCriteriaValue, 'personalizationCriteria'>;
 
+/** @deprecated Experimental functionality is subject to change in minor versions. */
+type ToolLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<unknown, TIntegrationConfiguration>;
+/** @deprecated Experimental functionality is subject to change in minor versions. */
+type ToolLocation<TTool, TIntegrationConfiguration = unknown> = MeshLocationCore<TTool, ToolLocationMetadata<TIntegrationConfiguration>, TTool, 'tool'>;
+
 interface SdkWindow {
     /** The current window object. */
     instance: Window;
@@ -2052,4 +2116,4 @@ declare const hasPermissions: (permissions: MeshLocationUserPermissions | MeshLo
  */
 declare const hasRole: (role: string, user: UniformUser) => boolean;
 
-export { type AIGenerateLocation, type AIGenerateLocationMetadata, type AIPromptMetadataLocation, type AssetLibraryLocation, type AssetLibraryLocationMetadata, type AssetParameterLocation, type AssetParameterLocationMetadata, type BindableTypes, type CSSHeight, type CanvasEditorEntityType, type CanvasEditorToolsData, type CanvasEditorToolsLocation, type CanvasEditorToolsLocationMetadata, type CloseDialogMessage, type CloseLocationDialogOptions, type CommonMetadata, type DataConnectorInfo, type DataResourceLocation, type DataResourceLocationMetadata, type DataSourceLocation, type DataSourceLocationMetadata, type DataSourceLocationValue, type DataTypeLocation, type DataTypeLocationMetadata, type DataTypeLocationValue, type DialogContext, type DialogOptions, type DialogParamValue, type DialogParams, type DialogResponseData, type DialogResponseHandler, type DialogResponseHandlers, type DialogType, type DynamicInput, type DynamicInputs, type EditConnectedDataMessage, type EditConnectedDataResponse, type EditConnectedDataResponseCancellationContext, type EmbeddedEditorLocation, type EmbeddedEditorLocationMetadata, type EmbeddedEditorLocationSetValue, type EmbeddedEditorLocationValue, type FunctionCallResponse, type FunctionCallSystemParameter, type GetDataResourceLocation, type GetDataResourceMessage, IntegrationDefinitionClient, type IntegrationDefinitionDeleteParameters, type IntegrationDefinitionGetParameters, type IntegrationDefinitionGetResponse, type IntegrationDefinitionPutParameters, type IntegrationDefinitionPutResponse, IntegrationInstallationClient, type IntegrationInstallationDeleteParameters, type IntegrationInstallationGetParameters, type IntegrationInstallationGetResponse, type IntegrationInstallationPutParameters, type LocationDialogResponse, type MeshContextData, type MeshLocation, type MeshLocationCore, type MeshLocationTypes, type MeshLocationUserPermissions, type MeshSDKEventInterface, type OpenConfirmationDialogOptions, type OpenConfirmationDialogResult, type OpenDialogMessage, type OpenDialogResult, type OpenLocationDialogOptions, type ParamTypeConfigLocation, type ParamTypeConfigLocationMetadata, type ParamTypeLocation, type ParamTypeLocationMetadata, type PersonalizationCriteriaLocation, type PersonalizationCriteriaLocationMetadata, type PromptSettingsLocationMetadata, type SdkWindow, type SetLocationFunction, type SetValueMessage, type SetValueOptions, type SettingsLocation, type SettingsLocationMetadata, type UniformMeshSDK, type UniformMeshSDKEvents, type UniformUser, type ValidationResult, functionCallSystemParameters, hasPermissions, hasRole, initializeUniformMeshSDK, parseFunctionCall };
+export { type AIGenerateLocation, type AIGenerateLocationMetadata, type AIPromptMetadataLocation, type AssetLibraryLocation, type AssetLibraryLocationMetadata, type AssetParameterLocation, type AssetParameterLocationMetadata, type BindableTypes, type CSSHeight, type CanvasEditorEntityType, type CanvasEditorToolsData, type CanvasEditorToolsLocation, type CanvasEditorToolsLocationMetadata, type CloseDialogMessage, type CloseLocationDialogOptions, type CommonMetadata, type DataConnectorInfo, type DataResourceLocation, type DataResourceLocationMetadata, type DataSourceLocation, type DataSourceLocationMetadata, type DataSourceLocationValue, type DataTypeLocation, type DataTypeLocationMetadata, type DataTypeLocationValue, type DialogContext, type DialogOptions, type DialogParamValue, type DialogParams, type DialogResponseData, type DialogResponseHandler, type DialogResponseHandlers, type DialogType, type DynamicInput, type DynamicInputs, type EditConnectedDataMessage, type EditConnectedDataResponse, type EditConnectedDataResponseCancellationContext, type EmbeddedEditorLocation, type EmbeddedEditorLocationMetadata, type EmbeddedEditorLocationSetValue, type EmbeddedEditorLocationValue, type FunctionCallResponse, type FunctionCallSystemParameter, type GetDataResourceLocation, type GetDataResourceMessage, IntegrationDefinitionClient, type IntegrationDefinitionDeleteParameters, type IntegrationDefinitionGetParameters, type IntegrationDefinitionGetResponse, type IntegrationDefinitionPutParameters, type IntegrationDefinitionPutResponse, IntegrationInstallationClient, type IntegrationInstallationDeleteParameters, type IntegrationInstallationGetParameters, type IntegrationInstallationGetResponse, type IntegrationInstallationPutParameters, type LocationDialogResponse, type MeshContextData, type MeshLocation, type MeshLocationCore, type MeshLocationTypes, type MeshLocationUserPermissions, type MeshRouter, type MeshSDKEventInterface, type NavigateMessage, type OpenConfirmationDialogOptions, type OpenConfirmationDialogResult, type OpenDialogMessage, type OpenDialogResult, type OpenLocationDialogOptions, type ParamTypeConfigLocation, type ParamTypeConfigLocationMetadata, type ParamTypeLocation, type ParamTypeLocationMetadata, type PersonalizationCriteriaLocation, type PersonalizationCriteriaLocationMetadata, type PromptSettingsLocationMetadata, type SdkWindow, type SetLocationFunction, type SetValueMessage, type SetValueOptions, type SettingsLocation, type SettingsLocationMetadata, type ToolLocation, type ToolLocationMetadata, type UniformMeshSDK, type UniformMeshSDKEvents, type UniformUser, type ValidationResult, functionCallSystemParameters, hasPermissions, hasRole, initializeUniformMeshSDK, parseFunctionCall };

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { ApiClient, ClientOptions, ExceptProject } from '@uniformdev/context/api';
-import { ProjectMapNode } from '@uniformdev/project-map';
-import { AssetParamValue, DataType, DataSource, DataSourceVariantsKeys, DataResourceVariables, RootComponentInstance, ComponentInstance, ComponentDefinition, ComponentDefinitionParameter, Locale, DataVariableDefinition, EntryData } from '@uniformdev/canvas';
+import { AssetParamValue, DataType, DataSource, DataSourceVariantsKeys, DataResourceVariables, RootComponentInstance, ComponentInstance, ComponentDefinition, ComponentDefinitionParameter, DataVariableDefinition, Locale, EntryData } from '@uniformdev/canvas';
 export { AssetParamValue, AssetParamValueItem } from '@uniformdev/canvas';
+import { ProjectMapNode } from '@uniformdev/project-map';
 import { AssetDefinitionType } from '@uniformdev/assets';
 import { Emitter } from 'mitt';
 
@@ -233,15 +233,22 @@ interface paths$1 {
                                                 definition: {
                                                     name: string;
                                                     description: string;
-                                                    parameters?: {
+                                                    parameters: {
                                                         [key: string]: unknown;
                                                     };
+                                                    strict: boolean;
                                                 };
                                                 systemParameters?: "pageHtml"[];
                                                 includedAgents?: ("scout" | "sage")[];
                                             }[];
                                         };
                                     };
+                                    tools?: {
+                                        id: string;
+                                        name: string;
+                                        url: string;
+                                        iconUrl?: string;
+                                    }[];
                                 };
                                 unstable_prompts?: {
                                     /** Format: uuid */
@@ -486,15 +493,22 @@ interface paths$1 {
                                             definition: {
                                                 name: string;
                                                 description: string;
-                                                parameters?: {
+                                                parameters: {
                                                     [key: string]: unknown;
                                                 };
+                                                strict: boolean;
                                             };
                                             systemParameters?: "pageHtml"[];
                                             includedAgents?: ("scout" | "sage")[];
                                         }[];
                                     };
                                 };
+                                tools?: {
+                                    id: string;
+                                    name: string;
+                                    url: string;
+                                    iconUrl?: string;
+                                }[];
                             };
                             unstable_prompts?: {
                                 /** Format: uuid */
@@ -724,15 +738,22 @@ interface paths$1 {
                                             definition: {
                                                 name: string;
                                                 description: string;
-                                                parameters?: {
+                                                parameters: {
                                                     [key: string]: unknown;
                                                 };
+                                                strict: boolean;
                                             };
                                             systemParameters?: "pageHtml"[];
                                             includedAgents?: ("scout" | "sage")[];
                                         }[];
                                     };
                                 };
+                                tools?: {
+                                    id: string;
+                                    name: string;
+                                    url: string;
+                                    iconUrl?: string;
+                                }[];
                             };
                             unstable_prompts?: {
                                 /** Format: uuid */
@@ -1311,15 +1332,22 @@ declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
                         definition: {
                             name: string;
                             description: string;
-                            parameters?: {
+                            parameters: {
                                 [key: string]: unknown;
                             };
+                            strict: boolean;
                         };
                         systemParameters?: "pageHtml"[];
                         includedAgents?: ("scout" | "sage")[];
                     }[];
                 };
             };
+            tools?: {
+                id: string;
+                name: string;
+                url: string;
+                iconUrl?: string;
+            }[];
         };
         unstable_prompts?: {
             id: string;
@@ -1388,7 +1416,11 @@ type FunctionCallSystemParameter = (typeof functionCallSystemParameters)[number]
 declare function parseFunctionCall<Parameters extends Record<string, string>, Settings = Record<string, string>>(request: Pick<Request, 'body'>): {
     functionCall: {
         arguments: Parameters;
+        call_id: string;
         name: string;
+        type: "function_call";
+        id?: string;
+        status?: "in_progress" | "completed" | "incomplete";
     };
     settings: Settings;
     systemParameters: Record<FunctionCallSystemParameter, string | undefined>;
@@ -1504,16 +1536,14 @@ type ParamTypeLocation<TParamValue = unknown, TParamConfiguration = unknown, TPa
     editConnectedData: Awaited<ReturnType<typeof connectToParent>>['parent']['editConnectedData'];
 };
 
-type SettingsLocationMetadata = CommonMetadata & {
-    locales: Locale[];
-};
+type SettingsLocationMetadata = CommonMetadata;
 type SettingsLocation<TSettingsType> = MeshLocationCore<TSettingsType, SettingsLocationMetadata, 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.
  */
-type MeshLocation<TValue = unknown, TSetValue = TValue> = ParamTypeLocation<TValue, unknown, TSetValue> | ParamTypeConfigLocation<TValue> | SettingsLocation<TValue> | AssetLibraryLocation | AssetParameterLocation | DataSourceLocation | DataTypeLocation | DataResourceLocation | CanvasEditorToolsLocation | EmbeddedEditorLocation | AIGenerateLocation<TValue> | AIPromptMetadataLocation | PersonalizationCriteriaLocation<TValue>;
+type MeshLocation<TValue = unknown, TSetValue = TValue> = ParamTypeLocation<TValue, unknown, TSetValue> | ParamTypeConfigLocation<TValue> | SettingsLocation<TValue> | AssetLibraryLocation | AssetParameterLocation | DataSourceLocation | DataTypeLocation | DataResourceLocation | CanvasEditorToolsLocation | EmbeddedEditorLocation | AIGenerateLocation<TValue> | AIPromptMetadataLocation | PersonalizationCriteriaLocation<TValue> | ToolLocation<TValue>;
 interface MeshContextData {
     locationKey: string;
     locationType: MeshLocationTypes;
@@ -1522,6 +1552,7 @@ interface MeshContextData {
     locationMetadata: any;
     uniformApiVersion: string;
     dialogContext?: DialogContext;
+    fullScreenHeight?: boolean;
 }
 interface DialogContext {
     dialogId: string;
@@ -1620,6 +1651,12 @@ type OpenDialogMessage = {
     dialogData: unknown;
     options?: DialogOptions;
 };
+type NavigateMessage = {
+    path: string;
+    options?: {
+        target?: '_blank';
+    };
+};
 type CloseDialogMessage = {
     dialogId: string | undefined;
     dialogType: DialogType;
@@ -1694,6 +1731,8 @@ declare function connectToParent({ dialogResponseHandlers, onMetadataUpdated, on
         openDialog: (message: OpenDialogMessage) => Promise<Pick<DialogResponseData, "value" | "dialogId"> | undefined>;
         closeDialog: (message: CloseDialogMessage) => Promise<void>;
         getDataResource: <TExpectedResult>(message: GetDataResourceMessage) => Promise<TExpectedResult>;
+        navigate: (message: NavigateMessage) => Promise<void>;
+        reloadLocation: () => Promise<void>;
         editConnectedData: (message: EditConnectedDataMessage) => Promise<EditConnectedDataResponse>;
     };
 }>;
@@ -1718,6 +1757,12 @@ interface MeshLocationCore<TValue = unknown, TMetadata = unknown, TSetValue = TV
      * Each location has a specific type of metadata that it is provided, which is typed automatically when the location is known.
      */
     metadata: TMetadata;
+    /**
+     * A router object that can be used to navigate parent frame (Uniform App) to other page within current project and other methods.
+     *
+     * @deprecated Is not stable yet so can contain breaking changes in the future
+     */
+    router: MeshRouter;
     /**
      * Context of a location when it is rendering inside a dialog in the Uniform app.
      * This is set when:
@@ -1735,6 +1780,19 @@ interface MeshLocationCore<TValue = unknown, TMetadata = unknown, TSetValue = TV
         returnDialogValue: (value: unknown) => Promise<void>;
     };
 }
+type MeshRouter = {
+    /**
+     * Navigate parent frame (Uniform App) to a new path within current project.
+     *
+     * So router.navigate('/canvas/edit/{compositionId}') will navigate will open the composition editor for the given composition ID in the parent frame.
+     * Be aware that most of the time it will close your mesh app, so you should use it with caution.
+     *
+     * @deprecated Is not stable yet so can contain breaking changes in the future
+     */
+    navigatePlatform: (path: string, options?: {
+        target?: '_blank';
+    }) => void;
+};
 /** Common metadata for all mesh locations */
 type CommonMetadata<ExtendedMetadata = unknown, TIntegrationConfiguration = unknown> = {
     /** The current Uniform user context. Contains name, email and context to check for permissions */
@@ -1745,6 +1803,8 @@ type CommonMetadata<ExtendedMetadata = unknown, TIntegrationConfiguration = unkn
     dashboardOrigin: string;
     /** Settings defined at the integration level (arbitrary type used on settings location) */
     settings: TIntegrationConfiguration;
+    /** List if enabled Uniform Project locales */
+    locales: Locale[];
 } & ExtendedMetadata;
 type MeshLocationUserPermissions = 
 /** Uniform Context:Enrichments:Create */
@@ -1828,7 +1888,7 @@ type MeshLocationUserPermissions =
 /**
  * Known location types that can be passed to a mesh location
  */
-type MeshLocationTypes = 'paramType' | 'paramTypeConfig' | 'assetLibrary' | 'assetParameter' | 'settings' | 'dataSource' | 'dataType' | 'dataResource' | 'aiGenerate' | 'embeddedEditor' | 'canvasEditorTools' | 'aiMetadata' | 'personalizationCriteria';
+type MeshLocationTypes = 'paramType' | 'paramTypeConfig' | 'assetLibrary' | 'assetParameter' | 'settings' | 'dataSource' | 'dataType' | 'dataResource' | 'aiGenerate' | 'embeddedEditor' | 'canvasEditorTools' | 'aiMetadata' | 'personalizationCriteria' | 'tool';
 type SetValueOptions = ValidationResult;
 type SetValueMessage = {
     uniformMeshLocationValue: unknown;
@@ -1870,7 +1930,6 @@ type AIPromptMetadataLocation = MeshLocationCore<Record<string, unknown>, Prompt
 type CanvasEditorToolsLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
     releaseId?: string;
     state?: number;
-    locales: Locale[];
 }, TIntegrationConfiguration>;
 type CanvasEditorToolsReferenceData = {
     name: string;
@@ -1949,6 +2008,11 @@ type PersonalizationCriteriaLocationMetadata<TIntegrationConfiguration = unknown
 /** @deprecated Experimental functionality is subject to change in minor versions. */
 type PersonalizationCriteriaLocation<TCriteriaValue, TIntegrationConfiguration = unknown> = MeshLocationCore<TCriteriaValue | undefined, PersonalizationCriteriaLocationMetadata<TIntegrationConfiguration>, TCriteriaValue, 'personalizationCriteria'>;
 
+/** @deprecated Experimental functionality is subject to change in minor versions. */
+type ToolLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<unknown, TIntegrationConfiguration>;
+/** @deprecated Experimental functionality is subject to change in minor versions. */
+type ToolLocation<TTool, TIntegrationConfiguration = unknown> = MeshLocationCore<TTool, ToolLocationMetadata<TIntegrationConfiguration>, TTool, 'tool'>;
+
 interface SdkWindow {
     /** The current window object. */
     instance: Window;
@@ -2052,4 +2116,4 @@ declare const hasPermissions: (permissions: MeshLocationUserPermissions | MeshLo
  */
 declare const hasRole: (role: string, user: UniformUser) => boolean;
 
-export { type AIGenerateLocation, type AIGenerateLocationMetadata, type AIPromptMetadataLocation, type AssetLibraryLocation, type AssetLibraryLocationMetadata, type AssetParameterLocation, type AssetParameterLocationMetadata, type BindableTypes, type CSSHeight, type CanvasEditorEntityType, type CanvasEditorToolsData, type CanvasEditorToolsLocation, type CanvasEditorToolsLocationMetadata, type CloseDialogMessage, type CloseLocationDialogOptions, type CommonMetadata, type DataConnectorInfo, type DataResourceLocation, type DataResourceLocationMetadata, type DataSourceLocation, type DataSourceLocationMetadata, type DataSourceLocationValue, type DataTypeLocation, type DataTypeLocationMetadata, type DataTypeLocationValue, type DialogContext, type DialogOptions, type DialogParamValue, type DialogParams, type DialogResponseData, type DialogResponseHandler, type DialogResponseHandlers, type DialogType, type DynamicInput, type DynamicInputs, type EditConnectedDataMessage, type EditConnectedDataResponse, type EditConnectedDataResponseCancellationContext, type EmbeddedEditorLocation, type EmbeddedEditorLocationMetadata, type EmbeddedEditorLocationSetValue, type EmbeddedEditorLocationValue, type FunctionCallResponse, type FunctionCallSystemParameter, type GetDataResourceLocation, type GetDataResourceMessage, IntegrationDefinitionClient, type IntegrationDefinitionDeleteParameters, type IntegrationDefinitionGetParameters, type IntegrationDefinitionGetResponse, type IntegrationDefinitionPutParameters, type IntegrationDefinitionPutResponse, IntegrationInstallationClient, type IntegrationInstallationDeleteParameters, type IntegrationInstallationGetParameters, type IntegrationInstallationGetResponse, type IntegrationInstallationPutParameters, type LocationDialogResponse, type MeshContextData, type MeshLocation, type MeshLocationCore, type MeshLocationTypes, type MeshLocationUserPermissions, type MeshSDKEventInterface, type OpenConfirmationDialogOptions, type OpenConfirmationDialogResult, type OpenDialogMessage, type OpenDialogResult, type OpenLocationDialogOptions, type ParamTypeConfigLocation, type ParamTypeConfigLocationMetadata, type ParamTypeLocation, type ParamTypeLocationMetadata, type PersonalizationCriteriaLocation, type PersonalizationCriteriaLocationMetadata, type PromptSettingsLocationMetadata, type SdkWindow, type SetLocationFunction, type SetValueMessage, type SetValueOptions, type SettingsLocation, type SettingsLocationMetadata, type UniformMeshSDK, type UniformMeshSDKEvents, type UniformUser, type ValidationResult, functionCallSystemParameters, hasPermissions, hasRole, initializeUniformMeshSDK, parseFunctionCall };
+export { type AIGenerateLocation, type AIGenerateLocationMetadata, type AIPromptMetadataLocation, type AssetLibraryLocation, type AssetLibraryLocationMetadata, type AssetParameterLocation, type AssetParameterLocationMetadata, type BindableTypes, type CSSHeight, type CanvasEditorEntityType, type CanvasEditorToolsData, type CanvasEditorToolsLocation, type CanvasEditorToolsLocationMetadata, type CloseDialogMessage, type CloseLocationDialogOptions, type CommonMetadata, type DataConnectorInfo, type DataResourceLocation, type DataResourceLocationMetadata, type DataSourceLocation, type DataSourceLocationMetadata, type DataSourceLocationValue, type DataTypeLocation, type DataTypeLocationMetadata, type DataTypeLocationValue, type DialogContext, type DialogOptions, type DialogParamValue, type DialogParams, type DialogResponseData, type DialogResponseHandler, type DialogResponseHandlers, type DialogType, type DynamicInput, type DynamicInputs, type EditConnectedDataMessage, type EditConnectedDataResponse, type EditConnectedDataResponseCancellationContext, type EmbeddedEditorLocation, type EmbeddedEditorLocationMetadata, type EmbeddedEditorLocationSetValue, type EmbeddedEditorLocationValue, type FunctionCallResponse, type FunctionCallSystemParameter, type GetDataResourceLocation, type GetDataResourceMessage, IntegrationDefinitionClient, type IntegrationDefinitionDeleteParameters, type IntegrationDefinitionGetParameters, type IntegrationDefinitionGetResponse, type IntegrationDefinitionPutParameters, type IntegrationDefinitionPutResponse, IntegrationInstallationClient, type IntegrationInstallationDeleteParameters, type IntegrationInstallationGetParameters, type IntegrationInstallationGetResponse, type IntegrationInstallationPutParameters, type LocationDialogResponse, type MeshContextData, type MeshLocation, type MeshLocationCore, type MeshLocationTypes, type MeshLocationUserPermissions, type MeshRouter, type MeshSDKEventInterface, type NavigateMessage, type OpenConfirmationDialogOptions, type OpenConfirmationDialogResult, type OpenDialogMessage, type OpenDialogResult, type OpenLocationDialogOptions, type ParamTypeConfigLocation, type ParamTypeConfigLocationMetadata, type ParamTypeLocation, type ParamTypeLocationMetadata, type PersonalizationCriteriaLocation, type PersonalizationCriteriaLocationMetadata, type PromptSettingsLocationMetadata, type SdkWindow, type SetLocationFunction, type SetValueMessage, type SetValueOptions, type SettingsLocation, type SettingsLocationMetadata, type ToolLocation, type ToolLocationMetadata, type UniformMeshSDK, type UniformMeshSDKEvents, type UniformUser, type ValidationResult, functionCallSystemParameters, hasPermissions, hasRole, initializeUniformMeshSDK, parseFunctionCall };

package/dist/index.esm.js

@@ -131,7 +131,7 @@ var getLogger = (prefix, debug) => {
 };
 
 // src/temp/version.ts
-var UNIFORM_MESH_SDK_VERSION = "20.9.0";
+var UNIFORM_MESH_SDK_VERSION = "20.14.0";
 
 // src/framepost/constants.ts
 var DEFAULT_REQUEST_TIMEOUT = 5e3;
@@ -518,6 +518,12 @@ async function connectToParent({
           timeout: 3e4
         });
       },
+      navigate: async (message) => {
+        await client.request("navigate", message);
+      },
+      reloadLocation: async () => {
+        await client.request("reload");
+      },
       editConnectedData: async (message) => {
         return await client.request(
           "editConnectedData",
@@ -702,6 +708,10 @@ async function initializeUniformMeshSDK({
       getCurrentLocation: () => {
         const location = {
           getDataResource: parent.getDataResource,
+          router: {
+            navigatePlatform: (path, options) => parent.navigate({ path, options })
+            // reloadLocation: parent.reloadLocation,
+          },
           editConnectedData,
           type: contextData.locationType,
           isReadOnly: contextData.isReadOnly,
@@ -732,7 +742,10 @@ async function initializeUniformMeshSDK({
         // then we disable autoResizing for the dialog location.
         // Otherwise, autoResizing will likely "overwrite" the specified `contentHeight` value, making
         // developers very sad and confused. No one wants a sad and confused developer.
-        autoResizingDisabled: ((_a = contextData.dialogContext) == null ? void 0 : _a.contentHeight) ? true : autoResizingDisabled
+        // Another case for explicit autoResizingDisabled flag is Full Screen Height from the parent (e.g. asset library location),
+        // so by default it will be stretch to the maximum height of the parent.
+        // Can still be manually enabled by calling sdk.currentWindow?.enableAutoResizing() in mesh app.
+        autoResizingDisabled: ((_a = contextData.dialogContext) == null ? void 0 : _a.contentHeight) || contextData.fullScreenHeight ? true : autoResizingDisabled
       }),
       version: contextData.uniformApiVersion,
       openLocationDialog: async ({

package/dist/index.js

@@ -172,7 +172,7 @@ var getLogger = (prefix, debug) => {
 };
 
 // src/temp/version.ts
-var UNIFORM_MESH_SDK_VERSION = "20.9.0";
+var UNIFORM_MESH_SDK_VERSION = "20.14.0";
 
 // src/framepost/constants.ts
 var DEFAULT_REQUEST_TIMEOUT = 5e3;
@@ -559,6 +559,12 @@ async function connectToParent({
           timeout: 3e4
         });
       },
+      navigate: async (message) => {
+        await client.request("navigate", message);
+      },
+      reloadLocation: async () => {
+        await client.request("reload");
+      },
       editConnectedData: async (message) => {
         return await client.request(
           "editConnectedData",
@@ -743,6 +749,10 @@ async function initializeUniformMeshSDK({
       getCurrentLocation: () => {
         const location = {
           getDataResource: parent.getDataResource,
+          router: {
+            navigatePlatform: (path, options) => parent.navigate({ path, options })
+            // reloadLocation: parent.reloadLocation,
+          },
           editConnectedData,
           type: contextData.locationType,
           isReadOnly: contextData.isReadOnly,
@@ -773,7 +783,10 @@ async function initializeUniformMeshSDK({
         // then we disable autoResizing for the dialog location.
         // Otherwise, autoResizing will likely "overwrite" the specified `contentHeight` value, making
         // developers very sad and confused. No one wants a sad and confused developer.
-        autoResizingDisabled: ((_a = contextData.dialogContext) == null ? void 0 : _a.contentHeight) ? true : autoResizingDisabled
+        // Another case for explicit autoResizingDisabled flag is Full Screen Height from the parent (e.g. asset library location),
+        // so by default it will be stretch to the maximum height of the parent.
+        // Can still be manually enabled by calling sdk.currentWindow?.enableAutoResizing() in mesh app.
+        autoResizingDisabled: ((_a = contextData.dialogContext) == null ? void 0 : _a.contentHeight) || contextData.fullScreenHeight ? true : autoResizingDisabled
       }),
       version: contextData.uniformApiVersion,
       openLocationDialog: async ({

package/dist/index.mjs

@@ -131,7 +131,7 @@ var getLogger = (prefix, debug) => {
 };
 
 // src/temp/version.ts
-var UNIFORM_MESH_SDK_VERSION = "20.9.0";
+var UNIFORM_MESH_SDK_VERSION = "20.14.0";
 
 // src/framepost/constants.ts
 var DEFAULT_REQUEST_TIMEOUT = 5e3;
@@ -518,6 +518,12 @@ async function connectToParent({
           timeout: 3e4
         });
       },
+      navigate: async (message) => {
+        await client.request("navigate", message);
+      },
+      reloadLocation: async () => {
+        await client.request("reload");
+      },
       editConnectedData: async (message) => {
         return await client.request(
           "editConnectedData",
@@ -702,6 +708,10 @@ async function initializeUniformMeshSDK({
       getCurrentLocation: () => {
         const location = {
           getDataResource: parent.getDataResource,
+          router: {
+            navigatePlatform: (path, options) => parent.navigate({ path, options })
+            // reloadLocation: parent.reloadLocation,
+          },
           editConnectedData,
           type: contextData.locationType,
           isReadOnly: contextData.isReadOnly,
@@ -732,7 +742,10 @@ async function initializeUniformMeshSDK({
         // then we disable autoResizing for the dialog location.
         // Otherwise, autoResizing will likely "overwrite" the specified `contentHeight` value, making
         // developers very sad and confused. No one wants a sad and confused developer.
-        autoResizingDisabled: ((_a = contextData.dialogContext) == null ? void 0 : _a.contentHeight) ? true : autoResizingDisabled
+        // Another case for explicit autoResizingDisabled flag is Full Screen Height from the parent (e.g. asset library location),
+        // so by default it will be stretch to the maximum height of the parent.
+        // Can still be manually enabled by calling sdk.currentWindow?.enableAutoResizing() in mesh app.
+        autoResizingDisabled: ((_a = contextData.dialogContext) == null ? void 0 : _a.contentHeight) || contextData.fullScreenHeight ? true : autoResizingDisabled
       }),
       version: contextData.uniformApiVersion,
       openLocationDialog: async ({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/mesh-sdk",
-  "version": "20.7.1-alpha.26+03c49728b3",
+  "version": "20.7.1-alpha.32+616e77445e",
   "description": "Uniform Mesh Framework SDK",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -25,7 +25,7 @@
     "lint": "eslint \"src/**/*.{js,ts,tsx}\"",
     "format": "prettier --write \"src/**/*.{js,ts,tsx}\"",
     "update-openapi": "tsx ./scripts/update-openapi.cts",
-    "document": "api-extractor run --local"
+    "document:prebuild": "api-extractor run --local"
   },
   "files": [
     "/dist"
@@ -34,16 +34,16 @@
     "access": "public"
   },
   "dependencies": {
-    "@uniformdev/assets": "20.7.1-alpha.26+03c49728b3",
-    "@uniformdev/canvas": "20.7.1-alpha.26+03c49728b3",
-    "@uniformdev/context": "20.7.1-alpha.26+03c49728b3",
-    "@uniformdev/project-map": "20.7.1-alpha.26+03c49728b3",
+    "@uniformdev/assets": "20.7.1-alpha.32+616e77445e",
+    "@uniformdev/canvas": "20.7.1-alpha.32+616e77445e",
+    "@uniformdev/context": "20.7.1-alpha.32+616e77445e",
+    "@uniformdev/project-map": "20.7.1-alpha.32+616e77445e",
     "imagesloaded": "^5.0.0",
     "mitt": "^3.0.1"
   },
   "devDependencies": {
     "@types/imagesloaded": "^4.1.2",
-    "openai": "^4.58.2"
+    "openai": "4.94.0"
   },
-  "gitHead": "03c49728b3fb82b57e64265bde2f950f12ee7cb6"
+  "gitHead": "616e77445e7f75fca783616a70b359a2fb7bdfab"
 }