@fgv/ts-json-base 5.0.0-24 → 5.0.0-26

package/dist/ts-json-base.d.ts

@@ -0,0 +1,458 @@
+import { Converter } from '@fgv/ts-utils';
+import { Result } from '@fgv/ts-utils';
+import { Validator } from '@fgv/ts-utils';
+
+/**
+ * Identifies whether some `unknown` value is a {@link JsonPrimitive | primitive},
+ * {@link JsonObject | object} or {@link JsonArray | array}. Fails for any value
+ * that cannot be converted to JSON (e.g. a function) _but_ this is a shallow test -
+ * it does not test the properties of an object or elements in an array.
+ * @param from - The `unknown` value to be tested
+ * @public
+ */
+export declare function classifyJsonValue(from: unknown): Result<JsonValueType>;
+
+declare namespace Converters {
+    export {
+        IJsonConverterContext,
+        jsonPrimitive,
+        jsonObject,
+        jsonArray,
+        jsonValue
+    }
+}
+export { Converters }
+
+/**
+ * Reads all JSON files from a directory and apply a supplied converter.
+ * @param srcPath - The path of the folder to be read.
+ * @param options - {@link JsonFile.IJsonFsDirectoryOptions | Options} to control
+ * conversion and filtering
+ * @public
+ */
+declare function convertJsonDirectorySync<T, TC = unknown>(srcPath: string, options: IJsonFsDirectoryOptions<T, TC>): Result<IReadDirectoryItem<T>[]>;
+
+/**
+ * Reads and converts all JSON files from a directory, returning a
+ * `Map<string, T>` indexed by file base name (i.e. minus the extension)
+ * with an optional name transformation applied if present.
+ * @param srcPath - The path of the folder to be read.
+ * @param options - {@link JsonFile.IJsonFsDirectoryToMapOptions | Options} to control conversion,
+ * filtering and naming.
+ * @public
+ */
+declare function convertJsonDirectoryToMapSync<T, TC = unknown>(srcPath: string, options: IJsonFsDirectoryToMapOptions<T, TC>): Result<Map<string, T>>;
+
+/**
+ * Read a JSON file and apply a supplied converter.
+ * @param srcPath - Path of the file to read.
+ * @param converter - `Converter` used to convert the file contents
+ * @returns `Success` with a result of type `<T>`, or `Failure`* with a message if an error occurs.
+ * @public
+ */
+declare function convertJsonFileSync<T, TC = unknown>(srcPath: string, converter: Converter<T, TC>): Result<T>;
+
+/**
+ * @public
+ */
+declare const DefaultJsonFsHelper: JsonFsHelper;
+
+/**
+ * Default configuration for {@link JsonFile.JsonFsHelper | JsonFsHelper}.
+ * @public
+ */
+declare const DefaultJsonFsHelperConfig: IJsonFsHelperConfig;
+
+/**
+ * @public
+ */
+declare const DefaultJsonLike: IJsonLike;
+
+/**
+ * Conversion context for JSON converters.
+ * @public
+ */
+declare interface IJsonConverterContext {
+    ignoreUndefinedProperties?: boolean;
+}
+
+/**
+ * Options for directory conversion.
+ * TODO: add filtering, allowed and excluded.
+ * @public
+ */
+declare interface IJsonFsDirectoryOptions<T, TC = unknown> {
+    /**
+     * The converter used to convert incoming JSON objects.
+     */
+    converter: Converter<T, TC> | Validator<T, TC>;
+    /**
+     * Filter applied to items in the directory
+     */
+    files?: RegExp[];
+}
+
+/**
+ * Options controlling conversion of a directory to a `Map`.
+ * @public
+ */
+declare interface IJsonFsDirectoryToMapOptions<T, TC = unknown> extends IJsonFsDirectoryOptions<T, TC> {
+    transformName?: ItemNameTransformFunction<T>;
+}
+
+/**
+ * Configuration for {@link JsonFile.JsonFsHelper | JsonFsHelper}.
+ * @public
+ */
+declare interface IJsonFsHelperConfig {
+    json: IJsonLike;
+    allowUndefinedWrite: boolean;
+    defaultFiles: RegExp[];
+}
+
+/**
+ * @public
+ */
+declare interface IJsonLike {
+    parse(text: string, reviver?: JsonReviver, options?: unknown): JsonValue | undefined;
+    stringify(value: JsonValue, replacer?: JsonReplacer, space?: string | number): string | undefined;
+}
+
+/**
+ * Validation context for in-place JSON validators.
+ * @public
+ */
+declare interface IJsonValidatorContext {
+    ignoreUndefinedProperties?: boolean;
+}
+
+/**
+ * Return value for one item in a directory conversion.
+ * @public
+ */
+declare interface IReadDirectoryItem<T> {
+    /**
+     * Relative name of the file that was processed
+     */
+    filename: string;
+    /**
+     * The payload of the file.
+     */
+    item: T;
+}
+
+/**
+ * Test if an `unknown` is potentially a {@link JsonArray | JsonArray}.
+ * @param from - The `unknown` to be tested.
+ * @returns `true` if the supplied parameter is an array object,
+ * `false` otherwise.
+ * @public
+ */
+export declare function isJsonArray(from: unknown): from is JsonArray;
+
+/**
+ * Test if an `unknown` is potentially a {@link JsonObject | JsonObject}.
+ * @param from - The `unknown` to be tested.
+ * @returns `true` if the supplied parameter is a non-array, non-special object,
+ * `false` otherwise.
+ * @public
+ */
+export declare function isJsonObject(from: unknown): from is JsonObject;
+
+/**
+ * Test if an `unknown` is a {@link JsonValue | JsonValue}.
+ * @param from - The `unknown` to be tested
+ * @returns `true` if the supplied parameter is a valid {@link JsonPrimitive | JsonPrimitive},
+ * `false` otherwise.
+ * @public
+ */
+export declare function isJsonPrimitive(from: unknown): from is JsonPrimitive;
+
+/**
+ * Function to transform the name of a some entity, given an original name
+ * and the contents of the entity.
+ * @public
+ */
+declare type ItemNameTransformFunction<T> = (name: string, item: T) => Result<string>;
+
+/**
+ * A {@link JsonArray | JsonArray} is an array containing only valid {@link JsonValue | JsonValues}.
+ * @public
+ */
+export declare interface JsonArray extends Array<JsonValue> {
+}
+
+/**
+ * An copying converter which converts a supplied `unknown` value to
+ * a valid {@link JsonArray | JsonArray}. Fails by default if any properties or array elements
+ * are `undefined` - this default behavior can be overridden by supplying an appropriate
+ * {@link Converters.IJsonConverterContext | context} at runtime.
+ *
+ * Guaranteed to return a new array.
+ * @public
+ */
+declare const jsonArray: Converter<JsonArray, IJsonConverterContext>;
+
+/**
+ * An in-place validator which validates that a supplied `unknown` value is
+ * a valid {@link JsonArray | JsonArray}. Fails by default if any properties or array elements
+ * are `undefined` - this default behavior can be overridden by supplying an appropriate
+ * {@link Validators.IJsonValidatorContext | context} at runtime.
+ * @public
+ */
+declare const jsonArray_2: Validator<JsonArray, IJsonValidatorContext>;
+
+declare namespace JsonFile {
+    export {
+        readJsonFileSync,
+        convertJsonFileSync,
+        convertJsonDirectorySync,
+        convertJsonDirectoryToMapSync,
+        writeJsonFileSync,
+        IJsonFsDirectoryOptions,
+        IReadDirectoryItem,
+        ItemNameTransformFunction,
+        IJsonFsDirectoryToMapOptions,
+        IJsonFsHelperConfig,
+        JsonFsHelperInitOptions,
+        DefaultJsonFsHelperConfig,
+        JsonFsHelper,
+        DefaultJsonFsHelper,
+        JsonReviver,
+        JsonReplacerFunction,
+        JsonReplacerArray,
+        JsonReplacer,
+        IJsonLike,
+        DefaultJsonLike
+    }
+}
+export { JsonFile }
+
+/**
+ * Helper class to simplify common filesystem operations involving JSON (or JSON-like)
+ * files.
+ * @public
+ */
+declare class JsonFsHelper {
+    /**
+     * Configuration for this {@link JsonFile.JsonFsHelper | JsonFsHelper}.
+     */
+    readonly config: IJsonFsHelperConfig;
+    /**
+     * Construct a new {@link JsonFile.JsonFsHelper | JsonFsHelper}.
+     * @param json - Optional {@link JsonFile.IJsonLike | IJsonLike} used to process strings
+     * and JSON values.
+     */
+    constructor(init?: JsonFsHelperInitOptions);
+    /**
+     * Read type-safe JSON from a file.
+     * @param srcPath - Path of the file to read
+     * @returns `Success` with a {@link JsonValue | JsonValue} or `Failure`
+     * with a message if an error occurs.
+     */
+    readJsonFileSync(srcPath: string): Result<JsonValue>;
+    /**
+     * Read a JSON file and apply a supplied converter or validator.
+     * @param srcPath - Path of the file to read.
+     * @param cv - Converter or validator used to process the file.
+     * @returns `Success` with a result of type `<T>`, or `Failure`
+     * with a message if an error occurs.
+     */
+    convertJsonFileSync<T, TC = unknown>(srcPath: string, cv: Converter<T, TC> | Validator<T, TC>, context?: TC): Result<T>;
+    /**
+     * Reads all JSON files from a directory and apply a supplied converter or validator.
+     * @param srcPath - The path of the folder to be read.
+     * @param options - {@link JsonFile.IJsonFsDirectoryOptions | Options} to control
+     * conversion and filtering
+     */
+    convertJsonDirectorySync<T, TC = unknown>(srcPath: string, options: IJsonFsDirectoryOptions<T>, context?: TC): Result<IReadDirectoryItem<T>[]>;
+    /**
+     * Reads and converts or validates all JSON files from a directory, returning a
+     * `Map<string, T>` indexed by file base name (i.e. minus the extension)
+     * with an optional name transformation applied if present.
+     * @param srcPath - The path of the folder to be read.
+     * @param options - {@link JsonFile.IJsonFsDirectoryToMapOptions | Options} to control conversion,
+     * filtering and naming.
+     */
+    convertJsonDirectoryToMapSync<T, TC = unknown>(srcPath: string, options: IJsonFsDirectoryToMapOptions<T, TC>, context?: unknown): Result<Map<string, T>>;
+    /**
+     * Write type-safe JSON to a file.
+     * @param srcPath - Path of the file to write.
+     * @param value - The {@link JsonValue | JsonValue} to be written.
+     */
+    writeJsonFileSync(srcPath: string, value: JsonValue): Result<boolean>;
+    protected _pathMatchesOptions<T, TC>(options: IJsonFsDirectoryOptions<T, TC>, path: string): boolean;
+}
+
+/**
+ * Initialization options for {@link JsonFile.JsonFsHelper | JsonFsHelper}.
+ * @public
+ */
+declare type JsonFsHelperInitOptions = Partial<IJsonFsHelperConfig>;
+
+/**
+ * A {@link JsonObject | JsonObject} is a string-keyed object
+ * containing only valid {@link JsonValue | JSON values}.
+ * @public
+ */
+export declare interface JsonObject {
+    [key: string]: JsonValue;
+}
+
+/**
+ * An copying converter which converts a supplied `unknown` value into
+ * a valid {@link JsonObject | JsonObject}. Fails by default if any properties or array elements
+ * are `undefined` - this default behavior can be overridden by supplying an appropriate
+ * {@link Converters.IJsonConverterContext | context} at runtime.
+ *
+ * Guaranteed to return a new object.
+ * @public
+ */
+declare const jsonObject: Converter<JsonObject, IJsonConverterContext>;
+
+/**
+ * An in-place validator which validates that a supplied `unknown` value is
+ * a valid {@link JsonObject | JsonObject}. Fails by default if any properties or array elements
+ * are `undefined` - this default behavior can be overridden by supplying an appropriate
+ * {@link Validators.IJsonValidatorContext | context} at runtime.
+ * @public
+ */
+declare const jsonObject_2: Validator<JsonObject, IJsonValidatorContext>;
+
+/**
+ * Primitive (terminal) values allowed in by JSON.
+ * @public
+ */
+export declare type JsonPrimitive = boolean | number | string | null;
+
+/**
+ * An converter which converts a supplied `unknown` value to a valid {@link JsonPrimitive | JsonPrimitive}.
+ * @public
+ */
+declare const jsonPrimitive: Converter<JsonPrimitive, IJsonConverterContext>;
+
+/**
+ * An in-place validator which validates that a supplied `unknown` value is
+ * a valid {@link JsonPrimitive | JsonPrimitive}.
+ * @public
+ */
+declare const jsonPrimitive_2: Validator<JsonPrimitive, IJsonValidatorContext>;
+
+/**
+ * @public
+ */
+declare type JsonReplacer = JsonReplacerFunction | JsonReplacerArray;
+
+/**
+ * @public
+ */
+declare type JsonReplacerArray = (string | number)[];
+
+/**
+ * @public
+ */
+declare type JsonReplacerFunction = (key: string, value: JsonValue) => JsonValue;
+
+/**
+ * @public
+ */
+declare type JsonReviver = (key: string, value: JsonValue) => JsonValue;
+
+/**
+ * A {@link JsonValue | JsonValue} is one of: a {@link JsonPrimitive | JsonPrimitive},
+ * a {@link JsonObject | JsonObject} or an {@link JsonArray | JsonArray}.
+ * @public
+ */
+export declare type JsonValue = JsonPrimitive | JsonObject | JsonArray;
+
+/**
+ * An copying converter which converts a supplied `unknown` value to a
+ * valid {@link JsonValue | JsonValue}. Fails by default if any properties or array elements
+ * are `undefined` - this default behavior can be overridden by supplying an appropriate
+ * {@link Converters.IJsonConverterContext | context} at runtime.
+ * @public
+ */
+declare const jsonValue: Converter<JsonValue, IJsonConverterContext>;
+
+/**
+ * An in-place validator which validates that a supplied `unknown` value is
+ * a valid {@link JsonValue | JsonValue}. Fails by default if any properties or array elements
+ * are `undefined` - this default behavior can be overridden by supplying an appropriate
+ * {@link Validators.IJsonValidatorContext | context} at runtime.
+ * @public
+ */
+declare const jsonValue_2: Validator<JsonValue, IJsonValidatorContext>;
+
+/**
+ * Classes of {@link JsonValue | JsonValue}.
+ * @public
+ */
+export declare type JsonValueType = 'primitive' | 'object' | 'array';
+
+/**
+ * Picks a nested {@link JsonObject | JsonObject} from a supplied
+ * {@link JsonObject | JsonObject}.
+ * @param src - The {@link JsonObject | object} from which the field is
+ * to be picked.
+ * @param path - Dot-separated path of the member to be picked.
+ * @returns `Success` with the property if the path is valid and the value
+ * is an object. Returns `Failure` with details if an error occurs.
+ * @public
+ */
+export declare function pickJsonObject(src: JsonObject, path: string): Result<JsonObject>;
+
+/**
+ * Picks a nested field from a supplied {@link JsonObject | JsonObject}.
+ * @param src - The {@link JsonObject | object} from which the field is to be picked.
+ * @param path - Dot-separated path of the member to be picked.
+ * @returns `Success` with the property if the path is valid, `Failure`
+ * with an error message otherwise.
+ * @public
+ */
+export declare function pickJsonValue(src: JsonObject, path: string): Result<JsonValue>;
+
+/**
+ * {@inheritdoc JsonFile.JsonFsHelper.readJsonFileSync}
+ * @public
+ */
+declare function readJsonFileSync(srcPath: string): Result<JsonValue>;
+
+/**
+ * "Sanitizes" an `unknown` by stringifying and then parsing it.  Guarantees a
+ * valid {@link JsonValue | JsonValue} but is not idempotent and gives no guarantees
+ * about fidelity. Fails if the supplied value cannot be stringified as Json.
+ * @param from - The `unknown` to be sanitized.
+ * @returns `Success` with a {@link JsonValue | JsonValue} if conversion succeeds,
+ * `Failure` with details if an error occurs.
+ * @public
+ */
+export declare function sanitizeJson(from: unknown): Result<JsonValue>;
+
+/**
+ * Sanitizes some value using JSON stringification and parsing, returning an
+ * returning a matching strongly-typed value.
+ * @param from - The value to be sanitized.
+ * @returns `Success` with a {@link JsonObject | JsonObject} if conversion succeeds,
+ * `Failure` with details if an error occurs.
+ * @public
+ */
+export declare function sanitizeJsonObject<T>(from: T): Result<T>;
+
+declare namespace Validators {
+    export {
+        IJsonValidatorContext,
+        jsonPrimitive_2 as jsonPrimitive,
+        jsonObject_2 as jsonObject,
+        jsonArray_2 as jsonArray,
+        jsonValue_2 as jsonValue
+    }
+}
+export { Validators }
+
+/**
+ * {@inheritDoc JsonFile.JsonFsHelper.writeJsonFileSync}
+ * @public
+ */
+declare function writeJsonFileSync(srcPath: string, value: JsonValue): Result<boolean>;
+
+export { }

