@lwrjs/shared-utils 0.9.0-alpha.3 → 0.9.0-alpha.30

package/build/es/logger.js

@@ -43,21 +43,33 @@ function log(level, message, additionalInfo) {
         }
     }
     if (shouldLog) {
-        let logMethod;
+        const logMessage = `[${level}]${gap(message)}${message}`;
+        const additionalMessage = additionalInfo
+            ? `Additional Info: ${JSON.stringify(additionalInfo)}`
+            : undefined;
         if (level == ERROR) {
-            logMethod = console.error;
+            console.error('\x1b[31m%s\x1b[0m', logMessage); // red
+            if (additionalInfo) {
+                console.error('\n\x1b[31m%s\x1b[0m', additionalMessage); // red
+            }
         }
         else if (level == WARN) {
-            logMethod = console.warn;
+            console.warn('\x1b[33m%s\x1b[0m', logMessage); // yellow
+            if (additionalInfo) {
+                console.warn('\n\x1b[33m%s\x1b[0m', additionalMessage); // yellow
+            }
         }
-        else {
-            logMethod = console.log;
-        }
-        if (additionalInfo) {
-            logMethod(`[${level}] ${message} \nAdditional Info: ${JSON.stringify(additionalInfo)}`);
+        else if (level == DEBUG || level == VERBOSE) {
+            console.log('\x1b[2m%s\x1b[0m', logMessage); // dim
+            if (additionalInfo) {
+                console.log('\n\x1b[2m%s\x1b[0m', additionalMessage); // dim
+            }
         }
         else {
-            logMethod(`[${level}] ${message}`);
+            console.log(logMessage);
+            if (additionalInfo) {
+                console.log(`\n${additionalMessage}`);
+            }
         }
     }
 }
@@ -83,12 +95,26 @@ export const stringifyError = (error) => {
         return JSON.stringify(retObj);
     }
 };
+// Return a space if there should be a space between the message and the level
+function gap(message) {
+    return String(message)?.indexOf('[') === 0 ? '' : ' ';
+}
+function logError(err, additionalInfo) {
+    if (err instanceof DiagnosticsError || !err || !err.message) {
+        log(ERROR, stringifyError(err), additionalInfo);
+    }
+    // If this is an error with a message update the message header and log as is...
+    if (err && err.message) {
+        err.message = `[${ERROR}]${gap(err.message)}${err.message}`;
+        console.error('\x1b[31m%s\x1b[0m', err);
+    }
+}
 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),
