@effect/sql-sqlite-react-native 4.0.0-beta.70 → 4.0.0-beta.72
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/SqliteClient.d.ts +7 -2
- package/dist/SqliteClient.d.ts.map +1 -1
- package/dist/SqliteClient.js +38 -14
- package/dist/SqliteClient.js.map +1 -1
- package/dist/index.d.ts +0 -33
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +0 -33
- package/dist/index.js.map +1 -1
- package/package.json +3 -3
- package/src/SqliteClient.ts +38 -14
- package/src/index.ts +0 -33
package/dist/SqliteClient.d.ts
CHANGED
|
@@ -32,7 +32,7 @@ export interface SqliteClient extends Client.SqlClient {
|
|
|
32
32
|
readonly updateValues: never;
|
|
33
33
|
}
|
|
34
34
|
/**
|
|
35
|
-
*
|
|
35
|
+
* Service tag for the React Native SQLite client.
|
|
36
36
|
*
|
|
37
37
|
* @category tags
|
|
38
38
|
* @since 4.0.0
|
|
@@ -53,7 +53,12 @@ export interface SqliteClientConfig {
|
|
|
53
53
|
readonly transformQueryNames?: ((str: string) => string) | undefined;
|
|
54
54
|
}
|
|
55
55
|
/**
|
|
56
|
-
* Fiber
|
|
56
|
+
* Fiber reference that makes the React Native SQLite client run queries through the asynchronous `execute` API instead of `executeSync`.
|
|
57
|
+
*
|
|
58
|
+
* **When to use**
|
|
59
|
+
*
|
|
60
|
+
* Use to switch React Native SQLite query execution to the asynchronous driver
|
|
61
|
+
* API for a scoped effect.
|
|
57
62
|
*
|
|
58
63
|
* @category fiber refs
|
|
59
64
|
* @since 4.0.0
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SqliteClient.d.ts","sourceRoot":"","sources":["../src/SqliteClient.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"SqliteClient.d.ts","sourceRoot":"","sources":["../src/SqliteClient.ts"],"names":[],"mappings":"AAsCA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AACzC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAGvC,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AACrC,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AAGrC,OAAO,KAAK,UAAU,MAAM,uCAAuC,CAAA;AACnE,OAAO,KAAK,MAAM,MAAM,+BAA+B,CAAA;AAUvD;;;;;GAKG;AACH,eAAO,MAAM,MAAM,EAAE,MAAwD,CAAA;AAE7E;;;;;GAKG;AACH,MAAM,MAAM,MAAM,GAAG,+CAA+C,CAAA;AAEpE;;;;;GAKG;AACH,MAAM,WAAW,YAAa,SAAQ,MAAM,CAAC,SAAS;IACpD,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,MAAM,EAAE,kBAAkB,CAAA;IAEnC,8BAA8B;IAC9B,QAAQ,CAAC,YAAY,EAAE,KAAK,CAAA;CAC7B;AAED;;;;;GAKG;AACH,eAAO,MAAM,YAAY,6CAAgF,CAAA;AAEzG;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACtC,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3C,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;IAC7D,QAAQ,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC,GAAG,SAAS,CAAA;IACrE,QAAQ,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC,GAAG,SAAS,CAAA;CACrE;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,UAAU,4BAGtB,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,QAAQ,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,2CACrB,CAAA;AAIjD;;;;;GAKG;AACH,eAAO,MAAM,IAAI,GACf,SAAS,kBAAkB,KAC1B,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,GAAG,UAAU,CAAC,UAAU,CAmGrE,CAAA;AAEJ;;;;;GAKG;AACH,eAAO,MAAM,WAAW,GACtB,QAAQ,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,KACtC,KAAK,CAAC,KAAK,CAAC,YAAY,GAAG,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,WAAW,CAUzB,CAAA;AAEzC;;;;;GAKG;AACH,eAAO,MAAM,KAAK,GAChB,QAAQ,kBAAkB,KACzB,KAAK,CAAC,KAAK,CAAC,YAAY,GAAG,MAAM,CAAC,SAAS,CAML,CAAA"}
|
package/dist/SqliteClient.js
CHANGED
|
@@ -1,18 +1,37 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
2
|
+
* React Native SQLite client implementation for Effect SQL, backed by
|
|
3
|
+
* `@op-engineering/op-sqlite`.
|
|
3
4
|
*
|
|
4
|
-
*
|
|
5
|
-
* React Native-specific `SqliteClient` and the generic Effect
|
|
6
|
-
*
|
|
7
|
-
*
|
|
5
|
+
* This module opens an on-device SQLite database and exposes it as both the
|
|
6
|
+
* React Native-specific `SqliteClient` service and the generic Effect
|
|
7
|
+
* `SqlClient` service. Use it for mobile application storage, offline caches,
|
|
8
|
+
* local migrations, sync queues, and tests that need the same SQLite driver as
|
|
9
|
+
* the app runtime.
|
|
8
10
|
*
|
|
9
|
-
*
|
|
10
|
-
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
11
|
+
* **Mental model**
|
|
12
|
+
*
|
|
13
|
+
* A client owns one scoped op-sqlite database handle configured with the
|
|
14
|
+
* provided `filename`, optional `location`, and optional `encryptionKey`.
|
|
15
|
+
* Queries are compiled through the Effect SQL SQLite compiler and serialized
|
|
16
|
+
* through that single handle. A transaction keeps the serialized connection
|
|
17
|
+
* permit for the whole transaction scope, so other fibers using the same client
|
|
18
|
+
* wait until the transaction finishes.
|
|
19
|
+
*
|
|
20
|
+
* **Common tasks**
|
|
21
|
+
*
|
|
22
|
+
* Use `layer` when a React Native app should provide both `SqliteClient` and
|
|
23
|
+
* the generic `SqlClient` from a concrete configuration, `layerConfig` when the
|
|
24
|
+
* configuration should come from Effect `Config`, and `make` inside a custom
|
|
25
|
+
* scoped layer when you need direct lifecycle control. Use `withAsyncQuery`
|
|
26
|
+
* around UI-sensitive effects or longer migration steps to run statements with
|
|
27
|
+
* the driver's asynchronous API instead of the default synchronous API.
|
|
28
|
+
*
|
|
29
|
+
* **Gotchas**
|
|
30
|
+
*
|
|
31
|
+
* The default synchronous op-sqlite API can block the JavaScript thread, so keep
|
|
32
|
+
* transactions short and wrap multi-statement writes in a transaction to avoid
|
|
33
|
+
* partial updates. `executeStream` is not implemented for this driver, and
|
|
34
|
+
* SQLite does not support `updateValues`.
|
|
16
35
|
*
|
|
17
36
|
* @since 4.0.0
|
|
18
37
|
*/
|
|
@@ -43,14 +62,19 @@ const classifyError = (cause, message, operation) => classifySqliteError(cause,
|
|
|
43
62
|
*/
|
|
44
63
|
export const TypeId = "~@effect/sql-sqlite-react-native/SqliteClient";
|
|
45
64
|
/**
|
|
46
|
-
*
|
|
65
|
+
* Service tag for the React Native SQLite client.
|
|
47
66
|
*
|
|
48
67
|
* @category tags
|
|
49
68
|
* @since 4.0.0
|
|
50
69
|
*/
|
|
51
70
|
export const SqliteClient = /*#__PURE__*/Context.Service("@effect/sql-sqlite-react-native/SqliteClient");
|
|
52
71
|
/**
|
|
53
|
-
* Fiber
|
|
72
|
+
* Fiber reference that makes the React Native SQLite client run queries through the asynchronous `execute` API instead of `executeSync`.
|
|
73
|
+
*
|
|
74
|
+
* **When to use**
|
|
75
|
+
*
|
|
76
|
+
* Use to switch React Native SQLite query execution to the asynchronous driver
|
|
77
|
+
* API for a scoped effect.
|
|
54
78
|
*
|
|
55
79
|
* @category fiber refs
|
|
56
80
|
* @since 4.0.0
|
package/dist/SqliteClient.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SqliteClient.js","names":["Sqlite","Config","Context","Effect","Fiber","constFalse","identity","Layer","Scope","Semaphore","Stream","Reactivity","Client","classifySqliteError","SqlError","Statement","ATTR_DB_SYSTEM_NAME","classifyError","cause","message","operation","TypeId","SqliteClient","Service","AsyncQuery","Reference","defaultValue","withAsyncQuery","effect","provideService","make","options","gen","clientOptions","name","filename","location","encryptionKey","compiler","makeCompilerSqlite","transformQueryNames","transformRows","transformResultNames","defaultTransforms","array","undefined","makeConnection","db","open","addFinalizer","sync","close","run","sql","params","values","withFiber","fiber","getRef","map","tryPromise","try","execute","catch","reason","result","rawRows","rows","executeSync","executeRaw","executeValues","executeUnprepared","executeStream","die","semaphore","connection","acquirer","withPermits","succeed","transactionAcquirer","uninterruptibleMask","restore","getCurrent","scope","getUnsafe","context","as","tap","take","release","Object","assign","spanAttributes","entries","config","layerConfig","effectContext","unwrap","pipe","flatMap","client","add","SqlClient","provide","layer"],"sources":["../src/SqliteClient.ts"],"sourcesContent":[null],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"SqliteClient.js","names":["Sqlite","Config","Context","Effect","Fiber","constFalse","identity","Layer","Scope","Semaphore","Stream","Reactivity","Client","classifySqliteError","SqlError","Statement","ATTR_DB_SYSTEM_NAME","classifyError","cause","message","operation","TypeId","SqliteClient","Service","AsyncQuery","Reference","defaultValue","withAsyncQuery","effect","provideService","make","options","gen","clientOptions","name","filename","location","encryptionKey","compiler","makeCompilerSqlite","transformQueryNames","transformRows","transformResultNames","defaultTransforms","array","undefined","makeConnection","db","open","addFinalizer","sync","close","run","sql","params","values","withFiber","fiber","getRef","map","tryPromise","try","execute","catch","reason","result","rawRows","rows","executeSync","executeRaw","executeValues","executeUnprepared","executeStream","die","semaphore","connection","acquirer","withPermits","succeed","transactionAcquirer","uninterruptibleMask","restore","getCurrent","scope","getUnsafe","context","as","tap","take","release","Object","assign","spanAttributes","entries","config","layerConfig","effectContext","unwrap","pipe","flatMap","client","add","SqlClient","provide","layer"],"sources":["../src/SqliteClient.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqCA,OAAO,KAAKA,MAAM,MAAM,2BAA2B;AACnD,OAAO,KAAKC,MAAM,MAAM,eAAe;AACvC,OAAO,KAAKC,OAAO,MAAM,gBAAgB;AACzC,OAAO,KAAKC,MAAM,MAAM,eAAe;AACvC,OAAO,KAAKC,KAAK,MAAM,cAAc;AACrC,SAASC,UAAU,EAAEC,QAAQ,QAAQ,iBAAiB;AACtD,OAAO,KAAKC,KAAK,MAAM,cAAc;AACrC,OAAO,KAAKC,KAAK,MAAM,cAAc;AACrC,OAAO,KAAKC,SAAS,MAAM,kBAAkB;AAC7C,OAAO,KAAKC,MAAM,MAAM,eAAe;AACvC,OAAO,KAAKC,UAAU,MAAM,uCAAuC;AACnE,OAAO,KAAKC,MAAM,MAAM,+BAA+B;AAEvD,SAASC,mBAAmB,EAAEC,QAAQ,QAAQ,8BAA8B;AAC5E,OAAO,KAAKC,SAAS,MAAM,+BAA+B;AAE1D,MAAMC,mBAAmB,GAAG,gBAAgB;AAE5C,MAAMC,aAAa,GAAGA,CAACC,KAAc,EAAEC,OAAe,EAAEC,SAAiB,KACvEP,mBAAmB,CAACK,KAAK,EAAE;EAAEC,OAAO;EAAEC;AAAS,CAAE,CAAC;AAEpD;;;;;;AAMA,OAAO,MAAMC,MAAM,GAAW,+CAA+C;AAwB7E;;;;;;AAMA,OAAO,MAAMC,YAAY,gBAAGpB,OAAO,CAACqB,OAAO,CAAe,8CAA8C,CAAC;AAiBzG;;;;;;;;;;;AAWA,OAAO,MAAMC,UAAU,gBAAGtB,OAAO,CAACuB,SAAS,CACzC,mDAAmD,EACnD;EAAEC,YAAY,EAAErB;AAAU,CAAE,CAC7B;AAED;;;;;;AAMA,OAAO,MAAMsB,cAAc,GAAaC,MAA8B,IACpEzB,MAAM,CAAC0B,cAAc,CAACD,MAAM,EAAEJ,UAAU,EAAE,IAAI,CAAC;AAIjD;;;;;;AAMA,OAAO,MAAMM,IAAI,GACfC,OAA2B,IAE3B5B,MAAM,CAAC6B,GAAG,CAAC,aAAS;EAClB,MAAMC,aAAa,GAAsC;IACvDC,IAAI,EAAEH,OAAO,CAACI;GACf;EACD,IAAIJ,OAAO,CAACK,QAAQ,EAAE;IACpBH,aAAa,CAACG,QAAQ,GAAGL,OAAO,CAACK,QAAQ;EAC3C;EACA,IAAIL,OAAO,CAACM,aAAa,EAAE;IACzBJ,aAAa,CAACI,aAAa,GAAGN,OAAO,CAACM,aAAa;EACrD;EAEA,MAAMC,QAAQ,GAAGvB,SAAS,CAACwB,kBAAkB,CAACR,OAAO,CAACS,mBAAmB,CAAC;EAC1E,MAAMC,aAAa,GAAGV,OAAO,CAACW,oBAAoB,GAChD3B,SAAS,CAAC4B,iBAAiB,CAACZ,OAAO,CAACW,oBAAoB,CAAC,CAACE,KAAK,GAC/DC,SAAS;EAEX,MAAMC,cAAc,GAAG3C,MAAM,CAAC6B,GAAG,CAAC,aAAS;IACzC,MAAMe,EAAE,GAAG/C,MAAM,CAACgD,IAAI,CAACf,aAAa,CAAO;IAC3C,OAAO9B,MAAM,CAAC8C,YAAY,CAAC,MAAM9C,MAAM,CAAC+C,IAAI,CAAC,MAAMH,EAAE,CAACI,KAAK,EAAE,CAAC,CAAC;IAE/D,MAAMC,GAAG,GAAGA,CACVC,GAAW,EACXC,MAAA,GAAiC,EAAE,EACnCC,MAAM,GAAG,KAAK,KAEdpD,MAAM,CAACqD,SAAS,CAAwBC,KAAK,IAAI;MAC/C,IAAIA,KAAK,CAACC,MAAM,CAAClC,UAAU,CAAC,EAAE;QAC5B,OAAOrB,MAAM,CAACwD,GAAG,CACfxD,MAAM,CAACyD,UAAU,CAAC;UAChBC,GAAG,EAAEA,CAAA,KAAMd,EAAE,CAACe,OAAO,CAACT,GAAG,EAAEC,MAAoB,CAAC;UAChDS,KAAK,EAAG7C,KAAK,IACX,IAAIJ,QAAQ,CAAC;YAAEkD,MAAM,EAAE/C,aAAa,CAACC,KAAK,EAAE,qCAAqC,EAAE,SAAS;UAAC,CAAE;SAClG,CAAC,EACD+C,MAAM,IAAKV,MAAM,GAAGU,MAAM,CAACC,OAAO,IAAI,EAAE,GAAGD,MAAM,CAACE,IAAI,CACxD;MACH;MACA,OAAOhE,MAAM,CAAC0D,GAAG,CAAC;QAChBA,GAAG,EAAEA,CAAA,KAAK;UACR,MAAMI,MAAM,GAAGlB,EAAE,CAACqB,WAAW,CAACf,GAAG,EAAEC,MAAoB,CAAC;UACxD,OAAOC,MAAM,GAAGU,MAAM,CAACC,OAAO,IAAI,EAAE,GAAGD,MAAM,CAACE,IAAI;QACpD,CAAC;QACDJ,KAAK,EAAG7C,KAAK,IAAK,IAAIJ,QAAQ,CAAC;UAAEkD,MAAM,EAAE/C,aAAa,CAACC,KAAK,EAAE,6BAA6B,EAAE,SAAS;QAAC,CAAE;OAC1G,CAAC;IACJ,CAAC,CAAC;IAEJ,OAAOZ,QAAQ,CAAmB;MAChCwD,OAAOA,CAACT,GAAG,EAAEC,MAAM,EAAEb,aAAa;QAChC,OAAOA,aAAa,GAChBtC,MAAM,CAACwD,GAAG,CAACP,GAAG,CAACC,GAAG,EAAEC,MAAM,CAAC,EAAEb,aAAa,CAAC,GAC3CW,GAAG,CAACC,GAAG,EAAEC,MAAM,CAAC;MACtB,CAAC;MACDe,UAAUA,CAAChB,GAAG,EAAEC,MAAM;QACpB,OAAOF,GAAG,CAACC,GAAG,EAAEC,MAAM,CAAC;MACzB,CAAC;MACDgB,aAAaA,CAACjB,GAAG,EAAEC,MAAM;QACvB,OAAOF,GAAG,CAACC,GAAG,EAAEC,MAAM,EAAE,IAAI,CAAC;MAC/B,CAAC;MACDiB,iBAAiBA,CAAClB,GAAG,EAAEC,MAAM,EAAEb,aAAa;QAC1C,OAAO,IAAI,CAACqB,OAAO,CAACT,GAAG,EAAEC,MAAM,EAAEb,aAAa,CAAC;MACjD,CAAC;MACD+B,aAAaA,CAAA;QACX,OAAO9D,MAAM,CAAC+D,GAAG,CAAC,+BAA+B,CAAC;MACpD;KACD,CAAC;EACJ,CAAC,CAAC;EAEF,MAAMC,SAAS,GAAG,OAAOjE,SAAS,CAACqB,IAAI,CAAC,CAAC,CAAC;EAC1C,MAAM6C,UAAU,GAAG,OAAO7B,cAAc;EAExC,MAAM8B,QAAQ,GAAGF,SAAS,CAACG,WAAW,CAAC,CAAC,CAAC,CAAC1E,MAAM,CAAC2E,OAAO,CAACH,UAAU,CAAC,CAAC;EACrE,MAAMI,mBAAmB,GAAG5E,MAAM,CAAC6E,mBAAmB,CAAEC,OAAO,IAAI;IACjE,MAAMxB,KAAK,GAAGrD,KAAK,CAAC8E,UAAU,EAAG;IACjC,MAAMC,KAAK,GAAGjF,OAAO,CAACkF,SAAS,CAAC3B,KAAK,CAAC4B,OAAO,EAAE7E,KAAK,CAACA,KAAK,CAAC;IAC3D,OAAOL,MAAM,CAACmF,EAAE,CACdnF,MAAM,CAACoF,GAAG,CACRN,OAAO,CAACP,SAAS,CAACc,IAAI,CAAC,CAAC,CAAC,CAAC,EAC1B,MAAMhF,KAAK,CAACyC,YAAY,CAACkC,KAAK,EAAET,SAAS,CAACe,OAAO,CAAC,CAAC,CAAC,CAAC,CACtD,EACDd,UAAU,CACX;EACH,CAAC,CAAC;EAEF,OAAOe,MAAM,CAACC,MAAM,CACjB,OAAO/E,MAAM,CAACkB,IAAI,CAAC;IAClB8C,QAAQ;IACRtC,QAAQ;IACRyC,mBAAmB;IACnBa,cAAc,EAAE,CACd,IAAI7D,OAAO,CAAC6D,cAAc,GAAGF,MAAM,CAACG,OAAO,CAAC9D,OAAO,CAAC6D,cAAc,CAAC,GAAG,EAAE,CAAC,EACzE,CAAC5E,mBAAmB,EAAE,QAAQ,CAAC,CAChC;IACDyB;GACD,CAAC,EACF;IACE,CAACpB,MAAM,GAAGA,MAAM;IAChByE,MAAM,EAAE/D;GACT,CACF;AACH,CAAC,CAAC;AAEJ;;;;;;AAMA,OAAO,MAAMgE,WAAW,GACtBD,MAAuC,IAEvCvF,KAAK,CAACyF,aAAa,CACjB/F,MAAM,CAACgG,MAAM,CAACH,MAAM,CAAC,CAACI,IAAI,CACxB/F,MAAM,CAACgG,OAAO,CAACrE,IAAI,CAAC,EACpB3B,MAAM,CAACwD,GAAG,CAAEyC,MAAM,IAChBlG,OAAO,CAAC4B,IAAI,CAACR,YAAY,EAAE8E,MAAM,CAAC,CAACF,IAAI,CACrChG,OAAO,CAACmG,GAAG,CAACzF,MAAM,CAAC0F,SAAS,EAAEF,MAAM,CAAC,CACtC,CACF,CACF,CACF,CAACF,IAAI,CAAC3F,KAAK,CAACgG,OAAO,CAAC5F,UAAU,CAAC6F,KAAK,CAAC,CAAC;AAEzC;;;;;;AAMA,OAAO,MAAMA,KAAK,GAChBV,MAA0B,IAE1BvF,KAAK,CAACyF,aAAa,CACjB7F,MAAM,CAACwD,GAAG,CAAC7B,IAAI,CAACgE,MAAM,CAAC,EAAGM,MAAM,IAC9BlG,OAAO,CAAC4B,IAAI,CAACR,YAAY,EAAE8E,MAAM,CAAC,CAACF,IAAI,CACrChG,OAAO,CAACmG,GAAG,CAACzF,MAAM,CAAC0F,SAAS,EAAEF,MAAM,CAAC,CACtC,CAAC,CACL,CAACF,IAAI,CAAC3F,KAAK,CAACgG,OAAO,CAAC5F,UAAU,CAAC6F,KAAK,CAAC,CAAC","ignoreList":[]}
|
package/dist/index.d.ts
CHANGED
|
@@ -2,43 +2,10 @@
|
|
|
2
2
|
* @since 4.0.0
|
|
3
3
|
*/
|
|
4
4
|
/**
|
|
5
|
-
* Provides a React Native SQLite `SqlClient` backed by `@op-engineering/op-sqlite`.
|
|
6
|
-
*
|
|
7
|
-
* Use this module to open an on-device SQLite database, expose it as both the
|
|
8
|
-
* React Native-specific `SqliteClient` and the generic Effect `SqlClient`, and
|
|
9
|
-
* run application queries, migrations, and transactional reads or writes from
|
|
10
|
-
* Effect services and layers.
|
|
11
|
-
*
|
|
12
|
-
* The client uses one serialized connection. Regular queries and transactions
|
|
13
|
-
* share that handle, and a transaction holds it for the lifetime of its scope,
|
|
14
|
-
* so keep mobile transactions short and wrap multi-statement writes in a
|
|
15
|
-
* transaction to avoid partial updates. By default statements use the driver's
|
|
16
|
-
* synchronous API, which can block the JavaScript thread; `withAsyncQuery`
|
|
17
|
-
* switches a fiber to the asynchronous driver API when UI responsiveness is more
|
|
18
|
-
* important than sync execution.
|
|
19
|
-
*
|
|
20
5
|
* @since 4.0.0
|
|
21
6
|
*/
|
|
22
7
|
export * as SqliteClient from "./SqliteClient.ts";
|
|
23
8
|
/**
|
|
24
|
-
* Utilities for applying Effect SQL migrations to React Native SQLite databases.
|
|
25
|
-
*
|
|
26
|
-
* This module re-exports the shared `Migrator` loaders and error types, then
|
|
27
|
-
* provides `run` and `layer` helpers that execute ordered migrations through the
|
|
28
|
-
* current React Native SQLite `SqlClient`. Use it when a mobile app needs to
|
|
29
|
-
* bring its on-device database schema up to date during startup, before opening
|
|
30
|
-
* repositories or sync services, or in integration tests that create app-local
|
|
31
|
-
* database files.
|
|
32
|
-
*
|
|
33
|
-
* React Native SQLite databases are scoped by the client configuration, so the
|
|
34
|
-
* migrator should be run with the same `filename`, `location`, and encryption
|
|
35
|
-
* key as the rest of the application. Migrations run through the package's
|
|
36
|
-
* single serialized connection; by default statements use the synchronous
|
|
37
|
-
* driver API and can block the JS thread, so long migration sets may want to run
|
|
38
|
-
* under `SqliteClient.withAsyncQuery`. Mobile upgrades can be interrupted by app
|
|
39
|
-
* suspension or process death, so keep migrations transaction-aware and avoid
|
|
40
|
-
* assuming a fresh database on every launch.
|
|
41
|
-
*
|
|
42
9
|
* @since 4.0.0
|
|
43
10
|
*/
|
|
44
11
|
export * as SqliteMigrator from "./SqliteMigrator.ts";
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH;;GAEG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAEjD;;GAEG;AACH,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA"}
|
package/dist/index.js
CHANGED
|
@@ -3,43 +3,10 @@
|
|
|
3
3
|
*/
|
|
4
4
|
// @barrel: Auto-generated exports. Do not edit manually.
|
|
5
5
|
/**
|
|
6
|
-
* Provides a React Native SQLite `SqlClient` backed by `@op-engineering/op-sqlite`.
|
|
7
|
-
*
|
|
8
|
-
* Use this module to open an on-device SQLite database, expose it as both the
|
|
9
|
-
* React Native-specific `SqliteClient` and the generic Effect `SqlClient`, and
|
|
10
|
-
* run application queries, migrations, and transactional reads or writes from
|
|
11
|
-
* Effect services and layers.
|
|
12
|
-
*
|
|
13
|
-
* The client uses one serialized connection. Regular queries and transactions
|
|
14
|
-
* share that handle, and a transaction holds it for the lifetime of its scope,
|
|
15
|
-
* so keep mobile transactions short and wrap multi-statement writes in a
|
|
16
|
-
* transaction to avoid partial updates. By default statements use the driver's
|
|
17
|
-
* synchronous API, which can block the JavaScript thread; `withAsyncQuery`
|
|
18
|
-
* switches a fiber to the asynchronous driver API when UI responsiveness is more
|
|
19
|
-
* important than sync execution.
|
|
20
|
-
*
|
|
21
6
|
* @since 4.0.0
|
|
22
7
|
*/
|
|
23
8
|
export * as SqliteClient from "./SqliteClient.js";
|
|
24
9
|
/**
|
|
25
|
-
* Utilities for applying Effect SQL migrations to React Native SQLite databases.
|
|
26
|
-
*
|
|
27
|
-
* This module re-exports the shared `Migrator` loaders and error types, then
|
|
28
|
-
* provides `run` and `layer` helpers that execute ordered migrations through the
|
|
29
|
-
* current React Native SQLite `SqlClient`. Use it when a mobile app needs to
|
|
30
|
-
* bring its on-device database schema up to date during startup, before opening
|
|
31
|
-
* repositories or sync services, or in integration tests that create app-local
|
|
32
|
-
* database files.
|
|
33
|
-
*
|
|
34
|
-
* React Native SQLite databases are scoped by the client configuration, so the
|
|
35
|
-
* migrator should be run with the same `filename`, `location`, and encryption
|
|
36
|
-
* key as the rest of the application. Migrations run through the package's
|
|
37
|
-
* single serialized connection; by default statements use the synchronous
|
|
38
|
-
* driver API and can block the JS thread, so long migration sets may want to run
|
|
39
|
-
* under `SqliteClient.withAsyncQuery`. Mobile upgrades can be interrupted by app
|
|
40
|
-
* suspension or process death, so keep migrations transaction-aware and avoid
|
|
41
|
-
* assuming a fresh database on every launch.
|
|
42
|
-
*
|
|
43
10
|
* @since 4.0.0
|
|
44
11
|
*/
|
|
45
12
|
export * as SqliteMigrator from "./SqliteMigrator.js";
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","names":["SqliteClient","SqliteMigrator"],"sources":["../src/index.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAIA;AAEA
|
|
1
|
+
{"version":3,"file":"index.js","names":["SqliteClient","SqliteMigrator"],"sources":["../src/index.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAIA;AAEA;;;AAGA,OAAO,KAAKA,YAAY,MAAM,mBAAmB;AAEjD;;;AAGA,OAAO,KAAKC,cAAc,MAAM,qBAAqB","ignoreList":[]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@effect/sql-sqlite-react-native",
|
|
3
|
-
"version": "4.0.0-beta.
|
|
3
|
+
"version": "4.0.0-beta.72",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"description": "A SQLite toolkit for Effect",
|
|
@@ -44,11 +44,11 @@
|
|
|
44
44
|
},
|
|
45
45
|
"devDependencies": {
|
|
46
46
|
"@op-engineering/op-sqlite": "15.2.12",
|
|
47
|
-
"effect": "^4.0.0-beta.
|
|
47
|
+
"effect": "^4.0.0-beta.72"
|
|
48
48
|
},
|
|
49
49
|
"peerDependencies": {
|
|
50
50
|
"@op-engineering/op-sqlite": "15.0.4",
|
|
51
|
-
"effect": "^4.0.0-beta.
|
|
51
|
+
"effect": "^4.0.0-beta.72"
|
|
52
52
|
},
|
|
53
53
|
"scripts": {
|
|
54
54
|
"codegen": "effect-utils codegen",
|
package/src/SqliteClient.ts
CHANGED
|
@@ -1,18 +1,37 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
2
|
+
* React Native SQLite client implementation for Effect SQL, backed by
|
|
3
|
+
* `@op-engineering/op-sqlite`.
|
|
3
4
|
*
|
|
4
|
-
*
|
|
5
|
-
* React Native-specific `SqliteClient` and the generic Effect
|
|
6
|
-
*
|
|
7
|
-
*
|
|
5
|
+
* This module opens an on-device SQLite database and exposes it as both the
|
|
6
|
+
* React Native-specific `SqliteClient` service and the generic Effect
|
|
7
|
+
* `SqlClient` service. Use it for mobile application storage, offline caches,
|
|
8
|
+
* local migrations, sync queues, and tests that need the same SQLite driver as
|
|
9
|
+
* the app runtime.
|
|
8
10
|
*
|
|
9
|
-
*
|
|
10
|
-
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
11
|
+
* **Mental model**
|
|
12
|
+
*
|
|
13
|
+
* A client owns one scoped op-sqlite database handle configured with the
|
|
14
|
+
* provided `filename`, optional `location`, and optional `encryptionKey`.
|
|
15
|
+
* Queries are compiled through the Effect SQL SQLite compiler and serialized
|
|
16
|
+
* through that single handle. A transaction keeps the serialized connection
|
|
17
|
+
* permit for the whole transaction scope, so other fibers using the same client
|
|
18
|
+
* wait until the transaction finishes.
|
|
19
|
+
*
|
|
20
|
+
* **Common tasks**
|
|
21
|
+
*
|
|
22
|
+
* Use `layer` when a React Native app should provide both `SqliteClient` and
|
|
23
|
+
* the generic `SqlClient` from a concrete configuration, `layerConfig` when the
|
|
24
|
+
* configuration should come from Effect `Config`, and `make` inside a custom
|
|
25
|
+
* scoped layer when you need direct lifecycle control. Use `withAsyncQuery`
|
|
26
|
+
* around UI-sensitive effects or longer migration steps to run statements with
|
|
27
|
+
* the driver's asynchronous API instead of the default synchronous API.
|
|
28
|
+
*
|
|
29
|
+
* **Gotchas**
|
|
30
|
+
*
|
|
31
|
+
* The default synchronous op-sqlite API can block the JavaScript thread, so keep
|
|
32
|
+
* transactions short and wrap multi-statement writes in a transaction to avoid
|
|
33
|
+
* partial updates. `executeStream` is not implemented for this driver, and
|
|
34
|
+
* SQLite does not support `updateValues`.
|
|
16
35
|
*
|
|
17
36
|
* @since 4.0.0
|
|
18
37
|
*/
|
|
@@ -68,7 +87,7 @@ export interface SqliteClient extends Client.SqlClient {
|
|
|
68
87
|
}
|
|
69
88
|
|
|
70
89
|
/**
|
|
71
|
-
*
|
|
90
|
+
* Service tag for the React Native SQLite client.
|
|
72
91
|
*
|
|
73
92
|
* @category tags
|
|
74
93
|
* @since 4.0.0
|
|
@@ -91,7 +110,12 @@ export interface SqliteClientConfig {
|
|
|
91
110
|
}
|
|
92
111
|
|
|
93
112
|
/**
|
|
94
|
-
* Fiber
|
|
113
|
+
* Fiber reference that makes the React Native SQLite client run queries through the asynchronous `execute` API instead of `executeSync`.
|
|
114
|
+
*
|
|
115
|
+
* **When to use**
|
|
116
|
+
*
|
|
117
|
+
* Use to switch React Native SQLite query execution to the asynchronous driver
|
|
118
|
+
* API for a scoped effect.
|
|
95
119
|
*
|
|
96
120
|
* @category fiber refs
|
|
97
121
|
* @since 4.0.0
|
package/src/index.ts
CHANGED
|
@@ -5,44 +5,11 @@
|
|
|
5
5
|
// @barrel: Auto-generated exports. Do not edit manually.
|
|
6
6
|
|
|
7
7
|
/**
|
|
8
|
-
* Provides a React Native SQLite `SqlClient` backed by `@op-engineering/op-sqlite`.
|
|
9
|
-
*
|
|
10
|
-
* Use this module to open an on-device SQLite database, expose it as both the
|
|
11
|
-
* React Native-specific `SqliteClient` and the generic Effect `SqlClient`, and
|
|
12
|
-
* run application queries, migrations, and transactional reads or writes from
|
|
13
|
-
* Effect services and layers.
|
|
14
|
-
*
|
|
15
|
-
* The client uses one serialized connection. Regular queries and transactions
|
|
16
|
-
* share that handle, and a transaction holds it for the lifetime of its scope,
|
|
17
|
-
* so keep mobile transactions short and wrap multi-statement writes in a
|
|
18
|
-
* transaction to avoid partial updates. By default statements use the driver's
|
|
19
|
-
* synchronous API, which can block the JavaScript thread; `withAsyncQuery`
|
|
20
|
-
* switches a fiber to the asynchronous driver API when UI responsiveness is more
|
|
21
|
-
* important than sync execution.
|
|
22
|
-
*
|
|
23
8
|
* @since 4.0.0
|
|
24
9
|
*/
|
|
25
10
|
export * as SqliteClient from "./SqliteClient.ts"
|
|
26
11
|
|
|
27
12
|
/**
|
|
28
|
-
* Utilities for applying Effect SQL migrations to React Native SQLite databases.
|
|
29
|
-
*
|
|
30
|
-
* This module re-exports the shared `Migrator` loaders and error types, then
|
|
31
|
-
* provides `run` and `layer` helpers that execute ordered migrations through the
|
|
32
|
-
* current React Native SQLite `SqlClient`. Use it when a mobile app needs to
|
|
33
|
-
* bring its on-device database schema up to date during startup, before opening
|
|
34
|
-
* repositories or sync services, or in integration tests that create app-local
|
|
35
|
-
* database files.
|
|
36
|
-
*
|
|
37
|
-
* React Native SQLite databases are scoped by the client configuration, so the
|
|
38
|
-
* migrator should be run with the same `filename`, `location`, and encryption
|
|
39
|
-
* key as the rest of the application. Migrations run through the package's
|
|
40
|
-
* single serialized connection; by default statements use the synchronous
|
|
41
|
-
* driver API and can block the JS thread, so long migration sets may want to run
|
|
42
|
-
* under `SqliteClient.withAsyncQuery`. Mobile upgrades can be interrupted by app
|
|
43
|
-
* suspension or process death, so keep migrations transaction-aware and avoid
|
|
44
|
-
* assuming a fresh database on every launch.
|
|
45
|
-
*
|
|
46
13
|
* @since 4.0.0
|
|
47
14
|
*/
|
|
48
15
|
export * as SqliteMigrator from "./SqliteMigrator.ts"
|