datocms-plugin-sdk 2.0.9 → 2.0.12

package/src/hooks/onBeforeItemUpsert.ts

@@ -18,4 +18,25 @@ export type OnBeforeItemUpsertHook = {
   ) => MaybePromise<boolean>;
 };
 
-export type OnBeforeItemUpsertCtx = Ctx;
+export type OnBeforeItemUpsertCtx = Ctx<
+  {},
+  {
+    /**
+     * Smoothly navigates to a specific field in the form. If the field is
+     * localized it will switch language tab and then navigate to the chosen
+     * field.
+     *
+     * @example
+     *
+     * ```js
+     * const fieldPath = prompt(
+     *   'Please insert the path of a field in the form',
+     *   ctx.fieldPath,
+     * );
+     *
+     * await ctx.scrollToField(fieldPath);
+     * ```
+     */
+    scrollToField: (path: string, locale?: string) => Promise<void>;
+  }
+>;

package/src/hooks/schemaItemTypeDropdownActions.ts

@@ -0,0 +1,22 @@
+import type { SchemaTypes } from '@datocms/cma-client';
+import { Ctx } from '../ctx/base';
+import { DropdownAction, DropdownActionGroup } from '../shared';
+
+type ItemType = SchemaTypes.ItemType;
+
+export type SchemaItemTypeDropdownActionsHook = {
+  /**
+   * Use this function to define custom actions (or groups of actions) for a model/block model in the Schema section.
+   *
+   * The `executeSchemaItemTypeDropdownAction()` hook will be triggered once the user
+   * clicks on one of the defined actions.
+   *
+   * @tag dropdownActions
+   */
+  schemaItemTypeDropdownActions: (
+    itemType: ItemType,
+    ctx: SchemaItemTypeDropdownActionsCtx,
+  ) => Array<DropdownAction | DropdownActionGroup>;
+};
+
+export type SchemaItemTypeDropdownActionsCtx = Ctx;

package/src/index.ts

@@ -25,6 +25,7 @@ export * from './hooks/customMarksForStructuredTextField';
 export * from './hooks/executeFieldDropdownAction';
 export * from './hooks/executeItemFormDropdownAction';
 export * from './hooks/executeItemsDropdownAction';
+export * from './hooks/executeSchemaItemTypeDropdownAction';
 export * from './hooks/executeUploadsDropdownAction';
 export * from './hooks/fieldDropdownActions';
 export * from './hooks/initialLocationQueryForItemSelector';
@@ -54,6 +55,7 @@ export * from './hooks/renderModal';
 export * from './hooks/renderPage';
 export * from './hooks/renderUploadSidebar';
 export * from './hooks/renderUploadSidebarPanel';
+export * from './hooks/schemaItemTypeDropdownActions';
 export * from './hooks/settingsAreaSidebarItemGroups';
 export * from './hooks/uploadsDropdownActions';
 export * from './hooks/uploadSidebarPanels';

package/src/manifest.ts

@@ -101,6 +101,30 @@ export const manifest: Manifest = {
         lineNumber: 19,
       },
     },
+    schemaItemTypeDropdownActions: {
+      name: 'schemaItemTypeDropdownActions',
+      comment: {
+        markdownText:
+          'Use this function to define custom actions (or groups of actions) for a model/block model in the Schema section.\n\nThe `executeSchemaItemTypeDropdownAction()` hook will be triggered once the user\nclicks on one of the defined actions.',
+        tag: 'dropdownActions',
+      },
+      nonCtxArguments: [
+        {
+          name: 'itemType',
+          typeName: 'ItemType',
+        },
+      ],
+      ctxArgument: {
+        type: 'Ctx',
+        additionalProperties: [],
+        additionalMethods: [],
+      },
+      returnType: 'Array<DropdownAction | DropdownActionGroup>',
+      location: {
+        filePath: 'src/hooks/schemaItemTypeDropdownActions.ts',
+        lineNumber: 16,
+      },
+    },
     renderUploadSidebarPanel: {
       name: 'renderUploadSidebarPanel',
       comment: {
@@ -1722,8 +1746,30 @@ export const manifest: Manifest = {
       ],
       ctxArgument: {
         type: 'Ctx',
-        additionalProperties: [],
-        additionalMethods: [],
+        additionalProperties: [
+          {
+            items: {},
+          },
+        ],
+        additionalMethods: [
+          {
+            items: {
+              scrollToField: {
+                comment: {
+                  markdownText:
+                    'Smoothly navigates to a specific field in the form. If the field is\nlocalized it will switch language tab and then navigate to the chosen\nfield.',
+                  example:
+                    "const fieldPath = prompt(\n  'Please insert the path of a field in the form',\n  ctx.fieldPath,\n);\n\nawait ctx.scrollToField(fieldPath);",
+                },
+                location: {
+                  filePath: 'src/hooks/onBeforeItemUpsert.ts',
+                  lineNumber: 40,
+                },
+                type: '(path: string, locale?: string) => Promise<void>',
+              },
+            },
+          },
+        ],
       },
       returnType: 'MaybePromise<boolean>',
       location: {
@@ -2272,6 +2318,46 @@ export const manifest: Manifest = {
         lineNumber: 13,
       },
     },
+    executeSchemaItemTypeDropdownAction: {
+      name: 'executeSchemaItemTypeDropdownAction',
+      comment: {
+        markdownText:
+          'Use this function to execute a particular dropdown action defined via\nthe `schemaItemTypeDropdownActions()` hook.',
+        tag: 'dropdownActions',
+      },
+      nonCtxArguments: [
+        {
+          name: 'actionId',
+          typeName: 'string',
+        },
+        {
+          name: 'itemType',
+          typeName: 'ItemType',
+        },
+      ],
+      ctxArgument: {
+        type: 'Ctx',
+        additionalProperties: [
+          {
+            items: {
+              parameters: {
+                location: {
+                  filePath: 'src/hooks/executeSchemaItemTypeDropdownAction.ts',
+                  lineNumber: 23,
+                },
+                type: 'Record<string, unknown> | undefined',
+              },
+            },
+          },
+        ],
+        additionalMethods: [],
+      },
+      returnType: 'Promise<void>',
+      location: {
+        filePath: 'src/hooks/executeSchemaItemTypeDropdownAction.ts',
+        lineNumber: 13,
+      },
+    },
     executeItemsDropdownAction: {
       name: 'executeItemsDropdownAction',
       comment: {