starpc 0.1.8 → 0.2.1

package/dist/srpc/broadcast-channel.d.ts

@@ -2,16 +2,18 @@ import type { Duplex, Sink } from 'it-stream-types';
 import { Conn, ConnParams } from './conn';
 import { Server } from './server';
 export declare class BroadcastChannelIterable<T> implements Duplex<T> {
-    readonly channel: BroadcastChannel;
+    readonly readChannel: BroadcastChannel;
+    readonly writeChannel: BroadcastChannel;
     sink: Sink<T>;
     source: AsyncIterable<T>;
-    constructor(channel: BroadcastChannel);
+    constructor(readChannel: BroadcastChannel, writeChannel: BroadcastChannel);
     private _createSink;
     private _createSource;
 }
-export declare function newBroadcastChannelIterable<T>(name: string): BroadcastChannelIterable<T>;
+export declare function newBroadcastChannelIterable<T>(readName: string, writeName: string): BroadcastChannelIterable<T>;
 export declare class BroadcastChannelConn extends Conn {
     private channel;
-    constructor(channel: BroadcastChannel, server?: Server, connParams?: ConnParams);
-    getBroadcastChannel(): BroadcastChannel;
+    constructor(readChannel: BroadcastChannel, writeChannel: BroadcastChannel, server?: Server, connParams?: ConnParams);
+    getReadChannel(): BroadcastChannel;
+    getWriteChannel(): BroadcastChannel;
 }

package/dist/srpc/broadcast-channel.js

@@ -3,14 +3,17 @@ import { EventIterator } from 'event-iterator';
 import { pipe } from 'it-pipe';
 // BroadcastChannelIterable is a AsyncIterable wrapper for BroadcastChannel.
 export class BroadcastChannelIterable {
-    // channel is the broadcast channel
-    channel;
+    // readChannel is the incoming broadcast channel
+    readChannel;
+    // writeChannel is the outgoing broadcast channel
+    writeChannel;
     // sink is the sink for incoming messages.
     sink;
     // source is the source for outgoing messages.
     source;
-    constructor(channel) {
-        this.channel = channel;
+    constructor(readChannel, writeChannel) {
+        this.readChannel = readChannel;
+        this.writeChannel = writeChannel;
         this.sink = this._createSink();
         this.source = this._createSource();
     }
@@ -18,7 +21,7 @@ export class BroadcastChannelIterable {
     _createSink() {
         return async (source) => {
             for await (const msg of source) {
-                this.channel.postMessage(msg);
+                this.writeChannel.postMessage(msg);
             }
         };
     }
@@ -30,17 +33,16 @@ export class BroadcastChannelIterable {
                     queue.push(ev.data);
                 }
             };
-            this.channel.addEventListener('message', messageListener);
+            this.readChannel.addEventListener('message', messageListener);
             return () => {
-                this.channel.removeEventListener('message', messageListener);
+                this.readChannel.removeEventListener('message', messageListener);
             };
         });
     }
 }
 // newBroadcastChannelIterable constructs a BroadcastChannelIterable with a channel name.
