emdash 1.1.0 → 1.2.0

package/dist/entry-lock-B4n0HdQ_.mjs

@@ -0,0 +1,163 @@
+import { t as EntryLockRepository } from "./entry-locks-DJAqVweV.mjs";
+import { t as ErrorCode } from "./errors-hskQ0C8G.mjs";
+import { ulid } from "ulidx";
+
+//#region src/api/handlers/entry-lock.ts
+/**
+* How long an entry stays locked without a heartbeat or save. Long enough to
+* survive a pause in typing, short enough that a closed tab frees the entry
+* within a coffee break.
+*/
+const ENTRY_LOCK_LEASE_MS = 420 * 1e3;
+const ENTRY_LOCK_LEASE_SECONDS = ENTRY_LOCK_LEASE_MS / 1e3;
+function toHolder(lock) {
+	return {
+		userId: lock.userId,
+		userName: lock.userName,
+		acquiredAt: lock.acquiredAt,
+		expiresAt: lock.expiresAt
+	};
+}
+function holderLabel(holder) {
+	return holder.userName?.trim() ? holder.userName : "Another editor";
+}
+async function isLockingEnabled(db, collection) {
+	const row = await db.selectFrom("_emdash_collections").select("edit_locking").where("slug", "=", collection).executeTakeFirst();
+	if (!row) return null;
+	return row.edit_locking !== 0;
+}
+function collectionNotFound(collection) {
+	return {
+		success: false,
+		error: {
+			code: ErrorCode.COLLECTION_NOT_FOUND,
+			message: `Collection '${collection}' not found`
+		}
+	};
+}
+/**
+* Takes the entry's lock for `userId`, or reports who is holding it. A
+* take-over is only granted when the caller asks for one.
+*/
+async function handleEntryLockAcquire(db, collection, entryId, userId, options = {}) {
+	try {
+		const enabled = await isLockingEnabled(db, collection);
+		if (enabled === null) return collectionNotFound(collection);
+		if (!enabled) return {
+			success: true,
+			data: {
+				enabled: false,
+				holder: null,
+				heldByCaller: false
+			}
+		};
+		const claim = await new EntryLockRepository(db).acquire({
+			collection,
+			entryId,
+			userId,
+			token: options.token ?? ulid(),
+			leaseSeconds: ENTRY_LOCK_LEASE_SECONDS,
+			takeover: options.takeover
+		});
+		return {
+			success: true,
+			data: {
+				enabled: true,
+				holder: toHolder(claim.lock),
+				heldByCaller: claim.outcome === "acquired"
+			}
+		};
+	} catch (error) {
+		console.error("[entry-lock] acquire failed:", error);
+		return {
+			success: false,
+			error: {
+				code: ErrorCode.ENTRY_LOCK_ERROR,
+				message: "Failed to acquire the entry lock"
+			}
+		};
+	}
+}
+async function handleEntryLockRead(db, collection, entryId, userId) {
+	try {
+		const enabled = await isLockingEnabled(db, collection);
+		if (enabled === null) return collectionNotFound(collection);
+		if (!enabled) return {
+			success: true,
+			data: {
+				enabled: false,
+				holder: null,
+				heldByCaller: false
+			}
+		};
+		const lock = await new EntryLockRepository(db).findLive(collection, entryId);
+		return {
+			success: true,
+			data: {
+				enabled: true,
+				holder: lock ? toHolder(lock) : null,
+				heldByCaller: lock?.userId === userId
+			}
+		};
+	} catch (error) {
+		console.error("[entry-lock] read failed:", error);
+		return {
+			success: false,
+			error: {
+				code: ErrorCode.ENTRY_LOCK_ERROR,
+				message: "Failed to read the entry lock"
+			}
+		};
+	}
+}
+async function handleEntryLockRelease(db, collection, entryId, userId, options = {}) {
+	try {
+		return {
+			success: true,
+			data: { released: await new EntryLockRepository(db).release({
+				collection,
+				entryId,
+				userId,
+				token: options.token
+			}) }
+		};
+	} catch (error) {
+		console.error("[entry-lock] release failed:", error);
+		return {
+			success: false,
+			error: {
+				code: ErrorCode.ENTRY_LOCK_ERROR,
+				message: "Failed to release the entry lock"
+			}
+		};
+	}
+}
+/**
+* Decides whether a write may proceed, and keeps the caller's own lease alive
+* while it does. Resolves to `null` when the write is allowed.
+*
+* A write never takes a lock it was not given, so a CLI or API caller writing
+* an unlocked entry leaves it unlocked.
+*/
+async function claimEntryLockForWrite(db, collection, entryId, userId, options = {}) {
+	if (options.override === true) return null;
+	const repo = new EntryLockRepository(db);
+	if (await repo.refreshHeld({
+		collection,
+		entryId,
+		userId,
+		leaseSeconds: ENTRY_LOCK_LEASE_SECONDS
+	})) return null;
+	const holder = await repo.findEnforceable(collection, entryId);
+	if (!holder) return null;
+	const details = toHolder(holder);
+	return {
+		code: ErrorCode.ENTRY_LOCKED,
+		message: `${holderLabel(details)} is holding this entry`,
+		details
+	};
+}
+
+//#endregion
+export { handleEntryLockRelease as i, handleEntryLockAcquire as n, handleEntryLockRead as r, claimEntryLockForWrite as t };
+//# sourceMappingURL=entry-lock-B4n0HdQ_.mjs.map

