@uniformdev/mesh-sdk 19.35.2 → 19.36.0

package/dist/index.d.mts

@@ -0,0 +1,993 @@
+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';
+
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+interface paths$1 {
+    "/api/v1/integration-definitions": {
+        /** Gets a list of Mesh apps that are available for a Uniform team */
+        get: {
+            parameters: {
+                query: {
+                    teamId: string;
+                    includePublic?: boolean | null;
+                    teamSpecificType?: boolean | null;
+                };
+            };
+            responses: {
+                /** 200 response */
+                200: {
+                    content: {
+                        "application/json": {
+                            results: {
+                                type: string;
+                                displayName: string;
+                                logoIconUrl?: string;
+                                badgeIconUrl?: string;
+                                /** @enum {string} */
+                                category?: "analytics" | "cdn" | "classic" | "commerce" | "content" | "comingSoon" | "data" | "deprecated" | "email" | "framework" | "search" | "starters" | "uniform" | "unknown";
+                                public?: boolean;
+                                baseLocationUrl?: string;
+                                locations: {
+                                    install?: {
+                                        description?: string[];
+                                        informationUrl?: string;
+                                        canvasPackageUrl?: string;
+                                    };
+                                    settings?: {
+                                        url: string;
+                                        locations?: {
+                                            [key: string]: {
+                                                url: string;
+                                            };
+                                        };
+                                    };
+                                    canvas?: {
+                                        parameterTypes: {
+                                            type: string;
+                                            displayName: string;
+                                            configureUrl?: string;
+                                            editorUrl: string;
+                                            configurationLocations?: {
+                                                [key: string]: {
+                                                    url: string;
+                                                };
+                                            };
+                                            editorLocations?: {
+                                                [key: string]: {
+                                                    url: string;
+                                                };
+                                            };
+                                            renderableInPropertyPanel?: boolean;
+                                        }[];
+                                    };
+                                    dataConnectors?: {
+                                        type: string;
+                                        displayName: string;
+                                        dataSourceEditorUrl?: string;
+                                        dataSourceEditorLocations?: {
+                                            [key: string]: {
+                                                url: string;
+                                            };
+                                        };
+                                        dataArchetypes?: {
+                                            [key: string]: {
+                                                displayName: string;
+                                                typeEditorUrl?: string;
+                                                typeEditorLocations?: {
+                                                    [key: string]: {
+                                                        url: string;
+                                                    };
+                                                };
+                                                dataEditorUrl?: string;
+                                                dataEditorUrlLocations?: {
+                                                    [key: string]: {
+                                                        url: string;
+                                                    };
+                                                };
+                                            };
+                                        };
+                                        badgeIconUrl?: string;
+                                    }[];
+                                };
+                            }[];
+                        };
+                    };
+                };
+                400: external$1["swagger.yml"]["components"]["responses"]["BadRequestError"];
+                401: external$1["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
+                403: external$1["swagger.yml"]["components"]["responses"]["ForbiddenError"];
+                429: external$1["swagger.yml"]["components"]["responses"]["RateLimitError"];
+                500: external$1["swagger.yml"]["components"]["responses"]["InternalServerError"];
+            };
+        };
+        /** Creates or updates a Mesh app definition on a team */
+        put: {
+            responses: {
+                /** Update success */
+                200: {
+                    content: {
+                        "application/json": {
+                            type: string;
+                            displayName: string;
+                            logoIconUrl?: string;
+                            badgeIconUrl?: string;
+                            /** @enum {string} */
+                            category?: "analytics" | "cdn" | "classic" | "commerce" | "content" | "comingSoon" | "data" | "deprecated" | "email" | "framework" | "search" | "starters" | "uniform" | "unknown";
+                            public?: boolean;
+                            baseLocationUrl?: string;
+                            locations: {
+                                install?: {
+                                    description?: string[];
+                                    informationUrl?: string;
+                                    canvasPackageUrl?: string;
+                                };
+                                settings?: {
+                                    url: string;
+                                    locations?: {
+                                        [key: string]: {
+                                            url: string;
+                                        };
+                                    };
+                                };
+                                canvas?: {
+                                    parameterTypes: {
+                                        type: string;
+                                        displayName: string;
+                                        configureUrl?: string;
+                                        editorUrl: string;
+                                        configurationLocations?: {
+                                            [key: string]: {
+                                                url: string;
+                                            };
+                                        };
+                                        editorLocations?: {
+                                            [key: string]: {
+                                                url: string;
+                                            };
+                                        };
+                                        renderableInPropertyPanel?: boolean;
+                                    }[];
+                                };
+                                dataConnectors?: {
+                                    type: string;
+                                    displayName: string;
+                                    dataSourceEditorUrl?: string;
+                                    dataSourceEditorLocations?: {
+                                        [key: string]: {
+                                            url: string;
+                                        };
+                                    };
+                                    dataArchetypes?: {
+                                        [key: string]: {
+                                            displayName: string;
+                                            typeEditorUrl?: string;
+                                            typeEditorLocations?: {
+                                                [key: string]: {
+                                                    url: string;
+                                                };
+                                            };
+                                            dataEditorUrl?: string;
+                                            dataEditorUrlLocations?: {
+                                                [key: string]: {
+                                                    url: string;
+                                                };
+                                            };
+                                        };
+                                    };
+                                    badgeIconUrl?: string;
+                                }[];
+                            };
+                        };
+                    };
+                };
+                400: external$1["swagger.yml"]["components"]["responses"]["BadRequestError"];
+                401: external$1["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
+                403: external$1["swagger.yml"]["components"]["responses"]["ForbiddenError"];
+                429: external$1["swagger.yml"]["components"]["responses"]["RateLimitError"];
+                500: external$1["swagger.yml"]["components"]["responses"]["InternalServerError"];
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        /**
+                         * Format: uuid
+                         * @description The team ID
+                         */
+                        teamId: string;
+                        data: {
+                            type: string;
+                            displayName: string;
+                            logoIconUrl?: string;
+                            badgeIconUrl?: string;
+                            /** @enum {string} */
+                            category?: "analytics" | "cdn" | "classic" | "commerce" | "content" | "comingSoon" | "data" | "deprecated" | "email" | "framework" | "search" | "starters" | "uniform" | "unknown";
+                            baseLocationUrl?: string;
+                            locations: {
+                                install?: {
+                                    description?: string[];
+                                    informationUrl?: string;
+                                    canvasPackageUrl?: string;
+                                };
+                                settings?: {
+                                    url: string;
+                                    locations?: {
+                                        [key: string]: {
+                                            url: string;
+                                        };
+                                    };
+                                };
+                                canvas?: {
+                                    parameterTypes: {
+                                        type: string;
+                                        displayName: string;
+                                        configureUrl?: string;
+                                        editorUrl: string;
+                                        configurationLocations?: {
+                                            [key: string]: {
+                                                url: string;
+                                            };
+                                        };
+                                        editorLocations?: {
+                                            [key: string]: {
+                                                url: string;
+                                            };
+                                        };
+                                        renderableInPropertyPanel?: boolean;
+                                    }[];
+                                };
+                                dataConnectors?: {
+                                    type: string;
+                                    displayName: string;
+                                    dataSourceEditorUrl?: string;
+                                    dataSourceEditorLocations?: {
+                                        [key: string]: {
+                                            url: string;
+                                        };
+                                    };
+                                    dataArchetypes?: {
+                                        [key: string]: {
+                                            displayName: string;
+                                            typeEditorUrl?: string;
+                                            typeEditorLocations?: {
+                                                [key: string]: {
+                                                    url: string;
+                                                };
+                                            };
+                                            dataEditorUrl?: string;
+                                            dataEditorUrlLocations?: {
+                                                [key: string]: {
+                                                    url: string;
+                                                };
+                                            };
+                                        };
+                                    };
+                                    badgeIconUrl?: string;
+                                }[];
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        /** Removes a Mesh app definition from a team. Note that public integrations may not be deleted without contacting Uniform. */
+        delete: {
+            responses: {
+                /** Delete successful */
+                204: never;
+                400: external$1["swagger.yml"]["components"]["responses"]["BadRequestError"];
+                401: external$1["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
+                403: external$1["swagger.yml"]["components"]["responses"]["ForbiddenError"];
+                /** Integration to delete was not found */
+                404: unknown;
+                429: external$1["swagger.yml"]["components"]["responses"]["RateLimitError"];
+                500: external$1["swagger.yml"]["components"]["responses"]["InternalServerError"];
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        /**
+                         * Format: uuid
+                         * @description The team ID
+                         */
+                        teamId: string;
+                        /** @description The integration type to remove */
+                        type: string;
+                    };
+                };
+            };
+        };
+        /** Handles preflight requests. This endpoint allows CORS. */
+        options: {
+            responses: {
+                /** ok */
+                204: never;
+            };
+        };
+    };
+}
+interface external$1 {
+    "swagger.yml": {
+        paths: {};
+        components: {
+            schemas: {
+                Error: {
+                    /** @description Error message(s) that occurred while processing the request */
+                    errorMessage?: string[] | string;
+                };
+            };
+            responses: {
+                /** Request input validation failed */
+                BadRequestError: {
+                    content: {
+                        "application/json": external$1["swagger.yml"]["components"]["schemas"]["Error"];
+                    };
+                };
+                /** API key or token was not valid */
+                UnauthorizedError: {
+                    content: {
+                        "application/json": external$1["swagger.yml"]["components"]["schemas"]["Error"];
+                    };
+                };
+                /** Permission was denied */
+                ForbiddenError: {
+                    content: {
+                        "application/json": external$1["swagger.yml"]["components"]["schemas"]["Error"];
+                    };
+                };
+                /** Resource not found */
+                NotFoundError: {
+                    content: {
+                        "application/json": external$1["swagger.yml"]["components"]["schemas"]["Error"];
+                    };
+                };
+                /** Too many requests in allowed time period */
+                RateLimitError: unknown;
+                /** Execution error occurred */
+                InternalServerError: unknown;
+            };
+        };
+        operations: {};
+    };
+}
+
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+interface paths {
+    "/api/v1/integration-installations": {
+        /** Gets a list of installed integrations for a Uniform Project */
+        get: {
+            parameters: {
+                query: {
+                    projectId: string;
+                    type?: string;
+                    exactType?: boolean | null;
+                    teamSpecificType?: boolean | null;
+                };
+            };
+            responses: {
+                /** 200 response */
+                200: {
+                    content: {
+                        "application/json": {
+                            results: {
+                                type: string;
+                                data?: {
+                                    [key: string]: unknown;
+                                };
+                            }[];
+                        };
+                    };
+                };
+                400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
+                401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
+                403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
+                429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
+                500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
+            };
+        };
+        /** Installs or updates an integration on a Uniform Project. If data is not provided, it will remain unmodified from any existing value. */
+        put: {
+            responses: {
+                /** Install or update success */
+                204: never;
+                400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
+                401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
+                403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
+                429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
+                500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        /**
+                         * Format: uuid
+                         * @description The project ID
+                         */
+                        projectId: string;
+                        /** @description Whether to match the passed type exactly or to treat the type as a prefix */
+                        exactType?: boolean | null;
+                        type: string;
+                        data?: {
+                            [key: string]: unknown;
+                        };
+                    };
+                };
+            };
+        };
+        /** Removes an integration from a project. */
+        delete: {
+            responses: {
+                /** Delete successful */
+                204: never;
+                400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
+                401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
+                403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
+                /** Integration to delete was not found */
+                404: unknown;
+                429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
+                500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        /**
+                         * Format: uuid
+                         * @description The project ID
+                         */
+                        projectId: string;
+                        /** @description The integration type to remove */
+                        type: string;
+                        /** @description Whether to match the passed type exactly or to treat the type as a prefix */
+                        exactType?: boolean | null;
+                    };
+                };
+            };
+        };
+        /** Handles preflight requests. This endpoint allows CORS. */
+        options: {
+            responses: {
+                /** ok */
+                204: never;
+            };
+        };
+    };
+}
+interface external {
+    "swagger.yml": {
+        paths: {};
+        components: {
+            schemas: {
+                Error: {
+                    /** @description Error message(s) that occurred while processing the request */
+                    errorMessage?: string[] | string;
+                };
+            };
+            responses: {
+                /** Request input validation failed */
+                BadRequestError: {
+                    content: {
+                        "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
+                    };
+                };
+                /** API key or token was not valid */
+                UnauthorizedError: {
+                    content: {
+                        "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
+                    };
+                };
+                /** Permission was denied */
+                ForbiddenError: {
+                    content: {
+                        "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
+                    };
+                };
+                /** Resource not found */
+                NotFoundError: {
+                    content: {
+                        "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
+                    };
+                };
+                /** Too many requests in allowed time period */
+                RateLimitError: unknown;
+                /** Execution error occurred */
+                InternalServerError: unknown;
+            };
+        };
+        operations: {};
+    };
+}
+
+type IntegrationDefinitionsApi = paths$1['/api/v1/integration-definitions'];
+type IntegrationInstallationsApi = paths['/api/v1/integration-installations'];
+/** Query parameter options for GET /api/v1/integration-definitions */
+type IntegrationDefinitionGetParameters = IntegrationDefinitionsApi['get']['parameters']['query'];
+/** The GET response from /api/v1/integration-definitions */
+type IntegrationDefinitionGetResponse = IntegrationDefinitionsApi['get']['responses']['200']['content']['application/json'];
+/** The PUT body for /api/v1/integration-definitions */
+type IntegrationDefinitionPutParameters = IntegrationDefinitionsApi['put']['requestBody']['content']['application/json'];
+/** The PUT response body for /api/v1/integration-definitions (has team-specific integration type) */
+type IntegrationDefinitionPutResponse = IntegrationDefinitionsApi['put']['responses']['200']['content']['application/json'];
+/** The DELETE body for /api/v1/integration-definitions */
+type IntegrationDefinitionDeleteParameters = IntegrationDefinitionsApi['delete']['requestBody']['content']['application/json'];
+/** Query parameter options for GET /api/v1/integration-installations */
+type IntegrationInstallationGetParameters = IntegrationInstallationsApi['get']['parameters']['query'];
+/** The GET response from /api/v1/integration-installations */
+type IntegrationInstallationGetResponse = IntegrationInstallationsApi['get']['responses']['200']['content']['application/json'];
+/** The PUT body for /api/v1/integration-installations */
+type IntegrationInstallationPutParameters = IntegrationInstallationsApi['put']['requestBody']['content']['application/json'];
+/** The DELETE body for /api/v1/integration-installations */
+type IntegrationInstallationDeleteParameters = IntegrationInstallationsApi['delete']['requestBody']['content']['application/json'];
+
+type DefClientOptions = Omit<ClientOptions, 'apiKey' | 'projectId'> & {
+    teamId: string;
+};
+/** API Client to manage the registration of custom Mesh applications */
+declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
+    #private;
+    constructor(options: DefClientOptions);
+    /** Fetches all mesh apps for a team (and optionally also those shared across teams) */
+    get(options?: Omit<IntegrationDefinitionGetParameters, 'teamId'>): Promise<IntegrationDefinitionGetResponse>;
+    /** Creates or updates a mesh app definition on a team */
+    upsert(body: Omit<IntegrationDefinitionPutParameters, 'teamId'>): Promise<{
+        type: string;
+        displayName: string;
+        logoIconUrl?: string | undefined;
+        badgeIconUrl?: string | undefined;
+        category?: "analytics" | "cdn" | "classic" | "commerce" | "content" | "comingSoon" | "data" | "deprecated" | "email" | "framework" | "search" | "starters" | "uniform" | "unknown" | undefined;
+        public?: boolean | undefined;
+        baseLocationUrl?: string | undefined;
+        locations: {
+            install?: {
+                description?: string[] | undefined;
+                informationUrl?: string | undefined;
+                canvasPackageUrl?: string | undefined;
+            } | undefined;
+            settings?: {
+                url: string;
+                locations?: {
+                    [key: string]: {
+                        url: string;
+                    };
+                } | undefined;
+            } | undefined;
+            canvas?: {
+                parameterTypes: {
+                    type: string;
+                    displayName: string;
+                    configureUrl?: string | undefined;
+                    editorUrl: string;
+                    configurationLocations?: {
+                        [key: string]: {
+                            url: string;
+                        };
+                    } | undefined;
+                    editorLocations?: {
+                        [key: string]: {
+                            url: string;
+                        };
+                    } | undefined;
+                    renderableInPropertyPanel?: boolean | undefined;
+                }[];
+            } | undefined;
+            dataConnectors?: {
+                type: string;
+                displayName: string;
+                dataSourceEditorUrl?: string | undefined;
+                dataSourceEditorLocations?: {
+                    [key: string]: {
+                        url: string;
+                    };
+                } | undefined;
+                dataArchetypes?: {
+                    [key: string]: {
+                        displayName: string;
+                        typeEditorUrl?: string | undefined;
+                        typeEditorLocations?: {
+                            [key: string]: {
+                                url: string;
+                            };
+                        } | undefined;
+                        dataEditorUrl?: string | undefined;
+                        dataEditorUrlLocations?: {
+                            [key: string]: {
+                                url: string;
+                            };
+                        } | undefined;
+                    };
+                } | undefined;
+                badgeIconUrl?: string | undefined;
+            }[] | undefined;
+        };
+    }>;
+    /** Deletes a mesh app from a team */
+    remove(body: Omit<IntegrationDefinitionDeleteParameters, 'teamId'>): Promise<void>;
+}
+
+/** API Client to manage the registration of custom Mesh applications */
+declare class IntegrationInstallationClient extends ApiClient {
+    #private;
+    constructor(options: Omit<ClientOptions, 'apiKey'>);
+    /** Fetches all IntegrationInstallations for a project */
+    get(options?: ExceptProject<Omit<IntegrationInstallationGetParameters, 'type'>>): Promise<IntegrationInstallationGetResponse>;
+    /** Fetches all IntegrationInstallations for a project */
+    getOne(options?: ExceptProject<IntegrationInstallationGetParameters & {
+        type: string;
+    }>): Promise<IntegrationInstallationGetResponse['results'][0] | undefined>;
+    /** Updates or creates (based on id) a IntegrationInstallation */
+    upsert(body: ExceptProject<IntegrationInstallationPutParameters>): Promise<void>;
+    /** Deletes a IntegrationInstallation */
+    remove(body: ExceptProject<IntegrationInstallationDeleteParameters>): Promise<void>;
+}
+
+type DataSourceLocationValue = Pick<DataSource, 'baseUrl' | 'custom' | 'headers' | 'parameters' | 'variables'>;
+type DataSourceLocationMetadata<TIntegrationConfiguration = unknown> = {
+    /** Settings defined at the integration level (arbitrary type used on settings location) */
+    settings: TIntegrationConfiguration;
+    /** The Uniform project ID */
+    projectId: string;
+};
+type DataSourceLocation = MeshLocationCore<DataSourceLocationValue, DataSourceLocationMetadata, DataSourceLocationValue, 'dataSource'>;
+
+type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfiguration = unknown> = {
+    rootNode: Omit<RootComponentInstance, 'slots' | '_data'>;
+    parameterConfiguration: TParamConfiguration;
+    component: Omit<ComponentInstance, 'slots'>;
+    componentDefinitions: Record<string, ComponentDefinition | undefined>;
+    parameterDefinition: ComponentDefinitionParameter;
+    /** Settings defined at the integration level (arbitrary type used on settings location) */
+    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 SettingsLocationMetadata = {
+    projectId: string;
+};
+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> | DataSourceLocation | DataTypeLocation | DataResourceLocation;
+interface MeshContextData {
+    locationKey: string;
+    locationType: MeshLocationTypes;
+    isReadOnly: boolean;
+    locationValue: any;
+    locationMetadata: any;
+    uniformApiVersion: string;
+    dialogContext?: DialogContext;
+}
+interface DialogContext {
+    dialogId: string;
+    dialogLocation?: string;
+    contentHeight?: CSSHeight;
+}
+interface DialogResponseHandlers {
+    [dialogId: string]: DialogResponseHandler;
+}
+interface DialogResponseHandler {
+    resolve: (value: Pick<DialogResponseData, 'value' | 'dialogId'>) => void;
+    reject: (reason?: unknown) => void;
+}
+interface DialogResponseData {
+    value?: unknown;
+    dialogId: string;
+    error?: string;
+}
+type DialogType = 'location' | 'confirm';
+type OpenDialogResult = {
+    /** Unique ID of this dialog which can be used to close it */
+    dialogId: string;
+    /**
+     * For custom location based dialogs, this is the name of the location from the Mesh app manifest.
+     * e.g. if you define a dialog location in the manifestunder locations.settings.locations.fooFooFoo,
+     * this would be 'fooFooFoo'
+     */
+    dialogLocation?: string;
+};
+interface DialogOptions<TDialogParams = DialogParams> {
+    /**
+     * By default, dialogs will be closed when they set a value.
+     * You can disable this behavior by setting the `disableCloseDialogOnSetValue`
+     * property to true.
+     * You'll still be able to close a dialog via the `closeDialog` method
+     * that is returned from the `openLocationDialog` method.
+     */
+    disableCloseDialogOnSetValue?: boolean;
+    /**
+     * Options for setting the max width of the dialog.
+     */
+    maxWidth?: 'xs' | 'sm' | 'md' | 'lg' | 'xl' | '2xl' | '3xl' | '4xl' | '5xl' | '6xl' | 'full';
+    /**
+     * Parameters to pass to the dialog, which will be available in the dialog via
+     * the `metadata` object for the dialog location, e.g. `metadata.dialogParams`.
+     * Parameters should be simple (serializable) types, not functions or DOM
+     * elements or similar non-serializable objects.
+     */
+    params?: TDialogParams;
+    /**
+     * Allows you to specify the height of the dialog content upon open. Note: the
+     * dialog itself will always be full height to match the Uniform dashboard UI.
+     * However, the content container within the dialog is, by default, auto-sized to
+     * the calculated height of the rendered content of the dialog.
+     * Setting the `contentHeight` option disables auto-sizing and allows you to specify
+     * your own height for the dialog content.
+     * `contentHeight` option can be specific lengths, e.g. 100vh, 500px, etc... as
+     * well as other standard CSS height options.
+     */
+    contentHeight?: CSSHeight;
+}
+type DialogParamValue = string | number | boolean | null | DialogParamValue[] | {
+    [key: string]: DialogParamValue;
+};
+type DialogParams = {
+    [paramName: string]: DialogParamValue;
+};
+type CSSHeight = '-moz-initial' | 'inherit' | 'initial' | 'revert' | 'unset' | '-moz-max-content' | '-moz-min-content' | '-webkit-fit-content' | 'auto' | 'fit-content' | 'max-content' | 'min-content' | `${number}${'px' | 'em' | 'rem' | 'vh'}`;
+type ValidationResult = {
+    isValid: false;
+    validationMessage: string;
+} | {
+    isValid: true;
+};
+type OpenDialogMessage = {
+    dialogType: DialogType;
+    dialogData: unknown;
+    options?: DialogOptions;
+};
+type CloseDialogMessage = {
+    dialogId: string | undefined;
+    dialogType: DialogType;
+    dialogData?: unknown;
+};
+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, onMetadataUpdated, }: {
+    dialogResponseHandlers: DialogResponseHandlers;
+    onMetadataUpdated: (metadata: unknown) => void;
+}): Promise<{
+    initData: MeshContextData;
+    parent: {
+        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>;
+    };
+}>;
+
+type SetLocationFunction<TSetValue> = (value: TSetValue, options?: SetValueOptions) => Promise<void> | void;
+/** 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;
+    /** 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: SetLocationFunction<TSetValue>;
+    /**
+     * 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;
+    /**
+     * 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
+ */
+type MeshLocationTypes = 'paramType' | 'paramTypeConfig' | 'settings' | 'dataSource' | 'dataType' | 'dataResource';
+type SetValueOptions = ValidationResult;
+type SetValueMessage = {
+    uniformMeshLocationValue: unknown;
+    options?: SetValueOptions;
+};
+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 = {
+    type: string;
+    displayName: string;
+};
+type DataTypeLocationMetadata<TIntegrationConfiguration = unknown> = {
+    /** Settings defined at the integration level (arbitrary type used on settings location) */
+    settings: TIntegrationConfiguration;
+    /** The Uniform project ID */
+    projectId: string;
+    /**
+     * The current data type's data source. NOTE: param and header values are not available in this context.
+     */
+    dataSource: DataSource;
+    /** The data connector type of the current data type's data source */
+    dataConnector: DataConnectorInfo;
+    /** The data type's archetype value. */
+    archetype: string;
+};
+type DataTypeLocation = MeshLocationCore<DataTypeLocationValue, DataTypeLocationMetadata, DataTypeLocationValue, 'dataType'> & GetDataResourceLocation;
+
+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;
+    /** The data type's archetype value. */
+    archetype: string;
+    /**
+     * The current data resource's data source. NOTE: param and header values are not available in this context.
+     */
+    dataSource: DataSource;
+    /** The data connector type of the current data resource's data source */
+    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;
+
+type ParamTypeConfigLocationMetadata<TIntegrationConfiguration = unknown> = {
+    /** Settings defined at the integration level (arbitrary type used on settings location) */
+    settings: TIntegrationConfiguration;
+    /** The Uniform project ID */
+    projectId: string;
+    componentDefinition: ComponentDefinition;
+};
+type ParamTypeConfigLocation<TParamValue = unknown, TIntegrationConfiguration = unknown> = MeshLocationCore<TParamValue | undefined, ParamTypeConfigLocationMetadata<TIntegrationConfiguration>, TParamValue, 'paramTypeConfig'>;
+
+interface SdkWindow {
+    /** The current window object. */
+    instance: Window;
+    /** The numerical height of the current window. */
+    height: number;
+    /** The MutationObserver object used to detect content height changes.
+     * Note: this property is only defined if `enableAutoResizing` is true. */
+    observer?: MutationObserver;
+    /** Enables auto-resizing of the window (iframe) based on the size of the content. */
+    enableAutoResizing: () => void;
+    /** Disables auto-resizing of the window (iframe) based on the size of the content. */
+    disableAutoResizing: () => void;
+    /** `height` argument can be specific lengths, e.g. 100vh, 300px, etc...
+     * as well as other standard CSS height options */
+    updateHeight: (height: CSSHeight) => void;
+}
+
+type OpenLocationDialogOptions<TDialogParams> = {
+    /**
+     * Name of the location key in the Mesh App definition (stored on uniform.app) to open in a dialog.
+     * For example if the current location is integration settings, this would be an object key on:
+     * locations.settings.locations.<thisKey>
+     * and the URL to the dialog would be in
+     * locations.settings.locations.<thisKey>.url.
+     */
+    locationKey: string;
+    options?: DialogOptions<TDialogParams>;
+};
+type OpenConfirmationDialogOptions = {
+    titleText: string;
+    bodyText: string;
+    options?: Omit<DialogOptions<void>, 'disableCloseDialogOnSetValue' | 'params'>;
+};
+type OpenConfirmationDialogResult = {
+    value: 'confirm' | 'cancel';
+    closeDialog: () => Promise<void>;
+};
+type CloseLocationDialogOptions = {
+    /** Id of the dialog to close. If no dialog with the given id exists, nothing will happen. */
+    dialogId: string;
+};
+interface LocationDialogResponse<TDialogValue> {
+    /** Generated id for the dialog. */
+    dialogId: string;
+    /** The value set by the dialog. */
+    value: TDialogValue;
+    /** Allows for closing the dialog manually.
+     * Typically used when `closeDialogOnSetValue` is false. */
+    closeDialog: () => Promise<void>;
+}
+/** Events that can be emitted from the Mesh SDK */
+type UniformMeshSDKEvents = {
+    /** Fired when the location value has changed */
+    onValueChanged: {
+        newValue: unknown;
+    };
+    /** Fired when the location metadata value has been updated */
+    onMetadataChanged: {
+        newValue: unknown;
+    };
+};
+interface UniformMeshSDK {
+    events: Emitter<UniformMeshSDKEvents>;
+    /** Gets the current location that the Mesh App is being displayed on. */
+    getCurrentLocation: <TValue = unknown, TSetValue = unknown>() => MeshLocation<TValue, TSetValue>;
+    /** The current `window` object being used for the SDK */
+    currentWindow: SdkWindow | undefined;
+    /** The version of the Mesh framework being used */
+    version: string;
+    /** Opens a dialog in the Uniform app with the URL set to a specific named dialog registered for the current location in the Mesh app manifest */
+    openLocationDialog: <TExpectedDialogResult = unknown, TDialogParams = void>(options: OpenLocationDialogOptions<TDialogParams>) => Promise<LocationDialogResponse<TExpectedDialogResult> | undefined>;
+    /** Explicitly close a location dialog. Called within the dialog. */
+    closeLocationDialog: (options: CloseLocationDialogOptions) => Promise<void>;
+    /** Opens a confirmation dialog to get a confirm/cancel question answered. Does not require any registration with the Mesh app manifest. */
+    openConfirmationDialog(options: OpenConfirmationDialogOptions): Promise<OpenConfirmationDialogResult | undefined>;
+    /** Opens the current location within a dialog, enabling to to break out of the layout it was loaded in. */
+    openCurrentLocationDialog<TLocationType extends MeshLocation['type'], TLocationSetValue = unknown, TDialogParams = void>(options?: {
+        options?: DialogOptions<TDialogParams>;
+    }): Promise<LocationDialogResponse<Parameters<Extract<MeshLocation<TLocationSetValue, TLocationSetValue>, {
+        type: TLocationType;
+    }>['setValue']>[0]> | undefined>;
+    /** Explicitly close a location dialog. Called when rendering current location in the dialog. */
+    closeCurrentLocationDialog(): Promise<void>;
+}
+declare global {
+    interface Window {
+        UniformMeshSDK: UniformMeshSDK | undefined;
+    }
+}
+/**
+ * Initializes the Uniform Mesh SDK. Intended to be called (and awaited) prior to any
+ * attempted interaction with the Uniform Mesh SDK.
+ */
+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 };

