locust-ui 1.0.0-beta

package/lib/types/redux/slice/url.slice.d.ts

@@ -0,0 +1,20 @@
+import { PayloadAction } from '../../@reduxjs/toolkit';
+
+export interface IUrlState {
+    query: {
+        [key: string]: string;
+    } | null;
+}
+export type UrlAction = PayloadAction<Partial<IUrlState>>;
+export declare const urlActions: import('../../@reduxjs/toolkit').CaseReducerActions<{
+    setUrl: (state: IUrlState, { payload }: {
+        payload: Partial<IUrlState>;
+        type: string;
+    }) => IUrlState & (boolean | import('../../logViewer.slice').ILogViewerState | import('../../notification.slice').INotificationState | Partial<import('../../swarm.slice').ISwarmState> | Partial<import('../../ui.slice').IUiState> | Partial<IUrlState> | undefined);
+}, "url">;
+declare const _default: import('..').Reducer<{
+    query: {
+        [key: string]: string;
+    } | null;
+}>;
+export default _default;

package/lib/types/redux/store.d.ts

@@ -0,0 +1,75 @@
+import { configureStore } from '../@reduxjs/toolkit';
+
+export declare const store: import('../@reduxjs/toolkit').EnhancedStore<{
+    api: import('../@reduxjs/toolkit/query').CombinedState<{
+        getStats: import('../@reduxjs/toolkit/query').QueryDefinition<void, import('../@reduxjs/toolkit/query').BaseQueryFn<string | import('../@reduxjs/toolkit/query').FetchArgs, unknown, import('../@reduxjs/toolkit/query').FetchBaseQueryError, {}, import('../@reduxjs/toolkit/query').FetchBaseQueryMeta>, never, import('../../types/ui.types').IStatsResponse, "api">;
+        getTasks: import('../@reduxjs/toolkit/query').QueryDefinition<void, import('../@reduxjs/toolkit/query').BaseQueryFn<string | import('../@reduxjs/toolkit/query').FetchArgs, unknown, import('../@reduxjs/toolkit/query').FetchBaseQueryError, {}, import('../@reduxjs/toolkit/query').FetchBaseQueryMeta>, never, import('../../types/ui.types').ISwarmRatios, "api">;
+        getExceptions: import('../@reduxjs/toolkit/query').QueryDefinition<void, import('../@reduxjs/toolkit/query').BaseQueryFn<string | import('../@reduxjs/toolkit/query').FetchArgs, unknown, import('../@reduxjs/toolkit/query').FetchBaseQueryError, {}, import('../@reduxjs/toolkit/query').FetchBaseQueryMeta>, never, import('../../types/ui.types').ISwarmExceptionsResponse, "api">;
+        getLogs: import('../@reduxjs/toolkit/query').QueryDefinition<void, import('../@reduxjs/toolkit/query').BaseQueryFn<string | import('../@reduxjs/toolkit/query').FetchArgs, unknown, import('../@reduxjs/toolkit/query').FetchBaseQueryError, {}, import('../@reduxjs/toolkit/query').FetchBaseQueryMeta>, never, import('../../types/ui.types').ILogsResponse, "api">;
+        startSwarm: import('../@reduxjs/toolkit/query').MutationDefinition<any, import('../@reduxjs/toolkit/query').BaseQueryFn<string | import('../@reduxjs/toolkit/query').FetchArgs, unknown, import('../@reduxjs/toolkit/query').FetchBaseQueryError, {}, import('../@reduxjs/toolkit/query').FetchBaseQueryMeta>, never, any, "api">;
+        updateUserSettings: import('../@reduxjs/toolkit/query').MutationDefinition<any, import('../@reduxjs/toolkit/query').BaseQueryFn<string | import('../@reduxjs/toolkit/query').FetchArgs, unknown, import('../@reduxjs/toolkit/query').FetchBaseQueryError, {}, import('../@reduxjs/toolkit/query').FetchBaseQueryMeta>, never, any, "api">;
+    }, never, "api">;
+    logViewer: {
+        master: string[];
+        workers: {};
+    };
+    notification: {};
+    swarm: import('../slice/swarm.slice').ISwarmState;
+    theme: {
+        isDarkMode: boolean;
+    };
+    ui: {
+        totalRps: number;
+        failRatio: number;
+        startTime: string;
+        stats: import('../../types/ui.types').ISwarmStat[];
+        errors: import('../../types/ui.types').ISwarmError[];
+        exceptions: import('../../types/ui.types').ISwarmException[];
+        charts: import('../../types/ui.types').ICharts;
+        ratios: import('../../types/ui.types').ISwarmRatios;
+        userCount: number;
+    };
+    url: {
+        query: {
+            [key: string]: string;
+        } | null;
+    };
+}, import('.').UnknownAction, import('../@reduxjs/toolkit').Tuple<[import('.').StoreEnhancer<{
+    dispatch: import('../redux-thunk').ThunkDispatch<{
+        api: import('../@reduxjs/toolkit/query').CombinedState<{
+            getStats: import('../@reduxjs/toolkit/query').QueryDefinition<void, import('../@reduxjs/toolkit/query').BaseQueryFn<string | import('../@reduxjs/toolkit/query').FetchArgs, unknown, import('../@reduxjs/toolkit/query').FetchBaseQueryError, {}, import('../@reduxjs/toolkit/query').FetchBaseQueryMeta>, never, import('../../types/ui.types').IStatsResponse, "api">;
+            getTasks: import('../@reduxjs/toolkit/query').QueryDefinition<void, import('../@reduxjs/toolkit/query').BaseQueryFn<string | import('../@reduxjs/toolkit/query').FetchArgs, unknown, import('../@reduxjs/toolkit/query').FetchBaseQueryError, {}, import('../@reduxjs/toolkit/query').FetchBaseQueryMeta>, never, import('../../types/ui.types').ISwarmRatios, "api">;
+            getExceptions: import('../@reduxjs/toolkit/query').QueryDefinition<void, import('../@reduxjs/toolkit/query').BaseQueryFn<string | import('../@reduxjs/toolkit/query').FetchArgs, unknown, import('../@reduxjs/toolkit/query').FetchBaseQueryError, {}, import('../@reduxjs/toolkit/query').FetchBaseQueryMeta>, never, import('../../types/ui.types').ISwarmExceptionsResponse, "api">;
+            getLogs: import('../@reduxjs/toolkit/query').QueryDefinition<void, import('../@reduxjs/toolkit/query').BaseQueryFn<string | import('../@reduxjs/toolkit/query').FetchArgs, unknown, import('../@reduxjs/toolkit/query').FetchBaseQueryError, {}, import('../@reduxjs/toolkit/query').FetchBaseQueryMeta>, never, import('../../types/ui.types').ILogsResponse, "api">;
+            startSwarm: import('../@reduxjs/toolkit/query').MutationDefinition<any, import('../@reduxjs/toolkit/query').BaseQueryFn<string | import('../@reduxjs/toolkit/query').FetchArgs, unknown, import('../@reduxjs/toolkit/query').FetchBaseQueryError, {}, import('../@reduxjs/toolkit/query').FetchBaseQueryMeta>, never, any, "api">;
+            updateUserSettings: import('../@reduxjs/toolkit/query').MutationDefinition<any, import('../@reduxjs/toolkit/query').BaseQueryFn<string | import('../@reduxjs/toolkit/query').FetchArgs, unknown, import('../@reduxjs/toolkit/query').FetchBaseQueryError, {}, import('../@reduxjs/toolkit/query').FetchBaseQueryMeta>, never, any, "api">;
+        }, never, "api">;
+        logViewer: {
+            master: string[];
+            workers: {};
+        };
+        notification: {};
+        swarm: import('../slice/swarm.slice').ISwarmState;
+        theme: {
+            isDarkMode: boolean;
+        };
+        ui: {
+            totalRps: number;
+            failRatio: number;
+            startTime: string;
+            stats: import('../../types/ui.types').ISwarmStat[];
+            errors: import('../../types/ui.types').ISwarmError[];
+            exceptions: import('../../types/ui.types').ISwarmException[];
+            charts: import('../../types/ui.types').ICharts;
+            ratios: import('../../types/ui.types').ISwarmRatios;
+            userCount: number;
+        };
+        url: {
+            query: {
+                [key: string]: string;
+            } | null;
+        };
+    }, undefined, import('.').UnknownAction>;
+}>, import('.').StoreEnhancer]>>;
+export type { IRootState, Action } from './slice/root.slice';
+export default configureStore;

