@ir-kit/create-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,46 @@
+# `@ir-kit/create-k6`
+
+Wizard scaffolder for the [`@ir-kit/k6`](https://github.com/ir-kit/ir-kit/tree/main/packages/k6/framework) stack. Run `npm create @ir-kit/k6` (or the pnpm / yarn equivalent) to generate a typed client from your OpenAPI spec and a starter `loadtest.ts` in one shot.
+
+## Use
+
+```sh
+npm create @ir-kit/k6@latest
+# pnpm create @ir-kit/k6
+# yarn create @ir-kit/k6
+```
+
+The wizard asks for:
+
+- OpenAPI spec source (path or URL)
+- Output directory
+- Whether to scaffold a per-tag scenario folder
+
+It writes:
+
+- `src/gen/` — typed k6 client + types + faker data builders
+- `loadtests/` (optional) — one starter file per OpenAPI tag
+- `package.json` with the right `@ir-kit/k6` + `@ir-kit/k6-toolkit` deps
+
+## What you get
+
+```ts
+// loadtests/smoke.ts
+import { defineLoadTest, flow, smoke, useAuth } from "@ir-kit/k6";
+import { client } from "../src/gen";
+
+export const options = smoke();
+
+export default defineLoadTest({
+  setup: () => useAuth({ bearer: "token" }),
+  scenarios: flow().step("list pets", () => client.listPets()),
+});
+```
+
+## Status
+
+`0.1.0` — first release under the `@ir-kit/*` scope. Replaces the legacy `@ahmedrowaihi/create-k6` (deprecated).
+
+## Repo
+
+Source at [ir-kit/ir-kit](https://github.com/ir-kit/ir-kit/tree/main/packages/k6/create).

package/dist/bin.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=bin.d.ts.map

package/dist/bin.d.ts.map

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

package/dist/bin.js

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+import { runWizard } from "./wizard.js";
+runWizard(process.cwd()).catch((err) => {
+    const msg = err instanceof Error ? err.message : String(err);
+    console.error(`create-k6 failed: ${msg}`);
+    process.exit(1);
+});
+//# sourceMappingURL=bin.js.map

package/dist/bin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bin.js","sourceRoot":"","sources":["../src/bin.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,GAAY,EAAE,EAAE;IAC9C,MAAM,GAAG,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC7D,OAAO,CAAC,KAAK,CAAC,qBAAqB,GAAG,EAAE,CAAC,CAAC;IAC1C,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { runWizard } from "./wizard.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,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC"}

package/dist/index.js

@@ -0,0 +1,2 @@
+export { runWizard } from "./wizard.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,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC"}

package/dist/wizard.d.ts

@@ -0,0 +1,2 @@
+export declare function runWizard(cwd?: string): Promise<void>;
+//# sourceMappingURL=wizard.d.ts.map

package/dist/wizard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wizard.d.ts","sourceRoot":"","sources":["../src/wizard.ts"],"names":[],"mappings":"AAoBA,wBAAsB,SAAS,CAAC,GAAG,GAAE,MAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CA0B1E"}

package/dist/wizard.js

