@adobe/helix-shared-config 1.7.21 → 2.0.0

package/src/schemas/config.schema.json

@@ -1,44 +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/config",
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "Configuration",
-  "type": "object",
-  "meta:status": "stabilizing",
-  "description": "A Configuration File for Project Helix.",
-  "additionalProperties": false,
-  "properties": {
-    "definitions": {
-      "type": "object",
-      "description": "A container for referencable objects that can be re-used elsewhere in the configuration."
-    },
-    "version": {
-      "type":["string", "number"],
-      "enum": ["1", 1],
-      "default": 1,
-      "description": "The helix-config file format version"
-    },
-    "strains": {
-      "$ref": "https://ns.adobe.com/helix/shared/strains"
-    },
-    "preflight": {
-      "type": "string",
-      "format": "uri",
-      "pattern": "^https://adobeioruntime\\.net/|^https://[^.]*\\.anywhere\\.run/",
-      "description": "The URL of a preflight check that should be performed before assigning a strain to a request. The headers returned by this preflight request can be used in strain conditions."
-    }
-  },
-  "required": [
-    "strains"
-  ]
-}

package/src/schemas/data-embed-response.schema.json

@@ -1,40 +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/response",
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "Response",
-  "type": "object",
-  "meta:status": "stabilizing",
-  "description": "The Helix Data Embed Response format",
-  "allOf": [
-    {
-      "oneOf": [
-        { "$ref": "https://ns.adobe.com/helix/data-embed/sheet" },
-        { "$ref": "https://ns.adobe.com/helix/data-embed/workbook" }
-      ]
-    },
-    {
-      ":version": {
-        "type": "number",
-        "enum": [3],
-        "default": 3,
-        "description": "The workbook response format version"
-      }
-    }
-  ],
-  "required": [
-    ":version",
-    ":type"
-  ],
-  "minProperties": 4
-}

package/src/schemas/giturl.schema.json

@@ -1,62 +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/giturl",
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "Git URL",
-  "type": "object",
-  "meta:status": "stabilizing",
-  "description": "Representation of the fragments of a Git URL",
-  "additionalProperties": false,
-  "properties": {
-    "protocol": {
-      "description": "The protocol to access the Git repository",
-      "enum": ["https", "http", "ssh"],
-      "type":"string"
-    },
-    "hostname": {
-      "description": "The hostname without port",
-      "type":"string",
-      "format": "hostname"
-    },
-    "host": {
-      "description": "The hostname with port",
-      "type":"string"
-    },
-    "port": {
-      "description": "The port to access the Git Repository",
-      "type":["integer", "string"]
-    },
-    "owner": {
-      "description": "The owner or username that the repository belongs to",
-      "type":"string"
-    },
-    "path": {
-      "description": "The path within the repository",
-      "type":"string"
-    },
-    "repo": {
-      "description": "The repository name",
-      "type":"string"
-    },
-    "ref": {
-      "description": "The branch, tag, or sha of the tree in the repository to use",
-      "default": "master",
-      "type":"string"
-    }
-  },
-  "required": [
-    "owner",
-    "repo",
-    "ref"
-  ]
-}

package/src/schemas/markup.schema.json

@@ -1,22 +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/markup",
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "Markup Configuration",
-  "type": "object",
-  "meta:status": "stabilizing",
-  "description": "A container for markup mappings. Each markup mapping is a named key.",
-  "additionalProperties": {
-    "$ref": "https://ns.adobe.com/helix/shared/markupmapping"
-  }
-}

package/src/schemas/markupconfig.schema.json

@@ -1,38 +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/markupconfig",
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "Configuration",
-  "type": "object",
-  "meta:status": "stabilizing",
-  "description": "A Markup Configuration File for Project Helix.",
-  "additionalProperties": false,
-  "properties": {
-    "definitions": {
-      "type": "object",
-      "description": "A container for referencable objects that can be re-used elsewhere in the configuration."
-    },
-    "version": {
-      "type":["string", "number"],
-      "enum": ["1", 1],
-      "default": 1,
-      "description": "The helix-config file format version"
-    },
-    "markup": {
-      "$ref": "https://ns.adobe.com/helix/shared/markup"
-    }
-  },
-  "required": [
-    "markup"
-  ]
-}

package/src/schemas/markupmapping.description.md

