datocms-plugin-sdk 0.5.2 → 0.6.1-alpha.0

package/src/connect.ts

@@ -1,5 +1,5 @@
 import connectToParent from 'penpal/lib/connectToParent';
-import { Field, ModelBlock } from './SiteApiSchema';
+import { Field, ItemType } from './SiteApiSchema';
 import {
   AssetSource,
   ContentAreaSidebarItem,
@@ -64,12 +64,12 @@ export type SizingUtilities = {
   updateHeight: (newHeight?: number) => void;
 };
 
-export type { Field, ModelBlock };
+export type { Field, ItemType };
 
 export type IntentCtx = InitPropertiesAndMethods;
 export type OnBootCtx = OnBootPropertiesAndMethods;
 export type FieldIntentCtx = InitPropertiesAndMethods & {
-  itemType: ModelBlock;
+  itemType: ItemType;
 };
 export type RenderPageCtx = RenderPagePropertiesAndMethods;
 export type RenderModalCtx = RenderModalPropertiesAndMethods & SizingUtilities;
@@ -136,7 +136,7 @@ export type FullConnectParameters = {
    * @group sidebarPanels
    */
   itemFormSidebarPanels: (
-    itemType: ModelBlock,
+    itemType: ItemType,
     ctx: IntentCtx,
   ) => ItemFormSidebarPanel[];
 
@@ -146,7 +146,7 @@ export type FullConnectParameters = {
    *
    * @group itemFormOutlets
    */
-  itemFormOutlets: (itemType: ModelBlock, ctx: IntentCtx) => ItemFormOutlet[];
+  itemFormOutlets: (itemType: ItemType, ctx: IntentCtx) => ItemFormOutlet[];
 
   /**
    * Use this function to automatically force one or more field extensions to a
@@ -278,7 +278,7 @@ function toMultifield<Result>(
     for (const field of fields) {
       const itemType = ctx.itemTypes[
         field.relationships.item_type.data.id
-      ] as ModelBlock;
+      ] as ItemType;
       result[field.id] = fn(field, { ...ctx, itemType });
     }
 

package/src/index.ts

@@ -2,7 +2,7 @@ import {
   Account,
   Field,
   Item,
-  ModelBlock,
+  ItemType,
   Plugin,
   Site,
   SsoUser,
@@ -15,7 +15,7 @@ export type {
   Account,
   Field,
   Item,
-  ModelBlock,
+  ItemType,
   Plugin,
   Site,
   SsoUser,

package/src/types.ts

@@ -5,7 +5,7 @@ import {
   Field,
   Fieldset,
   Item,
-  ModelBlock,
+  ItemType,
   Plugin,
   Role,
   Site,
@@ -514,7 +514,7 @@ export type CommonProperties = {
   /** The ID of the current environment */
   environment: string;
   /** All the models of the current DatoCMS project, indexed by ID */
-  itemTypes: Partial<Record<string, ModelBlock>>;
+  itemTypes: Partial<Record<string, ItemType>>;
   /**
    * The current DatoCMS user. It can either be the owner or one of the
    * collaborators (regular or SSO).
@@ -1099,7 +1099,7 @@ export type ItemFormAdditionalProperties = {
   /** If an already persisted record is being edited, returns the full record entity */
   item: Item | null;
   /** The model for the record being edited */
-  itemType: ModelBlock;
+  itemType: ItemType;
   /** The complete internal form state */
   formValues: Record<string, unknown>;
   /** The current status of the record being edited */
@@ -1108,6 +1108,15 @@ 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 */
+  blocksUsage: {
+    /** Total number of blocks */
+    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>;
+  };
 };
 
 export type ItemFormProperties = RenderProperties &
@@ -1481,7 +1490,7 @@ export type RenderManualFieldExtensionConfigScreenAdditionalProperties = {
   pendingField: PendingField;
 
   /** The model for the field being edited */
-  itemType: ModelBlock;
+  itemType: ItemType;
 };
 
 export type RenderManualFieldExtensionConfigScreenProperties = RenderProperties &