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

package/dist/react/app/Fin5AppRootStore.js

@@ -1,70 +1,70 @@
-"use strict";
-/*
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Fin5AppRootStore = void 0;
-const mobx_1 = require("mobx");
-/**
- * An application root store for use with FIN5.
- */
-class Fin5AppRootStore {
-    project = '';
-    sidebarOpen = false;
-    locale = '';
-    allLocales = [];
-    target = '';
-    targetSidebar = '';
-    currentUser;
-    get app() {
-        return undefined;
-    }
-    get sidebar() {
-        return undefined;
-    }
-    apps = [];
-    history = {
-        state: {},
-        pushState: (state) => {
-            this.history.state = state;
-        },
-        replaceState: (state) => {
-            this.history.state = state;
-        },
-    };
-    historySidebar = {
-        state: {},
-        pushState: (state) => {
-            this.historySidebar.state = state;
-        },
-        replaceState: (state) => {
-            this.historySidebar.state = state;
-        },
-    };
-    constructor() {
-        (0, mobx_1.makeAutoObservable)(this, {
-            currentUser: mobx_1.observable.ref,
-            apps: mobx_1.observable.ref,
-        });
-    }
-    openAppInNewWindow() { }
-    open() { }
-    openSidebar() { }
-    postAppMessage() { }
-    registerSidebars() { }
-    unregisterSidebars() { }
-    registerQuicklinks() { }
-    unregisterQuicklinks() { }
-    hasAppAccess = (_, access) => {
-        // For FIN5, an operator only has readonly app level access.
-        const user = this.currentUser;
-        return user?.get('userRole')?.value === 'op'
-            ? access === 'read'
-            : !!user;
-    };
-    hasSidebar() {
-        return false;
-    }
-}
-exports.Fin5AppRootStore = Fin5AppRootStore;
+"use strict";
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Fin5AppRootStore = void 0;
+const mobx_1 = require("mobx");
+/**
+ * An application root store for use with FIN5.
+ */
+class Fin5AppRootStore {
+    project = '';
+    sidebarOpen = false;
+    locale = '';
+    allLocales = [];
+    target = '';
+    targetSidebar = '';
+    currentUser;
+    get app() {
+        return undefined;
+    }
+    get sidebar() {
+        return undefined;
+    }
+    apps = [];
+    history = {
+        state: {},
+        pushState: (state) => {
+            this.history.state = state;
+        },
+        replaceState: (state) => {
+            this.history.state = state;
+        },
+    };
+    historySidebar = {
+        state: {},
+        pushState: (state) => {
+            this.historySidebar.state = state;
+        },
+        replaceState: (state) => {
+            this.historySidebar.state = state;
+        },
+    };
+    constructor() {
+        (0, mobx_1.makeAutoObservable)(this, {
+            currentUser: mobx_1.observable.ref,
+            apps: mobx_1.observable.ref,
+        });
+    }
+    openAppInNewWindow() { }
+    open() { }
+    openSidebar() { }
+    postAppMessage() { }
+    registerSidebars() { }
+    unregisterSidebars() { }
+    registerQuicklinks() { }
+    unregisterQuicklinks() { }
+    hasAppAccess = (_, access) => {
+        // For FIN5, an operator only has readonly app level access.
+        const user = this.currentUser;
+        return user?.get('userRole')?.value === 'op'
+            ? access === 'read'
+            : !!user;
+    };
+    hasSidebar() {
+        return false;
+    }
+}
+exports.Fin5AppRootStore = Fin5AppRootStore;
 //# sourceMappingURL=Fin5AppRootStore.js.map

package/dist/react/components/ErrorBoundary.d.ts

