@lwrjs/loader 0.13.0-alpha.2 → 0.13.0-alpha.21

package/build/shim-legacy/shimLegacy.js

@@ -0,0 +1,188 @@
+/* global document */
+import { BOOTSTRAP_ERROR } from 'lwr/metrics';
+import { logOperationStart, logOperationEnd } from 'lwr/profiler';
+import { createLoader } from './loaderLegacy.js';
+import { REQUIRED_MODULES_TIMEOUT } from '../shim/constants.js';
+import { customInit } from '../shim/customInit.js';
+/* eslint-disable lwr/no-unguarded-apis */
+const hasSetTimeout = typeof setTimeout === 'function';
+const hasConsole = typeof console !== 'undefined';
+/* eslint-enable lwr/no-unguarded-apis */
+export default class LoaderShim {
+    constructor(global) {
+        this.defineCache = {};
+        this.orderedDefs = [];
+        // Start watchdog timer
+        if (hasSetTimeout) {
+            this.watchdogTimerId = this.startWatchdogTimer();
+        }
+        // Parse configuration
+        this.global = global;
+        this.config = global.LWR;
+        this.loaderModule = 'lwr/loaderLegacy/v/__VERSION__';
+        // Set up error handler
+        this.errorHandler = this.config.onError;
+        // Set up the temporary LWR.define function and customInit hook
+        const tempDefine = this.tempDefine.bind(this);
+        global.LWR.define = tempDefine;
+        this.bootReady = this.config.autoBoot;
+        try {
+            this.createProfilerModule(global.LWR.define);
+            customInit(Object.freeze(this.config), this.postCustomInit.bind(this), tempDefine, (e) => {
+                // customInit handlers can overwrite
+                // the error handler with onBootstrapError
+                this.errorHandler = e;
+            });
+        }
+        catch (e) {
+            this.enterErrorState(e);
+        }
+    }
+    // Return true if the app can be initialized
+    canInit() {
+        if (!this.config.requiredModules) {
+            throw new Error('Unexpected missing requiredModules');
+        }
+        // Initialize the app if:
+        //  - bootReady: autoBoot is on OR customInit has finished
+        //  - all required modules are defined
+        const allDefined = this.config.requiredModules.every((m) => this.orderedDefs.includes(m));
+        return this.bootReady && allDefined;
+    }
+    /**
+     * Create a temporary LWR.define() function which captures all
+     * calls that occur BEFORE the full loader module is available
+     *
+     * Each call to LWR.define() is stored in 2 ways:
+     *      - in a map as [moduleName, arguments] pairs
+     *      - each moduleName is pushed onto an array, to preserve
+     *          the order in which the modules were defined
+     */
+    tempDefine(...args) {
+        // Cache the incoming module
+        const moduleName = args[0];
+        this.defineCache[moduleName] = args;
+        this.orderedDefs.push(moduleName);
+        if (this.canInit()) {
+            if (hasSetTimeout) {
+                // requiredModules are defined, clear watchdog timer
+                // eslint-disable-next-line lwr/no-unguarded-apis, no-undef
+                clearTimeout(this.watchdogTimerId);
+            }
+            this.initApp();
+        }
+    }
+    // Called by the customInit hook via lwr.initializeApp()
+    postCustomInit() {
+        this.bootReady = true;
+        if (this.canInit()) {
+            if (hasSetTimeout) {
+                // requiredModules are defined, clear watchdog timer
+                // eslint-disable-next-line lwr/no-unguarded-apis, no-undef
+                clearTimeout(this.watchdogTimerId);
+            }
+            this.initApp();
+        }
+    }
+    // Create the loader and initialize the application
+    initApp() {
+        try {
+            const loaderConfig = {
+                baseUrl: this.config.baseUrl,
+                profiler: { logOperationStart, logOperationEnd },
+                // TODO: can be removed following https://github.com/salesforce-experience-platform-emu/lwr/issues/1087
+                appMetadata: {
+                    appId: this.config.appId,
+                    bootstrapModule: this.config.bootstrapModule,
+                    rootComponent: this.config.rootComponent,
+                    rootComponents: this.config.rootComponents,
+                },
+            };
+            const loader = createLoader(this.loaderModule, this.defineCache[this.loaderModule], loaderConfig, this.config.preloadModules);
+            this.mountApp(loader);
+        }
+        catch (e) {
+            this.enterErrorState(e);
+        }
+    }
+    waitForDOMContentLoaded() {
+        // eslint-disable-next-line lwr/no-unguarded-apis
+        if (typeof document === undefined) {
+            return Promise.resolve();
+        }
+        // Resolve if document is already "ready" https://developer.mozilla.org/en-US/docs/Web/API/Document/readyState
+        // eslint-disable-next-line lwr/no-unguarded-apis
+        if (document.readyState === 'interactive' || document.readyState === 'complete') {
+            return Promise.resolve();
+        }
+        return new Promise((resolve) => {
+            // eslint-disable-next-line lwr/no-unguarded-apis
+            document.addEventListener('DOMContentLoaded', () => {
+                resolve();
+            });
+        });
+    }
+    // Create a module out of the profiler
+    // Note: The profiler is also available as a module through lwc module resolution (see package.json)
+    createProfilerModule(define) {
+        const exporter = (exports) => {
+            Object.assign(exports, { logOperationStart, logOperationEnd });
+        };
+        define('lwr/profiler/v/__VERSION__', ['exports'], exporter, {});
+    }
+    // Set up the application globals, import map, root custom element...
+    mountApp(loader) {
+        const { bootstrapModule, rootComponent, importMappings, rootComponents, serverData, endpoints } = this.config;
+        // Set global LWR.define to loader.define
+        this.global.LWR = Object.freeze({
+            define: loader.define.bind(loader),
+            rootComponent,
+            rootComponents,
+            serverData: serverData || {},
+            importMappings,
+            endpoints,
+            env: this.global.LWR.env,
+        });
+        // Redefine all modules in the temporary cache
+        this.orderedDefs.forEach((specifier) => {
+            if (specifier !== this.loaderModule) {
+                loader.define(...this.defineCache[specifier]);
+            }
+        });
+        // by default, app initialization is gated on waiting for document to be parsed (via DOMContentLoaded)
+        const { disableInitDefer } = this.config;
+        // Load the import mappings and application bootstrap module
+        loader
+            .registerImportMappings(importMappings)
+            .then(() => {
+            if (!disableInitDefer) {
+                return this.waitForDOMContentLoaded();
+            }
+        })
+            .then(() => loader.load(bootstrapModule))
+            .catch((reason) => {
+            this.enterErrorState(new Error(`Application ${rootComponent || bootstrapModule} could not be loaded: ${reason}`));
+        });
+    }
+    // Trigger bootstrap error state, and call error handler if registered
+    enterErrorState(error) {
+        logOperationStart({ id: BOOTSTRAP_ERROR });
+        if (this.errorHandler) {
+            this.errorHandler(error);
+        }
+        else {
+            if (hasConsole) {
+                // eslint-disable-next-line lwr/no-unguarded-apis, no-undef
+                console.error(`An error occurred during LWR bootstrap. ${error.message}`, error.stack);
+            }
+        }
+    }
+    // eslint-disable-next-line no-undef, lwr/no-unguarded-apis
+    startWatchdogTimer() {
+        // eslint-disable-next-line lwr/no-unguarded-apis, no-undef
+        return setTimeout(() => {
+            this.enterErrorState(new Error('Failed to load required modules - timed out'));
+        }, REQUIRED_MODULES_TIMEOUT);
+    }
+}
+//# sourceMappingURL=shimLegacy.js.map

