@grafana/openapi-to-k6 0.3.0 → 0.3.2

package/examples/post_request_with_query_params/split/exampleAPI.schemas.ts

@@ -1,26 +1,10 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.3.0
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.2
  * Do not edit manually.
  * Example API
  * API with a POST request having an object as the body and query parameters
  * Service version: 1.0.0
  */
-export type CreateExampleData201 = {
-  /** The data from the body */
-  data?: string
-  /** The active status from the query parameter */
-  isActive?: boolean
-  /** Response status */
-  status?: string
-  /** The user ID from the query parameter */
-  userId?: string
-}
-
-export type CreateExampleDataBody = {
-  /** A string field representing data */
-  data: string
-}
-
 export type CreateExampleDataParams = {
   /**
    * A string query parameter for user ID
@@ -31,3 +15,19 @@ export type CreateExampleDataParams = {
    */
   isActive?: boolean
 }
+
+export type CreateExampleDataBody = {
+  /** A string field representing data */
+  data: string
+}
+
+export type CreateExampleData201 = {
+  /** The user ID from the query parameter */
+  userId?: string
+  /** The active status from the query parameter */
+  isActive?: boolean
+  /** The data from the body */
+  data?: string
+  /** Response status */
+  status?: string
+}

package/examples/post_request_with_query_params/split/exampleAPI.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.3.0
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.2
  * Do not edit manually.
  * Example API
  * API with a POST request having an object as the body and query parameters
@@ -26,6 +26,8 @@ export class ExampleAPIClient {
     commonRequestParameters?: Params
   }) {
     this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+
+    this.commonRequestParameters = clientOptions.commonRequestParameters || {}
   }
 
   /**
@@ -56,8 +58,8 @@ export class ExampleAPIClient {
       {
         ...mergedRequestParameters,
         headers: {
-          'Content-Type': 'application/json',
           ...mergedRequestParameters?.headers,
+          'Content-Type': 'application/json',
         },
       }
     )

package/examples/post_request_with_query_params/tags/default.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.3.0
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.2
  * Do not edit manually.
  * Example API
  * API with a POST request having an object as the body and query parameters
@@ -26,6 +26,8 @@ export class DefaultClient {
     commonRequestParameters?: Params
   }) {
     this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+
+    this.commonRequestParameters = clientOptions.commonRequestParameters || {}
   }
 
   /**
@@ -56,8 +58,8 @@ export class DefaultClient {
       {
         ...mergedRequestParameters,
         headers: {
-          'Content-Type': 'application/json',
           ...mergedRequestParameters?.headers,
+          'Content-Type': 'application/json',
         },
       }
     )

package/examples/post_request_with_query_params/tags/exampleAPI.schemas.ts

@@ -1,26 +1,10 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.3.0
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.2
  * Do not edit manually.
  * Example API
  * API with a POST request having an object as the body and query parameters
  * Service version: 1.0.0
  */
-export type CreateExampleData201 = {
-  /** The data from the body */
-  data?: string
-  /** The active status from the query parameter */
-  isActive?: boolean
-  /** Response status */
-  status?: string
-  /** The user ID from the query parameter */
-  userId?: string
-}
-
-export type CreateExampleDataBody = {
-  /** A string field representing data */
-  data: string
-}
-
 export type CreateExampleDataParams = {
   /**
    * A string query parameter for user ID
@@ -31,3 +15,19 @@ export type CreateExampleDataParams = {
    */
   isActive?: boolean
 }
+
+export type CreateExampleDataBody = {
+  /** A string field representing data */
+  data: string
+}
+
+export type CreateExampleData201 = {
+  /** The user ID from the query parameter */
+  userId?: string
+  /** The active status from the query parameter */
+  isActive?: boolean
+  /** The data from the body */
+  data?: string
+  /** Response status */
+  status?: string
+}

package/examples/query_params_schema/single/exampleAPI.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.3.0
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.2
  * Do not edit manually.
  * Example API
  * API with all formats of query parameters
@@ -8,14 +8,6 @@
 import { URL, URLSearchParams } from 'https://jslib.k6.io/url/1.0.0/index.js'
 import http from 'k6/http'
 import type { Params, Response } from 'k6/http'
-export type GetExampleData200 = {
-  age?: number
-  date?: string
-  isActive?: boolean
-  name?: string
-  tags?: string[]
-}
-
 export type GetExampleDataParams = {
   /**
    * A string parameter
@@ -39,6 +31,14 @@ export type GetExampleDataParams = {
   date?: string
 }
 
+export type GetExampleData200 = {
+  name?: string
+  age?: number
+  isActive?: boolean
+  tags?: string[]
+  date?: string
+}
+
 /**
  * This is the base client to use for interacting with the API.
  */
@@ -51,6 +51,8 @@ export class ExampleAPIClient {
     commonRequestParameters?: Params
   }) {
     this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+
+    this.commonRequestParameters = clientOptions.commonRequestParameters || {}
   }
 
   /**

package/examples/query_params_schema/split/exampleAPI.schemas.ts

@@ -1,18 +1,10 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.3.0
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.2
  * Do not edit manually.
  * Example API
  * API with all formats of query parameters
  * Service version: 1.0.0
  */
