typeferry 0.6.0

package/dist/utils/presentation.js

@@ -0,0 +1,25 @@
+import { v4 } from '@lukeed/uuid';
+import { EJSON } from '../ejson/index.js';
+export var PayloadType;
+(function (PayloadType) {
+    PayloadType["METHOD"] = "method";
+    PayloadType["RESULT"] = "result";
+    PayloadType["EVENT"] = "event";
+    PayloadType["ERROR"] = "error";
+    PayloadType["AUTH_RESULT"] = "auth:result";
+})(PayloadType || (PayloadType = {}));
+export var Presentation;
+(function (Presentation) {
+    Presentation.uuid = v4;
+    function decode(payload) {
+        return EJSON.parse(typeof payload === 'string'
+            ? payload
+            : payload.data);
+    }
+    Presentation.decode = decode;
+    function encode(payload) {
+        return EJSON.stringify(payload);
+    }
+    Presentation.encode = encode;
+})(Presentation || (Presentation = {}));
+//# sourceMappingURL=presentation.js.map

package/dist/utils/presentation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"presentation.js","sourceRoot":"","sources":["../../src/utils/presentation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,cAAc,CAAA;AAEjC,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAA;AAEhC,MAAM,CAAN,IAAY,WAMX;AAND,WAAY,WAAW;IACrB,gCAAiB,CAAA;IACjB,gCAAiB,CAAA;IACjB,8BAAe,CAAA;IACf,8BAAe,CAAA;IACf,0CAA2B,CAAA;AAC7B,CAAC,EANW,WAAW,KAAX,WAAW,QAMtB;AAED,MAAM,KAAW,YAAY,CAmB5B;AAnBD,WAAiB,YAAY;IACd,iBAAI,GAAG,EAAE,CAAA;IAOtB,SAAgB,MAAM,CAAc,OAAkC;QACpE,OAAO,KAAK,CAAC,KAAK,CAChB,OAAO,OAAO,KAAK,QAAQ;YACzB,CAAC,CAAC,OAAO;YACT,CAAC,CAAE,OAA4B,CAAC,IAAI,CACvC,CAAA;IACH,CAAC;IANe,mBAAM,SAMrB,CAAA;IAED,SAAgB,MAAM,CAAc,OAAU;QAC5C,OAAO,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;IACjC,CAAC;IAFe,mBAAM,SAErB,CAAA;AACH,CAAC,EAnBgB,YAAY,KAAZ,YAAY,QAmB5B"}

package/dist/utils/promise.d.ts

@@ -0,0 +1,6 @@
+export declare function getPromise(): {
+    promise: Promise<unknown>;
+    resolve: any;
+};
+export declare function sleep(ms: number): Promise<unknown>;
+export declare function randomSleep(min?: number, max?: number): Promise<unknown>;

package/dist/utils/promise.js

@@ -0,0 +1,17 @@
+export function getPromise() {
+    let resolve = null;
+    const promise = new Promise(r => {
+        resolve = r;
+    });
+    return {
+        promise,
+        resolve,
+    };
+}
+export function sleep(ms) {
+    return new Promise(resolve => setTimeout(resolve, ms));
+}
+export async function randomSleep(min = 50, max = 200) {
+    return sleep(Math.floor(Math.random() * (max - min) + min));
+}
+//# sourceMappingURL=promise.js.map

package/dist/utils/promise.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"promise.js","sourceRoot":"","sources":["../../src/utils/promise.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,UAAU;IACxB,IAAI,OAAO,GAAG,IAAI,CAAA;IAElB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE;QAC9B,OAAO,GAAG,CAAC,CAAA;IACb,CAAC,CAAC,CAAA;IAEF,OAAO;QACL,OAAO;QACP,OAAO;KACR,CAAA;AACH,CAAC;AAED,MAAM,UAAU,KAAK,CAAC,EAAU;IAC9B,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAA;AACxD,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,GAAG,GAAG,EAAE,EAAE,GAAG,GAAG,GAAG;IACnD,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,CAAA;AAC7D,CAAC"}

package/dist/utils/protocol.d.ts

