@databiosphere/findable-ui 0.0.0

package/lib/hooks/useAuthentication/useFetchTerraNIHProfile.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useFetchTerraNIHProfile = void 0;
+const react_1 = require("react");
+const useAuthenticationConfig_1 = require("../useAuthenticationConfig");
+const constants_1 = require("./common/constants");
+const entities_1 = require("./common/entities");
+const utils_1 = require("./common/utils");
+/**
+ * Returns Terra NIH login status from configured endpoint.
+ * @param token - Token.
+ * @returns Terra NIH login status.
+ */
+const useFetchTerraNIHProfile = (token) => {
+    const authenticationConfig = (0, useAuthenticationConfig_1.useAuthenticationConfig)();
+    const { terraAuthConfig: { terraNIHProfileEndpoint: endpoint } = {} } = authenticationConfig;
+    const [loginStatus, setLoginStatus] = (0, react_1.useState)((0, utils_1.initLoginStatus)(endpoint));
+    // Fetch Terra NIH account profile.
+    const fetchEndpointData = (0, react_1.useCallback)((endpoint, accessToken) => {
+        fetch(endpoint, (0, utils_1.getAuthenticationRequestOptions)(accessToken))
+            .then((response) => response.json())
+            .then((response) => {
+            if (isResponseError(response)) {
+                setLoginStatus(constants_1.LOGIN_STATUS_FAILED);
+            }
+            else {
+                setLoginStatus((prevStatus) => (Object.assign(Object.assign({}, prevStatus), { isSuccess: isResponseSuccess(response), requestStatus: entities_1.REQUEST_STATUS.COMPLETED, response })));
+            }
+        })
+            .catch((err) => {
+            console.log(err); // TODO handle error.
+            setLoginStatus(constants_1.LOGIN_STATUS_FAILED);
+        });
+    }, []);
+    // Fetches Terra NIH account profile.
+    (0, react_1.useEffect)(() => {
+        if (!token)
+            return;
+        if (!endpoint)
+            return;
+        fetchEndpointData(endpoint, token);
+    }, [endpoint, fetchEndpointData, token]);
+    return loginStatus;
+};
+exports.useFetchTerraNIHProfile = useFetchTerraNIHProfile;
+/**
+ * Returns true if response is an error response.
+ * @param response - Response.
+ * @returns true if response is an error response.
+ */
+function isResponseError(response) {
+    return Boolean(response.statusCode);
+}
+/**
+ * Returns true if the user accepted terms of service version is current.
+ * @param response - Response.
+ * @returns true if response is successful.
+ */
+function isResponseSuccess(response) {
+    return Boolean(response.linkedNihUsername);
+}

package/lib/hooks/useAuthentication/useFetchTerraProfile.d.ts

@@ -0,0 +1,24 @@
+import { LoginStatus } from "./common/entities";
+declare type Status = LoginStatus<TerraResponse>;
+export interface TerraResponse {
+    enabled: TerraResponseEnabled;
+    userInfo: TerraResponseUserInfo;
+}
+interface TerraResponseEnabled {
+    adminEnabled: boolean;
+    allUsersGroup: boolean;
+    google: boolean;
+    ldap: boolean;
+    tosAccepted: boolean;
+}
+interface TerraResponseUserInfo {
+    userEmail: string;
+    userSubjectId: string;
+}
+/**
+ * Returns Terra profile login status from configured endpoint.
+ * @param token - Token.
+ * @returns Terra profile login status.
+ */
+export declare const useFetchTerraProfile: (token?: string | undefined) => Status;
+export {};

