@xtandard/webhooks 0.1.0

package/dist/file-COBYZA4Q.cjs

@@ -0,0 +1,148 @@
+const require_keys = require("./keys-FiKpaVHX.cjs");
+let node_fs = require("node:fs");
+let node_fs_promises = require("node:fs/promises");
+let node_path = require("node:path");
+//#region src/storage/file.ts
+/**
+* File-system storage adapter. Persists each key as a JSON file under a base
+* directory, mirroring the slash-delimited key layout (`whk/{app}/…`) as a
+* tree of nested directories with a `.json` extension on the leaf. Zero
+* external dependencies — uses `node:fs/promises`, which works in both Bun and
+* Node.
+*
+* @module
+*/
+var file_exports = /* @__PURE__ */ require_keys.__exportAll({
+	clearFileStorage: () => clearFileStorage,
+	createFileStorage: () => createFileStorage
+});
+/** Suffix appended to the leaf file for every stored key. */
+const JSON_SUFFIX = ".json";
+/**
+* Map a storage key (e.g. `whk/acme/endpoints/ep_1`) to an absolute file path
+* inside `dir`. Each key segment becomes a directory; the last segment gains a
+* `.json` extension.
+*/
+function keyToPath(dir, key) {
+	return (0, node_path.join)(dir, ...key.split("/")) + JSON_SUFFIX;
+}
+/**
+* Reverse {@link keyToPath}: turn an absolute (or `dir`-relative) file path back
+* into the original slash-delimited storage key. Returns `null` for paths that
+* are not `.json` leaves under `dir`.
+*/
+function pathToKey(dir, filePath) {
+	const rel = (0, node_path.relative)(dir, filePath);
+	if (rel.startsWith("..") || !rel.endsWith(JSON_SUFFIX)) return null;
+	return rel.slice(0, -5).split(node_path.sep).join("/");
+}
+/** Recursively collect every `.json` leaf file path under `root`. */
+async function walk(root) {
+	const out = [];
+	let entries;
+	try {
+		entries = await (0, node_fs_promises.readdir)(root, { withFileTypes: true });
+	} catch (err) {
+		if (err.code === "ENOENT") return out;
+		throw err;
+	}
+	for (const entry of entries) {
+		const name = entry.name.toString();
+		const full = (0, node_path.join)(root, name);
+		if (entry.isDirectory()) out.push(...await walk(full));
+		else if (entry.isFile() && name.endsWith(JSON_SUFFIX)) out.push(full);
+	}
+	return out;
+}
+/**
+* Create a file-backed {@link WatchableWebhooksStorage}. Values are serialized
+* as pretty-printed JSON. `watch` is implemented via `fs.watch` on the base
+* directory (recursive); it is best-effort and may coalesce or miss events on
+* platforms without recursive-watch support.
+*
+* @example
+* ```ts
+* import { createFileStorage } from "@xtandard/webhooks/storage/file";
+*
+* const storage = createFileStorage({ dir: "./data/webhooks" });
+* ```
+*/
+function createFileStorage(options) {
+	const { dir } = options;
+	return {
+		async getItem(key) {
+			try {
+				const raw = await (0, node_fs_promises.readFile)(keyToPath(dir, key), "utf8");
+				return JSON.parse(raw);
+			} catch (err) {
+				if (err.code === "ENOENT") return null;
+				throw err;
+			}
+		},
+		async setItem(key, value) {
+			const path = keyToPath(dir, key);
+			await (0, node_fs_promises.mkdir)((0, node_path.dirname)(path), { recursive: true });
+			await (0, node_fs_promises.writeFile)(path, JSON.stringify(value, null, 2), "utf8");
+		},
+		async removeItem(key) {
+			try {
+				await (0, node_fs_promises.unlink)(keyToPath(dir, key));
+			} catch (err) {
+				if (err.code !== "ENOENT") throw err;
+			}
+		},
+		async getKeys(prefix) {
+			const files = await walk(dir);
+			const out = [];
+			for (const file of files) {
+				const key = pathToKey(dir, file);
+				if (key !== null && key.startsWith(prefix)) out.push(key);
+			}
+			return out;
+		},
+		async watch(prefix, callback) {
+			await (0, node_fs_promises.mkdir)(dir, { recursive: true });
+			const watcher = (0, node_fs.watch)(dir, { recursive: true }, (eventType, filename) => {
+				if (!filename) return;
+				const key = pathToKey(dir, (0, node_path.join)(dir, filename.toString()));
+				if (key === null || !key.startsWith(prefix)) return;
+				callback({
+					type: eventType === "rename" ? "remove" : "update",
+					key
+				});
+			});
+			return () => watcher.close();
+		}
+	};
+}
+/**
+* Delete every file written by a {@link createFileStorage} instance by removing
+* its base directory. Exposed primarily for tests and cleanup tooling.
+*/
+async function clearFileStorage(options) {
+	await (0, node_fs_promises.rm)(options.dir, {
+		recursive: true,
+		force: true
+	});
+}
+//#endregion
+Object.defineProperty(exports, "clearFileStorage", {
+	enumerable: true,
+	get: function() {
+		return clearFileStorage;
+	}
+});
+Object.defineProperty(exports, "createFileStorage", {
+	enumerable: true,
+	get: function() {
+		return createFileStorage;
+	}
+});
+Object.defineProperty(exports, "file_exports", {
+	enumerable: true,
+	get: function() {
+		return file_exports;
+	}
+});
+
+//# sourceMappingURL=file-COBYZA4Q.cjs.map

