@j2inn/fin5-ui-utils 6.0.5-beta.0 → 6.1.0

package/dist_es/react/components/ErrorBoundary.js

@@ -1,124 +1,124 @@
-/*
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
- */
-import React, { useState } from 'react';
-import { Button, Checkbox, Divider, Message, Container, ColorVals, } from '@j2inn/ui';
-import { usei18n } from '@j2inn/utils';
-import { createUseStyles, useTheme } from 'react-jss';
-const boundryStyles = createUseStyles((theme) => ({
-    errorBoundry: {
-        backgroundColor: theme.bodyBg,
-        flex: `1 1 auto`,
-    },
-    boundryContainer: {
-        margin: '0 auto',
-        flex: `1 1 auto`,
-        padding: `2rem`,
-        maxWidth: 1024,
-        backgroundColor: theme.bgColor,
-        [`& h1, & h3`]: {
-            paddingBottom: `1rem`,
-        },
-    },
-    errorDetails: {
-        [`& pre`]: {
-            overflow: 'auto',
-            marginTop: '1rem',
-            backgroundColor: ColorVals.Black,
-            color: ColorVals.White,
-            padding: '0.3rem',
-        },
-    },
-}));
-function get(i18n, key, fallback) {
-    return i18n.has(key) ? i18n.get(key) : fallback;
-}
-/**
- * Format an error message into something more useful for the clipboard.
- */
-function formatErrorMessage(error, appId) {
-    return JSON.stringify({
-        timestamp: new Date().toISOString(),
-        appId: appId ?? '',
-        location: location.href,
-        navigator: {
-            cookieEnabled: navigator.cookieEnabled,
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            deviceMemory: navigator.deviceMemory,
-            language: navigator.language,
-            languages: navigator.languages,
-            onLine: navigator.onLine,
-            userAgent: navigator.userAgent,
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            userAgentData: navigator.userAgentData,
-            vendor: navigator.vendor,
-        },
-        error: String(error.stack),
-    }, null, 2);
-}
-/**
- * Shows the internal error details to a user.
- */
-const ErrorDetails = ({ showDetails, setShowDetails, error, appId, }) => {
-    const i18n = usei18n();
-    const classes = boundryStyles();
-    const theme = useTheme();
-    const copyToClipboard = () => {
-        navigator.clipboard.writeText(formatErrorMessage(error, appId));
-        Message.success(theme, get(i18n, 'finUi.errorBoundary.copiedErrorToClipboard', 'Copied error to clipboard'));
-    };
-    return (React.createElement("div", { className: classes.errorDetails },
-        React.createElement(Checkbox, { onChange: (e) => {
-                setShowDetails(e.target.checked);
-            }, defaultChecked: showDetails, value: showDetails }, get(i18n, 'finUi.errorBoundary.showDetails', 'Show details')),
-        showDetails && (React.createElement(React.Fragment, null,
-            React.createElement("pre", null, error.stack),
-            React.createElement(Container, { horizontal: true, middle: true, right: true },
-                React.createElement(Button, { onClick: copyToClipboard }, get(i18n, 'finUi.errorBoundary.copyToClipboard', 'Copy to clipboard')))))));
-};
-/**
- * The inner error boundary component. This is required so
- * we can use hooks that can't be used in a normal class component.
- */
-const ErrorBoundaryInner = ({ error, mode, appId, showReportDialog, }) => {
-    const i18n = usei18n();
-    const [showDetails, setShowDetails] = useState(true);
-    const classes = boundryStyles();
-    const title = `finUi.errorBoundary.${mode}.title`;
-    const appName = `${appId}.name`;
-    const header = get(i18n, title, mode === 'global' ? 'Error' : 'Application error') +
-        (appId ? `: ${get(i18n, appName, appName)}` : '');
-    const continueMsg = get(i18n, `finUi.errorBoundary.${mode}.continue`, mode === 'global'
-        ? 'To continue, please reload or navigate to the home page.'
-        : 'To continue, please reload, navigate to the home page or another application.');
-    return (React.createElement(Container, { vertical: true, top: true, center: true, className: classes.errorBoundry },
-        React.createElement("div", { className: classes.boundryContainer, style: { gap: `1rem` } },
-            React.createElement("h1", null, header),
-            React.createElement("h3", null, get(i18n, 'finUi.errorBoundary.description', 'The application has encountered an error when trying to display some content.')),
-            React.createElement("p", null, continueMsg),
-            React.createElement("div", null,
-                React.createElement(ErrorDetails, { showDetails: showDetails, setShowDetails: setShowDetails, error: error, appId: appId })),
-            React.createElement(Divider, null),
-            React.createElement(Container, { horizontal: true, middle: true, left: true, style: { gap: `1rem` } },
-                React.createElement(Button, { onClick: () => window.location.reload(), type: 'primary' }, get(i18n, 'finUi.common.reload', 'Reload')),
-                React.createElement(Button, { onClick: () => window.location.assign('/') }, get(i18n, 'finUi.common.home', 'Home'))),
-            showReportDialog && (React.createElement("div", { style: { marginTop: `0.5rem` } },
-                React.createElement("small", { onClick: showReportDialog }, get(i18n, 'finUi.errorBoundary.additionalDetails', 'If you’d like, click here to include an additional error report to our team. Any details you provide will be helpful.')))))));
-};
-/**
- * A common error boundary used to capture errors.
- */
-export class ErrorBoundary extends React.Component {
-    state = {};
-    componentDidCatch(error, info) {
-        this.props.onError?.(error);
-        console.error(error, info);
-    }
-    static getDerivedStateFromError(error) {
-        return { error };
-    }
-    render() {
-        return this.state.error ? (React.createElement(ErrorBoundaryInner, { error: this.state.error, mode: this.props.mode, appId: this.props.appId, showReportDialog: this.props.showReportDialog })) : (this.props.children);
-    }
-}
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+import React, { useState } from 'react';
+import { Button, Checkbox, Divider, Message, Container, ColorVals, } from '@j2inn/ui';
+import { usei18n } from '@j2inn/utils';
+import { createUseStyles, useTheme } from 'react-jss';
+const boundryStyles = createUseStyles((theme) => ({
+    errorBoundry: {
+        backgroundColor: theme.bodyBg,
+        flex: `1 1 auto`,
+    },
+    boundryContainer: {
+        margin: '0 auto',
+        flex: `1 1 auto`,
+        padding: `2rem`,
+        maxWidth: 1024,
+        backgroundColor: theme.bgColor,
+        [`& h1, & h3`]: {
+            paddingBottom: `1rem`,
+        },
+    },
+    errorDetails: {
+        [`& pre`]: {
+            overflow: 'auto',
+            marginTop: '1rem',
+            backgroundColor: ColorVals.Black,
+            color: ColorVals.White,
+            padding: '0.3rem',
+        },
+    },
+}));
+function get(i18n, key, fallback) {
+    return i18n.has(key) ? i18n.get(key) : fallback;
+}
+/**
+ * Format an error message into something more useful for the clipboard.
+ */
+function formatErrorMessage(error, appId) {
+    return JSON.stringify({
+        timestamp: new Date().toISOString(),
+        appId: appId ?? '',
+        location: location.href,
+        navigator: {
+            cookieEnabled: navigator.cookieEnabled,
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            deviceMemory: navigator.deviceMemory,
+            language: navigator.language,
+            languages: navigator.languages,
+            onLine: navigator.onLine,
+            userAgent: navigator.userAgent,
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            userAgentData: navigator.userAgentData,
+            vendor: navigator.vendor,
+        },
+        error: String(error.stack),
+    }, null, 2);
+}
+/**
+ * Shows the internal error details to a user.
+ */
+const ErrorDetails = ({ showDetails, setShowDetails, error, appId, }) => {
+    const i18n = usei18n();
+    const classes = boundryStyles();
+    const theme = useTheme();
+    const copyToClipboard = () => {
+        navigator.clipboard.writeText(formatErrorMessage(error, appId));
+        Message.success(theme, get(i18n, 'finUi.errorBoundary.copiedErrorToClipboard', 'Copied error to clipboard'));
+    };
+    return (React.createElement("div", { className: classes.errorDetails },
+        React.createElement(Checkbox, { onChange: (e) => {
+                setShowDetails(e.target.checked);
+            }, defaultChecked: showDetails, value: showDetails }, get(i18n, 'finUi.errorBoundary.showDetails', 'Show details')),
+        showDetails && (React.createElement(React.Fragment, null,
+            React.createElement("pre", null, error.stack),
+            React.createElement(Container, { horizontal: true, middle: true, right: true },
+                React.createElement(Button, { onClick: copyToClipboard }, get(i18n, 'finUi.errorBoundary.copyToClipboard', 'Copy to clipboard')))))));
+};
+/**
+ * The inner error boundary component. This is required so
+ * we can use hooks that can't be used in a normal class component.
+ */
+const ErrorBoundaryInner = ({ error, mode, appId, showReportDialog, }) => {
+    const i18n = usei18n();
+    const [showDetails, setShowDetails] = useState(true);
+    const classes = boundryStyles();
+    const title = `finUi.errorBoundary.${mode}.title`;
+    const appName = `${appId}.name`;
+    const header = get(i18n, title, mode === 'global' ? 'Error' : 'Application error') +
+        (appId ? `: ${get(i18n, appName, appName)}` : '');
+    const continueMsg = get(i18n, `finUi.errorBoundary.${mode}.continue`, mode === 'global'
+        ? 'To continue, please reload or navigate to the home page.'
+        : 'To continue, please reload, navigate to the home page or another application.');
+    return (React.createElement(Container, { vertical: true, top: true, center: true, className: classes.errorBoundry },
+        React.createElement("div", { className: classes.boundryContainer, style: { gap: `1rem` } },
+            React.createElement("h1", null, header),
+            React.createElement("h3", null, get(i18n, 'finUi.errorBoundary.description', 'The application has encountered an error when trying to display some content.')),
+            React.createElement("p", null, continueMsg),
+            React.createElement("div", null,
+                React.createElement(ErrorDetails, { showDetails: showDetails, setShowDetails: setShowDetails, error: error, appId: appId })),
+            React.createElement(Divider, null),
+            React.createElement(Container, { horizontal: true, middle: true, left: true, style: { gap: `1rem` } },
+                React.createElement(Button, { onClick: () => window.location.reload(), type: 'primary' }, get(i18n, 'finUi.common.reload', 'Reload')),
+                React.createElement(Button, { onClick: () => window.location.assign('/') }, get(i18n, 'finUi.common.home', 'Home'))),
+            showReportDialog && (React.createElement("div", { style: { marginTop: `0.5rem` } },
+                React.createElement("small", { onClick: showReportDialog }, get(i18n, 'finUi.errorBoundary.additionalDetails', 'If you’d like, click here to include an additional error report to our team. Any details you provide will be helpful.')))))));
+};
+/**
+ * A common error boundary used to capture errors.
+ */
+export class ErrorBoundary extends React.Component {
+    state = {};
+    componentDidCatch(error, info) {
+        this.props.onError?.(error);
+        console.error(error, info);
+    }
+    static getDerivedStateFromError(error) {
+        return { error };
+    }
+    render() {
+        return this.state.error ? (React.createElement(ErrorBoundaryInner, { error: this.state.error, mode: this.props.mode, appId: this.props.appId, showReportDialog: this.props.showReportDialog })) : (this.props.children);
+    }
+}
 //# sourceMappingURL=ErrorBoundary.js.map

