@warlock.js/core 5.29.0 → 5.31.0

package/esm/tests/fakes/queue-fake.mjs

@@ -0,0 +1,134 @@
+import { clock } from "../../utils/clock.mjs";
+import { FakeAssertionError, describeRecorded } from "./fake-assertion-error.mjs";
+
+//#region ../../packages/core/src/tests/fakes/queue-fake.ts
+const INTERCEPTOR_KEY = Symbol.for("warlock.queue.dispatchInterceptor");
+const pushed = [];
+let sequence = 0;
+let previous;
+let installed = false;
+function nameOf(job) {
+	return typeof job === "string" ? job : job.name;
+}
+function isSubset(expected, actual) {
+	if (expected === actual) return true;
+	if (typeof expected !== "object" || expected === null) return false;
+	if (typeof actual !== "object" || actual === null) return false;
+	return Object.entries(expected).every(([key, value]) => isSubset(value, actual[key]));
+}
+function matches(job, matcher) {
+	if (matcher === void 0) return true;
+	if (typeof matcher === "function") return matcher(job);
+	return isSubset(matcher, job.payload);
+}
+function describeJob(job) {
+	return `${job.name} on "${job.queue}" with ${JSON.stringify(job.payload)}`;
+}
+const interceptor = {
+	dispatch({ name, queue, payload, options }) {
+		const explicitId = typeof options.jobId === "string" ? options.jobId : void 0;
+		const existing = explicitId ? pushed.find((job) => job.id === explicitId) : void 0;
+		if (existing) return {
+			id: existing.id,
+			name: existing.name,
+			queue: existing.queue
+		};
+		sequence += 1;
+		const job = {
+			id: explicitId ?? `fake-${sequence}`,
+			name,
+			queue,
+			payload,
+			options: { ...options },
+			pushedAt: clock.now()
+		};
+		pushed.push(job);
+		return {
+			id: job.id,
+			name,
+			queue
+		};
+	},
+	find({ name, id }) {
+		const job = pushed.find((entry) => entry.id === id && entry.name === name);
+		if (!job) return void 0;
+		return {
+			id: job.id,
+			name: job.name,
+			queue: job.queue,
+			state: "waiting",
+			payload: job.payload,
+			progress: 0,
+			attemptsMade: 0,
+			createdAt: job.pushedAt
+		};
+	}
+};
+/**
+* Records every `@warlock.js/queue` dispatch instead of pushing it to Redis.
+*
+* Installed by default in the test environment. Jobs are recorded, not run:
+* call the job's handler directly to test what it does.
+*
+* @example
+* await placeOrder(order);
+*
+* queueFake.assertPushed(sendInvoice, { orderId: order.id });
+* queueFake.assertPushedCount(1);
+*/
+const queueFake = {
+	/** Start recording (idempotent). Clears anything recorded before. */
+	install() {
+		const holder = globalThis;
+		if (!installed) {
+			previous = holder[INTERCEPTOR_KEY];
+			installed = true;
+		}
+		holder[INTERCEPTOR_KEY] = interceptor;
+		queueFake.clear();
+	},
+	/** Stop recording; dispatches reach the broker again. */
+	restore() {
+		if (!installed) return;
+		globalThis[INTERCEPTOR_KEY] = previous;
+		previous = void 0;
+		installed = false;
+		queueFake.clear();
+	},
+	isInstalled() {
+		return installed;
+	},
+	/** Forget recorded jobs. */
+	clear() {
+		pushed.length = 0;
+		sequence = 0;
+	},
+	/** Recorded jobs, oldest first; optionally only one job type. */
+	pushed(job, matcher) {
+		return pushed.filter((entry) => (job === void 0 || entry.name === nameOf(job)) && matches(entry, matcher));
+	},
+	/** Assert `job` was pushed (with a payload matching `matcher`); returns the first match. */
+	assertPushed(job, matcher) {
+		const found = queueFake.pushed(job, matcher)[0];
+		if (!found) throw new FakeAssertionError(`Expected ${nameOf(job)} to be pushed${matcher === void 0 ? "" : " with a matching payload"}. ${describeRecorded(pushed, describeJob, "pushed")}`);
+		return found;
+	},
+	/** Assert `job` was not pushed (with a matching payload). */
+	assertNotPushed(job, matcher) {
+		const found = queueFake.pushed(job, matcher);
+		if (found.length > 0) throw new FakeAssertionError(`Expected ${nameOf(job)} not to be pushed. ${describeRecorded(found, describeJob, "pushed")}`);
+	},
+	/** Assert exactly `count` jobs were pushed — of type `job` when given. */
+	assertPushedCount(count, job) {
+		const found = queueFake.pushed(job);
+		if (found.length !== count) throw new FakeAssertionError(`Expected ${count} ${job === void 0 ? "job(s)" : nameOf(job)} pushed, found ${found.length}. ${describeRecorded(pushed, describeJob, "pushed")}`);
+	},
+	/** Assert nothing was pushed. */
+	assertNothingPushed() {
+		queueFake.assertPushedCount(0);
+	}
+};
+
+//#endregion
+export { queueFake };
+//# sourceMappingURL=queue-fake.mjs.map

