@seam-rpc/server 5.0.2 → 5.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seam-rpc/server",
-  "version": "5.0.2",
+  "version": "5.1.0",
   "main": "dist/index.js",
   "type": "module",
   "types": "dist/index.d.ts",

package/dist/bin/generate.d.ts

@@ -1,12 +0,0 @@
-export declare function generateClient(): Promise<void>;
-interface GenerateOptions {
-    tsPath: string;
-    jsPath: string;
-    outputPath: string;
-}
-export declare function getProcedureMetadata(filePath: string): Record<string, {
-    comment: string;
-    returnType?: string;
-}>;
-export declare function generateClientFile({ tsPath, jsPath, outputPath, }: GenerateOptions): Promise<string>;
-export {};

package/dist/bin/generate.js

@@ -1,208 +0,0 @@
-import fs from "fs";
-import path from "path";
-import fg from "fast-glob";
-import ts from "typescript";
-import { zodToTs, createAuxiliaryTypeStore, printNode } from "zod-to-ts";
-import { existsSync, writeFileSync } from "fs";
-export async function generateClient() {
-    const config = loadConfig();
-    if (!config)
-        return;
-    const sourceFiles = await fg(config.source);
-    const compiledFolder = path.resolve(config.compiledFolder);
-    const outputPath = path.resolve(config.outputFolder);
-    const rootPath = path.resolve(".");
-    function removeRootPath(path) {
-        return "." + path.slice(rootPath.length);
-    }
-    // try {
-    const outputFiles = [];
-    for (let i = 0; i < sourceFiles.length; i++) {
-        gen(sourceFiles[i], outputPath);
-        // const sourceFile = sourceFiles[i];
-        // const path = await generateClientFile({ tsPath: sourceFile, jsPath: compiledFolder, outputPath });
-        // const symb = i < sourceFiles.length - 1 ? " ├╴" : " └╴";
-        // outputFiles.push(symb + removeRootPath(path));
-    }
-    console.log("\x1b[32m\x1b[1m%s\x1b[0m\n\x1b[94m%s\x1b[0m", `✅ Successfully generated client files at ${config.outputFolder}`, `${outputFiles.join("\n")}`);
-    // } catch (err: any) {
-    //     console.error("❌ Failed to generate client file:", err.message + "\n\n", err.stack);
-    //     process.exit(1);
-    // }
-}
-function loadConfig() {
-    // Check if config exists
-    if (!fs.existsSync("./seam-rpc.config.json")) {
-        console.error("\x1b[31mNo config file found.\x1b[0m\n Create a config file with \x1b[36msrpc init\x1b[0m.");
-        return null;
-    }
-    // Load config from config file
-    return JSON.parse(fs.readFileSync("./seam-rpc.config.json", "utf-8"));
-}
-// Extracts comments from TS file.
-export function getProcedureMetadata(filePath) {
-    const sourceText = fs.readFileSync(filePath, "utf8");
-    const program = ts.createProgram([filePath], {
-        target: ts.ScriptTarget.Latest,
-        module: ts.ModuleKind.CommonJS,
-        strict: true,
-    });
-    const checker = program.getTypeChecker();
-    const sourceFile = program.getSourceFile(filePath);
-    if (!sourceFile)
-        return {};
-    const metadata = {};
-    function getHandlerReturnType(node) {
-        let current = node;
-        while (current) {
-            if (ts.isCallExpression(current) &&
-                ts.isPropertyAccessExpression(current.expression)) {
-                const prop = current.expression;
-                if (prop.name.text === "handler") {
-                    const handlerFn = current.arguments[0];
-                    if (handlerFn &&
-                        (ts.isArrowFunction(handlerFn) ||
-                            ts.isFunctionExpression(handlerFn))) {
-                        const signature = checker.getSignatureFromDeclaration(handlerFn);
-                        if (!signature)
-                            return;
-                        const returnType = checker.getReturnTypeOfSignature(signature);
-                        return checker.typeToString(returnType, undefined, ts.TypeFormatFlags.NoTruncation);
-                    }
-                }
-                current = prop.expression;
-                continue;
-            }
-            break;
-        }
-        return;
-    }
-    function visit(node) {
-        if (ts.isVariableStatement(node)) {
-            const comment = getFullComment(node, sourceText);
-            for (const decl of node.declarationList.declarations) {
-                if (!ts.isIdentifier(decl.name))
-                    continue;
-                const name = decl.name.text;
-                let returnType;
-                if (decl.initializer) {
-                    returnType = getHandlerReturnType(decl.initializer);
-                }
-                metadata[name] = {
-                    comment,
-                    returnType,
-                };
-            }
-        }
-        ts.forEachChild(node, visit);
-    }
-    visit(sourceFile);
-    return metadata;
-}
-function getFullComment(node, sourceText) {
-    const ranges = ts.getLeadingCommentRanges(sourceText, node.pos);
-    if (!ranges)
-        return "";
-    for (const range of ranges) {
-        const comment = sourceText.slice(range.pos, range.end);
-        // Only keep JSDoc-style comments
-        if (comment.startsWith("/**")) {
-            return comment;
-        }
-    }
-    return "";
-}
-function convert(schema) {
-    const store = createAuxiliaryTypeStore();
-    const { node } = zodToTs(schema, { auxiliaryTypeStore: store });
-    return printNode(node);
-}
-function gen(src, outputPath) {
-    const options = {
-        declaration: true,
-        emitDeclarationOnly: true,
-        outDir: outputPath,
-        target: ts.ScriptTarget.ES2020,
-        module: ts.ModuleKind.NodeNext,
-        strict: true,
-    };
-    const host = ts.createCompilerHost(options);
-    const file = path.resolve(process.cwd(), src);
-    const program = ts.createProgram([file], options, host);
-    console.log(file, outputPath);
-    const emitResult = program.emit();
-    const diagnostics = ts.getPreEmitDiagnostics(program)
-        .concat(emitResult.diagnostics);
-    for (const d of diagnostics) {
-        console.log(ts.flattenDiagnosticMessageText(d.messageText, "\n"));
-    }
-}
-export async function generateClientFile({ tsPath, jsPath, outputPath, }) {
-    const tsFile = path.resolve(process.cwd(), tsPath);
-    const tsFileName = path.basename(tsFile).slice(0, -path.extname(tsFile).length);
-    const routerName = tsFileName.slice(0, tsFileName.indexOf("."));
-    const jsFile = path.resolve(process.cwd(), path.join(jsPath, tsFileName + ".js"));
-    if (!existsSync(tsFile)) {
-        throw new Error(`TS file not found: ${tsFile}`);
-    }
-    if (!existsSync(jsFile)) {
-        throw new Error(`JS file not found: ${jsFile}`);
-    }
-    const mod = await import("file://" + jsFile);
-    const procedures = mod.default;
-    // const routerName = path.basename(jsFile, path.extname(jsFile));
-    const procMetadata = getProcedureMetadata(tsFile);
-    let output = `/**
- * +===================================+
- * |  File auto-generated by SeamRPC.  |
- * |        --- DO NOT EDIT ---        |
- * +===================================+
- */
-
-import { callApi, RpcError } from "@seam-rpc/client";
-
-`;
-    const functions = [];
-    for (const [name, proc] of Object.entries(procedures)) {
-        // Input
-        let inputType = "void";
-        let hasInput = false;
-        if (proc._def.input) {
-            try {
-                const fields = [];
-                for (const [key, schema] of Object.entries(proc._def.input)) {
-                    const isOptional = schema.isOptional?.() ?? false;
-                    const tsType = convert(schema);
-                    fields.push(`${key}${isOptional ? "?" : ""}: ${tsType}`);
-                }
-                if (fields.length > 0) {
-                    inputType = `{ ${fields.join("; ")} }`;
-                    hasInput = true;
-                }
-            }
-            catch (e) {
-                console.error(`Failed to process input of procedure "${name}".`);
-                process.exit(1);
-            }
-        }
-        // const dataType = proc._def.output ? convert(proc._def.output) : "void";
-        // const errors = Object.entries(proc._def.errors ?? {});
-        // const errorType = errors.map(e => `RpcError<"${e[0]}", ${convert(e[1] as any)}>`).join(" | ");
-        // const fullReturnType = `Promise<Result<${dataType}${errors.length > 0 ? `, ${errorType}` : ""}>>`;
-        const fullReturnType = procMetadata[name].returnType;
-        const params = hasInput ? `input: ${inputType}` : "";
-        const args = [`"${routerName}"`, `"${name}"`];
-        if (hasInput)
-            args.push("input");
-        const call = `callApi(${args.join(", ")})`;
-        const comment = procMetadata[name].comment ? procMetadata[name].comment + "\n" : "";
-        const func = `${comment}export function ${name}(${params}): ${fullReturnType} {
-    return ${call};
-}`;
-        functions.push(func);
-    }
-    output += functions.join("\n\n");
-    const outFile = path.join(outputPath, `${routerName}.ts`);
-    writeFileSync(outFile, output, "utf-8");
-    return outFile;
-}

