@spartaficial/openapi-to-k6 0.0.0-stage → 1.0.0

package/dist/runtime.d.cts

@@ -0,0 +1,131 @@
+/*!
+ * Copyright (c) 2026 Spartaficial - Cerios. All rights reserved.
+ * Proprietary software, licensed not sold. Unauthorized use, redistribution or
+ * circumvention of licensing is prohibited. See LICENSE for details.
+ */
+import { Params, Params as Params$1, RequestBody, Response } from "k6/http";
+/**
+ * K6 service result type - combines HTTP response with parsed data and status check result
+ * Used as return type for service methods
+ *
+ * @template T - The type of the parsed response data (from generated types)
+ *
+ * @example
+ * ```typescript
+ * // Service method returns K6ServiceResult<User>
+ * const result = service.getUserById("123");
+ * if (result.ok) {
+ *   console.log(result.data.name); // data is typed as User
+ * } else {
+ *   console.log(`Request failed with status: ${result.response.status}`);
+ * }
+ * ```
+ */
+export interface K6ServiceResult<T> {
+  /** The raw K6 HTTP response */
+  response: Response;
+  /** The parsed response data */
+  data: T;
+  /** Whether the status code check passed */
+  ok: boolean;
+}
+/**
+ * Query string parameters
+ * Supports primitives, arrays, or undefined values
+ */
+export type QueryParams = Record<string, string | number | boolean | string[] | number[] | boolean[] | Record<string, string | number | boolean | null | undefined> | undefined | null>;
+/**
+ * Serialization styles OpenAPI defines for query parameters
+ */
+export type QueryParameterStyle = "form" | "spaceDelimited" | "pipeDelimited" | "deepObject";
+/**
+ * How a single parameter should be serialized
+ */
+export interface ParameterSerialization {
+  style: QueryParameterStyle;
+  explode: boolean;
+  /**
+   * Leave RFC 3986 reserved characters unencoded in the value
+   *
+   * @default false
+   */
+  allowReserved?: boolean;
+}
+/**
+ * Per-parameter serialization, keyed by parameter name. Generated clients pass entries only
+ * for parameters that deviate from the OpenAPI default (form with explode: true).
+ */
+export type ParameterSerializationMap = Record<string, ParameterSerialization>;
+/**
+ * Merges request parameters with common parameters
+ * Request-specific parameters take precedence over common parameters
+ *
+ * Deep-merges nested object properties: headers, tags, cookies
+ *
+ * @param requestParams - Request-specific K6 parameters
+ * @param commonParams - Common K6 parameters set on the client
+ * @returns Merged parameters with request params taking precedence
+ */
+export declare function mergeRequestParameters(requestParams: Params$1, commonParams: Params$1): Params$1;
+/**
+ * Builds query string from parameters object
+ *
+ * Honours OpenAPI style/explode per parameter. Omitting `serializations` means the OpenAPI
+ * default, `form` with `explode: true`, which serializes arrays as repeated keys.
+ *
+ * @param params - Query parameters object
+ * @param serializations - Per-parameter style/explode, for parameters that deviate from the default
+ * @returns Query string starting with '?' or empty string if no params
+ */
+export declare function buildQueryString(params?: QueryParams, serializations?: ParameterSerializationMap): string;
+/**
+ * Cleans a base URL by removing trailing slashes
+ *
+ * @param baseUrl - The base URL to clean
+ * @returns URL without trailing slashes
+ */
+export declare function cleanBaseUrl(baseUrl: string): string;
+/**
+ * Safely formats a K6 response body for logging purposes.
+ * - null: returns "null"
+ * - string: returned as-is
+ * - ArrayBuffer: returns "[ArrayBuffer: N bytes]"
+ *
+ * @param body - The response body (string | ArrayBuffer | null)
+ * @returns A string representation safe for use in template literals
+ */
+export declare function formatResponseBody(body: string | ArrayBuffer | null): string;
+/**
+ * Serializes a request body for K6 HTTP requests.
+ * - null/undefined: passed through as-is
+ * - string: passed through as-is (already serialized)
+ * - ArrayBuffer: passed through as-is (binary data)
+ * - FileData (K6 type with 'data' property): passed through as-is
+ * - objects under a form or multipart content type: passed through for K6 to encode
+ * - other objects: JSON.stringify'd
+ *
+ * @param body - The request body to serialize
+ * @param contentType - The declared request content type, if any
+ * @returns Serialized body suitable for K6 http.request
+ */
+export declare function serializeBody(body: unknown, contentType?: string): RequestBody | null | undefined;
+/**
+ * Serialization styles OpenAPI defines for path parameters
+ */
+export type PathParameterStyle = "simple" | "label" | "matrix";
+/**
+ * How a single path parameter should be serialized
+ */
+export interface PathParameterSerialization {
+  style: PathParameterStyle;
+  explode: boolean;
+}
+/**
+ * Serialize a path parameter into the text that replaces its {placeholder}
+ *
+ * Deliberate copy of `serializePathParam` in
+ * packages/openapi-core/src/utils/param-serialization.ts. This module ships standalone and must not import openapi-core. The shared table in
+ * fixtures/param-serialization-cases.ts is asserted from both, so the copies cannot drift.
+ */
+export declare function serializePathParam(name: string, value: unknown, serialization?: PathParameterSerialization): string;
+export type { Params };

