filter enhancements

tools/search/simple_field_resolver.go

@@ -8,6 +8,25 @@ import (
 	"github.com/pocketbase/pocketbase/tools/list"
 )
 
+// ResolverResult defines a single FieldResolver.Resolve() successfully parsed result.
+type ResolverResult struct {
+	// Identifier is the plain SQL identifier/column that will be used
+	// in the final db expression as left or right operand.
+	Identifier string
+
+	// Params is a map with db placeholder->value pairs that will be added
+	// to the query when building both resolved operands/sides in a single expression.
+	Params dbx.Params
+
+	// MultiMatchSubQuery is an optional sub query expression that will be added
+	// in addition to the combined ResolverResult expression during build.
+	MultiMatchSubQuery dbx.Expression
+
+	// AfterBuild is an optional function that will be called after building
+	// and combining the result of both resolved operands/sides in a single expression.
+	AfterBuild func(expr dbx.Expression) dbx.Expression
+}
+
 // FieldResolver defines an interface for managing search fields.
 type FieldResolver interface {
 	// UpdateQuery allows to updated the provided db query based on the
@@ -18,7 +37,7 @@ type FieldResolver interface {
 
 	// Resolve parses the provided field and returns a properly
 	// formatted db identifier (eg. NULL, quoted column, placeholder parameter, etc.).
-	Resolve(field string) (name string, placeholderParams dbx.Params, err error)
+	Resolve(field string) (*ResolverResult, error)
 }
 
 // NewSimpleFieldResolver creates a new `SimpleFieldResolver` with the
@@ -49,10 +68,12 @@ func (r *SimpleFieldResolver) UpdateQuery(query *dbx.SelectQuery) error {
 // Resolve implements `search.Resolve` interface.
 //
 // Returns error if `field` is not in `r.allowedFields`.
-func (r *SimpleFieldResolver) Resolve(field string) (resultName string, placeholderParams dbx.Params, err error) {
+func (r *SimpleFieldResolver) Resolve(field string) (*ResolverResult, error) {
 	if !list.ExistInSliceWithRegex(field, r.allowedFields) {
-		return "", nil, fmt.Errorf("Failed to resolve field %q.", field)
+		return nil, fmt.Errorf("Failed to resolve field %q.", field)
 	}
 
-	return fmt.Sprintf("[[%s]]", inflector.Columnify(field)), nil, nil
+	return &ResolverResult{
+		Identifier: "[[" + inflector.Columnify(field) + "]]",
+	}, nil
 }