datocms-plugin-sdk 2.0.3 → 2.0.5

package/src/icon.ts

@@ -1,7 +1,19 @@
+import { isRecord, isString } from './guardUtils.js';
+
 export type Icon =
   | AwesomeFontIconIdentifier
   | { type: 'svg'; viewBox: string; content: string };
 
+export function isIcon(value: unknown): value is Icon {
+  return (
+    isString(value) ||
+    (isRecord(value) &&
+      value.type === 'svg' &&
+      isString(value.viewBox) &&
+      isString(value.content))
+  );
+}
+
 export type AwesomeFontIconIdentifier =
   | '0'
   | '00'

package/src/manifest.ts

@@ -60,7 +60,7 @@ export const manifest: Manifest = {
       returnType: 'UploadSidebar[]',
       location: {
         filePath: 'src/hooks/uploadSidebars.ts',
-        lineNumber: 10,
+        lineNumber: 11,
       },
     },
     uploadSidebarPanels: {
@@ -79,7 +79,7 @@ export const manifest: Manifest = {
       returnType: 'UploadSidebarPanel[]',
       location: {
         filePath: 'src/hooks/uploadSidebarPanels.ts',
-        lineNumber: 10,
+        lineNumber: 18,
       },
     },
     settingsAreaSidebarItemGroups: {
@@ -1150,7 +1150,7 @@ export const manifest: Manifest = {
       name: 'renderItemCollectionOutlet',
       comment: {
         markdownText:
-          'This function will be called when the plugin needs to render an outlet\ndefined by the `itemFormOutlets()` hook.',
+          'This function will be called when the plugin needs to render an outlet\ndefined by the `itemCollectionOutlets()` hook.',
         tag: 'outlets',
       },
       nonCtxArguments: [
@@ -1171,10 +1171,21 @@ export const manifest: Manifest = {
                 },
                 location: {
                   filePath: 'src/hooks/renderItemCollectionOutlet.ts',
-                  lineNumber: 21,
+                  lineNumber: 24,
                 },
                 type: 'string',
               },
+              itemType: {
+                comment: {
+                  markdownText:
+                    'The model for which the outlet is being rendered.',
+                },
+                location: {
+                  filePath: 'src/hooks/renderItemCollectionOutlet.ts',
+                  lineNumber: 26,
+                },
+                type: 'ItemType',
+              },
             },
           },
         ],
@@ -1183,7 +1194,7 @@ export const manifest: Manifest = {
       returnType: 'void',
       location: {
         filePath: 'src/hooks/renderItemCollectionOutlet.ts',
-        lineNumber: 11,
+        lineNumber: 14,
       },
     },
     renderFieldExtension: {
@@ -1590,7 +1601,7 @@ export const manifest: Manifest = {
               itemType: {
                 location: {
                   filePath: 'src/hooks/overrideFieldExtensions.ts',
-                  lineNumber: 22,
+                  lineNumber: 31,
                 },
                 type: 'ItemType',
               },
@@ -1602,7 +1613,7 @@ export const manifest: Manifest = {
       returnType: 'FieldExtensionOverride | undefined',
       location: {
         filePath: 'src/hooks/overrideFieldExtensions.ts',
-        lineNumber: 15,
+        lineNumber: 24,
       },
     },
     onBoot: {
@@ -1736,7 +1747,7 @@ export const manifest: Manifest = {
       returnType: 'ManualFieldExtension[]',
       location: {
         filePath: 'src/hooks/manualFieldExtensions.ts',
-        lineNumber: 10,
+        lineNumber: 18,
       },
     },
     mainNavigationTabs: {
@@ -1755,7 +1766,7 @@ export const manifest: Manifest = {
       returnType: 'MainNavigationTab[]',
       location: {
         filePath: 'src/hooks/mainNavigationTabs.ts',
-        lineNumber: 11,
+        lineNumber: 18,
       },
     },
     itemsDropdownActions: {
@@ -1815,7 +1826,7 @@ export const manifest: Manifest = {
       returnType: 'ItemFormSidebar[]',
       location: {
         filePath: 'src/hooks/itemFormSidebars.ts',
-        lineNumber: 13,
+        lineNumber: 14,
       },
     },
     itemFormSidebarPanels: {
@@ -1839,7 +1850,7 @@ export const manifest: Manifest = {
       returnType: 'ItemFormSidebarPanel[]',
       location: {
         filePath: 'src/hooks/itemFormSidebarPanels.ts',
-        lineNumber: 14,
+        lineNumber: 22,
       },
     },
     itemFormOutlets: {
@@ -1863,7 +1874,7 @@ export const manifest: Manifest = {
       returnType: 'ItemFormOutlet[]',
       location: {
         filePath: 'src/hooks/itemFormOutlets.ts',
-        lineNumber: 13,
+        lineNumber: 14,
       },
     },
     itemFormDropdownActions: {
@@ -2006,7 +2017,7 @@ export const manifest: Manifest = {
       returnType: 'ItemCollectionOutlet[]',
       location: {
         filePath: 'src/hooks/itemCollectionOutlets.ts',
-        lineNumber: 13,
+        lineNumber: 14,
       },
     },
     initialLocationQueryForItemSelector: {
@@ -2840,7 +2851,7 @@ export const manifest: Manifest = {
               itemType: {
                 location: {
                   filePath: 'src/hooks/customMarksForStructuredTextField.ts',
-                  lineNumber: 22,
+                  lineNumber: 29,
                 },
                 type: 'ItemType',
               },
@@ -2852,7 +2863,7 @@ export const manifest: Manifest = {
       returnType: 'StructuredTextCustomMark[] | undefined',
       location: {
         filePath: 'src/hooks/customMarksForStructuredTextField.ts',
-        lineNumber: 15,
+        lineNumber: 22,
       },
     },
     customBlockStylesForStructuredTextField: {
@@ -2877,7 +2888,7 @@ export const manifest: Manifest = {
                 location: {
                   filePath:
                     'src/hooks/customBlockStylesForStructuredTextField.ts',
-                  lineNumber: 22,
+                  lineNumber: 23,
                 },
                 type: 'ItemType',
               },
@@ -2889,7 +2900,7 @@ export const manifest: Manifest = {
       returnType: 'StructuredTextCustomBlockStyle[] | undefined',
       location: {
         filePath: 'src/hooks/customBlockStylesForStructuredTextField.ts',
-        lineNumber: 15,
+        lineNumber: 16,
       },
     },
     contentAreaSidebarItems: {
@@ -2908,7 +2919,7 @@ export const manifest: Manifest = {
       returnType: 'ContentAreaSidebarItem[]',
       location: {
         filePath: 'src/hooks/contentAreaSidebarItems.ts',
-        lineNumber: 10,
+        lineNumber: 17,
       },
     },
     buildItemPresentationInfo: {
@@ -2932,7 +2943,7 @@ export const manifest: Manifest = {
       returnType: 'MaybePromise<ItemPresentationInfo | undefined>',
       location: {
         filePath: 'src/hooks/buildItemPresentationInfo.ts',
-        lineNumber: 14,
+        lineNumber: 15,
       },
     },
     assetSources: {
@@ -2951,7 +2962,7 @@ export const manifest: Manifest = {
       returnType: 'AssetSource[] | undefined',
       location: {
         filePath: 'src/hooks/assetSources.ts',
-        lineNumber: 11,
+        lineNumber: 12,
       },
     },
   },

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,32 @@ 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))
+  );
+}