datocms-plugin-sdk 0.3.30 → 0.3.32

package/dist/esm/types.d.ts

@@ -1,4 +1,4 @@
-import { Account, Field, Item, ModelBlock, Plugin, PluginAttributes, Role, Site, SsoUser, Upload, User } from './SiteApiSchema';
+import { Account, Field, Fieldset, Item, ModelBlock, Plugin, PluginAttributes, Role, Site, SsoUser, Upload, User } from './SiteApiSchema';
 export declare type Icon = string | {
     type: 'svg';
     viewBox: string;
@@ -419,6 +419,14 @@ export declare type RenderAdditionalProperties = {
      * to load them.
      */
     fields: Partial<Record<string, Field>>;
+    /**
+     * All the fieldsets currently loaded for the current DatoCMS project, indexed
+     * by ID. It will always contain the current model fields and all the fields
+     * of the blocks it might contain via Modular Content/Structured Text fields.
+     * If some fields you need are not present, use the `loadItemTypeFieldsets`
+     * function to load them.
+     */
+    fieldsets: Partial<Record<string, Fieldset>>;
     /** An object containing the theme colors for the current DatoCMS project */
     theme: Theme;
     /**
@@ -559,6 +567,25 @@ export declare type LoadDataMethods = {
      * ```
      */
     loadItemTypeFields: (itemTypeId: string) => Promise<Field[]>;
+    /**
+     * Loads all the fieldsets for a specific model (or block). Fieldsets will be
+     * returned and will also be available in the the `fieldsets` property.
+     *
+     * @example
+     *
+     * ```js
+     * const itemTypeId = prompt('Please insert a model ID:');
+     *
+     * const fieldsets = await ctx.loadItemTypeFieldsets(itemTypeId);
+     *
+     * ctx.notice(
+     *   `Success! ${fieldsets
+     *     .map((fieldset) => fieldset.attributes.title)
+     *     .join(', ')}`,
+     * );
+     * ```
+     */
+    loadItemTypeFieldsets: (itemTypeId: string) => Promise<Fieldset[]>;
     /**
      * Loads all the fields in the project that are currently using the plugin for
      * one of its manual field extensions.

package/dist/types/types.d.ts

@@ -1,4 +1,4 @@
-import { Account, Field, Item, ModelBlock, Plugin, PluginAttributes, Role, Site, SsoUser, Upload, User } from './SiteApiSchema';
+import { Account, Field, Fieldset, Item, ModelBlock, Plugin, PluginAttributes, Role, Site, SsoUser, Upload, User } from './SiteApiSchema';
 export declare type Icon = string | {
     type: 'svg';
     viewBox: string;
@@ -419,6 +419,14 @@ export declare type RenderAdditionalProperties = {
      * to load them.
      */
     fields: Partial<Record<string, Field>>;
+    /**
+     * All the fieldsets currently loaded for the current DatoCMS project, indexed
+     * by ID. It will always contain the current model fields and all the fields
+     * of the blocks it might contain via Modular Content/Structured Text fields.
+     * If some fields you need are not present, use the `loadItemTypeFieldsets`
+     * function to load them.
+     */
+    fieldsets: Partial<Record<string, Fieldset>>;
     /** An object containing the theme colors for the current DatoCMS project */
     theme: Theme;
     /**
@@ -559,6 +567,25 @@ export declare type LoadDataMethods = {
      * ```
      */
     loadItemTypeFields: (itemTypeId: string) => Promise<Field[]>;
+    /**
+     * Loads all the fieldsets for a specific model (or block). Fieldsets will be
+     * returned and will also be available in the the `fieldsets` property.
+     *
+     * @example
+     *
+     * ```js
+     * const itemTypeId = prompt('Please insert a model ID:');
+     *
+     * const fieldsets = await ctx.loadItemTypeFieldsets(itemTypeId);
+     *
+     * ctx.notice(
+     *   `Success! ${fieldsets
+     *     .map((fieldset) => fieldset.attributes.title)
+     *     .join(', ')}`,
+     * );
+     * ```
+     */
+    loadItemTypeFieldsets: (itemTypeId: string) => Promise<Fieldset[]>;
     /**
      * Loads all the fields in the project that are currently using the plugin for
      * one of its manual field extensions.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "datocms-plugin-sdk",
-  "version": "0.3.30",
+  "version": "0.3.32",
   "description": "DatoCMS Plugin SDK",
   "keywords": [
     "datocms",
@@ -41,5 +41,5 @@
   "devDependencies": {
     "typedoc": "^0.22.8"
   },
-  "gitHead": "ff419344f09be141cc04bf3e3cc28bd5f1d77903"
+  "gitHead": "db31347c59fa5ef6bfc050f36ff89f59846a7952"
 }

package/src/types.ts

@@ -1,6 +1,7 @@
 import {
   Account,
   Field,
+  Fieldset,
   Item,
   ModelBlock,
   Plugin,
@@ -460,6 +461,14 @@ export type RenderAdditionalProperties = {
    * to load them.
    */
   fields: Partial<Record<string, Field>>;
+  /**
+   * All the fieldsets currently loaded for the current DatoCMS project, indexed
+   * by ID. It will always contain the current model fields and all the fields
+   * of the blocks it might contain via Modular Content/Structured Text fields.
+   * If some fields you need are not present, use the `loadItemTypeFieldsets`
+   * function to load them.
+   */
+  fieldsets: Partial<Record<string, Fieldset>>;
   /** An object containing the theme colors for the current DatoCMS project */
   theme: Theme;
   /**
@@ -613,6 +622,25 @@ export type LoadDataMethods = {
    * ```
    */
   loadItemTypeFields: (itemTypeId: string) => Promise<Field[]>;
+  /**
+   * Loads all the fieldsets for a specific model (or block). Fieldsets will be
+   * returned and will also be available in the the `fieldsets` property.
+   *
+   * @example
+   *
+   * ```js
+   * const itemTypeId = prompt('Please insert a model ID:');
+   *
+   * const fieldsets = await ctx.loadItemTypeFieldsets(itemTypeId);
+   *
+   * ctx.notice(
+   *   `Success! ${fieldsets
+   *     .map((fieldset) => fieldset.attributes.title)
+   *     .join(', ')}`,
+   * );
+   * ```
+   */
+  loadItemTypeFieldsets: (itemTypeId: string) => Promise<Fieldset[]>;
   /**
    * Loads all the fields in the project that are currently using the plugin for
    * one of its manual field extensions.