dexie 4.0.1-beta.8 → 4.0.1-rc.1

package/SECURITY.md

@@ -6,7 +6,7 @@
 | ------- | ------------------ | --------
 | 4.x     | :white_check_mark: | master
 | 3.x     | :white_check_mark: | master-3
-| 2.0.x   | :thinking: | master-2
+| 2.0.x   | :x: | master-2
 | 1.5.x   | :x: | master-1
 | < 1.5.1 | :x:                |
 

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-rc.1, Wed Mar 20 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;
@@ -363,16 +363,32 @@ export type KeyPaths<T> = {
 	 ? 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;
+export declare const PropModSymbol: unique symbol;
+export type PropModSpec = {
+	replacePrefix?: [
+		string,
+		string
+	];
+};
+export class PropModification implements PropModSpec {
+	[PropModSymbol]?: true;
+	replacePrefix?: [
+		string,
+		string
+	];
+	execute<T>(value: T): T;
+	constructor(spec: PropModSpec);
+}
 export type UpdateSpec<T> = {
-	[KP in KeyPaths<T>]?: KeyPathValue<T, KP>;
+	[KP in KeyPaths<T>]?: KeyPathValue<T, KP> | PropModification;
 };
-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 +406,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 +415,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 +699,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 +709,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>;
@@ -804,7 +820,9 @@ export interface Dexie {
 	close(closeOptions?: {
 		disableAutoOpen: boolean;
 	}): void;
-	delete(): PromiseExtended<void>;
+	delete(closeOptions?: {
+		disableAutoOpen: boolean;
+	}): PromiseExtended<void>;
 	isOpen(): boolean;
 	hasBeenClosed(): boolean;
 	hasFailed(): boolean;
@@ -1022,7 +1040,6 @@ export interface TblQueryCache {
 	objs: Map<string | number, object>;
 	optimisticOps: DBCoreMutateRequest[];
 	unsignaledParts: ObservabilitySet;
-	signalTimer?: number;
 }
 export interface CacheEntryCommon {
 	subscribers: Set<() => void>;
@@ -1069,6 +1086,7 @@ export interface DexieConstructor extends DexieExceptionClasses {
 	getDatabaseNames<R>(thenShortcut: ThenShortcut<string[], R>): Promise<R>;
 	vip<U>(scopeFunction: () => U): U;
 	ignoreTransaction<U>(fn: () => U): U;
+	disableBfCache?: boolean;
 	liveQuery<T>(fn: () => T | Promise<T>): Observable<T>;
 	extendObservabilitySet(target: ObservabilitySet, newSet: ObservabilitySet): ObservabilitySet;
 	override<F>(origFunc: F, overridedFactory: (fn: any) => any): F; // ?
@@ -1138,6 +1156,7 @@ export function liveQuery<T>(querier: () => T | Promise<T>): Observable<T>;
 export function mergeRanges(target: IntervalTree, newSet: IntervalTree): void;
 export function rangesOverlap(rangeSet1: IntervalTree, rangeSet2: IntervalTree): boolean;
 export function cmp(a: any, b: any): number;
+export function replacePrefix(a: string, b: string): PropModification;
 /** Exporting 'Dexie' as the default export.
  **/
 export default Dexie;