dexie 4.1.0-alpha.2 → 4.1.0-alpha.23

package/dist/dexie.d.ts

@@ -4,7 +4,7 @@
  *
  * By David Fahlander, david.fahlander@gmail.com
  *
- * Version 4.1.0-alpha.2, Fri Oct 04 2024
+ * Version 4.1.0-alpha.23, Wed Nov 27 2024
  *
  * https://dexie.org
  *
@@ -364,6 +364,119 @@ export interface PromiseExtended<T = any> extends Promise<T> {
 	finally<U>(onFinally?: () => U | PromiseLike<U>): PromiseExtended<T>;
 	timeout(ms: number, msg?: string): PromiseExtended<T>;
 }
+export type KeyPathIgnoreObject = ArrayBuffer | ArrayBufferView | RegExp | Blob | FileList | FileSystemFileHandle | FileSystemDirectoryHandle | DataView | ImageBitmap | ImageData | Map<any, any> | Set<any> | CryptoKey | Promise<any> | ReadableStream<any> | ReadableStreamDefaultReader<any> | ReadableStreamDefaultController<any> | {
+	whenLoaded: Promise<any>;
+}; // Y.Doc
+export type KeyPaths<T, MAXDEPTH = "II", CURRDEPTH extends string = ""> = {
+	[P in keyof T]: P extends string ? CURRDEPTH extends MAXDEPTH ? P : T[P] extends Array<infer K> ? K extends any[] // Array of arrays (issue #2026)
+	 ? P | `${P}.${number}` | `${P}.${number}.${number}` : K extends object // only drill into the array element if it's an object
+	 ? P | `${P}.${number}` | `${P}.${number}.${KeyPaths<Required<K>>}` : P | `${P}.${number}` : T[P] extends (...args: any[]) => any // Method
+	 ? never : T[P] extends KeyPathIgnoreObject // Not valid in update spec or where clause (+ avoid circular reference)
+	 ? P : T[P] extends object ? P | `${P}.${KeyPaths<Required<T[P]>, MAXDEPTH, `${CURRDEPTH}I`>}` : P : never;
+}[keyof T];
+export type KeyPathValue<T, PATH> = PATH extends `${infer R}.${infer S}` ? R extends keyof T ? KeyPathValue<Required<T[R]>, S> : T extends any[] ? PATH extends `${number}.${infer S}` ? KeyPathValue<Required<T[number]>, S> : void : void : PATH extends `${number}` ? T extends any[] ? T[number] : void : PATH extends keyof T ? T[PATH] : any;
+export declare const PropModSymbol: unique symbol;
+export type PropModSpec = {
+	replacePrefix?: [
+		string,
+		string
+	];
+	add?: number | bigint | Array<string | number>;
+	remove?: number | bigint | Array<string | number>;
+};
+export class PropModification implements PropModSpec {
+	[PropModSymbol]?: true;
+	replacePrefix?: [
+		string,
+		string
+	];
+	add?: number | bigint | Array<string | number>;
+	remove?: number | bigint | Array<string | number>;
+	execute<T>(value: T): T;
+	constructor(spec: PropModSpec);
+}
+export type UpdateSpec<T> = {
+	[KP in KeyPaths<Required<T>>]?: KeyPathValue<Required<T>, KP> | PropModification;
+};
+export interface Collection<T = any, TKey = IndexableType, TInsertType = T> {
+	db: Dexie;
+	and(filter: (x: T) => boolean): Collection<T, TKey, TInsertType>;
+	clone(props?: Object): Collection<T, TKey, TInsertType>;
+	count(): PromiseExtended<number>;
+	count<R>(thenShortcut: ThenShortcut<number, R>): PromiseExtended<R>;
+	distinct(): Collection<T, TKey, TInsertType>;
+	each(callback: (obj: T, cursor: {
+		key: IndexableType;
+		primaryKey: TKey;
+	}) => any): PromiseExtended<void>;
+	eachKey(callback: (key: IndexableType, cursor: {
+		key: IndexableType;
+		primaryKey: TKey;
+	}) => any): PromiseExtended<void>;
+	eachPrimaryKey(callback: (key: TKey, cursor: {
+		key: IndexableType;
+		primaryKey: TKey;
+	}) => any): PromiseExtended<void>;
+	eachUniqueKey(callback: (key: IndexableType, cursor: {
+		key: IndexableType;
+		primaryKey: TKey;
+	}) => any): PromiseExtended<void>;
+	filter<S extends T>(filter: (x: T) => x is S): Collection<S, TKey>;
+	filter(filter: (x: T) => boolean): Collection<T, TKey, TInsertType>;
+	first(): PromiseExtended<T | undefined>;
+	first<R>(thenShortcut: ThenShortcut<T | undefined, R>): PromiseExtended<R>;
+	keys(): PromiseExtended<IndexableTypeArray>;
+	keys<R>(thenShortcut: ThenShortcut<IndexableTypeArray, R>): PromiseExtended<R>;
+	primaryKeys(): PromiseExtended<TKey[]>;
+	primaryKeys<R>(thenShortcut: ThenShortcut<TKey[], R>): PromiseExtended<R>;
+	last(): PromiseExtended<T | undefined>;
+	last<R>(thenShortcut: ThenShortcut<T | undefined, R>): PromiseExtended<R>;
+	limit(n: number): Collection<T, TKey, TInsertType>;
+	offset(n: number): Collection<T, TKey, TInsertType>;
+	or(indexOrPrimayKey: string): WhereClause<T, TKey, TInsertType>;
+	raw(): Collection<T, TKey, TInsertType>;
+	reverse(): Collection<T, TKey, TInsertType>;
+	sortBy(keyPath: string): PromiseExtended<T[]>;
+	sortBy<R>(keyPath: string, thenShortcut: ThenShortcut<T[], R>): PromiseExtended<R>;
+	toArray(): PromiseExtended<Array<T>>;
+	toArray<R>(thenShortcut: ThenShortcut<T[], R>): PromiseExtended<R>;
+	uniqueKeys(): PromiseExtended<IndexableTypeArray>;
+	uniqueKeys<R>(thenShortcut: ThenShortcut<IndexableTypeArray, R>): PromiseExtended<R>;
+	until(filter: (value: T) => boolean, includeStopEntry?: boolean): Collection<T, TKey, TInsertType>;
+	// Mutating methods
+	delete(): PromiseExtended<number>;
+	modify(changeCallback: (obj: T, ctx: {
+		value: TInsertType;
+	}) => void | boolean): PromiseExtended<number>;
+	modify(changes: UpdateSpec<TInsertType>): PromiseExtended<number>;
+}
+export type IntervalTree = IntervalTreeNode | EmptyRange;
+export interface IntervalTreeNode {
+	from: IndexableType; // lower bound
+	to: IndexableType; // upper bound
+	l?: IntervalTreeNode | null; // left
+	r?: IntervalTreeNode | null; // right
+	d: number; // depth
+}
+export interface EmptyRange {
+	d: 0;
+}
+export interface RangeSetPrototype {
+	add(rangeSet: IntervalTree | {
+		from: IndexableType;
+		to: IndexableType;
+	}): RangeSet;
+	addKey(key: IndexableType): RangeSet;
+	addKeys(keys: IndexableType[]): RangeSet;
+	hasKey(key: IndexableType): boolean;
+	[Symbol.iterator](): Iterator<IntervalTreeNode, undefined, IndexableType | undefined>;
+}
+export type RangeSet = RangeSetPrototype & IntervalTree;
+export interface RangeSetConstructor {
+	(tree: IntervalTree): RangeSet;
+	new (): RangeSet;
+	new (from: IndexableType, to?: IndexableType): RangeSet;
+}
 // There typings are extracted from https://github.com/tc39/proposal-observable
 declare global {
 	interface SymbolConstructor {
@@ -530,116 +643,6 @@ export interface YDocCache {
 	add: (doc: YjsDoc) => void;
 	delete: (doc: YjsDoc) => void;
 }
-export type KeyPaths<T> = {
-	[P in keyof T]: P extends string ? T[P] extends Array<infer K> ? K extends any[] // Array of arrays (issue #2026)
-	 ? P | `${P}.${number}` | `${P}.${number}.${number}` : K extends object // only drill into the array element if it's an object
-	 ? P | `${P}.${number}` | `${P}.${number}.${KeyPaths<K>}` : P | `${P}.${number}` : T[P] extends (...args: any[]) => any // Method
-	 ? never : T[P] extends YjsDoc // Not valid in update spec or where clause (+ avoid circular reference)
-	 ? never : T[P] extends object ? P | `${P}.${KeyPaths<T[P]>}` : P : never;
-}[keyof T];
-export type KeyPathValue<T, PATH> = PATH extends `${infer R}.${infer S}` ? R extends keyof T ? KeyPathValue<T[R], S> : T extends any[] ? PATH extends `${number}.${infer S}` ? KeyPathValue<T[number], S> : void : void : PATH extends `${number}` ? T extends any[] ? T[number] : void : PATH extends keyof T ? T[PATH] : any;
-export declare const PropModSymbol: unique symbol;
-export type PropModSpec = {
-	replacePrefix?: [
-		string,
-		string
-	];
-	add?: number | bigint | Array<string | number>;
-	remove?: number | bigint | Array<string | number>;
-};
-export class PropModification implements PropModSpec {
-	[PropModSymbol]?: true;
-	replacePrefix?: [
-		string,
-		string
-	];
-	add?: number | bigint | Array<string | number>;
-	remove?: number | bigint | Array<string | number>;
-	execute<T>(value: T): T;
-	constructor(spec: PropModSpec);
-}
-export type UpdateSpec<T> = {
-	[KP in KeyPaths<T>]?: KeyPathValue<T, KP> | PropModification;
-};
-export interface Collection<T = any, TKey = IndexableType, TInsertType = T> {
-	db: Dexie;
-	and(filter: (x: T) => boolean): Collection<T, TKey, TInsertType>;
-	clone(props?: Object): Collection<T, TKey, TInsertType>;
-	count(): PromiseExtended<number>;
-	count<R>(thenShortcut: ThenShortcut<number, R>): PromiseExtended<R>;
-	distinct(): Collection<T, TKey, TInsertType>;
-	each(callback: (obj: T, cursor: {
-		key: IndexableType;
-		primaryKey: TKey;
-	}) => any): PromiseExtended<void>;
-	eachKey(callback: (key: IndexableType, cursor: {
-		key: IndexableType;
-		primaryKey: TKey;
-	}) => any): PromiseExtended<void>;
-	eachPrimaryKey(callback: (key: TKey, cursor: {
-		key: IndexableType;
-		primaryKey: TKey;
-	}) => any): PromiseExtended<void>;
-	eachUniqueKey(callback: (key: IndexableType, cursor: {
-		key: IndexableType;
-		primaryKey: TKey;
-	}) => any): PromiseExtended<void>;
-	filter<S extends T>(filter: (x: T) => x is S): Collection<S, TKey>;
-	filter(filter: (x: T) => boolean): Collection<T, TKey, TInsertType>;
-	first(): PromiseExtended<T | undefined>;
-	first<R>(thenShortcut: ThenShortcut<T | undefined, R>): PromiseExtended<R>;
-	keys(): PromiseExtended<IndexableTypeArray>;
-	keys<R>(thenShortcut: ThenShortcut<IndexableTypeArray, R>): PromiseExtended<R>;
-	primaryKeys(): PromiseExtended<TKey[]>;
-	primaryKeys<R>(thenShortcut: ThenShortcut<TKey[], R>): PromiseExtended<R>;
-	last(): PromiseExtended<T | undefined>;
-	last<R>(thenShortcut: ThenShortcut<T | undefined, R>): PromiseExtended<R>;
-	limit(n: number): Collection<T, TKey, TInsertType>;
-	offset(n: number): Collection<T, TKey, TInsertType>;
-	or(indexOrPrimayKey: string): WhereClause<T, TKey, TInsertType>;
-	raw(): Collection<T, TKey, TInsertType>;
-	reverse(): Collection<T, TKey, TInsertType>;
-	sortBy(keyPath: string): PromiseExtended<T[]>;
-	sortBy<R>(keyPath: string, thenShortcut: ThenShortcut<T[], R>): PromiseExtended<R>;
-	toArray(): PromiseExtended<Array<T>>;
-	toArray<R>(thenShortcut: ThenShortcut<T[], R>): PromiseExtended<R>;
-	uniqueKeys(): PromiseExtended<IndexableTypeArray>;
-	uniqueKeys<R>(thenShortcut: ThenShortcut<IndexableTypeArray, R>): PromiseExtended<R>;
-	until(filter: (value: T) => boolean, includeStopEntry?: boolean): Collection<T, TKey, TInsertType>;
-	// Mutating methods
-	delete(): PromiseExtended<number>;
-	modify(changeCallback: (obj: T, ctx: {
-		value: TInsertType;
-	}) => void | boolean): PromiseExtended<number>;
-	modify(changes: UpdateSpec<TInsertType>): PromiseExtended<number>;
-}
-export type IntervalTree = IntervalTreeNode | EmptyRange;
-export interface IntervalTreeNode {
-	from: IndexableType; // lower bound
-	to: IndexableType; // upper bound
-	l?: IntervalTreeNode | null; // left
-	r?: IntervalTreeNode | null; // right
-	d: number; // depth
-}
-export interface EmptyRange {
-	d: 0;
-}
-export interface RangeSetPrototype {
-	add(rangeSet: IntervalTree | {
-		from: IndexableType;
-		to: IndexableType;
-	}): RangeSet;
-	addKey(key: IndexableType): RangeSet;
-	addKeys(keys: IndexableType[]): RangeSet;
-	hasKey(key: IndexableType): boolean;
-	[Symbol.iterator](): Iterator<IntervalTreeNode, undefined, IndexableType | undefined>;
-}
-export type RangeSet = RangeSetPrototype & IntervalTree;
-export interface RangeSetConstructor {
-	(tree: IntervalTree): RangeSet;
-	new (): RangeSet;
-	new (from: IndexableType, to?: IndexableType): RangeSet;
-}
 export interface DexieOnReadyEvent {
 	subscribe(fn: (vipDb: Dexie) => any, bSticky: boolean): void;
 	unsubscribe(fn: (vipDb: Dexie) => any): void;
@@ -746,7 +749,7 @@ export interface DBCoreMutateResponse {
 		[operationNumber: number]: Error;
 	};
 	lastResult: any;
-	results?: any[]; // Present on AddRequest and PutRequest.
+	results?: any[]; // Always present on responses to AddRequest and PutRequest.
 }
 export interface DBCoreAddRequest {
 	type: "add";
@@ -935,11 +938,10 @@ export interface Table<T = any, TKey = any, TInsertType = T> {
 	reverse(): Collection<T, TKey, TInsertType>;
 	mapToClass(constructor: Function): Function;
 	add(item: TInsertType, key?: TKey): PromiseExtended<TKey>;
-	update(key: TKey | T, changes: ((obj: T, ctx: {
+	update(key: TKey | T, changes: UpdateSpec<TInsertType> | ((obj: T, ctx: {
 		value: any;
 		primKey: IndexableType;
 	}) => void | boolean)): PromiseExtended<number>;
-	update(key: TKey | T, changes: UpdateSpec<TInsertType>): PromiseExtended<number>;
 	put(item: TInsertType, key?: TKey): PromiseExtended<TKey>;
 	delete(key: TKey): PromiseExtended<void>;
 	clear(): PromiseExtended<void>;
@@ -989,7 +991,7 @@ export interface Middleware<TStack extends {
 export interface DexieStacks {
 	dbcore: DBCore;
 }
-export type TableProp<DX extends Dexie> = {
+export type TableProp<DX> = {
 	[K in keyof DX]: DX[K] extends {
 		schema: any;
 		get: any;
@@ -1252,14 +1254,17 @@ export interface DexieOptions {
 		upperBound: Function;
 	};
 	allowEmptyDB?: boolean;
-	modifyChunkSize?: number;
+	modifyChunkSize?: number | {
+		[key: string]: number;
+	};
 	chromeTransactionDurability?: ChromeTransactionDurability;
 	cache?: "immutable" | "cloned" | "disabled";
 	Y?: YjsLib; // Caller supplies Y from the following: import * as Y from 'yjs';
+	gc?: boolean;
 }
 export interface DexieConstructor extends DexieExceptionClasses {
 	new (databaseName: string, options?: DexieOptions): Dexie;
-	prototype: Dexie;
+	prototype: any;
 	addons: Array<(db: Dexie) => void>;
 	version: number;
 	semVer: string;