@cccsaurora/howler-ui 2.14.0-dev.263 → 2.14.0-dev.265

package/api/index.ts

@@ -0,0 +1,301 @@
+import * as action from '@cccsaurora/howler-ui/api/action';
+import * as analytic from '@cccsaurora/howler-ui/api/analytic';
+import * as auth from '@cccsaurora/howler-ui/api/auth';
+import * as configs from '@cccsaurora/howler-ui/api/configs';
+import * as dossier from '@cccsaurora/howler-ui/api/dossier';
+import * as help from '@cccsaurora/howler-ui/api/help';
+import * as hit from '@cccsaurora/howler-ui/api/hit';
+import * as notebook from '@cccsaurora/howler-ui/api/notebook';
+import * as overview from '@cccsaurora/howler-ui/api/overview';
+import * as search from '@cccsaurora/howler-ui/api/search';
+import * as template from '@cccsaurora/howler-ui/api/template';
+import * as user from '@cccsaurora/howler-ui/api/user';
+import * as view from '@cccsaurora/howler-ui/api/view';
+import AxiosClient from '@cccsaurora/howler-ui/rest/AxiosClient';
+import urlJoin from 'url-join';
+import { StorageKey } from '@cccsaurora/howler-ui/utils/constants';
+import {
+  getStored as getLocalStored,
+  removeStored as removeLocalStored,
+  saveLoginCredential,
+  setStored as setLocalStored
+} from '@cccsaurora/howler-ui/utils/localStorage';
+import { getStored as getSessionStored, setStored as setSessionStored } from '@cccsaurora/howler-ui/utils/sessionStorage';
+import getXSRFCookie from '@cccsaurora/howler-ui/utils/xsrf';
+
+/**
+ * Concrete Rest HTTP client implementation.
+ */
+const client = new AxiosClient();
+
+/**
+ * Defining the default export exposing all children routes of '/api/v1/'.
+ */
+// prettier-ignore
+const api = {
+  action,
+  analytic,
+  auth,
+  configs,
+  dossier,
+  help,
+  hit,
+  overview,
+  search,
+  template,
+  user,
+  view,
+  notebook
+};
+
+/**
+ * The specification interface of an Howler HTTP response.
+ */
+export type HowlerResponse<R> = {
+  api_response: R;
+  api_error_message: string;
+  api_server_version: string;
+  api_status_code: number;
+};
+
+/**
+ * The base section of the Howler API uri.
+ *
+ * `/api/v1/`
+ */
+export const uri = () => {
+  return '/api/v1';
+};
+
+/**
+ * Format/Adapt the specified URI to an Howler API uri.
+ *
+ * Ensure it starts with '/api/v1' and doesn't end with a '/'.
+ *
+ * @param _uri - the uri to format.
+ * @returns `string` - properly formatted howler uri.
+ */
+const format = (_uri: string): string => {
+  return _uri.startsWith(uri()) ? _uri : `${uri()}/${_uri.replace(/\/$/, '')}`;
+};
+
+/**
+ * Append series of search parameters to the specified uri.
+ *
+ * @param _uri - the base uri.
+ * @param searchParams  -  a list of search parameters to join with the uri.
+ * @returns a uri with the search parameters.
+ */
+export const joinParams = (_uri: string, searchParams?: URLSearchParams): string => {
+  return `${_uri}${searchParams ? `${_uri.indexOf('?') > 0 ? '&' : '?'}${searchParams.toString()}` : ''}`;
+};
+
+/**
+ * Join two uri and then join them with the specified search parameters.
+ *
+ * This function will format the resulting uri section using {@link format}.
+ *
+ * This function will join the specified parameters using {@link joinParams}
+ *
+ * @param uri1 the first section of the uri.
+ * @param uri2 the second section of the uri.
+ * @param searchParams the search parameters to append to the uri.
+ * @returns a uri that joins `uri1` and `uri2` with the specified `_search` parameters.
+ */
+export const joinUri = (uri1: string, uri2: string, searchParams?: URLSearchParams): string => {
+  const _uri = format(urlJoin(uri1, uri2));
+  return searchParams ? joinParams(_uri, searchParams) : _uri;
+};
+
+/**
+ * joinUrl all params together
+ *
+ * @returns a uri generated from all params
+ */
+export const joinAllUri = (...urlParts: string[]): string => {
+  return urlJoin(...urlParts);
+};
+
+/**
+ * Create the required headers object for attaching to the request
+ *
+ * @param ifMatch a value for the If-Match header
+ */
+export const setHeaders = (ifMatch?: string): HeadersInit => {
+  const headers: HeadersInit = {};
+  if (ifMatch) {
+    headers['If-Match'] = ifMatch;
+  }
+  return headers;
+};
+
+const getEtagUrl = (_uri: string): string => {
+  if (_uri.startsWith('/api/v1/hit')) {
+    return _uri.replace(/.+hit\/(.+?)$/g, '$1').split('/')[0];
+  }
+
+  return _uri;
+};
+
+/**
+ * Generic FETCH implementation for HOWLER API.
+ *
+ * This function will format the specified `url` with {@link format} before issuing the fetch.
+ *
+ * @param _uri - the uri to fetch.
+ * @param method - the http method to use.
+ * @param body - the body of the request.
+ * @returns the `api_response` object of the returned {@link HowlerResponse}.
+ */
+export const hfetch = async <R>(
+  _uri: string,
+  method: 'get' | 'post' | 'put' | 'delete' | 'patch' = 'get',
+  body?: any,
+  searchParams?: URLSearchParams,
+  requestHeaders?: HeadersInit
+): Promise<R> => {
+  const authToken = getLocalStored(StorageKey.APP_TOKEN);
+  const etags = getSessionStored(StorageKey.ETAG) || {};
+  const currentObject = etags[getEtagUrl(_uri)] || null;
+
+  requestHeaders = {
+    ...requestHeaders,
+    ...(currentObject && setHeaders(currentObject)),
+    'Content-Type': 'application/json',
+    'X-XSRF-TOKEN': getXSRFCookie()
+  };
+
+  if (authToken) {
+    requestHeaders = { ...requestHeaders, Authorization: `Bearer ${authToken}` };
+  }
+
+  // Wait for it ....
+  const [json, statusCode, responseHeader] = await client.fetch<R>(
+    format(_uri),
+    method,
+    body,
+    searchParams,
+    requestHeaders
+  );
+
+  if (responseHeader.etag) {
+    setSessionStored(StorageKey.ETAG, { ...etags, [getEtagUrl(_uri)]: responseHeader.etag });
+  }
+
+  if (!json) {
+    return null;
+  }
+
+  // Did it work?
+  if (statusCode < 300 || statusCode === 304) {
+    return json.api_response;
+  }
+
+  if (statusCode === 401) {
+    if (!getLocalStored(StorageKey.NEXT_LOCATION)) {
+      setLocalStored(StorageKey.NEXT_LOCATION, window.location.pathname);
+      setLocalStored(StorageKey.NEXT_SEARCH, window.location.search);
+    }
+
+    if (!_uri.includes('/auth/login') && getLocalStored(StorageKey.REFRESH_TOKEN)) {
+      //Refresh access token if possible
+      //And re-execute the previous api call (seamless)
+      const refreshToken: string = getLocalStored(StorageKey.REFRESH_TOKEN);
+      const provider: string = getLocalStored(StorageKey.PROVIDER);
+      const refreshResponse = await api.auth.login.post({ refresh_token: refreshToken, provider: provider });
+
+      if (refreshResponse) {
+        saveLoginCredential(refreshResponse);
+        const result = await hfetch<R>(_uri, method, body, searchParams);
+
+        removeLocalStored(StorageKey.NEXT_LOCATION);
+        removeLocalStored(StorageKey.NEXT_SEARCH);
+
+        return result;
+      }
+    }
+
+    saveLoginCredential({});
+
+    if (window.location.pathname !== '/login') {
+      window.location.pathname = '/login';
+    }
+    return;
+  }
+
+  // Throw it back.
+  throw new Error(
+    json.api_error_message || (json as unknown as string) || `Error while fetching ${_uri} - ${method.toUpperCase()}`,
+    {
+      cause: json
+    }
+  );
+};
+
+/**
+ * Perform an HTTP GET for the specified uri.
+ *
+ * This method eventually delegates to {@link hfetch}
+ *
+ * @param _uri - the uri to fetch.
+ * @returns the `api_response` object of the returned {@link HowlerResponse}.
+ */
+export const hget = <R = any>(_uri: string, searchParams?: URLSearchParams, headers: HeadersInit = {}): Promise<R> => {
+  return hfetch(_uri, 'get', null, searchParams, headers);
+};
+
+/**
+ * Perform an HTTP POST for the specified uri and body data.
+ *
+ * This method eventually delegates to {@link hfetch}
+ *
+ * @param _uri - the uri to fetch.
+ * @param body - the body of the request.
+ * @returns the `api_response` object of the returned {@link HowlerResponse}.
+ */
+export const hpost = <R = any>(_uri: string, body: any, headers: HeadersInit = {}): Promise<R> => {
+  return hfetch(_uri, 'post', body, undefined, headers);
+};
+
+/**
+ * Peform an HTTP PUT for the specified uri and body data.
+ *
+ * This method eventually delegates to {@link hfetch}
+ *
+ * @param _uri - the uri to fetch.
+ * @param body - the body of the request.
+ * @returns the `api_response` object of the returned {@link HowlerResponse}.
+ */
+export const hput = <R = any>(_uri: string, body: any, headers: HeadersInit = {}): Promise<R> => {
+  return hfetch(_uri, 'put', body, undefined, headers);
+};
+
+/**
+ * Peform an HTTP PATCH for the specified uri and body data.
+ *
+ * This method eventually delegates to {@link hfetch}
+ *
+ * @param _uri - the uri to fetch.
+ * @param body - the body of the request.
+ * @returns the `api_response` object of the returned {@link HowlerResponse}.
+ */
+export const hpatch = <R = any>(_uri: string, body: any, headers: HeadersInit = {}): Promise<R> => {
+  return hfetch(_uri, 'patch', body, undefined, headers);
+};
+
+/**
+ * Performa an HTTP DELETE for the specified uri.
+ *
+ * This method eventually delegates to {@link hfetch}
+ *
+ * @param _uri - the uri to fetch.
+ * @returns the `api_response` object of the returned {@link HowlerResponse}.
+ */
+export const hdelete = <R = any>(_uri: string, body = null, headers: HeadersInit = {}): Promise<R> => {
+  return hfetch(_uri, 'delete', body, undefined, headers);
+};
+
+/**
+ * Default export exposing the howler rest api
+ */
+export default api;