package/lib/hooks/useAuthentication/useFetchTerraProfile.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useFetchTerraProfile = void 0;
+const react_1 = require("react");
+const useAuthenticationConfig_1 = require("../useAuthenticationConfig");
+const constants_1 = require("./common/constants");
+const entities_1 = require("./common/entities");
+const utils_1 = require("./common/utils");
+/**
+ * Returns Terra profile login status from configured endpoint.
+ * @param token - Token.
+ * @returns Terra profile login status.
+ */
+const useFetchTerraProfile = (token) => {
+    const authenticationConfig = (0, useAuthenticationConfig_1.useAuthenticationConfig)();
+    const { terraAuthConfig: { terraProfileEndpoint: endpoint } = {} } = authenticationConfig;
+    const [loginStatus, setLoginStatus] = (0, react_1.useState)((0, utils_1.initLoginStatus)(endpoint));
+    // Fetch Terra profile.
+    const fetchEndpointData = (0, react_1.useCallback)((endpoint, accessToken) => {
+        fetch(endpoint, (0, utils_1.getAuthenticationRequestOptions)(accessToken))
+            .then((response) => response.json())
+            .then((response) => {
+            if (isResponseError(response)) {
+                setLoginStatus(constants_1.LOGIN_STATUS_FAILED);
+            }
+            else {
+                setLoginStatus((prevStatus) => (Object.assign(Object.assign({}, prevStatus), { isSuccess: isResponseSuccess(response), requestStatus: entities_1.REQUEST_STATUS.COMPLETED, response: response })));
+            }
+        })
+            .catch((err) => {
+            console.log(err); // TODO handle error.
+            setLoginStatus(constants_1.LOGIN_STATUS_FAILED);
+        });
+    }, []);
+    // Fetches Terra profile.
+    (0, react_1.useEffect)(() => {
+        if (!token)
+            return;
+        if (!endpoint)
+            return;
+        fetchEndpointData(endpoint, token);
+    }, [endpoint, fetchEndpointData, token]);
+    return loginStatus;
+};
+exports.useFetchTerraProfile = useFetchTerraProfile;
+/**
+ * Returns true if response is an error response.
+ * @param response - Response.
+ * @returns true if response is an error response.
+ */
+function isResponseError(response) {
+    return Boolean(response.statusCode);
+}
+/**
+ * Returns true if response is enabled.
+ * @param response - Response.
+ * @returns true if response is successful.
+ */
+function isResponseSuccess(response) {
+    var _a;
+    return Boolean((_a = response.enabled) === null || _a === void 0 ? void 0 : _a.google);
+}

package/lib/hooks/useAuthentication/useFetchTerraTermsOfService.d.ts

@@ -0,0 +1,15 @@
+import { LoginStatus } from "./common/entities";
+declare type Status = LoginStatus<TerraTermsOfServiceResponse>;
+export interface TerraTermsOfServiceResponse {
+    currentVersion: string;
+    isEnabled: boolean;
+    isGracePeriodEnabled: boolean;
+    userAcceptedVersion?: string;
+}
+/**
+ * Returns Terra terms of service login status from configured endpoint.
+ * @param token - Token.
+ * @returns Terra terms of service login status.
+ */
+export declare const useFetchTerraTermsOfService: (token?: string | undefined) => Status;
+export {};

