datocms-plugin-sdk 2.0.12 → 2.0.13

package/manifest.json

@@ -259,6 +259,16 @@
                   "lineNumber": 19
                 },
                 "type": "string"
+              },
+              "location": {
+                "comment": {
+                  "markdownText": "Current page location."
+                },
+                "location": {
+                  "filePath": "src/hooks/renderPage.ts",
+                  "lineNumber": 22
+                },
+                "type": "{\n      pathname: string;\n      search: string;\n      hash: string;\n    }"
               }
             }
           }
@@ -2922,13 +2932,23 @@
             },
             "type": "string"
           },
+          "isEnvironmentPrimary": {
+            "comment": {
+              "markdownText": "Whether the current environment is the primary one."
+            },
+            "location": {
+              "filePath": "src/ctx/base.ts",
+              "lineNumber": 64
+            },
+            "type": "boolean"
+          },
           "owner": {
             "comment": {
               "markdownText": "The account/organization that is the project owner."
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 64
+              "lineNumber": 67
             },
             "type": "Account | Organization"
           },
@@ -2939,7 +2959,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 72
+              "lineNumber": 75
             },
             "type": "Account | undefined"
           },
@@ -2949,7 +2969,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 78
+              "lineNumber": 81
             },
             "type": "{\n    /** Preferred locale */\n    locale: string;\n  }"
           },
@@ -2959,7 +2979,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 84
+              "lineNumber": 87
             },
             "type": "Theme"
           }
@@ -2977,7 +2997,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 94
+              "lineNumber": 97
             },
             "type": "Partial<Record<string, ItemType>>"
           },
@@ -2987,7 +3007,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 101
+              "lineNumber": 104
             },
             "type": "Partial<Record<string, Field>>"
           },
@@ -2997,7 +3017,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 108
+              "lineNumber": 111
             },
             "type": "Partial<Record<string, Fieldset>>"
           },
@@ -3007,7 +3027,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 115
+              "lineNumber": 118
             },
             "type": "Partial<Record<string, User>>"
           },
@@ -3017,7 +3037,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 122
+              "lineNumber": 125
             },
             "type": "Partial<Record<string, SsoUser>>"
           }
@@ -3038,7 +3058,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 165
+              "lineNumber": 168
             },
             "type": "(itemTypeId: string) => Promise<Field[]>"
           },
@@ -3049,7 +3069,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 184
+              "lineNumber": 187
             },
             "type": "(itemTypeId: string) => Promise<Fieldset[]>"
           },
@@ -3060,7 +3080,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 201
+              "lineNumber": 204
             },
             "type": "() => Promise<Field[]>"
           },
@@ -3071,7 +3091,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 214
+              "lineNumber": 217
             },
             "type": "() => Promise<User[]>"
           },
@@ -3082,7 +3102,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 227
+              "lineNumber": 230
             },
             "type": "() => Promise<SsoUser[]>"
           }
@@ -3101,7 +3121,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 249
+              "lineNumber": 252
             },
             "type": "(params: Record<string, unknown>) => Promise<void>"
           },
@@ -3112,7 +3132,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 300
+              "lineNumber": 303
             },
             "type": "(\n    fieldId: string,\n    changes: FieldAppearanceChange[],\n  ) => Promise<void>"
           }
@@ -3131,7 +3151,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 405
+              "lineNumber": 408
             },
             "type": "(message: string) => Promise<void>"
           },
@@ -3142,7 +3162,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 420
+              "lineNumber": 423
             },
             "type": "(message: string) => Promise<void>"
           },
@@ -3153,7 +3173,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 444
+              "lineNumber": 447
             },
             "type": "<CtaValue = unknown>(\n    toast: Toast<CtaValue>,\n  ) => Promise<CtaValue | null>"
           }
@@ -3172,7 +3192,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 330
+              "lineNumber": 333
             },
             "type": "(itemTypeId: string) => Promise<Item | null>"
           },
