datocms-plugin-sdk 2.0.5 → 2.0.6

package/src/hooks/assetSources.ts

@@ -1,5 +1,11 @@
 import { Ctx } from '../ctx/base';
-import { isNullish, isNumber, isRecord, isString } from '../guardUtils.js';
+import {
+  isArray,
+  isNullish,
+  isNumber,
+  isRecord,
+  isString,
+} from '../guardUtils.js';
 import { Icon, isIcon } from '../icon';
 
 export type AssetSourcesHook = {
@@ -49,11 +55,6 @@ export type AssetSource = {
   };
 };
 
-/**
- * Type guard for AssetSource.
- * @param value - The value to check.
- * @returns true if the value is an AssetSource, false otherwise.
- */
 export function isAssetSource(value: unknown): value is AssetSource {
   if (isNullish(value)) return false;
   if (!isRecord(value)) return false;
@@ -73,3 +74,9 @@ export function isAssetSource(value: unknown): value is AssetSource {
         (isNullish(modal.initialHeight) || isNumber(modal.initialHeight))))
   );
 }
+
+export function isReturnTypeOfAssetSourcesHook(
+  value: unknown,
+): value is AssetSource[] | undefined {
+  return isNullish(value) || isArray(value, isAssetSource);
+}

package/src/hooks/buildItemPresentationInfo.ts

@@ -40,11 +40,6 @@ 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 {
@@ -55,3 +50,9 @@ export function isItemPresentationInfo(
     (isNullish(value.rank) || isNumber(value.rank))
   );
 }
+
+export function isReturnTypeOfBuildItemPresentationInfoHook(
+  value: unknown,
+): value is ItemPresentationInfo | undefined {
+  return isNullish(value) || isItemPresentationInfo(value);
+}

package/src/hooks/contentAreaSidebarItems.ts

