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

package/dist/SqliteClient.d.ts

@@ -30,14 +30,14 @@ import * as Client from "effect/unstable/sql/SqlClient";
 /**
  * Runtime type identifier used to mark Cloudflare Durable Object `SqliteClient` values.
  *
- * @category type ids
+ * @category type IDs
  * @since 4.0.0
  */
 export declare const TypeId: TypeId;
 /**
  * Type-level identifier used to mark Cloudflare Durable Object `SqliteClient` values.
  *
- * @category type ids
+ * @category type IDs
  * @since 4.0.0
  */
 export type TypeId = "~@effect/sql-sqlite-do/SqliteClient";
@@ -75,7 +75,7 @@ export interface SqliteClientConfig {
 /**
  * Creates a scoped Cloudflare Durable Object SQLite client around `SqlStorage`, serializing access and converting returned `ArrayBuffer` values to `Uint8Array`.
  *
- * @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

@@ -19,7 +19,7 @@ const classifyError = (cause, message, operation) => classifySqliteError(cause,
 /**
  * Runtime type identifier used to mark Cloudflare Durable Object `SqliteClient` values.
  *
- * @category type ids
+ * @category type IDs
  * @since 4.0.0
  */
 export const TypeId = "~@effect/sql-sqlite-do/SqliteClient";
@@ -33,7 +33,7 @@ export const SqliteClient = /*#__PURE__*/Context.Service("@effect/sql-sqlite-do/
 /**
  * Creates a scoped Cloudflare Durable Object SQLite client around `SqlStorage`, serializing access and converting returned `ArrayBuffer` values to `Uint8Array`.
  *
- * @category constructor
+ * @category constructors
  * @since 4.0.0
  */
 export const make = options => Effect.gen(function* () {

package/dist/SqliteMigrator.d.ts

@@ -34,14 +34,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>({ loader, schemaDirectory, table }: 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/SqliteMigrator.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,49 @@
  * @since 4.0.0
  */
 /**
+ * Provides an Effect SQL client for Cloudflare Durable Object SQLite storage.
+ *
+ * This module adapts a Durable Object `SqlStorage` handle into both the
+ * Durable Object-specific `SqliteClient` service and the generic Effect
+ * `SqlClient` service. Use it from inside a Durable Object to run local
+ * per-object queries, repositories, migrations, transactional read/write
+ * workflows, and tests that exercise Cloudflare's SQLite-backed storage API.
+ *
+ * Durable Object SQLite storage is scoped to one object id, so each object
+ * instance has its own database and callers should pass the same `SqlStorage`
+ * handle that the object uses for normal reads and writes. This adapter
+ * serializes Effect SQL access through one connection; a transaction holds that
+ * permit for the lifetime of its scope, so keep transactions short, avoid
+ * suspending them across unrelated work, and use them when multi-statement
+ * writes must commit atomically. `SqlStorage.exec` returns `ArrayBuffer` values
+ * for SQLite blobs, which this client normalizes to `Uint8Array`, and SQLite
+ * does not support `updateValues`.
+ *
  * @since 4.0.0
  */
 export * as SqliteClient from "./SqliteClient.ts";
 /**
+ * Utilities for applying Effect SQL migrations to Cloudflare Durable Object SQLite storage.
+ *
+ * This module re-exports the shared `Migrator` loaders and error types, then
+ * provides `run` and `layer` helpers that execute ordered migrations through the
+ * current Durable Object `SqlStorage`-backed `SqlClient`. Use it when a Durable
+ * Object needs to create or upgrade its local schema during construction, before
+ * repositories or request handlers use the object storage, or in tests that
+ * exercise Durable Object persistence.
+ *
+ * Migrations are recorded in `effect_sql_migrations` by default and are loaded
+ * using the shared `<id>_<name>` file or record-key convention. The underlying
+ * storage is scoped to a Durable Object id, so running migrations for one object
+ * does not update any other object instance; run the migrator against the same
+ * `SqlStorage` handle that the object uses for normal queries. These SQL
+ * migrations are separate from Cloudflare's Durable Object class migrations, and
+ * the Durable Object must already be configured with SQLite storage before this
+ * module can apply schema changes. Repeated startup runs are expected and are
+ * guarded by the migrations table, but request handling should wait until the
+ * migration layer has finished. 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;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAEjD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA"}

package/dist/index.js

@@ -3,10 +3,49 @@
  */
 // @barrel: Auto-generated exports. Do not edit manually.
 /**
+ * Provides an Effect SQL client for Cloudflare Durable Object SQLite storage.
+ *
+ * This module adapts a Durable Object `SqlStorage` handle into both the
+ * Durable Object-specific `SqliteClient` service and the generic Effect
+ * `SqlClient` service. Use it from inside a Durable Object to run local
+ * per-object queries, repositories, migrations, transactional read/write
+ * workflows, and tests that exercise Cloudflare's SQLite-backed storage API.
+ *
+ * Durable Object SQLite storage is scoped to one object id, so each object
+ * instance has its own database and callers should pass the same `SqlStorage`
+ * handle that the object uses for normal reads and writes. This adapter
+ * serializes Effect SQL access through one connection; a transaction holds that
+ * permit for the lifetime of its scope, so keep transactions short, avoid
+ * suspending them across unrelated work, and use them when multi-statement
+ * writes must commit atomically. `SqlStorage.exec` returns `ArrayBuffer` values
+ * for SQLite blobs, which this client normalizes to `Uint8Array`, and SQLite
+ * does not support `updateValues`.
+ *
  * @since 4.0.0
  */
 export * as SqliteClient from "./SqliteClient.js";
 /**
+ * Utilities for applying Effect SQL migrations to Cloudflare Durable Object SQLite storage.
+ *
+ * This module re-exports the shared `Migrator` loaders and error types, then
+ * provides `run` and `layer` helpers that execute ordered migrations through the
+ * current Durable Object `SqlStorage`-backed `SqlClient`. Use it when a Durable
+ * Object needs to create or upgrade its local schema during construction, before
+ * repositories or request handlers use the object storage, or in tests that
+ * exercise Durable Object persistence.
+ *
+ * Migrations are recorded in `effect_sql_migrations` by default and are loaded
+ * using the shared `<id>_<name>` file or record-key convention. The underlying
+ * storage is scoped to a Durable Object id, so running migrations for one object
+ * does not update any other object instance; run the migrator against the same
+ * `SqlStorage` handle that the object uses for normal queries. These SQL
+ * migrations are separate from Cloudflare's Durable Object class migrations, and
+ * the Durable Object must already be configured with SQLite storage before this
+ * module can apply schema changes. Repeated startup runs are expected and are
+ * guarded by the migrations table, but request handling should wait until the
+ * migration layer has finished. 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;;;;;;;;;;;;;;;;;;;;;AAqBA,OAAO,KAAKA,YAAY,MAAM,mBAAmB;AAEjD;;;;;;;;;;;;;;;;;;;;;;;;AAwBA,OAAO,KAAKC,cAAc,MAAM,qBAAqB","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@effect/sql-sqlite-do",
-  "version": "4.0.0-beta.67",
+  "version": "4.0.0-beta.68",
   "type": "module",
   "license": "MIT",
   "description": "A SQLite toolkit for Effect",
@@ -44,10 +44,10 @@
   },
   "devDependencies": {
     "@cloudflare/workers-types": "^4.20260511.1",
-    "effect": "^4.0.0-beta.67"
+    "effect": "^4.0.0-beta.68"
   },
   "peerDependencies": {
-    "effect": "^4.0.0-beta.67"
+    "effect": "^4.0.0-beta.68"
   },
   "scripts": {
     "codegen": "effect-utils codegen",

package/src/SqliteClient.ts

@@ -43,7 +43,7 @@ const classifyError = (cause: unknown, message: string, operation: string) =>
 /**
  * Runtime type identifier used to mark Cloudflare Durable Object `SqliteClient` values.
  *
- * @category type ids
+ * @category type IDs
  * @since 4.0.0
  */
 export const TypeId: TypeId = "~@effect/sql-sqlite-do/SqliteClient"
@@ -51,7 +51,7 @@ export const TypeId: TypeId = "~@effect/sql-sqlite-do/SqliteClient"
 /**
  * Type-level identifier used to mark Cloudflare Durable Object `SqliteClient` values.
  *
- * @category type ids
+ * @category type IDs
  * @since 4.0.0
  */
 export type TypeId = "~@effect/sql-sqlite-do/SqliteClient"
@@ -95,7 +95,7 @@ export interface SqliteClientConfig {
 /**
  * Creates a scoped Cloudflare Durable Object SQLite client around `SqlStorage`, serializing access and converting returned `ArrayBuffer` values to `Uint8Array`.
  *
- * @category constructor
+ * @category constructors
  * @since 4.0.0
  */
 export const make = (

package/src/SqliteMigrator.ts

@@ -36,7 +36,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>(
@@ -50,7 +50,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,50 @@
 // @barrel: Auto-generated exports. Do not edit manually.
 
 /**
+ * Provides an Effect SQL client for Cloudflare Durable Object SQLite storage.
+ *
+ * This module adapts a Durable Object `SqlStorage` handle into both the
+ * Durable Object-specific `SqliteClient` service and the generic Effect
+ * `SqlClient` service. Use it from inside a Durable Object to run local
+ * per-object queries, repositories, migrations, transactional read/write
+ * workflows, and tests that exercise Cloudflare's SQLite-backed storage API.
+ *
+ * Durable Object SQLite storage is scoped to one object id, so each object
+ * instance has its own database and callers should pass the same `SqlStorage`
+ * handle that the object uses for normal reads and writes. This adapter
+ * serializes Effect SQL access through one connection; a transaction holds that
+ * permit for the lifetime of its scope, so keep transactions short, avoid
+ * suspending them across unrelated work, and use them when multi-statement
+ * writes must commit atomically. `SqlStorage.exec` returns `ArrayBuffer` values
+ * for SQLite blobs, which this client normalizes to `Uint8Array`, and SQLite
+ * does not support `updateValues`.
+ *
  * @since 4.0.0
  */
 export * as SqliteClient from "./SqliteClient.ts"
 
 /**
+ * Utilities for applying Effect SQL migrations to Cloudflare Durable Object SQLite storage.
+ *
+ * This module re-exports the shared `Migrator` loaders and error types, then
+ * provides `run` and `layer` helpers that execute ordered migrations through the
+ * current Durable Object `SqlStorage`-backed `SqlClient`. Use it when a Durable
+ * Object needs to create or upgrade its local schema during construction, before
+ * repositories or request handlers use the object storage, or in tests that
+ * exercise Durable Object persistence.
+ *
+ * Migrations are recorded in `effect_sql_migrations` by default and are loaded
+ * using the shared `<id>_<name>` file or record-key convention. The underlying
+ * storage is scoped to a Durable Object id, so running migrations for one object
+ * does not update any other object instance; run the migrator against the same
+ * `SqlStorage` handle that the object uses for normal queries. These SQL
+ * migrations are separate from Cloudflare's Durable Object class migrations, and
+ * the Durable Object must already be configured with SQLite storage before this
+ * module can apply schema changes. Repeated startup runs are expected and are
+ * guarded by the migrations table, but request handling should wait until the
+ * migration layer has finished. This adapter does not currently write SQLite
+ * schema dumps for `schemaDirectory`.
+ *
  * @since 4.0.0
  */
 export * as SqliteMigrator from "./SqliteMigrator.ts"