TTC Origin Server

A lightweight server wrapper for ttc-rpc that exposes your decorated classes as RPC endpoints with automatic API discovery.

Installation

bun add ttc-origin-server
# or
npm install ttc-origin-server

Quick Start

1. Create a module using ttc-rpc decorators

// src/test.ts
import { ttc } from "ttc-rpc";
import z from "zod";

export class HelloWorldModule {
    @ttc.describe({
        doc: 'some info',
        inputSchema: z.object({
            name: z.string()
        }),
        outputSchema: z.string(),
        validate: true,
        auth: true
    })
    hello(name: string): string {
        return `Hello, ${name}!`;
    }
}

2. Start the server

// src/index.ts
import { runServer } from 'ttc-origin-server';
import { HelloWorldModule } from './test';

runServer({
    name: 'my-service',
    modules: [HelloWorldModule],
    port: 3000,
    authCb: async (req) => {
        // Your authentication logic
        return true;
    }
});

3. Run

bun run src/index.ts

API

runServer(config)

Starts a TTC Origin server.

Config options:

• name (string) – Service name
• modules (any[]) – Array of classes decorated with @ttc.describe
• port (number) – Port to listen on
• authCb (req => Promise) – Authentication callback
• app (express.Express) – Optional existing Express app
• requireAuth (boolean) – Whether authentication is required
• modifyable (boolean) – If true, exposes working directory
• description (string) – Optional description

Endpoints

• GET /rpc/info – Service metadata
• GET /rpc/functions – Lists all RPC methods (auto‑discovered)
• POST /rpc/:module/:method – Invoke an RPC method (handled by ttc-rpc)

Decorator Usage

Refer to the ttc-rpc npm package for full documentation on the @ttc.describe decorator and its options.

Development

git clone https://github.com/tentarcles/ttc-origin-server.git
cd ttc-origin-server
bun install
bun run dev

License

MIT © Tentarcles