datocms-plugin-sdk 1.1.1 → 2.0.1

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

@@ -0,0 +1,27 @@
+import type { SchemaTypes } from '@datocms/cma-client';
+import { Ctx, ItemListLocationQuery } from '../ctx/base';
+import { MaybePromise } from '../utils';
+type Field = SchemaTypes.Field;
+type ItemType = SchemaTypes.ItemType;
+export type InitialLocationQueryForItemSelectorHook = {
+    /**
+     * Use this function to customize the initial filters when opening a record
+     * selector via a "Single link" or "Multiple links" field
+     *
+     * @tag locationQuery
+     */
+    initialLocationQueryForItemSelector: (openerField: Field, itemType: ItemType, ctx: InitialLocationQueryForItemSelectorCtx) => MaybePromise<InitialLocationQueryForItemSelector | undefined>;
+};
+export type InitialLocationQueryForItemSelectorCtx = Ctx;
+export type InitialLocationQueryForItemSelector = {
+    locationQuery: ItemListLocationQuery;
+    /**
+     * If different plugins implement the `initialLocationQueryForItemSelector`
+     * hook, the one with the lowest `rank` will be used. 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;
+};
+export {};

package/dist/esm/hooks/initialLocationQueryForItemSelector.js

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

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

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

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

@@ -0,0 +1,31 @@
+import type { SchemaTypes } from '@datocms/cma-client';
+import { Ctx } from '../ctx/base';
+type ItemType = SchemaTypes.ItemType;
+export type ItemCollectionOutletsHook = {
+    /**
+     * Use this function to declare custom outlets to be shown at the top of a
+     * collection of records of a particular model
+     *
+     * @tag outlets
+     */
+    itemCollectionOutlets: (itemType: ItemType, ctx: ItemCollectionOutletsCtx) => ItemCollectionOutlet[];
+};
+export type ItemCollectionOutletsCtx = Ctx;
+/** An outlet to be shown at the top of a record's collection page */
+export type ItemCollectionOutlet = {
+    /**
+     * ID of the outlet. Will be the first argument for the `renderItemCollectionOutlet`
+     * function
+     */
+    id: string;
+    /**
+     * Multiple outlets will be sorted 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;
+    /** The initial height to set for the iframe that will render the outlet */
+    initialHeight?: number;
+};
+export {};

package/dist/esm/hooks/itemCollectionOutlets.js

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

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

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

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

@@ -0,0 +1,20 @@
+import type { SchemaTypes } from '@datocms/cma-client';
+import { Ctx } from '../ctx/base';
+import { ItemFormAdditionalProperties } from '../ctx/commonExtras/itemForm';
+import { DropdownAction, DropdownActionGroup } from '../shared';
+type ItemType = SchemaTypes.ItemType;
+export type ItemFormDropdownActionsHook = {
+    /**
+     * Use this function to define custom actions (or groups of actions) to be
+     * displayed at when editing a particular record.
+     *
+     * The `executeItemFormDropdownAction()` hook will be triggered once the user
+     * clicks on one of the defined actions.
+     *
+     * @tag dropdownActions
+     */
+    itemFormDropdownActions: (itemType: ItemType, ctx: ItemFormDropdownActionsCtx) => Array<DropdownAction | DropdownActionGroup>;
+};
+export type ItemFormDropdownActionsCtx = ItemFormDropdownActionsProperties;
+export type ItemFormDropdownActionsProperties = Ctx<ItemFormAdditionalProperties>;
+export {};

package/dist/esm/hooks/itemFormDropdownActions.js

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

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

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

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

@@ -0,0 +1,30 @@
+import type { SchemaTypes } from '@datocms/cma-client';
+import { Ctx } from '../ctx/base';
+type ItemType = SchemaTypes.ItemType;
+export type ItemFormOutletsHook = {
+    /**
+     * Use this function to declare custom outlets to be shown at the top of the
+     * record's editing page
+     *
+     * @tag outlets
+     */
+    itemFormOutlets: (itemType: ItemType, ctx: ItemFormOutletsCtx) => ItemFormOutlet[];
+};
+export type ItemFormOutletsCtx = Ctx;
+export type ItemFormOutlet = {
+    /**
+     * ID of the outlet. Will be the first argument for the `renderItemFormOutlet`
+     * function
+     */
+    id: string;
+    /**
+     * Multiple outlets will be sorted 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;
+    /** The initial height to set for the iframe that will render the outlet */
+    initialHeight?: number;
+};
+export {};

