@astrosheep/square 0.3.44 → 0.3.46

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/dist/artifact.js CHANGED
@@ -1,317 +1,360 @@
1
- import crypto from 'node:crypto';
1
+ import { DatabaseSync } from 'node:sqlite';
2
+ import { randomUUID } from 'node:crypto';
2
3
  import fs from 'node:fs';
3
4
  import path from 'node:path';
4
- import { TextDecoder } from 'node:util';
5
- import zlib from 'node:zlib';
6
- import { isWakeRouteKind, InternalSquareError, SquareError, } from './model.js';
7
- import { parseActivityId } from './square-core.js';
8
- const SQUARE_MAGIC = Buffer.from('SQUARE01', 'ascii');
9
- const LENGTH_BYTES = 4;
10
- const DIGEST_BYTES = 32;
11
- const HEADER_BYTES = SQUARE_MAGIC.length + LENGTH_BYTES + DIGEST_BYTES;
12
- const utf8 = new TextDecoder('utf-8', { fatal: true });
13
- const guideNames = ['participant', 'architect', 'brainstorm'];
14
- const guideContents = new Map(await Promise.all(guideNames.map(async (name) => [name, (await fs.promises.readFile(new URL(`../guides/${name}.md`, import.meta.url), 'utf8')).trim()])));
5
+ import { pathToFileURL } from 'node:url';
6
+ import { setTimeout as sleep } from 'node:timers/promises';
7
+ import { isDeepStrictEqual } from 'node:util';
8
+ import { InternalSquareError, SquareError } from './model.js';
9
+ import { validateSquareState } from './square-state.js';
10
+ const APPLICATION_ID = 0x53515245;
11
+ const USER_VERSION = 1;
12
+ const SNAPSHOT_TABLE = 'square_snapshot';
13
+ const SNAPSHOT_DDL = `CREATE TABLE ${SNAPSHOT_TABLE} (id INTEGER PRIMARY KEY CHECK(id=1), revision INTEGER NOT NULL CHECK(revision>=0), state TEXT NOT NULL)`;
14
+ const SNAPSHOT_COLUMNS = [
15
+ { cid: 0, name: 'id', type: 'INTEGER', notnull: 0, dflt_value: null, pk: 1, hidden: 0 },
16
+ { cid: 1, name: 'revision', type: 'INTEGER', notnull: 1, dflt_value: null, pk: 0, hidden: 0 },
17
+ { cid: 2, name: 'state', type: 'TEXT', notnull: 1, dflt_value: null, pk: 0, hidden: 0 },
18
+ ];
19
+ export { createSquareState, emptyRuntimeState } from './square-state.js';
15
20
  function invalidArtifact(detail) {
16
21
  return new SquareError('invalid_args', `Invalid square artifact: ${detail}`);
17
22
  }