package/dist/runtime.d.mts

@@ -0,0 +1,131 @@
+/*!
+ * Copyright (c) 2026 Spartaficial - Cerios. All rights reserved.
+ * Proprietary software, licensed not sold. Unauthorized use, redistribution or
+ * circumvention of licensing is prohibited. See LICENSE for details.
+ */
+import { Params, Params as Params$1, RequestBody, Response } from "k6/http";
+/**
+ * K6 service result type - combines HTTP response with parsed data and status check result
+ * Used as return type for service methods
+ *
+ * @template T - The type of the parsed response data (from generated types)
+ *
+ * @example
+ * ```typescript
+ * // Service method returns K6ServiceResult<User>
+ * const result = service.getUserById("123");
+ * if (result.ok) {
+ *   console.log(result.data.name); // data is typed as User
+ * } else {
+ *   console.log(`Request failed with status: ${result.response.status}`);
+ * }
+ * ```
+ */
+export interface K6ServiceResult<T> {
+  /** The raw K6 HTTP response */
+  response: Response;
+  /** The parsed response data */
+  data: T;
+  /** Whether the status code check passed */
+  ok: boolean;
+}
+/**
+ * Query string parameters
+ * Supports primitives, arrays, or undefined values
+ */
+export type QueryParams = Record<string, string | number | boolean | string[] | number[] | boolean[] | Record<string, string | number | boolean | null | undefined> | undefined | null>;
+/**
+ * Serialization styles OpenAPI defines for query parameters
+ */
+export type QueryParameterStyle = "form" | "spaceDelimited" | "pipeDelimited" | "deepObject";
+/**
+ * How a single parameter should be serialized
+ */
+export interface ParameterSerialization {
+  style: QueryParameterStyle;
+  explode: boolean;
+  /**
+   * Leave RFC 3986 reserved characters unencoded in the value
+   *
+   * @default false
+   */
+  allowReserved?: boolean;
+}
+/**
+ * Per-parameter serialization, keyed by parameter name. Generated clients pass entries only
+ * for parameters that deviate from the OpenAPI default (form with explode: true).
+ */
+export type ParameterSerializationMap = Record<string, ParameterSerialization>;
+/**
+ * Merges request parameters with common parameters
+ * Request-specific parameters take precedence over common parameters
+ *
+ * Deep-merges nested object properties: headers, tags, cookies
+ *
+ * @param requestParams - Request-specific K6 parameters
+ * @param commonParams - Common K6 parameters set on the client
+ * @returns Merged parameters with request params taking precedence
+ */
+export declare function mergeRequestParameters(requestParams: Params$1, commonParams: Params$1): Params$1;
+/**
+ * Builds query string from parameters object
+ *
+ * Honours OpenAPI style/explode per parameter. Omitting `serializations` means the OpenAPI
+ * default, `form` with `explode: true`, which serializes arrays as repeated keys.
+ *
+ * @param params - Query parameters object
+ * @param serializations - Per-parameter style/explode, for parameters that deviate from the default
+ * @returns Query string starting with '?' or empty string if no params
+ */
+export declare function buildQueryString(params?: QueryParams, serializations?: ParameterSerializationMap): string;
+/**
+ * Cleans a base URL by removing trailing slashes
+ *
+ * @param baseUrl - The base URL to clean
+ * @returns URL without trailing slashes
+ */
+export declare function cleanBaseUrl(baseUrl: string): string;
+/**
+ * Safely formats a K6 response body for logging purposes.
+ * - null: returns "null"
+ * - string: returned as-is
+ * - ArrayBuffer: returns "[ArrayBuffer: N bytes]"
+ *
+ * @param body - The response body (string | ArrayBuffer | null)
+ * @returns A string representation safe for use in template literals
+ */
+export declare function formatResponseBody(body: string | ArrayBuffer | null): string;
+/**
+ * Serializes a request body for K6 HTTP requests.
+ * - null/undefined: passed through as-is
+ * - string: passed through as-is (already serialized)
+ * - ArrayBuffer: passed through as-is (binary data)
+ * - FileData (K6 type with 'data' property): passed through as-is
+ * - objects under a form or multipart content type: passed through for K6 to encode
+ * - other objects: JSON.stringify'd
+ *
+ * @param body - The request body to serialize
+ * @param contentType - The declared request content type, if any
+ * @returns Serialized body suitable for K6 http.request
+ */
+export declare function serializeBody(body: unknown, contentType?: string): RequestBody | null | undefined;
+/**
+ * Serialization styles OpenAPI defines for path parameters
+ */
+export type PathParameterStyle = "simple" | "label" | "matrix";
+/**
+ * How a single path parameter should be serialized
+ */
+export interface PathParameterSerialization {
+  style: PathParameterStyle;
+  explode: boolean;
+}
+/**
+ * Serialize a path parameter into the text that replaces its {placeholder}
+ *
+ * Deliberate copy of `serializePathParam` in
+ * packages/openapi-core/src/utils/param-serialization.ts. This module ships standalone and must not import openapi-core. The shared table in
+ * fixtures/param-serialization-cases.ts is asserted from both, so the copies cannot drift.
+ */
+export declare function serializePathParam(name: string, value: unknown, serialization?: PathParameterSerialization): string;
+export type { Params };

