@usearazzo/resolver 1.0.1-alpha.2

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,20 @@
+Arazzo Toolkit
+Copyright (c) 2026 UseArazzo
+Arazzo Toolkit is licensed under Apache 2.0 license.
+Copy of the Apache 2.0 license can be found in `LICENSE` file.
+
+jentic/jentic-arazzo-tools
+Copyright (c) 2026 Jentic
+Jentic Arazzo Tools is licensed under Apache 2.0 license.
+Copy of the Apache 2.0 license can be found in `LICENSE` file.
+Arazzo Tookit project was founded on Jentic Arazzo Tools from commit c696c9.
+Arazzo Toolkit includes modifications by members of UseArazzo GitHub organization.
+All such modifications are licensed under the Apache License, Version 2.0.
+
+swagger-js/swagger-client
+Copyright 2020-2021 SmartBear Software Inc.
+swagger-client is being pre-processed by our build process
+and swagger-client build artifact is included in npm distribution.
+It's not dynamically linked via npm dependency management.
+swagger-client is licensed under Apache 2.0 license.
+Copy of the Apache 2.0 license can be found in `LICENSE` file.

package/README.md

@@ -0,0 +1,99 @@
+<h1 align="center">@usearazzo/resolver</h1>
+
+<p align="center">
+  Reference resolver for <a href="https://spec.openapis.org/arazzo/latest.html">Arazzo</a> and <a href="https://spec.openapis.org/oas/latest.html">OpenAPI</a> documents:
+  bundle, dereference, and resolve.
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@usearazzo/resolver"><img src="https://img.shields.io/npm/v/@usearazzo/resolver.svg" alt="npm version"></a>
+  <a href="https://github.com/usearazzo/arazzo-toolkit/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" alt="License: Apache 2.0"></a>
+</p>
+
+<p align="center">
+  <a href="https://usearazzo.com"><img alt="UseArazzo" width="96" src="https://usearazzo.com/assets/images/logos/usearazzo-logo.svg"></a>
+</p>
+
+---
+
+## What it does
+
+Arazzo and OpenAPI documents contain references, to other parts of the same document and to other documents. This package handles those references in three ways, all on [SpecLynx ApiDOM](https://github.com/speclynx/apidom):
+
+- **Bundle.** `bundleArazzo` and `bundleOpenAPI` pull external documents into the entry document's components, producing a single *compound document* that still reads like the original: external JSON Schema resources land in `components.inputs` in Arazzo; Reference Object targets land in the matching `components` field and external Path Items in `components.pathItems` in OpenAPI. References are repointed to the hoisted components.
+- **Dereference.** `dereferenceArazzo` and `dereferenceOpenAPI` replace every reference with the content it points at: JSON Schema References and Reusable Object references (`$components.*`) in Arazzo; Reference Objects, Path Item references, and schema references in OpenAPI. The result is one self-contained directed graph: a Directed Acyclic Graph (DAG), or a Directed Cyclic Graph (DCG) when references form cycles. Arazzo source descriptions can be dereferenced along with the entry document.
+- **Resolve.** `resolveArazzo` and `resolveOpenAPI` fetch the document and every external document its references reach, and return the `ReferenceSet` listing them all, parsed. Nothing is replaced; this is the reference graph itself.
+
+## At a glance
+
+| Function | Takes | Returns |
+|---|---|---|
+| `bundleArazzo`, `bundleOpenAPI` | path or URL | `ParseResultElement` holding one compound document |
+| `dereferenceArazzo`, `dereferenceOpenAPI` | path or URL | `ParseResultElement` with every reference replaced inline |
+| `dereferenceArazzoElement`, `dereferenceOpenAPIElement` | a parsed document (`ParseResultElement`), or a single element inside it, such as a workflow or a path item | the same element, dereferenced |
+| `resolveArazzo`, `resolveOpenAPI` | path or URL | `ReferenceSet` of every document reached |
+| `resolveArazzoElement`, `resolveOpenAPIElement` | a parsed document (`ParseResultElement`), or a single element inside it, such as a workflow or a path item | `ReferenceSet` of every document reached |
+
+Each operation fails through its own typed error, `BundleError`, `DereferenceError`, or `ResolveError`, with the underlying error on `cause`.
+
+## Installation
+
+```sh
+npm install @usearazzo/resolver
+```
+
+Ships ESM and CommonJS builds with TypeScript declarations. Requires Node.js 20.10 or newer.
+
+## Usage
+
+```js
+import { bundleArazzo, dereferenceArazzo, resolveArazzo } from '@usearazzo/resolver';
+
+const bundled = await bundleArazzo('./adopt-a-pet.arazzo.yaml'); // ParseResultElement
+const dereferenced = await dereferenceArazzo('./adopt-a-pet.arazzo.yaml'); // ParseResultElement
+const refSet = await resolveArazzo('./adopt-a-pet.arazzo.yaml'); // ReferenceSet
+```
+
+The OpenAPI source descriptions have their own counterparts:
+
+```js
+import { bundleOpenAPI, dereferenceOpenAPI, resolveOpenAPI } from '@usearazzo/resolver';
+
+const bundled = await bundleOpenAPI('./petstore.openapi.yaml'); // ParseResultElement
+const dereferenced = await dereferenceOpenAPI('./petstore.openapi.yaml'); // ParseResultElement
+const refSet = await resolveOpenAPI('./petstore.openapi.yaml'); // ReferenceSet
+```
+
+`dereferenceArazzoElement`, `resolveArazzoElement` and their OpenAPI counterparts take a document you already parsed. When that document came from a string or an object, it has no URL of its own, so pass `resolve.baseURI` explicitly:
+
+```js
+import { parseArazzo } from '@usearazzo/parser';
+import { dereferenceArazzoElement } from '@usearazzo/resolver';
+
+const parseResult = await parseArazzo(yamlText);
+const dereferenced = await dereferenceArazzoElement(parseResult, {
+  resolve: { baseURI: 'https://example.com/adopt-a-pet.arazzo.yaml' },
+});
+```
+
+Everything else, from options and source descriptions to result shapes and error handling, is in the API reference:
+
+**[API reference](https://usearazzo.com/docs/resolver/)**
+
+## Supported versions
+
+Arazzo documents:
+
+- [Arazzo 1.0.0](https://spec.openapis.org/arazzo/v1.0.0)
+- [Arazzo 1.0.1](https://spec.openapis.org/arazzo/v1.0.1)
+- [Arazzo 1.1.0](https://spec.openapis.org/arazzo/v1.1.0)
+
+OpenAPI documents, as source descriptions or on their own:
+
+- [OpenAPI 2.0](https://spec.openapis.org/oas/v2.0)
+- [OpenAPI 3.0.x](https://spec.openapis.org/oas/v3.0.4)
+- [OpenAPI 3.1.x](https://spec.openapis.org/oas/v3.1.2)
+
+## Part of the Arazzo Toolkit
+
+`@usearazzo/resolver` is the reference layer of the [arazzo-toolkit](https://github.com/usearazzo/arazzo-toolkit) monorepo, beside [@usearazzo/parser](https://github.com/usearazzo/arazzo-toolkit/tree/main/packages/parser#readme), [@usearazzo/validator](https://github.com/usearazzo/arazzo-toolkit/tree/main/packages/validator#readme), and [@usearazzo/runner](https://github.com/usearazzo/arazzo-toolkit/tree/main/packages/runner#readme). Questions and ideas go to [GitHub Discussions](https://github.com/orgs/usearazzo/discussions).