datocms-plugin-sdk 2.1.0 → 2.1.5

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/manifest.json

@@ -3076,13 +3076,33 @@
             },
             "type": "boolean"
           },
+          "cdaEndpointUrl": {
+            "comment": {
+              "markdownText": "The URL of the Content Delivery API (GraphQL) endpoint for the current\nproject and environment.\n\nIn the vast majority of cases you don't need this: the CDA endpoint is at a\nwell-known, stable URL. It's exposed here only to support DatoCMS internal\ntesting against non-production environments (e.g. staging)."
+            },
+            "location": {
+              "filePath": "src/ctx/base.ts",
+              "lineNumber": 74
+            },
+            "type": "string"
+          },
+          "cmaBaseUrl": {
+            "comment": {
+              "markdownText": "The base URL of the Content Management API.\n\nIn the vast majority of cases you don't need this: the CMA lives at a\nwell-known, stable URL. It's exposed here only to support DatoCMS internal\ntesting against non-production environments (e.g. staging)."
+            },
+            "location": {
+              "filePath": "src/ctx/base.ts",
+              "lineNumber": 83
+            },
+            "type": "string"
+          },
           "owner": {
             "comment": {
               "markdownText": "The account/organization that is the project owner."
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 67
+              "lineNumber": 86
             },
             "type": "Account | Organization"
           },
@@ -3093,7 +3113,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 75
+              "lineNumber": 94
             },
             "type": "Account | undefined"
           },
@@ -3103,7 +3123,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 81
+              "lineNumber": 100
             },
             "type": "{\n    /** Preferred locale */\n    locale: string;\n  }"
           },
@@ -3113,7 +3133,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 87
+              "lineNumber": 106
             },
             "type": "Theme"
           }
@@ -3131,7 +3151,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 97
+              "lineNumber": 116
             },
             "type": "Partial<Record<string, ItemType>>"
           },
@@ -3141,7 +3161,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 104
+              "lineNumber": 123
             },
             "type": "Partial<Record<string, Field>>"
           },
@@ -3151,7 +3171,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 111
+              "lineNumber": 130
             },
             "type": "Partial<Record<string, Fieldset>>"
           },
@@ -3161,7 +3181,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 118
+              "lineNumber": 137
             },
             "type": "Partial<Record<string, User>>"
           },
@@ -3171,7 +3191,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 125
+              "lineNumber": 144
             },
             "type": "Partial<Record<string, SsoUser>>"
           }
@@ -3192,7 +3212,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 168
+              "lineNumber": 187
             },
             "type": "(itemTypeId: string) => Promise<Field[]>"
           },
@@ -3203,7 +3223,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 187
+              "lineNumber": 206
             },
             "type": "(itemTypeId: string) => Promise<Fieldset[]>"
           },
@@ -3214,7 +3234,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 204
+              "lineNumber": 223
             },
             "type": "() => Promise<Field[]>"
           },
@@ -3225,7 +3245,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 217
+              "lineNumber": 236
             },
             "type": "() => Promise<User[]>"
           },
@@ -3236,7 +3256,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 230
+              "lineNumber": 249
             },
             "type": "() => Promise<SsoUser[]>"
           }
@@ -3255,7 +3275,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 252
+              "lineNumber": 271
             },
             "type": "(params: Record<string, unknown>) => Promise<void>"
           },
@@ -3266,7 +3286,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 303
+              "lineNumber": 322
             },
             "type": "(\n    fieldId: string,\n    changes: FieldAppearanceChange[],\n  ) => Promise<void>"
           }
@@ -3285,7 +3305,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 408
+              "lineNumber": 427
             },
             "type": "(message: string) => Promise<void>"
           },
@@ -3296,7 +3316,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 423
+              "lineNumber": 442
             },
             "type": "(message: string) => Promise<void>"
           },
@@ -3307,7 +3327,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 447
+              "lineNumber": 466
             },
             "type": "<CtaValue = unknown>(\n    toast: Toast<CtaValue>,\n  ) => Promise<CtaValue | null>"
           }
@@ -3326,7 +3346,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 333
+              "lineNumber": 352
             },
             "type": "(itemTypeId: string) => Promise<Item | null>"
           },
@@ -3337,7 +3357,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 354
+              "lineNumber": 373
             },
             "type": "{\n    (\n      itemTypeId: string,\n      options: { multiple: true; initialLocationQuery?: ItemListLocationQuery },\n    ): Promise<Item[] | null>;\n    (\n      itemTypeId: string,\n      options?: {\n        multiple: false;\n        initialLocationQuery?: ItemListLocationQuery;\n      },\n    ): Promise<Item | null>;\n  }"
           },
