@ir-kit/openapi-ts-k6 0.1.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Ahmed Rowaihi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,21 @@
+# @ir-kit/openapi-ts-k6
+
+Thin [`@hey-api/openapi-ts`](https://github.com/hey-api/openapi-ts) plugin that wraps [`@ir-kit/k6-gen`](../gen). For users who already drive code generation through `openapi-ts.config.ts` — otherwise prefer the [`k6-tools` CLI](../tools).
+
+```ts
+// openapi-ts.config.ts
+import { defineConfig } from "@hey-api/openapi-ts";
+import { defineConfig as defineK6 } from "@ir-kit/openapi-ts-k6";
+
+export default defineConfig({
+  input: "./openapi.yaml",
+  output: "./src/generated",
+  plugins: [
+    defineK6({ output: "./k6", defaultBaseUrl: "https://api.example.com" }),
+  ],
+});
+```
+
+Emits the same four files (`types.ts`, `client.ts`, `data.ts`, `index.ts`) under `<hey-api output.path>/<plugin output>` — see [@ir-kit/k6-gen](../gen) for output shape.
+
+The plugin is a single function call: it reads the bundled spec from hey-api's context and delegates to `generate()`. No `$` DSL, no symbol planner, no plugin hooks — just spec → files.

package/dist/config.d.ts

@@ -0,0 +1,6 @@
+import type { K6HeyApiPlugin } from "./types.js";
+export declare const defaultConfig: K6HeyApiPlugin["Config"];
+export declare const defineConfig: (userConfig?: Omit<import("./types.js").UserConfig, "name"> | undefined) => Omit<import("@hey-api/shared").Plugin.Config<import("@hey-api/shared").Plugin.Types<import("./types.js").UserConfig, import("./types.js").Config, never>>, "name"> & {
+    name: any;
+};
+//# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAEjD,eAAO,MAAM,aAAa,EAAE,cAAc,CAAC,QAAQ,CAQlD,CAAC;AAEF,eAAO,MAAM,YAAY;;CAAoC,CAAC"}

package/dist/config.js

@@ -0,0 +1,13 @@
+import { definePluginConfig } from "@hey-api/shared";
+import { handler } from "./plugin.js";
+export const defaultConfig = {
+    config: {
+        output: "./k6",
+    },
+    dependencies: [],
+    handler,
+    name: "@ir-kit/openapi-ts-k6",
+    tags: ["client"],
+};
+export const defineConfig = definePluginConfig(defaultConfig);
+//# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAErD,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAGtC,MAAM,CAAC,MAAM,aAAa,GAA6B;IACrD,MAAM,EAAE;QACN,MAAM,EAAE,MAAM;KACf;IACD,YAAY,EAAE,EAAE;IAChB,OAAO;IACP,IAAI,EAAE,uBAAuB;IAC7B,IAAI,EAAE,CAAC,QAAQ,CAAC;CACjB,CAAC;AAEF,MAAM,CAAC,MAAM,YAAY,GAAG,kBAAkB,CAAC,aAAa,CAAC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import "./types.js";
+export { defaultConfig, defineConfig } from "./config.js";
+export type { Config, K6HeyApiPlugin, UserConfig } from "./types.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,CAAC;AAEpB,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC1D,YAAY,EAAE,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC"}

package/dist/index.js

@@ -0,0 +1,3 @@
+import "./types.js";
+export { defaultConfig, defineConfig } from "./config.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,CAAC;AAEpB,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC"}

package/dist/plugin.d.ts

@@ -0,0 +1,9 @@
+import type { K6HeyApiPlugin } from "./types.js";
+/**
+ * Plugin handler — defers all real work to `@ir-kit/k6-gen`'s
+ * standalone `generate()`. The hey-api context already $ref-bundled and
+ * normalized the spec, so we pass that through and disable our own
+ * normalize step.
+ */
+export declare const handler: K6HeyApiPlugin["Handler"];
+//# sourceMappingURL=plugin.d.ts.map

package/dist/plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAEjD;;;;;GAKG;AACH,eAAO,MAAM,OAAO,EAAE,cAAc,CAAC,SAAS,CAW7C,CAAC"}

package/dist/plugin.js

