diff --git a/docs/README.md b/docs/README.md index c2ab21472..36cf9bd14 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,16 +1,89 @@ -# Readme - -## / - -- [Action](./action.schema.md) – `https://ns.adobe.com/helix/pipeline/action` (Stabilizing) -- [Content](./content.schema.md) – `https://ns.adobe.com/helix/pipeline/content` (Stabilizing) -- [Context](./context.schema.md) – `https://ns.adobe.com/helix/pipeline/context` (Stabilizing) -- [MDAST](./mdast.schema.md) – `https://ns.adobe.com/helix/pipeline/mdast` (Stable) -- [Meta](./meta.schema.md) – `https://ns.adobe.com/helix/pipeline/meta` (Stabilizing) -- [Position](./position.schema.md) – `https://ns.adobe.com/helix/pipeline/position` (Stable) -- [Raw Request](./rawrequest.schema.md) – `https://ns.adobe.com/helix/pipeline/rawrequest` (Experimental) -- [Request](./request.schema.md) – `https://ns.adobe.com/helix/pipeline/request` (Stabilizing) -- [Response](./response.schema.md) – `https://ns.adobe.com/helix/pipeline/response` (Stabilizing) -- [Secrets](./secrets.schema.md) – `https://ns.adobe.com/helix/pipeline/secrets` (Stable) -- [Section](./section.schema.md) – `https://ns.adobe.com/helix/pipeline/section` (Experimental) -- [Text Coordinates](./textcoordinates.schema.md) – `https://ns.adobe.com/helix/pipeline/textcoordinates` (Stabilizing) +# README + +## Top-level Schemas + +- [Action](./action.md "Tracks the OpenWhisk action invocation") – `https://ns.adobe.com/helix/pipeline/action` +- [Content](./content.md "The content as retrieved from the repository and enriched in the pipeline") – `https://ns.adobe.com/helix/pipeline/content` +- [Context](./context.md "The context thingie") – `https://ns.adobe.com/helix/pipeline/context` +- [MDAST](./mdast.md "A node in the Markdown AST") – `https://ns.adobe.com/helix/pipeline/mdast` +- [Meta](./meta.md "Content and Section Metadata Properties") – `https://ns.adobe.com/helix/pipeline/meta` +- [Position](./position.md "Marks the position of an AST node in the original text flow") – `https://ns.adobe.com/helix/pipeline/position` +- [Raw Request](./rawrequest.md "The Request Object used for Invoking OpenWhisk") – `https://ns.adobe.com/helix/pipeline/rawrequest` +- [Request](./request.md "The HTTP Request") – `https://ns.adobe.com/helix/pipeline/request` +- [Response](./response.md "The HTTP response object") – `https://ns.adobe.com/helix/pipeline/response` +- [Secrets](./secrets.md "Secrets passed into the pipeline such as API Keys or configuration settings") – `https://ns.adobe.com/helix/pipeline/secrets` +- [Section](./section.md "A section in a markdown document") – `https://ns.adobe.com/helix/pipeline/section` +- [Text Coordinates](./textcoordinates.md "A position in a text document") – `https://ns.adobe.com/helix/pipeline/textcoordinates` + +## Other Schemas + +### Objects + +- [MDAST](./content-properties-mdast.md "A node in the Markdown AST") – `https://ns.adobe.com/helix/pipeline/mdast#/properties/mdast` +- [Position](./section-definitions-section-properties-position.md "Marks the position of an AST node in the original text flow") – `https://ns.adobe.com/helix/pipeline/position#/definitions/section/properties/position` +- [Raw Request](./action-properties-raw-request.md "The Request Object used for Invoking OpenWhisk") – `https://ns.adobe.com/helix/pipeline/rawrequest#/properties/request` +- [Request](./context-properties-request.md "The HTTP Request") – `https://ns.adobe.com/helix/pipeline/request#/properties/request` +- [Response](./context-properties-response.md "The HTTP response object") – `https://ns.adobe.com/helix/pipeline/response#/properties/response` +- [Secrets](./action-properties-secrets.md "Secrets passed into the pipeline such as API Keys or configuration settings") – `https://ns.adobe.com/helix/pipeline/secrets#/properties/secrets` +- [Text Coordinates](./position-properties-text-coordinates.md "A position in a text document") – `https://ns.adobe.com/helix/pipeline/textcoordinates#/properties/start` +- [Untitled object in Action](./action-properties-logger.md "A helix-log SimpleInterface logger instance") – `https://ns.adobe.com/helix/pipeline/action#/properties/logger` +- [Untitled object in Action](./action-properties-debug.md "Internal information related to debugging") – `https://ns.adobe.com/helix/pipeline/action#/properties/debug` +- [Untitled object in Action](./action-properties-transformer.md "A VDOMTransformer instance") – `https://ns.adobe.com/helix/pipeline/action#/properties/transformer` +- [Untitled object in Content](./content-properties-document.md "The DOM-compatible representation of the document's inner HTML") – `https://ns.adobe.com/helix/pipeline/content#/properties/document` +- [Untitled object in Content](./content-properties-xml.md "The XML object to emit") – `https://ns.adobe.com/helix/pipeline/content#/properties/xml` +- [Untitled object in Content](./content-properties-data.md "Custom object that can hold any user defined data") – `https://ns.adobe.com/helix/pipeline/content#/properties/data` +- [Untitled object in Content](./content-properties-json.md "The JSON object to emit") – `https://ns.adobe.com/helix/pipeline/content#/properties/json` +- [Untitled object in MDAST](./mdast-properties-payload.md "The payload of a frontmatter/yaml block") – `https://ns.adobe.com/helix/pipeline/mdast#/properties/payload` +- [Untitled object in MDAST](./mdast-properties-payload.md "The payload of a frontmatter/yaml block") – `https://ns.adobe.com/helix/pipeline/mdast#/properties/payload` +- [Untitled object in MDAST](./mdast-properties-data-hproperties-items.md) – `https://ns.adobe.com/helix/pipeline/mdast#/properties/data/hProperties/items` +- [Untitled object in MDAST](./mdast-properties-data-hchildren-items.md) – `https://ns.adobe.com/helix/pipeline/mdast#/properties/data/hChildren/items` +- [Untitled object in MDAST](./mdast-properties-data-hchildren-items.md) – `https://ns.adobe.com/helix/pipeline/mdast#/properties/data/hChildren/items` +- [Untitled object in MDAST](./mdast-properties-data-hproperties-items.md) – `https://ns.adobe.com/helix/pipeline/mdast#/properties/data/hProperties/items` +- [Untitled object in MDAST](./mdast-properties-data.md "data is guaranteed to never be specified by unist or specifications implementing unist") – `https://ns.adobe.com/helix/pipeline/mdast#/properties/data` +- [Untitled object in MDAST](./mdast-properties-data.md "data is guaranteed to never be specified by unist or specifications implementing unist") – `https://ns.adobe.com/helix/pipeline/mdast#/properties/data` +- [Untitled object in Raw Request](./rawrequest-definitions-rawrequest-properties-headers.md "The headers of the request made to OpenWhisk (or Simulator)") – `https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/headers` +- [Untitled object in Raw Request](./rawrequest-definitions-rawrequest-properties-params-properties-__ow_headers.md "Deprecated: The original OpenWhisk request headers") – `https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/__ow_headers` +- [Untitled object in Raw Request](./rawrequest-definitions-rawrequest-properties-params.md "Parameters used to invoke the OpenWhisk action") – `https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params` +- [Untitled object in Raw Request](./rawrequest-definitions-rawrequest-properties-params-properties-__ow_headers.md "Deprecated: The original OpenWhisk request headers") – `https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/__ow_headers` +- [Untitled object in Raw Request](./rawrequest-definitions-rawrequest-properties-params.md "Parameters used to invoke the OpenWhisk action") – `https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params` +- [Untitled object in Raw Request](./rawrequest-definitions-rawrequest-properties-headers.md "The headers of the request made to OpenWhisk (or Simulator)") – `https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/headers` +- [Untitled object in Raw Request](./rawrequest-definitions-rawrequest-properties-headers.md "The headers of the request made to OpenWhisk (or Simulator)") – `https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/headers` +- [Untitled object in Raw Request](./rawrequest-definitions-rawrequest-properties-params.md "Parameters used to invoke the OpenWhisk action") – `https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params` +- [Untitled object in Raw Request](./rawrequest-definitions-rawrequest-properties-params-properties-__ow_headers.md "Deprecated: The original OpenWhisk request headers") – `https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/__ow_headers` +- [Untitled object in Raw Request](./rawrequest-definitions-rawrequest-properties-headers.md "The headers of the request made to OpenWhisk (or Simulator)") – `https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/headers` +- [Untitled object in Raw Request](./rawrequest-definitions-rawrequest-properties-params.md "Parameters used to invoke the OpenWhisk action") – `https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params` +- [Untitled object in Raw Request](./rawrequest-definitions-rawrequest-properties-params-properties-__ow_headers.md "Deprecated: The original OpenWhisk request headers") – `https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/__ow_headers` +- [Untitled object in Request](./request-properties-params.md "The passed through (and filtered) URL parameters of the request") – `https://ns.adobe.com/helix/pipeline/request#/properties/params` +- [Untitled object in Request](./request-properties-params.md "The passed through (and filtered) URL parameters of the request") – `https://ns.adobe.com/helix/pipeline/request#/properties/params` +- [Untitled object in Response](./response-properties-document.md "The DOM-compatible representation of the response document") – `https://ns.adobe.com/helix/pipeline/response#/properties/document` +- [Untitled object in Response](./response-properties-body-anyof-1.md "The JSON object to represent the body of the response") – `https://ns.adobe.com/helix/pipeline/response#/properties/body/anyOf/1` +- [Untitled object in Response](./response-properties-body-anyof-1.md "The JSON object to represent the body of the response") – `https://ns.adobe.com/helix/pipeline/response#/properties/body/anyOf/1` +- [Untitled object in Response](./response-properties-document.md "The DOM-compatible representation of the response document") – `https://ns.adobe.com/helix/pipeline/response#/properties/document` + +### Arrays + +- [Untitled array in Content](./content-properties-sources.md "List of URIs that have been retrieved for this piece of content") – `https://ns.adobe.com/helix/pipeline/content#/properties/sources` +- [Untitled array in MDAST](./mdast-properties-children.md) – `https://ns.adobe.com/helix/pipeline/mdast#/properties/children` +- [Untitled array in MDAST](./mdast-properties-types.md "The inferred class names for the section") – `https://ns.adobe.com/helix/pipeline/mdast#/properties/types` +- [Untitled array in MDAST](./mdast-properties-align.md "For tables, an align field can be present") – `https://ns.adobe.com/helix/pipeline/mdast#/properties/align` +- [Untitled array in MDAST](./mdast-properties-children.md) – `https://ns.adobe.com/helix/pipeline/mdast#/properties/children` +- [Untitled array in MDAST](./mdast-properties-align.md "For tables, an align field can be present") – `https://ns.adobe.com/helix/pipeline/mdast#/properties/align` +- [Untitled array in MDAST](./mdast-properties-types.md "The inferred class names for the section") – `https://ns.adobe.com/helix/pipeline/mdast#/properties/types` +- [Untitled array in Meta](./meta-definitions-meta-properties-types.md "The inferred class names for the section") – `https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/types` +- [Untitled array in Meta](./meta-definitions-meta-properties-types.md "The inferred class names for the section") – `https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/types` +- [Untitled array in Meta](./meta-definitions-meta-properties-types.md "The inferred class names for the section") – `https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/types` +- [Untitled array in Meta](./meta-definitions-meta-properties-types.md "The inferred class names for the section") – `https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/types` +- [Untitled array in Meta](./meta-definitions-meta-properties-types.md "The inferred class names for the section") – `https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/types` +- [Untitled array in Meta](./meta-definitions-meta-properties-types.md "The inferred class names for the section") – `https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/types` +- [Untitled array in Meta](./meta-definitions-meta-properties-types.md "The inferred class names for the section") – `https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/types` +- [Untitled array in Position](./position-properties-indent.md) – `https://ns.adobe.com/helix/pipeline/position#/properties/indent` +- [Untitled array in Position](./position-properties-indent.md) – `https://ns.adobe.com/helix/pipeline/position#/properties/indent` +- [Untitled array in Request](./request-properties-params-additionalproperties-anyof-1.md) – `https://ns.adobe.com/helix/pipeline/request#/properties/params/additionalProperties/anyOf/1` +- [Untitled array in Request](./request-properties-params-additionalproperties-anyof-1.md) – `https://ns.adobe.com/helix/pipeline/request#/properties/params/additionalProperties/anyOf/1` +- [Untitled array in Section](./section-definitions-section-properties-children.md "The AST nodes making up the section") – `https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/children` +- [Untitled array in Section](./section-definitions-section-properties-children.md "The AST nodes making up the section") – `https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/children` +- [Untitled array in Section](./section-definitions-section-properties-children.md "The AST nodes making up the section") – `https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/children` + +## Version Note + +The schemas linked above follow the JSON Schema Spec version: `http://json-schema.org/draft-07/schema#` diff --git a/docs/action-properties-debug.md b/docs/action-properties-debug.md new file mode 100644 index 000000000..b830f3f45 --- /dev/null +++ b/docs/action-properties-debug.md @@ -0,0 +1,16 @@ +# Untitled object in Action Schema + +```txt +https://ns.adobe.com/helix/pipeline/action#/properties/debug +``` + +Internal information related to debugging. + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ----------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [action.schema.json\*](action.schema.json "open original schema") | + +## debug Type + +`object` ([Details](action-properties-debug.md)) diff --git a/docs/action-properties-logger.md b/docs/action-properties-logger.md new file mode 100644 index 000000000..80729d7f6 --- /dev/null +++ b/docs/action-properties-logger.md @@ -0,0 +1,16 @@ +# Untitled object in Action Schema + +```txt +https://ns.adobe.com/helix/pipeline/action#/properties/logger +``` + +A helix-log [SimpleInterface](https://github.com/adobe/helix-log) logger instance. + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ----------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [action.schema.json\*](action.schema.json "open original schema") | + +## logger Type + +`object` ([Details](action-properties-logger.md)) diff --git a/docs/action-properties-raw-request.md b/docs/action-properties-raw-request.md new file mode 100644 index 000000000..7fb8a8d6b --- /dev/null +++ b/docs/action-properties-raw-request.md @@ -0,0 +1,84 @@ +# Raw Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/rawrequest#/properties/request +``` + +The Request Object used for Invoking OpenWhisk + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :--------------------- | ---------- | ------------ | ----------------------- | :---------------- | --------------------- | ------------------- | ----------------------------------------------------------------- | +| Cannot be instantiated | Yes | Experimental | Unknown identifiability | Forbidden | Allowed | none | [action.schema.json\*](action.schema.json "open original schema") | + +## request Type + +`object` ([Raw Request](action-properties-raw-request.md)) + +all of + +- [Untitled undefined type in Raw Request](rawrequest-definitions-rawrequest.md "check type definition") + +# Raw Request Definitions + +## Definitions group rawrequest + +Reference this group by using + +```json +{"$ref":"https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :------------------ | -------- | -------- | -------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [headers](#headers) | `object` | Optional | cannot be null | [Raw Request](rawrequest-definitions-rawrequest-properties-headers.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/headers") | +| [method](#method) | `string` | Optional | cannot be null | [Raw Request](rawrequest-definitions-rawrequest-properties-method.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/method") | +| [params](#params) | `object` | Optional | cannot be null | [Raw Request](rawrequest-definitions-rawrequest-properties-params.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params") | + +### headers + +The headers of the request made to OpenWhisk (or Simulator) + + +`headers` + +- is optional +- Type: `object` ([Details](rawrequest-definitions-rawrequest-properties-headers.md)) +- cannot be null +- defined in: [Raw Request](rawrequest-definitions-rawrequest-properties-headers.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/headers") + +#### headers Type + +`object` ([Details](rawrequest-definitions-rawrequest-properties-headers.md)) + +### method + +The HTTP method of the request made to OpenWhisk (or Simulator). Note: OpenWhisk converts all methods to lowercase. + + +`method` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Raw Request](rawrequest-definitions-rawrequest-properties-method.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/method") + +#### method Type + +`string` + +### params + +Parameters used to invoke the OpenWhisk action. These are either URL parameters added when invoking the action from the CDN or default parameters set during creation of the action. + + +`params` + +- is optional +- Type: `object` ([Details](rawrequest-definitions-rawrequest-properties-params.md)) +- cannot be null +- defined in: [Raw Request](rawrequest-definitions-rawrequest-properties-params.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params") + +#### params Type + +`object` ([Details](rawrequest-definitions-rawrequest-properties-params.md)) diff --git a/docs/action-properties-secrets.md b/docs/action-properties-secrets.md new file mode 100644 index 000000000..65ddaacfd --- /dev/null +++ b/docs/action-properties-secrets.md @@ -0,0 +1,324 @@ +# Secrets Schema + +```txt +https://ns.adobe.com/helix/pipeline/secrets#/properties/secrets +``` + +Secrets passed into the pipeline such as API Keys or configuration settings. + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | ------ | ------------ | :---------------- | --------------------- | ------------------- | ----------------------------------------------------------------- | +| Can be instantiated | No | Stable | No | Forbidden | Forbidden | none | [action.schema.json\*](action.schema.json "open original schema") | + +## secrets Type + +`object` ([Secrets](action-properties-secrets.md)) + +# Secrets Properties + +| Property | Type | Required | Nullable | Defined by | +| :------------------------------------------------ | --------- | -------- | -------------- | :-------------------------------------------------------------------------------------------------------------------------------------------- | +| [REPO_RAW_ROOT](#REPO_RAW_ROOT) | `string` | Optional | cannot be null | [Secrets](secrets-properties-repo_raw_root.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/REPO_RAW_ROOT") | +| [REPO_API_ROOT](#REPO_API_ROOT) | `string` | Optional | cannot be null | [Secrets](secrets-properties-repo_api_root.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/REPO_API_ROOT") | +| [EMBED_WHITELIST](#EMBED_WHITELIST) | `string` | Optional | cannot be null | [Secrets](secrets-properties-embed_whitelist.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/EMBED_WHITELIST") | +| [EMBED_SERVICE](#EMBED_SERVICE) | `string` | Optional | cannot be null | [Secrets](secrets-properties-embed_service.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/EMBED_SERVICE") | +| [EMBED_SELECTOR](#EMBED_SELECTOR) | `string` | Optional | cannot be null | [Secrets](secrets-properties-embed_selector.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/EMBED_SELECTOR") | +| [IMAGES_MIN_SIZE](#IMAGES_MIN_SIZE) | `integer` | Optional | cannot be null | [Secrets](secrets-properties-images_min_size.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/IMAGES_MIN_SIZE") | +| [HTTP_TIMEOUT](#HTTP_TIMEOUT) | `integer` | Optional | cannot be null | [Secrets](secrets-properties-http_timeout.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/HTTP_TIMEOUT") | +| [TEST_BOOLEAN](#TEST_BOOLEAN) | `boolean` | Optional | cannot be null | [Secrets](secrets-properties-test_boolean.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/TEST_BOOLEAN") | +| [XML_PRETTY](#XML_PRETTY) | `boolean` | Optional | cannot be null | [Secrets](secrets-properties-xml_pretty.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/XML_PRETTY") | +| [SANITIZE_DOM](#SANITIZE_DOM) | `boolean` | Optional | cannot be null | [Secrets](secrets-properties-sanitize_dom.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/SANITIZE_DOM") | +| [RESOLVE_GITREF_SERVICE](#RESOLVE_GITREF_SERVICE) | `string` | Optional | cannot be null | [Secrets](secrets-properties-resolve_gitref_service.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/RESOLVE_GITREF_SERVICE") | +| [GITHUB_TOKEN](#GITHUB_TOKEN) | `string` | Optional | cannot be null | [Secrets](secrets-properties-github_token.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/GITHUB_TOKEN") | +| `[A-Z0-9_]+` | Multiple | Optional | cannot be null | [Secrets](secrets-patternproperties-a-z0-9_.md "https://ns.adobe.com/helix/pipeline/secrets#/patternProperties/\[A-Z0-9\_]+") | + +## REPO_RAW_ROOT + +The Base URL for retrieving raw text files from GitHub + + +`REPO_RAW_ROOT` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Secrets](secrets-properties-repo_raw_root.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/REPO_RAW_ROOT") + +### REPO_RAW_ROOT Type + +`string` + +### REPO_RAW_ROOT Constraints + +**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc4291 "check the specification") + +### REPO_RAW_ROOT Default Value + +The default value is: + +```json +"https://raw.githubusercontent.com/" +``` + +## REPO_API_ROOT + +The base URL for all GitHub API operations + + +`REPO_API_ROOT` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Secrets](secrets-properties-repo_api_root.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/REPO_API_ROOT") + +### REPO_API_ROOT Type + +`string` + +### REPO_API_ROOT Constraints + +**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc4291 "check the specification") + +### REPO_API_ROOT Default Value + +The default value is: + +```json +"https://api.github.com/" +``` + +## EMBED_WHITELIST + +Comma-separated list of allowed hostnames for embeds. Supports `*.example.com` as a subdomain wildcard. Use `*` to allow all embeds (potentially insecure) + + +`EMBED_WHITELIST` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Secrets](secrets-properties-embed_whitelist.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/EMBED_WHITELIST") + +### EMBED_WHITELIST Type + +`string` + +### EMBED_WHITELIST Default Value + +The default value is: + +```json +"www.youtube.com, spark.adobe.com, unsplash.com/photos" +``` + +## EMBED_SERVICE + +URL of an Embed Service that takes the appended URL and returns an embeddable HTML representation. + + +`EMBED_SERVICE` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Secrets](secrets-properties-embed_service.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/EMBED_SERVICE") + +### EMBED_SERVICE Type + +`string` + +### EMBED_SERVICE Default Value + +The default value is: + +```json +"https://adobeioruntime.net/api/v1/web/helix/helix-services/embed@v1" +``` + +## EMBED_SELECTOR + +Selector to be used when resolving internal embeds. + + +`EMBED_SELECTOR` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Secrets](secrets-properties-embed_selector.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/EMBED_SELECTOR") + +### EMBED_SELECTOR Type + +`string` + +### EMBED_SELECTOR Default Value + +The default value is: + +```json +"embed" +``` + +## IMAGES_MIN_SIZE + +Minimum physical width of responsive images to generate + + +`IMAGES_MIN_SIZE` + +- is optional +- Type: `integer` +- cannot be null +- defined in: [Secrets](secrets-properties-images_min_size.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/IMAGES_MIN_SIZE") + +### IMAGES_MIN_SIZE Type + +`integer` + +### IMAGES_MIN_SIZE Default Value + +The default value is: + +```json +480 +``` + +## HTTP_TIMEOUT + +Timeout for outgoing HTTP requests in milliseconds + + +`HTTP_TIMEOUT` + +- is optional +- Type: `integer` +- cannot be null +- defined in: [Secrets](secrets-properties-http_timeout.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/HTTP_TIMEOUT") + +### HTTP_TIMEOUT Type + +`integer` + +### HTTP_TIMEOUT Default Value + +The default value is: + +```json +1000 +``` + +## TEST_BOOLEAN + + + + +`TEST_BOOLEAN` + +- is optional +- Type: `boolean` +- cannot be null +- defined in: [Secrets](secrets-properties-test_boolean.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/TEST_BOOLEAN") + +### TEST_BOOLEAN Type + +`boolean` + +### TEST_BOOLEAN Default Value + +The default value is: + +```json +true +``` + +## XML_PRETTY + +Print XML with line breaks and indentation + + +`XML_PRETTY` + +- is optional +- Type: `boolean` +- cannot be null +- defined in: [Secrets](secrets-properties-xml_pretty.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/XML_PRETTY") + +### XML_PRETTY Type + +`boolean` + +### XML_PRETTY Default Value + +The default value is: + +```json +true +``` + +## SANITIZE_DOM + +Sanitize the HTML output to guard against XSS attacks. + +**Note:** this flag applies a pretty aggressive DOM filtering that will strip out a lot of HTML that your authors might find useful. The setting is meant for processing truly untrusted inputs, such as comments in a social media site. + + +`SANITIZE_DOM` + +- is optional +- Type: `boolean` +- cannot be null +- defined in: [Secrets](secrets-properties-sanitize_dom.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/SANITIZE_DOM") + +### SANITIZE_DOM Type + +`boolean` + +## RESOLVE_GITREF_SERVICE + +API endpoint or action name to the service that resolves github refs to commit SHAs. + + +`RESOLVE_GITREF_SERVICE` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Secrets](secrets-properties-resolve_gitref_service.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/RESOLVE_GITREF_SERVICE") + +### RESOLVE_GITREF_SERVICE Type + +`string` + +## GITHUB_TOKEN + +GitHub access token to use while fetching markdown. See . + + +`GITHUB_TOKEN` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Secrets](secrets-properties-github_token.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/GITHUB_TOKEN") + +### GITHUB_TOKEN Type + +`string` + +## Pattern: `[A-Z0-9_]+` + + + + +`[A-Z0-9_]+` + +- is optional +- Type: any of the folllowing: `boolean` or `integer` or `number` or `string` ([Details](secrets-patternproperties-a-z0-9_.md)) +- cannot be null +- defined in: [Secrets](secrets-patternproperties-a-z0-9_.md "https://ns.adobe.com/helix/pipeline/secrets#/patternProperties/\[A-Z0-9\_]+") + +### \[A-Z0-9\_]+ Type + +any of the folllowing: `boolean` or `integer` or `number` or `string` ([Details](secrets-patternproperties-a-z0-9_.md)) diff --git a/docs/action-properties-transformer.md b/docs/action-properties-transformer.md new file mode 100644 index 000000000..00ce14b63 --- /dev/null +++ b/docs/action-properties-transformer.md @@ -0,0 +1,16 @@ +# Untitled object in Action Schema + +```txt +https://ns.adobe.com/helix/pipeline/action#/properties/transformer +``` + +A VDOMTransformer instance + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ----------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [action.schema.json\*](action.schema.json "open original schema") | + +## transformer Type + +`object` ([Details](action-properties-transformer.md)) diff --git a/docs/action-properties.md b/docs/action-properties.md new file mode 100644 index 000000000..e257b2b35 --- /dev/null +++ b/docs/action-properties.md @@ -0,0 +1,16 @@ +# Untitled undefined type in Action Schema + +```txt +https://ns.adobe.com/helix/pipeline/action#/properties +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ----------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [action.schema.json\*](action.schema.json "open original schema") | + +## properties Type + +unknown diff --git a/docs/action.md b/docs/action.md new file mode 100644 index 000000000..08b541b3e --- /dev/null +++ b/docs/action.md @@ -0,0 +1,110 @@ +# Action Schema + +```txt +https://ns.adobe.com/helix/pipeline/action +``` + +Tracks the OpenWhisk action invocation + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | ----------- | ------------ | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------- | +| Can be instantiated | No | Stabilizing | No | Forbidden | Forbidden | none | [action.schema.json](action.schema.json "open original schema") | + +## Action Type + +`object` ([Action](action.md)) + +# Action Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------------------- | -------- | -------- | -------------- | :------------------------------------------------------------------------------------------------------------------- | +| [request](#request) | Merged | Optional | cannot be null | [Action](action-properties-raw-request.md "https://ns.adobe.com/helix/pipeline/rawrequest#/properties/request") | +| [logger](#logger) | `object` | Optional | cannot be null | [Action](action-properties-logger.md "https://ns.adobe.com/helix/pipeline/action#/properties/logger") | +| [debug](#debug) | `object` | Optional | cannot be null | [Action](action-properties-debug.md "https://ns.adobe.com/helix/pipeline/action#/properties/debug") | +| [secrets](#secrets) | `object` | Optional | cannot be null | [Action](action-properties-secrets.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/secrets") | +| [transformer](#transformer) | `object` | Optional | cannot be null | [Action](action-properties-transformer.md "https://ns.adobe.com/helix/pipeline/action#/properties/transformer") | + +## request + +The Request Object used for Invoking OpenWhisk + + +`request` + +- is optional +- Type: `object` ([Raw Request](action-properties-raw-request.md)) +- cannot be null +- defined in: [Action](action-properties-raw-request.md "https://ns.adobe.com/helix/pipeline/rawrequest#/properties/request") + +### request Type + +`object` ([Raw Request](action-properties-raw-request.md)) + +all of + +- [Untitled undefined type in Raw Request](rawrequest-definitions-rawrequest.md "check type definition") + +## logger + +A helix-log [SimpleInterface](https://github.com/adobe/helix-log) logger instance. + + +`logger` + +- is optional +- Type: `object` ([Details](action-properties-logger.md)) +- cannot be null +- defined in: [Action](action-properties-logger.md "https://ns.adobe.com/helix/pipeline/action#/properties/logger") + +### logger Type + +`object` ([Details](action-properties-logger.md)) + +## debug + +Internal information related to debugging. + + +`debug` + +- is optional +- Type: `object` ([Details](action-properties-debug.md)) +- cannot be null +- defined in: [Action](action-properties-debug.md "https://ns.adobe.com/helix/pipeline/action#/properties/debug") + +### debug Type + +`object` ([Details](action-properties-debug.md)) + +## secrets + +Secrets passed into the pipeline such as API Keys or configuration settings. + + +`secrets` + +- is optional +- Type: `object` ([Secrets](action-properties-secrets.md)) +- cannot be null +- defined in: [Action](action-properties-secrets.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/secrets") + +### secrets Type + +`object` ([Secrets](action-properties-secrets.md)) + +## transformer + +A VDOMTransformer instance + + +`transformer` + +- is optional +- Type: `object` ([Details](action-properties-transformer.md)) +- cannot be null +- defined in: [Action](action-properties-transformer.md "https://ns.adobe.com/helix/pipeline/action#/properties/transformer") + +### transformer Type + +`object` ([Details](action-properties-transformer.md)) diff --git a/docs/action.schema.json b/docs/action.schema.json index 685498767..c9596b7b5 100644 --- a/docs/action.schema.json +++ b/docs/action.schema.json @@ -1,40 +1 @@ -{ - "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/pipeline/action", - "$schema": "http://json-schema.org/draft-07/schema#", - "title": "Action", - "meta:status": "stabilizing", - "type": "object", - "description": "Tracks the OpenWhisk action invocation", - "additionalProperties": false, - "properties": { - "request": { - "$ref": "https://ns.adobe.com/helix/pipeline/rawrequest" - }, - "logger": { - "type": "object", - "description": "A helix-log [SimpleInterface](https://github.com/adobe/helix-log) logger instance." - }, - "debug": { - "type": "object", - "description": "Internal information related to debugging." - }, - "secrets": { - "$ref": "https://ns.adobe.com/helix/pipeline/secrets" - }, - "transformer": { - "type": "object", - "description": "A VDOMTransformer instance" - } - } -} \ No newline at end of file +{"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/pipeline/action","$schema":"http://json-schema.org/draft-07/schema#","title":"Action","meta:status":"stabilizing","type":"object","description":"Tracks the OpenWhisk action invocation","additionalProperties":false,"properties":{"request":{"$ref":"https://ns.adobe.com/helix/pipeline/rawrequest"},"logger":{"type":"object","description":"A helix-log [SimpleInterface](https://github.com/adobe/helix-log) logger instance."},"debug":{"type":"object","description":"Internal information related to debugging."},"secrets":{"$ref":"https://ns.adobe.com/helix/pipeline/secrets"},"transformer":{"type":"object","description":"A VDOMTransformer instance"}}} diff --git a/docs/action.schema.md b/docs/action.schema.md deleted file mode 100644 index 153da4739..000000000 --- a/docs/action.schema.md +++ /dev/null @@ -1,105 +0,0 @@ -# Action Schema - -``` -https://ns.adobe.com/helix/pipeline/action -``` - -Tracks the OpenWhisk action invocation - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Defined In | -| ------------------- | ---------- | ----------- | ------------ | ----------------- | --------------------- | ---------------------------------------- | -| Can be instantiated | No | Stabilizing | No | Forbidden | Forbidden | [action.schema.json](action.schema.json) | - -## Schema Hierarchy - -- Action `https://ns.adobe.com/helix/pipeline/action` - - [Raw Request](rawrequest.schema.md) `https://ns.adobe.com/helix/pipeline/rawrequest` - - [Secrets](secrets.schema.md) `https://ns.adobe.com/helix/pipeline/secrets` - -# Action Properties - -| Property | Type | Required | Nullable | Defined by | -| --------------------------- | ----------- | -------- | -------- | -------------------- | -| [debug](#debug) | `object` | Optional | No | Action (this schema) | -| [logger](#logger) | `object` | Optional | No | Action (this schema) | -| [request](#request) | Raw Request | Optional | No | Action (this schema) | -| [secrets](#secrets) | Secrets | Optional | No | Action (this schema) | -| [transformer](#transformer) | `object` | Optional | No | Action (this schema) | - -## debug - -Internal information related to debugging. - -`debug` - -- is optional -- type: `object` -- defined in this schema - -### debug Type - -`object` with following properties: - -| Property | Type | Required | -| -------- | ---- | -------- | - - -## logger - -A helix-log [SimpleInterface](https://github.com/adobe/helix-log) logger instance. - -`logger` - -- is optional -- type: `object` -- defined in this schema - -### logger Type - -`object` with following properties: - -| Property | Type | Required | -| -------- | ---- | -------- | - - -## request - -`request` - -- is optional -- type: Raw Request -- defined in this schema - -### request Type - -- [Raw Request](rawrequest.schema.md) – `https://ns.adobe.com/helix/pipeline/rawrequest` - -## secrets - -`secrets` - -- is optional -- type: Secrets -- defined in this schema - -### secrets Type - -- [Secrets](secrets.schema.md) – `https://ns.adobe.com/helix/pipeline/secrets` - -## transformer - -A VDOMTransformer instance - -`transformer` - -- is optional -- type: `object` -- defined in this schema - -### transformer Type - -`object` with following properties: - -| Property | Type | Required | -| -------- | ---- | -------- | - diff --git a/docs/content-properties-body.md b/docs/content-properties-body.md new file mode 100644 index 000000000..75ef4a516 --- /dev/null +++ b/docs/content-properties-body.md @@ -0,0 +1,16 @@ +# Untitled string in Content Schema + +```txt +https://ns.adobe.com/helix/pipeline/content#/properties/body +``` + +The content body of the retrieved source document + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [content.schema.json\*](content.schema.json "open original schema") | + +## body Type + +`string` diff --git a/docs/content-properties-data.md b/docs/content-properties-data.md new file mode 100644 index 000000000..c3d524d4f --- /dev/null +++ b/docs/content-properties-data.md @@ -0,0 +1,16 @@ +# Untitled object in Content Schema + +```txt +https://ns.adobe.com/helix/pipeline/content#/properties/data +``` + +Custom object that can hold any user defined data. + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [content.schema.json\*](content.schema.json "open original schema") | + +## data Type + +`object` ([Details](content-properties-data.md)) diff --git a/docs/content-properties-document.md b/docs/content-properties-document.md new file mode 100644 index 000000000..5626f2848 --- /dev/null +++ b/docs/content-properties-document.md @@ -0,0 +1,16 @@ +# Untitled object in Content Schema + +```txt +https://ns.adobe.com/helix/pipeline/content#/properties/document +``` + +The DOM-compatible representation of the document's inner HTML + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [content.schema.json\*](content.schema.json "open original schema") | + +## document Type + +`object` ([Details](content-properties-document.md)) diff --git a/docs/content-properties-image.md b/docs/content-properties-image.md new file mode 100644 index 000000000..efadf34b1 --- /dev/null +++ b/docs/content-properties-image.md @@ -0,0 +1,20 @@ +# Untitled string in Content Schema + +```txt +https://ns.adobe.com/helix/pipeline/content#/properties/image +``` + +Path (can be relative) to the first image in the document + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [content.schema.json\*](content.schema.json "open original schema") | + +## image Type + +`string` + +## image Constraints + +**URI reference**: the string must be a URI reference, according to [RFC 3986](https://tools.ietf.org/html/rfc4291 "check the specification") diff --git a/docs/content-properties-intro.md b/docs/content-properties-intro.md new file mode 100644 index 000000000..4da69f240 --- /dev/null +++ b/docs/content-properties-intro.md @@ -0,0 +1,16 @@ +# Untitled string in Content Schema + +```txt +https://ns.adobe.com/helix/pipeline/content#/properties/intro +``` + +Extracted first paragraph of the document + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [content.schema.json\*](content.schema.json "open original schema") | + +## intro Type + +`string` diff --git a/docs/content-properties-json.md b/docs/content-properties-json.md new file mode 100644 index 000000000..7ce1bb410 --- /dev/null +++ b/docs/content-properties-json.md @@ -0,0 +1,16 @@ +# Untitled object in Content Schema + +```txt +https://ns.adobe.com/helix/pipeline/content#/properties/json +``` + +The JSON object to emit. + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [content.schema.json\*](content.schema.json "open original schema") | + +## json Type + +`object` ([Details](content-properties-json.md)) diff --git a/docs/content-properties-mdast.md b/docs/content-properties-mdast.md new file mode 100644 index 000000000..12b8edb78 --- /dev/null +++ b/docs/content-properties-mdast.md @@ -0,0 +1,500 @@ +# MDAST Schema + +```txt +https://ns.adobe.com/helix/pipeline/mdast#/properties/mdast +``` + +A node in the Markdown AST + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | ------ | ------------ | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Stable | No | Forbidden | Forbidden | none | [content.schema.json\*](content.schema.json "open original schema") | + +## mdast Type + +`object` ([MDAST](content-properties-mdast.md)) + +# MDAST Properties + +| Property | Type | Required | Nullable | Defined by | +| :------------------------------ | ------------- | -------- | -------------- | :----------------------------------------------------------------------------------------------------------------------------------- | +| [type](#type) | Not specified | Optional | cannot be null | [MDAST](mdast-properties-type.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/type") | +| [children](#children) | `array` | Optional | cannot be null | [MDAST](mdast-properties-children.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/children") | +| [position](#position) | `object` | Optional | cannot be null | [MDAST](section-definitions-section-properties-position.md "https://ns.adobe.com/helix/pipeline/position#/properties/position") | +| [value](#value) | `string` | Optional | cannot be null | [MDAST](mdast-properties-value.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/value") | +| [payload](#payload) | `object` | Optional | cannot be null | [MDAST](mdast-properties-payload.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/payload") | +| [depth](#depth) | `integer` | Optional | cannot be null | [MDAST](mdast-properties-depth.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/depth") | +| [ordered](#ordered) | `boolean` | Optional | cannot be null | [MDAST](mdast-properties-ordered.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/ordered") | +| [start](#start) | `integer` | Optional | can be null | [MDAST](mdast-properties-start.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/start") | +| [spread](#spread) | `boolean` | Optional | can be null | [MDAST](mdast-properties-spread.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/spread") | +| [checked](#checked) | `boolean` | Optional | can be null | [MDAST](mdast-properties-checked.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/checked") | +| [align](#align) | `array` | Optional | cannot be null | [MDAST](mdast-properties-align.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/align") | +| [lang](#lang) | `string` | Optional | can be null | [MDAST](mdast-properties-lang.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/lang") | +| [identifier](#identifier) | `string` | Optional | cannot be null | [MDAST](mdast-properties-identifier.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/identifier") | +| [label](#label) | `string` | Optional | cannot be null | [MDAST](mdast-properties-label.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/label") | +| [url](#url) | `string` | Optional | cannot be null | [MDAST](mdast-properties-url.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/url") | +| [meta](#meta) | `object` | Optional | can be null | [MDAST](meta-definitions-meta.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/meta") | +| [title](#title) | `string` | Optional | can be null | [MDAST](mdast-properties-title.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/title") | +| [code](#code) | `string` | Optional | cannot be null | [MDAST](mdast-properties-code.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/code") | +| [intro](#intro) | `string` | Optional | can be null | [MDAST](mdast-properties-intro.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/intro") | +| [image](#image) | `string` | Optional | can be null | [MDAST](mdast-properties-image.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/image") | +| [types](#types) | `array` | Optional | cannot be null | [MDAST](mdast-properties-types.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/types") | +| [alt](#alt) | `string` | Optional | can be null | [MDAST](mdast-properties-alt.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/alt") | +| [referenceType](#referenceType) | Not specified | Optional | cannot be null | [MDAST](mdast-properties-referencetype.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/referenceType") | +| [data](#data) | `object` | Optional | cannot be null | [MDAST](mdast-properties-data.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/data") | + +## type + +The node type of the MDAST node + + +`type` + +- is optional +- Type: unknown +- cannot be null +- defined in: [MDAST](mdast-properties-type.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/type") + +### type Type + +unknown + +### type Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :--------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `"root"` | The root node, representing a document or section | +| `"paragraph"` | A paragraph. Note: standalone \`image\` blocks are often wrapped in a \`paragraph\` | +| `"text"` | Plain text | +| `"heading"` | A heading with heading level | +| `"thematicBreak"` | A section break | +| `"blockquote"` | A blockquote | +| `"list"` | An ordered or unordered list | +| `"listItem"` | | +| `"table"` | A table | +| `"tableRow"` | A row in a table | +| `"tableCell"` | A cell in a table | +| `"html"` | Raw HTML embedded in Markdown. Disabled by default. | +| `"code"` | A code block | +| `"yaml"` | A metadata block. If the block is not at the top of the document, it will start a new section. | +| `"definition"` | A definition that can be referenced | +| `"footnoteDefinition"` | A footnote | +| `"emphasis"` | emphasis (often in italics) | +| `"strong"` | strong (often in bold type) | +| `"delete"` | deleted content | +| `"inlineCode"` | inline code | +| `"break"` | A line break | +| `"link"` | A hyperlink | +| `"image"` | An image | +| `"linkReference"` | A pointer to a link | +| `"imageReference"` | A pointer to an image | +| `"footnote"` | A footnote | +| `"footnoteReference"` | A reference to a footnote | +| `"embed"` | Content embedded from another page, identified by the \`url\` attribute. | +| `"section"` | A section within the document. Sections serve as a high-level structure of a single markdown document and can have their own section-specific front matter metadata. | +| `"icon"` | An SVG icon, identified by the syntax \`:foo:\` | + +## children + + + + +`children` + +- is optional +- Type: an array of merged types ([Details](mdast-properties-children-items.md)) +- cannot be null +- defined in: [MDAST](mdast-properties-children.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/children") + +### children Type + +an array of merged types ([Details](mdast-properties-children-items.md)) + +## position + +Marks the position of an AST node in the original text flow + + +`position` + +- is optional +- Type: `object` ([Position](section-definitions-section-properties-position.md)) +- cannot be null +- defined in: [MDAST](section-definitions-section-properties-position.md "https://ns.adobe.com/helix/pipeline/position#/properties/position") + +### position Type + +`object` ([Position](section-definitions-section-properties-position.md)) + +## value + +The string value of the node, if it is a terminal node. + + +`value` + +- is optional +- Type: `string` +- cannot be null +- defined in: [MDAST](mdast-properties-value.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/value") + +### value Type + +`string` + +## payload + +The payload of a frontmatter/yaml block + + +`payload` + +- is optional +- Type: `object` ([Details](mdast-properties-payload.md)) +- cannot be null +- defined in: [MDAST](mdast-properties-payload.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/payload") + +### payload Type + +`object` ([Details](mdast-properties-payload.md)) + +## depth + +The heading level + + +`depth` + +- is optional +- Type: `integer` +- cannot be null +- defined in: [MDAST](mdast-properties-depth.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/depth") + +### depth Type + +`integer` + +### depth Constraints + +**maximum**: the value of this number must smaller than or equal to: `6` + +**minimum**: the value of this number must greater than or equal to: `1` + +## ordered + +Is the list ordered + + +`ordered` + +- is optional +- Type: `boolean` +- cannot be null +- defined in: [MDAST](mdast-properties-ordered.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/ordered") + +### ordered Type + +`boolean` + +## start + +Starting item of the list + + +`start` + +- is optional +- Type: `integer` +- can be null +- defined in: [MDAST](mdast-properties-start.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/start") + +### start Type + +`integer` + +## spread + +A spread field can be present. It represents that any of its items is separated by a blank line from its siblings or contains two or more children (when true), or not (when false or not present). + + +`spread` + +- is optional +- Type: `boolean` +- can be null +- defined in: [MDAST](mdast-properties-spread.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/spread") + +### spread Type + +`boolean` + +## checked + +A checked field can be present. It represents whether the item is done (when true), not done (when false), or indeterminate or not applicable (when null or not present). + + +`checked` + +- is optional +- Type: `boolean` +- can be null +- defined in: [MDAST](mdast-properties-checked.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/checked") + +### checked Type + +`boolean` + +## align + +For tables, an align field can be present. If present, it must be a list of alignTypes. It represents how cells in columns are aligned. + + +`align` + +- is optional +- Type: `string[]` +- cannot be null +- defined in: [MDAST](mdast-properties-align.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/align") + +### align Type + +`string[]` + +## lang + +For code, a lang field can be present. It represents the language of computer code being marked up. + + +`lang` + +- is optional +- Type: `string` +- can be null +- defined in: [MDAST](mdast-properties-lang.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/lang") + +### lang Type + +`string` + +## identifier + +For associations, an identifier field must be present. It can match an identifier field on another node. + + +`identifier` + +- is optional +- Type: `string` +- cannot be null +- defined in: [MDAST](mdast-properties-identifier.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/identifier") + +### identifier Type + +`string` + +## label + +For associations, a label field can be present. It represents the original value of the normalised identifier field. + + +`label` + +- is optional +- Type: `string` +- cannot be null +- defined in: [MDAST](mdast-properties-label.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/label") + +### label Type + +`string` + +## url + +For resources, an url field must be present. It represents a URL to the referenced resource. + + +`url` + +- is optional +- Type: `string` +- cannot be null +- defined in: [MDAST](mdast-properties-url.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/url") + +### url Type + +`string` + +### url Constraints + +**URI reference**: the string must be a URI reference, according to [RFC 3986](https://tools.ietf.org/html/rfc4291 "check the specification") + +## meta + + + + +`meta` + +- is optional +- Type: `object` ([Details](meta-definitions-meta.md)) +- can be null +- defined in: [MDAST](meta-definitions-meta.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/meta") + +### meta Type + +`object` ([Details](meta-definitions-meta.md)) + +## title + +Extracted title of the document + + +`title` + +- is optional +- Type: `string` +- can be null +- defined in: [MDAST](mdast-properties-title.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/title") + +### title Type + +`string` + +## code + +Icon code + + +`code` + +- is optional +- Type: `string` +- cannot be null +- defined in: [MDAST](mdast-properties-code.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/code") + +### code Type + +`string` + +### code Constraints + +**pattern**: the string must match the following regular expression: + +```regexp +:[a-zA-Z0-9_-]+: +``` + +[try pattern](https://regexr.com/?expression=%3A%5Ba-zA-Z0-9_-%5D%2B%3A "try regular expression with regexr.com") + +## intro + +Extracted first paragraph of the document + + +`intro` + +- is optional +- Type: `string` +- can be null +- defined in: [MDAST](mdast-properties-intro.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/intro") + +### intro Type + +`string` + +## image + +Path (can be relative) to the first image in the document + + +`image` + +- is optional +- Type: `string` +- can be null +- defined in: [MDAST](mdast-properties-image.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/image") + +### image Type + +`string` + +### image Constraints + +**URI reference**: the string must be a URI reference, according to [RFC 3986](https://tools.ietf.org/html/rfc4291 "check the specification") + +## types + +The inferred class names for the section + + +`types` + +- is optional +- Type: `string[]` +- cannot be null +- defined in: [MDAST](mdast-properties-types.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/types") + +### types Type + +`string[]` + +## alt + +An alt field should be present. It represents equivalent content for environments that cannot represent the node as intended. + + +`alt` + +- is optional +- Type: `string` +- can be null +- defined in: [MDAST](mdast-properties-alt.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/alt") + +### alt Type + +`string` + +## referenceType + +Represents the explicitness of a reference. + + +`referenceType` + +- is optional +- Type: unknown +- cannot be null +- defined in: [MDAST](mdast-properties-referencetype.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/referenceType") + +### referenceType Type + +unknown + +### referenceType Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :------------ | ------------------------------------------------------------------- | +| `"shortcut"` | the reference is implicit, its identifier inferred from its content | +| `"collapsed"` | the reference is explicit, its identifier inferred from its content | +| `"full"` | the reference is explicit, its identifier explicitly set | + +## data + +data is guaranteed to never be specified by unist or specifications implementing unist. Free data space. + + +`data` + +- is optional +- Type: `object` ([Details](mdast-properties-data.md)) +- cannot be null +- defined in: [MDAST](mdast-properties-data.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/data") + +### data Type + +`object` ([Details](mdast-properties-data.md)) diff --git a/docs/content-properties-sources-items.md b/docs/content-properties-sources-items.md new file mode 100644 index 000000000..91be0a4eb --- /dev/null +++ b/docs/content-properties-sources-items.md @@ -0,0 +1,20 @@ +# Untitled string in Content Schema + +```txt +https://ns.adobe.com/helix/pipeline/content#/properties/sources/items +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [content.schema.json\*](content.schema.json "open original schema") | + +## items Type + +`string` + +## items Constraints + +**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc4291 "check the specification") diff --git a/docs/content-properties-sources.md b/docs/content-properties-sources.md new file mode 100644 index 000000000..deacf33ed --- /dev/null +++ b/docs/content-properties-sources.md @@ -0,0 +1,16 @@ +# Untitled array in Content Schema + +```txt +https://ns.adobe.com/helix/pipeline/content#/properties/sources +``` + +List of URIs that have been retrieved for this piece of content + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [content.schema.json\*](content.schema.json "open original schema") | + +## sources Type + +`string[]` diff --git a/docs/content-properties-title.md b/docs/content-properties-title.md new file mode 100644 index 000000000..f2b91aa0e --- /dev/null +++ b/docs/content-properties-title.md @@ -0,0 +1,16 @@ +# Untitled string in Content Schema + +```txt +https://ns.adobe.com/helix/pipeline/content#/properties/title +``` + +Extracted title of the document + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [content.schema.json\*](content.schema.json "open original schema") | + +## title Type + +`string` diff --git a/docs/content-properties-xml.md b/docs/content-properties-xml.md new file mode 100644 index 000000000..cc4def689 --- /dev/null +++ b/docs/content-properties-xml.md @@ -0,0 +1,16 @@ +# Untitled object in Content Schema + +```txt +https://ns.adobe.com/helix/pipeline/content#/properties/xml +``` + +The XML object to emit. See xmlbuilder-js for syntax. + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [content.schema.json\*](content.schema.json "open original schema") | + +## xml Type + +`object` ([Details](content-properties-xml.md)) diff --git a/docs/content-properties.md b/docs/content-properties.md new file mode 100644 index 000000000..7774c5f0d --- /dev/null +++ b/docs/content-properties.md @@ -0,0 +1,16 @@ +# \[object Object] Schema + +```txt +https://ns.adobe.com/helix/pipeline/content#/properties +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [content.schema.json\*](content.schema.json "open original schema") | + +## properties Type + +unknown diff --git a/docs/content.md b/docs/content.md new file mode 100644 index 000000000..fcf168459 --- /dev/null +++ b/docs/content.md @@ -0,0 +1,212 @@ +# Content Schema + +```txt +https://ns.adobe.com/helix/pipeline/content +``` + +The content as retrieved from the repository and enriched in the pipeline. + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | ----------- | ------------ | :---------------- | --------------------- | ------------------- | ----------------------------------------------------------------- | +| Can be instantiated | No | Stabilizing | No | Forbidden | Forbidden | none | [content.schema.json](content.schema.json "open original schema") | + +## Content Type + +`object` ([Content](content.md)) + +# Content Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------------- | -------- | -------- | -------------- | :---------------------------------------------------------------------------------------------------------------- | +| [sources](#sources) | `array` | Optional | cannot be null | [Content](content-properties-sources.md "https://ns.adobe.com/helix/pipeline/content#/properties/sources") | +| [body](#body) | `string` | Optional | cannot be null | [Content](content-properties-body.md "https://ns.adobe.com/helix/pipeline/content#/properties/body") | +| [mdast](#mdast) | `object` | Optional | cannot be null | [Content](content-properties-mdast.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/mdast") | +| [document](#document) | `object` | Optional | cannot be null | [Content](content-properties-document.md "https://ns.adobe.com/helix/pipeline/content#/properties/document") | +| [json](#json) | `object` | Optional | cannot be null | [Content](content-properties-json.md "https://ns.adobe.com/helix/pipeline/content#/properties/json") | +| [xml](#xml) | `object` | Optional | cannot be null | [Content](content-properties-xml.md "https://ns.adobe.com/helix/pipeline/content#/properties/xml") | +| [meta](#meta) | `object` | Optional | can be null | [Content](meta-definitions-meta.md "https://ns.adobe.com/helix/pipeline/content#/properties/meta") | +| [title](#title) | `string` | Optional | cannot be null | [Content](content-properties-title.md "https://ns.adobe.com/helix/pipeline/content#/properties/title") | +| [intro](#intro) | `string` | Optional | cannot be null | [Content](content-properties-intro.md "https://ns.adobe.com/helix/pipeline/content#/properties/intro") | +| [image](#image) | `string` | Optional | cannot be null | [Content](content-properties-image.md "https://ns.adobe.com/helix/pipeline/content#/properties/image") | +| [data](#data) | `object` | Optional | cannot be null | [Content](content-properties-data.md "https://ns.adobe.com/helix/pipeline/content#/properties/data") | + +## sources + +List of URIs that have been retrieved for this piece of content + + +`sources` + +- is optional +- Type: `string[]` +- cannot be null +- defined in: [Content](content-properties-sources.md "https://ns.adobe.com/helix/pipeline/content#/properties/sources") + +### sources Type + +`string[]` + +## body + +The content body of the retrieved source document + + +`body` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Content](content-properties-body.md "https://ns.adobe.com/helix/pipeline/content#/properties/body") + +### body Type + +`string` + +## mdast + +A node in the Markdown AST + + +`mdast` + +- is optional +- Type: `object` ([MDAST](content-properties-mdast.md)) +- cannot be null +- defined in: [Content](content-properties-mdast.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/mdast") + +### mdast Type + +`object` ([MDAST](content-properties-mdast.md)) + +## document + +The DOM-compatible representation of the document's inner HTML + + +`document` + +- is optional +- Type: `object` ([Details](content-properties-document.md)) +- cannot be null +- defined in: [Content](content-properties-document.md "https://ns.adobe.com/helix/pipeline/content#/properties/document") + +### document Type + +`object` ([Details](content-properties-document.md)) + +## json + +The JSON object to emit. + + +`json` + +- is optional +- Type: `object` ([Details](content-properties-json.md)) +- cannot be null +- defined in: [Content](content-properties-json.md "https://ns.adobe.com/helix/pipeline/content#/properties/json") + +### json Type + +`object` ([Details](content-properties-json.md)) + +## xml + +The XML object to emit. See xmlbuilder-js for syntax. + + +`xml` + +- is optional +- Type: `object` ([Details](content-properties-xml.md)) +- cannot be null +- defined in: [Content](content-properties-xml.md "https://ns.adobe.com/helix/pipeline/content#/properties/xml") + +### xml Type + +`object` ([Details](content-properties-xml.md)) + +## meta + + + + +`meta` + +- is optional +- Type: `object` ([Details](meta-definitions-meta.md)) +- can be null +- defined in: [Content](meta-definitions-meta.md "https://ns.adobe.com/helix/pipeline/content#/properties/meta") + +### meta Type + +`object` ([Details](meta-definitions-meta.md)) + +## title + +Extracted title of the document + + +`title` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Content](content-properties-title.md "https://ns.adobe.com/helix/pipeline/content#/properties/title") + +### title Type + +`string` + +## intro + +Extracted first paragraph of the document + + +`intro` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Content](content-properties-intro.md "https://ns.adobe.com/helix/pipeline/content#/properties/intro") + +### intro Type + +`string` + +## image + +Path (can be relative) to the first image in the document + + +`image` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Content](content-properties-image.md "https://ns.adobe.com/helix/pipeline/content#/properties/image") + +### image Type + +`string` + +### image Constraints + +**URI reference**: the string must be a URI reference, according to [RFC 3986](https://tools.ietf.org/html/rfc4291 "check the specification") + +## data + +Custom object that can hold any user defined data. + + +`data` + +- is optional +- Type: `object` ([Details](content-properties-data.md)) +- cannot be null +- defined in: [Content](content-properties-data.md "https://ns.adobe.com/helix/pipeline/content#/properties/data") + +### data Type + +`object` ([Details](content-properties-data.md)) diff --git a/docs/content.schema.json b/docs/content.schema.json index d6a1ddab9..69c86b2cc 100644 --- a/docs/content.schema.json +++ b/docs/content.schema.json @@ -1,65 +1 @@ -{ - "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/pipeline/content", - "$schema": "http://json-schema.org/draft-07/schema#", - "title": "Content", - "meta:status": "stabilizing", - "type": "object", - "description": "The content as retrieved from the repository and enriched in the pipeline.", - "additionalProperties": false, - "properties": { - "sources": { - "type": "array", - "description": "List of URIs that have been retrieved for this piece of content", - "items": { - "type": "string", - "format": "uri" - } - }, - "body": { - "type": "string", - "description": "The content body of the retrieved source document" - }, - "mdast": { - "$ref": "https://ns.adobe.com/helix/pipeline/mdast" - }, - "document": { - "type": "object", - "description": "The DOM-compatible representation of the document's inner HTML" - }, - "json": { - "type": "object", - "description": "The JSON object to emit." - }, - "xml": { - "type": "object", - "description": "The XML object to emit. See xmlbuilder-js for syntax." - }, - "meta": { - "$ref": "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta" - }, - "title": { - "$ref": "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/title" - }, - "intro": { - "$ref": "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/intro" - }, - "image": { - "$ref": "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/image" - }, - "data": { - "type": "object", - "description": "Custom object that can hold any user defined data." - } - } -} \ No newline at end of file +{"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/pipeline/content","$schema":"http://json-schema.org/draft-07/schema#","title":"Content","meta:status":"stabilizing","type":"object","description":"The content as retrieved from the repository and enriched in the pipeline.","additionalProperties":false,"properties":{"sources":{"type":"array","description":"List of URIs that have been retrieved for this piece of content","items":{"type":"string","format":"uri"}},"body":{"type":"string","description":"The content body of the retrieved source document"},"mdast":{"$ref":"https://ns.adobe.com/helix/pipeline/mdast"},"document":{"type":"object","description":"The DOM-compatible representation of the document's inner HTML"},"json":{"type":"object","description":"The JSON object to emit."},"xml":{"type":"object","description":"The XML object to emit. See xmlbuilder-js for syntax."},"meta":{"$ref":"https://ns.adobe.com/helix/pipeline/meta#/definitions/meta"},"title":{"$ref":"https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/title"},"intro":{"$ref":"https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/intro"},"image":{"$ref":"https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/image"},"data":{"type":"object","description":"Custom object that can hold any user defined data."}}} diff --git a/docs/content.schema.md b/docs/content.schema.md deleted file mode 100644 index 6398bcad8..000000000 --- a/docs/content.schema.md +++ /dev/null @@ -1,296 +0,0 @@ -# Content Schema - -``` -https://ns.adobe.com/helix/pipeline/content -``` - -The content as retrieved from the repository and enriched in the pipeline. - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Defined In | -| ------------------- | ---------- | ----------- | ------------ | ----------------- | --------------------- | ------------------------------------------ | -| Can be instantiated | No | Stabilizing | No | Forbidden | Forbidden | [content.schema.json](content.schema.json) | - -## Schema Hierarchy - -- Content `https://ns.adobe.com/helix/pipeline/content` - - [MDAST](mdast.schema.md) `https://ns.adobe.com/helix/pipeline/mdast` - - [Meta](meta.schema.md) `https://ns.adobe.com/helix/pipeline/meta` - -# Content Properties - -| Property | Type | Required | Nullable | Defined by | -| --------------------- | ---------- | -------- | -------- | --------------------- | -| [body](#body) | `string` | Optional | No | Content (this schema) | -| [data](#data) | `object` | Optional | No | Content (this schema) | -| [document](#document) | `object` | Optional | No | Content (this schema) | -| [image](#image) | `string` | Optional | No | Content (this schema) | -| [intro](#intro) | `string` | Optional | No | Content (this schema) | -| [json](#json) | `object` | Optional | No | Content (this schema) | -| [mdast](#mdast) | MDAST | Optional | No | Content (this schema) | -| [meta](#meta) | `object` | Optional | Yes | Content (this schema) | -| [sources](#sources) | `string[]` | Optional | No | Content (this schema) | -| [title](#title) | `string` | Optional | No | Content (this schema) | -| [xml](#xml) | `object` | Optional | No | Content (this schema) | - -## body - -The content body of the retrieved source document - -`body` - -- is optional -- type: `string` -- defined in this schema - -### body Type - -`string` - -## data - -Custom object that can hold any user defined data. - -`data` - -- is optional -- type: `object` -- defined in this schema - -### data Type - -`object` with following properties: - -| Property | Type | Required | -| -------- | ---- | -------- | - - -## document - -The DOM-compatible representation of the document's inner HTML - -`document` - -- is optional -- type: `object` -- defined in this schema - -### document Type - -`object` with following properties: - -| Property | Type | Required | -| -------- | ---- | -------- | - - -## image - -Path (can be relative) to the first image in the document - -`image` - -- is optional -- type: `string` -- defined in this schema - -### image Type - -`string` - -- format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) - -## intro - -Extracted first paragraph of the document - -`intro` - -- is optional -- type: `string` -- defined in this schema - -### intro Type - -`string` - -## json - -The JSON object to emit. - -`json` - -- is optional -- type: `object` -- defined in this schema - -### json Type - -`object` with following properties: - -| Property | Type | Required | -| -------- | ---- | -------- | - - -## mdast - -`mdast` - -- is optional -- type: MDAST -- defined in this schema - -### mdast Type - -- [MDAST](mdast.schema.md) – `https://ns.adobe.com/helix/pipeline/mdast` - -## meta - -`meta` - -- is optional -- type: `object` -- defined in this schema - -### meta Type - -`object`, nullable, with following properties: - -| Property | Type | Required | -| --------- | ------ | -------- | -| `class` | string | Optional | -| `image` | string | Optional | -| `intro` | string | Optional | -| `tagname` | string | Optional | -| `title` | string | Optional | -| `types` | array | Optional | - -#### class - -The CSS class to use for the section instead of the default `hlx-section` one - -`class` - -- is optional -- type: `string` - -##### class Type - -`string` - -#### image - -Path (can be relative) to the first image in the document - -`image` - -- is optional -- type: `string` - -##### image Type - -`string` - -- format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) - -#### intro - -Extracted first paragraph of the document - -`intro` - -- is optional -- type: `string` - -##### intro Type - -`string` - -#### tagname - -The element tag name to use for the section instead of the default `div` one (i.e. `section`, `main`, `aside`) - -`tagname` - -- is optional -- type: `string` - -##### tagname Type - -`string` - -#### title - -Extracted title of the document - -`title` - -- is optional -- type: `string` - -##### title Type - -`string` - -#### types - -The inferred class names for the section - -`types` - -- is optional -- type: `string[]` - -##### types Type - -Array type: `string[]` - -All items must be of the type: `string` - -## sources - -List of URIs that have been retrieved for this piece of content - -`sources` - -- is optional -- type: `string[]` -- defined in this schema - -### sources Type - -Array type: `string[]` - -All items must be of the type: `string` - -- format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) - -## title - -Extracted title of the document - -`title` - -- is optional -- type: `string` -- defined in this schema - -### title Type - -`string` - -## xml - -The XML object to emit. See xmlbuilder-js for syntax. - -`xml` - -- is optional -- type: `object` -- defined in this schema - -### xml Type - -`object` with following properties: - -| Property | Type | Required | -| -------- | ---- | -------- | - diff --git a/docs/context-properties-error.md b/docs/context-properties-error.md new file mode 100644 index 000000000..f0420f441 --- /dev/null +++ b/docs/context-properties-error.md @@ -0,0 +1,17 @@ +# Untitled undefined type in Context Schema + +```txt +https://ns.adobe.com/helix/pipeline/context#/properties/error +``` + +An error message that has been generated during pipeline processing. +When this property is present, all other values can be ignored. + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [context.schema.json\*](context.schema.json "open original schema") | + +## error Type + +any of the folllowing: `string` or `object` ([Details](context-properties-error.md)) diff --git a/docs/context-properties-request.md b/docs/context-properties-request.md new file mode 100644 index 000000000..121c2e83c --- /dev/null +++ b/docs/context-properties-request.md @@ -0,0 +1,241 @@ +# Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/request#/properties/request +``` + +The HTTP Request + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | ----------- | ------------ | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Stabilizing | No | Forbidden | Forbidden | none | [context.schema.json\*](context.schema.json "open original schema") | + +## request Type + +`object` ([Request](context-properties-request.md)) + +# Request Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------------------- | ------------- | -------- | -------------- | :---------------------------------------------------------------------------------------------------------------------- | +| [url](#url) | `string` | Optional | cannot be null | [Request](request-properties-url.md "https://ns.adobe.com/helix/pipeline/request#/properties/url") | +| [path](#path) | `string` | Optional | cannot be null | [Request](request-properties-path.md "https://ns.adobe.com/helix/pipeline/request#/properties/path") | +| [pathInfo](#pathInfo) | `string` | Optional | cannot be null | [Request](request-properties-pathinfo.md "https://ns.adobe.com/helix/pipeline/request#/properties/pathInfo") | +| [rootPath](#rootPath) | `string` | Optional | cannot be null | [Request](request-properties-rootpath.md "https://ns.adobe.com/helix/pipeline/request#/properties/rootPath") | +| [selector](#selector) | `string` | Optional | cannot be null | [Request](request-properties-selector.md "https://ns.adobe.com/helix/pipeline/request#/properties/selector") | +| [extension](#extension) | `string` | Optional | cannot be null | [Request](request-properties-extension.md "https://ns.adobe.com/helix/pipeline/request#/properties/extension") | +| [method](#method) | `string` | Optional | cannot be null | [Request](request-properties-method.md "https://ns.adobe.com/helix/pipeline/request#/properties/method") | +| [headers](#headers) | Not specified | Optional | cannot be null | [Request](request-properties-headers.md "https://ns.adobe.com/helix/pipeline/request#/properties/headers") | +| [params](#params) | `object` | Optional | cannot be null | [Request](request-properties-params.md "https://ns.adobe.com/helix/pipeline/request#/properties/params") | +| [queryString](#queryString) | `string` | Optional | cannot be null | [Request](request-properties-querystring.md "https://ns.adobe.com/helix/pipeline/request#/properties/queryString") | + +## url + +The path and request parameters of the client request URL + + +`url` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Request](request-properties-url.md "https://ns.adobe.com/helix/pipeline/request#/properties/url") + +### url Type + +`string` + +### url Examples + +```json +"/docs/api/general/index.nav.html?a=1" +``` + +## path + +The path of the client request URL + + +`path` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Request](request-properties-path.md "https://ns.adobe.com/helix/pipeline/request#/properties/path") + +### path Type + +`string` + +### path Examples + +```json +"/docs/api/general/index.nav.html" +``` + +## pathInfo + +The part of the client path that is relative to the rootPath + + +`pathInfo` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Request](request-properties-pathinfo.md "https://ns.adobe.com/helix/pipeline/request#/properties/pathInfo") + +### pathInfo Type + +`string` + +### pathInfo Examples + +```json +"/general/index.nav.html" +``` + +## rootPath + +The request root path of the current strain. + + +`rootPath` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Request](request-properties-rootpath.md "https://ns.adobe.com/helix/pipeline/request#/properties/rootPath") + +### rootPath Type + +`string` + +### rootPath Examples + +```json +"/docs/api" +``` + +## selector + +The selector (sub-type indicator) + + +`selector` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Request](request-properties-selector.md "https://ns.adobe.com/helix/pipeline/request#/properties/selector") + +### selector Type + +`string` + +### selector Examples + +```json +"" +``` + +```json +"nav" +``` + +## extension + +The extension of the requested resource + + +`extension` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Request](request-properties-extension.md "https://ns.adobe.com/helix/pipeline/request#/properties/extension") + +### extension Type + +`string` + +### extension Examples + +```json +"html" +``` + +```json +"json" +``` + +## method + +The HTTP method of the request. Note: method names can be lower-case. + + +`method` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Request](request-properties-method.md "https://ns.adobe.com/helix/pipeline/request#/properties/method") + +### method Type + +`string` + +## headers + +The HTTP headers of the request. Note: all header names will be lower-case. + + +`headers` + +- is optional +- Type: unknown +- cannot be null +- defined in: [Request](request-properties-headers.md "https://ns.adobe.com/helix/pipeline/request#/properties/headers") + +### headers Type + +unknown + +## params + +The passed through (and filtered) URL parameters of the request + + +`params` + +- is optional +- Type: `object` ([Details](request-properties-params.md)) +- cannot be null +- defined in: [Request](request-properties-params.md "https://ns.adobe.com/helix/pipeline/request#/properties/params") + +### params Type + +`object` ([Details](request-properties-params.md)) + +## queryString + +The original query string + + +`queryString` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Request](request-properties-querystring.md "https://ns.adobe.com/helix/pipeline/request#/properties/queryString") + +### queryString Type + +`string` + +### queryString Examples + +```json +"?parameter1=foo¶meter2=bar" +``` diff --git a/docs/context-properties-response.md b/docs/context-properties-response.md new file mode 100644 index 000000000..36de8b988 --- /dev/null +++ b/docs/context-properties-response.md @@ -0,0 +1,94 @@ +# Response Schema + +```txt +https://ns.adobe.com/helix/pipeline/response#/properties/response +``` + +The HTTP response object + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | ----------- | ------------ | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Stabilizing | No | Forbidden | Forbidden | none | [context.schema.json\*](context.schema.json "open original schema") | + +## response Type + +`object` ([Response](context-properties-response.md)) + +# Response Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------------- | ------------- | -------- | -------------- | :------------------------------------------------------------------------------------------------------------------- | +| [status](#status) | `integer` | Optional | cannot be null | [Response](response-properties-status.md "https://ns.adobe.com/helix/pipeline/response#/properties/status") | +| [body](#body) | Merged | Optional | cannot be null | [Response](response-properties-body.md "https://ns.adobe.com/helix/pipeline/response#/properties/body") | +| [document](#document) | `object` | Optional | cannot be null | [Response](response-properties-document.md "https://ns.adobe.com/helix/pipeline/response#/properties/document") | +| [headers](#headers) | Not specified | Optional | cannot be null | [Response](response-properties-headers.md "https://ns.adobe.com/helix/pipeline/response#/properties/headers") | + +## status + +The HTTP status code + + +`status` + +- is optional +- Type: `integer` +- cannot be null +- defined in: [Response](response-properties-status.md "https://ns.adobe.com/helix/pipeline/response#/properties/status") + +### status Type + +`integer` + +## body + + + + +`body` + +- is optional +- Type: merged type ([Details](response-properties-body.md)) +- cannot be null +- defined in: [Response](response-properties-body.md "https://ns.adobe.com/helix/pipeline/response#/properties/body") + +### body Type + +merged type ([Details](response-properties-body.md)) + +any of + +- [Untitled undefined type in Response](response-properties-body-anyof-0.md "check type definition") +- [Untitled object in Response](response-properties-body-anyof-1.md "check type definition") + +## document + +The DOM-compatible representation of the response document + + +`document` + +- is optional +- Type: `object` ([Details](response-properties-document.md)) +- cannot be null +- defined in: [Response](response-properties-document.md "https://ns.adobe.com/helix/pipeline/response#/properties/document") + +### document Type + +`object` ([Details](response-properties-document.md)) + +## headers + +The HTTP headers of the response + + +`headers` + +- is optional +- Type: unknown +- cannot be null +- defined in: [Response](response-properties-headers.md "https://ns.adobe.com/helix/pipeline/response#/properties/headers") + +### headers Type + +unknown diff --git a/docs/context-properties.md b/docs/context-properties.md new file mode 100644 index 000000000..5fa9c6b80 --- /dev/null +++ b/docs/context-properties.md @@ -0,0 +1,16 @@ +# Untitled undefined type in Context Schema + +```txt +https://ns.adobe.com/helix/pipeline/context#/properties +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [context.schema.json\*](context.schema.json "open original schema") | + +## properties Type + +unknown diff --git a/docs/context.md b/docs/context.md new file mode 100644 index 000000000..768fe3236 --- /dev/null +++ b/docs/context.md @@ -0,0 +1,90 @@ +# Context Schema + +```txt +https://ns.adobe.com/helix/pipeline/context +``` + +The context thingie. + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | ----------- | ------------ | :---------------- | --------------------- | ------------------- | ----------------------------------------------------------------- | +| Can be instantiated | No | Stabilizing | No | Forbidden | Forbidden | none | [context.schema.json](context.schema.json "open original schema") | + +## Context Type + +`object` ([Context](context.md)) + +# Context Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------------- | -------- | -------- | -------------- | :----------------------------------------------------------------------------------------------------------------- | +| [error](#error) | Multiple | Optional | cannot be null | [Context](context-properties-error.md "https://ns.adobe.com/helix/pipeline/context#/properties/error") | +| [request](#request) | `object` | Optional | cannot be null | [Context](context-properties-request.md "https://ns.adobe.com/helix/pipeline/request#/properties/request") | +| [content](#content) | `object` | Optional | cannot be null | [Context](context-properties-content.md "https://ns.adobe.com/helix/pipeline/content#/properties/content") | +| [response](#response) | `object` | Optional | cannot be null | [Context](context-properties-response.md "https://ns.adobe.com/helix/pipeline/response#/properties/response") | + +## error + +An error message that has been generated during pipeline processing. +When this property is present, all other values can be ignored. + + +`error` + +- is optional +- Type: any of the folllowing: `string` or `object` ([Details](context-properties-error.md)) +- cannot be null +- defined in: [Context](context-properties-error.md "https://ns.adobe.com/helix/pipeline/context#/properties/error") + +### error Type + +any of the folllowing: `string` or `object` ([Details](context-properties-error.md)) + +## request + +The HTTP Request + + +`request` + +- is optional +- Type: `object` ([Request](context-properties-request.md)) +- cannot be null +- defined in: [Context](context-properties-request.md "https://ns.adobe.com/helix/pipeline/request#/properties/request") + +### request Type + +`object` ([Request](context-properties-request.md)) + +## content + +The content as retrieved from the repository and enriched in the pipeline. + + +`content` + +- is optional +- Type: `object` ([Content](context-properties-content.md)) +- cannot be null +- defined in: [Context](context-properties-content.md "https://ns.adobe.com/helix/pipeline/content#/properties/content") + +### content Type + +`object` ([Content](context-properties-content.md)) + +## response + +The HTTP response object + + +`response` + +- is optional +- Type: `object` ([Response](context-properties-response.md)) +- cannot be null +- defined in: [Context](context-properties-response.md "https://ns.adobe.com/helix/pipeline/response#/properties/response") + +### response Type + +`object` ([Response](context-properties-response.md)) diff --git a/docs/context.schema.json b/docs/context.schema.json index 3445eaa5a..fa0b8bc84 100644 --- a/docs/context.schema.json +++ b/docs/context.schema.json @@ -1,38 +1 @@ -{ - "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/pipeline/context", - "$schema": "http://json-schema.org/draft-07/schema#", - "title": "Context", - "type": "object", - "meta:status": "stabilizing", - "description": "The context thingie.", - "additionalProperties": false, - "properties": { - "error": { - "type": [ - "string", - "object" - ], - "description": "An error message that has been generated during pipeline processing.\nWhen this property is present, all other values can be ignored." - }, - "request": { - "$ref": "https://ns.adobe.com/helix/pipeline/request" - }, - "content": { - "$ref": "https://ns.adobe.com/helix/pipeline/content" - }, - "response": { - "$ref": "https://ns.adobe.com/helix/pipeline/response" - } - } -} \ No newline at end of file +{"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/pipeline/context","$schema":"http://json-schema.org/draft-07/schema#","title":"Context","type":"object","meta:status":"stabilizing","description":"The context thingie.","additionalProperties":false,"properties":{"error":{"type":["string","object"],"description":"An error message that has been generated during pipeline processing.\nWhen this property is present, all other values can be ignored."},"request":{"$ref":"https://ns.adobe.com/helix/pipeline/request"},"content":{"$ref":"https://ns.adobe.com/helix/pipeline/content"},"response":{"$ref":"https://ns.adobe.com/helix/pipeline/response"}}} diff --git a/docs/context.schema.md b/docs/context.schema.md deleted file mode 100644 index 1a3ebc3e1..000000000 --- a/docs/context.schema.md +++ /dev/null @@ -1,81 +0,0 @@ -# Context Schema - -``` -https://ns.adobe.com/helix/pipeline/context -``` - -The context thingie. - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Defined In | -| ------------------- | ---------- | ----------- | ------------ | ----------------- | --------------------- | ------------------------------------------ | -| Can be instantiated | No | Stabilizing | No | Forbidden | Forbidden | [context.schema.json](context.schema.json) | - -## Schema Hierarchy - -- Context `https://ns.adobe.com/helix/pipeline/context` - - [Request](request.schema.md) `https://ns.adobe.com/helix/pipeline/request` - - [Content](content.schema.md) `https://ns.adobe.com/helix/pipeline/content` - - [Response](response.schema.md) `https://ns.adobe.com/helix/pipeline/response` - -# Context Properties - -| Property | Type | Required | Nullable | Defined by | -| --------------------- | -------- | -------- | -------- | --------------------- | -| [content](#content) | Content | Optional | No | Context (this schema) | -| [error](#error) | multiple | Optional | No | Context (this schema) | -| [request](#request) | Request | Optional | No | Context (this schema) | -| [response](#response) | Response | Optional | No | Context (this schema) | - -## content - -`content` - -- is optional -- type: Content -- defined in this schema - -### content Type - -- [Content](content.schema.md) – `https://ns.adobe.com/helix/pipeline/content` - -## error - -An error message that has been generated during pipeline processing. When this property is present, all other values -can be ignored. - -`error` - -- is optional -- type: multiple -- defined in this schema - -### error Type - -Either one of: - -- `string` -- `object` - -## request - -`request` - -- is optional -- type: Request -- defined in this schema - -### request Type - -- [Request](request.schema.md) – `https://ns.adobe.com/helix/pipeline/request` - -## response - -`response` - -- is optional -- type: Response -- defined in this schema - -### response Type - -- [Response](response.schema.md) – `https://ns.adobe.com/helix/pipeline/response` diff --git a/docs/mdast-properties-align-items.md b/docs/mdast-properties-align-items.md new file mode 100644 index 000000000..13743bcee --- /dev/null +++ b/docs/mdast-properties-align-items.md @@ -0,0 +1,27 @@ +# Untitled undefined type in MDAST Schema + +```txt +https://ns.adobe.com/helix/pipeline/mdast#/properties/align/items +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [mdast.schema.json\*](mdast.schema.json "open original schema") | + +## items Type + +`string` + +## items Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :--------- | ----------- | +| `"left"` | | +| `"right"` | | +| `"center"` | | +| `null` | | diff --git a/docs/mdast-properties-align.md b/docs/mdast-properties-align.md new file mode 100644 index 000000000..0b94e5684 --- /dev/null +++ b/docs/mdast-properties-align.md @@ -0,0 +1,16 @@ +# Untitled array in MDAST Schema + +```txt +https://ns.adobe.com/helix/pipeline/mdast#/properties/align +``` + +For tables, an align field can be present. If present, it must be a list of alignTypes. It represents how cells in columns are aligned. + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [mdast.schema.json\*](mdast.schema.json "open original schema") | + +## align Type + +`string[]` diff --git a/docs/mdast-properties-alt.md b/docs/mdast-properties-alt.md new file mode 100644 index 000000000..30f1eef99 --- /dev/null +++ b/docs/mdast-properties-alt.md @@ -0,0 +1,16 @@ +# Untitled undefined type in MDAST Schema + +```txt +https://ns.adobe.com/helix/pipeline/mdast#/properties/alt +``` + +An alt field should be present. It represents equivalent content for environments that cannot represent the node as intended. + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [mdast.schema.json\*](mdast.schema.json "open original schema") | + +## alt Type + +`string` diff --git a/docs/mdast-properties-checked.md b/docs/mdast-properties-checked.md new file mode 100644 index 000000000..2893a03ef --- /dev/null +++ b/docs/mdast-properties-checked.md @@ -0,0 +1,16 @@ +# Untitled undefined type in MDAST Schema + +```txt +https://ns.adobe.com/helix/pipeline/mdast#/properties/checked +``` + +A checked field can be present. It represents whether the item is done (when true), not done (when false), or indeterminate or not applicable (when null or not present). + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [mdast.schema.json\*](mdast.schema.json "open original schema") | + +## checked Type + +`boolean` diff --git a/docs/mdast-properties-children-items.md b/docs/mdast-properties-children-items.md new file mode 100644 index 000000000..b8baa3002 --- /dev/null +++ b/docs/mdast-properties-children-items.md @@ -0,0 +1,21 @@ +# Untitled undefined type in MDAST Schema + +```txt +https://ns.adobe.com/helix/pipeline/mdast#/properties/children/items +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [mdast.schema.json\*](mdast.schema.json "open original schema") | + +## items Type + +merged type ([Details](mdast-properties-children-items.md)) + +one (and only one) of + +- [MDAST](content-properties-mdast.md "check type definition") +- [Untitled undefined type in MDAST](section-definitions-section.md "check type definition") diff --git a/docs/mdast-properties-children.md b/docs/mdast-properties-children.md new file mode 100644 index 000000000..dfd525f65 --- /dev/null +++ b/docs/mdast-properties-children.md @@ -0,0 +1,16 @@ +# Untitled array in MDAST Schema + +```txt +https://ns.adobe.com/helix/pipeline/mdast#/properties/children +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [mdast.schema.json\*](mdast.schema.json "open original schema") | + +## children Type + +an array of merged types ([Details](mdast-properties-children-items.md)) diff --git a/docs/mdast-properties-code.md b/docs/mdast-properties-code.md new file mode 100644 index 000000000..c49cba1c0 --- /dev/null +++ b/docs/mdast-properties-code.md @@ -0,0 +1,26 @@ +# Untitled string in MDAST Schema + +```txt +https://ns.adobe.com/helix/pipeline/mdast#/properties/code +``` + +Icon code + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [mdast.schema.json\*](mdast.schema.json "open original schema") | + +## code Type + +`string` + +## code Constraints + +**pattern**: the string must match the following regular expression: + +```regexp +:[a-zA-Z0-9_-]+: +``` + +[try pattern](https://regexr.com/?expression=%3A%5Ba-zA-Z0-9_-%5D%2B%3A "try regular expression with regexr.com") diff --git a/docs/mdast-properties-data-hchildren-items.md b/docs/mdast-properties-data-hchildren-items.md new file mode 100644 index 000000000..4335832b5 --- /dev/null +++ b/docs/mdast-properties-data-hchildren-items.md @@ -0,0 +1,16 @@ +# Untitled object in MDAST Schema + +```txt +https://ns.adobe.com/helix/pipeline/mdast#/properties/data/hChildren/items +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [mdast.schema.json\*](mdast.schema.json "open original schema") | + +## items Type + +`object` ([Details](mdast-properties-data-hchildren-items.md)) diff --git a/docs/mdast-properties-data-hchildren.md b/docs/mdast-properties-data-hchildren.md new file mode 100644 index 000000000..5b7de91c1 --- /dev/null +++ b/docs/mdast-properties-data-hchildren.md @@ -0,0 +1,16 @@ +# Untitled undefined type in MDAST Schema + +```txt +https://ns.adobe.com/helix/pipeline/mdast#/properties/data/hChildren +``` + +May be used to define extra HAST children + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [mdast.schema.json\*](mdast.schema.json "open original schema") | + +## hChildren Type + +`object[]` ([Details](mdast-properties-data-hchildren-items.md)) diff --git a/docs/mdast-properties-data-hname.md b/docs/mdast-properties-data-hname.md new file mode 100644 index 000000000..d79202ed6 --- /dev/null +++ b/docs/mdast-properties-data-hname.md @@ -0,0 +1,16 @@ +# Untitled undefined type in MDAST Schema + +```txt +https://ns.adobe.com/helix/pipeline/mdast#/properties/data/hName +``` + +May be use to override the element’s tag-name + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [mdast.schema.json\*](mdast.schema.json "open original schema") | + +## hName Type + +`string` diff --git a/docs/mdast-properties-data-hproperties-items.md b/docs/mdast-properties-data-hproperties-items.md new file mode 100644 index 000000000..35342fcbc --- /dev/null +++ b/docs/mdast-properties-data-hproperties-items.md @@ -0,0 +1,16 @@ +# Untitled object in MDAST Schema + +```txt +https://ns.adobe.com/helix/pipeline/mdast#/properties/data/hProperties/items +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [mdast.schema.json\*](mdast.schema.json "open original schema") | + +## items Type + +`object` ([Details](mdast-properties-data-hproperties-items.md)) diff --git a/docs/mdast-properties-data-hproperties.md b/docs/mdast-properties-data-hproperties.md new file mode 100644 index 000000000..0cd71d2af --- /dev/null +++ b/docs/mdast-properties-data-hproperties.md @@ -0,0 +1,16 @@ +# Untitled undefined type in MDAST Schema + +```txt +https://ns.adobe.com/helix/pipeline/mdast#/properties/data/hProperties +``` + +May be used to define extra DOM element properties + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [mdast.schema.json\*](mdast.schema.json "open original schema") | + +## hProperties Type + +`object[]` ([Details](mdast-properties-data-hproperties-items.md)) diff --git a/docs/mdast-properties-data-types-items.md b/docs/mdast-properties-data-types-items.md new file mode 100644 index 000000000..ffd8fa925 --- /dev/null +++ b/docs/mdast-properties-data-types-items.md @@ -0,0 +1,16 @@ +# Untitled string in MDAST Schema + +```txt +https://ns.adobe.com/helix/pipeline/mdast#/properties/data/types/items +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [mdast.schema.json\*](mdast.schema.json "open original schema") | + +## items Type + +`string` diff --git a/docs/mdast-properties-data-types.md b/docs/mdast-properties-data-types.md new file mode 100644 index 000000000..bd63925c6 --- /dev/null +++ b/docs/mdast-properties-data-types.md @@ -0,0 +1,16 @@ +# Untitled undefined type in MDAST Schema + +```txt +https://ns.adobe.com/helix/pipeline/mdast#/properties/data/types +``` + +The inferred class names for the node + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [mdast.schema.json\*](mdast.schema.json "open original schema") | + +## types Type + +`string[]` diff --git a/docs/mdast-properties-data.md b/docs/mdast-properties-data.md new file mode 100644 index 000000000..b9d3d61bc --- /dev/null +++ b/docs/mdast-properties-data.md @@ -0,0 +1,26 @@ +# Untitled object in MDAST Schema + +```txt +https://ns.adobe.com/helix/pipeline/mdast#/properties/data +``` + +data is guaranteed to never be specified by unist or specifications implementing unist. Free data space. + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [mdast.schema.json\*](mdast.schema.json "open original schema") | + +## data Type + +`object` ([Details](mdast-properties-data.md)) + +# undefined Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------------- | ---- | -------- | ----------- | :--------- | +| Additional Properties | Any | Optional | can be null | | + +## Additional Properties + +Additional properties are allowed and do not have to follow a specific schema diff --git a/docs/mdast-properties-depth.md b/docs/mdast-properties-depth.md new file mode 100644 index 000000000..6ec20251f --- /dev/null +++ b/docs/mdast-properties-depth.md @@ -0,0 +1,22 @@ +# Untitled integer in MDAST Schema + +```txt +https://ns.adobe.com/helix/pipeline/mdast#/properties/depth +``` + +The heading level + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [mdast.schema.json\*](mdast.schema.json "open original schema") | + +## depth Type + +`integer` + +## depth Constraints + +**maximum**: the value of this number must smaller than or equal to: `6` + +**minimum**: the value of this number must greater than or equal to: `1` diff --git a/docs/mdast-properties-identifier.md b/docs/mdast-properties-identifier.md new file mode 100644 index 000000000..27796bc70 --- /dev/null +++ b/docs/mdast-properties-identifier.md @@ -0,0 +1,16 @@ +# Untitled string in MDAST Schema + +```txt +https://ns.adobe.com/helix/pipeline/mdast#/properties/identifier +``` + +For associations, an identifier field must be present. It can match an identifier field on another node. + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [mdast.schema.json\*](mdast.schema.json "open original schema") | + +## identifier Type + +`string` diff --git a/docs/mdast-properties-image.md b/docs/mdast-properties-image.md new file mode 100644 index 000000000..f2766adc3 --- /dev/null +++ b/docs/mdast-properties-image.md @@ -0,0 +1,20 @@ +# Untitled undefined type in MDAST Schema + +```txt +https://ns.adobe.com/helix/pipeline/mdast#/properties/image +``` + +Path (can be relative) to the first image in the document + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [mdast.schema.json\*](mdast.schema.json "open original schema") | + +## image Type + +`string` + +## image Constraints + +**URI reference**: the string must be a URI reference, according to [RFC 3986](https://tools.ietf.org/html/rfc4291 "check the specification") diff --git a/docs/mdast-properties-intro.md b/docs/mdast-properties-intro.md new file mode 100644 index 000000000..2db4df6a9 --- /dev/null +++ b/docs/mdast-properties-intro.md @@ -0,0 +1,16 @@ +# Untitled undefined type in MDAST Schema + +```txt +https://ns.adobe.com/helix/pipeline/mdast#/properties/intro +``` + +Extracted first paragraph of the document + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [mdast.schema.json\*](mdast.schema.json "open original schema") | + +## intro Type + +`string` diff --git a/docs/mdast-properties-label.md b/docs/mdast-properties-label.md new file mode 100644 index 000000000..c683350c9 --- /dev/null +++ b/docs/mdast-properties-label.md @@ -0,0 +1,16 @@ +# Untitled string in MDAST Schema + +```txt +https://ns.adobe.com/helix/pipeline/mdast#/properties/label +``` + +For associations, a label field can be present. It represents the original value of the normalised identifier field. + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [mdast.schema.json\*](mdast.schema.json "open original schema") | + +## label Type + +`string` diff --git a/docs/mdast-properties-lang.md b/docs/mdast-properties-lang.md new file mode 100644 index 000000000..44ce780d6 --- /dev/null +++ b/docs/mdast-properties-lang.md @@ -0,0 +1,16 @@ +# Untitled undefined type in MDAST Schema + +```txt +https://ns.adobe.com/helix/pipeline/mdast#/properties/lang +``` + +For code, a lang field can be present. It represents the language of computer code being marked up. + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [mdast.schema.json\*](mdast.schema.json "open original schema") | + +## lang Type + +`string` diff --git a/docs/mdast-properties-ordered.md b/docs/mdast-properties-ordered.md new file mode 100644 index 000000000..bfb5c3113 --- /dev/null +++ b/docs/mdast-properties-ordered.md @@ -0,0 +1,16 @@ +# Untitled boolean in MDAST Schema + +```txt +https://ns.adobe.com/helix/pipeline/mdast#/properties/ordered +``` + +Is the list ordered + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [mdast.schema.json\*](mdast.schema.json "open original schema") | + +## ordered Type + +`boolean` diff --git a/docs/mdast-properties-payload.md b/docs/mdast-properties-payload.md new file mode 100644 index 000000000..deddbf597 --- /dev/null +++ b/docs/mdast-properties-payload.md @@ -0,0 +1,16 @@ +# Untitled object in MDAST Schema + +```txt +https://ns.adobe.com/helix/pipeline/mdast#/properties/payload +``` + +The payload of a frontmatter/yaml block + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [mdast.schema.json\*](mdast.schema.json "open original schema") | + +## payload Type + +`object` ([Details](mdast-properties-payload.md)) diff --git a/docs/mdast-properties-referencetype-metaenum.md b/docs/mdast-properties-referencetype-metaenum.md new file mode 100644 index 000000000..6028f1583 --- /dev/null +++ b/docs/mdast-properties-referencetype-metaenum.md @@ -0,0 +1,16 @@ +# Untitled undefined type in MDAST Schema + +```txt +https://ns.adobe.com/helix/pipeline/mdast#/properties/referenceType/meta:enum +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [mdast.schema.json\*](mdast.schema.json "open original schema") | + +## meta:enum Type + +unknown diff --git a/docs/mdast-properties-referencetype.md b/docs/mdast-properties-referencetype.md new file mode 100644 index 000000000..2391b341a --- /dev/null +++ b/docs/mdast-properties-referencetype.md @@ -0,0 +1,26 @@ +# Untitled undefined type in MDAST Schema + +```txt +https://ns.adobe.com/helix/pipeline/mdast#/properties/referenceType +``` + +Represents the explicitness of a reference. + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [mdast.schema.json\*](mdast.schema.json "open original schema") | + +## referenceType Type + +unknown + +## referenceType Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :------------ | ------------------------------------------------------------------- | +| `"shortcut"` | the reference is implicit, its identifier inferred from its content | +| `"collapsed"` | the reference is explicit, its identifier inferred from its content | +| `"full"` | the reference is explicit, its identifier explicitly set | diff --git a/docs/mdast-properties-spread.md b/docs/mdast-properties-spread.md new file mode 100644 index 000000000..9f6c426c6 --- /dev/null +++ b/docs/mdast-properties-spread.md @@ -0,0 +1,16 @@ +# Untitled undefined type in MDAST Schema + +```txt +https://ns.adobe.com/helix/pipeline/mdast#/properties/spread +``` + +A spread field can be present. It represents that any of its items is separated by a blank line from its siblings or contains two or more children (when true), or not (when false or not present). + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [mdast.schema.json\*](mdast.schema.json "open original schema") | + +## spread Type + +`boolean` diff --git a/docs/mdast-properties-start.md b/docs/mdast-properties-start.md new file mode 100644 index 000000000..e0eaef24e --- /dev/null +++ b/docs/mdast-properties-start.md @@ -0,0 +1,16 @@ +# Untitled undefined type in MDAST Schema + +```txt +https://ns.adobe.com/helix/pipeline/mdast#/properties/start +``` + +Starting item of the list + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [mdast.schema.json\*](mdast.schema.json "open original schema") | + +## start Type + +`integer` diff --git a/docs/mdast-properties-title.md b/docs/mdast-properties-title.md new file mode 100644 index 000000000..214532f33 --- /dev/null +++ b/docs/mdast-properties-title.md @@ -0,0 +1,16 @@ +# Untitled undefined type in MDAST Schema + +```txt +https://ns.adobe.com/helix/pipeline/mdast#/properties/title +``` + +Extracted title of the document + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [mdast.schema.json\*](mdast.schema.json "open original schema") | + +## title Type + +`string` diff --git a/docs/mdast-properties-type-metaenum.md b/docs/mdast-properties-type-metaenum.md new file mode 100644 index 000000000..e77d33bfe --- /dev/null +++ b/docs/mdast-properties-type-metaenum.md @@ -0,0 +1,16 @@ +# Untitled undefined type in MDAST Schema + +```txt +https://ns.adobe.com/helix/pipeline/mdast#/properties/type/meta:enum +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [mdast.schema.json\*](mdast.schema.json "open original schema") | + +## meta:enum Type + +unknown diff --git a/docs/mdast-properties-type.md b/docs/mdast-properties-type.md new file mode 100644 index 000000000..c920cc848 --- /dev/null +++ b/docs/mdast-properties-type.md @@ -0,0 +1,53 @@ +# Untitled undefined type in MDAST Schema + +```txt +https://ns.adobe.com/helix/pipeline/mdast#/properties/type +``` + +The node type of the MDAST node + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [mdast.schema.json\*](mdast.schema.json "open original schema") | + +## type Type + +unknown + +## type Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :--------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `"root"` | The root node, representing a document or section | +| `"paragraph"` | A paragraph. Note: standalone \`image\` blocks are often wrapped in a \`paragraph\` | +| `"text"` | Plain text | +| `"heading"` | A heading with heading level | +| `"thematicBreak"` | A section break | +| `"blockquote"` | A blockquote | +| `"list"` | An ordered or unordered list | +| `"listItem"` | | +| `"table"` | A table | +| `"tableRow"` | A row in a table | +| `"tableCell"` | A cell in a table | +| `"html"` | Raw HTML embedded in Markdown. Disabled by default. | +| `"code"` | A code block | +| `"yaml"` | A metadata block. If the block is not at the top of the document, it will start a new section. | +| `"definition"` | A definition that can be referenced | +| `"footnoteDefinition"` | A footnote | +| `"emphasis"` | emphasis (often in italics) | +| `"strong"` | strong (often in bold type) | +| `"delete"` | deleted content | +| `"inlineCode"` | inline code | +| `"break"` | A line break | +| `"link"` | A hyperlink | +| `"image"` | An image | +| `"linkReference"` | A pointer to a link | +| `"imageReference"` | A pointer to an image | +| `"footnote"` | A footnote | +| `"footnoteReference"` | A reference to a footnote | +| `"embed"` | Content embedded from another page, identified by the \`url\` attribute. | +| `"section"` | A section within the document. Sections serve as a high-level structure of a single markdown document and can have their own section-specific front matter metadata. | +| `"icon"` | An SVG icon, identified by the syntax \`:foo:\` | diff --git a/docs/mdast-properties-types-items.md b/docs/mdast-properties-types-items.md new file mode 100644 index 000000000..73450142a --- /dev/null +++ b/docs/mdast-properties-types-items.md @@ -0,0 +1,16 @@ +# Untitled string in MDAST Schema + +```txt +https://ns.adobe.com/helix/pipeline/mdast#/properties/types/items +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [mdast.schema.json\*](mdast.schema.json "open original schema") | + +## items Type + +`string` diff --git a/docs/mdast-properties-types.md b/docs/mdast-properties-types.md new file mode 100644 index 000000000..503d62ea2 --- /dev/null +++ b/docs/mdast-properties-types.md @@ -0,0 +1,16 @@ +# Untitled array in MDAST Schema + +```txt +https://ns.adobe.com/helix/pipeline/mdast#/properties/types +``` + +The inferred class names for the section + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [mdast.schema.json\*](mdast.schema.json "open original schema") | + +## types Type + +`string[]` diff --git a/docs/mdast-properties-url.md b/docs/mdast-properties-url.md new file mode 100644 index 000000000..7abcf019e --- /dev/null +++ b/docs/mdast-properties-url.md @@ -0,0 +1,20 @@ +# Untitled string in MDAST Schema + +```txt +https://ns.adobe.com/helix/pipeline/mdast#/properties/url +``` + +For resources, an url field must be present. It represents a URL to the referenced resource. + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [mdast.schema.json\*](mdast.schema.json "open original schema") | + +## url Type + +`string` + +## url Constraints + +**URI reference**: the string must be a URI reference, according to [RFC 3986](https://tools.ietf.org/html/rfc4291 "check the specification") diff --git a/docs/mdast-properties-value.md b/docs/mdast-properties-value.md new file mode 100644 index 000000000..ee3f13ee7 --- /dev/null +++ b/docs/mdast-properties-value.md @@ -0,0 +1,16 @@ +# Untitled string in MDAST Schema + +```txt +https://ns.adobe.com/helix/pipeline/mdast#/properties/value +``` + +The string value of the node, if it is a terminal node. + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [mdast.schema.json\*](mdast.schema.json "open original schema") | + +## value Type + +`string` diff --git a/docs/mdast-properties.md b/docs/mdast-properties.md new file mode 100644 index 000000000..fc2b0bf90 --- /dev/null +++ b/docs/mdast-properties.md @@ -0,0 +1,16 @@ +# \[object Object] Schema + +```txt +https://ns.adobe.com/helix/pipeline/mdast#/properties +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [mdast.schema.json\*](mdast.schema.json "open original schema") | + +## properties Type + +unknown diff --git a/docs/mdast.md b/docs/mdast.md new file mode 100644 index 000000000..6b7cc5f6c --- /dev/null +++ b/docs/mdast.md @@ -0,0 +1,500 @@ +# MDAST Schema + +```txt +https://ns.adobe.com/helix/pipeline/mdast +``` + +A node in the Markdown AST + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | ------ | ------------ | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------- | +| Can be instantiated | No | Stable | No | Forbidden | Forbidden | none | [mdast.schema.json](mdast.schema.json "open original schema") | + +## MDAST Type + +`object` ([MDAST](mdast.md)) + +# MDAST Properties + +| Property | Type | Required | Nullable | Defined by | +| :------------------------------ | ------------- | -------- | -------------- | :----------------------------------------------------------------------------------------------------------------------------------- | +| [type](#type) | Not specified | Optional | cannot be null | [MDAST](mdast-properties-type.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/type") | +| [children](#children) | `array` | Optional | cannot be null | [MDAST](mdast-properties-children.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/children") | +| [position](#position) | `object` | Optional | cannot be null | [MDAST](section-definitions-section-properties-position.md "https://ns.adobe.com/helix/pipeline/position#/properties/position") | +| [value](#value) | `string` | Optional | cannot be null | [MDAST](mdast-properties-value.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/value") | +| [payload](#payload) | `object` | Optional | cannot be null | [MDAST](mdast-properties-payload.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/payload") | +| [depth](#depth) | `integer` | Optional | cannot be null | [MDAST](mdast-properties-depth.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/depth") | +| [ordered](#ordered) | `boolean` | Optional | cannot be null | [MDAST](mdast-properties-ordered.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/ordered") | +| [start](#start) | `integer` | Optional | can be null | [MDAST](mdast-properties-start.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/start") | +| [spread](#spread) | `boolean` | Optional | can be null | [MDAST](mdast-properties-spread.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/spread") | +| [checked](#checked) | `boolean` | Optional | can be null | [MDAST](mdast-properties-checked.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/checked") | +| [align](#align) | `array` | Optional | cannot be null | [MDAST](mdast-properties-align.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/align") | +| [lang](#lang) | `string` | Optional | can be null | [MDAST](mdast-properties-lang.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/lang") | +| [identifier](#identifier) | `string` | Optional | cannot be null | [MDAST](mdast-properties-identifier.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/identifier") | +| [label](#label) | `string` | Optional | cannot be null | [MDAST](mdast-properties-label.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/label") | +| [url](#url) | `string` | Optional | cannot be null | [MDAST](mdast-properties-url.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/url") | +| [meta](#meta) | `object` | Optional | can be null | [MDAST](meta-definitions-meta.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/meta") | +| [title](#title) | `string` | Optional | can be null | [MDAST](mdast-properties-title.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/title") | +| [code](#code) | `string` | Optional | cannot be null | [MDAST](mdast-properties-code.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/code") | +| [intro](#intro) | `string` | Optional | can be null | [MDAST](mdast-properties-intro.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/intro") | +| [image](#image) | `string` | Optional | can be null | [MDAST](mdast-properties-image.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/image") | +| [types](#types) | `array` | Optional | cannot be null | [MDAST](mdast-properties-types.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/types") | +| [alt](#alt) | `string` | Optional | can be null | [MDAST](mdast-properties-alt.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/alt") | +| [referenceType](#referenceType) | Not specified | Optional | cannot be null | [MDAST](mdast-properties-referencetype.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/referenceType") | +| [data](#data) | `object` | Optional | cannot be null | [MDAST](mdast-properties-data.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/data") | + +## type + +The node type of the MDAST node + + +`type` + +- is optional +- Type: unknown +- cannot be null +- defined in: [MDAST](mdast-properties-type.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/type") + +### type Type + +unknown + +### type Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :--------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `"root"` | The root node, representing a document or section | +| `"paragraph"` | A paragraph. Note: standalone \`image\` blocks are often wrapped in a \`paragraph\` | +| `"text"` | Plain text | +| `"heading"` | A heading with heading level | +| `"thematicBreak"` | A section break | +| `"blockquote"` | A blockquote | +| `"list"` | An ordered or unordered list | +| `"listItem"` | | +| `"table"` | A table | +| `"tableRow"` | A row in a table | +| `"tableCell"` | A cell in a table | +| `"html"` | Raw HTML embedded in Markdown. Disabled by default. | +| `"code"` | A code block | +| `"yaml"` | A metadata block. If the block is not at the top of the document, it will start a new section. | +| `"definition"` | A definition that can be referenced | +| `"footnoteDefinition"` | A footnote | +| `"emphasis"` | emphasis (often in italics) | +| `"strong"` | strong (often in bold type) | +| `"delete"` | deleted content | +| `"inlineCode"` | inline code | +| `"break"` | A line break | +| `"link"` | A hyperlink | +| `"image"` | An image | +| `"linkReference"` | A pointer to a link | +| `"imageReference"` | A pointer to an image | +| `"footnote"` | A footnote | +| `"footnoteReference"` | A reference to a footnote | +| `"embed"` | Content embedded from another page, identified by the \`url\` attribute. | +| `"section"` | A section within the document. Sections serve as a high-level structure of a single markdown document and can have their own section-specific front matter metadata. | +| `"icon"` | An SVG icon, identified by the syntax \`:foo:\` | + +## children + + + + +`children` + +- is optional +- Type: an array of merged types ([Details](mdast-properties-children-items.md)) +- cannot be null +- defined in: [MDAST](mdast-properties-children.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/children") + +### children Type + +an array of merged types ([Details](mdast-properties-children-items.md)) + +## position + +Marks the position of an AST node in the original text flow + + +`position` + +- is optional +- Type: `object` ([Position](section-definitions-section-properties-position.md)) +- cannot be null +- defined in: [MDAST](section-definitions-section-properties-position.md "https://ns.adobe.com/helix/pipeline/position#/properties/position") + +### position Type + +`object` ([Position](section-definitions-section-properties-position.md)) + +## value + +The string value of the node, if it is a terminal node. + + +`value` + +- is optional +- Type: `string` +- cannot be null +- defined in: [MDAST](mdast-properties-value.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/value") + +### value Type + +`string` + +## payload + +The payload of a frontmatter/yaml block + + +`payload` + +- is optional +- Type: `object` ([Details](mdast-properties-payload.md)) +- cannot be null +- defined in: [MDAST](mdast-properties-payload.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/payload") + +### payload Type + +`object` ([Details](mdast-properties-payload.md)) + +## depth + +The heading level + + +`depth` + +- is optional +- Type: `integer` +- cannot be null +- defined in: [MDAST](mdast-properties-depth.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/depth") + +### depth Type + +`integer` + +### depth Constraints + +**maximum**: the value of this number must smaller than or equal to: `6` + +**minimum**: the value of this number must greater than or equal to: `1` + +## ordered + +Is the list ordered + + +`ordered` + +- is optional +- Type: `boolean` +- cannot be null +- defined in: [MDAST](mdast-properties-ordered.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/ordered") + +### ordered Type + +`boolean` + +## start + +Starting item of the list + + +`start` + +- is optional +- Type: `integer` +- can be null +- defined in: [MDAST](mdast-properties-start.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/start") + +### start Type + +`integer` + +## spread + +A spread field can be present. It represents that any of its items is separated by a blank line from its siblings or contains two or more children (when true), or not (when false or not present). + + +`spread` + +- is optional +- Type: `boolean` +- can be null +- defined in: [MDAST](mdast-properties-spread.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/spread") + +### spread Type + +`boolean` + +## checked + +A checked field can be present. It represents whether the item is done (when true), not done (when false), or indeterminate or not applicable (when null or not present). + + +`checked` + +- is optional +- Type: `boolean` +- can be null +- defined in: [MDAST](mdast-properties-checked.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/checked") + +### checked Type + +`boolean` + +## align + +For tables, an align field can be present. If present, it must be a list of alignTypes. It represents how cells in columns are aligned. + + +`align` + +- is optional +- Type: `string[]` +- cannot be null +- defined in: [MDAST](mdast-properties-align.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/align") + +### align Type + +`string[]` + +## lang + +For code, a lang field can be present. It represents the language of computer code being marked up. + + +`lang` + +- is optional +- Type: `string` +- can be null +- defined in: [MDAST](mdast-properties-lang.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/lang") + +### lang Type + +`string` + +## identifier + +For associations, an identifier field must be present. It can match an identifier field on another node. + + +`identifier` + +- is optional +- Type: `string` +- cannot be null +- defined in: [MDAST](mdast-properties-identifier.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/identifier") + +### identifier Type + +`string` + +## label + +For associations, a label field can be present. It represents the original value of the normalised identifier field. + + +`label` + +- is optional +- Type: `string` +- cannot be null +- defined in: [MDAST](mdast-properties-label.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/label") + +### label Type + +`string` + +## url + +For resources, an url field must be present. It represents a URL to the referenced resource. + + +`url` + +- is optional +- Type: `string` +- cannot be null +- defined in: [MDAST](mdast-properties-url.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/url") + +### url Type + +`string` + +### url Constraints + +**URI reference**: the string must be a URI reference, according to [RFC 3986](https://tools.ietf.org/html/rfc4291 "check the specification") + +## meta + + + + +`meta` + +- is optional +- Type: `object` ([Details](meta-definitions-meta.md)) +- can be null +- defined in: [MDAST](meta-definitions-meta.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/meta") + +### meta Type + +`object` ([Details](meta-definitions-meta.md)) + +## title + +Extracted title of the document + + +`title` + +- is optional +- Type: `string` +- can be null +- defined in: [MDAST](mdast-properties-title.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/title") + +### title Type + +`string` + +## code + +Icon code + + +`code` + +- is optional +- Type: `string` +- cannot be null +- defined in: [MDAST](mdast-properties-code.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/code") + +### code Type + +`string` + +### code Constraints + +**pattern**: the string must match the following regular expression: + +```regexp +:[a-zA-Z0-9_-]+: +``` + +[try pattern](https://regexr.com/?expression=%3A%5Ba-zA-Z0-9_-%5D%2B%3A "try regular expression with regexr.com") + +## intro + +Extracted first paragraph of the document + + +`intro` + +- is optional +- Type: `string` +- can be null +- defined in: [MDAST](mdast-properties-intro.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/intro") + +### intro Type + +`string` + +## image + +Path (can be relative) to the first image in the document + + +`image` + +- is optional +- Type: `string` +- can be null +- defined in: [MDAST](mdast-properties-image.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/image") + +### image Type + +`string` + +### image Constraints + +**URI reference**: the string must be a URI reference, according to [RFC 3986](https://tools.ietf.org/html/rfc4291 "check the specification") + +## types + +The inferred class names for the section + + +`types` + +- is optional +- Type: `string[]` +- cannot be null +- defined in: [MDAST](mdast-properties-types.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/types") + +### types Type + +`string[]` + +## alt + +An alt field should be present. It represents equivalent content for environments that cannot represent the node as intended. + + +`alt` + +- is optional +- Type: `string` +- can be null +- defined in: [MDAST](mdast-properties-alt.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/alt") + +### alt Type + +`string` + +## referenceType + +Represents the explicitness of a reference. + + +`referenceType` + +- is optional +- Type: unknown +- cannot be null +- defined in: [MDAST](mdast-properties-referencetype.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/referenceType") + +### referenceType Type + +unknown + +### referenceType Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :------------ | ------------------------------------------------------------------- | +| `"shortcut"` | the reference is implicit, its identifier inferred from its content | +| `"collapsed"` | the reference is explicit, its identifier inferred from its content | +| `"full"` | the reference is explicit, its identifier explicitly set | + +## data + +data is guaranteed to never be specified by unist or specifications implementing unist. Free data space. + + +`data` + +- is optional +- Type: `object` ([Details](mdast-properties-data.md)) +- cannot be null +- defined in: [MDAST](mdast-properties-data.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/data") + +### data Type + +`object` ([Details](mdast-properties-data.md)) diff --git a/docs/mdast.schema.json b/docs/mdast.schema.json index e71199b2d..3471cc432 100644 --- a/docs/mdast.schema.json +++ b/docs/mdast.schema.json @@ -1,278 +1 @@ -{ - "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/pipeline/mdast", - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "title": "MDAST", - "meta:status": "stable", - "description": "A node in the Markdown AST", - "additionalProperties": false, - "properties": { - "type": { - "enum": [ - "root", - "paragraph", - "text", - "heading", - "thematicBreak", - "blockquote", - "list", - "listItem", - "table", - "tableRow", - "tableCell", - "html", - "code", - "yaml", - "definition", - "footnoteDefinition", - "emphasis", - "strong", - "delete", - "inlineCode", - "break", - "link", - "image", - "linkReference", - "imageReference", - "footnote", - "footnoteReference", - "embed", - "section", - "icon" - ], - "meta:enum": { - "root": "The root node, representing a document or section", - "paragraph": "A paragraph. Note: standalone `image` blocks are often wrapped in a `paragraph`", - "text": "Plain text", - "heading": "A heading with heading level", - "thematicBreak": "A section break", - "blockquote": "A blockquote", - "list": "An ordered or unordered list", - "table": "A table", - "tableRow": "A row in a table", - "tableCell": "A cell in a table", - "html": "Raw HTML embedded in Markdown. Disabled by default.", - "code": "A code block", - "yaml": "A metadata block. If the block is not at the top of the document, it will start a new section.", - "definition": "A definition that can be referenced", - "footnoteDefinition": "A footnote", - "emphasis": "emphasis (often in italics)", - "strong": "strong (often in bold type)", - "delete": "deleted content", - "inlineCode": "inline code", - "break": "A line break", - "link": "A hyperlink", - "image": "An image", - "linkReference": "A pointer to a link", - "imageReference": "A pointer to an image", - "footnote": "A footnote", - "footnoteReference": "A reference to a footnote", - "embed": "Content embedded from another page, identified by the `url` attribute.", - "section": "A section within the document. Sections serve as a high-level structure of a single markdown document and can have their own section-specific front matter metadata.", - "icon": "An SVG icon, identified by the syntax `:foo:`" - }, - "description": "The node type of the MDAST node" - }, - "children": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "https://ns.adobe.com/helix/pipeline/mdast" - }, - { - "$ref": "https://ns.adobe.com/helix/pipeline/section#/definitions/section" - } - ] - } - }, - "position": { - "$ref": "https://ns.adobe.com/helix/pipeline/position" - }, - "value": { - "type": "string", - "description": "The string value of the node, if it is a terminal node." - }, - "payload": { - "type": "object", - "description": "The payload of a frontmatter/yaml block" - }, - "depth": { - "type": "integer", - "minimum": 1, - "maximum": 6, - "description": "The heading level" - }, - "ordered": { - "type": "boolean", - "description": "Is the list ordered" - }, - "start": { - "type": [ - "null", - "integer" - ], - "description": "Starting item of the list" - }, - "spread": { - "type": [ - "null", - "boolean" - ], - "description": "A spread field can be present. It represents that any of its items is separated by a blank line from its siblings or contains two or more children (when true), or not (when false or not present)." - }, - "checked": { - "type": [ - "null", - "boolean" - ], - "description": "A checked field can be present. It represents whether the item is done (when true), not done (when false), or indeterminate or not applicable (when null or not present)." - }, - "align": { - "description": "For tables, an align field can be present. If present, it must be a list of alignTypes. It represents how cells in columns are aligned.", - "type": "array", - "items": { - "type": [ - "null", - "string" - ], - "enum": [ - "left", - "right", - "center", - null - ] - } - }, - "lang": { - "type": [ - "null", - "string" - ], - "description": "For code, a lang field can be present. It represents the language of computer code being marked up." - }, - "identifier": { - "type": "string", - "description": "For associations, an identifier field must be present. It can match an identifier field on another node." - }, - "label": { - "type": "string", - "description": "For associations, a label field can be present. It represents the original value of the normalised identifier field." - }, - "url": { - "type": "string", - "format": "uri-reference", - "description": "For resources, an url field must be present. It represents a URL to the referenced resource." - }, - "meta": { - "$ref": "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta" - }, - "title": { - "type": [ - "null", - "string" - ], - "description": "Extracted title of the document" - }, - "code": { - "type": "string", - "pattern": ":[a-zA-Z0-9_-]+:", - "description": "Icon code" - }, - "intro": { - "type": [ - "null", - "string" - ], - "description": "Extracted first paragraph of the document" - }, - "image": { - "type": [ - "null", - "string" - ], - "format": "uri-reference", - "description": "Path (can be relative) to the first image in the document" - }, - "types": { - "type": "array", - "description": "The inferred class names for the section", - "items": { - "type": "string" - } - }, - "alt": { - "type": [ - "string", - "null" - ], - "description": "An alt field should be present. It represents equivalent content for environments that cannot represent the node as intended." - }, - "referenceType": { - "enum": [ - "shortcut", - "collapsed", - "full" - ], - "description": "Represents the explicitness of a reference.", - "meta:enum": { - "shortcut": "the reference is implicit, its identifier inferred from its content", - "collapsed": "the reference is explicit, its identifier inferred from its content", - "full": "the reference is explicit, its identifier explicitly set" - } - }, - "data": { - "type": "object", - "description": "data is guaranteed to never be specified by unist or specifications implementing unist. Free data space.", - "additionalProperties": true, - "types": { - "type": [ - "null", - "array" - ], - "description": "The inferred class names for the node", - "items": { - "type": "string" - } - }, - "hName": { - "description": "May be use to override the element’s tag-name", - "type": [ - "null", - "string" - ] - }, - "hProperties": { - "description": "May be used to define extra DOM element properties", - "type": [ - "null", - "array" - ], - "items": { - "type": "object" - } - }, - "hChildren": { - "description": "May be used to define extra HAST children", - "type": [ - "null", - "array" - ], - "items": { - "type": "object" - } - } - } - } -} \ No newline at end of file +{"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/pipeline/mdast","$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"MDAST","meta:status":"stable","description":"A node in the Markdown AST","additionalProperties":false,"properties":{"type":{"enum":["root","paragraph","text","heading","thematicBreak","blockquote","list","listItem","table","tableRow","tableCell","html","code","yaml","definition","footnoteDefinition","emphasis","strong","delete","inlineCode","break","link","image","linkReference","imageReference","footnote","footnoteReference","embed","section","icon"],"meta:enum":{"root":"The root node, representing a document or section","paragraph":"A paragraph. Note: standalone `image` blocks are often wrapped in a `paragraph`","text":"Plain text","heading":"A heading with heading level","thematicBreak":"A section break","blockquote":"A blockquote","list":"An ordered or unordered list","table":"A table","tableRow":"A row in a table","tableCell":"A cell in a table","html":"Raw HTML embedded in Markdown. Disabled by default.","code":"A code block","yaml":"A metadata block. If the block is not at the top of the document, it will start a new section.","definition":"A definition that can be referenced","footnoteDefinition":"A footnote","emphasis":"emphasis (often in italics)","strong":"strong (often in bold type)","delete":"deleted content","inlineCode":"inline code","break":"A line break","link":"A hyperlink","image":"An image","linkReference":"A pointer to a link","imageReference":"A pointer to an image","footnote":"A footnote","footnoteReference":"A reference to a footnote","embed":"Content embedded from another page, identified by the `url` attribute.","section":"A section within the document. Sections serve as a high-level structure of a single markdown document and can have their own section-specific front matter metadata.","icon":"An SVG icon, identified by the syntax `:foo:`"},"description":"The node type of the MDAST node"},"children":{"type":"array","items":{"oneOf":[{"$ref":"https://ns.adobe.com/helix/pipeline/mdast"},{"$ref":"https://ns.adobe.com/helix/pipeline/section#/definitions/section"}]}},"position":{"$ref":"https://ns.adobe.com/helix/pipeline/position"},"value":{"type":"string","description":"The string value of the node, if it is a terminal node."},"payload":{"type":"object","description":"The payload of a frontmatter/yaml block"},"depth":{"type":"integer","minimum":1,"maximum":6,"description":"The heading level"},"ordered":{"type":"boolean","description":"Is the list ordered"},"start":{"type":["null","integer"],"description":"Starting item of the list"},"spread":{"type":["null","boolean"],"description":"A spread field can be present. It represents that any of its items is separated by a blank line from its siblings or contains two or more children (when true), or not (when false or not present)."},"checked":{"type":["null","boolean"],"description":"A checked field can be present. It represents whether the item is done (when true), not done (when false), or indeterminate or not applicable (when null or not present)."},"align":{"description":"For tables, an align field can be present. If present, it must be a list of alignTypes. It represents how cells in columns are aligned.","type":"array","items":{"type":["null","string"],"enum":["left","right","center",null]}},"lang":{"type":["null","string"],"description":"For code, a lang field can be present. It represents the language of computer code being marked up."},"identifier":{"type":"string","description":"For associations, an identifier field must be present. It can match an identifier field on another node."},"label":{"type":"string","description":"For associations, a label field can be present. It represents the original value of the normalised identifier field."},"url":{"type":"string","format":"uri-reference","description":"For resources, an url field must be present. It represents a URL to the referenced resource."},"meta":{"$ref":"https://ns.adobe.com/helix/pipeline/meta#/definitions/meta"},"title":{"type":["null","string"],"description":"Extracted title of the document"},"code":{"type":"string","pattern":":[a-zA-Z0-9_-]+:","description":"Icon code"},"intro":{"type":["null","string"],"description":"Extracted first paragraph of the document"},"image":{"type":["null","string"],"format":"uri-reference","description":"Path (can be relative) to the first image in the document"},"types":{"type":"array","description":"The inferred class names for the section","items":{"type":"string"}},"alt":{"type":["string","null"],"description":"An alt field should be present. It represents equivalent content for environments that cannot represent the node as intended."},"referenceType":{"enum":["shortcut","collapsed","full"],"description":"Represents the explicitness of a reference.","meta:enum":{"shortcut":"the reference is implicit, its identifier inferred from its content","collapsed":"the reference is explicit, its identifier inferred from its content","full":"the reference is explicit, its identifier explicitly set"}},"data":{"type":"object","description":"data is guaranteed to never be specified by unist or specifications implementing unist. Free data space.","additionalProperties":true,"types":{"type":["null","array"],"description":"The inferred class names for the node","items":{"type":"string"}},"hName":{"description":"May be use to override the element’s tag-name","type":["null","string"]},"hProperties":{"description":"May be used to define extra DOM element properties","type":["null","array"],"items":{"type":"object"}},"hChildren":{"description":"May be used to define extra HAST children","type":["null","array"],"items":{"type":"object"}}}}} diff --git a/docs/mdast.schema.md b/docs/mdast.schema.md deleted file mode 100644 index ed9dcc88f..000000000 --- a/docs/mdast.schema.md +++ /dev/null @@ -1,567 +0,0 @@ -# MDAST Schema - -``` -https://ns.adobe.com/helix/pipeline/mdast -``` - -A node in the Markdown AST - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Defined In | -| ------------------- | ---------- | ------ | ------------ | ----------------- | --------------------- | -------------------------------------- | -| Can be instantiated | No | Stable | No | Forbidden | Forbidden | [mdast.schema.json](mdast.schema.json) | - -## Schema Hierarchy - -- MDAST `https://ns.adobe.com/helix/pipeline/mdast` - - [Position](position.schema.md) `https://ns.adobe.com/helix/pipeline/position` - - [Meta](meta.schema.md) `https://ns.adobe.com/helix/pipeline/meta` - -# MDAST Properties - -| Property | Type | Required | Nullable | Defined by | -| ------------------------------- | ---------- | -------- | -------- | ------------------- | -| [align](#align) | `enum[]` | Optional | No | MDAST (this schema) | -| [alt](#alt) | `string` | Optional | Yes | MDAST (this schema) | -| [checked](#checked) | `boolean` | Optional | Yes | MDAST (this schema) | -| [children](#children) | `array` | Optional | No | MDAST (this schema) | -| [code](#code) | `string` | Optional | No | MDAST (this schema) | -| [data](#data) | `object` | Optional | No | MDAST (this schema) | -| [depth](#depth) | `integer` | Optional | No | MDAST (this schema) | -| [identifier](#identifier) | `string` | Optional | No | MDAST (this schema) | -| [image](#image) | `string` | Optional | Yes | MDAST (this schema) | -| [intro](#intro) | `string` | Optional | Yes | MDAST (this schema) | -| [label](#label) | `string` | Optional | No | MDAST (this schema) | -| [lang](#lang) | `string` | Optional | Yes | MDAST (this schema) | -| [meta](#meta) | `object` | Optional | Yes | MDAST (this schema) | -| [ordered](#ordered) | `boolean` | Optional | No | MDAST (this schema) | -| [payload](#payload) | `object` | Optional | No | MDAST (this schema) | -| [position](#position) | Position | Optional | No | MDAST (this schema) | -| [referenceType](#referencetype) | `enum` | Optional | No | MDAST (this schema) | -| [spread](#spread) | `boolean` | Optional | Yes | MDAST (this schema) | -| [start](#start) | `integer` | Optional | Yes | MDAST (this schema) | -| [title](#title) | `string` | Optional | Yes | MDAST (this schema) | -| [type](#type) | `enum` | Optional | No | MDAST (this schema) | -| [types](#types) | `string[]` | Optional | No | MDAST (this schema) | -| [url](#url) | `string` | Optional | No | MDAST (this schema) | -| [value](#value) | `string` | Optional | No | MDAST (this schema) | - -## align - -For tables, an align field can be present. If present, it must be a list of alignTypes. It represents how cells in -columns are aligned. - -`align` - -- is optional -- type: `enum[]` -- defined in this schema - -### align Type - -Array type: `enum[]` - -All items must be of the type: Unknown type `null,string`. - -```json -{ - "description": "For tables, an align field can be present. If present, it must be a list of alignTypes. It represents how cells in columns are aligned.", - "type": "array", - "items": { - "type": ["null", "string"], - "enum": ["left", "right", "center", null], - "simpletype": "`enum`", - "meta:enum": { - "left": "", - "right": "", - "center": "", - "null": "" - } - }, - "simpletype": "`enum[]`" -} -``` - -## alt - -An alt field should be present. It represents equivalent content for environments that cannot represent the node as -intended. - -`alt` - -- is optional -- type: `string` -- defined in this schema - -### alt Type - -`string`, nullable - -## checked - -A checked field can be present. It represents whether the item is done (when true), not done (when false), or -indeterminate or not applicable (when null or not present). - -`checked` - -- is optional -- type: `boolean` -- defined in this schema - -### checked Type - -`boolean` , nullable - -## children - -`children` - -- is optional -- type: `array` -- defined in this schema - -### children Type - -Array type: `array` - -All items must be of the type: - -**One** of the following _conditions_ need to be fulfilled. - -#### Condition 1 - -- []() – `https://ns.adobe.com/helix/pipeline/mdast` - -#### Condition 2 - -- []() – `https://ns.adobe.com/helix/pipeline/section#/definitions/section` - -## code - -Icon code - -`code` - -- is optional -- type: `string` -- defined in this schema - -### code Type - -`string` - -All instances must conform to this regular expression (test examples -[here](https://regexr.com/?expression=%3A%5Ba-zA-Z0-9_-%5D%2B%3A)): - -```regex -:[a-zA-Z0-9_-]+: -``` - -## data - -data is guaranteed to never be specified by unist or specifications implementing unist. Free data space. - -`data` - -- is optional -- type: `object` -- defined in this schema - -### data Type - -`object` with following properties: - -| Property | Type | Required | -| -------- | ---- | -------- | - - -## depth - -The heading level - -`depth` - -- is optional -- type: `integer` -- defined in this schema - -### depth Type - -`integer` - -- minimum value: `1` -- maximum value: `6` - -## identifier - -For associations, an identifier field must be present. It can match an identifier field on another node. - -`identifier` - -- is optional -- type: `string` -- defined in this schema - -### identifier Type - -`string` - -## image - -Path (can be relative) to the first image in the document - -`image` - -- is optional -- type: `string` -- defined in this schema - -### image Type - -`string`, nullable - -- format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) - -## intro - -Extracted first paragraph of the document - -`intro` - -- is optional -- type: `string` -- defined in this schema - -### intro Type - -`string`, nullable - -## label - -For associations, a label field can be present. It represents the original value of the normalised identifier field. - -`label` - -- is optional -- type: `string` -- defined in this schema - -### label Type - -`string` - -## lang - -For code, a lang field can be present. It represents the language of computer code being marked up. - -`lang` - -- is optional -- type: `string` -- defined in this schema - -### lang Type - -`string`, nullable - -## meta - -`meta` - -- is optional -- type: `object` -- defined in this schema - -### meta Type - -`object`, nullable, with following properties: - -| Property | Type | Required | -| --------- | ------ | -------- | -| `class` | string | Optional | -| `image` | string | Optional | -| `intro` | string | Optional | -| `tagname` | string | Optional | -| `title` | string | Optional | -| `types` | array | Optional | - -#### class - -The CSS class to use for the section instead of the default `hlx-section` one - -`class` - -- is optional -- type: `string` - -##### class Type - -`string` - -#### image - -Path (can be relative) to the first image in the document - -`image` - -- is optional -- type: `string` - -##### image Type - -`string` - -- format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) - -#### intro - -Extracted first paragraph of the document - -`intro` - -- is optional -- type: `string` - -##### intro Type - -`string` - -#### tagname - -The element tag name to use for the section instead of the default `div` one (i.e. `section`, `main`, `aside`) - -`tagname` - -- is optional -- type: `string` - -##### tagname Type - -`string` - -#### title - -Extracted title of the document - -`title` - -- is optional -- type: `string` - -##### title Type - -`string` - -#### types - -The inferred class names for the section - -`types` - -- is optional -- type: `string[]` - -##### types Type - -Array type: `string[]` - -All items must be of the type: `string` - -## ordered - -Is the list ordered - -`ordered` - -- is optional -- type: `boolean` -- defined in this schema - -### ordered Type - -`boolean` - -## payload - -The payload of a frontmatter/yaml block - -`payload` - -- is optional -- type: `object` -- defined in this schema - -### payload Type - -`object` with following properties: - -| Property | Type | Required | -| -------- | ---- | -------- | - - -## position - -`position` - -- is optional -- type: Position -- defined in this schema - -### position Type - -- [Position](position.schema.md) – `https://ns.adobe.com/helix/pipeline/position` - -## referenceType - -Represents the explicitness of a reference. - -`referenceType` - -- is optional -- type: `enum` -- defined in this schema - -The value of this property **must** be equal to one of the [known values below](#referencetype-known-values). - -### referenceType Known Values - -| Value | Description | -| ----------- | ------------------------------------------------------------------- | -| `shortcut` | the reference is implicit, its identifier inferred from its content | -| `collapsed` | the reference is explicit, its identifier inferred from its content | -| `full` | the reference is explicit, its identifier explicitly set | - -## spread - -A spread field can be present. It represents that any of its items is separated by a blank line from its siblings or -contains two or more children (when true), or not (when false or not present). - -`spread` - -- is optional -- type: `boolean` -- defined in this schema - -### spread Type - -`boolean` , nullable - -## start - -Starting item of the list - -`start` - -- is optional -- type: `integer` -- defined in this schema - -### start Type - -`integer`, nullable - -## title - -Extracted title of the document - -`title` - -- is optional -- type: `string` -- defined in this schema - -### title Type - -`string`, nullable - -## type - -The node type of the MDAST node - -`type` - -- is optional -- type: `enum` -- defined in this schema - -The value of this property **must** be equal to one of the [known values below](#type-known-values). - -### type Known Values - -| Value | Description | -| -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `root` | The root node, representing a document or section | -| `paragraph` | A paragraph. Note: standalone `image` blocks are often wrapped in a `paragraph` | -| `text` | Plain text | -| `heading` | A heading with heading level | -| `thematicBreak` | A section break | -| `blockquote` | A blockquote | -| `list` | An ordered or unordered list | -| `table` | A table | -| `tableRow` | A row in a table | -| `tableCell` | A cell in a table | -| `html` | Raw HTML embedded in Markdown. Disabled by default. | -| `code` | A code block | -| `yaml` | A metadata block. If the block is not at the top of the document, it will start a new section. | -| `definition` | A definition that can be referenced | -| `footnoteDefinition` | A footnote | -| `emphasis` | emphasis (often in italics) | -| `strong` | strong (often in bold type) | -| `delete` | deleted content | -| `inlineCode` | inline code | -| `break` | A line break | -| `link` | A hyperlink | -| `image` | An image | -| `linkReference` | A pointer to a link | -| `imageReference` | A pointer to an image | -| `footnote` | A footnote | -| `footnoteReference` | A reference to a footnote | -| `embed` | Content embedded from another page, identified by the `url` attribute. | -| `section` | A section within the document. Sections serve as a high-level structure of a single markdown document and can have their own section-specific front matter metadata. | -| `icon` | An SVG icon, identified by the syntax `:foo:` | -| `listItem` | | - -## types - -The inferred class names for the section - -`types` - -- is optional -- type: `string[]` -- defined in this schema - -### types Type - -Array type: `string[]` - -All items must be of the type: `string` - -## url - -For resources, an url field must be present. It represents a URL to the referenced resource. - -`url` - -- is optional -- type: `string` -- defined in this schema - -### url Type - -`string` - -- format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) - -## value - -The string value of the node, if it is a terminal node. - -`value` - -- is optional -- type: `string` -- defined in this schema - -### value Type - -`string` diff --git a/docs/meta-definitions-meta-properties-class.md b/docs/meta-definitions-meta-properties-class.md new file mode 100644 index 000000000..033f2d28c --- /dev/null +++ b/docs/meta-definitions-meta-properties-class.md @@ -0,0 +1,16 @@ +# Untitled string in Meta Schema + +```txt +https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/class +``` + +The CSS class to use for the section instead of the default `hlx-section` one + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [meta.schema.json\*](meta.schema.json "open original schema") | + +## class Type + +`string` diff --git a/docs/meta-definitions-meta-properties-image.md b/docs/meta-definitions-meta-properties-image.md new file mode 100644 index 000000000..d83c4fe86 --- /dev/null +++ b/docs/meta-definitions-meta-properties-image.md @@ -0,0 +1,20 @@ +# Untitled string in Section Schema + +```txt +https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/image +``` + +Path (can be relative) to the first image in the document + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [section.schema.json\*](section.schema.json "open original schema") | + +## image Type + +`string` + +## image Constraints + +**URI reference**: the string must be a URI reference, according to [RFC 3986](https://tools.ietf.org/html/rfc4291 "check the specification") diff --git a/docs/meta-definitions-meta-properties-intro.md b/docs/meta-definitions-meta-properties-intro.md new file mode 100644 index 000000000..1c88cdccd --- /dev/null +++ b/docs/meta-definitions-meta-properties-intro.md @@ -0,0 +1,16 @@ +# Untitled string in Section Schema + +```txt +https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/intro +``` + +Extracted first paragraph of the document + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [section.schema.json\*](section.schema.json "open original schema") | + +## intro Type + +`string` diff --git a/docs/meta-definitions-meta-properties-tagname.md b/docs/meta-definitions-meta-properties-tagname.md new file mode 100644 index 000000000..d1a0951e3 --- /dev/null +++ b/docs/meta-definitions-meta-properties-tagname.md @@ -0,0 +1,16 @@ +# Untitled string in Meta Schema + +```txt +https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/tagname +``` + +The element tag name to use for the section instead of the default `div` one (i.e. `section`, `main`, `aside`) + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [meta.schema.json\*](meta.schema.json "open original schema") | + +## tagname Type + +`string` diff --git a/docs/meta-definitions-meta-properties-title.md b/docs/meta-definitions-meta-properties-title.md new file mode 100644 index 000000000..e08973a1b --- /dev/null +++ b/docs/meta-definitions-meta-properties-title.md @@ -0,0 +1,16 @@ +# Untitled string in Section Schema + +```txt +https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/title +``` + +Extracted title of the document + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [section.schema.json\*](section.schema.json "open original schema") | + +## title Type + +`string` diff --git a/docs/meta-definitions-meta-properties-types-items.md b/docs/meta-definitions-meta-properties-types-items.md new file mode 100644 index 000000000..d4408c72f --- /dev/null +++ b/docs/meta-definitions-meta-properties-types-items.md @@ -0,0 +1,16 @@ +# Untitled string in Meta Schema + +```txt +https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/types/items +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [meta.schema.json\*](meta.schema.json "open original schema") | + +## items Type + +`string` diff --git a/docs/meta-definitions-meta-properties-types.md b/docs/meta-definitions-meta-properties-types.md new file mode 100644 index 000000000..398956971 --- /dev/null +++ b/docs/meta-definitions-meta-properties-types.md @@ -0,0 +1,16 @@ +# Untitled array in Meta Schema + +```txt +https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/types +``` + +The inferred class names for the section + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [meta.schema.json\*](meta.schema.json "open original schema") | + +## types Type + +`string[]` diff --git a/docs/meta-definitions-meta-properties.md b/docs/meta-definitions-meta-properties.md new file mode 100644 index 000000000..d87b67e58 --- /dev/null +++ b/docs/meta-definitions-meta-properties.md @@ -0,0 +1,16 @@ +# \[object Object] Schema + +```txt +https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [meta.schema.json\*](meta.schema.json "open original schema") | + +## properties Type + +unknown diff --git a/docs/meta-definitions-meta.md b/docs/meta-definitions-meta.md new file mode 100644 index 000000000..782175f79 --- /dev/null +++ b/docs/meta-definitions-meta.md @@ -0,0 +1,127 @@ +# Untitled undefined type in Section Schema + +```txt +https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/meta +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ------------ | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [section.schema.json\*](section.schema.json "open original schema") | + +## meta Type + +`object` ([Details](meta-definitions-meta.md)) + +# undefined Properties + +| Property | Type | Required | Nullable | Defined by | +| :------------------ | -------- | -------- | -------------- | :--------------------------------------------------------------------------------------------------------------------------------------- | +| [class](#class) | `string` | Optional | cannot be null | [Meta](meta-definitions-meta-properties-class.md "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/class") | +| [tagname](#tagname) | `string` | Optional | cannot be null | [Meta](meta-definitions-meta-properties-tagname.md "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/tagname") | +| [types](#types) | `array` | Optional | cannot be null | [Meta](meta-definitions-meta-properties-types.md "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/types") | +| [title](#title) | `string` | Optional | cannot be null | [Meta](meta-definitions-meta-properties-title.md "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/title") | +| [intro](#intro) | `string` | Optional | cannot be null | [Meta](meta-definitions-meta-properties-intro.md "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/intro") | +| [image](#image) | `string` | Optional | cannot be null | [Meta](meta-definitions-meta-properties-image.md "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/image") | + +## class + +The CSS class to use for the section instead of the default `hlx-section` one + + +`class` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Meta](meta-definitions-meta-properties-class.md "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/class") + +### class Type + +`string` + +## tagname + +The element tag name to use for the section instead of the default `div` one (i.e. `section`, `main`, `aside`) + + +`tagname` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Meta](meta-definitions-meta-properties-tagname.md "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/tagname") + +### tagname Type + +`string` + +## types + +The inferred class names for the section + + +`types` + +- is optional +- Type: `string[]` +- cannot be null +- defined in: [Meta](meta-definitions-meta-properties-types.md "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/types") + +### types Type + +`string[]` + +## title + +Extracted title of the document + + +`title` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Meta](meta-definitions-meta-properties-title.md "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/title") + +### title Type + +`string` + +## intro + +Extracted first paragraph of the document + + +`intro` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Meta](meta-definitions-meta-properties-intro.md "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/intro") + +### intro Type + +`string` + +## image + +Path (can be relative) to the first image in the document + + +`image` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Meta](meta-definitions-meta-properties-image.md "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/image") + +### image Type + +`string` + +### image Constraints + +**URI reference**: the string must be a URI reference, according to [RFC 3986](https://tools.ietf.org/html/rfc4291 "check the specification") diff --git a/docs/meta-definitions.md b/docs/meta-definitions.md new file mode 100644 index 000000000..51953470c --- /dev/null +++ b/docs/meta-definitions.md @@ -0,0 +1,16 @@ +# Untitled undefined type in Meta Schema + +```txt +https://ns.adobe.com/helix/pipeline/meta#/definitions +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [meta.schema.json\*](meta.schema.json "open original schema") | + +## definitions Type + +unknown diff --git a/docs/meta.md b/docs/meta.md new file mode 100644 index 000000000..9a6c5ed75 --- /dev/null +++ b/docs/meta.md @@ -0,0 +1,135 @@ +# Meta Schema + +```txt +https://ns.adobe.com/helix/pipeline/meta +``` + +Content and Section Metadata Properties + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :--------------------- | ---------- | ----------- | ----------------------- | :---------------- | --------------------- | ------------------- | ----------------------------------------------------------- | +| Cannot be instantiated | Yes | Stabilizing | Unknown identifiability | Forbidden | Allowed | none | [meta.schema.json](meta.schema.json "open original schema") | + +## Meta Type + +unknown ([Meta](meta.md)) + +# Meta Definitions + +## Definitions group meta + +Reference this group by using + +```json +{"$ref":"https://ns.adobe.com/helix/pipeline/meta#/definitions/meta"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :------------------ | -------- | -------- | -------------- | :--------------------------------------------------------------------------------------------------------------------------------------- | +| [class](#class) | `string` | Optional | cannot be null | [Meta](meta-definitions-meta-properties-class.md "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/class") | +| [tagname](#tagname) | `string` | Optional | cannot be null | [Meta](meta-definitions-meta-properties-tagname.md "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/tagname") | +| [types](#types) | `array` | Optional | cannot be null | [Meta](meta-definitions-meta-properties-types.md "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/types") | +| [title](#title) | `string` | Optional | cannot be null | [Meta](meta-definitions-meta-properties-title.md "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/title") | +| [intro](#intro) | `string` | Optional | cannot be null | [Meta](meta-definitions-meta-properties-intro.md "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/intro") | +| [image](#image) | `string` | Optional | cannot be null | [Meta](meta-definitions-meta-properties-image.md "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/image") | + +### class + +The CSS class to use for the section instead of the default `hlx-section` one + + +`class` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Meta](meta-definitions-meta-properties-class.md "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/class") + +#### class Type + +`string` + +### tagname + +The element tag name to use for the section instead of the default `div` one (i.e. `section`, `main`, `aside`) + + +`tagname` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Meta](meta-definitions-meta-properties-tagname.md "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/tagname") + +#### tagname Type + +`string` + +### types + +The inferred class names for the section + + +`types` + +- is optional +- Type: `string[]` +- cannot be null +- defined in: [Meta](meta-definitions-meta-properties-types.md "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/types") + +#### types Type + +`string[]` + +### title + +Extracted title of the document + + +`title` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Meta](meta-definitions-meta-properties-title.md "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/title") + +#### title Type + +`string` + +### intro + +Extracted first paragraph of the document + + +`intro` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Meta](meta-definitions-meta-properties-intro.md "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/intro") + +#### intro Type + +`string` + +### image + +Path (can be relative) to the first image in the document + + +`image` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Meta](meta-definitions-meta-properties-image.md "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/image") + +#### image Type + +`string` + +#### image Constraints + +**URI reference**: the string must be a URI reference, according to [RFC 3986](https://tools.ietf.org/html/rfc4291 "check the specification") diff --git a/docs/meta.schema.json b/docs/meta.schema.json index 110321e7f..425849209 100644 --- a/docs/meta.schema.json +++ b/docs/meta.schema.json @@ -1,56 +1 @@ -{ - "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/pipeline/meta", - "$schema": "http://json-schema.org/draft-07/schema#", - "title": "Meta", - "meta:status": "stabilizing", - "description": "Content and Section Metadata Properties", - "definitions": { - "meta": { - "type": [ - "null", - "object" - ], - "properties": { - "class": { - "type": "string", - "description": "The CSS class to use for the section instead of the default `hlx-section` one" - }, - "tagname": { - "type": "string", - "description": "The element tag name to use for the section instead of the default `div` one (i.e. `section`, `main`, `aside`)" - }, - "types": { - "type": "array", - "description": "The inferred class names for the section", - "items": { - "type": "string" - } - }, - "title": { - "type": "string", - "description": "Extracted title of the document" - }, - "intro": { - "type": "string", - "description": "Extracted first paragraph of the document" - }, - "image": { - "type": "string", - "format": "uri-reference", - "description": "Path (can be relative) to the first image in the document" - } - } - } - } -} \ No newline at end of file +{"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/pipeline/meta","$schema":"http://json-schema.org/draft-07/schema#","title":"Meta","meta:status":"stabilizing","description":"Content and Section Metadata Properties","definitions":{"meta":{"type":["null","object"],"properties":{"class":{"type":"string","description":"The CSS class to use for the section instead of the default `hlx-section` one"},"tagname":{"type":"string","description":"The element tag name to use for the section instead of the default `div` one (i.e. `section`, `main`, `aside`)"},"types":{"type":"array","description":"The inferred class names for the section","items":{"type":"string"}},"title":{"type":"string","description":"Extracted title of the document"},"intro":{"type":"string","description":"Extracted first paragraph of the document"},"image":{"type":"string","format":"uri-reference","description":"Path (can be relative) to the first image in the document"}}}}} diff --git a/docs/meta.schema.md b/docs/meta.schema.md deleted file mode 100644 index 1c86a2dfd..000000000 --- a/docs/meta.schema.md +++ /dev/null @@ -1,110 +0,0 @@ -# Meta Schema - -``` -https://ns.adobe.com/helix/pipeline/meta -``` - -Content and Section Metadata Properties - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Defined In | -| ---------------------- | ---------- | ----------- | ------------ | ----------------- | --------------------- | ------------------------------------ | -| Cannot be instantiated | Yes | Stabilizing | No | Forbidden | Permitted | [meta.schema.json](meta.schema.json) | - -# Meta Definitions - -| Property | Type | Group | -| ------------------- | ---------- | ------------------------------------------------------------ | -| [class](#class) | `string` | `https://ns.adobe.com/helix/pipeline/meta#/definitions/meta` | -| [image](#image) | `string` | `https://ns.adobe.com/helix/pipeline/meta#/definitions/meta` | -| [intro](#intro) | `string` | `https://ns.adobe.com/helix/pipeline/meta#/definitions/meta` | -| [tagname](#tagname) | `string` | `https://ns.adobe.com/helix/pipeline/meta#/definitions/meta` | -| [title](#title) | `string` | `https://ns.adobe.com/helix/pipeline/meta#/definitions/meta` | -| [types](#types) | `string[]` | `https://ns.adobe.com/helix/pipeline/meta#/definitions/meta` | - -## class - -The CSS class to use for the section instead of the default `hlx-section` one - -`class` - -- is optional -- type: `string` -- defined in this schema - -### class Type - -`string` - -## image - -Path (can be relative) to the first image in the document - -`image` - -- is optional -- type: `string` -- defined in this schema - -### image Type - -`string` - -- format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) - -## intro - -Extracted first paragraph of the document - -`intro` - -- is optional -- type: `string` -- defined in this schema - -### intro Type - -`string` - -## tagname - -The element tag name to use for the section instead of the default `div` one (i.e. `section`, `main`, `aside`) - -`tagname` - -- is optional -- type: `string` -- defined in this schema - -### tagname Type - -`string` - -## title - -Extracted title of the document - -`title` - -- is optional -- type: `string` -- defined in this schema - -### title Type - -`string` - -## types - -The inferred class names for the section - -`types` - -- is optional -- type: `string[]` -- defined in this schema - -### types Type - -Array type: `string[]` - -All items must be of the type: `string` diff --git a/docs/position-properties-indent.md b/docs/position-properties-indent.md new file mode 100644 index 000000000..ecd64c4e3 --- /dev/null +++ b/docs/position-properties-indent.md @@ -0,0 +1,16 @@ +# Untitled array in Position Schema + +```txt +https://ns.adobe.com/helix/pipeline/position#/properties/indent +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [position.schema.json\*](position.schema.json "open original schema") | + +## indent Type + +`array` diff --git a/docs/position-properties-text-coordinates.md b/docs/position-properties-text-coordinates.md new file mode 100644 index 000000000..8a266cef4 --- /dev/null +++ b/docs/position-properties-text-coordinates.md @@ -0,0 +1,72 @@ +# Text Coordinates Schema + +```txt +https://ns.adobe.com/helix/pipeline/textcoordinates#/properties/start +``` + +A position in a text document + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | ----------- | ------------ | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------------- | +| Can be instantiated | No | Stabilizing | No | Forbidden | Forbidden | none | [position.schema.json\*](position.schema.json "open original schema") | + +## start Type + +`object` ([Text Coordinates](position-properties-text-coordinates.md)) + +# Text Coordinates Properties + +| Property | Type | Required | Nullable | Defined by | +| :---------------- | -------- | -------- | -------------- | :------------------------------------------------------------------------------------------------------------------------------------- | +| [line](#line) | `number` | Optional | cannot be null | [Text Coordinates](textcoordinates-properties-line.md "https://ns.adobe.com/helix/pipeline/textcoordinates#/properties/line") | +| [column](#column) | `number` | Optional | cannot be null | [Text Coordinates](textcoordinates-properties-column.md "https://ns.adobe.com/helix/pipeline/textcoordinates#/properties/column") | +| [offset](#offset) | `number` | Optional | cannot be null | [Text Coordinates](textcoordinates-properties-offset.md "https://ns.adobe.com/helix/pipeline/textcoordinates#/properties/offset") | + +## line + +Line number + + +`line` + +- is optional +- Type: `number` +- cannot be null +- defined in: [Text Coordinates](textcoordinates-properties-line.md "https://ns.adobe.com/helix/pipeline/textcoordinates#/properties/line") + +### line Type + +`number` + +## column + +Column number + + +`column` + +- is optional +- Type: `number` +- cannot be null +- defined in: [Text Coordinates](textcoordinates-properties-column.md "https://ns.adobe.com/helix/pipeline/textcoordinates#/properties/column") + +### column Type + +`number` + +## offset + +Character in the entire document + + +`offset` + +- is optional +- Type: `number` +- cannot be null +- defined in: [Text Coordinates](textcoordinates-properties-offset.md "https://ns.adobe.com/helix/pipeline/textcoordinates#/properties/offset") + +### offset Type + +`number` diff --git a/docs/position-properties.md b/docs/position-properties.md new file mode 100644 index 000000000..623f1bc81 --- /dev/null +++ b/docs/position-properties.md @@ -0,0 +1,16 @@ +# Untitled undefined type in Position Schema + +```txt +https://ns.adobe.com/helix/pipeline/position#/properties +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [position.schema.json\*](position.schema.json "open original schema") | + +## properties Type + +unknown diff --git a/docs/position.md b/docs/position.md new file mode 100644 index 000000000..69a4f8a74 --- /dev/null +++ b/docs/position.md @@ -0,0 +1,72 @@ +# Position Schema + +```txt +https://ns.adobe.com/helix/pipeline/position +``` + +Marks the position of an AST node in the original text flow + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | ------ | ------------ | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Stable | No | Forbidden | Forbidden | none | [position.schema.json](position.schema.json "open original schema") | + +## Position Type + +`object` ([Position](position.md)) + +# Position Properties + +| Property | Type | Required | Nullable | Defined by | +| :---------------- | -------- | -------- | -------------- | :------------------------------------------------------------------------------------------------------------------------------- | +| [start](#start) | `object` | Optional | cannot be null | [Position](position-properties-text-coordinates.md "https://ns.adobe.com/helix/pipeline/textcoordinates#/properties/start") | +| [end](#end) | `object` | Optional | cannot be null | [Position](position-properties-text-coordinates.md "https://ns.adobe.com/helix/pipeline/textcoordinates#/properties/end") | +| [indent](#indent) | `array` | Optional | cannot be null | [Position](position-properties-indent.md "https://ns.adobe.com/helix/pipeline/position#/properties/indent") | + +## start + +A position in a text document + + +`start` + +- is optional +- Type: `object` ([Text Coordinates](position-properties-text-coordinates.md)) +- cannot be null +- defined in: [Position](position-properties-text-coordinates.md "https://ns.adobe.com/helix/pipeline/textcoordinates#/properties/start") + +### start Type + +`object` ([Text Coordinates](position-properties-text-coordinates.md)) + +## end + +A position in a text document + + +`end` + +- is optional +- Type: `object` ([Text Coordinates](position-properties-text-coordinates.md)) +- cannot be null +- defined in: [Position](position-properties-text-coordinates.md "https://ns.adobe.com/helix/pipeline/textcoordinates#/properties/end") + +### end Type + +`object` ([Text Coordinates](position-properties-text-coordinates.md)) + +## indent + + + + +`indent` + +- is optional +- Type: `array` +- cannot be null +- defined in: [Position](position-properties-indent.md "https://ns.adobe.com/helix/pipeline/position#/properties/indent") + +### indent Type + +`array` diff --git a/docs/position.schema.json b/docs/position.schema.json index 60e84cfea..fd34eab5e 100644 --- a/docs/position.schema.json +++ b/docs/position.schema.json @@ -1,31 +1 @@ -{ - "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/pipeline/position", - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "title": "Position", - "meta:status": "stable", - "description": "Marks the position of an AST node in the original text flow", - "additionalProperties": false, - "properties": { - "start": { - "$ref": "https://ns.adobe.com/helix/pipeline/textcoordinates" - }, - "end": { - "$ref": "https://ns.adobe.com/helix/pipeline/textcoordinates" - }, - "indent": { - "type": "array" - } - } -} \ No newline at end of file +{"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/pipeline/position","$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"Position","meta:status":"stable","description":"Marks the position of an AST node in the original text flow","additionalProperties":false,"properties":{"start":{"$ref":"https://ns.adobe.com/helix/pipeline/textcoordinates"},"end":{"$ref":"https://ns.adobe.com/helix/pipeline/textcoordinates"},"indent":{"type":"array"}}} diff --git a/docs/position.schema.md b/docs/position.schema.md deleted file mode 100644 index eb8ef1327..000000000 --- a/docs/position.schema.md +++ /dev/null @@ -1,60 +0,0 @@ -# Position Schema - -``` -https://ns.adobe.com/helix/pipeline/position -``` - -Marks the position of an AST node in the original text flow - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Defined In | -| ------------------- | ---------- | ------ | ------------ | ----------------- | --------------------- | -------------------------------------------- | -| Can be instantiated | No | Stable | No | Forbidden | Forbidden | [position.schema.json](position.schema.json) | - -## Schema Hierarchy - -- Position `https://ns.adobe.com/helix/pipeline/position` - - [Text Coordinates](textcoordinates.schema.md) `https://ns.adobe.com/helix/pipeline/textcoordinates` - -# Position Properties - -| Property | Type | Required | Nullable | Defined by | -| ----------------- | ---------------- | -------- | -------- | ---------------------- | -| [end](#end) | Text Coordinates | Optional | No | Position (this schema) | -| [indent](#indent) | `array` | Optional | No | Position (this schema) | -| [start](#start) | Text Coordinates | Optional | No | Position (this schema) | - -## end - -`end` - -- is optional -- type: Text Coordinates -- defined in this schema - -### end Type - -- [Text Coordinates](textcoordinates.schema.md) – `https://ns.adobe.com/helix/pipeline/textcoordinates` - -## indent - -`indent` - -- is optional -- type: `array` -- defined in this schema - -### indent Type - -Array type: `array` - -## start - -`start` - -- is optional -- type: Text Coordinates -- defined in this schema - -### start Type - -- [Text Coordinates](textcoordinates.schema.md) – `https://ns.adobe.com/helix/pipeline/textcoordinates` diff --git a/docs/rawrequest-definitions-rawrequest-properties-headers-additionalproperties.md b/docs/rawrequest-definitions-rawrequest-properties-headers-additionalproperties.md new file mode 100644 index 000000000..ec30460e5 --- /dev/null +++ b/docs/rawrequest-definitions-rawrequest-properties-headers-additionalproperties.md @@ -0,0 +1,16 @@ +# Untitled string in Raw Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/headers/additionalProperties +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [rawrequest.schema.json\*](rawrequest.schema.json "open original schema") | + +## additionalProperties Type + +`string` diff --git a/docs/rawrequest-definitions-rawrequest-properties-headers-properties-x-backend-name-metaenum.md b/docs/rawrequest-definitions-rawrequest-properties-headers-properties-x-backend-name-metaenum.md new file mode 100644 index 000000000..b01f32f33 --- /dev/null +++ b/docs/rawrequest-definitions-rawrequest-properties-headers-properties-x-backend-name-metaenum.md @@ -0,0 +1,16 @@ +# Untitled undefined type in Raw Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/headers/properties/x-backend-name/meta:enum +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [rawrequest.schema.json\*](rawrequest.schema.json "open original schema") | + +## meta:enum Type + +unknown diff --git a/docs/rawrequest-definitions-rawrequest-properties-headers-properties-x-backend-name.md b/docs/rawrequest-definitions-rawrequest-properties-headers-properties-x-backend-name.md new file mode 100644 index 000000000..f2e3f1e41 --- /dev/null +++ b/docs/rawrequest-definitions-rawrequest-properties-headers-properties-x-backend-name.md @@ -0,0 +1,16 @@ +# Untitled string in Raw Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/headers/properties/x-backend-name +``` + +Name of the Backend handling the request. + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [rawrequest.schema.json\*](rawrequest.schema.json "open original schema") | + +## x-backend-name Type + +`string` diff --git a/docs/rawrequest-definitions-rawrequest-properties-headers-properties-x-cdn-request-id.md b/docs/rawrequest-definitions-rawrequest-properties-headers-properties-x-cdn-request-id.md new file mode 100644 index 000000000..846a8f2d6 --- /dev/null +++ b/docs/rawrequest-definitions-rawrequest-properties-headers-properties-x-cdn-request-id.md @@ -0,0 +1,16 @@ +# Untitled string in Raw Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/headers/properties/x-cdn-request-id +``` + +Request ID generated by the CDN + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [rawrequest.schema.json\*](rawrequest.schema.json "open original schema") | + +## x-cdn-request-id Type + +`string` diff --git a/docs/rawrequest-definitions-rawrequest-properties-headers-properties-x-openwhisk-activation-id.md b/docs/rawrequest-definitions-rawrequest-properties-headers-properties-x-openwhisk-activation-id.md new file mode 100644 index 000000000..62d7b23e0 --- /dev/null +++ b/docs/rawrequest-definitions-rawrequest-properties-headers-properties-x-openwhisk-activation-id.md @@ -0,0 +1,16 @@ +# Untitled string in Raw Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/headers/properties/x-openwhisk-activation-id +``` + +OpenWhisk Activation ID + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [rawrequest.schema.json\*](rawrequest.schema.json "open original schema") | + +## x-openwhisk-activation-id Type + +`string` diff --git a/docs/rawrequest-definitions-rawrequest-properties-headers-properties-x-request-id.md b/docs/rawrequest-definitions-rawrequest-properties-headers-properties-x-request-id.md new file mode 100644 index 000000000..34a195d6e --- /dev/null +++ b/docs/rawrequest-definitions-rawrequest-properties-headers-properties-x-request-id.md @@ -0,0 +1,16 @@ +# Untitled string in Raw Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/headers/properties/x-request-id +``` + +Request ID generated by OpenWhisk + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [rawrequest.schema.json\*](rawrequest.schema.json "open original schema") | + +## x-request-id Type + +`string` diff --git a/docs/rawrequest-definitions-rawrequest-properties-headers-properties.md b/docs/rawrequest-definitions-rawrequest-properties-headers-properties.md new file mode 100644 index 000000000..5ca8eeff6 --- /dev/null +++ b/docs/rawrequest-definitions-rawrequest-properties-headers-properties.md @@ -0,0 +1,16 @@ +# Untitled undefined type in Raw Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/headers/properties +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [rawrequest.schema.json\*](rawrequest.schema.json "open original schema") | + +## properties Type + +unknown diff --git a/docs/rawrequest-definitions-rawrequest-properties-headers.md b/docs/rawrequest-definitions-rawrequest-properties-headers.md new file mode 100644 index 000000000..ade1b1df1 --- /dev/null +++ b/docs/rawrequest-definitions-rawrequest-properties-headers.md @@ -0,0 +1,106 @@ +# Untitled object in Raw Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/headers +``` + +The headers of the request made to OpenWhisk (or Simulator) + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ------------ | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [rawrequest.schema.json\*](rawrequest.schema.json "open original schema") | + +## headers Type + +`object` ([Details](rawrequest-definitions-rawrequest-properties-headers.md)) + +# undefined Properties + +| Property | Type | Required | Nullable | Defined by | +| :------------------------------------------------------ | -------- | -------- | -------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [x-openwhisk-activation-id](#x-openwhisk-activation-id) | `string` | Optional | cannot be null | [Raw Request](rawrequest-definitions-rawrequest-properties-headers-properties-x-openwhisk-activation-id.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/headers/properties/x-openwhisk-activation-id") | +| [x-request-id](#x-request-id) | `string` | Optional | cannot be null | [Raw Request](rawrequest-definitions-rawrequest-properties-headers-properties-x-request-id.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/headers/properties/x-request-id") | +| [x-cdn-request-id](#x-cdn-request-id) | `string` | Optional | cannot be null | [Raw Request](rawrequest-definitions-rawrequest-properties-headers-properties-x-cdn-request-id.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/headers/properties/x-cdn-request-id") | +| [x-backend-name](#x-backend-name) | `string` | Optional | cannot be null | [Raw Request](rawrequest-definitions-rawrequest-properties-headers-properties-x-backend-name.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/headers/properties/x-backend-name") | +| Additional Properties | `string` | Optional | cannot be null | [Raw Request](rawrequest-definitions-rawrequest-properties-headers-additionalproperties.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/headers/additionalProperties") | + +## x-openwhisk-activation-id + +OpenWhisk Activation ID + + +`x-openwhisk-activation-id` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Raw Request](rawrequest-definitions-rawrequest-properties-headers-properties-x-openwhisk-activation-id.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/headers/properties/x-openwhisk-activation-id") + +### x-openwhisk-activation-id Type + +`string` + +## x-request-id + +Request ID generated by OpenWhisk + + +`x-request-id` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Raw Request](rawrequest-definitions-rawrequest-properties-headers-properties-x-request-id.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/headers/properties/x-request-id") + +### x-request-id Type + +`string` + +## x-cdn-request-id + +Request ID generated by the CDN + + +`x-cdn-request-id` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Raw Request](rawrequest-definitions-rawrequest-properties-headers-properties-x-cdn-request-id.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/headers/properties/x-cdn-request-id") + +### x-cdn-request-id Type + +`string` + +## x-backend-name + +Name of the Backend handling the request. + + +`x-backend-name` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Raw Request](rawrequest-definitions-rawrequest-properties-headers-properties-x-backend-name.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/headers/properties/x-backend-name") + +### x-backend-name Type + +`string` + +## Additional Properties + +Additional properties are allowed, as long as they follow this schema: + + + + +- is optional +- Type: `string` +- cannot be null +- defined in: [Raw Request](rawrequest-definitions-rawrequest-properties-headers-additionalproperties.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/headers/additionalProperties") + +### additionalProperties Type + +`string` diff --git a/docs/rawrequest-definitions-rawrequest-properties-method-metaenum.md b/docs/rawrequest-definitions-rawrequest-properties-method-metaenum.md new file mode 100644 index 000000000..24c004ebd --- /dev/null +++ b/docs/rawrequest-definitions-rawrequest-properties-method-metaenum.md @@ -0,0 +1,16 @@ +# Untitled undefined type in Raw Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/method/meta:enum +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [rawrequest.schema.json\*](rawrequest.schema.json "open original schema") | + +## meta:enum Type + +unknown diff --git a/docs/rawrequest-definitions-rawrequest-properties-method.md b/docs/rawrequest-definitions-rawrequest-properties-method.md new file mode 100644 index 000000000..823827674 --- /dev/null +++ b/docs/rawrequest-definitions-rawrequest-properties-method.md @@ -0,0 +1,16 @@ +# Untitled string in Raw Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/method +``` + +The HTTP method of the request made to OpenWhisk (or Simulator). Note: OpenWhisk converts all methods to lowercase. + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [rawrequest.schema.json\*](rawrequest.schema.json "open original schema") | + +## method Type + +`string` diff --git a/docs/rawrequest-definitions-rawrequest-properties-params-additionalproperties.md b/docs/rawrequest-definitions-rawrequest-properties-params-additionalproperties.md new file mode 100644 index 000000000..2d355107b --- /dev/null +++ b/docs/rawrequest-definitions-rawrequest-properties-params-additionalproperties.md @@ -0,0 +1,16 @@ +# Untitled string in Raw Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/additionalProperties +``` + +All other parameters are interpreted as string. + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [rawrequest.schema.json\*](rawrequest.schema.json "open original schema") | + +## additionalProperties Type + +`string` diff --git a/docs/rawrequest-definitions-rawrequest-properties-params-properties-__ow_headers.md b/docs/rawrequest-definitions-rawrequest-properties-params-properties-__ow_headers.md new file mode 100644 index 000000000..cfb7ce6ec --- /dev/null +++ b/docs/rawrequest-definitions-rawrequest-properties-params-properties-__ow_headers.md @@ -0,0 +1,16 @@ +# Untitled object in Raw Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/__ow_headers +``` + +Deprecated: The original OpenWhisk request headers + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [rawrequest.schema.json\*](rawrequest.schema.json "open original schema") | + +## \_\_ow_headers Type + +`object` ([Details](rawrequest-definitions-rawrequest-properties-params-properties-__ow_headers.md)) diff --git a/docs/rawrequest-definitions-rawrequest-properties-params-properties-branch.md b/docs/rawrequest-definitions-rawrequest-properties-params-properties-branch.md new file mode 100644 index 000000000..dfd1bfb88 --- /dev/null +++ b/docs/rawrequest-definitions-rawrequest-properties-params-properties-branch.md @@ -0,0 +1,16 @@ +# Untitled string in Raw Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/branch +``` + +Name of the branch or tag. defaults back to the value of 'ref' if missing. + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [rawrequest.schema.json\*](rawrequest.schema.json "open original schema") | + +## branch Type + +`string` diff --git a/docs/rawrequest-definitions-rawrequest-properties-params-properties-owner.md b/docs/rawrequest-definitions-rawrequest-properties-params-properties-owner.md new file mode 100644 index 000000000..90dc208c2 --- /dev/null +++ b/docs/rawrequest-definitions-rawrequest-properties-params-properties-owner.md @@ -0,0 +1,16 @@ +# Untitled string in Raw Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/owner +``` + +Owner of the GitHub repository. This is the name of a user or organization. + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [rawrequest.schema.json\*](rawrequest.schema.json "open original schema") | + +## owner Type + +`string` diff --git a/docs/rawrequest-definitions-rawrequest-properties-params-properties-path.md b/docs/rawrequest-definitions-rawrequest-properties-params-properties-path.md new file mode 100644 index 000000000..94a6b2b7c --- /dev/null +++ b/docs/rawrequest-definitions-rawrequest-properties-params-properties-path.md @@ -0,0 +1,22 @@ +# Untitled string in Raw Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/path +``` + +Path to the requested (Markdown) file + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [rawrequest.schema.json\*](rawrequest.schema.json "open original schema") | + +## path Type + +`string` + +## path Examples + +```json +"/general/index.md" +``` diff --git a/docs/rawrequest-definitions-rawrequest-properties-params-properties-ref.md b/docs/rawrequest-definitions-rawrequest-properties-params-properties-ref.md new file mode 100644 index 000000000..c1f1b7a8f --- /dev/null +++ b/docs/rawrequest-definitions-rawrequest-properties-params-properties-ref.md @@ -0,0 +1,16 @@ +# Untitled string in Raw Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/ref +``` + +Name of the branch or tag or the SHA of the commit + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [rawrequest.schema.json\*](rawrequest.schema.json "open original schema") | + +## ref Type + +`string` diff --git a/docs/rawrequest-definitions-rawrequest-properties-params-properties-repo.md b/docs/rawrequest-definitions-rawrequest-properties-params-properties-repo.md new file mode 100644 index 000000000..8ed344d8d --- /dev/null +++ b/docs/rawrequest-definitions-rawrequest-properties-params-properties-repo.md @@ -0,0 +1,16 @@ +# Untitled string in Raw Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/repo +``` + +Repository where content originates + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [rawrequest.schema.json\*](rawrequest.schema.json "open original schema") | + +## repo Type + +`string` diff --git a/docs/rawrequest-definitions-rawrequest-properties-params-properties-rootpath.md b/docs/rawrequest-definitions-rawrequest-properties-params-properties-rootpath.md new file mode 100644 index 000000000..4e55f4781 --- /dev/null +++ b/docs/rawrequest-definitions-rawrequest-properties-params-properties-rootpath.md @@ -0,0 +1,22 @@ +# Untitled string in Raw Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/rootPath +``` + +The request root path of the current strain. + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [rawrequest.schema.json\*](rawrequest.schema.json "open original schema") | + +## rootPath Type + +`string` + +## rootPath Examples + +```json +"/docs/api" +``` diff --git a/docs/rawrequest-definitions-rawrequest-properties-params-properties-strain.md b/docs/rawrequest-definitions-rawrequest-properties-params-properties-strain.md new file mode 100644 index 000000000..e935cbd14 --- /dev/null +++ b/docs/rawrequest-definitions-rawrequest-properties-params-properties-strain.md @@ -0,0 +1,16 @@ +# Untitled string in Raw Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/strain +``` + +The resolved strain (variant) + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [rawrequest.schema.json\*](rawrequest.schema.json "open original schema") | + +## strain Type + +`string` diff --git a/docs/rawrequest-definitions-rawrequest-properties-params-properties.md b/docs/rawrequest-definitions-rawrequest-properties-params-properties.md new file mode 100644 index 000000000..4e6dd5e05 --- /dev/null +++ b/docs/rawrequest-definitions-rawrequest-properties-params-properties.md @@ -0,0 +1,16 @@ +# Untitled undefined type in Raw Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [rawrequest.schema.json\*](rawrequest.schema.json "open original schema") | + +## properties Type + +unknown diff --git a/docs/rawrequest-definitions-rawrequest-properties-params.md b/docs/rawrequest-definitions-rawrequest-properties-params.md new file mode 100644 index 000000000..7ec3857f4 --- /dev/null +++ b/docs/rawrequest-definitions-rawrequest-properties-params.md @@ -0,0 +1,186 @@ +# Untitled object in Raw Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params +``` + +Parameters used to invoke the OpenWhisk action. These are either URL parameters added when invoking the action from the CDN or default parameters set during creation of the action. + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ------------ | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [rawrequest.schema.json\*](rawrequest.schema.json "open original schema") | + +## params Type + +`object` ([Details](rawrequest-definitions-rawrequest-properties-params.md)) + +# undefined Properties + +| Property | Type | Required | Nullable | Defined by | +| :------------------------------ | -------- | -------- | -------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [owner](#owner) | `string` | Optional | cannot be null | [Raw Request](rawrequest-definitions-rawrequest-properties-params-properties-owner.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/owner") | +| [repo](#repo) | `string` | Optional | cannot be null | [Raw Request](rawrequest-definitions-rawrequest-properties-params-properties-repo.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/repo") | +| [ref](#ref) | `string` | Optional | cannot be null | [Raw Request](rawrequest-definitions-rawrequest-properties-params-properties-ref.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/ref") | +| [branch](#branch) | `string` | Optional | cannot be null | [Raw Request](rawrequest-definitions-rawrequest-properties-params-properties-branch.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/branch") | +| [path](#path) | `string` | Optional | cannot be null | [Raw Request](rawrequest-definitions-rawrequest-properties-params-properties-path.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/path") | +| [rootPath](#rootPath) | `string` | Optional | cannot be null | [Raw Request](rawrequest-definitions-rawrequest-properties-params-properties-rootpath.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/rootPath") | +| [strain](#strain) | `string` | Optional | cannot be null | [Raw Request](rawrequest-definitions-rawrequest-properties-params-properties-strain.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/strain") | +| [\_\_ow_headers](#__ow_headers) | `object` | Optional | cannot be null | [Raw Request](rawrequest-definitions-rawrequest-properties-params-properties-__ow_headers.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/\_\_ow_headers") | +| Additional Properties | `string` | Optional | cannot be null | [Raw Request](rawrequest-definitions-rawrequest-properties-params-additionalproperties.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/additionalProperties") | + +## owner + +Owner of the GitHub repository. This is the name of a user or organization. + + +`owner` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Raw Request](rawrequest-definitions-rawrequest-properties-params-properties-owner.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/owner") + +### owner Type + +`string` + +## repo + +Repository where content originates + + +`repo` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Raw Request](rawrequest-definitions-rawrequest-properties-params-properties-repo.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/repo") + +### repo Type + +`string` + +## ref + +Name of the branch or tag or the SHA of the commit + + +`ref` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Raw Request](rawrequest-definitions-rawrequest-properties-params-properties-ref.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/ref") + +### ref Type + +`string` + +## branch + +Name of the branch or tag. defaults back to the value of 'ref' if missing. + + +`branch` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Raw Request](rawrequest-definitions-rawrequest-properties-params-properties-branch.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/branch") + +### branch Type + +`string` + +## path + +Path to the requested (Markdown) file + + +`path` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Raw Request](rawrequest-definitions-rawrequest-properties-params-properties-path.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/path") + +### path Type + +`string` + +### path Examples + +```json +"/general/index.md" +``` + +## rootPath + +The request root path of the current strain. + + +`rootPath` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Raw Request](rawrequest-definitions-rawrequest-properties-params-properties-rootpath.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/rootPath") + +### rootPath Type + +`string` + +### rootPath Examples + +```json +"/docs/api" +``` + +## strain + +The resolved strain (variant) + + +`strain` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Raw Request](rawrequest-definitions-rawrequest-properties-params-properties-strain.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/strain") + +### strain Type + +`string` + +## \_\_ow_headers + +Deprecated: The original OpenWhisk request headers + + +`__ow_headers` + +- is optional +- Type: `object` ([Details](rawrequest-definitions-rawrequest-properties-params-properties-__ow_headers.md)) +- cannot be null +- defined in: [Raw Request](rawrequest-definitions-rawrequest-properties-params-properties-__ow_headers.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/\_\_ow_headers") + +### \_\_ow_headers Type + +`object` ([Details](rawrequest-definitions-rawrequest-properties-params-properties-__ow_headers.md)) + +## Additional Properties + +Additional properties are allowed, as long as they follow this schema: + +All other parameters are interpreted as string. + + +- is optional +- Type: `string` +- cannot be null +- defined in: [Raw Request](rawrequest-definitions-rawrequest-properties-params-additionalproperties.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/additionalProperties") + +### additionalProperties Type + +`string` diff --git a/docs/rawrequest-definitions-rawrequest-properties.md b/docs/rawrequest-definitions-rawrequest-properties.md new file mode 100644 index 000000000..8a167d116 --- /dev/null +++ b/docs/rawrequest-definitions-rawrequest-properties.md @@ -0,0 +1,16 @@ +# Untitled undefined type in Raw Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [rawrequest.schema.json\*](rawrequest.schema.json "open original schema") | + +## properties Type + +unknown diff --git a/docs/rawrequest-definitions-rawrequest.md b/docs/rawrequest-definitions-rawrequest.md new file mode 100644 index 000000000..36384655c --- /dev/null +++ b/docs/rawrequest-definitions-rawrequest.md @@ -0,0 +1,72 @@ +# Untitled undefined type in Raw Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/rawrequest#/allOf/0 +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ------------ | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [rawrequest.schema.json\*](rawrequest.schema.json "open original schema") | + +## 0 Type + +unknown + +# undefined Properties + +| Property | Type | Required | Nullable | Defined by | +| :------------------ | -------- | -------- | -------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [headers](#headers) | `object` | Optional | cannot be null | [Raw Request](rawrequest-definitions-rawrequest-properties-headers.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/headers") | +| [method](#method) | `string` | Optional | cannot be null | [Raw Request](rawrequest-definitions-rawrequest-properties-method.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/method") | +| [params](#params) | `object` | Optional | cannot be null | [Raw Request](rawrequest-definitions-rawrequest-properties-params.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params") | + +## headers + +The headers of the request made to OpenWhisk (or Simulator) + + +`headers` + +- is optional +- Type: `object` ([Details](rawrequest-definitions-rawrequest-properties-headers.md)) +- cannot be null +- defined in: [Raw Request](rawrequest-definitions-rawrequest-properties-headers.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/headers") + +### headers Type + +`object` ([Details](rawrequest-definitions-rawrequest-properties-headers.md)) + +## method + +The HTTP method of the request made to OpenWhisk (or Simulator). Note: OpenWhisk converts all methods to lowercase. + + +`method` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Raw Request](rawrequest-definitions-rawrequest-properties-method.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/method") + +### method Type + +`string` + +## params + +Parameters used to invoke the OpenWhisk action. These are either URL parameters added when invoking the action from the CDN or default parameters set during creation of the action. + + +`params` + +- is optional +- Type: `object` ([Details](rawrequest-definitions-rawrequest-properties-params.md)) +- cannot be null +- defined in: [Raw Request](rawrequest-definitions-rawrequest-properties-params.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params") + +### params Type + +`object` ([Details](rawrequest-definitions-rawrequest-properties-params.md)) diff --git a/docs/rawrequest-definitions.md b/docs/rawrequest-definitions.md new file mode 100644 index 000000000..2c731a0f8 --- /dev/null +++ b/docs/rawrequest-definitions.md @@ -0,0 +1,16 @@ +# Untitled undefined type in Raw Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/rawrequest#/definitions +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [rawrequest.schema.json\*](rawrequest.schema.json "open original schema") | + +## definitions Type + +unknown diff --git a/docs/rawrequest.md b/docs/rawrequest.md new file mode 100644 index 000000000..4ebbad1be --- /dev/null +++ b/docs/rawrequest.md @@ -0,0 +1,84 @@ +# Raw Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/rawrequest +``` + +The Request Object used for Invoking OpenWhisk + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :--------------------- | ---------- | ------------ | ----------------------- | :---------------- | --------------------- | ------------------- | ----------------------------------------------------------------------- | +| Cannot be instantiated | Yes | Experimental | Unknown identifiability | Forbidden | Allowed | none | [rawrequest.schema.json](rawrequest.schema.json "open original schema") | + +## Raw Request Type + +`object` ([Raw Request](rawrequest.md)) + +all of + +- [Untitled undefined type in Raw Request](rawrequest-definitions-rawrequest.md "check type definition") + +# Raw Request Definitions + +## Definitions group rawrequest + +Reference this group by using + +```json +{"$ref":"https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :------------------ | -------- | -------- | -------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [headers](#headers) | `object` | Optional | cannot be null | [Raw Request](rawrequest-definitions-rawrequest-properties-headers.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/headers") | +| [method](#method) | `string` | Optional | cannot be null | [Raw Request](rawrequest-definitions-rawrequest-properties-method.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/method") | +| [params](#params) | `object` | Optional | cannot be null | [Raw Request](rawrequest-definitions-rawrequest-properties-params.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params") | + +### headers + +The headers of the request made to OpenWhisk (or Simulator) + + +`headers` + +- is optional +- Type: `object` ([Details](rawrequest-definitions-rawrequest-properties-headers.md)) +- cannot be null +- defined in: [Raw Request](rawrequest-definitions-rawrequest-properties-headers.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/headers") + +#### headers Type + +`object` ([Details](rawrequest-definitions-rawrequest-properties-headers.md)) + +### method + +The HTTP method of the request made to OpenWhisk (or Simulator). Note: OpenWhisk converts all methods to lowercase. + + +`method` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Raw Request](rawrequest-definitions-rawrequest-properties-method.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/method") + +#### method Type + +`string` + +### params + +Parameters used to invoke the OpenWhisk action. These are either URL parameters added when invoking the action from the CDN or default parameters set during creation of the action. + + +`params` + +- is optional +- Type: `object` ([Details](rawrequest-definitions-rawrequest-properties-params.md)) +- cannot be null +- defined in: [Raw Request](rawrequest-definitions-rawrequest-properties-params.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params") + +#### params Type + +`object` ([Details](rawrequest-definitions-rawrequest-properties-params.md)) diff --git a/docs/rawrequest.schema.json b/docs/rawrequest.schema.json index 6693ad67b..26175601b 100644 --- a/docs/rawrequest.schema.json +++ b/docs/rawrequest.schema.json @@ -1,117 +1 @@ -{ - "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/pipeline/rawrequest", - "$schema": "http://json-schema.org/draft-07/schema#", - "title": "Raw Request", - "type": "object", - "meta:status": "experimental", - "description": "The Request Object used for Invoking OpenWhisk", - "definitions": { - "rawrequest": { - "additionalProperties": false, - "properties": { - "headers": { - "type": "object", - "description": "The headers of the request made to OpenWhisk (or Simulator)", - "additionalProperties": { - "type": "string" - }, - "properties": { - "x-openwhisk-activation-id": { - "type": "string", - "description": "OpenWhisk Activation ID" - }, - "x-request-id": { - "type": "string", - "description": "Request ID generated by OpenWhisk" - }, - "x-cdn-request-id": { - "type": "string", - "description": "Request ID generated by the CDN" - }, - "x-backend-name": { - "type": "string", - "description": "Name of the Backend handling the request.", - "meta:enum": { - "localhost--F_Petridish": "Fake Backend name of the local Simulator server" - } - } - } - }, - "method": { - "type": "string", - "description": "The HTTP method of the request made to OpenWhisk (or Simulator). Note: OpenWhisk converts all methods to lowercase.", - "meta:enum": { - "get": "GET request", - "post": "POST request", - "put": "PUT request (not handled by Helix)", - "delete": "DELETE request (not handled by Helix)" - } - }, - "params": { - "type": "object", - "description": "Parameters used to invoke the OpenWhisk action. These are either URL parameters added when invoking the action from the CDN or default parameters set during creation of the action.", - "additionalProperties": { - "type": "string", - "description": "All other parameters are interpreted as string." - }, - "properties": { - "owner": { - "type": "string", - "description": "Owner of the GitHub repository. This is the name of a user or organization." - }, - "repo": { - "type": "string", - "description": "Repository where content originates" - }, - "ref": { - "type": "string", - "description": "Name of the branch or tag or the SHA of the commit" - }, - "branch": { - "type": "string", - "description": "Name of the branch or tag. defaults back to the value of 'ref' if missing." - }, - "path": { - "type": "string", - "description": "Path to the requested (Markdown) file", - "examples": [ - "/general/index.md" - ] - }, - "rootPath": { - "type": "string", - "description": "The request root path of the current strain.", - "examples": [ - "/docs/api" - ] - }, - "strain": { - "type": "string", - "description": "The resolved strain (variant)" - }, - "__ow_headers": { - "type": "object", - "description": "Deprecated: The original OpenWhisk request headers" - } - } - } - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/rawrequest" - } - ] -} \ No newline at end of file +{"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/pipeline/rawrequest","$schema":"http://json-schema.org/draft-07/schema#","title":"Raw Request","type":"object","meta:status":"experimental","description":"The Request Object used for Invoking OpenWhisk","definitions":{"rawrequest":{"additionalProperties":false,"properties":{"headers":{"type":"object","description":"The headers of the request made to OpenWhisk (or Simulator)","additionalProperties":{"type":"string"},"properties":{"x-openwhisk-activation-id":{"type":"string","description":"OpenWhisk Activation ID"},"x-request-id":{"type":"string","description":"Request ID generated by OpenWhisk"},"x-cdn-request-id":{"type":"string","description":"Request ID generated by the CDN"},"x-backend-name":{"type":"string","description":"Name of the Backend handling the request.","meta:enum":{"localhost--F_Petridish":"Fake Backend name of the local Simulator server"}}}},"method":{"type":"string","description":"The HTTP method of the request made to OpenWhisk (or Simulator). Note: OpenWhisk converts all methods to lowercase.","meta:enum":{"get":"GET request","post":"POST request","put":"PUT request (not handled by Helix)","delete":"DELETE request (not handled by Helix)"}},"params":{"type":"object","description":"Parameters used to invoke the OpenWhisk action. These are either URL parameters added when invoking the action from the CDN or default parameters set during creation of the action.","additionalProperties":{"type":"string","description":"All other parameters are interpreted as string."},"properties":{"owner":{"type":"string","description":"Owner of the GitHub repository. This is the name of a user or organization."},"repo":{"type":"string","description":"Repository where content originates"},"ref":{"type":"string","description":"Name of the branch or tag or the SHA of the commit"},"branch":{"type":"string","description":"Name of the branch or tag. defaults back to the value of 'ref' if missing."},"path":{"type":"string","description":"Path to the requested (Markdown) file","examples":["/general/index.md"]},"rootPath":{"type":"string","description":"The request root path of the current strain.","examples":["/docs/api"]},"strain":{"type":"string","description":"The resolved strain (variant)"},"__ow_headers":{"type":"object","description":"Deprecated: The original OpenWhisk request headers"}}}}}},"allOf":[{"$ref":"#/definitions/rawrequest"}]} diff --git a/docs/rawrequest.schema.md b/docs/rawrequest.schema.md deleted file mode 100644 index 1be000ebc..000000000 --- a/docs/rawrequest.schema.md +++ /dev/null @@ -1,274 +0,0 @@ -# Raw Request Schema - -``` -https://ns.adobe.com/helix/pipeline/rawrequest -``` - -The Request Object used for Invoking OpenWhisk - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Defined In | -| ------------------- | ---------- | ------------ | ------------ | ----------------- | --------------------- | ------------------------------------------------ | -| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [rawrequest.schema.json](rawrequest.schema.json) | - -# Raw Request Properties - -| Property | Type | Required | Nullable | Defined by | -| ------------------- | -------- | ---------- | -------- | ------------------------------------------ | -| [headers](#headers) | `object` | Optional | No | Raw Request (this schema) | -| [method](#method) | `string` | Optional | No | Raw Request (this schema) | -| [params](#params) | `object` | Optional | No | Raw Request (this schema) | -| `*` | any | Additional | Yes | this schema _allows_ additional properties | - -## headers - -The headers of the request made to OpenWhisk (or Simulator) - -`headers` - -- is optional -- type: `object` -- defined in this schema - -### headers Type - -`object` with following properties: - -| Property | Type | Required | -| --------------------------- | ------ | -------- | -| `x-backend-name` | string | Optional | -| `x-cdn-request-id` | string | Optional | -| `x-openwhisk-activation-id` | string | Optional | -| `x-request-id` | string | Optional | - -#### x-backend-name - -Name of the Backend handling the request. - -`x-backend-name` - -- is optional -- type: `string` - -##### x-backend-name Type - -`string` - -##### x-backend-name Known Values - -| Value | Description | -| ------------------------ | ----------------------------------------------- | -| `localhost--F_Petridish` | Fake Backend name of the local Simulator server | - -#### x-cdn-request-id - -Request ID generated by the CDN - -`x-cdn-request-id` - -- is optional -- type: `string` - -##### x-cdn-request-id Type - -`string` - -#### x-openwhisk-activation-id - -OpenWhisk Activation ID - -`x-openwhisk-activation-id` - -- is optional -- type: `string` - -##### x-openwhisk-activation-id Type - -`string` - -#### x-request-id - -Request ID generated by OpenWhisk - -`x-request-id` - -- is optional -- type: `string` - -##### x-request-id Type - -`string` - -## method - -The HTTP method of the request made to OpenWhisk (or Simulator). Note: OpenWhisk converts all methods to lowercase. - -`method` - -- is optional -- type: `string` -- defined in this schema - -### method Type - -`string` - -### method Known Values - -| Value | Description | -| -------- | ------------------------------------- | -| `get` | GET request | -| `post` | POST request | -| `put` | PUT request (not handled by Helix) | -| `delete` | DELETE request (not handled by Helix) | - -## params - -Parameters used to invoke the OpenWhisk action. These are either URL parameters added when invoking the action from the -CDN or default parameters set during creation of the action. - -`params` - -- is optional -- type: `object` -- defined in this schema - -### params Type - -`object` with following properties: - -| Property | Type | Required | -| -------------- | ------ | -------- | -| `__ow_headers` | object | Optional | -| `branch` | string | Optional | -| `owner` | string | Optional | -| `path` | string | Optional | -| `ref` | string | Optional | -| `repo` | string | Optional | -| `rootPath` | string | Optional | -| `strain` | string | Optional | - -#### \_\_ow_headers - -Deprecated: The original OpenWhisk request headers - -`__ow_headers` - -- is optional -- type: `object` - -##### \_\_ow_headers Type - -`object` with following properties: - -| Property | Type | Required | -| -------- | ---- | -------- | - - -#### branch - -Name of the branch or tag. defaults back to the value of 'ref' if missing. - -`branch` - -- is optional -- type: `string` - -##### branch Type - -`string` - -#### owner - -Owner of the GitHub repository. This is the name of a user or organization. - -`owner` - -- is optional -- type: `string` - -##### owner Type - -`string` - -#### path - -Path to the requested (Markdown) file - -`path` - -- is optional -- type: `string` - -##### path Type - -`string` - -##### path Example - -```json -/general/deinx.md -``` - -#### ref - -Name of the branch or tag or the SHA of the commit - -`ref` - -- is optional -- type: `string` - -##### ref Type - -`string` - -#### repo - -Repository where content originates - -`repo` - -- is optional -- type: `string` - -##### repo Type - -`string` - -#### rootPath - -The request root path of the current strain. - -`rootPath` - -- is optional -- type: `string` - -##### rootPath Type - -`string` - -##### rootPath Example - -```json -/docs/aip -``` - -#### strain - -The resolved strain (variant) - -`strain` - -- is optional -- type: `string` - -##### strain Type - -`string` - -**All** of the following _requirements_ need to be fulfilled. - -#### Requirement 1 - -- []() – `#/definitions/rawrequest` diff --git a/docs/request-properties-extension.md b/docs/request-properties-extension.md new file mode 100644 index 000000000..989372f07 --- /dev/null +++ b/docs/request-properties-extension.md @@ -0,0 +1,26 @@ +# Untitled string in Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/request#/properties/extension +``` + +The extension of the requested resource + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [request.schema.json\*](request.schema.json "open original schema") | + +## extension Type + +`string` + +## extension Examples + +```json +"html" +``` + +```json +"json" +``` diff --git a/docs/request-properties-headers-additionalproperties.md b/docs/request-properties-headers-additionalproperties.md new file mode 100644 index 000000000..19b307720 --- /dev/null +++ b/docs/request-properties-headers-additionalproperties.md @@ -0,0 +1,16 @@ +# Untitled string in Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/request#/properties/headers/additionalProperties +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [request.schema.json\*](request.schema.json "open original schema") | + +## additionalProperties Type + +`string` diff --git a/docs/request-properties-headers.md b/docs/request-properties-headers.md new file mode 100644 index 000000000..6ac8ae965 --- /dev/null +++ b/docs/request-properties-headers.md @@ -0,0 +1,38 @@ +# Untitled undefined type in Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/request#/properties/headers +``` + +The HTTP headers of the request. Note: all header names will be lower-case. + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [request.schema.json\*](request.schema.json "open original schema") | + +## headers Type + +unknown + +# undefined Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------------- | -------- | -------- | -------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Additional Properties | `string` | Optional | cannot be null | [Request](request-properties-headers-additionalproperties.md "https://ns.adobe.com/helix/pipeline/request#/properties/headers/additionalProperties") | + +## Additional Properties + +Additional properties are allowed, as long as they follow this schema: + + + + +- is optional +- Type: `string` +- cannot be null +- defined in: [Request](request-properties-headers-additionalproperties.md "https://ns.adobe.com/helix/pipeline/request#/properties/headers/additionalProperties") + +### additionalProperties Type + +`string` diff --git a/docs/request-properties-method-metaenum.md b/docs/request-properties-method-metaenum.md new file mode 100644 index 000000000..46eba1886 --- /dev/null +++ b/docs/request-properties-method-metaenum.md @@ -0,0 +1,16 @@ +# Untitled undefined type in Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/request#/properties/method/meta:enum +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [request.schema.json\*](request.schema.json "open original schema") | + +## meta:enum Type + +unknown diff --git a/docs/request-properties-method.md b/docs/request-properties-method.md new file mode 100644 index 000000000..5d74d782d --- /dev/null +++ b/docs/request-properties-method.md @@ -0,0 +1,16 @@ +# Untitled string in Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/request#/properties/method +``` + +The HTTP method of the request. Note: method names can be lower-case. + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [request.schema.json\*](request.schema.json "open original schema") | + +## method Type + +`string` diff --git a/docs/request-properties-params-additionalproperties-anyof-0.md b/docs/request-properties-params-additionalproperties-anyof-0.md new file mode 100644 index 000000000..b8b7e52bc --- /dev/null +++ b/docs/request-properties-params-additionalproperties-anyof-0.md @@ -0,0 +1,16 @@ +# Untitled string in Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/request#/properties/params/additionalProperties/anyOf/0 +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [request.schema.json\*](request.schema.json "open original schema") | + +## 0 Type + +`string` diff --git a/docs/request-properties-params-additionalproperties-anyof-1-items.md b/docs/request-properties-params-additionalproperties-anyof-1-items.md new file mode 100644 index 000000000..8bed8aa38 --- /dev/null +++ b/docs/request-properties-params-additionalproperties-anyof-1-items.md @@ -0,0 +1,16 @@ +# Untitled string in Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/request#/properties/params/additionalProperties/anyOf/1/items +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [request.schema.json\*](request.schema.json "open original schema") | + +## items Type + +`string` diff --git a/docs/request-properties-params-additionalproperties-anyof-1.md b/docs/request-properties-params-additionalproperties-anyof-1.md new file mode 100644 index 000000000..3f81069a2 --- /dev/null +++ b/docs/request-properties-params-additionalproperties-anyof-1.md @@ -0,0 +1,16 @@ +# Untitled array in Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/request#/properties/params/additionalProperties/anyOf/1 +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [request.schema.json\*](request.schema.json "open original schema") | + +## 1 Type + +`string[]` diff --git a/docs/request-properties-params-additionalproperties.md b/docs/request-properties-params-additionalproperties.md new file mode 100644 index 000000000..bd7fd03d4 --- /dev/null +++ b/docs/request-properties-params-additionalproperties.md @@ -0,0 +1,21 @@ +# Untitled undefined type in Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/request#/properties/params/additionalProperties +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [request.schema.json\*](request.schema.json "open original schema") | + +## additionalProperties Type + +merged type ([Details](request-properties-params-additionalproperties.md)) + +any of + +- [Untitled string in Request](request-properties-params-additionalproperties-anyof-0.md "check type definition") +- [Untitled array in Request](request-properties-params-additionalproperties-anyof-1.md "check type definition") diff --git a/docs/request-properties-params.md b/docs/request-properties-params.md new file mode 100644 index 000000000..d31bd29cd --- /dev/null +++ b/docs/request-properties-params.md @@ -0,0 +1,43 @@ +# Untitled object in Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/request#/properties/params +``` + +The passed through (and filtered) URL parameters of the request + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [request.schema.json\*](request.schema.json "open original schema") | + +## params Type + +`object` ([Details](request-properties-params.md)) + +# undefined Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------------- | ------ | -------- | -------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Additional Properties | Merged | Optional | cannot be null | [Request](request-properties-params-additionalproperties.md "https://ns.adobe.com/helix/pipeline/request#/properties/params/additionalProperties") | + +## Additional Properties + +Additional properties are allowed, as long as they follow this schema: + + + + +- is optional +- Type: merged type ([Details](request-properties-params-additionalproperties.md)) +- cannot be null +- defined in: [Request](request-properties-params-additionalproperties.md "https://ns.adobe.com/helix/pipeline/request#/properties/params/additionalProperties") + +### additionalProperties Type + +merged type ([Details](request-properties-params-additionalproperties.md)) + +any of + +- [Untitled string in Request](request-properties-params-additionalproperties-anyof-0.md "check type definition") +- [Untitled array in Request](request-properties-params-additionalproperties-anyof-1.md "check type definition") diff --git a/docs/request-properties-path.md b/docs/request-properties-path.md new file mode 100644 index 000000000..49384c7c2 --- /dev/null +++ b/docs/request-properties-path.md @@ -0,0 +1,22 @@ +# Untitled string in Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/request#/properties/path +``` + +The path of the client request URL + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [request.schema.json\*](request.schema.json "open original schema") | + +## path Type + +`string` + +## path Examples + +```json +"/docs/api/general/index.nav.html" +``` diff --git a/docs/request-properties-pathinfo.md b/docs/request-properties-pathinfo.md new file mode 100644 index 000000000..2ff116705 --- /dev/null +++ b/docs/request-properties-pathinfo.md @@ -0,0 +1,22 @@ +# Untitled string in Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/request#/properties/pathInfo +``` + +The part of the client path that is relative to the rootPath + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [request.schema.json\*](request.schema.json "open original schema") | + +## pathInfo Type + +`string` + +## pathInfo Examples + +```json +"/general/index.nav.html" +``` diff --git a/docs/request-properties-querystring.md b/docs/request-properties-querystring.md new file mode 100644 index 000000000..91f7ca116 --- /dev/null +++ b/docs/request-properties-querystring.md @@ -0,0 +1,22 @@ +# Untitled string in Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/request#/properties/queryString +``` + +The original query string + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [request.schema.json\*](request.schema.json "open original schema") | + +## queryString Type + +`string` + +## queryString Examples + +```json +"?parameter1=foo¶meter2=bar" +``` diff --git a/docs/request-properties-rootpath.md b/docs/request-properties-rootpath.md new file mode 100644 index 000000000..021d36bba --- /dev/null +++ b/docs/request-properties-rootpath.md @@ -0,0 +1,22 @@ +# Untitled string in Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/request#/properties/rootPath +``` + +The request root path of the current strain. + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [request.schema.json\*](request.schema.json "open original schema") | + +## rootPath Type + +`string` + +## rootPath Examples + +```json +"/docs/api" +``` diff --git a/docs/request-properties-selector.md b/docs/request-properties-selector.md new file mode 100644 index 000000000..548601582 --- /dev/null +++ b/docs/request-properties-selector.md @@ -0,0 +1,26 @@ +# Untitled string in Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/request#/properties/selector +``` + +The selector (sub-type indicator) + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [request.schema.json\*](request.schema.json "open original schema") | + +## selector Type + +`string` + +## selector Examples + +```json +"" +``` + +```json +"nav" +``` diff --git a/docs/request-properties-url.md b/docs/request-properties-url.md new file mode 100644 index 000000000..c3ebf7106 --- /dev/null +++ b/docs/request-properties-url.md @@ -0,0 +1,22 @@ +# Untitled string in Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/request#/properties/url +``` + +The path and request parameters of the client request URL + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [request.schema.json\*](request.schema.json "open original schema") | + +## url Type + +`string` + +## url Examples + +```json +"/docs/api/general/index.nav.html?a=1" +``` diff --git a/docs/request-properties.md b/docs/request-properties.md new file mode 100644 index 000000000..37c20d911 --- /dev/null +++ b/docs/request-properties.md @@ -0,0 +1,16 @@ +# Untitled undefined type in Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/request#/properties +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [request.schema.json\*](request.schema.json "open original schema") | + +## properties Type + +unknown diff --git a/docs/request.md b/docs/request.md new file mode 100644 index 000000000..96e829e62 --- /dev/null +++ b/docs/request.md @@ -0,0 +1,241 @@ +# Request Schema + +```txt +https://ns.adobe.com/helix/pipeline/request +``` + +The HTTP Request + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | ----------- | ------------ | :---------------- | --------------------- | ------------------- | ----------------------------------------------------------------- | +| Can be instantiated | No | Stabilizing | No | Forbidden | Forbidden | none | [request.schema.json](request.schema.json "open original schema") | + +## Request Type + +`object` ([Request](request.md)) + +# Request Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------------------- | ------------- | -------- | -------------- | :---------------------------------------------------------------------------------------------------------------------- | +| [url](#url) | `string` | Optional | cannot be null | [Request](request-properties-url.md "https://ns.adobe.com/helix/pipeline/request#/properties/url") | +| [path](#path) | `string` | Optional | cannot be null | [Request](request-properties-path.md "https://ns.adobe.com/helix/pipeline/request#/properties/path") | +| [pathInfo](#pathInfo) | `string` | Optional | cannot be null | [Request](request-properties-pathinfo.md "https://ns.adobe.com/helix/pipeline/request#/properties/pathInfo") | +| [rootPath](#rootPath) | `string` | Optional | cannot be null | [Request](request-properties-rootpath.md "https://ns.adobe.com/helix/pipeline/request#/properties/rootPath") | +| [selector](#selector) | `string` | Optional | cannot be null | [Request](request-properties-selector.md "https://ns.adobe.com/helix/pipeline/request#/properties/selector") | +| [extension](#extension) | `string` | Optional | cannot be null | [Request](request-properties-extension.md "https://ns.adobe.com/helix/pipeline/request#/properties/extension") | +| [method](#method) | `string` | Optional | cannot be null | [Request](request-properties-method.md "https://ns.adobe.com/helix/pipeline/request#/properties/method") | +| [headers](#headers) | Not specified | Optional | cannot be null | [Request](request-properties-headers.md "https://ns.adobe.com/helix/pipeline/request#/properties/headers") | +| [params](#params) | `object` | Optional | cannot be null | [Request](request-properties-params.md "https://ns.adobe.com/helix/pipeline/request#/properties/params") | +| [queryString](#queryString) | `string` | Optional | cannot be null | [Request](request-properties-querystring.md "https://ns.adobe.com/helix/pipeline/request#/properties/queryString") | + +## url + +The path and request parameters of the client request URL + + +`url` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Request](request-properties-url.md "https://ns.adobe.com/helix/pipeline/request#/properties/url") + +### url Type + +`string` + +### url Examples + +```json +"/docs/api/general/index.nav.html?a=1" +``` + +## path + +The path of the client request URL + + +`path` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Request](request-properties-path.md "https://ns.adobe.com/helix/pipeline/request#/properties/path") + +### path Type + +`string` + +### path Examples + +```json +"/docs/api/general/index.nav.html" +``` + +## pathInfo + +The part of the client path that is relative to the rootPath + + +`pathInfo` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Request](request-properties-pathinfo.md "https://ns.adobe.com/helix/pipeline/request#/properties/pathInfo") + +### pathInfo Type + +`string` + +### pathInfo Examples + +```json +"/general/index.nav.html" +``` + +## rootPath + +The request root path of the current strain. + + +`rootPath` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Request](request-properties-rootpath.md "https://ns.adobe.com/helix/pipeline/request#/properties/rootPath") + +### rootPath Type + +`string` + +### rootPath Examples + +```json +"/docs/api" +``` + +## selector + +The selector (sub-type indicator) + + +`selector` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Request](request-properties-selector.md "https://ns.adobe.com/helix/pipeline/request#/properties/selector") + +### selector Type + +`string` + +### selector Examples + +```json +"" +``` + +```json +"nav" +``` + +## extension + +The extension of the requested resource + + +`extension` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Request](request-properties-extension.md "https://ns.adobe.com/helix/pipeline/request#/properties/extension") + +### extension Type + +`string` + +### extension Examples + +```json +"html" +``` + +```json +"json" +``` + +## method + +The HTTP method of the request. Note: method names can be lower-case. + + +`method` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Request](request-properties-method.md "https://ns.adobe.com/helix/pipeline/request#/properties/method") + +### method Type + +`string` + +## headers + +The HTTP headers of the request. Note: all header names will be lower-case. + + +`headers` + +- is optional +- Type: unknown +- cannot be null +- defined in: [Request](request-properties-headers.md "https://ns.adobe.com/helix/pipeline/request#/properties/headers") + +### headers Type + +unknown + +## params + +The passed through (and filtered) URL parameters of the request + + +`params` + +- is optional +- Type: `object` ([Details](request-properties-params.md)) +- cannot be null +- defined in: [Request](request-properties-params.md "https://ns.adobe.com/helix/pipeline/request#/properties/params") + +### params Type + +`object` ([Details](request-properties-params.md)) + +## queryString + +The original query string + + +`queryString` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Request](request-properties-querystring.md "https://ns.adobe.com/helix/pipeline/request#/properties/queryString") + +### queryString Type + +`string` + +### queryString Examples + +```json +"?parameter1=foo¶meter2=bar" +``` diff --git a/docs/request.schema.json b/docs/request.schema.json index b6d47e0ca..17a9855c8 100644 --- a/docs/request.schema.json +++ b/docs/request.schema.json @@ -1,106 +1 @@ -{ - "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/pipeline/request", - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "title": "Request", - "meta:status": "stabilizing", - "description": "The HTTP Request", - "additionalProperties": false, - "properties": { - "url": { - "type": "string", - "description": "The path and request parameters of the client request URL", - "examples": [ - "/docs/api/general/index.nav.html?a=1" - ] - }, - "path": { - "type": "string", - "description": "The path of the client request URL", - "examples": [ - "/docs/api/general/index.nav.html" - ] - }, - "pathInfo": { - "type": "string", - "description": "The part of the client path that is relative to the rootPath", - "examples": [ - "/general/index.nav.html" - ] - }, - "rootPath": { - "type": "string", - "description": "The request root path of the current strain.", - "examples": [ - "/docs/api" - ] - }, - "selector": { - "type": "string", - "description": "The selector (sub-type indicator)", - "examples": [ - "", - "nav" - ] - }, - "extension": { - "type": "string", - "description": "The extension of the requested resource", - "examples": [ - "html", - "json" - ] - }, - "method": { - "type": "string", - "description": "The HTTP method of the request. Note: method names can be lower-case.", - "meta:enum": { - "GET": "GET request", - "POST": "POST request", - "PUT": "PUT request (not handled by Helix)", - "DELETE": "DELETE request (not handled by Helix)" - } - }, - "headers": { - "description": "The HTTP headers of the request. Note: all header names will be lower-case.", - "additionalProperties": { - "type": "string" - } - }, - "params": { - "type": "object", - "description": "The passed through (and filtered) URL parameters of the request", - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - } - }, - "queryString": { - "type": "string", - "description": "The original query string", - "examples": [ - "?parameter1=foo¶meter2=bar" - ] - } - } -} \ No newline at end of file +{"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/pipeline/request","$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"Request","meta:status":"stabilizing","description":"The HTTP Request","additionalProperties":false,"properties":{"url":{"type":"string","description":"The path and request parameters of the client request URL","examples":["/docs/api/general/index.nav.html?a=1"]},"path":{"type":"string","description":"The path of the client request URL","examples":["/docs/api/general/index.nav.html"]},"pathInfo":{"type":"string","description":"The part of the client path that is relative to the rootPath","examples":["/general/index.nav.html"]},"rootPath":{"type":"string","description":"The request root path of the current strain.","examples":["/docs/api"]},"selector":{"type":"string","description":"The selector (sub-type indicator)","examples":["","nav"]},"extension":{"type":"string","description":"The extension of the requested resource","examples":["html","json"]},"method":{"type":"string","description":"The HTTP method of the request. Note: method names can be lower-case.","meta:enum":{"GET":"GET request","POST":"POST request","PUT":"PUT request (not handled by Helix)","DELETE":"DELETE request (not handled by Helix)"}},"headers":{"description":"The HTTP headers of the request. Note: all header names will be lower-case.","additionalProperties":{"type":"string"}},"params":{"type":"object","description":"The passed through (and filtered) URL parameters of the request","additionalProperties":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"queryString":{"type":"string","description":"The original query string","examples":["?parameter1=foo¶meter2=bar"]}}} diff --git a/docs/request.schema.md b/docs/request.schema.md deleted file mode 100644 index bca965dc9..000000000 --- a/docs/request.schema.md +++ /dev/null @@ -1,239 +0,0 @@ -# Request Schema - -``` -https://ns.adobe.com/helix/pipeline/request -``` - -The HTTP Request - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Defined In | -| ------------------- | ---------- | ----------- | ------------ | ----------------- | --------------------- | ------------------------------------------ | -| Can be instantiated | No | Stabilizing | No | Forbidden | Forbidden | [request.schema.json](request.schema.json) | - -# Request Properties - -| Property | Type | Required | Nullable | Defined by | -| --------------------------- | -------- | -------- | -------- | --------------------- | -| [extension](#extension) | `string` | Optional | No | Request (this schema) | -| [headers](#headers) | complex | Optional | No | Request (this schema) | -| [method](#method) | `string` | Optional | No | Request (this schema) | -| [params](#params) | `object` | Optional | No | Request (this schema) | -| [path](#path) | `string` | Optional | No | Request (this schema) | -| [pathInfo](#pathinfo) | `string` | Optional | No | Request (this schema) | -| [queryString](#querystring) | `string` | Optional | No | Request (this schema) | -| [rootPath](#rootpath) | `string` | Optional | No | Request (this schema) | -| [selector](#selector) | `string` | Optional | No | Request (this schema) | -| [url](#url) | `string` | Optional | No | Request (this schema) | - -## extension - -The extension of the requested resource - -`extension` - -- is optional -- type: `string` -- defined in this schema - -### extension Type - -`string` - -### extension Examples - -```json -"html" -``` - -```json -"json" -``` - -## headers - -The HTTP headers of the request. Note: all header names will be lower-case. - -`headers` - -- is optional -- type: complex -- defined in this schema - -### headers Type - -Unknown type ``. - -```json -{ - "description": "The HTTP headers of the request. Note: all header names will be lower-case.", - "additionalProperties": { - "type": "string" - }, - "simpletype": "complex" -} -``` - -## method - -The HTTP method of the request. Note: method names can be lower-case. - -`method` - -- is optional -- type: `string` -- defined in this schema - -### method Type - -`string` - -### method Known Values - -| Value | Description | -| -------- | ------------------------------------- | -| `GET` | GET request | -| `POST` | POST request | -| `PUT` | PUT request (not handled by Helix) | -| `DELETE` | DELETE request (not handled by Helix) | - -## params - -The passed through (and filtered) URL parameters of the request - -`params` - -- is optional -- type: `object` -- defined in this schema - -### params Type - -`object` with following properties: - -| Property | Type | Required | -| -------- | ---- | -------- | - - -## path - -The path of the client request URL - -`path` - -- is optional -- type: `string` -- defined in this schema - -### path Type - -`string` - -### path Example - -```json -"/docs/api/general/index.nav.html" -``` - -## pathInfo - -The part of the client path that is relative to the rootPath - -`pathInfo` - -- is optional -- type: `string` -- defined in this schema - -### pathInfo Type - -`string` - -### pathInfo Example - -```json -"/general/index.nav.html" -``` - -## queryString - -The original query string - -`queryString` - -- is optional -- type: `string` -- defined in this schema - -### queryString Type - -`string` - -### queryString Example - -```json -"?parameter1=foo¶meter2=bar" -``` - -## rootPath - -The request root path of the current strain. - -`rootPath` - -- is optional -- type: `string` -- defined in this schema - -### rootPath Type - -`string` - -### rootPath Example - -```json -"/docs/api" -``` - -## selector - -The selector (sub-type indicator) - -`selector` - -- is optional -- type: `string` -- defined in this schema - -### selector Type - -`string` - -### selector Examples - -```json -"" -``` - -```json -"nav" -``` - -## url - -The path and request parameters of the client request URL - -`url` - -- is optional -- type: `string` -- defined in this schema - -### url Type - -`string` - -### url Example - -```json -"/docs/api/general/index.nav.html?a=1" -``` diff --git a/docs/response-properties-body-anyof-0.md b/docs/response-properties-body-anyof-0.md new file mode 100644 index 000000000..7d60069ff --- /dev/null +++ b/docs/response-properties-body-anyof-0.md @@ -0,0 +1,16 @@ +# Untitled undefined type in Response Schema + +```txt +https://ns.adobe.com/helix/pipeline/response#/properties/body/anyOf/0 +``` + +The plain text or base64-encoded body of the response + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [response.schema.json\*](response.schema.json "open original schema") | + +## 0 Type + +unknown diff --git a/docs/response-properties-body-anyof-1.md b/docs/response-properties-body-anyof-1.md new file mode 100644 index 000000000..c554fcd7a --- /dev/null +++ b/docs/response-properties-body-anyof-1.md @@ -0,0 +1,16 @@ +# Untitled object in Response Schema + +```txt +https://ns.adobe.com/helix/pipeline/response#/properties/body/anyOf/1 +``` + +The JSON object to represent the body of the response + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [response.schema.json\*](response.schema.json "open original schema") | + +## 1 Type + +`object` ([Details](response-properties-body-anyof-1.md)) diff --git a/docs/response-properties-body.md b/docs/response-properties-body.md new file mode 100644 index 000000000..10c5fb375 --- /dev/null +++ b/docs/response-properties-body.md @@ -0,0 +1,21 @@ +# Untitled undefined type in Response Schema + +```txt +https://ns.adobe.com/helix/pipeline/response#/properties/body +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [response.schema.json\*](response.schema.json "open original schema") | + +## body Type + +merged type ([Details](response-properties-body.md)) + +any of + +- [Untitled undefined type in Response](response-properties-body-anyof-0.md "check type definition") +- [Untitled object in Response](response-properties-body-anyof-1.md "check type definition") diff --git a/docs/response-properties-document.md b/docs/response-properties-document.md new file mode 100644 index 000000000..6312bf9c3 --- /dev/null +++ b/docs/response-properties-document.md @@ -0,0 +1,16 @@ +# Untitled object in Response Schema + +```txt +https://ns.adobe.com/helix/pipeline/response#/properties/document +``` + +The DOM-compatible representation of the response document + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [response.schema.json\*](response.schema.json "open original schema") | + +## document Type + +`object` ([Details](response-properties-document.md)) diff --git a/docs/response-properties-headers-additionalproperties.md b/docs/response-properties-headers-additionalproperties.md new file mode 100644 index 000000000..12956151f --- /dev/null +++ b/docs/response-properties-headers-additionalproperties.md @@ -0,0 +1,16 @@ +# Untitled string in Response Schema + +```txt +https://ns.adobe.com/helix/pipeline/response#/properties/headers/additionalProperties +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [response.schema.json\*](response.schema.json "open original schema") | + +## additionalProperties Type + +`string` diff --git a/docs/response-properties-headers.md b/docs/response-properties-headers.md new file mode 100644 index 000000000..c912f98b3 --- /dev/null +++ b/docs/response-properties-headers.md @@ -0,0 +1,38 @@ +# Untitled undefined type in Response Schema + +```txt +https://ns.adobe.com/helix/pipeline/response#/properties/headers +``` + +The HTTP headers of the response + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [response.schema.json\*](response.schema.json "open original schema") | + +## headers Type + +unknown + +# undefined Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------------- | -------- | -------- | -------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Additional Properties | `string` | Optional | cannot be null | [Response](response-properties-headers-additionalproperties.md "https://ns.adobe.com/helix/pipeline/response#/properties/headers/additionalProperties") | + +## Additional Properties + +Additional properties are allowed, as long as they follow this schema: + + + + +- is optional +- Type: `string` +- cannot be null +- defined in: [Response](response-properties-headers-additionalproperties.md "https://ns.adobe.com/helix/pipeline/response#/properties/headers/additionalProperties") + +### additionalProperties Type + +`string` diff --git a/docs/response-properties-status.md b/docs/response-properties-status.md new file mode 100644 index 000000000..30e9c26c9 --- /dev/null +++ b/docs/response-properties-status.md @@ -0,0 +1,16 @@ +# Untitled integer in Response Schema + +```txt +https://ns.adobe.com/helix/pipeline/response#/properties/status +``` + +The HTTP status code + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [response.schema.json\*](response.schema.json "open original schema") | + +## status Type + +`integer` diff --git a/docs/response-properties.md b/docs/response-properties.md new file mode 100644 index 000000000..36ccd9126 --- /dev/null +++ b/docs/response-properties.md @@ -0,0 +1,16 @@ +# Untitled undefined type in Response Schema + +```txt +https://ns.adobe.com/helix/pipeline/response#/properties +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [response.schema.json\*](response.schema.json "open original schema") | + +## properties Type + +unknown diff --git a/docs/response.md b/docs/response.md new file mode 100644 index 000000000..f8bce0620 --- /dev/null +++ b/docs/response.md @@ -0,0 +1,94 @@ +# Response Schema + +```txt +https://ns.adobe.com/helix/pipeline/response +``` + +The HTTP response object + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | ----------- | ------------ | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Stabilizing | No | Forbidden | Forbidden | none | [response.schema.json](response.schema.json "open original schema") | + +## Response Type + +`object` ([Response](response.md)) + +# Response Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------------- | ------------- | -------- | -------------- | :------------------------------------------------------------------------------------------------------------------- | +| [status](#status) | `integer` | Optional | cannot be null | [Response](response-properties-status.md "https://ns.adobe.com/helix/pipeline/response#/properties/status") | +| [body](#body) | Merged | Optional | cannot be null | [Response](response-properties-body.md "https://ns.adobe.com/helix/pipeline/response#/properties/body") | +| [document](#document) | `object` | Optional | cannot be null | [Response](response-properties-document.md "https://ns.adobe.com/helix/pipeline/response#/properties/document") | +| [headers](#headers) | Not specified | Optional | cannot be null | [Response](response-properties-headers.md "https://ns.adobe.com/helix/pipeline/response#/properties/headers") | + +## status + +The HTTP status code + + +`status` + +- is optional +- Type: `integer` +- cannot be null +- defined in: [Response](response-properties-status.md "https://ns.adobe.com/helix/pipeline/response#/properties/status") + +### status Type + +`integer` + +## body + + + + +`body` + +- is optional +- Type: merged type ([Details](response-properties-body.md)) +- cannot be null +- defined in: [Response](response-properties-body.md "https://ns.adobe.com/helix/pipeline/response#/properties/body") + +### body Type + +merged type ([Details](response-properties-body.md)) + +any of + +- [Untitled undefined type in Response](response-properties-body-anyof-0.md "check type definition") +- [Untitled object in Response](response-properties-body-anyof-1.md "check type definition") + +## document + +The DOM-compatible representation of the response document + + +`document` + +- is optional +- Type: `object` ([Details](response-properties-document.md)) +- cannot be null +- defined in: [Response](response-properties-document.md "https://ns.adobe.com/helix/pipeline/response#/properties/document") + +### document Type + +`object` ([Details](response-properties-document.md)) + +## headers + +The HTTP headers of the response + + +`headers` + +- is optional +- Type: unknown +- cannot be null +- defined in: [Response](response-properties-headers.md "https://ns.adobe.com/helix/pipeline/response#/properties/headers") + +### headers Type + +unknown diff --git a/docs/response.schema.json b/docs/response.schema.json index 4bff5f7f5..d0fa85ff7 100644 --- a/docs/response.schema.json +++ b/docs/response.schema.json @@ -1,48 +1 @@ -{ - "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/pipeline/response", - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "title": "Response", - "meta:status": "stabilizing", - "description": "The HTTP response object", - "additionalProperties": false, - "properties": { - "status": { - "type": "integer", - "description": "The HTTP status code" - }, - "body": { - "anyOf": [ - { - "description": "The plain text or base64-encoded body of the response", - "type:": "string" - }, - { - "description": "The JSON object to represent the body of the response", - "type": "object" - } - ] - }, - "document": { - "type": "object", - "description": "The DOM-compatible representation of the response document" - }, - "headers": { - "description": "The HTTP headers of the response", - "additionalProperties": { - "type": "string" - } - } - } -} \ No newline at end of file +{"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/pipeline/response","$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"Response","meta:status":"stabilizing","description":"The HTTP response object","additionalProperties":false,"properties":{"status":{"type":"integer","description":"The HTTP status code"},"body":{"anyOf":[{"description":"The plain text or base64-encoded body of the response","type:":"string"},{"description":"The JSON object to represent the body of the response","type":"object"}]},"document":{"type":"object","description":"The DOM-compatible representation of the response document"},"headers":{"description":"The HTTP headers of the response","additionalProperties":{"type":"string"}}}} diff --git a/docs/response.schema.md b/docs/response.schema.md deleted file mode 100644 index ad6425737..000000000 --- a/docs/response.schema.md +++ /dev/null @@ -1,98 +0,0 @@ -# Response Schema - -``` -https://ns.adobe.com/helix/pipeline/response -``` - -The HTTP response object - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Defined In | -| ------------------- | ---------- | ----------- | ------------ | ----------------- | --------------------- | -------------------------------------------- | -| Can be instantiated | No | Stabilizing | No | Forbidden | Forbidden | [response.schema.json](response.schema.json) | - -# Response Properties - -| Property | Type | Required | Nullable | Defined by | -| --------------------- | --------- | -------- | -------- | ---------------------- | -| [body](#body) | complex | Optional | No | Response (this schema) | -| [document](#document) | `object` | Optional | No | Response (this schema) | -| [headers](#headers) | complex | Optional | No | Response (this schema) | -| [status](#status) | `integer` | Optional | No | Response (this schema) | - -## body - -`body` - -- is optional -- type: complex -- defined in this schema - -### body Type - -**Any** following _options_ needs to be fulfilled. - -#### Option 1 - -#### Option 2 - -`object` with following properties: - -| Property | Type | Required | -| -------- | ---- | -------- | - - -## document - -The DOM-compatible representation of the response document - -`document` - -- is optional -- type: `object` -- defined in this schema - -### document Type - -`object` with following properties: - -| Property | Type | Required | -| -------- | ---- | -------- | - - -## headers - -The HTTP headers of the response - -`headers` - -- is optional -- type: complex -- defined in this schema - -### headers Type - -Unknown type ``. - -```json -{ - "description": "The HTTP headers of the response", - "additionalProperties": { - "type": "string" - }, - "simpletype": "complex" -} -``` - -## status - -The HTTP status code - -`status` - -- is optional -- type: `integer` -- defined in this schema - -### status Type - -`integer` diff --git a/docs/secrets-patternproperties-a-z0-9_.md b/docs/secrets-patternproperties-a-z0-9_.md new file mode 100644 index 000000000..e0232d9bf --- /dev/null +++ b/docs/secrets-patternproperties-a-z0-9_.md @@ -0,0 +1,16 @@ +# Untitled undefined type in Secrets Schema + +```txt +https://ns.adobe.com/helix/pipeline/secrets#/patternProperties/[A-Z0-9_]+ +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [secrets.schema.json\*](secrets.schema.json "open original schema") | + +## \[A-Z0-9\_]+ Type + +any of the folllowing: `boolean` or `integer` or `number` or `string` ([Details](secrets-patternproperties-a-z0-9_.md)) diff --git a/docs/secrets-patternproperties.md b/docs/secrets-patternproperties.md new file mode 100644 index 000000000..a4cf8f348 --- /dev/null +++ b/docs/secrets-patternproperties.md @@ -0,0 +1,16 @@ +# Untitled undefined type in Secrets Schema + +```txt +https://ns.adobe.com/helix/pipeline/secrets#/patternProperties +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [secrets.schema.json\*](secrets.schema.json "open original schema") | + +## patternProperties Type + +unknown diff --git a/docs/secrets-properties-embed_selector.md b/docs/secrets-properties-embed_selector.md new file mode 100644 index 000000000..5c703a44e --- /dev/null +++ b/docs/secrets-properties-embed_selector.md @@ -0,0 +1,24 @@ +# Untitled string in Secrets Schema + +```txt +https://ns.adobe.com/helix/pipeline/secrets#/properties/EMBED_SELECTOR +``` + +Selector to be used when resolving internal embeds. + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [secrets.schema.json\*](secrets.schema.json "open original schema") | + +## EMBED_SELECTOR Type + +`string` + +## EMBED_SELECTOR Default Value + +The default value is: + +```json +"embed" +``` diff --git a/docs/secrets-properties-embed_service.md b/docs/secrets-properties-embed_service.md new file mode 100644 index 000000000..8923acd6e --- /dev/null +++ b/docs/secrets-properties-embed_service.md @@ -0,0 +1,24 @@ +# Untitled string in Secrets Schema + +```txt +https://ns.adobe.com/helix/pipeline/secrets#/properties/EMBED_SERVICE +``` + +URL of an Embed Service that takes the appended URL and returns an embeddable HTML representation. + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [secrets.schema.json\*](secrets.schema.json "open original schema") | + +## EMBED_SERVICE Type + +`string` + +## EMBED_SERVICE Default Value + +The default value is: + +```json +"https://adobeioruntime.net/api/v1/web/helix/helix-services/embed@v1" +``` diff --git a/docs/secrets-properties-embed_whitelist.md b/docs/secrets-properties-embed_whitelist.md new file mode 100644 index 000000000..6ebec3758 --- /dev/null +++ b/docs/secrets-properties-embed_whitelist.md @@ -0,0 +1,24 @@ +# Untitled string in Secrets Schema + +```txt +https://ns.adobe.com/helix/pipeline/secrets#/properties/EMBED_WHITELIST +``` + +Comma-separated list of allowed hostnames for embeds. Supports `*.example.com` as a subdomain wildcard. Use `*` to allow all embeds (potentially insecure) + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [secrets.schema.json\*](secrets.schema.json "open original schema") | + +## EMBED_WHITELIST Type + +`string` + +## EMBED_WHITELIST Default Value + +The default value is: + +```json +"www.youtube.com, spark.adobe.com, unsplash.com/photos" +``` diff --git a/docs/secrets-properties-github_token.md b/docs/secrets-properties-github_token.md new file mode 100644 index 000000000..143a3f012 --- /dev/null +++ b/docs/secrets-properties-github_token.md @@ -0,0 +1,16 @@ +# Untitled string in Secrets Schema + +```txt +https://ns.adobe.com/helix/pipeline/secrets#/properties/GITHUB_TOKEN +``` + +GitHub access token to use while fetching markdown. See . + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [secrets.schema.json\*](secrets.schema.json "open original schema") | + +## GITHUB_TOKEN Type + +`string` diff --git a/docs/secrets-properties-http_timeout.md b/docs/secrets-properties-http_timeout.md new file mode 100644 index 000000000..79bb75924 --- /dev/null +++ b/docs/secrets-properties-http_timeout.md @@ -0,0 +1,24 @@ +# Untitled integer in Secrets Schema + +```txt +https://ns.adobe.com/helix/pipeline/secrets#/properties/HTTP_TIMEOUT +``` + +Timeout for outgoing HTTP requests in milliseconds + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [secrets.schema.json\*](secrets.schema.json "open original schema") | + +## HTTP_TIMEOUT Type + +`integer` + +## HTTP_TIMEOUT Default Value + +The default value is: + +```json +1000 +``` diff --git a/docs/secrets-properties-images_min_size.md b/docs/secrets-properties-images_min_size.md new file mode 100644 index 000000000..9188a7a94 --- /dev/null +++ b/docs/secrets-properties-images_min_size.md @@ -0,0 +1,24 @@ +# Untitled integer in Secrets Schema + +```txt +https://ns.adobe.com/helix/pipeline/secrets#/properties/IMAGES_MIN_SIZE +``` + +Minimum physical width of responsive images to generate + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [secrets.schema.json\*](secrets.schema.json "open original schema") | + +## IMAGES_MIN_SIZE Type + +`integer` + +## IMAGES_MIN_SIZE Default Value + +The default value is: + +```json +480 +``` diff --git a/docs/secrets-properties-repo_api_root.md b/docs/secrets-properties-repo_api_root.md new file mode 100644 index 000000000..5a64fb80a --- /dev/null +++ b/docs/secrets-properties-repo_api_root.md @@ -0,0 +1,28 @@ +# Untitled string in Secrets Schema + +```txt +https://ns.adobe.com/helix/pipeline/secrets#/properties/REPO_API_ROOT +``` + +The base URL for all GitHub API operations + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [secrets.schema.json\*](secrets.schema.json "open original schema") | + +## REPO_API_ROOT Type + +`string` + +## REPO_API_ROOT Constraints + +**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc4291 "check the specification") + +## REPO_API_ROOT Default Value + +The default value is: + +```json +"https://api.github.com/" +``` diff --git a/docs/secrets-properties-repo_raw_root.md b/docs/secrets-properties-repo_raw_root.md new file mode 100644 index 000000000..110b3bd3e --- /dev/null +++ b/docs/secrets-properties-repo_raw_root.md @@ -0,0 +1,28 @@ +# Untitled string in Secrets Schema + +```txt +https://ns.adobe.com/helix/pipeline/secrets#/properties/REPO_RAW_ROOT +``` + +The Base URL for retrieving raw text files from GitHub + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [secrets.schema.json\*](secrets.schema.json "open original schema") | + +## REPO_RAW_ROOT Type + +`string` + +## REPO_RAW_ROOT Constraints + +**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc4291 "check the specification") + +## REPO_RAW_ROOT Default Value + +The default value is: + +```json +"https://raw.githubusercontent.com/" +``` diff --git a/docs/secrets-properties-resolve_gitref_service.md b/docs/secrets-properties-resolve_gitref_service.md new file mode 100644 index 000000000..e320d902c --- /dev/null +++ b/docs/secrets-properties-resolve_gitref_service.md @@ -0,0 +1,16 @@ +# Untitled string in Secrets Schema + +```txt +https://ns.adobe.com/helix/pipeline/secrets#/properties/RESOLVE_GITREF_SERVICE +``` + +API endpoint or action name to the service that resolves github refs to commit SHAs. + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [secrets.schema.json\*](secrets.schema.json "open original schema") | + +## RESOLVE_GITREF_SERVICE Type + +`string` diff --git a/docs/secrets-properties-sanitize_dom.md b/docs/secrets-properties-sanitize_dom.md new file mode 100644 index 000000000..66c2da44f --- /dev/null +++ b/docs/secrets-properties-sanitize_dom.md @@ -0,0 +1,18 @@ +# Untitled boolean in Secrets Schema + +```txt +https://ns.adobe.com/helix/pipeline/secrets#/properties/SANITIZE_DOM +``` + +Sanitize the HTML output to guard against XSS attacks. + +**Note:** this flag applies a pretty aggressive DOM filtering that will strip out a lot of HTML that your authors might find useful. The setting is meant for processing truly untrusted inputs, such as comments in a social media site. + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [secrets.schema.json\*](secrets.schema.json "open original schema") | + +## SANITIZE_DOM Type + +`boolean` diff --git a/docs/secrets-properties-test_boolean.md b/docs/secrets-properties-test_boolean.md new file mode 100644 index 000000000..fd28d3c0c --- /dev/null +++ b/docs/secrets-properties-test_boolean.md @@ -0,0 +1,24 @@ +# Untitled boolean in Secrets Schema + +```txt +https://ns.adobe.com/helix/pipeline/secrets#/properties/TEST_BOOLEAN +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [secrets.schema.json\*](secrets.schema.json "open original schema") | + +## TEST_BOOLEAN Type + +`boolean` + +## TEST_BOOLEAN Default Value + +The default value is: + +```json +true +``` diff --git a/docs/secrets-properties-xml_pretty.md b/docs/secrets-properties-xml_pretty.md new file mode 100644 index 000000000..1b6f250a3 --- /dev/null +++ b/docs/secrets-properties-xml_pretty.md @@ -0,0 +1,24 @@ +# Untitled boolean in Secrets Schema + +```txt +https://ns.adobe.com/helix/pipeline/secrets#/properties/XML_PRETTY +``` + +Print XML with line breaks and indentation + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [secrets.schema.json\*](secrets.schema.json "open original schema") | + +## XML_PRETTY Type + +`boolean` + +## XML_PRETTY Default Value + +The default value is: + +```json +true +``` diff --git a/docs/secrets-properties.md b/docs/secrets-properties.md new file mode 100644 index 000000000..f831ae0c9 --- /dev/null +++ b/docs/secrets-properties.md @@ -0,0 +1,16 @@ +# Untitled undefined type in Secrets Schema + +```txt +https://ns.adobe.com/helix/pipeline/secrets#/properties +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [secrets.schema.json\*](secrets.schema.json "open original schema") | + +## properties Type + +unknown diff --git a/docs/secrets.md b/docs/secrets.md new file mode 100644 index 000000000..ced3abdc4 --- /dev/null +++ b/docs/secrets.md @@ -0,0 +1,324 @@ +# Secrets Schema + +```txt +https://ns.adobe.com/helix/pipeline/secrets +``` + +Secrets passed into the pipeline such as API Keys or configuration settings. + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | ------ | ------------ | :---------------- | --------------------- | ------------------- | ----------------------------------------------------------------- | +| Can be instantiated | No | Stable | No | Forbidden | Forbidden | none | [secrets.schema.json](secrets.schema.json "open original schema") | + +## Secrets Type + +`object` ([Secrets](secrets.md)) + +# Secrets Properties + +| Property | Type | Required | Nullable | Defined by | +| :------------------------------------------------ | --------- | -------- | -------------- | :-------------------------------------------------------------------------------------------------------------------------------------------- | +| [REPO_RAW_ROOT](#REPO_RAW_ROOT) | `string` | Optional | cannot be null | [Secrets](secrets-properties-repo_raw_root.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/REPO_RAW_ROOT") | +| [REPO_API_ROOT](#REPO_API_ROOT) | `string` | Optional | cannot be null | [Secrets](secrets-properties-repo_api_root.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/REPO_API_ROOT") | +| [EMBED_WHITELIST](#EMBED_WHITELIST) | `string` | Optional | cannot be null | [Secrets](secrets-properties-embed_whitelist.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/EMBED_WHITELIST") | +| [EMBED_SERVICE](#EMBED_SERVICE) | `string` | Optional | cannot be null | [Secrets](secrets-properties-embed_service.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/EMBED_SERVICE") | +| [EMBED_SELECTOR](#EMBED_SELECTOR) | `string` | Optional | cannot be null | [Secrets](secrets-properties-embed_selector.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/EMBED_SELECTOR") | +| [IMAGES_MIN_SIZE](#IMAGES_MIN_SIZE) | `integer` | Optional | cannot be null | [Secrets](secrets-properties-images_min_size.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/IMAGES_MIN_SIZE") | +| [HTTP_TIMEOUT](#HTTP_TIMEOUT) | `integer` | Optional | cannot be null | [Secrets](secrets-properties-http_timeout.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/HTTP_TIMEOUT") | +| [TEST_BOOLEAN](#TEST_BOOLEAN) | `boolean` | Optional | cannot be null | [Secrets](secrets-properties-test_boolean.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/TEST_BOOLEAN") | +| [XML_PRETTY](#XML_PRETTY) | `boolean` | Optional | cannot be null | [Secrets](secrets-properties-xml_pretty.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/XML_PRETTY") | +| [SANITIZE_DOM](#SANITIZE_DOM) | `boolean` | Optional | cannot be null | [Secrets](secrets-properties-sanitize_dom.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/SANITIZE_DOM") | +| [RESOLVE_GITREF_SERVICE](#RESOLVE_GITREF_SERVICE) | `string` | Optional | cannot be null | [Secrets](secrets-properties-resolve_gitref_service.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/RESOLVE_GITREF_SERVICE") | +| [GITHUB_TOKEN](#GITHUB_TOKEN) | `string` | Optional | cannot be null | [Secrets](secrets-properties-github_token.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/GITHUB_TOKEN") | +| `[A-Z0-9_]+` | Multiple | Optional | cannot be null | [Secrets](secrets-patternproperties-a-z0-9_.md "https://ns.adobe.com/helix/pipeline/secrets#/patternProperties/\[A-Z0-9\_]+") | + +## REPO_RAW_ROOT + +The Base URL for retrieving raw text files from GitHub + + +`REPO_RAW_ROOT` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Secrets](secrets-properties-repo_raw_root.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/REPO_RAW_ROOT") + +### REPO_RAW_ROOT Type + +`string` + +### REPO_RAW_ROOT Constraints + +**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc4291 "check the specification") + +### REPO_RAW_ROOT Default Value + +The default value is: + +```json +"https://raw.githubusercontent.com/" +``` + +## REPO_API_ROOT + +The base URL for all GitHub API operations + + +`REPO_API_ROOT` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Secrets](secrets-properties-repo_api_root.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/REPO_API_ROOT") + +### REPO_API_ROOT Type + +`string` + +### REPO_API_ROOT Constraints + +**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc4291 "check the specification") + +### REPO_API_ROOT Default Value + +The default value is: + +```json +"https://api.github.com/" +``` + +## EMBED_WHITELIST + +Comma-separated list of allowed hostnames for embeds. Supports `*.example.com` as a subdomain wildcard. Use `*` to allow all embeds (potentially insecure) + + +`EMBED_WHITELIST` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Secrets](secrets-properties-embed_whitelist.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/EMBED_WHITELIST") + +### EMBED_WHITELIST Type + +`string` + +### EMBED_WHITELIST Default Value + +The default value is: + +```json +"www.youtube.com, spark.adobe.com, unsplash.com/photos" +``` + +## EMBED_SERVICE + +URL of an Embed Service that takes the appended URL and returns an embeddable HTML representation. + + +`EMBED_SERVICE` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Secrets](secrets-properties-embed_service.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/EMBED_SERVICE") + +### EMBED_SERVICE Type + +`string` + +### EMBED_SERVICE Default Value + +The default value is: + +```json +"https://adobeioruntime.net/api/v1/web/helix/helix-services/embed@v1" +``` + +## EMBED_SELECTOR + +Selector to be used when resolving internal embeds. + + +`EMBED_SELECTOR` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Secrets](secrets-properties-embed_selector.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/EMBED_SELECTOR") + +### EMBED_SELECTOR Type + +`string` + +### EMBED_SELECTOR Default Value + +The default value is: + +```json +"embed" +``` + +## IMAGES_MIN_SIZE + +Minimum physical width of responsive images to generate + + +`IMAGES_MIN_SIZE` + +- is optional +- Type: `integer` +- cannot be null +- defined in: [Secrets](secrets-properties-images_min_size.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/IMAGES_MIN_SIZE") + +### IMAGES_MIN_SIZE Type + +`integer` + +### IMAGES_MIN_SIZE Default Value + +The default value is: + +```json +480 +``` + +## HTTP_TIMEOUT + +Timeout for outgoing HTTP requests in milliseconds + + +`HTTP_TIMEOUT` + +- is optional +- Type: `integer` +- cannot be null +- defined in: [Secrets](secrets-properties-http_timeout.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/HTTP_TIMEOUT") + +### HTTP_TIMEOUT Type + +`integer` + +### HTTP_TIMEOUT Default Value + +The default value is: + +```json +1000 +``` + +## TEST_BOOLEAN + + + + +`TEST_BOOLEAN` + +- is optional +- Type: `boolean` +- cannot be null +- defined in: [Secrets](secrets-properties-test_boolean.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/TEST_BOOLEAN") + +### TEST_BOOLEAN Type + +`boolean` + +### TEST_BOOLEAN Default Value + +The default value is: + +```json +true +``` + +## XML_PRETTY + +Print XML with line breaks and indentation + + +`XML_PRETTY` + +- is optional +- Type: `boolean` +- cannot be null +- defined in: [Secrets](secrets-properties-xml_pretty.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/XML_PRETTY") + +### XML_PRETTY Type + +`boolean` + +### XML_PRETTY Default Value + +The default value is: + +```json +true +``` + +## SANITIZE_DOM + +Sanitize the HTML output to guard against XSS attacks. + +**Note:** this flag applies a pretty aggressive DOM filtering that will strip out a lot of HTML that your authors might find useful. The setting is meant for processing truly untrusted inputs, such as comments in a social media site. + + +`SANITIZE_DOM` + +- is optional +- Type: `boolean` +- cannot be null +- defined in: [Secrets](secrets-properties-sanitize_dom.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/SANITIZE_DOM") + +### SANITIZE_DOM Type + +`boolean` + +## RESOLVE_GITREF_SERVICE + +API endpoint or action name to the service that resolves github refs to commit SHAs. + + +`RESOLVE_GITREF_SERVICE` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Secrets](secrets-properties-resolve_gitref_service.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/RESOLVE_GITREF_SERVICE") + +### RESOLVE_GITREF_SERVICE Type + +`string` + +## GITHUB_TOKEN + +GitHub access token to use while fetching markdown. See . + + +`GITHUB_TOKEN` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Secrets](secrets-properties-github_token.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/GITHUB_TOKEN") + +### GITHUB_TOKEN Type + +`string` + +## Pattern: `[A-Z0-9_]+` + + + + +`[A-Z0-9_]+` + +- is optional +- Type: any of the folllowing: `boolean` or `integer` or `number` or `string` ([Details](secrets-patternproperties-a-z0-9_.md)) +- cannot be null +- defined in: [Secrets](secrets-patternproperties-a-z0-9_.md "https://ns.adobe.com/helix/pipeline/secrets#/patternProperties/\[A-Z0-9\_]+") + +### \[A-Z0-9\_]+ Type + +any of the folllowing: `boolean` or `integer` or `number` or `string` ([Details](secrets-patternproperties-a-z0-9_.md)) diff --git a/docs/secrets.schema.json b/docs/secrets.schema.json index 1719ba732..ccb0ea684 100644 --- a/docs/secrets.schema.json +++ b/docs/secrets.schema.json @@ -1,93 +1 @@ -{ - "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/pipeline/secrets", - "$schema": "http://json-schema.org/draft-07/schema#", - "title": "Secrets", - "type": "object", - "meta:status": "stable", - "additionalProperties": false, - "description": "Secrets passed into the pipeline such as API Keys or configuration settings.", - "patternProperties": { - "[A-Z0-9_]+": { - "type": [ - "boolean", - "integer", - "number", - "string" - ] - } - }, - "properties": { - "REPO_RAW_ROOT": { - "type": "string", - "format": "uri", - "description": "The Base URL for retrieving raw text files from GitHub", - "default": "https://raw.githubusercontent.com/" - }, - "REPO_API_ROOT": { - "type": "string", - "format": "uri", - "description": "The base URL for all GitHub API operations", - "default": "https://api.github.com/" - }, - "EMBED_WHITELIST": { - "type": "string", - "description": "Comma-separated list of allowed hostnames for embeds. Supports `*.example.com` as a subdomain wildcard. Use `*` to allow all embeds (potentially insecure)", - "default": "www.youtube.com, spark.adobe.com, unsplash.com/photos" - }, - "EMBED_SERVICE": { - "type": "string", - "description": "URL of an Embed Service that takes the appended URL and returns an embeddable HTML representation.", - "default": "https://adobeioruntime.net/api/v1/web/helix/helix-services/embed@v1" - }, - "EMBED_SELECTOR": { - "type": "string", - "description": "Selector to be used when resolving internal embeds.", - "default": "embed" - }, - "IMAGES_MIN_SIZE": { - "type": "integer", - "description": "Minimum physical width of responsive images to generate", - "default": 480 - }, - "HTTP_TIMEOUT": { - "type": "integer", - "description": "Timeout for outgoing HTTP requests in milliseconds", - "default": 1000 - }, - "TEST_BOOLEAN": { - "type": "boolean", - "default": true - }, - "XML_PRETTY": { - "type": "boolean", - "description": "Print XML with line breaks and indentation", - "default": true - }, - "SANITIZE_DOM": { - "type": "boolean", - "description": "Sanitize the HTML output to guard against XSS attacks. \n\n**Note:** this flag applies a pretty aggressive DOM filtering that will strip out a lot of HTML that your authors might find useful. The setting is meant for processing truly untrusted inputs, such as comments in a social media site.", - "default": false - }, - "RESOLVE_GITREF_SERVICE": { - "type": "string", - "description": "API endpoint or action name to the service that resolves github refs to commit SHAs.", - "default": "" - }, - "GITHUB_TOKEN": { - "type": "string", - "description": "GitHub access token to use while fetching markdown. See https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line.", - "default": "" - } - } -} \ No newline at end of file +{"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/pipeline/secrets","$schema":"http://json-schema.org/draft-07/schema#","title":"Secrets","type":"object","meta:status":"stable","additionalProperties":false,"description":"Secrets passed into the pipeline such as API Keys or configuration settings.","patternProperties":{"[A-Z0-9_]+":{"type":["boolean","integer","number","string"]}},"properties":{"REPO_RAW_ROOT":{"type":"string","format":"uri","description":"The Base URL for retrieving raw text files from GitHub","default":"https://raw.githubusercontent.com/"},"REPO_API_ROOT":{"type":"string","format":"uri","description":"The base URL for all GitHub API operations","default":"https://api.github.com/"},"EMBED_WHITELIST":{"type":"string","description":"Comma-separated list of allowed hostnames for embeds. Supports `*.example.com` as a subdomain wildcard. Use `*` to allow all embeds (potentially insecure)","default":"www.youtube.com, spark.adobe.com, unsplash.com/photos"},"EMBED_SERVICE":{"type":"string","description":"URL of an Embed Service that takes the appended URL and returns an embeddable HTML representation.","default":"https://adobeioruntime.net/api/v1/web/helix/helix-services/embed@v1"},"EMBED_SELECTOR":{"type":"string","description":"Selector to be used when resolving internal embeds.","default":"embed"},"IMAGES_MIN_SIZE":{"type":"integer","description":"Minimum physical width of responsive images to generate","default":480},"HTTP_TIMEOUT":{"type":"integer","description":"Timeout for outgoing HTTP requests in milliseconds","default":1000},"TEST_BOOLEAN":{"type":"boolean","default":true},"XML_PRETTY":{"type":"boolean","description":"Print XML with line breaks and indentation","default":true},"SANITIZE_DOM":{"type":"boolean","description":"Sanitize the HTML output to guard against XSS attacks. \n\n**Note:** this flag applies a pretty aggressive DOM filtering that will strip out a lot of HTML that your authors might find useful. The setting is meant for processing truly untrusted inputs, such as comments in a social media site.","default":false},"RESOLVE_GITREF_SERVICE":{"type":"string","description":"API endpoint or action name to the service that resolves github refs to commit SHAs.","default":""},"GITHUB_TOKEN":{"type":"string","description":"GitHub access token to use while fetching markdown. See https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line.","default":""}}} diff --git a/docs/secrets.schema.md b/docs/secrets.schema.md deleted file mode 100644 index d915e7380..000000000 --- a/docs/secrets.schema.md +++ /dev/null @@ -1,237 +0,0 @@ -# Secrets Schema - -``` -https://ns.adobe.com/helix/pipeline/secrets -``` - -Secrets passed into the pipeline such as API Keys or configuration settings. - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Defined In | -| ------------------- | ---------- | ------ | ------------ | ----------------- | --------------------- | ------------------------------------------ | -| Can be instantiated | No | Stable | No | Forbidden | Forbidden | [secrets.schema.json](secrets.schema.json) | - -# Secrets Properties - -| Property | Type | Required | Nullable | Default | Defined by | -| ------------------------------------------------- | --------- | -------- | -------- | ----------------------------------------------------------------------- | --------------------- | -| [EMBED_SELECTOR](#embed_selector) | `string` | Optional | No | `"embed"` | Secrets (this schema) | -| [EMBED_SERVICE](#embed_service) | `string` | Optional | No | `"https://adobeioruntime.net/api/v1/web/helix/helix-services/embed@v1"` | Secrets (this schema) | -| [EMBED_WHITELIST](#embed_whitelist) | `string` | Optional | No | `"www.youtube.com, spark.adobe.com, unsplash.com/photos"` | Secrets (this schema) | -| [GITHUB_TOKEN](#github_token) | `string` | Optional | No | `""` | Secrets (this schema) | -| [HTTP_TIMEOUT](#http_timeout) | `integer` | Optional | No | `1000` | Secrets (this schema) | -| [IMAGES_MIN_SIZE](#images_min_size) | `integer` | Optional | No | `480` | Secrets (this schema) | -| [REPO_API_ROOT](#repo_api_root) | `string` | Optional | No | `"https://api.github.com/"` | Secrets (this schema) | -| [REPO_RAW_ROOT](#repo_raw_root) | `string` | Optional | No | `"https://raw.githubusercontent.com/"` | Secrets (this schema) | -| [RESOLVE_GITREF_SERVICE](#resolve_gitref_service) | `string` | Optional | No | `""` | Secrets (this schema) | -| [SANITIZE_DOM](#sanitize_dom) | `boolean` | Optional | No | `false` | Secrets (this schema) | -| [TEST_BOOLEAN](#test_boolean) | `boolean` | Optional | No | `true` | Secrets (this schema) | -| [XML_PRETTY](#xml_pretty) | `boolean` | Optional | No | `true` | Secrets (this schema) | -| `[A-Z0-9_]+` | multiple | Pattern | No | | Secrets (this schema) | - -## EMBED_SELECTOR - -Selector to be used when resolving internal embeds. - -`EMBED_SELECTOR` - -- is optional -- type: `string` -- default: `"embed"` -- defined in this schema - -### EMBED_SELECTOR Type - -`string` - -## EMBED_SERVICE - -URL of an Embed Service that takes the appended URL and returns an embeddable HTML representation. - -`EMBED_SERVICE` - -- is optional -- type: `string` -- default: `"https://adobeioruntime.net/api/v1/web/helix/helix-services/embed@v1"` -- defined in this schema - -### EMBED_SERVICE Type - -`string` - -## EMBED_WHITELIST - -Comma-separated list of allowed hostnames for embeds. Supports `*.example.com` as a subdomain wildcard. Use `*` to -allow all embeds (potentially insecure) - -`EMBED_WHITELIST` - -- is optional -- type: `string` -- default: `"www.youtube.com, spark.adobe.com, unsplash.com/photos"` -- defined in this schema - -### EMBED_WHITELIST Type - -`string` - -## GITHUB_TOKEN - -GitHub access token to use while fetching markdown. See -https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line. - -`GITHUB_TOKEN` - -- is optional -- type: `string` -- default: `""` -- defined in this schema - -### GITHUB_TOKEN Type - -`string` - -## HTTP_TIMEOUT - -Timeout for outgoing HTTP requests in milliseconds - -`HTTP_TIMEOUT` - -- is optional -- type: `integer` -- default: `1000` -- defined in this schema - -### HTTP_TIMEOUT Type - -`integer` - -## IMAGES_MIN_SIZE - -Minimum physical width of responsive images to generate - -`IMAGES_MIN_SIZE` - -- is optional -- type: `integer` -- default: `480` -- defined in this schema - -### IMAGES_MIN_SIZE Type - -`integer` - -## REPO_API_ROOT - -The base URL for all GitHub API operations - -`REPO_API_ROOT` - -- is optional -- type: `string` -- default: `"https://api.github.com/"` -- defined in this schema - -### REPO_API_ROOT Type - -`string` - -- format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) - -## REPO_RAW_ROOT - -The Base URL for retrieving raw text files from GitHub - -`REPO_RAW_ROOT` - -- is optional -- type: `string` -- default: `"https://raw.githubusercontent.com/"` -- defined in this schema - -### REPO_RAW_ROOT Type - -`string` - -- format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) - -## RESOLVE_GITREF_SERVICE - -API endpoint or action name to the service that resolves github refs to commit SHAs. - -`RESOLVE_GITREF_SERVICE` - -- is optional -- type: `string` -- default: `""` -- defined in this schema - -### RESOLVE_GITREF_SERVICE Type - -`string` - -## SANITIZE_DOM - -Sanitize the HTML output to guard against XSS attacks. - -**Note:** this flag applies a pretty aggressive DOM filtering that will strip out a lot of HTML that your authors might -find useful. The setting is meant for processing truly untrusted inputs, such as comments in a social media site. - -`SANITIZE_DOM` - -- is optional -- type: `boolean` -- default: `false` -- defined in this schema - -### SANITIZE_DOM Type - -`boolean` - -## TEST_BOOLEAN - -`TEST_BOOLEAN` - -- is optional -- type: `boolean` -- default: `true` -- defined in this schema - -### TEST_BOOLEAN Type - -`boolean` - -## XML_PRETTY - -Print XML with line breaks and indentation - -`XML_PRETTY` - -- is optional -- type: `boolean` -- default: `true` -- defined in this schema - -### XML_PRETTY Type - -`boolean` - -## Pattern: `[A-Z0-9_]+` - -Applies to all properties that match the regular expression `[A-Z0-9_]+` - -`[A-Z0-9_]+` - -- is a property pattern -- type: multiple -- defined in this schema - -### Pattern [A-Z0-9_]+ Type - -Unknown type `boolean,integer,number,string`. - -```json -{ - "type": ["boolean", "integer", "number", "string"], - "simpletype": "multiple" -} -``` diff --git a/docs/section-definitions-section-properties-children.md b/docs/section-definitions-section-properties-children.md new file mode 100644 index 000000000..33e456b31 --- /dev/null +++ b/docs/section-definitions-section-properties-children.md @@ -0,0 +1,16 @@ +# Untitled array in Section Schema + +```txt +https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/children +``` + +The AST nodes making up the section. Section dividers are not included. + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [section.schema.json\*](section.schema.json "open original schema") | + +## children Type + +`object[]` ([MDAST](content-properties-mdast.md)) diff --git a/docs/section-definitions-section-properties-image.md b/docs/section-definitions-section-properties-image.md new file mode 100644 index 000000000..d83c4fe86 --- /dev/null +++ b/docs/section-definitions-section-properties-image.md @@ -0,0 +1,20 @@ +# Untitled string in Section Schema + +```txt +https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/image +``` + +Path (can be relative) to the first image in the document + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [section.schema.json\*](section.schema.json "open original schema") | + +## image Type + +`string` + +## image Constraints + +**URI reference**: the string must be a URI reference, according to [RFC 3986](https://tools.ietf.org/html/rfc4291 "check the specification") diff --git a/docs/section-definitions-section-properties-intro.md b/docs/section-definitions-section-properties-intro.md new file mode 100644 index 000000000..1c88cdccd --- /dev/null +++ b/docs/section-definitions-section-properties-intro.md @@ -0,0 +1,16 @@ +# Untitled string in Section Schema + +```txt +https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/intro +``` + +Extracted first paragraph of the document + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [section.schema.json\*](section.schema.json "open original schema") | + +## intro Type + +`string` diff --git a/docs/section-definitions-section-properties-position.md b/docs/section-definitions-section-properties-position.md new file mode 100644 index 000000000..3b9d671b6 --- /dev/null +++ b/docs/section-definitions-section-properties-position.md @@ -0,0 +1,72 @@ +# Position Schema + +```txt +https://ns.adobe.com/helix/pipeline/position#/definitions/section/properties/position +``` + +Marks the position of an AST node in the original text flow + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | ------ | ------------ | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Stable | No | Forbidden | Forbidden | none | [section.schema.json\*](section.schema.json "open original schema") | + +## position Type + +`object` ([Position](section-definitions-section-properties-position.md)) + +# Position Properties + +| Property | Type | Required | Nullable | Defined by | +| :---------------- | -------- | -------- | -------------- | :------------------------------------------------------------------------------------------------------------------------------- | +| [start](#start) | `object` | Optional | cannot be null | [Position](position-properties-text-coordinates.md "https://ns.adobe.com/helix/pipeline/textcoordinates#/properties/start") | +| [end](#end) | `object` | Optional | cannot be null | [Position](position-properties-text-coordinates.md "https://ns.adobe.com/helix/pipeline/textcoordinates#/properties/end") | +| [indent](#indent) | `array` | Optional | cannot be null | [Position](position-properties-indent.md "https://ns.adobe.com/helix/pipeline/position#/properties/indent") | + +## start + +A position in a text document + + +`start` + +- is optional +- Type: `object` ([Text Coordinates](position-properties-text-coordinates.md)) +- cannot be null +- defined in: [Position](position-properties-text-coordinates.md "https://ns.adobe.com/helix/pipeline/textcoordinates#/properties/start") + +### start Type + +`object` ([Text Coordinates](position-properties-text-coordinates.md)) + +## end + +A position in a text document + + +`end` + +- is optional +- Type: `object` ([Text Coordinates](position-properties-text-coordinates.md)) +- cannot be null +- defined in: [Position](position-properties-text-coordinates.md "https://ns.adobe.com/helix/pipeline/textcoordinates#/properties/end") + +### end Type + +`object` ([Text Coordinates](position-properties-text-coordinates.md)) + +## indent + + + + +`indent` + +- is optional +- Type: `array` +- cannot be null +- defined in: [Position](position-properties-indent.md "https://ns.adobe.com/helix/pipeline/position#/properties/indent") + +### indent Type + +`array` diff --git a/docs/section-definitions-section-properties-title.md b/docs/section-definitions-section-properties-title.md new file mode 100644 index 000000000..e08973a1b --- /dev/null +++ b/docs/section-definitions-section-properties-title.md @@ -0,0 +1,16 @@ +# Untitled string in Section Schema + +```txt +https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/title +``` + +Extracted title of the document + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [section.schema.json\*](section.schema.json "open original schema") | + +## title Type + +`string` diff --git a/docs/section-definitions-section-properties-type.md b/docs/section-definitions-section-properties-type.md new file mode 100644 index 000000000..4526892b3 --- /dev/null +++ b/docs/section-definitions-section-properties-type.md @@ -0,0 +1,24 @@ +# Untitled undefined type in Section Schema + +```txt +https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/type +``` + +The MDAST node type. Each section can be treated as a standalone document. + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [section.schema.json\*](section.schema.json "open original schema") | + +## type Type + +unknown + +## type Constraints + +**constant**: the value of this property must be equal to: + +```json +"root" +``` diff --git a/docs/section-definitions-section-properties.md b/docs/section-definitions-section-properties.md new file mode 100644 index 000000000..6cda014d0 --- /dev/null +++ b/docs/section-definitions-section-properties.md @@ -0,0 +1,16 @@ +# \[object Object] Schema + +```txt +https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [section.schema.json\*](section.schema.json "open original schema") | + +## properties Type + +unknown diff --git a/docs/section-definitions-section.md b/docs/section-definitions-section.md new file mode 100644 index 000000000..fa1d75fd0 --- /dev/null +++ b/docs/section-definitions-section.md @@ -0,0 +1,152 @@ +# Untitled undefined type in Section Schema + +```txt +https://ns.adobe.com/helix/pipeline/section#/definitions/section +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ------------ | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [section.schema.json\*](section.schema.json "open original schema") | + +## section Type + +unknown + +# undefined Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------------- | ------------- | -------- | -------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [type](#type) | Not specified | Optional | cannot be null | [Section](section-definitions-section-properties-type.md "https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/type") | +| [position](#position) | `object` | Optional | cannot be null | [Section](section-definitions-section-properties-position.md "https://ns.adobe.com/helix/pipeline/position#/definitions/section/properties/position") | +| [children](#children) | `array` | Optional | cannot be null | [Section](section-definitions-section-properties-children.md "https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/children") | +| [meta](#meta) | `object` | Optional | can be null | [Section](meta-definitions-meta.md "https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/meta") | +| [title](#title) | `string` | Optional | cannot be null | [Section](meta-definitions-meta-properties-title.md "https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/title") | +| [intro](#intro) | `string` | Optional | cannot be null | [Section](meta-definitions-meta-properties-intro.md "https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/intro") | +| [image](#image) | `string` | Optional | cannot be null | [Section](meta-definitions-meta-properties-image.md "https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/image") | + +## type + +The MDAST node type. Each section can be treated as a standalone document. + + +`type` + +- is optional +- Type: unknown +- cannot be null +- defined in: [Section](section-definitions-section-properties-type.md "https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/type") + +### type Type + +unknown + +### type Constraints + +**constant**: the value of this property must be equal to: + +```json +"root" +``` + +## position + +Marks the position of an AST node in the original text flow + + +`position` + +- is optional +- Type: `object` ([Position](section-definitions-section-properties-position.md)) +- cannot be null +- defined in: [Section](section-definitions-section-properties-position.md "https://ns.adobe.com/helix/pipeline/position#/definitions/section/properties/position") + +### position Type + +`object` ([Position](section-definitions-section-properties-position.md)) + +## children + +The AST nodes making up the section. Section dividers are not included. + + +`children` + +- is optional +- Type: `object[]` ([MDAST](content-properties-mdast.md)) +- cannot be null +- defined in: [Section](section-definitions-section-properties-children.md "https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/children") + +### children Type + +`object[]` ([MDAST](content-properties-mdast.md)) + +## meta + + + + +`meta` + +- is optional +- Type: `object` ([Details](meta-definitions-meta.md)) +- can be null +- defined in: [Section](meta-definitions-meta.md "https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/meta") + +### meta Type + +`object` ([Details](meta-definitions-meta.md)) + +## title + +Extracted title of the document + + +`title` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Section](meta-definitions-meta-properties-title.md "https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/title") + +### title Type + +`string` + +## intro + +Extracted first paragraph of the document + + +`intro` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Section](meta-definitions-meta-properties-intro.md "https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/intro") + +### intro Type + +`string` + +## image + +Path (can be relative) to the first image in the document + + +`image` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Section](meta-definitions-meta-properties-image.md "https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/image") + +### image Type + +`string` + +### image Constraints + +**URI reference**: the string must be a URI reference, according to [RFC 3986](https://tools.ietf.org/html/rfc4291 "check the specification") diff --git a/docs/section-definitions.md b/docs/section-definitions.md new file mode 100644 index 000000000..ee44e9352 --- /dev/null +++ b/docs/section-definitions.md @@ -0,0 +1,16 @@ +# Untitled undefined type in Section Schema + +```txt +https://ns.adobe.com/helix/pipeline/section#/definitions +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [section.schema.json\*](section.schema.json "open original schema") | + +## definitions Type + +unknown diff --git a/docs/section.md b/docs/section.md new file mode 100644 index 000000000..a2a0b8a04 --- /dev/null +++ b/docs/section.md @@ -0,0 +1,160 @@ +# Section Schema + +```txt +https://ns.adobe.com/helix/pipeline/section +``` + +A section in a markdown document + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :--------------------- | ---------- | ------------ | ----------------------- | :---------------- | --------------------- | ------------------- | ----------------------------------------------------------------- | +| Cannot be instantiated | Yes | Experimental | Unknown identifiability | Forbidden | Allowed | none | [section.schema.json](section.schema.json "open original schema") | + +## Section Type + +unknown ([Section](section.md)) + +# Section Definitions + +## Definitions group section + +Reference this group by using + +```json +{"$ref":"https://ns.adobe.com/helix/pipeline/section#/definitions/section"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :-------------------- | ------------- | -------- | -------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [type](#type) | Not specified | Optional | cannot be null | [Section](section-definitions-section-properties-type.md "https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/type") | +| [position](#position) | `object` | Optional | cannot be null | [Section](section-definitions-section-properties-position.md "https://ns.adobe.com/helix/pipeline/position#/definitions/section/properties/position") | +| [children](#children) | `array` | Optional | cannot be null | [Section](section-definitions-section-properties-children.md "https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/children") | +| [meta](#meta) | `object` | Optional | can be null | [Section](meta-definitions-meta.md "https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/meta") | +| [title](#title) | `string` | Optional | cannot be null | [Section](meta-definitions-meta-properties-title.md "https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/title") | +| [intro](#intro) | `string` | Optional | cannot be null | [Section](meta-definitions-meta-properties-intro.md "https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/intro") | +| [image](#image) | `string` | Optional | cannot be null | [Section](meta-definitions-meta-properties-image.md "https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/image") | + +### type + +The MDAST node type. Each section can be treated as a standalone document. + + +`type` + +- is optional +- Type: unknown +- cannot be null +- defined in: [Section](section-definitions-section-properties-type.md "https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/type") + +#### type Type + +unknown + +#### type Constraints + +**constant**: the value of this property must be equal to: + +```json +"root" +``` + +### position + +Marks the position of an AST node in the original text flow + + +`position` + +- is optional +- Type: `object` ([Position](section-definitions-section-properties-position.md)) +- cannot be null +- defined in: [Section](section-definitions-section-properties-position.md "https://ns.adobe.com/helix/pipeline/position#/definitions/section/properties/position") + +#### position Type + +`object` ([Position](section-definitions-section-properties-position.md)) + +### children + +The AST nodes making up the section. Section dividers are not included. + + +`children` + +- is optional +- Type: `object[]` ([MDAST](content-properties-mdast.md)) +- cannot be null +- defined in: [Section](section-definitions-section-properties-children.md "https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/children") + +#### children Type + +`object[]` ([MDAST](content-properties-mdast.md)) + +### meta + + + + +`meta` + +- is optional +- Type: `object` ([Details](meta-definitions-meta.md)) +- can be null +- defined in: [Section](meta-definitions-meta.md "https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/meta") + +#### meta Type + +`object` ([Details](meta-definitions-meta.md)) + +### title + +Extracted title of the document + + +`title` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Section](meta-definitions-meta-properties-title.md "https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/title") + +#### title Type + +`string` + +### intro + +Extracted first paragraph of the document + + +`intro` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Section](meta-definitions-meta-properties-intro.md "https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/intro") + +#### intro Type + +`string` + +### image + +Path (can be relative) to the first image in the document + + +`image` + +- is optional +- Type: `string` +- cannot be null +- defined in: [Section](meta-definitions-meta-properties-image.md "https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/image") + +#### image Type + +`string` + +#### image Constraints + +**URI reference**: the string must be a URI reference, according to [RFC 3986](https://tools.ietf.org/html/rfc4291 "check the specification") diff --git a/docs/section.schema.json b/docs/section.schema.json index c763c9974..97c82c84f 100644 --- a/docs/section.schema.json +++ b/docs/section.schema.json @@ -1,51 +1 @@ -{ - "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/pipeline/section", - "$schema": "http://json-schema.org/draft-07/schema#", - "description": "A section in a markdown document", - "meta:status": "experimental", - "title": "Section", - "definitions": { - "section": { - "additionalProperties": false, - "properties": { - "type": { - "const": "root", - "description": "The MDAST node type. Each section can be treated as a standalone document." - }, - "position": { - "$ref": "https://ns.adobe.com/helix/pipeline/position" - }, - "children": { - "type": "array", - "description": "The AST nodes making up the section. Section dividers are not included.", - "items": { - "$ref": "https://ns.adobe.com/helix/pipeline/mdast" - } - }, - "meta": { - "$ref": "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta" - }, - "title": { - "$ref": "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/title" - }, - "intro": { - "$ref": "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/intro" - }, - "image": { - "$ref": "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/image" - } - } - } - } -} \ No newline at end of file +{"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/pipeline/section","$schema":"http://json-schema.org/draft-07/schema#","description":"A section in a markdown document","meta:status":"experimental","title":"Section","definitions":{"section":{"additionalProperties":false,"properties":{"type":{"const":"root","description":"The MDAST node type. Each section can be treated as a standalone document."},"position":{"$ref":"https://ns.adobe.com/helix/pipeline/position"},"children":{"type":"array","description":"The AST nodes making up the section. Section dividers are not included.","items":{"$ref":"https://ns.adobe.com/helix/pipeline/mdast"}},"meta":{"$ref":"https://ns.adobe.com/helix/pipeline/meta#/definitions/meta"},"title":{"$ref":"https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/title"},"intro":{"$ref":"https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/intro"},"image":{"$ref":"https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/image"}}}}} diff --git a/docs/section.schema.md b/docs/section.schema.md deleted file mode 100644 index 36dacff02..000000000 --- a/docs/section.schema.md +++ /dev/null @@ -1,117 +0,0 @@ -# Section Schema - -``` -https://ns.adobe.com/helix/pipeline/section -``` - -A section in a markdown document - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Defined In | -| ---------------------- | ---------- | ------------ | ------------ | ----------------- | --------------------- | ------------------------------------------ | -| Cannot be instantiated | Yes | Experimental | No | Forbidden | Permitted | [section.schema.json](section.schema.json) | - -# Section Definitions - -| Property | Type | Group | -| --------------------- | --------- | ------------------------------------------------------------------ | -| [children](#children) | reference | `https://ns.adobe.com/helix/pipeline/section#/definitions/section` | -| [image](#image) | reference | `https://ns.adobe.com/helix/pipeline/section#/definitions/section` | -| [intro](#intro) | reference | `https://ns.adobe.com/helix/pipeline/section#/definitions/section` | -| [meta](#meta) | reference | `https://ns.adobe.com/helix/pipeline/section#/definitions/section` | -| [position](#position) | reference | `https://ns.adobe.com/helix/pipeline/section#/definitions/section` | -| [title](#title) | reference | `https://ns.adobe.com/helix/pipeline/section#/definitions/section` | -| [type](#type) | `const` | `https://ns.adobe.com/helix/pipeline/section#/definitions/section` | - -## children - -The AST nodes making up the section. Section dividers are not included. - -`children` - -- is optional -- type: reference -- defined in this schema - -### children Type - -Array type: reference - -All items must be of the type: - -- []() – `https://ns.adobe.com/helix/pipeline/mdast` - -## image - -`image` - -- is optional -- type: reference -- defined in this schema - -### image Type - -- []() – `https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/image` - -## intro - -`intro` - -- is optional -- type: reference -- defined in this schema - -### intro Type - -- []() – `https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/intro` - -## meta - -`meta` - -- is optional -- type: reference -- defined in this schema - -### meta Type - -- []() – `https://ns.adobe.com/helix/pipeline/meta#/definitions/meta` - -## position - -`position` - -- is optional -- type: reference -- defined in this schema - -### position Type - -- []() – `https://ns.adobe.com/helix/pipeline/position` - -## title - -`title` - -- is optional -- type: reference -- defined in this schema - -### title Type - -- []() – `https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/title` - -## type - -The MDAST node type. Each section can be treated as a standalone document. - -`type` - -- is optional -- type: `const` -- defined in this schema - -The value of this property **must** be equal to: - -```json -"root" -``` diff --git a/docs/textcoordinates-properties-column.md b/docs/textcoordinates-properties-column.md new file mode 100644 index 000000000..86a370185 --- /dev/null +++ b/docs/textcoordinates-properties-column.md @@ -0,0 +1,16 @@ +# Untitled number in Text Coordinates Schema + +```txt +https://ns.adobe.com/helix/pipeline/textcoordinates#/properties/column +``` + +Column number + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ----------------------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [textcoordinates.schema.json\*](textcoordinates.schema.json "open original schema") | + +## column Type + +`number` diff --git a/docs/textcoordinates-properties-line.md b/docs/textcoordinates-properties-line.md new file mode 100644 index 000000000..666b39ca3 --- /dev/null +++ b/docs/textcoordinates-properties-line.md @@ -0,0 +1,16 @@ +# Untitled number in Text Coordinates Schema + +```txt +https://ns.adobe.com/helix/pipeline/textcoordinates#/properties/line +``` + +Line number + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ----------------------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [textcoordinates.schema.json\*](textcoordinates.schema.json "open original schema") | + +## line Type + +`number` diff --git a/docs/textcoordinates-properties-offset.md b/docs/textcoordinates-properties-offset.md new file mode 100644 index 000000000..c365d49b6 --- /dev/null +++ b/docs/textcoordinates-properties-offset.md @@ -0,0 +1,16 @@ +# Untitled number in Text Coordinates Schema + +```txt +https://ns.adobe.com/helix/pipeline/textcoordinates#/properties/offset +``` + +Character in the entire document + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ----------------------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [textcoordinates.schema.json\*](textcoordinates.schema.json "open original schema") | + +## offset Type + +`number` diff --git a/docs/textcoordinates-properties.md b/docs/textcoordinates-properties.md new file mode 100644 index 000000000..1815fbcb9 --- /dev/null +++ b/docs/textcoordinates-properties.md @@ -0,0 +1,16 @@ +# Untitled undefined type in Text Coordinates Schema + +```txt +https://ns.adobe.com/helix/pipeline/textcoordinates#/properties +``` + + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | ----------------------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [textcoordinates.schema.json\*](textcoordinates.schema.json "open original schema") | + +## properties Type + +unknown diff --git a/docs/textcoordinates.md b/docs/textcoordinates.md new file mode 100644 index 000000000..d14da85bc --- /dev/null +++ b/docs/textcoordinates.md @@ -0,0 +1,72 @@ +# Text Coordinates Schema + +```txt +https://ns.adobe.com/helix/pipeline/textcoordinates +``` + +A position in a text document + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | ---------- | ----------- | ------------ | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------------------------- | +| Can be instantiated | No | Stabilizing | No | Forbidden | Forbidden | none | [textcoordinates.schema.json](textcoordinates.schema.json "open original schema") | + +## Text Coordinates Type + +`object` ([Text Coordinates](textcoordinates.md)) + +# Text Coordinates Properties + +| Property | Type | Required | Nullable | Defined by | +| :---------------- | -------- | -------- | -------------- | :------------------------------------------------------------------------------------------------------------------------------------- | +| [line](#line) | `number` | Optional | cannot be null | [Text Coordinates](textcoordinates-properties-line.md "https://ns.adobe.com/helix/pipeline/textcoordinates#/properties/line") | +| [column](#column) | `number` | Optional | cannot be null | [Text Coordinates](textcoordinates-properties-column.md "https://ns.adobe.com/helix/pipeline/textcoordinates#/properties/column") | +| [offset](#offset) | `number` | Optional | cannot be null | [Text Coordinates](textcoordinates-properties-offset.md "https://ns.adobe.com/helix/pipeline/textcoordinates#/properties/offset") | + +## line + +Line number + + +`line` + +- is optional +- Type: `number` +- cannot be null +- defined in: [Text Coordinates](textcoordinates-properties-line.md "https://ns.adobe.com/helix/pipeline/textcoordinates#/properties/line") + +### line Type + +`number` + +## column + +Column number + + +`column` + +- is optional +- Type: `number` +- cannot be null +- defined in: [Text Coordinates](textcoordinates-properties-column.md "https://ns.adobe.com/helix/pipeline/textcoordinates#/properties/column") + +### column Type + +`number` + +## offset + +Character in the entire document + + +`offset` + +- is optional +- Type: `number` +- cannot be null +- defined in: [Text Coordinates](textcoordinates-properties-offset.md "https://ns.adobe.com/helix/pipeline/textcoordinates#/properties/offset") + +### offset Type + +`number` diff --git a/docs/textcoordinates.schema.json b/docs/textcoordinates.schema.json index 5a62b7692..d5d5acce6 100644 --- a/docs/textcoordinates.schema.json +++ b/docs/textcoordinates.schema.json @@ -1,34 +1 @@ -{ - "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/pipeline/textcoordinates", - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "title": "Text Coordinates", - "meta:status": "stabilizing", - "description": "A position in a text document", - "additionalProperties": false, - "properties": { - "line": { - "type": "number", - "description": "Line number" - }, - "column": { - "type": "number", - "description": "Column number" - }, - "offset": { - "type": "number", - "description": "Character in the entire document" - } - } -} \ No newline at end of file +{"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/pipeline/textcoordinates","$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"Text Coordinates","meta:status":"stabilizing","description":"A position in a text document","additionalProperties":false,"properties":{"line":{"type":"number","description":"Line number"},"column":{"type":"number","description":"Column number"},"offset":{"type":"number","description":"Character in the entire document"}}} diff --git a/docs/textcoordinates.schema.md b/docs/textcoordinates.schema.md deleted file mode 100644 index c8888887f..000000000 --- a/docs/textcoordinates.schema.md +++ /dev/null @@ -1,61 +0,0 @@ -# Text Coordinates Schema - -``` -https://ns.adobe.com/helix/pipeline/textcoordinates -``` - -A position in a text document - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Defined In | -| ------------------- | ---------- | ----------- | ------------ | ----------------- | --------------------- | ---------------------------------------------------------- | -| Can be instantiated | No | Stabilizing | No | Forbidden | Forbidden | [textcoordinates.schema.json](textcoordinates.schema.json) | - -# Text Coordinates Properties - -| Property | Type | Required | Nullable | Defined by | -| ----------------- | -------- | -------- | -------- | ------------------------------ | -| [column](#column) | `number` | Optional | No | Text Coordinates (this schema) | -| [line](#line) | `number` | Optional | No | Text Coordinates (this schema) | -| [offset](#offset) | `number` | Optional | No | Text Coordinates (this schema) | - -## column - -Column number - -`column` - -- is optional -- type: `number` -- defined in this schema - -### column Type - -`number` - -## line - -Line number - -`line` - -- is optional -- type: `number` -- defined in this schema - -### line Type - -`number` - -## offset - -Character in the entire document - -`offset` - -- is optional -- type: `number` -- defined in this schema - -### offset Type - -`number` diff --git a/package-lock.json b/package-lock.json index 28effa0f9..3402d9e1d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "@adobe/helix-pipeline", - "version": "6.1.6", + "version": "6.1.7", "lockfileVersion": 1, "requires": true, "dependencies": { @@ -29,9 +29,9 @@ } }, "@adobe/helix-shared": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/@adobe/helix-shared/-/helix-shared-3.1.2.tgz", - "integrity": "sha512-yAeO9EQW9ycYsP3aw8x9ayUyBgx1dHsQ3KokVnw1V64/biwZ4v8k+7LrPH53lEDnI/n6AEG01JI0LeMhIHl7lA==", + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/@adobe/helix-shared/-/helix-shared-4.0.0.tgz", + "integrity": "sha512-Y4Tolba2jC6akPKT7OvMoQvYyhlCbr9ou6cZG94jqKKCU/OfLybgvPKallxGS+5D5PXAWpOTf8Jm2MyEMg/Lhw==", "requires": { "ajv": "^6.10.2", "ferrum": "^1.4.1", @@ -46,39 +46,201 @@ } }, "@adobe/jsonschema2md": { - "version": "3.3.1", - "resolved": "https://registry.npmjs.org/@adobe/jsonschema2md/-/jsonschema2md-3.3.1.tgz", - "integrity": "sha512-fF3TaFazqZ52DaM9Au97STq7LnnMzDFr5Nr4RUY/7XImL0fW8SbjLl3M3AuALI2UZv28qcWxu+h03Nz3k2h7HA==", + "version": "4.0.6", + "resolved": "https://registry.npmjs.org/@adobe/jsonschema2md/-/jsonschema2md-4.0.6.tgz", + "integrity": "sha512-0R05wLpcxCA0I6f8fMAfR1FagdD37cw3eOf09jNLRD52D+LvSYrEn7Befy0xiAxjLQBT8V8RcwDOVLRHJsOY5Q==", "dev": true, "requires": { - "@adobe/helix-log": "^2.0.0", - "ajv": "^6.10.2", - "bluebird": "^3.5.5", - "ejs": "^2.6.2", + "@adobe/helix-log": "^4.4.0", + "es2015-i18n-tag": "^1.6.1", + "ferrum": "^1.4.1", + "fs-extra": "^8.1.0", "github-slugger": "^1.2.1", - "i18n": "^0.8.3", - "jasmine-xml-reporter": "^1.2.1", - "json-pointer": "^0.6.0", - "lodash": "^4.17.15", - "mkdirp": "^0.5.1", - "optimist": "^0.6.1", - "prettier": "^1.18.2", - "readdirp": "^3.1.1", - "valid-url": "1.0.9" + "js-yaml": "^3.13.1", + "mdast-builder": "^1.1.1", + "mdast-util-to-string": "^1.0.7", + "mocha": "^6.2.2", + "readdirp": "^3.3.0", + "remark-parse": "^7.0.2", + "remark-stringify": "^7.0.4", + "unified": "^8.4.2", + "unist-builder": "^2.0.2", + "unist-util-inspect": "^5.0.0", + "yargs": "^15.0.2" }, "dependencies": { - "@adobe/helix-log": { + "diff": { + "version": "3.5.0", + "resolved": "https://registry.npmjs.org/diff/-/diff-3.5.0.tgz", + "integrity": "sha512-A46qtFgd+g7pDZinpnwiRJtxbC1hpgf0uzP3iG89scHk0AUC7A1TGxf5OiiOUv/JMZR8GOt8hL900hV0bOy5xA==", + "dev": true + }, + "find-up": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-3.0.0.tgz", + "integrity": "sha512-1yD6RmLI1XBfxugvORwlck6f75tYL+iR0jqwsOrOxMZyGYqUuDhJ0l4AXdO1iX/FTs9cBAMEk1gWSEx1kSbylg==", + "dev": true, + "requires": { + "locate-path": "^3.0.0" + } + }, + "glob": { + "version": "7.1.3", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.3.tgz", + "integrity": "sha512-vcfuiIxogLV4DlGBHIUOwI0IbrJ8HWPc4MU7HzviGeNho/UJDfi6B5p3sHeWIQ0KGIU0Jpxi5ZHxemQfLkkAwQ==", + "dev": true, + "requires": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.0.4", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + } + }, + "locate-path": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-3.0.0.tgz", + "integrity": "sha512-7AO748wWnIhNqAuaty2ZWHkQHRSNfPVIsPIfwEOWO22AmaoVrWavlOcMR5nzTLNYvp36X220/maaRsrec1G65A==", + "dev": true, + "requires": { + "p-locate": "^3.0.0", + "path-exists": "^3.0.0" + } + }, + "log-symbols": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/log-symbols/-/log-symbols-2.2.0.tgz", + "integrity": "sha512-VeIAFslyIerEJLXHziedo2basKbMKtTw3vfn5IzG0XTjhAVEJyNHnL2p7vc+wBDSdQuUpNw3M2u6xb9QsAY5Eg==", + "dev": true, + "requires": { + "chalk": "^2.0.1" + } + }, + "mocha": { + "version": "6.2.2", + "resolved": "https://registry.npmjs.org/mocha/-/mocha-6.2.2.tgz", + "integrity": "sha512-FgDS9Re79yU1xz5d+C4rv1G7QagNGHZ+iXF81hO8zY35YZZcLEsJVfFolfsqKFWunATEvNzMK0r/CwWd/szO9A==", + "dev": true, + "requires": { + "ansi-colors": "3.2.3", + "browser-stdout": "1.3.1", + "debug": "3.2.6", + "diff": "3.5.0", + "escape-string-regexp": "1.0.5", + "find-up": "3.0.0", + "glob": "7.1.3", + "growl": "1.10.5", + "he": "1.2.0", + "js-yaml": "3.13.1", + "log-symbols": "2.2.0", + "minimatch": "3.0.4", + "mkdirp": "0.5.1", + "ms": "2.1.1", + "node-environment-flags": "1.0.5", + "object.assign": "4.1.0", + "strip-json-comments": "2.0.1", + "supports-color": "6.0.0", + "which": "1.3.1", + "wide-align": "1.1.3", + "yargs": "13.3.0", + "yargs-parser": "13.1.1", + "yargs-unparser": "1.6.0" + }, + "dependencies": { + "yargs": { + "version": "13.3.0", + "resolved": "https://registry.npmjs.org/yargs/-/yargs-13.3.0.tgz", + "integrity": "sha512-2eehun/8ALW8TLoIl7MVaRUrg+yCnenu8B4kBlRxj3GJGDKU1Og7sMXPNm1BYyM1DOJmTZ4YeN/Nwxv+8XJsUA==", + "dev": true, + "requires": { + "cliui": "^5.0.0", + "find-up": "^3.0.0", + "get-caller-file": "^2.0.1", + "require-directory": "^2.1.1", + "require-main-filename": "^2.0.0", + "set-blocking": "^2.0.0", + "string-width": "^3.0.0", + "which-module": "^2.0.0", + "y18n": "^4.0.0", + "yargs-parser": "^13.1.1" + } + } + } + }, + "ms": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.1.tgz", + "integrity": "sha512-tgp+dl5cGk28utYktBsrFqA7HKgrhgPsg6Z/EfhWI4gl1Hwq8B/GmY/0oXZ6nF8hDVesS/FpnYaD/kOWhYQvyg==", + "dev": true + }, + "node-environment-flags": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/node-environment-flags/-/node-environment-flags-1.0.5.tgz", + "integrity": "sha512-VNYPRfGfmZLx0Ye20jWzHUjyTW/c+6Wq+iLhDzUI4XmhrDd9l/FozXV3F2xOaXjvp0co0+v1YSR3CMP6g+VvLQ==", + "dev": true, + "requires": { + "object.getownpropertydescriptors": "^2.0.3", + "semver": "^5.7.0" + } + }, + "p-limit": { "version": "2.2.2", - "resolved": "https://registry.npmjs.org/@adobe/helix-log/-/helix-log-2.2.2.tgz", - "integrity": "sha512-Jn8EUE2Mpb3NRz5wWrj3xu51kZDYboTlAueG5mgYdG3/NnHNUJU75N/JMpA+QTPSAi9XjWoUmM7nQW346qbU3g==", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.2.2.tgz", + "integrity": "sha512-WGR+xHecKTr7EbUEhyLSh5Dube9JtdiG78ufaeLxTgpudf/20KqyMioIUZJAezlTIi6evxuoUs9YXc11cU+yzQ==", + "dev": true, + "requires": { + "p-try": "^2.0.0" + } + }, + "p-locate": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-3.0.0.tgz", + "integrity": "sha512-x+12w/To+4GFfgJhBEpiDcLozRJGegY+Ei7/z0tSLkMmxGZNybVMSfWj9aJn8Z5Fc7dBUNJOOVgPv2H7IwulSQ==", + "dev": true, + "requires": { + "p-limit": "^2.0.0" + } + }, + "p-try": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", + "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", + "dev": true + }, + "readdirp": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/readdirp/-/readdirp-3.3.0.tgz", + "integrity": "sha512-zz0pAkSPOXXm1viEwygWIPSPkcBYjW1xU5j/JBh5t9bGCJwa6f9+BJa6VaB2g+b55yVrmXzqkyLf4xaWYM0IkQ==", + "dev": true, + "requires": { + "picomatch": "^2.0.7" + } + }, + "semver": { + "version": "5.7.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-5.7.1.tgz", + "integrity": "sha512-sauaDf/PZdVgrLTNYHRtpXa1iRiKcaebiKQ1BJdpQlWH2lCvexQdX55snPFyK7QzpudqbCI0qXFfOasHdyNDGQ==", + "dev": true + }, + "string-width": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-3.1.0.tgz", + "integrity": "sha512-vafcv6KjVZKSgz06oM/H6GDBrAtz8vdhQakGjFIvNrHA6y3HCF1CInLy+QLq8dTJPQ1b+KDUqDFctkdRW44e1w==", + "dev": true, + "requires": { + "emoji-regex": "^7.0.1", + "is-fullwidth-code-point": "^2.0.0", + "strip-ansi": "^5.1.0" + } + }, + "supports-color": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-6.0.0.tgz", + "integrity": "sha512-on9Kwidc1IUQo+bQdhi8+Tijpo0e1SS6RoGo2guUwn5vdaxw8RXOF9Vb2ws+ihWOmh4JnCJOvaziZWP1VABaLg==", "dev": true, "requires": { - "colorette": "^1.1.0", - "ferrum": "^1.2.0", - "phin": "^3.4.0", - "polka": "^0.5.2", - "snyk": "^1.226.1", - "uuid": "^3.3.3" + "has-flag": "^3.0.0" } } } @@ -1370,131 +1532,12 @@ "integrity": "sha512-+iTbntw2IZPb/anVDbypzfQa+ay64MW0Zo8aJ8gZPWMMK6/OubMVb6lUPMagqjOPnmtauXnFCACVl3O7ogjeqQ==", "dev": true }, - "@snyk/cli-interface": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/@snyk/cli-interface/-/cli-interface-2.2.0.tgz", - "integrity": "sha512-sA7V2JhgqJB9z5uYotgQc5iNDv//y+Mdm39rANxmFjtZMSYJZHkP80arzPjw1mB5ni/sWec7ieYUUFeySZBfVg==", - "dev": true, - "requires": { - "tslib": "^1.9.3" - } - }, - "@snyk/cocoapods-lockfile-parser": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/@snyk/cocoapods-lockfile-parser/-/cocoapods-lockfile-parser-3.0.0.tgz", - "integrity": "sha512-AebCc+v9vtOL9tFkU4/tommgVsXxqdx6t45kCkBW+FC4PaYvfYEg9Eg/9GqlY9+nFrLFo/uTr+E/aR0AF/KqYA==", - "dev": true, - "requires": { - "@snyk/dep-graph": "^1.11.0", - "@snyk/ruby-semver": "^2.0.4", - "@types/js-yaml": "^3.12.1", - "core-js": "^3.2.0", - "js-yaml": "^3.13.1", - "source-map-support": "^0.5.7", - "tslib": "^1.9.3" - } - }, - "@snyk/composer-lockfile-parser": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/@snyk/composer-lockfile-parser/-/composer-lockfile-parser-1.2.0.tgz", - "integrity": "sha512-kZT+HTqgNcQMeoE5NM9M3jj463M8zI7ZxqZXLw9WoyVs5JTt9g0qFWxIG1cNwZdGVI+y7tzZbNWw9BlMD1vCCQ==", - "dev": true, - "requires": { - "lodash": "^4.17.13" - } - }, - "@snyk/dep-graph": { - "version": "1.13.1", - "resolved": "https://registry.npmjs.org/@snyk/dep-graph/-/dep-graph-1.13.1.tgz", - "integrity": "sha512-Ww2xvm5UQgrq9eV0SdTBCh+w/4oI2rCx5vn1IOSeypaR0CO4p+do1vm3IDZ2ugg4jLSfHP8+LiD6ORESZMkQ2w==", - "dev": true, - "requires": { - "graphlib": "^2.1.5", - "lodash": "^4.7.14", - "object-hash": "^1.3.1", - "semver": "^6.0.0", - "source-map-support": "^0.5.11", - "tslib": "^1.9.3" - }, - "dependencies": { - "object-hash": { - "version": "1.3.1", - "resolved": "https://registry.npmjs.org/object-hash/-/object-hash-1.3.1.tgz", - "integrity": "sha512-OSuu/pU4ENM9kmREg0BdNrUDIl1heYa4mBZacJc+vVWz4GtAwu7jO8s4AIt2aGRUTqxykpWzI3Oqnsm13tTMDA==", - "dev": true - } - } - }, - "@snyk/gemfile": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/@snyk/gemfile/-/gemfile-1.2.0.tgz", - "integrity": "sha512-nI7ELxukf7pT4/VraL4iabtNNMz8mUo7EXlqCFld8O5z6mIMLX9llps24iPpaIZOwArkY3FWA+4t+ixyvtTSIA==", - "dev": true - }, - "@snyk/ruby-semver": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/@snyk/ruby-semver/-/ruby-semver-2.0.4.tgz", - "integrity": "sha512-ceMD4CBS3qtAg+O0BUvkKdsheUNCqi+/+Rju243Ul8PsUgZnXmGiqfk/2z7DCprRQnxUTra4+IyeDQT7wAheCQ==", - "dev": true, - "requires": { - "lodash": "^4.17.14" - } - }, - "@snyk/snyk-cocoapods-plugin": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/@snyk/snyk-cocoapods-plugin/-/snyk-cocoapods-plugin-2.0.1.tgz", - "integrity": "sha512-XVkvaMvMzQ3miJi/YZmsRJSAUfDloYhfg6pXPgzAeAugB4p+cNi01Z68pT62ypB8U/Ugh1Xx2pb9aoOFqBbSjA==", - "dev": true, - "requires": { - "@snyk/cli-interface": "1.5.0", - "@snyk/cocoapods-lockfile-parser": "3.0.0", - "@snyk/dep-graph": "^1.13.1", - "source-map-support": "^0.5.7", - "tslib": "^1.9.3" - }, - "dependencies": { - "@snyk/cli-interface": { - "version": "1.5.0", - "resolved": "https://registry.npmjs.org/@snyk/cli-interface/-/cli-interface-1.5.0.tgz", - "integrity": "sha512-+Qo+IO3YOXWgazlo+CKxOuWFLQQdaNCJ9cSfhFQd687/FuesaIxWdInaAdfpsLScq0c6M1ieZslXgiZELSzxbg==", - "dev": true, - "requires": { - "tslib": "^1.9.3" - } - } - } - }, - "@types/agent-base": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/@types/agent-base/-/agent-base-4.2.0.tgz", - "integrity": "sha512-8mrhPstU+ZX0Ugya8tl5DsDZ1I5ZwQzbL/8PA0z8Gj0k9nql7nkaMzmPVLj+l/nixWaliXi+EBiLA8bptw3z7Q==", - "dev": true, - "requires": { - "@types/events": "*", - "@types/node": "*" - } - }, - "@types/bunyan": { - "version": "1.8.6", - "resolved": "https://registry.npmjs.org/@types/bunyan/-/bunyan-1.8.6.tgz", - "integrity": "sha512-YiozPOOsS6bIuz31ilYqR5SlLif4TBWsousN2aCWLi5233nZSX19tFbcQUPdR7xJ8ypPyxkCGNxg0CIV5n9qxQ==", - "dev": true, - "requires": { - "@types/node": "*" - } - }, "@types/color-name": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/@types/color-name/-/color-name-1.1.1.tgz", "integrity": "sha512-rr+OQyAjxze7GgWrSaJwydHStIhHq2lvY3BOC2Mj7KnzI7XK0Uw1TOOdI9lDoajEbSWLiYgoo4f1R51erQfhPQ==", "dev": true }, - "@types/debug": { - "version": "4.1.5", - "resolved": "https://registry.npmjs.org/@types/debug/-/debug-4.1.5.tgz", - "integrity": "sha512-Q1y515GcOdTHgagaVFhHnIFQ38ygs/kmxdNpvpou+raI9UO3YZcHDngBSYKQklcKlvA7iuQlmIKbzvmxcOE9CQ==", - "dev": true - }, "@types/events": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/@types/events/-/events-3.0.0.tgz", @@ -1512,12 +1555,6 @@ "@types/node": "*" } }, - "@types/js-yaml": { - "version": "3.12.1", - "resolved": "https://registry.npmjs.org/@types/js-yaml/-/js-yaml-3.12.1.tgz", - "integrity": "sha512-SGGAhXLHDx+PK4YLNcNGa6goPf9XRWQNAUUbffkwVGGXIxmDKWyGGL4inzq2sPmExu431Ekb9aEMn9BkPqEYFA==", - "dev": true - }, "@types/json-schema": { "version": "7.0.4", "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.4.tgz", @@ -1562,49 +1599,17 @@ "integrity": "sha512-gDE8JJEygpay7IjA/u3JiIURvwZW08f0cZSZLAzFoX/ZmeqvS0Sqv+97aKuHpNsalAMMhwPe+iAS6fQbfmbt7A==", "dev": true }, - "@types/restify": { - "version": "4.3.6", - "resolved": "https://registry.npmjs.org/@types/restify/-/restify-4.3.6.tgz", - "integrity": "sha512-4l4f0EXnleXQttlhRCXtTuJ8UelsKiAKIK2AAEd2epBHu41aEbM0U2z6E5tUrNwlbxz7qaNBISduGMeg+G3PaA==", - "dev": true, - "requires": { - "@types/bunyan": "*", - "@types/node": "*" - } - }, "@types/retry": { "version": "0.12.0", "resolved": "https://registry.npmjs.org/@types/retry/-/retry-0.12.0.tgz", "integrity": "sha512-wWKOClTTiizcZhXnPY4wikVAwmdYHp8q6DmC+EJUzAMsycb7HB32Kh9RN4+0gExjmPmZSAQjgURXIGATPegAvA==", "dev": true }, - "@types/semver": { - "version": "5.5.0", - "resolved": "https://registry.npmjs.org/@types/semver/-/semver-5.5.0.tgz", - "integrity": "sha512-41qEJgBH/TWgo5NFSvBCJ1qkoi3Q6ONSF2avrHq1LVEZfYpdHmj0y9SuTK+u9ZhG1sYQKBL1AWXKyLWP4RaUoQ==", - "dev": true - }, "@types/unist": { "version": "2.0.3", "resolved": "https://registry.npmjs.org/@types/unist/-/unist-2.0.3.tgz", "integrity": "sha512-FvUupuM3rlRsRtCN+fDudtmytGO6iHJuuRKS1Ss0pG5z8oX0diNEw94UEL7hgDbpN94rgaK5R7sWm6RrSkZuAQ==" }, - "@types/xml2js": { - "version": "0.4.3", - "resolved": "https://registry.npmjs.org/@types/xml2js/-/xml2js-0.4.3.tgz", - "integrity": "sha512-Pv2HGRE4gWLs31In7nsyXEH4uVVsd0HNV9i2dyASvtDIlOtSTr1eczPLDpdEuyv5LWH5LT20GIXwPjkshKWI1g==", - "dev": true, - "requires": { - "@types/events": "*", - "@types/node": "*" - } - }, - "@yarnpkg/lockfile": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/@yarnpkg/lockfile/-/lockfile-1.1.0.tgz", - "integrity": "sha512-GpSwvyXOcOOlV70vbnzjj4fW5xW/FdUF6nQEt1ENy7m4ZCczi1+/buVUPAqmGfqznsORNFzUMjctTIp8a9tuCQ==", - "dev": true - }, "JSONStream": { "version": "1.3.5", "resolved": "https://registry.npmjs.org/JSONStream/-/JSONStream-1.3.5.tgz", @@ -1620,12 +1625,6 @@ "resolved": "https://registry.npmjs.org/abab/-/abab-2.0.3.tgz", "integrity": "sha512-tsFzPpcttalNjFBCFMqsKYQcWxxen1pgJR56by//QwvJc4/OUS3kPOOttx2tSIfjsylB0pYu7f5D3K1RCxUnUg==" }, - "abbrev": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/abbrev/-/abbrev-1.1.1.tgz", - "integrity": "sha512-nne9/IiQ/hzIhY6pdDnbBtz7DjPTKrY00P/zvPSm5pOFkl6xuGrGnXn/VtTNNfNtAfZ9/1RtehkszU9qcTii0Q==", - "dev": true - }, "accepts": { "version": "1.3.7", "resolved": "https://registry.npmjs.org/accepts/-/accepts-1.3.7.tgz", @@ -1698,15 +1697,6 @@ "uri-js": "^4.2.2" } }, - "ansi-align": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/ansi-align/-/ansi-align-2.0.0.tgz", - "integrity": "sha1-w2rsy6VjuJzrVW82kPCx2eNUf38=", - "dev": true, - "requires": { - "string-width": "^2.0.0" - } - }, "ansi-colors": { "version": "3.2.3", "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-3.2.3.tgz", @@ -2006,12 +1996,6 @@ "integrity": "sha1-iYUI2iIm84DfkEcoRWhJwVAaSw0=", "dev": true }, - "asap": { - "version": "2.0.6", - "resolved": "https://registry.npmjs.org/asap/-/asap-2.0.6.tgz", - "integrity": "sha1-5QNHYR1+aQlDIIu9r+vLwvuGbUY=", - "dev": true - }, "asn1": { "version": "0.2.4", "resolved": "https://registry.npmjs.org/asn1/-/asn1-0.2.4.tgz", @@ -2031,12 +2015,6 @@ "integrity": "sha1-WWZ/QfrdTyDMvCu5a41Pf3jsA2c=", "dev": true }, - "ast-types": { - "version": "0.13.2", - "resolved": "https://registry.npmjs.org/ast-types/-/ast-types-0.13.2.tgz", - "integrity": "sha512-uWMHxJxtfj/1oZClOxDEV1sQ1HCDkA4MG8Gr69KKeBjEVH0R84WlejZ0y2DcwyBlpAEMltmVYkVgqfLFb2oyiA==", - "dev": true - }, "astral-regex": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/astral-regex/-/astral-regex-1.0.0.tgz", @@ -2232,21 +2210,6 @@ "integrity": "sha512-Phlt0plgpIIBOGTT/ehfFnbNlfsDEiqmzE2KRXoX1bLIlir4X/MR+zSyBEkL05ffWgnRSf/DXv+WrUAVr93/ow==", "dev": true }, - "bl": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/bl/-/bl-3.0.0.tgz", - "integrity": "sha512-EUAyP5UHU5hxF8BPT0LKW8gjYLhq1DQIcneOX/pL/m2Alo+OYDQAJlHq+yseMP50Os2nHXOSic6Ss3vSQeyf4A==", - "dev": true, - "requires": { - "readable-stream": "^3.0.1" - } - }, - "bluebird": { - "version": "3.7.1", - "resolved": "https://registry.npmjs.org/bluebird/-/bluebird-3.7.1.tgz", - "integrity": "sha512-DdmyoGCleJnkbp3nkbxTLJ18rjDsE4yCggEwKNXkeV123sPNfOCYeDoeuOY+F2FrSjO1YXcTU+dsy96KMy+gcg==", - "dev": true - }, "blueimp-md5": { "version": "2.12.0", "resolved": "https://registry.npmjs.org/blueimp-md5/-/blueimp-md5-2.12.0.tgz", @@ -2342,29 +2305,6 @@ "integrity": "sha512-FxxltGKqMHkVa3KtpA+kdnxH0caHPDewccyrK3vW1bsMw6Zco4vRPmMunowX0pXlDZqhxkKSpToADQI2Sk4OeQ==", "dev": true }, - "boxen": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/boxen/-/boxen-1.3.0.tgz", - "integrity": "sha512-TNPjfTr432qx7yOjQyaXm3dSR0MH9vXp7eT1BFSl/C51g+EFnOR9hTg1IreahGBmDNCehscshe45f+C1TBZbLw==", - "dev": true, - "requires": { - "ansi-align": "^2.0.0", - "camelcase": "^4.0.0", - "chalk": "^2.0.1", - "cli-boxes": "^1.0.0", - "string-width": "^2.0.0", - "term-size": "^1.2.0", - "widest-line": "^2.0.0" - }, - "dependencies": { - "camelcase": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-4.1.0.tgz", - "integrity": "sha1-1UVjW+HjPFQmScaRc+Xeas+uNN0=", - "dev": true - } - } - }, "brace-expansion": { "version": "1.1.11", "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", @@ -2406,12 +2346,6 @@ "integrity": "sha1-M3dm2hWAEhD92VbCLpxokaudAzc=", "dev": true }, - "buffer-from": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/buffer-from/-/buffer-from-1.1.1.tgz", - "integrity": "sha512-MQcXEUbCKtEo7bhqEs6560Hyd4XaovZlO/k9V3hjVUF/zwW7KBVdSK4gIt/bzwS9MbR5qob+F5jusZsb0YQK2A==", - "dev": true - }, "bytes": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.1.0.tgz", @@ -2514,9 +2448,9 @@ "integrity": "sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==" }, "camelcase": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-2.1.1.tgz", - "integrity": "sha1-fB0W1nmhu+WcoCys7PsBHiAfWh8=", + "version": "5.3.1", + "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-5.3.1.tgz", + "integrity": "sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg==", "dev": true }, "camelcase-keys": { @@ -2538,12 +2472,6 @@ } } }, - "capture-stack-trace": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/capture-stack-trace/-/capture-stack-trace-1.0.1.tgz", - "integrity": "sha512-mYQLZnx5Qt1JgB1WEiMCf2647plpGeQ2NMR/5L0HNZzGQo4fuSPnK+wjfPnKZV0aiJDgzmWqqkV/g7JD+DW0qw==", - "dev": true - }, "cardinal": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/cardinal/-/cardinal-2.1.1.tgz", @@ -2559,6 +2487,12 @@ "resolved": "https://registry.npmjs.org/caseless/-/caseless-0.12.0.tgz", "integrity": "sha1-G2gcIf+EAzyCZUMJBolCDRhxUdw=" }, + "ccount": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/ccount/-/ccount-1.0.4.tgz", + "integrity": "sha512-fpZ81yYfzentuieinmGnphk0pLkOTMm6MZdVqwd77ROvhko6iujLNGrHH5E7utq3ygWklwfmwuG+A7P+NpqT6w==", + "dev": true + }, "centra": { "version": "2.4.0", "resolved": "https://registry.npmjs.org/centra/-/centra-2.4.0.tgz", @@ -2580,6 +2514,12 @@ "resolved": "https://registry.npmjs.org/character-entities/-/character-entities-1.2.3.tgz", "integrity": "sha512-yB4oYSAa9yLcGyTbB4ItFwHw43QHdH129IJ5R+WvxOkWlyFnR5FAaBNnUq4mcxsTVZGh28bHoeTHMKXH1wZf3w==" }, + "character-entities-html4": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/character-entities-html4/-/character-entities-html4-1.1.3.tgz", + "integrity": "sha512-SwnyZ7jQBCRHELk9zf2CN5AnGEc2nA+uKMZLHvcqhpPprjkYhiLn0DywMHgN5ttFZuITMATbh68M6VIVKwJbcg==", + "dev": true + }, "character-entities-legacy": { "version": "1.1.3", "resolved": "https://registry.npmjs.org/character-entities-legacy/-/character-entities-legacy-1.1.3.tgz", @@ -2618,12 +2558,6 @@ "readdirp": "~3.2.0" } }, - "ci-info": { - "version": "1.6.0", - "resolved": "https://registry.npmjs.org/ci-info/-/ci-info-1.6.0.tgz", - "integrity": "sha512-vsGdkwSCDpWmP80ncATX7iea5DWQemg1UgCW5J8tqjU3lYw4FBYuj89J0CTVomA7BEfvSZd84GmHko+MxFQU2A==", - "dev": true - }, "class-list": { "version": "0.1.1", "resolved": "https://registry.npmjs.org/class-list/-/class-list-0.1.1.tgz", @@ -2662,12 +2596,6 @@ "integrity": "sha512-4diC9HaTE+KRAMWhDhrGOECgWZxoevMc5TlkObMqNSsVU62PYzXZ/SMTjzyGAFF1YusgxGcSWTEXBhp0CPwQ1A==", "dev": true }, - "cli-boxes": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/cli-boxes/-/cli-boxes-1.0.0.tgz", - "integrity": "sha1-T6kXw+WclKAEzWH47lCdplFocUM=", - "dev": true - }, "cli-color": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/cli-color/-/cli-color-1.4.0.tgz", @@ -2699,12 +2627,6 @@ "restore-cursor": "^2.0.0" } }, - "cli-spinner": { - "version": "0.2.10", - "resolved": "https://registry.npmjs.org/cli-spinner/-/cli-spinner-0.2.10.tgz", - "integrity": "sha512-U0sSQ+JJvSLi1pAYuJykwiA8Dsr15uHEy85iCJ6A+0DjVxivr3d+N2Wjvodeg89uP5K6TswFkKBfAD7B3YSn/Q==", - "dev": true - }, "cli-table": { "version": "0.3.1", "resolved": "https://registry.npmjs.org/cli-table/-/cli-table-0.3.1.tgz", @@ -2782,59 +2704,25 @@ "dev": true }, "cliui": { - "version": "3.2.0", - "resolved": "https://registry.npmjs.org/cliui/-/cliui-3.2.0.tgz", - "integrity": "sha1-EgYBU3qRbSmUD5NNo7SNWFo5IT0=", + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/cliui/-/cliui-5.0.0.tgz", + "integrity": "sha512-PYeGSEmmHM6zvoef2w8TPzlrnNpXIjTipYK780YswmIP9vjxmd6Y2a3CB2Ks6/AU8NHjZugXvo8w3oWM2qnwXA==", "dev": true, "requires": { - "string-width": "^1.0.1", - "strip-ansi": "^3.0.1", - "wrap-ansi": "^2.0.0" + "string-width": "^3.1.0", + "strip-ansi": "^5.2.0", + "wrap-ansi": "^5.1.0" }, "dependencies": { - "ansi-regex": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-2.1.1.tgz", - "integrity": "sha1-w7M6te42DYbg5ijwRorn7yfWVN8=", - "dev": true - }, - "is-fullwidth-code-point": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-1.0.0.tgz", - "integrity": "sha1-754xOG8DGn8NZDr4L95QxFfvAMs=", - "dev": true, - "requires": { - "number-is-nan": "^1.0.0" - } - }, "string-width": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-1.0.2.tgz", - "integrity": "sha1-EYvfW4zcUaKn5w0hHgfisLmxB9M=", - "dev": true, - "requires": { - "code-point-at": "^1.0.0", - "is-fullwidth-code-point": "^1.0.0", - "strip-ansi": "^3.0.0" - } - }, - "strip-ansi": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-3.0.1.tgz", - "integrity": "sha1-ajhfuIU9lS1f8F0Oiq+UJ43GPc8=", - "dev": true, - "requires": { - "ansi-regex": "^2.0.0" - } - }, - "wrap-ansi": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-2.1.0.tgz", - "integrity": "sha1-2Pw9KE3QV5T+hJc8rs3Rz4JP3YU=", + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-3.1.0.tgz", + "integrity": "sha512-vafcv6KjVZKSgz06oM/H6GDBrAtz8vdhQakGjFIvNrHA6y3HCF1CInLy+QLq8dTJPQ1b+KDUqDFctkdRW44e1w==", "dev": true, "requires": { - "string-width": "^1.0.1", - "strip-ansi": "^3.0.1" + "emoji-regex": "^7.0.1", + "is-fullwidth-code-point": "^2.0.0", + "strip-ansi": "^5.1.0" } } } @@ -2844,18 +2732,6 @@ "resolved": "https://registry.npmjs.org/clone/-/clone-2.1.2.tgz", "integrity": "sha1-G39Ln1kfHo+DZwQBYANFoCiHQ18=" }, - "clone-deep": { - "version": "0.3.0", - "resolved": "https://registry.npmjs.org/clone-deep/-/clone-deep-0.3.0.tgz", - "integrity": "sha1-NIxhrpzb4O3+BT2R/0zFIdeQ7eg=", - "dev": true, - "requires": { - "for-own": "^1.0.0", - "is-plain-object": "^2.0.1", - "kind-of": "^3.2.2", - "shallow-clone": "^0.1.2" - } - }, "cls-hooked": { "version": "4.2.2", "resolved": "https://registry.npmjs.org/cls-hooked/-/cls-hooked-4.2.2.tgz", @@ -2873,12 +2749,6 @@ } } }, - "co": { - "version": "4.6.0", - "resolved": "https://registry.npmjs.org/co/-/co-4.6.0.tgz", - "integrity": "sha1-bqa989hTrlTMuOR7+gvz+QMfsYQ=", - "dev": true - }, "code-point-at": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/code-point-at/-/code-point-at-1.1.0.tgz", @@ -3108,20 +2978,6 @@ "integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=", "dev": true }, - "configstore": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/configstore/-/configstore-3.1.2.tgz", - "integrity": "sha512-vtv5HtGjcYUgFrXc6Kx747B83MRRVS5R1VTEQoXvuP+kMI+if6uywV0nDGoiydJRy4yk7h9od5Og0kxx4zUXmw==", - "dev": true, - "requires": { - "dot-prop": "^4.1.0", - "graceful-fs": "^4.1.2", - "make-dir": "^1.0.0", - "unique-string": "^1.0.0", - "write-file-atomic": "^2.0.0", - "xdg-basedir": "^3.0.0" - } - }, "confusing-browser-globals": { "version": "1.0.9", "resolved": "https://registry.npmjs.org/confusing-browser-globals/-/confusing-browser-globals-1.0.9.tgz", @@ -3251,12 +3107,6 @@ "integrity": "sha1-Z29us8OZl8LuGsOpJP1hJHSPV40=", "dev": true }, - "core-js": { - "version": "3.4.1", - "resolved": "https://registry.npmjs.org/core-js/-/core-js-3.4.1.tgz", - "integrity": "sha512-KX/dnuY/J8FtEwbnrzmAjUYgLqtk+cxM86hfG60LGiW3MmltIc2yAmDgBgEkfm0blZhUrdr1Zd84J2Y14mLxzg==", - "dev": true - }, "core-util-is": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.2.tgz", @@ -3302,15 +3152,6 @@ } } }, - "create-error-class": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/create-error-class/-/create-error-class-3.0.2.tgz", - "integrity": "sha1-Br56vvlHo/FKMP1hBnHUAbyot7Y=", - "dev": true, - "requires": { - "capture-stack-trace": "^1.0.0" - } - }, "cross-spawn": { "version": "6.0.5", "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-6.0.5.tgz", @@ -3412,12 +3253,6 @@ "assert-plus": "^1.0.0" } }, - "data-uri-to-buffer": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/data-uri-to-buffer/-/data-uri-to-buffer-1.2.0.tgz", - "integrity": "sha512-vKQ9DTQPN1FLYiiEEOQ6IBGFqvjCa5rSK3cWMy/Nespm5d/x3dGFT9UBZnkLxCwua/IXBi2TYnwTEpsOvhC4UQ==", - "dev": true - }, "data-urls": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/data-urls/-/data-urls-1.1.0.tgz", @@ -3560,25 +3395,6 @@ } } }, - "degenerator": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/degenerator/-/degenerator-1.0.4.tgz", - "integrity": "sha1-/PSQo37OJmRk2cxDGrmMWBnO0JU=", - "dev": true, - "requires": { - "ast-types": "0.x.x", - "escodegen": "1.x.x", - "esprima": "3.x.x" - }, - "dependencies": { - "esprima": { - "version": "3.1.3", - "resolved": "https://registry.npmjs.org/esprima/-/esprima-3.1.3.tgz", - "integrity": "sha1-/cpRzuYTOJXjyI1TXOSdv/YqRjM=", - "dev": true - } - } - }, "del": { "version": "5.1.0", "resolved": "https://registry.npmjs.org/del/-/del-5.1.0.tgz", @@ -3695,15 +3511,6 @@ "path-type": "^4.0.0" } }, - "dockerfile-ast": { - "version": "0.0.16", - "resolved": "https://registry.npmjs.org/dockerfile-ast/-/dockerfile-ast-0.0.16.tgz", - "integrity": "sha512-+HZToHjjiLPl46TqBrok5dMrg5oCkZFPSROMQjRmvin0zG4FxK0DJXTpV/CUPYY2zpmEvVza55XLwSHFx/xZMw==", - "dev": true, - "requires": { - "vscode-languageserver-types": "^3.5.0" - } - }, "doctrine": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-3.0.0.tgz", @@ -3726,51 +3533,11 @@ "resolved": "https://registry.npmjs.org/dompurify/-/dompurify-2.0.7.tgz", "integrity": "sha512-S3O0lk6rFJtO01ZTzMollCOGg+WAtCwS3U5E2WSDY/x/sy7q70RjEC4Dmrih5/UqzLLB9XoKJ8KqwBxaNvBu4A==" }, - "dot-prop": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/dot-prop/-/dot-prop-4.2.0.tgz", - "integrity": "sha512-tUMXrxlExSW6U2EXiiKGSBVdYgtV8qlHL+C10TsW4PURY/ic+eaysnSkwB4kA/mBlCyy/IKDJ+Lc3wbWeaXtuQ==", - "dev": true, - "requires": { - "is-obj": "^1.0.0" - } - }, "dotenv": { "version": "8.2.0", "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-8.2.0.tgz", "integrity": "sha512-8sJ78ElpbDJBHNeBzUbUVLsqKdccaa/BXF1uPTw3GrvQTBgrQrtObr2mUrE38vzYd8cEv+m/JBfDLioYcfXoaw==" }, - "dotnet-deps-parser": { - "version": "4.5.2", - "resolved": "https://registry.npmjs.org/dotnet-deps-parser/-/dotnet-deps-parser-4.5.2.tgz", - "integrity": "sha512-bk5Q1luEwQ10rrBwZbtTxUNadaLz2dM6xzOLoTK+oUBcaq6saCeELmkIgdG+Fwkn58XRgLQvOySVS0gp4OG6RA==", - "dev": true, - "requires": { - "@types/xml2js": "0.4.3", - "lodash": "^4.17.11", - "source-map-support": "^0.5.7", - "tslib": "^1.9.3", - "xml2js": "0.4.19" - }, - "dependencies": { - "xml2js": { - "version": "0.4.19", - "resolved": "https://registry.npmjs.org/xml2js/-/xml2js-0.4.19.tgz", - "integrity": "sha512-esZnJZJOiJR9wWKMyuvSE1y6Dq5LCuJanqhxslH2bxM6duahNZ+HMpCLhBQGZkbX6xRf8x1Y2eJlgt2q3qo49Q==", - "dev": true, - "requires": { - "sax": ">=0.6.0", - "xmlbuilder": "~9.0.1" - } - }, - "xmlbuilder": { - "version": "9.0.7", - "resolved": "https://registry.npmjs.org/xmlbuilder/-/xmlbuilder-9.0.7.tgz", - "integrity": "sha1-Ey7mPS7FVlxVfiD0wi35rKaGsQ0=", - "dev": true - } - } - }, "duplexer2": { "version": "0.1.4", "resolved": "https://registry.npmjs.org/duplexer2/-/duplexer2-0.1.4.tgz", @@ -3812,12 +3579,6 @@ } } }, - "duplexer3": { - "version": "0.1.4", - "resolved": "https://registry.npmjs.org/duplexer3/-/duplexer3-0.1.4.tgz", - "integrity": "sha1-7gHdHKwO08vH/b6jfcCo8c4ALOI=", - "dev": true - }, "ecc-jsbn": { "version": "0.1.2", "resolved": "https://registry.npmjs.org/ecc-jsbn/-/ecc-jsbn-0.1.2.tgz", @@ -3833,24 +3594,12 @@ "integrity": "sha1-WQxhFWsK4vTwJVcyoViyZrxWsh0=", "dev": true }, - "ejs": { - "version": "2.7.2", - "resolved": "https://registry.npmjs.org/ejs/-/ejs-2.7.2.tgz", - "integrity": "sha512-rHGwtpl67oih3xAHbZlpw5rQAt+YV1mSCu2fUZ9XNrfaGEhom7E+AUiMci+ByP4aSfuAWx7hE0BPuJLMrpXwOw==", - "dev": true - }, "elegant-spinner": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/elegant-spinner/-/elegant-spinner-1.0.1.tgz", "integrity": "sha1-2wQ1IcldfjA/2PNFvtwzSc+wcp4=", "dev": true }, - "email-validator": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/email-validator/-/email-validator-2.0.4.tgz", - "integrity": "sha512-gYCwo7kh5S3IDyZPLZf6hSS0MnZT8QmJFqYvbqlDZSbwdZlY6QZWxJ4i/6UhITOJ4XzyI647Bm2MXKCLqnJ4nQ==", - "dev": true - }, "emitter-listener": { "version": "1.1.2", "resolved": "https://registry.npmjs.org/emitter-listener/-/emitter-listener-1.1.2.tgz", @@ -4046,6 +3795,12 @@ "is-symbol": "^1.0.2" } }, + "es2015-i18n-tag": { + "version": "1.6.1", + "resolved": "https://registry.npmjs.org/es2015-i18n-tag/-/es2015-i18n-tag-1.6.1.tgz", + "integrity": "sha512-MYoh9p+JTkgnzBh0MEBON6xUyzdmwT6wzsmmFJvZujGSXiI2kM+3XvFl6+AcIO2eeL6VWgtX9szSiDTMwDxyYA==", + "dev": true + }, "es5-ext": { "version": "0.10.53", "resolved": "https://registry.npmjs.org/es5-ext/-/es5-ext-0.10.53.tgz", @@ -4894,12 +4649,6 @@ "flat-cache": "^2.0.1" } }, - "file-uri-to-path": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/file-uri-to-path/-/file-uri-to-path-1.0.0.tgz", - "integrity": "sha512-0Zt+s3L7Vf1biwWZ29aARiVYLx7iMGnEUl9x33fbB/j3jR81u/O2LbqK+Bm1CDSNDKVtJ/YjwY7TUd5SkeLQLw==", - "dev": true - }, "fill-range": { "version": "7.0.1", "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz", @@ -5246,21 +4995,6 @@ "integrity": "sha1-gQaNKVqBQuwKxybG4iAMMPttXoA=", "dev": true }, - "for-own": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/for-own/-/for-own-1.0.0.tgz", - "integrity": "sha1-xjMy9BXO3EsE2/5wz4NklMU8tEs=", - "dev": true, - "requires": { - "for-in": "^1.0.1" - } - }, - "foreach": { - "version": "2.0.5", - "resolved": "https://registry.npmjs.org/foreach/-/foreach-2.0.5.tgz", - "integrity": "sha1-C+4AUBiusmDQo6865ljdATbsG5k=", - "dev": true - }, "foreground-child": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/foreground-child/-/foreground-child-2.0.0.tgz", @@ -5404,12 +5138,6 @@ "integrity": "sha512-33X7H/wdfO99GdRLLgkjUrD4geAFdq/Uv0kl3HD4da6HDixd2GUg8Mw7dahLCV9r/EARkmtYBB6Tch4EEokFTQ==", "dev": true }, - "fs-constants": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/fs-constants/-/fs-constants-1.0.0.tgz", - "integrity": "sha512-y6OAwoSIf7FyjMIv94u+b5rdheZEjzR63GTyZJm5qh4Bi+2YgwLCcI/fPFZkL5PSixOt6ZNKm+w+Hfp/Bciwow==", - "dev": true - }, "fs-extra": { "version": "8.1.0", "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-8.1.0.tgz", @@ -5433,42 +5161,6 @@ "dev": true, "optional": true }, - "ftp": { - "version": "0.3.10", - "resolved": "https://registry.npmjs.org/ftp/-/ftp-0.3.10.tgz", - "integrity": "sha1-kZfYYa2BQvPmPVqDv+TFn3MwiF0=", - "dev": true, - "requires": { - "readable-stream": "1.1.x", - "xregexp": "2.0.0" - }, - "dependencies": { - "isarray": { - "version": "0.0.1", - "resolved": "https://registry.npmjs.org/isarray/-/isarray-0.0.1.tgz", - "integrity": "sha1-ihis/Kmo9Bd+Cav8YDiTmwXR7t8=", - "dev": true - }, - "readable-stream": { - "version": "1.1.14", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-1.1.14.tgz", - "integrity": "sha1-fPTFTvZI44EwhMY23SB54WbAgdk=", - "dev": true, - "requires": { - "core-util-is": "~1.0.0", - "inherits": "~2.0.1", - "isarray": "0.0.1", - "string_decoder": "~0.10.x" - } - }, - "string_decoder": { - "version": "0.10.31", - "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-0.10.31.tgz", - "integrity": "sha1-YuIDvEF2bGwoyfyEMB2rHFMQ+pQ=", - "dev": true - } - } - }, "function-bind": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.1.tgz", @@ -5501,67 +5193,6 @@ "pump": "^3.0.0" } }, - "get-uri": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/get-uri/-/get-uri-2.0.4.tgz", - "integrity": "sha512-v7LT/s8kVjs+Tx0ykk1I+H/rbpzkHvuIq87LmeXptcf5sNWm9uQiwjNAt94SJPA1zOlCntmnOlJvVWKmzsxG8Q==", - "dev": true, - "requires": { - "data-uri-to-buffer": "1", - "debug": "2", - "extend": "~3.0.2", - "file-uri-to-path": "1", - "ftp": "~0.3.10", - "readable-stream": "2" - }, - "dependencies": { - "debug": { - "version": "2.6.9", - "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", - "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", - "dev": true, - "requires": { - "ms": "2.0.0" - } - }, - "ms": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", - "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g=", - "dev": true - }, - "readable-stream": { - "version": "2.3.6", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.6.tgz", - "integrity": "sha512-tQtKA9WIAhBF3+VLAseyMqZeBjW0AHJoxOtYqSUZNJxauErmLbVm2FW1y+J/YA9dUrAC39ITejlZWhVIwawkKw==", - "dev": true, - "requires": { - "core-util-is": "~1.0.0", - "inherits": "~2.0.3", - "isarray": "~1.0.0", - "process-nextick-args": "~2.0.0", - "safe-buffer": "~5.1.1", - "string_decoder": "~1.1.1", - "util-deprecate": "~1.0.1" - } - }, - "safe-buffer": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz", - "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==", - "dev": true - }, - "string_decoder": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz", - "integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==", - "dev": true, - "requires": { - "safe-buffer": "~5.1.0" - } - } - } - }, "get-value": { "version": "2.0.6", "resolved": "https://registry.npmjs.org/get-value/-/get-value-2.0.6.tgz", @@ -5655,25 +5286,6 @@ } } }, - "git-up": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/git-up/-/git-up-4.0.1.tgz", - "integrity": "sha512-LFTZZrBlrCrGCG07/dm1aCjjpL1z9L3+5aEeI9SBhAqSc+kiA9Or1bgZhQFNppJX6h/f5McrvJt1mQXTFm6Qrw==", - "dev": true, - "requires": { - "is-ssh": "^1.3.0", - "parse-url": "^5.0.0" - } - }, - "git-url-parse": { - "version": "11.1.2", - "resolved": "https://registry.npmjs.org/git-url-parse/-/git-url-parse-11.1.2.tgz", - "integrity": "sha512-gZeLVGY8QVKMIkckncX+iCq2/L8PlwncvDFKiWkBn9EtCfYDbliRTTp6qzyQ1VMdITUfq7293zDzfpjdiGASSQ==", - "dev": true, - "requires": { - "git-up": "^4.0.0" - } - }, "github-slugger": { "version": "1.2.1", "resolved": "https://registry.npmjs.org/github-slugger/-/github-slugger-1.2.1.tgz", @@ -5717,6 +5329,7 @@ "resolved": "https://registry.npmjs.org/global-dirs/-/global-dirs-0.1.1.tgz", "integrity": "sha1-sxnA3UYH81PzvpzKTHL8FIxJ9EU=", "dev": true, + "optional": true, "requires": { "ini": "^1.3.4" } @@ -5767,33 +5380,6 @@ "slash": "^3.0.0" } }, - "got": { - "version": "6.7.1", - "resolved": "https://registry.npmjs.org/got/-/got-6.7.1.tgz", - "integrity": "sha1-JAzQV4WpoY5WHcG0S0HHY+8ejbA=", - "dev": true, - "requires": { - "create-error-class": "^3.0.0", - "duplexer3": "^0.1.4", - "get-stream": "^3.0.0", - "is-redirect": "^1.0.0", - "is-retry-allowed": "^1.0.0", - "is-stream": "^1.0.0", - "lowercase-keys": "^1.0.0", - "safe-buffer": "^5.0.1", - "timed-out": "^4.0.0", - "unzip-response": "^2.0.1", - "url-parse-lax": "^1.0.0" - }, - "dependencies": { - "get-stream": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-3.0.0.tgz", - "integrity": "sha1-jpQ9E1jcN1VQVOy+LtsFqhdO3hQ=", - "dev": true - } - } - }, "graceful-fs": { "version": "4.2.3", "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.3.tgz", @@ -5805,15 +5391,6 @@ "integrity": "sha1-TK+tdrxi8C+gObL5Tpo906ORpyU=", "dev": true }, - "graphlib": { - "version": "2.1.7", - "resolved": "https://registry.npmjs.org/graphlib/-/graphlib-2.1.7.tgz", - "integrity": "sha512-TyI9jIy2J4j0qgPmOOrHTCtpPqJGN/aurBwc6ZT+bRii+di1I+Wv3obRhVrmBEXet+qkMaEX67dXrwsd3QQM6w==", - "dev": true, - "requires": { - "lodash": "^4.17.5" - } - }, "growl": { "version": "1.10.5", "resolved": "https://registry.npmjs.org/growl/-/growl-1.10.5.tgz", @@ -6053,33 +5630,6 @@ } } }, - "http-proxy-agent": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/http-proxy-agent/-/http-proxy-agent-2.1.0.tgz", - "integrity": "sha512-qwHbBLV7WviBl0rQsOzH6o5lwyOIvwp/BdFnvVxXORldu5TmjFfjzBcWUWS5kWAZhmv+JtiDhSuQCp4sBfbIgg==", - "dev": true, - "requires": { - "agent-base": "4", - "debug": "3.1.0" - }, - "dependencies": { - "debug": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/debug/-/debug-3.1.0.tgz", - "integrity": "sha512-OX8XqP7/1a9cqkxYw2yXss15f26NKWBpDXQd0/uK/KPqdQhxbPa994hnzjcE2VqQpDslf55723cKPUOGSmMY3g==", - "dev": true, - "requires": { - "ms": "2.0.0" - } - }, - "ms": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", - "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g=", - "dev": true - } - } - }, "http-signature": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/http-signature/-/http-signature-1.2.0.tgz", @@ -6090,16 +5640,6 @@ "sshpk": "^1.7.0" } }, - "https-proxy-agent": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-3.0.1.tgz", - "integrity": "sha512-+ML2Rbh6DAuee7d07tYGEKOEi2voWPUGan+ExdPbPW6Z3svq+JCqr0v8WmKPOkz1vOVykPCBSuobe7G8GJUtVg==", - "dev": true, - "requires": { - "agent-base": "^4.3.0", - "debug": "^3.1.0" - } - }, "human-signals": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-1.1.1.tgz", @@ -6117,28 +5657,6 @@ "html-element": "^2.0.0" } }, - "i18n": { - "version": "0.8.4", - "resolved": "https://registry.npmjs.org/i18n/-/i18n-0.8.4.tgz", - "integrity": "sha512-PvMcG+yqYWXrwgdmCpL+APCGa8lRY0tdlo2cXp9UeR3u4h1bJGqFsgybfmG/MqtL1iDmdaPPPLJebXGrZ1XoMQ==", - "dev": true, - "requires": { - "debug": "*", - "make-plural": "^6.0.1", - "math-interval-parser": "^2.0.1", - "messageformat": "^2.3.0", - "mustache": "*", - "sprintf-js": "^1.1.2" - }, - "dependencies": { - "sprintf-js": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.1.2.tgz", - "integrity": "sha512-VE0SOVEHCk7Qc8ulkWw3ntAzXuqf7S2lvwQaDLRnUeIEaKNQJzV6BwmLKhOqT61aGhfUMrXeaBk+oDGCzvhcug==", - "dev": true - } - } - }, "iconv-lite": { "version": "0.4.24", "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.24.tgz", @@ -6162,12 +5680,6 @@ "minimatch": "^3.0.4" } }, - "immediate": { - "version": "3.0.6", - "resolved": "https://registry.npmjs.org/immediate/-/immediate-3.0.6.tgz", - "integrity": "sha1-nbHb0Pr43m++D13V5Wu2BigN5ps=", - "dev": true - }, "import-fresh": { "version": "3.2.1", "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.2.1.tgz", @@ -6195,12 +5707,6 @@ "resolve-from": "^5.0.0" } }, - "import-lazy": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/import-lazy/-/import-lazy-2.1.0.tgz", - "integrity": "sha1-BWmOPUXIjo1+nZLLBYTnfwlvPkM=", - "dev": true - }, "imurmurhash": { "version": "0.1.4", "resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz", @@ -6240,27 +5746,6 @@ "integrity": "sha512-RZY5huIKCMRWDUqZlEi72f/lmXKMvuszcMBduliQ3nnWbx9X/ZBQO7DijMEYS9EhHBb2qacRUMtC7svLwe0lcw==", "dev": true }, - "inquirer": { - "version": "6.5.2", - "resolved": "https://registry.npmjs.org/inquirer/-/inquirer-6.5.2.tgz", - "integrity": "sha512-cntlB5ghuB0iuO65Ovoi8ogLHiWGs/5yNrtUcKjFhSSiVeAIVpD7koaSU9RM8mpXw5YDi9RdYXGQMaOURB7ycQ==", - "dev": true, - "requires": { - "ansi-escapes": "^3.2.0", - "chalk": "^2.4.2", - "cli-cursor": "^2.1.0", - "cli-width": "^2.0.0", - "external-editor": "^3.0.3", - "figures": "^2.0.0", - "lodash": "^4.17.12", - "mute-stream": "0.0.7", - "run-async": "^2.2.0", - "rxjs": "^6.4.0", - "string-width": "^2.1.0", - "strip-ansi": "^5.1.0", - "through": "^2.3.6" - } - }, "interpret": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/interpret/-/interpret-1.2.0.tgz", @@ -6277,18 +5762,6 @@ "p-is-promise": "^3.0.0" } }, - "invert-kv": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/invert-kv/-/invert-kv-1.0.0.tgz", - "integrity": "sha1-EEqOSqym09jNFXqO+L+rLXo//bY=", - "dev": true - }, - "ip": { - "version": "1.1.5", - "resolved": "https://registry.npmjs.org/ip/-/ip-1.1.5.tgz", - "integrity": "sha1-vd7XARQpCCjAoDnnLvJfWq7ENUo=", - "dev": true - }, "ip-regex": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/ip-regex/-/ip-regex-2.1.0.tgz", @@ -6320,6 +5793,12 @@ "resolved": "https://registry.npmjs.org/is-alphabetical/-/is-alphabetical-1.0.3.tgz", "integrity": "sha512-eEMa6MKpHFzw38eKm56iNNi6GJ7lf6aLLio7Kr23sJPAECscgRtZvOBYybejWDQ2bM949Y++61PY+udzj5QMLA==" }, + "is-alphanumeric": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-alphanumeric/-/is-alphanumeric-1.0.0.tgz", + "integrity": "sha1-Spzvcdr0wAHB2B1j0UDPU/1oifQ=", + "dev": true + }, "is-alphanumerical": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/is-alphanumerical/-/is-alphanumerical-1.0.3.tgz", @@ -6354,15 +5833,6 @@ "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.1.4.tgz", "integrity": "sha512-r5p9sxJjYnArLjObpjA4xu5EKI3CuKHkJXMhT7kwbpUyIFD1n5PMAsoPvWnvtZiNz7LjkYDRZhd7FlI0eMijEA==" }, - "is-ci": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/is-ci/-/is-ci-1.2.1.tgz", - "integrity": "sha512-s6tfsaQaQi3JNciBH6shVqEDvhGut0SUXr31ag8Pd8BBbVVlcGfWhpPmEOoM6RJ5TFhbypvf5yyRw/VXW1IiWg==", - "dev": true, - "requires": { - "ci-info": "^1.5.0" - } - }, "is-data-descriptor": { "version": "0.1.4", "resolved": "https://registry.npmjs.org/is-data-descriptor/-/is-data-descriptor-0.1.4.tgz", @@ -6445,22 +5915,6 @@ "resolved": "https://registry.npmjs.org/is-hexadecimal/-/is-hexadecimal-1.0.3.tgz", "integrity": "sha512-zxQ9//Q3D/34poZf8fiy3m3XVpbQc7ren15iKqrTtLPwkPD/t3Scy9Imp63FujULGxuK0ZlCwoo5xNpktFgbOA==" }, - "is-installed-globally": { - "version": "0.1.0", - "resolved": "https://registry.npmjs.org/is-installed-globally/-/is-installed-globally-0.1.0.tgz", - "integrity": "sha1-Df2Y9akRFxbdU13aZJL2e/PSWoA=", - "dev": true, - "requires": { - "global-dirs": "^0.1.0", - "is-path-inside": "^1.0.0" - } - }, - "is-npm": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-npm/-/is-npm-1.0.0.tgz", - "integrity": "sha1-8vtjpl5JBbQGyGBydloaTceTufQ=", - "dev": true - }, "is-number": { "version": "7.0.0", "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", @@ -6487,15 +5941,6 @@ "integrity": "sha512-w942bTcih8fdJPJmQHFzkS76NEP8Kzzvmw92cXsazb8intwLqPibPPdXf4ANdKV3rYMuuQYGIWtvz9JilB3NFQ==", "dev": true }, - "is-path-inside": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/is-path-inside/-/is-path-inside-1.0.1.tgz", - "integrity": "sha1-jvW33lBDej/cprToZe96pVy0gDY=", - "dev": true, - "requires": { - "path-is-inside": "^1.0.1" - } - }, "is-plain-obj": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/is-plain-obj/-/is-plain-obj-2.0.0.tgz", @@ -6516,12 +5961,6 @@ "integrity": "sha1-eaKp7OfwlugPNtKy87wWwf9L8/o=", "dev": true }, - "is-redirect": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-redirect/-/is-redirect-1.0.0.tgz", - "integrity": "sha1-HQPd7VO9jbDzDCbk+V02/HyH3CQ=", - "dev": true - }, "is-regex": { "version": "1.0.4", "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.0.4.tgz", @@ -6536,21 +5975,6 @@ "integrity": "sha1-/S2INUXEa6xaYz57mgnof6LLUGk=", "dev": true }, - "is-retry-allowed": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/is-retry-allowed/-/is-retry-allowed-1.2.0.tgz", - "integrity": "sha512-RUbUeKwvm3XG2VYamhJL1xFktgjvPzL0Hq8C+6yrWIswDy3BIXGqCxhxkc30N9jqK311gVU137K8Ei55/zVJRg==", - "dev": true - }, - "is-ssh": { - "version": "1.3.1", - "resolved": "https://registry.npmjs.org/is-ssh/-/is-ssh-1.3.1.tgz", - "integrity": "sha512-0eRIASHZt1E68/ixClI8bp2YK2wmBPVWEismTs6M+M099jKgrzl/3E976zIbImSIob48N2/XGe9y7ZiYdImSlg==", - "dev": true, - "requires": { - "protocols": "^1.1.0" - } - }, "is-stream": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-1.1.0.tgz", @@ -6606,12 +6030,6 @@ "resolved": "https://registry.npmjs.org/is-word-character/-/is-word-character-1.0.3.tgz", "integrity": "sha512-0wfcrFgOOOBdgRNT9H33xe6Zi6yhX/uoc4U8NBZGeQQB0ctU1dnlNTyL9JM2646bHDTpsDm1Brb3VPoCIMrd/A==" }, - "is-wsl": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/is-wsl/-/is-wsl-1.1.0.tgz", - "integrity": "sha1-HxbkqiKwTRM2tmGIpmrzxgDDpm0=", - "dev": true - }, "isarray": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz", @@ -6831,25 +6249,6 @@ "istanbul-lib-report": "^3.0.0" } }, - "jasmine-reporters": { - "version": "2.3.2", - "resolved": "https://registry.npmjs.org/jasmine-reporters/-/jasmine-reporters-2.3.2.tgz", - "integrity": "sha512-u/7AT9SkuZsUfFBLLzbErohTGNsEUCKaQbsVYnLFW1gEuL2DzmBL4n8v90uZsqIqlWvWUgian8J6yOt5Fyk/+A==", - "dev": true, - "requires": { - "mkdirp": "^0.5.1", - "xmldom": "^0.1.22" - } - }, - "jasmine-xml-reporter": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/jasmine-xml-reporter/-/jasmine-xml-reporter-1.2.1.tgz", - "integrity": "sha1-fKoqUYAv7+2+JLPqinrUJ8nqfbM=", - "dev": true, - "requires": { - "jasmine-reporters": "^2.2.0" - } - }, "java-properties": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/java-properties/-/java-properties-1.0.2.tgz", @@ -6921,15 +6320,6 @@ "integrity": "sha512-mrqyZKfX5EhL7hvqcV6WG1yYjnjeuYDzDhhcAAUrq8Po85NBQBJP+ZDUT75qZQ98IkUoBqdkExkukOU7Ts2wrw==", "dev": true }, - "json-pointer": { - "version": "0.6.0", - "resolved": "https://registry.npmjs.org/json-pointer/-/json-pointer-0.6.0.tgz", - "integrity": "sha1-jlAFUKaqxUZKRzN32leqbMIoKNc=", - "dev": true, - "requires": { - "foreach": "^2.0.4" - } - }, "json-schema": { "version": "0.2.3", "resolved": "https://registry.npmjs.org/json-schema/-/json-schema-0.2.3.tgz", @@ -7015,50 +6405,6 @@ "verror": "1.10.0" } }, - "jszip": { - "version": "3.2.2", - "resolved": "https://registry.npmjs.org/jszip/-/jszip-3.2.2.tgz", - "integrity": "sha512-NmKajvAFQpbg3taXQXr/ccS2wcucR1AZ+NtyWp2Nq7HHVsXhcJFR8p0Baf32C2yVvBylFWVeKf+WI2AnvlPhpA==", - "dev": true, - "requires": { - "lie": "~3.3.0", - "pako": "~1.0.2", - "readable-stream": "~2.3.6", - "set-immediate-shim": "~1.0.1" - }, - "dependencies": { - "readable-stream": { - "version": "2.3.6", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.6.tgz", - "integrity": "sha512-tQtKA9WIAhBF3+VLAseyMqZeBjW0AHJoxOtYqSUZNJxauErmLbVm2FW1y+J/YA9dUrAC39ITejlZWhVIwawkKw==", - "dev": true, - "requires": { - "core-util-is": "~1.0.0", - "inherits": "~2.0.3", - "isarray": "~1.0.0", - "process-nextick-args": "~2.0.0", - "safe-buffer": "~5.1.1", - "string_decoder": "~1.1.1", - "util-deprecate": "~1.0.1" - } - }, - "safe-buffer": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz", - "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==", - "dev": true - }, - "string_decoder": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz", - "integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==", - "dev": true, - "requires": { - "safe-buffer": "~5.1.0" - } - } - } - }, "just-extend": { "version": "4.0.2", "resolved": "https://registry.npmjs.org/just-extend/-/just-extend-4.0.2.tgz", @@ -7082,30 +6428,6 @@ "colornames": "^1.1.1" } }, - "latest-version": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/latest-version/-/latest-version-3.1.0.tgz", - "integrity": "sha1-ogU4P+oyKzO1rjsYq+4NwvNW7hU=", - "dev": true, - "requires": { - "package-json": "^4.0.0" - } - }, - "lazy-cache": { - "version": "0.2.7", - "resolved": "https://registry.npmjs.org/lazy-cache/-/lazy-cache-0.2.7.tgz", - "integrity": "sha1-f+3fLctu23fRHvHRF6tf/fCrG2U=", - "dev": true - }, - "lcid": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/lcid/-/lcid-1.0.0.tgz", - "integrity": "sha1-MIrMr6C8SDo4Z7S28rlQYlHRuDU=", - "dev": true, - "requires": { - "invert-kv": "^1.0.0" - } - }, "levn": { "version": "0.3.0", "resolved": "https://registry.npmjs.org/levn/-/levn-0.3.0.tgz", @@ -7115,15 +6437,6 @@ "type-check": "~0.3.2" } }, - "lie": { - "version": "3.3.0", - "resolved": "https://registry.npmjs.org/lie/-/lie-3.3.0.tgz", - "integrity": "sha512-UaiMJzeWRlEujzAuw5LokY1L5ecNQYZKfmyZ9L7wDHb/p5etKaxXhohBcrw0EYby+G/NA52vRSN4N39dxHAIwQ==", - "dev": true, - "requires": { - "immediate": "~3.0.5" - } - }, "lines-and-columns": { "version": "1.1.6", "resolved": "https://registry.npmjs.org/lines-and-columns/-/lines-and-columns-1.1.6.tgz", @@ -7452,18 +6765,6 @@ "integrity": "sha1-zkKt4IOE711i+nfDD2GkbmhvhDQ=", "dev": true }, - "lodash.assign": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/lodash.assign/-/lodash.assign-4.2.0.tgz", - "integrity": "sha1-DZnzzNem0mHRm9rrkkUAXShYCOc=", - "dev": true - }, - "lodash.assignin": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/lodash.assignin/-/lodash.assignin-4.2.0.tgz", - "integrity": "sha1-uo31+4QesKPoBEIysOJjqNxqKKI=", - "dev": true - }, "lodash.capitalize": { "version": "4.2.1", "resolved": "https://registry.npmjs.org/lodash.capitalize/-/lodash.capitalize-4.2.1.tgz", @@ -7476,24 +6777,12 @@ "integrity": "sha1-GVhwRQ9aExkkeN9Lw9I9LeoZB7Y=", "dev": true }, - "lodash.clonedeep": { - "version": "4.5.0", - "resolved": "https://registry.npmjs.org/lodash.clonedeep/-/lodash.clonedeep-4.5.0.tgz", - "integrity": "sha1-4j8/nE+Pvd6HJSnBBxhXoIblzO8=", - "dev": true - }, "lodash.escaperegexp": { "version": "4.1.2", "resolved": "https://registry.npmjs.org/lodash.escaperegexp/-/lodash.escaperegexp-4.1.2.tgz", "integrity": "sha1-ZHYsSGGAglGKw99Mz11YhtriA0c=", "dev": true }, - "lodash.flatten": { - "version": "4.4.0", - "resolved": "https://registry.npmjs.org/lodash.flatten/-/lodash.flatten-4.4.0.tgz", - "integrity": "sha1-8xwiIlqWMtK7+OSt2+8kCqdlph8=", - "dev": true - }, "lodash.flattendeep": { "version": "4.4.0", "resolved": "https://registry.npmjs.org/lodash.flattendeep/-/lodash.flattendeep-4.4.0.tgz", @@ -7626,6 +6915,12 @@ "integrity": "sha1-eB4YMpaqlPbU2RbcM10NF676I/g=", "dev": true }, + "longest-streak": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/longest-streak/-/longest-streak-2.0.3.tgz", + "integrity": "sha512-9lz5IVdpwsKLMzQi0MQ+oD9EA0mIGcWYP7jXMTZVXP8D42PwuAk+M/HBFYQoxt1G5OR8m7aSIgb1UymfWGBWEw==", + "dev": true + }, "loud-rejection": { "version": "1.6.0", "resolved": "https://registry.npmjs.org/loud-rejection/-/loud-rejection-1.6.0.tgz", @@ -7636,12 +6931,6 @@ "signal-exit": "^3.0.0" } }, - "lowercase-keys": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/lowercase-keys/-/lowercase-keys-1.0.1.tgz", - "integrity": "sha512-G2Lj61tXDnVFFOi8VZds+SoQjtQC3dgokKdDG2mTm1tx4m50NUHBOZSBwQQHyy0V12A0JTG4icfZQH+xPyh8VA==", - "dev": true - }, "lru-cache": { "version": "5.1.1", "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-5.1.1.tgz", @@ -7666,21 +6955,6 @@ "integrity": "sha512-OHhSbtcviqMPt7yfw5ef5aghS2jzFVKEFyCJndQt2YpSQ9qRVSEv2axSJI1paVThEu+FFGs584h/1YhxjVqajA==", "dev": true }, - "make-dir": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-1.3.0.tgz", - "integrity": "sha512-2w31R7SJtieJJnQtGc7RVL2StM2vGYVfqUOvUDxH6bC6aJTxPxTF0GnIgCyu7tjockiUWAYQRbxa7vKn34s5sQ==", - "dev": true, - "requires": { - "pify": "^3.0.0" - } - }, - "make-plural": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/make-plural/-/make-plural-6.0.1.tgz", - "integrity": "sha512-h0uBNi4tpDkiWUyYKrJNj8Kif6q3Ba5zp/8jnfPy3pQE+4XcTj6h3eZM5SYVUyDNX9Zk69Isr/dx0I+78aJUaQ==", - "dev": true - }, "manage-path": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/manage-path/-/manage-path-2.0.0.tgz", @@ -7713,6 +6987,12 @@ "resolved": "https://registry.npmjs.org/markdown-escapes/-/markdown-escapes-1.0.3.tgz", "integrity": "sha512-XUi5HJhhV5R74k8/0H2oCbCiYf/u4cO/rX8tnGkRvrqhsr5BRNU6Mg0yt/8UIx1iIS8220BNJsDb7XnILhLepw==" }, + "markdown-table": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/markdown-table/-/markdown-table-1.1.3.tgz", + "integrity": "sha512-1RUZVgQlpJSPWYbFSpmudq5nHY1doEIv89gBtF0s4gW1GF2XorxcA/70M5vq7rLv0a6mhOUccRsqkwhwLCIQ2Q==", + "dev": true + }, "marked": { "version": "0.8.0", "resolved": "https://registry.npmjs.org/marked/-/marked-0.8.0.tgz", @@ -7741,12 +7021,6 @@ "@arr/every": "^1.0.0" } }, - "math-interval-parser": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/math-interval-parser/-/math-interval-parser-2.0.1.tgz", - "integrity": "sha512-VmlAmb0UJwlvMyx8iPhXUDnVW1F9IrGEd9CIOmv+XL8AErCUUuozoDMrgImvnYt2A+53qVX/tPW6YJurMKYsvA==", - "dev": true - }, "md5": { "version": "2.2.1", "resolved": "https://registry.npmjs.org/md5/-/md5-2.2.1.tgz", @@ -7758,6 +7032,35 @@ "is-buffer": "~1.1.1" } }, + "mdast-builder": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/mdast-builder/-/mdast-builder-1.1.1.tgz", + "integrity": "sha512-a3KBk/LmYD6wKsWi8WJrGU/rXR4yuF4Men0JO0z6dSZCm5FrXXWTRDjqK0vGSqa+1M6p9edeuypZAZAzSehTUw==", + "dev": true, + "requires": { + "@types/unist": "^2.0.3" + } + }, + "mdast-util-compact": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/mdast-util-compact/-/mdast-util-compact-1.0.4.tgz", + "integrity": "sha512-3YDMQHI5vRiS2uygEFYaqckibpJtKq5Sj2c8JioeOQBU6INpKbdWzfyLqFFnDwEcEnRFIdMsguzs5pC1Jp4Isg==", + "dev": true, + "requires": { + "unist-util-visit": "^1.1.0" + }, + "dependencies": { + "unist-util-visit": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/unist-util-visit/-/unist-util-visit-1.4.1.tgz", + "integrity": "sha512-AvGNk7Bb//EmJZyhtRUnNMEpId/AZ5Ph/KUpTI09WHQuDZHKovQ1oEv3mfmKpWKtoMzyMC4GLBm1Zy5k12fjIw==", + "dev": true, + "requires": { + "unist-util-visit-parents": "^2.0.0" + } + } + } + }, "mdast-util-definitions": { "version": "1.2.5", "resolved": "https://registry.npmjs.org/mdast-util-definitions/-/mdast-util-definitions-1.2.5.tgz", @@ -7930,40 +7233,6 @@ "integrity": "sha512-2j4DAdlBOkiSZIsaXk4mTE3sRS02yBHAtfy127xRV3bQUFqXkjHCHLW6Scv7DwNRbIWNHH8zpnz9zMaKXIdvYw==", "dev": true }, - "messageformat": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/messageformat/-/messageformat-2.3.0.tgz", - "integrity": "sha512-uTzvsv0lTeQxYI2y1NPa1lItL5VRI8Gb93Y2K2ue5gBPyrbJxfDi/EYWxh2PKv5yO42AJeeqblS9MJSh/IEk4w==", - "dev": true, - "requires": { - "make-plural": "^4.3.0", - "messageformat-formatters": "^2.0.1", - "messageformat-parser": "^4.1.2" - }, - "dependencies": { - "make-plural": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/make-plural/-/make-plural-4.3.0.tgz", - "integrity": "sha512-xTYd4JVHpSCW+aqDof6w/MebaMVNTVYBZhbB/vi513xXdiPT92JMVCo0Jq8W2UZnzYRFeVbQiQ+I25l13JuKvA==", - "dev": true, - "requires": { - "minimist": "^1.2.0" - } - } - } - }, - "messageformat-formatters": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/messageformat-formatters/-/messageformat-formatters-2.0.1.tgz", - "integrity": "sha512-E/lQRXhtHwGuiQjI7qxkLp8AHbMD5r2217XNe/SREbBlSawe0lOqsFb7rflZJmlQFSULNLIqlcjjsCPlB3m3Mg==", - "dev": true - }, - "messageformat-parser": { - "version": "4.1.2", - "resolved": "https://registry.npmjs.org/messageformat-parser/-/messageformat-parser-4.1.2.tgz", - "integrity": "sha512-7dWuifeyldz7vhEuL96Kwq1fhZXBW+TUfbnHN4UCrCxoXQTYjHnR78eI66Gk9LaLLsAvzPNVJBaa66DRfFNaiA==", - "dev": true - }, "methods": { "version": "1.1.2", "resolved": "https://registry.npmjs.org/methods/-/methods-1.1.2.tgz", @@ -8058,24 +7327,6 @@ } } }, - "mixin-object": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/mixin-object/-/mixin-object-2.0.1.tgz", - "integrity": "sha1-T7lJRB2rGCVA8f4DW6YOGUel5X4=", - "dev": true, - "requires": { - "for-in": "^0.1.3", - "is-extendable": "^0.1.1" - }, - "dependencies": { - "for-in": { - "version": "0.1.8", - "resolved": "https://registry.npmjs.org/for-in/-/for-in-0.1.8.tgz", - "integrity": "sha1-2Hc5COMSVhCZUrH9ubP6hn0ndeE=", - "dev": true - } - } - }, "mkdirp": { "version": "0.5.1", "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-0.5.1.tgz", @@ -8340,12 +7591,6 @@ "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==" }, - "mustache": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/mustache/-/mustache-3.1.0.tgz", - "integrity": "sha512-3Bxq1R5LBZp7fbFPZzFe5WN4s0q3+gxZaZuZVY+QctYJiCiVgXHOTIC0/HgZuOPFt/6BQcx5u0H2CUOxT/RoGQ==", - "dev": true - }, "mute-stream": { "version": "0.0.7", "resolved": "https://registry.npmjs.org/mute-stream/-/mute-stream-0.0.7.tgz", @@ -8396,37 +7641,6 @@ "integrity": "sha1-Sr6/7tdUHywnrPspvbvRXI1bpPc=", "dev": true }, - "nconf": { - "version": "0.10.0", - "resolved": "https://registry.npmjs.org/nconf/-/nconf-0.10.0.tgz", - "integrity": "sha512-fKiXMQrpP7CYWJQzKkPPx9hPgmq+YLDyxcG9N8RpiE9FoCkCbzD0NyW0YhE3xn3Aupe7nnDeIx4PFzYehpHT9Q==", - "dev": true, - "requires": { - "async": "^1.4.0", - "ini": "^1.3.0", - "secure-keys": "^1.0.0", - "yargs": "^3.19.0" - }, - "dependencies": { - "async": { - "version": "1.5.2", - "resolved": "https://registry.npmjs.org/async/-/async-1.5.2.tgz", - "integrity": "sha1-7GphrlZIDAw8skHJVhjiCJL5Zyo=", - "dev": true - } - } - }, - "needle": { - "version": "2.4.0", - "resolved": "https://registry.npmjs.org/needle/-/needle-2.4.0.tgz", - "integrity": "sha512-4Hnwzr3mi5L97hMYeNl8wRW/Onhy4nUKR/lVemJ8gJedxxUyBLm9kkrDColJvoSfwi0jCNhD+xCdOtiGDQiRZg==", - "dev": true, - "requires": { - "debug": "^3.2.6", - "iconv-lite": "^0.4.4", - "sax": "^1.2.4" - } - }, "negotiator": { "version": "0.6.2", "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-0.6.2.tgz", @@ -8445,12 +7659,6 @@ "integrity": "sha1-5tq3/r9a2Bbqgc9cYpxaDr3nLBo=", "dev": true }, - "netmask": { - "version": "1.0.6", - "resolved": "https://registry.npmjs.org/netmask/-/netmask-1.0.6.tgz", - "integrity": "sha1-ICl+idhvb2QA8lDZ9Pa0wZRfzTU=", - "dev": true - }, "next-tick": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/next-tick/-/next-tick-1.0.0.tgz", @@ -8597,12 +7805,6 @@ "integrity": "sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==", "dev": true }, - "normalize-url": { - "version": "3.3.0", - "resolved": "https://registry.npmjs.org/normalize-url/-/normalize-url-3.3.0.tgz", - "integrity": "sha512-U+JJi7duF1o+u2pynbp2zXDW2/PADgC30f0GsHZtRh+HOcXHnw137TrNlyxxRvWW5fjKd3bcLHPxofWuCjaeZg==", - "dev": true - }, "not": { "version": "0.1.0", "resolved": "https://registry.npmjs.org/not/-/not-0.1.0.tgz", @@ -12592,15 +11794,6 @@ "format-util": "^1.0.3" } }, - "opn": { - "version": "5.5.0", - "resolved": "https://registry.npmjs.org/opn/-/opn-5.5.0.tgz", - "integrity": "sha512-PqHpggC9bLV0VeWcdKhkpxY+3JTzetLSqTCWL/z/tFIbI6G8JCjondXklT1JinczLz2Xib62sSp0T/gKT4KksA==", - "dev": true, - "requires": { - "is-wsl": "^1.1.0" - } - }, "opt-cli": { "version": "1.5.1", "resolved": "https://registry.npmjs.org/opt-cli/-/opt-cli-1.5.1.tgz", @@ -12670,15 +11863,6 @@ "word-wrap": "~1.2.3" } }, - "os-locale": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/os-locale/-/os-locale-1.4.0.tgz", - "integrity": "sha1-IPnxeuKe00XoveWDsT0gCYA8FNk=", - "dev": true, - "requires": { - "lcid": "^1.0.0" - } - }, "os-name": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/os-name/-/os-name-3.1.0.tgz", @@ -12768,50 +11952,10 @@ "integrity": "sha1-y8ec26+P1CKOE/Yh8rGiN8GyB7M=", "dev": true }, - "pac-proxy-agent": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/pac-proxy-agent/-/pac-proxy-agent-3.0.1.tgz", - "integrity": "sha512-44DUg21G/liUZ48dJpUSjZnFfZro/0K5JTyFYLBcmh9+T6Ooi4/i4efwUiEy0+4oQusCBqWdhv16XohIj1GqnQ==", - "dev": true, - "requires": { - "agent-base": "^4.2.0", - "debug": "^4.1.1", - "get-uri": "^2.0.0", - "http-proxy-agent": "^2.1.0", - "https-proxy-agent": "^3.0.0", - "pac-resolver": "^3.0.0", - "raw-body": "^2.2.0", - "socks-proxy-agent": "^4.0.1" - }, - "dependencies": { - "debug": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.1.1.tgz", - "integrity": "sha512-pYAIzeRo8J6KPEaJ0VWOh5Pzkbw/RetuzehGM7QRRX5he4fPHx2rdKMB256ehJCkX+XRQm16eZLqLNS8RSZXZw==", - "dev": true, - "requires": { - "ms": "^2.1.1" - } - } - } - }, - "pac-resolver": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/pac-resolver/-/pac-resolver-3.0.0.tgz", - "integrity": "sha512-tcc38bsjuE3XZ5+4vP96OfhOugrX+JcnpUbhfuc4LuXBLQhoTthOstZeoQJBDnQUDYzYmdImKsbz0xSl1/9qeA==", - "dev": true, - "requires": { - "co": "^4.6.0", - "degenerator": "^1.0.4", - "ip": "^1.1.5", - "netmask": "^1.0.6", - "thunkify": "^2.1.2" - } - }, - "package-hash": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/package-hash/-/package-hash-4.0.0.tgz", - "integrity": "sha512-whdkPIooSu/bASggZ96BWVvZTRMOFxnyUG5PnTSGKoJE2gd5mbVNmR2Nj20QFzxYYgAXpoqC+AiXzl+UMRh7zQ==", + "package-hash": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/package-hash/-/package-hash-4.0.0.tgz", + "integrity": "sha512-whdkPIooSu/bASggZ96BWVvZTRMOFxnyUG5PnTSGKoJE2gd5mbVNmR2Nj20QFzxYYgAXpoqC+AiXzl+UMRh7zQ==", "dev": true, "requires": { "graceful-fs": "^4.1.15", @@ -12820,32 +11964,6 @@ "release-zalgo": "^1.0.0" } }, - "package-json": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/package-json/-/package-json-4.0.1.tgz", - "integrity": "sha1-iGmgQBJTZhxMTKPabCEh7VVfXu0=", - "dev": true, - "requires": { - "got": "^6.7.1", - "registry-auth-token": "^3.0.1", - "registry-url": "^3.0.3", - "semver": "^5.1.0" - }, - "dependencies": { - "semver": { - "version": "5.7.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-5.7.1.tgz", - "integrity": "sha512-sauaDf/PZdVgrLTNYHRtpXa1iRiKcaebiKQ1BJdpQlWH2lCvexQdX55snPFyK7QzpudqbCI0qXFfOasHdyNDGQ==", - "dev": true - } - } - }, - "pako": { - "version": "1.0.10", - "resolved": "https://registry.npmjs.org/pako/-/pako-1.0.10.tgz", - "integrity": "sha512-0DTvPVU3ed8+HNXOu5Bs+o//Mbdj9VNQMUOe9oKCwh8l0GNwpTDMKCWbRjgtD291AWnkAgkqA/LOnQS8AmS1tw==", - "dev": true - }, "parent-module": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz", @@ -12894,28 +12012,6 @@ "integrity": "sha1-bVuTSkVpk7I9N/QKOC1vFmao5cY=", "dev": true }, - "parse-path": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/parse-path/-/parse-path-4.0.1.tgz", - "integrity": "sha512-d7yhga0Oc+PwNXDvQ0Jv1BuWkLVPXcAoQ/WREgd6vNNoKYaW52KI+RdOFjI63wjkmps9yUE8VS4veP+AgpQ/hA==", - "dev": true, - "requires": { - "is-ssh": "^1.3.0", - "protocols": "^1.4.0" - } - }, - "parse-url": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/parse-url/-/parse-url-5.0.1.tgz", - "integrity": "sha512-flNUPP27r3vJpROi0/R3/2efgKkyXqnXwyP1KQ2U0SfFRgdizOdWfvrrvJg1LuOoxs7GQhmxJlq23IpQ/BkByg==", - "dev": true, - "requires": { - "is-ssh": "^1.3.0", - "normalize-url": "^3.3.0", - "parse-path": "^4.0.0", - "protocols": "^1.4.0" - } - }, "parse5": { "version": "5.1.0", "resolved": "https://registry.npmjs.org/parse5/-/parse5-5.1.0.tgz", @@ -12945,12 +12041,6 @@ "integrity": "sha1-F0uSaHNVNP+8es5r9TpanhtcX18=", "dev": true }, - "path-is-inside": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/path-is-inside/-/path-is-inside-1.0.2.tgz", - "integrity": "sha1-NlQX3t5EQw0cEa9hAn+s8HS9/FM=", - "dev": true - }, "path-key": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/path-key/-/path-key-2.0.1.tgz", @@ -13072,12 +12162,6 @@ "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.1.2.tgz", "integrity": "sha1-IZMqVJ9eUv/ZqCf1cOBL5iqX2lQ=" }, - "prepend-http": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/prepend-http/-/prepend-http-1.0.4.tgz", - "integrity": "sha1-1PRWKwzjaW5BrFLQ4ALlemNdxtw=", - "dev": true - }, "prettier": { "version": "1.19.1", "resolved": "https://registry.npmjs.org/prettier/-/prettier-1.19.1.tgz", @@ -13104,15 +12188,6 @@ "integrity": "sha512-7PiHtLll5LdnKIMw100I+8xJXR5gW2QwWYkT6iJva0bXitZKa/XMrSbdmg3r2Xnaidz9Qumd0VPaMrZlF9V9sA==", "dev": true }, - "promise": { - "version": "7.3.1", - "resolved": "https://registry.npmjs.org/promise/-/promise-7.3.1.tgz", - "integrity": "sha512-nolQXZ/4L+bP/UGlkfaIujX9BKxGwmQ9OT4mOt5yvy8iK1h3wqTEJCijzGANTCCl9nWjY41juyAn2K3Q1hLLTg==", - "dev": true, - "requires": { - "asap": "~2.0.3" - } - }, "propagate": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/propagate/-/propagate-2.0.1.tgz", @@ -13127,12 +12202,6 @@ "xtend": "^4.0.1" } }, - "protocols": { - "version": "1.4.7", - "resolved": "https://registry.npmjs.org/protocols/-/protocols-1.4.7.tgz", - "integrity": "sha512-Fx65lf9/YDn3hUX08XUc0J8rSux36rEsyiv21ZGUC1mOyeM3lTRpZLcrm8aAolzS4itwVfm7TAPyxC2E5zd6xg==", - "dev": true - }, "proxy-addr": { "version": "2.0.5", "resolved": "https://registry.npmjs.org/proxy-addr/-/proxy-addr-2.0.5.tgz", @@ -13143,45 +12212,6 @@ "ipaddr.js": "1.9.0" } }, - "proxy-agent": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/proxy-agent/-/proxy-agent-3.1.1.tgz", - "integrity": "sha512-WudaR0eTsDx33O3EJE16PjBRZWcX8GqCEeERw1W3hZJgH/F2a46g7jty6UGty6NeJ4CKQy8ds2CJPMiyeqaTvw==", - "dev": true, - "requires": { - "agent-base": "^4.2.0", - "debug": "4", - "http-proxy-agent": "^2.1.0", - "https-proxy-agent": "^3.0.0", - "lru-cache": "^5.1.1", - "pac-proxy-agent": "^3.0.1", - "proxy-from-env": "^1.0.0", - "socks-proxy-agent": "^4.0.1" - }, - "dependencies": { - "debug": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.1.1.tgz", - "integrity": "sha512-pYAIzeRo8J6KPEaJ0VWOh5Pzkbw/RetuzehGM7QRRX5he4fPHx2rdKMB256ehJCkX+XRQm16eZLqLNS8RSZXZw==", - "dev": true, - "requires": { - "ms": "^2.1.1" - } - } - } - }, - "proxy-from-env": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/proxy-from-env/-/proxy-from-env-1.0.0.tgz", - "integrity": "sha1-M8UDmPcOp+uW0h97gXYwpVeRx+4=", - "dev": true - }, - "pseudomap": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/pseudomap/-/pseudomap-1.0.2.tgz", - "integrity": "sha1-8FKijacOYYkX7wqKw0wa5aaChrM=", - "dev": true - }, "psl": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/psl/-/psl-1.4.0.tgz", @@ -13230,18 +12260,6 @@ "integrity": "sha512-Hrgsx+orqoygnmhFbKaHE6c296J+HTAQXoxEF6gNupROmmGJRoyzfG3ccAveqCBrwr/2yxQ5BVd/GTl5agOwSg==", "dev": true }, - "raw-body": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/raw-body/-/raw-body-2.4.1.tgz", - "integrity": "sha512-9WmIKF6mkvA0SLmA2Knm9+qj89e+j1zqgyn8aXGd7+nAduPoqgI9lO57SAZNn/Byzo5P7JhXTyg9PzaJbH73bA==", - "dev": true, - "requires": { - "bytes": "3.1.0", - "http-errors": "1.7.3", - "iconv-lite": "0.4.24", - "unpipe": "1.0.0" - } - }, "rc": { "version": "1.2.8", "resolved": "https://registry.npmjs.org/rc/-/rc-1.2.8.tgz", @@ -13368,25 +12386,6 @@ "integrity": "sha512-lv0M6+TkDVniA3aD1Eg0DVpfU/booSu7Eev3TDO/mZKHBfVjgCGTV4t4buppESEYDtkArYFOxTJWv6S5C+iaNw==", "dev": true }, - "registry-auth-token": { - "version": "3.4.0", - "resolved": "https://registry.npmjs.org/registry-auth-token/-/registry-auth-token-3.4.0.tgz", - "integrity": "sha512-4LM6Fw8eBQdwMYcES4yTnn2TqIasbXuwDx3um+QRs7S55aMKCBKBxvPXl2RiUjHwuJLTyYfxSpmfSAjQpcuP+A==", - "dev": true, - "requires": { - "rc": "^1.1.6", - "safe-buffer": "^5.0.1" - } - }, - "registry-url": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/registry-url/-/registry-url-3.1.0.tgz", - "integrity": "sha1-PU74cPc93h138M+aOBQyRE4XSUI=", - "dev": true, - "requires": { - "rc": "^1.0.1" - } - }, "release-zalgo": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/release-zalgo/-/release-zalgo-1.0.0.tgz", @@ -13436,6 +12435,28 @@ } } }, + "remark-stringify": { + "version": "7.0.4", + "resolved": "https://registry.npmjs.org/remark-stringify/-/remark-stringify-7.0.4.tgz", + "integrity": "sha512-qck+8NeA1D0utk1ttKcWAoHRrJxERYQzkHDyn+pF5Z4whX1ug98uCNPPSeFgLSaNERRxnD6oxIug6DzZQth6Pg==", + "dev": true, + "requires": { + "ccount": "^1.0.0", + "is-alphanumeric": "^1.0.0", + "is-decimal": "^1.0.0", + "is-whitespace-character": "^1.0.0", + "longest-streak": "^2.0.1", + "markdown-escapes": "^1.0.0", + "markdown-table": "^1.1.0", + "mdast-util-compact": "^1.0.0", + "parse-entities": "^1.0.2", + "repeat-string": "^1.5.4", + "state-toggle": "^1.0.0", + "stringify-entities": "^2.0.0", + "unherit": "^1.0.4", + "xtend": "^4.0.1" + } + }, "repeat-element": { "version": "1.1.3", "resolved": "https://registry.npmjs.org/repeat-element/-/repeat-element-1.1.3.tgz", @@ -13662,15 +12683,6 @@ "integrity": "sha1-jKCMLLtbVedNr6lr9/0aJ9VoyNA=", "dev": true }, - "rimraf": { - "version": "2.7.1", - "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-2.7.1.tgz", - "integrity": "sha512-uWjbaKIK3T1OSVptzX7Nl6PvQ3qAGtKEtVRjRuazjfL3Bx5eI409VZSqgND+4UNnmzLVdPj9FqFJNPqBZFve4w==", - "dev": true, - "requires": { - "glob": "^7.1.3" - } - }, "route-recognizer": { "version": "0.3.4", "resolved": "https://registry.npmjs.org/route-recognizer/-/route-recognizer-0.3.4.tgz", @@ -13733,12 +12745,6 @@ "xmlchars": "^2.1.1" } }, - "secure-keys": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/secure-keys/-/secure-keys-1.0.0.tgz", - "integrity": "sha1-8MgtmKOxOah3aogIBQuCRDEIf8o=", - "dev": true - }, "semantic-release": { "version": "16.0.1", "resolved": "https://registry.npmjs.org/semantic-release/-/semantic-release-16.0.1.tgz", @@ -14167,23 +13173,6 @@ "integrity": "sha1-De4hahyUGrN+nvsXiPavxf9VN/w=", "dev": true }, - "semver-diff": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/semver-diff/-/semver-diff-2.1.0.tgz", - "integrity": "sha1-S7uEN8jTfksM8aaP1ybsbWRdbTY=", - "dev": true, - "requires": { - "semver": "^5.0.3" - }, - "dependencies": { - "semver": { - "version": "5.7.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-5.7.1.tgz", - "integrity": "sha512-sauaDf/PZdVgrLTNYHRtpXa1iRiKcaebiKQ1BJdpQlWH2lCvexQdX55snPFyK7QzpudqbCI0qXFfOasHdyNDGQ==", - "dev": true - } - } - }, "semver-regex": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/semver-regex/-/semver-regex-2.0.0.tgz", @@ -14260,12 +13249,6 @@ "integrity": "sha512-bUcyZhIOLvjvdO7UT5MyNd6AAci4ssZy/8Da1etJVI/2n3vgpxfJ/ntYA0bN+8qg9HZB7xR9/g+fcDbGkk/gQg==", "dev": true }, - "set-immediate-shim": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/set-immediate-shim/-/set-immediate-shim-1.0.1.tgz", - "integrity": "sha1-SysbJ+uAip+NzEgaWOXlb1mfP2E=", - "dev": true - }, "set-value": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/set-value/-/set-value-2.0.1.tgz", @@ -14295,29 +13278,6 @@ "integrity": "sha512-JvdAWfbXeIGaZ9cILp38HntZSFSo3mWg6xGcJJsd+d4aRMOqauag1C63dJfDw7OaMYwEbHMOxEZ1lqVRYP2OAw==", "dev": true }, - "shallow-clone": { - "version": "0.1.2", - "resolved": "https://registry.npmjs.org/shallow-clone/-/shallow-clone-0.1.2.tgz", - "integrity": "sha1-WQnodLp3EG1zrEFM/sH/yofZcGA=", - "dev": true, - "requires": { - "is-extendable": "^0.1.1", - "kind-of": "^2.0.1", - "lazy-cache": "^0.2.3", - "mixin-object": "^2.0.1" - }, - "dependencies": { - "kind-of": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-2.0.1.tgz", - "integrity": "sha1-AY7HpM5+OobLkUG+UZ0kyPqpgbU=", - "dev": true, - "requires": { - "is-buffer": "^1.0.2" - } - } - } - }, "shebang-command": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-1.2.0.tgz", @@ -14429,12 +13389,6 @@ "integrity": "sha512-wA9XS475ZmGNlEnYYLPReSfuz/c3VQsEMoU43mi6OnKMCdbnFXd4/Yg7J0lBv8jkPolacMpOrWEaoYxuE1+hoQ==", "dev": true }, - "smart-buffer": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/smart-buffer/-/smart-buffer-4.1.0.tgz", - "integrity": "sha512-iVICrxOzCynf/SNaBQCw34eM9jROU/s5rzIhpOvzhzuYHfJR/DhZfDkXiZSgKXfgv26HT3Yni3AV/DGw0cGnnw==", - "dev": true - }, "snapdragon": { "version": "0.8.2", "resolved": "https://registry.npmjs.org/snapdragon/-/snapdragon-0.8.2.tgz", @@ -14558,528 +13512,99 @@ "kind-of": "^3.2.0" } }, - "snyk": { - "version": "1.247.1", - "resolved": "https://registry.npmjs.org/snyk/-/snyk-1.247.1.tgz", - "integrity": "sha512-/3n8Eair/MCtetCfaU7jRdIq0wac4fpFQXrp5phwRLvnxO9x6racbozrBszmlOBCCLlveFCBJg5il5hf1kacwQ==", - "dev": true, - "requires": { - "@snyk/cli-interface": "2.2.0", - "@snyk/dep-graph": "1.13.1", - "@snyk/gemfile": "1.2.0", - "@snyk/snyk-cocoapods-plugin": "2.0.1", - "@types/agent-base": "^4.2.0", - "@types/restify": "^4.3.6", - "abbrev": "^1.1.1", - "ansi-escapes": "3.2.0", - "chalk": "^2.4.2", - "cli-spinner": "0.2.10", - "configstore": "^3.1.2", - "debug": "^3.1.0", - "diff": "^4.0.1", - "git-url-parse": "11.1.2", - "glob": "^7.1.3", - "inquirer": "^6.2.2", - "lodash": "^4.17.14", - "needle": "^2.2.4", - "opn": "^5.5.0", - "os-name": "^3.0.0", - "proxy-agent": "^3.1.1", - "proxy-from-env": "^1.0.0", - "semver": "^6.0.0", - "snyk-config": "^2.2.1", - "snyk-docker-plugin": "1.33.1", - "snyk-go-plugin": "1.11.1", - "snyk-gradle-plugin": "3.2.2", - "snyk-module": "1.9.1", - "snyk-mvn-plugin": "2.4.0", - "snyk-nodejs-lockfile-parser": "1.16.1", - "snyk-nuget-plugin": "1.13.1", - "snyk-php-plugin": "1.7.0", - "snyk-policy": "1.13.5", - "snyk-python-plugin": "^1.13.3", - "snyk-resolve": "1.0.1", - "snyk-resolve-deps": "4.4.0", - "snyk-sbt-plugin": "2.9.0", - "snyk-tree": "^1.0.0", - "snyk-try-require": "1.3.1", - "source-map-support": "^0.5.11", - "strip-ansi": "^5.2.0", - "tempfile": "^2.0.0", - "then-fs": "^2.0.0", - "update-notifier": "^2.5.0", - "uuid": "^3.3.2", - "wrap-ansi": "^5.1.0" - } + "source-map": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==" }, - "snyk-config": { - "version": "2.2.3", - "resolved": "https://registry.npmjs.org/snyk-config/-/snyk-config-2.2.3.tgz", - "integrity": "sha512-9NjxHVMd1U1LFw66Lya4LXgrsFUiuRiL4opxfTFo0LmMNzUoU5Bk/p0zDdg3FE5Wg61r4fP2D8w+QTl6M8CGiw==", + "source-map-resolve": { + "version": "0.5.2", + "resolved": "https://registry.npmjs.org/source-map-resolve/-/source-map-resolve-0.5.2.tgz", + "integrity": "sha512-MjqsvNwyz1s0k81Goz/9vRBe9SZdB09Bdw+/zYyO+3CuPk6fouTaxscHkgtE8jKvf01kVfl8riHzERQ/kefaSA==", "dev": true, "requires": { - "debug": "^3.1.0", - "lodash": "^4.17.15", - "nconf": "^0.10.0" + "atob": "^2.1.1", + "decode-uri-component": "^0.2.0", + "resolve-url": "^0.2.1", + "source-map-url": "^0.4.0", + "urix": "^0.1.0" } }, - "snyk-docker-plugin": { - "version": "1.33.1", - "resolved": "https://registry.npmjs.org/snyk-docker-plugin/-/snyk-docker-plugin-1.33.1.tgz", - "integrity": "sha512-xfs3DN1tPMTh6J8x2341wGK4HRr+pI5+i/YRuRmsslnBnwk/DkKYcbt8zOIWk6kzMoW8vo+9LqqXBQO/24szKg==", + "source-map-url": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/source-map-url/-/source-map-url-0.4.0.tgz", + "integrity": "sha1-PpNdfd1zYxuXZZlW1VEo6HtQhKM=", + "dev": true + }, + "space-separated-tokens": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/space-separated-tokens/-/space-separated-tokens-1.1.4.tgz", + "integrity": "sha512-UyhMSmeIqZrQn2UdjYpxEkwY9JUrn8pP+7L4f91zRzOQuI8MF1FGLfYU9DKCYeLdo7LXMxwrX5zKFy7eeeVHuA==", + "dev": true + }, + "spawn-command": { + "version": "0.0.2", + "resolved": "https://registry.npmjs.org/spawn-command/-/spawn-command-0.0.2.tgz", + "integrity": "sha1-lUThpDygRfhTGqwaSMspva5iM44=", + "dev": true + }, + "spawn-error-forwarder": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/spawn-error-forwarder/-/spawn-error-forwarder-1.0.0.tgz", + "integrity": "sha1-Gv2Uc46ZmwNG17n8NzvlXgdXcCk=", + "dev": true + }, + "spawn-wrap": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/spawn-wrap/-/spawn-wrap-2.0.0.tgz", + "integrity": "sha512-EeajNjfN9zMnULLwhZZQU3GWBoFNkbngTUPfaawT4RkMiviTxcX0qfhVbGey39mfctfDHkWtuecgQ8NJcyQWHg==", "dev": true, "requires": { - "debug": "^4.1.1", - "dockerfile-ast": "0.0.16", - "semver": "^6.1.0", - "tar-stream": "^2.1.0", - "tslib": "^1" + "foreground-child": "^2.0.0", + "is-windows": "^1.0.2", + "make-dir": "^3.0.0", + "rimraf": "^3.0.0", + "signal-exit": "^3.0.2", + "which": "^2.0.1" }, "dependencies": { - "debug": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.1.1.tgz", - "integrity": "sha512-pYAIzeRo8J6KPEaJ0VWOh5Pzkbw/RetuzehGM7QRRX5he4fPHx2rdKMB256ehJCkX+XRQm16eZLqLNS8RSZXZw==", + "make-dir": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-3.0.0.tgz", + "integrity": "sha512-grNJDhb8b1Jm1qeqW5R/O63wUo4UXo2v2HMic6YT9i/HBlF93S8jkMgH7yugvY9ABDShH4VZMn8I+U8+fCNegw==", "dev": true, "requires": { - "ms": "^2.1.1" + "semver": "^6.0.0" + } + }, + "rimraf": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-3.0.0.tgz", + "integrity": "sha512-NDGVxTsjqfunkds7CqsOiEnxln4Bo7Nddl3XhS4pXg5OzwkLqJ971ZVAAnB+DDLnF76N+VnDEiBHaVV8I06SUg==", + "dev": true, + "requires": { + "glob": "^7.1.3" + } + }, + "which": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", + "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", + "dev": true, + "requires": { + "isexe": "^2.0.0" } } } }, - "snyk-go-parser": { - "version": "1.3.1", - "resolved": "https://registry.npmjs.org/snyk-go-parser/-/snyk-go-parser-1.3.1.tgz", - "integrity": "sha512-jrFRfIk6yGHFeipGD66WV9ei/A/w/lIiGqI80w1ndMbg6D6M5pVNbK7ngDTmo4GdHrZDYqx/VBGBsUm2bol3Rg==", + "spdx-correct": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/spdx-correct/-/spdx-correct-3.1.0.tgz", + "integrity": "sha512-lr2EZCctC2BNR7j7WzJ2FpDznxky1sjfxvvYEyzxNyb6lZXHODmEoJeFu4JupYlkfha1KZpJyoqiJ7pgA1qq8Q==", "dev": true, "requires": { - "toml": "^3.0.0", - "tslib": "^1.9.3" - } - }, - "snyk-go-plugin": { - "version": "1.11.1", - "resolved": "https://registry.npmjs.org/snyk-go-plugin/-/snyk-go-plugin-1.11.1.tgz", - "integrity": "sha512-IsNi7TmpHoRHzONOWJTT8+VYozQJnaJpKgnYNQjzNm2JlV8bDGbdGQ1a8LcEoChxnJ8v8aMZy7GTiQyGGABtEQ==", - "dev": true, - "requires": { - "debug": "^4.1.1", - "graphlib": "^2.1.1", - "snyk-go-parser": "1.3.1", - "tmp": "0.0.33", - "tslib": "^1.10.0" - }, - "dependencies": { - "debug": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.1.1.tgz", - "integrity": "sha512-pYAIzeRo8J6KPEaJ0VWOh5Pzkbw/RetuzehGM7QRRX5he4fPHx2rdKMB256ehJCkX+XRQm16eZLqLNS8RSZXZw==", - "dev": true, - "requires": { - "ms": "^2.1.1" - } - } - } - }, - "snyk-gradle-plugin": { - "version": "3.2.2", - "resolved": "https://registry.npmjs.org/snyk-gradle-plugin/-/snyk-gradle-plugin-3.2.2.tgz", - "integrity": "sha512-ijIWsypbtpdTuRcYTFsnEWbaBnhCc7q0iIg0A4OcOW/xLyInPwyfBMnip4ubNfHAS/PrvzgfwwwJhttcQD0ZaQ==", - "dev": true, - "requires": { - "@snyk/cli-interface": "2.2.0", - "@types/debug": "^4.1.4", - "chalk": "^2.4.2", - "clone-deep": "^0.3.0", - "debug": "^4.1.1", - "tmp": "0.0.33", - "tslib": "^1.9.3" - }, - "dependencies": { - "debug": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.1.1.tgz", - "integrity": "sha512-pYAIzeRo8J6KPEaJ0VWOh5Pzkbw/RetuzehGM7QRRX5he4fPHx2rdKMB256ehJCkX+XRQm16eZLqLNS8RSZXZw==", - "dev": true, - "requires": { - "ms": "^2.1.1" - } - } - } - }, - "snyk-module": { - "version": "1.9.1", - "resolved": "https://registry.npmjs.org/snyk-module/-/snyk-module-1.9.1.tgz", - "integrity": "sha512-A+CCyBSa4IKok5uEhqT+hV/35RO6APFNLqk9DRRHg7xW2/j//nPX8wTSZUPF8QeRNEk/sX+6df7M1y6PBHGSHA==", - "dev": true, - "requires": { - "debug": "^3.1.0", - "hosted-git-info": "^2.7.1" - } - }, - "snyk-mvn-plugin": { - "version": "2.4.0", - "resolved": "https://registry.npmjs.org/snyk-mvn-plugin/-/snyk-mvn-plugin-2.4.0.tgz", - "integrity": "sha512-Fmt6Mjx6zZz+4q6PnBkhuNGhEX++q/pKMI26ls4p3JPkx4KxBz89oncpkmf7P8YCkoaka8oHhtDEv/R4Z9LleQ==", - "dev": true, - "requires": { - "lodash": "^4.17.15", - "tslib": "1.9.3" - }, - "dependencies": { - "tslib": { - "version": "1.9.3", - "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.9.3.tgz", - "integrity": "sha512-4krF8scpejhaOgqzBEcGM7yDIEfi0/8+8zDRZhNZZ2kjmHJ4hv3zCbQWxoJGz1iw5U0Jl0nma13xzHXcncMavQ==", - "dev": true - } - } - }, - "snyk-nodejs-lockfile-parser": { - "version": "1.16.1", - "resolved": "https://registry.npmjs.org/snyk-nodejs-lockfile-parser/-/snyk-nodejs-lockfile-parser-1.16.1.tgz", - "integrity": "sha512-MEQImB2XU35D66wYve6g1RcDuD9vyoxGvYtM+ngSd5ItujzjIpyF26W7niqHwBRGLamqjsKF5cOlbmHs+wsx/Q==", - "dev": true, - "requires": { - "@yarnpkg/lockfile": "^1.0.2", - "graphlib": "^2.1.5", - "lodash": "^4.17.14", - "source-map-support": "^0.5.7", - "tslib": "^1.9.3", - "uuid": "^3.3.2" - } - }, - "snyk-nuget-plugin": { - "version": "1.13.1", - "resolved": "https://registry.npmjs.org/snyk-nuget-plugin/-/snyk-nuget-plugin-1.13.1.tgz", - "integrity": "sha512-2AQVeahBK7Rt38p0Acl1fMsFQu3dsqoRODPoRaS0IM/bOBzVdAkDF9pCb5yKMREGpMZcyRFkt8Q+hGiUk0Nlfg==", - "dev": true, - "requires": { - "debug": "^3.1.0", - "dotnet-deps-parser": "4.5.2", - "jszip": "^3.1.5", - "lodash": "^4.17.14", - "snyk-paket-parser": "1.5.0", - "tslib": "^1.9.3", - "xml2js": "^0.4.17" - } - }, - "snyk-paket-parser": { - "version": "1.5.0", - "resolved": "https://registry.npmjs.org/snyk-paket-parser/-/snyk-paket-parser-1.5.0.tgz", - "integrity": "sha512-1CYMPChJ9D9LBy3NLqHyv8TY7pR/LMISSr08LhfFw/FpfRZ+gTH8W6bbxCmybAYrOFNCqZkRprqOYDqZQFHipA==", - "dev": true, - "requires": { - "tslib": "^1.9.3" - } - }, - "snyk-php-plugin": { - "version": "1.7.0", - "resolved": "https://registry.npmjs.org/snyk-php-plugin/-/snyk-php-plugin-1.7.0.tgz", - "integrity": "sha512-mDe90xkqSEVrpx1ZC7ItqCOc6fZCySbE+pHVI+dAPUmf1C1LSWZrZVmAVeo/Dw9sJzJfzmcdAFQl+jZP8/uV0A==", - "dev": true, - "requires": { - "@snyk/cli-interface": "2.2.0", - "@snyk/composer-lockfile-parser": "1.2.0", - "tslib": "1.9.3" - }, - "dependencies": { - "tslib": { - "version": "1.9.3", - "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.9.3.tgz", - "integrity": "sha512-4krF8scpejhaOgqzBEcGM7yDIEfi0/8+8zDRZhNZZ2kjmHJ4hv3zCbQWxoJGz1iw5U0Jl0nma13xzHXcncMavQ==", - "dev": true - } - } - }, - "snyk-policy": { - "version": "1.13.5", - "resolved": "https://registry.npmjs.org/snyk-policy/-/snyk-policy-1.13.5.tgz", - "integrity": "sha512-KI6GHt+Oj4fYKiCp7duhseUj5YhyL/zJOrrJg0u6r59Ux9w8gmkUYT92FHW27ihwuT6IPzdGNEuy06Yv2C9WaQ==", - "dev": true, - "requires": { - "debug": "^3.1.0", - "email-validator": "^2.0.4", - "js-yaml": "^3.13.1", - "lodash.clonedeep": "^4.5.0", - "semver": "^6.0.0", - "snyk-module": "^1.9.1", - "snyk-resolve": "^1.0.1", - "snyk-try-require": "^1.3.1", - "then-fs": "^2.0.0" - } - }, - "snyk-python-plugin": { - "version": "1.13.3", - "resolved": "https://registry.npmjs.org/snyk-python-plugin/-/snyk-python-plugin-1.13.3.tgz", - "integrity": "sha512-Ud7mHmpMG4uCChvYLx5jA8HwOV/FNpT65xTxSt+6wsOjIUTuLiqM86mbvgzgk3pir8vMP9yQEsCi1i0zYLBArw==", - "dev": true, - "requires": { - "@snyk/cli-interface": "^2.0.3", - "tmp": "0.0.33" - } - }, - "snyk-resolve": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/snyk-resolve/-/snyk-resolve-1.0.1.tgz", - "integrity": "sha512-7+i+LLhtBo1Pkth01xv+RYJU8a67zmJ8WFFPvSxyCjdlKIcsps4hPQFebhz+0gC5rMemlaeIV6cqwqUf9PEDpw==", - "dev": true, - "requires": { - "debug": "^3.1.0", - "then-fs": "^2.0.0" - } - }, - "snyk-resolve-deps": { - "version": "4.4.0", - "resolved": "https://registry.npmjs.org/snyk-resolve-deps/-/snyk-resolve-deps-4.4.0.tgz", - "integrity": "sha512-aFPtN8WLqIk4E1ulMyzvV5reY1Iksz+3oPnUVib1jKdyTHymmOIYF7z8QZ4UUr52UsgmrD9EA/dq7jpytwFoOQ==", - "dev": true, - "requires": { - "@types/node": "^6.14.4", - "@types/semver": "^5.5.0", - "ansicolors": "^0.3.2", - "debug": "^3.2.5", - "lodash.assign": "^4.2.0", - "lodash.assignin": "^4.2.0", - "lodash.clone": "^4.5.0", - "lodash.flatten": "^4.4.0", - "lodash.get": "^4.4.2", - "lodash.set": "^4.3.2", - "lru-cache": "^4.0.0", - "semver": "^5.5.1", - "snyk-module": "^1.6.0", - "snyk-resolve": "^1.0.0", - "snyk-tree": "^1.0.0", - "snyk-try-require": "^1.1.1", - "then-fs": "^2.0.0" - }, - "dependencies": { - "@types/node": { - "version": "6.14.9", - "resolved": "https://registry.npmjs.org/@types/node/-/node-6.14.9.tgz", - "integrity": "sha512-leP/gxHunuazPdZaCvsCefPQxinqUDsCxCR5xaDUrY2MkYxQRFZZwU5e7GojyYsGB7QVtCi7iVEl/hoFXQYc+w==", - "dev": true - }, - "lru-cache": { - "version": "4.1.5", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-4.1.5.tgz", - "integrity": "sha512-sWZlbEP2OsHNkXrMl5GYk/jKk70MBng6UU4YI/qGDYbgf6YbP4EvmqISbXCoJiRKs+1bSpFHVgQxvJ17F2li5g==", - "dev": true, - "requires": { - "pseudomap": "^1.0.2", - "yallist": "^2.1.2" - } - }, - "semver": { - "version": "5.7.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-5.7.1.tgz", - "integrity": "sha512-sauaDf/PZdVgrLTNYHRtpXa1iRiKcaebiKQ1BJdpQlWH2lCvexQdX55snPFyK7QzpudqbCI0qXFfOasHdyNDGQ==", - "dev": true - }, - "yallist": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-2.1.2.tgz", - "integrity": "sha1-HBH5IY8HYImkfdUS+TxmmaaoHVI=", - "dev": true - } - } - }, - "snyk-sbt-plugin": { - "version": "2.9.0", - "resolved": "https://registry.npmjs.org/snyk-sbt-plugin/-/snyk-sbt-plugin-2.9.0.tgz", - "integrity": "sha512-R8jfRDkqlSsiSHYNAItKBUKUwb0n5z304Ko8ply/eoNAJMkXbFASDKHRto1v4F4wryJb4Rl1j/vFvIwytqZrww==", - "dev": true, - "requires": { - "semver": "^6.1.2", - "tmp": "^0.1.0", - "tree-kill": "^1.2.1", - "tslib": "^1.10.0" - }, - "dependencies": { - "tmp": { - "version": "0.1.0", - "resolved": "https://registry.npmjs.org/tmp/-/tmp-0.1.0.tgz", - "integrity": "sha512-J7Z2K08jbGcdA1kkQpJSqLF6T0tdQqpR2pnSUXsIchbPdTI9v3e85cLW0d6WDhwuAleOV71j2xWs8qMPfK7nKw==", - "dev": true, - "requires": { - "rimraf": "^2.6.3" - } - } - } - }, - "snyk-tree": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/snyk-tree/-/snyk-tree-1.0.0.tgz", - "integrity": "sha1-D7cxdtvzLngvGRAClBYESPkRHMg=", - "dev": true, - "requires": { - "archy": "^1.0.0" - } - }, - "snyk-try-require": { - "version": "1.3.1", - "resolved": "https://registry.npmjs.org/snyk-try-require/-/snyk-try-require-1.3.1.tgz", - "integrity": "sha1-bgJvkuZK9/zM6h7lPVJIQeQYohI=", - "dev": true, - "requires": { - "debug": "^3.1.0", - "lodash.clonedeep": "^4.3.0", - "lru-cache": "^4.0.0", - "then-fs": "^2.0.0" - }, - "dependencies": { - "lru-cache": { - "version": "4.1.5", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-4.1.5.tgz", - "integrity": "sha512-sWZlbEP2OsHNkXrMl5GYk/jKk70MBng6UU4YI/qGDYbgf6YbP4EvmqISbXCoJiRKs+1bSpFHVgQxvJ17F2li5g==", - "dev": true, - "requires": { - "pseudomap": "^1.0.2", - "yallist": "^2.1.2" - } - }, - "yallist": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-2.1.2.tgz", - "integrity": "sha1-HBH5IY8HYImkfdUS+TxmmaaoHVI=", - "dev": true - } - } - }, - "socks": { - "version": "2.3.3", - "resolved": "https://registry.npmjs.org/socks/-/socks-2.3.3.tgz", - "integrity": "sha512-o5t52PCNtVdiOvzMry7wU4aOqYWL0PeCXRWBEiJow4/i/wr+wpsJQ9awEu1EonLIqsfGd5qSgDdxEOvCdmBEpA==", - "dev": true, - "requires": { - "ip": "1.1.5", - "smart-buffer": "^4.1.0" - } - }, - "socks-proxy-agent": { - "version": "4.0.2", - "resolved": "https://registry.npmjs.org/socks-proxy-agent/-/socks-proxy-agent-4.0.2.tgz", - "integrity": "sha512-NT6syHhI9LmuEMSK6Kd2V7gNv5KFZoLE7V5udWmn0de+3Mkj3UMA/AJPLyeNUVmElCurSHtUdM3ETpR3z770Wg==", - "dev": true, - "requires": { - "agent-base": "~4.2.1", - "socks": "~2.3.2" - }, - "dependencies": { - "agent-base": { - "version": "4.2.1", - "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-4.2.1.tgz", - "integrity": "sha512-JVwXMr9nHYTUXsBFKUqhJwvlcYU/blreOEUkhNR2eXZIvwd+c+o5V4MgDPKWnMS/56awN3TRzIP+KoPn+roQtg==", - "dev": true, - "requires": { - "es6-promisify": "^5.0.0" - } - } - } - }, - "source-map": { - "version": "0.6.1", - "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", - "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==" - }, - "source-map-resolve": { - "version": "0.5.2", - "resolved": "https://registry.npmjs.org/source-map-resolve/-/source-map-resolve-0.5.2.tgz", - "integrity": "sha512-MjqsvNwyz1s0k81Goz/9vRBe9SZdB09Bdw+/zYyO+3CuPk6fouTaxscHkgtE8jKvf01kVfl8riHzERQ/kefaSA==", - "dev": true, - "requires": { - "atob": "^2.1.1", - "decode-uri-component": "^0.2.0", - "resolve-url": "^0.2.1", - "source-map-url": "^0.4.0", - "urix": "^0.1.0" - } - }, - "source-map-support": { - "version": "0.5.16", - "resolved": "https://registry.npmjs.org/source-map-support/-/source-map-support-0.5.16.tgz", - "integrity": "sha512-efyLRJDr68D9hBBNIPWFjhpFzURh+KJykQwvMyW5UiZzYwoF6l4YMMDIJJEyFWxWCqfyxLzz6tSfUFR+kXXsVQ==", - "dev": true, - "requires": { - "buffer-from": "^1.0.0", - "source-map": "^0.6.0" - } - }, - "source-map-url": { - "version": "0.4.0", - "resolved": "https://registry.npmjs.org/source-map-url/-/source-map-url-0.4.0.tgz", - "integrity": "sha1-PpNdfd1zYxuXZZlW1VEo6HtQhKM=", - "dev": true - }, - "space-separated-tokens": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/space-separated-tokens/-/space-separated-tokens-1.1.4.tgz", - "integrity": "sha512-UyhMSmeIqZrQn2UdjYpxEkwY9JUrn8pP+7L4f91zRzOQuI8MF1FGLfYU9DKCYeLdo7LXMxwrX5zKFy7eeeVHuA==", - "dev": true - }, - "spawn-command": { - "version": "0.0.2", - "resolved": "https://registry.npmjs.org/spawn-command/-/spawn-command-0.0.2.tgz", - "integrity": "sha1-lUThpDygRfhTGqwaSMspva5iM44=", - "dev": true - }, - "spawn-error-forwarder": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/spawn-error-forwarder/-/spawn-error-forwarder-1.0.0.tgz", - "integrity": "sha1-Gv2Uc46ZmwNG17n8NzvlXgdXcCk=", - "dev": true - }, - "spawn-wrap": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/spawn-wrap/-/spawn-wrap-2.0.0.tgz", - "integrity": "sha512-EeajNjfN9zMnULLwhZZQU3GWBoFNkbngTUPfaawT4RkMiviTxcX0qfhVbGey39mfctfDHkWtuecgQ8NJcyQWHg==", - "dev": true, - "requires": { - "foreground-child": "^2.0.0", - "is-windows": "^1.0.2", - "make-dir": "^3.0.0", - "rimraf": "^3.0.0", - "signal-exit": "^3.0.2", - "which": "^2.0.1" - }, - "dependencies": { - "make-dir": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-3.0.0.tgz", - "integrity": "sha512-grNJDhb8b1Jm1qeqW5R/O63wUo4UXo2v2HMic6YT9i/HBlF93S8jkMgH7yugvY9ABDShH4VZMn8I+U8+fCNegw==", - "dev": true, - "requires": { - "semver": "^6.0.0" - } - }, - "rimraf": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-3.0.0.tgz", - "integrity": "sha512-NDGVxTsjqfunkds7CqsOiEnxln4Bo7Nddl3XhS4pXg5OzwkLqJ971ZVAAnB+DDLnF76N+VnDEiBHaVV8I06SUg==", - "dev": true, - "requires": { - "glob": "^7.1.3" - } - }, - "which": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", - "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", - "dev": true, - "requires": { - "isexe": "^2.0.0" - } - } - } - }, - "spdx-correct": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/spdx-correct/-/spdx-correct-3.1.0.tgz", - "integrity": "sha512-lr2EZCctC2BNR7j7WzJ2FpDznxky1sjfxvvYEyzxNyb6lZXHODmEoJeFu4JupYlkfha1KZpJyoqiJ7pgA1qq8Q==", - "dev": true, - "requires": { - "spdx-expression-parse": "^3.0.0", - "spdx-license-ids": "^3.0.0" + "spdx-expression-parse": "^3.0.0", + "spdx-license-ids": "^3.0.0" } }, "spdx-exceptions": { @@ -15342,6 +13867,19 @@ "safe-buffer": "~5.2.0" } }, + "stringify-entities": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/stringify-entities/-/stringify-entities-2.0.0.tgz", + "integrity": "sha512-fqqhZzXyAM6pGD9lky/GOPq6V4X0SeTAFBl0iXb/BzOegl40gpf/bV3QQP7zULNYvjr6+Dx8SCaDULjVoOru0A==", + "dev": true, + "requires": { + "character-entities-html4": "^1.0.0", + "character-entities-legacy": "^1.0.0", + "is-alphanumerical": "^1.0.0", + "is-decimal": "^1.0.2", + "is-hexadecimal": "^1.0.0" + } + }, "stringify-object": { "version": "3.3.0", "resolved": "https://registry.npmjs.org/stringify-object/-/stringify-object-3.3.0.tgz", @@ -15464,21 +14002,8 @@ "emoji-regex": "^7.0.1", "is-fullwidth-code-point": "^2.0.0", "strip-ansi": "^5.1.0" - } - } - } - }, - "tar-stream": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/tar-stream/-/tar-stream-2.1.0.tgz", - "integrity": "sha512-+DAn4Nb4+gz6WZigRzKEZl1QuJVOLtAwwF+WUxy1fJ6X63CaGaUAxJRD2KEn1OMfcbCjySTYpNC6WmfQoIEOdw==", - "dev": true, - "requires": { - "bl": "^3.0.0", - "end-of-stream": "^1.4.1", - "fs-constants": "^1.0.0", - "inherits": "^2.0.3", - "readable-stream": "^3.1.1" + } + } } }, "teeny-request": { @@ -15510,16 +14035,6 @@ "integrity": "sha1-CnwOom06Oa+n4OvqnB/AvE2qAR0=", "dev": true }, - "tempfile": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/tempfile/-/tempfile-2.0.0.tgz", - "integrity": "sha1-awRGhWqbERTRhW/8vlCczLCXcmU=", - "dev": true, - "requires": { - "temp-dir": "^1.0.0", - "uuid": "^3.0.1" - } - }, "tempy": { "version": "0.3.0", "resolved": "https://registry.npmjs.org/tempy/-/tempy-0.3.0.tgz", @@ -15539,65 +14054,6 @@ } } }, - "term-size": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/term-size/-/term-size-1.2.0.tgz", - "integrity": "sha1-RYuDiH8oj8Vtb/+/rSYuJmOO+mk=", - "dev": true, - "requires": { - "execa": "^0.7.0" - }, - "dependencies": { - "cross-spawn": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-5.1.0.tgz", - "integrity": "sha1-6L0O/uWPz/b4+UUQoKVUu/ojVEk=", - "dev": true, - "requires": { - "lru-cache": "^4.0.1", - "shebang-command": "^1.2.0", - "which": "^1.2.9" - } - }, - "execa": { - "version": "0.7.0", - "resolved": "https://registry.npmjs.org/execa/-/execa-0.7.0.tgz", - "integrity": "sha1-lEvs00zEHuMqY6n68nrVpl/Fl3c=", - "dev": true, - "requires": { - "cross-spawn": "^5.0.1", - "get-stream": "^3.0.0", - "is-stream": "^1.1.0", - "npm-run-path": "^2.0.0", - "p-finally": "^1.0.0", - "signal-exit": "^3.0.0", - "strip-eof": "^1.0.0" - } - }, - "get-stream": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-3.0.0.tgz", - "integrity": "sha1-jpQ9E1jcN1VQVOy+LtsFqhdO3hQ=", - "dev": true - }, - "lru-cache": { - "version": "4.1.5", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-4.1.5.tgz", - "integrity": "sha512-sWZlbEP2OsHNkXrMl5GYk/jKk70MBng6UU4YI/qGDYbgf6YbP4EvmqISbXCoJiRKs+1bSpFHVgQxvJ17F2li5g==", - "dev": true, - "requires": { - "pseudomap": "^1.0.2", - "yallist": "^2.1.2" - } - }, - "yallist": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-2.1.2.tgz", - "integrity": "sha1-HBH5IY8HYImkfdUS+TxmmaaoHVI=", - "dev": true - } - } - }, "test-exclude": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/test-exclude/-/test-exclude-6.0.0.tgz", @@ -15626,15 +14082,6 @@ "integrity": "sha1-f17oI66AUgfACvLfSoTsP8+lcLQ=", "dev": true }, - "then-fs": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/then-fs/-/then-fs-2.0.0.tgz", - "integrity": "sha1-cveS3Z0xcFqRrhnr/Piz+WjIHaI=", - "dev": true, - "requires": { - "promise": ">=3.2 <8" - } - }, "thenify": { "version": "3.3.0", "resolved": "https://registry.npmjs.org/thenify/-/thenify-3.3.0.tgz", @@ -15668,18 +14115,6 @@ "readable-stream": "2 || 3" } }, - "thunkify": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/thunkify/-/thunkify-2.1.2.tgz", - "integrity": "sha1-+qDp0jDFGsyVyhOjYawFyn4EVT0=", - "dev": true - }, - "timed-out": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/timed-out/-/timed-out-4.0.1.tgz", - "integrity": "sha1-8y6srFoXW+ol1/q1Zas+2HQe9W8=", - "dev": true - }, "timers-ext": { "version": "0.1.7", "resolved": "https://registry.npmjs.org/timers-ext/-/timers-ext-0.1.7.tgz", @@ -15740,12 +14175,6 @@ "integrity": "sha512-yaOH/Pk/VEhBWWTlhI+qXxDFXlejDGcQipMlyxda9nthulaxLZUNcUqFxokp0vcYnvteJln5FNQDRrxj3YcbVw==", "dev": true }, - "toml": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/toml/-/toml-3.0.0.tgz", - "integrity": "sha512-y/mWCZinnvxjTKYhJ+pYxwD0mRLVvOtdS2Awbgxln6iEnt4rk0yBxeSBHkGJcPucRiG0e55mwWp+g/05rsrd6w==", - "dev": true - }, "tough-cookie": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/tough-cookie/-/tough-cookie-3.0.1.tgz", @@ -15770,12 +14199,6 @@ "integrity": "sha1-y99WD9e5r2MlAv7UD5GMFX6pcTc=", "dev": true }, - "tree-kill": { - "version": "1.2.2", - "resolved": "https://registry.npmjs.org/tree-kill/-/tree-kill-1.2.2.tgz", - "integrity": "sha512-L0Orpi8qGpRG//Nd+H90vFB+3iHnue1zSSGmNOOCh1GLJ7rUKVwV2HvijphGQS2UmhUZewS9VgvxYIdgr+fG1A==", - "dev": true - }, "trim": { "version": "0.0.1", "resolved": "https://registry.npmjs.org/trim/-/trim-0.0.1.tgz", @@ -16128,30 +14551,6 @@ } } }, - "unzip-response": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/unzip-response/-/unzip-response-2.0.1.tgz", - "integrity": "sha1-0vD3N9FrBhXnKmk17QQhRXLVb5c=", - "dev": true - }, - "update-notifier": { - "version": "2.5.0", - "resolved": "https://registry.npmjs.org/update-notifier/-/update-notifier-2.5.0.tgz", - "integrity": "sha512-gwMdhgJHGuj/+wHJJs9e6PcCszpxR1b236igrOkUofGhqJuG+amlIKwApH1IW1WWl7ovZxsX49lMBWLxSdm5Dw==", - "dev": true, - "requires": { - "boxen": "^1.2.1", - "chalk": "^2.0.1", - "configstore": "^3.0.0", - "import-lazy": "^2.1.0", - "is-ci": "^1.0.10", - "is-installed-globally": "^0.1.0", - "is-npm": "^1.0.0", - "latest-version": "^3.0.0", - "semver-diff": "^2.0.0", - "xdg-basedir": "^3.0.0" - } - }, "uri-js": { "version": "4.2.2", "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.2.2.tgz", @@ -16181,15 +14580,6 @@ "requires-port": "^1.0.0" } }, - "url-parse-lax": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/url-parse-lax/-/url-parse-lax-1.0.0.tgz", - "integrity": "sha1-evjzA2Rem9eaJy56FKxovAYJ2nM=", - "dev": true, - "requires": { - "prepend-http": "^1.0.1" - } - }, "urlgrey": { "version": "0.4.4", "resolved": "https://registry.npmjs.org/urlgrey/-/urlgrey-0.4.4.tgz", @@ -16239,12 +14629,6 @@ "integrity": "sha512-usZBT3PW+LOjM25wbqIlZwPeJV+3OSz3M1k1Ws8snlW39dZyYL9lOGC5FgPVHfk0jKmjiDV8Z0mIbVQPiwFs7g==", "dev": true }, - "valid-url": { - "version": "1.0.9", - "resolved": "https://registry.npmjs.org/valid-url/-/valid-url-1.0.9.tgz", - "integrity": "sha1-HBRHm0DxOXp1eC8RXkCGRHQzogA=", - "dev": true - }, "validate-npm-package-license": { "version": "3.0.4", "resolved": "https://registry.npmjs.org/validate-npm-package-license/-/validate-npm-package-license-3.0.4.tgz", @@ -16304,12 +14688,6 @@ "unist-util-stringify-position": "^2.0.0" } }, - "vscode-languageserver-types": { - "version": "3.14.0", - "resolved": "https://registry.npmjs.org/vscode-languageserver-types/-/vscode-languageserver-types-3.14.0.tgz", - "integrity": "sha512-lTmS6AlAlMHOvPQemVwo3CezxBp0sNB95KNPkqp3Nxd5VFEnuG1ByM0zlRWos0zjO3ZWtkvhal0COgiV1xIA4A==", - "dev": true - }, "w3c-hr-time": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/w3c-hr-time/-/w3c-hr-time-1.0.1.tgz", @@ -16385,21 +14763,6 @@ "string-width": "^1.0.2 || 2" } }, - "widest-line": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/widest-line/-/widest-line-2.0.1.tgz", - "integrity": "sha512-Ba5m9/Fa4Xt9eb2ELXt77JxVDV8w7qQrH0zS/TWSJdLyAwQjWoOzpzj5lwVftDz6n/EOu3tNACS84v509qwnJA==", - "dev": true, - "requires": { - "string-width": "^2.1.1" - } - }, - "window-size": { - "version": "0.1.4", - "resolved": "https://registry.npmjs.org/window-size/-/window-size-0.1.4.tgz", - "integrity": "sha1-+OGqHuWlPsW/FR/6CXQqatdpeHY=", - "dev": true - }, "windows-release": { "version": "3.2.0", "resolved": "https://registry.npmjs.org/windows-release/-/windows-release-3.2.0.tgz", @@ -16513,17 +14876,6 @@ "mkdirp": "^0.5.1" } }, - "write-file-atomic": { - "version": "2.4.3", - "resolved": "https://registry.npmjs.org/write-file-atomic/-/write-file-atomic-2.4.3.tgz", - "integrity": "sha512-GaETH5wwsX+GcnzhPgKcKjJ6M2Cq3/iZp1WyY/X1CSqrW+jVNM9Y7D8EC2sM4ZG/V8wZlSniJnCKWPmBYAucRQ==", - "dev": true, - "requires": { - "graceful-fs": "^4.1.11", - "imurmurhash": "^0.1.4", - "signal-exit": "^3.0.2" - } - }, "ws": { "version": "7.2.0", "resolved": "https://registry.npmjs.org/ws/-/ws-7.2.0.tgz", @@ -16532,12 +14884,6 @@ "async-limiter": "^1.0.0" } }, - "xdg-basedir": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/xdg-basedir/-/xdg-basedir-3.0.0.tgz", - "integrity": "sha1-SWsswQnsqNus/i3HK2A8F8WHCtQ=", - "dev": true - }, "xml": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/xml/-/xml-1.0.1.tgz", @@ -16576,27 +14922,15 @@ "resolved": "https://registry.npmjs.org/xmlchars/-/xmlchars-2.2.0.tgz", "integrity": "sha512-JZnDKK8B0RCDw84FNdDAIpZK+JuJw+s7Lz8nksI7SIuU3UXJJslUthsi+uWBUYOwPFwW7W7PRLRfUKpxjtjFCw==" }, - "xmldom": { - "version": "0.1.27", - "resolved": "https://registry.npmjs.org/xmldom/-/xmldom-0.1.27.tgz", - "integrity": "sha1-1QH5ezvbQDr4757MIFcxh6rawOk=", - "dev": true - }, - "xregexp": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/xregexp/-/xregexp-2.0.0.tgz", - "integrity": "sha1-UqY+VsoLhKfzpfPWGHLxJq16WUM=", - "dev": true - }, "xtend": { "version": "4.0.2", "resolved": "https://registry.npmjs.org/xtend/-/xtend-4.0.2.tgz", "integrity": "sha512-LKYU1iAXJXUgAXn9URjiu+MWhyUXHsvfp7mcuYm9dSUKK0/CjtrUwFAxD82/mCWbtLsGjFIad0wIsod4zrTAEQ==" }, "y18n": { - "version": "3.2.1", - "resolved": "https://registry.npmjs.org/y18n/-/y18n-3.2.1.tgz", - "integrity": "sha1-bRX7qITAhnnA136I53WegR4H+kE=", + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/y18n/-/y18n-4.0.0.tgz", + "integrity": "sha512-r9S/ZyXu/Xu9q1tYlpsLIsa3EeLXXk0VwlxqTcFRfg9EhMW+17kbt9G0NrgCmhGb5vT2hyhJZLfDGx+7+5Uj/w==", "dev": true }, "yallist": { @@ -16614,53 +14948,166 @@ } }, "yargs": { - "version": "3.32.0", - "resolved": "https://registry.npmjs.org/yargs/-/yargs-3.32.0.tgz", - "integrity": "sha1-AwiOnr+edWtpdRYR0qXvWRSCyZU=", - "dev": true, - "requires": { - "camelcase": "^2.0.1", - "cliui": "^3.0.3", - "decamelize": "^1.1.1", - "os-locale": "^1.4.0", - "string-width": "^1.0.1", - "window-size": "^0.1.4", - "y18n": "^3.2.0" + "version": "15.1.0", + "resolved": "https://registry.npmjs.org/yargs/-/yargs-15.1.0.tgz", + "integrity": "sha512-T39FNN1b6hCW4SOIk1XyTOWxtXdcen0t+XYrysQmChzSipvhBO8Bj0nK1ozAasdk24dNWuMZvr4k24nz+8HHLg==", + "dev": true, + "requires": { + "cliui": "^6.0.0", + "decamelize": "^1.2.0", + "find-up": "^4.1.0", + "get-caller-file": "^2.0.1", + "require-directory": "^2.1.1", + "require-main-filename": "^2.0.0", + "set-blocking": "^2.0.0", + "string-width": "^4.2.0", + "which-module": "^2.0.0", + "y18n": "^4.0.0", + "yargs-parser": "^16.1.0" }, "dependencies": { "ansi-regex": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-2.1.1.tgz", - "integrity": "sha1-w7M6te42DYbg5ijwRorn7yfWVN8=", + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.0.tgz", + "integrity": "sha512-bY6fj56OUQ0hU1KjFNDQuJFezqKdrAyFdIevADiqrWHwSlbmBNMHp5ak2f40Pm8JTFyM2mqxkG6ngkHO11f/lg==", + "dev": true + }, + "ansi-styles": { + "version": "4.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.2.1.tgz", + "integrity": "sha512-9VGjrMsG1vePxcSweQsN20KY/c4zN0h9fLjqAbwbPfahM3t+NL+M9HC8xeXG2I8pX5NoamTGNuomEUFI7fcUjA==", + "dev": true, + "requires": { + "@types/color-name": "^1.1.1", + "color-convert": "^2.0.1" + } + }, + "cliui": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/cliui/-/cliui-6.0.0.tgz", + "integrity": "sha512-t6wbgtoCXvAzst7QgXxJYqPt0usEfbgQdftEPbLL/cvv6HPE5VgvqCuAIDR0NgU52ds6rFwqrgakNLrHEjCbrQ==", + "dev": true, + "requires": { + "string-width": "^4.2.0", + "strip-ansi": "^6.0.0", + "wrap-ansi": "^6.2.0" + } + }, + "color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "requires": { + "color-name": "~1.1.4" + } + }, + "color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "emoji-regex": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", "dev": true }, + "find-up": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-4.1.0.tgz", + "integrity": "sha512-PpOwAdQ/YlXQ2vj8a3h8IipDuYRi3wceVQQGYWxNINccq40Anw7BlsEXCMbt1Zt+OLA6Fq9suIpIWD0OsnISlw==", + "dev": true, + "requires": { + "locate-path": "^5.0.0", + "path-exists": "^4.0.0" + } + }, "is-fullwidth-code-point": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-1.0.0.tgz", - "integrity": "sha1-754xOG8DGn8NZDr4L95QxFfvAMs=", + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", + "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", + "dev": true + }, + "locate-path": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-5.0.0.tgz", + "integrity": "sha512-t7hw9pI+WvuwNJXwk5zVHpyhIqzg2qTlklJOf0mVxGSbe3Fp2VieZcduNYjaLDoy6p9uGpQEGWG87WpMKlNq8g==", "dev": true, "requires": { - "number-is-nan": "^1.0.0" + "p-locate": "^4.1.0" + } + }, + "p-limit": { + "version": "2.2.2", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.2.2.tgz", + "integrity": "sha512-WGR+xHecKTr7EbUEhyLSh5Dube9JtdiG78ufaeLxTgpudf/20KqyMioIUZJAezlTIi6evxuoUs9YXc11cU+yzQ==", + "dev": true, + "requires": { + "p-try": "^2.0.0" + } + }, + "p-locate": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-4.1.0.tgz", + "integrity": "sha512-R79ZZ/0wAxKGu3oYMlz8jy/kbhsNrS7SKZ7PxEHBgJ5+F2mtFW2fK2cOtBh1cHYkQsbzFV7I+EoRKe6Yt0oK7A==", + "dev": true, + "requires": { + "p-limit": "^2.2.0" } }, + "p-try": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", + "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", + "dev": true + }, + "path-exists": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-4.0.0.tgz", + "integrity": "sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w==", + "dev": true + }, "string-width": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-1.0.2.tgz", - "integrity": "sha1-EYvfW4zcUaKn5w0hHgfisLmxB9M=", + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.0.tgz", + "integrity": "sha512-zUz5JD+tgqtuDjMhwIg5uFVV3dtqZ9yQJlZVfq4I01/K5Paj5UHj7VyrQOJvzawSVlKpObApbfD0Ed6yJc+1eg==", "dev": true, "requires": { - "code-point-at": "^1.0.0", - "is-fullwidth-code-point": "^1.0.0", - "strip-ansi": "^3.0.0" + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.0" } }, "strip-ansi": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-3.0.1.tgz", - "integrity": "sha1-ajhfuIU9lS1f8F0Oiq+UJ43GPc8=", + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.0.tgz", + "integrity": "sha512-AuvKTrTfQNYNIctbR1K/YGTR1756GycPsg7b9bdV9Duqur4gv6aKqHXah67Z8ImS7WEz5QVcOtlfW2rZEugt6w==", "dev": true, "requires": { - "ansi-regex": "^2.0.0" + "ansi-regex": "^5.0.0" + } + }, + "wrap-ansi": { + "version": "6.2.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-6.2.0.tgz", + "integrity": "sha512-r6lPcBGxZXlIcymEu7InxDMhdW0KDxpLgoFLcguasxCaJ/SOIZwINatK9KY/tf+ZrlywOKU0UDj3ATXUBfxJXA==", + "dev": true, + "requires": { + "ansi-styles": "^4.0.0", + "string-width": "^4.1.0", + "strip-ansi": "^6.0.0" + } + }, + "yargs-parser": { + "version": "16.1.0", + "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-16.1.0.tgz", + "integrity": "sha512-H/V41UNZQPkUMIT5h5hiwg4QKIY1RPvoBV4XcjUbRM8Bk2oKqqyZ0DIEbTFZB0XjbtSPG8SAa/0DxCQmiRgzKg==", + "dev": true, + "requires": { + "camelcase": "^5.0.0", + "decamelize": "^1.2.0" } } } diff --git a/package.json b/package.json index 9cbbda4bf..5ca79a25f 100644 --- a/package.json +++ b/package.json @@ -11,14 +11,14 @@ "test-ci": "npm run lint && npm run test && codecov", "lint": "npx eslint . && npm run types", "types": "npm run docs && node bin/schema2ts.js", - "docs": "npx jsonschema2md -d src/schemas -o docs", + "docs": "npx jsonschema2md -d src/schemas -o docs -x docs", "commit": "git-cz" }, "author": "", "license": "Apache-2.0", "devDependencies": { "@adobe/eslint-config-helix": "1.1.0", - "@adobe/jsonschema2md": "3.3.1", + "@adobe/jsonschema2md": "4.0.6", "@pollyjs/adapter-fetch": "3.0.1", "@pollyjs/adapter-node-http": "3.0.2", "@pollyjs/core": "3.0.0", @@ -49,7 +49,7 @@ }, "dependencies": { "@adobe/helix-log": "4.4.2", - "@adobe/helix-shared": "^3.0.0", + "@adobe/helix-shared": "^4.0.0", "@adobe/openwhisk-action-logger": "2.0.3", "ajv": "^6.10.2", "callsites": "^3.1.0",