Type: Improved type for SecurityObject to include oauth2 & apiKey (#253)

* Updated SecurityObject to contain more than basic type

* Fixed SecurityObject scheme being interpreted as type and vice versa

* Fixed SecurityObject type being written from wrong documentation

---------

Co-authored-by: Kevin Julián Martínez Escobar <[email protected]>

Author: MakakWasTaken

.eslintrc.json

@@ -17,6 +17,7 @@
     "ecmaVersion": 11
   },
   "rules": {
+    "linebreak-style": ["error", "windows"],
     "arrow-parens": [
       "error",
       "as-needed",

index.d.ts

@@ -29,10 +29,67 @@ interface InfoObject {
   license?: LicenseObject;
 }
 
-interface SecurityObject {
-  type: string;
-  scheme: string;
+
+interface FlowObjectDefaults {
+  refreshUrl?: string
+  scopes: { [key: string]: string }
 }
+type SecurityObject =
+  | {
+      description?: string
+    } & (
+      | {
+          type: "mutualTLS"
+        }
+      | {
+          type: "apiKey"
+          name: string
+          in: "query" | "header" | "cookie"
+        }
+      | {
+          type: "http"
+          scheme:
+            | "basic"
+            | "digest"
+            | "dpop"
+            | "hoba"
+            | "mutual"
+            | "negotiate"
+            | "oauth"
+            | "scram-sha-1"
+            | "scram-sha-256"
+            | "vapid"
+        }
+      | {
+          type: "http"
+          scheme: "bearer"
+          bearerFormat: string
+        }
+      | {
+          type: "oauth2"
+          flows: {
+            implicit?: FlowObjectDefaults & {
+              authorizationUrl: string
+            }
+            password?: FlowObjectDefaults & {
+              tokenUrl: string
+            }
+            clientCredentials?: FlowObjectDefaults & {
+              tokenUrl: string
+            }
+            authorizationCode?: FlowObjectDefaults & {
+              authorizationUrl: string
+              tokenUrl: string
+            }
+          }
+        }
+      | {
+          type: "openIdConnect"
+          openIdConnectUrl: string
+        }
+    )
+
+
 
 interface Security {
   [key: string]: SecurityObject;

package-lock.json

@@ -34,7 +34,7 @@ describe('Transform security schemas', () => {
     expect(result).toEqual(expected);
   });
 
-  it('Should return a security array and securitySchemes within components field', () => {
+  it('Should return a security array and securitySchemes within components field for http', () => {
     const input = {
       security: {
         BasicAuth: {
@@ -62,6 +62,66 @@ describe('Transform security schemas', () => {
     expect(result).toEqual(expected);
   });
 
+  it('Should return a security array and securitySchemes within components field for http', () => {
+    const input = {
+      security: {
+        HTTPAuth: {
+          type: 'http',
+          scheme: "basic",
+          bearerFormat: 'JWT'
+        },
+      },
+    };
+    const expected = {
+      security: [
+        {
+          HTTPAuth: [],
+        },
+      ],
+      components: {
+        securitySchemes: {
+          HTTPAuth: {
+            type: 'http',
+            scheme: "basic",
+            bearerFormat: 'JWT'
+          },
+        },
+      },
+    };
+    const result = parseSecuritySchemas(input);
+    expect(result).toEqual(expected);
+  });
+
+  it('Should return a security array and securitySchemes within components field for apiKey', () => {
+    const input = {
+      security: {
+        ApiKeyAuth: {
+          type: "apiKey",
+          in: "header",
+          name: "api_key",
+        },
+      },
+    };
+    const expected = {
+      security: [
+        {
+          ApiKeyAuth: [],
+        },
+      ],
+      components: {
+        securitySchemes: {
+          ApiKeyAuth: {
+            type: "apiKey",
+            in: "header",
+            name: "api_key",
+          },
+        },
+      },
+    };
+    const result = parseSecuritySchemas(input);
+    expect(result).toEqual(expected);
+  });
+
   it('Should return a security array and securitySchemes, both with each security type', () => {
     const input = {
       security: {