@cccsaurora/clue-ui 1.3.0-dev.279 → 1.3.0-dev.284

package/database/types.d.ts

@@ -1,13 +1,70 @@
-import { Annotation, Selector, WithExtra } from "../types/lookup";
+import { Annotation, Selector, WithExtra } from 'lib/types/lookup';
 import { RxCollection, RxDatabase, RxDocument } from 'rxdb';
 
 
+/**
+ * Configuration options for the database.
+ */
 export interface DatabaseConfig {
+  /**
+   * The type of storage mechanism to use for persisting database data.
+   * - `'memory'`: Store data in memory (lost on page refresh)
+   * - `'sessionStorage'`: Store data in browser's sessionStorage (persists during session)
+   *
+   * @default 'memory'
+   */
   storageType?: 'memory' | 'sessionStorage';
+
+  /**
+   * Indicates whether the database is running in testing mode.
+   * When enabled, may apply test-specific configurations or disable certain features.
+   *
+   * @default false
+   */
   testing?: boolean;
+
+  /**
+   * Indicates whether the database is running in development mode.
+   * When enabled, provides additional logging and debugging capabilities.
+   *
+   * @default false
+   */
   devMode?: boolean;
+
+  /**
+   * Enables data replication to a remote server.
+   * When enabled, database changes are synchronized with the remote storage.
+   *
+   * @default false
+   */
+  replicate?: boolean;
+
+  /**
+   * The base URL of the clue API server used for replication and remote operations.
+   *
+   * @example 'https://api.clue.example.com'
+   */
+  baseURL?: string;
+
+  /**
+   * Add modify the Axios request configuration before the request is sent
+   *
+   * @param config The existing axios request config
+   */
+  onNetworkCall?: (config: AxiosRequestConfig) => AxiosRequestConfig;
+
+  /**
+   * Get an access token for the clue API. Used during replication.
+   *
+   * @returns An access token valid for use with the clue API.
+   */
+  getToken?: () => string;
 }
 