@@ -0,0 +1,110 @@
+/**
+ * Wire protocol for TypeFerry WebSocket communication.
+ *
+ * Replaces Socket.IO's multi-event system with a single JSON envelope per
+ * WebSocket frame. Every message is EJSON-encoded text (preserving existing
+ * Date/Binary/ObjectId round-tripping via Presentation.encode/decode).
+ *
+ * The `t` field is the discriminator that determines message shape.
+ */
+/** Discriminator for all WebSocket frame types. */
+export declare enum MessageType {
+    /** Client → Server: RPC call expecting a response */
+    RPC = "rpc",
+    /** Client → Server: fire-and-forget RPC (no response) */
+    RPC_VOID = "rpc:void",
+    /** Server → Client: RPC response correlated by `id` */
+    RPC_RESPONSE = "rpc:res",
+    /** Server → Client: push event from a subscription */
+    EVENT = "event",
+    /** Server → Client: authentication result after connection */
+    AUTH = "auth",
+    /** Bidirectional: keep-alive ping (server-initiated) */
+    PING = "ping",
+    /** Bidirectional: keep-alive pong (client response) */
+    PONG = "pong"
+}
+/** RPC call that expects a correlated response. */
+export interface RpcMessage {
+    readonly t: MessageType.RPC;
+    /** UUID for request/response correlation */
+    readonly id: string;
+    readonly method: string;
+    readonly params?: unknown;
+}
+/** Fire-and-forget RPC call (no response expected). */
+export interface RpcVoidMessage {
+    readonly t: MessageType.RPC_VOID;
+    readonly method: string;
+    readonly params?: unknown;
+}
+/** Client ping response. */
+export interface PongMessage {
+    readonly t: MessageType.PONG;
+}
+/** Union of all client-to-server message types. */
+export type ClientMessage = RpcMessage | RpcVoidMessage | PongMessage;
+/** Successful RPC response. */
+export interface RpcResponseSuccess {
+    readonly t: MessageType.RPC_RESPONSE;
+    readonly id: string;
+    readonly result: unknown;
+}
+/** Failed RPC response. */
+export interface RpcResponseError {
+    readonly t: MessageType.RPC_RESPONSE;
+    readonly id: string;
+    readonly error: string;
+    readonly errors?: unknown;
+}
+/** Union of RPC response shapes. */
+export type RpcResponseMessage = RpcResponseSuccess | RpcResponseError;
+/** Push event from a subscription channel. */
+export interface EventMessage {
+    readonly t: MessageType.EVENT;
+    readonly uuid: string;
+    readonly event: string;
+    readonly channel?: string;
+    readonly params?: unknown;
+}
+/** Authentication result sent after WebSocket connection. */
+export interface AuthMessage {
+    readonly t: MessageType.AUTH;
+    readonly authenticated: boolean;
+}
+/** Server-initiated keep-alive ping. */
+export interface PingMessage {
+    readonly t: MessageType.PING;
+}
+/** Union of all server-to-client message types. */
+export type ServerMessage = RpcResponseMessage | EventMessage | AuthMessage | PingMessage;
+/** Any message that can travel over the wire. */
+export type WireMessage = ClientMessage | ServerMessage;
+/** Narrows a parsed envelope to an RPC call. */
+export declare function isRpcMessage(msg: {
+    t: string;
+}): msg is RpcMessage;
+/** Narrows a parsed envelope to a void RPC call. */
+export declare function isRpcVoidMessage(msg: {
+    t: string;
+}): msg is RpcVoidMessage;
+/** Narrows a parsed envelope to an RPC response. */
+export declare function isRpcResponse(msg: {
+    t: string;
+}): msg is RpcResponseMessage;
+/** Narrows a parsed envelope to a push event. */
+export declare function isEventMessage(msg: {
+    t: string;
+}): msg is EventMessage;
+/** Narrows a parsed envelope to an auth result. */
+export declare function isAuthMessage(msg: {
+    t: string;
+}): msg is AuthMessage;
+/** Narrows a parsed envelope to a ping. */
+export declare function isPingMessage(msg: {
+    t: string;
+}): msg is PingMessage;
+/** Narrows a parsed envelope to a pong. */
+export declare function isPongMessage(msg: {
+    t: string;
+}): msg is PongMessage;

package/dist/utils/protocol.js

