datocms-plugin-sdk 2.1.1 → 3.0.1-alpha.0

package/manifest.json

@@ -3109,13 +3109,34 @@
           },
           "theme": {
             "comment": {
-              "markdownText": "An object containing the theme colors for the current DatoCMS project."
+              "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"
+          },
+          "colorScheme": {
+            "comment": {
+              "markdownText": "The appearance color scheme the host CMS is currently using. Resolved —\n`'system'` is already expanded to `'light'` or `'dark'` by the host.\n\nThe SDK runtime reflects this onto `document.documentElement` as\n`data-theme=\"light\"` / `data-theme=\"dark\"` so plugin CSS can branch\nwith `[data-theme=\"dark\"] { … }` selectors. For non-CSS decisions\n(choosing a logo asset, a syntax-highlighting preset, …) branch on\n`ctx.colorScheme` directly."
+            },
+            "location": {
+              "filePath": "src/ctx/base.ts",
+              "lineNumber": 111
+            },
+            "type": "'light' | 'dark'"
           }
         }
       },
@@ -3131,7 +3152,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 97
+              "lineNumber": 121
             },
             "type": "Partial<Record<string, ItemType>>"
           },
@@ -3141,7 +3162,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 104
+              "lineNumber": 128
             },
             "type": "Partial<Record<string, Field>>"
           },
@@ -3151,7 +3172,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 111
+              "lineNumber": 135
             },
             "type": "Partial<Record<string, Fieldset>>"
           },
@@ -3161,7 +3182,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 118
+              "lineNumber": 142
             },
             "type": "Partial<Record<string, User>>"
           },
@@ -3171,7 +3192,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 125
+              "lineNumber": 149
             },
             "type": "Partial<Record<string, SsoUser>>"
           }
@@ -3192,7 +3213,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 168
+              "lineNumber": 353
             },
             "type": "(itemTypeId: string) => Promise<Field[]>"
           },
@@ -3203,7 +3224,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 187
+              "lineNumber": 372
             },
             "type": "(itemTypeId: string) => Promise<Fieldset[]>"
           },
@@ -3214,7 +3235,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 204
+              "lineNumber": 389
             },
             "type": "() => Promise<Field[]>"
           },
@@ -3225,7 +3246,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 217
+              "lineNumber": 402
             },
             "type": "() => Promise<User[]>"
           },
@@ -3236,7 +3257,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 230
+              "lineNumber": 415
             },
             "type": "() => Promise<SsoUser[]>"
           }
@@ -3255,7 +3276,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 252
+              "lineNumber": 437
             },
             "type": "(params: Record<string, unknown>) => Promise<void>"
           },
@@ -3266,7 +3287,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 303
+              "lineNumber": 488
             },
             "type": "(\n    fieldId: string,\n    changes: FieldAppearanceChange[],\n  ) => Promise<void>"
           }
@@ -3285,7 +3306,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 408
+              "lineNumber": 593
             },
             "type": "(message: string) => Promise<void>"
           },
@@ -3296,7 +3317,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 423
+              "lineNumber": 608
             },
             "type": "(message: string) => Promise<void>"
           },
@@ -3307,7 +3328,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 447
+              "lineNumber": 632
             },
             "type": "<CtaValue = unknown>(\n    toast: Toast<CtaValue>,\n  ) => Promise<CtaValue | null>"
           }
@@ -3326,7 +3347,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 333
+              "lineNumber": 518
             },
             "type": "(itemTypeId: string) => Promise<Item | null>"
           },
@@ -3337,7 +3358,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 354
+              "lineNumber": 539
             },
             "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 +3369,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 386
+              "lineNumber": 571
             },
             "type": "(itemId: string) => Promise<Item | null>"
           }
@@ -3367,7 +3388,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 474
+              "lineNumber": 659
             },
             "type": "{\n    (options: { multiple: true }): Promise<Upload[] | null>;\n    (options?: { multiple: false }): Promise<Upload | null>;\n  }"
           },
