typescript generator for security object => $.user

openapi-example.yaml

@@ -3,6 +3,9 @@ info:
   version: 1.0.0
   title: Sample API
   description: A sample API to illustrate OpenAPI concepts
+security:
+  - type: ["http"]
+    scheme: ["basic"]
 paths:
   /count:
     get:

src/typescript-generator/generate.js

@@ -78,12 +78,17 @@ export async function generate(
 
   debug("got %i paths", paths.size);
 
+  const securityRequirement = await specification.requirementAt("#/security");
+
+  const security = securityRequirement?.data ?? [];
+
   paths.forEach((pathDefinition, key) => {
     debug("processing path %s", key);
+
     pathDefinition.forEach((operation, requestMethod) => {
       repository
         .get(`paths${key}.ts`)
-        .export(new OperationCoder(operation, requestMethod));
+        .export(new OperationCoder(operation, requestMethod, security));
     });
   });
 

src/typescript-generator/operation-coder.js

@@ -5,14 +5,15 @@ import { Coder } from "./coder.js";
 import { OperationTypeCoder } from "./operation-type-coder.js";
 
 export class OperationCoder extends Coder {
-  constructor(requirement, requestMethod) {
+  constructor(requirement, requestMethod, security = []) {
     super(requirement);
 
     if (requestMethod === undefined) {
       throw new Error("requestMethod is required");
     }
 
     this.requestMethod = requestMethod;
+    this.security = security;
   }
 
   names() {
@@ -46,6 +47,7 @@ export class OperationCoder extends Coder {
     const operationTypeCoder = new OperationTypeCoder(
       this.requirement,
       this.requestMethod,
+      this.security,
     );
 
     return script.importType(operationTypeCoder);

src/typescript-generator/operation-type-coder.js

@@ -8,14 +8,15 @@ import { SchemaTypeCoder } from "./schema-type-coder.js";
 import { TypeCoder } from "./type-coder.js";
 
 export class OperationTypeCoder extends TypeCoder {
-  constructor(requirement, requestMethod) {
+  constructor(requirement, requestMethod, security = []) {
     super(requirement);
 
     if (requestMethod === undefined) {
       throw new Error("requestMethod is required");
     }
 
     this.requestMethod = requestMethod;
+    this.security = security;
   }
 
   names() {
@@ -76,6 +77,18 @@ export class OperationTypeCoder extends TypeCoder {
       .replaceAll("\\", "/")}.types.ts`;
   }
 
+  userType() {
+    if (
+      this.security.some(
+        ({ scheme, type }) => type.includes("http") && scheme.includes("basic"),
+      )
+    ) {
+      return "{username?: string, password?: string}";
+    }
+
+    return "never";
+  }
+
   // eslint-disable-next-line max-statements
   writeCode(script) {
     // eslint-disable-next-line no-param-reassign
@@ -123,7 +136,7 @@ export class OperationTypeCoder extends TypeCoder {
 
     const proxyType = '(url: string) => "COUNTERFACT_RESPONSE"';
 
-    return `($: OmitValueWhenNever<{ query: ${queryType}, path: ${pathType}, header: ${headerType}, body: ${bodyType}, context: ${contextTypeImportName}, response: ${responseType}, x: ${xType}, proxy: ${proxyType} }>) => ${this.responseTypes(
+    return `($: OmitValueWhenNever<{ query: ${queryType}, path: ${pathType}, header: ${headerType}, body: ${bodyType}, context: ${contextTypeImportName}, response: ${responseType}, x: ${xType}, proxy: ${proxyType}, user: ${this.userType()} }>) => ${this.responseTypes(
       script,
     )} | { status: 415, contentType: "text/plain", body: string } | "COUNTERFACT_RESPONSE" | { ALL_REMAINING_HEADERS_ARE_OPTIONAL: "COUNTERFACT_RESPONSE" }`;
   }