@@ -0,0 +1,59 @@
+/**
+ * Wire protocol for TypeFerry WebSocket communication.
+ *
+ * Replaces Socket.IO's multi-event system with a single JSON envelope per
+ * WebSocket frame. Every message is EJSON-encoded text (preserving existing
+ * Date/Binary/ObjectId round-tripping via Presentation.encode/decode).
+ *
+ * The `t` field is the discriminator that determines message shape.
+ */
+/** Discriminator for all WebSocket frame types. */
+export var MessageType;
+(function (MessageType) {
+    /** Client → Server: RPC call expecting a response */
+    MessageType["RPC"] = "rpc";
+    /** Client → Server: fire-and-forget RPC (no response) */
+    MessageType["RPC_VOID"] = "rpc:void";
+    /** Server → Client: RPC response correlated by `id` */
+    MessageType["RPC_RESPONSE"] = "rpc:res";
+    /** Server → Client: push event from a subscription */
+    MessageType["EVENT"] = "event";
+    /** Server → Client: authentication result after connection */
+    MessageType["AUTH"] = "auth";
+    /** Bidirectional: keep-alive ping (server-initiated) */
+    MessageType["PING"] = "ping";
+    /** Bidirectional: keep-alive pong (client response) */
+    MessageType["PONG"] = "pong";
+})(MessageType || (MessageType = {}));
+// ---------------------------------------------------------------------------
+// Type guards
+// ---------------------------------------------------------------------------
+/** Narrows a parsed envelope to an RPC call. */
+export function isRpcMessage(msg) {
+    return msg.t === MessageType.RPC;
+}
+/** Narrows a parsed envelope to a void RPC call. */
+export function isRpcVoidMessage(msg) {
+    return msg.t === MessageType.RPC_VOID;
+}
+/** Narrows a parsed envelope to an RPC response. */
+export function isRpcResponse(msg) {
+    return msg.t === MessageType.RPC_RESPONSE;
+}
+/** Narrows a parsed envelope to a push event. */
+export function isEventMessage(msg) {
+    return msg.t === MessageType.EVENT;
+}
+/** Narrows a parsed envelope to an auth result. */
+export function isAuthMessage(msg) {
+    return msg.t === MessageType.AUTH;
+}
+/** Narrows a parsed envelope to a ping. */
+export function isPingMessage(msg) {
+    return msg.t === MessageType.PING;
+}
+/** Narrows a parsed envelope to a pong. */
+export function isPongMessage(msg) {
+    return msg.t === MessageType.PONG;
+}
+//# sourceMappingURL=protocol.js.map

package/dist/utils/protocol.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"protocol.js","sourceRoot":"","sources":["../../src/utils/protocol.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,mDAAmD;AACnD,MAAM,CAAN,IAAY,WAeX;AAfD,WAAY,WAAW;IACrB,qDAAqD;IACrD,0BAAW,CAAA;IACX,yDAAyD;IACzD,oCAAqB,CAAA;IACrB,uDAAuD;IACvD,uCAAwB,CAAA;IACxB,sDAAsD;IACtD,8BAAe,CAAA;IACf,8DAA8D;IAC9D,4BAAa,CAAA;IACb,wDAAwD;IACxD,4BAAa,CAAA;IACb,uDAAuD;IACvD,4BAAa,CAAA;AACf,CAAC,EAfW,WAAW,KAAX,WAAW,QAetB;AAkFD,8EAA8E;AAC9E,cAAc;AACd,8EAA8E;AAE9E,gDAAgD;AAChD,MAAM,UAAU,YAAY,CAAC,GAAkB;IAC7C,OAAO,GAAG,CAAC,CAAC,KAAK,WAAW,CAAC,GAAG,CAAA;AAClC,CAAC;AAED,oDAAoD;AACpD,MAAM,UAAU,gBAAgB,CAAC,GAAkB;IACjD,OAAO,GAAG,CAAC,CAAC,KAAK,WAAW,CAAC,QAAQ,CAAA;AACvC,CAAC;AAED,oDAAoD;AACpD,MAAM,UAAU,aAAa,CAAC,GAAkB;IAC9C,OAAO,GAAG,CAAC,CAAC,KAAK,WAAW,CAAC,YAAY,CAAA;AAC3C,CAAC;AAED,iDAAiD;AACjD,MAAM,UAAU,cAAc,CAAC,GAAkB;IAC/C,OAAO,GAAG,CAAC,CAAC,KAAK,WAAW,CAAC,KAAK,CAAA;AACpC,CAAC;AAED,mDAAmD;AACnD,MAAM,UAAU,aAAa,CAAC,GAAkB;IAC9C,OAAO,GAAG,CAAC,CAAC,KAAK,WAAW,CAAC,IAAI,CAAA;AACnC,CAAC;AAED,2CAA2C;AAC3C,MAAM,UAAU,aAAa,CAAC,GAAkB;IAC9C,OAAO,GAAG,CAAC,CAAC,KAAK,WAAW,CAAC,IAAI,CAAA;AACnC,CAAC;AAED,2CAA2C;AAC3C,MAAM,UAAU,aAAa,CAAC,GAAkB;IAC9C,OAAO,GAAG,CAAC,CAAC,KAAK,WAAW,CAAC,IAAI,CAAA;AACnC,CAAC"}

