ts-procedures 5.15.0 → 5.16.0

package/src/codegen/e2e.test.ts

@@ -481,6 +481,157 @@ describe('E2E: generateClient full pipeline', () => {
         execSync(`${tscPath} --noEmit --project ${join(tmpDir, 'tsconfig.json')}`, { stdio: 'pipe' })
       }).not.toThrow()
     })
+
+    it('_types.ts exports RequestMeta (empty interface ready for augmentation)', async () => {
+      tmpDir = makeTmpDir()
+      await generateClient({ envelope, outDir: tmpDir, selfContained: true })
+
+      const content = readFileSync(join(tmpDir, '_types.ts'), 'utf-8')
+      expect(content).toContain('export interface RequestMeta')
+      // meta on AdapterRequest and ProcedureCallDefaults should be typed as RequestMeta
+      expect(content).toContain('meta?: RequestMeta')
+    })
+
+    it('developers can augment RequestMeta for typed per-call meta + typed hook/adapter access', async () => {
+      tmpDir = makeTmpDir()
+      await generateClient({ envelope, outDir: tmpDir, selfContained: true })
+
+      // Write a consumer file that augments RequestMeta, then uses typed meta
+      // end-to-end: per-call options, createClient defaults, onBeforeRequest, and adapter.
+      const consumer = `
+import { createClient } from './_client'
+import type { ClientAdapter } from './_types'
+import { createApiBindings } from './index'
+
+declare module './_types' {
+  interface RequestMeta {
+    traceId: string
+    priority?: 'high' | 'low'
+  }
+}
+
+const typedAdapter: ClientAdapter = {
+  async request(req) {
+    // req.meta is now typed
+    const trace: string | undefined = req.meta?.traceId
+    const pri: 'high' | 'low' | undefined = req.meta?.priority
+    void trace; void pri
+    return { status: 200, headers: {}, body: {} }
+  },
+  async stream(req) {
+    const trace: string | undefined = req.meta?.traceId
+    void trace
+    return { status: 200, headers: {}, body: (async function*() {})() }
+  },
+}
+
+const client = createClient({
+  adapter: typedAdapter,
+  basePath: 'https://api.example.com',
+  scopes: createApiBindings,
+  defaults: {
+    meta: { traceId: 'default-trace' }, // typed
+  },
+  hooks: {
+    onBeforeRequest(ctx) {
+      // ctx.request.meta is typed via declaration merging
+      const trace: string | undefined = ctx.request.meta?.traceId
+      void trace
+      return ctx
+    },
+  },
+})
+
+async function run(): Promise<void> {
+  // Per-call meta is typed — traceId is required, priority is optional
+  await client.users.GetUser(
+    { id: '1' },
+    { meta: { traceId: 'per-call-trace', priority: 'high' } },
+  )
+  // Timeout + signal + headers typecheck
+  await client.users.GetUser(
+    { id: '2' },
+    { timeout: 5000, headers: { 'X-Request-Id': 'abc' }, basePath: 'https://other' },
+  )
+}
+void run
+`
+      const { writeFileSync } = await import('node:fs')
+      writeFileSync(join(tmpDir, 'consumer.ts'), consumer)
+
+      const tsconfig = {
+        compilerOptions: {
+          strict: true,
+          target: 'ES2022',
+          module: 'ES2022',
+          moduleResolution: 'bundler',
+          noEmit: true,
+          skipLibCheck: true,
+        },
+        include: ['_types.ts', '_client.ts', 'index.ts', 'users.ts', 'events.ts', '_errors.ts', 'consumer.ts'],
+      }
+      writeFileSync(join(tmpDir, 'tsconfig.json'), JSON.stringify(tsconfig))
+
+      const { execSync } = await import('node:child_process')
+      const tscPath = join(process.cwd(), 'node_modules', '.bin', 'tsc')
+      expect(() => {
+        execSync(`${tscPath} --noEmit --project ${join(tmpDir, 'tsconfig.json')}`, { stdio: 'pipe' })
+      }).not.toThrow()
+    })
+
+    it('augmented RequestMeta rejects wrong types (compile error)', async () => {
+      tmpDir = makeTmpDir()
+      await generateClient({ envelope, outDir: tmpDir, selfContained: true })
+
+      // Passing a number for `traceId` (declared as string) should fail tsc
+      const consumer = `
+import { createClient, createFetchAdapter } from './_client'
+import { createApiBindings } from './index'
+// RequestMeta is imported only for augmentation below
+import type {} from './_types'
+
+declare module './_types' {
+  interface RequestMeta {
+    traceId: string
+  }
+}
+
+const client = createClient({
+  adapter: createFetchAdapter(),
+  basePath: 'https://api.example.com',
+  scopes: createApiBindings,
+})
+
+async function run(): Promise<void> {
+  // @ts-expect-error traceId must be string, not number
+  await client.users.GetUser({ id: '1' }, { meta: { traceId: 42 } })
+}
+void run
+`
+      const { writeFileSync } = await import('node:fs')
+      writeFileSync(join(tmpDir, 'consumer.ts'), consumer)
+
+      const tsconfig = {
+        compilerOptions: {
+          strict: true,
+          target: 'ES2022',
+          module: 'ES2022',
+          moduleResolution: 'bundler',
+          noEmit: true,
+          skipLibCheck: true,
+        },
+        include: ['_types.ts', '_client.ts', 'index.ts', 'users.ts', 'events.ts', '_errors.ts', 'consumer.ts'],
+      }
+      writeFileSync(join(tmpDir, 'tsconfig.json'), JSON.stringify(tsconfig))
+
+      const { execSync } = await import('node:child_process')
+      const tscPath = join(process.cwd(), 'node_modules', '.bin', 'tsc')
+      // With @ts-expect-error in place, tsc should pass; if RequestMeta wasn't
+      // enforcing the type, @ts-expect-error would fail because there'd be no error.
+      expect(() => {
+        execSync(`${tscPath} --noEmit --project ${join(tmpDir, 'tsconfig.json')}`, { stdio: 'pipe' })
+      }).not.toThrow()
+    })
   })
 
   // ── namespaceTypes mode ───────────────────────────────────────────────────

package/src/codegen/emit-client-runtime.ts

@@ -16,8 +16,10 @@ const TYPES_IMPORT = `import type {
   StreamDescriptor,
   TypedStream,
   ClientInstance,
+  ProcedureCallDefaults,
   ProcedureCallOptions,
   CreateClientConfig,
+  RequestMeta,
 } from './_types'`
 
 /**
@@ -27,6 +29,7 @@ const TYPES_IMPORT = `import type {
 const SOURCE_FILES = [
   'errors.ts',
   'request-builder.ts',
+  'resolve-options.ts',
   'hooks.ts',
   'call.ts',
   'stream.ts',

package/src/implementations/http/README.md

@@ -319,7 +319,15 @@ import type { APIConfig, APIHttpRouteDoc, APIInput, HttpMethod } from 'ts-proced
 
 // Client Runtime
 import { createClient, createFetchAdapter } from 'ts-procedures/client'
-import type { ClientAdapter, ClientHooks, TypedStream, ClientInstance } from 'ts-procedures/client'
+import type {
+  ClientAdapter,
+  ClientHooks,
+  TypedStream,
+  ClientInstance,
+  ProcedureCallDefaults,
+  ProcedureCallOptions,
+  RequestMeta,
+} from 'ts-procedures/client'
 
 // Code Generation (build-time only)
 import { generateClient } from 'ts-procedures/codegen'