datocms-plugin-sdk 0.3.26 → 0.3.33

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, Role, Site, SsoUser, Upload, User } from './SiteApiSchema';
 export declare type Icon = string | {
     type: 'svg';
     viewBox: string;
@@ -114,6 +114,7 @@ export declare type ContentAreaSidebarItem = {
     rank?: number;
 };
 export declare type FieldExtensionType = 'editor' | 'addon';
+export declare type FieldType = 'boolean' | 'color' | 'date_time' | 'date' | 'file' | 'float' | 'gallery' | 'integer' | 'json' | 'lat_lon' | 'link' | 'links' | 'rich_text' | 'seo' | 'slug' | 'string' | 'structured_text' | 'text' | 'video';
 /**
  * Field extensions extend the basic functionality of DatoCMS when it comes to
  * presenting record's fields to the final user. Depending on the extension type
@@ -141,8 +142,11 @@ export declare type ManualFieldExtension = {
     asSidebarPanel?: boolean | {
         startOpen: boolean;
     };
-    /** The type of fields that the field extension in compatible with */
-    fieldTypes: NonNullable<PluginAttributes['field_types']>;
+    /**
+     * The type of fields that the field extension in compatible with. You can use
+     * the shortcut `all` to target all types of fields
+     */
+    fieldTypes: 'all' | FieldType[];
     /**
      * Whether this field extension needs some configuration options before being
      * installed in a field or not. Will trigger the
@@ -419,6 +423,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 +571,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, Role, Site, SsoUser, Upload, User } from './SiteApiSchema';
 export declare type Icon = string | {
     type: 'svg';
     viewBox: string;
@@ -114,6 +114,7 @@ export declare type ContentAreaSidebarItem = {
     rank?: number;
 };
 export declare type FieldExtensionType = 'editor' | 'addon';
+export declare type FieldType = 'boolean' | 'color' | 'date_time' | 'date' | 'file' | 'float' | 'gallery' | 'integer' | 'json' | 'lat_lon' | 'link' | 'links' | 'rich_text' | 'seo' | 'slug' | 'string' | 'structured_text' | 'text' | 'video';
 /**
  * Field extensions extend the basic functionality of DatoCMS when it comes to
  * presenting record's fields to the final user. Depending on the extension type
@@ -141,8 +142,11 @@ export declare type ManualFieldExtension = {
     asSidebarPanel?: boolean | {
         startOpen: boolean;
     };
-    /** The type of fields that the field extension in compatible with */
-    fieldTypes: NonNullable<PluginAttributes['field_types']>;
+    /**
+     * The type of fields that the field extension in compatible with. You can use
+     * the shortcut `all` to target all types of fields
+     */
+    fieldTypes: 'all' | FieldType[];
     /**
      * Whether this field extension needs some configuration options before being
      * installed in a field or not. Will trigger the
@@ -419,6 +423,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 +571,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.26",
+  "version": "0.3.33",
   "description": "DatoCMS Plugin SDK",
   "keywords": [
     "datocms",
@@ -20,7 +20,7 @@
   },
   "files": [
     "dist",
-    "sistema",
+    "src",
     "types.json"
   ],
   "repository": {
@@ -41,5 +41,5 @@
   "devDependencies": {
     "typedoc": "^0.22.8"
   },
-  "gitHead": "d69a1acf1fd4bf58604559ffc74be584b51285db"
+  "gitHead": "d3b87c5972cffb40d248f09246211fa772c4244b"
 }