typeferry 0.6.0

package/dist/server/decorators/namespace.js

@@ -0,0 +1,34 @@
+/**
+ * @Namespace class decorator — registers a class as a TypeFerry RPC namespace.
+ *
+ * All methods in the class are prefixed with `{prefix}.{methodName}`.
+ * Also flushes pending @Method metadata into the class's WeakMap entry.
+ *
+ * @module typeferry/server/decorators/namespace
+ */
+import { flushPendingUpdates, getOrCreateNamespaceMeta } from './metadata.js';
+/**
+ * Registers the decorated class as a TypeFerry namespace with the given prefix.
+ *
+ * Class decorators run after all method decorators, so we flush the pending
+ * update queue here — each queued updater receives this class constructor
+ * and writes its metadata into the class's WeakMap entry.
+ *
+ * @example
+ * ```ts
+ * @Namespace('boards')
+ * class BoardMethods { ... }
+ * // Methods register as: boards.get, boards.create, etc.
+ * ```
+ */
+export function Namespace(prefix) {
+    return function (target, _context) {
+        const meta = getOrCreateNamespaceMeta(target);
+        meta.prefix = prefix;
+        // Flush all pending method-level metadata updates (@Method, @Schema,
+        // @Use, @Protected, @Cached, etc.) into this class's WeakMap entries.
+        flushPendingUpdates(target);
+        return target;
+    };
+}
+//# sourceMappingURL=namespace.js.map

package/dist/server/decorators/namespace.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"namespace.js","sourceRoot":"","sources":["../../../src/server/decorators/namespace.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,MAAM,YAAY,CAAA;AAI1E;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,SAAS,CAAC,MAAc;IACtC,OAAO,UACL,MAAS,EACT,QAA+B;QAE/B,MAAM,IAAI,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAAA;QAC7C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QAEpB,qEAAqE;QACrE,sEAAsE;QACtE,mBAAmB,CAAC,MAAM,CAAC,CAAA;QAE3B,OAAO,MAAM,CAAA;IACf,CAAC,CAAA;AACH,CAAC"}

package/dist/server/decorators/protected.d.ts

@@ -0,0 +1,36 @@
+/**
+ * @Protected class decorator — sets `protected: true` as default for all methods.
+ * @Public method decorator — overrides class-level @Protected for a specific method.
+ *
+ * @module typeferry/server/decorators/protected
+ */
+/**
+ * Sets `protected: true` as default for all methods in the class.
+ * Individual methods can override with @Public().
+ *
+ * @example
+ * ```ts
+ * @Namespace('boards')
+ * @Protected()
+ * class BoardMethods {
+ *   // All methods here require authentication by default
+ * }
+ * ```
+ */
+export declare function Protected(): <T>(target: T, context: ClassDecoratorContext | ClassMethodDecoratorContext) => T;
+/**
+ * Overrides class-level @Protected() for a specific method, making it public.
+ *
+ * @example
+ * ```ts
+ * @Namespace('boards')
+ * @Protected()
+ * class BoardMethods {
+ *   @Method()
+ *   @Public()
+ *   async listPublic(client: ClientNode, params) { ... }
+ *   // This method does NOT require authentication
+ * }
+ * ```
+ */
+export declare function Public(): <T extends (...args: never[]) => unknown>(target: T, context: ClassMethodDecoratorContext) => T;

package/dist/server/decorators/protected.js