package/lib/types/redux/utils.d.ts

@@ -0,0 +1,3 @@
+import { Action } from './store';
+
+export declare function updateStateWithPayload<ReducerState, ActionType extends Action = Action>(state: ReducerState, { payload }: ActionType): ReducerState & (boolean | import('../slice/logViewer.slice').ILogViewerState | import('../slice/notification.slice').INotificationState | Partial<import('../slice/swarm.slice').ISwarmState> | Partial<import('../slice/ui.slice').IUiState> | Partial<import('../slice/url.slice').IUrlState> | undefined);

package/lib/types/styles/theme.d.ts

@@ -0,0 +1,4 @@
+import { PaletteMode } from '../@mui/material';
+
+declare const createTheme: (mode: PaletteMode) => import('../@mui/material').Theme;
+export default createTheme;

package/lib/types/types/auth.types.d.ts

@@ -0,0 +1,10 @@
+export interface IAuthProviders {
+    label: string;
+    iconUrl: string;
+    callbackUrl: string;
+}
+export interface IAuthArgs {
+    usernamePasswordCallback?: string;
+    error?: string;
+    authProviders?: IAuthProviders[];
+}

package/lib/types/types/swarm.types.d.ts

@@ -0,0 +1,46 @@
+import { ICharts, ISwarmError, ISwarmStat, IResponseTime, ISwarmRatios, ISwarmException } from './ui.types';
+
+export interface IExtraOptionParameter {
+    choices: string[] | null;
+    defaultValue: string | number | boolean | null;
+    helpText: string | null;
+    isSecret: boolean;
+}
+export interface IExtraOptions {
+    [key: string]: IExtraOptionParameter;
+}
+export interface IHistory {
+    currentRps: [string, number];
+    currentFailPerSec: [string, number];
+    userCount: [string, number];
+    currentResponseTimePercentiles: {
+        [key: `responseTimePercentile${number}`]: [string, number | null];
+    };
+    totalAvgResponseTime: [string, number];
+    time: string;
+}
+export interface IReport {
+    locustfile: string;
+    showDownloadLink: boolean;
+    startTime: string;
+    endTime: string;
+    host: string;
+    charts: ICharts;
+    requestsStatistics: ISwarmStat[];
+    failuresStatistics: ISwarmError[];
+    responseTimeStatistics: IResponseTime[];
+    exceptionsStatistics: ISwarmException[];
+    tasks: ISwarmRatios;
+}
+export interface IReportTemplateArgs extends Omit<IReport, 'charts'> {
+    history: IHistory[];
+    isReport?: boolean;
+    percentilesToChart: number[];
+    percentilesToStatistics: number[];
+}
+export interface ISwarmUser {
+    fixedCount: number;
+    host: string;
+    weight: number;
+    tasks: string[];
+}