@@ -3183,7 +3203,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 351
+              "lineNumber": 354
             },
             "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  }"
           },
@@ -3194,7 +3214,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 383
+              "lineNumber": 386
             },
             "type": "(itemId: string) => Promise<Item | null>"
           }
@@ -3213,7 +3233,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 471
+              "lineNumber": 474
             },
             "type": "{\n    (options: { multiple: true }): Promise<Upload[] | null>;\n    (options?: { multiple: false }): Promise<Upload | null>;\n  }"
           },
@@ -3224,7 +3244,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 499
+              "lineNumber": 502
             },
             "type": "(\n    uploadId: string,\n  ) => Promise<(Upload & { deleted?: true }) | null>"
           },
@@ -3235,7 +3255,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 527
+              "lineNumber": 530
             },
             "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>"
           }
@@ -3254,7 +3274,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 558
+              "lineNumber": 561
             },
             "type": "(modal: Modal) => Promise<unknown>"
           },
@@ -3265,7 +3285,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 595
+              "lineNumber": 598
             },
             "type": "(options: ConfirmOptions) => Promise<unknown>"
           }
@@ -3284,7 +3304,7 @@
             },
             "location": {
               "filePath": "src/ctx/base.ts",
-              "lineNumber": 609
+              "lineNumber": 612
             },
             "type": "(path: string) => Promise<void>"
           }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "datocms-plugin-sdk",
-  "version": "2.0.12",
+  "version": "2.0.13",
   "description": "DatoCMS Plugin SDK",
   "keywords": [
     "datocms",
@@ -45,5 +45,5 @@
     "glob": "^11.0.0",
     "typescript": "^5.6.2"
   },
-  "gitHead": "e41647363072a1d6edec852553045af9ec797a1f"
+  "gitHead": "1420d4ce991da7c84da85b1b4e1375df19e156d7"
 }

package/src/ctx/base.ts

@@ -60,6 +60,9 @@ type ProjectProperties = {
   /** The ID of the current environment */
   environment: string;
 
+  /** Whether the current environment is the primary one */
+  isEnvironmentPrimary: boolean;
+
   /** The account/organization that is the project owner */
   owner: Account | Organization;
 

package/src/hooks/renderPage.ts

@@ -17,6 +17,13 @@ export type RenderPageCtx = ImposedSizePluginFrameCtx<
   {
     /** The ID of the page that needs to be rendered */
     pageId: string;
+
+    /** Current page location */
+    location: {
+      pathname: string;
+      search: string;
+      hash: string;
+    };
   }
 >;
 

package/src/manifest.ts

@@ -275,6 +275,16 @@ export const manifest: Manifest = {
                 },
                 type: 'string',
               },
+              location: {
+                comment: {
+                  markdownText: 'Current page location.',
+                },
+                location: {
+                  filePath: 'src/hooks/renderPage.ts',
+                  lineNumber: 22,
+                },
+                type: '{\n      pathname: string;\n      search: string;\n      hash: string;\n    }',
+              },
             },
           },
         ],
@@ -3136,6 +3146,17 @@ export const manifest: Manifest = {
             },
             type: 'string',
           },
+          isEnvironmentPrimary: {
+            comment: {
+              markdownText:
+                'Whether the current environment is the primary one.',
+            },
+            location: {
+              filePath: 'src/ctx/base.ts',
+              lineNumber: 64,
+            },
+            type: 'boolean',
+          },
           owner: {
             comment: {
               markdownText:
@@ -3143,7 +3164,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 64,
+              lineNumber: 67,
             },
             type: 'Account | Organization',
           },
@@ -3155,7 +3176,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 72,
+              lineNumber: 75,
             },
             type: 'Account | undefined',
           },
@@ -3166,7 +3187,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 78,
+              lineNumber: 81,
             },
             type: '{\n    /** Preferred locale */\n    locale: string;\n  }',
           },
