@rushstack/typings-generator 0.15.14 → 0.16.1

package/CHANGELOG.json

@@ -1,6 +1,52 @@
 {
   "name": "@rushstack/typings-generator",
   "entries": [
+    {
+      "version": "0.16.1",
+      "tag": "@rushstack/typings-generator_v0.16.1",
+      "date": "Fri, 20 Feb 2026 00:15:04 GMT",
+      "comments": {
+        "patch": [
+          {
+            "comment": "Add `\"node\"` condition before `\"import\"` in the `\"exports\"` map so that Node.js uses the CJS output (which handles extensionless imports), while bundlers still use ESM via `\"import\"`. Fixes https://github.com/microsoft/rushstack/issues/5644."
+          }
+        ],
+        "dependency": [
+          {
+            "comment": "Updating dependency \"@rushstack/node-core-library\" to `5.20.1`"
+          },
+          {
+            "comment": "Updating dependency \"@rushstack/terminal\" to `0.22.1`"
+          },
+          {
+            "comment": "Updating dependency \"@rushstack/heft\" to `1.2.1`"
+          }
+        ]
+      }
+    },
+    {
+      "version": "0.16.0",
+      "tag": "@rushstack/typings-generator_v0.16.0",
+      "date": "Thu, 19 Feb 2026 00:04:53 GMT",
+      "comments": {
+        "minor": [
+          {
+            "comment": "Normalize package layout. CommonJS is now under `lib-commonjs`, DTS is now under `lib-dts`, and ESM is now under `lib-esm`. Imports to `lib` still work as before, handled by the `\"exports\"` field in `package.json`."
+          }
+        ],
+        "dependency": [
+          {
+            "comment": "Updating dependency \"@rushstack/node-core-library\" to `5.20.0`"
+          },
+          {
+            "comment": "Updating dependency \"@rushstack/terminal\" to `0.22.0`"
+          },
+          {
+            "comment": "Updating dependency \"@rushstack/heft\" to `1.2.0`"
+          }
+        ]
+      }
+    },
     {
       "version": "0.15.14",
       "tag": "@rushstack/typings-generator_v0.15.14",

package/CHANGELOG.md

@@ -1,6 +1,20 @@
 # Change Log - @rushstack/typings-generator
 
-This log was last generated on Sat, 07 Feb 2026 01:13:26 GMT and should not be manually modified.
+This log was last generated on Fri, 20 Feb 2026 00:15:04 GMT and should not be manually modified.
+
+## 0.16.1
+Fri, 20 Feb 2026 00:15:04 GMT
+
+### Patches
+
+- Add `"node"` condition before `"import"` in the `"exports"` map so that Node.js uses the CJS output (which handles extensionless imports), while bundlers still use ESM via `"import"`. Fixes https://github.com/microsoft/rushstack/issues/5644.
+
+## 0.16.0
+Thu, 19 Feb 2026 00:04:53 GMT
+
+### Minor changes
+
+- Normalize package layout. CommonJS is now under `lib-commonjs`, DTS is now under `lib-dts`, and ESM is now under `lib-esm`. Imports to `lib` still work as before, handled by the `"exports"` field in `package.json`.
 
 ## 0.15.14
 Sat, 07 Feb 2026 01:13:26 GMT

package/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.56.2"
+      "packageVersion": "7.57.0"
     }
   ]
 }

package/lib-esm/StringValuesTypingsGenerator.js

@@ -0,0 +1,111 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import { EOL } from 'node:os';
+import { Text } from '@rushstack/node-core-library';
+import { TypingsGenerator } from './TypingsGenerator';
+const EXPORT_AS_DEFAULT_INTERFACE_NAME = 'IExport';
+function convertToTypingsGeneratorOptions(options) {
+    var _a;
+    const { exportAsDefault: exportAsDefaultOptions, exportAsDefaultInterfaceName: exportAsDefaultInterfaceName_deprecated, parseAndGenerateTypings } = options;
+    let defaultSplitExportAsDefaultInterfaceDocumentationComment;
+    let defaultSplitExportAsDefaultValueDocumentationComment;
+    let defaultExportAsDefaultInterfaceName;
+    if (typeof exportAsDefaultOptions === 'object') {
+        const { interfaceDocumentationComment, documentationComment: interfaceDocumentationComment_deprecated, valueDocumentationComment, interfaceName } = exportAsDefaultOptions;
+        defaultSplitExportAsDefaultInterfaceDocumentationComment = Text.splitByNewLines(interfaceDocumentationComment !== null && interfaceDocumentationComment !== void 0 ? interfaceDocumentationComment : interfaceDocumentationComment_deprecated);
+        defaultSplitExportAsDefaultValueDocumentationComment = Text.splitByNewLines(valueDocumentationComment);
+        defaultExportAsDefaultInterfaceName =
+            (_a = interfaceName !== null && interfaceName !== void 0 ? interfaceName : exportAsDefaultInterfaceName_deprecated) !== null && _a !== void 0 ? _a : EXPORT_AS_DEFAULT_INTERFACE_NAME;
+    }
+    else if (exportAsDefaultOptions) {
+        defaultExportAsDefaultInterfaceName =
+            exportAsDefaultInterfaceName_deprecated !== null && exportAsDefaultInterfaceName_deprecated !== void 0 ? exportAsDefaultInterfaceName_deprecated : EXPORT_AS_DEFAULT_INTERFACE_NAME;
+    }
+    async function parseAndGenerateTypingsOuter(fileContents, filePath, relativePath) {
+        var _a, _b, _c, _d;
+        const stringValueTypings = await parseAndGenerateTypings(fileContents, filePath, relativePath);
+        if (stringValueTypings === undefined) {
+            return;
+        }
+        const { exportAsDefault: exportAsDefaultOptionsOverride, typings } = stringValueTypings;
+        let exportAsDefaultInterfaceName;
+        let interfaceDocumentationCommentLines;
+        let valueDocumentationCommentLines;
+        if (typeof exportAsDefaultOptionsOverride === 'boolean') {
+            if (exportAsDefaultOptionsOverride) {
+                exportAsDefaultInterfaceName =
+                    defaultExportAsDefaultInterfaceName !== null && defaultExportAsDefaultInterfaceName !== void 0 ? defaultExportAsDefaultInterfaceName : EXPORT_AS_DEFAULT_INTERFACE_NAME;
+                interfaceDocumentationCommentLines = defaultSplitExportAsDefaultInterfaceDocumentationComment;
+                valueDocumentationCommentLines = defaultSplitExportAsDefaultValueDocumentationComment;
+            }
+        }
+        else if (exportAsDefaultOptionsOverride) {
+            const { interfaceName, documentationComment, interfaceDocumentationComment, valueDocumentationComment } = exportAsDefaultOptionsOverride;
+            exportAsDefaultInterfaceName =
+                (_a = interfaceName !== null && interfaceName !== void 0 ? interfaceName : defaultExportAsDefaultInterfaceName) !== null && _a !== void 0 ? _a : EXPORT_AS_DEFAULT_INTERFACE_NAME;
+            interfaceDocumentationCommentLines =
+                (_c = (_b = Text.splitByNewLines(interfaceDocumentationComment)) !== null && _b !== void 0 ? _b : Text.splitByNewLines(documentationComment)) !== null && _c !== void 0 ? _c : defaultSplitExportAsDefaultInterfaceDocumentationComment;
+            valueDocumentationCommentLines =
+                (_d = Text.splitByNewLines(valueDocumentationComment)) !== null && _d !== void 0 ? _d : defaultSplitExportAsDefaultValueDocumentationComment;
+        }
+        else {
+            exportAsDefaultInterfaceName = defaultExportAsDefaultInterfaceName;
+            interfaceDocumentationCommentLines = defaultSplitExportAsDefaultInterfaceDocumentationComment;
+            valueDocumentationCommentLines = defaultSplitExportAsDefaultValueDocumentationComment;
+        }
+        const outputLines = [];
+        let indent = '';
+        if (exportAsDefaultInterfaceName) {
+            if (interfaceDocumentationCommentLines) {
+                outputLines.push(`/**`);
+                for (const line of interfaceDocumentationCommentLines) {
+                    outputLines.push(` * ${line}`);
+                }
+                outputLines.push(` */`);
+            }
+            outputLines.push(`export interface ${exportAsDefaultInterfaceName} {`);
+            indent = '  ';
+        }
+        for (const stringValueTyping of typings) {
+            const { exportName, comment } = stringValueTyping;
+            if (comment && comment.trim() !== '') {
+                outputLines.push(`${indent}/**`, `${indent} * ${comment.replace(/\*\//g, '*\\/')}`, `${indent} */`);
+            }
+            if (exportAsDefaultInterfaceName) {
+                outputLines.push(`${indent}'${exportName}': string;`, '');
+            }
+            else {
+                outputLines.push(`export declare const ${exportName}: string;`, '');
+            }
+        }
+        if (exportAsDefaultInterfaceName) {
+            outputLines.push('}', '');
+            if (valueDocumentationCommentLines) {
+                outputLines.push(`/**`);
+                for (const line of valueDocumentationCommentLines) {
+                    outputLines.push(` * ${line}`);
+                }
+                outputLines.push(` */`);
+            }
+            outputLines.push(`declare const strings: ${exportAsDefaultInterfaceName};`, '', 'export default strings;');
+        }
+        return outputLines.join(EOL);
+    }
+    const convertedOptions = {
+        ...options,
+        parseAndGenerateTypings: parseAndGenerateTypingsOuter
+    };
+    return convertedOptions;
+}
+/**
+ * This is a simple tool that generates .d.ts files for non-TS files that can be represented as
+ * a simple set of named string exports.
+ *
+ * @public
+ */
+export class StringValuesTypingsGenerator extends TypingsGenerator {
+    constructor(options) {
+        super(convertToTypingsGeneratorOptions(options));
+    }
+}
+//# sourceMappingURL=StringValuesTypingsGenerator.js.map

