@zukhruf/sqlite-data-version 0.3.51 → 0.3.52

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/README.md CHANGED
@@ -20,12 +20,6 @@ import { DatabaseSync } from 'node:sqlite';
20
20
 
21
21
  import { DataVersion } from '@zukhruf/sqlite-data-version';
22
22
 
23
- class Unavailable extends Error {
24
- constructor(path: string, cause: unknown) {
25
- super(`Cannot read ${path}`, { cause });
26
- }
27
- }
28
-
29
23
  await using scratch = await mkdtempDisposable(join(tmpdir(), 'data-version-'));
30
24
  const path = join(scratch.path, 'notes.sqlite');
31
25
 
@@ -34,7 +28,7 @@ using owner = new DatabaseSync(path);
34
28
  owner.exec(`PRAGMA journal_mode = WAL;
35
29
  CREATE TABLE notes (id INTEGER PRIMARY KEY, title TEXT)`);
36
30
 
37
- using version = new DataVersion(path, Unavailable);
31
+ using version = new DataVersion(path);
38
32
  let seen = version.current;
39
33
  for (const title of ['first', 'second']) {
40
34
  owner.prepare('INSERT INTO notes (title) VALUES (?)').run(title);
@@ -55,7 +49,7 @@ no change
55
49
 
56
50
  ## The rules
57
51
 
58
- - `new DataVersion(path, unavailable)` opens its own read-only connection to the database. It does not share a connection with a reader. [ADR 0001](./docs/adr/0001-poll-data-version.md) tells why.
52
+ - `new DataVersion(path)` opens its own read-only connection to the database. It does not share a connection with a reader. [ADR 0001](./docs/adr/0001-poll-data-version.md) tells why.
59
53
  - `current` gives the data version now. It is the number of `DataVersion`, not the `PRAGMA data_version` of SQLite. Compare it with the value that you read before from the same `DataVersion`. A different value tells that another connection committed, or that the owner replaced the file. The same value tells that no change occurred.
60
54
  - The number tells only that a change occurred. It does not count the commits, and it does not tell what changed.
61
55
  - `DataVersion` follows the path. The owner can replace the file at the path: it can rename a new file over it, or delete the file and create it again. A replaced file is a change. Then `DataVersion` reads the new file, and each later commit to the new file is a change too. [ADR 0002](./docs/adr/0002-a-replaced-file-is-followed-by-name.md) tells why.
@@ -63,18 +57,18 @@ no change
63
57
  - Each read of `current` reads the status of the file at the path one time (`stat`).
64
58
  - A commit by the same connection does not change the number. The `DataVersion` connection never writes, so each commit that it sees comes from another connection.
65
59
  - Dispose closes the connection. Use `using`, or call `[Symbol.dispose]()`.
66
- - The caller gives the error class. Thus the error names what the caller needs, for example the access that the user must give.
60
+ - The package throws its own `UnavailableError`. A host that needs its own error translates the error of the package at its boundary, and keeps the error of the package as `cause`. [ADR 0003](./docs/adr/0003-the-package-throws-its-own-errors.md) tells why.
67
61
 
68
62
  ## The last write
69
63
 
70
64
  The data version tells that the owner committed after you read it before. It does not tell when. A new process has no earlier value, so it cannot use the data version to find how old the data is.
71
65
 
72
- `lastWrite(path, unavailable)` gives the time when the owner last wrote the database. Use it when the owner writes only while it runs: a time in the past tells that the data has not changed since then.
66
+ `lastWrite(path)` gives the time when the owner last wrote the database. Use it when the owner writes only while it runs: a time in the past tells that the data has not changed since then.
73
67
 
74
68
  ```ts
75
69
  import { lastWrite } from '@zukhruf/sqlite-data-version';
76
70
 
77
- const written = lastWrite(path, Unavailable);
71
+ const written = lastWrite(path);
78
72
  console.log(`The owner last wrote at ${written.toISOString()}`);
79
73
  ```
80
74
 
@@ -87,13 +81,13 @@ console.log(`The owner last wrote at ${written.toISOString()}`);
87
81
 
88
82
  ## Errors
89
83
 
90
- | Error | When |
91
- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------- |
92
- | `new unavailable(path, cause)` | SQLite cannot open the file: `SQLITE_CANTOPEN` (14), for a missing file or a file that the system denies, a privacy denial too. |
93
- | The error of SQLite | All other failures. |
94
- | The error of the file system | `current` cannot read the status of the path, for a cause other than a missing path or a folder that denies this process. |
84
+ | Error | When |
85
+ | ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
86
+ | `UnavailableError` | SQLite cannot open the file: `SQLITE_CANTOPEN` (14), for a missing file or a file that the system denies, a privacy denial too. `new DataVersion` throws it, and `current` throws it when it cannot open a replaced file. `cause` is the error of SQLite. |
87
+ | The error of SQLite | All other failures. |
88
+ | The error of the file system | `current` cannot read the status of the path, for a cause other than a missing path or a folder that denies this process. |
95
89
 
96
- `lastWrite` gives `new unavailable(path, cause)` when the file is missing (`ENOENT`) or the mode of its folder denies this process (`EACCES`). It gives the error of the file system for all other failures.
90
+ `UnavailableError` has the `path`. `lastWrite` throws `UnavailableError` when the file is missing (`ENOENT`) or the mode of its folder denies this process (`EACCES`). Then `cause` is the error of the file system. `lastWrite` throws the error of the file system for all other failures.
97
91
 
98
92
  ## The same concepts in other systems
99
93
 
@@ -110,6 +104,7 @@ console.log(`The owner last wrote at ${written.toISOString()}`);
110
104
 
111
105
  - [0001 Poll data_version](./docs/adr/0001-poll-data-version.md)
112
106
  - [0002 A replaced file is followed by name](./docs/adr/0002-a-replaced-file-is-followed-by-name.md)
107
+ - [0003 The package throws its own errors](./docs/adr/0003-the-package-throws-its-own-errors.md)
113
108
  - [Code copied into this package](./docs/copied-code.md)
114
109
 
115
110
  ## Development
@@ -126,8 +121,9 @@ npx nx run sqlite-data-version:build # compiles src/ to dist/
126
121
  ```
127
122
  src/
128
123
  index.ts the exports
129
- data-version.ts DataVersion and UnavailableError
124
+ data-version.ts DataVersion
130
125
  followed-database.ts the connection that follows the path to a replaced file
126
+ unavailable-error.ts UnavailableError
131
127
  data-version.test.ts the tests, on real SQLite files
132
128
  last-write.ts lastWrite
133
129
  last-write.test.ts the tests, on real SQLite files
@@ -1,7 +1,6 @@
1
- export type UnavailableError = new (path: string, cause: unknown) => Error;
2
1
  export declare class DataVersion implements Disposable {
3
2
  #private;
4
- constructor(path: string, unavailable: UnavailableError);
3
+ constructor(path: string);
5
4
  get current(): number;
6
5
  [Symbol.dispose](): void;
7
6
  }
@@ -1 +1 @@
1
- {"version":3,"file":"data-version.d.ts","sourceRoot":"","sources":["../src/data-version.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,gBAAgB,GAAG,KAAK,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,KAAK,KAAK,CAAC;AAQ3E,qBAAa,WAAY,YAAW,UAAU;;gBAKhC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,gBAAgB;IAKvD,IAAI,OAAO,IAAI,MAAM,CAOpB;IAED,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,IAAI;CAGzB"}
1
+ {"version":3,"file":"data-version.d.ts","sourceRoot":"","sources":["../src/data-version.ts"],"names":[],"mappings":"AAQA,qBAAa,WAAY,YAAW,UAAU;;gBAKhC,IAAI,EAAE,MAAM;IAKxB,IAAI,OAAO,IAAI,MAAM,CAOpB;IAED,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,IAAI;CAGzB"}
@@ -9,8 +9,8 @@ export class DataVersion {
9
9
  #database;
10
10
  #seen;
11
11
  #current = 0;
12
- constructor(path, unavailable) {
13
- this.#database = new FollowedDatabase(path, unavailable);
12
+ constructor(path) {
13
+ this.#database = new FollowedDatabase(path);
14
14
  this.#seen = this.#database.observe();
15
15
  }
16
16
  get current() {
@@ -1 +1 @@
1
- {"version":3,"file":"data-version.js","sourceRoot":"","sources":["../src/data-version.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAM1D,wEAAwE;AACxE,6EAA6E;AAC7E,wEAAwE;AACxE,sEAAsE;AACtE,wEAAwE;AACxE,0DAA0D;AAC1D,MAAM,OAAO,WAAW;IACb,SAAS,CAAmB;IACrC,KAAK,CAAS;IACd,QAAQ,GAAG,CAAC,CAAC;IAEb,YAAY,IAAY,EAAE,WAA6B;QACrD,IAAI,CAAC,SAAS,GAAG,IAAI,gBAAgB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACzD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;IACxC,CAAC;IAED,IAAI,OAAO;QACT,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;QAC1C,IAAI,QAAQ,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;YAC5B,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC;YACtB,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC;QACrB,CAAC;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,CAAC,MAAM,CAAC,OAAO,CAAC;QACd,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;IACnC,CAAC;CACF"}
1
+ {"version":3,"file":"data-version.js","sourceRoot":"","sources":["../src/data-version.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1D,wEAAwE;AACxE,6EAA6E;AAC7E,wEAAwE;AACxE,sEAAsE;AACtE,wEAAwE;AACxE,0DAA0D;AAC1D,MAAM,OAAO,WAAW;IACb,SAAS,CAAmB;IACrC,KAAK,CAAS;IACd,QAAQ,GAAG,CAAC,CAAC;IAEb,YAAY,IAAY;QACtB,IAAI,CAAC,SAAS,GAAG,IAAI,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAC5C,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;IACxC,CAAC;IAED,IAAI,OAAO;QACT,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;QAC1C,IAAI,QAAQ,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;YAC5B,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC;YACtB,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC;QACrB,CAAC;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,CAAC,MAAM,CAAC,OAAO,CAAC;QACd,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;IACnC,CAAC;CACF"}
@@ -1,7 +1,6 @@
1
- import type { UnavailableError } from './data-version.ts';
2
1
  export declare class FollowedDatabase implements Disposable {
3
2
  #private;
4
- constructor(path: string, unavailable: UnavailableError);
3
+ constructor(path: string);
5
4
  observe(): string;
6
5
  [Symbol.dispose](): void;
7
6
  }
@@ -1 +1 @@
1
- {"version":3,"file":"followed-database.d.ts","sourceRoot":"","sources":["../src/followed-database.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAqC1D,qBAAa,gBAAiB,YAAW,UAAU;;gBAOrC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,gBAAgB;IAgBvD,OAAO,IAAI,MAAM;IAcjB,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,IAAI;CAGzB"}
1
+ {"version":3,"file":"followed-database.d.ts","sourceRoot":"","sources":["../src/followed-database.ts"],"names":[],"mappings":"AAmEA,qBAAa,gBAAiB,YAAW,UAAU;;gBAIrC,IAAI,EAAE,MAAM;IAQxB,OAAO,IAAI,MAAM;IAYjB,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,IAAI;CAGzB"}
@@ -1,6 +1,7 @@
1
1
  import { statSync } from 'node:fs';
2
2
  import { DatabaseSync } from 'node:sqlite';
3
- function open(path, unavailable) {
3
+ import { UnavailableError } from "./unavailable-error.js";
4
+ function open(path) {
4
5
  try {
5
6
  return new DatabaseSync(path, { readOnly: true });
6
7
  }
@@ -12,7 +13,7 @@ function open(path, unavailable) {
12
13
  // SQLite gives AUTH only for an authorizer, and this private connection
13
14
  // has none. Any other failure is not one that access can fix.
14
15
  cause.errcode === 14)
15
- throw new unavailable(path, cause);
16
+ throw new UnavailableError(path, cause);
16
17
  throw cause;
17
18
  }
18
19
  }
@@ -30,45 +31,55 @@ function identify(path) {
30
31
  throw cause;
31
32
  }
32
33
  }
33
- // A connection keeps reading the file it opened, also after the owner
34
- // replaces the file at the path. This follows the path by name, as tail -F
35
- // does: when the path names a different file, it opens that file.
36
- export class FollowedDatabase {
37
- #path;
38
- #unavailable;
39
- #identity;
34
+ // One read-only connection and the identity of the file it opened, which
35
+ // never change: a replaced file gets a new OpenFile.
36
+ class OpenFile {
37
+ identity;
40
38
  #database;
41
39
  #version;
42
- constructor(path, unavailable) {
43
- this.#path = path;
44
- this.#unavailable = unavailable;
40
+ constructor(path) {
45
41
  // Stat before open: a file replaced between the two is one extra change
46
42
  // at the next observation. Stat after open could give the new file's
47
43
  // identity to the old connection, and then the replace is never seen.
48
44
  // A path this process cannot see fails the open too, as CANTOPEN.
49
- const identity = identify(path);
50
- this.#database = open(path, unavailable);
51
- this.#identity = identity ?? '';
45
+ this.identity = identify(path);
46
+ this.#database = open(path);
52
47
  this.#version = this.#database.prepare('PRAGMA data_version');
53
48
  }
49
+ get observation() {
50
+ // PRAGMA data_version always gives one row.
51
+ return `${this.identity}|${String(this.#version.get().data_version)}`;
52
+ }
53
+ [Symbol.dispose]() {
54
+ this.#database.close();
55
+ }
56
+ }
57
+ // A connection keeps reading the file it opened, also after the owner
58
+ // replaces the file at the path. This follows the path by name, as tail -F
59
+ // does: when the path names a different file, it opens that file.
60
+ export class FollowedDatabase {
61
+ #path;
62
+ #file;
63
+ constructor(path) {
64
+ this.#path = path;
65
+ this.#file = new OpenFile(path);
66
+ }
54
67
  // The identity of the held file and its data version. A path this process
55
68
  // cannot see keeps the old connection: the owner may be about to create the
56
69
  // file again, and the open connection still reads.
57
70
  observe() {
58
71
  const identity = identify(this.#path);
59
- if (identity !== undefined && identity !== this.#identity) {
72
+ if (identity !== undefined && identity !== this.#file.identity) {
60
73
  // Open the new file before the old one closes. While the old file is
61
74
  // open its inode stays in use, so the new file cannot get the same one.
62
- const database = open(this.#path, this.#unavailable);
63
- this.#database.close();
64
- this.#database = database;
65
- this.#identity = identity;
66
- this.#version = database.prepare('PRAGMA data_version');
75
+ const file = new OpenFile(this.#path);
76
+ this.#file[Symbol.dispose]();
77
+ this.#file = file;
67
78
  }
68
- return `${this.#identity}|${String(this.#version.get()?.data_version)}`;
79
+ return this.#file.observation;
69
80
  }
70
81
  [Symbol.dispose]() {
71
- this.#database.close();
82
+ this.#file[Symbol.dispose]();
72
83
  }
73
84
  }
74
85
  //# sourceMappingURL=followed-database.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"followed-database.js","sourceRoot":"","sources":["../src/followed-database.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnC,OAAO,EAAE,YAAY,EAAsB,MAAM,aAAa,CAAC;AAI/D,SAAS,IAAI,CAAC,IAAY,EAAE,WAA6B;IACvD,IAAI,CAAC;QACH,OAAO,IAAI,YAAY,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;IACpD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IACE,KAAK,YAAY,KAAK;YACtB,SAAS,IAAI,KAAK;YAClB,oEAAoE;YACpE,sEAAsE;YACtE,wEAAwE;YACxE,8DAA8D;YAC9D,KAAK,CAAC,OAAO,KAAK,EAAE;YAEpB,MAAM,IAAI,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACrC,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED,uEAAuE;AACvE,4EAA4E;AAC5E,8DAA8D;AAC9D,SAAS,QAAQ,CAAC,IAAY;IAC5B,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,KAAK,EAAE,CAAC,CAAC;QACtE,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,GAAG,IAAI,KAAK,CAAC,GAAG,EAAE,CAAC;IACvE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,KAAK,IAAI,MAAM,IAAI,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ;YACtE,OAAO,SAAS,CAAC;QACnB,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED,sEAAsE;AACtE,2EAA2E;AAC3E,kEAAkE;AAClE,MAAM,OAAO,gBAAgB;IAClB,KAAK,CAAS;IACd,YAAY,CAAmB;IACxC,SAAS,CAAS;IAClB,SAAS,CAAe;IACxB,QAAQ,CAAgB;IAExB,YAAY,IAAY,EAAE,WAA6B;QACrD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAChC,wEAAwE;QACxE,qEAAqE;QACrE,sEAAsE;QACtE,kEAAkE;QAClE,MAAM,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;QAChC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACzC,IAAI,CAAC,SAAS,GAAG,QAAQ,IAAI,EAAE,CAAC;QAChC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAChE,CAAC;IAED,0EAA0E;IAC1E,4EAA4E;IAC5E,mDAAmD;IACnD,OAAO;QACL,MAAM,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACtC,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,IAAI,CAAC,SAAS,EAAE,CAAC;YAC1D,qEAAqE;YACrE,wEAAwE;YACxE,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;YACrD,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;YACvB,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;YAC1B,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;YAC1B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC;QAC1D,CAAC;QACD,OAAO,GAAG,IAAI,CAAC,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,EAAE,YAAY,CAAC,EAAE,CAAC;IAC1E,CAAC;IAED,CAAC,MAAM,CAAC,OAAO,CAAC;QACd,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;IACzB,CAAC;CACF"}
1
+ {"version":3,"file":"followed-database.js","sourceRoot":"","sources":["../src/followed-database.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnC,OAAO,EAAE,YAAY,EAAsB,MAAM,aAAa,CAAC;AAE/D,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1D,SAAS,IAAI,CAAC,IAAY;IACxB,IAAI,CAAC;QACH,OAAO,IAAI,YAAY,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;IACpD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IACE,KAAK,YAAY,KAAK;YACtB,SAAS,IAAI,KAAK;YAClB,oEAAoE;YACpE,sEAAsE;YACtE,wEAAwE;YACxE,8DAA8D;YAC9D,KAAK,CAAC,OAAO,KAAK,EAAE;YAEpB,MAAM,IAAI,gBAAgB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC1C,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED,uEAAuE;AACvE,4EAA4E;AAC5E,8DAA8D;AAC9D,SAAS,QAAQ,CAAC,IAAY;IAC5B,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,KAAK,EAAE,CAAC,CAAC;QACtE,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,GAAG,IAAI,KAAK,CAAC,GAAG,EAAE,CAAC;IACvE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,KAAK,IAAI,MAAM,IAAI,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ;YACtE,OAAO,SAAS,CAAC;QACnB,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED,yEAAyE;AACzE,qDAAqD;AACrD,MAAM,QAAQ;IACH,QAAQ,CAAqB;IAC7B,SAAS,CAAe;IACxB,QAAQ,CAAgB;IAEjC,YAAY,IAAY;QACtB,wEAAwE;QACxE,qEAAqE;QACrE,sEAAsE;QACtE,kEAAkE;QAClE,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC/B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAChE,CAAC;IAED,IAAI,WAAW;QACb,4CAA4C;QAC5C,OAAO,GAAG,IAAI,CAAC,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAG,CAAC,YAAY,CAAC,EAAE,CAAC;IACzE,CAAC;IAED,CAAC,MAAM,CAAC,OAAO,CAAC;QACd,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;IACzB,CAAC;CACF;AAED,sEAAsE;AACtE,2EAA2E;AAC3E,kEAAkE;AAClE,MAAM,OAAO,gBAAgB;IAClB,KAAK,CAAS;IACvB,KAAK,CAAW;IAEhB,YAAY,IAAY;QACtB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,KAAK,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IAED,0EAA0E;IAC1E,4EAA4E;IAC5E,mDAAmD;IACnD,OAAO;QACL,MAAM,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACtC,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;YAC/D,qEAAqE;YACrE,wEAAwE;YACxE,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACtC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;YAC7B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QACpB,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC;IAChC,CAAC;IAED,CAAC,MAAM,CAAC,OAAO,CAAC;QACd,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;IAC/B,CAAC;CACF"}
package/dist/index.d.ts CHANGED
@@ -1,3 +1,4 @@
1
- export { DataVersion, type UnavailableError } from './data-version.ts';
1
+ export { DataVersion } from './data-version.ts';
2
2
  export { lastWrite } from './last-write.ts';
3
+ export { UnavailableError } from './unavailable-error.ts';
3
4
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,KAAK,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACvE,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC"}
package/dist/index.js CHANGED
@@ -1,3 +1,4 @@
1
1
  export { DataVersion } from "./data-version.js";
2
2
  export { lastWrite } from "./last-write.js";
3
+ export { UnavailableError } from "./unavailable-error.js";
3
4
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAyB,MAAM,mBAAmB,CAAC;AACvE,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC"}
@@ -1,3 +1,2 @@
1
- import type { UnavailableError } from './data-version.ts';
2
- export declare function lastWrite(path: string, unavailable: UnavailableError): Date;
1
+ export declare function lastWrite(path: string): Date;
3
2
  //# sourceMappingURL=last-write.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"last-write.d.ts","sourceRoot":"","sources":["../src/last-write.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAa1D,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,gBAAgB,GAAG,IAAI,CAgB3E"}
1
+ {"version":3,"file":"last-write.d.ts","sourceRoot":"","sources":["../src/last-write.ts"],"names":[],"mappings":"AAeA,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAgB5C"}
@@ -1,4 +1,5 @@
1
1
  import { statSync } from 'node:fs';
2
+ import { UnavailableError } from "./unavailable-error.js";
2
3
  // A missing file, or one in a folder whose mode denies this process. macOS
3
4
  // privacy controls do not deny it: they stop a read of the file and a list of
4
5
  // its folder with EPERM, but not stat of the file.
@@ -9,7 +10,7 @@ const unreadable = new Set(['ENOENT', 'EACCES']);
9
10
  // it closes, and a reader that opens the database then makes an empty one,
10
11
  // timed as it reads; an empty WAL holds nothing the file does not, so only a
11
12
  // WAL with frames counts.
12
- export function lastWrite(path, unavailable) {
13
+ export function lastWrite(path) {
13
14
  try {
14
15
  const file = statSync(path).mtimeMs;
15
16
  const wal = statSync(`${path}-wal`, { throwIfNoEntry: false });
@@ -19,7 +20,7 @@ export function lastWrite(path, unavailable) {
19
20
  if (cause instanceof Error &&
20
21
  'code' in cause &&
21
22
  unreadable.has(String(cause.code)))
22
- throw new unavailable(path, cause);
23
+ throw new UnavailableError(path, cause);
23
24
  throw cause;
24
25
  }
25
26
  }
@@ -1 +1 @@
1
- {"version":3,"file":"last-write.js","sourceRoot":"","sources":["../src/last-write.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAInC,2EAA2E;AAC3E,8EAA8E;AAC9E,mDAAmD;AACnD,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;AAEjD,4EAA4E;AAC5E,6EAA6E;AAC7E,4EAA4E;AAC5E,2EAA2E;AAC3E,6EAA6E;AAC7E,0BAA0B;AAC1B,MAAM,UAAU,SAAS,CAAC,IAAY,EAAE,WAA6B;IACnE,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;QACpC,MAAM,GAAG,GAAG,QAAQ,CAAC,GAAG,IAAI,MAAM,EAAE,EAAE,cAAc,EAAE,KAAK,EAAE,CAAC,CAAC;QAC/D,OAAO,IAAI,IAAI,CACb,GAAG,KAAK,SAAS,IAAI,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CACvE,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IACE,KAAK,YAAY,KAAK;YACtB,MAAM,IAAI,KAAK;YACf,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAElC,MAAM,IAAI,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACrC,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC"}
1
+ {"version":3,"file":"last-write.js","sourceRoot":"","sources":["../src/last-write.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAEnC,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1D,2EAA2E;AAC3E,8EAA8E;AAC9E,mDAAmD;AACnD,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;AAEjD,4EAA4E;AAC5E,6EAA6E;AAC7E,4EAA4E;AAC5E,2EAA2E;AAC3E,6EAA6E;AAC7E,0BAA0B;AAC1B,MAAM,UAAU,SAAS,CAAC,IAAY;IACpC,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;QACpC,MAAM,GAAG,GAAG,QAAQ,CAAC,GAAG,IAAI,MAAM,EAAE,EAAE,cAAc,EAAE,KAAK,EAAE,CAAC,CAAC;QAC/D,OAAO,IAAI,IAAI,CACb,GAAG,KAAK,SAAS,IAAI,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CACvE,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IACE,KAAK,YAAY,KAAK;YACtB,MAAM,IAAI,KAAK;YACf,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAElC,MAAM,IAAI,gBAAgB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC1C,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC"}
@@ -0,0 +1,6 @@
1
+ /** The database file is missing, or this process has no access to it. */
2
+ export declare class UnavailableError extends Error {
3
+ readonly path: string;
4
+ constructor(path: string, cause: unknown);
5
+ }
6
+ //# sourceMappingURL=unavailable-error.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"unavailable-error.d.ts","sourceRoot":"","sources":["../src/unavailable-error.ts"],"names":[],"mappings":"AAAA,yEAAyE;AACzE,qBAAa,gBAAiB,SAAQ,KAAK;IACzC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;gBAEV,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO;CAQzC"}
@@ -0,0 +1,10 @@
1
+ /** The database file is missing, or this process has no access to it. */
2
+ export class UnavailableError extends Error {
3
+ path;
4
+ constructor(path, cause) {
5
+ super(`The database at ${JSON.stringify(path)} cannot be opened: the file is missing, or this process has no access to it. Give the process access, or check the path.`, { cause });
6
+ this.name = 'UnavailableError';
7
+ this.path = path;
8
+ }
9
+ }
10
+ //# sourceMappingURL=unavailable-error.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"unavailable-error.js","sourceRoot":"","sources":["../src/unavailable-error.ts"],"names":[],"mappings":"AAAA,yEAAyE;AACzE,MAAM,OAAO,gBAAiB,SAAQ,KAAK;IAChC,IAAI,CAAS;IAEtB,YAAY,IAAY,EAAE,KAAc;QACtC,KAAK,CACH,mBAAmB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,0HAA0H,EACjK,EAAE,KAAK,EAAE,CACV,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,kBAAkB,CAAC;QAC/B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zukhruf/sqlite-data-version",
3
- "version": "0.3.51",
3
+ "version": "0.3.52",
4
4
  "description": "The data version of a SQLite database that another process owns and writes. It polls PRAGMA data_version on its own read-only connection, which changes on each commit by another connection, also while the owner keeps the file open.",
5
5
  "license": "MIT",
6
6
  "repository": {
@@ -40,6 +40,6 @@
40
40
  "access": "public"
41
41
  },
42
42
  "devDependencies": {
43
- "@zukhruf/testing": "^0.3.51"
43
+ "@zukhruf/testing": "^0.3.52"
44
44
  }
45
45
  }