dce-reactkit 3.0.1 → 3.0.4

package/lib/index.d.ts

@@ -1,274 +0,0 @@
-/// <reference types="react" />
-import React from 'react';
-
-/**
- * A wrapper for the entire React app that adds global functionality like
- *   handling for fatal error messages
- * @author Gabe Abrams
- */
-
-declare type Props$3 = {
-    children: React.ReactNode;
-    dark?: boolean;
-    sessionExpiredMessage?: string;
-};
-/**
- * Show an alert modal with an "Okay" button
- * @author Gabe Abrams
- * @param title the title text to display at the top of the alert
- * @param text the text to display in the alert
- */
-declare const alert: (title: string, text: string) => Promise<undefined>;
-/**
- * Show a confirmation modal with an "Okay" and a "Cancel" button
- * @author Gabe Abrams
- * @param title the title text to display at the top of the alert
- * @param text the text to display in the alert
- * @returns true if the user confirmed
- */
-declare const confirm: (title: string, text: string) => Promise<boolean>;
-/**
- * Show a fatal error message
- * @author Gabe Abrams
- * @param error the error to show
- * @param [errorTitle] title of the error box
- */
-declare const showFatalError: (error: any, errorTitle?: string) => undefined;
-declare const AppWrapper: React.FC<Props$3>;
-
-/**
- * Loading spinner/indicator
- * @author Gabe Abrams
- */
-declare const LoadingSpinner: () => JSX.Element;
-
-/**
- * Displays an error
- * @author Gabe Abrams
- */
-
-declare type Props$2 = {
-    error: any;
-    title?: string;
-    onClose?: () => void;
-};
-declare const ErrorBox: React.FC<Props$2>;
-
-/**
- * Bootstrap variants
- * @author Gabe Abrams
- */
-declare enum Variant {
-    Primary = "primary",
-    Secondary = "secondary",
-    Success = "success",
-    Warning = "warning",
-    Info = "info",
-    Danger = "danger",
-    Light = "light",
-    Dark = "dark"
-}
-
-/**
- * Types of buttons in the modal
- * @author Gabe Abrams
- */
-declare enum ModalButtonType {
-    Okay = "okay",
-    Cancel = "cancel",
-    Yes = "yes",
-    No = "no",
-    Abandon = "abandon",
-    GoBack = "goBack",
-    Continue = "continue",
-    ImSure = "imSure",
-    Delete = "delete",
-    Confirm = "confirm"
-}
-
-/**
- * Modal sizes
- * @author Gabe Abrams
- */
-declare enum ModalSize {
-    Small = "sm",
-    Medium = "md",
-    Large = "lg",
-    ExtraLarge = "xl"
-}
-
-/**
- * Types of modals
- * @author Gabe Abrams
- */
-declare enum ModalType {
-    Okay = "okay",
-    OkayCancel = "okay-cancel",
-    YesNo = "yes-no",
-    YesNoCancel = "yes-no-cancel",
-    AbandonGoBack = "abandon-goBack",
-    ImSureCancel = "imSure-cancel",
-    DeleteCancel = "delete-cancel",
-    ConfirmCancel = "confirm-cancel",
-    NoButtons = "-"
-}
-
-/**
- * A generic popup modal
- * @author Gabe Abrams
- */
-
-declare type Props$1 = {
-    type?: ModalType;
-    size?: ModalSize;
-    title?: React.ReactNode;
-    children?: React.ReactNode;
-    onClose?: (type: ModalButtonType) => void;
-    dontAllowBackdropExit?: boolean;
-    okayLabel?: string;
-    okayVariant?: Variant;
-    cancelLabel?: string;
-    cancelVariant?: Variant;
-    yesLabel?: string;
-    yesVariant?: Variant;
-    noLabel?: string;
-    noVariant?: Variant;
-    abandonLabel?: string;
-    abandonVariant?: Variant;
-    goBackLabel?: string;
-    goBackVariant?: Variant;
-    continueLabel?: string;
-    continueVariant?: Variant;
-    imSureLabel?: string;
-    imSureVariant?: Variant;
-    deleteLabel?: string;
-    deleteVariant?: Variant;
-    confirmLabel?: string;
-    confirmVariant?: Variant;
-    onTopOfOtherModals?: boolean;
-};
-declare const Modal: React.FC<Props$1>;
-
-/**
- * A box with a tab on the top that holds buttons and other content
- * @author Gabe Abrams
- */
-
-declare type Props = {
-    title: React.ReactNode;
-    children: React.ReactNode;
-};
-declare const TabBox: React.FC<Props>;
-
-/**
- * An error with a code
- * @author Gabe Abrams
- */
-declare class ErrorWithCode extends Error {
-    code: string;
-    constructor(message: string, code: string);
-}
-
-/**
- * Shorten text so it fits into a certain number of chars
- * @author Gabe Abrams
- * @param text the text to abbreviate
- * @param maxChars the maximum number of chars to include
- * @returns abbreviated text with length no greater than maxChars
- *   (including ellipses if applicable)
- */
-declare const abbreviate: (text: string, maxChars: number) => string;
-
-/**
- * Get the average of a set of numbers
- * @author Gabe Abrams
- * @param nums the numbers to average
- * @returns average value or 0 if no numbers
- */
-declare const avg: (nums: number[]) => number;
-
-/**
- * Round a number (ceiling) to a certain number of decimals
- * @author Gabe Abrams
- * @param num the number to round
- * @param numDecimals the number of decimals to round to
- * @returns rounded number
- */
-declare const ceilToNumDecimals: (num: number, numDecimals: number) => number;
-
-/**
- * Round a number (floor) to a certain number of decimals
- * @author Gabe Abrams
- * @param num the number to round
- * @param numDecimals the number of decimals to round to
- * @returns rounded number
- */
-declare const floorToNumDecimals: (num: number, numDecimals: number) => number;
-
-/**
- * Force a number to stay within specific bounds
- * @author Gabe Abrams
- * @param num the number to move into the bounds
- * @param min the minimum number in the bound
- * @param max the maximum number in the bound
- * @returns bounded number
- */
-declare const forceNumIntoBounds: (num: number, min: number, max: number) => number;
-
-/**
- * Pad a number's decimal with zeros on the right
- *   (e.g. 5.2 becomes 5.20 with 2 digit padding)
- * @author Gabe Abrams
- * @param num the number to pad
- * @param numDigits the minimum number of digits after the decimal
- * @returns padded number
- */
-declare const padDecimalZeros: (num: number, numDigits: number) => string;
-
-/**
- * Pad a number with zeros on the left (e.g. 5 becomes 05 with 2 digit padding)
- * @author Gabe Abrams
- * @param num the number to pad
- * @param numDigits the minimum number of digits before the decimal
- * @returns padded number
- */
-declare const padZerosLeft: (num: number, numDigits: number) => string;
-
-/**
- * Round a number to a certain number of decimals
- * @author Gabe Abrams
- * @param num the number to round
- * @param numDecimals the number of decimals to round to
- * @returns rounded number
- */
-declare const roundToNumDecimals: (num: number, numDecimals: number) => number;
-
-/**
- * Sum the numbers in an array
- * @author Gabe Abrams
- * @param nums the numbers to sum
- * @returns the sum of the numbers
- */
-declare const sum: (nums: number[]) => number;
-
-/**
- * Wait for a certain number of ms
- * @author Gabe Abrams
- * @param ms number of ms to wait
- */
-declare const waitMs: (ms?: number) => Promise<unknown>;
-
-/**
- * List of error codes built into the react kit
- * @author Gabe Abrams
- */
-declare enum ReactKitErrorCode {
-    NoResponse = "DRK1",
-    NoCode = "DRK2",
-    SessionExpired = "DRK3",
-    MissingParameter = "DRK4",
-    InvalidParameter = "DRK5",
-    WrongCourse = "DRK6"
-}
-
-export { AppWrapper, ErrorBox, ErrorWithCode, LoadingSpinner, Modal, ModalButtonType, ModalSize, ModalType, ReactKitErrorCode, TabBox, Variant, abbreviate, alert, avg, ceilToNumDecimals, confirm, floorToNumDecimals, forceNumIntoBounds, padDecimalZeros, padZerosLeft, roundToNumDecimals, showFatalError, sum, waitMs };