@uwrl/qc-utils 0.0.17 → 0.0.19

package/dist/types/index.d.ts

@@ -1,350 +0,0 @@
-import { DataSource } from '@/models';
-import { ObservationRecord } from '@/utils/plotting/observation-record';
-export type EnumDictionary<T extends string | symbol | number, U> = {
-    [K in T]: U;
-};
-export declare enum TimeUnit {
-    SECOND = "s",
-    MINUTE = "m",
-    HOUR = "h",
-    DAY = "D",
-    WEEK = "W",
-    MONTH = "M",
-    YEAR = "Y"
-}
-export declare enum EnumEditOperations {
-    ADD_POINTS = "ADD_POINTS",
-    CHANGE_VALUES = "CHANGE_VALUES",
-    DELETE_POINTS = "DELETE_POINTS",
-    DRIFT_CORRECTION = "DRIFT_CORRECTION",
-    INTERPOLATE = "INTERPOLATE",
-    SHIFT_DATETIMES = "SHIFT_DATETIMES",
-    FILL_GAPS = "FILL_GAPS"
-}
-export declare enum EnumFilterOperations {
-    FIND_GAPS = "FIND_GAPS",
-    PERSISTENCE = "PERSISTENCE",
-    CHANGE = "CHANGE",
-    RATE_OF_CHANGE = "RATE_OF_CHANGE",
-    VALUE_THRESHOLD = "VALUE_THRESHOLD"
-}
-export declare enum FilterOperation {
-    LT = "Less than",
-    LTE = "Less than or equal to",
-    GT = "Greater than",
-    GTE = "Greater than or equal to",
-    E = "Equal",
-    START = "Start datetime",
-    END = "End datetime"
-}
-export declare const FilterOperationFn: EnumDictionary<FilterOperation, (value: number, toCompare: number) => boolean>;
-export declare enum Operator {
-    ADD = "ADD",
-    SUB = "SUB",
-    MULT = "MULT",
-    DIV = "DIV",
-    ASSIGN = "ASSIGN"
-}
-export declare enum LogicalOperation {
-    LT = "Less than",
-    LTE = "Less than or equal to",
-    GT = "Greater than",
-    GTE = "Greater than or equal to",
-    E = "Equal"
-}
-export declare const LogicalComparator: EnumDictionary<LogicalOperation, (value: number, toCompare: number) => boolean>;
-export type HistoryItem = {
-    method: EnumEditOperations;
-    icon: string;
-    isLoading: boolean;
-    args?: any[];
-    duration?: number;
-    status?: 'success' | 'failed';
-};
-export type DataPoint = {
-    date: Date;
-    value: number;
-};
-export type DataArray = [string, number][];
-export interface GraphSeries {
-    id: string;
-    name: string;
-    data: ObservationRecord;
-    yAxisLabel: string;
-    seriesOption: any;
-}
-export type TimeSpacingUnit = 'seconds' | 'minutes' | 'hours' | 'days';
-export interface Tag {
-    key: string;
-    value: string;
-}
-export type Frequency = 'daily' | 'weekly' | 'monthly' | null;
-export declare class HydroShareArchive {
-    id: string;
-    thingId: string;
-    link: string;
-    frequency: Frequency;
-    path: string;
-    datastreamIds: string[];
-    publicResource: boolean;
-    constructor();
-}
-export declare class PostHydroShareArchive extends HydroShareArchive {
-    resourceTitle?: string;
-    resourceAbstract?: string;
-    resourceKeywords?: string[];
-    constructor();
-}
-export declare class Location {
-    latitude?: number | '';
-    longitude?: number | '';
-    elevation_m?: number | '';
-    elevationDatum: string;
-    state: string;
-    county: string;
-    country: string;
-    constructor();
-}
-export declare class Thing {
-    id: string;
-    workspaceId: string;
-    name: string;
-    location: Location;
-    tags: Tag[];
-    hydroShareArchive?: HydroShareArchive | null;
-    siteType: string;
-    samplingFeatureCode: string;
-    isPrivate: boolean;
-    description: string;
-    samplingFeatureType: string;
-    dataDisclaimer: string;
-    constructor();
-}
-export interface ThingWithColor extends Thing {
-    color?: {
-        borderColor: string;
-        background: string;
-        glyphColor: string;
-    };
-    tagValue?: string;
-}
-export declare class Datastream {
-    id: string;
-    workspaceId: string;
-    name: string;
-    description: string;
-    thingId: string;
-    observationType: string;
-    resultType?: string;
-    status?: string;
-    sampledMedium: string;
-    noDataValue: number;
-    aggregationStatistic: string;
-    unitId: string;
-    observedPropertyId: string;
-    sensorId: string;
-    processingLevelId: string;
-    isPrivate: boolean;
-    isVisible: boolean;
-    phenomenonBeginTime?: string | null;
-    phenomenonEndTime?: string | null;
-    intendedTimeSpacing?: number;
-    intendedTimeSpacingUnit?: TimeSpacingUnit | null;
-    timeAggregationInterval: number | null;
-    timeAggregationIntervalUnit: TimeSpacingUnit;
-    dataSourceId?: string | null;
-    valueCount: number;
-    constructor(thingId?: string);
-}
-export interface DatastreamExtended {
-    id: string;
-    name: string;
-    description: string;
-    observationType: string;
-    resultType?: string;
-    status?: string;
-    sampledMedium: string;
-    noDataValue: number;
-    aggregationStatistic: string;
-    isPrivate: boolean;
-    isVisible: boolean;
-    phenomenonBeginTime?: string | null;
-    phenomenonEndTime?: string | null;
-    intendedTimeSpacing?: number;
-    intendedTimeSpacingUnit?: TimeSpacingUnit | null;
-    timeAggregationInterval: number | null;
-    timeAggregationIntervalUnit: TimeSpacingUnit;
-    dataSourceId?: string | null;
-    valueCount: number;
-    thing: Thing;
-    workspace: Workspace;
-    unit: Unit;
-    observedProperty: ObservedProperty;
-    sensor: Sensor;
-    processingLevel: ProcessingLevel;
-    dataSource: DataSource;
-}
-export declare class Unit {
-    id: string;
-    workspaceId: string;
-    name: string;
-    symbol: string;
-    definition: string;
-    type: string;
-    constructor();
-}
-export declare class Sensor {
-    id: string;
-    workspaceId: string;
-    name: string;
-    description: string;
-    manufacturer: string;
-    model: string;
-    methodType: string;
-    methodCode: string;
-    methodLink: string;
-    encodingType: string;
-    modelLink: string;
-    constructor();
-}
-export declare class ObservedProperty {
-    id: string;
-    workspaceId: string;
-    name: string;
-    definition: string;
-    description: string;
-    type: string;
-    code: string;
-    constructor();
-}
-export declare class ProcessingLevel {
-    id: string;
-    workspaceId: string;
-    code: string;
-    definition: string;
-    explanation: string;
-    constructor();
-}
-export declare class ResultQualifier {
-    id: string;
-    workspaceId: string;
-    code: string;
-    description: string;
-    constructor();
-}
-export declare class Organization {
-    name?: string;
-    code?: string;
-    type?: string;
-    description?: string;
-    link?: string;
-    constructor();
-}
-export declare class User {
-    id: string;
-    email: string;
-    password: string;
-    firstName: string;
-    middleName: string;
-    lastName: string;
-    phone: string;
-    address: string;
-    organization?: Organization | null;
-    type: string;
-    link: string;
-    accountType: 'admin' | 'standard' | 'limited';
-    hydroShareConnected: boolean;
-    constructor();
-}
-export interface Photo {
-    name: string;
-    link: string;
-}
-export declare class OAuthProvider {
-    id: string;
-    name: string;
-    iconLink: string;
-    signupEnabled: boolean;
-    connectEnabled: boolean;
-    constructor();
-}
-export declare enum PermissionAction {
-    Global = "*",
-    View = "view",
-    Create = "create",
-    Edit = "edit",
-    Delete = "delete"
-}
-export declare enum PermissionResource {
-    Global = "*",
-    Workspace = "Workspace",
-    Collaborator = "Collaborator",
-    Thing = "Thing",
-    Datastream = "Datastream",
-    Sensor = "Sensor",
-    Unit = "Unit",
-    ObservedProperty = "ObservedProperty",
-    ProcessingLevel = "ProcessingLevel",
-    Observation = "Observation"
-}
-export interface Permission {
-    action: PermissionAction;
-    resource: PermissionResource;
-}
-export interface CollaboratorRole {
-    name: string;
-    description: string;
-    id: string;
-    workspaceId: string;
-    isApikeyRole: boolean;
-    isUserRole: boolean;
-    permissions: Permission[];
-}
-export declare class ApiKey {
-    id: string;
-    key: string;
-    name: string;
-    description: string;
-    isActive: boolean;
-    expiresAt: string;
-    createdAt: string;
-    lastUsed: string;
-    workspaceId: string;
-    role: CollaboratorRole | null;
-    constructor(init?: Partial<ApiKey>);
-}
-export interface WorkspaceData {
-    id: string;
-    name: string;
-    isPrivate: boolean;
-    owner: User;
-    collaboratorRole: CollaboratorRole;
-    pendingTransferTo?: User | null;
-}
-export declare class Workspace {
-    id: string;
-    name: string;
-    isPrivate: boolean;
-    owner: UserInfo | null;
-    collaboratorRole: CollaboratorRole | null;
-    pendingTransferTo?: UserInfo | null;
-    constructor();
-}
-export interface UserInfo {
-    name: string;
-    email: string;
-    phone: string;
-    address: string;
-    link: string;
-    type: string;
-    organizationName: string;
-}
-export declare class Collaborator {
-    user: UserInfo;
-    role: CollaboratorRole;
-    constructor();
-}
-export interface ApiError {
-    status: number;
-    message?: string;
-}

