@vielzeug/codex 2.3.0 → 2.3.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/data/catalog.json +38 -37
- package/data/llms-full.txt +46 -4
- package/data/llms.txt +1 -1
- package/data/manifest.json +1 -1
- package/data/packages/postmaster.json +33 -27
- package/data/refine.json +1777 -1817
- package/data/search.json +9 -5
- package/package.json +1 -1
package/data/catalog.json
CHANGED
|
@@ -124,7 +124,7 @@
|
|
|
124
124
|
"refine"
|
|
125
125
|
],
|
|
126
126
|
"slug": "assay",
|
|
127
|
-
"version": "2.1.
|
|
127
|
+
"version": "2.1.1"
|
|
128
128
|
},
|
|
129
129
|
{
|
|
130
130
|
"availableDocPages": [
|
|
@@ -167,7 +167,7 @@
|
|
|
167
167
|
"ward"
|
|
168
168
|
],
|
|
169
169
|
"slug": "clockwork",
|
|
170
|
-
"version": "2.
|
|
170
|
+
"version": "2.2.0"
|
|
171
171
|
},
|
|
172
172
|
{
|
|
173
173
|
"availableDocPages": [
|
|
@@ -196,7 +196,7 @@
|
|
|
196
196
|
"refine"
|
|
197
197
|
],
|
|
198
198
|
"slug": "codex",
|
|
199
|
-
"version": "2.
|
|
199
|
+
"version": "2.3.0"
|
|
200
200
|
},
|
|
201
201
|
{
|
|
202
202
|
"availableDocPages": [
|
|
@@ -242,7 +242,7 @@
|
|
|
242
242
|
"spell"
|
|
243
243
|
],
|
|
244
244
|
"slug": "coins",
|
|
245
|
-
"version": "2.1.
|
|
245
|
+
"version": "2.1.1"
|
|
246
246
|
},
|
|
247
247
|
{
|
|
248
248
|
"availableDocPages": [
|
|
@@ -281,7 +281,7 @@
|
|
|
281
281
|
"rune"
|
|
282
282
|
],
|
|
283
283
|
"slug": "conduit",
|
|
284
|
-
"version": "2.0
|
|
284
|
+
"version": "2.1.0"
|
|
285
285
|
},
|
|
286
286
|
{
|
|
287
287
|
"availableDocPages": [
|
|
@@ -327,7 +327,7 @@
|
|
|
327
327
|
"spell"
|
|
328
328
|
],
|
|
329
329
|
"slug": "courier",
|
|
330
|
-
"version": "2.
|
|
330
|
+
"version": "2.3.0"
|
|
331
331
|
},
|
|
332
332
|
{
|
|
333
333
|
"availableDocPages": [
|
|
@@ -372,7 +372,7 @@
|
|
|
372
372
|
"refine"
|
|
373
373
|
],
|
|
374
374
|
"slug": "dnd",
|
|
375
|
-
"version": "2.0
|
|
375
|
+
"version": "2.1.0"
|
|
376
376
|
},
|
|
377
377
|
{
|
|
378
378
|
"availableDocPages": [
|
|
@@ -415,7 +415,7 @@
|
|
|
415
415
|
"herald"
|
|
416
416
|
],
|
|
417
417
|
"slug": "familiar",
|
|
418
|
-
"version": "2.0
|
|
418
|
+
"version": "2.1.0"
|
|
419
419
|
},
|
|
420
420
|
{
|
|
421
421
|
"availableDocPages": [
|
|
@@ -479,7 +479,7 @@
|
|
|
479
479
|
"courier"
|
|
480
480
|
],
|
|
481
481
|
"slug": "flux",
|
|
482
|
-
"version": "2.3.
|
|
482
|
+
"version": "2.3.3"
|
|
483
483
|
},
|
|
484
484
|
{
|
|
485
485
|
"availableDocPages": [
|
|
@@ -514,7 +514,7 @@
|
|
|
514
514
|
"ore"
|
|
515
515
|
],
|
|
516
516
|
"slug": "focus",
|
|
517
|
-
"version": "2.1.
|
|
517
|
+
"version": "2.1.1"
|
|
518
518
|
},
|
|
519
519
|
{
|
|
520
520
|
"availableDocPages": [
|
|
@@ -559,7 +559,7 @@
|
|
|
559
559
|
"courier"
|
|
560
560
|
],
|
|
561
561
|
"slug": "forge",
|
|
562
|
-
"version": "2.
|
|
562
|
+
"version": "2.3.0"
|
|
563
563
|
},
|
|
564
564
|
{
|
|
565
565
|
"availableDocPages": [
|
|
@@ -592,7 +592,7 @@
|
|
|
592
592
|
"keymap"
|
|
593
593
|
],
|
|
594
594
|
"slug": "gesture",
|
|
595
|
-
"version": "1.1.
|
|
595
|
+
"version": "1.1.1"
|
|
596
596
|
},
|
|
597
597
|
{
|
|
598
598
|
"availableDocPages": [
|
|
@@ -643,7 +643,7 @@
|
|
|
643
643
|
"familiar"
|
|
644
644
|
],
|
|
645
645
|
"slug": "herald",
|
|
646
|
-
"version": "2.
|
|
646
|
+
"version": "2.2.0"
|
|
647
647
|
},
|
|
648
648
|
{
|
|
649
649
|
"availableDocPages": [
|
|
@@ -686,7 +686,7 @@
|
|
|
686
686
|
"tempo"
|
|
687
687
|
],
|
|
688
688
|
"slug": "illusionist",
|
|
689
|
-
"version": "2.3.
|
|
689
|
+
"version": "2.3.1"
|
|
690
690
|
},
|
|
691
691
|
{
|
|
692
692
|
"availableDocPages": [
|
|
@@ -733,7 +733,7 @@
|
|
|
733
733
|
"ore"
|
|
734
734
|
],
|
|
735
735
|
"slug": "keymap",
|
|
736
|
-
"version": "2.
|
|
736
|
+
"version": "2.2.0"
|
|
737
737
|
},
|
|
738
738
|
{
|
|
739
739
|
"availableDocPages": [
|
|
@@ -774,7 +774,7 @@
|
|
|
774
774
|
"vault"
|
|
775
775
|
],
|
|
776
776
|
"slug": "ledger",
|
|
777
|
-
"version": "2.2.
|
|
777
|
+
"version": "2.2.3"
|
|
778
778
|
},
|
|
779
779
|
{
|
|
780
780
|
"availableDocPages": [
|
|
@@ -820,7 +820,7 @@
|
|
|
820
820
|
"courier"
|
|
821
821
|
],
|
|
822
822
|
"slug": "lingua",
|
|
823
|
-
"version": "2.
|
|
823
|
+
"version": "2.4.0"
|
|
824
824
|
},
|
|
825
825
|
{
|
|
826
826
|
"availableDocPages": [
|
|
@@ -857,7 +857,7 @@
|
|
|
857
857
|
"ore"
|
|
858
858
|
],
|
|
859
859
|
"slug": "necromancer",
|
|
860
|
-
"version": "2.0
|
|
860
|
+
"version": "2.1.0"
|
|
861
861
|
},
|
|
862
862
|
{
|
|
863
863
|
"availableDocPages": [
|
|
@@ -897,7 +897,7 @@
|
|
|
897
897
|
"prism"
|
|
898
898
|
],
|
|
899
899
|
"slug": "orbit",
|
|
900
|
-
"version": "2.1.
|
|
900
|
+
"version": "2.1.3"
|
|
901
901
|
},
|
|
902
902
|
{
|
|
903
903
|
"availableDocPages": [
|
|
@@ -961,7 +961,7 @@
|
|
|
961
961
|
"orbit"
|
|
962
962
|
],
|
|
963
963
|
"slug": "ore",
|
|
964
|
-
"version": "2.0
|
|
964
|
+
"version": "2.1.0"
|
|
965
965
|
},
|
|
966
966
|
{
|
|
967
967
|
"availableDocPages": [
|
|
@@ -973,7 +973,8 @@
|
|
|
973
973
|
"category": "Async",
|
|
974
974
|
"description": "Typed durable job outbox with leased processing, retries, and dead-letter recovery for browser applications.",
|
|
975
975
|
"exampleIds": [
|
|
976
|
-
"define-jobs"
|
|
976
|
+
"define-jobs",
|
|
977
|
+
"delayed-enqueue"
|
|
977
978
|
],
|
|
978
979
|
"exports": [
|
|
979
980
|
"createPostmaster",
|
|
@@ -1004,7 +1005,7 @@
|
|
|
1004
1005
|
"ripple"
|
|
1005
1006
|
],
|
|
1006
1007
|
"slug": "postmaster",
|
|
1007
|
-
"version": "
|
|
1008
|
+
"version": "2.0.0"
|
|
1008
1009
|
},
|
|
1009
1010
|
{
|
|
1010
1011
|
"availableDocPages": [
|
|
@@ -1061,7 +1062,7 @@
|
|
|
1061
1062
|
"orbit"
|
|
1062
1063
|
],
|
|
1063
1064
|
"slug": "prism",
|
|
1064
|
-
"version": "2.2.
|
|
1065
|
+
"version": "2.2.4"
|
|
1065
1066
|
},
|
|
1066
1067
|
{
|
|
1067
1068
|
"availableDocPages": [
|
|
@@ -1124,7 +1125,7 @@
|
|
|
1124
1125
|
"clockwork"
|
|
1125
1126
|
],
|
|
1126
1127
|
"slug": "pulse",
|
|
1127
|
-
"version": "2.
|
|
1128
|
+
"version": "2.3.0"
|
|
1128
1129
|
},
|
|
1129
1130
|
{
|
|
1130
1131
|
"availableDocPages": [
|
|
@@ -1222,7 +1223,7 @@
|
|
|
1222
1223
|
"keymap"
|
|
1223
1224
|
],
|
|
1224
1225
|
"slug": "refine",
|
|
1225
|
-
"version": "2.2.
|
|
1226
|
+
"version": "2.2.5"
|
|
1226
1227
|
},
|
|
1227
1228
|
{
|
|
1228
1229
|
"availableDocPages": [
|
|
@@ -1274,7 +1275,7 @@
|
|
|
1274
1275
|
"ledger"
|
|
1275
1276
|
],
|
|
1276
1277
|
"slug": "ripple",
|
|
1277
|
-
"version": "2.2.
|
|
1278
|
+
"version": "2.2.4"
|
|
1278
1279
|
},
|
|
1279
1280
|
{
|
|
1280
1281
|
"availableDocPages": [
|
|
@@ -1328,7 +1329,7 @@
|
|
|
1328
1329
|
"familiar"
|
|
1329
1330
|
],
|
|
1330
1331
|
"slug": "rune",
|
|
1331
|
-
"version": "2.1.
|
|
1332
|
+
"version": "2.1.1"
|
|
1332
1333
|
},
|
|
1333
1334
|
{
|
|
1334
1335
|
"availableDocPages": [
|
|
@@ -1427,7 +1428,7 @@
|
|
|
1427
1428
|
"ripple"
|
|
1428
1429
|
],
|
|
1429
1430
|
"slug": "scout",
|
|
1430
|
-
"version": "2.
|
|
1431
|
+
"version": "2.3.0"
|
|
1431
1432
|
},
|
|
1432
1433
|
{
|
|
1433
1434
|
"availableDocPages": [
|
|
@@ -1480,7 +1481,7 @@
|
|
|
1480
1481
|
"refine"
|
|
1481
1482
|
],
|
|
1482
1483
|
"slug": "scroll",
|
|
1483
|
-
"version": "2.
|
|
1484
|
+
"version": "2.2.0"
|
|
1484
1485
|
},
|
|
1485
1486
|
{
|
|
1486
1487
|
"availableDocPages": [
|
|
@@ -1522,7 +1523,7 @@
|
|
|
1522
1523
|
"gesture"
|
|
1523
1524
|
],
|
|
1524
1525
|
"slug": "sentinel",
|
|
1525
|
-
"version": "2.0.
|
|
1526
|
+
"version": "2.0.2"
|
|
1526
1527
|
},
|
|
1527
1528
|
{
|
|
1528
1529
|
"availableDocPages": [
|
|
@@ -1589,7 +1590,7 @@
|
|
|
1589
1590
|
"wayfinder"
|
|
1590
1591
|
],
|
|
1591
1592
|
"slug": "sourcerer",
|
|
1592
|
-
"version": "2.2.
|
|
1593
|
+
"version": "2.2.1"
|
|
1593
1594
|
},
|
|
1594
1595
|
{
|
|
1595
1596
|
"availableDocPages": [
|
|
@@ -1648,7 +1649,7 @@
|
|
|
1648
1649
|
"vault"
|
|
1649
1650
|
],
|
|
1650
1651
|
"slug": "spell",
|
|
1651
|
-
"version": "2.
|
|
1652
|
+
"version": "2.2.0"
|
|
1652
1653
|
},
|
|
1653
1654
|
{
|
|
1654
1655
|
"availableDocPages": [
|
|
@@ -1715,7 +1716,7 @@
|
|
|
1715
1716
|
"vault"
|
|
1716
1717
|
],
|
|
1717
1718
|
"slug": "tempo",
|
|
1718
|
-
"version": "2.1.
|
|
1719
|
+
"version": "2.1.2"
|
|
1719
1720
|
},
|
|
1720
1721
|
{
|
|
1721
1722
|
"availableDocPages": [
|
|
@@ -1767,7 +1768,7 @@
|
|
|
1767
1768
|
"ripple"
|
|
1768
1769
|
],
|
|
1769
1770
|
"slug": "vault",
|
|
1770
|
-
"version": "2.
|
|
1771
|
+
"version": "2.4.0"
|
|
1771
1772
|
},
|
|
1772
1773
|
{
|
|
1773
1774
|
"availableDocPages": [
|
|
@@ -1826,7 +1827,7 @@
|
|
|
1826
1827
|
"herald"
|
|
1827
1828
|
],
|
|
1828
1829
|
"slug": "ward",
|
|
1829
|
-
"version": "2.
|
|
1830
|
+
"version": "2.2.0"
|
|
1830
1831
|
},
|
|
1831
1832
|
{
|
|
1832
1833
|
"availableDocPages": [
|
|
@@ -1878,8 +1879,8 @@
|
|
|
1878
1879
|
"herald"
|
|
1879
1880
|
],
|
|
1880
1881
|
"slug": "wayfinder",
|
|
1881
|
-
"version": "2.
|
|
1882
|
+
"version": "2.2.0"
|
|
1882
1883
|
}
|
|
1883
1884
|
],
|
|
1884
|
-
"version": "2.
|
|
1885
|
+
"version": "2.3.0"
|
|
1885
1886
|
}
|
package/data/llms-full.txt
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Vielzeug — Full Documentation
|
|
2
2
|
|
|
3
|
-
> Complete documentation for 37 packages. Version: 2.
|
|
3
|
+
> Complete documentation for 37 packages. Version: 2.3.0
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
@@ -14450,7 +14450,7 @@ await store.dispose();
|
|
|
14450
14450
|
|
|
14451
14451
|
- `defineJobs()` — Typed job registry with payload inference and validation.
|
|
14452
14452
|
- `createPostmaster()` — Processor with leased claims, heartbeat renewal, and crash recovery.
|
|
14453
|
-
- `enqueue()` — Persist a job and wake the processor
|
|
14453
|
+
- `enqueue()` — Persist a job and wake the processor, with optional delayed eligibility via `availableAt`.
|
|
14454
14454
|
- `flush()` — Process every available job until the queue is empty.
|
|
14455
14455
|
- `retry()` / `remove()` — Recover or discard dead-letter jobs.
|
|
14456
14456
|
- `tap()` — Typed runtime events for enqueued, started, completed, retry-scheduled, dead-lettered, removed, lease-lost, and processor-error.
|
|
@@ -14617,10 +14617,28 @@ await store.dispose();
|
|
|
14617
14617
|
### `enqueue()`
|
|
14618
14618
|
|
|
14619
14619
|
```ts
|
|
14620
|
-
enqueue(
|
|
14620
|
+
enqueue(
|
|
14621
|
+
name: K,
|
|
14622
|
+
payload: InferJobPayload,
|
|
14623
|
+
options?: EnqueueOptions,
|
|
14624
|
+
): Promise;
|
|
14621
14625
|
```
|
|
14622
14626
|
|
|
14623
|
-
Validates the payload (if `validate` is defined), derives the key, persists the job, and wakes the processor. Throws `PostmasterError` for an empty key
|
|
14627
|
+
Validates the payload (if `validate` is defined), derives the key, persists the job, and wakes the processor. Throws `PostmasterError` for an empty key, non-JSON-serializable payload, or invalid `availableAt`.
|
|
14628
|
+
|
|
14629
|
+
| Parameter | Type | Description |
|
|
14630
|
+
| --- | --- | --- |
|
|
14631
|
+
| `name` | `K` | Registered job name |
|
|
14632
|
+
| `payload` | `InferJobPayload` | Job payload (validated if `validate` is defined) |
|
|
14633
|
+
| `options.availableAt` | `number` | Earliest epoch timestamp (ms) the job may be claimed. Defaults to the Postmaster clock. Must be a finite non-negative safe integer. |
|
|
14634
|
+
|
|
14635
|
+
**Delayed eligibility.** The job persists immediately but cannot be claimed before `availableAt`. Postmaster does not guarantee execution at that time — only that the job will not be claimed earlier. A live processor (`start()` or `flush()`) is required for execution. Past timestamps remain immediately eligible.
|
|
14636
|
+
|
|
14637
|
+
**Example**
|
|
14638
|
+
|
|
14639
|
+
```ts
|
|
14640
|
+
await postmaster.enqueue('sendDigest', { userId }, { availableAt: Date.now() + 60_000 });
|
|
14641
|
+
```
|
|
14624
14642
|
|
|
14625
14643
|
---
|
|
14626
14644
|
|
|
@@ -14705,6 +14723,18 @@ Aborts owned work, releases all active leases, and tears down subscriptions. Ide
|
|
|
14705
14723
|
|
|
14706
14724
|
## Types
|
|
14707
14725
|
|
|
14726
|
+
### `EnqueueOptions`
|
|
14727
|
+
|
|
14728
|
+
```ts
|
|
14729
|
+
interface EnqueueOptions {
|
|
14730
|
+
readonly availableAt?: number;
|
|
14731
|
+
}
|
|
14732
|
+
```
|
|
14733
|
+
|
|
14734
|
+
Options for `enqueue()`. `availableAt` is the earliest epoch timestamp (ms) at which the job may be claimed. Defaults to the Postmaster clock at enqueue time. Past timestamps remain immediately eligible. Postmaster does not guarantee execution at the requested time — only that the job will not be claimed before it. A live processor is required for execution.
|
|
14735
|
+
|
|
14736
|
+
---
|
|
14737
|
+
|
|
14708
14738
|
### `JobDefinition`
|
|
14709
14739
|
|
|
14710
14740
|
```ts
|
|
@@ -15054,6 +15084,16 @@ const jobs = defineJobs({
|
|
|
15054
15084
|
- Delay must be finite and non-negative.
|
|
15055
15085
|
- Lifecycle aborts caused by disposal are not classified as job failures.
|
|
15056
15086
|
|
|
15087
|
+
## Delayed eligibility
|
|
15088
|
+
|
|
15089
|
+
`enqueue()` accepts an optional `availableAt` timestamp. The job persists immediately but cannot be claimed before that time. Use this for scheduled writes, cooldowns, or any work that must survive a reload but should not run yet.
|
|
15090
|
+
|
|
15091
|
+
```ts
|
|
15092
|
+
await postmaster.enqueue('sendDigest', { userId }, { availableAt: Date.now() + 60_000 });
|
|
15093
|
+
```
|
|
15094
|
+
|
|
15095
|
+
Postmaster does not guarantee execution at `availableAt` — only that the job will not be claimed earlier. A live processor (`start()` or `flush()`) is required for execution. In a browser, a closed page or suspended service worker will run the job when the processor next becomes active. Past timestamps remain immediately eligible. The same mechanism already backs retry delays, so delayed eligibility reuses the existing claim, wake, and persistence paths.
|
|
15096
|
+
|
|
15057
15097
|
## Dead-letter recovery
|
|
15058
15098
|
|
|
15059
15099
|
Jobs that exhaust retries or hit a terminal failure move to dead-letter. Inspect, retry, or remove them.
|
|
@@ -15327,12 +15367,14 @@ The IndexedDB adapter is built on Vault. Use Vault directly for unrelated storag
|
|
|
15327
15367
|
|
|
15328
15368
|
- [Queue Offline Courier Mutations](./examples/queue-offline-courier-mutations.md)
|
|
15329
15369
|
- [Resume When Network Returns](./examples/resume-when-network-returns.md)
|
|
15370
|
+
- [Delayed Eligibility](./examples/delayed-eligibility.md)
|
|
15330
15371
|
- [Recover Dead-Letter Jobs](./examples/recover-dead-letter-jobs.md)
|
|
15331
15372
|
- [Service Worker Background Sync](./examples/service-worker-background-sync.md)
|
|
15332
15373
|
|
|
15333
15374
|
### REPL Examples
|
|
15334
15375
|
|
|
15335
15376
|
- defineJobs - Basic Outbox (id: `define-jobs`)
|
|
15377
|
+
- delayedEnqueue - Delayed Eligibility (id: `delayed-enqueue`)
|
|
15336
15378
|
|
|
15337
15379
|
---
|
|
15338
15380
|
|
package/data/llms.txt
CHANGED
package/data/manifest.json
CHANGED