@@ -3177,7 +3198,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 84,
+              lineNumber: 87,
             },
             type: 'Theme',
           },
@@ -3197,7 +3218,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 94,
+              lineNumber: 97,
             },
             type: 'Partial<Record<string, ItemType>>',
           },
@@ -3208,7 +3229,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 101,
+              lineNumber: 104,
             },
             type: 'Partial<Record<string, Field>>',
           },
@@ -3219,7 +3240,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 108,
+              lineNumber: 111,
             },
             type: 'Partial<Record<string, Fieldset>>',
           },
@@ -3230,7 +3251,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 115,
+              lineNumber: 118,
             },
             type: 'Partial<Record<string, User>>',
           },
@@ -3241,7 +3262,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 122,
+              lineNumber: 125,
             },
             type: 'Partial<Record<string, SsoUser>>',
           },
@@ -3265,7 +3286,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 165,
+              lineNumber: 168,
             },
             type: '(itemTypeId: string) => Promise<Field[]>',
           },
@@ -3278,7 +3299,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 184,
+              lineNumber: 187,
             },
             type: '(itemTypeId: string) => Promise<Fieldset[]>',
           },
@@ -3291,7 +3312,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 201,
+              lineNumber: 204,
             },
             type: '() => Promise<Field[]>',
           },
@@ -3304,7 +3325,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 214,
+              lineNumber: 217,
             },
             type: '() => Promise<User[]>',
           },
@@ -3317,7 +3338,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 227,
+              lineNumber: 230,
             },
             type: '() => Promise<SsoUser[]>',
           },
@@ -3339,7 +3360,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 249,
+              lineNumber: 252,
             },
             type: '(params: Record<string, unknown>) => Promise<void>',
           },
@@ -3352,7 +3373,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 300,
+              lineNumber: 303,
             },
             type: '(\n    fieldId: string,\n    changes: FieldAppearanceChange[],\n  ) => Promise<void>',
           },
@@ -3374,7 +3395,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 405,
+              lineNumber: 408,
             },
             type: '(message: string) => Promise<void>',
           },
@@ -3387,7 +3408,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 420,
+              lineNumber: 423,
             },
             type: '(message: string) => Promise<void>',
           },
@@ -3400,7 +3421,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 444,
+              lineNumber: 447,
             },
             type: '<CtaValue = unknown>(\n    toast: Toast<CtaValue>,\n  ) => Promise<CtaValue | null>',
           },
@@ -3422,7 +3443,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 330,
+              lineNumber: 333,
             },
             type: '(itemTypeId: string) => Promise<Item | null>',
           },
@@ -3435,7 +3456,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 351,
+              lineNumber: 354,
             },
             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  }',
           },
@@ -3448,7 +3469,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 383,
+              lineNumber: 386,
             },
             type: '(itemId: string) => Promise<Item | null>',
           },
@@ -3470,7 +3491,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 471,
+              lineNumber: 474,
             },
             type: '{\n    (options: { multiple: true }): Promise<Upload[] | null>;\n    (options?: { multiple: false }): Promise<Upload | null>;\n  }',
           },
@@ -3483,7 +3504,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 499,
+              lineNumber: 502,
             },
             type: '(\n    uploadId: string,\n  ) => Promise<(Upload & { deleted?: true }) | null>',
           },
@@ -3496,7 +3517,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 527,
+              lineNumber: 530,
             },
             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>',
           },
@@ -3518,7 +3539,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 558,
+              lineNumber: 561,
             },
             type: '(modal: Modal) => Promise<unknown>',
           },
@@ -3531,7 +3552,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 595,
+              lineNumber: 598,
             },
             type: '(options: ConfirmOptions) => Promise<unknown>',
           },
@@ -3552,7 +3573,7 @@ export const manifest: Manifest = {
             },
             location: {
               filePath: 'src/ctx/base.ts',
-              lineNumber: 609,
+              lineNumber: 612,
             },
             type: '(path: string) => Promise<void>',
           },