datocms-plugin-sdk 2.0.11 → 2.0.13

package/dist/types/hooks/executeSchemaItemTypeDropdownAction.d.ts

@@ -0,0 +1,20 @@
+import type { SchemaTypes } from '@datocms/cma-client';
+import { Ctx } from '../ctx/base';
+type ItemType = SchemaTypes.ItemType;
+export type ExecuteSchemaItemTypeDropdownActionHook = {
+    /**
+     * Use this function to execute a particular dropdown action defined via
+     * the `schemaItemTypeDropdownActions()` hook.
+     *
+     * @tag dropdownActions
+     */
+    executeSchemaItemTypeDropdownAction: (
+    /** The ID of the action that was requested by the user */
+    actionId: string, 
+    /** The model/block model on which the action should be executed */
+    itemType: ItemType, ctx: ExecuteSchemaItemTypeDropdownActionCtx) => Promise<void>;
+};
+export type ExecuteSchemaItemTypeDropdownActionCtx = Ctx<{
+    parameters: Record<string, unknown> | undefined;
+}>;
+export {};

package/dist/types/hooks/renderPage.d.ts

@@ -12,5 +12,11 @@ export type RenderPageHook = {
 export type RenderPageCtx = ImposedSizePluginFrameCtx<'renderPage', {
     /** The ID of the page that needs to be rendered */
     pageId: string;
+    /** Current page location */
+    location: {
+        pathname: string;
+        search: string;
+        hash: string;
+    };
 }>;
 export declare const renderPageBootstrapper: import("../utils").Bootstrapper<"renderPage">;

package/dist/types/hooks/schemaItemTypeDropdownActions.d.ts

@@ -0,0 +1,17 @@
+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;
+export {};

package/dist/types/index.d.ts

@@ -23,6 +23,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';
@@ -52,6 +53,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/manifest.json

@@ -94,6 +94,29 @@
         "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": {
@@ -236,6 +259,16 @@
                   "lineNumber": 19
                 },
                 "type": "string"
+              },
+              "location": {
+                "comment": {
+                  "markdownText": "Current page location."
+                },
+                "location": {
+                  "filePath": "src/hooks/renderPage.ts",
+                  "lineNumber": 22
+                },
+                "type": "{\n      pathname: string;\n      search: string;\n      hash: string;\n    }"
               }
             }
           }
@@ -2134,6 +2167,45 @@
         "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": {
@@ -2860,13 +2932,23 @@
             },
             "type": "string"
           },
+          "isEnvironmentPrimary": {
+            "comment": {
+              "markdownText": "Whether the current environment is the primary one."
+            },
+            "location": {
+              "filePath": "src/ctx/base.ts",
+              "lineNumber": 64
+            },
+            "type": "boolean"
+          },
           "owner": {
             "comment": {
               "markdownText": "The account/organization that is the project owner."
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 64
+              "lineNumber": 67
             },
             "type": "Account | Organization"
           },
@@ -2877,7 +2959,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 72
+              "lineNumber": 75
             },
             "type": "Account | undefined"
           },
@@ -2887,7 +2969,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 78
+              "lineNumber": 81
             },
             "type": "{\n    /** Preferred locale */\n    locale: string;\n  }"
           },
@@ -2897,7 +2979,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 84
+              "lineNumber": 87
             },
             "type": "Theme"
           }
@@ -2915,7 +2997,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 94
+              "lineNumber": 97
             },
             "type": "Partial<Record<string, ItemType>>"
           },
@@ -2925,7 +3007,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 101
+              "lineNumber": 104
             },
             "type": "Partial<Record<string, Field>>"
           },
@@ -2935,7 +3017,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 108
+              "lineNumber": 111
             },
             "type": "Partial<Record<string, Fieldset>>"
           },
@@ -2945,7 +3027,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 115
+              "lineNumber": 118
             },
             "type": "Partial<Record<string, User>>"
           },
@@ -2955,7 +3037,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 122
+              "lineNumber": 125
             },
             "type": "Partial<Record<string, SsoUser>>"
           }
