datocms-plugin-sdk 0.6.15-alpha.0 → 0.6.15

package/src/connect.ts

@@ -1,5 +1,11 @@
 import connectToParent from 'penpal/lib/connectToParent';
-import { Field, Item, ItemType } from './SiteApiSchema';
+import {
+  Field,
+  Item,
+  ItemCreateSchema,
+  ItemType,
+  ItemUpdateSchema,
+} from './SiteApiSchema';
 import {
   AssetSource,
   ContentAreaSidebarItem,
@@ -27,7 +33,6 @@ import {
   SettingsAreaSidebarItemGroup,
 } from './types';
 import {
-  isInitParent,
   isOnBootParent,
   isRenderAssetSourceParent,
   isRenderConfigScreenParent,
@@ -86,6 +91,8 @@ export type RenderManualFieldExtensionConfigScreenCtx =
 export type RenderConfigScreenCtx = RenderConfigScreenPropertiesAndMethods &
   SizingUtilities;
 
+type MaybePromise<T> = T | Promise<T>;
+
 /** The full options you can pass to the `connect` function */
 export type FullConnectParameters = {
   /**
@@ -97,44 +104,48 @@ export type FullConnectParameters = {
   onBoot: (ctx: OnBootCtx) => void;
 
   /**
-   * This function will be called before destroying a record. You can stop the
+   * This function will be called before destroying records. You can stop the
    * action by returning `false`
    *
    * @tag beforeHooks
    */
-  onBeforeItemDestroy: (item: Item, ctx: OnBootCtx) => Promise<boolean>;
-
-  /**
-   * This function will be called before saving a new version of a record. You
-   * can stop the action by returning `false`
-   *
-   * @tag beforeHooks
-   */
-  onBeforeItemSave: (item: Item, ctx: OnBootCtx) => Promise<boolean>;
+  onBeforeItemsDestroy: (
+    items: Item[],
+    ctx: OnBootCtx,
+  ) => MaybePromise<boolean>;
 
   /**
-   * This function will be called before publishing a record. You can stop the
+   * This function will be called before publishing records. You can stop the
    * action by returning `false`
    *
    * @tag beforeHooks
    */
-  onBeforeItemPublish: (item: Item, ctx: OnBootCtx) => Promise<boolean>;
+  onBeforeItemsPublish: (
+    items: Item[],
+    ctx: OnBootCtx,
+  ) => MaybePromise<boolean>;
 
   /**
-   * This function will be called before unpublishing a record. You can stop the
+   * This function will be called before unpublishing records. You can stop the
    * action by returning `false`
    *
    * @tag beforeHooks
    */
-  onBeforeItemUnpublish: (item: Item, ctx: OnBootCtx) => Promise<boolean>;
+  onBeforeItemsUnpublish: (
+    items: Item[],
+    ctx: OnBootCtx,
+  ) => MaybePromise<boolean>;
 
   /**
-   * This function will be called before duplicating a record. You can stop the
-   * action by returning `false`
+   * This function will be called before saving a new version of a record. You
+   * can stop the action by returning `false`
    *
    * @tag beforeHooks
    */
-  onBeforeItemDuplicate: (item: Item, ctx: OnBootCtx) => Promise<boolean>;
+  onBeforeItemUpsert: (
+    createOrUpdateItemPayload: ItemUpdateSchema | ItemCreateSchema,
+    ctx: OnBootCtx,
+  ) => MaybePromise<boolean>;
 
   /**
    * Use this function to declare new tabs you want to add in the top-bar of the
@@ -332,17 +343,13 @@ function toMultifield<Result>(
   };
 }
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
 type AsyncReturnType<T extends (...args: any) => any> = T extends (
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   ...args: any
 ) => Promise<infer U>
   ? U
-  : // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  T extends (...args: any) => infer U
+  : T extends (...args: any) => infer U
   ? U
-  : // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    any;
+  : any;
 
 function getMaxScrollHeight() {
   const elements = document.querySelectorAll('body *');
@@ -428,15 +435,15 @@ export async function connect(
     manualFieldExtensions,
     itemFormSidebarPanels,
     itemFormOutlets,
-    onBeforeItemDestroy,
-    onBeforeItemPublish,
-    onBeforeItemUnpublish,
-    onBeforeItemSave,
-    onBeforeItemDuplicate,
   } = configuration;
-
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   let listener: ((newSettings: any) => void) | null = null;
+  let callMethodMergingBootCtxExecutor:
+    | ((
+        methodName: string,
+        methodArgs: any[],
+        extraCtx: Record<string, any>,
+      ) => void)
+    | null = null;
 
   const penpalConnection = connectToParent({
     methods: {
@@ -458,11 +465,6 @@ export async function connect(
       manualFieldExtensions,
       itemFormSidebarPanels,
       itemFormOutlets,
-      onBeforeItemDestroy,
-      onBeforeItemPublish,
-      onBeforeItemUnpublish,
-      onBeforeItemSave,
-      onBeforeItemDuplicate,
       overrideFieldExtensions: toMultifield(
         configuration.overrideFieldExtensions,
       ),
@@ -472,39 +474,61 @@ export async function connect(
       customBlockStylesForStructuredTextField: toMultifield(
         configuration.customBlockStylesForStructuredTextField,
       ),
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
       onChange(newSettings: any) {
         if (listener) {
           listener(newSettings);
         }
       },
-      validateManualFieldExtensionParameters:
-        configuration.validateManualFieldExtensionParameters,
+      callMethodMergingBootCtx(
+        methodName: string,
+        methodArgs: any[],
+        extraCtx: Record<string, any>,
+      ) {
+        if (!callMethodMergingBootCtxExecutor) {
+          return null;
+        }
+        return callMethodMergingBootCtxExecutor(
+          methodName,
+          methodArgs,
+          extraCtx,
+        );
+      },
     },
   });
 
   const parent: Parent = await penpalConnection.promise;
   const initialSettings = await parent.getSettings();
 
-  if (isInitParent(parent, initialSettings)) {
-    // Nothing to do. Parent calls the method they need.
-  }
-
   if (isOnBootParent(parent, initialSettings)) {
     type Settings = AsyncReturnType<OnBootMethods['getSettings']>;
+    let currentSettings = initialSettings as Settings;
 
-    const render = (settings: Settings) => {
-      if (!configuration.onBoot) {
-        return;
+    listener = (newSettings: Settings) => {
+      currentSettings = newSettings;
+    };
+
+    callMethodMergingBootCtxExecutor = (
+      methodName: string,
+      methodArgs: any[],
+      extraCtx: Record<string, any>,
+    ) => {
+      if (!(methodName in configuration)) {
+        return undefined;
       }
 
-      configuration.onBoot({
+      return (configuration as any)[methodName](...methodArgs, {
         ...parent,
-        ...settings,
+        ...currentSettings,
+        ...extraCtx,
       });
     };
 
-    render(initialSettings as Settings);
+    if (configuration.onBoot) {
+      configuration.onBoot({
+        ...parent,
+        ...currentSettings,
+      });
+    }
   }
 
   if (isRenderPageParent(parent, initialSettings)) {

package/src/guards.ts

@@ -1,6 +1,5 @@
 import { RenderItemFormOutletMethods } from '.';
 import {
-  InitMethods,
   OnBootMethods,
   RenderPageMethods,
   RenderFieldExtensionMethods,
@@ -18,8 +17,6 @@ function buildGuard<P extends Parent>(mode: string) {
     settings.mode === mode;
 }
 
-export const isInitParent = buildGuard<InitMethods>('init');
-
 export const isOnBootParent = buildGuard<OnBootMethods>('onBoot');
 
 export const isRenderPageParent = buildGuard<RenderPageMethods>('renderPage');