ts-procedures 8.6.0 → 9.1.0

package/src/codegen/__goldens__/ts-default--users/users.ts

@@ -0,0 +1,169 @@
+// Auto-generated by ts-procedures-codegen (v8.6.0) — do not edit
+// Source hash: 7b621d913616819f78563ff671bffa03
+import type { ClientInstance, ProcedureCallOptions, TypedStream } from './_types'
+import type { ApiErrors } from './_errors'
+
+export namespace Users {
+  export namespace GetUser {
+    export namespace Req {
+      export type PathParams = { id: string; }
+    }
+
+    export type Req = { pathParams: Req.PathParams }
+
+    export namespace Response {
+      export type Address = { street: string; city: string; }
+      export type Body = { id: string; name: string; "created-at": string; address: Address; }
+    }
+    export type Errors = ApiErrors.NotFound
+  }
+
+  export namespace CreateUser {
+    export namespace Req {
+      export type Body = { kind: "guest"; displayName: string; } | { kind: "registered"; email: string; name: string; }
+    }
+
+    export type Req = { body: Req.Body }
+
+    export namespace Response {
+      export type Body = { id: string; }
+    }
+    export type Errors = ApiErrors.ValidationError
+  }
+
+  export namespace ListUsers {
+    export namespace Req {
+      export type Query = { status?: "active" | "inactive"; limit?: number; }
+    }
+
+    export type Req = { query: Req.Query }
+
+    export namespace Response {
+      export type Item = { id: string; name: string; }
+      export type Body = { items: Array<Item>; }
+    }
+  }
+
+  export namespace DownloadUser {
+    export namespace Req {
+      export type PathParams = { id: string; }
+    }
+
+    export type Req = { pathParams: Req.PathParams }
+
+    export namespace Response {
+      export type Body = { url: string; }
+      export type Headers = { "x-download-token": string; "content-disposition"?: string; }
+    }
+  }
+
+  export namespace WatchUsers {
+    export namespace Req {
+      export type Query = { status?: "active" | "inactive"; }
+    }
+    export type Req = { query: Req.Query }
+    export namespace Response {
+      export type Headers = { "x-stream-id": string; }
+    }
+    export type Yield = { id: string; event: "created" | "updated" | "deleted"; }
+    export type ReturnType = { count: number; }
+  }
+
+  /** Binds every callable in this scope to a configured client. */
+  export function bindScope(client: ClientInstance) {
+    return {
+      /**
+       * GET /users/:id
+       *
+       * @param options Optional per-call {@link ProcedureCallOptions} —
+       *   `signal` (cancel on dispose), `timeout`, `headers`, `basePath`.
+       * @throws Declared typed errors: {@link Users.GetUser.Errors}. Narrow with
+       *   `instanceof` on the throwing path, or call `.safe()` for a `Result`.
+       */
+      GetUser: client.bindCallableTyped<Users.GetUser.Req, Users.GetUser.Response.Body, Users.GetUser.Errors>({
+        name: 'GetUser',
+        scope: 'users',
+        path: '/users/:id',
+        method: 'GET',
+        kind: 'api',
+      }),
+
+      /**
+       * POST /users
+       *
+       * @param options Optional per-call {@link ProcedureCallOptions} —
+       *   `signal` (cancel on dispose), `timeout`, `headers`, `basePath`.
+       * @throws Declared typed errors: {@link Users.CreateUser.Errors}. Narrow with
+       *   `instanceof` on the throwing path, or call `.safe()` for a `Result`.
+       */
+      CreateUser: client.bindCallableTyped<Users.CreateUser.Req, Users.CreateUser.Response.Body, Users.CreateUser.Errors>({
+        name: 'CreateUser',
+        scope: 'users',
+        path: '/users',
+        method: 'POST',
+        kind: 'api',
+      }),
+
+      /**
+       * GET /users
+       *
+       * @param options Optional per-call {@link ProcedureCallOptions} —
+       *   `signal` (cancel on dispose), `timeout`, `headers`, `basePath`.
+       */
+      ListUsers: client.bindCallable<Users.ListUsers.Req, Users.ListUsers.Response.Body>({
+        name: 'ListUsers',
+        scope: 'users',
+        path: '/users',
+        method: 'GET',
+        kind: 'api',
+      }),
+
+      /**
+       * GET /users/:id/download
+       *
+       * @param options Optional per-call {@link ProcedureCallOptions} —
+       *   `signal` (cancel on dispose), `timeout`, `headers`, `basePath`.
+       */
+      DownloadUser: client.bindCallable<Users.DownloadUser.Req, { body: Users.DownloadUser.Response.Body; headers: Users.DownloadUser.Response.Headers }>({
+        name: 'DownloadUser',
+        scope: 'users',
+        path: '/users/:id/download',
+        method: 'GET',
+        kind: 'api',
+        responseHeadersDeclared: true,
+      }),
+
+      /**
+       * GET /users/watch
+       *
+       * @param options Optional per-call {@link ProcedureCallOptions} —
+       *   `signal` (cancel on dispose), `timeout`, `headers`, `basePath`.
+       */
+      WatchUsers(req: Users.WatchUsers.Req, options?: ProcedureCallOptions): TypedStream<Users.WatchUsers.Yield, Users.WatchUsers.ReturnType> {
+        return client.stream<Users.WatchUsers.Yield, Users.WatchUsers.ReturnType>({
+          name: 'WatchUsers',
+          scope: 'users',
+          path: '/users/watch',
+          method: 'GET',
+          kind: 'http-stream',
+          streamMode: 'sse',
+          params: req,
+        }, options)
+      },
+
+      /**
+       * GET /users/heartbeat
+       *
+       * @param options Optional per-call {@link ProcedureCallOptions} —
+       *   `signal` (cancel on dispose), `timeout`, `headers`, `basePath`.
+       */
+      Heartbeat: client.bindCallable<void, void>({
+        name: 'Heartbeat',
+        scope: 'users',
+        path: '/users/heartbeat',
+        method: 'GET',
+        kind: 'api',
+      }),
+    }
+  }
+}