@@ -0,0 +1,61 @@
+/**
+ * @Protected class decorator — sets `protected: true` as default for all methods.
+ * @Public method decorator — overrides class-level @Protected for a specific method.
+ *
+ * @module typeferry/server/decorators/protected
+ */
+import { getOrCreateMethodMeta, getOrCreateNamespaceMeta, queueMethodUpdate, } from './metadata.js';
+/**
+ * Sets `protected: true` as default for all methods in the class.
+ * Individual methods can override with @Public().
+ *
+ * @example
+ * ```ts
+ * @Namespace('boards')
+ * @Protected()
+ * class BoardMethods {
+ *   // All methods here require authentication by default
+ * }
+ * ```
+ */
+export function Protected() {
+    return function (target, context) {
+        if (context.kind === 'class') {
+            const meta = getOrCreateNamespaceMeta(target);
+            meta.protected = true;
+            return target;
+        }
+        const key = String(context.name);
+        queueMethodUpdate(Class => {
+            const meta = getOrCreateMethodMeta(Class, key);
+            meta.protected = true;
+        });
+        return target;
+    };
+}
+/**
+ * Overrides class-level @Protected() for a specific method, making it public.
+ *
+ * @example
+ * ```ts
+ * @Namespace('boards')
+ * @Protected()
+ * class BoardMethods {
+ *   @Method()
+ *   @Public()
+ *   async listPublic(client: ClientNode, params) { ... }
+ *   // This method does NOT require authentication
+ * }
+ * ```
+ */
+export function Public() {
+    return function (target, context) {
+        const key = String(context.name);
+        queueMethodUpdate(Class => {
+            const meta = getOrCreateMethodMeta(Class, key);
+            meta.protected = false;
+        });
+        return target;
+    };
+}
+//# sourceMappingURL=protected.js.map

package/dist/server/decorators/protected.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"protected.js","sourceRoot":"","sources":["../../../src/server/decorators/protected.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EACL,qBAAqB,EACrB,wBAAwB,EACxB,iBAAiB,GAClB,MAAM,YAAY,CAAA;AAEnB;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,SAAS;IACvB,OAAO,UACL,MAAS,EACT,OAA4D;QAE5D,IAAI,OAAO,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YAC7B,MAAM,IAAI,GAAG,wBAAwB,CAAC,MAAgB,CAAC,CAAA;YACvD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAA;YACrB,OAAO,MAAM,CAAA;QACf,CAAC;QAED,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QAEhC,iBAAiB,CAAC,KAAK,CAAC,EAAE;YACxB,MAAM,IAAI,GAAG,qBAAqB,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;YAC9C,IAAI,CAAC,SAAS,GAAG,IAAI,CAAA;QACvB,CAAC,CAAC,CAAA;QAEF,OAAO,MAAM,CAAA;IACf,CAAC,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,MAAM;IACpB,OAAO,UACL,MAAS,EACT,OAAoC;QAEpC,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QAEhC,iBAAiB,CAAC,KAAK,CAAC,EAAE;YACxB,MAAM,IAAI,GAAG,qBAAqB,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;YAC9C,IAAI,CAAC,SAAS,GAAG,KAAK,CAAA;QACxB,CAAC,CAAC,CAAA;QAEF,OAAO,MAAM,CAAA;IACf,CAAC,CAAA;AACH,CAAC"}

package/dist/server/decorators/register.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Registers a decorator-based namespace class with TypeFerry.
+ *
+ * Reads WeakMap metadata from @Namespace, @Method, @Schema, @Use, @Protected,
+ * @Cached decorators and calls `global.TypeFerry.addMethod()` for each method.
+ *
+ * @module typeferry/server/decorators/register
+ */
+/**
+ * Registers all decorated methods on a namespace class with TypeFerry.
+ *
+ * Creates a singleton instance, reads class/method metadata, wraps each method
+ * to inject `ClientNode` as the first argument, and calls `global.TypeFerry.addMethod()`.
+ *
+ * @param Class - A class decorated with @Namespace and containing @Method members
+ *
+ * @example
+ * ```ts
+ * import { registerNamespace } from 'typeferry/server/decorators'
+ * import { BoardMethods } from './boards.js'
+ *
+ * registerNamespace(BoardMethods)
+ * ```
+ */
+export declare function registerNamespace(Class: new (...args: never[]) => unknown): void;

package/dist/server/decorators/register.js

