datocms-plugin-sdk 2.0.4 → 2.0.6

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: 10,
+        lineNumber: 17,
       },
     },
     uploadSidebarPanels: {
@@ -79,7 +79,7 @@ export const manifest: Manifest = {
       returnType: 'UploadSidebarPanel[]',
       location: {
         filePath: 'src/hooks/uploadSidebarPanels.ts',
-        lineNumber: 10,
+        lineNumber: 19,
       },
     },
     settingsAreaSidebarItemGroups: {
@@ -1601,7 +1601,7 @@ export const manifest: Manifest = {
               itemType: {
                 location: {
                   filePath: 'src/hooks/overrideFieldExtensions.ts',
-                  lineNumber: 22,
+                  lineNumber: 31,
                 },
                 type: 'ItemType',
               },
@@ -1613,7 +1613,7 @@ export const manifest: Manifest = {
       returnType: 'FieldExtensionOverride | undefined',
       location: {
         filePath: 'src/hooks/overrideFieldExtensions.ts',
-        lineNumber: 15,
+        lineNumber: 24,
       },
     },
     onBoot: {
@@ -1747,7 +1747,7 @@ export const manifest: Manifest = {
       returnType: 'ManualFieldExtension[]',
       location: {
         filePath: 'src/hooks/manualFieldExtensions.ts',
-        lineNumber: 10,
+        lineNumber: 18,
       },
     },
     mainNavigationTabs: {
@@ -1766,7 +1766,7 @@ export const manifest: Manifest = {
       returnType: 'MainNavigationTab[]',
       location: {
         filePath: 'src/hooks/mainNavigationTabs.ts',
-        lineNumber: 11,
+        lineNumber: 19,
       },
     },
     itemsDropdownActions: {
@@ -1826,7 +1826,7 @@ export const manifest: Manifest = {
       returnType: 'ItemFormSidebar[]',
       location: {
         filePath: 'src/hooks/itemFormSidebars.ts',
-        lineNumber: 13,
+        lineNumber: 20,
       },
     },
     itemFormSidebarPanels: {
@@ -1850,7 +1850,7 @@ export const manifest: Manifest = {
       returnType: 'ItemFormSidebarPanel[]',
       location: {
         filePath: 'src/hooks/itemFormSidebarPanels.ts',
-        lineNumber: 14,
+        lineNumber: 23,
       },
     },
     itemFormOutlets: {
@@ -1874,7 +1874,7 @@ export const manifest: Manifest = {
       returnType: 'ItemFormOutlet[]',
       location: {
         filePath: 'src/hooks/itemFormOutlets.ts',
-        lineNumber: 13,
+        lineNumber: 20,
       },
     },
     itemFormDropdownActions: {
@@ -2017,7 +2017,7 @@ export const manifest: Manifest = {
       returnType: 'ItemCollectionOutlet[]',
       location: {
         filePath: 'src/hooks/itemCollectionOutlets.ts',
-        lineNumber: 13,
+        lineNumber: 20,
       },
     },
     initialLocationQueryForItemSelector: {
@@ -2851,7 +2851,7 @@ export const manifest: Manifest = {
               itemType: {
                 location: {
                   filePath: 'src/hooks/customMarksForStructuredTextField.ts',
-                  lineNumber: 22,
+                  lineNumber: 30,
                 },
                 type: 'ItemType',
               },
@@ -2863,7 +2863,7 @@ export const manifest: Manifest = {
       returnType: 'StructuredTextCustomMark[] | undefined',
       location: {
         filePath: 'src/hooks/customMarksForStructuredTextField.ts',
-        lineNumber: 15,
+        lineNumber: 23,
       },
     },
     customBlockStylesForStructuredTextField: {
@@ -2888,7 +2888,7 @@ export const manifest: Manifest = {
                 location: {
                   filePath:
                     'src/hooks/customBlockStylesForStructuredTextField.ts',
-                  lineNumber: 22,
+                  lineNumber: 29,
                 },
                 type: 'ItemType',
               },
@@ -2900,7 +2900,7 @@ export const manifest: Manifest = {
       returnType: 'StructuredTextCustomBlockStyle[] | undefined',
       location: {
         filePath: 'src/hooks/customBlockStylesForStructuredTextField.ts',
-        lineNumber: 15,
+        lineNumber: 22,
       },
     },
     contentAreaSidebarItems: {
@@ -2919,7 +2919,7 @@ export const manifest: Manifest = {
       returnType: 'ContentAreaSidebarItem[]',
       location: {
         filePath: 'src/hooks/contentAreaSidebarItems.ts',
-        lineNumber: 10,
+        lineNumber: 18,
       },
     },
     buildItemPresentationInfo: {
@@ -2943,7 +2943,7 @@ export const manifest: Manifest = {
       returnType: 'MaybePromise<ItemPresentationInfo | undefined>',
       location: {
         filePath: 'src/hooks/buildItemPresentationInfo.ts',
-        lineNumber: 14,
+        lineNumber: 15,
       },
     },
     assetSources: {
@@ -2962,7 +2962,7 @@ export const manifest: Manifest = {
       returnType: 'AssetSource[] | undefined',
       location: {
         filePath: 'src/hooks/assetSources.ts',
-        lineNumber: 11,
+        lineNumber: 18,
       },
     },
   },

package/src/shared.ts

@@ -1,5 +1,18 @@
-import { Icon } from './icon';
+import {
+  isArray,
+  isBoolean,
+  isNullish,
+  isNumber,
+  isRecord,
+  isString,
+} from './guardUtils.js';
+import { Icon, isIcon } from './icon';
 
+/**
+ * An object expressing a dropdown action to be shown in the interface
+ *
+ * @see {isDropdownAction}
+ */
 export type DropdownAction = {
   /**
    * ID of action. Will be the first argument for the
@@ -38,6 +51,11 @@ export type DropdownAction = {
   rank?: number;
 };
 
+/**
+ * An object expressing a dropdown submenu containing actions to be shown in the interface
+ *
+ * @see {isDropdownActionGroup}
+ */
 export type DropdownActionGroup = {
   /** Label to be shown. Must be unique. */
   label: string;
@@ -65,3 +83,42 @@ export type ItemFormSidebarPanelPlacement = [
   'before' | 'after',
   'info' | 'publishedVersion' | 'schedule' | 'links' | 'history',
 ];
+
+export function isDropdownAction(value: unknown): value is DropdownAction {
+  if (!isRecord(value)) return false;
+
+  return (
+    isString(value.id) &&
+    (isNullish(value.parameters) || isRecord(value.parameters)) &&
+    isString(value.label) &&
+    isIcon(value.icon) &&
+    (isNullish(value.active) || isBoolean(value.active)) &&
+    (isNullish(value.alert) || isBoolean(value.alert)) &&
+    (isNullish(value.disabled) || isBoolean(value.disabled)) &&
+    (isNullish(value.closeMenuOnClick) || isBoolean(value.closeMenuOnClick)) &&
+    (isNullish(value.rank) || isNumber(value.rank))
+  );
+}
+
+export function isDropdownActionGroup(
+  value: unknown,
+): value is DropdownActionGroup {
+  if (!isRecord(value)) return false;
+
+  return (
+    isString(value.label) &&
+    isIcon(value.icon) &&
+    isArray(value.actions, isDropdownAction) &&
+    (isNullish(value.rank) || isNumber(value.rank))
+  );
+}
+
+export function isDropdownActionOrGroupArray(
+  value: unknown,
+): value is Array<DropdownAction | DropdownActionGroup> {
+  return isArray(
+    value,
+    (innerValue) =>
+      isDropdownAction(innerValue) || isDropdownActionGroup(innerValue),
+  );
+}