package/dist_es/react/components/ErrorDisplayer.d.ts

@@ -1,19 +1,19 @@
-import React, { ErrorInfo, ReactNode } from 'react';
-interface ErrorBoundaryState {
-    error?: Error;
-}
-interface ErrorBoundaryProps {
-    children: ReactNode;
-}
-export declare class DefaultErrorBoundary extends React.Component<ErrorBoundaryProps> {
-    state: ErrorBoundaryState;
-    static getDerivedStateFromError(error: Error): ErrorBoundaryState;
-    componentDidCatch(error: Error, errorInfo: ErrorInfo): void;
-    render(): ReactNode;
-}
-export interface ErrorDisplayerProps {
-    error: Error;
-    extra: React.ReactNode;
-}
-export declare const ErrorDisplayer: React.FC<ErrorDisplayerProps>;
-export {};
+import React, { ErrorInfo, ReactNode } from 'react';
+interface ErrorBoundaryState {
+    error?: Error;
+}
+interface ErrorBoundaryProps {
+    children: ReactNode;
+}
+export declare class DefaultErrorBoundary extends React.Component<ErrorBoundaryProps> {
+    state: ErrorBoundaryState;
+    static getDerivedStateFromError(error: Error): ErrorBoundaryState;
+    componentDidCatch(error: Error, errorInfo: ErrorInfo): void;
+    render(): ReactNode;
+}
+export interface ErrorDisplayerProps {
+    error: Error;
+    extra: React.ReactNode;
+}
+export declare const ErrorDisplayer: React.FC<ErrorDisplayerProps>;
+export {};