package/api/notebook/environments.ts

@@ -0,0 +1,14 @@
+import { hget, joinUri } from '@cccsaurora/howler-ui/api';
+import { uri as parentUri } from '@cccsaurora/howler-ui/api/notebook';
+
+export type EnvsResponse = {
+  envs: { name: string; url: string; default: boolean; user_interface: string }[];
+};
+
+export const uri = () => {
+  return joinUri(parentUri(), 'environments');
+};
+
+export const get = (): Promise<EnvsResponse> => {
+  return hget(uri());
+};

package/api/notebook/index.ts

@@ -0,0 +1,20 @@
+import { hpost, joinUri, uri as parentUri } from '@cccsaurora/howler-ui/api';
+import type { Analytic } from '@cccsaurora/howler-ui/models/entities/generated/Analytic';
+import type { Hit } from '@cccsaurora/howler-ui/models/entities/generated/Hit';
+
+import * as environments from '@cccsaurora/howler-ui/api/notebook/environments';
+
+export type NotebookResponse = {
+  nb_content: any;
+  name: string;
+};
+
+export const uri = () => {
+  return joinUri(parentUri(), 'notebook');
+};
+
+export const post = (body: { link: string; analytic: Analytic; hit?: Hit }): Promise<NotebookResponse> => {
+  return hpost(joinUri(uri(), 'notebook'), body);
+};
+
+export { environments };

