@trevrpc/trevrpc-js 0.2.3 → 1.1.0

package/examples/greeter/greeter.node.trevrpc.d.ts

@@ -1,53 +0,0 @@
-// Code generated by protoc-gen-trevrpc-js. DO NOT EDIT.
-
-import type {
-  NodeServer,
-  NodeServerCall,
-  StreamingServerResponse,
-  UnaryServerResponse,
-} from "../../src/node-generated.js";
-import type { HelloRequest, HelloReply } from "./greeter.trevrpc.js";
-
-/** Typed Node handlers for the Greeter service. */
-export interface GreeterHandlers {
-  sayHello?(
-    request: HelloRequest,
-    call: NodeServerCall,
-  ):
-    | HelloReply
-    | UnaryServerResponse<HelloReply>
-    | Promise<HelloReply | UnaryServerResponse<HelloReply>>;
-  lotsOfReplies?(
-    request: HelloRequest,
-    call: NodeServerCall,
-  ):
-    | Iterable<HelloReply>
-    | AsyncIterable<HelloReply>
-    | StreamingServerResponse<HelloReply>
-    | Promise<
-        Iterable<HelloReply> | AsyncIterable<HelloReply> | StreamingServerResponse<HelloReply>
-      >;
-  lotsOfGreetings?(
-    requests: AsyncIterable<HelloRequest>,
-    call: NodeServerCall,
-  ):
-    | HelloReply
-    | UnaryServerResponse<HelloReply>
-    | Promise<HelloReply | UnaryServerResponse<HelloReply>>;
-  bidiHello?(
-    requests: AsyncIterable<HelloRequest>,
-    call: NodeServerCall,
-  ):
-    | Iterable<HelloReply>
-    | AsyncIterable<HelloReply>
-    | StreamingServerResponse<HelloReply>
-    | Promise<
-        Iterable<HelloReply> | AsyncIterable<HelloReply> | StreamingServerResponse<HelloReply>
-      >;
-}
-
-/** Registers typed Node handlers for the Greeter service. */
-export declare function registerGreeterServer(
-  server: NodeServer,
-  handlers: GreeterHandlers,
-): NodeServer;

package/examples/greeter/greeter.node.trevrpc.js

@@ -1,9 +0,0 @@
-// Code generated by protoc-gen-trevrpc-js. DO NOT EDIT.
-
-import { registerTypedService } from "../../src/node-generated.js";
-import { GreeterService, root } from "./greeter.trevrpc.js";
-
-/** Registers typed Node handlers for the Greeter service. */
-export function registerGreeterServer(server, handlers) {
-  return registerTypedService(server, root, GreeterService, handlers);
-}

package/examples/greeter/greeter.proto

@@ -1,18 +0,0 @@
-syntax = "proto3";
-
-package example.greeter;
-
-service Greeter {
-  rpc SayHello(HelloRequest) returns (HelloReply);
-  rpc LotsOfReplies(HelloRequest) returns (stream HelloReply);
-  rpc LotsOfGreetings(stream HelloRequest) returns (HelloReply);
-  rpc BidiHello(stream HelloRequest) returns (stream HelloReply);
-}
-
-message HelloRequest {
-  string name = 1;
-}
-
-message HelloReply {
-  string message = 1;
-}

package/examples/greeter/greeter.trevrpc.d.ts

@@ -1,55 +0,0 @@
-// Code generated by protoc-gen-trevrpc-js. DO NOT EDIT.
-
-import type { Long, Root } from "protobufjs";
-
-import type {
-  BidirectionalStreamingCall,
-  CallOptions,
-  ClientStreamingCall,
-  ResponseAsyncIterable,
-  RpcServiceDescriptor,
-  Transport,
-  UnaryResponse,
-} from "../../src/index.js";
-
-export declare const root: Root;
-
-export interface HelloRequest {
-  name?: string;
-}
-
-export interface HelloReply {
-  message?: string;
-}
-
-/** Service descriptor for the Greeter service. */
-export declare const GreeterService: RpcServiceDescriptor;
-
-/** Client for the Greeter service. */
-export declare class GreeterClient {
-  /** Creates a client for the Greeter service. */
-  constructor(transport: Transport, options?: CallOptions);
-
-  /** Calls the SayHello RPC. */
-  sayHello(request: HelloRequest, options?: CallOptions): Promise<HelloReply>;
-  /** Calls the SayHello RPC and returns response metadata. */
-  sayHelloWithResponse(
-    request: HelloRequest,
-    options?: CallOptions,
-  ): Promise<UnaryResponse<HelloReply>>;
-  /** Calls the LotsOfReplies RPC. */
-  lotsOfReplies(
-    request: HelloRequest,
-    options?: CallOptions,
-  ): Promise<ResponseAsyncIterable<HelloReply>>;
-  /** Calls the LotsOfGreetings RPC. */
-  lotsOfGreetings(options?: CallOptions): Promise<ClientStreamingCall<HelloRequest, HelloReply>>;
-  /** Calls the BidiHello RPC. */
-  bidiHello(options?: CallOptions): Promise<BidirectionalStreamingCall<HelloRequest, HelloReply>>;
-}
-
-/** Creates a client for the Greeter service. */
-export declare function createGreeterClient(
-  transport: Transport,
-  options?: CallOptions,
-): GreeterClient;

