@superbright/indexeddb-orm 0.1.5 → 0.1.6

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 {};

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

@@ -0,0 +1,582 @@
+import { z } from "zod";
+export declare const QuestionEnumValues: readonly ["location", "budget", "size", "other"];
+export type QuestionEnum = (typeof QuestionEnumValues)[number];
+export type FilterEnum = string;
+export declare const SortEnumValues: readonly ["cost_low_to_high", "cost_high_to_low", "newest", "relevance"];
+export type SortEnum = (typeof SortEnumValues)[number];
+declare const propertyContextSchema: z.ZodObject<{
+    property_id: z.ZodString;
+    property_slug: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    property_id: string;
+    property_slug: string;
+}, {
+    property_id: string;
+    property_slug: string;
+}>;
+declare const viewAllUnitsSchema: z.ZodObject<{
+    property_id: z.ZodString;
+    property_slug: z.ZodString;
+} & {
+    property_name: z.ZodString;
+} & {
+    total_units_available: z.ZodNumber;
+    results_unit_count: z.ZodNumber;
+    unit_count_date: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    property_id: string;
+    property_slug: string;
+    property_name: string;
+    total_units_available: number;
+    results_unit_count: number;
+    unit_count_date?: string | undefined;
+}, {
+    property_id: string;
+    property_slug: string;
+    property_name: string;
+    total_units_available: number;
+    results_unit_count: number;
+    unit_count_date?: string | undefined;
+}>;
+declare const loadMoreSchema: z.ZodObject<{
+    property_id: z.ZodString;
+    property_slug: z.ZodString;
+} & {
+    property_name: z.ZodString;
+} & {
+    total_units_available: z.ZodNumber;
+    results_unit_count: z.ZodNumber;
+    unit_count_date: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    property_id: string;
+    property_slug: string;
+    property_name: string;
+    total_units_available: number;
+    results_unit_count: number;
+    unit_count_date?: string | undefined;
+}, {
+    property_id: string;
+    property_slug: string;
+    property_name: string;
+    total_units_available: number;
+    results_unit_count: number;
+    unit_count_date?: string | undefined;
+}>;
+declare const questionnaireEventSchema: z.ZodObject<{
+    property_id: z.ZodString;
+    property_slug: z.ZodString;
+} & {
+    question_index: z.ZodNumber;
+    question_ENUM: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    property_id: string;
+    property_slug: string;
+    question_index: number;
+    question_ENUM: string;
+}, {
+    property_id: string;
+    property_slug: string;
+    question_index: number;
+    question_ENUM: string;
+}>;
+declare const continueQuestionnaireEventSchema: z.ZodObject<{
+    property_id: z.ZodString;
+    property_slug: z.ZodString;
+} & {
+    question_index: z.ZodNumber;
+    question_ENUM: z.ZodString;
+} & {
+    selected_answers_ENUM_Array: z.ZodEffects<z.ZodEffects<z.ZodAny, string[], any>, string[], any>;
+}, "strip", z.ZodTypeAny, {
+    property_id: string;
+    property_slug: string;
+    question_index: number;
+    question_ENUM: string;
+    selected_answers_ENUM_Array: string[];
+}, {
+    property_id: string;
+    property_slug: string;
+    question_index: number;
+    question_ENUM: string;
+    selected_answers_ENUM_Array?: any;
+}>;
+declare const unitEventSchema: z.ZodObject<{
+    property_id: z.ZodString;
+    property_slug: z.ZodString;
+} & {
+    unit_id: z.ZodString;
+    unit_title: z.ZodString;
+    unit_slug: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    property_id: string;
+    property_slug: string;
+    unit_id: string;
+    unit_title: string;
+    unit_slug: string;
+}, {
+    property_id: string;
+    property_slug: string;
+    unit_id: string;
+    unit_title: string;
+    unit_slug: string;
+}>;
+declare const hoverUnitSchema: z.ZodObject<{
+    property_id: z.ZodString;
+    property_slug: z.ZodString;
+} & {
+    property_name: z.ZodString;
+} & {
+    unit_id: z.ZodString;
+    unit_title: z.ZodString;
+    unit_slug: z.ZodString;
+} & {
+    favorited_unit: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    property_id: string;
+    property_slug: string;
+    property_name: string;
+    unit_id: string;
+    unit_title: string;
+    unit_slug: string;
+    favorited_unit: boolean;
+}, {
+    property_id: string;
+    property_slug: string;
+    property_name: string;
+    unit_id: string;
+    unit_title: string;
+    unit_slug: string;
+    favorited_unit: boolean;
+}>;
+declare const filterOpenSchema: z.ZodObject<{
+    property_id: z.ZodString;
+    property_slug: z.ZodString;
+} & {
+    property_name: z.ZodString;
+} & {
+    filter_index: z.ZodNumber;
+    filter_label: z.ZodString;
+    selected_filters_ENUM: z.ZodEffects<z.ZodEffects<z.ZodAny, string[], any>, string[], any>;
+    filter_name: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    property_id: string;
+    property_slug: string;
+    property_name: string;
+    filter_index: number;
+    filter_label: string;
+    selected_filters_ENUM: string[];
+    filter_name?: string | undefined;
+}, {
+    property_id: string;
+    property_slug: string;
+    property_name: string;
+    filter_index: number;
+    filter_label: string;
+    selected_filters_ENUM?: any;
+    filter_name?: string | undefined;
+}>;
+declare const filterMutationSchema: z.ZodObject<{
+    property_id: z.ZodString;
+    property_slug: z.ZodString;
+} & {
+    property_name: z.ZodString;
+} & {
+    filter_index: z.ZodNumber;
+    filter_label: z.ZodString;
+    selected_filters_ENUM: z.ZodEffects<z.ZodEffects<z.ZodAny, string[], any>, string[], any>;
+}, "strip", z.ZodTypeAny, {
+    property_id: string;
+    property_slug: string;
+    property_name: string;
+    filter_index: number;
+    filter_label: string;
+    selected_filters_ENUM: string[];
+}, {
+    property_id: string;
+    property_slug: string;
+    property_name: string;
+    filter_index: number;
+    filter_label: string;
+    selected_filters_ENUM?: any;
+}>;
+declare const sortEventSchema: z.ZodObject<{
+    property_id: z.ZodString;
+    property_slug: z.ZodString;
+} & {
+    sort_index: z.ZodNumber;
+    sort_ENUM: z.ZodEnum<["cost_low_to_high", "cost_high_to_low", "newest", "relevance"]>;
+}, "strip", z.ZodTypeAny, {
+    property_id: string;
+    property_slug: string;
+    sort_index: number;
+    sort_ENUM: "relevance" | "newest" | "cost_low_to_high" | "cost_high_to_low";
+}, {
+    property_id: string;
+    property_slug: string;
+    sort_index: number;
+    sort_ENUM: "relevance" | "newest" | "cost_low_to_high" | "cost_high_to_low";
+}>;
+declare const sortOpenSchema: z.ZodObject<{
+    property_id: z.ZodString;
+    property_slug: z.ZodString;
+} & {
+    property_name: z.ZodString;
+} & {
+    sort_index: z.ZodNumber;
+    sort_ENUM: z.ZodEnum<["cost_low_to_high", "cost_high_to_low", "newest", "relevance"]>;
+    results_unit_count: z.ZodNumber;
+    unit_count_date: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    property_id: string;
+    property_slug: string;
+    property_name: string;
+    results_unit_count: number;
+    sort_index: number;
+    sort_ENUM: "relevance" | "newest" | "cost_low_to_high" | "cost_high_to_low";
+    unit_count_date?: string | undefined;
+}, {
+    property_id: string;
+    property_slug: string;
+    property_name: string;
+    results_unit_count: number;
+    sort_index: number;
+    sort_ENUM: "relevance" | "newest" | "cost_low_to_high" | "cost_high_to_low";
+    unit_count_date?: string | undefined;
+}>;
+declare const questionnaireResultSchema: z.ZodObject<{
+    property_id: z.ZodString;
+    property_slug: z.ZodString;
+} & {
+    full_questionnaire_schema_json: z.ZodOptional<z.ZodUnknown>;
+    unit_results: z.ZodOptional<z.ZodObject<{
+        type: z.ZodOptional<z.ZodString>;
+        total: z.ZodOptional<z.ZodNumber>;
+        units: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            unit_id: z.ZodString;
+            unit_name: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            unit_id: string;
+            unit_name?: string | undefined;
+        }, {
+            unit_id: string;
+            unit_name?: string | undefined;
+        }>, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        type?: string | undefined;
+        units?: {
+            unit_id: string;
+            unit_name?: string | undefined;
+        }[] | undefined;
+        total?: number | undefined;
+    }, {
+        type?: string | undefined;
+        units?: {
+            unit_id: string;
+            unit_name?: string | undefined;
+        }[] | undefined;
+        total?: number | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    property_id: string;
+    property_slug: string;
+    full_questionnaire_schema_json?: unknown;
+    unit_results?: {
+        type?: string | undefined;
+        units?: {
+            unit_id: string;
+            unit_name?: string | undefined;
+        }[] | undefined;
+        total?: number | undefined;
+    } | undefined;
+}, {
+    property_id: string;
+    property_slug: string;
+    full_questionnaire_schema_json?: unknown;
+    unit_results?: {
+        type?: string | undefined;
+        units?: {
+            unit_id: string;
+            unit_name?: string | undefined;
+        }[] | undefined;
+        total?: number | undefined;
+    } | undefined;
+}>;
+declare const clickUnitSchema: z.ZodObject<{
+    property_id: z.ZodString;
+    property_slug: z.ZodString;
+} & {
+    property_name: z.ZodString;
+} & {
+    unit_id: z.ZodString;
+    unit_title: z.ZodString;
+    unit_slug: z.ZodString;
+} & {
+    favorited_unit: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    property_id: string;
+    property_slug: string;
+    property_name: string;
+    unit_id: string;
+    unit_title: string;
+    unit_slug: string;
+    favorited_unit: boolean;
+}, {
+    property_id: string;
+    property_slug: string;
+    property_name: string;
+    unit_id: string;
+    unit_title: string;
+    unit_slug: string;
+    favorited_unit: boolean;
+}>;
+declare const clickUnitFavoritesSchema: z.ZodObject<{
+    property_id: z.ZodString;
+    property_slug: z.ZodString;
+} & {
+    property_name: z.ZodString;
+} & {
+    unit_id: z.ZodString;
+    unit_title: z.ZodString;
+    unit_slug: z.ZodString;
+} & {
+    favorited_unit: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    property_id: string;
+    property_slug: string;
+    property_name: string;
+    unit_id: string;
+    unit_title: string;
+    unit_slug: string;
+    favorited_unit: boolean;
+}, {
+    property_id: string;
+    property_slug: string;
+    property_name: string;
+    unit_id: string;
+    unit_title: string;
+    unit_slug: string;
+    favorited_unit: boolean;
+}>;
+export type BaseEvent = z.infer<typeof propertyContextSchema>;
+export type ViewAllUnitsEvent = z.infer<typeof viewAllUnitsSchema>;
+export type LoadMoreEvent = z.infer<typeof loadMoreSchema>;
+export type QuestionnaireEvent = z.infer<typeof questionnaireEventSchema>;
+export type ContinueQuestionnaireEvent = z.infer<typeof continueQuestionnaireEventSchema>;
+export type ClickUnitEvent = z.infer<typeof clickUnitSchema>;
+export type UnitEvent = z.infer<typeof unitEventSchema>;
+export type HoverUnitEvent = z.infer<typeof hoverUnitSchema>;
+export type FilterEvent = z.infer<typeof filterMutationSchema>;
+export type FilterOpenEvent = z.infer<typeof filterOpenSchema>;
+export type SortEvent = z.infer<typeof sortEventSchema>;
+export type SortOpenEvent = z.infer<typeof sortOpenSchema>;
+export type QuestionnaireResultEvent = z.infer<typeof questionnaireResultSchema>;
+export type ClickUnitFavoritesEvent = z.infer<typeof clickUnitFavoritesSchema>;
+export type TrackingEventWithUnits = FilterEvent & {
+    trackingEvent: (payload: FilterEvent) => void;
+    [metadata: string]: unknown;
+};
+export type TrackEventFn = (eventName: string, data?: Record<string, any>) => void;
+export declare function useTrackEvent(): (eventName: string, data?: Record<string, any>) => void;
+export declare function buildTrackingEvents(trackEvent: TrackEventFn): {
+    trackViewAllUnits: (payload: z.input<typeof viewAllUnitsSchema>) => void;
+    trackQuestionnaireSkip: (payload: {
+        property_id: string;
+        property_slug: string;
+        question_index: number;
+        question_ENUM: string;
+    }) => void;
+    trackQuestionnaireContinue: (payload: {
+        property_id: string;
+        property_slug: string;
+        question_index: number;
+        question_ENUM: string;
+        selected_answers_ENUM_Array?: any;
+    }) => void;
+    trackQuestionnaireBack: (payload: {
+        property_id: string;
+        property_slug: string;
+        question_index: number;
+        question_ENUM: string;
+    }) => void;
+    trackClickUnit: (payload: {
+        property_id: string;
+        property_slug: string;
+        property_name: string;
+        unit_id: string;
+        unit_title: string;
+        unit_slug: string;
+        favorited_unit: boolean;
+    }) => void;
+    trackHoverUnit: (payload: {
+        property_id: string;
+        property_slug: string;
+        property_name: string;
+        unit_id: string;
+        unit_title: string;
+        unit_slug: string;
+        favorited_unit: boolean;
+    }) => void;
+    trackLoadMore: (payload: z.input<typeof loadMoreSchema>) => void;
+    trackOpenFilters: (payload: {
+        property_id: string;
+        property_slug: string;
+        property_name: string;
+        filter_index: number;
+        filter_label: string;
+        selected_filters_ENUM?: any;
+        filter_name?: string | undefined;
+    }) => void;
+    trackCancelFilter: (payload: {
+        property_id: string;
+        property_slug: string;
+        property_name: string;
+        filter_index: number;
+        filter_label: string;
+        selected_filters_ENUM?: any;
+    }) => void;
+    trackApplyFilter: (payload: {
+        property_id: string;
+        property_slug: string;
+        property_name: string;
+        filter_index: number;
+        filter_label: string;
+        selected_filters_ENUM?: any;
+    }) => void;
+    trackOpenSort: (payload: z.input<typeof sortOpenSchema>) => void;
+    trackSelectSort: (payload: {
+        property_id: string;
+        property_slug: string;
+        sort_index: number;
+        sort_ENUM: "relevance" | "newest" | "cost_low_to_high" | "cost_high_to_low";
+    }) => void;
+    trackCancelSort: (payload: {
+        property_id: string;
+        property_slug: string;
+        sort_index: number;
+        sort_ENUM: "relevance" | "newest" | "cost_low_to_high" | "cost_high_to_low";
+    }) => void;
+    trackClickUnitFavorites: (payload: {
+        property_id: string;
+        property_slug: string;
+        property_name: string;
+        unit_id: string;
+        unit_title: string;
+        unit_slug: string;
+        favorited_unit: boolean;
+    }) => void;
+    trackQuestionnaireResult: (payload: {
+        property_id: string;
+        property_slug: string;
+        full_questionnaire_schema_json?: unknown;
+        unit_results?: {
+            type?: string | undefined;
+            units?: {
+                unit_id: string;
+                unit_name?: string | undefined;
+            }[] | undefined;
+            total?: number | undefined;
+        } | undefined;
+    }) => void;
+};
+export declare function useTrackingEvents(): {
+    trackViewAllUnits: (payload: z.input<typeof viewAllUnitsSchema>) => void;
+    trackQuestionnaireSkip: (payload: {
+        property_id: string;
+        property_slug: string;
+        question_index: number;
+        question_ENUM: string;
+    }) => void;
+    trackQuestionnaireContinue: (payload: {
+        property_id: string;
+        property_slug: string;
+        question_index: number;
+        question_ENUM: string;
+        selected_answers_ENUM_Array?: any;
+    }) => void;
+    trackQuestionnaireBack: (payload: {
+        property_id: string;
+        property_slug: string;
+        question_index: number;
+        question_ENUM: string;
+    }) => void;
+    trackClickUnit: (payload: {
+        property_id: string;
+        property_slug: string;
+        property_name: string;
+        unit_id: string;
+        unit_title: string;
+        unit_slug: string;
+        favorited_unit: boolean;
+    }) => void;
+    trackHoverUnit: (payload: {
+        property_id: string;
+        property_slug: string;
+        property_name: string;
+        unit_id: string;
+        unit_title: string;
+        unit_slug: string;
+        favorited_unit: boolean;
+    }) => void;
+    trackLoadMore: (payload: z.input<typeof loadMoreSchema>) => void;
+    trackOpenFilters: (payload: {
+        property_id: string;
+        property_slug: string;
+        property_name: string;
+        filter_index: number;
+        filter_label: string;
+        selected_filters_ENUM?: any;
+        filter_name?: string | undefined;
+    }) => void;
+    trackCancelFilter: (payload: {
+        property_id: string;
+        property_slug: string;
+        property_name: string;
+        filter_index: number;
+        filter_label: string;
+        selected_filters_ENUM?: any;
+    }) => void;
+    trackApplyFilter: (payload: {
+        property_id: string;
+        property_slug: string;
+        property_name: string;
+        filter_index: number;
+        filter_label: string;
+        selected_filters_ENUM?: any;
+    }) => void;
+    trackOpenSort: (payload: z.input<typeof sortOpenSchema>) => void;
+    trackSelectSort: (payload: {
+        property_id: string;
+        property_slug: string;
+        sort_index: number;
+        sort_ENUM: "relevance" | "newest" | "cost_low_to_high" | "cost_high_to_low";
+    }) => void;
+    trackCancelSort: (payload: {
+        property_id: string;
+        property_slug: string;
+        sort_index: number;
+        sort_ENUM: "relevance" | "newest" | "cost_low_to_high" | "cost_high_to_low";
+    }) => void;
+    trackClickUnitFavorites: (payload: {
+        property_id: string;
+        property_slug: string;
+        property_name: string;
+        unit_id: string;
+        unit_title: string;
+        unit_slug: string;
+        favorited_unit: boolean;
+    }) => void;
+    trackQuestionnaireResult: (payload: {
+        property_id: string;
+        property_slug: string;
+        full_questionnaire_schema_json?: unknown;
+        unit_results?: {
+            type?: string | undefined;
+            units?: {
+                unit_id: string;
+                unit_name?: string | undefined;
+            }[] | undefined;
+            total?: number | undefined;
+        } | undefined;
+    }) => void;
+};
+export {};

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

@@ -0,0 +1 @@
+export declare const generateUserUUID: Promise<string>;

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

@@ -0,0 +1,3 @@
+export * from "./analytics";
+export { MixpanelProvider, useMixpanel } from "./MixpanelProvider";
+export { generateUserUUID } from "./generateUserUUID";