@cccsaurora/howler-ui 2.14.0-dev.248 → 2.14.0-dev.254

package/plugins/store.d.ts

@@ -1,95 +0,0 @@
-import type { Hit } from '@cccsaurora/howler-ui/models/entities/generated/Hit';
-import { Event } from 'react-pluggable';
-import type HowlerPlugin from './HowlerPlugin';
-import type { AppLeftNavElement } from '../commons/components/app/AppConfigs';
-export declare class HitEvent extends Event {
-    hit: Hit;
-    constructor(type: string, hit: Hit);
-}
-export declare enum MainMenuInsertOperation {
-    Insert = "INSERT",
-    InsertAfter = "AFTER",
-    InsertBefore = "BEFORE"
-}
-declare class HowlerPluginStore {
-    private _pluginStore;
-    plugins: string[];
-    private _leadFormats;
-    private _pivotFormats;
-    private _operations;
-    private _userMenuItems;
-    private _adminMenuItems;
-    private _mainMenuOperations;
-    private _routes;
-    private _sitemaps;
-    install(plugin: HowlerPlugin): void;
-    addLead(format: string): boolean;
-    addPivot(format: string): boolean;
-    addUserMenuItem(menuItem: {
-        i18nKey: string;
-        route: string;
-        icon: JSX.Element;
-    }): void;
-    addAdminMenuItem(menuItem: {
-        i18nKey: string;
-        route: string;
-        icon: JSX.Element;
-    }): void;
-    addMainMenuItem(menuOperation: {
-        operation: string;
-        targetId: string;
-        item: AppLeftNavElement;
-    }): void;
-    addRoute(route: {
-        path: string;
-        element: JSX.Element;
-        children?: [];
-    }): void;
-    addSitemap(sitemap: {
-        path: string;
-        title: string;
-        icon?: JSX.Element;
-        isRoot?: boolean;
-        isLeaf?: boolean;
-        excluded?: boolean;
-        breadcrumbs?: string[];
-        textWidth?: number;
-    }): void;
-    addOperation(format: string): boolean;
-    get leadFormats(): string[];
-    get pivotFormats(): string[];
-    get operations(): string[];
-    get userMenuItems(): {
-        i18nKey: string;
-        route: string;
-        icon: JSX.Element;
-    }[];
-    get adminMenuItems(): {
-        i18nKey: string;
-        route: string;
-        icon: JSX.Element;
-    }[];
-    get mainMenuOperations(): {
-        operation: string;
-        targetId: string;
-        item: AppLeftNavElement;
-    }[];
-    get routes(): {
-        path: string;
-        element: JSX.Element;
-        children?: [];
-    }[];
-    get sitemaps(): {
-        path: string;
-        title: string;
-        icon?: JSX.Element;
-        isRoot?: boolean;
-        isLeaf?: boolean;
-        excluded?: boolean;
-        breadcrumbs?: string[];
-        textWidth?: number;
-    }[];
-    get pluginStore(): import("react-pluggable").PluginStore;
-}
-declare const howlerPluginStore: HowlerPluginStore;
-export default howlerPluginStore;

package/plugins/store.js

