@adobe/helix-shared-config 1.7.21 → 2.0.0

package/src/Static.js

@@ -1,119 +0,0 @@
-/*
- * Copyright 2021 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.
- */
-
-const { Pair } = require('yaml/types');
-
-const EventEmitter = require('events');
-const { GitUrl } = require('@adobe/helix-shared-git');
-const pruneEmptyValues = require('@adobe/helix-shared-prune');
-
-/**
- * Static content handling
- */
-class Static extends EventEmitter {
-  constructor(cfg) {
-    super();
-    this.url = cfg;
-    this._magic = cfg.magic || false;
-    this._allow = cfg.allow || [];
-    this._deny = cfg.deny || [];
-  }
-
-  get url() {
-    return this._url;
-  }
-
-  set url(value) {
-    if (value.toJSON) {
-      this._url = new GitUrl(value.toJSON({ minimal: true, keepFormat: true }), { ref: 'master', path: '/htdocs' });
-    } else {
-      this._url = new GitUrl(value, { ref: 'master', path: '/htdocs' });
-    }
-    this.emit('url-change', value);
-  }
-
-  get magic() {
-    return this._magic;
-  }
-
-  get allow() {
-    return this._allow;
-  }
-
-  get deny() {
-    return this._deny;
-  }
-
-  get path() {
-    return this._url.path;
-  }
-
-  get owner() {
-    return this._url.owner;
-  }
-
-  get repo() {
-    return this._url.repo;
-  }
-
-  get ref() {
-    return this._url.ref;
-  }
-
-  /**
-   * JSON Serialization of Static
-   * @typedef Static~JSON
-   * @augments GitUrl~JSON
-   * @property {boolean} magic
-   * @property {String[]} allow
-   * @property {String[]} deny
-   */
-
-  /**
-   * Returns a json representation
-   * @returns {Static~JSON}
-   */
-  toJSON(opts) {
-    let json = {
-      magic: this.magic,
-      allow: this.allow,
-      deny: this.deny,
-    };
-    if (opts && (opts.minimal || opts.keepFormat)) {
-      json = pruneEmptyValues(json);
-    }
-    if (!json) {
-      return this.url.toJSON(opts);
-    }
-    const myOpts = { ...opts };
-    delete myOpts.keepFormat;
-    return Object.assign(json, this.url.toJSON(myOpts));
-  }
-
-  toYAMLNode() {
-    const props = pruneEmptyValues({
-      magic: this.magic,
-      allow: this.allow,
-      deny: this.deny,
-    });
-    if (!props) {
-      return this.url.toYAMLNode();
-    }
-    const node = this.url.toYAMLNode(true);
-    Object.keys(props).forEach((key) => {
-      node.items.push(new Pair(key, props[key]));
-    });
-    return node;
-  }
-}
-
-module.exports = Static;

package/src/Strain.js

