@rushstack/package-extractor 0.12.0 → 0.12.2

package/dist/tsdoc-metadata.json

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

package/lib-commonjs/ArchiveManager.js

@@ -0,0 +1,64 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ArchiveManager = void 0;
+const jszip_1 = __importDefault(require("jszip"));
+const node_core_library_1 = require("@rushstack/node-core-library");
+// 755 are default permissions to allow read/write/execute for owner and read/execute for group and others.
+const DEFAULT_FILE_PERMISSIONS = 0o755;
+// This value sets the allowed permissions when preserving symbolic links.
+// 120000 is the symbolic link identifier, and is OR'd with the default file permissions.
+// See: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/include/uapi/linux/stat.h#n10
+// eslint-disable-next-line no-bitwise
+const SYMBOLIC_LINK_PERMISSIONS = 0o120000 | DEFAULT_FILE_PERMISSIONS;
+class ArchiveManager {
+    constructor() {
+        this._zip = new jszip_1.default();
+    }
+    async addToArchiveAsync(options) {
+        var _a;
+        const { filePath, fileData, archivePath } = options;
+        let data;
+        let permissions;
+        if (filePath) {
+            const stats = (_a = options.stats) !== null && _a !== void 0 ? _a : (await node_core_library_1.FileSystem.getLinkStatisticsAsync(filePath));
+            if (stats.isSymbolicLink()) {
+                data = await node_core_library_1.FileSystem.readLinkAsync(filePath);
+                permissions = SYMBOLIC_LINK_PERMISSIONS;
+            }
+            else if (stats.isDirectory()) {
+                throw new Error('Directories cannot be added to the archive');
+            }
+            else {
+                data = await node_core_library_1.FileSystem.readFileToBufferAsync(filePath);
+                permissions = stats.mode;
+            }
+        }
+        else if (fileData) {
+            data = fileData;
+            permissions = DEFAULT_FILE_PERMISSIONS;
+        }
+        else {
+            throw new Error('Either filePath or fileData must be provided');
+        }
+        // Replace backslashes for Unix compat
+        const addPath = node_core_library_1.Path.convertToSlashes(archivePath);
+        this._zip.file(addPath, data, {
+            unixPermissions: permissions,
+            dir: false
+        });
+    }
+    async createArchiveAsync(archiveFilePath) {
+        const zipContent = await this._zip.generateAsync({
+            type: 'nodebuffer',
+            platform: 'UNIX'
+        });
+        await node_core_library_1.FileSystem.writeFileAsync(archiveFilePath, zipContent);
+    }
+}
+exports.ArchiveManager = ArchiveManager;
+//# sourceMappingURL=ArchiveManager.js.map

