capnweb 0.0.0-85fde1b → 0.0.0-8a47045

package/dist/index.d.cts

@@ -23,21 +23,21 @@ type Stubable = RpcTargetBranded | ((...args: any[]) => any);
 // The reason for using a generic type here is to build a serializable subset of structured
 //   cloneable composite types. This allows types defined with the "interface" keyword to pass the
 //   serializable check as well. Otherwise, only types defined with the "type" keyword would pass.
-type Serializable<T> =
+type RpcCompatible<T> =
   // Structured cloneables
   | BaseType
   // Structured cloneable composites
   | Map<
-      T extends Map<infer U, unknown> ? Serializable<U> : never,
-      T extends Map<unknown, infer U> ? Serializable<U> : never
+      T extends Map<infer U, unknown> ? RpcCompatible<U> : never,
+      T extends Map<unknown, infer U> ? RpcCompatible<U> : never
     >
-  | Set<T extends Set<infer U> ? Serializable<U> : never>
-  | Array<T extends Array<infer U> ? Serializable<U> : never>
-  | ReadonlyArray<T extends ReadonlyArray<infer U> ? Serializable<U> : never>
+  | Set<T extends Set<infer U> ? RpcCompatible<U> : never>
+  | Array<T extends Array<infer U> ? RpcCompatible<U> : never>
+  | ReadonlyArray<T extends ReadonlyArray<infer U> ? RpcCompatible<U> : never>
   | {
-      [K in keyof T]: K extends number | string ? Serializable<T[K]> : never;
+      [K in keyof T]: K extends number | string ? RpcCompatible<T[K]> : never;
     }
-  | Promise<T extends Promise<infer U> ? Serializable<U> : never>
+  | Promise<T extends Promise<infer U> ? RpcCompatible<U> : never>
   // Special types
   | Stub<Stubable>
   // Serialized as stubs, see `Stubify`
@@ -45,12 +45,12 @@ type Serializable<T> =
 
 // Base type for all RPC stubs, including common memory management methods.
 // `T` is used as a marker type for unwrapping `Stub`s later.