package/src/codegen/__goldens__/ts-external-runtime--models/_errors.ts

@@ -0,0 +1,90 @@
+// Auto-generated by ts-procedures-codegen (v8.6.0) — do not edit
+// Source hash: cb5f789247045d83e6eb2611821116bb
+
+export namespace ApiErrors {
+  /** Base class for every generated error in this service. Catch with `instanceof`. */
+  export class ApiProcedureError<TBody = unknown> extends Error {
+    readonly status: number
+    readonly procedureName: string
+    readonly scope: string
+    readonly body: TBody
+    constructor(args: {
+      name: string
+      message: string
+      status: number
+      procedureName: string
+      scope: string
+      body: TBody
+    }) {
+      super(args.message)
+      this.name = args.name
+      this.status = args.status
+      this.procedureName = args.procedureName
+      this.scope = args.scope
+      this.body = args.body
+      Object.setPrototypeOf(this, new.target.prototype)
+    }
+  }
+
+  /** Response body for NotFound. */
+  export type NotFoundBody = { name: "NotFound"; message: string; }
+
+  /** Resource not found (HTTP 404) */
+  export class NotFound extends ApiProcedureError<NotFoundBody> {
+    static readonly errorName = 'NotFound' as const
+    static readonly statusCode = 404
+    static fromResponse(
+      body: NotFoundBody,
+      meta: { status: number; procedureName: string; scope: string }
+    ): NotFound {
+      const message =
+        body && typeof (body as { message?: unknown }).message === 'string'
+          ? (body as { message: string }).message
+          : 'NotFound'
+      return new NotFound({
+        name: 'NotFound',
+        message,
+        status: meta.status,
+        procedureName: meta.procedureName,
+        scope: meta.scope,
+        body,
+      })
+    }
+  }
+
+  /** Response body for OrderRejected. */
+  export type OrderRejectedBody = { name: "OrderRejected"; message: string; reason: "out-of-stock" | "fraud" | "limit"; }
+
+  /** The order could not be accepted (HTTP 422) */
+  export class OrderRejected extends ApiProcedureError<OrderRejectedBody> {
+    static readonly errorName = 'OrderRejected' as const
+    static readonly statusCode = 422
+    static fromResponse(
+      body: OrderRejectedBody,
+      meta: { status: number; procedureName: string; scope: string }
+    ): OrderRejected {
+      const message =
+        body && typeof (body as { message?: unknown }).message === 'string'
+          ? (body as { message: string }).message
+          : 'OrderRejected'
+      return new OrderRejected({
+        name: 'OrderRejected',
+        message,
+        status: meta.status,
+        procedureName: meta.procedureName,
+        scope: meta.scope,
+        body,
+      })
+    }
+  }
+
+  /** Union of every generated error in this service. */
+  export type ApiProcedureErrorUnion = NotFound | OrderRejected
+
+  /** Runtime registry consumed by the client to dispatch by `body.name`. */
+  export const ApiErrorRegistry = {
+    NotFound,
+    OrderRejected,
+  } as const
+
+}

