@capsitech/react-utilities 0.1.4 → 0.1.5

package/lib/Hooks/useShortcuts.js

@@ -1,91 +1,91 @@
-import React from 'react';
-const blacklistedTargets = ['INPUT', 'TEXTAREA', 'SELECT'];
-const keysReducer = (state, action) => {
-    switch (action.type) {
-        case 'set-key-down':
-            const keydownState = { ...state, [action.key]: true };
-            return keydownState;
-        case 'set-key-up':
-            const keyUpState = { ...state, [action.key]: false };
-            return keyUpState;
-        case 'reset-keys':
-            const resetState = { ...action.data };
-            return resetState;
-        default:
-            return state;
-    }
-};
-export const useShortcuts = (shortcutKeys, callback, options) => {
-    if (!Array.isArray(shortcutKeys))
-        throw new Error('The first parameter to `useShortcuts` must be an ordered array of `KeyboardEvent.key` strings.');
-    if (!shortcutKeys.length)
-        throw new Error('The first parameter to `useShortcuts` must contain atleast one `KeyboardEvent.key` string.');
-    if (!callback || typeof callback !== 'function')
-        throw new Error('The second parameter to `useShortcuts` must be a function that will be envoked when the keys are pressed.');
-    const { overrideSystem } = options || {};
-    const initalKeyMapping = shortcutKeys.reduce((currentKeys, key) => {
-        currentKeys[key.toLowerCase()] = false;
-        return currentKeys;
-    }, {});
-    const [keys, setKeys] = React.useReducer(keysReducer, initalKeyMapping);
-    const keydownListener = React.useCallback((assignedKey) => (keydownEvent) => {
-        const loweredKey = assignedKey.toLowerCase();
-        if (keydownEvent.repeat)
-            return;
-        if (blacklistedTargets.includes(keydownEvent.target.tagName))
-            return;
-        if (loweredKey !== keydownEvent.key.toLowerCase())
-            return;
-        if (keys[loweredKey] === undefined)
-            return;
-        if (overrideSystem) {
-            keydownEvent.preventDefault();
-            disabledEventPropagation(keydownEvent);
-        }
-        setKeys({ type: 'set-key-down', key: loweredKey });
-        return false;
-    }, [keys, overrideSystem]);
-    const keyupListener = React.useCallback((assignedKey) => (keyupEvent) => {
-        const raisedKey = assignedKey.toLowerCase();
-        if (blacklistedTargets.includes(keyupEvent.target.tagName))
-            return;
-        if (keyupEvent.key.toLowerCase() !== raisedKey)
-            return;
-        if (keys[raisedKey] === undefined)
-            return;
-        if (overrideSystem) {
-            keyupEvent.preventDefault();
-            disabledEventPropagation(keyupEvent);
-        }
-        setKeys({ type: 'set-key-up', key: raisedKey });
-        return false;
-    }, [keys, overrideSystem]);
-    React.useEffect(() => {
-        //console.log('keys', keys);
-        if (!Object.values(keys).filter((value) => !value).length) {
-            callback(keys);
-            setKeys({ type: 'reset-keys', data: initalKeyMapping });
-        }
-        else {
-            setKeys({ type: '' });
-        }
-    }, [callback, keys]);
-    React.useEffect(() => {
-        shortcutKeys.forEach((k) => window.addEventListener('keydown', keydownListener(k)));
-        return () => shortcutKeys.forEach((k) => window.removeEventListener('keydown', keydownListener(k)));
-    }, []);
-    React.useEffect(() => {
-        shortcutKeys.forEach((k) => window.addEventListener('keyup', keyupListener(k)));
-        return () => shortcutKeys.forEach((k) => window.removeEventListener('keyup', keyupListener(k)));
-    }, []);
-};
-export function disabledEventPropagation(e) {
-    if (e) {
-        if (e.stopPropagation) {
-            e.stopPropagation();
-        }
-        else if (window.event) {
-            window.event.cancelBubble = true;
-        }
-    }
-}
+import React from 'react';
+const blacklistedTargets = ['INPUT', 'TEXTAREA', 'SELECT'];
+const keysReducer = (state, action) => {
+    switch (action.type) {
+        case 'set-key-down':
+            const keydownState = { ...state, [action.key]: true };
+            return keydownState;
+        case 'set-key-up':
+            const keyUpState = { ...state, [action.key]: false };
+            return keyUpState;
+        case 'reset-keys':
+            const resetState = { ...action.data };
+            return resetState;
+        default:
+            return state;
+    }
+};
+export const useShortcuts = (shortcutKeys, callback, options) => {
+    if (!Array.isArray(shortcutKeys))
+        throw new Error('The first parameter to `useShortcuts` must be an ordered array of `KeyboardEvent.key` strings.');
+    if (!shortcutKeys.length)
+        throw new Error('The first parameter to `useShortcuts` must contain atleast one `KeyboardEvent.key` string.');
+    if (!callback || typeof callback !== 'function')
+        throw new Error('The second parameter to `useShortcuts` must be a function that will be envoked when the keys are pressed.');
+    const { overrideSystem } = options || {};
+    const initalKeyMapping = shortcutKeys.reduce((currentKeys, key) => {
+        currentKeys[key.toLowerCase()] = false;
+        return currentKeys;
+    }, {});
+    const [keys, setKeys] = React.useReducer(keysReducer, initalKeyMapping);
+    const keydownListener = React.useCallback((assignedKey) => (keydownEvent) => {
+        const loweredKey = assignedKey.toLowerCase();
+        if (keydownEvent.repeat)
+            return;
+        if (blacklistedTargets.includes(keydownEvent.target.tagName))
+            return;
+        if (loweredKey !== keydownEvent.key.toLowerCase())
+            return;
+        if (keys[loweredKey] === undefined)
+            return;
+        if (overrideSystem) {
+            keydownEvent.preventDefault();
+            disabledEventPropagation(keydownEvent);
+        }
+        setKeys({ type: 'set-key-down', key: loweredKey });
+        return false;
+    }, [keys, overrideSystem]);
+    const keyupListener = React.useCallback((assignedKey) => (keyupEvent) => {
+        const raisedKey = assignedKey.toLowerCase();
+        if (blacklistedTargets.includes(keyupEvent.target.tagName))
+            return;
+        if (keyupEvent.key.toLowerCase() !== raisedKey)
+            return;
+        if (keys[raisedKey] === undefined)
+            return;
+        if (overrideSystem) {
+            keyupEvent.preventDefault();
+            disabledEventPropagation(keyupEvent);
+        }
+        setKeys({ type: 'set-key-up', key: raisedKey });
+        return false;
+    }, [keys, overrideSystem]);
+    React.useEffect(() => {
+        //console.log('keys', keys);
+        if (!Object.values(keys).filter((value) => !value).length) {
+            callback(keys);
+            setKeys({ type: 'reset-keys', data: initalKeyMapping });
+        }
+        else {
+            setKeys({ type: '' });
+        }
+    }, [callback, keys]);
+    React.useEffect(() => {
+        shortcutKeys.forEach((k) => window.addEventListener('keydown', keydownListener(k)));
+        return () => shortcutKeys.forEach((k) => window.removeEventListener('keydown', keydownListener(k)));
+    }, []);
+    React.useEffect(() => {
+        shortcutKeys.forEach((k) => window.addEventListener('keyup', keyupListener(k)));
+        return () => shortcutKeys.forEach((k) => window.removeEventListener('keyup', keyupListener(k)));
+    }, []);
+};
+export function disabledEventPropagation(e) {
+    if (e) {
+        if (e.stopPropagation) {
+            e.stopPropagation();
+        }
+        else if (window.event) {
+            window.event.cancelBubble = true;
+        }
+    }
+}

