@syncular/dialect-wa-sqlite 0.0.6-72 → 0.0.6-79
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 +7 -3
- package/dist/index.d.ts +0 -21
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +0 -30
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/index.ts +2 -40
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @syncular/dialect-wa-sqlite
|
|
2
2
|
|
|
3
|
-
wa-sqlite (WASM) Kysely dialect for browser SQLite
|
|
3
|
+
wa-sqlite (WASM) Kysely dialect for browser SQLite.
|
|
4
4
|
|
|
5
5
|
## Install
|
|
6
6
|
|
|
@@ -11,9 +11,13 @@ npm install @syncular/dialect-wa-sqlite
|
|
|
11
11
|
## Usage
|
|
12
12
|
|
|
13
13
|
```ts
|
|
14
|
-
import {
|
|
14
|
+
import { createDatabase } from '@syncular/core';
|
|
15
|
+
import { createWaSqliteDialect } from '@syncular/dialect-wa-sqlite';
|
|
15
16
|
|
|
16
|
-
const db =
|
|
17
|
+
const db = createDatabase<MyDb>({
|
|
18
|
+
dialect: createWaSqliteDialect({ fileName: 'app.sqlite' }),
|
|
19
|
+
family: 'sqlite',
|
|
20
|
+
});
|
|
17
21
|
```
|
|
18
22
|
|
|
19
23
|
## Documentation
|
package/dist/index.d.ts
CHANGED
|
@@ -4,7 +4,6 @@
|
|
|
4
4
|
* Provides a Kysely dialect for wa-sqlite (browser SQLite via WebAssembly).
|
|
5
5
|
* Uses kysely-wasqlite-worker for running SQL in a web worker with OPFS or IndexedDB storage.
|
|
6
6
|
*/
|
|
7
|
-
import { Kysely } from 'kysely';
|
|
8
7
|
import { GenericSqliteDialect } from 'kysely-generic-sqlite';
|
|
9
8
|
import { WaSqliteWorkerDialect, type WaSqliteWorkerDialectConfig } from 'kysely-wasqlite-worker';
|
|
10
9
|
export interface WaSqliteOptions extends Omit<WaSqliteWorkerDialectConfig, 'fileName'> {
|
|
@@ -19,30 +18,10 @@ export interface WaSqliteMainThreadOptions {
|
|
|
19
18
|
/** WASM URL override */
|
|
20
19
|
url?: string;
|
|
21
20
|
}
|
|
22
|
-
/**
|
|
23
|
-
* Create a Kysely instance with wa-sqlite dialect.
|
|
24
|
-
*
|
|
25
|
-
* @example
|
|
26
|
-
* // In-memory database
|
|
27
|
-
* const db = createWaSqliteDb<MyDb>();
|
|
28
|
-
*
|
|
29
|
-
* // OPFS-persisted database
|
|
30
|
-
* const db = createWaSqliteDb<MyDb>({
|
|
31
|
-
* fileName: 'mydb.sqlite',
|
|
32
|
-
* });
|
|
33
|
-
*/
|
|
34
|
-
export declare function createWaSqliteDb<T>(options?: WaSqliteOptions): Kysely<T>;
|
|
35
21
|
/**
|
|
36
22
|
* Create the wa-sqlite dialect directly.
|
|
37
23
|
*/
|
|
38
24
|
export declare function createWaSqliteDialect(options?: WaSqliteOptions): WaSqliteWorkerDialect;
|
|
39
|
-
/**
|
|
40
|
-
* Create a Kysely instance with wa-sqlite running in the current thread.
|
|
41
|
-
*
|
|
42
|
-
* Useful when nested Worker support is unavailable (for example, in
|
|
43
|
-
* ServiceWorker runtimes).
|
|
44
|
-
*/
|
|
45
|
-
export declare function createWaSqliteMainThreadDb<T>(options?: WaSqliteMainThreadOptions): Kysely<T>;
|
|
46
25
|
/**
|
|
47
26
|
* Create the wa-sqlite main-thread dialect directly.
|
|
48
27
|
*/
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,EAIL,qBAAqB,EACrB,KAAK,2BAA2B,EACjC,MAAM,wBAAwB,CAAC;AAEhC,MAAM,WAAW,eACf,SAAQ,IAAI,CAAC,2BAA2B,EAAE,UAAU,CAAC;IACrD,qEAAqE;IACrE,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,yBAAyB;IACxC,qEAAqE;IACrE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,4DAA4D;IAC5D,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,wBAAwB;IACxB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAWD;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,CAAC,EAAE,eAAe,yBAE9D;AAUD;;GAEG;AACH,wBAAgB,+BAA+B,CAC7C,OAAO,CAAC,EAAE,yBAAyB,wBAMpC;AAED,wBAAgB,gCAAgC,IAAI;IAClD,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAIA;AAED,wBAAgB,oBAAoB,IAAI;IACtC,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;CACtB,CAQA"}
|
package/dist/index.js
CHANGED
|
@@ -4,7 +4,6 @@
|
|
|
4
4
|
* Provides a Kysely dialect for wa-sqlite (browser SQLite via WebAssembly).
|
|
5
5
|
* Uses kysely-wasqlite-worker for running SQL in a web worker with OPFS or IndexedDB storage.
|
|
6
6
|
*/
|
|
7
|
-
import { Kysely } from 'kysely';
|
|
8
7
|
import { GenericSqliteDialect } from 'kysely-generic-sqlite';
|
|
9
8
|
import { createSqliteExecutor, defaultCreateDatabaseFn, WaSqliteWorkerDialect, } from 'kysely-wasqlite-worker';
|
|
10
9
|
function toDialectConfig(options) {
|
|
@@ -13,23 +12,6 @@ function toDialectConfig(options) {
|
|
|
13
12
|
...options,
|
|
14
13
|
};
|
|
15
14
|
}
|
|
16
|
-
/**
|
|
17
|
-
* Create a Kysely instance with wa-sqlite dialect.
|
|
18
|
-
*
|
|
19
|
-
* @example
|
|
20
|
-
* // In-memory database
|
|
21
|
-
* const db = createWaSqliteDb<MyDb>();
|
|
22
|
-
*
|
|
23
|
-
* // OPFS-persisted database
|
|
24
|
-
* const db = createWaSqliteDb<MyDb>({
|
|
25
|
-
* fileName: 'mydb.sqlite',
|
|
26
|
-
* });
|
|
27
|
-
*/
|
|
28
|
-
export function createWaSqliteDb(options) {
|
|
29
|
-
return new Kysely({
|
|
30
|
-
dialect: new WaSqliteWorkerDialect(toDialectConfig(options)),
|
|
31
|
-
});
|
|
32
|
-
}
|
|
33
15
|
/**
|
|
34
16
|
* Create the wa-sqlite dialect directly.
|
|
35
17
|
*/
|
|
@@ -43,18 +25,6 @@ function toMainThreadInitData(options) {
|
|
|
43
25
|
url: options?.url,
|
|
44
26
|
};
|
|
45
27
|
}
|
|
46
|
-
/**
|
|
47
|
-
* Create a Kysely instance with wa-sqlite running in the current thread.
|
|
48
|
-
*
|
|
49
|
-
* Useful when nested Worker support is unavailable (for example, in
|
|
50
|
-
* ServiceWorker runtimes).
|
|
51
|
-
*/
|
|
52
|
-
export function createWaSqliteMainThreadDb(options) {
|
|
53
|
-
const initData = toMainThreadInitData(options);
|
|
54
|
-
return new Kysely({
|
|
55
|
-
dialect: new GenericSqliteDialect(async () => createSqliteExecutor(await defaultCreateDatabaseFn(initData))),
|
|
56
|
-
});
|
|
57
|
-
}
|
|
58
28
|
/**
|
|
59
29
|
* Create the wa-sqlite main-thread dialect directly.
|
|
60
30
|
*/
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,EACL,oBAAoB,EACpB,uBAAuB,EAEvB,qBAAqB,GAEtB,MAAM,wBAAwB,CAAC;AAiBhC,SAAS,eAAe,CACtB,OAAyB,EACI;IAC7B,OAAO;QACL,QAAQ,EAAE,OAAO,EAAE,QAAQ,IAAI,cAAc;QAC7C,GAAG,OAAO;KACX,CAAC;AAAA,CACH;AAED;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,OAAyB,EAAE;IAC/D,OAAO,IAAI,qBAAqB,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC;AAAA,CAC5D;AAED,SAAS,oBAAoB,CAAC,OAAmC,EAAY;IAC3E,OAAO;QACL,QAAQ,EAAE,OAAO,EAAE,QAAQ,IAAI,cAAc;QAC7C,OAAO,EAAE,OAAO,EAAE,OAAO,IAAI,IAAI;QACjC,GAAG,EAAE,OAAO,EAAE,GAAG;KAClB,CAAC;AAAA,CACH;AAED;;GAEG;AACH,MAAM,UAAU,+BAA+B,CAC7C,OAAmC,EACnC;IACA,MAAM,QAAQ,GAAG,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAC/C,OAAO,IAAI,oBAAoB,CAAC,KAAK,IAAI,EAAE,CACzC,oBAAoB,CAAC,MAAM,uBAAuB,CAAC,QAAQ,CAAC,CAAC,CAC9D,CAAC;AAAA,CACH;AAED,MAAM,UAAU,gCAAgC,GAE9C;IACA,OAAO;QACL,gBAAgB,EAAE,IAAI,GAAG,CAAC,oBAAoB,EAAE,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,QAAQ;KAC1E,CAAC;AAAA,CACH;AAED,MAAM,UAAU,oBAAoB,GAGlC;IACA,OAAO;QACL,aAAa,EAAE,IAAI,GAAG,CACpB,OAAO,IAAI,CAAC,OAAO,CAAC,sCAAsC,CAAC,CAC5D,CAAC,QAAQ;QACV,YAAY,EAAE,IAAI,GAAG,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,gCAAgC,CAAC,CAAC;aACzE,QAAQ;KACZ,CAAC;AAAA,CACH"}
|
package/package.json
CHANGED
package/src/index.ts
CHANGED
|
@@ -5,7 +5,6 @@
|
|
|
5
5
|
* Uses kysely-wasqlite-worker for running SQL in a web worker with OPFS or IndexedDB storage.
|
|
6
6
|
*/
|
|
7
7
|
|
|
8
|
-
import { Kysely } from 'kysely';
|
|
9
8
|
import { GenericSqliteDialect } from 'kysely-generic-sqlite';
|
|
10
9
|
import {
|
|
11
10
|
createSqliteExecutor,
|
|
@@ -39,30 +38,10 @@ function toDialectConfig(
|
|
|
39
38
|
};
|
|
40
39
|
}
|
|
41
40
|
|
|
42
|
-
/**
|
|
43
|
-
* Create a Kysely instance with wa-sqlite dialect.
|
|
44
|
-
*
|
|
45
|
-
* @example
|
|
46
|
-
* // In-memory database
|
|
47
|
-
* const db = createWaSqliteDb<MyDb>();
|
|
48
|
-
*
|
|
49
|
-
* // OPFS-persisted database
|
|
50
|
-
* const db = createWaSqliteDb<MyDb>({
|
|
51
|
-
* fileName: 'mydb.sqlite',
|
|
52
|
-
* });
|
|
53
|
-
*/
|
|
54
|
-
export function createWaSqliteDb<T>(options?: WaSqliteOptions): Kysely<T> {
|
|
55
|
-
return new Kysely<T>({
|
|
56
|
-
dialect: new WaSqliteWorkerDialect(toDialectConfig(options)),
|
|
57
|
-
});
|
|
58
|
-
}
|
|
59
|
-
|
|
60
41
|
/**
|
|
61
42
|
* Create the wa-sqlite dialect directly.
|
|
62
43
|
*/
|
|
63
|
-
export function createWaSqliteDialect(
|
|
64
|
-
options?: WaSqliteOptions
|
|
65
|
-
): WaSqliteWorkerDialect {
|
|
44
|
+
export function createWaSqliteDialect(options?: WaSqliteOptions) {
|
|
66
45
|
return new WaSqliteWorkerDialect(toDialectConfig(options));
|
|
67
46
|
}
|
|
68
47
|
|
|
@@ -74,29 +53,12 @@ function toMainThreadInitData(options?: WaSqliteMainThreadOptions): InitData {
|
|
|
74
53
|
};
|
|
75
54
|
}
|
|
76
55
|
|
|
77
|
-
/**
|
|
78
|
-
* Create a Kysely instance with wa-sqlite running in the current thread.
|
|
79
|
-
*
|
|
80
|
-
* Useful when nested Worker support is unavailable (for example, in
|
|
81
|
-
* ServiceWorker runtimes).
|
|
82
|
-
*/
|
|
83
|
-
export function createWaSqliteMainThreadDb<T>(
|
|
84
|
-
options?: WaSqliteMainThreadOptions
|
|
85
|
-
): Kysely<T> {
|
|
86
|
-
const initData = toMainThreadInitData(options);
|
|
87
|
-
return new Kysely<T>({
|
|
88
|
-
dialect: new GenericSqliteDialect(async () =>
|
|
89
|
-
createSqliteExecutor(await defaultCreateDatabaseFn(initData))
|
|
90
|
-
),
|
|
91
|
-
});
|
|
92
|
-
}
|
|
93
|
-
|
|
94
56
|
/**
|
|
95
57
|
* Create the wa-sqlite main-thread dialect directly.
|
|
96
58
|
*/
|
|
97
59
|
export function createWaSqliteMainThreadDialect(
|
|
98
60
|
options?: WaSqliteMainThreadOptions
|
|
99
|
-
)
|
|
61
|
+
) {
|
|
100
62
|
const initData = toMainThreadInitData(options);
|
|
101
63
|
return new GenericSqliteDialect(async () =>
|
|
102
64
|
createSqliteExecutor(await defaultCreateDatabaseFn(initData))
|