@rebasepro/client-firebase 0.0.1-canary.4d4fb3e

package/src/hooks/useInitialiseFirebase.ts

@@ -0,0 +1,132 @@
+import { useCallback, useEffect, useState } from "react";
+
+import { deleteApp, FirebaseApp, getApps, initializeApp } from "@firebase/app";
+
+/**
+ * @group Firebase
+ */
+export interface InitialiseFirebaseResult {
+    firebaseConfigLoading: boolean,
+    firebaseApp?: FirebaseApp;
+    configError?: string,
+    firebaseConfigError?: Error
+}
+
+const hostingError = "It seems like the provided Firebase config is not correct. If you \n" +
+    "are using the credentials provided automatically by Firebase \n" +
+    "Hosting, make sure you link your Firebase app to Firebase Hosting. \n";
+
+/**
+ * Function used to initialise Firebase, either by using the provided config,
+ * or by fetching it by Firebase Hosting, if not specified.
+ *
+ * It works as a hook that gives you the loading state and the used
+ * configuration.
+ *
+ * You most likely only need to use this if you are developing a custom app. You can also not use this component
+ * and initialise Firebase yourself.
+ *
+ * @param onFirebaseInit
+ * @param firebaseConfig
+ * @param fromUrl
+ * @param name
+ * @param authDomain
+ * @group Firebase
+ */
+export function useInitialiseFirebase({
+                                          firebaseConfig,
+                                          fromUrl,
+                                          onFirebaseInit,
+                                          name,
+                                          authDomain
+                                      }: {
+    firebaseConfig?: Record<string, unknown>,
+    fromUrl?: string | undefined,
+    onFirebaseInit?: ((config: object, firebaseApp: FirebaseApp) => void) | undefined,
+    name?: string;
+    authDomain?: string;
+}): InitialiseFirebaseResult {
+
+    const [firebaseApp, setFirebaseApp] = useState<FirebaseApp | undefined>();
+    const [firebaseConfigLoading, setFirebaseConfigLoading] = useState<boolean>(false);
+    const [configError, setConfigError] = useState<string>();
+
+    const initFirebase = useCallback((config: Record<string, unknown>) => {
+
+        if (config.projectId === firebaseApp?.options.projectId) {
+            console.debug("Firebase app already initialised with the same project ID. This should happen only in development mode.");
+            setConfigError(undefined);
+            setFirebaseConfigLoading(false);
+            return;
+        }
+
+        try {
+            const targetName = name ?? "[DEFAULT]";
+            const currentApps = getApps();
+            const existingApp = currentApps.find(app => app.name === targetName);
+            if (existingApp) {
+                deleteApp(existingApp);
+            }
+            const initialisedFirebaseApp = initializeApp(config, targetName);
+            setConfigError(undefined);
+            setFirebaseConfigLoading(false);
+            setFirebaseApp(initialisedFirebaseApp);
+        } catch (e: any) {
+            console.error("Error initialising Firebase", e);
+            setConfigError(hostingError + "\n" + (e.message ?? JSON.stringify(e)));
+        }
+    }, [name]);
+
+    useEffect(() => {
+        if (onFirebaseInit && firebaseConfig && firebaseApp) {
+            onFirebaseInit(firebaseConfig, firebaseApp);
+        }
+    }, [firebaseApp]);
+
+    useEffect(() => {
+
+        setFirebaseConfigLoading(true);
+
+        function fetchFromUrl(url: string) {
+            fetch(url)
+                .then(async response => {
+                    console.debug("Firebase init response", response.status);
+                    if (response && response.status < 300) {
+                        const config = await response.json();
+                        if (authDomain) config.authDomain = authDomain;
+                        initFirebase(config);
+                    }
+                })
+                .catch(e => {
+                        setFirebaseConfigLoading(false);
+                        setConfigError(
+                            "Could not load Firebase configuration from Firebase hosting. " +
+                            "If the app is not deployed in Firebase hosting, you need to specify the configuration manually" +
+                            e.toString()
+                        );
+                    }
+                );
+        }
+
+        if (firebaseConfig) {
+            initFirebase(firebaseConfig);
+        } else {
+            if (fromUrl) {
+                fetchFromUrl(fromUrl);
+            } else if (process.env.NODE_ENV === "production") {
+                fetchFromUrl("/__/firebase/init.json");
+            } else {
+                setFirebaseConfigLoading(false);
+                setConfigError(
+                    "You need to deploy the app to Firebase hosting or specify a Firebase configuration object"
+                );
+            }
+        }
+    }, []);
+
+    return {
+        firebaseApp,
+        firebaseConfigLoading,
+        configError
+    };
+}