package/examples/greeter/greeter.trevrpc.js

@@ -1,103 +0,0 @@
-// Code generated by protoc-gen-trevrpc-js. DO NOT EDIT.
-
-import { createRoot, createServiceClient } from "../../src/index.js";
-
-export const root = createRoot({
-  nested: {
-    example: {
-      nested: {
-        greeter: {
-          nested: {
-            HelloRequest: {
-              fields: {
-                name: {
-                  type: "string",
-                  id: 1,
-                },
-              },
-            },
-            HelloReply: {
-              fields: {
-                message: {
-                  type: "string",
-                  id: 1,
-                },
-              },
-            },
-          },
-        },
-      },
-    },
-  },
-});
-
-/** Service descriptor for the Greeter service. */
-export const GreeterService = Object.freeze({
-  name: "Greeter",
-  fullName: "example.greeter.Greeter",
-  exportName: "GreeterService",
-  methods: {
-    sayHello: {
-      name: "SayHello",
-      kind: "unary",
-      inputType: "example.greeter.HelloRequest",
-      outputType: "example.greeter.HelloReply",
-    },
-    lotsOfReplies: {
-      name: "LotsOfReplies",
-      kind: "serverStreaming",
-      inputType: "example.greeter.HelloRequest",
-      outputType: "example.greeter.HelloReply",
-    },
-    lotsOfGreetings: {
-      name: "LotsOfGreetings",
-      kind: "clientStreaming",
-      inputType: "example.greeter.HelloRequest",
-      outputType: "example.greeter.HelloReply",
-    },
-    bidiHello: {
-      name: "BidiHello",
-      kind: "bidirectionalStreaming",
-      inputType: "example.greeter.HelloRequest",
-      outputType: "example.greeter.HelloReply",
-    },
-  },
-});
-
-/** Client for the Greeter service. */
-export class GreeterClient {
-  /** Creates a client for the Greeter service. */
-  constructor(transport, options = {}) {
-    this._client = createServiceClient(transport, GreeterService, root, options);
-  }
-
-  /** Calls the SayHello RPC. */
-  sayHello(request, options = {}) {
-    return this._client.sayHello(request, options);
-  }
-
-  /** Calls the SayHello RPC and returns response metadata. */
-  sayHelloWithResponse(request, options = {}) {
-    return this._client.sayHelloWithResponse(request, options);
-  }
-
-  /** Calls the LotsOfReplies RPC. */
-  lotsOfReplies(request, options = {}) {
-    return this._client.lotsOfReplies(request, options);
-  }
-
-  /** Calls the LotsOfGreetings RPC. */
-  lotsOfGreetings(options = {}) {
-    return this._client.lotsOfGreetings(options);
-  }
-
-  /** Calls the BidiHello RPC. */
-  bidiHello(options = {}) {
-    return this._client.bidiHello(options);
-  }
-}
-
-/** Creates a client for the Greeter service. */
-export function createGreeterClient(transport, options = {}) {
-  return new GreeterClient(transport, options);
-}

package/examples/greeter/index.html