package/api/overview/index.ts

@@ -0,0 +1,22 @@
+import { hdelete, hget, hpost, hput, joinAllUri, joinUri, uri as parentUri } from '@cccsaurora/howler-ui/api';
+import type { Overview } from '@cccsaurora/howler-ui/models/entities/generated/Overview';
+
+export const uri = (id?: string) => {
+  return id ? joinAllUri(parentUri(), 'overview', id) : joinUri(parentUri(), 'overview');
+};
+
+export const get = (): Promise<Overview[]> => {
+  return hget(uri());
+};
+
+export const post = (newData: Partial<Overview>): Promise<Overview> => {
+  return hpost(uri(), newData);
+};
+
+export const put = (id: string, content: string): Promise<Overview> => {
+  return hput(uri(id), { content });
+};
+
+export const del = (id: string): Promise<void> => {
+  return hdelete(uri(id));
+};

package/api/search/action.ts

@@ -0,0 +1,12 @@
+import { hpost, joinUri } from '@cccsaurora/howler-ui/api';
+import type { HowlerSearchRequest, HowlerSearchResponse } from '@cccsaurora/howler-ui/api/search';
+import { uri as parentUri } from '@cccsaurora/howler-ui/api/search';
+import type { Action } from '@cccsaurora/howler-ui/models/entities/generated/Action';
+
+export const uri = () => {
+  return joinUri(parentUri(), 'action');
+};
+
+export const post = (request?: HowlerSearchRequest): Promise<HowlerSearchResponse<Action>> => {
+  return hpost(uri(), { ...(request || {}), query: request?.query || 'action_id:*' });
+};

