@amazon/vinyl-build-utils 1.0.0

package/dist/util/TaskQueue.js

@@ -0,0 +1,55 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * A TaskQueue runs actions in a sequence.
+ */
+export class TaskQueue {
+    /**
+     * Set to handle when a task rejects.
+     */
+    onError = () => { };
+    _running = 0;
+    /**
+     * How many simultaneous tasks may be run at a time.
+     */
+    simultaneous = 1;
+    pending = [];
+    /**
+     * How many tasks are currently running.
+     */
+    get running() {
+        return this._running;
+    }
+    /**
+     * Enqueues the given task, returning a Promise that settles when the task is complete.
+     */
+    enqueue(task) {
+        return new Promise((resolve, reject) => {
+            this.pending.push(() => {
+                this._running++;
+                Promise.resolve(task())
+                    .then(resolve)
+                    .catch((error) => {
+                    reject(error);
+                    this.onError(error);
+                })
+                    .finally(() => {
+                    this._running--;
+                    this.checkQueue();
+                });
+            });
+            this.checkQueue();
+        });
+    }
+    /**
+     * Checks if the queue has any remaining actions and if there is additional capacity to execute.
+     * @private
+     */
+    checkQueue() {
+        if (this.pending.length === 0 || this._running >= this.simultaneous)
+            return;
+        Promise.resolve(this.pending.shift()()).catch(() => { });
+    }
+}

package/dist/util/console.d.ts

@@ -0,0 +1,22 @@
+/**
+ * ANSI escape codes
+ * https://gist.github.com/fnky/458719343aabd01cfb17a3a4f7296797
+ */
+export declare const ansi: {
+    readonly cursorLeft: string;
+    readonly eraseLine: string;
+    readonly cursorUp: (count?: number) => string;
+    readonly cursorDown: (count?: number) => string;
+    readonly eraseLines: (count: number) => string;
+    readonly red: string;
+    readonly green: string;
+    readonly yellow: string;
+    readonly resetColor: string;
+};
+/**
+ * Returns the number of log lines a message will occupy.
+ * @param message
+ */
+export declare function calculateLogLines(message: string): number;
+export declare function progressBar(percent: number, width?: number): string;
+//# sourceMappingURL=console.d.ts.map

package/dist/util/console.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"console.d.ts","sourceRoot":"","sources":["../../src/util/console.ts"],"names":[],"mappings":"AASA;;;GAGG;AACH,eAAO,MAAM,IAAI;;;gCAGK,MAAM,KAAO,MAAM;kCACjB,MAAM,KAAO,MAAM;iCAErB,MAAM,KAAG,MAAM;;;;;CAgB3B,CAAA;AAEV;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAUzD;AAMD,wBAAgB,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,GAAE,MAAW,GAAG,MAAM,CAMvE"}

package/dist/util/console.js

@@ -0,0 +1,58 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import process from 'node:process';
+const ESC = '\x1b[';
+/**
+ * ANSI escape codes
+ * https://gist.github.com/fnky/458719343aabd01cfb17a3a4f7296797
+ */
+export const ansi = {
+    cursorLeft: ESC + 'G',
+    eraseLine: ESC + '2K',
+    cursorUp: (count = 1) => `${ESC}${count}A`,
+    cursorDown: (count = 1) => `${ESC}${count}B`,
+    eraseLines(count) {
+        if (!count)
+            return '';
+        let clear = '';
+        for (let i = 0; i < count; i++) {
+            clear += ansi.eraseLine;
+            if (i < count - 1)
+                clear += ansi.cursorUp();
+        }
+        clear += ansi.cursorLeft;
+        return clear;
+    },
+    // Colors
+    red: ESC + '31m',
+    green: ESC + '32m',
+    yellow: ESC + '33m',
+    resetColor: ESC + '0m',
+};
+/**
+ * Returns the number of log lines a message will occupy.
+ * @param message
+ */
+export function calculateLogLines(message) {
+    const columns = process.stdout.columns;
+    // Split the message by newline characters to handle explicit new lines
+    const lines = message.split('\n');
+    let totalLines = 0;
+    lines.forEach((line) => {
+        // If the line is empty, count the line break.
+        totalLines += Math.ceil(line.length / columns) || 1;
+    });
+    return totalLines;
+}
+const percentFormatter = new Intl.NumberFormat(undefined, {
+    style: 'percent',
+});
+export function progressBar(percent, width = 50) {
+    const percentStr = percentFormatter.format(percent);
+    const n = Math.floor(Math.min(Math.max(percent + 0.001, 0), 1) * width);
+    // Show the angle bracket up until 100%
+    const remainingStr = n < width ? `>${' '.repeat(width - n - 1)}` : '';
+    return `[${'='.repeat(n)}${remainingStr}] ${percentStr}`;
+}

