@pyrpc/client 0.1.0-alpha.1

package/README.md

@@ -0,0 +1,39 @@
+# @pyrpc/client
+
+The universal TypeScript client for pyRPC.
+
+## Installation
+
+```bash
+npm install @pyrpc/client
+# or
+pnpm add @pyrpc/client
+# or
+yarn add @pyrpc/client
+```
+
+## Usage
+
+```typescript
+import { createClient } from '@pyrpc/client';
+import type { AppRouter } from './server-types'; // Generated by pyrpc-codegen
+
+const client = createClient<AppRouter>({
+  baseUrl: 'http://localhost:8000',
+});
+
+// Call remote procedures as local methods
+const user = await client.get_user({ id: 1 });
+console.log(user.name);
+```
+
+### Dynamic Headers (Auth)
+
+```typescript
+const client = createClient({
+  baseUrl: 'http://localhost:8000',
+  headers: () => ({
+    Authorization: `Bearer ${localStorage.getItem('token')}`,
+  }),
+});
+```

package/dist/index.d.mts

@@ -0,0 +1,51 @@
+interface RpcRequest {
+    id: string;
+    method: string;
+    params: any[] | Record<string, any>;
+}
+interface RpcResponse<T = any> {
+    id: string;
+    result: T | null;
+    error: {
+        code: number;
+        message: string;
+        data?: any;
+    } | null;
+}
+interface ClientOptions {
+    /**
+     * The base URL of the pyRPC server.
+     * If omitted in a browser environment, it defaults to the current origin + '/rpc'.
+     */
+    baseUrl?: string;
+    /**
+     * Optional custom headers to send with each request.
+     */
+    headers?: HeadersInit | (() => HeadersInit | Promise<HeadersInit>);
+}
+
+declare class PyRPCClient {
+    private baseUrl;
+    private options;
+    constructor(options?: ClientOptions);
+    /**
+     * Internal method to perform the fetch request.
+     */
+    private request;
+    /**
+     * Creates a proxy that allows calling remote procedures as if they were local methods.
+     */
+    get rpc(): any;
+}
+/**
+ * Modern factory API for pyRPC.
+ */
+declare function createClient<TTypes = any>(options?: ClientOptions): PyRPCClient & TTypes;
+
+declare class PyRPCError extends Error {
+    readonly code: number;
+    readonly data?: any;
+    constructor(code: number, message: string, data?: any);
+}
+
+export { type ClientOptions, PyRPCClient, PyRPCError, type RpcRequest, type RpcResponse, createClient };

package/dist/index.d.ts

@@ -0,0 +1,51 @@
+interface RpcRequest {
+    id: string;
+    method: string;
+    params: any[] | Record<string, any>;
+}
+interface RpcResponse<T = any> {
+    id: string;
+    result: T | null;
+    error: {
+        code: number;
+        message: string;
+        data?: any;
+    } | null;
+}
+interface ClientOptions {
+    /**
+     * The base URL of the pyRPC server.
+     * If omitted in a browser environment, it defaults to the current origin + '/rpc'.
+     */
+    baseUrl?: string;
+    /**
+     * Optional custom headers to send with each request.
+     */
+    headers?: HeadersInit | (() => HeadersInit | Promise<HeadersInit>);
+}
+
+declare class PyRPCClient {
+    private baseUrl;
+    private options;
+    constructor(options?: ClientOptions);
+    /**
+     * Internal method to perform the fetch request.
+     */
+    private request;
+    /**
+     * Creates a proxy that allows calling remote procedures as if they were local methods.
+     */
+    get rpc(): any;
+}
+/**
+ * Modern factory API for pyRPC.
+ */
+declare function createClient<TTypes = any>(options?: ClientOptions): PyRPCClient & TTypes;
+
+declare class PyRPCError extends Error {
+    readonly code: number;
+    readonly data?: any;
+    constructor(code: number, message: string, data?: any);
+}
+
+export { type ClientOptions, PyRPCClient, PyRPCError, type RpcRequest, type RpcResponse, createClient };

package/dist/index.js

