ttc-origin-server 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Tentarcles
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,157 @@
+# TTC Origin Server
+
+A lightweight, decorator‑based RPC server for the Tentarcles Origins platform. Quickly expose TypeScript classes as RPC endpoints with Zod validation and automatic API discovery.
+
+## Features
+
+- **Decorator‑based endpoints** – Use `@ttc.describe()` to expose methods
+- **Zod validation** – Type‑safe input/output schemas
+- **Automatic API discovery** – `/rpc/functions` endpoint lists all available methods
+- **Authentication hooks** – Customizable auth middleware
+- **Express‑compatible** – Use your own Express app or let the library create one
+- **Bun/Node.js** – Runs on Bun (recommended) or Node.js
+
+## Installation
+
+```bash
+# Using Bun
+bun add ttc-origin-server
+
+# Using npm
+npm install ttc-origin-server
+
+# Using yarn
+yarn add ttc-origin-server
+```
+
+## Quick Start
+
+1. **Create a module**
+
+```typescript
+// src/modules/hello.ts
+import { ttc } from 'ttc-rpc';
+import { z } from 'zod';
+
+export class HelloService {
+  @ttc.describe({
+    name: 'greet',
+    description: 'Returns a personalized greeting',
+    input: z.object({
+      name: z.string().optional().default('World')
+    }),
+    output: z.string()
+  })
+  greet(input: { name?: string }): string {
+    return `Hello, ${input.name}!`;
+  }
+}
+```
+
+2. **Start the server**
+
+```typescript
+// src/index.ts
+import { runServer } from 'ttc-origin-server';
+import { HelloService } from './modules/hello';
+
+runServer({
+  name: 'my-service',
+  description: 'A demo TTC Origins service',
+  modules: [HelloService],
+  port: 3000,
+  authCb: async (req) => {
+    // Your authentication logic
+    return true; // Allow all requests
+  }
+});
+```
+
+3. **Run it**
+
+```bash
+bun run src/index.ts
+# or with hot reload
+bun run dev
+```
+
+## API Reference
+
+### `runServer(config)`
+
+Starts the TTC Origin server.
+
+**Configuration:**
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `name` | `string` | Service name (spaces replaced with underscores) |
+| `description` | `string` | Optional service description |
+| `modules` | `any[]` | Array of classes with `@ttc.describe` decorators |
+| `port` | `number` | Port to listen on |
+| `authCb` | `(req) => Promise<boolean>` | Authentication callback |
+| `app` | `express.Express` | Optional existing Express app |
+| `requireAuth` | `boolean` | Whether authentication is required |
+| `modifyable` | `boolean` | If `true`, exposes the working directory |
+
+### Endpoints
+
+- `GET /rpc/info` – Returns service metadata
+- `GET /rpc/functions` – Lists all available RPC methods with schemas
+- `POST /rpc/:module/:method` – Invokes an RPC method (handled by `ttc-rpc`)
+
+## Example Module
+
+```typescript
+import { ttc } from 'ttc-rpc';
+import { z } from 'zod';
+
+export class Calculator {
+  @ttc.describe({
+    name: 'add',
+    description: 'Adds two numbers',
+    input: z.object({
+      a: z.number(),
+      b: z.number()
+    }),
+    output: z.number()
+  })
+  add(input: { a: number; b: number }): number {
+    return input.a + input.b;
+  }
+
+  @ttc.describe({
+    name: 'multiply',
+    description: 'Multiplies two numbers',
+    input: z.object({
+      a: z.number(),
+      b: z.number()
+    }),
+    output: z.number()
+  })
+  multiply(input: { a: number; b: number }): number {
+    return input.a * input.b;
+  }
+}
+```
+
+## Development
+
+```bash
+# Clone the repository
+git clone https://github.com/tentarcles/ttc-origin-server.git
+cd ttc-origin-server
+
+# Install dependencies
+bun install
+
+# Run in development mode (hot reload)
+bun run dev
+
+# Build for production
+bun run build
+```
+
+## License
+
+MIT © Tentarcles

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "ttc-origin-server",
+  "version": "0.1.0",
+  "description": "A lightweight server for TTC Origins - run RPC services with decorator-based endpoints",
+  "main": "dist/index.js",
+  "module": "src/index.ts",
+  "type": "module",
+  "private": false,
+  "files": [
+    "dist",
+    "src",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "start": "bun run src/index.ts",
+    "dev": "bun --watch src/index.ts",
+    "test": "bun run src/modules/logModule.ts",
+    "build": "tsc",
+    "prepublishOnly": "bun run build"
+  },
+  "keywords": [
+    "ttc",
+    "origins",
+    "rpc",
+    "server",
+    "decorators",
+    "typescript",
+    "express"
+  ],
+  "author": "Tentarcles",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tentarcles/ttc-origin-server.git"
+  },
+  "bugs": {
+    "url": "https://github.com/tentarcles/ttc-origin-server/issues"
+  },
+  "homepage": "https://github.com/tentarcles/ttc-origin-server#readme",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "express": "^5.2.1",
+    "reflect-metadata": "^0.2.2",
+    "ttc-rpc": "^2.1.4",
+    "zod": "^4.3.6"
+  },
+  "devDependencies": {
+    "@types/bun": "latest",
+    "@types/express": "^5.0.0",
+    "@types/node": "^20.0.0",
+    "typescript": "^5.0.0"
+  },
+  "peerDependencies": {
+    "typescript": "^5"
+  },
+  "engines": {
+    "node": ">=18.0.0",
+    "bun": ">=1.0.0"
+  }
+}

package/src/index.ts

@@ -0,0 +1,65 @@
+import { generateRPCMethodsInfo, ttc, type RPCMethodInfo } from 'ttc-rpc';
+import express from 'express';
+
+
+
+export const runServer = (config: {
+    name: string,
+    description?: string,
+    modules: any[],
+    port: number,
+    requireAuth?: boolean,
+    modifyable?: boolean,
+    authCb: (req: any) => Promise<boolean>,
+    app?: express.Express
+}) => {
+    const { modules, port, app } = config;
+    const appInstance = app || express();
+
+    config.name = config.name.replace(/\s+/g, '_').toLowerCase();
+
+    // authenticate to the ttc server
+    // the server will get the definition and Qualities and url etc
+    appInstance.get('/rpc/info', (req, res) => {
+        res.json({
+            name: config.name,
+            description: config.description || '',
+            requireAuth: config.requireAuth,
+            directory: config.modifyable ? process.cwd() : undefined
+        });
+    });
+
+    appInstance.get('/rpc/functions', (req, res) => {
+        const queryParams = req.query;
+        const assistant = queryParams.assistant as string | undefined;
+        console.log(`${assistant} is accessing the RPC definitions..`);
+        const info: Record<string, RPCMethodInfo[]> = generateRPCMethodsInfo();
+        const finalFunctions: RPCMethodInfo[] = [];
+        Object.keys(info).forEach((module: string) => {
+            const functions = info[module]?.map((func: RPCMethodInfo) => {
+                return {
+                    ...func,
+                    name: `${config.name}.${module}.${func.name}`
+                }
+            }) || [];
+            finalFunctions.push(...functions);
+        });
+        console.log(JSON.stringify(finalFunctions, null, 2));
+        res.json({
+            functions: finalFunctions
+        });
+    });
+
+    ttc.init({
+        app: appInstance,
+        modules: modules,
+        generate_client: false,
+        authCb: async (req) => {
+            // authorization for fetching functions will come through here
+            if(config.authCb){
+                return await config.authCb(req);
+            }
+        },
+        socketCb: async (socket) => { }
+    }).listen(port);
+}