@amazon/vinyl-build-utils 1.0.0

package/dist/vinyl/buildVinylPackage.js

@@ -0,0 +1,167 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import process from 'node:process';
+import fs from 'node:fs';
+import path from 'node:path';
+import { createRequire } from 'node:module';
+import { vinylDefaultTscOptions } from './vinylDefaultTscOptions';
+import { tscPlugin } from '../esbuild/TypeDeclarationsPlugin';
+import { compatTransformPlugin } from '../esbuild/CompatTransformPlugin';
+import { copyFiles } from '../util/copyFiles';
+import { buildAll } from '../esbuild/buildAll';
+import { pureExportsPlugin } from '../esbuild/PureExportsPlugin';
+import { startServer } from '../express/serve';
+import { logger, LogLevel } from '../util/Logger';
+import { optionalEntryPoints } from '../esbuild/optionalEntryPoints';
+import { getRootProjectDir } from '../util/getRootProjectDir';
+const argv = process.argv;
+const release = argv.includes('--release');
+const serve = argv.includes('--serve');
+const watch = argv.includes('--watch') || serve;
+const debug = argv.includes('--debug');
+/**
+ * CLI args.
+ */
+export const vinylBuildCliOptions = {
+    release,
+    serve,
+    watch,
+    debug,
+};
+/**
+ * Common vinyl library build config.
+ */
+export const commonVinylBuildOptions = {
+    bundle: true,
+    format: 'esm',
+    platform: 'browser',
+    target: 'es2017',
+    minify: false,
+    sourcemap: true,
+    logLevel: debug ? 'debug' : 'info',
+    metafile: true,
+    external: ['@amazon/*'],
+    define: {
+        global: 'globalThis',
+    },
+};
+/**
+ * Builds a vinyl package with inferred configuration.
+ *
+ * @param options
+ */
+export function buildVinylPackage(options) {
+    if (debug)
+        logger.level = LogLevel.DEBUG;
+    const overriddenOptions = options?.commonOptions ?? {};
+    // Merge overridden options, apply commonVinylBuildOptions then options.commonOptions
+    const commonOptions = {
+        ...commonVinylBuildOptions,
+        ...overriddenOptions,
+        define: {
+            ...commonVinylBuildOptions.define,
+            ...overriddenOptions.define,
+        },
+    };
+    const require = createRequire(import.meta.url);
+    const tsc = tscPlugin(vinylDefaultTscOptions);
+    const compat = compatTransformPlugin({
+        enabled: release,
+    });
+    const testEntries = [];
+    const rootDir = getRootProjectDir();
+    // Copy and optionally watch the html assets.
+    const sharedTestResourcesDir = `${rootDir}/testResources`;
+    const testResourcesDir = 'test/jasmine/resources';
+    const testDist = './dist/test';
+    if (fs.existsSync('./test/integ')) {
+        // If this package has integ tests, copy the integ test resources,
+        // from /testResources, test/jasmine/resources (optional), and copy the jasmine wrapper and css
+        copyFiles({
+            src: sharedTestResourcesDir,
+            dest: testDist,
+            required: true,
+            watch,
+            debug,
+            filter: (source) => {
+                if (fs.lstatSync(source).isDirectory()) {
+                    return true;
+                }
+                // If the file is to be overwritten in the project-specific test resources folder, do not copy from the
+                // shared test resources.
+                const relPath = path.relative(sharedTestResourcesDir, source);
+                return !fs.existsSync(path.resolve(testResourcesDir, relPath));
+            },
+        });
+        copyFiles({
+            src: testResourcesDir,
+            dest: testDist,
+            required: false,
+            watch,
+            debug,
+        });
+        // Copy the jasmine css. No need for a watch, imported module doesn't change.
+        copyFiles({
+            src: require.resolve('jasmine-core/lib/jasmine-core/jasmine.css'),
+            dest: './dist/test/jasmine.css',
+            debug,
+        });
+        testEntries.push({
+            stdin: {
+                contents: `import '@amazon/vinyl-jasmine-wrapper'`,
+                resolveDir: process.cwd(),
+                loader: 'ts',
+            },
+            ...commonOptions,
+            external: [],
+            plugins: [compat],
+            outfile: 'dist/test/jasmineHtml.js',
+        });
+    }
+    if (serve || release) {
+        // Check for integ, unit, and benchmark tests
+        testEntries.push({
+            entryPoints: optionalEntryPoints({
+                integ: 'test/integ/index.ts',
+                benchmark: 'test/benchmark/index.ts',
+            }),
+            ...commonOptions,
+            external: [], // Bundle everything together for integ
+            format: 'iife',
+            outdir: 'dist/test/',
+            plugins: [tsc, compat],
+        });
+    }
+    // Build and optionally watch all targets.
+    buildAll([
+        {
+            entryPoints: ['src/index.ts'],
+            ...commonOptions,
+            plugins: [tsc, pureExportsPlugin],
+            outfile: 'dist/index.js',
+        },
+        {
+            entryPoints: ['src/index.ts'],
+            ...commonOptions,
+            format: 'cjs',
+            // No need to run tsc again, esm entry point compiles declarations
+            plugins: [pureExportsPlugin],
+            outfile: 'dist/index.cjs',
+        },
+        ...(options?.buildOptions ?? []),
+        ...testEntries,
+    ], { watch })
+        .then(() => {
+        if (serve) {
+            if (!options?.serverOptions)
+                throw new Error('serverOptions not set');
+            void startServer(options.serverOptions);
+        }
+    })
+        .catch((error) => {
+        console.error('message' in error ? error.message : error);
+        process.exit(1);
+    });
+}