package/src/hooks/useRecaptcha.tsx

@@ -0,0 +1,28 @@
+import { useEffect } from "react";
+import { getAuth, RecaptchaVerifier } from "@firebase/auth";
+
+declare global {
+    interface Window {
+        recaptchaVerifier: RecaptchaVerifier;
+    }
+}
+
+export const RECAPTCHA_CONTAINER_ID = "recaptcha-container" as const;
+
+export function useRecaptcha() {
+    useEffect(() => {
+        if (!window || window?.recaptchaVerifier) return;
+
+        const auth = getAuth();
+
+        window.recaptchaVerifier = new RecaptchaVerifier(
+            auth,
+            RECAPTCHA_CONTAINER_ID,
+            {
+                size: "invisible"
+            }
+        );
+    }, []);
+
+    return null;
+}

package/src/index.ts

@@ -0,0 +1,4 @@
+export * from "./hooks";
+export * from "./types";
+export * from "./utils";
+export * from "./components";

package/src/social_icons.tsx

@@ -0,0 +1,135 @@
+export const googleIcon = (mode: "light" | "dark") => <>
+    <svg
+        xmlns="http://www.w3.org/2000/svg"
+        viewBox="0 0 64 64"
+        width={32}
+        height={32}
+    >
+        <linearGradient
+            id="95yY7w43Oj6n2vH63j6HJb"
+            x1="29.401"
+            x2="29.401"
+            y1="4.064"
+            y2="106.734"
+            gradientTransform="matrix(1 0 0 -1 0 66)"
+            gradientUnits="userSpaceOnUse"
+        >
+            <stop offset="0" stopColor="#ff5840"/>
+            <stop offset=".007" stopColor="#ff5840"/>
+            <stop offset=".989" stopColor="#fa528c"/>
+            <stop offset="1" stopColor="#fa528c"/>
+        </linearGradient>
+        <path
+            fill="url(#95yY7w43Oj6n2vH63j6HJb)"
+            d="M47.46,15.5l-1.37,1.48c-1.34,1.44-3.5,1.67-5.15,0.6c-2.71-1.75-6.43-3.13-11-2.37 c-4.94,0.83-9.17,3.85-11.64, 7.97l-8.03-6.08C14.99,9.82,23.2,5,32.5,5c5,0,9.94,1.56,14.27,4.46 C48.81,10.83,49.13,13.71,47.46,15.5z"
+        />
+        <linearGradient
+            id="95yY7w43Oj6n2vH63j6HJc"
+            x1="12.148"
+            x2="12.148"
+            y1=".872"
+            y2="47.812"
+            gradientTransform="matrix(1 0 0 -1 0 66)"
+            gradientUnits="userSpaceOnUse"
+        >
+            <stop offset="0" stopColor="#feaa53"/>
+            <stop offset=".612" stopColor="#ffcd49"/>
+            <stop offset="1" stopColor="#ffde44"/>
+        </linearGradient>
+        <path
+            fill="url(#95yY7w43Oj6n2vH63j6HJc)"
+            d="M16.01,30.91c-0.09,2.47,0.37,4.83,1.27,6.96l-8.21,6.05c-1.35-2.51-2.3-5.28-2.75-8.22 c-1.06-6.88,0.54-13.38, 3.95-18.6l8.03,6.08C16.93,25.47,16.1,28.11,16.01,30.91z"
+        />
+        <linearGradient
+            id="95yY7w43Oj6n2vH63j6HJd"
+            x1="29.76"
+            x2="29.76"
+            y1="32.149"
+            y2="-6.939"
+            gradientTransform="matrix(1 0 0 -1 0 66)"
+            gradientUnits="userSpaceOnUse"
+        >
+            <stop offset="0" stopColor="#42d778"/>
+            <stop offset=".428" stopColor="#3dca76"/>
+            <stop offset="1" stopColor="#34b171"/>
+        </linearGradient>
+        <path
+            fill="url(#95yY7w43Oj6n2vH63j6HJd)"
+            d="M50.45,51.28c-4.55,4.07-10.61,6.57-17.36,6.71C22.91,58.2,13.66,52.53,9.07,43.92l8.21-6.05 C19.78,43.81, 25.67,48,32.5,48c3.94,0,7.52-1.28,10.33-3.44L50.45,51.28z"
+        />
+        <linearGradient
+            id="95yY7w43Oj6n2vH63j6HJe"
+            x1="46"
+            x2="46"
+            y1="3.638"
+            y2="35.593"
+            gradientTransform="matrix(1 0 0 -1 0 66)"
+            gradientUnits="userSpaceOnUse"
+        >
+            <stop offset="0" stopColor="#155cde"/>
+            <stop offset=".278" stopColor="#1f7fe5"/>
+            <stop offset=".569" stopColor="#279ceb"/>
+            <stop offset=".82" stopColor="#2cafef"/>
+            <stop offset="1" stopColor="#2eb5f0"/>
+        </linearGradient>
+        <path
+            fill="url(#95yY7w43Oj6n2vH63j6HJe)"
+            d="M59,31.97c0.01,7.73-3.26,14.58-8.55,19.31l-7.62-6.72c2.1-1.61,3.77-3.71,4.84-6.15
+        c0.29-0.66-0.2-1.41-0.92-1.41H37c-2.21,0-4-1.79-4-4v-2c0-2.21,1.79-4,4-4h17C56.75,27,59,29.22,59,31.97z"
+        />
+    </svg>
+</>;
+
+export const appleIcon = (mode: "light" | "dark") => <svg width={32} height={32}
+                                                          viewBox="0 0 56 56"
+                                                          style={{ transform: "scale(2.8)" }}
+                                                          version="1.1"
+                                                          xmlns="http://www.w3.org/2000/svg">
+    <g stroke={mode === "light" ? "#424245" : "white"} strokeWidth="0.5"
+       fillRule="evenodd">
+        <path
+            d="M28.2226562,20.3846154 C29.0546875,20.3846154 30.0976562,19.8048315 30.71875,19.0317864 C31.28125,18.3312142 31.6914062,17.352829 31.6914062,16.3744437 C31.6914062,16.2415766 31.6796875,16.1087095 31.65625,16 C30.7304687,16.0362365 29.6171875,16.640178 28.9492187,17.4494596 C28.421875,18.06548 27.9414062,19.0317864 27.9414062,20.0222505 C27.9414062,20.1671964 27.9648438,20.3121424 27.9765625,20.3604577 C28.0351562,20.3725366 28.1289062,20.3846154 28.2226562,20.3846154 Z M25.2929688,35 C26.4296875,35 26.9335938,34.214876 28.3515625,34.214876 C29.7929688,34.214876 30.109375,34.9758423 31.375,34.9758423 C32.6171875,34.9758423 33.4492188,33.792117 34.234375,32.6325493 C35.1132812,31.3038779 35.4765625,29.9993643 35.5,29.9389701 C35.4179688,29.9148125 33.0390625,28.9122695 33.0390625,26.0979021 C33.0390625,23.6579784 34.9140625,22.5588048 35.0195312,22.474253 C33.7773438,20.6382708 31.890625,20.5899555 31.375,20.5899555 C29.9804688,20.5899555 28.84375,21.4596313 28.1289062,21.4596313 C27.3554688,21.4596313 26.3359375,20.6382708 25.1289062,20.6382708 C22.8320312,20.6382708 20.5,22.5950413 20.5,26.2911634 C20.5,28.5861411 21.3671875,31.013986 22.4335938,32.5842339 C23.3476562,33.9129053 24.1445312,35 25.2929688,35 Z"
+            fill={mode === "light" ? "#424245" : "white"} fillRule="nonzero"/>
+    </g>
+</svg>;
+
+export const githubIcon = (mode: "light" | "dark") => <svg
+    fill={mode === "light" ? "#1c1e21" : "white"}
+    role="img"
+    viewBox="0 0 24 24"
+    width={28}
+    height={28}
+    xmlns="http://www.w3.org/2000/svg">
+    <path
+        d="M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12"/>
+</svg>;
+
+
+export const facebookIcon = (mode: "light" | "dark") => <svg
+    xmlns="http://www.w3.org/2000/svg"
+    width={28} height={28}
+    viewBox="0 0 90 90">
+    <g>
+        <path
+            d="M90,15.001C90,7.119,82.884,0,75,0H15C7.116,0,0,7.119,0,15.001v59.998   C0,82.881,7.116,90,15.001,90H45V56H34V41h11v-5.844C45,25.077,52.568,16,61.875,16H74v15H61.875C60.548,31,59,32.611,59,35.024V41   h15v15H59v34h16c7.884,0,15-7.119,15-15.001V15.001z"
+            fill={mode === "light" ? "#39569c" : "white"}/>
+    </g>
+</svg>;
+
+export const microsoftIcon = (mode: "light" | "dark") => <svg
+    xmlns="http://www.w3.org/2000/svg" width={28} height={28}
+    viewBox="0 0 480 480">
+    <g>
+        <path
+            d="M0.176,224L0.001,67.963l192-26.072V224H0.176z M224.001,37.241L479.937,0v224H224.001V37.241z M479.999,256l-0.062,224   l-255.936-36.008V256H479.999z M192.001,439.918L0.157,413.621L0.147,256h191.854V439.918z"
+            fill={mode === "light" ? "#00a2ed" : "white"}/>
+    </g>
+</svg>;
+
+export const twitterIcon = (mode: "light" | "dark") => <svg
+    xmlns="http://www.w3.org/2000/svg" width={28} height={28}
+    viewBox="0 0 24 24">
+    <path fill={mode === "light" ? "#00acee" : "white"}
+          d="M24 4.557c-.883.392-1.832.656-2.828.775 1.017-.609 1.798-1.574 2.165-2.724-.951.564-2.005.974-3.127 1.195-.897-.957-2.178-1.555-3.594-1.555-3.179 0-5.515 2.966-4.797 6.045-4.091-.205-7.719-2.165-10.148-5.144-1.29 2.213-.669 5.108 1.523 6.574-.806-.026-1.566-.247-2.229-.616-.054 2.281 1.581 4.415 3.949 4.89-.693.188-1.452.232-2.224.084.626 1.956 2.444 3.379 4.6 3.419-2.07 1.623-4.678 2.348-7.29 2.04 2.179 1.397 4.768 2.212 7.548 2.212 9.142 0 14.307-7.721 13.995-14.646.962-.695 1.797-1.562 2.457-2.549z"/>
+</svg>;
+

