@firtoz/drizzle-indexeddb 3.0.0 → 3.0.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @firtoz/drizzle-indexeddb
 
+## 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": "3.0.1",
 	"description": "IndexedDB migrations powered by Drizzle ORM",
 	"main": "./src/index.ts",
 	"module": "./src/index.ts",

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";
@@ -59,6 +67,28 @@ export interface DrizzleIndexedDBCollectionConfig<TTable extends Table> {
 	debug?: boolean;
 }
 
+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 +114,7 @@ function discoverIndexes(
  */
 export function drizzleIndexedDBCollectionOptions<const TTable extends Table>(
 	config: DrizzleIndexedDBCollectionConfig<TTable>,
-) {
+): DrizzleIndexedDBCollectionConfigResult<TTable> {
 	let discoveredIndexes: Record<string, string> = {};
 	let indexesDiscovered = false;
 

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";