datocms-plugin-sdk 1.1.0 → 2.0.0

package/dist/types/connect.d.ts

@@ -1,243 +1,45 @@
-import type { SchemaTypes } from '@datocms/cma-client';
-import type { ItemFormOutlet, RenderItemFormOutletPropertiesAndMethods, StructuredTextCustomBlockStyle, StructuredTextCustomMark } from '.';
-import type { AssetSource, ContentAreaSidebarItem, FieldExtensionOverride, InitPropertiesAndMethods, InitialLocationQueryForItemSelector, ItemFormSidebar, ItemFormSidebarPanel, ItemPresentationInfo, MainNavigationTab, ManualFieldExtension, OnBootPropertiesAndMethods, RenderAssetSourcePropertiesAndMethods, RenderConfigScreenPropertiesAndMethods, RenderFieldExtensionPropertiesAndMethods, RenderManualFieldExtensionConfigScreenPropertiesAndMethods, RenderModalPropertiesAndMethods, RenderPagePropertiesAndMethods, RenderSidebarPanelPropertiesAndMethods, RenderSidebarPropertiesAndMethods, SettingsAreaSidebarItemGroup } from './types';
-declare type Field = SchemaTypes.Field;
-declare type Item = SchemaTypes.Item;
-declare type ItemCreateSchema = SchemaTypes.ItemCreateSchema;
-declare type ItemType = SchemaTypes.ItemType;
-declare type ItemUpdateSchema = SchemaTypes.ItemUpdateSchema;
-export declare type SizingUtilities = {
-    /**
-     * Listens for DOM changes and automatically calls `setHeight` when it detects
-     * a change. If you're using `datocms-react-ui` package, the `<Canvas />`
-     * component already takes care of calling this method for you.
-     */
-    startAutoResizer: () => void;
-    /** Stops resizing the iframe automatically */
-    stopAutoResizer: () => void;
-    /**
-     * Triggers a change in the size of the iframe. If you don't explicitely pass
-     * a `newHeight` it will be automatically calculated using the iframe content
-     * at the moment
-     */
-    updateHeight: (newHeight?: number) => void;
-};
-export type { Field, ItemType };
-export declare type IntentCtx = InitPropertiesAndMethods;
-export declare type OnBootCtx = OnBootPropertiesAndMethods;
-export declare type FieldIntentCtx = InitPropertiesAndMethods & {
-    itemType: ItemType;
-};
-export declare type RenderPageCtx = RenderPagePropertiesAndMethods;
-export declare type RenderModalCtx = RenderModalPropertiesAndMethods & SizingUtilities;
-export declare type RenderAssetSourceCtx = RenderAssetSourcePropertiesAndMethods & SizingUtilities;
-export declare type RenderItemFormSidebarPanelCtx = RenderSidebarPanelPropertiesAndMethods & SizingUtilities;
-export declare type RenderItemFormSidebarCtx = RenderSidebarPropertiesAndMethods & SizingUtilities;
-export declare type RenderItemFormOutletCtx = RenderItemFormOutletPropertiesAndMethods & SizingUtilities;
-export declare type RenderFieldExtensionCtx = RenderFieldExtensionPropertiesAndMethods & SizingUtilities;
-export declare type RenderManualFieldExtensionConfigScreenCtx = RenderManualFieldExtensionConfigScreenPropertiesAndMethods & SizingUtilities;
-export declare type RenderConfigScreenCtx = RenderConfigScreenPropertiesAndMethods & SizingUtilities;
-declare type MaybePromise<T> = T | Promise<T>;
+import type { AssetSourcesHook } from './hooks/assetSources';
+import type { BuildItemPresentationInfoHook } from './hooks/buildItemPresentationInfo';
+import type { ContentAreaSidebarItemsHook } from './hooks/contentAreaSidebarItems';
+import type { CustomBlockStylesForStructuredTextFieldHook } from './hooks/customBlockStylesForStructuredTextField';
+import type { CustomMarksForStructuredTextFieldHook } from './hooks/customMarksForStructuredTextField';
+import type { ExecuteFieldDropdownActionHook } from './hooks/executeFieldDropdownAction';
+import type { ExecuteItemFormDropdownActionHook } from './hooks/executeItemFormDropdownAction';
+import type { ExecuteItemsDropdownActionHook } from './hooks/executeItemsDropdownAction';
+import type { ExecuteUploadsDropdownActionHook } from './hooks/executeUploadsDropdownAction';
+import type { FieldDropdownActionsHook } from './hooks/fieldDropdownActions';
+import type { InitialLocationQueryForItemSelectorHook } from './hooks/initialLocationQueryForItemSelector';
+import type { ItemCollectionOutletsHook } from './hooks/itemCollectionOutlets';
+import type { ItemFormDropdownActionsHook } from './hooks/itemFormDropdownActions';
+import type { ItemFormOutletsHook } from './hooks/itemFormOutlets';
+import type { ItemFormSidebarPanelsHook } from './hooks/itemFormSidebarPanels';
+import type { ItemFormSidebarsHook } from './hooks/itemFormSidebars';
+import type { ItemsDropdownActionsHook } from './hooks/itemsDropdownActions';
+import type { MainNavigationTabsHook } from './hooks/mainNavigationTabs';
+import type { ManualFieldExtensionsHook } from './hooks/manualFieldExtensions';
+import type { OnBeforeItemUpsertHook } from './hooks/onBeforeItemUpsert';
+import type { OnBeforeItemsDestroyHook } from './hooks/onBeforeItemsDestroy';
+import type { OnBeforeItemsPublishHook } from './hooks/onBeforeItemsPublish';
+import type { OnBeforeItemsUnpublishHook } from './hooks/onBeforeItemsUnpublish';
+import type { OnBootHook } from './hooks/onBoot';
+import type { OverrideFieldExtensionsHook } from './hooks/overrideFieldExtensions';
+import { RenderAssetSourceHook } from './hooks/renderAssetSource';
+import { RenderConfigScreenHook } from './hooks/renderConfigScreen';
+import { RenderFieldExtensionHook } from './hooks/renderFieldExtension';
+import { RenderItemCollectionOutletHook } from './hooks/renderItemCollectionOutlet';
+import { RenderItemFormOutletHook } from './hooks/renderItemFormOutlet';
+import { RenderItemFormSidebarHook } from './hooks/renderItemFormSidebar';
+import { RenderItemFormSidebarPanelHook } from './hooks/renderItemFormSidebarPanel';
+import { RenderManualFieldExtensionConfigScreenHook } from './hooks/renderManualFieldExtensionConfigScreen';
+import { RenderModalHook } from './hooks/renderModal';
+import { RenderPageHook } from './hooks/renderPage';
+import { RenderUploadSidebarHook } from './hooks/renderUploadSidebar';
+import { RenderUploadSidebarPanelHook } from './hooks/renderUploadSidebarPanel';
+import type { SettingsAreaSidebarItemGroupsHook } from './hooks/settingsAreaSidebarItemGroups';
+import { UploadSidebarPanelsHook } from './hooks/uploadSidebarPanels';
+import { UploadSidebarsHook } from './hooks/uploadSidebars';
+import type { UploadsDropdownActionsHook } from './hooks/uploadsDropdownActions';
+import type { ValidateManualFieldExtensionParametersHook } from './hooks/validateManualFieldExtensionParameters';
 /** The full options you can pass to the `connect` function */