package/dist/runtime.mjs

@@ -0,0 +1,6 @@
+/*!
+ * Copyright (c) 2026 Spartaficial - Cerios. All rights reserved.
+ * Proprietary software, licensed not sold. Unauthorized use, redistribution or
+ * circumvention of licensing is prohibited. See LICENSE for details.
+ */
+function e(e,t){return{...t,...e,cookies:{...t?.cookies,...e?.cookies},headers:{...t?.headers,...e?.headers},tags:{...t?.tags,...e?.tags}}}function t(e){return encodeURIComponent(e).replace(/%20/g,`+`)}function n(e){return[...e].map(e=>`:/?#[]@!$&'()*+,;=`.includes(e)?e:t(e)).join(``)}const r={form:`,`,spaceDelimited:` `,pipeDelimited:`|`,deepObject:`,`},i={style:`form`,explode:!0};function a(e){return typeof e==`object`&&!!e&&!Array.isArray(e)}function o(e,t,n){if(t==null)return[];let{style:o,explode:s}=n??i;if(Array.isArray(t)){let n=t.filter(e=>e!=null);return s?n.map(t=>[e,String(t)]):n.length===0?[]:[[e,n.map(e=>String(e)).join(r[o])]]}if(a(t)){let n=Object.entries(t).filter(([,e])=>e!=null);return o===`deepObject`?n.map(([t,n])=>[`${e}[${t}]`,String(n)]):s?n.map(([e,t])=>[e,String(t)]):n.length===0?[]:[[e,n.flatMap(([e,t])=>[e,String(t)]).join(r[o])]]}return[[e,String(t)]]}function s(e,r){if(!e||Object.keys(e).length===0)return``;let i=[];for(let[a,s]of Object.entries(e)){let e=r?.[a]?.allowReserved??!1;for(let[c,l]of o(a,s,r?.[a])){let r=e?n(l):t(l);i.push(`${t(c)}=${r}`)}}let a=i.join(`&`);return a?`?${a}`:``}function c(e){return e.replace(/\/+$/,``)}function l(e){return typeof e==`object`&&!!e&&`data`in e}function u(e){return e===null?`null`:typeof e==`string`?e:`[ArrayBuffer: ${e.byteLength} bytes]`}const d=[`application/x-www-form-urlencoded`,`multipart/form-data`];function f(e,t){if(e==null||typeof e==`string`||e instanceof ArrayBuffer||l(e))return e;let n=t?.toLowerCase().split(`;`)[0].trim();return n&&d.includes(n)?e:JSON.stringify(e)}const p={style:`simple`,explode:!1};function m(e,t,n){if(t==null)return``;let{style:r,explode:i}=n??p,a=e=>encodeURIComponent(String(e)),o=r===`label`?`.`:r===`matrix`?`;${e}=`:``;if(Array.isArray(t)){let n=t.filter(e=>e!=null);return n.length===0?r===`matrix`?`;${e}=`:o:i?r===`label`?`.${n.map(a).join(`.`)}`:r===`matrix`?n.map(t=>`;${e}=${a(t)}`).join(``):n.map(a).join(`,`):`${o}${n.map(a).join(`,`)}`}if(typeof t==`object`){let n=Object.entries(t).filter(([,e])=>e!=null);if(n.length===0)return r===`matrix`?`;${e}=`:o;if(i){let e=n.map(([e,t])=>`${a(e)}=${a(t)}`);return r===`label`?`.${e.join(`.`)}`:r===`matrix`?`;${e.join(`;`)}`:e.join(`,`)}return`${o}${n.flatMap(([e,t])=>[a(e),a(t)]).join(`,`)}`}return`${o}${a(t)}`}export{s as buildQueryString,c as cleanBaseUrl,u as formatResponseBody,e as mergeRequestParameters,f as serializeBody,m as serializePathParam};

