@grafana/openapi-to-k6 0.3.0 → 0.3.2

package/dist/generator/index.js

@@ -31,7 +31,7 @@ const generatedFileHeaderGenerator = (info) => {
         ...(info.version ? [`Service version: ${info.version}`] : []),
     ];
 };
-const afterAllFilesWriteHandler = (filePaths) => __awaiter(void 0, void 0, void 0, function* () {
+const afterAllFilesWriteHandler = (filePaths, outputOverrider) => __awaiter(void 0, void 0, void 0, function* () {
     const removeSingleFile = (filePath) => {
         try {
             fs_1.default.unlinkSync(filePath);
@@ -54,7 +54,14 @@ const afterAllFilesWriteHandler = (filePaths) => __awaiter(void 0, void 0, void
             removeSingleFile(filePath);
             continue;
         }
-        yield (0, helper_1.formatFileWithPrettier)(filePath);
+        try {
+            yield (0, helper_1.formatFileWithPrettier)(filePath);
+        }
+        catch (error) {
+            yield outputOverrider.temporarilyWriteToStdoutAndStderr(() => __awaiter(void 0, void 0, void 0, function* () {
+                logger_1.logger.error(`Error in formatting file ${filePath}: ${error}`);
+            }));
+        }
         const fileName = path_1.default.basename(filePath);
         if (fileName === '.ts') {
             // Generated SDK had no name because there was no title in the schema
@@ -102,7 +109,7 @@ exports.default = (_a) => __awaiter(void 0, [_a], void 0, function* ({ openApiPa
             },
             hooks: {
                 afterAllFilesWrite: (filePaths) => __awaiter(void 0, void 0, void 0, function* () {
-                    const filteredFilePaths = yield afterAllFilesWriteHandler(filePaths);
+                    const filteredFilePaths = yield afterAllFilesWriteHandler(filePaths, outputOverrider);
                     generatedFilePaths.push(...filteredFilePaths);
                 }),
             },
@@ -110,8 +117,8 @@ exports.default = (_a) => __awaiter(void 0, [_a], void 0, function* ({ openApiPa
     }));
     if (generatedFilePaths.length === 0) {
         const tagsMessage = (tags === null || tags === void 0 ? void 0 : tags.length) && tags.length > 0
-            ? ` Applied tag filter(s): ${tags.join(', ')}`
-            : '';
-        throw new errors_1.NoFilesGeneratedError(`No files were generated.${tagsMessage}`);
+            ? ` Applied tag filter(s): ${tags.join(', ')}. `
+            : ' ';
+        throw new errors_1.NoFilesGeneratedError(`No files were generated.${tagsMessage}Try running with --verbose flag to get more details.`);
     }
 });

package/dist/generator/k6Client.js

@@ -70,6 +70,7 @@ const _getRequestParamsValue = ({ response, queryParams, headers, body, }) => {
     // 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,`;
@@ -82,7 +83,7 @@ const _getRequestParamsValue = ({ response, queryParams, headers, body, }) => {
             headersValue += `\n// In the schema, headers can be of any type like number but k6 accepts only strings as headers, hence converting all headers to string`;
             headersValue += `\n...Object.fromEntries(Object.entries(headers || {}).map(([key, value]) => [key, String(value)])),`;
         }
-        headersValue += `\n...mergedRequestParameters?.headers},`;
+        headersValue += `\n},`;
         value += headersValue;
     }
     return `{${value}}`;
@@ -210,6 +211,7 @@ const generateK6Header = ({ title }) => {
     commonRequestParameters?: Params
 }) {
        this.cleanBaseUrl = clientOptions.baseUrl.replace(/\\/+$/, '');\n
+       this.commonRequestParameters = clientOptions.commonRequestParameters || {};
       }\n
 `;
 };

package/dist/helper.js

@@ -123,6 +123,22 @@ class OutputOverrider {
         process.stdout.write = this.originalStdoutWrite;
         process.stderr.write = this.originalStderrWrite;
     }
+    // Method to temporarily write to stdout and stderr
+    temporarilyWriteToStdoutAndStderr(callback) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const currentStdoutWrite = process.stdout.write;
+            const currentStderrWrite = process.stderr.write;
+            process.stdout.write = this.originalStdoutWrite;
+            process.stderr.write = this.originalStderrWrite;
+            try {
+                yield callback();
+            }
+            finally {
+                process.stdout.write = currentStdoutWrite;
+                process.stderr.write = currentStderrWrite;
+            }
+        });
+    }
 }
 exports.OutputOverrider = OutputOverrider;
 OutputOverrider.instance = null;

package/examples/basic_schema/schema.json

@@ -18,7 +18,8 @@
                   "properties": {
                     "message": {
                       "type": "string",
-                      "example": "Hello, World!"
+                      "example": "Hello, World!",
+                       "pattern": "^([a-zA-Z_][a-zA-Z0-9_-]*:)?([a-zA-Z_][a-zA-Z0-9_-]*/)?([a-zA-Z_][.a-zA-Z0-9_-]*)$"
                     }
                   }
                 }

package/examples/basic_schema/single/simpleAPI.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.
  * Simple API
  * Service version: 1.0.0
@@ -8,6 +8,7 @@ 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 GetExample200 = {
+  /** @pattern ^([a-zA-Z_][a-zA-Z0-9_-]*:)?([a-zA-Z_][a-zA-Z0-9_-]*\/)?([a-zA-Z_][.a-zA-Z0-9_-]*)$ */
   message?: string
 }
 
@@ -23,6 +24,8 @@ export class SimpleAPIClient {
     commonRequestParameters?: Params
   }) {
     this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+
+    this.commonRequestParameters = clientOptions.commonRequestParameters || {}
   }
 
   /**

package/examples/basic_schema/split/simpleAPI.schemas.ts

@@ -1,9 +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.
  * Simple API
  * Service version: 1.0.0
  */
 export type GetExample200 = {
+  /** @pattern ^([a-zA-Z_][a-zA-Z0-9_-]*:)?([a-zA-Z_][a-zA-Z0-9_-]*\/)?([a-zA-Z_][.a-zA-Z0-9_-]*)$ */
   message?: string
 }

package/examples/basic_schema/split/simpleAPI.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.
  * Simple API
  * Service version: 1.0.0
@@ -21,6 +21,8 @@ export class SimpleAPIClient {
     commonRequestParameters?: Params
   }) {
     this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+
+    this.commonRequestParameters = clientOptions.commonRequestParameters || {}
   }
 
   /**

package/examples/basic_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.
  * Simple API
  * Service version: 1.0.0
@@ -21,6 +21,8 @@ export class DefaultClient {
     commonRequestParameters?: Params
   }) {
     this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+
+    this.commonRequestParameters = clientOptions.commonRequestParameters || {}
   }
 
   /**

package/examples/basic_schema/tags/simpleAPI.schemas.ts

@@ -1,9 +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.
  * Simple API
  * Service version: 1.0.0
  */
 export type GetExample200 = {
+  /** @pattern ^([a-zA-Z_][a-zA-Z0-9_-]*:)?([a-zA-Z_][a-zA-Z0-9_-]*\/)?([a-zA-Z_][.a-zA-Z0-9_-]*)$ */
   message?: string
 }

package/examples/form_data_schema/single/formDataAPI.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.
  * Form Data API
  * Service version: 1.0.0
@@ -8,23 +8,23 @@ import { FormData } from 'https://jslib.k6.io/formdata/0.0.2/index.js'
 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 PostUpload400 = {
-  error?: string
-  success?: boolean
+export type PostUploadBody = {
+  /** File to upload */
+  file: Blob
+  /** Description of the file */
+  description?: string
+  /** User ID associated with the upload */
+  userId: string
 }
 
 export type PostUpload200 = {
-  message?: string
   success?: boolean
+  message?: string
 }
 
-export type PostUploadBody = {
-  /** Description of the file */
-  description?: string
-  /** File to upload */
-  file: Blob
-  /** User ID associated with the upload */
-  userId: string
+export type PostUpload400 = {
+  success?: boolean
+  error?: string
 }
 
 /**
@@ -39,6 +39,8 @@ export class FormDataAPIClient {
     commonRequestParameters?: Params
   }) {
     this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+
+    this.commonRequestParameters = clientOptions.commonRequestParameters || {}
   }
 
   /**
@@ -67,8 +69,8 @@ export class FormDataAPIClient {
     const response = http.request('POST', url.toString(), formData.body(), {
       ...mergedRequestParameters,
       headers: {
-        'Content-Type': 'multipart/form-data; boundary=' + formData.boundary,
         ...mergedRequestParameters?.headers,
+        'Content-Type': 'multipart/form-data; boundary=' + formData.boundary,
       },
     })
     let data

package/examples/form_data_schema/split/formDataAPI.schemas.ts

@@ -1,24 +1,24 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.3.0
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.2
  * Do not edit manually.
  * Form Data API
  * Service version: 1.0.0
  */
-export type PostUpload400 = {
-  error?: string
-  success?: boolean
+export type PostUploadBody = {
+  /** File to upload */
+  file: Blob
+  /** Description of the file */
+  description?: string
+  /** User ID associated with the upload */
+  userId: string
 }
 
 export type PostUpload200 = {
-  message?: string
   success?: boolean
+  message?: string
 }
 
-export type PostUploadBody = {
-  /** Description of the file */
-  description?: string
-  /** File to upload */
-  file: Blob
-  /** User ID associated with the upload */
-  userId: string
+export type PostUpload400 = {
+  success?: boolean
+  error?: string
 }

package/examples/form_data_schema/split/formDataAPI.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.
  * Form Data API
  * Service version: 1.0.0
@@ -22,6 +22,8 @@ export class FormDataAPIClient {
     commonRequestParameters?: Params
   }) {
     this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+
+    this.commonRequestParameters = clientOptions.commonRequestParameters || {}
   }
 
   /**
@@ -50,8 +52,8 @@ export class FormDataAPIClient {
     const response = http.request('POST', url.toString(), formData.body(), {
       ...mergedRequestParameters,
       headers: {
-        'Content-Type': 'multipart/form-data; boundary=' + formData.boundary,
         ...mergedRequestParameters?.headers,
+        'Content-Type': 'multipart/form-data; boundary=' + formData.boundary,
       },
     })
     let data

package/examples/form_data_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.
  * Form Data API
  * Service version: 1.0.0
@@ -22,6 +22,8 @@ export class DefaultClient {
     commonRequestParameters?: Params
   }) {
     this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+
+    this.commonRequestParameters = clientOptions.commonRequestParameters || {}
   }
 
   /**
@@ -50,8 +52,8 @@ export class DefaultClient {
     const response = http.request('POST', url.toString(), formData.body(), {
       ...mergedRequestParameters,
       headers: {
-        'Content-Type': 'multipart/form-data; boundary=' + formData.boundary,
         ...mergedRequestParameters?.headers,
+        'Content-Type': 'multipart/form-data; boundary=' + formData.boundary,
       },
     })
     let data

package/examples/form_data_schema/tags/formDataAPI.schemas.ts

@@ -1,24 +1,24 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.3.0
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.2
  * Do not edit manually.
  * Form Data API
  * Service version: 1.0.0
  */
-export type PostUpload400 = {
-  error?: string
-  success?: boolean
+export type PostUploadBody = {
+  /** File to upload */
+  file: Blob
+  /** Description of the file */
+  description?: string
+  /** User ID associated with the upload */
+  userId: string
 }
 
 export type PostUpload200 = {
-  message?: string
   success?: boolean
+  message?: string
 }
 
-export type PostUploadBody = {
-  /** Description of the file */
-  description?: string
-  /** File to upload */
-  file: Blob
-  /** User ID associated with the upload */
-  userId: string
+export type PostUpload400 = {
+  success?: boolean
+  error?: string
 }

package/examples/form_url_encoded_data_schema/single/formURLEncodedAPI.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.
  * Form URL Encoded API
  * Service version: 1.0.0
@@ -7,23 +7,23 @@
 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 PostSubmitForm400 = {
-  error?: string
-  success?: boolean
+export type PostSubmitFormBody = {
+  /** Name of the user */
+  name: string
+  /** Age of the user */
+  age?: number
+  /** Email address of the user */
+  email: string
 }
 
 export type PostSubmitForm200 = {
-  message?: string
   success?: boolean
+  message?: string
 }
 
-export type PostSubmitFormBody = {
-  /** Age of the user */
-  age?: number
-  /** Email address of the user */
-  email: string
-  /** Name of the user */
-  name: string
+export type PostSubmitForm400 = {
+  success?: boolean
+  error?: string
 }
 
 /**
@@ -38,6 +38,8 @@ export class FormURLEncodedAPIClient {
     commonRequestParameters?: Params
   }) {
     this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+
+    this.commonRequestParameters = clientOptions.commonRequestParameters || {}
   }
 
   /**
@@ -63,8 +65,8 @@ export class FormURLEncodedAPIClient {
       {
         ...mergedRequestParameters,
         headers: {
-          'Content-Type': 'application/x-www-form-urlencoded',
           ...mergedRequestParameters?.headers,
+          'Content-Type': 'application/x-www-form-urlencoded',
         },
       }
     )

package/examples/form_url_encoded_data_schema/split/formURLEncodedAPI.schemas.ts

@@ -1,24 +1,24 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.3.0
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.2
  * Do not edit manually.
  * Form URL Encoded API
  * Service version: 1.0.0
  */
-export type PostSubmitForm400 = {
-  error?: string
-  success?: boolean
+export type PostSubmitFormBody = {
+  /** Name of the user */
+  name: string
+  /** Age of the user */
+  age?: number
+  /** Email address of the user */
+  email: string
 }
 
 export type PostSubmitForm200 = {
-  message?: string
   success?: boolean
+  message?: string
 }
 
-export type PostSubmitFormBody = {
-  /** Age of the user */
-  age?: number
-  /** Email address of the user */
-  email: string
-  /** Name of the user */
-  name: string
+export type PostSubmitForm400 = {
+  success?: boolean
+  error?: string
 }

package/examples/form_url_encoded_data_schema/split/formURLEncodedAPI.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.
  * Form URL Encoded API
  * Service version: 1.0.0
@@ -24,6 +24,8 @@ export class FormURLEncodedAPIClient {
     commonRequestParameters?: Params
   }) {
     this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+
+    this.commonRequestParameters = clientOptions.commonRequestParameters || {}
   }
 
   /**
@@ -49,8 +51,8 @@ export class FormURLEncodedAPIClient {
       {
         ...mergedRequestParameters,
         headers: {
-          'Content-Type': 'application/x-www-form-urlencoded',
           ...mergedRequestParameters?.headers,
+          'Content-Type': 'application/x-www-form-urlencoded',
         },
       }
     )

package/examples/form_url_encoded_data_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.
  * Form URL Encoded API
  * Service version: 1.0.0
@@ -24,6 +24,8 @@ export class DefaultClient {
     commonRequestParameters?: Params
   }) {
     this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+
+    this.commonRequestParameters = clientOptions.commonRequestParameters || {}
   }
 
   /**
@@ -49,8 +51,8 @@ export class DefaultClient {
       {
         ...mergedRequestParameters,
         headers: {
-          'Content-Type': 'application/x-www-form-urlencoded',
           ...mergedRequestParameters?.headers,
+          'Content-Type': 'application/x-www-form-urlencoded',
         },
       }
     )

package/examples/form_url_encoded_data_schema/tags/formURLEncodedAPI.schemas.ts

@@ -1,24 +1,24 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.3.0
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.2
  * Do not edit manually.
  * Form URL Encoded API
  * Service version: 1.0.0
  */
-export type PostSubmitForm400 = {
-  error?: string
-  success?: boolean
+export type PostSubmitFormBody = {
+  /** Name of the user */
+  name: string
+  /** Age of the user */
+  age?: number
+  /** Email address of the user */
+  email: string
 }
 
 export type PostSubmitForm200 = {
-  message?: string
   success?: boolean
+  message?: string
 }
 
-export type PostSubmitFormBody = {
-  /** Age of the user */
-  age?: number
-  /** Email address of the user */
-  email: string
-  /** Name of the user */
-  name: string
+export type PostSubmitForm400 = {
+  success?: boolean
+  error?: string
 }

package/examples/form_url_encoded_data_with_query_params_schema/single/formURLEncodedAPIWithQueryParameters.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.
  * Form URL Encoded API with Query Parameters
  * Service version: 1.0.0
@@ -7,25 +7,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 PostSubmitForm400 = {
-  error?: string
-  success?: boolean
-}
-
-export type PostSubmitForm200 = {
-  message?: string
-  success?: boolean
-}
-
-export type PostSubmitFormBody = {
-  /** Age of the user */
-  age?: number
-  /** Email address of the user */
-  email: string
-  /** Name of the user */
-  name: string
-}
-
 export type PostSubmitFormParams = {
   /**
    * Authentication token
@@ -37,6 +18,25 @@ export type PostSubmitFormParams = {
   locale?: string
 }
 
+export type PostSubmitFormBody = {
+  /** Name of the user */
+  name: string
+  /** Age of the user */
+  age?: number
+  /** Email address of the user */
+  email: string
+}
+
+export type PostSubmitForm200 = {
+  success?: boolean
+  message?: string
+}
+
+export type PostSubmitForm400 = {
+  success?: boolean
+  error?: string
+}
+
 /**
  * This is the base client to use for interacting with the API.
  */
@@ -49,6 +49,8 @@ export class FormURLEncodedAPIWithQueryParametersClient {
     commonRequestParameters?: Params
   }) {
     this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+
+    this.commonRequestParameters = clientOptions.commonRequestParameters || {}
   }
 
   /**
@@ -79,8 +81,8 @@ export class FormURLEncodedAPIWithQueryParametersClient {
       {
         ...mergedRequestParameters,
         headers: {
-          'Content-Type': 'application/x-www-form-urlencoded',
           ...mergedRequestParameters?.headers,
+          'Content-Type': 'application/x-www-form-urlencoded',
         },
       }
     )