datocms-plugin-sdk 2.1.0 → 2.1.1

package/dist/cjs/hooks/contentAreaSidebarItems.js

@@ -7,7 +7,7 @@ var icon_1 = require("../icon");
 function isContentAreaSidebarItem(value) {
     return ((0, guardUtils_js_1.isRecord)(value) &&
         (0, guardUtils_js_1.isString)(value.label) &&
-        (0, icon_1.isIcon)(value.icon) &&
+        (0, icon_1.isIconWithEmoji)(value.icon) &&
         (0, guardUtils_js_1.isRecord)(value.pointsTo) &&
         (0, guardUtils_js_1.isString)(value.pointsTo.pageId) &&
         ((0, guardUtils_js_1.isNullish)(value.placement) || (0, guardUtils_js_1.isPlacement)(value.placement)) &&

package/dist/cjs/hooks/contentAreaSidebarItems.js.map

@@ -1 +1 @@
-{"version":3,"file":"contentAreaSidebarItems.js","sourceRoot":"","sources":["../../../src/hooks/contentAreaSidebarItems.ts"],"names":[],"mappings":";;AA2DA,4DAYC;AAED,8FAIC;AA5ED,kDAO0B;AAC1B,gCAAuC;AAkDvC,SAAgB,wBAAwB,CACtC,KAAc;IAEd,OAAO,CACL,IAAA,wBAAQ,EAAC,KAAK,CAAC;QACf,IAAA,wBAAQ,EAAC,KAAK,CAAC,KAAK,CAAC;QACrB,IAAA,aAAM,EAAC,KAAK,CAAC,IAAI,CAAC;QAClB,IAAA,wBAAQ,EAAC,KAAK,CAAC,QAAQ,CAAC;QACxB,IAAA,wBAAQ,EAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC;QAC/B,CAAC,IAAA,yBAAS,EAAC,KAAK,CAAC,SAAS,CAAC,IAAI,IAAA,2BAAW,EAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC5D,CAAC,IAAA,yBAAS,EAAC,KAAK,CAAC,IAAI,CAAC,IAAI,IAAA,wBAAQ,EAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAChD,CAAC;AACJ,CAAC;AAED,SAAgB,yCAAyC,CACvD,KAAc;IAEd,OAAO,IAAA,uBAAO,EAAC,KAAK,EAAE,wBAAwB,CAAC,CAAC;AAClD,CAAC"}
+{"version":3,"file":"contentAreaSidebarItems.js","sourceRoot":"","sources":["../../../src/hooks/contentAreaSidebarItems.ts"],"names":[],"mappings":";;AA2DA,4DAYC;AAED,8FAIC;AA5ED,kDAO0B;AAC1B,gCAAyD;AAkDzD,SAAgB,wBAAwB,CACtC,KAAc;IAEd,OAAO,CACL,IAAA,wBAAQ,EAAC,KAAK,CAAC;QACf,IAAA,wBAAQ,EAAC,KAAK,CAAC,KAAK,CAAC;QACrB,IAAA,sBAAe,EAAC,KAAK,CAAC,IAAI,CAAC;QAC3B,IAAA,wBAAQ,EAAC,KAAK,CAAC,QAAQ,CAAC;QACxB,IAAA,wBAAQ,EAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC;QAC/B,CAAC,IAAA,yBAAS,EAAC,KAAK,CAAC,SAAS,CAAC,IAAI,IAAA,2BAAW,EAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC5D,CAAC,IAAA,yBAAS,EAAC,KAAK,CAAC,IAAI,CAAC,IAAI,IAAA,wBAAQ,EAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAChD,CAAC;AACJ,CAAC;AAED,SAAgB,yCAAyC,CACvD,KAAc;IAEd,OAAO,IAAA,uBAAO,EAAC,KAAK,EAAE,wBAAwB,CAAC,CAAC;AAClD,CAAC"}

package/dist/cjs/icon.js

@@ -3,9 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.isIcon = isIcon;
 exports.isSvgDefinition = isSvgDefinition;
 exports.isEmojiDefinition = isEmojiDefinition;
+exports.isIconWithEmoji = isIconWithEmoji;
 var guardUtils_js_1 = require("./guardUtils.js");
 function isIcon(value) {
-    return (0, guardUtils_js_1.isString)(value) || isSvgDefinition(value) || isEmojiDefinition(value);
+    return (0, guardUtils_js_1.isString)(value) || isSvgDefinition(value);
 }
 function isSvgDefinition(value) {
     return ((0, guardUtils_js_1.isRecord)(value) &&
@@ -16,4 +17,7 @@ function isSvgDefinition(value) {
 function isEmojiDefinition(value) {
     return (0, guardUtils_js_1.isRecord)(value) && value.type === 'emoji' && (0, guardUtils_js_1.isEmoji)(value.emoji);
 }
+function isIconWithEmoji(value) {
+    return isIcon(value) || isEmojiDefinition(value);
+}
 //# sourceMappingURL=icon.js.map

package/dist/cjs/icon.js.map

@@ -1 +1 @@
-{"version":3,"file":"icon.js","sourceRoot":"","sources":["../../src/icon.ts"],"names":[],"mappings":";;AAIA,wBAEC;AAwCD,0CAOC;AAuBD,8CAEC;AA9ED,iDAA8D;AAI9D,SAAgB,MAAM,CAAC,KAAc;IACnC,OAAO,IAAA,wBAAQ,EAAC,KAAK,CAAC,IAAI,eAAe,CAAC,KAAK,CAAC,IAAI,iBAAiB,CAAC,KAAK,CAAC,CAAC;AAC/E,CAAC;AAwCD,SAAgB,eAAe,CAAC,KAAc;IAC5C,OAAO,CACL,IAAA,wBAAQ,EAAC,KAAK,CAAC;QACf,KAAK,CAAC,IAAI,KAAK,KAAK;QACpB,IAAA,wBAAQ,EAAC,KAAK,CAAC,OAAO,CAAC;QACvB,IAAA,wBAAQ,EAAC,KAAK,CAAC,OAAO,CAAC,CACxB,CAAC;AACJ,CAAC;AAuBD,SAAgB,iBAAiB,CAAC,KAAc;IAC9C,OAAO,IAAA,wBAAQ,EAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,IAAI,IAAA,uBAAO,EAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AAC3E,CAAC"}
+{"version":3,"file":"icon.js","sourceRoot":"","sources":["../../src/icon.ts"],"names":[],"mappings":";;AAIA,wBAEC;AAwCD,0CAOC;AAuBD,8CAEC;AAQD,0CAEC;AAxFD,iDAA8D;AAI9D,SAAgB,MAAM,CAAC,KAAc;IACnC,OAAO,IAAA,wBAAQ,EAAC,KAAK,CAAC,IAAI,eAAe,CAAC,KAAK,CAAC,CAAC;AACnD,CAAC;AAwCD,SAAgB,eAAe,CAAC,KAAc;IAC5C,OAAO,CACL,IAAA,wBAAQ,EAAC,KAAK,CAAC;QACf,KAAK,CAAC,IAAI,KAAK,KAAK;QACpB,IAAA,wBAAQ,EAAC,KAAK,CAAC,OAAO,CAAC;QACvB,IAAA,wBAAQ,EAAC,KAAK,CAAC,OAAO,CAAC,CACxB,CAAC;AACJ,CAAC;AAuBD,SAAgB,iBAAiB,CAAC,KAAc;IAC9C,OAAO,IAAA,wBAAQ,EAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,IAAI,IAAA,uBAAO,EAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AAC3E,CAAC;AAQD,SAAgB,eAAe,CAAC,KAAc;IAC5C,OAAO,MAAM,CAAC,KAAK,CAAC,IAAI,iBAAiB,CAAC,KAAK,CAAC,CAAC;AACnD,CAAC"}

package/dist/esm/hooks/contentAreaSidebarItems.d.ts

@@ -1,5 +1,5 @@
 import { Ctx } from '../ctx/base';
-import { Icon } from '../icon';
+import { IconWithEmoji } from '../icon';
 export type ContentAreaSidebarItemsHook = {
     /**
      * Use this function to declare new items in the content area sidebar
@@ -19,11 +19,11 @@ export type ContentAreaSidebarItem = {
     label: string;
     /**
      * Icon to be shown alongside the label. Can be a FontAwesome icon name (ie.
-     * `"address-book"`) or a custom SVG definition. To maintain visual
+     * `"address-book"`), a custom SVG definition, or an emoji. To maintain visual
      * consistency with the rest of the interface, try to use FontAwesome icons
      * whenever possible.
      */
-    icon: Icon;
+    icon: IconWithEmoji;
     /** ID of the page linked to the item */
     pointsTo: {
         pageId: string;

package/dist/esm/hooks/contentAreaSidebarItems.js

@@ -1,9 +1,9 @@
 import { isArray, isNullish, isNumber, isPlacement, isRecord, isString, } from '../guardUtils.js';
-import { isIcon } from '../icon';
+import { isIconWithEmoji } from '../icon';
 export function isContentAreaSidebarItem(value) {
     return (isRecord(value) &&
         isString(value.label) &&
-        isIcon(value.icon) &&
+        isIconWithEmoji(value.icon) &&
         isRecord(value.pointsTo) &&
         isString(value.pointsTo.pageId) &&
         (isNullish(value.placement) || isPlacement(value.placement)) &&

package/dist/esm/hooks/contentAreaSidebarItems.js.map

@@ -1 +1 @@
-{"version":3,"file":"contentAreaSidebarItems.js","sourceRoot":"","sources":["../../../src/hooks/contentAreaSidebarItems.ts"],"names":[],"mappings":"AACA,OAAO,EACL,OAAO,EACP,SAAS,EACT,QAAQ,EACR,WAAW,EACX,QAAQ,EACR,QAAQ,GACT,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAQ,MAAM,EAAE,MAAM,SAAS,CAAC;AAkDvC,MAAM,UAAU,wBAAwB,CACtC,KAAc;IAEd,OAAO,CACL,QAAQ,CAAC,KAAK,CAAC;QACf,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC;QACrB,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;QAClB,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC;QACxB,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC;QAC/B,CAAC,SAAS,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,WAAW,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC5D,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAChD,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,yCAAyC,CACvD,KAAc;IAEd,OAAO,OAAO,CAAC,KAAK,EAAE,wBAAwB,CAAC,CAAC;AAClD,CAAC"}
+{"version":3,"file":"contentAreaSidebarItems.js","sourceRoot":"","sources":["../../../src/hooks/contentAreaSidebarItems.ts"],"names":[],"mappings":"AACA,OAAO,EACL,OAAO,EACP,SAAS,EACT,QAAQ,EACR,WAAW,EACX,QAAQ,EACR,QAAQ,GACT,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAiB,eAAe,EAAE,MAAM,SAAS,CAAC;AAkDzD,MAAM,UAAU,wBAAwB,CACtC,KAAc;IAEd,OAAO,CACL,QAAQ,CAAC,KAAK,CAAC;QACf,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC;QACrB,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC;QAC3B,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC;QACxB,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC;QAC/B,CAAC,SAAS,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,WAAW,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC5D,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAChD,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,yCAAyC,CACvD,KAAc;IAEd,OAAO,OAAO,CAAC,KAAK,EAAE,wBAAwB,CAAC,CAAC;AAClD,CAAC"}

package/dist/esm/icon.d.ts

@@ -1,4 +1,4 @@
-export type Icon = AwesomeFontIconIdentifier | SvgDefinition | EmojiDefinition;
+export type Icon = AwesomeFontIconIdentifier | SvgDefinition;
 export declare function isIcon(value: unknown): value is Icon;
 /**
  * Defines a custom SVG icon for use in DatoCMS plugins.
@@ -56,6 +56,12 @@ export type EmojiDefinition = {
     emoji: string;
 };
 export declare function isEmojiDefinition(value: unknown): value is EmojiDefinition;
+/**
+ * Extended icon type that includes emoji support in addition to Font Awesome and SVG icons.
+ * This type is specifically used for content area sidebar items where emoji icons are supported.
+ */
+export type IconWithEmoji = Icon | EmojiDefinition;
+export declare function isIconWithEmoji(value: unknown): value is IconWithEmoji;
 /**
  * Font Awesome icon identifier for use in DatoCMS plugins.
  *

package/dist/esm/icon.js

@@ -1,6 +1,6 @@
 import { isEmoji, isRecord, isString } from './guardUtils.js';
 export function isIcon(value) {
-    return isString(value) || isSvgDefinition(value) || isEmojiDefinition(value);
+    return isString(value) || isSvgDefinition(value);
 }
 export function isSvgDefinition(value) {
     return (isRecord(value) &&
@@ -11,4 +11,7 @@ export function isSvgDefinition(value) {
 export function isEmojiDefinition(value) {
     return isRecord(value) && value.type === 'emoji' && isEmoji(value.emoji);
 }
+export function isIconWithEmoji(value) {
+    return isIcon(value) || isEmojiDefinition(value);
+}
 //# sourceMappingURL=icon.js.map

package/dist/esm/icon.js.map

@@ -1 +1 @@
-{"version":3,"file":"icon.js","sourceRoot":"","sources":["../../src/icon.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAI9D,MAAM,UAAU,MAAM,CAAC,KAAc;IACnC,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,eAAe,CAAC,KAAK,CAAC,IAAI,iBAAiB,CAAC,KAAK,CAAC,CAAC;AAC/E,CAAC;AAwCD,MAAM,UAAU,eAAe,CAAC,KAAc;IAC5C,OAAO,CACL,QAAQ,CAAC,KAAK,CAAC;QACf,KAAK,CAAC,IAAI,KAAK,KAAK;QACpB,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC;QACvB,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CACxB,CAAC;AACJ,CAAC;AAuBD,MAAM,UAAU,iBAAiB,CAAC,KAAc;IAC9C,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AAC3E,CAAC"}
+{"version":3,"file":"icon.js","sourceRoot":"","sources":["../../src/icon.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAI9D,MAAM,UAAU,MAAM,CAAC,KAAc;IACnC,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,eAAe,CAAC,KAAK,CAAC,CAAC;AACnD,CAAC;AAwCD,MAAM,UAAU,eAAe,CAAC,KAAc;IAC5C,OAAO,CACL,QAAQ,CAAC,KAAK,CAAC;QACf,KAAK,CAAC,IAAI,KAAK,KAAK;QACpB,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC;QACvB,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CACxB,CAAC;AACJ,CAAC;AAuBD,MAAM,UAAU,iBAAiB,CAAC,KAAc;IAC9C,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AAC3E,CAAC;AAQD,MAAM,UAAU,eAAe,CAAC,KAAc;IAC5C,OAAO,MAAM,CAAC,KAAK,CAAC,IAAI,iBAAiB,CAAC,KAAK,CAAC,CAAC;AACnD,CAAC"}

package/dist/types/hooks/contentAreaSidebarItems.d.ts

@@ -1,5 +1,5 @@
 import { Ctx } from '../ctx/base';
-import { Icon } from '../icon';
+import { IconWithEmoji } from '../icon';
 export type ContentAreaSidebarItemsHook = {
     /**
      * Use this function to declare new items in the content area sidebar
@@ -19,11 +19,11 @@ export type ContentAreaSidebarItem = {
     label: string;
     /**
      * Icon to be shown alongside the label. Can be a FontAwesome icon name (ie.
-     * `"address-book"`) or a custom SVG definition. To maintain visual
+     * `"address-book"`), a custom SVG definition, or an emoji. To maintain visual
      * consistency with the rest of the interface, try to use FontAwesome icons
      * whenever possible.
      */
-    icon: Icon;
+    icon: IconWithEmoji;
     /** ID of the page linked to the item */
     pointsTo: {
         pageId: string;

package/dist/types/icon.d.ts

@@ -1,4 +1,4 @@
-export type Icon = AwesomeFontIconIdentifier | SvgDefinition | EmojiDefinition;
+export type Icon = AwesomeFontIconIdentifier | SvgDefinition;
 export declare function isIcon(value: unknown): value is Icon;
 /**
  * Defines a custom SVG icon for use in DatoCMS plugins.
@@ -56,6 +56,12 @@ export type EmojiDefinition = {
     emoji: string;
 };
 export declare function isEmojiDefinition(value: unknown): value is EmojiDefinition;
+/**
+ * Extended icon type that includes emoji support in addition to Font Awesome and SVG icons.
+ * This type is specifically used for content area sidebar items where emoji icons are supported.
+ */
+export type IconWithEmoji = Icon | EmojiDefinition;
+export declare function isIconWithEmoji(value: unknown): value is IconWithEmoji;
 /**
  * Font Awesome icon identifier for use in DatoCMS plugins.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "datocms-plugin-sdk",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "description": "DatoCMS Plugin SDK",
   "keywords": [
     "datocms",
@@ -46,5 +46,5 @@
     "glob": "^11.0.0",
     "typescript": "^5.6.2"
   },
-  "gitHead": "42fea5d307d19f45233586a41f3aad273f58a577"
+  "gitHead": "a8fcf4b05fe22e331b2fd95303793088aa15fedf"
 }

package/src/hooks/contentAreaSidebarItems.ts

@@ -7,7 +7,7 @@ import {
   isRecord,
   isString,
 } from '../guardUtils.js';
-import { Icon, isIcon } from '../icon';
+import { IconWithEmoji, isIconWithEmoji } from '../icon';
 
 export type ContentAreaSidebarItemsHook = {
   /**
@@ -32,11 +32,11 @@ export type ContentAreaSidebarItem = {
   label: string;
   /**
    * Icon to be shown alongside the label. Can be a FontAwesome icon name (ie.
-   * `"address-book"`) or a custom SVG definition. To maintain visual
+   * `"address-book"`), a custom SVG definition, or an emoji. To maintain visual
    * consistency with the rest of the interface, try to use FontAwesome icons
    * whenever possible.
    */
-  icon: Icon;
+  icon: IconWithEmoji;
   /** ID of the page linked to the item */
   pointsTo: {
     pageId: string;
@@ -63,7 +63,7 @@ export function isContentAreaSidebarItem(
   return (
     isRecord(value) &&
     isString(value.label) &&
-    isIcon(value.icon) &&
+    isIconWithEmoji(value.icon) &&
     isRecord(value.pointsTo) &&
     isString(value.pointsTo.pageId) &&
     (isNullish(value.placement) || isPlacement(value.placement)) &&

package/src/icon.ts

@@ -1,9 +1,9 @@
 import { isEmoji, isRecord, isString } from './guardUtils.js';
 
-export type Icon = AwesomeFontIconIdentifier | SvgDefinition | EmojiDefinition;
+export type Icon = AwesomeFontIconIdentifier | SvgDefinition;
 
 export function isIcon(value: unknown): value is Icon {
-  return isString(value) || isSvgDefinition(value) || isEmojiDefinition(value);
+  return isString(value) || isSvgDefinition(value);
 }
 
 /**
@@ -78,6 +78,16 @@ export function isEmojiDefinition(value: unknown): value is EmojiDefinition {
   return isRecord(value) && value.type === 'emoji' && isEmoji(value.emoji);
 }
 
+/**
+ * Extended icon type that includes emoji support in addition to Font Awesome and SVG icons.
+ * This type is specifically used for content area sidebar items where emoji icons are supported.
+ */
+export type IconWithEmoji = Icon | EmojiDefinition;
+
+export function isIconWithEmoji(value: unknown): value is IconWithEmoji {
+  return isIcon(value) || isEmojiDefinition(value);
+}
+
 /**
  * Font Awesome icon identifier for use in DatoCMS plugins.
  *