@effect/sql-libsql 4.0.0-beta.67 → 4.0.0-beta.69

package/dist/LibsqlClient.d.ts

@@ -30,14 +30,14 @@ import * as Client from "effect/unstable/sql/SqlClient";
 /**
  * Runtime type identifier used to mark `LibsqlClient` values.
  *
- * @category type ids
+ * @category type IDs
  * @since 4.0.0
  */
 export declare const TypeId: TypeId;
 /**
  * Type-level identifier used to mark `LibsqlClient` values.
  *
- * @category type ids
+ * @category type IDs
  * @since 4.0.0
  */
 export type TypeId = "~@effect/sql-libsql/LibsqlClient";
@@ -140,7 +140,7 @@ export declare namespace LibsqlClientConfig {
 /**
  * Creates a scoped libSQL SQL client with transaction support. When given connection options it creates and closes the SDK client; when given `liveClient`, the caller retains ownership.
  *
- * @category constructor
+ * @category constructors
  * @since 4.0.0
  */
 export declare const make: (options: LibsqlClientConfig) => Effect.Effect<LibsqlClient, never, Scope.Scope | Reactivity.Reactivity>;

package/dist/LibsqlClient.js

@@ -40,7 +40,7 @@ const classifyError = (cause, message, operation) => classifySqliteError(cause,
 /**
  * Runtime type identifier used to mark `LibsqlClient` values.
  *
- * @category type ids
+ * @category type IDs
  * @since 4.0.0
  */
 export const TypeId = "~@effect/sql-libsql/LibsqlClient";
@@ -55,7 +55,7 @@ const LibsqlTransaction = /*#__PURE__*/Context.Service("@effect/sql-libsql/Libsq
 /**
  * Creates a scoped libSQL SQL client with transaction support. When given connection options it creates and closes the SDK client; when given `liveClient`, the caller retains ownership.
  *
- * @category constructor
+ * @category constructors
  * @since 4.0.0
  */
 export const make = options => Effect.gen(function* () {

package/dist/LibsqlMigrator.d.ts

@@ -33,14 +33,14 @@ export * from "effect/unstable/sql/Migrator";
 /**
  * Runs SQL migrations using the configured `SqlClient`, returning the migrations that were applied.
  *
- * @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 SQL migrations during layer construction.
  *
- * @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/LibsqlMigrator.js

@@ -7,14 +7,14 @@ export * from "effect/unstable/sql/Migrator";
 /**
  * Runs SQL migrations using the configured `SqlClient`, returning the migrations that were applied.
  *
- * @category constructor
+ * @category constructors
  * @since 4.0.0
  */
 export const run = /*#__PURE__*/Migrator.make({});
 /**
  * Creates a layer that runs the configured SQL migrations during layer construction.
  *
- * @category constructor
+ * @category constructors
  * @since 4.0.0
  */
 export const layer = options => Layer.effectDiscard(run(options));

package/dist/index.d.ts

@@ -2,10 +2,47 @@
  * @since 4.0.0
  */
 /**
+ * libSQL client implementation for Effect SQL, backed by `@libsql/client`.
+ *
+ * This module creates or wraps a libSQL SDK client and exposes it as both the
+ * libSQL-specific `LibsqlClient` service and the generic Effect `SqlClient`.
+ * Use it for Turso-hosted libSQL databases, local `file:` databases, embedded
+ * replicas configured with `syncUrl`, migrations, tests, and application code
+ * that wants SQLite-compatible SQL through Effect services and layers.
+ *
+ * When connection options are supplied the SDK client is scoped and closed by
+ * the layer; when `liveClient` is supplied ownership stays with the caller.
+ * Top-level `withTransaction` blocks open a libSQL write transaction, nested
+ * transactions use SQLite savepoints, and only statements run through the same
+ * Effect client participate in that transaction. Keep Turso or remote libSQL
+ * transactions short, because the transaction holds the client reservation
+ * until commit or rollback; direct SDK calls made outside this service are not
+ * coordinated with Effect SQL transactions. Row streaming is not implemented.
+ *
  * @since 4.0.0
  */
 export * as LibsqlClient from "./LibsqlClient.ts";
 /**
+ * Utilities for applying Effect SQL migrations to libSQL and Turso 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 libSQL-backed `SqlClient`. It is typically used at application
+ * startup, in deployment or setup scripts for Turso databases, in tests that
+ * create temporary `file:` databases, or in layer graphs that must ensure the
+ * schema exists before dependent services are acquired.
+ *
+ * Migrations are recorded in `effect_sql_migrations` by default and are loaded
+ * using the shared `<id>_<name>` file or record-key convention. Because libSQL
+ * uses SQLite-compatible SQL, migrations should avoid dialect features that are
+ * not supported by libSQL or the configured Turso deployment. Remote Turso
+ * databases, local `file:` databases, and embedded replicas can each observe
+ * different state until replication has caught up, so run schema-changing
+ * migrations against the intended writer and wait for replicas to sync before
+ * serving code that depends on the new schema. Concurrent migrators rely on the
+ * migrations table primary key to detect races, and this adapter does not
+ * currently write schema dumps for `schemaDirectory`.
+ *
  * @since 4.0.0
  */
 export * as LibsqlMigrator from "./LibsqlMigrator.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;;;;;;;;;;;;;;;;;;;GAmBG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAEjD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA"}

package/dist/index.js

@@ -3,10 +3,47 @@
  */
 // @barrel: Auto-generated exports. Do not edit manually.
 /**
+ * libSQL client implementation for Effect SQL, backed by `@libsql/client`.
+ *
+ * This module creates or wraps a libSQL SDK client and exposes it as both the
+ * libSQL-specific `LibsqlClient` service and the generic Effect `SqlClient`.
+ * Use it for Turso-hosted libSQL databases, local `file:` databases, embedded
+ * replicas configured with `syncUrl`, migrations, tests, and application code
+ * that wants SQLite-compatible SQL through Effect services and layers.
+ *
+ * When connection options are supplied the SDK client is scoped and closed by
+ * the layer; when `liveClient` is supplied ownership stays with the caller.
+ * Top-level `withTransaction` blocks open a libSQL write transaction, nested
+ * transactions use SQLite savepoints, and only statements run through the same
+ * Effect client participate in that transaction. Keep Turso or remote libSQL
+ * transactions short, because the transaction holds the client reservation
+ * until commit or rollback; direct SDK calls made outside this service are not
+ * coordinated with Effect SQL transactions. Row streaming is not implemented.
+ *
  * @since 4.0.0
  */
 export * as LibsqlClient from "./LibsqlClient.js";
 /**
+ * Utilities for applying Effect SQL migrations to libSQL and Turso 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 libSQL-backed `SqlClient`. It is typically used at application
+ * startup, in deployment or setup scripts for Turso databases, in tests that
+ * create temporary `file:` databases, or in layer graphs that must ensure the
+ * schema exists before dependent services are acquired.
+ *
+ * Migrations are recorded in `effect_sql_migrations` by default and are loaded
+ * using the shared `<id>_<name>` file or record-key convention. Because libSQL
+ * uses SQLite-compatible SQL, migrations should avoid dialect features that are
+ * not supported by libSQL or the configured Turso deployment. Remote Turso
+ * databases, local `file:` databases, and embedded replicas can each observe
+ * different state until replication has caught up, so run schema-changing
+ * migrations against the intended writer and wait for replicas to sync before
+ * serving code that depends on the new schema. Concurrent migrators rely on the
+ * migrations table primary key to detect races, and this adapter does not
+ * currently write schema dumps for `schemaDirectory`.
+ *
  * @since 4.0.0
  */
 export * as LibsqlMigrator from "./LibsqlMigrator.js";

package/dist/index.js.map

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@effect/sql-libsql",
-  "version": "4.0.0-beta.67",
+  "version": "4.0.0-beta.69",
   "type": "module",
   "license": "MIT",
   "description": "A libSQL toolkit for Effect",
@@ -46,10 +46,10 @@
   },
   "devDependencies": {
     "testcontainers": "^11.14.0",
-    "effect": "^4.0.0-beta.67"
+    "effect": "^4.0.0-beta.69"
   },
   "peerDependencies": {
-    "effect": "^4.0.0-beta.67"
+    "effect": "^4.0.0-beta.69"
   },
   "dependencies": {
     "@libsql/client": "^0.17.3"

package/src/LibsqlClient.ts

@@ -42,7 +42,7 @@ const classifyError = (cause: unknown, message: string, operation: string) =>
 /**
  * Runtime type identifier used to mark `LibsqlClient` values.
  *
- * @category type ids
+ * @category type IDs
  * @since 4.0.0
  */
 export const TypeId: TypeId = "~@effect/sql-libsql/LibsqlClient"
@@ -50,7 +50,7 @@ export const TypeId: TypeId = "~@effect/sql-libsql/LibsqlClient"
 /**
  * Type-level identifier used to mark `LibsqlClient` values.
  *
- * @category type ids
+ * @category type IDs
  * @since 4.0.0
  */
 export type TypeId = "~@effect/sql-libsql/LibsqlClient"
@@ -170,7 +170,7 @@ interface LibsqlConnection extends Connection {
 /**
  * Creates a scoped libSQL SQL client with transaction support. When given connection options it creates and closes the SDK client; when given `liveClient`, the caller retains ownership.
  *
- * @category constructor
+ * @category constructors
  * @since 4.0.0
  */
 export const make = (

package/src/LibsqlMigrator.ts

@@ -35,7 +35,7 @@ export * from "effect/unstable/sql/Migrator"
 /**
  * Runs SQL migrations using the configured `SqlClient`, returning the migrations that were applied.
  *
- * @category constructor
+ * @category constructors
  * @since 4.0.0
  */
 export const run: <R2 = never>(
@@ -49,7 +49,7 @@ export const run: <R2 = never>(
 /**
  * Creates a layer that runs the configured SQL migrations during layer construction.
  *
- * @category constructor
+ * @category constructors
  * @since 4.0.0
  */
 export const layer = <R>(

package/src/index.ts

@@ -5,11 +5,48 @@
 // @barrel: Auto-generated exports. Do not edit manually.
 
 /**
+ * libSQL client implementation for Effect SQL, backed by `@libsql/client`.
+ *
+ * This module creates or wraps a libSQL SDK client and exposes it as both the
+ * libSQL-specific `LibsqlClient` service and the generic Effect `SqlClient`.
+ * Use it for Turso-hosted libSQL databases, local `file:` databases, embedded
+ * replicas configured with `syncUrl`, migrations, tests, and application code
+ * that wants SQLite-compatible SQL through Effect services and layers.
+ *
+ * When connection options are supplied the SDK client is scoped and closed by
+ * the layer; when `liveClient` is supplied ownership stays with the caller.
+ * Top-level `withTransaction` blocks open a libSQL write transaction, nested
+ * transactions use SQLite savepoints, and only statements run through the same
+ * Effect client participate in that transaction. Keep Turso or remote libSQL
+ * transactions short, because the transaction holds the client reservation
+ * until commit or rollback; direct SDK calls made outside this service are not
+ * coordinated with Effect SQL transactions. Row streaming is not implemented.
+ *
  * @since 4.0.0
  */
 export * as LibsqlClient from "./LibsqlClient.ts"
 
 /**
+ * Utilities for applying Effect SQL migrations to libSQL and Turso 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 libSQL-backed `SqlClient`. It is typically used at application
+ * startup, in deployment or setup scripts for Turso databases, in tests that
+ * create temporary `file:` databases, or in layer graphs that must ensure the
+ * schema exists before dependent services are acquired.
+ *
+ * Migrations are recorded in `effect_sql_migrations` by default and are loaded
+ * using the shared `<id>_<name>` file or record-key convention. Because libSQL
+ * uses SQLite-compatible SQL, migrations should avoid dialect features that are
+ * not supported by libSQL or the configured Turso deployment. Remote Turso
+ * databases, local `file:` databases, and embedded replicas can each observe
+ * different state until replication has caught up, so run schema-changing
+ * migrations against the intended writer and wait for replicas to sync before
+ * serving code that depends on the new schema. Concurrent migrators rely on the
+ * migrations table primary key to detect races, and this adapter does not
+ * currently write schema dumps for `schemaDirectory`.
+ *
  * @since 4.0.0
  */
 export * as LibsqlMigrator from "./LibsqlMigrator.ts"