chore(parser-adapter-workflows-yaml-1): use API Extractor for TypeScr…

…ipt rollup (#4527) Refs #4382
swagger-api · Nov 21, 2024 · ec9053d · ec9053d
1 parent 6ee0532
commit ec9053d
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 15 deletions.
diff --git a/packages/apidom-parser-adapter-workflows-yaml-1/config/api-extractor/api-extractor.json b/packages/apidom-parser-adapter-workflows-yaml-1/config/api-extractor/api-extractor.json
@@ -0,0 +1,5 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+  "extends": "../../../../api-extractor.json",
+  "mainEntryPointFilePath": "../../types/adapter.d.ts"
+}
diff --git a/packages/apidom-parser-adapter-workflows-yaml-1/config/rollup/types.dist.js b/packages/apidom-parser-adapter-workflows-yaml-1/config/rollup/types.dist.js
diff --git a/packages/apidom-parser-adapter-workflows-yaml-1/package.json b/packages/apidom-parser-adapter-workflows-yaml-1/package.json
@@ -11,11 +11,11 @@
   "unpkg": "./dist/apidom-parser-adapter-workflows-yaml-1.browser.min.js",
   "main": "./src/adapter.cjs",
   "exports": {
-    "types": "./types/dist.d.ts",
+    "types": "./types/apidom-parser-adapter-workflows-yaml-1.d.ts",
     "import": "./src/adapter.mjs",
     "require": "./src/adapter.cjs"
   },
-  "types": "./types/dist.d.ts",
+  "types": "./types/apidom-parser-adapter-workflows-yaml-1.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'",
@@ -25,7 +25,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",
+    "typescript:declaration": "tsc -p tsconfig.declaration.json && api-extractor run -l -c ./config/api-extractor/api-extractor.json",
     "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",
     "prepack": "copyfiles -u 3 ../../LICENSES/* LICENSES && copyfiles -u 2 ../../NOTICE .",
     "postpack": "rimraf NOTICE LICENSES"
@@ -49,7 +49,7 @@
     "src/**/*.mjs",
     "src/**/*.cjs",
     "dist/",
-    "types/dist.d.ts",
+    "types/apidom-parser-adapter-workflows-yaml-1.d.ts",
     "LICENSES",
     "NOTICE",
     "README.md",

diff --git a/packages/apidom-parser-adapter-workflows-yaml-1/src/adapter.ts b/packages/apidom-parser-adapter-workflows-yaml-1/src/adapter.ts
@@ -11,12 +11,21 @@ import workflowsNamespace, {
 
 export { default as mediaTypes } from './media-types.ts';
 
+/**
+ * @public
+ */
 export const detectionRegExp =
   /(?<YAML>^(["']?)workflowsSpec\2\s*:\s*(["']?)(?<version_yaml>1\.(?:[1-9]\d*|0)\.(?:[1-9]\d*|0))\3(?:\s+|$))|(?<JSON>"workflowsSpec"\s*:\s*"(?<version_json>1\.(?:[1-9]\d*|0)\.(?:[1-9]\d*|0))")/m;
 
+/**
+ * @public
+ */
 export const detect = async (source: string): Promise<boolean> =>
   detectionRegExp.test(source) && (await detectYAML(source));
 
+/**
+ * @public
+ */
 export const parse = async (
   source: string,
   options: Record<string, unknown> = {},
@@ -38,4 +47,7 @@ export const parse = async (
   return parseResultElement;
 };
 
+/**
+ * @public
+ */
 export const namespace = createNamespace(workflowsNamespace);
diff --git a/packages/apidom-parser-adapter-workflows-yaml-1/src/media-types.ts b/packages/apidom-parser-adapter-workflows-yaml-1/src/media-types.ts
@@ -1,5 +1,8 @@
 import { mediaTypes, WorkflowsMediaTypes } from '@swagger-api/apidom-ns-workflows-1';
 
+/**
+ * @public
+ */
 const yamlMediaTypes = new WorkflowsMediaTypes(
   ...mediaTypes.filterByFormat('generic'),
   ...mediaTypes.filterByFormat('yaml'),