feat: add YAML parser adapter for OpenAPI 3.0.x namespace

README.md

@@ -79,6 +79,7 @@ You can now install ApiDOM packages using `npm`:
  $ npm install @swagger-api/apidom-parser-adapter-json
  $ npm install @swagger-api/apidom-parser-adapter-openapi-json-3-0
  $ npm install @swagger-api/apidom-parser-adapter-openapi-json-3-1
+ $ npm install @swagger-api/apidom-parser-adapter-openapi-yaml-3-0
  $ npm install @swagger-api/apidom-parser-adapter-openapi-yaml-3-1
  $ npm install @swagger-api/apidom-parser-adapter-yaml-1-2
  $ npm install @swagger-api/apidom-reference

package.json

@@ -28,7 +28,7 @@
     "clean": "lerna run clean",
     "test": "lerna run test",
     "link": "npm link --workspaces",
-    "unlink": "npm unlink --global @swagger-api/apidom-ast @swagger-api/apidom-core @swagger-api/apidom-json-path @swagger-api/apidom-json-pointer @swagger-api/apidom-parser-adapter-json @swagger-api/apidom-ns-api-design-systems @swagger-api/apidom-ns-asyncapi-2 @swagger-api/apidom-ns-json-schema-draft-4 @swagger-api/apidom-ns-json-schema-draft-6 @swagger-api/apidom-ns-json-schema-draft-7 @swagger-api/apidom-ns-openapi-3-0 @swagger-api/apidom-ns-openapi-3-1 @swagger-api/apidom-parser-adapter-yaml-1-2 @swagger-api/apidom-parser-adapter-asyncapi-yaml-2 @swagger-api/apidom-parser-adapter-openapi-yaml-3-1 @swagger-api/apidom-parser @swagger-api/apidom-parser-adapter-api-design-systems-json @swagger-api/apidom-parser-adapter-api-design-systems-yaml @swagger-api/apidom-parser-adapter-asyncapi-json-2 @swagger-api/apidom-ls @swagger-api/apidom-reference @swagger-api/apidom-parser-adapter-openapi-json-3-0 @swagger-api/apidom-parser-adapter-openapi-json-3-1 @swagger-api/apidom-playground",
+    "unlink": "npm unlink --global @swagger-api/apidom-ast @swagger-api/apidom-core @swagger-api/apidom-json-path @swagger-api/apidom-json-pointer @swagger-api/apidom-parser-adapter-json @swagger-api/apidom-ns-api-design-systems @swagger-api/apidom-ns-asyncapi-2 @swagger-api/apidom-ns-json-schema-draft-4 @swagger-api/apidom-ns-json-schema-draft-6 @swagger-api/apidom-ns-json-schema-draft-7 @swagger-api/apidom-ns-openapi-3-0 @swagger-api/apidom-ns-openapi-3-1 @swagger-api/apidom-parser-adapter-yaml-1-2 @swagger-api/apidom-parser-adapter-asyncapi-yaml-2 @swagger-api/apidom-parser-adapter-openapi-yaml-3-0 @swagger-api/apidom-parser-adapter-openapi-yaml-3-1 @swagger-api/apidom-parser @swagger-api/apidom-parser-adapter-api-design-systems-json @swagger-api/apidom-parser-adapter-api-design-systems-yaml @swagger-api/apidom-parser-adapter-asyncapi-json-2 @swagger-api/apidom-ls @swagger-api/apidom-reference @swagger-api/apidom-parser-adapter-openapi-json-3-0 @swagger-api/apidom-parser-adapter-openapi-json-3-1 @swagger-api/apidom-playground",
     "prepare": "husky install"
   },
   "repository": {

packages/apidom-parser-adapter-openapi-json-3-0/src/adapter.ts

@@ -6,7 +6,7 @@ import openApiNamespace, { OpenApi3_0Element } from '@swagger-api/apidom-ns-open
 
 export { default as mediaTypes } from './media-types';
 
-export const detectionRegExp = /"openapi"\s*:\s*"(?<version_json>3\.0\.([0123])(-rc[012])?)"/;
+export const detectionRegExp = /"openapi"\s*:\s*"(?<version_json>3\.0\.([0123])(?:-rc[012])?)"/;
 
 export const detect = async (source: string): Promise<boolean> =>
   detectionRegExp.test(source) && (await detectJSON(source));

packages/apidom-parser-adapter-openapi-yaml-3-0/.eslintignore

@@ -0,0 +1,8 @@
+/dist
+/es
+/cjs
+/types
+/config
+/.nyc_output
+/node_modules
+/**/*.js

packages/apidom-parser-adapter-openapi-yaml-3-0/.gitignore

@@ -0,0 +1,6 @@
+/dist
+/es
+/cjs
+/types
+/NOTICE
+/swagger-api-apidom-parser-adapter-openapi-yaml-3-0-*.tgz

packages/apidom-parser-adapter-openapi-yaml-3-0/.mocharc.json

@@ -0,0 +1,5 @@
+{
+  "recursive": true,
+  "spec": "test/**/*.ts",
+  "file": ["test/mocha-bootstrap.cjs"]
+}

packages/apidom-parser-adapter-openapi-yaml-3-0/.npmrc

@@ -0,0 +1,2 @@
+save-prefix="="
+save=false

packages/apidom-parser-adapter-openapi-yaml-3-0/README.md

@@ -0,0 +1,105 @@
+# @swagger-api/apidom-parser-adapter-openapi-yaml-3-0
+
+`@swagger-api/apidom-parser-adapter-openapi-yaml-3-0` is a parser adapter for the [OpenApi 3.0.x specification](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md) in [YAML format](https://yaml.org/spec/1.2/spec.html).
+Under the hood this adapter uses [apidom-parser-adapter-yaml-1-2](https://github.com/swagger-api/apidom/tree/main/packages/apidom-parser-adapter-yaml-1-2)
+to parse a source string into generic ApiDOM in [base ApiDOM namespace](https://github.com/swagger-api/apidom/tree/main/packages/apidom#base-namespace)
+which is then refracted with [OpenApi 3.0.x Refractors](https://github.com/swagger-api/apidom/tree/main/packages/apidom-ns-openapi-3-0#refractors).
+
+## Installation
+
+`@swagger-api/apidom-parser-adapter-openapi-yaml-3-0` is currently hosted on [GitHub packages registry](https://docs.github.com/en/packages/learn-github-packages/introduction-to-github-packages).
+For installing `@swagger-api/apidom-parser-adapter-openapi-yaml-3-0` from GitHub packages registry, create `.npmrc` file in your current directory and add
+the following line to it:
+
+```
+@swagger-api:registry=https://npm.pkg.github.com
+```
+
+You can now install the package using `npm`:
+
+```sh
+ $ npm install @swagger-api/apidom-parser-adapter-openapi-yaml-3-0
+```
+
+## Parser adapter API
+
+This parser adapter is fully compatible with parser adapter interface required by [@swagger-api/apidom-parser](https://github.com/swagger-api/apidom/tree/main/packages/apidom-parser#mounting-parser-adapters)
+and implements all required properties.
+
+### mediaTypes
+
+Defines list of media types that this parser adapter recognizes.
+
+```js
+[
+  'application/vnd.oai.openapi;version=3.0.0',
+  'application/vnd.oai.openapi+yaml;version=3.0.0',
+  'application/vnd.oai.openapi;version=3.0.0-rc0',
+  'application/vnd.oai.openapi+yaml;version=3.0.0-rc0',
+  'application/vnd.oai.openapi;version=3.0.0-rc1',
+  'application/vnd.oai.openapi+yaml;version=3.0.0-rc1',
+  'application/vnd.oai.openapi;version=3.0.0-rc2',
+  'application/vnd.oai.openapi+yaml;version=3.0.0-rc2',
+  'application/vnd.oai.openapi;version=3.0.1',
+  'application/vnd.oai.openapi+yaml;version=3.0.1',
+  'application/vnd.oai.openapi;version=3.0.2',
+  'application/vnd.oai.openapi+yaml;version=3.0.2',
+  'application/vnd.oai.openapi;version=3.0.3',
+  'application/vnd.oai.openapi+yaml;version=3.0.3',
+]
+```
+
+### detect
+
+[Detection](https://github.com/swagger-api/apidom/blob/main/packages/apidom-parser-adapter-openapi-yaml-3-0/src/adapter.ts#L13) is based on a regular expression matching required OpenApi 3.0.x specification symbols in YAML format.
+
+### namespace
+
+This adapter exposes an instance of [OpenApi 3.0.x ApiDOM namespace](https://github.com/swagger-api/apidom/tree/main/packages/apidom-ns-openapi-3-0#openapi-30x-namespace).
+
+### parse
+
+`parse` function consumes various options as a second argument. Here is a list of these options:
+
+Option | Type | Default | Description
+--- | --- | --- | ---
+<a name="specObj"></a>`specObj` | `Object` | [Specification Object](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ns-openapi-3-0/src/refractor/specification.ts) | This specification object drives the YAML AST transformation to OpenAPI 3.0.x ApiDOM namespace.
+<a name="sourceMap"></a>`sourceMap` | `Boolean` | `false` | Indicate whether to generate source maps.
+<a name="refractorOpts"></a>`refractorOpts` | `Object` | `{}` | Refractor options are [passed to refractors](https://github.com/swagger-api/apidom/tree/main/packages/apidom-ns-openapi-3-0#refractor-plugins) during refracting phase.
+
+All unrecognized arbitrary options will be ignored.
+
+## Usage
+
+This parser adapter can be used directly or indirectly via [apidom-parser](https://github.com/swagger-api/apidom/tree/main/packages/apidom-parser).
+
+### Direct usage
+
+During direct usage you don't need to provide `mediaType` as the `parse` function is already pre-bound
+with [supported media types](#mediatypes).
+
+```js
+import { parse, detect } from '@swagger-api/apidom-parser-adapter-openapi-yaml-3-0';
+
+// detecting
+await detect('openapi: 3.0.3'); // => true
+await detect('test'); // => false
+
+// parsing
+const parseResult = await parse('openapi: 3.0.0', { sourceMap: true });
+```
+
+### Indirect usage
+
+You can omit the `mediaType` option here, but please read [Word on detect vs mediaTypes](https://github.com/swagger-api/apidom/tree/main/packages/apidom-parser#word-on-detect-vs-mediatypes) before you do so.
+
+```js
+import ApiDOMParser from '@swagger-api/apidom-parser';
+import * as openApiYamlAdapter from '@swagger-api/apidom-parser-adapter-openapi-yaml-3-0';
+
+const parser = ApiDOMParser();
+
+parser.use(openApiYamlAdapter);
+
+const parseResult = await parser.parse('openapi: 3.0.3', { mediaType: openApiYamlAdapter.mediaTypes.latest('yaml') });
+```

packages/apidom-parser-adapter-openapi-yaml-3-0/config/rollup/types.dist.js

@@ -0,0 +1,11 @@
+import dts from 'rollup-plugin-dts';
+
+const config = [
+  {
+    input: './types/adapter.d.ts',
+    output: [{ file: 'types/dist.d.ts', format: 'es' }],
+    plugins: [dts()],
+  },
+];
+
+export default config;

packages/apidom-parser-adapter-openapi-yaml-3-0/config/webpack/browser.config.js

@@ -0,0 +1,88 @@
+import path from 'node:path';
+import { nonMinimizeTrait, minimizeTrait } from './traits.config.js';
+
+const browser = {
+  mode: 'production',
+  entry: ['./src/adapter.ts'],
+  target: 'web',
+  performance: {
+    maxEntrypointSize: 712000,
+    maxAssetSize: 712000,
+  },
+  output: {
+    path: path.resolve('./dist'),
+    filename: 'apidom-parser-adapter-openapi-yaml-3-0.browser.js',
+    libraryTarget: 'umd',
+    library: 'apidomParserAdapterOpenApiYaml3_0',
+  },
+  resolve: {
+    extensions: ['.ts', '.mjs', '.js', '.json'],
+    fallback: {
+      fs: false,
+      path: false,
+    },
+  },
+  module: {
+    rules: [
+      {
+        test: /\.wasm$/,
+        loader: 'file-loader',
+        type: 'javascript/auto',
+      },
+      {
+        test: /\.(ts|js)?$/,
+        exclude: /node_modules/,
+        use: {
+          loader: 'babel-loader',
+          options: {
+            babelrc: true,
+            rootMode: 'upward',
+          },
+        },
+      },
+    ],
+  },
+  ...nonMinimizeTrait,
+};
+
+const browserMin = {
+  mode: 'production',
+  entry: ['./src/adapter.ts'],
+  target: 'web',
+  output: {
+    path: path.resolve('./dist'),
+    filename: 'apidom-parser-adapter-openapi-yaml-3-0.browser.min.js',
+    libraryTarget: 'umd',
+    library: 'apidomParserAdapterOpenApiYaml3_0',
+  },
+  resolve: {
+    extensions: ['.ts', '.mjs', '.js', '.json'],
+    fallback: {
+      fs: false,
+      path: false,
+    },
+  },
+  module: {
+    rules: [
+      {
+        test: /\.wasm$/,
+        loader: 'file-loader',
+        type: 'javascript/auto',
+      },
+      {
+        test: /\.(ts|js)?$/,
+        exclude: /node_modules/,
+        use: {
+          loader: 'babel-loader',
+          options: {
+            babelrc: true,
+            rootMode: 'upward',
+          },
+        },
+      },
+    ],
+  },
+  ...minimizeTrait,
+};
+
+export default [browser, browserMin];

packages/apidom-parser-adapter-openapi-yaml-3-0/config/webpack/traits.config.js

@@ -0,0 +1,32 @@
+import webpack from 'webpack';
+import TerserPlugin from 'terser-webpack-plugin';
+
+export const nonMinimizeTrait = {
+  optimization: {
+    minimize: false,
+    usedExports: false,
+    concatenateModules: false,
+  },
+};
+
+export const minimizeTrait = {
+  plugins: [
+    new webpack.LoaderOptionsPlugin({
+      minimize: true,
+    }),
+  ],
+  optimization: {
+    minimizer: [
+      new TerserPlugin({
+        terserOptions: {
+          compress: {
+            warnings: false,
+          },
+          output: {
+            comments: false,
+          },
+        },
+      }),
+    ],
+  },
+};

packages/apidom-parser-adapter-openapi-yaml-3-0/declaration.tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": [
+    "test/**/*"
+  ],
+  "compilerOptions": {
+    "declaration": true,
+    "declarationDir": "types",
+    "noEmit": false,
+    "emitDeclarationOnly": true
+  }
+}