package/esm/tests/fakes/queue-fake.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"queue-fake.mjs","names":[],"sources":["../../../../../../../../../packages/core/src/tests/fakes/queue-fake.ts"],"sourcesContent":["import { clock } from \"../../utils/clock\";\nimport { FakeAssertionError, describeRecorded } from \"./fake-assertion-error\";\n\n/**\n * One job `dispatch()`ed while the fake was installed.\n *\n * Structural on purpose: core has no dependency on `@warlock.js/queue`. The\n * fake talks to it through the global dispatch-interceptor slot that package\n * reads (`setDispatchInterceptor`).\n */\nexport type PushedJob = {\n  id: string;\n  name: string;\n  queue: string;\n  payload: unknown;\n  /** The dispatch options (`delay`, `priority`, `jobId`, ...). */\n  options: Record<string, unknown>;\n  pushedAt: Date;\n};\n\n/** A job name, or anything with a `name` — the object `defineJob()` returns. */\nexport type JobReference = string | { readonly name: string };\n\n/** Which pushed jobs an assertion is about: a predicate, or a payload subset. */\nexport type PushedJobMatcher = ((job: PushedJob) => boolean) | Record<string, unknown>;\n\nconst INTERCEPTOR_KEY = Symbol.for(\"warlock.queue.dispatchInterceptor\");\n\ntype Interceptor = {\n  dispatch(job: {\n    name: string;\n    queue: string;\n    payload: unknown;\n    options: Record<string, unknown>;\n  }): { id: string; name: string; queue: string };\n  find(job: { name: string; id: string }): unknown;\n};\n\ntype InterceptorHolder = { [INTERCEPTOR_KEY]?: Interceptor };\n\nconst pushed: PushedJob[] = [];\nlet sequence = 0;\nlet previous: Interceptor | undefined;\nlet installed = false;\n\nfunction nameOf(job: JobReference): string {\n  return typeof job === \"string\" ? job : job.name;\n}\n\nfunction isSubset(expected: unknown, actual: unknown): boolean {\n  if (expected === actual) return true;\n  if (typeof expected !== \"object\" || expected === null) return false;\n  if (typeof actual !== \"object\" || actual === null) return false;\n\n  return Object.entries(expected).every(([key, value]) =>\n    isSubset(value, (actual as Record<string, unknown>)[key]),\n  );\n}\n\nfunction matches(job: PushedJob, matcher: PushedJobMatcher | undefined): boolean {\n  if (matcher === undefined) return true;\n  if (typeof matcher === \"function\") return matcher(job);\n\n  return isSubset(matcher, job.payload);\n}\n\nfunction describeJob(job: PushedJob): string {\n  return `${job.name} on \"${job.queue}\" with ${JSON.stringify(job.payload)}`;\n}\n\nconst interceptor: Interceptor = {\n  dispatch({ name, queue, payload, options }) {\n    // An explicit jobId makes a real dispatch idempotent; keep that contract.\n    const explicitId = typeof options.jobId === \"string\" ? options.jobId : undefined;\n    const existing = explicitId ? pushed.find((job) => job.id === explicitId) : undefined;\n\n    if (existing) return { id: existing.id, name: existing.name, queue: existing.queue };\n\n    sequence += 1;\n\n    const job: PushedJob = {\n      id: explicitId ?? `fake-${sequence}`,\n      name,\n      queue,\n      payload,\n      options: { ...options },\n      pushedAt: clock.now(),\n    };\n\n    pushed.push(job);\n\n    return { id: job.id, name, queue };\n  },\n\n  find({ name, id }) {\n    const job = pushed.find((entry) => entry.id === id && entry.name === name);\n\n    if (!job) return undefined;\n\n    return {\n      id: job.id,\n      name: job.name,\n      queue: job.queue,\n      state: \"waiting\",\n      payload: job.payload,\n      progress: 0,\n      attemptsMade: 0,\n      createdAt: job.pushedAt,\n    };\n  },\n};\n\n/**\n * Records every `@warlock.js/queue` dispatch instead of pushing it to Redis.\n *\n * Installed by default in the test environment. Jobs are recorded, not run:\n * call the job's handler directly to test what it does.\n *\n * @example\n * await placeOrder(order);\n *\n * queueFake.assertPushed(sendInvoice, { orderId: order.id });\n * queueFake.assertPushedCount(1);\n */\nexport const queueFake = {\n  /** Start recording (idempotent). Clears anything recorded before. */\n  install(): void {\n    const holder = globalThis as InterceptorHolder;\n\n    if (!installed) {\n      previous = holder[INTERCEPTOR_KEY];\n      installed = true;\n    }\n\n    holder[INTERCEPTOR_KEY] = interceptor;\n    queueFake.clear();\n  },\n\n  /** Stop recording; dispatches reach the broker again. */\n  restore(): void {\n    if (!installed) return;\n\n    (globalThis as InterceptorHolder)[INTERCEPTOR_KEY] = previous;\n    previous = undefined;\n    installed = false;\n    queueFake.clear();\n  },\n\n  isInstalled(): boolean {\n    return installed;\n  },\n\n  /** Forget recorded jobs. */\n  clear(): void {\n    pushed.length = 0;\n    sequence = 0;\n  },\n\n  /** Recorded jobs, oldest first; optionally only one job type. */\n  pushed(job?: JobReference, matcher?: PushedJobMatcher): PushedJob[] {\n    return pushed.filter(\n      (entry) => (job === undefined || entry.name === nameOf(job)) && matches(entry, matcher),\n    );\n  },\n\n  /** Assert `job` was pushed (with a payload matching `matcher`); returns the first match. */\n  assertPushed(job: JobReference, matcher?: PushedJobMatcher): PushedJob {\n    const found = queueFake.pushed(job, matcher)[0];\n\n    if (!found) {\n      throw new FakeAssertionError(\n        `Expected ${nameOf(job)} to be pushed${matcher === undefined ? \"\" : \" with a matching payload\"}. ${describeRecorded(pushed, describeJob, \"pushed\")}`,\n      );\n    }\n\n    return found;\n  },\n\n  /** Assert `job` was not pushed (with a matching payload). */\n  assertNotPushed(job: JobReference, matcher?: PushedJobMatcher): void {\n    const found = queueFake.pushed(job, matcher);\n\n    if (found.length > 0) {\n      throw new FakeAssertionError(\n        `Expected ${nameOf(job)} not to be pushed. ${describeRecorded(found, describeJob, \"pushed\")}`,\n      );\n    }\n  },\n\n  /** Assert exactly `count` jobs were pushed — of type `job` when given. */\n  assertPushedCount(count: number, job?: JobReference): void {\n    const found = queueFake.pushed(job);\n\n    if (found.length !== count) {\n      throw new FakeAssertionError(\n        `Expected ${count} ${job === undefined ? \"job(s)\" : nameOf(job)} pushed, found ${found.length}. ${describeRecorded(pushed, describeJob, \"pushed\")}`,\n      );\n    }\n  },\n\n  /** Assert nothing was pushed. */\n  assertNothingPushed(): void {\n    queueFake.assertPushedCount(0);\n  },\n};\n"],"mappings":";;;;AA0BA,MAAM,kBAAkB,OAAO,IAAI,mCAAmC;AActE,MAAM,SAAsB,CAAC;AAC7B,IAAI,WAAW;AACf,IAAI;AACJ,IAAI,YAAY;AAEhB,SAAS,OAAO,KAA2B;CACzC,OAAO,OAAO,QAAQ,WAAW,MAAM,IAAI;AAC7C;AAEA,SAAS,SAAS,UAAmB,QAA0B;CAC7D,IAAI,aAAa,QAAQ,OAAO;CAChC,IAAI,OAAO,aAAa,YAAY,aAAa,MAAM,OAAO;CAC9D,IAAI,OAAO,WAAW,YAAY,WAAW,MAAM,OAAO;CAE1D,OAAO,OAAO,QAAQ,QAAQ,CAAC,CAAC,OAAO,CAAC,KAAK,WAC3C,SAAS,OAAQ,OAAmC,IAAI,CAC1D;AACF;AAEA,SAAS,QAAQ,KAAgB,SAAgD;CAC/E,IAAI,YAAY,QAAW,OAAO;CAClC,IAAI,OAAO,YAAY,YAAY,OAAO,QAAQ,GAAG;CAErD,OAAO,SAAS,SAAS,IAAI,OAAO;AACtC;AAEA,SAAS,YAAY,KAAwB;CAC3C,OAAO,GAAG,IAAI,KAAK,OAAO,IAAI,MAAM,SAAS,KAAK,UAAU,IAAI,OAAO;AACzE;AAEA,MAAM,cAA2B;CAC/B,SAAS,EAAE,MAAM,OAAO,SAAS,WAAW;EAE1C,MAAM,aAAa,OAAO,QAAQ,UAAU,WAAW,QAAQ,QAAQ;EACvE,MAAM,WAAW,aAAa,OAAO,MAAM,QAAQ,IAAI,OAAO,UAAU,IAAI;EAE5E,IAAI,UAAU,OAAO;GAAE,IAAI,SAAS;GAAI,MAAM,SAAS;GAAM,OAAO,SAAS;EAAM;EAEnF,YAAY;EAEZ,MAAM,MAAiB;GACrB,IAAI,cAAc,QAAQ;GAC1B;GACA;GACA;GACA,SAAS,EAAE,GAAG,QAAQ;GACtB,UAAU,MAAM,IAAI;EACtB;EAEA,OAAO,KAAK,GAAG;EAEf,OAAO;GAAE,IAAI,IAAI;GAAI;GAAM;EAAM;CACnC;CAEA,KAAK,EAAE,MAAM,MAAM;EACjB,MAAM,MAAM,OAAO,MAAM,UAAU,MAAM,OAAO,MAAM,MAAM,SAAS,IAAI;EAEzE,IAAI,CAAC,KAAK,OAAO;EAEjB,OAAO;GACL,IAAI,IAAI;GACR,MAAM,IAAI;GACV,OAAO,IAAI;GACX,OAAO;GACP,SAAS,IAAI;GACb,UAAU;GACV,cAAc;GACd,WAAW,IAAI;EACjB;CACF;AACF;;;;;;;;;;;;;AAcA,MAAa,YAAY;;CAEvB,UAAgB;EACd,MAAM,SAAS;EAEf,IAAI,CAAC,WAAW;GACd,WAAW,OAAO;GAClB,YAAY;EACd;EAEA,OAAO,mBAAmB;EAC1B,UAAU,MAAM;CAClB;;CAGA,UAAgB;EACd,IAAI,CAAC,WAAW;EAEhB,AAAC,WAAiC,mBAAmB;EACrD,WAAW;EACX,YAAY;EACZ,UAAU,MAAM;CAClB;CAEA,cAAuB;EACrB,OAAO;CACT;;CAGA,QAAc;EACZ,OAAO,SAAS;EAChB,WAAW;CACb;;CAGA,OAAO,KAAoB,SAAyC;EAClE,OAAO,OAAO,QACX,WAAW,QAAQ,UAAa,MAAM,SAAS,OAAO,GAAG,MAAM,QAAQ,OAAO,OAAO,CACxF;CACF;;CAGA,aAAa,KAAmB,SAAuC;EACrE,MAAM,QAAQ,UAAU,OAAO,KAAK,OAAO,CAAC,CAAC;EAE7C,IAAI,CAAC,OACH,MAAM,IAAI,mBACR,YAAY,OAAO,GAAG,EAAE,eAAe,YAAY,SAAY,KAAK,2BAA2B,IAAI,iBAAiB,QAAQ,aAAa,QAAQ,GACnJ;EAGF,OAAO;CACT;;CAGA,gBAAgB,KAAmB,SAAkC;EACnE,MAAM,QAAQ,UAAU,OAAO,KAAK,OAAO;EAE3C,IAAI,MAAM,SAAS,GACjB,MAAM,IAAI,mBACR,YAAY,OAAO,GAAG,EAAE,qBAAqB,iBAAiB,OAAO,aAAa,QAAQ,GAC5F;CAEJ;;CAGA,kBAAkB,OAAe,KAA0B;EACzD,MAAM,QAAQ,UAAU,OAAO,GAAG;EAElC,IAAI,MAAM,WAAW,OACnB,MAAM,IAAI,mBACR,YAAY,MAAM,GAAG,QAAQ,SAAY,WAAW,OAAO,GAAG,EAAE,iBAAiB,MAAM,OAAO,IAAI,iBAAiB,QAAQ,aAAa,QAAQ,GAClJ;CAEJ;;CAGA,sBAA4B;EAC1B,UAAU,kBAAkB,CAAC;CAC/B;AACF"}

