feat: add package for apidom-ns-async-api-3

packages/apidom-ns-asyncapi-2/src/index.ts

@@ -17,7 +17,7 @@ export type { Format } from './media-types.ts';
 // eslint-disable-next-line no-restricted-exports
 export { default } from './namespace.ts';
 
-export type { default as specificationObj } from './refractor/specification.ts';
+export { default as specificationObj } from './refractor/specification.ts';
 
 export { default as refractorPluginReplaceEmptyElement } from './refractor/plugins/replace-empty-element.ts';
 
@@ -646,8 +646,8 @@ export type {
   PropertiesVisitorOptions as SchemaPropertiesVisitorOptions,
   JSONSchemaPropertiesVisitor,
 } from './refractor/visitors/async-api-2/schema/PropertiesVisitor.ts';
+export { default as SchemaOrReferenceVisitor } from './refractor/visitors/async-api-2/schema/SchemaOrReferenceVisitor.ts';
 export type {
-  default as SchemaOrReferenceVisitor,
   SchemaOrReferenceVisitorOptions,
   JSONSchemaOrJSONReferenceVisitor,
 } from './refractor/visitors/async-api-2/schema/SchemaOrReferenceVisitor.ts';
@@ -859,29 +859,29 @@ export {
   WebSocketServerBindingElement,
 } from './refractor/registration.ts';
 
-export type { default as ChannelItemsServersElement } from './elements/nces/ChannelItemsServers.ts';
-export type { default as ComponentsChannelBindingsElement } from './elements/nces/ComponentsChannelBindings.ts';
-export type { default as ComponentsChannelsElement } from './elements/nces/ComponentsChannels.ts';
-export type { default as ComponentsCorrelationIDsElement } from './elements/nces/ComponentsCorrelationIDs.ts';
-export type { default as ComponentsMessageBindingsElement } from './elements/nces/ComponentsMessageBindings.ts';
-export type { default as ComponentsMessagesElement } from './elements/nces/ComponentsMessages.ts';
-export type { default as ComponentsMessageTraitsElement } from './elements/nces/ComponentsMessageTraits.ts';
-export type { default as ComponentsOperationBindingsElement } from './elements/nces/ComponentsOperationBindings.ts';
-export type { default as ComponentsOperationTraitsElement } from './elements/nces/ComponentsOperationTraits.ts';
-export type { default as ComponentsParametersElement } from './elements/nces/ComponentsParameters.ts';
-export type { default as ComponentsSchemasElement } from './elements/nces/ComponentsSchemas.ts';
-export type { default as ComponentsSecuritySchemesElement } from './elements/nces/ComponentsSecuritySchemes.ts';
-export type { default as ComponentsServerBindingsElement } from './elements/nces/ComponentsServerBindings.ts';
-export type { default as ComponentsServersElement } from './elements/nces/ComponentsServers.ts';
-export type { default as ComponentsServerVariablesElement } from './elements/nces/ComponentsServerVariables.ts';
-export type { default as MessageExamplesElement } from './elements/nces/MessageExamples.ts';
-export type { default as MessageTraitExamplesElement } from './elements/nces/MessageTraitExamples.ts';
-export type { default as MessageTraitsElement } from './elements/nces/MessageTraits.ts';
-export type { default as OAuthFlowScopesElement } from './elements/nces/OAuthFlowScopes.ts';
-export type { default as OperationMessageElement } from './elements/nces/OperationMessage.ts';
-export type { default as OperationMessageMapElement } from './elements/nces/OperationMessageMap.ts';
-export type { default as OperationSecurityElement } from './elements/nces/OperationSecurity.ts';
-export type { default as OperationTraitsElement } from './elements/nces/OperationTraits.ts';
-export type { default as OperationTraitSecurityElement } from './elements/nces/OperationTraitSecurity.ts';
-export type { default as ServerSecurityElement } from './elements/nces/ServerSecurity.ts';
-export type { default as ServerVariablesElement } from './elements/nces/ServerVariables.ts';
+export { default as ChannelItemsServersElement } from './elements/nces/ChannelItemsServers.ts';
+export { default as ComponentsChannelBindingsElement } from './elements/nces/ComponentsChannelBindings.ts';
+export { default as ComponentsChannelsElement } from './elements/nces/ComponentsChannels.ts';
+export { default as ComponentsCorrelationIDsElement } from './elements/nces/ComponentsCorrelationIDs.ts';
+export { default as ComponentsMessageBindingsElement } from './elements/nces/ComponentsMessageBindings.ts';
+export { default as ComponentsMessagesElement } from './elements/nces/ComponentsMessages.ts';
+export { default as ComponentsMessageTraitsElement } from './elements/nces/ComponentsMessageTraits.ts';
+export { default as ComponentsOperationBindingsElement } from './elements/nces/ComponentsOperationBindings.ts';
+export { default as ComponentsOperationTraitsElement } from './elements/nces/ComponentsOperationTraits.ts';
+export { default as ComponentsParametersElement } from './elements/nces/ComponentsParameters.ts';
+export { default as ComponentsSchemasElement } from './elements/nces/ComponentsSchemas.ts';
+export { default as ComponentsSecuritySchemesElement } from './elements/nces/ComponentsSecuritySchemes.ts';
+export { default as ComponentsServerBindingsElement } from './elements/nces/ComponentsServerBindings.ts';
+export { default as ComponentsServersElement } from './elements/nces/ComponentsServers.ts';
+export { default as ComponentsServerVariablesElement } from './elements/nces/ComponentsServerVariables.ts';
+export { default as MessageExamplesElement } from './elements/nces/MessageExamples.ts';
+export { default as MessageTraitsElement } from './elements/nces/MessageTraits.ts';
+export { default as MessageTraitExamplesElement } from './elements/nces/MessageTraitExamples.ts';
+export { default as OAuthFlowScopesElement } from './elements/nces/OAuthFlowScopes.ts';
+export { default as OperationMessageElement } from './elements/nces/OperationMessage.ts';
+export { default as OperationMessageMapElement } from './elements/nces/OperationMessageMap.ts';
+export { default as OperationSecurityElement } from './elements/nces/OperationSecurity.ts';
+export { default as ServerVariablesElement } from './elements/nces/ServerVariables.ts';
+export { default as OperationTraitsElement } from './elements/nces/OperationTraits.ts';
+export { default as OperationTraitSecurityElement } from './elements/nces/OperationTraitSecurity.ts';
+export { default as ServerSecurityElement } from './elements/nces/ServerSecurity.ts';