@@ -1,57 +1,57 @@
-import React, { ErrorInfo, ReactNode } from 'react';
-/**
- * An error boundary can work at the global level (where something really screws up)
- * or an an app level (where the error is captured just for the running application).
- */
-export declare const enum ErrorBoundaryMode {
-    global = "global",
-    app = "app"
-}
-/**
- * The properties for an error boundary.
- */
-interface ErrorBoundaryProps {
-    /**
-     * The associated application id.
-     */
-    appId?: string;
-    /**
-     * The error mode.
-     */
-    mode: ErrorBoundaryMode;
-    /**
-     * Optional callback to display a report dialog.
-     */
-    showReportDialog?: () => void;
-    /**
-     * Optional callback used to capture the error.
-     */
-    onError?: (error: Error) => void;
-    /**
-     * Child components.
-     */
-    children?: React.ReactNode;
-}
-/**
- * The state for an error boundary.
- */
-interface ErrorBoundryState {
-    /**
-     * The last captured error.
-     */
-    error?: Error;
-}
-/**
- * A common error boundary used to capture errors.
- */
-export declare class ErrorBoundary extends React.Component<ErrorBoundaryProps, ErrorBoundryState> {
-    state: {
-        error?: Error;
-    };
-    componentDidCatch(error: Error, info: ErrorInfo): void;
-    static getDerivedStateFromError(error: Error): {
-        error: Error;
-    };
-    render(): ReactNode | JSX.Element;
-}
-export {};
+import React, { ErrorInfo, ReactNode } from 'react';
+/**
+ * An error boundary can work at the global level (where something really screws up)
+ * or an an app level (where the error is captured just for the running application).
+ */
+export declare const enum ErrorBoundaryMode {
+    global = "global",
+    app = "app"
+}
+/**
+ * The properties for an error boundary.
+ */
+interface ErrorBoundaryProps {
+    /**
+     * The associated application id.
+     */
+    appId?: string;
+    /**
+     * The error mode.
+     */
+    mode: ErrorBoundaryMode;
+    /**
+     * Optional callback to display a report dialog.
+     */
+    showReportDialog?: () => void;
+    /**
+     * Optional callback used to capture the error.
+     */
+    onError?: (error: Error) => void;
+    /**
+     * Child components.
+     */
+    children?: React.ReactNode;
+}
+/**
+ * The state for an error boundary.
+ */
+interface ErrorBoundryState {
+    /**
+     * The last captured error.
+     */
+    error?: Error;
+}
+/**
+ * A common error boundary used to capture errors.
+ */
+export declare class ErrorBoundary extends React.Component<ErrorBoundaryProps, ErrorBoundryState> {
+    state: {
+        error?: Error;
+    };
+    componentDidCatch(error: Error, info: ErrorInfo): void;
+    static getDerivedStateFromError(error: Error): {
+        error: Error;
+    };
+    render(): ReactNode | JSX.Element;
+}
+export {};

package/dist/react/components/ErrorBoundary.js