package/lib/hooks/useAuthentication/useFetchTerraTermsOfService.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useFetchTerraTermsOfService = void 0;
+const react_1 = require("react");
+const useAuthenticationConfig_1 = require("../useAuthenticationConfig");
+const constants_1 = require("./common/constants");
+const entities_1 = require("./common/entities");
+const utils_1 = require("./common/utils");
+/**
+ * Returns Terra terms of service login status from configured endpoint.
+ * @param token - Token.
+ * @returns Terra terms of service login status.
+ */
+const useFetchTerraTermsOfService = (token) => {
+    const authenticationConfig = (0, useAuthenticationConfig_1.useAuthenticationConfig)();
+    const { terraAuthConfig: { termsOfServiceEndpoint: endpoint } = {} } = authenticationConfig;
+    const [loginStatus, setLoginStatus] = (0, react_1.useState)((0, utils_1.initLoginStatus)(endpoint));
+    // Fetch Terra terms of service.
+    const fetchEndpointData = (0, react_1.useCallback)((endpoint, accessToken) => {
+        fetch(endpoint, (0, utils_1.getAuthenticationRequestOptions)(accessToken))
+            .then((response) => response.json())
+            .then((response) => {
+            if (isResponseError(response)) {
+                setLoginStatus(constants_1.LOGIN_STATUS_FAILED);
+            }
+            else {
+                setLoginStatus((prevStatus) => (Object.assign(Object.assign({}, prevStatus), { isSuccess: isResponseSuccess(response), requestStatus: entities_1.REQUEST_STATUS.COMPLETED, response })));
+            }
+        })
+            .catch((err) => {
+            console.log(err); // TODO handle error.
+            setLoginStatus(constants_1.LOGIN_STATUS_FAILED);
+        });
+    }, []);
+    // Fetches Terra terms of service.
+    (0, react_1.useEffect)(() => {
+        if (!token)
+            return;
+        if (!endpoint)
+            return;
+        fetchEndpointData(endpoint, token);
+    }, [endpoint, fetchEndpointData, token]);
+    return loginStatus;
+};
+exports.useFetchTerraTermsOfService = useFetchTerraTermsOfService;
+/**
+ * Returns true if response is an error response.
+ * @param response - Response.
+ * @returns true if response is an error response.
+ */
+function isResponseError(response) {
+    return Boolean(response.statusCode);
+}
+/**
+ * Returns true if the user accepted terms of service version is current.
+ * @param response - Response.
+ * @returns true if response is successful.
+ */
+function isResponseSuccess(response) {
+    return Boolean(response.currentVersion === response.userAcceptedVersion);
+}

package/lib/hooks/useAuthentication/useTokenClient.d.ts

@@ -0,0 +1,11 @@
+declare type TokenClient = any;
+export interface UseTokenClient {
+    token: string | undefined;
+    tokenClient: TokenClient | undefined;
+}
+/**
+ * Initializes the token client, sets token from token client callback.
+ * @returns initialized token client.
+ */
+export declare const useTokenClient: () => UseTokenClient;
+export {};

package/lib/hooks/useAuthentication/useTokenClient.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useTokenClient = void 0;
+const react_1 = require("react");
+const useAuthenticationConfig_1 = require("../useAuthenticationConfig");
+/**
+ * Initializes the token client, sets token from token client callback.
+ * @returns initialized token client.
+ */
+const useTokenClient = () => {
+    const [token, setToken] = (0, react_1.useState)();
+    const [tokenClient, setTokenClient] = (0, react_1.useState)();
+    const authenticationConfig = (0, useAuthenticationConfig_1.useAuthenticationConfig)();
+    const { googleGISAuthConfig: { clientId, scope } = {} } = authenticationConfig;
+    // Initializes token client - (authorization client id must be configured).
+    (0, react_1.useEffect)(() => {
+        if (clientId) {
+            setTokenClient(google.accounts.oauth2.initTokenClient({
+                callback: (tokenResponse) => {
+                    const access_token = tokenResponse.access_token;
+                    setToken(access_token);
+                },
+                client_id: clientId,
+                scope,
+            }));
+        }
+    }, [clientId, scope]);
+    return {
+        token,
+        tokenClient,
+    };
+};
+exports.useTokenClient = useTokenClient;

package/lib/hooks/useAuthenticationConfig.d.ts

@@ -0,0 +1,6 @@
+import { AuthenticationConfig } from "../config/entities";
+/**
+ * Hook to get the authentication config
+ * @returns @see AuthenticationConfig used in the current config.
+ */
+export declare const useAuthenticationConfig: () => AuthenticationConfig;