@@ -0,0 +1,108 @@
+import { cancel, confirm, intro, isCancel, outro, select, text, } from "@clack/prompts";
+import { init } from "@ir-kit/k6-toolkit";
+export async function runWizard(cwd = process.cwd()) {
+    intro("create-k6 — scaffold a load-test project");
+    const answers = await collectAnswers(cwd);
+    if (!answers)
+        return;
+    const result = await init({
+        cwd: answers.cwd,
+        input: answers.spec,
+        output: answers.output,
+        auth: answers.auth,
+        scenarios: answers.scenarios,
+        scaffold: answers.scaffoldStubs,
+        noOverwrite: true,
+    });
+    const stubCount = result.generated.files.filter((f) => f.path.startsWith("loadtests/")).length;
+    const summary = [
+        `Wrote ${result.generated.files.length} files to ${answers.output}.`,
+        `Loadtest entry: ${answers.cwd}/loadtest.ts`,
+        stubCount > 0 ? `Per-op stubs: ${stubCount}` : null,
+        "Next: edit loadtest.ts, then run it via @ir-kit/k6-toolkit `runK6()`.",
+    ].filter(Boolean);
+    outro(summary.join("\n"));
+}
+async function collectAnswers(cwd) {
+    const spec = await text({
+        message: "Path or URL to your OpenAPI spec?",
+        placeholder: "./openapi.yaml or https://api.example.com/openapi.yaml",
+        validate: (v) => (v && v.trim().length ? undefined : "Required"),
+    });
+    if (isCancel(spec))
+        return bail();
+    const output = await text({
+        message: "Where should the typed client land?",
+        initialValue: "./src/gen",
+        validate: (v) => (v && v.trim().length ? undefined : "Required"),
+    });
+    if (isCancel(output))
+        return bail();
+    const auth = (await select({
+        message: "Auth flavor for the loadtest starter?",
+        options: [
+            { value: "none", label: "None — public API or custom middleware later" },
+            { value: "bearer", label: "Bearer token from env var (API_TOKEN)" },
+            { value: "basic", label: "HTTP Basic (API_USER / API_PASS env)" },
+            { value: "apiKey", label: "API key header (X-API-Key from API_KEY env)" },
+            { value: "session", label: "Cookie/session — fill in signIn() yourself" },
+        ],
+        initialValue: "none",
+    }));
+    if (isCancel(auth))
+        return bail();
+    const shape = (await select({
+        message: "Single test or multiple named scenarios?",
+        options: [
+            { value: "single", label: "Single test (one pace + one flow)" },
+            {
+                value: "scenarios",
+                label: "Multiple named scenarios (browse / write / …)",
+            },
+        ],
+        initialValue: "single",
+    }));
+    if (isCancel(shape))
+        return bail();
+    let scenarios;
+    if (shape === "scenarios") {
+        const raw = await text({
+            message: "Scenario names (comma-separated)?",
+            placeholder: "browse, write",
+            validate: (v) => {
+                const parsed = parseScenarioNames(v ?? "");
+                if (!parsed.length)
+                    return "Provide at least one name";
+                return undefined;
+            },
+        });
+        if (isCancel(raw))
+            return bail();
+        scenarios = parseScenarioNames(raw);
+    }
+    const scaffoldStubs = await confirm({
+        message: "Also emit one stub loadtest per spec operation?",
+        initialValue: false,
+    });
+    if (isCancel(scaffoldStubs))
+        return bail();
+    return {
+        cwd,
+        spec: spec,
+        output: output,
+        auth: auth,
+        scenarios,
+        scaffoldStubs: scaffoldStubs,
+    };
+}
+function parseScenarioNames(raw) {
+    return raw
+        .split(",")
+        .map((s) => s.trim())
+        .filter(Boolean);
+}
+function bail() {
+    cancel("Aborted.");
+    return null;
+}
+//# sourceMappingURL=wizard.js.map

