@adobe/helix-config-storage 1.6.0 → 1.7.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [1.7.0](https://github.com/adobe/helix-config-storage/compare/v1.6.1...v1.7.0) (2024-09-05)
+
+
+### Features
+
+* add apiKeyId to org config ([#20](https://github.com/adobe/helix-config-storage/issues/20)) ([d6d86fe](https://github.com/adobe/helix-config-storage/commit/d6d86fecfad2f020a46efbe7061660bf312f67b6)), closes [#19](https://github.com/adobe/helix-config-storage/issues/19)
+
+## [1.6.1](https://github.com/adobe/helix-config-storage/compare/v1.6.0...v1.6.1) (2024-09-03)
+
+
+### Bug Fixes
+
+* properly store tokens ([#18](https://github.com/adobe/helix-config-storage/issues/18)) ([d919bf8](https://github.com/adobe/helix-config-storage/commit/d919bf86f248e0badc771305fa4f995b2bae74df))
+
 # [1.6.0](https://github.com/adobe/helix-config-storage/compare/v1.5.0...v1.6.0) (2024-09-02)
 
 

package/package.json

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

package/src/config-store.js

@@ -102,6 +102,10 @@ const FRAGMENTS = {
         members: 'object',
       },
     },
+    access: {
+      '.': 'object',
+      admin: 'object',
+    },
   },
 };
 

package/src/config-validator.js

@@ -31,6 +31,7 @@ import googleSchema from './schemas/content-source-google.schema.cjs';
 import headersSchema from './schemas/headers.schema.cjs';
 import markupSchema from './schemas/content-source-markup.schema.cjs';
 import metadataSchema from './schemas/metadata-source.schema.cjs';
+import orgAccessSchema from './schemas/org-access.schema.cjs';
 import orgSchema from './schemas/org.schema.cjs';
 import onedriveSchema from './schemas/content-source-onedrive.schema.cjs';
 import publicSchema from './schemas/public.schema.cjs';
@@ -59,6 +60,7 @@ export const SCHEMAS = [
   markupSchema,
   metadataSchema,
   orgSchema,
+  orgAccessSchema,
   onedriveSchema,
   publicSchema,
   profileSchema,

package/src/schemas/org-access.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('./org-access.schema.json');

package/src/schemas/org-access.schema.json

@@ -0,0 +1,24 @@
+{
+  "$comment": "https://github.com/adobe/helix-config/blob/main/LICENSE.txt",
+  "$id": "https://ns.adobe.com/helix/config/org/access",
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "title": "Org Access Config",
+  "type": "object",
+  "properties": {
+    "admin": {
+      "type": "object",
+      "properties": {
+        "apiKeyId": {
+          "description": "the id of the API key(s). this is used to validate the API KEYS and allows to invalidate them.",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false
+}
+

package/src/schemas/org.schema.json

@@ -20,6 +20,9 @@
     },
     "tokens": {
       "$ref": "https://ns.adobe.com/helix/config/tokens"
+    },
+    "access": {
+      "$ref": "https://ns.adobe.com/helix/config/org/access"
     }
   },
   "required": [

package/src/transient-token-store.js

@@ -57,6 +57,11 @@ export class TransientTokenStore {
    */
   #modified;
 
+  /**
+   * flag indicating that the store was modified
+   */
+  wasModified = false;
+
   /**
    * consistent "now"
    */
@@ -108,8 +113,11 @@ export class TransientTokenStore {
   async #save(ctx) {
     if (this.#modified) {
       const storage = HelixStorage.fromContext(ctx).configBus();
-      await storage.put(this.#key, JSON.stringify(this.#tokens));
+      await storage.put(this.#key, JSON.stringify({
+        tokens: this.#tokens,
+      }));
       this.#modified = false;
+      this.wasModified = true;
     }
   }
 

package/validate-json-schemas.sh

@@ -22,6 +22,7 @@ npx ajv-cli --spec=draft2019 -c ajv-formats compile \
 -s src/schemas/user.schema.json \
 -s src/schemas/users.schema.json \
 -s src/schemas/tokens.schema.json \
+-s src/schemas/org-access.schema.json \
 -s src/schemas/org.schema.json \
 -s src/schemas/sidekick.schema.json \
 -s src/schemas/robots.schema.json \