@lwrjs/tools 0.15.0-alpha.8 → 0.15.0

package/build/cjs/index.cjs

@@ -24,6 +24,7 @@ var __toModule = (module2) => {
 // packages/@lwrjs/tools/src/index.ts
 __markAsModule(exports);
 __export(exports, {
+  REQUEST_SCRIPT_NAME: () => import_server_build.REQUEST_SCRIPT_NAME,
   buildServer: () => import_server_build.buildServer,
   dedupeBundles: () => import_static.dedupeBundles
 });

package/build/cjs/plugins/build-server-plugin.cjs

@@ -108,8 +108,6 @@ function printRouteHandlers(routeHandlers) {
   }).join(",")}}`;
 }
 function buildLwrServer(config, buildDir) {
-  process.env.SINGLE_RENDER_MODE = "true";
-  process.env.REEVALUATE_MODULES = "true";
   return {
     name: "lwr-server-build",
     setup(build) {

package/build/cjs/server-build.cjs

@@ -24,6 +24,7 @@ var __toModule = (module2) => {
 // packages/@lwrjs/tools/src/server-build.ts
 __markAsModule(exports);
 __export(exports, {
+  REQUEST_SCRIPT_NAME: () => REQUEST_SCRIPT_NAME,
   buildServer: () => buildServer
 });
 var import_path = __toModule(require("path"));
@@ -33,10 +34,17 @@ var import_perf_hooks = __toModule(require("perf_hooks"));
 var import_diagnostics = __toModule(require("@lwrjs/diagnostics"));
 var import_shared_utils = __toModule(require("@lwrjs/shared-utils"));
 var import_config = __toModule(require("@lwrjs/config"));
+var import_request_script = __toModule(require("./util/request-script.cjs"));
 var import_generate_entry_plugin = __toModule(require("./plugins/generate-entry-plugin.cjs"));
 var import_build_server_plugin = __toModule(require("./plugins/build-server-plugin.cjs"));
+var REQUEST_SCRIPT_NAME = "index.js";
 async function build(buildOptions, config) {
   const {outputDir, normalizedOutputDir, minify} = buildOptions;
+  const ssrMetaContent = {
+    minLwcVersion: import_config.MIN_LWC_VERSION,
+    minLwrVersion: import_config.MIN_LWR_VERSION
+  };
+  const ssrMetaJsonContent = JSON.stringify(ssrMetaContent);
   await import_esbuild.default.build({
     entryPoints: ["./lwr.entry.js"],
     bundle: true,
@@ -61,10 +69,12 @@ async function build(buildOptions, config) {
     plugins: [(0, import_generate_entry_plugin.default)(), (0, import_build_server_plugin.default)(config, outputDir)],
     outfile: import_path.default.join(normalizedOutputDir, "ssr.js")
   });
+  await import_fs_extra.default.writeFile(import_path.default.join(normalizedOutputDir, REQUEST_SCRIPT_NAME), (0, import_request_script.getMainScriptContent)());
+  await import_fs_extra.default.writeFile(import_path.default.join(normalizedOutputDir, "ssr-meta.json"), ssrMetaJsonContent);
 }
 async function buildServer(configArg, options) {
   const startTime = import_perf_hooks.performance.now();
-  const outputDir = options?.outputDir || "/build";
+  const outputDir = options?.outputDir ?? "/build";
   const normalizedOutputDir = import_path.default.join(configArg?.rootDir || process.cwd(), outputDir);
   await import_fs_extra.default.ensureDir(normalizedOutputDir);
   await build({outputDir, normalizedOutputDir, minify: !!options?.minify}, configArg);

package/build/cjs/util/request-script.cjs

@@ -0,0 +1,223 @@
+var __defProp = Object.defineProperty;
+var __markAsModule = (target) => __defProp(target, "__esModule", {value: true});
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, {get: all[name], enumerable: true});
+};
+
+// packages/@lwrjs/tools/src/util/request-script.ts
+__markAsModule(exports);
+__export(exports, {
+  getMainScriptContent: () => getMainScriptContent
+});
+function getMainScriptContent() {
+  return getEnvironmentSetup() + getHandlerFunction() + getDefaultInput() + getDefaultContext() + getParseArguments() + getPrintHelpMessage() + getUpdateInput() + getMainExecution();
+}
+function getEnvironmentSetup() {
+  return `
+  // Overwrite Envs from SSR.js
+  process.env.LWR_TRACING = process.env.LWR_TRACING ?? 'default';
+  // Suppress TLS checking for now
+  process.env.NODE_TLS_REJECT_UNAUTHORIZED = 0;
+  // Set SSR timeout to 30 seconds (allow override)
+  process.env.SSR_TIMEOUT = process.env.SSR_TIMEOUT ?? 30000;
+  
+  // Lambda Envs (required by pwa-kit runtime)
+  process.env.AWS_LAMBDA_FUNCTION_NAME = 'get';
+  process.env.BUNDLE_ID = '1';
+  process.env.DEPLOY_TARGET = 'set';
+  process.env.EXTERNAL_DOMAIN_NAME = 'mock-domain.example.com';
+  process.env.MOBIFY_PROPERTY_ID = 'set';
+    `;
+}
+function getHandlerFunction() {
+  return `
+  /**
+   * Main handler function to be invoked by Java client.
+   * @param {Object} input - The input object containing JavaScript code.
+   * @returns {Promise<Object>} - The result object with linting results.
+   */
+  async function handler(input) {
+    if (!input) {
+      input = DEFAULT_INPUT;
+    }
+  
+    // Import the SSR module
+    const ssr = require('./ssr.js');
+    return new Promise((resolve, reject) => {
+      ssr.get(input, DEFAULT_CONTEXT, (error, result) => {
+        if (error) {
+          return reject(error);
+        } else {
+          // Check if we wanted to override the artifactPath
+          if (input.artifactPath && result.body) {
+            result.body = result.body.replaceAll(/\\/mobify\\/bundle\\/[a-z0-9]*\\//g, input.artifactPath);
+          }
+          resolve(result);
+        }
+      });
+    });
+  }
+    `;
+}
+function getDefaultInput() {
+  return `
+  // Example Input
+  const DEFAULT_INPUT = {
+    path: '/',
+    httpMethod: 'GET',
+    headers: {
+      host: 'mock-domain.example.com',
+      'user-agent': 'curl/7.64.1',
+    }
+  };
+    `;
+}
+function getDefaultContext() {
+  return `
+  // Define the context object (with basic properties, you can add more as needed)
+  const DEFAULT_CONTEXT = {
+    awsRequestId: 'test-request-id',
+    logGroupName: '/aws/lambda/test',
+    logStreamName: 'test-log-stream',
+    functionName: 'get',
+    functionVersion: '1',
+    invokedFunctionArn: 'arn:aws:lambda:test-region:123456789012:function:test-function',
+    memoryLimitInMB: '128',
+  };
+    `;
+}
+function getParseArguments() {
+  return `
+  // Parse command-line arguments
+  function parseArguments() {
+    const args = process.argv.slice(2);
+    const options = {
+      host: null,
+      proto: null,
+      basePath: null,
+      path: DEFAULT_INPUT.path,
+      output: null,
+    };
+  
+    if (args.includes('--help') || args.includes('-h')) {
+      printHelpMessage();
+      process.exit(0); // Exit after printing help message
+    }
+  
+    args.forEach((arg) => {
+      const [key, value] = arg.split('=');
+      switch (key) {
+        case '--host':
+        case '-H':
+          options.host = value;
+          break;
+        case '--proto':
+        case '-p':
+          options.proto = value;
+          break;
+        case '--basePath':
+        case '-b':
+          options.basePath = value;
+          break;
+        case '--path':
+        case '-P':
+          options.path = value;
+          break;
+        case '--output':
+        case '-o':
+          options.output = value;
+          break;
+        case '--artifactPath':
+        case '-a':
+          options.artifactPath = value;
+          break;
+      }
+    });
+  
+    return options;
+  }
+    `;
+}
+function getPrintHelpMessage() {
+  return `
+  function printHelpMessage() {
+    console.log(
+      'Usage: node index.js [options]\\n' +
+      '\\n' +
+      'Options:\\n' +
+      '  -H, --host=<host>          Specify the host\\n' +
+      '  -p, --proto=<protocol>     Specify the protocol (e.g., http, https)\\n' +
+      '  -b, --basePath=<basePath>  Specify the base path\\n' +
+      '  -P, --path=<path>          Specify the input path (default: ' + DEFAULT_INPUT.path + ')\\n' +
+      '  -o, --output=<output>      Specify the output file path\\n' +
+      '  -a, --artifactPath=<path>  Replace /mobify/bundle/xxx/ with a path provided (e.g. /webruntime/ssr-in-core/)\\n' +
+      '  -h, --help                 Show this help message\\n' +
+      '\\n' +
+      'Example:\\n' +
+      '  node index.js --host=localhost --proto=http --basePath=/api --path=/data --output=result.json\\n' +
+      '  node index.js -H=localhost -p=http -b=/api -P=/data -o=result.json\\n'
+    );
+  }
+    `;
+}
+function getUpdateInput() {
+  return `
+  // Update the DEFAULT_INPUT object based on arguments
+  function updateInput(input, args) {
+    if (args.host) {
+      const proto = args.proto || 'https'; // Default to 'https' if proto is not provided
+      input.headers.forwarded = 'host=' + args.host + ';proto=' + proto;
+    }
+  
+    if (args.basePath !== null) {
+      // Ensure basePath starts with a '/'
+      const normalizedBasePath = args.basePath.startsWith('/') ? args.basePath : '/' + args.basePath;
+      input.headers['x-mobify-request-class'] = 'basePath=' + normalizedBasePath;
+    }
+  
+    if (args.path) {
+      input.path = args.path;
+    }
+
+    if (args.artifactPath) {
+      input.artifactPath = args.artifactPath;
+    }
+  
+    return input;
+  }
+    `;
+}
+function getMainExecution() {
+  return `
+  // Automatically perform a request when this script is executed directly
+  if (require.main === module) {
+    const args = parseArguments();
+    const updatedInput = updateInput(DEFAULT_INPUT, args);
+    handler(updatedInput).then((result) => {
+      const fs = require('fs');
+      const path = require('path');
+  
+      // Write to a file
+      if (args.output) {
+        fs.writeFileSync(args.output, JSON.stringify(result, null, 2), 'utf-8');
+  
+        const outputPath = args.output;
+        const isAbsolutePath = path.isAbsolute(outputPath);
+        const filePath = isAbsolutePath ? outputPath : path.resolve(process.cwd(), outputPath);
+  
+        console.log('\\nRequest Saved: \\x1b[34mfile://' + filePath + '\\x1b[0m');
+      } else {
+        // Print to console
+        console.log(result);
+      }
+      process.exit(0);
+    }).catch(err => {
+      console.error(err);
+      process.exit(1);
+    });
+  }
+  
+  module.exports = handler;
+    `;
+}

package/build/es/index.d.ts

@@ -1,3 +1,3 @@
-export { buildServer } from './server-build.js';
+export { buildServer, REQUEST_SCRIPT_NAME } from './server-build.js';
 export { dedupeBundles } from '@lwrjs/static';
 //# sourceMappingURL=index.d.ts.map

package/build/es/index.js

@@ -1,3 +1,3 @@
-export { buildServer } from './server-build.js';
+export { buildServer, REQUEST_SCRIPT_NAME } from './server-build.js';
 export { dedupeBundles } from '@lwrjs/static';
 //# sourceMappingURL=index.js.map

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

@@ -100,10 +100,6 @@ function printRouteHandlers(routeHandlers) {
  * @returns esbuild plugin
  */
 export default function buildLwrServer(config, buildDir) {
-    // Lambda always runs one request at a time
-    process.env.SINGLE_RENDER_MODE = 'true';
-    // TODO: remove once W-16104831 is resolved
-    process.env.REEVALUATE_MODULES = 'true';
     return {
         name: 'lwr-server-build',
         setup(build) {

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

@@ -4,6 +4,7 @@ export interface BuildOptions {
     normalizedOutputDir?: string;
     minify?: boolean;
 }
+export declare const REQUEST_SCRIPT_NAME = "index.js";
 /**
  * Resolve configurations, generate a server build module, and bundle
  * the LWR server.  The bundled server will be written to the file system.

package/build/es/server-build.js

@@ -4,11 +4,18 @@ import esbuild from 'esbuild';
 import { performance } from 'perf_hooks';
 import { logger } from '@lwrjs/diagnostics';
 import { getFeatureFlags } from '@lwrjs/shared-utils';
-import { LWR_VERSION, LWC_VERSION, PWA_KIT_RUNTIME_VERSION } from '@lwrjs/config';
+import { LWR_VERSION, LWC_VERSION, PWA_KIT_RUNTIME_VERSION, MIN_LWR_VERSION, MIN_LWC_VERSION, } from '@lwrjs/config';
+import { getMainScriptContent } from './util/request-script.js';
 import generateLwrEntry from './plugins/generate-entry-plugin.js';
 import buildLwrServer from './plugins/build-server-plugin.js';
+export const REQUEST_SCRIPT_NAME = 'index.js';
 async function build(buildOptions, config) {
     const { outputDir, normalizedOutputDir, minify } = buildOptions;
+    const ssrMetaContent = {
+        minLwcVersion: MIN_LWC_VERSION,
+        minLwrVersion: MIN_LWR_VERSION,
+    };
+    const ssrMetaJsonContent = JSON.stringify(ssrMetaContent);
     // building specifically for MRT/Lambda
     await esbuild.build({
         entryPoints: ['./lwr.entry.js'],
@@ -41,6 +48,9 @@ async function build(buildOptions, config) {
         // MRT expects an entry point named `ssr.js`
         outfile: path.join(normalizedOutputDir, 'ssr.js'),
     });
+    // Save the request script to the app folder
+    await fs.writeFile(path.join(normalizedOutputDir, REQUEST_SCRIPT_NAME), getMainScriptContent());
+    await fs.writeFile(path.join(normalizedOutputDir, 'ssr-meta.json'), ssrMetaJsonContent);
 }
 /**
  * Resolve configurations, generate a server build module, and bundle
@@ -51,7 +61,7 @@ async function build(buildOptions, config) {
  */
 export async function buildServer(configArg, options) {
     const startTime = performance.now();
-    const outputDir = options?.outputDir || '/build';
+    const outputDir = options?.outputDir ?? '/build';
     const normalizedOutputDir = path.join(configArg?.rootDir || process.cwd(), outputDir);
     await fs.ensureDir(normalizedOutputDir);
     await build({ outputDir, normalizedOutputDir, minify: !!options?.minify }, configArg);

package/build/es/util/request-script.d.ts

@@ -0,0 +1,2 @@
+export declare function getMainScriptContent(): string;
+//# sourceMappingURL=request-script.d.ts.map

package/build/es/util/request-script.js

@@ -0,0 +1,219 @@
+export function getMainScriptContent() {
+    return (getEnvironmentSetup() +
+        getHandlerFunction() +
+        getDefaultInput() +
+        getDefaultContext() +
+        getParseArguments() +
+        getPrintHelpMessage() +
+        getUpdateInput() +
+        getMainExecution());
+}
+function getEnvironmentSetup() {
+    return `
+  // Overwrite Envs from SSR.js
+  process.env.LWR_TRACING = process.env.LWR_TRACING ?? 'default';
+  // Suppress TLS checking for now
+  process.env.NODE_TLS_REJECT_UNAUTHORIZED = 0;
+  // Set SSR timeout to 30 seconds (allow override)
+  process.env.SSR_TIMEOUT = process.env.SSR_TIMEOUT ?? 30000;
+  
+  // Lambda Envs (required by pwa-kit runtime)
+  process.env.AWS_LAMBDA_FUNCTION_NAME = 'get';
+  process.env.BUNDLE_ID = '1';
+  process.env.DEPLOY_TARGET = 'set';
+  process.env.EXTERNAL_DOMAIN_NAME = 'mock-domain.example.com';
+  process.env.MOBIFY_PROPERTY_ID = 'set';
+    `;
+}
+function getHandlerFunction() {
+    return `
+  /**
+   * Main handler function to be invoked by Java client.
+   * @param {Object} input - The input object containing JavaScript code.
+   * @returns {Promise<Object>} - The result object with linting results.
+   */
+  async function handler(input) {
+    if (!input) {
+      input = DEFAULT_INPUT;
+    }
+  
+    // Import the SSR module
+    const ssr = require('./ssr.js');
+    return new Promise((resolve, reject) => {
+      ssr.get(input, DEFAULT_CONTEXT, (error, result) => {
+        if (error) {
+          return reject(error);
+        } else {
+          // Check if we wanted to override the artifactPath
+          if (input.artifactPath && result.body) {
+            result.body = result.body.replaceAll(/\\/mobify\\/bundle\\/[a-z0-9]*\\//g, input.artifactPath);
+          }
+          resolve(result);
+        }
+      });
+    });
+  }
+    `;
+}
+function getDefaultInput() {
+    return `
+  // Example Input
+  const DEFAULT_INPUT = {
+    path: '/',
+    httpMethod: 'GET',
+    headers: {
+      host: 'mock-domain.example.com',
+      'user-agent': 'curl/7.64.1',
+    }
+  };
+    `;
+}
+function getDefaultContext() {
+    return `
+  // Define the context object (with basic properties, you can add more as needed)
+  const DEFAULT_CONTEXT = {
+    awsRequestId: 'test-request-id',
+    logGroupName: '/aws/lambda/test',
+    logStreamName: 'test-log-stream',
+    functionName: 'get',
+    functionVersion: '1',
+    invokedFunctionArn: 'arn:aws:lambda:test-region:123456789012:function:test-function',
+    memoryLimitInMB: '128',
+  };
+    `;
+}
+function getParseArguments() {
+    return `
+  // Parse command-line arguments
+  function parseArguments() {
+    const args = process.argv.slice(2);
+    const options = {
+      host: null,
+      proto: null,
+      basePath: null,
+      path: DEFAULT_INPUT.path,
+      output: null,
+    };
+  
+    if (args.includes('--help') || args.includes('-h')) {
+      printHelpMessage();
+      process.exit(0); // Exit after printing help message
+    }
+  
+    args.forEach((arg) => {
+      const [key, value] = arg.split('=');
+      switch (key) {
+        case '--host':
+        case '-H':
+          options.host = value;
+          break;
+        case '--proto':
+        case '-p':
+          options.proto = value;
+          break;
+        case '--basePath':
+        case '-b':
+          options.basePath = value;
+          break;
+        case '--path':
+        case '-P':
+          options.path = value;
+          break;
+        case '--output':
+        case '-o':
+          options.output = value;
+          break;
+        case '--artifactPath':
+        case '-a':
+          options.artifactPath = value;
+          break;
+      }
+    });
+  
+    return options;
+  }
+    `;
+}
+function getPrintHelpMessage() {
+    return `
+  function printHelpMessage() {
+    console.log(
+      'Usage: node index.js [options]\\n' +
+      '\\n' +
+      'Options:\\n' +
+      '  -H, --host=<host>          Specify the host\\n' +
+      '  -p, --proto=<protocol>     Specify the protocol (e.g., http, https)\\n' +
+      '  -b, --basePath=<basePath>  Specify the base path\\n' +
+      '  -P, --path=<path>          Specify the input path (default: ' + DEFAULT_INPUT.path + ')\\n' +
+      '  -o, --output=<output>      Specify the output file path\\n' +
+      '  -a, --artifactPath=<path>  Replace /mobify/bundle/xxx/ with a path provided (e.g. /webruntime/ssr-in-core/)\\n' +
+      '  -h, --help                 Show this help message\\n' +
+      '\\n' +
+      'Example:\\n' +
+      '  node index.js --host=localhost --proto=http --basePath=/api --path=/data --output=result.json\\n' +
+      '  node index.js -H=localhost -p=http -b=/api -P=/data -o=result.json\\n'
+    );
+  }
+    `;
+}
+function getUpdateInput() {
+    return `
+  // Update the DEFAULT_INPUT object based on arguments
+  function updateInput(input, args) {
+    if (args.host) {
+      const proto = args.proto || 'https'; // Default to 'https' if proto is not provided
+      input.headers.forwarded = 'host=' + args.host + ';proto=' + proto;
+    }
+  
+    if (args.basePath !== null) {
+      // Ensure basePath starts with a '/'
+      const normalizedBasePath = args.basePath.startsWith('/') ? args.basePath : '/' + args.basePath;
+      input.headers['x-mobify-request-class'] = 'basePath=' + normalizedBasePath;
+    }
+  
+    if (args.path) {
+      input.path = args.path;
+    }
+
+    if (args.artifactPath) {
+      input.artifactPath = args.artifactPath;
+    }
+  
+    return input;
+  }
+    `;
+}
+function getMainExecution() {
+    return `
+  // Automatically perform a request when this script is executed directly
+  if (require.main === module) {
+    const args = parseArguments();
+    const updatedInput = updateInput(DEFAULT_INPUT, args);
+    handler(updatedInput).then((result) => {
+      const fs = require('fs');
+      const path = require('path');
+  
+      // Write to a file
+      if (args.output) {
+        fs.writeFileSync(args.output, JSON.stringify(result, null, 2), 'utf-8');
+  
+        const outputPath = args.output;
+        const isAbsolutePath = path.isAbsolute(outputPath);
+        const filePath = isAbsolutePath ? outputPath : path.resolve(process.cwd(), outputPath);
+  
+        console.log('\\nRequest Saved: \\x1b[34mfile://' + filePath + '\\x1b[0m');
+      } else {
+        // Print to console
+        console.log(result);
+      }
+      process.exit(0);
+    }).catch(err => {
+      console.error(err);
+      process.exit(1);
+    });
+  }
+  
+  module.exports = handler;
+    `;
+}
+//# sourceMappingURL=request-script.js.map

package/package.json

@@ -4,7 +4,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.15.0-alpha.8",
+    "version": "0.15.0",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -34,16 +34,16 @@
         "package.cjs"
     ],
     "dependencies": {
-        "@lwrjs/config": "0.15.0-alpha.8",
-        "@lwrjs/core": "0.15.0-alpha.8",
-        "@lwrjs/diagnostics": "0.15.0-alpha.8",
-        "@lwrjs/shared-utils": "0.15.0-alpha.8",
-        "@lwrjs/static": "0.15.0-alpha.8",
+        "@lwrjs/config": "0.15.0",
+        "@lwrjs/core": "0.15.0",
+        "@lwrjs/diagnostics": "0.15.0",
+        "@lwrjs/shared-utils": "0.15.0",
+        "@lwrjs/static": "0.15.0",
         "esbuild": "^0.17.4",
         "fs-extra": "^11.2.0"
     },
     "devDependencies": {
-        "@lwrjs/types": "0.15.0-alpha.8",
+        "@lwrjs/types": "0.15.0",
         "jest": "^26.6.3",
         "ts-jest": "^26.5.6"
     },
@@ -56,5 +56,5 @@
     "volta": {
         "extends": "../../../package.json"
     },
-    "gitHead": "79fa28a99f3d89eca6a254c53a2a944778203ef2"
+    "gitHead": "ee374df435d5342f63e4da126a09461e761837f3"
 }