datocms-plugin-sdk 2.1.0-alpha.0 → 2.1.0-alpha.2

package/dist/cjs/manifest.js

@@ -97,6 +97,29 @@ exports.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: {
@@ -240,6 +263,16 @@ exports.manifest = {
                                 },
                                 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    }',
+                            },
                         },
                     },
                 ],
@@ -1109,6 +1142,140 @@ exports.manifest = {
                 lineNumber: 14,
             },
         },
+        renderInspectorPanel: {
+            name: 'renderInspectorPanel',
+            comment: {
+                markdownText: 'This function will be called when an inspector needs to render a specific\npanel (see the `renderInspector` and `setInspectorMode` functions).',
+                tag: 'inspector',
+            },
+            nonCtxArguments: [
+                {
+                    name: 'panelId',
+                    typeName: 'string',
+                },
+            ],
+            ctxArgument: {
+                type: 'ImposedSizePluginFrameCtx',
+                additionalProperties: [
+                    {
+                        items: {
+                            panelId: {
+                                comment: {
+                                    markdownText: 'The ID of the inspector panel that needs to be rendered.',
+                                },
+                                location: {
+                                    filePath: 'src/hooks/renderInspectorPanel.ts',
+                                    lineNumber: 18,
+                                },
+                                type: 'string',
+                            },
+                            parameters: {
+                                comment: {
+                                    markdownText: 'The arbitrary `parameters` of the modal declared in the `setInspectorMode`\nfunction.',
+                                },
+                                location: {
+                                    filePath: 'src/hooks/renderInspectorPanel.ts',
+                                    lineNumber: 24,
+                                },
+                                type: 'Record<string, unknown>',
+                            },
+                        },
+                    },
+                ],
+                additionalMethods: [],
+            },
+            returnType: 'void',
+            location: {
+                filePath: 'src/hooks/renderInspectorPanel.ts',
+                lineNumber: 11,
+            },
+        },
+        renderInspector: {
+            name: 'renderInspector',
+            comment: {
+                markdownText: 'This function will be called when the plugin needs to render a specific\ninspector. Inspectors provide a side panel interface for displaying and\ninteracting with content alongside a custom interface.',
+                tag: 'inspector',
+                example: "connect({\n  renderInspector(inspectorId, ctx) {\n    render(\n      <div>\n        <h1>Inspector: {inspectorId}</h1>\n        <button onClick={() => ctx.setInspectorMode({\n          type: 'itemEditor',\n          itemId: 'some-item-id'\n        })}>\n          Show Item Editor\n        </button>\n      </div>\n    );\n  }\n});",
+            },
+            nonCtxArguments: [
+                {
+                    name: 'inspectorId',
+                    typeName: 'string',
+                },
+            ],
+            ctxArgument: {
+                type: 'ImposedSizePluginFrameCtx',
+                additionalProperties: [
+                    {
+                        items: {
+                            inspectorId: {
+                                comment: {
+                                    markdownText: 'The ID of the inspector that needs to be rendered.',
+                                },
+                                location: {
+                                    filePath: 'src/hooks/renderInspector.ts',
+                                    lineNumber: 80,
+                                },
+                                type: 'string',
+                            },
+                            highlightedItemId: {
+                                comment: {
+                                    markdownText: 'The ID of the record the currently is highlighted by the user.',
+                                },
+                                location: {
+                                    filePath: 'src/hooks/renderInspector.ts',
+                                    lineNumber: 83,
+                                },
+                                type: 'string | undefined',
+                            },
+                            location: {
+                                comment: {
+                                    markdownText: 'Current page location.',
+                                },
+                                location: {
+                                    filePath: 'src/hooks/renderInspector.ts',
+                                    lineNumber: 86,
+                                },
+                                type: '{\n      pathname: string;\n      search: string;\n      hash: string;\n    }',
+                            },
+                        },
+                    },
+                ],
+                additionalMethods: [
+                    {
+                        items: {
+                            setInspectorMode: {
+                                comment: {
+                                    markdownText: 'Changes the current display mode of the inspector. This allows the plugin\nto dynamically switch between showing a record list, record editor, or custom\npanel within the inspector interface.',
+                                    example: "// Switch to record editor mode\nawait ctx.setInspectorMode({\n  type: 'itemEditor',\n  itemId: 'item-123',\n  fieldPath: 'title'\n});\n\n// Switch to record list mode\nawait ctx.setInspectorMode({ type: 'itemList' });\nawait ctx.setInspectorItemListData({\n  title: 'Related Records',\n  itemIds: ['item-1', 'item-2', 'item-3']\n});\n\n// Switch to custom panel mode\nawait ctx.setInspectorMode({\n  type: 'customPanel',\n  panelId: 'my-custom-panel',\n  parameters: { filter: 'active' }\n});\n\n// Low intent mode change - won't interrupt editing with unsaved changes\nawait ctx.setInspectorMode(\n  { type: 'itemList' },\n  { ignoreIfUnsavedChanges: true }\n);",
+                                },
+                                location: {
+                                    filePath: 'src/hooks/renderInspector.ts',
+                                    lineNumber: 136,
+                                },
+                                type: '(\n      mode: InspectorMode,\n      options?: SetInspectorModeOptions,\n    ) => Promise<void>',
+                            },
+                            setInspectorItemListData: {
+                                comment: {
+                                    markdownText: 'Sets the data for the item list inspector mode.',
+                                    example: "// Set the item list data\nawait ctx.setInspectorItemListData({\n  title: 'Related Records',\n  itemIds: ['item-1', 'item-2', 'item-3']\n});\n\n// Switch to item list mode\nawait ctx.setInspectorMode({ type: 'itemList' });",
+                                },
+                                location: {
+                                    filePath: 'src/hooks/renderInspector.ts',
+                                    lineNumber: 157,
+                                },
+                                type: '(data: {\n      /** The title to show in the inspector header */\n      title: string;\n      /** Array of record IDs to display in the list */\n      itemIds: string[];\n    }) => Promise<void>',
+                            },
+                        },
+                    },
+                ],
+            },
+            returnType: 'void',
+            location: {
+                filePath: 'src/hooks/renderInspector.ts',
+                lineNumber: 73,
+            },
+        },
         renderFieldExtension: {
             name: 'renderFieldExtension',
             comment: {
@@ -1586,7 +1753,7 @@ exports.manifest = {
         onBeforeItemUpsert: {
             name: 'onBeforeItemUpsert',
             comment: {
-                markdownText: 'This function will be called before saving a new version of a record. You\ncan stop the action by returning `false`.',
+                markdownText: 'This hook is called when the user attempts to save a record. You can use it to block record saving.\n\nIf you return `false`, the record will NOT be saved. A small on-page error will say "A plugin blocked the action".\nHowever, for better UX, consider also using `ctx.alert()` to better explain to the user why their save was blocked.\n\nIf you return `true`, the save will proceed as normal.\n\nThis hook runs BEFORE serverside validation. You can use it to do your own additional validation before returning.\nClientside validations are not affected by this hook, since those occur on individual fields\' `onBlur()` events.',
                 tag: 'beforeHooks',
             },
             nonCtxArguments: [
@@ -1597,13 +1764,33 @@ exports.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: 47,
+                                },
+                                type: '(path: string, locale?: string) => Promise<void>',
+                            },
+                        },
+                    },
+                ],
             },
             returnType: 'MaybePromise<boolean>',
             location: {
                 filePath: 'src/hooks/onBeforeItemUpsert.ts',
-                lineNumber: 15,
+                lineNumber: 22,
             },
         },
         manualFieldExtensions: {
@@ -2117,6 +2304,45 @@ exports.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: {
@@ -2843,13 +3069,23 @@ exports.manifest = {
                         },
                         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',
                     },
@@ -2860,7 +3096,7 @@ exports.manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 72,
+                            lineNumber: 75,
                         },
                         type: 'Account | undefined',
                     },
