datocms-plugin-sdk 1.1.1 → 2.0.1

package/dist/esm/hooks/renderAssetSource.d.ts

@@ -0,0 +1,98 @@
+import { SelfResizingPluginFrameCtx } from '../ctx/pluginFrame';
+export type RenderAssetSourceHook = {
+    /**
+     * This function will be called when the user selects one of the plugin's
+     * asset sources to upload a new media file.
+     *
+     * @tag assetSources
+     */
+    renderAssetSource: (assetSourceId: string, ctx: RenderAssetSourceCtx) => void;
+};
+export type RenderAssetSourceCtx = SelfResizingPluginFrameCtx<'renderAssetSource', {
+    /** The ID of the assetSource that needs to be rendered */
+    assetSourceId: string;
+}, {
+    /**
+     * Function to be called when the user selects the asset: it will trigger the
+     * creation of a new `Upload` that will be added in the Media Area.
+     *
+     * @example
+     *
+     * ```js
+     * await ctx.select({
+     *   resource: {
+     *     url: 'https://images.unsplash.com/photo-1416339306562-f3d12fefd36f',
+     *     filename: 'man-drinking-coffee.jpg',
+     *   },
+     *   copyright: 'Royalty free (Unsplash)',
+     *   author: 'Jeff Sheldon',
+     *   notes: 'A man drinking a coffee',
+     *   tags: ['man', 'coffee'],
+     * });
+     * ```
+     */
+    select: (newUpload: NewUpload) => void;
+}>;
+export type NewUploadResourceAsUrl = {
+    /**
+     * URL for the resource. The URL must respond with a
+     * `Access-Control-Allow-Origin` header — for instance `*`, which will allow
+     * all hosts — allowing the image to be read by DatoCMS
+     */
+    url: string;
+    /** Any additional headers to pass when making the request to the URL */
+    headers?: Record<string, string>;
+    /**
+     * Optional filename to be used to generate the final DatoCMS URL. If not
+     * passed, the URL will be used
+     */
+    filename?: string;
+};
+export type NewUploadResourceAsBase64 = {
+    /**
+     * Base64 encoded data URI for the resource.
+     *
+     * Format:
+     *
+     * `data:[<mime type>][;charset=<charset>];base64,<encoded data>`
+     */
+    base64: string;
+    /** Filename to be used to generate the final DatoCMS URL */
+    filename: string;
+};
+export type NewUpload = {
+    /** The actual resource that will be uploaded */
+    resource: NewUploadResourceAsUrl | NewUploadResourceAsBase64;
+    /** Copyright to apply to the asset */
+    copyright?: string;
+    /** Author to apply to the asset */
+    author?: string;
+    /** Notes to apply to the asset */
+    notes?: string;
+    /** Tags to apply to the asset */
+    tags?: string[];
+    /**
+     * An hash containing, for each locale of the project, the default metadata to
+     * apply to the asset
+     */
+    default_field_metadata?: {
+        [k: string]: {
+            /** Alternate text for the asset */
+            alt: string | null;
+            /** Title for the asset */
+            title: string | null;
+            /** Object with arbitrary metadata */
+            custom_data: {
+                [k: string]: unknown;
+            };
+            /** Focal point (only for image assets) */
+            focal_point?: {
+                /** Horizontal position expressed as float between 0 and 1 */
+                x: number;
+                /** Vertical position expressed as float between 0 and 1 */
+                y: number;
+            } | null;
+        };
+    };
+};
+export declare const renderAssetSourceBootstrapper: import("../utils").Bootstrapper<"renderAssetSource">;

package/dist/esm/hooks/renderAssetSource.js

@@ -0,0 +1,8 @@
+import { containedRenderModeBootstrapper } from '../utils';
+export var renderAssetSourceBootstrapper = containedRenderModeBootstrapper('renderAssetSource', function (configuration, ctx) {
+    if (!configuration.renderAssetSource) {
+        return;
+    }
+    configuration.renderAssetSource(ctx.assetSourceId, ctx);
+});
+//# sourceMappingURL=renderAssetSource.js.map

