@rebasepro/client-firebase 0.7.0 → 0.9.0

package/src/types/text_search.ts

@@ -1,6 +1,6 @@
 import { User as FirebaseUser } from "@firebase/auth";
 import { FirebaseApp } from "@firebase/app";
-import { EntityCollection } from "@rebasepro/types";
+import { CollectionConfig } from "@rebasepro/types";
 
 export type FirestoreTextSearchControllerBuilder = (props: {
     firebaseApp: FirebaseApp;
@@ -25,7 +25,7 @@ export type FirestoreTextSearchController = {
     init: (props: {
         path: string,
         databaseId?: string,
-        collection?: EntityCollection
+        collection?: CollectionConfig
     }) => Promise<boolean>,
     /**
      * Do the search and return a list of ids.
@@ -36,7 +36,7 @@ export type FirestoreTextSearchController = {
         path: string,
         currentUser?: FirebaseUser,
         databaseId?: string,
-        collection?: EntityCollection
+        collection?: CollectionConfig
     }) => (Promise<readonly string[] | undefined>),
 
 };

package/src/utils/collections_firestore.ts

@@ -1,5 +1,5 @@
 import { deleteField, DocumentSnapshot } from "@firebase/firestore";
-import { EntityCollection, FirebaseCollection, Properties, Property } from "@rebasepro/types";
+import { CollectionConfig, FirebaseCollectionConfig, Properties, Property } from "@rebasepro/types";
 import { COLLECTION_PATH_SEPARATOR, sortProperties, stripCollectionPath } from "@rebasepro/common";
 
 export function buildCollectionId(idOrPath: string, parentCollectionSlugs?: string[], parentEntityIds?: string[]): string {
@@ -9,7 +9,7 @@ export function buildCollectionId(idOrPath: string, parentCollectionSlugs?: stri
 }
 
 
-export const docsToCollectionTree = (docs: DocumentSnapshot[]): EntityCollection[] => {
+export const docsToCollectionTree = (docs: DocumentSnapshot[]): CollectionConfig[] => {
 
     const collectionsMap = docs.map((doc) => {
         const id: string = doc.id;
@@ -26,7 +26,7 @@ export const docsToCollectionTree = (docs: DocumentSnapshot[]): EntityCollection
             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];
+                (parentCollection as FirebaseCollectionConfig).subcollections = () => [...((parentCollection as FirebaseCollectionConfig).subcollections?.() ?? []), collection];
             delete collectionsMap[id];
         }
     });
@@ -34,7 +34,7 @@ export const docsToCollectionTree = (docs: DocumentSnapshot[]): EntityCollection
     return Object.values(collectionsMap);
 }
 
-export const docToCollection = (doc: DocumentSnapshot): EntityCollection => {
+export const docToCollection = (doc: DocumentSnapshot): CollectionConfig => {
     const data = doc.data();
     if (!data)
         throw Error("Entity collection has not been persisted correctly");
@@ -48,7 +48,7 @@ export const docToCollection = (doc: DocumentSnapshot): EntityCollection => {
         ...data,
         properties: sortedProperties,
         slug: data.id ?? data.alias ?? data.slug
-    } as EntityCollection;
+    } as CollectionConfig;
 }
 
 

package/src/utils/database.ts

@@ -12,8 +12,8 @@ export async function getFirestoreDataInPath(firebaseApp: FirebaseApp, path: str
     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());
+        return getDocs(q).then((queryEntity) => {
+            return queryEntity.docs.map(doc => doc.data());
         });
     } else {
         let currentDocs: QueryDocumentSnapshot[] | undefined = undefined;

package/src/utils/local_text_search_controller.ts

@@ -2,7 +2,7 @@ import { collection, getFirestore, onSnapshot, query } from "@firebase/firestore
 import Fuse from "fuse.js"
 
 import { FirebaseApp } from "@firebase/app";
-import { EntityCollection } from "@rebasepro/types";
+import { CollectionConfig } from "@rebasepro/types";
 import { FirestoreTextSearchController, FirestoreTextSearchControllerBuilder } from "../types";
 
 const MAX_SEARCH_RESULTS = 80;
@@ -32,7 +32,7 @@ export const localSearchControllerBuilder: FirestoreTextSearchControllerBuilder
         databaseId
     }: {
         path: string,
-        collection?: EntityCollection,
+        collection?: CollectionConfig,
         databaseId?: string
     }): Promise<boolean> => {
 
@@ -49,11 +49,11 @@ export const localSearchControllerBuilder: FirestoreTextSearchControllerBuilder
                 const col = collection(firestore, path);
                 listeners[path] = onSnapshot(query(col),
                     {
-                        next: (snapshot) => {
-                            if (snapshot.metadata.fromCache && snapshot.metadata.hasPendingWrites) {
+                        next: (entity) => {
+                            if (entity.metadata.fromCache && entity.metadata.hasPendingWrites) {
                                 return;
                             }
-                            const docs = snapshot.docs.map(doc => ({
+                            const docs = entity.docs.map(doc => ({
                                 id: doc.id,
                                 ...doc.data()
                             }));
@@ -112,7 +112,7 @@ export const localSearchControllerBuilder: FirestoreTextSearchControllerBuilder
     }
 }
 
-function buildIndex(list: (object & { id: string })[], collection: EntityCollection) {
+function buildIndex(list: (object & { id: string })[], collection: CollectionConfig) {
 
     const keys = ["id", ...Object.keys(collection.properties)];
 

package/src/utils/pinecone.ts

@@ -1,6 +1,6 @@
 import { User as FirebaseUser } from "@firebase/auth";
 import { FirestoreTextSearchController, FirestoreTextSearchControllerBuilder } from "../types";
-import { EntityCollection } from "@rebasepro/types";
+import { CollectionConfig } from "@rebasepro/types";
 
 const DEFAULT_SERVER = "https://api.rebase.pro";
 
@@ -60,7 +60,7 @@ export function buildPineconeSearchController({
 
         const init = (props: {
             path: string,
-            collection?: EntityCollection
+            collection?: CollectionConfig
         }) => {
             // do nothing
             return Promise.resolve(isPathSupported(props.path));

package/src/utils/rebase_search_controller.ts

@@ -1,7 +1,7 @@
 import { FirestoreTextSearchController, FirestoreTextSearchControllerBuilder } from "../types";
 import { FirebaseApp } from "@firebase/app";
 import { getFunctions, httpsCallable } from "@firebase/functions";
-import { EntityCollection } from "@rebasepro/types";
+import { CollectionConfig } from "@rebasepro/types";
 
 /**
  * Configuration returned by the Rebase Search Extension
@@ -204,7 +204,7 @@ export function buildRebaseSearchController(
          */
         const init = async (props: {
             path: string;
-            collection?: EntityCollection;
+            collection?: CollectionConfig;
             databaseId?: string;
         }): Promise<boolean> => {
             try {
@@ -289,7 +289,7 @@ export function buildRebaseSearchController(
             searchString: string;
             path: string;
             databaseId?: string;
-            collection?: EntityCollection;
+            collection?: CollectionConfig;
         }): Promise<readonly string[] | undefined> => {
             if (!typesenseClient) {
                 // Ensure client is initialized

package/src/utils/text_search_controller.ts

@@ -1,5 +1,5 @@
 import { FirestoreTextSearchController, FirestoreTextSearchControllerBuilder } from "../types";
-import { EntityCollection } from "@rebasepro/types";
+import { CollectionConfig } from "@rebasepro/types";
 
 /**
  * Utility function to perform a text search in an external index,
@@ -20,7 +20,7 @@ export function buildExternalSearchController({
 
         const init = (props: {
             path: string,
-            collection?: EntityCollection
+            collection?: CollectionConfig
         }) => {
             return Promise.resolve(isPathSupported(props.path));
         }