@rpack-dev/core 0.1.19 → 0.1.20-cc8be57

package/dist/rpack-core.d.ts

@@ -17,7 +17,7 @@ declare class RPack {
 	 */
 	static createInstance(defaultInstance?: boolean): Promise<RPack>;
 	static getInstance(): RPack;
-	private readonly pluginThread;
+	private readonly environment;
 	private readonly loadPromise;
 	private readonly platform;
 	private readonly version;
@@ -42,11 +42,25 @@ 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;
+	getEnvironment(): EnvironmentInfo;
 	isPluginThread(): boolean;
+	isHost(): boolean;
+	isClient(): boolean;
 	/**
 	 * Shorthand for getNetworkManager().getPlugin().
 	 *
@@ -80,9 +94,9 @@ export declare abstract class RPPlatform {
 export declare abstract class RPackThread {
 	private readonly threadId;
 	private readonly messenger;
-	protected constructor(threadId: string, messenger: Messenger<W2HPackets, H2WPackets>);
+	protected constructor(threadId: string, messenger: Messenger<P2CPackets, C2PPackets>);
 	getThreadId(): string;
-	getMessenger(): Messenger<W2HPackets, H2WPackets>;
+	getMessenger(): Messenger<P2CPackets, C2PPackets>;
 	abstract disable(): Promise<void>;
 	abstract terminate(): Promise<void>;
 }
@@ -171,7 +185,7 @@ export declare class ArrayUtils {
 	 */
 	static naturalSort<T>(array: T[], func?: (element: T) => string): T[];
 }
