🏷️ move swagger-client types to d.ts

app/javascript/src/ActiveDocs/ThreeScaleApiDocs.ts

@@ -6,7 +6,8 @@ import { fetchData } from 'utilities/fetchData'
 import { safeFromJsonString } from 'utilities/json-utils'
 import { autocompleteRequestInterceptor } from 'ActiveDocs/OAS3Autocomplete'
 
-import type { ApiDocsServices, BackendApiReportBody, BackendApiTransaction, BodyValue, BodyValueObject, FormData, ExecuteData } from 'Types/SwaggerTypes'
+import type { ApiDocsServices, BackendApiReportBody, BackendApiTransaction, BodyValue, BodyValueObject, FormData } from 'Types/SwaggerTypes'
+import type { ExecuteData } from 'swagger-client/es/execute'
 import type { SwaggerUIPlugin } from 'swagger-ui'
 
 const getApiSpecUrl = (baseUrl: string, specPath: string): string => {
@@ -110,7 +111,7 @@ const RequestBodyTransformerPlugin: SwaggerUIPlugin = () => {
             && req.requestBody) {
           req.requestBody = transformReportRequestBody(req.requestBody as BackendApiReportBody)
         }
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-call
+
         return execute(req)
       }
     }

app/javascript/src/Types/SwaggerTypes.ts

@@ -1,5 +1,4 @@
 /* eslint-disable @typescript-eslint/naming-convention */
-import type { Request, Response, SupportedHTTPMethods } from 'swagger-ui'
 
 export type AccountData = Record<string, {
   name: string;
@@ -19,26 +18,6 @@ export interface ApiDocsServices {
   apis: ApiDocsService[];
 }
 
-export interface ExecuteData {
-  contextUrl: string;
-  fetch: (arg: unknown) => unknown;
-  method: SupportedHTTPMethods;
-  operation: unknown;
-  operationId: string;
-  parameters: unknown;
-  pathName: string;
-  requestBody?: unknown;
-  requestContentType: string;
-  requestInterceptor?: ((request: Request) => Promise<Request> | Request) | undefined;
-  responseContentType: string;
-  responseInterceptor?: ((response: Response) => Promise<Response> | Response) | undefined;
-  scheme: string;
-  securities: unknown;
-  server: string;
-  serverVariables: unknown;
-  spec: unknown;
-}
-
 export interface BackendApiTransaction extends BodyValueObject {
   app_id?: string;
   user_key?: string;

app/javascript/src/Types/swagger.d.ts

@@ -1,3 +1,27 @@
+// There are no official types for swagger-client. These has been inspired by:
+// - https://github.com/swagger-api/swagger-js/blob/master/src/execute/index.js
 declare module 'swagger-client/es/execute' {
-  export function execute (req: unknown): unknown
+  import type { Request, Response, SupportedHTTPMethods } from 'swagger-ui'
+
+  export interface ExecuteData {
+    contextUrl: string;
+    fetch: (arg: unknown) => unknown;
+    method: SupportedHTTPMethods;
+    operation: unknown;
+    operationId: string;
+    parameters: unknown;
+    pathName: string;
+    requestBody?: unknown;
+    requestContentType: string;
+    requestInterceptor?: ((request: Request) => Promise<Request> | Request) | undefined;
+    responseContentType: string;
+    responseInterceptor?: ((response: Response) => Promise<Response> | Response) | undefined;
+    scheme: string;
+    securities: unknown;
+    server: string;
+    serverVariables: unknown;
+    spec: unknown;
+  }
+  function execute (req: ExecuteData): unknown
+  export { execute }
 }