@rsbuild/plugin-assets-retry 0.7.9 → 1.0.0-alpha.0

package/dist/AssetsRetryPlugin.d.ts

@@ -0,0 +1,19 @@
+import { type Rspack } from '@rsbuild/core';
+import type HtmlWebpackPlugin from 'html-webpack-plugin';
+import type { PluginAssetsRetryOptions } from './types';
+export declare class AssetsRetryPlugin implements Rspack.RspackPluginInstance {
+    #private;
+    readonly name: string;
+    readonly distDir: string;
+    readonly inlineScript: boolean;
+    readonly minify?: boolean;
+    readonly HtmlPlugin: typeof HtmlWebpackPlugin;
+    scriptPath: string;
+    constructor(options: PluginAssetsRetryOptions & {
+        distDir: string;
+        HtmlPlugin: typeof HtmlWebpackPlugin;
+    });
+    getRetryCode(): Promise<string>;
+    getScriptPath(): Promise<string>;
+    apply(compiler: Rspack.Compiler): void;
+}

package/dist/AsyncChunkRetryPlugin.d.ts

@@ -0,0 +1,15 @@
+import { type Rspack } from '@rsbuild/core';
+import type { PluginAssetsRetryOptions, RuntimeRetryOptions } from './types';
+declare class AsyncChunkRetryPlugin implements Rspack.RspackPluginInstance {
+    readonly name = "ASYNC_CHUNK_RETRY_PLUGIN";
+    readonly options: PluginAssetsRetryOptions & {
+        isRspack: boolean;
+    };
+    readonly runtimeOptions: RuntimeRetryOptions;
+    constructor(options: PluginAssetsRetryOptions & {
+        isRspack: boolean;
+    });
+    getRawRuntimeRetryCode(): string;
+    apply(compiler: Rspack.Compiler): void;
+}
+export { AsyncChunkRetryPlugin };

package/dist/index.cjs

@@ -58,13 +58,13 @@ var AssetsRetryPlugin_exports = {};
 __export(AssetsRetryPlugin_exports, {
   AssetsRetryPlugin: () => AssetsRetryPlugin
 });
