@seam-rpc/server 1.1.2 → 2.0.0

package/README.md

@@ -142,3 +142,19 @@ export async function updateUser(userId: string, userData: UserData): Promise<vo
 - The generated client files contain all imports from the api implementation file in the backend that import from the current relative folder (`./`). This is the simplest way I have to include imports (at least for now). It may import functions and unused symbols but that shouldn't be too worrying.
 - Don't include backend/server functions inside the server api files.
 - Only exported functions will be included in the client generated files.
+
+## Supported types
+SeamRPC supports the following types (at least for now):
+- string
+- number
+- boolean
+- array
+- object
+- null
+- undefined
+
+Classes are technically supported, in that the data is serialized to JSON.
+
+Other JavaScript types are not supported, although SeamRPC doesn't prevent you from using them, in which case they might lead to unexpected beahviour or even errors.
+
+The Date object type is not supported (at least for now). However, you can use `number` and pass `Date.now()` or `string` and pass `new Date().toString()`. This is not different than a normal HTTP request using JSON. SeamRPC also uses JSON behind the scenes, that's why there's these limitations, which could be overcome but I've decided not to because it would probably add more overhead to the logic.

package/dist/bin/gen-client.js

@@ -65,7 +65,8 @@ function generateClientFile(inputFile, outputPath) {
             const funcName = node.name.getText();
             const jsDoc = ts.getJSDocCommentsAndTags(node).map(e => e.getFullText()).filter(Boolean).join("\n");
             let signature = `${jsDoc}\nexport function ${funcName}(`;
-            const paramsText = node.parameters
+            const params = node.parameters.filter(p => !(p.type && p.type.getText() === "SeamContext"));
+            const paramsText = params
                 .map((p) => {
                 const paramName = p.name.getText();
                 const optional = p.questionToken ? "?" : "";
@@ -74,10 +75,7 @@ function generateClientFile(inputFile, outputPath) {
             })
                 .join(", ");
             const returnTypeText = node.type?.getText() ?? "any";
-            const finalReturnType = returnTypeText.startsWith("Promise<")
-                ? returnTypeText
-                : `Promise<${returnTypeText}>`;
-            signature += `${paramsText}): ${finalReturnType} { return callApi("${routerName}", "${funcName}", [${node.parameters.map(e => e.name.getText()).join(", ")}]); }`;
+            signature += `${paramsText}): ${returnTypeText} { return callApi("${routerName}", "${funcName}", [${params.map(e => e.name.getText()).join(", ")}]); }`;
             apiDef.push(signature);
         }
         else if ((ts.isInterfaceDeclaration(node) ||

package/dist/index.d.ts

@@ -1,10 +1,10 @@
 import { SeamFile, ISeamFile } from "@seam-rpc/core";
-import { Express, RequestHandler } from "express";
+import { Express, NextFunction, Request, RequestHandler, Response } from "express";
 export { SeamFile, ISeamFile };
 export interface RouterDefinition {
     [funcName: string]: (...args: any[]) => Promise<any>;
 }
-export declare function createSeamSpace(app: Express, fileHandler?: RequestHandler): SeamSpace;
+export declare function createSeamSpace(app: Express, fileHandler?: RequestHandler): Promise<SeamSpace>;
 export declare class SeamSpace {
     private app;
     private fileHandler;
@@ -12,3 +12,8 @@ export declare class SeamSpace {
     constructor(app: Express, fileHandler: RequestHandler);
     createRouter(path: string, routerDefinition: RouterDefinition): void;
 }
+export interface SeamContext {
+    request: Request;
+    response: Response;
+    next: NextFunction;
+}

package/dist/index.js

@@ -3,11 +3,11 @@ import express, { Router } from "express";
 import FormData from "form-data";
 export { SeamFile };
 ;
-export function createSeamSpace(app, fileHandler) {
+export async function createSeamSpace(app, fileHandler) {
     if (!fileHandler) {
         let multer;
         try {
-            multer = require("multer");
+            multer = (await import("multer")).default;
         }
         catch {
             throw new Error("Multer is required as default file handler. Install it or provide a custom fileHandler.");
@@ -55,7 +55,12 @@ export class SeamSpace {
             }
             let result;
             try {
-                result = await routerDefinition[req.params.funcName](...args);
+                const ctx = {
+                    request: req,
+                    response: res,
+                    next
+                };
+                result = await routerDefinition[req.params.funcName](...args, ctx);
             }
             catch (error) {
                 console.error(`Error at API function at router "${path}". Sent error to client.`, error);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seam-rpc/server",
-  "version": "1.1.2",
+  "version": "2.0.0",
   "main": "dist/index.js",
   "type": "module",
   "bin": {
@@ -28,6 +28,7 @@
   },
   "devDependencies": {
     "@types/express": "^5.0.3",
+    "@types/multer": "^2.0.0",
     "@types/node": "^24.3.1",
     "express": "^5.1.0",
     "multer": "^2.0.2"