package/dist/utils/types.d.ts

@@ -0,0 +1,23 @@
+import type { z } from 'zod';
+export type AnyFunction = (...args: any[]) => any | Promise<any>;
+export type ServerMethodDefinition<Schema extends z.ZodTypeAny | z.ZodUndefined = z.ZodUndefined, Result = any> = (params: Schema extends z.ZodUndefined ? CallOptions | void : z.input<Schema>, options: Schema extends z.ZodUndefined ? void : CallOptions | void) => Promise<Result>;
+/** Allows flat method definitions, nested namespace objects, or deeply nested. */
+export type ServerMethods = {
+    [key: string]: AnyMethodLike | ServerMethodNode;
+};
+/** Any callable that returns a promise — loose constraint for method shapes. */
+type AnyMethodLike = (...args: never[]) => Promise<unknown>;
+/** Recursive namespace node: methods or further nested namespaces. */
+type ServerMethodNode = {
+    [key: string]: AnyMethodLike | ServerMethodNode;
+};
+export type MethodParams<T = any> = T;
+export type CallOptions = {
+    http?: boolean;
+    timeout?: number;
+    httpFallback?: boolean;
+    ignoreInit?: boolean;
+    maxRetries?: number;
+    delayBetweenRetriesMs?: number;
+};
+export {};

