@needmoretruth/nmts-cli 0.38.0 → 0.39.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.
@@ -0,0 +1,119 @@
1
+ // Moving things into a folder, and giving one thing a new name where it is.
2
+ import { buildIndex, entryAt, folderIdFor, fullPathOf, namesIn, normaliseName, } from "../drive-paths.js";
3
+ import { readFileList } from "../manifest.js";
4
+ import { applyManyToList, applyToList, batchTargets } from "../manifest-write.js";
5
+ import { applyIntent } from "../shared/lib/drive/manifest-ops.js";
6
+ import { DriveEditError, requireNewName, resolving } from "./errors.js";
7
+ import { isUnder } from "./tree.js";
8
+ /**
9
+ * Move things into a folder. An empty destination is the top of the drive.
10
+ *
11
+ * ⛔ ONE WRITE FOR THE WHOLE RUN, however many things are named. The list is rewritten whole on
12
+ * every save, so a second thing costs nothing extra — while a second WRITE is a second chance
13
+ * to lose the compare-and-swap, and losing it half way through a run leaves some things moved
14
+ * and some not, which is a state the caller cannot tell apart from the one it asked for.
15
+ *
16
+ * ⛔ AND THE NAME CHECK RUNS AGAINST WHAT THIS RUN HAS ALREADY MOVED, not against the list as it
17
+ * was read. Two files called `notes.txt` in two folders, moved into one folder by one call,
18
+ * would otherwise both be written — two entries at one path, which nothing can address
19
+ * afterwards: every lookup answers "names 2 things in this account". So the loop folds each
20
+ * move onto a working copy and asks the working copy the next question.
21
+ */
22
+ export async function moveEntries(input, paths, destination) {
23
+ const at = Date.now();
24
+ let moved = [];
25
+ let already = [];
26
+ let parentId = null;
27
+ // ⛔ EVERY GUARD RUNS INSIDE THE ATTEMPT, INCLUDING WHICH ENTRY EACH PATH NAMES. A lost
28
+ // compare-and-swap re-applies the intent to a list that changed underneath — and when the
29
+ // winner had just taken this name, the loser landed on top of it and produced two entries at
30
+ // one path. Meanwhile the caller was told the move had been made.
31
+ const result = await applyManyToList(input, (now) => {
32
+ const targets = resolving(() => batchTargets(now, paths, { nothingHappened: "Nothing was moved." }));
33
+ const into = resolving(() => folderIdFor(destination, now, "Nothing was moved."));
34
+ const index = buildIndex(now);
35
+ const intents = [];
36
+ const carried = [];
37
+ const there = [];
38
+ let working = now;
39
+ for (const target of targets) {
40
+ if (into !== null && (into === target.id || isUnder(working, into, target.id))) {
41
+ throw new DriveEditError("INTO_ITSELF", `A folder cannot be moved inside itself.`, {
42
+ exitCode: 4,
43
+ nextStep: "Nothing was moved.",
44
+ });
45
+ }
46
+ if (into === target.parentId) {
47
+ there.push(target.name);
48
+ continue;
49
+ }
50
+ if (namesIn(working, into).has(normaliseName(target.name))) {
51
+ throw new DriveEditError("NAME_TAKEN", `Something called "${target.name}" is already in that folder.`, {
52
+ exitCode: 4,
53
+ nextStep: `Nothing was moved. Rename it first: nmts rename "${target.name}" <new name>`,
54
+ });
55
+ }
56
+ const intent = { op: "move", id: target.id, parentId: into, at };
57
+ intents.push(intent);
58
+ working = applyIntent(working, intent);
59
+ carried.push({ id: target.id, name: target.name, from: fullPathOf(index, target) });
60
+ }
61
+ moved = carried;
62
+ already = there;
63
+ parentId = into;
64
+ return intents;
65
+ });
66
+ // ⚠ Read off the list AS WRITTEN, not off the intents: an id another device took out of the list
67
+ // meanwhile has no path any more, and claiming one would name a place nothing is at.
68
+ const after = buildIndex(result.entries);
69
+ return {
70
+ moved: moved.map((m) => {
71
+ const live = result.entries.find((e) => e.id === m.id);
72
+ return { id: m.id, name: m.name, from: m.from, path: live === undefined ? null : fullPathOf(after, live) };
73
+ }),
74
+ already,
75
+ parentId,
76
+ changed: result.changed,
77
+ reappliedAfterConflict: result.reappliedAfterConflict,
78
+ seq: result.seq,
79
+ };
80
+ }
81
+ /**
82
+ * Give one thing a new name. The path stays the same otherwise.
83
+ *
84
+ * ⛔ REFUSED RATHER THAN NUMBERED, AND THE REFUSAL IS RE-DECIDED ON EVERY ATTEMPT. An upload picks
85
+ * `report (2).pdf` because nobody was watching; a rename is somebody choosing a name on purpose,
86
+ * and silently giving them a different one is how two files end up looking like a mistake nobody
87
+ * made. Checking once, before the write, was not enough: when another device took the name in
88
+ * between, the retry re-applied the old decision and produced two entries at one path, which
89
+ * nothing can address afterwards (2026-08-23).
90
+ */
91
+ export async function renameEntry(input, path, name) {
92
+ requireNewName(name);
93
+ const list = await readFileList(input.server, input.apiKey, input.code, input.accountId);
94
+ const entries = list.manifest?.entries ?? [];
95
+ const target = resolving(() => entryAt(entries, path, { nothingHappened: "Nothing was renamed." }));
96
+ const at = Date.now();
97
+ const fromPath = fullPathOf(buildIndex(entries), target);
98
+ const result = await applyToList(input, (now) => {
99
+ const live = now.find((e) => e.id === target.id);
100
+ if (live === undefined)
101
+ return null;
102
+ if (normaliseName(name) !== normaliseName(live.name) && namesIn(now, live.parentId).has(normaliseName(name))) {
103
+ throw new DriveEditError("NAME_TAKEN", `Something called "${name}" is already in that folder.`, {
104
+ exitCode: 4,
105
+ nextStep: "Nothing was renamed.",
106
+ });
107
+ }
108
+ return { op: "rename", id: target.id, name, at };
109
+ });
110
+ return {
111
+ id: target.id,
112
+ from: target.name,
113
+ fromPath,
114
+ to: name,
115
+ changed: result.changed,
116
+ reappliedAfterConflict: result.reappliedAfterConflict,
117
+ seq: result.seq,
118
+ };
119
+ }
@@ -0,0 +1,53 @@
1
+ import { type ListEditInput } from "../manifest-write.ts";
2
+ /**
3
+ * What one run of the trash did — and, in this order, exactly what `nmts rm --json` prints.
4
+ *
5
+ * ⛔ THE ORDER OF THESE FIELDS IS THE COMMAND'S JSON. The command hands this object straight to
6
+ * `JSON.stringify`, so a field added in the middle changes what an agent reading that output
7
+ * sees. Add at the end, or not at all.
8
+ */
9
+ export interface TrashOutcome {
10
+ /** The paths acted on. Empty when everything named was already where it was asked to be. */
11
+ paths: string[];
12
+ /** Their ids, in the same order. */
13
+ ids: string[];
14
+ /** How many server rows were moved. A folder has none of its own; its files have one each. */
15
+ files: number;
16
+ /** Named, and nothing written for them: already out of the trash, or covered by a named folder. */
17
+ skipped: string[];
18
+ changed: boolean;
19
+ reappliedAfterConflict: boolean;
20
+ seq: number;
21
+ }
22
+ export interface TrashEditOptions {
23
+ /**
24
+ * Refuse what the command-line tool names and carries on with.
25
+ *
26
+ * ⛔ OFF FOR THE COMMANDS AND ON FOR A LIBRARY, and the difference is who is reading. A person
27
+ * who typed `nmts restore a.txt b.txt` and had already restored `a.txt` wants `b.txt` back and
28
+ * a line saying the first was not in the trash; a program calling `restore` wants to know that
29
+ * what it asked for was not what it got, and the only way it learns that is a refusal.
30
+ *
31
+ * It adds two: a path that is not in the trash (`NOT_IN_TRASH`) and a restore whose old name has
32
+ * been taken since (`NAME_TAKEN`).
33
+ */
34
+ strict?: boolean;
35
+ }
36
+ /**
37
+ * Move things to the trash, or bring them back.
38
+ *
39
+ * ⛔ NEITHER HALF DESTROYS ANYTHING. `rm` moves everything it is given to the trash, where it stays
40
+ * restorable for thirty days; the endpoint that erases a stored row for good is closed to an API
41
+ * key and stays closed, so nothing here can reach it.
42
+ *
43
+ * ⛔ THE SERVER ROW GOES FIRST, AND "ALREADY DONE" COUNTS AS DONE. A trashed item's bytes cannot be
44
+ * fetched, so the state to avoid above all others is a list that shows a file as live when the
45
+ * server has already trashed it: the person sees it, asks for it, and is told it does not exist.
46
+ * Writing the list only after the server agreed means a failed server call leaves the drive
47
+ * exactly as it was — the state a caller can act on.
48
+ *
49
+ * ⛔ AND ONE PATH THAT WILL NOT RESOLVE REFUSES THE WHOLE RUN, before a single server row is
50
+ * touched. Trashing four of the five things somebody named and answering success is worse than
51
+ * trashing none: the run reads as done, and finding the odd one out means diffing the drive.
52
+ */
53
+ export declare function trashPaths(input: ListEditInput, verb: "rm" | "restore", paths: readonly string[], options?: TrashEditOptions): Promise<TrashOutcome>;
@@ -0,0 +1,190 @@
1
+ // The two halves of the trash: moving things into it, and bringing them back.
2
+ import { buildIndex, fullPathOf, isLive, normaliseName } from "../drive-paths.js";
3
+ import { NmtsError } from "../errors.js";
4
+ import { setTrashed } from "../item-trash.js";
5
+ import { readFileList } from "../manifest.js";
6
+ import { applyManyToList, batchTargets } from "../manifest-write.js";
7
+ import { applyIntent } from "../shared/lib/drive/manifest-ops.js";
8
+ import { DriveEditError, resolving } from "./errors.js";
9
+ import { filesUnder, hasNamedAncestor, uniqueById } from "./tree.js";
10
+ /**
11
+ * Move things to the trash, or bring them back.
12
+ *
13
+ * ⛔ NEITHER HALF DESTROYS ANYTHING. `rm` moves everything it is given to the trash, where it stays
14
+ * restorable for thirty days; the endpoint that erases a stored row for good is closed to an API
15
+ * key and stays closed, so nothing here can reach it.
16
+ *
17
+ * ⛔ THE SERVER ROW GOES FIRST, AND "ALREADY DONE" COUNTS AS DONE. A trashed item's bytes cannot be
18
+ * fetched, so the state to avoid above all others is a list that shows a file as live when the
19
+ * server has already trashed it: the person sees it, asks for it, and is told it does not exist.
20
+ * Writing the list only after the server agreed means a failed server call leaves the drive
21
+ * exactly as it was — the state a caller can act on.
22
+ *
23
+ * ⛔ AND ONE PATH THAT WILL NOT RESOLVE REFUSES THE WHOLE RUN, before a single server row is
24
+ * touched. Trashing four of the five things somebody named and answering success is worse than
25
+ * trashing none: the run reads as done, and finding the odd one out means diffing the drive.
26
+ */
27
+ export async function trashPaths(input, verb, paths, options = {}) {
28
+ const list = await readFileList(input.server, input.apiKey, input.code, input.accountId);
29
+ const entries = list.manifest?.entries ?? [];
30
+ // ⛔ `rm` REFUSES what is already in the trash rather than quietly doing nothing, so the caller
31
+ // learns nothing was needed; `restore` has to be able to SEE the trash to act on it. That is
32
+ // why the two lookups differ.
33
+ const index = buildIndex(entries);
34
+ const found = resolving(() => batchTargets(entries, paths, {
35
+ ...(verb === "restore" ? { includeTrashed: true } : {}),
36
+ nothingHappened: "Nothing changed.",
37
+ }));
38
+ const acting = [];
39
+ const skipped = [];
40
+ for (const entry of found) {
41
+ const at = fullPathOf(index, entry);
42
+ if (verb === "restore" && isLive(index, entry)) {
43
+ // Already in the state being asked for. Named, and left alone — unless the caller is a
44
+ // program, which cannot read a line about it.
45
+ if (options.strict === true) {
46
+ throw new DriveEditError("NOT_IN_TRASH", `"${at}" is not in the trash.`, {
47
+ exitCode: 4,
48
+ nextStep: "Nothing changed. Only something in the trash can be restored.",
49
+ });
50
+ }
51
+ skipped.push(at);
52
+ continue;
53
+ }
54
+ if (verb === "restore" && entry.deletedAt === undefined) {
55
+ // In the trash, but only because something above it is. Restoring this row would clear a
56
+ // `deletedAt` it does not have and leave the person exactly where they were.
57
+ throw new DriveEditError("NOT_IN_TRASH", `"${at}" is in the trash because a folder above it is.`, {
58
+ exitCode: 4,
59
+ nextStep: `Nothing changed. Restore that folder instead — \`nmts ls --all\` shows which one carries the trash.`,
60
+ });
61
+ }
62
+ acting.push({ entry, path: at });
63
+ }
64
+ // ⛔ NAMING A FOLDER AND SOMETHING INSIDE IT IS NAMING ONE TRASHING TWICE, and only for `rm` is
65
+ // that a problem worth solving here: stamping the child as well would give it a thirty-day
66
+ // clock of its own, and then restoring the folder would leave it behind — the person would
67
+ // have to remember they had also named it to ever find it again. Its bytes are covered either
68
+ // way, because the rows are read from the folder. `restore` is the opposite case: a child with
69
+ // its own instant needs its own clearing, so nothing is dropped there.
70
+ const named = new Set(acting.map((t) => t.entry.id));
71
+ const covered = verb === "rm" ? acting.filter((t) => hasNamedAncestor(entries, t.entry, named)) : [];
72
+ const targets = acting.filter((t) => !covered.includes(t));
73
+ for (const t of covered)
74
+ skipped.push(t.path);
75
+ if (targets.length === 0) {
76
+ // Everything named was already where it was asked to be. A no-op is a success: writing the
77
+ // list would cost every other device a download for nothing.
78
+ return { paths: [], ids: [], files: 0, skipped, changed: false, reappliedAfterConflict: false, seq: list.seq ?? 0 };
79
+ }
80
+ // Every FILE at or under the targets — a folder holds no bytes and has no server row, so the
81
+ // rows to move are its file descendants.
82
+ //
83
+ // ⛔ THE ROWS TO MOVE ARE THE ONES THE EDIT WILL MAKE REACHABLE, so the set is read off a PREVIEW
84
+ // of the list rather than guessed (2026-08-23). `rm` is easy — everything under the target
85
+ // loses its bytes. `restore` is not: a file the person deleted separately last week keeps its
86
+ // own `deletedAt`, stays in the trash after the folder comes back, and its row must stay
87
+ // deleted with it. Restoring that row would cancel its own thirty-day sweep, go on costing
88
+ // storage, and leave the list saying "trashed" while the server says "live" — after which
89
+ // `rm` refuses to put it back and there is no way out.
90
+ const at = Date.now();
91
+ const ids = targets.map((t) => t.entry.id);
92
+ const preview = buildIndex(applyIntent(entries, intentFor(verb, ids, at)));
93
+ const under = uniqueById(targets.flatMap((t) => filesUnder(entries, t.entry.id)));
94
+ // ⚠ Judged on the PREVIEW's own row, not on the one in hand: `applyIntent` returns new objects,
95
+ // so asking the preview about the old object reads the old `deletedAt` and answers "still
96
+ // trashed" for the very thing being restored.
97
+ const files = verb === "rm"
98
+ ? under
99
+ : under.filter((f) => {
100
+ const after = preview.byId.get(f.id);
101
+ return after !== undefined && isLive(preview, after);
102
+ });
103
+ let done = 0;
104
+ try {
105
+ for (const file of files) {
106
+ await setTrashed(input.server, input.apiKey, file.id, verb === "rm");
107
+ done += 1;
108
+ }
109
+ }
110
+ catch (error) {
111
+ // ⛔ A HALF-FINISHED RUN MUST NAME ITSELF. Without this an agent sees six words of stderr and
112
+ // the tool's own guidance ("a refusal is not a transient error, do not retry in a loop")
113
+ // steers it away from the one thing that fixes this — running the same command again.
114
+ const because = error instanceof Error ? error.message : "the server refused";
115
+ throw new NmtsError(because, {
116
+ exitCode: 1,
117
+ nextStep: `${done} of ${files.length} file rows were moved before this stopped, and the file list was ` +
118
+ `not written. Running \`nmts ${verb}\` on the same paths again finishes the job — nothing is lost.`,
119
+ });
120
+ }
121
+ // ⛔ THE IDS ARE DECIDED AGAIN ON EVERY ATTEMPT, and this is not ceremony. Between the read above
122
+ // and the write below another device can put one of these targets in the trash — by trashing
123
+ // it, or by moving it under a folder that already is. Re-applying the intent we built earlier
124
+ // would then stamp `deletedAt` on something that is ALREADY in the trash by inheritance,
125
+ // giving it a clock of its own and quietly detaching it from the folder it came with:
126
+ // restoring that folder afterwards would leave it behind. An id that has left the list
127
+ // entirely is dropped for the reason `manifest-ops.ts` gives — the other device removing it is
128
+ // newer information than our edit, and putting it back would undo a deletion somebody made on
129
+ // purpose.
130
+ const writing = applyManyToList(input, (now) => {
131
+ const nowIndex = buildIndex(now);
132
+ const still = ids.filter((id) => {
133
+ const live = nowIndex.byId.get(id);
134
+ if (live === undefined)
135
+ return false;
136
+ return verb === "rm" ? isLive(nowIndex, live) : live.deletedAt !== undefined;
137
+ });
138
+ if (verb === "restore" && options.strict === true)
139
+ refuseTakenNames(now, nowIndex.byId, still);
140
+ return still.length === 0 ? [] : [intentFor(verb, still, at)];
141
+ });
142
+ // ⛔ A STRICT RESTORE REFUSED HERE HAS ALREADY MOVED ITS ROWS. The name was free when the trash
143
+ // was read and taken by the time the list was written, so the rows above are live while the
144
+ // list still says trashed — the state the note on `files` calls no way out. Put the rows back
145
+ // before the refusal leaves. If putting them back fails too, the refusal still leaves as it
146
+ // is: restoring again after the rename moves the same rows and writes the list.
147
+ const result = await writing.catch(async (error) => {
148
+ if (verb === "restore" && error instanceof DriveEditError && error.code === "NAME_TAKEN") {
149
+ for (const file of files) {
150
+ await setTrashed(input.server, input.apiKey, file.id, true).catch(() => undefined);
151
+ }
152
+ }
153
+ throw error;
154
+ });
155
+ return {
156
+ paths: targets.map((t) => t.path),
157
+ ids,
158
+ files: files.length,
159
+ skipped,
160
+ changed: result.changed,
161
+ reappliedAfterConflict: result.reappliedAfterConflict,
162
+ seq: result.seq,
163
+ };
164
+ }
165
+ /**
166
+ * Refuse a restore that would land beside a live thing of the same name.
167
+ *
168
+ * ⛔ DECIDED INSIDE THE ATTEMPT like every other guard here: the name that was free when the trash
169
+ * was read can be taken by the time the list is written, and two entries at one path is a state
170
+ * no lookup can get out of.
171
+ */
172
+ function refuseTakenNames(entries, byId, ids) {
173
+ const index = buildIndex(entries);
174
+ for (const id of ids) {
175
+ const entry = byId.get(id);
176
+ if (entry === undefined)
177
+ continue;
178
+ const holder = entries.find((e) => e.id !== id && e.parentId === entry.parentId && normaliseName(e.name) === normaliseName(entry.name) && isLive(index, e));
179
+ if (holder === undefined)
180
+ continue;
181
+ throw new DriveEditError("NAME_TAKEN", `Something called "${entry.name}" is already in that folder.`, {
182
+ exitCode: 4,
183
+ nextStep: "The file list was not changed. Rename the one that is there, then restore again.",
184
+ });
185
+ }
186
+ }
187
+ /** The one intent either half of the trash writes. Built in two places, so it is spelled in one. */
188
+ function intentFor(verb, ids, at) {
189
+ return verb === "rm" ? { op: "trash", ids, at } : { op: "restore", ids, at };
190
+ }
@@ -0,0 +1,15 @@
1
+ import type { ManifestEntry } from "../shared/lib/drive/manifest-codec.ts";
2
+ /** Is `id` at or under `rootId`? Used to refuse moving a folder into its own subtree. */
3
+ export declare function isUnder(entries: readonly ManifestEntry[], id: string | null, rootId: string): boolean;
4
+ /** Is any ancestor of this entry in the set? Used to drop a target a named folder already covers. */
5
+ export declare function hasNamedAncestor(entries: readonly ManifestEntry[], entry: ManifestEntry, named: ReadonlySet<string>): boolean;
6
+ /** One entry per id, keeping the first. Two named folders can hold the same file only once. */
7
+ export declare function uniqueById(files: readonly ManifestEntry[]): ManifestEntry[];
8
+ /**
9
+ * Every file at or under one entry.
10
+ *
11
+ * ⚠ Trashed descendants are INCLUDED HERE, and the CALLER filters. Somebody who trashed one file
12
+ * last week and then trashes its folder expects the folder to be gone from the server too — so
13
+ * `rm` takes this set whole. `restore` cannot: see the note at the call site.
14
+ */
15
+ export declare function filesUnder(entries: readonly ManifestEntry[], rootId: string): ManifestEntry[];
@@ -0,0 +1,77 @@
1
+ // Walking the list: the three questions the edits below ask about where an entry sits, and the one
2
+ // that gathers the files a folder carries.
3
+ import { buildIndex, KIND_FILE } from "../drive-paths.js";
4
+ /** Is `id` at or under `rootId`? Used to refuse moving a folder into its own subtree. */
5
+ export function isUnder(entries, id, rootId) {
6
+ const byId = buildIndex(entries).byId;
7
+ const seen = new Set();
8
+ let at = id;
9
+ while (at !== null && !seen.has(at)) {
10
+ if (at === rootId)
11
+ return true;
12
+ seen.add(at);
13
+ at = byId.get(at)?.parentId ?? null;
14
+ }
15
+ return false;
16
+ }
17
+ /** Is any ancestor of this entry in the set? Used to drop a target a named folder already covers. */
18
+ export function hasNamedAncestor(entries, entry, named) {
19
+ const byId = buildIndex(entries).byId;
20
+ const seen = new Set([entry.id]);
21
+ let at = entry.parentId;
22
+ while (at !== null && !seen.has(at)) {
23
+ if (named.has(at))
24
+ return true;
25
+ seen.add(at);
26
+ at = byId.get(at)?.parentId ?? null;
27
+ }
28
+ return false;
29
+ }
30
+ /** One entry per id, keeping the first. Two named folders can hold the same file only once. */
31
+ export function uniqueById(files) {
32
+ const byId = new Map();
33
+ for (const file of files)
34
+ if (!byId.has(file.id))
35
+ byId.set(file.id, file);
36
+ return [...byId.values()];
37
+ }
38
+ /**
39
+ * Every file at or under one entry.
40
+ *
41
+ * ⚠ Trashed descendants are INCLUDED HERE, and the CALLER filters. Somebody who trashed one file
42
+ * last week and then trashes its folder expects the folder to be gone from the server too — so
43
+ * `rm` takes this set whole. `restore` cannot: see the note at the call site.
44
+ */
45
+ export function filesUnder(entries, rootId) {
46
+ const root = entries.find((e) => e.id === rootId);
47
+ if (root === undefined)
48
+ return [];
49
+ if (root.kind === KIND_FILE)
50
+ return [root];
51
+ const childrenOf = new Map();
52
+ for (const e of entries) {
53
+ const list = childrenOf.get(e.parentId);
54
+ if (list === undefined)
55
+ childrenOf.set(e.parentId, [e]);
56
+ else
57
+ list.push(e);
58
+ }
59
+ const out = [];
60
+ const seen = new Set([rootId]);
61
+ const queue = [rootId];
62
+ while (queue.length > 0) {
63
+ const id = queue.pop();
64
+ if (id === undefined)
65
+ break;
66
+ for (const child of childrenOf.get(id) ?? []) {
67
+ if (seen.has(child.id))
68
+ continue;
69
+ seen.add(child.id);
70
+ if (child.kind === KIND_FILE)
71
+ out.push(child);
72
+ else
73
+ queue.push(child.id);
74
+ }
75
+ }
76
+ return out;
77
+ }
@@ -1,189 +1,9 @@
1
- import { NmtsError } from "./errors.ts";
2
- import { type ListEditInput } from "./manifest-write.ts";
3
- import type { ManifestEntry } from "./shared/lib/drive/manifest-codec.ts";
4
- /**
5
- * What went wrong, in a word a program can branch on.
6
- *
7
- * FIVE, AND THEY ARE ABOUT THE LIST. A server refusal arrives as `ServerError` with the server's
8
- * own code, and a lost compare-and-swap that never settles arrives as a plain `NmtsError`;
9
- * neither is a decision this file made.
10
- */
11
- export type DriveEditCode =
12
- /** No entry at that path — or a path that names two, which is the same "which one?" */
13
- "NOT_FOUND"
14
- /** Something else in that folder already answers to that name. */
15
- | "NAME_TAKEN"
16
- /** The name itself cannot be used: empty, `.`, `..`, or a path pretending to be a name. */
17
- | "BAD_NAME"
18
- /** A restore was asked for something that is not in the trash, or not in it on its own account. */
19
- | "NOT_IN_TRASH"
20
- /** A folder was asked to move inside itself. */
21
- | "INTO_ITSELF";
22
- /** A refusal about the list, with the sentence a person reads and the word a program reads. */
23
- export declare class DriveEditError extends NmtsError {
24
- readonly code: DriveEditCode;
25
- constructor(code: DriveEditCode, message: string, options?: {
26
- exitCode?: number;
27
- nextStep?: string | null;
28
- });
29
- }
30
- /**
31
- * A new name is a name and not a path.
32
- *
33
- * ⛔ REFUSED RATHER THAN SPLIT. A name with a `/` in it is somebody asking for a move while typing
34
- * a rename, and quietly doing the move would put the file somewhere they did not look.
35
- */
36
- export declare function requireNewName(name: string): string;
37
- /**
38
- * Make a folder path, and every folder above it that is missing, for an account already opened.
39
- *
40
- * ⛔ THE RULES BELOW ARE THE ONES A SECOND COPY WOULD GET SUBTLY WRONG: a folder that is already
41
- * there IS the folder asked for (never a numbered one), the decision is taken inside each
42
- * attempt so a lost race cannot make two, and what was made before a failure is named rather
43
- * than silently kept.
44
- *
45
- * ⚠ MISSING PARENTS ARE CREATED, and that is a decision rather than a convenience. A folder costs
46
- * nothing, holds nothing and can be moved to the trash, so the failure mode of creating one too
47
- * many is a tidy-up; the failure mode of refusing is a caller that has to discover the tree one
48
- * call at a time. Every folder made is named in the result, so it is never a surprise.
49
- */
50
- export declare function ensureFolderPath(input: ListEditInput, wanted: string): Promise<{
51
- parentId: string | null;
52
- made: string[];
53
- }>;
54
- /** What making a folder did. `made` is empty when every folder in the path was already there. */
55
- export interface MadeFolder {
56
- /** The path as the drive spells it — no leading slash, no trailing one. */
57
- path: string;
58
- /** The folder at the end of the path. Null only for the top of the drive, which is never made. */
59
- parentId: string | null;
60
- /** The folders this call actually made, outermost first. */
61
- made: string[];
62
- }
63
- /** Make one folder path. A path that is already there is a success with nothing made. */
64
- export declare function makeFolder(input: ListEditInput, path: string): Promise<MadeFolder>;
65
- /** One thing a move carried, with where it came from and where it landed. */
66
- export interface MovedThing {
67
- id: string;
68
- /** Its name, which a move never changes. */
69
- name: string;
70
- /** Its full path before the move. */
71
- from: string;
72
- /** Its full path after, or null if another device took it out of the list meanwhile. */
73
- path: string | null;
74
- }
75
- /** What one run of moving did. */
76
- export interface MoveOutcome {
77
- /** The things this run moved, in the order they were named. */
78
- moved: MovedThing[];
79
- /** The names that were already in the destination, so nothing was written for them. */
80
- already: string[];
81
- /** The destination folder id, or null for the top of the drive. */
82
- parentId: string | null;
83
- /** False when everything named was already there, so no list was written. */
84
- changed: boolean;
85
- /** True when the list was rebuilt because another device wrote first. */
86
- reappliedAfterConflict: boolean;
87
- /** The list version now current. */
88
- seq: number;
89
- }
90
- /**
91
- * Move things into a folder. An empty destination is the top of the drive.
92
- *
93
- * ⛔ ONE WRITE FOR THE WHOLE RUN, however many things are named. The list is rewritten whole on
94
- * every save, so a second thing costs nothing extra — while a second WRITE is a second chance
95
- * to lose the compare-and-swap, and losing it half way through a run leaves some things moved
96
- * and some not, which is a state the caller cannot tell apart from the one it asked for.
97
- *
98
- * ⛔ AND THE NAME CHECK RUNS AGAINST WHAT THIS RUN HAS ALREADY MOVED, not against the list as it
99
- * was read. Two files called `notes.txt` in two folders, moved into one folder by one call,
100
- * would otherwise both be written — two entries at one path, which nothing can address
101
- * afterwards: every lookup answers "names 2 things in this account". So the loop folds each
102
- * move onto a working copy and asks the working copy the next question.
103
- */
104
- export declare function moveEntries(input: ListEditInput, paths: readonly string[], destination: string): Promise<MoveOutcome>;
105
- /** What renaming one thing did. */
106
- export interface RenameOutcome {
107
- id: string;
108
- /** The name it had. */
109
- from: string;
110
- /** The full path it had, which is what a person recognises it by. */
111
- fromPath: string;
112
- /** The name it has now. */
113
- to: string;
114
- /** False when it was already called that, so no list was written. */
115
- changed: boolean;
116
- reappliedAfterConflict: boolean;
117
- seq: number;
118
- }
119
- /**
120
- * Give one thing a new name. The path stays the same otherwise.
121
- *
122
- * ⛔ REFUSED RATHER THAN NUMBERED, AND THE REFUSAL IS RE-DECIDED ON EVERY ATTEMPT. An upload picks
123
- * `report (2).pdf` because nobody was watching; a rename is somebody choosing a name on purpose,
124
- * and silently giving them a different one is how two files end up looking like a mistake nobody
125
- * made. Checking once, before the write, was not enough: when another device took the name in
126
- * between, the retry re-applied the old decision and produced two entries at one path, which
127
- * nothing can address afterwards (2026-08-23).
128
- */
129
- export declare function renameEntry(input: ListEditInput, path: string, name: string): Promise<RenameOutcome>;
130
- /**
131
- * What one run of the trash did — and, in this order, exactly what `nmts rm --json` prints.
132
- *
133
- * ⛔ THE ORDER OF THESE FIELDS IS THE COMMAND'S JSON. The command hands this object straight to
134
- * `JSON.stringify`, so a field added in the middle changes what an agent reading that output
135
- * sees. Add at the end, or not at all.
136
- */
137
- export interface TrashOutcome {
138
- /** The paths acted on. Empty when everything named was already where it was asked to be. */
139
- paths: string[];
140
- /** Their ids, in the same order. */
141
- ids: string[];
142
- /** How many server rows were moved. A folder has none of its own; its files have one each. */
143
- files: number;
144
- /** Named, and nothing written for them: already out of the trash, or covered by a named folder. */
145
- skipped: string[];
146
- changed: boolean;
147
- reappliedAfterConflict: boolean;
148
- seq: number;
149
- }
150
- export interface TrashEditOptions {
151
- /**
152
- * Refuse what the command-line tool names and carries on with.
153
- *
154
- * ⛔ OFF FOR THE COMMANDS AND ON FOR A LIBRARY, and the difference is who is reading. A person
155
- * who typed `nmts restore a.txt b.txt` and had already restored `a.txt` wants `b.txt` back and
156
- * a line saying the first was not in the trash; a program calling `restore` wants to know that
157
- * what it asked for was not what it got, and the only way it learns that is a refusal.
158
- *
159
- * It adds two: a path that is not in the trash (`NOT_IN_TRASH`) and a restore whose old name has
160
- * been taken since (`NAME_TAKEN`).
161
- */
162
- strict?: boolean;
163
- }
164
- /**
165
- * Move things to the trash, or bring them back.
166
- *
167
- * ⛔ NEITHER HALF DESTROYS ANYTHING. `rm` moves everything it is given to the trash, where it stays
168
- * restorable for thirty days; the endpoint that erases a stored row for good is closed to an API
169
- * key and stays closed, so nothing here can reach it.
170
- *
171
- * ⛔ THE SERVER ROW GOES FIRST, AND "ALREADY DONE" COUNTS AS DONE. A trashed item's bytes cannot be
172
- * fetched, so the state to avoid above all others is a list that shows a file as live when the
173
- * server has already trashed it: the person sees it, asks for it, and is told it does not exist.
174
- * Writing the list only after the server agreed means a failed server call leaves the drive
175
- * exactly as it was — the state a caller can act on.
176
- *
177
- * ⛔ AND ONE PATH THAT WILL NOT RESOLVE REFUSES THE WHOLE RUN, before a single server row is
178
- * touched. Trashing four of the five things somebody named and answering success is worse than
179
- * trashing none: the run reads as done, and finding the odd one out means diffing the drive.
180
- */
181
- export declare function trashPaths(input: ListEditInput, verb: "rm" | "restore", paths: readonly string[], options?: TrashEditOptions): Promise<TrashOutcome>;
182
- /**
183
- * Every file at or under one entry.
184
- *
185
- * ⚠ Trashed descendants are INCLUDED HERE, and the CALLER filters. Somebody who trashed one file
186
- * last week and then trashes its folder expects the folder to be gone from the server too — so
187
- * `rm` takes this set whole. `restore` cannot: see the note at the call site.
188
- */
189
- export declare function filesUnder(entries: readonly ManifestEntry[], rootId: string): ManifestEntry[];
1
+ export { DriveEditError, requireNewName } from "./drive-edit/errors.ts";
2
+ export type { DriveEditCode } from "./drive-edit/errors.ts";
3
+ export { ensureFolderPath, makeFolder } from "./drive-edit/folders.ts";
4
+ export type { MadeFolder } from "./drive-edit/folders.ts";
5
+ export { moveEntries, renameEntry } from "./drive-edit/move.ts";
6
+ export type { MoveOutcome, MovedThing, RenameOutcome } from "./drive-edit/move.ts";
7
+ export { trashPaths } from "./drive-edit/trash.ts";
8
+ export type { TrashEditOptions, TrashOutcome } from "./drive-edit/trash.ts";
9
+ export { filesUnder } from "./drive-edit/tree.ts";