@adobe/helix-shared-config 8.2.0 → 8.3.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/helix-shared-config-v8.3.0](https://github.com/adobe/helix-shared/compare/@adobe/helix-shared-config-v8.2.0...@adobe/helix-shared-config-v8.3.0) (2022-08-12)
+
+
+### Features
+
+* add modifiers config ([0016e95](https://github.com/adobe/helix-shared/commit/0016e9519293c66953baa39d238147b2adf09ad5))
+
 # [@adobe/helix-shared-config-v8.2.0](https://github.com/adobe/helix-shared/compare/@adobe/helix-shared-config-v8.1.0...@adobe/helix-shared-config-v8.2.0) (2022-06-18)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-shared-config",
-  "version": "8.2.0",
+  "version": "8.3.0",
   "description": "Shared modules of the Helix Project - config",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -37,7 +37,7 @@
     "cookie": "0.5.0",
     "fs-extra": "10.1.0",
     "ignore": "5.2.0",
-    "lru-cache": "7.10.1",
+    "lru-cache": "7.10.2",
     "object-hash": "3.0.0",
     "uri-js": "4.4.1",
     "yaml": "2.1.1"
@@ -48,6 +48,6 @@
     "@pollyjs/adapter-node-http": "6.0.5",
     "@pollyjs/core": "6.0.5",
     "@pollyjs/persister-fs": "6.0.5",
-    "nock": "13.2.6"
+    "nock": "13.2.9"
   }
 }

package/src/ModifiersConfig.d.ts

@@ -0,0 +1,123 @@
+/*
+ * Copyright 2022 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.
+ */
+
+/**
+ * Structure that groups name value pairs by url, used as modifier sheet, for example
+ * in metadata.json or headers.json
+ *
+ * @example
+ *
+ * | url   | key | value | Title   | Description    |
+ * |-------|-----|-------|---------|----------------|
+ * | "/*"  | "A" | "B"   | ""      | ""             |
+ * | "/*"  | "C" | "D"   | ""      | ""             |
+ * | "/f"  | ""  | ""    | "Hero"  | "Once upon..." |
+ *
+ * becomes:
+ *
+ * {
+ *   "/*": [
+ *     { "key": "A", "value": "B" },
+ *     { "key": "C", "value": "D" },
+ *   ],
+ *   "/f": [
+ *     { "key": "title", "value": "Hero" },
+ *     { "key": "description", "value": "Once upon..." },
+ *   ]
+ * }
+ */
+export declare interface ModifierMap {
+  [ModifierUrl:string]: Modifier[];
+}
+
+export declare interface Modifier {
+  key: string;
+  value: string;
+}
+
+export type ModifierKeyFilter = (key:string) => boolean;
+
+/**
+ * The modifiers class help manage the metadata and headers modifiers.
+ */
+export declare class ModifiersConfig {
+  /**
+   * Converts all non-valid characters to `-`.
+   * @param {string} text input text
+   * @returns {string} the meta name
+   */
+  static toMetaName(text: string): string;
+
+  /**
+   * Converts a globbing expression to regexp. Note that only `*` and `**` are supported yet.
+   * @param {string} glob
+   * @returns {RegExp}
+   */
+  static globToRegExp(glob:string): RegExp;
+
+  /**
+   * Empty modifiers
+   */
+  static EMPTY: ModifiersConfig;
+
+  /**
+   * Parses a sheet that is in a modifier format into a list of key/value pairs
+   *
+   * @example
+   *
+   * | url   | key | value | Title   | Description    |
+   * |-------|-----|-------|---------|----------------|
+   * | "/*"  | "A" | "B"   | ""      | ""             |
+   * | "/*"  | "C" | "D"   | ""      | ""             |
+   * | "/f"  | ""  | ""    | "Hero"  | "Once upon..." |
+   *
+   * becomes:
+   *
+   * {
+   *   "/*": [
+   *     { "key": "A", "value": "B" },
+   *     { "key": "C", "value": "D" },
+   *   ],
+   *   "/f": [
+   *     { "key": "title", "value": "Hero" },
+   *     { "key": "description", "value": "Once upon..." },
+   *   ]
+   * }
+   *
+   *
+   * @param {object[]} sheet The sheet to parse
+   * @param {ModifierKeyFilter} keyFilter filter to apply on keys
+   * @returns {ModifierMap} An object containing an array of key/value pairs for every glob
+   */
+  static parseModifierSheet(sheet:object[], keyFilter: ModifierKeyFilter): ModifierMap;
+
+  /**
+   * Creates a ModifierConfig from the given data
+   * @param sheet
+   * @param keyFilter
+   */
+  static fromModifierSheet(sheet:object[], keyFilter: ModifierKeyFilter): ModifiersConfig;
+
+  /**
+   * Creates a new ModifiersConfig
+   * @param {ModifierMap} config
+   * @param {ModifierKeyFilter} keyFilter filter to apply on modifier keys
+   */
+  constructor(config:ModifierMap, keyFilter: ModifierKeyFilter);
+
+  /**
+   * Returns the modifier object for the given path, respecting the glob patterns in the urls.
+   * @param {string} path
+   * @return {object} the modifiers
+   */
+  getModifiers(path: string): object;
+}

package/src/ModifiersConfig.js

@@ -0,0 +1,177 @@
+/*
+ * Copyright 2022 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.
+ */
+
+/**
+ * Converts all non-valid characters to `-`.
+ * @param {string} text input text
+ * @returns {string} the meta name
+ */
+function toMetaName(text) {
+  return text
+    .toLowerCase()
+    .replace(/[^0-9a-z:_]/gi, '-');
+}
+
+/**
+ * The modifiers class help manage the metadata and headers modifiers.
+ */
+class ModifiersConfig {
+  /**
+   * Converts a globbing expression to regexp. Note that only `*` and `**` are supported yet.
+   * @param {string} glob
+   * @returns {RegExp}
+   */
+  static globToRegExp(glob) {
+    const reString = glob
+      .replaceAll('**', '|')
+      .replaceAll('*', '[0-9a-z-.]*')
+      .replaceAll('|', '.*');
+    return new RegExp(`^${reString}$`);
+  }
+
+  /**
+   * Converts all keys in a row object to lowercase
+   * @param {Object} obj A row of data from a sheet
+   * @returns {Object} A row with all keys converted to lowercase
+   */
+  static toLowerKeys(obj) {
+    return Object.keys(obj).reduce((prev, key) => {
+      // eslint-disable-next-line no-param-reassign
+      prev[key.toLowerCase()] = obj[key];
+      return prev;
+    }, {});
+  }
+
+  /**
+   * Empty modifiers
+   * @type {ModifiersConfig}
+   */
+  static EMPTY = new ModifiersConfig({});
+
+  /**
+   * Parses a sheet that is in a modifier format into a list of key/value pairs
+   *
+   * @example
+   *
+   * | url   | key | value | Title   | Description    |
+   * |-------|-----|-------|---------|----------------|
+   * | "/*"  | "A" | "B"   | ""      | ""             |
+   * | "/*"  | "C" | "D"   | ""      | ""             |
+   * | "/f"  | ""  | ""    | "Hero"  | "Once upon..." |
+   *
+   * becomes:
+   *
+   * {
+   *   "/*": [
+   *     { "key": "A", "value": "B" },
+   *     { "key": "C", "value": "D" },
+   *   ],
+   *   "/f": [
+   *     { "key": "title", "value": "Hero" },
+   *     { "key": "description", "value": "Once upon..." },
+   *   ]
+   * }
+   *
+   *
+   * @param {object[]} sheet The sheet to parse
+   * @param {ModifierKeyFilter} keyFilter filter to apply on keys
+   * @returns {ModifierMap} An object containing an array of key/value pairs for every glob
+   */
+  static parseModifierSheet(sheet, keyFilter = () => true) {
+    /** @type ModifierMap */
+    const res = {};
+    for (let row of sheet) {
+      row = ModifiersConfig.toLowerKeys(row);
+      const {
+        url, key, value, ...rest
+      } = row;
+      if (url) {
+        const put = (k, v) => {
+          if (keyFilter(k)) {
+            let entry = res[url];
+            if (!entry) {
+              entry = [];
+              res[url] = entry;
+            }
+            entry.push({ key: k, value: v });
+          }
+        };
+
+        // note that all values are strings, i.e. never another falsy value
+        if ('key' in row && 'value' in row && key && value) {
+          put(key, value);
+        } else {
+          Object.entries(rest).forEach(([k, v]) => {
+            if (k && v) {
+              put(k, v);
+            }
+          });
+        }
+      }
+    }
+    return res;
+  }
+
+  /**
+   * Creates a new `ModifiersConfig` from the given sheet.
+   *
+   * @see ModifiersConfig.parseModifierSheet
+   * @param {object[]} sheet The sheet to parse
+   * @param {ModifierKeyFilter} keyFilter filter to apply on keys
+   * @returns {ModifiersConfig} A ModifiersConfig instance.
+   */
+  static fromModifierSheet(sheet, keyFilter) {
+    return new ModifiersConfig(ModifiersConfig.parseModifierSheet(sheet, keyFilter));
+  }
+
+  /**
+   * Creates a new ModifiersConfig class.
+   * @param {ModifierMap} [map] The modifier map.
+   * @param {ModifierKeyFilter} keyFilter filter to apply on modifier keys
+   */
+  constructor(map, keyFilter = () => true) {
+    if (!map) {
+      return;
+    }
+    this.modifiers = Object.entries(map).map(([url, mods]) => {
+      const pat = url.indexOf('*') >= 0 ? ModifiersConfig.globToRegExp(url) : url;
+      return {
+        pat,
+        mods: mods.filter(({ key }) => keyFilter(key)),
+      };
+    });
+  }
+
+  /**
+   * Returns the modifier object for the given path.
+   * @param {string} path
+   * @return {object} the modifiers
+   */
+  getModifiers(path) {
+    if (!this.modifiers) {
+      return {};
+    }
+    const modifiers = {};
+    for (const { pat, mods } of this.modifiers) {
+      if (pat === path || (pat instanceof RegExp && pat.test(path))) {
+        for (const { key, value } of mods) {
+          modifiers[toMetaName(key)] = value;
+        }
+      }
+    }
+    return modifiers;
+  }
+}
+
+module.exports = {
+  ModifiersConfig,
+};

package/src/index.d.ts

@@ -10,3 +10,4 @@
  * governing permissions and limitations under the License.
  */
 export * from './config-wrapper';
+export * from './ModifiersConfig';

package/src/index.js

@@ -15,6 +15,7 @@ const { optionalConfig, requiredConfig } = require('./config-wrapper');
 const ValidationError = require('./ValidationError.js');
 const IgnoreConfig = require('./IgnoreConfig.js');
 const SitemapConfig = require('./SitemapConfig.js');
+const { ModifiersConfig } = require('./ModifiersConfig.js');
 
 module.exports = {
   IndexConfig,
@@ -24,4 +25,5 @@ module.exports = {
   optionalConfig,
   requiredConfig,
   ValidationError,
+  ModifiersConfig,
 };