package/src/types/appcheck.ts

@@ -0,0 +1,11 @@
+import { CustomProvider, ReCaptchaEnterpriseProvider, ReCaptchaV3Provider } from "@firebase/app-check";
+
+/**
+ * @group Firebase
+ */
+export interface AppCheckOptions {
+    provider: CustomProvider | ReCaptchaV3Provider | ReCaptchaEnterpriseProvider;
+    isTokenAutoRefreshEnabled?: boolean;
+    debugToken?: string;
+    forceRefresh?: boolean;
+}

package/src/types/auth.tsx

@@ -0,0 +1,74 @@
+import { ApplicationVerifier, ConfirmationResult, User as FirebaseUser } from "@firebase/auth";
+
+import { AuthController, Role, User } from "@rebasepro/types";
+
+/**
+ * @group Firebase
+ */
+export type FirebaseSignInProvider =
+    | "password"
+    | "phone"
+    | "anonymous"
+    | "google.com"
+    | "facebook.com"
+    | "github.com"
+    | "twitter.com"
+    | "microsoft.com"
+    | "apple.com";
+
+/**
+ * @group Firebase
+ */
+export type FirebaseSignInOption = {
+    provider: FirebaseSignInProvider;
+    scopes?: string[];
+    customParameters?: Record<string, string>;
+}
+
+export type FirebaseUserWrapper = User & FirebaseUser & {
+    firebaseUser: FirebaseUser | null;
+}
+
+/**
+ * @group Firebase
+ */
+export type FirebaseAuthController<USER extends User = FirebaseUserWrapper, ExtraData = any> =
+    AuthController<USER, ExtraData>
+    & {
+
+        confirmationResult?: ConfirmationResult;
+
+        googleLogin: () => void;
+
+        anonymousLogin: () => void;
+
+        appleLogin: () => void;
+
+        facebookLogin: () => void;
+
+        githubLogin: () => void;
+
+        microsoftLogin: () => void;
+
+        twitterLogin: () => void;
+
+        emailPasswordLogin: (email: string, password: string) => void;
+
+        fetchSignInMethodsForEmail: (email: string) => Promise<string[]>;
+
+        createUserWithEmailAndPassword: (email: string, password: string) => void;
+
+        sendPasswordResetEmail: (email: string) => Promise<void>;
+
+        phoneLogin: (phone: string, applicationVerifier: ApplicationVerifier) => void;
+
+        /**
+         * Skip login
+         */
+        skipLogin: () => void;
+
+        setUser: (user: USER | null) => void;
+
+        setUserRoles: (roles: Role[]) => void;
+
+    };

