@941design/marmot 0.2.0-alpha.0 → 0.2.0-alpha.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +30 -0
- package/dist/account/teardown.d.ts +66 -3
- package/dist/account/teardown.js +24 -2
- package/dist/client/admission-cleanup.d.ts +197 -0
- package/dist/client/admission-cleanup.js +635 -0
- package/dist/client/adoption-proof.d.ts +39 -0
- package/dist/client/adoption-proof.js +102 -0
- package/dist/client/before-publish-hooks.js +3 -1
- package/dist/client/commit-redrive.d.ts +28 -4
- package/dist/client/commit-redrive.js +54 -1
- package/dist/client/confirm-hooks.d.ts +6 -1
- package/dist/client/confirm-hooks.js +15 -0
- package/dist/client/create-client.d.ts +107 -3
- package/dist/client/create-client.js +114 -7
- package/dist/client/group-availability.d.ts +182 -0
- package/dist/client/group-availability.js +301 -0
- package/dist/client/group-history.d.ts +26 -0
- package/dist/client/group-history.js +77 -7
- package/dist/client/group-records.d.ts +39 -2
- package/dist/client/group-records.js +88 -5
- package/dist/client/group-runtime.d.ts +30 -3
- package/dist/client/group-runtime.js +131 -21
- package/dist/client/group-snapshot.d.ts +7 -1
- package/dist/client/group-snapshot.js +23 -2
- package/dist/client/index.d.ts +4 -1
- package/dist/client/ingest.js +47 -13
- package/dist/client/invitation-outcomes.d.ts +50 -0
- package/dist/client/invitation-outcomes.js +135 -0
- package/dist/client/opaque-candidates.d.ts +2 -1
- package/dist/client/opaque-candidates.js +2 -1
- package/dist/client/own-change-outbox.js +2 -0
- package/dist/client/pipeline.d.ts +30 -1
- package/dist/client/pipeline.js +142 -21
- package/dist/client/reentrancy-guard.d.ts +6 -0
- package/dist/client/reentrancy-guard.js +6 -0
- package/dist/history/admission-lineage.d.ts +186 -0
- package/dist/history/admission-lineage.js +589 -0
- package/dist/history/fencing.d.ts +41 -0
- package/dist/history/fencing.js +67 -7
- package/dist/history/index.d.ts +2 -1
- package/dist/history/index.js +2 -1
- package/dist/history/own-change.d.ts +13 -1
- package/dist/invitations/decline.d.ts +8 -2
- package/dist/invitations/decline.js +9 -3
- package/dist/invitations/delivery-evidence.d.ts +288 -0
- package/dist/invitations/delivery-evidence.js +766 -0
- package/dist/invitations/index.d.ts +4 -2
- package/dist/invitations/index.js +4 -2
- package/dist/invitations/invitation-outcome.d.ts +110 -0
- package/dist/invitations/invitation-outcome.js +210 -0
- package/dist/invitations/invite.d.ts +61 -6
- package/dist/invitations/invite.js +187 -51
- package/dist/invitations/welcome-processor.d.ts +20 -1
- package/dist/invitations/welcome-processor.js +81 -20
- package/dist/shared/errors.d.ts +7 -0
- package/dist/shared/errors.js +11 -0
- package/dist/shared/index.d.ts +1 -1
- package/dist/shared/index.js +1 -1
- package/dist/storage/index.d.ts +10 -0
- package/dist/storage/index.js +33 -1
- package/dist/storage/lease.d.ts +13 -0
- package/dist/storage/lease.js +51 -0
- package/package.json +2 -2
package/dist/shared/errors.d.ts
CHANGED
|
@@ -19,3 +19,10 @@ export declare class MarmotError extends Error {
|
|
|
19
19
|
}
|
|
20
20
|
/** Type guard; with `code`, also narrows to that one code. */
|
|
21
21
|
export declare function isMarmotError(value: unknown, code?: MarmotErrorCode): value is MarmotError;
|
|
22
|
+
/**
|
|
23
|
+
* Whether `error` says one stored row is unreadable as data — an envelope that does not open (`envelope-mismatch`,
|
|
24
|
+
* `reason: 'malformed'`) or a payload its decoder refused (`store-failed`, `details.malformed`) — rather than that the
|
|
25
|
+
* store failed, the lease is gone or the row was written by another build (`envelope-mismatch`, `reason: 'version'`).
|
|
26
|
+
* A lenient scan skips such a row as no evidence; every other error still propagates.
|
|
27
|
+
*/
|
|
28
|
+
export declare function isMalformedRowError(error: unknown): boolean;
|
package/dist/shared/errors.js
CHANGED
|
@@ -83,3 +83,14 @@ export function isMarmotError(value, code) {
|
|
|
83
83
|
return false;
|
|
84
84
|
return code === undefined || value.code === code;
|
|
85
85
|
}
|
|
86
|
+
/**
|
|
87
|
+
* Whether `error` says one stored row is unreadable as data — an envelope that does not open (`envelope-mismatch`,
|
|
88
|
+
* `reason: 'malformed'`) or a payload its decoder refused (`store-failed`, `details.malformed`) — rather than that the
|
|
89
|
+
* store failed, the lease is gone or the row was written by another build (`envelope-mismatch`, `reason: 'version'`).
|
|
90
|
+
* A lenient scan skips such a row as no evidence; every other error still propagates.
|
|
91
|
+
*/
|
|
92
|
+
export function isMalformedRowError(error) {
|
|
93
|
+
if (isMarmotError(error, 'envelope-mismatch'))
|
|
94
|
+
return error.details?.['reason'] === 'malformed';
|
|
95
|
+
return isMarmotError(error, 'store-failed') && error.details?.['malformed'] === true;
|
|
96
|
+
}
|
package/dist/shared/index.d.ts
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
* nothing else in-package; `kinds.ts` imports `@941design/marmot-engine/core`
|
|
8
8
|
* for `WELCOME_EVENT_KIND`.
|
|
9
9
|
*/
|
|
10
|
-
export { MarmotError, isMarmotError, MARMOT_ERROR_CODES, type MarmotErrorCode } from './errors.js';
|
|
10
|
+
export { MarmotError, isMarmotError, isMalformedRowError, MARMOT_ERROR_CODES, type MarmotErrorCode } from './errors.js';
|
|
11
11
|
export { RUMOR_KINDS, type RumorKind, type RumorKindConstants } from './kinds.js';
|
|
12
12
|
export { classifyPublish, type PublishOutcome } from './publish-classification.js';
|
|
13
13
|
export { isAccountPubkey, isHex64 } from './account-pubkey.js';
|
package/dist/shared/index.js
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
* nothing else in-package; `kinds.ts` imports `@941design/marmot-engine/core`
|
|
8
8
|
* for `WELCOME_EVENT_KIND`.
|
|
9
9
|
*/
|
|
10
|
-
export { MarmotError, isMarmotError, MARMOT_ERROR_CODES } from './errors.js';
|
|
10
|
+
export { MarmotError, isMarmotError, isMalformedRowError, MARMOT_ERROR_CODES } from './errors.js';
|
|
11
11
|
export { RUMOR_KINDS } from './kinds.js';
|
|
12
12
|
export { classifyPublish } from './publish-classification.js';
|
|
13
13
|
export { isAccountPubkey, isHex64 } from './account-pubkey.js';
|
package/dist/storage/index.d.ts
CHANGED
|
@@ -152,6 +152,16 @@ export interface AccountStore extends StoreScope<AccountArtifact> {
|
|
|
152
152
|
/** The last wipe's marker, readable whatever build wrote it. */
|
|
153
153
|
wipeMarker(): Promise<WipeMarker | undefined>;
|
|
154
154
|
onIncompatible(listener: IncompatibleListener): () => void;
|
|
155
|
+
/**
|
|
156
|
+
* Optional (epic marmot-invitation-outcomes, ADR-019 D11): calls `listener` once when this store stops being held
|
|
157
|
+
* under its lease — released or closed (inside the release barrier, as soon as writes stop being accepted and before
|
|
158
|
+
* a commit in progress is waited for), or the lease lost to another context (a Web Locks steal) — and synchronously
|
|
159
|
+
* at once when that already happened. A listener must not await, schedule work or touch a store; each runs inside a
|
|
160
|
+
* try/catch. Returns the unregister function. The built-in backends implement it; a consumer store that does not
|
|
161
|
+
* still works, but a client over it ends its availability subscriptions `no-lease` only lazily (at dispose, or when a
|
|
162
|
+
* background retry meets `no-lease`).
|
|
163
|
+
*/
|
|
164
|
+
onLeaseEnded?(listener: () => void): () => void;
|
|
155
165
|
}
|
|
156
166
|
/** What `openForWrite` yields; `{ account, groupFactory }` is `createMarmotClient`'s `stores` option. */
|
|
157
167
|
export interface WritableStores {
|
package/dist/storage/index.js
CHANGED
|
@@ -69,7 +69,7 @@
|
|
|
69
69
|
*/
|
|
70
70
|
import { MarmotError } from '../shared/index.js';
|
|
71
71
|
import { CURRENT_CODEC_VERSIONS, openEnvelope, openEnvelopeUnchecked, sealEnvelope, } from './envelope.js';
|
|
72
|
-
import { acquireLease, setReleaseBarrier, validateLeaseTimeout } from './lease.js';
|
|
72
|
+
import { acquireLease, onLeaseEnded, runLeaseEndListener, setReleaseBarrier, validateLeaseTimeout } from './lease.js';
|
|
73
73
|
export { CURRENT_CODEC_VERSIONS, ENVELOPE_FORMAT, decodePayload, encodePayload, openEnvelope, sealEnvelope, } from './envelope.js';
|
|
74
74
|
export { DEFAULT_LEASE_TIMEOUT_MS, acquireLease, defaultLockManager, } from './lease.js';
|
|
75
75
|
// ---------------------------------------------------------------------------
|
|
@@ -179,10 +179,28 @@ function createHandle(driver, account, lease, versions, clock) {
|
|
|
179
179
|
const commitGate = new SerialQueue();
|
|
180
180
|
// Every release of this lease (close(), stores.lease.release(), or the caller's own reference) first
|
|
181
181
|
// stops new writes and lets a flush already committing finish; flushes queued behind it reject no-lease.
|
|
182
|
+
// The lease-end listeners (AccountStore.onLeaseEnded): fired once, on the first of the release barrier (right after
|
|
183
|
+
// writes stop) and the lease's own end signal (a steal runs no barrier).
|
|
184
|
+
// One entry per registration (not per function): registering the same function twice fires it twice, and each
|
|
185
|
+
// unregister removes only its own registration.
|
|
186
|
+
const leaseEndListeners = new Set();
|
|
187
|
+
let leaseEndFired = false;
|
|
188
|
+
function fireLeaseEnded() {
|
|
189
|
+
if (leaseEndFired)
|
|
190
|
+
return;
|
|
191
|
+
leaseEndFired = true;
|
|
192
|
+
const listeners = [...leaseEndListeners];
|
|
193
|
+
leaseEndListeners.clear();
|
|
194
|
+
// A throwing listener, or an async one that rejects, never breaks the release, nor the other listeners.
|
|
195
|
+
for (const { listener } of listeners)
|
|
196
|
+
runLeaseEndListener(listener);
|
|
197
|
+
}
|
|
182
198
|
setReleaseBarrier(lease, async () => {
|
|
183
199
|
closed = true;
|
|
200
|
+
fireLeaseEnded();
|
|
184
201
|
await commitGate.run(async () => { });
|
|
185
202
|
});
|
|
203
|
+
onLeaseEnded(lease, fireLeaseEnded);
|
|
186
204
|
function assertLease() {
|
|
187
205
|
if (closed || !lease.held) {
|
|
188
206
|
throw new MarmotError('no-lease', `store for account ${account} is not held under a live lease`, { details: { account } });
|
|
@@ -427,6 +445,20 @@ function createHandle(driver, account, lease, versions, clock) {
|
|
|
427
445
|
}
|
|
428
446
|
return Object.freeze({ engine: stamp.engine, tsMls: stamp.tsMls, at: v.at, reason: v.reason });
|
|
429
447
|
},
|
|
448
|
+
onLeaseEnded(listener) {
|
|
449
|
+
if (typeof listener !== 'function')
|
|
450
|
+
throw new MarmotError('invalid-options', 'onLeaseEnded: listener must be a function');
|
|
451
|
+
if (leaseEndFired) {
|
|
452
|
+
// As for a listener fired by the release.
|
|
453
|
+
runLeaseEndListener(listener);
|
|
454
|
+
return () => undefined;
|
|
455
|
+
}
|
|
456
|
+
const registration = { listener };
|
|
457
|
+
leaseEndListeners.add(registration);
|
|
458
|
+
return () => {
|
|
459
|
+
leaseEndListeners.delete(registration);
|
|
460
|
+
};
|
|
461
|
+
},
|
|
430
462
|
};
|
|
431
463
|
const groups = new Map();
|
|
432
464
|
function groupFactory(rawGroupId) {
|
package/dist/storage/lease.d.ts
CHANGED
|
@@ -26,6 +26,19 @@ export declare const DEFAULT_LEASE_TIMEOUT_MS = 5000;
|
|
|
26
26
|
* own reference to the lease). Package-internal: not re-exported.
|
|
27
27
|
*/
|
|
28
28
|
export declare function setReleaseBarrier(lease: Lease, barrier: () => Promise<void>): void;
|
|
29
|
+
/**
|
|
30
|
+
* Runs one lease-end listener: a throw is swallowed, and so is the rejection of a thenable it returns (an `async`
|
|
31
|
+
* listener type-checks against `() => void`) — attached without awaiting, so the call stays synchronous and the
|
|
32
|
+
* rejection never surfaces as an unhandled one. A listener never breaks the release, its registration, or the others.
|
|
33
|
+
* Package-internal: not re-exported.
|
|
34
|
+
*/
|
|
35
|
+
export declare function runLeaseEndListener(listener: () => void): void;
|
|
36
|
+
/**
|
|
37
|
+
* Calls `listener` once when `lease` stops being held — released, or lost to another context (a Web Locks steal ends
|
|
38
|
+
* the hold without any release barrier running). Synchronously at once when it already ended. Each listener runs
|
|
39
|
+
* through {@link runLeaseEndListener}. Returns the unregister function. Package-internal: not re-exported.
|
|
40
|
+
*/
|
|
41
|
+
export declare function onLeaseEnded(lease: Lease, listener: () => void): () => void;
|
|
29
42
|
/** `navigator.locks` when the host has Web Locks, else `undefined`. */
|
|
30
43
|
export declare function defaultLockManager(): LockManagerLike | undefined;
|
|
31
44
|
export declare function validateLeaseTimeout(value: unknown, where: string): number;
|
package/dist/storage/lease.js
CHANGED
|
@@ -23,6 +23,55 @@ const releaseBarriers = new WeakMap();
|
|
|
23
23
|
export function setReleaseBarrier(lease, barrier) {
|
|
24
24
|
releaseBarriers.set(lease, barrier);
|
|
25
25
|
}
|
|
26
|
+
/** One entry per registration (not per function): each unregister removes only its own. */
|
|
27
|
+
const leaseEndListeners = new WeakMap();
|
|
28
|
+
const endedLeases = new WeakSet();
|
|
29
|
+
/**
|
|
30
|
+
* Runs one lease-end listener: a throw is swallowed, and so is the rejection of a thenable it returns (an `async`
|
|
31
|
+
* listener type-checks against `() => void`) — attached without awaiting, so the call stays synchronous and the
|
|
32
|
+
* rejection never surfaces as an unhandled one. A listener never breaks the release, its registration, or the others.
|
|
33
|
+
* Package-internal: not re-exported.
|
|
34
|
+
*/
|
|
35
|
+
export function runLeaseEndListener(listener) {
|
|
36
|
+
try {
|
|
37
|
+
const returned = listener();
|
|
38
|
+
if (typeof returned?.then === 'function') {
|
|
39
|
+
returned.then(undefined, () => undefined);
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
catch {
|
|
43
|
+
// Swallowed: see above.
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* Calls `listener` once when `lease` stops being held — released, or lost to another context (a Web Locks steal ends
|
|
48
|
+
* the hold without any release barrier running). Synchronously at once when it already ended. Each listener runs
|
|
49
|
+
* through {@link runLeaseEndListener}. Returns the unregister function. Package-internal: not re-exported.
|
|
50
|
+
*/
|
|
51
|
+
export function onLeaseEnded(lease, listener) {
|
|
52
|
+
if (endedLeases.has(lease)) {
|
|
53
|
+
runLeaseEndListener(listener);
|
|
54
|
+
return () => undefined;
|
|
55
|
+
}
|
|
56
|
+
let set = leaseEndListeners.get(lease);
|
|
57
|
+
if (set === undefined)
|
|
58
|
+
leaseEndListeners.set(lease, (set = new Set()));
|
|
59
|
+
const registration = { listener };
|
|
60
|
+
set.add(registration);
|
|
61
|
+
return () => {
|
|
62
|
+
set.delete(registration);
|
|
63
|
+
};
|
|
64
|
+
}
|
|
65
|
+
/** `lease` stopped being held: every {@link onLeaseEnded} listener, once. */
|
|
66
|
+
function leaseEnded(lease) {
|
|
67
|
+
if (endedLeases.has(lease))
|
|
68
|
+
return;
|
|
69
|
+
endedLeases.add(lease);
|
|
70
|
+
const listeners = [...(leaseEndListeners.get(lease) ?? [])];
|
|
71
|
+
leaseEndListeners.delete(lease);
|
|
72
|
+
for (const { listener } of listeners)
|
|
73
|
+
runLeaseEndListener(listener);
|
|
74
|
+
}
|
|
26
75
|
/** `navigator.locks` when the host has Web Locks, else `undefined`. */
|
|
27
76
|
export function defaultLockManager() {
|
|
28
77
|
const nav = globalThis.navigator;
|
|
@@ -105,8 +154,10 @@ export function acquireLease(locks, name, account, opts) {
|
|
|
105
154
|
}
|
|
106
155
|
released = requestDone.then(() => {
|
|
107
156
|
held = false;
|
|
157
|
+
leaseEnded(lease);
|
|
108
158
|
}, (err) => {
|
|
109
159
|
held = false;
|
|
160
|
+
leaseEnded(lease);
|
|
110
161
|
if (settled)
|
|
111
162
|
return;
|
|
112
163
|
settled = true;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@941design/marmot",
|
|
3
|
-
"version": "0.2.0-alpha.
|
|
3
|
+
"version": "0.2.0-alpha.1",
|
|
4
4
|
"description": "Marmot client: createMarmotClient over @941design/marmot-engine, with the @941design/nostr-events budgeted signer and transport contract.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
"@941design/marmot-engine": "^0.2.0-alpha.0"
|
|
37
37
|
},
|
|
38
38
|
"peerDependencies": {
|
|
39
|
-
"@941design/nostr-events": "^0.2.0-alpha.
|
|
39
|
+
"@941design/nostr-events": "^0.2.0-alpha.1"
|
|
40
40
|
},
|
|
41
41
|
"devDependencies": {
|
|
42
42
|
"@stryker-mutator/core": "^9.6.1",
|