@@ -1,96 +0,0 @@
-import { createPluginStore, Event } from 'react-pluggable';
-export class HitEvent extends Event {
-    hit;
-    constructor(type, hit) {
-        super(type);
-        this.hit = hit;
-    }
-}
-export var MainMenuInsertOperation;
-(function (MainMenuInsertOperation) {
-    MainMenuInsertOperation["Insert"] = "INSERT";
-    MainMenuInsertOperation["InsertAfter"] = "AFTER";
-    MainMenuInsertOperation["InsertBefore"] = "BEFORE";
-})(MainMenuInsertOperation || (MainMenuInsertOperation = {}));
-class HowlerPluginStore {
-    _pluginStore = createPluginStore();
-    plugins = [];
-    _leadFormats = [];
-    _pivotFormats = [];
-    _operations = [];
-    _userMenuItems = [];
-    _adminMenuItems = [];
-    _mainMenuOperations = [];
-    _routes = [];
-    _sitemaps = [];
-    install(plugin) {
-        console.log(`Installing plugin ${plugin.getPluginName()} by ${plugin.author}`);
-        this.plugins.push(plugin.name);
-        this.pluginStore.install(plugin);
-    }
-    addLead(format) {
-        if (this._leadFormats.includes(format)) {
-            return false;
-        }
-        this._leadFormats.push(format);
-        return true;
-    }
-    addPivot(format) {
-        if (this._pivotFormats.includes(format)) {
-            return false;
-        }
-        this._pivotFormats.push(format);
-        return true;
-    }
-    addUserMenuItem(menuItem) {
-        this._userMenuItems.push(menuItem);
-    }
-    addAdminMenuItem(menuItem) {
-        this._adminMenuItems.push(menuItem);
-    }
-    addMainMenuItem(menuOperation) {
-        this._mainMenuOperations.push(menuOperation);
-    }
-    addRoute(route) {
-        this._routes.push(route);
-    }
-    addSitemap(sitemap) {
-        this._sitemaps.push(sitemap);
-    }
-    addOperation(format) {
-        if (this._operations.includes(format)) {
-            return false;
-        }
-        this._operations.push(format);
-        return true;
-    }
-    get leadFormats() {
-        return this._leadFormats;
-    }
-    get pivotFormats() {
-        return this._pivotFormats;
-    }
-    get operations() {
-        return this._operations;
-    }
-    get userMenuItems() {
-        return this._userMenuItems;
-    }
-    get adminMenuItems() {
-        return this._adminMenuItems;
-    }
-    get mainMenuOperations() {
-        return this._mainMenuOperations;
-    }
-    get routes() {
-        return this._routes;
-    }
-    get sitemaps() {
-        return this._sitemaps;
-    }
-    get pluginStore() {
-        return this._pluginStore;
-    }
-}
-const howlerPluginStore = new HowlerPluginStore();
-export default howlerPluginStore;

package/rest/AxiosClient.d.ts

@@ -1,10 +0,0 @@
-import type { HowlerResponse } from '@cccsaurora/howler-ui/api';
-import type RestClient from '@cccsaurora/howler-ui/rest';
-export default class AxiosClient implements RestClient {
-    private cache;
-    private client;
-    constructor();
-    fetch<R>(url: string, method?: 'get' | 'post' | 'put' | 'delete' | 'patch', body?: any, params?: URLSearchParams, headers?: HeadersInit): Promise<[HowlerResponse<R>, number, {
-        [index: string]: any;
-    }]>;
-}

package/rest/AxiosClient.js

@@ -1,60 +0,0 @@
-import axios, { AxiosError } from 'axios';
-import axiosRetry, { exponentialDelay, isNetworkError } from 'axios-retry';
-import { getAxiosCache, setAxiosCache } from '@cccsaurora/howler-ui/utils/sessionStorage';
-class AxiosCache {
-    constructor(_axios) {
-        _axios.interceptors.response.use(async (res) => {
-            const cache = getAxiosCache();
-            if (res.status >= 200 && res.status < 300 && res.headers.etag) {
-                setAxiosCache(res.headers.etag, res.data);
-            }
-            if (res.status === 304) {
-                const etag = res.config.headers['If-Match'];
-                if (etag) {
-                    res.data = cache[etag];
-                }
-            }
-            return res;
-        });
-    }
-}
-export default class AxiosClient {
-    // @ts-ignore
-    cache;
-    client;
-    constructor() {
-        this.client = axios.create({
-            validateStatus: status => (status >= 200 && status < 300) || status === 304
-        });
-        this.cache = new AxiosCache(this.client);
-        axiosRetry(this.client, {
-            retries: 3,
-            retryCondition: err => {
-                return (
-                // Don't retry 502s, as we assume the server handles retries in those cases
-                isNetworkError(err) || (err?.response?.status >= 500 && err?.response?.status !== 502));
-            },
-            retryDelay: exponentialDelay
-        });
-    }
-    async fetch(url, method = 'get', body, params, headers) {
-        const config = {
-            url,
-            params,
-            method,
-            withCredentials: true,
-            data: JSON.stringify(body),
-            headers: headers
-        };
-        try {
-            const response = await this.client(config);
-            return [response.data, response.status, response.headers];
-        }
-        catch (e) {
-            if (e instanceof AxiosError && e.response?.data) {
-                return [e.response.data, e.response.status, e.response.headers];
-            }
-            throw e;
-        }
-    }
-}

package/rest/FetchClient.d.ts

@@ -1,7 +0,0 @@
-import type { HowlerResponse } from '@cccsaurora/howler-ui/api';
-import type RestClient from '@cccsaurora/howler-ui/rest';
-export default class FetchClient implements RestClient {
-    fetch<R>(url: string, method?: 'get' | 'post' | 'put' | 'delete', body?: any, params?: URLSearchParams, headers?: HeadersInit): Promise<[HowlerResponse<R>, number, {
-        [index: string]: any;
-    }]>;
-}

