@lwrjs/server 0.11.0-alpha.1 → 0.11.0-alpha.10

package/build/cjs/common/abstract-request.cjs

@@ -10,6 +10,18 @@ __markAsModule(exports);
 __export(exports, {
   AbstractMiddlewareRequest: () => AbstractMiddlewareRequest
 });
+function parseForwardedHeader(forwarded) {
+  if (!forwarded)
+    return void 0;
+  const couples = forwarded.toLocaleLowerCase().split(";");
+  const map = couples.reduce((m, c) => {
+    const [key, value] = c.trim().split("=");
+    m[key] = value;
+    return m;
+  }, {});
+  const proto = map.proto ? `${map.proto}://` : "";
+  return map.host ? `${proto}${map.host}` : void 0;
+}
 var AbstractMiddlewareRequest = class {
   constructor(isSiteGenerationRequest) {
     this.isSiteGenerationRequest = isSiteGenerationRequest || false;
@@ -42,8 +54,16 @@ var AbstractMiddlewareRequest = class {
     const supportedEnvironments = config.environment.supported || [];
     return !targetEnvironment || targetEnvironment === defaultEnvironment || supportedEnvironments?.includes(targetEnvironment);
   }
-  getRuntimeContext(defaultRuntimeEnvironment) {
-    const {format, apiVersion, compat, locale, environment, bundleSpecifier} = this.params;
+  getRuntimeContext(defaultRuntimeEnvironment, i18n) {
+    const {
+      format,
+      apiVersion,
+      basePath: basePathParam,
+      compat,
+      locale: localeParam,
+      environment,
+      bundleSpecifier
+    } = this.params;
     const debug = this.query.debug !== void 0;
     const bundle = !!bundleSpecifier;
     const runtimeEnvironment = {
@@ -52,11 +72,24 @@ var AbstractMiddlewareRequest = class {
       compat: compat || defaultRuntimeEnvironment.compat,
       debug: debug || defaultRuntimeEnvironment.debug,
       apiVersion: apiVersion || defaultRuntimeEnvironment.apiVersion,
-      bundle: bundle || defaultRuntimeEnvironment.bundle
+      bundle: bundle || defaultRuntimeEnvironment.bundle,
+      basePath: this.basePath || basePathParam || defaultRuntimeEnvironment.basePath
     };
+    let host = parseForwardedHeader(this.headers?.forwarded) || this.headers?.host || void 0;
+    if (host && !host.startsWith("http")) {
+      host = `${this.protocol}://${host}`;
+    }
+    const basePath = runtimeEnvironment.basePath;
+    const locale = localeParam || this.locale || defaultRuntimeEnvironment.defaultLocale;
+    const uiBasePath = i18n.uriPattern === "path-prefix" && i18n.defaultLocale !== locale ? `${basePath}/${locale}` : `${basePath}`;
+    const assetBasePath = `${runtimeEnvironment.basePath}${runtimeEnvironment.defaultAssetPath}`;
     const runtimeParams = {
-      locale: locale || this.locale || defaultRuntimeEnvironment.defaultLocale,
-      environment
+      basePath,
+      locale,
+      assetBasePath,
+      uiBasePath,
+      environment,
+      host
     };
     return {
       runtimeEnvironment,

package/build/cjs/express/express-request.cjs

@@ -56,6 +56,12 @@ var ExpressRequest = class extends import_abstract_request.AbstractMiddlewareReq
   get protocol() {
     return this.req.protocol;
   }
+  get basePath() {
+    return this.req.basePath || "";
+  }
+  set basePath(bp) {
+    this.req.basePath = bp;
+  }
   get locale() {
     return this.req.locale;
   }

package/build/cjs/express/express-server.cjs

@@ -28,7 +28,6 @@ __export(exports, {
 });
 var import_express = __toModule(require("express"));
 var import_http = __toModule(require("http"));
-var import_compression = __toModule(require("../common/compression.cjs"));
 var import_abstract_internal_app_server = __toModule(require("../common/abstract-internal-app-server.cjs"));
 var import_express_request = __toModule(require("./express-request.cjs"));
 var import_express_response = __toModule(require("./express-response.cjs"));
@@ -85,9 +84,6 @@ var ExpressInternalServer = class extends import_abstract_internal_app_server.de
       await middleware(lwrReq, lwrRes, next);
     });
   }
-  useCompression() {
-    this.expressApp.use((0, import_compression.default)());
-  }
   getRegexWildcard() {
     return "*";
   }

package/build/cjs/fs/fs-server.cjs

@@ -97,8 +97,6 @@ var FsInternalServer = class extends import_abstract_internal_app_server.default
     this.middlewares.push(this.koaRouter.routes());
     this.lwrFsKoaApp.setMiddlewares(this.middlewares);
   }
-  useCompression() {
-  }
   getImpl() {
     return this.lwrFsKoaApp;
   }

package/build/cjs/koa/koa-request.cjs

@@ -56,6 +56,12 @@ var KoaRequest = class extends import_abstract_request.AbstractMiddlewareRequest
   get headers() {
     return this.ctx.headers;
   }
+  get basePath() {
+    return this.ctx.basePath || "";
+  }
+  set basePath(bp) {
+    this.ctx.basePath = bp;
+  }
   get locale() {
     return this.ctx.locale;
   }

package/build/cjs/koa/koa-server.cjs

@@ -29,7 +29,6 @@ __export(exports, {
 var import_koa = __toModule(require("koa"));
 var import_router = __toModule(require("@koa/router"));
 var import_http = __toModule(require("http"));
-var import_koa_compress = __toModule(require("koa-compress"));
 var import_abstract_internal_app_server = __toModule(require("../common/abstract-internal-app-server.cjs"));
 var import_koa_request = __toModule(require("./koa-request.cjs"));
 var import_koa_response = __toModule(require("./koa-response.cjs"));
@@ -78,9 +77,6 @@ var KoaInternalServer = class extends import_abstract_internal_app_server.defaul
       await middleware(lwrReq, lwrRes, next);
     });
   }
-  useCompression() {
-    this.koaApp.use((0, import_koa_compress.default)());
-  }
   getRegexWildcard() {
     return "(.*)";
   }

package/build/es/common/abstract-request.d.ts

@@ -1,4 +1,4 @@
-import type { RuntimeContext, RuntimeEnvironment, Headers, MiddlewareRequest, NormalizedLwrGlobalConfig } from '@lwrjs/types';
+import type { RuntimeContext, RuntimeEnvironment, Headers, MiddlewareRequest, NormalizedLwrGlobalConfig, I18NConfig } from '@lwrjs/types';
 export declare abstract class AbstractMiddlewareRequest implements MiddlewareRequest {
     isSiteGenerationRequest: boolean;
     constructor(isSiteGenerationRequest?: boolean);
@@ -10,6 +10,7 @@ export declare abstract class AbstractMiddlewareRequest implements MiddlewareReq
     abstract params: any;
     abstract query: any;
     abstract locale: string;
+    abstract basePath: string;
     abstract headers: Headers;
     abstract acceptsLanguages(): string[];
     abstract get(field: string): string | undefined;
@@ -19,6 +20,6 @@ export declare abstract class AbstractMiddlewareRequest implements MiddlewareReq
     isJsonRequest(): boolean;
     validateJsonRequest(): boolean;
     validateEnvironmentRequest(config: NormalizedLwrGlobalConfig): boolean;
-    getRuntimeContext(defaultRuntimeEnvironment: RuntimeEnvironment): RuntimeContext;
+    getRuntimeContext(defaultRuntimeEnvironment: RuntimeEnvironment, i18n: I18NConfig): RuntimeContext;
 }
 //# sourceMappingURL=abstract-request.d.ts.map

package/build/es/common/abstract-request.js

@@ -1,3 +1,19 @@
+// See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Forwarded
+function parseForwardedHeader(forwarded) {
+    if (!forwarded)
+        return undefined;
+    // parse the Forwarded header to find the "host" and "proto"
+    // case-insensitive and can contain empty space around the key=value pairs
+    const couples = forwarded.toLocaleLowerCase().split(';');
+    const map = couples.reduce((m, c) => {
+        const [key, value] = c.trim().split('=');
+        m[key] = value;
+        return m;
+    }, {});
+    // build the protocol:host string
+    const proto = map.proto ? `${map.proto}://` : '';
+    return map.host ? `${proto}${map.host}` : undefined;
+}
 export class AbstractMiddlewareRequest {
     constructor(isSiteGenerationRequest) {
         this.isSiteGenerationRequest = isSiteGenerationRequest || false;
@@ -35,8 +51,8 @@ export class AbstractMiddlewareRequest {
             targetEnvironment === defaultEnvironment ||
             supportedEnvironments?.includes(targetEnvironment));
     }
-    getRuntimeContext(defaultRuntimeEnvironment) {
-        const { format, apiVersion, compat, locale, environment, bundleSpecifier } = this.params;
+    getRuntimeContext(defaultRuntimeEnvironment, i18n) {
+        const { format, apiVersion, basePath: basePathParam, compat, locale: localeParam, environment, bundleSpecifier, } = this.params;
         const debug = this.query.debug !== undefined;
         const bundle = !!bundleSpecifier;
         const runtimeEnvironment = {
@@ -47,10 +63,28 @@ export class AbstractMiddlewareRequest {
             debug: debug || defaultRuntimeEnvironment.debug,
             apiVersion: apiVersion || defaultRuntimeEnvironment.apiVersion,
             bundle: bundle || defaultRuntimeEnvironment.bundle,
+            basePath: this.basePath || basePathParam || defaultRuntimeEnvironment.basePath,
         };
+        let host = parseForwardedHeader(this.headers?.forwarded) || this.headers?.host || undefined;
+        if (host && !host.startsWith('http')) {
+            host = `${this.protocol}://${host}`;
+        }
+        const basePath = runtimeEnvironment.basePath;
+        const locale = localeParam || this.locale || defaultRuntimeEnvironment.defaultLocale;
+        // Base path to be used in routing ${basePath}/locale
+        const uiBasePath = i18n.uriPattern === 'path-prefix' && i18n.defaultLocale !== locale
+            ? `${basePath}/${locale}`
+            : `${basePath}`;
+        // Path to static artifacts on MRT the is ${basePath}/mobify/build/${bundleId}
+        // On express this is ${basePath}
+        const assetBasePath = `${runtimeEnvironment.basePath}${runtimeEnvironment.defaultAssetPath}`;
         const runtimeParams = {
-            locale: locale || this.locale || defaultRuntimeEnvironment.defaultLocale,
+            basePath,
+            locale,
+            assetBasePath,
+            uiBasePath,
             environment,
+            host,
         };
         return {
             runtimeEnvironment,

package/build/es/express/express-request.d.ts

@@ -12,6 +12,8 @@ export default class ExpressRequest extends AbstractMiddlewareRequest {
     get method(): string;
     get headers(): Headers;
     get protocol(): any;
+    get basePath(): string;
+    set basePath(bp: string);
     get locale(): string;
     set locale(l: string);
     acceptsLanguages(): string[];

package/build/es/express/express-request.js

@@ -29,6 +29,12 @@ export default class ExpressRequest extends AbstractMiddlewareRequest {
     get protocol() {
         return this.req.protocol;
     }
+    get basePath() {
+        return this.req.basePath || '';
+    }
+    set basePath(bp) {
+        this.req.basePath = bp;
+    }
     get locale() {
         return this.req.locale;
     }

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

@@ -17,7 +17,6 @@ export default class ExpressInternalServer extends AbstractInternalAppServer imp
     all(path: string | Array<string>, middleware: MiddlewareFunction): void;
     get(path: string | Array<string>, middleware: MiddlewareFunction): void;
     post(path: string | Array<string>, middleware: MiddlewareFunction): void;
-    useCompression(): void;
     getRegexWildcard(): string;
     initRoutes(): void;
 }

package/build/es/express/express-server.js

@@ -1,6 +1,5 @@
 import express from 'express';
 import http from 'http';
-import compression from '../common/compression.js';
 import AbstractInternalAppServer from '../common/abstract-internal-app-server.js';
 import ExpressRequest from './express-request.js';
 import ExpressResponse from './express-response.js';
@@ -61,9 +60,6 @@ export default class ExpressInternalServer extends AbstractInternalAppServer {
             await middleware(lwrReq, lwrRes, next);
         });
     }
-    useCompression() {
-        this.expressApp.use(compression());
-    }
     getRegexWildcard() {
         return '*';
     }

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

@@ -26,7 +26,6 @@ export declare class FsInternalServer extends AbstractInternalAppServer implemen
     get(path: string | string[], middleware: MiddlewareFunction): void;
     post(path: string | string[], middleware: MiddlewareFunction): void;
     initRoutes(): void;
-    useCompression(): void;
     getImpl(): LwrFsKoa;
     getRegexWildcard(): string;
 }

package/build/es/fs/fs-server.js

@@ -72,9 +72,6 @@ export class FsInternalServer extends AbstractInternalAppServer {
         this.middlewares.push(this.koaRouter.routes());
         this.lwrFsKoaApp.setMiddlewares(this.middlewares);
     }
-    useCompression() {
-        /* noop */
-    }
     getImpl() {
         return this.lwrFsKoaApp;
     }

package/build/es/koa/koa-request.d.ts

@@ -12,6 +12,8 @@ export default class KoaRequest extends AbstractMiddlewareRequest {
     get body(): any;
     get method(): string;
     get headers(): Headers;
+    get basePath(): string;
+    set basePath(bp: string);
     get locale(): string;
     set locale(l: string);
     acceptsLanguages(): string[];

package/build/es/koa/koa-request.js

@@ -28,6 +28,12 @@ export default class KoaRequest extends AbstractMiddlewareRequest {
     get headers() {
         return this.ctx.headers;
     }
+    get basePath() {
+        return this.ctx.basePath || '';
+    }
+    set basePath(bp) {
+        this.ctx.basePath = bp;
+    }
     get locale() {
         return this.ctx.locale;
     }

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

@@ -17,7 +17,6 @@ export default class KoaInternalServer extends AbstractInternalAppServer impleme
     all(path: string | string[], middleware: MiddlewareFunction): void;
     get(path: string | string[], middleware: MiddlewareFunction): void;
     post(path: string | string[], middleware: MiddlewareFunction): void;
-    useCompression(): void;
     getRegexWildcard(): string;
     initRoutes(): void;
 }

package/build/es/koa/koa-server.js

@@ -1,7 +1,6 @@
 import Koa from 'koa';
 import KoaRouter from '@koa/router';
 import http from 'http';
-import compress from 'koa-compress';
 import AbstractInternalAppServer from '../common/abstract-internal-app-server.js';
 import KoaRequest from './koa-request.js';
 import KoaResponse from './koa-response.js';
@@ -53,9 +52,6 @@ export default class KoaInternalServer extends AbstractInternalAppServer {
             await middleware(lwrReq, lwrRes, next);
         });
     }
-    useCompression() {
-        this.koaApp.use(compress());
-    }
     getRegexWildcard() {
         return '(.*)';
     }

package/package.json

@@ -4,7 +4,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.11.0-alpha.1",
+    "version": "0.11.0-alpha.10",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -34,30 +34,22 @@
         "build/**/*.d.ts"
     ],
     "devDependencies": {
-        "@lwrjs/types": "0.11.0-alpha.1",
+        "@lwrjs/types": "0.11.0-alpha.10",
         "@types/koa-compress": "^4.0.1",
         "@types/koa__router": "^8.0.4",
         "jest-express": "^1.12.0"
     },
     "dependencies": {
         "@koa/router": "^10.0.0",
-        "@lwrjs/shared-utils": "0.11.0-alpha.1",
-        "@types/compression": "^1.7.2",
+        "@lwrjs/shared-utils": "0.11.0-alpha.10",
         "@types/express": "^4.17.17",
         "@types/koa": "^2.11.7",
-        "compression": "^1.7.4",
         "express": "^4.18.2",
         "koa": "^2.13.1",
-        "koa-compose": "^4.1.0",
-        "koa-compress": "^5.0.1"
-    },
-    "optionalDependencies": {
-        "iltorb": "^2.4.5",
-        "node-zopfli-es": "^2.0.1",
-        "shrink-ray-current": "^4.1.3"
+        "koa-compose": "^4.1.0"
     },
     "engines": {
         "node": ">=16.0.0"
     },
-    "gitHead": "6a840d4694fac9f0be5c3a21707015379cbadad7"
+    "gitHead": "34b1e289e8de12531f5624b64512e870157195d4"
 }

package/build/cjs/common/compression.cjs

@@ -1,45 +0,0 @@
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-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});
-};
-var __exportStar = (target, module2, desc) => {
-  if (module2 && typeof module2 === "object" || typeof module2 === "function") {
-    for (let key of __getOwnPropNames(module2))
-      if (!__hasOwnProp.call(target, key) && key !== "default")
-        __defProp(target, key, {get: () => module2[key], enumerable: !(desc = __getOwnPropDesc(module2, key)) || desc.enumerable});
-  }
-  return target;
-};
-var __toModule = (module2) => {
-  return __exportStar(__markAsModule(__defProp(module2 != null ? __create(__getProtoOf(module2)) : {}, "default", module2 && module2.__esModule && "default" in module2 ? {get: () => module2.default, enumerable: true} : {value: module2, enumerable: true})), module2);
-};
-
-// packages/@lwrjs/server/src/common/compression.ts
-__markAsModule(exports);
-__export(exports, {
-  default: () => compression_default
-});
-var import_compression = __toModule(require("compression"));
-var compressionLibToUse;
-var compression = async (req, res, next) => {
-  if (compressionLibToUse === void 0) {
-    try {
-      let shrinkRay = await Promise.resolve().then(() => __toModule(require("shrink-ray-current")));
-      shrinkRay = shrinkRay.default || shrinkRay;
-      compressionLibToUse = shrinkRay({useZopfliForGzip: false});
-    } catch (err) {
-      compressionLibToUse = (0, import_compression.default)();
-    }
-  }
-  compressionLibToUse(req, res, next);
-};
-function compression_default() {
-  return compression;
-}