@@ -0,0 +1,72 @@
+/**
+ * Registers a decorator-based namespace class with TypeFerry.
+ *
+ * Reads WeakMap metadata from @Namespace, @Method, @Schema, @Use, @Protected,
+ * @Cached decorators and calls `global.TypeFerry.addMethod()` for each method.
+ *
+ * @module typeferry/server/decorators/register
+ */
+import { METHOD_META, NAMESPACE_META } from './metadata.js';
+/** Build a full method name from namespace prefix and method name */
+function buildFullName(nsMeta, meta) {
+    return nsMeta.prefix ? `${nsMeta.prefix}.${meta.name}` : meta.name;
+}
+/** Merge class-level and method-level options into MethodOptions */
+function buildOptions(nsMeta, meta) {
+    const isProtected = meta.protected ?? nsMeta.protected;
+    const isCached = meta.cached ?? nsMeta.cached;
+    const maxAge = meta.maxAge ?? (isCached ? nsMeta.maxAge : undefined);
+    return {
+        protected: isProtected,
+        middleware: meta.middleware.length > 0 ? meta.middleware : undefined,
+        schema: meta.schema,
+        cache: isCached || undefined,
+        maxAge,
+    };
+}
+/**
+ * Wrap a decorator-style method (explicit client param) into TypeFerry's
+ * `this`-based ClientNode binding.
+ */
+function wrapMethod(boundFn) {
+    return function (params) {
+        return boundFn(this, params);
+    };
+}
+/**
+ * Registers all decorated methods on a namespace class with TypeFerry.
+ *
+ * Creates a singleton instance, reads class/method metadata, wraps each method
+ * to inject `ClientNode` as the first argument, and calls `global.TypeFerry.addMethod()`.
+ *
+ * @param Class - A class decorated with @Namespace and containing @Method members
+ *
+ * @example
+ * ```ts
+ * import { registerNamespace } from 'typeferry/server/decorators'
+ * import { BoardMethods } from './boards.js'
+ *
+ * registerNamespace(BoardMethods)
+ * ```
+ */
+export function registerNamespace(Class) {
+    const nsMeta = NAMESPACE_META.get(Class);
+    if (!nsMeta) {
+        throw new Error(`Class "${Class.name}" is missing @Namespace decorator. ` +
+            'Add @Namespace(prefix) to register it as a TypeFerry namespace.');
+    }
+    // Instantiate to get bound method references for TypeFerry registration
+    const instance = new Class();
+    const methodsMap = METHOD_META.get(Class);
+    if (!methodsMap?.size) {
+        throw new Error(`Namespace "${nsMeta.prefix}" (${Class.name}) has no @Method-decorated members.`);
+    }
+    for (const [propertyKey, meta] of methodsMap) {
+        const originalFn = instance[propertyKey];
+        if (typeof originalFn !== 'function') {
+            throw new Error(`"${propertyKey}" on ${Class.name} is not a function — cannot register as TypeFerry method.`);
+        }
+        global.TypeFerry.addMethod(buildFullName(nsMeta, meta), wrapMethod(originalFn.bind(instance)), buildOptions(nsMeta, meta));
+    }
+}
+//# sourceMappingURL=register.js.map