package/dist/vinyl/vinylDefaultBrowserStackOptions.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Defaults for browserstack configuration in Vinyl related projects.
+ */
+export declare const vinylDefaultBrowserStackOptions: {
+    readonly credentials: import("..").BrowserStackCredentials;
+    readonly browsers: readonly import("..").WorkerInitOptions[];
+    readonly server: {
+        readonly http: {
+            readonly port: 9000;
+        };
+        readonly staticDir: "./dist/test";
+        readonly addressInUseAutoIncrement: true;
+    };
+    readonly stopOnFirstFailure: true;
+    readonly workerCommon: {
+        readonly video: true;
+        readonly timeout: number;
+    };
+    readonly worker: {
+        readonly queryParams: {
+            readonly vinylLogLevel: "debug";
+        };
+    };
+};
+//# sourceMappingURL=vinylDefaultBrowserStackOptions.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"vinylDefaultBrowserStackOptions.d.ts","sourceRoot":"","sources":["../../src/vinyl/vinylDefaultBrowserStackOptions.ts"],"names":[],"mappings":"AAWA;;GAEG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;CAkBK,CAAA"}

package/dist/vinyl/vinylDefaultBrowserStackOptions.js

@@ -0,0 +1,28 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { getEnvBrowserStackCredentials, } from '../browserstack/runBrowserStack';
+import { vinylSupportedBrowsers } from './vinylSupportedBrowsers';
+/**
+ * Defaults for browserstack configuration in Vinyl related projects.
+ */
+export const vinylDefaultBrowserStackOptions = {
+    credentials: getEnvBrowserStackCredentials(),
+    browsers: vinylSupportedBrowsers,
+    server: {
+        http: { port: 9000 },
+        staticDir: './dist/test',
+        addressInUseAutoIncrement: true,
+    },
+    stopOnFirstFailure: true,
+    workerCommon: {
+        video: true,
+        timeout: 10 * 60, // 10 minutes
+    },
+    worker: {
+        queryParams: {
+            vinylLogLevel: 'debug',
+        },
+    },
+};

package/dist/vinyl/vinylDefaultTscOptions.d.ts

@@ -0,0 +1,3 @@
+import type { TypeDeclarationOptions } from '../typescript/buildTypeDeclarations';
+export declare const vinylDefaultTscOptions: TypeDeclarationOptions;
+//# sourceMappingURL=vinylDefaultTscOptions.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"vinylDefaultTscOptions.d.ts","sourceRoot":"","sources":["../../src/vinyl/vinylDefaultTscOptions.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAA;AAEjF,eAAO,MAAM,sBAAsB,EAAE,sBAMpC,CAAA"}

package/dist/vinyl/vinylDefaultTscOptions.js

@@ -0,0 +1,11 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export const vinylDefaultTscOptions = {
+    downlevel: {
+        // 4.7 must be included; typescript started supporting 'exports' in package.json at 4.7
+        versions: ['3.7', '4.1', '4.7'],
+        out: '{OUT_DIR}/../ts{VERSION}',
+    },
+};

package/dist/vinyl/vinylSupportedBrowsers.d.ts