@@ -1,140 +0,0 @@
-<!doctype html>
-<html lang="en">
-  <head>
-    <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1" />
-    <title>TrevRPC JavaScript Greeter Client</title>
-    <style>
-      :root {
-        color-scheme: light dark;
-        font-family:
-          Inter,
-          ui-sans-serif,
-          system-ui,
-          -apple-system,
-          BlinkMacSystemFont,
-          "Segoe UI",
-          sans-serif;
-      }
-
-      body {
-        margin: 0;
-        min-height: 100vh;
-        background:
-          radial-gradient(circle at top left, rgb(80 80 180 / 30%), transparent 35rem), Canvas;
-        color: CanvasText;
-      }
-
-      main {
-        box-sizing: border-box;
-        width: min(54rem, 100%);
-        margin: 0 auto;
-        padding: 3rem 1rem;
-      }
-
-      form,
-      pre {
-        border: 1px solid color-mix(in srgb, CanvasText 18%, transparent);
-        border-radius: 1rem;
-        background: color-mix(in srgb, Canvas 92%, CanvasText 8%);
-        box-shadow: 0 1rem 3rem rgb(0 0 0 / 12%);
-      }
-
-      form {
-        display: grid;
-        gap: 1rem;
-        padding: 1rem;
-      }
-
-      label {
-        display: grid;
-        gap: 0.35rem;
-        font-weight: 700;
-      }
-
-      input,
-      button {
-        border: 1px solid color-mix(in srgb, CanvasText 22%, transparent);
-        border-radius: 0.7rem;
-        font: inherit;
-        padding: 0.75rem;
-      }
-
-      button {
-        cursor: pointer;
-        font-weight: 800;
-      }
-
-      .actions {
-        display: flex;
-        flex-wrap: wrap;
-        gap: 0.75rem;
-      }
-
-      #submit {
-        background: #5b5bd6;
-        color: white;
-      }
-
-      small {
-        opacity: 0.75;
-      }
-
-      pre {
-        min-height: 14rem;
-        overflow: auto;
-        padding: 1rem;
-        white-space: pre-wrap;
-      }
-    </style>
-    <script type="importmap">
-      {
-        "imports": {
-          "protobufjs": "./vendor/protobufjs.js"
-        }
-      }
-    </script>
-  </head>
-  <body>
-    <main>
-      <h1>TrevRPC JavaScript Greeter Client</h1>
-      <p>
-        Connect this page to a WebTransport-enabled TrevRPC Go or Rust greeter server and run all
-        four RPC shapes from the browser.
-      </p>
-
-      <form id="client-form">
-        <label>
-          WebTransport URL
-          <input name="url" required value="https://127.0.0.1:50051/trevrpc" />
-        </label>
-        <div class="actions">
-          <button type="button" data-url="https://127.0.0.1:50051/trevrpc">Go default URL</button>
-          <button type="button" data-url="https://127.0.0.1:5000/trevrpc">Rust default URL</button>
-        </div>
-        <label>
-          Name
-          <input name="name" value="TrevRPC" />
-        </label>
-        <label>
-          Bearer token
-          <input name="token" value="trevrpc-example-token" />
-        </label>
-        <label>
-          Server certificate SHA-256 hash
-          <input name="certificate-hash" placeholder="optional hex or base64 hash" />
-          <small>
-            The local static server loads this from
-            <code>~/.config/trevrpc/trevrpc-example-cert.pem</code> when available. Leave empty when
-            the browser already trusts the server certificate.
-          </small>
-        </label>
-        <button id="submit" type="submit">Run RPCs</button>
-      </form>
-
-      <h2>Output</h2>
-      <pre id="output" aria-live="polite"></pre>
-    </main>
-    <script type="module" src="./client.js"></script>
-  </body>
-</html>

package/examples/greeter/static-server.js