package/dist/esm/hooks/renderAssetSource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderAssetSource.js","sourceRoot":"","sources":["../../../src/hooks/renderAssetSource.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,+BAA+B,EAAE,MAAM,UAAU,CAAC;AA2G3D,MAAM,CAAC,IAAM,6BAA6B,GACxC,+BAA+B,CAC7B,mBAAmB,EACnB,UAAC,aAAa,EAAE,GAAG;IACjB,IAAI,CAAC,aAAa,CAAC,iBAAiB,EAAE,CAAC;QACrC,OAAO;IACT,CAAC;IAED,aAAa,CAAC,iBAAiB,CAAC,GAAG,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;AAC1D,CAAC,CACF,CAAC"}

package/dist/esm/hooks/renderConfigScreen.d.ts

@@ -0,0 +1,12 @@
+import { SelfResizingPluginFrameCtx } from '../ctx/pluginFrame';
+export type RenderConfigScreenHook = {
+    /**
+     * This function will be called when the plugin needs to render the plugin's
+     * configuration form
+     *
+     * @tag configScreen
+     */
+    renderConfigScreen: (ctx: RenderConfigScreenCtx) => void;
+};
+export type RenderConfigScreenCtx = SelfResizingPluginFrameCtx<'renderConfigScreen'>;
+export declare const renderConfigScreenBootstrapper: import("../utils").Bootstrapper<"renderConfigScreen">;

package/dist/esm/hooks/renderConfigScreen.js

@@ -0,0 +1,8 @@
+import { containedRenderModeBootstrapper } from '../utils';
+export var renderConfigScreenBootstrapper = containedRenderModeBootstrapper('renderConfigScreen', function (configuration, ctx) {
+    if (!configuration.renderConfigScreen) {
+        return;
+    }
+    configuration.renderConfigScreen(ctx);
+});
+//# sourceMappingURL=renderConfigScreen.js.map

package/dist/esm/hooks/renderConfigScreen.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderConfigScreen.js","sourceRoot":"","sources":["../../../src/hooks/renderConfigScreen.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,+BAA+B,EAAE,MAAM,UAAU,CAAC;AAe3D,MAAM,CAAC,IAAM,8BAA8B,GACzC,+BAA+B,CAC7B,oBAAoB,EACpB,UAAC,aAAa,EAAE,GAAG;IACjB,IAAI,CAAC,aAAa,CAAC,kBAAkB,EAAE,CAAC;QACtC,OAAO;IACT,CAAC;IAED,aAAa,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;AACxC,CAAC,CACF,CAAC"}

package/dist/esm/hooks/renderFieldExtension.d.ts

@@ -0,0 +1,20 @@
+import { FieldAdditionalProperties } from '../ctx/commonExtras/field';
+import { ItemFormAdditionalMethods, ItemFormAdditionalProperties } from '../ctx/commonExtras/itemForm';
+import { SelfResizingPluginFrameCtx } from '../ctx/pluginFrame';
+export type RenderFieldExtensionHook = {
+    /**
+     * This function will be called when the plugin needs to render a field
+     * extension (see the `manualFieldExtensions` and `overrideFieldExtensions`
+     * functions)
+     *
+     * @tag forcedFieldExtensions
+     */
+    renderFieldExtension: (fieldExtensionId: string, ctx: RenderFieldExtensionCtx) => void;
+};
+export type RenderFieldExtensionCtx = SelfResizingPluginFrameCtx<'renderFieldExtension', ItemFormAdditionalProperties & FieldAdditionalProperties & {
+    /** The ID of the field extension that needs to be rendered */
+    fieldExtensionId: string;
+    /** The arbitrary `parameters` of the field extension */
+    parameters: Record<string, unknown>;
+}, ItemFormAdditionalMethods>;
+export declare const renderFieldExtensionBootstrapper: import("../utils").Bootstrapper<"renderFieldExtension">;

package/dist/esm/hooks/renderFieldExtension.js

@@ -0,0 +1,8 @@
+import { containedRenderModeBootstrapper } from '../utils';
+export var renderFieldExtensionBootstrapper = containedRenderModeBootstrapper('renderFieldExtension', function (configuration, ctx) {
+    if (!configuration.renderFieldExtension) {
+        return;
+    }
+    configuration.renderFieldExtension(ctx.fieldExtensionId, ctx);
+});
+//# sourceMappingURL=renderFieldExtension.js.map

