@adobe/helix-config 3.9.3 → 3.10.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [3.10.0](https://github.com/adobe/helix-config/compare/v3.9.4...v3.10.0) (2024-07-25)
+
+
+### Features
+
+* move tokens from org to sites/profiles ([#151](https://github.com/adobe/helix-config/issues/151)) ([4eb3073](https://github.com/adobe/helix-config/commit/4eb3073386b951c88d5318d7511a41e0fb8a0eb5))
+
+## [3.9.4](https://github.com/adobe/helix-config/compare/v3.9.3...v3.9.4) (2024-07-23)
+
+
+### Bug Fixes
+
+* fix schema ([#148](https://github.com/adobe/helix-config/issues/148)) ([43e13d2](https://github.com/adobe/helix-config/commit/43e13d26c1045001248fb3f002b53fcb71b820d0))
+
 ## [3.9.3](https://github.com/adobe/helix-config/compare/v3.9.2...v3.9.3) (2024-07-22)
 
 

package/package.json

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

package/src/config-view.js

@@ -210,6 +210,15 @@ function retainProperty(obj, prop) {
   }
 }
 
+async function loadProfile(ctx, rso, name) {
+  const profileKey = `orgs/${rso.org}/profiles/${name}.json`;
+  const res = await ctx.loader.getObject(HELIX_CONFIG_BUS, profileKey);
+  if (res.body) {
+    return res.json();
+  }
+  return null;
+}
+
 /**
  * Returns the config for the given RSO
  * @param ctx
@@ -220,16 +229,20 @@ 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`;
-  let res = await ctx.loader.getObject(HELIX_CONFIG_BUS, key);
+  const res = await ctx.loader.getObject(HELIX_CONFIG_BUS, key);
   if (!res.body) {
     if (scope !== SCOPE_ADMIN) {
-      return resolveLegacyConfig(ctx, rso, scope);
+      const config = await resolveLegacyConfig(ctx, rso, scope);
+      if (config) {
+        const profile = await loadProfile(ctx, rso, 'default');
+        config.tokens = profile?.tokens || {};
+      }
+      return config;
     } else {
       return null;
     }
   }
   const site = res.json();
-  let profile;
 
   // always load default profile if available
   if (!site.extends?.profile) {
@@ -237,11 +250,7 @@ async function resolveConfig(ctx, rso, scope) {
       profile: 'default',
     };
   }
-  const profileKey = `orgs/${rso.org}/profiles/${site.extends.profile}.json`;
-  res = await ctx.loader.getObject(HELIX_CONFIG_BUS, profileKey);
-  if (res.body) {
-    profile = res.json();
-  }
+  const profile = await loadProfile(ctx, rso, site.extends.profile);
   const config = getMergedConfig(site, profile);
   if (scope === SCOPE_PIPELINE) {
     config.metadata = {
@@ -383,10 +392,6 @@ export async function getConfigResponse(ctx, opts) {
   }
 
   const orgConfig = await loadOrgConfig(ctx, org);
-  if (orgConfig?.tokens) {
-    config.tokens = orgConfig.tokens;
-  }
-
   if (config.access) {
     // normalize access config
     const { admin = {} } = config.access;

package/src/schemas/headers.schema.json

@@ -17,9 +17,9 @@
   "patternProperties": {
     "^/[a-zA-Z0-9-/.]*\\*{0,2}$": {
       "type": "array",
-      "items": [
-        { "$ref": "https://ns.adobe.com/helix/config/common#/definitions/keyValuePair" }
-      ]
+      "items": {
+        "$ref": "https://ns.adobe.com/helix/config/common#/definitions/keyValuePair"
+      }
     }
   },
   "additionalProperties": false

package/src/schemas/org.schema.json

@@ -22,9 +22,6 @@
     },
     "title": { "$ref": "https://ns.adobe.com/helix/config/common#/definitions/title" },
     "description": { "$ref": "https://ns.adobe.com/helix/config/common#/definitions/description" },
-    "tokens": {
-      "$ref": "https://ns.adobe.com/helix/config/tokens"
-    },
     "users": {
       "$ref": "https://ns.adobe.com/helix/config/users"
     },

package/src/schemas/profile.schema.json

@@ -41,6 +41,12 @@
     "access": {
       "$ref": "https://ns.adobe.com/helix/config/access"
     },
+    "tokens": {
+      "$ref": "https://ns.adobe.com/helix/config/tokens"
+    },
+    "groups": {
+      "$ref": "https://ns.adobe.com/helix/config/groups"
+    },
     "sidekick": {
       "$ref": "https://ns.adobe.com/helix/config/sidekick"
     },

package/src/schemas/site.schema.json

@@ -46,6 +46,9 @@
     "access": {
       "$ref": "https://ns.adobe.com/helix/config/access"
     },
+    "tokens": {
+      "$ref": "https://ns.adobe.com/helix/config/tokens"
+    },
     "groups": {
       "$ref": "https://ns.adobe.com/helix/config/groups"
     },

package/src/schemas/user.schema.json

@@ -12,6 +12,7 @@
   ],
   "$schema": "http://json-schema.org/draft-07/schema#",
   "$id": "https://ns.adobe.com/helix/config/user",
+  "title": "user",
   "type": "object",
   "properties": {
     "id": {

package/src/storage/config-store.js

@@ -41,6 +41,20 @@ const FRAGMENTS_COMMON = {
     preview: 'object',
     live: 'object',
   },
+  tokens: {
+    '.': 'tokens',
+    '.param': {
+      name: 'id',
+      '.': 'token',
+    },
+  },
+  groups: {
+    '.': 'object',
+    '.param': {
+      '.': 'object',
+      members: 'object',
+    },
+  },
   public: 'object',
   robots: 'object',
 };
@@ -49,23 +63,9 @@ const FRAGMENTS = {
   sites: {
     ...FRAGMENTS_COMMON,
     extends: 'object',
-    groups: {
-      '.': 'object',
-      '.param': {
-        '.': 'object',
-        members: 'object',
-      },
-    },
   },
   profiles: FRAGMENTS_COMMON,
   org: {
-    tokens: {
-      '.': 'tokens',
-      '.param': {
-        name: 'id',
-        '.': 'token',
-      },
-    },
     users: {
       '.': 'users',
       '.param': {
@@ -195,8 +195,8 @@ export class ConfigStore {
     if (await storage.head(this.key)) {
       throw new StatusCodeError(409, 'config already exists.');
     }
-    if (this.type === 'org' && data.tokens) {
-      throw new StatusCodeError(400, 'creating org config with tokens not supported yet.');
+    if (data.tokens) {
+      throw new StatusCodeError(400, 'creating config with tokens not supported yet.');
     }
     if (this.type === 'org' && data.users) {
       throw new StatusCodeError(400, 'creating org config with users is not supported yet.');
@@ -264,7 +264,7 @@ export class ConfigStore {
     }
     if (frag) {
       if (!old) {
-        if (this.type === 'org' && frag.type === 'tokens') {
+        if (this.type === 'profiles' && frag.type === 'tokens') {
           old = {};
         } else {
           throw new StatusCodeError(404, 'config not found.');

package/types/org-config.d.ts

@@ -12,7 +12,7 @@
 
 // NOTE: this file is autogenerated via 'npm run docs:types'
 
-export type Users = HttpsNsAdobeComHelixConfigUser[];
+export type Users = User[];
 
 export interface HelixOrgConfig {
   version: 1;
@@ -24,22 +24,10 @@ export interface HelixOrgConfig {
    * description for clarity. has no influence on the configuration.
    */
   description?: string;
-  tokens?: Tokens;
   users?: Users;
   groups?: Groups;
 }
-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;
-  };
-}
-export interface HttpsNsAdobeComHelixConfigUser {
+export interface User {
   id: string;
   email: string;
   name?: string;

package/types/profile-config.d.ts

@@ -28,6 +28,8 @@ export interface HelixProfileConfig {
   headers?: HelixHeadersConfig;
   cdn?: CDNConfig;
   access?: Access;
+  tokens?: Tokens;
+  groups?: Groups;
   sidekick?: SidekickConfig;
   metadata?: Metadata;
   robots?: Robots;
@@ -102,7 +104,7 @@ export interface HelixHeadersConfig {
    * This interface was referenced by `HelixHeadersConfig`'s JSON-Schema definition
    * via the `patternProperty` "^/[a-zA-Z0-9-/.]*\*{0,2}$".
    */
-  [k: string]: [] | [KeyValuePair];
+  [k: string]: KeyValuePair[];
 }
 export interface KeyValuePair {
   key: string;
@@ -254,6 +256,33 @@ export interface SiteAccessConfig {
    */
   clientCertDN?: 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;
+  };
+}
+export interface Groups {
+  [k: string]: Group;
+}
+/**
+ * A group of members. Can be referenced in access.admin.role.
+ *
+ * This interface was referenced by `Groups`'s JSON-Schema definition
+ * via the `patternProperty` "^[a-zA-Z0-9-_=]+$".
+ */
+export interface Group {
+  members: {
+    email: string;
+    name?: string;
+    [k: string]: unknown;
+  }[];
+}
 export interface SidekickConfig {
   plugins?: SidekickPlugin[];
   [k: string]: unknown;

package/types/site-config.d.ts

@@ -32,6 +32,7 @@ export interface HelixSiteConfig {
   headers?: HelixHeadersConfig;
   cdn?: CDNConfig;
   access?: Access;
+  tokens?: Tokens;
   groups?: Groups;
   sidekick?: SidekickConfig;
   metadata?: Metadata;
@@ -110,7 +111,7 @@ export interface HelixHeadersConfig {
    * This interface was referenced by `HelixHeadersConfig`'s JSON-Schema definition
    * via the `patternProperty` "^/[a-zA-Z0-9-/.]*\*{0,2}$".
    */
-  [k: string]: [] | [KeyValuePair];
+  [k: string]: KeyValuePair[];
 }
 export interface KeyValuePair {
   key: string;
@@ -262,6 +263,17 @@ export interface SiteAccessConfig {
    */
   clientCertDN?: 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;
+  };
+}
 export interface Groups {
   [k: string]: Group;
 }