feat: adds dashboard search support

CHANGELOG.md

@@ -7,6 +7,10 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+## [2.22.0] - 2023-03-30
+
+- Adds Support for Dashboard Search 
+
 ## [2.21.0] - 2023-03-27
 
 - Introduce TOTP Recipe plugin interface

build.gradle

@@ -2,7 +2,7 @@ plugins {
     id 'java-library'
 }
 
-version = "2.21.0"
+version = "2.22.0"
 
 repositories {
     mavenCentral()

src/main/java/io/supertokens/pluginInterface/authRecipe/AuthRecipeStorage.java

@@ -19,6 +19,7 @@
 
 import io.supertokens.pluginInterface.RECIPE_ID;
 import io.supertokens.pluginInterface.Storage;
+import io.supertokens.pluginInterface.dashboard.DashboardSearchTags;
 import io.supertokens.pluginInterface.exceptions.StorageQueryException;
 
 import javax.annotation.Nonnull;
@@ -29,7 +30,7 @@ public interface AuthRecipeStorage extends Storage {
     long getUsersCount(@Nullable RECIPE_ID[] includeRecipeIds) throws StorageQueryException;
 
     AuthRecipeUserInfo[] getUsers(@Nonnull Integer limit, @Nonnull String timeJoinedOrder,
-            @Nullable RECIPE_ID[] includeRecipeIds, @Nullable String userId, @Nullable Long timeJoined)
+            @Nullable RECIPE_ID[] includeRecipeIds, @Nullable String userId, @Nullable Long timeJoined, @Nullable DashboardSearchTags dashboardSearchTags)
             throws StorageQueryException;
 
     boolean doesUserIdExist(String userId) throws StorageQueryException;

src/main/java/io/supertokens/pluginInterface/dashboard/DashboardSearchTags.java

@@ -0,0 +1,96 @@
+package io.supertokens.pluginInterface.dashboard;
+
+import java.util.ArrayList;
+
+import javax.annotation.Nullable;
+
+public class DashboardSearchTags {
+
+    public ArrayList<String> emails;
+    public ArrayList<String> phoneNumbers;
+    public ArrayList<String> providers;
+
+    public DashboardSearchTags(@Nullable ArrayList<String> emails, @Nullable ArrayList<String> phones,
+            @Nullable ArrayList<String> providers) {
+        this.emails = emails;
+        this.phoneNumbers = phones;
+        this.providers = providers;
+    }
+
+    public boolean shouldEmailPasswordTableBeSearched() {
+
+        ArrayList<SUPPORTED_SEARCH_TAGS> nonNullSearchTags = getNonNullSearchFields();
+        return nonNullSearchTags.contains(SUPPORTED_SEARCH_TAGS.EMAIL) && nonNullSearchTags.size() == 1;
+
+    }
+
+    public boolean shouldThirdPartyTableBeSearched() {
+
+        ArrayList<SUPPORTED_SEARCH_TAGS> nonNullSearchTags = getNonNullSearchFields();
+        if(nonNullSearchTags.contains(SUPPORTED_SEARCH_TAGS.EMAIL) && nonNullSearchTags.contains(SUPPORTED_SEARCH_TAGS.PROVIDER)){
+            return nonNullSearchTags.size() == 2;
+        }
+
+        if(nonNullSearchTags.contains(SUPPORTED_SEARCH_TAGS.EMAIL) || nonNullSearchTags.contains(SUPPORTED_SEARCH_TAGS.PROVIDER)){
+            return nonNullSearchTags.size() == 1;
+        }
+
+        return false;
+    }
+
+    public boolean shouldPasswordlessTableBeSearched() {
+        ArrayList<SUPPORTED_SEARCH_TAGS> nonNullSearchTags = getNonNullSearchFields();
+        if(nonNullSearchTags.contains(SUPPORTED_SEARCH_TAGS.EMAIL) && nonNullSearchTags.contains(SUPPORTED_SEARCH_TAGS.PHONE)){
+            return nonNullSearchTags.size() == 2;
+        }
+
+        if(nonNullSearchTags.contains(SUPPORTED_SEARCH_TAGS.EMAIL) || nonNullSearchTags.contains(SUPPORTED_SEARCH_TAGS.PHONE)){
+            return nonNullSearchTags.size() == 1;
+        }
+
+        return false;
+    }
+
+    private ArrayList<SUPPORTED_SEARCH_TAGS> getNonNullSearchFields() {
+        ArrayList<SUPPORTED_SEARCH_TAGS> nonNullSearchTags = new ArrayList<>();
+
+        if (this.emails != null) {
+            nonNullSearchTags.add(SUPPORTED_SEARCH_TAGS.EMAIL);
+        }
+
+        if (this.phoneNumbers != null) {
+            nonNullSearchTags.add(SUPPORTED_SEARCH_TAGS.PHONE);
+        }
+
+        if (this.providers != null) {
+            nonNullSearchTags.add(SUPPORTED_SEARCH_TAGS.PROVIDER);
+        }
+
+        return nonNullSearchTags;
+    }
+
+    public enum SUPPORTED_SEARCH_TAGS {
+        EMAIL("email"), PHONE("phone"), PROVIDER("provider");
+
+        private String tag;
+
+        SUPPORTED_SEARCH_TAGS(String tag) {
+            this.tag = tag;
+        }
+
+        public static SUPPORTED_SEARCH_TAGS fromString(String text) {
+            for (SUPPORTED_SEARCH_TAGS t : SUPPORTED_SEARCH_TAGS.values()) {
+                if (t.tag.equalsIgnoreCase(text)) {
+                    return t;
+                }
+            }
+            return null;
+        }
+
+        @Override
+        public String toString() {
+            return tag;
+        }
+    }
+
+}