@lwrjs/server 0.6.5 → 0.7.0-alpha.10

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/cjs/common/compression.cjs

@@ -0,0 +1,45 @@
+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/cjs/express/express-request.cjs

@@ -33,6 +33,9 @@ var ExpressRequest = class {
   get method() {
     return this.req.method;
   }
+  get headers() {
+    return this.req.headers;
+  }
   get protocol() {
     return this.req.protocol;
   }
@@ -68,7 +71,7 @@ var ExpressRequest = class {
     return !this.hasJsonParam() || this.req.accepts("json") === "json";
   }
   getRuntimeContext(defaultRuntimeEnvironment) {
-    const {format, apiVersion, compat, locale, environment} = this.req.params;
+    const {format, apiVersion, compat, locale, environment, bundleSpecifier} = this.req.params;
     const {debug} = this.req.query;
     return {
       runtimeEnvironment: {
@@ -76,7 +79,8 @@ var ExpressRequest = class {
         format: format ? format : defaultRuntimeEnvironment.format,
         compat: compat !== void 0 ? compat : defaultRuntimeEnvironment.compat,
         debug: debug !== void 0 ? true : defaultRuntimeEnvironment.debug,
-        apiVersion: apiVersion ? apiVersion : defaultRuntimeEnvironment.apiVersion
+        apiVersion: apiVersion ? apiVersion : defaultRuntimeEnvironment.apiVersion,
+        bundle: bundleSpecifier !== void 0 ? true : false
       },
       runtimeParams: {
         locale: locale ? locale : this.req.locale ? this.req.locale : defaultRuntimeEnvironment.defaultLocale,

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

@@ -29,7 +29,7 @@ __export(exports, {
 var import_express = __toModule(require("express"));
 var import_spdy = __toModule(require("spdy"));
 var import_http = __toModule(require("http"));
-var import_shrink_ray_current = __toModule(require("shrink-ray-current"));
+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"));
@@ -91,7 +91,7 @@ var ExpressInternalServer = class extends import_abstract_internal_app_server.de
     });
   }
   useCompression() {
-    this.expressApp.use((0, import_shrink_ray_current.default)({useZopfliForGzip: false}));
+    this.expressApp.use((0, import_compression.default)());
   }
   getRegexWildcard() {
     return "*";

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

@@ -36,6 +36,9 @@ var KoaRequest = class {
   get method() {
     return this.ctx.method;
   }
+  get headers() {
+    return this.ctx.headers;
+  }
   get locale() {
     return this.ctx.locale;
   }
@@ -66,7 +69,7 @@ var KoaRequest = class {
     return !this.hasJsonParam() || this.ctx.request.accepts("json") === "json";
   }
   getRuntimeContext(defaultRuntimeEnvironment) {
-    const {format, apiVersion, compat, locale, environment} = this.params;
+    const {format, apiVersion, compat, locale, environment, bundleSpecifier} = this.params;
     const {debug} = this.ctx.request.query;
     return {
       runtimeEnvironment: {
@@ -74,7 +77,8 @@ var KoaRequest = class {
         format: format ? format : defaultRuntimeEnvironment.format,
         compat: compat !== void 0 ? compat : defaultRuntimeEnvironment.compat,
         debug: debug !== void 0 ? true : defaultRuntimeEnvironment.debug,
-        apiVersion: apiVersion ? apiVersion : defaultRuntimeEnvironment.apiVersion
+        apiVersion: apiVersion ? apiVersion : defaultRuntimeEnvironment.apiVersion,
+        bundle: bundleSpecifier !== void 0 ? true : false
       },
       runtimeParams: {
         locale: locale ? locale : this.ctx.locale ? this.ctx.locale : defaultRuntimeEnvironment.defaultLocale,

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

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

package/build/es/common/compression.js

@@ -0,0 +1,25 @@
+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

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

@@ -1,5 +1,5 @@
 import { Request } from 'express';
-import { RuntimeContext, RuntimeEnvironment, MiddlewareRequest } from '@lwrjs/types';
+import { RuntimeContext, RuntimeEnvironment, MiddlewareRequest, Headers } from '@lwrjs/types';
 export default class ExpressRequest implements MiddlewareRequest {
     private req;
     isMetadataRequest: boolean;
@@ -10,6 +10,7 @@ export default class ExpressRequest implements MiddlewareRequest {
     get query(): any;
     get body(): any;
     get method(): string;
+    get headers(): Headers;
     get protocol(): any;
     get locale(): string;
     set locale(l: string);

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

@@ -22,6 +22,9 @@ export default class ExpressRequest {
     get method() {
         return this.req.method;
     }
+    get headers() {
+        return this.req.headers;
+    }
     get protocol() {
         return this.req.protocol;
     }
@@ -58,7 +61,7 @@ export default class ExpressRequest {
         return !this.hasJsonParam() || this.req.accepts('json') === 'json';
     }
     getRuntimeContext(defaultRuntimeEnvironment) {
-        const { format, apiVersion, compat, locale, environment } = this.req.params;
+        const { format, apiVersion, compat, locale, environment, bundleSpecifier } = this.req.params;
         const { debug } = this.req.query;
         return {
             runtimeEnvironment: {
@@ -67,6 +70,7 @@ export default class ExpressRequest {
                 compat: compat !== undefined ? compat : defaultRuntimeEnvironment.compat,
                 debug: debug !== undefined ? true : defaultRuntimeEnvironment.debug,
                 apiVersion: apiVersion ? apiVersion : defaultRuntimeEnvironment.apiVersion,
+                bundle: bundleSpecifier !== undefined ? true : false, // the absence of a bundle strategy means bundling is off
             },
             runtimeParams: {
                 locale: locale

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

@@ -1,7 +1,7 @@
 import express from 'express';
 import spdy from 'spdy';
 import http from 'http';
-import compression from 'shrink-ray-current';
+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';
@@ -68,10 +68,7 @@ export default class ExpressInternalServer extends AbstractInternalAppServer {
         });
     }
     useCompression() {
-        // TODO: Unfortunately the compression story for express is a mess
-        // shrink-ray is a fork of compression with brotlli support, we will use it
-        // until the "official" one accepts a PR to support it
-        this.expressApp.use(compression({ useZopfliForGzip: false }));
+        this.expressApp.use(compression());
     }
     getRegexWildcard() {
         return '*';

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

@@ -1,5 +1,5 @@
 import Koa from 'koa';
-import { RuntimeContext, RuntimeEnvironment, MiddlewareRequest } from '@lwrjs/types';
+import { RuntimeContext, RuntimeEnvironment, MiddlewareRequest, Headers } from '@lwrjs/types';
 export default class KoaRequest implements MiddlewareRequest {
     protected ctx: Koa.Context;
     isMetadataRequest: boolean;
@@ -11,6 +11,7 @@ export default class KoaRequest implements MiddlewareRequest {
     get protocol(): any;
     get body(): any;
     get method(): string;
+    get headers(): Headers;
     get locale(): string;
     set locale(l: string);
     isSiteGeneration(): boolean;

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

@@ -24,6 +24,9 @@ export default class KoaRequest {
     get method() {
         return this.ctx.method;
     }
+    get headers() {
+        return this.ctx.headers;
+    }
     get locale() {
         return this.ctx.locale;
     }
@@ -54,7 +57,7 @@ export default class KoaRequest {
         return !this.hasJsonParam() || this.ctx.request.accepts('json') === 'json';
     }
     getRuntimeContext(defaultRuntimeEnvironment) {
-        const { format, apiVersion, compat, locale, environment } = this.params;
+        const { format, apiVersion, compat, locale, environment, bundleSpecifier } = this.params;
         const { debug } = this.ctx.request.query;
         return {
             runtimeEnvironment: {
@@ -63,6 +66,7 @@ export default class KoaRequest {
                 compat: compat !== undefined ? compat : defaultRuntimeEnvironment.compat,
                 debug: debug !== undefined ? true : defaultRuntimeEnvironment.debug,
                 apiVersion: apiVersion ? apiVersion : defaultRuntimeEnvironment.apiVersion,
+                bundle: bundleSpecifier !== undefined ? true : false, // the absence of a bundle strategy means bundling is off
             },
             runtimeParams: {
                 locale: locale

package/package.json

@@ -4,7 +4,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.6.5",
+    "version": "0.7.0-alpha.10",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -30,7 +30,7 @@
         "build/**/*.d.ts"
     ],
     "devDependencies": {
-        "@lwrjs/types": "0.6.5",
+        "@lwrjs/types": "0.7.0-alpha.10",
         "@types/koa-compress": "^4.0.1",
         "@types/koa__router": "^8.0.4",
         "@types/spdy": "^3.4.4",
@@ -38,17 +38,22 @@
     },
     "dependencies": {
         "@koa/router": "^10.0.0",
-        "@lwrjs/shared-utils": "0.6.5",
+        "@lwrjs/shared-utils": "0.7.0-alpha.10",
+        "@types/compression": "^1.7.2",
         "@types/express": "^4.17.11",
         "@types/koa": "^2.11.7",
+        "compression": "^1.7.4",
         "express": "^4.17.1",
         "koa": "^2.13.1",
         "koa-compose": "^4.1.0",
         "koa-compress": "^5.0.1",
-        "shrink-ray-current": "^4.1.2",
         "spdy": "^4.0.2"
     },
+    "optionalDependencies": {
+        "shrink-ray-current": "^4.1.2"
+    },
     "engines": {
         "node": ">=14.15.4 <17"
-    }
+    },
+    "gitHead": "83c1e65e2169094cb55ac2c37e5aef16d3a9aa4a"
 }