package/dist/esm/hooks/renderFieldExtension.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderFieldExtension.js","sourceRoot":"","sources":["../../../src/hooks/renderFieldExtension.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,+BAA+B,EAAE,MAAM,UAAU,CAAC;AA4B3D,MAAM,CAAC,IAAM,gCAAgC,GAC3C,+BAA+B,CAC7B,sBAAsB,EACtB,UAAC,aAAa,EAAE,GAAG;IACjB,IAAI,CAAC,aAAa,CAAC,oBAAoB,EAAE,CAAC;QACxC,OAAO;IACT,CAAC;IAED,aAAa,CAAC,oBAAoB,CAAC,GAAG,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC;AAChE,CAAC,CACF,CAAC"}

package/dist/esm/hooks/renderItemCollectionOutlet.d.ts

@@ -0,0 +1,15 @@
+import { SelfResizingPluginFrameCtx } from '../ctx/pluginFrame';
+export type RenderItemCollectionOutletHook = {
+    /**
+     * This function will be called when the plugin needs to render an outlet
+     * defined by the `itemFormOutlets()` hook.
+     *
+     * @tag outlets
+     */
+    renderItemCollectionOutlet: (itemCollectionOutletId: string, ctx: RenderItemCollectionOutletCtx) => void;
+};
+export type RenderItemCollectionOutletCtx = SelfResizingPluginFrameCtx<'renderItemCollectionOutlet', {
+    /** The ID of the outlet that needs to be rendered */
+    itemCollectionOutletId: string;
+}>;
+export declare const renderItemCollectionOutletBootstrapper: import("../utils").Bootstrapper<"renderItemCollectionOutlet">;

package/dist/esm/hooks/renderItemCollectionOutlet.js

@@ -0,0 +1,8 @@
+import { containedRenderModeBootstrapper } from '../utils';
+export var renderItemCollectionOutletBootstrapper = containedRenderModeBootstrapper('renderItemCollectionOutlet', function (configuration, ctx) {
+    if (!configuration.renderItemCollectionOutlet) {
+        return;
+    }
+    configuration.renderItemCollectionOutlet(ctx.itemCollectionOutletId, ctx);
+});
+//# sourceMappingURL=renderItemCollectionOutlet.js.map

package/dist/esm/hooks/renderItemCollectionOutlet.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderItemCollectionOutlet.js","sourceRoot":"","sources":["../../../src/hooks/renderItemCollectionOutlet.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,+BAA+B,EAAE,MAAM,UAAU,CAAC;AAuB3D,MAAM,CAAC,IAAM,sCAAsC,GACjD,+BAA+B,CAC7B,4BAA4B,EAC5B,UAAC,aAAa,EAAE,GAAG;IACjB,IAAI,CAAC,aAAa,CAAC,0BAA0B,EAAE,CAAC;QAC9C,OAAO;IACT,CAAC;IAED,aAAa,CAAC,0BAA0B,CAAC,GAAG,CAAC,sBAAsB,EAAE,GAAG,CAAC,CAAC;AAC5E,CAAC,CACF,CAAC"}

package/dist/esm/hooks/renderItemFormOutlet.d.ts

@@ -0,0 +1,16 @@
+import { ItemFormAdditionalMethods, ItemFormAdditionalProperties } from '../ctx/commonExtras/itemForm';
+import { SelfResizingPluginFrameCtx } from '../ctx/pluginFrame';
+export type RenderItemFormOutletHook = {
+    /**
+     * This function will be called when the plugin needs to render an outlet
+     * defined by the `itemFormOutlets()` hook.
+     *
+     * @tag outlets
+     */
+    renderItemFormOutlet: (itemFormOutletId: string, ctx: RenderItemFormOutletCtx) => void;
+};
+export type RenderItemFormOutletCtx = SelfResizingPluginFrameCtx<'renderItemFormOutlet', ItemFormAdditionalProperties & {
+    /** The ID of the outlet that needs to be rendered */
+    itemFormOutletId: string;
+}, ItemFormAdditionalMethods>;
+export declare const renderItemFormOutletBootstrapper: import("../utils").Bootstrapper<"renderItemFormOutlet">;

package/dist/esm/hooks/renderItemFormOutlet.js

@@ -0,0 +1,8 @@
+import { containedRenderModeBootstrapper } from '../utils';
+export var renderItemFormOutletBootstrapper = containedRenderModeBootstrapper('renderItemFormOutlet', function (configuration, ctx) {
+    if (!configuration.renderItemFormOutlet) {
+        return;
+    }
+    configuration.renderItemFormOutlet(ctx.itemFormOutletId, ctx);
+});
+//# sourceMappingURL=renderItemFormOutlet.js.map