package/lib/types/types/tab.types.d.ts

@@ -0,0 +1,9 @@
+import { ComponentType } from '../react';
+import { IRootState } from '../redux/store';
+
+export interface ITab<TabType = string> {
+    component?: ComponentType;
+    key: TabType;
+    title: string;
+    shouldDisplayTab?: (state: IRootState) => boolean;
+}

package/lib/types/types/table.types.d.ts

@@ -0,0 +1,6 @@
+export interface ITableStructure {
+    key: string;
+    title: string;
+    round?: number;
+    markdown?: boolean;
+}

package/lib/types/types/ui.types.d.ts

@@ -0,0 +1,96 @@
+import { ILineChartMarkers } from '../components/LineChart/LineChart.types';
+import { SWARM_STATE } from '../constants/swarm';
+
+export type SwarmState = (typeof SWARM_STATE)[keyof typeof SWARM_STATE];
+export interface ISwarmStat {
+    avgContentLength: number;
+    avgResponseTime: number;
+    currentFailPerSec: number;
+    currentRps: number;
+    maxResponseTime: number;
+    medianResponseTime: number;
+    method: 'GET' | 'POST' | 'PUT' | 'DELETE';
+    minResponseTime: number;
+    name: string;
+    [key: `responseTimePercentile${number}`]: number;
+    numFailures: number;
+    numRequests: number;
+    safeName: string;
+}
+export interface ISwarmError {
+    method: 'GET' | 'POST' | 'PUT' | 'DELETE';
+    name: string;
+    occurrences: number;
+}
+export interface ISwarmException {
+    count: number;
+    msg: string;
+    nodes: string;
+    traceback: string;
+}
+export interface IResponseTime {
+    method: string;
+    name: string;
+    [percentile: string]: string | number;
+}
+export interface ISwarmExceptionsResponse {
+    exceptions: ISwarmException[];
+}
+export interface ISwarmWorker {
+    cpuUsage: number;
+    id: string;
+    memoryUsage: number;
+    state: (typeof SWARM_STATE)[keyof typeof SWARM_STATE];
+    userCount: number;
+}
+export interface NullChartValue {
+    value: null;
+}
+export interface ICharts extends ILineChartMarkers {
+    currentRps: ((string | number)[] | NullChartValue)[];
+    currentFailPerSec: ([string, number] | NullChartValue)[];
+    [key: `responseTimePercentile${number}`]: ([string, number | null] | NullChartValue)[];
+    totalAvgResponseTime: ([string, number] | NullChartValue)[];
+    userCount: ([string, number] | NullChartValue)[];
+    time: string[];
+}
+export interface IClassRatio {
+    [key: string]: {
+        ratio: number;
+        tasks: IClassRatio;
+    };
+}
+export interface ISwarmRatios {
+    perClass: IClassRatio;
+    total: IClassRatio;
+}
+export interface IExtendedStatData {
+    name: string;
+    safeName: string;
+    [key: string]: number | string;
+}
+export interface IExtendedStat {
+    key: string;
+    data: IExtendedStatData[];
+}
+export interface IStatsResponse {
+    extendedStats: IExtendedStat[];
+    state: SwarmState;
+    stats: ISwarmStat[];
+    errors: ISwarmError[];
+    workers: ISwarmWorker[];
+    totalRps: number;
+    totalFailPerSec: number;
+    totalAvgResponseTime: number;
+    currentResponseTimePercentiles: {
+        [key: `responseTimePercentile${number}`]: number | null;
+    };
+    failRatio: number;
+    userCount: number;
+}
+export interface ILogsResponse {
+    master: string[];
+    workers: {
+        [key: string]: string[];
+    };
+}

