datocms-plugin-sdk 2.1.5 → 2.2.0-alpha.1

package/manifest.json

@@ -3129,13 +3129,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": 106
+              "lineNumber": 111
             },
             "type": "Theme"
+          },
+          "semanticColorTokensTheme": {
+            "comment": {
+              "markdownText": "Semantic color tokens for the current DatoCMS project, pre-computed by\nthe host. A map of CSS custom property names (e.g.\n`--color--raised--surface`) to their resolved values for the current\ncolor scheme."
+            },
+            "location": {
+              "filePath": "src/ctx/base.ts",
+              "lineNumber": 119
+            },
+            "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": 131
+            },
+            "type": "'light' | 'dark'"
           }
         }
       },
@@ -3151,7 +3172,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 116
+              "lineNumber": 141
             },
             "type": "Partial<Record<string, ItemType>>"
           },
@@ -3161,7 +3182,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 123
+              "lineNumber": 148
             },
             "type": "Partial<Record<string, Field>>"
           },
@@ -3171,7 +3192,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 130
+              "lineNumber": 155
             },
             "type": "Partial<Record<string, Fieldset>>"
           },
@@ -3181,7 +3202,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 137
+              "lineNumber": 162
             },
             "type": "Partial<Record<string, User>>"
           },
@@ -3191,7 +3212,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 144
+              "lineNumber": 169
             },
             "type": "Partial<Record<string, SsoUser>>"
           }
@@ -3212,7 +3233,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 187
+              "lineNumber": 232
             },
             "type": "(itemTypeId: string) => Promise<Field[]>"
           },
@@ -3223,7 +3244,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 206
+              "lineNumber": 251
             },
             "type": "(itemTypeId: string) => Promise<Fieldset[]>"
           },
@@ -3234,7 +3255,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 223
+              "lineNumber": 268
             },
             "type": "() => Promise<Field[]>"
           },
@@ -3245,7 +3266,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 236
+              "lineNumber": 281
             },
             "type": "() => Promise<User[]>"
           },
@@ -3256,7 +3277,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 249
+              "lineNumber": 294
             },
             "type": "() => Promise<SsoUser[]>"
           }
@@ -3275,7 +3296,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 271
+              "lineNumber": 316
             },
             "type": "(params: Record<string, unknown>) => Promise<void>"
           },
@@ -3286,7 +3307,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 322
+              "lineNumber": 367
             },
             "type": "(\n    fieldId: string,\n    changes: FieldAppearanceChange[],\n  ) => Promise<void>"
           }
@@ -3305,7 +3326,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 427
+              "lineNumber": 472
             },
             "type": "(message: string) => Promise<void>"
           },
@@ -3316,7 +3337,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 442
+              "lineNumber": 487
             },
             "type": "(message: string) => Promise<void>"
           },
@@ -3327,7 +3348,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 466
+              "lineNumber": 511
             },
             "type": "<CtaValue = unknown>(\n    toast: Toast<CtaValue>,\n  ) => Promise<CtaValue | null>"
           }
@@ -3346,7 +3367,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 352
+              "lineNumber": 397
             },
             "type": "(itemTypeId: string) => Promise<Item | null>"
           },
@@ -3357,7 +3378,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 373
+              "lineNumber": 418
             },
             "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  }"
           },
@@ -3368,7 +3389,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 405
+              "lineNumber": 450
             },
             "type": "(itemId: string) => Promise<Item | null>"
           }
@@ -3387,7 +3408,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 493
+              "lineNumber": 538
             },
             "type": "{\n    (options: { multiple: true }): Promise<Upload[] | null>;\n    (options?: { multiple: false }): Promise<Upload | null>;\n  }"
           },
@@ -3398,7 +3419,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 521
+              "lineNumber": 566
             },
             "type": "(\n    uploadId: string,\n  ) => Promise<(Upload & { deleted?: true }) | null>"
           },
@@ -3409,7 +3430,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 549
+              "lineNumber": 594
             },
             "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>"
           }
@@ -3428,7 +3449,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 580
+              "lineNumber": 625
             },
             "type": "(modal: Modal) => Promise<unknown>"
           },
@@ -3439,7 +3460,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 617
+              "lineNumber": 662
             },
             "type": "(options: ConfirmOptions) => Promise<unknown>"
           }
@@ -3458,7 +3479,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 631
+              "lineNumber": 676
             },
             "type": "(path: string) => Promise<void>"
           }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "datocms-plugin-sdk",
-  "version": "2.1.5",
+  "version": "2.2.0-alpha.1",
   "description": "DatoCMS Plugin SDK",
   "keywords": [
     "datocms",
@@ -46,5 +46,5 @@
     "glob": "^11.0.0",
     "typescript": "^5.6.2"
   },
-  "gitHead": "1fc2f5b9c06a8bac49bd0e2cf731e599415ce010"
+  "gitHead": "998ccd009a2babbc49d883ea4b0ef6539937271c"
 }

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

