dexie 4.0.0-alpha.3 → 4.0.1-alpha.10

package/CONTRIBUTING.md

@@ -4,7 +4,7 @@ HOW TO CONTRIBUTE
 We appreciate contributions in forms of:
 
 * issues
-* help answering questions in [issues](https://github.com/dfahlander/Dexie.js/issues) and on [stackoverflow](https://stackexchange.com/filters/233583/dexie-stackoverflow)
+* help answering questions in [issues](https://github.com/dexie/Dexie.js/issues) and on [stackoverflow](https://stackexchange.com/filters/233583/dexie-stackoverflow)
 * fixing bugs via pull-requests
 * developing addons or other [derived work](https://dexie.org/docs/DerivedWork)
 * promoting Dexie.js
@@ -13,7 +13,9 @@ We appreciate contributions in forms of:
 Contribute while developing your own app
 ========================================
 
-Here is a little cheat-sheet for how to symlink your app's `node_modules/dexie` to a place where you can edit the source, version control your changes and create pull requests back to Dexie. Assuming you've already ran `npm install dexie --save` for the app your are developing.
+Dexie uses pnpm package manager. Refer to [pnpm.io/installation](https://pnpm.io/installation) for how to install pnpm.
+
+Here is a little cheat-sheet for how to symlink your app's `node_modules/dexie` to a place where you can edit the source, version control your changes and create pull requests back to Dexie. Assuming you've already ran `npm install dexie` for the app your are developing.
 
 1. Fork Dexie.js from the web gui on github
 2. Clone your fork locally by launching a shell/command window and cd to a neutral place (like `~repos/`, `c:\repos` or whatever)
@@ -22,39 +24,42 @@ Here is a little cheat-sheet for how to symlink your app's `node_modules/dexie`
     ```
     git clone https://github.com/YOUR-USERNAME/Dexie.js.git dexie
     cd dexie
-    npm install
-    npm run build
-    npm link
+    pnpm install
+    pnpm run build
+    npm link # Or yarn link or pnpm link --global depending on what package manager you are using.
     ```
 3. cd to your app directory and write:
     ```
-    npm link dexie
+    npm link dexie # Or yarn link dexie / pnpm link dexie depending on your package manager.
     ```
 
-Your app's `node_modules/dexie/` is now sym-linked to the Dexie.js clone on your hard drive so any change you do there will propagate to your app. Build dexie.js using `npm run build` or `npm run watch`. The latter will react on any source file change and rebuild the dist files.
+Your app's `node_modules/dexie/` is now sym-linked to the Dexie.js clone on your hard drive so any change you do there will propagate to your app. Build dexie.js using `pnpm run build` or `pnpm run watch`. The latter will react on any source file change and rebuild the dist files.
 
 That's it. Now you're up and running to test and commit changes to files under dexie/src/* or dexie/test/* and the changes will instantly affect the app you are developing.
 
+If you're on yarn or pnpm, do the same procedures using yarn link / pnpm link.
+
 Pull requests are more than welcome. Some advices are:
 
-* Run npm test before making a pull request.
+* Run pnpm test before making a pull request.
 * If you find an issue, a unit test that reproduces it is lovely ;). If you don't know where to put it, put it in `test/tests-misc.js`. We use qunit. Just look at existing tests in `tests-misc.js` to see how they should be written. Tests are transpiled in the build script so you can use ES6 if you like.
 
 Build
 -----
 ```
-npm install
-npm run build
+# To install pnpm, see https://pnpm.io/installation
+pnpm install
+pnpm run build
 ```
 
 Test
 ----
 ```
-npm test
+pnpm test
 ```
 
 Watch
 -----
 ```
-npm run watch
+pnpm run watch
 ```

package/README.md

@@ -229,50 +229,25 @@ https://unpkg.com/dexie@latest/dist/dexie.d.ts
 
 Contributing
 ============
-Here is a little cheat-sheet for how to symlink your app's `node_modules/dexie` to a place where you can edit the source, version control your changes and create pull requests back to Dexie. Assuming you've already ran `npm install dexie --save` for the app your are developing.
-
-1. Fork Dexie.js from the web gui on github
-2. Clone your fork locally by launching a shell/command window and cd to a neutral place (like `~repos/`, `c:\repos` or whatever)
-3. Run the following commands:
-
-    ```
-    git clone https://github.com/YOUR-USERNAME/Dexie.js.git dexie
-    cd dexie
-    npm install
-    npm run build
-    npm link
-    ```
-3. cd to your app directory and write:
-    ```
-    npm link dexie
-    ```
-
-Your app's `node_modules/dexie/` is now sym-linked to the Dexie.js clone on your hard drive so any change you do there will propagate to your app. Build dexie.js using `npm run build` or `npm run watch`. The latter will react on any source file change and rebuild the dist files.
-
-That's it. Now you're up and running to test and commit changes to files under dexie/src/* or dexie/test/* and the changes will instantly affect the app you are developing.
-
-Pull requests are more than welcome. Some advices are:
-
-* Run npm test before making a pull request.
-* If you find an issue, a unit test that reproduces it is lovely ;). If you don't know where to put it, put it in `test/tests-misc.js`. We use qunit. Just look at existing tests in `tests-misc.js` to see how they should be written. Tests are transpiled in the build script so you can use ES6 if you like.
+See [CONTRIBUTING.md](CONTRIBUTING.md)
 
 Build
 -----
 ```
-npm install
-npm run build
+pnpm install
+pnpm run build
 ```
 
 Test
 ----
 ```
-npm test
+pnpm test
 ```
 
 Watch
 -----
 ```
-npm run watch
+pnpm run watch
 ```
 
 

package/dist/dexie.d.ts

@@ -4,7 +4,7 @@
  *
  * By David Fahlander, david.fahlander@gmail.com
  *
- * Version 4.0.0-alpha.3, Wed Apr 27 2022
+ * Version 4.0.1-alpha.10, Wed Mar 29 2023
  *
  * https://dexie.org
  *
@@ -85,7 +85,7 @@ export interface DeletingHookContext<T, Key> {
 	onerror?: (err: any) => void;
 }
 export interface TableHooks<T = any, TKey = IndexableType> extends DexieEventSet {
-	(eventName: "creating", subscriber: (this: CreatingHookContext<T, TKey>, primKey: TKey, obj: T, transaction: Transaction) => any): void;
+	(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;
 	(eventName: "deleting", subscriber: (this: DeletingHookContext<T, TKey>, primKey: TKey, obj: T, transaction: Transaction) => any): void;
@@ -357,11 +357,10 @@ 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 : T[P] extends (...args: any[]) => any // Method
+	[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
 	 ? never : T[P] extends object ? P | `${P}.${KeyPaths<T[P]>}` : P : never;
 }[keyof T];
-export type Extract<T, P> = P extends keyof T ? T[P] : void;
-export type KeyPathValue<T, PATH> = PATH extends `${infer R}.${infer S}` ? R extends keyof T ? Extract<T[R], S> : void : Extract<T, PATH>;
+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 type UpdateSpec<T> = {
 	[KP in KeyPaths<T>]?: KeyPathValue<T, KP>;
 };
@@ -388,6 +387,7 @@ export interface Collection<T = any, TKey = IndexableType> {
 		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>;
 	first(): PromiseExtended<T | undefined>;
 	first<R>(thenShortcut: ThenShortcut<T | undefined, R>): PromiseExtended<R>;
@@ -464,9 +464,12 @@ export interface DBCorePutRequest {
 	changeSpec?: {
 		[keyPath: string]: any;
 	}; // Common changeSpec for each key
-	changeSpecs?: {
-		[keyPath: string]: any;
-	}[]; // changeSpec per key. 
+	updates?: {
+		keys: any[];
+		changeSpecs: {
+			[keyPath: string]: any;
+		}[]; // changeSpec per key.  
+	};
 	/** @deprecated Will always get results since 3.1.0-alpha.5 */
 	wantResults?: boolean;
 }
@@ -581,76 +584,71 @@ export interface DBCoreTable {
 	openCursor(req: DBCoreOpenCursorRequest): Promise<DBCoreCursor | null>;
 	count(req: DBCoreCountRequest): Promise<number>;
 }
-export type MethodProps<T> = {
-	[P in keyof T]: T[P] extends (...args: any[]) => any ? P : never;
-}[keyof T];
-export type InsertType<T, TOptionalProperties, TKeyPropNameOrKeyType> = string extends MethodProps<T> ? T : Omit<T, TOptionalProperties extends keyof T ? TKeyPropNameOrKeyType extends keyof T ? MethodProps<T> | TOptionalProperties | TKeyPropNameOrKeyType : MethodProps<T> | TOptionalProperties : MethodProps<T>> & (TOptionalProperties extends keyof T ? TKeyPropNameOrKeyType extends keyof T ? {
-	[P in (TOptionalProperties | TKeyPropNameOrKeyType)]?: T[P];
-} : {
-	[P in TOptionalProperties]?: T[P];
-} : {});
-export type IDType<T, TKey> = TKey extends keyof T ? T[TKey] : TKey;
-export interface Table<T = any, TKeyPropNameOrKeyType = IndexableType, TOpt = void> {
+export interface Table<T = any, TKey = any, TInsertType = T> {
 	db: Dexie;
 	name: string;
 	schema: TableSchema;
-	hook: TableHooks<T, IDType<T, TKeyPropNameOrKeyType>>;
+	hook: TableHooks<T, TKey>;
 	core: DBCoreTable;
-	get(key: IDType<T, TKeyPropNameOrKeyType>): PromiseExtended<T | undefined>;
-	get<R>(key: IDType<T, TKeyPropNameOrKeyType>, thenShortcut: ThenShortcut<T | undefined, R>): PromiseExtended<R>;
+	get(key: TKey): PromiseExtended<T | undefined>;
+	get<R>(key: TKey, thenShortcut: ThenShortcut<T | undefined, R>): PromiseExtended<R>;
 	get(equalityCriterias: {
 		[key: string]: any;
 	}): PromiseExtended<T | undefined>;
 	get<R>(equalityCriterias: {
 		[key: string]: any;
 	}, thenShortcut: ThenShortcut<T | undefined, R>): PromiseExtended<R>;
-	where(index: string | string[]): WhereClause<T, IDType<T, TKeyPropNameOrKeyType>>;
+	where(index: string | string[]): WhereClause<T, TKey>;
 	where(equalityCriterias: {
 		[key: string]: any;
-	}): Collection<T, IDType<T, TKeyPropNameOrKeyType>>;
-	filter(fn: (obj: T) => boolean): Collection<T, IDType<T, TKeyPropNameOrKeyType>>;
+	}): Collection<T, TKey>;
+	filter(fn: (obj: T) => boolean): Collection<T, TKey>;
 	count(): PromiseExtended<number>;
 	count<R>(thenShortcut: ThenShortcut<number, R>): PromiseExtended<R>;
-	offset(n: number): Collection<T, IDType<T, TKeyPropNameOrKeyType>>;
-	limit(n: number): Collection<T, IDType<T, TKeyPropNameOrKeyType>>;
+	offset(n: number): Collection<T, TKey>;
+	limit(n: number): Collection<T, TKey>;
 	each(callback: (obj: T, cursor: {
 		key: any;
-		primaryKey: IDType<T, TKeyPropNameOrKeyType>;
+		primaryKey: TKey;
 	}) => any): PromiseExtended<void>;
 	toArray(): PromiseExtended<Array<T>>;
 	toArray<R>(thenShortcut: ThenShortcut<T[], R>): PromiseExtended<R>;
-	toCollection(): Collection<T, IDType<T, TKeyPropNameOrKeyType>>;
-	orderBy(index: string | string[]): Collection<T, IDType<T, TKeyPropNameOrKeyType>>;
-	reverse(): Collection<T, IDType<T, TKeyPropNameOrKeyType>>;
+	toCollection(): Collection<T, TKey>;
+	orderBy(index: string | string[]): Collection<T, TKey>;
+	reverse(): Collection<T, TKey>;
 	mapToClass(constructor: Function): Function;
-	add(item: InsertType<T, TOpt, TKeyPropNameOrKeyType>, key?: IDType<T, TKeyPropNameOrKeyType>): PromiseExtended<IDType<T, TKeyPropNameOrKeyType>>;
-	update(key: IDType<T, TKeyPropNameOrKeyType> | T, changes: UpdateSpec<T> | ((obj: T, ctx: {
+	add(item: TInsertType, key?: TKey): PromiseExtended<TKey>;
+	update(key: TKey | T, changes: UpdateSpec<T> | ((obj: T, ctx: {
 		value: any;
 		primKey: IndexableType;
 	}) => void | boolean)): PromiseExtended<number>;
-	put(item: InsertType<T, TOpt, TKeyPropNameOrKeyType>, key?: IDType<T, TKeyPropNameOrKeyType>): PromiseExtended<IDType<T, TKeyPropNameOrKeyType>>;
-	delete(key: IDType<T, TKeyPropNameOrKeyType>): PromiseExtended<void>;
+	put(item: TInsertType, key?: TKey): PromiseExtended<TKey>;
+	delete(key: TKey): PromiseExtended<void>;
 	clear(): PromiseExtended<void>;
-	bulkGet(keys: IDType<T, TKeyPropNameOrKeyType>[]): PromiseExtended<(T | undefined)[]>;
-	bulkAdd<B extends boolean>(items: readonly InsertType<T, TOpt, TKeyPropNameOrKeyType>[], keys: IndexableTypeArrayReadonly, options: {
+	bulkGet(keys: TKey[]): PromiseExtended<(T | undefined)[]>;
+	bulkAdd<B extends boolean>(items: readonly TInsertType[], keys: IndexableTypeArrayReadonly, options: {
 		allKeys: B;
-	}): PromiseExtended<B extends true ? IDType<T, TKeyPropNameOrKeyType>[] : IDType<T, TKeyPropNameOrKeyType>>;
-	bulkAdd<B extends boolean>(items: readonly InsertType<T, TOpt, TKeyPropNameOrKeyType>[], options: {
+	}): PromiseExtended<B extends true ? TKey[] : TKey>;
+	bulkAdd<B extends boolean>(items: readonly TInsertType[], options: {
 		allKeys: B;
-	}): PromiseExtended<B extends true ? IDType<T, TKeyPropNameOrKeyType>[] : IDType<T, TKeyPropNameOrKeyType>>;
-	bulkAdd(items: readonly InsertType<T, TOpt, TKeyPropNameOrKeyType>[], keys?: IndexableTypeArrayReadonly, options?: {
+	}): PromiseExtended<B extends true ? TKey[] : TKey>;
+	bulkAdd(items: readonly TInsertType[], keys?: IndexableTypeArrayReadonly, options?: {
 		allKeys: boolean;
-	}): PromiseExtended<IDType<T, TKeyPropNameOrKeyType>>;
-	bulkPut<B extends boolean>(items: readonly InsertType<T, TOpt, TKeyPropNameOrKeyType>[], keys: IndexableTypeArrayReadonly, options: {
+	}): PromiseExtended<TKey>;
+	bulkPut<B extends boolean>(items: readonly TInsertType[], keys: IndexableTypeArrayReadonly, options: {
 		allKeys: B;
-	}): PromiseExtended<B extends true ? IDType<T, TKeyPropNameOrKeyType>[] : IDType<T, TKeyPropNameOrKeyType>>;
-	bulkPut<B extends boolean>(items: readonly InsertType<T, TOpt, TKeyPropNameOrKeyType>[], options: {
+	}): PromiseExtended<B extends true ? TKey[] : TKey>;
+	bulkPut<B extends boolean>(items: readonly TInsertType[], options: {
 		allKeys: B;
-	}): PromiseExtended<B extends true ? IDType<T, TKeyPropNameOrKeyType>[] : IDType<T, TKeyPropNameOrKeyType>>;
-	bulkPut(items: readonly InsertType<T, TOpt, TKeyPropNameOrKeyType>[], keys?: IndexableTypeArrayReadonly, options?: {
+	}): PromiseExtended<B extends true ? TKey[] : TKey>;
+	bulkPut(items: readonly TInsertType[], keys?: IndexableTypeArrayReadonly, options?: {
 		allKeys: boolean;
-	}): PromiseExtended<IDType<T, TKeyPropNameOrKeyType>>;
-	bulkDelete(keys: IDType<T, TKeyPropNameOrKeyType>[]): PromiseExtended<void>;
+	}): PromiseExtended<TKey>;
+	bulkUpdate(keysAndChanges: ReadonlyArray<{
+		key: TKey;
+		changes: UpdateSpec<T>;
+	}>): PromiseExtended<number>;
+	bulkDelete(keys: TKey[]): PromiseExtended<void>;
 }
 export interface Version {
 	stores(schema: {
@@ -969,10 +967,16 @@ declare global {
 		readonly observable: symbol;
 	}
 }
+export interface Subscribable<T> {
+	subscribe(observer: Partial<Observer<T>>): Unsubscribable;
+}
+export interface Unsubscribable {
+	unsubscribe(): void;
+}
 export interface Observable<T = any> {
-	subscribe(onNext?: ((value: T) => void) | null, onError?: ((error: any) => void) | null, onComplete?: (() => void) | null): Subscription;
-	subscribe(observer?: Observer<T> | null): Subscription;
-	[Symbol.observable]: () => Observable<T>;
+	subscribe(observerOrNext?: Observer<T> | ((value: T) => void)): Subscription;
+	subscribe(next?: ((value: T) => void) | null, error?: ((error: any) => void) | null, complete?: (() => void) | null): Subscription;
+	[Symbol.observable]: () => Subscribable<T>;
 }
 export interface Subscription {
 	unsubscribe(): void;
@@ -1039,6 +1043,27 @@ export class Entity<TDexieSubClass extends Dexie = Dexie> {
 	protected readonly db: TDexieSubClass;
 	table(): TableProp<TDexieSubClass>;
 }
+export type IsStrictlyAny<T> = (T extends never ? true : false) extends false ? false : true;
+/** Extract the union of literal method names in T
+ */
+export type MethodProps<T> = {
+	[P in keyof T]: IsStrictlyAny<T[P]> extends true ? never // Plain property of type any (not method)
+	 : T[P] extends (...args: any[]) => any ? P // a function (method)
+	 : never;
+}[keyof T];
+/** Default insert type of T is a subset of T where:
+ *    * given optional props (such as an auto-generated primary key) are made optional
+ *    * methods are omitted
+ */
+export type InsertType<T, OptionalProps extends keyof T> = Omit<T, OptionalProps | MethodProps<T>> & {
+	[P in OptionalProps]?: T[P];
+};
+/** IDType extract the actual type of the primary key:
+ *  * If TKey is a literal type that names a property of T, extract the type using T[TKey]
+ *  * Else, use TKey as is.
+ */
+export type IDType<T, TKeyPropNameOrKeyType> = IsStrictlyAny<T> extends true ? TKeyPropNameOrKeyType : TKeyPropNameOrKeyType extends string ? TKeyPropNameOrKeyType extends keyof T ? T[TKeyPropNameOrKeyType] : TKeyPropNameOrKeyType : TKeyPropNameOrKeyType;
+export type EntityTable<T, TKeyPropName extends keyof T = never, TInsertType = InsertType<T, TKeyPropName>> = Table<T, IDType<T, TKeyPropName>, TInsertType>;
 export declare var Dexie: DexieConstructor;
 export interface _Table<T, TKey> extends Table<T, TKey> {
 }