chore(ns-openapi-2): use API Extractor for TypeScript rollup (#4543)

Refs #4382
swagger-api · Nov 22, 2024 · d9baa6b · d9baa6b
1 parent aa9027f
commit d9baa6b
Show file tree

Hide file tree

Showing 109 changed files with 582 additions and 25 deletions.
diff --git a/packages/apidom-ns-openapi-2/config/api-extractor/api-extractor.json b/packages/apidom-ns-openapi-2/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"
+}
diff --git a/packages/apidom-ns-openapi-2/config/rollup/types.dist.js b/packages/apidom-ns-openapi-2/config/rollup/types.dist.js
diff --git a/packages/apidom-ns-openapi-2/package.json b/packages/apidom-ns-openapi-2/package.json
@@ -14,11 +14,11 @@
   "unpkg": "./dist/apidom-ns-openapi-2.browser.min.js",
   "main": "./src/index.cjs",
   "exports": {
-    "types": "./types/dist.d.ts",
+    "types": "./types/apidom-ns-openapi-2.d.ts",
     "import": "./src/index.mjs",
     "require": "./src/index.cjs"
   },
-  "types": "./types/dist.d.ts",
+  "types": "./types/apidom-ns-openapi-2.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'",
@@ -30,7 +30,7 @@
     "test": "npm run build:es && cross-env BABEL_ENV=es babel test --out-dir test --extensions '.ts' --out-file-extension '.mjs' --root-mode 'upward' && cross-env NODE_ENV=test mocha",
     "test:update-snapshots": "cross-env UPDATE_SNAPSHOT=1 mocha",
     "typescript:check-types": "tsc --noEmit && tsc -p ./test/tsconfig.json --noEmit",
-    "typescript:declaration": "tsc -p tsconfig.declaration.json && rollup -c config/rollup/types.dist.js",
+    "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'",
     "prepack": "copyfiles -u 3 ../../LICENSES/* LICENSES && copyfiles -u 2 ../../NOTICE .",
     "postpack": "rimraf NOTICE LICENSES"
   },
@@ -54,7 +54,7 @@
     "src/**/*.mjs",
     "src/**/*.cjs",
     "dist/",
-    "types/dist.d.ts",
+    "types/apidom-ns-openapi-2.d.ts",
     "LICENSES",
     "NOTICE",
     "README.md",

diff --git a/packages/apidom-ns-openapi-2/src/elements/Contact.ts b/packages/apidom-ns-openapi-2/src/elements/Contact.ts
@@ -1,5 +1,8 @@
 import { StringElement, ObjectElement, Attributes, Meta } from '@swagger-api/apidom-core';
 