18
- function isObject(value) {
19
- return typeof value === 'object' && value !== null && !Array.isArray(value);
20
- }
21
- function hasExactKeys(value, required, optional = []) {
22
- const allowed = new Set([...required, ...optional]);
23
- return required.every((key) => Object.hasOwn(value, key))
24
- && Object.keys(value).every((key) => allowed.has(key));
25
- }
26
- function isFiniteNumber(value) {
27
- return typeof value === 'number' && Number.isFinite(value);
28
- }
29
- function isNonNegativeInteger(value) {
30
- return typeof value === 'number' && Number.isSafeInteger(value) && value >= 0;
31
- }
32
- function isNonblankString(value) {
33
- return typeof value === 'string' && value.length > 0;
23
+ function requireSquareExtension(squarePath) {
24
+ if (!squarePath.endsWith('.square'))
25
+ throw new SquareError('invalid_args', `Square artifacts must use the .square extension: ${squarePath}`);
34
26
  }
35
- function isStringArray(value) {
36
- return Array.isArray(value) && value.every((item) => typeof item === 'string');
27
+ function isNotFound(error) {
28
+ return error instanceof Error && /unable to open database file|no such file|SQLITE_CANTOPEN/i.test(error.message);
37
29
  }
38
- function validateObservation(value) {
39
- return isObject(value)
40
- && hasExactKeys(value, ['state', 'at'])
41
- && value.state === 'seen'
42
- && isFiniteNumber(value.at);
30
+ function isNotADatabase(error) {
31
+ return error instanceof Error && /not a database|file is not a database|SQLITE_NOTADB/i.test(error.message);
43
32
  }
44
- function validateWatchLease(value) {
45
- if (!isObject(value)
46
- || !hasExactKeys(value, ['leaseId', 'heartbeatAt', 'expiresAt'], ['filter'])
47
- || !isNonblankString(value.leaseId)
48
- || !isFiniteNumber(value.heartbeatAt)
49
- || !isFiniteNumber(value.expiresAt)
50
- || value.expiresAt < value.heartbeatAt)
51
- return false;
52
- if (value.filter === undefined)
53
- return true;
54
- return isObject(value.filter)
55
- && hasExactKeys(value.filter, [], ['participants', 'mention'])
56
- && (value.filter.participants === undefined || isStringArray(value.filter.participants))
57
- && (value.filter.mention === undefined || typeof value.filter.mention === 'string');
33
+ function existingDatabaseUri(squarePath) {
34
+ const uri = pathToFileURL(path.resolve(squarePath));
35
+ uri.searchParams.set('mode', 'rw');
36
+ return uri.href;
58
37
  }
59
- function validateRecord(value, item) {
60
- return isObject(value)
61
- && Object.entries(value).every(([key, candidate]) => key.length > 0 && item(candidate));
38
+ function openExistingDatabase(squarePath) {
39
+ try {
40
+ return new DatabaseSync(existingDatabaseUri(squarePath));
41
+ }
42
+ catch (error) {
43
+ if (isNotFound(error))
44
+ throw new InternalSquareError('not_found', `square file not found: ${squarePath}`);
45
+ if (isNotADatabase(error))
46
+ throw invalidArtifact('not a SQLite database.');
47
+ throw error;
48
+ }
62
49
  }
63
- function validateRuntime(value) {
64
- if (!isObject(value)
65
- || !hasExactKeys(value, ['nextActIndex', 'observations', 'leases'])
66
- || !isNonNegativeInteger(value.nextActIndex)
67
- || !validateRecord(value.observations, (candidate) => isObject(candidate) && Object.entries(candidate).every(([id, observation]) => parseActivityId(id) !== undefined && validateObservation(observation)))
68
- || !validateRecord(value.leases, validateWatchLease))
69
- return false;
70
- return true;
50
+ function closeQuietly(database) {
51
+ try {
52
+ database?.close();
53
+ }
54
+ catch { /* closing does not alter the primary failure */ }
71
55
  }
72
- function validateAssignedRuntimeReferences(runtime) {
73
- const bound = runtime.nextActIndex;
74
- for (const observations of Object.values(runtime.observations)) {
75
- for (const id of Object.keys(observations)) {
76
- const index = parseActivityId(id);
77
- if (index === undefined)
78
- return 'malformed';
79
- if (index >= bound)
80
- return 'future';
81
- }
56
+ function parseState(state) {
57
+ if (typeof state !== 'string')
58
+ throw invalidArtifact('snapshot state is malformed.');
59
+ try {
60
+ return validateSquareState(JSON.parse(state));
61
+ }
62
+ catch (error) {
63
+ if (error instanceof SquareError)
64
+ throw error;
65
+ throw invalidArtifact('snapshot state is not valid JSON.');
82
66
  }
83
- return 'ok';
84
67
  }
85
- function validateActor(value, required) {
86
- return required ? isNonblankString(value) : value === undefined || isNonblankString(value);
68
+ function normalizedSql(sql) {
69
+ return sql.trim().replace(/\s+/g, ' ').replace(/\s*(>=|[(),=])\s*/g, '$1');
87
70
  }
88
- function validateStoredAct(value) {
89
- if (!isObject(value)
90
- || typeof value.kind !== 'string'
91
- || !isNonNegativeInteger(value.index)
92
- || !isFiniteNumber(value.at))
71
+ function isOwnedSnapshotSchema(database) {
72
+ const objects = database.prepare("SELECT type, name, tbl_name, sql FROM sqlite_schema WHERE name NOT GLOB 'sqlite_*' ORDER BY type, name")
73
+ .all();
74
+ if (objects.length !== 1)
93
75
  return false;
94
- switch (value.kind) {
95
- case 'join':
96
- return hasExactKeys(value, ['kind', 'actor', 'at', 'index']) && validateActor(value.actor, true);
97
- case 'done':
98
- return hasExactKeys(value, ['kind', 'actor', 'at', 'index'], ['body'])
99
- && validateActor(value.actor, true)
100
- && (value.body === undefined || typeof value.body === 'string');
101
- case 'say':
102
- return hasExactKeys(value, ['kind', 'actor', 'at', 'body', 'index'], ['mentions', 'reach', 'reply'])
103
- && validateActor(value.actor, true)
104
- && typeof value.body === 'string'
105
- && (value.mentions === undefined || isStringArray(value.mentions))
106
- && (value.reach === undefined || value.reach === 'bell')
107
- && (value.reply === undefined || isNonNegativeInteger(value.reply));
108
- case 'hold':
109
- return hasExactKeys(value, ['kind', 'at', 'index'], ['actor', 'body'])
110
- && validateActor(value.actor, false)
111
- && (value.body === undefined || typeof value.body === 'string');
112
- case 'resume':
113
- return hasExactKeys(value, ['kind', 'at', 'index'], ['actor']) && validateActor(value.actor, false);
114
- case 'read':
115
- return hasExactKeys(value, ['kind', 'actor', 'at', 'through', 'index'])
116
- && validateActor(value.actor, true)
117
- && isNonNegativeInteger(value.through);
118
- case 'listen':
119
- case 'ignore':
120
- return hasExactKeys(value, ['kind', 'actor', 'target', 'at', 'index'])
121
- && validateActor(value.actor, true)
122
- && validateActor(value.target, true);
123
- default:
124
- return false;
125
- }
126
- }
127
- function validateActs(value) {
128
- if (!Array.isArray(value) || !value.every(validateStoredAct))
76
+ const [object] = objects;
77
+ if (object.type !== 'table' || object.name !== SNAPSHOT_TABLE || object.tbl_name !== SNAPSHOT_TABLE
78
+ || typeof object.sql !== 'string' || normalizedSql(object.sql) !== normalizedSql(SNAPSHOT_DDL))
129
79
  return false;
130
- let previous = -1;
131
- for (const act of value) {
132
- if (act.index <= previous)
133
- return false;
134
- if (act.kind === 'say' && act.reply !== undefined && act.reply >= act.index)
135
- return false;
136
- previous = act.index;
137
- }
138
- return true;
80
+ const columns = database.prepare('SELECT cid, name, type, "notnull", dflt_value, pk, hidden FROM pragma_table_xinfo(?) ORDER BY cid')
81
+ .all(SNAPSHOT_TABLE);
82
+ return columns.length === SNAPSHOT_COLUMNS.length && columns.every((column, index) => {
83
+ const expected = SNAPSHOT_COLUMNS[index];
84
+ return column.cid === expected.cid && column.name === expected.name && column.type === expected.type
85
+ && column.notnull === expected.notnull && column.dflt_value === expected.dflt_value
86
+ && column.pk === expected.pk && column.hidden === expected.hidden;
87
+ });
139
88
  }
140
- function validateSquareState(value) {
141
- if (!isObject(value)
142
- || !hasExactKeys(value, ['hardCap', 'preamble', 'warmup', 'acts', 'runtime'], ['throttlePerMinute', 'routes'])
143
- || !(value.hardCap === null || (Number.isSafeInteger(value.hardCap) && value.hardCap > 0))
144
- || (value.throttlePerMinute !== undefined
145
- && (!Number.isSafeInteger(value.throttlePerMinute) || value.throttlePerMinute <= 0))
146
- || !isStringArray(value.preamble)
147
- || !isStringArray(value.warmup)
148
- || !validateActs(value.acts)
149
- || (value.routes !== undefined && (!Array.isArray(value.routes) || !value.routes.every((route) => isObject(route) && isWakeRouteKind(route.kind) && typeof route.location === 'string' && typeof route.participant === 'string' && typeof route.sessionId === 'string' && typeof route.channel === 'string' && isObject(route.address) && Object.values(route.address).every((item) => typeof item === 'string') && typeof route.updatedAt === 'number')))
150
- || !validateRuntime(value.runtime)) {
151
- throw invalidArtifact('snapshot schema is malformed.');
89
+ function validateDatabase(database) {
90
+ try {
91
+ const identity = database.prepare('SELECT application_id, user_version FROM pragma_application_id, pragma_user_version').get();
92
+ if (identity.application_id !== APPLICATION_ID)
93
+ throw invalidArtifact('unrelated SQLite database.');
94
+ if (identity.user_version !== USER_VERSION)
95
+ throw invalidArtifact('unsupported SQLite format version.');
96
+ if (!isOwnedSnapshotSchema(database))
97
+ throw invalidArtifact('unsupported snapshot schema.');
98
+ const rows = database.prepare(`SELECT id, revision, state FROM ${SNAPSHOT_TABLE}`).all();
99
+ if (rows.length !== 1 || rows[0].id !== 1 || !Number.isSafeInteger(rows[0].revision) || rows[0].revision < 0)
100
+ throw invalidArtifact('snapshot row is malformed.');
101
+ return { state: parseState(rows[0].state), revision: rows[0].revision };
152
102
  }
153
- const acts = value.acts;
154
- const runtime = value.runtime;
155
- const historyBoundary = acts.at(-1)?.index ?? -1;
156
- if (runtime.nextActIndex <= historyBoundary) {
157
- throw invalidArtifact('nextActIndex is behind the activity history.');
103
+ catch (error) {
104
+ if (error instanceof SquareError)
105
+ throw error;
106
+ if (isNotADatabase(error))
107
+ throw invalidArtifact('not a SQLite database.');
108
+ throw error;
158
109
  }
159
- const references = validateAssignedRuntimeReferences(runtime);
160
- if (references === 'malformed')
161
- throw invalidArtifact('snapshot schema is malformed.');
162
- if (references === 'future')
163
- throw invalidArtifact('runtime references an unassigned activity index.');
164
- return value;
165
110
  }
166
- function encodeEnvelope(magic, value) {
167
- const json = Buffer.from(JSON.stringify(value), 'utf8');
168
- const payload = zlib.gzipSync(json, { level: 9 });
169
- if (payload.length > 0xffff_ffff)
170
- throw invalidArtifact('compressed payload is too large.');
171
- const header = Buffer.alloc(HEADER_BYTES);
172
- magic.copy(header, 0);
173
- header.writeUInt32BE(payload.length, magic.length);
174
- crypto.createHash('sha256').update(payload).digest().copy(header, magic.length + LENGTH_BYTES);
175
- return Buffer.concat([header, payload]);
111
+ function configureDatabase(database) {
112
+ database.exec('PRAGMA busy_timeout = 0; PRAGMA journal_mode = DELETE; PRAGMA synchronous = FULL;');
176
113
  }
177
- function decodeEnvelope(bytes, magic) {
178
- if (bytes.length < HEADER_BYTES)
179
- throw invalidArtifact('truncated header.');
180
- if (!bytes.subarray(0, magic.length).equals(magic))
181
- throw invalidArtifact('bad magic or unsupported format version.');
182
- const length = bytes.readUInt32BE(magic.length);
183
- if (bytes.length !== HEADER_BYTES + length)
184
- throw invalidArtifact('payload length does not match the file.');
185
- const expected = bytes.subarray(magic.length + LENGTH_BYTES, HEADER_BYTES);
186
- const payload = bytes.subarray(HEADER_BYTES);
187
- const actual = crypto.createHash('sha256').update(payload).digest();
188
- if (!crypto.timingSafeEqual(expected, actual))
189
- throw invalidArtifact('payload digest mismatch.');
190
- let inflated;
114
+ /** Opens an existing artifact without permitting SQLite to create a missing path. */
115
+ function readSquareSnapshotOnce(squarePath) {
116
+ requireSquareExtension(squarePath);
117
+ let database;
191
118
  try {
192
- inflated = zlib.gunzipSync(payload);
119
+ database = openExistingDatabase(squarePath);
120
+ return validateDatabase(database);
193
121
  }
194
- catch {
195
- throw invalidArtifact('payload is not valid gzip data.');
122
+ catch (error) {
123
+ if (error instanceof SquareError)
124
+ throw error;
125
+ if (isNotFound(error))
126
+ throw new InternalSquareError('not_found', `square file not found: ${squarePath}`);
127
+ if (isNotADatabase(error))
128
+ throw invalidArtifact('not a SQLite database.');
129
+ throw error;
196
130
  }
197
- let text;
198
- try {
199
- text = utf8.decode(inflated);
131
+ finally {
132
+ closeQuietly(database);
200
133
  }
201
- catch {
202
- throw invalidArtifact('payload is not valid UTF-8.');
134
+ }
135
+ async function createTemporaryArtifact(squarePath) {
136
+ const directory = path.dirname(squarePath);
137
+ await fs.promises.mkdir(directory, { recursive: true });
138
+ while (true) {
139
+ const temporary = path.join(directory, `.${path.basename(squarePath)}.${process.pid}.${randomUUID()}.tmp`);
140
+ try {
141
+ const handle = await fs.promises.open(temporary, 'wx');
142
+ await handle.close();
143
+ return temporary;
144
+ }
145
+ catch (error) {
146
+ if (error.code === 'EEXIST')
147
+ continue;
148
+ throw error;
149
+ }
203
150
  }
151
+ }
152
+ async function syncTemporaryArtifact(temporary) {
153
+ const handle = await fs.promises.open(temporary, 'r');
204
154
  try {
205
- return JSON.parse(text);
155
+ await handle.sync();
206
156
  }
207
- catch {
208
- throw invalidArtifact('payload is not valid JSON.');
157
+ finally {
158
+ await handle.close();
209
159
  }
210
160
  }
211
- export function emptyRuntimeState(nextActIndex = 0) {
212
- return {
213
- nextActIndex,
214
- observations: {},
215
- leases: {},
216
- };
217
- }
218
- function normalizedLines(value) {
219
- const normalized = value.replace(/\r\n/g, '\n').trim();
220
- return normalized === '' ? [] : normalized.split('\n');
161
+ async function removeTemporaryArtifact(temporary) {
162
+ try {
163
+ await fs.promises.unlink(temporary);
164
+ }
165
+ catch { /* cleanup cannot invalidate a published artifact */ }
221
166
  }
222
- function readGuide(name) {
167
+ function initializeDatabase(squarePath, state) {
168
+ const encoded = JSON.stringify(state);
169
+ let database;
223
170
  try {
224
- const guide = guideContents.get(name);
225
- if (guide === undefined)
226
- throw Object.assign(new Error('missing guide'), { code: 'ENOENT' });
227
- return guide;
171
+ database = openExistingDatabase(squarePath);
172
+ database.exec(`PRAGMA journal_mode = DELETE; PRAGMA synchronous = FULL; BEGIN IMMEDIATE; PRAGMA application_id = ${APPLICATION_ID}; PRAGMA user_version = ${USER_VERSION}; ${SNAPSHOT_DDL};`);
173
+ database.prepare(`INSERT INTO ${SNAPSHOT_TABLE} (id, revision, state) VALUES (1, 0, ?)`).run(encoded);
174
+ database.exec('COMMIT;');
228
175
  }
229
176
  catch (error) {
230
- if (error.code === 'ENOENT') {
231
- throw new SquareError('invalid_args', `Unknown square guide: ${name}`);
177
+ try {
178
+ database?.exec('ROLLBACK;');
232
179
  }
180
+ catch { /* retain initialization failure */ }
233
181
  throw error;
234
182
  }
183
+ finally {
184
+ closeQuietly(database);
185
+ }
186
+ }
187
+ /** Creates a new SQLite artifact only when its pathname did not already exist. */
188
+ export async function createSquareFile(squarePath, state) {
189
+ requireSquareExtension(squarePath);
190
+ const validated = validateSquareState(state);
191
+ const temporary = await createTemporaryArtifact(squarePath);
192
+ try {
193
+ initializeDatabase(temporary, validated);
194
+ await syncTemporaryArtifact(temporary);
195
+ try {
196
+ await fs.promises.link(temporary, squarePath);
197
+ return true;
198
+ }
199
+ catch (error) {
200
+ if (error.code === 'EEXIST')
201
+ return false;
202
+ throw error;
203
+ }
204
+ }
205
+ finally {
206
+ await removeTemporaryArtifact(temporary);
207
+ }
235
208
  }
236
- export function createSquareState(options, snippet) {
237
- const guides = [readGuide('participant')];
238
- if (options.template !== undefined)
239
- guides.push(readGuide(options.template));
240
- return {
241
- hardCap: options.hardCap,
242
- ...(options.throttlePerMinute === undefined ? {} : { throttlePerMinute: options.throttlePerMinute }),
243
- preamble: normalizedLines(snippet),
244
- warmup: normalizedLines(guides.join('\n\n')),
245
- acts: [],
246
- routes: [],
247
- runtime: emptyRuntimeState(),
248
- };
209
+ function isBusy(error) {
210
+ return error instanceof Error && /database is locked|database is busy|SQLITE_BUSY/i.test(error.message);
249
211
  }
250
- export function encodeSquare(squareState) {
251
- return encodeEnvelope(SQUARE_MAGIC, validateSquareState(squareState));
212
+ function isThenable(value) {
213
+ return (typeof value === 'object' || typeof value === 'function') && value !== null
214
+ && typeof value.then === 'function';
252
215
  }
253
- export function decodeSquare(bytes) {
254
- return validateSquareState(decodeEnvelope(bytes, SQUARE_MAGIC));
216
+ function discardThenable(value) {
217
+ void Promise.resolve(value).catch(() => undefined);
255
218
  }
256
- async function readArtifact(squarePath) {
219
+ function closedError() {
220
+ return new Error('Square artifact is closed');
221
+ }
222
+ async function pauseForBusy(signal) {
223
+ if (signal?.aborted)
224
+ throw signal.reason ?? closedError();
257
225
  try {
258
- return await fs.promises.readFile(squarePath);
226
+ await sleep(25, undefined, { signal });
259
227
  }
260
228
  catch (error) {
261
- if (error.code === 'ENOENT') {
262
- throw new InternalSquareError('not_found', `square file not found: ${squarePath}`);
263
- }
229
+ if (signal?.aborted)
230
+ throw signal.reason ?? closedError();
264
231
  throw error;
265
232
  }
266
233
  }
267
- function requireSquareExtension(squarePath) {
268
- if (!squarePath.endsWith('.square')) {
269
- throw new SquareError('invalid_args', `Square artifacts must use the .square extension: ${squarePath}`);
234
+ /**
235
+ * Reads a complete validated snapshot, yielding between transient SQLite lock
236
+ * conflicts. The URI remains create-disabled throughout the retry loop.
237
+ */
238
+ export async function readSquareSnapshot(squarePath, signal) {
239
+ while (true) {
240
+ if (signal?.aborted)
241
+ throw signal.reason ?? closedError();
242
+ try {
243
+ return readSquareSnapshotOnce(squarePath);
244
+ }
245
+ catch (error) {
246
+ if (!isBusy(error))
247
+ throw error;
248
+ await pauseForBusy(signal);
249
+ }
270
250
  }
271
251
  }
272
- async function atomicWrite(target, bytes) {
273
- const temporary = path.join(path.dirname(target), `.${path.basename(target)}.${process.pid}.${Date.now()}.${Math.random().toString(36).slice(2)}.tmp`);
274
- await fs.promises.mkdir(path.dirname(target), { recursive: true });
252
+ /**
253
+ * Executes one synchronous SquareState transition under SQLite's write lock.
254
+ * A busy COMMIT retries on this same transaction, so fn is never replayed.
255
+ */
256
+ export async function transactSquareSnapshot(squarePath, fn, signal, forceCommit = false) {
257
+ requireSquareExtension(squarePath);
258
+ let database;
259
+ let begun = false;
275
260
  try {
276
- await fs.promises.writeFile(temporary, bytes);
277
- await fs.promises.rename(temporary, target);
261
+ database = openExistingDatabase(squarePath);
262
+ // Validate before any persistent pragma can touch an unsupported artifact.
263
+ while (true) {
264
+ try {
265
+ validateDatabase(database);
266
+ break;
267
+ }
268
+ catch (error) {
269
+ if (!isBusy(error))
270
+ throw error;
271
+ await pauseForBusy(signal);
272
+ }
273
+ }
274
+ while (true) {
275
+ if (signal?.aborted)
276
+ throw signal.reason ?? closedError();
277
+ try {
278
+ configureDatabase(database);
279
+ database.exec('BEGIN IMMEDIATE;');
280
+ begun = true;
281
+ break;
282
+ }
283
+ catch (error) {
284
+ if (!isBusy(error))
285
+ throw error;
286
+ await pauseForBusy(signal);
287
+ }
288
+ }
289
+ const current = validateDatabase(database);
290
+ const outcome = fn(structuredClone(current.state), current.revision);
291
+ if (isThenable(outcome)) {
292
+ discardThenable(outcome);
293
+ throw new TypeError('Square artifact transitions must be synchronous.');
294
+ }
295
+ if (typeof outcome !== 'object' || outcome === null || !Object.hasOwn(outcome, 'result')) {
296
+ throw new TypeError('Square artifact transition must return { state?, result }.');
297
+ }
298
+ if (outcome.state === undefined || (!forceCommit && isDeepStrictEqual(outcome.state, current.state))) {
299
+ database.exec('ROLLBACK;');
300
+ begun = false;
301
+ return { result: outcome.result, revision: current.revision, changed: false };
302
+ }
303
+ const state = validateSquareState(outcome.state);
304
+ if (current.revision === Number.MAX_SAFE_INTEGER) {
305
+ throw invalidArtifact('snapshot revision cannot advance beyond the safe integer limit.');
306
+ }
307
+ const revision = current.revision + 1;
308
+ database.prepare(`UPDATE ${SNAPSHOT_TABLE} SET revision = ?, state = ? WHERE id = 1`)
309
+ .run(revision, JSON.stringify(state));
310
+ while (true) {
311
+ if (signal?.aborted)
312
+ throw signal.reason ?? closedError();
313
+ try {
314
+ database.exec('COMMIT;');
315
+ begun = false;
316
+ return { result: outcome.result, revision, changed: true };
317
+ }
318
+ catch (error) {
319
+ if (!isBusy(error))
320
+ throw error;
321
+ await pauseForBusy(signal);
322
+ }
323
+ }
278
324
  }
279
325
  catch (error) {
280
- try {
281
- await fs.promises.unlink(temporary);
326
+ if (begun) {
327
+ try {
328
+ database?.exec('ROLLBACK;');
329
+ }
330
+ catch { /* retain callback and SQLite failures */ }
282
331
  }
283
- catch { }
284
332
  throw error;
285
333
  }
334
+ finally {
335
+ closeQuietly(database);
336
+ }
337
+ }
338
+ /** Replaces an existing validated snapshot in place and always advances its revision. */
339
+ export async function replaceSquareSnapshot(squarePath, state) {
340
+ const replacement = structuredClone(validateSquareState(state));
341
+ const committed = await transactSquareSnapshot(squarePath, () => ({ state: replacement, result: undefined }), undefined, true);
342
+ return { state: replacement, revision: committed.revision };
286
343
  }
287
344
  export async function writeSquareFile(squarePath, squareState) {
288
345
  requireSquareExtension(squarePath);
289
- await atomicWrite(squarePath, encodeSquare(squareState));
346
+ if (await createSquareFile(squarePath, squareState))
347
+ return;
348
+ await replaceSquareSnapshot(squarePath, squareState);
290
349
  }
291
350
  export async function loadSquare(squarePath) {
292
- requireSquareExtension(squarePath);
293
- return decodeSquare(await readArtifact(squarePath));
351
+ return structuredClone((await readSquareSnapshot(squarePath)).state);
294
352
  }
295
353
  export async function probeSquare(squarePath) {
296
354
  if (!squarePath.endsWith('.square'))
297
355
  return undefined;
298
- let descriptor;
299
- try {
300
- descriptor = await fs.promises.open(squarePath, 'r');
301
- const magic = Buffer.alloc(SQUARE_MAGIC.length);
302
- if ((await descriptor.read(magic, 0, magic.length, 0)).bytesRead !== magic.length || !magic.equals(SQUARE_MAGIC)) {
303
- return undefined;
304
- }
305
- }
306
- catch {
307
- return undefined;
308
- }
309
- finally {
310
- if (descriptor !== undefined)
311
- await descriptor.close();
312
- }
313
356
  try {
314
- return await loadSquare(squarePath);
357
+ return structuredClone(readSquareSnapshotOnce(squarePath).state);
315
358
  }
316
359
  catch {
317
360
  return undefined;
@@ -322,9 +365,6 @@ export async function diagnoseSquareFile(squarePath) {
322
365
  return { problems: [], state: await loadSquare(squarePath) };
323
366
  }
324
367
  catch (error) {
325
- return {
326
- unfixable: error instanceof Error ? error.message : String(error),
327
- problems: [],
328
- };
368
+ return { unfixable: error instanceof Error ? error.message : String(error), problems: [] };
329
369
  }
330
370
  }
@@ -157,7 +157,7 @@ export function verifyOpenCodeRuntime(homeDir, run = runOpenCode) {
157
157
  }
158
158
  }
159
159
  export function skillLinks(homeDir = os.homedir(), parents = ['.claude', '.agents']) {
160
- return parents.flatMap((parent) => ['square', 'brainstorm'].map((name) => ({
160
+ return parents.flatMap((parent) => ['square'].map((name) => ({
161
161
  source: path.join(packageRoot(), 'skills', name),
162
162
  target: path.join(homeDir, parent, 'skills', name),
163
163
  kind: 'skill',
package/dist/help.js CHANGED
@@ -70,7 +70,7 @@ const COMMANDS = [
70
70
  },
71
71
  {
72
72
  names: ['doctor'], usage: 'doctor', usesSquare: true, group: 'maintenance',
73
- summary: 'Validate binary artifact integrity.',
73
+ summary: 'Validate artifact integrity.',
74
74
  },
75
75
  ];
76
76
  function definitionFor(command) {