@adobe/helix-config-storage 2.2.12 → 2.3.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [2.3.0](https://github.com/adobe/helix-config-storage/compare/v2.2.13...v2.3.0) (2025-06-24)
+
+
+### Features
+
+* include site details in list ([#146](https://github.com/adobe/helix-config-storage/issues/146)) ([00656ee](https://github.com/adobe/helix-config-storage/commit/00656ee93da9ac41410aeb79b4c2fdad35359fe7))
+
+## [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)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-config-storage",
-  "version": "2.2.12",
+  "version": "2.3.0",
   "description": "Helix Config Storage",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -36,7 +36,7 @@
     "reporter-options": "configFile=.mocha-multi.json"
   },
   "devDependencies": {
-    "@adobe/eslint-config-helix": "3.0.4",
+    "@adobe/eslint-config-helix": "3.0.5",
     "@eslint/config-helpers": "0.2.3",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/git": "10.0.1",
@@ -48,7 +48,7 @@
     "json-schema-to-typescript": "15.0.4",
     "junit-report-builder": "5.1.1",
     "lint-staged": "16.1.2",
-    "mocha": "11.6.0",
+    "mocha": "11.7.0",
     "mocha-multi-reporters": "1.5.1",
     "mocha-suppress-logs": "0.5.1",
     "nock": "13.5.6",
@@ -63,6 +63,7 @@
     "@adobe/fetch": "^4.2.0",
     "@adobe/helix-shared-config": "^11.1.4",
     "@adobe/helix-shared-git": "^3.0.18",
+    "@adobe/helix-shared-process-queue": "3.1.3",
     "@adobe/helix-shared-storage": "^1.3.0",
     "@adobe/helix-shared-string": "^2.1.0",
     "@adobe/helix-shared-utils": "^3.0.2",

package/src/config-store.js

@@ -13,6 +13,7 @@
 import crypto from 'crypto';
 import { decodeJwt } from 'jose';
 import { HelixStorage } from '@adobe/helix-shared-storage';
+import processQueue from '@adobe/helix-shared-process-queue';
 import { StatusCodeError } from './status-code-error.js';
 import {
   createToken, createUser,
@@ -350,6 +351,7 @@ export class ConfigStore {
     this.now = new Date();
     this.isAdmin = false;
     this.isOps = false;
+    this.listDetails = false;
   }
 
   /**
@@ -372,6 +374,16 @@ export class ConfigStore {
     return this;
   }
 
+  /**
+   * shows the details of the config list, like the source and code urls.
+   * @param v
+   * @returns {ConfigStore}
+   */
+  withListDetails(v) {
+    this.listDetails = v;
+    return this;
+  }
+
   /**
    * updates the created and lastModified time stamp on the data object to the current time.
    * the created property is only set if it doesn't exist yet.
@@ -388,18 +400,28 @@ export class ConfigStore {
     const storage = HelixStorage.fromContext(ctx).configBus();
     const key = `orgs/${this.org}/${this.type}/`;
     const list = await storage.list(key);
+    let entries = list.map((entry) => {
+      const siteKey = entry.key;
+      if (siteKey.endsWith('.json')) {
+        const name = siteKey.split('/').pop();
+        return {
+          path: `/config/${this.org}/${this.type}/${name}`,
+          name: name.substring(0, name.length - 5),
+        };
+      }
+      return null;
+    }).filter((entry) => !!entry);
+
+    if (this.listDetails) {
+      entries = await processQueue(entries, async (entry) => {
+        const json = JSON.parse(await storage.get(`/orgs/${this.org}/${this.type}/${entry.name}.json`));
+        entry.content = json.content;
+        entry.code = json.code;
+        return entry;
+      });
+    }
     return {
-      [this.type]: list.map((entry) => {
-        const siteKey = entry.key;
-        if (siteKey.endsWith('.json')) {
-          const name = siteKey.split('/').pop();
-          return {
-            path: `/config/${this.org}/${this.type}/${name}`,
-            name: name.substring(0, name.length - 5),
-          };
-        }
-        return null;
-      }).filter((entry) => !!entry),
+      [this.type]: entries,
     };
   }
 
@@ -732,21 +754,19 @@ export class ConfigStore {
     config.created = oldConfig?.created;
     this.#updateTimeStamps(config);
     let newConfig = config;
+    let purgeConfig = oldConfig;
     if (this.type === 'sites') {
-      // apply profile
-      if (!oldConfig) {
-        // 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 = { extends: newConfig.extends };
-      }
-      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);
   }