datocms-plugin-sdk 2.0.1 → 2.0.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "datocms-plugin-sdk",
-  "version": "2.0.1",
+  "version": "2.0.3",
   "description": "DatoCMS Plugin SDK",
   "keywords": [
     "datocms",
@@ -45,5 +45,5 @@
     "glob": "^11.0.0",
     "typescript": "^5.6.2"
   },
-  "gitHead": "8db42fb5778d563908adb0e06c334f49bb207cd4"
+  "gitHead": "b505f6681411e687cd6908661d73670ecaf8a584"
 }

package/src/ctx/base.ts

@@ -60,7 +60,7 @@ type ProjectProperties = {
   /** The ID of the current environment */
   environment: string;
 
-  /** The account that is the project owner */
+  /** The account/organization that is the project owner */
   owner: Account | Organization;
 
   /**

package/src/ctx/commonExtras/field.ts

@@ -3,6 +3,10 @@ import type { SchemaTypes } from '@datocms/cma-client';
 type Field = SchemaTypes.Field;
 type ItemType = SchemaTypes.ItemType;
 
+/**
+ * These information describe the current state of the field where this plugin
+ * is applied to.
+ */
 export type FieldAdditionalProperties = {
   /** Whether the field is currently disabled or not */
   disabled: boolean;

package/src/ctx/commonExtras/itemForm.ts

@@ -25,19 +25,22 @@ export type ItemFormAdditionalProperties = {
   isSubmitting: boolean;
   /** Whether the form has some non-persisted changes or not */
   isFormDirty: boolean;
-  /** Current number of blocks present in form state */
-  blocksAnalysis: {
-    usage: {
-      /** Total number of blocks present in form state */
-      total: number;
-      /** Total number of blocks present in non-localized fields */
-      nonLocalized: number;
-      /** Total number of blocks present in localized fields, per locale */
-      perLocale: Record<string, number>;
-    };
-    /** Maximum number of blocks per item */
-    maximumPerItem: number;
+  /** Provides information on how many blocks are currently present in the form */
+  blocksAnalysis: BlocksAnalysis;
+};
+
+/** Current number of blocks present in form state */
+export type BlocksAnalysis = {
+  usage: {
+    /** Total number of blocks present in form state */
+    total: number;
+    /** Total number of blocks present in non-localized fields */
+    nonLocalized: number;
+    /** Total number of blocks present in localized fields, per locale */
+    perLocale: Record<string, number>;
   };
+  /** Maximum number of blocks per item */
+  maximumPerItem: number;
 };
 
 /**

package/src/ctx/commonExtras/sizing.ts

@@ -1,3 +1,4 @@
+/** A number of methods that you can use to control the size of the plugin frame */
 export type SizingUtilities = {
   /**
    * Listens for DOM changes and automatically calls `setHeight` when it detects

package/src/hooks/renderItemFormSidebar.ts

@@ -8,7 +8,7 @@ import { fullScreenRenderModeBootstrapper } from '../utils';
 export type RenderItemFormSidebarHook = {
   /**
    * This function will be called when the plugin needs to render a sidebar (see
-   * the `itemFormSidebars` function)
+   * the `itemFormSidebars` hook)
    *
    * @tag sidebarPanels
    */

package/src/hooks/renderItemFormSidebarPanel.ts

@@ -8,7 +8,7 @@ import { containedRenderModeBootstrapper } from '../utils';
 export type RenderItemFormSidebarPanelHook = {
   /**
    * This function will be called when the plugin needs to render a sidebar panel
-   * (see the `itemFormSidebarPanels` function)
+   * (see the `itemFormSidebarPanels` hook)
    *
    * @tag sidebarPanels
    */

package/src/hooks/renderManualFieldExtensionConfigScreen.ts

@@ -23,12 +23,12 @@ export type RenderManualFieldExtensionConfigScreenCtx =
       fieldExtensionId: string;
       /**
        * The current value of the parameters (you can change the value with the
-       * `setParameters` function)
+       * `setParameters` hook)
        */
       parameters: Record<string, unknown>;
       /**
        * The current validation errors for the parameters (you can set them
-       * implementing the `validateManualFieldExtensionParameters` function)
+       * implementing the `validateManualFieldExtensionParameters` hook)
        */
       errors: Record<string, unknown>;
 

package/src/hooks/renderModal.ts

@@ -4,7 +4,7 @@ import { containedRenderModeBootstrapper } from '../utils';
 export type RenderModalHook = {
   /**
    * This function will be called when the plugin requested to open a modal (see
-   * the `openModal` function)
+   * the `openModal` hook)
    *
    * @tag modals
    */

package/src/hooks/renderUploadSidebar.ts

@@ -7,7 +7,7 @@ type Upload = SchemaTypes.Upload;
 export type RenderUploadSidebarHook = {
   /**
    * This function will be called when the plugin needs to render a sidebar (see
-   * the `uploadSidebars` function)
+   * the `uploadSidebars` hook)
    *
    * @tag sidebarPanels
    */

package/src/hooks/renderUploadSidebarPanel.ts

@@ -7,7 +7,7 @@ type Upload = SchemaTypes.Upload;
 export type RenderUploadSidebarPanelHook = {
   /**
    * This function will be called when the plugin needs to render a sidebar panel
-   * (see the `uploadSidebarPanels` function)
+   * (see the `uploadSidebarPanels` hook)
    *
    * @tag sidebarPanels
    */