@adobe/helix-config-storage 2.0.5 → 2.1.0

package/CHANGELOG.md

@@ -1,3 +1,23 @@
+# [2.1.0](https://github.com/adobe/helix-config-storage/compare/v2.0.6...v2.1.0) (2025-03-13)
+
+
+### Bug Fixes
+
+* address comments ([e30b646](https://github.com/adobe/helix-config-storage/commit/e30b6465ce23fe85726ee173cd3d94bdcf71e98e))
+* remove escaped ([efc3ef4](https://github.com/adobe/helix-config-storage/commit/efc3ef4819fd89192f3b0b082135b11cbcc6e506))
+
+
+### Features
+
+* support cdn.review.host for custom review origin ([b8ba6c5](https://github.com/adobe/helix-config-storage/commit/b8ba6c549238ba0328e2cb74aa24ee5b9f8b26be))
+
+## [2.0.6](https://github.com/adobe/helix-config-storage/compare/v2.0.5...v2.0.6) (2025-03-05)
+
+
+### Bug Fixes
+
+* relax folders schema ([#102](https://github.com/adobe/helix-config-storage/issues/102)) ([e1468a3](https://github.com/adobe/helix-config-storage/commit/e1468a320ec025e909a1804fb49b15310ed6c76f))
+
 ## [2.0.5](https://github.com/adobe/helix-config-storage/compare/v2.0.4...v2.0.5) (2025-03-04)
 
 

package/package.json

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

package/src/schemas/cdn.schema.json

@@ -42,7 +42,7 @@
       "type": "object",
       "properties": {
         "host": {
-          "description": "Sidekick config to override the default preview host. it supports parameters $owner and $repo",
+          "description": "Sidekick config to override the default previewHost. it supports parameters $owner and $repo",
           "examples": [
             "main--$repo--page.example.com"
           ],
@@ -58,9 +58,25 @@
       "type": "object",
       "properties": {
         "host": {
-          "description": "Sidekick config to override the default live host. it supports parameters $owner and $repo",
+          "description": "Sidekick config to override the default liveHost. it supports parameters $owner and $repo",
           "examples": [
-            "main--$repo--live.example.com\""
+            "main--$repo--live.example.com"
+          ],
+          "type": "string"
+        }
+      },
+      "required": [
+        "host"
+      ],
+      "additionalProperties": false
+    },
+    "review": {
+      "type": "object",
+      "properties": {
+        "host": {
+          "description": "Sidekick config to override the default reviewHost. it supports parameters $owner and $repo",
+          "examples": [
+            "example.reviews"
           ],
           "type": "string"
         }

package/src/schemas/folders.schema.json

@@ -5,7 +5,7 @@
   "type": "object",
   "title": "folders",
   "patternProperties": {
-    "^/[a-zA-Z0-9-/.]*$": {
+    "^/[a-zA-Z0-9-_/.]*$": {
       "type": "string"
     }
   },

package/types/org-config.d.ts

@@ -34,6 +34,7 @@ export interface HelixOrgConfig {
   description?: string;
   users?: Users;
   groups?: Groups;
+  secrets?: Secrets;
   tokens?: Tokens;
   access?: OrgAccessConfig;
 }
@@ -59,6 +60,36 @@ export interface Group {
     [k: string]: unknown;
   }[];
 }
+/**
+ * Defines organization level secrets.
+ */
+export interface Secrets {
+  /**
+   * This interface was referenced by `Secrets`'s JSON-Schema definition
+   * via the `patternProperty` "^[a-zA-Z0-9-_=]+$".
+   */
+  [k: string]:
+    | {
+        hash: string;
+        id: string;
+        type: 'hashed' | 'key';
+        created: string;
+        lastModified: string;
+        description?: string;
+      }
+    | {
+        value: string;
+        id: string;
+        type: 'hashed' | 'key';
+        created: string;
+        lastModified: string;
+        description?: string;
+      };
+}
+/**
+ * @deprecated
+ * site tokens. deprecated: use the org secrets instead.
+ */
 export interface Tokens {
   /**
    * This interface was referenced by `Tokens`'s JSON-Schema definition
@@ -73,7 +104,7 @@ export interface Tokens {
 export interface OrgAccessConfig {
   admin?: {
     /**
-     * the id of the API key(s). this is used to validate the API KEYS and allows to invalidate them.
+     * the id of the API key(s) that are allowed to access this org (admin).
      */
     apiKeyId?: string[];
   };

package/types/profile-config.d.ts

@@ -37,12 +37,15 @@ export interface HelixProfileConfig {
   cdn?: CDNConfig;
   access?: Access;
   tokens?: Tokens;
+  secrets?: Secrets;
   groups?: Groups;
   sidekick?: SidekickConfig;
   metadata?: Metadata;
   robots?: Robots;
   public?: Public;
   events?: EventsConfig;
+  features?: Features;
+  limits?: Features1;
 }
 /**
  * Defines the content bus location and source.
@@ -112,7 +115,7 @@ export interface CodeSource {
 export interface Folders {
   /**
    * This interface was referenced by `Folders`'s JSON-Schema definition
-   * via the `patternProperty` "^/[a-zA-Z0-9-/.]*$".
+   * via the `patternProperty` "^/[a-zA-Z0-9-_/.]*$".
    */
   [k: string]: string;
 }
@@ -269,10 +272,19 @@ export interface SiteAccessConfig {
    */
   allow?: string[];
   /**
-   * IDs of the api keys (tokens) that are allowed.
+   * IDs of the hashed secrets that are allowed.
+   */
+  secretId?: string[];
+  /**
+   * @deprecated
+   * IDs of the api keys that are allowed. This is deprecated. use `secretId` instead.
    */
   apiKeyId?: string[];
 }
+/**
+ * @deprecated
+ * site tokens. deprecated: use the org secrets instead.
+ */
 export interface Tokens {
   /**
    * This interface was referenced by `Tokens`'s JSON-Schema definition
@@ -284,6 +296,32 @@ export interface Tokens {
     created?: string;
   };
 }
+/**
+ * Defines organization level secrets.
+ */
+export interface Secrets {
+  /**
+   * This interface was referenced by `Secrets`'s JSON-Schema definition
+   * via the `patternProperty` "^[a-zA-Z0-9-_=]+$".
+   */
+  [k: string]:
+    | {
+        hash: string;
+        id: string;
+        type: 'hashed' | 'key';
+        created: string;
+        lastModified: string;
+        description?: string;
+      }
+    | {
+        value: string;
+        id: string;
+        type: 'hashed' | 'key';
+        created: string;
+        lastModified: string;
+        description?: string;
+      };
+}
 export interface Groups {
   [k: string]: Group;
 }
@@ -324,7 +362,7 @@ export interface SidekickPlugin {
   /**
    * The environments to display this plugin in
    */
-  environments?: string & ('any' | 'dev' | 'admin' | 'edit' | 'preview' | 'live' | 'prod')[];
+  environments?: string & ('any' | 'dev' | 'admin' | 'edit' | 'preview' | 'live' | 'prod' | 'review')[];
   /**
    * The name of a custom event to fire when the button is clicked (defaults to id)
    */
@@ -349,6 +387,14 @@ export interface SidekickPlugin {
    * he dimensions and position of a palette box
    */
   paletteRect?: string;
+  /**
+   * Opens the URL in a popover instead of a new tab
+   */
+  isPopover?: boolean;
+  /**
+   * The dimensions of a popover, delimited by a semicolon (width, height)
+   */
+  popoverRect?: string;
   /**
    * The button text in other supported languages
    */
@@ -369,6 +415,28 @@ export interface SidekickPlugin {
    * Append the referrer URL as a query param on new URL button click
    */
   passReferrer?: boolean;
+  /**
+   * Opens the URL in a palette instead of a new tab
+   */
+  isBadge?: boolean;
+  /**
+   * The variant of the badge following the Adobe Spectrum badge variants
+   */
+  badgeVariant?:
+    | 'gray'
+    | 'red'
+    | 'orange'
+    | 'yellow'
+    | 'chartreuse'
+    | 'celery'
+    | 'green'
+    | 'seafoam'
+    | 'cyan'
+    | 'blue'
+    | 'indigo'
+    | 'purple'
+    | 'fuchsia'
+    | 'magenta';
   [k: string]: unknown;
 }
 export interface Metadata {
@@ -388,3 +456,28 @@ export interface EventsConfig {
     target: string;
   };
 }
+/**
+ * Features configuration
+ */
+export interface Features {
+  /**
+   * This interface was referenced by `Features`'s JSON-Schema definition
+   * via the `patternProperty` "^[a-zA-Z0-9-_=]+$".
+   */
+  [k: string]: {
+    [k: string]: unknown;
+  };
+}
+/**
+ * Features configuration
+ */
+export interface Features1 {
+  /**
+   * This interface was referenced by `Features1`'s JSON-Schema definition
+   * via the `patternProperty` "^[a-zA-Z0-9-_=]+$".
+   */
+  [k: string]: {
+    description?: string;
+    [k: string]: unknown;
+  };
+}

package/types/site-config.d.ts

@@ -41,12 +41,15 @@ export interface HelixSiteConfig {
   cdn?: CDNConfig;
   access?: Access;
   tokens?: Tokens;
+  secrets?: Secrets;
   groups?: Groups;
   sidekick?: SidekickConfig;
   metadata?: Metadata;
   robots?: Robots;
   public?: Public;
   events?: EventsConfig;
+  features?: Features;
+  limits?: Features1;
   extends?: {
     profile?: string;
   };
@@ -119,7 +122,7 @@ export interface CodeSource {
 export interface Folders {
   /**
    * This interface was referenced by `Folders`'s JSON-Schema definition
-   * via the `patternProperty` "^/[a-zA-Z0-9-/.]*$".
+   * via the `patternProperty` "^/[a-zA-Z0-9-_/.]*$".
    */
   [k: string]: string;
 }
@@ -276,10 +279,19 @@ export interface SiteAccessConfig {
    */
   allow?: string[];
   /**
-   * IDs of the api keys (tokens) that are allowed.
+   * IDs of the hashed secrets that are allowed.
+   */
+  secretId?: string[];
+  /**
+   * @deprecated
+   * IDs of the api keys that are allowed. This is deprecated. use `secretId` instead.
    */
   apiKeyId?: string[];
 }
+/**
+ * @deprecated
+ * site tokens. deprecated: use the org secrets instead.
+ */
 export interface Tokens {
   /**
    * This interface was referenced by `Tokens`'s JSON-Schema definition
@@ -291,6 +303,32 @@ export interface Tokens {
     created?: string;
   };
 }
+/**
+ * Defines organization level secrets.
+ */
+export interface Secrets {
+  /**
+   * This interface was referenced by `Secrets`'s JSON-Schema definition
+   * via the `patternProperty` "^[a-zA-Z0-9-_=]+$".
+   */
+  [k: string]:
+    | {
+        hash: string;
+        id: string;
+        type: 'hashed' | 'key';
+        created: string;
+        lastModified: string;
+        description?: string;
+      }
+    | {
+        value: string;
+        id: string;
+        type: 'hashed' | 'key';
+        created: string;
+        lastModified: string;
+        description?: string;
+      };
+}
 export interface Groups {
   [k: string]: Group;
 }
@@ -331,7 +369,7 @@ export interface SidekickPlugin {
   /**
    * The environments to display this plugin in
    */
-  environments?: string & ('any' | 'dev' | 'admin' | 'edit' | 'preview' | 'live' | 'prod')[];
+  environments?: string & ('any' | 'dev' | 'admin' | 'edit' | 'preview' | 'live' | 'prod' | 'review')[];
   /**
    * The name of a custom event to fire when the button is clicked (defaults to id)
    */
@@ -356,6 +394,14 @@ export interface SidekickPlugin {
    * he dimensions and position of a palette box
    */
   paletteRect?: string;
+  /**
+   * Opens the URL in a popover instead of a new tab
+   */
+  isPopover?: boolean;
+  /**
+   * The dimensions of a popover, delimited by a semicolon (width, height)
+   */
+  popoverRect?: string;
   /**
    * The button text in other supported languages
    */
@@ -376,6 +422,28 @@ export interface SidekickPlugin {
    * Append the referrer URL as a query param on new URL button click
    */
   passReferrer?: boolean;
+  /**
+   * Opens the URL in a palette instead of a new tab
+   */
+  isBadge?: boolean;
+  /**
+   * The variant of the badge following the Adobe Spectrum badge variants
+   */
+  badgeVariant?:
+    | 'gray'
+    | 'red'
+    | 'orange'
+    | 'yellow'
+    | 'chartreuse'
+    | 'celery'
+    | 'green'
+    | 'seafoam'
+    | 'cyan'
+    | 'blue'
+    | 'indigo'
+    | 'purple'
+    | 'fuchsia'
+    | 'magenta';
   [k: string]: unknown;
 }
 export interface Metadata {
@@ -395,3 +463,28 @@ export interface EventsConfig {
     target: string;
   };
 }
+/**
+ * Features configuration
+ */
+export interface Features {
+  /**
+   * This interface was referenced by `Features`'s JSON-Schema definition
+   * via the `patternProperty` "^[a-zA-Z0-9-_=]+$".
+   */
+  [k: string]: {
+    [k: string]: unknown;
+  };
+}
+/**
+ * Features configuration
+ */
+export interface Features1 {
+  /**
+   * This interface was referenced by `Features1`'s JSON-Schema definition
+   * via the `patternProperty` "^[a-zA-Z0-9-_=]+$".
+   */
+  [k: string]: {
+    description?: string;
+    [k: string]: unknown;
+  };
+}