package/dist/server/decorators/register.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"register.js","sourceRoot":"","sources":["../../../src/server/decorators/register.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAMH,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAExD,qEAAqE;AACrE,SAAS,aAAa,CAAC,MAAqB,EAAE,IAAgB;IAC5D,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAA;AACpE,CAAC;AAED,oEAAoE;AACpE,SAAS,YAAY,CAAC,MAAqB,EAAE,IAAgB;IAC3D,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,IAAI,MAAM,CAAC,SAAS,CAAA;IACtD,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,CAAA;IAC7C,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;IAEpE,OAAO;QACL,SAAS,EAAE,WAAW;QACtB,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS;QACpE,MAAM,EAAE,IAAI,CAAC,MAAM;QACnB,KAAK,EAAE,QAAQ,IAAI,SAAS;QAC5B,MAAM;KACP,CAAA;AACH,CAAC;AAED;;;GAGG;AACH,SAAS,UAAU,CACjB,OAAyD;IAEzD,OAAO,UAA4B,MAAM;QACvC,OAAO,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IAC9B,CAAC,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,iBAAiB,CAC/B,KAAwC;IAExC,MAAM,MAAM,GAAG,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;IACxC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CACb,UAAU,KAAK,CAAC,IAAI,qCAAqC;YACvD,iEAAiE,CACpE,CAAA;IACH,CAAC;IAED,wEAAwE;IACxE,MAAM,QAAQ,GAAG,IAAK,KAA2C,EAAE,CAAA;IAEnE,MAAM,UAAU,GAAG,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;IACzC,IAAI,CAAC,UAAU,EAAE,IAAI,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CACb,cAAc,MAAM,CAAC,MAAM,MAAM,KAAK,CAAC,IAAI,qCAAqC,CACjF,CAAA;IACH,CAAC;IAED,KAAK,MAAM,CAAC,WAAW,EAAE,IAAI,CAAC,IAAI,UAAU,EAAE,CAAC;QAC7C,MAAM,UAAU,GAAG,QAAQ,CAAC,WAAW,CAG3B,CAAA;QAEZ,IAAI,OAAO,UAAU,KAAK,UAAU,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CACb,IAAI,WAAW,QAAQ,KAAK,CAAC,IAAI,2DAA2D,CAC7F,CAAA;QACH,CAAC;QAED,MAAM,CAAC,SAAS,CAAC,SAAS,CACxB,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,EAC3B,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,EACrC,YAAY,CAAC,MAAM,EAAE,IAAI,CAAC,CAC3B,CAAA;IACH,CAAC;AACH,CAAC"}

package/dist/server/decorators/schema.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @Schema decorator — attaches a Zod validation schema to a TypeFerry method.
+ *
+ * @module typeferry/server/decorators/schema
+ */
+import type { z } from 'zod';
+/**
+ * Attaches a Zod schema for input validation on the decorated method.
+ *
+ * @example
+ * ```ts
+ * @Method()
+ * @Schema(z.object({ boardId: z.string(), name: z.string().min(1) }))
+ * async create(client: ClientNode, params: CreateParams) { ... }
+ * ```
+ */
+export declare function Schema(schema: z.ZodType): <T extends (...args: never[]) => unknown>(target: T, context: ClassMethodDecoratorContext) => T;

package/dist/server/decorators/schema.js

@@ -0,0 +1,27 @@
+/**
+ * @Schema decorator — attaches a Zod validation schema to a TypeFerry method.
+ *
+ * @module typeferry/server/decorators/schema
+ */
+import { getOrCreateMethodMeta, queueMethodUpdate } from './metadata.js';
+/**
+ * Attaches a Zod schema for input validation on the decorated method.
+ *
+ * @example
+ * ```ts
+ * @Method()
+ * @Schema(z.object({ boardId: z.string(), name: z.string().min(1) }))
+ * async create(client: ClientNode, params: CreateParams) { ... }
+ * ```
+ */
+export function Schema(schema) {
+    return function (target, context) {
+        const key = String(context.name);
+        queueMethodUpdate(Class => {
+            const meta = getOrCreateMethodMeta(Class, key);
+            meta.schema = schema;
+        });
+        return target;
+    };
+}
+//# sourceMappingURL=schema.js.map

package/dist/server/decorators/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../../src/server/decorators/schema.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAErE;;;;;;;;;GASG;AACH,MAAM,UAAU,MAAM,CAAC,MAAiB;IACtC,OAAO,UACL,MAAS,EACT,OAAoC;QAEpC,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QAEhC,iBAAiB,CAAC,KAAK,CAAC,EAAE;YACxB,MAAM,IAAI,GAAG,qBAAqB,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;YAC9C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACtB,CAAC,CAAC,CAAA;QAEF,OAAO,MAAM,CAAA;IACf,CAAC,CAAA;AACH,CAAC"}