package/dist/file-COBYZA4Q.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-COBYZA4Q.cjs","names":["sep"],"sources":["../src/storage/file.ts"],"sourcesContent":["/**\n * File-system storage adapter. Persists each key as a JSON file under a base\n * directory, mirroring the slash-delimited key layout (`whk/{app}/…`) as a\n * tree of nested directories with a `.json` extension on the leaf. Zero\n * external dependencies — uses `node:fs/promises`, which works in both Bun and\n * Node.\n *\n * @module\n */\n\nimport { watch as fsWatch } from \"node:fs\";\nimport type { Dirent } from \"node:fs\";\nimport { mkdir, readdir, readFile, rm, unlink, writeFile } from \"node:fs/promises\";\nimport { dirname, join, relative, sep } from \"node:path\";\nimport type { StorageChangeEvent, WatchableWebhooksStorage } from \"./contract.ts\";\n\n/** Options for {@link createFileStorage}. */\nexport interface FileStorageOptions {\n  /** Base directory under which key files are written. Created on demand. */\n  dir: string;\n}\n\n/** Suffix appended to the leaf file for every stored key. */\nconst JSON_SUFFIX = \".json\";\n\n/**\n * Map a storage key (e.g. `whk/acme/endpoints/ep_1`) to an absolute file path\n * inside `dir`. Each key segment becomes a directory; the last segment gains a\n * `.json` extension.\n */\nfunction keyToPath(dir: string, key: string): string {\n  return join(dir, ...key.split(\"/\")) + JSON_SUFFIX;\n}\n\n/**\n * Reverse {@link keyToPath}: turn an absolute (or `dir`-relative) file path back\n * into the original slash-delimited storage key. Returns `null` for paths that\n * are not `.json` leaves under `dir`.\n */\nfunction pathToKey(dir: string, filePath: string): string | null {\n  const rel = relative(dir, filePath);\n  if (rel.startsWith(\"..\") || !rel.endsWith(JSON_SUFFIX)) return null;\n  return rel.slice(0, -JSON_SUFFIX.length).split(sep).join(\"/\");\n}\n\n/** Recursively collect every `.json` leaf file path under `root`. */\nasync function walk(root: string): Promise<string[]> {\n  const out: string[] = [];\n  let entries: Dirent[];\n  try {\n    entries = (await readdir(root, { withFileTypes: true })) as Dirent[];\n  } catch (err) {\n    if ((err as NodeJS.ErrnoException).code === \"ENOENT\") return out;\n    throw err;\n  }\n  for (const entry of entries) {\n    const name = entry.name.toString();\n    const full = join(root, name);\n    if (entry.isDirectory()) {\n      out.push(...(await walk(full)));\n    } else if (entry.isFile() && name.endsWith(JSON_SUFFIX)) {\n      out.push(full);\n    }\n  }\n  return out;\n}\n\n/**\n * Create a file-backed {@link WatchableWebhooksStorage}. Values are serialized\n * as pretty-printed JSON. `watch` is implemented via `fs.watch` on the base\n * directory (recursive); it is best-effort and may coalesce or miss events on\n * platforms without recursive-watch support.\n *\n * @example\n * ```ts\n * import { createFileStorage } from \"@xtandard/webhooks/storage/file\";\n *\n * const storage = createFileStorage({ dir: \"./data/webhooks\" });\n * ```\n */\nexport function createFileStorage(options: FileStorageOptions): WatchableWebhooksStorage {\n  const { dir } = options;\n\n  return {\n    async getItem<T>(key: string): Promise<T | null> {\n      try {\n        const raw = await readFile(keyToPath(dir, key), \"utf8\");\n        return JSON.parse(raw) as T;\n      } catch (err) {\n        if ((err as NodeJS.ErrnoException).code === \"ENOENT\") return null;\n        throw err;\n      }\n    },\n\n    async setItem<T>(key: string, value: T): Promise<void> {\n      const path = keyToPath(dir, key);\n      await mkdir(dirname(path), { recursive: true });\n      await writeFile(path, JSON.stringify(value, null, 2), \"utf8\");\n    },\n\n    async removeItem(key: string): Promise<void> {\n      try {\n        await unlink(keyToPath(dir, key));\n      } catch (err) {\n        if ((err as NodeJS.ErrnoException).code !== \"ENOENT\") throw err;\n      }\n    },\n\n    async getKeys(prefix: string): Promise<string[]> {\n      const files = await walk(dir);\n      const out: string[] = [];\n      for (const file of files) {\n        const key = pathToKey(dir, file);\n        if (key !== null && key.startsWith(prefix)) out.push(key);\n      }\n      return out;\n    },\n\n    async watch(\n      prefix: string,\n      callback: (event: StorageChangeEvent) => void,\n    ): Promise<() => void> {\n      // Ensure the watched root exists so fs.watch does not throw on a fresh dir.\n      await mkdir(dir, { recursive: true });\n      const watcher = fsWatch(dir, { recursive: true }, (eventType, filename) => {\n        if (!filename) return;\n        const key = pathToKey(dir, join(dir, filename.toString()));\n        if (key === null || !key.startsWith(prefix)) return;\n        // `rename` covers both creation and deletion; we cannot reliably tell\n        // them apart from the event alone, so report \"update\" for changes and\n        // \"remove\" only when the underlying file is gone.\n        const type: StorageChangeEvent[\"type\"] = eventType === \"rename\" ? \"remove\" : \"update\";\n        callback({ type, key });\n      });\n      return () => watcher.close();\n    },\n  } satisfies WatchableWebhooksStorage;\n}\n\n/**\n * Delete every file written by a {@link createFileStorage} instance by removing\n * its base directory. Exposed primarily for tests and cleanup tooling.\n */\nexport async function clearFileStorage(options: FileStorageOptions): Promise<void> {\n  await rm(options.dir, { recursive: true, force: true });\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAuBA,MAAM,cAAc;;;;;;AAOpB,SAAS,UAAU,KAAa,KAAqB;CACnD,QAAA,GAAA,UAAA,MAAY,KAAK,GAAG,IAAI,MAAM,GAAG,CAAC,IAAI;AACxC;;;;;;AAOA,SAAS,UAAU,KAAa,UAAiC;CAC/D,MAAM,OAAA,GAAA,UAAA,UAAe,KAAK,QAAQ;CAClC,IAAI,IAAI,WAAW,IAAI,KAAK,CAAC,IAAI,SAAS,WAAW,GAAG,OAAO;CAC/D,OAAO,IAAI,MAAM,GAAG,EAAmB,EAAE,MAAMA,UAAAA,GAAG,EAAE,KAAK,GAAG;AAC9D;;AAGA,eAAe,KAAK,MAAiC;CACnD,MAAM,MAAgB,CAAC;CACvB,IAAI;CACJ,IAAI;EACF,UAAW,OAAA,GAAA,iBAAA,SAAc,MAAM,EAAE,eAAe,KAAK,CAAC;CACxD,SAAS,KAAK;EACZ,IAAK,IAA8B,SAAS,UAAU,OAAO;EAC7D,MAAM;CACR;CACA,KAAK,MAAM,SAAS,SAAS;EAC3B,MAAM,OAAO,MAAM,KAAK,SAAS;EACjC,MAAM,QAAA,GAAA,UAAA,MAAY,MAAM,IAAI;EAC5B,IAAI,MAAM,YAAY,GACpB,IAAI,KAAK,GAAI,MAAM,KAAK,IAAI,CAAE;OACzB,IAAI,MAAM,OAAO,KAAK,KAAK,SAAS,WAAW,GACpD,IAAI,KAAK,IAAI;CAEjB;CACA,OAAO;AACT;;;;;;;;;;;;;;AAeA,SAAgB,kBAAkB,SAAuD;CACvF,MAAM,EAAE,QAAQ;CAEhB,OAAO;EACL,MAAM,QAAW,KAAgC;GAC/C,IAAI;IACF,MAAM,MAAM,OAAA,GAAA,iBAAA,UAAe,UAAU,KAAK,GAAG,GAAG,MAAM;IACtD,OAAO,KAAK,MAAM,GAAG;GACvB,SAAS,KAAK;IACZ,IAAK,IAA8B,SAAS,UAAU,OAAO;IAC7D,MAAM;GACR;EACF;EAEA,MAAM,QAAW,KAAa,OAAyB;GACrD,MAAM,OAAO,UAAU,KAAK,GAAG;GAC/B,OAAA,GAAA,iBAAA,QAAA,GAAA,UAAA,SAAoB,IAAI,GAAG,EAAE,WAAW,KAAK,CAAC;GAC9C,OAAA,GAAA,iBAAA,WAAgB,MAAM,KAAK,UAAU,OAAO,MAAM,CAAC,GAAG,MAAM;EAC9D;EAEA,MAAM,WAAW,KAA4B;GAC3C,IAAI;IACF,OAAA,GAAA,iBAAA,QAAa,UAAU,KAAK,GAAG,CAAC;GAClC,SAAS,KAAK;IACZ,IAAK,IAA8B,SAAS,UAAU,MAAM;GAC9D;EACF;EAEA,MAAM,QAAQ,QAAmC;GAC/C,MAAM,QAAQ,MAAM,KAAK,GAAG;GAC5B,MAAM,MAAgB,CAAC;GACvB,KAAK,MAAM,QAAQ,OAAO;IACxB,MAAM,MAAM,UAAU,KAAK,IAAI;IAC/B,IAAI,QAAQ,QAAQ,IAAI,WAAW,MAAM,GAAG,IAAI,KAAK,GAAG;GAC1D;GACA,OAAO;EACT;EAEA,MAAM,MACJ,QACA,UACqB;GAErB,OAAA,GAAA,iBAAA,OAAY,KAAK,EAAE,WAAW,KAAK,CAAC;GACpC,MAAM,WAAA,GAAA,QAAA,OAAkB,KAAK,EAAE,WAAW,KAAK,IAAI,WAAW,aAAa;IACzE,IAAI,CAAC,UAAU;IACf,MAAM,MAAM,UAAU,MAAA,GAAA,UAAA,MAAU,KAAK,SAAS,SAAS,CAAC,CAAC;IACzD,IAAI,QAAQ,QAAQ,CAAC,IAAI,WAAW,MAAM,GAAG;IAK7C,SAAS;KAAE,MAD8B,cAAc,WAAW,WAAW;KAC5D;IAAI,CAAC;GACxB,CAAC;GACD,aAAa,QAAQ,MAAM;EAC7B;CACF;AACF;;;;;AAMA,eAAsB,iBAAiB,SAA4C;CACjF,OAAA,GAAA,iBAAA,IAAS,QAAQ,KAAK;EAAE,WAAW;EAAM,OAAO;CAAK,CAAC;AACxD"}