package/dist/utils/__tests__/ellapsed-time.spec.d.ts

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

package/dist/utils/__tests__/format.spec.d.ts

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

package/dist/utils/__tests__/notifications.spec.d.ts

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

package/dist/utils/__tests__/observations.spec.d.ts

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

package/dist/utils/ellapsed-time.d.ts

@@ -1,4 +0,0 @@
-export declare const measureEllapsedTime: (fn: () => any, message?: string) => Promise<{
-    response: any;
-    duration: number;
-}>;

package/dist/utils/format.d.ts

@@ -1,5 +0,0 @@
-import { EnumDictionary, TimeUnit } from '@/types';
-export declare const timeUnitMultipliers: EnumDictionary<TimeUnit, number>;
-export declare const formatDate: (date: Date) => string;
-export declare const formatDuration: (duration: number) => string;
-export declare const shiftDatetime: (datetime: number, amount: number, unit: TimeUnit) => number;

package/dist/utils/index.d.ts

@@ -1,5 +0,0 @@
-export * from './format';
-export * from './ellapsed-time';
-export * from './notifications';
-export * from './observations';
-export * from './plotting/observation-record';

package/dist/utils/notifications.d.ts

@@ -1,46 +0,0 @@
-export declare const DEFAULT_SNACK_DURATION = 3000;
-export declare enum SnackColor {
-    Warning = "warning",
-    Success = "success",
-    Error = "error",
-    Info = "info"
-}
-export declare enum SnackIcon {
-    Success = "mdi-checkbox-marked-circle",
-    Warning = "mdi-alert",
-    Error = "mdi-alert-circle",
-    Info = "mdi-information",
-    None = "none"
-}
-export declare enum SnackTitle {
-    Warning = "Warning",
-    Success = "Success",
-    Error = "Error",
-    Info = "Info"
-}
-export declare enum Position {
-    Center = "center",
-    Left = "left",
-    Right = "right",
-    Bottom = "bottom",
-    Top = "top"
-}
-export declare class Snack {
-    message: string;
-    color: SnackColor;
-    icon: SnackIcon;
-    title: SnackTitle;
-    timeout: number;
-    position: Position;
-    visible: boolean;
-    constructor(message?: string, color?: SnackColor, icon?: SnackIcon, title?: SnackTitle, timeout?: number, position?: Position, visible?: boolean);
-}
-export declare class Snackbar {
-    private static subject;
-    static get snack$(): import("rxjs").Observable<Snack>;
-    private static createSnackbar;
-    static success(message: string): void;
-    static warn(message: string): void;
-    static error(message: string): void;
-    static info(message: string): void;
-}