@@ -2870,7 +3106,7 @@ exports.manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 78,
+                            lineNumber: 81,
                         },
                         type: '{\n    /** Preferred locale */\n    locale: string;\n  }',
                     },
@@ -2880,7 +3116,7 @@ exports.manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 84,
+                            lineNumber: 87,
                         },
                         type: 'Theme',
                     },
@@ -2898,7 +3134,7 @@ exports.manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 94,
+                            lineNumber: 97,
                         },
                         type: 'Partial<Record<string, ItemType>>',
                     },
@@ -2908,7 +3144,7 @@ exports.manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 101,
+                            lineNumber: 104,
                         },
                         type: 'Partial<Record<string, Field>>',
                     },
@@ -2918,7 +3154,7 @@ exports.manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 108,
+                            lineNumber: 111,
                         },
                         type: 'Partial<Record<string, Fieldset>>',
                     },
@@ -2928,7 +3164,7 @@ exports.manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 115,
+                            lineNumber: 118,
                         },
                         type: 'Partial<Record<string, User>>',
                     },
@@ -2938,7 +3174,7 @@ exports.manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 122,
+                            lineNumber: 125,
                         },
                         type: 'Partial<Record<string, SsoUser>>',
                     },
@@ -2959,7 +3195,7 @@ exports.manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 165,
+                            lineNumber: 168,
                         },
                         type: '(itemTypeId: string) => Promise<Field[]>',
                     },
