@arcgis/api-extractor 5.0.0-next.14 → 5.0.0-next.141

package/package.json

@@ -1,24 +1,65 @@
 {
   "name": "@arcgis/api-extractor",
-  "version": "5.0.0-next.14",
+  "version": "5.0.0-next.141",
   "type": "module",
   "main": "dist/index.cjs",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
   "exports": {
     ".": "./dist/index.js",
-    "./diff": "./dist/diff/index.js",
+    "./apiJson": {
+      "types": "./dist/apiJson.d.ts"
+    },
+    "./compilerHints": {
+      "types": "./dist/compilerHints.d.ts"
+    },
+    "./diff/diffApiJson": "./dist/diff/diffApiJson.js",
+    "./diff/fetchApiJsonFromNpm": "./dist/diff/fetchApiJsonFromNpm.js",
+    "./diffTypes": "./dist/diffTypes/index.js",
+    "./extractor/ApiExtractor": "./dist/extractor/ApiExtractor.js",
+    "./extractor/privateContext": "./dist/extractor/privateContext.js",
+    "./extractor/types": {
+      "types": "./dist/extractor/types.d.ts"
+    },
+    "./extractor/config": "./dist/extractor/config.js",
+    "./extractor/extractors/copyDoc": {
+      "types": "./dist/extractor/extractors/copyDoc.d.ts"
+    },
+    "./extractor/processing/links": "./dist/extractor/processing/links.js",
+    "./extractor/webComponent/findComponents": "./dist/extractor/webComponent/findComponents.js",
+    "./extractor/webComponent/pathMapping": "./dist/extractor/webComponent/pathMapping.js",
+    "./uiUtils": "./dist/uiUtils/index.js",
+    "./utils/apiHelpers": "./dist/utils/apiHelpers.js",
+    "./utils/astHelpers": "./dist/utils/astHelpers.js",
+    "./utils/hydrateApiType": "./dist/utils/hydrateApiType.js",
+    "./utils/inferEntrypoints": "./dist/utils/inferEntrypoints.js",
+    "./utils/internalTypeScriptApis": "./dist/utils/internalTypeScriptApis.js",
+    "./utils/partPrinter": "./dist/utils/partPrinter.js",
+    "./vite/plugin": "./dist/vite/plugin.js",
+    "./vite/typeScript": "./dist/vite/typeScript.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.14",
-    "@arcgis/toolkit": "5.0.0-next.14",
+    "@commander-js/extra-typings": "^14.0.0",
     "chalk": "^5.4.1",
+    "commander": "^14.0.0",
     "tslib": "^2.8.1",
-    "typescript": "~5.8.3"
+    "vite": "^7.2.2",
+    "@arcgis/components-build-utils": "5.0.0-next.141",
+    "@arcgis/toolkit": "5.0.0-next.141"
+  },
+  "peerDependencies": {
+    "typescript": "~5.9.3",
+    "vite": "^7.2.2"
+  },
+  "peerDependenciesMeta": {
+    "vite": {
+      "optional": true
+    }
   }
 }

package/dist/diff/index.d.ts

@@ -1,3 +0,0 @@
-export { fetchApiJsonFromNpm } from './fetchApiJsonFromNpm';
-export { diffApiJson } from './diffApiJson';
-export type * from './types';

package/dist/diff.js

