dce-reactkit 2.0.12 → 3.0.0

package/lib/esm/lib/types/ModalType.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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 = "-"
+}
+export default ModalType;

package/lib/esm/lib/types/ParamType.d.ts

@@ -0,0 +1,17 @@
+/**
+ * API param types
+ * @author Gabe Abrams
+ */
+declare enum ParamType {
+    Boolean = "boolean",
+    BooleanOptional = "boolean-optional",
+    Float = "float",
+    FloatOptional = "float-optional",
+    Int = "int",
+    IntOptional = "int-optional",
+    JSON = "json",
+    JSONOptional = "json-optional",
+    String = "string",
+    StringOptional = "string-optional"
+}
+export default ParamType;

package/lib/esm/lib/types/ReactKitErrorCode.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 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 default ReactKitErrorCode;

package/lib/esm/lib/types/Variant.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Bootstrap variants
+ * @author Gabe Abrams
+ */
+declare enum Variant {
+    Primary = "primary",
+    Secondary = "secondary",
+    Success = "success",
+    Warning = "warning",
+    Info = "info",
+    Danger = "danger",
+    Light = "light",
+    Dark = "dark"
+}
+export default Variant;

package/lib/esm/types/components/AppWrapper.d.ts

@@ -0,0 +1,40 @@
+/**
+ * A wrapper for the entire React app that adds global functionality like
+ *   handling for fatal error messages
+ * @author Gabe Abrams
+ */
+import React from 'react';
+declare type Props = {
+    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
+ */
+export declare const alert: (title: string, text: string) => Promise<unknown>;
+/**
+ * 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
+ */
+export 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
+ */
+export declare const showFatalError: (error: any, errorTitle?: string) => Promise<unknown> | undefined;
+/**
+ * Show the "session expired" message
+ * @author Gabe Abrams
+ */
+export declare const showSessionExpiredMessage: () => void;
+declare const AppWrapper: React.FC<Props>;
+export default AppWrapper;

package/lib/esm/types/components/ErrorBox.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Displays an error
+ * @author Gabe Abrams
+ */
+import React from 'react';
+declare type Props = {
+    error: any;
+    title?: string;
+    onClose?: () => void;
+};
+declare const ErrorBox: React.FC<Props>;
+export default ErrorBox;

package/lib/esm/types/components/LoadingSpinner.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Loading spinner/indicator
+ * @author Gabe Abrams
+ */
+/// <reference types="react" />
+declare const LoadingSpinner: () => JSX.Element;
+export default LoadingSpinner;

package/lib/esm/types/components/Modal.d.ts

@@ -0,0 +1,40 @@
+/**
+ * A generic popup modal
+ * @author Gabe Abrams
+ */
+import React from 'react';
+import Variant from '../types/Variant';
+import ModalButtonType from '../types/ModalButtonType';
+import ModalSize from '../types/ModalSize';
+import ModalType from '../types/ModalType';
+declare type Props = {
+    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>;
+export default Modal;

package/lib/esm/types/components/TabBox.d.ts

@@ -0,0 +1,11 @@
+/**
+ * A box with a tab on the top that holds buttons and other content
+ * @author Gabe Abrams
+ */
+import React from 'react';
+declare type Props = {
+    title: React.ReactNode;
+    children: React.ReactNode;
+};
+declare const TabBox: React.FC<Props>;
+export default TabBox;

package/lib/esm/types/errors/ErrorWithCode.d.ts

@@ -0,0 +1,9 @@
+/**
+ * An error with a code
+ * @author Gabe Abrams
+ */
+declare class ErrorWithCode extends Error {
+    code: string;
+    constructor(message: string, code: string);
+}
+export default ErrorWithCode;

package/lib/esm/types/helpers/abbreviate.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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;
+export default abbreviate;

package/lib/esm/types/helpers/alert.d.ts

@@ -0,0 +1,2 @@
+declare const alert: (title: string, text: string) => Promise<unknown>;
+export default alert;

package/lib/esm/types/helpers/avg.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 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;
+export default avg;

package/lib/esm/types/helpers/ceilToNumDecimals.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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;
+export default ceilToNumDecimals;

package/lib/esm/types/helpers/confirm.d.ts

@@ -0,0 +1,2 @@
+declare const confirm: (title: string, text: string) => Promise<boolean>;
+export default confirm;

package/lib/esm/types/helpers/floorToNumDecimals.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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;
+export default floorToNumDecimals;

package/lib/esm/types/helpers/forceNumIntoBounds.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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;
+export default forceNumIntoBounds;

package/lib/esm/types/helpers/handleError.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Handle an error and respond to the client
+ * @author Gabe Abrams
+ * @param res express response
+ * @param error error info
+ * @param opts.err the error to send to the client
+ *   or the error message
+ * @param [opts.code] an error code (only used if err.code is not
+ *   included)
+ * @param [opts.status=500] the https status code to use
+ *   defined)
+ */
+declare const handleError: (res: any, error: any) => undefined;
+export default handleError;

package/lib/esm/types/helpers/handleSuccess.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Send successful API response
+ * @author Gabe Abrams
+ * @param res express response
+ * @param body the body of the response to send to the client
+ */
+declare const handleSuccess: (res: any, body: any) => undefined;
+export default handleSuccess;

package/lib/esm/types/helpers/padDecimalZeros.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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;
+export default padDecimalZeros;

package/lib/esm/types/helpers/padZerosLeft.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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;
+export default padZerosLeft;

package/lib/esm/types/helpers/parseRequest.d.ts

@@ -0,0 +1,21 @@
+import ParamType from '../types/ParamType';
+/**
+ * Parse express request params and body
+ * @author Gabe Abrams
+ * @param opts object containing all arguments
+ * @param opts.req express request instance
+ * @param opts.res express response instance
+ * @param opts.params map of parameters that should be parsed out of the request
+ * @returns parsed params + user info from session (if it exists) or undefined
+ *   if an error occurred
+ */
+declare const parseRequest: (opts: {
+    req: any;
+    res: any;
+    params: {
+        [x: string]: ParamType;
+    };
+}) => {
+    [x: string]: any;
+} | undefined;
+export default parseRequest;

package/lib/esm/types/helpers/roundToNumDecimals.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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;
+export default roundToNumDecimals;

package/lib/esm/types/helpers/showFatalError.d.ts

@@ -0,0 +1,2 @@
+declare const showFatalError: (error: any, errorTitle?: string) => Promise<unknown> | undefined;
+export default showFatalError;

package/lib/esm/types/helpers/sum.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 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;
+export default sum;

package/lib/esm/types/helpers/visitServerEndpoint.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Set the session expiry handler
+ * @author Gabe Abrams
+ * @param handler new handler to use when session expires
+ */
+export declare const setSessionExpiryHandler: (handler: () => void) => void;
+/**
+ * Visit an endpoint on the server [for client only]
+ * @author Gabe Abrams
+ * @param opts object containing all arguments
+ * @param opts.path - the path of the server endpoint
+ * @param [opts.method=GET] - the method of the endpoint
+ * @param [opts.params] - query/body parameters to include
+ * @returns response from server
+ */
+declare const visitServerEndpoint: (opts: {
+    path: string;
+    method?: "GET" | "POST" | "DELETE" | "PUT" | undefined;
+    params?: {
+        [x: string]: any;
+    } | undefined;
+}) => Promise<any>;
+export default visitServerEndpoint;

package/lib/esm/types/helpers/waitMs.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Wait for a certain number of ms
+ * @author Gabe Abrams
+ * @param ms number of ms to wait
+ */
+declare const waitMs: (ms?: number) => Promise<unknown>;
+export default waitMs;

package/lib/esm/types/index.d.ts

@@ -0,0 +1,22 @@
+import AppWrapper, { alert, confirm, showFatalError } from './components/AppWrapper';
+import LoadingSpinner from './components/LoadingSpinner';
+import ErrorBox from './components/ErrorBox';
+import Modal from './components/Modal';
+import TabBox from './components/TabBox';
+import ErrorWithCode from './errors/ErrorWithCode';
+import abbreviate from './helpers/abbreviate';
+import avg from './helpers/avg';
+import ceilToNumDecimals from './helpers/ceilToNumDecimals';
+import floorToNumDecimals from './helpers/floorToNumDecimals';
+import forceNumIntoBounds from './helpers/forceNumIntoBounds';
+import padDecimalZeros from './helpers/padDecimalZeros';
+import padZerosLeft from './helpers/padZerosLeft';
+import roundToNumDecimals from './helpers/roundToNumDecimals';
+import sum from './helpers/sum';
+import waitMs from './helpers/waitMs';
+import ModalButtonType from './types/ModalButtonType';
+import ModalSize from './types/ModalSize';
+import ModalType from './types/ModalType';
+import ReactKitErrorCode from './types/ReactKitErrorCode';
+import Variant from './types/Variant';
+export { AppWrapper, LoadingSpinner, ErrorBox, Modal, TabBox, alert, confirm, showFatalError, ErrorWithCode, abbreviate, avg, ceilToNumDecimals, floorToNumDecimals, forceNumIntoBounds, padDecimalZeros, padZerosLeft, roundToNumDecimals, sum, waitMs, ModalButtonType, ModalSize, ModalType, ReactKitErrorCode, Variant, };

package/lib/esm/types/types/ModalButtonType.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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"
+}
+export default ModalButtonType;