@@ -3348,7 +3368,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 386
+              "lineNumber": 405
             },
             "type": "(itemId: string) => Promise<Item | null>"
           }
@@ -3367,7 +3387,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 474
+              "lineNumber": 493
             },
             "type": "{\n    (options: { multiple: true }): Promise<Upload[] | null>;\n    (options?: { multiple: false }): Promise<Upload | null>;\n  }"
           },
@@ -3378,7 +3398,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 502
+              "lineNumber": 521
             },
             "type": "(\n    uploadId: string,\n  ) => Promise<(Upload & { deleted?: true }) | null>"
           },
@@ -3389,7 +3409,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 530
+              "lineNumber": 549
             },
             "type": "(\n    /** The \"single asset\" field structure */\n    fileFieldValue: FileFieldValue,\n    /** Shows metadata information for a specific locale */\n    locale?: string,\n  ) => Promise<FileFieldValue | null>"
           }
@@ -3408,7 +3428,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 561
+              "lineNumber": 580
             },
             "type": "(modal: Modal) => Promise<unknown>"
           },
@@ -3419,7 +3439,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 598
+              "lineNumber": 617
             },
             "type": "(options: ConfirmOptions) => Promise<unknown>"
           }
@@ -3438,7 +3458,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 612
+              "lineNumber": 631
             },
             "type": "(path: string) => Promise<void>"
           }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "datocms-plugin-sdk",
-  "version": "2.1.0",
+  "version": "2.1.5",
   "description": "DatoCMS Plugin SDK",
   "keywords": [
     "datocms",
@@ -38,7 +38,7 @@
   "dependencies": {
     "@datocms/cma-client": "*",
     "@types/react": "^17.0.3",
-    "datocms-structured-text-utils": "^2.0.0",
+    "datocms-structured-text-utils": "^5.1.16",
     "emoji-regex-xs": "*",
     "penpal": "^4.1.1"
   },
@@ -46,5 +46,5 @@
     "glob": "^11.0.0",
     "typescript": "^5.6.2"
   },
-  "gitHead": "42fea5d307d19f45233586a41f3aad273f58a577"
+  "gitHead": "1fc2f5b9c06a8bac49bd0e2cf731e599415ce010"
 }

package/src/ctx/base.ts

@@ -63,6 +63,25 @@ type ProjectProperties = {
   /** Whether the current environment is the primary one */
   isEnvironmentPrimary: boolean;
 
+  /**
+   * The URL of the Content Delivery API (GraphQL) endpoint for the current
+   * project and environment.
+   *
+   * In the vast majority of cases you don't need this: the CDA endpoint is at a
+   * well-known, stable URL. It's exposed here only to support DatoCMS internal
+   * testing against non-production environments (e.g. staging).
+   */
+  cdaEndpointUrl: string;
+
+  /**
+   * The base URL of the Content Management API.
+   *
+   * In the vast majority of cases you don't need this: the CMA lives at a
+   * well-known, stable URL. It's exposed here only to support DatoCMS internal
+   * testing against non-production environments (e.g. staging).
+   */
+  cmaBaseUrl: string;
+
   /** The account/organization that is the project owner */
   owner: Account | Organization;
 

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.
  *

package/src/manifest.ts

@@ -3302,6 +3302,28 @@ export const manifest: Manifest = {
             },
             type: 'boolean',
           },
+          cdaEndpointUrl: {
+            comment: {
+              markdownText:
+                "The URL of the Content Delivery API (GraphQL) endpoint for the current\nproject and environment.\n\nIn the vast majority of cases you don't need this: the CDA endpoint is at a\nwell-known, stable URL. It's exposed here only to support DatoCMS internal\ntesting against non-production environments (e.g. staging).",
+            },
+            location: {
+              filePath: 'src/ctx/base.ts',
+              lineNumber: 74,
+            },
+            type: 'string',
+          },
+          cmaBaseUrl: {
+            comment: {
+              markdownText:
+                "The base URL of the Content Management API.\n\nIn the vast majority of cases you don't need this: the CMA lives at a\nwell-known, stable URL. It's exposed here only to support DatoCMS internal\ntesting against non-production environments (e.g. staging).",
+            },
+            location: {
+              filePath: 'src/ctx/base.ts',
+              lineNumber: 83,
+            },
+            type: 'string',
+          },
           owner: {
             comment: {
               markdownText:
@@ -3309,7 +3331,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 67,
+              lineNumber: 86,
             },
             type: 'Account | Organization',
           },
@@ -3321,7 +3343,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 75,
+              lineNumber: 94,
             },
             type: 'Account | undefined',
           },
