@rpack-dev/core 0.1.20-e0d3509 → 0.1.20

package/dist/rpack-core.d.ts

@@ -42,7 +42,18 @@ declare class RPack {
 	 * @return an RPVersion instance
 	 */
 	getVersion(): RPVersion;
+	/**
+	 * Returns the current ProxyManager instance.
+	 *
+	 * This class is used when dealing with proxied objects
+	 * across threads and the network.
+	 */
 	getProxyManager(): ProxyManager;
+	/**
+	 * Returns the current RegistryManager instance.
+	 *
+	 * This class is used when dealing with Registries.
+	 */
 	getRegistryManager(): RegistryManager;
 	getPluginManager(): PluginManager;
 	getNetworkManager(): NetworkManager;
@@ -381,7 +392,7 @@ export declare class NetworkManager {
 	private threadId;
 	private readonly wellKnownMap;
 	private readonly wellKnownReverseMap;
-	constructor(rpack: RPack, threadId: string, coreMessenger?: Messenger<C2PPackets, P2CPackets>);
+	constructor(rpack: RPack);
 	private mapWellKnown;
 	__initPlugin(pluginKey: string, scriptUrl: string): Promise<void>;
 	getRPack(): RPack;
@@ -428,7 +439,31 @@ export declare class RPPlugin {
 	 * @return the RPack instance
 	 */
 	getRPack(): RPack;
+	/**
+	 * This lifecycle method is called when this plugin is initialized in any environment.
+	 * Note that this method runs before environment-specific methods.
+	 * @see onInitHost
+	 * @see onInitClient
+	 */
 	onInit(): Promise<void>;
+	/**
+	 * This lifecycle method is called when this plugin is initialized in a client environment.
+	 * Note that this method runs after the generic {@link onInit} finishes executing.
+	 */
+	onInitClient(): Promise<void>;
+	/**
+	 * This lifecycle method is called when this plugin is initialized in a host environment.
+	 * Note that this method runs after the generic {@link onInit} finishes executing.
+	 */
+	onInitHost(): Promise<void>;
+	/**
+	 * This lifecycle method is called when this plugin is requested to shut down.
+	 *
+	 * By default, the plugin will only unload after this method
+	 * finishes executing. However, if this method is taking too
+	 * long to finish, the user can choose to terminate the plugin,
+	 * which will cause the execution to immediately halt.
+	 */
 	onShutdown(): Promise<void>;
 	/**
 	 * Internal method, do not use.
@@ -817,6 +852,11 @@ export declare namespace Registry {
 	function withDefaultOptions(options?: Partial<RegistryOptions>): RegistryOptions;
 	function withPublicDefaultOptions(options?: Partial<RegistryOptions>): PublicRegistryOptions;
 }
+export interface C2HHelloRequestPacket extends NoncePacket {
+	id: "host:hello_request";
+	name: string;
+	secret: string;
+}
 export interface C2PHelloRequestPacket extends NoncePacket {
 	id: "thread:hello_request";
 	threadId: string;
@@ -873,12 +913,49 @@ export interface DevPluginSourceServerManifest {
 	};
 	websocketRefresh?: boolean;
 }
+/**
+ * This class gives some information about the current environment the rPack.dev instance is running in.
+ */
 export interface EnvironmentInfo {
+	/**
+	 * Returns whether the current thread is a plugin thread.
+	 */
 	isPluginThread(): boolean;
+	/**
+	 * Returns whether this environment is a host.
+	 */
 	isHost(): boolean;
+	/**
+	 * Returns whether this environment is a client.
+	 */
 	isClient(): boolean;
+	/**
+	 * Returns the type of environment the current rPack.dev instance is.
+	 */
 	getEnvironmentType(): EnvironmentType;
+	/**
+	 * Returns the current Thread ID.
+	 */
 	getThreadId(): string;
+	/**
+	 * Returns the Messenger instance used to
+	 * communicate with the current core thread.
+	 *
+	 * This only works on plugin threads, otherwise returns null.
+	 */
+	getCoreMessenger(): Messenger<C2PPackets, P2CPackets> | null;
+	/**
+	 * Returns the Messenger interface used to
+	 * communicate with the current host.
+	 *
+	 * If there is no host connected (no project is open),
+	 * this method will return null.
+	 */
+	getHostMessenger(): Messenger<H2CPackets, C2HPackets> | null;
+}
+export interface H2CHelloResponsePacket extends NoncePacket {
+	id: "host:hello_response";
+	accepted: boolean;
 }
 export interface MessageTarget<T = any> {
 	postMessage(message: any, options?: {
@@ -1006,6 +1083,8 @@ export interface ProxyRefreshObjectResponsePacket extends NoncePacket {
 	value?: SerializedData;
 	error?: SerializedData;
 }
+export interface RPackHost {
+}
 export interface Registry<Data, Key extends JSONLike = string> extends RegistryBase {
 	get(key: Key): Promise<RegistryDataFiltered<Data> | undefined>;
 	getEntry(key: Key): Promise<RegistryEntry<Data, Key> | undefined>;
@@ -1203,6 +1282,9 @@ export type BatchResult<T> = {
 	done: boolean;
 	values: T[];
 };
+export type C2HPackets = {
+	"host:hello_request": C2HHelloRequestPacket;
+} & ProxyPackets & RegistryPackets;
 export type C2PPackets = {
 	"thread:hello_request": C2PHelloRequestPacket;
 	"thread:shutdown_request": C2PShutdownRequestPacket;
@@ -1237,6 +1319,9 @@ export type FixedLengthArray<T, L extends number, TObj = [
 	[I: number]: T;
 	[Symbol.iterator]: () => IterableIterator<T>;
 };
+export type H2CPackets = {
+	"host:hello_response": H2CHelloResponsePacket;
+} & ProxyPackets & RegistryPackets;
 export type JSONLike = string | number | boolean | null | {
 	[key: string]: JSONLike;
 } | JSONLike[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rpack-dev/core",
-  "version": "0.1.20-e0d3509",
+  "version": "0.1.20",
   "description": "",
   "license": "LGPL-3.0-or-later",
   "repository": {
@@ -52,7 +52,8 @@
     "typescript": "^5.0.0",
     "webpack": "^5.90.3",
     "webpack-cli": "^5.1.4",
-    "webpack-define-config": "^0.0.1"
+    "webpack-define-config": "^0.0.1",
+    "@rpack-dev/webpack-plugin": "^0.5.6"
   },
   "dependencies": {
     "jszip": "^3.10.1"