ts-procedures 8.6.0 → 9.1.0

package/src/{implementations/http → adapters}/hono/types.ts

@@ -1,11 +1,14 @@
 import type { Context, Hono } from 'hono'
-import type { ErrorTaxonomy, UnknownErrorConfig } from '../error-taxonomy.js'
+import type { ErrorTaxonomy, UnknownErrorConfig } from '../../server/errors/taxonomy.js'
 import type {
-  AnyProcedureRegistration,
   OnRequestErrorObserver,
   OnMidStreamError,
   PreStreamOnError,
-} from '../error-dispatch.js'
+  PreStreamErrorConfig,
+  MidStreamErrorConfig,
+} from '../../server/errors/dispatch.js'
+import type { QueryParser } from '../../server/request/query.js'
+import type { FactoryContextInit } from '../../server/context.js'
 import type {
   ProceduresFactory,
   ExtractContext,
@@ -15,35 +18,31 @@ import type {
   APIHttpRouteDoc,
   StreamHttpRouteDoc,
   HttpStreamRouteDoc,
-} from '../../types.js'
+} from '../../server/types.js'
 import type {
+  AnyProcedureRegistration,
   TProcedureRegistration,
   TStreamProcedureRegistration,
   THttpProcedureRegistration,
   THttpStreamProcedureRegistration,
-} from '../../../types.js'
-
-export type { AnyProcedureRegistration } from '../error-dispatch.js'
+} from '../../core/types.js'
 
-/** Default query parser using URLSearchParams. */
-export type QueryParser = (queryString: string) => Record<string, unknown>
+export type { QueryParser } from '../../server/request/query.js'
 
 export type OnRequestErrorContext = {
   err: unknown
-  procedure: AnyProcedureRegistration
+  procedure: AnyProcedureRegistration<any, any>
   raw: Context
 }
 
 export type ExtendProcedureDoc = (params: {
   base: RPCHttpRouteDoc | APIHttpRouteDoc | StreamHttpRouteDoc | HttpStreamRouteDoc
-  procedure: AnyProcedureRegistration
+  procedure: AnyProcedureRegistration<any, any>
 }) => Record<string, unknown>
 
 export type HonoFactoryItem<TFactory extends ProceduresFactory = ProceduresFactory> = {
   factory: TFactory
-  factoryContext:
-    | ExtractContext<TFactory>
-    | ((c: Context) => ExtractContext<TFactory> | Promise<ExtractContext<TFactory>>)
+  factoryContext: FactoryContextInit<ExtractContext<TFactory>, Context>
   streamMode?: StreamMode
   extendProcedureDoc?: ExtendProcedureDoc
 }