@@ -2976,7 +3058,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 165
+              "lineNumber": 168
             },
             "type": "(itemTypeId: string) => Promise<Field[]>"
           },
@@ -2987,7 +3069,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 184
+              "lineNumber": 187
             },
             "type": "(itemTypeId: string) => Promise<Fieldset[]>"
           },
@@ -2998,7 +3080,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 201
+              "lineNumber": 204
             },
             "type": "() => Promise<Field[]>"
           },
@@ -3009,7 +3091,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 214
+              "lineNumber": 217
             },
             "type": "() => Promise<User[]>"
           },
@@ -3020,7 +3102,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 227
+              "lineNumber": 230
             },
             "type": "() => Promise<SsoUser[]>"
           }
@@ -3039,7 +3121,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 249
+              "lineNumber": 252
             },
             "type": "(params: Record<string, unknown>) => Promise<void>"
           },
@@ -3050,7 +3132,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 300
+              "lineNumber": 303
             },
             "type": "(\n    fieldId: string,\n    changes: FieldAppearanceChange[],\n  ) => Promise<void>"
           }
@@ -3069,7 +3151,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 405
+              "lineNumber": 408
             },
             "type": "(message: string) => Promise<void>"
           },
@@ -3080,7 +3162,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 420
+              "lineNumber": 423
             },
             "type": "(message: string) => Promise<void>"
           },
@@ -3091,7 +3173,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 444
+              "lineNumber": 447
             },
             "type": "<CtaValue = unknown>(\n    toast: Toast<CtaValue>,\n  ) => Promise<CtaValue | null>"
           }
@@ -3110,7 +3192,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 330
+              "lineNumber": 333
             },
             "type": "(itemTypeId: string) => Promise<Item | null>"
           },
@@ -3121,7 +3203,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 351
+              "lineNumber": 354
             },
             "type": "{\n    (\n      itemTypeId: string,\n      options: { multiple: true; initialLocationQuery?: ItemListLocationQuery },\n    ): Promise<Item[] | null>;\n    (\n      itemTypeId: string,\n      options?: {\n        multiple: false;\n        initialLocationQuery?: ItemListLocationQuery;\n      },\n    ): Promise<Item | null>;\n  }"
           },
@@ -3132,7 +3214,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 383
+              "lineNumber": 386
             },
             "type": "(itemId: string) => Promise<Item | null>"
           }
@@ -3151,7 +3233,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 471
+              "lineNumber": 474
             },
             "type": "{\n    (options: { multiple: true }): Promise<Upload[] | null>;\n    (options?: { multiple: false }): Promise<Upload | null>;\n  }"
           },
@@ -3162,7 +3244,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 499
+              "lineNumber": 502
             },
             "type": "(\n    uploadId: string,\n  ) => Promise<(Upload & { deleted?: true }) | null>"
           },
@@ -3173,7 +3255,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 527
+              "lineNumber": 530
             },
             "type": "(\n    /** The \"single asset\" field structure */\n    fileFieldValue: FileFieldValue,\n    /** Shows metadata information for a specific locale */\n    locale?: string,\n  ) => Promise<FileFieldValue | null>"
           }
@@ -3192,7 +3274,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 558
+              "lineNumber": 561
             },
             "type": "(modal: Modal) => Promise<unknown>"
           },
@@ -3203,7 +3285,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 595
+              "lineNumber": 598
             },
             "type": "(options: ConfirmOptions) => Promise<unknown>"
           }
@@ -3222,7 +3304,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 609
+              "lineNumber": 612
             },
             "type": "(path: string) => Promise<void>"
           }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "datocms-plugin-sdk",
-  "version": "2.0.11",
+  "version": "2.0.13",
   "description": "DatoCMS Plugin SDK",
   "keywords": [
     "datocms",
@@ -45,5 +45,5 @@
     "glob": "^11.0.0",
     "typescript": "^5.6.2"
   },
-  "gitHead": "3f849aa16b3588d7bbd3f44ba07f3bca6eb71626"
+  "gitHead": "1420d4ce991da7c84da85b1b4e1375df19e156d7"
 }