package/dist/esm/hooks/itemFormOutlets.js

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

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

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

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

@@ -0,0 +1,48 @@
+import type { SchemaTypes } from '@datocms/cma-client';
+import { Ctx } from '../ctx/base';
+import { ItemFormSidebarPanelPlacement } from '../shared';
+type ItemType = SchemaTypes.ItemType;
+export type ItemFormSidebarPanelsHook = {
+    /**
+     * 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: ItemFormSidebarPanelsCtx) => ItemFormSidebarPanel[];
+};
+export type ItemFormSidebarPanelsCtx = Ctx;
+export type ItemFormSidebarPanel = {
+    /**
+     * ID of the panel. Will be the first argument for the
+     * `renderItemFormSidebarPanel` function
+     */
+    id: string;
+    /** Label to be shown on the collapsible sidebar panel handle */
+    label: string;
+    /**
+     * An arbitrary configuration object that will be passed as the `parameters`
+     * property of the second argument of the `renderItemFormSidebarPanel`
+     * function
+     */
+    parameters?: Record<string, unknown>;
+    /** Whether the sidebar panel will start open or collapsed */
+    startOpen?: boolean;
+    /**
+     * Expresses where you want the item to be placed inside the sidebar. If not
+     * specified, the item will be placed after the standard panels provided by
+     * DatoCMS itself.
+     */
+    placement?: ItemFormSidebarPanelPlacement;
+    /**
+     * If multiple sidebar panels specify the same `placement`, they will be
+     * sorted 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;
+    /** The initial height to set for the iframe that will render the sidebar panel */
+    initialHeight?: number;
+};
+export {};

package/dist/esm/hooks/itemFormSidebarPanels.js

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

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

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

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

@@ -0,0 +1,38 @@
+import type { SchemaTypes } from '@datocms/cma-client';
+import { Ctx } from '../ctx/base';
+type ItemType = SchemaTypes.ItemType;
+export type ItemFormSidebarsHook = {
+    /**
+     * 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: ItemFormSidebarsCtx) => ItemFormSidebar[];
+};
+export type ItemFormSidebarsCtx = Ctx;
+export type ItemFormSidebar = {
+    /**
+     * ID of the sidebar. Will be the first argument for the
+     * `renderItemFormSidebar` function
+     */
+    id: string;
+    /** Label to be shown on the collapsible sidebar handle */
+    label: string;
+    /**
+     * An arbitrary configuration object that will be passed as the `parameters`
+     * property of the second argument of the `renderItemFormSidebar` function
+     */
+    parameters?: Record<string, unknown>;
+    /**
+     * If multiple sidebars specify the same `placement`, they will be sorted 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;
+    /** The preferred width for the sidebar */
+    preferredWidth?: number;
+};
+export {};

package/dist/esm/hooks/itemFormSidebars.js

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

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

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

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

@@ -0,0 +1,23 @@
+import type { SchemaTypes } from '@datocms/cma-client';
+import { Ctx } from '../ctx/base';
+import { DropdownAction, DropdownActionGroup } from '../shared';
+type ItemType = SchemaTypes.ItemType;
+export type ItemsDropdownActionsHook = {
+    /**
+     * This function lets you set up custom actions (or groups of actions) that
+     * show up when the user:
+     *
+     * * selects multiple records in the collection view for batch operations, or
+     * * starts editing a specific record.
+     *
+     * The `executeItemsDropdownAction()` hook will be triggered once the user
+     * clicks on one of the defined actions.
+     *
+     * @tag dropdownActions
+     */
+    itemsDropdownActions: (itemType: ItemType, ctx: ItemDropdownActionsCtx) => Array<DropdownAction | DropdownActionGroup>;
+};
+export type ItemDropdownActionsCtx = Ctx<{
+    itemType: ItemType;
+}>;
+export {};

package/dist/esm/hooks/itemsDropdownActions.js

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

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

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

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

