@lwrjs/tools 0.9.0-alpha.14

package/LICENSE

@@ -0,0 +1,10 @@
+MIT LICENSE
+
+Copyright (c) 2020, Salesforce.com, Inc.
+All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/build/es/index.d.ts

@@ -0,0 +1,2 @@
+export { buildServer } from './server-build.js';
+//# sourceMappingURL=index.d.ts.map

package/build/es/index.js

@@ -0,0 +1,2 @@
+export { buildServer } from './server-build.js';
+//# sourceMappingURL=index.js.map

package/build/es/plugins/build-server-plugin.d.ts

@@ -0,0 +1,18 @@
+import type { Plugin } from 'esbuild';
+import type { LwrGlobalConfig } from '@lwrjs/types';
+/**
+ * Creates an esbuild plugin that generates a server build module
+ *
+ * @remarks
+ * The generated server build module contains:
+ * - normalized lwr global config(without normalized directories and after config hooks are applied)
+ * - runtime environment(after config hooks are applied)
+ * - global data(after config hooks are applied)
+ * - lwr services(ie. module providers) with static imports
+ * - route handlers with static imports
+ *
+ * @param config - programmatic global config
+ * @returns esbuild plugin
+ */
+export default function buildLwrServer(config?: LwrGlobalConfig): Plugin;
+//# sourceMappingURL=build-server-plugin.d.ts.map

package/build/es/plugins/build-server-plugin.js

@@ -0,0 +1,132 @@
+import path from 'path';
+import { loadConfig } from '@lwrjs/config';
+import { normalizeDirectory } from '@lwrjs/shared-utils';
+const services = [
+    'moduleProviders',
+    'assetProviders',
+    'assetTransformers',
+    'viewProviders',
+    'viewTransformers',
+    'resourceProviders',
+];
+function processServices(kind, entries, rootDir) {
+    const output = {
+        imports: [],
+        entries: [],
+    };
+    for (const [index, [entry, config]] of entries.entries()) {
+        const name = kind + index;
+        output.imports.push(`import ${name} from '${normalizeDirectory(entry, rootDir)}';`);
+        output.entries.push([name, config]);
+    }
+    return output;
+}
+function processRoutes(routes, rootDir) {
+    const output = {
+        imports: [],
+        routes: [],
+    };
+    const handlers = {};
+    for (const route of routes) {
+        if (!route.routeHandler) {
+            output.routes.push(route);
+            continue;
+        }
+        const handler = route.routeHandler;
+        if (!handlers[handler]) {
+            const name = `routeHandler${Object.keys(handlers).length}`;
+            handlers[handler] = name;
+            output.imports.push(`import ${name} from '${normalizeDirectory(handler, rootDir)}';`);
+        }
+        output.routes.push({
+            ...route,
+            routeHandler: handlers[handler],
+        });
+    }
+    return output;
+}
+function printServices(config) {
+    return `{${Object.entries(config)
+        .map(([key, value]) => {
+        const entries = value;
+        return `${key}: [${entries.map(([ctor, config = {}]) => `[${ctor}, ${JSON.stringify(config)}]`)}]`;
+    })
+        .join(',')}}`;
+}
+function printRoutes(routes) {
+    return `[${routes
+        .map((route) => {
+        return `{${Object.entries(route)
+            .map(([key, value]) => {
+            if (key !== 'routeHandler') {
+                return `${key}: ${JSON.stringify(value)}`;
+            }
+            return `${key}: ${value}`;
+        })
+            .join(',')}}`;
+    })
+        .join(',')}]`;
+}
+/**
+ * Creates an esbuild plugin that generates a server build module
+ *
+ * @remarks
+ * The generated server build module contains:
+ * - normalized lwr global config(without normalized directories and after config hooks are applied)
+ * - runtime environment(after config hooks are applied)
+ * - global data(after config hooks are applied)
+ * - lwr services(ie. module providers) with static imports
+ * - route handlers with static imports
+ *
+ * @param config - programmatic global config
+ * @returns esbuild plugin
+ */
+export default function buildLwrServer(config) {
+    return {
+        name: 'lwr-server-build',
+        setup(build) {
+            // This file is generated during the build, so it is mapped to a custom namespace
+            // to prevent looking for it on the file system.
+            build.onResolve({ filter: /.*\/lwr.build.js$/ }, (args) => ({
+                path: args.path,
+                namespace: 'lwr-server-build',
+            }));
+            build.onLoad({ filter: /.*/, namespace: 'lwr-server-build' }, async (args) => {
+                const { appConfig, runtimeEnvironment, globalData } = await loadConfig(config, {
+                    skipDirNormalization: true,
+                });
+                const remoteAppConfig = {
+                    ...appConfig,
+                    ignoreLwrConfigFile: true,
+                    rootDir: undefined,
+                    port: undefined,
+                };
+                const serviceImports = [];
+                const serviceConfig = {};
+                for (const service of services) {
+                    const entries = processServices(service, appConfig[service], appConfig.rootDir);
+                    serviceImports.push(...entries.imports);
+                    serviceConfig[service] = entries.entries;
+                }
+                const routesConfig = processRoutes(appConfig.routes, appConfig.rootDir);
+                const errorRoutesConfig = processRoutes(appConfig.errorRoutes, appConfig.rootDir);
+                return {
+                    contents: [
+                        ...serviceImports,
+                        ...routesConfig.imports,
+                        ...errorRoutesConfig.imports,
+                        `export const appConfig = ${JSON.stringify(remoteAppConfig)};`,
+                        `export const runtimeEnvironment = ${JSON.stringify(runtimeEnvironment)};`,
+                        `export const globalData = ${JSON.stringify(globalData)};`,
+                        `export const services = ${printServices(serviceConfig)};`,
+                        `export const routes = ${printRoutes(routesConfig.routes)};`,
+                        `export const errorRoutes = ${printRoutes(errorRoutesConfig.routes)};`,
+                    ].join('\n'),
+                    loader: 'ts',
+                    resolveDir: path.dirname(args.path),
+                };
+            });
+        },
+    };
+}
+//# sourceMappingURL=build-server-plugin.js.map

