datocms-plugin-sdk 0.6.7 → 0.6.10

package/dist/types/connect.d.ts

@@ -41,19 +41,22 @@ export declare type FullConnectParameters = {
      */
     onBoot: (ctx: OnBootCtx) => void;
     /**
-     * Use this function to declare new tabs you want to add in the top-bar of the UI
+     * Use this function to declare new tabs you want to add in the top-bar of the
+     * UI
      *
      * @group pages
      */
     mainNavigationTabs: (ctx: IntentCtx) => MainNavigationTab[];
     /**
-     * Use this function to declare new navigation sections in the Settings Area sidebar
+     * Use this function to declare new navigation sections in the Settings Area
+     * sidebar
      *
      * @group pages
      */
     settingsAreaSidebarItemGroups: (ctx: IntentCtx) => SettingsAreaSidebarItemGroup[];
     /**
-     * Use this function to declare new navigation items in the Content Area sidebar
+     * Use this function to declare new navigation items in the Content Area
+     * sidebar
      *
      * @group pages
      */
@@ -152,14 +155,16 @@ export declare type FullConnectParameters = {
     renderAssetSource: (assetSourceId: string, ctx: RenderAssetSourceCtx) => void;
     /**
      * This function will be called when the plugin needs to render a field
-     * extension (see the `manualFieldExtensions` and `overrideFieldExtensions` functions)
+     * extension (see the `manualFieldExtensions` and `overrideFieldExtensions`
+     * functions)
      *
      * @group forcedFieldExtensions
      */
     renderFieldExtension: (fieldExtensionId: string, ctx: RenderFieldExtensionCtx) => void;
     /**
      * This function will be called when the plugin needs to render the
-     * configuration form for installing a field extension inside a particular field
+     * configuration form for installing a field extension inside a particular
+     * field
      *
      * @group manualFieldExtensions
      */

package/dist/types/types.d.ts

@@ -120,7 +120,8 @@ export declare type FieldType = 'boolean' | 'color' | 'date_time' | 'date' | 'fi
 /**
  * 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
- * (`editor` or `addon`) they will be shown in different places of the interface.
+ * (`editor` or `addon`) they will be shown in different places of the
+ * interface.
  */
 export declare type ManualFieldExtension = {
     /**
@@ -158,7 +159,10 @@ export declare type ManualFieldExtension = {
     configurable?: boolean | {
         initialHeight: number;
     };
-    /** The initial height to set for the iframe that will render the field extension */
+    /**
+     * The initial height to set for the iframe that will render the field
+     * extension
+     */
     initialHeight?: number;
 };
 export declare type ItemFormSidebarPanelPlacement = [
@@ -176,7 +180,8 @@ export declare type ItemFormSidebarPanel = {
     label: string;
     /**
      * An arbitrary configuration object that will be passed as the `parameters`
-     * property of the second argument of the `renderItemFormSidebarPanel` function
+     * property of the second argument of the `renderItemFormSidebarPanel`
+     * function
      */
     parameters?: Record<string, unknown>;
     /** Whether the sidebar panel will start open or collapsed */
@@ -200,7 +205,10 @@ export declare type ItemFormSidebarPanel = {
 };
 /** An outlet to be shown at the top of a record's editing page */
 export declare type ItemFormOutlet = {
-    /** ID of the outlet. Will be the first argument for the `renderItemFormOutlet` function */
+    /**
+     * ID of the outlet. Will be the first argument for the `renderItemFormOutlet`
+     * function
+     */
     id: string;
     /**
      * Multiple outlets will be sorted by ascending `rank`. If you want to specify
@@ -219,7 +227,10 @@ export declare type EditorOverride = {
      * `renderFieldExtension` function
      */
     id: string;
-    /** Moves the field to the sidebar of the record editing page, mimicking a sidebar panel */
+    /**
+     * Moves the field to the sidebar of the record editing page, mimicking a
+     * sidebar panel
+     */
     asSidebarPanel?: boolean | {
         startOpen?: boolean;
         placement?: ItemFormSidebarPanelPlacement;
@@ -237,7 +248,10 @@ export declare type EditorOverride = {
      * another plugin!
      */
     rank?: number;
-    /** The initial height to set for the iframe that will render the field extension */
+    /**
+     * The initial height to set for the iframe that will render the field
+     * extension
+     */
     initialHeight?: number;
 };
 /** A field addon extension forced on a field */
@@ -260,7 +274,10 @@ export declare type AddonOverride = {
      * the one of another plugin!
      */
     rank?: number;
-    /** The initial height to set for the iframe that will render the field extension */
+    /**
+     * The initial height to set for the iframe that will render the field
+     * extension
+     */
     initialHeight?: number;
 };
 export declare type StructuredTextCustomMarkPlacement = [
@@ -320,7 +337,10 @@ export declare type StructuredTextCustomBlockStyle = {
      */
     rank?: number;
 };
-/** An object expressing some field extensions you want to force on a particular field */
+/**
+ * An object expressing some field extensions you want to force on a particular
+ * field
+ */
 export declare type FieldExtensionOverride = {
     /** Force a field editor/sidebar extension on a field */
     editor?: EditorOverride;
@@ -396,7 +416,10 @@ export declare type AssetSource = {
     modal?: {
         /** Width of the modal. Can be a number, or one of the predefined sizes */
         width?: 's' | 'm' | 'l' | 'xl' | number;
-        /** The initial height to set for the iframe that will render the modal content */
+        /**
+         * The initial height to set for the iframe that will render the modal
+         * content
+         */
         initialHeight?: number;
     };
 };
@@ -433,7 +456,10 @@ export declare type ConfirmChoice = {
      * clicked by the user
      */
     value: unknown;
-    /** The intent of the button. Will present the button in a different color accent. */
+    /**
+     * The intent of the button. Will present the button in a different color
+     * accent.
+     */
     intent?: 'positive' | 'negative';
 };
 /** Options for the `openConfirm` function */
@@ -707,7 +733,10 @@ export declare type LoadDataMethods = {
      */
     loadSsoUsers: () => Promise<SsoUser[]>;
 };
-/** These methods let you open the standard DatoCMS dialogs needed to interact with records */
+/**
+ * These methods let you open the standard DatoCMS dialogs needed to interact
+ * with records
+ */
 export declare type ItemDialogMethods = {
     /**
      * Opens a dialog for creating a new record. It returns a promise resolved
@@ -778,7 +807,10 @@ export declare type ItemDialogMethods = {
      */
     editItem: (itemId: string) => Promise<Item | null>;
 };
-/** These methods can be used to show UI-consistent toast notifications to the end-user */
+/**
+ * These methods can be used to show UI-consistent toast notifications to the
+ * end-user
+ */
 export declare type ToastMethods = {
     /**
      * Triggers an "error" toast displaying the selected message
@@ -811,7 +843,8 @@ export declare type ToastMethods = {
      */
     notice: (message: string) => Promise<void>;
     /**
-     * Triggers a custom toast displaying the selected message (and optionally a CTA)
+     * Triggers a custom toast displaying the selected message (and optionally a
+     * CTA)
      *
      * @example
      *
@@ -865,7 +898,8 @@ export declare type UploadDialogMethods = {
         }): Promise<Upload | null>;
     };
     /**
-     * Opens a dialog for editing a Media Area asset. It returns a promise resolved with:
+     * Opens a dialog for editing a Media Area asset. It returns a promise
+     * resolved with:
      *
      * - The updated asset, if the user persists some changes to the asset itself
      * - `null`, if the user closes the dialog without persisting any change
@@ -1008,7 +1042,10 @@ export declare type RenderMethods = LoadDataMethods & UpdateParametersMethods &
 export declare type ItemFormAdditionalProperties = {
     /** The currently active locale for the record */
     locale: string;
-    /** If an already persisted record is being edited, returns the full record entity */
+    /**
+     * If an already persisted record is being edited, returns the full record
+     * entity
+     */
     item: Item | null;
     /** The model for the record being edited */
     itemType: ItemType;
@@ -1072,7 +1109,8 @@ export declare type ItemFormAdditionalMethods = {
     disableField: (path: string, disable: boolean) => Promise<void>;
     /**
      * Smoothly navigates to a specific field in the form. If the field is
-     * localized it will switch language tab and then navigate to the chosen field.
+     * localized it will switch language tab and then navigate to the chosen
+     * field.
      *
      * @example
      *
@@ -1156,7 +1194,10 @@ export declare type RenderFieldExtensionAdditionalProperties = {
     placeholder: string;
     /** Whether the field is currently disabled or not */
     disabled: boolean;
-    /** The path in the `formValues` object where to find the current value for the field */
+    /**
+     * The path in the `formValues` object where to find the current value for the
+     * field
+     */
     fieldPath: string;
     /** The field where the field extension is installed to */
     field: Field;
@@ -1186,7 +1227,10 @@ export declare type RenderModalAdditionalProperties = {
     mode: 'renderModal';
     /** The ID of the modal that needs to be rendered */
     modalId: string;
-    /** The arbitrary `parameters` of the modal declared in the `openModal` function */
+    /**
+     * The arbitrary `parameters` of the modal declared in the `openModal`
+     * function
+     */
     parameters: Record<string, unknown>;
 };
 export declare type RenderModalProperties = RenderProperties & RenderModalAdditionalProperties;
@@ -1212,7 +1256,10 @@ export declare type RenderModalAdditionalMethods = {
 };
 export declare type RenderModalMethods = RenderMethods & IframeMethods & RenderModalAdditionalMethods;
 export declare type RenderModalPropertiesAndMethods = RenderModalMethods & RenderModalProperties;
-/** Information regarding the specific asset source browser that you need to render */
+/**
+ * Information regarding the specific asset source browser that you need to
+ * render
+ */
 export declare type RenderAssetSourceAdditionalProperties = {
     mode: 'renderAssetSource';
     /** The ID of the assetSource that needs to be rendered */
@@ -1291,8 +1338,7 @@ export declare type RenderAssetSourceAdditionalMethods = {
      * ```js
      * await ctx.select({
      *   resource: {
-     *     url:
-     *       'https://images.unsplash.com/photo-1416339306562-f3d12fefd36f',
+     *     url: 'https://images.unsplash.com/photo-1416339306562-f3d12fefd36f',
      *     filename: 'man-drinking-coffee.jpg',
      *   },
      *   copyright: 'Royalty free (Unsplash)',
@@ -1338,7 +1384,10 @@ export declare type PendingField = {
  */
 export declare type RenderManualFieldExtensionConfigScreenAdditionalProperties = {
     mode: 'renderManualFieldExtensionConfigScreen';
-    /** The ID of the field extension for which we need to render the parameters form */
+    /**
+     * The ID of the field extension for which we need to render the parameters
+     * form
+     */
     fieldExtensionId: string;
     /**
      * The current value of the parameters (you can change the value with the

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "datocms-plugin-sdk",
-  "version": "0.6.7",
+  "version": "0.6.10",
   "description": "DatoCMS Plugin SDK",
   "keywords": [
     "datocms",
@@ -41,7 +41,7 @@
     "penpal": "^4.1.1"
   },
   "devDependencies": {
-    "typedoc": "^0.22.8"
+    "typedoc": "^0.23.20"
   },
-  "gitHead": "7f0954ee55baae51573b12bddaa8d6ddde6d94c6"
+  "gitHead": "ee402f7da5c79a0675995519c792000bb220bc7a"
 }