@evolu/common 1.0.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.
Files changed (79) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +205 -0
  3. package/dist/src/Config.d.ts +20 -0
  4. package/dist/src/Config.d.ts.map +1 -0
  5. package/dist/src/Config.js +8 -0
  6. package/dist/src/Crypto.d.ts +42 -0
  7. package/dist/src/Crypto.d.ts.map +1 -0
  8. package/dist/src/Crypto.js +44 -0
  9. package/dist/src/Db.d.ts +60 -0
  10. package/dist/src/Db.d.ts.map +1 -0
  11. package/dist/src/Db.js +118 -0
  12. package/dist/src/DbWorker.d.ts +78 -0
  13. package/dist/src/DbWorker.d.ts.map +1 -0
  14. package/dist/src/DbWorker.js +282 -0
  15. package/dist/src/Diff.d.ts +19 -0
  16. package/dist/src/Diff.d.ts.map +1 -0
  17. package/dist/src/Diff.js +86 -0
  18. package/dist/src/Errors.d.ts +19 -0
  19. package/dist/src/Errors.d.ts.map +1 -0
  20. package/dist/src/Errors.js +11 -0
  21. package/dist/src/Evolu.d.ts +71 -0
  22. package/dist/src/Evolu.d.ts.map +1 -0
  23. package/dist/src/Evolu.js +235 -0
  24. package/dist/src/MerkleTree.d.ts +15 -0
  25. package/dist/src/MerkleTree.d.ts.map +1 -0
  26. package/dist/src/MerkleTree.js +49 -0
  27. package/dist/src/Model.d.ts +143 -0
  28. package/dist/src/Model.d.ts.map +1 -0
  29. package/dist/src/Model.js +103 -0
  30. package/dist/src/Murmurhash.d.ts +2 -0
  31. package/dist/src/Murmurhash.d.ts.map +1 -0
  32. package/dist/src/Murmurhash.js +60 -0
  33. package/dist/src/Platform.d.ts +29 -0
  34. package/dist/src/Platform.d.ts.map +1 -0
  35. package/dist/src/Platform.js +17 -0
  36. package/dist/src/Protobuf.d.ts +130 -0
  37. package/dist/src/Protobuf.d.ts.map +1 -0
  38. package/dist/src/Protobuf.js +100 -0
  39. package/dist/src/Public.d.ts +7 -0
  40. package/dist/src/Public.d.ts.map +1 -0
  41. package/dist/src/Public.js +2 -0
  42. package/dist/src/Sql.d.ts +12 -0
  43. package/dist/src/Sql.d.ts.map +1 -0
  44. package/dist/src/Sql.js +100 -0
  45. package/dist/src/Sqlite.d.ts +30 -0
  46. package/dist/src/Sqlite.d.ts.map +1 -0
  47. package/dist/src/Sqlite.js +41 -0
  48. package/dist/src/Store.d.ts +9 -0
  49. package/dist/src/Store.d.ts.map +1 -0
  50. package/dist/src/Store.js +18 -0
  51. package/dist/src/SyncWorker.d.ts +73 -0
  52. package/dist/src/SyncWorker.d.ts.map +1 -0
  53. package/dist/src/SyncWorker.js +136 -0
  54. package/dist/src/Timestamp.d.ts +44 -0
  55. package/dist/src/Timestamp.d.ts.map +1 -0
  56. package/dist/src/Timestamp.js +76 -0
  57. package/dist/src/index.d.ts +19 -0
  58. package/dist/src/index.d.ts.map +1 -0
  59. package/dist/src/index.js +18 -0
  60. package/package.json +76 -0
  61. package/src/Config.ts +33 -0
  62. package/src/Crypto.ts +113 -0
  63. package/src/Db.ts +323 -0
  64. package/src/DbWorker.ts +683 -0
  65. package/src/Diff.ts +113 -0
  66. package/src/Errors.ts +33 -0
  67. package/src/Evolu.ts +527 -0
  68. package/src/MerkleTree.ts +83 -0
  69. package/src/Model.ts +212 -0
  70. package/src/Murmurhash.ts +70 -0
  71. package/src/Platform.ts +63 -0
  72. package/src/Protobuf.ts +204 -0
  73. package/src/Public.ts +6 -0
  74. package/src/Sql.ts +114 -0
  75. package/src/Sqlite.ts +92 -0
  76. package/src/Store.ts +32 -0
  77. package/src/SyncWorker.ts +344 -0
  78. package/src/Timestamp.ts +192 -0
  79. package/src/index.ts +18 -0