@@ -3378,7 +3399,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 502
+              "lineNumber": 687
             },
             "type": "(\n    uploadId: string,\n  ) => Promise<(Upload & { deleted?: true }) | null>"
           },
@@ -3389,7 +3410,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 530
+              "lineNumber": 715
             },
             "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 +3429,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 561
+              "lineNumber": 746
             },
             "type": "(modal: Modal) => Promise<unknown>"
           },
@@ -3419,7 +3440,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 598
+              "lineNumber": 783
             },
             "type": "(options: ConfirmOptions) => Promise<unknown>"
           }
@@ -3438,7 +3459,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 612
+              "lineNumber": 797
             },
             "type": "(path: string) => Promise<void>"
           }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "datocms-plugin-sdk",
-  "version": "2.1.1",
+  "version": "3.0.1-alpha.0",
   "description": "DatoCMS Plugin SDK",
   "keywords": [
     "datocms",
@@ -46,5 +46,5 @@
     "glob": "^11.0.0",
     "typescript": "^5.6.2"
   },
-  "gitHead": "a8fcf4b05fe22e331b2fd95303793088aa15fedf"
+  "gitHead": "52e7affbf92416cbc1cde78e016a62f3ff1a95cf"
 }

package/src/connect.ts

@@ -136,6 +136,15 @@ export type FullConnectParameters = AssetSourcesHook &
   UploadSidebarsHook &
   ValidateManualFieldExtensionParametersHook;
 