package/rest/FetchClient.js

@@ -1,16 +0,0 @@
-export default class FetchClient {
-    async fetch(url, method = 'get', body, params, headers) {
-        const _url = `${url}${params ? `?${params.toString()}` : ''}`;
-        const response = await fetch(_url, {
-            method,
-            credentials: 'same-origin',
-            headers: headers,
-            body: body ? JSON.stringify(body) : null
-        });
-        if (response.status === 204) {
-            return null;
-        }
-        const json = (await response.json());
-        return [json, response.status, response.headers];
-    }
-}

package/rest/index.d.ts

@@ -1,6 +0,0 @@
-import type { HowlerResponse } from '@cccsaurora/howler-ui/api';
-export default interface RestClient {
-    fetch<R>(url: string, method: 'get' | 'post' | 'put' | 'delete', body?: any, params?: URLSearchParams, headers?: HeadersInit): Promise<[HowlerResponse<R>, number, {
-        [index: string]: any;
-    }]>;
-}

package/rest/index.js

@@ -1 +0,0 @@
-export {};

package/setupTests.d.ts

@@ -1 +0,0 @@
-import '@testing-library/jest-dom/vitest';

package/setupTests.js

@@ -1,12 +0,0 @@
-/// <reference types="vitest" />
-import * as matchers from '@testing-library/jest-dom/matchers';
-import '@testing-library/jest-dom/vitest';
-import { configure } from '@testing-library/react';
-import { server } from '@cccsaurora/howler-ui/tests/server';
-// Extend vitest with the dom matchers from jest-dom.
-expect.extend(matchers);
-// tell React Testing Library to look for id as the testId.
-configure({ testIdAttribute: 'id' });
-beforeAll(() => server.listen());
-afterEach(() => server.resetHandlers());
-afterAll(() => server.close());

package/tests/MockLocalStorage.d.ts

@@ -1,5 +0,0 @@
-export default class MockLocalStorage {
-    constructor();
-    get length(): number;
-    get __STORE__(): this;
-}

package/tests/MockLocalStorage.js

@@ -1,44 +0,0 @@
-export default class MockLocalStorage {
-    constructor() {
-        Object.defineProperty(this, 'getItem', {
-            enumerable: false,
-            value: vi.fn(key => (this[key] !== undefined ? this[key] : null))
-        });
-        Object.defineProperty(this, 'setItem', {
-            enumerable: false,
-            // not mentioned in the spec, but we must always coerce to a string
-            value: vi.fn((key, val) => {
-                this[key] = `${val}`;
-            })
-        });
-        Object.defineProperty(this, 'removeItem', {
-            enumerable: false,
-            value: vi.fn(key => {
-                delete this[key];
-            })
-        });
-        Object.defineProperty(this, 'clear', {
-            enumerable: false,
-            value: vi.fn(() => {
-                Object.keys(this).map(key => delete this[key]);
-            })
-        });
-        Object.defineProperty(this, 'toString', {
-            enumerable: false,
-            value: vi.fn(() => {
-                return '[object Storage]';
-            })
-        });
-        Object.defineProperty(this, 'key', {
-            enumerable: false,
-            value: vi.fn(idx => Object.keys(this)[idx] || null)
-        });
-    } // end constructor
-    get length() {
-        return Object.keys(this).length;
-    }
-    // for backwards compatibility
-    get __STORE__() {
-        return this;
-    }
-}

package/tests/server-handlers.d.ts

@@ -1,5 +0,0 @@
-export declare const MOCK_RESPONSES: {
-    [path: string]: any;
-};
-declare const handlers: import("msw").HttpHandler[];
-export { handlers };

package/tests/server-handlers.js

