@swaggerexpert/arazzo-runtime-expression 1.0.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed 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 CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,10 @@
+@swaggerexpert/arazzo-runtime-expression
+Copyright 2025, Vladimír Gorej
+@swaggerexpert/arazzo-runtime-expression is licensed under Apache 2.0 license.
+Copy of the Apache 2.0 license can be found in `LICENSE` file.
+
+Arazzo Specification 1.0.1
+Copyright The Linux Foundation
+Fragments of the specification text are embedded in `README.md`.
+ABNF grammar is taken directly from Arazzo Specification.
+Copy of the Apache 2.0 license can be found in `LICENSE` file.

package/README.md

@@ -0,0 +1,290 @@
+# @swaggerexpert/arazzo-runtime-expression
+
+[![npmversion](https://img.shields.io/npm/v/%40swaggerexpert%2Farazzo-runtime-expression?style=flat-square&label=npm%20package&color=%234DC81F&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2F%40swaggerexpert%2Farazzo-runtime-expression)](https://www.npmjs.com/package/@swaggerexpert/arazzo-runtime-expression)
+[![npm](https://img.shields.io/npm/dm/@swaggerexpert/arazzo-runtime-expression)](https://www.npmjs.com/package/@swaggerexpert/arazzo-runtime-expression)
+[![Test workflow](https://github.com/swaggerexpert/arazzo-runtime-expression/actions/workflows/test.yml/badge.svg)](https://github.com/swaggerexpert/arazzo-runtime-expression/actions)
+[![Dependabot enabled](https://img.shields.io/badge/Dependabot-enabled-blue.svg)](https://dependabot.com/)
+[![try on RunKit](https://img.shields.io/badge/try%20on-RunKit-brightgreen.svg?style=flat)](https://npm.runkit.com/@swaggerexpert/arazzo-runtime-expression)
+[![Tidelift](https://tidelift.com/badges/package/npm/@swaggerexpert%2Farazzo-runtime-expression)](https://tidelift.com/subscription/pkg/npm-.swaggerexpert-arazzo-runtime-expression?utm_source=npm-swaggerexpert-arazzo-runtime-expression&utm_medium=referral&utm_campaign=readme)
+
+[Arazzo Runtime Expressions](https://spec.openapis.org/arazzo/latest.html#runtime-expressions) allows values to be defined based on information that will be available within the HTTP message in an actual API call,
+or within objects serialized from the Arazzo document such as [workflows](https://spec.openapis.org/arazzo/latest.html#workflow-object) or [steps](https://spec.openapis.org/arazzo/latest.html#step-object).
+
+`@swaggerexpert/arazzo-runtime-expression` is a **parser**, **validator** and **extractor** for Arazzo Runtime Expressions.
+
+It supports Runtime Expressions defined in following Arazzo specification versions:
+
+- [Arazzo 1.0.0](https://spec.openapis.org/arazzo/v1.0.0.html)
+- [Arazzo 1.0.1](https://spec.openapis.org/arazzo/v1.0.1.html)
+
+<table>
+  <tr>
+    <td align="right" valign="middle">
+        <img src="https://cdn2.hubspot.net/hubfs/4008838/website/logos/logos_for_download/Tidelift_primary-shorthand-logo.png" alt="Tidelift" width="60" />
+      </td>
+      <td valign="middle">
+        <a href="https://tidelift.com/subscription/pkg/npm-.swaggerexpert-arazzo-runtime-expression?utm_source=npm-swaggerexpert-arazzo-runtime-expression&utm_medium=referral&utm_campaign=readme">
+            Get professionally supported @swaggerexpert/arazzo-runtime-expression with Tidelift Subscription.
+        </a>
+      </td>
+  </tr>
+</table>
+
+## Table of Contents
+
+- [Getting started](#getting-started)
+  - [Installation](#installation)
+  - [Usage](#usage)
+    - [Extraction](#extraction)
+    - [Parsing](#parsing)
+    - [Validation](#validation)
+    - [Grammar](#grammar)
+- [More about Arazzo runtime expressions](#more-about-arazzo-runtime-expressions)
+- [License](#license)
+
+
+## Getting started
+
+### Installation
+
+You can install `@swaggerexpert/arazzo-runtime-expression` using `npm`:
+
+```sh
+ $ npm install @swaggerexpert/arazzo-runtime-expression
+```
+
+### Usage
+
+`@swaggerexpert/arazzo-runtime-expression` currently supports **extraction**, **parsing** and **validation**.
+Both parser and validator are based on a superset of [ABNF](https://www.rfc-editor.org/rfc/rfc5234) ([SABNF](https://cs.github.com/ldthomas/apg-js2/blob/master/SABNF.md))
+and use [apg-lite](https://github.com/ldthomas/apg-lite) parser generator.
+
+#### Extraction
+
+Arazzo embeds Runtime Expressions into string values surrounded with `{}` curly braces.
+To extract Runtime Expressions from this embedded form, use the **extract** function.
+Extracted Runtime Expression can be used for further parsing of validation.
+
+```js
+import { extract, test, parse } from '@swaggerexpert/arazzo-runtime-expression';
+
+const expression = extract('{$request.header.accept}'); // => '$request.header.accept'
+
+test(expression); // => true
+parse(expression); // => { result, ast }
+```
+
+#### Parsing
+
+Parsing a Runtime Expression is as simple as importing the **parse** function and calling it.
+
+```js
+import { parse } from '@swaggerexpert/arazzo-runtime-expression';
+
+const parseResult = parse('$request.header.accept');
+```
+
+**parseResult** variable has the following shape:
+
+```
+{
+  result: {
+    success: true,
+    state: 101,
+    stateName: 'MATCH',
+    length: 22,
+    matched: 22,
+    maxMatched: 22,
+    maxTreeDepth: 13,
+    nodeHits: 152
+  },
+  ast: fnast {
+    callbacks: [
+      expression: [Function: expression],
+      'parameter-name': [Function: parameterName],
+      source: [Function: source],
+      'header-reference': [Function: headerReference],
+      'query-reference': [Function: queryReference],
+      'path-reference': [Function: pathReference],
+      'body-reference': [Function: bodyReference],
+      'json-pointer': [Function: jsonPointer],
+      'reference-token': [Function: referenceToken],
+      name: [Function: name],
+      token: [Function: token]
+    ],
+    init: [Function (anonymous)],
+    ruleDefined: [Function (anonymous)],
+    udtDefined: [Function (anonymous)],
+    down: [Function (anonymous)],
+    up: [Function (anonymous)],
+    translate: [Function (anonymous)],
+    setLength: [Function (anonymous)],
+    getLength: [Function (anonymous)],
+    toXml: [Function (anonymous)]
+  }
+}
+```
+
+###### Interpreting AST as list of entries
+
+```js
+import { parse } from '@swaggerexpert/arazzo-runtime-expression';
+
+const parseResult = parse('$request.header.accept');
+const parts = [];
+
+parseResult.ast.translate(parts);
+```
+
+After running the above code, **parts** variable has the following shape:
+
+```js
+[
+  [ 'expression', '$request.header.accept' ],
+  [ 'source', 'header.accept' ],
+  [ 'header-reference', 'header.accept' ],
+  [ 'token', 'accept' ],
+]
+```
+
+###### Interpreting AST as XML
+
+```js
+import { parse } from '@swaggerexpert/arazzo-runtime-expression';
+
+const parseResult = parse('$request.header.accept');
+const xml = parseResult.ast.toXml();
+```
+
+After running the above code, **xml** variable has the following content:
+
+```xml
+<?xml version="1.0" encoding="utf-8"?>
+<root nodes="4" characters="22">
+  <!-- input string -->
+  $request.header.accept
+  <node name="expression" index="0" length="22">
+    $request.header.accept
+    <node name="source" index="9" length="13">
+      header.accept
+      <node name="header-reference" index="9" length="13">
+        header.accept
+        <node name="token" index="16" length="6">
+          accept
+        </node><!-- name="token" -->
+      </node><!-- name="header-reference" -->
+    </node><!-- name="source" -->
+  </node><!-- name="expression" -->
+</root>
+```
+
+> NOTE: AST can also be traversed in classical way using [depth first traversal](https://www.tutorialspoint.com/data_structures_algorithms/depth_first_traversal.htm). For more information about this option please refer to [apg-js](https://github.com/ldthomas/apg-js) and [apg-js-examples](https://github.com/ldthomas/apg-js-examples).
+
+#### Validation
+
+Validating a Runtime Expression is as simple as importing the **test** function and calling it.
+
+```js
+import { test } from '@swaggerexpert/arazzo-runtime-expression';
+
+test('$request.header.accept'); // => true
+test('nonsensical string'); // => false
+```
+
+#### Grammar
+
+New grammar instance can be created in following way:
+
+```js
+import { Grammar } from '@swaggerexpert/arazzo-runtime-expression';
+
+const grammar = new Grammar();
+```
+
+To obtain original ABNF (SABNF) grammar as a string:
+
+```js
+import { Grammar } from '@swaggerexpert/arazzo-runtime-expression';
+
+const grammar = new Grammar();
+
+grammar.toString();
+// or
+String(grammar);
+```
+
+## More about Arazzo runtime expressions
+
+The runtime expression is defined by the following [ABNF](https://tools.ietf.org/html/rfc5234) syntax
+
+```abnf
+; Arazzo runtime expression ABNF syntax
+expression       = ( "$url" / "$method" / "$statusCode" / "$request." source / "$response." source / "$inputs." name / "$outputs." name / "$steps." name / "$workflows." name / "$sourceDescriptions." name / "$components." name / "$components.parameters." parameter-name)
+parameter-name   = name ; Reuses 'name' rule for parameter names
+source           = ( header-reference / query-reference / path-reference / body-reference )
+header-reference = "header." token
+query-reference  = "query." name
+path-reference   = "path." name
+body-reference   = "body" ["#" json-pointer ]
+
+; https://datatracker.ietf.org/doc/html/rfc6901#section-3
+json-pointer     = *( "/" reference-token )
+reference-token  = *( unescaped / escaped )
+unescaped        = %x00-2E / %x30-7D / %x7F-10FFFF
+                 ; %x2F ('/') and %x7E ('~') are excluded from 'unescaped'
+escaped          = "~" ( "0" / "1" )
+                 ; representing '~' and '/', respectively
+name             = *( CHAR )
+token            = 1*tchar
+tchar            = "!" / "#" / "$" / "%" / "&" / "'" / "*" / "+" / "-" / "."
+                 / "^" /"_" / "`" / "|" / "~" / DIGIT / ALPHA
+
+; https://www.rfc-editor.org/rfc/rfc7159#section-7
+CHAR = unescape /
+    escape (
+        %x22 /          ; "    quotation mark  U+0022
+        %x5C /          ; \    reverse solidus U+005C
+        %x2F /          ; /    solidus         U+002F
+        %x62 /          ; b    backspace       U+0008
+        %x66 /          ; f    form feed       U+000C
+        %x6E /          ; n    line feed       U+000A
+        %x72 /          ; r    carriage return U+000D
+        %x74 /          ; t    tab             U+0009
+        %x75 4HEXDIG )  ; uXXXX                U+XXXX
+escape         = %x5C   ; \
+unescape       = %x20-21 / %x23-5B / %x5D-10FFFF
+
+; https://datatracker.ietf.org/doc/html/rfc5234#appendix-B.1
+HEXDIG         =  DIGIT / "A" / "B" / "C" / "D" / "E" / "F"
+DIGIT          =  %x30-39   ; 0-9
+ALPHA          =  %x41-5A / %x61-7A   ; A-Z / a-z
+```
+
+The `name` identifier is case-sensitive, whereas `token` is not.
+
+The table below provides examples of runtime expressions and examples of their use in a value:
+
+#### Examples
+
+Source Location | example expression  | notes
+---|:---|:---|
+HTTP Method            | `$method`         | The allowable values for the `$method` will be those for the HTTP operation.
+Requested media type | `$request.header.accept`        |
+Request parameter      | `$request.path.id`        | Request parameters MUST be declared in the `parameters` section of the parent operation or they cannot be evaluated. This includes request headers.
+Request body property   | `$request.body#/user/uuid`   | In operations which accept payloads, references may be made to portions of the `requestBody` or the entire body.
+Request URL            | `$url`            |
+Response value         | `$response.body#/status`       |  In operations which return payloads, references may be made to portions of the response body or the entire body.
+Response header        | `$response.header.Server` |  Single header values only are available
+workflow input        | `$inputs.username` or `$workflows.foo.inputs.username` |  Single input values only are available
+Step output value        | `$steps.someStepId.outputs.pets` |  In situations where the output named property return payloads, references may be made to portions of the response body (e.g., `$steps.someStepId.outputs.pets#/0/id`) or the entire body.
+Workflow output value | `$outputs.bar` or `$workflows.foo.outputs.bar` |  In situations where the output named property return payloads, references may be made to portions of the response body (e.g., `$workflows.foo.outputs.mappedResponse#/name`) or the entire body.
+Components parameter | `$components.parameters.foo` | Accesses a foo parameter defined within the Components Object.
+
+Runtime expressions preserve the type of the referenced value.
+Expressions can be embedded into string values by surrounding the expression with `{}` curly braces.
+
+## License
+
+`@swaggerexpert/arazzo-runtime-expression` is licensed under [Apache 2.0 license](https://github.com/swaggerexpert/arazzo-runtime-expression/blob/main/LICENSE).
+`@swaggerexpert/arazzo-runtime-expression` comes with an explicit [NOTICE](https://github.com/swaggerexpert/arazzo-runtime-expression/blob/main/NOTICE) file
+containing additional legal notices and information.

package/SECURITY.md

@@ -0,0 +1,15 @@
+# Security Policy
+
+If you believe you've found an exploitable security issue in @swaggerexpert/arazzo-runtime-expression, please don't create a public issue.
+
+## Supported Versions
+
+| Version | Supported          |
+|---------|--------------------|
+| ^1.0.0  | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+To report a vulnerability please send an email with the details to contact@swaggerexpert.com.
+
+I'll acknowledge receipt of your report ASAP, and set expectations on how I plan to handle it.