chore(reference): use API Extractor for TypeScript rollup (#4538)

Refs #4382

packages/apidom-reference/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-reference/package.json

@@ -19,22 +19,22 @@
     "./src/resolve/resolvers/file/index-node.mjs": "./src/resolve/resolvers/file/index-browser.mjs"
   },
   "main": "./src/configuration/saturated.cjs",
-  "types": "./types/dist.d.ts",
+  "types": "./types/apidom-reference.d.ts",
   "exports": {
     ".": {
       "import": "./src/configuration/saturated.mjs",
       "require": "./src/configuration/saturated.cjs",
-      "types": "./types/dist.d.ts"
+      "types": "./types/apidom-reference.d.ts"
     },
     "./configuration/saturated": {
       "import": "./src/configuration/saturated.mjs",
       "require": "./src/configuration/saturated.cjs",
-      "types": "./types/dist.d.ts"
+      "types": "./types/apidom-reference.d.ts"
     },
     "./configuration/empty": {
       "import": "./src/configuration/empty.mjs",
       "require": "./src/configuration/empty.cjs",
-      "types": "./types/dist.d.ts"
+      "types": "./types/apidom-reference.d.ts"
     },
     "./resolve/resolvers/file": {
       "browser": {
@@ -246,7 +246,7 @@
     "perf": "cross-env BABEL_ENV=es babel ./test/perf/index.ts --out-file ./test/perf/index.mjs --root-mode 'upward' && cross-env NODE_ENV=test node ./test/perf/index.mjs",
     "perf:openapi-3-1-dereference": "cross-env BABEL_ENV=es babel ./test/perf/openapi-3-1-dereference.ts --out-file ./test/perf/openapi-3-1-dereference.mjs --root-mode 'upward' && cross-env NODE_ENV=test node ./test/perf/openapi-3-1-dereference.mjs",
     "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",
     "prepack": "copyfiles -u 3 ../../LICENSES/* LICENSES && copyfiles -u 2 ../../NOTICE .",
     "postpack": "rimraf NOTICE LICENSES"
   },

packages/apidom-reference/src/File.ts

@@ -6,6 +6,7 @@ import * as url from './util/url.ts';
 
 /**
  * This class represents a File object with url and data.
+ * @public
  */
 
 export interface FileOptions {
@@ -15,6 +16,9 @@ export interface FileOptions {
   readonly parseResult?: ParseResultElement;
 }
 
+/**
+ * @public
+ */
 class File {
   public uri: string;
 

packages/apidom-reference/src/Reference.ts

@@ -2,13 +2,19 @@ import { Element } from '@swagger-api/apidom-core';
 
 import ReferenceSet from './ReferenceSet.ts';
 
+/**
+ * @public
+ */
 export interface ReferenceOptions<T = Element> {
   readonly uri: string;
   readonly depth?: number;
   readonly refSet?: ReferenceSet;
   readonly value: T;
 }
 
+/**
+ * @public
+ */
 class Reference<T = Element> {
   public readonly uri: string;
 

packages/apidom-reference/src/ReferenceSet.ts

@@ -2,11 +2,17 @@ import { isNotUndefined, isString } from 'ramda-adjunct';
 
 import type Reference from './Reference.ts';
 
+/**
+ * @public
+ */
 export interface ReferenceSetOptions {
   readonly refs?: Reference[];
   readonly circular?: boolean;
 }
 
+/**
+ * @public
+ */
 class ReferenceSet {
   public rootRef?: Reference;
 

packages/apidom-reference/src/bundle/strategies/BundleStrategy.ts

@@ -3,10 +3,16 @@ import { ParseResultElement } from '@swagger-api/apidom-core';
 import File from '../../File.ts';
 import type { ReferenceOptions } from '../../options/index.ts';
 
+/**
+ * @public
+ */
 export interface BundleStrategyOptions {
   readonly name: string;
 }
 
+/**
+ * @public
+ */
 abstract class BundleStrategy {
   public readonly name: string;
 

packages/apidom-reference/src/dereference/strategies/DereferenceStrategy.ts

@@ -3,10 +3,16 @@ import { Element } from 'minim';
 import File from '../../File.ts';
 import type { ReferenceOptions } from '../../options/index.ts';
 
+/**
+ * @public
+ */
 export interface DereferenceStrategyOptions {
   readonly name: string;
 }
 
+/**
+ * @public
+ */
 abstract class DereferenceStrategy {
   public readonly name: string;
 

packages/apidom-reference/src/dereference/util.ts

@@ -1,5 +1,8 @@
 import { Element, isElement } from '@swagger-api/apidom-core';
 
+/**
+ * @public
+ */
 // eslint-disable-next-line import/prefer-default-export
 export class AncestorLineage<T extends Element> extends Array<Set<T>> {
   includesCycle(element: T) {

packages/apidom-reference/src/errors/BundleError.ts

@@ -1,5 +1,8 @@
 import { ApiDOMError } from '@swagger-api/apidom-error';
 
+/**
+ * @public
+ */
 class BundleError extends ApiDOMError {}
 
 export default BundleError;

packages/apidom-reference/src/errors/DereferenceError.ts

@@ -1,5 +1,8 @@
 import { ApiDOMError } from '@swagger-api/apidom-error';
 
+/**
+ * @public
+ */
 class DereferenceError extends ApiDOMError {}
 
 export default DereferenceError;

packages/apidom-reference/src/errors/EvaluationElementIdError.ts

@@ -1,5 +1,8 @@
 import { ApiDOMError } from '@swagger-api/apidom-error';
 
+/**
+ * @public
+ */
 class EvaluationElementIdError extends ApiDOMError {}
 
 export default EvaluationElementIdError;

packages/apidom-reference/src/errors/EvaluationJsonSchema$anchorError.ts

@@ -1,5 +1,8 @@
 import JsonSchema$anchorError from './JsonSchema$anchorError.ts';
 
+/**
+ * @public
+ */
 class EvaluationJsonSchema$anchorError extends JsonSchema$anchorError {}
 
 export default EvaluationJsonSchema$anchorError;

packages/apidom-reference/src/errors/EvaluationJsonSchemaUriError.ts

@@ -1,5 +1,8 @@
 import JsonSchemaUriError from './JsonSchemaUriError.ts';
 
+/**
+ * @public
+ */
 class EvaluationJsonSchemaUriError extends JsonSchemaUriError {}
 
 export default EvaluationJsonSchemaUriError;

packages/apidom-reference/src/errors/InvalidJsonSchema$anchorError.ts

@@ -1,5 +1,8 @@
 import JsonSchema$anchorError from './JsonSchema$anchorError.ts';
 
+/**
+ * @public
+ */
 class InvalidJsonSchema$anchorError extends JsonSchema$anchorError {
   constructor(anchor: string) {
     super(`Invalid JSON Schema $anchor "${anchor}".`);

packages/apidom-reference/src/errors/JsonSchema$anchorError.ts

@@ -1,5 +1,8 @@
 import { ApiDOMError } from '@swagger-api/apidom-error';
 
+/**
+ * @public
+ */
 class JsonSchema$anchorError extends ApiDOMError {}
 
 export default JsonSchema$anchorError;

packages/apidom-reference/src/errors/JsonSchemaUriError.ts

@@ -1,5 +1,8 @@
 import { ApiDOMError } from '@swagger-api/apidom-error';
 
+/**
+ * @public
+ */
 class JsonSchemaUriError extends ApiDOMError {}
 
 export default JsonSchemaUriError;

packages/apidom-reference/src/errors/MaximumBundleDepthError.ts

@@ -1,5 +1,8 @@
 import BundleError from './BundleError.ts';
 
+/**
+ * @public
+ */
 class MaximumBundleDepthError extends BundleError {}
 
 export default MaximumBundleDepthError;

packages/apidom-reference/src/errors/MaximumDereferenceDepthError.ts

@@ -1,5 +1,8 @@
 import DereferenceError from './DereferenceError.ts';
 
+/**
+ * @public
+ */
 class MaximumDereferenceDepthError extends DereferenceError {}
 
 export default MaximumDereferenceDepthError;

packages/apidom-reference/src/errors/MaximumResolveDepthError.ts

@@ -1,5 +1,8 @@
 import ResolveError from './ResolveError.ts';
 
+/**
+ * @public
+ */
 class MaximumResolveDepthError extends ResolveError {}
 
 export default MaximumResolveDepthError;

packages/apidom-reference/src/errors/ParseError.ts

@@ -1,5 +1,8 @@
 import { ApiDOMError } from '@swagger-api/apidom-error';
 
+/**
+ * @public
+ */
 class ParseError extends ApiDOMError {}
 
 export default ParseError;

packages/apidom-reference/src/errors/ParserError.ts

@@ -1,5 +1,8 @@
 import ParseError from './ParseError.ts';
 
+/**
+ * @public
+ */
 class ParserError extends ParseError {}
 
 export default ParserError;

packages/apidom-reference/src/errors/PluginError.ts

@@ -1,5 +1,8 @@
 import { ApiDOMError } from '@swagger-api/apidom-error';
 
+/**
+ * @public
+ */
 class PluginError extends ApiDOMError {
   public plugin: any;
 

packages/apidom-reference/src/errors/ResolveError.ts

@@ -1,5 +1,8 @@
 import { ApiDOMError } from '@swagger-api/apidom-error';
 
+/**
+ * @public
+ */
 class ResolveError extends ApiDOMError {}
 
 export default ResolveError;

packages/apidom-reference/src/errors/ResolverError.ts

@@ -1,5 +1,8 @@
 import ResolveError from './ResolveError.ts';
 
+/**
+ * @public
+ */
 class ResolverError extends ResolveError {}
 
 export default ResolverError;

packages/apidom-reference/src/errors/UnmatchedBundleStrategyError.ts

@@ -1,5 +1,8 @@
 import BundleError from './BundleError.ts';
 
+/**
+ * @public
+ */
 class UnmatchedBundleStrategyError extends BundleError {}
 
 export default UnmatchedBundleStrategyError;

packages/apidom-reference/src/errors/UnmatchedDereferenceStrategyError.ts

@@ -1,5 +1,8 @@
 import DereferenceError from './DereferenceError.ts';
 
+/**
+ * @public
+ */
 class UnmatchedDereferenceStrategyError extends DereferenceError {}
 
 export default UnmatchedDereferenceStrategyError;

packages/apidom-reference/src/errors/UnmatchedResolveStrategyError.ts

@@ -1,5 +1,8 @@
 import ResolveError from './ResolveError.ts';
 
+/**
+ * @public
+ */
 class UnmatchedResolveStrategyError extends ResolveError {}
 
 export default UnmatchedResolveStrategyError;

packages/apidom-reference/src/errors/UnmatchedResolverError.ts

@@ -1,5 +1,8 @@
 import ResolverError from './ResolverError.ts';
 
+/**
+ * @public
+ */
 class UnmatchedResolverError extends ResolverError {}
 
 export default UnmatchedResolverError;