package/lib/hooks/useAuthenticationConfig.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useAuthenticationConfig = void 0;
+const useConfig_1 = require("./useConfig");
+/**
+ * Hook to get the authentication config
+ * @returns @see AuthenticationConfig used in the current config.
+ */
+const useAuthenticationConfig = () => {
+    const { config } = (0, useConfig_1.useConfig)();
+    if (!config.authentication) {
+        return {
+            title: "",
+        };
+    }
+    return config.authentication;
+};
+exports.useAuthenticationConfig = useAuthenticationConfig;

package/lib/hooks/useBreakpointHelper.d.ts

@@ -0,0 +1,14 @@
+import { Breakpoint } from "@mui/material";
+/**
+ * Hook utilising Mui's breakpoint helper (media query hook).
+ * https://mui.com/material-ui/react-use-media-query/#using-muis-breakpoint-helpers
+ */
+export declare enum BREAKPOINT_FN_NAME {
+    DOWN = "down",
+    ONLY = "only",
+    UP = "up"
+}
+declare type BreakpointFnName = BREAKPOINT_FN_NAME;
+declare type BreakpointKey = Breakpoint;
+export declare const useBreakpointHelper: (fnName: BreakpointFnName, breakpointKey: BreakpointKey) => boolean;
+export {};

package/lib/hooks/useBreakpointHelper.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useBreakpointHelper = exports.BREAKPOINT_FN_NAME = void 0;
+const material_1 = require("@mui/material");
+/**
+ * Hook utilising Mui's breakpoint helper (media query hook).
+ * https://mui.com/material-ui/react-use-media-query/#using-muis-breakpoint-helpers
+ */
+var BREAKPOINT_FN_NAME;
+(function (BREAKPOINT_FN_NAME) {
+    BREAKPOINT_FN_NAME["DOWN"] = "down";
+    BREAKPOINT_FN_NAME["ONLY"] = "only";
+    BREAKPOINT_FN_NAME["UP"] = "up";
+})(BREAKPOINT_FN_NAME = exports.BREAKPOINT_FN_NAME || (exports.BREAKPOINT_FN_NAME = {}));
+const useBreakpointHelper = (fnName, breakpointKey) => {
+    return (0, material_1.useMediaQuery)((theme) => theme.breakpoints[fnName](breakpointKey));
+};
+exports.useBreakpointHelper = useBreakpointHelper;

package/lib/hooks/useCatalog.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Returns configured catalog value.
+ * @returns catalog value.
+ */
+export declare const useCatalog: () => string | undefined;

package/lib/hooks/useCatalog.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useCatalog = void 0;
+const useConfig_1 = require("./useConfig");
+const useExploreState_1 = require("./useExploreState");
+/**
+ * Returns configured catalog value.
+ * @returns catalog value.
+ */
+const useCatalog = () => {
+    const { config } = (0, useConfig_1.useConfig)();
+    const { exploreState: { catalogState }, } = (0, useExploreState_1.useExploreState)();
+    const { dataSource } = config;
+    const { defaultParams } = dataSource || {};
+    const { catalog } = defaultParams || {};
+    return catalogState || catalog;
+};
+exports.useCatalog = useCatalog;

package/lib/hooks/useCategoryConfigs.d.ts

@@ -0,0 +1,6 @@
+import { CategoryConfig } from "../config/entities";
+/**
+ * Returns configured grouped configured categories as a list of configured categories.
+ * @returns a list of configured categories.
+ */
+export declare const useCategoryConfigs: () => CategoryConfig[] | undefined;

package/lib/hooks/useCategoryConfigs.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useCategoryConfigs = void 0;
+const react_1 = require("react");
+const useConfig_1 = require("./useConfig");
+/**
+ * Returns configured grouped configured categories as a list of configured categories.
+ * @returns a list of configured categories.
+ */
+const useCategoryConfigs = () => {
+    const { config } = (0, useConfig_1.useConfig)();
+    const { categoryGroupConfigs } = config;
+    return (0, react_1.useMemo)(() => {
+        return categoryGroupConfigs === null || categoryGroupConfigs === void 0 ? void 0 : categoryGroupConfigs.flatMap(({ categoryConfigs }) => categoryConfigs);
+    }, [categoryGroupConfigs]);
+};
+exports.useCategoryConfigs = useCategoryConfigs;