-export type GetExampleData200 = {
-  age?: number
-  date?: string
-  isActive?: boolean
-  name?: string
-  tags?: string[]
-}
-
 export type GetExampleDataParams = {
   /**
    * A string parameter
@@ -35,3 +27,11 @@ export type GetExampleDataParams = {
    */
   date?: string
 }
+
+export type GetExampleData200 = {
+  name?: string
+  age?: number
+  isActive?: boolean
+  tags?: string[]
+  date?: string
+}

package/examples/query_params_schema/split/exampleAPI.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.3.0
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.2
  * Do not edit manually.
  * Example API
  * API with all formats of query parameters
@@ -25,6 +25,8 @@ export class ExampleAPIClient {
     commonRequestParameters?: Params
   }) {
     this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+
+    this.commonRequestParameters = clientOptions.commonRequestParameters || {}
   }
 
   /**

package/examples/query_params_schema/tags/default.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.3.0
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.2
  * Do not edit manually.
  * Example API
  * API with all formats of query parameters
@@ -25,6 +25,8 @@ export class DefaultClient {
     commonRequestParameters?: Params
   }) {
     this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+
+    this.commonRequestParameters = clientOptions.commonRequestParameters || {}
   }
 
   /**

package/examples/query_params_schema/tags/exampleAPI.schemas.ts

@@ -1,18 +1,10 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.3.0
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.2
  * Do not edit manually.
  * Example API
  * API with all formats of query parameters
  * Service version: 1.0.0
  */
-export type GetExampleData200 = {
-  age?: number
-  date?: string
-  isActive?: boolean
-  name?: string
-  tags?: string[]
-}
-
 export type GetExampleDataParams = {
   /**
    * A string parameter
@@ -35,3 +27,11 @@ export type GetExampleDataParams = {
    */
   date?: string
 }
+
+export type GetExampleData200 = {
+  name?: string
+  age?: number
+  isActive?: boolean
+  tags?: string[]
+  date?: string
+}

package/examples/simple_post_request_schema/single/exampleAPI.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.3.0
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.2
  * Do not edit manually.
  * Example API
  * API with all formats of data in the POST request body
@@ -8,22 +8,6 @@
 import { URL } from 'https://jslib.k6.io/url/1.0.0/index.js'
 import http from 'k6/http'
 import type { Params, Response } from 'k6/http'
-export type CreateExampleData201Meta = {
-  createdBy?: string
-  updatedBy?: string
-}
-
-export type CreateExampleData201 = {
-  age?: number
-  date?: string
-  /** The unique ID of the created resource */
-  id?: string
-  isActive?: boolean
-  meta?: CreateExampleData201Meta
-  name?: string
-  tags?: string[]
-}
-
 /**
  * An object parameter containing metadata
  */
@@ -35,18 +19,34 @@ export type CreateExampleDataBodyMeta = {
 }
 
 export type CreateExampleDataBody = {
+  /** A string parameter */
+  name: string
   /** An integer parameter */
   age: number
-  /** A date parameter in YYYY-MM-DD format */
-  date?: string
   /** A boolean parameter */
   isActive: boolean
+  /** An array of strings */
+  tags?: string[]
+  /** A date parameter in YYYY-MM-DD format */
+  date?: string
   /** An object parameter containing metadata */
   meta?: CreateExampleDataBodyMeta
-  /** A string parameter */
-  name: string
-  /** An array of strings */
+}
+
+export type CreateExampleData201Meta = {
+  createdBy?: string
+  updatedBy?: string
+}
+
+export type CreateExampleData201 = {
+  /** The unique ID of the created resource */
+  id?: string
+  name?: string
+  age?: number
+  isActive?: boolean
   tags?: string[]
+  date?: string
+  meta?: CreateExampleData201Meta
 }
 
 /**
@@ -61,6 +61,8 @@ export class ExampleAPIClient {
     commonRequestParameters?: Params
   }) {
     this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+
+    this.commonRequestParameters = clientOptions.commonRequestParameters || {}
   }
 
   /**
@@ -86,8 +88,8 @@ export class ExampleAPIClient {
       {
         ...mergedRequestParameters,
         headers: {
-          'Content-Type': 'application/json',
           ...mergedRequestParameters?.headers,
+          'Content-Type': 'application/json',
         },
       }
     )

package/examples/simple_post_request_schema/split/exampleAPI.schemas.ts

@@ -1,26 +1,10 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.3.0
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.2
  * Do not edit manually.
  * Example API
  * API with all formats of data in the POST request body
  * Service version: 1.0.0
  */