package/build/types.d.ts

@@ -0,0 +1,56 @@
+import type { ImportMetadata, AppMetadata, ServerData, ClientBootstrapConfig } from '@lwrjs/types';
+import type { ImportMap } from './modules/lwr/loaderLegacy/importMap/importMap.js';
+import type { ProfilerAPI, LogDispatcher } from 'lwr/profiler';
+export type GlobalThis = {
+    LWR: Partial<ClientBootstrapConfig> & {
+        define: LoaderDefine;
+    };
+    [key: string]: unknown;
+};
+export type LoaderDefine = (id: string, deps: string[], exporter: Function, hash?: object) => void;
+export type DefineArguments = [string, string[], Function, object?];
+export type LoaderClass = {
+    new (config?: LoaderConfig): LoaderAPI;
+};
+export interface BaseLoaderAPI {
+    define: LoaderDefine;
+    load(id: string): Promise<unknown>;
+    registerExternalModules(modules: string[]): void;
+    services: Record<string, Function>;
+}
+export interface LoaderAPI extends BaseLoaderAPI {
+    registerImportMappings(mappings?: ImportMap): Promise<void>;
+}
+export type LoaderConfig = {
+    baseUrl?: string;
+    profiler: ProfilerAPI;
+    serverData?: ServerData;
+    appMetadata?: AppMetadata;
+};
+export type CustomErrorHandler = (error: Error) => void;
+export type RegisterCustomErrorHandler = (callback: CustomErrorHandler) => void;
+export type InitializeApp = () => void;
+export interface CustomInitAPI {
+    initializeApp: InitializeApp;
+    onBootstrapError: RegisterCustomErrorHandler;
+    attachDispatcher: (dispatcher: LogDispatcher) => void;
+    define: LoaderDefine;
+}
+export type CustomInitFunction = (lwr: CustomInitAPI, config: ClientBootstrapConfig) => void;
+export type Endpoints = {
+    uris: Record<string, string>;
+    modifiers?: Record<string, string>;
+};
+/**
+ * Fingerprints loader extensions
+ */
+export interface FingerprintsLoaderAPI extends BaseLoaderAPI {
+    registerImportMappings(importMetadata: ImportMetadata, rootSpecifiers: string[]): Promise<void>;
+}
+export interface FingerprintsLoaderConfig extends LoaderConfig {
+    endpoints?: Endpoints;
+}
+export type FingerprintsLoaderClass = {
+    new (config?: LoaderConfig): FingerprintsLoaderAPI;
+};
+//# sourceMappingURL=types.d.ts.map