package/src/types/index.ts

@@ -0,0 +1,3 @@
+export * from "./auth";
+export * from "./text_search";
+export * from "./appcheck";

package/src/types/text_search.ts

@@ -0,0 +1,42 @@
+import { User as FirebaseUser } from "@firebase/auth";
+import { FirebaseApp } from "@firebase/app";
+import { EntityCollection } from "@rebasepro/types";
+
+export type FirestoreTextSearchControllerBuilder = (props: {
+    firebaseApp: FirebaseApp;
+}) => FirestoreTextSearchController;
+
+/**
+ * Use this controller to return a list of ids from a search index, given a
+ * `path` and a `searchString`.
+ * Firestore does not support text search directly, so we need to rely on an external
+ * index, such as Algolia.
+ * Note that you will get text search requests for collections that have the
+ * `textSearchEnabled` flag set to `true`.
+ * @see performAlgoliaTextSearch
+ * @group Firebase
+ */
+export type FirestoreTextSearchController = {
+    /**
+     * This method is called when a search delegate is ready to be used.
+     * Return true if this path can be handled by this controller.
+     * @param props
+     */
+    init: (props: {
+        path: string,
+        databaseId?: string,
+        collection?: EntityCollection
+    }) => Promise<boolean>,
+    /**
+     * Do the search and return a list of ids.
+     * @param props
+     */
+    search: (props: {
+        searchString: string,
+        path: string,
+        currentUser?: FirebaseUser,
+        databaseId?: string,
+        collection?: EntityCollection
+    }) => (Promise<readonly string[] | undefined>),
+
+};

