@speclynx/apidom-parser 1.12.1

package/LICENSES/BSD-3-Clause.txt

@@ -0,0 +1,26 @@
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+1. Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/LICENSES/MIT.txt

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) <year> <copyright holders>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/NOTICE

@@ -0,0 +1,65 @@
+Additional Notices for SpecLynx Distribution
+Copyright 2025 SpecLynx
+This distribution is known as "SpecLynx ApiDOM". It is a fork of the ApiDOM project maintained by SmartBear.
+This distribution includes modifications by SpecLynx.
+All such modifications are licensed under the Apache License, Version 2.0.
+A copy of the Apache 2.0 license can be found in `LICENSES/Apache-2.0.txt`.
+
+ApiDOM
+Copyright 2020 SmartBear Software Inc.
+ApiDOM is licensed under Apache 2.0 license.
+Copy of the Apache 2.0 license can be found in `LICENSES/Apache-2.0.txt` file.
+
+json-schema-ref-parser
+Copyright (c) 2015 James Messinger
+File packages/apidom-reference/src/util/url.ts (the file) was originally created under MIT license in https://github.com/APIDevTools/json-schema-ref-parser repository.
+The file has been copied into this project and modified. All modifications are licensed under Apache 2.0 License.
+Copy of the MIT license can be found in `LICENSES/MIT.txt` file.
+
+graphql-js
+Copyright (c) GraphQL Contributors
+File packages/apidom-ast/src/traversal/visitor.ts (the file) was originally created under MIT license in https://github.com/graphql/graphql-js repository.
+The file has been copied into this project and modified. All modifications are licensed under Apache 2.0 License.
+Copy of the MIT license can be found in `LICENSES/MIT.txt` file.
+
+babel-plugin-add-import-extension
+Copyright (c) 2019 Karl Prieb
+File scripts/babel-plugin-add-import-extension.cjs (the file) was originally created under MIT license in https://codeberg.org/karl/babel-plugin-add-import-extension.
+The file has been copied into this project and modified. All modifications are licensed under Apache 2.0 License.
+Copy of the MIT license can be found in `LICENSES/MIT.txt` file.
+
+refract-spec
+Copyright (c) 2015 refractproject
+Specific texts in README.md (the file) were originally created under MIT license in https://github.com/refractproject/refract-spec repository.
+Specific texts have been copied into this project and modified. All modifications are licensed under Apache 2.0 License.
+Copy of the MIT license can be found in `LICENSES/MIT.txt` file.
+
+api-elements
+Copyright (c) 2015 Apiary Inc.
+Specific texts in README.md (the file) were originally created under MIT license in https://github.com/refractproject/refract-spec repository.
+Specific texts have been copied into this project and modified. All modifications are licensed under Apache 2.0 License.
+Copy of the MIT license can be found in `LICENSES/MIT.txt` file.
+
+deepmerge
+Copyright (c) 2012 James Halliday, Josh Duff, and other contributors
+- File packages/apidom-core/src/deepmerge.ts contains algorithms that we originally created
+  in https://github.com/TehShrike/deepmerge/blob/master/index.js to handle deep merging of JavaScript Objects and Arrays.
+  These algorithms have been reverse engineered and adapted to support deep merging of ApiDOM structures.
+- File packages/apidom-core/test/deepmerge.ts contains tests and fixtures that were originally created
+  in https://github.com/TehShrike/deepmerge/blob/master/test/merge.js to test deep merging of JavaScript Objects and Arrays.
+  These tests have been adapted to support testing deep merging of ApiDOM structures.
+- File packages/apidom-core/README.md contains text fragments that were originally created
+  in https://github.com/TehShrike/deepmerge/blob/master/readme.md to document deepmerge library.
+  These text fragments have been amended to describe merging of ApiDOM structures.
+Copy of the MIT license can be found in `LICENSES/MIT.txt` file.
+All modifications are licensed under Apache 2.0 License.
+
+---
+
+If the SPDX-FileCopyrightText and SPDX-License-Identifier tags are not present in the file,
+it is assumed that these tags have following implicit value:
+
+SPDX-FileCopyrightText: Copyright 2025 SpecLynx
+SPDX-FileCopyrightText: Copyright 2020-2021 SmartBear Software Inc.
+SPDX-License-Identifier: Apache-2.0
+

package/README.md