package/dist/utils/observations.d.ts

@@ -1,5 +0,0 @@
-export declare function subtractHours(timestamp: string, hours: number): string;
-/** Returns the index of the first value that is greater or equal to the target value */
-export declare const findFirstGreaterOrEqual: (array: number[] | Float64Array<SharedArrayBuffer>, target: number) => number;
-/** Returns the index of the last value that is lesser or equal to the target value */
-export declare const findLastLessOrEqual: (array: number[] | Float64Array<SharedArrayBuffer>, target: number) => number;

package/dist/utils/plotting/__tests__/delete-data.worker.spec.d.ts

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

package/dist/utils/plotting/__tests__/mock.d.ts

@@ -1,4 +0,0 @@
-export declare const mockDatastream: {
-    phenomenon_time: string[];
-    result: number[];
-};

package/dist/utils/plotting/__tests__/observation-record.spec.d.ts

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

package/dist/utils/plotting/observation-record.d.ts

@@ -1,155 +0,0 @@
-import { EnumEditOperations, EnumFilterOperations, HistoryItem } from '../../types';
-/**
- * This number should approximate the number of observations that a dataset could increase by during a session.
- * The lower this number, the less memory the entire app uses.
- * Note that when a dataset number of data points increases by more than `INCREASE_AMOUNT`,
- * the `_growBuffer()` method will allocate a new buffer, and the data will be copied into it.
- */
-export declare const INCREASE_AMOUNT: number;
-export declare class ObservationRecord {
-    /** The generated dataset to be used for plotting */
-    dataset: {
-        dimensions: string[];
-        source: {
-            x: Float64Array<SharedArrayBuffer>;
-            y: Float32Array<SharedArrayBuffer>;
-        };
-    };
-    history: HistoryItem[];
-    loadingTime: number | null;
-    isLoading: boolean;
-    rawData: {
-        datetimes: Float64Array<ArrayBuffer> | number[];
-        dataValues: Float32Array<ArrayBuffer> | number[];
-    };
-    constructor(dataArrays: {
-        datetimes: Float64Array<ArrayBuffer> | number[];
-        dataValues: Float32Array<ArrayBuffer> | number[];
-    });
-    loadData(dataArrays: {
-        datetimes: Float64Array<ArrayBuffer> | number[];
-        dataValues: Float32Array<ArrayBuffer> | number[];
-    }): Promise<void>;
-    get dataX(): Float64Array<SharedArrayBuffer>;
-    get dataY(): Float32Array<SharedArrayBuffer>;
-    /**
-     * Resizes the typed array
-     * @param length The total number of elements that the view will contain
-     */
-    private _resizeTo;
-    /**
-     * Buffer size is always in increments of `INCREASE_AMOUNT`.
-     * Grows the buffer by `INCREASE_AMOUNT` in bytes if the current data doesn't fit
-     * @param newLength The total number of elements that the view will contain
-     */
-    private _growBuffer;
-    /**
-     * Reloads the dataset with the raw data
-     */
-    reload(): Promise<void>;
-    /**
-     * @param index
-     * @returns
-     */
-    reloadHistory(index: number): Promise<void>;
-    /**
-     * Remove a history item
-     * @param index
-     */
-    removeHistoryItem(index: number): Promise<void>;
-    get beginTime(): Date | null;
-    get endTime(): Date | null;
-    /** Dispatch an operation and log its signature in hisotry */
-    dispatch(action: EnumEditOperations | [EnumEditOperations, ...any][], ...args: any): Promise<any[]>;
-    /** Filter operations do not transform the data and are not logged in history */
-    dispatchFilter(action: EnumFilterOperations | [EnumFilterOperations, ...any][], ...args: any): Promise<any>;
-    /**
-     * @param index An array containing the list of index of values to perform the operations on.
-     * @param operator The operator that will be applied
-     * @param value The value to use in the operation
-     * @returns The modified DataFrame
-     */
-    private _changeValues;
-    private _interpolate;
-    /** Interpolate existing values in the data source */
-    private _interpolateLinear;
-    /**
-     * Shifts the selected indexes by specified amount of units. Elements are reinserted according to their datetime.
-     * @param index The index of the elements to shift
-     * @param amount Number of {@link TimeUnit}
-     * @param unit {@link TimeUnit}
-     * @returns
-     */
-    private _shift;
-    private _fillGapsV2;
-    /**
-     * Find gaps and fill them with placeholder value
-     * @param gap Intervals to detect as gaps
-     * @param fill Interval used to fill the detected gaps
-     * @param interpolateValues If true, the new values will be linearly interpolated
-     * @returns
-     */
-    private _fillGaps;
-    /**
-     Deletes data points from a large array using worker threads.
-      1. The main thread divides the original array into equal parts to distribute work among workers.
-      2. For each segment, binary search locates the indexes to delete (deleteSegment), ensuring efficient lookups.
-      3. The cumulative deletions before each segment help compute the starting index (startTarget) for each worker's output, ensuring no overlap.
-      4. Each worker processes its segment linearly, skipping deletions and copying kept elements to their computed positions.
-      * @param deleteIndices
-     */
-    private _deleteDataPoints;
-    /**
-     *
-     * @param start The start index
-     * @param end The end index
-     * @param value The drift amount
-     */
-    private _driftCorrection;
-    /** Traverses the index array and returns groups of consecutive values.
-     * i.e.: `[0, 1, 3, 4, 6] => [[0, 1], [3, 4], [6]]`
-     * Assumes the input array is sorted.
-     * @param index: the index array (sorted)
-     */
-    private _getConsecutiveGroups;
-    /**
-     * Adds data points. Their insert index is determined using `findFirstGreaterOrEqual` in the x-axis.
-     * @param dataPoints
-     */
-    private _addDataPoints;
-    /**
-     * Filter by applying a set of logical operations
-     * @param appliedFilters
-     * @returns
-     */
-    private _valueThreshold;
-    /**
-     *
-     * @param comparator
-     * @param value
-     * @returns
-     */
-    private _rateOfChange;
-    /**
-   *
-   * @param comparator
-   * @param value
-   * @returns
-   */
-    private _change;
-    /**
-     * Find gaps in the data
-     * @param value The time value
-     * @param unit The time unit (TimeUnit)
-     * @param range If specified, the gaps will be found only within the range
-     * @returns
-     */
-    private _findGaps;
-    /**
-     * Find points where the values are the same at least x times in a row
-     * @param times The number of times in a row that points can be equal
-     * @param range If specified, the points will be found only within the range
-     * @returns
-     */
-    private _persistence;
-}