@adobe/helix-config-storage 2.12.1 → 2.12.2

package/.claude/settings.local.json

@@ -0,0 +1,7 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(npx mocha:*)"
+    ]
+  }
+}

package/CLAUDE.md

@@ -0,0 +1,47 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Commands
+
+```bash
+# Run all tests with coverage
+npm test
+
+# Run a single test file
+npx mocha --spec 'test/config-store.test.js'
+
+# Lint (ESLint + JSON schema validation)
+npm run lint
+
+# Validate JSON schemas only
+./validate-json-schemas.sh
+```
+
+## Architecture
+
+This is a Node.js library for managing configuration storage for Adobe Helix (Edge Delivery Services) projects. It provides CRUD operations for org, site, and profile configuration objects stored in a content bus via `@adobe/helix-shared-storage`.
+
+### Core Concepts
+
+- **Config types**: `org`, `sites`, `profiles` — stored at `/orgs/{org}/{type}/{name}.json`
+- **Fragments**: Support for updating nested subpaths (e.g., `/cdn/prod`, `/secrets/{id}`) via parameterized deep-path operations
+- **Profile merging**: Site configs can inherit from profiles; `config-merge.js` handles atomic/object/array union merge strategies
+- **Versioning**: Auto-incrementing version history stored alongside each config
+- **Access control gates**: `withAllowAdmin(bool)` and `withAllowOps(bool)` on the store control what callers may modify
+
+### Key Files
+
+- `src/config-store.js` — Main `ConfigStore` class with create/read/update/remove/validate methods
+- `src/fragment.js` — Fragment path parsing and application for nested updates
+- `src/config-merge.js` — Profile/site merge logic (atomic vs. deep-merge vs. array-union per property)
+- `src/config-validator.js` — AJV-based schema validation across 40+ JSON schemas in `src/schemas/`
+- `src/config-versioning.js` — Version history management
+- `src/utils.js` — Helpers for users, tokens, secrets, content/code source detection
+
+### Patterns
+
+- All operations accept a `ctx` object providing storage access (`HelixStorage.fromContext(ctx).configBus()`) and logging (`ctx.log`)
+- Sensitive fields (secrets, tokens) are redacted on read — only metadata is returned
+- Schema validation uses AJV with coercion and defaults enabled
+- The `Fragment` class handles parameterized sub-paths; arrays and objects within configs use different merge strategies

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-config-storage",
-  "version": "2.12.1",
+  "version": "2.12.2",
   "description": "Helix Config Storage",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -36,18 +36,18 @@
     "reporter-options": "configFile=.mocha-multi.json"
   },
   "devDependencies": {
-    "@adobe/eslint-config-helix": "3.0.21",
+    "@adobe/eslint-config-helix": "3.0.22",
     "@eslint/config-helpers": "0.5.2",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/git": "10.0.1",
-    "@semantic-release/npm": "13.1.4",
+    "@semantic-release/npm": "13.1.5",
     "ajv-cli": "5.0.0",
     "c8": "11.0.0",
     "eslint": "9.4.0",
     "husky": "9.1.7",
     "json-schema-to-typescript": "15.0.4",
     "junit-report-builder": "5.1.1",
-    "lint-staged": "16.2.7",
+    "lint-staged": "16.3.1",
     "mocha": "11.7.5",
     "mocha-multi-reporters": "1.5.1",
     "mocha-suppress-logs": "0.6.0",
@@ -68,6 +68,7 @@
     "@adobe/helix-shared-string": "^2.1.0",
     "@adobe/helix-shared-utils": "^3.0.2",
     "ajv": "8.18.0",
+    "ajv-errors": "^3.0.0",
     "ajv-formats": "3.0.1",
     "jose": "6.1.3"
   }

package/src/config-validator.js

@@ -10,6 +10,7 @@
  * governing permissions and limitations under the License.
  */
 import Ajv2019 from 'ajv/dist/2019.js';
+import ajvErrors from 'ajv-errors';
 import ajvFormats from 'ajv-formats';
 import { ValidationError } from './ValidationError.js';
 
@@ -114,6 +115,7 @@ export async function validate(config, type) {
     strict: false,
   });
   ajvFormats(ajv);
+  ajvErrors(ajv);
 
   ajv.addSchema(SCHEMAS);
   const res = ajv.validate(schema, config);

package/src/schemas/cdn-prod-akamai.schema.json