package/build/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/package.json

@@ -5,7 +5,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.13.0-alpha.2",
+    "version": "0.13.0-alpha.21",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -24,9 +24,8 @@
             "import": "./build/index.js",
             "require": "./build/cjs/index.cjs"
         },
-        "./metrics": {
-            "import": "./build/metrics.js",
-            "require": "./build/cjs/metrics.cjs"
+        "./types": {
+            "import": "./build/types.js"
         },
         "./prod-error-shim": "./build/assets/prod/lwr-error-shim.js",
         "./prod-loader-shim": "./build/assets/prod/lwr-loader-shim.js",
@@ -61,17 +60,17 @@
         "build": "yarn build:ts && yarn build:error-shim && yarn build:shim && yarn build:loader && yarn build:shim:bundle && yarn build:shim:bundle:minify"
     },
     "devDependencies": {
-        "@locker/trusted-types": "0.22.1",
-        "@lwrjs/diagnostics": "0.13.0-alpha.2",
-        "@lwrjs/types": "0.13.0-alpha.2",
+        "@locker/trusted-types": "0.22.3",
+        "@lwrjs/diagnostics": "0.13.0-alpha.21",
+        "@lwrjs/types": "0.13.0-alpha.21",
         "@rollup/plugin-node-resolve": "^15.2.3",
         "@rollup/plugin-sucrase": "^5.0.2",
         "@rollup/plugin-terser": "^0.4.4",
         "rollup": "^2.78.0"
     },
     "dependencies": {
-        "@lwrjs/client-modules": "0.13.0-alpha.2",
-        "@lwrjs/shared-utils": "0.13.0-alpha.2"
+        "@lwrjs/client-modules": "0.13.0-alpha.21",
+        "@lwrjs/shared-utils": "0.13.0-alpha.21"
     },
     "lwc": {
         "modules": [
@@ -91,5 +90,5 @@
     "volta": {
         "extends": "../../../package.json"
     },
-    "gitHead": "3ae1051ef1eb282f9c1fb54f6aab44ab5ba48480"
+    "gitHead": "d272dcd07881fa469ee73bd28d2f30f99957e122"
 }