starpc 0.10.6 → 0.10.8

package/README.md

@@ -1,11 +1,22 @@
 # Stream RPC
 
+[![GoDoc Widget]][GoDoc] [![Go Report Card Widget]][Go Report Card]
+
+> Protobuf 3 RPC services over any stream multiplexer.
+
+[GoDoc]: https://godoc.org/github.com/aperturerobotics/starpc
+[GoDoc Widget]: https://godoc.org/github.com/aperturerobotics/starpc?status.svg
+[Go Report Card Widget]: https://goreportcard.com/badge/github.com/aperturerobotics/starpc
+[Go Report Card]: https://goreportcard.com/report/github.com/aperturerobotics/starpc
+
+## Introduction
+
 **starpc** implements [Proto3 services] (server & client) in both TypeScript and Go.
 
 [Proto3 services]: https://developers.google.com/protocol-buffers/docs/proto3#services
 
 Supports **client-to-server streaming** RPCs in the web browser, currently not
-supported by any of the major RPC libraries.
+supported by any of the other RPC libraries.
 
 The [rpcproto](./srpc/rpcproto.proto) file describes the protocol.
 
@@ -17,7 +28,7 @@ Can use any Stream multiplexer: defaults to [libp2p-mplex] over a WebSocket.
 
 [rpcstream]: ./rpcstream
 
-# Usage
+## Usage
 
 Start with the [protobuf-project] template repository on the "starpc" branch.
 
@@ -26,13 +37,13 @@ Start with the [protobuf-project] template repository on the "starpc" branch.
 Use "git add" to add your new .proto files, then `yarn gen` to generate the
 TypeScript and Go code.
 
-# Examples
+## Examples
 
 The demo/boilerplate project implements the Echo example below.
 
 This repository uses protowrap, see the [Makefile](./Makefile).
 
-## Protobuf
+### Protobuf
 
 The following examples use the [echo](./echo/echo.proto) protobuf sample.
 
@@ -58,7 +69,7 @@ message EchoMsg {
 }
 ```
 
-## Go
+### Go
 
 This example demonstrates both the server and client:
 
@@ -94,7 +105,7 @@ if out.GetBody() != bodyTxt {
 
 [e2e test]: ./e2e/e2e_test.go
 
-## TypeScript
+### TypeScript
 
 See the ts-proto README to generate the TypeScript for your protobufs.
 
@@ -155,7 +166,7 @@ for await (const msg of serverStream) {
 }
 ```
 
-## WebSocket
+### WebSocket
 
 One way to integrate Go and TypeScript is over a WebSocket:
 
@@ -186,7 +197,7 @@ Uses [vtprotobuf] to generate Protobuf marshal / unmarshal code.
 
 [vtprotobuf]: https://github.com/planetscale/vtprotobuf
 
-# Support
+## Support
 
 Starpc is built & supported by Aperture Robotics, LLC.
 

package/dist/echo/echo.pb.d.ts

