datocms-plugin-sdk 2.0.3 → 2.0.5

package/src/hooks/buildItemPresentationInfo.ts

@@ -1,5 +1,6 @@
 import type { SchemaTypes } from '@datocms/cma-client';
 import { Ctx } from '../ctx/base';
+import { isNullish, isNumber, isRecord, isString } from '../guardUtils.js';
 import type { MaybePromise } from '../utils';
 
 type Item = SchemaTypes.Item;
@@ -19,6 +20,11 @@ export type BuildItemPresentationInfoHook = {
 
 export type BuildItemPresentationInfoCtx = Ctx;
 
+/**
+ * An object expressing how a record should be presented in the interface
+ *
+ * @see {isItemPresentationInfo}
+ */
 export type ItemPresentationInfo = {
   /** The title to present the record */
   title: string;
@@ -33,3 +39,19 @@ export type ItemPresentationInfo = {
    */
   rank?: number;
 };
+
+/**
+ * Checks if the value is an ItemPresentationInfo type.
+ * @param value The value to check.
+ * @returns True if the value is an ItemPresentationInfo, false otherwise.
+ */
+export function isItemPresentationInfo(
+  value: unknown,
+): value is ItemPresentationInfo {
+  return (
+    isRecord(value) &&
+    isString(value.title) &&
+    (isNullish(value.imageUrl) || isString(value.imageUrl)) &&
+    (isNullish(value.rank) || isNumber(value.rank))
+  );
+}

package/src/hooks/contentAreaSidebarItems.ts

@@ -1,5 +1,12 @@
 import { Ctx } from '../ctx/base';
-import { Icon } from '../icon';
+import {
+  isNullish,
+  isNumber,
+  isPlacement,
+  isRecord,
+  isString,
+} from '../guardUtils.js';
+import { Icon, isIcon } from '../icon';
 
 export type ContentAreaSidebarItemsHook = {
   /**
@@ -14,6 +21,11 @@ export type ContentAreaSidebarItemsHook = {
 
 export type ContentAreaSidebarItemsCtx = Ctx;
 
+/**
+ * An object expressing an item in the content area sidebar
+ *
+ * @see {isContentAreaSidebarItem}
+ */
 export type ContentAreaSidebarItem = {
   /** Label to be shown. Must be unique. */
   label: string;
@@ -43,3 +55,22 @@ export type ContentAreaSidebarItem = {
    */
   rank?: number;
 };
+
+/**
+ * Checks if the value is a ContentAreaSidebarItem.
+ * @param value - The value to check.
+ * @returns True if the value is a ContentAreaSidebarItem, false otherwise.
+ */
+export function isContentAreaSidebarItem(
+  value: unknown,
+): value is ContentAreaSidebarItem {
+  return (
+    isRecord(value) &&
+    isString(value.label) &&
+    isIcon(value.icon) &&
+    isRecord(value.pointsTo) &&
+    isString(value.pointsTo.pageId) &&
+    (isNullish(value.placement) || isPlacement(value.placement)) &&
+    (isNullish(value.rank) || isNumber(value.rank))
+  );
+}

package/src/hooks/customBlockStylesForStructuredTextField.ts

@@ -1,6 +1,7 @@
 import type { SchemaTypes } from '@datocms/cma-client';
 import { BlockNodeTypeWithCustomStyle } from 'datocms-structured-text-utils';
 import { Ctx } from '../ctx/base';
+import { isNullish, isNumber, isRecord, isString } from '../guardUtils.js';
 
 type Field = SchemaTypes.Field;
 type ItemType = SchemaTypes.ItemType;
@@ -22,7 +23,11 @@ export type CustomBlockStylesForStructuredTextFieldCtx = Ctx<{
   itemType: ItemType;
 }>;
 
-/** An object expressing a custom block style for a Structured Text field */
+/**
+ * An object expressing a custom block style for a Structured Text field
+ *
+ * @see {isStructuredTextCustomBlockStyle}
+ */
 export type StructuredTextCustomBlockStyle = {
   /** ID of custom block style */
   id: string;
@@ -40,3 +45,20 @@ export type StructuredTextCustomBlockStyle = {
    */
   rank?: number;
 };
+
+/**
+ * Checks if the given value is a StructuredTextCustomBlockStyle.
+ * @param value - The value to check.
+ * @returns True if the value is a StructuredTextCustomBlockStyle, otherwise false.
+ */
+export function isStructuredTextCustomBlockStyle(
+  value: unknown,
+): value is StructuredTextCustomBlockStyle {
+  return (
+    isRecord(value) &&
+    isString(value.id) &&
+    isString(value.label) &&
+    isString(value.node) &&
+    (isNullish(value.rank) || isNumber(value.rank))
+  );
+}

package/src/hooks/customMarksForStructuredTextField.ts

@@ -1,6 +1,13 @@
 import type { SchemaTypes } from '@datocms/cma-client';
 import { Ctx } from '../ctx/base';
-import { Icon } from '../icon';
+import {
+  isNullish,
+  isNumber,
+  isPlacement,
+  isRecord,
+  isString,
+} from '../guardUtils.js';
+import { Icon, isIcon } from '../icon';
 
 type Field = SchemaTypes.Field;
 type ItemType = SchemaTypes.ItemType;
@@ -22,7 +29,11 @@ export type CustomMarksForStructuredTextFieldCtx = Ctx<{
   itemType: ItemType;
 }>;
 
-/** An object expressing a custom mark for a Structured Text field */
+/**
+ * An object expressing a custom mark for a Structured Text field
+ *
+ * @see {isStructuredTextCustomMark}
+ */
 export type StructuredTextCustomMark = {
   /** ID of mark */
   id: string;
@@ -62,3 +73,23 @@ export type StructuredTextCustomMarkPlacement = [
   'before' | 'after',
   'strong' | 'emphasis' | 'underline' | 'code' | 'highlight' | 'strikethrough',
 ];
+
+/**
+ * Checks if the given value is a StructuredTextCustomMark.
+ * @param value The value to check.
+ * @returns True if the value is a StructuredTextCustomMark, false otherwise.
+ */
+export function isStructuredTextCustomMark(
+  value: unknown,
+): value is StructuredTextCustomMark {
+  return (
+    isRecord(value) &&
+    isString(value.id) &&
+    isString(value.label) &&
+    isIcon(value.icon) &&
+    (isNullish(value.placement) || isPlacement(value.placement)) &&
+    (isNullish(value.rank) || isNumber(value.rank)) &&
+    (isNullish(value.keyboardShortcut) || isString(value.keyboardShortcut)) &&
+    isRecord(value.appliedStyle)
+  );
+}

package/src/hooks/initialLocationQueryForItemSelector.ts

@@ -1,6 +1,6 @@
 import type { SchemaTypes } from '@datocms/cma-client';
 import { Ctx, ItemListLocationQuery } from '../ctx/base';
-
+import { isNullish, isNumber, isRecord } from '../guardUtils.js';
 import { MaybePromise } from '../utils';
 
 type Field = SchemaTypes.Field;
@@ -22,6 +22,11 @@ export type InitialLocationQueryForItemSelectorHook = {
 
 export type InitialLocationQueryForItemSelectorCtx = Ctx;
 
+/**
+ * An object expressing which filters should be applied to the record selector
+ *
+ * @see {isInitialLocationQueryForItemSelector}
+ */
 export type InitialLocationQueryForItemSelector = {
   locationQuery: ItemListLocationQuery;
   /**
@@ -33,3 +38,18 @@ export type InitialLocationQueryForItemSelector = {
    */
   rank?: number;
 };
+
+/**
+ * Type guard for InitialLocationQueryForItemSelector
+ * @param value - The value to check
+ * @returns True if value is of type InitialLocationQueryForItemSelector, false otherwise
+ */
+export function isInitialLocationQueryForItemSelector(
+  value: unknown,
+): value is InitialLocationQueryForItemSelector {
+  return (
+    isRecord(value) &&
+    isRecord(value.locationQuery) &&
+    (isNullish(value.rank) || isNumber(value.rank))
+  );
+}

package/src/hooks/itemCollectionOutlets.ts

@@ -1,5 +1,6 @@
 import type { SchemaTypes } from '@datocms/cma-client';
 import { Ctx } from '../ctx/base';
+import { isNullish, isNumber, isRecord, isString } from '../guardUtils.js';
 
 type ItemType = SchemaTypes.ItemType;
 
@@ -18,7 +19,11 @@ export type ItemCollectionOutletsHook = {
 
 export type ItemCollectionOutletsCtx = Ctx;
 
-/** An outlet to be shown at the top of a record's collection page */
+/**
+ * An object expressing an outlet to be shown at the top of a record's collection page
+ *
+ * @see {isItemCollectionOutlet}
+ */
 export type ItemCollectionOutlet = {
   /**
    * ID of the outlet. Will be the first argument for the `renderItemCollectionOutlet`
@@ -35,3 +40,19 @@ export type ItemCollectionOutlet = {
   /** The initial height to set for the iframe that will render the outlet */
   initialHeight?: number;
 };
+
+/**
+ * Checks if the given value is an ItemCollectionOutlet.
+ * @param value - The value to check.
+ * @returns True if the value is an ItemCollectionOutlet, false otherwise.
+ */
+export function isItemCollectionOutlet(
+  value: unknown,
+): value is ItemCollectionOutlet {
+  return (
+    isRecord(value) &&
+    isString(value.id) &&
+    (isNullish(value.rank) || isNumber(value.rank)) &&
+    (isNullish(value.initialHeight) || isNumber(value.initialHeight))
+  );
+}

package/src/hooks/itemFormOutlets.ts

@@ -1,5 +1,6 @@
 import type { SchemaTypes } from '@datocms/cma-client';
 import { Ctx } from '../ctx/base';
+import { isNullish, isNumber, isRecord, isString } from '../guardUtils.js';
 
 type ItemType = SchemaTypes.ItemType;
 
@@ -18,6 +19,11 @@ export type ItemFormOutletsHook = {
 
 export type ItemFormOutletsCtx = Ctx;
 
+/**
+ * An object expressing an outlet to be shown at the top of a record's editing page
+ *
+ * @see {isItemFormOutlet}
+ */
 export type ItemFormOutlet = {
   /**
    * ID of the outlet. Will be the first argument for the `renderItemFormOutlet`
@@ -34,3 +40,17 @@ export type ItemFormOutlet = {
   /** The initial height to set for the iframe that will render the outlet */
   initialHeight?: number;
 };
+
+/**
+ * Checks if the given value is an ItemFormOutlet.
+ * @param value - The value to check.
+ * @returns True if the value is an ItemFormOutlet, false otherwise.
+ */
+export function isItemFormOutlet(value: unknown): value is ItemFormOutlet {
+  return (
+    isRecord(value) &&
+    isString(value.id) &&
+    (isNullish(value.rank) || isNumber(value.rank)) &&
+    (isNullish(value.initialHeight) || isNumber(value.initialHeight))
+  );
+}

package/src/hooks/itemFormSidebarPanels.ts

@@ -1,5 +1,13 @@
 import type { SchemaTypes } from '@datocms/cma-client';
 import { Ctx } from '../ctx/base';
+import {
+  isBoolean,
+  isNullish,
+  isNumber,
+  isPlacement,
+  isRecord,
+  isString,
+} from '../guardUtils.js';
 import { ItemFormSidebarPanelPlacement } from '../shared';
 
 type ItemType = SchemaTypes.ItemType;
@@ -19,6 +27,12 @@ export type ItemFormSidebarPanelsHook = {
 
 export type ItemFormSidebarPanelsCtx = Ctx;
 
+/**
+ * An object expressing a sidebar panel to be shown when the user
+ * edits records of a particular model
+ *
+ * @see {isItemFormSidebarPanel}
+ */
 export type ItemFormSidebarPanel = {
   /**
    * ID of the panel. Will be the first argument for the
@@ -52,3 +66,23 @@ export type ItemFormSidebarPanel = {
   /** The initial height to set for the iframe that will render the sidebar panel */
   initialHeight?: number;
 };
+
+/**
+ * Checks if the given value is an ItemFormSidebarPanel.
+ * @param value - The value to check.
+ * @returns True if the value is an ItemFormSidebarPanel, false otherwise.
+ */
+export function isItemFormSidebarPanel(
+  value: unknown,
+): value is ItemFormSidebarPanel {
+  return (
+    isRecord(value) &&
+    isString(value.id) &&
+    isString(value.label) &&
+    (isNullish(value.parameters) || isRecord(value.parameters)) &&
+    (isNullish(value.startOpen) || isBoolean(value.startOpen)) &&
+    (isNullish(value.placement) || isPlacement(value.placement)) &&
+    (isNullish(value.rank) || isNumber(value.rank)) &&
+    (isNullish(value.initialHeight) || isNumber(value.initialHeight))
+  );
+}

package/src/hooks/itemFormSidebars.ts

@@ -1,5 +1,6 @@
 import type { SchemaTypes } from '@datocms/cma-client';
 import { Ctx } from '../ctx/base';
+import { isNullish, isNumber, isRecord, isString } from '../guardUtils.js';
 
 type ItemType = SchemaTypes.ItemType;
 
@@ -18,6 +19,12 @@ export type ItemFormSidebarsHook = {
 
 export type ItemFormSidebarsCtx = Ctx;
 
+/**
+ * An object expressing a sidebar to be shown when the user edits
+ * records of a particular model
+ *
+ * @see {isItemFormSidebar}
+ */
 export type ItemFormSidebar = {
   /**
    * ID of the sidebar. Will be the first argument for the
@@ -42,3 +49,19 @@ export type ItemFormSidebar = {
   /** The preferred width for the sidebar */
   preferredWidth?: number;
 };
+
+/**
+ * Type guard to check if the value is an ItemFormSidebar.
+ * @param value - The value to check.
+ * @returns true if the value is an ItemFormSidebar, false otherwise.
+ */
+export function isItemFormSidebar(value: unknown): value is ItemFormSidebar {
+  return (
+    isRecord(value) &&
+    isString(value.id) &&
+    isString(value.label) &&
+    (isNullish(value.parameters) || isRecord(value.parameters)) &&
+    (isNullish(value.rank) || isNumber(value.rank)) &&
+    (isNullish(value.preferredWidth) || isNumber(value.preferredWidth))
+  );
+}

package/src/hooks/mainNavigationTabs.ts

@@ -1,5 +1,12 @@
 import { Ctx } from '../ctx/base';
-import { Icon } from '../icon';
+import {
+  isNullish,
+  isNumber,
+  isPlacement,
+  isRecord,
+  isString,
+} from '../guardUtils.js';
+import { Icon, isIcon } from '../icon';
 
 export type MainNavigationTabsHook = {
   /**
@@ -13,7 +20,11 @@ export type MainNavigationTabsHook = {
 
 export type MainNavigationTabsCtx = Ctx;
 
-/** A tab to be displayed in the top-bar of the UI */
+/**
+ * An object expressing a tab to be displayed in the top-bar of the UI
+ *
+ * @see {isMainNavigationTab}
+ */
 export type MainNavigationTab = {
   /** Label to be shown. Must be unique. */
   label: string;
@@ -45,3 +56,22 @@ export type MainNavigationTab = {
    */
   rank?: number;
 };
+
+/**
+ * Checks if the given value is a MainNavigationTab.
+ * @param value The value to check.
+ * @returns True if the value is a MainNavigationTab, false otherwise.
+ */
+export function isMainNavigationTab(
+  value: unknown,
+): value is MainNavigationTab {
+  return (
+    isRecord(value) &&
+    isString(value.label) &&
+    isIcon(value.icon) &&
+    isRecord(value.pointsTo) &&
+    isString(value.pointsTo.pageId) &&
+    (isNullish(value.placement) || isPlacement(value.placement)) &&
+    (isNullish(value.rank) || isNumber(value.rank))
+  );
+}

package/src/hooks/manualFieldExtensions.ts

@@ -1,4 +1,12 @@
 import { Ctx } from '../ctx/base';
+import {
+  isArray,
+  isBoolean,
+  isNullish,
+  isNumber,
+  isRecord,
+  isString,
+} from '../guardUtils.js';
 
 export type ManualFieldExtensionsHook = {
   /**
@@ -14,6 +22,12 @@ export type ManualFieldExtensionsHook = {
 
 export type ManualFieldExtensionsCtx = Ctx;
 
+/**
+ * An object expressing a field extension that users will be able
+ * to install manually in some field
+ *
+ * @see {isManualFieldExtension}
+ */
 export type ManualFieldExtension = {
   /**
    * ID of field extension. Will be the first argument for the
@@ -80,3 +94,31 @@ export type FieldType =
   | 'structured_text'
   | 'text'
   | 'video';
+
+/**
+ * Checks if the provided value is a ManualFieldExtension.
+ * @param value - The value to check.
+ * @returns True if the value is a ManualFieldExtension, otherwise false.
+ */
+export function isManualFieldExtension(
+  value: unknown,
+): value is ManualFieldExtension {
+  return (
+    isRecord(value) &&
+    isString(value.id) &&
+    isString(value.name) &&
+    isString(value.type) &&
+    ['editor', 'addon'].includes(value.type) &&
+    (isNullish(value.asSidebarPanel) ||
+      isBoolean(value.asSidebarPanel) ||
+      (isRecord(value.asSidebarPanel) &&
+        isBoolean(value.asSidebarPanel.startOpen))) &&
+    ((isString(value.fieldTypes) && value.fieldTypes === 'all') ||
+      isArray(value.fieldTypes, isString)) &&
+    (isNullish(value.configurable) ||
+      isBoolean(value.configurable) ||
+      (isRecord(value.configurable) &&
+        isNumber(value.configurable.initialHeight))) &&
+    (isNullish(value.initialHeight) || isNumber(value.initialHeight))
+  );
+}

package/src/hooks/overrideFieldExtensions.ts

@@ -1,5 +1,14 @@
 import type { SchemaTypes } from '@datocms/cma-client';
 import { Ctx } from '../ctx/base';
+import {
+  isArray,
+  isBoolean,
+  isNullish,
+  isNumber,
+  isPlacement,
+  isRecord,
+  isString,
+} from '../guardUtils.js';
 import { ItemFormSidebarPanelPlacement } from '../shared';
 
 type Field = SchemaTypes.Field;
@@ -25,6 +34,8 @@ export type OverrideFieldExtensionsCtx = Ctx<{
 /**
  * An object expressing some field extensions you want to force on a particular
  * field
+ *
+ * @see {isFieldExtensionOverride}
  */
 export type FieldExtensionOverride = {
   /** Force a field editor/sidebar extension on a field */
@@ -93,3 +104,56 @@ export type AddonOverride = {
    */
   initialHeight?: number;
 };
+
+/**
+ * Checks if the value is a FieldExtensionOverride.
+ * @param value The value to check.
+ * @returns True if the value is a FieldExtensionOverride, false otherwise.
+ */
+export function isFieldExtensionOverride(
+  value: unknown,
+): value is FieldExtensionOverride {
+  return (
+    isNullish(value) ||
+    (isRecord(value) &&
+      (isNullish(value.editor) || isEditorOverride(value.editor)) &&
+      (isNullish(value.addons) || isArray(value.addons, isAddonOverride)))
+  );
+}
+
+/**
+ * Checks if the value is an EditorOverride.
+ * @param value The value to check.
+ * @returns True if the value is an EditorOverride, false otherwise.
+ */
+export function isEditorOverride(value: unknown): value is EditorOverride {
+  return (
+    isRecord(value) &&
+    isString(value.id) &&
+    (isNullish(value.asSidebarPanel) ||
+      isBoolean(value.asSidebarPanel) ||
+      (isRecord(value.asSidebarPanel) &&
+        (isNullish(value.asSidebarPanel.startOpen) ||
+          isBoolean(value.asSidebarPanel.startOpen)) &&
+        (isNullish(value.asSidebarPanel.placement) ||
+          isPlacement(value.asSidebarPanel.placement)))) &&
+    (isNullish(value.parameters) || isRecord(value.parameters)) &&
+    (isNullish(value.rank) || isNumber(value.rank)) &&
+    (isNullish(value.initialHeight) || isNumber(value.initialHeight))
+  );
+}
+
+/**
+ * Checks if the value is an AddonOverride.
+ * @param value The value to check.
+ * @returns True if the value is an AddonOverride, false otherwise.
+ */
+export function isAddonOverride(value: unknown): value is AddonOverride {
+  return (
+    isRecord(value) &&
+    isString(value.id) &&
+    (isNullish(value.parameters) || isRecord(value.parameters)) &&
+    (isNullish(value.rank) || isNumber(value.rank)) &&
+    (isNullish(value.initialHeight) || isNumber(value.initialHeight))
+  );
+}

package/src/hooks/renderItemCollectionOutlet.ts

@@ -1,10 +1,13 @@
+import type { SchemaTypes } from '@datocms/cma-client';
 import { SelfResizingPluginFrameCtx } from '../ctx/pluginFrame';
 import { containedRenderModeBootstrapper } from '../utils';
 
+type ItemType = SchemaTypes.ItemType;
+
 export type RenderItemCollectionOutletHook = {
   /**
    * This function will be called when the plugin needs to render an outlet
-   * defined by the `itemFormOutlets()` hook.
+   * defined by the `itemCollectionOutlets()` hook.
    *
    * @tag outlets
    */
@@ -19,6 +22,8 @@ export type RenderItemCollectionOutletCtx = SelfResizingPluginFrameCtx<
   {
     /** The ID of the outlet that needs to be rendered */
     itemCollectionOutletId: string;
+    /** The model for which the outlet is being rendered */
+    itemType: ItemType;
   }
 >;
 

package/src/hooks/uploadSidebarPanels.ts

@@ -1,4 +1,12 @@
 import { Ctx } from '../ctx/base';
+import {
+  isBoolean,
+  isNullish,
+  isNumber,
+  isPlacement,
+  isRecord,
+  isString,
+} from '../guardUtils.js';
 
 export type UploadSidebarPanelsHook = {
   /**
@@ -12,6 +20,12 @@ export type UploadSidebarPanelsHook = {
 
 export type UploadSidebarPanelsCtx = Ctx;
 
+/**
+ * An object expressing a sidebar panel to be shown when the user
+ * opens up an asset in the Media Area
+ *
+ * @see {isUploadSidebarPanel}
+ */
 export type UploadSidebarPanel = {
   /**
    * ID of the panel. Will be the first argument for the
@@ -57,3 +71,23 @@ export type UploadSidebarPanelPlacement = [
     | 'replace'
   ),
 ];
+
+/**
+ * Type guard for UploadSidebarPanel
+ * @param value - The value to check
+ * @returns True if the value is an UploadSidebarPanel
+ */
+export function isUploadSidebarPanel(
+  value: unknown,
+): value is UploadSidebarPanel {
+  return (
+    isRecord(value) &&
+    isString(value.id) &&
+    isString(value.label) &&
+    (isNullish(value.parameters) || isRecord(value.parameters)) &&
+    (isNullish(value.startOpen) || isBoolean(value.startOpen)) &&
+    (isNullish(value.placement) || isPlacement(value.placement)) &&
+    (isNullish(value.rank) || isNumber(value.rank)) &&
+    (isNullish(value.initialHeight) || isNumber(value.initialHeight))
+  );
+}

package/src/hooks/uploadSidebars.ts

@@ -1,4 +1,5 @@
 import { Ctx } from '../ctx/base';
+import { isNullish, isNumber, isRecord, isString } from '../guardUtils.js';
 
 export type UploadSidebarsHook = {
   /**
@@ -12,6 +13,12 @@ export type UploadSidebarsHook = {
 
 export type UploadSidebarsCtx = Ctx;
 
+/**
+ * An object expressing a sidebar to be shown when the user opens
+ * up an asset in the Media Area
+ *
+ * @see {isUploadSidebar}
+ */
 export type UploadSidebar = {
   /**
    * ID of the sidebar. Will be the first argument for the
@@ -36,3 +43,19 @@ export type UploadSidebar = {
   /** The preferred width for the sidebar */
   preferredWidth?: number;
 };
+
+/**
+ * Checks if the provided value is an UploadSidebar.
+ * @param value - The value to check.
+ * @returns True if the value is an UploadSidebar, otherwise false.
+ */
+export function isUploadSidebar(value: unknown): value is UploadSidebar {
+  return (
+    isRecord(value) &&
+    isString(value.id) &&
+    isString(value.label) &&
+    (isNullish(value.parameters) || isRecord(value.parameters)) &&
+    (isNullish(value.rank) || isNumber(value.rank)) &&
+    (isNullish(value.preferredWidth) || isNumber(value.preferredWidth))
+  );
+}