@superbright/indexeddb-orm 0.1.4 → 0.1.6

package/README.md

@@ -176,23 +176,25 @@ const unitState = useUnitState("unit-123");
 
 ### Direct Store Methods
 
-For advanced use cases, all original store methods are available:
+For advanced use cases, the core store methods are available. Prefer the structured actions shown above for most scenarios.
 
 ```typescript
 // Property operations
-await store.getCurrentProperty()
-await store.setCurrentProperty(propertyId, slug)
-await store.getPropertyData(propertyId)
-
-// Unit results
-await store.setUnitResults(transformedUnits.hits)
-await store.clearUnitResults()
-
-// Filter operations
-await store.loadPersistedFilters()
-await store.handleFilterCommitIndexDB(newFilters)
+await store.getCurrentProperty();
+await store.setCurrentProperty(propertyId, slug);
+await store.getPropertyData(propertyId);
+
+// Unit results cache
+await store.setUnitResults(transformedUnits.hits);
+await store.clearUnitResults();
+
+// Filters
+await store.setFilters({ bedrooms: [1, 2] });
+await store.setTempFilters({ cost: 2500 });
+await store.submitFilterUpdate();
 ```
 
+
 ## 🛠️ Development
 
 ### Local Development Setup
@@ -232,6 +234,7 @@ pnpm dev
 - **🏠 Property Management**: Create properties, set current property, retrieve property data
 - **⭐ Unit Actions**: Toggle favorites, mark units as viewed, get unit state
 - **🔍 Filter Operations**: Set filters, reset to defaults, submit filter updates
+- **🧪 Search & Results**: Set results mode and sort order, run a mock search that populates unit results, and clear results
 - **📝 Questionnaire & Tours**: Set questionnaire results, manage tour contact data
 - **📊 Real-time State View**: Live view of database state and action logs
 - **🛠️ Developer Tools Integration**: Inspect IndexedDB directly in DevTools → Application → IndexedDB → `inresi-orm`
@@ -351,8 +354,7 @@ configureValidation("strict"); // "strict" | "warn" | "off"
 ## 📖 Documentation
 
 - [Consuming App Guide](./CONSUMING_APP_GUIDE.md) - Complete integration guide
-- [Migration Summary](./MIGRATION_SUMMARY.md) - Migration from legacy stores
-- [Property Store Guide](./docs/property-store.md) - Property-specific usage
+- [Structured Store Migration](./docs/structured-store-migration.md) - Move to the structured API
 - [App Store Guide](./docs/app-store-guide.md) - App state management
 
 ## 🔧 Legacy API

package/dist/adapters/dexie.d.ts

@@ -0,0 +1,14 @@
+import Dexie, { type Table } from "dexie";
+export interface KV {
+    key: string;
+    value: unknown;
+}
+export interface OrmDexieTables {
+    users: Table<any, string>;
+    kv: Table<KV, string>;
+}
+export declare class OrmDexie extends Dexie {
+    users: OrmDexieTables["users"];
+    kv: OrmDexieTables["kv"];
+    constructor(name?: string);
+}

package/dist/adapters/structured-store.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Structured store wrapper (preferred DX)
+ *
+ * This layer wraps the flat Zustand adapter with domain‑grouped actions
+ * for a more discoverable API in apps. It does not add new behavior —
+ * it simply organizes calls like:
+ *   - `property.unit.favorites.toggle` → `toggleFavorite`
+ *   - `property.unit.viewed.mark`     → `markUnitAsViewed`
+ *   - `filters.set/submit/...`        → filter methods
+ */
+import { type ZustandUnifiedStoreState, type Filters, type TourContactData, type QueryParams } from "./zustand-store";
+export interface StructuredStoreActions {
+    property: {
+        unit: {
+            favorites: {
+                toggle: (unitId: string) => Promise<void>;
+            };
+            viewed: {
+                mark: (unitId: string, slug: string) => Promise<void>;
+            };
+        };
+        questionnaire: {
+            setResults: (results: unknown) => Promise<void>;
+        };
+        tour: {
+            setContactedOn: () => Promise<void>;
+            getContactedOn: () => Promise<string | null>;
+            setContactData: (data: TourContactData) => Promise<void>;
+        };
+    };
+    filters: {
+        set: (filters: Partial<Filters>) => Promise<void>;
+        setTemp: (filters: Partial<Filters>) => Promise<void>;
+        setToDefault: () => Promise<void>;
+        commitTemp: <K extends keyof Filters>(key: K, defaultValue: Filters[K]) => Promise<void>;
+        commitAvailability: () => Promise<void>;
+        submit: () => Promise<void>;
+    };
+}
+export declare function createStructuredStoreActions(store: ZustandUnifiedStoreState, get?: () => ZustandUnifiedStoreState): StructuredStoreActions;
+export type StructuredStore = ZustandUnifiedStoreState & StructuredStoreActions;
+export declare function createStructuredStore(options?: {
+    onFilterUpdate?: (apiParams: QueryParams) => void;
+}): (set: any, get: any) => StructuredStore;

