@rspack/plugin-react-refresh 1.0.0-beta.1 → 1.0.0-beta.3

package/dist/index.d.ts

@@ -1,11 +1,6 @@
 import type { Compiler } from "@rspack/core";
-import { type NormalizedPluginOptions, type PluginOptions } from "./options";
+import type { NormalizedPluginOptions, PluginOptions } from "./options";
 export type { PluginOptions };
-/**
- * @typedef {Object} Options
- * @property {(string | RegExp | (string | RegExp)[] | null)=} include included resourcePath for loader
- * @property {(string | RegExp | (string | RegExp)[] | null)=} exclude excluded resourcePath for loader
- */
 declare class ReactRefreshRspackPlugin {
     options: NormalizedPluginOptions;
     static deprecated_runtimePaths: string[];

package/dist/index.js

@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 const node_path_1 = __importDefault(require("node:path"));
 const options_1 = require("./options");
 const getAdditionalEntries_1 = require("./utils/getAdditionalEntries");
-const getSocketIntegration_1 = __importDefault(require("./utils/getSocketIntegration"));
+const getSocketIntegration_1 = require("./utils/getSocketIntegration");
 const reactRefreshPath = require.resolve("../client/reactRefresh.js");
 const reactRefreshEntryPath = require.resolve("../client/reactRefreshEntry.js");
 const refreshUtilsPath = require.resolve("../client/refreshUtils.js");
@@ -18,11 +18,6 @@ const runtimePaths = [
     refreshUtilsPath,
     refreshRuntimeDirPath
 ];
-/**
- * @typedef {Object} Options
- * @property {(string | RegExp | (string | RegExp)[] | null)=} include included resourcePath for loader
- * @property {(string | RegExp | (string | RegExp)[] | null)=} exclude excluded resourcePath for loader
- */
 class ReactRefreshRspackPlugin {
     constructor(options = {}) {
         this.options = (0, options_1.normalizeOptions)(options);
@@ -81,7 +76,7 @@ class ReactRefreshRspackPlugin {
                 providedModules.__react_refresh_error_overlay__ = require.resolve(this.options.overlay.module);
             }
             if (this.options.overlay.sockIntegration) {
-                providedModules.__react_refresh_socket__ = (0, getSocketIntegration_1.default)(this.options.overlay.sockIntegration);
+                providedModules.__react_refresh_socket__ = (0, getSocketIntegration_1.getSocketIntegration)(this.options.overlay.sockIntegration);
             }
         }
         new compiler.webpack.DefinePlugin(definedModules).apply(compiler);

package/dist/sockets/WDSSocket.d.ts

@@ -1,10 +1,13 @@
+import type { SocketClient } from "./utils/getWDSMetadata";
 declare global {
-    var __webpack_dev_server_client__: any;
+    var __webpack_dev_server_client__: SocketClient | {
+        default: SocketClient;
+    };
 }
 /**
  * Initializes a socket server for HMR for webpack-dev-server.
- * @param {function(*): void} messageHandler A handler to consume Webpack compilation messages.
- * @param {string} [resourceQuery] Webpack's `__resourceQuery` string.
- * @returns {void}
+ * @param messageHandler A handler to consume Webpack compilation messages.
+ * @param resourceQuery Webpack's `__resourceQuery` string.
+ * @returns
  */
 export declare function init(messageHandler: (...args: any[]) => void, resourceQuery: string): void;

package/dist/sockets/WDSSocket.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.init = void 0;
 /**
  * The following code is modified based on
- * https://github.com/pmmmwh/react-refresh-webpack-plugin/blob/f1c8b9a44198449093ca95f85af5df97925e1cfc/sockets/WPSSocket.js
+ * https://github.com/pmmmwh/react-refresh-webpack-plugin/blob/f1c8b9a44198449093ca95f85af5df97925e1cfc/sockets/WDSSocket.js
  *
  * MIT Licensed
  * Author Michael Mok
@@ -18,20 +18,22 @@ const getUrlFromParts_1 = __importDefault(require("./utils/getUrlFromParts"));
 const getWDSMetadata_1 = __importDefault(require("./utils/getWDSMetadata"));
 /**
  * Initializes a socket server for HMR for webpack-dev-server.
- * @param {function(*): void} messageHandler A handler to consume Webpack compilation messages.
- * @param {string} [resourceQuery] Webpack's `__resourceQuery` string.
- * @returns {void}
+ * @param messageHandler A handler to consume Webpack compilation messages.
+ * @param resourceQuery Webpack's `__resourceQuery` string.
+ * @returns
  */
 function init(messageHandler, resourceQuery) {
     if (typeof __webpack_dev_server_client__ !== "undefined") {
-        let SocketClient = __webpack_dev_server_client__;
-        if (typeof __webpack_dev_server_client__.default !== "undefined") {
+        let SocketClient;
+        if ("default" in __webpack_dev_server_client__) {
             SocketClient = __webpack_dev_server_client__.default;
         }
+        else {
+            SocketClient = __webpack_dev_server_client__;
+        }
         const wdsMeta = (0, getWDSMetadata_1.default)(SocketClient);
         const urlParts = (0, getSocketUrlParts_1.default)(resourceQuery, wdsMeta);
         const connection = new SocketClient((0, getUrlFromParts_1.default)(urlParts, wdsMeta));
-        // @ts-expect-error -- ignore
         connection.onMessage(function onSocketMessage(data) {
             const message = JSON.parse(data);
             messageHandler(message);

package/dist/sockets/utils/getCurrentScriptSource.d.ts

@@ -1 +1 @@
-export default function getCurrentScriptSource(): any;
+export default function getCurrentScriptSource(): string | null | undefined;

package/dist/sockets/utils/getSocketUrlParts.js

@@ -4,11 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const getCurrentScriptSource_1 = __importDefault(require("./getCurrentScriptSource"));
-function getSocketUrlParts(resourceQuery, metadata) {
-    if (typeof metadata === "undefined") {
-        metadata = {};
-    }
-    /** @type {SocketUrlParts} */
+function getSocketUrlParts(resourceQuery, metadata = {}) {
     const urlParts = {};
     // If the resource query is available,
     // parse it and ignore everything we received from the script host.
@@ -16,7 +12,6 @@ function getSocketUrlParts(resourceQuery, metadata) {
         const parsedQuery = {};
         const searchParams = new URLSearchParams(resourceQuery.slice(1));
         searchParams.forEach((value, key) => {
-            // @ts-expect-error -- ignore
             parsedQuery[key] = value;
         });
         urlParts.hostname = parsedQuery.sockHost;
@@ -24,7 +19,7 @@ function getSocketUrlParts(resourceQuery, metadata) {
         urlParts.port = parsedQuery.sockPort;
         // Make sure the protocol from resource query has a trailing colon
         if (parsedQuery.sockProtocol) {
-            urlParts.protocol = parsedQuery.sockProtocol + ":";
+            urlParts.protocol = `${parsedQuery.sockProtocol}:`;
         }
     }
     else {
@@ -47,7 +42,7 @@ function getSocketUrlParts(resourceQuery, metadata) {
             // Result: <username> or <username>:<password>
             urlParts.auth = url.username;
             if (url.password) {
-                urlParts.auth += ":" + url.password;
+                urlParts.auth += `:${url.password}`;
             }
         }
         // `file://` URLs has `'null'` origin

package/dist/sockets/utils/getUrlFromParts.d.ts

@@ -2,8 +2,8 @@ import type { SocketUrlParts } from "./getSocketUrlParts";
 import type { WDSMetaObj } from "./getWDSMetadata";
 /**
  * Create a valid URL from parsed URL parts.
- * @param {import('./getSocketUrlParts').SocketUrlParts} urlParts The parsed URL parts.
- * @param {import('./getWDSMetadata').WDSMetaObj} [metadata] The parsed WDS metadata object.
- * @returns {string} The generated URL.
+ * @param urlParts The parsed URL parts.
+ * @param metadata The parsed WDS metadata object.
+ * @returns The generated URL.
  */
-export default function urlFromParts(urlParts: SocketUrlParts, metadata: WDSMetaObj): string;
+export default function urlFromParts(urlParts: SocketUrlParts, metadata?: WDSMetaObj): string;

package/dist/sockets/utils/getUrlFromParts.js

@@ -2,14 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 /**
  * Create a valid URL from parsed URL parts.
- * @param {import('./getSocketUrlParts').SocketUrlParts} urlParts The parsed URL parts.
- * @param {import('./getWDSMetadata').WDSMetaObj} [metadata] The parsed WDS metadata object.
- * @returns {string} The generated URL.
+ * @param urlParts The parsed URL parts.
+ * @param metadata The parsed WDS metadata object.
+ * @returns The generated URL.
  */
-function urlFromParts(urlParts, metadata) {
-    if (typeof metadata === "undefined") {
-        metadata = {};
-    }
+function urlFromParts(urlParts, metadata = {}) {
     let fullProtocol = "http:";
     if (urlParts.protocol) {
         fullProtocol = urlParts.protocol;
@@ -17,14 +14,14 @@ function urlFromParts(urlParts, metadata) {
     if (metadata.enforceWs) {
         fullProtocol = fullProtocol.replace(/^(?:http|.+-extension|file)/i, "ws");
     }
-    fullProtocol = fullProtocol + "//";
+    fullProtocol = `${fullProtocol}//`;
     let fullHost = urlParts.hostname;
     if (urlParts.auth) {
-        const fullAuth = urlParts.auth.split(":").map(encodeURIComponent).join(":") + "@";
+        const fullAuth = `${urlParts.auth.split(":").map(encodeURIComponent).join(":")}@`;
         fullHost = fullAuth + fullHost;
     }
     if (urlParts.port) {
-        fullHost = fullHost + ":" + urlParts.port;
+        fullHost = `${fullHost}:${urlParts.port}`;
     }
     const url = new URL(urlParts.pathname, fullProtocol + fullHost);
     return url.href;

package/dist/sockets/utils/getWDSMetadata.d.ts

@@ -2,4 +2,15 @@ export interface WDSMetaObj {
     enforceWs?: boolean;
     version?: number;
 }
-export default function getWDSMetadata(SocketClient: any): WDSMetaObj;
+declare class WebSocketClient {
+    client: WebSocket;
+    constructor(url: string);
+    onOpen(f: (...args: any[]) => void): void;
+    onClose(f: (...args: any[]) => void): void;
+    onMessage(f: (...args: any[]) => void): void;
+}
+export interface SocketClient {
+    new (url: string): WebSocketClient;
+}
+export default function getWDSMetadata(SocketClient: SocketClient): WDSMetaObj;
+export {};

package/dist/utils/getAdditionalEntries.js

@@ -6,7 +6,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getAdditionalEntries = void 0;
 const node_querystring_1 = __importDefault(require("node:querystring"));
 function getAdditionalEntries({ devServer, options }) {
-    /** @type {Record<string, string | number>} */
     const resourceQuery = {};
     if (devServer) {
         const { client, https, http2, sockHost, sockPath, sockPort } = devServer;
@@ -26,7 +25,7 @@ function getAdditionalEntries({ devServer, options }) {
             if (parsedUrl.username) {
                 auth = parsedUrl.username;
                 if (parsedUrl.password) {
-                    auth += ":" + parsedUrl.password;
+                    auth += `:${parsedUrl.password}`;
                 }
             }
             if (parsedUrl.hostname != null) {
@@ -70,12 +69,8 @@ function getAdditionalEntries({ devServer, options }) {
     }
     // We don't need to URI encode the resourceQuery as it will be parsed by Webpack
     const queryString = node_querystring_1.default.stringify(resourceQuery, undefined, undefined, {
-        /**
-         * @param {string} string
-         * @returns {string}
-         */
-        encodeURIComponent(string) {
-            return string;
+        encodeURIComponent(str) {
+            return str;
         }
     });
     const prependEntries = [
@@ -84,8 +79,8 @@ function getAdditionalEntries({ devServer, options }) {
     ];
     const overlayEntries = [
         // Error overlay runtime
-        options.overlay &&
-            options.overlay.entry &&
+        options.overlay !== false &&
+            options.overlay?.entry &&
             `${require.resolve(options.overlay.entry)}${queryString ? `?${queryString}` : ""}`
     ].filter(Boolean);
     return { prependEntries, overlayEntries };

package/dist/utils/getSocketIntegration.d.ts

@@ -1,2 +1,2 @@
 export type IntegrationType = "wds";
-export default function getSocketIntegration(integrationType: IntegrationType): string;
+export declare function getSocketIntegration(integrationType: IntegrationType): string;

package/dist/utils/getSocketIntegration.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSocketIntegration = void 0;
 function getSocketIntegration(integrationType) {
     let resolvedSocketIntegration;
     switch (integrationType) {
@@ -14,4 +15,4 @@ function getSocketIntegration(integrationType) {
     }
     return resolvedSocketIntegration;
 }
-exports.default = getSocketIntegration;
+exports.getSocketIntegration = getSocketIntegration;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspack/plugin-react-refresh",
-  "version": "1.0.0-beta.1",
+  "version": "1.0.0-beta.3",
   "license": "MIT",
   "description": "React refresh plugin for rspack",
   "main": "dist/index.js",
@@ -31,8 +31,8 @@
   "devDependencies": {
     "react-refresh": "^0.14.0",
     "typescript": "5.0.2",
-    "@rspack/core": "1.0.0-beta.1",
-    "@rspack/plugin-react-refresh": "1.0.0-beta.1"
+    "@rspack/core": "1.0.0-beta.3",
+    "@rspack/plugin-react-refresh": "1.0.0-beta.3"
   },
   "dependencies": {
     "error-stack-parser": "^2.0.6",