@molecule/api-instance-leadership 0.0.0-stage → 1.1.0

package/LICENSE

@@ -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 [yyyy] [name of copyright owner]
+
+   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/README.md

@@ -1,3 +1,294 @@
-# Temporary Holding Version
+<!--
+AUTO-GENERATED — DO NOT EDIT THIS FILE.
+Generated by `mlcl sync-docs` from the package's src/index.ts JSDoc + mlcl/registry.json.
+Edits here are overwritten on the next commit (molecule's pre-commit hook regenerates).
+To change this document, edit the module-level JSDoc in src/index.ts.
+Generated: 2026-10-19T22:02:10.338Z
+-->
 
-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.
+# @molecule/api-instance-leadership
+
+Instance-leadership core interface for molecule.dev: elect ONE API instance
+to run platform-wide singleton work, and hand leadership over within seconds
+when the holder's connection is lost.
+
+Bond a provider — `@molecule/api-instance-leadership-postgresql` — at
+startup, then start leader-only work from `acquireLeadership()`:
+
+```typescript
+import { acquireLeadership, isLeader } from '@molecule/api-instance-leadership'
+import { provider } from '@molecule/api-instance-leadership-postgresql'
+import { setProvider } from '@molecule/api-instance-leadership'
+
+setProvider(provider)
+
+acquireLeadership({
+  onAcquired: () => startPoolManager(),
+  onLost: () => stopPoolManager(),
+})
+```
+
+**Only the code you run inside `onAcquired` is leader-only.** Every instance
+still serves HTTP traffic, processes queue messages, and answers readiness
+probes. Reach for this package when a job must run once across the whole
+platform — pre-warm pool managers, retention sweeps, status recorders,
+periodic billing — not for anything request-driven.
+
+Use `isLeader()` for facts that must be decided at call time (e.g. skipping a
+duplicate periodic tick); use `onAcquired`/`onLost` to start and stop the
+loops themselves.
+
+> **Auto-generated, AI-first package reference** for the [molecule.dev](https://molecule.dev) ecosystem.
+> It is written to be read by coding agents as much as by people, and is generated from this
+> package's source — edit `src/index.ts` JSDoc, not this file.
+
+## Type
+
+`core`
+
+## Installation
+
+```bash
+npm install @molecule/api-instance-leadership @molecule/api-bond
+```
+
+## API
+
+### Interfaces
+
+#### `LeaderLockSession`
+
+One dedicated lock session, as a provider bond sees it.
+
+A session must be backed by a connection the provider owns exclusively: the
+lock lives and dies with that connection, so an operator never has to tune a
+TTL and a crashed instance never leaves a stale lock row behind.
+
+```typescript
+interface LeaderLockSession {
+  /**
+   * Ask the shared store for the lock WITHOUT blocking.
+   *
+   * @returns `true` when this session now holds it.
+   */
+  tryLock(): Promise<boolean>
+
+  /**
+   * Release the lock (a no-op when this session does not hold it) and close
+   * the connection.
+   */
+  release(): Promise<void>
+
+  /**
+   * Register the "this connection is gone" handler. Called at most once, when
+   * the connection errors or the store ends the session.
+   *
+   * @param handler - Invoked on connection loss.
+   */
+  onLost(handler: () => void): void
+}
+```
+
+#### `AcquireLeadershipOptions`
+
+What {@link InstanceLeadershipProvider.acquire} needs from the application.
+
+```typescript
+interface AcquireLeadershipOptions {
+  /**
+   * Start the singleton subsystems. Invoked once per acquisition — including a
+   * RE-acquisition after a connection loss, so it must be safe to call again
+   * after {@link AcquireLeadershipOptions.onLost} stopped everything.
+   */
+  onAcquired: () => void | Promise<void>
+
+  /**
+   * Stop the singleton subsystems. Invoked when a leader loses its lock
+   * connection, BEFORE the provider tries to re-acquire: the store has (or is
+   * about to) release the lock, another instance may already be taking over,
+   * and two live leaders is exactly what leadership exists to prevent.
+   */
+  onLost?: () => void | Promise<void>
+}
+```
+
+#### `InstanceLeadershipProvider`
+
+The contract every instance-leadership provider implements.
+
+Application code reaches the bonded provider through the accessors in
+`@molecule/api-instance-leadership` (`setProvider`, `getProvider`,
+`isLeader`, `acquireLeadership`, `releaseLeadership`) rather than importing
+a bond.
+
+```typescript
+interface InstanceLeadershipProvider {
+  /**
+   * Whether THIS instance currently holds the leadership lock.
+   *
+   * @returns `true` from the moment the lock is acquired until it is lost or
+   * released.
+   */
+  isLeader(): boolean
+
+  /**
+   * The current leadership phase.
+   *
+   * @returns The {@link LeadershipState}.
+   */
+  state(): LeadershipState
+
+  /**
+   * Start contending for the lock, retrying forever in the background. Never
+   * rejects and never blocks — the caller starts its singleton subsystems from
+   * {@link AcquireLeadershipOptions.onAcquired}.
+   *
+   * Calling `acquire()` again while already contending or leading is a no-op.
+   *
+   * @param options - What to start on acquisition and stop on loss.
+   */
+  acquire(options: AcquireLeadershipOptions): void
+
+  /**
+   * Stop contending and release the lock, so another instance can take over
+   * immediately instead of waiting for this process to exit.
+   *
+   * @returns Resolves once the lock release and the connection close settle.
+   */
+  release(): Promise<void>
+}
+```
+
+### Types
+
+#### `LeadershipState`
+
+The leadership phase of one instance.
+
+- `follower` — the instance is contending for the lock but does not hold it.
+- `leader` — the instance holds the lock and runs the singleton work.
+- `stopped` — `release()` was called; the instance no longer contends.
+
+```typescript
+type LeadershipState = 'follower' | 'leader' | 'stopped'
+```
+
+#### `LeaderLockFactory`
+
+Creates a fresh lock session.
+
+Injected rather than imported so a host application can reuse its own
+database connection settings, and so tests can drive several simulated
+instances through one fake store.
+
+```typescript
+type LeaderLockFactory = () => Promise<LeaderLockSession>
+```
+
+### Functions
+
+#### `setProvider(provider)`
+
+Registers an instance-leadership provider as the active singleton. Called by
+a bond package during application startup.
+
+```typescript
+function setProvider(provider: InstanceLeadershipProvider): void
+```
+
+- `provider` — The provider implementation to bond.
+
+#### `getProvider()`
+
+Retrieves the bonded instance-leadership provider, throwing if none is wired.
+
+```typescript
+function getProvider(): InstanceLeadershipProvider
+```
+
+**Returns:** The bonded instance-leadership provider.
+
+#### `hasProvider()`
+
+Checks whether an instance-leadership provider is currently bonded.
+
+```typescript
+function hasProvider(): boolean
+```
+
+**Returns:** `true` if a provider is bonded.
+
+#### `isLeader()`
+
+Whether THIS instance currently holds platform leadership.
+
+```typescript
+function isLeader(): boolean
+```
+
+**Returns:** `false` when no provider is bonded or this instance is a follower.
+
+#### `leadershipState()`
+
+The current leadership phase of this instance.
+
+```typescript
+function leadershipState(): LeadershipState
+```
+
+**Returns:** The bonded provider's state, or `'follower'` when none is bonded.
+
+#### `acquireLeadership(options)`
+
+Starts contending for platform leadership through the bonded provider.
+
+```typescript
+function acquireLeadership(options: AcquireLeadershipOptions): void
+```
+
+- `options` — What to start on acquisition and stop on loss.
+
+#### `releaseLeadership()`
+
+Releases platform leadership through the bonded provider so another
+instance can take over immediately.
+
+```typescript
+function releaseLeadership(): Promise<void>
+```
+
+**Returns:** Resolves once the release settles; a no-op when no provider is bonded.
+
+## Available Providers
+
+| Provider   | Package                                        |
+| ---------- | ---------------------------------------------- |
+| PostgreSQL | `@molecule/api-instance-leadership-postgresql` |
+
+## Injection Notes
+
+### Requirements
+
+Peer dependencies:
+
+- `@molecule/api-bond` ^1.0.1
+
+### Runtime Dependencies
+
+- `@molecule/api-bond`
+
+- **The lock must live in a store every instance shares.** A host-local lock
+  (a loopback port, a file) elects one leader PER HOST, so every singleton
+  runs twice — the failure this package exists to prevent.
+- **`onLost` is not optional in practice for a real leader.** A provider may
+  lose the lock while the process keeps running (a database connection that
+  errors); the instance demotes itself and another may already be leading.
+  Stop the loops in `onLost`, or two copies run.
+- **Re-acquisition is possible.** `onAcquired` runs again after a loss, so
+  it must be safe to call after `onLost` stopped everything.
+- **Followers retry forever in the background.** `acquireLeadership()` never
+  rejects and never blocks; a database that is down at boot just means this
+  instance stays a follower until it is reachable.
+- **No provider bonded ⇒ `isLeader()` is `false`.** A single-instance app can
+  use this package unchanged (it never leads until a bond exists) or omit it
+  and run its singleton work directly.

package/dist/browser-guard.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=browser-guard.d.ts.map

package/dist/browser-guard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser-guard.d.ts","sourceRoot":"","sources":["../src/browser-guard.ts"],"names":[],"mappings":"AAuBA,OAAO,EAAE,CAAA"}

package/dist/browser-guard.js

@@ -0,0 +1,19 @@
+/**
+ * Browser guard — `@molecule/api-instance-leadership` is SERVER-ONLY.
+ *
+ * Generated by scripts/gen-browser-guards.mjs (workspace root) — edit THAT, not this.
+ * Evaluating a server package in a browser bundle is always an import-graph mistake
+ * (node APIs, secrets); without this guard it surfaces as a cryptic downstream crash
+ * ("Buffer is not defined") far from the culprit. Throwing here names the package and
+ * the fix at the exact moment the client bundle evaluates it. jsdom tests and SSR are
+ * unaffected: the throw requires browser globals AND the absence of a node runtime.
+ */
+const g = globalThis;
+if (g.window !== undefined && g.document !== undefined && !g.process?.versions?.node) {
+    throw new Error('@molecule/api-instance-leadership is SERVER-ONLY: it was bundled into browser/client code. Import it only ' +
+        'from server code (a server route/function or your API), or dynamic-import it inside ' +
+        'the server handler — never from components or shared client modules, and never ' +
+        'polyfill Buffer/process to silence this.');
+}
+export {};
+//# sourceMappingURL=browser-guard.js.map

package/dist/browser-guard.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser-guard.js","sourceRoot":"","sources":["../src/browser-guard.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,MAAM,CAAC,GAAG,UAIT,CAAA;AACD,IAAI,CAAC,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,CAAC,QAAQ,KAAK,SAAS,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;IACrF,MAAM,IAAI,KAAK,CACb,4GAA4G;QAC1G,sFAAsF;QACtF,iFAAiF;QACjF,0CAA0C,CAC7C,CAAA;AACH,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Instance-leadership core interface for molecule.dev: elect ONE API instance
+ * to run platform-wide singleton work, and hand leadership over within seconds
+ * when the holder's connection is lost.
+ *
+ * Bond a provider — `@molecule/api-instance-leadership-postgresql` — at
+ * startup, then start leader-only work from `acquireLeadership()`:
+ *
+ * ```typescript
+ * import { acquireLeadership, isLeader } from '@molecule/api-instance-leadership'
+ * import { provider } from '@molecule/api-instance-leadership-postgresql'
+ * import { setProvider } from '@molecule/api-instance-leadership'
+ *
+ * setProvider(provider)
+ *
+ * acquireLeadership({
+ *   onAcquired: () => startPoolManager(),
+ *   onLost: () => stopPoolManager(),
+ * })
+ * ```
+ *
+ * **Only the code you run inside `onAcquired` is leader-only.** Every instance
+ * still serves HTTP traffic, processes queue messages, and answers readiness
+ * probes. Reach for this package when a job must run once across the whole
+ * platform — pre-warm pool managers, retention sweeps, status recorders,
+ * periodic billing — not for anything request-driven.
+ *
+ * Use `isLeader()` for facts that must be decided at call time (e.g. skipping a
+ * duplicate periodic tick); use `onAcquired`/`onLost` to start and stop the
+ * loops themselves.
+ *
+ * @remarks
+ * - **The lock must live in a store every instance shares.** A host-local lock
+ *   (a loopback port, a file) elects one leader PER HOST, so every singleton
+ *   runs twice — the failure this package exists to prevent.
+ * - **`onLost` is not optional in practice for a real leader.** A provider may
+ *   lose the lock while the process keeps running (a database connection that
+ *   errors); the instance demotes itself and another may already be leading.
+ *   Stop the loops in `onLost`, or two copies run.
+ * - **Re-acquisition is possible.** `onAcquired` runs again after a loss, so
+ *   it must be safe to call after `onLost` stopped everything.
+ * - **Followers retry forever in the background.** `acquireLeadership()` never
+ *   rejects and never blocks; a database that is down at boot just means this
+ *   instance stays a follower until it is reachable.
+ * - **No provider bonded ⇒ `isLeader()` is `false`.** A single-instance app can
+ *   use this package unchanged (it never leads until a bond exists) or omit it
+ *   and run its singleton work directly.
+ *
+ * @module
+ */
+export * from './browser-guard.js';
+export * from './provider.js';
+export * from './types.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AAEH,cAAc,oBAAoB,CAAA;AAClC,cAAc,eAAe,CAAA;AAC7B,cAAc,YAAY,CAAA"}

package/dist/index.js

@@ -0,0 +1,54 @@
+/**
+ * Instance-leadership core interface for molecule.dev: elect ONE API instance
+ * to run platform-wide singleton work, and hand leadership over within seconds
+ * when the holder's connection is lost.
+ *
+ * Bond a provider — `@molecule/api-instance-leadership-postgresql` — at
+ * startup, then start leader-only work from `acquireLeadership()`:
+ *
+ * ```typescript
+ * import { acquireLeadership, isLeader } from '@molecule/api-instance-leadership'
+ * import { provider } from '@molecule/api-instance-leadership-postgresql'
+ * import { setProvider } from '@molecule/api-instance-leadership'
+ *
+ * setProvider(provider)
+ *
+ * acquireLeadership({
+ *   onAcquired: () => startPoolManager(),
+ *   onLost: () => stopPoolManager(),
+ * })
+ * ```
+ *
+ * **Only the code you run inside `onAcquired` is leader-only.** Every instance
+ * still serves HTTP traffic, processes queue messages, and answers readiness
+ * probes. Reach for this package when a job must run once across the whole
+ * platform — pre-warm pool managers, retention sweeps, status recorders,
+ * periodic billing — not for anything request-driven.
+ *
+ * Use `isLeader()` for facts that must be decided at call time (e.g. skipping a
+ * duplicate periodic tick); use `onAcquired`/`onLost` to start and stop the
+ * loops themselves.
+ *
+ * @remarks
+ * - **The lock must live in a store every instance shares.** A host-local lock
+ *   (a loopback port, a file) elects one leader PER HOST, so every singleton
+ *   runs twice — the failure this package exists to prevent.
+ * - **`onLost` is not optional in practice for a real leader.** A provider may
+ *   lose the lock while the process keeps running (a database connection that
+ *   errors); the instance demotes itself and another may already be leading.
+ *   Stop the loops in `onLost`, or two copies run.
+ * - **Re-acquisition is possible.** `onAcquired` runs again after a loss, so
+ *   it must be safe to call after `onLost` stopped everything.
+ * - **Followers retry forever in the background.** `acquireLeadership()` never
+ *   rejects and never blocks; a database that is down at boot just means this
+ *   instance stays a follower until it is reachable.
+ * - **No provider bonded ⇒ `isLeader()` is `false`.** A single-instance app can
+ *   use this package unchanged (it never leads until a bond exists) or omit it
+ *   and run its singleton work directly.
+ *
+ * @module
+ */
+export * from './browser-guard.js';
+export * from './provider.js';
+export * from './types.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AAEH,cAAc,oBAAoB,CAAA;AAClC,cAAc,eAAe,CAAA;AAC7B,cAAc,YAAY,CAAA"}

package/dist/provider.d.ts

@@ -0,0 +1,58 @@
+/**
+ * Accessors for the bonded instance-leadership provider.
+ *
+ * A provider bond (e.g. `@molecule/api-instance-leadership-postgresql`) calls
+ * `setProvider()` during application startup. Application code uses the
+ * convenience accessors (`acquireLeadership`, `isLeader`, …), which delegate to
+ * the bonded provider.
+ *
+ * @module
+ */
+import type { AcquireLeadershipOptions, InstanceLeadershipProvider, LeadershipState } from './types.js';
+/**
+ * Registers an instance-leadership provider as the active singleton. Called by
+ * a bond package during application startup.
+ *
+ * @param provider - The provider implementation to bond.
+ */
+export declare const setProvider: (provider: InstanceLeadershipProvider) => void;
+/**
+ * Retrieves the bonded instance-leadership provider, throwing if none is wired.
+ *
+ * @returns The bonded instance-leadership provider.
+ * @throws {Error} If no instance-leadership provider has been bonded.
+ */
+export declare const getProvider: () => InstanceLeadershipProvider;
+/**
+ * Checks whether an instance-leadership provider is currently bonded.
+ *
+ * @returns `true` if a provider is bonded.
+ */
+export declare const hasProvider: () => boolean;
+/**
+ * Whether THIS instance currently holds platform leadership.
+ *
+ * @returns `false` when no provider is bonded or this instance is a follower.
+ */
+export declare const isLeader: () => boolean;
+/**
+ * The current leadership phase of this instance.
+ *
+ * @returns The bonded provider's state, or `'follower'` when none is bonded.
+ */
+export declare const leadershipState: () => LeadershipState;
+/**
+ * Starts contending for platform leadership through the bonded provider.
+ *
+ * @param options - What to start on acquisition and stop on loss.
+ * @throws {Error} If no instance-leadership provider has been bonded.
+ */
+export declare const acquireLeadership: (options: AcquireLeadershipOptions) => void;
+/**
+ * Releases platform leadership through the bonded provider so another
+ * instance can take over immediately.
+ *
+ * @returns Resolves once the release settles; a no-op when no provider is bonded.
+ */
+export declare const releaseLeadership: () => Promise<void>;
+//# sourceMappingURL=provider.d.ts.map

package/dist/provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAIH,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAC1B,eAAe,EAChB,MAAM,YAAY,CAAA;AAInB;;;;;GAKG;AACH,eAAO,MAAM,WAAW,GAAI,UAAU,0BAA0B,KAAG,IAElE,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,WAAW,QAAO,0BAS9B,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,WAAW,QAAO,OAE9B,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,QAAQ,QAAO,OAE3B,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,eAAe,QAAO,eAElC,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,GAAI,SAAS,wBAAwB,KAAG,IAErE,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,QAAa,OAAO,CAAC,IAAI,CAEtD,CAAA"}

package/dist/provider.js

@@ -0,0 +1,79 @@
+/**
+ * Accessors for the bonded instance-leadership provider.
+ *
+ * A provider bond (e.g. `@molecule/api-instance-leadership-postgresql`) calls
+ * `setProvider()` during application startup. Application code uses the
+ * convenience accessors (`acquireLeadership`, `isLeader`, …), which delegate to
+ * the bonded provider.
+ *
+ * @module
+ */
+import { bond, isBonded, require as bondRequire } from '@molecule/api-bond';
+const BOND_TYPE = 'instance-leadership';
+/**
+ * Registers an instance-leadership provider as the active singleton. Called by
+ * a bond package during application startup.
+ *
+ * @param provider - The provider implementation to bond.
+ */
+export const setProvider = (provider) => {
+    bond(BOND_TYPE, provider);
+};
+/**
+ * Retrieves the bonded instance-leadership provider, throwing if none is wired.
+ *
+ * @returns The bonded instance-leadership provider.
+ * @throws {Error} If no instance-leadership provider has been bonded.
+ */
+export const getProvider = () => {
+    try {
+        return bondRequire(BOND_TYPE);
+    }
+    catch (error) {
+        throw new Error('No instance-leadership provider set. Bond one (e.g. @molecule/api-instance-leadership-postgresql) at startup.', { cause: error });
+    }
+};
+/**
+ * Checks whether an instance-leadership provider is currently bonded.
+ *
+ * @returns `true` if a provider is bonded.
+ */
+export const hasProvider = () => {
+    return isBonded(BOND_TYPE);
+};
+/**
+ * Whether THIS instance currently holds platform leadership.
+ *
+ * @returns `false` when no provider is bonded or this instance is a follower.
+ */
+export const isLeader = () => {
+    return hasProvider() ? getProvider().isLeader() : false;
+};
+/**
+ * The current leadership phase of this instance.
+ *
+ * @returns The bonded provider's state, or `'follower'` when none is bonded.
+ */
+export const leadershipState = () => {
+    return hasProvider() ? getProvider().state() : 'follower';
+};
+/**
+ * Starts contending for platform leadership through the bonded provider.
+ *
+ * @param options - What to start on acquisition and stop on loss.
+ * @throws {Error} If no instance-leadership provider has been bonded.
+ */
+export const acquireLeadership = (options) => {
+    getProvider().acquire(options);
+};
+/**
+ * Releases platform leadership through the bonded provider so another
+ * instance can take over immediately.
+ *
+ * @returns Resolves once the release settles; a no-op when no provider is bonded.
+ */
+export const releaseLeadership = async () => {
+    if (hasProvider())
+        await getProvider().release();
+};
+//# sourceMappingURL=provider.js.map

package/dist/provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"provider.js","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAQ3E,MAAM,SAAS,GAAG,qBAAqB,CAAA;AAEvC;;;;;GAKG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,QAAoC,EAAQ,EAAE;IACxE,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAA;AAC3B,CAAC,CAAA;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,GAA+B,EAAE;IAC1D,IAAI,CAAC;QACH,OAAO,WAAW,CAA6B,SAAS,CAAC,CAAA;IAC3D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CACb,+GAA+G,EAC/G,EAAE,KAAK,EAAE,KAAK,EAAE,CACjB,CAAA;IACH,CAAC;AACH,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,GAAY,EAAE;IACvC,OAAO,QAAQ,CAAC,SAAS,CAAC,CAAA;AAC5B,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,GAAY,EAAE;IACpC,OAAO,WAAW,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,KAAK,CAAA;AACzD,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,GAAoB,EAAE;IACnD,OAAO,WAAW,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,UAAU,CAAA;AAC3D,CAAC,CAAA;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,OAAiC,EAAQ,EAAE;IAC3E,WAAW,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;AAChC,CAAC,CAAA;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,KAAK,IAAmB,EAAE;IACzD,IAAI,WAAW,EAAE;QAAE,MAAM,WAAW,EAAE,CAAC,OAAO,EAAE,CAAA;AAClD,CAAC,CAAA"}

package/dist/types.d.ts

@@ -0,0 +1,128 @@
+/**
+ * Type definitions for the instance-leadership core interface.
+ *
+ * Several subsystems of a multi-instance API assume exactly ONE runner across
+ * the whole platform rather than one per instance: pre-warm pool managers,
+ * hibernation and archive sweeps, status recorders, periodic billing jobs.
+ * Running them twice ranges from wasteful to corrupting. Instance leadership
+ * elects one instance — "the leader" — and runs those subsystems only there.
+ *
+ * The contract is deliberately small: the core names what leadership IS (a lock
+ * every instance contends for, held by one, lost when its connection dies) and
+ * a provider bond implements it against a shared store (e.g. a PostgreSQL
+ * session advisory lock in `@molecule/api-instance-leadership-postgresql`).
+ *
+ * @module
+ */
+/**
+ * The leadership phase of one instance.
+ *
+ * - `follower` — the instance is contending for the lock but does not hold it.
+ * - `leader` — the instance holds the lock and runs the singleton work.
+ * - `stopped` — `release()` was called; the instance no longer contends.
+ */
+export type LeadershipState = 'follower' | 'leader' | 'stopped';
+/**
+ * One dedicated lock session, as a provider bond sees it.
+ *
+ * A session must be backed by a connection the provider owns exclusively: the
+ * lock lives and dies with that connection, so an operator never has to tune a
+ * TTL and a crashed instance never leaves a stale lock row behind.
+ */
+export interface LeaderLockSession {
+    /**
+     * Ask the shared store for the lock WITHOUT blocking.
+     *
+     * @returns `true` when this session now holds it.
+     */
+    tryLock(): Promise<boolean>;
+    /**
+     * Release the lock (a no-op when this session does not hold it) and close
+     * the connection.
+     */
+    release(): Promise<void>;
+    /**
+     * Register the "this connection is gone" handler. Called at most once, when
+     * the connection errors or the store ends the session.
+     *
+     * @param handler - Invoked on connection loss.
+     */
+    onLost(handler: () => void): void;
+}
+/**
+ * Creates a fresh lock session.
+ *
+ * Injected rather than imported so a host application can reuse its own
+ * database connection settings, and so tests can drive several simulated
+ * instances through one fake store.
+ */
+export type LeaderLockFactory = () => Promise<LeaderLockSession>;
+/**
+ * What {@link InstanceLeadershipProvider.acquire} needs from the application.
+ */
+export interface AcquireLeadershipOptions {
+    /**
+     * Start the singleton subsystems. Invoked once per acquisition — including a
+     * RE-acquisition after a connection loss, so it must be safe to call again
+     * after {@link AcquireLeadershipOptions.onLost} stopped everything.
+     */
+    onAcquired: () => void | Promise<void>;
+    /**
+     * Stop the singleton subsystems. Invoked when a leader loses its lock
+     * connection, BEFORE the provider tries to re-acquire: the store has (or is
+     * about to) release the lock, another instance may already be taking over,
+     * and two live leaders is exactly what leadership exists to prevent.
+     */
+    onLost?: () => void | Promise<void>;
+}
+/**
+ * The contract every instance-leadership provider implements.
+ *
+ * Application code reaches the bonded provider through the accessors in
+ * `@molecule/api-instance-leadership` (`setProvider`, `getProvider`,
+ * `isLeader`, `acquireLeadership`, `releaseLeadership`) rather than importing
+ * a bond.
+ *
+ * @example
+ * ```typescript
+ * import { acquireLeadership, isLeader } from '@molecule/api-instance-leadership'
+ *
+ * acquireLeadership({
+ *   onAcquired: () => startPeriodicSweeps(),
+ *   onLost: () => stopPeriodicSweeps(),
+ * })
+ * ```
+ */
+export interface InstanceLeadershipProvider {
+    /**
+     * Whether THIS instance currently holds the leadership lock.
+     *
+     * @returns `true` from the moment the lock is acquired until it is lost or
+     * released.
+     */
+    isLeader(): boolean;
+    /**
+     * The current leadership phase.
+     *
+     * @returns The {@link LeadershipState}.
+     */
+    state(): LeadershipState;
+    /**
+     * Start contending for the lock, retrying forever in the background. Never
+     * rejects and never blocks — the caller starts its singleton subsystems from
+     * {@link AcquireLeadershipOptions.onAcquired}.
+     *
+     * Calling `acquire()` again while already contending or leading is a no-op.
+     *
+     * @param options - What to start on acquisition and stop on loss.
+     */
+    acquire(options: AcquireLeadershipOptions): void;
+    /**
+     * Stop contending and release the lock, so another instance can take over
+     * immediately instead of waiting for this process to exit.
+     *
+     * @returns Resolves once the lock release and the connection close settle.
+     */
+    release(): Promise<void>;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH;;;;;;GAMG;AACH,MAAM,MAAM,eAAe,GAAG,UAAU,GAAG,QAAQ,GAAG,SAAS,CAAA;AAE/D;;;;;;GAMG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,CAAA;IAE3B;;;OAGG;IACH,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAExB;;;;;OAKG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,IAAI,GAAG,IAAI,CAAA;CAClC;AAED;;;;;;GAMG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,OAAO,CAAC,iBAAiB,CAAC,CAAA;AAEhE;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;;OAIG;IACH,UAAU,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEtC;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACpC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;;;OAKG;IACH,QAAQ,IAAI,OAAO,CAAA;IAEnB;;;;OAIG;IACH,KAAK,IAAI,eAAe,CAAA;IAExB;;;;;;;;OAQG;IACH,OAAO,CAAC,OAAO,EAAE,wBAAwB,GAAG,IAAI,CAAA;IAEhD;;;;;OAKG;IACH,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;CACzB"}

package/dist/types.js

@@ -0,0 +1,18 @@
+/**
+ * Type definitions for the instance-leadership core interface.
+ *
+ * Several subsystems of a multi-instance API assume exactly ONE runner across
+ * the whole platform rather than one per instance: pre-warm pool managers,
+ * hibernation and archive sweeps, status recorders, periodic billing jobs.
+ * Running them twice ranges from wasteful to corrupting. Instance leadership
+ * elects one instance — "the leader" — and runs those subsystems only there.
+ *
+ * The contract is deliberately small: the core names what leadership IS (a lock
+ * every instance contends for, held by one, lost when its connection dies) and
+ * a provider bond implements it against a shared store (e.g. a PostgreSQL
+ * session advisory lock in `@molecule/api-instance-leadership-postgresql`).
+ *
+ * @module
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG"}

package/package.json

@@ -1,6 +1,57 @@
 {
   "name": "@molecule/api-instance-leadership",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.1.0",
+  "description": "Instance-leadership core interface for molecule.dev: elect one API instance to run platform-wide singleton work, with demotion and takeover when the holder's connection is lost.",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage"
+  },
+  "keywords": [
+    "molecule",
+    "leadership",
+    "leader election",
+    "singleton",
+    "distributed lock",
+    "multi-instance"
+  ],
+  "author": "Molecule Dev, Inc. (https://molecule.dev)",
+  "license": "Apache-2.0",
+  "engines": {
+    "node": ">=20"
+  },
+  "peerDependencies": {
+    "@molecule/api-bond": "^1.0.1"
+  },
+  "devDependencies": {
+    "@molecule/api-bond": "1.0.2",
+    "@types/node": "26.1.2",
+    "typescript": "6.0.3",
+    "vitest": "4.1.11"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/molecule-dev/molecule.git",
+    "directory": "packages/api/core/instance-leadership"
+  },
+  "homepage": "https://www.molecule.dev/packages/api-instance-leadership",
+  "bugs": "https://github.com/molecule-dev/molecule/issues",
+  "publishConfig": {
+    "access": "public"
+  }
+}