+export type WithLastUpdated<T> = T & {
+  updated_at: number;
+};
+
 export interface SelectorDocType {
   id: string;
   source: string;

package/hooks/ClueActionContext.js

@@ -1,7 +1,7 @@
 import "react/jsx-runtime";
 import "@mui/material";
-import { g, C } from "../ActionForm-C4mWgND1.js";
-import "../useClueTypeConfig-Z1LFp01b.js";
+import { g, C } from "../ActionForm-Cdo8jBDU.js";
+import "../index-BfslcSud.js";
 import "../components/display/icons/Iconified.js";
 import "../components/ErrorBoundary.js";
 import "../data/event.js";

package/hooks/ClueDatabaseContext.d.ts

@@ -1,9 +1,42 @@
 import { ClueDatabase, DatabaseConfig } from "../database/types";
 import { FC, PropsWithChildren } from 'react';
 
+/**
+ * Context properties for the Clue Database.
+ *
+ * Provides access to the Clue database instance, configuration, and authentication utilities
+ * for interacting with the Clue API.
+ *
+ * @property {ClueDatabase} [database] - The Clue database instance. Optional, may be undefined
+ * if the database is not yet initialized.
+ *
+ * @property {DatabaseConfig} [databaseConfig] - Configuration settings for the database connection.
+ * Optional, may be undefined if configuration has not been loaded.
+ *
+ * @example
+ * ```tsx
+ * const contextProps: ClueDatabaseContextProps = {
+ *   database: myDatabaseInstance,
+ *   databaseConfig: myConfig
+ * };
+ * ```
+ */
 export interface ClueDatabaseContextProps {
+    /**
+     * The Clue Database instance used for data operations and queries. Optional.
+     */
     database?: ClueDatabase;
+    /**
+     * Configuration settings for the database connection and behavior.
+     * Optional - may be undefined if using default database configuration.
+     */
     databaseConfig?: DatabaseConfig;
+    /**
+     * Get an access token for the clue API. Used during replication. Must be a stable reference.
+     *
+     * @returns An access token valid for use with the clue API.
+     */
+    getToken?: () => string;
 }
 export type ClueDatabaseContextType = ClueDatabase;
 export declare const ClueDatabaseContext: import('react').Context<ClueDatabase>;

package/hooks/ClueDatabaseContext.js

@@ -1,18 +1,35 @@
 import { jsx } from "react/jsx-runtime";
-import { b as buildDatabase } from "../index-C12gPw2W.js";
-import { createContext, useState, useEffect } from "react";
+import { b as buildDatabase } from "../index-BXnMCI65.js";
+import { createContext, useState, useRef, useEffect } from "react";
 const ClueDatabaseContext = createContext(null);
 const ClueDatabaseProvider = ({
   children,
   database: _database,
-  databaseConfig
+  databaseConfig,
+  getToken
 }) => {
   const [database, setDatabase] = useState();
+  const getTokenRef = useRef(getToken);
+  useEffect(() => {
+    getTokenRef.current = getToken;
+  }, [getToken]);
   useEffect(() => {
     if (_database) {
       setDatabase(_database);
-    } else {
-      buildDatabase(databaseConfig).then(setDatabase);
+    }
+  }, [_database]);
+  useEffect(() => {
+    let cancelled = false;
+    if (!_database) {
+      console.warn("It is heavily suggested to initialize the database outside of the React component tree.");
+      buildDatabase({ getToken: getTokenRef.current, ...databaseConfig }).then((_db) => {
+        if (!cancelled) {
+          setDatabase(_db);
+        }
+      });
+      return () => {
+        cancelled = true;
+      };
     }
   }, [_database, databaseConfig]);
   return /* @__PURE__ */ jsx(ClueDatabaseContext.Provider, { value: database, children });

package/hooks/ClueEnrichContext.js

@@ -1,14 +1,17 @@
 import "react/jsx-runtime";
 import "../iconify-CXMreGTg.js";
-import "../useClueTypeConfig-Z1LFp01b.js";
+import "../index-BfslcSud.js";
+import "../database/globals.js";
 import "../utils/loggerUtil.js";
-import { C, a } from "../ClueEnrichContext-CJEJxrgs.js";
-import "../debounce-bV0h5FC5.js";
+import { C, a } from "../ClueEnrichContext-CZkS1jpb.js";
+import "../sessionStorage-Dbmo2Exe.js";
 import "../groupBy-xqz-n0Vd.js";
+import "../useClueTypeConfig-DnF4rLsl.js";
 import "react";
 import "../index-AMfoEg_6.js";
 import "./ClueDatabaseContext.js";
 import "./useClueConfig.js";
+import "../_baseUniq-BI9GIHMF.js";
 export {
   C as ClueEnrichContext,
   a as ClueEnrichProvider

package/hooks/ClueFetcherContext.js

@@ -1,5 +1,5 @@
 import { jsx } from "react/jsx-runtime";
-import { a as api } from "../useClueTypeConfig-Z1LFp01b.js";
+import { a as api } from "../index-BfslcSud.js";
 import { SNACKBAR_EVENT_ID } from "../data/event.js";
 import { safeDispatchEvent } from "../utils/window.js";
 import { useState, useRef, useMemo, useCallback, useEffect } from "react";

package/hooks/ClueGroupContext.js

@@ -1,7 +1,7 @@
 import { jsx } from "react/jsx-runtime";
 import { useState, useMemo } from "react";
 import { c as createContext } from "../index-AMfoEg_6.js";
-import { b as useClueEnrichSelector } from "../ActionForm-C4mWgND1.js";
+import { b as useClueEnrichSelector } from "../ActionForm-Cdo8jBDU.js";
 const ClueGroupContext = createContext(null);
 const ClueGroupProvider = ({ children, type, classification }) => {
   const defaultClassification = useClueEnrichSelector((ctx) => ctx.defaultClassification);

package/hooks/CluePopupContext.js

@@ -1,9 +1,9 @@
 import "react/jsx-runtime";
 import "../components/AnnotationDetailPopover.js";
-import { C, a } from "../AnnotationPreview-CEopHIPL.js";
+import { C, a } from "../AnnotationPreview-WuxXgLCE.js";
 import "../data/event.js";
 import "../utils/window.js";
-import "../AnnotationDetails-CFsyeAZD.js";
+import "../AnnotationDetails-CUU61Vwl.js";
 import "react";
 import "../index-AMfoEg_6.js";
 export {

package/hooks/ClueProvider.js

@@ -1,11 +1,11 @@
 import { jsx } from "react/jsx-runtime";
-import { C as ClueActionProvider } from "../ActionForm-C4mWgND1.js";
+import { C as ClueActionProvider } from "../ActionForm-Cdo8jBDU.js";
 import { ClueComponentProvider } from "./ClueComponentContext.js";
 import { ClueConfigProvider } from "./ClueConfigProvider.js";
 import { ClueDatabaseProvider } from "./ClueDatabaseContext.js";
-import { a as ClueEnrichProvider } from "../ClueEnrichContext-CJEJxrgs.js";
+import { a as ClueEnrichProvider } from "../ClueEnrichContext-CZkS1jpb.js";
 import { ClueFetcherProvider } from "./ClueFetcherContext.js";
-import { a as CluePopupProvider } from "../AnnotationPreview-CEopHIPL.js";
+import { a as CluePopupProvider } from "../AnnotationPreview-WuxXgLCE.js";
 const ClueProvider = ({ children, ...props }) => {
   return /* @__PURE__ */ jsx(ClueComponentProvider, { ...props, children: /* @__PURE__ */ jsx(ClueConfigProvider, { config: props.config, children: /* @__PURE__ */ jsx(ClueDatabaseProvider, { ...props, children: /* @__PURE__ */ jsx(ClueEnrichProvider, { ...props, children: /* @__PURE__ */ jsx(ClueFetcherProvider, { ...props, children: /* @__PURE__ */ jsx(ClueActionProvider, { ...props, children: /* @__PURE__ */ jsx(CluePopupProvider, { children }) }) }) }) }) }) });
 };

package/hooks/selectors.js

@@ -1,6 +1,6 @@
-import { a, d, b, c } from "../ActionForm-C4mWgND1.js";
+import { a, d, b, c } from "../ActionForm-Cdo8jBDU.js";
 import "./ClueComponentContext.js";
-import "../ClueEnrichContext-CJEJxrgs.js";
+import "../ClueEnrichContext-CZkS1jpb.js";
 import "./ClueFetcherContext.js";
 import "../index-AMfoEg_6.js";
 export {

package/hooks/useActionResult.js

@@ -1,5 +1,5 @@
 import "react";
-import { f } from "../ActionForm-C4mWgND1.js";
+import { f } from "../ActionForm-Cdo8jBDU.js";
 export {
   f as useActionResult
 };

package/hooks/useAnnotations.js

@@ -1,8 +1,9 @@
-import { u as uniqBy } from "../ClueEnrichContext-CJEJxrgs.js";
+import { u as uniqBy } from "../ClueEnrichContext-CZkS1jpb.js";
 import { useContext, useMemo, useState, useEffect } from "react";
 import { ClueDatabaseContext } from "./ClueDatabaseContext.js";
-import { b as useClueEnrichSelector } from "../ActionForm-C4mWgND1.js";
+import { b as useClueEnrichSelector } from "../ActionForm-Cdo8jBDU.js";
 const useAnnotations = (type, value, _classification, { skipEnrichment } = { skipEnrichment: false }) => {
+  var _a;
   const database = useContext(ClueDatabaseContext);
   const defaultClassification = useClueEnrichSelector((ctx) => ctx.defaultClassification);
   const enrichReady = useClueEnrichSelector((ctx) => ctx.ready);
@@ -15,8 +16,9 @@ const useAnnotations = (type, value, _classification, { skipEnrichment } = { ski
   const [loading, setLoading] = useState(false);
   const [annotations, setAnnotations] = useState([]);
   const ready = useMemo(
-    () => enrichReady && !!type && !!value && !!classification,
-    [classification, enrichReady, type, value]
+    () => enrichReady && !!type && !!value && !!classification && !!(database == null ? void 0 : database.selectors) && !database.selectors.closed,
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    [classification, database == null ? void 0 : database.selectors, (_a = database == null ? void 0 : database.selectors) == null ? void 0 : _a.closed, enrichReady, type, value]
   );
   useEffect(() => {
     if (!ready || !(database == null ? void 0 : database.status)) {

package/hooks/useClue.js

@@ -1,5 +1,5 @@
 import { a as useContext } from "../index-AMfoEg_6.js";
-import { C as ClueEnrichContext } from "../ClueEnrichContext-CJEJxrgs.js";
+import { C as ClueEnrichContext } from "../ClueEnrichContext-CZkS1jpb.js";
 const useClue = () => {
   return useContext(ClueEnrichContext);
 };

package/hooks/useClueActions.js

@@ -1,4 +1,4 @@
-import { u } from "../ActionForm-C4mWgND1.js";
+import { u } from "../ActionForm-Cdo8jBDU.js";
 import "../index-AMfoEg_6.js";
 export {
   u as default

package/hooks/useClueTypeConfig.js

@@ -1,7 +1,8 @@
-import { b } from "../useClueTypeConfig-Z1LFp01b.js";
+import "../index-BfslcSud.js";
 import "../utils/loggerUtil.js";
 import "../_baseUniq-BI9GIHMF.js";
 import "react";
+import { a } from "../useClueTypeConfig-DnF4rLsl.js";
 export {
-  b as default
+  a as default
 };

package/hooks/useErrors.js

@@ -1,6 +1,6 @@
 import { useContext, useState, useEffect } from "react";
 import { ClueDatabaseContext } from "./ClueDatabaseContext.js";
-import { b as useClueEnrichSelector } from "../ActionForm-C4mWgND1.js";
+import { b as useClueEnrichSelector } from "../ActionForm-Cdo8jBDU.js";
 const useErrors = (value) => {
   const database = useContext(ClueDatabaseContext);
   const ready = useClueEnrichSelector((ctx) => ctx.ready);

package/hooks/useFetcherResult.js

@@ -1,5 +1,5 @@
 import { useState, useRef, useMemo, useEffect } from "react";
-import { u as useClueActions } from "../ActionForm-C4mWgND1.js";
+import { u as useClueActions } from "../ActionForm-Cdo8jBDU.js";
 const useActionResult = (resultWithData, interval = 2e3) => {
   const [result, setResult] = useState(resultWithData);
   const timeoutRef = useRef(null);

package/icons/Action.js

@@ -2,8 +2,8 @@ import { jsx, jsxs } from "react/jsx-runtime";
 import { I as Icon } from "../iconify-CXMreGTg.js";
 import { useTheme, Stack, Divider, Typography } from "@mui/material";
 import CountBadge from "../components/CountBadge.js";
-import { C as CluePopupContext } from "../AnnotationPreview-CEopHIPL.js";
-import { u as useClueActions } from "../ActionForm-C4mWgND1.js";
+import { C as CluePopupContext } from "../AnnotationPreview-WuxXgLCE.js";
+import { u as useClueActions } from "../ActionForm-Cdo8jBDU.js";
 import { g as groupBy } from "../groupBy-xqz-n0Vd.js";
 import { memo, useRef, useMemo, useEffect } from "react";
 import { u as useContextSelector } from "../index-AMfoEg_6.js";

package/icons/Assessment.js

@@ -2,7 +2,7 @@ import { jsxs, Fragment, jsx } from "react/jsx-runtime";
 import { I as Icon } from "../iconify-CXMreGTg.js";
 import { useTheme, Stack, Chip, Divider, Grid, Tooltip } from "@mui/material";
 import CountBadge from "../components/CountBadge.js";
-import { C as CluePopupContext } from "../AnnotationPreview-CEopHIPL.js";
+import { C as CluePopupContext } from "../AnnotationPreview-WuxXgLCE.js";
 import { g as groupBy } from "../groupBy-xqz-n0Vd.js";
 import { l as last } from "../last-CUCl67Im.js";
 import { m as maxBy } from "../maxBy-IKHzFrCS.js";

package/icons/Context.js

@@ -4,7 +4,7 @@ import { Stack, Divider } from "@mui/material";
 import AnnotationEntry from "../components/AnnotationEntry.js";
 import CountBadge from "../components/CountBadge.js";
 import Iconified from "../components/display/icons/Iconified.js";
-import { C as CluePopupContext } from "../AnnotationPreview-CEopHIPL.js";
+import { C as CluePopupContext } from "../AnnotationPreview-WuxXgLCE.js";
 import { g as groupBy } from "../groupBy-xqz-n0Vd.js";
 import { memo, useRef, useMemo, useEffect } from "react";
 import { u as useContextSelector } from "../index-AMfoEg_6.js";

package/icons/Opinion.js

@@ -2,7 +2,7 @@ import { jsxs, Fragment, jsx } from "react/jsx-runtime";
 import { I as Icon } from "../iconify-CXMreGTg.js";
 import { useTheme, Stack, Chip, Divider, Grid } from "@mui/material";
 import CountBadge from "../components/CountBadge.js";
-import { C as CluePopupContext } from "../AnnotationPreview-CEopHIPL.js";
+import { C as CluePopupContext } from "../AnnotationPreview-WuxXgLCE.js";
 import { g as groupBy } from "../groupBy-xqz-n0Vd.js";
 import { s as sortBy } from "../sortBy-DfSj8IoJ.js";
 import { s as sumBy } from "../sumBy-D-hb_NY-.js";