package/dist/esm/hooks/renderItemFormOutlet.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderItemFormOutlet.js","sourceRoot":"","sources":["../../../src/hooks/renderItemFormOutlet.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,+BAA+B,EAAE,MAAM,UAAU,CAAC;AAwB3D,MAAM,CAAC,IAAM,gCAAgC,GAC3C,+BAA+B,CAC7B,sBAAsB,EACtB,UAAC,aAAa,EAAE,GAAG;IACjB,IAAI,CAAC,aAAa,CAAC,oBAAoB,EAAE,CAAC;QACxC,OAAO;IACT,CAAC;IAED,aAAa,CAAC,oBAAoB,CAAC,GAAG,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC;AAChE,CAAC,CACF,CAAC"}

package/dist/esm/hooks/renderItemFormSidebar.d.ts

@@ -0,0 +1,21 @@
+import { ItemFormAdditionalMethods, ItemFormAdditionalProperties } from '../ctx/commonExtras/itemForm';
+import { ImposedSizePluginFrameCtx } from '../ctx/pluginFrame';
+export type RenderItemFormSidebarHook = {
+    /**
+     * This function will be called when the plugin needs to render a sidebar (see
+     * the `itemFormSidebars` function)
+     *
+     * @tag sidebarPanels
+     */
+    renderItemFormSidebar: (sidebarId: string, ctx: RenderItemFormSidebarCtx) => void;
+};
+export type RenderItemFormSidebarCtx = ImposedSizePluginFrameCtx<'renderItemFormSidebar', ItemFormAdditionalProperties & {
+    /** The ID of the sidebar that needs to be rendered */
+    sidebarId: string;
+    /**
+     * The arbitrary `parameters` of the declared in the `itemFormSidebars`
+     * function
+     */
+    parameters: Record<string, unknown>;
+}, ItemFormAdditionalMethods>;
+export declare const renderItemFormSidebarBootstrapper: import("../utils").Bootstrapper<"renderItemFormSidebar">;

package/dist/esm/hooks/renderItemFormSidebar.js

@@ -0,0 +1,8 @@
+import { fullScreenRenderModeBootstrapper } from '../utils';
+export var renderItemFormSidebarBootstrapper = fullScreenRenderModeBootstrapper('renderItemFormSidebar', function (configuration, ctx) {
+    if (!configuration.renderItemFormSidebar) {
+        return;
+    }
+    configuration.renderItemFormSidebar(ctx.sidebarId, ctx);
+});
+//# sourceMappingURL=renderItemFormSidebar.js.map

package/dist/esm/hooks/renderItemFormSidebar.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderItemFormSidebar.js","sourceRoot":"","sources":["../../../src/hooks/renderItemFormSidebar.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,gCAAgC,EAAE,MAAM,UAAU,CAAC;AA6B5D,MAAM,CAAC,IAAM,iCAAiC,GAC5C,gCAAgC,CAC9B,uBAAuB,EACvB,UAAC,aAAa,EAAE,GAAG;IACjB,IAAI,CAAC,aAAa,CAAC,qBAAqB,EAAE,CAAC;QACzC,OAAO;IACT,CAAC;IAED,aAAa,CAAC,qBAAqB,CAAC,GAAG,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;AAC1D,CAAC,CACF,CAAC"}

package/dist/esm/hooks/renderItemFormSidebarPanel.d.ts

@@ -0,0 +1,21 @@
+import { ItemFormAdditionalMethods, ItemFormAdditionalProperties } from '../ctx/commonExtras/itemForm';
+import { SelfResizingPluginFrameCtx } from '../ctx/pluginFrame';
+export type RenderItemFormSidebarPanelHook = {
+    /**
+     * This function will be called when the plugin needs to render a sidebar panel
+     * (see the `itemFormSidebarPanels` function)
+     *
+     * @tag sidebarPanels
+     */
+    renderItemFormSidebarPanel: (sidebarPaneId: string, ctx: RenderItemFormSidebarPanelCtx) => void;
+};
+export type RenderItemFormSidebarPanelCtx = SelfResizingPluginFrameCtx<'renderItemFormSidebarPanel', ItemFormAdditionalProperties & {
+    /** The ID of the sidebar panel that needs to be rendered */
+    sidebarPaneId: string;
+    /**
+     * The arbitrary `parameters` of the panel declared in the
+     * `itemFormSidebarPanels` function
+     */
+    parameters: Record<string, unknown>;
+}, ItemFormAdditionalMethods>;
+export declare const renderItemFormSidebarPanelBootstrapper: import("../utils").Bootstrapper<"renderItemFormSidebarPanel">;