package/esm/tests/fakes/storage-fake.d.mts

@@ -0,0 +1,31 @@
+import { StorageDriverName } from "../../storage/types.mjs";
+
+//#region ../../packages/core/src/tests/fakes/storage-fake.d.ts
+/**
+ * Points every configured storage driver — local, S3, R2, Spaces — at a
+ * local temporary directory.
+ *
+ * Installed by default in the test environment: uploads and `storage.put()`
+ * calls land on disk under one temp root (a folder per driver name), never in
+ * a bucket and never in the app's real `storage/` folder. The root is shared
+ * with the HTTP test server, so a file an HTTP request stored is visible to
+ * the test that sent it. The process that created the root deletes it on
+ * restore.
+ *
+ * @example
+ * await uploadAvatar(user, file);
+ *
+ * await storageFake.assertExists(`avatars/${user.id}.png`);
+ */
+declare const storageFake: {
+  /** Re-register every driver as a local one under the temp root. */install(): Promise<void>; /** Drop the fake drivers; the real configuration is read again on next use. */
+  restore(): Promise<void>;
+  isInstalled(): boolean; /** The temp directory every fake driver lives under. */
+  root(): string; /** Every stored file, as `<driver>/<path>`, sorted. */
+  files(driver?: StorageDriverName): string[]; /** Assert a file exists, on the default driver unless `driver` is given. */
+  assertExists(location: string, driver?: StorageDriverName): Promise<void>; /** Assert a file does not exist, on the default driver unless `driver` is given. */
+  assertMissing(location: string, driver?: StorageDriverName): Promise<void>;
+};
+//#endregion
+export { storageFake };
+//# sourceMappingURL=storage-fake.d.mts.map

package/esm/tests/fakes/storage-fake.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage-fake.d.mts","names":[],"sources":["../../../../../../../../../packages/core/src/tests/fakes/storage-fake.ts"],"mappings":";;;;;;;;;;;;;;;;;;;cA2Da,WAAA;gFAEM,OAAA,QA6EkB;aAtClB,OAAA;;kBAmDmB;iBArBrB,iBAAA,aAqB2D;iCAbvC,MAAA,GAAW,iBAAA,GAAoB,OAAA;kCAa9B,MAAA,GAAW,iBAAA,GAAoB,OAAA;AAAA"}

package/esm/tests/fakes/storage-fake.mjs

@@ -0,0 +1,122 @@
+import { storageConfigurations } from "../../storage/config.mjs";
+import { storage } from "../../storage/storage.mjs";
+import "../../storage/index.mjs";
+import { FakeAssertionError } from "./fake-assertion-error.mjs";
+import path from "node:path";
+import { existsSync, mkdirSync, mkdtempSync, readdirSync, rmSync } from "node:fs";
+import os from "node:os";
+
+//#region ../../packages/core/src/tests/fakes/storage-fake.ts
+/**
+* The env var that carries the fake storage root from the process that
+* created it (the HTTP test server, in `globalSetup`) to the test workers it
+* spawns, so both sides read and write the same files. Like
+* `WARLOCK_TEST_SERVER_PORT`, it is plumbing between the kit's own processes.
+*/
+const TEST_STORAGE_ROOT_ENV_KEY = "WARLOCK_TEST_STORAGE_ROOT";
+let root;
+let ownsRoot = false;
+let installed = false;
+let wasInitialized = false;
+function currentRoot() {
+	if (!root) throw new FakeAssertionError("storageFake is not installed. It installs by default in the test environment; check `tests.fakes` in src/config/tests.ts, or call storageFake.install().");
+	return root;
+}
+function listFiles(directory, base) {
+	if (!existsSync(directory)) return [];
+	return readdirSync(directory, { withFileTypes: true }).flatMap((entry) => {
+		const absolute = path.join(directory, entry.name);
+		return entry.isDirectory() ? listFiles(absolute, base) : [path.relative(base, absolute).split(path.sep).join("/")];
+	});
+}
+/**
+* Points every configured storage driver — local, S3, R2, Spaces — at a
+* local temporary directory.
+*
+* Installed by default in the test environment: uploads and `storage.put()`
+* calls land on disk under one temp root (a folder per driver name), never in
+* a bucket and never in the app's real `storage/` folder. The root is shared
+* with the HTTP test server, so a file an HTTP request stored is visible to
+* the test that sent it. The process that created the root deletes it on
+* restore.
+*
+* @example
+* await uploadAvatar(user, file);
+*
+* await storageFake.assertExists(`avatars/${user.id}.png`);
+*/
+const storageFake = {
+	/** Re-register every driver as a local one under the temp root. */
+	async install() {
+		if (!installed) {
+			wasInitialized = storage.isInitialized;
+			installed = true;
+		}
+		if (!root) {
+			const shared = process.env[TEST_STORAGE_ROOT_ENV_KEY];
+			if (shared) {
+				root = shared;
+				ownsRoot = false;
+			} else {
+				root = mkdtempSync(path.join(os.tmpdir(), "warlock-test-storage-"));
+				ownsRoot = true;
+				process.env[TEST_STORAGE_ROOT_ENV_KEY] = root;
+			}
+		}
+		await storage.init();
+		const fakeRoot = root;
+		for (const name of storage.driverNames()) {
+			const driverRoot = path.join(fakeRoot, name);
+			mkdirSync(driverRoot, { recursive: true });
+			storage.register(name, storageConfigurations.local({
+				root: driverRoot,
+				urlPrefix: `/test-storage/${name}`
+			}));
+		}
+		const defaultName = storage.getDefaultName();
+		if (defaultName) storage.setDefault(defaultName);
+	},
+	/** Drop the fake drivers; the real configuration is read again on next use. */
+	async restore() {
+		if (!installed) return;
+		installed = false;
+		storage.reset();
+		if (wasInitialized) await storage.init();
+		if (root && ownsRoot) {
+			rmSync(root, {
+				recursive: true,
+				force: true
+			});
+			if (process.env["WARLOCK_TEST_STORAGE_ROOT"] === root) delete process.env[TEST_STORAGE_ROOT_ENV_KEY];
+		}
+		root = void 0;
+		ownsRoot = false;
+	},
+	isInstalled() {
+		return installed;
+	},
+	/** The temp directory every fake driver lives under. */
+	root() {
+		return currentRoot();
+	},
+	/** Every stored file, as `<driver>/<path>`, sorted. */
+	files(driver) {
+		const base = currentRoot();
+		const directory = driver ? path.join(base, driver) : base;
+		return listFiles(directory, directory).sort();
+	},
+	/** Assert a file exists, on the default driver unless `driver` is given. */
+	async assertExists(location, driver) {
+		currentRoot();
+		if (!await (driver ? storage.use(driver) : storage).exists(location)) throw new FakeAssertionError(`Expected ${JSON.stringify(location)} to be stored${driver ? ` on "${driver}"` : ""}. Stored files: ${JSON.stringify(storageFake.files())}.`);
+	},
+	/** Assert a file does not exist, on the default driver unless `driver` is given. */
+	async assertMissing(location, driver) {
+		currentRoot();
+		if (await (driver ? storage.use(driver) : storage).exists(location)) throw new FakeAssertionError(`Expected ${JSON.stringify(location)} not to be stored${driver ? ` on "${driver}"` : ""}, but it is.`);
+	}
+};
+
+//#endregion
+export { storageFake };
+//# sourceMappingURL=storage-fake.mjs.map