package/api/search/analytic.ts

@@ -0,0 +1,12 @@
+import { hpost, joinUri } from '@cccsaurora/howler-ui/api';
+import type { HowlerSearchRequest, HowlerSearchResponse } from '@cccsaurora/howler-ui/api/search';
+import { uri as parentUri } from '@cccsaurora/howler-ui/api/search';
+import type { Analytic } from '@cccsaurora/howler-ui/models/entities/generated/Analytic';
+
+export const uri = () => {
+  return joinUri(parentUri(), 'analytic');
+};
+
+export const post = (request?: HowlerSearchRequest): Promise<HowlerSearchResponse<Analytic>> => {
+  return hpost(uri(), { ...(request || {}), query: request?.query || 'analytic_id:*' });
+};

package/api/search/count/hit.ts

@@ -0,0 +1,11 @@
+import { hpost, joinUri } from '@cccsaurora/howler-ui/api';
+import type { HowlerCountResult, HowlerCountSearchRequest } from '@cccsaurora/howler-ui/api/search/count';
+import { uri as parentUri } from '@cccsaurora/howler-ui/api/search/count';
+
+export const uri = () => {
+  return joinUri(parentUri(), 'hit');
+};
+
+export const post = (request?: HowlerCountSearchRequest): Promise<HowlerCountResult> => {
+  return hpost(uri(), { ...(request || {}), query: request?.query || 'howler.id:*' });
+};

package/api/search/count/index.ts

@@ -0,0 +1,18 @@
+import { joinUri } from '@cccsaurora/howler-ui/api';
+import { uri as parentUri } from '@cccsaurora/howler-ui/api/search';
+import * as hit from '@cccsaurora/howler-ui/api/search/count/hit';
+
+export interface HowlerCountSearchRequest {
+  query: string;
+  filters?: string[];
+}
+
+export interface HowlerCountResult {
+  count: number;
+}
+
+export const uri = () => {
+  return joinUri(parentUri(), 'count');
+};
+
+export { hit };

package/api/search/dossier.ts

@@ -0,0 +1,12 @@
+import { hpost, joinUri } from '@cccsaurora/howler-ui/api';
+import type { HowlerSearchRequest, HowlerSearchResponse } from '@cccsaurora/howler-ui/api/search';
+import { uri as parentUri } from '@cccsaurora/howler-ui/api/search';
+import type { Dossier } from '@cccsaurora/howler-ui/models/entities/generated/Dossier';
+
+export const uri = () => {
+  return joinUri(parentUri(), 'dossier');
+};
+
+export const post = (request?: HowlerSearchRequest): Promise<HowlerSearchResponse<Dossier>> => {
+  return hpost(uri(), { ...(request || {}), query: request?.query || 'title:*' });
+};

package/api/search/eql/hit.ts

@@ -0,0 +1,12 @@
+import { hpost, joinAllUri } from '@cccsaurora/howler-ui/api';
+import type { HowlerEQLSearchRequest, HowlerEQLSearchResponse } from '@cccsaurora/howler-ui/api/search';
+import { uri as parentUri } from '@cccsaurora/howler-ui/api/search';
+import type { Hit } from '@cccsaurora/howler-ui/models/entities/generated/Hit';
+
+export const uri = () => {
+  return joinAllUri(parentUri(), 'hit', 'eql');
+};
+
+export const post = (request?: HowlerEQLSearchRequest): Promise<HowlerEQLSearchResponse<Hit>> => {
+  return hpost(uri(), { ...(request || {}), eql_query: request?.eql_query || 'any where true' });
+};

package/api/search/facet/hit.ts

@@ -0,0 +1,11 @@
+import { hpost, joinUri } from '@cccsaurora/howler-ui/api';
+import type { HowlerFacetSearchRequest, HowlerFacetSearchResponse } from '@cccsaurora/howler-ui/api/search/facet';
+import { uri as parentUri } from '@cccsaurora/howler-ui/api/search/facet';
+
+export const uri = () => {
+  return joinUri(parentUri(), 'hit');
+};
+
+export const post = (request?: HowlerFacetSearchRequest): Promise<{ [index: string]: HowlerFacetSearchResponse }> => {
+  return hpost(uri(), { ...(request || {}), query: request?.query || 'howler.id:*' });
+};