package/lib/esm/types/types/ModalSize.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Modal sizes
+ * @author Gabe Abrams
+ */
+declare enum ModalSize {
+    Small = "sm",
+    Medium = "md",
+    Large = "lg",
+    ExtraLarge = "xl"
+}
+export default ModalSize;

package/lib/esm/types/types/ModalType.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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 = "-"
+}
+export default ModalType;

package/lib/esm/types/types/ParamType.d.ts

@@ -0,0 +1,17 @@
+/**
+ * API param types
+ * @author Gabe Abrams
+ */
+declare enum ParamType {
+    Boolean = "boolean",
+    BooleanOptional = "boolean-optional",
+    Float = "float",
+    FloatOptional = "float-optional",
+    Int = "int",
+    IntOptional = "int-optional",
+    JSON = "json",
+    JSONOptional = "json-optional",
+    String = "string",
+    StringOptional = "string-optional"
+}
+export default ParamType;

package/lib/esm/types/types/ReactKitErrorCode.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 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 default ReactKitErrorCode;

package/lib/esm/types/types/Variant.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Bootstrap variants
+ * @author Gabe Abrams
+ */
+declare enum Variant {
+    Primary = "primary",
+    Secondary = "secondary",
+    Success = "success",
+    Warning = "warning",
+    Info = "info",
+    Danger = "danger",
+    Light = "light",
+    Dark = "dark"
+}
+export default Variant;