@@ -0,0 +1,20 @@
+import { resolve } from "node:path";
+import { generate } from "@ir-kit/k6-gen";
+/**
+ * Plugin handler — defers all real work to `@ir-kit/k6-gen`'s
+ * standalone `generate()`. The hey-api context already $ref-bundled and
+ * normalized the spec, so we pass that through and disable our own
+ * normalize step.
+ */
+export const handler = ({ plugin }) => {
+    const outputBase = plugin.context.config.output.path;
+    const outDir = resolve(outputBase, plugin.config.output);
+    const spec = plugin.context.spec;
+    return generate({
+        input: spec,
+        output: outDir,
+        defaultBaseUrl: plugin.config.defaultBaseUrl,
+        normalize: false,
+    }).then(() => undefined);
+};
+//# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAI1C;;;;;GAKG;AACH,MAAM,CAAC,MAAM,OAAO,GAA8B,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE;IAC/D,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;IACrD,MAAM,MAAM,GAAG,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACzD,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,IAA+B,CAAC;IAE5D,OAAO,QAAQ,CAAC;QACd,KAAK,EAAE,IAAI;QACX,MAAM,EAAE,MAAM;QACd,cAAc,EAAE,MAAM,CAAC,MAAM,CAAC,cAAc;QAC5C,SAAS,EAAE,KAAK;KACjB,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;AAC3B,CAAC,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,28 @@
+import type { DefinePlugin, Plugin } from "@hey-api/shared";
+export type UserConfig = Plugin.Hooks & Plugin.UserExports & {
+    name: "@ir-kit/openapi-ts-k6";
+    /**
+     * Output directory for the generated client (`types.ts`, `client.ts`,
+     * `data.ts`, `index.ts`). Resolved relative to hey-api's `output.path`.
+     * @default "./k6"
+     */
+    output?: string;
+    /**
+     * Default base URL baked into the client. Falls back to spec
+     * `servers[0].url`. The user can still override at runtime via
+     * `__ENV.BASE_URL`.
+     */
+    defaultBaseUrl?: string;
+};
+export type Config = Plugin.Hooks & Plugin.Exports & {
+    name: "@ir-kit/openapi-ts-k6";
+    output: string;
+    defaultBaseUrl?: string;
+};
+export type K6HeyApiPlugin = DefinePlugin<UserConfig, Config>;
+declare module "@hey-api/openapi-ts" {
+    interface PluginConfigMap {
+        "@ir-kit/openapi-ts-k6": K6HeyApiPlugin["Types"];
+    }
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAE5D,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,KAAK,GACnC,MAAM,CAAC,WAAW,GAAG;IACnB,IAAI,EAAE,uBAAuB,CAAC;IAC9B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEJ,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,GAC/B,MAAM,CAAC,OAAO,GAAG;IACf,IAAI,EAAE,uBAAuB,CAAC;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEJ,MAAM,MAAM,cAAc,GAAG,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;AAE9D,OAAO,QAAQ,qBAAqB,CAAC;IACnC,UAAiB,eAAe;QAC9B,uBAAuB,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC;KAClD;CACF"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@ir-kit/openapi-ts-k6",
+  "version": "0.1.0",
+  "description": "Thin @hey-api/openapi-ts plugin that delegates to @ir-kit/k6-gen. Use if you already drive codegen through openapi-ts.config.ts; otherwise reach for @ir-kit/k6-toolkit.",
+  "keywords": [
+    "openapi",
+    "openapi-ts",
+    "k6",
+    "load-testing",
+    "plugin"
+  ],
+  "homepage": "https://github.com/ir-kit/ir-kit/tree/main/packages/k6/hey-api",
+  "bugs": {
+    "url": "https://github.com/ir-kit/ir-kit/issues"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "Ahmed Rowaihi",
+    "email": "ahmedrowaihi@gmail.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ir-kit/ir-kit.git",
+    "directory": "packages/k6/hey-api"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE.md"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "dependencies": {
+    "@ir-kit/k6-gen": "0.1.0"
+  },
+  "peerDependencies": {
+    "@hey-api/openapi-ts": ">=0.95.0",
+    "@hey-api/shared": ">=0.2.0"
+  },
+  "devDependencies": {
+    "@hey-api/openapi-ts": "^0.97.0",
+    "@hey-api/shared": "^0.4.2",
+    "@types/node": "^22",
+    "vitest": "^4.0.0",
+    "@ir-kit/tsconfig": "0.0.0"
+  },
+  "engines": {
+    "node": ">=20.19.0"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "dev": "tsc -p tsconfig.build.json --watch",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run --passWithNoTests"
+  }
+}