@forge/cli-shared 9.3.0-next.8 → 9.3.0-next.9

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @forge/cli-shared
 
+## 9.3.0-next.9
+
+### Minor Changes
+
+- a36d70b: Implement manual bundler
+
 ## 9.3.0-next.8
 
 ### Patch Changes

package/out/file-system/archiver.d.ts

@@ -0,0 +1,40 @@
+import { UserError } from '../shared';
+import { Logger } from '../ui';
+export declare abstract class Archiver {
+    abstract addContent(fileName: string, contents: Buffer): void;
+    abstract addFrom(fileName: string, filePath: string): void;
+    abstract finalise(): Promise<string>;
+    addMany(entries: Map<string, string | Buffer>): void;
+}
+export declare class ArchiverError extends UserError {
+}
+export declare class ZipArchiver extends Archiver {
+    private readonly archive;
+    private readonly logger;
+    private tempFile;
+    private resolves;
+    private rejects;
+    private constructor();
+    static create(logger: Logger): Promise<ZipArchiver>;
+    addContent(fileName: string, contents: Buffer): void;
+    addFrom(fileName: string, filePath: string): void;
+    finalise(): Promise<string>;
+    onWarning(cb: (err: Error) => void): void;
+    private onArchiveError;
+    private onClose;
+}
+export declare class DirectoryArchiver extends Archiver {
+    private readonly target;
+    constructor(target: string);
+    addContent(fileName: string, contents: Buffer): void;
+    addFrom(fileName: string, filePath: string): void;
+    finalise(): Promise<string>;
+}
+export declare class MultiArchiver extends Archiver {
+    private readonly archivers;
+    constructor(archivers: Archiver[]);
+    addContent(fileName: string, contents: Buffer): void;
+    addFrom(fileName: string, filePath: string): void;
+    finalise(): Promise<string>;
+}
+//# sourceMappingURL=archiver.d.ts.map

package/out/file-system/archiver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"archiver.d.ts","sourceRoot":"","sources":["../../src/file-system/archiver.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAE/B,8BAAsB,QAAQ;aACZ,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI;aAKpD,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI;aACjD,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC;IAMpC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,GAAG,IAAI;CAS5D;AAED,qBAAa,aAAc,SAAQ,SAAS;CAAG;AA4B/C,qBAAa,WAAY,SAAQ,QAAQ;IAMrC,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,MAAM;IANzB,OAAO,CAAC,QAAQ,CAAqC;IACrD,OAAO,CAAC,QAAQ,CAAsC;IACtD,OAAO,CAAC,OAAO,CAAmC;IAElD,OAAO;WAaa,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAKzD,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI;IAMpD,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI;IAUjD,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC;IAS3B,SAAS,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,KAAK,KAAK,IAAI;IAIzC,OAAO,CAAC,cAAc,CAKpB;IAEF,OAAO,CAAC,OAAO,CAIb;CACH;AAED,qBAAa,iBAAkB,SAAQ,QAAQ;IACjC,OAAO,CAAC,QAAQ,CAAC,MAAM;gBAAN,MAAM,EAAE,MAAM;IAIpC,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI;IAWpD,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI;IAU3C,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC;CAGzC;AAED,qBAAa,aAAc,SAAQ,QAAQ;IAC7B,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,QAAQ,EAAE;IAI3C,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI;IAMpD,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI;IAM3C,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC;CAIzC"}

package/out/file-system/archiver.js