package/dist/adapters/zustand-store.d.ts

@@ -0,0 +1,54 @@
+import type { UserPropertyState, Filters, QueryParams, ResultsMode, SortBy, TourContactData, Unit } from "../schema";
+export interface ZustandUnifiedStoreState {
+    properties: Record<string, UserPropertyState>;
+    currentPropertyId: string | null;
+    currentPropertySlug: string | null;
+    hasPreviouslySearched: string[];
+    unitResults: Unit[];
+    filters: Filters;
+    tempFilters: Filters;
+    apiFilters: QueryParams;
+    resultsMode: ResultsMode;
+    resolvedQuestionnaireValues: Record<string, string[]>;
+    sortBy: SortBy;
+    filtersLoaded: boolean;
+    initializeProperty: (propertyId: string, slug: string) => Promise<void>;
+    setCurrentProperty: (propertyId: string, slug?: string) => Promise<void>;
+    setCurrentPropertySlug: (slug: string) => Promise<void>;
+    setHasPreviouslySearched: (slug: string) => Promise<void>;
+    toggleFavorite: (unitId: string) => Promise<void>;
+    markUnitAsViewed: (unitId: string, slug: string) => Promise<void>;
+    setTourContactedOn: () => Promise<void>;
+    getTourContactedOn: () => Promise<string | null>;
+    setQuestionnaireResults: (results: unknown) => Promise<void>;
+    setTourContactData: (data: TourContactData) => Promise<void>;
+    setUnitResults: (units: unknown) => Promise<void>;
+    clearUnitResults: () => Promise<void>;
+    setFilters: (filters: Partial<Filters>) => Promise<void>;
+    setTempFilters: (filters: Partial<Filters>) => Promise<void>;
+    setFiltersToDefault: () => Promise<void>;
+    setApiFilters: (filters: Partial<QueryParams>) => Promise<void>;
+    handleTempFilterChange: <K extends keyof Filters>(key: K, value: Filters[K]) => Promise<void>;
+    submitFilterUpdate: () => Promise<void>;
+    setResultsMode: (mode: ResultsMode) => Promise<void>;
+    setSortBy: (sortBy: SortBy) => Promise<void>;
+    setResolvedQuestionnaireValues: (name: string, values: string[]) => Promise<void>;
+    getUnitState: (unitId: string) => {
+        isFavorite: boolean;
+        viewedDate: string;
+    };
+    getResultsUrl: () => Promise<string | null>;
+    getCurrentProperty: () => Promise<UserPropertyState | null>;
+    getPropertyData: (propertyId?: string) => Promise<UserPropertyState | null>;
+    _hydrate: () => Promise<void>;
+    _initialize: () => Promise<void>;
+}
+/**
+ * @deprecated For new apps, use `createStructuredStore` from `./structured-store`.
+ * This flat adapter remains for migration/advanced cases.
+ */
+export declare function createZustandUnifiedStore(options?: {
+    onFilterUpdate?: (apiParams: QueryParams) => void;
+}): (set: any, get: any) => ZustandUnifiedStoreState;
+export declare function createUseUnitState(): (useStore: any) => (unitId: string) => any;
+export type { UnitData, UserPropertyState, Filters, QueryParams, ResultsMode, SortBy, TourContactData, Unit } from "../schema";

