Update the search API

src/Gargantext/API.hs

@@ -73,11 +73,10 @@ import Gargantext.API.Count  ( CountAPI, count, Query)
 import Gargantext.API.FrontEnd (FrontEndAPI, frontEndServer)
 import Gargantext.API.Ngrams (HasRepo(..), HasRepoSaver(..), saveRepo, TableNgramsApi, apiNgramsTableDoc)
 import Gargantext.API.Node
-import Gargantext.API.Search ( SearchAPI, search, SearchQuery)
+import Gargantext.API.Search (SearchPairsAPI, searchPairs)
 import Gargantext.API.Types
 import qualified Gargantext.API.Corpus.New as New
 import Gargantext.Core.Types (HasInvalidError(..))
-import Gargantext.Database.Facet
 import Gargantext.Database.Schema.Node (HasNodeError(..), NodeError)
 import Gargantext.Database.Tree (HasTreeError(..), TreeError)
 import Gargantext.Database.Types.Node
@@ -263,12 +262,7 @@ type GargAPI' =
                         :> ReqBody '[JSON] Query :> CountAPI
            
            -- Corpus endpoint --> TODO rename s/search/filter/g
-           :<|> "search":> Summary "Search endpoint"
-                        :> ReqBody '[JSON] SearchQuery 
-                        :> QueryParam "offset" Int
-                        :> QueryParam "limit"  Int
-                        :> QueryParam "order"  OrderBy
-                        :> SearchAPI
+           :<|> "search":> Capture "corpus" NodeId :> SearchPairsAPI
 
            -- TODO move to NodeAPI?
            :<|> "graph" :> Summary "Graph endpoint"
@@ -320,7 +314,7 @@ serverGargAPI -- orchestrator
      :<|> apiNgramsTableDoc
      :<|> nodesAPI
      :<|> count -- TODO: undefined
-     :<|> search
+     :<|> searchPairs -- TODO: move elsewhere
      :<|> graphAPI -- TODO: mock
      :<|> treeAPI
      :<|> New.api

src/Gargantext/API/Node.hs

@@ -51,7 +51,7 @@ import GHC.Generics (Generic)
 import Gargantext.API.Metrics
 import Gargantext.API.Ngrams (TabType(..), TableNgramsApi, apiNgramsTableCorpus, QueryParamR, TODO)
 import Gargantext.API.Ngrams.NTree (MyTree)
-import Gargantext.API.Search ( SearchAPI, searchIn, SearchInQuery)
+import Gargantext.API.Search (SearchDocsAPI, searchDocs)
 import Gargantext.API.Types
 import Gargantext.Core.Types (Offset, Limit)
 import Gargantext.Core.Types.Main (Tree, NodeTree, ListType)
@@ -133,12 +133,7 @@ type NodeAPI a = Get '[JSON] (Node a)
 
              :<|> "favorites" :> FavApi
              :<|> "documents" :> DocsApi
-             :<|> "search":> Summary "Node Search"
-                        :> ReqBody '[JSON] SearchInQuery
-                        :> QueryParam "offset" Int
-                        :> QueryParam "limit"  Int
-                        :> QueryParam "order"  OrderBy
-                        :> SearchAPI
+             :<|> "search"    :> SearchDocsAPI
 
              -- VIZ
              :<|> "metrics" :> ScatterAPI
@@ -182,8 +177,7 @@ nodeAPI p uId id
            
            :<|> favApi   id
            :<|> delDocs  id
-           :<|> searchIn id
-           
+           :<|> searchDocs id
            :<|> getScatter id
            :<|> getChart id
            :<|> getPie   id

src/Gargantext/API/Search.hs

@@ -33,54 +33,50 @@ import Servant
 import Test.QuickCheck.Arbitrary
 import Test.QuickCheck (elements)
 -- import Control.Applicative ((<*>))
+import Gargantext.API.Types (GargServer)
 import Gargantext.Prelude
 import Gargantext.Core.Utils.Prefix (unPrefix)
-import Gargantext.Core.Types.Main (Offset, Limit)
 import Gargantext.Database.Types.Node
 import Gargantext.Database.TextSearch
 import Gargantext.Database.Facet
-import Gargantext.Database.Utils (Cmd)
 
 -----------------------------------------------------------------------