@@ -1,5 +1,6 @@
 import { Ctx } from '../ctx/base';
 import {
+  isArray,
   isNullish,
   isNumber,
   isPlacement,
@@ -56,11 +57,6 @@ 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 {
@@ -74,3 +70,9 @@ export function isContentAreaSidebarItem(
     (isNullish(value.rank) || isNumber(value.rank))
   );
 }
+
+export function isReturnTypeOfContentAreaSidebarItemsHook(
+  value: unknown,
+): value is ContentAreaSidebarItem[] {
+  return isArray(value, isContentAreaSidebarItem);
+}

package/src/hooks/customBlockStylesForStructuredTextField.ts

@@ -1,7 +1,13 @@
 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';
+import {
+  isArray,
+  isNullish,
+  isNumber,
+  isRecord,
+  isString,
+} from '../guardUtils.js';
 
 type Field = SchemaTypes.Field;
 type ItemType = SchemaTypes.ItemType;
@@ -46,11 +52,6 @@ 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 {
@@ -62,3 +63,9 @@ export function isStructuredTextCustomBlockStyle(
     (isNullish(value.rank) || isNumber(value.rank))
   );
 }
+
+export function isReturnTypeOfCustomBlockStylesForStructuredTextFieldHook(
+  value: unknown,
+): value is StructuredTextCustomBlockStyle[] | undefined {
+  return isNullish(value) || isArray(value, isStructuredTextCustomBlockStyle);
+}

package/src/hooks/customMarksForStructuredTextField.ts

@@ -1,6 +1,7 @@
 import type { SchemaTypes } from '@datocms/cma-client';
 import { Ctx } from '../ctx/base';
 import {
+  isArray,
   isNullish,
   isNumber,
   isPlacement,
@@ -74,11 +75,6 @@ export type StructuredTextCustomMarkPlacement = [
   '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 {
@@ -93,3 +89,9 @@ export function isStructuredTextCustomMark(
     isRecord(value.appliedStyle)
   );
 }
+
+export function isReturnTypeOfCustomMarksForStructuredTextFieldHook(
+  value: unknown,
+): value is StructuredTextCustomMark[] | undefined {
+  return isNullish(value) || isArray(value, isStructuredTextCustomMark);
+}

package/src/hooks/initialLocationQueryForItemSelector.ts

@@ -39,11 +39,6 @@ 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 {
@@ -53,3 +48,9 @@ export function isInitialLocationQueryForItemSelector(
     (isNullish(value.rank) || isNumber(value.rank))
   );
 }
+
+export function isReturnTypeOfInitialLocationQueryForItemSelectorHook(
+  value: unknown,
+): value is InitialLocationQueryForItemSelector | undefined {
+  return isNullish(value) || isInitialLocationQueryForItemSelector(value);
+}

package/src/hooks/itemCollectionOutlets.ts

@@ -1,6 +1,12 @@
 import type { SchemaTypes } from '@datocms/cma-client';
 import { Ctx } from '../ctx/base';
-import { isNullish, isNumber, isRecord, isString } from '../guardUtils.js';
+import {
+  isArray,
+  isNullish,
+  isNumber,
+  isRecord,
+  isString,
+} from '../guardUtils.js';
 
 type ItemType = SchemaTypes.ItemType;
 
@@ -41,11 +47,6 @@ export type ItemCollectionOutlet = {
   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 {
@@ -56,3 +57,9 @@ export function isItemCollectionOutlet(
     (isNullish(value.initialHeight) || isNumber(value.initialHeight))
   );
 }
+
+export function isReturnTypeOfItemCollectionOutletsHook(
+  value: unknown,
+): value is ItemCollectionOutlet[] {
+  return isArray(value, isItemCollectionOutlet);
+}

package/src/hooks/itemFormOutlets.ts

@@ -1,6 +1,12 @@
 import type { SchemaTypes } from '@datocms/cma-client';
 import { Ctx } from '../ctx/base';
-import { isNullish, isNumber, isRecord, isString } from '../guardUtils.js';
+import {
+  isArray,
+  isNullish,
+  isNumber,
+  isRecord,
+  isString,
+} from '../guardUtils.js';
 
 type ItemType = SchemaTypes.ItemType;
 
@@ -41,11 +47,6 @@ export type ItemFormOutlet = {
   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) &&
@@ -54,3 +55,9 @@ export function isItemFormOutlet(value: unknown): value is ItemFormOutlet {
     (isNullish(value.initialHeight) || isNumber(value.initialHeight))
   );
 }
+
+export function isReturnTypeOfItemFormOutletsHook(
+  value: unknown,
+): value is ItemFormOutlet[] {
+  return isArray(value, isItemFormOutlet);
+}

package/src/hooks/itemFormSidebarPanels.ts

@@ -1,6 +1,7 @@
 import type { SchemaTypes } from '@datocms/cma-client';
 import { Ctx } from '../ctx/base';
 import {
+  isArray,
   isBoolean,
   isNullish,
   isNumber,
@@ -67,11 +68,6 @@ export type ItemFormSidebarPanel = {
   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 {
@@ -86,3 +82,9 @@ export function isItemFormSidebarPanel(
     (isNullish(value.initialHeight) || isNumber(value.initialHeight))
   );
 }
+
+export function isReturnTypeOfItemFormSidebarPanelsHook(
+  value: unknown,
+): value is ItemFormSidebarPanel[] {
+  return isArray(value, isItemFormSidebarPanel);
+}

package/src/hooks/itemFormSidebars.ts

@@ -1,6 +1,12 @@
 import type { SchemaTypes } from '@datocms/cma-client';
 import { Ctx } from '../ctx/base';
-import { isNullish, isNumber, isRecord, isString } from '../guardUtils.js';
+import {
+  isArray,
+  isNullish,
+  isNumber,
+  isRecord,
+  isString,
+} from '../guardUtils.js';
 
 type ItemType = SchemaTypes.ItemType;
 
@@ -50,11 +56,6 @@ export type ItemFormSidebar = {
   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) &&
@@ -65,3 +66,9 @@ export function isItemFormSidebar(value: unknown): value is ItemFormSidebar {
     (isNullish(value.preferredWidth) || isNumber(value.preferredWidth))
   );
 }
+
+export function isReturnTypeOfItemFormSidebarsHook(
+  value: unknown,
+): value is ItemFormSidebar[] {
+  return isArray(value, isItemFormSidebar);
+}

package/src/hooks/mainNavigationTabs.ts

@@ -1,5 +1,6 @@
 import { Ctx } from '../ctx/base';
 import {
+  isArray,
   isNullish,
   isNumber,
   isPlacement,
@@ -57,11 +58,6 @@ 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 {
@@ -75,3 +71,9 @@ export function isMainNavigationTab(
     (isNullish(value.rank) || isNumber(value.rank))
   );
 }
+
+export function isReturnTypeOfMainNavigationTabsHook(
+  value: unknown,
+): value is MainNavigationTab[] {
+  return isArray(value, isMainNavigationTab);
+}

package/src/hooks/manualFieldExtensions.ts

@@ -95,11 +95,6 @@ export type FieldType =
   | '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 {
@@ -122,3 +117,9 @@ export function isManualFieldExtension(
     (isNullish(value.initialHeight) || isNumber(value.initialHeight))
   );
 }
+
+export function isReturnTypeOfManualFieldExtensionsHook(
+  value: unknown,
+): value is ManualFieldExtension[] {
+  return isArray(value, isManualFieldExtension);
+}

package/src/hooks/overrideFieldExtensions.ts

@@ -105,11 +105,6 @@ 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 {
@@ -121,11 +116,6 @@ export function isFieldExtensionOverride(
   );
 }
 
-/**
- * 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) &&
@@ -143,11 +133,6 @@ export function isEditorOverride(value: unknown): value is EditorOverride {
   );
 }
 
-/**
- * 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) &&
@@ -157,3 +142,9 @@ export function isAddonOverride(value: unknown): value is AddonOverride {
     (isNullish(value.initialHeight) || isNumber(value.initialHeight))
   );
 }
+
+export function isReturnTypeOfOverrideFieldExtensionsHook(
+  value: unknown,
+): value is FieldExtensionOverride | undefined {
+  return isNullish(value) || isFieldExtensionOverride(value);
+}

package/src/hooks/uploadSidebarPanels.ts

@@ -1,5 +1,6 @@
 import { Ctx } from '../ctx/base';
 import {
+  isArray,
   isBoolean,
   isNullish,
   isNumber,
@@ -72,11 +73,6 @@ export type UploadSidebarPanelPlacement = [
   ),
 ];
 
-/**
- * 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 {
@@ -91,3 +87,9 @@ export function isUploadSidebarPanel(
     (isNullish(value.initialHeight) || isNumber(value.initialHeight))
   );
 }
+
+export function isReturnTypeOfUploadSidebarPanelsHook(
+  value: unknown,
+): value is UploadSidebarPanel[] {
+  return isArray(value, isUploadSidebarPanel);
+}

package/src/hooks/uploadSidebars.ts

@@ -1,5 +1,11 @@
 import { Ctx } from '../ctx/base';
-import { isNullish, isNumber, isRecord, isString } from '../guardUtils.js';
+import {
+  isArray,
+  isNullish,
+  isNumber,
+  isRecord,
+  isString,
+} from '../guardUtils.js';
 
 export type UploadSidebarsHook = {
   /**
@@ -44,11 +50,6 @@ export type UploadSidebar = {
   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) &&
@@ -59,3 +60,9 @@ export function isUploadSidebar(value: unknown): value is UploadSidebar {
     (isNullish(value.preferredWidth) || isNumber(value.preferredWidth))
   );
 }
+
+export function isReturnTypeOfUploadSidebarsHook(
+  value: unknown,
+): value is UploadSidebar[] {
+  return isArray(value, isUploadSidebar);
+}

package/src/hooks/validateManualFieldExtensionParameters.ts

@@ -1,3 +1,5 @@
+import { isRecord } from '../guardUtils';
+
 export type ValidateManualFieldExtensionParametersHook = {
   /**
    * This function will be called each time the configuration object changes. It
@@ -10,3 +12,9 @@ export type ValidateManualFieldExtensionParametersHook = {
     parameters: Record<string, unknown>,
   ) => Record<string, unknown> | Promise<Record<string, unknown>>;
 };
+
+export function isReturnTypeOfValidateManualFieldExtensionParametersHook(
+  value: unknown,
+): value is Record<string, unknown> {
+  return isRecord(value);
+}

package/src/manifest.ts

@@ -22,7 +22,7 @@ export const manifest: Manifest = {
       returnType: 'Record<string, unknown> | Promise<Record<string, unknown>>',
       location: {
         filePath: 'src/hooks/validateManualFieldExtensionParameters.ts',
-        lineNumber: 8,
+        lineNumber: 10,
       },
     },
     uploadsDropdownActions: {
@@ -60,7 +60,7 @@ export const manifest: Manifest = {
       returnType: 'UploadSidebar[]',
       location: {
         filePath: 'src/hooks/uploadSidebars.ts',
-        lineNumber: 11,
+        lineNumber: 17,
       },
     },
     uploadSidebarPanels: {
@@ -79,7 +79,7 @@ export const manifest: Manifest = {
       returnType: 'UploadSidebarPanel[]',
       location: {
         filePath: 'src/hooks/uploadSidebarPanels.ts',
-        lineNumber: 18,
+        lineNumber: 19,
       },
     },
     settingsAreaSidebarItemGroups: {
@@ -1766,7 +1766,7 @@ export const manifest: Manifest = {
       returnType: 'MainNavigationTab[]',
       location: {
         filePath: 'src/hooks/mainNavigationTabs.ts',
-        lineNumber: 18,
+        lineNumber: 19,
       },
     },
     itemsDropdownActions: {
@@ -1826,7 +1826,7 @@ export const manifest: Manifest = {
       returnType: 'ItemFormSidebar[]',
       location: {
         filePath: 'src/hooks/itemFormSidebars.ts',
-        lineNumber: 14,
+        lineNumber: 20,
       },
     },
     itemFormSidebarPanels: {
@@ -1850,7 +1850,7 @@ export const manifest: Manifest = {
       returnType: 'ItemFormSidebarPanel[]',
       location: {
         filePath: 'src/hooks/itemFormSidebarPanels.ts',
-        lineNumber: 22,
+        lineNumber: 23,
       },
     },
     itemFormOutlets: {
@@ -1874,7 +1874,7 @@ export const manifest: Manifest = {
       returnType: 'ItemFormOutlet[]',
       location: {
         filePath: 'src/hooks/itemFormOutlets.ts',
-        lineNumber: 14,
+        lineNumber: 20,
       },
     },
     itemFormDropdownActions: {
@@ -2017,7 +2017,7 @@ export const manifest: Manifest = {
       returnType: 'ItemCollectionOutlet[]',
       location: {
         filePath: 'src/hooks/itemCollectionOutlets.ts',
-        lineNumber: 14,
+        lineNumber: 20,
       },
     },
     initialLocationQueryForItemSelector: {
@@ -2851,7 +2851,7 @@ export const manifest: Manifest = {
               itemType: {
                 location: {
                   filePath: 'src/hooks/customMarksForStructuredTextField.ts',
-                  lineNumber: 29,
+                  lineNumber: 30,
                 },
                 type: 'ItemType',
               },
@@ -2863,7 +2863,7 @@ export const manifest: Manifest = {
       returnType: 'StructuredTextCustomMark[] | undefined',
       location: {
         filePath: 'src/hooks/customMarksForStructuredTextField.ts',
-        lineNumber: 22,
+        lineNumber: 23,
       },
     },
     customBlockStylesForStructuredTextField: {
@@ -2888,7 +2888,7 @@ export const manifest: Manifest = {
                 location: {
                   filePath:
                     'src/hooks/customBlockStylesForStructuredTextField.ts',
-                  lineNumber: 23,
+                  lineNumber: 29,
                 },
                 type: 'ItemType',
               },
@@ -2900,7 +2900,7 @@ export const manifest: Manifest = {
       returnType: 'StructuredTextCustomBlockStyle[] | undefined',
       location: {
         filePath: 'src/hooks/customBlockStylesForStructuredTextField.ts',
-        lineNumber: 16,
+        lineNumber: 22,
       },
     },
     contentAreaSidebarItems: {
@@ -2919,7 +2919,7 @@ export const manifest: Manifest = {
       returnType: 'ContentAreaSidebarItem[]',
       location: {
         filePath: 'src/hooks/contentAreaSidebarItems.ts',
-        lineNumber: 17,
+        lineNumber: 18,
       },
     },
     buildItemPresentationInfo: {
@@ -2962,7 +2962,7 @@ export const manifest: Manifest = {
       returnType: 'AssetSource[] | undefined',
       location: {
         filePath: 'src/hooks/assetSources.ts',
-        lineNumber: 12,
+        lineNumber: 18,
       },
     },
   },

package/src/shared.ts

@@ -112,3 +112,13 @@ export function isDropdownActionGroup(
     (isNullish(value.rank) || isNumber(value.rank))
   );
 }
+
+export function isDropdownActionOrGroupArray(
+  value: unknown,
+): value is Array<DropdownAction | DropdownActionGroup> {
+  return isArray(
+    value,
+    (innerValue) =>
+      isDropdownAction(innerValue) || isDropdownActionGroup(innerValue),
+  );
+}