@@ -1,151 +1,151 @@
-"use strict";
-/*
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ErrorBoundary = void 0;
-const react_1 = __importStar(require("react"));
-const ui_1 = require("@j2inn/ui");
-const utils_1 = require("@j2inn/utils");
-const react_jss_1 = require("react-jss");
-const boundryStyles = (0, react_jss_1.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: ui_1.ColorVals.Black,
-            color: ui_1.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 = (0, utils_1.usei18n)();
-    const classes = boundryStyles();
-    const theme = (0, react_jss_1.useTheme)();
-    const copyToClipboard = () => {
-        navigator.clipboard.writeText(formatErrorMessage(error, appId));
-        ui_1.Message.success(theme, get(i18n, 'finUi.errorBoundary.copiedErrorToClipboard', 'Copied error to clipboard'));
-    };
-    return (react_1.default.createElement("div", { className: classes.errorDetails },
-        react_1.default.createElement(ui_1.Checkbox, { onChange: (e) => {
-                setShowDetails(e.target.checked);
-            }, defaultChecked: showDetails, value: showDetails }, get(i18n, 'finUi.errorBoundary.showDetails', 'Show details')),
-        showDetails && (react_1.default.createElement(react_1.default.Fragment, null,
-            react_1.default.createElement("pre", null, error.stack),
-            react_1.default.createElement(ui_1.Container, { horizontal: true, middle: true, right: true },
-                react_1.default.createElement(ui_1.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 = (0, utils_1.usei18n)();
-    const [showDetails, setShowDetails] = (0, react_1.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_1.default.createElement(ui_1.Container, { vertical: true, top: true, center: true, className: classes.errorBoundry },
-        react_1.default.createElement("div", { className: classes.boundryContainer, style: { gap: `1rem` } },
-            react_1.default.createElement("h1", null, header),
-            react_1.default.createElement("h3", null, get(i18n, 'finUi.errorBoundary.description', 'The application has encountered an error when trying to display some content.')),
-            react_1.default.createElement("p", null, continueMsg),
-            react_1.default.createElement("div", null,
-                react_1.default.createElement(ErrorDetails, { showDetails: showDetails, setShowDetails: setShowDetails, error: error, appId: appId })),
-            react_1.default.createElement(ui_1.Divider, null),
-            react_1.default.createElement(ui_1.Container, { horizontal: true, middle: true, left: true, style: { gap: `1rem` } },
-                react_1.default.createElement(ui_1.Button, { onClick: () => window.location.reload(), type: 'primary' }, get(i18n, 'finUi.common.reload', 'Reload')),
-                react_1.default.createElement(ui_1.Button, { onClick: () => window.location.assign('/') }, get(i18n, 'finUi.common.home', 'Home'))),
-            showReportDialog && (react_1.default.createElement("div", { style: { marginTop: `0.5rem` } },
-                react_1.default.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.
- */
-class ErrorBoundary extends react_1.default.Component {
-    state = {};
-    componentDidCatch(error, info) {
-        this.props.onError?.(error);
-        console.error(error, info);
-    }
-    static getDerivedStateFromError(error) {
-        return { error };
-    }
-    render() {
-        return this.state.error ? (react_1.default.createElement(ErrorBoundaryInner, { error: this.state.error, mode: this.props.mode, appId: this.props.appId, showReportDialog: this.props.showReportDialog })) : (this.props.children);
-    }
-}
-exports.ErrorBoundary = ErrorBoundary;
+"use strict";
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ErrorBoundary = void 0;
+const react_1 = __importStar(require("react"));
+const ui_1 = require("@j2inn/ui");
+const utils_1 = require("@j2inn/utils");
+const react_jss_1 = require("react-jss");
+const boundryStyles = (0, react_jss_1.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: ui_1.ColorVals.Black,
+            color: ui_1.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 = (0, utils_1.usei18n)();
+    const classes = boundryStyles();
+    const theme = (0, react_jss_1.useTheme)();
+    const copyToClipboard = () => {
+        navigator.clipboard.writeText(formatErrorMessage(error, appId));
+        ui_1.Message.success(theme, get(i18n, 'finUi.errorBoundary.copiedErrorToClipboard', 'Copied error to clipboard'));
+    };
+    return (react_1.default.createElement("div", { className: classes.errorDetails },
+        react_1.default.createElement(ui_1.Checkbox, { onChange: (e) => {
+                setShowDetails(e.target.checked);
+            }, defaultChecked: showDetails, value: showDetails }, get(i18n, 'finUi.errorBoundary.showDetails', 'Show details')),
+        showDetails && (react_1.default.createElement(react_1.default.Fragment, null,
+            react_1.default.createElement("pre", null, error.stack),
+            react_1.default.createElement(ui_1.Container, { horizontal: true, middle: true, right: true },
+                react_1.default.createElement(ui_1.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 = (0, utils_1.usei18n)();
+    const [showDetails, setShowDetails] = (0, react_1.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_1.default.createElement(ui_1.Container, { vertical: true, top: true, center: true, className: classes.errorBoundry },
+        react_1.default.createElement("div", { className: classes.boundryContainer, style: { gap: `1rem` } },
+            react_1.default.createElement("h1", null, header),
+            react_1.default.createElement("h3", null, get(i18n, 'finUi.errorBoundary.description', 'The application has encountered an error when trying to display some content.')),
+            react_1.default.createElement("p", null, continueMsg),
+            react_1.default.createElement("div", null,
+                react_1.default.createElement(ErrorDetails, { showDetails: showDetails, setShowDetails: setShowDetails, error: error, appId: appId })),
+            react_1.default.createElement(ui_1.Divider, null),
+            react_1.default.createElement(ui_1.Container, { horizontal: true, middle: true, left: true, style: { gap: `1rem` } },
+                react_1.default.createElement(ui_1.Button, { onClick: () => window.location.reload(), type: 'primary' }, get(i18n, 'finUi.common.reload', 'Reload')),
+                react_1.default.createElement(ui_1.Button, { onClick: () => window.location.assign('/') }, get(i18n, 'finUi.common.home', 'Home'))),
+            showReportDialog && (react_1.default.createElement("div", { style: { marginTop: `0.5rem` } },
+                react_1.default.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.
+ */
+class ErrorBoundary extends react_1.default.Component {
+    state = {};
+    componentDidCatch(error, info) {
+        this.props.onError?.(error);
+        console.error(error, info);
+    }
+    static getDerivedStateFromError(error) {
+        return { error };
+    }
+    render() {
+        return this.state.error ? (react_1.default.createElement(ErrorBoundaryInner, { error: this.state.error, mode: this.props.mode, appId: this.props.appId, showReportDialog: this.props.showReportDialog })) : (this.props.children);
+    }
+}
+exports.ErrorBoundary = ErrorBoundary;
 //# sourceMappingURL=ErrorBoundary.js.map

package/dist/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 {};