package/esm/tests/fakes/storage-fake.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage-fake.mjs","names":[],"sources":["../../../../../../../../../packages/core/src/tests/fakes/storage-fake.ts"],"sourcesContent":["import { existsSync, mkdirSync, mkdtempSync, readdirSync, rmSync } from \"node:fs\";\nimport os from \"node:os\";\nimport path from \"node:path\";\nimport { storage } from \"../../storage\";\nimport { storageConfigurations } from \"../../storage/config\";\nimport type { StorageDriverName } from \"../../storage/types\";\nimport { FakeAssertionError } from \"./fake-assertion-error\";\n\n/**\n * The env var that carries the fake storage root from the process that\n * created it (the HTTP test server, in `globalSetup`) to the test workers it\n * spawns, so both sides read and write the same files. Like\n * `WARLOCK_TEST_SERVER_PORT`, it is plumbing between the kit's own processes.\n */\nexport const TEST_STORAGE_ROOT_ENV_KEY = \"WARLOCK_TEST_STORAGE_ROOT\";\n\nlet root: string | undefined;\nlet ownsRoot = false;\nlet installed = false;\nlet wasInitialized = false;\n\nfunction currentRoot(): string {\n  if (!root) {\n    throw new FakeAssertionError(\n      \"storageFake is not installed. It installs by default in the test environment; check `tests.fakes` in src/config/tests.ts, or call storageFake.install().\",\n    );\n  }\n\n  return root;\n}\n\nfunction listFiles(directory: string, base: string): string[] {\n  if (!existsSync(directory)) return [];\n\n  return readdirSync(directory, { withFileTypes: true }).flatMap((entry) => {\n    const absolute = path.join(directory, entry.name);\n\n    return entry.isDirectory()\n      ? listFiles(absolute, base)\n      : [path.relative(base, absolute).split(path.sep).join(\"/\")];\n  });\n}\n\n/**\n * Points every configured storage driver — local, S3, R2, Spaces — at a\n * local temporary directory.\n *\n * Installed by default in the test environment: uploads and `storage.put()`\n * calls land on disk under one temp root (a folder per driver name), never in\n * a bucket and never in the app's real `storage/` folder. The root is shared\n * with the HTTP test server, so a file an HTTP request stored is visible to\n * the test that sent it. The process that created the root deletes it on\n * restore.\n *\n * @example\n * await uploadAvatar(user, file);\n *\n * await storageFake.assertExists(`avatars/${user.id}.png`);\n */\nexport const storageFake = {\n  /** Re-register every driver as a local one under the temp root. */\n  async install(): Promise<void> {\n    if (!installed) {\n      wasInitialized = storage.isInitialized;\n      installed = true;\n    }\n\n    if (!root) {\n      const shared = process.env[TEST_STORAGE_ROOT_ENV_KEY];\n\n      if (shared) {\n        root = shared;\n        ownsRoot = false;\n      } else {\n        root = mkdtempSync(path.join(os.tmpdir(), \"warlock-test-storage-\"));\n        ownsRoot = true;\n        process.env[TEST_STORAGE_ROOT_ENV_KEY] = root;\n      }\n    }\n\n    await storage.init();\n\n    const fakeRoot = root;\n\n    for (const name of storage.driverNames()) {\n      const driverRoot = path.join(fakeRoot, name);\n\n      mkdirSync(driverRoot, { recursive: true });\n      storage.register(\n        name,\n        storageConfigurations.local({ root: driverRoot, urlPrefix: `/test-storage/${name}` }),\n      );\n    }\n\n    const defaultName = storage.getDefaultName();\n\n    if (defaultName) storage.setDefault(defaultName);\n  },\n\n  /** Drop the fake drivers; the real configuration is read again on next use. */\n  async restore(): Promise<void> {\n    if (!installed) return;\n\n    installed = false;\n    storage.reset();\n\n    if (wasInitialized) await storage.init();\n\n    if (root && ownsRoot) {\n      rmSync(root, { recursive: true, force: true });\n\n      if (process.env[TEST_STORAGE_ROOT_ENV_KEY] === root) {\n        delete process.env[TEST_STORAGE_ROOT_ENV_KEY];\n      }\n    }\n\n    root = undefined;\n    ownsRoot = false;\n  },\n\n  isInstalled(): boolean {\n    return installed;\n  },\n\n  /** The temp directory every fake driver lives under. */\n  root(): string {\n    return currentRoot();\n  },\n\n  /** Every stored file, as `<driver>/<path>`, sorted. */\n  files(driver?: StorageDriverName): string[] {\n    const base = currentRoot();\n    const directory = driver ? path.join(base, driver) : base;\n\n    return listFiles(directory, directory).sort();\n  },\n\n  /** Assert a file exists, on the default driver unless `driver` is given. */\n  async assertExists(location: string, driver?: StorageDriverName): Promise<void> {\n    currentRoot();\n\n    const target = driver ? storage.use(driver) : storage;\n\n    if (!(await target.exists(location))) {\n      throw new FakeAssertionError(\n        `Expected ${JSON.stringify(location)} to be stored${driver ? ` on \"${driver}\"` : \"\"}. Stored files: ${JSON.stringify(storageFake.files())}.`,\n      );\n    }\n  },\n\n  /** Assert a file does not exist, on the default driver unless `driver` is given. */\n  async assertMissing(location: string, driver?: StorageDriverName): Promise<void> {\n    currentRoot();\n\n    const target = driver ? storage.use(driver) : storage;\n\n    if (await target.exists(location)) {\n      throw new FakeAssertionError(\n        `Expected ${JSON.stringify(location)} not to be stored${driver ? ` on \"${driver}\"` : \"\"}, but it is.`,\n      );\n    }\n  },\n};\n"],"mappings":";;;;;;;;;;;;;;;AAcA,MAAa,4BAA4B;AAEzC,IAAI;AACJ,IAAI,WAAW;AACf,IAAI,YAAY;AAChB,IAAI,iBAAiB;AAErB,SAAS,cAAsB;CAC7B,IAAI,CAAC,MACH,MAAM,IAAI,mBACR,0JACF;CAGF,OAAO;AACT;AAEA,SAAS,UAAU,WAAmB,MAAwB;CAC5D,IAAI,CAAC,WAAW,SAAS,GAAG,OAAO,CAAC;CAEpC,OAAO,YAAY,WAAW,EAAE,eAAe,KAAK,CAAC,CAAC,CAAC,SAAS,UAAU;EACxE,MAAM,WAAW,KAAK,KAAK,WAAW,MAAM,IAAI;EAEhD,OAAO,MAAM,YAAY,IACrB,UAAU,UAAU,IAAI,IACxB,CAAC,KAAK,SAAS,MAAM,QAAQ,CAAC,CAAC,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC;CAC9D,CAAC;AACH;;;;;;;;;;;;;;;;;AAkBA,MAAa,cAAc;;CAEzB,MAAM,UAAyB;EAC7B,IAAI,CAAC,WAAW;GACd,iBAAiB,QAAQ;GACzB,YAAY;EACd;EAEA,IAAI,CAAC,MAAM;GACT,MAAM,SAAS,QAAQ,IAAI;GAE3B,IAAI,QAAQ;IACV,OAAO;IACP,WAAW;GACb,OAAO;IACL,OAAO,YAAY,KAAK,KAAK,GAAG,OAAO,GAAG,uBAAuB,CAAC;IAClE,WAAW;IACX,QAAQ,IAAI,6BAA6B;GAC3C;EACF;EAEA,MAAM,QAAQ,KAAK;EAEnB,MAAM,WAAW;EAEjB,KAAK,MAAM,QAAQ,QAAQ,YAAY,GAAG;GACxC,MAAM,aAAa,KAAK,KAAK,UAAU,IAAI;GAE3C,UAAU,YAAY,EAAE,WAAW,KAAK,CAAC;GACzC,QAAQ,SACN,MACA,sBAAsB,MAAM;IAAE,MAAM;IAAY,WAAW,iBAAiB;GAAO,CAAC,CACtF;EACF;EAEA,MAAM,cAAc,QAAQ,eAAe;EAE3C,IAAI,aAAa,QAAQ,WAAW,WAAW;CACjD;;CAGA,MAAM,UAAyB;EAC7B,IAAI,CAAC,WAAW;EAEhB,YAAY;EACZ,QAAQ,MAAM;EAEd,IAAI,gBAAgB,MAAM,QAAQ,KAAK;EAEvC,IAAI,QAAQ,UAAU;GACpB,OAAO,MAAM;IAAE,WAAW;IAAM,OAAO;GAAK,CAAC;GAE7C,IAAI,QAAQ,qCAAmC,MAC7C,OAAO,QAAQ,IAAI;EAEvB;EAEA,OAAO;EACP,WAAW;CACb;CAEA,cAAuB;EACrB,OAAO;CACT;;CAGA,OAAe;EACb,OAAO,YAAY;CACrB;;CAGA,MAAM,QAAsC;EAC1C,MAAM,OAAO,YAAY;EACzB,MAAM,YAAY,SAAS,KAAK,KAAK,MAAM,MAAM,IAAI;EAErD,OAAO,UAAU,WAAW,SAAS,CAAC,CAAC,KAAK;CAC9C;;CAGA,MAAM,aAAa,UAAkB,QAA2C;EAC9E,YAAY;EAIZ,IAAI,CAAE,OAFS,SAAS,QAAQ,IAAI,MAAM,IAAI,QAE5B,CAAC,OAAO,QAAQ,GAChC,MAAM,IAAI,mBACR,YAAY,KAAK,UAAU,QAAQ,EAAE,eAAe,SAAS,QAAQ,OAAO,KAAK,GAAG,kBAAkB,KAAK,UAAU,YAAY,MAAM,CAAC,EAAE,EAC5I;CAEJ;;CAGA,MAAM,cAAc,UAAkB,QAA2C;EAC/E,YAAY;EAIZ,IAAI,OAFW,SAAS,QAAQ,IAAI,MAAM,IAAI,QAE9B,CAAC,OAAO,QAAQ,GAC9B,MAAM,IAAI,mBACR,YAAY,KAAK,UAAU,QAAQ,EAAE,mBAAmB,SAAS,QAAQ,OAAO,KAAK,GAAG,aAC1F;CAEJ;AACF"}