package/src/utils/algolia.ts

@@ -0,0 +1,27 @@
+import { buildExternalSearchController } from "./text_search_controller";
+
+/**
+ * Utility function to perform a text search in an algolia index,
+ * returning the ids of the entities.
+ * @param client The algolia client
+ * @param indexName
+ * @param query
+ * @group Firebase
+ */
+export function performAlgoliaTextSearch(client: any, indexName: string, query: string): Promise<readonly string[]> {
+
+    console.debug("Performing Algolia query", client, query);
+
+    return client.searchSingleIndex({
+        indexName,
+        searchParams: { query },
+    }).then(({ hits }: any) => {
+        return hits.map((hit: any) => hit.objectID as string);
+    })
+        .catch((err: any) => {
+            console.error(err);
+            return [];
+        });
+}
+
+

package/src/utils/collections_firestore.ts

@@ -0,0 +1,149 @@
+import { deleteField, DocumentSnapshot } from "@firebase/firestore";
+import { EntityCollection, FirebaseCollection, Properties, Property } from "@rebasepro/types";
+import { COLLECTION_PATH_SEPARATOR, sortProperties, stripCollectionPath } from "@rebasepro/common";
+
+export function buildCollectionId(idOrPath: string, parentCollectionIds?: string[]): string {
+    if (!parentCollectionIds)
+        return stripCollectionPath(idOrPath);
+    return [...parentCollectionIds.map(stripCollectionPath), stripCollectionPath(idOrPath)].join(COLLECTION_PATH_SEPARATOR);
+}
+
+
+
+export const docsToCollectionTree = (docs: DocumentSnapshot[]): EntityCollection[] => {
+
+    const collectionsMap = docs.map((doc) => {
+        const id: string = doc.id;
+        const collection = docToCollection(doc);
+        return { [id]: collection };
+    }).reduce((a, b) => ({ ...a, ...b }), {});
+
+    const orderedKeys = Object.keys(collectionsMap).sort((a, b) => b.split(COLLECTION_PATH_SEPARATOR).length - a.split(COLLECTION_PATH_SEPARATOR).length);
+
+    orderedKeys.forEach((id) => {
+        const collection = collectionsMap[id];
+        if (id.includes(COLLECTION_PATH_SEPARATOR)) {
+            const parentId = id.split(COLLECTION_PATH_SEPARATOR).slice(0, -1).join(COLLECTION_PATH_SEPARATOR);
+            const parentCollection = collectionsMap[parentId];
+            if (parentCollection)
+                (parentCollection as FirebaseCollection).subcollections = () => [...((parentCollection as FirebaseCollection).subcollections?.() ?? []), collection];
+            delete collectionsMap[id];
+        }
+    });
+
+    return Object.values(collectionsMap);
+}
+
+export const docToCollection = (doc: DocumentSnapshot): EntityCollection => {
+    const data = doc.data();
+    if (!data)
+        throw Error("Entity collection has not been persisted correctly");
+    const propertiesOrder = data.propertiesOrder;
+    const properties = data.properties as Properties ?? {};
+
+    // Normalize enum values from object format to array format (sorted alphabetically)
+    const normalizedProperties = normalizePropertiesEnumValues(properties, true);
+    const sortedProperties = sortProperties(normalizedProperties, propertiesOrder);
+    return {
+        ...data,
+        properties: sortedProperties,
+        slug: data.id ?? data.alias ?? data.slug
+    } as EntityCollection;
+}
+
+
+
+/**
+ * Converts enum values from object format to array format.
+ * Firestore doesn't preserve object key order, so we must use arrays.
+ * When enum values are already stored as an array, their order is preserved
+ * (this is intentional - users can reorder columns in Kanban view).
+ * Only sort alphabetically when converting from legacy object format.
+ * @param enumValues - The enum values (object or array format)
+ * @param sortObjectFormat - If true, sort by id alphabetically when converting from object format
+ * @returns Array of EnumValueConfig objects
+ */
+function normalizeEnumValuesToArray(
+    enumValues: unknown,
+    sortObjectFormat: boolean = false
+): unknown[] {
+    if (Array.isArray(enumValues)) {
+        // Already an array - preserve order! This order is intentional
+        // (e.g., user reordered Kanban columns)
+        return enumValues;
+    } else if (typeof enumValues === "object" && enumValues !== null) {
+        // Convert object to array format
+        // Object keys don't have guaranteed order in Firestore, so we sort alphabetically
+        const entries = Object.entries(enumValues).map(([id, value]) =>
+            typeof value === "string"
+                ? {
+                    id,
+                    label: value
+                }
+                : {
+                    ...(value as object),
+                    id
+                }
+        );
+        // Sort alphabetically by id when loading from Firestore object format
+        // This is the only case where sorting makes sense, since object key order is not preserved
+        if (sortObjectFormat) {
+            entries.sort((a, b) => String(a.id).localeCompare(String(b.id)));
+        }
+        return entries;
+    }
+    return [];
+}
+
+/**
+ * Normalizes all enum values in a properties object.
+ * @param properties - The properties object to normalize
+ * @param sortObjectFormat - If true, sort enum values alphabetically when converting from object format
+ * @returns Properties with normalized enum values
+ */
+function normalizePropertiesEnumValues(
+    properties: Properties,
+    sortObjectFormat: boolean = false
+): Properties {
+    const result: Properties = {};
+    Object.entries(properties).forEach(([key, property]) => {
+        if (typeof property === "object" && property !== null) {
+            const normalizedProperty = { ...property } as Record<string, unknown>;
+
+            // Handle direct enum values
+            if (normalizedProperty.enum) {
+                normalizedProperty.enum = normalizeEnumValuesToArray(
+                    normalizedProperty.enum,
+                    sortObjectFormat
+                );
+            }
+
+            // Handle array properties with enum values in "of"
+            if (normalizedProperty.dataType === "array" && typeof normalizedProperty.of === "object" && normalizedProperty.of !== null) {
+                const ofProp = normalizedProperty.of as Record<string, unknown>;
+                if (ofProp.enum) {
+                    normalizedProperty.of = {
+                        ...ofProp,
+                        enum: normalizeEnumValuesToArray(
+                            ofProp.enum,
+                            sortObjectFormat
+                        )
+                    };
+                }
+            }
+
+            // Handle map properties recursively
+            if (normalizedProperty.dataType === "map" && normalizedProperty.properties) {
+                normalizedProperty.properties = normalizePropertiesEnumValues(
+                    normalizedProperty.properties as Properties,
+                    sortObjectFormat
+                );
+            }
+
+            result[key] = normalizedProperty as unknown as Property;
+        } else {
+            result[key] = property;
+        }
+    });
+    return result;
+}