package/dist/esm/hooks/renderItemFormSidebarPanel.js

@@ -0,0 +1,8 @@
+import { containedRenderModeBootstrapper } from '../utils';
+export var renderItemFormSidebarPanelBootstrapper = containedRenderModeBootstrapper('renderItemFormSidebarPanel', function (configuration, ctx) {
+    if (!configuration.renderItemFormSidebarPanel) {
+        return;
+    }
+    configuration.renderItemFormSidebarPanel(ctx.sidebarPaneId, ctx);
+});
+//# sourceMappingURL=renderItemFormSidebarPanel.js.map

package/dist/esm/hooks/renderItemFormSidebarPanel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderItemFormSidebarPanel.js","sourceRoot":"","sources":["../../../src/hooks/renderItemFormSidebarPanel.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,+BAA+B,EAAE,MAAM,UAAU,CAAC;AA8B3D,MAAM,CAAC,IAAM,sCAAsC,GACjD,+BAA+B,CAC7B,4BAA4B,EAC5B,UAAC,aAAa,EAAE,GAAG;IACjB,IAAI,CAAC,aAAa,CAAC,0BAA0B,EAAE,CAAC;QAC9C,OAAO;IACT,CAAC;IAED,aAAa,CAAC,0BAA0B,CAAC,GAAG,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;AACnE,CAAC,CACF,CAAC"}

package/dist/esm/hooks/renderManualFieldExtensionConfigScreen.d.ts

@@ -0,0 +1,55 @@
+import type { SchemaTypes } from '@datocms/cma-client';
+import { SelfResizingPluginFrameCtx } from '../ctx/pluginFrame';
+type Field = SchemaTypes.Field;
+type ItemType = SchemaTypes.ItemType;
+export type RenderManualFieldExtensionConfigScreenHook = {
+    renderManualFieldExtensionConfigScreen: (fieldExtensionId: string, ctx: RenderManualFieldExtensionConfigScreenCtx) => void;
+};
+export type RenderManualFieldExtensionConfigScreenCtx = SelfResizingPluginFrameCtx<'renderManualFieldExtensionConfigScreen', {
+    /**
+     * The ID of the field extension for which we need to render the parameters
+     * form
+     */
+    fieldExtensionId: string;
+    /**
+     * The current value of the parameters (you can change the value with the
+     * `setParameters` function)
+     */
+    parameters: Record<string, unknown>;
+    /**
+     * The current validation errors for the parameters (you can set them
+     * implementing the `validateManualFieldExtensionParameters` function)
+     */
+    errors: Record<string, unknown>;
+    /** The field entity that is being edited in the form */
+    pendingField: PendingField;
+    /** The model for the field being edited */
+    itemType: ItemType;
+}, {
+    /**
+     * Sets a new value for the parameters
+     *
+     * @example
+     *
+     * ```js
+     * await ctx.setParameters({ color: '#ff0000' });
+     * ```
+     */
+    setParameters: (params: Record<string, unknown>) => Promise<void>;
+}>;
+export type PendingField = {
+    id?: string;
+    type: 'field';
+    attributes: {
+        api_key: Field['attributes']['api_key'];
+        appearance: Field['attributes']['appearance'];
+        default_value: Field['attributes']['default_value'];
+        field_type: Field['attributes']['field_type'];
+        hint: Field['attributes']['hint'];
+        label: Field['attributes']['label'];
+        localized: Field['attributes']['localized'];
+        validators: Field['attributes']['validators'];
+    };
+};
+export declare const renderManualFieldExtensionConfigScreenBootstrapper: import("../utils").Bootstrapper<"renderManualFieldExtensionConfigScreen">;
+export {};

package/dist/esm/hooks/renderManualFieldExtensionConfigScreen.js