package/lib-commonjs/ArchiveManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ArchiveManager.js","sourceRoot":"","sources":["../src/ArchiveManager.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;AAE3D,kDAA0B;AAE1B,oEAAsF;AAEtF,2GAA2G;AAC3G,MAAM,wBAAwB,GAAW,KAAK,CAAC;AAC/C,0EAA0E;AAC1E,yFAAyF;AACzF,6GAA6G;AAC7G,sCAAsC;AACtC,MAAM,yBAAyB,GAAW,QAAQ,GAAG,wBAAwB,CAAC;AAS9E,MAAa,cAAc;IAA3B;QACU,SAAI,GAAU,IAAI,eAAK,EAAE,CAAC;IAwCpC,CAAC;IAtCQ,KAAK,CAAC,iBAAiB,CAAC,OAA6B;;QAC1D,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC;QAEpD,IAAI,IAAqB,CAAC;QAC1B,IAAI,WAAmB,CAAC;QACxB,IAAI,QAAQ,EAAE,CAAC;YACb,MAAM,KAAK,GAAoB,MAAA,OAAO,CAAC,KAAK,mCAAI,CAAC,MAAM,8BAAU,CAAC,sBAAsB,CAAC,QAAQ,CAAC,CAAC,CAAC;YACpG,IAAI,KAAK,CAAC,cAAc,EAAE,EAAE,CAAC;gBAC3B,IAAI,GAAG,MAAM,8BAAU,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;gBAChD,WAAW,GAAG,yBAAyB,CAAC;YAC1C,CAAC;iBAAM,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;gBAC/B,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;YAChE,CAAC;iBAAM,CAAC;gBACN,IAAI,GAAG,MAAM,8BAAU,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;gBACxD,WAAW,GAAG,KAAK,CAAC,IAAI,CAAC;YAC3B,CAAC;QACH,CAAC;aAAM,IAAI,QAAQ,EAAE,CAAC;YACpB,IAAI,GAAG,QAAQ,CAAC;YAChB,WAAW,GAAG,wBAAwB,CAAC;QACzC,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;QAClE,CAAC;QAED,sCAAsC;QACtC,MAAM,OAAO,GAAW,wBAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;QAC3D,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE;YAC5B,eAAe,EAAE,WAAW;YAC5B,GAAG,EAAE,KAAK;SACX,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAAC,eAAuB;QACrD,MAAM,UAAU,GAAW,MAAM,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC;YACvD,IAAI,EAAE,YAAY;YAClB,QAAQ,EAAE,MAAM;SACjB,CAAC,CAAC;QACH,MAAM,8BAAU,CAAC,cAAc,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC;IAC/D,CAAC;CACF;AAzCD,wCAyCC","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 JSZip from 'jszip';\n\nimport { FileSystem, type FileSystemStats, Path } from '@rushstack/node-core-library';\n\n// 755 are default permissions to allow read/write/execute for owner and read/execute for group and others.\nconst DEFAULT_FILE_PERMISSIONS: number = 0o755;\n// This value sets the allowed permissions when preserving symbolic links.\n// 120000 is the symbolic link identifier, and is OR'd with the default file permissions.\n// See: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/include/uapi/linux/stat.h#n10\n// eslint-disable-next-line no-bitwise\nconst SYMBOLIC_LINK_PERMISSIONS: number = 0o120000 | DEFAULT_FILE_PERMISSIONS;\n\nexport interface IAddToArchiveOptions {\n  filePath?: string;\n  fileData?: Buffer | string;\n  archivePath: string;\n  stats?: FileSystemStats;\n}\n\nexport class ArchiveManager {\n  private _zip: JSZip = new JSZip();\n\n  public async addToArchiveAsync(options: IAddToArchiveOptions): Promise<void> {\n    const { filePath, fileData, archivePath } = options;\n\n    let data: Buffer | string;\n    let permissions: number;\n    if (filePath) {\n      const stats: FileSystemStats = options.stats ?? (await FileSystem.getLinkStatisticsAsync(filePath));\n      if (stats.isSymbolicLink()) {\n        data = await FileSystem.readLinkAsync(filePath);\n        permissions = SYMBOLIC_LINK_PERMISSIONS;\n      } else if (stats.isDirectory()) {\n        throw new Error('Directories cannot be added to the archive');\n      } else {\n        data = await FileSystem.readFileToBufferAsync(filePath);\n        permissions = stats.mode;\n      }\n    } else if (fileData) {\n      data = fileData;\n      permissions = DEFAULT_FILE_PERMISSIONS;\n    } else {\n      throw new Error('Either filePath or fileData must be provided');\n    }\n\n    // Replace backslashes for Unix compat\n    const addPath: string = Path.convertToSlashes(archivePath);\n    this._zip.file(addPath, data, {\n      unixPermissions: permissions,\n      dir: false\n    });\n  }\n\n  public async createArchiveAsync(archiveFilePath: string): Promise<void> {\n    const zipContent: Buffer = await this._zip.generateAsync({\n      type: 'nodebuffer',\n      platform: 'UNIX'\n    });\n    await FileSystem.writeFileAsync(archiveFilePath, zipContent);\n  }\n}\n"]}

package/lib-commonjs/AssetHandler.js