packages/apidom-ns-asyncapi-3/.gitignore

@@ -0,0 +1,7 @@
+/src/**/*.mjs
+/src/**/*.cjs
+/test/**/*.mjs
+/dist
+/types
+/NOTICE
+/swagger-api-apidom-ns-asyncapi-3-*.tgz

packages/apidom-ns-asyncapi-3/.mocharc.json

@@ -0,0 +1,8 @@
+{
+  "extensions": ["ts"],
+  "loader": "ts-node/esm",
+  "recursive": true,
+  "spec": "test/**/*.ts",
+  "file": ["test/mocha-bootstrap.ts"],
+  "ignore": ["test/perf/**/*.ts"]
+}

packages/apidom-ns-asyncapi-3/README.md

@@ -0,0 +1,5 @@
+# apidom-ns-asyncapi-3
+
+AsyncAPI 3.x.y namespace for ApiDOM.
+
+This is a starter scaffold. Implement element classes, predicates and refractor visitors following the pattern from `apidom-ns-asyncapi-2`.

packages/apidom-ns-asyncapi-3/config/api-extractor/api-extractor.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+  "extends": "../../../../api-extractor.json"
+}

packages/apidom-ns-asyncapi-3/config/webpack/browser.config.js

@@ -0,0 +1,75 @@
+import path from 'node:path';
+
+import { nonMinimizeTrait, minimizeTrait } from './traits.config.js';
+
+const browser = {
+  mode: 'production',
+  entry: ['./src/index.ts'],
+  target: 'web',
+  performance: {
+    maxEntrypointSize: 2200000,
+    maxAssetSize: 2200000,
+  },
+  output: {
+    path: path.resolve('./dist'),
+    filename: 'apidom-ns-asyncapi-3.browser.js',
+    libraryTarget: 'umd',
+    library: 'apidomNsAsyncApi3',
+  },
+  resolve: {
+    extensions: ['.ts', '.mjs', '.js', '.json'],
+  },
+  module: {
+    rules: [
+      {
+        test: /\.(ts|js)?$/,
+        exclude: /node_modules/,
+        use: {
+          loader: 'babel-loader',
+          options: {
+            babelrc: true,
+            rootMode: 'upward',
+          },
+        },
+      },
+    ],
+  },
+  ...nonMinimizeTrait,
+};
+
+const browserMin = {
+  mode: 'production',
+  entry: ['./src/index.ts'],
+  target: 'web',
+  performance: {
+    maxEntrypointSize: 310000,
+    maxAssetSize: 310000,
+  },
+  output: {
+    path: path.resolve('./dist'),
+    filename: 'apidom-ns-asyncapi-3.browser.min.js',
+    libraryTarget: 'umd',
+    library: 'apidomNsAsyncApi3',
+  },
+  resolve: {
+    extensions: ['.ts', '.mjs', '.js', '.json'],
+  },
+  module: {
+    rules: [
+      {
+        test: /\.(ts|js)?$/,
+        exclude: /node_modules/,
+        use: {
+          loader: 'babel-loader',
+          options: {
+            babelrc: true,
+            rootMode: 'upward',
+          },
+        },
+      },
+    ],
+  },
+  ...minimizeTrait,
+};
+
+export default [browser, browserMin];