package/lib/hooks/useCategoryFilter.d.ts

@@ -0,0 +1,35 @@
+import { CategoryKey, CategoryValueKey, Filters, SelectCategory, SelectCategoryView } from "../common/entities";
+import { CategoryConfig } from "../config/entities";
+/**
+ * State backing filter functionality and calculations. Converted to view model for display.
+ */
+export declare type FilterState = Filters;
+/**
+ * Shape of return value from this useCategoryFilter hook.
+ */
+export interface FilterInstance {
+    categories: SelectCategoryView[];
+    filter: FilterState;
+    onFilter: OnFilterFn;
+}
+/**
+ * Function invoked when selected state of a category value is toggled or range is selected.
+ */
+export declare type OnFilterFn = (categoryKey: CategoryKey, selectedCategoryValue: CategoryValueKey, selected: boolean, categorySection?: string, searchTerm?: string) => void;
+/**
+ * Build view-specific models from filter state, to facilitate easy rendering.
+ * @param categories - Categories, category value and their counts with the current filter applied.
+ * @param categoryConfigs - Category configs indicating accept list as well as label configuration.
+ * @param filterState - Current set of selected category and category values.
+ * @returns Array of category view objects.
+ */
+export declare function buildCategoryViews(categories: SelectCategory[], categoryConfigs: CategoryConfig[] | undefined, filterState: FilterState): SelectCategoryView[];
+/**
+ * Build new set of selected filters on de/select of filter.
+ * @param filterState - Current set of selected category and category values.
+ * @param categoryKey - Key of category that has been de/selected.
+ * @param selectedValue - Key of category value that has been de/selected
+ * @param selected - True if value is selected, false if de-selected.
+ * @returns New filter state generated from the current set of selected values and the newly selected value.
+ */
+export declare function buildNextFilterState(filterState: FilterState, categoryKey: CategoryKey, selectedValue: CategoryValueKey, selected: boolean): FilterState;

package/lib/hooks/useCategoryFilter.js

