datocms-plugin-sdk 2.0.1 → 2.0.2

package/package.json

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

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