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

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 `cssDesignTokens` instead. This property is kept\nfor backward compatibility with third-party plugins.',
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 106,
+              lineNumber: 111,
             },
             type: 'Theme',
           },
+          cssDesignTokens: {
+            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: 'cssDesignTokens',
+          },
+          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` two ways:\nthe `data-color-scheme="light"` / `data-color-scheme="dark"` attribute,\nso plugin CSS can branch with `[data-color-scheme="dark"] { … }`\nselectors; and the actual `color-scheme` CSS property, so `light-dark()`\nresolves to the correct branch (and native form controls / scrollbars\nmatch) everywhere in the plugin frame. For non-CSS decisions (choosing a\nlogo asset, a syntax-highlighting preset, …) branch on `ctx.colorScheme`\ndirectly.',
+            },
+            location: {
+              filePath: 'src/ctx/base.ts',
+              lineNumber: 134,
+            },
+            type: "'light' | 'dark'",
+          },
         },
       },
       {
@@ -3385,7 +3409,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 116,
+              lineNumber: 144,
             },
             type: 'Partial<Record<string, ItemType>>',
           },
@@ -3396,7 +3420,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 123,
+              lineNumber: 151,
             },
             type: 'Partial<Record<string, Field>>',
           },
@@ -3407,7 +3431,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 130,
+              lineNumber: 158,
             },
             type: 'Partial<Record<string, Fieldset>>',
           },
@@ -3418,7 +3442,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 137,
+              lineNumber: 165,
             },
             type: 'Partial<Record<string, User>>',
           },
@@ -3429,7 +3453,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 144,
+              lineNumber: 172,
             },
             type: 'Partial<Record<string, SsoUser>>',
           },
@@ -3453,7 +3477,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 187,
+              lineNumber: 235,
             },
             type: '(itemTypeId: string) => Promise<Field[]>',
           },
@@ -3466,7 +3490,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 206,
+              lineNumber: 254,
             },
             type: '(itemTypeId: string) => Promise<Fieldset[]>',
           },
@@ -3479,7 +3503,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 223,
+              lineNumber: 271,
             },
             type: '() => Promise<Field[]>',
           },
@@ -3492,7 +3516,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 236,
+              lineNumber: 284,
             },
             type: '() => Promise<User[]>',
           },
@@ -3505,7 +3529,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 249,
+              lineNumber: 297,
             },
             type: '() => Promise<SsoUser[]>',
           },
@@ -3527,7 +3551,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 271,
+              lineNumber: 319,
             },
             type: '(params: Record<string, unknown>) => Promise<void>',
           },
@@ -3540,7 +3564,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 322,
+              lineNumber: 370,
             },
             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: 475,
             },
             type: '(message: string) => Promise<void>',
           },
@@ -3575,7 +3599,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 442,
+              lineNumber: 490,
             },
             type: '(message: string) => Promise<void>',
           },
@@ -3588,7 +3612,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 466,
+              lineNumber: 514,
             },
             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: 400,
             },
             type: '(itemTypeId: string) => Promise<Item | null>',
           },
@@ -3623,7 +3647,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 373,
+              lineNumber: 421,
             },
             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: 453,
             },
             type: '(itemId: string) => Promise<Item | null>',
           },
@@ -3658,7 +3682,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 493,
+              lineNumber: 541,
             },
             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: 569,
             },
             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: 597,
             },
             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: 628,
             },
             type: '(modal: Modal) => Promise<unknown>',
           },
@@ -3719,7 +3743,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 617,
+              lineNumber: 665,
             },
             type: '(options: ConfirmOptions) => Promise<unknown>',
           },
@@ -3740,7 +3764,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 631,
+              lineNumber: 679,
             },
             type: '(path: string) => Promise<void>',
           },