@@ -1,147 +0,0 @@
-async function b(d, i) {
-  const o = await fetch(`https://unpkg.com/${d}@${i}/dist/docs/api.json`);
-  if (!o.ok)
-    throw new Error(`Failed to fetch api.json: ${o.statusText}`);
-  return await o.json();
-}
-function M(d, i) {
-  const o = new Map(d.modules.map((e) => [e.path, e])), t = [];
-  for (const e of i.modules) {
-    const a = o.get(e.path), s = D(a, e, !0);
-    s !== void 0 && t.push(s), o.delete(e.path);
-  }
-  for (const e of o.values()) {
-    const a = D(void 0, e, !1);
-    a !== void 0 && t.push(a);
-  }
-  return { modules: t };
-}
-function D(d, i, o) {
-  const t = [], e = p(d?.declarations ?? []), a = p(i.declarations ?? []);
-  for (const s of a.values()) {
-    const n = s.at(-1), l = "tagName" in n ? n.tagName : void 0, v = l ?? n.name, u = e.get(v);
-    e.delete(v);
-    const h = u === void 0 && !o ? !0 : void 0, m = o && // Only mark as deprecated if all overloads are deprecated
-    (s.length === 1 || s.every((r) => r.deprecated !== void 0)) ? n.deprecated : void 0, g = !m && u === void 0 && o ? !0 : void 0;
-    if (h || g) {
-      t.push({
-        kind: n.kind,
-        name: n.name,
-        tagName: l,
-        members: void 0,
-        removed: h,
-        added: g,
-        deprecated: m
-      });
-      continue;
-    } else if (!o)
-      continue;
-    if ("tagName" in n) {
-      const r = u?.[0], c = {
-        kind: n.kind,
-        name: n.name,
-        tagName: n.tagName,
-        deprecated: m,
-        added: void 0,
-        removed: void 0,
-        members: k(r?.members, n.members),
-        events: f(r?.events, n.events),
-        slots: f(r?.slots, n.slots),
-        cssParts: f(r?.cssParts, n.cssParts),
-        cssProperties: f(r?.cssProperties, n.cssProperties),
-        cssStates: f(r?.cssStates, n.cssStates)
-      };
-      (m !== void 0 || c.members !== void 0 || c.events !== void 0 || c.slots !== void 0 || c.cssParts !== void 0 || c.cssProperties !== void 0 || c.cssStates !== void 0) && t.push(c);
-    } else if (n.kind === "class") {
-      const r = u?.[0], c = {
-        kind: n.kind,
-        name: n.name,
-        deprecated: m,
-        added: void 0,
-        removed: void 0,
-        members: k(r?.members, n.members),
-        events: f(r?.events, n.events)
-      };
-      (m !== void 0 || c.members !== void 0 || c.events !== void 0) && t.push(c);
-    } else m !== void 0 && t.push({
-      kind: n.kind,
-      name: n.name,
-      deprecated: m,
-      added: void 0,
-      removed: void 0
-    });
-  }
-  if (o)
-    for (const [s] of e.values())
-      t.push({
-        kind: s.kind,
-        name: s.name,
-        tagName: "tagName" in s ? s.tagName : void 0,
-        members: void 0,
-        removed: !0,
-        added: void 0,
-        deprecated: void 0
-      });
-  if (t.length !== 0)
-    return {
-      path: i.path,
-      declarations: t
-    };
-}
-function p(d) {
-  const i = /* @__PURE__ */ new Map();
-  for (let o = 0; o < d.length; o++) {
-    const t = d[o], e = "tagName" in t ? t.tagName : t.name, a = i.get(e);
-    a === void 0 ? i.set(e, [t]) : a.push(t);
-  }
-  return i;
-}
-function f(d, i) {
-  const o = p(d ?? []), t = [];
-  if (i !== void 0)
-    for (const e of i)
-      o.get(e.name) === void 0 ? t.push({
-        name: e.name,
-        added: !0
-      }) : e.deprecated && t.push({
-        name: e.name,
-        deprecated: e.deprecated
-      }), o.delete(e.name);
-  for (const [e] of o.values())
-    t.push({
-      name: e.name,
-      removed: !0
-    });
-  return t.length ? t : void 0;
-}
-function k(d, i) {
-  const o = p(d ?? []), t = p(i ?? []), e = [];
-  for (const a of t.values()) {
-    const s = a.at(-1), n = o.get(s.name);
-    o.delete(s.name);
-    const l = (
-      // Only mark as deprecated if all overloads are deprecated
-      a.length === 1 || a.every((v) => v.deprecated !== void 0) ? s.deprecated : void 0
-    );
-    l ? e.push({
-      kind: s.kind,
-      name: s.name,
-      deprecated: l
-    }) : n === void 0 && e.push({
-      kind: s.kind,
-      name: s.name,
-      added: !0
-    });
-  }
-  for (const [a] of o.values())
-    e.push({
-      kind: a.kind,
-      name: a.name,
-      removed: !0
-    });
-  return e.length ? e : void 0;
-}
-export {
-  M as diffApiJson,
-  b as fetchApiJsonFromNpm
-};

package/dist/ensureValidType.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/extractor/index.d.ts