package/api/search/facet/index.ts

@@ -0,0 +1,19 @@
+import { joinUri } from '@cccsaurora/howler-ui/api';
+import { uri as parentUri } from '@cccsaurora/howler-ui/api/search';
+import * as hit from '@cccsaurora/howler-ui/api/search/facet/hit';
+
+export const uri = () => {
+  return joinUri(parentUri(), 'facet');
+};
+
+export type HowlerFacetSearchRequest = {
+  fields?: string[];
+  query?: string;
+  mincount?: number;
+  rows?: number;
+  filters?: string[];
+};
+
+export type HowlerFacetSearchResponse = { [value: string]: number };
+
+export { hit };

package/api/search/fields/hit.ts

@@ -0,0 +1,12 @@
+import { hget, joinUri } from '@cccsaurora/howler-ui/api';
+import type { SearchField } from '@cccsaurora/howler-ui/api/search/fields';
+import { indexed, uri as parentUri } from '@cccsaurora/howler-ui/api/search/fields';
+
+export const uri = () => {
+  return joinUri(parentUri(), 'hit');
+};
+
+export const get = async (): Promise<SearchField[]> => {
+  const response = await hget<{ [key: string]: SearchField }>(uri());
+  return indexed(response);
+};

package/api/search/fields/index.ts

@@ -0,0 +1,29 @@
+import { uri as parentUri } from '@cccsaurora/howler-ui/api/search';
+import * as hit from '@cccsaurora/howler-ui/api/search/fields/hit';
+import * as user from '@cccsaurora/howler-ui/api/search/fields/user';
+// import urlJoin from 'url-join';
+import { joinUri } from '@cccsaurora/howler-ui/api';
+
+export type SearchField = {
+  key?: string;
+  default: boolean;
+  indexed: boolean;
+  list: boolean;
+  stored: boolean;
+  type: string;
+  description?: string;
+};
+
+export const uri = () => {
+  return joinUri(parentUri(), 'fields');
+};
+
+export const map = (fields: { [key: string]: SearchField }): SearchField[] => {
+  return Object.keys(fields).map(key => ({ ...fields[key], key }));
+};
+
+export const indexed = (fields: { [key: string]: SearchField }): SearchField[] => {
+  return map(fields).filter(field => field.indexed);
+};
+
+export { hit, user };

package/api/search/fields/user.ts

@@ -0,0 +1,14 @@
+import * as api from '@cccsaurora/howler-ui/api';
+import type { SearchField } from '@cccsaurora/howler-ui/api/search/fields';
+import { indexed, uri as parentUri } from '@cccsaurora/howler-ui/api/search/fields';
+// import urlJoin from 'url-join';
+import { joinUri } from '@cccsaurora/howler-ui/api';
+
+export const uri = () => {
+  return joinUri(parentUri(), 'user');
+};
+
+export const get = async (): Promise<SearchField[]> => {
+  const response = await api.hget<{ [key: string]: SearchField }>(uri());
+  return indexed(response);
+};

package/api/search/grouped/hit.ts

@@ -0,0 +1,15 @@
+import { hpost, joinAllUri } from '@cccsaurora/howler-ui/api';
+import type { HowlerGroupedSearchRequest, HowlerGroupedSearchResponse } from '@cccsaurora/howler-ui/api/search/grouped';
+import { uri as parentUri } from '@cccsaurora/howler-ui/api/search/grouped';
+import type { Hit } from '@cccsaurora/howler-ui/models/entities/generated/Hit';
+
+export const uri = (field: string) => {
+  return joinAllUri(parentUri(), 'hit', field);
+};
+
+export const post = (
+  field: string,
+  request?: HowlerGroupedSearchRequest
+): Promise<HowlerGroupedSearchResponse<Hit>> => {
+  return hpost(uri(field), { ...(request || {}), query: request?.query || 'howler.id:*' });
+};

package/api/search/grouped/index.ts