@@ -1,332 +0,0 @@
-/*
- * Copyright 2021 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.
- */
-
-const URI = require('uri-js');
-const YAML = require('yaml');
-const { YAMLMap, Pair } = require('yaml/types');
-const { GitUrl } = require('@adobe/helix-shared-git');
-const pruneEmptyValues = require('@adobe/helix-shared-prune');
-const Origin = require('./Origin.js');
-const Static = require('./Static.js');
-const Performance = require('./Performance.js');
-const Redirect = require('./Redirect.js');
-const Condition = require('./Condition.js');
-
-/**
- * Strain
- */
-class Strain {
-  constructor(cfg) {
-    this._name = cfg.name;
-    if (cfg.origin) {
-      // proxy
-      this._origin = new Origin(cfg.origin);
-    } else {
-      this._origin = null;
-      this._content = new GitUrl(cfg.content, { ref: 'master' });
-      this._code = new GitUrl(cfg.code, { ref: 'master' });
-      // todo: 1. do we still need whilelists?
-      this._static = new Static(cfg.static);
-      // detect changes in static URL
-      this._static.on('url-change', () => {
-        this._modified('static', this._static);
-      });
-      this._directoryIndex = cfg.directoryIndex;
-      this._package = cfg.package || '';
-    }
-
-    // todo: schema for perf
-    this._perf = new Performance(cfg.perf);
-    this._condition = cfg.condition ? new Condition(cfg.condition) : null;
-
-    if (cfg.url) {
-      throw new Error('url property is no longer supported.');
-    }
-
-    this._sticky = cfg.sticky;
-
-    this._redirects = (Array.isArray(cfg.redirects) ? cfg.redirects : [])
-      .map((r) => new Redirect(r));
-
-    this._urls = new Set(Array.isArray(cfg.urls) ? cfg.urls.map(URI.normalize) : []);
-    this._params = Array.isArray(cfg.params) ? cfg.params : [];
-    this._versionLock = cfg['version-lock'];
-    this._yamlNode = null;
-    // define them initially, and clear for alias node
-    // todo: improve
-    this._ownProperties = new Set([
-      'name',
-      'origin',
-      'code',
-      'content',
-      'static',
-      'package',
-      'perf',
-      'condition',
-      'sticky',
-      'urls',
-      'params',
-      'redirects',
-      'version-lock',
-    ]);
-  }
-
-  clone() {
-    const strain = new Strain(this.toJSON({ keepFormat: true }));
-    if (this._directoryIndex) {
-      // this is a bit a hack...consider a better binding
-      // eslint-disable-next-line no-underscore-dangle
-      strain._ownProperties.add('directoryIndex');
-    }
-    // another neccessary hack
-    // eslint-disable-next-line no-underscore-dangle
-    strain._sticky = this._sticky;
-    return strain;
-  }
-
-  get urls() {
-    return Array.from(this._urls);
-  }
-
-  set urls(value) {
-    if (Array.isArray(value)) {
-      this._urls = new Set(value.map(URI.normalize));
-    } else {
-      this._urls = new Set([value].map(URI.normalize));
-    }
-  }
-
-  get sticky() {
-    // when `sticky` is not set
-    // assume the strain to be sticky when the condition is
-    return this._sticky === undefined && this._condition !== null
-      ? this._condition.sticky()
-      : !!this._sticky;
-  }
-
-  /**
-   * Name of this strain.
-   * @returns {String}
-   */
-  get name() {
-    return this._name;
-  }
-
-  set name(value) {
-    this._name = value;
-  }
-
-  /**
-   * GitUrl of the content repository
-   * @returns {GitUrl}
-   */
-  get content() {
-    return this._content;
-  }
-
-  set content(url) {
-    this._content = url;
-    this._modified('content', url);
-  }
-
-  /**
-   * GitUrl of the code repository
-   * @returns {GitUrl}
-   */
-  get code() {
-    return this._code;
-  }
-
-  set code(code) {
-    this._code = code;
-    this._modified('code', code);
-  }
-
-  /**
-   * Static information of this strain
-   * @returns {Static}
-   */
-  get static() {
-    return this._static;
-  }
-
-  get package() {
-    return this._package;
-  }
-
-  set package(value) {
-    this._package = value;
-    this._modified('package', value);
-  }
-
-  get params() {
-    return this._params;
-  }
-
-  get condition() {
-    return this._condition;
-  }
-
-  set condition(value) {
-    this._condition = value;
-  }
-
-  get directoryIndex() {
-    return this._directoryIndex || 'index.html';
-  }
-
-  set directoryIndex(value) {
-    this._directoryIndex = value;
-    this._modified('directoryIndex', value);
-  }
-
-  get perf() {
-    return this._perf;
-  }
-
-  get origin() {
-    return this._origin;
-  }
-
-  isProxy() {
-    return this._origin !== null;
-  }
-
-  get redirects() {
-    return this._redirects;
-  }
-
-  get versionLock() {
-    return this._versionLock;
-  }
-
-  /**
-   * JSON Serialization of a Strain
-   * @typedef Strain~JSON
-   * @property {String} name
-   * @property {String} code
-   * @property {GitUrl~JSON} content
-   * @property {Static~JSON} static
-   * @property {String} condition
-   * @property {String} directoryIndex
-   * @property {Performance~JSON} perf
-   * @property {Origin~JSON} origin
-   */
-
-  /**
-   * Returns a json representation
-   * @returns {Strain~JSON}
-   */
-  toJSON(opts) {
-    const json = {
-      name: this.name,
-      sticky: this.sticky,
-      condition: this.condition ? this.condition.toJSON(opts) : '',
-      perf: this.perf.toJSON(opts),
-      urls: this.urls,
-    };
-    if (this.params.length > 0) {
-      json.params = this.params;
-    }
-    if (this.redirects.length > 0) {
-      json.redirects = this.redirects.map((r) => r.toJSON());
-    }
-    if (this.isProxy()) {
-      return { origin: this.origin.toJSON(opts), ...json };
-    }
-    if (this.versionLock) {
-      json['version-lock'] = this.versionLock;
-    }
-    const ret = {
-      code: this.code.toJSON(opts),
-      content: this.content.toJSON(opts),
-      static: this.static.toJSON(opts),
-      directoryIndex: this.directoryIndex,
-      package: this.package,
-      ...json,
-    };
-    if (opts && opts.minimal) {
-      return pruneEmptyValues(ret);
-    }
-    return ret;
-  }
-
-  _modified(propertyName, propertyValue) {
-    if (propertyName && propertyValue) {
-      this._ownProperties.add(propertyName);
-    }
-
-    if (this._yamlNode) {
-      const node = this._yamlNode;
-      this._ownProperties.forEach((key) => {
-        const idx = node.items.findIndex((i) => i.key === key
-          || (i.key.value && i.key.value === key));
-        let value = key === 'version-lock' ? this.versionLock : this[key];
-        value = key === 'sticky' ? this._sticky : value;
-        if (value && value.toYAMLNode) {
-          value = value.toYAMLNode();
-        }
-        if (Array.isArray(value) && value.length === 0) {
-          value = null;
-        }
-        if (value || (value === false && key === 'sticky')) {
-          if (idx >= 0) {
-            const item = node.items[idx];
-            const oldValue = item.value.type === 'ALIAS' ? item.value.source : item.value;
-            if (oldValue.toString() !== value.toString()) {
-              item.value = value;
-            }
-          } else {
-            node.items.push(new Pair(key, value));
-          }
-        } else if (idx >= 0) {
-          node.items.splice(idx, 1);
-        }
-      });
-    }
-
-    if (propertyName && !propertyValue) {
-      this._ownProperties.clear(propertyName);
-    }
-  }
-
-  toYAML() {
-    return YAML.stringify(this.toYAMLNode());
-  }
-
-  static fromYAMLNode(node) {
-    /* eslint-disable no-underscore-dangle */
-    const json = node.toJSON();
-    const strain = new Strain(json);
-    strain._yamlNode = node;
-    strain._ownProperties.clear();
-    if (node.type === 'MAP') {
-      // remember our 'own' properties
-      node.items.forEach((pair) => {
-        strain._ownProperties.add(pair.key.value);
-      });
-      strain._ownProperties.delete('<<');
-    }
-    /* eslint-enable no-underscore-dangle */
-    return strain;
-  }
-
-  toYAMLNode() {
-    if (!this._yamlNode) {
-      this._yamlNode = new YAMLMap();
-      this._modified();
-    }
-    return this._yamlNode;
-  }
-}
-
-module.exports = Strain;

