@cccsaurora/howler-ui 2.14.0-dev.269 → 2.14.0-dev.272

package/utils/utils.js

@@ -0,0 +1,180 @@
+import * as colors from '@mui/material/colors';
+import dayjs from 'dayjs';
+import { flatten, unflatten } from 'flat';
+import { isArray, isEmpty, isNil, isObject, isPlainObject } from 'lodash-es';
+export const bytesToSize = (bytes) => {
+    const sizes = ['B', 'KB', 'MB', 'GB', 'TB'];
+    if (bytes === 0 || bytes === null)
+        return '0 B';
+    const i = Math.floor(Math.log(bytes) / Math.log(1024));
+    return `${Math.round(bytes / Math.pow(1024, i))} ${sizes[i]}`;
+};
+export const humanReadableNumber = (num) => {
+    const sizes = ['', 'k', 'm', 'g', 't', 'p', 'e', 'z', 'y'];
+    if (num === 0 || num === null)
+        return '0 ';
+    const i = Math.floor(Math.log(num) / Math.log(1000));
+    return `${Math.round(num / Math.pow(1000, i))}${sizes[i]} `;
+};
+export const getProvider = () => {
+    if (window.location.pathname.indexOf(`${import.meta.env.PUBLIC_URL}/oauth/`) !== -1) {
+        return window.location.pathname
+            .split(`${import.meta.env.PUBLIC_URL}/oauth/`)
+            .pop()
+            .slice(0, -1);
+    }
+    const params = new URLSearchParams(window.location.search);
+    return params.get('provider');
+};
+export const searchResultsDisplay = (count, max = 10000) => {
+    const params = new URLSearchParams(window.location.search);
+    const trackedHits = params.get('track_total_hits');
+    if (count === parseInt(trackedHits) || (trackedHits === null && count === max)) {
+        return `${count}+`;
+    }
+    return `${count}`;
+};
+const DATE_FORMAT = 'YYYY/MM/DD HH:mm:ss';
+export const formatDate = (date) => {
+    if (!date) {
+        return '?';
+    }
+    return dayjs(date).utc().format(DATE_FORMAT);
+};
+export const compareTimestamp = (a, b) => {
+    return (new Date(a).getTime() - new Date(b).getTime()) / 1000;
+};
+export const twitterShort = (date) => {
+    if (!date || date === '?') {
+        return '?';
+    }
+    return dayjs(date).fromNow();
+};
+export const hashCode = (s) => s.split('').reduce((a, b) => ((a << 5) - a + b.charCodeAt(0)) | 0, 0);
+export const stringToColor = (string) => {
+    const number = Math.abs(hashCode(string));
+    const colorKeys = Object.keys(colors).filter(key => key !== 'common');
+    const colorKey = colorKeys[number % colorKeys.length];
+    // eslint-disable-next-line import/namespace
+    const color = colors[colorKey];
+    const shade = Math.max(Math.floor((number / 1000) % 10), 1) * 100;
+    return color[shade];
+};
+// Adapted from here: https://stackoverflow.com/a/48429492
+export const delay = (ms, rejectOnCancel = false) => {
+    let timerId;
+    let onCancel;
+    class TimedPromise extends Promise {
+        cancel = () => {
+            if (rejectOnCancel) {
+                onCancel();
+            }
+            clearTimeout(timerId);
+        };
+    }
+    return new TimedPromise((resolve, reject) => {
+        timerId = setTimeout(resolve, ms);
+        onCancel = reject;
+    });
+};
+export const sortByTimestamp = (arr) => {
+    return (arr ?? []).slice().sort((a, b) => compareTimestamp(b.timestamp, a.timestamp));
+};
+export const getTimeRange = (arr) => {
+    const sorted = arr.sort((a, b) => compareTimestamp(a, b));
+    return [sorted[0], sorted[sorted.length - 1]];
+};
+export const removeEmpty = (obj, aggressive = false) => {
+    if (aggressive && isEmpty(obj)) {
+        return null;
+    }
+    else if (isArray(obj)) {
+        return obj;
+    }
+    return Object.fromEntries(Object.entries(obj ?? {})
+        .filter(([__, v]) => !isNil(v))
+        .map(([k, v]) => [k, isPlainObject(v) || isArray(v) ? removeEmpty(v, aggressive) : v])
+        .filter(([__, v]) => !!v));
+};
+export const searchObject = (o, query, returnFlat = false) => {
+    if (!query) {
+        return returnFlat ? flatten(o) : o;
+    }
+    try {
+        const regex = new RegExp(query, 'i');
+        const filteredData = Object.fromEntries(Object.entries(flatten(o)).filter(([k, v]) => regex.test(k) || regex.test(v))) ?? {};
+        return returnFlat ? filteredData : unflatten(filteredData);
+    }
+    catch (e) {
+        return returnFlat ? flatten(o) : o;
+    }
+};
+const DATE_TO_LUCENE_MAP = {
+    day: 'd',
+    week: 'w',
+    month: 'M',
+    year: 'y'
+};
+export const convertDateToLucene = (date) => {
+    if (!date.startsWith('date.range.')) {
+        return '[now-1d TO now]';
+    }
+    if (date.endsWith('all')) {
+        return '*';
+    }
+    const [amount, type] = date.replace('date.range.', '').split('.');
+    return `[now-${amount}${DATE_TO_LUCENE_MAP[type] ?? 'd'} TO now]`;
+};
+export const convertCustomDateRangeToLucene = (startDate, endDate) => {
+    return `[${startDate} TO ${endDate}]`;
+};
+export const convertLuceneToDate = (lucene) => {
+    if (!lucene.includes(':')) {
+        return lucene;
+    }
+    const [amount, initial] = lucene.replace(/.+\[now-(\d+)(\w+) TO now]/, '$1 $2').split(' ');
+    const type = Object.entries(DATE_TO_LUCENE_MAP).find(([__, _initial]) => _initial === initial)?.[0] ?? 'day';
+    return `date.range.${amount}.${type}`;
+};
+export const tryParse = (json) => {
+    try {
+        return JSON.parse(json);
+    }
+    catch (e) {
+        return json;
+    }
+};
+export const flattenDeep = (data) => {
+    const partialFlat = flatten(data, { safe: true });
+    const final = {};
+    Object.entries(partialFlat).forEach(([key, value]) => {
+        if (!Array.isArray(value) || value.length === 0 || !value.some(entry => isObject(entry))) {
+            final[key] = value;
+        }
+        else {
+            value.forEach(entry => {
+                const flattenedEntry = flattenDeep(entry);
+                Object.entries(flattenedEntry).forEach(([childKey, childValue]) => {
+                    const fullKey = `${key}.${childKey}`;
+                    if (!final[fullKey]) {
+                        if (Array.isArray(childValue)) {
+                            final[fullKey] = childValue;
+                        }
+                        else {
+                            final[fullKey] = [childValue];
+                        }
+                    }
+                    else {
+                        if (Array.isArray(childValue)) {
+                            final[fullKey] = [...final[fullKey], ...childValue];
+                        }
+                        else {
+                            final[fullKey].push(childValue);
+                        }
+                    }
+                });
+            });
+        }
+    });
+    return final;
+};

