@adobe/helix-config 2.12.1 → 2.13.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [2.13.0](https://github.com/adobe/helix-config/compare/v2.12.2...v2.13.0) (2024-05-07)
+
+
+### Features
+
+* store tokens in org config ([#72](https://github.com/adobe/helix-config/issues/72)) ([03a3a81](https://github.com/adobe/helix-config/commit/03a3a812ef1ab3147ea73447dced740dfa48555a)), closes [#69](https://github.com/adobe/helix-config/issues/69)
+
+## [2.12.2](https://github.com/adobe/helix-config/compare/v2.12.1...v2.12.2) (2024-05-04)
+
+
+### Bug Fixes
+
+* **deps:** update adobe fixes ([e62fa79](https://github.com/adobe/helix-config/commit/e62fa79415c617ac250456ac03551fbae1f90766))
+
 ## [2.12.1](https://github.com/adobe/helix-config/compare/v2.12.0...v2.12.1) (2024-05-04)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-config",
-  "version": "2.12.1",
+  "version": "2.13.0",
   "description": "Helix Config",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -59,8 +59,8 @@
   },
   "dependencies": {
     "@adobe/fetch": "4.1.2",
-    "@adobe/helix-shared-config": "10.4.3",
-    "@adobe/helix-shared-git": "3.0.8",
+    "@adobe/helix-shared-config": "10.4.4",
+    "@adobe/helix-shared-git": "3.0.9",
     "@adobe/helix-shared-storage": "1.0.0",
     "@adobe/helix-shared-utils": "3.0.2",
     "ajv": "8.13.0",

package/src/config-view.js

@@ -167,8 +167,8 @@ function retainProperty(obj, prop) {
  */
 async function resolveConfig(ctx, rso, scope) {
   // try to load site config from config-bus
-  const key = `orgs/${rso.org}/sites/${rso.site}.json`;
-  const res = await ctx.loader.getObject(HELIX_CONFIG_BUS, key);
+  let key = `orgs/${rso.org}/sites/${rso.site}.json`;
+  let res = await ctx.loader.getObject(HELIX_CONFIG_BUS, key);
   if (!res.body) {
     if (scope !== SCOPE_ADMIN) {
       return resolveLegacyConfig(ctx, rso, scope);
@@ -193,6 +193,15 @@ async function resolveConfig(ctx, rso, scope) {
     config.head = await loadHeadHtml(ctx, config, rso.ref);
   }
 
+  // check for org config
+  key = `orgs/${rso.org}/config.json`;
+  res = await ctx.loader.getObject(HELIX_CONFIG_BUS, key);
+  if (res.body) {
+    const orgConfig = res.json();
+    if (orgConfig.tokens) {
+      config.tokens = orgConfig.tokens;
+    }
+  }
   return config;
 }
 

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

package/src/schemas/org.schema.json

@@ -0,0 +1,33 @@
+{
+  "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/org",
+  "title": "Helix Org Config",
+  "type": "object",
+  "properties": {
+    "version": {
+      "type": "integer",
+      "enum": [1],
+      "default": 1
+    },
+    "title": { "$ref": "https://ns.adobe.com/helix/config/common#/$defs/title" },
+    "description": { "$ref": "https://ns.adobe.com/helix/config/common#/$defs/description" },
+    "tokens": {
+      "$ref": "https://ns.adobe.com/helix/config/tokens"
+    }
+  },
+  "required": [
+    "version"
+  ],
+  "additionalProperties": false
+}

package/src/schemas/profile.schema.json

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

package/src/schemas/site.schema.json

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

package/src/storage/config-store.js

@@ -44,18 +44,20 @@ const FRAGMENTS_COMMON = {
   },
   public: 'object',
   robots: 'object',
-  tokens: {
-    '.': 'tokens',
-    '.param': {
-      name: 'id',
-      '.': 'token',
-    },
-  },
 };
 
 const FRAGMENTS = {
   sites: FRAGMENTS_COMMON,
   profiles: FRAGMENTS_COMMON,
+  org: {
+    tokens: {
+      '.': 'tokens',
+      '.param': {
+        name: 'id',
+        '.': 'token',
+      },
+    },
+  },
 };
 
 export function getFragmentInfo(type, relPath) {
@@ -147,7 +149,7 @@ export class ConfigStore {
     this.org = org;
     this.type = type;
     this.name = name;
-    this.key = type === org
+    this.key = type === 'org'
       ? `/orgs/${this.org}/config.json`
       : `/orgs/${this.org}/${this.type}/${this.name}.json`;
   }
@@ -160,8 +162,13 @@ export class ConfigStore {
     if (await storage.head(this.key)) {
       throw new StatusCodeError(409, 'config already exists.');
     }
-    updateContentSource(ctx, data.content);
-    updateCodeSource(ctx, data.code);
+    if (this.type === 'org' && data.tokens) {
+      throw new StatusCodeError(400, 'creating org config with tokens not supported yet.');
+    }
+    if (this.type !== 'org') {
+      updateContentSource(ctx, data.content);
+      updateCodeSource(ctx, data.code);
+    }
     await validate(data, this.type);
     await storage.put(this.key, JSON.stringify(data), 'application/json');
     await this.purge(ctx, null, data);
@@ -229,7 +236,7 @@ export class ConfigStore {
         delete ret.hash;
       }
       config = jsonPut(old, relPath, data);
-    } else {
+    } else if (this.type !== 'org') {
       updateContentSource(ctx, config.content);
       updateCodeSource(ctx, config.code);
     }

package/src/storage/config-validator.js

@@ -24,6 +24,7 @@ import foldersSchema from '../schemas/folders.schema.cjs';
 import googleSchema from '../schemas/content-source-google.schema.cjs';
 import markupSchema from '../schemas/content-source-markup.schema.cjs';
 import metadataSchema from '../schemas/metadata-source.schema.cjs';
+import orgSchema from '../schemas/org.schema.cjs';
 import onedriveSchema from '../schemas/content-source-onedrive.schema.cjs';
 import profileSchema from '../schemas/profile.schema.cjs';
 import robotsSchema from '../schemas/robots.schema.cjs';
@@ -43,6 +44,7 @@ const SCHEMAS = [
   googleSchema,
   markupSchema,
   metadataSchema,
+  orgSchema,
   onedriveSchema,
   profileSchema,
   robotsSchema,
@@ -54,6 +56,7 @@ const SCHEMAS = [
 const SCHEMA_TYPES = {
   profiles: profileSchema,
   sites: siteSchema,
+  org: orgSchema,
 };
 
 /**

package/types/org-config.d.ts

@@ -0,0 +1,37 @@
+/*
+ * 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.
+ */
+
+// NOTE: this file is autogenerated via 'npm run docs:types'
+
+export interface HelixOrgConfig {
+  version: 1;
+  /**
+   * human readable title. has no influence on the configuration.
+   */
+  title?: string;
+  /**
+   * description for clarity. has no influence on the configuration.
+   */
+  description?: string;
+  tokens?: Tokens;
+}
+export interface Tokens {
+  /**
+   * This interface was referenced by `Tokens`'s JSON-Schema definition
+   * via the `patternProperty` "^[a-zA-Z0-9-_=]+$".
+   */
+  [k: string]: {
+    id?: string;
+    hash?: string;
+    created?: string;
+  };
+}

package/types/profile-config.d.ts

@@ -11,7 +11,6 @@
  */
 
 // NOTE: this file is autogenerated via 'npm run docs:types'
-import {MountConfig} from '@adobe/helix-shared-config';
 
 export interface HelixProfileConfig {
   version: 1;
@@ -32,7 +31,6 @@ export interface HelixProfileConfig {
   sidekick?: SidekickConfig;
   metadata?: Metadata;
   robots?: Robots;
-  tokens?: Tokens;
 }
 /**
  * Defines the content bus location and source.
@@ -248,14 +246,3 @@ export interface Metadata {
 export interface Robots {
   txt?: string;
 }
-export interface Tokens {
-  /**
-   * This interface was referenced by `Tokens`'s JSON-Schema definition
-   * via the `patternProperty` "^[a-zA-Z0-9-_=]+$".
-   */
-  [k: string]: {
-    id?: string;
-    hash?: string;
-    created?: string;
-  };
-}

package/types/site-config.d.ts

@@ -35,7 +35,6 @@ export interface HelixSiteConfig {
   sidekick?: SidekickConfig;
   metadata?: Metadata;
   robots?: Robots;
-  tokens?: Tokens;
 }
 /**
  * Defines the content bus location and source.
@@ -251,14 +250,3 @@ export interface Metadata {
 export interface Robots {
   txt?: string;
 }
-export interface Tokens {
-  /**
-   * This interface was referenced by `Tokens`'s JSON-Schema definition
-   * via the `patternProperty` "^[a-zA-Z0-9-_=]+$".
-   */
-  [k: string]: {
-    id?: string;
-    hash?: string;
-    created?: string;
-  };
-}