@@ -1,6 +1,6 @@
-import Long from 'long';
-import _m0 from 'protobufjs/minimal.js';
-import { RpcStreamPacket } from '../rpcstream/rpcstream.pb.js';
+import Long from "long";
+import _m0 from "protobufjs/minimal.js";
+import { RpcStreamPacket } from "../rpcstream/rpcstream.pb.js";
 export declare const protobufPackage = "echo";
 /** EchoMsg is the message body for Echo. */
 export interface EchoMsg {
@@ -322,9 +322,9 @@ declare type Builtin = Date | Function | Uint8Array | string | number | boolean
 export declare type DeepPartial<T> = T extends Builtin ? T : T extends Long ? string | number | Long : T extends Array<infer U> ? Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {
     $case: string;
 } ? {
-    [K in keyof Omit<T, '$case'>]?: DeepPartial<T[K]>;
+    [K in keyof Omit<T, "$case">]?: DeepPartial<T[K]>;
 } & {
-    $case: T['$case'];
+    $case: T["$case"];
 } : T extends {} ? {
     [K in keyof T]?: DeepPartial<T[K]>;
 } : Partial<T>;

package/dist/echo/echo.pb.js

@@ -1,14 +1,14 @@
 /* eslint-disable */
-import Long from 'long';
-import _m0 from 'protobufjs/minimal.js';
-import { RpcStreamPacket } from '../rpcstream/rpcstream.pb.js';
-export const protobufPackage = 'echo';
+import Long from "long";
+import _m0 from "protobufjs/minimal.js";
+import { RpcStreamPacket } from "../rpcstream/rpcstream.pb.js";
+export const protobufPackage = "echo";
 function createBaseEchoMsg() {
-    return { body: '' };
+    return { body: "" };
 }
 export const EchoMsg = {
     encode(message, writer = _m0.Writer.create()) {
-        if (message.body !== '') {
+        if (message.body !== "") {
             writer.uint32(10).string(message.body);
         }
         return writer;
@@ -59,7 +59,7 @@ export const EchoMsg = {
         }
     },
     fromJSON(object) {
-        return { body: isSet(object.body) ? String(object.body) : '' };
+        return { body: isSet(object.body) ? String(object.body) : "" };
     },
     toJSON(message) {
         const obj = {};
@@ -68,7 +68,7 @@ export const EchoMsg = {
     },
     fromPartial(object) {
         const message = createBaseEchoMsg();
-        message.body = object.body ?? '';
+        message.body = object.body ?? "";
         return message;
     },
 };
@@ -83,37 +83,37 @@ export class EchoerClientImpl {
     }
     Echo(request) {
         const data = EchoMsg.encode(request).finish();
-        const promise = this.rpc.request('echo.Echoer', 'Echo', data);
+        const promise = this.rpc.request("echo.Echoer", "Echo", data);
         return promise.then((data) => EchoMsg.decode(new _m0.Reader(data)));
     }
     EchoServerStream(request) {
         const data = EchoMsg.encode(request).finish();
-        const result = this.rpc.serverStreamingRequest('echo.Echoer', 'EchoServerStream', data);
+        const result = this.rpc.serverStreamingRequest("echo.Echoer", "EchoServerStream", data);
         return EchoMsg.decodeTransform(result);
     }
     EchoClientStream(request) {
         const data = EchoMsg.encodeTransform(request);
-        const promise = this.rpc.clientStreamingRequest('echo.Echoer', 'EchoClientStream', data);
+        const promise = this.rpc.clientStreamingRequest("echo.Echoer", "EchoClientStream", data);
         return promise.then((data) => EchoMsg.decode(new _m0.Reader(data)));
     }
     EchoBidiStream(request) {
         const data = EchoMsg.encodeTransform(request);
-        const result = this.rpc.bidirectionalStreamingRequest('echo.Echoer', 'EchoBidiStream', data);
+        const result = this.rpc.bidirectionalStreamingRequest("echo.Echoer", "EchoBidiStream", data);
         return EchoMsg.decodeTransform(result);
     }
     RpcStream(request) {
         const data = RpcStreamPacket.encodeTransform(request);
-        const result = this.rpc.bidirectionalStreamingRequest('echo.Echoer', 'RpcStream', data);
+        const result = this.rpc.bidirectionalStreamingRequest("echo.Echoer", "RpcStream", data);
         return RpcStreamPacket.decodeTransform(result);
     }
 }
 export const EchoerDefinition = {
-    name: 'Echoer',
-    fullName: 'echo.Echoer',
+    name: "Echoer",
+    fullName: "echo.Echoer",
     methods: {
         /** Echo returns the given message. */
         echo: {
-            name: 'Echo',
+            name: "Echo",
             requestType: EchoMsg,
             requestStream: false,
             responseType: EchoMsg,
@@ -122,7 +122,7 @@ export const EchoerDefinition = {
         },
         /** EchoServerStream is an example of a server -> client one-way stream. */
         echoServerStream: {
-            name: 'EchoServerStream',
+            name: "EchoServerStream",
             requestType: EchoMsg,
             requestStream: false,
             responseType: EchoMsg,
@@ -131,7 +131,7 @@ export const EchoerDefinition = {
         },
         /** EchoClientStream is an example of client->server one-way stream. */
         echoClientStream: {
-            name: 'EchoClientStream',
+            name: "EchoClientStream",
             requestType: EchoMsg,
             requestStream: true,
             responseType: EchoMsg,
@@ -140,7 +140,7 @@ export const EchoerDefinition = {
         },
         /** EchoBidiStream is an example of a two-way stream. */
         echoBidiStream: {
-            name: 'EchoBidiStream',
+            name: "EchoBidiStream",
             requestType: EchoMsg,
             requestStream: true,
             responseType: EchoMsg,
@@ -149,7 +149,7 @@ export const EchoerDefinition = {
         },
         /** RpcStream opens a nested rpc call stream. */
         rpcStream: {
-            name: 'RpcStream',
+            name: "RpcStream",
             requestType: RpcStreamPacket,
             requestStream: true,
             responseType: RpcStreamPacket,

package/dist/rpcstream/rpcstream.pb.d.ts

@@ -1,16 +1,16 @@
-import Long from 'long';
-import _m0 from 'protobufjs/minimal.js';
+import Long from "long";
+import _m0 from "protobufjs/minimal.js";
 export declare const protobufPackage = "rpcstream";
 /** RpcStreamPacket is a packet encapsulating data for a RPC stream. */
 export interface RpcStreamPacket {
     body?: {
-        $case: 'init';
+        $case: "init";
         init: RpcStreamInit;
     } | {
-        $case: 'ack';
+        $case: "ack";
         ack: RpcAck;
     } | {
-        $case: 'data';
+        $case: "data";
         data: Uint8Array;
     };
 }
@@ -116,9 +116,9 @@ declare type Builtin = Date | Function | Uint8Array | string | number | boolean
 export declare type DeepPartial<T> = T extends Builtin ? T : T extends Long ? string | number | Long : T extends Array<infer U> ? Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {
     $case: string;
 } ? {
-    [K in keyof Omit<T, '$case'>]?: DeepPartial<T[K]>;
+    [K in keyof Omit<T, "$case">]?: DeepPartial<T[K]>;
 } & {
-    $case: T['$case'];
+    $case: T["$case"];
 } : T extends {} ? {
     [K in keyof T]?: DeepPartial<T[K]>;
 } : Partial<T>;

package/dist/rpcstream/rpcstream.pb.js

@@ -1,19 +1,19 @@
 /* eslint-disable */
-import Long from 'long';
-import _m0 from 'protobufjs/minimal.js';
-export const protobufPackage = 'rpcstream';
+import Long from "long";
+import _m0 from "protobufjs/minimal.js";
+export const protobufPackage = "rpcstream";
 function createBaseRpcStreamPacket() {
     return { body: undefined };
 }
 export const RpcStreamPacket = {
     encode(message, writer = _m0.Writer.create()) {
-        if (message.body?.$case === 'init') {
+        if (message.body?.$case === "init") {
             RpcStreamInit.encode(message.body.init, writer.uint32(10).fork()).ldelim();
         }
-        if (message.body?.$case === 'ack') {
+        if (message.body?.$case === "ack") {
             RpcAck.encode(message.body.ack, writer.uint32(18).fork()).ldelim();
         }
-        if (message.body?.$case === 'data') {
+        if (message.body?.$case === "data") {
             writer.uint32(26).bytes(message.body.data);
         }
         return writer;
@@ -26,19 +26,13 @@ export const RpcStreamPacket = {
             const tag = reader.uint32();
             switch (tag >>> 3) {
                 case 1:
-                    message.body = {
-                        $case: 'init',
-                        init: RpcStreamInit.decode(reader, reader.uint32()),
-                    };
+                    message.body = { $case: "init", init: RpcStreamInit.decode(reader, reader.uint32()) };
                     break;
                 case 2:
-                    message.body = {
-                        $case: 'ack',
-                        ack: RpcAck.decode(reader, reader.uint32()),
-                    };
+                    message.body = { $case: "ack", ack: RpcAck.decode(reader, reader.uint32()) };
                     break;
                 case 3:
-                    message.body = { $case: 'data', data: reader.bytes() };
+                    message.body = { $case: "data", data: reader.bytes() };
                     break;
                 default:
                     reader.skipType(tag & 7);
@@ -78,60 +72,43 @@ export const RpcStreamPacket = {
     fromJSON(object) {
         return {
             body: isSet(object.init)
-                ? { $case: 'init', init: RpcStreamInit.fromJSON(object.init) }
+                ? { $case: "init", init: RpcStreamInit.fromJSON(object.init) }
                 : isSet(object.ack)
-                    ? { $case: 'ack', ack: RpcAck.fromJSON(object.ack) }
+                    ? { $case: "ack", ack: RpcAck.fromJSON(object.ack) }
                     : isSet(object.data)
-                        ? { $case: 'data', data: bytesFromBase64(object.data) }
+                        ? { $case: "data", data: bytesFromBase64(object.data) }
                         : undefined,
         };
     },
     toJSON(message) {
         const obj = {};
-        message.body?.$case === 'init' &&
-            (obj.init = message.body?.init
-                ? RpcStreamInit.toJSON(message.body?.init)
-                : undefined);
-        message.body?.$case === 'ack' &&
-            (obj.ack = message.body?.ack
-                ? RpcAck.toJSON(message.body?.ack)
-                : undefined);
-        message.body?.$case === 'data' &&
-            (obj.data =
-                message.body?.data !== undefined
-                    ? base64FromBytes(message.body?.data)
-                    : undefined);
+        message.body?.$case === "init" &&
+            (obj.init = message.body?.init ? RpcStreamInit.toJSON(message.body?.init) : undefined);
+        message.body?.$case === "ack" && (obj.ack = message.body?.ack ? RpcAck.toJSON(message.body?.ack) : undefined);
+        message.body?.$case === "data" &&
+            (obj.data = message.body?.data !== undefined ? base64FromBytes(message.body?.data) : undefined);
         return obj;
     },
     fromPartial(object) {
         const message = createBaseRpcStreamPacket();
-        if (object.body?.$case === 'init' &&
-            object.body?.init !== undefined &&
-            object.body?.init !== null) {
-            message.body = {
-                $case: 'init',
-                init: RpcStreamInit.fromPartial(object.body.init),
-            };
+        if (object.body?.$case === "init" && object.body?.init !== undefined && object.body?.init !== null) {
+            message.body = { $case: "init", init: RpcStreamInit.fromPartial(object.body.init) };
         }
-        if (object.body?.$case === 'ack' &&
-            object.body?.ack !== undefined &&
-            object.body?.ack !== null) {
-            message.body = { $case: 'ack', ack: RpcAck.fromPartial(object.body.ack) };
+        if (object.body?.$case === "ack" && object.body?.ack !== undefined && object.body?.ack !== null) {
+            message.body = { $case: "ack", ack: RpcAck.fromPartial(object.body.ack) };
         }
-        if (object.body?.$case === 'data' &&
-            object.body?.data !== undefined &&
-            object.body?.data !== null) {
-            message.body = { $case: 'data', data: object.body.data };
+        if (object.body?.$case === "data" && object.body?.data !== undefined && object.body?.data !== null) {
+            message.body = { $case: "data", data: object.body.data };
         }
         return message;
     },
 };
 function createBaseRpcStreamInit() {
-    return { componentId: '' };
+    return { componentId: "" };
 }
 export const RpcStreamInit = {
     encode(message, writer = _m0.Writer.create()) {
-        if (message.componentId !== '') {
+        if (message.componentId !== "") {
             writer.uint32(10).string(message.componentId);
         }
         return writer;
@@ -182,9 +159,7 @@ export const RpcStreamInit = {
         }
     },
     fromJSON(object) {
-        return {
-            componentId: isSet(object.componentId) ? String(object.componentId) : '',
-        };
+        return { componentId: isSet(object.componentId) ? String(object.componentId) : "" };
     },
     toJSON(message) {
         const obj = {};
@@ -193,16 +168,16 @@ export const RpcStreamInit = {
     },
     fromPartial(object) {
         const message = createBaseRpcStreamInit();
-        message.componentId = object.componentId ?? '';
+        message.componentId = object.componentId ?? "";
         return message;
     },
 };
 function createBaseRpcAck() {
-    return { error: '' };
+    return { error: "" };
 }
 export const RpcAck = {
     encode(message, writer = _m0.Writer.create()) {
-        if (message.error !== '') {
+        if (message.error !== "") {
             writer.uint32(10).string(message.error);
         }
         return writer;
@@ -253,7 +228,7 @@ export const RpcAck = {
         }
     },
     fromJSON(object) {
-        return { error: isSet(object.error) ? String(object.error) : '' };
+        return { error: isSet(object.error) ? String(object.error) : "" };
     },
     toJSON(message) {
         const obj = {};
@@ -262,28 +237,28 @@ export const RpcAck = {
     },
     fromPartial(object) {
         const message = createBaseRpcAck();
-        message.error = object.error ?? '';
+        message.error = object.error ?? "";
         return message;
     },
 };
 var globalThis = (() => {
-    if (typeof globalThis !== 'undefined') {
+    if (typeof globalThis !== "undefined") {
         return globalThis;
     }
-    if (typeof self !== 'undefined') {
+    if (typeof self !== "undefined") {
         return self;
     }
-    if (typeof window !== 'undefined') {
+    if (typeof window !== "undefined") {
         return window;
     }
-    if (typeof global !== 'undefined') {
+    if (typeof global !== "undefined") {
         return global;
     }
-    throw 'Unable to locate global object';
+    throw "Unable to locate global object";
 })();
 function bytesFromBase64(b64) {
     if (globalThis.Buffer) {
-        return Uint8Array.from(globalThis.Buffer.from(b64, 'base64'));
+        return Uint8Array.from(globalThis.Buffer.from(b64, "base64"));
     }
     else {
         const bin = globalThis.atob(b64);
@@ -296,14 +271,14 @@ function bytesFromBase64(b64) {
 }
 function base64FromBytes(arr) {
     if (globalThis.Buffer) {
-        return globalThis.Buffer.from(arr).toString('base64');
+        return globalThis.Buffer.from(arr).toString("base64");
     }
     else {
         const bin = [];
         arr.forEach((byte) => {
             bin.push(String.fromCharCode(byte));
         });
-        return globalThis.btoa(bin.join(''));
+        return globalThis.btoa(bin.join(""));
     }
 }
 if (_m0.util.Long !== Long) {

package/dist/srpc/rpcproto.pb.d.ts

@@ -1,13 +1,13 @@
-import Long from 'long';
-import _m0 from 'protobufjs/minimal.js';
+import Long from "long";
+import _m0 from "protobufjs/minimal.js";
 export declare const protobufPackage = "srpc";
 /** Packet is a message sent over a srpc packet connection. */
 export interface Packet {
     body?: {
-        $case: 'callStart';
+        $case: "callStart";
         callStart: CallStart;
     } | {
-        $case: 'callData';
+        $case: "callData";
         callData: CallData;
     };
 }
@@ -162,9 +162,9 @@ declare type Builtin = Date | Function | Uint8Array | string | number | boolean
 export declare type DeepPartial<T> = T extends Builtin ? T : T extends Long ? string | number | Long : T extends Array<infer U> ? Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {
     $case: string;
 } ? {
-    [K in keyof Omit<T, '$case'>]?: DeepPartial<T[K]>;
+    [K in keyof Omit<T, "$case">]?: DeepPartial<T[K]>;
 } & {
-    $case: T['$case'];
+    $case: T["$case"];
 } : T extends {} ? {
     [K in keyof T]?: DeepPartial<T[K]>;
 } : Partial<T>;