@arcgis/api-extractor 5.0.0-next.61 → 5.0.0-next.63

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli.js

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+import { Command as i } from "@commander-js/extra-typings";
+const e = new i();
+e.name("api-extractor").description("Extract public API from a TypeScript project to produce .d.ts types and api.json docs");
+e.command("diff-types").description("Generate a types diff summary .md file").requiredOption("--original-dts <originalTypings>", "Path to the original types folder").requiredOption("--new-dts <newTypings>", "Path to the new types folder").option("--output-md <outputMd>", "Path to the output markdown file", "types-diff.md").option("--no-truncate", "Do not truncate output if it is longer than 1000 lines", !1).action(async (t) => {
+  const { diffTypes: o } = await import("./diffTypes/index.js");
+  await o({
+    originalDtsPath: t.originalDts,
+    newDtsPath: t.newDts,
+    outputMdPath: t.outputMd,
+    truncate: t.truncate
+  });
+});
+e.parse();

package/dist/diffTypes/index.d.ts

@@ -0,0 +1,24 @@
+interface DiffTypesOptions {
+    /**
+     * Path to the original types folder.
+     */
+    originalDtsPath: string;
+    /**
+     * Path to the new types folder.
+     */
+    newDtsPath: string;
+    /**
+     * Path to the output markdown file.
+     *
+     * @default "types-diff.md"
+     */
+    outputMdPath: string;
+    /**
+     * Whether to truncate output if the diff is longer than 1000 lines.
+     *
+     * @default true
+     */
+    truncate?: boolean;
+}
+export declare function diffTypes({ originalDtsPath, newDtsPath, outputMdPath, truncate, }: DiffTypesOptions): Promise<void>;
+export {};

package/dist/diffTypes/index.js