package/dist/util/copyFiles.d.ts

@@ -0,0 +1,33 @@
+export interface CopyFilesOptions {
+    /**
+     * The paths in files will be copied maintaining the relative path from here.
+     */
+    readonly src: string;
+    /**
+     * The destination directory.
+     */
+    readonly dest: string;
+    /**
+     * Function to filter copied files/directories. Return
+     * `true` to copy the item, `false` to ignore it.
+     */
+    readonly filter?: (source: string, destination: string) => boolean;
+    /**
+     * If false, an error will not be thrown if the src does not exist.
+     */
+    readonly required?: boolean;
+    /**
+     * If true, changes to the source will cause the build to repeat.
+     */
+    readonly watch?: boolean;
+    /**
+     * If true, logs debug messages.
+     */
+    readonly debug?: boolean;
+}
+/**
+ * Recursively copies files and directories from one location to another.
+ * Optionally watches matching files for changes.
+ */
+export declare function copyFiles(options: CopyFilesOptions): void;
+//# sourceMappingURL=copyFiles.d.ts.map

package/dist/util/copyFiles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"copyFiles.d.ts","sourceRoot":"","sources":["../../src/util/copyFiles.ts"],"names":[],"mappings":"AASA,MAAM,WAAW,gBAAgB;IAC7B;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IAErB;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,KAAK,OAAO,CAAA;IAElE;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;IAE3B;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAA;IAExB;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAA;CAC3B;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,gBAAgB,QAuClD"}

package/dist/util/copyFiles.js

@@ -0,0 +1,55 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import fs from 'node:fs';
+import path from 'path';
+/**
+ * Recursively copies files and directories from one location to another.
+ * Optionally watches matching files for changes.
+ */
+export function copyFiles(options) {
+    const copyOptions = {
+        preserveTimestamps: true,
+        recursive: true,
+        force: true,
+        errorOnExist: false,
+    };
+    if (options.filter)
+        copyOptions.filter = options.filter;
+    if (fs.existsSync(options.src)) {
+        if (options.debug)
+            console.log(`copy: '${options.src}' to '${options.dest}'`);
+        fs.cpSync(options.src, options.dest, copyOptions);
+    }
+    else {
+        if (options.required !== false) {
+            throw new Error(`copy: source '${options.src}' does not exist`);
+        }
+        return;
+    }
+    if (options.watch) {
+        fs.watch(options.src, { recursive: true }, (_, filename) => {
+            if (filename == null)
+                return;
+            const src = path.join(options.src, filename);
+            const dest = path.join(options.dest, filename);
+            if (!fs.existsSync(src)) {
+                if (fs.existsSync(dest)) {
+                    fs.rmSync(dest, {
+                        recursive: true,
+                    });
+                    if (options.debug)
+                        console.log(`copy: deleted '${options.dest}'`);
+                }
+            }
+            else {
+                if (options.filter && !options.filter(src, dest))
+                    return;
+                if (options.debug)
+                    console.log(`copy: ${src} to '${dest}'`);
+                fs.cpSync(src, dest, copyOptions);
+            }
+        });
+    }
+}