package/src/connect.ts

@@ -7,6 +7,7 @@ import type { CustomMarksForStructuredTextFieldHook } from './hooks/customMarksF
 import type { ExecuteFieldDropdownActionHook } from './hooks/executeFieldDropdownAction';
 import type { ExecuteItemFormDropdownActionHook } from './hooks/executeItemFormDropdownAction';
 import type { ExecuteItemsDropdownActionHook } from './hooks/executeItemsDropdownAction';
+import type { ExecuteSchemaItemTypeDropdownActionHook } from './hooks/executeSchemaItemTypeDropdownAction';
 import type { ExecuteUploadsDropdownActionHook } from './hooks/executeUploadsDropdownAction';
 import type { FieldDropdownActionsHook } from './hooks/fieldDropdownActions';
 import type { InitialLocationQueryForItemSelectorHook } from './hooks/initialLocationQueryForItemSelector';
@@ -66,6 +67,7 @@ import {
   RenderUploadSidebarPanelHook,
   renderUploadSidebarPanelBootstrapper,
 } from './hooks/renderUploadSidebarPanel';
+import type { SchemaItemTypeDropdownActionsHook } from './hooks/schemaItemTypeDropdownActions';
 import type { SettingsAreaSidebarItemGroupsHook } from './hooks/settingsAreaSidebarItemGroups';
 import { UploadSidebarPanelsHook } from './hooks/uploadSidebarPanels';
 import { UploadSidebarsHook } from './hooks/uploadSidebars';
@@ -87,6 +89,7 @@ export type FullConnectParameters = AssetSourcesHook &
   ExecuteFieldDropdownActionHook &
   ExecuteItemFormDropdownActionHook &
   ExecuteItemsDropdownActionHook &
+  ExecuteSchemaItemTypeDropdownActionHook &
   ExecuteUploadsDropdownActionHook &
   FieldDropdownActionsHook &
   InitialLocationQueryForItemSelectorHook &
@@ -116,6 +119,7 @@ export type FullConnectParameters = AssetSourcesHook &
   RenderPageHook &
   RenderUploadSidebarHook &
   RenderUploadSidebarPanelHook &
+  SchemaItemTypeDropdownActionsHook &
   SettingsAreaSidebarItemGroupsHook &
   UploadsDropdownActionsHook &
   UploadSidebarPanelsHook &

package/src/ctx/base.ts

@@ -60,6 +60,9 @@ type ProjectProperties = {
   /** The ID of the current environment */
   environment: string;
 
+  /** Whether the current environment is the primary one */
+  isEnvironmentPrimary: boolean;
+
   /** The account/organization that is the project owner */
   owner: Account | Organization;
 

package/src/hooks/executeSchemaItemTypeDropdownAction.ts

@@ -0,0 +1,24 @@
+import type { SchemaTypes } from '@datocms/cma-client';
+import { Ctx } from '../ctx/base';
+
+type ItemType = SchemaTypes.ItemType;
+
+export type ExecuteSchemaItemTypeDropdownActionHook = {
+  /**
+   * Use this function to execute a particular dropdown action defined via
+   * the `schemaItemTypeDropdownActions()` hook.
+   *
+   * @tag dropdownActions
+   */
+  executeSchemaItemTypeDropdownAction: (
+    /** The ID of the action that was requested by the user */
+    actionId: string,
+    /** The model/block model on which the action should be executed */
+    itemType: ItemType,
+    ctx: ExecuteSchemaItemTypeDropdownActionCtx,
+  ) => Promise<void>;
+};
+
+export type ExecuteSchemaItemTypeDropdownActionCtx = Ctx<{
+  parameters: Record<string, unknown> | undefined;
+}>;

package/src/hooks/renderPage.ts

@@ -17,6 +17,13 @@ export type RenderPageCtx = ImposedSizePluginFrameCtx<
   {
     /** The ID of the page that needs to be rendered */
     pageId: string;
+
+    /** Current page location */
+    location: {
+      pathname: string;
+      search: string;
+      hash: string;
+    };
   }
 >;
 

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';