@databiosphere/findable-ui 0.0.0

package/src/views/ExportMethodView/exportMethodView.tsx

@@ -0,0 +1,42 @@
+import { useRouter } from "next/router";
+import React from "react";
+import { ComponentCreator } from "../../components/ComponentCreator/ComponentCreator";
+import { BackPageView } from "../../components/Layout/components/BackPage/backPageView";
+import { ExportMethodConfig } from "../../config/entities";
+import { useExportConfig } from "../../hooks/useExportConfig";
+import { useUpdateURLSearchParams } from "../../hooks/useUpdateURLSearchParams";
+
+export const ExportMethodView = (): JSX.Element => {
+  useUpdateURLSearchParams();
+  const { pathname } = useRouter();
+  const { exportMethods, tabs } = useExportConfig();
+  const { sideColumn } = tabs[0];
+  const { mainColumn, top } =
+    getExportMethodConfig(exportMethods, pathname) || {};
+  return (
+    <BackPageView
+      mainColumn={
+        <ComponentCreator components={mainColumn || []} response={{}} />
+      }
+      sideColumn={
+        sideColumn ? (
+          <ComponentCreator components={sideColumn} response={{}} />
+        ) : undefined
+      }
+      top={<ComponentCreator components={top || []} response={{}} />}
+    />
+  );
+};
+
+/**
+ * Returns the export method configuration for the given pathname.
+ * @param exportMethods - Export methods config.
+ * @param pathname - Pathname.
+ * @returns export method configuration.
+ */
+function getExportMethodConfig(
+  exportMethods: ExportMethodConfig[],
+  pathname: string
+): ExportMethodConfig | undefined {
+  return exportMethods.find(({ route }) => route === pathname);
+}

package/src/views/ExportView/exportView.tsx

@@ -0,0 +1,32 @@
+import React from "react";
+import { AzulEntityStaticResponse } from "../../apis/azul/common/entities";
+import { ComponentCreator } from "../../components/ComponentCreator/ComponentCreator";
+import { BackPageView } from "../../components/Layout/components/BackPage/backPageView";
+import { useExploreState } from "../../hooks/useExploreState";
+import { useExportConfig } from "../../hooks/useExportConfig";
+import { useRequestFileManifest } from "../../hooks/useFileManifest/useRequestFileManifest";
+import { useUpdateURLSearchParams } from "../../hooks/useUpdateURLSearchParams";
+
+export type ExportViewProps = AzulEntityStaticResponse;
+
+export const ExportView = (props: ExportViewProps): JSX.Element => {
+  const {
+    exploreState: { filterState },
+  } = useExploreState();
+  useUpdateURLSearchParams();
+  useRequestFileManifest(undefined, filterState, undefined);
+  const { tabs, top } = useExportConfig();
+  const currentTab = tabs[0];
+  const { mainColumn, sideColumn } = currentTab;
+  return (
+    <BackPageView
+      mainColumn={<ComponentCreator components={mainColumn} response={props} />}
+      sideColumn={
+        sideColumn ? (
+          <ComponentCreator components={sideColumn} response={props} />
+        ) : undefined
+      }
+      top={<ComponentCreator components={top} response={props} />}
+    />
+  );
+};

package/src/views/LoginView/loginView.tsx

@@ -0,0 +1,18 @@
+import React from "react";
+import { Login } from "../../components/Login/login";
+import { useAuthenticationConfig } from "../../hooks/useAuthenticationConfig";
+
+export const LoginView = (): JSX.Element => {
+  const { googleGISAuthConfig, termsOfService, text, title, warning } =
+    useAuthenticationConfig();
+
+  return (
+    <Login
+      isGoogle={!!googleGISAuthConfig}
+      termsOfService={termsOfService}
+      text={text}
+      title={title}
+      warning={warning}
+    />
+  );
+};

package/tests/authentication.test.ts