@@ -12,10 +12,12 @@
     "host": {
       "description": "production host",
       "type": "string",
-      "pattern": "^([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.){1,3}[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?$",
+      "pattern": "^$|^([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.){1,3}[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?$",
       "not": {
-        "pattern": ".*--.*--.*\\.aem\\.(live|page|reviews|network)$",
-        "description": "AEM endpoints not allowed"
+        "pattern": ".*--.*--.*\\.aem\\.(live|page|reviews|network)$"
+      },
+      "errorMessage": {
+        "not": "AEM endpoints are not allowed as /cdn/prod/host"
       }
     },
     "route": {

package/src/schemas/cdn-prod-cloudflare.schema.json

@@ -12,10 +12,12 @@
     "host": {
       "description": "production host",
       "type": "string",
-      "pattern": "^([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.){1,3}[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?$",
+      "pattern": "^$|^([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.){1,3}[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?$",
       "not": {
-        "pattern": ".*--.*--.*\\.aem\\.(live|page|reviews|network)$",
-        "description": "AEM endpoints not allowed"
+        "pattern": ".*--.*--.*\\.aem\\.(live|page|reviews|network)$"
+      },
+      "errorMessage": {
+        "not": "AEM endpoints are not allowed as /cdn/prod/host"
       }
     },
     "route": {

package/src/schemas/cdn-prod-cloudfront.schema.json

@@ -12,10 +12,12 @@
     "host": {
       "description": "production host",
       "type": "string",
-      "pattern": "^([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.){1,3}[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?$",
+      "pattern": "^$|^([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.){1,3}[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?$",
       "not": {
-        "pattern": ".*--.*--.*\\.aem\\.(live|page|reviews|network)$",
-        "description": "AEM endpoints not allowed"
+        "pattern": ".*--.*--.*\\.aem\\.(live|page|reviews|network)$"
+      },
+      "errorMessage": {
+        "not": "AEM endpoints are not allowed as /cdn/prod/host"
       }
     },
     "route": {

package/src/schemas/cdn-prod-fastly.schema.json

@@ -13,10 +13,12 @@
     "host": {
       "description": "production host",
       "type": "string",
-      "pattern": "^([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.){1,3}[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?$",
+      "pattern": "^$|^([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.){1,3}[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?$",
       "not": {
-        "pattern": ".*--.*--.*\\.aem\\.(live|page|reviews|network)$",
-        "description": "AEM endpoints not allowed"
+        "pattern": ".*--.*--.*\\.aem\\.(live|page|reviews|network)$"
+      },
+      "errorMessage": {
+        "not": "AEM endpoints are not allowed as /cdn/prod/host"
       }
     },
     "route": {

package/src/schemas/cdn-prod-managed.schema.json

@@ -12,10 +12,12 @@
     "host": {
       "description": "production host",
       "type": "string",
-      "pattern": "^([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.){1,3}[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?$",
+      "pattern": "^$|^([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.){1,3}[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?$",
       "not": {
-        "pattern": ".*--.*--.*\\.aem\\.(live|page|reviews|network)$",
-        "description": "AEM endpoints not allowed"
+        "pattern": ".*--.*--.*\\.aem\\.(live|page|reviews|network)$"
+      },
+      "errorMessage": {
+        "not": "AEM endpoints are not allowed as /cdn/prod/host"
       }
     },
     "envId": {

package/src/schemas/cdn.schema.json

@@ -31,8 +31,10 @@
               "type": "string",
               "pattern": "^([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.){1,3}[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?$",
               "not": {
-                "pattern": ".*--.*--.*\\.aem\\.(live|page|reviews|network)$",
-                "description": "AEM endpoints not allowed"
+                "pattern": ".*--.*--.*\\.aem\\.(live|page|reviews|network)$"
+              },
+              "errorMessage": {
+                "not": "AEM endpoints are not allowed as /cdn/prod/host"
               }
             }
           },
@@ -53,8 +55,10 @@
           ],
           "type": "string",
           "not": {
-            "pattern": ".*--.*--.*\\.aem\\.(live|page|reviews|network)$",
-            "description": "AEM endpoints not allowed"
+            "pattern": ".*--.*--.*\\.aem\\.(live|page|reviews|network)$"
+          },
+          "errorMessage": {
+            "not": "AEM endpoints are not allowed as /cdn/live/host"
           }
         }
       },
@@ -73,8 +77,10 @@
           ],
           "type": "string",
           "not": {
-            "pattern": ".*--.*--.*\\.aem\\.(live|page|reviews|network)$",
-            "description": "AEM endpoints not allowed"
+            "pattern": ".*--.*--.*\\.aem\\.(live|page|reviews|network)$"
+          },
+          "errorMessage": {
+            "not": "AEM endpoints are not allowed as /cdn/preview/host"
           }
         }
       },
@@ -93,8 +99,10 @@
           ],
           "type": "string",
           "not": {
-            "pattern": ".*--.*--.*\\.aem\\.(live|page|reviews|network)$",
-            "description": "AEM endpoints not allowed"
+            "pattern": ".*--.*--.*\\.aem\\.(live|page|reviews|network)$"
+          },
+          "errorMessage": {
+            "not": "AEM endpoints are not allowed as /cdn/review/host"
           }
         }
       },