@adobe/helix-shared-config 1.7.23 → 2.0.2

package/src/schemas/markupmapping.schema.json

@@ -1,122 +0,0 @@
-{
-  "meta:license": [
-    "Copyright 2019 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/markupmapping",
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "Markup Mapping",
-  "type": "object",
-  "meta:status": "stabilizing",
-  "description": "",
-  "required": [
-    "match"
-  ],
-  "additionalProperties": false,
-  "properties": {
-    "name": {
-      "type": "string",
-      "description": "The (optional) name of the mapping. The name is normative only, and can be used for debugging purposes. It does not affect either matching nor the markup output."
-    },
-    "match": {
-      "type": "string",
-      "anyOf": [
-        {
-          "type": "string",
-          "title": "DOM Match Expression",
-          "description": "A CSS selector expression selecting the DOM nodes that should get processed",
-          "examples": [
-            "p",
-            "p>img",
-            "h1+p"
-          ]
-        },
-        {
-          "type": "string",
-          "title": "MDAST Match Expression",
-          "description": "A CSS selector expression selecting the Markdown nodes that should get processed",
-          "examples": [
-            "paragraph",
-            "paragraph>image",
-            "heading+paragraph"
-          ]
-        },
-        {
-          "type": "string",
-          "title": "URL Pattern Match Expression",
-          "description": "An [Express-like](https://expressjs.com/en/guide/routing.html) path expression for selecting URL patterns that will apply the changes to the `body` element.",
-          "examples": [
-            "/about",
-            "/authors/:name",
-            "/posts/(\\d\\d\\d\\d)/(\\d\\d)/:title"
-          ]
-        },
-        {
-          "type": "string",
-          "title": "Content Intelligence Match Expression",
-          "description": "Use a [Content Intelligence](https://github.com/adobe/helix-pipeline/blob/master/README.md#infer-content-types-with-utilstypes) expression for selecting sections in MDAST that have the specified order of children.",
-          "examples": [
-            "^heading",
-            "paragraph$",
-            "heading image+",
-            "heading? image",
-            "heading paragraph* image",
-            "(paragraph|list)",
-            "^heading (image paragraph)+$"
-          ]
-        }
-      ]
-    },
-    "type": {
-      "type": "string",
-      "enum": ["html", "markdown", "url", "content"],
-      "default": "html",
-      "meta:enum": {
-        "html": "Match against the generated DOM tree",
-        "markdown": "Match against the source MDAST tree",
-        "url": "Match against the request URL",
-        "content": "Use content intelligence matching for sections"
-      }
-    },
-    "wrap": {
-      "type": "string",
-      "description": "Add the following HTML tags around the generated HTML. This attribute is using [Emmet](https://emmet.io) notation.",
-      "examples": [
-        "div>ul>li",
-        "div+p+bq",
-        "div+div>p>span+em"
-      ]
-    },
-    "replace": {
-      "type": "string",
-      "description": "Add the following HTML tags instead of the generated HTML. This attribute is using [Emmet](https://emmet.io) notation.",
-      "examples": [
-        "div>ul>li",
-        "div+p+bq",
-        "div+div>p>span+em"
-      ]
-    },
-    "classnames": {
-      "type": "array",
-      "description": "Add the following class names to the `class` attribute of the generated HTML",
-      "items": {
-        "type": "string"
-      }
-    },
-    "attribute": {
-      "type": "object",
-      "description": "create new attributes for each key value pair below this property",
-      "additionalProperties": {
-        "type": "string",
-        "description": "The property value"
-      }
-    }
-  }
-}

package/src/schemas/origin.description.md

@@ -1,5 +0,0 @@
-Representation of a origin host for a proxy strain.
-
-As proxy strains deliver content from another web server, the `origin` property can be used to specify the source of this third-party content to be served. In the simplest case, the `origin` property can be a simple URL, but for advanced configuration, all the properties in this schema are available.
-
-The properties in this schema are largely identical with the properties defined in the [Fastly Backend API](https://docs.fastly.com/api/config#backend).

package/src/schemas/origin.schema.json

@@ -1,86 +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/origin",
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "Origin",
-  "type": "object",
-  "meta:status": "stabilizing",
-  "description": "Representation of a origin host for a proxy strain.",
-  "additionalProperties": false,
-  "properties": {
-    "hostname": {
-      "type": "string",
-      "format": "hostname",
-      "description": "The hostname of the backend."
-    },
-    "port": {
-      "type": "integer",
-      "description": "The port number."
-    },
-    "error_threshold": {
-      "type": "integer",
-      "description": ""
-    },
-    "first_byte_timeout": {
-      "type": "integer",
-      "description": "How long to wait for the first bytes in milliseconds."
-    },
-    "weight": {
-      "type": "integer",
-      "description": "Weight used to load balance this backend against others."
-    },
-    "address": {
-      "type": "string",
-      "format": "hostname",
-      "description": "An hostname, IPv4, or IPv6 address for the backend."
-    },
-    "connect_timeout": {
-      "type": "string",
-      "description": "How long to wait for a timeout in milliseconds."
-    },
-    "name": {
-      "type": "string",
-      "description": "The name of the backend."
-    },
-    "between_bytes_timeout": {
-      "type": "integer",
-      "description": "How long to wait between bytes in milliseconds."
-    },
-    "shield": {
-      "type": "string",
-      "description": "The shield POP designated to reduce inbound load on this origin by serving the cached data to the rest of the network."
-    },
-    "ssl_cert_hostname": {
-      "type": "string",
-      "format": "hostname",
-      "description": "Overrides ssl_hostname, but only for cert verification. Does not affect SNI at all."
-    },
-    "max_conn": {
-      "type": "integer",
-      "description": "Maximum number of connections."
-    },
-    "use_ssl": {
-      "type": "boolean",
-      "description": "Whether or not to use SSL to reach the backend."
-    },
-    "path": {
-      "type": "string",
-      "description": "The base path to make requests again. For example, if your `origin` is `http://www.example.com/foo` and a request is made to your site using the URL `/bar`, a backend request to `http://www.example.com/foo/bar` will be made."
-    },
-    "override_host": {
-      "type": "string",
-      "format": "hostname",
-      "description": "The hostname to override the [Host header](https://docs.fastly.com/guides/basic-configuration/specifying-an-override-host).\nBy default, proxy strains use the `Host` header that was used to make the request to Helix's CDN, which is ideal for migration use cases where the existing backend expects to serve traffic to a hostname that has now been taken over by Helix. In cases where Helix is aggregating content from multiple hosts, and the backend won't serve any content to the domain name Helix is using, set the `override_host` property to an accepted `Host` header value."
-    }
-  }
-}

package/src/schemas/performance.schema.json

@@ -1,210 +0,0 @@
-{
-  "meta:license": [
-    "Copyright 2019 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/performance",
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "Performance",
-  "type": "object",
-  "meta:status": "stabilizing",
-  "description": "Performance testing details.",
-  "additionalProperties": false,
-  "properties": {
-    "device": {
-      "description": "Testing device",
-      "enum": [
-        "",
-        "MotorolaMotoG4",
-        "iPhone5",
-        "iPhone6",
-        "iPhone6Plus",
-        "iPhone7",
-        "iPhone8",
-        "Nexus5X",
-        "Nexus6P",
-        "GalaxyS5",
-        "iPad",
-        "iPadPro"
-      ]
-    },
-    "location": {
-      "description": "Testing location",
-      "enum": [
-        "",
-        "NorthVirginia",
-        "Frankfurt",
-        "Sydney",
-        "Ohio",
-        "California",
-        "Oregon",
-        "Canada",
-        "Ireland",
-        "Tokyo",
-        "Seoul",
-        "Singapore",
-        "Mumbai",
-        "SaoPaulo",
-        "London"
-      ]
-    },
-    "connection": {
-      "description": "Testing connection",
-      "enum": [
-        "",
-        "regular2G",
-        "good2G",
-        "slow3G",
-        "regular3G",
-        "good3G",
-        "emergingMarkets",
-        "regular4G",
-        "LTE",
-        "dsl",
-        "wifi",
-        "cable"
-      ]
-    },
-    "lighthouse-seo-score": {
-      "type": "number",
-      "description": "Lighthouse SEO Score"
-    },
-
-    "lighthouse-best-practices-score": {
-      "type": "number",
-      "description": "Lighthouse Best Practices Score"
-    },
-
-    "lighthouse-accessibility-score": {
-      "type": "number",
-      "description": "Lighthouse Accessibility Score"
-    },
-
-    "lighthouse-performance-score": {
-      "type": "number",
-      "description": "Lighthouse Performance Score"
-    },
-
-    "lighthouse-pwa-score": {
-      "type": "number",
-      "description": "Lighthouse Progressive Web App Score"
-    },
-
-    "js-parse-compile": {
-      "type": "number",
-      "description": "JS Parse & Compile"
-    },
-    "dom-size": { "type": "number", "description": "DOM Element Count" },
-    "visually_complete_85": {
-      "type": "number",
-      "description": "85% Visually Complete"
-    },
-
-    "visually_complete": {
-      "type": "number",
-      "description": "Visually Complete"
-    },
-
-    "consistently-interactive": {
-      "type": "number",
-      "description": "Time to Interactive"
-    },
-
-    "first-interactive": { "type": "number", "description": "First CPU Idle" },
-
-    "time-to-first-byte": {
-      "type": "number",
-      "description": "Time to First Byte"
-    },
-
-    "estimated-input-latency": {
-      "type": "number",
-      "description": "Estimated input latency"
-    },
-    "speed_index": { "type": "number", "description": "Speed Index" },
-    "first-meaningful-paint": {
-      "type": "number",
-      "description": "First Meaningful Paint"
-    },
-
-    "first-contentful-paint": {
-      "type": "number",
-      "description": "First Contentful Paint"
-    },
-    "firstRender": { "type": "number", "description": "First Paint" },
-    "image_body_size_in_bytes": {
-      "type": "number",
-      "description": "Total Image size in bytes"
-    },
-
-    "image_size_in_bytes": {
-      "type": "number",
-      "description": "Total Image transferred"
-    },
-
-    "font_body_size_in_bytes": {
-      "type": "number",
-      "description": "Total Webfont size in bytes"
-    },
-
-    "font_size_in_bytes": {
-      "type": "number",
-      "description": "Total Webfont transferred"
-    },
-
-    "js_body_size_in_bytes": {
-      "type": "number",
-      "description": "Total JavaScript size in bytes"
-    },
-
-    "js_size_in_bytes": {
-      "type": "number",
-      "description": "Total JavaScript Transferred"
-    },
-
-    "css_body_size_in_bytes": {
-      "type": "number",
-      "description": "Total CSS size in bytes"
-    },
-
-    "css_size_in_bytes": {
-      "type": "number",
-      "description": "Total CSS transferred"
-    },
-
-    "html_body_size_in_bytes": {
-      "type": "number",
-      "description": "Total HTML size in bytes"
-    },
-
-    "html_size_in_bytes": {
-      "type": "number",
-      "description": "Total HTML transferred"
-    },
-
-    "page_wait_timing": { "type": "number", "description": "Response time" },
-
-    "page_size_in_bytes": {
-      "type": "number",
-      "description": "Total Page transferred"
-    },
-
-    "page_body_size_in_bytes": {
-      "type": "number",
-      "description": "Total Page size in bytes"
-    },
-
-    "asset_count": { "type": "number", "description": "Number of requests" },
-
-    "onload": { "type": "number", "description": "onLoad" },
-
-    "oncontentload": { "type": "number", "description": "onContentLoad" }
-  }
-}

package/src/schemas/proxystrain.description.md

@@ -1,20 +0,0 @@
-A proxy strain is a strain that serves content from another web server, acting as a pure proxy.
-
-## How are Proxy Strains configured?
-
-Add an `origin` property to your strain object in the `helix-config.yaml`. The `origin` property can be either the base URL of the web server that you want to serve content from
-or a more complex configuration object, described in the [Origin schema](origin.schema.md).
-
-Most of the other properties that can be used to describe other strains (i.e. [Runtime strains](runtimestrain.schema.md)) do not work for Proxy strains and are not just irrelevant, but also forbidden.
-
-## What are useful scenarios for Proxy Strains?
-
-You can use Proxy Strains in a number of scenarios:
-
-- in order to integrate non-Helix web applications that should run on the same hostname
-- in order to serve legacy content from an old website as a fallback
-- in order to enable a gradual migration of an existing site to Helix
-
-A good pattern for migrating to Project Helix is to define one proxy strain as the `default` that serves the old site from the current backend.
-
-Over time, add more and more runtime strains that are powered by Helix and adjust the `url` and `conditions` so that they receive more traffic.

package/src/schemas/proxystrain.schema.json

@@ -1,87 +0,0 @@
-{
-  "meta:license": [
-    "Copyright 2019 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/proxystrain",
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "Proxy Strain",
-  "type": "object",
-  "meta:status": "stabilizing",
-  "description": "A strain is a combination of code and content that enables the creation of a digital experience. Strains can be used to create language variants of websites, A/B tests, personalization, or to aggregate content from multiple sources",
-  "additionalProperties": false,
-  "properties": {
-    "name": {
-      "type": "string",
-      "description": "Name of the strain"
-    },
-    "origin": {
-      "description": "Origin backend for proxy strains.",
-      "anyOf": [
-        {
-          "type": "string",
-          "format": "uri"
-        },
-        {"$ref": "https://ns.adobe.com/helix/shared/origin"}
-      ]
-    },
-    "sticky": {
-      "description": "Sticky strains are not re-evaluated on every request. As soon as a visitor is determined to match a sticky strain, a session cookie will be set to keep the user in the strain.",
-      "type": "boolean"
-    },
-    "url": {
-      "description": "URL condition.\n\n**Warning**: this property has been deprecated in favour of adding the `url` to the `condition` property.",
-      "type": "string",
-      "format": "uri",
-      "meta:status": "deprecated"
-    },
-    "urls": {
-      "description": "List of known URLs for testing this strain",
-      "type": "array",
-      "items": {
-        "type": "string",
-        "format": "uri"
-      }
-    },
-    "condition": {
-      "description": "VLC condition that controls that can optionally activate this strain.",
-      "oneOf": [
-        {
-          "type": "string"
-        },
-        {"$ref": "https://ns.adobe.com/helix/shared/conditions"}
-      ]
-    },
-    "perf": {
-      "$ref": "https://ns.adobe.com/helix/shared/performance"
-    },
-    "version-lock": {
-      "$ref": "https://ns.adobe.com/helix/shared/version-lock"
-    },
-    "params": {
-      "description": "A list (using globbing language) of accepted URL parameters. Note: every parameter is a potential cache killer.",
-      "type": "array",
-      "items": {
-        "type": "string"
-      }
-    },
-    "redirects": {
-      "type": "array",
-      "description": "The redirect rules that should be applied to this strain",
-      "items": {
-        "$ref": "https://ns.adobe.com/helix/shared/redirectrule"
-      }
-    }
-  },
-  "required": [
-    "origin",
-    "name"
-  ]
-}

package/src/schemas/redirect.schema.json

@@ -1,34 +0,0 @@
-{
-  "meta:license": [
-    "Copyright 2020 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/redirect",
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "Redirect",
-  "description": "A redirect specification take take the form of either a URL of a spreadsheet with rewrite rules or a rewrite rule as `from`, `to` pairs.",
-  "anyOf": [
-    {
-      "type": "string",
-      "format": "uri",
-      "title": "Rewrites Excel Spreadsheet",
-      "description": "A link to an Excel spreadsheet hosted on Sharepoint, shared with `helix@adobe.com` that has at least two columns. The first column, titled ‟from” contains the rewrite source path, the second column, titled ‟to” specifies the rewrite target path."
-    },
-    {
-      "type": "string",
-      "format": "uri",
-      "title": "Rewrites Google Spreadsheet",
-      "description": "A link to a Google spreadsheet, shared with `helix@adobe.com` that has at least two columns. The first column, titled ‟from” contains the rewrite source path, the second column, titled ‟to” specifies the rewrite target path."
-    },
-    {
-      "$ref": "https://ns.adobe.com/helix/shared/redirectrule"
-    }
-  ]
-}

package/src/schemas/redirectrule.schema.json

@@ -1,46 +0,0 @@
-{
-  "meta:license": [
-    "Copyright 2019 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/redirectrule",
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "Redirect Rule",
-  "type": "object",
-  "meta:status": "stabilizing",
-  "description": "A strain is a combination of code and content that enables the creation of a digital experience. Strains can be used to create language variants of websites, A/B tests, personalization, or to aggregate content from multiple sources",
-  "additionalProperties": false,
-  "properties": {
-    "from": {
-      "type": "string",
-      "description": "A URL path or regular expression to match the path of a URL. It can contain capture groups that can be used in `to`.",
-      "examples": [
-        "/old",
-        "/old/(.*)\\.php$"
-      ]
-    },
-    "to": {
-      "type": "string",
-      "description": "A replacement string that replaces matched URLs found in `from`.",
-      "examples": [
-        "/new",
-        "/new/$1.html"
-      ]
-    },
-    "type": {
-      "enum": [
-        "permanent",
-        "temporary",
-        "internal"
-      ],
-      "description": "What kind of redirect is this?"
-    }
-  }
-}

package/src/schemas/redirects.description.md

@@ -1 +0,0 @@
-This configuration file enables the creation of programmatic redirects, rewrites, and vanity URLs.

package/src/schemas/redirects.schema.json

@@ -1,41 +0,0 @@
-{
-  "meta:license": [
-    "Copyright 2020 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/redirects",
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "Redirects Configuration",
-  "type": "object",
-  "properties": {
-    "version": {
-      "type":["string", "number"],
-      "enum": ["1", 1],
-      "default": 1,
-      "description": "The redirect-config file format version"
-    },
-    "redirects": {
-      "type": "array",
-      "default": [],
-      "items": {
-        "$ref": "https://ns.adobe.com/helix/shared/redirect"
-      }
-    },
-    "vanity": {
-      "type": "object",
-      "title": "Vanity URL extractor",
-      "description": "Configure one or multiple vanity URL extractors, each extractor is a property of this object",
-      "default": {},
-      "additionalProperties": {
-        "$ref": "https://ns.adobe.com/helix/shared/vanity"
-      }
-    }
-  }
-}