package/package.json

@@ -1,6 +1,101 @@
 {
-  "name": "@spartaficial/openapi-to-k6",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+	"name": "@spartaficial/openapi-to-k6",
+	"version": "1.0.0",
+	"description": "Generate type-safe K6 HTTP clients from OpenAPI specifications with TypeScript types",
+	"keywords": [
+		"api-client",
+		"cerios",
+		"generator",
+		"k6",
+		"load-testing",
+		"openapi",
+		"performance-testing",
+		"typescript"
+	],
+	"homepage": "https://spartaficial.dev/",
+	"bugs": {
+		"url": "https://github.com/Spartaficial/openapi-codegen-support/issues"
+	},
+	"license": "SEE LICENSE IN LICENSE",
+	"author": "Ronald Veth - Cerios",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/Spartaficial/openapi-codegen.git",
+		"directory": "packages/openapi-to-k6"
+	},
+	"bin": {
+		"openapi-to-k6": "./dist/cli.cjs"
+	},
+	"files": [
+		"dist"
+	],
+	"type": "commonjs",
+	"sideEffects": false,
+	"main": "./dist/index.cjs",
+	"module": "./dist/index.mjs",
+	"types": "./dist/index.d.cts",
+	"typesVersions": {
+		"*": {
+			"runtime": [
+				"./dist/runtime.d.cts"
+			]
+		}
+	},
+	"exports": {
+		".": {
+			"import": {
+				"types": "./dist/index.d.mts",
+				"default": "./dist/index.mjs"
+			},
+			"require": {
+				"types": "./dist/index.d.cts",
+				"default": "./dist/index.cjs"
+			}
+		},
+		"./runtime": {
+			"import": {
+				"types": "./dist/runtime.d.mts",
+				"default": "./dist/runtime.mjs"
+			},
+			"require": {
+				"types": "./dist/runtime.d.cts",
+				"default": "./dist/runtime.cjs"
+			}
+		},
+		"./package.json": "./package.json"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"scripts": {
+		"build": "tsdown && tsx ../../scripts/obfuscate-dist.ts && tsx ../../scripts/add-banner.ts",
+		"check-exports": "attw --pack . && publint",
+		"compile": "tsc --noEmit",
+		"dev": "tsdown --watch",
+		"test": "vitest run",
+		"test:coverage": "vitest run --coverage"
+	},
+	"dependencies": {
+		"@spartaficial/openapi-core": "^1.0.0",
+		"@spartaficial/openapi-to-typescript": "^1.0.0",
+		"commander": "^15.1.0",
+		"prompts": "^2.4.2",
+		"zod": "^4.6.7"
+	},
+	"devDependencies": {
+		"@arethetypeswrong/cli": "^0.18.5",
+		"@types/k6": "^2.3.1",
+		"@types/node": "^26.6.6",
+		"@types/prompts": "^2.4.9",
+		"publint": "^0.3.25",
+		"tsdown": "^0.23.7",
+		"typescript": "^7.0.2",
+		"vitest": "^5.1.0"
+	},
+	"peerDependencies": {
+		"@types/k6": ">=0.52.0"
+	},
+	"engines": {
+		"node": "^22.18.0 || >=24"
+	}
+}