-var import_node_path, import_core, import_shared, _retryOptions, AssetsRetryPlugin;
+var import_node_fs, import_node_path, import_core, _retryOptions, AssetsRetryPlugin;
 var init_AssetsRetryPlugin = __esm({
   "src/AssetsRetryPlugin.ts"() {
     "use strict";
+    import_node_fs = __toESM(require("fs"));
     import_node_path = __toESM(require("path"));
     import_core = require("@rsbuild/core");
-    import_shared = require("@rsbuild/shared");
     AssetsRetryPlugin = class {
       constructor(options) {
         __publicField(this, "name");
@@ -97,7 +97,7 @@ var init_AssetsRetryPlugin = __esm({
           "runtime",
           this.minify ? `${filename}.min.js` : `${filename}.js`
         );
-        const runtimeCode = await import_shared.fse.readFile(runtimeFilePath, "utf-8");
+        const runtimeCode = await import_node_fs.default.promises.readFile(runtimeFilePath, "utf-8");
         return `(function(){${runtimeCode};init(${serialize2(
           __privateGet(this, _retryOptions)
         )});})()`;
@@ -106,7 +106,7 @@ var init_AssetsRetryPlugin = __esm({
         if (!this.scriptPath) {
           this.scriptPath = import_node_path.default.posix.join(
             this.distDir,
-            `assets-retry.${"0.7.9"}.js`
+            `assets-retry.${"1.0.0-alpha.0"}.js`
           );
         }
         return this.scriptPath;
@@ -151,7 +151,7 @@ var init_AssetsRetryPlugin = __esm({
                   innerHTML: await this.getRetryCode()
                 });
               } else {
-                const publicPath = (0, import_shared.getPublicPathFromCompiler)(compiler);
+                const { publicPath } = compilation.outputOptions;
                 const url = (0, import_core.ensureAssetPrefix)(
                   await this.getScriptPath(),
                   publicPath
@@ -210,13 +210,13 @@ function pick(obj, keys) {
     {}
   );
 }
-var import_node_path2, import_core2, import_shared2, import_serialize_javascript, AsyncChunkRetryPlugin;
+var import_node_fs2, import_node_path2, import_core2, import_serialize_javascript, AsyncChunkRetryPlugin;
 var init_AsyncChunkRetryPlugin = __esm({
   "src/AsyncChunkRetryPlugin.ts"() {
     "use strict";
+    import_node_fs2 = __toESM(require("fs"));
     import_node_path2 = __toESM(require("path"));
     import_core2 = require("@rsbuild/core");
-    import_shared2 = require("@rsbuild/shared");
     import_serialize_javascript = __toESM(require("serialize-javascript"));
     AsyncChunkRetryPlugin = class {
       constructor(options) {
@@ -242,7 +242,7 @@ var init_AsyncChunkRetryPlugin = __esm({
           "runtime",
           this.options.minify ? `${filename}.min.js` : `${filename}.js`
         );
-        const rawText = import_shared2.fse.readFileSync(runtimeFilePath, "utf-8");
+        const rawText = import_node_fs2.default.readFileSync(runtimeFilePath, "utf-8");
         return rawText.replaceAll("__RUNTIME_GLOBALS_REQUIRE__", RuntimeGlobals.require).replaceAll(
           "__RUNTIME_GLOBALS_ENSURE_CHUNK__",
           RuntimeGlobals.ensureChunk
@@ -280,15 +280,15 @@ __export(src_exports, {
   pluginAssetsRetry: () => pluginAssetsRetry
 });
 module.exports = __toCommonJS(src_exports);
-var import_shared3 = require("@rsbuild/shared");
 var PLUGIN_ASSETS_RETRY_NAME = "rsbuild:assets-retry";
 var pluginAssetsRetry = (options = {}) => ({
   name: PLUGIN_ASSETS_RETRY_NAME,
   setup(api) {
     api.modifyBundlerChain(
-      async (chain, { CHAIN_ID, target, HtmlPlugin, isProd }) => {
-        const config = api.getNormalizedConfig();
-        if (!options || (0, import_shared3.isHtmlDisabled)(config, target)) {
+      async (chain, { CHAIN_ID, HtmlPlugin, isProd, environment }) => {
+        const { config } = environment;
+        const htmlPaths = api.getHTMLPaths({ environment: environment.name });
+        if (!options || Object.keys(htmlPaths).length === 0) {
           return;
         }
         const { AssetsRetryPlugin: AssetsRetryPlugin2 } = await Promise.resolve().then(() => (init_AssetsRetryPlugin(), AssetsRetryPlugin_exports));

package/dist/index.d.ts

@@ -1,71 +1,5 @@
-import { CrossOrigin, RsbuildPlugin } from '@rsbuild/core';
-
-type PluginAssetsRetryOptions = {
-    /**
-     * The maximum number of retries for a single asset.
-     * @default 3
-     */
-    max?: number;
-    /**
-     * Used to specify the HTML tag types that need to be retried.
-     * @default ['script', 'link', 'img']
-     */
-    type?: string[];
-    /**
-     * The test function of the asset to be retried.
-     */
-    test?: string | ((url: string) => boolean);
-    /**
-     * Specifies the retry domain when assets fail to load.
-     */
-    domain?: string[];
-    /**
-     * Set the `crossorigin` attribute for tags.
-     * @default config.html.crossorigin
-     */
-    crossOrigin?: boolean | CrossOrigin;
-    /**
-     * The callback function when the asset is failed to be retried.
-     */
-    onFail?: (context: AssetsRetryHookContext) => void;
-    /**
-     * The callback function when the asset is being retried.
-     */
-    onRetry?: (context: AssetsRetryHookContext) => void;
-    /**
-     * The callback function when the asset is successfully retried.
-     */
-    onSuccess?: (context: AssetsRetryHookContext) => void;
-    /**
-     * The function to add query parameters to the URL of the asset being retried.
-     * @param times e.g: 1 -> 2 -> 3
-     * @param originalQuery initial request url's query e.g: <script src="https://cdn.com/a.js?version=1"></script> -> "?version=1"
-     * @default false
-     * @description true -> hasQuery(originalQuery) ? `${getQuery(originalQuery)}&retry=${existRetryTimes}` : `?retry=${existRetryTimes}`
-     */
-    addQuery?: boolean | ((context: {
-        times: number;
-        originalQuery: string;
-    }) => string);
-    /**
-     * Whether to inline the runtime JavaScript code of Assets Retry plugin into the HTML file.
-     * @default true
-     */
-    inlineScript?: boolean;
-    /**
-     * Whether to minify the runtime JavaScript code of Assets Retry plugin.
-     * @default process.env.NODE_ENV === 'production'
-     */
-    minify?: boolean;
-};
-type AssetsRetryHookContext = {
-    url: string;
-    times: number;
-    domain: string;
-    tagName: string;
-};
-
-declare const PLUGIN_ASSETS_RETRY_NAME = "rsbuild:assets-retry";
-declare const pluginAssetsRetry: (options?: PluginAssetsRetryOptions) => RsbuildPlugin;
-
-export { PLUGIN_ASSETS_RETRY_NAME, type PluginAssetsRetryOptions, pluginAssetsRetry };
+import type { RsbuildPlugin } from '@rsbuild/core';
+import type { PluginAssetsRetryOptions } from './types';
+export type { PluginAssetsRetryOptions };
+export declare const PLUGIN_ASSETS_RETRY_NAME = "rsbuild:assets-retry";
+export declare const pluginAssetsRetry: (options?: PluginAssetsRetryOptions) => RsbuildPlugin;

package/dist/index.js

@@ -34,12 +34,12 @@ var __privateSet = (obj, member, value, setter) => {
   return value;
 };
 
-// ../../node_modules/.pnpm/@modern-js+module-tools@2.52.0_eslint@9.5.0_typescript@5.4.5/node_modules/@modern-js/module-tools/shims/esm.js
+// ../../node_modules/.pnpm/@modern-js+module-tools@2.54.5_eslint@9.6.0_typescript@5.5.2/node_modules/@modern-js/module-tools/shims/esm.js
 import { fileURLToPath } from "url";
 import path from "path";
 var getFilename, getDirname, __dirname;
 var init_esm = __esm({
-  "../../node_modules/.pnpm/@modern-js+module-tools@2.52.0_eslint@9.5.0_typescript@5.4.5/node_modules/@modern-js/module-tools/shims/esm.js"() {
+  "../../node_modules/.pnpm/@modern-js+module-tools@2.54.5_eslint@9.6.0_typescript@5.5.2/node_modules/@modern-js/module-tools/shims/esm.js"() {
     "use strict";
     getFilename = () => fileURLToPath(import.meta.url);
     getDirname = () => path.dirname(getFilename());
@@ -52,9 +52,9 @@ var AssetsRetryPlugin_exports = {};
 __export(AssetsRetryPlugin_exports, {
   AssetsRetryPlugin: () => AssetsRetryPlugin
 });
+import fs from "fs";
 import path2 from "path";
 import { ensureAssetPrefix } from "@rsbuild/core";
-import { fse, getPublicPathFromCompiler } from "@rsbuild/shared";
 var _retryOptions, AssetsRetryPlugin;
 var init_AssetsRetryPlugin = __esm({
   "src/AssetsRetryPlugin.ts"() {
@@ -92,7 +92,7 @@ var init_AssetsRetryPlugin = __esm({
           "runtime",
           this.minify ? `${filename}.min.js` : `${filename}.js`
         );
-        const runtimeCode = await fse.readFile(runtimeFilePath, "utf-8");
+        const runtimeCode = await fs.promises.readFile(runtimeFilePath, "utf-8");
         return `(function(){${runtimeCode};init(${serialize2(
           __privateGet(this, _retryOptions)
         )});})()`;
@@ -101,7 +101,7 @@ var init_AssetsRetryPlugin = __esm({
         if (!this.scriptPath) {
           this.scriptPath = path2.posix.join(
             this.distDir,
-            `assets-retry.${"0.7.9"}.js`
+            `assets-retry.${"1.0.0-alpha.0"}.js`
           );
         }
         return this.scriptPath;
@@ -146,7 +146,7 @@ var init_AssetsRetryPlugin = __esm({
                   innerHTML: await this.getRetryCode()
                 });
               } else {
-                const publicPath = getPublicPathFromCompiler(compiler);
+                const { publicPath } = compilation.outputOptions;
                 const url = ensureAssetPrefix(
                   await this.getScriptPath(),
                   publicPath
@@ -174,9 +174,9 @@ var AsyncChunkRetryPlugin_exports = {};
 __export(AsyncChunkRetryPlugin_exports, {
   AsyncChunkRetryPlugin: () => AsyncChunkRetryPlugin
 });
+import fs2 from "fs";
 import path3 from "path";
 import { rspack } from "@rsbuild/core";
-import { fse as fse2 } from "@rsbuild/shared";
 import serialize from "serialize-javascript";
 function appendWebpackScript(module, appendSource) {
   try {
@@ -238,7 +238,7 @@ var init_AsyncChunkRetryPlugin = __esm({
           "runtime",
           this.options.minify ? `${filename}.min.js` : `${filename}.js`
         );
-        const rawText = fse2.readFileSync(runtimeFilePath, "utf-8");
+        const rawText = fs2.readFileSync(runtimeFilePath, "utf-8");
         return rawText.replaceAll("__RUNTIME_GLOBALS_REQUIRE__", RuntimeGlobals.require).replaceAll(
           "__RUNTIME_GLOBALS_ENSURE_CHUNK__",
           RuntimeGlobals.ensureChunk
@@ -271,15 +271,15 @@ var init_AsyncChunkRetryPlugin = __esm({
 
 // src/index.ts
 init_esm();
-import { isHtmlDisabled } from "@rsbuild/shared";
 var PLUGIN_ASSETS_RETRY_NAME = "rsbuild:assets-retry";
 var pluginAssetsRetry = (options = {}) => ({
   name: PLUGIN_ASSETS_RETRY_NAME,
   setup(api) {
     api.modifyBundlerChain(
-      async (chain, { CHAIN_ID, target, HtmlPlugin, isProd }) => {
-        const config = api.getNormalizedConfig();
-        if (!options || isHtmlDisabled(config, target)) {
+      async (chain, { CHAIN_ID, HtmlPlugin, isProd, environment }) => {
+        const { config } = environment;
+        const htmlPaths = api.getHTMLPaths({ environment: environment.name });
+        if (!options || Object.keys(htmlPaths).length === 0) {
           return;
         }
         const { AssetsRetryPlugin: AssetsRetryPlugin2 } = await Promise.resolve().then(() => (init_AssetsRetryPlugin(), AssetsRetryPlugin_exports));

package/dist/runtime/asyncChunkRetry.d.ts

@@ -0,0 +1,14 @@
+import type { RuntimeRetryOptions } from '../types';
+type ChunkId = string;
+type ChunkFilename = string;
+type ChunkSrcUrl = string;
+declare global {
+    var __RUNTIME_GLOBALS_REQUIRE__: unknown;
+    var __RUNTIME_GLOBALS_ENSURE_CHUNK__: (chunkId: ChunkId) => Promise<unknown>;
+    var __RUNTIME_GLOBALS_GET_CHUNK_SCRIPT_FILENAME__: (chunkId: ChunkId) => string;
+    var __RUNTIME_GLOBALS_LOAD_SCRIPT__: (url: ChunkSrcUrl, done: unknown, key: string, chunkId: ChunkId) => void;
+    var __RUNTIME_GLOBALS_PUBLIC_PATH__: string;
+    var __RETRY_OPTIONS__: RuntimeRetryOptions;
+    var __RB_ASYNC_CHUNKS__: Record<ChunkFilename, boolean>;
+}
+export {};

package/dist/runtime/initialChunkRetry.d.ts

@@ -0,0 +1,4 @@
+declare global {
+    var __RB_ASYNC_CHUNKS__: Record<string, boolean>;
+}
+export {};

package/dist/types.d.ts

@@ -0,0 +1,66 @@
+import type { CrossOrigin } from '@rsbuild/core';
+export type PluginAssetsRetryOptions = {
+    /**
+     * The maximum number of retries for a single asset.
+     * @default 3
+     */
+    max?: number;
+    /**
+     * Used to specify the HTML tag types that need to be retried.
+     * @default ['script', 'link', 'img']
+     */
+    type?: string[];
+    /**
+     * The test function of the asset to be retried.
+     */
+    test?: string | ((url: string) => boolean);
+    /**
+     * Specifies the retry domain when assets fail to load.
+     */
+    domain?: string[];
+    /**
+     * Set the `crossorigin` attribute for tags.
+     * @default config.html.crossorigin
+     */
+    crossOrigin?: boolean | CrossOrigin;
+    /**
+     * The callback function when the asset is failed to be retried.
+     */
+    onFail?: (context: AssetsRetryHookContext) => void;
+    /**
+     * The callback function when the asset is being retried.
+     */
+    onRetry?: (context: AssetsRetryHookContext) => void;
+    /**
+     * The callback function when the asset is successfully retried.
+     */
+    onSuccess?: (context: AssetsRetryHookContext) => void;
+    /**
+     * The function to add query parameters to the URL of the asset being retried.
+     * @param times e.g: 1 -> 2 -> 3
+     * @param originalQuery initial request url's query e.g: <script src="https://cdn.com/a.js?version=1"></script> -> "?version=1"
+     * @default false
+     * @description true -> hasQuery(originalQuery) ? `${getQuery(originalQuery)}&retry=${existRetryTimes}` : `?retry=${existRetryTimes}`
+     */
+    addQuery?: boolean | ((context: {
+        times: number;
+        originalQuery: string;
+    }) => string);
+    /**
+     * Whether to inline the runtime JavaScript code of Assets Retry plugin into the HTML file.
+     * @default true
+     */
+    inlineScript?: boolean;
+    /**
+     * Whether to minify the runtime JavaScript code of Assets Retry plugin.
+     * @default process.env.NODE_ENV === 'production'
+     */
+    minify?: boolean;
+};
+export type RuntimeRetryOptions = Omit<PluginAssetsRetryOptions, 'inlineScript' | 'minify'>;
+export type AssetsRetryHookContext = {
+    url: string;
+    times: number;
+    domain: string;
+    tagName: string;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rsbuild/plugin-assets-retry",
-  "version": "0.7.9",
+  "version": "1.0.0-alpha.0",
   "description": "Assets retry plugin for Rsbuild",
   "homepage": "https://rsbuild.dev",
   "repository": {
@@ -24,7 +24,7 @@
   ],
   "dependencies": {
     "serialize-javascript": "^6.0.2",
-    "@rsbuild/shared": "0.7.9"
+    "@rsbuild/shared": "1.0.0-alpha.0"
   },
   "devDependencies": {
     "@babel/core": "^7.24.7",
@@ -33,11 +33,11 @@
     "@types/serialize-javascript": "^5.0.4",
     "html-webpack-plugin": "npm:html-rspack-plugin@5.7.2",
     "terser": "5.31.1",
-    "typescript": "^5.4.2",
-    "@rsbuild/core": "0.7.9"
+    "typescript": "^5.5.2",
+    "@rsbuild/core": "1.0.0-alpha.0"
   },
   "peerDependencies": {
-    "@rsbuild/core": "^0.7.9"
+    "@rsbuild/core": "^1.0.0-alpha.0"
   },
   "publishConfig": {
     "access": "public",