package/esm/tests/fakes/test-fakes.d.mts

@@ -0,0 +1,39 @@
+//#region ../../packages/core/src/tests/fakes/test-fakes.d.ts
+/** The fakes the test kit installs. */
+declare const TEST_FAKE_NAMES: readonly ["mail", "queue", "cache", "storage", "clock", "ids"];
+type TestFakeName = (typeof TEST_FAKE_NAMES)[number];
+/**
+ * Which fakes to install.
+ *
+ * - `true` (the default) — all of them.
+ * - `false` — none: real drivers, real clock, real ids.
+ * - an object — all of them except the ones set to `false`, e.g.
+ *   `{ cache: false }` keeps the configured cache driver.
+ */
+type TestFakesSelection = boolean | Partial<Record<TestFakeName, boolean>>;
+/** Read `tests.fakes` from `src/config/tests.ts`, or `undefined` when unset. */
+declare function readConfiguredFakes(): TestFakesSelection | undefined;
+/**
+ * The fakes to install. Precedence: an explicit selection (the `fakes`
+ * option of `setupTest()` / `startHttpTestServer()`) > `tests.fakes` in
+ * `src/config/tests.ts` > all on.
+ */
+declare function resolveTestFakes(explicit?: TestFakesSelection): TestFakeName[];
+/**
+ * Install the selected fakes. Called by `setupTest()` and
+ * `startHttpTestServer()` once their connectors are up; call it yourself only
+ * when you bootstrap the framework without them.
+ *
+ * @returns the fakes that are now installed.
+ */
+declare function installTestFakes(explicit?: TestFakesSelection): Promise<TestFakeName[]>;
+/**
+ * Restore every installed fake, in reverse order. Every fake is restored even
+ * when one fails; the failures are rethrown together afterwards.
+ */
+declare function restoreTestFakes(): Promise<void>;
+/** The fakes installed right now. */
+declare function installedTestFakes(): TestFakeName[];
+//#endregion
+export { TEST_FAKE_NAMES, TestFakeName, TestFakesSelection, installTestFakes, installedTestFakes, readConfiguredFakes, resolveTestFakes, restoreTestFakes };
+//# sourceMappingURL=test-fakes.d.mts.map

package/esm/tests/fakes/test-fakes.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-fakes.d.mts","names":[],"sources":["../../../../../../../../../packages/core/src/tests/fakes/test-fakes.ts"],"mappings":";;cAUa,eAAA;AAAA,KAED,YAAA,WAAuB,eAAe;;;AAF2C;AAE7F;;;;AAAkD;KAUtC,kBAAA,aAA+B,OAAA,CAAQ,MAAA,CAAO,YAAA;;iBAiB1C,mBAAA,IAAuB,kBAAkB;;;;;;iBA0CzC,gBAAA,CAAiB,QAAA,GAAW,kBAAA,GAAqB,YAAY;;;;AA3DP;AAiBtE;;;iBA2DsB,gBAAA,CAAiB,QAAA,GAAW,kBAAA,GAAqB,OAAA,CAAQ,YAAA;AA3DtB;AA0CzD;;;AA1CyD,iBA2EnC,gBAAA,IAAoB,OAAO;;iBAiBjC,kBAAA,IAAsB,YAAY"}

package/esm/tests/fakes/test-fakes.mjs

@@ -0,0 +1,90 @@
+import { config } from "../../config/config-getter.mjs";
+import "../../config/index.mjs";
+import { cacheFake } from "./cache-fake.mjs";
+import { clockFake } from "./clock-fake.mjs";
+import { idsFake } from "./ids-fake.mjs";
+import { mailFake } from "./mail-fake.mjs";
+import { queueFake } from "./queue-fake.mjs";
+import { storageFake } from "./storage-fake.mjs";
+
+//#region ../../packages/core/src/tests/fakes/test-fakes.ts
+/** The fakes the test kit installs. */
+const TEST_FAKE_NAMES = [
+	"mail",
+	"queue",
+	"cache",
+	"storage",
+	"clock",
+	"ids"
+];
+const fakes = {
+	mail: mailFake,
+	queue: queueFake,
+	cache: cacheFake,
+	storage: storageFake,
+	clock: clockFake,
+	ids: idsFake
+};
+let active = [];
+/** Read `tests.fakes` from `src/config/tests.ts`, or `undefined` when unset. */
+function readConfiguredFakes() {
+	return validateSelection((config.get("tests", {}) ?? {}).fakes, "tests.fakes");
+}
+function validateSelection(value, source) {
+	if (value === void 0 || typeof value === "boolean") return value;
+	if (typeof value !== "object" || value === null || Array.isArray(value)) throw new Error(`${source} must be true, false, or an object such as { cache: false }; got ${JSON.stringify(value)}.`);
+	const selection = {};
+	for (const [key, flag] of Object.entries(value)) {
+		const name = TEST_FAKE_NAMES.find((candidate) => candidate === key);
+		if (!name) throw new Error(`${source} has an unknown fake "${key}". Known fakes: ${TEST_FAKE_NAMES.join(", ")}.`);
+		if (typeof flag !== "boolean") throw new Error(`${source}.${key} must be true or false; got ${JSON.stringify(flag)}.`);
+		selection[name] = flag;
+	}
+	return selection;
+}
+/**
+* The fakes to install. Precedence: an explicit selection (the `fakes`
+* option of `setupTest()` / `startHttpTestServer()`) > `tests.fakes` in
+* `src/config/tests.ts` > all on.
+*/
+function resolveTestFakes(explicit) {
+	const selection = explicit !== void 0 ? validateSelection(explicit, "fakes") : readConfiguredFakes();
+	if (selection === void 0 || selection === true) return [...TEST_FAKE_NAMES];
+	if (selection === false) return [];
+	return TEST_FAKE_NAMES.filter((name) => selection[name] !== false);
+}
+/**
+* Install the selected fakes. Called by `setupTest()` and
+* `startHttpTestServer()` once their connectors are up; call it yourself only
+* when you bootstrap the framework without them.
+*
+* @returns the fakes that are now installed.
+*/
+async function installTestFakes(explicit) {
+	const selected = resolveTestFakes(explicit);
+	for (const name of selected) await fakes[name].install();
+	active = [...new Set([...active, ...selected])];
+	return selected;
+}
+/**
+* Restore every installed fake, in reverse order. Every fake is restored even
+* when one fails; the failures are rethrown together afterwards.
+*/
+async function restoreTestFakes() {
+	const errors = [];
+	for (const name of [...active].reverse()) try {
+		await fakes[name].restore();
+	} catch (error) {
+		errors.push(error);
+	}
+	active = [];
+	if (errors.length > 0) throw new AggregateError(errors, "Restoring the test fakes failed.");
+}
+/** The fakes installed right now. */
+function installedTestFakes() {
+	return [...active];
+}
+
+//#endregion
+export { TEST_FAKE_NAMES, installTestFakes, installedTestFakes, readConfiguredFakes, resolveTestFakes, restoreTestFakes };
+//# sourceMappingURL=test-fakes.mjs.map