@@ -3332,7 +3354,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 81,
+              lineNumber: 100,
             },
             type: '{\n    /** Preferred locale */\n    locale: string;\n  }',
           },
@@ -3343,7 +3365,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 87,
+              lineNumber: 106,
             },
             type: 'Theme',
           },
@@ -3363,7 +3385,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 97,
+              lineNumber: 116,
             },
             type: 'Partial<Record<string, ItemType>>',
           },
@@ -3374,7 +3396,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 104,
+              lineNumber: 123,
             },
             type: 'Partial<Record<string, Field>>',
           },
@@ -3385,7 +3407,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 111,
+              lineNumber: 130,
             },
             type: 'Partial<Record<string, Fieldset>>',
           },
@@ -3396,7 +3418,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 118,
+              lineNumber: 137,
             },
             type: 'Partial<Record<string, User>>',
           },
@@ -3407,7 +3429,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 125,
+              lineNumber: 144,
             },
             type: 'Partial<Record<string, SsoUser>>',
           },
@@ -3431,7 +3453,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 168,
+              lineNumber: 187,
             },
             type: '(itemTypeId: string) => Promise<Field[]>',
           },
@@ -3444,7 +3466,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 187,
+              lineNumber: 206,
             },
             type: '(itemTypeId: string) => Promise<Fieldset[]>',
           },
@@ -3457,7 +3479,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 204,
+              lineNumber: 223,
             },
             type: '() => Promise<Field[]>',
           },
@@ -3470,7 +3492,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 217,
+              lineNumber: 236,
             },
             type: '() => Promise<User[]>',
           },
@@ -3483,7 +3505,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 230,
+              lineNumber: 249,
             },
             type: '() => Promise<SsoUser[]>',
           },
@@ -3505,7 +3527,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 252,
+              lineNumber: 271,
             },
             type: '(params: Record<string, unknown>) => Promise<void>',
           },
@@ -3518,7 +3540,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 303,
+              lineNumber: 322,
             },
             type: '(\n    fieldId: string,\n    changes: FieldAppearanceChange[],\n  ) => Promise<void>',
           },
@@ -3540,7 +3562,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 408,
+              lineNumber: 427,
             },
             type: '(message: string) => Promise<void>',
           },
@@ -3553,7 +3575,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 423,
+              lineNumber: 442,
             },
             type: '(message: string) => Promise<void>',
           },
@@ -3566,7 +3588,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 447,
+              lineNumber: 466,
             },
             type: '<CtaValue = unknown>(\n    toast: Toast<CtaValue>,\n  ) => Promise<CtaValue | null>',
           },
@@ -3588,7 +3610,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 333,
+              lineNumber: 352,
             },
             type: '(itemTypeId: string) => Promise<Item | null>',
           },
@@ -3601,7 +3623,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 354,
+              lineNumber: 373,
             },
             type: '{\n    (\n      itemTypeId: string,\n      options: { multiple: true; initialLocationQuery?: ItemListLocationQuery },\n    ): Promise<Item[] | null>;\n    (\n      itemTypeId: string,\n      options?: {\n        multiple: false;\n        initialLocationQuery?: ItemListLocationQuery;\n      },\n    ): Promise<Item | null>;\n  }',
           },
@@ -3614,7 +3636,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 386,
+              lineNumber: 405,
             },
             type: '(itemId: string) => Promise<Item | null>',
           },
@@ -3636,7 +3658,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 474,
+              lineNumber: 493,
             },
             type: '{\n    (options: { multiple: true }): Promise<Upload[] | null>;\n    (options?: { multiple: false }): Promise<Upload | null>;\n  }',
           },
@@ -3649,7 +3671,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 502,
+              lineNumber: 521,
             },
             type: '(\n    uploadId: string,\n  ) => Promise<(Upload & { deleted?: true }) | null>',
           },
@@ -3662,7 +3684,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 530,
+              lineNumber: 549,
             },
             type: '(\n    /** The "single asset" field structure */\n    fileFieldValue: FileFieldValue,\n    /** Shows metadata information for a specific locale */\n    locale?: string,\n  ) => Promise<FileFieldValue | null>',
           },
@@ -3684,7 +3706,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 561,
+              lineNumber: 580,
             },
             type: '(modal: Modal) => Promise<unknown>',
           },
@@ -3697,7 +3719,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 598,
+              lineNumber: 617,
             },
             type: '(options: ConfirmOptions) => Promise<unknown>',
           },
@@ -3718,7 +3740,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 612,
+              lineNumber: 631,
             },
             type: '(path: string) => Promise<void>',
           },