package/src/Strains.js

@@ -1,68 +0,0 @@
-/*
- * Copyright 2018 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.
- */
-const Strain = require('./Strain.js');
-
-/**
- * Strains
- */
-class Strains extends Map {
-  add(strain) {
-    this.set(strain.name, strain);
-    if (this._yamlNode) {
-      const node = strain.toYAMLNode();
-      node.spaceBefore = true;
-      this._yamlNode.items.push(node);
-    }
-  }
-
-  /**
-   * Returns a json representation
-   * @returns {Strains~JSON}
-   */
-  toJSON() {
-    const strains = [];
-    this.forEach((strain) => {
-      strains.push(strain.toJSON());
-    });
-    return strains;
-  }
-
-  filterByCode(code) {
-    return this.getByFilter((strain) => code.equalsIgnoreTransport(strain.code));
-  }
-
-  getByFilter(filterfn) {
-    return [...this.values()].filter(filterfn);
-  }
-
-  getRuntimeStrains() {
-    return this.getByFilter((strain) => !strain.isProxy());
-  }
-
-  getProxyStrains() {
-    return this.getByFilter((strain) => strain.isProxy());
-  }
-
-  /**
-   * Creates the strains from a yaml node
-   * @param {YAMLSeq} node
-   */
-  fromYAML(node) {
-    this._yamlNode = node;
-    node.items.forEach((value) => {
-      const strain = Strain.fromYAMLNode(value);
-      this.set(strain.name, strain);
-    });
-  }
-}
-
-module.exports = Strains;

package/src/schemas/conditions.schema.json