+    error: (error, additionalInfo) => logError(error, additionalInfo),
     log,
     setOptions: (opts) => {
         options = opts;

package/build/es/mappings.js

@@ -141,6 +141,8 @@ async function createIndex(specifiers, moduleRegistry, runtimeEnvironment, runti
         if (!moduleId.version) {
             throw new Error('Module specifier must include a version: ' + specifier);
         }
+        // Do not use replace with the moduleBundler.  Otherwize we will create a bundle from every
+        // root just to get the URL.
         index[specifier] = await moduleRegistry.resolveModuleUri({ ...moduleId, version: moduleId.version }, moduleRuntimeEnvironment, runtimeParams);
     }
     // Queue up uri requests

package/build/es/object.js

@@ -18,7 +18,8 @@ function _deepFreeze(obj, maxDepth, depth) {
  */
 // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
 export function deepFreeze(obj, maxDepth = 5) {
-    return _deepFreeze(obj, maxDepth, 0);
+    const objClone = JSON.parse(JSON.stringify(obj));
+    return _deepFreeze(objClone, maxDepth, 0);
 }
 /**
  * Returns a function which debounces when the input function is called with the same first argument

package/build/es/serialize.d.ts

@@ -1,4 +1,4 @@
-import { LinkedModuleDefinition, ModuleJsonDefinition, ModuleRegistry, RuntimeParams } from '@lwrjs/types';
+import type { LinkedModuleDefinition, ModuleJsonDefinition, ModuleRegistry, RuntimeParams } from '@lwrjs/types';
 /**
  * Take a Module Definition and return its JSON serialization
  *
@@ -19,4 +19,11 @@ export declare function replaceStringFromLocation(src: string, { startOffset, en
     startOffset: number;
     endOffset: number;
 }, replaceValue: string): string;
+/**
+ * Given two TTLs, return the shortest one
+ * @param newTtl - time-to-live: time string or number of seconds
+ * @param oldTtl - the current shortest TTL (if it exists)
+ * @returns - the shorter of the two TTLs IN SECONDS, undefined if both TTLs are missing
+ */
+export declare function shortestTtl(newTtl?: string | number, oldTtl?: string | number): number | undefined;
 //# sourceMappingURL=serialize.d.ts.map

package/build/es/serialize.js

@@ -1,3 +1,4 @@
+import ms from 'ms';
 // Given a Module Identifier, return a JSON entry
 async function createJsonModule(moduleId, moduleRegistry, runtimeEnvironment, runtimeParams) {
     const { ownHash, moduleEntry: { version }, } = await moduleRegistry.getModule(moduleId, runtimeParams);
@@ -6,7 +7,7 @@ async function createJsonModule(moduleId, moduleRegistry, runtimeEnvironment, ru
         version,
         ownHash,
         links: {
-            self: moduleRegistry.resolveModuleUri(moduleId, runtimeEnvironment, runtimeParams, ownHash),
+            self: await moduleRegistry.resolveModuleUri(moduleId, runtimeEnvironment, runtimeParams, ownHash),
         },
     };
 }
@@ -42,4 +43,21 @@ export async function serializeModuleToJson(code = '', { specifier, version, own
 export function replaceStringFromLocation(src, { startOffset, endOffset }, replaceValue) {
     return src.substr(0, startOffset) + replaceValue + src.substr(endOffset, src.length);
 }
+/**
+ * Given two TTLs, return the shortest one
+ * @param newTtl - time-to-live: time string or number of seconds
+ * @param oldTtl - the current shortest TTL (if it exists)
+ * @returns - the shorter of the two TTLs IN SECONDS, undefined if both TTLs are missing
+ */
+export function shortestTtl(newTtl, oldTtl) {
+    if (!newTtl && !oldTtl)
+        return undefined;
+    const newSeconds = typeof newTtl === 'string' ? ms(newTtl) / 1000 : newTtl;
+    const oldSeconds = typeof oldTtl === 'string' ? ms(oldTtl) / 1000 : oldTtl;
+    if (!newSeconds)
+        return oldSeconds;
+    if (!oldSeconds)
+        return newSeconds;
+    return newSeconds < oldSeconds ? newSeconds : oldSeconds;
+}
 //# sourceMappingURL=serialize.js.map

package/build/es/site-metadata.d.ts

@@ -0,0 +1,27 @@
+import type { SiteAssets, SiteBundles, SiteMetadata, SiteResources } from '@lwrjs/types';
+declare type Options = {
+    rootDir: string;
+};
+export declare class SiteMetadataImpl implements SiteMetadata {
+    private options;
+    private siteBundles;
+    private siteResources;
+    private siteAssets;
+    constructor(options: Options);
+    getSiteRootDir(): string;
+    getSiteBundles(): SiteBundles;
+    getSiteResources(): SiteResources;
+    getSiteAssets(): SiteAssets;
+    persistSiteMetadata(): Promise<void>;
+    private readStaticBundleMetadata;
+    /**
+     * Read the metadata about the pre-built resources of the current site.
+     */
+    private readStaticResourceMetadata;
+    /**
+     * Read the metadata about the pre-built assets of the current site.
+     */
+    private readStaticAssetsMetadata;
+}
+export {};
+//# sourceMappingURL=site-metadata.d.ts.map

package/build/es/site-metadata.js

@@ -0,0 +1,111 @@
+import path from 'path';
+import fs from 'fs-extra';
+import { logger } from './logger.js';
+const SITE_METADATA_PATH = '.metadata';
+const STATIC_BUNDLE_METADATA_PATH = path.join(SITE_METADATA_PATH, '/bundle-metadata.json');
+const STATIC_RESOURCE_METADATA_PATH = path.join(SITE_METADATA_PATH, '/resource-metadata.json');
+const STATIC_ASSET_METADATA_PATH = path.join(SITE_METADATA_PATH, '/asset-metadata.json');
+export class SiteMetadataImpl {
+    constructor(options) {
+        this.options = options;
+        this.siteBundles = this.readStaticBundleMetadata(options.rootDir);
+        this.siteResources = this.readStaticResourceMetadata(options.rootDir);
+        this.siteAssets = this.readStaticAssetsMetadata(options.rootDir);
+    }
+    getSiteRootDir() {
+        return this.options.rootDir;
+    }
+    getSiteBundles() {
+        return this.siteBundles;
+    }
+    getSiteResources() {
+        return this.siteResources;
+    }
+    getSiteAssets() {
+        return this.siteAssets;
+    }
+    async persistSiteMetadata() {
+        // Create the metadata directory if if does not exist
+        const siteMetadataPath = path.join(this.options.rootDir, SITE_METADATA_PATH);
+        try {
+            if (!(await fs.pathExists(siteMetadataPath))) {
+                await fs.mkdir(siteMetadataPath, { recursive: true });
+            }
+            // Save Bundle Metadata
+            const bundleMetadataPath = path.join(this.options.rootDir, STATIC_BUNDLE_METADATA_PATH);
+            await fs.writeJSON(bundleMetadataPath, this.siteBundles, { spaces: 2 });
+            // Save Resource Metadata
+            const resourceMetadataPath = path.join(this.options.rootDir, STATIC_RESOURCE_METADATA_PATH);
+            await fs.writeJSON(resourceMetadataPath, this.siteResources, { spaces: 2 });
+            // Save Resource Metadata
+            const assetMetadataPath = path.join(this.options.rootDir, STATIC_ASSET_METADATA_PATH);
+            return fs.writeJSON(assetMetadataPath, this.siteAssets, { spaces: 2 });
+        }
+        catch (err) {
+            console.error(`[SiteMetadata] Failed to save site metadata ${siteMetadataPath}`);
+            console.error(err);
+        }
+    }
+    readStaticBundleMetadata(staticRoot) {
+        let bundleMetadataPath;
+        let siteBundles = { bundles: {} };
+        try {
+            bundleMetadataPath = path.join(staticRoot, STATIC_BUNDLE_METADATA_PATH);
+            const savedMetadata = fs.readJSONSync(bundleMetadataPath);
+            siteBundles = savedMetadata;
+        }
+        catch (error) {
+            if (error.code === 'ENOENT') {
+                logger.debug(`[SiteMetadata] Failed to load Static Bundle Metadata: ${bundleMetadataPath}`);
+            }
+            else {
+                throw error;
+            }
+        }
+        return siteBundles;
+    }
+    /**
+     * Read the metadata about the pre-built resources of the current site.
+     */
+    readStaticResourceMetadata(staticRoot) {
+        let resourceMetadataPath;
+        let siteResources = { resources: {} };
+        try {
+            resourceMetadataPath = path.join(staticRoot, STATIC_RESOURCE_METADATA_PATH);
+            const savedMetadata = fs.readJSONSync(resourceMetadataPath);
+            siteResources = savedMetadata;
+        }
+        catch (error) {
+            if (error.code === 'ENOENT') {
+                logger.debug(`[SiteMetadata] Failed to load Static Resource Metadata: ${resourceMetadataPath}`);
+            }
+            else {
+                throw error;
+            }
+        }
+        return siteResources;
+    }
+    /**
+     * Read the metadata about the pre-built assets of the current site.
+     */
+    readStaticAssetsMetadata(staticRoot) {
+        let assetMetadataPath;
+        let siteAssets = {
+            assets: {},
+        };
+        try {
+            assetMetadataPath = path.join(staticRoot, STATIC_ASSET_METADATA_PATH);
+            siteAssets = fs.readJSONSync(assetMetadataPath);
+        }
+        catch (error) {
+            if (error.code === 'ENOENT') {
+                logger.debug(`[SiteMetadata] Failed to load Static Resource Metadata: ${assetMetadataPath}`);
+            }
+            else {
+                throw error;
+            }
+        }
+        return siteAssets;
+    }
+}
+//# sourceMappingURL=site-metadata.js.map

package/build/es/typescript.js

@@ -1,8 +1,9 @@
 import fs from 'fs';
 import { join, dirname, extname } from 'path';
 import esbuildEsm from 'esbuild';
-// Workaround until this is fixed:
 // https://github.com/evanw/esbuild/issues/706
+// Fixed in 0.11.0 but upgrading past 0.9.7 has caused breaking changes for consumers...
+// https://github.com/salesforce-experience-platform-emu/lwr/issues/1014
 let esbuild = esbuildEsm;
 if (!esbuildEsm) {
     try {

package/package.json

@@ -4,18 +4,18 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.9.0-alpha.3",
+    "version": "0.9.0-alpha.30",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
-        "url": "https://github.com/salesforce/lwr.git",
+        "url": "https://github.com/salesforce-experience-platform-emu/lwr.git",
         "directory": "packages/@lwrjs/shared-utils"
     },
     "scripts": {
         "build": "tsc -b"
     },
     "bugs": {
-        "url": "https://github.com/salesforce/lwr/issues"
+        "url": "https://github.com/salesforce-experience-platform-emu/lwr/issues"
     },
     "type": "module",
     "types": "build/es/index.d.ts",
@@ -25,6 +25,18 @@
         ".": {
             "import": "./build/es/index.js",
             "require": "./build/cjs/index.cjs"
+        },
+        "./fs-watch": {
+            "import": "./build/es/fs-watch.js",
+            "require": "./build/cjs/fs-watch.cjs"
+        },
+        "./typescript": {
+            "import": "./build/es/typescript.js",
+            "require": "./build/cjs/typescript.cjs"
+        },
+        "./compiler": {
+            "import": "./build/es/compiler.js",
+            "require": "./build/cjs/compiler.cjs"
         }
     },
     "files": [
@@ -33,25 +45,29 @@
         "build/**/*.d.ts"
     ],
     "dependencies": {
-        "chokidar": "^3.4.0",
         "es-module-lexer": "^0.3.18",
-        "esbuild": "^0.9.7",
         "fast-json-stable-stringify": "^2.1.0",
         "magic-string": "^0.25.7",
         "mime-types": "^2.1.33",
+        "ms": "^2.1.3",
         "parse5-sax-parser": "^6.0.1",
         "path-to-regexp": "^6.2.0",
-        "slugify": "^1.4.5",
-        "winston": "^3.7.2"
+        "slugify": "^1.4.5"
+    },
+    "peerDependencies": {
+        "@locker/compiler": "0.18.14",
+        "chokidar": "^3.5.3",
+        "esbuild": "^0.9.7",
+        "rollup": "~2.45.2"
     },
     "devDependencies": {
-        "@lwrjs/diagnostics": "0.9.0-alpha.3",
-        "@lwrjs/types": "0.9.0-alpha.3",
+        "@lwrjs/diagnostics": "0.9.0-alpha.30",
+        "@lwrjs/types": "0.9.0-alpha.30",
         "@types/mime-types": "2.1.1",
         "@types/path-to-regexp": "^1.7.0"
     },
     "engines": {
-        "node": ">=14.15.4 <19"
+        "node": ">=16.0.0 <20"
     },
-    "gitHead": "3e96a852db94afbbfbc6558098303a85acd6604d"
+    "gitHead": "6e18768b8e47066c41ae0b792bf4aa766b0b784b"
 }