package/dist/bin/index.d.ts

@@ -1,6 +0,0 @@
-#!/usr/bin/env node
-export interface SeamConfig {
-    source: string;
-    compiledFolder: string;
-    outputFolder: string;
-}

package/dist/bin/index.js

@@ -1,17 +0,0 @@
-#!/usr/bin/env node
-import { generateClient } from "./generate.js";
-import { initConfig } from "./init.js";
-main();
-function main() {
-    const args = process.argv;
-    switch (args[2]) {
-        case "generate":
-            generateClient();
-            break;
-        case "init":
-            initConfig();
-            break;
-        default:
-            console.log("Commands:\n- \x1b[36msrpc generate\x1b[0m - Generate client files as defined in the config.\n- \x1b[36msrpc init\x1b[0m - Create config file.");
-    }
-}

package/dist/bin/init.d.ts

@@ -1 +0,0 @@
-export declare function initConfig(): Promise<void>;

package/dist/bin/init.js

@@ -1,34 +0,0 @@
-import fs from "fs";
-import readline from "readline";
-export async function initConfig() {
-    let source = "./src/api/*";
-    let compiledFolder = "./dist/api";
-    let outputFolder = "../client/src/api";
-    if (fs.existsSync("./seam-rpc.config.json")) {
-        const rl = readline.createInterface({
-            input: process.stdin,
-            output: process.stdout,
-        });
-        rl.question("Config file already exists. Do you want to overwrite it? [Y/n] ", answer => {
-            if (answer && answer.toLowerCase() != "y" && answer.toLowerCase() != "yes") {
-                console.log("Operation canceled.");
-                process.exit(0);
-            }
-            rl.close();
-            createConfig();
-        });
-    }
-    else {
-        createConfig();
-    }
-    function createConfig() {
-        const config = { source, compiledFolder, outputFolder };
-        try {
-            fs.writeFileSync("./seam-rpc.config.json", JSON.stringify(config, null, 4), "utf-8");
-        }
-        catch (e) {
-            console.log("\x1b[31mFailed to create config file ./seam-rpc.config.json\x1b[0m\n" + e);
-        }
-        console.log(`\x1b[32mSuccessfully created config file ./seam-rpc.config.json\x1b[0m`);
-    }
-}

