Table.hs 4.69 KB
{-# LANGUAGE TypeOperators   #-}

module Gargantext.API.Routes.Named.Table (
  -- * Routes types
    TableAPI(..)
  , TableNgramsAPI(..)
  , TableNgramsApiGet(..)
  , TableNgramsApiPut(..)
  , RecomputeScoresNgramsApiGet(..)
  , TableNgramsApiGetVersion(..)
  , TableNgramsAsyncAPI(..)

  -- * API types (appears in the routes)

  , TableQuery(..)
  , FacetTableResult
  ) where

import Data.Text (Text)
import GHC.Generics (Generic)
import Gargantext.API.HashedResponse (HashedResponse)
import Gargantext.API.Ngrams.Types (TabType(..), UpdateTableNgramsCharts, Version, QueryParamR, Versioned, VersionedWithCount, NgramsTable, NgramsTablePatch)
import Gargantext.API.Ngrams.Types qualified as Ngrams
import Gargantext.API.Worker (WorkerAPI)
import Gargantext.API.Table.Types ( TableQuery(..), FacetTableResult )
import Gargantext.Core.Text.Corpus.Query (RawQuery)
import Gargantext.Core.Types.Main (ListType)
import Gargantext.Core.Types.Query (Limit, MinSize, MaxSize, Offset)
import Gargantext.Database.Admin.Types.Node (ListId)
import Gargantext.Database.Query.Facet.Types qualified as Facet
import Prelude
import Servant


data TableAPI mode = TableAPI
  { getTableEp   :: mode :- Summary "Table API"
                         :> QueryParam "tabType" TabType
                         :> QueryParam "limit" Limit
                         :> QueryParam "offset" Offset
                         :> QueryParam "orderBy" Facet.OrderBy
                         :> QueryParam "query" RawQuery
                         :> QueryParam "year" Text
                         :> Get    '[JSON] (HashedResponse FacetTableResult)
  , postTableEp :: mode :- Summary "Table API (POST)"
                        :> ReqBody '[JSON] TableQuery
                        :> Post    '[JSON] FacetTableResult
  , hashTableEp :: mode :- "hash"
                        :> Summary "Hash Table"
                        :> QueryParam "tabType" TabType
                        :> Get '[JSON] Text
  } deriving Generic


data TableNgramsAPI mode = TableNgramsAPI
  { tableNgramsGetAPI       :: mode :- NamedRoutes TableNgramsApiGet
  , tableNgramsPutAPI       :: mode :- NamedRoutes TableNgramsApiPut
  , recomputeScoresEp       :: mode :- NamedRoutes RecomputeScoresNgramsApiGet
  , tableNgramsGetVersionEp :: mode :- "version" :> NamedRoutes TableNgramsApiGetVersion
  , tableNgramsAsyncAPI     :: mode :- NamedRoutes TableNgramsAsyncAPI
  } deriving Generic


newtype TableNgramsApiGet mode = TableNgramsApiGet
  { getNgramsTableEp :: mode :- Summary " Table Ngrams API Get"
                             :> QueryParamR "ngramsType"  TabType
                             :> QueryParamR "list"        ListId
                             :> QueryParamR "limit"       Limit
                             :> QueryParam  "offset"      Offset
                             :> QueryParam  "listType"    ListType
                             :> QueryParam  "minTermSize" MinSize
                             :> QueryParam  "maxTermSize" MaxSize
                             :> QueryParam  "orderBy"     Ngrams.OrderBy
                             :> QueryParam  "search"      Text
                             :> Get    '[JSON] (VersionedWithCount NgramsTable)
  } deriving Generic


newtype TableNgramsApiPut mode = TableNgramsApiPut
  { putNgramsTableEp :: mode :- Summary " Table Ngrams API Change"
                             :> QueryParamR "ngramsType" TabType
                             :> QueryParamR "list"       ListId
                             :> ReqBody '[JSON] (Versioned NgramsTablePatch)
                             :> Put     '[JSON] (Versioned NgramsTablePatch)
  } deriving Generic


newtype RecomputeScoresNgramsApiGet mode = RecomputeScoresNgramsApiGet
  { recomputeNgramsEp :: mode :- Summary " Recompute scores for ngrams table"
                              :> QueryParamR "ngramsType"  TabType
                              :> QueryParamR "list"        ListId
                              :> "recompute" :> Post '[JSON] Int
  } deriving Generic


newtype TableNgramsApiGetVersion mode = TableNgramsApiGetVersion
  { getTableNgramsVersion :: mode :- Summary " Table Ngrams API Get Version"
                                  :> QueryParamR "ngramsType"  TabType
                                  :> QueryParamR "list"        ListId
                                  :> Get    '[JSON] Version
  } deriving Generic


data TableNgramsAsyncAPI mode = TableNgramsAsyncAPI
  { updateTableNgramsChartsEp :: mode :- Summary "Table Ngrams Async API"
                                      :> "async"
                                      :> "charts"
                                      :> "update"
                                      :> NamedRoutes (WorkerAPI '[JSON] UpdateTableNgramsCharts)
  } deriving Generic