package/src/utils/database.ts

@@ -0,0 +1,39 @@
+import { FirebaseApp } from "@firebase/app";
+import {
+    collection,
+    getDocs,
+    getFirestore,
+    limit as limitClause,
+    query,
+    QueryDocumentSnapshot
+} from "@firebase/firestore";
+
+export async function getFirestoreDataInPath(firebaseApp: FirebaseApp, path: string, parentPaths: string[], limit: number): Promise<object[]> {
+    const firestore = getFirestore(firebaseApp);
+    if (!parentPaths || parentPaths.length === 0) {
+        const q = query(collection(firestore, path), limitClause(limit));
+        return getDocs(q).then((querySnapshot) => {
+            return querySnapshot.docs.map(doc => doc.data());
+        });
+    } else {
+        let currentDocs: QueryDocumentSnapshot[] | undefined = undefined;
+        let index = 0;
+        const allPaths = parentPaths;
+        allPaths.push(path);
+        let parentPath: string | undefined = allPaths[0];
+        while (parentPath) {
+            if (currentDocs) {
+                currentDocs = (await Promise.all(currentDocs.map(async (doc) => {
+                    const q = query(collection(firestore, doc.ref.path, parentPath as string), limitClause(5));
+                    return (await getDocs(q)).docs;
+                }))).flat();
+            } else {
+                const q = query(collection(firestore, parentPath), limitClause(5));
+                currentDocs = (await getDocs(q)).docs;
+            }
+            index++;
+            parentPath = index < allPaths.length ? allPaths[index] : undefined;
+        }
+        return currentDocs ? currentDocs.map(doc => doc.data()) : [];
+    }
+}

package/src/utils/index.ts

@@ -0,0 +1,7 @@
+export * from "./collections_firestore";
+export * from "./database";
+export * from "./algolia";
+export * from "./pinecone";
+export * from "./text_search_controller";
+export * from "./local_text_search_controller";
+export * from "./rebase_search_controller";