@@ -0,0 +1,158 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildNextFilterState = exports.buildCategoryViews = void 0;
+const constants_1 = require("../common/constants");
+/**
+ * Build the view-specific model of the given category value.
+ * @param categoryValue - The category value to build a view model of.
+ * @param categorySelectedFilter - Current filter state for a category.
+ * @returns Full built category value view, ready for display.
+ */
+function buildCategoryValueView(categoryValue, categorySelectedFilter) {
+    // Determine if the category value is currently selected.
+    const selected = isCategoryValueSelected(categoryValue.key, categorySelectedFilter);
+    // Build view model.
+    return {
+        count: categoryValue.count,
+        key: categoryValue.key,
+        label: categoryValue.label,
+        selected,
+    };
+}
+/**
+ * Build the view-specific model of the given category, including the category label pulled from the config.
+ * @param category - The category to build a view model of.
+ * @param categoryValueViews - Set of category value view models for the given category.
+ * @param categoryConfigs - Category configs indicating accept list as well as label configuration.
+ * @returns Full built category value view, ready for display.
+ */
+function buildCategoryView(category, categoryValueViews, categoryConfigs) {
+    return {
+        isDisabled: false,
+        key: category.key,
+        label: getCategoryLabel(category.key, categoryConfigs),
+        values: categoryValueViews,
+    };
+}
+/**
+ * Build view-specific models from filter state, to facilitate easy rendering.
+ * @param categories - Categories, category value and their counts with the current filter applied.
+ * @param categoryConfigs - Category configs indicating accept list as well as label configuration.
+ * @param filterState - Current set of selected category and category values.
+ * @returns Array of category view objects.
+ */
+function buildCategoryViews(categories, categoryConfigs, filterState) {
+    if (!categories || !categoryConfigs) {
+        return [];
+    }
+    // Determine the set of categories to display.
+    const acceptListCategories = categories.filter((category) => isCategoryAcceptListed(category, categoryConfigs));
+    // Build view models for each category.
+    const views = acceptListCategories.map((category) => {
+        // Get the set of selected values for this category, if any.
+        const categorySelectedFilter = getCategorySelectedFilter(category.key, filterState);
+        // Build view models for each category value in this category and sort alpha.
+        const categoryValueViews = category.values.map((categoryValue) => buildCategoryValueView(categoryValue, categorySelectedFilter));
+        categoryValueViews.sort(sortCategoryValueViews);
+        // Build category view model.
+        return buildCategoryView(category, categoryValueViews, categoryConfigs);
+    });
+    // Sort and return category views.
+    views.sort(sortCategoryViews);
+    return views;
+}
+exports.buildCategoryViews = buildCategoryViews;
+/**
+ * Build new set of selected filters on de/select of filter.
+ * @param filterState - Current set of selected category and category values.
+ * @param categoryKey - Key of category that has been de/selected.
+ * @param selectedValue - Key of category value that has been de/selected
+ * @param selected - True if value is selected, false if de-selected.
+ * @returns New filter state generated from the current set of selected values and the newly selected value.
+ */
+function buildNextFilterState(filterState, categoryKey, selectedValue, selected) {
+    // Check if the selected category already has selected values.
+    const categorySelectedFilter = getCategorySelectedFilter(categoryKey, filterState);
+    // Create a copy of the current filter state. Remove the selected filter for the selected category, if any.
+    const nextFilterState = filterState.filter((selectedFilter) => selectedFilter !== categorySelectedFilter);
+    // Create new selected filter for this category. Copy values currently selected for this category, if any.
+    const nextCategorySelectedFilter = {
+        categoryKey,
+        value: categorySelectedFilter ? [...categorySelectedFilter.value] : [],
+    };
+    // Handle case where category value is selected.
+    if (selected) {
+        nextCategorySelectedFilter.value.push(selectedValue);
+    }
+    // Otherwise, category value has been de-selected; remove the selected value from the selected set of values.
+    else {
+        nextCategorySelectedFilter.value = nextCategorySelectedFilter.value.filter((value) => value !== selectedValue);
+    }
+    // Add the new selected filter for this category to the set of selected filters, if there are selected values for it.
+    if (nextCategorySelectedFilter.value.length) {
+        nextFilterState.push(nextCategorySelectedFilter);
+    }
+    return nextFilterState;
+}
+exports.buildNextFilterState = buildNextFilterState;
+/**
+ * Get the selected values for the given category, if any.
+ * @param categoryKey - Key of category to check if it has any selected category values.
+ * @param filterState - Current set of selected category and category values.
+ * @returns The selected filter (i.e. the set of selected values) for the given category.
+ */
+function getCategorySelectedFilter(categoryKey, filterState) {
+    return filterState.find((filter) => filter.categoryKey === categoryKey);
+}
+/**
+ * Get the label for the given category key as per the config.
+ * @param key - Key of category to find label of.
+ * @param categoryConfigs - Category accept list.
+ * @returns the display value for the given category.
+ */
+function getCategoryLabel(key, categoryConfigs) {
+    const categoryConfig = categoryConfigs.find((categoryConfig) => categoryConfig.key === key);
+    if (!categoryConfig) {
+        return key;
+    }
+    return categoryConfig.label;
+}
+/**
+ * Determine if given category value is selected.
+ * @param categoryValueKey - The key of the category value to check if selected in the filter state.
+ * @param categorySelectedFilter - Current filter state for a category.
+ * @returns True if category value is in the set of currently selected values.
+ */
+function isCategoryValueSelected(categoryValueKey, categorySelectedFilter) {
+    if (!categorySelectedFilter) {
+        return false;
+    }
+    return categorySelectedFilter.value.includes(categoryValueKey);
+}
+/**
+ * Determine if category is to be included in filter.
+ * @param category - Category to check if included in accept list.
+ * @param categoryConfigs - Category accept list.
+ * @returns true if category is to be included in filter.
+ */
+function isCategoryAcceptListed(category, categoryConfigs) {
+    return categoryConfigs.some((categoryConfig) => categoryConfig.key === category.key);
+}
+/**
+ * Sort category value views by key, ascending.
+ * @param cvv0 - First category value view to compare.
+ * @param cvv1 - Second category value view to compare.
+ * @returns Number indicating sort precedence of cv0 vs cv1.
+ */
+function sortCategoryValueViews(cvv0, cvv1) {
+    return constants_1.COLLATOR_CASE_INSENSITIVE.compare(cvv0.label, cvv1.label);
+}
+/**
+ * Sort category views by display label, ascending.
+ * @param c0 - First category view to compare.
+ * @param c1 - Second category view to compare.
+ * @returns Number indicating sort precedence of c0 vs c1.
+ */
+function sortCategoryViews(c0, c1) {
+    return constants_1.COLLATOR_CASE_INSENSITIVE.compare(c0.label, c1.label);
+}

