feat(apidom-ns-arazzo-1): add support for Arazzo 1.1

[frankkilcommins]

Update apidom-ns-arazzo-1 to support the changes introduced in Arazzo 1.1

[char0n]

Arazzo 1.0.1 → 1.1.0 changelog

Computed from git diff of versions/1.0.1.md vs versions/1.1.0.md and cross-checked against the 1.1.0 release notes. Released 2026-05-17. Every release-note item is accounted for below; PR numbers refer to OAI/Arazzo-Specification.

Arazzo Object

• NEW $self (string, URI-reference per RFC 3986 §4.1) — canonical identity of the document and its base URI for resolving relative references. MUST NOT contain a fragment. May itself be relative (resolved against the retrieval URI first). — chore(deps-dev): bump eslint-plugin-mocha from 11.3.0 to 12.0.2 #451

Source Description Object

• type: new allowed value asyncapi (alongside openapi, arazzo). — feat(reference): add Arazzo 1 bundle strategy #367

Workflow Object

• outputs: Map[string, {expression}] → Map[string, {expression} | Selector Object]. — chore(deps-dev): bump eslint from 9.39.4 to 10.7.0 #409

Step Object

• NEW channelPath (string) — source description + JSON Pointer to an AsyncAPI channel; mutually exclusive with operationId/workflowId. — feat(reference): add Arazzo 1 bundle strategy #367
• NEW action (string, send | receive) — AsyncAPI steps only. — feat(reference): add Arazzo 1 bundle strategy #367
• NEW correlationId (string) — AsyncAPI receive steps only. — feat(reference): add Arazzo 1 bundle strategy #367
• NEW timeout (integer, milliseconds). — feat(reference): add Arazzo 1 bundle strategy #367
• NEW dependsOn ([string] of stepIds). Cross-workflow form $workflows.<id>.steps.<stepId>, cross-document form $sourceDescriptions.<name>.<workflowId>.steps.<stepId>. — feat(reference): add Arazzo 1 bundle strategy #367
• outputs: widened to {expression} | Selector Object. — chore(deps-dev): bump eslint from 9.39.4 to 10.7.0 #409
• successCriteria: if present MUST contain ≥ 1 Criterion Object.
• New prose: Step Dependencies and Execution Order (output references are implicit dependencies; SHOULD error on forward references in sequential workflows), Defining Success for Asynchronous Steps.

Parameter Object

• in: new value querystring (OpenAPI 3.2 concept; value is the whole query string). — feat(datamodel): support Metadata in cloneDeep and cloneShallow #443
• in may now be omitted when a success/failure action (not only a step) targets a workflowId. — chore(deps-dev): bump typescript-eslint from 8.64.0 to 8.65.0 #416
• value: Any | {expression} → Any | {expression} | Selector Object. — chore(deps-dev): bump eslint from 9.39.4 to 10.7.0 #409

Success Action Object / Failure Action Object

• NEW parameters ([Parameter Object | Reusable Object]) on both — passed to the workflow referenced by workflowId; in MUST NOT be used; no duplicates. — chore(deps-dev): bump typescript-eslint from 8.64.0 to 8.65.0 #416

Criterion Object

• type now references the renamed Expression Type Object.
• New normative sections: Runtime Expressions in Conditions (for regex/jsonpath/xpath, runtime expressions MUST be embedded as {$expr} and substituted before evaluation), Condition Evaluation (per-type truthiness: simple / regex / JSONPath non-empty nodelist / XPath EBV), Evaluation Errors (→ fail), Multiple Criteria (logical AND). Simple-condition semantics tightened (null only equals null, numeric-string coercion, case-insensitive strings). — apidom-overlay: applyOverlay mutates a ParseResultElement target #475

Criterion Expression Type Object → Expression Type Object (renamed)

• Shared by Criterion Object and Selector Object.
• type: jsonpath | xpath | jsonpointer (new).
• version: JSONPath adds rfc9535; XPath adds xpath-31; JSON Pointer rfc6901. Explicit defaults: rfc9535 / xpath-31 / rfc6901.
• Anchors renamed criterionExpressionType → expressionType, criterionExpressionVersion → expressionVersion. — chore(deps-dev): bump eslint from 9.39.4 to 10.7.0 #409

Selector Object — NEW — #409

Field	Type
context	{expression}	REQUIRED, must evaluate to structured data
selector	string	REQUIRED — JSONPath / XPath / JSON Pointer
type	string | Expression Type Object	REQUIRED

Allowed in: workflow outputs, step outputs, parameter value, request body payload (nested anywhere), payload replacement value.

Request Body Object

• payload may contain Selector Objects in addition to runtime expressions. — chore(deps-dev): bump eslint from 9.39.4 to 10.7.0 #409

Payload Replacement Object