-interface StubBase<T extends Serializable<T>> extends Disposable {
+interface StubBase<T extends RpcCompatible<T>> extends Disposable {
   [__RPC_STUB_BRAND]: T;
   dup(): this;
   onRpcBroken(callback: (error: any) => void): void;
 }
-type Stub<T extends Serializable<T>> =
+type Stub<T extends RpcCompatible<T>> =
     T extends object ? Provider<T> & StubBase<T> : StubBase<T>;
 
 type TypedArray =
@@ -127,7 +127,7 @@ type MaybeDisposable<T> = T extends object ? Disposable : unknown;
 
 // Type for method return or property on an RPC interface.
 // - Stubable types are replaced by stubs.
-// - Serializable types are passed by value, with stubable types replaced by stubs
+// - RpcCompatible types are passed by value, with stubable types replaced by stubs
 //   and a top-level `Disposer`.
 // Everything else can't be passed over RPC.
 // Technically, we use custom thenables here, but they quack like `Promise`s.
@@ -135,7 +135,7 @@ type MaybeDisposable<T> = T extends object ? Disposable : unknown;
 // prettier-ignore
 type Result<R> =
   R extends Stubable ? Promise<Stub<R>> & Provider<R> & StubBase<R>
-  : R extends Serializable<R> ? Promise<Stubify<R> & MaybeDisposable<R>> & Provider<R> & StubBase<R>
+  : R extends RpcCompatible<R> ? Promise<Stubify<R> & MaybeDisposable<R>> & Provider<R> & StubBase<R>
   : never;
 
 // Type for method or property on an RPC interface.
@@ -266,9 +266,9 @@ declare function nodeHttpBatchRpcResponse(request: IncomingMessage, response: Se
  * such method exists on the remote object, an exception is thrown back. But the client does not
  * actually know, until that point, what methods exist.
  */
-type RpcStub<T extends Serializable<T>> = Stub<T>;
+type RpcStub<T extends RpcCompatible<T>> = Stub<T>;
 declare const RpcStub: {
-    new <T extends Serializable<T>>(value: T): RpcStub<T>;
+    new <T extends RpcCompatible<T>>(value: T): RpcStub<T>;
 };
 /**
  * Represents the result of an RPC call.
@@ -288,14 +288,14 @@ declare const RpcStub: {
  * if you only intend to use the promise for pipelining and you never await it, then there's no
  * need to transmit the resolution!
  */
-type RpcPromise<T extends Serializable<T>> = Stub<T> & Promise<Stubify<T>>;
+type RpcPromise<T extends RpcCompatible<T>> = Stub<T> & Promise<Stubify<T>>;
 declare const RpcPromise: {};
 /**
  * Use to construct an `RpcSession` on top of a custom `RpcTransport`.
  *
  * Most people won't use this. You only need it if you've implemented your own `RpcTransport`.
  */
-interface RpcSession<T extends Serializable<T> = undefined> {
+interface RpcSession<T extends RpcCompatible<T> = undefined> {
     getRemoteMain(): RpcStub<T>;
     getStats(): {
         imports: number;
@@ -304,7 +304,7 @@ interface RpcSession<T extends Serializable<T> = undefined> {
     drain(): Promise<void>;
 }
 declare const RpcSession: {
-    new <T extends Serializable<T> = undefined>(transport: RpcTransport, localMain?: any, options?: RpcSessionOptions): RpcSession<T>;
+    new <T extends RpcCompatible<T> = undefined>(transport: RpcTransport, localMain?: any, options?: RpcSessionOptions): RpcSession<T>;
 };
 /**
  * Classes which are intended to be passed by reference and called over RPC must extend
@@ -333,7 +333,7 @@ interface Empty {
  * @param localMain The main RPC interface to expose to the peer. Returns a stub for the main
  * interface exposed from the peer.
  */
-declare let newWebSocketRpcSession: <T extends Serializable<T> = Empty>(webSocket: WebSocket | string, localMain?: any, options?: RpcSessionOptions) => RpcStub<T>;
+declare let newWebSocketRpcSession: <T extends RpcCompatible<T> = Empty>(webSocket: WebSocket | string, localMain?: any, options?: RpcSessionOptions) => RpcStub<T>;
 /**
  * Initiate an HTTP batch session from the client side.
  *
@@ -341,13 +341,13 @@ declare let newWebSocketRpcSession: <T extends Serializable<T> = Empty>(webSocke
  * value is an RpcStub. You can customize anything about the request except for the method
  * (it will always be set to POST) and the body (which the RPC system will fill in).
  */
-declare let newHttpBatchRpcSession: <T extends Serializable<T>>(urlOrRequest: string | Request, options?: RpcSessionOptions) => RpcStub<T>;
+declare let newHttpBatchRpcSession: <T extends RpcCompatible<T>>(urlOrRequest: string | Request, options?: RpcSessionOptions) => RpcStub<T>;
 /**
  * Initiate an RPC session over a MessagePort, which is particularly useful for communicating
  * between an iframe and its parent frame in a browser context. Each side should call this function
  * on its own end of the MessageChannel.
  */
-declare let newMessagePortRpcSession: <T extends Serializable<T> = Empty>(port: MessagePort, localMain?: any, options?: RpcSessionOptions) => RpcStub<T>;
+declare let newMessagePortRpcSession: <T extends RpcCompatible<T> = Empty>(port: MessagePort, localMain?: any, options?: RpcSessionOptions) => RpcStub<T>;
 /**
  * Implements unified handling of HTTP-batch and WebSocket responses for the Cloudflare Workers
  * Runtime.
@@ -361,4 +361,4 @@ declare let newMessagePortRpcSession: <T extends Serializable<T> = Empty>(port:
  */
 declare function newWorkersRpcResponse(request: Request, localMain: any): Promise<Response>;
 
-export { RpcPromise, RpcSession, type RpcSessionOptions, RpcStub, RpcTarget, type RpcTransport, deserialize, newHttpBatchRpcResponse, newHttpBatchRpcSession, newMessagePortRpcSession, newWebSocketRpcSession, newWorkersRpcResponse, newWorkersWebSocketRpcResponse, nodeHttpBatchRpcResponse, serialize };
+export { type RpcCompatible, RpcPromise, RpcSession, type RpcSessionOptions, RpcStub, RpcTarget, type RpcTransport, deserialize, newHttpBatchRpcResponse, newHttpBatchRpcSession, newMessagePortRpcSession, newWebSocketRpcSession, newWorkersRpcResponse, newWorkersWebSocketRpcResponse, nodeHttpBatchRpcResponse, serialize };

package/dist/index.d.ts

@@ -23,21 +23,21 @@ type Stubable = RpcTargetBranded | ((...args: any[]) => any);
 // The reason for using a generic type here is to build a serializable subset of structured
 //   cloneable composite types. This allows types defined with the "interface" keyword to pass the
 //   serializable check as well. Otherwise, only types defined with the "type" keyword would pass.
-type Serializable<T> =
+type RpcCompatible<T> =
   // Structured cloneables
   | BaseType
   // Structured cloneable composites
   | Map<
-      T extends Map<infer U, unknown> ? Serializable<U> : never,
-      T extends Map<unknown, infer U> ? Serializable<U> : never
+      T extends Map<infer U, unknown> ? RpcCompatible<U> : never,
+      T extends Map<unknown, infer U> ? RpcCompatible<U> : never
     >
-  | Set<T extends Set<infer U> ? Serializable<U> : never>
-  | Array<T extends Array<infer U> ? Serializable<U> : never>
-  | ReadonlyArray<T extends ReadonlyArray<infer U> ? Serializable<U> : never>
+  | Set<T extends Set<infer U> ? RpcCompatible<U> : never>
+  | Array<T extends Array<infer U> ? RpcCompatible<U> : never>
+  | ReadonlyArray<T extends ReadonlyArray<infer U> ? RpcCompatible<U> : never>
   | {
-      [K in keyof T]: K extends number | string ? Serializable<T[K]> : never;
+      [K in keyof T]: K extends number | string ? RpcCompatible<T[K]> : never;
     }
-  | Promise<T extends Promise<infer U> ? Serializable<U> : never>
+  | Promise<T extends Promise<infer U> ? RpcCompatible<U> : never>
   // Special types
   | Stub<Stubable>
   // Serialized as stubs, see `Stubify`
@@ -45,12 +45,12 @@ type Serializable<T> =
 
 // Base type for all RPC stubs, including common memory management methods.
 // `T` is used as a marker type for unwrapping `Stub`s later.
-interface StubBase<T extends Serializable<T>> extends Disposable {
+interface StubBase<T extends RpcCompatible<T>> extends Disposable {
   [__RPC_STUB_BRAND]: T;
   dup(): this;
   onRpcBroken(callback: (error: any) => void): void;
 }
-type Stub<T extends Serializable<T>> =
+type Stub<T extends RpcCompatible<T>> =
     T extends object ? Provider<T> & StubBase<T> : StubBase<T>;
 
 type TypedArray =
@@ -127,7 +127,7 @@ type MaybeDisposable<T> = T extends object ? Disposable : unknown;
 
 // Type for method return or property on an RPC interface.
 // - Stubable types are replaced by stubs.
-// - Serializable types are passed by value, with stubable types replaced by stubs
+// - RpcCompatible types are passed by value, with stubable types replaced by stubs
 //   and a top-level `Disposer`.
 // Everything else can't be passed over RPC.
 // Technically, we use custom thenables here, but they quack like `Promise`s.
@@ -135,7 +135,7 @@ type MaybeDisposable<T> = T extends object ? Disposable : unknown;
 // prettier-ignore
 type Result<R> =
   R extends Stubable ? Promise<Stub<R>> & Provider<R> & StubBase<R>
-  : R extends Serializable<R> ? Promise<Stubify<R> & MaybeDisposable<R>> & Provider<R> & StubBase<R>
+  : R extends RpcCompatible<R> ? Promise<Stubify<R> & MaybeDisposable<R>> & Provider<R> & StubBase<R>
   : never;
 
 // Type for method or property on an RPC interface.
@@ -266,9 +266,9 @@ declare function nodeHttpBatchRpcResponse(request: IncomingMessage, response: Se
  * such method exists on the remote object, an exception is thrown back. But the client does not
  * actually know, until that point, what methods exist.
  */
-type RpcStub<T extends Serializable<T>> = Stub<T>;
+type RpcStub<T extends RpcCompatible<T>> = Stub<T>;
 declare const RpcStub: {
-    new <T extends Serializable<T>>(value: T): RpcStub<T>;
+    new <T extends RpcCompatible<T>>(value: T): RpcStub<T>;
 };
 /**
  * Represents the result of an RPC call.
@@ -288,14 +288,14 @@ declare const RpcStub: {
  * if you only intend to use the promise for pipelining and you never await it, then there's no
  * need to transmit the resolution!
  */
-type RpcPromise<T extends Serializable<T>> = Stub<T> & Promise<Stubify<T>>;
+type RpcPromise<T extends RpcCompatible<T>> = Stub<T> & Promise<Stubify<T>>;
 declare const RpcPromise: {};
 /**
  * Use to construct an `RpcSession` on top of a custom `RpcTransport`.
  *
  * Most people won't use this. You only need it if you've implemented your own `RpcTransport`.
  */
-interface RpcSession<T extends Serializable<T> = undefined> {
+interface RpcSession<T extends RpcCompatible<T> = undefined> {
     getRemoteMain(): RpcStub<T>;
     getStats(): {
         imports: number;
@@ -304,7 +304,7 @@ interface RpcSession<T extends Serializable<T> = undefined> {
     drain(): Promise<void>;
 }
 declare const RpcSession: {
-    new <T extends Serializable<T> = undefined>(transport: RpcTransport, localMain?: any, options?: RpcSessionOptions): RpcSession<T>;
+    new <T extends RpcCompatible<T> = undefined>(transport: RpcTransport, localMain?: any, options?: RpcSessionOptions): RpcSession<T>;
 };
 /**
  * Classes which are intended to be passed by reference and called over RPC must extend
@@ -333,7 +333,7 @@ interface Empty {
  * @param localMain The main RPC interface to expose to the peer. Returns a stub for the main
  * interface exposed from the peer.
  */
-declare let newWebSocketRpcSession: <T extends Serializable<T> = Empty>(webSocket: WebSocket | string, localMain?: any, options?: RpcSessionOptions) => RpcStub<T>;
+declare let newWebSocketRpcSession: <T extends RpcCompatible<T> = Empty>(webSocket: WebSocket | string, localMain?: any, options?: RpcSessionOptions) => RpcStub<T>;
 /**
  * Initiate an HTTP batch session from the client side.
  *
@@ -341,13 +341,13 @@ declare let newWebSocketRpcSession: <T extends Serializable<T> = Empty>(webSocke
  * value is an RpcStub. You can customize anything about the request except for the method
  * (it will always be set to POST) and the body (which the RPC system will fill in).
  */
-declare let newHttpBatchRpcSession: <T extends Serializable<T>>(urlOrRequest: string | Request, options?: RpcSessionOptions) => RpcStub<T>;
+declare let newHttpBatchRpcSession: <T extends RpcCompatible<T>>(urlOrRequest: string | Request, options?: RpcSessionOptions) => RpcStub<T>;
 /**
  * Initiate an RPC session over a MessagePort, which is particularly useful for communicating
  * between an iframe and its parent frame in a browser context. Each side should call this function
  * on its own end of the MessageChannel.
  */
-declare let newMessagePortRpcSession: <T extends Serializable<T> = Empty>(port: MessagePort, localMain?: any, options?: RpcSessionOptions) => RpcStub<T>;
+declare let newMessagePortRpcSession: <T extends RpcCompatible<T> = Empty>(port: MessagePort, localMain?: any, options?: RpcSessionOptions) => RpcStub<T>;
 /**
  * Implements unified handling of HTTP-batch and WebSocket responses for the Cloudflare Workers
  * Runtime.
@@ -361,4 +361,4 @@ declare let newMessagePortRpcSession: <T extends Serializable<T> = Empty>(port:
  */
 declare function newWorkersRpcResponse(request: Request, localMain: any): Promise<Response>;
 
-export { RpcPromise, RpcSession, type RpcSessionOptions, RpcStub, RpcTarget, type RpcTransport, deserialize, newHttpBatchRpcResponse, newHttpBatchRpcSession, newMessagePortRpcSession, newWebSocketRpcSession, newWorkersRpcResponse, newWorkersWebSocketRpcResponse, nodeHttpBatchRpcResponse, serialize };
+export { type RpcCompatible, RpcPromise, RpcSession, type RpcSessionOptions, RpcStub, RpcTarget, type RpcTransport, deserialize, newHttpBatchRpcResponse, newHttpBatchRpcSession, newMessagePortRpcSession, newWebSocketRpcSession, newWorkersRpcResponse, newWorkersWebSocketRpcResponse, nodeHttpBatchRpcResponse, serialize };