@homeflare/alchemy 0.37.2 → 0.37.3

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.
Files changed (155) hide show
  1. package/dist/proxmox/backup-job-config.d.ts +95 -0
  2. package/dist/proxmox/backup-job-config.d.ts.map +1 -0
  3. package/dist/proxmox/backup-job-distilled.d.ts +46 -0
  4. package/dist/proxmox/backup-job-distilled.d.ts.map +1 -0
  5. package/dist/proxmox/backup-job.d.ts +9 -26
  6. package/dist/proxmox/backup-job.d.ts.map +1 -1
  7. package/dist/proxmox/distilled-pbs.d.ts +12 -0
  8. package/dist/proxmox/distilled-pbs.d.ts.map +1 -0
  9. package/dist/proxmox/fake-pbs-jobs.d.ts +23 -0
  10. package/dist/proxmox/fake-pbs-jobs.d.ts.map +1 -0
  11. package/dist/proxmox/fake-pbs-notify.d.ts.map +1 -1
  12. package/dist/proxmox/fake-pve.d.ts +1 -1
  13. package/dist/proxmox/fake-pve.d.ts.map +1 -1
  14. package/dist/proxmox/index.js +1501 -607
  15. package/dist/proxmox/index.js.map +48 -24
  16. package/dist/proxmox/live-core-fixtures.d.ts +40 -0
  17. package/dist/proxmox/live-core-fixtures.d.ts.map +1 -0
  18. package/dist/proxmox/metric-server-config.d.ts +49 -0
  19. package/dist/proxmox/metric-server-config.d.ts.map +1 -0
  20. package/dist/proxmox/metric-server-distilled.d.ts +43 -0
  21. package/dist/proxmox/metric-server-distilled.d.ts.map +1 -0
  22. package/dist/proxmox/metric-server.d.ts +2 -10
  23. package/dist/proxmox/metric-server.d.ts.map +1 -1
  24. package/dist/proxmox/notification-matcher-distilled.d.ts +9 -0
  25. package/dist/proxmox/notification-matcher-distilled.d.ts.map +1 -0
  26. package/dist/proxmox/notification-matcher-lifecycle.d.ts +27 -0
  27. package/dist/proxmox/notification-matcher-lifecycle.d.ts.map +1 -0
  28. package/dist/proxmox/notification-matcher.d.ts +5 -5
  29. package/dist/proxmox/notification-matcher.d.ts.map +1 -1
  30. package/dist/proxmox/notification-sdk-input.d.ts +22 -0
  31. package/dist/proxmox/notification-sdk-input.d.ts.map +1 -0
  32. package/dist/proxmox/notification-target-distilled.d.ts +12 -0
  33. package/dist/proxmox/notification-target-distilled.d.ts.map +1 -0
  34. package/dist/proxmox/notification-target-form.d.ts +2 -0
  35. package/dist/proxmox/notification-target-form.d.ts.map +1 -1
  36. package/dist/proxmox/notification-target-lifecycle.d.ts +29 -0
  37. package/dist/proxmox/notification-target-lifecycle.d.ts.map +1 -0
  38. package/dist/proxmox/notification-target-spec.d.ts +5 -0
  39. package/dist/proxmox/notification-target-spec.d.ts.map +1 -0
  40. package/dist/proxmox/notification-target.d.ts +4 -5
  41. package/dist/proxmox/notification-target.d.ts.map +1 -1
  42. package/dist/proxmox/pbs-datastore-endpoint.d.ts +1 -1
  43. package/dist/proxmox/pbs-datastore-form.d.ts +18 -42
  44. package/dist/proxmox/pbs-datastore-form.d.ts.map +1 -1
  45. package/dist/proxmox/pbs-datastore-guard.d.ts +7 -4
  46. package/dist/proxmox/pbs-datastore-guard.d.ts.map +1 -1
  47. package/dist/proxmox/pbs-datastore-lifecycle.d.ts +56 -0
  48. package/dist/proxmox/pbs-datastore-lifecycle.d.ts.map +1 -0
  49. package/dist/proxmox/pbs-datastore-wire.d.ts +21 -0
  50. package/dist/proxmox/pbs-datastore-wire.d.ts.map +1 -0
  51. package/dist/proxmox/pbs-datastore.d.ts +5 -6
  52. package/dist/proxmox/pbs-datastore.d.ts.map +1 -1
  53. package/dist/proxmox/pbs-notification-input.d.ts +18 -0
  54. package/dist/proxmox/pbs-notification-input.d.ts.map +1 -0
  55. package/dist/proxmox/pbs-notification-matcher-distilled.d.ts +11 -0
  56. package/dist/proxmox/pbs-notification-matcher-distilled.d.ts.map +1 -0
  57. package/dist/proxmox/pbs-notification-matcher.d.ts +4 -3
  58. package/dist/proxmox/pbs-notification-matcher.d.ts.map +1 -1
  59. package/dist/proxmox/pbs-notification-target-distilled.d.ts +20 -0
  60. package/dist/proxmox/pbs-notification-target-distilled.d.ts.map +1 -0
  61. package/dist/proxmox/pbs-notification-target-lifecycle.d.ts +4 -4
  62. package/dist/proxmox/pbs-notification-target-lifecycle.d.ts.map +1 -1
  63. package/dist/proxmox/pbs-notification-target.d.ts +1 -1
  64. package/dist/proxmox/pbs-prune-job-lifecycle.d.ts +22 -0
  65. package/dist/proxmox/pbs-prune-job-lifecycle.d.ts.map +1 -0
  66. package/dist/proxmox/pbs-prune-job-spec.d.ts +5 -0
  67. package/dist/proxmox/pbs-prune-job-spec.d.ts.map +1 -0
  68. package/dist/proxmox/pbs-prune-job-wire.d.ts +11 -0
  69. package/dist/proxmox/pbs-prune-job-wire.d.ts.map +1 -0
  70. package/dist/proxmox/pbs-prune-job.d.ts +9 -8
  71. package/dist/proxmox/pbs-prune-job.d.ts.map +1 -1
  72. package/dist/proxmox/pbs-sync-job-attributes.d.ts +34 -0
  73. package/dist/proxmox/pbs-sync-job-attributes.d.ts.map +1 -0
  74. package/dist/proxmox/pbs-sync-job-form.d.ts +21 -22
  75. package/dist/proxmox/pbs-sync-job-form.d.ts.map +1 -1
  76. package/dist/proxmox/pbs-sync-job-lifecycle.d.ts +22 -0
  77. package/dist/proxmox/pbs-sync-job-lifecycle.d.ts.map +1 -0
  78. package/dist/proxmox/pbs-sync-job-wire.d.ts +11 -0
  79. package/dist/proxmox/pbs-sync-job-wire.d.ts.map +1 -0
  80. package/dist/proxmox/pbs-sync-job.d.ts +9 -39
  81. package/dist/proxmox/pbs-sync-job.d.ts.map +1 -1
  82. package/dist/proxmox/pbs-verify-job-lifecycle.d.ts +22 -0
  83. package/dist/proxmox/pbs-verify-job-lifecycle.d.ts.map +1 -0
  84. package/dist/proxmox/pbs-verify-job-spec.d.ts +16 -0
  85. package/dist/proxmox/pbs-verify-job-spec.d.ts.map +1 -0
  86. package/dist/proxmox/pbs-verify-job-wire.d.ts +11 -0
  87. package/dist/proxmox/pbs-verify-job-wire.d.ts.map +1 -0
  88. package/dist/proxmox/pbs-verify-job.d.ts +12 -12
  89. package/dist/proxmox/pbs-verify-job.d.ts.map +1 -1
  90. package/dist/proxmox/pool.d.ts +10 -1
  91. package/dist/proxmox/pool.d.ts.map +1 -1
  92. package/docs/pbs-distilled-jobs.md +31 -0
  93. package/docs/pbs-notifications.md +8 -2
  94. package/docs/proxmox-notification-sdk.md +28 -0
  95. package/docs/proxmox-sdk-migration.md +60 -0
  96. package/docs/upstream-conformance-families.md +6 -2
  97. package/package.json +1 -1
  98. package/src/proxmox/adopt-noop.test.ts +4 -5
  99. package/src/proxmox/backup-job-config.ts +95 -0
  100. package/src/proxmox/backup-job-distilled.ts +86 -0
  101. package/src/proxmox/backup-job.ts +78 -116
  102. package/src/proxmox/constraints.test.ts +9 -8
  103. package/src/proxmox/distilled-pbs.test.ts +87 -0
  104. package/src/proxmox/distilled-pbs.ts +50 -0
  105. package/src/proxmox/fake-pbs-jobs.ts +99 -0
  106. package/src/proxmox/fake-pbs-notify.ts +4 -1
  107. package/src/proxmox/fake-pve.ts +3 -2
  108. package/src/proxmox/live-core-fixtures.ts +126 -0
  109. package/src/proxmox/live-core-lifecycle.test.ts +115 -0
  110. package/src/proxmox/live-core-wire.test.ts +190 -0
  111. package/src/proxmox/metric-server-config.ts +87 -0
  112. package/src/proxmox/metric-server-distilled.ts +81 -0
  113. package/src/proxmox/metric-server.ts +77 -88
  114. package/src/proxmox/notification-distilled.test.ts +162 -0
  115. package/src/proxmox/notification-matcher-distilled.ts +60 -0
  116. package/src/proxmox/notification-matcher-lifecycle.ts +71 -0
  117. package/src/proxmox/notification-matcher.ts +9 -26
  118. package/src/proxmox/notification-replacement.test.ts +190 -0
  119. package/src/proxmox/notification-sdk-input.ts +39 -0
  120. package/src/proxmox/notification-target-distilled.ts +160 -0
  121. package/src/proxmox/notification-target-form.ts +2 -0
  122. package/src/proxmox/notification-target-lifecycle.ts +75 -0
  123. package/src/proxmox/notification-target-spec.ts +68 -0
  124. package/src/proxmox/notification-target.ts +6 -68
  125. package/src/proxmox/pbs-datastore-endpoint.ts +1 -1
  126. package/src/proxmox/pbs-datastore-form.ts +18 -49
  127. package/src/proxmox/pbs-datastore-guard.ts +7 -4
  128. package/src/proxmox/pbs-datastore-lifecycle.ts +114 -0
  129. package/src/proxmox/pbs-datastore-wire.ts +94 -0
  130. package/src/proxmox/pbs-datastore.ts +7 -133
  131. package/src/proxmox/pbs-jobs-delete.test.ts +40 -0
  132. package/src/proxmox/pbs-jobs-sdk.test.ts +215 -0
  133. package/src/proxmox/pbs-notification-errors.test.ts +93 -0
  134. package/src/proxmox/pbs-notification-input.ts +25 -0
  135. package/src/proxmox/pbs-notification-mail.test.ts +64 -0
  136. package/src/proxmox/pbs-notification-matcher-distilled.ts +65 -0
  137. package/src/proxmox/pbs-notification-matcher.ts +70 -17
  138. package/src/proxmox/pbs-notification-target-distilled.ts +124 -0
  139. package/src/proxmox/pbs-notification-target-lifecycle.ts +26 -17
  140. package/src/proxmox/pbs-notification-target.ts +1 -1
  141. package/src/proxmox/pbs-notifications-stack.test.ts +25 -0
  142. package/src/proxmox/pbs-prune-job-lifecycle.ts +52 -0
  143. package/src/proxmox/pbs-prune-job-spec.ts +53 -0
  144. package/src/proxmox/pbs-prune-job-wire.ts +68 -0
  145. package/src/proxmox/pbs-prune-job.ts +10 -58
  146. package/src/proxmox/pbs-sync-job-attributes.ts +33 -0
  147. package/src/proxmox/pbs-sync-job-form.ts +7 -6
  148. package/src/proxmox/pbs-sync-job-lifecycle.ts +46 -0
  149. package/src/proxmox/pbs-sync-job-wire.ts +71 -0
  150. package/src/proxmox/pbs-sync-job.ts +10 -41
  151. package/src/proxmox/pbs-verify-job-lifecycle.ts +52 -0
  152. package/src/proxmox/pbs-verify-job-spec.ts +76 -0
  153. package/src/proxmox/pbs-verify-job-wire.ts +58 -0
  154. package/src/proxmox/pbs-verify-job.ts +13 -85
  155. package/src/proxmox/pool.ts +92 -10