-export type CreateExampleData201Meta = {
-  createdBy?: string
-  updatedBy?: string
-}
-
-export type CreateExampleData201 = {
-  age?: number
-  date?: string
-  /** The unique ID of the created resource */
-  id?: string
-  isActive?: boolean
-  meta?: CreateExampleData201Meta
-  name?: string
-  tags?: string[]
-}
-
 /**
  * An object parameter containing metadata
  */
@@ -32,16 +16,32 @@ export type CreateExampleDataBodyMeta = {
 }
 
 export type CreateExampleDataBody = {
+  /** A string parameter */
+  name: string
   /** An integer parameter */
   age: number
-  /** A date parameter in YYYY-MM-DD format */
-  date?: string
   /** A boolean parameter */
   isActive: boolean
+  /** An array of strings */
+  tags?: string[]
+  /** A date parameter in YYYY-MM-DD format */
+  date?: string
   /** An object parameter containing metadata */
   meta?: CreateExampleDataBodyMeta
-  /** A string parameter */
-  name: string
-  /** An array of strings */
+}
+
+export type CreateExampleData201Meta = {
+  createdBy?: string
+  updatedBy?: string
+}
+
+export type CreateExampleData201 = {
+  /** The unique ID of the created resource */
+  id?: string
+  name?: string
+  age?: number
+  isActive?: boolean
   tags?: string[]
+  date?: string
+  meta?: CreateExampleData201Meta
 }

package/examples/simple_post_request_schema/split/exampleAPI.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.3.0
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.2
  * Do not edit manually.
  * Example API
  * API with all formats of data in the POST request body
@@ -25,6 +25,8 @@ export class ExampleAPIClient {
     commonRequestParameters?: Params
   }) {
     this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+
+    this.commonRequestParameters = clientOptions.commonRequestParameters || {}
   }
 
   /**
@@ -50,8 +52,8 @@ export class ExampleAPIClient {
       {
         ...mergedRequestParameters,
         headers: {
-          'Content-Type': 'application/json',
           ...mergedRequestParameters?.headers,
+          'Content-Type': 'application/json',
         },
       }
     )

package/examples/simple_post_request_schema/tags/default.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.3.0
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.2
  * Do not edit manually.
  * Example API
  * API with all formats of data in the POST request body
@@ -25,6 +25,8 @@ export class DefaultClient {
     commonRequestParameters?: Params
   }) {
     this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+
+    this.commonRequestParameters = clientOptions.commonRequestParameters || {}
   }
 
   /**
@@ -50,8 +52,8 @@ export class DefaultClient {
       {
         ...mergedRequestParameters,
         headers: {
-          'Content-Type': 'application/json',
           ...mergedRequestParameters?.headers,
+          'Content-Type': 'application/json',
         },
       }
     )

package/examples/simple_post_request_schema/tags/exampleAPI.schemas.ts

@@ -1,26 +1,10 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.3.0
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.2
  * Do not edit manually.
  * Example API
  * API with all formats of data in the POST request body
  * Service version: 1.0.0
  */
-export type CreateExampleData201Meta = {
-  createdBy?: string
-  updatedBy?: string
-}
-
-export type CreateExampleData201 = {
-  age?: number
-  date?: string
-  /** The unique ID of the created resource */
-  id?: string
-  isActive?: boolean
-  meta?: CreateExampleData201Meta
-  name?: string
-  tags?: string[]
-}
-
 /**
  * An object parameter containing metadata
  */
@@ -32,16 +16,32 @@ export type CreateExampleDataBodyMeta = {
 }
 
 export type CreateExampleDataBody = {
+  /** A string parameter */
+  name: string
   /** An integer parameter */
   age: number
-  /** A date parameter in YYYY-MM-DD format */
-  date?: string
   /** A boolean parameter */
   isActive: boolean
+  /** An array of strings */
+  tags?: string[]
+  /** A date parameter in YYYY-MM-DD format */
+  date?: string
   /** An object parameter containing metadata */
   meta?: CreateExampleDataBodyMeta
-  /** A string parameter */
-  name: string
-  /** An array of strings */
+}
+
+export type CreateExampleData201Meta = {
+  createdBy?: string
+  updatedBy?: string
+}
+
+export type CreateExampleData201 = {
+  /** The unique ID of the created resource */
+  id?: string
+  name?: string
+  age?: number
+  isActive?: boolean
   tags?: string[]
+  date?: string
+  meta?: CreateExampleData201Meta
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/openapi-to-k6",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "description": "A CLI tool to generate helper modules for K6 from OpenAPI schema",
   "main": "dist/cli.js",
   "bin": {
@@ -28,7 +28,7 @@
     "commander": "^12.1.0",
     "handlebars": "^4.7.8",
     "openapi-typescript": "^7.4.1",
-    "orval": "^7.2.0",
+    "orval": "^7.5.0",
     "prettier": "^3.3.3",
     "uuid": "^10.0.0"
   },
@@ -47,6 +47,7 @@
     "prettier": "^3.3.3",
     "ts-node": "^10.9.2",
     "typescript": "^5.6.2",
+    "vite-tsconfig-paths": "^5.1.4",
     "vitest": "^2.1.3"
   },
   "lint-staged": {

package/src/generator/index.ts

@@ -27,7 +27,10 @@ const generatedFileHeaderGenerator = (info: InfoObject) => {
   ]
 }
 