package/dist/server/decorators/use.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @Use decorator — attaches middleware functions to a TypeFerry method.
+ *
+ * Multiple @Use() decorators stack. TC39 decorators evaluate bottom-to-top,
+ * so the pending queue receives entries in reverse order. @Namespace flushes
+ * them with `.pop()`, restoring the visual order (top @Use runs first).
+ *
+ * @module typeferry/server/decorators/use
+ */
+import type { AnyFunction } from '../../utils/index.js';
+/**
+ * Attaches middleware functions to the decorated method.
+ *
+ * @example
+ * ```ts
+ * @Method()
+ * @Schema(z.object({ boardId: z.string() }))
+ * @Use(withBoardPermissionLevel(Permission.Read))
+ * async get(client: ClientNode, { boardId, board }: GetBoardParams) { ... }
+ * ```
+ */
+export declare function Use(...middleware: AnyFunction[]): <T extends (...args: never[]) => unknown>(target: T, context: ClassMethodDecoratorContext) => T;

package/dist/server/decorators/use.js

@@ -0,0 +1,32 @@
+/**
+ * @Use decorator — attaches middleware functions to a TypeFerry method.
+ *
+ * Multiple @Use() decorators stack. TC39 decorators evaluate bottom-to-top,
+ * so the pending queue receives entries in reverse order. @Namespace flushes
+ * them with `.pop()`, restoring the visual order (top @Use runs first).
+ *
+ * @module typeferry/server/decorators/use
+ */
+import { getOrCreateMethodMeta, queueMethodUpdate } from './metadata.js';
+/**
+ * Attaches middleware functions to the decorated method.
+ *
+ * @example
+ * ```ts
+ * @Method()
+ * @Schema(z.object({ boardId: z.string() }))
+ * @Use(withBoardPermissionLevel(Permission.Read))
+ * async get(client: ClientNode, { boardId, board }: GetBoardParams) { ... }
+ * ```
+ */
+export function Use(...middleware) {
+    return function (target, context) {
+        const key = String(context.name);
+        queueMethodUpdate(Class => {
+            const meta = getOrCreateMethodMeta(Class, key);
+            meta.middleware.push(...middleware);
+        });
+        return target;
+    };
+}
+//# sourceMappingURL=use.js.map

package/dist/server/decorators/use.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use.js","sourceRoot":"","sources":["../../../src/server/decorators/use.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAIH,OAAO,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAErE;;;;;;;;;;GAUG;AACH,MAAM,UAAU,GAAG,CAAC,GAAG,UAAyB;IAC9C,OAAO,UACL,MAAS,EACT,OAAoC;QAEpC,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QAEhC,iBAAiB,CAAC,KAAK,CAAC,EAAE;YACxB,MAAM,IAAI,GAAG,qBAAqB,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;YAC9C,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,CAAA;QACrC,CAAC,CAAC,CAAA;QAEF,OAAO,MAAM,CAAA;IACf,CAAC,CAAA;AACH,CAAC"}

package/dist/server/default-methods.d.ts

@@ -0,0 +1,8 @@
+import type { z } from 'zod';
+import type { Method } from './method.js';
+import type { Server } from './server.js';
+type MethodBuilder<Schema extends z.ZodUndefined | z.ZodObject<any> = z.ZodUndefined, Result = any> = (server: Server, name: string) => Method<Schema, Result>;
+export declare const DefaultMethods: {
+    [key: string]: MethodBuilder;
+};
+export {};

package/dist/server/default-methods.js

@@ -0,0 +1,8 @@
+import { Methods } from '../utils/index.js';
+import { rpcLogout, rpcOff, rpcOn } from './methods.js';
+export const DefaultMethods = {
+    [Methods.RPC_ON]: rpcOn,
+    [Methods.RPC_OFF]: rpcOff,
+    [Methods.RPC_LOGOUT]: rpcLogout,
+};
+//# sourceMappingURL=default-methods.js.map