@@ -1,42 +1,41 @@
1
1
  /**
2
- * A PBS datastore on the wire: the transport that reaches PBS, the form it wants, and the coercion
3
- * back to something comparable.
2
+ * A PBS datastore's pure vendor forms and coercion back to comparable state. SDK transport is
3
+ * in pbs-datastore-wire.ts; lifecycle behavior is in pbs-datastore-lifecycle.ts.
4
4
  *
5
5
  * ★ SPLIT OUT OF pbs-datastore.ts FOR THE 250-LINE CAP, the seam notification-target-form.ts uses:
6
- * this file is everything that touches PBS's encoding, and the resource file is the declaration
7
- * and the five handlers. The `import type` back is erased, so it is a cycle on paper only.
6
+ * this file originally held PBS encoding beside forms, while the resource held its declaration
7
+ * and five handlers. The `import type` back is erased, so it is a cycle on paper only.
8
8
  *
9
- * ⛔ THIS FILE IS OVER THE 250-LINE CAP AND THE EXTRACTION IS NAMED RATHER THAN FUDGED. `PbsTarget`,
9
+ * ⛔ HISTORICAL EXTRACTION NOTE: THIS FILE EXCEEDED THE 250-LINE CAP IN THE ORIGINAL DRAFT. `PbsTarget`,
10
10
  * `PbsRole`, `PbsError`, `pbsAuthorization`, `PveForm`, `encode`, `pbs` and `settle` — about 150
11
11
  * lines — are a PBS CLIENT, not a datastore form, and belong in `pbs-client.ts`. Lifting them
12
12
  * leaves this file near 200 and costs nothing but a move. It was not done here only because the
13
13
  * family was commissioned as a two-file split; ceph-pool is the in-package precedent for three
14
14
  * (ceph-pool.ts + ceph-pool-form.ts + ceph-pool-settle.ts, 532 lines for one family). Everything
15
15
  * in that list is also what Pbs.SyncJob, Pbs.PruneJob and Pbs.Remote will each need unchanged,
16
- * so the second PBS family forces the move anyway. ⛔ DO NOT MEET THE CAP BY CUTTING COMMENTS.
16
+ * so the second PBS family forced that move. The SDK and focused siblings now own these seams.
17
+ * ⛔ DO NOT MEET THE CAP BY CUTTING COMMENTS.
17
18
  */
