feat(small): add searchProperty option for resource to allow custom property search.

Author: ulion

src/backend/actions/search/search-action.ts

@@ -31,10 +31,12 @@ export const SearchAction: Action<SearchActionResponse> = {
     const { query } = request
 
     const decorated = resource.decorate()
-    const titlePropertyName = request.query?.searchProperty ?? decorated.titleProperty().name()
+    const titlePropertyName = request.query?.searchProperty ?? decorated.searchProperty().name()
 
     const {
-      sortBy = decorated.options?.sort?.sortBy || titlePropertyName,
+      sortBy = decorated.options?.sort?.sortBy
+        || request.query?.searchProperty
+        || decorated.titleProperty().name(),
       direction = 'asc',
       filters: customFilters = {},
       perPage = 50,

src/backend/decorators/resource/resource-decorator.ts

@@ -267,6 +267,17 @@ class ResourceDecorator {
     return record.get(this.titleProperty().name()) as string
   }
 
+  /**
+   * Returns PropertyDecorator of a property which should be used to search.
+   * If searchProperty not set, use titleProperty as fallback
+   *
+   * @return  {PropertyDecorator} PropertyDecorator of search property
+   */
+  searchProperty(): PropertyDecorator {
+    return (this.options.searchProperty && this.getPropertyByKey(this.options.searchProperty))
+      || this.titleProperty()
+  }
+
   getHref(currentAdmin?: CurrentAdmin): string | null {
     const { href } = this.options
     if (href) {

src/backend/decorators/resource/resource-options.interface.ts

@@ -105,6 +105,10 @@ export interface ResourceOptions {
     direction: 'asc' | 'desc';
     sortBy: string;
   };
+  /**
+   * Property which should be used to search
+   */
+  searchProperty?: string;
   /**
    * List of properties along with their options
    */

src/backend/utils/build-feature/build-feature.ts

@@ -29,7 +29,7 @@ function mergeActionHooks<T>(
   return hooks.length ? { [key]: hooks } : {}
 }
 
-const basicOptions = ['id', 'href', 'parent', 'sort', 'navigation'] as const
+const basicOptions = ['id', 'href', 'parent', 'sort', 'navigation', 'searchProperty'] as const
 const listOptions = [
   'listProperties', 'showProperties', 'editProperties', 'filterProperties',
 ] as const