package/dist_es/react/components/ErrorDisplayer.js

@@ -1,29 +1,29 @@
-import { Button, Collapse, Container, Result, Typography } from '@j2inn/ui';
-import React from 'react';
-export class DefaultErrorBoundary extends React.Component {
-    state = {};
-    static getDerivedStateFromError(error) {
-        // Update state so the next render will show the fallback UI.
-        return { error: error };
-    }
-    componentDidCatch(error, errorInfo) {
-        // You can also log the error to an error reporting service
-        console.error(error, errorInfo);
-    }
-    render() {
-        if (this.state.error) {
-            // You can render any custom fallback UI
-            return (React.createElement(ErrorDisplayer, { error: this.state.error, extra: [
-                    React.createElement(Button, { type: 'primary', key: 'refresh', onClick: () => window.location.reload() }, "Refresh The Page"),
-                ] }));
-        }
-        return this.props.children;
-    }
-}
-export const ErrorDisplayer = ({ error, extra, }) => {
-    return (React.createElement(Result, { status: 'error', title: 'Ouch... Something Went Wrong', subTitle: React.createElement(Container, { center: true },
-            React.createElement(Collapse, { style: { width: 600, textAlign: 'left' } },
-                React.createElement(Collapse.Panel, { header: `${error.toString()}`, key: '1' },
-                    React.createElement(Typography.Text, { style: { width: 400 } }, error.stack)))), extra: extra }));
-};
+import { Button, Collapse, Container, Result, Typography } from '@j2inn/ui';
+import React from 'react';
+export class DefaultErrorBoundary extends React.Component {
+    state = {};
+    static getDerivedStateFromError(error) {
+        // Update state so the next render will show the fallback UI.
+        return { error: error };
+    }
+    componentDidCatch(error, errorInfo) {
+        // You can also log the error to an error reporting service
+        console.error(error, errorInfo);
+    }
+    render() {
+        if (this.state.error) {
+            // You can render any custom fallback UI
+            return (React.createElement(ErrorDisplayer, { error: this.state.error, extra: [
+                    React.createElement(Button, { type: 'primary', key: 'refresh', onClick: () => window.location.reload() }, "Refresh The Page"),
+                ] }));
+        }
+        return this.props.children;
+    }
+}
+export const ErrorDisplayer = ({ error, extra, }) => {
+    return (React.createElement(Result, { status: 'error', title: 'Ouch... Something Went Wrong', subTitle: React.createElement(Container, { center: true },
+            React.createElement(Collapse, { style: { width: 600, textAlign: 'left' } },
+                React.createElement(Collapse.Panel, { header: `${error.toString()}`, key: '1' },
+                    React.createElement(Typography.Text, { style: { width: 400 } }, error.stack)))), extra: extra }));
+};
 //# sourceMappingURL=ErrorDisplayer.js.map

