climb-onyx-gui/dist/types.d.ts

Onyx Graphical User Interface

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 {
    LIST = "record-list-tab",
    DETAIL = "record-detail-tab"
}
export declare enum AnalysisTabKeys {
    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"
}
export declare enum GraphPanelTabKeys {
    GRAPH = "graph-panel-graph",
    FILTERS = "graph-panel-filters",
    DISPLAY = "graph-panel-display"
}
export declare enum ExportStatus {
    READY = 0,
    RUNNING = 1,
    WRITING = 2,
    FINISHED = 3,
    CANCELLED = 4,
    ERROR = 5
}
export type ObjectType = "record" | "analysis";
export type TabState = {
    tabKey: OnyxTabKeys;
    recordTabKey: RecordTabKeys;
    recordDetailTabKey: RecordDetailTabKeys;
    recordDataPanelTabKey: DataPanelTabKeys;
    recordID: string;
    analysisTabKey: AnalysisTabKeys;
    analysisDetailTabKey: AnalysisDetailTabKeys;
    analysisDataPanelTabKey: DataPanelTabKeys;
    analysisID: string;
};
export type RecentlyViewed = {
    objectType: ObjectType;
    ID: string;
    timestamp: string;
};
export type FieldType = "text" | "choice" | "integer" | "decimal" | "date" | "datetime" | "bool" | "relation" | "array" | "structure" | "";
export type GraphType = "line" | "bar" | "pie" | "";
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, Field>;
};
export type Fields = {
    name: string;
    description: string;
    fields: Record<string, Field>;
    default_fields?: string[];
};
export type FilterConfig = {
    key: string;
    type: FieldType;
    field: string;
    lookup: string;
    value: string;
};
export type GraphConfig = {
    key: string;
    type: GraphType;
    field: string;
    groupBy: string;
    groupMode: string;
    filters: FilterConfig[];
    yAxisType: string;
};
export type TypeObject = {
    type: FieldType;
    lookups: string[];
};
export type Lookup = {
    lookup: string;
    description: string;
};
export type ChoiceDescription = {
    description: string;
    is_active: boolean;
};
export type Choices = Record<string, ChoiceDescription>;
export type SelectOption = {
    label: string;
    value: string;
};
export type RecordType = Record<string, string | number | boolean | object | null | RecordType[]>;
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: ErrorMessages;
}
export interface SuccessResponse {
    status: "success";
    code: number;
}
export interface ListResponse<T> extends SuccessResponse {
    data: T[];
    next: string | null;
    previous: string | null;
}
export interface DetailResponse<T> extends SuccessResponse {
    data: T;
}