@@ -1,97 +0,0 @@
-import { http, HttpResponse } from 'msw';
-export const MOCK_RESPONSES = {
-    '/api/v1/view/example_view_id': {
-        owner: 'user',
-        settings: {
-            advance_on_triage: false
-        },
-        view_id: 'example_view_id',
-        query: 'howler.id:*',
-        sort: 'event.created desc',
-        title: 'Example View',
-        type: 'personal',
-        span: 'date.range.1.month'
-    },
-    '/api/v1/search/view': {
-        items: [
-            {
-                owner: 'user',
-                settings: {
-                    advance_on_triage: false
-                },
-                view_id: 'searched_view_id',
-                query: 'howler.id:searched',
-                sort: 'event.created desc',
-                title: 'Searched View',
-                type: 'personal',
-                span: 'date.range.1.month'
-            }
-        ],
-        total: 1,
-        rows: 1
-    },
-    '/api/v1/view/new_view_id': {
-        owner: 'user',
-        settings: {
-            advance_on_triage: false
-        },
-        view_id: 'new_view_id',
-        query: 'howler.id:new',
-        sort: 'event.created desc',
-        title: 'New View',
-        type: 'personal',
-        span: 'date.range.1.month'
-    },
-    '/api/v1/view/:view_id/favourite': { success: true }
-};
-const handlers = [
-    ...Object.entries(MOCK_RESPONSES).map(([path, data]) => http.all(path, async () => HttpResponse.json({ api_response: data }))),
-    http.post('/api/v1/view', async () => HttpResponse.json({
-        api_response: {
-            owner: 'user',
-            settings: {
-                advance_on_triage: false
-            },
-            view_id: 'example_created_view',
-            query: 'howler.id:*',
-            sort: 'event.created desc',
-            title: 'Example View',
-            type: 'personal',
-            span: 'date.range.1.month'
-        }
-    }, { status: 201 })),
-    http.delete('/api/v1/view/:view_id', async () => HttpResponse.json({
-        api_response: {
-            success: true
-        }
-    }, { status: 204 })),
-    http.get('/api/v1/view', async () => HttpResponse.json({
-        api_response: [
-            {
-                owner: 'user',
-                settings: {
-                    advance_on_triage: false
-                },
-                view_id: 'example_view_id',
-                query: 'howler.id:*',
-                sort: 'event.created desc',
-                title: 'Example View',
-                type: 'personal',
-                span: 'date.range.1.month'
-            },
-            {
-                owner: 'user',
-                settings: {
-                    advance_on_triage: true
-                },
-                view_id: 'another_view_id',
-                query: 'howler.status:open',
-                sort: 'event.created asc',
-                title: 'Another View',
-                type: 'global',
-                span: 'date.range.1.week'
-            }
-        ]
-    }))
-];
-export { handlers };

package/tests/server.d.ts

@@ -1,3 +0,0 @@
-import { http } from 'msw';
-declare const server: import("msw/node").SetupServerApi;
-export { http, server };

package/tests/server.js

@@ -1,5 +0,0 @@
-import { http } from 'msw';
-import { setupServer } from 'msw/node';
-import { handlers } from './server-handlers';
-const server = setupServer(...handlers);
-export { http, server };

package/utils/Throttler.d.ts

@@ -1,9 +0,0 @@
-export default class Throttler {
-    private throttleId;
-    private delayId;
-    private msec;
-    constructor(msec: number);
-    throttle(fn: () => void): void;
-    debounce(fn: () => void): void;
-    delayAsync(fn: (...args: any[]) => Promise<any>, ...args: any[]): Promise<any>;
-}

package/utils/Throttler.js

@@ -1,38 +0,0 @@
-export default class Throttler {
-    throttleId = null;
-    delayId = null;
-    msec = null;
-    constructor(msec) {
-        this.msec = msec;
-        this.debounce = this.debounce.bind(this);
-    }
-    throttle(fn) {
-        if (!this.throttleId) {
-            fn();
-            this.throttleId = setTimeout(() => {
-                this.throttleId = null;
-            }, this.msec);
-        }
-    }
-    debounce(fn) {
-        if (this.delayId) {
-            clearTimeout(this.delayId);
-        }
-        this.delayId = setTimeout(fn, this.msec);
-    }
-    delayAsync(fn, ...args) {
-        if (this.delayId) {
-            clearTimeout(this.delayId);
-        }
-        return new Promise((resolve, reject) => {
-            this.delayId = setTimeout(async () => {
-                try {
-                    resolve(await fn?.(...args));
-                }
-                catch (error) {
-                    reject(error);
-                }
-            }, this.msec);
-        });
-    }
-}

package/utils/actionUtils.d.ts