--- | SearchIn [NodesId] if empty then global search
--- TODO [Int]
-data SearchQuery = SearchQuery { sq_query :: [Text]
-                               , sq_corpus_id :: NodeId
+data SearchQuery = SearchQuery
+  { sq_query :: [Text]
   } deriving (Generic)
+
 $(deriveJSON (unPrefix "sq_") ''SearchQuery)
+
 instance ToSchema SearchQuery where
   declareNamedSchema =
     genericDeclareNamedSchema
-      defaultSchemaOptions {fieldLabelModifier = \fieldLabel -> drop 3 fieldLabel}
+      defaultSchemaOptions {fieldLabelModifier = drop 3}
 
 instance Arbitrary SearchQuery where
-  arbitrary = elements [SearchQuery ["electrodes"] 472764]
-
---
+  arbitrary = elements [SearchQuery ["electrodes"]]
 
-data SearchInQuery = SearchInQuery { siq_query :: [Text]
-                               } deriving (Generic)
-$(deriveJSON (unPrefix "siq_") ''SearchInQuery)
-instance ToSchema SearchInQuery where
-  declareNamedSchema =
-    genericDeclareNamedSchema
-      defaultSchemaOptions {fieldLabelModifier = \fieldLabel -> drop 4 fieldLabel}
+-----------------------------------------------------------------------
 
-instance Arbitrary SearchInQuery where
-  arbitrary = SearchInQuery <$> arbitrary
+data SearchDocResults = SearchDocResults { sdr_results :: [FacetDoc]}
+  deriving (Generic)
+$(deriveJSON (unPrefix "sdr_") ''SearchDocResults)
 
+instance Arbitrary SearchDocResults where
+  arbitrary = SearchDocResults <$> arbitrary
 
------------------------------------------------------------------------
+instance ToSchema SearchDocResults where
+  declareNamedSchema =
+    genericDeclareNamedSchema
+      defaultSchemaOptions {fieldLabelModifier = drop 4}
 
-data SearchResults = SearchResults' { srs_resultsP :: [FacetDoc]}
-                   | SearchResults  { srs_results :: [FacetPaired Int UTCTime HyperdataDocument Int [Pair Int Text]]}
+data SearchPairedResults = SearchPairedResults { spr_results :: [FacetPaired Int UTCTime HyperdataDocument Int [Pair Int Text]] }
   deriving (Generic)
-$(deriveJSON (unPrefix "srs_") ''SearchResults)
+$(deriveJSON (unPrefix "spr_") ''SearchPairedResults)
 
-instance Arbitrary SearchResults where
-  arbitrary = SearchResults <$> arbitrary
+instance Arbitrary SearchPairedResults where
+  arbitrary = SearchPairedResults <$> arbitrary
 
-instance ToSchema SearchResults where
+instance ToSchema SearchPairedResults where
   declareNamedSchema =
     genericDeclareNamedSchema
       defaultSchemaOptions {fieldLabelModifier = \fieldLabel -> drop 4 fieldLabel}
@@ -88,16 +84,25 @@ instance ToSchema SearchResults where
 -----------------------------------------------------------------------
 -- TODO-ACCESS: CanSearch? or is it part of CanGetNode
 -- TODO-EVENTS: No event, this is a read-only query.
-type SearchAPI = Post '[JSON] SearchResults
+type SearchAPI results
+  = Summary "Search endpoint"
+ :> ReqBody '[JSON] SearchQuery
+ :> QueryParam "offset" Int
+ :> QueryParam "limit"  Int
+ :> QueryParam "order"  OrderBy
+ :> Post '[JSON] results
+
+type SearchDocsAPI  = SearchAPI SearchDocResults
+type SearchPairsAPI = SearchAPI SearchPairedResults
 -----------------------------------------------------------------------
 
-search :: SearchQuery -> Maybe Offset -> Maybe Limit -> Maybe OrderBy -> Cmd err SearchResults
-search (SearchQuery q pId) o l order =
-  SearchResults <$> searchInCorpusWithContacts pId q o l order
+searchPairs :: NodeId -> GargServer SearchPairsAPI
+searchPairs pId (SearchQuery q) o l order =
+  SearchPairedResults <$> searchInCorpusWithContacts pId q o l order
 
-searchIn :: NodeId -> SearchInQuery -> Maybe Offset -> Maybe Limit -> Maybe OrderBy -> Cmd err SearchResults
-searchIn nId (SearchInQuery q ) o l order =
-  SearchResults' <$> searchInCorpus nId q o l order
+searchDocs :: NodeId -> GargServer SearchDocsAPI
+searchDocs nId (SearchQuery q) o l order =
+  SearchDocResults <$> searchInCorpus nId q o l order
   --SearchResults <$> searchInCorpusWithContacts nId q o l order