ts-procedures 5.4.0 → 5.5.0

package/src/implementations/http/express-rpc/index.ts

@@ -1,265 +0,0 @@
-import express from 'express'
-import { kebabCase } from 'es-toolkit/string'
-import { Procedures, TProcedureRegistration } from '../../../index.js'
-import {
-  ExtractConfig,
-  ExtractContext,
-  ProceduresFactory,
-  RPCConfig,
-  RPCHttpRouteDoc,
-} from '../../types.js'
-import { castArray } from 'es-toolkit/compat'
-import { ExpressFactoryItem } from './types.js'
-
-export type { RPCConfig, RPCHttpRouteDoc }
-
-export type ExpressRPCAppBuilderConfig = {
-  /**
-   * An existing Express application instance to use.
-   * When provided, ensure to set up necessary middleware (e.g., json/body parser) beforehand.
-   * If not provided, a new instance will be created.
-   */
-  app?: express.Express
-  /** Optional path prefix for all RPC routes. */
-  pathPrefix?: string
-  onRequestStart?: (req: express.Request) => void
-  onRequestEnd?: (req: express.Request, res: express.Response) => void
-  onSuccess?: (
-    procedure: TProcedureRegistration,
-    req: express.Request,
-    res: express.Response
-  ) => void
-  /**
-   * Error handler called when a procedure throws an error.
-   * @param procedure
-   * @param req
-   * @param res
-   * @param error
-   */
-  onError?: (
-    procedure: TProcedureRegistration,
-    req: express.Request,
-    res: express.Response,
-    error: Error
-  ) => void
-}
-
-/**
- * Builder class for creating an Express application with RPC routes.
- *
- * Usage:
- *   const PublicRPC = Procedures<PublicRPCContext, RPCConfig>()
- *   const ProtectedRPC = Procedures<ProtectedRPCContext, RPCConfig>()
- *
- *   const rpcApp = new ExpressRPCAppBuilder()
- *     .register(PublicRPC, (req): Promise<PublicRPCContext> => { /* context resolution logic * / })
- *     .register(ProtectedRPC, (req): Promise<ProtectedRPCContext> => { /* context resolution logic * / })
- *     .build();
- *
- *   const app = rpcApp.app; // Express application
- *   const docs = rpcApp.docs; // RPC route documentation
- */
-export class ExpressRPCAppBuilder {
-  /**
-   * Constructor for ExpressRPCAppBuilder.
-   *
-   * @param config
-   */
-  constructor(readonly config?: ExpressRPCAppBuilderConfig) {
-    if (config?.app) {
-      this._app = config.app
-    } else {
-      // Default middleware if no app is provided
-      this._app.use(express.json())
-    }
-
-    if (config?.onRequestStart) {
-      this._app.use((req, res, next) => {
-        config.onRequestStart!(req)
-        next()
-      })
-    }
-
-    if (config?.onRequestEnd) {
-      this._app.use((req, res, next) => {
-        res.on('finish', () => {
-          config.onRequestEnd!(req, res)
-        })
-        next()
-      })
-    }
-  }
-
-  /**
-   * Generates the RPC route path based on the RPC configuration.
-   * The RPCConfig name can be a string or an array of strings to form nested paths.
-   *
-   * Example
-   *  name: ['string', 'string-string', 'string']
-   *  path: /string/string-string/string/version
-   * @param config
-   */
-  static makeRPCHttpRoutePath({
-    name,
-    config,
-    prefix,
-  }: {
-    name: string
-    prefix?: string
-    config: RPCConfig
-  }) {
-    const normalizedPrefix = prefix ? (prefix.startsWith('/') ? prefix : `/${prefix}`) : ''
-
-    return `${normalizedPrefix}/${castArray(config.scope).map(kebabCase).join('/')}/${kebabCase(name)}/${String(config.version).trim()}`
-  }
-
-  /**
-   * Instance method wrapper for makeRPCHttpRoutePath that uses the builder's pathPrefix.
-   * @param config - The RPC configuration
-   */
-  makeRPCHttpRoutePath(name: string, config: RPCConfig): string {
-    return ExpressRPCAppBuilder.makeRPCHttpRoutePath({
-      name,
-      config,
-      prefix: this.config?.pathPrefix,
-    })
-  }
-
-  private factories: ExpressFactoryItem<any>[] = []
-
-  private _app: express.Express = express()
-  private _docs: (RPCHttpRouteDoc & object)[] = []
-
-  get app(): express.Express {
-    return this._app
-  }
-
-  get docs(): RPCHttpRouteDoc[] {
-    return this._docs
-  }
-
-  /**
-   * Registers a procedure factory with its context.
-   * @param factory - The procedure factory created by Procedures<Context, RPCConfig>()
-   * @param factoryContext - The context for procedure handlers. Can be a direct value,
-   *                         a sync function (req) => Context, or an async function (req) => Promise<Context>
-   * @param extendProcedureDoc - A custom function to extend the generated RPC route documentation for each procedure.
-   */
-  register<TFactory extends ProceduresFactory>(
-    factory: TFactory,
-    factoryContext:
-      | ExtractContext<TFactory>
-      | ((req: express.Request) => ExtractContext<TFactory> | Promise<ExtractContext<TFactory>>),
-    extendProcedureDoc?: (params: {
-      /* RPC App builder base http route doc */
-      base: RPCHttpRouteDoc
-      /* Procedure registration */
-      procedure: TProcedureRegistration<any, ExtractConfig<TFactory>>
-    }) => Record<string, any>
-  ): this {
-    this.factories.push({ factory, factoryContext, extendProcedureDoc } as ExpressFactoryItem<any>)
-    return this
-  }
-
-  /**
-   * Builds and returns the Express application with registered RPC routes.
-   * @return express.Application
-   */
-  build(): express.Application {
-    this.factories.forEach(({ factory, factoryContext, extendProcedureDoc }) => {
-      factory.getProcedures().map((procedure: TProcedureRegistration<any, RPCConfig>) => {
-        const route = this.buildRpcHttpRouteDoc(procedure, extendProcedureDoc)
-
-        this._docs.push(route)
-
-        this._app[route.method](route.path, async (req, res) => {
-          try {
-            const context =
-              typeof factoryContext === 'function'
-                ? await factoryContext(req)
-                : (factoryContext as ExtractContext<typeof factory>)
-
-            let ac: AbortController | undefined
-            const ctxWithSignal = Object.defineProperty({ ...context }, 'signal', {
-              get() {
-                if (!ac) {
-                  ac = new AbortController()
-                  req.on('close', () => { if (!res.writableFinished) ac!.abort() })
-                }
-                return ac.signal
-              },
-              enumerable: true,
-            })
-
-            res.json(await procedure.handler(ctxWithSignal, req.body))
-            if (this.config?.onSuccess) {
-              this.config.onSuccess(procedure, req, res)
-            }
-            // if status not set, set to 200
-            if (!res.status) {
-              res.status(200)
-            }
-          } catch (error) {
-            if (this.config?.onError) {
-              this.config.onError(procedure, req, res, error as Error)
-              return
-            }
-            if (!res.status) {
-              res.status(500)
-            }
-            // if no res.json set, set default error message
-            if (!res.headersSent) {
-              res.json({ error: (error as Error).message })
-            }
-          }
-        })
-      })
-    })
-
-    return this._app
-  }
-
-  /**
-   * Generates the RPC HTTP route for the given procedure.
-   * @param procedure
-   */
-  private buildRpcHttpRouteDoc(
-    procedure: TProcedureRegistration<any, RPCConfig>,
-    extendProcedureDoc: ExpressFactoryItem['extendProcedureDoc']
-  ): RPCHttpRouteDoc {
-    const { config } = procedure
-    const path = ExpressRPCAppBuilder.makeRPCHttpRoutePath({
-      name: procedure.name,
-      config,
-      prefix: this.config?.pathPrefix,
-    })
-    const method = 'post' as const // RPCs use POST method
-    const jsonSchema: { body?: Record<string, unknown>; response?: Record<string, unknown> } = {}
-
-    if (config.schema?.params) {
-      jsonSchema.body = config.schema.params
-    }
-    if (config.schema?.returnType) {
-      jsonSchema.response = config.schema.returnType
-    }
-
-    const base = {
-      name: procedure.name,
-      version: config.version,
-      scope: config.scope,
-      path,
-      method,
-      jsonSchema,
-    }
-    let extendedDoc: object = {}
-
-    if (extendProcedureDoc) {
-      extendedDoc = extendProcedureDoc({ base, procedure })
-    }
-
-    return {
-      ...extendedDoc,
-      ...base,
-    }
-  }
-}

package/src/implementations/http/express-rpc/types.ts

@@ -1,16 +0,0 @@
-import { ExtractConfig, ExtractContext, RPCConfig, RPCHttpRouteDoc } from '../../types.js'
-import { Procedures, TProcedureRegistration } from '../../../index.js'
-import express from 'express'
-
-export type ExpressFactoryItem<TFactory = ReturnType<typeof Procedures<any, RPCConfig>>> = {
-  factory: TFactory
-  factoryContext:
-    | ExtractContext<TFactory>
-    | ((req: express.Request) => ExtractContext<TFactory> | Promise<ExtractContext<TFactory>>)
-  extendProcedureDoc?: (params: {
-    /* RPC App builder base http route doc */
-    base: RPCHttpRouteDoc
-    /* Procedure registration */
-    procedure: TProcedureRegistration<any, ExtractConfig<TFactory>>
-  }) => Record<string, any>
-}