@@ -0,0 +1,282 @@
1
+ import { hexToBytes } from "@noble/ciphers/utils";
2
+ import { Context, Effect, Function, Layer, Match, Option, ReadonlyArray, Ref, pipe, } from "effect";
3
+ import { Config, ConfigLive } from "./Config.js";
4
+ import { Bip39, NanoId } from "./Crypto.js";
5
+ import { Owner, ensureSchema, lazyInit, someDefectToNoSuchTableOrColumnError, transaction, } from "./Db.js";
6
+ import { makePatches } from "./Diff.js";
7
+ import { makeUnexpectedError } from "./Errors.js";
8
+ import { diffMerkleTrees, insertIntoMerkleTree, merkleTreeToString, } from "./MerkleTree.js";
9
+ import { cast } from "./Model.js";
10
+ import { insertIntoMessagesIfNew, insertValueIntoTableRowColumn, selectLastTimestampForTableRowColumn, selectMessagesToSync, selectOwner, selectOwnerTimestampAndMerkleTree, updateOwnerTimestampAndMerkleTree, } from "./Sql.js";
11
+ import { Sqlite, queryObjectFromQuery } from "./Sqlite.js";
12
+ import { SyncWorker, SyncWorkerPostMessage, } from "./SyncWorker.js";
13
+ import { Time, TimeLive, makeSyncTimestamp, receiveTimestamp, sendTimestamp, timestampToString, unsafeTimestampFromString, } from "./Timestamp.js";
14
+ export const DbWorker = Context.Tag("evolu/DbWorker");
15
+ const DbWorkerOnMessage = Context.Tag("evolu/DbWorkerOnMessage");
16
+ const init = (input) => Effect.gen(function* (_) {
17
+ const sqlite = yield* _(Sqlite);
18
+ return yield* _(sqlite.exec(selectOwner), Effect.map(({ rows: [row] }) => ({
19
+ id: row.id,
20
+ mnemonic: row.mnemonic,
21
+ // expo-sqlite 11.3.2 doesn't support Uint8Array
22
+ encryptionKey: hexToBytes(row.encryptionKey),
23
+ })), someDefectToNoSuchTableOrColumnError, Effect.catchTag("NoSuchTableOrColumnError", () => lazyInit()), Effect.tap(() => ensureSchema(input.tables)));
24
+ });
25
+ const RowsCacheRef = Context.Tag("evolu/RowsCacheRef");
26
+ const query = ({ queries, onCompleteIds = [], }) => Effect.gen(function* (_) {
27
+ const sqlite = yield* _(Sqlite);
28
+ const rowsCache = yield* _(RowsCacheRef);
29
+ const dbWorkerOnMessage = yield* _(DbWorkerOnMessage);
30
+ const queriesRows = yield* _(Effect.forEach(queries, (query) => sqlite
31
+ .exec(queryObjectFromQuery(query))
32
+ .pipe(Effect.map((result) => [query, result.rows]))));
33
+ const previous = yield* _(Ref.get(rowsCache));
34
+ yield* _(Ref.set(rowsCache, new Map([...previous, ...queriesRows])));
35
+ const queriesPatches = queriesRows.map(([query, rows]) => ({
36
+ query,
37
+ patches: makePatches(previous.get(query), rows),
38
+ }));
39
+ dbWorkerOnMessage({ _tag: "onQuery", queriesPatches, onCompleteIds });
40
+ });
41
+ const readTimestampAndMerkleTree = Sqlite.pipe(Effect.flatMap((sqlite) => sqlite.exec(selectOwnerTimestampAndMerkleTree)), Effect.map((result) => result.rows), Effect.map(([{ timestamp, merkleTree }]) => ({
42
+ timestamp: unsafeTimestampFromString(timestamp),
43
+ merkleTree: merkleTree,
44
+ })));
45
+ const mutateItemsToNewMessages = (items) => pipe(items, ReadonlyArray.mapNonEmpty(({ id, isInsert, now, table, values }) => pipe(Object.entries(values), ReadonlyArray.filterMap(([key, value]) =>
46
+ // The value can be undefined if exactOptionalPropertyTypes isn't true.
47
+ // Don't insert nulls because null is the default value.
48
+ value === undefined || (isInsert && value == null)
49
+ ? Option.none()
50
+ : Option.some([key, value])), ReadonlyArray.map(([key, value]) => [
51
+ key,
52
+ typeof value === "boolean"
53
+ ? cast(value)
54
+ : value instanceof Date
55
+ ? cast(value)
56
+ : value,
57
+ ]), ReadonlyArray.append([isInsert ? "createdAt" : "updatedAt", now]), ReadonlyArray.mapNonEmpty(([key, value]) => ({
58
+ table,
59
+ row: id,
60
+ column: key,
61
+ value,
62
+ })))), ReadonlyArray.flattenNonEmpty);
63
+ const ensureSchemaByMessages = (messages) => Effect.gen(function* (_) {
64
+ const tablesMap = new Map();
65
+ messages.forEach((message) => {
66
+ const table = tablesMap.get(message.table);
67
+ if (table == null) {
68
+ tablesMap.set(message.table, {
69
+ name: message.table,
70
+ columns: [message.column],
71
+ });
72
+ return;
73
+ }
74
+ if (table.columns.includes(message.column))
75
+ return;
76
+ tablesMap.set(message.table, {
77
+ name: message.table,
78
+ columns: table.columns.concat(message.column),
79
+ });
80
+ });
81
+ yield* _(ensureSchema(Array.from(tablesMap.values())));
82
+ });
83
+ const applyMessages = ({ merkleTree, messages, }) => Effect.gen(function* (_) {
84
+ const sqlite = yield* _(Sqlite);
85
+ for (const message of messages) {
86
+ const timestamp = yield* _(sqlite.exec({
87
+ sql: selectLastTimestampForTableRowColumn,
88
+ parameters: [message.table, message.row, message.column],
89
+ }), Effect.map((result) => result.rows), Effect.flatMap(ReadonlyArray.head), Effect.map((row) => row.timestamp), Effect.catchTag("NoSuchElementException", () => Effect.succeed(null)));
90
+ if (timestamp == null || timestamp < message.timestamp) {
91
+ const insert = sqlite.exec({
92
+ sql: insertValueIntoTableRowColumn(message.table, message.column),
93
+ parameters: [message.row, message.value, message.value],
94
+ });
95
+ yield* _(insert, someDefectToNoSuchTableOrColumnError, Effect.catchTag("NoSuchTableOrColumnError", () => ensureSchemaByMessages(messages).pipe(Effect.flatMap(() => insert))));
96
+ }
97
+ if (timestamp == null || timestamp !== message.timestamp) {
98
+ const { changes } = yield* _(sqlite.exec({
99
+ sql: insertIntoMessagesIfNew,
100
+ parameters: [
101
+ message.timestamp,
102
+ message.table,
103
+ message.row,
104
+ message.column,
105
+ message.value,
106
+ ],
107
+ }));
108
+ if (changes > 0)
109
+ merkleTree = insertIntoMerkleTree(unsafeTimestampFromString(message.timestamp))(merkleTree);
110
+ }
111
+ }
112
+ return merkleTree;
113
+ });
114
+ const writeTimestampAndMerkleTree = ({ timestamp, merkleTree, }) => Effect.flatMap(Sqlite, (sqlite) => sqlite.exec({
115
+ sql: updateOwnerTimestampAndMerkleTree,
116
+ parameters: [
117
+ timestampToString(timestamp),
118
+ merkleTreeToString(merkleTree),
119
+ ],
120
+ }));
121
+ const mutate = ({ items, queries, }) => Effect.gen(function* (_) {
122
+ const owner = yield* _(Owner);
123
+ let { timestamp, merkleTree } = yield* _(readTimestampAndMerkleTree);
124
+ const messages = yield* _(mutateItemsToNewMessages(items), Effect.forEach((newMessage) => Effect.map(sendTimestamp(timestamp), (nextTimestamp) => {
125
+ timestamp = nextTimestamp;
126
+ return {
127
+ ...newMessage,
128
+ timestamp: timestampToString(timestamp),
129
+ };
130
+ })));
131
+ if (ReadonlyArray.isNonEmptyReadonlyArray(messages)) {
132
+ merkleTree = yield* _(applyMessages({ merkleTree, messages }));
133
+ yield* _(writeTimestampAndMerkleTree({ timestamp, merkleTree }));
134
+ }
135
+ const onCompleteIds = ReadonlyArray.filterMap(items, (item) => Option.fromNullable(item.onCompleteId));
136
+ if (queries.length > 0 || onCompleteIds.length > 0)
137
+ yield* _(query({ queries, onCompleteIds }));
138
+ const [config, syncWorkerPostMessage] = yield* _(Effect.all([Config, SyncWorkerPostMessage]));
139
+ syncWorkerPostMessage({
140
+ _tag: "sync",
141
+ syncUrl: config.syncUrl,
142
+ messages,
143
+ timestamp,
144
+ merkleTree,
145
+ owner,
146
+ syncLoopCount: 0,
147
+ });
148
+ });
149
+ const handleSyncResponse = ({ messages, ...response }) => Effect.gen(function* (_) {
150
+ let { timestamp, merkleTree } = yield* _(readTimestampAndMerkleTree);
151
+ if (ReadonlyArray.isNonEmptyReadonlyArray(messages)) {
152
+ for (const message of messages)
153
+ timestamp = yield* _(unsafeTimestampFromString(message.timestamp), (remote) => receiveTimestamp({ local: timestamp, remote }));
154
+ merkleTree = yield* _(applyMessages({ merkleTree, messages }));
155
+ yield* _(writeTimestampAndMerkleTree({ timestamp, merkleTree }));
156
+ }
157
+ const dbWorkerOnMessage = yield* _(DbWorkerOnMessage);
158
+ dbWorkerOnMessage({ _tag: "onReceive" });
159
+ const diff = diffMerkleTrees(response.merkleTree, merkleTree);
160
+ const syncWorkerPostMessage = yield* _(SyncWorkerPostMessage);
161
+ if (Option.isNone(diff)) {
162
+ syncWorkerPostMessage({ _tag: "syncCompleted" });
163
+ dbWorkerOnMessage({
164
+ _tag: "onSyncState",
165
+ state: {
166
+ _tag: "SyncStateIsSynced",
167
+ time: yield* _(Time.pipe(Effect.flatMap((time) => time.now))),
168
+ },
169
+ });
170
+ return;
171
+ }
172
+ const [sqlite, config, owner] = yield* _(Effect.all([Sqlite, Config, Owner]));
173
+ const messagesToSync = yield* _(sqlite.exec({
174
+ sql: selectMessagesToSync,
175
+ parameters: [timestampToString(makeSyncTimestamp(diff.value))],
176
+ }), Effect.map(({ rows }) => rows));
177
+ syncWorkerPostMessage({
178
+ _tag: "sync",
179
+ syncUrl: config.syncUrl,
180
+ messages: messagesToSync,
181
+ timestamp,
182
+ merkleTree,
183
+ owner,
184
+ syncLoopCount: response.syncLoopCount + 1,
185
+ });
186
+ });
187
+ const sync = ({ queries, }) => Effect.gen(function* (_) {
188
+ if (queries.length > 0)
189
+ yield* _(query({ queries }));
190
+ const [syncWorkerPostMessage, config, owner, timestampAndMerkleTree] = yield* _(Effect.all([
191
+ SyncWorkerPostMessage,
192
+ Config,
193
+ Owner,
194
+ readTimestampAndMerkleTree,
195
+ ]));
196
+ syncWorkerPostMessage({
197
+ ...timestampAndMerkleTree,
198
+ _tag: "sync",
199
+ syncUrl: config.syncUrl,
200
+ owner,
201
+ messages: [],
202
+ syncLoopCount: 0,
203
+ });
204
+ });
205
+ const reset = (input) => Effect.gen(function* (_) {
206
+ const sqlite = yield* _(Sqlite);
207
+ yield* _(sqlite.exec(`SELECT "name" FROM "sqlite_master" WHERE "type" = 'table'`), Effect.map((result) => result.rows), Effect.flatMap(
208
+ // The dropped table is completely removed from the database schema and
209
+ // the disk file. The table can not be recovered.
210
+ // All indices and triggers associated with the table are also deleted.
211
+ // https://sqlite.org/lang_droptable.html
212
+ Effect.forEach(({ name }) => sqlite.exec(`DROP TABLE "${name}"`), { discard: true })));
213
+ if (input.mnemonic)
214
+ yield* _(lazyInit(input.mnemonic));
215
+ const onMessage = yield* _(DbWorkerOnMessage);
216
+ onMessage({ _tag: "onResetOrRestore" });
217
+ });
218
+ export const DbWorkerLive = Layer.effect(DbWorker, Effect.gen(function* (_) {
219
+ const syncWorker = yield* _(SyncWorker);
220
+ const rowsCacheRef = yield* _(Ref.make(new Map()));
221
+ const onError = (error) => Effect.sync(() => {
222
+ dbWorker.onMessage({ _tag: "onError", error });
223
+ });
224
+ syncWorker.onMessage = (output) => {
225
+ switch (output._tag) {
226
+ case "UnexpectedError":
227
+ onError(output).pipe(Effect.runSync);
228
+ break;
229
+ case "SyncWorkerOutputSyncResponse":
230
+ postMessage(output);
231
+ break;
232
+ default:
233
+ dbWorker.onMessage({ _tag: "onSyncState", state: output });
234
+ }
235
+ };
236
+ const context = Context.empty().pipe(Context.add(Sqlite, yield* _(Sqlite)), Context.add(Bip39, yield* _(Bip39)), Context.add(NanoId, yield* _(NanoId)));
237
+ const run = (effect) => effect.pipe(Effect.catchAllDefect(makeUnexpectedError), transaction, Effect.catchAll(onError), Effect.provide(context), Effect.runPromise);
238
+ // Write for reset only in case init fails.
239
+ const writeForInitFail = (input) => {
240
+ if (input._tag !== "reset")
241
+ return Promise.resolve(undefined);
242
+ return reset(input).pipe(Effect.provideService(DbWorkerOnMessage, dbWorker.onMessage), Effect.provide(context), run);
243
+ };
244
+ const makeWriteForInitSuccess = (owner, config) => {
245
+ let skipAllBecauseOfReset = false;
246
+ const layer = Layer.mergeAll(ConfigLive(config), Layer.succeed(DbWorkerOnMessage, dbWorker.onMessage), Layer.succeed(Owner, owner), Layer.succeed(SyncWorkerPostMessage, syncWorker.postMessage), Layer.succeed(RowsCacheRef, rowsCacheRef), TimeLive);
247
+ return (input) => {
248
+ if (skipAllBecauseOfReset)
249
+ return Promise.resolve(undefined);
250
+ return Match.value(input).pipe(Match.tagsExhaustive({
251
+ init: () => makeUnexpectedError(new Error("init must be called once")),
252
+ query,
253
+ mutate,
254
+ sync,
255
+ reset: (input) => {
256
+ skipAllBecauseOfReset = true;
257
+ return reset(input);
258
+ },
259
+ ensureSchema: (input) => ensureSchema(input.tables),
260
+ SyncWorkerOutputSyncResponse: handleSyncResponse,
261
+ }), Effect.provide(layer), run);
262
+ };
263
+ };
264
+ let write = (input) => {
265
+ if (input._tag !== "init")
266
+ return run(makeUnexpectedError(new Error("init must be called first")));
267
+ write = writeForInitFail;
268
+ return init(input).pipe(Effect.map((owner) => {
269
+ dbWorker.onMessage({ _tag: "onOwner", owner });
270
+ write = makeWriteForInitSuccess(owner, input.config);
271
+ }), run);
272
+ };
273
+ let messageQueue = Promise.resolve(undefined);
274
+ const postMessage = (input) => {
275
+ messageQueue = messageQueue.then(() => write(input));
276
+ };
277
+ const dbWorker = {
278
+ postMessage,
279
+ onMessage: Function.constVoid,
280
+ };
281
+ return dbWorker;
282
+ }));
@@ -0,0 +1,19 @@
1
+ import { Query, Row, Value } from "./Sqlite.js";
2
+ export interface QueryPatches {
3
+ readonly query: Query;
4
+ readonly patches: ReadonlyArray<Patch>;
5
+ }
6
+ export type Patch = ReplaceAllPatch | ReplaceAtPatch;
7
+ export interface ReplaceAllPatch {
8
+ readonly op: "replaceAll";
9
+ readonly value: ReadonlyArray<Row>;
10
+ }
11
+ export interface ReplaceAtPatch {
12
+ readonly op: "replaceAt";
13
+ readonly index: number;
14
+ readonly value: Row;
15
+ }
16
+ export declare const applyPatches: (patches: ReadonlyArray<Patch>) => (current: ReadonlyArray<Row>) => ReadonlyArray<Row>;
17
+ export declare const makePatches: (previousRows: ReadonlyArray<Row> | undefined, nextRows: ReadonlyArray<Row>) => readonly Patch[];
18
+ export declare const areEqual: (a: Value | Row | ReadonlyArray<Row>, b: Value | Row | ReadonlyArray<Row>) => boolean;
19
+ //# sourceMappingURL=Diff.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Diff.d.ts","sourceRoot":"","sources":["../../src/Diff.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEhD,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC;CACxC;AAED,MAAM,MAAM,KAAK,GAAG,eAAe,GAAG,cAAc,CAAC;AAErD,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,EAAE,EAAE,YAAY,CAAC;IAC1B,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,EAAE,EAAE,WAAW,CAAC;IACzB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC;CACrB;AAED,eAAO,MAAM,YAAY,YACb,cAAc,KAAK,CAAC,eACpB,cAAc,GAAG,CAAC,KAAG,cAAc,GAAG,CAYnC,CAAC;AAQhB,eAAO,MAAM,WAAW,iBACR,cAAc,GAAG,CAAC,GAAG,SAAS,YAClC,cAAc,GAAG,CAAC,KAC3B,SAAS,KAAK,EA2BhB,CAAC;AAEF,eAAO,MAAM,QAAQ,MAChB,KAAK,GAAG,GAAG,GAAG,cAAc,GAAG,CAAC,KAChC,KAAK,GAAG,GAAG,GAAG,cAAc,GAAG,CAAC,KAClC,OAkCF,CAAC"}
@@ -0,0 +1,86 @@
1
+ import { Predicate } from "effect/index";
2
+ export const applyPatches = (patches) => (current) => patches.reduce((a, patch) => {
3
+ switch (patch.op) {
4
+ case "replaceAll":
5
+ return patch.value;
6
+ case "replaceAt": {
7
+ if (a === undefined)
8
+ return a;
9
+ const next = [...a];
10
+ next[patch.index] = patch.value;
11
+ return next;
12
+ }
13
+ }
14
+ }, current);
15
+ // We detect only a change in the whole result and in-place edits.
16
+ // In the future, we will add more heuristics. We will probably not implement
17
+ // the Myers diff algorithm because it's faster to rerender all than
18
+ // to compute many detailed patches. We will only implement a logic
19
+ // a developer would implement manually, if necessary.
20
+ // Another idea is to make makePatches configurable via custom functions.
21
+ export const makePatches = (previousRows, nextRows) => {
22
+ if (previousRows === undefined)
23
+ return [{ op: "replaceAll", value: nextRows }];
24
+ // TODO: Detect prepend and append, it's cheap.
25
+ if (previousRows.length !== nextRows.length) {
26
+ return [{ op: "replaceAll", value: nextRows }];
27
+ }
28
+ const length = previousRows.length;
29
+ const replaceAtPatches = [];
30
+ for (let i = 0; i < length; i++) {
31
+ const previousRow = previousRows[i];
32
+ const nextRow = nextRows[i];
33
+ // We expect the same shape for both rows.
34
+ for (const key in previousRow)
35
+ if (!areEqual(previousRow[key], nextRow[key])) {
36
+ replaceAtPatches.push({ op: "replaceAt", value: nextRow, index: i });
37
+ break;
38
+ }
39
+ }
40
+ if (length > 0 && replaceAtPatches.length === length) {
41
+ return [{ op: "replaceAll", value: nextRows }];
42
+ }
43
+ return replaceAtPatches;
44
+ };
45
+ export const areEqual = (a, b) => {
46
+ // Compare string, number, null ASAP.
47
+ if (a === b)
48
+ return true;
49
+ // Different type works only for string and number, everything else is an object.
50
+ if (typeof a !== typeof b)
51
+ return false;
52
+ // Both are nonnullable objects.
53
+ if (typeof a === "object" && a !== null && b !== null) {
54
+ const aIsUint8Array = Predicate.isUint8Array(a);
55
+ const bIsUint8Array = Predicate.isUint8Array(b);
56
+ if (aIsUint8Array && bIsUint8Array) {
57
+ if (a.length !== b.length)
58
+ return false;
59
+ for (let i = 0; i < a.length; i++)
60
+ if (a[i] !== b[i])
61
+ return false;
62
+ return true;
63
+ }
64
+ const aIsArray = Array.isArray(a);
65
+ const bIsArray = Array.isArray(b);
66
+ if (aIsArray && bIsArray) {
67
+ if (a.length !== b.length)
68
+ return false;
69
+ for (let i = 0; i < a.length; i++)
70
+ if (!areEqual(a[i], b[i]))
71
+ return false;
72
+ return true;
73
+ }
74
+ if (!aIsUint8Array && !bIsUint8Array && !aIsArray && !bIsArray) {
75
+ const aKeys = Object.keys(a);
76
+ const bKeys = Object.keys(b);
77
+ if (aKeys.length !== bKeys.length)
78
+ return false;
79
+ for (const key of aKeys)
80
+ if (!areEqual(a[key], b[key]))
81
+ return false;
82
+ return true;
83
+ }
84
+ }
85
+ return false;
86
+ };
@@ -0,0 +1,19 @@
1
+ import { Effect } from "effect";
2
+ import { TimestampError } from "./Timestamp.js";
3
+ export type EvoluError = UnexpectedError | TimestampError;
4
+ /**
5
+ * We can't use the whole error because of WebWorker postMessage DataCloneError
6
+ * in Safari and Firefox.
7
+ * https://discord.com/channels/795981131316985866/795983589644304396/1096736473396564079
8
+ */
9
+ interface TransferableError {
10
+ readonly message: string;
11
+ readonly stack: string | undefined;
12
+ }
13
+ export interface UnexpectedError {
14
+ readonly _tag: "UnexpectedError";
15
+ readonly error: TransferableError;
16
+ }
17
+ export declare const makeUnexpectedError: (error: unknown) => Effect.Effect<never, UnexpectedError, never>;
18
+ export {};
19
+ //# sourceMappingURL=Errors.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Errors.d.ts","sourceRoot":"","sources":["../../src/Errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAEhD,MAAM,MAAM,UAAU,GAAG,eAAe,GAAG,cAAc,CAAC;AAE1D;;;;GAIG;AACH,UAAU,iBAAiB;IACzB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;CACpC;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC;IACjC,QAAQ,CAAC,KAAK,EAAE,iBAAiB,CAAC;CACnC;AAED,eAAO,MAAM,mBAAmB,UACvB,OAAO,KACb,aAAa,CAAC,KAAK,EAAE,eAAe,EAAE,KAAK,CAU7C,CAAC"}
@@ -0,0 +1,11 @@
1
+ import { Effect } from "effect";
2
+ export const makeUnexpectedError = (error) => {
3
+ const isError = error instanceof Error;
4
+ return Effect.fail({
5
+ _tag: "UnexpectedError",
6
+ error: {
7
+ message: isError ? error.message : String(error),
8
+ stack: isError ? error.stack : undefined,
9
+ },
10
+ });
11
+ };
@@ -0,0 +1,71 @@
1
+ import { Context, Either, Layer } from "effect";
2
+ import { Simplify } from "kysely";
3
+ import { Config } from "./Config.js";
4
+ import { Bip39, NanoId } from "./Crypto.js";
5
+ import { CommonColumns, CreateQuery, Owner, Schema, Tables } from "./Db.js";
6
+ import { DbWorker, DbWorkerOutputOnQuery } from "./DbWorker.js";
7
+ import { EvoluError } from "./Errors.js";
8
+ import { CastableForMutate } from "./Model.js";
9
+ import { AppState, FlushSync } from "./Platform.js";
10
+ import { Query, Row } from "./Sqlite.js";
11
+ import { Store, StoreListener, StoreUnsubscribe } from "./Store.js";
12
+ import { SyncState } from "./SyncWorker.js";
13
+ import { Time } from "./Timestamp.js";
14
+ export interface Evolu<S extends Schema> {
15
+ readonly subscribeError: ErrorStore["subscribe"];
16
+ readonly getError: ErrorStore["getState"];
17
+ readonly subscribeOwner: OwnerStore["subscribe"];
18
+ readonly getOwner: OwnerStore["getState"];
19
+ readonly subscribeQuery: QueryStore["subscribe"];
20
+ readonly getQuery: QueryStore["getState"];
21
+ readonly createQuery: CreateQuery<S>;
22
+ readonly loadQuery: QueryStore["loadQuery"];
23
+ readonly subscribeSyncState: (listener: StoreListener) => StoreUnsubscribe;
24
+ readonly getSyncState: () => SyncState;
25
+ readonly create: Create<S>;
26
+ readonly update: Update<S>;
27
+ readonly ownerActions: OwnerActions;
28
+ readonly ensureSchema: (tables: Tables) => void;
29
+ }
30
+ export declare const Evolu: <T extends Schema>() => Context.Tag<Evolu<T>, Evolu<T>>;
31
+ type ErrorStore = Store<EvoluError | null>;
32
+ type OwnerStore = Store<Owner | null>;
33
+ interface QueryStore {
34
+ readonly subscribe: (query: Query | null) => (listener: StoreListener) => StoreUnsubscribe;
35
+ readonly getState: (query: Query | null) => ReadonlyArray<Row> | null;
36
+ readonly loadQuery: (query: Query) => Promise<ReadonlyArray<Row>>;
37
+ readonly onQuery: (output: DbWorkerOutputOnQuery) => void;
38
+ }
39
+ declare const QueryStore: Context.Tag<QueryStore, QueryStore>;
40
+ export type Create<S extends Schema> = <T extends keyof S>(table: T, values: Simplify<PartialOnlyForNullable<CastableForMutate<Omit<S[T], "id">>>>, onComplete?: () => void) => {
41
+ readonly id: S[T]["id"];
42
+ };
43
+ type PartialOnlyForNullable<T, NK extends keyof T = {
44
+ [K in keyof T]: null extends T[K] ? K : never;
45
+ }[keyof T], NP = Pick<T, Exclude<keyof T, NK>> & Partial<Pick<T, NK>>> = {
46
+ [K in keyof NP]: NP[K];
47
+ };
48
+ export type Update<S extends Schema> = <T extends keyof S>(table: T, values: Simplify<Partial<CastableForMutate<Omit<S[T], "id"> & Pick<CommonColumns, "isDeleted">>> & {
49
+ readonly id: S[T]["id"];
50
+ }>, onComplete?: () => void) => {
51
+ readonly id: S[T]["id"];
52
+ };
53
+ export interface OwnerActions {
54
+ /**
55
+ * Use `reset` to delete all local data from the current device.
56
+ * After the deletion, Evolu reloads all browser tabs that use Evolu.
57
+ */
58
+ readonly reset: () => void;
59
+ /**
60
+ * Use `restore` to restore `Owner` with synced data on a different device.
61
+ */
62
+ readonly restore: (mnemonic: string) => Promise<Either.Either<RestoreOwnerError, void>>;
63
+ }
64
+ interface RestoreOwnerError {
65
+ readonly _tag: "RestoreOwnerError";
66
+ }
67
+ export declare const loadingPromisesPromiseProp = "rows";
68
+ export declare const EvoluLive: <T extends Schema>(tables: Tables) => Layer.Layer<Config | Bip39 | NanoId | Time | FlushSync | AppState | DbWorker, never, Evolu<T>>;
69
+ export declare const makeEvoluForPlatform: <T extends Schema>(PlatformLayer: Layer.Layer<never, never, DbWorker | Bip39 | NanoId | FlushSync | AppState>, tables: Tables, config?: Partial<Config>) => Evolu<T>;
70
+ export {};
71
+ //# sourceMappingURL=Evolu.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Evolu.d.ts","sourceRoot":"","sources":["../../src/Evolu.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EAEP,MAAM,EAEN,KAAK,EAMN,MAAM,QAAQ,CAAC;AAChB,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAClC,OAAO,EAAE,MAAM,EAAc,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EACL,aAAa,EACb,WAAW,EAEX,KAAK,EACL,MAAM,EACN,MAAM,EAEP,MAAM,SAAS,CAAC;AACjB,OAAO,EACL,QAAQ,EACR,qBAAqB,EAItB,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,iBAAiB,EAAY,MAAM,YAAY,CAAC;AACzD,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AACpD,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,KAAK,EAAE,aAAa,EAAE,gBAAgB,EAAa,MAAM,YAAY,CAAC;AAC/E,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,IAAI,EAAY,MAAM,gBAAgB,CAAC;AAEhD,MAAM,WAAW,KAAK,CAAC,CAAC,SAAS,MAAM;IACrC,QAAQ,CAAC,cAAc,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC;IACjD,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC;IAE1C,QAAQ,CAAC,cAAc,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC;IACjD,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC;IAE1C,QAAQ,CAAC,cAAc,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC;IACjD,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC;IAC1C,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IACrC,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC;IAE5C,QAAQ,CAAC,kBAAkB,EAAE,CAAC,QAAQ,EAAE,aAAa,KAAK,gBAAgB,CAAC;IAC3E,QAAQ,CAAC,YAAY,EAAE,MAAM,SAAS,CAAC;IAEvC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAC3B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAE3B,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IACpC,QAAQ,CAAC,YAAY,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;CACjD;AAED,eAAO,MAAM,KAAK,yDACoB,CAAC;AAEvC,KAAK,UAAU,GAAG,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC;AAE3C,KAAK,UAAU,GAAG,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;AAEtC,UAAU,UAAU;IAClB,QAAQ,CAAC,SAAS,EAAE,CAClB,KAAK,EAAE,KAAK,GAAG,IAAI,KAChB,CAAC,QAAQ,EAAE,aAAa,KAAK,gBAAgB,CAAC;IACnD,QAAQ,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,KAAK,aAAa,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;IACtE,QAAQ,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC;IAClE,QAAQ,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE,qBAAqB,KAAK,IAAI,CAAC;CAC3D;AAED,QAAA,MAAM,UAAU,qCAA8C,CAAC;AAE/D,MAAM,MAAM,MAAM,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,CAAC,SAAS,MAAM,CAAC,EACvD,KAAK,EAAE,CAAC,EACR,MAAM,EAAE,QAAQ,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,EAC7E,UAAU,CAAC,EAAE,MAAM,IAAI,KACpB;IACH,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;CACzB,CAAC;AAGF,KAAK,sBAAsB,CACzB,CAAC,EACD,EAAE,SAAS,MAAM,CAAC,GAAG;KAClB,CAAC,IAAI,MAAM,CAAC,GAAG,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK;CAC9C,CAAC,MAAM,CAAC,CAAC,EACV,EAAE,GAAG,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IACvD;KAAG,CAAC,IAAI,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;CAAE,CAAC;AAE/B,MAAM,MAAM,MAAM,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,CAAC,SAAS,MAAM,CAAC,EACvD,KAAK,EAAE,CAAC,EACR,MAAM,EAAE,QAAQ,CACd,OAAO,CACL,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,IAAI,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC,CACvE,GAAG;IAAE,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;CAAE,CAChC,EACD,UAAU,CAAC,EAAE,MAAM,IAAI,KACpB;IACH,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;CACzB,CAAC;AAwBF,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,IAAI,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,CAChB,QAAQ,EAAE,MAAM,KACb,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC,CAAC;CACtD;AAID,UAAU,iBAAiB;IACzB,QAAQ,CAAC,IAAI,EAAE,mBAAmB,CAAC;CACpC;AAyBD,eAAO,MAAM,0BAA0B,SAAS,CAAC;AAgNjD,eAAO,MAAM,SAAS,sIA8HnB,CAAC;AAEJ,eAAO,MAAM,oBAAoB,oCAChB,WAAW,CACxB,KAAK,EACL,KAAK,EACL,QAAQ,GAAG,KAAK,GAAG,MAAM,GAAG,SAAS,GAAG,QAAQ,CACjD,2BAEQ,QAAQ,MAAM,CAAC,aAQF,CAAC"}