@@ -0,0 +1,139 @@
+# @speclynx/apidom-parser
+
+`@speclynx/apidom-parser` consumes parser adapters and provides unified API for parsing.
+
+## Installation
+
+You can install this package via [npm CLI](https://docs.npmjs.com/cli) by running the following command:
+
+```sh
+ $ npm install @speclynx/apidom-parser
+```
+
+## Mounting parser adapters
+
+ApiDOM parser can consume any parser adapter as long as its shape is compatible.
+In order for parsing adapter to be compatible it must be a [JavaScript Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
+containing following 4 properties (2 required, 2 optional):
+
+Property | Type | Default | Description
+--- | --- | --- | ---
+<a name="detect"></a>`detect` | `(source: String) => Boolean` | `undefined` | This method is called from a parser with a single argument of string that is going to be parsed. Returns a boolean value indicating if the source string was recognized by the parser adapter. It can be defined either as [synchronous](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Asynchronous/Introducing#synchronous_javascript) or [asynchronous function](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Asynchronous/Introducing#asynchronous_javascript).
+<a name="mediaTypes"></a>`mediaTypes` | `String[]` | `undefined` | This is a property of parser adapter that contains list of supported [media types](https://www.iana.org/assignments/media-types/media-types.xhtml) by this parser adapter. Note that other media types that are not officially registered by [iana](https://www.iana.org/) can be used as well.
+<a name="namespace"></a>`namespace` | `Namespace` | | **REQUIRED** An ApiDOM namespace instance.
+<a name="parse"></a>`parse` | `(source: String, options = {}) => ParseResult` |  | **REQUIRED** This method should contain logic of actual parsing and should return instance of [ParseResult Element](https://github.com/speclynx/apidom/blob/main/packages/apidom/src/elements/ParseResult.ts).
+
+Now, let's mount some adapters:
+
+```js
+import ApiDOMParser from '@speclynx/apidom-parser';
+import * as jsonParserAdapter from '@speclynx/apidom-parser-adapter-json';
+import * as yamlParserAdapter from '@speclynx/apidom-parser-adapter-yaml-1-2';
+
+const parser = new ApiDOMParser();
+
+parser.use(jsonParserAdapter);
+parser.use(yamlParserAdapter);
+```
+
+## Finding an appropriate ApiDOM namespace
+
+ApiDOM parser contains logic of mapping a `source string` + `mediaType` to appropriate ApiDOM namespace.
+It will return either [base namespace instance](https://github.com/speclynx/apidom/tree/main/packages/apidom#base-namespace) or a specific one like [OpenApi 3.1.0](https://github.com/speclynx/apidom/tree/main/packages/apidom-ns-openapi-3-1#openapi-310-namespace) or [AsyncApi 2.6.0](https://github.com/speclynx/apidom/tree/main/packages/apidom-ns-asyncapi-2#asyncapi-2xy-namespace).
+
+```js
+import ApiDOMParser from '@speclynx/apidom-parser';
+import * as jsonParserAdapter from '@speclynx/apidom-parser-adapter-json';
+import * as yamlParserAdapter from '@speclynx/apidom-parser-adapter-yaml';
+
+const parser = new ApiDOMParser();
+
+parser.use(jsonParserAdapter);
+parser.use(yamlParserAdapter);
+
+const namespace = await parser.findNamespace('{"prop", "value"}', { mediaType: 'application/json' });
+```
+
+## Finding an appropriate media type
+
+ApiDOM parser contains logic of mapping a `source string` to appropriate media type.
+
+```js
+import ApiDOMParser from '@speclynx/apidom-parser';
+import * as jsonParserAdapter from '@speclynx/apidom-parser-adapter-json';
+import * as yamlParserAdapter from '@speclynx/apidom-parser-adapter-yaml';
+
+const parser = new ApiDOMParser();
+
+parser.use(jsonParserAdapter);
+parser.use(yamlParserAdapter);
+
+await parser.findMediaType('{"prop", "value"}'); // => 'application/json'
+await parser.findMediaType('key: value'); // => 'application/yaml'
+```
+
+
+## Parsing
+
+ApiDOM parser doesn't contain any parsing logic. It uses parser adapter to provide the parsing logic for it.
+
+```js
+import ApiDOMParser from '@speclynx/apidom-parser';
+import * as jsonParserAdapter from '@speclynx/apidom-parser-adapter-json';
+import * as yamlParserAdapter from '@speclynx/apidom-parser-adapter-yaml';
+
+const parser = new ApiDOMParser();
+
+parser.use(jsonParserAdapter);
+parser.use(yamlParserAdapter);
+
+const parseResult = await parser.parse('{"prop", "value"}', { mediaType: 'application/json' });
+```
+
+`parse` method consumes various options as a second argument. Here is a list of options recognized by all parser adapters:
+
+Option | Type | Default | Description
+--- | --- | --- | ---
+<a name="mediaType"></a>`mediaType` | `String` | `undefined` | Indicate to parser that the source string should be understood and parsed as provided by this option.
+<a name="sourceMap"></a>`sourceMap` | `Boolean` | `false` | Indicate to parser whether to generate source maps.
+
+All unrecognized arbitrary options will be further passed to underlying parser adapter.
+
+#### Parsing errors
+
+If no parser adapter was mounted before the parsing, calling `parse` method will result in Error.
+
+```js
+import ApiDOMParser from '@speclynx/apidom-parser';
+
+const parser = new ApiDOMParser();
+const parseResult = await parser.parse('{"prop", "value"}', { mediaType: 'application/json' });
+// => ParserError('Source did not match any registered parsers')
+```
+
+Along with this, if underlying parser adapter produces an error, this error is propagated to ApiDOM
+parser.
+
+#### Word on detect vs mediaTypes
+
+We strongly encourage users of this package to use explicit `mediaType` option when calling
+`parse` method. If `mediaType` is not provided the parser will fallback to calling `detect` method
+on parser adapter to indicate if the source string can be parsed by a parser adapter. As there are
+ambiguities and common forms in different formats like JSON vs YAML, it's not always possible to
+detect the format correctly and choose appropriate parser adapter.
+
+Here is an example of YAML fragment:
+
+```yaml
+{"prop": "value"}
+```
+
+This is a valid YAML, but it's also a valid JSON. It's not possible for parser adapter to properly
+detect which format was intended by the author.
+
+#### Word on ordering
+
+If multiple parser adapters contain identical `mediaTypes` or `detect` logic then for the purposes
+of [parsing](#parsing) or [finding an appropriate namespace](#finding-an-appropriate-apidom-namespace)
+the order of [mounting the parser adapters](#mounting-parser-adapters) matter. The first parser adapter that matches its `mediaTypes`
+or returns `true` from a `detect` is used.