climb-onyx-gui 0.14.3 → 0.15.0

package/dist/types.d.ts

@@ -1,17 +1,47 @@
+export declare enum Themes {
+    LIGHT = "light",
+    DARK = "dark"
+}
+export declare enum DarkModeColours {
+    BS_BODY_COLOR = "#dee2e6",// Bootstrap body text color for dark mode
+    BS_BODY_BG = "#121212",// Bootstrap body background color for dark mode
+    BS_GRAY_600 = "#6c757d",// Bootstrap gray-600 for dark mode
+    BS_GRAY_900 = "#212529"
+}
+export declare enum OnyxTabKeys {
+    USER = "user-tab",
+    SITE = "site-tab",
+    RECORDS = "records-tab",
+    ANALYSES = "analyses-tab",
+    GRAPHS = "graphs-tab"
+}
 export declare enum RecordTabKeys {
-    Data = "record-data-tab",
-    History = "record-history-tab",
-    Analyses = "record-analyses-tab"
+    LIST = "record-list-tab",
+    DETAIL = "record-detail-tab"
 }
 export declare enum AnalysisTabKeys {
-    Data = "analysis-data-tab",
-    History = "analysis-history-tab",
-    Records = "analysis-records-tab",
-    Upstream = "analysis-upstream-tab",
-    Downstream = "analysis-downstream-tab"
+    LIST = "analysis-list-tab",
+    DETAIL = "analysis-detail-tab"
+}
+export declare enum RecordDetailTabKeys {
+    DATA = "record-detail-data-tab",
+    HISTORY = "record-detail-history-tab",
+    ANALYSES = "record-detail-analyses-tab"
+}
+export declare enum AnalysisDetailTabKeys {
+    DATA = "analysis-detail-data-tab",
+    HISTORY = "analysis-detail-history-tab",
+    RECORDS = "analysis-detail-records-tab",
+    UPSTREAM = "analysis-detail-upstream-tab",
+    DOWNSTREAM = "analysis-detail-downstream-tab"
 }
 export declare enum DataPanelTabKeys {
-    Details = "data-panel-details"
+    DETAILS = "data-panel-details"
+}
+export declare enum GraphPanelTabKeys {
+    GRAPH = "graph-panel-graph",
+    FILTERS = "graph-panel-filters",
+    DISPLAY = "graph-panel-display"
 }
 export declare enum ExportStatus {
     READY = 0,
@@ -21,14 +51,52 @@ export declare enum ExportStatus {
     CANCELLED = 4,
     ERROR = 5
 }
+export type TabState = {
+    tabKey: OnyxTabKeys;
+    recordTabKey: RecordTabKeys;
+    recordDetailTabKey: RecordDetailTabKeys;
+    recordDataPanelTabKey: DataPanelTabKeys;
+    recordID: string;
+    analysisTabKey: AnalysisTabKeys;
+    analysisDetailTabKey: AnalysisDetailTabKeys;
+    analysisDataPanelTabKey: DataPanelTabKeys;
+    analysisID: string;
+};
+export type RecentlyViewed = {
+    ID: string;
+    timestamp: Date;
+    handleShowID: (id: string) => void;
+};
 export type FieldType = "text" | "choice" | "integer" | "decimal" | "date" | "datetime" | "bool" | "relation" | "array" | "structure" | "";
 export type GraphType = "line" | "bar" | "pie" | "";
-export type ProjectField = {
+export type Profile = {
+    username: string;
+    site: string;
+    email: string;
+};
+export type Project = {
+    code: string;
+    name: string;
+};
+export type ProjectPermissionGroup = {
+    project: string;
+    name: string;
+    scope: string;
+    actions: string[];
+};
+export type Field = {
     type: FieldType;
+    code: string;
     description: string;
     actions: string[];
     values?: string[];
-    fields?: Record<string, ProjectField>;
+    fields?: Record<string, Field>;
+};
+export type Fields = {
+    name: string;
+    description: string;
+    fields: Record<string, Field>;
+    default_fields?: string[];
 };
 export type FilterConfig = {
     key: string;
@@ -50,7 +118,7 @@ export type TypeObject = {
     type: FieldType;
     lookups: string[];
 };
-export type LookupObject = {
+export type Lookup = {
     lookup: string;
     description: string;
 };
@@ -58,42 +126,37 @@ export type ChoiceDescription = {
     description: string;
     is_active: boolean;
 };
-export type OptionType = {
+export type Choices = Record<string, ChoiceDescription>;
+export type SelectOption = {
     label: string;
     value: string;
 };
-export type ErrorType = Record<string, string | string[]>;
 export type RecordType = Record<string, string | number | boolean | object | null | RecordType[]>;
-export type SummaryType = Record<"count", number> & Record<string, string | number | boolean | object | null>;
-export type ProjectPermissionType = {
-    project: string;
-    scope: string;
-    actions: string[];
+export type HistoricalEntry = {
+    username?: string;
+    timestamp: string;
+    action: "add" | "change" | "delete";
+    changes: RecordType[];
+};
+export type HistoricalEntries = {
+    history: HistoricalEntry[];
 };
+export type Summary = Record<"count", number> & Record<string, string | number | boolean | object | null>;
+export type ErrorMessages = Record<string, string | string[]>;
 export interface ErrorResponse {
     status: "fail" | "error";
     code: number;
-    messages: ErrorType;
+    messages: ErrorMessages;
 }
 export interface SuccessResponse {
     status: "success";
     code: number;
 }
-export interface ListResponse extends SuccessResponse {
-    data: RecordType[];
+export interface ListResponse<T> extends SuccessResponse {
+    data: T[];
     next: string | null;
     previous: string | null;
 }
-export interface DetailResponse extends SuccessResponse {
-    data: RecordType;
-}
-export interface FieldsResponse extends SuccessResponse {
-    data: {
-        name: string;
-        description: string;
-        fields: Record<string, ProjectField>;
-    };
-}
-export interface ChoicesResponse extends SuccessResponse {
-    data: Record<string, ChoiceDescription>;
+export interface DetailResponse<T> extends SuccessResponse {
+    data: T;
 }

package/dist/utils/functions.d.ts

@@ -1,12 +1,12 @@
 import { ExportHandlerProps, OnyxProps } from '../interfaces';
-import { DetailResponse, ErrorResponse, FilterConfig } from '../types';
+import { RecordType, DetailResponse, ErrorResponse, FilterConfig } from '../types';
 
 /** Returns a random hexadecimal string. */
 declare function generateKey(): string;
 /** Generate a default file name prefix based on the project code and search parameters. */
 declare function getDefaultFileNamePrefix(project: string, searchParameters: string): string;
 interface DetailResponseProps extends OnyxProps {
-    response: DetailResponse | ErrorResponse | undefined;
+    response: DetailResponse<RecordType> | ErrorResponse | undefined;
 }
 /** Handler for converting JSON data to a string for file export. */
 declare function handleJSONExport(props: DetailResponseProps): (exportProps: ExportHandlerProps) => void;
@@ -14,4 +14,5 @@ declare function handleJSONExport(props: DetailResponseProps): (exportProps: Exp
 declare function formatFilters(filters: FilterConfig[]): string[][];
 /** Takes a Response object and returns its status code, formatted as a string. */
 declare function formatResponseStatus(response: Response): string;
+export declare function formatTimeAgo(timestamp: Date): string;
 export { formatFilters, formatResponseStatus, generateKey, getDefaultFileNamePrefix, handleJSONExport, };

package/dist/utils/hooks.d.ts

@@ -1,3 +1,4 @@
-declare const useDebouncedValue: (inputValue: string, delay: number) => string;
-declare const useQueryRefresh: (refresh: number | null, dataUpdatedAt: number, errorUpdatedAt: number, refetch: () => void, setLastUpdated: (lastUpdated: string | null) => void) => void;
-export { useDebouncedValue, useQueryRefresh };
+export declare const useDebouncedValue: (inputValue: string, delay: number) => string;
+export declare const useDelayedValue: (delay?: number) => boolean;
+export declare const useCyclicValue: (start: number, end: number, pause?: number) => number;
+export declare const useQueryRefresh: (refresh: number | null, dataUpdatedAt: number, errorUpdatedAt: number, refetch: () => void, setLastUpdated: (lastUpdated: string | null) => void) => void;

package/dist/utils/styles.d.ts

@@ -1,21 +1,6 @@
 import { StylesConfig } from 'react-select';
+import { Template } from 'plotly.js-basic-dist';
 
 declare const selectStyles: StylesConfig;
-declare const graphStyles: {
-    layout: {
-        font: {
-            color: string;
-        };
-        paper_bgcolor: string;
-        plot_bgcolor: string;
-        xaxis: {
-            gridcolor: string;
-            zerolinecolor: string;
-        };
-        yaxis: {
-            gridcolor: string;
-            zerolinecolor: string;
-        };
-    };
-};
+declare const graphStyles: Template;
 export { graphStyles, selectStyles };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "climb-onyx-gui",
-  "version": "0.14.3",
+  "version": "0.15.0",
   "description": "Onyx Graphical User Interface",
   "keywords": [
     "gui",

package/dist/components/History.d.ts

@@ -1,9 +0,0 @@
-import { PageProps } from '../interfaces';
-
-interface HistoryProps extends PageProps {
-    name?: string;
-    searchPath: string;
-    ID: string;
-}
-declare function History(props: HistoryProps): import("react/jsx-runtime").JSX.Element;
-export default History;

package/dist/components/Transforms.d.ts

@@ -1,12 +0,0 @@
-import { DataProps } from '../interfaces';
-
-interface TransformsProps extends DataProps {
-    transform: string;
-    transformList: string[];
-    setTransformList: (value: string[]) => void;
-    filterFieldOptions: string[];
-    listFieldOptions: string[];
-    setEditMode: (value: boolean) => void;
-}
-declare function Transforms(props: TransformsProps): import("react/jsx-runtime").JSX.Element;
-export default Transforms;

package/dist/components/TransformsPanel.d.ts

@@ -1,12 +0,0 @@
-import { DataProps } from '../interfaces';
-
-interface TransformsPanelProps extends DataProps {
-    transform: string;
-    setTransform: (value: string) => void;
-    transformList: string[];
-    setTransformList: (value: string[]) => void;
-    filterFieldOptions: string[];
-    listFieldOptions: string[];
-}
-declare function TransformsPanel(props: TransformsPanelProps): import("react/jsx-runtime").JSX.Element;
-export default TransformsPanel;