package/lib-esm/StringValuesTypingsGenerator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StringValuesTypingsGenerator.js","sourceRoot":"","sources":["../src/StringValuesTypingsGenerator.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EAAE,GAAG,EAAE,MAAM,SAAS,CAAC;AAE9B,OAAO,EAAE,IAAI,EAAE,MAAM,8BAA8B,CAAC;AAEpD,OAAO,EAEL,gBAAgB,EAEjB,MAAM,oBAAoB,CAAC;AAsF5B,MAAM,gCAAgC,GAAW,SAAS,CAAC;AAE3D,SAAS,gCAAgC,CACvC,OAA8E;;IAE9E,MAAM,EACJ,eAAe,EAAE,sBAAsB,EACvC,4BAA4B,EAAE,uCAAuC,EACrE,uBAAuB,EACxB,GAAG,OAAO,CAAC;IACZ,IAAI,wDAA8E,CAAC;IACnF,IAAI,oDAA0E,CAAC;IAC/E,IAAI,mCAAuD,CAAC;IAC5D,IAAI,OAAO,sBAAsB,KAAK,QAAQ,EAAE,CAAC;QAC/C,MAAM,EACJ,6BAA6B,EAC7B,oBAAoB,EAAE,wCAAwC,EAC9D,yBAAyB,EACzB,aAAa,EACd,GAAG,sBAAsB,CAAC;QAC3B,wDAAwD,GAAG,IAAI,CAAC,eAAe,CAC7E,6BAA6B,aAA7B,6BAA6B,cAA7B,6BAA6B,GAAI,wCAAwC,CAC1E,CAAC;QACF,oDAAoD,GAAG,IAAI,CAAC,eAAe,CAAC,yBAAyB,CAAC,CAAC;QACvG,mCAAmC;YACjC,MAAA,aAAa,aAAb,aAAa,cAAb,aAAa,GAAI,uCAAuC,mCAAI,gCAAgC,CAAC;IACjG,CAAC;SAAM,IAAI,sBAAsB,EAAE,CAAC;QAClC,mCAAmC;YACjC,uCAAuC,aAAvC,uCAAuC,cAAvC,uCAAuC,GAAI,gCAAgC,CAAC;IAChF,CAAC;IAED,KAAK,UAAU,4BAA4B,CACzC,YAA2B,EAC3B,QAAgB,EAChB,YAAoB;;QAEpB,MAAM,kBAAkB,GAAoC,MAAM,uBAAuB,CACvF,YAAY,EACZ,QAAQ,EACR,YAAY,CACb,CAAC;QAEF,IAAI,kBAAkB,KAAK,SAAS,EAAE,CAAC;YACrC,OAAO;QACT,CAAC;QAED,MAAM,EAAE,eAAe,EAAE,8BAA8B,EAAE,OAAO,EAAE,GAAG,kBAAkB,CAAC;QACxF,IAAI,4BAAgD,CAAC;QACrD,IAAI,kCAAwD,CAAC;QAC7D,IAAI,8BAAoD,CAAC;QACzD,IAAI,OAAO,8BAA8B,KAAK,SAAS,EAAE,CAAC;YACxD,IAAI,8BAA8B,EAAE,CAAC;gBACnC,4BAA4B;oBAC1B,mCAAmC,aAAnC,mCAAmC,cAAnC,mCAAmC,GAAI,gCAAgC,CAAC;gBAC1E,kCAAkC,GAAG,wDAAwD,CAAC;gBAC9F,8BAA8B,GAAG,oDAAoD,CAAC;YACxF,CAAC;QACH,CAAC;aAAM,IAAI,8BAA8B,EAAE,CAAC;YAC1C,MAAM,EACJ,aAAa,EACb,oBAAoB,EACpB,6BAA6B,EAC7B,yBAAyB,EAC1B,GAAG,8BAA8B,CAAC;YACnC,4BAA4B;gBAC1B,MAAA,aAAa,aAAb,aAAa,cAAb,aAAa,GAAI,mCAAmC,mCAAI,gCAAgC,CAAC;YAC3F,kCAAkC;gBAChC,MAAA,MAAA,IAAI,CAAC,eAAe,CAAC,6BAA6B,CAAC,mCACnD,IAAI,CAAC,eAAe,CAAC,oBAAoB,CAAC,mCAC1C,wDAAwD,CAAC;YAC3D,8BAA8B;gBAC5B,MAAA,IAAI,CAAC,eAAe,CAAC,yBAAyB,CAAC,mCAC/C,oDAAoD,CAAC;QACzD,CAAC;aAAM,CAAC;YACN,4BAA4B,GAAG,mCAAmC,CAAC;YACnE,kCAAkC,GAAG,wDAAwD,CAAC;YAC9F,8BAA8B,GAAG,oDAAoD,CAAC;QACxF,CAAC;QAED,MAAM,WAAW,GAAa,EAAE,CAAC;QACjC,IAAI,MAAM,GAAW,EAAE,CAAC;QACxB,IAAI,4BAA4B,EAAE,CAAC;YACjC,IAAI,kCAAkC,EAAE,CAAC;gBACvC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACxB,KAAK,MAAM,IAAI,IAAI,kCAAkC,EAAE,CAAC;oBACtD,WAAW,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;gBACjC,CAAC;gBAED,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC1B,CAAC;YAED,WAAW,CAAC,IAAI,CAAC,oBAAoB,4BAA4B,IAAI,CAAC,CAAC;YACvE,MAAM,GAAG,IAAI,CAAC;QAChB,CAAC;QAED,KAAK,MAAM,iBAAiB,IAAI,OAAO,EAAE,CAAC;YACxC,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,iBAAiB,CAAC;YAElD,IAAI,OAAO,IAAI,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;gBACrC,WAAW,CAAC,IAAI,CAAC,GAAG,MAAM,KAAK,EAAE,GAAG,MAAM,MAAM,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,EAAE,GAAG,MAAM,KAAK,CAAC,CAAC;YACtG,CAAC;YAED,IAAI,4BAA4B,EAAE,CAAC;gBACjC,WAAW,CAAC,IAAI,CAAC,GAAG,MAAM,IAAI,UAAU,YAAY,EAAE,EAAE,CAAC,CAAC;YAC5D,CAAC;iBAAM,CAAC;gBACN,WAAW,CAAC,IAAI,CAAC,wBAAwB,UAAU,WAAW,EAAE,EAAE,CAAC,CAAC;YACtE,CAAC;QACH,CAAC;QAED,IAAI,4BAA4B,EAAE,CAAC;YACjC,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YAE1B,IAAI,8BAA8B,EAAE,CAAC;gBACnC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACxB,KAAK,MAAM,IAAI,IAAI,8BAA8B,EAAE,CAAC;oBAClD,WAAW,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;gBACjC,CAAC;gBAED,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC1B,CAAC;YAED,WAAW,CAAC,IAAI,CACd,0BAA0B,4BAA4B,GAAG,EACzD,EAAE,EACF,yBAAyB,CAC1B,CAAC;QACJ,CAAC;QAED,OAAO,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC/B,CAAC;IAED,MAAM,gBAAgB,GAAkF;QACtG,GAAG,OAAO;QACV,uBAAuB,EAAE,4BAA4B;KACtD,CAAC;IAEF,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAED;;;;;GAKG;AACH,MAAM,OAAO,4BAAqD,SAAQ,gBAA+B;IAKvG,YAAmB,OAA8E;QAC/F,KAAK,CAAC,gCAAgC,CAAC,OAAO,CAAC,CAAC,CAAC;IACnD,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport { EOL } from 'node:os';\n\nimport { Text } from '@rushstack/node-core-library';\n\nimport {\n  type ITypingsGeneratorOptions,\n  TypingsGenerator,\n  type ITypingsGeneratorOptionsWithCustomReadFile\n} from './TypingsGenerator';\n\n/**\n * @public\n */\nexport interface IStringValueTyping {\n  exportName: string;\n  comment?: string;\n}\n\n/**\n * @public\n */\nexport interface IStringValueTypings {\n  typings: IStringValueTyping[];\n\n  /**\n   * Options for default exports. Note that options provided here will override\n   * options provided in {@link IStringValuesTypingsGeneratorBaseOptions.exportAsDefault}.\n   */\n  exportAsDefault?: boolean | IExportAsDefaultOptions;\n}\n\n/**\n * @public\n */\nexport interface IExportAsDefaultOptions {\n  /**\n   * This setting overrides the the interface name for the default wrapped export.\n   *\n   * @defaultValue \"IExport\"\n   */\n  interfaceName?: string;\n\n  /**\n   * @deprecated - Use {@link IExportAsDefaultOptions.interfaceDocumentationComment} instead.\n   */\n  documentationComment?: string;\n\n  /**\n   * This value is placed in a documentation comment for the\n   * exported default interface.\n   */\n  interfaceDocumentationComment?: string;\n\n  /**\n   * This value is placed in a documentation comment for the\n   * exported const value.\n   */\n  valueDocumentationComment?: string;\n}\n\n/**\n * @public\n */\nexport interface IStringValuesTypingsGeneratorBaseOptions {\n  /**\n   * Setting this option wraps the typings export in a default property.\n   */\n  exportAsDefault?: boolean | IExportAsDefaultOptions;\n\n  /**\n   * @deprecated Use {@link IStringValuesTypingsGeneratorBaseOptions.exportAsDefault}'s\n   * {@link IExportAsDefaultOptions.interfaceName} instead.\n   */\n  exportAsDefaultInterfaceName?: string;\n}\n\n/**\n * @public\n */\nexport interface IStringValuesTypingsGeneratorOptions<TFileContents extends string = string>\n  extends ITypingsGeneratorOptions<IStringValueTypings | undefined, TFileContents>,\n    IStringValuesTypingsGeneratorBaseOptions {\n  // Nothing added.\n}\n\n/**\n * @public\n */\nexport interface IStringValuesTypingsGeneratorOptionsWithCustomReadFile<TFileContents = string>\n  extends ITypingsGeneratorOptionsWithCustomReadFile<IStringValueTypings | undefined, TFileContents>,\n    IStringValuesTypingsGeneratorBaseOptions {\n  // Nothing added.\n}\n\nconst EXPORT_AS_DEFAULT_INTERFACE_NAME: string = 'IExport';\n\nfunction convertToTypingsGeneratorOptions<TFileContents>(\n  options: IStringValuesTypingsGeneratorOptionsWithCustomReadFile<TFileContents>\n): ITypingsGeneratorOptionsWithCustomReadFile<string | undefined, TFileContents> {\n  const {\n    exportAsDefault: exportAsDefaultOptions,\n    exportAsDefaultInterfaceName: exportAsDefaultInterfaceName_deprecated,\n    parseAndGenerateTypings\n  } = options;\n  let defaultSplitExportAsDefaultInterfaceDocumentationComment: string[] | undefined;\n  let defaultSplitExportAsDefaultValueDocumentationComment: string[] | undefined;\n  let defaultExportAsDefaultInterfaceName: string | undefined;\n  if (typeof exportAsDefaultOptions === 'object') {\n    const {\n      interfaceDocumentationComment,\n      documentationComment: interfaceDocumentationComment_deprecated,\n      valueDocumentationComment,\n      interfaceName\n    } = exportAsDefaultOptions;\n    defaultSplitExportAsDefaultInterfaceDocumentationComment = Text.splitByNewLines(\n      interfaceDocumentationComment ?? interfaceDocumentationComment_deprecated\n    );\n    defaultSplitExportAsDefaultValueDocumentationComment = Text.splitByNewLines(valueDocumentationComment);\n    defaultExportAsDefaultInterfaceName =\n      interfaceName ?? exportAsDefaultInterfaceName_deprecated ?? EXPORT_AS_DEFAULT_INTERFACE_NAME;\n  } else if (exportAsDefaultOptions) {\n    defaultExportAsDefaultInterfaceName =\n      exportAsDefaultInterfaceName_deprecated ?? EXPORT_AS_DEFAULT_INTERFACE_NAME;\n  }\n\n  async function parseAndGenerateTypingsOuter(\n    fileContents: TFileContents,\n    filePath: string,\n    relativePath: string\n  ): Promise<string | undefined> {\n    const stringValueTypings: IStringValueTypings | undefined = await parseAndGenerateTypings(\n      fileContents,\n      filePath,\n      relativePath\n    );\n\n    if (stringValueTypings === undefined) {\n      return;\n    }\n\n    const { exportAsDefault: exportAsDefaultOptionsOverride, typings } = stringValueTypings;\n    let exportAsDefaultInterfaceName: string | undefined;\n    let interfaceDocumentationCommentLines: string[] | undefined;\n    let valueDocumentationCommentLines: string[] | undefined;\n    if (typeof exportAsDefaultOptionsOverride === 'boolean') {\n      if (exportAsDefaultOptionsOverride) {\n        exportAsDefaultInterfaceName =\n          defaultExportAsDefaultInterfaceName ?? EXPORT_AS_DEFAULT_INTERFACE_NAME;\n        interfaceDocumentationCommentLines = defaultSplitExportAsDefaultInterfaceDocumentationComment;\n        valueDocumentationCommentLines = defaultSplitExportAsDefaultValueDocumentationComment;\n      }\n    } else if (exportAsDefaultOptionsOverride) {\n      const {\n        interfaceName,\n        documentationComment,\n        interfaceDocumentationComment,\n        valueDocumentationComment\n      } = exportAsDefaultOptionsOverride;\n      exportAsDefaultInterfaceName =\n        interfaceName ?? defaultExportAsDefaultInterfaceName ?? EXPORT_AS_DEFAULT_INTERFACE_NAME;\n      interfaceDocumentationCommentLines =\n        Text.splitByNewLines(interfaceDocumentationComment) ??\n        Text.splitByNewLines(documentationComment) ??\n        defaultSplitExportAsDefaultInterfaceDocumentationComment;\n      valueDocumentationCommentLines =\n        Text.splitByNewLines(valueDocumentationComment) ??\n        defaultSplitExportAsDefaultValueDocumentationComment;\n    } else {\n      exportAsDefaultInterfaceName = defaultExportAsDefaultInterfaceName;\n      interfaceDocumentationCommentLines = defaultSplitExportAsDefaultInterfaceDocumentationComment;\n      valueDocumentationCommentLines = defaultSplitExportAsDefaultValueDocumentationComment;\n    }\n\n    const outputLines: string[] = [];\n    let indent: string = '';\n    if (exportAsDefaultInterfaceName) {\n      if (interfaceDocumentationCommentLines) {\n        outputLines.push(`/**`);\n        for (const line of interfaceDocumentationCommentLines) {\n          outputLines.push(` * ${line}`);\n        }\n\n        outputLines.push(` */`);\n      }\n\n      outputLines.push(`export interface ${exportAsDefaultInterfaceName} {`);\n      indent = '  ';\n    }\n\n    for (const stringValueTyping of typings) {\n      const { exportName, comment } = stringValueTyping;\n\n      if (comment && comment.trim() !== '') {\n        outputLines.push(`${indent}/**`, `${indent} * ${comment.replace(/\\*\\//g, '*\\\\/')}`, `${indent} */`);\n      }\n\n      if (exportAsDefaultInterfaceName) {\n        outputLines.push(`${indent}'${exportName}': string;`, '');\n      } else {\n        outputLines.push(`export declare const ${exportName}: string;`, '');\n      }\n    }\n\n    if (exportAsDefaultInterfaceName) {\n      outputLines.push('}', '');\n\n      if (valueDocumentationCommentLines) {\n        outputLines.push(`/**`);\n        for (const line of valueDocumentationCommentLines) {\n          outputLines.push(` * ${line}`);\n        }\n\n        outputLines.push(` */`);\n      }\n\n      outputLines.push(\n        `declare const strings: ${exportAsDefaultInterfaceName};`,\n        '',\n        'export default strings;'\n      );\n    }\n\n    return outputLines.join(EOL);\n  }\n\n  const convertedOptions: ITypingsGeneratorOptionsWithCustomReadFile<string | undefined, TFileContents> = {\n    ...options,\n    parseAndGenerateTypings: parseAndGenerateTypingsOuter\n  };\n\n  return convertedOptions;\n}\n\n/**\n * This is a simple tool that generates .d.ts files for non-TS files that can be represented as\n * a simple set of named string exports.\n *\n * @public\n */\nexport class StringValuesTypingsGenerator<TFileContents = string> extends TypingsGenerator<TFileContents> {\n  public constructor(\n    options: TFileContents extends string ? IStringValuesTypingsGeneratorOptions<TFileContents> : never\n  );\n  public constructor(options: IStringValuesTypingsGeneratorOptionsWithCustomReadFile<TFileContents>);\n  public constructor(options: IStringValuesTypingsGeneratorOptionsWithCustomReadFile<TFileContents>) {\n    super(convertToTypingsGeneratorOptions(options));\n  }\n}\n"]}

package/lib-esm/TypingsGenerator.js

@@ -0,0 +1,242 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import * as path from 'node:path';
+import { EOL } from 'node:os';
+import glob from 'fast-glob';
+import * as chokidar from 'chokidar';
+import { Terminal, ConsoleTerminalProvider } from '@rushstack/terminal';
+import { FileSystem, Path, NewlineKind, Async } from '@rushstack/node-core-library';
+/**
+ * This is a simple tool that generates .d.ts files for non-TS files.
+ *
+ * @public
+ */
+export class TypingsGenerator {
+    constructor(options) {
+        var _a, _b;
+        this._options = {
+            ...options,
+            readFile: (_a = options.readFile) !== null && _a !== void 0 ? _a : ((filePath, relativePath) => FileSystem.readFileAsync(filePath))
+        };
+        if (!options.generatedTsFolder) {
+            throw new Error('generatedTsFolder must be provided');
+        }
+        if (!options.srcFolder) {
+            throw new Error('srcFolder must be provided');
+        }
+        this.sourceFolderPath = options.srcFolder;
+        if (Path.isUnder(options.srcFolder, options.generatedTsFolder)) {
+            throw new Error('srcFolder must not be under generatedTsFolder');
+        }
+        if (Path.isUnder(options.generatedTsFolder, options.srcFolder)) {
+            throw new Error('generatedTsFolder must not be under srcFolder');
+        }
+        if (!options.fileExtensions || options.fileExtensions.length === 0) {
+            throw new Error('At least one file extension must be provided.');
+        }
+        this.ignoredFileGlobs = options.globsToIgnore || [];
+        this.terminal = (_b = options.terminal) !== null && _b !== void 0 ? _b : new Terminal(new ConsoleTerminalProvider({ verboseEnabled: true }));
+        this._options.fileExtensions = this._normalizeFileExtensions(options.fileExtensions);
+        this._dependenciesOfFile = new Map();
+        this._consumersOfFile = new Map();
+        this._relativePaths = new Map();
+        this.inputFileGlob = `**/*+(${this._options.fileExtensions.join('|')})`;
+    }
+    /**
+     * Generate typings for the provided input files.
+     *
+     * @param relativeFilePaths - The input files to process, relative to the source folder. If not provided,
+     * all input files will be processed.
+     */
+    async generateTypingsAsync(relativeFilePaths) {
+        let checkFilePaths = true;
+        if (!(relativeFilePaths === null || relativeFilePaths === void 0 ? void 0 : relativeFilePaths.length)) {
+            checkFilePaths = false; // Don't check file paths if we generate them
+            relativeFilePaths = await glob(this.inputFileGlob, {
+                cwd: this.sourceFolderPath,
+                ignore: this.ignoredFileGlobs,
+                onlyFiles: true
+            });
+        }
+        await this._reprocessFilesAsync(relativeFilePaths, checkFilePaths);
+    }
+    async runWatcherAsync() {
+        await FileSystem.ensureFolderAsync(this._options.generatedTsFolder);
+        await new Promise((resolve, reject) => {
+            const watcher = chokidar.watch(this.inputFileGlob, {
+                cwd: this.sourceFolderPath,
+                ignored: this.ignoredFileGlobs // `ignored` doesn't like the readonly array
+            });
+            const queue = new Set();
+            let timeout;
+            let processing = false;
+            let flushAfterCompletion = false;
+            const flushInternal = () => {
+                processing = true;
+                const toProcess = Array.from(queue);
+                queue.clear();
+                this._reprocessFilesAsync(toProcess, false)
+                    .then(() => {
+                    processing = false;
+                    // If the timeout was invoked again, immediately reexecute with the changed files.
+                    if (flushAfterCompletion) {
+                        flushAfterCompletion = false;
+                        flushInternal();
+                    }
+                })
+                    .catch(reject);
+            };
+            const debouncedFlush = () => {
+                timeout = undefined;
+                if (processing) {
+                    // If the callback was invoked while processing is ongoing, indicate that we should flush immediately
+                    // upon completion of the current change batch.
+                    flushAfterCompletion = true;
+                    return;
+                }
+                flushInternal();
+            };
+            const onChange = (relativePath) => {
+                queue.add(relativePath);
+                if (timeout) {
+                    clearTimeout(timeout);
+                }
+                setTimeout(debouncedFlush, 100);
+            };
+            watcher.on('add', onChange);
+            watcher.on('change', onChange);
+            watcher.on('unlink', async (relativePath) => {
+                await Promise.all(this._getOutputFilePathsWithoutCheck(relativePath).map(async (outputFile) => {
+                    await FileSystem.deleteFileAsync(outputFile);
+                }));
+            });
+            watcher.on('error', reject);
+        });
+    }
+    /**
+     * Register file dependencies that may effect the typings of a consumer file.
+     * Note: This feature is only useful in watch mode.
+     * The registerDependency method must be called in the body of parseAndGenerateTypings every
+     * time because the registry for a file is cleared at the beginning of processing.
+     */
+    registerDependency(consumer, rawDependency) {
+        // Need to normalize slashes in the dependency path
+        const dependency = path.resolve(this._options.srcFolder, rawDependency);
+        let dependencies = this._dependenciesOfFile.get(consumer);
+        if (!dependencies) {
+            dependencies = new Set();
+            this._dependenciesOfFile.set(consumer, dependencies);
+        }
+        dependencies.add(dependency);
+        let consumers = this._consumersOfFile.get(dependency);
+        if (!consumers) {
+            consumers = new Set();
+            this._consumersOfFile.set(dependency, consumers);
+        }
+        consumers.add(consumer);
+    }
+    getOutputFilePaths(relativePath) {
+        if (path.isAbsolute(relativePath)) {
+            throw new Error(`"${relativePath}" must be relative`);
+        }
+        return this._getOutputFilePathsWithoutCheck(relativePath);
+    }
+    _getOutputFilePathsWithoutCheck(relativePath) {
+        var _a, _b;
+        const typingsFilePaths = this._getTypingsFilePaths(relativePath);
+        const additionalPaths = (_b = (_a = this._options).getAdditionalOutputFiles) === null || _b === void 0 ? void 0 : _b.call(_a, relativePath);
+        return additionalPaths ? [...typingsFilePaths, ...additionalPaths] : Array.from(typingsFilePaths);
+    }
+    async _reprocessFilesAsync(relativePaths, checkFilePaths) {
+        // Build a queue of resolved paths
+        const toProcess = new Set();
+        for (const rawPath of relativePaths) {
+            if (checkFilePaths && path.isAbsolute(rawPath)) {
+                throw new Error(`"${rawPath}" must be relative`);
+            }
+            const relativePath = Path.convertToSlashes(rawPath);
+            const resolvedPath = path.resolve(this._options.srcFolder, rawPath);
+            this._relativePaths.set(resolvedPath, relativePath);
+            toProcess.add(resolvedPath);
+        }
+        // Expand out all registered consumers, according to the current dependency graph
+        for (const file of toProcess) {
+            const consumers = this._consumersOfFile.get(file);
+            if (consumers) {
+                for (const consumer of consumers) {
+                    toProcess.add(consumer);
+                }
+            }
+        }
+        // Map back to the relative paths so that the information is available
+        await Async.forEachAsync(toProcess, async (resolvedPath) => {
+            const relativePath = this._relativePaths.get(resolvedPath);
+            if (!relativePath) {
+                throw new Error(`Missing relative path for file ${resolvedPath}`);
+            }
+            await this._parseFileAndGenerateTypingsAsync(relativePath, resolvedPath);
+        }, { concurrency: 20 });
+    }
+    async _parseFileAndGenerateTypingsAsync(relativePath, resolvedPath) {
+        // Clear registered dependencies prior to reprocessing.
+        this._clearDependencies(resolvedPath);
+        try {
+            const fileContents = await this._options.readFile(resolvedPath, relativePath);
+            const typingsData = await this._options.parseAndGenerateTypings(fileContents, resolvedPath, relativePath);
+            // Typings data will be undefined when no types should be generated for the parsed file.
+            if (typingsData === undefined) {
+                return;
+            }
+            const prefixedTypingsData = [
+                '// This file was generated by a tool. Modifying it will produce unexpected behavior',
+                '',
+                typingsData
+            ].join(EOL);
+            const generatedTsFilePaths = this._getTypingsFilePaths(relativePath);
+            for (const generatedTsFilePath of generatedTsFilePaths) {
+                await FileSystem.writeFileAsync(generatedTsFilePath, prefixedTypingsData, {
+                    ensureFolderExists: true,
+                    convertLineEndings: NewlineKind.OsDefault
+                });
+            }
+        }
+        catch (e) {
+            this.terminal.writeError(`Error occurred parsing and generating typings for file "${resolvedPath}": ${e}`);
+        }
+    }
+    /**
+     * Removes the consumer from all extant dependencies
+     */
+    _clearDependencies(consumer) {
+        const dependencies = this._dependenciesOfFile.get(consumer);
+        if (dependencies) {
+            for (const dependency of dependencies) {
+                this._consumersOfFile.get(dependency).delete(consumer);
+            }
+            dependencies.clear();
+        }
+    }
+    *_getTypingsFilePaths(relativePath) {
+        const { generatedTsFolder, secondaryGeneratedTsFolders } = this._options;
+        const dtsFilename = `${relativePath}.d.ts`;
+        yield `${generatedTsFolder}/${dtsFilename}`;
+        if (secondaryGeneratedTsFolders) {
+            for (const secondaryGeneratedTsFolder of secondaryGeneratedTsFolders) {
+                yield `${secondaryGeneratedTsFolder}/${dtsFilename}`;
+            }
+        }
+    }
+    _normalizeFileExtensions(fileExtensions) {
+        const result = new Set();
+        for (const fileExtension of fileExtensions) {
+            if (!fileExtension.startsWith('.')) {
+                result.add(`.${fileExtension}`);
+            }
+            else {
+                result.add(fileExtension);
+            }
+        }
+        return Array.from(result);
+    }
+}
+//# sourceMappingURL=TypingsGenerator.js.map

package/lib-esm/TypingsGenerator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TypingsGenerator.js","sourceRoot":"","sources":["../src/TypingsGenerator.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,GAAG,EAAE,MAAM,SAAS,CAAC;AAE9B,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,KAAK,QAAQ,MAAM,UAAU,CAAC;AAErC,OAAO,EAAkB,QAAQ,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AACxF,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,8BAA8B,CAAC;AA2DpF;;;;GAIG;AACH,MAAM,OAAO,gBAAgB;IAmC3B,YAAmB,OAAsF;;QACvG,IAAI,CAAC,QAAQ,GAAG;YACd,GAAG,OAAO;YACV,QAAQ,EACN,MAAA,OAAO,CAAC,QAAQ,mCAChB,CAAC,CAAC,QAAgB,EAAE,YAAoB,EAA0B,EAAE,CAClE,UAAU,CAAC,aAAa,CAAC,QAAQ,CAA2B,CAAC;SAClE,CAAC;QAEF,IAAI,CAAC,OAAO,CAAC,iBAAiB,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;QACxD,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAChD,CAAC;QACD,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,SAAS,CAAC;QAE1C,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,iBAAiB,CAAC,EAAE,CAAC;YAC/D,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;QACnE,CAAC;QAED,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,iBAAiB,EAAE,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;YAC/D,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;QACnE,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,cAAc,IAAI,OAAO,CAAC,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACnE,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;QACnE,CAAC;QAED,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,aAAa,IAAI,EAAE,CAAC;QAEpD,IAAI,CAAC,QAAQ,GAAG,MAAA,OAAO,CAAC,QAAQ,mCAAI,IAAI,QAAQ,CAAC,IAAI,uBAAuB,CAAC,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QAExG,IAAI,CAAC,QAAQ,CAAC,cAAc,GAAG,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAErF,IAAI,CAAC,mBAAmB,GAAG,IAAI,GAAG,EAAE,CAAC;QACrC,IAAI,CAAC,gBAAgB,GAAG,IAAI,GAAG,EAAE,CAAC;QAClC,IAAI,CAAC,cAAc,GAAG,IAAI,GAAG,EAAE,CAAC;QAEhC,IAAI,CAAC,aAAa,GAAG,SAAS,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;IAC1E,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,oBAAoB,CAAC,iBAA4B;QAC5D,IAAI,cAAc,GAAY,IAAI,CAAC;QACnC,IAAI,CAAC,CAAA,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,MAAM,CAAA,EAAE,CAAC;YAC/B,cAAc,GAAG,KAAK,CAAC,CAAC,6CAA6C;YACrE,iBAAiB,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE;gBACjD,GAAG,EAAE,IAAI,CAAC,gBAAgB;gBAC1B,MAAM,EAAE,IAAI,CAAC,gBAA4B;gBACzC,SAAS,EAAE,IAAI;aAChB,CAAC,CAAC;QACL,CAAC;QAED,MAAM,IAAI,CAAC,oBAAoB,CAAC,iBAAkB,EAAE,cAAc,CAAC,CAAC;IACtE,CAAC;IAEM,KAAK,CAAC,eAAe;QAC1B,MAAM,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC;QAEpE,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAQ,EAAE;YAC1C,MAAM,OAAO,GAAuB,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,EAAE;gBACrE,GAAG,EAAE,IAAI,CAAC,gBAAgB;gBAC1B,OAAO,EAAE,IAAI,CAAC,gBAA4B,CAAC,4CAA4C;aACxF,CAAC,CAAC;YAEH,MAAM,KAAK,GAAgB,IAAI,GAAG,EAAE,CAAC;YACrC,IAAI,OAAmC,CAAC;YACxC,IAAI,UAAU,GAAY,KAAK,CAAC;YAChC,IAAI,oBAAoB,GAAY,KAAK,CAAC;YAE1C,MAAM,aAAa,GAAe,GAAG,EAAE;gBACrC,UAAU,GAAG,IAAI,CAAC;gBAElB,MAAM,SAAS,GAAa,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBAC9C,KAAK,CAAC,KAAK,EAAE,CAAC;gBACd,IAAI,CAAC,oBAAoB,CAAC,SAAS,EAAE,KAAK,CAAC;qBACxC,IAAI,CAAC,GAAG,EAAE;oBACT,UAAU,GAAG,KAAK,CAAC;oBACnB,kFAAkF;oBAClF,IAAI,oBAAoB,EAAE,CAAC;wBACzB,oBAAoB,GAAG,KAAK,CAAC;wBAC7B,aAAa,EAAE,CAAC;oBAClB,CAAC;gBACH,CAAC,CAAC;qBACD,KAAK,CAAC,MAAM,CAAC,CAAC;YACnB,CAAC,CAAC;YAEF,MAAM,cAAc,GAAe,GAAG,EAAE;gBACtC,OAAO,GAAG,SAAS,CAAC;gBACpB,IAAI,UAAU,EAAE,CAAC;oBACf,qGAAqG;oBACrG,+CAA+C;oBAC/C,oBAAoB,GAAG,IAAI,CAAC;oBAC5B,OAAO;gBACT,CAAC;gBAED,aAAa,EAAE,CAAC;YAClB,CAAC,CAAC;YAEF,MAAM,QAAQ,GAAmC,CAAC,YAAoB,EAAE,EAAE;gBACxE,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;gBACxB,IAAI,OAAO,EAAE,CAAC;oBACZ,YAAY,CAAC,OAAO,CAAC,CAAC;gBACxB,CAAC;gBAED,UAAU,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC;YAClC,CAAC,CAAC;YAEF,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;YAC5B,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;YAC/B,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,KAAK,EAAE,YAAY,EAAE,EAAE;gBAC1C,MAAM,OAAO,CAAC,GAAG,CACf,IAAI,CAAC,+BAA+B,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,UAAkB,EAAE,EAAE;oBAClF,MAAM,UAAU,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;gBAC/C,CAAC,CAAC,CACH,CAAC;YACJ,CAAC,CAAC,CAAC;YACH,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,kBAAkB,CAAC,QAAgB,EAAE,aAAqB;QAC/D,mDAAmD;QACnD,MAAM,UAAU,GAAW,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;QAEhF,IAAI,YAAY,GAA4B,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACnF,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,YAAY,GAAG,IAAI,GAAG,EAAE,CAAC;YACzB,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;QACvD,CAAC;QACD,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAE7B,IAAI,SAAS,GAA4B,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC/E,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,SAAS,GAAG,IAAI,GAAG,EAAE,CAAC;YACtB,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;QACnD,CAAC;QACD,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC1B,CAAC;IAEM,kBAAkB,CAAC,YAAoB;QAC5C,IAAI,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CAAC,IAAI,YAAY,oBAAoB,CAAC,CAAC;QACxD,CAAC;QAED,OAAO,IAAI,CAAC,+BAA+B,CAAC,YAAY,CAAC,CAAC;IAC5D,CAAC;IAEO,+BAA+B,CAAC,YAAoB;;QAC1D,MAAM,gBAAgB,GAAqB,IAAI,CAAC,oBAAoB,CAAC,YAAY,CAAC,CAAC;QACnF,MAAM,eAAe,GAAyB,MAAA,MAAA,IAAI,CAAC,QAAQ,EAAC,wBAAwB,mDAAG,YAAY,CAAC,CAAC;QACrG,OAAO,eAAe,CAAC,CAAC,CAAC,CAAC,GAAG,gBAAgB,EAAE,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IACpG,CAAC;IAEO,KAAK,CAAC,oBAAoB,CAChC,aAA+B,EAC/B,cAAuB;QAEvB,kCAAkC;QAClC,MAAM,SAAS,GAAgB,IAAI,GAAG,EAAE,CAAC;QACzC,KAAK,MAAM,OAAO,IAAI,aAAa,EAAE,CAAC;YACpC,IAAI,cAAc,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC/C,MAAM,IAAI,KAAK,CAAC,IAAI,OAAO,oBAAoB,CAAC,CAAC;YACnD,CAAC;YAED,MAAM,YAAY,GAAW,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;YAC5D,MAAM,YAAY,GAAW,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;YAC5E,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;YACpD,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QAC9B,CAAC;QAED,iFAAiF;QACjF,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE,CAAC;YAC7B,MAAM,SAAS,GAA4B,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAC3E,IAAI,SAAS,EAAE,CAAC;gBACd,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;oBACjC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBAC1B,CAAC;YACH,CAAC;QACH,CAAC;QAED,sEAAsE;QACtE,MAAM,KAAK,CAAC,YAAY,CACtB,SAAS,EACT,KAAK,EAAE,YAAoB,EAAE,EAAE;YAC7B,MAAM,YAAY,GAAuB,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YAC/E,IAAI,CAAC,YAAY,EAAE,CAAC;gBAClB,MAAM,IAAI,KAAK,CAAC,kCAAkC,YAAY,EAAE,CAAC,CAAC;YACpE,CAAC;YACD,MAAM,IAAI,CAAC,iCAAiC,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;QAC3E,CAAC,EACD,EAAE,WAAW,EAAE,EAAE,EAAE,CACpB,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,iCAAiC,CAAC,YAAoB,EAAE,YAAoB;QACxF,uDAAuD;QACvD,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC;QAEtC,IAAI,CAAC;YACH,MAAM,YAAY,GAAkB,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;YAC7F,MAAM,WAAW,GAAuB,MAAM,IAAI,CAAC,QAAQ,CAAC,uBAAuB,CACjF,YAAY,EACZ,YAAY,EACZ,YAAY,CACb,CAAC;YAEF,wFAAwF;YACxF,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;gBAC9B,OAAO;YACT,CAAC;YAED,MAAM,mBAAmB,GAAW;gBAClC,qFAAqF;gBACrF,EAAE;gBACF,WAAW;aACZ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAEZ,MAAM,oBAAoB,GAAqB,IAAI,CAAC,oBAAoB,CAAC,YAAY,CAAC,CAAC;YACvF,KAAK,MAAM,mBAAmB,IAAI,oBAAoB,EAAE,CAAC;gBACvD,MAAM,UAAU,CAAC,cAAc,CAAC,mBAAmB,EAAE,mBAAmB,EAAE;oBACxE,kBAAkB,EAAE,IAAI;oBACxB,kBAAkB,EAAE,WAAW,CAAC,SAAS;iBAC1C,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,QAAQ,CAAC,UAAU,CACtB,2DAA2D,YAAY,MAAM,CAAC,EAAE,CACjF,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;OAEG;IACK,kBAAkB,CAAC,QAAgB;QACzC,MAAM,YAAY,GAA4B,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACrF,IAAI,YAAY,EAAE,CAAC;YACjB,KAAK,MAAM,UAAU,IAAI,YAAY,EAAE,CAAC;gBACtC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,UAAU,CAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAC1D,CAAC;YACD,YAAY,CAAC,KAAK,EAAE,CAAC;QACvB,CAAC;IACH,CAAC;IAEO,CAAC,oBAAoB,CAAC,YAAoB;QAChD,MAAM,EAAE,iBAAiB,EAAE,2BAA2B,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC;QACzE,MAAM,WAAW,GAAW,GAAG,YAAY,OAAO,CAAC;QACnD,MAAM,GAAG,iBAAiB,IAAI,WAAW,EAAE,CAAC;QAC5C,IAAI,2BAA2B,EAAE,CAAC;YAChC,KAAK,MAAM,0BAA0B,IAAI,2BAA2B,EAAE,CAAC;gBACrE,MAAM,GAAG,0BAA0B,IAAI,WAAW,EAAE,CAAC;YACvD,CAAC;QACH,CAAC;IACH,CAAC;IAEO,wBAAwB,CAAC,cAAwB;QACvD,MAAM,MAAM,GAAgB,IAAI,GAAG,EAAE,CAAC;QACtC,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE,CAAC;YAC3C,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBACnC,MAAM,CAAC,GAAG,CAAC,IAAI,aAAa,EAAE,CAAC,CAAC;YAClC,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;YAC5B,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC5B,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport * as path from 'node:path';\nimport { EOL } from 'node:os';\n\nimport glob from 'fast-glob';\nimport * as chokidar from 'chokidar';\n\nimport { type ITerminal, Terminal, ConsoleTerminalProvider } from '@rushstack/terminal';\nimport { FileSystem, Path, NewlineKind, Async } from '@rushstack/node-core-library';\n\n/**\n * @public\n */\nexport interface ITypingsGeneratorBaseOptions {\n  srcFolder: string;\n  generatedTsFolder: string;\n  secondaryGeneratedTsFolders?: string[];\n  globsToIgnore?: string[];\n  terminal?: ITerminal;\n}\n\n/**\n * @public\n */\nexport interface ITypingsGeneratorOptionsWithoutReadFile<\n  TTypingsResult = string | undefined,\n  TFileContents = string\n> extends ITypingsGeneratorBaseOptions {\n  fileExtensions: string[];\n  parseAndGenerateTypings: (\n    fileContents: TFileContents,\n    filePath: string,\n    relativePath: string\n  ) => TTypingsResult | Promise<TTypingsResult>;\n  getAdditionalOutputFiles?: (relativePath: string) => string[];\n}\n\n/**\n * @public\n */\nexport type ReadFile<TFileContents = string> = (\n  filePath: string,\n  relativePath: string\n) => Promise<TFileContents> | TFileContents;\n\n/**\n * @public\n */\nexport interface ITypingsGeneratorOptions<\n  TTypingsResult = string | undefined,\n  TFileContents extends string = string\n> extends ITypingsGeneratorOptionsWithoutReadFile<TTypingsResult, TFileContents> {\n  readFile?: ReadFile<TFileContents>;\n}\n\n/**\n * Options for a TypingsGenerator that needs to customize how files are read.\n *\n * @public\n */\nexport interface ITypingsGeneratorOptionsWithCustomReadFile<\n  TTypingsResult = string | undefined,\n  TFileContents = string\n> extends ITypingsGeneratorOptionsWithoutReadFile<TTypingsResult, TFileContents> {\n  readFile: ReadFile<TFileContents>;\n}\n\n/**\n * This is a simple tool that generates .d.ts files for non-TS files.\n *\n * @public\n */\nexport class TypingsGenerator<TFileContents = string> {\n  // Map of resolved consumer file path -> Set<resolved dependency file path>\n  private readonly _dependenciesOfFile: Map<string, Set<string>>;\n\n  // Map of resolved dependency file path -> Set<resolved consumer file path>\n  private readonly _consumersOfFile: Map<string, Set<string>>;\n\n  // Map of resolved file path -> relative file path\n  private readonly _relativePaths: Map<string, string>;\n\n  protected readonly _options: ITypingsGeneratorOptionsWithCustomReadFile<string | undefined, TFileContents>;\n\n  protected readonly terminal: ITerminal;\n\n  /**\n   * The folder path that contains all input source files.\n   */\n  public readonly sourceFolderPath: string;\n\n  /**\n   * The glob pattern used to find input files to process.\n   */\n  public readonly inputFileGlob: string;\n\n  /**\n   * The glob patterns that should be ignored when finding input files to process.\n   */\n  public readonly ignoredFileGlobs: readonly string[];\n\n  public constructor(\n    options: TFileContents extends string\n      ? ITypingsGeneratorOptions<string | undefined, TFileContents>\n      : never\n  );\n  public constructor(options: ITypingsGeneratorOptionsWithCustomReadFile<string | undefined, TFileContents>);\n  public constructor(options: ITypingsGeneratorOptionsWithCustomReadFile<string | undefined, TFileContents>) {\n    this._options = {\n      ...options,\n      readFile:\n        options.readFile ??\n        ((filePath: string, relativePath: string): Promise<TFileContents> =>\n          FileSystem.readFileAsync(filePath) as Promise<TFileContents>)\n    };\n\n    if (!options.generatedTsFolder) {\n      throw new Error('generatedTsFolder must be provided');\n    }\n\n    if (!options.srcFolder) {\n      throw new Error('srcFolder must be provided');\n    }\n    this.sourceFolderPath = options.srcFolder;\n\n    if (Path.isUnder(options.srcFolder, options.generatedTsFolder)) {\n      throw new Error('srcFolder must not be under generatedTsFolder');\n    }\n\n    if (Path.isUnder(options.generatedTsFolder, options.srcFolder)) {\n      throw new Error('generatedTsFolder must not be under srcFolder');\n    }\n\n    if (!options.fileExtensions || options.fileExtensions.length === 0) {\n      throw new Error('At least one file extension must be provided.');\n    }\n\n    this.ignoredFileGlobs = options.globsToIgnore || [];\n\n    this.terminal = options.terminal ?? new Terminal(new ConsoleTerminalProvider({ verboseEnabled: true }));\n\n    this._options.fileExtensions = this._normalizeFileExtensions(options.fileExtensions);\n\n    this._dependenciesOfFile = new Map();\n    this._consumersOfFile = new Map();\n    this._relativePaths = new Map();\n\n    this.inputFileGlob = `**/*+(${this._options.fileExtensions.join('|')})`;\n  }\n\n  /**\n   * Generate typings for the provided input files.\n   *\n   * @param relativeFilePaths - The input files to process, relative to the source folder. If not provided,\n   * all input files will be processed.\n   */\n  public async generateTypingsAsync(relativeFilePaths?: string[]): Promise<void> {\n    let checkFilePaths: boolean = true;\n    if (!relativeFilePaths?.length) {\n      checkFilePaths = false; // Don't check file paths if we generate them\n      relativeFilePaths = await glob(this.inputFileGlob, {\n        cwd: this.sourceFolderPath,\n        ignore: this.ignoredFileGlobs as string[],\n        onlyFiles: true\n      });\n    }\n\n    await this._reprocessFilesAsync(relativeFilePaths!, checkFilePaths);\n  }\n\n  public async runWatcherAsync(): Promise<void> {\n    await FileSystem.ensureFolderAsync(this._options.generatedTsFolder);\n\n    await new Promise((resolve, reject): void => {\n      const watcher: chokidar.FSWatcher = chokidar.watch(this.inputFileGlob, {\n        cwd: this.sourceFolderPath,\n        ignored: this.ignoredFileGlobs as string[] // `ignored` doesn't like the readonly array\n      });\n\n      const queue: Set<string> = new Set();\n      let timeout: NodeJS.Timeout | undefined;\n      let processing: boolean = false;\n      let flushAfterCompletion: boolean = false;\n\n      const flushInternal: () => void = () => {\n        processing = true;\n\n        const toProcess: string[] = Array.from(queue);\n        queue.clear();\n        this._reprocessFilesAsync(toProcess, false)\n          .then(() => {\n            processing = false;\n            // If the timeout was invoked again, immediately reexecute with the changed files.\n            if (flushAfterCompletion) {\n              flushAfterCompletion = false;\n              flushInternal();\n            }\n          })\n          .catch(reject);\n      };\n\n      const debouncedFlush: () => void = () => {\n        timeout = undefined;\n        if (processing) {\n          // If the callback was invoked while processing is ongoing, indicate that we should flush immediately\n          // upon completion of the current change batch.\n          flushAfterCompletion = true;\n          return;\n        }\n\n        flushInternal();\n      };\n\n      const onChange: (relativePath: string) => void = (relativePath: string) => {\n        queue.add(relativePath);\n        if (timeout) {\n          clearTimeout(timeout);\n        }\n\n        setTimeout(debouncedFlush, 100);\n      };\n\n      watcher.on('add', onChange);\n      watcher.on('change', onChange);\n      watcher.on('unlink', async (relativePath) => {\n        await Promise.all(\n          this._getOutputFilePathsWithoutCheck(relativePath).map(async (outputFile: string) => {\n            await FileSystem.deleteFileAsync(outputFile);\n          })\n        );\n      });\n      watcher.on('error', reject);\n    });\n  }\n\n  /**\n   * Register file dependencies that may effect the typings of a consumer file.\n   * Note: This feature is only useful in watch mode.\n   * The registerDependency method must be called in the body of parseAndGenerateTypings every\n   * time because the registry for a file is cleared at the beginning of processing.\n   */\n  public registerDependency(consumer: string, rawDependency: string): void {\n    // Need to normalize slashes in the dependency path\n    const dependency: string = path.resolve(this._options.srcFolder, rawDependency);\n\n    let dependencies: Set<string> | undefined = this._dependenciesOfFile.get(consumer);\n    if (!dependencies) {\n      dependencies = new Set();\n      this._dependenciesOfFile.set(consumer, dependencies);\n    }\n    dependencies.add(dependency);\n\n    let consumers: Set<string> | undefined = this._consumersOfFile.get(dependency);\n    if (!consumers) {\n      consumers = new Set();\n      this._consumersOfFile.set(dependency, consumers);\n    }\n    consumers.add(consumer);\n  }\n\n  public getOutputFilePaths(relativePath: string): string[] {\n    if (path.isAbsolute(relativePath)) {\n      throw new Error(`\"${relativePath}\" must be relative`);\n    }\n\n    return this._getOutputFilePathsWithoutCheck(relativePath);\n  }\n\n  private _getOutputFilePathsWithoutCheck(relativePath: string): string[] {\n    const typingsFilePaths: Iterable<string> = this._getTypingsFilePaths(relativePath);\n    const additionalPaths: string[] | undefined = this._options.getAdditionalOutputFiles?.(relativePath);\n    return additionalPaths ? [...typingsFilePaths, ...additionalPaths] : Array.from(typingsFilePaths);\n  }\n\n  private async _reprocessFilesAsync(\n    relativePaths: Iterable<string>,\n    checkFilePaths: boolean\n  ): Promise<void> {\n    // Build a queue of resolved paths\n    const toProcess: Set<string> = new Set();\n    for (const rawPath of relativePaths) {\n      if (checkFilePaths && path.isAbsolute(rawPath)) {\n        throw new Error(`\"${rawPath}\" must be relative`);\n      }\n\n      const relativePath: string = Path.convertToSlashes(rawPath);\n      const resolvedPath: string = path.resolve(this._options.srcFolder, rawPath);\n      this._relativePaths.set(resolvedPath, relativePath);\n      toProcess.add(resolvedPath);\n    }\n\n    // Expand out all registered consumers, according to the current dependency graph\n    for (const file of toProcess) {\n      const consumers: Set<string> | undefined = this._consumersOfFile.get(file);\n      if (consumers) {\n        for (const consumer of consumers) {\n          toProcess.add(consumer);\n        }\n      }\n    }\n\n    // Map back to the relative paths so that the information is available\n    await Async.forEachAsync(\n      toProcess,\n      async (resolvedPath: string) => {\n        const relativePath: string | undefined = this._relativePaths.get(resolvedPath);\n        if (!relativePath) {\n          throw new Error(`Missing relative path for file ${resolvedPath}`);\n        }\n        await this._parseFileAndGenerateTypingsAsync(relativePath, resolvedPath);\n      },\n      { concurrency: 20 }\n    );\n  }\n\n  private async _parseFileAndGenerateTypingsAsync(relativePath: string, resolvedPath: string): Promise<void> {\n    // Clear registered dependencies prior to reprocessing.\n    this._clearDependencies(resolvedPath);\n\n    try {\n      const fileContents: TFileContents = await this._options.readFile(resolvedPath, relativePath);\n      const typingsData: string | undefined = await this._options.parseAndGenerateTypings(\n        fileContents,\n        resolvedPath,\n        relativePath\n      );\n\n      // Typings data will be undefined when no types should be generated for the parsed file.\n      if (typingsData === undefined) {\n        return;\n      }\n\n      const prefixedTypingsData: string = [\n        '// This file was generated by a tool. Modifying it will produce unexpected behavior',\n        '',\n        typingsData\n      ].join(EOL);\n\n      const generatedTsFilePaths: Iterable<string> = this._getTypingsFilePaths(relativePath);\n      for (const generatedTsFilePath of generatedTsFilePaths) {\n        await FileSystem.writeFileAsync(generatedTsFilePath, prefixedTypingsData, {\n          ensureFolderExists: true,\n          convertLineEndings: NewlineKind.OsDefault\n        });\n      }\n    } catch (e) {\n      this.terminal.writeError(\n        `Error occurred parsing and generating typings for file \"${resolvedPath}\": ${e}`\n      );\n    }\n  }\n\n  /**\n   * Removes the consumer from all extant dependencies\n   */\n  private _clearDependencies(consumer: string): void {\n    const dependencies: Set<string> | undefined = this._dependenciesOfFile.get(consumer);\n    if (dependencies) {\n      for (const dependency of dependencies) {\n        this._consumersOfFile.get(dependency)!.delete(consumer);\n      }\n      dependencies.clear();\n    }\n  }\n\n  private *_getTypingsFilePaths(relativePath: string): Iterable<string> {\n    const { generatedTsFolder, secondaryGeneratedTsFolders } = this._options;\n    const dtsFilename: string = `${relativePath}.d.ts`;\n    yield `${generatedTsFolder}/${dtsFilename}`;\n    if (secondaryGeneratedTsFolders) {\n      for (const secondaryGeneratedTsFolder of secondaryGeneratedTsFolders) {\n        yield `${secondaryGeneratedTsFolder}/${dtsFilename}`;\n      }\n    }\n  }\n\n  private _normalizeFileExtensions(fileExtensions: string[]): string[] {\n    const result: Set<string> = new Set();\n    for (const fileExtension of fileExtensions) {\n      if (!fileExtension.startsWith('.')) {\n        result.add(`.${fileExtension}`);\n      } else {\n        result.add(fileExtension);\n      }\n    }\n\n    return Array.from(result);\n  }\n}\n"]}

package/lib-esm/index.js

@@ -0,0 +1,12 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+/**
+ * An engine for generating TypeScript .d.ts files that provide type signatures
+ * for non-TypeScript modules such as generated JavaScript or CSS. It can operate
+ * in either a single-run mode or a watch mode.
+ *
+ * @packageDocumentation
+ */
+export { TypingsGenerator } from './TypingsGenerator';
+export { StringValuesTypingsGenerator } from './StringValuesTypingsGenerator';
+//# sourceMappingURL=index.js.map

package/lib-esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D;;;;;;GAMG;AAEH,OAAO,EAML,gBAAgB,EACjB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAOL,4BAA4B,EAC7B,MAAM,gCAAgC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\n/**\n * An engine for generating TypeScript .d.ts files that provide type signatures\n * for non-TypeScript modules such as generated JavaScript or CSS. It can operate\n * in either a single-run mode or a watch mode.\n *\n * @packageDocumentation\n */\n\nexport {\n  type ReadFile,\n  type ITypingsGeneratorBaseOptions,\n  type ITypingsGeneratorOptionsWithoutReadFile,\n  type ITypingsGeneratorOptions,\n  type ITypingsGeneratorOptionsWithCustomReadFile,\n  TypingsGenerator\n} from './TypingsGenerator';\n\nexport {\n  type IStringValueTyping,\n  type IStringValueTypings,\n  type IExportAsDefaultOptions,\n  type IStringValuesTypingsGeneratorBaseOptions,\n  type IStringValuesTypingsGeneratorOptions,\n  type IStringValuesTypingsGeneratorOptionsWithCustomReadFile,\n  StringValuesTypingsGenerator\n} from './StringValuesTypingsGenerator';\n"]}

package/package.json

@@ -1,14 +1,37 @@
 {
   "name": "@rushstack/typings-generator",
-  "version": "0.15.14",
+  "version": "0.16.1",
   "description": "This library provides functionality for automatically generating typings for non-TS files.",
   "keywords": [
     "dts",
     "typings",
     "generate"
   ],
-  "main": "lib/index.js",
-  "typings": "dist/typings-generator.d.ts",
+  "main": "./lib-commonjs/index.js",
+  "module": "./lib-esm/index.js",
+  "types": "./dist/typings-generator.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/typings-generator.d.ts",
+      "node": "./lib-commonjs/index.js",
+      "import": "./lib-esm/index.js",
+      "require": "./lib-commonjs/index.js"
+    },
+    "./lib/*": {
+      "types": "./lib-dts/*.d.ts",
+      "node": "./lib-commonjs/*.js",
+      "import": "./lib-esm/*.js",
+      "require": "./lib-commonjs/*.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "typesVersions": {
+    "*": {
+      "lib/*": [
+        "lib-dts/*"
+      ]
+    }
+  },
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -18,13 +41,13 @@
   "dependencies": {
     "chokidar": "~3.6.0",
     "fast-glob": "~3.3.1",
-    "@rushstack/node-core-library": "5.19.1",
-    "@rushstack/terminal": "0.21.0"
+    "@rushstack/node-core-library": "5.20.1",
+    "@rushstack/terminal": "0.22.1"
   },
   "devDependencies": {
     "eslint": "~9.37.0",
-    "local-node-rig": "1.0.0",
-    "@rushstack/heft": "1.1.14"
+    "@rushstack/heft": "1.2.1",
+    "local-node-rig": "1.0.0"
   },
   "peerDependencies": {
     "@types/node": "*"
@@ -34,6 +57,7 @@
       "optional": true
     }
   },
+  "sideEffects": false,
   "scripts": {
     "build": "heft build --clean",
     "_phase:build": "heft run --only build -- --clean",