@arcgis/api-extractor 5.0.0-next.78 → 5.0.0-next.79

package/dist/extractor/ApiExtractor.d.ts

@@ -90,7 +90,7 @@ export declare abstract class ApiExtractor {
      * we compute inheritance data lazily).
      */
     ApiExtractorInheritanceData | false | undefined>;
-    noInheritMembers: Record<string, string[] | undefined>;
+    noInheritMembers: Readonly<Record<string, readonly string[]>>;
     /**
      * Based on the superclass name, find the actual declaration in the modules.
      */

package/dist/extractor/config.d.ts

@@ -0,0 +1,66 @@
+import { CopyDocDefinitions } from '../types.ts';
+export interface ApiExtractorConfig {
+    /**
+     * The environment in which the extractor is running.
+     *
+     * @public
+     * @default "production"
+     */
+    readonly environment?: "development" | "production";
+    /**
+     * The path to the root of the project to extract.
+     *
+     * @public
+     * @default process.cwd()
+     */
+    readonly cwd?: string;
+    /**
+     * @public
+     * @default undefined
+     */
+    readonly copyDocDefinitions?: CopyDocDefinitions;
+    /** @public */
+    readonly typeReplacements?: TypeReplacements;
+    /**
+     * api-extractor automatically discovers files that contain `@public`. Not
+     * having to manually maintain a list of entries saves labor.
+     *
+     * As a performance optimization, you can exclude some directories from
+     * `@public` file discovery. This should be a flat list of folders inside
+     * basePath without slashes or deep paths.
+     *
+     * @public
+     * @example ["tests"]
+     */
+    readonly excludedDirectories?: Set<string>;
+    /** @public */
+    readonly noInheritMembers?: NoInheritMembers;
+}
+/**
+ * Privately, arcgis-js-api has interfaces that mirror some of the most widely
+ * used types. They are in the process of refactoring out many of them. Until
+ * that is complete, this hardcoded table is used to replace the usages of these
+ * interfaces with their concrete types.
+ *
+ * Keep this list minimal. Type replacements have pitfalls:
+ * - In a .ts file there is no indication that a given type will be replaced.
+ *   It can be surprising why some types are replaced and some are not.
+ * - The replaced type is not equivalent (LayerUnion=>Layer). These do affect
+ *   type checking in some cases.
+ * - If the name we are replacing with is already present in the current scope,
+ *   there will be a collision. Detecting such collisions is tricky - extractor
+ *   does it minimally.
+ *
+ * @public
+ * @see https://devtopia.esri.com/WebGIS/arcgis-js-api/discussions/60843
+ * @see https://devtopia.esri.com/WebGIS/arcgis-js-api/issues/69911
+ * @see https://devtopia.esri.com/WebGIS/arcgis-js-api/issues/73395
+ */
+export type TypeReplacements = Record<string, Record<string, readonly [modulePath: string, name: string, type: "default" | "named"] | undefined> | undefined>;
+/**
+ * Don't include these members in each subclass to keep api reference pages cleaner.
+ * These has no typings impact since their inheritance is still done by TypeScript.
+ *
+ * @public
+ */
+export type NoInheritMembers = Readonly<Record<string, readonly string[]>>;

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 j = "@arcgis/api-extractor", X = "5.0.0-next.78", P = {
+const j = "@arcgis/api-extractor", X = "5.0.0-next.79", P = {
   name: j,
   version: X
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcgis/api-extractor",
-  "version": "5.0.0-next.78",
+  "version": "5.0.0-next.79",
   "type": "module",
   "main": "dist/index.cjs",
   "module": "dist/index.js",
@@ -10,6 +10,9 @@
     "./diff": "./dist/diff/index.js",
     "./diffTypes": "./dist/diffTypes/index.js",
     "./uiUtils": "./dist/uiUtils/index.js",
+    "./extractor/config": {
+      "types": "./dist/extractor/config.d.ts"
+    },
     "./package.json": "./package.json"
   },
   "files": [
@@ -18,8 +21,8 @@
   "bin": "./dist/cli.js",
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
-    "@arcgis/components-build-utils": "5.0.0-next.78",
-    "@arcgis/toolkit": "5.0.0-next.78",
+    "@arcgis/components-build-utils": "5.0.0-next.79",
+    "@arcgis/toolkit": "5.0.0-next.79",
     "@commander-js/extra-typings": "^14.0.0",
     "chalk": "^5.4.1",
     "commander": "^14.0.0",