package/dist_es/react/components/Loader.d.ts

@@ -1,9 +1,9 @@
-import React from 'react';
-/**
- * A simple UI loader.
- */
-declare const Loader: ({ loading, children, }: {
-    loading: boolean;
-    children?: React.ReactNode;
-}) => JSX.Element;
-export default Loader;
+import React from 'react';
+/**
+ * A simple UI loader.
+ */
+declare const Loader: ({ loading, children, }: {
+    loading: boolean;
+    children?: React.ReactNode;
+}) => JSX.Element;
+export default Loader;

package/dist_es/react/components/Loader.js

@@ -1,13 +1,13 @@
-/*
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
- */
-import React from 'react';
-import { LoadingSpinner } from './LoadingSpinner';
-/**
- * A simple UI loader.
- */
-const Loader = ({ loading, children, }) => {
-    return loading ? React.createElement(LoadingSpinner, null) : React.createElement(React.Fragment, null, children);
-};
-export default Loader;
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+import React from 'react';
+import { LoadingSpinner } from './LoadingSpinner';
+/**
+ * A simple UI loader.
+ */
+const Loader = ({ loading, children, }) => {
+    return loading ? React.createElement(LoadingSpinner, null) : React.createElement(React.Fragment, null, children);
+};
+export default Loader;
 //# sourceMappingURL=Loader.js.map

