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

package/dist/SqliteClient.d.ts

@@ -10,14 +10,14 @@ import { SqlError } from "effect/unstable/sql/SqlError";
 /**
  * Runtime type identifier used to mark Node `SqliteClient` values.
  *
- * @category type ids
+ * @category type IDs
  * @since 4.0.0
  */
 export declare const TypeId: TypeId;
 /**
  * Type-level identifier used to mark Node `SqliteClient` values.
  *
- * @category type ids
+ * @category type IDs
  * @since 4.0.0
  */
 export type TypeId = "~@effect/sql-sqlite-node/SqliteClient";
@@ -72,7 +72,7 @@ export interface SqliteClientConfig {
 /**
  * Creates a scoped node SQLite client from the supplied configuration, using a single serialized connection with WAL enabled by default and exposing SQLite-specific `export`, `backup`, and `loadExtension` operations.
  *
- * @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

@@ -39,7 +39,7 @@ const classifyError = (cause, message, operation) => classifySqliteError(cause,
 /**
  * Runtime type identifier used to mark Node `SqliteClient` values.
  *
- * @category type ids
+ * @category type IDs
  * @since 4.0.0
  */
 export const TypeId = "~@effect/sql-sqlite-node/SqliteClient";
@@ -53,7 +53,7 @@ export const SqliteClient = /*#__PURE__*/Context.Service("@effect/sql-sqlite-nod
 /**
  * Creates a scoped node SQLite client from the supplied configuration, using a single serialized connection with WAL enabled by default and exposing SQLite-specific `export`, `backup`, and `loadExtension` operations.
  *
- * @category constructor
+ * @category constructors
  * @since 4.0.0
  */
 export const make = options => Effect.gen(function* () {

package/dist/SqliteMigrator.d.ts

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

package/dist/SqliteMigrator.js

@@ -7,7 +7,7 @@ export * from "effect/unstable/sql/Migrator";
 /**
  * Runs SQL migrations for a 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({
@@ -56,7 +56,7 @@ export const run = /*#__PURE__*/Migrator.make({
 /**
  * Creates a layer that runs the configured 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,39 @@
  * @since 4.0.0
  */
 /**
+ * Node.js SQLite client implementation for Effect SQL, backed by `better-sqlite3`.
+ *
+ * This module exposes constructors and layers for providing both the SQLite-specific `SqliteClient`
+ * service and the generic `SqlClient` service. It is intended for file-backed or in-memory SQLite
+ * databases in Node applications, local development tools, tests, migrations, and embedded
+ * persistence use cases that need Effect SQL query compilation plus SQLite-specific operations such
+ * as exporting a database, creating backups, or loading native SQLite extensions.
+ *
+ * Each client owns one scoped `better-sqlite3` connection and serializes access through it. WAL mode
+ * is enabled by default, so set `disableWAL` when opening read-only databases or when the database
+ * location cannot change journal mode. Prepared statements are cached by SQL text, safe integer
+ * handling follows the `SqlClient` fiber-local setting, `executeStream` is not implemented, and
+ * SQLite does not support `updateValues`.
+ *
  * @since 4.0.0
  */
 export * as SqliteClient from "./SqliteClient.ts";
 /**
+ * Utilities for applying Effect SQL migrations to Node.js SQLite databases.
+ *
+ * This module re-exports the shared `Migrator` loaders and error types, then
+ * provides `run` and `layer` helpers for applying ordered migrations through the
+ * current SQLite `SqlClient`. It is typically used at application startup, in
+ * tests that create temporary database files, or in layer graphs that must
+ * ensure a file-backed SQLite schema exists before dependent services start.
+ *
+ * Migrations are recorded in `effect_sql_migrations` by default and are loaded
+ * using the shared `<id>_<name>` file or record-key convention. Only migrations
+ * with an id greater than the latest recorded id are applied, so every client
+ * involved in startup should point at the same SQLite filename. Concurrent
+ * writers can surface SQLite lock timeout errors, and this adapter does not
+ * currently write SQLite schema dumps for `schemaDirectory`.
+ *
  * @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;;;;;;;;;;;;;;;;GAgBG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAEjD;;;;;;;;;;;;;;;;;GAiBG;AACH,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA"}

package/dist/index.js

@@ -3,10 +3,39 @@
  */
 // @barrel: Auto-generated exports. Do not edit manually.
 /**
+ * Node.js SQLite client implementation for Effect SQL, backed by `better-sqlite3`.
+ *
+ * This module exposes constructors and layers for providing both the SQLite-specific `SqliteClient`
+ * service and the generic `SqlClient` service. It is intended for file-backed or in-memory SQLite
+ * databases in Node applications, local development tools, tests, migrations, and embedded
+ * persistence use cases that need Effect SQL query compilation plus SQLite-specific operations such
+ * as exporting a database, creating backups, or loading native SQLite extensions.
+ *
+ * Each client owns one scoped `better-sqlite3` connection and serializes access through it. WAL mode
+ * is enabled by default, so set `disableWAL` when opening read-only databases or when the database
+ * location cannot change journal mode. Prepared statements are cached by SQL text, safe integer
+ * handling follows the `SqlClient` fiber-local setting, `executeStream` is not implemented, and
+ * SQLite does not support `updateValues`.
+ *
  * @since 4.0.0
  */
 export * as SqliteClient from "./SqliteClient.js";
 /**
+ * Utilities for applying Effect SQL migrations to Node.js SQLite databases.
+ *
+ * This module re-exports the shared `Migrator` loaders and error types, then
+ * provides `run` and `layer` helpers for applying ordered migrations through the
+ * current SQLite `SqlClient`. It is typically used at application startup, in
+ * tests that create temporary database files, or in layer graphs that must
+ * ensure a file-backed SQLite schema exists before dependent services start.
+ *
+ * Migrations are recorded in `effect_sql_migrations` by default and are loaded
+ * using the shared `<id>_<name>` file or record-key convention. Only migrations
+ * with an id greater than the latest recorded id are applied, so every client
+ * involved in startup should point at the same SQLite filename. Concurrent
+ * writers can surface SQLite lock timeout errors, and this adapter does not
+ * currently write SQLite schema dumps for `schemaDirectory`.
+ *
  * @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;;;;;;;;;;;;;;;;;AAiBA,OAAO,KAAKA,YAAY,MAAM,mBAAmB;AAEjD;;;;;;;;;;;;;;;;;;AAkBA,OAAO,KAAKC,cAAc,MAAM,qBAAqB","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@effect/sql-sqlite-node",
-  "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": {
     "@types/better-sqlite3": "^7.6.13",
-    "effect": "^4.0.0-beta.67",
-    "@effect/platform-node": "^4.0.0-beta.67"
+    "@effect/platform-node": "^4.0.0-beta.68",
+    "effect": "^4.0.0-beta.68"
   },
   "peerDependencies": {
-    "effect": "^4.0.0-beta.67"
+    "effect": "^4.0.0-beta.68"
   },
   "dependencies": {
     "better-sqlite3": "^12.9.0"

package/src/SqliteClient.ts

@@ -41,7 +41,7 @@ const classifyError = (cause: unknown, message: string, operation: string) =>
 /**
  * Runtime type identifier used to mark Node `SqliteClient` values.
  *
- * @category type ids
+ * @category type IDs
  * @since 4.0.0
  */
 export const TypeId: TypeId = "~@effect/sql-sqlite-node/SqliteClient"
@@ -49,7 +49,7 @@ export const TypeId: TypeId = "~@effect/sql-sqlite-node/SqliteClient"
 /**
  * Type-level identifier used to mark Node `SqliteClient` values.
  *
- * @category type ids
+ * @category type IDs
  * @since 4.0.0
  */
 export type TypeId = "~@effect/sql-sqlite-node/SqliteClient"
@@ -117,7 +117,7 @@ interface SqliteConnection extends Connection {
 /**
  * Creates a scoped node SQLite client from the supplied configuration, using a single serialized connection with WAL enabled by default and exposing SQLite-specific `export`, `backup`, and `loadExtension` operations.
  *
- * @category constructor
+ * @category constructors
  * @since 4.0.0
  */
 export const make = (

package/src/SqliteMigrator.ts

@@ -30,7 +30,7 @@ export * from "effect/unstable/sql/Migrator"
 /**
  * Runs SQL migrations for a SQLite database using the shared `Migrator` implementation and the current `SqlClient`.
  *
- * @category constructor
+ * @category constructors
  * @since 4.0.0
  */
 export const run: <R2 = never>(
@@ -86,7 +86,7 @@ export const run: <R2 = never>(
 /**
  * Creates a layer that runs the configured 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,40 @@
 // @barrel: Auto-generated exports. Do not edit manually.
 
 /**
+ * Node.js SQLite client implementation for Effect SQL, backed by `better-sqlite3`.
+ *
+ * This module exposes constructors and layers for providing both the SQLite-specific `SqliteClient`
+ * service and the generic `SqlClient` service. It is intended for file-backed or in-memory SQLite
+ * databases in Node applications, local development tools, tests, migrations, and embedded
+ * persistence use cases that need Effect SQL query compilation plus SQLite-specific operations such
+ * as exporting a database, creating backups, or loading native SQLite extensions.
+ *
+ * Each client owns one scoped `better-sqlite3` connection and serializes access through it. WAL mode
+ * is enabled by default, so set `disableWAL` when opening read-only databases or when the database
+ * location cannot change journal mode. Prepared statements are cached by SQL text, safe integer
+ * handling follows the `SqlClient` fiber-local setting, `executeStream` is not implemented, and
+ * SQLite does not support `updateValues`.
+ *
  * @since 4.0.0
  */
 export * as SqliteClient from "./SqliteClient.ts"
 
 /**
+ * Utilities for applying Effect SQL migrations to Node.js SQLite databases.
+ *
+ * This module re-exports the shared `Migrator` loaders and error types, then
+ * provides `run` and `layer` helpers for applying ordered migrations through the
+ * current SQLite `SqlClient`. It is typically used at application startup, in
+ * tests that create temporary database files, or in layer graphs that must
+ * ensure a file-backed SQLite schema exists before dependent services start.
+ *
+ * Migrations are recorded in `effect_sql_migrations` by default and are loaded
+ * using the shared `<id>_<name>` file or record-key convention. Only migrations
+ * with an id greater than the latest recorded id are applied, so every client
+ * involved in startup should point at the same SQLite filename. Concurrent
+ * writers can surface SQLite lock timeout errors, and this adapter does not
+ * currently write SQLite schema dumps for `schemaDirectory`.
+ *
  * @since 4.0.0
  */
 export * as SqliteMigrator from "./SqliteMigrator.ts"