@@ -0,0 +1,44 @@
+import { Ctx } from '../ctx/base';
+import { Icon } from '../icon';
+export type MainNavigationTabsHook = {
+    /**
+     * Use this function to declare new tabs you want to add in the top-bar of the
+     * UI
+     *
+     * @tag pages
+     */
+    mainNavigationTabs: (ctx: MainNavigationTabsCtx) => MainNavigationTab[];
+};
+export type MainNavigationTabsCtx = Ctx;
+/** A tab to be displayed in the top-bar of the UI */
+export type MainNavigationTab = {
+    /** 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 tab */
+    pointsTo: {
+        pageId: string;
+    };
+    /**
+     * Expresses where you want to place the tab in the top-bar. If not specified,
+     * the tab will be placed after the standard tabs provided by DatoCMS itself.
+     */
+    placement?: [
+        'before' | 'after',
+        'content' | 'media' | 'schema' | 'configuration' | 'cdaPlayground'
+    ];
+    /**
+     * If different plugins specify the same `placement` for their tabs, 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;
+};

package/dist/esm/hooks/mainNavigationTabs.js

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

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

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

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

@@ -0,0 +1,59 @@
+import { Ctx } from '../ctx/base';
+export type ManualFieldExtensionsHook = {
+    /**
+     * Use this function to declare new field extensions that users will be able
+     * to install manually in some field
+     *
+     * @tag manualFieldExtensions
+     */
+    manualFieldExtensions: (ctx: ManualFieldExtensionsCtx) => ManualFieldExtension[];
+};
+export type ManualFieldExtensionsCtx = Ctx;
+export type ManualFieldExtension = {
+    /**
+     * ID of field extension. Will be the first argument for the
+     * `renderFieldExtension` function
+     */
+    id: string;
+    /** Name to be shown when editing fields */
+    name: string;
+    /**
+     * Type of field extension. An `editor` extension replaces the default field
+     * editor that DatoCMS provides, while an `addon` extension is placed
+     * underneath the field editor to provide additional info/behaviour. You can
+     * setup multiple field addons for every field.
+     */
+    type: FieldExtensionType;
+    /**
+     * For `editor` extensions: moves the field to the sidebar of the record
+     * editing page, mimicking a sidebar panel
+     */
+    asSidebarPanel?: boolean | {
+        startOpen: boolean;
+    };
+    /**
+     * The type of fields that the field extension in compatible with. You can use
+     * the shortcut `all` to target all types of fields
+     */
+    fieldTypes: 'all' | FieldType[];
+    /**
+     * Whether this field extension needs some configuration options before being
+     * installed in a field or not. Will trigger the
+     * `renderManualFieldExtensionConfigScreen` and
+     * `validateManualFieldExtensionParameters` methods
+     */
+    configurable?: boolean | {
+        initialHeight: number;
+    };
+    /**
+     * The initial height to set for the iframe that will render the field
+     * extension
+     */
+    initialHeight?: number;
+};
+/**
+ * The sidebar in the Content Area presents a number of user-defined menu-items.
+ * This object represents a new item to be added in the sidebar.
+ */
+export type FieldExtensionType = 'editor' | 'addon';
+export type FieldType = 'boolean' | 'color' | 'date_time' | 'date' | 'file' | 'float' | 'gallery' | 'integer' | 'json' | 'lat_lon' | 'link' | 'links' | 'rich_text' | 'seo' | 'slug' | 'string' | 'structured_text' | 'text' | 'video';

package/dist/esm/hooks/manualFieldExtensions.js

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

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

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

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

@@ -0,0 +1,16 @@
+import type { SchemaTypes } from '@datocms/cma-client';
+import { Ctx } from '../ctx/base';
+import { MaybePromise } from '../utils';
+type ItemUpdateSchema = SchemaTypes.ItemUpdateSchema;
+type ItemCreateSchema = SchemaTypes.ItemCreateSchema;
+export type OnBeforeItemUpsertHook = {
+    /**
+     * 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: OnBeforeItemUpsertCtx) => MaybePromise<boolean>;
+};
+export type OnBeforeItemUpsertCtx = Ctx;
+export {};

package/dist/esm/hooks/onBeforeItemUpsert.js

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

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

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

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

@@ -0,0 +1,15 @@
+import type { SchemaTypes } from '@datocms/cma-client';
+import { Ctx } from '../ctx/base';
+import { MaybePromise } from '../utils';
+type Item = SchemaTypes.Item;
+export type OnBeforeItemsDestroyHook = {
+    /**
+     * This function will be called before destroying records. You can stop the
+     * action by returning `false`
+     *
+     * @tag beforeHooks
+     */
+    onBeforeItemsDestroy: (items: Item[], ctx: OnBeforeItemsDestroyCtx) => MaybePromise<boolean>;
+};
+export type OnBeforeItemsDestroyCtx = Ctx;
+export {};

package/dist/esm/hooks/onBeforeItemsDestroy.js

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

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

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

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