@@ -0,0 +1,136 @@
+import { LOGIN_STATUS_NOT_STARTED } from "../src/hooks/useAuthentication/common/constants";
+import {
+  LoginStatus,
+  REQUEST_STATUS,
+} from "../src/hooks/useAuthentication/common/entities";
+import { GoogleResponse } from "../src/hooks/useAuthentication/useFetchGoogleProfile";
+import { TerraResponse } from "../src/hooks/useAuthentication/useFetchTerraProfile";
+import { TerraTermsOfServiceResponse } from "../src/hooks/useAuthentication/useFetchTerraTermsOfService";
+import { shouldReleaseToken } from "../src/providers/authentication";
+
+describe("authentication", () => {
+  // Boolean constants.
+  const IS_NOT_SUCCESS = false;
+  const IS_NOT_SUPPORTED = false;
+  const IS_SUCCESS = true;
+  const IS_SUPPORTED = true;
+  // Response objects.
+  const GOOGLE_RESPONSE = {} as GoogleResponse;
+  const TERRA_RESPONSE = {} as TerraResponse;
+  const TERRA_TOS_RESPONSE = {} as TerraTermsOfServiceResponse;
+  // Login statuses - not started, not supported.
+  const LOGIN_STATUS_NOT_STARTED_NOT_SUPPORTED_TERRA: LoginStatus<TerraResponse> =
+    {
+      isSuccess: IS_NOT_SUCCESS,
+      isSupported: IS_NOT_SUPPORTED,
+      requestStatus: REQUEST_STATUS.NOT_STARTED,
+      response: TERRA_RESPONSE,
+    };
+  const LOGIN_STATUS_NOT_STARTED_NOT_SUPPORTED_TERRA_TOS: LoginStatus<TerraTermsOfServiceResponse> =
+    {
+      isSuccess: IS_NOT_SUCCESS,
+      isSupported: IS_NOT_SUPPORTED,
+      requestStatus: REQUEST_STATUS.NOT_STARTED,
+      response: TERRA_TOS_RESPONSE,
+    };
+  // Login statuses - not started, supported.
+  const LOGIN_STATUS_NOT_STARTED_SUPPORTED_TERRA =
+    LOGIN_STATUS_NOT_STARTED as LoginStatus<TerraResponse>;
+  const LOGIN_STATUS_NOT_STARTED_SUPPORTED_TERRA_TOS =
+    LOGIN_STATUS_NOT_STARTED as LoginStatus<TerraTermsOfServiceResponse>;
+  const LOGIN_STATUS_NOT_STARTED_SUPPORTED_USER_PROFILE =
+    LOGIN_STATUS_NOT_STARTED as LoginStatus<GoogleResponse>;
+  // Login statuses - completed, not successful.
+  const LOGIN_STATUS_COMPLETED_NOT_SUCCESS_TERRA_TOS: LoginStatus<TerraTermsOfServiceResponse> =
+    {
+      isSuccess: IS_NOT_SUCCESS,
+      isSupported: IS_SUPPORTED,
+      requestStatus: REQUEST_STATUS.COMPLETED,
+      response: TERRA_TOS_RESPONSE,
+    };
+  const LOGIN_STATUS_COMPLETED_NOT_SUCCESS_USER_PROFILE: LoginStatus<GoogleResponse> =
+    {
+      isSuccess: IS_NOT_SUCCESS,
+      isSupported: IS_SUPPORTED,
+      requestStatus: REQUEST_STATUS.COMPLETED,
+      response: GOOGLE_RESPONSE,
+    };
+  // Login statuses - completed, successful.
+  const LOGIN_STATUS_COMPLETED_SUCCESS_TERRA: LoginStatus<TerraResponse> = {
+    isSuccess: IS_SUCCESS,
+    isSupported: IS_SUPPORTED,
+    requestStatus: REQUEST_STATUS.COMPLETED,
+    response: TERRA_RESPONSE,
+  };
+  const LOGIN_STATUS_COMPLETED_SUCCESS_TERRA_TOS: LoginStatus<TerraTermsOfServiceResponse> =
+    {
+      isSuccess: IS_SUCCESS,
+      isSupported: IS_SUPPORTED,
+      requestStatus: REQUEST_STATUS.COMPLETED,
+      response: TERRA_TOS_RESPONSE,
+    };
+  const LOGIN_STATUS_COMPLETED_SUCCESS_USER_PROFILE: LoginStatus<GoogleResponse> =
+    {
+      isSuccess: IS_SUCCESS,
+      isSupported: IS_SUPPORTED,
+      requestStatus: REQUEST_STATUS.COMPLETED,
+      response: GOOGLE_RESPONSE,
+    };
+
+  describe("Should Release Token", () => {
+    describe("shouldReleaseToken", () => {
+      describe("Terra endpoint is configured", () => {
+        test("login not started", () => {
+          const releaseToken = shouldReleaseToken(
+            LOGIN_STATUS_NOT_STARTED_SUPPORTED_USER_PROFILE,
+            LOGIN_STATUS_NOT_STARTED_SUPPORTED_TERRA,
+            LOGIN_STATUS_NOT_STARTED_SUPPORTED_TERRA_TOS
+          );
+          expect(releaseToken).toBeFalsy();
+        });
+        test("login completed and Terra terms of service is not successful", () => {
+          const releaseToken = shouldReleaseToken(
+            LOGIN_STATUS_COMPLETED_SUCCESS_USER_PROFILE,
+            LOGIN_STATUS_COMPLETED_SUCCESS_TERRA,
+            LOGIN_STATUS_COMPLETED_NOT_SUCCESS_TERRA_TOS
+          );
+          expect(releaseToken).toBeFalsy();
+        });
+        test("login completed and Terra terms of service is successful", () => {
+          const releaseToken = shouldReleaseToken(
+            LOGIN_STATUS_COMPLETED_SUCCESS_USER_PROFILE,
+            LOGIN_STATUS_COMPLETED_SUCCESS_TERRA,
+            LOGIN_STATUS_COMPLETED_SUCCESS_TERRA_TOS
+          );
+          expect(releaseToken).toBeTruthy();
+        });
+      });
+      describe("Terra endpoint is not configured", () => {
+        test("login not started", () => {
+          const releaseToken = shouldReleaseToken(
+            LOGIN_STATUS_NOT_STARTED_SUPPORTED_USER_PROFILE,
+            LOGIN_STATUS_NOT_STARTED_NOT_SUPPORTED_TERRA,
+            LOGIN_STATUS_NOT_STARTED_NOT_SUPPORTED_TERRA_TOS
+          );
+          expect(releaseToken).toBeFalsy();
+        });
+        test("user profile is not successful", () => {
+          const releaseToken = shouldReleaseToken(
+            LOGIN_STATUS_COMPLETED_NOT_SUCCESS_USER_PROFILE,
+            LOGIN_STATUS_NOT_STARTED_NOT_SUPPORTED_TERRA,
+            LOGIN_STATUS_NOT_STARTED_NOT_SUPPORTED_TERRA_TOS
+          );
+          expect(releaseToken).toBeFalsy();
+        });
+        test("user profile is successful", () => {
+          const releaseToken = shouldReleaseToken(
+            LOGIN_STATUS_COMPLETED_SUCCESS_USER_PROFILE,
+            LOGIN_STATUS_NOT_STARTED_NOT_SUPPORTED_TERRA,
+            LOGIN_STATUS_NOT_STARTED_NOT_SUPPORTED_TERRA_TOS
+          );
+          expect(releaseToken).toBeTruthy();
+        });
+      });
+    });
+  });
+});

