@trevrpc/trevrpc-js 0.2.2 → 1.0.0

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";

package/src/native-loader.js

@@ -1,118 +0,0 @@
-import { existsSync } from "node:fs";
-import { createRequire } from "node:module";
-import { dirname, join } from "node:path";
-import process from "node:process";
-import { fileURLToPath } from "node:url";
-
-const require = createRequire(import.meta.url);
-const packageRoot = join(dirname(fileURLToPath(import.meta.url)), "..");
-const packageVersion = (() => {
-  try {
-    return require(join(packageRoot, "package.json")).version ?? "unknown";
-  } catch {
-    return "unknown";
-  }
-})();
-const SupportedOptionalTarget = "linux/x64/glibc";
-const LinuxX64GnuPackage = "@trevrpc/trevrpc-js-native-linux-x64-gnu";
-
-/** Loads the target-specific native addon without building during installation. */
-export function loadNativeAddon({ loadOptionalPackage = true, loadBundledAddon = true } = {}) {
-  const target = nativeTarget();
-  const packageName = nativePackageName(target);
-  let packageError;
-  let packageState = "unsupported";
-
-  if (loadOptionalPackage && packageName != null) {
-    try {
-      return require(packageName);
-    } catch (error) {
-      packageError = error;
-      packageState = isMissingPackage(error, packageName) ? "missing" : "failed to load";
-    }
-  }
-
-  const bundled = loadBundledAddon ? bundledNativePath() : null;
-  let bundledError;
-  if (bundled != null) {
-    try {
-      return require(bundled);
-    } catch (error) {
-      bundledError = error;
-    }
-  }
-
-  const fallback = developmentFallbackPath();
-  let fallbackError;
-  if (fallback != null) {
-    try {
-      return require(fallback);
-    } catch (error) {
-      fallbackError = error;
-    }
-  }
-
-  const detected = targetName(target);
-  const expected = packageName ?? "no optional package (unsupported target)";
-  const bundledState =
-    bundled == null ? "no Nix-bundled addon was present" : "the Nix-bundled addon failed to load";
-  const fallbackState =
-    fallback == null
-      ? "no source-checkout fallback was present"
-      : fallbackError == null
-        ? "the source-checkout fallback was unavailable"
-        : "the source-checkout fallback failed to load";
-  throw new Error(
-    `TrevRPC native addon is unavailable for detected target ${detected}. ` +
-      `Supported optional-package targets: ${SupportedOptionalTarget}. Expected optional package: ${expected}@${packageVersion}; ` +
-      `package state: ${packageState}; ${bundledState}; ${fallbackState}. ` +
-      "Install the matching optional package or build build/native/trevrpc_native.node explicitly in a source checkout; npm installation never starts a source build.",
-    { cause: fallbackError ?? bundledError ?? packageError },
-  );
-}
-
-/** Returns the normalized native npm target. */
-export function nativeTarget() {
-  return Object.freeze({
-    platform: process.platform,
-    arch: process.arch,
-    libc: process.platform === "linux" ? linuxLibc() : undefined,
-  });
-}
-
-function nativePackageName(target) {
-  if (target.platform === "linux" && target.arch === "x64" && target.libc === "glibc") {
-    return LinuxX64GnuPackage;
-  }
-  return null;
-}
-
-function bundledNativePath() {
-  const path = join(packageRoot, "native", "trevrpc_native.node");
-  return existsSync(path) ? path : null;
-}
-
-function developmentFallbackPath() {
-  if (!existsSync(join(packageRoot, "native", "CMakeLists.txt"))) {
-    return null;
-  }
-  const path = join(packageRoot, "build", "native", "trevrpc_native.node");
-  return existsSync(path) ? path : null;
-}
-
-function targetName(target) {
-  return `${target.platform}/${target.arch}${target.libc == null ? "" : `/${target.libc}`}`;
-}
-
-function linuxLibc() {
-  const report = process.report?.getReport?.();
-  return report?.header?.glibcVersionRuntime == null ? "musl" : "glibc";
-}
-
-function isMissingPackage(error, packageName) {
-  return (
-    error?.code === "MODULE_NOT_FOUND" &&
-    typeof error.message === "string" &&
-    error.message.includes(packageName)
-  );
-}

package/src/node-advanced.d.ts

@@ -1,27 +0,0 @@
-import type { RpcResponseMessage, RpcStreamFrameMessage, Transport } from "./index.js";
-import type { NodeChannelTarget, NodeConnectOptions } from "./node.js";
-
-export interface RawNodeCloseInfo {
-  nativeCode: number;
-}
-
-/** Raw single-connection Node transport backed by trevrpc-c and MsQuic. */
-export class RawNodeTransport implements Transport {
-  maxFrameSize?: number;
-  readonly closed: Promise<RawNodeCloseInfo>;
-
-  static connect(
-    target: string | URL | NodeChannelTarget,
-    options?: NodeConnectOptions,
-  ): Promise<RawNodeTransport>;
-  call(
-    request: Parameters<Transport["call"]>[0],
-    options?: Parameters<Transport["call"]>[1],
-  ): Promise<RpcResponseMessage>;
-  streamingCall(
-    request: Parameters<Transport["streamingCall"]>[0],
-    requestBody: AsyncIterable<Uint8Array>,
-    options?: Parameters<Transport["streamingCall"]>[2],
-  ): Promise<AsyncIterableIterator<RpcStreamFrameMessage>>;
-  close(): void;
-}

package/src/node-advanced.js

@@ -1 +0,0 @@
-export { RawNodeTransport } from "./node.js";

package/src/node-generated.d.ts

@@ -1,24 +0,0 @@
-import type { Root, Type } from "protobufjs";
-
-import type { RpcMethodKind, RpcServiceDescriptor } from "./index.js";
-import type { NodeServer, NodeServerCall } from "./node.js";
-
-export type { StreamingServerResponse, UnaryServerResponse } from "./index.js";
-export type { NodeServer, NodeServerCall } from "./node.js";
-
-/** Registers typed generated handlers on a Node server. */
-export function registerTypedService(
-  server: NodeServer,
-  root: Root,
-  service: RpcServiceDescriptor,
-  handlers: Record<string, unknown>,
-): NodeServer;
-
-/** Dispatches one typed generated Node handler. */
-export function dispatchTypedNodeHandler(
-  call: NodeServerCall,
-  handler: (...args: unknown[]) => unknown,
-  kind: RpcMethodKind,
-  requestType: Type,
-  responseType: Type,
-): Promise<void>;