-export declare type FullConnectParameters = {
-    /**
-     * This function will be called once at boot time and can be used to perform
-     * ie. some initial integrity checks on the configuration.
-     *
-     * @tag boot
-     */
-    onBoot: (ctx: OnBootCtx) => void;
-    /**
-     * This function will be called before destroying records. You can stop the
-     * action by returning `false`
-     *
-     * @tag beforeHooks
-     */
-    onBeforeItemsDestroy: (items: Item[], ctx: OnBootCtx) => MaybePromise<boolean>;
-    /**
-     * This function will be called before publishing records. You can stop the
-     * action by returning `false`
-     *
-     * @tag beforeHooks
-     */
-    onBeforeItemsPublish: (items: Item[], ctx: OnBootCtx) => MaybePromise<boolean>;
-    /**
-     * This function will be called before unpublishing records. You can stop the
-     * action by returning `false`
-     *
-     * @tag beforeHooks
-     */
-    onBeforeItemsUnpublish: (items: Item[], ctx: OnBootCtx) => MaybePromise<boolean>;
-    /**
-     * This function will be called before saving a new version of a record. You
-     * can stop the action by returning `false`
-     *
-     * @tag beforeHooks
-     */
-    onBeforeItemUpsert: (createOrUpdateItemPayload: ItemUpdateSchema | ItemCreateSchema, ctx: OnBootCtx) => MaybePromise<boolean>;
-    /**
-     * Use this function to customize the presentation of a record in records
-     * collections and "Single link" or "Multiple links" field
-     *
-     * @tag presentation
-     */
-    buildItemPresentationInfo: (item: Item, ctx: OnBootCtx) => MaybePromise<ItemPresentationInfo | undefined>;
-    /**
-     * Use this function to customize the initial filters when opening an record
-     * selector via a "Single link" or "Multiple links" field
-     *
-     * @tag locationQuery
-     */
-    initialLocationQueryForItemSelector: (openerfield: Item, itemType: ItemType, ctx: OnBootCtx) => MaybePromise<InitialLocationQueryForItemSelector | undefined>;
-    /**
-     * Use this function to declare new tabs you want to add in the top-bar of the
-     * UI
-     *
-     * @tag pages
-     */
-    mainNavigationTabs: (ctx: IntentCtx) => MainNavigationTab[];
-    /**
-     * Use this function to declare new navigation sections in the Settings Area
-     * sidebar
-     *
-     * @tag pages
-     */
-    settingsAreaSidebarItemGroups: (ctx: IntentCtx) => SettingsAreaSidebarItemGroup[];
-    /**
-     * Use this function to declare new navigation items in the Content Area
-     * sidebar
-     *
-     * @tag pages
-     */
-    contentAreaSidebarItems: (ctx: IntentCtx) => ContentAreaSidebarItem[];
-    /**
-     * Use this function to declare new field extensions that users will be able
-     * to install manually in some field
-     *
-     * @tag manualFieldExtensions
-     */
-    manualFieldExtensions: (ctx: IntentCtx) => ManualFieldExtension[];
-    /**
-     * Use this function to declare additional sources to be shown when users want
-     * to upload new assets
-     *
-     * @tag assetSources
-     */
-    assetSources: (ctx: IntentCtx) => AssetSource[] | undefined;
-    /**
-     * Use this function to declare new sidebar panels to be shown when the user
-     * edits records of a particular model
-     *
-     * @tag sidebarPanels
-     */
-    itemFormSidebarPanels: (itemType: ItemType, ctx: IntentCtx) => ItemFormSidebarPanel[];
-    /**
-     * Use this function to declare new sidebar to be shown when the user edits
-     * records of a particular model
-     *
-     * @tag sidebarPanels
-     */
-    itemFormSidebars: (itemType: ItemType, ctx: IntentCtx) => ItemFormSidebar[];
-    /**
-     * Use this function to declare custom outlets to be shown at the top of the
-     * record's editing page
-     *
-     * @tag itemFormOutlets
-     */
-    itemFormOutlets: (itemType: ItemType, ctx: IntentCtx) => ItemFormOutlet[];
-    /**
-     * Use this function to automatically force one or more field extensions to a
-     * particular field
-     *
-     * @tag forcedFieldExtensions
-     */
-    overrideFieldExtensions: (field: Field, ctx: FieldIntentCtx) => FieldExtensionOverride | undefined;
-    /**
-     * Use this function to define a number of custom marks for a specific
-     * Structured Text field
-     *
-     * @tag structuredText
-     */
-    customMarksForStructuredTextField: (field: Field, ctx: FieldIntentCtx) => StructuredTextCustomMark[] | undefined;
-    /**
-     * Use this function to define a number of custom block styles for a specific
-     * Structured Text field
-     *
-     * @tag structuredText
-     */
-    customBlockStylesForStructuredTextField: (field: Field, ctx: FieldIntentCtx) => StructuredTextCustomBlockStyle[] | undefined;
-    /**
-     * This function will be called when the plugin needs to render the plugin's
-     * configuration form
-     *
-     * @tag configScreen
-     */
-    renderConfigScreen: (ctx: RenderConfigScreenCtx) => void;
-    /**
-     * 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;
-    /**
-     * 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;
-    /**
-     * 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;
-    /**
-     * 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;
-    /**
-     * This function will be called when the plugin needs to render an outlet (see
-     * the `itemFormOutlets` function)
-     *
-     * @tag itemFormOutlets
-     */
-    renderItemFormOutlet: (itemFormOutletId: string, ctx: RenderItemFormOutletCtx) => void;
-    /**
-     * 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;
-    /**
-     * 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;
-    /**
-     * This function will be called when the plugin needs to render the
-     * configuration form for installing a field extension inside a particular
-     * field
-     *
-     * @tag manualFieldExtensions
-     */
-    renderManualFieldExtensionConfigScreen: (fieldExtensionId: string, ctx: RenderManualFieldExtensionConfigScreenCtx) => void;
-    /**
-     * This function will be called each time the configuration object changes. It
-     * must return an object containing possible validation errors
-     *
-     * @tag manualFieldExtensions
-     */
-    validateManualFieldExtensionParameters: (fieldExtensionId: string, parameters: Record<string, unknown>) => Record<string, unknown> | Promise<Record<string, unknown>>;
-};
-export declare function connect(configuration?: Partial<FullConnectParameters>): Promise<void>;
+export type FullConnectParameters = AssetSourcesHook & BuildItemPresentationInfoHook & ContentAreaSidebarItemsHook & CustomBlockStylesForStructuredTextFieldHook & CustomMarksForStructuredTextFieldHook & ExecuteFieldDropdownActionHook & ExecuteItemFormDropdownActionHook & ExecuteItemsDropdownActionHook & ExecuteUploadsDropdownActionHook & FieldDropdownActionsHook & InitialLocationQueryForItemSelectorHook & ItemCollectionOutletsHook & ItemFormDropdownActionsHook & ItemFormOutletsHook & ItemFormSidebarPanelsHook & ItemFormSidebarsHook & ItemsDropdownActionsHook & MainNavigationTabsHook & ManualFieldExtensionsHook & OnBeforeItemsDestroyHook & OnBeforeItemsPublishHook & OnBeforeItemsUnpublishHook & OnBeforeItemUpsertHook & OnBootHook & OverrideFieldExtensionsHook & RenderAssetSourceHook & RenderConfigScreenHook & RenderFieldExtensionHook & RenderItemCollectionOutletHook & RenderItemFormOutletHook & RenderItemFormSidebarHook & RenderItemFormSidebarPanelHook & RenderManualFieldExtensionConfigScreenHook & RenderModalHook & RenderPageHook & RenderUploadSidebarHook & RenderUploadSidebarPanelHook & SettingsAreaSidebarItemGroupsHook & UploadsDropdownActionsHook & UploadSidebarPanelsHook & UploadSidebarsHook & ValidateManualFieldExtensionParametersHook;
+export declare function connect(rawConfiguration?: Partial<FullConnectParameters>): Promise<void>;