package/build/es/plugins/generate-entry-plugin.d.ts

@@ -0,0 +1,11 @@
+import type { Plugin } from 'esbuild';
+/**
+ * Creates an esbuild plugin that generates the application entry point
+ *
+ * @remarks
+ * The generated entry point includes a reference to a generated server build module.
+ *
+ * @returns esbuild plugin
+ */
+export default function generateLwrEntry(): Plugin;
+//# sourceMappingURL=generate-entry-plugin.d.ts.map

package/build/es/plugins/generate-entry-plugin.js

@@ -0,0 +1,45 @@
+import path from 'path';
+/**
+ * Creates an esbuild plugin that generates the application entry point
+ *
+ * @remarks
+ * The generated entry point includes a reference to a generated server build module.
+ *
+ * @returns esbuild plugin
+ */
+export default function generateLwrEntry() {
+    return {
+        name: 'lwr-entry',
+        setup(build) {
+            // This file is generated during the build, so it is mapped to a custom namespace
+            // to prevent looking for it on the file system.
+            build.onResolve({ filter: /.*\/lwr.entry.js$/ }, ({ kind, path }) => {
+                if (kind === 'entry-point') {
+                    return {
+                        path,
+                        namespace: 'lwr-entry',
+                    };
+                }
+            });
+            build.onLoad({ filter: /.*/, namespace: 'lwr-entry' }, (args) => ({
+                contents: [
+                    `/* This module is generated */`,
+                    `import { createHandler } from '@lwrjs/lambda';`,
+                    // Importing the server build module at this point enables support for ESM bundling.
+                    // If the server build module was imported in `createHandler`, it would need to be exposed
+                    // as CJS.
+                    `import * as build from './lwr.build.js';`,
+                    // The server build module MUST NOT require asynchronous initialization to support running on MRT
+                    // Once MRT supports ESM, top-level await could be used at this point to perform some asynchronous
+                    // initialization.
+                    `const handler = createHandler(build);`,
+                    // MRT expects the handler to be a named export: `get`
+                    `export { handler as get };`,
+                ].join('\n'),
+                loader: 'ts',
+                resolveDir: path.dirname(args.path),
+            }));
+        },
+    };
+}
+//# sourceMappingURL=generate-entry-plugin.js.map

package/build/es/server-build.d.ts

@@ -0,0 +1,13 @@
+import type { LwrGlobalConfig } from '@lwrjs/types';
+export interface BuildOptions {
+    outputDir?: string;
+}
+/**
+ * Resolve configurations, generate a server build module, and bundle
+ * the LWR server.  The bundled server will be written to the file system.
+ *
+ * @param {LwrGlobalConfig} configArg - programmatic LWR global config
+ * @param {BuildOptions} options - server build options
+ */
+export declare function buildServer(configArg?: LwrGlobalConfig, options?: BuildOptions): Promise<void>;
+//# sourceMappingURL=server-build.d.ts.map