@@ -1,168 +0,0 @@
-import { createHash } from "node:crypto";
-import { createReadStream } from "node:fs";
-import { readFile, stat } from "node:fs/promises";
-import { createServer } from "node:http";
-import { homedir } from "node:os";
-import { extname, join, normalize, resolve, sep } from "node:path";
-import { fileURLToPath } from "node:url";
-
-const root = resolve(fileURLToPath(new URL("../..", import.meta.url)));
-const port = Number.parseInt(process.env.PORT ?? "8080", 10);
-const authToken = "trevrpc-example-token";
-const protobufBundlePath = fileURLToPath(import.meta.resolve("protobufjs/dist/protobuf.min.js"));
-
-const contentTypes = new Map([
-  [".html", "text/html; charset=utf-8"],
-  [".js", "text/javascript; charset=utf-8"],
-  [".json", "application/json; charset=utf-8"],
-  [".md", "text/markdown; charset=utf-8"],
-  [".proto", "text/plain; charset=utf-8"],
-]);
-
-const server = createServer(async (request, response) => {
-  try {
-    const path = requestPath(request.url ?? "/");
-
-    if (path === "/favicon.ico") {
-      response.writeHead(204);
-      response.end();
-      return;
-    }
-
-    if (path === "/examples/greeter/certificate-hash.json") {
-      await writeCertificateHash(response);
-      return;
-    }
-
-    if (path === "/examples/greeter/vendor/protobufjs.js") {
-      writeProtobufModule(response);
-      return;
-    }
-
-    if (path === "/examples/greeter/vendor/protobuf.min.js") {
-      await writeProtobufBundle(response);
-      return;
-    }
-
-    const file = path.endsWith("/") ? join(path, "index.html") : path;
-    await writeStaticFile(response, safePath(file));
-  } catch (error) {
-    if (error?.code === "ENOENT") {
-      notFound(response);
-      return;
-    }
-
-    response.writeHead(500, { "content-type": "text/plain; charset=utf-8" });
-    response.end(error?.message ?? String(error));
-  }
-});
-
-server.listen(port, "127.0.0.1", () => {
-  console.log(`serving trevrpc-js from http://127.0.0.1:${port}/examples/greeter/`);
-});
-
-function requestPath(url) {
-  return decodeURIComponent(new URL(url, "http://127.0.0.1").pathname);
-}
-
-async function writeStaticFile(response, absolute) {
-  const info = await stat(absolute);
-
-  if (!info.isFile()) {
-    notFound(response);
-    return;
-  }
-
-  response.writeHead(200, {
-    "content-type": contentTypes.get(extname(absolute)) ?? "application/octet-stream",
-  });
-  createReadStream(absolute).pipe(response);
-}
-
-function safePath(path) {
-  const absolute = normalize(join(root, path));
-  if (absolute !== root && !absolute.startsWith(`${root}${sep}`)) {
-    throw new Error("path escapes example root");
-  }
-
-  return absolute;
-}
-
-async function writeCertificateHash(response) {
-  const path = certificatePath();
-
-  try {
-    const certificate = await readFile(path);
-    const der = certificateDer(certificate);
-    const hash = createHash("sha256").update(der).digest();
-
-    response.writeHead(200, { "content-type": "application/json; charset=utf-8" });
-    response.end(
-      JSON.stringify({
-        exists: true,
-        path,
-        bearerToken: authToken,
-        sha256Base64: hash.toString("base64"),
-        sha256Hex: hash.toString("hex"),
-      }),
-    );
-  } catch (error) {
-    response.writeHead(200, { "content-type": "application/json; charset=utf-8" });
-    response.end(
-      JSON.stringify({
-        exists: false,
-        path,
-        bearerToken: authToken,
-        error: error?.message ?? String(error),
-      }),
-    );
-  }
-}
-
-function writeProtobufModule(response) {
-  response.writeHead(200, { "content-type": "text/javascript; charset=utf-8" });
-  response.end(`await new Promise((resolve, reject) => {
-  if (globalThis.protobuf != null) {
-    resolve();
-    return;
-  }
-
-  const script = document.createElement("script");
-  script.src = new URL("./protobuf.min.js", import.meta.url).href;
-  script.onload = resolve;
-  script.onerror = () => reject(new Error("failed to load protobuf.js browser bundle"));
-  document.head.append(script);
-});
-
-export default globalThis.protobuf;
-export const protobuf = globalThis.protobuf;
-`);
-}
-
-async function writeProtobufBundle(response) {
-  await writeStaticFile(response, protobufBundlePath);
-}
-
-function certificatePath() {
-  return (
-    process.env.TREVRPC_EXAMPLE_CERT ??
-    join(homedir(), ".config", "trevrpc", "trevrpc-example-cert.pem")
-  );
-}
-
-function certificateDer(certificate) {
-  const text = certificate.toString("utf8");
-  const match = /-----BEGIN CERTIFICATE-----([A-Za-z0-9+/=\s]+)-----END CERTIFICATE-----/.exec(
-    text,
-  );
-  if (match == null) {
-    return certificate;
-  }
-
-  return Buffer.from(match[1].replace(/\s/g, ""), "base64");
-}
-
-function notFound(response) {
-  response.writeHead(404, { "content-type": "text/plain; charset=utf-8" });
-  response.end("not found");
-}