@@ -0,0 +1,171 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AssetHandler = void 0;
+const node_path_1 = __importDefault(require("node:path"));
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_core_library_1 = require("@rushstack/node-core-library");
+const ArchiveManager_1 = require("./ArchiveManager");
+const Utils_1 = require("./Utils");
+class AssetHandler {
+    constructor(options) {
+        this._includedAssetPaths = new Set();
+        this._isFinalized = false;
+        const { terminal, sourceRootFolder, targetRootFolder, linkCreation, symlinkAnalyzer, createArchiveFilePath, createArchiveOnly = false } = options;
+        this._terminal = terminal;
+        this._sourceRootFolder = sourceRootFolder;
+        this._targetRootFolder = targetRootFolder;
+        this._symlinkAnalyzer = symlinkAnalyzer;
+        if (createArchiveFilePath) {
+            if (node_path_1.default.extname(createArchiveFilePath) !== '.zip') {
+                throw new Error('Only archives with the .zip file extension are currently supported.');
+            }
+            this._archiveFilePath = node_path_1.default.resolve(targetRootFolder, createArchiveFilePath);
+            this._archiveManager = new ArchiveManager_1.ArchiveManager();
+        }
+        if (createArchiveOnly && !this._archiveManager) {
+            throw new Error('createArchiveOnly cannot be true if createArchiveFilePath is not provided');
+        }
+        this._createArchiveOnly = createArchiveOnly;
+        this._linkCreationMode = linkCreation || 'default';
+    }
+    async includeAssetAsync(options) {
+        const { sourceFileContent, targetFilePath, ignoreIfExisting = false } = options;
+        let { sourceFilePath } = options;
+        if (this._isFinalized) {
+            throw new Error('includeAssetAsync() cannot be called after finalizeAsync()');
+        }
+        if (!sourceFilePath && !sourceFileContent) {
+            if (!node_core_library_1.Path.isUnder(targetFilePath, this._targetRootFolder)) {
+                throw new Error('The existing asset path must be under the target root folder');
+            }
+            sourceFilePath = targetFilePath;
+        }
+        if (sourceFilePath && sourceFileContent) {
+            throw new Error('Either sourceFilePath or sourceFileContent must be provided, but not both');
+        }
+        if (this._includedAssetPaths.has(targetFilePath)) {
+            if (ignoreIfExisting) {
+                return;
+            }
+            throw new Error(`The asset at path "${targetFilePath}" has already been included`);
+        }
+        if (!this._createArchiveOnly) {
+            // Ignore when the source file is the same as the target file, as it's a no-op
+            if (sourceFilePath && sourceFilePath !== targetFilePath) {
+                // Use the fs.copyFile API instead of FileSystem.copyFileAsync() since copyFileAsync performs
+                // a needless stat() call to determine if it's a file or folder, and we already know it's a file.
+                try {
+                    await node_fs_1.default.promises.copyFile(sourceFilePath, targetFilePath, node_fs_1.default.constants.COPYFILE_EXCL);
+                }
+                catch (e) {
+                    if (!node_core_library_1.FileSystem.isNotExistError(e)) {
+                        throw e;
+                    }
+                    // The parent folder may not exist, so ensure it exists before trying to copy again
+                    await node_core_library_1.FileSystem.ensureFolderAsync(node_path_1.default.dirname(targetFilePath));
+                    await node_fs_1.default.promises.copyFile(sourceFilePath, targetFilePath, node_fs_1.default.constants.COPYFILE_EXCL);
+                }
+            }
+            else if (sourceFileContent) {
+                await node_core_library_1.FileSystem.writeFileAsync(targetFilePath, sourceFileContent, {
+                    ensureFolderExists: true
+                });
+            }
+        }
+        if (this._archiveManager) {
+            const targetRelativeFilePath = node_path_1.default.relative(this._targetRootFolder, targetFilePath);
+            if (sourceFilePath) {
+                await this._archiveManager.addToArchiveAsync({
+                    filePath: sourceFilePath,
+                    archivePath: targetRelativeFilePath
+                });
+            }
+            else if (sourceFileContent) {
+                await this._archiveManager.addToArchiveAsync({
+                    fileData: sourceFileContent,
+                    archivePath: targetRelativeFilePath
+                });
+            }
+        }
+        this._includedAssetPaths.add(targetFilePath);
+    }
+    get assetPaths() {
+        return [...this._includedAssetPaths];
+    }
+    async finalizeAsync(options) {
+        const { onAfterExtractSymlinksAsync } = options !== null && options !== void 0 ? options : {};
+        if (this._isFinalized) {
+            throw new Error('finalizeAsync() has already been called');
+        }
+        if (this._linkCreationMode === 'default') {
+            this._terminal.writeLine('Creating symlinks');
+            const linksToCopy = this._symlinkAnalyzer.reportSymlinks();
+            await node_core_library_1.Async.forEachAsync(linksToCopy, async (linkToCopy) => {
+                await this._extractSymlinkAsync(linkToCopy);
+            });
+        }
+        await (onAfterExtractSymlinksAsync === null || onAfterExtractSymlinksAsync === void 0 ? void 0 : onAfterExtractSymlinksAsync());
+        if (this._archiveManager && this._archiveFilePath) {
+            this._terminal.writeLine(`Creating archive at "${this._archiveFilePath}"`);
+            await this._archiveManager.createArchiveAsync(this._archiveFilePath);
+        }
+        this._isFinalized = true;
+    }
+    /**
+     * Create a symlink as described by the ILinkInfo object.
+     */
+    async _extractSymlinkAsync(linkInfo) {
+        const { kind, linkPath, targetPath } = {
+            ...linkInfo,
+            linkPath: (0, Utils_1.remapSourcePathForTargetFolder)({
+                sourceRootFolder: this._sourceRootFolder,
+                targetRootFolder: this._targetRootFolder,
+                sourcePath: linkInfo.linkPath
+            }),
+            targetPath: (0, Utils_1.remapSourcePathForTargetFolder)({
+                sourceRootFolder: this._sourceRootFolder,
+                targetRootFolder: this._targetRootFolder,
+                sourcePath: linkInfo.targetPath
+            })
+        };
+        const newLinkFolder = node_path_1.default.dirname(linkPath);
+        await node_core_library_1.FileSystem.ensureFolderAsync(newLinkFolder);
+        // Link to the relative path for symlinks
+        const relativeTargetPath = node_path_1.default.relative(newLinkFolder, targetPath);
+        // NOTE: This logic is based on NpmLinkManager._createSymlink()
+        if (kind === 'fileLink') {
+            // For files, we use a Windows "hard link", because creating a symbolic link requires
+            // administrator permission. However hard links seem to cause build failures on Mac,
+            // so for all other operating systems we use symbolic links for this case.
+            if (process.platform === 'win32') {
+                await node_core_library_1.FileSystem.createHardLinkAsync({
+                    linkTargetPath: relativeTargetPath,
+                    newLinkPath: linkPath
+                });
+            }
+            else {
+                await node_core_library_1.FileSystem.createSymbolicLinkFileAsync({
+                    linkTargetPath: relativeTargetPath,
+                    newLinkPath: linkPath
+                });
+            }
+        }
+        else {
+            // Junctions are only supported on Windows. This will create a symbolic link on other platforms.
+            await node_core_library_1.FileSystem.createSymbolicLinkJunctionAsync({
+                linkTargetPath: relativeTargetPath,
+                newLinkPath: linkPath
+            });
+        }
+        // Since the created symlinks have the required relative paths, they can be added directly to
+        // the archive.
+        await this.includeAssetAsync({ targetFilePath: linkPath });
+    }
+}
+exports.AssetHandler = AssetHandler;
+//# sourceMappingURL=AssetHandler.js.map

