Adds API functionality (#18)

* Adds more hooks

* Enum hook reorder & extension

* PR comments

Author: JWittmeyer

hooks/enums/useEnumOptions.tsx

@@ -0,0 +1,7 @@
+import { enumToArray, enumToArrayOptions } from '@/submodules/javascript-functions/general';
+import { useMemo } from 'react';
+
+
+export default function useEnumOptions<T>(enumObj: T, options?: enumToArrayOptions): { name: string, value: T }[] {
+    return useMemo(() => enumToArray(enumObj, options), []);
+}

hooks/enums/useEnumOptionsTranslated.tsx

@@ -0,0 +1,23 @@
+import { enumToArray } from '@/submodules/javascript-functions/general';
+import { useMemo } from 'react';
+import { useTranslation } from 'react-i18next';
+
+
+const cache = {};
+
+function getEnumOptionsForLanguage<T>(enumObj: T, lookupKey: string, t: any, language: string): { name: string, value: T }[] {
+    if (!(lookupKey in cache)) cache[lookupKey] = {};
+    if (cache[lookupKey][language]) return cache[lookupKey][language];
+    const finalArray = enumToArray(enumObj, { nameFunction: (s) => { return t(`${lookupKey}.${s}`) } });
+    cache[lookupKey][language] = finalArray;
+    return cache[lookupKey][language];
+}
+
+// unfortunately we need to provide the lookupKey ourselves which is the Enum name itself.
+// there is no way to get the name of the enum at runtime since they are compiled away
+// https://stackoverflow.com/a/59824941/19801189
+export default function useEnumOptionsTranslated<T>(enumObj: T, lookupKey: string, translationScope: string): { name: string, value: T }[] {
+    const { t, i18n } = useTranslation(translationScope);
+    const values = useMemo(() => getEnumOptionsForLanguage(enumObj, lookupKey, t, i18n.language), [i18n.language]);
+    return values;
+}

hooks/enums/useEnumState.tsx

@@ -0,0 +1,21 @@
+import { Dispatch, SetStateAction, useEffect } from "react";
+import useEnumOptionsTranslated from "./useEnumOptionsTranslated";
+import useRefState from "../useRefState";
+import useEnumOptions from "./useEnumOptions";
+import { enumToArrayOptions } from "@/submodules/javascript-functions/general";
+
+export default function useEnumState<T>(enumObj: T, conversionOptions?: enumToArrayOptions): [
+    { name: string, value: T },
+    Dispatch<SetStateAction<{ name: string; value: T; }>>,
+    { name: string, value: T }[]
+] {
+    const options = useEnumOptions(enumObj, conversionOptions);
+    const { state, setState, ref } = useRefState(options[0]);
+    useEffect(() => {
+        if (!ref.current) return;
+        const newOption = options.find(e => e.value == ref.current.value);
+        if (newOption) setState(newOption);
+    }, [options]);
+
+    return [state, setState, options]
+}

hooks/enums/useEnumStateTranslated.tsx

@@ -0,0 +1,23 @@
+import { Dispatch, SetStateAction, useEffect } from "react";
+import useEnumOptionsTranslated from "./useEnumOptionsTranslated";
+import useRefState from "../useRefState";
+//TODO: build one for without translation so we can use it outside of cognition as well
+
+// only works if the corresponding enum is translated in the i18n file with the lookupKey
+// example: cognition-ui> PATExpiresAt
+export default function useEnumStateTranslated<T>(enumObj: T, lookupKey: string, translationScope?: string): [
+    { name: string, value: T },
+    Dispatch<SetStateAction<{ name: string; value: T; }>>,
+    { name: string, value: T }[]
+] {
+    const _translationScope = translationScope || 'enums';
+    const options = useEnumOptionsTranslated(enumObj, lookupKey, _translationScope);
+    const { state, setState, ref } = useRefState(options[0]);
+    useEffect(() => {
+        if (!ref.current) return;
+        const newOption = options.find(e => e.value == ref.current.value);
+        if (newOption) setState(newOption);
+    }, [options]);
+
+    return [state, setState, options]
+}