-export function newBroadcastChannelIterable(name) {
-    const channel = new BroadcastChannel(name);
-    return new BroadcastChannelIterable(channel);
+export function newBroadcastChannelIterable(readName, writeName) {
+    return new BroadcastChannelIterable(new BroadcastChannel(readName), new BroadcastChannel(writeName));
 }
 // BroadcastChannelConn implements a connection with a BroadcastChannel.
 //
@@ -48,13 +50,17 @@ export function newBroadcastChannelIterable(name) {
 export class BroadcastChannelConn extends Conn {
     // channel is the broadcast channel iterable
     channel;
-    constructor(channel, server, connParams) {
+    constructor(readChannel, writeChannel, server, connParams) {
         super(server, connParams);
-        this.channel = new BroadcastChannelIterable(channel);
+        this.channel = new BroadcastChannelIterable(readChannel, writeChannel);
         pipe(this, this.channel, this);
     }
-    // getBroadcastChannel returns the BroadcastChannel.
-    getBroadcastChannel() {
-        return this.channel.channel;
+    // getReadChannel returns the read BroadcastChannel.
+    getReadChannel() {
+        return this.channel.readChannel;
+    }
+    // getWriteChannel returns the write BroadcastChannel.
+    getWriteChannel() {
+        return this.channel.writeChannel;
     }
 }

package/dist/srpc/client-rpc.js

@@ -16,7 +16,7 @@ export class ClientRPC extends CommonRPC {
             rpcService: this.service,
             rpcMethod: this.method,
             data: data || new Uint8Array(0),
-            dataIsZero: (!!data) && data.length === 0,
+            dataIsZero: !!data && data.length === 0,
         };
         await this.writePacket({
             body: {

package/dist/srpc/common-rpc.js

@@ -29,7 +29,7 @@ export class CommonRPC {
     async writeCallData(data, complete, error) {
         const callData = {
             data: data || new Uint8Array(0),
-            dataIsZero: (!!data) && data.length === 0,
+            dataIsZero: !!data && data.length === 0,
             complete: complete || false,
             error: error || '',
         };

package/dist/srpc/index.d.ts

@@ -5,3 +5,4 @@ export { Conn } from './conn.js';
 export { Handler, InvokeFn, createHandler, createInvokeFn } from './handler.js';
 export { Mux, createMux } from './mux.js';
 export { WebSocketConn } from './websocket.js';
+export { BroadcastChannelIterable, newBroadcastChannelIterable, BroadcastChannelConn, } from './broadcast-channel';

package/dist/srpc/index.js

@@ -4,3 +4,4 @@ export { Conn } from './conn.js';
 export { createHandler, createInvokeFn } from './handler.js';
 export { createMux } from './mux.js';
 export { WebSocketConn } from './websocket.js';
+export { BroadcastChannelIterable, newBroadcastChannelIterable, BroadcastChannelConn, } from './broadcast-channel';

package/dist/srpc/mux.d.ts

@@ -1,5 +1,4 @@
-import { InvokeFn } from 'srpc';
-import { Handler } from './handler';
+import { InvokeFn, Handler } from './handler';
 export interface Mux {
     register(handler: Handler): void;
     lookupMethod(serviceID: string, methodID: string): Promise<InvokeFn | null>;

package/dist/srpc/server-rpc.js

@@ -23,7 +23,6 @@ export class ServerRPC extends CommonRPC {
         }
         this.pushRpcData(packet.data, packet.dataIsZero);
         this.invokeRPC(methodDef);
-        return super.handleCallStart(packet);
     }
     // handleCallData handles a CallData packet.
     async handleCallData(packet) {
@@ -35,8 +34,7 @@ export class ServerRPC extends CommonRPC {
     // invokeRPC starts invoking the RPC handler.
     invokeRPC(invokeFn) {
         const dataSink = this._createDataSink();
-        invokeFn(this.rpcDataSource, dataSink)
-            .catch((err) => {
+        invokeFn(this.rpcDataSource, dataSink).catch((err) => {
             this.close(err);
         });
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starpc",
-  "version": "0.1.8",
+  "version": "0.2.1",
   "description": "Streaming protobuf RPC service protocol over any two-way channel.",
   "license": "MIT",
   "author": {
@@ -36,6 +36,7 @@
   "scripts": {
     "build": "rimraf ./dist && tsc --project tsconfig.build.json --outDir ./dist/",
     "check": "tsc",
+    "deps": "depcheck",
     "codegen": "npm run gen",
     "ci": "npm run build && npm run lint:js && npm run lint:go",
     "format": "prettier --write './{srpc,echo,e2e,integration}/**/(*.ts|*.tsx|*.html|*.css)'",
@@ -56,29 +57,21 @@
     "singleQuote": true
   },
   "devDependencies": {
-    "@babel/core": "^7.18.5",
-    "@babel/preset-env": "^7.18.2",
-    "@babel/preset-typescript": "^7.17.12",
-    "@types/varint": "^6.0.0",
     "@typescript-eslint/eslint-plugin": "^5.27.1",
     "@typescript-eslint/parser": "^5.27.1",
-    "esbuild": "^0.14.44",
-    "eslint": "^8.17.0",
+    "depcheck": "^1.4.3",
+    "esbuild": "^0.14.46",
+    "eslint": "^8.18.0",
     "eslint-config-prettier": "^8.5.0",
-    "eslint-config-standard-with-typescript": "^21.0.1",
-    "eslint-plugin-react-hooks": "^4.6.0",
-    "husky": "^8.0.1",
-    "prettier": "^2.7.0",
+    "prettier": "^2.7.1",
     "rimraf": "^3.0.2",
-    "ts-eager": "^2.0.2",
-    "ts-node": "^10.8.1",
     "ts-proto": "^1.115.4",
-    "typescript": "^4.7.3"
+    "typescript": "^4.7.4"
   },
   "dependencies": {
-    "@libp2p/components": "^1.0.0",
-    "@libp2p/interface-connection": "^1.0.1",
-    "@libp2p/mplex": "^2.0.0",
+    "@libp2p/interface-connection": "^2.0.0",
+    "@libp2p/interface-stream-muxer": "^1.0.2",
+    "@libp2p/mplex": "^3.0.0",
     "event-iterator": "^2.0.0",
     "isomorphic-ws": "^4.0.1",
     "it-length-prefixed": "^7.0.1",
@@ -86,10 +79,10 @@
     "it-pushable": "^3.0.0",
     "it-stream-types": "^1.0.4",
     "it-ws": "^5.0.2",
+    "long": "^5.2.0",
     "patch-package": "^6.4.7",
     "protobufjs": "^6.11.3",
     "rxjs": "^7.5.5",
-    "ts-poet": "^4.13.0",
     "ws": "^8.8.0"
   }
 }

package/srpc/broadcast-channel.ts

@@ -6,15 +6,18 @@ import { Server } from './server'
 
 // BroadcastChannelIterable is a AsyncIterable wrapper for BroadcastChannel.
 export class BroadcastChannelIterable<T> implements Duplex<T> {
-  // channel is the broadcast channel
-  public readonly channel: BroadcastChannel
+  // readChannel is the incoming broadcast channel
+  public readonly readChannel: BroadcastChannel
+  // writeChannel is the outgoing broadcast channel
+  public readonly writeChannel: BroadcastChannel
   // sink is the sink for incoming messages.
   public sink: Sink<T>
   // source is the source for outgoing messages.
   public source: AsyncIterable<T>
 
-  constructor(channel: BroadcastChannel) {
-    this.channel = channel
+  constructor(readChannel: BroadcastChannel, writeChannel: BroadcastChannel) {
+    this.readChannel = readChannel
+    this.writeChannel = writeChannel
     this.sink = this._createSink()
     this.source = this._createSource()
   }
@@ -23,7 +26,7 @@ export class BroadcastChannelIterable<T> implements Duplex<T> {
   private _createSink(): Sink<T> {
     return async (source) => {
       for await (const msg of source) {
-        this.channel.postMessage(msg)
+        this.writeChannel.postMessage(msg)
       }
     }
   }
@@ -36,10 +39,10 @@ export class BroadcastChannelIterable<T> implements Duplex<T> {
           queue.push(ev.data)
         }
       }
-      this.channel.addEventListener('message', messageListener)
+      this.readChannel.addEventListener('message', messageListener)
 
       return () => {
-        this.channel.removeEventListener('message', messageListener)
+        this.readChannel.removeEventListener('message', messageListener)
       }
     })
   }
@@ -47,10 +50,13 @@ export class BroadcastChannelIterable<T> implements Duplex<T> {
 
 // newBroadcastChannelIterable constructs a BroadcastChannelIterable with a channel name.
 export function newBroadcastChannelIterable<T>(
-  name: string
+  readName: string,
+  writeName: string
 ): BroadcastChannelIterable<T> {
-  const channel = new BroadcastChannel(name)
-  return new BroadcastChannelIterable<T>(channel)
+  return new BroadcastChannelIterable<T>(
+    new BroadcastChannel(readName),
+    new BroadcastChannel(writeName)
+  )
 }
 
 // BroadcastChannelConn implements a connection with a BroadcastChannel.
@@ -61,17 +67,26 @@ export class BroadcastChannelConn extends Conn {
   private channel: BroadcastChannelIterable<Uint8Array>
 
   constructor(
-    channel: BroadcastChannel,
+    readChannel: BroadcastChannel,
+    writeChannel: BroadcastChannel,
     server?: Server,
     connParams?: ConnParams
   ) {
     super(server, connParams)
-    this.channel = new BroadcastChannelIterable<Uint8Array>(channel)
+    this.channel = new BroadcastChannelIterable<Uint8Array>(
+      readChannel,
+      writeChannel
+    )
     pipe(this, this.channel, this)
   }
 
-  // getBroadcastChannel returns the BroadcastChannel.
-  public getBroadcastChannel(): BroadcastChannel {
-    return this.channel.channel
+  // getReadChannel returns the read BroadcastChannel.
+  public getReadChannel(): BroadcastChannel {
+    return this.channel.readChannel
+  }
+
+  // getWriteChannel returns the write BroadcastChannel.
+  public getWriteChannel(): BroadcastChannel {
+    return this.channel.writeChannel
   }
 }

package/srpc/client-rpc.ts

@@ -19,7 +19,7 @@ export class ClientRPC extends CommonRPC {
       rpcService: this.service,
       rpcMethod: this.method,
       data: data || new Uint8Array(0),
-      dataIsZero: (!!data) && data.length === 0,
+      dataIsZero: !!data && data.length === 0,
     }
     await this.writePacket({
       body: {

package/srpc/client.ts

@@ -133,7 +133,7 @@ export class Client implements TsProtoRpc {
   private async startRpc(
     rpcService: string,
     rpcMethod: string,
-    data: Uint8Array | null,
+    data: Uint8Array | null
   ): Promise<ClientRPC> {
     const conn = await this.openConnFn()
     const call = new ClientRPC(rpcService, rpcMethod)

package/srpc/common-rpc.ts

@@ -48,7 +48,7 @@ export class CommonRPC {
   ) {
     const callData: CallData = {
       data: data || new Uint8Array(0),
-      dataIsZero: (!!data) && data.length === 0,
+      dataIsZero: !!data && data.length === 0,
       complete: complete || false,
       error: error || '',
     }
@@ -103,8 +103,11 @@ export class CommonRPC {
     )
   }
 
- // pushRpcData pushes incoming rpc data to the rpc data source.
-  protected pushRpcData(data: Uint8Array | undefined, dataIsZero: boolean | undefined) {
+  // pushRpcData pushes incoming rpc data to the rpc data source.
+  protected pushRpcData(
+    data: Uint8Array | undefined,
+    dataIsZero: boolean | undefined
+  ) {
     if (dataIsZero) {
       if (!data || data.length !== 0) {
         data = new Uint8Array(0)

package/srpc/handler.ts

@@ -66,11 +66,10 @@ export class StaticHandler implements Handler {
 
 // MethodProto is a function which matches one of the RPC signatures.
 type MethodProto =
-  ((request: unknown) => Promise<unknown>) |
-    ((request: unknown) => Observable<unknown>) |
-    ((request: Observable<unknown>) => Promise<unknown>) |
-    ((request: Observable<unknown>) => Observable<unknown>)
-
+  | ((request: unknown) => Promise<unknown>)
+  | ((request: unknown) => Observable<unknown>)
+  | ((request: Observable<unknown>) => Promise<unknown>)
+  | ((request: Observable<unknown>) => Observable<unknown>)
 
 // createInvokeFn builds an InvokeFn from a method definition and a function prototype.
 export function createInvokeFn(

package/srpc/index.ts

@@ -5,3 +5,8 @@ export { Conn } from './conn.js'
 export { Handler, InvokeFn, createHandler, createInvokeFn } from './handler.js'
 export { Mux, createMux } from './mux.js'
 export { WebSocketConn } from './websocket.js'
+export {
+  BroadcastChannelIterable,
+  newBroadcastChannelIterable,
+  BroadcastChannelConn,
+} from './broadcast-channel'

package/srpc/mux.ts

@@ -1,5 +1,4 @@
-import { InvokeFn } from 'srpc'
-import { Handler } from './handler'
+import { InvokeFn, Handler } from './handler'
 
 // Mux contains a set of <service, method> handlers.
 export interface Mux {

package/srpc/server-rpc.ts

@@ -31,7 +31,6 @@ export class ServerRPC extends CommonRPC {
     }
     this.pushRpcData(packet.data, packet.dataIsZero)
     this.invokeRPC(methodDef)
-    return super.handleCallStart(packet)
   }
 
   // handleCallData handles a CallData packet.
@@ -45,10 +44,9 @@ export class ServerRPC extends CommonRPC {
   // invokeRPC starts invoking the RPC handler.
   private invokeRPC(invokeFn: InvokeFn) {
     const dataSink = this._createDataSink()
-    invokeFn(this.rpcDataSource, dataSink)
-      .catch((err) => {
-        this.close(err)
-      })
+    invokeFn(this.rpcDataSource, dataSink).catch((err) => {
+      this.close(err)
+    })
   }
 
   // _createDataSink creates a sink for outgoing data packets.