@adobe/helix-config 3.7.1 → 3.9.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [3.9.0](https://github.com/adobe/helix-config/compare/v3.8.0...v3.9.0) (2024-07-18)
+
+
+### Features
+
+* also include ctx ([#140](https://github.com/adobe/helix-config/issues/140)) ([6c29c54](https://github.com/adobe/helix-config/commit/6c29c541ccacc6740d60f577889f5064ec6c29c4))
+
+# [3.8.0](https://github.com/adobe/helix-config/compare/v3.7.1...v3.8.0) (2024-07-18)
+
+
+### Features
+
+* make ConfigStore.validate() overridable ([#139](https://github.com/adobe/helix-config/issues/139)) ([6a85c7f](https://github.com/adobe/helix-config/commit/6a85c7fbefb3687c8c4f8ae2117886507192aaac))
+
 ## [3.7.1](https://github.com/adobe/helix-config/compare/v3.7.0...v3.7.1) (2024-07-17)
 
 

package/package.json

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

package/src/storage/config-store.js

@@ -19,7 +19,7 @@ import {
   updateCodeSource,
   updateContentSource,
 } from './utils.js';
-import { validate } from './config-validator.js';
+import { validate as validateSchema } from './config-validator.js';
 import { deepGetOrCreate, deepPut } from '../utils.js';
 
 const FRAGMENTS_COMMON = {
@@ -177,6 +177,16 @@ export class ConfigStore {
       : `/orgs/${this.org}/${this.type}/${this.name}.json`;
   }
 
+  /**
+   * Validates the config and throws an error if not valid.
+   * @param {AdminContext} ctx
+   * @param {HelixSiteConfig|HelixProfileConfig} data the data of the config to be updated
+   * @returns {Promise<boolean|undefined>}
+   */
+  async validate(ctx, data) {
+    return validateSchema(data, this.type);
+  }
+
   async create(ctx, data, relPath = '') {
     if (relPath) {
       throw new StatusCodeError(409, 'create not supported on substructures.');
@@ -195,7 +205,7 @@ export class ConfigStore {
       updateContentSource(ctx, data.content);
       updateCodeSource(ctx, data.code);
     }
-    await validate(data, this.type);
+    await this.validate(ctx, data);
     await storage.put(this.key, JSON.stringify(data), 'application/json');
     await this.purge(ctx, null, data);
   }
@@ -315,7 +325,7 @@ export class ConfigStore {
       updateContentSource(ctx, config.content);
       updateCodeSource(ctx, config.code);
     }
-    await validate(config, this.type);
+    await this.validate(ctx, config);
     await storage.put(this.key, JSON.stringify(config), 'application/json');
     await this.purge(ctx, buf ? JSON.parse(buf) : null, config);
     return ret ?? redact(data, frag);
@@ -330,7 +340,7 @@ export class ConfigStore {
     const frag = getFragmentInfo(this.type, relPath);
     if (frag) {
       const data = deepPut(JSON.parse(buf), relPath, null);
-      await validate(data, this.type);
+      await this.validate(ctx, data);
       await storage.put(this.key, JSON.stringify(data), 'application/json');
       await this.purge(ctx, JSON.parse(buf), data);
       return;