@lwrjs/diagnostics 0.7.0-alpha.0 → 0.7.0-alpha.11

package/build/cjs/descriptions/configParser.cjs

@@ -91,6 +91,10 @@ var configParser = (0, import_core_diagnostics.createDiagnosticsCategory)({
     category: "lwrConfig/invalidSchema",
     message: `Property "${configProperty}" must be a URI path string which starts but does not end with a slash, received ${actualProp}`
   }),
+  INVALID_BASEPATH: (configProperty, actualProp) => ({
+    category: "lwrConfig/invalidSchema",
+    message: `Property "${configProperty}" must be a URI base path string which starts with a slash, received ${actualProp}`
+  }),
   INVALID_SERVICE: (configProperty, actualProp) => ({
     category: "lwrConfig/invalidSchema",
     message: `Property "${configProperty}" must be a valid service (a non-empty string or array with [non-empty string, any]), received ${actualProp}`

package/build/cjs/descriptions/unresolvable.cjs

@@ -67,6 +67,11 @@ var unresolvable = (0, import_core_diagnostics.createDiagnosticsCategory)({
   LABEL_MODULE: (file, error) => ({
     category: "lwrUnresolvable/label",
     message: `Invalid JSON: Labels file ${file} must be a JSON object with string values or nested string values
+${error}`
+  }),
+  ROUTES_MODULE: (file, error) => ({
+    category: "lwrUnresolvable/routes",
+    message: `Invalid JSON: Route config file ${file} is invalid
 ${error}`
   })
 });

package/build/cjs/errors.cjs

@@ -1,9 +1,25 @@
+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/diagnostics/src/errors.ts
 __markAsModule(exports);
@@ -12,9 +28,15 @@ __export(exports, {
   LwrConfigValidationError: () => LwrConfigValidationError,
   LwrServerError: () => LwrServerError,
   LwrUnresolvableError: () => LwrUnresolvableError,
+  createReturnStatus: () => createReturnStatus,
   createSingleDiagnosticError: () => createSingleDiagnosticError,
   isNodeError: () => isNodeError
 });
+var import_descriptions = __toModule(require("./descriptions/index.cjs"));
+var import_dompurify = __toModule(require("dompurify"));
+var import_jsdom = __toModule(require("jsdom"));
+var window = new import_jsdom.JSDOM("").window;
+var DOMPurify = (0, import_dompurify.default)(window);
 function isNodeError(error) {
   return error instanceof Error;
 }
@@ -46,3 +68,17 @@ var LwrUnresolvableError = class extends DiagnosticsError {
 };
 var LwrServerError = class extends DiagnosticsError {
 };
+function createReturnStatus(name, error) {
+  let returnStatus = {status: 501, message: ""};
+  if (isNodeError(error) && error.code === "NO_LWC_MODULE_FOUND") {
+    returnStatus = {status: 404, message: import_descriptions.descriptions.UNRESOLVABLE.LWC_MODULE(name).message};
+  } else if (error instanceof LwrUnresolvableError && error.diagnostics[0].description.category === "lwrUnresolvable/invalid") {
+    returnStatus = {status: 400, message: error.message};
+  } else if (error instanceof LwrUnresolvableError) {
+    returnStatus = {status: 404, message: error.message};
+  } else {
+    returnStatus = {status: 500, message: import_descriptions.descriptions.UNRESOLVABLE.SERVER_ERROR(name).message};
+  }
+  returnStatus.message = DOMPurify.sanitize(returnStatus.message);
+  return returnStatus;
+}

package/build/es/categories.d.ts

@@ -1,6 +1,6 @@
 export declare type DiagnosticCategory = DiagnosticLwrConfigCategory | DiagnosticCompiler | DiagnosticLwrUnresolvableCategory | DiagnosticLwrServer | '...more here';
 export declare type DiagnosticLwrConfigCategory = 'lwrConfig/invalidJson' | 'lwrConfig/invalidSchema';
-export declare type DiagnosticLwrUnresolvableCategory = 'lwrUnresolvable/asset' | 'lwrUnresolvable/module' | 'lwrUnresolvable/label' | 'lwrUnresolvable/resource' | 'lwrUnresolvable/invalid' | 'lwrUnresolvable/fatal';
+export declare type DiagnosticLwrUnresolvableCategory = 'lwrUnresolvable/asset' | 'lwrUnresolvable/module' | 'lwrUnresolvable/label' | 'lwrUnresolvable/routes' | 'lwrUnresolvable/resource' | 'lwrUnresolvable/invalid' | 'lwrUnresolvable/fatal';
 export declare type DiagnosticCompiler = 'compile/umd_transform';
 export declare type DiagnosticLwrServer = 'lwrServer/warmupError';
 //# sourceMappingURL=categories.d.ts.map

package/build/es/descriptions/configParser.d.ts

@@ -114,6 +114,13 @@ export declare const configParser: {
         advice: import("../types.js").DiagnosticAdvice;
         message: string;
     };
+    INVALID_BASEPATH: (configProperty: string, actualProp: string) => Omit<{
+        category: "lwrConfig/invalidSchema";
+        message: string;
+    }, "message" | "advice"> & {
+        advice: import("../types.js").DiagnosticAdvice;
+        message: string;
+    };
     INVALID_SERVICE: (configProperty: string, actualProp: string) => Omit<{
         category: "lwrConfig/invalidSchema";
         message: string;

package/build/es/descriptions/configParser.js

@@ -63,6 +63,10 @@ export const configParser = createDiagnosticsCategory({
         category: 'lwrConfig/invalidSchema',
         message: `Property "${configProperty}" must be a URI path string which starts but does not end with a slash, received ${actualProp}`,
     }),
+    INVALID_BASEPATH: (configProperty, actualProp) => ({
+        category: 'lwrConfig/invalidSchema',
+        message: `Property "${configProperty}" must be a URI base path string which starts with a slash, received ${actualProp}`,
+    }),
     INVALID_SERVICE: (configProperty, actualProp) => ({
         category: 'lwrConfig/invalidSchema',
         message: `Property "${configProperty}" must be a valid service (a non-empty string or array with [non-empty string, any]), received ${actualProp}`,

package/build/es/descriptions/index.d.ts

@@ -114,6 +114,13 @@ export declare const descriptions: {
             advice: import("../types.js").DiagnosticAdvice;
             message: string;
         };
+        INVALID_BASEPATH: (configProperty: string, actualProp: string) => Omit<{
+            category: "lwrConfig/invalidSchema";
+            message: string;
+        }, "message" | "advice"> & {
+            advice: import("../types.js").DiagnosticAdvice;
+            message: string;
+        };
         INVALID_SERVICE: (configProperty: string, actualProp: string) => Omit<{
             category: "lwrConfig/invalidSchema";
             message: string;
@@ -228,6 +235,13 @@ export declare const descriptions: {
             advice: import("../types.js").DiagnosticAdvice;
             message: string;
         };
+        ROUTES_MODULE: (file: string, error: string) => Omit<{
+            category: "lwrUnresolvable/routes";
+            message: string;
+        }, "message" | "advice"> & {
+            advice: import("../types.js").DiagnosticAdvice;
+            message: string;
+        };
     };
     SERVER: {
         WARMUP_ERROR: (error: string) => Omit<{

package/build/es/descriptions/unresolvable.d.ts

@@ -69,5 +69,12 @@ export declare const unresolvable: {
         advice: import("../types.js").DiagnosticAdvice;
         message: string;
     };
+    ROUTES_MODULE: (file: string, error: string) => Omit<{
+        category: "lwrUnresolvable/routes";
+        message: string;
+    }, "message" | "advice"> & {
+        advice: import("../types.js").DiagnosticAdvice;
+        message: string;
+    };
 };
 //# sourceMappingURL=unresolvable.d.ts.map

package/build/es/descriptions/unresolvable.js

@@ -40,5 +40,9 @@ export const unresolvable = createDiagnosticsCategory({
         category: 'lwrUnresolvable/label',
         message: `Invalid JSON: Labels file ${file} must be a JSON object with string values or nested string values\n${error}`,
     }),
+    ROUTES_MODULE: (file, error) => ({
+        category: 'lwrUnresolvable/routes',
+        message: `Invalid JSON: Route config file ${file} is invalid\n${error}`,
+    }),
 });
 //# sourceMappingURL=unresolvable.js.map

package/build/es/errors.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { Diagnostic, Diagnostics } from './types';
+import { Diagnostic, Diagnostics } from './types.js';
 export declare function isNodeError(error: unknown): error is NodeJS.ErrnoException;
 export declare function createSingleDiagnosticError(diag: Diagnostic, errorClass?: typeof DiagnosticsError): DiagnosticsError;
 export declare class DiagnosticsError extends Error {
@@ -15,4 +15,14 @@ export declare class LwrUnresolvableError extends DiagnosticsError {
 }
 export declare class LwrServerError extends DiagnosticsError {
 }
+/**
+ * Create a status object Express can return when there is an error
+ *
+ * @param name - string name of the problem module/resource
+ * @param error - an Error/Diagnostic object; thrown from try/catch
+ */
+export declare function createReturnStatus(name: string, error: unknown): {
+    status: number;
+    message: string;
+};
 //# sourceMappingURL=errors.d.ts.map

package/build/es/errors.js

@@ -1,3 +1,8 @@
+import { descriptions } from './descriptions/index.js';
+import createDOMPurify from 'dompurify';
+import { JSDOM } from 'jsdom';
+const window = new JSDOM('').window;
+const DOMPurify = createDOMPurify(window);
 // The NodeJS Error is different from the JavaScript Error (e.g. NodeJS Error has a code)
 export function isNodeError(error) {
     return error instanceof Error;
@@ -32,4 +37,28 @@ export class LwrUnresolvableError extends DiagnosticsError {
 }
 export class LwrServerError extends DiagnosticsError {
 }
+/**
+ * Create a status object Express can return when there is an error
+ *
+ * @param name - string name of the problem module/resource
+ * @param error - an Error/Diagnostic object; thrown from try/catch
+ */
+export function createReturnStatus(name, error) {
+    let returnStatus = { status: 501, message: '' };
+    if (isNodeError(error) && error.code === 'NO_LWC_MODULE_FOUND') {
+        returnStatus = { status: 404, message: descriptions.UNRESOLVABLE.LWC_MODULE(name).message };
+    }
+    else if (error instanceof LwrUnresolvableError &&
+        error.diagnostics[0].description.category === 'lwrUnresolvable/invalid') {
+        returnStatus = { status: 400, message: error.message };
+    }
+    else if (error instanceof LwrUnresolvableError) {
+        returnStatus = { status: 404, message: error.message };
+    }
+    else {
+        returnStatus = { status: 500, message: descriptions.UNRESOLVABLE.SERVER_ERROR(name).message };
+    }
+    returnStatus.message = DOMPurify.sanitize(returnStatus.message);
+    return returnStatus;
+}
 //# sourceMappingURL=errors.js.map

package/package.json

@@ -4,7 +4,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.7.0-alpha.0",
+    "version": "0.7.0-alpha.11",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -29,11 +29,15 @@
         "build/**/*.cjs",
         "build/**/*.d.ts"
     ],
+    "dependencies": {
+        "dompurify": "^2.3.0",
+        "jsdom": "^16.7.0"
+    },
     "devDependencies": {
-        "@lwrjs/types": "0.7.0-alpha.0"
+        "@lwrjs/types": "0.7.0-alpha.11"
     },
     "engines": {
         "node": ">=14.15.4 <17"
     },
-    "gitHead": "4ed70d0bb9fd53feb629468b558b882adade0967"
+    "gitHead": "0b272d15905ec7b949974e8c5ba668a98eaa7e2d"
 }