@@ -0,0 +1,65 @@
+import { path as s, sh as c } from "@arcgis/components-build-utils";
+import { mkdir as d, writeFile as m } from "node:fs/promises";
+const a = "diff --unified=2 --new-file --recursive";
+async function I({
+  originalDtsPath: t,
+  newDtsPath: n,
+  outputMdPath: e = "types-diff.md",
+  truncate: i = !0
+}) {
+  n = s.join(s.resolve(n), "/");
+  const l = c(`${a} ${t} ${n} || true`);
+  let o = "";
+  if (l.length === 0)
+    console.log("Public types did not change.");
+  else {
+    o = `### Public types changes
+
+🧐 please verify that the changes to the public API/doc below are intentional.
+🟥 If removing/changing APIs, remember the semver promise.
+🟩 If adding APIs, add to release notes.`;
+    let r = u(l.split(`
+`), n);
+    i && r.length > f && (o += `> [!WARNING]
+> Too many changes. Only displaying the first ${f} lines (total ${r.length}) of the diff. If you need to see complete diff, re-run this command with --no-truncate.
+
+`, r = r.slice(0, f)), o += `${h(r)}
+
+`, console.log(`Wrote diff to ${e}`);
+  }
+  await d(s.dirname(e), { recursive: !0 }), await m(e, o);
+}
+function u(t, n) {
+  for (let e = 0; e < t.length; e++) {
+    const i = t[e];
+    if (
+      // Make diff smaller by excluding the `diff ...` lines
+      (i.startsWith(a) || // Redundant line - make file header smaller
+      i.startsWith("---") || // Not important
+      i === "\") && (t.splice(e, 1), e--), i.startsWith("+++")
+    ) {
+      const l = i.indexOf("	");
+      let o = i.slice(4, l === -1 ? i.length : l);
+      o.startsWith(n) && (o = o.slice(n.length)), t[e] = `🟦 ${o}`;
+    }
+  }
+  return t;
+}
+const f = 1e3;
+function h(t) {
+  const n = t.length, e = g(t.join(`
+`));
+  return n <= 10 ? e : `<details><summary>See diff</summary>
+
+${e}
+
+</details>`;
+}
+function g(t) {
+  return `\`\`\`diff
+${t}
+\`\`\``;
+}
+export {
+  I as diffTypes
+};

package/dist/index.d.ts

@@ -9,4 +9,4 @@ export { apiMemberToNodeDoc, nodeDocToString, nodeDocToSynthesizedComment } from
 export { setApiDocFromJsDoc, setApiDocFromSymbol, symbolToDocs, getNodeDoc } from './utils/jsDocParser';
 export { typeScriptGlobals, typeScriptGlobalsViewUrlCommonPrefix } from './config/typeReferences/globals';
 export { printClass, printInterface, printMethod, printFunction, printSignature, printProperty, printGetterSetter, printVariable, printTypeAlias, printTypeParameters, } from './utils/partPrinter';
-export { apiExtractorError, apiExtractorErrorCount, resetApiExtractorErrorCount, setApiExtractorErrorLogger, type ApiExtractorErrorContext, } from './utils/error';
+export { apiExtractorError, apiExtractorErrorCount, resetApiExtractorErrorCount, setApiExtractorErrorLogger, apiExtractorDiagnosticContext, type ApiExtractorErrorContext, } from './utils/error';

package/dist/index.js

@@ -2,7 +2,7 @@ import d from "typescript";
 import $, { supportsColorStderr as z } from "chalk";
 import { path as q } from "@arcgis/components-build-utils";
 import { mappedFind as J } from "@arcgis/toolkit/array";
-const H = "@arcgis/api-extractor", j = "5.0.0-next.61";
+const H = "@arcgis/api-extractor", j = "5.0.0-next.63";
 let A;
 function X(e) {
   return A ??= d.createPrinter(), A.printNode(d.EmitHint.Unspecified, e, void 0);
@@ -11,8 +11,8 @@ function Q(e, t) {
   return e.pos !== -1 && e.end !== -1 && t !== void 0 ? e.getText(t) : X(e);
 }
 let N = 0;
-function Re() {
-  N = 0;
+function Re(e = 0) {
+  N = e;
 }
 let B = console.error;
 function Le(e) {
@@ -766,6 +766,7 @@ function ot(e, t, n, o) {
 export {
   Ne as ApiExtractor,
   O as alternativeDocumentationHost,
+  Y as apiExtractorDiagnosticContext,
   g as apiExtractorError,
   N as apiExtractorErrorCount,
   T as apiExtractorJsDocError,

package/dist/utils/error.d.ts

@@ -1,6 +1,6 @@
 import { default as ts } from 'typescript';
 export declare let apiExtractorErrorCount: number;
-export declare function resetApiExtractorErrorCount(): void;
+export declare function resetApiExtractorErrorCount(newCount?: number): void;
 export declare function setApiExtractorErrorLogger(logger: (msg: string) => void): void;
 export interface ApiExtractorErrorContext {
     file: ts.SourceFile | undefined;
@@ -9,6 +9,7 @@ export interface ApiExtractorErrorContext {
     start?: number;
     length?: number;
 }
+export declare const apiExtractorDiagnosticContext: ts.FormatDiagnosticsHost;
 /**
  * Produce an error message in the style of TypeScript compiler errors.
  * Error message includes code snippet when possible.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcgis/api-extractor",
-  "version": "5.0.0-next.61",
+  "version": "5.0.0-next.63",
   "type": "module",
   "main": "dist/index.cjs",
   "module": "dist/index.js",
@@ -8,18 +8,24 @@
   "exports": {
     ".": "./dist/index.js",
     "./diff": "./dist/diff/index.js",
+    "./diffTypes": "./dist/diffTypes/index.js",
     "./uiUtils": "./dist/uiUtils/index.js",
     "./package.json": "./package.json"
   },
   "files": [
     "dist/"
   ],
+  "bin": "./dist/cli.js",
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
-    "@arcgis/components-build-utils": "5.0.0-next.61",
-    "@arcgis/toolkit": "5.0.0-next.61",
+    "@arcgis/components-build-utils": "5.0.0-next.63",
+    "@arcgis/toolkit": "5.0.0-next.63",
+    "@commander-js/extra-typings": "^14.0.0",
     "chalk": "^5.4.1",
-    "tslib": "^2.8.1",
+    "commander": "^14.0.0",
+    "tslib": "^2.8.1"
+  },
+  "peerDependencies": {
     "typescript": "~5.9.3"
   }
 }