package/dist/index copy.d.ts

@@ -1,84 +0,0 @@
-import { Result, ApiError } from "@seam-rpc/core";
-import EventEmitter from "events";
-import express, { Express, NextFunction, Request, RequestHandler, Response } from "express";
-import * as z from "zod";
-export { ApiError as RpcError };
-export type { Result };
-export interface RouterDefinition {
-    [procName: string]: (...args: any[]) => Promise<any>;
-}
-type Simplify<T> = T extends File ? File : T extends object ? {
-    [K in keyof T]: Simplify<T[K]>;
-} : T;
-export interface SeamContext {
-    request: Request;
-    response: Response;
-    next: NextFunction;
-}
-export interface SeamErrorContext {
-    routerPath: string;
-    procedureName: string;
-    input?: Record<string, unknown> | null;
-    validatedInput?: Record<string, unknown> | null;
-    output?: unknown;
-    validatedOutput?: unknown;
-    request: Request;
-    response: Response;
-    next: NextFunction;
-}
-export interface SeamEvents {
-    apiError: [error: unknown, context: SeamErrorContext];
-    internalError: [error: unknown, context: SeamErrorContext];
-    inputValidationError: [error: unknown, context: SeamErrorContext];
-    outputValidationError: [error: unknown, context: SeamErrorContext];
-}
-type ProcedureHandler<Input extends ProcedureInput, Output extends ProcedureOutput, Errors extends ProcedureErrors> = (options: ProcedureOptions<Input, Errors>) => Result<z.infer<Output>, ApiError> | Promise<Result<z.infer<Output>, ApiError>>;
-interface ProcedureOptions<Input extends ProcedureInput, Errors extends ProcedureErrors> {
-    input: Simplify<ProcedureInputData<Input>>;
-    ctx: SeamContext;
-    error: RpcErrorFactory<Errors>;
-}
-type RpcErrorFactory<Errors extends ProcedureErrors> = <Code extends keyof Errors>(code: Code, ...args: z.infer<Errors[Code]> extends undefined ? [] : [data: z.infer<Errors[Code]>]) => void;
-type ProcedureInput = Record<string, z.ZodType>;
-type ProcedureOutput = z.ZodType;
-type ProcedureErrors = Record<string, z.ZodType>;
-type ProcedureBuilderList = Record<string, ProcedureBuilder<any, any, any>>;
-type ProcedureInputData<T extends ProcedureInput> = {
-    [K in keyof T]: z.infer<T[K]>;
-};
-interface SeamProcedure<Input extends ProcedureInput, Output extends ProcedureOutput, Errors extends ProcedureErrors> {
-    input?: Input;
-    output?: Output;
-    errors?: Errors;
-    handler?: ProcedureHandler<Input, Output, Errors>;
-}
-export type ProcedureBuilder<Input extends ProcedureInput, Output extends ProcedureOutput, Errors extends ProcedureErrors> = {
-    _def: SeamProcedure<Input, Output, Errors>;
-    input: <T extends ProcedureInput>(schema: T) => ProcedureBuilder<T, Output, Errors>;
-    output: <T extends ProcedureOutput>(schema: T) => ProcedureBuilder<Input, T, Errors>;
-    errors: <T extends ProcedureErrors>(errors: T) => ProcedureBuilder<Input, Output, T>;
-    handler: (handler: ProcedureHandler<Input, Output, Errors>) => ProcedureBuilder<Input, Output, Errors>;
-};
-export declare function createSeamSpace(app: Express, fileHandler?: RequestHandler): Promise<SeamSpace>;
-export declare function seamRouter(path: string, procedures: ProcedureBuilderList): SeamRouter;
-export declare function seamProcedure(): ProcedureBuilder<ProcedureInput, ProcedureOutput, ProcedureErrors>;
-export declare class SeamRouter extends EventEmitter<SeamEvents> {
-    private _procedures;
-    private _router;
-    constructor(path: string, procedures: ProcedureBuilderList);
-    get router(): express.Router;
-    private runMiddleware;
-    private validateInput;
-    private validateOutput;
-    private validateData;
-}
-export declare class SeamSpace extends EventEmitter<SeamEvents> {
-    private _app;
-    private _fileHandler;
-    private _jsonParser;
-    constructor(_app: Express, _fileHandler: RequestHandler);
-    createRouter(path: string, procedures?: ProcedureBuilderList): SeamRouter;
-    get app(): express.Express;
-    get jsonParser(): import("connect").NextHandleFunction;
-    get fileHandler(): express.RequestHandler<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>;
-}

