datocms-plugin-sdk 2.1.0 → 3.0.0-alpha.0

package/dist/esm/ctx/base.d.ts

@@ -62,8 +62,19 @@ type ProjectProperties = {
         /** Preferred locale */
         locale: string;
     };
-    /** An object containing the theme colors for the current DatoCMS project */
+    /**
+     * An object containing the theme colors for the current DatoCMS project
+     *
+     * @deprecated Use `semanticColorTokensTheme` instead. This property is kept
+     *   for backward compatibility with third-party plugins.
+     */
     theme: Theme;
+    /**
+     * Semantic color tokens for the current DatoCMS project, pre-computed by
+     * the host. Only available on DatoCMS hosts that support the new token
+     * system.
+     */
+    semanticColorTokensTheme: SemanticColorTokensTheme;
 };
 /**
  * These properties provide access to "entity repos", that is, the collection of
@@ -98,7 +109,12 @@ type EntityReposProperties = {
      */
     ssoUsers: Partial<Record<string, SsoUser>>;
 };
-/** An object containing the theme colors for the current DatoCMS project */
+/**
+ * An object containing the theme colors for the current DatoCMS project
+ *
+ * @deprecated Use `SemanticColorTokensTheme` instead. This type is kept for
+ *   backward compatibility with third-party plugins.
+ */
 export type Theme = {
     primaryColor: string;
     accentColor: string;
@@ -106,6 +122,114 @@ export type Theme = {
     lightColor: string;
     darkColor: string;
 };
+/**
+ * Known semantic color tokens provided by the DatoCMS host.
+ * All properties are optional — the host may not send all of them.
+ *
+ * camelCase keys are converted to kebab-case CSS custom properties via
+ * `camelToDash`. For example, `colorRaisedSurface` becomes
+ * `--color-raised-surface`.
+ */
+type KnownSemanticColorTokens = {
+    colorSurface?: string;
+    colorSurfaceHover?: string;
+    colorSurfaceMuted?: string;
+    colorInk?: string;
+    colorInkSubtle?: string;
+    colorInkHover?: string;
+    colorInkMuted?: string;
+    colorInkPlaceholder?: string;
+    colorInkPrimary?: string;
+    colorInkAccent?: string;
+    colorInkDisabled?: string;
+    colorBorder?: string;
+    colorBorderHover?: string;
+    colorRaisedSurface?: string;
+    colorRaisedSurfaceHover?: string;
+    colorRaisedSurfaceActive?: string;
+    colorPrimarySurface?: string;
+    colorPrimarySurfaceHover?: string;
+    colorPrimarySurfaceActive?: string;
+    colorPrimarySurfaceMuted?: string;
+    colorPrimaryInk?: string;
+    colorPrimaryBorder?: string;
+    colorTintedSurface?: string;
+    colorTintedSurfaceHover?: string;
+    colorTintedSurfaceActive?: string;
+    colorTintedInk?: string;
+    colorAccentSurface?: string;
+    colorAccentInk?: string;
+    colorSelectedSurface?: string;
+    colorSelectedInk?: string;
+    colorSelectedBorder?: string;
+    colorDisabledSurface?: string;
+    colorDisabledInk?: string;
+    colorDangerSurface?: string;
+    colorDangerInk?: string;
+    colorEnterpriseSurface?: string;
+    colorFocusBorder?: string;
+    colorFocusOutline?: string;
+    colorFeedbackFailInk?: string;
+    colorFeedbackFailBorder?: string;
+    colorFeedbackFailOutline?: string;
+    colorFeedbackWarningInk?: string;
+    colorFeedbackWarningSurface?: string;
+    colorFeedbackSuccessInk?: string;
+    colorFeedbackWarningBorder?: string;
+    colorFeedbackSuccessBorder?: string;
+    colorHighlightSurface?: string;
+    colorDiffAddedSurface?: string;
+    colorDiffRemovedSurface?: string;
+    colorDiffChangedSurface?: string;
+    colorDiffAddedSurfaceSubtle?: string;
+    colorDiffRemovedSurfaceSubtle?: string;
+    colorDiffChangedSurfaceSubtle?: string;
+    colorDiffAddedOutlineSubtle?: string;
+    colorDiffRemovedOutlineSubtle?: string;
+    colorDiffChangedOutlineSubtle?: string;
+    colorDiffChangedBorder?: string;
+    colorDiffChangedBorderNegative?: string;
+    colorStatusDraftInk?: string;
+    colorStatusOutdatedInk?: string;
+    colorStatusPublishedInk?: string;
+    colorBackdropSurface?: string;
+    colorBackdropInk?: string;
+    colorOverlaySurface?: string;
+    colorOverlaySurfaceSubtle?: string;
+    colorOverlayInk?: string;
+    colorStackedSurfaceBase?: string;
+    colorStackedSurface?: string;
+    colorStackedSurfaceRaised?: string;
+    colorStackedInk?: string;
+    colorStackedInkSubtle?: string;
+    colorStackedBorder?: string;
+    colorStackedSurfaceHover?: string;
+    colorStackedSurfaceTranslucent?: string;
+    colorStackedSurfaceButton?: string;
+    colorStackedSurfaceButtonActive?: string;
+    colorProgressTrack?: string;
+    colorProgressFill?: string;
+    colorProgressFillHover?: string;
+    colorTooltipSurface?: string;
+    colorTooltipSurfaceHover?: string;
+    colorTooltipInk?: string;
+    colorTooltipInkSubtle?: string;
+    colorCodeSurface?: string;
+    colorCodeInk?: string;
+    colorShadowSubtle?: string;
+    colorShadow?: string;
+    colorShadowStrong?: string;
+    colorScrollbar?: string;
+    shadowElevated?: string;
+    shadowFloat?: string;
+    shadowAmbient?: string;
+};
+/**
+ * Semantic color tokens for the current DatoCMS project, pre-computed by the
+ * host. Known tokens get autocomplete; unknown tokens are accepted via the
+ * index signature for forward compatibility.
+ */
+export type SemanticColorTokensTheme = KnownSemanticColorTokens & Record<string, string>;
 export type BaseMethods = LoadDataMethods & UpdatePluginParametersMethods & ToastMethods & ItemDialogMethods & UploadDialogMethods & CustomDialogMethods & NavigateMethods;
 /**
  * These methods can be used to asyncronously load additional information your

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/esm/manifest.js

@@ -3110,13 +3110,24 @@ export var manifest = {
                     theme: {
                         comment: {
                             markdownText: 'An object containing the theme colors for the current DatoCMS project.',
+                            deprecatedMarkdownText: 'Use `semanticColorTokensTheme` instead. This property is kept\nfor backward compatibility with third-party plugins.',
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 87,
+                            lineNumber: 92,
                         },
                         type: 'Theme',
                     },
+                    semanticColorTokensTheme: {
+                        comment: {
+                            markdownText: 'Semantic color tokens for the current DatoCMS project, pre-computed by\nthe host. Only available on DatoCMS hosts that support the new token\nsystem.',
+                        },
+                        location: {
+                            filePath: 'src/ctx/base.ts',
+                            lineNumber: 99,
+                        },
+                        type: 'SemanticColorTokensTheme',
+                    },
                 },
             },
             {
@@ -3131,7 +3142,7 @@ export var manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 97,
+                            lineNumber: 109,
                         },
                         type: 'Partial<Record<string, ItemType>>',
                     },
@@ -3141,7 +3152,7 @@ export var manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 104,
+                            lineNumber: 116,
                         },
                         type: 'Partial<Record<string, Field>>',
                     },
@@ -3151,7 +3162,7 @@ export var manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 111,
+                            lineNumber: 123,
                         },
                         type: 'Partial<Record<string, Fieldset>>',
                     },
@@ -3161,7 +3172,7 @@ export var manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 118,
+                            lineNumber: 130,
                         },
                         type: 'Partial<Record<string, User>>',
                     },
@@ -3171,7 +3182,7 @@ export var manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 125,
+                            lineNumber: 137,
                         },
                         type: 'Partial<Record<string, SsoUser>>',
                     },
@@ -3192,7 +3203,7 @@ export var manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 168,
+                            lineNumber: 341,
                         },
                         type: '(itemTypeId: string) => Promise<Field[]>',
                     },
@@ -3203,7 +3214,7 @@ export var manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 187,
+                            lineNumber: 360,
                         },
                         type: '(itemTypeId: string) => Promise<Fieldset[]>',
                     },
@@ -3214,7 +3225,7 @@ export var manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 204,
+                            lineNumber: 377,
                         },
                         type: '() => Promise<Field[]>',
                     },
@@ -3225,7 +3236,7 @@ export var manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 217,
+                            lineNumber: 390,
                         },
                         type: '() => Promise<User[]>',
                     },
@@ -3236,7 +3247,7 @@ export var manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 230,
+                            lineNumber: 403,
                         },
                         type: '() => Promise<SsoUser[]>',
                     },
@@ -3255,7 +3266,7 @@ export var manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 252,
+                            lineNumber: 425,
                         },
                         type: '(params: Record<string, unknown>) => Promise<void>',
                     },
@@ -3266,7 +3277,7 @@ export var manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 303,
+                            lineNumber: 476,
                         },
                         type: '(\n    fieldId: string,\n    changes: FieldAppearanceChange[],\n  ) => Promise<void>',
                     },
@@ -3285,7 +3296,7 @@ export var manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 408,
+                            lineNumber: 581,
                         },
                         type: '(message: string) => Promise<void>',
                     },
@@ -3296,7 +3307,7 @@ export var manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 423,
+                            lineNumber: 596,
                         },
                         type: '(message: string) => Promise<void>',
                     },
@@ -3307,7 +3318,7 @@ export var manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 447,
+                            lineNumber: 620,
                         },
                         type: '<CtaValue = unknown>(\n    toast: Toast<CtaValue>,\n  ) => Promise<CtaValue | null>',
                     },
@@ -3326,7 +3337,7 @@ export var manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 333,
+                            lineNumber: 506,
                         },
                         type: '(itemTypeId: string) => Promise<Item | null>',
                     },
@@ -3337,7 +3348,7 @@ export var manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 354,
+                            lineNumber: 527,
                         },
                         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 +3359,7 @@ export var manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 386,
+                            lineNumber: 559,
                         },
                         type: '(itemId: string) => Promise<Item | null>',
                     },
@@ -3367,7 +3378,7 @@ export var manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 474,
+                            lineNumber: 647,
                         },
                         type: '{\n    (options: { multiple: true }): Promise<Upload[] | null>;\n    (options?: { multiple: false }): Promise<Upload | null>;\n  }',
                     },
@@ -3378,7 +3389,7 @@ export var manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 502,
+                            lineNumber: 675,
                         },
                         type: '(\n    uploadId: string,\n  ) => Promise<(Upload & { deleted?: true }) | null>',
                     },
@@ -3389,7 +3400,7 @@ export var manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 530,
+                            lineNumber: 703,
                         },
                         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 +3419,7 @@ export var manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 561,
+                            lineNumber: 734,
                         },
                         type: '(modal: Modal) => Promise<unknown>',
                     },
@@ -3419,7 +3430,7 @@ export var manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 598,
+                            lineNumber: 771,
                         },
                         type: '(options: ConfirmOptions) => Promise<unknown>',
                     },
@@ -3438,7 +3449,7 @@ export var manifest = {
                         },
                         location: {
                             filePath: 'src/ctx/base.ts',
-                            lineNumber: 612,
+                            lineNumber: 785,
                         },
                         type: '(path: string) => Promise<void>',
                     },