18
- import * as Effect from 'effect/Effect';
19
- import { type PveForm, pve } from './client.ts';
20
19
  import type { PbsTarget as ApiPbsTarget } from './credentials.ts';
21
20
  import type { PbsDatastoreProps } from './pbs-datastore.ts';
22
21
  import { bool, flag, int, propertyString, text } from './values.ts';
23
22
 
24
23
  /**
25
- * ★ PBS REUSES THE PVE CLIENT RATHER THAN OWNING ONE. An earlier draft of this file carried its
26
- * own `PbsTarget`, `PbsError`, `pbsAuthorization`, form encoder and `pve()` — a near-copy of
27
- * client.ts differing in one header. They are gone: `PveTarget` now carries a `scheme`, and
28
- * `authorization()` spells the header `PBSAPIToken=<id>:<secret>` when it is `'pbs'`. The
29
- * insight that survived is the FORM TYPE — PBS decodes a multi-valued field from repeated keys
30
- * where PVE wants a comma string — and that now lives on `PveForm` in client.ts, so both
31
- * products share one encoder and neither can reach for the other's convention by accident.
24
+ * ★ PBS ORIGINALLY REUSED THE PVE CLIENT RATHER THAN OWNING ANOTHER. An earlier draft carried
25
+ * its own `PbsTarget`, `PbsError`, `pbsAuthorization`, form encoder and `pve()` — a near-copy of
26
+ * client.ts differing in one header. The shared target's `scheme` replaced that copy. This
27
+ * family now uses the distilled PBS SDK through `distilled-pbs.ts`, retaining the same leased
28
+ * credentials and PBS authorization scheme. The important encoding distinction survives:
29
+ * PBS decodes a multi-valued field from repeated keys where PVE wants a comma string. The SDK
30
+ * protocol owns that behavior; these pure forms describe only this datastore's scalar fields.
32
31
  *
33
32
  * 🔴 THIS ALIAS SAID `= PveTarget` AND IT WAS WRONG — Pbs.Datastore REQUIRED A PVE TARGET. When
34
33
  * `credentials.ts` grew a real `PbsTarget` with `scheme: 'pbs'`, this line was left pointing at
35
34
  * the PVE type, which pins `scheme: 'pve'`. So the one family that most needs the discriminant
36
35
  * was the one family that refused the correct value: declaring a datastore against the PBS host
37
36
  * failed to compile with `Type '"pbs"' is not assignable to type 'Input<"pve">'`, and passing a
38
- * PVE target compiled fine and would have 401'd every call — which `read` folds into "absent",
39
- * so the plan would say CREATE for a datastore holding the estate's backups.
37
+ * PVE target compiled fine and would have 401'd every call — which the old `read` folded into
38
+ * "absent", so the plan would say CREATE for a datastore holding the estate's backups.
40
39
  * ⛔ IT SURVIVED BECAUSE NOTHING EVER DECLARED ONE. The provider was registered in
41
40
  * alchemy.run.ts from the day it was written and `pveHandlers`' `list` answers empty, so
42
41
  * registration exercises no call site at all. Three sibling families import `PbsTarget` from
@@ -183,7 +182,7 @@ const mutable = (props: PbsDatastoreProps): Record<string, string> => ({
183
182
  * slot, not of the declaration; one that could re-point it is one that can send backups to the
184
183
  * wrong drive.
185
184
  */