package/dist_es/react/components/LoadingSpinner.d.ts

@@ -1,2 +1,2 @@
-import React from 'react';
-export declare const LoadingSpinner: React.FC;
+import React from 'react';
+export declare const LoadingSpinner: React.FC;

package/dist_es/react/components/LoadingSpinner.js

@@ -1,21 +1,21 @@
-/*
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
- */
-import { Spin } from '@j2inn/ui';
-import React from 'react';
-import { createUseStyles } from 'react-jss';
-const useStyles = createUseStyles({
-    container: {
-        display: 'flex',
-        alignItems: 'center',
-        justifyContent: 'center',
-        height: '100%',
-        width: '100%',
-    },
-});
-export const LoadingSpinner = () => {
-    const classes = useStyles();
-    return (React.createElement("div", { className: classes.container },
-        React.createElement(Spin, { size: 'large' })));
-};
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+import { Spin } from '@j2inn/ui';
+import React from 'react';
+import { createUseStyles } from 'react-jss';
+const useStyles = createUseStyles({
+    container: {
+        display: 'flex',
+        alignItems: 'center',
+        justifyContent: 'center',
+        height: '100%',
+        width: '100%',
+    },
+});
+export const LoadingSpinner = () => {
+    const classes = useStyles();
+    return (React.createElement("div", { className: classes.container },
+        React.createElement(Spin, { size: 'large' })));
+};
 //# sourceMappingURL=LoadingSpinner.js.map

package/dist_es/react/components/RecordImage.d.ts

@@ -1,20 +1,20 @@
-import { HRef } from 'haystack-core';
-import React from 'react';
-export interface RecordImageProps {
-    /**
-     * Ref of the image bin record.
-     */
-    imageRef?: HRef;
-    /**
-     * Fallback component to be displayed if the imageRef is not valid or the image is not found.
-     */
-    fallbackComponent?: React.ReactElement;
-    /**
-     * Props for img customization
-     */
-    imgProps?: Omit<React.DetailedHTMLProps<React.ImgHTMLAttributes<HTMLImageElement>, HTMLImageElement>, 'src'>;
-}
-/**
- * Displays an image from a bin record or a fallback if the given imageRef is not valid or if the image can't be found.
- */
-export declare const RecordImage: ({ imageRef, fallbackComponent, imgProps, }: RecordImageProps) => JSX.Element;
+import { HRef } from 'haystack-core';
+import React from 'react';
+export interface RecordImageProps {
+    /**
+     * Ref of the image bin record.
+     */
+    imageRef?: HRef;
+    /**
+     * Fallback component to be displayed if the imageRef is not valid or the image is not found.
+     */
+    fallbackComponent?: React.ReactElement;
+    /**
+     * Props for img customization
+     */
+    imgProps?: Omit<React.DetailedHTMLProps<React.ImgHTMLAttributes<HTMLImageElement>, HTMLImageElement>, 'src'>;
+}
+/**
+ * Displays an image from a bin record or a fallback if the given imageRef is not valid or if the image can't be found.
+ */
+export declare const RecordImage: ({ imageRef, fallbackComponent, imgProps, }: RecordImageProps) => JSX.Element;

