dexie 4.0.1-alpha.10 → 4.0.1-alpha.12

package/dist/dexie.d.ts

@@ -4,7 +4,7 @@
  *
  * By David Fahlander, david.fahlander@gmail.com
  *
- * Version 4.0.1-alpha.10, Wed Mar 29 2023
+ * Version 4.0.1-alpha.12, Tue May 30 2023
  *
  * https://dexie.org
  *
@@ -65,6 +65,7 @@ export interface Transaction {
 	mode: IDBTransactionMode;
 	//tables: { [type: string]: Table<any, any> }; Deprecated since 2.0. Obsolete from v3.0.
 	storeNames: Array<string>;
+	explicit?: boolean;
 	parent?: Transaction;
 	on: TransactionEvents;
 	abort(): void;
@@ -357,7 +358,8 @@ export interface PromiseExtended<T = any> extends Promise<T> {
 	timeout(ms: number, msg?: string): PromiseExtended<T>;
 }
 export type KeyPaths<T> = {
-	[P in keyof T]: P extends string ? T[P] extends any[] ? P | `${P}.${number}` | `${P}.${number}.${KeyPaths<T[P][number]>}` : T[P] extends (...args: any[]) => any // Method
+	[P in keyof T]: P extends string ? T[P] extends Array<infer K> ? 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 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] : void;
@@ -416,6 +418,88 @@ export interface Collection<T = any, TKey = IndexableType> {
 	}) => void | boolean): PromiseExtended<number>;
 	modify(changes: UpdateSpec<T>): 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 DexieOnReadyEvent {
+	subscribe(fn: (vipDb: Dexie) => any, bSticky: boolean): void;
+	unsubscribe(fn: (vipDb: Dexie) => any): void;
+	fire(vipDb: Dexie): any;
+}
+export interface DexieVersionChangeEvent {
+	subscribe(fn: (event: IDBVersionChangeEvent) => any): void;
+	unsubscribe(fn: (event: IDBVersionChangeEvent) => any): void;
+	fire(event: IDBVersionChangeEvent): any;
+}
+export interface DexiePopulateEvent {
+	subscribe(fn: (trans: Transaction) => any): void;
+	unsubscribe(fn: (trans: Transaction) => any): void;
+	fire(trans: Transaction): any;
+}
+export interface DexieCloseEvent {
+	subscribe(fn: (event: Event) => any): void;
+	unsubscribe(fn: (event: Event) => any): void;
+	fire(event: Event): any;
+}
+export interface DbEvents extends DexieEventSet {
+	(eventName: "ready", subscriber: (vipDb: Dexie) => any, bSticky?: boolean): void;
+	(eventName: "populate", subscriber: (trans: Transaction) => any): void;
+	(eventName: "blocked", subscriber: (event: IDBVersionChangeEvent) => any): void;
+	(eventName: "versionchange", subscriber: (event: IDBVersionChangeEvent) => any): void;
+	(eventName: "close", subscriber: (event: Event) => any): void;
+	ready: DexieOnReadyEvent;
+	populate: DexiePopulateEvent;
+	blocked: DexieEvent;
+	versionchange: DexieVersionChangeEvent;
+	close: DexieCloseEvent;
+}
+/** Set of mutated parts of the database
+ */
+export type ObservabilitySet = {
+	/** Database part having been mutated.
+	 *
+	 * This structure is produced in observability-middleware.ts
+	 * and consumed in live-query.ts.
+	 *
+	 * Format of 'part':
+	 *
+	 *   `idb://${dbName}/${tableName}/${indexName}`
+	 *
+	 * * dbName is the database name
+	 * * tableName is the table name
+	 * * indexName is any of:
+	 *    1. An empty string - represents the primary keys of the affected objs
+	 *    2. ":dels" - represents primary keys of deleted objects in the table
+	 *    3. The keyPath of an index, such as "name", "age" or "address.city" -
+	 *       represents indexes that, if used in a query, might affect the
+	 *       result of that query.
+	 *
+	 * IntervalTree
+	 *    * See definition of IntervalTree type in rangeset.d.ts
+	 *    * See rangesOverlap() in rangeset.ts that can be used to compare two
+	 *      IntervalTrees and detect collissions.
+	 *    * See RangeSet class that can be used to create an IntervalTree and add
+	 *      ranges to it.
+	 */
+	[part: string]: IntervalTree;
+};
+export interface DexieOnStorageMutatedEvent {
+	subscribe(fn: (parts: ObservabilitySet) => any): void;
+	unsubscribe(fn: (parts: ObservabilitySet) => any): void;
+	fire(parts: ObservabilitySet): any;
+}
+export interface GlobalDexieEvents extends DexieEventSet {
+	(eventName: "storagemutated", subscriber: (parts: ObservabilitySet) => any): void;
+	storagemutated: DexieOnStorageMutatedEvent;
+}
 export const enum DBCoreRangeType {
 	Equal = 1,
 	Range = 2,
@@ -449,6 +533,7 @@ export interface DBCoreAddRequest {
 	trans: DBCoreTransaction;
 	values: readonly any[];
 	keys?: any[];
+	mutatedParts?: ObservabilitySet;
 	/** @deprecated Will always get results since 3.1.0-alpha.5 */
 	wantResults?: boolean;
 }
@@ -457,6 +542,7 @@ export interface DBCorePutRequest {
 	trans: DBCoreTransaction;
 	values: readonly any[];
 	keys?: any[];
+	mutatedParts?: ObservabilitySet;
 	criteria?: {
 		index: string | null;
 		range: DBCoreKeyRange;
@@ -477,6 +563,7 @@ export interface DBCoreDeleteRequest {
 	type: "delete";
 	trans: DBCoreTransaction;
 	keys: any[];
+	mutatedParts?: ObservabilitySet;
 	criteria?: {
 		index: string | null;
 		range: DBCoreKeyRange;
@@ -486,15 +573,18 @@ export interface DBCoreDeleteRangeRequest {
 	type: "deleteRange";
 	trans: DBCoreTransaction;
 	range: DBCoreKeyRange;
+	mutatedParts?: ObservabilitySet;
 }
 export interface DBCoreGetManyRequest {
 	trans: DBCoreTransaction;
 	keys: any[];
 	cache?: "immutable" | "clone";
+	obsSet?: ObservabilitySet;
 }
 export interface DBCoreGetRequest {
 	trans: DBCoreTransaction;
 	key: any;
+	obsSet?: ObservabilitySet;
 }
 export interface DBCoreQuery {
 	index: DBCoreIndex; //keyPath: null | string | string[]; // null represents primary key. string a property, string[] several properties.
@@ -505,6 +595,7 @@ export interface DBCoreQueryRequest {
 	values?: boolean;
 	limit?: number;
 	query: DBCoreQuery;
+	obsSet?: ObservabilitySet;
 }
 export interface DBCoreQueryResponse {
 	result: any[];
@@ -515,10 +606,12 @@ export interface DBCoreOpenCursorRequest {
 	unique?: boolean;
 	reverse?: boolean;
 	query: DBCoreQuery;
+	obsSet?: ObservabilitySet;
 }
 export interface DBCoreCountRequest {
 	trans: DBCoreTransaction;
 	query: DBCoreQuery;
+	obsSet?: ObservabilitySet;
 }
 export interface DBCoreCursor {
 	readonly trans: DBCoreTransaction;
@@ -656,88 +749,6 @@ export interface Version {
 	}): Version;
 	upgrade(fn: (trans: Transaction) => PromiseLike<any> | void): Version;
 }
-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 DexieOnReadyEvent {
-	subscribe(fn: (vipDb: Dexie) => any, bSticky: boolean): void;
-	unsubscribe(fn: (vipDb: Dexie) => any): void;
-	fire(vipDb: Dexie): any;
-}
-export interface DexieVersionChangeEvent {
-	subscribe(fn: (event: IDBVersionChangeEvent) => any): void;
-	unsubscribe(fn: (event: IDBVersionChangeEvent) => any): void;
-	fire(event: IDBVersionChangeEvent): any;
-}
-export interface DexiePopulateEvent {
-	subscribe(fn: (trans: Transaction) => any): void;
-	unsubscribe(fn: (trans: Transaction) => any): void;
-	fire(trans: Transaction): any;
-}
-export interface DexieCloseEvent {
-	subscribe(fn: (event: Event) => any): void;
-	unsubscribe(fn: (event: Event) => any): void;
-	fire(event: Event): any;
-}
-export interface DbEvents extends DexieEventSet {
-	(eventName: "ready", subscriber: (vipDb: Dexie) => any, bSticky?: boolean): void;
-	(eventName: "populate", subscriber: (trans: Transaction) => any): void;
-	(eventName: "blocked", subscriber: (event: IDBVersionChangeEvent) => any): void;
-	(eventName: "versionchange", subscriber: (event: IDBVersionChangeEvent) => any): void;
-	(eventName: "close", subscriber: (event: Event) => any): void;
-	ready: DexieOnReadyEvent;
-	populate: DexiePopulateEvent;
-	blocked: DexieEvent;
-	versionchange: DexieVersionChangeEvent;
-	close: DexieCloseEvent;
-}
-/** Set of mutated parts of the database
- */
-export type ObservabilitySet = {
-	/** Database part having been mutated.
-	 *
-	 * This structure is produced in observability-middleware.ts
-	 * and consumed in live-query.ts.
-	 *
-	 * Format of 'part':
-	 *
-	 *   `idb://${dbName}/${tableName}/${indexName}`
-	 *
-	 * * dbName is the database name
-	 * * tableName is the table name
-	 * * indexName is any of:
-	 *    1. An empty string - represents the primary keys of the affected objs
-	 *    2. ":dels" - represents primary keys of deleted objects in the table
-	 *    3. The keyPath of an index, such as "name", "age" or "address.city" -
-	 *       represents indexes that, if used in a query, might affect the
-	 *       result of that query.
-	 *
-	 * IntervalTree
-	 *    * See definition of IntervalTree type in rangeset.d.ts
-	 *    * See rangesOverlap() in rangeset.ts that can be used to compare two
-	 *      IntervalTrees and detect collissions.
-	 *    * See RangeSet class that can be used to create an IntervalTree and add
-	 *      ranges to it.
-	 */
-	[part: string]: IntervalTree;
-};
-export interface DexieOnStorageMutatedEvent {
-	subscribe(fn: (parts: ObservabilitySet) => any): void;
-	unsubscribe(fn: (parts: ObservabilitySet) => any): void;
-	fire(parts: ObservabilitySet): any;
-}
-export interface GlobalDexieEvents extends DexieEventSet {
-	(eventName: "storagemutated", subscriber: (parts: ObservabilitySet) => any): void;
-	storagemutated: DexieOnStorageMutatedEvent;
-}
 export type TransactionMode = "readonly" | "readwrite" | "r" | "r!" | "r?" | "rw" | "rw!" | "rw?";
 export type DbSchema = {
 	[tableName: string]: TableSchema;
@@ -976,6 +987,8 @@ export interface Unsubscribable {
 export interface Observable<T = any> {
 	subscribe(observerOrNext?: Observer<T> | ((value: T) => void)): Subscription;
 	subscribe(next?: ((value: T) => void) | null, error?: ((error: any) => void) | null, complete?: (() => void) | null): Subscription;
+	getValue?(): T;
+	hasValue?(): boolean;
 	[Symbol.observable]: () => Subscribable<T>;
 }
 export interface Subscription {
@@ -988,6 +1001,41 @@ export interface Observer<T = any> {
 	error?: (error: any) => void;
 	complete?: () => void;
 }
+export type GlobalQueryCache = {
+	// TODO: Change to parts: {[part: string]: TblQueryCache}
+	//       och unsignaledParts: ObservabilitySet;
+	[part: string]: TblQueryCache; // part is `idb://${dbName}/${tableName}`
+};
+export interface TblQueryCache {
+	queries: {
+		query: {
+			[indexName: string]: CacheEntry[];
+		};
+		count: {
+			[indexName: string]: CacheEntry[];
+		};
+	};
+	objs: Map<string | number, object>;
+	optimisticOps: DBCoreMutateRequest[];
+	unsignaledParts: ObservabilitySet;
+	signalTimer?: number;
+}
+export interface CacheEntryCommon {
+	subscribers: Set<() => void>;
+	obsSet: ObservabilitySet;
+	//txObsSet: ObservabilitySet;
+	promise: Promise<any>;
+	dirty: boolean;
+}
+export type CacheEntry = CacheEntryCommon & ({
+	type: "query";
+	req: DBCoreQueryRequest;
+	res?: readonly any[];
+} | {
+	type: "count";
+	req: DBCoreCountRequest;
+	res?: number;
+});
 export type ChromeTransactionDurability = "default" | "strict" | "relaxed";
 export interface DexieOptions {
 	addons?: Array<(db: Dexie) => void>;
@@ -1003,6 +1051,7 @@ export interface DexieOptions {
 	allowEmptyDB?: boolean;
 	modifyChunkSize?: number;
 	chromeTransactionDurability?: ChromeTransactionDurability;
+	cache?: "immutable" | "cloned" | "disabled";
 }
 export interface DexieConstructor extends DexieExceptionClasses {
 	new (databaseName: string, options?: DexieOptions): Dexie;
@@ -1031,6 +1080,7 @@ export interface DexieConstructor extends DexieExceptionClasses {
 	delete(dbName: string): Promise<void>;
 	dependencies: DexieDOMDependencies;
 	default: Dexie; // Work-around for different build tools handling default imports differently.
+	cache: GlobalQueryCache;
 	Promise: PromiseExtendedConstructor;
 	//TableSchema: {}; // Deprecate!
 	//IndexSpec: {new():IndexSpec}; //? Deprecate