@@ -57,9 +56,9 @@ export type HonoAppBuilderConfig<TStreamErrorData = unknown> = {
   // Error handling — peers
   errors?: ErrorTaxonomy
   unknownError?: UnknownErrorConfig
-  onError?: PreStreamOnError
+  onError?: PreStreamOnError<Context, Response>
   /** Cross-cutting observer — fires for every caught error before dispatch. */
-  onRequestError?: OnRequestErrorObserver
+  onRequestError?: OnRequestErrorObserver<Context>
 
   // Lifecycle (every kind)
   onRequestStart?: (c: Context) => void
@@ -67,7 +66,7 @@ export type HonoAppBuilderConfig<TStreamErrorData = unknown> = {
 
   // Kind-specific blocks
   rpc?: {
-    onSuccess?: (procedure: TProcedureRegistration, c: Context) => void
+    onSuccess?: (procedure: TProcedureRegistration<any, any>, c: Context) => void
   }
   api?: {
     queryParser?: QueryParser
@@ -77,17 +76,41 @@ export type HonoAppBuilderConfig<TStreamErrorData = unknown> = {
     /** Default for both rpc-stream and http-stream. */
     defaultStreamMode?: StreamMode
     onStreamStart?: (
-      procedure: TStreamProcedureRegistration | THttpStreamProcedureRegistration<any>,
+      procedure: TStreamProcedureRegistration<any, any> | THttpStreamProcedureRegistration<any>,
       c: Context,
       streamMode: StreamMode,
     ) => void
     onStreamEnd?: (
-      procedure: TStreamProcedureRegistration | THttpStreamProcedureRegistration<any>,
+      procedure: TStreamProcedureRegistration<any, any> | THttpStreamProcedureRegistration<any>,
       c: Context,
       streamMode: StreamMode,
     ) => void
-    onMidStreamError?: OnMidStreamError<TStreamErrorData>
+    onMidStreamError?: OnMidStreamError<TStreamErrorData, Context>
   }
 }
 
 export type DocAccumulator = AnyHttpRouteDoc[]
+
+/** The pre-stream slice of the builder config, passed to dispatch. */
+export function preStreamErrorConfig(
+  cfg: HonoAppBuilderConfig<any>,
+): PreStreamErrorConfig<Context, Response> {
+  return {
+    errors: cfg.errors,
+    unknownError: cfg.unknownError,
+    onError: cfg.onError,
+    onRequestError: cfg.onRequestError,
+  }
+}
+
+/** The mid-stream slice of the builder config, passed to dispatch. */
+export function midStreamErrorConfig<TStreamErrorData>(
+  cfg: HonoAppBuilderConfig<TStreamErrorData>,
+): MidStreamErrorConfig<TStreamErrorData, Context> {
+  return {
+    errors: cfg.errors,
+    unknownError: cfg.unknownError,
+    onMidStreamError: cfg.stream?.onMidStreamError,
+    onRequestError: cfg.onRequestError,
+  }
+}

package/src/client/freeze.test.ts

@@ -0,0 +1,41 @@
+import { createHash } from 'node:crypto'
+import { readFile } from 'node:fs/promises'
+import { dirname, resolve } from 'node:path'
+import { fileURLToPath } from 'node:url'
+import { describe, expect, it } from 'vitest'
+
+/**
+ * The client runtime is CONTENT-FROZEN for v9.
+ *
+ * Self-contained codegen (the default) bundles these source files verbatim
+ * (imports stripped) into the generated `_client.ts` / `_types.ts`. The v9
+ * hard requirement is byte-identical generated output vs v8.6.0, so these
+ * files must not change. If you intentionally change one, you are changing
+ * generated output for every downstream app: re-capture the codegen goldens,
+ * verify the diff is wanted, and update the hash here.
+ *
+ * Hashes recorded from v8.6.0 `src/client/*.ts`.
+ */
+const FROZEN_FILES: ReadonlyArray<readonly [file: string, sha256: string]> = [
+  ['errors.ts', 'abcdee64e22e748d870efdac68f03a05cd0666c65ec3f3b5217acd9c22f72a4d'],
+  ['classify-error.ts', '28062fdc3be39461eeec4cc96e3edcf46377922bac6fb3cc7b54111b42199773'],
+  ['error-dispatch.ts', '1bdd89319239e8aca0f186714c15b77ae5f4a9ac2c257416ddaf36d965dbe141'],
+  ['request-builder.ts', 'ac15485e6786de00386e6c4a425dbab503589bc012af6ef6515b1c3e4176a51e'],
+  ['resolve-options.ts', 'a0e6d745a630176696c0221f5166958bfc5255e50168e5f3cf021bbf4a8aaffc'],
+  ['hooks.ts', '15d67ba827dbb6e38407af606c05a459ec27e3b1e738aac868233d0f10478aa7'],
+  ['call.ts', 'b7afeadb3b338cb45ab09273a1729c25ea0f6429670664d197d91ee47cc0a3dc'],
+  ['stream.ts', '655af96f789150e3fedb7b345aae70d58b1d3b3cad9eb8b341d5a4780d5760ce'],
+  ['fetch-adapter.ts', 'c5a6ebdeecac3a5efc3d77f346135609e23c5eebc671a08456175901106655a2'],
+  ['index.ts', '8e33080aba85ba9af52f8b7232c01c82fae167742facb250f5d6800d51544d65'],
+  ['types.ts', 'e236213020290fd187a80cdf060fcb3d67e734e94aa060c736f142cbefd4ced7'],
+]
+
+const clientDir = dirname(fileURLToPath(import.meta.url))
+
+describe('client runtime freeze (codegen bundling contract)', () => {
+  it.each(FROZEN_FILES)('%s matches its v8.6.0 content hash', async (file, expected) => {
+    const content = await readFile(resolve(clientDir, file), 'utf-8')
+    const actual = createHash('sha256').update(content).digest('hex')
+    expect(actual, `${file} diverged from the frozen v8.6.0 content — this changes generated _client.ts/_types.ts output`).toBe(expected)
+  })
+})

package/src/client/typed-error-dispatch.test.ts

@@ -1,8 +1,8 @@
  
 import { describe, expect, test } from 'vitest'
 import { Type } from 'typebox'
-import { Procedures } from '../index.js'
-import { HonoAppBuilder, defineErrorTaxonomy } from '../implementations/http/hono/index.js'
+import { Procedures } from '../core/procedures.js'
+import { HonoAppBuilder, defineErrorTaxonomy } from '../adapters/hono/index.js'
 import { createClient } from './index.js'
 import { ClientRequestError } from './errors.js'
 import type { ClientAdapter, ErrorRegistry } from './types.js'
@@ -26,7 +26,7 @@ const appErrors = defineErrorTaxonomy({
   UseCaseError: {
     class: UseCaseError,
     statusCode: 422,
-    toResponse: (err) => ({ message: err.externalMsg }),
+    toResponse: (err: UseCaseError) => ({ message: err.externalMsg }),
   },
 })
 

package/src/codegen/__fixtures__/make-envelope.ts

@@ -5,7 +5,7 @@ import type {
   HeaderDoc,
   HttpMethod,
   RPCHttpRouteDoc,
-} from '../../implementations/types.js'
+} from '../../server/types.js'
 
 /**
  * Typed builders for codegen test envelopes.

package/src/codegen/__fixtures__/models-envelope.json

@@ -0,0 +1,310 @@
+{
+  "version": "1",
+  "basePath": "/api",
+  "headers": [],
+  "routes": [
+    {
+      "kind": "rpc",
+      "name": "GetOrder",
+      "version": 1,
+      "scope": "orders",
+      "path": "/orders/get-order/1",
+      "method": "post",
+      "jsonSchema": {
+        "body": {
+          "type": "object",
+          "properties": { "orderId": { "type": "string" } },
+          "required": ["orderId"]
+        },
+        "response": {
+          "$id": "Customer",
+          "title": "Customer",
+          "type": "object",
+          "properties": {
+            "id": { "type": "string" },
+            "name": { "type": "string" },
+            "balance": {
+              "$id": "Money",
+              "title": "Money",
+              "type": "object",
+              "properties": {
+                "amount": { "type": "integer" },
+                "currency": { "type": "string" }
+              },
+              "required": ["amount", "currency"]
+            }
+          },
+          "required": ["id", "name", "balance"]
+        }
+      },
+      "errors": ["OrderRejected", "RateLimited"]
+    },
+    {
+      "kind": "rpc",
+      "name": "SubmitOrder",
+      "version": 1,
+      "scope": "orders",
+      "path": "/orders/submit-order/1",
+      "method": "post",
+      "jsonSchema": {
+        "body": {
+          "type": "object",
+          "properties": {
+            "orderId": { "type": "string" },
+            "total": {
+              "$id": "Money",
+              "title": "Money",
+              "type": "object",
+              "properties": {
+                "amount": { "type": "integer" },
+                "currency": { "type": "string" }
+              },
+              "required": ["amount", "currency"]
+            }
+          },
+          "required": ["orderId", "total"]
+        },
+        "response": {
+          "type": "object",
+          "properties": { "ok": { "type": "boolean" } },
+          "required": ["ok"]
+        }
+      },
+      "errors": ["OrderRejected"]
+    },
+    {
+      "kind": "stream",
+      "name": "WatchOrders",
+      "version": 1,
+      "scope": "orders",
+      "path": "/orders/watch-orders/1",
+      "methods": ["post", "get"],
+      "streamMode": "sse",
+      "jsonSchema": {
+        "params": {
+          "type": "object",
+          "properties": { "orderId": { "type": "string" } },
+          "required": ["orderId"]
+        },
+        "yieldType": {
+          "type": "object",
+          "description": "SSE message envelope. The data field contains the procedure yield value.",
+          "required": ["data", "event", "id"],
+          "properties": {
+            "data": {
+              "$id": "OrderEvent",
+              "title": "OrderEvent",
+              "type": "object",
+              "properties": {
+                "orderId": { "type": "string" },
+                "status": { "type": "string", "enum": ["created", "paid", "shipped"] },
+                "total": {
+                  "$id": "Money",
+                  "title": "Money",
+                  "type": "object",
+                  "properties": {
+                    "amount": { "type": "integer" },
+                    "currency": { "type": "string" }
+                  },
+                  "required": ["amount", "currency"]
+                }
+              },
+              "required": ["orderId", "status", "total"]
+            },
+            "event": { "type": "string" },
+            "id": { "type": "string" },
+            "retry": { "type": "number" }
+          }
+        },
+        "returnType": {
+          "type": "object",
+          "properties": { "total": { "type": "integer" } },
+          "required": ["total"]
+        }
+      },
+      "errors": []
+    },
+    {
+      "kind": "api",
+      "name": "GetInvoice",
+      "scope": "billing",
+      "method": "GET",
+      "fullPath": "/billing/invoices/:id",
+      "jsonSchema": {
+        "req": {
+          "pathParams": {
+            "type": "object",
+            "properties": { "id": { "type": "string" } },
+            "required": ["id"]
+          }
+        },
+        "res": {
+          "body": {
+            "$id": "Invoice",
+            "title": "Invoice",
+            "type": "object",
+            "properties": {
+              "id": { "type": "string" },
+              "total": {
+                "$id": "Money",
+                "title": "Money",
+                "type": "object",
+                "properties": {
+                  "amount": { "type": "integer" },
+                  "currency": { "type": "string" }
+                },
+                "required": ["amount", "currency"]
+              },
+              "customer": {
+                "$id": "Customer",
+                "title": "Customer",
+                "type": "object",
+                "properties": {
+                  "id": { "type": "string" },
+                  "name": { "type": "string" },
+                  "balance": {
+                    "$id": "Money",
+                    "title": "Money",
+                    "type": "object",
+                    "properties": {
+                      "amount": { "type": "integer" },
+                      "currency": { "type": "string" }
+                    },
+                    "required": ["amount", "currency"]
+                  }
+                },
+                "required": ["id", "name", "balance"]
+              }
+            },
+            "required": ["id", "total", "customer"]
+          }
+        }
+      },
+      "errors": ["NotFound"]
+    },
+    {
+      "kind": "api",
+      "name": "ListInvoices",
+      "scope": "billing",
+      "method": "GET",
+      "fullPath": "/billing/invoices",
+      "jsonSchema": {
+        "req": {
+          "query": {
+            "type": "object",
+            "properties": {
+              "status": { "type": "string", "enum": ["open", "paid"] },
+              "limit": { "type": "integer" }
+            }
+          }
+        },
+        "res": {
+          "body": {
+            "type": "object",
+            "properties": {
+              "items": {
+                "type": "array",
+                "items": {
+                  "$id": "Invoice",
+                  "title": "Invoice",
+                  "type": "object",
+                  "properties": {
+                    "id": { "type": "string" },
+                    "total": {
+                      "$id": "Money",
+                      "title": "Money",
+                      "type": "object",
+                      "properties": {
+                        "amount": { "type": "integer" },
+                        "currency": { "type": "string" }
+                      },
+                      "required": ["amount", "currency"]
+                    },
+                    "customer": {
+                      "$id": "Customer",
+                      "title": "Customer",
+                      "type": "object",
+                      "properties": {
+                        "id": { "type": "string" },
+                        "name": { "type": "string" },
+                        "balance": {
+                          "$id": "Money",
+                          "title": "Money",
+                          "type": "object",
+                          "properties": {
+                            "amount": { "type": "integer" },
+                            "currency": { "type": "string" }
+                          },
+                          "required": ["amount", "currency"]
+                        }
+                      },
+                      "required": ["id", "name", "balance"]
+                    }
+                  },
+                  "required": ["id", "total", "customer"]
+                }
+              }
+            },
+            "required": ["items"]
+          }
+        }
+      },
+      "errors": []
+    },
+    {
+      "kind": "rpc",
+      "name": "GenerateReport",
+      "version": 1,
+      "scope": ["billing", "reports"],
+      "path": "/billing-reports/generate-report/1",
+      "method": "post",
+      "jsonSchema": {
+        "body": {
+          "type": "object",
+          "properties": { "month": { "type": "string" } },
+          "required": ["month"]
+        },
+        "response": {
+          "type": "object",
+          "properties": { "url": { "type": "string" } },
+          "required": ["url"]
+        }
+      },
+      "errors": []
+    }
+  ],
+  "errors": [
+    {
+      "name": "NotFound",
+      "statusCode": 404,
+      "description": "Resource not found",
+      "schema": {
+        "type": "object",
+        "properties": {
+          "name": { "const": "NotFound" },
+          "message": { "type": "string" }
+        },
+        "required": ["name", "message"]
+      }
+    },
+    {
+      "name": "OrderRejected",
+      "statusCode": 422,
+      "description": "The order could not be accepted",
+      "schema": {
+        "type": "object",
+        "properties": {
+          "name": { "const": "OrderRejected" },
+          "message": { "type": "string" },
+          "reason": { "type": "string", "enum": ["out-of-stock", "fraud", "limit"] }
+        },
+        "required": ["name", "message", "reason"]
+      }
+    },
+    {
+      "name": "RateLimited",
+      "statusCode": 429,
+      "description": "Too many requests (no schema on purpose: pins route-error filtering)"
+    }
+  ]
+}

package/src/codegen/__goldens__/MANIFEST.json

@@ -0,0 +1,85 @@
+{
+  "capturedFrom": "ts-procedures@8.6.0",
+  "note": "Byte-level codegen output contract. Regenerate ONLY with the v8 build via tools/capture-goldens.mjs (V8_ROOT=<v8.6.0 checkout>).",
+  "cases": [
+    {
+      "name": "ts-default",
+      "envelopes": [
+        "users",
+        "models"
+      ],
+      "options": {}
+    },
+    {
+      "name": "ts-flat",
+      "envelopes": [
+        "users",
+        "models"
+      ],
+      "options": {
+        "namespaceTypes": false
+      }
+    },
+    {
+      "name": "ts-external-runtime",
+      "envelopes": [
+        "users",
+        "models"
+      ],
+      "options": {
+        "selfContained": false
+      }
+    },
+    {
+      "name": "ts-no-share-models",
+      "envelopes": [
+        "users",
+        "models"
+      ],
+      "options": {
+        "shareModels": false
+      }
+    },
+    {
+      "name": "ts-shared-models-module",
+      "envelopes": [
+        "models"
+      ],
+      "options": {
+        "sharedModelsModule": "@acme/models"
+      }
+    },
+    {
+      "name": "kotlin-default",
+      "envelopes": [
+        "users",
+        "models"
+      ],
+      "options": {
+        "target": "kotlin",
+        "kotlinPackage": "com.example.api",
+        "kotlinEmitter": {}
+      }
+    },
+    {
+      "name": "swift-default",
+      "envelopes": [
+        "users",
+        "models"
+      ],
+      "options": {
+        "target": "swift",
+        "swiftEmitter": {}
+      }
+    }
+  ],
+  "cliDefaults": {
+    "ajsc": {
+      "jsdoc": true
+    },
+    "namespaceTypes": true,
+    "selfContained": true,
+    "shareModels": true,
+    "cleanOutDir": false
+  }
+}