@modern-js/plugin-v2 2.63.7 → 2.63.8-alpha.1

package/dist/types/types/cli/hooks.d.ts

@@ -10,7 +10,7 @@ declare module '@modern-js/utils/commander' {
     }
 }
 export type ConfigFn<Config> = () => Config;
-export type ModifyConfigFn<Config> = TransformFunction<Config>;
+export type ModifyConfigFn<Config, ExtendConfigUtils> = (arg: Config, utils?: ExtendConfigUtils) => Config | Promise<Config>;
 export type ModifyResolvedConfigFn<NormalizedConfig> = TransformFunction<NormalizedConfig>;
 type IPartialMethod = (...script: string[]) => void;
 export interface PartialMethod {
@@ -44,8 +44,8 @@ export type OnBeforeDevFn = () => Promise<void> | void;
 export type OnAfterDevFn = (params: {
     port: number;
 }) => Promise<void> | void;
-export type OnBeforeDeployFn = (options: Record<string, any>) => Promise<void> | void;
-export type OnAfterDeployFn = (options: Record<string, any>) => Promise<void> | void;
+export type OnBeforeDeployFn = (options?: Record<string, any>) => Promise<void> | void;
+export type OnAfterDeployFn = (options?: Record<string, any>) => Promise<void> | void;
 export type OnBeforeExitFn = () => void;
 export type ModifyBundlerChainFn<ExtendsUtils> = (chain: RspackChain, utils: ModifyBundlerChainUtils & ExtendsUtils) => MaybePromise<void>;
 export type ModifyRsbuildConfigUtils = {

package/dist/types/types/cli/plugin.d.ts

@@ -2,13 +2,14 @@ import type { PluginHook } from '../hooks';
 import type { Plugin } from '../plugin';
 import type { CLIPluginAPI } from './api';
 import type { AppContext } from './context';
-export interface CLIPluginExtends<Config extends Record<string, any> = {}, NormalizedConfig extends Record<string, any> = {}, ExtendContext extends Record<string, any> = {}, ExtendAPI extends Record<string, any> = {}, ExtendHook extends Record<string, PluginHook<(...args: any[]) => any>> = {}, ExtendBuildUtils extends Record<string, any> = {}> {
+export interface CLIPluginExtends<Config extends Record<string, any> = {}, NormalizedConfig extends Record<string, any> = {}, ExtendContext extends Record<string, any> = {}, ExtendAPI extends Record<string, any> = {}, ExtendHook extends Record<string, PluginHook<(...args: any[]) => any>> = {}, ExtendBuildUtils extends Record<string, any> = {}, ExtendConfigUtils extends Record<string, any> = {}> {
     config?: Config;
     normalizedConfig?: NormalizedConfig;
     extendContext?: ExtendContext;
     extendApi?: ExtendAPI;
     extendHooks?: ExtendHook;
     extendBuildUtils?: ExtendBuildUtils;
+    extendConfigUtils?: ExtendConfigUtils;
 }
 /**
  * The type of the CLI plugin object.

package/dist/types/types/hooks.d.ts

@@ -1,11 +1,23 @@
-import type { UnwrapPromise } from './utils';
+import type { Tail, UnwrapPromise } from './utils';
+export type SyncHook<Callback extends (...args: any[]) => any> = {
+    tap: (cb: Callback) => void;
+    call: (...args: Parameters<Callback>) => ReturnType<Callback>;
+};
 export type AsyncHook<Callback extends (...args: any[]) => any> = {
     tap: (cb: Callback) => void;
     call: (...args: Parameters<Callback>) => Promise<ReturnType<Callback>>;
 };
+export type AsyncInterruptHook<Callback extends (...args: any[]) => any> = {
+    tap: (cb: Callback) => void;
+    call: (...args: Tail<Parameters<Callback>>) => Promise<ReturnType<Callback>>;
+};
 export type CollectAsyncHook<Callback extends (...params: any[]) => any> = {
     tap: (cb: Callback) => void;
     call: (...params: Parameters<Callback>) => Promise<UnwrapPromise<ReturnType<Callback>>[]>;
 };
-export type PluginHook<Callback extends (...args: any[]) => any> = AsyncHook<Callback> | CollectAsyncHook<Callback>;
+export type CollectSyncHook<Callback extends (...params: any[]) => any> = {
+    tap: (cb: Callback) => void;
+    call: (...params: Parameters<Callback>) => ReturnType<Callback>[];
+};
+export type PluginHook<Callback extends (...args: any[]) => any> = SyncHook<Callback> | AsyncHook<Callback> | CollectSyncHook<Callback> | CollectAsyncHook<Callback> | AsyncInterruptHook<Callback>;
 export type PluginHookTap<T extends (...args: any[]) => any> = (options: T) => void;

package/dist/types/types/index.d.ts

@@ -1,3 +1,4 @@
 export type { Plugin, PluginManager, TransformFunction, } from './plugin';
 export type { CLIPluginAPI, AppContext, InternalContext, Entrypoint, CLIPlugin, } from './cli';
+export type { RuntimePluginAPI, RuntimeContext, InternalRuntimeContext, RuntimePlugin, } from './runtime';
 export type { AsyncHook, CollectAsyncHook, PluginHook, PluginHookTap, } from './hooks';

package/dist/types/types/plugin.d.ts

@@ -18,7 +18,7 @@ export type Plugin<PluginAPI = {}, Context = {}> = {
     /**
      * The plugins add new apis to the plugin manager.
      */
-    _registryApi?: (getAppContext: () => Context, updateAppContext: (context: Context) => void) => Record<string, (...args: any[]) => any>;
+    _registryApi?: (...params: any[]) => Record<string, (...args: any[]) => any>;
     /**
      * The setup function of the plugin, which can be an async function.
      * This function is called once when the plugin is initialized.

package/dist/types/types/runtime/api.d.ts

@@ -0,0 +1,15 @@
+import type { PluginHookTap } from '../hooks';
+import type { DeepPartial } from '../utils';
+import type { RuntimeContext } from './context';
+import type { Hooks } from './hooks';
+import type { ModifyRuntimeConfigFn, OnBeforeRenderFn, PickContextFn, WrapRootFn } from './hooks';
+import type { RuntimePluginExtends } from './plugin';
+export type RuntimePluginAPI<Extends extends RuntimePluginExtends> = Readonly<{
+    updateRuntimeContext: (updateContext: DeepPartial<RuntimeContext>) => void;
+    getHooks: () => Readonly<Hooks<Extends['config'], RuntimeContext & Extends['extendContext']> & Extends['extendHooks']>;
+    getRuntimeConfig: () => Readonly<Extends['config']>;
+    onBeforeRender: PluginHookTap<OnBeforeRenderFn<Extends['extendContext']>>;
+    wrapRoot: PluginHookTap<WrapRootFn>;
+    pickContext: PluginHookTap<PickContextFn<RuntimeContext>>;
+    modifyRuntimeConfig: PluginHookTap<ModifyRuntimeConfigFn<Extends['config']>>;
+}>;

package/dist/types/types/runtime/context.d.ts

@@ -0,0 +1,13 @@
+import type { RuntimePluginAPI } from './api';
+import type { Hooks } from './hooks';
+import type { RuntimePluginExtends } from './plugin';
+export type RuntimeContext = {};
+export type InternalRuntimeContext<Extends extends RuntimePluginExtends> = RuntimeContext & {
+    /** All hooks. */
+    hooks: Hooks<Extends['config'], RuntimeContext & Extends['extendContext']> & Extends['extendHooks'];
+    /** All plugin registry hooks */
+    extendsHooks: Extends['extendHooks'];
+    config: Extends['config'];
+    pluginAPI?: RuntimePluginAPI<Extends>;
+    _internalContext?: InternalRuntimeContext<Extends>;
+};

package/dist/types/types/runtime/hooks.d.ts

@@ -0,0 +1,12 @@
+import type React from 'react';
+import type { AsyncInterruptHook, CollectSyncHook, SyncHook } from '../hooks';
+export type OnBeforeRenderFn<RuntimeContext> = (context: RuntimeContext, interrupt: (info: any) => any) => Promise<any> | any;
+export type WrapRootFn = (root: React.ComponentType<any>) => React.ComponentType<any>;
+export type PickContextFn<RuntimeContext> = (context: RuntimeContext) => RuntimeContext;
+export type ModifyRuntimeConfigFn<RuntimeConfig> = (config: RuntimeConfig) => RuntimeConfig;
+export type Hooks<RuntimeConfig, RuntimeContext> = {
+    onBeforeRender: AsyncInterruptHook<OnBeforeRenderFn<RuntimeContext>>;
+    wrapRoot: SyncHook<WrapRootFn>;
+    pickContext: SyncHook<PickContextFn<RuntimeContext>>;
+    modifyRuntimeConfig: CollectSyncHook<ModifyRuntimeConfigFn<RuntimeConfig>>;
+};

package/dist/types/types/runtime/index.d.ts

@@ -0,0 +1,4 @@
+export type { RuntimePluginAPI } from './api';
+export type { RuntimeContext, InternalRuntimeContext } from './context';
+export type { RuntimePlugin, RuntimePluginExtends } from './plugin';
+export type { Hooks } from './hooks';

package/dist/types/types/runtime/plugin.d.ts

@@ -0,0 +1,14 @@
+import type { PluginHook } from '../hooks';
+import type { Plugin } from '../plugin';
+import type { RuntimePluginAPI } from './api';
+import type { RuntimeContext } from './context';
+export interface RuntimePluginExtends<Config extends Record<string, any> = {}, ExtendContext extends Record<string, any> = {}, ExtendAPI extends Record<string, any> = {}, ExtendHook extends Record<string, PluginHook<(...args: any[]) => any>> = {}> {
+    config?: Config;
+    extendContext?: ExtendContext;
+    extendApi?: ExtendAPI;
+    extendHooks?: ExtendHook;
+}
+/**
+ * The type of the Runtime plugin object.
+ */
+export type RuntimePlugin<Extends extends RuntimePluginExtends> = Plugin<RuntimePluginAPI<Extends> & Extends['extendApi'], RuntimeContext & Extends['extendContext']>;

package/dist/types/types/utils.d.ts

@@ -4,3 +4,4 @@ export type DeepPartial<T> = {
     [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
 };
 export type UnwrapPromise<T> = T extends Promise<infer U> ? U : T;
+export type Tail<T extends any[]> = T extends [...infer Rest, any] ? Rest : never;

package/package.json

@@ -15,7 +15,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "2.63.7",
+  "version": "2.63.8-alpha.1",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/cjs/index.js",
@@ -30,11 +30,6 @@
       },
       "default": "./dist/esm/index.js"
     },
-    "./types": {
-      "types": "./dist/types/types/index.d.ts",
-      "jsnext:source": "./src/types/index.ts",
-      "default": "./dist/cjs/types/index.js"
-    },
     "./run": {
       "types": "./dist/types/cli/run/run.d.ts",
       "jsnext:source": "./src/cli/run/run.ts",
@@ -44,6 +39,11 @@
       "types": "./dist/types/cli/index.d.ts",
       "jsnext:source": "./src/cli/index.ts",
       "default": "./dist/cjs/cli/index.js"
+    },
+    "./runtime": {
+      "types": "./dist/types/runtime/index.d.ts",
+      "jsnext:source": "./src/runtime/index.ts",
+      "default": "./dist/esm/runtime/index.js"
     }
   },
   "typesVersions": {
@@ -56,16 +56,21 @@
       ],
       "cli": [
         "./dist/types/cli/index.d.ts"
+      ],
+      "runtime": [
+        "./dist/types/runtime/index.d.ts"
       ]
     }
   },
   "dependencies": {
     "@swc/helpers": "0.5.13",
     "@modern-js/node-bundle-require": "2.63.7",
-    "@modern-js/utils": "2.63.7"
+    "@modern-js/utils": "2.63.7",
+    "@modern-js/runtime-utils": "2.63.7"
   },
   "devDependencies": {
     "@rsbuild/core": "1.1.13",
+    "@types/react": "^18.3.11",
     "@types/jest": "^29",
     "@types/node": "^14",
     "jest": "^29",
@@ -78,8 +83,7 @@
   "sideEffects": false,
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
-    "access": "public",
-    "provenance": true
+    "access": "public"
   },
   "scripts": {
     "new": "modern-lib new",