@@ -1,31 +0,0 @@
-import type { ActionOperation, ActionOperationStep } from '@cccsaurora/howler-ui/models/ActionTypes';
-import type { Operation } from '@cccsaurora/howler-ui/models/entities/generated/Operation';
-/**
- * A simple validation function to ensure we have all the necessary arguments filled out.
- * @param step The step to validate
- * @param values The context to validate on
- * @returns whether all the necessary arguments have been filled in the given step
- */
-export declare const checkArgsAreFilled: (step: ActionOperationStep, values: string) => boolean;
-/**
- * Take the raw options object as specified by the server and get a list of usable options, filtered using the current values suppled for the action entry.
- * @param options The raw list of options from the server
- * @param arg The argument for which we are parsing options
- * @param context The values provided so far by the user
- * @returns a list of options matching the current context
- */
-export declare const getOptionsByContext: (options: ActionOperationStep["options"], arg: string, context: string) => string[];
-/**
- * Get a list of arguments to display based on the current context, using the current values supplied for the action entry.
- * @param args a complete list of all arguments in the action
- * @param values the current list of values provided by the user
- * @returns A list of arguments to display
- */
-export declare const getArgsByContext: (args: ActionOperationStep["args"], values: string) => string[];
-/**
- * Check to see if a given action has all the data necessary to execute successfully
- * @param data The user-provided data
- * @param action The action to validate
- * @returns whether the action is ready to execute
- */
-export declare const operationReady: (data: Operation["data_json"], action: ActionOperation) => boolean;

package/utils/actionUtils.js

@@ -1,88 +0,0 @@
-/**
- * A simple validation function to ensure we have all the necessary arguments filled out.
- * @param step The step to validate
- * @param values The context to validate on
- * @returns whether all the necessary arguments have been filled in the given step
- */
-export const checkArgsAreFilled = (step, values) => {
-    if (!values) {
-        return false;
-    }
-    const parsedValues = JSON.parse(values);
-    return Object.keys(step.args).every(arg => !!parsedValues[arg]);
-};
-/**
- * Convert a raw list of keyt value pairs into a context object used in other util functions. Converts it into a list like so:
- *
- * {
- *  "key": "value"
- * }
- * is converted to:
- * ["key:value"]
- *
- * Which is the format used for conditionals throughout the action specification.
- *
- * @param values The raw values object to convert
- * @returns a list representing the current context
- */
-const buildContext = (values = '{}') => Object.entries(JSON.parse(values)).map(tuple => tuple.join(':'));
-/**
- * Take the raw options object as specified by the server and get a list of usable options, filtered using the current values suppled for the action entry.
- * @param options The raw list of options from the server
- * @param arg The argument for which we are parsing options
- * @param context The values provided so far by the user
- * @returns a list of options matching the current context
- */
-export const getOptionsByContext = (options, arg, context) => {
-    if (!options[arg]) {
-        return [];
-    }
-    // If it's just an array, there's no special conditional logic to deal with - we just return the array
-    if (Array.isArray(options[arg])) {
-        return options[arg];
-    }
-    // Build the context up from the raw values, and check to see if any of the context values matches the conditionals provided in the options.
-    // i.e.
-    //
-    // options = {
-    //  "status:open": [] // would match if values["status"] === "open"
-    // }
-    //
-    // Note that this restricts the options to a single key:value pair.
-    // For more complex cases down the road (if those end up existing), we'll need to improve this
-    const matchingKey = buildContext(context).find(key => !!options[arg][key]);
-    return options[arg][matchingKey] ?? [];
-};
-/**
- * Get a list of arguments to display based on the current context, using the current values supplied for the action entry.
- * @param args a complete list of all arguments in the action
- * @param values the current list of values provided by the user
- * @returns A list of arguments to display
- */
-export const getArgsByContext = (args, values) => Object.entries(args)
-    .filter(([_, conditions]) => {
-    // If the array is empty, we always want to show this argument
-    if (conditions.length < 1) {
-        return true;
-    }
-    const context = buildContext(values);
-    // Note that the .some(...) here means the arguments are ORed together, not ANDed. So:
-    // "arg_to_show": ["status:open", "assignment:goose"]
-    // Will show if only one of these two conditions is valid.
-    return conditions.some(c => context.includes(c));
-})
-    .map(([arg, _]) => arg);
-/**
- * Check to see if a given action has all the data necessary to execute successfully
- * @param data The user-provided data
- * @param action The action to validate
- * @returns whether the action is ready to execute
- */
-export const operationReady = (data, action) => {
-    if (!data) {
-        return false;
-    }
-    const parsedData = JSON.parse(data);
-    return (action &&
-        getArgsByContext(action.steps.reduce((acc, _step) => ({ ...acc, ..._step.args }), {}), data).every(v => !!parsedData[v]));
-};