chore(core): use API Extractor for TypeScript rollup (#4509)

Refs #4382

Author: glowcloud

packages/apidom-core/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-core/config/rollup/types.dist.js

@@ -14,11 +14,11 @@
   "unpkg": "./dist/apidom-core.browser.min.js",
   "main": "./src/index.cjs",
   "exports": {
-    "types": "./types/dist.d.ts",
+    "types": "./types/apidom-core.d.ts",
     "import": "./src/index.mjs",
     "require": "./src/index.cjs"
   },
-  "types": "./types/dist.d.ts",
+  "types": "./types/apidom-core.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'",
@@ -28,7 +28,7 @@
     "lint:fix": "eslint ./ --fix",
     "clean": "rimraf --glob 'src/**/*.mjs' 'src/**/*.cjs' 'test/**/*.mjs' ./dist ./types",
     "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 && copyfiles -u 2 ../@types/minim.d.ts ./types && node ../../scripts/file-replace-bof.js './types/dist.d.ts' '/// <reference path=\"./minim.d.ts\" />\nimport * as minim from \"minim\";'",
+    "typescript:declaration": "tsc -p tsconfig.declaration.json && api-extractor run -l -c ./config/api-extractor/api-extractor.json && copyfiles -u 2 ../@types/minim.d.ts ./types && node ./scripts/file-replace-bof.js './types/apidom-core.d.ts' '/// <reference path=\"./minim.d.ts\" />\nimport * as minim from \"minim\";'",
     "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 NODE_ENV=test mocha",
     "prepack": "copyfiles -u 3 ../../LICENSES/* LICENSES && copyfiles -u 2 ../../NOTICE .",
@@ -55,7 +55,7 @@
     "src/**/*.mjs",
     "src/**/*.cjs",
     "dist/",
-    "types/dist.d.ts",
+    "types/apidom-core.d.ts",
     "types/minim.d.ts",
     "LICENSES",
     "NOTICE",

packages/apidom-core/package.json

@@ -8,7 +8,6 @@ const filePath = path.join(cwd, fileName);
 const fileContent = fs.readFileSync(filePath).toString();
 const lines = fileContent.split('\n');
 
-lines.shift();
 lines.unshift(bofContent);
 
 const newFileContent = lines.join('\n');

scripts/file-replace-bof.js renamed to packages/apidom-core/scripts/file-replace-bof.js

@@ -1,10 +1,16 @@
 import { ApiDOMStructuredError } from '@swagger-api/apidom-error';
 import type { ApiDOMErrorOptions } from '@swagger-api/apidom-error';
 
-interface CloneErrorOptions extends ApiDOMErrorOptions {
+/**
+ * @public
+ */
+export interface CloneErrorOptions extends ApiDOMErrorOptions {
   readonly value: unknown;
 }
 
+/**
+ * @public
+ */
 class CloneError extends ApiDOMStructuredError {
   public readonly value: unknown;
 

packages/apidom-core/src/clone/errors/CloneError.ts

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

packages/apidom-core/src/clone/errors/DeepCloneError.ts

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

packages/apidom-core/src/clone/errors/ShallowCloneError.ts

@@ -4,12 +4,21 @@ import { isElement } from '../predicates/index.ts';
 import DeepCloneError from './errors/DeepCloneError.ts';
 import ShallowCloneError from './errors/ShallowCloneError.ts';
 
-type FinalCloneTypes = KeyValuePair | ArraySlice | ObjectSlice;
-
-type DeepCloneOptions<T extends Element | FinalCloneTypes> = {
+/**
+ * @public
+ */
+export type FinalCloneTypes = KeyValuePair | ArraySlice | ObjectSlice;
+
+/**
+ * @public
+ */
+export type DeepCloneOptions<T extends Element | FinalCloneTypes> = {
   visited?: WeakMap<T, T>;
 };
 
+/**
+ * @public
+ */
 export const cloneDeep = <T extends Element | FinalCloneTypes>(
   value: T,
   options: DeepCloneOptions<T> = {},
@@ -137,6 +146,9 @@ const cloneShallowElement = <T extends Element>(element: T): T => {
 };
 /* eslint-enable */
 
+/**
+ * @public
+ */
 export const cloneShallow = <T extends Element | FinalCloneTypes>(value: T): T => {
   if (value instanceof KeyValuePair) {
     return cloneShallowKeyValuePair(value) as T;

packages/apidom-core/src/clone/index.ts

@@ -1,5 +1,8 @@
 import { Attributes, Meta, StringElement } from 'minim';
 
+/**
+ * @public
+ */
 class Annotation extends StringElement {
   // classes: warning | error
 

packages/apidom-core/src/elements/Annotation.ts

@@ -1,5 +1,8 @@
 import { Attributes, Meta, StringElement } from 'minim';
 
+/**
+ * @public
+ */
 class Comment extends StringElement {
   constructor(content?: string, meta?: Meta, attributes?: Attributes) {
     super(content, meta, attributes);

packages/apidom-core/src/elements/Comment.ts

@@ -1,6 +1,9 @@
 import { ArrayElement, ArraySlice, Attributes, Element, Meta } from 'minim';
 import { isUndefined } from 'ramda-adjunct';
 
+/**
+ * @public
+ */
 class ParseResult extends ArrayElement {
   constructor(content?: Array<any>, meta?: Meta, attributes?: Attributes) {
     super(content, meta, attributes);

packages/apidom-core/src/elements/ParseResult.ts

@@ -1,16 +1,25 @@
 import { ArrayElement, Element, Attributes, Meta } from 'minim';
 
+/**
+ * @public
+ */
 export interface Position {
   row: number;
   column: number;
   char: number;
 }
 
+/**
+ * @public
+ */
 export interface PositionRange {
   start: Position;
   end: Position;
 }
 
+/**
+ * @public
+ */
 class SourceMap extends ArrayElement {
   constructor(content?: Array<any>, meta?: Meta, attributes?: Attributes) {
     super(content, meta, attributes);

packages/apidom-core/src/elements/SourceMap.ts

@@ -1,10 +1,16 @@
 import { ApiDOMStructuredError } from '@swagger-api/apidom-error';
 import type { ApiDOMErrorOptions } from '@swagger-api/apidom-error';
 
-interface ElementIdentityErrorOptions extends ApiDOMErrorOptions {
+/**
+ * @public
+ */
+export interface ElementIdentityErrorOptions extends ApiDOMErrorOptions {
   readonly value: unknown;
 }
 
+/**
+ * @public
+ */
 class ElementIdentityError extends ApiDOMStructuredError {
   public readonly value: unknown;
 

packages/apidom-core/src/identity/errors/ElementIdentityError.ts

@@ -4,6 +4,9 @@ import ShortUniqueId from 'short-unique-id';
 import ElementIdentityError from './errors/ElementIdentityError.ts';
 import { isElement, isStringElement } from '../predicates/index.ts';
 
+/**
+ * @public
+ */
 export class IdentityManager {
   protected readonly uuid: ShortUniqueId;
 
@@ -57,4 +60,7 @@ export class IdentityManager {
   }
 }
 
+/**
+ * @public
+ */
 export const defaultIdentityManager = new IdentityManager();

packages/apidom-core/src/identity/index.ts

@@ -7,6 +7,7 @@ export type {
 
 export { default as refractorPluginElementIdentity } from './refractor/plugins/element-identity.ts';
 export { default as refractorPluginSemanticElementIdentity } from './refractor/plugins/semantic-element-identity.ts';
+export type { Predicates } from './refractor/plugins/semantic-element-identity.ts';
 
 export { default as MediaTypes } from './media-types.ts';
 
@@ -30,6 +31,8 @@ export {
   SourceMapElement,
 } from './refractor/registration.ts';
 
+export type { default as createToolbox, Toolbox, basePredicates } from './refractor/toolbox.ts';
+
 export {
   isElement,
   isStringElement,
@@ -49,10 +52,25 @@ export {
   includesSymbols,
   includesClasses,
 } from './predicates/index.ts';
-export type { ElementPredicate } from './predicates/helpers.ts';
+export type { PrimitiveElement } from './predicates/index.ts';
+export type {
+  ElementPredicate,
+  PredicateCreator,
+  PredicateHelpers,
+  hasMethod,
+  hasBasicElementProps,
+  primitiveEq,
+  isElementType,
+  hasClass,
+  ElementBasicsTrait,
+  ElementPrimitiveBehavior,
+  ElementClassesTrait,
+  ElementTypeTrait,
+} from './predicates/helpers.ts';
 export { default as createPredicate } from './predicates/helpers.ts';
 
 export { filter, reject, find, findAtOffset, some, traverse, parents } from './traversal/index.ts';
+export type { FindAtOffsetOptions } from './traversal/index.ts';
 export {
   visit,
   BREAK,
@@ -61,18 +79,22 @@ export {
   cloneNode,
   keyMapDefault as keyMap,
 } from './traversal/visitor.ts';
+export type { Callback, TraverseOptions } from './traversal/traverse.ts';
 
 export { transclude, default as Transcluder } from './transcluder/index.ts';
 
 export { dereference } from './util.ts';
 
 export { cloneShallow, cloneDeep } from './clone/index.ts';
 export { default as CloneError } from './clone/errors/CloneError.ts';
+export type { CloneErrorOptions } from './clone/errors/CloneError.ts';
 export { default as DeepCloneError } from './clone/errors/DeepCloneError.ts';
 export { default as ShallowCloneError } from './clone/errors/ShallowCloneError.ts';
+export type { FinalCloneTypes, DeepCloneOptions } from './clone/index.ts';
 
 export { defaultIdentityManager, IdentityManager } from './identity/index.ts';
 export { default as ElementIdentityError } from './identity/errors/ElementIdentityError.ts';
+export type { ElementIdentityErrorOptions } from './identity/errors/ElementIdentityError.ts';
 
 /**
  * Transforms data to an Element from a particular namespace.
@@ -110,7 +132,18 @@ export { default as toString } from './transformers/to-string.ts';
 export { default as sexprs } from './transformers/sexprs.ts';
 
 export { default as deepmerge } from './merge/deepmerge.ts';
-export type { DeepMergeUserOptions, ObjectOrArrayElement } from './merge/deepmerge.ts';
+export type {
+  DeepMergeUserOptions,
+  ObjectOrArrayElement,
+  AnyElement,
+  DeepMerge,
+  DeepMergeOptions,
+  ArrayElementMerge as DeepMergeArrayElementMerge,
+  ObjectElementMerge as DeepMergeObjectElementMerge,
+  CustomMerge as DeepMergeCustomMerge,
+  CustomMetaMerge as DeepMergeCustomMetaMerge,
+  CustomAttributesMerge as DeepMergeCustomAttributesMerge,
+} from './merge/deepmerge.ts';
 export { default as mergeRight } from './merge/merge-right.ts';
 export type { MergeRightOptions } from './merge/merge-right.ts';
 export { default as mergeLeft } from './merge/merge-left.ts';

packages/apidom-core/src/index.ts

@@ -1,5 +1,8 @@
 import { NotImplementedError } from '@swagger-api/apidom-error';
 
+/**
+ * @public
+ */
 class MediaTypes<T> extends Array<T> {
   unknownMediaType = 'application/octet-stream';