package/dist/util/extractArgs.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Given CLI arguments, extracts properties starting with --, separating args that do not.
+ *
+ * @param argv process args.
+ */
+export declare function extractArgs(argv: readonly string[]): {
+    properties: {
+        [key: string]: string;
+    };
+    args: string[];
+};
+//# sourceMappingURL=extractArgs.d.ts.map

package/dist/util/extractArgs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"extractArgs.d.ts","sourceRoot":"","sources":["../../src/util/extractArgs.ts"],"names":[],"mappings":"AAKA;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,SAAS,MAAM,EAAE,GAAG;IAClD,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IACrC,IAAI,EAAE,MAAM,EAAE,CAAA;CACjB,CAcA"}

package/dist/util/extractArgs.js

@@ -0,0 +1,23 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * Given CLI arguments, extracts properties starting with --, separating args that do not.
+ *
+ * @param argv process args.
+ */
+export function extractArgs(argv) {
+    const properties = {};
+    const args = [];
+    argv.forEach((item) => {
+        if (item.startsWith('--')) {
+            const split = item.substring(2).split('=', 2);
+            properties[split[0]] = split[1] ?? true;
+        }
+        else {
+            args.push(item);
+        }
+    });
+    return { properties, args };
+}

package/dist/util/getRootProjectDir.d.ts

@@ -0,0 +1,2 @@
+export declare function getRootProjectDir(dir?: string): string | null;
+//# sourceMappingURL=getRootProjectDir.d.ts.map

package/dist/util/getRootProjectDir.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getRootProjectDir.d.ts","sourceRoot":"","sources":["../../src/util/getRootProjectDir.ts"],"names":[],"mappings":"AAQA,wBAAgB,iBAAiB,CAAC,GAAG,GAAE,MAAsB,GAAG,MAAM,GAAG,IAAI,CAM5E"}

package/dist/util/getRootProjectDir.js

@@ -0,0 +1,14 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import fs from 'node:fs';
+import path from 'node:path';
+export function getRootProjectDir(dir = process.cwd()) {
+    const packageJsonPath = path.join(dir, 'package.json');
+    const found = fs.existsSync(packageJsonPath) ? dir : null;
+    const parentDir = path.resolve(dir, '..');
+    if (parentDir === dir)
+        return found; // File system root
+    return getRootProjectDir(parentDir) ?? found;
+}

package/dist/util/prompt.d.ts

@@ -0,0 +1,2 @@
+export declare function prompt(question: string): Promise<string>;
+//# sourceMappingURL=prompt.d.ts.map

package/dist/util/prompt.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prompt.d.ts","sourceRoot":"","sources":["../../src/util/prompt.ts"],"names":[],"mappings":"AAOA,wBAAgB,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAYxD"}

package/dist/util/prompt.js

@@ -0,0 +1,15 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import readline from 'readline';
+export function prompt(question) {
+    const rl = readline.createInterface({
+        input: process.stdin,
+        output: process.stdout,
+    });
+    return new Promise((resolve) => rl.question(question, (answer) => {
+        rl.close();
+        resolve(answer.trim());
+    }));
+}

package/dist/util/sleep.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Returns a promise that resolves after a set amount of time.
+ * @param time The number of seconds to sleep.
+ */
+export declare function sleep(time: number): Promise<void>;
+//# sourceMappingURL=sleep.d.ts.map

package/dist/util/sleep.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sleep.d.ts","sourceRoot":"","sources":["../../src/util/sleep.ts"],"names":[],"mappings":"AAKA;;;GAGG;AACH,wBAAgB,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAIjD"}

package/dist/util/sleep.js

