ts-procedures 5.3.0 → 5.4.1

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>
-}

package/src/implementations/http/hono-rpc/README.md

@@ -1,358 +0,0 @@
-# HonoRPCAppBuilder
-
-Hono integration for `ts-procedures` that creates type-safe RPC endpoints as POST routes. Works with Bun, Deno, Cloudflare Workers, and Node.js.
-
-## Installation
-
-```bash
-npm install ts-procedures hono
-```
-
-## Quick Start
-
-```typescript
-import { Hono } from 'hono'
-import { Procedures } from 'ts-procedures'
-import { HonoRPCAppBuilder, RPCConfig } from 'ts-procedures/hono-rpc'
-import { v } from 'suretype'
-
-// Define your context type
-type AppContext = { userId: string }
-
-// Create a procedure factory
-const RPC = Procedures<AppContext, RPCConfig>()
-
-// Define procedures
-RPC.Create(
-  'GetUser',
-  {
-    scope: ['users', 'profile'],
-    version: 1,
-    schema: {
-      params: v.object({ id: v.string() }),
-      returnType: v.object({ id: v.string(), name: v.string() }),
-    },
-  },
-  async (ctx, params) => {
-    return { id: params.id, name: 'John Doe' }
-  }
-)
-
-// Build the Hono app
-const builder = new HonoRPCAppBuilder({ pathPrefix: '/rpc' }).register(RPC, (c) => ({
-  userId: c.req.header('x-user-id') || 'anonymous',
-}))
-
-const app = builder.build()
-
-// Bun
-export default app
-
-// Node.js
-// import { serve } from '@hono/node-server'
-// serve(app)
-
-// POST /rpc/users/profile/get-user/1 → { id: "123", name: "John Doe" }
-```
-
-## Configuration
-
-```typescript
-type HonoRPCAppBuilderConfig = {
-  app?: Hono // Existing Hono app (optional)
-  pathPrefix?: string // Prefix for all routes (e.g., '/rpc/v1')
-  onRequestStart?: (c: Context) => void
-  onRequestEnd?: (c: Context) => void
-  onSuccess?: (procedure: TProcedureRegistration, c: Context) => void
-  error?: (
-    procedure: TProcedureRegistration,
-    c: Context,
-    error: Error
-  ) => Response | Promise<Response>
-}
-```
-
-| Option           | Type                         | Description                                       |
-| ---------------- | ---------------------------- | ------------------------------------------------- |
-| `app`            | `Hono`                       | Use existing Hono app instead of creating new one |
-| `pathPrefix`     | `string`                     | Prefix all routes (e.g., `/rpc/v1`)               |
-| `onRequestStart` | `(c) => void`                | Called at start of each request                   |
-| `onRequestEnd`   | `(c) => void`                | Called after handler completes                    |
-| `onSuccess`      | `(proc, c) => void`          | Called on successful handler execution            |
-| `error`          | `(proc, c, err) => Response` | Custom error handler (must return Response)       |
-
-## Context Resolution
-
-The context resolver receives the Hono `Context` object:
-
-```typescript
-builder.register(RPC, (c: Context) => ({
-  userId: c.req.header('x-user-id') || 'anonymous',
-  userAgent: c.req.header('user-agent'),
-  ip: c.req.raw.headers.get('cf-connecting-ip'), // Cloudflare
-}))
-
-// Async context resolution
-builder.register(RPC, async (c) => {
-  const token = c.req.header('authorization')?.replace('Bearer ', '')
-  const user = await verifyToken(token)
-  return { userId: user.id, roles: user.roles }
-})
-```
-
-## Extending Procedure Documentation
-
-The `register` method accepts an optional third parameter `extendProcedureDoc` that allows you to add custom fields to each procedure's documentation. This is useful for adding metadata like descriptions, tags, or custom fields for API documentation generators.
-
-```typescript
-// Example of a factory extending the procedure config:
-type ExtendedRPCConfig = {
-  description: string
-  tags: string[]
-}
-
-builder.register(RPC, (c) => ({ userId: c.req.header('x-user-id') || 'anonymous' }), {
-  extendProcedureDoc: ({ base, procedure }, { base: RPCHttpRouteDoc, procedure }) =>
-    ({
-      description: `Procedure: ${procedure.name}`,
-      tags: Array.isArray(procedure.config.scope)
-        ? procedure.config.scope
-        : [procedure.config.scope],
-    }),
-})
-
-// Access extended docs after build()
-const app = builder.build()
-console.log(builder.docs) // Each doc now includes description and tags
-```
-
-The `extendProcedureDoc` callback receives:
-
-| Parameter   | Type                     | Description                                                                                |
-| ----------- | ------------------------ | ------------------------------------------------------------------------------------------ |
-| `base`      | `RPCHttpRouteDoc`        | The base documentation with `name`, `path`, `method`, `scope`, `version`, and `jsonSchema` |
-| `procedure` | `TProcedureRegistration` | The full procedure registration including `name`, `config`, and `handler`                  |
-
-This allows you to derive documentation fields from procedure config or add static metadata per factory registration.
-
-## Abort Signal
-
-`HonoRPCAppBuilder` automatically injects the HTTP request's `AbortSignal` (`c.req.raw.signal`) into the handler context. When a client disconnects mid-request, `ctx.signal` aborts, cancelling any signal-aware operations:
-
-```typescript
-RPC.Create(
-  'SlowQuery',
-  { scope: 'data', version: 1 },
-  async (ctx, params) => {
-    // Automatically cancelled if client disconnects
-    const response = await fetch('https://slow-api.example.com/data', {
-      signal: ctx.signal,
-    })
-    return response.json()
-  }
-)
-```
-
-To use `ctx.signal` with type safety, include `signal: AbortSignal` in your context type:
-
-```typescript
-type AppContext = { userId: string; signal: AbortSignal }
-const RPC = Procedures<AppContext, RPCConfig>()
-```
-
-## Error Handling
-
-Custom error handler receives the procedure, context, and error. **Must return a Response:**
-
-```typescript
-const builder = new HonoRPCAppBuilder({
-  onError: (procedure, c, error) => {
-    console.error(`Error in ${procedure.name}:`, error)
-
-    if (error instanceof ValidationError) {
-      return c.json({ error: error.message, code: 'VALIDATION_ERROR' }, 400)
-    }
-
-    if (error instanceof AuthError) {
-      return c.json({ error: 'Unauthorized', code: 'AUTH_ERROR' }, 401)
-    }
-
-    return c.json({ error: 'Internal server error' }, 500)
-  },
-})
-```
-
-**Default error handling:** Returns `{ error: message }` with status 500.
-
-## Using Existing Hono App
-
-You can add RPC routes to an existing Hono application:
-
-```typescript
-const app = new Hono()
-
-// Add custom middleware and routes
-app.use('*', cors())
-app.get('/custom', (c) => c.json({ custom: true }))
-
-const builder = new HonoRPCAppBuilder({ app }).register(RPC, contextResolver)
-
-builder.build() // Adds RPC routes to existing app
-```
-
-## Runtime Compatibility
-
-HonoRPCAppBuilder works across all Hono-supported runtimes:
-
-### Bun
-
-```typescript
-const app = builder.build()
-export default app
-```
-
-### Node.js
-
-```typescript
-import { serve } from '@hono/node-server'
-
-const app = builder.build()
-serve(app)
-```
-
-### Deno
-
-```typescript
-import { serve } from 'https://deno.land/std/http/server.ts'
-
-const app = builder.build()
-serve(app.fetch)
-```
-
-### Cloudflare Workers
-
-```typescript
-const app = builder.build()
-export default app
-```
-
-## API Reference
-
-### Constructor
-
-```typescript
-new HonoRPCAppBuilder(config?: HonoRPCAppBuilderConfig)
-```
-
-### Methods
-
-| Method                 | Signature                                         | Description                                                        |
-| ---------------------- | ------------------------------------------------- | ------------------------------------------------------------------ |
-| `register`             | `register<T>(factory, context, options?): this`   | Register procedure factory with context and optional doc extension |
-| `build`                | `build(): Hono`                                   | Build routes and return app                                        |
-| `makeRPCHttpRoutePath` | `makeRPCHttpRoutePath(config: RPCConfig): string` | Generate route path                                                |
-
-### Static Methods
-
-| Method                 | Signature                                                 | Description                            |
-| ---------------------- | --------------------------------------------------------- | -------------------------------------- |
-| `makeRPCHttpRoutePath` | `static makeRPCHttpRoutePath({ config, prefix }): string` | Generate route path with custom prefix |
-
-### Properties
-
-| Property | Type                      | Description                           |
-| -------- | ------------------------- | ------------------------------------- |
-| `app`    | `Hono`                    | The Hono application instance         |
-| `docs`   | `RPCHttpRouteDoc[]`       | Route documentation (after `build()`) |
-| `config` | `HonoRPCAppBuilderConfig` | The configuration object              |
-
-## TypeScript Types
-
-```typescript
-import {
-  HonoRPCAppBuilder,
-  HonoRPCAppBuilderConfig,
-  RPCConfig,
-  RPCHttpRouteDoc,
-} from 'ts-procedures/hono-rpc'
-```
-
-## Full Example
-
-```typescript
-import { Hono, Context } from 'hono'
-import { Procedures } from 'ts-procedures'
-import { HonoRPCAppBuilder, RPCConfig } from 'ts-procedures/hono-rpc'
-import { v } from 'suretype'
-
-// Context types
-type PublicContext = { source: 'public' }
-type AuthContext = { source: 'auth'; userId: string }
-
-// Create factories
-const PublicRPC = Procedures<PublicContext, RPCConfig>()
-const AuthRPC = Procedures<AuthContext, RPCConfig>()
-
-// Public procedures
-PublicRPC.Create('HealthCheck', { scope: 'health', version: 1 }, async () => ({
-  status: 'ok',
-}))
-
-PublicRPC.Create('GetVersion', { scope: ['system', 'version'], version: 1 }, async () => ({
-  version: '1.0.0',
-}))
-
-// Authenticated procedures
-AuthRPC.Create(
-  'GetProfile',
-  {
-    scope: ['users', 'profile'],
-    version: 1,
-    schema: { returnType: v.object({ userId: v.string() }) },
-  },
-  async (ctx) => ({ userId: ctx.userId })
-)
-
-AuthRPC.Create(
-  'UpdateProfile',
-  {
-    scope: ['users', 'profile'],
-    version: 2,
-    schema: { params: v.object({ name: v.string() }) },
-  },
-  async (ctx, params) => ({ userId: ctx.userId, name: params.name })
-)
-
-// Build app
-const builder = new HonoRPCAppBuilder({
-  pathPrefix: '/rpc',
-  onRequestStart: (c) => console.log(`→ ${c.req.method} ${c.req.path}`),
-  onRequestEnd: (c) => console.log(`← completed`),
-  onSuccess: (proc) => console.log(`✓ ${proc.name}`),
-  onError: (proc, c, err) => {
-    console.error(`✗ ${proc.name}:`, err.message)
-    return c.json({ error: err.message }, 500)
-  },
-})
-
-builder
-  .register(PublicRPC, () => ({ source: 'public' as const }))
-  .register(AuthRPC, (c) => ({
-    source: 'auth' as const,
-    userId: c.req.header('x-user-id') || 'anonymous',
-  }))
-
-const app = builder.build()
-
-// Generated routes:
-// POST /rpc/health/1
-// POST /rpc/system/version/get-version/1
-// POST /rpc/users/profile/get-user/1
-// POST /rpc/users/profile/get-user/2
-
-console.log(
-  'Routes:',
-  builder.docs.map((d) => d.path)
-)
-export default app
-```