package/dist/server/default-methods.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"default-methods.js","sourceRoot":"","sources":["../../src/server/default-methods.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAA;AAElC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,WAAW,CAAA;AAQpD,MAAM,CAAC,MAAM,cAAc,GAEvB;IACF,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,KAAK;IACvB,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,MAAM;IACzB,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,SAAS;CAChC,CAAA"}

package/dist/server/event.d.ts

@@ -0,0 +1,42 @@
+import type { ClientNode } from './client-node.js';
+import type { Server } from './server.js';
+import type { ServerChannel } from './server-channel.js';
+export type EventOptions = {
+    /**
+     * Requires authentication to subscribe to this event.
+     */
+    protected?: boolean;
+    /**
+     * Only allow user to subscribe to this event on his own channel. Automatically makes the event protected.
+     */
+    user?: boolean;
+    /**
+     * This overrides the `user` flag.
+     */
+    shouldSubscribe?: (client: ClientNode, eventName: string, channel: string) => Promise<boolean>;
+    /**
+     * This will propagate the event to other instances when running node in a cluster.
+     */
+    cluster?: boolean;
+    /**
+     * When true, excludes the originating client from receiving the event.
+     * Requires `params.uuid` to identify the originator.
+     */
+    excludeOriginator?: boolean;
+};
+export declare class Event {
+    uuid: string;
+    name: string;
+    isProtected: boolean;
+    channel: ServerChannel;
+    server: Server;
+    cluster: boolean;
+    excludeOriginator: boolean;
+    shouldSubscribe: (client: ClientNode, eventName: string, channel: string) => Promise<boolean>;
+    constructor(name: string, server: Server, channel: ServerChannel, opts?: EventOptions);
+    /**
+     * Encodes the event with the wire protocol `t` field so propagate()
+     * can forward the payload directly without re-encoding.
+     */
+    handler(channel: ServerChannel, params: Record<string, string>): void;
+}

package/dist/server/event.js

@@ -0,0 +1,53 @@
+import { MessageType, Presentation } from '../utils/index.js';
+export class Event {
+    uuid;
+    name;
+    isProtected;
+    channel;
+    server;
+    cluster;
+    excludeOriginator;
+    shouldSubscribe = async () => true;
+    constructor(name, server, channel, opts) {
+        this.uuid = Presentation.uuid();
+        this.name = name;
+        this.server = server;
+        this.channel = channel;
+        this.isProtected = opts?.protected ?? false;
+        if (opts?.user) {
+            this.isProtected = true;
+            this.shouldSubscribe = async function (client, event, channel) {
+                if (!client.userId)
+                    return false;
+                return channel === client.userId.toString();
+            };
+        }
+        if (opts?.shouldSubscribe) {
+            this.shouldSubscribe = opts.shouldSubscribe;
+        }
+        this.cluster = Boolean(opts?.cluster);
+        this.excludeOriginator = Boolean(opts?.excludeOriginator);
+    }
+    /**
+     * Encodes the event with the wire protocol `t` field so propagate()
+     * can forward the payload directly without re-encoding.
+     */
+    handler(channel, params) {
+        const payload = Presentation.encode({
+            t: MessageType.EVENT,
+            uuid: Presentation.uuid(),
+            event: this.name,
+            channel: channel.channelName,
+            params,
+        });
+        const excludeUuid = this.excludeOriginator ? params.uuid : undefined;
+        if (this.cluster && this.server?.redisTransport?.pub) {
+            this.server.redisTransport
+                .publish(this.name, channel.channelName, payload, excludeUuid)
+                .catch(console.error);
+            return;
+        }
+        channel.propagate(this.name, payload, excludeUuid);
+    }
+}
+//# sourceMappingURL=event.js.map