@@ -1,242 +0,0 @@
-A markup mapping defines how Helix should generate markup for certain Markdown or DOM patterns.
-
-A configuration consits of a mandatory `match` expression, which is a matching expression that works differently depending on the value of the `type` attribute.
-
-- If `type=html`, then `match` is a CSS selector that operates on the generated HTML
-- If `type=markdown`, then `match` is a CSS selector that operates on the source Markdown
-- If `type=url`, then `match` is a URL path expression
-- If `type=content`, then `match` is a content intelligence expression that selects sections based on the order of their children
-
-Furthermore, a configuration can have any number of actions (including none at all), for example:
-
-- `wrap`: adds more HTML elements around the generated HTML
-- `replace`: replaces the generated HTML with the provided markup
-- `classnames` adds `class` attribute values into the generated HTML element
-- `attribute` adds other attributes and values into the generated HTML element
-
-## Referencing AST values
-
-In the `wrap` and `replace` expressions you can use pattern expressions like `wrap: pre.zupp[data-embed="${url}"]` inside the Emmet syntax, allowing you to reference properties of the matched MDAST or DOM node.
-
-## Examples
-
-### On the DOM tree
-
-The most intuitive usage for most developers will be directly operating on the resulting DOM tree.
-The `match` method just takes a regular CSS selector and then applies the desired markup on the resulting element.
-
-#### Adding a class
-
-`index.md`
-```markdown
-# Lorem ipsum dolor sit amet
-
-consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua
-
-![Lorem ipsum](http://dolor.sit/amet.jpeg)
-```
-
-`helix-markup.yaml`
-```yaml
-version: 1
-markup:
-  foo:
-    match: p
-    classnames:
-      - foo
-    type: html
-```
-
-`index.html`
-```html
-<h1>Lorem ipsum dolor sit amet</h1>
-<p class="foo">consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua</p>
-<img src="http://dolor.sit/amet.jpeg" alt="Lorem ipsum"/>
-```
-
-#### Adding an attribute
-
-`index.md`
-```markdown
-# Lorem ipsum dolor sit amet
-
-consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua
-
-![Lorem ipsum](http://dolor.sit/amet.jpeg)
-```
-
-`helix-markup.yaml`
-```yaml
-version: 1
-markup:
-  foo:
-    match: p
-    attribute:
-      bar: baz
-    type: html
-```
-
-`index.html`
-```html
-<h1>Lorem ipsum dolor sit amet</h1>
-<p bar="baz">consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua</p>
-<img src="http://dolor.sit/amet.jpeg" alt="Lorem ipsum"/>
-```
-
-#### Wrapping with another element
-
-`index.md`
-```markdown
-# Lorem ipsum dolor sit amet
-
-consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua
-
-![Lorem ipsum](http://dolor.sit/amet.jpeg)
-```
-
-`helix-markup.yaml`
-```yaml
-version: 1
-markup:
-  foo:
-    match: p
-    wrap: section.qux
-    type: html
-```
-
-`index.html`
-```html
-<h1>Lorem ipsum dolor sit amet</h1>
-<section class="qux">
-  <p>consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua</p>
-</section>
-<img src="http://dolor.sit/amet.jpeg" alt="Lorem ipsum"/>
-```
-
-### On the Markdown abstract tree
-
-As an alternative, it is also possible to directly operate on the Markdown abstract syntax tree before it is converted to HTML. This is especially useful if you are heavily modifying the markup via the `*.pre.js` and need to already annotate your tree before processing. The `match` property takes a CSS like selector, but instead of DOM elements, you are targeting [MDAST nodes](https://github.com/syntax-tree/mdast#nodes).
-
-#### Adding a class
-
-`index.md`
-```markdown
-# Lorem ipsum dolor sit amet
-
-consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua
-
-![Lorem ipsum](http://dolor.sit/amet.jpeg)
-```
-
-`helix-markup.yaml`
-```yaml
-version: 1
-markup:
-  foo:
-    match: paragraph
-    classnames:
-      - foo
-    type: markdown
-```
-
-`index.html`
-```html
-<h1>Lorem ipsum dolor sit amet</h1>
-<p class="foo">consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua</p>
-<img src="http://dolor.sit/amet.jpeg" alt="Lorem ipsum"/>
-```
-
-#### Adding an attribute
-
-`index.md`
-```markdown
-# Lorem ipsum dolor sit amet
-
-consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua
-
-![Lorem ipsum](http://dolor.sit/amet.jpeg)
-```
-
-`helix-markup.yaml`
-```yaml
-version: 1
-markup:
-  foo:
-    match: paragraph
-    attribute:
-      bar: baz
-    type: markdown
-```
-
-`index.html`
-```html
-<h1>Lorem ipsum dolor sit amet</h1>
-<p bar="baz">consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua</p>
-<img src="http://dolor.sit/amet.jpeg" alt="Lorem ipsum"/>
-```
-
-#### Wrapping with another element
-
-`index.md`
-```markdown
-# Lorem ipsum dolor sit amet
-
-consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua
-
-![Lorem ipsum](http://dolor.sit/amet.jpeg)
-```
-
-`helix-markup.yaml`
-```yaml
-version: 1
-markup:
-  foo:
-    match: paragraph
-    wrap: section.qux
-    type: markdown
-```
-
-`index.html`
-```html
-<h1>Lorem ipsum dolor sit amet</h1>
-<section class="qux">
-  <p>consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua</p>
-</section>
-<img src="http://dolor.sit/amet.jpeg" alt="Lorem ipsum"/>
-```
-
-### Mixed
-
-For the sake of completeness, we provide here an example of mixed rules
-
-`index.md`
-```markdown
-# Lorem ipsum dolor sit amet
-
-consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua
-
-![Lorem ipsum](http://dolor.sit/amet.jpeg)
-```
-
-`helix-markup.yaml`
-```yaml
-version: 1
-markup:
-  foo:
-    match: paragraph
-    classnames:
-      - foo
-    type: markdown
-  bar:
-    match: p
-    attribute:
-      bar: baz
-    type: html
-```
-
-`index.html`
-```html
-<h1>Lorem ipsum dolor sit amet</h1>
-<p class="foo" bar="baz">consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua</p>
-<img src="http://dolor.sit/amet.jpeg" alt="Lorem ipsum"/>
-```

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