@voltro/data-transfer 0.49.0 → 0.50.0

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 CHANGED
@@ -39,6 +39,64 @@ _Changes staged for the next release accumulate here (rolled up from
39
39
 
40
40
  ---
41
41
 
42
+ ## [0.50.0] — 2026-08-23
43
+
44
+ ### ⚠ BREAKING
45
+
46
+ - **@voltro/cli** — The read-only run-history endpoint moved:
47
+
48
+ GET /_voltro/admin/imports → GET /_voltro/admin/transfers
49
+
50
+ Same secret, same query parameters, same response shape. Only the path changed.
51
+
52
+ It answers for four directions now — import, export, native backup, native restore — and it named one of them. The subcommand and the table were renamed for exactly that reason in 0.49.0 and this path was left behind, which is worse than renaming none of them: a reader who follows a rename tries the matching path, gets a 404, and concludes the instance is too old.
53
+
54
+ `voltro data transfers --target api` uses the new path for you. What needs a hand is anything calling it directly — a monitoring check, an uptime probe, a curl in a runbook, a dashboard datasource. The codemod is `manual` and declares `reach: 'beyond-source'`, so it prints whether or not the path is found in your repository.
55
+ - **@voltro/database, @voltro/voltro** — `InterruptedReplace.tables` is `number | null`, and the interface gains `kind?: 'replace' | 'restore'`.
56
+
57
+ `_voltro_replace_in_progress` records two destructive operations now — an import's `--mode replace` and a native `voltro data restore`. A restore replaces the whole database from an artefact, so "how many tables was this going to empty and refill" has no answer: not known up front, not meaningful after.
58
+
59
+ Writing `0` would have preserved the type and been worse. That number is rendered into the boot refusal, which is read under pressure, and it would have said `began emptying 0 table(s)` — a measurement that was never taken. The framework's own text says "this database" instead; `Number(null)` is `0`, so coercing it reintroduces exactly the sentence being avoided.
60
+
61
+ `DataTransferRun.direction` also widens to name `'backup'` and `'restore'` explicitly. That one is documentary — the union already ended in `| string`, so no assignability changes.
62
+
63
+ **`voltro update` carries you across this** — codemod `0.50.0/03_interrupted-replace-tables-nullable`.
64
+
65
+ ### Added
66
+
67
+ - **@voltro/cli, @voltro/data-transfer, @voltro/database** — `voltro data backup --assets` and `voltro data restore --assets` now move the stored blobs alongside the vendor dump, through the same content-addressed phase the logical `export` / `import` path uses — streamed, deduped by sha256, verified on the way back, resumable per key.
68
+
69
+ `--assets` was accepted by `backup` and silently ignored, with the only signal a field in the closing JSON reading `NOT included`; `restore` did not accept it at all. A rows-only backup restores a database whose rows reference objects nothing puts back, and the reference and the object are checked at different times, so that state is discovered by a user rather than by the restore.
70
+
71
+ Three refusals, each for a belief that is otherwise acted on silently: `backup --assets` with no storage provider is refused rather than swallowed; `restore --assets` on a rows-only artefact is refused; a restore WITHOUT `--assets` over an artefact that has them warns and proceeds, because restoring rows without blobs is legitimate and refusing it would push people at `--force`.
72
+
73
+ The dump itself still has no resume — a vendor artefact is one opaque file with no offset to restart from, and the logical path is what exists for that.
74
+ - **@voltro/cli, @voltro/database, @voltro/data-transfer** — A native `backup` / `restore` now writes to the same `_voltro_data_transfers` record `import` and `export` use, so `voltro data transfers` answers "did last night's backup finish" from the instance that ran it. A native run reports blobs rather than rows — a vendor tool reports no row count we can trust, and printing `0 row(s)` over a dump that worked would be a wrong measurement.
75
+
76
+ `restore` also writes the `_voltro_replace_in_progress` marker before its first destructive statement and clears it after the last write, blobs included, so a killed restore refuses the next boot instead of serving a half-loaded database. `--allow-live` guards from the wrong side — it asks you not to — and this guards from the right one. The marker carries a `kind` so the refusal can say something different for a `replace` (re-import the capture) and a `restore` (finish the restore), and `tables` is nullable because a native restore has no table count to claim.
77
+
78
+ The sqlite / turso restore is atomic now (temp file + rename): its marker lives in the very file being replaced, so a plain in-place copy would leave a truncated database with nothing left to catch it.
79
+
80
+ A target with no `_voltro_data_transfers` table still gets its backup; the closing line says it was not recorded rather than implying it was.
81
+ - **@voltro/cli** — A re-issued migration note for the `voltro data imports` → `voltro data transfers` rename that shipped in 0.49.0.
82
+
83
+ Codemods are selected by `from < version <= to`, so the 0.49.0 note fires once, on the jump that crosses 0.49.0, and cannot be corrected for anyone already past it. Its gate searched `.ts` / `.tsx` while the command it is about lives in shell scripts, CI job definitions and runbooks — so a project whose only occurrence sat in `.gitlab-ci.yml` crossed 0.49.0 and was told there was nothing to apply.
84
+
85
+ The re-issue is filed under 0.50.0, prints unconditionally, and says what to grep for. Redundant for anyone already fixed; the alternative is firing for nobody.
86
+
87
+ ### Fixed
88
+
89
+ - **@voltro/cli** — A `manual` codemod's `appliesTo` can now search every text file the project owns — `.sh`, `.yml`, `.json`, `.md`, `Makefile`, the `.js` scripts — through a new `ctx.text` on the predicate context, and a codemod may declare `reach: 'beyond-source'` to print its note even when nothing matched.
90
+
91
+ Both halves close the same gap, and it was in the codemod most in need of a gate. A manual codemod exists BECAUSE its subject could not be transformed, which usually means it is not source at all — and `appliesTo` was reading the ts-morph project, which holds `.ts` / `.tsx` and nothing else. Measured with one identical CLI invocation in four files: the `.ts` one printed the note, the `.sh`, `.yml` and `.md` ones printed nothing, and the run reported `codemods: nothing to apply for this jump`. That is an acquittal from a check that never looked at the file, and an acquittal gets acted on.
92
+
93
+ `reach: 'beyond-source'` covers what no scan of one repository can reach — an inline script in a CI runner's own UI, a CronJob spec in another repo, a wiki runbook. The note prints either way; only its framing changes, and an uncertain one says plainly that we could not look there.
94
+ - **@voltro/data-transfer** — When `mariadb-dump` is absent and the mysql-family fallback runs Oracle's `mysqldump` against a MariaDB server, the failure now names the way out.
95
+
96
+ The stderr it prints is the child's own words and is the right first thing to show — and on its own it is a dead end: `Unknown table 'COLUMN_STATISTICS' in information_schema (1109)` names a table nobody asked for, in a schema nobody wrote, about a feature nobody enabled. Everything needed to act on it was known where the fallback was DECIDED: which binary we wanted, which one we took, and why the difference matters. That travels with the step now and prints under the stderr, including the counter-move a reader reaches for on their own (`--column-statistics=0` does not exist on `mariadb-dump`, so it fixes the wrong client and breaks the right one).
97
+
98
+ ---
99
+
42
100
  ## [0.49.0] — 2026-08-23
43
101
 
44
102
  ### ⚠ BREAKING
package/dist/index.d.ts CHANGED
@@ -76,6 +76,23 @@ export declare interface AssetInfo {
76
76
  readonly size: number;
77
77
  }
78
78
 
79
+ /**
80
+ * The resume journal, as this phase needs it.
81
+ *
82
+ * Deliberately two functions rather than the `Ledger` type: the native path
83
+ * keeps its own sidecar and the logical path keeps the shared one, and neither
84
+ * has any business knowing the other's file layout. What both must agree on is
85
+ * the SEMANTICS — `done` is keyed by the asset KEY (not its hash), because an
86
+ * asset is skippable when the destination already has that key, and the hash is
87
+ * not known until the bytes have been read, which is the cost being avoided.
88
+ */
89
+ export declare interface AssetProgress {
90
+ readonly done: (key: string) => boolean;
91
+ /** Record `key` as landed. Called AFTER the bytes are durable, never before —
92
+ * a ledger written first turns a crash into silent data loss on resume. */
93
+ readonly mark: (key: string, entry: AssetEntry) => Effect.Effect<void, BundleError>;
94
+ }
95
+
79
96
  export declare const ASSETS_DIR = "assets";
80
97
 
81
98
  /** Where import writes assets TO. */
@@ -149,6 +166,25 @@ export declare type CanonicalCategory = 'string' | 'integer' | 'float' | 'boolea
149
166
  * types (a bundle from a newer framework) fall back to 'string' passthrough. */
150
167
  export declare const canonicalType: (type: string) => CanonicalCategory;
151
168
 
169
+ /**
170
+ * Stream every asset the source enumerates into the content-addressed `assetsDir`.
171
+ *
172
+ * `assetsDir` must exist. Each asset is hashed while it streams (never buffered
173
+ * whole), written to a temp file and renamed to `assets/<sha256>` — so identical
174
+ * blobs dedupe, a concurrent reader never sees a half-written asset, and the
175
+ * hash IS the integrity check the restore verifies against.
176
+ */
177
+ export declare const captureAssetsToCas: (opts: {
178
+ readonly source: AssetSource;
179
+ readonly assetsDir: string;
180
+ readonly progress?: AssetProgress;
181
+ }) => Effect.Effect<CapturedAssets, BundleError>;
182
+
183
+ export declare interface CapturedAssets {
184
+ readonly count: number;
185
+ readonly totalBytes: number;
186
+ }
187
+
152
188
  /**
153
189
  * Lint a bundle's column types against a target dialect. Same-dialect import is
154
190
  * always clean (returns []). Otherwise returns every column whose type won't
@@ -1075,6 +1111,9 @@ export declare type NativeStep = {
1075
1111
  readonly env: Readonly<Record<string, string>>;
1076
1112
  readonly stdoutFile?: string;
1077
1113
  readonly stdinFile?: string;
1114
+ /** Something known at BUILD time that the failure could not otherwise
1115
+ * say — e.g. that this tool is a fallback for one that was absent. */
1116
+ readonly hint?: string;
1078
1117
  } | {
1079
1118
  readonly kind: 'copy';
1080
1119
  readonly from: string;
@@ -1089,6 +1128,19 @@ export declare class NativeToolError extends NativeToolError_base<{
1089
1128
  readonly tool: string;
1090
1129
  readonly reason: string;
1091
1130
  readonly stderr?: string;
1131
+ /**
1132
+ * What the CALLER knew and the child could not say.
1133
+ *
1134
+ * The stderr above is the tool's own words, which is the right first answer
1135
+ * and is sometimes a dead end on its own: `Unknown table 'COLUMN_STATISTICS'
1136
+ * in information_schema (1109)` names a table nobody asked for, in a schema
1137
+ * nobody wrote. The fact that turns it into an action — that we wanted
1138
+ * `mariadb-dump`, could not find it, and took Oracle's `mysqldump` instead —
1139
+ * is known where the step is BUILT and nowhere else. So it travels with the
1140
+ * step (`NativeStep.hint`) and is printed under the child's words, never
1141
+ * instead of them.
1142
+ */
1143
+ readonly hint?: string;
1092
1144
  }> {
1093
1145
  /**
1094
1146
  * The child's own words, not ours.
@@ -1117,6 +1169,11 @@ declare const NativeToolError_base: new <A extends Record<string, any> = {}>(arg
1117
1169
  * rather than a bare SyntaxError. */
1118
1170
  export declare const ndjsonToRows: <E, R>(bytes: Stream.Stream<Uint8Array, E, R>, table: string, columnTypes: ColumnTypes) => Stream.Stream<Row, E | CodecError, R>;
1119
1171
 
1172
+ /** A progress journal that remembers nothing — every asset is transferred. Used
1173
+ * where there is no sidecar to keep, and named so a caller passing it is
1174
+ * saying "no resume" rather than passing `undefined` and hoping. */
1175
+ export declare const noAssetProgress: AssetProgress;
1176
+
1120
1177
  export declare type OnConflict = 'skip' | 'fail';
1121
1178
 
1122
1179
  /** The caller's progress sink. Plain sync fn — never fails the job. */
@@ -1232,6 +1289,9 @@ export declare interface ProgressEvent {
1232
1289
  /** Which pipeline the event belongs to. */
1233
1290
  export declare type ProgressPhase = 'export' | 'import';
1234
1291
 
1292
+ /** Read a CAS index file (NDJSON, one {@link AssetEntry} per line) as a stream. */
1293
+ export declare const readAssetIndex: (indexPath: string) => Stream.Stream<AssetEntry, BundleError>;
1294
+
1235
1295
  /** Read the ledger at `path`, or an empty one when it is absent / unreadable
1236
1296
  * (a missing ledger just means "nothing done yet" — never a hard failure). */
1237
1297
  export declare const readLedger: (path: string) => Effect.Effect<Ledger>;
@@ -1270,6 +1330,20 @@ export declare const restoreAssetFromCas: (sink: AssetSink, assetsDir: string, e
1270
1330
  readonly contentType: string;
1271
1331
  }) => Effect.Effect<void, BundleError | IntegrityError | StorageError>;
1272
1332
 
1333
+ /**
1334
+ * Push every asset named in the index back to the sink, re-hashing on the way.
1335
+ *
1336
+ * A hash mismatch is an {@link IntegrityError} and stops the phase — a corrupted
1337
+ * artefact must never silently re-upload bad bytes over good ones, which is the
1338
+ * one failure a restore has no way to notice afterwards.
1339
+ */
1340
+ export declare const restoreAssetsFromCas: (opts: {
1341
+ readonly sink: AssetSink;
1342
+ readonly assetsDir: string;
1343
+ readonly indexPath: string;
1344
+ readonly progress?: AssetProgress;
1345
+ }) => Effect.Effect<number, BundleError | IntegrityError | StorageError>;
1346
+
1273
1347
  /** Build the restore step for a dialect reading `inFile`. */
1274
1348
  export declare const restoreCommand: (dialect: string, conn: NativeConn, inFile: string) => NativeStep;
1275
1349