package/dist/entry-lock-B4n0HdQ_.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"entry-lock-B4n0HdQ_.mjs","names":[],"sources":["../src/api/handlers/entry-lock.ts"],"sourcesContent":["import type { Kysely } from \"kysely\";\nimport { ulid } from \"ulidx\";\n\nimport { EntryLockRepository, type EntryLock } from \"../../database/repositories/entry-locks.js\";\nimport type { Database } from \"../../database/types.js\";\nimport { ErrorCode } from \"../errors.js\";\nimport type { ApiResult } from \"../types.js\";\n\n/**\n * How long an entry stays locked without a heartbeat or save. Long enough to\n * survive a pause in typing, short enough that a closed tab frees the entry\n * within a coffee break.\n */\nexport const ENTRY_LOCK_LEASE_MS = 7 * 60 * 1000;\n\nconst ENTRY_LOCK_LEASE_SECONDS = ENTRY_LOCK_LEASE_MS / 1000;\n\nexport interface EntryLockHolder {\n\tuserId: string;\n\tuserName: string | null;\n\tacquiredAt: string;\n\texpiresAt: string;\n}\n\nexport interface EntryLockStatus {\n\t/** Whether the collection takes edit locks at all. */\n\tenabled: boolean;\n\t/** The live lease, whoever holds it. */\n\tholder: EntryLockHolder | null;\n\t/** Whether `holder` is the caller. */\n\theldByCaller: boolean;\n}\n\nexport interface EntryLockRefusal {\n\tcode: typeof ErrorCode.ENTRY_LOCKED;\n\tmessage: string;\n\tdetails: EntryLockHolder;\n}\n\nfunction toHolder(lock: EntryLock): EntryLockHolder {\n\treturn {\n\t\tuserId: lock.userId,\n\t\tuserName: lock.userName,\n\t\tacquiredAt: lock.acquiredAt,\n\t\texpiresAt: lock.expiresAt,\n\t};\n}\n\nfunction holderLabel(holder: EntryLockHolder): string {\n\treturn holder.userName?.trim() ? holder.userName : \"Another editor\";\n}\n\nasync function isLockingEnabled(db: Kysely<Database>, collection: string): Promise<boolean | null> {\n\tconst row = await db\n\t\t.selectFrom(\"_emdash_collections\")\n\t\t.select(\"edit_locking\")\n\t\t.where(\"slug\", \"=\", collection)\n\t\t.executeTakeFirst();\n\tif (!row) return null;\n\treturn row.edit_locking !== 0;\n}\n\nfunction collectionNotFound(collection: string): ApiResult<never> {\n\treturn {\n\t\tsuccess: false,\n\t\terror: {\n\t\t\tcode: ErrorCode.COLLECTION_NOT_FOUND,\n\t\t\tmessage: `Collection '${collection}' not found`,\n\t\t},\n\t};\n}\n\n/**\n * Takes the entry's lock for `userId`, or reports who is holding it. A\n * take-over is only granted when the caller asks for one.\n */\nexport async function handleEntryLockAcquire(\n\tdb: Kysely<Database>,\n\tcollection: string,\n\tentryId: string,\n\tuserId: string,\n\toptions: { takeover?: boolean; token?: string } = {},\n): Promise<ApiResult<EntryLockStatus>> {\n\ttry {\n\t\tconst enabled = await isLockingEnabled(db, collection);\n\t\tif (enabled === null) return collectionNotFound(collection);\n\t\tif (!enabled) {\n\t\t\treturn { success: true, data: { enabled: false, holder: null, heldByCaller: false } };\n\t\t}\n\n\t\tconst claim = await new EntryLockRepository(db).acquire({\n\t\t\tcollection,\n\t\t\tentryId,\n\t\t\tuserId,\n\t\t\ttoken: options.token ?? ulid(),\n\t\t\tleaseSeconds: ENTRY_LOCK_LEASE_SECONDS,\n\t\t\ttakeover: options.takeover,\n\t\t});\n\n\t\treturn {\n\t\t\tsuccess: true,\n\t\t\tdata: {\n\t\t\t\tenabled: true,\n\t\t\t\tholder: toHolder(claim.lock),\n\t\t\t\theldByCaller: claim.outcome === \"acquired\",\n\t\t\t},\n\t\t};\n\t} catch (error) {\n\t\tconsole.error(\"[entry-lock] acquire failed:\", error);\n\t\treturn {\n\t\t\tsuccess: false,\n\t\t\terror: { code: ErrorCode.ENTRY_LOCK_ERROR, message: \"Failed to acquire the entry lock\" },\n\t\t};\n\t}\n}\n\nexport async function handleEntryLockRead(\n\tdb: Kysely<Database>,\n\tcollection: string,\n\tentryId: string,\n\tuserId: string,\n): Promise<ApiResult<EntryLockStatus>> {\n\ttry {\n\t\tconst enabled = await isLockingEnabled(db, collection);\n\t\tif (enabled === null) return collectionNotFound(collection);\n\t\tif (!enabled) {\n\t\t\treturn { success: true, data: { enabled: false, holder: null, heldByCaller: false } };\n\t\t}\n\n\t\tconst lock = await new EntryLockRepository(db).findLive(collection, entryId);\n\t\treturn {\n\t\t\tsuccess: true,\n\t\t\tdata: {\n\t\t\t\tenabled: true,\n\t\t\t\tholder: lock ? toHolder(lock) : null,\n\t\t\t\theldByCaller: lock?.userId === userId,\n\t\t\t},\n\t\t};\n\t} catch (error) {\n\t\tconsole.error(\"[entry-lock] read failed:\", error);\n\t\treturn {\n\t\t\tsuccess: false,\n\t\t\terror: { code: ErrorCode.ENTRY_LOCK_ERROR, message: \"Failed to read the entry lock\" },\n\t\t};\n\t}\n}\n\nexport async function handleEntryLockRelease(\n\tdb: Kysely<Database>,\n\tcollection: string,\n\tentryId: string,\n\tuserId: string,\n\toptions: { token?: string } = {},\n): Promise<ApiResult<{ released: boolean }>> {\n\ttry {\n\t\tconst released = await new EntryLockRepository(db).release({\n\t\t\tcollection,\n\t\t\tentryId,\n\t\t\tuserId,\n\t\t\ttoken: options.token,\n\t\t});\n\t\treturn { success: true, data: { released } };\n\t} catch (error) {\n\t\tconsole.error(\"[entry-lock] release failed:\", error);\n\t\treturn {\n\t\t\tsuccess: false,\n\t\t\terror: { code: ErrorCode.ENTRY_LOCK_ERROR, message: \"Failed to release the entry lock\" },\n\t\t};\n\t}\n}\n\n/**\n * Decides whether a write may proceed, and keeps the caller's own lease alive\n * while it does. Resolves to `null` when the write is allowed.\n *\n * A write never takes a lock it was not given, so a CLI or API caller writing\n * an unlocked entry leaves it unlocked.\n */\nexport async function claimEntryLockForWrite(\n\tdb: Kysely<Database>,\n\tcollection: string,\n\tentryId: string,\n\tuserId: string,\n\toptions: { override?: boolean } = {},\n): Promise<EntryLockRefusal | null> {\n\tif (options.override === true) return null;\n\n\tconst repo = new EntryLockRepository(db);\n\tconst heldByCaller = await repo.refreshHeld({\n\t\tcollection,\n\t\tentryId,\n\t\tuserId,\n\t\tleaseSeconds: ENTRY_LOCK_LEASE_SECONDS,\n\t});\n\tif (heldByCaller) return null;\n\n\tconst holder = await repo.findEnforceable(collection, entryId);\n\tif (!holder) return null;\n\n\tconst details = toHolder(holder);\n\treturn {\n\t\tcode: ErrorCode.ENTRY_LOCKED,\n\t\tmessage: `${holderLabel(details)} is holding this entry`,\n\t\tdetails,\n\t};\n}\n"],"mappings":";;;;;;;;;;AAaA,MAAa,sBAAsB,MAAS;AAE5C,MAAM,2BAA2B,sBAAsB;AAwBvD,SAAS,SAAS,MAAkC;AACnD,QAAO;EACN,QAAQ,KAAK;EACb,UAAU,KAAK;EACf,YAAY,KAAK;EACjB,WAAW,KAAK;EAChB;;AAGF,SAAS,YAAY,QAAiC;AACrD,QAAO,OAAO,UAAU,MAAM,GAAG,OAAO,WAAW;;AAGpD,eAAe,iBAAiB,IAAsB,YAA6C;CAClG,MAAM,MAAM,MAAM,GAChB,WAAW,sBAAsB,CACjC,OAAO,eAAe,CACtB,MAAM,QAAQ,KAAK,WAAW,CAC9B,kBAAkB;AACpB,KAAI,CAAC,IAAK,QAAO;AACjB,QAAO,IAAI,iBAAiB;;AAG7B,SAAS,mBAAmB,YAAsC;AACjE,QAAO;EACN,SAAS;EACT,OAAO;GACN,MAAM,UAAU;GAChB,SAAS,eAAe,WAAW;GACnC;EACD;;;;;;AAOF,eAAsB,uBACrB,IACA,YACA,SACA,QACA,UAAkD,EAAE,EACd;AACtC,KAAI;EACH,MAAM,UAAU,MAAM,iBAAiB,IAAI,WAAW;AACtD,MAAI,YAAY,KAAM,QAAO,mBAAmB,WAAW;AAC3D,MAAI,CAAC,QACJ,QAAO;GAAE,SAAS;GAAM,MAAM;IAAE,SAAS;IAAO,QAAQ;IAAM,cAAc;IAAO;GAAE;EAGtF,MAAM,QAAQ,MAAM,IAAI,oBAAoB,GAAG,CAAC,QAAQ;GACvD;GACA;GACA;GACA,OAAO,QAAQ,SAAS,MAAM;GAC9B,cAAc;GACd,UAAU,QAAQ;GAClB,CAAC;AAEF,SAAO;GACN,SAAS;GACT,MAAM;IACL,SAAS;IACT,QAAQ,SAAS,MAAM,KAAK;IAC5B,cAAc,MAAM,YAAY;IAChC;GACD;UACO,OAAO;AACf,UAAQ,MAAM,gCAAgC,MAAM;AACpD,SAAO;GACN,SAAS;GACT,OAAO;IAAE,MAAM,UAAU;IAAkB,SAAS;IAAoC;GACxF;;;AAIH,eAAsB,oBACrB,IACA,YACA,SACA,QACsC;AACtC,KAAI;EACH,MAAM,UAAU,MAAM,iBAAiB,IAAI,WAAW;AACtD,MAAI,YAAY,KAAM,QAAO,mBAAmB,WAAW;AAC3D,MAAI,CAAC,QACJ,QAAO;GAAE,SAAS;GAAM,MAAM;IAAE,SAAS;IAAO,QAAQ;IAAM,cAAc;IAAO;GAAE;EAGtF,MAAM,OAAO,MAAM,IAAI,oBAAoB,GAAG,CAAC,SAAS,YAAY,QAAQ;AAC5E,SAAO;GACN,SAAS;GACT,MAAM;IACL,SAAS;IACT,QAAQ,OAAO,SAAS,KAAK,GAAG;IAChC,cAAc,MAAM,WAAW;IAC/B;GACD;UACO,OAAO;AACf,UAAQ,MAAM,6BAA6B,MAAM;AACjD,SAAO;GACN,SAAS;GACT,OAAO;IAAE,MAAM,UAAU;IAAkB,SAAS;IAAiC;GACrF;;;AAIH,eAAsB,uBACrB,IACA,YACA,SACA,QACA,UAA8B,EAAE,EACY;AAC5C,KAAI;AAOH,SAAO;GAAE,SAAS;GAAM,MAAM,EAAE,UANf,MAAM,IAAI,oBAAoB,GAAG,CAAC,QAAQ;IAC1D;IACA;IACA;IACA,OAAO,QAAQ;IACf,CAAC,EACwC;GAAE;UACpC,OAAO;AACf,UAAQ,MAAM,gCAAgC,MAAM;AACpD,SAAO;GACN,SAAS;GACT,OAAO;IAAE,MAAM,UAAU;IAAkB,SAAS;IAAoC;GACxF;;;;;;;;;;AAWH,eAAsB,uBACrB,IACA,YACA,SACA,QACA,UAAkC,EAAE,EACD;AACnC,KAAI,QAAQ,aAAa,KAAM,QAAO;CAEtC,MAAM,OAAO,IAAI,oBAAoB,GAAG;AAOxC,KANqB,MAAM,KAAK,YAAY;EAC3C;EACA;EACA;EACA,cAAc;EACd,CAAC,CACgB,QAAO;CAEzB,MAAM,SAAS,MAAM,KAAK,gBAAgB,YAAY,QAAQ;AAC9D,KAAI,CAAC,OAAQ,QAAO;CAEpB,MAAM,UAAU,SAAS,OAAO;AAChC,QAAO;EACN,MAAM,UAAU;EAChB,SAAS,GAAG,YAAY,QAAQ,CAAC;EACjC;EACA"}