package/esm/tests/fakes/test-fakes.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-fakes.mjs","names":[],"sources":["../../../../../../../../../packages/core/src/tests/fakes/test-fakes.ts"],"sourcesContent":["import type { GenericObject } from \"@mongez/reinforcements\";\nimport { config } from \"../../config\";\nimport { cacheFake } from \"./cache-fake\";\nimport { clockFake } from \"./clock-fake\";\nimport { idsFake } from \"./ids-fake\";\nimport { mailFake } from \"./mail-fake\";\nimport { queueFake } from \"./queue-fake\";\nimport { storageFake } from \"./storage-fake\";\n\n/** The fakes the test kit installs. */\nexport const TEST_FAKE_NAMES = [\"mail\", \"queue\", \"cache\", \"storage\", \"clock\", \"ids\"] as const;\n\nexport type TestFakeName = (typeof TEST_FAKE_NAMES)[number];\n\n/**\n * Which fakes to install.\n *\n * - `true` (the default) — all of them.\n * - `false` — none: real drivers, real clock, real ids.\n * - an object — all of them except the ones set to `false`, e.g.\n *   `{ cache: false }` keeps the configured cache driver.\n */\nexport type TestFakesSelection = boolean | Partial<Record<TestFakeName, boolean>>;\n\nconst fakes: Record<\n  TestFakeName,\n  { install(): void | Promise<void>; restore(): void | Promise<void> }\n> = {\n  mail: mailFake,\n  queue: queueFake,\n  cache: cacheFake,\n  storage: storageFake,\n  clock: clockFake,\n  ids: idsFake,\n};\n\nlet active: TestFakeName[] = [];\n\n/** Read `tests.fakes` from `src/config/tests.ts`, or `undefined` when unset. */\nexport function readConfiguredFakes(): TestFakesSelection | undefined {\n  // `config.get` resolves an absent key to `null`, not to its default's shape.\n  const testsConfig = config.get<GenericObject>(\"tests\", {}) ?? {};\n\n  return validateSelection(testsConfig.fakes as unknown, \"tests.fakes\");\n}\n\nfunction validateSelection(value: unknown, source: string): TestFakesSelection | undefined {\n  if (value === undefined || typeof value === \"boolean\") return value;\n\n  if (typeof value !== \"object\" || value === null || Array.isArray(value)) {\n    throw new Error(\n      `${source} must be true, false, or an object such as { cache: false }; got ${JSON.stringify(value)}.`,\n    );\n  }\n\n  const selection: Partial<Record<TestFakeName, boolean>> = {};\n\n  for (const [key, flag] of Object.entries(value)) {\n    const name = TEST_FAKE_NAMES.find((candidate) => candidate === key);\n\n    if (!name) {\n      throw new Error(\n        `${source} has an unknown fake \"${key}\". Known fakes: ${TEST_FAKE_NAMES.join(\", \")}.`,\n      );\n    }\n\n    if (typeof flag !== \"boolean\") {\n      throw new Error(`${source}.${key} must be true or false; got ${JSON.stringify(flag)}.`);\n    }\n\n    selection[name] = flag;\n  }\n\n  return selection;\n}\n\n/**\n * The fakes to install. Precedence: an explicit selection (the `fakes`\n * option of `setupTest()` / `startHttpTestServer()`) > `tests.fakes` in\n * `src/config/tests.ts` > all on.\n */\nexport function resolveTestFakes(explicit?: TestFakesSelection): TestFakeName[] {\n  const selection =\n    explicit !== undefined ? validateSelection(explicit, \"fakes\") : readConfiguredFakes();\n\n  if (selection === undefined || selection === true) return [...TEST_FAKE_NAMES];\n  if (selection === false) return [];\n\n  return TEST_FAKE_NAMES.filter((name) => selection[name] !== false);\n}\n\n/**\n * Install the selected fakes. Called by `setupTest()` and\n * `startHttpTestServer()` once their connectors are up; call it yourself only\n * when you bootstrap the framework without them.\n *\n * @returns the fakes that are now installed.\n */\nexport async function installTestFakes(explicit?: TestFakesSelection): Promise<TestFakeName[]> {\n  const selected = resolveTestFakes(explicit);\n\n  for (const name of selected) {\n    await fakes[name].install();\n  }\n\n  active = [...new Set([...active, ...selected])];\n\n  return selected;\n}\n\n/**\n * Restore every installed fake, in reverse order. Every fake is restored even\n * when one fails; the failures are rethrown together afterwards.\n */\nexport async function restoreTestFakes(): Promise<void> {\n  const errors: unknown[] = [];\n\n  for (const name of [...active].reverse()) {\n    try {\n      await fakes[name].restore();\n    } catch (error) {\n      errors.push(error);\n    }\n  }\n\n  active = [];\n\n  if (errors.length > 0) throw new AggregateError(errors, \"Restoring the test fakes failed.\");\n}\n\n/** The fakes installed right now. */\nexport function installedTestFakes(): TestFakeName[] {\n  return [...active];\n}\n"],"mappings":";;;;;;;;;;;AAUA,MAAa,kBAAkB;CAAC;CAAQ;CAAS;CAAS;CAAW;CAAS;AAAK;AAcnF,MAAM,QAGF;CACF,MAAM;CACN,OAAO;CACP,OAAO;CACP,SAAS;CACT,OAAO;CACP,KAAK;AACP;AAEA,IAAI,SAAyB,CAAC;;AAG9B,SAAgB,sBAAsD;CAIpE,OAAO,mBAFa,OAAO,IAAmB,SAAS,CAAC,CAAC,KAAK,CAAC,EAE3B,CAAC,OAAkB,aAAa;AACtE;AAEA,SAAS,kBAAkB,OAAgB,QAAgD;CACzF,IAAI,UAAU,UAAa,OAAO,UAAU,WAAW,OAAO;CAE9D,IAAI,OAAO,UAAU,YAAY,UAAU,QAAQ,MAAM,QAAQ,KAAK,GACpE,MAAM,IAAI,MACR,GAAG,OAAO,mEAAmE,KAAK,UAAU,KAAK,EAAE,EACrG;CAGF,MAAM,YAAoD,CAAC;CAE3D,KAAK,MAAM,CAAC,KAAK,SAAS,OAAO,QAAQ,KAAK,GAAG;EAC/C,MAAM,OAAO,gBAAgB,MAAM,cAAc,cAAc,GAAG;EAElE,IAAI,CAAC,MACH,MAAM,IAAI,MACR,GAAG,OAAO,wBAAwB,IAAI,kBAAkB,gBAAgB,KAAK,IAAI,EAAE,EACrF;EAGF,IAAI,OAAO,SAAS,WAClB,MAAM,IAAI,MAAM,GAAG,OAAO,GAAG,IAAI,8BAA8B,KAAK,UAAU,IAAI,EAAE,EAAE;EAGxF,UAAU,QAAQ;CACpB;CAEA,OAAO;AACT;;;;;;AAOA,SAAgB,iBAAiB,UAA+C;CAC9E,MAAM,YACJ,aAAa,SAAY,kBAAkB,UAAU,OAAO,IAAI,oBAAoB;CAEtF,IAAI,cAAc,UAAa,cAAc,MAAM,OAAO,CAAC,GAAG,eAAe;CAC7E,IAAI,cAAc,OAAO,OAAO,CAAC;CAEjC,OAAO,gBAAgB,QAAQ,SAAS,UAAU,UAAU,KAAK;AACnE;;;;;;;;AASA,eAAsB,iBAAiB,UAAwD;CAC7F,MAAM,WAAW,iBAAiB,QAAQ;CAE1C,KAAK,MAAM,QAAQ,UACjB,MAAM,MAAM,KAAK,CAAC,QAAQ;CAG5B,SAAS,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,QAAQ,GAAG,QAAQ,CAAC,CAAC;CAE9C,OAAO;AACT;;;;;AAMA,eAAsB,mBAAkC;CACtD,MAAM,SAAoB,CAAC;CAE3B,KAAK,MAAM,QAAQ,CAAC,GAAG,MAAM,CAAC,CAAC,QAAQ,GACrC,IAAI;EACF,MAAM,MAAM,KAAK,CAAC,QAAQ;CAC5B,SAAS,OAAO;EACd,OAAO,KAAK,KAAK;CACnB;CAGF,SAAS,CAAC;CAEV,IAAI,OAAO,SAAS,GAAG,MAAM,IAAI,eAAe,QAAQ,kCAAkC;AAC5F;;AAGA,SAAgB,qBAAqC;CACnD,OAAO,CAAC,GAAG,MAAM;AACnB"}