package/dist/index copy.js

@@ -1,254 +0,0 @@
-import { extractFiles, injectFiles, ApiError } from "@seam-rpc/core";
-import EventEmitter from "events";
-import express, { Router } from "express";
-import FormData from "form-data";
-import * as z from "zod";
-export { ApiError as RpcError };
-;
-;
-const errorHandler = (code, ...args) => {
-    return new ApiError(code, args[0]);
-};
-export async function createSeamSpace(app, fileHandler) {
-    if (!fileHandler) {
-        let multer;
-        try {
-            multer = (await import("multer")).default;
-        }
-        catch {
-            throw new Error("Multer is required as default file handler. Install it or provide a custom fileHandler.");
-        }
-        const upload = multer();
-        fileHandler = upload.any();
-    }
-    return new SeamSpace(app, fileHandler);
-}
-export function seamRouter(path, procedures) {
-    return new SeamRouter(path, procedures);
-}
-export function seamProcedure() {
-    return createProcedureBuilder();
-}
-function createProcedureBuilder(definition = {}) {
-    return {
-        _def: definition,
-        input: schema => createProcedureBuilder({
-            ...definition,
-            input: schema,
-        }),
-        output: schema => createProcedureBuilder({
-            ...definition,
-            output: schema,
-        }),
-        errors: errors => createProcedureBuilder({
-            ...definition,
-            errors
-        }),
-        handler: handler => createProcedureBuilder({
-            ...definition,
-            handler
-        }),
-    };
-}
-export class SeamRouter extends EventEmitter {
-    constructor(path, procedures) {
-        super();
-        this._procedures = {};
-        this._router = Router();
-        for (const proc in procedures) {
-            this._procedures[proc] = procedures[proc]._def;
-        }
-        // seamSpace.app.use(path, this._router);
-        this._router.post("/:procName", async (req, res, next) => {
-            const procedure = this._procedures[req.params.procName];
-            if (!procedure || !procedure.handler)
-                return res.sendStatus(404);
-            let input;
-            let validatedInput = undefined;
-            let output = undefined;
-            let validatedOutput;
-            // Middleware
-            try {
-                input = await this.runMiddleware(req, res);
-            }
-            catch (err) {
-                console.error(err);
-                return res.status(415).send(String(err));
-            }
-            // Validate input
-            try {
-                validatedInput = this.validateInput(input, procedure.input);
-            }
-            catch (err) {
-                this.emit("inputValidationError", err, {
-                    routerPath: path,
-                    procedureName: req.params.procName,
-                    input,
-                    validatedInput,
-                    output,
-                    validatedOutput,
-                    request: req,
-                    response: res,
-                    next,
-                });
-                res.sendStatus(400);
-                return;
-            }
-            // Call procedure
-            const ctx = {
-                request: req,
-                response: res,
-                next,
-            };
-            function toResError(error) {
-                if (error instanceof ApiError)
-                    return { isApiError: true, error: error.toJSON() };
-                else
-                    return { isApiError: false };
-            }
-            try {
-                output = await procedure.handler({ input: validatedInput, ctx, error: errorHandler });
-            }
-            catch (error) {
-                this.emit("apiError", error, {
-                    routerPath: path,
-                    procedureName: req.params.procName,
-                    input,
-                    validatedInput,
-                    output,
-                    validatedOutput,
-                    request: req,
-                    response: res,
-                    next: () => { res.status(400).json(toResError(error)); return next(); },
-                });
-                return;
-            }
-            if (!output.ok) {
-                this.emit("apiError", output.error, {
-                    routerPath: path,
-                    procedureName: req.params.procName,
-                    input,
-                    validatedInput,
-                    output,
-                    validatedOutput,
-                    request: req,
-                    response: res,
-                    next: () => { res.status(400).json(toResError(output.error)); return next(); },
-                });
-                return;
-            }
-            // Validate output
-            try {
-                validatedOutput = this.validateOutput(output, z.object({ ok: z.literal(true), data: procedure.output }).or(z.object({ ok: z.literal(false), error: z.any() })));
-            }
-            catch (err) {
-                this.emit("outputValidationError", err, {
-                    routerPath: path,
-                    procedureName: req.params.procName,
-                    input,
-                    validatedInput,
-                    output,
-                    validatedOutput,
-                    request: req,
-                    response: res,
-                    next,
-                });
-                res.sendStatus(500);
-                return;
-            }
-            try {
-                const { json, files, paths } = extractFiles({ result: validatedOutput });
-                // Does not include file(s)
-                if (files.length === 0) {
-                    res.json(json);
-                    return;
-                }
-                // Includes file(s)
-                const form = new FormData();
-                form.append("json", JSON.stringify(json));
-                form.append("paths", JSON.stringify(paths));
-                for (let i = 0; i < files.length; i++) {
-                    const file = files[i];
-                    const buffer = Buffer.from(await file.arrayBuffer());
-                    form.append(`file-${i}`, buffer, {
-                        filename: file.name || `file-${i}`,
-                        contentType: file.type || "application/octet-stream",
-                    });
-                }
-                res.writeHead(200, form.getHeaders());
-                form.pipe(res);
-            }
-            catch (error) {
-                this.emit("internalError", error, {
-                    routerPath: path,
-                    procedureName: req.params.procName,
-                    input,
-                    validatedInput,
-                    output,
-                    validatedOutput,
-                    request: req,
-                    response: res,
-                    next: next,
-                });
-                res.sendStatus(500); //.send({ error: String(error) });
-            }
-        });
-    }
-    get router() {
-        return this._router;
-    }
-    async runMiddleware(req, res) {
-        const contentType = req.headers["content-type"] || "";
-        const runMiddleware = (middleware) => new Promise((resolve, reject) => middleware(req, res, err => (err ? reject(err) : resolve())));
-        // if (contentType.startsWith("application/json")) {
-        //     await runMiddleware(this.seamSpace.jsonParser);
-        // } else if (contentType.startsWith("multipart/form-data")) {
-        //     await runMiddleware(this.seamSpace.fileHandler);
-        // } else {
-        //     throw new Error("Unsupported content type.");
-        // }
-        if (contentType.startsWith("application/json"))
-            return req.body;
-        // multipart/form-data (already checked before)
-        let input = JSON.parse(req.body.json);
-        const paths = JSON.parse(req.body.paths);
-        const files = (req.files ?? []).map((file, index) => ({
-            path: paths[index],
-            file: new File([file.buffer], file.originalname, { type: file.mimetype }),
-        }));
-        injectFiles(input, files);
-        return input;
-    }
-    validateInput(input, inputSchema) {
-        return this.validateData(input, z.object(inputSchema));
-    }
-    validateOutput(output, procOutput) {
-        return this.validateData(output, procOutput);
-    }
-    validateData(data, schema) {
-        if (!schema) {
-            if (data)
-                throw new Error("Received data, but no data expected.");
-            return null;
-        }
-        if (!data)
-            throw new Error("No data was received, but data was expected.");
-        return schema.parse(data);
-    }
-}
-export class SeamSpace extends EventEmitter {
-    constructor(_app, _fileHandler) {
-        super();
-        this._app = _app;
-        this._fileHandler = _fileHandler;
-        this._jsonParser = express.json();
-    }
-    createRouter(path, procedures = {}) {
-        const router = new SeamRouter(path, procedures);
-        // router.addProcedures(procedures);
-        return router;
-    }
-    get app() { return this._app; }
-    get jsonParser() { return this._jsonParser; }
-    get fileHandler() { return this._fileHandler; }
-}