@adobe/helix-config-storage 2.2.11 → 2.2.13

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [2.2.13](https://github.com/adobe/helix-config-storage/compare/v2.2.12...v2.2.13) (2025-06-18)
+
+
+### Bug Fixes
+
+* ensure that purge receives empty old config ([#143](https://github.com/adobe/helix-config-storage/issues/143)) ([77bab30](https://github.com/adobe/helix-config-storage/commit/77bab30a36aa8a817f1d45307447ec62e1ee39ae))
+
+## [2.2.12](https://github.com/adobe/helix-config-storage/compare/v2.2.11...v2.2.12) (2025-06-18)
+
+
+### Bug Fixes
+
+* respect profile when validating for new site configs ([#142](https://github.com/adobe/helix-config-storage/issues/142)) ([ad9e784](https://github.com/adobe/helix-config-storage/commit/ad9e7847d305726ac6987b6138b523a2ce867011))
+
 ## [2.2.11](https://github.com/adobe/helix-config-storage/compare/v2.2.10...v2.2.11) (2025-06-13)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-config-storage",
-  "version": "2.2.11",
+  "version": "2.2.13",
   "description": "Helix Config Storage",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -36,8 +36,8 @@
     "reporter-options": "configFile=.mocha-multi.json"
   },
   "devDependencies": {
-    "@adobe/eslint-config-helix": "3.0.3",
-    "@eslint/config-helpers": "0.2.2",
+    "@adobe/eslint-config-helix": "3.0.4",
+    "@eslint/config-helpers": "0.2.3",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/git": "10.0.1",
     "@semantic-release/npm": "12.0.1",
@@ -47,7 +47,7 @@
     "husky": "9.1.7",
     "json-schema-to-typescript": "15.0.4",
     "junit-report-builder": "5.1.1",
-    "lint-staged": "16.1.0",
+    "lint-staged": "16.1.2",
     "mocha": "11.6.0",
     "mocha-multi-reporters": "1.5.1",
     "mocha-suppress-logs": "0.5.1",

package/src/config-store.js

@@ -520,9 +520,15 @@ export class ConfigStore {
     // we don't allow to define created
     delete data.created;
     this.#updateTimeStamps(data);
+    let oldConfig = {};
+    if (this.type === 'sites') {
+      // for a new site using a profile, we get the aggregate of the same profile.
+      // this allows to validate the protected properties like features and limits.
+      oldConfig = await this.getAggregatedConfig(ctx, { extends: data.extends });
+    }
     const config = await this.getAggregatedConfig(ctx, data);
     await this.validate(ctx, config);
-    await this.validatePermissions(ctx, {}, config);
+    await this.validatePermissions(ctx, oldConfig, config);
     await storage.put(this.key, JSON.stringify(data), 'application/json');
     await this.purge(ctx, null, config);
   }
@@ -726,16 +732,19 @@ export class ConfigStore {
     config.created = oldConfig?.created;
     this.#updateTimeStamps(config);
     let newConfig = config;
+    let purgeConfig = oldConfig;
     if (this.type === 'sites') {
-      // apply profile
-      oldConfig = await this.getAggregatedConfig(ctx, oldConfig);
+      // apply profile: for a new site using a profile, we get the aggregate of the same profile.
+      // this allows to validate the protected properties like features and limits.
+      oldConfig = await this.getAggregatedConfig(ctx, oldConfig ?? { extends: newConfig.extends });
+      purgeConfig = await this.getAggregatedConfig(ctx, purgeConfig);
       newConfig = await this.getAggregatedConfig(ctx, newConfig);
     }
 
     await this.validate(ctx, newConfig);
     await this.validatePermissions(ctx, oldConfig, newConfig);
     await storage.put(this.key, JSON.stringify(config), 'application/json');
-    await this.purge(ctx, oldConfig, newConfig);
+    await this.purge(ctx, purgeConfig, newConfig);
     return ret ?? redact(data, frag);
   }
 

package/types/org-config.d.ts

@@ -35,6 +35,7 @@ export interface HelixOrgConfig {
   users?: Users;
   groups?: Groups;
   secrets?: Secrets;
+  apiKeys?: ApiKeys;
   tokens?: Tokens;
   access?: OrgAccessConfig;
 }
@@ -86,6 +87,29 @@ export interface Secrets {
         description?: string;
       };
 }
+/**
+ * Stores information about generated admin API keys. The keys listed here have no operational meaning, but are used to track the keys that have been generated.
+ */
+export interface ApiKeys {
+  /**
+   * This interface was referenced by `ApiKeys`'s JSON-Schema definition
+   * via the `patternProperty` "^[a-zA-Z0-9-_]+$".
+   */
+  [k: string]: {
+    /**
+     * the API token id (jti)
+     */
+    id: string;
+    created: string;
+    expiration: string;
+    roles: string[];
+    /**
+     * the subject of the API token (sub)
+     */
+    subject: string;
+    description?: string;
+  };
+}
 /**
  * @deprecated
  * site tokens. deprecated: use the org secrets instead.

package/types/profile-config.d.ts

@@ -134,13 +134,19 @@ export interface CDNConfig {
   prod?: FastlyCDNConfig | CloudflareCDNConfig | AkamaiCDNConfig | ManagedCDNConfig | CloudfrontCDNConfig | EmptyConfig;
   live?: {
     /**
-     * Sidekick config to override the default preview host. it supports parameters $owner and $repo
+     * Sidekick config to override the default previewHost. it supports parameters $owner and $repo
      */
     host: string;
   };
   preview?: {
     /**
-     * Sidekick config to override the default live host. it supports parameters $owner and $repo
+     * Sidekick config to override the default liveHost. it supports parameters $owner and $repo
+     */
+    host: string;
+  };
+  review?: {
+    /**
+     * Sidekick config to override the default reviewHost. it supports parameters $owner and $repo
      */
     host: string;
   };
@@ -339,22 +345,60 @@ export interface Group {
   }[];
 }
 export interface SidekickConfig {
+  /**
+   * The label of the custom editing environment.
+   */
+  editUrlLabel?: string;
+  /**
+   * The URL pattern for the custom editing environment. Supports placeholders like {{contentSourceUrl}} or {{pathname}}.
+   */
+  editUrlPattern?: string;
+  /**
+   * The host name of the production website (overrides cdn.prod.host)
+   */
+  host?: string;
+  /**
+   * The host name of the live environment (overrides cdn.live.host, defaults to *.aem.live)
+   */
+  liveHost?: string;
   plugins?: SidekickPlugin[];
-  [k: string]: unknown;
-}
-export interface SidekickPlugin {
   /**
-   * The unique plugin ID
+   * The host name of the preview environment (overrides cdn.preview.host, defaults to *.aem.page)
    */
-  id: string;
+  previewHost?: string;
   /**
-   * The button text
+   * The name of the project to display in the sidekick
    */
-  title?: string;
+  project?: string;
   /**
-   * The URL to open when the button is clicked
+   * The host name of the review environment (overrides cdn.review.host, defaults to *.aem.reviews)
    */
-  url?: string;
+  reviewHost?: string;
+  specialViews?: SidekickSpecialView[];
+  /**
+   * Additional hosts that are trusted to use the sidekick authentication
+   */
+  trustedHosts?: string[];
+}
+export interface SidekickPlugin {
+  /**
+   * 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';
   /**
    * The ID of the container to add this plugin to
    */
@@ -362,21 +406,29 @@ export interface SidekickPlugin {
   /**
    * The environments to display this plugin in
    */
-  environments?: string & ('any' | 'dev' | 'admin' | 'edit' | 'preview' | 'live' | 'prod' | 'review')[];
+  environments?: string & ('any' | 'dev' | 'admin' | 'edit' | 'preview' | 'review' | '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
+   * Excludes the plugin from these paths
    */
   excludePaths?: string[];
   /**
-   * Include the plugin on these paths (overrides excludePaths)
+   * The unique plugin ID
+   */
+  id: string;
+  /**
+   * Includes the plugin on these paths (overrides excludePaths)
    */
   includePaths?: string[];
   /**
-   * Turns the plugin into a container for other plugins
+   * Renders the plugin as a badge
+   */
+  isBadge?: boolean;
+  /**
+   * Renders the plugin as a container for other plugins
    */
   isContainer?: boolean;
   /**
@@ -384,17 +436,33 @@ export interface SidekickPlugin {
    */
   isPalette?: boolean;
   /**
-   * he dimensions and position of a palette box
+   * Opens the URL in a popover instead of a new tab
+   */
+  isPopover?: boolean;
+  /**
+   * The dimensions and position of the palette (top, left, bottom, right, width, height)
    */
   paletteRect?: string;
   /**
-   * Opens the URL in a popover instead of a new tab
+   * Append ref, repo, owner, host, and project as query params to the URL
    */
-  isPopover?: boolean;
+  passConfig?: boolean;
+  /**
+   * Append the referrer URL as a query param to the URL
+   */
+  passReferrer?: boolean;
+  /**
+   * Renders the plugin in the bar (true, default) or the menu (false)
+   */
+  pinned?: boolean;
   /**
-   * The dimensions of a popover, delimited by a semicolon (width, height)
+   * The dimensions of the popover (width, height)
    */
   popoverRect?: string;
+  /**
+   * The button text
+   */
+  title?: string;
   /**
    * The button text in other supported languages
    */
@@ -408,35 +476,28 @@ export interface SidekickPlugin {
     [k: string]: string;
   };
   /**
-   * Append ref, repo, owner, host, and project as query params on new URL button click
+   * The URL to open when the button is clicked
    */
-  passConfig?: boolean;
+  url?: string;
+  [k: string]: unknown;
+}
+export interface SidekickSpecialView {
   /**
-   * Append the referrer URL as a query param on new URL button click
+   * The unique view ID
    */
-  passReferrer?: boolean;
+  id: string;
   /**
-   * Opens the URL in a palette instead of a new tab
+   * Open the special view on this path
    */
-  isBadge?: boolean;
+  path: string;
   /**
-   * The variant of the badge following the Adobe Spectrum badge variants
+   * Title of the special view
    */
-  badgeVariant?:
-    | 'gray'
-    | 'red'
-    | 'orange'
-    | 'yellow'
-    | 'chartreuse'
-    | 'celery'
-    | 'green'
-    | 'seafoam'
-    | 'cyan'
-    | 'blue'
-    | 'indigo'
-    | 'purple'
-    | 'fuchsia'
-    | 'magenta';
+  title?: string;
+  /**
+   * The URL of the special view. The resource path will be passed to it via 'path' parameter
+   */
+  viewer: string;
   [k: string]: unknown;
 }
 export interface Metadata {

package/types/site-config.d.ts

@@ -42,6 +42,7 @@ export interface HelixSiteConfig {
   access?: Access;
   tokens?: Tokens;
   secrets?: Secrets;
+  apiKeys?: ApiKeys;
   groups?: Groups;
   sidekick?: SidekickConfig;
   metadata?: Metadata;
@@ -141,13 +142,19 @@ export interface CDNConfig {
   prod?: FastlyCDNConfig | CloudflareCDNConfig | AkamaiCDNConfig | ManagedCDNConfig | CloudfrontCDNConfig | EmptyConfig;
   live?: {
     /**
-     * Sidekick config to override the default preview host. it supports parameters $owner and $repo
+     * Sidekick config to override the default previewHost. it supports parameters $owner and $repo
      */
     host: string;
   };
   preview?: {
     /**
-     * Sidekick config to override the default live host. it supports parameters $owner and $repo
+     * Sidekick config to override the default liveHost. it supports parameters $owner and $repo
+     */
+    host: string;
+  };
+  review?: {
+    /**
+     * Sidekick config to override the default reviewHost. it supports parameters $owner and $repo
      */
     host: string;
   };
@@ -329,6 +336,29 @@ export interface Secrets {
         description?: string;
       };
 }
+/**
+ * Stores information about generated admin API keys. The keys listed here have no operational meaning, but are used to track the keys that have been generated.
+ */
+export interface ApiKeys {
+  /**
+   * This interface was referenced by `ApiKeys`'s JSON-Schema definition
+   * via the `patternProperty` "^[a-zA-Z0-9-_]+$".
+   */
+  [k: string]: {
+    /**
+     * the API token id (jti)
+     */
+    id: string;
+    created: string;
+    expiration: string;
+    roles: string[];
+    /**
+     * the subject of the API token (sub)
+     */
+    subject: string;
+    description?: string;
+  };
+}
 export interface Groups {
   [k: string]: Group;
 }
@@ -346,22 +376,60 @@ export interface Group {
   }[];
 }
 export interface SidekickConfig {
+  /**
+   * The label of the custom editing environment.
+   */
+  editUrlLabel?: string;
+  /**
+   * The URL pattern for the custom editing environment. Supports placeholders like {{contentSourceUrl}} or {{pathname}}.
+   */
+  editUrlPattern?: string;
+  /**
+   * The host name of the production website (overrides cdn.prod.host)
+   */
+  host?: string;
+  /**
+   * The host name of the live environment (overrides cdn.live.host, defaults to *.aem.live)
+   */
+  liveHost?: string;
   plugins?: SidekickPlugin[];
-  [k: string]: unknown;
-}
-export interface SidekickPlugin {
   /**
-   * The unique plugin ID
+   * The host name of the preview environment (overrides cdn.preview.host, defaults to *.aem.page)
    */
-  id: string;
+  previewHost?: string;
   /**
-   * The button text
+   * The name of the project to display in the sidekick
    */
-  title?: string;
+  project?: string;
   /**
-   * The URL to open when the button is clicked
+   * The host name of the review environment (overrides cdn.review.host, defaults to *.aem.reviews)
    */
-  url?: string;
+  reviewHost?: string;
+  specialViews?: SidekickSpecialView[];
+  /**
+   * Additional hosts that are trusted to use the sidekick authentication
+   */
+  trustedHosts?: string[];
+}
+export interface SidekickPlugin {
+  /**
+   * 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';
   /**
    * The ID of the container to add this plugin to
    */
@@ -369,21 +437,29 @@ export interface SidekickPlugin {
   /**
    * The environments to display this plugin in
    */
-  environments?: string & ('any' | 'dev' | 'admin' | 'edit' | 'preview' | 'live' | 'prod' | 'review')[];
+  environments?: string & ('any' | 'dev' | 'admin' | 'edit' | 'preview' | 'review' | '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
+   * Excludes the plugin from these paths
    */
   excludePaths?: string[];
   /**
-   * Include the plugin on these paths (overrides excludePaths)
+   * The unique plugin ID
+   */
+  id: string;
+  /**
+   * Includes the plugin on these paths (overrides excludePaths)
    */
   includePaths?: string[];
   /**
-   * Turns the plugin into a container for other plugins
+   * Renders the plugin as a badge
+   */
+  isBadge?: boolean;
+  /**
+   * Renders the plugin as a container for other plugins
    */
   isContainer?: boolean;
   /**
@@ -391,17 +467,33 @@ export interface SidekickPlugin {
    */
   isPalette?: boolean;
   /**
-   * he dimensions and position of a palette box
+   * Opens the URL in a popover instead of a new tab
+   */
+  isPopover?: boolean;
+  /**
+   * The dimensions and position of the palette (top, left, bottom, right, width, height)
    */
   paletteRect?: string;
   /**
-   * Opens the URL in a popover instead of a new tab
+   * Append ref, repo, owner, host, and project as query params to the URL
    */
-  isPopover?: boolean;
+  passConfig?: boolean;
+  /**
+   * Append the referrer URL as a query param to the URL
+   */
+  passReferrer?: boolean;
+  /**
+   * Renders the plugin in the bar (true, default) or the menu (false)
+   */
+  pinned?: boolean;
   /**
-   * The dimensions of a popover, delimited by a semicolon (width, height)
+   * The dimensions of the popover (width, height)
    */
   popoverRect?: string;
+  /**
+   * The button text
+   */
+  title?: string;
   /**
    * The button text in other supported languages
    */
@@ -415,35 +507,28 @@ export interface SidekickPlugin {
     [k: string]: string;
   };
   /**
-   * Append ref, repo, owner, host, and project as query params on new URL button click
+   * The URL to open when the button is clicked
    */
-  passConfig?: boolean;
+  url?: string;
+  [k: string]: unknown;
+}
+export interface SidekickSpecialView {
   /**
-   * Append the referrer URL as a query param on new URL button click
+   * The unique view ID
    */
-  passReferrer?: boolean;
+  id: string;
   /**
-   * Opens the URL in a palette instead of a new tab
+   * Open the special view on this path
    */
-  isBadge?: boolean;
+  path: string;
   /**
-   * The variant of the badge following the Adobe Spectrum badge variants
+   * Title of the special view
    */
-  badgeVariant?:
-    | 'gray'
-    | 'red'
-    | 'orange'
-    | 'yellow'
-    | 'chartreuse'
-    | 'celery'
-    | 'green'
-    | 'seafoam'
-    | 'cyan'
-    | 'blue'
-    | 'indigo'
-    | 'purple'
-    | 'fuchsia'
-    | 'magenta';
+  title?: string;
+  /**
+   * The URL of the special view. The resource path will be passed to it via 'path' parameter
+   */
+  viewer: string;
   [k: string]: unknown;
 }
 export interface Metadata {