ttc-origin-server 0.1.0 → 0.3.0

package/README.md

@@ -1,50 +1,37 @@
 # 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
+A lightweight server wrapper for `ttc-rpc` that exposes your decorated classes as RPC endpoints with automatic API discovery.
 
 ## Installation
 
 ```bash
-# Using Bun
 bun add ttc-origin-server
-
-# Using npm
+# or
 npm install ttc-origin-server
-
-# Using yarn
-yarn add ttc-origin-server
 ```
 
 ## Quick Start
 
-1. **Create a module**
+1. **Create a module using `ttc-rpc` decorators**
 
 ```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}!`;
-  }
+// 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}!`;
+    }
 }
 ```
 
@@ -53,103 +40,59 @@ export class HelloService {
 ```typescript
 // src/index.ts
 import { runServer } from 'ttc-origin-server';
-import { HelloService } from './modules/hello';
+import { HelloWorldModule } from './test';
 
 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
-  }
+    name: 'my-service',
+    modules: [HelloWorldModule],
+    port: 3000,
+    authCb: async (req) => {
+        // Your authentication logic
+        return true;
+    }
 });
 ```
 
-3. **Run it**
+3. **Run**
 
 ```bash
 bun run src/index.ts
-# or with hot reload
-bun run dev
 ```
 
-## API Reference
+## API
 
 ### `runServer(config)`
 
-Starts the TTC Origin server.
+Starts a TTC Origin server.
 
-**Configuration:**
+**Config options:**
 
-| 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 |
+- `name` (string) – Service name
+- `modules` (any[]) – Array of classes decorated with `@ttc.describe`
+- `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 working directory
+- `description` (string) – Optional description
 
 ### 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`)
+- `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`)
 
-## Example Module
+## Decorator Usage
 
-```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;
-  }
-}
-```
+Refer to the [`ttc-rpc` npm package](https://www.npmjs.com/package/ttc-rpc) for full documentation on the `@ttc.describe` decorator and its options.
 
 ## 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

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+import express from 'express';
+export declare const runServer: (config: {
+    name: string;
+    description?: string;
+    modules: any[];
+    port: number;
+    requireAuth?: boolean;
+    modifyable?: boolean;
+    authCb: (req: any) => Promise<boolean>;
+    app?: express.Express;
+}) => void;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,SAAS,CAAC;AAI9B,eAAO,MAAM,SAAS,GAAI,QAAQ;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,GAAG,EAAE,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,MAAM,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IACvC,GAAG,CAAC,EAAE,OAAO,CAAC,OAAO,CAAA;CACxB,SAkDA,CAAA"}

package/dist/index.js

@@ -0,0 +1,57 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runServer = void 0;
+const ttc_rpc_1 = require("ttc-rpc");
+const express_1 = __importDefault(require("express"));
+const runServer = (config) => {
+    const { modules, port, app } = config;
+    const appInstance = app || (0, express_1.default)();
+    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;
+        console.log(`${assistant} is accessing the RPC definitions..`);
+        const info = (0, ttc_rpc_1.generateRPCMethodsInfo)();
+        const finalFunctions = [];
+        Object.keys(info).forEach((module) => {
+            const functions = info[module]?.map((func) => {
+                return {
+                    ...func,
+                    name: `${config.name}.${module}.${func.name}`
+                };
+            }) || [];
+            finalFunctions.push(...functions);
+        });
+        console.log(JSON.stringify(finalFunctions, null, 2));
+        res.json({
+            functions: finalFunctions
+        });
+    });
+    ttc_rpc_1.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);
+};
+exports.runServer = runServer;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,qCAA0E;AAC1E,sDAA8B;AAIvB,MAAM,SAAS,GAAG,CAAC,MASzB,EAAE,EAAE;IACD,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC;IACtC,MAAM,WAAW,GAAG,GAAG,IAAI,IAAA,iBAAO,GAAE,CAAC;IAErC,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC;IAE7D,iCAAiC;IACjC,+DAA+D;IAC/D,WAAW,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;QACtC,GAAG,CAAC,IAAI,CAAC;YACL,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,WAAW,EAAE,MAAM,CAAC,WAAW,IAAI,EAAE;YACrC,WAAW,EAAE,MAAM,CAAC,WAAW;YAC/B,SAAS,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,SAAS;SAC3D,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,WAAW,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;QAC3C,MAAM,WAAW,GAAG,GAAG,CAAC,KAAK,CAAC;QAC9B,MAAM,SAAS,GAAG,WAAW,CAAC,SAA+B,CAAC;QAC9D,OAAO,CAAC,GAAG,CAAC,GAAG,SAAS,qCAAqC,CAAC,CAAC;QAC/D,MAAM,IAAI,GAAoC,IAAA,gCAAsB,GAAE,CAAC;QACvE,MAAM,cAAc,GAAoB,EAAE,CAAC;QAC3C,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,MAAc,EAAE,EAAE;YACzC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,CAAC,IAAmB,EAAE,EAAE;gBACxD,OAAO;oBACH,GAAG,IAAI;oBACP,IAAI,EAAE,GAAG,MAAM,CAAC,IAAI,IAAI,MAAM,IAAI,IAAI,CAAC,IAAI,EAAE;iBAChD,CAAA;YACL,CAAC,CAAC,IAAI,EAAE,CAAC;YACT,cAAc,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,CAAC;QACtC,CAAC,CAAC,CAAC;QACH,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QACrD,GAAG,CAAC,IAAI,CAAC;YACL,SAAS,EAAE,cAAc;SAC5B,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,aAAG,CAAC,IAAI,CAAC;QACL,GAAG,EAAE,WAAW;QAChB,OAAO,EAAE,OAAO;QAChB,eAAe,EAAE,KAAK;QACtB,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;YAClB,8DAA8D;YAC9D,IAAG,MAAM,CAAC,MAAM,EAAC,CAAC;gBACd,OAAO,MAAM,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACpC,CAAC;QACL,CAAC;QACD,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,GAAG,CAAC;KAClC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;AACpB,CAAC,CAAA;AA3DY,QAAA,SAAS,aA2DrB"}