package/dist/server/event.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"event.js","sourceRoot":"","sources":["../../src/server/event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAqCpD,MAAM,OAAO,KAAK;IAChB,IAAI,CAAQ;IACZ,IAAI,CAAQ;IACZ,WAAW,CAAS;IACpB,OAAO,CAAe;IACtB,MAAM,CAAQ;IACd,OAAO,CAAS;IAChB,iBAAiB,CAAS;IAE1B,eAAe,GAIS,KAAK,IAAI,EAAE,CAAC,IAAI,CAAA;IAExC,YACE,IAAY,EACZ,MAAc,EACd,OAAsB,EACtB,IAAmB;QAEnB,IAAI,CAAC,IAAI,GAAG,YAAY,CAAC,IAAI,EAAE,CAAA;QAC/B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QAEtB,IAAI,CAAC,WAAW,GAAG,IAAI,EAAE,SAAS,IAAI,KAAK,CAAA;QAE3C,IAAI,IAAI,EAAE,IAAI,EAAE,CAAC;YACf,IAAI,CAAC,WAAW,GAAG,IAAI,CAAA;YAEvB,IAAI,CAAC,eAAe,GAAG,KAAK,WAAW,MAAM,EAAE,KAAK,EAAE,OAAO;gBAC3D,IAAI,CAAC,MAAM,CAAC,MAAM;oBAAE,OAAO,KAAK,CAAA;gBAEhC,OAAO,OAAO,KAAK,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAA;YAC7C,CAAC,CAAA;QACH,CAAC;QAED,IAAI,IAAI,EAAE,eAAe,EAAE,CAAC;YAC1B,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,CAAA;QAC7C,CAAC;QAED,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QACrC,IAAI,CAAC,iBAAiB,GAAG,OAAO,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAA;IAC3D,CAAC;IAED;;;OAGG;IACH,OAAO,CAAC,OAAsB,EAAE,MAA8B;QAC5D,MAAM,OAAO,GAAG,YAAY,CAAC,MAAM,CAAC;YAClC,CAAC,EAAE,WAAW,CAAC,KAAK;YACpB,IAAI,EAAE,YAAY,CAAC,IAAI,EAAE;YACzB,KAAK,EAAE,IAAI,CAAC,IAAI;YAChB,OAAO,EAAE,OAAO,CAAC,WAAW;YAC5B,MAAM;SACP,CAAC,CAAA;QAEF,MAAM,WAAW,GAAG,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAA;QAEpE,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,MAAM,EAAE,cAAc,EAAE,GAAG,EAAE,CAAC;YACrD,IAAI,CAAC,MAAM,CAAC,cAAc;iBACvB,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,WAAW,EAAE,OAAO,EAAE,WAAW,CAAC;iBAC7D,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;YAEvB,OAAM;QACR,CAAC;QAED,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,WAAW,CAAC,CAAA;IACpD,CAAC;CACF"}

package/dist/server/index.d.ts

@@ -0,0 +1,10 @@
+export * from './typeferry-async-local-storage.js';
+export * from './client-node.js';
+export * from './default-methods.js';
+export * from './event.js';
+export * from './method.js';
+export * from './methods.js';
+export * from './server.js';
+export * from './server-channel.js';
+export * from './transports/index.js';
+export * from './types.js';

package/dist/server/index.js

@@ -0,0 +1,11 @@
+export * from './typeferry-async-local-storage.js';
+export * from './client-node.js';
+export * from './default-methods.js';
+export * from './event.js';
+export * from './method.js';
+export * from './methods.js';
+export * from './server.js';
+export * from './server-channel.js';
+export * from './transports/index.js';
+export * from './types.js';
+//# sourceMappingURL=index.js.map

package/dist/server/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/server/index.ts"],"names":[],"mappings":"AAAA,cAAc,iCAAiC,CAAA;AAC/C,cAAc,eAAe,CAAA;AAC7B,cAAc,mBAAmB,CAAA;AACjC,cAAc,SAAS,CAAA;AACvB,cAAc,UAAU,CAAA;AACxB,cAAc,WAAW,CAAA;AACzB,cAAc,UAAU,CAAA;AACxB,cAAc,kBAAkB,CAAA;AAChC,cAAc,cAAc,CAAA;AAC5B,cAAc,SAAS,CAAA"}

