datocms-plugin-sdk 2.0.0 → 2.0.2

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

@@ -9,8 +9,9 @@ export type ItemFormSidebarPanelsHook = {
      *
      * @tag sidebarPanels
      */
-    itemFormSidebarPanels: (itemType: ItemType, ctx: Ctx) => ItemFormSidebarPanel[];
+    itemFormSidebarPanels: (itemType: ItemType, ctx: ItemFormSidebarPanelsCtx) => ItemFormSidebarPanel[];
 };
+export type ItemFormSidebarPanelsCtx = Ctx;
 export type ItemFormSidebarPanel = {
     /**
      * ID of the panel. Will be the first argument for the

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

@@ -8,8 +8,9 @@ export type ItemFormSidebarsHook = {
      *
      * @tag sidebarPanels
      */
-    itemFormSidebars: (itemType: ItemType, ctx: Ctx) => ItemFormSidebar[];
+    itemFormSidebars: (itemType: ItemType, ctx: ItemFormSidebarsCtx) => ItemFormSidebar[];
 };
+export type ItemFormSidebarsCtx = Ctx;
 export type ItemFormSidebar = {
     /**
      * ID of the sidebar. Will be the first argument for the

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

@@ -3,6 +3,18 @@ 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<{

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

@@ -7,8 +7,9 @@ export type MainNavigationTabsHook = {
      *
      * @tag pages
      */
-    mainNavigationTabs: (ctx: Ctx) => MainNavigationTab[];
+    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. */

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

@@ -6,8 +6,9 @@ export type ManualFieldExtensionsHook = {
      *
      * @tag manualFieldExtensions
      */
-    manualFieldExtensions: (ctx: Ctx) => ManualFieldExtension[];
+    manualFieldExtensions: (ctx: ManualFieldExtensionsCtx) => ManualFieldExtension[];
 };
+export type ManualFieldExtensionsCtx = Ctx;
 export type ManualFieldExtension = {
     /**
      * ID of field extension. Will be the first argument for the

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

@@ -10,6 +10,7 @@ export type OnBeforeItemUpsertHook = {
      *
      * @tag beforeHooks
      */
-    onBeforeItemUpsert: (createOrUpdateItemPayload: ItemUpdateSchema | ItemCreateSchema, ctx: Ctx) => MaybePromise<boolean>;
+    onBeforeItemUpsert: (createOrUpdateItemPayload: ItemUpdateSchema | ItemCreateSchema, ctx: OnBeforeItemUpsertCtx) => MaybePromise<boolean>;
 };
+export type OnBeforeItemUpsertCtx = Ctx;
 export {};

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

@@ -9,6 +9,7 @@ export type OnBeforeItemsDestroyHook = {
      *
      * @tag beforeHooks
      */
-    onBeforeItemsDestroy: (items: Item[], ctx: Ctx) => MaybePromise<boolean>;
+    onBeforeItemsDestroy: (items: Item[], ctx: OnBeforeItemsDestroyCtx) => MaybePromise<boolean>;
 };
+export type OnBeforeItemsDestroyCtx = Ctx;
 export {};

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

@@ -9,6 +9,7 @@ export type OnBeforeItemsPublishHook = {
      *
      * @tag beforeHooks
      */
-    onBeforeItemsPublish: (items: Item[], ctx: Ctx) => MaybePromise<boolean>;
+    onBeforeItemsPublish: (items: Item[], ctx: OnBeforeItemsPublishCtx) => MaybePromise<boolean>;
 };
+export type OnBeforeItemsPublishCtx = Ctx;
 export {};

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

@@ -9,6 +9,7 @@ export type OnBeforeItemsUnpublishHook = {
      *
      * @tag beforeHooks
      */
-    onBeforeItemsUnpublish: (items: Item[], ctx: Ctx) => MaybePromise<boolean>;
+    onBeforeItemsUnpublish: (items: Item[], ctx: OnBeforeItemsUnpublishCtx) => MaybePromise<boolean>;
 };
+export type OnBeforeItemsUnpublishCtx = Ctx;
 export {};

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

@@ -10,9 +10,9 @@ export type OverrideFieldExtensionsHook = {
      *
      * @tag forcedFieldExtensions
      */
-    overrideFieldExtensions: (field: Field, ctx: OverrideFieldExtensionsHookCtx) => FieldExtensionOverride | undefined;
+    overrideFieldExtensions: (field: Field, ctx: OverrideFieldExtensionsCtx) => FieldExtensionOverride | undefined;
 };
-export type OverrideFieldExtensionsHookCtx = Ctx<{
+export type OverrideFieldExtensionsCtx = Ctx<{
     itemType: ItemType;
 }>;
 /**

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

@@ -1,5 +1,11 @@
 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', {

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

@@ -1 +1 @@
-{"version":3,"file":"renderItemCollectionOutlet.js","sourceRoot":"","sources":["../../../src/hooks/renderItemCollectionOutlet.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,+BAA+B,EAAE,MAAM,UAAU,CAAC;AAiB3D,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"}
+{"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

@@ -2,10 +2,10 @@ import { ItemFormAdditionalMethods, ItemFormAdditionalProperties } from '../ctx/
 import { SelfResizingPluginFrameCtx } from '../ctx/pluginFrame';
 export type RenderItemFormOutletHook = {
     /**
-     * This function will be called when the plugin needs to render an outlet (see
-     * the `itemFormOutlets` function)
+     * This function will be called when the plugin needs to render an outlet
+     * defined by the `itemFormOutlets()` hook.
      *
-     * @tag itemFormOutlets
+     * @tag outlets
      */
     renderItemFormOutlet: (itemFormOutletId: string, ctx: RenderItemFormOutletCtx) => void;
 };

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

@@ -7,8 +7,9 @@ export type SettingsAreaSidebarItemGroupsHook = {
      *
      * @tag pages
      */
-    settingsAreaSidebarItemGroups: (ctx: Ctx) => SettingsAreaSidebarItemGroup[];
+    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

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

@@ -6,8 +6,9 @@ export type UploadSidebarPanelsHook = {
      *
      * @tag sidebarPanels
      */
-    uploadSidebarPanels: (ctx: Ctx) => UploadSidebarPanel[];
+    uploadSidebarPanels: (ctx: UploadSidebarPanelsCtx) => UploadSidebarPanel[];
 };
+export type UploadSidebarPanelsCtx = Ctx;
 export type UploadSidebarPanel = {
     /**
      * ID of the panel. Will be the first argument for the

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

@@ -6,8 +6,9 @@ export type UploadSidebarsHook = {
      *
      * @tag sidebarPanels
      */
-    uploadSidebars: (ctx: Ctx) => UploadSidebar[];
+    uploadSidebars: (ctx: UploadSidebarsCtx) => UploadSidebar[];
 };
+export type UploadSidebarsCtx = Ctx;
 export type UploadSidebar = {
     /**
      * ID of the sidebar. Will be the first argument for the

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

@@ -1,5 +1,19 @@
 import { Ctx } from '../ctx/base';
 import { DropdownAction, DropdownActionGroup } from '../shared';
 export type UploadsDropdownActionsHook = {
-    uploadsDropdownActions: (ctx: Ctx) => Array<DropdownAction | DropdownActionGroup>;
+    /**
+     * This function lets you set up custom actions (or groups of actions) that
+     * show up when the user:
+     *
+     * * selects multiple assets in the Media Area for batch operations, or
+     * * opens up a specific asset from the Media Area.
+     *
+     * The `executeUploadsDropdownAction()` hook will be triggered once the user
+     * clicks on one of the defined actions.
+     *
+     * @tag dropdownActions
+     */
+    uploadsDropdownActions: (ctx: UploadsDropdownActionsCtx) => Array<DropdownAction | DropdownActionGroup>;
 };
+type UploadsDropdownActionsCtx = Ctx;
+export {};