ts-procedures 8.5.0 → 9.0.0

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/__fixtures__/users-envelope.json

@@ -191,6 +191,15 @@
         }
       },
       "errors": []
+    },
+    {
+      "kind": "api",
+      "name": "Heartbeat",
+      "scope": "users",
+      "method": "GET",
+      "fullPath": "/users/heartbeat",
+      "jsonSchema": { "req": {}, "res": {} },
+      "errors": []
     }
   ],
   "errors": [

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

package/src/codegen/__goldens__/kotlin-default--models/Billing.kt

@@ -0,0 +1,112 @@
+package com.example.api
+
+// ts-procedures-codegen — do not edit
+// Source hash: cb5f789247045d83e6eb2611821116bb
+
+import kotlinx.serialization.SerialName
+import kotlinx.serialization.Serializable
+
+object Billing {
+    object GetInvoice {
+        const val method = "GET"
+        const val pathTemplate = "/billing/invoices/{id}"
+        fun path(p: PathParams): String = "/billing/invoices/${p.id}"
+
+        @Serializable
+        data class PathParams(
+          val id: String,
+        )
+
+
+        @Serializable
+        data class Response(
+          val id: String,
+          val total: Total,
+          val customer: Customer,
+        ) {
+          /** Money */
+          @Serializable
+          data class Total(
+            val amount: Long,
+            val currency: String,
+          )
+
+          /** Customer */
+          @Serializable
+          data class Customer(
+            val id: String,
+            val name: String,
+            val balance: Balance,
+          ) {
+            /** Money */
+            @Serializable
+            data class Balance(
+              val amount: Long,
+              val currency: String,
+            )
+          }
+        }
+
+
+        object Errors {
+            @Serializable
+            data class NotFound(
+              val name: String,
+              val message: String,
+            )
+
+        }
+    }
+
+    object ListInvoices {
+        const val method = "GET"
+        const val pathTemplate = "/billing/invoices"
+        const val path = "/billing/invoices"
+
+        @Serializable
+        enum class Status { @SerialName("open") OPEN, @SerialName("paid") PAID }
+
+        @Serializable
+        data class Query(
+          val status: Status? = null,
+          val limit: Long? = null,
+        )
+
+
+        @Serializable
+        data class Response(
+          val items: List<Item>,
+        ) {
+          /** Invoice */
+          @Serializable
+          data class Item(
+            val id: String,
+            val total: Total,
+            val customer: Customer,
+          ) {
+            /** Money */
+            @Serializable
+            data class Total(
+              val amount: Long,
+              val currency: String,
+            )
+
+            /** Customer */
+            @Serializable
+            data class Customer(
+              val id: String,
+              val name: String,
+              val balance: Balance,
+            ) {
+              /** Money */
+              @Serializable
+              data class Balance(
+                val amount: Long,
+                val currency: String,
+              )
+            }
+          }
+        }
+
+    }
+}

package/src/codegen/__goldens__/kotlin-default--models/BillingReports.kt

@@ -0,0 +1,26 @@
+package com.example.api
+
+// ts-procedures-codegen — do not edit
+// Source hash: cb5f789247045d83e6eb2611821116bb
+
+import kotlinx.serialization.Serializable
+
+object BillingReports {
+    object GenerateReport {
+        const val method = "POST"
+        const val pathTemplate = "/billing-reports/generate-report/1"
+        const val path = "/billing-reports/generate-report/1"
+
+        @Serializable
+        data class Body(
+          val month: String,
+        )
+
+
+        @Serializable
+        data class Response(
+          val url: String,
+        )
+
+    }
+}

package/src/codegen/__goldens__/kotlin-default--models/Orders.kt

@@ -0,0 +1,88 @@
+package com.example.api
+
+// ts-procedures-codegen — do not edit
+// Source hash: cb5f789247045d83e6eb2611821116bb
+
+import kotlinx.serialization.SerialName
+import kotlinx.serialization.Serializable
+
+object Orders {
+    object GetOrder {
+        const val method = "POST"
+        const val pathTemplate = "/orders/get-order/1"
+        const val path = "/orders/get-order/1"
+
+        @Serializable
+        data class Body(
+          val orderId: String,
+        )
+
+
+        @Serializable
+        data class Response(
+          val id: String,
+          val name: String,
+          val balance: Balance,
+        ) {
+          /** Money */
+          @Serializable
+          data class Balance(
+            val amount: Long,
+            val currency: String,
+          )
+        }
+
+
+        object Errors {
+            @Serializable
+            enum class Reason { @SerialName("out-of-stock") OUT_OF_STOCK, @SerialName("fraud") FRAUD, @SerialName("limit") LIMIT }
+
+            @Serializable
+            data class OrderRejected(
+              val name: String,
+              val message: String,
+              val reason: Reason,
+            )
+
+        }
+    }
+
+    object SubmitOrder {
+        const val method = "POST"
+        const val pathTemplate = "/orders/submit-order/1"
+        const val path = "/orders/submit-order/1"
+
+        @Serializable
+        data class Body(
+          val orderId: String,
+          val total: Total,
+        ) {
+          /** Money */
+          @Serializable
+          data class Total(
+            val amount: Long,
+            val currency: String,
+          )
+        }
+
+
+        @Serializable
+        data class Response(
+          val ok: Boolean,
+        )
+
+
+        object Errors {
+            @Serializable
+            enum class Reason { @SerialName("out-of-stock") OUT_OF_STOCK, @SerialName("fraud") FRAUD, @SerialName("limit") LIMIT }
+
+            @Serializable
+            data class OrderRejected(
+              val name: String,
+              val message: String,
+              val reason: Reason,
+            )
+
+        }
+    }
+}