package/tests/filterMenu.test.ts

@@ -0,0 +1,100 @@
+import { applyMenuFilter } from "../src/components/Filter/components/FilterMenu/filterMenu";
+
+const values = [
+  {
+    count: 312,
+    key: "normal",
+    label: "Normal",
+    selected: false,
+  },
+  {
+    count: 0,
+    key: "abscess",
+    label: "abscess",
+    selected: false,
+  },
+  {
+    count: 3,
+    key: "acoustic neuroma",
+    label: "acoustic neuroma",
+    selected: true,
+  },
+  {
+    count: 3,
+    key: "acute kidney failure",
+    label: "acute kidney failure",
+    selected: true,
+  },
+  {
+    count: 3,
+    key: "acute kidney tubular necrosis",
+    label: "acute kidney tubular necrosis",
+    selected: true,
+  },
+  {
+    count: 3,
+    key: "alcohol abuse",
+    label: "alcohol abuse",
+    selected: true,
+  },
+  {
+    count: 3,
+    key: "Alzheimer disease",
+    label: "Alzheimer disease",
+    selected: true,
+  },
+  {
+    count: 3,
+    key: "amyotrophic lateral sclerosis",
+    label: "amyotrophic lateral sclerosis",
+    selected: true,
+  },
+  {
+    count: 1,
+    key: "anxiety disorder",
+    label: "anxiety disorder",
+    selected: true,
+  },
+  {
+    count: 3,
+    key: "aplastic anemia",
+    label: "aplastic anemia",
+    selected: true,
+  },
+  {
+    count: 3,
+    key: "arthritis",
+    label: "arthritis",
+    selected: true,
+  },
+  {
+    count: 3,
+    key: "asthma",
+    label: "asthma",
+    selected: true,
+  },
+  {
+    count: 222,
+    key: "atherosclerosis",
+    label: "atherosclerosis",
+    selected: false,
+  },
+  {
+    count: 222,
+    key: "atrial fibrillation",
+    label: "atrial fibrillation",
+    selected: true,
+  },
+  {
+    count: 222,
+    key: "benign prostatic hyperplasia",
+    label: "benign prostatic hyperplasia",
+    selected: true,
+  },
+];
+
+test("applyMenuFilter", () => {
+  expect(applyMenuFilter(values, "ro").map(({ value }) => value)).toStrictEqual(
+    [values[2], values[4], values[7], values[12], values[14]]
+  );
+});