@@ -0,0 +1,34 @@
+import { joinUri } from '@cccsaurora/howler-ui/api';
+import { uri as parentUri } from '@cccsaurora/howler-ui/api/search';
+import * as hit from '@cccsaurora/howler-ui/api/search/grouped/hit';
+import * as user from '@cccsaurora/howler-ui/api/search/grouped/user';
+
+export const uri = () => {
+  return joinUri(parentUri(), 'grouped');
+};
+
+export type HowlerGroupedSearchRequest = {
+  group_sort?: string;
+  limit?: number;
+  query?: string;
+  offset?: number;
+  rows?: number;
+  sort?: string;
+  fl?: string;
+  filters?: string[];
+};
+
+type GroupedResult<T> = {
+  value: string;
+  total: number;
+  items: T[];
+};
+
+export type HowlerGroupedSearchResponse<T> = {
+  items: GroupedResult<T>[];
+  offset: number;
+  rows: number;
+  total: number;
+};
+
+export { hit, user };

package/api/search/grouped/user.ts

@@ -0,0 +1,30 @@
+import { hpost, joinAllUri } from '@cccsaurora/howler-ui/api';
+import type { HowlerGroupedSearchRequest, HowlerGroupedSearchResponse } from '@cccsaurora/howler-ui/api/search/grouped';
+import { uri as parentUri } from '@cccsaurora/howler-ui/api/search/grouped';
+import type { HowlerUser } from '@cccsaurora/howler-ui/models/entities/HowlerUser';
+
+export type HowlerApiUser = Omit<HowlerUser, 'username'> & { uname: string };
+
+export const uri = (field: string) => {
+  return joinAllUri(parentUri(), 'user', field);
+};
+
+export const post = async (
+  field: string,
+  body?: HowlerGroupedSearchRequest
+): Promise<HowlerGroupedSearchResponse<HowlerUser>> => {
+  const response = await hpost<HowlerGroupedSearchResponse<HowlerApiUser>>(uri(field), {
+    ...(body || {}),
+    query: body?.query || 'uname:*'
+  });
+  return {
+    ...response,
+    items: response.items.map(i => ({
+      ...i,
+      items: i.items.map(_i => ({
+        ..._i,
+        username: _i.uname
+      }))
+    }))
+  };
+};

package/api/search/histogram/hit.ts

@@ -0,0 +1,11 @@
+import { hpost, joinAllUri } from '@cccsaurora/howler-ui/api';
+import type { HowlerHistogramSearchRequest, HowlerHistogramSearchResponse } from '@cccsaurora/howler-ui/api/search/histogram';
+import { uri as parentUri } from '@cccsaurora/howler-ui/api/search/histogram';
+
+export const uri = (field: string) => {
+  return joinAllUri(parentUri(), 'hit', field);
+};
+
+export const post = (field: string, request?: HowlerHistogramSearchRequest): Promise<HowlerHistogramSearchResponse> => {
+  return hpost(uri(field), { ...(request || {}), query: request?.query || 'howler.id:*' });
+};

package/api/search/histogram/index.ts

@@ -0,0 +1,20 @@
+import { joinUri } from '@cccsaurora/howler-ui/api';
+import { uri as parentUri } from '@cccsaurora/howler-ui/api/search';
+import * as hit from '@cccsaurora/howler-ui/api/search/histogram/hit';
+
+export const uri = () => {
+  return joinUri(parentUri(), 'histogram');
+};
+
+export type HowlerHistogramSearchRequest = {
+  query?: string;
+  mincount?: number;
+  filters?: string[];
+  start?: string | number;
+  end?: string | number;
+  gap?: string | number;
+};
+
+export type HowlerHistogramSearchResponse = { [timestamp: string]: number };
+
+export { hit };

package/api/search/hit.ts

@@ -0,0 +1,17 @@
+import { hpost, joinUri } from '@cccsaurora/howler-ui/api';
+import type { HowlerSearchRequest, HowlerSearchResponse } from '@cccsaurora/howler-ui/api/search';
+import { uri as parentUri } from '@cccsaurora/howler-ui/api/search';
+import type { Hit } from '@cccsaurora/howler-ui/models/entities/generated/Hit';
+
+import * as eql from '@cccsaurora/howler-ui/api/search/eql/hit';
+import * as sigma from '@cccsaurora/howler-ui/api/search/sigma/hit';
+
+export const uri = () => {
+  return joinUri(parentUri(), 'hit');
+};
+
+export const post = (request?: HowlerSearchRequest): Promise<HowlerSearchResponse<Hit>> => {
+  return hpost(uri(), { ...(request || {}), query: request?.query || 'howler.id:*' });
+};
+
+export { eql, sigma };