package/dist/file-fi02eFHk.mjs

@@ -0,0 +1,131 @@
+import { t as __exportAll } from "./chunk-D7D4PA-g.mjs";
+import { watch } from "node:fs";
+import { mkdir, readFile, readdir, rm, unlink, writeFile } from "node:fs/promises";
+import { dirname, join, relative, sep } from "node:path";
+//#region src/storage/file.ts
+/**
+* File-system storage adapter. Persists each key as a JSON file under a base
+* directory, mirroring the slash-delimited key layout (`whk/{app}/…`) as a
+* tree of nested directories with a `.json` extension on the leaf. Zero
+* external dependencies — uses `node:fs/promises`, which works in both Bun and
+* Node.
+*
+* @module
+*/
+var file_exports = /* @__PURE__ */ __exportAll({
+	clearFileStorage: () => clearFileStorage,
+	createFileStorage: () => createFileStorage
+});
+/** Suffix appended to the leaf file for every stored key. */
+const JSON_SUFFIX = ".json";
+/**
+* Map a storage key (e.g. `whk/acme/endpoints/ep_1`) to an absolute file path
+* inside `dir`. Each key segment becomes a directory; the last segment gains a
+* `.json` extension.
+*/
+function keyToPath(dir, key) {
+	return join(dir, ...key.split("/")) + JSON_SUFFIX;
+}
+/**
+* Reverse {@link keyToPath}: turn an absolute (or `dir`-relative) file path back
+* into the original slash-delimited storage key. Returns `null` for paths that
+* are not `.json` leaves under `dir`.
+*/
+function pathToKey(dir, filePath) {
+	const rel = relative(dir, filePath);
+	if (rel.startsWith("..") || !rel.endsWith(JSON_SUFFIX)) return null;
+	return rel.slice(0, -5).split(sep).join("/");
+}
+/** Recursively collect every `.json` leaf file path under `root`. */
+async function walk(root) {
+	const out = [];
+	let entries;
+	try {
+		entries = await readdir(root, { withFileTypes: true });
+	} catch (err) {
+		if (err.code === "ENOENT") return out;
+		throw err;
+	}
+	for (const entry of entries) {
+		const name = entry.name.toString();
+		const full = join(root, name);
+		if (entry.isDirectory()) out.push(...await walk(full));
+		else if (entry.isFile() && name.endsWith(JSON_SUFFIX)) out.push(full);
+	}
+	return out;
+}
+/**
+* Create a file-backed {@link WatchableWebhooksStorage}. Values are serialized
+* as pretty-printed JSON. `watch` is implemented via `fs.watch` on the base
+* directory (recursive); it is best-effort and may coalesce or miss events on
+* platforms without recursive-watch support.
+*
+* @example
+* ```ts
+* import { createFileStorage } from "@xtandard/webhooks/storage/file";
+*
+* const storage = createFileStorage({ dir: "./data/webhooks" });
+* ```
+*/
+function createFileStorage(options) {
+	const { dir } = options;
+	return {
+		async getItem(key) {
+			try {
+				const raw = await readFile(keyToPath(dir, key), "utf8");
+				return JSON.parse(raw);
+			} catch (err) {
+				if (err.code === "ENOENT") return null;
+				throw err;
+			}
+		},
+		async setItem(key, value) {
+			const path = keyToPath(dir, key);
+			await mkdir(dirname(path), { recursive: true });
+			await writeFile(path, JSON.stringify(value, null, 2), "utf8");
+		},
+		async removeItem(key) {
+			try {
+				await unlink(keyToPath(dir, key));
+			} catch (err) {
+				if (err.code !== "ENOENT") throw err;
+			}
+		},
+		async getKeys(prefix) {
+			const files = await walk(dir);
+			const out = [];
+			for (const file of files) {
+				const key = pathToKey(dir, file);
+				if (key !== null && key.startsWith(prefix)) out.push(key);
+			}
+			return out;
+		},
+		async watch(prefix, callback) {
+			await mkdir(dir, { recursive: true });
+			const watcher = watch(dir, { recursive: true }, (eventType, filename) => {
+				if (!filename) return;
+				const key = pathToKey(dir, join(dir, filename.toString()));
+				if (key === null || !key.startsWith(prefix)) return;
+				callback({
+					type: eventType === "rename" ? "remove" : "update",
+					key
+				});
+			});
+			return () => watcher.close();
+		}
+	};
+}
+/**
+* Delete every file written by a {@link createFileStorage} instance by removing
+* its base directory. Exposed primarily for tests and cleanup tooling.
+*/
+async function clearFileStorage(options) {
+	await rm(options.dir, {
+		recursive: true,
+		force: true
+	});
+}
+//#endregion
+export { createFileStorage as n, file_exports as r, clearFileStorage as t };
+
+//# sourceMappingURL=file-fi02eFHk.mjs.map