package/src/codegen/__goldens__/ts-external-runtime--models/_models.ts

@@ -0,0 +1,10 @@
+// Auto-generated by ts-procedures-codegen (v8.6.0) — do not edit
+// Source hash: cb5f789247045d83e6eb2611821116bb
+
+export type Customer = { id: string; name: string; balance: Money; }
+
+export type Money = { amount: number; currency: string; }
+
+export type OrderEvent = { orderId: string; status: "created" | "paid" | "shipped"; total: Money; }
+
+export type Invoice = { id: string; total: Money; customer: Customer; }

package/src/codegen/__goldens__/ts-external-runtime--models/billing-reports.ts

@@ -0,0 +1,29 @@
+// Auto-generated by ts-procedures-codegen (v8.6.0) — do not edit
+// Source hash: cb5f789247045d83e6eb2611821116bb
+import type { ClientInstance, ProcedureCallOptions } from 'ts-procedures/client'
+
+export namespace BillingReports {
+  export namespace GenerateReport {
+    export type Params = { month: string; }
+    export type Response = { url: string; }
+  }
+
+  /** Binds every callable in this scope to a configured client. */
+  export function bindScope(client: ClientInstance) {
+    return {
+      /**
+       * POST /billing-reports/generate-report/1
+       *
+       * @param options Optional per-call {@link ProcedureCallOptions} —
+       *   `signal` (cancel on dispose), `timeout`, `headers`, `basePath`.
+       */
+      GenerateReport: client.bindCallable<BillingReports.GenerateReport.Params, BillingReports.GenerateReport.Response>({
+        name: 'GenerateReport',
+        scope: 'billing-reports',
+        path: '/billing-reports/generate-report/1',
+        method: 'post',
+        kind: 'rpc',
+      }),
+    }
+  }
+}

package/src/codegen/__goldens__/ts-external-runtime--models/billing.ts