package/dist_es/react/components/RecordImage.js

@@ -1,25 +1,25 @@
-/*
- * Copyright (c) 2023, J2 Innovations. All Rights Reserved
- */
-import React, { useState } from 'react';
-import { useFin5BinUrl } from '../hooks/useFin5BinUrl';
-/**
- * Displays an image from a bin record or a fallback if the given imageRef is not valid or if the image can't be found.
- */
-export const RecordImage = ({ imageRef, fallbackComponent, imgProps, }) => {
-    const imgUrl = useFin5BinUrl(imageRef);
-    // State used to identify whether there is an error in loading the image, to display the fallback component if necessary
-    const [hasImage, setHasImage] = useState(true);
-    const shouldDisplayFallback = !!fallbackComponent && (!hasImage || !imgUrl);
-    if (shouldDisplayFallback) {
-        return fallbackComponent;
-    }
-    else {
-        return (React.createElement("img", { ...imgProps, onError: (event) => {
-                // This will happen if the resource is not found for some reason
-                setHasImage(false);
-                imgProps?.onError?.(event);
-            }, src: imgUrl }));
-    }
-};
+/*
+ * Copyright (c) 2023, J2 Innovations. All Rights Reserved
+ */
+import React, { useState } from 'react';
+import { useFin5BinUrl } from '../hooks/useFin5BinUrl';
+/**
+ * Displays an image from a bin record or a fallback if the given imageRef is not valid or if the image can't be found.
+ */
+export const RecordImage = ({ imageRef, fallbackComponent, imgProps, }) => {
+    const imgUrl = useFin5BinUrl(imageRef);
+    // State used to identify whether there is an error in loading the image, to display the fallback component if necessary
+    const [hasImage, setHasImage] = useState(true);
+    const shouldDisplayFallback = !!fallbackComponent && (!hasImage || !imgUrl);
+    if (shouldDisplayFallback) {
+        return fallbackComponent;
+    }
+    else {
+        return (React.createElement("img", { ...imgProps, onError: (event) => {
+                // This will happen if the resource is not found for some reason
+                setHasImage(false);
+                imgProps?.onError?.(event);
+            }, src: imgUrl }));
+    }
+};
 //# sourceMappingURL=RecordImage.js.map

package/dist_es/react/components/charts/QRCode.d.ts

@@ -1,25 +1,25 @@
-import React from 'react';
-interface QRCodeProps {
-    /**
-     * The value the QR code holds (can be an URI or a plain string)
-     */
-    value: string;
-    /**
-     * True to show a link to copy QR code to clipboard, false otherwise.
-     * @default true
-     */
-    copyable?: boolean;
-    /**
-     * The text of the link to copy the QR code to clipboard.
-     * @default 'Copy QR code to clipboard'
-     */
-    copyText?: string;
-    /**
-     * The size of the QR code in pixels.
-     * @default 350
-     */
-    size?: number;
-    className?: string;
-}
-export declare const QRCode: React.FC<QRCodeProps>;
-export {};
+import React from 'react';
+interface QRCodeProps {
+    /**
+     * The value the QR code holds (can be an URI or a plain string)
+     */
+    value: string;
+    /**
+     * True to show a link to copy QR code to clipboard, false otherwise.
+     * @default true
+     */
+    copyable?: boolean;
+    /**
+     * The text of the link to copy the QR code to clipboard.
+     * @default 'Copy QR code to clipboard'
+     */
+    copyText?: string;
+    /**
+     * The size of the QR code in pixels.
+     * @default 350
+     */
+    size?: number;
+    className?: string;
+}
+export declare const QRCode: React.FC<QRCodeProps>;
+export {};