@@ -0,0 +1,8 @@
+import { containedRenderModeBootstrapper } from '../utils';
+export var renderManualFieldExtensionConfigScreenBootstrapper = containedRenderModeBootstrapper('renderManualFieldExtensionConfigScreen', function (configuration, ctx) {
+    if (!configuration.renderManualFieldExtensionConfigScreen) {
+        return;
+    }
+    configuration.renderManualFieldExtensionConfigScreen(ctx.fieldExtensionId, ctx);
+});
+//# sourceMappingURL=renderManualFieldExtensionConfigScreen.js.map

package/dist/esm/hooks/renderManualFieldExtensionConfigScreen.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderManualFieldExtensionConfigScreen.js","sourceRoot":"","sources":["../../../src/hooks/renderManualFieldExtensionConfigScreen.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,+BAA+B,EAAE,MAAM,UAAU,CAAC;AAmE3D,MAAM,CAAC,IAAM,kDAAkD,GAC7D,+BAA+B,CAC7B,wCAAwC,EACxC,UAAC,aAAa,EAAE,GAAG;IACjB,IAAI,CAAC,aAAa,CAAC,sCAAsC,EAAE,CAAC;QAC1D,OAAO;IACT,CAAC;IAED,aAAa,CAAC,sCAAsC,CAClD,GAAG,CAAC,gBAAgB,EACpB,GAAG,CACJ,CAAC;AACJ,CAAC,CACF,CAAC"}

package/dist/esm/hooks/renderModal.d.ts

@@ -0,0 +1,37 @@
+import { SelfResizingPluginFrameCtx } from '../ctx/pluginFrame';
+export type RenderModalHook = {
+    /**
+     * This function will be called when the plugin requested to open a modal (see
+     * the `openModal` function)
+     *
+     * @tag modals
+     */
+    renderModal: (modalId: string, ctx: RenderModalCtx) => void;
+};
+export type RenderModalCtx = SelfResizingPluginFrameCtx<'renderModal', {
+    /** The ID of the modal that needs to be rendered */
+    modalId: string;
+    /**
+     * The arbitrary `parameters` of the modal declared in the `openModal`
+     * function
+     */
+    parameters: Record<string, unknown>;
+}, {
+    /**
+     * A function to be called by the plugin to close the modal. The `openModal`
+     * call will be resolved with the passed return value
+     *
+     * @example
+     *
+     * ```js
+     * const returnValue = prompt(
+     *   'Please specify the value to return to the caller:',
+     *   'success',
+     * );
+     *
+     * await ctx.resolve(returnValue);
+     * ```
+     */
+    resolve: (returnValue: unknown) => Promise<void>;
+}>;
+export declare const renderModalBootstrapper: import("../utils").Bootstrapper<"renderModal">;

package/dist/esm/hooks/renderModal.js

@@ -0,0 +1,8 @@
+import { containedRenderModeBootstrapper } from '../utils';
+export var renderModalBootstrapper = containedRenderModeBootstrapper('renderModal', function (configuration, ctx) {
+    if (!configuration.renderModal) {
+        return;
+    }
+    configuration.renderModal(ctx.modalId, ctx);
+});
+//# sourceMappingURL=renderModal.js.map

package/dist/esm/hooks/renderModal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderModal.js","sourceRoot":"","sources":["../../../src/hooks/renderModal.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,+BAA+B,EAAE,MAAM,UAAU,CAAC;AA0C3D,MAAM,CAAC,IAAM,uBAAuB,GAClC,+BAA+B,CAC7B,aAAa,EACb,UAAC,aAAa,EAAE,GAAG;IACjB,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC;QAC/B,OAAO;IACT,CAAC;IAED,aAAa,CAAC,WAAW,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AAC9C,CAAC,CACF,CAAC"}

package/dist/esm/hooks/renderPage.d.ts

@@ -0,0 +1,16 @@
+import { ImposedSizePluginFrameCtx } from '../ctx/pluginFrame';
+export type RenderPageHook = {
+    /**
+     * This function will be called when the plugin needs to render a specific
+     * page (see the `mainNavigationTabs`, `settingsAreaSidebarItemGroups` and
+     * `contentAreaSidebarItems` functions)
+     *
+     * @tag pages
+     */
+    renderPage: (pageId: string, ctx: RenderPageCtx) => void;
+};
+export type RenderPageCtx = ImposedSizePluginFrameCtx<'renderPage', {
+    /** The ID of the page that needs to be rendered */
+    pageId: string;
+}>;
+export declare const renderPageBootstrapper: import("../utils").Bootstrapper<"renderPage">;

