@osdlc/file-lock 0.0.0-stage → 0.0.1-stage

package/CHANGELOG.md

@@ -0,0 +1 @@
+# @osdlc/file-lock

package/CONTRIBUTING.md

@@ -0,0 +1,57 @@
+# Contributing
+
+Thanks for your interest in `@osdlc/file-lock`.
+
+## Issues
+
+Report bugs and ask for features in the
+[issue tracker](https://github.com/osdlc/osdlc/issues). For a bug, include the
+library version, your runtime (Node or Bun) and version, your operating
+system and file system, and a minimal example. Report security problems
+privately. See [SECURITY.md](./SECURITY.md).
+
+## Pull requests
+
+This package lives in [osdlc/osdlc](https://github.com/osdlc/osdlc) under
+`packages/ts/file-lock`. Open pull requests there. They are reviewed and
+merged there.
+
+## Running the tests
+
+The repository is a pnpm workspace. Install from the repository root, then
+work in the package directory. The tests run on Vitest under Node 22 or
+later, against the TypeScript source. The smoke check below runs the built
+package, so build before it.
+
+```sh
+pnpm install
+cd packages/ts/file-lock
+pnpm run build
+pnpm test
+```
+
+`pnpm run smoke` runs `tests/smoke.mjs`, a short check of the built package
+under Node. It is not published. `pnpm run coverage` reports test coverage.
+
+Other checks:
+
+```sh
+pnpm run typecheck
+pnpm run lint
+pnpm run format:check
+```
+
+## Code style
+
+- TypeScript, ES modules, and explicit `.ts` import paths.
+- Prettier formats the code and oxlint checks it. Run `pnpm run format` and
+  `pnpm run lint` before you commit.
+- Add a test for each behaviour change or bug fix.
+- A new export gets TSDoc and a use in `examples/`, which imports the package
+  by name. A test fails if an export has no example.
+- An experimental export carries `@experimental` and is listed in the
+  README's Stability section. A test checks that the two agree.
+- For a change users can see, add a changeset: run `pnpm changeset` at the
+  repository root. Start a breaking change's summary with `**Breaking:**`.
+  Do not edit `CHANGELOG.md` or `version` by hand. The release writes them.
+  See [packages/README.md](https://github.com/osdlc/osdlc/blob/main/packages/README.md).

package/LICENSE-APACHE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Sizer LLC
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 SK Sizer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,275 @@
-# Temporary Holding Version
+# @osdlc/file-lock
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Cross-process exclusive file locks for Node.js. No dependencies beyond Node's
+own `fs` and `crypto`.
+
+There are two shapes, built on one mechanism:
+
+- **A held lock**, `claimLock`, for something a process owns for as long as
+  it runs: a port lease, one loop per repository, one digest per session. The
+  lock names its holder, and you choose when a holder counts as gone: its
+  process exited, or it stopped touching the lock.
+- **A short critical section**, `withLock`, for a re-read, check and rewrite
+  of one file that two processes may do at once.
+
+## Why
+
+Two processes that read a file, change it and write it back can lose each
+other's change. A lock file next to the data stops that, but the simple
+versions break in ways that only show up under load or after a crash:
+
+- An `O_EXCL` create followed by a write can leave an empty lock if the
+  process dies between the two. Nobody can tell whose it is.
+- "Delete the lock if it looks stale" lets a slow waiter delete the fresh lock
+  that a faster waiter just took, so two holders run at once.
+- "Delete the lock on exit" lets an owner whose lock was taken over delete the
+  new holder's lock.
+
+This package closes each of those. A claim writes the whole content to a temp
+file and hard-links it into place, so the lock never exists empty. A stale lock
+is taken over through a marker that only one reaper can create, and it is
+removed only if it still reads exactly as it did when it was judged stale.
+Every claim carries a random token, and release, touch and rewrite act only
+while the lock still holds that token.
+
+When not to use it:
+
+- The lock must hold across machines, or the directory is on a network file
+  system. `link()` and `rename()` are relied on to be atomic. For workers on
+  several machines that share a git remote, use
+  [`@osdlc/ref-lease`](../ref-lease/README.md).
+- You need a shared (reader) lock, or a lock the kernel drops when the process
+  dies. Those are OS advisory locks (`flock`, `fcntl`), which Node has no
+  built-in binding for.
+- The section is async and long. `withLock` blocks the thread while it waits.
+  Use `claimLock` and `releaseLock` around async work instead.
+
+## Guide
+
+The [guide](https://github.com/osdlc/osdlc/blob/main/packages/ts/file-lock/docs/guide/getting-started.md) walks through the problem with
+timelines and examples: [getting started](https://github.com/osdlc/osdlc/blob/main/packages/ts/file-lock/docs/guide/getting-started.md),
+[choosing a staleness rule](https://github.com/osdlc/osdlc/blob/main/packages/ts/file-lock/docs/guide/staleness.md) and
+[how it works](https://github.com/osdlc/osdlc/blob/main/packages/ts/file-lock/docs/guide/how-it-works.md) on disk.
+
+## Install
+
+```sh
+npm install @osdlc/file-lock
+```
+
+`pnpm add @osdlc/file-lock` and `yarn add @osdlc/file-lock` work too.
+
+ESM only. Node.js 22 or later. Bun also works.
+
+## Quick start
+
+```ts
+import { mkdtempSync, readFileSync, writeFileSync } from 'node:fs'
+import { tmpdir } from 'node:os'
+import { join } from 'node:path'
+
+import { claimLock, holderGone, releaseLock, withLock } from '@osdlc/file-lock'
+
+const dir = mkdtempSync(join(tmpdir(), 'file-lock-'))
+
+// A short section: no other process runs it on this file at the same time.
+const counter = join(dir, 'counter')
+writeFileSync(counter, '0')
+withLock(`${counter}.lock`, () => {
+  writeFileSync(counter, String(Number(readFileSync(counter, 'utf8')) + 1))
+})
+
+// A held lock: ours until this process exits, or until we release it.
+const lease = join(dir, '4000.lease')
+const claim = claimLock(
+  lease,
+  { pid: process.pid },
+  { isStale: holderGone<{ pid?: number }>((c) => [c.pid]) },
+)
+if (claim.ok) {
+  // ... use the port ...
+  releaseLock(lease, claim.token)
+} else {
+  console.log('held by', claim.holder?.content?.pid)
+}
+```
+
+## The held lock
+
+`claimLock(path, content, { isStale })` writes `content` as
+JSON, with a fresh `token` field added, and returns `{ ok: true, token }` when
+it took the lock. When the lock is held, it reads it and asks `isStale`:
+
+- `false`: the holder is live. The result is `{ ok: false, holder }`, where
+  `holder` is a `HeldLock`: the parsed `content` (null when the file is not
+  a JSON object), the `mtimeMs`, and the `raw` text.
+- `true`: the lock is taken over and the claim is tried again. When several
+  claimants take over one stale lock at once, one of them wins and the others
+  see it as the live holder.
+
+`{ ok: false, holder: null }` means the lock could not be settled: it kept
+changing under every attempt, or it is stale and another claimant's takeover
+is still in progress. Try again shortly. The directory must exist; any error other than "already held" is
+thrown.
+
+The content is read back unchecked, cast to the type you name, so a rule should
+check the type of each field it reads. A lock written by another program
+without a `token` still reaches the rule with its fields, but no token
+releases it.
+
+With the token in hand:
+
+- `touchLock(path, token)` refreshes the lock's mtime: a sign of life for an
+  `untouchedFor` rule. Run it on a timer for long work.
+- `updateLock(path, token, update)` replaces the content, keeping the token.
+  `update` gets the current content and returns the new fields. The new file
+  is renamed into place, so a reader never sees it half written. An error
+  thrown by `update` is thrown to you, and the lock is left as it was.
+- `releaseLock(path, token)` removes the lock. It renames the lock aside
+  first and checks the token there, so the file it removes is exactly the
+  file it checked.
+
+Each acts only while the lock still holds `token`, and returns whether it did
+anything. An owner whose lock was taken over, or whose lock is gone, gets
+`false` and leaves the new holder's lock alone. Any other error, such as
+`EACCES` or `ENOSPC`, is thrown rather than reported as a lost lock.
+
+The types are `LockContent`, `HeldLock`, `LockClaim`, `ClaimOptions` and
+`StaleRule`.
+
+## Staleness rules
+
+`isStale` is any function of a `HeldLock`. Two are ready-made:
+
+- `holderGone(pids, { alive? })`: stale once no pid that `pids` reads from the
+  content is alive. A lock whose content cannot be parsed is never judged
+  gone by this rule. A recycled pid keeps the lock held; compare a start time
+  in your own rule if that matters. `alive` defaults to `pidAlive(pid)`,
+  which sends signal 0 and counts `EPERM` (another user's process) as alive.
+  `HolderGoneOptions` is its options type.
+- `untouchedFor(ms, now?)`: stale once the lock was not written or touched for
+  more than `ms`. A live holder that outlasts `ms` without touching loses the
+  lock, so keep `ms` far above the longest hold.
+
+## The short section
+
+`withLock(path, fn, { staleMs?, timeoutMs?, retryMs?, isStale? })` runs
+`fn` holding the lock at `path` and releases it when `fn` returns or throws.
+The lock records this process's `pid` (`SectionHolder`), and its rule is
+`untouchedFor(staleMs)` unless you pass `isStale`.
+
+| option | default | meaning |
+|---|---|---|
+| `staleMs` | 10 s | a lock untouched for longer is a killed holder's |
+| `timeoutMs` | 30 s | give up after waiting this long; 0 tries once |
+| `retryMs` | 5 ms | pause between attempts |
+| `isStale` | `untouchedFor(staleMs)` | replaces the age rule, for example `holderGone((h) => [h.pid])` for a section that may run long |
+
+When the lock stays held, it throws `LockTimeoutError`, whose message is
+`timed out waiting for lock <path>`, with the `path` and the last `holder`
+seen. `LockOptions` is the options type.
+
+Waiting blocks the thread with `Atomics.wait`, so the section is for short,
+synchronous work. `fn` must not be async: the lock would be released when it
+returns its promise, so a `fn` that returns one is refused with a `TypeError`.
+If a section outlasts `staleMs` and another waiter takes the lock over, the
+section still returns normally; pass a `holderGone` rule as `isStale` when a
+section may run long.
+
+## Read-modify-write with `@osdlc/etag-write`
+
+[`@osdlc/etag-write`](../etag-write/README.md) is not a lock. `writeCas` checks
+the etag and then renames, so two processes writing at once can still both
+pass the check, and one of them loses its update. `atomicWrite` alone never
+checks. For a file that more than one process rewrites, take the lock first,
+then read, change and write inside it. The atomic write still matters inside
+the lock: a reader that takes no lock, or a crash mid-write, must never see a
+torn file.
+
+```ts
+import { mkdtempSync, readFileSync } from 'node:fs'
+import { tmpdir } from 'node:os'
+import { join } from 'node:path'
+
+import { atomicWrite, etagOfFile, writeCas } from '@osdlc/etag-write'
+import { withLock } from '@osdlc/file-lock'
+
+const path = join(mkdtempSync(join(tmpdir(), 'file-lock-rmw-')), 'state.json')
+atomicWrite(path, JSON.stringify({ runs: 0 }))
+
+withLock(`${path}.lock`, () => {
+  const seen = etagOfFile(path)
+  const state = JSON.parse(readFileSync(path, 'utf8')) as { runs: number }
+  // Other lock-takers wait here. writeCas still refuses the write if a
+  // writer that does not take the lock (a person in an editor) changed it.
+  writeCas(path, JSON.stringify({ runs: state.runs + 1 }), seen)
+})
+```
+
+## Behaviour to know
+
+- **Files beside the lock.** A claim writes `<path>.new-<uuid>` and removes it
+  before returning (`withLock` writes it once and keeps it while it waits). A
+  release renames the lock to `<path>.release-<uuid>` for microseconds. A
+  takeover creates `<path>.stale-<24 hex digits>` for microseconds. A process
+  killed in between can leave any of them behind. A marker whose lock is still
+  there blocks the takeover of that lock until it is `MARKER_STALE_MS` (10 s)
+  old, judged by the inode's ctime; then the next claimant removes it. A
+  marker left after its lock was removed blocks nothing and is safe to delete.
+- **The content is pretty-printed JSON** with a trailing newline, and the
+  `token` field last.
+- **`updateLock` checks the token, then renames.** A takeover that lands
+  between the two is overwritten. A rule that never judges a live holder stale,
+  such as `holderGone`, closes that window.
+- **A takeover removes only the lock it judged:** the same bytes and the same
+  mtime, so a holder that touches its lock just in time keeps it.
+- **A reaper paused mid-takeover for longer than `MARKER_STALE_MS`** (a
+  suspended laptop, a stopped process) has its marker cleared as a dead
+  reaper's. If another claimant then replaces the lock, the paused reaper can
+  remove the new lock when it resumes. A pause of 10 s inside a few
+  microseconds of work is the only way in.
+- **Keep locks in directories only their users can write.** The marker's name
+  comes from the lock's content, so anyone who can write the directory can
+  create it and hold off a takeover for 10 s at a time.
+- **`withLock` decides staleness by age.** A live holder whose section
+  outlasts `staleMs` loses the lock to the next waiter, and both then run.
+- **Hard links are required.** A file system without them (some FUSE and
+  network mounts) fails the claim with the error `link()` throws.
+
+## How it compares
+
+| | `@osdlc/file-lock` | `proper-lockfile` | OS advisory lock (`flock`) |
+|---|---|---|---|
+| Lock never exists empty or half written | yes | yes (a directory) | yes |
+| Holder recorded in the lock | yes | no | no |
+| Stale when the holder process is gone | yes (`holderGone`) | no | yes (the kernel drops it) |
+| Stale when untouched for a while | yes (`untouchedFor`) | yes | no |
+| Release refuses to delete another holder's lock | yes (token) | no | yes |
+| Shared (reader) locks | no | no | yes |
+| Works without a native addon in Node | yes | yes | no |
+| Async API | no (`claimLock` is sync and fast) | yes | depends on the binding |
+
+This comparison is from each package's documentation. Pick `proper-lockfile`
+for an async, mtime-refreshed lock with no holder check. Pick an OS lock when a
+native addon is acceptable and the kernel should release the lock on exit.
+
+## Stability
+
+The package is 0.x, so any minor release may break the API. Within that, each
+export is stable or experimental. A breaking change to a stable export is
+listed in the CHANGELOG under "Breaking". Any release may change or remove an
+experimental export.
+
+The experimental exports:
+
+- none
+
+## Runtimes and platforms
+
+Node.js 22 or later, ESM only. Bun works too, through the compiled `dist/`.
+The tests run on Linux and macOS. Windows is not tested: `pidAlive` relies on
+signal 0, and the takeover relies on hard links and ctime.
+
+## Licence
+
+`MIT OR Apache-2.0`, at your option. See [LICENSE-MIT](./LICENSE-MIT) and [LICENSE-APACHE](./LICENSE-APACHE).

package/SECURITY.md

@@ -0,0 +1,23 @@
+# Security policy
+
+## Reporting a vulnerability
+
+Please report vulnerabilities privately. Do not open a public issue.
+
+Use GitHub private vulnerability reporting on the repository: open the
+[Security tab](https://github.com/osdlc/osdlc/security) and choose
+"Report a vulnerability".
+
+Include the version, a short description, and steps to reproduce. A minimal
+code sample helps.
+
+## Supported versions
+
+Only the latest `0.x` release gets security fixes. The library is pre-1.0, so
+older `0.x` releases are not patched. Upgrade to the latest release.
+
+## What to expect
+
+This is a small project. We aim to reply within a week. We will tell you
+whether we accept the report and keep you updated until a fix is released.
+We will credit you in the release notes if you want that.

package/dist/held.d.ts

@@ -0,0 +1,119 @@
+/**
+ * The held lock: a file whose existence means "taken", whose content names the
+ * holder, and which carries a random token so only the claim that wrote it
+ * can touch, rewrite or release it.
+ *
+ *  - Claim: the whole content, token included, is written to a temp file and
+ *    hard-linked to the lock path. `link()` fails with `EEXIST` just as
+ *    `O_EXCL` does, so one of several racing claimants wins, and the lock
+ *    never exists empty or half written.
+ *  - Takeover of a stale lock: the caller's rule judges a held lock. One it
+ *    judges stale is hard-linked to a marker named from a hash of its content
+ *    (the content can be longer than a file name may be), exclusively, so one
+ *    reaper wins. The winner removes the lock only if its content is still
+ *    what was judged, removes the marker, and claims again. A loser claims
+ *    again too. A reaper killed mid-takeover leaves its marker behind. While
+ *    the stale lock is still there, the next claimant removes a marker older
+ *    than {@link MARKER_STALE_MS}. A marker left after its lock was removed
+ *    matches no later lock, so it blocks nothing; it is litter, safe to delete.
+ *  - Release, touch and rewrite act only while the lock still holds this
+ *    claim's token, so an owner whose lock was taken over never disturbs the
+ *    taker's.
+ */
+/**
+ * What a lock file holds: the fields its owner recorded, and the claim's token.
+ * The fields are read back from disk unchecked, so a rule should check the
+ * types of the ones it reads. `token` is absent in a lock that some other
+ * writer created without one.
+ */
+export type LockContent<F extends object = Record<string, unknown>> = F & {
+    token?: string;
+};
+/** A lock as found on disk. */
+export interface HeldLock<F extends object = Record<string, unknown>> {
+    /** The parsed content, or null when the file is not a JSON object. */
+    content: LockContent<F> | null;
+    /** When the lock was last written or touched. */
+    mtimeMs: number;
+    /** The file's text. A takeover removes the lock only while it still reads exactly this. */
+    raw: string;
+}
+/** Judges a held lock: true when its holder is gone and the lock may be taken over. */
+export type StaleRule<F extends object = Record<string, unknown>> = (held: HeldLock<F>) => boolean;
+/** Options for {@link claimLock}. */
+export interface ClaimOptions<F extends object = Record<string, unknown>> {
+    /** Answers true for a held lock that may be taken over. */
+    isStale: StaleRule<F>;
+}
+/**
+ * The outcome of {@link claimLock}. `ok: true` carries the token that touches,
+ * rewrites and releases the lock. `ok: false` names the live holder, or has
+ * `holder: null` when the lock could not be settled: it kept changing, or it
+ * is stale and another claimant's takeover is still in progress.
+ */
+export type LockClaim<F extends object = Record<string, unknown>> = {
+    ok: true;
+    token: string;
+} | {
+    ok: false;
+    holder: HeldLock<F> | null;
+};
+/**
+ * A takeover marker older than this, in milliseconds, belongs to a reaper that
+ * died mid-takeover: a live one holds its marker for microseconds. It is judged
+ * by the inode's ctime. The marker is a hard link of the lock, so its mtime is
+ * the lock's, but linking and unlinking both set the ctime.
+ */
+export declare const MARKER_STALE_MS = 10000;
+/** The takeover marker's name for a lock whose text is `raw`. Internal: exported for the tests. */
+export declare function markerFor(path: string, raw: string): string;
+/**
+ * Claim the lock at `path`, recording `content` in it as JSON with a fresh
+ * token added (a `token` field in `content` is replaced). A held lock that
+ * `isStale` answers true for is taken over, and one of several takers wins;
+ * one it answers false for is live, and the result names it. The directory
+ * must exist. Errors other than "already held" are thrown.
+ */
+export declare function claimLock<F extends object>(path: string, content: F, options: ClaimOptions<F>): LockClaim<F>;
+/**
+ * A claim whose temp file is written once and attempted as often as needed, so
+ * `withLock` creates no new file on each retry. Internal: not exported from
+ * the package entry.
+ */
+export interface PreparedClaim<F extends object> {
+    attempt(): LockClaim<F>;
+    /** Remove the temp file. */
+    dispose(): void;
+}
+export declare function prepareClaim<F extends object>(path: string, content: F, { isStale }: ClaimOptions<F>): PreparedClaim<F>;
+/**
+ * Refresh the lock's mtime while it still holds `token`: the holder's sign of
+ * life, for a rule such as `untouchedFor`. Returns false when the lock is gone
+ * or holds another token. Any other error (`EACCES`, `EIO`) is thrown.
+ */
+export declare function touchLock(path: string, token: string): boolean;
+/**
+ * Replace the content of the lock while it still holds `token`. `update` gets
+ * the current content and returns the new fields; the token is kept. The new
+ * content is written to a temp file and renamed over the lock, so a reader
+ * never sees it half written. Returns false when the lock is gone or holds
+ * another token, and leaves it as it was. An error thrown by `update`, or any
+ * error other than "gone" (`ENOSPC`, `EACCES`), is thrown.
+ *
+ * The token check and the rename are two steps: a takeover that lands between
+ * them is overwritten. A rule that never judges a live holder stale, such as
+ * `holderGone`, closes that window.
+ */
+export declare function updateLock<F extends object>(path: string, token: string, update: (content: LockContent<F>) => F): boolean;
+/**
+ * Remove the lock only while it holds `token`: an owner whose lock was taken
+ * over must not delete the taker's. Returns whether it removed it: false when
+ * the lock is gone or holds another token. Any other error is thrown.
+ *
+ * The lock is renamed aside, which is atomic, and its token checked there, so
+ * the file removed is exactly the file checked. The cheap check first means a
+ * lock that is plainly someone else's is never moved. If it was taken over in
+ * the instant between that check and the rename, it is linked back, unless a
+ * new claim also landed in that instant.
+ */
+export declare function releaseLock(path: string, token: string): boolean;

package/dist/held.js

@@ -0,0 +1,263 @@
+/**
+ * The held lock: a file whose existence means "taken", whose content names the
+ * holder, and which carries a random token so only the claim that wrote it
+ * can touch, rewrite or release it.
+ *
+ *  - Claim: the whole content, token included, is written to a temp file and
+ *    hard-linked to the lock path. `link()` fails with `EEXIST` just as
+ *    `O_EXCL` does, so one of several racing claimants wins, and the lock
+ *    never exists empty or half written.
+ *  - Takeover of a stale lock: the caller's rule judges a held lock. One it
+ *    judges stale is hard-linked to a marker named from a hash of its content
+ *    (the content can be longer than a file name may be), exclusively, so one
+ *    reaper wins. The winner removes the lock only if its content is still
+ *    what was judged, removes the marker, and claims again. A loser claims
+ *    again too. A reaper killed mid-takeover leaves its marker behind. While
+ *    the stale lock is still there, the next claimant removes a marker older
+ *    than {@link MARKER_STALE_MS}. A marker left after its lock was removed
+ *    matches no later lock, so it blocks nothing; it is litter, safe to delete.
+ *  - Release, touch and rewrite act only while the lock still holds this
+ *    claim's token, so an owner whose lock was taken over never disturbs the
+ *    taker's.
+ */
+import { createHash, randomUUID } from 'node:crypto';
+import { closeSync, fstatSync, linkSync, openSync, readFileSync, renameSync, rmSync, statSync, utimesSync, writeFileSync, } from 'node:fs';
+/**
+ * A takeover marker older than this, in milliseconds, belongs to a reaper that
+ * died mid-takeover: a live one holds its marker for microseconds. It is judged
+ * by the inode's ctime. The marker is a hard link of the lock, so its mtime is
+ * the lock's, but linking and unlinking both set the ctime.
+ */
+export const MARKER_STALE_MS = 10_000;
+/** Claim attempts before giving up: enough for a few reapers racing over one stale lock. */
+const CLAIM_ATTEMPTS = 6;
+function parse(raw) {
+    try {
+        const value = JSON.parse(raw);
+        if (typeof value !== 'object' || value === null || Array.isArray(value))
+            return null;
+        const token = value.token;
+        if (token !== undefined && typeof token !== 'string')
+            return null;
+        return value;
+    }
+    catch {
+        // Not JSON: the rule sees null.
+        return null;
+    }
+}
+function tokenOf(path) {
+    return parse(readFileSync(path, 'utf-8'))?.token;
+}
+/** The lock's text and its mtime, both from one open of the file, so they describe the same inode. */
+function readHeld(path) {
+    const fd = openSync(path, 'r');
+    try {
+        const mtimeMs = fstatSync(fd).mtimeMs;
+        const raw = readFileSync(fd, 'utf-8');
+        return { content: parse(raw), mtimeMs, raw };
+    }
+    finally {
+        closeSync(fd);
+    }
+}
+function serialize(content, token) {
+    return `${JSON.stringify({ ...content, token }, null, 2)}\n`;
+}
+/** The takeover marker's name for a lock whose text is `raw`. Internal: exported for the tests. */
+export function markerFor(path, raw) {
+    return `${path}.stale-${createHash('sha256').update(raw).digest('hex').slice(0, 24)}`;
+}
+/**
+ * Claim the lock at `path`, recording `content` in it as JSON with a fresh
+ * token added (a `token` field in `content` is replaced). A held lock that
+ * `isStale` answers true for is taken over, and one of several takers wins;
+ * one it answers false for is live, and the result names it. The directory
+ * must exist. Errors other than "already held" are thrown.
+ */
+export function claimLock(path, content, options) {
+    const claim = prepareClaim(path, content, options);
+    try {
+        return claim.attempt();
+    }
+    finally {
+        claim.dispose();
+    }
+}
+export function prepareClaim(path, content, { isStale }) {
+    const token = randomUUID();
+    const tmp = `${path}.new-${token}`;
+    writeFileSync(tmp, serialize(content, token));
+    return {
+        attempt: () => {
+            for (let attempt = 0; attempt < CLAIM_ATTEMPTS; attempt++) {
+                try {
+                    linkSync(tmp, path);
+                    return { ok: true, token };
+                }
+                catch (err) {
+                    if (err.code !== 'EEXIST')
+                        throw err;
+                }
+                let held;
+                try {
+                    held = readHeld(path);
+                }
+                catch {
+                    continue; // released between the link and the read: claim again
+                }
+                if (!isStale(held))
+                    return { ok: false, holder: held };
+                takeOver(path, held);
+            }
+            // Every holder seen was stale and mid-takeover, or the lock kept changing: no live holder to name.
+            return { ok: false, holder: null };
+        },
+        dispose: () => rmSync(tmp, { force: true }),
+    };
+}
+/** Remove the stale lock so one of several takers can claim a new one. A loser just claims again. */
+function takeOver(path, seen) {
+    try {
+        if (readFileSync(path, 'utf-8') !== seen.raw)
+            return; // replaced since it was judged
+    }
+    catch {
+        return;
+    }
+    const marker = markerFor(path, seen.raw);
+    try {
+        linkSync(path, marker);
+    }
+    catch (err) {
+        // Another reaper holds the marker, or one died holding it. A marker that
+        // old is cleared, and the caller's next attempt takes over.
+        if (err.code === 'EEXIST')
+            clearDeadMarker(marker);
+        return;
+    }
+    try {
+        // Still the very lock that was judged: the same bytes, and not touched since.
+        const now = readHeld(path);
+        if (readFileSync(marker, 'utf-8') === seen.raw &&
+            now.raw === seen.raw &&
+            now.mtimeMs === seen.mtimeMs) {
+            rmSync(path, { force: true });
+        }
+    }
+    catch {
+        // Gone meanwhile: the next attempt sorts it out.
+    }
+    finally {
+        rmSync(marker, { force: true });
+    }
+}
+function clearDeadMarker(marker) {
+    try {
+        if (Date.now() - statSync(marker).ctimeMs >= MARKER_STALE_MS)
+            rmSync(marker, { force: true });
+    }
+    catch {
+        // Gone meanwhile.
+    }
+}
+/** True for "the file is not there": the one error the token calls report as `false` rather than throw. */
+function isGone(err) {
+    return err.code === 'ENOENT';
+}
+/**
+ * Refresh the lock's mtime while it still holds `token`: the holder's sign of
+ * life, for a rule such as `untouchedFor`. Returns false when the lock is gone
+ * or holds another token. Any other error (`EACCES`, `EIO`) is thrown.
+ */
+export function touchLock(path, token) {
+    try {
+        if (tokenOf(path) !== token)
+            return false;
+        const now = new Date();
+        utimesSync(path, now, now);
+        return true;
+    }
+    catch (err) {
+        if (isGone(err))
+            return false; // the owner is finishing, or its lock was taken over
+        throw err;
+    }
+}
+/**
+ * Replace the content of the lock while it still holds `token`. `update` gets
+ * the current content and returns the new fields; the token is kept. The new
+ * content is written to a temp file and renamed over the lock, so a reader
+ * never sees it half written. Returns false when the lock is gone or holds
+ * another token, and leaves it as it was. An error thrown by `update`, or any
+ * error other than "gone" (`ENOSPC`, `EACCES`), is thrown.
+ *
+ * The token check and the rename are two steps: a takeover that lands between
+ * them is overwritten. A rule that never judges a live holder stale, such as
+ * `holderGone`, closes that window.
+ */
+export function updateLock(path, token, update) {
+    let content;
+    try {
+        content = parse(readFileSync(path, 'utf-8'));
+    }
+    catch (err) {
+        if (isGone(err))
+            return false; // released or taken over
+        throw err;
+    }
+    if (content === null || content.token !== token)
+        return false;
+    const next = serialize(update(content), token);
+    const tmp = `${path}.new-${randomUUID()}`;
+    try {
+        writeFileSync(tmp, next);
+        renameSync(tmp, path);
+        return true;
+    }
+    catch (err) {
+        rmSync(tmp, { force: true });
+        if (isGone(err))
+            return false; // the directory went away meanwhile
+        throw err;
+    }
+}
+/**
+ * Remove the lock only while it holds `token`: an owner whose lock was taken
+ * over must not delete the taker's. Returns whether it removed it: false when
+ * the lock is gone or holds another token. Any other error is thrown.
+ *
+ * The lock is renamed aside, which is atomic, and its token checked there, so
+ * the file removed is exactly the file checked. The cheap check first means a
+ * lock that is plainly someone else's is never moved. If it was taken over in
+ * the instant between that check and the rename, it is linked back, unless a
+ * new claim also landed in that instant.
+ */
+export function releaseLock(path, token) {
+    const aside = `${path}.release-${randomUUID()}`;
+    try {
+        if (tokenOf(path) !== token)
+            return false;
+        renameSync(path, aside);
+    }
+    catch (err) {
+        if (isGone(err))
+            return false; // already released, or taken over and released
+        throw err;
+    }
+    try {
+        if (tokenOf(aside) === token)
+            return true;
+        linkSync(aside, path); // not ours: put the taker's lock back
+        return false;
+    }
+    catch (err) {
+        // EEXIST: a new claim landed while the lock was aside, and that claimant holds it now.
+        if (err.code === 'EEXIST')
+            return false;
+        throw err;
+    }
+    finally {
+        rmSync(aside, { force: true });
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Cross-process exclusive file locks for Node.js: a held lock with an owner
+ * token, a caller-supplied staleness rule and race-safe takeover, and a short
+ * critical section built on it.
+ */
+export { claimLock, MARKER_STALE_MS, releaseLock, touchLock, updateLock, type ClaimOptions, type HeldLock, type LockClaim, type LockContent, type StaleRule, } from './held.ts';
+export { holderGone, pidAlive, untouchedFor, type HolderGoneOptions } from './rules.ts';
+export { LockTimeoutError, withLock, type LockOptions, type SectionHolder } from './section.ts';

package/dist/index.js

@@ -0,0 +1,8 @@
+/**
+ * Cross-process exclusive file locks for Node.js: a held lock with an owner
+ * token, a caller-supplied staleness rule and race-safe takeover, and a short
+ * critical section built on it.
+ */
+export { claimLock, MARKER_STALE_MS, releaseLock, touchLock, updateLock, } from "./held.js";
+export { holderGone, pidAlive, untouchedFor } from "./rules.js";
+export { LockTimeoutError, withLock } from "./section.js";

package/dist/rules.d.ts

@@ -0,0 +1,28 @@
+/** Ready-made staleness rules for `claimLock`. */
+import type { LockContent, StaleRule } from './held.ts';
+/**
+ * True when a process with `pid` exists. Signal 0 checks without delivering
+ * anything; `EPERM` means the process exists and belongs to another user,
+ * which counts as alive. A pid that is not a positive integer is not alive.
+ */
+export declare function pidAlive(pid: number): boolean;
+/** Options for {@link holderGone}. */
+export interface HolderGoneOptions {
+    /** The liveness probe. Default {@link pidAlive}. */
+    alive?: ((pid: number) => boolean) | undefined;
+}
+/**
+ * Stale once no pid that `pids` reads from the content is alive. Values that
+ * are not numbers name no live holder. A file that is not a JSON object was
+ * not written by `claimLock`, so this rule never judges it stale: it belongs
+ * to some other program and is left alone. A pid can be recycled by a later process, which
+ * then keeps the lock held; a rule that also compares a start time closes
+ * that.
+ */
+export declare function holderGone<F extends object = Record<string, unknown>>(pids: (content: LockContent<F>) => readonly unknown[], options?: HolderGoneOptions): StaleRule<F>;
+/**
+ * Stale once the lock has not been written or touched for more than `ms`
+ * milliseconds. A live holder whose work outlasts `ms` loses the lock, so
+ * keep `ms` far above the longest hold, or refresh the lock with `touchLock`.
+ */
+export declare function untouchedFor<F extends object = Record<string, unknown>>(ms: number, now?: () => number): StaleRule<F>;

package/dist/rules.js

@@ -0,0 +1,41 @@
+/** Ready-made staleness rules for `claimLock`. */
+/**
+ * True when a process with `pid` exists. Signal 0 checks without delivering
+ * anything; `EPERM` means the process exists and belongs to another user,
+ * which counts as alive. A pid that is not a positive integer is not alive.
+ */
+export function pidAlive(pid) {
+    if (!Number.isInteger(pid) || pid <= 0)
+        return false;
+    try {
+        process.kill(pid, 0);
+        return true;
+    }
+    catch (err) {
+        return err.code === 'EPERM';
+    }
+}
+/**
+ * Stale once no pid that `pids` reads from the content is alive. Values that
+ * are not numbers name no live holder. A file that is not a JSON object was
+ * not written by `claimLock`, so this rule never judges it stale: it belongs
+ * to some other program and is left alone. A pid can be recycled by a later process, which
+ * then keeps the lock held; a rule that also compares a start time closes
+ * that.
+ */
+export function holderGone(pids, options = {}) {
+    const alive = options.alive ?? pidAlive;
+    return (held) => {
+        if (held.content === null)
+            return false;
+        return !pids(held.content).some((pid) => typeof pid === 'number' && alive(pid));
+    };
+}
+/**
+ * Stale once the lock has not been written or touched for more than `ms`
+ * milliseconds. A live holder whose work outlasts `ms` loses the lock, so
+ * keep `ms` far above the longest hold, or refresh the lock with `touchLock`.
+ */
+export function untouchedFor(ms, now = Date.now) {
+    return (held) => now() - held.mtimeMs > ms;
+}

package/dist/section.d.ts

@@ -0,0 +1,47 @@
+/**
+ * The short critical section: hold a lock for the length of a synchronous
+ * function, such as a re-read, validate and rewrite of one file.
+ */
+import { type HeldLock, type StaleRule } from './held.ts';
+/** What a {@link withLock} lock records: the holder's pid. */
+export interface SectionHolder {
+    pid?: number;
+}
+/** Options for {@link withLock}. */
+export interface LockOptions {
+    /** A lock untouched for longer than this, in milliseconds, is a dead holder's and is taken over. Default 10 s. */
+    staleMs?: number | undefined;
+    /**
+     * Replaces the age rule: when a held lock may be taken over. For a section
+     * that can legitimately run long, `holderGone((h) => [h.pid])` waits for the
+     * holder process to exit instead of guessing by age. `staleMs` is then unused.
+     */
+    isStale?: StaleRule<SectionHolder> | undefined;
+    /** Give up and throw {@link LockTimeoutError} after waiting this long. 0 tries once. Default 30 s. */
+    timeoutMs?: number | undefined;
+    /** Pause between attempts, in milliseconds. Default 5. */
+    retryMs?: number | undefined;
+}
+/** {@link withLock} waited `timeoutMs` and the lock stayed held. */
+export declare class LockTimeoutError extends Error {
+    /** The lock that stayed held. */
+    readonly path: string;
+    /** The holder seen last, or null when the lock kept changing. */
+    readonly holder: HeldLock<SectionHolder> | null;
+    constructor(path: string, holder: HeldLock<SectionHolder> | null);
+}
+/**
+ * Run `fn` holding the lock at `path`, and release it when `fn` returns or
+ * throws. The lock records this process's pid. Waiting blocks the thread, so
+ * keep the section short. `fn` must be synchronous: one that returns a promise
+ * is refused with a `TypeError`, because the lock would be released before the
+ * awaited work ran. Use `claimLock` and `releaseLock` around async work.
+ *
+ * By default a lock untouched for `staleMs` is taken to be a killed holder's.
+ * That is a guess: a live holder whose section outlasts `staleMs` loses its
+ * lock to the next waiter, and both then run. The first one's release leaves
+ * the taker's lock alone, and that loss is not reported. Keep `staleMs` far
+ * above the longest section, or pass an `isStale` rule that does not guess by
+ * age, such as `holderGone`.
+ */
+export declare function withLock<T>(path: string, fn: () => T, options?: LockOptions): T;

package/dist/section.js

@@ -0,0 +1,78 @@
+/**
+ * The short critical section: hold a lock for the length of a synchronous
+ * function, such as a re-read, validate and rewrite of one file.
+ */
+import { prepareClaim, releaseLock } from "./held.js";
+import { untouchedFor } from "./rules.js";
+/** {@link withLock} waited `timeoutMs` and the lock stayed held. */
+export class LockTimeoutError extends Error {
+    /** The lock that stayed held. */
+    path;
+    /** The holder seen last, or null when the lock kept changing. */
+    holder;
+    constructor(path, holder) {
+        super(`timed out waiting for lock ${path}`);
+        this.name = 'LockTimeoutError';
+        this.path = path;
+        this.holder = holder;
+    }
+}
+/** Nothing ever notifies it, so `Atomics.wait` on it just sleeps. */
+const SLEEPER = new Int32Array(new SharedArrayBuffer(4));
+/** Block the thread for `ms` without spinning. */
+function sleepSync(ms) {
+    Atomics.wait(SLEEPER, 0, 0, ms);
+}
+/**
+ * Run `fn` holding the lock at `path`, and release it when `fn` returns or
+ * throws. The lock records this process's pid. Waiting blocks the thread, so
+ * keep the section short. `fn` must be synchronous: one that returns a promise
+ * is refused with a `TypeError`, because the lock would be released before the
+ * awaited work ran. Use `claimLock` and `releaseLock` around async work.
+ *
+ * By default a lock untouched for `staleMs` is taken to be a killed holder's.
+ * That is a guess: a live holder whose section outlasts `staleMs` loses its
+ * lock to the next waiter, and both then run. The first one's release leaves
+ * the taker's lock alone, and that loss is not reported. Keep `staleMs` far
+ * above the longest section, or pass an `isStale` rule that does not guess by
+ * age, such as `holderGone`.
+ */
+export function withLock(path, fn, options = {}) {
+    const { staleMs = 10_000, timeoutMs = 30_000, retryMs = 5 } = options;
+    const isStale = options.isStale ?? untouchedFor(staleMs);
+    const deadline = Date.now() + timeoutMs;
+    // The temp file is written once; each retry only tries the link again.
+    const prepared = prepareClaim(path, { pid: process.pid }, { isStale });
+    let claim;
+    try {
+        claim = prepared.attempt();
+        while (!claim.ok) {
+            if (Date.now() >= deadline)
+                throw new LockTimeoutError(path, claim.holder);
+            sleepSync(Math.min(retryMs, deadline - Date.now()));
+            claim = prepared.attempt();
+        }
+    }
+    finally {
+        prepared.dispose();
+    }
+    const { token } = claim;
+    let result;
+    try {
+        result = fn();
+    }
+    catch (err) {
+        try {
+            releaseLock(path, token);
+        }
+        catch {
+            // The section's own error is the one to report.
+        }
+        throw err;
+    }
+    releaseLock(path, token);
+    if (typeof result?.then === 'function') {
+        throw new TypeError(`withLock(${path}): fn returned a promise, so its awaited work ran after the lock was released; use claimLock and releaseLock around async work`);
+    }
+    return result;
+}

package/package.json

@@ -1,6 +1,70 @@
 {
   "name": "@osdlc/file-lock",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.0.1-stage",
+  "description": "Cross-process exclusive file locks for Node.js: a held lock with an owner token, a staleness rule you choose (holder process gone, untouched too long) and race-safe takeover of a stale lock, plus a short synchronous critical section built on it.",
+  "license": "MIT OR Apache-2.0",
+  "author": "sksizer",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/osdlc/osdlc.git",
+    "directory": "packages/ts/file-lock"
+  },
+  "homepage": "https://github.com/osdlc/osdlc/tree/main/packages/ts/file-lock#readme",
+  "bugs": "https://github.com/osdlc/osdlc/issues",
+  "keywords": [
+    "lock",
+    "lockfile",
+    "file-lock",
+    "mutex",
+    "exclusive",
+    "cross-process",
+    "stale-lock",
+    "critical-section",
+    "typescript"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "engines": {
+    "node": ">=22"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist/",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE-MIT",
+    "LICENSE-APACHE",
+    "SECURITY.md",
+    "CONTRIBUTING.md"
+  ],
+  "devDependencies": {
+    "@types/node": "^26.1.0",
+    "@vitest/coverage-v8": "^5.0.5",
+    "oxlint": "^1.65.0",
+    "prettier": "3.9.6",
+    "typescript": "~6.0.3",
+    "vitest": "^5.0.5",
+    "@osdlc/tsconfig": "^0.4.1",
+    "@osdlc/prettier-config": "^0.3.1",
+    "@osdlc/etag-write": "^0.3.0"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "clean": "node -e \"require('node:fs').rmSync('dist', { recursive: true, force: true })\"",
+    "test": "vitest run",
+    "coverage": "vitest run --coverage",
+    "smoke": "node tests/smoke.mjs",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "lint": "oxlint .",
+    "typecheck": "tsc --noEmit && tsc -p tsconfig.build.json --noEmit"
+  }
 }