package/src/advanced.d.ts

@@ -1,29 +0,0 @@
-import type {
-  ResolvedCallOptions,
-  RpcRequestMessage,
-  RpcResponseMessage,
-  RpcStreamFrameMessage,
-  Transport,
-  WebTransportBidirectionalStreamLike,
-  WebTransportCloseInfoLike,
-  WebTransportOptions,
-  WebTransportSessionLike,
-} from "./index.js";
-
-/** Raw single-session TrevRPC transport for browser WebTransport. */
-export class RawWebTransport implements Transport {
-  session: WebTransportSessionLike;
-  maxFrameSize: number;
-
-  constructor(session: WebTransportSessionLike, options?: WebTransportOptions);
-  static connect(url: string | URL, options?: WebTransportOptions): Promise<RawWebTransport>;
-  ready(): Promise<void>;
-  close(closeInfo?: WebTransportCloseInfoLike): void;
-  call(request: RpcRequestMessage, options?: ResolvedCallOptions): Promise<RpcResponseMessage>;
-  streamingCall(
-    request: RpcRequestMessage,
-    requestBody: AsyncIterable<Uint8Array>,
-    options?: ResolvedCallOptions,
-  ): Promise<AsyncIterableIterator<RpcStreamFrameMessage>>;
-  openBidirectionalStream(): Promise<WebTransportBidirectionalStreamLike>;
-}

package/src/advanced.js

@@ -1 +0,0 @@
-export { RawWebTransport } from "./webtransport.js";

package/src/browser-channel.js

@@ -1,49 +0,0 @@
-import { ChannelStateMachine, stripChannelOptions, waitForInitialReady } from "./channel.js";
-import { unavailable } from "./status.js";
-import {
-  RawWebTransport,
-  createWebTransportSession,
-  waitForWebTransportReady,
-} from "./webtransport.js";
-
-/** Browser channel with background session reconnection. */
-export class Channel extends ChannelStateMachine {
-  constructor(url, options = {}) {
-    const retainedUrl = url instanceof URL ? url.href : url;
-    const retainedOptions = Object.freeze({ ...options });
-    const transportOptions = stripChannelOptions(retainedOptions);
-    super(
-      (signal) => connectWebTransport(retainedUrl, transportOptions, signal),
-      retainedOptions,
-      (transport) => transport.session.closed,
-    );
-    this.url = retainedUrl;
-    this.options = retainedOptions;
-  }
-
-  /** Creates a channel and waits for its first ready generation. */
-  static async connect(url, options = {}) {
-    const channel = new Channel(url, options);
-    await waitForInitialReady(channel, options);
-    return channel;
-  }
-}
-
-async function connectWebTransport(url, options, signal) {
-  const session = createWebTransportSession(url, options);
-  const onAbort = () => session.close?.();
-  signal.addEventListener("abort", onAbort, { once: true });
-
-  try {
-    await waitForWebTransportReady(session);
-    if (signal.aborted) {
-      throw unavailable("channel is closed");
-    }
-    return new RawWebTransport(session, options);
-  } catch (error) {
-    session.close?.();
-    throw error;
-  } finally {
-    signal.removeEventListener("abort", onAbort);
-  }
-}

package/src/connect.js

@@ -1,6 +0,0 @@
-import { Channel } from "./browser-channel.js";
-
-/** Opens a TrevRPC client for the current JavaScript runtime. */
-export async function connect(url, options = {}) {
-  return await Channel.connect(url, options);
-}

package/src/connect.node.js

@@ -1,6 +0,0 @@
-import { Channel } from "./node.js";
-
-/** Opens a TrevRPC client backed by the native Node runtime. */
-export async function connect(urlOrOptions, options = {}) {
-  return await Channel.connect(urlOrOptions, options);
-}

package/src/index.node.d.ts

@@ -1,10 +0,0 @@
-export * from "./index.js";
-export { Channel } from "./node.js";
-
-import type { Channel, NodeChannelOptions, NodeChannelTarget } from "./node.js";
-
-/** Opens a native Node channel and waits for its first ready generation. */
-export function connect(
-  target: string | URL | NodeChannelTarget,
-  options?: NodeChannelOptions,
-): Promise<Channel>;

package/src/index.node.js

@@ -1,3 +0,0 @@
-export * from "./runtime.js";
-export { connect } from "./connect.node.js";
-export { Channel } from "./node.js";