-const afterAllFilesWriteHandler = async (filePaths: string[]) => {
+const afterAllFilesWriteHandler = async (
+  filePaths: string[],
+  outputOverrider: OutputOverrider
+) => {
   const removeSingleFile = (filePath: string) => {
     try {
       fs.unlinkSync(filePath)
@@ -53,8 +56,13 @@ const afterAllFilesWriteHandler = async (filePaths: string[]) => {
       removeSingleFile(filePath)
       continue
     }
-
-    await formatFileWithPrettier(filePath)
+    try {
+      await formatFileWithPrettier(filePath)
+    } catch (error) {
+      await outputOverrider.temporarilyWriteToStdoutAndStderr(async () => {
+        logger.error(`Error in formatting file ${filePath}: ${error}`)
+      })
+    }
 
     const fileName = path.basename(filePath)
 
@@ -125,7 +133,10 @@ export default async ({
       },
       hooks: {
         afterAllFilesWrite: async (filePaths: string[]) => {
-          const filteredFilePaths = await afterAllFilesWriteHandler(filePaths)
+          const filteredFilePaths = await afterAllFilesWriteHandler(
+            filePaths,
+            outputOverrider
+          )
           generatedFilePaths.push(...filteredFilePaths)
         },
       },
@@ -135,8 +146,10 @@ export default async ({
   if (generatedFilePaths.length === 0) {
     const tagsMessage =
       tags?.length && tags.length > 0
-        ? ` Applied tag filter(s): ${tags.join(', ')}`
-        : ''
-    throw new NoFilesGeneratedError(`No files were generated.${tagsMessage}`)
+        ? ` Applied tag filter(s): ${tags.join(', ')}. `
+        : ' '
+    throw new NoFilesGeneratedError(
+      `No files were generated.${tagsMessage}Try running with --verbose flag to get more details.`
+    )
   }
 }

package/src/generator/k6Client.ts

@@ -102,6 +102,7 @@ const _getRequestParamsValue = ({
   // Expand the headers
   if (body.contentType || headers) {
     let headersValue = `\n       headers: {`
+    headersValue += '\n...mergedRequestParameters?.headers,'
     if (body.contentType) {
       if (body.formData) {
         headersValue += `\n'Content-Type': '${body.contentType}; boundary=' + formData.boundary,`
@@ -115,7 +116,7 @@ const _getRequestParamsValue = ({
       headersValue += `\n...Object.fromEntries(Object.entries(headers || {}).map(([key, value]) => [key, String(value)])),`
     }
 
-    headersValue += `\n...mergedRequestParameters?.headers},`
+    headersValue += `\n},`
     value += headersValue
   }
 
@@ -270,6 +271,7 @@ const generateK6Header: ClientHeaderBuilder = ({ title }) => {
     commonRequestParameters?: Params
 }) {
        this.cleanBaseUrl = clientOptions.baseUrl.replace(/\\/+$/, '');\n
+       this.commonRequestParameters = clientOptions.commonRequestParameters || {};
       }\n
 `
 }

package/src/helper.ts

@@ -123,6 +123,23 @@ export class OutputOverrider {
     process.stdout.write = this.originalStdoutWrite
     process.stderr.write = this.originalStderrWrite
   }
+
+  // Method to temporarily write to stdout and stderr
+  public async temporarilyWriteToStdoutAndStderr(
+    callback: () => Promise<void>
+  ) {
+    const currentStdoutWrite = process.stdout.write
+    const currentStderrWrite = process.stderr.write
+
+    process.stdout.write = this.originalStdoutWrite
+    process.stderr.write = this.originalStderrWrite
+    try {
+      await callback()
+    } finally {
+      process.stdout.write = currentStdoutWrite
+      process.stderr.write = currentStderrWrite
+    }
+  }
 }
 
 /**