package/tests/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "compilerOptions": {
+    "rootDir": "../"
+  },
+  "extends": "../tsconfig.json",
+  "include": ["./**/*.ts"]
+}

package/tests/useAuthenticationStatus.test.ts

@@ -0,0 +1,155 @@
+import {
+  LOGIN_STATUS_NOT_STARTED,
+  LOGIN_STATUS_NOT_SUPPORTED,
+} from "../src/hooks/useAuthentication/common/constants";
+import {
+  AUTHENTICATION_STATUS,
+  LoginResponse,
+  LoginStatus,
+  REQUEST_STATUS,
+} from "../src/hooks/useAuthentication/common/entities";
+import { getAuthenticationStatus } from "../src/hooks/useAuthentication/useAuthenticationStatus";
+
+const TEST_LOGIN_IS_COMPLETE = "login is complete";
+const TEST_LOGIN_NOT_STARTED = "login not started";
+const TEST_USER_PROFILE_AND_TERRA_AND_TOS_IS_COMPLETE =
+  "user profile, terra and terms of service is complete";
+const TEST_USER_PROFILE_AND_TERRA_IS_COMPLETE =
+  "user profile and terra is complete";
+const TEST_USER_PROFILE_IS_COMPLETE = "user profile is complete";
+
+describe("useAuthenticationStatus", () => {
+  // Login statuses - completed, successful.
+  const LOGIN_STATUS_COMPLETED_SUCCESS: LoginStatus<LoginResponse> = {
+    isSuccess: true,
+    isSupported: true,
+    requestStatus: REQUEST_STATUS.COMPLETED,
+    response: {} as LoginResponse,
+  };
+
+  describe("Calculate Authentication Status", () => {
+    describe("getAuthenticationStatus", () => {
+      describe("endpoints are configured", () => {
+        test(TEST_LOGIN_NOT_STARTED, () => {
+          const authenticationStatus = getAuthenticationStatus([
+            LOGIN_STATUS_NOT_STARTED,
+            LOGIN_STATUS_NOT_STARTED,
+            LOGIN_STATUS_NOT_STARTED,
+            LOGIN_STATUS_NOT_STARTED,
+          ]);
+          expect(authenticationStatus).toEqual(
+            AUTHENTICATION_STATUS.INCOMPLETE
+          );
+        });
+        test(TEST_USER_PROFILE_IS_COMPLETE, () => {
+          const authenticationStatus = getAuthenticationStatus([
+            LOGIN_STATUS_NOT_STARTED,
+            LOGIN_STATUS_NOT_STARTED,
+            LOGIN_STATUS_NOT_STARTED,
+            LOGIN_STATUS_COMPLETED_SUCCESS,
+          ]);
+          expect(authenticationStatus).toEqual(
+            AUTHENTICATION_STATUS.INCOMPLETE
+          );
+        });
+        test(TEST_USER_PROFILE_AND_TERRA_IS_COMPLETE, () => {
+          const authenticationStatus = getAuthenticationStatus([
+            LOGIN_STATUS_NOT_STARTED,
+            LOGIN_STATUS_COMPLETED_SUCCESS,
+            LOGIN_STATUS_NOT_STARTED,
+            LOGIN_STATUS_COMPLETED_SUCCESS,
+          ]);
+          expect(authenticationStatus).toEqual(
+            AUTHENTICATION_STATUS.INCOMPLETE
+          );
+        });
+        test(TEST_USER_PROFILE_AND_TERRA_AND_TOS_IS_COMPLETE, () => {
+          const authenticationStatus = getAuthenticationStatus([
+            LOGIN_STATUS_NOT_STARTED,
+            LOGIN_STATUS_COMPLETED_SUCCESS,
+            LOGIN_STATUS_COMPLETED_SUCCESS,
+            LOGIN_STATUS_COMPLETED_SUCCESS,
+          ]);
+          expect(authenticationStatus).toEqual(
+            AUTHENTICATION_STATUS.INCOMPLETE
+          );
+        });
+        test(TEST_LOGIN_IS_COMPLETE, () => {
+          const authenticationStatus = getAuthenticationStatus([
+            LOGIN_STATUS_COMPLETED_SUCCESS,
+            LOGIN_STATUS_COMPLETED_SUCCESS,
+            LOGIN_STATUS_COMPLETED_SUCCESS,
+            LOGIN_STATUS_COMPLETED_SUCCESS,
+          ]);
+          expect(authenticationStatus).toEqual(AUTHENTICATION_STATUS.COMPLETED);
+        });
+      });
+      describe("NIH endpoint is not configured", () => {
+        test(TEST_LOGIN_NOT_STARTED, () => {
+          const authenticationStatus = getAuthenticationStatus([
+            LOGIN_STATUS_NOT_SUPPORTED,
+            LOGIN_STATUS_NOT_STARTED,
+            LOGIN_STATUS_NOT_STARTED,
+            LOGIN_STATUS_NOT_STARTED,
+          ]);
+          expect(authenticationStatus).toEqual(
+            AUTHENTICATION_STATUS.INCOMPLETE
+          );
+        });
+        test(TEST_USER_PROFILE_IS_COMPLETE, () => {
+          const authenticationStatus = getAuthenticationStatus([
+            LOGIN_STATUS_NOT_SUPPORTED,
+            LOGIN_STATUS_NOT_STARTED,
+            LOGIN_STATUS_NOT_STARTED,
+            LOGIN_STATUS_COMPLETED_SUCCESS,
+          ]);
+          expect(authenticationStatus).toEqual(
+            AUTHENTICATION_STATUS.INCOMPLETE
+          );
+        });
+        test(TEST_USER_PROFILE_AND_TERRA_IS_COMPLETE, () => {
+          const authenticationStatus = getAuthenticationStatus([
+            LOGIN_STATUS_NOT_SUPPORTED,
+            LOGIN_STATUS_COMPLETED_SUCCESS,
+            LOGIN_STATUS_NOT_STARTED,
+            LOGIN_STATUS_COMPLETED_SUCCESS,
+          ]);
+          expect(authenticationStatus).toEqual(
+            AUTHENTICATION_STATUS.INCOMPLETE
+          );
+        });
+        test(TEST_LOGIN_IS_COMPLETE, () => {
+          const authenticationStatus = getAuthenticationStatus([
+            LOGIN_STATUS_NOT_SUPPORTED,
+            LOGIN_STATUS_COMPLETED_SUCCESS,
+            LOGIN_STATUS_COMPLETED_SUCCESS,
+            LOGIN_STATUS_COMPLETED_SUCCESS,
+          ]);
+          expect(authenticationStatus).toEqual(AUTHENTICATION_STATUS.COMPLETED);
+        });
+      });
+      describe("Terra endpoint is not configured", () => {
+        test(TEST_LOGIN_NOT_STARTED, () => {
+          const authenticationStatus = getAuthenticationStatus([
+            LOGIN_STATUS_NOT_SUPPORTED,
+            LOGIN_STATUS_NOT_SUPPORTED,
+            LOGIN_STATUS_NOT_SUPPORTED,
+            LOGIN_STATUS_NOT_STARTED,
+          ]);
+          expect(authenticationStatus).toEqual(
+            AUTHENTICATION_STATUS.INCOMPLETE
+          );
+        });
+        test(TEST_LOGIN_IS_COMPLETE, () => {
+          const authenticationStatus = getAuthenticationStatus([
+            LOGIN_STATUS_NOT_SUPPORTED,
+            LOGIN_STATUS_NOT_SUPPORTED,
+            LOGIN_STATUS_NOT_SUPPORTED,
+            LOGIN_STATUS_COMPLETED_SUCCESS,
+          ]);
+          expect(authenticationStatus).toEqual(AUTHENTICATION_STATUS.COMPLETED);
+        });
+      });
+    });
+  });
+});

