@lwc/hmr-client 10.0.0 → 10.0.1-test.267

package/dist/__tests__/api.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/client/client.d.ts

@@ -0,0 +1,38 @@
+import JSONWebSocket from '../utils/json-web-socket';
+import { TypedEventTarget } from '../utils/typed-event-target';
+import { HotModuleHandler } from './hot-module-handler';
+type HmrClientEvent = {
+    modulePath: string;
+};
+type HmrClientEvents = {
+    'hmr:update': HmrClientEvent;
+    'hmr:delete': HmrClientEvent;
+    'hmr:create': HmrClientEvent;
+    'hmr:hot-swapped': HmrClientEvent;
+    'hmr:close': void;
+};
+export declare class HMRClient {
+    moduleHandlerHooks: HotModuleHandler;
+    ws: JSONWebSocket;
+    private eventTarget;
+    constructor(ws: JSONWebSocket, moduleHandlerHooks: HotModuleHandler);
+    /**
+     * Register all modules that have been registered at this point.
+     * This function is usually called upon hmr-client initialization.
+     */
+    registerAllModules(): void;
+    /**
+     * Register any new modules that have been registered.
+     */
+    registerPendingModules(): void;
+    messageCallback(data: unknown): void;
+    /**
+     * Send a message to the dev server to send a hot module.
+     * The send and receive messages are asyncronous.
+     * @param modulePath the module to be fetched
+     */
+    fetchModule(modulePath: string): void;
+    addEventListener: TypedEventTarget<HmrClientEvents>['addEventListener'];
+    removeEventListener: TypedEventTarget<HmrClientEvents>['removeEventListener'];
+}
+export {};

package/dist/client/hot-module-handler.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This interface defines capabilities that need to be implemented by the container to handle hot module
+ * updates.
+ */
+export interface HotModuleHandler {
+    /**
+     * Fetch all dependencies that are required for a hot module before its evaluation.
+     * @param moduleSpecifiers List of dependent modules specifiers.
+     */
+    fetchDependencies(moduleSpecifiers: string[]): Promise<any>;
+    /**
+     * Evalaute a given Javascript source code.
+     * @param source Javascript in string format.
+     */
+    evaluateModule(ownerModuleId: string, hotModulePath: string, source: string): Promise<unknown>;
+}

package/dist/client/index.d.ts

@@ -0,0 +1,18 @@
+import { Auth_Challenge, Auth_Response } from '@lwc/lwc-dev-server-types';
+import { HotModuleHandler } from './hot-module-handler';
+import { HMRClient } from './client';
+type AuthConfig = {
+    authChallengeData: Auth_Challenge;
+    authResponseCallback: (response: Auth_Response) => boolean;
+};
+/**
+ * Initialize the hmr-client.
+ * @param url The lightning dev preview server to connect to. Provide the fully qualified WebSocketServer url, for example 'wss://localhost:8999'
+ * @param target The type of client being served. Currently only supports 'LEX.
+ * @param hotModuleHandler Callback hooks that the hmr-client will utilize to handle hot modules. The callbacks are implemented by the container.
+ * @param authConfig Optional authentication configuration if the hmr-client needs to establish an authenticated connection.
+ *
+ * @returns {HMRClient} the HMR Client
+ */
+export declare function initializeClient(url: string, _target: string, hotModuleHandler: HotModuleHandler, authConfig?: AuthConfig): Promise<HMRClient>;
+export {};

package/dist/client/index.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/consoleLogger.d.ts

@@ -0,0 +1,3 @@
+export declare function logError(message: string): void;
+export declare function logWarning(message: string): void;
+export declare function logInfo(message: string): void;

package/dist/utils/index.d.ts

@@ -0,0 +1 @@
+export declare function debounce(callback: Function, delay: number): () => void;

package/dist/utils/json-web-socket.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Wrapper on WebSocket to handle JSON serialization/deserialization
+ */
+export default class JSONWebSocket {
+    socket: WebSocket;
+    private constructor();
+    send(data: object): void;
+    onMessage(callback: (data: unknown) => void): void;
+    close(): void;
+    static init(url: string, protocols?: string[] | string): Promise<JSONWebSocket>;
+}

package/dist/utils/module-util.d.ts

@@ -0,0 +1,10 @@
+export declare function extractDescriptorsFromSource(src: string): {
+    parentDescriptor: string;
+    deps: string[];
+} | undefined;
+/**
+ * Adapt source provided by dev server to LEX format.
+ * Note: This logic comes from [core:]BundleModuleDefFactory.processCompiledCode()
+ * @param src compiled module file
+ */
+export declare function adaptSourceForLex(src: string, hotModulePath: string, parentDescriptor: string): string;

package/dist/utils/typed-event-target.d.ts

@@ -0,0 +1,14 @@
+type NonVoidKeys<T> = {
+    [P in keyof T]: T[P] extends void ? P : never;
+}[keyof T];
+export declare class TypedEventTarget<T extends {
+    [k: string]: any;
+}> {
+    #private;
+    constructor();
+    addEventListener<K extends Extract<keyof T, string>>(type: K, listener: (event: CustomEvent<T[K]>) => void): void;
+    removeEventListener<K extends Extract<keyof T, string>>(type: K, listener: (event: CustomEvent<T[K]>) => void): void;
+    dispatch<K extends NonVoidKeys<T>>(type: K): boolean;
+    dispatch<K extends Extract<keyof T, string>>(type: K, detail: T[K]): boolean;
+}
+export {};

package/dist/utils/typed-event-target.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@lwc/hmr-client",
     "description": "Provide hot module reloading capabilities to @lwc/engine-dom.",
-    "version": "10.0.0",
+    "version": "10.0.1-test.267+03d683d",
     "keywords": [
         "lwc dev server",
         "lwc hmr plugin"
@@ -19,7 +19,7 @@
         "clean": "rimraf dist/ && rimraf node_modules/"
     },
     "devDependencies": {
-        "@lwc/lwc-dev-server-types": "10.0.0",
+        "@lwc/lwc-dev-server-types": "10.0.1-test.267+03d683d",
         "@types/websocket": "^1.0.10"
     },
     "peerDependencies": {
@@ -35,5 +35,6 @@
         "expose": [
             "@lwc/hmr-client"
         ]
-    }
+    },
+    "gitHead": "03d683dddcb5e7bb2e7eb92393df32432c1cd661"
 }