dry-ux 1.70.0 → 1.72.0

package/dist/dajaxice/DajaxiceCall.js

@@ -98,7 +98,7 @@ class DajaxiceCall {
                 this.callApi();
             }
             else {
-                (0, utilities_1.fnWithAuthCheck)(this.callApi, authCheck.url, authCheck.redirectUrl).catch(this.handleError);
+                (0, utilities_1.fnWithAuthCheck)(this.callApi, authCheck.url, authCheck.redirectUrl).catch(authCheck.onError || this.handleError);
             }
         }
         else {

package/dist/dajaxice/Proxy.interface.d.ts

@@ -70,6 +70,10 @@ export interface IDajaxiceProxy<TModule> {
          * The URL to redirect to if not authenticated.
          */
         redirectUrl: string;
+        /**
+         * The method to call if the authentication check fails.
+         */
+        onError?: (error: any) => void;
     };
     /**
      * The error handler function.

package/dist/enhanced-inputs/interface.d.ts

@@ -1,5 +1,11 @@
 import { InputHTMLAttributes } from "react";
+/**
+ * Type alias for validation, which can be a boolean or a string.
+ */
 export type IValidation = boolean | string;
+/**
+ * Interface representing a value validation with an optional message.
+ */
 export interface IValueValidation<T> {
     /**
      * The value to be validated.
@@ -10,6 +16,9 @@ export interface IValueValidation<T> {
      */
     message?: string;
 }
+/**
+ * Interface representing various validation rules for a field.
+ */
 export interface IValidations {
     /**
      * Indicates if the field is required.
@@ -80,6 +89,9 @@ export interface IValidations {
      */
     errorRef?: string;
 }
+/**
+ * Interface representing enhanced properties for an input field.
+ */
 export interface IEnhancedProps {
     /**
      * Validation rules for the field.
@@ -106,4 +118,7 @@ export interface IEnhancedProps {
      */
     validateOnChange?: boolean;
 }
+/**
+ * Type alias for input attributes, extending HTML input, select, and textarea attributes.
+ */
 export type InputAttributes = InputHTMLAttributes<HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement>;

package/dist/error/ErrorBoundary.stories.d.ts

@@ -0,0 +1,5 @@
+import { Meta } from "@storybook/react";
+declare const _default: Meta;
+export default _default;
+export declare const Default: any;
+export declare const WithError: any;

package/dist/error/ErrorBoundary.stories.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WithError = exports.Default = void 0;
+const React = require("react");
+const ErrorBoundary_1 = require("./ErrorBoundary");
+exports.default = {
+    title: "ErrorBoundary",
+    component: ErrorBoundary_1.ErrorBoundary,
+};
+const Template = args => (React.createElement(ErrorBoundary_1.ErrorBoundary, Object.assign({}, args),
+    React.createElement("div", null, "Child component content")));
+exports.Default = Template.bind({});
+exports.Default.args = {};
+exports.WithError = Template.bind({});
+exports.WithError.args = {
+    fallback: (error, resetError) => (React.createElement("div", null,
+        React.createElement("h1", null, "Custom Fallback UI"),
+        React.createElement("p", null, error.message),
+        React.createElement("button", { onClick: resetError }, "Try Again"))),
+    children: (() => {
+        throw new Error("Test error");
+    })(),
+};

package/dist/error/ErrorScreen.stories.d.ts

@@ -0,0 +1,4 @@
+import { Meta } from "@storybook/react";
+declare const _default: Meta;
+export default _default;
+export declare const Default: any;

package/dist/error/ErrorScreen.stories.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Default = void 0;
+const React = require("react");
+const ErrorScreen_1 = require("./ErrorScreen");
+exports.default = {
+    title: "ErrorScreen",
+    component: ErrorScreen_1.ErrorScreen,
+};
+const Template = args => React.createElement(ErrorScreen_1.ErrorScreen, Object.assign({}, args));
+exports.Default = Template.bind({});
+exports.Default.args = {};

package/dist/helpers/logger.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Interface representing a logger with various logging methods.
+ */
 export interface ILogger {
     /**
      * Logs a message with the info level.
@@ -20,6 +23,18 @@ export interface ILogger {
      */
     warn(...message: any[]): void;
 }
+/**
+ * Initializes a logger factory with the specified path.
+ *
+ * @param {string} path - The endpoint to which log messages will be sent.
+ * @returns {Object} An object containing a useLogger method to create logger instances.
+ */
 export declare const initLoggerFactory: (path: string) => {
+    /**
+     * Creates a logger instance with the specified name.
+     *
+     * @param {string} name - The name of the logger.
+     * @returns {ILogger} The logger instance with methods to log messages at different levels.
+     */
     useLogger: (name: string) => ILogger;
 };

package/dist/helpers/logger.js

@@ -1,6 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.initLoggerFactory = void 0;
+/**
+ * Creates a logger instance with the specified path and name.
+ *
+ * @param {string} path - The endpoint to which log messages will be sent.
+ * @param {string} name - The name of the logger.
+ * @returns {ILogger} The logger instance with methods to log messages at different levels.
+ */
 const useLogger = (path, name) => {
     const convertMessage = (message) => message
         .map(m => {
@@ -35,7 +42,19 @@ const useLogger = (path, name) => {
         warn: (...message) => log("warn", message),
     };
 };
+/**
+ * Initializes a logger factory with the specified path.
+ *
+ * @param {string} path - The endpoint to which log messages will be sent.
+ * @returns {Object} An object containing a useLogger method to create logger instances.
+ */
 const initLoggerFactory = (path) => ({
+    /**
+     * Creates a logger instance with the specified name.
+     *
+     * @param {string} name - The name of the logger.
+     * @returns {ILogger} The logger instance with methods to log messages at different levels.
+     */
     useLogger: (name) => useLogger(path, name),
 });
 exports.initLoggerFactory = initLoggerFactory;

package/dist/provider.d.ts

@@ -1,9 +1,12 @@
 import * as React from "react";
 import { UIUtilRendererProps } from "./ui-utils/UIUtilRenderer";
+/**
+ * Props for the DryUXProvider component.
+ */
 interface IDryUXProviderProps {
     /**
      * Does not render the renderer for this provider. If this is set to true, then the renderer needs to be mounted
-     * by explicitly.
+     * explicitly.
      */
     noRenderer?: boolean;
     /**
@@ -14,7 +17,16 @@ interface IDryUXProviderProps {
      * If true, the viewport detection will be enabled.
      */
     viewportDetect?: boolean;
+    /**
+     * The children elements to be rendered within the provider.
+     */
     children: React.ReactNode;
 }
+/**
+ * DryUXProvider component that provides UI utilities and optionally renders a UIUtilRenderer.
+ *
+ * @param {IDryUXProviderProps} props - The props for the DryUXProvider component.
+ * @returns {JSX.Element} The DryUXProvider component.
+ */
 export declare const DryUXProvider: React.FC<IDryUXProviderProps>;
 export {};

package/dist/provider.js

@@ -4,6 +4,12 @@ exports.DryUXProvider = void 0;
 const React = require("react");
 const UIUtilProvider_1 = require("./ui-utils/UIUtilProvider");
 const UIUtilRenderer_1 = require("./ui-utils/UIUtilRenderer");
+/**
+ * DryUXProvider component that provides UI utilities and optionally renders a UIUtilRenderer.
+ *
+ * @param {IDryUXProviderProps} props - The props for the DryUXProvider component.
+ * @returns {JSX.Element} The DryUXProvider component.
+ */
 exports.DryUXProvider = React.memo(({ children, noRenderer = false, rendererProps, viewportDetect }) => (React.createElement(UIUtilProvider_1.UIUtilProvider, { viewportDetect: viewportDetect },
     children,
     !noRenderer && React.createElement(UIUtilRenderer_1.UIUtilRenderer, Object.assign({}, rendererProps)))));