package/build/es/server-build.js

@@ -0,0 +1,76 @@
+import path from 'path';
+import fs from 'fs-extra';
+import esbuild from 'esbuild';
+import { performance } from 'perf_hooks';
+import { getFeatureFlags, logger } from '@lwrjs/shared-utils';
+import { LWR_VERSION } from '@lwrjs/config';
+import generateLwrEntry from './plugins/generate-entry-plugin.js';
+import buildLwrServer from './plugins/build-server-plugin.js';
+async function build(outputDir, config) {
+    // building specifically for MRT/Lambda
+    await esbuild.build({
+        entryPoints: ['./lwr.entry.js'],
+        bundle: true,
+        sourcemap: true,
+        format: 'cjs',
+        platform: 'node',
+        logLevel: 'silent',
+        // Alow us to roll up additional require() dependencies
+        mainFields: ['module', 'main'],
+        external: [
+            // node native dependencies
+            'node:*',
+            // fsevents used by chokidar used by nunjucks
+            'fsevents',
+            // Used for express compression.  Should be an optional dependency ans should be omitted at runtime
+            'iltorb',
+            'shrink-ray-current',
+            // Work in progress to isolate
+            'esbuild*',
+            // Used in the NPM module provider.  Once Static Module Bundler is done we should be able to remove this
+            'esinstall',
+            // Rollup resolves plugins in node_modules at runtime.  More investigation needed.
+            'rollup',
+            'rollup-plugin-*',
+            // We can remove this once we have the module bundler working
+            '@lwrjs/loader',
+        ],
+        banner: {
+            js: createEnvVarHeader(),
+        },
+        plugins: [generateLwrEntry(), buildLwrServer(config)],
+        // MRT expects an entry point named `ssr.js`
+        outfile: path.join(outputDir, 'ssr.js'),
+    });
+}
+/**
+ * Resolve configurations, generate a server build module, and bundle
+ * the LWR server.  The bundled server will be written to the file system.
+ *
+ * @param {LwrGlobalConfig} configArg - programmatic LWR global config
+ * @param {BuildOptions} options - server build options
+ */
+export async function buildServer(configArg, options) {
+    const startTime = performance.now();
+    const outputDir = path.join(configArg?.rootDir || process.cwd(), options?.outputDir || '/build');
+    await fs.ensureDir(outputDir);
+    await build(outputDir, configArg);
+    const endTime = performance.now();
+    const timeDiff = endTime - startTime;
+    logger.info(`[Server Build] successfully built the server in ${Math.round(timeDiff)} ms`);
+}
+/**
+ * Build in important environment variables set during build
+ */
+function createEnvVarHeader() {
+    // Setup global environment variables
+    const currentFeatureFlags = getFeatureFlags();
+    let initFatureFlagsString = '';
+    for (const [key, val] of Object.entries(currentFeatureFlags)) {
+        if (val) {
+            initFatureFlagsString += `process.env.${key} = 'true'`;
+        }
+    }
+    return `globalThis.LWR_VERSION='${LWR_VERSION}';${initFatureFlagsString}`;
+}
+//# sourceMappingURL=server-build.js.map

package/package.json

@@ -0,0 +1,48 @@
+{
+    "name": "@lwrjs/tools",
+    "license": "MIT",
+    "publishConfig": {
+        "access": "public"
+    },
+    "version": "0.9.0-alpha.14",
+    "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/salesforce/lwr.git",
+        "directory": "packages/@lwrjs/tools"
+    },
+    "bugs": {
+        "url": "https://github.com/salesforce/lwr/issues"
+    },
+    "type": "module",
+    "types": "build/es/index.d.ts",
+    "module": "build/es/index.js",
+    "scripts": {
+        "build": "tsc -b"
+    },
+    "exports": {
+        ".": {
+            "import": "./build/es/index.js"
+        }
+    },
+    "files": [
+        "build/**/*.js",
+        "build/**/*.cjs",
+        "build/**/*.d.ts",
+        "package.cjs"
+    ],
+    "dependencies": {
+        "@lwrjs/core": "0.9.0-alpha.14",
+        "esbuild": "^0.17.4"
+    },
+    "devDependencies": {
+        "@lwrjs/types": "0.9.0-alpha.14"
+    },
+    "peerDependencies": {
+        "lwc": "2.x"
+    },
+    "engines": {
+        "node": ">=14.15.4 <19"
+    },
+    "gitHead": "64e0ba617151429da6e09f1a9686628f64183d25"
+}