@adobe/helix-config 3.10.1 → 3.11.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [3.11.0](https://github.com/adobe/helix-config/compare/v3.10.1...v3.11.0) (2024-07-29)
+
+
+### Features
+
+* update sidekick plugin schema ([bac329a](https://github.com/adobe/helix-config/commit/bac329a15045ff49e4d58b1e7dc0289a97e6a67b))
+
 ## [3.10.1](https://github.com/adobe/helix-config/compare/v3.10.0...v3.10.1) (2024-07-27)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-config",
-  "version": "3.10.1",
+  "version": "3.11.0",
   "description": "Helix Config",
   "main": "src/index.js",
   "types": "src/index.d.ts",

package/src/schemas/sidekick.schema.json

@@ -17,19 +17,93 @@
       "type": "object",
       "properties": {
         "id": {
-          "type": "string"
+          "type": "string",
+          "description": "The unique plugin ID"
         },
         "title": {
-          "type": "string"
+          "type": "string",
+          "description": "The button text"
         },
         "url": {
-          "type": "string"
+          "type": "string",
+          "description": "The URL to open when the button is clicked"
+        },
+        "containerId": {
+          "type": "string",
+          "description": "The ID of the container to add this plugin to"
+        },
+        "environments": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": ["any", "dev", "admin", "edit", "preview", "live", "prod"]
+          },
+          "description": "The environments to display this plugin in",
+          "default": "any"
+        },
+        "event": {
+          "type": "string",
+          "description": "The name of a custom event to fire when the button is clicked (defaults to id)"
+        },
+        "excludePaths": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Exclude the plugin from these paths",
+          "examples": [
+            "/foo/**",
+            "**/:x:**"
+          ]
+        },
+        "includePaths": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Include the plugin on these paths (overrides excludePaths)",
+          "examples": [
+            "/foo/bar/**",
+            "**.docx**"
+          ]
+        },
+        "isContainer": {
+          "type": "boolean",
+          "description": "Turns the plugin into a container for other plugins"
+        },
+        "isPalette": {
+          "type": "boolean",
+          "description": "Opens the URL in a palette instead of a new tab",
+          "dependentRequired": ["url"]
+        },
+        "paletteRect": {
+          "type": "string",
+          "description": "he dimensions and position of a palette box",
+          "dependentRequired": ["isPalette"]
+        },
+        "titleI18n": {
+          "type": "object",
+          "description": "The button text in other supported languages",
+          "patternProperties": {
+            "^[a-z]{2}(-[A-Z]{2})?$": {
+              "type": "string",
+              "description": "ISO language code (`en` or `en-US`) with translated button text"
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        },
+        "passConfig": {
+          "type": "boolean",
+          "description": "Append ref, repo, owner, host, and project as query params on new URL button click"
+        },
+        "passReferrer": {
+          "type": "boolean",
+          "description": "Append the referrer URL as a query param on new URL button click"
         }
       },
       "required": [
-        "id",
-        "title",
-        "url"
+        "id"
       ]
     }
   },

package/types/profile-config.d.ts

@@ -288,9 +288,70 @@ export interface SidekickConfig {
   [k: string]: unknown;
 }
 export interface SidekickPlugin {
+  /**
+   * The unique plugin ID
+   */
   id: string;
-  title: string;
-  url: string;
+  /**
+   * The button text
+   */
+  title?: string;
+  /**
+   * The URL to open when the button is clicked
+   */
+  url?: string;
+  /**
+   * The ID of the container to add this plugin to
+   */
+  containerId?: string;
+  /**
+   * The environments to display this plugin in
+   */
+  environments?: string & ('any' | 'dev' | 'admin' | 'edit' | 'preview' | 'live' | 'prod')[];
+  /**
+   * The name of a custom event to fire when the button is clicked (defaults to id)
+   */
+  event?: string;
+  /**
+   * Exclude the plugin from these paths
+   */
+  excludePaths?: string[];
+  /**
+   * Include the plugin on these paths (overrides excludePaths)
+   */
+  includePaths?: string[];
+  /**
+   * Turns the plugin into a container for other plugins
+   */
+  isContainer?: boolean;
+  /**
+   * Opens the URL in a palette instead of a new tab
+   */
+  isPalette?: boolean;
+  /**
+   * he dimensions and position of a palette box
+   */
+  paletteRect?: string;
+  /**
+   * The button text in other supported languages
+   */
+  titleI18n?: {
+    /**
+     * ISO language code (`en` or `en-US`) with translated button text
+     *
+     * This interface was referenced by `undefined`'s JSON-Schema definition
+     * via the `patternProperty` "^[a-z]{2}(-[A-Z]{2})?$".
+     */
+    [k: string]: string;
+  };
+  /**
+   * Append ref, repo, owner, host, and project as query params on new URL button click
+   */
+  passConfig?: boolean;
+  /**
+   * Append the referrer URL as a query param on new URL button click
+   */
+  passReferrer?: boolean;
   [k: string]: unknown;
 }
 export interface Metadata {

package/types/site-config.d.ts

@@ -295,9 +295,70 @@ export interface SidekickConfig {
   [k: string]: unknown;
 }
 export interface SidekickPlugin {
+  /**
+   * The unique plugin ID
+   */
   id: string;
-  title: string;
-  url: string;
+  /**
+   * The button text
+   */
+  title?: string;
+  /**
+   * The URL to open when the button is clicked
+   */
+  url?: string;
+  /**
+   * The ID of the container to add this plugin to
+   */
+  containerId?: string;
+  /**
+   * The environments to display this plugin in
+   */
+  environments?: string & ('any' | 'dev' | 'admin' | 'edit' | 'preview' | 'live' | 'prod')[];
+  /**
+   * The name of a custom event to fire when the button is clicked (defaults to id)
+   */
+  event?: string;
+  /**
+   * Exclude the plugin from these paths
+   */
+  excludePaths?: string[];
+  /**
+   * Include the plugin on these paths (overrides excludePaths)
+   */
+  includePaths?: string[];
+  /**
+   * Turns the plugin into a container for other plugins
+   */
+  isContainer?: boolean;
+  /**
+   * Opens the URL in a palette instead of a new tab
+   */
+  isPalette?: boolean;
+  /**
+   * he dimensions and position of a palette box
+   */
+  paletteRect?: string;
+  /**
+   * The button text in other supported languages
+   */
+  titleI18n?: {
+    /**
+     * ISO language code (`en` or `en-US`) with translated button text
+     *
+     * This interface was referenced by `undefined`'s JSON-Schema definition
+     * via the `patternProperty` "^[a-z]{2}(-[A-Z]{2})?$".
+     */
+    [k: string]: string;
+  };
+  /**
+   * Append ref, repo, owner, host, and project as query params on new URL button click
+   */
+  passConfig?: boolean;
+  /**
+   * Append the referrer URL as a query param on new URL button click
+   */
+  passReferrer?: boolean;
   [k: string]: unknown;
 }
 export interface Metadata {