@lwrjs/shared-utils 0.8.0-alpha.9 → 0.8.1

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/fs.cjs

@@ -43,10 +43,14 @@ var import_object = __toModule(require("./object.cjs"));
 var import_chokidar = __toModule(require("chokidar"));
 var import_diagnostics = __toModule(require("@lwrjs/diagnostics"));
 var import_mime_types = __toModule(require("mime-types"));
+var import_logger = __toModule(require("./logger.cjs"));
+var fileCount = 0;
+var files = new Map();
 function hashContent(source) {
   return import_crypto.default.createHash("md5").update(source).digest("hex");
 }
 function readFile(filePath) {
+  logMetrics(filePath);
   return import_fs.default.readFileSync(filePath, "utf8");
 }
 function resolveFileExtension(filePath) {
@@ -77,7 +81,7 @@ function setupWatcher(onModuleChange) {
   const fileWatcher = createFileWatcher();
   fileWatcher.on("change", (0, import_object.debounce)((file) => onModuleChange(file), 500));
   fileWatcher.on("unlink", (0, import_object.debounce)((file) => onModuleChange(file), 500));
-  fileWatcher.on("add", (file) => console.log("Watching: ", file));
+  fileWatcher.on("add", (file) => import_logger.logger.info(`Watching: ${file}`));
   return fileWatcher;
 }
 function canResolveView(source, type) {
@@ -124,3 +128,15 @@ function normalizeResourcePath(rawPath, {rootDir, assets, contentDir, layoutsDir
     return alias;
   });
 }
+function logMetrics(filePath) {
+  if (import_logger.logger.currentLevel == import_logger.DEBUG || import_logger.logger.currentLevel == import_logger.VERBOSE) {
+    let count = files.get(filePath) || 0;
+    if (++count % 100 === 0) {
+      import_logger.logger.debug(`[${count}] Repeat Read ${filePath}`);
+    }
+    files.set(filePath, count);
+    if (++fileCount % 1e3 === 0) {
+      import_logger.logger.debug(`Open file count [${fileCount}]`);
+    }
+  }
+}

package/build/cjs/html-meta.cjs

@@ -24,7 +24,9 @@ var __toModule = (module2) => {
 // packages/@lwrjs/shared-utils/src/html-meta.ts
 __markAsModule(exports);
 __export(exports, {
-  extractMetadataFromHtml: () => extractMetadataFromHtml
+  extractMetadataFromHtml: () => extractMetadataFromHtml,
+  isRelative: () => isRelative,
+  isSelfUrl: () => isSelfUrl
 });
 var import_identity = __toModule(require("./identity.cjs"));
 var import_parse5_sax_parser = __toModule(require("parse5-sax-parser"));
@@ -38,12 +40,21 @@ function parseAssetLocation(htmlSource, tagName, attrLocation) {
   return {
     url,
     tagName,
+    relative: isRelative(url),
     location: {
       startOffset: startOffset + keyAttr.length + 2,
       endOffset: endOffset - 1
     }
   };
 }
+function isRelative(url) {
+  return !url?.match(isNotRelativeRegex);
+}
+var isNotRelativeRegex = /^(http(s)?:\/\/|\/)/i;
+function isSelfUrl(url) {
+  return !url || !!url.match(isSelfUrlRegex);
+}
+var isSelfUrlRegex = /^\s*(data:|#)/i;
 async function extractMetadataFromHtml(htmlSource) {
   return new Promise((resolve, reject) => {
     const customElements = [];

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

@@ -38,8 +38,10 @@ var DEBUG = "debug";
 var INFO = "info";
 var WARN = "warn";
 var ERROR = "error";
+var options = {};
+var DUPES = new Set();
 var currentLevel = process.env.LOG_LEVEL || INFO;
-var log = (level, message, additionalInfo) => {
+function log(level, message, additionalInfo) {
   const LOG_LEVEL = process.env.LOG_LEVEL || INFO;
   if (currentLevel !== LOG_LEVEL) {
     currentLevel = LOG_LEVEL;
@@ -63,21 +65,31 @@ var log = (level, message, additionalInfo) => {
       shouldLog = true;
       break;
   }
+  if (shouldLog && options.dedupe && options.dedupe.has(level)) {
+    const key = `[${level}] : ${message}`;
+    if (DUPES.has(key)) {
+      shouldLog = false;
+    } else {
+      DUPES.add(key);
+    }
+  }
   if (shouldLog) {
     let logMethod;
     if (level == ERROR) {
       logMethod = console.error;
+    } else if (level == WARN) {
+      logMethod = console.warn;
     } else {
       logMethod = console.log;
     }
     if (additionalInfo) {
-      logMethod(`[${level}] : ${message} 
+      logMethod(`[${level}] ${message} 
 Additional Info: ${JSON.stringify(additionalInfo)}`);
     } else {
-      logMethod(`[${level}] : ${message}`);
+      logMethod(`[${level}] ${message}`);
     }
   }
-};
+}
 var stringifyError = (error) => {
   if (error instanceof import_diagnostics.DiagnosticsError) {
     return JSON.stringify({
@@ -104,5 +116,9 @@ var logger = {
   info: (message, additionalInfo) => log(INFO, message, additionalInfo),
   warn: (message, additionalInfo) => log(WARN, message, additionalInfo),
   error: (error, additionalInfo) => log(ERROR, stringifyError(error), additionalInfo),
-  log
+  log,
+  setOptions: (opts) => {
+    options = opts;
+  },
+  currentLevel
 };

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/urls.cjs

@@ -29,6 +29,7 @@ __export(exports, {
   getClientBootstrapConfigurationRoutes: () => getClientBootstrapConfigurationRoutes,
   getClientBootstrapConfigurationUri: () => getClientBootstrapConfigurationUri,
   getClientBootstrapConfigurationUriPrefix: () => getClientBootstrapConfigurationUriPrefix,
+  isModuleOrBundleUrl: () => isModuleOrBundleUrl,
   removeClientBootstrapConfigurationSuffix: () => removeClientBootstrapConfigurationSuffix
 });
 var import_path_to_regexp = __toModule(require("path-to-regexp"));
@@ -95,3 +96,7 @@ function extractRequestParams(parameterizedRoute, resolvedUrl, existingParams) {
   }
   return params;
 }
+var isModuleOrBundleRegEx = /^\/.*\/(module|bundle)\//i;
+function isModuleOrBundleUrl(url) {
+  return isModuleOrBundleRegEx.test(url);
+}

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/fs.js

@@ -6,6 +6,9 @@ import { debounce } from './object.js';
 import chokidar from 'chokidar';
 import { LwrUnresolvableError, createSingleDiagnosticError, descriptions } from '@lwrjs/diagnostics';
 import { lookup } from 'mime-types';
+import { DEBUG, logger, VERBOSE } from './logger.js';
+let fileCount = 0;
+const files = new Map();
 /**
  * Create a hash string for a source
  * @param source
@@ -18,6 +21,7 @@ export function hashContent(source) {
  * @param filePath
  */
 export function readFile(filePath) {
+    logMetrics(filePath);
     return fs.readFileSync(filePath, 'utf8');
 }
 /**
@@ -67,7 +71,7 @@ export function setupWatcher(onModuleChange) {
     const fileWatcher = createFileWatcher();
     fileWatcher.on('change', debounce((file) => onModuleChange(file), 500));
     fileWatcher.on('unlink', debounce((file) => onModuleChange(file), 500));
-    fileWatcher.on('add', (file) => console.log('Watching: ', file));
+    fileWatcher.on('add', (file) => logger.info(`Watching: ${file}`));
     return fileWatcher;
 }
 /**
@@ -137,4 +141,16 @@ export function normalizeResourcePath(rawPath, { rootDir, assets, contentDir, la
     });
 }
 export { lookup as mimeLookup };
+function logMetrics(filePath) {
+    if (logger.currentLevel == DEBUG || logger.currentLevel == VERBOSE) {
+        let count = files.get(filePath) || 0;
+        if (++count % 100 === 0) {
+            logger.debug(`[${count}] Repeat Read ${filePath}`);
+        }
+        files.set(filePath, count);
+        if (++fileCount % 1000 === 0) {
+            logger.debug(`Open file count [${fileCount}]`);
+        }
+    }
+}
 //# sourceMappingURL=fs.js.map

package/build/es/html-meta.d.ts

@@ -1,4 +1,6 @@
 import { RenderedViewMetadata } from '@lwrjs/types';
+export declare function isRelative(url: string): boolean;
+export declare function isSelfUrl(url: string): boolean;
 /**
  * Pull the custom elements and img tags out of an HTML string, to use as metadata
  * @param htmlSource - An HTML string to parse

package/build/es/html-meta.js

@@ -12,12 +12,23 @@ function parseAssetLocation(htmlSource, tagName, attrLocation) {
     return {
         url,
         tagName,
+        relative: isRelative(url),
         location: {
             startOffset: startOffset + keyAttr.length + 2 /* =" */,
             endOffset: endOffset - 1,
         },
     };
 }
+// Detect if this is a relative URL
+export function isRelative(url) {
+    return !url?.match(isNotRelativeRegex);
+}
+const isNotRelativeRegex = /^(http(s)?:\/\/|\/)/i;
+// Detect if this is just a self referential URL
+export function isSelfUrl(url) {
+    return !url || !!url.match(isSelfUrlRegex);
+}
+const isSelfUrlRegex = /^\s*(data:|#)/i;
 /**
  * Pull the custom elements and img tags out of an HTML string, to use as metadata
  * @param htmlSource - An HTML string to parse

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

@@ -4,6 +4,10 @@ export declare const DEBUG: LEVEL;
 export declare const INFO: LEVEL;
 export declare const WARN: LEVEL;
 export declare const ERROR: LEVEL;
+declare type LoggerOptions = {
+    dedupe?: Set<string>;
+};
+declare function log(level: string, message: string, additionalInfo?: any): void;
 export declare const stringifyError: (error: any) => string;
 export declare const logger: {
     verbose: (message: string, additionalInfo?: any) => void;
@@ -11,7 +15,9 @@ export declare const logger: {
     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;
+    log: typeof log;
+    setOptions: (opts: LoggerOptions) => void;
+    currentLevel: string;
 };
 export {};
 //# sourceMappingURL=logger.d.ts.map

package/build/es/logger.js

@@ -4,8 +4,10 @@ export const DEBUG = 'debug';
 export const INFO = 'info';
 export const WARN = 'warn';
 export const ERROR = 'error';
+let options = {};
+const DUPES = new Set();
 let currentLevel = process.env.LOG_LEVEL || INFO;
-const log = (level, message, additionalInfo) => {
+function log(level, message, additionalInfo) {
     const LOG_LEVEL = process.env.LOG_LEVEL || INFO;
     if (currentLevel !== LOG_LEVEL) {
         currentLevel = LOG_LEVEL;
@@ -29,22 +31,36 @@ const log = (level, message, additionalInfo) => {
             shouldLog = true;
             break;
     }
+    // Check if we should suppress dupes and we have already logged this message
+    if (shouldLog && options.dedupe && options.dedupe.has(level)) {
+        const key = `[${level}] : ${message}`;
+        if (DUPES.has(key)) {
+            shouldLog = false;
+        }
+        else {
+            // add key to de-duplicate cache
+            DUPES.add(key);
+        }
+    }
     if (shouldLog) {
         let logMethod;
         if (level == ERROR) {
             logMethod = console.error;
         }
+        else if (level == WARN) {
+            logMethod = console.warn;
+        }
         else {
             logMethod = console.log;
         }
         if (additionalInfo) {
-            logMethod(`[${level}] : ${message} \nAdditional Info: ${JSON.stringify(additionalInfo)}`);
+            logMethod(`[${level}] ${message} \nAdditional Info: ${JSON.stringify(additionalInfo)}`);
         }
         else {
-            logMethod(`[${level}] : ${message}`);
+            logMethod(`[${level}] ${message}`);
         }
     }
-};
+}
 export const stringifyError = (error) => {
     if (error instanceof DiagnosticsError) {
         return JSON.stringify({
@@ -74,5 +90,9 @@ export const logger = {
     warn: (message, additionalInfo) => log(WARN, message, additionalInfo),
     error: (error, additionalInfo) => log(ERROR, stringifyError(error), additionalInfo),
     log,
+    setOptions: (opts) => {
+        options = opts;
+    },
+    currentLevel,
 };
 //# 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/urls.d.ts

@@ -27,4 +27,5 @@ export declare function getClientBootstrapConfigurationRoutes(): string[];
  * @returns A parameter maps with existing parameters plus token value pairs from route and url
  */
 export declare function extractRequestParams(parameterizedRoute: string, resolvedUrl: string, existingParams?: Record<string, string>): Record<string, string>;
+export declare function isModuleOrBundleUrl(url: string): boolean;
 //# sourceMappingURL=urls.d.ts.map

package/build/es/urls.js

@@ -87,4 +87,8 @@ export function extractRequestParams(parameterizedRoute, resolvedUrl, existingPa
     }
     return params;
 }
+const isModuleOrBundleRegEx = /^\/.*\/(module|bundle)\//i;
+export function isModuleOrBundleUrl(url) {
+    return isModuleOrBundleRegEx.test(url);
+}
 //# sourceMappingURL=urls.js.map

package/package.json

@@ -4,7 +4,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.8.0-alpha.9",
+    "version": "0.8.1",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -45,13 +45,13 @@
         "winston": "^3.7.2"
     },
     "devDependencies": {
-        "@lwrjs/diagnostics": "0.8.0-alpha.9",
-        "@lwrjs/types": "0.8.0-alpha.9",
+        "@lwrjs/diagnostics": "0.8.1",
+        "@lwrjs/types": "0.8.1",
         "@types/mime-types": "2.1.1",
         "@types/path-to-regexp": "^1.7.0"
     },
     "engines": {
         "node": ">=14.15.4 <19"
     },
-    "gitHead": "037c471903c6753fc6866ef598571b0df83e58f9"
+    "gitHead": "171c43556c5624849c8ee6b61ef6de5b65630e38"
 }