@firecms/core 3.0.0-canary.59 → 3.0.0-canary.60

package/dist/types/datasource.d.ts

@@ -1,6 +1,7 @@
 import { Entity, EntityStatus, EntityValues } from "./entities";
 import { EntityCollection, FilterValues } from "./collections";
 import { ResolvedEntityCollection } from "./resolved_entities";
+import { FireCMSContext } from "./firecms_context";
 /**
  * @group Datasource
  */
@@ -145,6 +146,17 @@ export interface DataSource {
      * @param props
      */
     isFilterCombinationValid?(props: FilterCombinationValidProps): boolean;
+    /**
+     * Called when the user clicks on the search bar in a collection view.
+     * Useful for initializing a text search index.
+     * @param props
+     */
+    initTextSearch?: (props: {
+        context: FireCMSContext;
+        path: string;
+        collection: EntityCollection;
+        parentCollectionIds?: string[];
+    }) => Promise<boolean>;
 }
 export type FilterCombinationValidProps = {
     path: string;
@@ -241,14 +253,6 @@ export interface DataSourceDelegate {
      * @param props
      */
     isFilterCombinationValid?(props: Omit<FilterCombinationValidProps, "collection">): boolean;
-    /**
-     * Convert a FireCMS reference to a reference that can be used by the datasource
-     * @param reference
-     */
-    /**
-     * Convert a FireCMS GeoPoint to a GeoPoint that can be used by the datasource
-     * @param geoPoint
-     */
     /**
      * Get the object to generate the current time in the datasource
      */
@@ -256,4 +260,10 @@ export interface DataSourceDelegate {
     delegateToCMSModel: (data: any) => any;
     cmsToDelegateModel: (data: any) => any;
     setDateToMidnight: (input?: any) => any;
+    initTextSearch?: (props: {
+        context: FireCMSContext;
+        path: string;
+        collection: EntityCollection;
+        parentCollectionIds?: string[];
+    }) => Promise<boolean>;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@firecms/core",
     "type": "module",
-    "version": "3.0.0-canary.59",
+    "version": "3.0.0-canary.60",
     "description": "Awesome Firebase/Firestore-based headless open-source CMS",
     "funding": {
         "url": "https://github.com/sponsors/firecmsco"
@@ -46,8 +46,8 @@
         "./package.json": "./package.json"
     },
     "dependencies": {
-        "@firecms/formex": "^3.0.0-canary.59",
-        "@firecms/ui": "^3.0.0-canary.59",
+        "@firecms/formex": "^3.0.0-canary.60",
+        "@firecms/ui": "^3.0.0-canary.60",
         "@fontsource/jetbrains-mono": "^5.0.20",
         "@hello-pangea/dnd": "^16.6.0",
         "@radix-ui/react-portal": "^1.0.4",
@@ -111,7 +111,7 @@
         "dist",
         "src"
     ],
-    "gitHead": "870435eb903576cd282b2c22165ec3afa84c9340",
+    "gitHead": "b93bb64369b81ae43a6e0e0ae4748a818af6d7ae",
     "publishConfig": {
         "access": "public"
     },

package/src/components/common/useTableSearchHelper.ts

@@ -1,7 +1,7 @@
 import { useState } from "react";
 
 import { EntityCollection } from "../../types";
-import { useCustomizationController, useFireCMSContext } from "../../hooks";
+import { useCustomizationController, useDataSource, useFireCMSContext } from "../../hooks";
 
 export interface UseTableSearchHelperParams<M extends Record<string, any>> {
     collection: EntityCollection<M>;
@@ -9,27 +9,47 @@ export interface UseTableSearchHelperParams<M extends Record<string, any>> {
     parentCollectionIds?: string[];
 }
 
-export function useTableSearchHelper<M extends Record<string, any>>({ collection, fullPath, parentCollectionIds }: UseTableSearchHelperParams<M>) {
+export function useTableSearchHelper<M extends Record<string, any>>({
+                                                                        collection,
+                                                                        fullPath,
+                                                                        parentCollectionIds
+                                                                    }: UseTableSearchHelperParams<M>) {
 
     const context = useFireCMSContext();
     const customizationController = useCustomizationController();
+    const dataSource = useDataSource();
 
     const [textSearchLoading, setTextSearchLoading] = useState<boolean>(false);
     const [textSearchInitialised, setTextSearchInitialised] = useState<boolean>(false);
     let onTextSearchClick: (() => void) | undefined;
     let textSearchEnabled = Boolean(collection.textSearchEnabled);
     if (customizationController?.plugins) {
-        const addTextSearchClickListener = customizationController.plugins?.find(p => Boolean(p.collectionView?.onTextSearchClick));
+        const addTextSearchClickListener = dataSource?.initTextSearch || customizationController.plugins?.find(p => Boolean(p.collectionView?.onTextSearchClick));
 
         onTextSearchClick = addTextSearchClickListener
             ? () => {
                 setTextSearchLoading(true);
-                Promise.all(customizationController.plugins?.map(p => {
+                const promises: Promise<boolean>[] = [];
+                if (dataSource?.initTextSearch) {
+                    promises.push(dataSource.initTextSearch({
+                        context,
+                        path: fullPath,
+                        collection,
+                        parentCollectionIds
+                    }));
+                }
+                customizationController.plugins?.forEach(p => {
                     if (p.collectionView?.onTextSearchClick)
-                        return p.collectionView.onTextSearchClick({ context, path: fullPath, collection, parentCollectionIds });
+                        promises.push(p.collectionView.onTextSearchClick({
+                            context,
+                            path: fullPath,
+                            collection,
+                            parentCollectionIds
+                        }));
                     return Promise.resolve(true);
-                }) as Promise<boolean>[])
-                    .then((res) => {
+                })
+                return Promise.all(promises)
+                    .then((res: boolean[]) => {
                         if (res.every(Boolean)) setTextSearchInitialised(true);
                     })
                     .finally(() => setTextSearchLoading(false));
@@ -39,9 +59,19 @@ export function useTableSearchHelper<M extends Record<string, any>>({ collection
         customizationController.plugins?.forEach(p => {
             if (!textSearchEnabled)
                 if (p.collectionView?.showTextSearchBar) {
-                    textSearchEnabled = p.collectionView.showTextSearchBar({ context, path: fullPath, collection, parentCollectionIds });
+                    textSearchEnabled = p.collectionView.showTextSearchBar({
+                        context,
+                        path: fullPath,
+                        collection,
+                        parentCollectionIds
+                    });
                 }
         })
     }
-    return { textSearchLoading, textSearchInitialised, onTextSearchClick, textSearchEnabled };
+    return {
+        textSearchLoading,
+        textSearchInitialised,
+        onTextSearchClick,
+        textSearchEnabled
+    };
 }

package/src/internal/useBuildDataSource.ts

@@ -9,6 +9,7 @@ import {
     FetchCollectionProps,
     FetchEntityProps,
     FilterValues,
+    FireCMSContext,
     ListenCollectionProps,
     ListenEntityProps,
     NavigationController,
@@ -313,6 +314,17 @@ export function useBuildDataSource({
             )
         }, [delegate.isFilterCombinationValid]),
 
+        initTextSearch: useCallback(async (props: {
+            context: FireCMSContext,
+            path: string,
+            collection: EntityCollection,
+            parentCollectionIds?: string[]
+        }): Promise<boolean> => {
+            if (!delegate.initTextSearch)
+                return false;
+            return delegate.initTextSearch(props)
+        }, [delegate.initTextSearch]),
+
     };
 
 }

package/src/types/datasource.ts

@@ -1,6 +1,7 @@
 import { Entity, EntityReference, EntityStatus, EntityValues, GeoPoint } from "./entities";
 import { EntityCollection, FilterValues } from "./collections";
 import { ResolvedEntityCollection } from "./resolved_entities";
+import { FireCMSContext } from "./firecms_context";
 
 /**
  * @group Datasource
@@ -217,6 +218,18 @@ export interface DataSource {
      */
     isFilterCombinationValid?(props: FilterCombinationValidProps): boolean;
 
+    /**
+     * Called when the user clicks on the search bar in a collection view.
+     * Useful for initializing a text search index.
+     * @param props
+     */
+    initTextSearch?: (props: {
+        context: FireCMSContext,
+        path: string,
+        collection: EntityCollection,
+        parentCollectionIds?: string[]
+    }) => Promise<boolean>;
+
 }
 
 export type FilterCombinationValidProps = {
@@ -363,30 +376,21 @@ export interface DataSourceDelegate {
      */
     isFilterCombinationValid?(props: Omit<FilterCombinationValidProps, "collection">): boolean;
 
-    /**
-     * Convert a FireCMS reference to a reference that can be used by the datasource
-     * @param reference
-     */
-    // buildReference: (reference: EntityReference) => any,
-
-    /**
-     * Convert a FireCMS GeoPoint to a GeoPoint that can be used by the datasource
-     * @param geoPoint
-     */
-    // buildGeoPoint: (geoPoint: GeoPoint) => any,
-
     /**
      * Get the object to generate the current time in the datasource
      */
     currentTime(): any;
 
-    // buildDate: (date: Date) => any;
-
-    // buildDeleteFieldValue: () => any;
-
     delegateToCMSModel: (data: any) => any;
 
     cmsToDelegateModel: (data: any) => any;
 
     setDateToMidnight: (input?: any) => any;
+
+    initTextSearch?: (props: {
+        context: FireCMSContext,
+        path: string,
+        collection: EntityCollection,
+        parentCollectionIds?: string[]
+    }) => Promise<boolean>;
 }