package/tests/viewModelBuilders_utils.test.ts

@@ -0,0 +1,58 @@
+import {
+  sanitizeString,
+  sanitizeStringArray,
+} from "../src/viewModelBuilders/common/utils";
+
+// sanitizeString tests:
+
+test('sanitize "" to "Unspecified"', () => {
+  expect(sanitizeString("")).toBe("Unspecified");
+});
+
+test('sanitize null to "Unspecified"', () => {
+  expect(sanitizeString(null as any)).toBe("Unspecified");
+});
+
+test('sanitize undefined to "Unspecified"', () => {
+  expect(sanitizeString(undefined as any)).toBe("Unspecified");
+});
+
+test('sanitize "example" with no change', () => {
+  expect(sanitizeString("example")).toBe("example");
+});
+
+// sanitizeStringArray tests:
+
+test('sanitize null string array to ["Unspecified"]', () => {
+  expect(sanitizeStringArray(null as any)).toStrictEqual(["Unspecified"]);
+});
+
+test('sanitize empty string array to ["Unspecified"]', () => {
+  expect(sanitizeStringArray([])).toStrictEqual(["Unspecified"]);
+});
+
+test("sanitize string array containing null, undefined, and empty string values", () => {
+  expect(
+    sanitizeStringArray([
+      "a",
+      "",
+      null,
+      "b",
+      "c",
+      undefined,
+      null,
+      "d",
+      "e",
+    ] as any)
+  ).toStrictEqual([
+    "a",
+    "Unspecified",
+    "Unspecified",
+    "b",
+    "c",
+    "Unspecified",
+    "Unspecified",
+    "d",
+    "e",
+  ]);
+});

package/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "target": "es6",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "esModuleInterop": true,
+    "module": "CommonJS",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "jsx": "react",
+    "baseUrl": "./src",
+    "rootDir": "./src",
+    "outDir": "lib",
+    "declaration": true
+  },
+  "include": ["src/**/*.ts", "src/**/*.tsx", "types/*.d.ts"],
+  "exclude": ["node_modules"]
+}