package/dist/esm/hooks/renderPage.js

@@ -0,0 +1,8 @@
+import { fullScreenRenderModeBootstrapper } from '../utils';
+export var renderPageBootstrapper = fullScreenRenderModeBootstrapper('renderPage', function (configuration, ctx) {
+    if (!configuration.renderPage) {
+        return;
+    }
+    configuration.renderPage(ctx.pageId, ctx);
+});
+//# sourceMappingURL=renderPage.js.map

package/dist/esm/hooks/renderPage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderPage.js","sourceRoot":"","sources":["../../../src/hooks/renderPage.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gCAAgC,EAAE,MAAM,UAAU,CAAC;AAqB5D,MAAM,CAAC,IAAM,sBAAsB,GACjC,gCAAgC,CAC9B,YAAY,EACZ,UAAC,aAAa,EAAE,GAAG;IACjB,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,CAAC;QAC9B,OAAO;IACT,CAAC;IAED,aAAa,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAC5C,CAAC,CACF,CAAC"}

package/dist/esm/hooks/renderUploadSidebar.d.ts

@@ -0,0 +1,25 @@
+import type { SchemaTypes } from '@datocms/cma-client';
+import { ImposedSizePluginFrameCtx } from '../ctx/pluginFrame';
+type Upload = SchemaTypes.Upload;
+export type RenderUploadSidebarHook = {
+    /**
+     * This function will be called when the plugin needs to render a sidebar (see
+     * the `uploadSidebars` function)
+     *
+     * @tag sidebarPanels
+     */
+    renderUploadSidebar: (sidebarId: string, ctx: RenderUploadSidebarCtx) => void;
+};
+export type RenderUploadSidebarCtx = ImposedSizePluginFrameCtx<'renderUploadSidebar', {
+    /** The ID of the sidebar that needs to be rendered */
+    sidebarId: string;
+    /**
+     * The arbitrary `parameters` of the declared in the `uploadSidebars`
+     * function
+     */
+    parameters: Record<string, unknown>;
+    /** The active asset */
+    upload: Upload;
+}>;
+export declare const renderUploadSidebarBootstrapper: import("../utils").Bootstrapper<"renderUploadSidebar">;
+export {};

package/dist/esm/hooks/renderUploadSidebar.js

@@ -0,0 +1,8 @@
+import { fullScreenRenderModeBootstrapper } from '../utils';
+export var renderUploadSidebarBootstrapper = fullScreenRenderModeBootstrapper('renderUploadSidebar', function (configuration, ctx) {
+    if (!configuration.renderUploadSidebar) {
+        return;
+    }
+    configuration.renderUploadSidebar(ctx.sidebarId, ctx);
+});
+//# sourceMappingURL=renderUploadSidebar.js.map

package/dist/esm/hooks/renderUploadSidebar.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderUploadSidebar.js","sourceRoot":"","sources":["../../../src/hooks/renderUploadSidebar.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,gCAAgC,EAAE,MAAM,UAAU,CAAC;AA+B5D,MAAM,CAAC,IAAM,+BAA+B,GAC1C,gCAAgC,CAC9B,qBAAqB,EACrB,UAAC,aAAa,EAAE,GAAG;IACjB,IAAI,CAAC,aAAa,CAAC,mBAAmB,EAAE,CAAC;QACvC,OAAO;IACT,CAAC;IAED,aAAa,CAAC,mBAAmB,CAAC,GAAG,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;AACxD,CAAC,CACF,CAAC"}

package/dist/esm/hooks/renderUploadSidebarPanel.d.ts

@@ -0,0 +1,25 @@
+import { SchemaTypes } from '@datocms/cma-client';
+import { SelfResizingPluginFrameCtx } from '../ctx/pluginFrame';
+type Upload = SchemaTypes.Upload;
+export type RenderUploadSidebarPanelHook = {
+    /**
+     * This function will be called when the plugin needs to render a sidebar panel
+     * (see the `uploadSidebarPanels` function)
+     *
+     * @tag sidebarPanels
+     */
+    renderUploadSidebarPanel: (sidebarPaneId: string, ctx: RenderUploadSidebarPanelCtx) => void;
+};
+export type RenderUploadSidebarPanelCtx = SelfResizingPluginFrameCtx<'renderUploadSidebarPanel', {
+    /** The ID of the sidebar panel that needs to be rendered */
+    sidebarPaneId: string;
+    /**
+     * The arbitrary `parameters` of the panel declared in the
+     * `uploadSidebarPanels` function
+     */
+    parameters: Record<string, unknown>;
+    /** The active asset */
+    upload: Upload;
+}>;
+export declare const renderUploadSidebarPanelBootstrapper: import("../utils").Bootstrapper<"renderUploadSidebarPanel">;
+export {};