@@ -0,0 +1,67 @@
+// Auto-generated by ts-procedures-codegen (v8.6.0) — do not edit
+// Source hash: cb5f789247045d83e6eb2611821116bb
+import type { ClientInstance, ProcedureCallOptions } from 'ts-procedures/client'
+import type { ApiErrors } from './_errors'
+import type { Invoice } from './_models'
+
+export namespace Billing {
+  export namespace GetInvoice {
+    export namespace Req {
+      export type PathParams = { id: string; }
+    }
+
+    export type Req = { pathParams: Req.PathParams }
+
+    export namespace Response {
+      export type Body = Invoice
+    }
+    export type Errors = ApiErrors.NotFound
+  }
+
+  export namespace ListInvoices {
+    export namespace Req {
+      export type Query = { status?: "open" | "paid"; limit?: number; }
+    }
+
+    export type Req = { query: Req.Query }
+
+    export namespace Response {
+      export type Body = { items: Array<Invoice>; }
+    }
+  }
+
+  /** Binds every callable in this scope to a configured client. */
+  export function bindScope(client: ClientInstance) {
+    return {
+      /**
+       * GET /billing/invoices/:id
+       *
+       * @param options Optional per-call {@link ProcedureCallOptions} —
+       *   `signal` (cancel on dispose), `timeout`, `headers`, `basePath`.
+       * @throws Declared typed errors: {@link Billing.GetInvoice.Errors}. Narrow with
+       *   `instanceof` on the throwing path, or call `.safe()` for a `Result`.
+       */
+      GetInvoice: client.bindCallableTyped<Billing.GetInvoice.Req, Billing.GetInvoice.Response.Body, Billing.GetInvoice.Errors>({
+        name: 'GetInvoice',
+        scope: 'billing',
+        path: '/billing/invoices/:id',
+        method: 'GET',
+        kind: 'api',
+      }),
+
+      /**
+       * GET /billing/invoices
+       *
+       * @param options Optional per-call {@link ProcedureCallOptions} —
+       *   `signal` (cancel on dispose), `timeout`, `headers`, `basePath`.
+       */
+      ListInvoices: client.bindCallable<Billing.ListInvoices.Req, Billing.ListInvoices.Response.Body>({
+        name: 'ListInvoices',
+        scope: 'billing',
+        path: '/billing/invoices',
+        method: 'GET',
+        kind: 'api',
+      }),
+    }
+  }
+}

package/src/codegen/__goldens__/ts-external-runtime--models/index.ts

@@ -0,0 +1,48 @@
+// Auto-generated by ts-procedures-codegen (v8.6.0) — do not edit
+// Source hash: cb5f789247045d83e6eb2611821116bb
+import { createClient } from 'ts-procedures/client'
+import type { ClientInstance, CreateClientConfig } from 'ts-procedures/client'
+import * as _orders from './orders'
+import * as _billing from './billing'
+import * as _billingReports from './billing-reports'
+import * as _errorsModule from './_errors'
+
+export namespace Api {
+  export import Orders = _orders.Orders
+  export import Billing = _billing.Billing
+  export import BillingReports = _billingReports.BillingReports
+  export import Errors = _errorsModule.ApiErrors
+}
+
+export function createApiBindings(client: ClientInstance) {
+  return {
+    orders: _orders.Orders.bindScope(client),
+    billing: _billing.Billing.bindScope(client),
+    billingReports: _billingReports.BillingReports.bindScope(client),
+  }
+}
+
+/** Full typed client surface — every scope of `Api`. */
+export type ApiClient = ReturnType<typeof createApiBindings>
+/** Narrow port for the `orders` scope — inject as a DI seam without casting the aggregate client. */
+export type OrdersClient = ApiClient['orders']
+/** Narrow port for the `billing` scope — inject as a DI seam without casting the aggregate client. */
+export type BillingClient = ApiClient['billing']
+/** Narrow port for the `billingReports` scope — inject as a DI seam without casting the aggregate client. */
+export type BillingReportsClient = ApiClient['billingReports']
+
+/**
+ * Creates a typed client for this service with the generated error
+ * registry pre-configured. Non-2xx responses whose body `name` matches
+ * a registered error are thrown as typed class instances instead of
+ * generic `ClientHttpError`s.
+ */
+export function createApiClient(
+  config: Omit<CreateClientConfig<ReturnType<typeof createApiBindings>>, 'scopes' | 'errorRegistry'>
+) {
+  return createClient({
+    ...config,
+    errorRegistry: _errorsModule.ApiErrors.ApiErrorRegistry,
+    scopes: (client) => createApiBindings(client),
+  })
+}

package/src/codegen/__goldens__/ts-external-runtime--models/orders.ts