package/utils/xsrf.d.ts

@@ -0,0 +1,2 @@
+declare const getXSRFCookie: () => string;
+export default getXSRFCookie;

package/utils/xsrf.js

@@ -0,0 +1,16 @@
+const getXSRFCookie = () => {
+    if (document.cookie !== undefined) {
+        try {
+            // eslint-disable-next-line prefer-destructuring
+            return document.cookie
+                .split('; ')
+                .find(row => row.startsWith('XSRF-TOKEN'))
+                .split('=')[1];
+        }
+        catch (ex) {
+            // Ignore... we will return null
+        }
+    }
+    return null;
+};
+export default getXSRFCookie;

package/README.fr.md

@@ -1,39 +0,0 @@
-# Howler : Triage optimisé
-
-Améliorez l'efficacité de votre centre d'opérations de sécurité avec Howler, la plateforme de triage des alertes de pointe conçue pour répondre aux exigences actuelles des centres d'opérations de sécurité.
-
-## 🚀 Donnez du pouvoir à vos analystes
-
-Howler permet aux analystes de triage et aux ingénieurs de détection d'en faire plus en affinant et en accélérant la réponse aux incidents grâce à une multitude de fonctionnalités modernes.
-
-- **💨 Triage rationalisé des alertes:** Utilisez des modèles de cartes d'alerte personnalisables pour une évaluation rapide et cohérente.
-
-- **☑ Schéma normalisé:** Examinez les alertes conformes au Elastic Common Schema pour une comparaison plus facile et des évaluations plus précises.
-
-- **📁 Automatisation basée sur des filtres:** Mettez en œuvre une automatisation basée sur des filtres pour éliminer les tâches de routine et vous concentrer sur l'analyse stratégique.
-
-- **📝 Automatisation basée sur des règles:** Utilisez Elastic Query Language ou les formats de règles Sigma pour automatiser.
-
-- **🧠 Regroupement intelligent des alertes:** Gérez efficacement les menaces grâce à un système de regroupement intuitif qui fournit un contexte et accélère la résolution.
-
-- **🛠 Intégration transparente des outils:** Améliorez votre écosystème de sécurité grâce à l'intégration sans effort d'outils externes essentiels.
-
-## Documentation
-
-Pour la documentation, voir <https://cybercentrecanada.github.io/howler-docs/fr>
-
-## Contribution
-
-### Développement
-
-Si vous souhaitez contribuer à Howler, suivez le [guide du développeur] (<https://cybercentrecanada.github.io/howler-docs/developer/getting_started/>), créez une branche et commencez à coder !
-
-### Signalement de problèmes
-
-Si vous souhaitez signaler un problème, nous suivrons les problèmes pour chaque composant dans leurs dépôts respectifs :
-
-- [Howler UI](https://github.com/CybercentreCanada/howler-ui/issues/new)
-- [Howler API](https://github.com/CybercentreCanada/howler-api/issues/new)
-- [Howler Client](https://github.com/CybercentreCanada/howler-client/issues/new)
-
-Veuillez ne pas créer de problèmes dans ce dépôt - il est expressément utilisé comme une page d'atterrissage pour ceux qui sont intéressés par les bases de code de Howler.

package/README.md

@@ -1,29 +0,0 @@
-# Howler: Triage Optimized
-
-Elevate your Security Operations Center's efficiency with Howler, the cutting-edge alert triage platform tailored for today's SOC demands.
-
-## 🚀 Empower Your Analysts
-
-Howler allows triage analysts and detection engineers to do more by refining and expediting incident response through a host of modern features.
-
-- **💨 Streamlined Alert Triage**: Utilize customizable alert card templates for quick and consistent evaluation.
-
-- **☑ Standardized Schema**: Review alerts conforming to the Elastic Common Schema for easier comparison and more accurate assessments.
-
-- **📁 Filter-based automation**: Implement filter-driven automation to eliminate routine tasks and focus on strategic analysis.
-
-- **📝 Rule-based automation**: Use Elastic Query Language or Sigma rule formats to automate.
-
-- **🧠 Intelligent Alert Grouping**: Efficiently manage threats with an intuitive bundling system that provides context and speeds up resolution.
-
-- **🛠 Seamless Tool Integration**: Enhance your security ecosystem with effortless integration of essential external tools.
-
-## Documentation
-
-For documentation, see <https://cybercentrecanada.github.io/howler-docs/>
-
-## Contributing
-
-### Development
-
-If you'd like to contribute to Howler, follow the [developer's guide](https://cybercentrecanada.github.io/howler-docs/developer/getting_started/), create a branch and get coding!

package/api/action/execute.ts

@@ -1,19 +0,0 @@
-import { hpost, joinAllUri, joinUri } from '@cccsaurora/howler-ui/api';
-import { uri as parentUri } from '@cccsaurora/howler-ui/api/action';
-import type { ActionReport, ActionRequest } from '@cccsaurora/howler-ui/models/ActionTypes';
-
-export const uri = (id?: string) => {
-  return id ? joinAllUri(parentUri(), id, 'execute') : joinUri(parentUri(), 'execute');
-};
-
-export const post = (data: ActionRequest): Promise<ActionReport> => {
-  if (data.action_id) {
-    return hpost(uri(data.action_id), { request_id: data.request_id, query: data.query });
-  } else {
-    return hpost(uri(), {
-      request_id: data.request_id,
-      query: data.query,
-      operations: data.operations
-    });
-  }
-};

package/api/action/index.ts

@@ -1,36 +0,0 @@
-import { hdelete, hpatch, hpost, hput, joinAllUri, joinUri, uri as parentUri } from '@cccsaurora/howler-ui/api';
-import * as execute from '@cccsaurora/howler-ui/api/action/execute';
-import * as operations from '@cccsaurora/howler-ui/api/action/operations';
-import { action } from '@cccsaurora/howler-ui/api/search';
-import type { Action } from '@cccsaurora/howler-ui/models/entities/generated/Action';
-
-export const uri = (id?: string) => {
-  return id ? joinAllUri(parentUri(), 'action', id) : joinUri(parentUri(), 'action');
-};
-
-export const get = (id: string): Promise<Action> => {
-  return action
-    .post({
-      query: `action_id:${id}`,
-      rows: 1
-    })
-    .then(res => res.items[0]);
-};
-
-export const post = (data: Action): Promise<Action> => {
-  return hpost(uri(), data);
-};
-
-export const put = (id: string, data: Action): Promise<Action> => {
-  return hput(uri(id), data);
-};
-
-export const patch = (id: string, data: Action): Promise<Action> => {
-  return hpatch(uri(id), data);
-};
-
-export const del = (id: string): Promise<void> => {
-  return hdelete(uri(id));
-};
-
-export { execute, operations };

package/api/action/operations.ts

@@ -1,11 +0,0 @@
-import { hget, joinUri } from '@cccsaurora/howler-ui/api';
-import { uri as parentUri } from '@cccsaurora/howler-ui/api/action';
-import type { ActionOperation } from '@cccsaurora/howler-ui/models/ActionTypes';
-
-export const uri = () => {
-  return joinUri(parentUri(), 'operations');
-};
-
-export const get = (): Promise<ActionOperation[]> => {
-  return hget(uri());
-};

package/api/analytic/comments/index.ts

@@ -1,27 +0,0 @@
-import { hdelete, hget, hpost, hput, joinAllUri, joinUri } from '@cccsaurora/howler-ui/api';
-import { uri as parentUri } from '@cccsaurora/howler-ui/api/analytic';
-import type { Analytic } from '@cccsaurora/howler-ui/models/entities/generated/Analytic';
-import type { Comment } from '@cccsaurora/howler-ui/models/entities/generated/Comment';
-import * as react from './react';
-
-export const uri = (analytic: string, comment?: string) => {
-  return comment ? joinAllUri(parentUri(analytic), 'comments', comment) : joinUri(parentUri(analytic), 'comments');
-};
-
-export const get = (analytic: string, comment: string): Promise<Comment> => {
-  return hget(uri(analytic, comment));
-};
-
-export const put = (analytic: string, comment: string, value: string): Promise<{ success: boolean }> => {
-  return hput(uri(analytic, comment), { value });
-};
-
-export const post = (analytic: string, value: string, detection?: string): Promise<Analytic> => {
-  return hpost(uri(analytic), { value, detection });
-};
-
-export const del = (analytic: string, comments: string[]): Promise<{ success: boolean }> => {
-  return hdelete(uri(analytic), comments);
-};
-
-export { react };

package/api/analytic/comments/react.ts

@@ -1,14 +0,0 @@
-import { hdelete, hput, joinUri } from '@cccsaurora/howler-ui/api';
-import { uri as parentUri } from '@cccsaurora/howler-ui/api/analytic/comments';
-
-export const uri = (analytic: string, comment: string) => {
-  return joinUri(parentUri(analytic, comment), 'react');
-};
-
-export const put = (analytic: string, comment: string, type: string): Promise<boolean> => {
-  return hput(uri(analytic, comment), { type });
-};
-
-export const del = (analytic: string, comment: string): Promise<boolean> => {
-  return hdelete(uri(analytic, comment));
-};

package/api/analytic/favourite.ts

@@ -1,14 +0,0 @@
-import { hdelete, hpost, joinAllUri } from '@cccsaurora/howler-ui/api';
-import { uri as parentUri } from '@cccsaurora/howler-ui/api/analytic';
-
-export const uri = (id: string) => {
-  return joinAllUri(parentUri(), id, 'favourite');
-};
-
-export const del = (id: string): Promise<{ success: boolean }> => {
-  return hdelete(uri(id));
-};
-
-export const post = (id: string): Promise<{ success: boolean }> => {
-  return hpost(uri(id), {});
-};

package/api/analytic/index.ts

@@ -1,27 +0,0 @@
-import { hdelete, hget, hput, joinAllUri, joinUri, uri as parentUri } from '@cccsaurora/howler-ui/api';
-import * as comments from '@cccsaurora/howler-ui/api/analytic/comments';
-import * as favourite from '@cccsaurora/howler-ui/api/analytic/favourite';
-import * as notebooks from '@cccsaurora/howler-ui/api/analytic/notebooks';
-import * as owner from '@cccsaurora/howler-ui/api/analytic/owner';
-import * as rules from '@cccsaurora/howler-ui/api/analytic/rules';
-import type { Analytic } from '@cccsaurora/howler-ui/models/entities/generated/Analytic';
-
-export type EditOptions = Pick<Analytic, 'description' | 'rule' | 'rule_crontab' | 'triage_settings'>;
-
-export const uri = (id?: string) => {
-  return id ? joinAllUri(parentUri(), 'analytic', id) : joinUri(parentUri(), 'analytic');
-};
-
-export const get = (id?: string) => {
-  return id ? hget<Analytic>(uri(id)) : hget<Analytic[]>(uri());
-};
-
-export const put = (id: string, editData: EditOptions): Promise<Analytic> => {
-  return hput(uri(id), editData);
-};
-
-export const del = (id: string) => {
-  return hdelete(uri(id));
-};
-
-export { comments, favourite, notebooks, owner, rules };

package/api/analytic/notebooks/index.ts

@@ -1,15 +0,0 @@
-import { hdelete, hpost, joinUri } from '@cccsaurora/howler-ui/api';
-import { uri as parentUri } from '@cccsaurora/howler-ui/api/analytic';
-import type { Analytic } from '@cccsaurora/howler-ui/models/entities/generated/Analytic';
-
-export const uri = (analytic: string) => {
-  return joinUri(parentUri(analytic), 'notebooks');
-};
-
-export const post = (analytic: string, body: { detection: string; value: string; name: string }): Promise<Analytic> => {
-  return hpost(uri(analytic), body);
-};
-
-export const del = (analytic: string, notebooks: string[]): Promise<{ success: boolean }> => {
-  return hdelete(uri(analytic), notebooks);
-};

package/api/analytic/owner.ts

@@ -1,11 +0,0 @@
-import { hpost, joinAllUri } from '@cccsaurora/howler-ui/api';
-import { uri as parentUri } from '@cccsaurora/howler-ui/api/analytic';
-import type { Analytic } from '@cccsaurora/howler-ui/models/entities/generated/Analytic';
-
-export const uri = (id: string) => {
-  return joinAllUri(parentUri(), id, 'owner');
-};
-
-export const post = (id: string, body: { username: string }): Promise<Analytic> => {
-  return hpost(uri(id), body);
-};

package/api/analytic/rules.ts

@@ -1,13 +0,0 @@
-import { hpost, joinUri } from '@cccsaurora/howler-ui/api';
-import { uri as parentUri } from '@cccsaurora/howler-ui/api/analytic';
-import type { Analytic } from '@cccsaurora/howler-ui/models/entities/generated/Analytic';
-
-export const uri = () => {
-  return joinUri(parentUri(), 'rules');
-};
-
-export const post = (
-  body: Pick<Analytic, 'description' | 'name' | 'rule' | 'rule_type' | 'rule_crontab'>
-): Promise<Analytic> => {
-  return hpost(uri(), body);
-};

package/api/auth/apikey.ts

@@ -1,20 +0,0 @@
-import { hdelete, hpost, joinUri } from '@cccsaurora/howler-ui/api';
-import { uri as parentUri } from '@cccsaurora/howler-ui/api/auth';
-
-export type Privileges = 'R' | 'W' | 'E' | 'I';
-
-type CreateApiKeyResponse = {
-  apikey: string;
-};
-
-export const uri = (apiKeyName?: string) => {
-  return apiKeyName ? joinUri(joinUri(parentUri(), 'apikey'), apiKeyName) : joinUri(parentUri(), 'apikey');
-};
-
-export const post = (apiKeyName: string, priv: Privileges[], expiryDate: string): Promise<CreateApiKeyResponse> => {
-  return hpost(uri(), { name: apiKeyName, priv, expiry_date: expiryDate });
-};
-
-export const del = (apiKeyName: string) => {
-  return hdelete(uri(apiKeyName));
-};

package/api/auth/index.ts

@@ -1,9 +0,0 @@
-import { joinUri, uri as parentUri } from '@cccsaurora/howler-ui/api';
-import * as apikey from '@cccsaurora/howler-ui/api/auth/apikey';
-import * as login from '@cccsaurora/howler-ui/api/auth/login';
-
-export const uri = () => {
-  return joinUri(parentUri(), 'auth');
-};
-
-export { apikey, login };

package/api/auth/login.ts

@@ -1,35 +0,0 @@
-import { hget, hpost, joinUri } from '@cccsaurora/howler-ui/api';
-import { uri as parentUri } from '@cccsaurora/howler-ui/api/auth';
-import { MY_LOCAL_STORAGE_PREFIX, StorageKey } from '@cccsaurora/howler-ui/utils/constants';
-
-export type PostLoginBody = {
-  user?: string;
-  password?: string;
-  refresh_token?: string;
-  provider?: string;
-};
-
-export type LoginResponse = {
-  app_token?: string;
-  refresh_token?: string;
-  provider?: string;
-};
-
-export const uri = (searchParams?: URLSearchParams) => {
-  return joinUri(parentUri(), 'login', searchParams);
-};
-
-export const post = (body: PostLoginBody): Promise<LoginResponse> => {
-  return hpost(uri(), body);
-};
-
-export const get = (search: URLSearchParams): Promise<LoginResponse> => {
-  const nonce = localStorage.getItem(`${MY_LOCAL_STORAGE_PREFIX}.${StorageKey.LOGIN_NONCE}`);
-
-  if (nonce) {
-    search.set('nonce', JSON.parse(nonce));
-    localStorage.removeItem(`${MY_LOCAL_STORAGE_PREFIX}.${StorageKey.LOGIN_NONCE}`);
-  }
-
-  return hget(uri(), search);
-};

package/api/configs/index.ts

@@ -1,10 +0,0 @@
-import { hget, joinUri, uri as parentUri } from '@cccsaurora/howler-ui/api';
-import type { ApiType } from '@cccsaurora/howler-ui/models/entities/generated/ApiType';
-
-export const uri = () => {
-  return joinUri(parentUri(), 'configs');
-};
-
-export const get = (): Promise<ApiType> => {
-  return hget(uri());
-};

package/api/dossier/hit.ts

@@ -1,10 +0,0 @@
-/* eslint-disable import/no-cycle */
-import { hget, joinAllUri } from '@cccsaurora/howler-ui/api';
-import type { Dossier } from '@cccsaurora/howler-ui/models/entities/generated/Dossier';
-import { uri as parentUri } from '.';
-
-const uri = (id: string) => joinAllUri(parentUri(), 'hit', id);
-
-export const get = (id?: string): Promise<Dossier[]> => {
-  return hget(uri(id));
-};

package/api/dossier/index.ts

@@ -1,26 +0,0 @@
-// eslint-disable-next-line import/no-cycle
-import { hdelete, hget, hpost, hput, joinAllUri, joinUri, uri as parentUri } from '@cccsaurora/howler-ui/api';
-import type { Dossier } from '@cccsaurora/howler-ui/models/entities/generated/Dossier';
-import * as hit from './hit';
-
-export const uri = (id?: string) => {
-  return id ? joinAllUri(parentUri(), 'dossier', id) : joinUri(parentUri(), 'dossier');
-};
-
-export const get = (id?: string): Promise<Dossier | Dossier[]> => {
-  return hget(uri(id));
-};
-
-export const post = (newData: Partial<Dossier>): Promise<Dossier> => {
-  return hpost(uri(), newData);
-};
-
-export const put = (id: string, dossier: Partial<Dossier>): Promise<Dossier> => {
-  return hput(uri(id), dossier);
-};
-
-export const del = (id: string): Promise<void> => {
-  return hdelete(uri(id));
-};
-
-export { hit };

package/api/help.ts

@@ -1,71 +0,0 @@
-import { hget, joinUri, uri as parentUri } from '@cccsaurora/howler-ui/api';
-
-export const uri = () => {
-  return joinUri(parentUri(), '');
-};
-
-interface ApiDescription {
-  /**
-   * Name of the api
-   */
-  name: string;
-
-  /**
-   * API path
-   */
-  path: string;
-
-  /**
-   * Is UI only API
-   */
-  ui_only: boolean;
-
-  /**
-   * Allowed HTTP methods
-   */
-  methods: string[];
-
-  /**
-   * API documentation
-   */
-  description: string;
-
-  /**
-   * Unique ID for the API
-   */
-  id: string;
-
-  /**
-   * Function called in the code
-   */
-  function: string;
-
-  /**
-   * Does the API require login
-   **/
-  protected: boolean;
-
-  /**
-   * Type of users allowed to use API
-   */
-  required_type: string[];
-
-  /**
-   * Type of privileges needed by API keys to use API
-   */
-  required_priv: string[];
-
-  /**
-   * Is the API stable?
-   **/
-  complete: boolean;
-}
-
-export interface HelpResponse {
-  apis: ApiDescription[];
-  blueprints: { [index: string]: string };
-}
-
-export const get = (): Promise<HelpResponse> => {
-  return hget(uri());
-};