@speclynx/apidom-ns-arazzo-1 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,206 @@
+# @speclynx/apidom-ns-arazzo-1
+
+`@speclynx/apidom-ns-arazzo-1` contains ApiDOM namespace specific to **Arazzo 1.x.y specification**, supporting the following 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)
+
+## Installation
+
+You can install this package via [npm CLI](https://docs.npmjs.com/cli) by running the following command:
+
+```sh
+ $ npm install @speclynx/apidom-ns-arazzo-1
+```
+
+## Arazzo 1.0.1 namespace
+
+Arazzo 1.0.1 namespace consists of [number of elements](https://github.com/speclynx/apidom/tree/main/packages/apidom-ns-arazzo-1/src/elements) implemented on top
+of [primitive ones](https://github.com/refractproject/minim/tree/master/lib/primitives).
+
+```js
+import { createNamespace } from '@speclynx/apidom-core';
+import arazzo1Namespace from '@speclynx/apidom-ns-arazzo-1';
+
+const namespace = createNamespace(arazzo1Namespace);
+
+const objectElement = new namespace.elements.Object();
+const arazzoElement = new namespace.elements.ArazzoSpecification1();
+```
+
+When namespace instance is created in this way, it will extend the base namespace
+with the namespace provided as an argument.
+
+Elements from the namespace can also be used directly by importing them.
+
+```js
+import { ArazzoSpecification1Element, InfoElement } from '@speclynx/apidom-ns-arazzo-1';
+
+const infoElement = new InfoElement();
+const arazzoElement = new ArazzoSpecification1Element();
+```
+
+## Predicates
+
+This package exposes [predicates](https://github.com/speclynx/apidom/blob/main/packages/apidom-ns-arazzo-1/src/predicates.ts)
+for all higher order elements that are part of this namespace.
+
+```js
+import { isArazzoSpecification1Element, ArazzoSpecification1Element } from '@speclynx/apidom-ns-arazzo-1';
+
+const arazzoElement = new ArazzoSpecification1Element();
+
+isArazzoSpecification1Element(arazzoElement); // => true
+```
+
+## Traversal
+
+Traversing ApiDOM in this namespace is possible by using `visit` function from `apidom` package.
+This package comes with its own [keyMap](https://github.com/speclynx/apidom/blob/main/packages/apidom-ns-arazzo-1/src/traversal/visitor.ts) and [nodeTypeGetter](https://github.com/speclynx/apidom/blob/main/packages/apidom-ns-arazzo-1/src/traversal/visitor.ts).
+To learn more about these `visit` configuration options please refer to [@speclynx/apidom-ast documentation](https://github.com/speclynx/apidom/blob/main/packages/apidom-ast/README.md#visit).
+
+```js
+import { visit } from '@speclynx/apidom-core';
+import { ArazzoSpecification1Element, keyMap, getNodeType } from '@speclynx/apidom-ns-arazzo-1';
+
+const element = new ArazzoSpecification1Element();
+
+const visitor = {
+  ArazzoSpecification1Element(arazzoElement) {
+    console.dir(arazzoElement);
+  },
+};
+
+visit(element, visitor, { keyMap, nodeTypeGetter: getNodeType });
+```
+
+## Refractors
+
+Refractor is a special layer inside the namespace that can transform either JavaScript structures
+or generic ApiDOM structures into structures built from elements of this namespace.
+
+**Refracting JavaScript structures**:
+
+```js
+import { InfoElement } from '@speclynx/apidom-ns-arazzo-1';
+
+const object = {
+    title: 'my title',
+    summary: 'my summary',
+    description: 'my description',
+    version: '0.1.0',
+};
+
+InfoElement.refract(object); // => InfoElement({ title, summary, description, version })
+```
+
+**Refracting generic ApiDOM structures**:
+
+```js
+import { ObjectElement } from '@speclynx/apidom-core';
+import { InfoElement } from '@speclynx/apidom-ns-arazzo-1';
+
+const objectElement = new ObjectElement({
+    title: 'my title',
+    summary: 'my summary',
+    description: 'my description',
+    version: '0.1.0',
+});
+
+InfoElement.refract(objectElement); // => InfoElement({ title = 'my title', summary = 'my summary', description = 'my description', version = '0.1.0' })
+```
+
+### Refractor plugins
+
+Refractors can accept plugins as a second argument of refract static method.
+
+```js
+import { ObjectElement } from '@speclynx/apidom-core';
+import { InfoElement } from '@speclynx/apidom-ns-arazzo-1';
+
+const objectElement = new ObjectElement({
+    title: 'my title',
+    summary: 'my summary',
+    description: 'my description',
+    version: '0.1.0',
+});
+
+const plugin = ({ predicates, namespace }) => ({
+  name: 'plugin',
+  pre() {
+      console.dir('runs before traversal');
+  },
+  visitor: {
+    InfoElement(infoElement) {
+      infoElement.version = '2.0.0';
+    },
+  },
+  post() {
+      console.dir('runs after traversal');
+  },
+});
+
+InfoElement.refract(objectElement, { plugins: [plugin] }); // => InfoElement({ title = 'my title', description = 'my description', version = '2.0.0' })
+```
+
+You can define as many plugins as needed to enhance the resulting namespaced ApiDOM structure.
+If multiple plugins with the same visitor method are defined, they run in parallel (just like in Babel).
+
+#### Replace Empty Element plugin
+
+This plugin is specific to YAML 1.2 format, which allows defining key-value pairs with empty key,
+empty value, or both. If the value is not provided in YAML format, this plugin compensates for
+this missing value with the most appropriate semantic element type.
+
+```js
+import { parse } from '@speclynx/apidom-parser-adapter-yaml-1-2';
+import { refractorPluginReplaceEmptyElement, ArazzoSpecification1Element } from '@speclynx/apidom-ns-arazzo-1';
+
+const yamlDefinition = `
+arazzo: 1.0.1
+info:
+`;
+const apiDOM = await parse(yamlDefinition);
+const arazzoElement = ArazzoSpecification1Element.refract(apiDOM.result, {
+  plugins: [refractorPluginReplaceEmptyElement()],
+});
+
+// =>
+// (ArazzoSpecification1Element
+//   (MemberElement
+//     (StringElement)
+//     (StringElement))
+//   (MemberElement
+//     (StringElement)
+//     (InfoElement)))
+
+// => without the plugin the result would be as follows:
+// (ArazzoSpecification1Element
+//   (MemberElement
+//     (StringElement)
+//     (StringElement))
+//   (MemberElement
+//     (StringElement)
+//     (StringElement)))
+```
+
+## Implementation progress
+
+Only fully implemented specification objects should be checked here.
+
+- [x] [Arazzo Specification Object](https://spec.openapis.org/arazzo/latest.html#arazzo-specification-object)
+- [x] [Info Object](https://spec.openapis.org/arazzo/latest.html#info-object)
+- [x] [Source Description Object](https://spec.openapis.org/arazzo/latest.html#source-description-object)
+- [x] [Workflow Object](https://spec.openapis.org/arazzo/latest.html#workflow-object)
+- [x] [Step Object](https://spec.openapis.org/arazzo/latest.html#step-object)
+- [x] [Parameter Object](https://spec.openapis.org/arazzo/latest.html#parameter-object)
+- [x] [Success Action Object](https://spec.openapis.org/arazzo/latest.html#success-action-object)
+- [x] [Failure Action Object](https://spec.openapis.org/arazzo/latest.html#failure-action-object)
+- [x] [Components Object](https://spec.openapis.org/arazzo/latest.html#components-object)
+- [x] [Reusable Object](https://spec.openapis.org/arazzo/latest.html#reusable-object)
+- [x] [Criterion Object](https://spec.openapis.org/arazzo/latest.html#criterion-object)
+- [x] [Criterion Expression Type Object](https://spec.openapis.org/arazzo/latest.html#criterion-expression-type-object)
+- [x] [Request Body Object](https://spec.openapis.org/arazzo/latest.html#request-body-object)
+- [x] [Payload Replacement Object](https://spec.openapis.org/arazzo/latest.html#payload-replacement-object)
+- [x] [JSON Schema](https://json-schema.org/specification-links#2020-12)
+- [x] [Specification extensions](https://spec.openapis.org/arazzo/latest.html#specification-extensions)