@lwrjs/shared-utils 0.8.0-alpha.1 → 0.8.0-alpha.11

package/build/cjs/env.cjs

@@ -11,7 +11,14 @@ __export(exports, {
   getFeatureFlags: () => getFeatureFlags
 });
 function getFeatureFlags() {
+  let legacyLoader = process.env.LEGACY_LOADER !== void 0 && process.env.LEGACY_LOADER === "true" ? true : false;
+  try {
+    if (LWR) {
+      legacyLoader = LWR.LEGACY_LOADER;
+    }
+  } catch (e) {
+  }
   return {
-    LEGACY_LOADER: process.env.LEGACY_LOADER !== void 0 && process.env.LEGACY_LOADER === "true" ? true : false
+    LEGACY_LOADER: legacyLoader
   };
 }

package/build/cjs/identity.cjs

@@ -79,7 +79,7 @@ var DEFAULT_LWR_BOOTSTRAP_CONFIG = {
   workers: {},
   services: [],
   configAsSrc: false,
-  experimentalSSR: false
+  ssr: false
 };
 function normalizeVersionToUri(version) {
   return version.replace(/\./g, "_");

package/build/cjs/index.cjs

@@ -34,3 +34,4 @@ __exportStar(exports, __toModule(require("./mappings.cjs")));
 __exportStar(exports, __toModule(require("./urls.cjs")));
 __exportStar(exports, __toModule(require("./env.cjs")));
 __exportStar(exports, __toModule(require("./logger.cjs")));
+__exportStar(exports, __toModule(require("./lwr-app-observer.cjs")));

package/build/cjs/logger.cjs

@@ -24,13 +24,85 @@ var __toModule = (module2) => {
 // packages/@lwrjs/shared-utils/src/logger.ts
 __markAsModule(exports);
 __export(exports, {
-  logger: () => logger
-});
-var import_winston = __toModule(require("winston"));
-var LOG_LEVEL = process.env.LOG_LEVEL || "info";
-console.log(`LOG_LEVEL: ${LOG_LEVEL}`);
-var logger = import_winston.default.createLogger({
-  level: LOG_LEVEL,
-  format: import_winston.default.format.json(),
-  transports: [new import_winston.default.transports.Console()]
+  DEBUG: () => DEBUG,
+  ERROR: () => ERROR,
+  INFO: () => INFO,
+  VERBOSE: () => VERBOSE,
+  WARN: () => WARN,
+  logger: () => logger,
+  stringifyError: () => stringifyError
 });
+var import_diagnostics = __toModule(require("@lwrjs/diagnostics"));
+var VERBOSE = "verbose";
+var DEBUG = "debug";
+var INFO = "info";
+var WARN = "warn";
+var ERROR = "error";
+var currentLevel = process.env.LOG_LEVEL || INFO;
+var log = (level, message, additionalInfo) => {
+  const LOG_LEVEL = process.env.LOG_LEVEL || INFO;
+  if (currentLevel !== LOG_LEVEL) {
+    currentLevel = LOG_LEVEL;
+    console.log(`LOG_LEVEL: ${LOG_LEVEL}`);
+  }
+  let shouldLog = false;
+  switch (level) {
+    case VERBOSE:
+      shouldLog = LOG_LEVEL == VERBOSE;
+      break;
+    case DEBUG:
+      shouldLog = LOG_LEVEL == VERBOSE || LOG_LEVEL == DEBUG;
+      break;
+    case INFO:
+      shouldLog = LOG_LEVEL == VERBOSE || LOG_LEVEL == DEBUG || LOG_LEVEL == INFO;
+      break;
+    case WARN:
+      shouldLog = LOG_LEVEL == VERBOSE || LOG_LEVEL == DEBUG || LOG_LEVEL == INFO || LOG_LEVEL == WARN;
+      break;
+    case ERROR:
+      shouldLog = true;
+      break;
+  }
+  if (shouldLog) {
+    let logMethod;
+    if (level == ERROR) {
+      logMethod = console.error;
+    } else {
+      logMethod = console.log;
+    }
+    if (additionalInfo) {
+      logMethod(`[${level}] : ${message} 
+Additional Info: ${JSON.stringify(additionalInfo)}`);
+    } else {
+      logMethod(`[${level}] : ${message}`);
+    }
+  }
+};
+var stringifyError = (error) => {
+  if (error instanceof import_diagnostics.DiagnosticsError) {
+    return JSON.stringify({
+      message: error.message,
+      diagnostics: error.diagnostics,
+      stack: error.stack
+    });
+  } else if (typeof error === "string" || error instanceof String) {
+    return error;
+  } else {
+    const propertyNames = Object.getOwnPropertyNames(error);
+    const retObj = {};
+    for (let property, i = 0, len = propertyNames.length; i < len; ++i) {
+      property = propertyNames[i];
+      const descriptor = Object.getOwnPropertyDescriptor(error, property);
+      retObj[property] = descriptor?.value;
+    }
+    return JSON.stringify(retObj);
+  }
+};
+var logger = {
+  verbose: (message, additionalInfo) => log(VERBOSE, message, additionalInfo),
+  debug: (message, additionalInfo) => log(DEBUG, message, additionalInfo),
+  info: (message, additionalInfo) => log(INFO, message, additionalInfo),
+  warn: (message, additionalInfo) => log(WARN, message, additionalInfo),
+  error: (error, additionalInfo) => log(ERROR, stringifyError(error), additionalInfo),
+  log
+};

package/build/cjs/lwr-app-observer.cjs

@@ -0,0 +1,82 @@
+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/shared-utils/src/lwr-app-observer.ts
+__markAsModule(exports);
+__export(exports, {
+  LwrApplicationObserver: () => LwrApplicationObserver
+});
+var import_events = __toModule(require("events"));
+var MODULE_DEF_CHANGED_EVENT = "module_definition_changed";
+var MODULE_SOURCE_CHANGED_EVENT = "module_source_changed";
+var VIEW_SOURCE_CHANGED_EVENT = "view_source_changed";
+var ASSET_SOURCE_CHANGED_EVENT = "asset_source_changed";
+var LwrEmitter = class {
+  constructor(observer) {
+    this.observer = observer;
+  }
+  notifyAssetSourceChanged(payload) {
+    this.observer.emit(ASSET_SOURCE_CHANGED_EVENT, {
+      eventType: ASSET_SOURCE_CHANGED_EVENT,
+      payload
+    });
+  }
+  notifyViewSourceChanged(payload) {
+    this.observer.emit(VIEW_SOURCE_CHANGED_EVENT, {
+      eventType: VIEW_SOURCE_CHANGED_EVENT,
+      payload
+    });
+  }
+  notifyModuleDefinitionChanged(payload) {
+    this.observer.emit(MODULE_DEF_CHANGED_EVENT, {
+      eventType: MODULE_DEF_CHANGED_EVENT,
+      payload
+    });
+  }
+  notifyModuleSourceChanged(payload) {
+    this.observer.emit(MODULE_SOURCE_CHANGED_EVENT, {
+      eventType: MODULE_SOURCE_CHANGED_EVENT,
+      payload
+    });
+  }
+};
+var LwrApplicationObserver = class extends import_events.EventEmitter {
+  constructor() {
+    super();
+  }
+  onModuleDefinitionChange(listener) {
+    this.on(MODULE_DEF_CHANGED_EVENT, listener);
+  }
+  onModuleSourceChange(listener) {
+    this.on(MODULE_SOURCE_CHANGED_EVENT, listener);
+  }
+  onViewSourceChange(listener) {
+    this.on(VIEW_SOURCE_CHANGED_EVENT, listener);
+  }
+  onAssetSourceChange(listener) {
+    this.on(ASSET_SOURCE_CHANGED_EVENT, listener);
+  }
+  createLwrEmitter() {
+    return new LwrEmitter(this);
+  }
+};

package/build/cjs/tasks.cjs

@@ -58,15 +58,12 @@ var InflightTasks = class {
   constructor() {
     this.tasks = new Map();
   }
-  execute(id, taskCtor, caller) {
-    if (this.tasks.has(id)) {
-      return this.tasks.get(id);
-    } else {
-      const job = taskCtor.bind(caller || this)().finally(() => {
-        this.tasks.delete(id);
-      });
-      this.tasks.set(id, job);
-      return job;
+  execute(id, fn) {
+    let promise = this.tasks.get(id);
+    if (!promise) {
+      promise = fn().finally(() => this.tasks.delete(id));
+      this.tasks.set(id, promise);
     }
+    return promise;
   }
 };

package/build/cjs/typescript.cjs

@@ -73,6 +73,7 @@ async function transpileTs(tsAbsPath, {rootDir, cacheDir}) {
     bundle: true,
     logLevel: "error",
     entryPoints: [tsAbsPath],
+    sourcemap: true,
     outfile,
     plugins: [ESBUILD_EXTENSION_PLUGIN(tsAbsPath, format)]
   });

package/build/es/env.js

@@ -1,7 +1,17 @@
 export function getFeatureFlags() {
+    let legacyLoader = process.env.LEGACY_LOADER !== undefined && process.env.LEGACY_LOADER === 'true' ? true : false;
+    try {
+        // Use the Shim for MRT since we don't have access to managing environment variables
+        if (LWR) {
+            legacyLoader = LWR.LEGACY_LOADER;
+        }
+    }
+    catch (e) {
+        // No shim, ignore error
+    }
     return {
         // DEFAULT LEGACY_LOADER = false;
-        LEGACY_LOADER: process.env.LEGACY_LOADER !== undefined && process.env.LEGACY_LOADER === 'true' ? true : false,
+        LEGACY_LOADER: legacyLoader,
     };
 }
 //# sourceMappingURL=env.js.map

package/build/es/identity.d.ts

@@ -19,7 +19,7 @@ export declare const DEFAULT_LWR_BOOTSTRAP_CONFIG: {
     workers: {};
     services: never[];
     configAsSrc: boolean;
-    experimentalSSR: boolean;
+    ssr: boolean;
 };
 declare type ModuleIdentifierPartial = Partial<AbstractModuleId>;
 /**

package/build/es/identity.js

@@ -20,7 +20,7 @@ export const DEFAULT_LWR_BOOTSTRAP_CONFIG = {
     workers: {},
     services: [],
     configAsSrc: false,
-    experimentalSSR: false,
+    ssr: false,
 };
 /**
  * Turn the dots in a version into underscores

package/build/es/index.d.ts

@@ -13,4 +13,5 @@ export * from './mappings.js';
 export * from './urls.js';
 export * from './env.js';
 export * from './logger.js';
+export * from './lwr-app-observer.js';
 //# sourceMappingURL=index.d.ts.map

package/build/es/index.js

@@ -13,4 +13,5 @@ export * from './mappings.js';
 export * from './urls.js';
 export * from './env.js';
 export * from './logger.js';
+export * from './lwr-app-observer.js';
 //# sourceMappingURL=index.js.map

package/build/es/logger.d.ts

@@ -1,3 +1,17 @@
-import winston from 'winston';
-export declare const logger: winston.Logger;
+declare type LEVEL = 'verbose' | 'debug' | 'info' | 'warn' | 'error';
+export declare const VERBOSE: LEVEL;
+export declare const DEBUG: LEVEL;
+export declare const INFO: LEVEL;
+export declare const WARN: LEVEL;
+export declare const ERROR: LEVEL;
+export declare const stringifyError: (error: any) => string;
+export declare const logger: {
+    verbose: (message: string, additionalInfo?: any) => void;
+    debug: (message: string, additionalInfo?: any) => void;
+    info: (message: string, additionalInfo?: any) => void;
+    warn: (message: string, additionalInfo?: any) => void;
+    error: (error: any, additionalInfo?: any) => void;
+    log: (level: string, message: string, additionalInfo?: any) => void;
+};
+export {};
 //# sourceMappingURL=logger.d.ts.map

package/build/es/logger.js

@@ -1,9 +1,78 @@
-import winston from 'winston';
-const LOG_LEVEL = process.env.LOG_LEVEL || 'info';
-console.log(`LOG_LEVEL: ${LOG_LEVEL}`);
-export const logger = winston.createLogger({
-    level: LOG_LEVEL,
-    format: winston.format.json(),
-    transports: [new winston.transports.Console()],
-});
+import { DiagnosticsError } from '@lwrjs/diagnostics';
+export const VERBOSE = 'verbose';
+export const DEBUG = 'debug';
+export const INFO = 'info';
+export const WARN = 'warn';
+export const ERROR = 'error';
+let currentLevel = process.env.LOG_LEVEL || INFO;
+const log = (level, message, additionalInfo) => {
+    const LOG_LEVEL = process.env.LOG_LEVEL || INFO;
+    if (currentLevel !== LOG_LEVEL) {
+        currentLevel = LOG_LEVEL;
+        console.log(`LOG_LEVEL: ${LOG_LEVEL}`);
+    }
+    let shouldLog = false;
+    switch (level) {
+        case VERBOSE:
+            shouldLog = LOG_LEVEL == VERBOSE;
+            break;
+        case DEBUG:
+            shouldLog = LOG_LEVEL == VERBOSE || LOG_LEVEL == DEBUG;
+            break;
+        case INFO:
+            shouldLog = LOG_LEVEL == VERBOSE || LOG_LEVEL == DEBUG || LOG_LEVEL == INFO;
+            break;
+        case WARN:
+            shouldLog = LOG_LEVEL == VERBOSE || LOG_LEVEL == DEBUG || LOG_LEVEL == INFO || LOG_LEVEL == WARN;
+            break;
+        case ERROR:
+            shouldLog = true;
+            break;
+    }
+    if (shouldLog) {
+        let logMethod;
+        if (level == ERROR) {
+            logMethod = console.error;
+        }
+        else {
+            logMethod = console.log;
+        }
+        if (additionalInfo) {
+            logMethod(`[${level}] : ${message} \nAdditional Info: ${JSON.stringify(additionalInfo)}`);
+        }
+        else {
+            logMethod(`[${level}] : ${message}`);
+        }
+    }
+};
+export const stringifyError = (error) => {
+    if (error instanceof DiagnosticsError) {
+        return JSON.stringify({
+            message: error.message,
+            diagnostics: error.diagnostics,
+            stack: error.stack,
+        });
+    }
+    else if (typeof error === 'string' || error instanceof String) {
+        return error;
+    }
+    else {
+        const propertyNames = Object.getOwnPropertyNames(error);
+        const retObj = {};
+        for (let property, i = 0, len = propertyNames.length; i < len; ++i) {
+            property = propertyNames[i];
+            const descriptor = Object.getOwnPropertyDescriptor(error, property);
+            retObj[property] = descriptor?.value;
+        }
+        return JSON.stringify(retObj);
+    }
+};
+export const logger = {
+    verbose: (message, additionalInfo) => log(VERBOSE, message, additionalInfo),
+    debug: (message, additionalInfo) => log(DEBUG, message, additionalInfo),
+    info: (message, additionalInfo) => log(INFO, message, additionalInfo),
+    warn: (message, additionalInfo) => log(WARN, message, additionalInfo),
+    error: (error, additionalInfo) => log(ERROR, stringifyError(error), additionalInfo),
+    log,
+};
 //# sourceMappingURL=logger.js.map

package/build/es/lwr-app-observer.d.ts

@@ -0,0 +1,21 @@
+/// <reference types="node" />
+import { EventEmitter } from 'events';
+import { ModuleCompiled, LwrAppEmitter, LwrAppObserver, ModuleDefinitionChangedEvent, ModuleSourceChangedEvent, CompiledView, AssetSource, AssetSourceChangedEvent, ViewSourceChangedEvent } from '@lwrjs/types';
+declare class LwrEmitter implements LwrAppEmitter {
+    observer: LwrApplicationObserver;
+    constructor(observer: LwrApplicationObserver);
+    notifyAssetSourceChanged(payload: AssetSource): void;
+    notifyViewSourceChanged(payload: CompiledView): void;
+    notifyModuleDefinitionChanged(payload: ModuleCompiled): void;
+    notifyModuleSourceChanged(payload: ModuleCompiled): void;
+}
+export declare class LwrApplicationObserver extends EventEmitter implements LwrAppObserver {
+    constructor();
+    onModuleDefinitionChange(listener: (event: ModuleDefinitionChangedEvent) => void): void;
+    onModuleSourceChange(listener: (event: ModuleSourceChangedEvent) => void): void;
+    onViewSourceChange(listener: (event: ViewSourceChangedEvent) => void): void;
+    onAssetSourceChange(listener: (event: AssetSourceChangedEvent) => void): void;
+    createLwrEmitter(): LwrEmitter;
+}
+export {};
+//# sourceMappingURL=lwr-app-observer.d.ts.map

package/build/es/lwr-app-observer.js

@@ -0,0 +1,55 @@
+import { EventEmitter } from 'events';
+const MODULE_DEF_CHANGED_EVENT = 'module_definition_changed';
+const MODULE_SOURCE_CHANGED_EVENT = 'module_source_changed';
+const VIEW_SOURCE_CHANGED_EVENT = 'view_source_changed';
+const ASSET_SOURCE_CHANGED_EVENT = 'asset_source_changed';
+class LwrEmitter {
+    constructor(observer) {
+        this.observer = observer;
+    }
+    notifyAssetSourceChanged(payload) {
+        this.observer.emit(ASSET_SOURCE_CHANGED_EVENT, {
+            eventType: ASSET_SOURCE_CHANGED_EVENT,
+            payload,
+        });
+    }
+    notifyViewSourceChanged(payload) {
+        this.observer.emit(VIEW_SOURCE_CHANGED_EVENT, {
+            eventType: VIEW_SOURCE_CHANGED_EVENT,
+            payload,
+        });
+    }
+    notifyModuleDefinitionChanged(payload) {
+        this.observer.emit(MODULE_DEF_CHANGED_EVENT, {
+            eventType: MODULE_DEF_CHANGED_EVENT,
+            payload,
+        });
+    }
+    notifyModuleSourceChanged(payload) {
+        this.observer.emit(MODULE_SOURCE_CHANGED_EVENT, {
+            eventType: MODULE_SOURCE_CHANGED_EVENT,
+            payload,
+        });
+    }
+}
+export class LwrApplicationObserver extends EventEmitter {
+    constructor() {
+        super();
+    }
+    onModuleDefinitionChange(listener) {
+        this.on(MODULE_DEF_CHANGED_EVENT, listener);
+    }
+    onModuleSourceChange(listener) {
+        this.on(MODULE_SOURCE_CHANGED_EVENT, listener);
+    }
+    onViewSourceChange(listener) {
+        this.on(VIEW_SOURCE_CHANGED_EVENT, listener);
+    }
+    onAssetSourceChange(listener) {
+        this.on(ASSET_SOURCE_CHANGED_EVENT, listener);
+    }
+    createLwrEmitter() {
+        return new LwrEmitter(this);
+    }
+}
+//# sourceMappingURL=lwr-app-observer.js.map

package/build/es/tasks.d.ts

@@ -23,16 +23,15 @@ export declare class TaskPool {
  * Calls to execute with the id of a task in progress returns the running tasks
  * If no task of that id is running a new task is created
  */
-export declare class InflightTasks<Type> {
+export declare class InflightTasks<Value> {
     private tasks;
     /**
      * Return a promise per id.  If one is already in flight return the promise.
      * If not use the constructor to create a new
      *
      * @param id - Unique id for promise in question
-     * @param taskCtor - Function that create a promise for the id if needed
-     * @param caller - The closer to use when calling the constructor
+     * @param fn - Function that create a promise for the id if needed
      */
-    execute(id: string, taskCtor: Function, caller?: any): Promise<Type>;
+    execute(id: string, fn: () => Promise<Value>): Promise<Value>;
 }
 //# sourceMappingURL=tasks.d.ts.map

package/build/es/tasks.js

@@ -75,24 +75,15 @@ export class InflightTasks {
      * If not use the constructor to create a new
      *
      * @param id - Unique id for promise in question
-     * @param taskCtor - Function that create a promise for the id if needed
-     * @param caller - The closer to use when calling the constructor
+     * @param fn - Function that create a promise for the id if needed
      */
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-    execute(id, taskCtor, caller) {
-        if (this.tasks.has(id)) {
-            return this.tasks.get(id);
-        }
-        else {
-            const job = taskCtor
-                .bind(caller || this)()
-                .finally(() => {
-                // Once fulfilled remove form active jobs
-                this.tasks.delete(id);
-            });
-            this.tasks.set(id, job);
-            return job;
+    execute(id, fn) {
+        let promise = this.tasks.get(id);
+        if (!promise) {
+            promise = fn().finally(() => this.tasks.delete(id));
+            this.tasks.set(id, promise);
         }
+        return promise;
     }
 }
 //# sourceMappingURL=tasks.js.map

package/build/es/typescript.js

@@ -60,6 +60,7 @@ export async function transpileTs(tsAbsPath, { rootDir, cacheDir }) {
         bundle: true,
         logLevel: 'error',
         entryPoints: [tsAbsPath],
+        sourcemap: true,
         outfile,
         plugins: [ESBUILD_EXTENSION_PLUGIN(tsAbsPath, format)],
     });

package/package.json

@@ -4,7 +4,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.8.0-alpha.1",
+    "version": "0.8.0-alpha.11",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -40,17 +40,18 @@
         "magic-string": "^0.25.7",
         "mime-types": "^2.1.33",
         "parse5-sax-parser": "^6.0.1",
+        "path-to-regexp": "^6.2.0",
         "slugify": "^1.4.5",
         "winston": "^3.7.2"
     },
     "devDependencies": {
-        "@lwrjs/diagnostics": "0.8.0-alpha.1",
-        "@lwrjs/types": "0.8.0-alpha.1",
+        "@lwrjs/diagnostics": "0.8.0-alpha.11",
+        "@lwrjs/types": "0.8.0-alpha.11",
         "@types/mime-types": "2.1.1",
         "@types/path-to-regexp": "^1.7.0"
     },
     "engines": {
         "node": ">=14.15.4 <19"
     },
-    "gitHead": "2718cc5abe11d0d6fd5375cf9205167b6f69e244"
+    "gitHead": "e8a2c6811e4a52227219f2d94648e0eae9800fbc"
 }