@@ -0,0 +1,15 @@
+import type { SchemaTypes } from '@datocms/cma-client';
+import { Ctx } from '../ctx/base';
+import { MaybePromise } from '../utils';
+type Item = SchemaTypes.Item;
+export type OnBeforeItemsPublishHook = {
+    /**
+     * This function will be called before publishing records. You can stop the
+     * action by returning `false`
+     *
+     * @tag beforeHooks
+     */
+    onBeforeItemsPublish: (items: Item[], ctx: OnBeforeItemsPublishCtx) => MaybePromise<boolean>;
+};
+export type OnBeforeItemsPublishCtx = Ctx;
+export {};

package/dist/esm/hooks/onBeforeItemsPublish.js

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

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

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

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

@@ -0,0 +1,15 @@
+import type { SchemaTypes } from '@datocms/cma-client';
+import { Ctx } from '../ctx/base';
+import { MaybePromise } from '../utils';
+type Item = SchemaTypes.Item;
+export type OnBeforeItemsUnpublishHook = {
+    /**
+     * This function will be called before unpublishing records. You can stop the
+     * action by returning `false`
+     *
+     * @tag beforeHooks
+     */
+    onBeforeItemsUnpublish: (items: Item[], ctx: OnBeforeItemsUnpublishCtx) => MaybePromise<boolean>;
+};
+export type OnBeforeItemsUnpublishCtx = Ctx;
+export {};

package/dist/esm/hooks/onBeforeItemsUnpublish.js

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

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

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

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

@@ -0,0 +1,11 @@
+import { ImposedSizePluginFrameCtx } from '../ctx/pluginFrame';
+export type OnBootHook = {
+    /**
+     * 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;
+};
+export type OnBootCtx = ImposedSizePluginFrameCtx<'onBoot'>;

package/dist/esm/hooks/onBoot.js

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

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

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

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

@@ -0,0 +1,88 @@
+import type { SchemaTypes } from '@datocms/cma-client';
+import { Ctx } from '../ctx/base';
+import { ItemFormSidebarPanelPlacement } from '../shared';
+type Field = SchemaTypes.Field;
+type ItemType = SchemaTypes.ItemType;
+export type OverrideFieldExtensionsHook = {
+    /**
+     * Use this function to automatically force one or more field extensions to a
+     * particular field
+     *
+     * @tag forcedFieldExtensions
+     */
+    overrideFieldExtensions: (field: Field, ctx: OverrideFieldExtensionsCtx) => FieldExtensionOverride | undefined;
+};
+export type OverrideFieldExtensionsCtx = Ctx<{
+    itemType: ItemType;
+}>;
+/**
+ * An object expressing some field extensions you want to force on a particular
+ * field
+ */
+export type FieldExtensionOverride = {
+    /** Force a field editor/sidebar extension on a field */
+    editor?: EditorOverride;
+    /** One or more field sidebar extensions to forcefully add to a field */
+    addons?: AddonOverride[];
+};
+/** A field editor/sidebar forced on a field */
+export type EditorOverride = {
+    /**
+     * ID of field extension. Will be the first argument for the
+     * `renderFieldExtension` function
+     */
+    id: string;
+    /**
+     * Moves the field to the sidebar of the record editing page, mimicking a
+     * sidebar panel
+     */
+    asSidebarPanel?: boolean | {
+        startOpen?: boolean;
+        placement?: ItemFormSidebarPanelPlacement;
+    };
+    /**
+     * An arbitrary configuration object that will be passed as the `parameters`
+     * property of the second argument of the `renderFieldExtension` function
+     */
+    parameters?: Record<string, unknown>;
+    /**
+     * If multiple plugins override a field, the one with the lowest `rank` will
+     * win. 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;
+    /**
+     * The initial height to set for the iframe that will render the field
+     * extension
+     */
+    initialHeight?: number;
+};
+/** A field addon extension forced on a field */
+export type AddonOverride = {
+    /**
+     * ID of field extension. Will be the first argument for the
+     * `renderFieldExtension` function
+     */
+    id: string;
+    /**
+     * An arbitrary configuration object that will be passed as the `parameters`
+     * property of the second argument of the `renderFieldExtension` function
+     */
+    parameters?: Record<string, unknown>;
+    /**
+     * If multiple addons are present for a field, they will be sorted 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;
+    /**
+     * The initial height to set for the iframe that will render the field
+     * extension
+     */
+    initialHeight?: number;
+};
+export {};

package/dist/esm/hooks/overrideFieldExtensions.js

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

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

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