@@ -0,0 +1,18 @@
+import type { WorkerInitOptions } from '../browserstack/runBrowserStack';
+/**
+ * Notes:
+ * Firefox for Windows does not accept our root CA on BrowserStack.
+ * Firefox (any OS) does not run in a secure context with localhost.
+ * Firefox for macOS does accept our root CA.
+ * iOS redirects localhost to bs-local.com and must use HTTPS.
+ *
+ * Tests that require a secure context (DRM) are expected to be skipped if one cannot be
+ * established.
+ *
+ * https should be true for browsers that accept our root CA and are not in a secure context when
+ * using localhost.
+ *
+ * @module
+ */
+export declare const vinylSupportedBrowsers: readonly WorkerInitOptions[];
+//# sourceMappingURL=vinylSupportedBrowsers.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"vinylSupportedBrowsers.d.ts","sourceRoot":"","sources":["../../src/vinyl/vinylSupportedBrowsers.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AAExE;;;;;;;;;;;;;;GAcG;AAEH,eAAO,MAAM,sBAAsB,EAAE,SAAS,iBAAiB,EAyCrD,CAAA"}

package/dist/vinyl/vinylSupportedBrowsers.js

@@ -0,0 +1,55 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * Notes:
+ * Firefox for Windows does not accept our root CA on BrowserStack.
+ * Firefox (any OS) does not run in a secure context with localhost.
+ * Firefox for macOS does accept our root CA.
+ * iOS redirects localhost to bs-local.com and must use HTTPS.
+ *
+ * Tests that require a secure context (DRM) are expected to be skipped if one cannot be
+ * established.
+ *
+ * https should be true for browsers that accept our root CA and are not in a secure context when
+ * using localhost.
+ *
+ * @module
+ */
+export const vinylSupportedBrowsers = [
+    {
+        browser: 'chrome',
+        browser_version: 'latest',
+        os: 'OS X',
+        os_version: 'Monterey',
+    },
+    {
+        browser: 'safari',
+        browser_version: 'latest',
+        os: 'OS X',
+        os_version: 'Sonoma',
+    },
+    {
+        browser: 'firefox',
+        browser_version: 'latest',
+        os: 'Windows',
+        os_version: '10',
+    },
+    // Mobile
+    {
+        device: 'Samsung Galaxy S23 Ultra',
+        os: 'android',
+        os_version: '13.0',
+    },
+    {
+        device: 'iPhone 13',
+        os: 'ios',
+        os_version: '17',
+    },
+    {
+        device: 'iPhone 15 Pro Max',
+        os: 'ios',
+        os_version: '17',
+    },
+];

package/package.json

@@ -0,0 +1,52 @@
+{
+    "name": "@amazon/vinyl-build-utils",
+    "version": "1.0.0",
+    "description": "Build utilities and configuration for TypeScript libraries.",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/amazonmusic/vinyl.git"
+    },
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "type": "module",
+    "sideEffects": [
+        "test/**/*"
+    ],
+    "files": [
+        "dist",
+        "jscodeshift",
+        ".prettierrc.json"
+    ],
+    "scripts": {
+        "build": "tsc -p ./src/tsconfig.json",
+        "build:release": "tsc -p ./src/tsconfig.json",
+        "build:watch": "tsc -p ./src/tsconfig.json -w",
+        "clean": "rimraf --glob dist .eslintcache \"**/*.tsbuildinfo\"",
+        "eslint:check": "eslint . --cache --max-warnings=0",
+        "eslint:write": "eslint . --cache --fix",
+        "indexFiles:check": "tsx ./buildScripts/writeIndexFiles.ts --check",
+        "indexFiles:write": "tsx ./buildScripts/writeIndexFiles.ts",
+        "lint": "npm run eslint:check && npm run prettier:check && npm run indexFiles:check",
+        "lint:write": "npm run indexFiles:write && npm run eslint:write && npm run prettier:write",
+        "prettier:check": "prettier . --ignore-path ../../.prettierignore --cache --check",
+        "prettier:write": "prettier . --ignore-path ../../.prettierignore --cache --write",
+        "release": "npm run lint && npm run build:release",
+        "test": "tsx ../../node_modules/jasmine/bin/jasmine --config=test/unit/jasmine.config.json",
+        "test:coverage": "echo \"No tests\"",
+        "validate": "npm run lint"
+    },
+    "author": "",
+    "license": "ISC",
+    "devDependencies": {
+        "@nbilyk/downlevel-dts": "^0.15.2",
+        "@types/babel__core": "^7.20.5",
+        "@types/express": "^5.0.1",
+        "@types/jscodeshift": "^0.12.0",
+        "jscodeshift": "^17.1.2",
+        "magic-string": "^0.30.17"
+    },
+    "dependencies": {
+        "express": "^5.1.0",
+        "http-proxy-middleware": "^3.0.5"
+    }
+}