@@ -1,46 +0,0 @@
-import { ApiClassMethod, ApiCustomElementDeclaration, ApiCustomElementField, ApiDeclaration, ApiEvent, ApiExport, ApiJson, ApiModule } from '../apiJson';
-import { default as ts } from 'typescript';
-import { CopyPropertyDoc, CopyMethodDoc, CopyEventDoc } from '../types';
-export type ApiExtractorOptions = {
-    /**
-     * Whether to extract full API information, with type-checking. This should be
-     * the case during build or when running under Storybook. Otherwise, the dev
-     * server should keep API extraction to bare minimum to reduce needless
-     * overhead. Only the information necessary for the dev server is extracted.
-     */
-    isFullApiExtraction: boolean;
-    cwd: string;
-};
-/**
- * This is a base abstract class. It should be subclassed to implement the
- * specific extraction logic.
- */
-export declare abstract class ApiExtractor {
-    options: ApiExtractorOptions;
-    constructor(options: ApiExtractorOptions);
-    protected file: ts.SourceFile;
-    protected apiModule: ApiModule;
-    /** Given an array of TypeScript source files, generate an api.json file */
-    extract(files: readonly ts.SourceFile[]): ApiJson;
-    protected extractModules(files: readonly ts.SourceFile[]): ApiModule[];
-    protected extractModule(module: ts.SourceFile): ApiModule;
-    /**
-     * For a given module, extract all public declarations.
-     */
-    protected extractDeclarations(module: ts.SourceFile): ApiDeclaration[];
-    /**
-     * For each statement in a module, extract a declaration if it is a public API
-     */
-    protected abstract extractDeclaration(statement: ts.Statement): ApiDeclaration | undefined;
-    /**
-     * Infer ApiModule.exports based on ApiModule.declarations.
-     */
-    protected inferExports(declarations: ApiDeclaration[]): ApiExport[];
-    /**
-     * Infer ApiExport based on ApiDeclaration
-     */
-    protected abstract inferExport(declaration: ApiDeclaration): ApiExport | undefined;
-    copyDoc(errorReportingNode: ts.Node, copyDocDefinition: CopyPropertyDoc | undefined, property: ApiCustomElementField, component: ApiCustomElementDeclaration): void;
-    copyDoc(errorReportingNode: ts.Node, copyDocDefinition: CopyMethodDoc | undefined, method: ApiClassMethod, component: ApiCustomElementDeclaration): void;
-    copyDoc(errorReportingNode: ts.Node, copyDocDefinition: CopyEventDoc | undefined, event: ApiEvent, component: ApiCustomElementDeclaration): void;
-}

package/dist/types.d.ts

@@ -1,25 +0,0 @@
-import { ApiCustomElementField, ApiCustomElementDeclaration, ApiClassMethod, ApiEvent } from './apiJson';
-/**
- * @example
- * ```ts
- * {
- *   properties: {
- *     // You only need to return the fields you wish to modify.
- *     autoDestroyDisabled: () => ({
- *       description: `If true, the component will not be destroyed automatically when it is
- * disconnected from the document. This is useful when you want to move the
- * component to a different place on the page, or temporarily hide it. If this
- * is set, make sure to call the {@link #destroy} method when you are done to
- * prevent memory leaks.`,
- *     }),
- *   },
- * }
- */
-export type CopyDocDefinitions = {
-    properties?: Record<string, CopyPropertyDoc | undefined>;
-    methods?: Record<string, CopyMethodDoc | undefined>;
-    events?: Record<string, CopyEventDoc | undefined>;
-};
-export type CopyPropertyDoc = (property: ApiCustomElementField, component: ApiCustomElementDeclaration) => Partial<ApiCustomElementField> | undefined;
-export type CopyMethodDoc = (method: ApiClassMethod, component: ApiCustomElementDeclaration) => Partial<ApiClassMethod> | undefined;
-export type CopyEventDoc = (event: ApiEvent, component: ApiCustomElementDeclaration) => Partial<ApiEvent> | undefined;

package/dist/utils/docHelpers.d.ts

@@ -1,9 +0,0 @@
-import { default as ts } from 'typescript';
-import { ApiCustomElementField, ApiCustomElementDeclaration, ApiEvent, ApiDocsTag, ApiCustomElementMember } from '../apiJson';
-export declare function symbolToDocs(checker: ts.TypeChecker, symbol: ts.Signature | ts.Symbol): {
-    description: ApiCustomElementField["description"];
-    docsTags: ApiDocsTag[];
-};
-export declare const internalJsDocTag = "internal";
-export declare function apiMemberToSynthesizedComments(apiMember: ApiCustomElementDeclaration | ApiCustomElementMember | ApiEvent): ts.SynthesizedComment[];
-export declare function setApiDocFromJsDoc(node: ts.PropertyName, checker: ts.TypeChecker, api: Partial<Pick<ApiCustomElementDeclaration, "cssParts" | "cssProperties" | "cssStates" | "slots"> & Pick<ApiCustomElementField, "default" | "deprecated" | "description" | "docsTags" | "privacy" | "readonly">>, docs?: ReturnType<typeof symbolToDocs>): void;

package/dist/utils/error.d.ts

@@ -1,12 +0,0 @@
-import { default as ts } from 'typescript';
-export declare let apiExtractorErrorCount: number;
-export declare const apiExtractorErrorFiles: Set<string>;
-export declare function setApiExtractorErrorLogger(logger: (msg: string) => void): void;
-export interface ApiExtractorErrorContext {
-    file: ts.SourceFile | undefined;
-    node: ts.Node | undefined;
-    scope?: string;
-    start?: number;
-    length?: number;
-}
-export declare function apiExtractorError(message: string, { file, node, scope, start, length }: ApiExtractorErrorContext): void;

package/dist/utils/print.d.ts

@@ -1,7 +0,0 @@
-import { default as ts } from 'typescript';
-export declare function printNode(node: ts.Node): string;
-/**
- * For usage in error messages. Print original node text if available. Otherwise,
- * print the AST.
- */
-export declare function debugPrintNode(node: ts.Node, sourceFile: ts.SourceFile | undefined): string;