@effect/platform-browser 4.0.0-beta.102 → 4.0.0-beta.103

package/src/IndexedDbDatabase.ts

@@ -31,12 +31,6 @@ const SchemaProto = {
   [TypeId]: {
     _A: (_: never) => _
   },
-  ...Effectable.Prototype<IndexedDbSchema<any, any, any>>({
-    label: "IndexedDbSchema",
-    evaluate() {
-      return this.getQueryBuilder
-    }
-  }),
   get getQueryBuilder() {
     const self = this as unknown as IndexedDbSchema<any, any, any>
     return IndexedDbDatabase.useSync(({ database, IDBKeyRange, reactivity }) =>
@@ -48,6 +42,12 @@ const SchemaProto = {
       })
     )
   },
+  ...Effectable.Prototype<IndexedDbSchema<any, any, any>>({
+    label: "IndexedDbSchema",
+    evaluate() {
+      return this.getQueryBuilder
+    }
+  }),
   add<Version extends IndexedDbVersion.AnyWithProps>(
     this: IndexedDbSchema<any, any, any>,
     version: Version,
@@ -126,7 +126,7 @@ export class IndexedDbDatabaseError extends Data.TaggedError(
  * @see {@link IndexedDb.IndexedDb} for the lower-level browser IndexedDB primitives
  * @see {@link make} for creating a schema that provides this service as a layer
  *
- * @category models
+ * @category services
  * @since 4.0.0
  */
 export class IndexedDbDatabase extends Context.Service<
@@ -234,7 +234,7 @@ export interface Transaction<
 /**
  * Extracts the string-literal index names defined by an `IndexedDbTable`.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type IndexFromTable<Table extends IndexedDbTable.AnyWithProps> = IsStringLiteral<
@@ -245,7 +245,7 @@ export type IndexFromTable<Table extends IndexedDbTable.AnyWithProps> = IsString
 /**
  * Extracts the valid index names for a table name within an IndexedDB version.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type IndexFromTableName<
@@ -478,6 +478,12 @@ const layer = <DatabaseName extends string>(
             Effect.provideService(IndexedDbQueryBuilder.IndexedDbTransaction, transaction)
           )
           fiber = runForkWith(effect)
+          fiber.addObserver((exit) => {
+            if (exit._tag === "Failure") {
+              transaction.abort()
+              resume(exit)
+            }
+          })
           fiber.currentDispatcher.flush()
         }
 

package/src/IndexedDbQueryBuilder.ts

@@ -136,13 +136,17 @@ export interface IndexedDbQueryBuilder<
     readonly tables: Tables
     readonly mode: Mode
     readonly durability?: IDBTransactionDurability
-  }) => <A, E, R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<A, E, Exclude<R, IndexedDbTransaction>>
+  }) => <A, E, R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<
+    A,
+    E | IndexedDbQueryError,
+    Exclude<R, IndexedDbTransaction>
+  >
 }
 
 /**
  * Valid key-path type for a table schema, using encoded fields whose values are IndexedDB-valid keys.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type KeyPath<TableSchema extends IndexedDbTable.AnySchemaStruct> =
@@ -152,7 +156,7 @@ export type KeyPath<TableSchema extends IndexedDbTable.AnySchemaStruct> =
 /**
  * Valid numeric key-path type for a table schema, used for auto-increment key paths.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type KeyPathNumber<TableSchema extends IndexedDbTable.AnySchemaStruct> =
@@ -168,7 +172,7 @@ export declare namespace IndexedDbQuery {
   /**
    * Decoded row type returned by select queries, adding a `key` field when the table does not define a key path.
    *
-   * @category models
+   * @category utility types
    * @since 4.0.0
    */
   export type SelectType<
@@ -181,7 +185,7 @@ export declare namespace IndexedDbQuery {
   /**
    * Input type for insert and upsert operations, adjusted for auto-increment keys and out-of-line keys.
    *
-   * @category models
+   * @category utility types
    * @since 4.0.0
    */
   export type ModifyType<
@@ -215,7 +219,7 @@ export declare namespace IndexedDbQuery {
   /**
    * Value type accepted by `equals` comparisons for a table key path or index.
    *
-   * @category models
+   * @category utility types
    * @since 4.0.0
    */
   export type EqualsType<
@@ -229,7 +233,7 @@ export declare namespace IndexedDbQuery {
   /**
    * Value type accepted by range comparisons for a table key path or index, including partial tuples for compound indexes.
    *
-   * @category models
+   * @category utility types
    * @since 4.0.0
    */
   export type ExtractIndexType<
@@ -248,7 +252,7 @@ export declare namespace IndexedDbQuery {
   /**
    * Mutation input type for insert and upsert operations, including any required key fields.
    *
-   * @category models
+   * @category utility types
    * @since 4.0.0
    */
   export type ModifyWithKey<Table extends IndexedDbTable.AnyWithProps> = ModifyType<Table>
@@ -719,7 +723,7 @@ export declare namespace IndexedDbQuery {
 /**
  * Service tag for the active `IDBTransaction` used to share a transaction across IndexedDB query effects.
  *
- * @category models
+ * @category services
  * @since 4.0.0
  */
 export class IndexedDbTransaction extends Context.Service<IndexedDbTransaction, globalThis.IDBTransaction>()(
@@ -752,6 +756,7 @@ const applyDelete = (query: IndexedDbQuery.Delete<any, never>) =>
       durability: query.delete.from.table.durability
     })
     const objectStore = transaction.objectStore(query.delete.from.table.tableName)
+    const store = query.delete.index === undefined ? objectStore : objectStore.index(query.delete.index)
     const predicate = query.predicate
 
     let keyRange: globalThis.IDBKeyRange | undefined = undefined
@@ -782,8 +787,8 @@ const applyDelete = (query: IndexedDbQuery.Delete<any, never>) =>
 
     let request: globalThis.IDBRequest
 
-    if (query.limitValue !== undefined || predicate) {
-      const cursorRequest = objectStore.openCursor()
+    if (query.delete.index !== undefined || query.limitValue !== undefined || predicate) {
+      const cursorRequest = store.openCursor(keyRange)
       let count = 0
 
       cursorRequest.onerror = () => {
@@ -897,7 +902,7 @@ const applySelect = Effect.fnUntraced(function*(
   const keyPath = query.from.table.keyPath
   const predicate = query.predicate
 
-  const data = predicate || keyPath === undefined || query.offsetValue !== undefined ?
+  const data = predicate || keyPath === undefined || query.offsetValue !== undefined || query.reverseValue ?
     yield* Effect.callback<Array<any>, IndexedDbQueryError>((resume) => {
       const { keyRange, store } = getReadonlyObjectStore(query)
 
@@ -1001,7 +1006,13 @@ const applyFirst = Effect.fnUntraced(function*(
       }
 
       request.onsuccess = () => {
-        resume(Effect.succeed(request.result))
+        if (request.result === undefined) {
+          resume(
+            Effect.fail(new Cause.NoSuchElementError(`No such element in table ${query.select.from.table.tableName}`))
+          )
+        } else {
+          resume(Effect.succeed(request.result))
+        }
       }
     } else {
       const request = store.openCursor()
@@ -1331,7 +1342,6 @@ const FromProto: Omit<
   | "countCache"
   | "deleteCache"
 > = {
-  ...CommonProto,
   select<Index extends IndexedDbDatabase.IndexFromTable<any>>(
     this: IndexedDbQuery.From<any>,
     index?: Index
@@ -1392,7 +1402,8 @@ const FromProto: Omit<
       database: self.database.current,
       table: self.table
     })
-  }
+  },
+  ...CommonProto
 }
 
 const makeFrom = <
@@ -1516,7 +1527,7 @@ const DeleteProto: Omit<
   filter(this: IndexedDbQuery.Delete<any, never>, filter: (value: IndexedDbTable.Encoded<any>) => boolean) {
     const prev = this.predicate
     return makeDelete({
-      delete: this.delete,
+      ...this,
       predicate: prev ? (item) => prev(item) && filter(item) : filter
     })
   },
@@ -1760,18 +1771,22 @@ const SelectProto: Omit<
   }) {
     const limit = this.limitValue
     const chunkSize = Math.min(options?.chunkSize ?? 100, limit ?? Number.MAX_SAFE_INTEGER)
-    const initial = this.limit(chunkSize)
+    const initialOffset = this.offsetValue ?? 0
     return Stream.suspend(() => {
       let total = 0
+      const initial = this.limit(chunkSize)
       return Stream.paginate(initial, (select) =>
         Effect.map(
           applySelect(select as any),
           (data) => {
             total += data.length
-            ;(select as any).offsetValue = total
             const reachedLimit = limit && total >= limit
             const isPartial = data.length < chunkSize
-            return [data, isPartial || reachedLimit ? Option.none() : Option.some(select)] as const
+            const next = makeSelect({
+              ...select,
+              offsetValue: initialOffset + total
+            })
+            return [data, isPartial || reachedLimit ? Option.none() : Option.some(next)] as const
           }
         ))
     })
@@ -1951,7 +1966,6 @@ const QueryBuilderProto: Omit<
   | "IDBTransaction"
   | "reactivity"
 > = {
-  ...CommonProto,
   use(this: IndexedDbQueryBuilder<any>, f: (database: globalThis.IDBDatabase) => any) {
     return Effect.try({
       try: () => f(this.database.current),
@@ -1979,6 +1993,7 @@ const QueryBuilderProto: Omit<
     const self = this as IndexedDbQueryBuilder<any>
     return applyClearAll({ database: self.database.current })
   },
+  ...CommonProto,
   withTransaction(this: IndexedDbQueryBuilder<any>, options: {
     readonly tables: NonEmptyReadonlyArray<any>
     readonly mode: globalThis.IDBTransactionMode
@@ -1987,7 +2002,11 @@ const QueryBuilderProto: Omit<
     return (effect) =>
       Effect.suspend(() => {
         const transaction = this.database.current.transaction(options.tables, options.mode, options)
-        return Effect.provideService(effect, IndexedDbTransaction, transaction)
+        return Effect.provideService(effect, IndexedDbTransaction, transaction).pipe(
+          Effect.onExit((exit) =>
+            exit._tag === "Success" ? awaitTransaction(transaction) : abortTransaction(transaction)
+          )
+        )
       }).pipe(
         // To prevent async gaps between transaction queries
         Effect.provideService(References.PreventSchedulerYield, true)
@@ -1995,6 +2014,30 @@ const QueryBuilderProto: Omit<
   }
 }
 
+const abortTransaction = (transaction: globalThis.IDBTransaction) =>
+  Effect.try({
+    try: () => transaction.abort(),
+    catch: () => undefined
+  }).pipe(Effect.ignore)
+
+const awaitTransaction = (transaction: globalThis.IDBTransaction) =>
+  Effect.callback<void, IndexedDbQueryError>((resume) => {
+    transaction.oncomplete = () => {
+      resume(Effect.void)
+    }
+    transaction.onabort = () => {
+      resume(
+        Effect.fail(
+          new IndexedDbQueryError({
+            reason: "TransactionError",
+            cause: transaction.error
+          })
+        )
+      )
+    }
+    return abortTransaction(transaction)
+  })
+
 /**
  * Creates an `IndexedDbQueryBuilder` from an open database reference, key-range constructor, table map, and reactivity service.
  *

package/src/IndexedDbTable.ts

@@ -23,7 +23,7 @@ const TypeId = "~@effect/platform-browser/IndexedDbTable"
 /**
  * Typed IndexedDB table definition containing its name, schema, key path, indexes, auto-increment setting, and transaction durability.
  *
- * @category interface
+ * @category models
  * @since 4.0.0
  */
 export interface IndexedDbTable<
@@ -94,14 +94,14 @@ export type AnyWithProps = IndexedDbTable<
 /**
  * Extracts the table name type from an `IndexedDbTable`.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type TableName<Table extends Any> = Table["tableName"]
 /**
  * Extracts the key-path type from an `IndexedDbTable`.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type KeyPath<Table extends Any> = Table["keyPath"]
@@ -109,7 +109,7 @@ export type KeyPath<Table extends Any> = Table["keyPath"]
 /**
  * Extracts the auto-increment flag type from an `IndexedDbTable`.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type AutoIncrement<Table extends Any> = Table["autoIncrement"]
@@ -117,14 +117,14 @@ export type AutoIncrement<Table extends Any> = Table["autoIncrement"]
 /**
  * Extracts the schema type from an `IndexedDbTable`.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type TableSchema<Table extends Any> = Table["tableSchema"]
 /**
  * Extracts the decoding or encoding service requirements needed by an `IndexedDbTable` schema.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type Context<Table extends Any> =
@@ -134,7 +134,7 @@ export type Context<Table extends Any> =
 /**
  * Extracts the encoded row type from an `IndexedDbTable` schema.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type Encoded<Table extends Any> = Table["tableSchema"]["Encoded"]
@@ -142,7 +142,7 @@ export type Encoded<Table extends Any> = Table["tableSchema"]["Encoded"]
 /**
  * Extracts the index definition map from an `IndexedDbTable`.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type Indexes<Table extends Any> = Table["indexes"]
@@ -150,7 +150,7 @@ export type Indexes<Table extends Any> = Table["indexes"]
 /**
  * Selects the table with the given name from a union of `IndexedDbTable` types.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type WithName<Table extends Any, TableName extends string> = Extract<

package/src/IndexedDbVersion.ts

@@ -27,7 +27,7 @@ const TypeId = "~@effect/platform-browser/IndexedDbVersion"
 /**
  * Typed IndexedDB version definition containing the tables available in that schema version.
  *
- * @category interface
+ * @category models
  * @since 4.0.0
  */
 export interface IndexedDbVersion<
@@ -59,7 +59,7 @@ export type AnyWithProps = IndexedDbVersion<IndexedDbTable.AnyWithProps>
 /**
  * Extracts the table union from an `IndexedDbVersion`.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type Tables<Db extends Any> = Db extends IndexedDbVersion<infer _Tables> ? _Tables : never
@@ -67,7 +67,7 @@ export type Tables<Db extends Any> = Db extends IndexedDbVersion<infer _Tables>
 /**
  * Selects a table by name from an `IndexedDbVersion`.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type TableWithName<
@@ -78,7 +78,7 @@ export type TableWithName<
 /**
  * Extracts the schema for a named table within an `IndexedDbVersion`.
  *
- * @category models
+ * @category utility types
  * @since 4.0.0
  */
 export type SchemaWithName<

package/src/Permissions.ts

@@ -21,7 +21,7 @@ const ErrorTypeId = "~@effect/platform-browser/Permissions/PermissionsError"
  * Wrapper on the Permission API (`navigator.permissions`) with methods for
  * querying status of permissions.
  *
- * @category models
+ * @category services
  * @since 4.0.0
  */
 export interface Permissions {