package/dist/wizard.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wizard.js","sourceRoot":"","sources":["../src/wizard.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,MAAM,EACN,OAAO,EACP,KAAK,EACL,QAAQ,EACR,KAAK,EACL,MAAM,EACN,IAAI,GACL,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAmB,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAW3D,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,MAAc,OAAO,CAAC,GAAG,EAAE;IACzD,KAAK,CAAC,0CAA0C,CAAC,CAAC;IAElD,MAAM,OAAO,GAAG,MAAM,cAAc,CAAC,GAAG,CAAC,CAAC;IAC1C,IAAI,CAAC,OAAO;QAAE,OAAO;IAErB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC;QACxB,GAAG,EAAE,OAAO,CAAC,GAAG;QAChB,KAAK,EAAE,OAAO,CAAC,IAAI;QACnB,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,QAAQ,EAAE,OAAO,CAAC,aAAa;QAC/B,WAAW,EAAE,IAAI;KAClB,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CACpD,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAChC,CAAC,MAAM,CAAC;IACT,MAAM,OAAO,GAAG;QACd,SAAS,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,aAAa,OAAO,CAAC,MAAM,GAAG;QACpE,mBAAmB,OAAO,CAAC,GAAG,cAAc;QAC5C,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,iBAAiB,SAAS,EAAE,CAAC,CAAC,CAAC,IAAI;QACnD,uEAAuE;KACxE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAClB,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;AAC5B,CAAC;AAED,KAAK,UAAU,cAAc,CAAC,GAAW;IACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC;QACtB,OAAO,EAAE,mCAAmC;QAC5C,WAAW,EAAE,wDAAwD;QACrE,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC;KACjE,CAAC,CAAC;IACH,IAAI,QAAQ,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,EAAE,CAAC;IAElC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC;QACxB,OAAO,EAAE,qCAAqC;QAC9C,YAAY,EAAE,WAAW;QACzB,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC;KACjE,CAAC,CAAC;IACH,IAAI,QAAQ,CAAC,MAAM,CAAC;QAAE,OAAO,IAAI,EAAE,CAAC;IAEpC,MAAM,IAAI,GAAG,CAAC,MAAM,MAAM,CAAC;QACzB,OAAO,EAAE,uCAAuC;QAChD,OAAO,EAAE;YACP,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,8CAA8C,EAAE;YACxE,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,uCAAuC,EAAE;YACnE,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,sCAAsC,EAAE;YACjE,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,6CAA6C,EAAE;YACzE,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,4CAA4C,EAAE;SAC1E;QACD,YAAY,EAAE,MAAM;KACrB,CAAC,CAAwB,CAAC;IAC3B,IAAI,QAAQ,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,EAAE,CAAC;IAElC,MAAM,KAAK,GAAG,CAAC,MAAM,MAAM,CAAC;QAC1B,OAAO,EAAE,0CAA0C;QACnD,OAAO,EAAE;YACP,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,mCAAmC,EAAE;YAC/D;gBACE,KAAK,EAAE,WAAW;gBAClB,KAAK,EAAE,+CAA+C;aACvD;SACF;QACD,YAAY,EAAE,QAAQ;KACvB,CAAC,CAAoC,CAAC;IACvC,IAAI,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,IAAI,EAAE,CAAC;IAEnC,IAAI,SAA4C,CAAC;IACjD,IAAI,KAAK,KAAK,WAAW,EAAE,CAAC;QAC1B,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC;YACrB,OAAO,EAAE,mCAAmC;YAC5C,WAAW,EAAE,eAAe;YAC5B,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE;gBACd,MAAM,MAAM,GAAG,kBAAkB,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;gBAC3C,IAAI,CAAC,MAAM,CAAC,MAAM;oBAAE,OAAO,2BAA2B,CAAC;gBACvD,OAAO,SAAS,CAAC;YACnB,CAAC;SACF,CAAC,CAAC;QACH,IAAI,QAAQ,CAAC,GAAG,CAAC;YAAE,OAAO,IAAI,EAAE,CAAC;QACjC,SAAS,GAAG,kBAAkB,CAAC,GAAa,CAAC,CAAC;IAChD,CAAC;IAED,MAAM,aAAa,GAAG,MAAM,OAAO,CAAC;QAClC,OAAO,EAAE,iDAAiD;QAC1D,YAAY,EAAE,KAAK;KACpB,CAAC,CAAC;IACH,IAAI,QAAQ,CAAC,aAAa,CAAC;QAAE,OAAO,IAAI,EAAE,CAAC;IAE3C,OAAO;QACL,GAAG;QACH,IAAI,EAAE,IAAc;QACpB,MAAM,EAAE,MAAgB;QACxB,IAAI,EAAE,IAAkB;QACxB,SAAS;QACT,aAAa,EAAE,aAAwB;KACxC,CAAC;AACJ,CAAC;AAED,SAAS,kBAAkB,CAAC,GAAW;IACrC,OAAO,GAAG;SACP,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;SACpB,MAAM,CAAC,OAAO,CAAC,CAAC;AACrB,CAAC;AAED,SAAS,IAAI;IACX,MAAM,CAAC,UAAU,CAAC,CAAC;IACnB,OAAO,IAAI,CAAC;AACd,CAAC"}

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@ir-kit/create-k6",
+  "version": "0.1.0",
+  "description": "Wizard scaffolder for the @ir-kit/k6 stack. Run `npm create @ir-kit/k6` to generate a typed client from your OpenAPI spec and a starter loadtest.ts in one shot.",
+  "keywords": [
+    "k6",
+    "load-testing",
+    "scaffold",
+    "wizard",
+    "openapi"
+  ],
+  "homepage": "https://github.com/ir-kit/ir-kit/tree/main/packages/k6/create",
+  "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/create"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "bin": {
+    "create-k6": "./dist/bin.js"
+  },
+  "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": {
+    "@clack/prompts": "^1.3.0",
+    "@ir-kit/k6-toolkit": "0.1.0"
+  },
+  "devDependencies": {
+    "@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 && chmod +x dist/bin.js",
+    "dev": "tsc -p tsconfig.build.json --watch",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run --passWithNoTests"
+  }
+}