package/lib/types/utils/array.d.ts

@@ -0,0 +1 @@
+export declare const flatten: <T>(array: any[]) => T[];

package/lib/types/utils/date.d.ts

@@ -0,0 +1 @@
+export declare const formatLocaleString: (utcTimestamp: string) => string;

package/lib/types/utils/number.d.ts

@@ -0,0 +1,2 @@
+export declare const roundToDecimalPlaces: (n: number, decimalPlaces?: number) => number;
+export declare const padStart: (n: number, length?: number, padding?: string) => string;

package/lib/types/utils/object.d.ts

@@ -0,0 +1,6 @@
+export declare const isEmpty: <T extends any[] | Record<string, any>>(object: T) => boolean;
+export declare function shallowMerge<ObjectA, ObjectB>(objectA: ObjectA, objectB: ObjectB): ObjectA & ObjectB;
+export declare const createFormData: (inputData: {
+    [key: string]: string | string[];
+}) => URLSearchParams;
+export declare const updateArraysAtProps: <T extends Record<string, any>>(objectToUpdate: T, propsWithUpdates: { [K in keyof T]: T[K] extends (infer U)[] ? U : T; }) => T;

package/lib/types/utils/string.d.ts

@@ -0,0 +1,8 @@
+export declare const snakeToCamelCase: (string: string) => string;
+export declare const camelCaseKeys: <ObjectInterface extends Record<string, any>>(object: ObjectInterface) => ObjectInterface;
+export declare const snakeCaseKeys: <ObjectInterface extends Record<string, any>>(object: ObjectInterface) => ObjectInterface;
+export declare const toTitleCase: (string: string) => string;
+export declare const queryStringToObject: (queryString: string) => {
+    [k: string]: string;
+};
+export declare const formatBytes: (bytes: number, decimals?: number) => string;

package/lib/types/utils/url.d.ts

@@ -0,0 +1,6 @@
+export declare const pushQuery: (query: {
+    [key: string]: string;
+}) => void;
+export declare const getUrlParams: () => {
+    [key: string]: string;
+} | null;