@@ -0,0 +1,127 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  PyRPCClient: () => PyRPCClient,
+  PyRPCError: () => PyRPCError,
+  createClient: () => createClient
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/error.ts
+var PyRPCError = class _PyRPCError extends Error {
+  code;
+  data;
+  constructor(code, message, data) {
+    super(message);
+    this.name = "PyRPCError";
+    this.code = code;
+    this.data = data;
+    Object.setPrototypeOf(this, _PyRPCError.prototype);
+  }
+};
+
+// src/client.ts
+var NO_BASE_URL_ERROR = `
+No baseUrl detected.
+
+pyRPC could not automatically determine your server location.
+
+If your frontend and backend are deployed separately, provide:
+
+createClient({
+  baseUrl: "https://api.example.com"
+})
+`;
+var PyRPCClient = class {
+  baseUrl;
+  options;
+  constructor(options = {}) {
+    let baseUrl = options.baseUrl;
+    if (!baseUrl) {
+      if (typeof window !== "undefined" && window.location) {
+        baseUrl = window.location.origin;
+      } else {
+        throw new Error(NO_BASE_URL_ERROR);
+      }
+    }
+    this.baseUrl = baseUrl.replace(/\/$/, "");
+    this.options = options;
+  }
+  /**
+   * Internal method to perform the fetch request.
+   */
+  async request(method, params) {
+    const id = Math.random().toString(36).substring(7);
+    const body = { id, method, params };
+    const baseHeaders = {
+      "Content-Type": "application/json"
+    };
+    let userHeaders = {};
+    if (this.options.headers) {
+      userHeaders = typeof this.options.headers === "function" ? await this.options.headers() : this.options.headers;
+    }
+    const headers = { ...baseHeaders, ...Object.fromEntries(new Headers(userHeaders).entries()) };
+    const response = await fetch(`${this.baseUrl}/rpc`, {
+      method: "POST",
+      headers,
+      body: JSON.stringify(body)
+    });
+    if (!response.ok) {
+      throw new Error(`HTTP error! status: ${response.status}`);
+    }
+    const data = await response.json();
+    if (data.error) {
+      throw new PyRPCError(data.error.code, data.error.message, data.error.data);
+    }
+    return data.result;
+  }
+  /**
+   * Creates a proxy that allows calling remote procedures as if they were local methods.
+   */
+  get rpc() {
+    return new Proxy({}, {
+      get: (_, method) => {
+        return (...args) => {
+          const params = args.length === 1 && typeof args[0] === "object" && !Array.isArray(args[0]) ? args[0] : args;
+          return this.request(method, params);
+        };
+      }
+    });
+  }
+};
+function createClient(options = {}) {
+  const client = new PyRPCClient(options);
+  return new Proxy(client, {
+    get(target, prop, receiver) {
+      if (prop in target) {
+        return Reflect.get(target, prop, receiver);
+      }
+      return target.rpc[prop];
+    }
+  });
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  PyRPCClient,
+  PyRPCError,
+  createClient
+});

package/dist/index.mjs

@@ -0,0 +1,98 @@
+// src/error.ts
+var PyRPCError = class _PyRPCError extends Error {
+  code;
+  data;
+  constructor(code, message, data) {
+    super(message);
+    this.name = "PyRPCError";
+    this.code = code;
+    this.data = data;
+    Object.setPrototypeOf(this, _PyRPCError.prototype);
+  }
+};
+
+// src/client.ts
+var NO_BASE_URL_ERROR = `
+No baseUrl detected.
+
+pyRPC could not automatically determine your server location.
+
+If your frontend and backend are deployed separately, provide:
+
+createClient({
+  baseUrl: "https://api.example.com"
+})
+`;
+var PyRPCClient = class {
+  baseUrl;
+  options;
+  constructor(options = {}) {
+    let baseUrl = options.baseUrl;
+    if (!baseUrl) {
+      if (typeof window !== "undefined" && window.location) {
+        baseUrl = window.location.origin;
+      } else {
+        throw new Error(NO_BASE_URL_ERROR);
+      }
+    }
+    this.baseUrl = baseUrl.replace(/\/$/, "");
+    this.options = options;
+  }
+  /**
+   * Internal method to perform the fetch request.
+   */
+  async request(method, params) {
+    const id = Math.random().toString(36).substring(7);
+    const body = { id, method, params };
+    const baseHeaders = {
+      "Content-Type": "application/json"
+    };
+    let userHeaders = {};
+    if (this.options.headers) {
+      userHeaders = typeof this.options.headers === "function" ? await this.options.headers() : this.options.headers;
+    }
+    const headers = { ...baseHeaders, ...Object.fromEntries(new Headers(userHeaders).entries()) };
+    const response = await fetch(`${this.baseUrl}/rpc`, {
+      method: "POST",
+      headers,
+      body: JSON.stringify(body)
+    });
+    if (!response.ok) {
+      throw new Error(`HTTP error! status: ${response.status}`);
+    }
+    const data = await response.json();
+    if (data.error) {
+      throw new PyRPCError(data.error.code, data.error.message, data.error.data);
+    }
+    return data.result;
+  }
+  /**
+   * Creates a proxy that allows calling remote procedures as if they were local methods.
+   */
+  get rpc() {
+    return new Proxy({}, {
+      get: (_, method) => {
+        return (...args) => {
+          const params = args.length === 1 && typeof args[0] === "object" && !Array.isArray(args[0]) ? args[0] : args;
+          return this.request(method, params);
+        };
+      }
+    });
+  }
+};
+function createClient(options = {}) {
+  const client = new PyRPCClient(options);
+  return new Proxy(client, {
+    get(target, prop, receiver) {
+      if (prop in target) {
+        return Reflect.get(target, prop, receiver);
+      }
+      return target.rpc[prop];
+    }
+  });
+}
+export {
+  PyRPCClient,
+  PyRPCError,
+  createClient
+};

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@pyrpc/client",
+  "version": "0.1.0-alpha.1",
+  "description": "Universal TypeScript client for pyRPC",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "dev": "tsup src/index.ts --format cjs,esm --watch --dts",
+    "lint": "eslint src/**/*.ts",
+    "test": "vitest run"
+  },
+  "keywords": [
+    "rpc",
+    "pyrpc",
+    "typescript",
+    "client",
+    "api"
+  ],
+  "author": "",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/node": "^20.19.39",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3",
+    "vitest": "^3.0.0"
+  }
+}