datocms-plugin-sdk 0.7.15 → 0.8.2

package/dist/esm/types.d.ts

@@ -1217,6 +1217,33 @@ export declare type ItemFormAdditionalMethods = {
      * ```
      */
     setFieldValue: (path: string, value: unknown) => Promise<void>;
+    /**
+     * Takes the internal form state, and transforms it into an Item entity
+     * compatible with DatoCMS API.
+     *
+     * When `skipUnchangedFields`, only the fields that changed value will be
+     * serialized.
+     *
+     * If the required nested blocks are still not loaded, this method will return
+     * `undefined`.
+     *
+     * @example
+     *
+     * ```js
+     * await ctx.formValuesToItem(ctx.formValues, false);
+     * ```
+     */
+    formValuesToItem: (formValues: Record<string, unknown>, skipUnchangedFields?: boolean) => Promise<Omit<Item, 'id' | 'meta'> | undefined>;
+    /**
+     * Takes an Item entity, and converts it into the internal form state
+     *
+     * @example
+     *
+     * ```js
+     * await ctx.itemToFormValues(ctx.item);
+     * ```
+     */
+    itemToFormValues: (item: Omit<Item, 'id' | 'meta'>) => Promise<Record<string, unknown>>;
     /**
      * Triggers a submit form for current record
      *

package/dist/types/types.d.ts

@@ -1217,6 +1217,33 @@ export declare type ItemFormAdditionalMethods = {
      * ```
      */
     setFieldValue: (path: string, value: unknown) => Promise<void>;
+    /**
+     * Takes the internal form state, and transforms it into an Item entity
+     * compatible with DatoCMS API.
+     *
+     * When `skipUnchangedFields`, only the fields that changed value will be
+     * serialized.
+     *
+     * If the required nested blocks are still not loaded, this method will return
+     * `undefined`.
+     *
+     * @example
+     *
+     * ```js
+     * await ctx.formValuesToItem(ctx.formValues, false);
+     * ```
+     */
+    formValuesToItem: (formValues: Record<string, unknown>, skipUnchangedFields?: boolean) => Promise<Omit<Item, 'id' | 'meta'> | undefined>;
+    /**
+     * Takes an Item entity, and converts it into the internal form state
+     *
+     * @example
+     *
+     * ```js
+     * await ctx.itemToFormValues(ctx.item);
+     * ```
+     */
+    itemToFormValues: (item: Omit<Item, 'id' | 'meta'>) => Promise<Record<string, unknown>>;
     /**
      * Triggers a submit form for current record
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "datocms-plugin-sdk",
-  "version": "0.7.15",
+  "version": "0.8.2",
   "description": "DatoCMS Plugin SDK",
   "keywords": [
     "datocms",
@@ -44,5 +44,5 @@
   "devDependencies": {
     "typedoc": "^0.23.20"
   },
-  "gitHead": "5d21c006626fb71e79cbf29a3b7398b9e896ce10"
+  "gitHead": "cd9036995eefda50300a5226e7511ee7f3377cd0"
 }

package/src/types.ts

@@ -1309,6 +1309,38 @@ export type ItemFormAdditionalMethods = {
    * ```
    */
   setFieldValue: (path: string, value: unknown) => Promise<void>;
+  /**
+   * Takes the internal form state, and transforms it into an Item entity
+   * compatible with DatoCMS API.
+   *
+   * When `skipUnchangedFields`, only the fields that changed value will be
+   * serialized.
+   *
+   * If the required nested blocks are still not loaded, this method will return
+   * `undefined`.
+   *
+   * @example
+   *
+   * ```js
+   * await ctx.formValuesToItem(ctx.formValues, false);
+   * ```
+   */
+  formValuesToItem: (
+    formValues: Record<string, unknown>,
+    skipUnchangedFields?: boolean,
+  ) => Promise<Omit<Item, 'id' | 'meta'> | undefined>;
+  /**
+   * Takes an Item entity, and converts it into the internal form state
+   *
+   * @example
+   *
+   * ```js
+   * await ctx.itemToFormValues(ctx.item);
+   * ```
+   */
+  itemToFormValues: (
+    item: Omit<Item, 'id' | 'meta'>,
+  ) => Promise<Record<string, unknown>>;
   /**
    * Triggers a submit form for current record
    *