@@ -0,0 +1,80 @@
+// Auto-generated by ts-procedures-codegen (v8.6.0) — do not edit
+// Source hash: cb5f789247045d83e6eb2611821116bb
+import type { ClientInstance, ProcedureCallOptions, TypedStream } from 'ts-procedures/client'
+import type { ApiErrors } from './_errors'
+import type { Customer, Money, OrderEvent } from './_models'
+
+export namespace Orders {
+  export namespace GetOrder {
+    export type Params = { orderId: string; }
+    export type Response = Customer
+    export type Errors = ApiErrors.OrderRejected
+  }
+
+  export namespace SubmitOrder {
+    export type Params = { orderId: string; total: Money; }
+    export type Response = { ok: boolean; }
+    export type Errors = ApiErrors.OrderRejected
+  }
+
+  export namespace WatchOrders {
+    export type Params = { orderId: string; }
+    export type Yield = OrderEvent
+    export type Return = { total: number; }
+  }
+
+  /** Binds every callable in this scope to a configured client. */
+  export function bindScope(client: ClientInstance) {
+    return {
+      /**
+       * POST /orders/get-order/1
+       *
+       * @param options Optional per-call {@link ProcedureCallOptions} —
+       *   `signal` (cancel on dispose), `timeout`, `headers`, `basePath`.
+       * @throws Declared typed errors: {@link Orders.GetOrder.Errors}. Narrow with
+       *   `instanceof` on the throwing path, or call `.safe()` for a `Result`.
+       */
+      GetOrder: client.bindCallableTyped<Orders.GetOrder.Params, Orders.GetOrder.Response, Orders.GetOrder.Errors>({
+        name: 'GetOrder',
+        scope: 'orders',
+        path: '/orders/get-order/1',
+        method: 'post',
+        kind: 'rpc',
+      }),
+
+      /**
+       * POST /orders/submit-order/1
+       *
+       * @param options Optional per-call {@link ProcedureCallOptions} —
+       *   `signal` (cancel on dispose), `timeout`, `headers`, `basePath`.
+       * @throws Declared typed errors: {@link Orders.SubmitOrder.Errors}. Narrow with
+       *   `instanceof` on the throwing path, or call `.safe()` for a `Result`.
+       */
+      SubmitOrder: client.bindCallableTyped<Orders.SubmitOrder.Params, Orders.SubmitOrder.Response, Orders.SubmitOrder.Errors>({
+        name: 'SubmitOrder',
+        scope: 'orders',
+        path: '/orders/submit-order/1',
+        method: 'post',
+        kind: 'rpc',
+      }),
+
+      /**
+       * POST|GET /orders/watch-orders/1
+       *
+       * @param options Optional per-call {@link ProcedureCallOptions} —
+       *   `signal` (cancel on dispose), `timeout`, `headers`, `basePath`.
+       */
+      WatchOrders(params: Orders.WatchOrders.Params, options?: ProcedureCallOptions): TypedStream<Orders.WatchOrders.Yield, Orders.WatchOrders.Return> {
+        return client.stream<Orders.WatchOrders.Yield, Orders.WatchOrders.Return>({
+          name: 'WatchOrders',
+          scope: 'orders',
+          path: '/orders/watch-orders/1',
+          method: 'post',
+          kind: 'stream',
+          streamMode: 'sse',
+          params,
+        }, options)
+      },
+    }
+  }
+}

package/src/codegen/__goldens__/ts-external-runtime--users/_errors.ts