package/dist/api/favorites.d.ts

@@ -0,0 +1,4 @@
+export declare function getFavoritedUnitsForProperty(propertyId: string | number): Promise<string[]>;
+export declare function setFavoriteUnit(propertyId: string | number, unitId: string, on: boolean): Promise<string[]>;
+export declare function toggleFavoriteUnit(propertyId: string | number, unitId: string): Promise<string[]>;
+export declare function isUnitFavorited(propertyId: string | number, unitId: string): Promise<boolean>;

package/dist/api/properties.d.ts

@@ -0,0 +1,22 @@
+import { type TourContactData, type UserPropertyState, type PropertyStoreData } from "../schema";
+export type { ViewedUnit, TourContactData, UserPropertyState, PropertyStoreData } from "../schema";
+export declare class PropertyStore {
+    private getState;
+    private setState;
+    setHasPreviouslySearched(slug: string): Promise<void>;
+    setTourContactedOn(): Promise<void>;
+    getTourContactedOn(): Promise<string | null>;
+    setQuestionnaireResults(results: unknown): Promise<void>;
+    setTourContactData(data: TourContactData): Promise<void>;
+    toggleFavorite(unitId: string): Promise<void>;
+    markUnitAsViewed(unitId: string, slug: string): Promise<void>;
+    getUnitState(unitId: string): Promise<{
+        isFavorite: boolean;
+        viewedDate: string;
+    }>;
+    getPropertyData(propertyId?: string | number): Promise<UserPropertyState | null>;
+    getCurrentProperty(): Promise<UserPropertyState | null>;
+    getFullState(): Promise<PropertyStoreData>;
+    initializeProperty(propertyId: string | number, slug: string): Promise<void>;
+}
+export declare const propertyStore: PropertyStore;

package/dist/api/users.d.ts

@@ -0,0 +1,5 @@
+import { type User } from "../schema";
+export type IdGenerator = () => string;
+export declare const defaultIdGenerator: IdGenerator;
+export declare function ensureUser(gen?: IdGenerator): Promise<User>;
+export declare const getUserUUID: (gen?: IdGenerator) => Promise<string>;

package/dist/db.d.ts

@@ -0,0 +1,15 @@
+import { OrmDexie } from "./adapters/dexie";
+import { type ValidationMode } from "./validation";
+export type OrmOptions = {
+    dbName?: string;
+    onReset?: (reason: "incompatible" | "versionchange" | "blocked") => void;
+    onError?: (err: unknown) => void;
+    validation?: {
+        mode?: ValidationMode;
+        onIssue?: (ctx: string, details: unknown) => void;
+        validateReads?: boolean;
+        dropInvalidOnRead?: boolean;
+    };
+};
+export declare function getDB(opts?: OrmOptions): Promise<OrmDexie>;
+export declare function resetDB(dbName?: string): Promise<void>;

package/dist/debug.d.ts

@@ -0,0 +1,2 @@
+export declare function debugDump(): Promise<Record<string, unknown[]>>;
+export declare function exportJSON(filename?: string): Promise<void>;

package/dist/errors.d.ts

@@ -0,0 +1,8 @@
+export declare class SchemaMismatchError extends Error {
+    detail?: unknown | undefined;
+    constructor(message: string, detail?: unknown | undefined);
+}
+export declare class OpenDBError extends Error {
+    detail?: unknown | undefined;
+    constructor(message: string, detail?: unknown | undefined);
+}

package/dist/features/analytics/MixpanelProvider.d.ts

@@ -0,0 +1,9 @@
+import React from "react";
+interface MixpanelProviderProps {
+    children: React.ReactNode;
+    token?: string;
+    envMode?: string;
+}
+export declare const MixpanelProvider: ({ children, token: tokenOverride, envMode, }: MixpanelProviderProps) => import("react/jsx-runtime").JSX.Element;
+export declare const useMixpanel: () => import("mixpanel-browser").OverridedMixpanel;
+export {};