@adobe/helix-shared-config 1.7.21 → 2.0.0

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"
-      }
-    }
-  }
-}

package/src/schemas/row.schema.json

@@ -1,23 +0,0 @@
-{
-  "meta:license": [
-    "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."
-  ],
-  "$id": "https://ns.adobe.com/helix/data-embed/row",
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "Row",
-  "type": "object",
-  "meta:status": "stabilizing",
-  "description": "A JSON representation of an Excel or Google Sheets data row.",
-  "additionalProperties": {
-    "type": ["string", "number"],
-    "description": "Value of the cell in the given column."
-  }
-}

package/src/schemas/runtimestrain.schema.json

@@ -1,144 +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/runtimestrain",
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "Runtime Strain",
-  "type": "object",
-  "meta:status": "stabilizing",
-  "description": "A runtime strain is a combination of code and content that enables the creation of a digital experience.",
-  "additionalProperties": false,
-  "properties": {
-    "name": {
-      "type": "string",
-      "description": "Name of the strain"
-    },
-    "code": {
-      "description": "Pointer to the code repository",
-      "oneOf": [
-        {
-          "type": "string",
-          "format": "uri"
-        },
-        {"$ref": "https://ns.adobe.com/helix/shared/giturl"}
-      ]
-    },
-    "content": {
-      "description": "Pointer to the content repository",
-      "oneOf": [
-        {
-          "type": "string",
-          "format": "uri"
-        },
-        {"$ref": "https://ns.adobe.com/helix/shared/giturl"}
-      ]
-    },
-    "static": {
-      "description": "Pointer to the repository for static resources",
-      "oneOf": [
-        {
-          "type": "string",
-          "format": "uri"
-        },
-        {"$ref": "https://ns.adobe.com/helix/shared/staticgiturl"}
-      ]
-    },
-    "directoryIndex": {
-      "description": "Name of the resource to use for requests to directories (no extension).\nWhen a request is made by the browser to `/help` and `directoryIndex=README.html`, then the request will be treated as if it was made to `/help/README.html`. Slashes (`/`) are not allowed in the directory index.",
-      "type": "string",
-      "pattern": "^[^/]+$",
-      "default": "index.html"
-    },
-    "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"
-    },
-    "package": {
-      "oneOf": [
-        {
-          "description": "Name of the action package that renders this strain.",
-          "type": "string",
-          "pattern": "^[^/]*$",
-          "examples": [
-            "10e05c072b108ac9533c6206c6eaa651901ca29b"
-          ]
-        },
-        {
-          "description": "A pair of OpenWhisk namespace and package name, separated by slash.\n\n This will be the base package to look up actions to run in this strain.",
-          "type": "string",
-          "pattern": "^[^/]+\\/[^/]+$",
-          "examples": [
-            "helix-pages/pages_4.15.1",
-            "trieloff/10e05c072b108ac9533c6206c6eaa651901ca29b"
-          ]
-        },
-        {
-          "description": "A base URL to use for all actions in this strain.",
-          "type": "string",
-          "format": "uri",
-          "examples": [
-            "https://helix-pages.anywhere.run/helix-pages/pages@4.15.1"
-          ]
-        }
-      ]
-    },
-    "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": [
-    "code",
-    "content",
-    "static",
-    "name"
-  ]
-}

package/src/schemas/sheet.schema.json

@@ -1,57 +0,0 @@
-{
-  "meta:license": [
-    "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."
-  ],
-  "$id": "https://ns.adobe.com/helix/data-embed/sheet",
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "Worksheet",
-  "type": "object",
-  "meta:status": "stabilizing",
-  "description": "A JSON representation of an Excel or Google Sheets worksheet containing rows and columns.",
-  "properties": {
-    ":type": {
-      "const": "sheet",
-      "description": "The response type, depending on the presence of the `sheet` request parameter."
-    },
-    "limit": {
-      "type": "integer",
-      "minimum": 0,
-      "description": "The maximum number of items requested by the `limit` parameter."
-    },
-    "offset": {
-      "type": "integer",
-      "minimum": 0,
-      "description": "The starting row that items have been retrieved by as specified by the `offset` parameter."
-    },
-    "total": {
-      "type": "integer",
-      "minimum": 0,
-      "description": "The total number of items in the data sheet. This value can be greater than the sum of `limit` and `offset`"
-    },
-    "data": {
-      "type": "array",
-      "description": "The data rows that are part of the result set",
-      "items": {
-        "$ref": "https://ns.adobe.com/helix/data-embed/row"
-      }
-    },
-    ":version": {
-      "type": "number",
-      "enum": [3],
-      "default": 3,
-      "description": "The workbook response format version"
-    }
-  },
-  "additionalProperties": false,
-  "required": [
-    "limit", "offset", "data", "total"
-  ]
-}