package/lib/hooks/useConfig.d.ts

@@ -0,0 +1,6 @@
+import { ConfigContextProps } from "../providers/config";
+/**
+ * Returns configuration context.
+ * @returns configuration context.
+ */
+export declare const useConfig: () => ConfigContextProps;

package/lib/hooks/useConfig.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useConfig = void 0;
+const react_1 = require("react");
+const config_1 = require("../providers/config");
+/**
+ * Returns configuration context.
+ * @returns configuration context.
+ */
+const useConfig = () => {
+    return (0, react_1.useContext)(config_1.ConfigContext);
+};
+exports.useConfig = useConfig;

package/lib/hooks/useCurrentDetailTab.d.ts

@@ -0,0 +1,13 @@
+import { BackPageTabConfig } from "../config/entities";
+/**
+ * Model of current selected tab and the tab's corresponding route in the set of tabs.
+ */
+export interface CurrentDetailTab {
+    currentTab: BackPageTabConfig;
+    route: string;
+}
+/**
+ * Hook to get the current tab and its route that will be used to create the detail page.
+ * @returns Current tab and current tab route.
+ */
+export declare const useCurrentDetailTab: () => CurrentDetailTab;

package/lib/hooks/useCurrentDetailTab.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useCurrentDetailTab = void 0;
+const router_1 = require("next/router");
+const constants_1 = require("../common/constants");
+const useConfig_1 = require("./useConfig");
+/**
+ * Hook to get the current tab and its route that will be used to create the detail page.
+ * @returns Current tab and current tab route.
+ */
+const useCurrentDetailTab = () => {
+    var _a, _b;
+    const router = (0, router_1.useRouter)();
+    const { entityConfig } = (0, useConfig_1.useConfig)();
+    const { detail } = entityConfig;
+    const { tabs } = detail;
+    const tabRoute = (_b = (_a = router.query.params) === null || _a === void 0 ? void 0 : _a[constants_1.PARAMS_INDEX_TAB]) !== null && _b !== void 0 ? _b : "";
+    const currentTab = tabs.find(({ route }) => route === tabRoute) || tabs[0];
+    return {
+        currentTab,
+        route: tabRoute,
+    };
+};
+exports.useCurrentDetailTab = useCurrentDetailTab;

package/lib/hooks/useDownloadStatus.d.ts

@@ -0,0 +1,10 @@
+export interface DownloadStatus {
+    disabled: boolean;
+    isLoading: boolean;
+    message: string | null;
+}
+/**
+ * Returns download status.
+ * @returns download status.
+ */
+export declare const useDownloadStatus: () => DownloadStatus;