@@ -0,0 +1,148 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MultiArchiver = exports.DirectoryArchiver = exports.ZipArchiver = exports.ArchiverError = exports.Archiver = void 0;
+const tslib_1 = require("tslib");
+const fs_1 = require("fs");
+const path_1 = tslib_1.__importDefault(require("path"));
+const tmp_1 = tslib_1.__importDefault(require("tmp"));
+const shared_1 = require("../shared");
+class Archiver {
+    addMany(entries) {
+        for (const [name, output] of entries) {
+            if (Buffer.isBuffer(output)) {
+                this.addContent(name, output);
+            }
+            else {
+                this.addFrom(name, output);
+            }
+        }
+    }
+}
+exports.Archiver = Archiver;
+class ArchiverError extends shared_1.UserError {
+}
+exports.ArchiverError = ArchiverError;
+const invalidArchivePathMessage = (fileName) => `Invalid archive path "${fileName}"`;
+const archiveContentAddedMessage = (fileName) => `Added archive content "${fileName}"`;
+const archiveFileAddedMessage = (fileName, filePath) => `Added archive file "${fileName}" from "${filePath}"`;
+function validateArchivePath(fileName) {
+    if (!fileName) {
+        return;
+    }
+    const normalizedPath = path_1.default.posix.normalize(fileName.replace(/\\/g, '/'));
+    if (path_1.default.posix.isAbsolute(normalizedPath) || normalizedPath === '..' || normalizedPath.startsWith('../')) {
+        throw new ArchiverError(invalidArchivePathMessage(fileName));
+    }
+}
+class ZipArchiver extends Archiver {
+    archive;
+    logger;
+    tempFile = tmp_1.default.fileSync({ postfix: '.zip' });
+    resolves = [];
+    rejects = [];
+    constructor(archive, logger) {
+        super();
+        this.archive = archive;
+        this.logger = logger;
+        const output = (0, fs_1.createWriteStream)(this.tempFile.name);
+        this.archive.pipe(output);
+        output.on('close', this.onClose);
+        this.archive.on('warning', this.onArchiveError);
+        this.archive.on('error', this.onArchiveError);
+    }
+    static async create(logger) {
+        const { ZipArchive } = await Promise.resolve().then(() => tslib_1.__importStar(require('archiver')));
+        return new ZipArchiver(new ZipArchive(), logger);
+    }
+    addContent(fileName, contents) {
+        validateArchivePath(fileName);
+        this.archive.append(contents, { name: fileName });
+        this.logger.debug(archiveContentAddedMessage(fileName));
+    }
+    addFrom(fileName, filePath) {
+        validateArchivePath(fileName);
+        if ((0, fs_1.statSync)(filePath).isDirectory()) {
+            this.archive.directory(filePath, fileName || false);
+        }
+        else {
+            this.archive.file(filePath, { name: fileName });
+        }
+        this.logger.debug(archiveFileAddedMessage(fileName, filePath));
+    }
+    finalise() {
+        return new Promise((resolve, reject) => {
+            this.resolves.push(resolve);
+            this.rejects.push(reject);
+            this.archive.finalize();
+        });
+    }
+    onWarning(cb) {
+        this.archive.on('warning', cb);
+    }
+    onArchiveError = (err) => {
+        const error = new ArchiverError(err.message);
+        for (const reject of this.rejects) {
+            reject(error);
+        }
+    };
+    onClose = () => {
+        for (const resolve of this.resolves) {
+            resolve(this.tempFile.name);
+        }
+    };
+}
+exports.ZipArchiver = ZipArchiver;
+class DirectoryArchiver extends Archiver {
+    target;
+    constructor(target) {
+        super();
+        this.target = target;
+    }
+    addContent(fileName, contents) {
+        validateArchivePath(fileName);
+        try {
+            const targetName = path_1.default.join(this.target, fileName);
+            (0, fs_1.mkdirSync)(path_1.default.dirname(targetName), { recursive: true });
+            (0, fs_1.writeFileSync)(targetName, contents);
+        }
+        catch (e) {
+            throw new ArchiverError(e.message);
+        }
+    }
+    addFrom(fileName, filePath) {
+        validateArchivePath(fileName);
+        try {
+            const targetName = path_1.default.join(this.target, fileName);
+            (0, fs_1.cpSync)(filePath, targetName, { recursive: true });
+        }
+        catch (e) {
+            throw new ArchiverError(e.message);
+        }
+    }
+    async finalise() {
+        return this.target;
+    }
+}
+exports.DirectoryArchiver = DirectoryArchiver;
+class MultiArchiver extends Archiver {
+    archivers;
+    constructor(archivers) {
+        super();
+        this.archivers = archivers;
+    }
+    addContent(fileName, contents) {
+        for (const archiver of this.archivers) {
+            archiver.addContent(fileName, contents);
+        }
+    }
+    addFrom(fileName, filePath) {
+        for (const archiver of this.archivers) {
+            archiver.addFrom(fileName, filePath);
+        }
+    }
+    async finalise() {
+        const paths = await Promise.all(this.archivers.map((archiver) => archiver.finalise()));
+        return paths[0];
+    }
+}
+exports.MultiArchiver = MultiArchiver;

package/out/file-system/index.d.ts

@@ -1,5 +1,6 @@
 export * from './file-system-reader';
 export * from './file-system-writer';
+export * from './archiver';
 export * from './util';
 export * from './zip-accessor';
 //# sourceMappingURL=index.d.ts.map

