@adobe/helix-config 3.2.14 → 3.3.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [3.3.0](https://github.com/adobe/helix-config/compare/v3.2.15...v3.3.0) (2024-06-21)
+
+
+### Features
+
+* add site and profile lists ([#110](https://github.com/adobe/helix-config/issues/110)) ([98c6a61](https://github.com/adobe/helix-config/commit/98c6a6102578fb4695704e1be44f6e7321c46d4d)), closes [#84](https://github.com/adobe/helix-config/issues/84) [#85](https://github.com/adobe/helix-config/issues/85)
+
+## [3.2.15](https://github.com/adobe/helix-config/compare/v3.2.14...v3.2.15) (2024-06-20)
+
+
+### Bug Fixes
+
+* legacy sites with apiKey but no allow must not authenticate ([#109](https://github.com/adobe/helix-config/issues/109)) ([421575e](https://github.com/adobe/helix-config/commit/421575eb9093820a824031695f26bbc568dd4505)), closes [#91](https://github.com/adobe/helix-config/issues/91)
+
 ## [3.2.14](https://github.com/adobe/helix-config/compare/v3.2.13...v3.2.14) (2024-06-20)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-config",
-  "version": "3.2.14",
+  "version": "3.3.0",
   "description": "Helix Config",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -51,7 +51,8 @@
     "mocha-multi-reporters": "1.5.1",
     "mocha-suppress-logs": "0.5.1",
     "nock": "13.5.4",
-    "semantic-release": "24.0.0"
+    "semantic-release": "24.0.0",
+    "xml2js": "0.6.2"
   },
   "lint-staged": {
     "*.js": "eslint",

package/src/config-legacy.js

@@ -131,6 +131,7 @@ export async function resolveLegacyConfig(ctx, rso, scope) {
   }
   const config = {
     version: 1,
+    legacy: true,
     code: {
       owner: rso.org,
       repo: rso.site,

package/src/config-view.js

@@ -122,8 +122,7 @@ export async function getAccessConfig(ctx, config, partition, rso) {
       .filter((hash) => !!hash),
     clientCertDN: toArray(access[partition]?.clientCertDN ?? access.clientCertDN),
   };
-  // if an allow is defined but no apiKeyId, create a fake one so that auth is still
-  // enforced. later we can remove the allow and the apiKeyId in favor of the tokenHash
+  // if an allow is defined but no apiKeyId, create a fake one so that auth is still enforced.
   if (allow.length && !cfg.apiKeyId.length) {
     cfg.apiKeyId.push('dummy');
   }
@@ -137,7 +136,10 @@ export async function getAccessConfig(ctx, config, partition, rso) {
       cfg.tokenHash.push(globalTokenHash);
     } else if (!cfg.tokenHash.length) {
       // add a dummy or global hash if no tokens match the apiKeyIds.
-      cfg.tokenHash.push(globalTokenHash || 'n/a');
+      if (!config.legacy || allow.length) {
+        // but only add for non-legacy sites or legacy with allows
+        cfg.tokenHash.push(globalTokenHash || 'n/a');
+      }
     }
   }
 

package/src/schemas/profiles.schema.cjs

@@ -0,0 +1,12 @@
+/*
+ * Copyright 2024 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+module.exports = require('./profiles.schema.json');

package/src/schemas/profiles.schema.json

@@ -0,0 +1,38 @@
+{
+  "meta:license": [
+    "Copyright 2024 Adobe. All rights reserved.",
+    "This file is licensed to you under the Apache License, Version 2.0 (the \"License\");",
+    "you may not use this file except in compliance with the License. You may obtain a copy",
+    "of the License at http://www.apache.org/licenses/LICENSE-2.0",
+    "",
+    "Unless required by applicable law or agreed to in writing, software distributed under",
+    "the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS",
+    "OF ANY KIND, either express or implied. See the License for the specific language",
+    "governing permissions and limitations under the License."
+  ],
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://ns.adobe.com/helix/config/profiles",
+  "title": "Helix Profiles List",
+  "type": "object",
+  "properties": {
+    "profiles": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "name"
+        ],
+        "additionalProperties": false
+      }
+    }
+  },
+  "required": [
+    "profiles"
+  ],
+  "additionalProperties": false
+}

package/src/schemas/sites.schema.cjs

@@ -0,0 +1,12 @@
+/*
+ * Copyright 2024 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+module.exports = require('./sites.schema.json');

package/src/schemas/sites.schema.json

@@ -0,0 +1,38 @@
+{
+  "meta:license": [
+    "Copyright 2024 Adobe. All rights reserved.",
+    "This file is licensed to you under the Apache License, Version 2.0 (the \"License\");",
+    "you may not use this file except in compliance with the License. You may obtain a copy",
+    "of the License at http://www.apache.org/licenses/LICENSE-2.0",
+    "",
+    "Unless required by applicable law or agreed to in writing, software distributed under",
+    "the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS",
+    "OF ANY KIND, either express or implied. See the License for the specific language",
+    "governing permissions and limitations under the License."
+  ],
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://ns.adobe.com/helix/config/sites",
+  "title": "Helix Sites List",
+  "type": "object",
+  "properties": {
+    "sites": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "name"
+        ],
+        "additionalProperties": false
+      }
+    }
+  },
+  "required": [
+    "sites"
+  ],
+  "additionalProperties": false
+}

package/src/storage/config-store.js

@@ -148,7 +148,7 @@ export class ConfigStore {
    * @param {string} type store type (org, sites, profiles, secrets, users)
    * @param {string} name config name
    */
-  constructor(org, type = 'org', name = 'config') {
+  constructor(org, type = 'org', name = '') {
     if (!org) {
       throw new Error('org required');
     }
@@ -159,7 +159,7 @@ export class ConfigStore {
     this.type = type;
     this.name = name;
     this.key = type === 'org'
-      ? `/orgs/${this.org}/config.json`
+      ? `/orgs/${this.org}/${this.name || 'config'}.json`
       : `/orgs/${this.org}/${this.type}/${this.name}.json`;
   }
 
@@ -186,7 +186,28 @@ export class ConfigStore {
     await this.purge(ctx, null, data);
   }
 
+  async #list(ctx) {
+    const storage = HelixStorage.fromContext(ctx).configBus();
+    const key = `/orgs/${this.org}/${this.type}`;
+    const list = await storage.list(key);
+    return {
+      [this.type]: list.map((entry) => {
+        const siteKey = entry.key;
+        if (siteKey.endsWith('.json')) {
+          return {
+            name: siteKey.substring(0, siteKey.length - 5),
+          };
+        }
+        return null;
+      }).filter((entry) => entry),
+    };
+  }
+
   async read(ctx, relPath = '') {
+    if (this.name === '' && (this.type === 'sites' || this.type === 'profiles')) {
+      return this.#list(ctx);
+    }
+
     const storage = HelixStorage.fromContext(ctx).configBus();
     const buf = await storage.get(this.key);
     if (!buf) {

package/src/storage/config-validator.js

@@ -29,9 +29,11 @@ import orgSchema from '../schemas/org.schema.cjs';
 import onedriveSchema from '../schemas/content-source-onedrive.schema.cjs';
 import publicSchema from '../schemas/public.schema.cjs';
 import profileSchema from '../schemas/profile.schema.cjs';
+import profilesSchema from '../schemas/profiles.schema.cjs';
 import robotsSchema from '../schemas/robots.schema.cjs';
 import sidekickSchema from '../schemas/sidekick.schema.cjs';
 import siteSchema from '../schemas/site.schema.cjs';
+import sitesSchema from '../schemas/sites.schema.cjs';
 import tokensSchema from '../schemas/tokens.schema.cjs';
 import userSchema from '../schemas/user.schema.cjs';
 import usersSchema from '../schemas/users.schema.cjs';
@@ -53,9 +55,11 @@ export const SCHEMAS = [
   onedriveSchema,
   publicSchema,
   profileSchema,
+  profilesSchema,
   robotsSchema,
   sidekickSchema,
   siteSchema,
+  sitesSchema,
   tokensSchema,
   userSchema,
   usersSchema,