@swaggerexpert/arazzo-runtime-expression 2.0.1 → 2.0.2

package/README.md

@@ -20,7 +20,7 @@ It supports Runtime Expressions defined in following Arazzo specification versio
 <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" />
+        <img src="https://raw.githubusercontent.com/swaggerexpert/arazzo-runtime-expression/main/assets/tidelift.webp" 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">
@@ -302,9 +302,9 @@ source-descriptions-reference   = 1*CHAR
 
 ; Secondary grammar for parsing $components name part
 ; Format: {field}.{subField}
-; Allowed fields: inputs, parameters, successActions, failureActions
+; Allowed fields: parameters, successActions, failureActions
 components-name      = components-field "." components-sub-field
-components-field     = "inputs" / "parameters" / "successActions" / "failureActions"
+components-field     = "parameters" / "successActions" / "failureActions"
 components-sub-field = 1*(ALPHA / DIGIT / "." / "-" / "_")
 
 ; https://datatracker.ietf.org/doc/html/rfc6901#section-3

package/cjs/grammar.cjs

@@ -11,13 +11,13 @@ function grammar() {
   // SUMMARY
   //      rules = 36
   //       udts = 0
-  //    opcodes = 213
+  //    opcodes = 212
   //        ---   ABNF original opcodes
   //        ALT = 21
   //        CAT = 24
   //        REP = 16
   //        RNM = 55
-  //        TLS = 73
+  //        TLS = 72
   //        TBS = 12
   //        TRG = 12
   //        ---   SABNF superset opcodes
@@ -847,21 +847,17 @@ function grammar() {
   this.rules[22].opcodes = [];
   this.rules[22].opcodes[0] = {
     type: 1,
-    children: [1, 2, 3, 4]
+    children: [1, 2, 3]
   }; // ALT
   this.rules[22].opcodes[1] = {
-    type: 7,
-    string: [105, 110, 112, 117, 116, 115]
-  }; // TLS
-  this.rules[22].opcodes[2] = {
     type: 7,
     string: [112, 97, 114, 97, 109, 101, 116, 101, 114, 115]
   }; // TLS
-  this.rules[22].opcodes[3] = {
+  this.rules[22].opcodes[2] = {
     type: 7,
     string: [115, 117, 99, 99, 101, 115, 115, 97, 99, 116, 105, 111, 110, 115]
   }; // TLS
-  this.rules[22].opcodes[4] = {
+  this.rules[22].opcodes[3] = {
     type: 7,
     string: [102, 97, 105, 108, 117, 114, 101, 97, 99, 116, 105, 111, 110, 115]
   }; // TLS
@@ -1280,9 +1276,9 @@ function grammar() {
     str += "\n";
     str += "; Secondary grammar for parsing $components name part\n";
     str += "; Format: {field}.{subField}\n";
-    str += "; Allowed fields: inputs, parameters, successActions, failureActions\n";
+    str += "; Allowed fields: parameters, successActions, failureActions\n";
     str += "components-name      = components-field \".\" components-sub-field\n";
-    str += "components-field     = \"inputs\" / \"parameters\" / \"successActions\" / \"failureActions\"\n";
+    str += "components-field     = \"parameters\" / \"successActions\" / \"failureActions\"\n";
     str += "components-sub-field = 1*(ALPHA / DIGIT / \".\" / \"-\" / \"_\")\n";
     str += "\n";
     str += "; https://datatracker.ietf.org/doc/html/rfc6901#section-3\n";

package/es/grammar.mjs

@@ -7,13 +7,13 @@ export default function grammar() {
   // SUMMARY
   //      rules = 36
   //       udts = 0
-  //    opcodes = 213
+  //    opcodes = 212
   //        ---   ABNF original opcodes
   //        ALT = 21
   //        CAT = 24
   //        REP = 16
   //        RNM = 55
-  //        TLS = 73
+  //        TLS = 72
   //        TBS = 12
   //        TRG = 12
   //        ---   SABNF superset opcodes
@@ -843,21 +843,17 @@ export default function grammar() {
   this.rules[22].opcodes = [];
   this.rules[22].opcodes[0] = {
     type: 1,
-    children: [1, 2, 3, 4]
+    children: [1, 2, 3]
   }; // ALT
   this.rules[22].opcodes[1] = {
-    type: 7,
-    string: [105, 110, 112, 117, 116, 115]
-  }; // TLS
-  this.rules[22].opcodes[2] = {
     type: 7,
     string: [112, 97, 114, 97, 109, 101, 116, 101, 114, 115]
   }; // TLS
-  this.rules[22].opcodes[3] = {
+  this.rules[22].opcodes[2] = {
     type: 7,
     string: [115, 117, 99, 99, 101, 115, 115, 97, 99, 116, 105, 111, 110, 115]
   }; // TLS
-  this.rules[22].opcodes[4] = {
+  this.rules[22].opcodes[3] = {
     type: 7,
     string: [102, 97, 105, 108, 117, 114, 101, 97, 99, 116, 105, 111, 110, 115]
   }; // TLS
@@ -1276,9 +1272,9 @@ export default function grammar() {
     str += "\n";
     str += "; Secondary grammar for parsing $components name part\n";
     str += "; Format: {field}.{subField}\n";
-    str += "; Allowed fields: inputs, parameters, successActions, failureActions\n";
+    str += "; Allowed fields: parameters, successActions, failureActions\n";
     str += "components-name      = components-field \".\" components-sub-field\n";
-    str += "components-field     = \"inputs\" / \"parameters\" / \"successActions\" / \"failureActions\"\n";
+    str += "components-field     = \"parameters\" / \"successActions\" / \"failureActions\"\n";
     str += "components-sub-field = 1*(ALPHA / DIGIT / \".\" / \"-\" / \"_\")\n";
     str += "\n";
     str += "; https://datatracker.ietf.org/doc/html/rfc6901#section-3\n";

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "2.0.1",
+  "version": "2.0.2",
   "description": "Arazzo Runtime expressions parser, validator and extractor.",
   "main": "./cjs/index.cjs",
   "types": "./types/index.d.ts",

package/types/index.d.ts

@@ -14,7 +14,7 @@ export interface CSTNode {
  * Translator base interface
  */
 export interface Translator {
-  getTree(): CSTNode | string | undefined;
+  getTree(): CSTNode | ASTNode | string | undefined;
 }
 
 /**
@@ -29,7 +29,8 @@ export class CSTTranslator implements Translator {
 /**
  * XMLTranslator - Produces XML string representation
  */
-export class XMLTranslator extends CSTTranslator {
+export class XMLTranslator implements Translator {
+  constructor();
   getTree(): string;
 }
 
@@ -203,7 +204,7 @@ export interface SourceDescriptionsExpression {
  */
 export interface ComponentsExpression {
   readonly type: 'ComponentsExpression';
-  readonly field: 'inputs' | 'parameters' | 'successActions' | 'failureActions';
+  readonly field: 'parameters' | 'successActions' | 'failureActions';
   readonly subField: string;
 }
 
@@ -227,7 +228,8 @@ export type ASTNode =
  * ASTTranslator - Produces Abstract Syntax Tree
  * Suitable for implementations that need to analyze or evaluate expressions.
  */
-export class ASTTranslator extends CSTTranslator {
+export class ASTTranslator implements Translator {
+  constructor();
   getTree(): ASTNode;
 }
 
@@ -258,36 +260,65 @@ export class Stats {
 /**
  * Parse options
  */
-export interface ParseOptions {
+export interface ParseOptions<T extends Translator | null = Translator | null> {
   readonly stats?: boolean;
   readonly trace?: boolean;
-  readonly translator?: Translator | null;
+  readonly translator?: T;
+}
+
+/**
+ * Parse result metadata
+ */
+export interface ParseResultMeta {
+  readonly success: boolean;
+  readonly state: number;
+  readonly stateName: string;
+  readonly length: number;
+  readonly matched: number;
+  readonly maxMatched: number;
+  readonly maxTreeDepth: number;
+  readonly nodeHits: number;
 }
 
 /**
  * Parse result
  */
-export interface ParseResult {
-  readonly result: {
-    readonly success: boolean;
-    readonly state: number;
-    readonly stateName: string;
-    readonly length: number;
-    readonly matched: number;
-    readonly maxMatched: number;
-    readonly maxTreeDepth: number;
-    readonly nodeHits: number;
-  };
-  readonly tree: CSTNode | string | undefined;
+export interface ParseResult<T = CSTNode | ASTNode | string | undefined> {
+  readonly result: ParseResultMeta;
+  readonly tree: T;
   readonly stats: Stats | undefined;
   readonly trace: Trace | undefined;
 }
 
 /**
- * Parse a runtime expression
+ * Parse a runtime expression with ASTTranslator
+ * https://spec.openapis.org/arazzo/latest.html#runtime-expressions
+ */
+export function parse(runtimeExpression: string, options: ParseOptions<ASTTranslator>): ParseResult<ASTNode>;
+
+/**
+ * Parse a runtime expression with XMLTranslator
+ * https://spec.openapis.org/arazzo/latest.html#runtime-expressions
+ */
+export function parse(runtimeExpression: string, options: ParseOptions<XMLTranslator>): ParseResult<string>;
+
+/**
+ * Parse a runtime expression with CSTTranslator
+ * https://spec.openapis.org/arazzo/latest.html#runtime-expressions
+ */
+export function parse(runtimeExpression: string, options: ParseOptions<CSTTranslator>): ParseResult<CSTNode>;
+
+/**
+ * Parse a runtime expression with null translator (validation only)
+ * https://spec.openapis.org/arazzo/latest.html#runtime-expressions
+ */
+export function parse(runtimeExpression: string, options: ParseOptions<null>): ParseResult<undefined>;
+
+/**
+ * Parse a runtime expression with default ASTTranslator
  * https://spec.openapis.org/arazzo/latest.html#runtime-expressions
  */
-export function parse(runtimeExpression: string, options?: ParseOptions): ParseResult;
+export function parse(runtimeExpression: string, options?: ParseOptions): ParseResult<ASTNode>;
 
 /**
  * Test if a string is a valid runtime expression