package/out/file-system/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/file-system/index.ts"],"names":[],"mappings":"AAEA,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,QAAQ,CAAC;AACvB,cAAc,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/file-system/index.ts"],"names":[],"mappings":"AAEA,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,YAAY,CAAC;AAC3B,cAAc,QAAQ,CAAC;AACvB,cAAc,gBAAgB,CAAC"}

package/out/file-system/index.js

@@ -3,5 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./file-system-reader"), exports);
 tslib_1.__exportStar(require("./file-system-writer"), exports);
+tslib_1.__exportStar(require("./archiver"), exports);
 tslib_1.__exportStar(require("./util"), exports);
 tslib_1.__exportStar(require("./zip-accessor"), exports);

package/out/shared/test.d.ts

@@ -7,9 +7,10 @@ type TestApp = {
         path: string;
     }[];
 };
-export declare function createTestApp({ userCode, userCodeFilename, packages, withI18nBundle }: {
+export declare function createTestApp({ userCode, userCodeFilename, userCodeExtension, packages, withI18nBundle }: {
     userCode: string;
     userCodeFilename?: string;
+    userCodeExtension?: string;
     packages?: string[];
     withI18nBundle?: boolean;
 }): Promise<TestApp>;

package/out/shared/test.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"test.d.ts","sourceRoot":"","sources":["../../src/shared/test.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAG/B,wBAAgB,UAAU,CAAC,YAAY,EAAE,OAAO,EAAE,YAAY,EAAE,OAAO,GAAG,MAAM,CAU/E;AAED,KAAK,OAAO,GAAG;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CAC/C,CAAC;AAEF,wBAAsB,aAAa,CAAC,EAClC,QAAQ,EACR,gBAA0B,EAC1B,QAAQ,EACR,cAAsB,EACvB,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B,GAAG,OAAO,CAAC,OAAO,CAAC,CA8CnB"}
+{"version":3,"file":"test.d.ts","sourceRoot":"","sources":["../../src/shared/test.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAG/B,wBAAgB,UAAU,CAAC,YAAY,EAAE,OAAO,EAAE,YAAY,EAAE,OAAO,GAAG,MAAM,CAU/E;AAED,KAAK,OAAO,GAAG;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CAC/C,CAAC;AAEF,wBAAsB,aAAa,CAAC,EAClC,QAAQ,EACR,gBAA0B,EAC1B,iBAAwB,EACxB,QAAQ,EACR,cAAsB,EACvB,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B,GAAG,OAAO,CAAC,OAAO,CAAC,CA8CnB"}

package/out/shared/test.js

@@ -18,12 +18,12 @@ function mockLogger(traceEnabled, debugEnabled) {
         error: jest.fn()
     };
 }
-async function createTestApp({ userCode, userCodeFilename = 'index', packages, withI18nBundle = false }) {
+async function createTestApp({ userCode, userCodeFilename = 'index', userCodeExtension = 'ts', packages, withI18nBundle = false }) {
     const appDirectory = (0, directories_1.tmpDir)();
     const userCodeDir = path_1.default.join(appDirectory, 'src', path_1.default.dirname(userCodeFilename));
     const userCodeBaseName = path_1.default.basename(userCodeFilename);
     await (0, fs_extra_1.ensureDir)(userCodeDir);
-    const userCodePath = path_1.default.join(userCodeDir, `${userCodeBaseName}.ts`);
+    const userCodePath = path_1.default.join(userCodeDir, `${userCodeBaseName}.${userCodeExtension}`);
     await (0, promises_1.writeFile)(userCodePath, userCode);
     await (0, promises_1.writeFile)(path_1.default.join(appDirectory, 'tsconfig.json'), JSON.stringify({}));
     const allPackages = ['@types/node', 'undici-types', ...(packages ?? [])];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/cli-shared",
-  "version": "9.3.0-next.8",
+  "version": "9.3.0-next.9",
   "description": "Common functionality for Forge CLI",
   "author": "Atlassian",
   "license": "SEE LICENSE IN LICENSE.txt",
@@ -18,6 +18,7 @@
     "@sentry/node": "7.106.0",
     "@vercel/detect-agent": "^1.2.3",
     "adm-zip": "^0.5.10",
+    "archiver": "^8.0.0",
     "array.prototype.flatmap": "^1.3.3",
     "case": "^1.6.3",
     "chalk": "^4.1.2",