ts-procedures 5.9.1 → 5.10.0

package/src/implementations/http/doc-registry.ts

@@ -0,0 +1,143 @@
+import type {
+  AnyHttpRouteDoc,
+  DocEnvelope,
+  DocRegistryConfig,
+  DocRegistryOutputOptions,
+  DocSource,
+  ErrorDoc,
+  HeaderDoc,
+} from '../types.js'
+
+export type {
+  AnyHttpRouteDoc,
+  DocEnvelope,
+  DocRegistryConfig,
+  DocRegistryOutputOptions,
+  DocSource,
+  ErrorDoc,
+  HeaderDoc,
+} from '../types.js'
+
+export class DocRegistry {
+  private readonly basePath: string
+  private readonly headers: HeaderDoc[]
+  private readonly errors: ErrorDoc[]
+  private readonly sources: DocSource<AnyHttpRouteDoc>[] = []
+
+  constructor(config?: DocRegistryConfig) {
+    this.basePath = config?.basePath ?? ''
+    this.headers = config?.headers ?? []
+    this.errors = config?.errors ?? []
+  }
+
+  from(source: DocSource<AnyHttpRouteDoc>): this {
+    this.sources.push(source)
+    return this
+  }
+
+  toJSON<T = DocEnvelope>(options?: DocRegistryOutputOptions<T>): T {
+    let routes = this.sources.flatMap((source) => source.docs)
+
+    if (options?.filter) {
+      routes = routes.filter(options.filter)
+    }
+
+    const envelope: DocEnvelope = {
+      basePath: this.basePath,
+      headers: [...this.headers],
+      errors: [...this.errors],
+      routes,
+    }
+
+    if (options?.transform) {
+      return options.transform(envelope)
+    }
+
+    return envelope as T
+  }
+
+  // Keep in sync with src/errors.ts
+  static defaultErrors(): ErrorDoc[] {
+    return [
+      {
+        name: 'ProcedureError',
+        statusCode: 500,
+        description: 'An error thrown from within a procedure handler via ctx.error().',
+        schema: {
+          type: 'object',
+          properties: {
+            name: { type: 'string', const: 'ProcedureError' },
+            procedureName: { type: 'string' },
+            message: { type: 'string' },
+            meta: { type: 'object' },
+          },
+          required: ['name', 'procedureName', 'message'],
+        },
+      },
+      {
+        name: 'ProcedureValidationError',
+        statusCode: 400,
+        description: 'Schema validation failed for the procedure input parameters.',
+        schema: {
+          type: 'object',
+          properties: {
+            name: { type: 'string', const: 'ProcedureValidationError' },
+            procedureName: { type: 'string' },
+            message: { type: 'string' },
+            errors: {
+              type: 'array',
+              items: {
+                type: 'object',
+                properties: {
+                  instancePath: { type: 'string' },
+                  message: { type: 'string' },
+                },
+              },
+            },
+          },
+          required: ['name', 'procedureName', 'message'],
+        },
+      },
+      {
+        name: 'ProcedureYieldValidationError',
+        statusCode: 500,
+        description:
+          'Schema validation failed for a yielded value in a streaming procedure.',
+        schema: {
+          type: 'object',
+          properties: {
+            name: { type: 'string', const: 'ProcedureYieldValidationError' },
+            procedureName: { type: 'string' },
+            message: { type: 'string' },
+            errors: {
+              type: 'array',
+              items: {
+                type: 'object',
+                properties: {
+                  instancePath: { type: 'string' },
+                  message: { type: 'string' },
+                },
+              },
+            },
+          },
+          required: ['name', 'procedureName', 'message'],
+        },
+      },
+      {
+        name: 'ProcedureRegistrationError',
+        statusCode: 500,
+        description:
+          'An invalid schema or configuration was detected at procedure registration time.',
+        schema: {
+          type: 'object',
+          properties: {
+            name: { type: 'string', const: 'ProcedureRegistrationError' },
+            procedureName: { type: 'string' },
+            message: { type: 'string' },
+          },
+          required: ['name', 'procedureName', 'message'],
+        },
+      },
+    ]
+  }
+}

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

@@ -14,7 +14,7 @@ npm install ts-procedures express
 import express from 'express'
 import { Procedures } from 'ts-procedures'
 import { ExpressRPCAppBuilder, RPCConfig } from 'ts-procedures/express-rpc'
-import { v } from 'suretype'
+import { Type } from 'typebox'
 
 // Define your context type
 type AppContext = { userId: string }
@@ -29,8 +29,8 @@ RPC.Create(
     scope: ['users', 'profile'],
     version: 1,
     schema: {
-      params: v.object({ id: v.string() }),
-      returnType: v.object({ id: v.string(), name: v.string() })
+      params: Type.Object({ id: Type.String() }),
+      returnType: Type.Object({ id: Type.String(), name: Type.String() })
     }
   },
   async (ctx, params) => {
@@ -209,7 +209,7 @@ import {
 import express from 'express'
 import { Procedures } from 'ts-procedures'
 import { ExpressRPCAppBuilder, RPCConfig } from 'ts-procedures/express-rpc'
-import { v } from 'suretype'
+import { Type } from 'typebox'
 
 // Context types
 type PublicContext = { source: 'public' }
@@ -234,7 +234,7 @@ AuthRPC.Create(
   {
     scope: ['users', 'profile'],
     version: 1,
-    schema: { returnType: v.object({ userId: v.string() }) }
+    schema: { returnType: Type.Object({ userId: Type.String() }) }
   },
   async (ctx) => ({ userId: ctx.userId })
 )
@@ -244,7 +244,7 @@ AuthRPC.Create(
   {
     scope: ['users', 'profile'],
     version: 2,
-    schema: { params: v.object({ name: v.string() }) }
+    schema: { params: Type.Object({ name: Type.String() }) }
   },
   async (ctx, params) => ({ userId: ctx.userId, name: params.name })
 )