@@ -0,0 +1,13 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * Returns a promise that resolves after a set amount of time.
+ * @param time The number of seconds to sleep.
+ */
+export function sleep(time) {
+    return new Promise((resolve) => {
+        setTimeout(resolve, time * 1000);
+    });
+}

package/dist/util/string.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Parses a string with name value pairs into an object.
+ *
+ * For example:
+ * ```
+ * key1=value1
+ * key2=value2
+ * ```
+ *
+ * Becomes
+ *
+ * ```
+ * {
+ *   key1: 'value1'
+ *   key2: 'value2'
+ * }
+ * ```
+ *
+ * @param str
+ */
+export declare function parseKeyValueStr(str: string): Record<string, string>;
+//# sourceMappingURL=string.d.ts.map

package/dist/util/string.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../../src/util/string.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAUpE"}

package/dist/util/string.js

@@ -0,0 +1,35 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * Parses a string with name value pairs into an object.
+ *
+ * For example:
+ * ```
+ * key1=value1
+ * key2=value2
+ * ```
+ *
+ * Becomes
+ *
+ * ```
+ * {
+ *   key1: 'value1'
+ *   key2: 'value2'
+ * }
+ * ```
+ *
+ * @param str
+ */
+export function parseKeyValueStr(str) {
+    const config = {};
+    const lines = str.split('\n');
+    for (const line of lines) {
+        if (line.includes('=')) {
+            const [key, value] = line.split('=', 2);
+            config[key.trim()] = value.trim();
+        }
+    }
+    return config;
+}

package/dist/util/writeIndexFile.d.ts

@@ -0,0 +1,13 @@
+export interface IndexFileOptions {
+    readonly header?: string;
+    readonly footer?: string;
+}
+/**
+ * Generates an index.ts for the given directory.
+ *
+ * @param dir
+ * @param out
+ * @param options Extra configuration, see {@link IndexFileOptions}
+ */
+export declare function writeIndexFile(dir: string, out?: string, options?: IndexFileOptions): void;
+//# sourceMappingURL=writeIndexFile.d.ts.map

package/dist/util/writeIndexFile.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"writeIndexFile.d.ts","sourceRoot":"","sources":["../../src/util/writeIndexFile.ts"],"names":[],"mappings":"AAgBA,MAAM,WAAW,gBAAgB;IAC7B,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAC3B;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAC1B,GAAG,EAAE,MAAM,EACX,GAAG,GAAE,MAAY,EACjB,OAAO,CAAC,EAAE,gBAAgB,QAmF7B"}

package/dist/util/writeIndexFile.js

