@contractkit/plugin-typescript 0.21.0 → 0.23.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contractkit/plugin-typescript",
-  "version": "0.21.0",
+  "version": "0.23.0",
   "description": "ContractKit built-in plugin: TypeScript codegen (SDK clients, Koa routers, Zod schemas, plain types)",
   "author": {
     "name": "Marooned Software",
@@ -26,11 +26,11 @@
     ".": "./dist/index.js"
   },
   "dependencies": {
-    "@contractkit/core": "0.16.0"
+    "@contractkit/core": "0.17.0"
   },
   "devDependencies": {
-    "@repo/config-eslint": "0.3.1",
-    "@repo/config-typescript": "0.1.0"
+    "@repo/config-typescript": "0.1.0",
+    "@repo/config-eslint": "0.3.1"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm --sourcemap --dts && tsc --emitDeclarationOnly --declaration",

package/src/codegen-operation.ts

@@ -125,6 +125,7 @@ export interface OpCodegenOptions {
     includeInternal?: boolean;
 }
 
+/** Generate a Koa router module for every operation in `root`, including the imports, type aliases, and handler list. */
 export function generateOp(root: OpRootNode, options: OpCodegenOptions = {}): string {
     // Collect all referenced types across all routes
     const types = collectTypes(root, options.modelsWithInput, options.modelsWithOutput);
@@ -240,8 +241,8 @@ function generateHandler(route: OpRouteNode, op: OpOperationNode, root: OpRootNo
     // Middleware list
     const middlewares: string[] = [];
     if (effectiveSecurity !== SECURITY_NONE) {
-        const roles = effectiveSecurity && effectiveSecurity.roles?.length ? `roles: [${effectiveSecurity.roles.map(r => `'${r}'`).join(', ')}]` : '';
-        middlewares.push(`requireSecurity({ ${roles} })`);
+        const args = effectiveSecurity && effectiveSecurity.requireMfa !== undefined ? `{ requireMfa: ${effectiveSecurity.requireMfa} }` : '';
+        middlewares.push(`requireSecurity(${args})`);
     }
     if (hasBody) {
         const parserTokens = Array.from(new Set(bodies.map(b => bodyParserToken(b.contentType))));

package/src/codegen-sdk.ts

@@ -138,6 +138,7 @@ export function generateSdk(root: OpRootNode, options: SdkCodegenOptions = {}):
         lines.push('        public readonly status: number,');
         lines.push('        public readonly statusText: string,');
         lines.push('        public readonly body: unknown,');
+        lines.push('        public readonly headers: Headers,');
         lines.push('    ) {');
         lines.push('        super(`${status} ${statusText}`);');
         lines.push("        this.name = 'SdkError';");
@@ -168,7 +169,7 @@ export function generateSdk(root: OpRootNode, options: SdkCodegenOptions = {}):
         lines.push('            const text = await res.text();');
         lines.push('            let body: unknown;');
         lines.push('            try { body = JSON.parse(text); } catch { body = text; }');
-        lines.push('            throw new SdkError(res.status, res.statusText, body);');
+        lines.push('            throw new SdkError(res.status, res.statusText, body, res.headers);');
         lines.push('        }');
         lines.push('        return res;');
         lines.push('    };');
@@ -885,6 +886,7 @@ export function generateSdkOptions(): string {
         '        public readonly status: number,',
         '        public readonly statusText: string,',
         '        public readonly body: unknown,',
+        '        public readonly headers: Headers,',
         '    ) {',
         '        super(`${status} ${statusText}`);',
         "        this.name = 'SdkError';",
@@ -931,7 +933,7 @@ export function generateSdkOptions(): string {
         '            const text = await res.text();',
         '            let body: unknown;',
         '            try { body = JSON.parse(text); } catch { body = text; }',
-        '            throw new SdkError(res.status, res.statusText, body);',
+        '            throw new SdkError(res.status, res.statusText, body, res.headers);',
         '        }',
         '        return res;',
         '    };',

package/tests/codegen-operation.test.ts

@@ -807,9 +807,9 @@ describe('generateOp — route modifiers JSDoc', () => {
             expect(out).toContain('anonymous access, no security required');
         });
 
-        it('emits no annotation for security with roles', () => {
+        it('emits no annotation for security with requireMfa', () => {
             const op = opOperation('get', {
-                security: { roles: ['admin'], loc: { file: 'test.op', line: 1 } },
+                security: { requireMfa: true, loc: { file: 'test.op', line: 1 } },
             });
             const root = opRoot([opRoute('/users', [op])]);
             const out = generateOp(root);
@@ -867,7 +867,7 @@ describe('generateOp — route modifiers JSDoc', () => {
 
         it('does not import requireSignature when no signature is set', () => {
             const op = opOperation('get', {
-                security: { roles: ['admin'], loc: { file: 'test.op', line: 1 } },
+                security: { requireMfa: true, loc: { file: 'test.op', line: 1 } },
             });
             const root = opRoot([opRoute('/users', [op])]);
             const out = generateOp(root);
@@ -876,7 +876,7 @@ describe('generateOp — route modifiers JSDoc', () => {
         });
     });
 
-    // ─── Security (roles) middleware ────────────────────────────────
+    // ─── Security (requireMfa) middleware ───────────────────────────
 
     describe('security middleware', () => {
         it('injects requireSecurity() with no args for unannotated routes', () => {
@@ -884,27 +884,26 @@ describe('generateOp — route modifiers JSDoc', () => {
             const root = opRoot([opRoute('/users', [op])]);
             const out = generateOp(root);
             expect(out).toContain(`import { ServerKitRouter, bodyParserMiddleware, requireSecurity }`);
-            expect(out).toContain(`requireSecurity({  })`);
+            expect(out).toContain(`requireSecurity()`);
         });
 
-        it('injects requireSecurity with roles when roles are set', () => {
+        it('injects requireSecurity with requireMfa: true when set', () => {
             const op = opOperation('get', {
-                security: { roles: ['admin'], loc: { file: 'test.op', line: 1 } },
+                security: { requireMfa: true, loc: { file: 'test.op', line: 1 } },
             });
             const root = opRoot([opRoute('/users', [op])]);
             const out = generateOp(root);
-            expect(out).toContain(`requireSecurity({ roles: ['admin'] })`);
+            expect(out).toContain(`requireSecurity({ requireMfa: true })`);
         });
 
-        it('passes multiple roles as an array', () => {
+        it('injects requireSecurity with requireMfa: false when set', () => {
             const op = opOperation('get', {
-                security: { roles: ['admin', 'support'], loc: { file: 'test.op', line: 1 } },
+                security: { requireMfa: false, loc: { file: 'test.op', line: 1 } },
             });
-            const root = opRoot([opRoute('/users', [op])]);
-            const routeLine = generateOp(root)
+            const routeLine = generateOp(opRoot([opRoute('/users', [op])]))
                 .split('\n')
                 .find(l => l.includes('.get('));
-            expect(routeLine).toContain(`requireSecurity({ roles: ['admin', 'support'] })`);
+            expect(routeLine).toContain(`requireSecurity({ requireMfa: false })`);
         });
 
         it('does not inject requireSecurity for public (security: none) routes', () => {
@@ -924,7 +923,7 @@ describe('generateOp — route modifiers JSDoc', () => {
 
         it('places requireSecurity before bodyParserMiddleware in the route line', () => {
             const op = opOperation('post', {
-                security: { roles: ['admin'], loc: { file: 'test.op', line: 1 } },
+                security: { requireMfa: true, loc: { file: 'test.op', line: 1 } },
                 request: opRequest('Payload'),
             });
             const root = opRoot([opRoute('/users', [op])]);
@@ -941,7 +940,7 @@ describe('generateOp — route modifiers JSDoc', () => {
         it('places requireSecurity before requireSignature when both are set', () => {
             const op = opOperation('post', {
                 signature: 'MY_KEY',
-                security: { roles: ['admin'], loc: { file: 'test.op', line: 1 } },
+                security: { requireMfa: true, loc: { file: 'test.op', line: 1 } },
                 request: opRequest('Payload'),
             });
             const root = opRoot([opRoute('/webhooks', [op])]);
@@ -958,7 +957,7 @@ describe('generateOp — route modifiers JSDoc', () => {
         it('imports both requireSecurity and requireSignature when both are set', () => {
             const op = opOperation('post', {
                 signature: 'MY_KEY',
-                security: { roles: ['admin'], loc: { file: 'test.op', line: 1 } },
+                security: { requireMfa: true, loc: { file: 'test.op', line: 1 } },
                 request: opRequest('Payload'),
             });
             const root = opRoot([opRoute('/webhooks', [op])]);
@@ -966,13 +965,13 @@ describe('generateOp — route modifiers JSDoc', () => {
             expect(out).toContain(`import { ServerKitRouter, bodyParserMiddleware, requireSecurity, requireSignature }`);
         });
 
-        it('works with route-level roles security', () => {
+        it('works with route-level requireMfa security', () => {
             const op = opOperation('get');
             const route = opRoute('/users', [op]);
-            route.security = { roles: ['admin'], loc: { file: 'test.op', line: 1 } };
+            route.security = { requireMfa: true, loc: { file: 'test.op', line: 1 } };
             const root = opRoot([route]);
             const out = generateOp(root);
-            expect(out).toContain(`requireSecurity({ roles: ['admin'] })`);
+            expect(out).toContain(`requireSecurity({ requireMfa: true })`);
         });
     });
 });

package/tests/codegen-sdk.test.ts

@@ -648,6 +648,8 @@ describe('generateSdk', () => {
             expect(out).toContain('headers?:');
             expect(out).toContain('fetch?: SdkFetch');
             expect(out).toContain('export class SdkError extends Error');
+            expect(out).toContain('public readonly headers: Headers');
+            expect(out).toContain('throw new SdkError(res.status, res.statusText, body, res.headers)');
         });
     });
 
@@ -756,7 +758,8 @@ describe('generateSdkOptions', () => {
         expect(out).toContain('export class SdkError extends Error');
         expect(out).toContain('public readonly status: number');
         expect(out).toContain('public readonly body: unknown');
-        expect(out).toContain('throw new SdkError(');
+        expect(out).toContain('public readonly headers: Headers');
+        expect(out).toContain('throw new SdkError(res.status, res.statusText, body, res.headers)');
         expect(out).toContain('export type SdkFetch');
         expect(out).toContain('export function createSdkFetch(options: SdkOptions): SdkFetch');
         expect(out).toContain('requestIdFactory ?? (() => crypto.randomUUID())');