package/esm/tests/index.d.mts

@@ -1,6 +1,18 @@
 import { assertPortIsAvailable, isPortAvailable } from "../http/port-preflight.mjs";
+import { TEST_FAKE_NAMES, TestFakeName, TestFakesSelection, installTestFakes, installedTestFakes, readConfiguredFakes, resolveTestFakes, restoreTestFakes } from "./fakes/test-fakes.mjs";
 import { StartHttpTestServerOptions, isTestServerRunning, startHttpTestServer, stopHttpTestServer } from "./start-http-development-server.mjs";
-import { expectJson, getTestServerUrl, parseJsonResponse, testDelete, testGet, testPatch, testPost, testPut, testRequest } from "./test-helpers.mjs";
+import { TestRequestClient, createTestRequestClient, expectJson, getTestServerUrl, parseJsonResponse, testDelete, testGet, testPatch, testPost, testPut, testRequest } from "./test-helpers.mjs";
+import { AuthenticatedTestClient, TestAuthenticableUser, actingAs } from "./authenticated-test-client.mjs";
 import { TestConnectorsSelection } from "./test-connectors-selection.mjs";
 import { TestLifecycleError, TestSetupOptions, setupTest, teardownTest, warnMissingImportModule } from "./vitest-setup.mjs";
-export { StartHttpTestServerOptions, type TestConnectorsSelection, TestLifecycleError, TestSetupOptions, assertPortIsAvailable, expectJson, getTestServerUrl, isPortAvailable, isTestServerRunning, parseJsonResponse, setupTest, startHttpTestServer, stopHttpTestServer, teardownTest, testDelete, testGet, testPatch, testPost, testPut, testRequest, warnMissingImportModule };
+import { cacheFake } from "./fakes/cache-fake.mjs";
+import { DEFAULT_FAKE_NOW, clockFake } from "./fakes/clock-fake.mjs";
+import { FakeAssertionError, describeRecorded } from "./fakes/fake-assertion-error.mjs";
+import { idsFake } from "./fakes/ids-fake.mjs";
+import { MailMatcher, mailFake } from "./fakes/mail-fake.mjs";
+import { JobReference, PushedJob, PushedJobMatcher, queueFake } from "./fakes/queue-fake.mjs";
+import { storageFake } from "./fakes/storage-fake.mjs";
+import { Factory, FactoryAttributes, FactoryOverrides, FactorySeed, FactoryState, defineFactory, resetFactorySequences } from "./factories.mjs";
+import { CreateTestHttpServerOptions, TestHttpServer, createTestHttpServer } from "./test-http-server.mjs";
+import { REDACTED, ResponseSnapshot, SnapshotResponseOptions, snapshotResponse } from "./snapshot-response.mjs";
+export { AuthenticatedTestClient, CreateTestHttpServerOptions, DEFAULT_FAKE_NOW, Factory, FactoryAttributes, FactoryOverrides, FactorySeed, FactoryState, FakeAssertionError, JobReference, MailMatcher, PushedJob, PushedJobMatcher, REDACTED, ResponseSnapshot, SnapshotResponseOptions, StartHttpTestServerOptions, TEST_FAKE_NAMES, TestAuthenticableUser, type TestConnectorsSelection, TestFakeName, TestFakesSelection, TestHttpServer, TestLifecycleError, TestRequestClient, TestSetupOptions, actingAs, assertPortIsAvailable, cacheFake, clockFake, createTestHttpServer, createTestRequestClient, defineFactory, describeRecorded, expectJson, getTestServerUrl, idsFake, installTestFakes, installedTestFakes, isPortAvailable, isTestServerRunning, mailFake, parseJsonResponse, queueFake, readConfiguredFakes, resetFactorySequences, resolveTestFakes, restoreTestFakes, setupTest, snapshotResponse, startHttpTestServer, stopHttpTestServer, storageFake, teardownTest, testDelete, testGet, testPatch, testPost, testPut, testRequest, warnMissingImportModule };

package/esm/tests/index.mjs

@@ -1,6 +1,19 @@
 import { assertPortIsAvailable, isPortAvailable } from "../http/port-preflight.mjs";
+import { FakeAssertionError, describeRecorded } from "./fakes/fake-assertion-error.mjs";
+import { cacheFake } from "./fakes/cache-fake.mjs";
+import { DEFAULT_FAKE_NOW, clockFake } from "./fakes/clock-fake.mjs";
+import { idsFake } from "./fakes/ids-fake.mjs";
+import { mailFake } from "./fakes/mail-fake.mjs";
+import { queueFake } from "./fakes/queue-fake.mjs";
+import { storageFake } from "./fakes/storage-fake.mjs";
+import { TEST_FAKE_NAMES, installTestFakes, installedTestFakes, readConfiguredFakes, resolveTestFakes, restoreTestFakes } from "./fakes/test-fakes.mjs";
 import { isTestServerRunning, startHttpTestServer, stopHttpTestServer } from "./start-http-development-server.mjs";
-import { expectJson, getTestServerUrl, parseJsonResponse, testDelete, testGet, testPatch, testPost, testPut, testRequest } from "./test-helpers.mjs";
+import { createTestRequestClient, expectJson, getTestServerUrl, parseJsonResponse, testDelete, testGet, testPatch, testPost, testPut, testRequest } from "./test-helpers.mjs";
+import { actingAs } from "./authenticated-test-client.mjs";
 import { TestLifecycleError, setupTest, teardownTest, warnMissingImportModule } from "./vitest-setup.mjs";
+import "./fakes/index.mjs";
+import { defineFactory, resetFactorySequences } from "./factories.mjs";
+import { createTestHttpServer } from "./test-http-server.mjs";
+import { REDACTED, snapshotResponse } from "./snapshot-response.mjs";
 
-export { TestLifecycleError, assertPortIsAvailable, expectJson, getTestServerUrl, isPortAvailable, isTestServerRunning, parseJsonResponse, setupTest, startHttpTestServer, stopHttpTestServer, teardownTest, testDelete, testGet, testPatch, testPost, testPut, testRequest, warnMissingImportModule };
+export { DEFAULT_FAKE_NOW, FakeAssertionError, REDACTED, TEST_FAKE_NAMES, TestLifecycleError, actingAs, assertPortIsAvailable, cacheFake, clockFake, createTestHttpServer, createTestRequestClient, defineFactory, describeRecorded, expectJson, getTestServerUrl, idsFake, installTestFakes, installedTestFakes, isPortAvailable, isTestServerRunning, mailFake, parseJsonResponse, queueFake, readConfiguredFakes, resetFactorySequences, resolveTestFakes, restoreTestFakes, setupTest, snapshotResponse, startHttpTestServer, stopHttpTestServer, storageFake, teardownTest, testDelete, testGet, testPatch, testPost, testPut, testRequest, warnMissingImportModule };

package/esm/tests/snapshot-response.d.mts