package/dist/file-fi02eFHk.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-fi02eFHk.mjs","names":["fsWatch"],"sources":["../src/storage/file.ts"],"sourcesContent":["/**\n * File-system storage adapter. Persists each key as a JSON file under a base\n * directory, mirroring the slash-delimited key layout (`whk/{app}/…`) as a\n * tree of nested directories with a `.json` extension on the leaf. Zero\n * external dependencies — uses `node:fs/promises`, which works in both Bun and\n * Node.\n *\n * @module\n */\n\nimport { watch as fsWatch } from \"node:fs\";\nimport type { Dirent } from \"node:fs\";\nimport { mkdir, readdir, readFile, rm, unlink, writeFile } from \"node:fs/promises\";\nimport { dirname, join, relative, sep } from \"node:path\";\nimport type { StorageChangeEvent, WatchableWebhooksStorage } from \"./contract.ts\";\n\n/** Options for {@link createFileStorage}. */\nexport interface FileStorageOptions {\n  /** Base directory under which key files are written. Created on demand. */\n  dir: string;\n}\n\n/** Suffix appended to the leaf file for every stored key. */\nconst JSON_SUFFIX = \".json\";\n\n/**\n * Map a storage key (e.g. `whk/acme/endpoints/ep_1`) to an absolute file path\n * inside `dir`. Each key segment becomes a directory; the last segment gains a\n * `.json` extension.\n */\nfunction keyToPath(dir: string, key: string): string {\n  return join(dir, ...key.split(\"/\")) + JSON_SUFFIX;\n}\n\n/**\n * Reverse {@link keyToPath}: turn an absolute (or `dir`-relative) file path back\n * into the original slash-delimited storage key. Returns `null` for paths that\n * are not `.json` leaves under `dir`.\n */\nfunction pathToKey(dir: string, filePath: string): string | null {\n  const rel = relative(dir, filePath);\n  if (rel.startsWith(\"..\") || !rel.endsWith(JSON_SUFFIX)) return null;\n  return rel.slice(0, -JSON_SUFFIX.length).split(sep).join(\"/\");\n}\n\n/** Recursively collect every `.json` leaf file path under `root`. */\nasync function walk(root: string): Promise<string[]> {\n  const out: string[] = [];\n  let entries: Dirent[];\n  try {\n    entries = (await readdir(root, { withFileTypes: true })) as Dirent[];\n  } catch (err) {\n    if ((err as NodeJS.ErrnoException).code === \"ENOENT\") return out;\n    throw err;\n  }\n  for (const entry of entries) {\n    const name = entry.name.toString();\n    const full = join(root, name);\n    if (entry.isDirectory()) {\n      out.push(...(await walk(full)));\n    } else if (entry.isFile() && name.endsWith(JSON_SUFFIX)) {\n      out.push(full);\n    }\n  }\n  return out;\n}\n\n/**\n * Create a file-backed {@link WatchableWebhooksStorage}. Values are serialized\n * as pretty-printed JSON. `watch` is implemented via `fs.watch` on the base\n * directory (recursive); it is best-effort and may coalesce or miss events on\n * platforms without recursive-watch support.\n *\n * @example\n * ```ts\n * import { createFileStorage } from \"@xtandard/webhooks/storage/file\";\n *\n * const storage = createFileStorage({ dir: \"./data/webhooks\" });\n * ```\n */\nexport function createFileStorage(options: FileStorageOptions): WatchableWebhooksStorage {\n  const { dir } = options;\n\n  return {\n    async getItem<T>(key: string): Promise<T | null> {\n      try {\n        const raw = await readFile(keyToPath(dir, key), \"utf8\");\n        return JSON.parse(raw) as T;\n      } catch (err) {\n        if ((err as NodeJS.ErrnoException).code === \"ENOENT\") return null;\n        throw err;\n      }\n    },\n\n    async setItem<T>(key: string, value: T): Promise<void> {\n      const path = keyToPath(dir, key);\n      await mkdir(dirname(path), { recursive: true });\n      await writeFile(path, JSON.stringify(value, null, 2), \"utf8\");\n    },\n\n    async removeItem(key: string): Promise<void> {\n      try {\n        await unlink(keyToPath(dir, key));\n      } catch (err) {\n        if ((err as NodeJS.ErrnoException).code !== \"ENOENT\") throw err;\n      }\n    },\n\n    async getKeys(prefix: string): Promise<string[]> {\n      const files = await walk(dir);\n      const out: string[] = [];\n      for (const file of files) {\n        const key = pathToKey(dir, file);\n        if (key !== null && key.startsWith(prefix)) out.push(key);\n      }\n      return out;\n    },\n\n    async watch(\n      prefix: string,\n      callback: (event: StorageChangeEvent) => void,\n    ): Promise<() => void> {\n      // Ensure the watched root exists so fs.watch does not throw on a fresh dir.\n      await mkdir(dir, { recursive: true });\n      const watcher = fsWatch(dir, { recursive: true }, (eventType, filename) => {\n        if (!filename) return;\n        const key = pathToKey(dir, join(dir, filename.toString()));\n        if (key === null || !key.startsWith(prefix)) return;\n        // `rename` covers both creation and deletion; we cannot reliably tell\n        // them apart from the event alone, so report \"update\" for changes and\n        // \"remove\" only when the underlying file is gone.\n        const type: StorageChangeEvent[\"type\"] = eventType === \"rename\" ? \"remove\" : \"update\";\n        callback({ type, key });\n      });\n      return () => watcher.close();\n    },\n  } satisfies WatchableWebhooksStorage;\n}\n\n/**\n * Delete every file written by a {@link createFileStorage} instance by removing\n * its base directory. Exposed primarily for tests and cleanup tooling.\n */\nexport async function clearFileStorage(options: FileStorageOptions): Promise<void> {\n  await rm(options.dir, { recursive: true, force: true });\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAuBA,MAAM,cAAc;;;;;;AAOpB,SAAS,UAAU,KAAa,KAAqB;CACnD,OAAO,KAAK,KAAK,GAAG,IAAI,MAAM,GAAG,CAAC,IAAI;AACxC;;;;;;AAOA,SAAS,UAAU,KAAa,UAAiC;CAC/D,MAAM,MAAM,SAAS,KAAK,QAAQ;CAClC,IAAI,IAAI,WAAW,IAAI,KAAK,CAAC,IAAI,SAAS,WAAW,GAAG,OAAO;CAC/D,OAAO,IAAI,MAAM,GAAG,EAAmB,EAAE,MAAM,GAAG,EAAE,KAAK,GAAG;AAC9D;;AAGA,eAAe,KAAK,MAAiC;CACnD,MAAM,MAAgB,CAAC;CACvB,IAAI;CACJ,IAAI;EACF,UAAW,MAAM,QAAQ,MAAM,EAAE,eAAe,KAAK,CAAC;CACxD,SAAS,KAAK;EACZ,IAAK,IAA8B,SAAS,UAAU,OAAO;EAC7D,MAAM;CACR;CACA,KAAK,MAAM,SAAS,SAAS;EAC3B,MAAM,OAAO,MAAM,KAAK,SAAS;EACjC,MAAM,OAAO,KAAK,MAAM,IAAI;EAC5B,IAAI,MAAM,YAAY,GACpB,IAAI,KAAK,GAAI,MAAM,KAAK,IAAI,CAAE;OACzB,IAAI,MAAM,OAAO,KAAK,KAAK,SAAS,WAAW,GACpD,IAAI,KAAK,IAAI;CAEjB;CACA,OAAO;AACT;;;;;;;;;;;;;;AAeA,SAAgB,kBAAkB,SAAuD;CACvF,MAAM,EAAE,QAAQ;CAEhB,OAAO;EACL,MAAM,QAAW,KAAgC;GAC/C,IAAI;IACF,MAAM,MAAM,MAAM,SAAS,UAAU,KAAK,GAAG,GAAG,MAAM;IACtD,OAAO,KAAK,MAAM,GAAG;GACvB,SAAS,KAAK;IACZ,IAAK,IAA8B,SAAS,UAAU,OAAO;IAC7D,MAAM;GACR;EACF;EAEA,MAAM,QAAW,KAAa,OAAyB;GACrD,MAAM,OAAO,UAAU,KAAK,GAAG;GAC/B,MAAM,MAAM,QAAQ,IAAI,GAAG,EAAE,WAAW,KAAK,CAAC;GAC9C,MAAM,UAAU,MAAM,KAAK,UAAU,OAAO,MAAM,CAAC,GAAG,MAAM;EAC9D;EAEA,MAAM,WAAW,KAA4B;GAC3C,IAAI;IACF,MAAM,OAAO,UAAU,KAAK,GAAG,CAAC;GAClC,SAAS,KAAK;IACZ,IAAK,IAA8B,SAAS,UAAU,MAAM;GAC9D;EACF;EAEA,MAAM,QAAQ,QAAmC;GAC/C,MAAM,QAAQ,MAAM,KAAK,GAAG;GAC5B,MAAM,MAAgB,CAAC;GACvB,KAAK,MAAM,QAAQ,OAAO;IACxB,MAAM,MAAM,UAAU,KAAK,IAAI;IAC/B,IAAI,QAAQ,QAAQ,IAAI,WAAW,MAAM,GAAG,IAAI,KAAK,GAAG;GAC1D;GACA,OAAO;EACT;EAEA,MAAM,MACJ,QACA,UACqB;GAErB,MAAM,MAAM,KAAK,EAAE,WAAW,KAAK,CAAC;GACpC,MAAM,UAAUA,MAAQ,KAAK,EAAE,WAAW,KAAK,IAAI,WAAW,aAAa;IACzE,IAAI,CAAC,UAAU;IACf,MAAM,MAAM,UAAU,KAAK,KAAK,KAAK,SAAS,SAAS,CAAC,CAAC;IACzD,IAAI,QAAQ,QAAQ,CAAC,IAAI,WAAW,MAAM,GAAG;IAK7C,SAAS;KAAE,MAD8B,cAAc,WAAW,WAAW;KAC5D;IAAI,CAAC;GACxB,CAAC;GACD,aAAa,QAAQ,MAAM;EAC7B;CACF;AACF;;;;;AAMA,eAAsB,iBAAiB,SAA4C;CACjF,MAAM,GAAG,QAAQ,KAAK;EAAE,WAAW;EAAM,OAAO;CAAK,CAAC;AACxD"}