package/lib/Utilities/ApiUtility.axios.d.ts

@@ -1,60 +1,60 @@
-import { AxiosError, AxiosRequestConfig, AxiosResponse } from 'axios';
-export interface IApiResponse<T = any> {
-    status: boolean;
-    result: T;
-    message?: string;
-    errors?: {
-        number: number;
-        message: string;
-        suggestion: string;
-        exception: any;
-    }[];
-}
-export interface IApiListResult<T = any> {
-    totalRecords: number;
-    items: T[];
-    moreRecords?: boolean;
-    continuationToken?: string;
-}
-export interface IApiListResultWithTotal<TItem = any, TTotal = any> extends IApiListResult<TItem> {
-    total: TTotal;
-}
-export declare enum HttpMethods {
-    get = "get",
-    post = "post"
-}
-export declare enum FileDownloadStatus {
-    downloading = "downloading",
-    done = "done",
-    error = "error"
-}
-export type DownloadCallback = (status: FileDownloadStatus, error?: any) => void;
-export interface IAxiosRequestConfigWithoutParams extends Omit<AxiosRequestConfig, 'params' | 'paramsSerializer'> {
-    contentType?: string;
-}
-declare class ApiUtilityBase {
-    accessToken?: string;
-    handleError: (error: string, errors?: any) => void;
-    getResponse: <T = any>(endpoint: string, params?: any, options?: IAxiosRequestConfigWithoutParams) => Promise<AxiosResponse<T, any>>;
-    get: <T = IApiResponse<any>>(endpoint: string, params?: any, throwErrorOn401?: boolean, options?: IAxiosRequestConfigWithoutParams) => Promise<T>;
-    getResult: <T = any>(endpoint: string, params?: any, throwErrorOn401?: boolean, options?: IAxiosRequestConfigWithoutParams) => Promise<T | null>;
-    post: <T = IApiResponse<any>>(endpoint: string, body: any, contentType?: string, options?: IAxiosRequestConfigWithoutParams) => Promise<T>;
-    put: <T = IApiResponse<any>>(endpoint: string, body: any, contentType?: string, options?: IAxiosRequestConfigWithoutParams) => Promise<T>;
-    appendFormDataValues: (form: FormData, values: any, preFix?: string) => void;
-    postForm: <T = IApiResponse<any>>(endpoint: string, params: any, options?: IAxiosRequestConfigWithoutParams) => Promise<IApiResponse<any> | T>;
-    putForm: <T = IApiResponse<any>>(endpoint: string, params: any, options?: IAxiosRequestConfigWithoutParams) => Promise<IApiResponse<any> | T>;
-    delete: <T = IApiResponse<any>>(endpoint: string, contentType?: string, options?: IAxiosRequestConfigWithoutParams) => Promise<T>;
-    private getFileName;
-    downloadFile: (endpoint: string, params?: any, method?: HttpMethods, options?: IAxiosRequestConfigWithoutParams) => Promise<{
-        status: FileDownloadStatus;
-        error?: any;
-    }>;
-    getAuthHeader: (contentType?: string) => any;
-    handleResponse: <T = IApiResponse<any>>(response: AxiosResponse<T, any>, throwErrorOn401?: boolean) => T;
-    handleAxiosError: <T = IApiResponse<any>>(error: AxiosError, throwErrorOn401?: boolean) => T;
-    handleErrorResponse: (message: any, errors?: any) => void;
-    _axiosOptions: (options?: IAxiosRequestConfigWithoutParams) => AxiosRequestConfig;
-    getBaseUrl: () => string | undefined;
-}
-export declare const ApiUtility: ApiUtilityBase;
-export {};
+import { AxiosError, AxiosRequestConfig, AxiosResponse } from 'axios';
+export interface IApiResponse<T = any> {
+    status: boolean;
+    result: T;
+    message?: string;
+    errors?: {
+        number: number;
+        message: string;
+        suggestion: string;
+        exception: any;
+    }[];
+}
+export interface IApiListResult<T = any> {
+    totalRecords: number;
+    items: T[];
+    moreRecords?: boolean;
+    continuationToken?: string;
+}
+export interface IApiListResultWithTotal<TItem = any, TTotal = any> extends IApiListResult<TItem> {
+    total: TTotal;
+}
+export declare enum HttpMethods {
+    get = "get",
+    post = "post"
+}
+export declare enum FileDownloadStatus {
+    downloading = "downloading",
+    done = "done",
+    error = "error"
+}
+export type DownloadCallback = (status: FileDownloadStatus, error?: any) => void;
+export interface IAxiosRequestConfigWithoutParams extends Omit<AxiosRequestConfig, 'params' | 'paramsSerializer'> {
+    contentType?: string;
+}
+declare class ApiUtilityBase {
+    accessToken?: string;
+    handleError: (error: string, errors?: any) => void;
+    getResponse: <T = any>(endpoint: string, params?: any, options?: IAxiosRequestConfigWithoutParams) => Promise<AxiosResponse<T, any>>;
+    get: <T = IApiResponse>(endpoint: string, params?: any, throwErrorOn401?: boolean, options?: IAxiosRequestConfigWithoutParams) => Promise<T>;
+    getResult: <T = any>(endpoint: string, params?: any, throwErrorOn401?: boolean, options?: IAxiosRequestConfigWithoutParams) => Promise<T | null>;
+    post: <T = IApiResponse>(endpoint: string, body: any, contentType?: string, options?: IAxiosRequestConfigWithoutParams) => Promise<T>;
+    put: <T = IApiResponse>(endpoint: string, body: any, contentType?: string, options?: IAxiosRequestConfigWithoutParams) => Promise<T>;
+    appendFormDataValues: (form: FormData, values: any, preFix?: string) => void;
+    postForm: <T = IApiResponse>(endpoint: string, params: any, options?: IAxiosRequestConfigWithoutParams) => Promise<IApiResponse<any> | T>;
+    putForm: <T = IApiResponse>(endpoint: string, params: any, options?: IAxiosRequestConfigWithoutParams) => Promise<IApiResponse<any> | T>;
+    delete: <T = IApiResponse>(endpoint: string, contentType?: string, options?: IAxiosRequestConfigWithoutParams) => Promise<T>;
+    private getFileName;
+    downloadFile: (endpoint: string, params?: any, method?: HttpMethods, options?: IAxiosRequestConfigWithoutParams) => Promise<{
+        status: FileDownloadStatus;
+        error?: any;
+    }>;
+    getAuthHeader: (contentType?: string) => any;
+    handleResponse: <T = IApiResponse>(response: AxiosResponse<T>, throwErrorOn401?: boolean) => T;
+    handleAxiosError: <T = IApiResponse>(error: AxiosError, throwErrorOn401?: boolean) => T;
+    handleErrorResponse: (message: any, errors?: any) => void;
+    _axiosOptions: (options?: IAxiosRequestConfigWithoutParams) => AxiosRequestConfig;
+    getBaseUrl: () => string | undefined;
+}
+export declare const ApiUtility: ApiUtilityBase;
+export {};