@@ -2970,7 +3206,7 @@ exports.manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 184,
+                            lineNumber: 187,
                         },
                         type: '(itemTypeId: string) => Promise<Fieldset[]>',
                     },
@@ -2981,7 +3217,7 @@ exports.manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 201,
+                            lineNumber: 204,
                         },
                         type: '() => Promise<Field[]>',
                     },
@@ -2992,7 +3228,7 @@ exports.manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 214,
+                            lineNumber: 217,
                         },
                         type: '() => Promise<User[]>',
                     },
@@ -3003,7 +3239,7 @@ exports.manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 227,
+                            lineNumber: 230,
                         },
                         type: '() => Promise<SsoUser[]>',
                     },
@@ -3022,7 +3258,7 @@ exports.manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 249,
+                            lineNumber: 252,
                         },
                         type: '(params: Record<string, unknown>) => Promise<void>',
                     },
@@ -3033,7 +3269,7 @@ exports.manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 300,
+                            lineNumber: 303,
                         },
                         type: '(\n    fieldId: string,\n    changes: FieldAppearanceChange[],\n  ) => Promise<void>',
                     },
@@ -3052,7 +3288,7 @@ exports.manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 405,
+                            lineNumber: 408,
                         },
                         type: '(message: string) => Promise<void>',
                     },
@@ -3063,7 +3299,7 @@ exports.manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 420,
+                            lineNumber: 423,
                         },
                         type: '(message: string) => Promise<void>',
                     },
@@ -3074,7 +3310,7 @@ exports.manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 444,
+                            lineNumber: 447,
                         },
                         type: '<CtaValue = unknown>(\n    toast: Toast<CtaValue>,\n  ) => Promise<CtaValue | null>',
                     },
@@ -3093,7 +3329,7 @@ exports.manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 330,
+                            lineNumber: 333,
                         },
                         type: '(itemTypeId: string) => Promise<Item | null>',
                     },
@@ -3104,7 +3340,7 @@ exports.manifest = {
                         },
                         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  }',
                     },
@@ -3115,7 +3351,7 @@ exports.manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 383,
+                            lineNumber: 386,
                         },
                         type: '(itemId: string) => Promise<Item | null>',
                     },
@@ -3134,7 +3370,7 @@ exports.manifest = {
                         },
                         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  }',
                     },
@@ -3145,7 +3381,7 @@ exports.manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 499,
+                            lineNumber: 502,
                         },
                         type: '(\n    uploadId: string,\n  ) => Promise<(Upload & { deleted?: true }) | null>',
                     },
@@ -3156,7 +3392,7 @@ exports.manifest = {
                         },
                         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>',
                     },
@@ -3175,7 +3411,7 @@ exports.manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 558,
+                            lineNumber: 561,
                         },
                         type: '(modal: Modal) => Promise<unknown>',
                     },
@@ -3186,7 +3422,7 @@ exports.manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 595,
+                            lineNumber: 598,
                         },
                         type: '(options: ConfirmOptions) => Promise<unknown>',
                     },
@@ -3205,7 +3441,7 @@ exports.manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 609,
+                            lineNumber: 612,
                         },
                         type: '(path: string) => Promise<void>',
                     },