packages/apidom-ns-asyncapi-3/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-ns-asyncapi-3/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@swagger-api/apidom-ns-asyncapi-3",
+  "version": "1.0.0-beta.0",
+  "description": "AsyncAPI 3.x.y namespace for ApiDOM.",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "type": "module",
+  "sideEffects": [],
+  "main": "./src/index.cjs",
+  "exports": {
+    "types": "./types/apidom-ns-asyncapi-3.d.ts",
+    "import": "./src/index.mjs",
+    "require": "./src/index.cjs"
+  },
+  "types": "./types/apidom-ns-asyncapi-3.d.ts",
+  "scripts": {
+    "build": "npm run clean && run-p --max-parallel ${CPU_CORES:-2} typescript:declaration build:es build:cjs build:umd:browser",
+    "build:es": "cross-env BABEL_ENV=es babel src --out-dir src --extensions '.ts' --out-file-extension '.mjs' --root-mode 'upward'",
+    "build:cjs": "cross-env BABEL_ENV=cjs babel src --out-dir src --extensions '.ts' --out-file-extension '.cjs' --root-mode 'upward'",
+    "build:umd:browser": "cross-env BABEL_ENV=browser webpack --config config/webpack/browser.config.js --progress",
+    "lint": "eslint ./",
+    "lint:fix": "eslint ./ --fix",
+    "clean": "rimraf --glob 'src/**/*.mjs' 'src/**/*.cjs' ./dist ./types",
+    "test": "NODE_ENV=test ts-mocha --exit",
+    "test:update-snapshots": "cross-env UPDATE_SNAPSHOT=1 BABEL_ENV=cjs mocha",
+    "perf": "cross-env BABEL_ENV=es babel ./test/perf --out-dir ./test/perf --extensions '.ts' --out-file-extension '.mjs' --root-mode 'upward' && cross-env NODE_ENV=test node ./test/perf/index.mjs",
+    "perf:visitor-shortcut": "cross-env BABEL_ENV=es babel ./test/perf/visitor-shortcut.ts --out-file ./test/perf/visitor-shortcut.mjs --root-mode 'upward' && cross-env NODE_ENV=test node ./test/perf/visitor-shortcut.mjs",
+    "typescript:check-types": "tsc --noEmit && tsc -p ./test/tsconfig.json --noEmit",
+    "typescript:declaration": "tsc -p tsconfig.declaration.json && api-extractor run -l -c ./config/api-extractor/api-extractor.json 2>&1 | shx grep -v 'Visitor_base'"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/swagger-api/apidom.git"
+  },
+  "author": "apidom team",
+  "license": "Apache-2.0",
+  "dependencies": {
+    "@babel/runtime-corejs3": "^7.26.10",
+    "@swagger-api/apidom-core": "^1.0.0-rc.3",
+    "@swagger-api/apidom-ns-asyncapi-2": "^1.0.0-rc.3",
+    "@types/ramda": "~0.30.0",
+    "ramda": "~0.30.0",
+    "ramda-adjunct": "^5.0.0",
+    "ts-mixer": "^6.0.3"
+  },
+  "files": [
+    "src/**/*.mjs",
+    "src/**/*.cjs",
+    "dist/",
+    "types/apidom-ns-asyncapi-3.d.ts",
+    "LICENSES",
+    "NOTICE",
+    "README.md",
+    "CHANGELOG.md"
+  ]
+}

packages/apidom-ns-asyncapi-3/src/elements/AsyncApi3.ts

@@ -0,0 +1,47 @@
+import { Attributes, Meta } from '@swagger-api/apidom-core';
+import { UnsupportedOperationError } from '@swagger-api/apidom-error';
+import {
+  ExternalDocumentationElement,
+  AsyncApi2Element,
+  TagsElement,
+} from '@swagger-api/apidom-ns-asyncapi-2';
+
+import OperationsElement from './Operations.ts';
+
+/* eslint-disable class-methods-use-this */
+
+/**
+ * @public
+ */
+class AsyncApi3 extends AsyncApi2Element {
+  constructor(content?: Record<string, unknown>, meta?: Meta, attributes?: Attributes) {
+    super(content, meta, attributes);
+    this.element = 'asyncApi3';
+  }
+
+  get tags(): TagsElement | undefined {
+    throw new UnsupportedOperationError('tags keyword has been moved to info');
+  }
+
+  set tags(tags: TagsElement | undefined) {
+    throw new UnsupportedOperationError('tags keyword has been moved to info');
+  }
+
+  get externalDocs(): ExternalDocumentationElement | undefined {
+    throw new UnsupportedOperationError('externalDocs keyword has been moved to info.');
+  }
+
+  set externalDocs(externalDocs: ExternalDocumentationElement | undefined) {
+    throw new UnsupportedOperationError('externalDocs keyword has been moved to info.');
+  }
+
+  get operations(): OperationsElement | undefined {
+    return this.get('operations');
+  }
+
+  set operations(operations: OperationsElement | undefined) {
+    this.set('operations', operations);
+  }
+}
+
+export default AsyncApi3;

packages/apidom-ns-asyncapi-3/src/elements/AsyncApiVersion.ts

@@ -0,0 +1,8 @@
+import { AsyncApiVersionElement } from '@swagger-api/apidom-ns-asyncapi-2';
+
+/**
+ * @public
+ */
+class AsyncApiVersion extends AsyncApiVersionElement {}
+
+export default AsyncApiVersion;