package/dist/esm/hooks/renderUploadSidebarPanel.js

@@ -0,0 +1,8 @@
+import { containedRenderModeBootstrapper } from '../utils';
+export var renderUploadSidebarPanelBootstrapper = containedRenderModeBootstrapper('renderUploadSidebarPanel', function (configuration, ctx) {
+    if (!configuration.renderUploadSidebarPanel) {
+        return;
+    }
+    configuration.renderUploadSidebarPanel(ctx.sidebarPaneId, ctx);
+});
+//# sourceMappingURL=renderUploadSidebarPanel.js.map

package/dist/esm/hooks/renderUploadSidebarPanel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderUploadSidebarPanel.js","sourceRoot":"","sources":["../../../src/hooks/renderUploadSidebarPanel.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,+BAA+B,EAAE,MAAM,UAAU,CAAC;AAkC3D,MAAM,CAAC,IAAM,oCAAoC,GAC/C,+BAA+B,CAC7B,0BAA0B,EAC1B,UAAC,aAAa,EAAE,GAAG;IACjB,IAAI,CAAC,aAAa,CAAC,wBAAwB,EAAE,CAAC;QAC5C,OAAO;IACT,CAAC;IAED,aAAa,CAAC,wBAAwB,CAAC,GAAG,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;AACjE,CAAC,CACF,CAAC"}

package/dist/esm/hooks/settingsAreaSidebarItemGroups.d.ts

@@ -0,0 +1,53 @@
+import { Ctx } from '../ctx/base';
+import { Icon } from '../icon';
+export type SettingsAreaSidebarItemGroupsHook = {
+    /**
+     * Use this function to declare new navigation sections in the Settings Area
+     * sidebar
+     *
+     * @tag pages
+     */
+    settingsAreaSidebarItemGroups: (ctx: SettingsAreaSidebarItemGroupsCtx) => SettingsAreaSidebarItemGroup[];
+};
+export type SettingsAreaSidebarItemGroupsCtx = Ctx;
+/**
+ * The sidebar in the Settings Area presents a number of pages grouped by topic.
+ * This object represents a new group to be added in the sideebar to the
+ * standard ones DatoCMS provides.
+ */
+export type SettingsAreaSidebarItemGroup = {
+    /** Label to be shown. Must be unique. */
+    label: string;
+    /** The list of items it contains * */
+    items: SettingsAreaSidebarItem[];
+    /**
+     * Expresses where you want the group to be placed inside the sidebar. If not
+     * specified, the item will be placed after the standard items provided by
+     * DatoCMS itself.
+     */
+    placement?: ['before' | 'after', 'properties' | 'permissions'];
+    /**
+     * If different plugins specify the same `placement` for their sections, they
+     * will be displayed by ascending `rank`. If you want to specify an explicit
+     * value for `rank`, make sure to offer a way for final users to customize it
+     * inside the plugin's settings form, otherwise the hardcoded value you choose
+     * might clash with the one of another plugin!
+     */
+    rank?: number;
+};
+/** An item contained in a Settings Area group */
+export type SettingsAreaSidebarItem = {
+    /** Label to be shown. Must be unique. */
+    label: string;
+    /**
+     * Icon to be shown alongside the label. Can be a FontAwesome icon name (ie.
+     * `"address-book"`) or a custom SVG definition. To maintain visual
+     * consistency with the rest of the interface, try to use FontAwesome icons
+     * whenever possible.
+     */
+    icon: Icon;
+    /** ID of the page linked to the item */
+    pointsTo: {
+        pageId: string;
+    };
+};

package/dist/esm/hooks/settingsAreaSidebarItemGroups.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=settingsAreaSidebarItemGroups.js.map

package/dist/esm/hooks/settingsAreaSidebarItemGroups.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"settingsAreaSidebarItemGroups.js","sourceRoot":"","sources":["../../../src/hooks/settingsAreaSidebarItemGroups.ts"],"names":[],"mappings":""}