package/build/es/common/compression.d.ts

@@ -1,3 +0,0 @@
-import type { RequestHandler } from 'express';
-export default function (): RequestHandler;
-//# sourceMappingURL=compression.d.ts.map

package/build/es/common/compression.js

@@ -1,25 +0,0 @@
-import expressCompression from 'compression';
-let compressionLibToUse;
-const compression = async (req, res, next) => {
-    if (compressionLibToUse === undefined) {
-        // TODO: Unfortunately the compression story for express is a mess.
-        // shrink-ray-current is a fork of compression with brotlli support, we will use it until the
-        // "official" one accepts a PR to support it: https://github.com/expressjs/compression/issues/71
-        // Since it has some native dependencies (node-zopfli-es, iltorb) that may fail to compile in
-        // certain environments, we make it an optional dependency and fall back to vanilla compression.
-        try {
-            let shrinkRay = await import('shrink-ray-current');
-            shrinkRay = shrinkRay.default || shrinkRay;
-            compressionLibToUse = shrinkRay({ useZopfliForGzip: false });
-        }
-        catch (err) {
-            compressionLibToUse = expressCompression();
-        }
-    }
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-    compressionLibToUse(req, res, next);
-};
-export default function () {
-    return compression;
-}
-//# sourceMappingURL=compression.js.map