package/dist/index.esm.js

@@ -521,6 +521,7 @@ function getByteSize(val) {
 }
 
 // src/sdkWindow.ts
+import imagesLoaded from "imagesloaded";
 var oldHeight;
 var createSdkWindow = ({
   onHeightChange,
@@ -548,6 +549,34 @@ var createSdkWindow = ({
     updateHeight();
   };
   const observer = autoResizingDisabled ? void 0 : new MutationObserver(heightCallback);
+  const observedImages = /* @__PURE__ */ new WeakSet();
+  const imagesLoadedInstance = autoResizingDisabled ? void 0 : imagesLoaded(document.body, () => {
+    heightCallback();
+  });
+  imagesLoadedInstance == null ? void 0 : imagesLoadedInstance.on("progress", () => {
+    heightCallback();
+  });
+  const newImagesObserver = autoResizingDisabled ? void 0 : new MutationObserver((mutations) => {
+    let newImagesAdded = false;
+    for (const mutation of mutations) {
+      for (const newNode of mutation.addedNodes) {
+        if (newNode && newNode.nodeName !== "IMG") {
+          continue;
+        }
+        if (observedImages.has(newNode)) {
+          continue;
+        }
+        observedImages.add(newNode);
+        imagesLoadedInstance == null ? void 0 : imagesLoadedInstance.addImage(newNode);
+        newImagesAdded = true;
+      }
+    }
+    if (newImagesAdded) {
+      window.requestAnimationFrame(() => {
+        imagesLoadedInstance == null ? void 0 : imagesLoadedInstance.check();
+      });
+    }
+  });
   const sdkWindow = {
     instance: windowInstance,
     height: windowInstance.document.documentElement.getBoundingClientRect().height,
@@ -560,10 +589,15 @@ var createSdkWindow = ({
         characterData: true
       });
       windowInstance.addEventListener("resize", heightCallback);
+      newImagesObserver == null ? void 0 : newImagesObserver.observe(document.body, {
+        childList: true,
+        subtree: true
+      });
     },
     disableAutoResizing: () => {
       observer == null ? void 0 : observer.disconnect();
       windowInstance.removeEventListener("resize", heightCallback);
+      newImagesObserver == null ? void 0 : newImagesObserver.disconnect();
     },
     updateHeight
   };

package/dist/index.js

@@ -558,6 +558,7 @@ function getByteSize(val) {
 }
 
 // src/sdkWindow.ts
+var import_imagesloaded = __toESM(require("imagesloaded"));
 var oldHeight;
 var createSdkWindow = ({
   onHeightChange,
@@ -585,6 +586,34 @@ var createSdkWindow = ({
     updateHeight();
   };
   const observer = autoResizingDisabled ? void 0 : new MutationObserver(heightCallback);
+  const observedImages = /* @__PURE__ */ new WeakSet();
+  const imagesLoadedInstance = autoResizingDisabled ? void 0 : (0, import_imagesloaded.default)(document.body, () => {
+    heightCallback();
+  });
+  imagesLoadedInstance == null ? void 0 : imagesLoadedInstance.on("progress", () => {
+    heightCallback();
+  });
+  const newImagesObserver = autoResizingDisabled ? void 0 : new MutationObserver((mutations) => {
+    let newImagesAdded = false;
+    for (const mutation of mutations) {
+      for (const newNode of mutation.addedNodes) {
+        if (newNode && newNode.nodeName !== "IMG") {
+          continue;
+        }
+        if (observedImages.has(newNode)) {
+          continue;
+        }
+        observedImages.add(newNode);
+        imagesLoadedInstance == null ? void 0 : imagesLoadedInstance.addImage(newNode);
+        newImagesAdded = true;
+      }
+    }
+    if (newImagesAdded) {
+      window.requestAnimationFrame(() => {
+        imagesLoadedInstance == null ? void 0 : imagesLoadedInstance.check();
+      });
+    }
+  });
   const sdkWindow = {
     instance: windowInstance,
     height: windowInstance.document.documentElement.getBoundingClientRect().height,
@@ -597,10 +626,15 @@ var createSdkWindow = ({
         characterData: true
       });
       windowInstance.addEventListener("resize", heightCallback);
+      newImagesObserver == null ? void 0 : newImagesObserver.observe(document.body, {
+        childList: true,
+        subtree: true
+      });
     },
     disableAutoResizing: () => {
       observer == null ? void 0 : observer.disconnect();
       windowInstance.removeEventListener("resize", heightCallback);
+      newImagesObserver == null ? void 0 : newImagesObserver.disconnect();
     },
     updateHeight
   };

package/dist/index.mjs

@@ -521,6 +521,7 @@ function getByteSize(val) {
 }
 
 // src/sdkWindow.ts
+import imagesLoaded from "imagesloaded";
 var oldHeight;
 var createSdkWindow = ({
   onHeightChange,
@@ -548,6 +549,34 @@ var createSdkWindow = ({
     updateHeight();
   };
   const observer = autoResizingDisabled ? void 0 : new MutationObserver(heightCallback);
+  const observedImages = /* @__PURE__ */ new WeakSet();
+  const imagesLoadedInstance = autoResizingDisabled ? void 0 : imagesLoaded(document.body, () => {
+    heightCallback();
+  });
+  imagesLoadedInstance == null ? void 0 : imagesLoadedInstance.on("progress", () => {
+    heightCallback();
+  });
+  const newImagesObserver = autoResizingDisabled ? void 0 : new MutationObserver((mutations) => {
+    let newImagesAdded = false;
+    for (const mutation of mutations) {
+      for (const newNode of mutation.addedNodes) {
+        if (newNode && newNode.nodeName !== "IMG") {
+          continue;
+        }
+        if (observedImages.has(newNode)) {
+          continue;
+        }
+        observedImages.add(newNode);
+        imagesLoadedInstance == null ? void 0 : imagesLoadedInstance.addImage(newNode);
+        newImagesAdded = true;
+      }
+    }
+    if (newImagesAdded) {
+      window.requestAnimationFrame(() => {
+        imagesLoadedInstance == null ? void 0 : imagesLoadedInstance.check();
+      });
+    }
+  });
   const sdkWindow = {
     instance: windowInstance,
     height: windowInstance.document.documentElement.getBoundingClientRect().height,
@@ -560,10 +589,15 @@ var createSdkWindow = ({
         characterData: true
       });
       windowInstance.addEventListener("resize", heightCallback);
+      newImagesObserver == null ? void 0 : newImagesObserver.observe(document.body, {
+        childList: true,
+        subtree: true
+      });
     },
     disableAutoResizing: () => {
       observer == null ? void 0 : observer.disconnect();
       windowInstance.removeEventListener("resize", heightCallback);
+      newImagesObserver == null ? void 0 : newImagesObserver.disconnect();
     },
     updateHeight
   };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/mesh-sdk",
-  "version": "19.35.2",
+  "version": "19.36.0",
   "description": "Uniform Mesh Framework SDK",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -32,10 +32,14 @@
     "access": "public"
   },
   "dependencies": {
-    "@uniformdev/canvas": "19.35.2",
-    "@uniformdev/context": "19.35.2",
-    "@uniformdev/project-map": "19.35.2",
+    "@uniformdev/canvas": "19.36.0",
+    "@uniformdev/context": "19.36.0",
+    "@uniformdev/project-map": "19.36.0",
+    "imagesloaded": "^5.0.0",
     "mitt": "^3.0.0"
   },
-  "gitHead": "64d3270175087c87cfaa29a283aa4a7b0a98fd2c"
+  "devDependencies": {
+    "@types/imagesloaded": "^4.1.2"
+  },
+  "gitHead": "3ae246a7f0f39adeaf04ecba4c7e48c478c019ad"
 }