package/lib-commonjs/AssetHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AssetHandler.js","sourceRoot":"","sources":["../src/AssetHandler.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;AAE3D,0DAA6B;AAC7B,sDAAyB;AAEzB,oEAA6F;AAG7F,qDAAkD;AAGlD,mCAAyD;AAkCzD,MAAa,YAAY;IAYvB,YAAmB,OAA6B;QAH/B,wBAAmB,GAAgB,IAAI,GAAG,EAAU,CAAC;QAC9D,iBAAY,GAAY,KAAK,CAAC;QAGpC,MAAM,EACJ,QAAQ,EACR,gBAAgB,EAChB,gBAAgB,EAChB,YAAY,EACZ,eAAe,EACf,qBAAqB,EACrB,iBAAiB,GAAG,KAAK,EAC1B,GAAG,OAAO,CAAC;QACZ,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,iBAAiB,GAAG,gBAAgB,CAAC;QAC1C,IAAI,CAAC,iBAAiB,GAAG,gBAAgB,CAAC;QAC1C,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAC;QACxC,IAAI,qBAAqB,EAAE,CAAC;YAC1B,IAAI,mBAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,KAAK,MAAM,EAAE,CAAC;gBACnD,MAAM,IAAI,KAAK,CAAC,qEAAqE,CAAC,CAAC;YACzF,CAAC;YACD,IAAI,CAAC,gBAAgB,GAAG,mBAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,qBAAqB,CAAC,CAAC;YAC9E,IAAI,CAAC,eAAe,GAAG,IAAI,+BAAc,EAAE,CAAC;QAC9C,CAAC;QACD,IAAI,iBAAiB,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;YAC/C,MAAM,IAAI,KAAK,CAAC,2EAA2E,CAAC,CAAC;QAC/F,CAAC;QACD,IAAI,CAAC,kBAAkB,GAAG,iBAAiB,CAAC;QAC5C,IAAI,CAAC,iBAAiB,GAAG,YAAY,IAAI,SAAS,CAAC;IACrD,CAAC;IAKM,KAAK,CAAC,iBAAiB,CAAC,OAA6B;QAC1D,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,gBAAgB,GAAG,KAAK,EAAE,GAAG,OAAO,CAAC;QAChF,IAAI,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC;QAEjC,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;QAChF,CAAC;QACD,IAAI,CAAC,cAAc,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC1C,IAAI,CAAC,wBAAI,CAAC,OAAO,CAAC,cAAc,EAAE,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC;gBAC1D,MAAM,IAAI,KAAK,CAAC,8DAA8D,CAAC,CAAC;YAClF,CAAC;YACD,cAAc,GAAG,cAAc,CAAC;QAClC,CAAC;QACD,IAAI,cAAc,IAAI,iBAAiB,EAAE,CAAC;YACxC,MAAM,IAAI,KAAK,CAAC,2EAA2E,CAAC,CAAC;QAC/F,CAAC;QACD,IAAI,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,CAAC;YACjD,IAAI,gBAAgB,EAAE,CAAC;gBACrB,OAAO;YACT,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,sBAAsB,cAAc,6BAA6B,CAAC,CAAC;QACrF,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC7B,8EAA8E;YAC9E,IAAI,cAAc,IAAI,cAAc,KAAK,cAAc,EAAE,CAAC;gBACxD,6FAA6F;gBAC7F,iGAAiG;gBACjG,IAAI,CAAC;oBACH,MAAM,iBAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,cAAc,EAAE,cAAc,EAAE,iBAAE,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;gBACzF,CAAC;gBAAC,OAAO,CAAU,EAAE,CAAC;oBACpB,IAAI,CAAC,8BAAU,CAAC,eAAe,CAAC,CAAU,CAAC,EAAE,CAAC;wBAC5C,MAAM,CAAC,CAAC;oBACV,CAAC;oBACD,mFAAmF;oBACnF,MAAM,8BAAU,CAAC,iBAAiB,CAAC,mBAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC;oBACjE,MAAM,iBAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,cAAc,EAAE,cAAc,EAAE,iBAAE,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;gBACzF,CAAC;YACH,CAAC;iBAAM,IAAI,iBAAiB,EAAE,CAAC;gBAC7B,MAAM,8BAAU,CAAC,cAAc,CAAC,cAAc,EAAE,iBAAiB,EAAE;oBACjE,kBAAkB,EAAE,IAAI;iBACzB,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;YACzB,MAAM,sBAAsB,GAAW,mBAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;YAC7F,IAAI,cAAc,EAAE,CAAC;gBACnB,MAAM,IAAI,CAAC,eAAe,CAAC,iBAAiB,CAAC;oBAC3C,QAAQ,EAAE,cAAc;oBACxB,WAAW,EAAE,sBAAsB;iBACpC,CAAC,CAAC;YACL,CAAC;iBAAM,IAAI,iBAAiB,EAAE,CAAC;gBAC7B,MAAM,IAAI,CAAC,eAAe,CAAC,iBAAiB,CAAC;oBAC3C,QAAQ,EAAE,iBAAiB;oBAC3B,WAAW,EAAE,sBAAsB;iBACpC,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IAC/C,CAAC;IAED,IAAW,UAAU;QACnB,OAAO,CAAC,GAAG,IAAI,CAAC,mBAAmB,CAAC,CAAC;IACvC,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,OAA0B;QACnD,MAAM,EAAE,2BAA2B,EAAE,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC;QAEtD,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;QAC7D,CAAC;QAED,IAAI,IAAI,CAAC,iBAAiB,KAAK,SAAS,EAAE,CAAC;YACzC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC;YAC9C,MAAM,WAAW,GAAgB,IAAI,CAAC,gBAAgB,CAAC,cAAc,EAAE,CAAC;YACxE,MAAM,yBAAK,CAAC,YAAY,CAAC,WAAW,EAAE,KAAK,EAAE,UAAqB,EAAE,EAAE;gBACpE,MAAM,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;YAC9C,CAAC,CAAC,CAAC;QACL,CAAC;QAED,MAAM,CAAA,2BAA2B,aAA3B,2BAA2B,uBAA3B,2BAA2B,EAAI,CAAA,CAAC;QAEtC,IAAI,IAAI,CAAC,eAAe,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAClD,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,wBAAwB,IAAI,CAAC,gBAAgB,GAAG,CAAC,CAAC;YAC3E,MAAM,IAAI,CAAC,eAAe,CAAC,kBAAkB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACvE,CAAC;QAED,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;IAC3B,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,oBAAoB,CAAC,QAAmB;QACpD,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG;YACrC,GAAG,QAAQ;YACX,QAAQ,EAAE,IAAA,sCAA8B,EAAC;gBACvC,gBAAgB,EAAE,IAAI,CAAC,iBAAiB;gBACxC,gBAAgB,EAAE,IAAI,CAAC,iBAAiB;gBACxC,UAAU,EAAE,QAAQ,CAAC,QAAQ;aAC9B,CAAC;YACF,UAAU,EAAE,IAAA,sCAA8B,EAAC;gBACzC,gBAAgB,EAAE,IAAI,CAAC,iBAAiB;gBACxC,gBAAgB,EAAE,IAAI,CAAC,iBAAiB;gBACxC,UAAU,EAAE,QAAQ,CAAC,UAAU;aAChC,CAAC;SACH,CAAC;QAEF,MAAM,aAAa,GAAW,mBAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACrD,MAAM,8BAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;QAElD,yCAAyC;QACzC,MAAM,kBAAkB,GAAW,mBAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;QAE5E,+DAA+D;QAC/D,IAAI,IAAI,KAAK,UAAU,EAAE,CAAC;YACxB,qFAAqF;YACrF,oFAAoF;YACpF,0EAA0E;YAC1E,IAAI,OAAO,CAAC,QAAQ,KAAK,OAAO,EAAE,CAAC;gBACjC,MAAM,8BAAU,CAAC,mBAAmB,CAAC;oBACnC,cAAc,EAAE,kBAAkB;oBAClC,WAAW,EAAE,QAAQ;iBACtB,CAAC,CAAC;YACL,CAAC;iBAAM,CAAC;gBACN,MAAM,8BAAU,CAAC,2BAA2B,CAAC;oBAC3C,cAAc,EAAE,kBAAkB;oBAClC,WAAW,EAAE,QAAQ;iBACtB,CAAC,CAAC;YACL,CAAC;QACH,CAAC;aAAM,CAAC;YACN,gGAAgG;YAChG,MAAM,8BAAU,CAAC,+BAA+B,CAAC;gBAC/C,cAAc,EAAE,kBAAkB;gBAClC,WAAW,EAAE,QAAQ;aACtB,CAAC,CAAC;QACL,CAAC;QAED,6FAA6F;QAC7F,eAAe;QACf,MAAM,IAAI,CAAC,iBAAiB,CAAC,EAAE,cAAc,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC7D,CAAC;CACF;AA3LD,oCA2LC","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 path from 'node:path';\nimport fs from 'node:fs';\n\nimport { Async, FileSystem, Path, type FileSystemStats } from '@rushstack/node-core-library';\nimport type { ITerminal } from '@rushstack/terminal';\n\nimport { ArchiveManager } from './ArchiveManager';\nimport type { IExtractorOptions, LinkCreationMode } from './PackageExtractor';\nimport type { ILinkInfo, SymlinkAnalyzer } from './SymlinkAnalyzer';\nimport { remapSourcePathForTargetFolder } from './Utils';\n\nexport interface IIncludeAssetOptions {\n  sourceFilePath?: string;\n  sourceFileStats?: FileSystemStats;\n  sourceFileContent?: string | Buffer;\n  targetFilePath: string;\n  ignoreIfExisting?: boolean;\n}\n\nexport interface IIncludeAssetPathOptions extends IIncludeAssetOptions {\n  sourceFilePath: string;\n  sourceFileContent?: never;\n}\n\nexport interface IIncludeExistingAssetPathOptions extends IIncludeAssetOptions {\n  sourceFilePath?: never;\n  sourceFileContent?: never;\n}\n\nexport interface IIncludeAssetContentOptions extends IIncludeAssetOptions {\n  sourceFileContent: string | Buffer;\n  sourceFilePath?: never;\n  sourceFileStats?: never;\n}\n\nexport interface IAssetHandlerOptions extends IExtractorOptions {\n  symlinkAnalyzer: SymlinkAnalyzer;\n}\n\nexport interface IFinalizeOptions {\n  onAfterExtractSymlinksAsync: () => Promise<void>;\n}\n\nexport class AssetHandler {\n  private readonly _terminal: ITerminal;\n  private readonly _sourceRootFolder: string;\n  private readonly _targetRootFolder: string;\n  private readonly _createArchiveOnly: boolean;\n  private readonly _symlinkAnalyzer: SymlinkAnalyzer;\n  private readonly _archiveManager: ArchiveManager | undefined;\n  private readonly _archiveFilePath: string | undefined;\n  private readonly _linkCreationMode: LinkCreationMode;\n  private readonly _includedAssetPaths: Set<string> = new Set<string>();\n  private _isFinalized: boolean = false;\n\n  public constructor(options: IAssetHandlerOptions) {\n    const {\n      terminal,\n      sourceRootFolder,\n      targetRootFolder,\n      linkCreation,\n      symlinkAnalyzer,\n      createArchiveFilePath,\n      createArchiveOnly = false\n    } = options;\n    this._terminal = terminal;\n    this._sourceRootFolder = sourceRootFolder;\n    this._targetRootFolder = targetRootFolder;\n    this._symlinkAnalyzer = symlinkAnalyzer;\n    if (createArchiveFilePath) {\n      if (path.extname(createArchiveFilePath) !== '.zip') {\n        throw new Error('Only archives with the .zip file extension are currently supported.');\n      }\n      this._archiveFilePath = path.resolve(targetRootFolder, createArchiveFilePath);\n      this._archiveManager = new ArchiveManager();\n    }\n    if (createArchiveOnly && !this._archiveManager) {\n      throw new Error('createArchiveOnly cannot be true if createArchiveFilePath is not provided');\n    }\n    this._createArchiveOnly = createArchiveOnly;\n    this._linkCreationMode = linkCreation || 'default';\n  }\n\n  public async includeAssetAsync(options: IIncludeAssetPathOptions): Promise<void>;\n  public async includeAssetAsync(options: IIncludeExistingAssetPathOptions): Promise<void>;\n  public async includeAssetAsync(options: IIncludeAssetContentOptions): Promise<void>;\n  public async includeAssetAsync(options: IIncludeAssetOptions): Promise<void> {\n    const { sourceFileContent, targetFilePath, ignoreIfExisting = false } = options;\n    let { sourceFilePath } = options;\n\n    if (this._isFinalized) {\n      throw new Error('includeAssetAsync() cannot be called after finalizeAsync()');\n    }\n    if (!sourceFilePath && !sourceFileContent) {\n      if (!Path.isUnder(targetFilePath, this._targetRootFolder)) {\n        throw new Error('The existing asset path must be under the target root folder');\n      }\n      sourceFilePath = targetFilePath;\n    }\n    if (sourceFilePath && sourceFileContent) {\n      throw new Error('Either sourceFilePath or sourceFileContent must be provided, but not both');\n    }\n    if (this._includedAssetPaths.has(targetFilePath)) {\n      if (ignoreIfExisting) {\n        return;\n      }\n      throw new Error(`The asset at path \"${targetFilePath}\" has already been included`);\n    }\n\n    if (!this._createArchiveOnly) {\n      // Ignore when the source file is the same as the target file, as it's a no-op\n      if (sourceFilePath && sourceFilePath !== targetFilePath) {\n        // Use the fs.copyFile API instead of FileSystem.copyFileAsync() since copyFileAsync performs\n        // a needless stat() call to determine if it's a file or folder, and we already know it's a file.\n        try {\n          await fs.promises.copyFile(sourceFilePath, targetFilePath, fs.constants.COPYFILE_EXCL);\n        } catch (e: unknown) {\n          if (!FileSystem.isNotExistError(e as Error)) {\n            throw e;\n          }\n          // The parent folder may not exist, so ensure it exists before trying to copy again\n          await FileSystem.ensureFolderAsync(path.dirname(targetFilePath));\n          await fs.promises.copyFile(sourceFilePath, targetFilePath, fs.constants.COPYFILE_EXCL);\n        }\n      } else if (sourceFileContent) {\n        await FileSystem.writeFileAsync(targetFilePath, sourceFileContent, {\n          ensureFolderExists: true\n        });\n      }\n    }\n\n    if (this._archiveManager) {\n      const targetRelativeFilePath: string = path.relative(this._targetRootFolder, targetFilePath);\n      if (sourceFilePath) {\n        await this._archiveManager.addToArchiveAsync({\n          filePath: sourceFilePath,\n          archivePath: targetRelativeFilePath\n        });\n      } else if (sourceFileContent) {\n        await this._archiveManager.addToArchiveAsync({\n          fileData: sourceFileContent,\n          archivePath: targetRelativeFilePath\n        });\n      }\n    }\n\n    this._includedAssetPaths.add(targetFilePath);\n  }\n\n  public get assetPaths(): string[] {\n    return [...this._includedAssetPaths];\n  }\n\n  public async finalizeAsync(options?: IFinalizeOptions): Promise<void> {\n    const { onAfterExtractSymlinksAsync } = options ?? {};\n\n    if (this._isFinalized) {\n      throw new Error('finalizeAsync() has already been called');\n    }\n\n    if (this._linkCreationMode === 'default') {\n      this._terminal.writeLine('Creating symlinks');\n      const linksToCopy: ILinkInfo[] = this._symlinkAnalyzer.reportSymlinks();\n      await Async.forEachAsync(linksToCopy, async (linkToCopy: ILinkInfo) => {\n        await this._extractSymlinkAsync(linkToCopy);\n      });\n    }\n\n    await onAfterExtractSymlinksAsync?.();\n\n    if (this._archiveManager && this._archiveFilePath) {\n      this._terminal.writeLine(`Creating archive at \"${this._archiveFilePath}\"`);\n      await this._archiveManager.createArchiveAsync(this._archiveFilePath);\n    }\n\n    this._isFinalized = true;\n  }\n\n  /**\n   * Create a symlink as described by the ILinkInfo object.\n   */\n  private async _extractSymlinkAsync(linkInfo: ILinkInfo): Promise<void> {\n    const { kind, linkPath, targetPath } = {\n      ...linkInfo,\n      linkPath: remapSourcePathForTargetFolder({\n        sourceRootFolder: this._sourceRootFolder,\n        targetRootFolder: this._targetRootFolder,\n        sourcePath: linkInfo.linkPath\n      }),\n      targetPath: remapSourcePathForTargetFolder({\n        sourceRootFolder: this._sourceRootFolder,\n        targetRootFolder: this._targetRootFolder,\n        sourcePath: linkInfo.targetPath\n      })\n    };\n\n    const newLinkFolder: string = path.dirname(linkPath);\n    await FileSystem.ensureFolderAsync(newLinkFolder);\n\n    // Link to the relative path for symlinks\n    const relativeTargetPath: string = path.relative(newLinkFolder, targetPath);\n\n    // NOTE: This logic is based on NpmLinkManager._createSymlink()\n    if (kind === 'fileLink') {\n      // For files, we use a Windows \"hard link\", because creating a symbolic link requires\n      // administrator permission. However hard links seem to cause build failures on Mac,\n      // so for all other operating systems we use symbolic links for this case.\n      if (process.platform === 'win32') {\n        await FileSystem.createHardLinkAsync({\n          linkTargetPath: relativeTargetPath,\n          newLinkPath: linkPath\n        });\n      } else {\n        await FileSystem.createSymbolicLinkFileAsync({\n          linkTargetPath: relativeTargetPath,\n          newLinkPath: linkPath\n        });\n      }\n    } else {\n      // Junctions are only supported on Windows. This will create a symbolic link on other platforms.\n      await FileSystem.createSymbolicLinkJunctionAsync({\n        linkTargetPath: relativeTargetPath,\n        newLinkPath: linkPath\n      });\n    }\n\n    // Since the created symlinks have the required relative paths, they can be added directly to\n    // the archive.\n    await this.includeAssetAsync({ targetFilePath: linkPath });\n  }\n}\n"]}