@@ -1,140 +0,0 @@
-{
-  "meta:license": [
-    "Copyright 2018 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."
-  ],
-  "$id": "https://ns.adobe.com/helix/shared/conditions",
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "Conditions",
-  "type": "object",
-  "meta:status": "stabilizing",
-  "description": "A condition expression",
-  "additionalProperties": false,
-  "minProperties": 1,
-  "maxProperties": 1,
-  "properties": {
-    "and": {
-      "type": "array",
-      "items": { "$ref": "https://ns.adobe.com/helix/shared/conditions" },
-      "description": "All conditions in this list must be met"
-    },
-    "or": {
-      "type": "array",
-      "items": { "$ref": "https://ns.adobe.com/helix/shared/conditions" },
-      "description": "Any conditions in this list must be met"
-    },
-    "not": {
-      "$ref": "https://ns.adobe.com/helix/shared/conditions"
-    }
-  },
-  "patternProperties": {
-    "^url[=~]?$": {
-      "type": "string",
-      "description": "Matches the full URL, including request parameters"
-    },
-    "^url\\.hostname[=~]?$": {
-      "type": "string",
-      "description": "Matches the hostname only"
-    },
-    "^url\\.path[=~]?$": {
-      "type": "string",
-      "description": "Matches the path only. Path does not include the query string."
-    },
-    "^referer[=~]?$": {
-      "type": "string",
-      "description": "Matches the Referrer (note the spelling)"
-    },
-    "^client_name[=~]?$": {
-      "type": "string",
-      "description": "Matches the client's company or ISP name"
-    },
-    "^client_city[=~]?$": {
-      "type": "string",
-      "description": "Matches the client's city"
-    },
-    "^client_country_code[=~]?$": {
-      "type": "string",
-      "description": "Matches the ISO 3166-1 country code (two letters)"
-    },
-    "^user_agent[=~]?$": {
-      "type": "string",
-      "description": "Matches the User Agent"
-    },
-    "^accept_language[=~]?$": {
-      "type": "string",
-      "description": "Matches the Accept-Language header"
-    },
-    "^client_lat[<=>]?$": {
-      "type": "number",
-      "description": "Compares the latitude"
-    },
-    "^client_lon[<=>]?$": {
-      "type": "number",
-      "description": "Compares the longitude"
-    },
-    "^client_gmt_offset[<=>]?$": {
-      "type": "number",
-      "description": "UTC offset for the client's time zone. Values look like -100 or 300."
-    },
-    "^time[<=>]?$": {
-      "type": "string",
-      "format": "date-time",
-      "description": "Absolute time of the request, evaluated against UTC"
-    },
-    "^time_day[<=>]?$": {
-      "type": "number",
-      "description": "Day of the week, same as Date.getDay() – adjusted for GMT offset"
-    },
-    "^time_date[<=>]?$": {
-      "type": "number",
-      "description": "Day of the month, same as Date.getDate() – adjusted for GMT offset"
-    },
-    "^time_hours[<=>]?$": {
-      "type": "number",
-      "description": "Hour of the day, same as Date.getHours() – adjusted for GMT offset"
-    },
-    "^time_minutes[<=>]?$": {
-      "type": "number",
-      "description": "Minute of the hour, same as Date.getMinutes() – adjusted for GMT offset"
-    },
-    "^time_month[<=>]?$": {
-      "type": "number",
-      "description": "Month of the year, same as Date.getMonth() – adjusted for GMT offset"
-    },
-    "^time_year[<=>]?$": {
-      "type": "number",
-      "description": "Year, same as Date.getFullYear() – adjusted for GMT offset"
-    },
-    "^url_param\\..+[~]?$": {
-      "type": "string",
-      "description": "Matches a URL parameter's value as a string"
-    },
-    "^url_param\\..+[<>]$": {
-      "type": "number",
-      "description": "Matches a URL parameter's value as a number"
-    },
-    "^url_param\\..+[=]$": {
-      "type": ["number", "string"],
-      "description": "Matches a URL parameter's value as a number or string"
-    },
-    "^preflight\\..+[~]?$": {
-      "type": "string",
-      "description": "Matches a preflight response header value as a string"
-    },
-    "^preflight\\..+[<>]$": {
-      "type": "number",
-      "description": "Matches a preflight response header value as a number"
-    },
-    "^preflight\\..+[=]$": {
-      "type": ["number", "string"],
-      "description": "Matches a preflight response header value as a number or string"
-    }
-  }
-}

package/src/schemas/config.description.md

@@ -1,7 +0,0 @@
-The Strains configuration for a Project Helix website.
-
-The `helix-config.yaml` file contains the list of Strains that have been configured for a Helix site. 
-
-Each strain represents a variant of the site. It is required to have a default strain for each website. A strain is either a [Runtime strain](runtimestrain.md), if it's powered by the Helix pipeline on Adobe I/O Runtime, or a [Proxy strain](proxystrain.md), if it's serving content from another host.
-
-All strains can have [Conditions](conditions.md) that determine if a visitor is eligible to see a certain strain. If a request fulfills the conditions of multiple strains, the first eligible strain will be served. This is why order of the strains in `helix-config.yaml` is important.

package/src/schemas/config.example.1.json

@@ -1,26 +0,0 @@
-{
-  "strains": [
-    {
-      "name": "preview",
-      "owner": "adobe",
-      "repo": "project-helix.io",
-      "ref": "preview",
-      "condition": {
-        "url": "https://preview.project.helix.io/"
-      }
-    },
-    {
-      "name": "legacy",
-      "origin": "https://www.adobe.io/helix",
-      "condition": {
-        "url": "https://www.project.helix.io/"
-      }
-    },
-    {
-      "name": "default",
-      "owner": "adobe",
-      "repo": "project-helix.io",
-      "ref": "master"
-    }
-  ]
-}