package/dist/utils/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/utils/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/utils/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,187 @@
+{
+  "name": "typeferry",
+  "version": "0.6.0",
+  "description": "Type-safe real-time RPC framework for TypeScript",
+  "type": "module",
+  "sideEffects": false,
+  "license": "MIT",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    "./client": {
+      "types": "./dist/client/index.d.ts",
+      "import": "./dist/client/index.js"
+    },
+    "./server": {
+      "types": "./dist/server/index.d.ts",
+      "import": "./dist/server/index.js"
+    },
+    "./server/decorators": {
+      "types": "./dist/server/decorators/index.d.ts",
+      "import": "./dist/server/decorators/index.js"
+    },
+    "./server/transports": {
+      "types": "./dist/server/transports/index.d.ts",
+      "import": "./dist/server/transports/index.js"
+    },
+    "./auth": {
+      "types": "./dist/auth/index.d.ts",
+      "import": "./dist/auth/index.js"
+    },
+    "./auth/server/oauth": {
+      "types": "./dist/auth/server/oauth/index.d.ts",
+      "import": "./dist/auth/server/oauth/index.js"
+    },
+    "./auth/client/oauth": {
+      "types": "./dist/auth/client/oauth/index.d.ts",
+      "import": "./dist/auth/client/oauth/index.js"
+    },
+    "./react": {
+      "types": "./dist/react/index.d.ts",
+      "import": "./dist/react/index.js"
+    },
+    "./ejson": {
+      "types": "./dist/ejson/index.d.ts",
+      "import": "./dist/ejson/index.js"
+    },
+    "./mongodb": {
+      "types": "./dist/mongodb/index.d.ts",
+      "import": "./dist/mongodb/index.js"
+    },
+    "./mongodb/decorators": {
+      "types": "./dist/mongodb/decorators/index.d.ts",
+      "import": "./dist/mongodb/decorators/index.js"
+    },
+    "./utils": {
+      "types": "./dist/utils/index.d.ts",
+      "import": "./dist/utils/index.js"
+    },
+    "./*": {
+      "types": "./dist/*.d.ts",
+      "import": "./dist/*.js"
+    }
+  },
+  "scripts": {
+    "build": "rm -rf dist && tsc -p tsconfig.build.json && node scripts/prepare-dist.mjs",
+    "typecheck": "tsc --noEmit",
+    "test": "npm run test:unit && npm run test:integration && npm run test:browser",
+    "test:watch": "npm run test:unit:watch",
+    "test:unit": "vitest --config vitest.config.unit.ts --run --watch=false",
+    "test:unit:watch": "vitest --config vitest.config.unit.ts --watch",
+    "test:coverage": "vitest --config vitest.config.unit.ts --run --coverage",
+    "test:integration": "vitest --config vitest.config.integration.ts --run --watch=false",
+    "test:integration:watch": "vitest --config vitest.config.integration.ts --watch",
+    "test:browser": "vitest --config vitest.config.browser.ts --run --watch=false",
+    "test:browser:watch": "vitest --config vitest.config.browser.ts --watch",
+    "lint": "eslint src/",
+    "lint:fix": "eslint src/ --fix"
+  },
+  "dependencies": {
+    "@hono/node-server": "^2.1.1",
+    "@lukeed/uuid": "^2.0.1",
+    "fast-deep-equal": "^3.1.3",
+    "google-auth-library": "^10.9.0",
+    "hono": "^4.13.3",
+    "jsonwebtoken": "^9.0.2",
+    "limiter": "^2.1.0",
+    "memoizee": "^0.4.15",
+    "query-string": "^9.5.0",
+    "redis": "^4.6.7",
+    "ua-parser-js": "^2.0.10",
+    "use-debounce": "^10.1.1",
+    "ws": "^8.21.3",
+    "zod": "^4.4.3"
+  },
+  "peerDependencies": {
+    "@react-oauth/google": ">=0.12",
+    "mongodb": ">=6",
+    "react": ">=18"
+  },
+  "peerDependenciesMeta": {
+    "mongodb": {
+      "optional": true
+    },
+    "react": {
+      "optional": true
+    },
+    "@react-oauth/google": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@eslint/js": "^10.0.1",
+    "@react-oauth/google": "^0.12.2",
+    "@testing-library/react": "^16.3.2",
+    "@types/json-stable-stringify": "^1",
+    "@types/jsonwebtoken": "^9.0.2",
+    "@types/memoizee": "^0",
+    "@types/node": "^24.13.3",
+    "@types/sinon": "^10.0.16",
+    "@types/ua-parser-js": "^0.7.39",
+    "@types/ws": "^8",
+    "@vitest/browser": "^4.1.11",
+    "@vitest/browser-playwright": "^4.1.11",
+    "@vitest/coverage-v8": "^4.1.11",
+    "esbuild": "^0.28.1",
+    "eslint": "^10.9.0",
+    "eslint-plugin-security": "^4.0.1",
+    "globals": "^17.7.0",
+    "jsdom": "^30.0.1",
+    "mongodb": "^7.5.0",
+    "playwright": "^1.61.1",
+    "postcss": "^8.5.26",
+    "react": "^19.2.3",
+    "react-dom": "^19.2.3",
+    "sinon": "^18.0.0",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.67.0",
+    "vite": "^7.3.3",
+    "vitest": "^4.1.11"
+  },
+  "overrides": {
+    "body-parser": "^2.3.0",
+    "brace-expansion": "^5.0.9",
+    "form-data": "^4.0.6",
+    "ip-address": "^10.5.0",
+    "nanoid": "^6.0.1",
+    "postcss": "^8.5.26",
+    "qs": "^6.15.3",
+    "undici": "^7.29.0",
+    "vite": "^7.3.3"
+  },
+  "engines": {
+    "node": "24.19.0",
+    "npm": "11.17.0"
+  },
+  "devEngines": {
+    "runtime": {
+      "name": "node",
+      "version": "24.19.0",
+      "onFail": "error"
+    },
+    "packageManager": {
+      "name": "npm",
+      "version": "11.17.0",
+      "onFail": "error"
+    }
+  },
+  "packageManager": "npm@11.17.0",
+  "allowScripts": {
+    "esbuild": true,
+    "es5-ext": true
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/leonardoventurini/typeferry.git",
+    "directory": "typeferry-ts"
+  },
+  "homepage": "https://github.com/leonardoventurini/typeferry#readme",
+  "bugs": {
+    "url": "https://github.com/leonardoventurini/typeferry/issues"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}