+function applyColorScheme(properties: unknown): void {
+  if (typeof document === 'undefined') return;
+  const next = (properties as { colorScheme?: 'light' | 'dark' } | null)
+    ?.colorScheme;
+  if (next !== 'light' && next !== 'dark') return;
+  if (document.documentElement.dataset.theme === next) return;
+  document.documentElement.dataset.theme = next;
+}
+
 export async function connect(
   rawConfiguration: Partial<FullConnectParameters> = {},
 ): Promise<void> {
@@ -185,6 +194,7 @@ export async function connect(
         ),
       ),
       onChange(newSettings: unknown) {
+        applyColorScheme(newSettings);
         if (onChangeListener) {
           onChangeListener(newSettings);
         }
@@ -212,6 +222,7 @@ export async function connect(
 
   const methods = await penpalConnection.promise;
   const initialProperties = await methods.getSettings();
+  applyColorScheme(initialProperties);
 
   if (initialProperties.mode === 'onBoot') {
     let currentProperties = initialProperties;

package/src/ctx/base.ts

@@ -83,8 +83,32 @@ type ProjectProperties = {
     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;
+
+  /**
+   * The appearance color scheme the host CMS is currently using. Resolved —
+   * `'system'` is already expanded to `'light'` or `'dark'` by the host.
+   *
+   * The SDK runtime reflects this onto `document.documentElement` as
+   * `data-theme="light"` / `data-theme="dark"` so plugin CSS can branch
+   * with `[data-theme="dark"] { … }` selectors. For non-CSS decisions
+   * (choosing a logo asset, a syntax-highlighting preset, …) branch on
+   * `ctx.colorScheme` directly.
+   */
+  colorScheme: 'light' | 'dark';
 };
 
 /**
@@ -125,7 +149,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;
@@ -134,6 +163,162 @@ export type Theme = {
   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 = {
+  /* --- Standalone --- */
+  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;
+
+  /* --- Context: raised --- */
+  colorRaisedSurface?: string;
+  colorRaisedSurfaceHover?: string;
+  colorRaisedSurfaceActive?: string;
+
+  /* --- Context: primary --- */
+  colorPrimarySurface?: string;
+  colorPrimarySurfaceHover?: string;
+  colorPrimarySurfaceActive?: string;
+  colorPrimarySurfaceMuted?: string;
+  colorPrimaryInk?: string;
+  colorPrimaryBorder?: string;
+
+  /* --- Context: tinted --- */
+  colorTintedSurface?: string;
+  colorTintedSurfaceHover?: string;
+  colorTintedSurfaceActive?: string;
+  colorTintedInk?: string;
+
+  /* --- Context: accent --- */
+  colorAccentSurface?: string;
+  colorAccentInk?: string;
+
+  /* --- Context: selected --- */
+  colorSelectedSurface?: string;
+  colorSelectedInk?: string;
+  colorSelectedBorder?: string;
+
+  /* --- Context: disabled --- */
+  colorDisabledSurface?: string;
+  colorDisabledInk?: string;
+
+  /* --- Context: danger --- */
+  colorDangerSurface?: string;
+  colorDangerInk?: string;
+
+  /* --- Context: enterprise --- */
+  colorEnterpriseSurface?: string;
+
+  /* --- Context: focus --- */
+  colorFocusBorder?: string;
+  colorFocusOutline?: string;
+
+  /* --- Feedback --- */
+  colorFeedbackFailInk?: string;
+  colorFeedbackFailBorder?: string;
+  colorFeedbackFailOutline?: string;
+  colorFeedbackWarningInk?: string;
+  colorFeedbackWarningSurface?: string;
+  colorFeedbackSuccessInk?: string;
+  colorFeedbackWarningBorder?: string;
+  colorFeedbackSuccessBorder?: string;
+
+  /* --- Context: highlight --- */
+  colorHighlightSurface?: string;
+
+  /* --- Diffs --- */
+  colorDiffAddedSurface?: string;
+  colorDiffRemovedSurface?: string;
+  colorDiffChangedSurface?: string;
+  colorDiffAddedSurfaceSubtle?: string;
+  colorDiffRemovedSurfaceSubtle?: string;
+  colorDiffChangedSurfaceSubtle?: string;
+  colorDiffAddedOutlineSubtle?: string;
+  colorDiffRemovedOutlineSubtle?: string;
+  colorDiffChangedOutlineSubtle?: string;
+  colorDiffChangedBorder?: string;
+  colorDiffChangedBorderNegative?: string;
+
+  /* --- Status --- */
+  colorStatusDraftInk?: string;
+  colorStatusOutdatedInk?: string;
+  colorStatusPublishedInk?: string;
+
+  /* --- Backdrop --- */
+  colorBackdropSurface?: string;
+  colorBackdropInk?: string;
+
+  /* --- Overlay --- */
+  colorOverlaySurface?: string;
+  colorOverlaySurfaceSubtle?: string;
+  colorOverlayInk?: string;
+
+  /* --- Stacked --- */
+  colorStackedSurfaceBase?: string;
+  colorStackedSurface?: string;
+  colorStackedSurfaceRaised?: string;
+  colorStackedInk?: string;
+  colorStackedInkSubtle?: string;
+  colorStackedBorder?: string;
+  colorStackedSurfaceHover?: string;
+  colorStackedSurfaceTranslucent?: string;
+  colorStackedSurfaceButton?: string;
+  colorStackedSurfaceButtonActive?: string;
+
+  /* --- Progress --- */
+  colorProgressTrack?: string;
+  colorProgressFill?: string;
+  colorProgressFillHover?: string;
+
+  /* --- Tooltip --- */
+  colorTooltipSurface?: string;
+  colorTooltipSurfaceHover?: string;
+  colorTooltipInk?: string;
+  colorTooltipInkSubtle?: string;
+
+  /* --- Code --- */
+  colorCodeSurface?: string;
+  colorCodeInk?: string;
+
+  /* --- Shadows --- */
+  colorShadowSubtle?: string;
+  colorShadow?: string;
+  colorShadowStrong?: string;
+
+  /* --- Scrollbar --- */
+  colorScrollbar?: string;
+
+  /* --- Shadow composites --- */
+  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 &