@lovrozagar/oat 0.1.0

package/labs/local.config.ts

@@ -0,0 +1,41 @@
+/**
+ * Points at the demo API that ships with oat, so this runs end to end with no setup.
+ *
+ *   oat serve                                    # terminal 1 — prints a url
+ *   oat run --config labs/local.config.ts --base-url <that url>
+ *
+ * Real configs import from "@lovrozagar/oat"; this one uses a relative path because it lives inside the
+ * repository.
+ */
+
+import { defineConfig } from "../dist/index.js"
+
+/* Overridden by --base-url, which is what `oat serve` prints. */
+const API = process.env.OAT_BASE_URL ?? "http://127.0.0.1:8787"
+
+export default defineConfig({
+	baseUrl: API,
+	principals: [
+		{
+			auth: {
+				credentialFrom: "$.access_token",
+				steps: [{ body: { key: "key_alpha" }, operationId: "auth.token" }],
+			},
+			id: "alpha",
+			roots: { project_id: "proj_alpha" },
+		},
+		/* A second principal in a different tenant — this is what makes the isolation checks
+		 * possible. Without one they are skipped rather than silently passed. */
+		{
+			auth: {
+				credentialFrom: "$.access_token",
+				steps: [{ body: { key: "key_beta" }, operationId: "auth.token" }],
+			},
+			id: "beta",
+			roots: { project_id: "proj_beta" },
+		},
+	],
+	seed: 42,
+	/* Relative to baseUrl — oat also accepts an absolute URL or a filesystem path. */
+	spec: "/v1/openapi/spec",
+})

package/labs/minimal.config.ts

@@ -0,0 +1,32 @@
+/**
+ * The smallest useful config: a long-lived API key, no login flow.
+ *
+ * A principal without an `auth` flow authenticates by static header, so nothing needs acquiring.
+ * The second principal is optional — but it is what makes the tenant-isolation checks possible;
+ * without one they are skipped rather than silently passed.
+ *
+ *   oat run --config labs/minimal.config.ts
+ *
+ * Written as `from "../dist/index.js"` only because this file lives inside the repository —
+ * in your own project it is `from "@lovrozagar/oat"`.
+ */
+
+import { defineConfig } from "../dist/index.js"
+
+export default defineConfig({
+	baseUrl: "https://api.example.com",
+	principals: [
+		{
+			headers: { authorization: `Bearer ${process.env.API_TOKEN ?? ""}` },
+			id: "alpha",
+			/* Path parameters oat cannot create for itself. */
+			roots: { project_id: process.env.PROJECT_A ?? "" },
+		},
+		{
+			headers: { authorization: `Bearer ${process.env.API_TOKEN_B ?? ""}` },
+			id: "beta",
+			roots: { project_id: process.env.PROJECT_B ?? "" },
+		},
+	],
+	spec: "https://api.example.com/openapi.json",
+})

package/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "@lovrozagar/oat",
+  "version": "0.1.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "description": "OpenAPI Tester — behavioural testing of a live backend against its OpenAPI specification",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lovrozagar/oat.git"
+  },
+  "homepage": "https://github.com/lovrozagar/oat#readme",
+  "bugs": {
+    "url": "https://github.com/lovrozagar/oat/issues"
+  },
+  "author": "lovrozagar",
+  "type": "module",
+  "engines": {
+    "node": ">=20"
+  },
+  "bin": {
+    "oat": "./bin/oat.js"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "bin/oat.js",
+    "dist/cli.js",
+    "dist/index.js",
+    "dist/index.d.ts",
+    "dist/config",
+    "dist/reference",
+    "dist/report",
+    "dist/runtime",
+    "dist/spec",
+    "README.md",
+    "LICENSE",
+    "labs/annotated-openapi.yaml",
+    "labs/local.config.ts",
+    "labs/minimal.config.ts",
+    "labs/anyrow.config.ts",
+    "labs/demo.mjs",
+    "labs/README.md"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "dev": "tsc -p tsconfig.json --watch",
+    "check": "tsc -p tsconfig.json --noEmit",
+    "test": "npm run build && node --experimental-sqlite dist/cli.js conformance",
+    "conformance": "node --experimental-sqlite dist/cli.js conformance",
+    "demo": "npm run build && node labs/demo.mjs",
+    "labs": "node --experimental-strip-types labs/serve.ts",
+    "labs:sweep": "bash labs/sweep.sh",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "openapi",
+    "testing",
+    "contract-testing",
+    "api",
+    "swagger"
+  ],
+  "dependencies": {
+    "ajv": "^8.17.1",
+    "ajv-formats": "^3.0.1",
+    "yaml": "^2.9.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.0",
+    "postgres": "^3.4.9",
+    "typescript": "^5.7.2"
+  }
+}