-export declare class AsyncIterableIteratorMirror<T, E> implements AsyncIterableIterator<T> {
+export declare class AsyncIteratorMirror<T, E> implements AsyncIterableIterator<T> {
 	private readonly it;
 	private readonly converter;
 	constructor(it: Iterator<T>);
@@ -228,7 +242,7 @@ export declare class DevPluginSource implements PluginSource {
 	getPluginArchive(groupId: string, pluginId: string, version: string): Promise<PluginArchive>;
 	removeServer(client: DevPluginServerClient): void;
 }
-export declare class FilteredIterableIterator<T> implements IterableIterator<T> {
+export declare class FilteredIterator<T> implements IterableIterator<T> {
 	private readonly it;
 	private readonly filter;
 	constructor(it: Iterator<T>, filter: (t: T) => boolean);
@@ -242,7 +256,7 @@ export declare class FilteredIterableIterator<T> implements IterableIterator<T>
 	return(value?: any): IteratorResult<T>;
 	throw(e?: any): IteratorResult<T>;
 }
-export declare class LazyBatchedAsyncIterableIterator<T> implements AsyncIterableIterator<T> {
+export declare class LazyBatchedAsyncIterator<T> implements AsyncIterableIterator<T> {
 	private readonly supplier;
 	private readonly completeHandler?;
 	private readonly errorHandler?;
@@ -269,6 +283,11 @@ export declare class LazyPromise<T> {
 	isComplete(): boolean;
 	isErrored(): boolean;
 }
+/**
+ * A Proxy handler that functions as a wrapper around an object.
+ * This class turns function return values on the wrapped object
+ * into Promise objects to match Registry return types.
+ */
 export declare class LocalObject<T extends object> implements ProxyHandler<T> {
 	get(target: T, p: string | symbol, receiver: any): any;
 }
@@ -327,6 +346,18 @@ export declare class LocalRemoteMap<Local, Remote> {
 	hasRemote(key: string): boolean;
 	deleteRemote(key: string): boolean;
 }
+export declare class MappedIterator<T, K> implements IterableIterator<K> {
+	private readonly it;
+	private readonly map;
+	constructor(it: Iterator<T>, map: (t: T) => K);
+	[Symbol.iterator](): IterableIterator<K>;
+	next(...args: [
+	] | [
+		any
+	]): IteratorResult<K>;
+	return(value?: any): IteratorResult<K>;
+	throw(e?: any): IteratorResult<K>;
+}
 export declare class Messenger<InPackets extends PacketsType<InPackets>, OutPackets extends PacketsType<OutPackets>> {
 	private readonly handlerLists;
 	private readonly sender;
@@ -347,26 +378,29 @@ export declare class Messenger<InPackets extends PacketsType<InPackets>, OutPack
 	sendPacket<K extends keyof OutPackets>(packet: OutPackets[K]): void;
 	sendPacketWithNoncePromise<O extends keyof OnlyNoncePackets<OutPackets>, I extends keyof OnlyNoncePackets<InPackets>>(outPacketKey: O, outPacket: Omit<OutPackets[O], "nonce" | "id">, inPacket: I, timeout?: number): Promise<InPackets[I]>;
 	static cast<SIn extends TIn, SOut extends TOut, TIn extends PacketsType<TIn>, TOut extends PacketsType<TOut>>(source: Messenger<SIn, SOut>): Messenger<TIn, TOut>;
+	private static filterTransferable;
+	static transferableSend<T, In extends PacketsType<In>, Out extends PacketsType<Out>>(detection: (value: any) => boolean, target: MessageTarget<T>): Messenger<In, Out>;
+	static websocket<In extends PacketsType<In>, Out extends PacketsType<Out>>(websocket: WebSocket): Messenger<In, Out>;
 }
 export declare class NetworkManager {
-	static readonly HOST_THREAD_ID = "host";
+	static readonly CORE_THREAD_ID = "core";
 	private readonly rpack;
-	private hostMessenger?;
+	private coreMessenger?;
 	private threads?;
 	private readonly pluginRegistry;
 	private plugin;
 	private threadId;
 	private readonly wellKnownMap;
 	private readonly wellKnownReverseMap;
-	constructor(rpack: RPack, threadId: string, hostMessenger?: Messenger<H2WPackets, W2HPackets>);
+	constructor(rpack: RPack);
 	private mapWellKnown;
 	__initPlugin(pluginKey: string, scriptUrl: string): Promise<void>;
 	getRPack(): RPack;
-	getHostMessenger(): Messenger<H2WPackets, W2HPackets> | undefined;
+	getCoreMessenger(): Messenger<C2PPackets, P2CPackets> | undefined;
 	getCurrentThreadId(): string;
 	getPlugin<T extends RPPlugin>(key: string): Promise<RegistryDataFiltered<T> | undefined>;
 	getPluginRegistry(): Registry<RPPlugin, string>;
-	__initRemotes(threadId: string, messenger: Messenger<H2WPackets | W2HPackets, H2WPackets | W2HPackets>): void;
+	__initRemotes(threadId: string, messenger: Messenger<C2PPackets | P2CPackets, C2PPackets | P2CPackets>): void;
 	__createThread(pluginKey: string, scriptUrl: string): Promise<string>;
 	private ensureJSONInner;
 	private ensureJSON;
@@ -405,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.
@@ -685,7 +743,6 @@ export declare class Utils {
 	static getEnumConstants<E extends string | number>(enumClass: {
 		[x: string]: E;
 	}): E[];
-	static presentOrDefault<T>(value: T | undefined, defaultValue: T): T;
 	/**
 	 * Generates a random integer
 	 * between 0 (inclusive) and `to` (exclusive)
@@ -718,6 +775,7 @@ export declare class Utils {
 	 * @returns a random element
 	 */
 	static pickRandomElement<T>(array: T[]): T;
+	static withDefaults<D extends object>(data: D, defaults: D): D;
 }
 export declare class ZipPluginArchive extends PluginArchive {
 	private zip;
@@ -794,6 +852,20 @@ 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;
+	pluginKey: string;
+	scriptUrl: string;
+}
+export interface C2PShutdownRequestPacket extends NoncePacket {
+	id: "thread:shutdown_request";
+}
 export interface DevPluginSourceR2SHelloRPackPacket {
 	id: "hello_request_rpack";
 	rpackChannel: string;
@@ -841,14 +913,55 @@ export interface DevPluginSourceServerManifest {
 	};
 	websocketRefresh?: boolean;
 }
-export interface H2WHelloRequestPacket extends NoncePacket {
-	id: "thread:hello_request";
-	threadId: string;
-	pluginKey: string;
-	scriptUrl: string;
+/**
+ * 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<P2CPackets, C2PPackets> | null;
 }
-export interface H2WShutdownRequestPacket extends NoncePacket {
-	id: "thread:shutdown_request";
+export interface H2CHelloResponsePacket extends NoncePacket {
+	id: "host:hello_response";
+	accepted: boolean;
+}
+export interface MessageTarget<T = any> {
+	postMessage(message: any, options?: {
+		transfer?: T[];
+	}): void;
+	onmessage: ((event: MessageEvent<any>) => void) | null;
 }
 export interface MultiSetRegistry<Data, Key extends JSONLike = string> extends RegistryBase {
 	append(key: Key, value: Data): Promise<string>;
@@ -869,6 +982,15 @@ export interface MultiSetRegistryEntry<Data, Key extends JSONLike> {
 export interface NoncePacket {
 	nonce: string;
 }
+export interface P2CHelloResponsePacket extends NoncePacket {
+	id: "thread:hello_response";
+}
+export interface P2CPluginLoadPacket extends NoncePacket {
+	id: "thread:plugin_load";
+}
+export interface P2CShutdownResponsePacket extends NoncePacket {
+	id: "thread:shutdown_response";
+}
 export interface Packet {
 	id: string;
 }
@@ -961,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>;
@@ -1154,19 +1278,17 @@ export interface TableOptions<N extends number> {
 	padding?: string;
 	textAlign?: "left" | "center" | "right";
 }
-export interface W2HHelloResponsePacket extends NoncePacket {
-	id: "thread:hello_response";
-}
-export interface W2HPluginLoadPacket extends NoncePacket {
-	id: "thread:plugin_load";
-}
-export interface W2HShutdownResponsePacket extends NoncePacket {
-	id: "thread:shutdown_response";
-}
 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;
+} & ProxyPackets & RegistryPackets;
 /**
  * A type alias representing a constructor signature for creating instances of type `T`.
  *
@@ -1187,6 +1309,7 @@ export type DeserializedFilter<T> = Pick<T, {
 	[K in keyof T]: T[K] extends ((...args: infer P) => Promise<Serializable | void>) ? P extends [
 	] ? K : P[number] extends Serializable ? K : never : never;
 }[keyof T]>;
+export type EnvironmentType = "host" | "client";
 export type ErrorType = Error | EvalError | RangeError | ReferenceError | SyntaxError | TypeError | URIError;
 export type FixedLengthArray<T, L extends number, TObj = [
 	T,
@@ -1196,14 +1319,13 @@ export type FixedLengthArray<T, L extends number, TObj = [
 	[I: number]: T;
 	[Symbol.iterator]: () => IterableIterator<T>;
 };
-export type H2WPackets = {
-	"thread:hello_request": H2WHelloRequestPacket;
-	"thread:shutdown_request": H2WShutdownRequestPacket;
+export type H2CPackets = {
+	"host:hello_response": H2CHelloResponsePacket;
 } & ProxyPackets & RegistryPackets;
 export type JSONLike = string | number | boolean | null | {
 	[key: string]: JSONLike;
 } | JSONLike[];
-export type KnownModules = "@rpack-dev/core" | "@rpack-dev/platform-browser";
+export type KnownModules = "@rpack-dev/core" | "@rpack-dev/platform-browser/bridge" | "@rpack-dev/platform-browser/worker";
 export type MappedDeserializedData<T> = T extends SerializedUndefined ? undefined : T extends SerializedJSON ? JSONLike : T extends SerializedRegistry ? Registry<any, any> : T extends SerializedError ? ErrorType : T extends SerializedObject ? SerializableObject : T extends SerializedRegistryEntry ? RegistryObject<any> : T extends SerializedFunction ? SerializableFunction : T extends {
 	"type": "well_known";
 	"kind": "RPack";
@@ -1236,6 +1358,11 @@ export type OnlyNoncePacketTypes<Packets extends PacketsType<Packets>> = {
 export type OnlyNoncePackets<Packets extends PacketsType<Packets>> = {
 	[Key in OnlyNoncePacketTypes<Packets>]: Packets[Key] & NoncePacket;
 };
+export type P2CPackets = {
+	"thread:hello_response": P2CHelloResponsePacket;
+	"thread:plugin_load": P2CPluginLoadPacket;
+	"thread:shutdown_response": P2CShutdownResponsePacket;
+} & ProxyPackets & RegistryPackets;
 export type PacketHandler<T> = (packet: T) => unknown | false;
 export type PacketHandlers<T> = {
 	[Key in keyof T]?: (T[Key] extends void ? () => (void | false) : PacketHandler<T[Key]>)[];
@@ -1250,11 +1377,10 @@ export type PromisesOnly<T> = {
 export type ProxyCleanupTarget = "object" | "iterator" | "array" | "function";
 export type PublicRegistryOptions = typeof DefaultPublicRegistryOptions;
 export type RPackConstructorOptions = {
-	pluginThread: boolean;
 	loadPromise: Promise<void>;
+	environment: EnvironmentInfo;
 	platform: RPPlatform;
-	threadId: string;
-	hostMessenger?: Messenger<H2WPackets, W2HPackets>;
+	hostMessenger?: Messenger<C2PPackets, P2CPackets>;
 	version: RPVersion;
 };
 export type RegistryDataFiltered<Data> = Data extends Serializable ? Data : {
@@ -1272,11 +1398,6 @@ export type Serializable = undefined | JSONLike | RegistryType | ErrorType | Wel
 export type SerializableFunction = (...args: Serializable[]) => Promise<Serializable>;
 export type SerializableObject = Record<string, SerializableFunction>;
 export type SerializedData = SerializedUndefined | SerializedJSON | SerializedRegistry | SerializedError | SerializedObject | SerializedFunction | SerializedWellKnown;
-export type W2HPackets = {
-	"thread:hello_response": W2HHelloResponsePacket;
-	"thread:plugin_load": W2HPluginLoadPacket;
-	"thread:shutdown_response": W2HShutdownResponsePacket;
-} & ProxyPackets & RegistryPackets;
 export type WellKnownType = RPack | NetworkManager | ProxyManager | RegistryManager;
 
 export {

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@rpack-dev/core",
-  "version": "0.1.19",
+  "version": "0.1.20-cc8be57",
   "description": "",
   "license": "LGPL-3.0-or-later",
   "repository": {
     "type": "git",
     "url": "https://github.com/rpack-dev/rpack-dev.git"
   },
+  "sideEffects": false,
   "scripts": {
     "test": "tsx node_modules/jasmine/bin/jasmine --config=jasmine.json",
     "prebuild:barrel": "ctix build",