@firtoz/drizzle-indexeddb 3.0.0 → 4.0.0

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @firtoz/drizzle-indexeddb
 
+## 4.0.0
+
+### Major Changes
+
+- [#64](https://github.com/firtoz/fullstack-toolkit/pull/64) [`556555a`](https://github.com/firtoz/fullstack-toolkit/commit/556555a2e09030a8658be8c07b5881e72be64b2f) Thanks [@firtoz](https://github.com/firtoz)! - **`@firtoz/drizzle-utils`:** Export `DrizzleSqliteTableCollection`; extend `BaseSyncConfig` / `createCollectionConfig` for typed `getSyncPersistKey` and `getKey` as `IdOf<TTable>`; avoid executing `syncableTable` default functions during table definition for Worker/DO globals; export collection helper types for Drizzle-backed TanStack collections.
+
+  **`@firtoz/drizzle-indexeddb` (major):** `deferLocalPersistence`, `handleBatchPut`, and related collection options; `receiveSync` persistence aligned with generic sync and partial-sync traffic; remove debug ingest usage. **Breaking** alongside the `@firtoz/drizzle-utils` sync/collection typing changes above (including `DrizzleSqliteTableCollection` and `BaseSyncConfig` expectations).
+
+### Patch Changes
+
+- Updated dependencies [[`556555a`](https://github.com/firtoz/fullstack-toolkit/commit/556555a2e09030a8658be8c07b5881e72be64b2f), [`556555a`](https://github.com/firtoz/fullstack-toolkit/commit/556555a2e09030a8658be8c07b5881e72be64b2f), [`556555a`](https://github.com/firtoz/fullstack-toolkit/commit/556555a2e09030a8658be8c07b5881e72be64b2f), [`f90479f`](https://github.com/firtoz/fullstack-toolkit/commit/f90479f263e932b39269aecce4f54dbbb7cdce3e)]:
+  - @firtoz/db-helpers@2.1.0
+  - @firtoz/drizzle-utils@1.2.0
+  - @firtoz/idb-collections@0.2.2
+
+## 3.0.1
+
+### Patch Changes
+
+- [`8b839f2`](https://github.com/firtoz/fullstack-toolkit/commit/8b839f2227f50409af649aab87178e039aad55dc) Thanks [@firtoz](https://github.com/firtoz)! - Export collection helper types for Drizzle-backed TanStack DB collections so users can declare collection variables with preserved select and insert inference from table schemas.
+
 ## 3.0.0
 
 ### Patch Changes

package/README.md

@@ -100,16 +100,23 @@ Create reactive collections backed by IndexedDB:
 
 ```typescript
 import { createCollection } from "@tanstack/db";
-import { indexedDBCollectionOptions } from "@firtoz/drizzle-indexeddb";
+import {
+	drizzleIndexedDBCollectionOptions,
+	type DrizzleIndexedDBCollection,
+} from "@firtoz/drizzle-indexeddb";
+import * as schema from "./schema";
 
 const todosCollection = createCollection(
-  indexedDBCollectionOptions({
-    db,
-    tableName: "todos",
+  drizzleIndexedDBCollectionOptions({
+    indexedDBRef: { current: db },
+    table: schema.todoTable,
+    storeName: "todos",
     syncMode: "on-demand", // or "realtime"
   })
 );
 
+type TodosCollection = DrizzleIndexedDBCollection<typeof schema.todoTable>;
+
 // Subscribe to changes
 const unsubscribe = todosCollection.subscribe((todos) => {
   console.log("Todos updated:", todos);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@firtoz/drizzle-indexeddb",
-	"version": "3.0.0",
+	"version": "4.0.0",
 	"description": "IndexedDB migrations powered by Drizzle ORM",
 	"main": "./src/index.ts",
 	"module": "./src/index.ts",
@@ -39,7 +39,7 @@
 		"CHANGELOG.md"
 	],
 	"scripts": {
-		"typecheck": "tsc --noEmit -p ./tsconfig.json",
+		"typecheck": "tsgo --noEmit -p ./tsconfig.json",
 		"lint": "biome check --write src",
 		"lint:ci": "biome ci src",
 		"format": "biome format src --write"
@@ -68,25 +68,25 @@
 		"access": "public"
 	},
 	"peerDependencies": {
-		"@firtoz/drizzle-utils": ">=1.1.0",
-		"@tanstack/db": ">=0.5.33",
-		"drizzle-orm": ">=0.45.1",
+		"@firtoz/drizzle-utils": ">=1.2.0",
+		"@tanstack/db": ">=0.6.1",
+		"drizzle-orm": ">=0.45.2",
 		"drizzle-valibot": ">=0.4.0",
 		"react": ">=19.2.4",
 		"valibot": ">=1.3.1"
 	},
 	"devDependencies": {
-		"@firtoz/drizzle-utils": "^1.1.0",
-		"@tanstack/db": "^0.5.33",
+		"@firtoz/drizzle-utils": "^1.2.0",
+		"@tanstack/db": "^0.6.1",
 		"@types/react": "^19.2.14",
-		"drizzle-orm": "^0.45.1",
+		"drizzle-orm": "^0.45.2",
 		"drizzle-valibot": "^0.4.2",
 		"react": "^19.2.4",
 		"valibot": "^1.3.1"
 	},
 	"dependencies": {
-		"@firtoz/db-helpers": "^2.0.0",
-		"@firtoz/idb-collections": "^0.2.1",
+		"@firtoz/db-helpers": "^2.1.0",
+		"@firtoz/idb-collections": "^0.2.2",
 		"@firtoz/maybe-error": "^1.5.2",
 		"citty": "^0.2.1"
 	}

package/src/collections/drizzle-indexeddb-collection.ts

@@ -1,4 +1,10 @@
-import type { InferSchemaOutput, SyncMode } from "@tanstack/db";
+import type {
+	Collection,
+	CollectionConfig,
+	InferSchemaInput,
+	InferSchemaOutput,
+	SyncMode,
+} from "@tanstack/db";
 import type { IR } from "@tanstack/db";
 import { parseOrderByExpression } from "@tanstack/db";
 import type { Table } from "drizzle-orm";
@@ -6,6 +12,8 @@ import type { Table } from "drizzle-orm";
 import {
 	type IdOf,
 	type SelectSchema,
+	type InsertToSelectSchema,
+	type TableWithRequiredFields,
 	type BaseSyncConfig,
 	type SyncBackend,
 	createSyncFunction,
@@ -13,7 +21,7 @@ import {
 	createGetKeyFunction,
 	createCollectionConfig,
 } from "@firtoz/drizzle-utils";
-import { evaluateExpression } from "@firtoz/db-helpers";
+import { evaluateExpression, type CollectionUtils } from "@firtoz/db-helpers";
 import { tryExtractIndexedQuery } from "@firtoz/idb-collections";
 
 import type { IDBDatabaseLike } from "../idb-types";
@@ -57,8 +65,35 @@ export interface DrizzleIndexedDBCollectionConfig<TTable extends Table> {
 	 * Enable debug logging for index discovery and query optimization
 	 */
 	debug?: boolean;
+	/**
+	 * When set, local mutations confirm TanStack sync immediately and persist to IndexedDB on a
+	 * coalesced timer (`createGenericSyncFunction` in `@firtoz/db-helpers`).
+	 */
+	deferLocalPersistence?: boolean | { flushIntervalMs?: number };
 }
 
+export type DrizzleIndexedDBCollectionConfigResult<TTable extends Table> = Omit<
+	CollectionConfig<
+		InferSchemaOutput<SelectSchema<TTable>>,
+		IdOf<TTable>,
+		InsertToSelectSchema<TTable>,
+		CollectionUtils<InferSchemaOutput<SelectSchema<TTable>>>
+	>,
+	"utils"
+> & {
+	schema: InsertToSelectSchema<TTable>;
+	utils: CollectionUtils<InferSchemaOutput<SelectSchema<TTable>>>;
+};
+
+export type DrizzleIndexedDBCollection<TTable extends TableWithRequiredFields> =
+	Collection<
+		InferSchemaOutput<SelectSchema<TTable>>,
+		IdOf<TTable>,
+		CollectionUtils<InferSchemaOutput<SelectSchema<TTable>>>,
+		InsertToSelectSchema<TTable>,
+		InferSchemaInput<InsertToSelectSchema<TTable>>
+	>;
+
 /**
  * Auto-discovers indexes from the IndexedDB store.
  * Returns a map of field names to index names for single-column indexes.
@@ -84,7 +119,7 @@ function discoverIndexes(
  */
 export function drizzleIndexedDBCollectionOptions<const TTable extends Table>(
 	config: DrizzleIndexedDBCollectionConfig<TTable>,
-) {
+): DrizzleIndexedDBCollectionConfigResult<TTable> {
 	let discoveredIndexes: Record<string, string> = {};
 	let indexesDiscovered = false;
 
@@ -254,6 +289,21 @@ export function drizzleIndexedDBCollectionOptions<const TTable extends Table>(
 			return results;
 		},
 
+		handleBatchPut: async (itemsToPut) => {
+			const db = config.indexedDBRef.current;
+			if (!db) {
+				throw new Error("Database not ready");
+			}
+			const now = new Date();
+			const rows = (itemsToPut as unknown as DrizzleIndexedDBSyncItem[]).map(
+				(row) => ({
+					...row,
+					updatedAt: now,
+				}),
+			);
+			await db.put(config.storeName, rows);
+		},
+
 		handleDelete: async (mutations) => {
 			const db = config.indexedDBRef.current;
 
@@ -290,11 +340,18 @@ export function drizzleIndexedDBCollectionOptions<const TTable extends Table>(
 		},
 	};
 
+	type TItem = InferSchemaOutput<SelectSchema<TTable>>;
+	const getKey = createGetKeyFunction<TTable>();
+
 	const baseSyncConfig: BaseSyncConfig<TTable> = {
 		table,
 		readyPromise: config.readyPromise,
 		syncMode: config.syncMode,
 		debug: config.debug,
+		getSyncPersistKey: (item: TItem) => String(getKey(item)),
+		...(config.deferLocalPersistence !== undefined
+			? { deferLocalPersistence: config.deferLocalPersistence }
+			: {}),
 	};
 
 	const syncResult = createSyncFunction(baseSyncConfig, wrappedBackend);
@@ -303,7 +360,7 @@ export function drizzleIndexedDBCollectionOptions<const TTable extends Table>(
 
 	return createCollectionConfig({
 		schema,
-		getKey: createGetKeyFunction<TTable>(),
+		getKey,
 		syncResult,
 		syncMode: config.syncMode,
 	});

package/src/index.ts

@@ -35,6 +35,8 @@ export { createInstrumentedDbCreator } from "./instrumented-idb-database";
 export {
 	drizzleIndexedDBCollectionOptions,
 	type DrizzleIndexedDBCollectionConfig,
+	type DrizzleIndexedDBCollectionConfigResult,
+	type DrizzleIndexedDBCollection,
 	type DrizzleIndexedDBSyncItem,
 } from "./collections/drizzle-indexeddb-collection";