@adobe/helix-shared-config 1.7.23 → 2.0.2

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

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"/>
-```