@@ -102,8 +102,33 @@ 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. A map of CSS custom property names (e.g.
+   * `--color--raised--surface`) to their resolved values for the current
+   * color scheme.
+   */
+  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';
 };
 
 /**
@@ -144,7 +169,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;
@@ -153,6 +183,21 @@ export type Theme = {
   darkColor: string;
 };
 
+/**
+ * Semantic color tokens for the current DatoCMS project, pre-computed by the
+ * host. Only available on DatoCMS hosts that support the new token system.
+ *
+ * Each key is a ready-to-use CSS custom property name (including the leading
+ * `--`), and each value is the resolved color for the host's current color
+ * scheme — e.g. `{ '--color--raised--surface': 'oklch(…)' }`. The SDK applies
+ * these verbatim onto the plugin canvas, so plugin CSS can reference them
+ * directly with `var(--color--raised--surface)`.
+ *
+ * The token set is whatever the host sends; it is intentionally untyped so it
+ * can evolve on the host without an SDK release.
+ */
+export type SemanticColorTokensTheme = Record<string, string>;
+
 export type BaseMethods = LoadDataMethods &
   UpdatePluginParametersMethods &
   ToastMethods &

package/src/manifest.ts

@@ -3362,13 +3362,37 @@ export const manifest: Manifest = {
             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: 106,
+              lineNumber: 111,
             },
             type: 'Theme',
           },
+          semanticColorTokensTheme: {
+            comment: {
+              markdownText:
+                'Semantic color tokens for the current DatoCMS project, pre-computed by\nthe host. A map of CSS custom property names (e.g.\n`--color--raised--surface`) to their resolved values for the current\ncolor scheme.',
+            },
+            location: {
+              filePath: 'src/ctx/base.ts',
+              lineNumber: 119,
+            },
+            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: 131,
+            },
+            type: "'light' | 'dark'",
+          },
         },
       },
       {
@@ -3385,7 +3409,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 116,
+              lineNumber: 141,
             },
             type: 'Partial<Record<string, ItemType>>',
           },
@@ -3396,7 +3420,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 123,
+              lineNumber: 148,
             },
             type: 'Partial<Record<string, Field>>',
           },
@@ -3407,7 +3431,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 130,
+              lineNumber: 155,
             },
             type: 'Partial<Record<string, Fieldset>>',
           },
@@ -3418,7 +3442,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 137,
+              lineNumber: 162,
             },
             type: 'Partial<Record<string, User>>',
           },
@@ -3429,7 +3453,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 144,
+              lineNumber: 169,
             },
             type: 'Partial<Record<string, SsoUser>>',
           },
@@ -3453,7 +3477,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 187,
+              lineNumber: 232,
             },
             type: '(itemTypeId: string) => Promise<Field[]>',
           },
@@ -3466,7 +3490,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 206,
+              lineNumber: 251,
             },
             type: '(itemTypeId: string) => Promise<Fieldset[]>',
           },
@@ -3479,7 +3503,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 223,
+              lineNumber: 268,
             },
             type: '() => Promise<Field[]>',
           },
@@ -3492,7 +3516,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 236,
+              lineNumber: 281,
             },
             type: '() => Promise<User[]>',
           },
@@ -3505,7 +3529,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 249,
+              lineNumber: 294,
             },
             type: '() => Promise<SsoUser[]>',
           },
@@ -3527,7 +3551,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 271,
+              lineNumber: 316,
             },
             type: '(params: Record<string, unknown>) => Promise<void>',
           },
@@ -3540,7 +3564,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 322,
+              lineNumber: 367,
             },
             type: '(\n    fieldId: string,\n    changes: FieldAppearanceChange[],\n  ) => Promise<void>',
           },
@@ -3562,7 +3586,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 427,
+              lineNumber: 472,
             },
             type: '(message: string) => Promise<void>',
           },
@@ -3575,7 +3599,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 442,
+              lineNumber: 487,
             },
             type: '(message: string) => Promise<void>',
           },
@@ -3588,7 +3612,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 466,
+              lineNumber: 511,
             },
             type: '<CtaValue = unknown>(\n    toast: Toast<CtaValue>,\n  ) => Promise<CtaValue | null>',
           },
@@ -3610,7 +3634,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 352,
+              lineNumber: 397,
             },
             type: '(itemTypeId: string) => Promise<Item | null>',
           },
@@ -3623,7 +3647,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 373,
+              lineNumber: 418,
             },
             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  }',
           },
@@ -3636,7 +3660,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 405,
+              lineNumber: 450,
             },
             type: '(itemId: string) => Promise<Item | null>',
           },
@@ -3658,7 +3682,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 493,
+              lineNumber: 538,
             },
             type: '{\n    (options: { multiple: true }): Promise<Upload[] | null>;\n    (options?: { multiple: false }): Promise<Upload | null>;\n  }',
           },
@@ -3671,7 +3695,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 521,
+              lineNumber: 566,
             },
             type: '(\n    uploadId: string,\n  ) => Promise<(Upload & { deleted?: true }) | null>',
           },
@@ -3684,7 +3708,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 549,
+              lineNumber: 594,
             },
             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>',
           },
@@ -3706,7 +3730,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 580,
+              lineNumber: 625,
             },
             type: '(modal: Modal) => Promise<unknown>',
           },
@@ -3719,7 +3743,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 617,
+              lineNumber: 662,
             },
             type: '(options: ConfirmOptions) => Promise<unknown>',
           },
@@ -3740,7 +3764,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 631,
+              lineNumber: 676,
             },
             type: '(path: string) => Promise<void>',
           },