@rspack/plugin-react-refresh 1.0.1 → 1.0.3

package/README.md

@@ -146,6 +146,8 @@ It is most useful when multiple instances of React Refresh is running together s
 
 Modify the behavior of the error overlay.
 
+Checkout [OverlayOptions](https://github.com/rspack-contrib/rspack-plugin-react-refresh/blob/main/src/options.ts#L4) type signature for more details.
+
 - Enable the error overlay:
 
 ```js

package/dist/index.js

@@ -7,6 +7,18 @@ const options_1 = require("./options");
 const paths_1 = require("./paths");
 const getAdditionalEntries_1 = require("./utils/getAdditionalEntries");
 const getSocketIntegration_1 = require("./utils/getSocketIntegration");
+const getIntegrationEntry_1 = require("./utils/getIntegrationEntry");
+function addEntry(entry, compiler) {
+    new compiler.webpack.EntryPlugin(compiler.context, entry, {
+        name: undefined,
+    }).apply(compiler);
+}
+function addSocketEntry(sockIntegration, compiler) {
+    const integrationEntry = (0, getIntegrationEntry_1.getIntegrationEntry)(sockIntegration);
+    if (integrationEntry) {
+        addEntry(integrationEntry, compiler);
+    }
+}
 class ReactRefreshRspackPlugin {
     constructor(options = {}) {
         this.options = (0, options_1.normalizeOptions)(options);
@@ -27,14 +39,14 @@ class ReactRefreshRspackPlugin {
             options: this.options,
         });
         for (const entry of addEntries.prependEntries) {
-            new compiler.webpack.EntryPlugin(compiler.context, entry, {
-                name: undefined,
-            }).apply(compiler);
+            addEntry(entry, compiler);
+        }
+        if (this.options.overlay !== false &&
+            this.options.overlay.sockIntegration) {
+            addSocketEntry(this.options.overlay.sockIntegration, compiler);
         }
         for (const entry of addEntries.overlayEntries) {
-            new compiler.webpack.EntryPlugin(compiler.context, entry, {
-                name: undefined,
-            }).apply(compiler);
+            addEntry(entry, compiler);
         }
         new compiler.webpack.ProvidePlugin({
             $ReactRefreshRuntime$: paths_1.reactRefreshPath,

package/dist/options.d.ts

@@ -3,7 +3,7 @@ import type { IntegrationType } from './utils/getSocketIntegration';
 interface OverlayOptions {
     entry: string;
     module: string;
-    sockIntegration: IntegrationType;
+    sockIntegration: IntegrationType | false;
     sockHost?: string;
     sockPath?: string;
     sockPort?: string;

package/dist/sockets/WHMEventSource.d.ts

@@ -0,0 +1,36 @@
+/**
+ * The following code is modified based on
+ * https://github.com/pmmmwh/react-refresh-webpack-plugin/blob/f770d3962c388da01eeda7079bff5f40c93992d2/sockets/WHMEventSource.js
+ *
+ * MIT Licensed
+ * Author Michael Mok
+ * Copyright (c) 2019 Michael Mok
+ * https://github.com/pmmmwh/react-refresh-webpack-plugin/blob/f770d3962c388da01eeda7079bff5f40c93992d2/LICENSE
+ */
+/**
+ * The hard-coded singleton key for webpack-hot-middleware's client instance.
+ *
+ * [Ref](https://github.com/webpack-contrib/webpack-hot-middleware/blob/cb29abb9dde435a1ac8e9b19f82d7d36b1093198/client.js#L152)
+ */
+declare const singletonKey = "__webpack_hot_middleware_reporter__";
+interface WHMClient {
+    cleanProblemsCache: () => void;
+    problems: () => boolean;
+    success: () => void;
+    useCustomOverlay: (customOverlay: {
+        showProblems: (type: string, data: string[]) => void;
+        clear: () => void;
+    }) => void;
+}
+declare global {
+    interface Window {
+        [singletonKey]: WHMClient;
+    }
+}
+/**
+ * Initializes a socket server for HMR for webpack-hot-middleware.
+ * @param {function(*): void} messageHandler A handler to consume Webpack compilation messages.
+ * @returns {void}
+ */
+export declare function init(messageHandler: (...args: unknown[]) => void): void;
+export {};

package/dist/sockets/WHMEventSource.js

@@ -0,0 +1,34 @@
+"use strict";
+/**
+ * The following code is modified based on
+ * https://github.com/pmmmwh/react-refresh-webpack-plugin/blob/f770d3962c388da01eeda7079bff5f40c93992d2/sockets/WHMEventSource.js
+ *
+ * MIT Licensed
+ * Author Michael Mok
+ * Copyright (c) 2019 Michael Mok
+ * https://github.com/pmmmwh/react-refresh-webpack-plugin/blob/f770d3962c388da01eeda7079bff5f40c93992d2/LICENSE
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.init = init;
+/**
+ * The hard-coded singleton key for webpack-hot-middleware's client instance.
+ *
+ * [Ref](https://github.com/webpack-contrib/webpack-hot-middleware/blob/cb29abb9dde435a1ac8e9b19f82d7d36b1093198/client.js#L152)
+ */
+const singletonKey = '__webpack_hot_middleware_reporter__';
+/**
+ * Initializes a socket server for HMR for webpack-hot-middleware.
+ * @param {function(*): void} messageHandler A handler to consume Webpack compilation messages.
+ * @returns {void}
+ */
+function init(messageHandler) {
+    const client = window[singletonKey];
+    client.useCustomOverlay({
+        showProblems(type, data) {
+            messageHandler({ type, data });
+        },
+        clear() {
+            messageHandler({ type: 'ok' });
+        },
+    });
+}

package/dist/utils/getIntegrationEntry.d.ts

@@ -0,0 +1,7 @@
+import type { IntegrationType } from './getSocketIntegration';
+/**
+ * Gets entry point of a supported socket integration.
+ * @param integrationType A valid socket integration type or a path to a module.
+ * @returns Path to the resolved integration entry point.
+ */
+export declare function getIntegrationEntry(integrationType: IntegrationType): string | undefined;

package/dist/utils/getIntegrationEntry.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getIntegrationEntry = getIntegrationEntry;
+/**
+ * Gets entry point of a supported socket integration.
+ * @param integrationType A valid socket integration type or a path to a module.
+ * @returns Path to the resolved integration entry point.
+ */
+function getIntegrationEntry(integrationType) {
+    let resolvedEntry;
+    switch (integrationType) {
+        case 'whm': {
+            resolvedEntry = 'webpack-hot-middleware/client';
+            break;
+        }
+    }
+    return resolvedEntry;
+}

package/dist/utils/getSocketIntegration.d.ts

@@ -1,2 +1,2 @@
-export type IntegrationType = 'wds';
+export type IntegrationType = 'wds' | 'whm' | (string & {});
 export declare function getSocketIntegration(integrationType: IntegrationType): string;

package/dist/utils/getSocketIntegration.js

@@ -8,6 +8,10 @@ function getSocketIntegration(integrationType) {
             resolvedSocketIntegration = require.resolve('../sockets/WDSSocket');
             break;
         }
+        case 'whm': {
+            resolvedSocketIntegration = require.resolve('../sockets/WHMEventSource');
+            break;
+        }
         default: {
             resolvedSocketIntegration = require.resolve(integrationType);
             break;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspack/plugin-react-refresh",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "repository": "https://github.com/rspack-contrib/rspack-plugin-react-refresh",
   "license": "MIT",
   "description": "React refresh plugin for rspack",
@@ -30,9 +30,8 @@
   "devDependencies": {
     "@biomejs/biome": "^1.9.4",
     "@rspack/core": "1.1.4",
-    "@types/node": "^22.10.1",
     "@types/jest": "29.5.14",
-    "react-refresh": "^0.14.2",
+    "@types/node": "^22.10.1",
     "cross-env": "^7.0.3",
     "execa": "9.5.1",
     "fs-extra": "11.2.0",
@@ -40,20 +39,24 @@
     "jest-cli": "29.7.0",
     "jest-environment-node": "29.7.0",
     "nano-staged": "^0.8.0",
+    "react-refresh": "^0.14.2",
     "semver": "7.6.3",
     "simple-git-hooks": "^2.11.1",
     "ts-jest": "29.2.5",
-    "typescript": "5.7.2"
+    "ts-node": "^10.9.2",
+    "typescript": "5.7.2",
+    "@continuous-auth/client": "2.3.2"
   },
   "dependencies": {
     "error-stack-parser": "^2.1.4",
     "html-entities": "^2.5.2"
   },
   "peerDependencies": {
-    "react-refresh": ">=0.10.0 <1.0.0"
+    "react-refresh": ">=0.10.0 <1.0.0",
+    "webpack-hot-middleware": "2.x"
   },
   "peerDependenciesMeta": {
-    "react-refresh": {
+    "webpack-hot-middleware": {
       "optional": true
     }
   },