@@ -0,0 +1,92 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import fs from 'node:fs';
+import { glob } from 'glob';
+import path from 'node:path';
+import { ansi } from './console';
+/**
+ * If --check argument is provided, do not write an index.ts file, check that the existing one
+ * is correct.
+ */
+const verifyMode = process.argv.includes('--check');
+/**
+ * Generates an index.ts for the given directory.
+ *
+ * @param dir
+ * @param out
+ * @param options Extra configuration, see {@link IndexFileOptions}
+ */
+export function writeIndexFile(dir, out = dir, options) {
+    const header = options?.header ?? `/** Auto-generated from build scripts */\n`;
+    let footer = options?.footer ?? '';
+    if (footer && !footer.endsWith('\n'))
+        footer += '\n';
+    const allSrcFiles = glob.sync(`${dir}/**/*.ts`, {
+        ignore: ['**/index.ts', '**/@types/**'],
+    });
+    const relativePaths = allSrcFiles
+        .map((srcFile) => {
+        const importPath = path.relative(out, srcFile);
+        return {
+            importOrExport: hasExports(srcFile)
+                ? 'export * from'
+                : 'import',
+            path: `./${importPath.substring(0, importPath.length - 3)}`,
+        };
+    })
+        .sort();
+    const outFile = path.join(out, 'index.ts');
+    function fail() {
+        console.error(`${ansi.red}${outFile} not valid, run indexFiles:write${ansi.resetColor}`);
+        process.exit(1);
+    }
+    if (verifyMode) {
+        console.log('validating index file:', outFile);
+        if (!fs.existsSync(outFile)) {
+            fail();
+        }
+        else {
+            let contents = fs.readFileSync(outFile, 'utf8');
+            if (contents.substring(0, header.length) !== header ||
+                contents.substring(contents.length - footer.length, contents.length) !== footer)
+                fail();
+            contents = contents.substring(header.length, contents.length - footer.length);
+            const lines = contents
+                .split('\n')
+                .filter((line) => line.startsWith('export') || line.startsWith('import'));
+            if (lines.length !== relativePaths.length)
+                fail();
+            for (let i = 0; i < lines.length; i++) {
+                const { path, importOrExport } = relativePaths[i];
+                if (!lines[i].startsWith(importOrExport) ||
+                    !lines[i].includes(path))
+                    fail();
+            }
+        }
+    }
+    else {
+        // Write the index.ts file
+        let indexStr = header;
+        indexStr +=
+            relativePaths
+                .map(({ importOrExport, path }) => `${importOrExport} '${path}'`)
+                .join('\n') + '\n';
+        if (!fs.existsSync(out)) {
+            fs.mkdirSync(out, { recursive: true });
+        }
+        indexStr += footer;
+        fs.writeFileSync(outFile, indexStr);
+        console.log(`indices written to ${out}`);
+    }
+}
+/**
+ * Checks if the given file has any exports.
+ *
+ * @param path
+ */
+function hasExports(path) {
+    const contents = fs.readFileSync(path, 'utf8');
+    return /(?<!['"`])\bexport\b(?![`'"])/.test(contents);
+}

package/dist/vinyl/buildVinylPackage.d.ts

@@ -0,0 +1,40 @@
+import type { BuildOptions } from 'esbuild';
+import { type ServerOptions } from '../express/serve';
+export interface VinylPackageOptions {
+    /**
+     * Can be set to add additional entry points for bundling.
+     */
+    readonly buildOptions?: BuildOptions[];
+    /**
+     * Options to apply to each esbuild target defined in `buildOptions`.
+     *
+     * Takes precedence over `commonVinylBuildOptions`
+     */
+    readonly commonOptions?: Partial<BuildOptions>;
+    /**
+     * Express server options used when invoked with `--serve`.
+     * Packages that opt into a dev server (e.g. vinyl) supply
+     * their own configuration; if omitted, `--serve` will not start a server.
+     */
+    readonly serverOptions?: ServerOptions;
+}
+/**
+ * CLI args.
+ */
+export declare const vinylBuildCliOptions: {
+    release: boolean;
+    serve: boolean;
+    watch: boolean;
+    debug: boolean;
+};
+/**
+ * Common vinyl library build config.
+ */
+export declare const commonVinylBuildOptions: BuildOptions;
+/**
+ * Builds a vinyl package with inferred configuration.
+ *
+ * @param options
+ */
+export declare function buildVinylPackage(options?: VinylPackageOptions): void;
+//# sourceMappingURL=buildVinylPackage.d.ts.map

package/dist/vinyl/buildVinylPackage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildVinylPackage.d.ts","sourceRoot":"","sources":["../../src/vinyl/buildVinylPackage.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAO3C,OAAO,EAAe,KAAK,aAAa,EAAE,MAAM,kBAAkB,CAAA;AAclE,MAAM,WAAW,mBAAmB;IAChC;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,YAAY,EAAE,CAAA;IAEtC;;;;OAIG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,CAAA;IAE9C;;;;OAIG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,aAAa,CAAA;CACzC;AAQD;;GAEG;AACH,eAAO,MAAM,oBAAoB;;;;;CAKhC,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,uBAAuB,EAAE,YAarC,CAAA;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,CAAC,EAAE,mBAAmB,QA4H9D"}