@@ -0,0 +1,34 @@
+//#region ../../packages/core/src/tests/snapshot-response.d.ts
+/**
+ * A response reduced to what a snapshot should pin: the status, the content
+ * type and the body — with the values that differ on every run (ids, tokens,
+ * timestamps) replaced, so the snapshot fails only when the shape or a stable
+ * value changes.
+ */
+type ResponseSnapshot = {
+  status: number;
+  contentType: string | null;
+  body: unknown;
+};
+type SnapshotResponseOptions = {
+  /**
+   * Dot paths whose values are replaced by `"[redacted]"`. `*` matches any
+   * key or array index: `"post.id"`, `"posts.*.createdAt"`, `"*.token"`.
+   */
+  redact?: string[];
+};
+declare const REDACTED = "[redacted]";
+/**
+ * Read a response into a {@link ResponseSnapshot} for `toMatchSnapshot()`.
+ * Consumes the body: call it instead of `response.json()`, not after.
+ *
+ * @example
+ * const response = await testPost("/posts", { title: "Hello" });
+ *
+ * expect(await snapshotResponse(response, { redact: ["post.id", "post.createdAt"] }))
+ *   .toMatchSnapshot();
+ */
+declare function snapshotResponse(response: Response, options?: SnapshotResponseOptions): Promise<ResponseSnapshot>;
+//#endregion
+export { REDACTED, ResponseSnapshot, SnapshotResponseOptions, snapshotResponse };
+//# sourceMappingURL=snapshot-response.d.mts.map

package/esm/tests/snapshot-response.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"snapshot-response.d.mts","names":[],"sources":["../../../../../../../../packages/core/src/tests/snapshot-response.ts"],"mappings":";;AAMA;;;;;KAAY,gBAAA;EACV,MAAA;EACA,WAAA;EACA,IAAA;AAAA;AAAA,KAGU,uBAAA;;;AAKJ;AAGR;EAHE,MAAM;AAAA;AAAA,cAGK,QAAA;AAAQ;AAkCrB;;;;;;;;;AAlCqB,iBAkCC,gBAAA,CACpB,QAAA,EAAU,QAAA,EACV,OAAA,GAAS,uBAAA,GACR,OAAA,CAAQ,gBAAA"}

package/esm/tests/snapshot-response.mjs

@@ -0,0 +1,42 @@
+//#region ../../packages/core/src/tests/snapshot-response.ts
+const REDACTED = "[redacted]";
+function redactPath(value, segments) {
+	if (segments.length === 0) return REDACTED;
+	if (typeof value !== "object" || value === null) return value;
+	const [head, ...rest] = segments;
+	if (Array.isArray(value)) return value.map((item, index) => head === "*" || head === String(index) ? redactPath(item, rest) : item);
+	const record = value;
+	const copy = { ...record };
+	for (const key of Object.keys(record)) if (head === "*" || head === key) copy[key] = redactPath(record[key], rest);
+	return copy;
+}
+/**
+* Read a response into a {@link ResponseSnapshot} for `toMatchSnapshot()`.
+* Consumes the body: call it instead of `response.json()`, not after.
+*
+* @example
+* const response = await testPost("/posts", { title: "Hello" });
+*
+* expect(await snapshotResponse(response, { redact: ["post.id", "post.createdAt"] }))
+*   .toMatchSnapshot();
+*/
+async function snapshotResponse(response, options = {}) {
+	const contentType = response.headers.get("content-type");
+	const text = await response.text();
+	let body = text;
+	if (contentType?.includes("json") && text !== "") try {
+		body = JSON.parse(text);
+	} catch {
+		body = text;
+	}
+	for (const path of options.redact ?? []) body = redactPath(body, path.split("."));
+	return {
+		status: response.status,
+		contentType,
+		body
+	};
+}
+
+//#endregion
+export { REDACTED, snapshotResponse };
+//# sourceMappingURL=snapshot-response.mjs.map

package/esm/tests/snapshot-response.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"snapshot-response.mjs","names":[],"sources":["../../../../../../../../packages/core/src/tests/snapshot-response.ts"],"sourcesContent":["/**\n * A response reduced to what a snapshot should pin: the status, the content\n * type and the body — with the values that differ on every run (ids, tokens,\n * timestamps) replaced, so the snapshot fails only when the shape or a stable\n * value changes.\n */\nexport type ResponseSnapshot = {\n  status: number;\n  contentType: string | null;\n  body: unknown;\n};\n\nexport type SnapshotResponseOptions = {\n  /**\n   * Dot paths whose values are replaced by `\"[redacted]\"`. `*` matches any\n   * key or array index: `\"post.id\"`, `\"posts.*.createdAt\"`, `\"*.token\"`.\n   */\n  redact?: string[];\n};\n\nexport const REDACTED = \"[redacted]\";\n\nfunction redactPath(value: unknown, segments: readonly string[]): unknown {\n  if (segments.length === 0) return REDACTED;\n  if (typeof value !== \"object\" || value === null) return value;\n\n  const [head, ...rest] = segments;\n\n  if (Array.isArray(value)) {\n    return value.map((item, index) =>\n      head === \"*\" || head === String(index) ? redactPath(item, rest) : item,\n    );\n  }\n\n  const record = value as Record<string, unknown>;\n  const copy: Record<string, unknown> = { ...record };\n\n  for (const key of Object.keys(record)) {\n    if (head === \"*\" || head === key) copy[key] = redactPath(record[key], rest);\n  }\n\n  return copy;\n}\n\n/**\n * Read a response into a {@link ResponseSnapshot} for `toMatchSnapshot()`.\n * Consumes the body: call it instead of `response.json()`, not after.\n *\n * @example\n * const response = await testPost(\"/posts\", { title: \"Hello\" });\n *\n * expect(await snapshotResponse(response, { redact: [\"post.id\", \"post.createdAt\"] }))\n *   .toMatchSnapshot();\n */\nexport async function snapshotResponse(\n  response: Response,\n  options: SnapshotResponseOptions = {},\n): Promise<ResponseSnapshot> {\n  const contentType = response.headers.get(\"content-type\");\n  const text = await response.text();\n  let body: unknown = text;\n\n  if (contentType?.includes(\"json\") && text !== \"\") {\n    try {\n      body = JSON.parse(text) as unknown;\n    } catch {\n      body = text;\n    }\n  }\n\n  for (const path of options.redact ?? []) {\n    body = redactPath(body, path.split(\".\"));\n  }\n\n  return { status: response.status, contentType, body };\n}\n"],"mappings":";AAoBA,MAAa,WAAW;AAExB,SAAS,WAAW,OAAgB,UAAsC;CACxE,IAAI,SAAS,WAAW,GAAG,OAAO;CAClC,IAAI,OAAO,UAAU,YAAY,UAAU,MAAM,OAAO;CAExD,MAAM,CAAC,MAAM,GAAG,QAAQ;CAExB,IAAI,MAAM,QAAQ,KAAK,GACrB,OAAO,MAAM,KAAK,MAAM,UACtB,SAAS,OAAO,SAAS,OAAO,KAAK,IAAI,WAAW,MAAM,IAAI,IAAI,IACpE;CAGF,MAAM,SAAS;CACf,MAAM,OAAgC,EAAE,GAAG,OAAO;CAElD,KAAK,MAAM,OAAO,OAAO,KAAK,MAAM,GAClC,IAAI,SAAS,OAAO,SAAS,KAAK,KAAK,OAAO,WAAW,OAAO,MAAM,IAAI;CAG5E,OAAO;AACT;;;;;;;;;;;AAYA,eAAsB,iBACpB,UACA,UAAmC,CAAC,GACT;CAC3B,MAAM,cAAc,SAAS,QAAQ,IAAI,cAAc;CACvD,MAAM,OAAO,MAAM,SAAS,KAAK;CACjC,IAAI,OAAgB;CAEpB,IAAI,aAAa,SAAS,MAAM,KAAK,SAAS,IAC5C,IAAI;EACF,OAAO,KAAK,MAAM,IAAI;CACxB,QAAQ;EACN,OAAO;CACT;CAGF,KAAK,MAAM,QAAQ,QAAQ,UAAU,CAAC,GACpC,OAAO,WAAW,MAAM,KAAK,MAAM,GAAG,CAAC;CAGzC,OAAO;EAAE,QAAQ,SAAS;EAAQ;EAAa;CAAK;AACtD"}