package/dist/server/method.d.ts

@@ -0,0 +1,95 @@
+import type { z } from 'zod';
+import type { AnyFunction, MethodParams as MethodParameters } from '../utils/index.js';
+import type { ClientNode } from './client-node.js';
+import type { Server } from './server.js';
+/**
+ * Function signature for TypeFerry RPC methods.
+ *
+ * @typeParam T - The type of the method parameters
+ * @typeParam R - The return type of the method
+ */
+export type MethodFunction<T = any, R = any> = (this: ClientNode, parameters?: MethodParameters<T>) => Promise<R> | R;
+/**
+ * Configuration options for TypeFerry RPC methods.
+ *
+ * @typeParam Schema - A Zod schema type for input validation
+ *
+ * @example
+ * ```ts
+ * TypeFerry.addMethod(
+ *   'user.create',
+ *   async ({ email, name }) => { ... },
+ *   {
+ *     protected: true,
+ *     schema: z.object({
+ *       email: z.string().email(),
+ *       name: z.string().min(1),
+ *     }),
+ *   }
+ * )
+ * ```
+ */
+export interface MethodOptions<Schema extends z.ZodType = z.ZodType> {
+    /** Enable result caching for this method */
+    cache?: boolean;
+    /** Cache TTL in milliseconds (default: 60000) */
+    maxAge?: number;
+    /** Require authentication to call this method */
+    protected?: boolean;
+    /** Middleware functions to run before the method handler */
+    middleware?: AnyFunction[];
+    /** Zod schema for input validation and type inference */
+    schema?: Schema;
+    /**
+     * Redact parameters, results, and errors from method telemetry.
+     *
+     * Use this for RPCs whose payloads contain credentials, authorization
+     * scopes, private query arguments, or other data that must not reach
+     * METHOD_EXECUTION/METHOD_ERROR observers.
+     */
+    sensitive?: boolean;
+}
+/** Stable marker used when sensitive method telemetry is intentionally hidden. */
+export declare const REDACTED_METHOD_TELEMETRY: "[REDACTED]";
+/** Returns a method telemetry field with the configured sensitivity applied. */
+export declare function redactMethodTelemetry(method: Pick<Method<z.ZodType, unknown>, 'isSensitive'>, value: unknown): unknown;
+/**
+ * Represents a registered TypeFerry RPC method with validation and middleware support.
+ *
+ * Methods are the core RPC primitives in TypeFerry. Each method can have:
+ * - Input validation via Zod schemas
+ * - Middleware chain for authentication/authorization
+ * - Result caching with configurable TTL
+ * - Execution time tracking
+ *
+ * @typeParam Schema - The Zod schema type for input validation
+ * @typeParam Result - The return type of the method
+ */
+export declare class Method<Schema extends z.ZodType, Result> {
+    uuid: string;
+    fn: MethodFunction;
+    isProtected: boolean;
+    isSensitive: boolean;
+    middleware: AnyFunction[];
+    schema: z.ZodSchema | null;
+    name: string;
+    server: Server;
+    constructor(server: Server, name: string, fn: MethodFunction<z.input<Schema> | any, Result>, opts: MethodOptions<Schema>);
+    /**
+     * Executes the middleware chain, passing params through each middleware.
+     * Each middleware can transform or augment the params before passing to the next.
+     */
+    runMiddleware(parameters: MethodParameters, node?: ClientNode): Promise<MethodParameters>;
+    /**
+     * Executes the method with validation, middleware, and timing.
+     *
+     * Execution flow:
+     * 1. Validate params against Zod schema (if provided)
+     * 2. Run middleware chain
+     * 3. Execute method handler
+     * 4. Emit execution event with timing data
+     *
+     * @throws {SchemaValidationError} When params fail Zod validation
+     */
+    exec(parameters: MethodParameters, node?: ClientNode): Promise<Result>;
+}