186
- export const createForm = (props: PbsDatastoreProps): PveForm => ({
185
+ export const createForm = (props: PbsDatastoreProps): Record<string, string> => ({
187
186
  ...mutable(props),
188
187
  name: props.name,
189
188
  path: props.path,
@@ -213,36 +212,6 @@ export const createForm = (props: PbsDatastoreProps): PveForm => ({
213
212
  * element that fails the enum check. `PveForm` and `encode` already carry arrays for exactly
214
213
  * this. ⚠️ REASONED FROM THE PUBLISHED SCHEMA, NOT PROVEN ON A WIRE.
215
214
  */
216
- export const updateForm = (props: PbsDatastoreProps): PveForm => mutable(props);
215
+ export const updateForm = (props: PbsDatastoreProps): Record<string, string> => mutable(props);
217
216
 
218
217
  export const object = (props: PbsDatastoreProps) => `config/datastore/${props.name}`;
219
-
220
- /**
221
- * The live datastore, or undefined.
222
- *
223
- * ⛔ `name` IS THE PRESENCE TEST, NOT THE STATUS CODE — PBS does not answer 404 for a section that
224
- * is missing from `datastore.cfg`, it answers a generic error, so there is no code to key off.
225
- * ⛔ A MISSING READ PRIVILEGE THEREFORE LOOKS EXACTLY LIKE ABSENCE, because the fold below cannot
226
- * tell them apart. The signature is a plan that says CREATE followed by PBS answering
227
- * "datastore '<name>' already exists." — that pair means Datastore.Audit, not a missing
228
- * datastore. It is loud and non-destructive, which is the only reason the fold is tolerable here;
229
- * see the ⛔ on `readRole` in resource.ts for the PVE families where it is not.
230
- * ⛔ ON THE DELETE PATH THE SAME FOLD IS A LIE, AND THIS IS THE ONE HAZARD IN THIS FAMILY I COULD
231
- * NOT CLOSE. `delete` settles by polling this read until it answers `undefined` — and a `read`
232
- * role that lacks `Datastore.Audit` answers `undefined` from the very first poll, so EVERY delete
233
- * would report success while the datastore stood. Worse, the two lanes are different leases: the
234
- * DELETE goes out under `provision` and may genuinely fail, and this read cannot see that it did.
235
- * ★ THE SHAPE OF THE FIX IS ALREADY IN THIS PACKAGE: `confirmAbsent` in ceph-pool-settle.ts asks
236
- * a SECOND, DIFFERENT question — does the collection LIST this object? — and lets a failure
237
- * PROPAGATE rather than folding it, so "I could not ask" fails the deploy instead of passing
238
- * it. Add the same over `GET /config/datastore` before anyone relies on a reported deletion.
239
- * ⚠️ UNTIL THEN THE PRECONDITION IS EXPLICIT: the `read` role MUST hold `Datastore.Audit` on the
240
- * datastore, or this provider cannot tell a deletion from a refusal.
241
- */
242
- export const readOne = (props: PbsDatastoreProps) =>
243
- pve<Record<string, unknown>>(props.target, 'read', 'GET', object(props)).pipe(
244
- Effect.map((live) =>
245
- live === undefined || typeof live['name'] !== 'string' ? undefined : attributes(live, props),
246
- ),
247
- Effect.orElseSucceed(() => undefined),
248
- );
@@ -76,13 +76,15 @@ export const guardBackend = (live: PbsDatastoreAttributes, props: PbsDatastorePr
76
76
  /**
77
77
  * Wait for PBS to finish, then answer the last thing it said.
78
78
  *
79
- * ⛔ IT EXISTS BECAUSE A PBS CREATE IS A FORKED WORKER AND THE CONFIG SECTION IS WRITTEN LAST.
79
+ * ⛔ THE ORIGINAL CREATE-WORKER ASSUMPTION BELOW WAS REASONED, NOT MEASURED.
80
80
  * `POST /config/datastore` answers with a UPID while a `create-datastore` task builds the chunk
81
81
  * store's 65536 directories; only when that finishes does the section reach `datastore.cfg`. An
82
82
  * immediate read-back therefore sees a datastore that is not there yet, and the factory's "the
83
83
  * write returned no error but the object is still absent" would fire on a create going perfectly.
84
84
  * The DELETE forks a worker too. ⚠️ DOCUMENTED FROM THE PUBLISHED SCHEMA, NOT MEASURED — I hold
85
- * no PBS token. If a create turns out to be synchronous, the first poll simply succeeds.
85
+ * no PBS token. The pinned PBS 4.2.6-1 schema actually declares a NULL create response,
86
+ * while DELETE declares a UPID. We preserve bounded readback for both; a synchronous create
87
+ * succeeds at the first poll rather than depending on the old UPID assumption.
86
88
  * ★ IT TAKES THE READ AS AN EFFECT RATHER THAN A FUNCTION — the one simplification over
87
89
  * ceph-pool-settle.ts: an Effect is a description, so re-running it re-reads and no dependency
88
90
  * has to be threaded back in to avoid a cycle.
@@ -91,8 +93,9 @@ export const guardBackend = (live: PbsDatastoreAttributes, props: PbsDatastorePr
91
93
  * Anything still unsettled after two minutes is a fault to surface, not a wait to lengthen, and
92
94
  * the caller's message points at the task log, which is where the real answer is. `Effect.sleep`
93
95
  * yields between polls; nothing here parks a call on one long wait.
94
- * ⚠️ POLLING THE TASK STATUS INSTEAD WOULD BE WORSE, for ceph-pool-settle.ts's reason: every call
95
- * mints a FRESH token, so the token asking about the task is not the one that started it.
96
+ * ⚠️ THE ORIGINAL TRANSPORT MINTED A TOKEN PER CALL, making task-owner polling unreliable.
97
+ * The SDK runner now reuses leases, but create has no task id in its measured response schema.
98
+ * This migration therefore preserves bounded readback rather than inventing a task handle.
96
99
  */
97
100
  export const settle = <A, E, R>(read: Effect.Effect<A, E, R>, done: (live: A) => boolean) =>
98
101
  Effect.gen(function* () {
@@ -0,0 +1,114 @@
1
+ /** PBS 4.2.6-1 datastore lifecycle. Reads and writes use the distilled SDK. */
2
+ import { isResolved } from 'alchemy/Diff';
3
+ import type { Input } from 'alchemy/Input';
4
+ import * as Effect from 'effect/Effect';
5
+ import type { PbsDatastoreProps } from './pbs-datastore.ts';
6
+ import { type PbsDatastoreAttributes, matches, object, updateForm } from './pbs-datastore-form.ts';
7
+ import { createOne, deleteOne, readOne, updateOne } from './pbs-datastore-wire.ts';
8
+ import { guardBackend, guardPath, settle } from './pbs-datastore-guard.ts';
9
+ import { guardDatastoreForms } from './pbs-datastore-endpoint.ts';
10
+ import { formToSend } from './update-guard.ts';
11
+
12
+ export const handlers = {
13
+ /**
14
+ * ⛔ EMPTY, AND HERE IT GUARDS THE ESTATE'S BACKUPS. `GET /config/datastore` returns every
15
+ * datastore on the host, the one PVE's `type: pbs` storage writes into included. See
16
+ * `pveHandlers` in resource.ts for why adoption stays an explicit act.
17
+ */
18
+ list: () => Effect.succeed([]),
19
+ read: ({ olds }: { olds: PbsDatastoreProps }) => readOne(olds),
20
+ /**
21
+ * ⚠️ `isResolved` IS THE NARROWING, resource.ts's reason: at plan time a prop can still be an
22
+ * unresolved Output, and comparing a placeholder to a live value reports a phantom update.
23
+ * ⛔ `guardPath` IS A DELIBERATE DEPARTURE FROM storage.ts, which lets its create-only field
24
+ * plan as noop. Dying fails `alchemy plan` with both paths named — see the ⛔ on the prop.
25
+ */
26
+ diff: ({
27
+ news,
28
+ output,
29
+ }: {
30
+ news: Input<PbsDatastoreProps>;
31
+ output: PbsDatastoreAttributes | undefined;
32
+ }) =>
33
+ Effect.gen(function* () {
34
+ if (!isResolved(news)) return undefined;
35
+ // ⛔ BEFORE the `output === undefined` return: that branch IS the create, which is the
36
+ // one this family has never checked. resource.ts carries the argument in full.
37
+ yield* guardDatastoreForms(news);
38
+ if (output === undefined) return undefined;
39
+ const live = yield* readOne(news);
40
+ // ⚠️ `update`, not `create` — Alchemy's Diff admits only noop/update/replace, and an
41
+ // object Alchemy has state for but PBS does not is drift for reconcile to repair.
42
+ if (live === undefined) return { action: 'update' } as const;
43
+ yield* guardPath(live, news);
44
+ yield* guardBackend(live, news);
45
+ return matches(live, news) ? ({ action: 'noop' } as const) : ({ action: 'update' } as const);
46
+ }),
47
+ /**
48
+ * ⚠️ NOT THE FACTORY'S reconcile: it reads back ONCE, immediately — see the ⛔ on `settle`.
49
+ * ⛔ `guardPath` RUNS HERE TOO, AND THAT IS NOT BELT-AND-BRACES — see the ⛔ on it.
50
+ * ⛔ THE `matches` GUARD BEFORE THE PUT IS resource.ts's, AND IT IS WHY ADOPTION IS FREE.
51
+ */
52
+ reconcile: Effect.fn(function* ({ news }: { news: PbsDatastoreProps }) {
53
+ // ⚠️ Again here: an ADOPTED row's diff answer is discarded by Alchemy and reconcile runs.
54
+ yield* guardDatastoreForms(news);
55
+ const live = yield* readOne(news);
56
+ if (live === undefined) {
57
+ yield* createOne(news);
58
+ } else {
59
+ yield* guardPath(live, news);
60
+ yield* guardBackend(live, news);
61
+ // ⚠️ An empty form is not a write, and a match is not one either — update-guard.ts.
62
+ const form = formToSend(matches, live, news, updateForm(news));
63
+ if (form !== undefined) {
64
+ yield* updateOne(news);
65
+ }
66
+ }
67
+ const after = yield* settle(readOne(news), (row) => row !== undefined && matches(row, news));
68
+ if (after === undefined || !matches(after, news)) {
69
+ /**
70
+ * ⛔ REFUSE RATHER THAN RETURN THE PROPS AS THOUGH THEY LANDED — resource.ts's rule.
71
+ * The pinned PBS 4.2.6-1 schema gives create a null return, so readback is its evidence.
72
+ */
73
+ return yield* Effect.die(
74
+ new Error(
75
+ `${object(news)}: the write returned no error but the datastore still does not ` +
76
+ 'match the declaration after 120s. Check the PBS task list ' +
77
+ '-- read it with `proxmox-backup-manager task log <upid>`. A slow disk is a ' +
78
+ 'plausible cause (see `settle`); a create over an existing chunk store is not, ' +
79
+ 'because PBS refuses that outright rather than timing out.',
80
+ ),
81
+ );
82
+ }
83
+ return after;
84
+ }),
85
+ /**
86
+ * ⛔ FULLY IMPLEMENTED, NEVER A STUB, and it only ever runs on an explicit
87
+ * `.pipe(RemovalPolicy.destroy())` because this family defaults to `retain`.
88
+ * ⛔ NO `destroy-data`. PBS's DELETE drops the section from `datastore.cfg` and leaves every
89
+ * chunk and snapshot on disk; `destroy-data=1` erases the contents. It is not a prop and
90
+ * not a flag here, so this provider can un-declare a datastore and can never erase one.
91
+ * ⚠️ IT IS STILL A ONE-WAY DOOR FOR A DECLARATION: re-adding a datastore over an existing
92
+ * chunk store needs `reuse-datastore`, which is deliberately not declarable — see the
93
+ * ⚠️ on `createForm`. Re-adopt with `proxmox-backup-manager datastore create …`.
94
+ * ⚠️ NO `keep-job-configs` EITHER, SO THE JOBS GO TOO: PBS defaults it false and removes the
95
+ * verify, sync and prune jobs referencing this datastore — objects nothing here declares.
96
+ * PBS's default stands, so the blast radius is what a human clicking Remove would get.
97
+ * ⚠️ AND THE REFUSAL CAN ARRIVE AFTER THE RESPONSE: the delete forks a worker too, so a store
98
+ * held open by a running backup can fail once the call has already returned 200.
99
+ */
100
+ delete: Effect.fn(function* ({ olds }: { olds: PbsDatastoreProps }) {
101
+ yield* deleteOne(olds);
102
+ const left = yield* settle(readOne(olds), (row) => row === undefined);
103
+ if (left !== undefined) {
104
+ return yield* Effect.die(
105
+ new Error(
106
+ `${object(olds)}: the DELETE returned no error but the datastore is still in ` +
107
+ 'datastore.cfg after 120s. Either a backup, verify or GC task still holds it, ' +
108
+ 'or the provision role lacks Datastore.Allocate on /datastore/' +
109
+ `${olds.name}. Read the task log with \`proxmox-backup-manager task log <upid>\`.`,
110
+ ),
111
+ );
112
+ }
113
+ }),
114
+ };
@@ -0,0 +1,94 @@
1
+ /** PBS 4.2.6-1 datastore SDK operations; no raw route-string transport. */
2
+ import * as config from '@distilled.cloud/proxmox-backup/config';
3
+ import * as Effect from 'effect/Effect';
4
+ import { runPbs } from './distilled-pbs.ts';
5
+ import { attributes, createForm, updateForm } from './pbs-datastore-form.ts';
6
+ import type { PbsDatastoreProps } from './pbs-datastore.ts';
7
+
8
+ /** Keep the existing form's unmanaged-field decisions while using typed SDK member names. */
9
+ const members = (form: Record<string, string>) => ({
10
+ ...(form['comment'] === undefined ? {} : { comment: form['comment'] }),
11
+ ...(form['counter-reset-schedule'] === undefined
12
+ ? {}
13
+ : { counter_reset_schedule: form['counter-reset-schedule'] }),
14
+ ...(form['gc-schedule'] === undefined ? {} : { gc_schedule: form['gc-schedule'] }),
15
+ ...(form['keep-daily'] === undefined ? {} : { keep_daily: form['keep-daily'] }),
16
+ ...(form['keep-hourly'] === undefined ? {} : { keep_hourly: form['keep-hourly'] }),
17
+ ...(form['keep-last'] === undefined ? {} : { keep_last: form['keep-last'] }),
18
+ ...(form['keep-monthly'] === undefined ? {} : { keep_monthly: form['keep-monthly'] }),
19
+ ...(form['keep-weekly'] === undefined ? {} : { keep_weekly: form['keep-weekly'] }),
20
+ ...(form['keep-yearly'] === undefined ? {} : { keep_yearly: form['keep-yearly'] }),
21
+ ...(form['maintenance-mode'] === undefined ? {} : { maintenance_mode: form['maintenance-mode'] }),
22
+ ...(form['notification-thresholds'] === undefined
23
+ ? {}
24
+ : { notification_thresholds: form['notification-thresholds'] }),
25
+ ...(form['notify'] === undefined ? {} : { notify: form['notify'] }),
26
+ ...(form['notify-user'] === undefined ? {} : { notify_user: form['notify-user'] }),
27
+ ...(form['prune-schedule'] === undefined ? {} : { prune_schedule: form['prune-schedule'] }),
28
+ ...(form['tuning'] === undefined ? {} : { tuning: form['tuning'] }),
29
+ ...(form['verify-new'] === undefined ? {} : { verify_new: form['verify-new'] }),
30
+ });
31
+
32
+ const createRequest = (props: PbsDatastoreProps): config.CreateConfigDatastoreRequest => ({
33
+ ...members(createForm(props)),
34
+ name: props.name,
35
+ path: props.path,
36
+ ...(props.backend === undefined ? {} : { backend: props.backend }),
37
+ });
38
+
39
+ const updateRequest = (props: PbsDatastoreProps): config.PutConfigDatastoreRequest => ({
40
+ ...members(updateForm(props)),
41
+ name: props.name,
42
+ });
43
+
44
+ const wire = (row: config.GetConfigDatastoreResponse): Record<string, unknown> => ({
45
+ ...row,
46
+ 'counter-reset-schedule': row.counter_reset_schedule,
47
+ 'gc-schedule': row.gc_schedule,
48
+ 'keep-daily': row.keep_daily,
49
+ 'keep-hourly': row.keep_hourly,
50
+ 'keep-last': row.keep_last,
51
+ 'keep-monthly': row.keep_monthly,
52
+ 'keep-weekly': row.keep_weekly,
53
+ 'keep-yearly': row.keep_yearly,
54
+ 'maintenance-mode': row.maintenance_mode,
55
+ 'notification-thresholds': row.notification_thresholds,
56
+ 'notify-user': row.notify_user,
57
+ 'prune-schedule': row.prune_schedule,
58
+ 'verify-new': row.verify_new,
59
+ });
60
+
61
+ /**
62
+ * ⛔ THE RAW READ FOLDED EVERY ERROR TO ABSENCE. Its `name` presence check could not distinguish
63
+ * a missing section from a denied read: both suggested CREATE for a datastore holding backups.
64
+ * The resulting "already exists" failure was loud, but the same fold on DELETE was worse:
65
+ * the first denied read confirmed removal while the datastore still stood.
66
+ * ★ MEASURED 2026-09-24 against PBS 4.2.6-1: a missing section is plain-text HTTP400,
67
+ * `no such datastore '<name>'`. The distilled patch types that GET response as
68
+ * DatastoreNotFound. Only that tag means absent; no permission, transport or malformed-response
69
+ * error can settle deletion. This replaces the old recommendation to disambiguate by listing.
70
+ * ⚠️ The read role still requires Datastore.Audit, and a missing grant now fails visibly.
71
+ */
72
+ export const readOne = (props: PbsDatastoreProps) =>
73
+ runPbs(props.target, 'read', config.getConfigDatastore({ name: props.name })).pipe(
74
+ Effect.map((live) => attributes(wire(live), props)),
75
+ Effect.catchTag('DatastoreNotFound', () => Effect.succeed(undefined)),
76
+ );
77
+
78
+ export const createOne = (props: PbsDatastoreProps) =>
79
+ runPbs(props.target, 'provision', config.createConfigDatastore(createRequest(props)));
80
+
81
+ export const updateOne = (props: PbsDatastoreProps) =>
82
+ runPbs(props.target, 'provision', config.putConfigDatastore(updateRequest(props)));
83
+
84
+ /** ⛔ No destroy-data or keep-job-configs flag: retain the original removal contract. */
85
+ export const deleteOne = (props: PbsDatastoreProps) =>
86
+ Effect.gen(function* () {
87
+ // ⛔ Missing-item tags are measured for GET only. Do not guess the DELETE error shape.
88
+ if ((yield* readOne(props)) === undefined) return;
89
+ return yield* runPbs(
90
+ props.target,
91
+ 'provision',
92
+ config.deleteConfigDatastore({ name: props.name }),
93
+ );
94
+ });
@@ -13,12 +13,11 @@
13
13
  * `/access/domains` lists the realms `pbs`, `pam` and an openid realm. So the
14
14
  * prefix, the `{"data": …}` envelope and the strict-TLS story are PVE's exactly — and only the
15
15
  * credential differs. There is no `pve` realm here; a PVE token cannot authenticate at all.
16
- * The header differs too, which is why `pve()` exists rather than `pve()` being reused — see the
17
- * ⛔ on `pbsAuthorization` in pbs-datastore-form.ts.
16
+ * The distilled PBS SDK owns that distinct header; `distilled-pbs.ts` supplies its credentials.
18
17
  *
19
- * ⛔ THERE IS NO OPENBAO MOUNT FOR PBS TODAY, SO NOTHING HERE CAN DEPLOY YET. `PbsTarget.mount` is
18
+ * ⚠️ HISTORICAL BOOTSTRAP BLOCKER, 2026-09-13: THERE WAS NO PBS MOUNT. `PbsTarget.mount` is
20
19
  * a parameter for the reason `PveTarget.mount` is — the provider must be able to leave this
21
- * estate — but the estate has nothing to put in it. MEASURED: under the agent's approle,
20
+ * estate. A later PBS credential lane resolved the following incident. MEASURED: under the agent's approle,
22
21
  * `bao token capabilities` answers `deny` for `proxmox-c1/creds/{read,provision}`,
23
22
  * `proxmox-c2/creds/read` and every `…pbs…` path tried, and `sys/mounts` is 403 — so I could
24
23
  * not enumerate the mounts to PROVE a PBS one is absent. That it is absent is the brief's
@@ -27,7 +26,7 @@
27
26
  * <mount>/creds/<role>` answering `{"data":{"token_id":…,"secret":…}}`, where `token_id` is a
28
27
  * PBS token id `user@realm!tokenname` — `hf-read@pbs!…` and `hf-provision@pbs!…`. Same short,
29
28
  * non-renewable lease contract as `proxmox-c1`.
30
- * ⚠️ PBS HAS NO DYNAMIC-SECRETS PLUGIN OF ITS OWN — OpenBao's Proxmox support is a PVE thing — so
29
+ * ⚠️ PBS HAD NO DYNAMIC-SECRETS PLUGIN OF ITS OWN — OpenBao's Proxmox support is a PVE thing — so
31
30
  * the mount is a small custom vendor against `POST /access/users/{id}/token/{name}`. Say which
32
31
  * mount and role you needed rather than reaching for the read-only `metrics@pbs` token on
33
32
  * the kv shelf: widening that would delete the outer lock for every reader of the shelf.
@@ -50,23 +49,11 @@
50
49
  * a state store Alchemy writes UNENCRYPTED and this estate copies to a backup guest nightly.
51
50
  */
52
51
  import { Resource } from 'alchemy';
53
- import { isResolved } from 'alchemy/Diff';
54
52
  import * as Provider from 'alchemy/Provider';
55
53
  import * as Effect from 'effect/Effect';
56
- import { pve } from './client.ts';
57
- import {
58
- type PbsDatastoreAttributes,
59
- type PbsTarget,
60
- createForm,
61
- matches,
62
- object,
63
- readOne,
64
- updateForm,
65
- } from './pbs-datastore-form.ts';
66
- import { guardBackend, guardPath, settle } from './pbs-datastore-guard.ts';
67
- import { guardDatastoreForms } from './pbs-datastore-endpoint.ts';
54
+ import type { PbsDatastoreAttributes, PbsTarget } from './pbs-datastore-form.ts';
55
+ import { handlers } from './pbs-datastore-lifecycle.ts';
68
56
  import type { PveRequirements } from './resource.ts';
69
- import { formToSend } from './update-guard.ts';
70
57
 
71
58
  export type { PbsDatastoreAttributes, PbsTarget };
72
59
 
@@ -163,117 +150,4 @@ export const PbsDatastore = Resource<PbsDatastore>('Pbs.Datastore', {
163
150
  });
164
151
 
165
152
  export const PbsDatastoreProvider = () =>
166
- Provider.effect(
167
- PbsDatastore,
168
- Effect.succeed(
169
- PbsDatastore.Provider.of({
170
- /**
171
- * ⛔ EMPTY, AND HERE IT GUARDS THE ESTATE'S BACKUPS. `GET /config/datastore` returns every
172
- * datastore on the host, the one PVE's `type: pbs` storage writes into included. See
173
- * `pveHandlers` in resource.ts for why adoption stays an explicit act.
174
- */
175
- list: () => Effect.succeed([]),
176
- read: ({ olds }) => readOne(olds),
177
- /**
178
- * ⚠️ `isResolved` IS THE NARROWING, resource.ts's reason: at plan time a prop can still be an
179
- * unresolved Output, and comparing a placeholder to a live value reports a phantom update.
180
- * ⛔ `guardPath` IS A DELIBERATE DEPARTURE FROM storage.ts, which lets its create-only field
181
- * plan as noop. Dying fails `alchemy plan` with both paths named — see the ⛔ on the prop.
182
- */
183
- diff: ({ news, output }) =>
184
- Effect.gen(function* () {
185
- if (!isResolved(news)) return undefined;
186
- // ⛔ BEFORE the `output === undefined` return: that branch IS the create, which is the
187
- // one this family has never checked. resource.ts carries the argument in full.
188
- yield* guardDatastoreForms(news);
189
- if (output === undefined) return undefined;
190
- const live = yield* readOne(news);
191
- // ⚠️ `update`, not `create` — Alchemy's Diff admits only noop/update/replace, and an
192
- // object Alchemy has state for but PBS does not is drift for reconcile to repair.
193
- if (live === undefined) return { action: 'update' } as const;
194
- yield* guardPath(live, news);
195
- yield* guardBackend(live, news);
196
- return matches(live, news)
197
- ? ({ action: 'noop' } as const)
198
- : ({ action: 'update' } as const);
199
- }),
200
- /**
201
- * ⚠️ NOT THE FACTORY'S reconcile: it reads back ONCE, immediately — see the ⛔ on `settle`.
202
- * ⛔ `guardPath` RUNS HERE TOO, AND THAT IS NOT BELT-AND-BRACES — see the ⛔ on it.
203
- * ⛔ THE `matches` GUARD BEFORE THE PUT IS resource.ts's, AND IT IS WHY ADOPTION IS FREE.
204
- */
205
- reconcile: Effect.fn(function* ({ news }) {
206
- // ⚠️ Again here: an ADOPTED row's diff answer is discarded by Alchemy and reconcile runs.
207
- yield* guardDatastoreForms(news);
208
- const live = yield* readOne(news);
209
- let upid: string | undefined;
210
- if (live === undefined) {
211
- upid = yield* pve<string>(
212
- news.target,
213
- 'provision',
214
- 'POST',
215
- 'config/datastore',
216
- createForm(news),
217
- );
218
- } else {
219
- yield* guardPath(live, news);
220
- yield* guardBackend(live, news);
221
- // ⚠️ An empty form is not a write, and a match is not one either — update-guard.ts.
222
- const form = formToSend(matches, live, news, updateForm(news));
223
- if (form !== undefined) {
224
- yield* pve(news.target, 'provision', 'PUT', object(news), form);
225
- }
226
- }
227
- const after = yield* settle(
228
- readOne(news),
229
- (row) => row !== undefined && matches(row, news),
230
- );
231
- if (after === undefined || !matches(after, news)) {
232
- /**
233
- * ⛔ REFUSE RATHER THAN RETURN THE PROPS AS THOUGH THEY LANDED — resource.ts's rule.
234
- * A create answers with a task id, so "no error" is not evidence of a datastore.
235
- */
236
- return yield* Effect.die(
237
- new Error(
238
- `${object(news)}: the write returned no error but the datastore still does not ` +
239
- `match the declaration after 120s. PBS answered with task ${upid ?? '(none)'} ` +
240
- '-- read it with `proxmox-backup-manager task log <upid>`. A slow disk is a ' +
241
- 'plausible cause (see `settle`); a create over an existing chunk store is not, ' +
242
- 'because PBS refuses that outright rather than timing out.',
243
- ),
244
- );
245
- }
246
- return after;
247
- }),
248
- /**
249
- * ⛔ FULLY IMPLEMENTED, NEVER A STUB, and it only ever runs on an explicit
250
- * `.pipe(RemovalPolicy.destroy())` because this family defaults to `retain`.
251
- * ⛔ NO `destroy-data`. PBS's DELETE drops the section from `datastore.cfg` and leaves every
252
- * chunk and snapshot on disk; `destroy-data=1` erases the contents. It is not a prop and
253
- * not a flag here, so this provider can un-declare a datastore and can never erase one.
254
- * ⚠️ IT IS STILL A ONE-WAY DOOR FOR A DECLARATION: re-adding a datastore over an existing
255
- * chunk store needs `reuse-datastore`, which is deliberately not declarable — see the
256
- * ⚠️ on `createForm`. Re-adopt with `proxmox-backup-manager datastore create …`.
257
- * ⚠️ NO `keep-job-configs` EITHER, SO THE JOBS GO TOO: PBS defaults it false and removes the
258
- * verify, sync and prune jobs referencing this datastore — objects nothing here declares.
259
- * PBS's default stands, so the blast radius is what a human clicking Remove would get.
260
- * ⚠️ AND THE REFUSAL CAN ARRIVE AFTER THE RESPONSE: the delete forks a worker too, so a store
261
- * held open by a running backup can fail once the call has already returned 200.
262
- */
263
- delete: Effect.fn(function* ({ olds }) {
264
- yield* pve<string>(olds.target, 'provision', 'DELETE', object(olds));
265
- const left = yield* settle(readOne(olds), (row) => row === undefined);
266
- if (left !== undefined) {
267
- return yield* Effect.die(
268
- new Error(
269
- `${object(olds)}: the DELETE returned no error but the datastore is still in ` +
270
- 'datastore.cfg after 120s. Either a backup, verify or GC task still holds it, ' +
271
- 'or the provision role lacks Datastore.Allocate on /datastore/' +
272
- `${olds.name}. Read the task log with \`proxmox-backup-manager task log <upid>\`.`,
273
- ),
274
- );
275
- }
276
- }),
277
- }),
278
- ),
279
- );
153
+ Provider.effect(PbsDatastore, Effect.succeed(PbsDatastore.Provider.of(handlers)));
@@ -0,0 +1,40 @@
1
+ /** A readable PBS section does not make a refused DELETE successful. No live calls. */
2
+ import { expect, test } from 'bun:test';
3
+ import * as Effect from 'effect/Effect';
4
+ import { withFakeBao } from './fake-bao-env.ts';
5
+ import { PBS_JOBS_TARGET, fakePbsJobs } from './fake-pbs-jobs.ts';
6
+ import { deleteOne as deleteDatastore } from './pbs-datastore-wire.ts';
7
+ import { deleteOne as deletePrune } from './pbs-prune-job-wire.ts';
8
+ import { deleteOne as deleteSync } from './pbs-sync-job-wire.ts';
9
+ import { deleteOne as deleteVerify } from './pbs-verify-job-wire.ts';
10
+
11
+ test('all four PBS DELETE paths propagate a typed refusal after a successful pre-read', async () => {
12
+ const fake = fakePbsJobs();
13
+ const target = PBS_JOBS_TARGET;
14
+ fake.rows.set('config/datastore/store', { name: 'store', path: '/mnt/store' });
15
+ fake.rows.set('config/prune/prune', { id: 'prune', store: 'store', schedule: 'daily' });
16
+ fake.rows.set('config/sync/sync', { id: 'sync', store: 'store', 'remote-store': 'other' });
17
+ fake.rows.set('config/verify/verify', { id: 'verify', store: 'store' });
18
+ // ★ A permission refusal exercises propagation without inventing an absent-DELETE shape.
19
+ fake.failDelete(403, { message: 'permission denied' });
20
+ const deletions = [
21
+ deleteDatastore({ name: 'store', path: '/mnt/store', target }).pipe(Effect.asVoid),
22
+ deletePrune({ id: 'prune', store: 'store', schedule: 'daily', target }).pipe(Effect.asVoid),
23
+ deleteSync({ id: 'sync', store: 'store', 'remote-store': 'other', target }).pipe(Effect.asVoid),
24
+ deleteVerify({ id: 'verify', store: 'store', schedule: null, target }).pipe(Effect.asVoid),
25
+ ];
26
+ await withFakeBao('http://bao.invalid', async () => {
27
+ for (const deletion of deletions) {
28
+ const error = await Effect.runPromise(deletion.pipe(Effect.flip, Effect.provide(fake.layer)));
29
+ expect(error).toMatchObject({ _tag: 'Forbidden' });
30
+ }
31
+ });
32
+ expect(fake.calls.filter((call) => call.method === 'GET')).toHaveLength(4);
33
+ expect(fake.writes.map((write) => write.method)).toEqual([
34
+ 'DELETE',
35
+ 'DELETE',
36
+ 'DELETE',
37
+ 'DELETE',
38
+ ]);
39
+ expect(fake.rows.size).toBe(4);
40
+ });