package/dist/test.d.ts

@@ -0,0 +1,4 @@
+export declare class HelloWorldModule {
+    hello(name: string): string;
+}
+//# sourceMappingURL=test.d.ts.map

package/dist/test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test.d.ts","sourceRoot":"","sources":["../src/test.ts"],"names":[],"mappings":"AAKA,qBAAa,gBAAgB;IAYzB,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;CAG9B"}

package/dist/test.js

@@ -0,0 +1,38 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HelloWorldModule = void 0;
+const ttc_rpc_1 = require("ttc-rpc");
+const zod_1 = __importDefault(require("zod"));
+class HelloWorldModule {
+    hello(name) {
+        return `Hello, ${name}!`;
+    }
+}
+exports.HelloWorldModule = HelloWorldModule;
+__decorate([
+    ttc_rpc_1.ttc.describe({
+        doc: 'some info',
+        inputSchema: zod_1.default.object({
+            name: zod_1.default.string()
+        }),
+        outputSchema: zod_1.default.string(),
+        validate: true,
+        auth: true
+    }),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String]),
+    __metadata("design:returntype", String)
+], HelloWorldModule.prototype, "hello", null);
+//# sourceMappingURL=test.js.map

package/dist/test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test.js","sourceRoot":"","sources":["../src/test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,qCAA8B;AAC9B,8CAAoB;AAIpB,MAAa,gBAAgB;IAYzB,KAAK,CAAC,IAAY;QACd,OAAO,UAAU,IAAI,GAAG,CAAC;IAC7B,CAAC;CACJ;AAfD,4CAeC;AAHG;IATC,aAAG,CAAC,QAAQ,CAAC;QACV,GAAG,EAAE,WAAW;QAChB,WAAW,EAAE,aAAC,CAAC,MAAM,CAAC;YAClB,IAAI,EAAE,aAAC,CAAC,MAAM,EAAE;SACnB,CAAC;QACF,YAAY,EAAE,aAAC,CAAC,MAAM,EAAE;QACxB,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,IAAI;KACb,CAAC;;;;6CAGD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ttc-origin-server",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "A lightweight server for TTC Origins - run RPC services with decorator-based endpoints",
   "main": "dist/index.js",
   "module": "src/index.ts",

package/src/test.ts

@@ -0,0 +1,21 @@
+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}!`;
+    }
+}