@effect/sql-sqlite-react-native 4.0.0-beta.67 → 4.0.0-beta.68

package/dist/SqliteClient.d.ts

@@ -8,14 +8,14 @@ import * as Client from "effect/unstable/sql/SqlClient";
 /**
  * Runtime identifier attached to SQLite React Native client values.
  *
- * @category type ids
+ * @category type IDs
  * @since 4.0.0
  */
 export declare const TypeId: TypeId;
 /**
  * Type-level identifier for SQLite React Native client values.
  *
- * @category type ids
+ * @category type IDs
  * @since 4.0.0
  */
 export type TypeId = "~@effect/sql-sqlite-react-native/SqliteClient";
@@ -69,7 +69,7 @@ export declare const withAsyncQuery: <R, E, A>(effect: Effect.Effect<A, E, R>) =
 /**
  * Creates a scoped React Native SQLite client from the supplied configuration, using a single serialized connection and honoring `AsyncQuery` for query execution.
  *
- * @category constructor
+ * @category constructors
  * @since 4.0.0
  */
 export declare const make: (options: SqliteClientConfig) => Effect.Effect<SqliteClient, never, Scope.Scope | Reactivity.Reactivity>;

package/dist/SqliteClient.js

@@ -38,7 +38,7 @@ const classifyError = (cause, message, operation) => classifySqliteError(cause,
 /**
  * Runtime identifier attached to SQLite React Native client values.
  *
- * @category type ids
+ * @category type IDs
  * @since 4.0.0
  */
 export const TypeId = "~@effect/sql-sqlite-react-native/SqliteClient";
@@ -68,7 +68,7 @@ export const withAsyncQuery = effect => Effect.provideService(effect, AsyncQuery
 /**
  * Creates a scoped React Native SQLite client from the supplied configuration, using a single serialized connection and honoring `AsyncQuery` for query execution.
  *
- * @category constructor
+ * @category constructors
  * @since 4.0.0
  */
 export const make = options => Effect.gen(function* () {

package/dist/SqliteMigrator.d.ts

@@ -31,14 +31,14 @@ export * from "effect/unstable/sql/Migrator";
 /**
  * Runs SQL migrations for a React Native SQLite database using the shared `Migrator` implementation and the current `SqlClient`.
  *
- * @category constructor
+ * @category constructors
  * @since 4.0.0
  */
 export declare const run: <R>(options: Migrator.MigratorOptions<R>) => Effect.Effect<ReadonlyArray<readonly [id: number, name: string]>, SqlError | Migrator.MigrationError, Client.SqlClient | R>;
 /**
  * Creates a layer that runs the configured React Native SQLite migrations during layer construction and provides no services.
  *
- * @category constructor
+ * @category constructors
  * @since 4.0.0
  */
 export declare const layer: <R>(options: Migrator.MigratorOptions<R>) => Layer.Layer<never, SqlError | Migrator.MigrationError, R | Client.SqlClient>;

package/dist/SqliteMigrator.js

@@ -7,14 +7,14 @@ export * from "effect/unstable/sql/Migrator";
 /**
  * Runs SQL migrations for a React Native SQLite database using the shared `Migrator` implementation and the current `SqlClient`.
  *
- * @category constructor
+ * @category constructors
  * @since 4.0.0
  */
 export const run = /*#__PURE__*/Migrator.make({});
 /**
  * Creates a layer that runs the configured React Native SQLite migrations during layer construction and provides no services.
  *
- * @category constructor
+ * @category constructors
  * @since 4.0.0
  */
 export const layer = options => Layer.effectDiscard(run(options));

package/dist/index.d.ts

@@ -2,10 +2,43 @@
  * @since 4.0.0
  */
 /**
+ * Provides a React Native SQLite `SqlClient` backed by `@op-engineering/op-sqlite`.
+ *
+ * Use this module to open an on-device SQLite database, expose it as both the
+ * React Native-specific `SqliteClient` and the generic Effect `SqlClient`, and
+ * run application queries, migrations, and transactional reads or writes from
+ * Effect services and layers.
+ *
+ * The client uses one serialized connection. Regular queries and transactions
+ * share that handle, and a transaction holds it for the lifetime of its scope,
+ * so keep mobile transactions short and wrap multi-statement writes in a
+ * transaction to avoid partial updates. By default statements use the driver's
+ * synchronous API, which can block the JavaScript thread; `withAsyncQuery`
+ * switches a fiber to the asynchronous driver API when UI responsiveness is more
+ * important than sync execution.
+ *
  * @since 4.0.0
  */
 export * as SqliteClient from "./SqliteClient.ts";
 /**
+ * Utilities for applying Effect SQL migrations to React Native SQLite databases.
+ *
+ * This module re-exports the shared `Migrator` loaders and error types, then
+ * provides `run` and `layer` helpers that execute ordered migrations through the
+ * current React Native SQLite `SqlClient`. Use it when a mobile app needs to
+ * bring its on-device database schema up to date during startup, before opening
+ * repositories or sync services, or in integration tests that create app-local
+ * database files.
+ *
+ * React Native SQLite databases are scoped by the client configuration, so the
+ * migrator should be run with the same `filename`, `location`, and encryption
+ * key as the rest of the application. Migrations run through the package's
+ * single serialized connection; by default statements use the synchronous
+ * driver API and can block the JS thread, so long migration sets may want to run
+ * under `SqliteClient.withAsyncQuery`. Mobile upgrades can be interrupted by app
+ * suspension or process death, so keep migrations transaction-aware and avoid
+ * assuming a fresh database on every launch.
+ *
  * @since 4.0.0
  */
 export * as SqliteMigrator from "./SqliteMigrator.ts";

package/dist/index.d.ts.map

@@ -1 +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"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH;;;;;;;;;;;;;;;;;GAiBG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAEjD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA"}

package/dist/index.js

@@ -3,10 +3,43 @@
  */
 // @barrel: Auto-generated exports. Do not edit manually.
 /**
+ * Provides a React Native SQLite `SqlClient` backed by `@op-engineering/op-sqlite`.
+ *
+ * Use this module to open an on-device SQLite database, expose it as both the
+ * React Native-specific `SqliteClient` and the generic Effect `SqlClient`, and
+ * run application queries, migrations, and transactional reads or writes from
+ * Effect services and layers.
+ *
+ * The client uses one serialized connection. Regular queries and transactions
+ * share that handle, and a transaction holds it for the lifetime of its scope,
+ * so keep mobile transactions short and wrap multi-statement writes in a
+ * transaction to avoid partial updates. By default statements use the driver's
+ * synchronous API, which can block the JavaScript thread; `withAsyncQuery`
+ * switches a fiber to the asynchronous driver API when UI responsiveness is more
+ * important than sync execution.
+ *
  * @since 4.0.0
  */
 export * as SqliteClient from "./SqliteClient.js";
 /**
+ * Utilities for applying Effect SQL migrations to React Native SQLite databases.
+ *
+ * This module re-exports the shared `Migrator` loaders and error types, then
+ * provides `run` and `layer` helpers that execute ordered migrations through the
+ * current React Native SQLite `SqlClient`. Use it when a mobile app needs to
+ * bring its on-device database schema up to date during startup, before opening
+ * repositories or sync services, or in integration tests that create app-local
+ * database files.
+ *
+ * React Native SQLite databases are scoped by the client configuration, so the
+ * migrator should be run with the same `filename`, `location`, and encryption
+ * key as the rest of the application. Migrations run through the package's
+ * single serialized connection; by default statements use the synchronous
+ * driver API and can block the JS thread, so long migration sets may want to run
+ * under `SqliteClient.withAsyncQuery`. Mobile upgrades can be interrupted by app
+ * suspension or process death, so keep migrations transaction-aware and avoid
+ * assuming a fresh database on every launch.
+ *
  * @since 4.0.0
  */
 export * as SqliteMigrator from "./SqliteMigrator.js";

package/dist/index.js.map

@@ -1 +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":[]}
+{"version":3,"file":"index.js","names":["SqliteClient","SqliteMigrator"],"sources":["../src/index.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAIA;AAEA;;;;;;;;;;;;;;;;;;AAkBA,OAAO,KAAKA,YAAY,MAAM,mBAAmB;AAEjD;;;;;;;;;;;;;;;;;;;;;AAqBA,OAAO,KAAKC,cAAc,MAAM,qBAAqB","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@effect/sql-sqlite-react-native",
-  "version": "4.0.0-beta.67",
+  "version": "4.0.0-beta.68",
   "type": "module",
   "license": "MIT",
   "description": "A SQLite toolkit for Effect",
@@ -44,11 +44,11 @@
   },
   "devDependencies": {
     "@op-engineering/op-sqlite": "15.2.12",
-    "effect": "^4.0.0-beta.67"
+    "effect": "^4.0.0-beta.68"
   },
   "peerDependencies": {
     "@op-engineering/op-sqlite": "15.0.4",
-    "effect": "^4.0.0-beta.67"
+    "effect": "^4.0.0-beta.68"
   },
   "scripts": {
     "codegen": "effect-utils codegen",

package/src/SqliteClient.ts

@@ -40,7 +40,7 @@ const classifyError = (cause: unknown, message: string, operation: string) =>
 /**
  * Runtime identifier attached to SQLite React Native client values.
  *
- * @category type ids
+ * @category type IDs
  * @since 4.0.0
  */
 export const TypeId: TypeId = "~@effect/sql-sqlite-react-native/SqliteClient"
@@ -48,7 +48,7 @@ export const TypeId: TypeId = "~@effect/sql-sqlite-react-native/SqliteClient"
 /**
  * Type-level identifier for SQLite React Native client values.
  *
- * @category type ids
+ * @category type IDs
  * @since 4.0.0
  */
 export type TypeId = "~@effect/sql-sqlite-react-native/SqliteClient"
@@ -115,7 +115,7 @@ interface SqliteConnection extends Connection {}
 /**
  * Creates a scoped React Native SQLite client from the supplied configuration, using a single serialized connection and honoring `AsyncQuery` for query execution.
  *
- * @category constructor
+ * @category constructors
  * @since 4.0.0
  */
 export const make = (
@@ -280,10 +280,6 @@ interface DB {
    *
    * If you are writing to the database YOU SHOULD BE USING TRANSACTIONS!
    * Transactions protect you from partial writes and ensure that your data is always in a consistent state
-   *
-   * @param query
-   * @param params
-   * @returns QueryResult
    */
   executeSync: (query: string, params?: Array<any>) => QueryResult
   /**
@@ -301,10 +297,6 @@ interface DB {
    * Transactions protect you from partial writes and ensure that your data is always in a consistent state
    *
    * If you need a large amount of queries ran as fast as possible you should be using `executeBatch`, `executeRaw`, `loadFile` or `executeWithHostObjects`
-   *
-   * @param query string of your SQL query
-   * @param params a list of parameters to bind to the query, if any
-   * @returns Promise<QueryResult> with the result of the query
    */
   execute: (query: string, params?: Array<any>) => Promise<QueryResult>
   /**

package/src/SqliteMigrator.ts

@@ -33,7 +33,7 @@ export * from "effect/unstable/sql/Migrator"
 /**
  * Runs SQL migrations for a React Native SQLite database using the shared `Migrator` implementation and the current `SqlClient`.
  *
- * @category constructor
+ * @category constructors
  * @since 4.0.0
  */
 export const run: <R>(
@@ -47,7 +47,7 @@ export const run: <R>(
 /**
  * Creates a layer that runs the configured React Native SQLite migrations during layer construction and provides no services.
  *
- * @category constructor
+ * @category constructors
  * @since 4.0.0
  */
 export const layer = <R>(

package/src/index.ts

@@ -5,11 +5,44 @@
 // @barrel: Auto-generated exports. Do not edit manually.
 
 /**
+ * Provides a React Native SQLite `SqlClient` backed by `@op-engineering/op-sqlite`.
+ *
+ * Use this module to open an on-device SQLite database, expose it as both the
+ * React Native-specific `SqliteClient` and the generic Effect `SqlClient`, and
+ * run application queries, migrations, and transactional reads or writes from
+ * Effect services and layers.
+ *
+ * The client uses one serialized connection. Regular queries and transactions
+ * share that handle, and a transaction holds it for the lifetime of its scope,
+ * so keep mobile transactions short and wrap multi-statement writes in a
+ * transaction to avoid partial updates. By default statements use the driver's
+ * synchronous API, which can block the JavaScript thread; `withAsyncQuery`
+ * switches a fiber to the asynchronous driver API when UI responsiveness is more
+ * important than sync execution.
+ *
  * @since 4.0.0
  */
 export * as SqliteClient from "./SqliteClient.ts"
 
 /**
+ * Utilities for applying Effect SQL migrations to React Native SQLite databases.
+ *
+ * This module re-exports the shared `Migrator` loaders and error types, then
+ * provides `run` and `layer` helpers that execute ordered migrations through the
+ * current React Native SQLite `SqlClient`. Use it when a mobile app needs to
+ * bring its on-device database schema up to date during startup, before opening
+ * repositories or sync services, or in integration tests that create app-local
+ * database files.
+ *
+ * React Native SQLite databases are scoped by the client configuration, so the
+ * migrator should be run with the same `filename`, `location`, and encryption
+ * key as the rest of the application. Migrations run through the package's
+ * single serialized connection; by default statements use the synchronous
+ * driver API and can block the JS thread, so long migration sets may want to run
+ * under `SqliteClient.withAsyncQuery`. Mobile upgrades can be interrupted by app
+ * suspension or process death, so keep migrations transaction-aware and avoid
+ * assuming a fresh database on every launch.
+ *
  * @since 4.0.0
  */
 export * as SqliteMigrator from "./SqliteMigrator.ts"