package/dist/index.cjs

@@ -0,0 +1,123 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_keys = require("./keys-FiKpaVHX.cjs");
+const require_schema = require("./schema.cjs");
+const require_signing = require("./signing.cjs");
+const require_core = require("./core-ZGhH6Vs2.cjs");
+const require_contract = require("./contract-Bf1qguwt.cjs");
+const require_dispatcher = require("./dispatcher-B0xTEHt1.cjs");
+const require_contract$1 = require("./contract-B2d5dNU3.cjs");
+const require_create_fetch_handler = require("./create-fetch-handler-CmooujQo.cjs");
+//#region src/storage/watch.ts
+/**
+* Wrap a storage so it implements {@link WatchableWebhooksStorage} using
+* `subscribe` as the change source. The wrapper delegates all reads/writes to
+* `storage` and only adds `watch`; keys not under the watched `prefix` are
+* filtered out. A notification without a key is delivered as a change to the
+* prefix itself (enough to trigger a refresh).
+*/
+function withWatch(storage, subscribe) {
+	const watchable = Object.create(storage);
+	watchable.watch = (prefix, callback) => {
+		const notify = (key) => {
+			if (key !== void 0 && key !== "" && !key.startsWith(prefix)) return;
+			callback({
+				type: "update",
+				key: key && key !== "" ? key : prefix
+			});
+		};
+		return Promise.resolve(subscribe(notify));
+	};
+	return watchable;
+}
+/**
+* A {@link WatchSubscribe} backed by Postgres `LISTEN`/`NOTIFY`. Pair with
+* {@link withWatch} for the postgres or drizzle-over-pg adapters. Your migration
+* owns the trigger that `pg_notify`s `channel` with the changed key as payload;
+* this only `LISTEN`s.
+*
+* @example
+* ```ts
+* import { Client } from "pg";
+* const listener = new Client({ connectionString: process.env.DATABASE_URL });
+* await listener.connect();
+* const storage = withWatch(base, pgListenNotify(listener, "xtandard_webhooks"));
+* ```
+*/
+function pgListenNotify(client, channel = "xtandard_webhooks") {
+	return async (notify) => {
+		const listener = (msg) => {
+			if (msg.channel === channel) notify(msg.payload);
+		};
+		client.on("notification", listener);
+		await client.query(`LISTEN "${channel.replace(/"/g, "\"\"")}"`);
+		return async () => {
+			client.removeListener("notification", listener);
+			await client.query(`UNLISTEN "${channel.replace(/"/g, "\"\"")}"`);
+		};
+	};
+}
+//#endregion
+exports.ConflictError = require_core.ConflictError;
+exports.DEFAULT_ATTEMPT_TIMEOUT_MS = require_core.DEFAULT_ATTEMPT_TIMEOUT_MS;
+exports.DEFAULT_PORTAL_ACTIONS = require_create_fetch_handler.DEFAULT_PORTAL_ACTIONS;
+exports.DEFAULT_RESPONSE_BODY_LIMIT = require_core.DEFAULT_RESPONSE_BODY_LIMIT;
+exports.DEFAULT_RETRY_SCHEDULE = require_dispatcher.DEFAULT_RETRY_SCHEDULE;
+exports.HookDeniedError = require_core.HookDeniedError;
+exports.IdempotencyConflictError = require_core.IdempotencyConflictError;
+exports.KEY_REGEX = require_core.KEY_REGEX;
+exports.MUTATING_ACTIONS = require_contract$1.MUTATING_ACTIONS;
+exports.NotFoundError = require_core.NotFoundError;
+exports.PORTAL_TOKEN_PREFIX = require_create_fetch_handler.PORTAL_TOKEN_PREFIX;
+exports.PayloadTooLargeError = require_core.PayloadTooLargeError;
+exports.PortalTokenError = require_create_fetch_handler.PortalTokenError;
+exports.RESERVED_HEADERS = require_core.RESERVED_HEADERS;
+exports.ReadonlyError = require_core.ReadonlyError;
+exports.SCHEMA_VERSION = require_schema.SCHEMA_VERSION;
+exports.SECRET_PREFIX = require_signing.SECRET_PREFIX;
+exports.VERSION = require_core.VERSION;
+exports.ValidationError = require_core.ValidationError;
+exports.WebhookVerificationError = require_signing.WebhookVerificationError;
+exports.activeSecrets = require_core.activeSecrets;
+exports.assertValid = require_core.assertValid;
+exports.attemptDelivery = require_core.attemptDelivery;
+exports.buildOpenApiDocument = require_create_fetch_handler.buildOpenApiDocument;
+exports.buildSignedRequest = require_core.buildSignedRequest;
+exports.createDispatcher = require_dispatcher.createDispatcher;
+exports.createFetchHandler = require_create_fetch_handler.createFetchHandler;
+exports.createPortalToken = require_create_fetch_handler.createPortalToken;
+exports.createWebhooksCore = require_core.createWebhooksCore;
+exports.defaultHookErrorReporter = require_core.defaultHookErrorReporter;
+exports.durationToMs = require_core.durationToMs;
+exports.emitDelivery = require_core.emitDelivery;
+exports.generateSecret = require_signing.generateSecret;
+exports.hasDeliveryQueue = require_contract.hasDeliveryQueue;
+exports.idPattern = require_core.idPattern;
+exports.isCompareAndSwap = require_contract.isCompareAndSwap;
+exports.isMutatingAction = require_contract$1.isMutatingAction;
+exports.isTerminalDeliveryStatus = require_schema.isTerminalDeliveryStatus;
+exports.isTransactional = require_contract.isTransactional;
+exports.isWatchable = require_contract.isWatchable;
+Object.defineProperty(exports, "keys", {
+	enumerable: true,
+	get: function() {
+		return require_keys.keys_exports;
+	}
+});
+exports.newId = require_core.newId;
+exports.normalizeHooks = require_core.normalizeHooks;
+exports.parseDurationList = require_core.parseDurationList;
+exports.pgListenNotify = pgListenNotify;
+exports.requirePeer = require_contract.requirePeer;
+exports.runAfter = require_core.runAfter;
+exports.runBefore = require_core.runBefore;
+exports.sign = require_signing.sign;
+exports.signatureHeader = require_signing.signatureHeader;
+exports.validateApplication = require_core.validateApplication;
+exports.validateEndpoint = require_core.validateEndpoint;
+exports.validateEndpointUrl = require_core.validateEndpointUrl;
+exports.validateEventType = require_core.validateEventType;
+exports.verify = require_signing.verify;
+exports.verifyPortalToken = require_create_fetch_handler.verifyPortalToken;
+exports.withWatch = withWatch;
+
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","names":[],"sources":["../src/storage/watch.ts"],"sourcesContent":["/**\n * Composable change-notifications. `watch` is **orthogonal** to which storage\n * you use, so rather than bake it into each adapter, {@link withWatch} wraps\n * *any* {@link WebhooksStorage} with a {@link WatchSubscribe} source you provide\n * — Postgres `LISTEN`/`NOTIFY`, Redis pub/sub, an ORM after-write hook, a\n * websocket, an `EventEmitter`, etc.\n *\n * This gives `watch` to adapters that don't implement it themselves (postgres,\n * drizzle, mongodb, unstorage, cloudflare-kv, …), driven by whatever change\n * signal your infrastructure already has.\n *\n * @example\n * ```ts\n * import { withWatch } from \"@xtandard/webhooks\";\n * import { createDrizzleStorage } from \"@xtandard/webhooks/storage/drizzle\";\n *\n * const storage = withWatch(createDrizzleStorage({ db, table }), (notify) => {\n *   const sub = redis.subscribe(\"webhook-changes\", (m) => notify(m.key));\n *   return () => sub.unsubscribe();\n * });\n * ```\n *\n * @module\n */\n\nimport type { StorageChangeEvent, WatchableWebhooksStorage, WebhooksStorage } from \"./contract.ts\";\n\n/**\n * A change source. Called with a `notify` callback — wire your source to invoke\n * it (optionally with the changed key) on every change — and return an\n * unsubscribe function (sync or async).\n */\nexport type WatchSubscribe = (\n  notify: (key?: string) => void,\n) => (() => void | Promise<void>) | Promise<() => void | Promise<void>>;\n\n/**\n * Wrap a storage so it implements {@link WatchableWebhooksStorage} using\n * `subscribe` as the change source. The wrapper delegates all reads/writes to\n * `storage` and only adds `watch`; keys not under the watched `prefix` are\n * filtered out. A notification without a key is delivered as a change to the\n * prefix itself (enough to trigger a refresh).\n */\nexport function withWatch<S extends WebhooksStorage>(\n  storage: S,\n  subscribe: WatchSubscribe,\n): S & WatchableWebhooksStorage {\n  const watchable = Object.create(storage) as S & WatchableWebhooksStorage;\n  watchable.watch = (prefix, callback) => {\n    const notify = (key?: string): void => {\n      if (key !== undefined && key !== \"\" && !key.startsWith(prefix)) return;\n      callback({\n        type: \"update\",\n        key: key && key !== \"\" ? key : prefix,\n      } satisfies StorageChangeEvent);\n    };\n    return Promise.resolve(subscribe(notify));\n  };\n  return watchable;\n}\n\n/**\n * A dedicated notification client for {@link pgListenNotify} — satisfied by a\n * `pg` `Client`. `Pool` won't do (it rotates connections); use a `Client` you\n * `connect()`.\n */\nexport interface PgNotificationClient {\n  query(sql: string): Promise<unknown>;\n  on(event: \"notification\", listener: (msg: { channel: string; payload?: string }) => void): void;\n  removeListener(\n    event: \"notification\",\n    listener: (msg: { channel: string; payload?: string }) => void,\n  ): void;\n}\n\n/**\n * A {@link WatchSubscribe} backed by Postgres `LISTEN`/`NOTIFY`. Pair with\n * {@link withWatch} for the postgres or drizzle-over-pg adapters. Your migration\n * owns the trigger that `pg_notify`s `channel` with the changed key as payload;\n * this only `LISTEN`s.\n *\n * @example\n * ```ts\n * import { Client } from \"pg\";\n * const listener = new Client({ connectionString: process.env.DATABASE_URL });\n * await listener.connect();\n * const storage = withWatch(base, pgListenNotify(listener, \"xtandard_webhooks\"));\n * ```\n */\nexport function pgListenNotify(\n  client: PgNotificationClient,\n  channel = \"xtandard_webhooks\",\n): WatchSubscribe {\n  return async (notify) => {\n    const listener = (msg: { channel: string; payload?: string }): void => {\n      if (msg.channel === channel) notify(msg.payload);\n    };\n    client.on(\"notification\", listener);\n    await client.query(`LISTEN \"${channel.replace(/\"/g, '\"\"')}\"`);\n    return async () => {\n      client.removeListener(\"notification\", listener);\n      await client.query(`UNLISTEN \"${channel.replace(/\"/g, '\"\"')}\"`);\n    };\n  };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;AA2CA,SAAgB,UACd,SACA,WAC8B;CAC9B,MAAM,YAAY,OAAO,OAAO,OAAO;CACvC,UAAU,SAAS,QAAQ,aAAa;EACtC,MAAM,UAAU,QAAuB;GACrC,IAAI,QAAQ,KAAA,KAAa,QAAQ,MAAM,CAAC,IAAI,WAAW,MAAM,GAAG;GAChE,SAAS;IACP,MAAM;IACN,KAAK,OAAO,QAAQ,KAAK,MAAM;GACjC,CAA8B;EAChC;EACA,OAAO,QAAQ,QAAQ,UAAU,MAAM,CAAC;CAC1C;CACA,OAAO;AACT;;;;;;;;;;;;;;;AA8BA,SAAgB,eACd,QACA,UAAU,qBACM;CAChB,OAAO,OAAO,WAAW;EACvB,MAAM,YAAY,QAAqD;GACrE,IAAI,IAAI,YAAY,SAAS,OAAO,IAAI,OAAO;EACjD;EACA,OAAO,GAAG,gBAAgB,QAAQ;EAClC,MAAM,OAAO,MAAM,WAAW,QAAQ,QAAQ,MAAM,MAAI,EAAE,EAAE;EAC5D,OAAO,YAAY;GACjB,OAAO,eAAe,gBAAgB,QAAQ;GAC9C,MAAM,OAAO,MAAM,aAAa,QAAQ,QAAQ,MAAM,MAAI,EAAE,EAAE;EAChE;CACF;AACF"}