package/dist/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.52.11"
+    }
+  ]
+}

package/eslint.config.js

@@ -0,0 +1,16 @@
+// ESLint 9 flat config
+const nodeProfile = require('@rushstack/eslint-config/flat/profile/node');
+const packletsPlugin = require('@rushstack/eslint-config/flat/mixins/packlets');
+const tsdocPlugin = require('@rushstack/eslint-config/flat/mixins/tsdoc');
+
+module.exports = [
+  ...nodeProfile,
+  packletsPlugin,
+  ...tsdocPlugin,
+  {
+    // Override specific rules if needed
+    rules: {
+      '@rushstack/packlets/mechanics': 'warn'
+    }
+  }
+];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fgv/ts-json-base",
-  "version": "5.0.0-24",
+  "version": "5.0.0-26",
   "description": "Typescript types and basic functions for working with json",
   "main": "lib/index.js",
   "types": "dist/ts-json-base.d.ts",
@@ -18,19 +18,19 @@
   "devDependencies": {
     "@types/jest": "^29.5.14",
     "@types/node": "^20.14.9",
-    "@typescript-eslint/eslint-plugin": "^7.14.1",
-    "@typescript-eslint/parser": "^7.14.1",
-    "eslint": "^8.57.0",
+    "@typescript-eslint/eslint-plugin": "^8.42.0",
+    "@typescript-eslint/parser": "^8.42.0",
+    "eslint": "^9.35.0",
     "eslint-plugin-import": "^2.32.0",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^6.2.0",
+    "eslint-plugin-promise": "^7.2.1",
     "jest": "^29.7.0",
     "jest-extended": "^4.0.2",
-    "rimraf": "^5.0.7",
+    "rimraf": "^6.0.1",
     "ts-jest": "^29.4.1",
     "ts-node": "^10.9.2",
     "typescript": "5.8.3",
-    "eslint-plugin-n": "^16.6.2",
+    "eslint-plugin-n": "^17.21.3",
     "@rushstack/heft-node-rig": "2.9.4",
     "@rushstack/heft": "0.74.3",
     "@rushstack/heft-jest-plugin": "0.16.12",
@@ -39,12 +39,12 @@
     "@rushstack/eslint-patch": "~1.12.0",
     "@rushstack/eslint-config": "4.4.0",
     "eslint-plugin-tsdoc": "~0.4.0",
-    "@fgv/ts-utils": "5.0.0-24",
-    "@fgv/ts-utils-jest": "5.0.0-24",
-    "@fgv/ts-extras": "5.0.0-24"
+    "@fgv/ts-utils": "5.0.0-26",
+    "@fgv/ts-extras": "5.0.0-26",
+    "@fgv/ts-utils-jest": "5.0.0-26"
   },
   "peerDependencies": {
-    "@fgv/ts-utils": "5.0.0-24"
+    "@fgv/ts-utils": "5.0.0-26"
   },
   "scripts": {
     "build": "heft test --clean",

package/config/api-extractor.json

@@ -1,343 +0,0 @@
-/**
- * Config file for API Extractor.  For more info, please visit: https://api-extractor.com
- */
-{
-  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-  /**
-   * Optionally specifies another JSON config file that this file extends from.  This provides a way for
-   * standard settings to be shared across multiple projects.
-   *
-   * If the path starts with "./" or "../", the path is resolved relative to the folder of the file that contains
-   * the "extends" field.  Otherwise, the first path segment is interpreted as an NPM package name, and will be
-   * resolved using NodeJS require().
-   *
-   * SUPPORTED TOKENS: none
-   * DEFAULT VALUE: ""
-   */
-  // "extends": "./shared/api-extractor-base.json"
-  // "extends": "my-package/include/api-extractor-base.json"
-  /**
-   * Determines the "<projectFolder>" token that can be used with other config file settings.  The project folder
-   * typically contains the tsconfig.json and package.json config files, but the path is user-defined.
-   *
-   * The path is resolved relative to the folder of the config file that contains the setting.
-   *
-   * The default value for "projectFolder" is the token "<lookup>", which means the folder is determined by traversing
-   * parent folders, starting from the folder containing api-extractor.json, and stopping at the first folder
-   * that contains a tsconfig.json file.  If a tsconfig.json file cannot be found in this way, then an error
-   * will be reported.
-   *
-   * SUPPORTED TOKENS: <lookup>
-   * DEFAULT VALUE: "<lookup>"
-   */
-  "projectFolder": "..",
-  /**
-   * (REQUIRED) Specifies the .d.ts file to be used as the starting point for analysis.  API Extractor
-   * analyzes the symbols exported by this module.
-   *
-   * The file extension must be ".d.ts" and not ".ts".
-   *
-   * The path is resolved relative to the folder of the config file that contains the setting; to change this,
-   * prepend a folder token such as "<projectFolder>".
-   *
-   * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
-   */
-  "mainEntryPointFilePath": "<projectFolder>/lib/index.d.ts",
-  /**
-   * A list of NPM package names whose exports should be treated as part of this package.
-   *
-   * For example, suppose that Webpack is used to generate a distributed bundle for the project "library1",
-   * and another NPM package "library2" is embedded in this bundle.  Some types from library2 may become part
-   * of the exported API for library1, but by default API Extractor would generate a .d.ts rollup that explicitly
-   * imports library2.  To avoid this, we can specify:
-   *
-   *   "bundledPackages": [ "library2" ],
-   *
-   * This would direct API Extractor to embed those types directly in the .d.ts rollup, as if they had been
-   * local files for library1.
-   */
-  "bundledPackages": [],
-  /**
-   * Determines how the TypeScript compiler engine will be invoked by API Extractor.
-   */
-  "compiler": {
-    /**
-     * Specifies the path to the tsconfig.json file to be used by API Extractor when analyzing the project.
-     *
-     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
-     * prepend a folder token such as "<projectFolder>".
-     *
-     * Note: This setting will be ignored if "overrideTsconfig" is used.
-     *
-     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
-     * DEFAULT VALUE: "<projectFolder>/tsconfig.json"
-     */
-    // "tsconfigFilePath": "<projectFolder>/tsconfig.json",
-    /**
-     * Provides a compiler configuration that will be used instead of reading the tsconfig.json file from disk.
-     * The object must conform to the TypeScript tsconfig schema:
-     *
-     * http://json.schemastore.org/tsconfig
-     *
-     * If omitted, then the tsconfig.json file will be read from the "projectFolder".
-     *
-     * DEFAULT VALUE: no overrideTsconfig section
-     */
-    // "overrideTsconfig": {
-    //   . . .
-    // }
-    /**
-     * This option causes the compiler to be invoked with the --skipLibCheck option. This option is not recommended
-     * and may cause API Extractor to produce incomplete or incorrect declarations, but it may be required when
-     * dependencies contain declarations that are incompatible with the TypeScript engine that API Extractor uses
-     * for its analysis.  Where possible, the underlying issue should be fixed rather than relying on skipLibCheck.
-     *
-     * DEFAULT VALUE: false
-     */
-    // "skipLibCheck": true,
-  },
-  /**
-   * Configures how the API report file (*.api.md) will be generated.
-   */
-  "apiReport": {
-    /**
-     * (REQUIRED) Whether to generate an API report.
-     */
-    "enabled": true
-    /**
-     * The filename for the API report files.  It will be combined with "reportFolder" or "reportTempFolder" to produce
-     * a full file path.
-     *
-     * The file extension should be ".api.md", and the string should not contain a path separator such as "\" or "/".
-     *
-     * SUPPORTED TOKENS: <packageName>, <unscopedPackageName>
-     * DEFAULT VALUE: "<unscopedPackageName>.api.md"
-     */
-    // "reportFileName": "<unscopedPackageName>.api.md",
-    /**
-     * Specifies the folder where the API report file is written.  The file name portion is determined by
-     * the "reportFileName" setting.
-     *
-     * The API report file is normally tracked by Git.  Changes to it can be used to trigger a branch policy,
-     * e.g. for an API review.
-     *
-     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
-     * prepend a folder token such as "<projectFolder>".
-     *
-     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
-     * DEFAULT VALUE: "<projectFolder>/etc/"
-     */
-    // "reportFolder": "<projectFolder>/etc/",
-    /**
-     * Specifies the folder where the temporary report file is written.  The file name portion is determined by
-     * the "reportFileName" setting.
-     *
-     * After the temporary file is written to disk, it is compared with the file in the "reportFolder".
-     * If they are different, a production build will fail.
-     *
-     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
-     * prepend a folder token such as "<projectFolder>".
-     *
-     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
-     * DEFAULT VALUE: "<projectFolder>/temp/"
-     */
-    // "reportTempFolder": "<projectFolder>/temp/"
-  },
-  /**
-   * Configures how the doc model file (*.api.json) will be generated.
-   */
-  "docModel": {
-    /**
-     * (REQUIRED) Whether to generate a doc model file.
-     */
-    "enabled": true
-    /**
-     * The output path for the doc model file.  The file extension should be ".api.json".
-     *
-     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
-     * prepend a folder token such as "<projectFolder>".
-     *
-     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
-     * DEFAULT VALUE: "<projectFolder>/temp/<unscopedPackageName>.api.json"
-     */
-    // "apiJsonFilePath": "<projectFolder>/temp/<unscopedPackageName>.api.json"
-  },
-  /**
-   * Configures how the .d.ts rollup file will be generated.
-   */
-  "dtsRollup": {
-    /**
-     * (REQUIRED) Whether to generate the .d.ts rollup file.
-     */
-    "enabled": true
-    /**
-     * Specifies the output path for a .d.ts rollup file to be generated without any trimming.
-     * This file will include all declarations that are exported by the main entry point.
-     *
-     * If the path is an empty string, then this file will not be written.
-     *
-     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
-     * prepend a folder token such as "<projectFolder>".
-     *
-     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
-     * DEFAULT VALUE: "<projectFolder>/dist/<unscopedPackageName>.d.ts"
-     */
-    // "untrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>.d.ts",
-    /**
-     * Specifies the output path for a .d.ts rollup file to be generated with trimming for a "beta" release.
-     * This file will include only declarations that are marked as "@public" or "@beta".
-     *
-     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
-     * prepend a folder token such as "<projectFolder>".
-     *
-     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
-     * DEFAULT VALUE: ""
-     */
-    // "betaTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-beta.d.ts",
-    /**
-     * Specifies the output path for a .d.ts rollup file to be generated with trimming for a "public" release.
-     * This file will include only declarations that are marked as "@public".
-     *
-     * If the path is an empty string, then this file will not be written.
-     *
-     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
-     * prepend a folder token such as "<projectFolder>".
-     *
-     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
-     * DEFAULT VALUE: ""
-     */
-    // "publicTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-public.d.ts",
-    /**
-     * When a declaration is trimmed, by default it will be replaced by a code comment such as
-     * "Excluded from this release type: exampleMember".  Set "omitTrimmingComments" to true to remove the
-     * declaration completely.
-     *
-     * DEFAULT VALUE: false
-     */
-    // "omitTrimmingComments": true
-  },
-  /**
-   * Configures how the tsdoc-metadata.json file will be generated.
-   */
-  "tsdocMetadata": {
-    /**
-     * Whether to generate the tsdoc-metadata.json file.
-     *
-     * DEFAULT VALUE: true
-     */
-    // "enabled": true,
-    /**
-     * Specifies where the TSDoc metadata file should be written.
-     *
-     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
-     * prepend a folder token such as "<projectFolder>".
-     *
-     * The default value is "<lookup>", which causes the path to be automatically inferred from the "tsdocMetadata",
-     * "typings" or "main" fields of the project's package.json.  If none of these fields are set, the lookup
-     * falls back to "tsdoc-metadata.json" in the package folder.
-     *
-     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
-     * DEFAULT VALUE: "<lookup>"
-     */
-    // "tsdocMetadataFilePath": "<projectFolder>/dist/tsdoc-metadata.json"
-  },
-  /**
-   * Specifies what type of newlines API Extractor should use when writing output files.  By default, the output files
-   * will be written with Windows-style newlines.  To use POSIX-style newlines, specify "lf" instead.
-   * To use the OS's default newline kind, specify "os".
-   *
-   * DEFAULT VALUE: "crlf"
-   */
-  // "newlineKind": "crlf",
-  /**
-   * Configures how API Extractor reports error and warning messages produced during analysis.
-   *
-   * There are three sources of messages:  compiler messages, API Extractor messages, and TSDoc messages.
-   */
-  "messages": {
-    /**
-     * Configures handling of diagnostic messages reported by the TypeScript compiler engine while analyzing
-     * the input .d.ts files.
-     *
-     * TypeScript message identifiers start with "TS" followed by an integer.  For example: "TS2551"
-     *
-     * DEFAULT VALUE:  A single "default" entry with logLevel=warning.
-     */
-    "compilerMessageReporting": {
-      /**
-       * Configures the default routing for messages that don't match an explicit rule in this table.
-       */
-      "default": {
-        /**
-         * Specifies whether the message should be written to the the tool's output log.  Note that
-         * the "addToApiReportFile" property may supersede this option.
-         *
-         * Possible values: "error", "warning", "none"
-         *
-         * Errors cause the build to fail and return a nonzero exit code.  Warnings cause a production build fail
-         * and return a nonzero exit code.  For a non-production build (e.g. when "api-extractor run" includes
-         * the "--local" option), the warning is displayed but the build will not fail.
-         *
-         * DEFAULT VALUE: "warning"
-         */
-        "logLevel": "warning"
-        /**
-         * When addToApiReportFile is true:  If API Extractor is configured to write an API report file (.api.md),
-         * then the message will be written inside that file; otherwise, the message is instead logged according to
-         * the "logLevel" option.
-         *
-         * DEFAULT VALUE: false
-         */
-        // "addToApiReportFile": false
-      }
-      // "TS2551": {
-      //   "logLevel": "warning",
-      //   "addToApiReportFile": true
-      // },
-      //
-      // . . .
-    },
-    /**
-     * Configures handling of messages reported by API Extractor during its analysis.
-     *
-     * API Extractor message identifiers start with "ae-".  For example: "ae-extra-release-tag"
-     *
-     * DEFAULT VALUE: See api-extractor-defaults.json for the complete table of extractorMessageReporting mappings
-     */
-    "extractorMessageReporting": {
-      "default": {
-        "logLevel": "warning"
-        // "addToApiReportFile": false
-      },
-      "ae-unresolved-link": {
-        "logLevel": "none",
-        "addToApiReportFile": true
-      }
-      // "ae-extra-release-tag": {
-      //   "logLevel": "warning",
-      //   "addToApiReportFile": true
-      // },
-      //
-      // . . .
-    },
-    /**
-     * Configures handling of messages reported by the TSDoc parser when analyzing code comments.
-     *
-     * TSDoc message identifiers start with "tsdoc-".  For example: "tsdoc-link-tag-unescaped-text"
-     *
-     * DEFAULT VALUE:  A single "default" entry with logLevel=warning.
-     */
-    "tsdocMessageReporting": {
-      "default": {
-        "logLevel": "warning"
-        // "addToApiReportFile": false
-      }
-      // "tsdoc-link-tag-unescaped-text": {
-      //   "logLevel": "warning",
-      //   "addToApiReportFile": true
-      // },
-      //
-      // . . .
-    }
-  }
-}

package/config/rig.json

@@ -1,16 +0,0 @@
-// The "rig.json" file directs tools to look for their config files in an external package.
-// Documentation for this system: https://www.npmjs.com/package/@rushstack/rig-package
-{
-  "$schema": "https://developer.microsoft.com/json-schemas/rig-package/rig.schema.json",
-  /**
-   * (Required) The name of the rig package to inherit from.
-   * It should be an NPM package name with the "-rig" suffix.
-   */
-  "rigPackageName": "@rushstack/heft-node-rig"
-  /**
-   * (Optional) Selects a config profile from the rig package.  The name must consist of
-   * lowercase alphanumeric words separated by hyphens, for example "sample-profile".
-   * If omitted, then the "default" profile will be used."
-   */
-  // "rigProfile": "your-profile-name"
-}