@@ -0,0 +1,90 @@
+// Auto-generated by ts-procedures-codegen (v8.6.0) — do not edit
+// Source hash: 7b621d913616819f78563ff671bffa03
+
+export namespace ApiErrors {
+  /** Base class for every generated error in this service. Catch with `instanceof`. */
+  export class ApiProcedureError<TBody = unknown> extends Error {
+    readonly status: number
+    readonly procedureName: string
+    readonly scope: string
+    readonly body: TBody
+    constructor(args: {
+      name: string
+      message: string
+      status: number
+      procedureName: string
+      scope: string
+      body: TBody
+    }) {
+      super(args.message)
+      this.name = args.name
+      this.status = args.status
+      this.procedureName = args.procedureName
+      this.scope = args.scope
+      this.body = args.body
+      Object.setPrototypeOf(this, new.target.prototype)
+    }
+  }
+
+  /** Response body for NotFound. */
+  export type NotFoundBody = { name: "NotFound"; message: string; }
+
+  /** Resource not found (HTTP 404) */
+  export class NotFound extends ApiProcedureError<NotFoundBody> {
+    static readonly errorName = 'NotFound' as const
+    static readonly statusCode = 404
+    static fromResponse(
+      body: NotFoundBody,
+      meta: { status: number; procedureName: string; scope: string }
+    ): NotFound {
+      const message =
+        body && typeof (body as { message?: unknown }).message === 'string'
+          ? (body as { message: string }).message
+          : 'NotFound'
+      return new NotFound({
+        name: 'NotFound',
+        message,
+        status: meta.status,
+        procedureName: meta.procedureName,
+        scope: meta.scope,
+        body,
+      })
+    }
+  }
+
+  /** Response body for ValidationError. */
+  export type ValidationErrorBody = { name: "ValidationError"; message: string; field?: string; }
+
+  /** Input failed validation (HTTP 400) */
+  export class ValidationError extends ApiProcedureError<ValidationErrorBody> {
+    static readonly errorName = 'ValidationError' as const
+    static readonly statusCode = 400
+    static fromResponse(
+      body: ValidationErrorBody,
+      meta: { status: number; procedureName: string; scope: string }
+    ): ValidationError {
+      const message =
+        body && typeof (body as { message?: unknown }).message === 'string'
+          ? (body as { message: string }).message
+          : 'ValidationError'
+      return new ValidationError({
+        name: 'ValidationError',
+        message,
+        status: meta.status,
+        procedureName: meta.procedureName,
+        scope: meta.scope,
+        body,
+      })
+    }
+  }
+
+  /** Union of every generated error in this service. */
+  export type ApiProcedureErrorUnion = NotFound | ValidationError
+
+  /** Runtime registry consumed by the client to dispatch by `body.name`. */
+  export const ApiErrorRegistry = {
+    NotFound,
+    ValidationError,
+  } as const
+
+}

package/src/codegen/__goldens__/ts-external-runtime--users/index.ts

@@ -0,0 +1,38 @@
+// Auto-generated by ts-procedures-codegen (v8.6.0) — do not edit
+// Source hash: 7b621d913616819f78563ff671bffa03
+import { createClient } from 'ts-procedures/client'
+import type { ClientInstance, CreateClientConfig } from 'ts-procedures/client'
+import * as _users from './users'
+import * as _errorsModule from './_errors'
+
+export namespace Api {
+  export import Users = _users.Users
+  export import Errors = _errorsModule.ApiErrors
+}
+
+export function createApiBindings(client: ClientInstance) {
+  return {
+    users: _users.Users.bindScope(client),
+  }
+}
+
+/** Full typed client surface — every scope of `Api`. */
+export type ApiClient = ReturnType<typeof createApiBindings>
+/** Narrow port for the `users` scope — inject as a DI seam without casting the aggregate client. */
+export type UsersClient = ApiClient['users']
+
+/**
+ * Creates a typed client for this service with the generated error
+ * registry pre-configured. Non-2xx responses whose body `name` matches
+ * a registered error are thrown as typed class instances instead of
+ * generic `ClientHttpError`s.
+ */
+export function createApiClient(
+  config: Omit<CreateClientConfig<ReturnType<typeof createApiBindings>>, 'scopes' | 'errorRegistry'>
+) {
+  return createClient({
+    ...config,
+    errorRegistry: _errorsModule.ApiErrors.ApiErrorRegistry,
+    scopes: (client) => createApiBindings(client),
+  })
+}