dexie 4.0.1-beta.8 → 4.0.1-beta.9

package/dist/dexie.d.ts

@@ -4,7 +4,7 @@
  *
  * By David Fahlander, david.fahlander@gmail.com
  *
- * Version 4.0.1-beta.8, Wed Feb 07 2024
+ * Version 4.0.1-beta.9, Thu Feb 08 2024
  *
  * https://dexie.org
  *
@@ -85,7 +85,7 @@ export interface DeletingHookContext<T, Key> {
 	onsuccess?: () => void;
 	onerror?: (err: any) => void;
 }
-export interface TableHooks<T = any, TKey = IndexableType> extends DexieEventSet {
+export interface TableHooks<T = any, TKey = IndexableType, TInsertType = T> extends DexieEventSet {
 	(eventName: "creating", subscriber: (this: CreatingHookContext<T, TKey>, primKey: TKey, obj: T, transaction: Transaction) => void | undefined | TKey): void;
 	(eventName: "reading", subscriber: (obj: T) => T | any): void;
 	(eventName: "updating", subscriber: (this: UpdatingHookContext<T, TKey>, modifications: Object, primKey: TKey, obj: T, transaction: Transaction) => any): void;
@@ -96,33 +96,33 @@ export interface TableHooks<T = any, TKey = IndexableType> extends DexieEventSet
 	deleting: DexieEvent;
 }
 export type ThenShortcut<T, TResult> = (value: T) => TResult | PromiseLike<TResult>;
-export interface WhereClause<T = any, TKey = IndexableType> {
-	above(key: any): Collection<T, TKey>;
-	aboveOrEqual(key: any): Collection<T, TKey>;
-	anyOf(keys: ReadonlyArray<IndexableType>): Collection<T, TKey>;
-	anyOf(...keys: Array<IndexableType>): Collection<T, TKey>;
-	anyOfIgnoreCase(keys: string[]): Collection<T, TKey>;
-	anyOfIgnoreCase(...keys: string[]): Collection<T, TKey>;
-	below(key: any): Collection<T, TKey>;
-	belowOrEqual(key: any): Collection<T, TKey>;
-	between(lower: any, upper: any, includeLower?: boolean, includeUpper?: boolean): Collection<T, TKey>;
-	equals(key: IndexableType): Collection<T, TKey>;
-	equalsIgnoreCase(key: string): Collection<T, TKey>;
+export interface WhereClause<T = any, TKey = IndexableType, TInsertType = T> {
+	above(key: any): Collection<T, TKey, TInsertType>;
+	aboveOrEqual(key: any): Collection<T, TKey, TInsertType>;
+	anyOf(keys: ReadonlyArray<IndexableType>): Collection<T, TKey, TInsertType>;
+	anyOf(...keys: Array<IndexableType>): Collection<T, TKey, TInsertType>;
+	anyOfIgnoreCase(keys: string[]): Collection<T, TKey, TInsertType>;
+	anyOfIgnoreCase(...keys: string[]): Collection<T, TKey, TInsertType>;
+	below(key: any): Collection<T, TKey, TInsertType>;
+	belowOrEqual(key: any): Collection<T, TKey, TInsertType>;
+	between(lower: any, upper: any, includeLower?: boolean, includeUpper?: boolean): Collection<T, TKey, TInsertType>;
+	equals(key: IndexableType): Collection<T, TKey, TInsertType>;
+	equalsIgnoreCase(key: string): Collection<T, TKey, TInsertType>;
 	inAnyRange(ranges: ReadonlyArray<{
 		0: any;
 		1: any;
 	}>, options?: {
 		includeLowers?: boolean;
 		includeUppers?: boolean;
-	}): Collection<T, TKey>;
-	startsWith(key: string): Collection<T, TKey>;
-	startsWithAnyOf(prefixes: string[]): Collection<T, TKey>;
-	startsWithAnyOf(...prefixes: string[]): Collection<T, TKey>;
-	startsWithIgnoreCase(key: string): Collection<T, TKey>;
-	startsWithAnyOfIgnoreCase(prefixes: string[]): Collection<T, TKey>;
-	startsWithAnyOfIgnoreCase(...prefixes: string[]): Collection<T, TKey>;
-	noneOf(keys: ReadonlyArray<IndexableType>): Collection<T, TKey>;
-	notEqual(key: IndexableType): Collection<T, TKey>;
+	}): Collection<T, TKey, TInsertType>;
+	startsWith(key: string): Collection<T, TKey, TInsertType>;
+	startsWithAnyOf(prefixes: string[]): Collection<T, TKey, TInsertType>;
+	startsWithAnyOf(...prefixes: string[]): Collection<T, TKey, TInsertType>;
+	startsWithIgnoreCase(key: string): Collection<T, TKey, TInsertType>;
+	startsWithAnyOfIgnoreCase(prefixes: string[]): Collection<T, TKey, TInsertType>;
+	startsWithAnyOfIgnoreCase(...prefixes: string[]): Collection<T, TKey, TInsertType>;
+	noneOf(keys: ReadonlyArray<IndexableType>): Collection<T, TKey, TInsertType>;
+	notEqual(key: IndexableType): Collection<T, TKey, TInsertType>;
 }
 export interface PromiseExtendedConstructor extends PromiseConstructor {
 	readonly prototype: PromiseExtended;
@@ -366,13 +366,13 @@ export type KeyPathValue<T, PATH> = PATH extends `${infer R}.${infer S}` ? R ext
 export type UpdateSpec<T> = {
 	[KP in KeyPaths<T>]?: KeyPathValue<T, KP>;
 };
-export interface Collection<T = any, TKey = IndexableType> {
+export interface Collection<T = any, TKey = IndexableType, TInsertType = T> {
 	db: Dexie;
-	and(filter: (x: T) => boolean): Collection<T, TKey>;
-	clone(props?: Object): Collection<T, TKey>;
+	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>;
+	distinct(): Collection<T, TKey, TInsertType>;
 	each(callback: (obj: T, cursor: {
 		key: IndexableType;
 		primaryKey: TKey;
@@ -390,7 +390,7 @@ export interface Collection<T = any, TKey = 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>;
+	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>;
@@ -399,24 +399,24 @@ export interface Collection<T = any, TKey = IndexableType> {
 	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>;
-	offset(n: number): Collection<T, TKey>;
-	or(indexOrPrimayKey: string): WhereClause<T, TKey>;
-	raw(): Collection<T, TKey>;
-	reverse(): Collection<T, TKey>;
+	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>;
+	until(filter: (value: T) => boolean, includeStopEntry?: boolean): Collection<T, TKey, TInsertType>;
 	// Mutating methods
 	delete(): PromiseExtended<number>;
 	modify(changeCallback: (obj: T, ctx: {
-		value: T;
+		value: TInsertType;
 	}) => void | boolean): PromiseExtended<number>;
-	modify(changes: UpdateSpec<T>): PromiseExtended<number>;
+	modify(changes: UpdateSpec<TInsertType>): PromiseExtended<number>;
 }
 export type IntervalTree = IntervalTreeNode | EmptyRange;
 export interface IntervalTreeNode {
@@ -683,7 +683,7 @@ export interface Table<T = any, TKey = any, TInsertType = T> {
 	db: Dexie;
 	name: string;
 	schema: TableSchema;
-	hook: TableHooks<T, TKey>;
+	hook: TableHooks<T, TKey, TInsertType>;
 	core: DBCoreTable;
 	get(key: TKey): PromiseExtended<T | undefined>;
 	get<R>(key: TKey, thenShortcut: ThenShortcut<T | undefined, R>): PromiseExtended<R>;
@@ -693,27 +693,27 @@ export interface Table<T = any, TKey = any, TInsertType = T> {
 	get<R>(equalityCriterias: {
 		[key: string]: any;
 	}, thenShortcut: ThenShortcut<T | undefined, R>): PromiseExtended<R>;
-	where(index: string | string[]): WhereClause<T, TKey>;
+	where(index: string | string[]): WhereClause<T, TKey, TInsertType>;
 	where(equalityCriterias: {
 		[key: string]: any;
-	}): Collection<T, TKey>;
-	filter(fn: (obj: T) => boolean): Collection<T, TKey>;
+	}): Collection<T, TKey, TInsertType>;
+	filter(fn: (obj: T) => boolean): Collection<T, TKey, TInsertType>;
 	count(): PromiseExtended<number>;
 	count<R>(thenShortcut: ThenShortcut<number, R>): PromiseExtended<R>;
-	offset(n: number): Collection<T, TKey>;
-	limit(n: number): Collection<T, TKey>;
+	offset(n: number): Collection<T, TKey, TInsertType>;
+	limit(n: number): Collection<T, TKey, TInsertType>;
 	each(callback: (obj: T, cursor: {
 		key: any;
 		primaryKey: TKey;
 	}) => any): PromiseExtended<void>;
 	toArray(): PromiseExtended<Array<T>>;
 	toArray<R>(thenShortcut: ThenShortcut<T[], R>): PromiseExtended<R>;
-	toCollection(): Collection<T, TKey>;
-	orderBy(index: string | string[]): Collection<T, TKey>;
-	reverse(): Collection<T, TKey>;
+	toCollection(): Collection<T, TKey, TInsertType>;
+	orderBy(index: string | string[]): Collection<T, TKey, TInsertType>;
+	reverse(): Collection<T, TKey, TInsertType>;
 	mapToClass(constructor: Function): Function;
 	add(item: TInsertType, key?: TKey): PromiseExtended<TKey>;
-	update(key: TKey | T, changes: UpdateSpec<T> | ((obj: T, ctx: {
+	update(key: TKey | T, changes: UpdateSpec<TInsertType> | ((obj: T, ctx: {
 		value: any;
 		primKey: IndexableType;
 	}) => void | boolean)): PromiseExtended<number>;
@@ -1022,7 +1022,6 @@ export interface TblQueryCache {
 	objs: Map<string | number, object>;
 	optimisticOps: DBCoreMutateRequest[];
 	unsignaledParts: ObservabilitySet;
-	signalTimer?: number;
 }
 export interface CacheEntryCommon {
 	subscribers: Set<() => void>;