+/**
+ * @public
+ */
 class Contact extends ObjectElement {
   constructor(content?: Record<string, unknown>, meta?: Meta, attributes?: Attributes) {
     super(content, meta, attributes);

diff --git a/packages/apidom-ns-openapi-2/src/elements/Definitions.ts b/packages/apidom-ns-openapi-2/src/elements/Definitions.ts
@@ -1,5 +1,8 @@
 import { ObjectElement, Attributes, Meta } from '@swagger-api/apidom-core';
 
+/**
+ * @public
+ */
 class Definitions extends ObjectElement {
   constructor(content?: Record<string, unknown>, meta?: Meta, attributes?: Attributes) {
     super(content, meta, attributes);

diff --git a/packages/apidom-ns-openapi-2/src/elements/Example.ts b/packages/apidom-ns-openapi-2/src/elements/Example.ts
@@ -1,5 +1,8 @@
 import { ObjectElement, Attributes, Meta } from '@swagger-api/apidom-core';
 
+/**
+ * @public
+ */
 class Example extends ObjectElement {
   constructor(content?: Record<string, unknown>, meta?: Meta, attributes?: Attributes) {
     super(content, meta, attributes);

diff --git a/packages/apidom-ns-openapi-2/src/elements/ExternalDocumentation.ts b/packages/apidom-ns-openapi-2/src/elements/ExternalDocumentation.ts
@@ -1,5 +1,8 @@
 import { StringElement, ObjectElement, Attributes, Meta } from '@swagger-api/apidom-core';
 
+/**
+ * @public
+ */
 class ExternalDocumentation extends ObjectElement {
   constructor(content?: Record<string, unknown>, meta?: Meta, attributes?: Attributes) {
     super(content, meta, attributes);

diff --git a/packages/apidom-ns-openapi-2/src/elements/Header.ts b/packages/apidom-ns-openapi-2/src/elements/Header.ts
@@ -15,6 +15,9 @@ import {
 } from '@swagger-api/apidom-ns-json-schema-draft-4';
 
 /* eslint-disable class-methods-use-this */
+/**
+ * @public
+ */
 class Header extends JSONSchemaElement {
   constructor(content?: Record<string, unknown>, meta?: Meta, attributes?: Attributes) {
     super(content, meta, attributes);

diff --git a/packages/apidom-ns-openapi-2/src/elements/Headers.ts b/packages/apidom-ns-openapi-2/src/elements/Headers.ts
@@ -1,5 +1,8 @@
 import { ObjectElement, Attributes, Meta } from '@swagger-api/apidom-core';
 
+/**
+ * @public
+ */
 class Headers extends ObjectElement {
   constructor(content?: Record<string, unknown>, meta?: Meta, attributes?: Attributes) {
     super(content, meta, attributes);

diff --git a/packages/apidom-ns-openapi-2/src/elements/Info.ts b/packages/apidom-ns-openapi-2/src/elements/Info.ts
@@ -3,6 +3,9 @@ import { StringElement, ObjectElement, Attributes, Meta } from '@swagger-api/api
 import ContactElement from './Contact.ts';
 import LicenseElement from './License.ts';
 
+/**
+ * @public
+ */
 class Info extends ObjectElement {
   constructor(content?: Record<string, unknown>, meta?: Meta, attributes?: Attributes) {
     super(content, meta, attributes);

diff --git a/packages/apidom-ns-openapi-2/src/elements/Items.ts b/packages/apidom-ns-openapi-2/src/elements/Items.ts
@@ -15,6 +15,9 @@ import {
 } from '@swagger-api/apidom-ns-json-schema-draft-4';
 
 /* eslint-disable class-methods-use-this */
+/**
+ * @public
+ */
 class Items extends JSONSchemaElement {
   constructor(content?: Record<string, unknown>, meta?: Meta, attributes?: Attributes) {
     super(content, meta, attributes);

diff --git a/packages/apidom-ns-openapi-2/src/elements/License.ts b/packages/apidom-ns-openapi-2/src/elements/License.ts
@@ -1,5 +1,8 @@
 import { StringElement, ObjectElement, Attributes, Meta } from '@swagger-api/apidom-core';
 
+/**
+ * @public
+ */
 class License extends ObjectElement {
   constructor(content?: Record<string, unknown>, meta?: Meta, attributes?: Attributes) {
     super(content, meta, attributes);

diff --git a/packages/apidom-ns-openapi-2/src/elements/Operation.ts b/packages/apidom-ns-openapi-2/src/elements/Operation.ts
@@ -10,6 +10,9 @@ import {
 import ExternalDocumentationElement from './ExternalDocumentation.ts';
 import ResponsesElement from './Responses.ts';
 
+/**
+ * @public
+ */
 class Operation extends ObjectElement {
   constructor(content?: Record<string, unknown>, meta?: Meta, attributes?: Attributes) {
     super(content, meta, attributes);

diff --git a/packages/apidom-ns-openapi-2/src/elements/Parameter.ts b/packages/apidom-ns-openapi-2/src/elements/Parameter.ts
@@ -17,6 +17,9 @@ import {
 import SchemaElement from './Schema.ts';
 
 /* eslint-disable class-methods-use-this */
+/**
+ * @public
+ */
 class Parameter extends JSONSchemaElement {
   constructor(content?: Record<string, unknown>, meta?: Meta, attributes?: Attributes) {
     super(content, meta, attributes);

diff --git a/packages/apidom-ns-openapi-2/src/elements/ParametersDefinitions.ts b/packages/apidom-ns-openapi-2/src/elements/ParametersDefinitions.ts
@@ -1,5 +1,8 @@
 import { ObjectElement, Attributes, Meta } from '@swagger-api/apidom-core';
 
+/**
+ * @public
+ */
 class ParametersDefinitions extends ObjectElement {
   constructor(content?: Record<string, unknown>, meta?: Meta, attributes?: Attributes) {
     super(content, meta, attributes);

diff --git a/packages/apidom-ns-openapi-2/src/elements/PathItem.ts b/packages/apidom-ns-openapi-2/src/elements/PathItem.ts
@@ -8,6 +8,9 @@ import {
 
 import OperationElement from './Operation.ts';
 
+/**
+ * @public
+ */
 class PathItem extends ObjectElement {
   constructor(content?: Record<string, unknown>, meta?: Meta, attributes?: Attributes) {
     super(content, meta, attributes);

diff --git a/packages/apidom-ns-openapi-2/src/elements/Paths.ts b/packages/apidom-ns-openapi-2/src/elements/Paths.ts
@@ -1,5 +1,8 @@
 import { ObjectElement, Attributes, Meta } from '@swagger-api/apidom-core';
 
+/**
+ * @public
+ */
 class Paths extends ObjectElement {
   constructor(content?: Record<string, unknown>, meta?: Meta, attributes?: Attributes) {
     super(content, meta, attributes);

diff --git a/packages/apidom-ns-openapi-2/src/elements/Reference.ts b/packages/apidom-ns-openapi-2/src/elements/Reference.ts
@@ -1,5 +1,8 @@
 import { StringElement, ObjectElement, Attributes, Meta } from '@swagger-api/apidom-core';
 
+/**
+ * @public
+ */
 class Reference extends ObjectElement {
   constructor(content?: Record<string, unknown>, meta?: Meta, attributes?: Attributes) {
     super(content, meta, attributes);

diff --git a/packages/apidom-ns-openapi-2/src/elements/Response.ts b/packages/apidom-ns-openapi-2/src/elements/Response.ts
@@ -4,6 +4,9 @@ import SchemaElement from './Schema.ts';
 import HeadersElement from './Headers.ts';
 import ExampleElement from './Example.ts';
 
+/**
+ * @public
+ */
 class Response extends ObjectElement {
   constructor(content?: Record<string, unknown>, meta?: Meta, attributes?: Attributes) {
     super(content, meta, attributes);

diff --git a/packages/apidom-ns-openapi-2/src/elements/Responses.ts b/packages/apidom-ns-openapi-2/src/elements/Responses.ts
@@ -3,6 +3,9 @@ import { ObjectElement, Attributes, Meta } from '@swagger-api/apidom-core';
 import ResponseElement from './Response.ts';
 import ReferenceElement from './Reference.ts';
 
+/**
+ * @public
+ */
 class Responses extends ObjectElement {
   constructor(content?: Record<string, unknown>, meta?: Meta, attributes?: Attributes) {
     super(content, meta, attributes);

diff --git a/packages/apidom-ns-openapi-2/src/elements/ResponsesDefinitions.ts b/packages/apidom-ns-openapi-2/src/elements/ResponsesDefinitions.ts
@@ -1,5 +1,8 @@
 import { ObjectElement, Attributes, Meta } from '@swagger-api/apidom-core';
 
+/**
+ * @public
+ */
 class ResponsesDefinitions extends ObjectElement {
   constructor(content?: Record<string, unknown>, meta?: Meta, attributes?: Attributes) {
     super(content, meta, attributes);

diff --git a/packages/apidom-ns-openapi-2/src/elements/Schema.ts b/packages/apidom-ns-openapi-2/src/elements/Schema.ts
@@ -14,6 +14,9 @@ import {
 } from '@swagger-api/apidom-ns-json-schema-draft-4';
 
 /* eslint-disable class-methods-use-this */
+/**
+ * @public
+ */
 class Schema extends JSONSchemaElement {
   constructor(content?: Record<string, unknown>, meta?: Meta, attributes?: Attributes) {
     super(content, meta, attributes);

diff --git a/packages/apidom-ns-openapi-2/src/elements/Scopes.ts b/packages/apidom-ns-openapi-2/src/elements/Scopes.ts
@@ -1,5 +1,8 @@
 import { ObjectElement, Attributes, Meta } from '@swagger-api/apidom-core';
 
+/**
+ * @public
+ */
 class Scopes extends ObjectElement {
   constructor(content?: Record<string, unknown>, meta?: Meta, attributes?: Attributes) {
     super(content, meta, attributes);

diff --git a/packages/apidom-ns-openapi-2/src/elements/SecurityDefinitions.ts b/packages/apidom-ns-openapi-2/src/elements/SecurityDefinitions.ts
@@ -1,5 +1,8 @@
 import { ObjectElement, Attributes, Meta } from '@swagger-api/apidom-core';
 
+/**
+ * @public
+ */
 class SecurityDefinitions extends ObjectElement {
   constructor(content?: Record<string, unknown>, meta?: Meta, attributes?: Attributes) {
     super(content, meta, attributes);

diff --git a/packages/apidom-ns-openapi-2/src/elements/SecurityRequirement.ts b/packages/apidom-ns-openapi-2/src/elements/SecurityRequirement.ts
@@ -1,5 +1,8 @@
 import { ObjectElement, Attributes, Meta } from '@swagger-api/apidom-core';
 
+/**
+ * @public
+ */
 class SecurityRequirement extends ObjectElement {
   constructor(content?: Record<string, unknown>, meta?: Meta, attributes?: Attributes) {
     super(content, meta, attributes);

diff --git a/packages/apidom-ns-openapi-2/src/elements/SecurityScheme.ts b/packages/apidom-ns-openapi-2/src/elements/SecurityScheme.ts
@@ -6,6 +6,9 @@ import {
   Meta,
 } from '@swagger-api/apidom-core';
 
+/**
+ * @public
+ */
 class SecurityScheme extends ObjectElement {
   constructor(content?: Record<string, unknown>, meta?: Meta, attributes?: Attributes) {
     super(content, meta, attributes);

diff --git a/packages/apidom-ns-openapi-2/src/elements/Swagger.ts b/packages/apidom-ns-openapi-2/src/elements/Swagger.ts
@@ -15,6 +15,9 @@ import ResponsesDefinitionsElement from './ResponsesDefinitions.ts';
 import SecurityDefinitionsElement from './SecurityDefinitions.ts';
 import ExternalDocumentationElement from './ExternalDocumentation.ts';
 
+/**
+ * @public
+ */
 class Swagger extends ObjectElement {
   constructor(content?: Record<string, unknown>, meta?: Meta, attributes?: Attributes) {
     super(content, meta, attributes);

diff --git a/packages/apidom-ns-openapi-2/src/elements/SwaggerVersion.ts b/packages/apidom-ns-openapi-2/src/elements/SwaggerVersion.ts
@@ -1,5 +1,8 @@
 import { StringElement, Attributes, Meta } from '@swagger-api/apidom-core';
 
+/**
+ * @public
+ */
 class SwaggerVersion extends StringElement {
   constructor(content?: string, meta?: Meta, attributes?: Attributes) {
     super(content, meta, attributes);

diff --git a/packages/apidom-ns-openapi-2/src/elements/Tag.ts b/packages/apidom-ns-openapi-2/src/elements/Tag.ts
@@ -2,6 +2,9 @@ import { ObjectElement, StringElement, Attributes, Meta } from '@swagger-api/api
 
 import ExternalDocumentationElement from './ExternalDocumentation.ts';
 
+/**
+ * @public
+ */
 class Tag extends ObjectElement {
   constructor(content?: Record<string, unknown>, meta?: Meta, attributes?: Attributes) {
     super(content, meta, attributes);

diff --git a/packages/apidom-ns-openapi-2/src/elements/Xml.ts b/packages/apidom-ns-openapi-2/src/elements/Xml.ts
@@ -6,6 +6,9 @@ import {
   Meta,
 } from '@swagger-api/apidom-core';
 
+/**
+ * @public
+ */
 class Xml extends ObjectElement {
   constructor(content?: Record<string, unknown>, meta?: Meta, attributes?: Attributes) {
     super(content, meta, attributes);

diff --git a/packages/apidom-ns-openapi-2/src/elements/nces/OperationConsumes.ts b/packages/apidom-ns-openapi-2/src/elements/nces/OperationConsumes.ts
@@ -1,5 +1,8 @@
 import { ArrayElement, Attributes, Meta } from '@swagger-api/apidom-core';
 
+/**
+ * @public
+ */
 class OperationConsumes extends ArrayElement {
   static primaryClass = 'operation-consumes';
 

diff --git a/packages/apidom-ns-openapi-2/src/elements/nces/OperationParameters.ts b/packages/apidom-ns-openapi-2/src/elements/nces/OperationParameters.ts
@@ -1,5 +1,8 @@
 import { ArrayElement, Attributes, Meta } from '@swagger-api/apidom-core';
 
+/**
+ * @public
+ */
 class OperationParameters extends ArrayElement {
   static primaryClass = 'operation-parameters';
 

diff --git a/packages/apidom-ns-openapi-2/src/elements/nces/OperationProduces.ts b/packages/apidom-ns-openapi-2/src/elements/nces/OperationProduces.ts
@@ -1,5 +1,8 @@
 import { ArrayElement, Attributes, Meta } from '@swagger-api/apidom-core';
 
+/**
+ * @public
+ */
 class OperationProduces extends ArrayElement {
   static primaryClass = 'operation-produces';
 

diff --git a/packages/apidom-ns-openapi-2/src/elements/nces/OperationSchemes.ts b/packages/apidom-ns-openapi-2/src/elements/nces/OperationSchemes.ts
@@ -1,5 +1,8 @@
 import { ArrayElement, Attributes, Meta } from '@swagger-api/apidom-core';
 
+/**
+ * @public
+ */
 class OperationSchemes extends ArrayElement {
   static primaryClass = 'operation-schemes';
 

diff --git a/packages/apidom-ns-openapi-2/src/elements/nces/OperationSecurity.ts b/packages/apidom-ns-openapi-2/src/elements/nces/OperationSecurity.ts
@@ -1,5 +1,8 @@
 import { ArrayElement, Attributes, Meta } from '@swagger-api/apidom-core';
 
+/**
+ * @public
+ */
 class OperationSecurity extends ArrayElement {
   static primaryClass = 'operation-security';
 

diff --git a/packages/apidom-ns-openapi-2/src/elements/nces/OperationTags.ts b/packages/apidom-ns-openapi-2/src/elements/nces/OperationTags.ts
@@ -1,5 +1,8 @@
 import { ArrayElement, Attributes, Meta } from '@swagger-api/apidom-core';
 
+/**
+ * @public
+ */
 class OperationTags extends ArrayElement {
   static primaryClass = 'operation-tags';
 

diff --git a/packages/apidom-ns-openapi-2/src/elements/nces/PathItemParameters.ts b/packages/apidom-ns-openapi-2/src/elements/nces/PathItemParameters.ts
@@ -1,5 +1,8 @@
 import { ArrayElement, Attributes, Meta } from '@swagger-api/apidom-core';
 
+/**
+ * @public
+ */
 class PathItemParameters extends ArrayElement {
   static primaryClass = 'path-item-parameters';
 

diff --git a/packages/apidom-ns-openapi-2/src/elements/nces/SwaggerConsumes.ts b/packages/apidom-ns-openapi-2/src/elements/nces/SwaggerConsumes.ts
@@ -1,5 +1,8 @@
 import { ArrayElement, Attributes, Meta } from '@swagger-api/apidom-core';
 
+/**
+ * @public
+ */
 class SwaggerConsumes extends ArrayElement {
   static primaryClass = 'swagger-consumes';
 

diff --git a/packages/apidom-ns-openapi-2/src/elements/nces/SwaggerProduces.ts b/packages/apidom-ns-openapi-2/src/elements/nces/SwaggerProduces.ts
@@ -1,5 +1,8 @@
 import { ArrayElement, Attributes, Meta } from '@swagger-api/apidom-core';
 
+/**
+ * @public
+ */
 class SwaggerProduces extends ArrayElement {
   static primaryClass = 'swagger-produces';
 

diff --git a/packages/apidom-ns-openapi-2/src/elements/nces/SwaggerSchemes.ts b/packages/apidom-ns-openapi-2/src/elements/nces/SwaggerSchemes.ts
@@ -1,5 +1,8 @@
 import { ArrayElement, Attributes, Meta } from '@swagger-api/apidom-core';
 
+/**
+ * @public
+ */
 class SwaggerSchemes extends ArrayElement {
   static primaryClass = 'swagger-schemes';