climb-onyx-gui 0.13.0 → 0.14.0-dev.10

package/dist/types.d.ts

@@ -1,45 +1,99 @@
-type ProjectField = {
-    type: string;
+export declare enum RecordTabKeys {
+    Data = "record-data-tab",
+    History = "record-history-tab",
+    Analyses = "record-analyses-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"
+}
+export declare enum DataPanelTabKeys {
+    Details = "data-panel-details"
+}
+export declare enum ExportStatus {
+    READY = 0,
+    RUNNING = 1,
+    WRITING = 2,
+    FINISHED = 3,
+    CANCELLED = 4,
+    ERROR = 5
+}
+export type FieldType = "text" | "choice" | "integer" | "decimal" | "date" | "datetime" | "bool" | "relation" | "array" | "structure" | "";
+export type GraphType = "line" | "bar" | "pie" | "";
+export type ProjectField = {
+    type: FieldType;
     description: string;
     actions: string[];
     values?: string[];
     fields?: Record<string, ProjectField>;
 };
-type FilterField = {
+export type FilterConfig = {
     key: string;
+    type: FieldType;
     field: string;
     lookup: string;
     value: string;
 };
-type OptionType = {
-    label: string;
-    value: string;
-};
-type ResultType = Record<string, string | number | boolean | object | null>;
-type ErrorType = Record<string, string | string[]>;
-type ResultData = {
-    status: string;
-    code: number;
-    next?: string;
-    previous?: string;
-    data?: ResultType[];
-    messages?: ErrorType;
-};
-declare enum ExportStatus {
-    READY = 0,
-    RUNNING = 1,
-    WRITING = 2,
-    FINISHED = 3,
-    CANCELLED = 4,
-    ERROR = 5
-}
-type GraphConfig = {
+export type GraphConfig = {
     key: string;
-    type: string;
+    type: GraphType;
     field: string;
     groupBy: string;
     groupMode: string;
+    filters: FilterConfig[];
     yAxisType: string;
 };
-export type { ProjectField, FilterField, OptionType, ResultType, ErrorType, ResultData, GraphConfig, };
-export { ExportStatus };
+export type TypeObject = {
+    type: FieldType;
+    lookups: string[];
+};
+export type LookupObject = {
+    lookup: string;
+    description: string;
+};
+export type ChoiceDescription = {
+    description: string;
+    is_active: boolean;
+};
+export type OptionType = {
+    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 interface ErrorResponse {
+    status: "fail" | "error";
+    code: number;
+    messages: ErrorType;
+}
+export interface SuccessResponse {
+    status: "success";
+    code: number;
+}
+export interface ListResponse extends SuccessResponse {
+    data: RecordType[];
+    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>;
+}

package/dist/utils/functions.d.ts

@@ -0,0 +1,17 @@
+import { ExportHandlerProps, OnyxProps } from '../interfaces';
+import { 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;
+}
+/** Handler for converting JSON data to a string for file export. */
+declare function handleJSONExport(props: DetailResponseProps): (exportProps: ExportHandlerProps) => void;
+/** Takes an array of FilterConfig objects and formats into an array of field (+lookup), value pairs. */
+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 { formatFilters, formatResponseStatus, generateKey, getDefaultFileNamePrefix, handleJSONExport, };

package/dist/utils/hooks.d.ts

@@ -0,0 +1,3 @@
+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 };

package/dist/utils/messages.d.ts

@@ -0,0 +1,4 @@
+export declare const s3BucketsMessage = "If you haven't already, please make sure you have clicked the 'Get Started With S3 Buckets' button under the 'S3 Buckets' tab on BRYN.";
+export declare const recentActivityMessage = "Your most recent API requests will be listed here. If you see anything suspicious, please contact CLIMB-TRE support immediately.";
+export declare const errorModalMessage = "Please try again or contact CLIMB-TRE support if the problem persists.";
+export declare const defaultExportProgressMessage = "Fetching items...";

package/dist/utils/{graphStyles.d.ts → styles.d.ts}

@@ -1,3 +1,6 @@
+import { StylesConfig } from 'react-select';
+
+declare const selectStyles: StylesConfig;
 declare const graphStyles: {
     layout: {
         font: {
@@ -15,4 +18,4 @@ declare const graphStyles: {
         };
     };
 };
-export default graphStyles;
+export { graphStyles, selectStyles };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "climb-onyx-gui",
-  "version": "0.13.0",
+  "version": "0.14.0-dev.10",
   "type": "module",
   "main": "dist/climb-onyx-gui.js",
   "types": "dist/main.d.ts",
@@ -23,8 +23,11 @@
     "@ag-grid-community/csv-export": "^32.2.0",
     "@ag-grid-community/react": "^32.2.0",
     "@ag-grid-community/styles": "^32.2.0",
+    "@fontsource/ibm-plex-sans": "^5.1.1",
     "@tanstack/react-query": "^4.36.1",
     "export-to-csv": "^1.3.0",
+    "http-status-codes": "^2.3.0",
+    "json-edit-react": "^1.22.6",
     "plotly.js-basic-dist": "^2.33.0",
     "react-bootstrap": "^2.10.2",
     "react-icons": "^5.3.0",

package/dist/components/RecordModal.d.ts

@@ -1,9 +0,0 @@
-import { DataProps } from '../interfaces';
-
-interface RecordModalProps extends DataProps {
-    recordID: string;
-    show: boolean;
-    onHide: () => void;
-}
-declare function RecordModal(props: RecordModalProps): import("react/jsx-runtime").JSX.Element;
-export default RecordModal;

package/dist/pages/Data.d.ts

@@ -1,4 +0,0 @@
-import { DataProps } from '../interfaces';
-
-declare function Data(props: DataProps): import("react/jsx-runtime").JSX.Element;
-export default Data;

package/dist/pages/Stats.d.ts

@@ -1,4 +0,0 @@
-import { StatsProps } from '../interfaces';
-
-declare function Stats(props: StatsProps): import("react/jsx-runtime").JSX.Element;
-export default Stats;

package/dist/utils/errorMessages.d.ts

@@ -1 +0,0 @@
-export declare const s3BucketsMessage = "If you haven't already, please make sure you have clicked the 'Get Started With S3 Buckets' button under the 'S3 Buckets' tab on BRYN.";

package/dist/utils/generateKey.d.ts

@@ -1,2 +0,0 @@
-declare function generateKey(): string;
-export default generateKey;

package/dist/utils/selectStyles.d.ts

@@ -1,4 +0,0 @@
-import { StylesConfig } from 'react-select';
-
-declare const selectStyles: StylesConfig;
-export default selectStyles;