• target: may now be JSONPath in addition to JSON Pointer / XPath.
• NEW targetSelectorType (string | Expression Type Object); defaults: JSON Pointer for application/json, XPath for XML media types.
• value: widened to Any | {expression} | Selector Object. — chore(deps-dev): bump eslint from 9.39.4 to 10.7.0 #409

Runtime Expressions (ABNF rewritten) — #454, #325, #367, #451

• New roots: $message. source (header., query., path., body, payload) and $self.
• payload-reference = "payload" ["#" json-pointer] added to the shared source rule (so $request.payload is grammatically valid — see upstream chore(deps-dev): bump @types/node from 26.2.0 to 26.3.0 #501).
• $inputs. / $outputs. formally allow a #json-pointer suffix.
• $steps. formalized: step-id ".outputs." output-name ["#" json-pointer].
• $workflows. formalized: workflow-id "." ("inputs"/"outputs") "." name ["#" json-pointer].
• $sourceDescriptions. formalized: source-name "." 1*CHAR, with new resolution priority: (1) operationId/workflowId, (2) Source Description field name (url, type, …).
• $components. formalized: ("parameters"/"successActions"/"failureActions") "." component-name (1.0.1 only spelled out parameters).
• New identifier-strict ([A-Za-z0-9_-]+, no dots) vs identifier (dots allowed).
• unescaped in json-pointer now also excludes { / }; new expression-string / embedded-expression rules define {...} embedding.
• Serialization rules for embedded expressions: scalars → string; parsed objects/arrays → JSON (RFC 8259); already-string values as-is.

Document-level / parsing semantics (new prose) — #451

• Parsing Documents: whole-document parsing required before reference resolution; fragmentary parsing is undefined behaviour.
• Identity-Based Referencing: references to another Arazzo document MUST use its $self if present; absolute source urls resolved by identity, not location.
• Relative References in Arazzo Description URIs: base URI algorithm ($self → encapsulating entity → retrieval URI → application default); fragment resolution (JSON Pointer; $anchor support in inputs schemas).
• Relative References in API URLs (renamed section): API endpoint URL comes from the OpenAPI Server Object, not the Arazzo base URI.
• Appendix B (new): worked examples of base-URI determination.

Editorial / non-semantic

• Tables reformatted, heading levels fixed, example headings reworded, formats table pivoted.
• Example fixes: $steps.loginUser → $steps.loginStep (feat(playground): add overlay 1.x parsing support #358); "{$statusCode == 401}" → "$statusCode == 401" (Unreachable JSON Pointer branch in Schema Object dereference (openapi-3-1, arazzo-1) #362); JSONPath examples updated to RFC 9535 (fix(overlay): clone the parse result under immutable apply #478, chore(deps): bump @mui/icons-material from 7.3.9 to 9.1.1 #339).

Schema-only changes (not in the markdown)

• chore(deps-dev): bump @microsoft/api-extractor from 7.58.8 to 7.58.9 #343 — removed the rule making retryAfter required when type: retry.
• chore(deps-dev): bump @babel/preset-typescript from 7.29.7 to 8.0.1 #348 — removed retry from the enum forcing stepId/workflowId; retry without a target is valid.
• fix(overlay): honour the immutable default for partial options #476 — added schema validation fixtures for async / OpenAPI / workflow steps (useful as test fixtures for us).

AsyncAPI scope note

1.1.0 supports AsyncAPI v3 only. Upstream #270 originally aimed at both v2 and v3, but the final proposal (Oct 2025) and PR #367 explicitly scoped to "initial support for AsyncAPI v3.0": the Step Object links to the v3 Operations Object, action: send|receive is v3 terminology, and the only example is asyncapi: 3.0.0. No text addresses v2 mapping. Full reference resolution into asyncapi source descriptions would therefore need AsyncAPI 3 support in ApiDOM (we currently only have apidom-ns-asyncapi-2); that is a separate track from the namespace changes below.

Implications for apidom-ns-arazzo-1

1. New elements: Selector; rename CriterionExpressionType → ExpressionType (keep alias for 1.0 compatibility).
2. New fields: Arazzo $self; Step channelPath / action / correlationId / timeout / dependsOn; SuccessAction & FailureAction parameters; PayloadReplacement targetSelectorType.
3. Union-typed positions needing Selector-vs-plain-object discrimination in refractor visitors: workflow/step outputs values, parameter value, payload-replacement value, request-body payload (recursive).
4. Enum widening: source type += asyncapi; parameter in += querystring; expression-type type += jsonpointer, version += rfc9535 / xpath-31 / rfc6901.
5. Runtime expression grammar: $message.*, $self, $components.successActions|failureActions, #json-pointer on $inputs/$outputs, embedded {...}; plus the dependsOn reference forms.
6. apidom-reference: $self-based base URI and identity-based resolution; asyncapi source descriptions (blocked on AsyncAPI 3 support).
7. Version detection: arazzo: 1.1.0 in parser adapters / media types.

[char0n]

Namespace & parser adapters done. Playground & apidom-reference to go.