@dartech/arsenal-ui 1.3.0 → 1.3.1

package/src/lib/Forms/ControlAceEditor.d.ts

@@ -0,0 +1,24 @@
+/// <reference types="react" />
+import AceEditor from 'react-ace';
+import 'ace-builds/src-noconflict/mode-python';
+import 'ace-builds/src-noconflict/theme-monokai';
+import 'ace-builds/src-noconflict/ext-language_tools';
+import { Control } from 'react-hook-form';
+export interface ControlAceEditorProps {
+    name: string;
+    control: Control<any>;
+    mode?: string;
+    label?: string;
+    width?: string;
+    height?: string;
+    theme?: string;
+    readOnly?: boolean;
+    required?: boolean;
+    validateJson?: boolean;
+    fontSize?: number;
+    validate?: boolean;
+    parseValue?: boolean;
+    [key: string]: unknown;
+}
+export declare const ControlAceEditor: import("react").ForwardRefExoticComponent<Omit<ControlAceEditorProps, "ref"> & import("react").RefAttributes<AceEditor>>;
+export default ControlAceEditor;

package/src/lib/Forms/ControlAutocomplete.d.ts

@@ -0,0 +1,69 @@
+/// <reference types="react" />
+import { AutocompleteProps } from '@mui/material/Autocomplete';
+import { TextFieldProps } from '@mui/material/TextField';
+import { Control } from 'react-hook-form';
+import { ValidateFunc } from '../../interfaces';
+/**
+ * This interface is referencing the [[ControlAutocomplete]] component props.
+ * @category Forms
+ */
+export type ControlAutocompleteProps = Omit<AutocompleteProps<unknown, boolean, boolean, boolean, React.ElementType<any>>, 'renderInput'> & {
+    /**
+     * React Hook Form control `name` propery
+     */
+    name: string;
+    /**
+     * Label for MUI TextField select component
+     */
+    label?: string;
+    /**
+     * React Hook Form `control`
+     */
+    control: Control<any>;
+    /**
+     * Is input required flag
+     */
+    required?: boolean;
+    /**
+     * React Hook Form `defaultValue`
+     */
+    defaultValue?: unknown;
+    /**
+     * Is disabled input flag
+     */
+    disabled?: boolean;
+    /**
+     * React Hook Form validate function
+     * ```typescript
+     * type ValidateFunc = (value: string) => boolean | string;
+     * ```
+     */
+    validate?: ValidateFunc | Record<string, ValidateFunc>;
+    /**
+     * Hide error message flag
+     */
+    hideErrorMessage?: boolean;
+    /**
+     * Custom onChange functionƒ
+     */
+    onChange?: (event: React.ChangeEvent<HTMLInputElement>, value: unknown) => void;
+    /**
+     * Key for option label
+     */
+    labelKey?: string;
+    /**
+     * Key for option value
+     */
+    valueKey?: string;
+    /**
+     * Select options
+     */
+    options: string[] | unknown[];
+    textFieldProps?: TextFieldProps;
+};
+/**
+ * Material UI `Autocomplete` controlled component. Used with react-hook-form
+ * @category Forms
+ */
+export declare const ControlAutocomplete: ({ control, validate, name, label, required, defaultValue, disabled, hideErrorMessage, onChange: customOnChange, labelKey, valueKey, options, multiple, textFieldProps, disableCloseOnSelect, ...autocompleteProps }: ControlAutocompleteProps) => JSX.Element;
+export default ControlAutocomplete;

package/src/lib/Forms/ControlCheckbox.d.ts

@@ -0,0 +1,51 @@
+/// <reference types="react" />
+import { CheckboxProps } from '@mui/material/Checkbox';
+import { Control } from 'react-hook-form';
+import { ValidateFunc } from '../../interfaces';
+/**
+ * This interface is referencing the [[ControlCheckbox]] component props.
+ * @category Forms
+ */
+export type ControlCheckboxProps = CheckboxProps & {
+    /**
+     * React Hook Form control `name` propery
+     */
+    name: string;
+    /**
+     * Label for MUI TextField component
+     */
+    label?: string;
+    /**
+     * React Hook Form `control`
+     */
+    control: Control<any>;
+    /**
+     * React Hook Form `defaultValue`
+     */
+    defaultValue?: unknown;
+    /**
+     * Is disabled input flag
+     */
+    disabled?: boolean;
+    /**
+     * React Hook Form validate function
+     * ```typescript
+     * type ValidateFunc = (value: string) => boolean | string;
+     * ```
+     */
+    validate?: ValidateFunc | Record<string, ValidateFunc>;
+    /**
+     * Hide error message flag
+     */
+    hideErrorMessage?: boolean;
+    /**
+     * Custom onChange functionƒ
+     */
+    onChange?: (event: React.ChangeEvent<HTMLInputElement>) => void;
+};
+/**
+ * Material UI `Checkbox` controlled component. Used with react-hook-form
+ * @category Forms
+ */
+export declare const ControlCheckbox: ({ control, validate, name, label, required, defaultValue, disabled, hideErrorMessage, onChange: customOnChange, ...checkboxProps }: ControlCheckboxProps) => JSX.Element;
+export default ControlCheckbox;

package/src/lib/Forms/ControlDate.d.ts

@@ -0,0 +1,18 @@
+/// <reference types="react" />
+import { Control } from 'react-hook-form';
+type Props = {
+    /**
+     * React Hook Form `control`
+     */
+    control: Control<any>;
+    /**
+     * Is input required flag
+     */
+    required?: boolean;
+    name: string;
+    label?: string;
+    format?: string;
+    hideErrorMessage?: boolean;
+};
+export declare const ControlDate: ({ control, name, required, label, format, hideErrorMessage, }: Props) => JSX.Element;
+export default ControlDate;

package/src/lib/Forms/ControlDateTime.d.ts

@@ -0,0 +1,18 @@
+/// <reference types="react" />
+import { Control } from 'react-hook-form';
+type Props = {
+    /**
+     * React Hook Form `control`
+     */
+    control: Control<any>;
+    /**
+     * Is input required flag
+     */
+    required?: boolean;
+    name: string;
+    label?: string;
+    format?: string;
+    hideErrorMessage?: boolean;
+};
+export declare const ControlDateTime: ({ control, name, required, label, format, hideErrorMessage, }: Props) => JSX.Element;
+export default ControlDateTime;

package/src/lib/Forms/ControlDebouncedInput.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+import { ControlInputProps } from './ControlInput';
+export declare const ControlDebouncedInput: ({ control, validate, name, label, required, defaultValue, disabled, textarea, hideErrorMessage, onChange: customOnChange, ...textFieldProps }: ControlInputProps) => JSX.Element;
+export default ControlDebouncedInput;

package/src/lib/Forms/ControlInput.d.ts

@@ -0,0 +1,59 @@
+/// <reference types="react" />
+import { Control } from 'react-hook-form';
+import { TextFieldProps } from '@mui/material/TextField';
+import { ValidateFunc } from '../../interfaces';
+/**
+ * This interface is referencing the [[ControlInput]] component props.
+ * @category Forms
+ */
+export type ControlInputProps = TextFieldProps & {
+    /**
+     * React Hook Form control `name` propery
+     */
+    name: string;
+    /**
+     * Label for MUI TextField component
+     */
+    label?: string;
+    /**
+     * React Hook Form `control`
+     */
+    control: Control<any>;
+    /**
+     * Is input required flag
+     */
+    required?: boolean;
+    /**
+     * React Hook Form `defaultValue`
+     */
+    defaultValue?: unknown;
+    /**
+     * Is disabled input flag
+     */
+    disabled?: boolean;
+    /**
+     * React Hook Form validate function
+     * ```typescript
+     * type ValidateFunc = (value: string) => boolean | string;
+     * ```
+     */
+    validate?: ValidateFunc | Record<string, ValidateFunc>;
+    /**
+     * Is input textarea flag
+     */
+    textarea?: boolean;
+    /**
+     * Hide error message flag
+     */
+    hideErrorMessage?: boolean;
+    /**
+     * Custom onChange functionƒ
+     */
+    onChange?: (event: React.ChangeEvent<HTMLInputElement>) => void;
+};
+/**
+ * Material UI `TextField` controlled component. Used with react-hook-form
+ * @category Forms
+ */
+export declare const ControlInput: ({ control, validate, name, label, required, defaultValue, disabled, textarea, hideErrorMessage, onChange: customOnChange, ...textFieldProps }: ControlInputProps) => JSX.Element;
+export default ControlInput;

package/src/lib/Forms/ControlNumberInput.d.ts

@@ -0,0 +1,51 @@
+/// <reference types="react" />
+import { TextFieldProps } from '@mui/material/TextField';
+import { Control } from 'react-hook-form';
+import { ValidateFunc } from '../../interfaces';
+type Props = TextFieldProps & {
+    /**
+     * React Hook Form control `name` propery
+     */
+    name: string;
+    /**
+     * Label for MUI TextField component
+     */
+    label?: string;
+    /**
+     * React Hook Form `control`
+     */
+    control: Control;
+    /**
+     * Is input required flag
+     */
+    required?: boolean;
+    /**
+     * React Hook Form `defaultValue`
+     */
+    defaultValue?: number;
+    /**
+     * Is disabled input flag
+     */
+    disabled?: boolean;
+    /**
+     * React Hook Form validate function
+     * ```typescript
+     * type ValidateFunc = (value: string) => boolean | string;
+     * ```
+     */
+    validate?: ValidateFunc | Record<string, ValidateFunc>;
+    /**
+     * Hide error message flag
+     */
+    hideErrorMessage?: boolean;
+    /**
+     * Custom onChange function
+     */
+    onChange?: (event: React.ChangeEvent<HTMLInputElement>) => void;
+    /**
+     * Is number decimal or integer flag
+     */
+    decimal?: boolean;
+};
+export declare const ControlNumberInput: ({ control, validate, name, label, required, defaultValue, disabled, hideErrorMessage, onChange: customOnChange, decimal, ...textFieldProps }: Props) => JSX.Element;
+export default ControlNumberInput;

package/src/lib/Forms/ControlQueryAutocomplete.d.ts

@@ -0,0 +1,16 @@
+/// <reference types="react" />
+import { ControlAutocompleteProps } from './ControlAutocomplete';
+import { PaginateData } from '../../interfaces';
+type PaginateParams = {
+    page: string;
+    size: string;
+    [key: string]: string;
+};
+type ControlQueryAutocompleteProps<T> = Omit<ControlAutocompleteProps, 'options'> & {
+    searchBy: string;
+    sortBy?: string;
+    queryFunction: (params: PaginateParams) => Promise<PaginateData<T>>;
+    itemQueryFunction?: (valueKey: string) => Promise<T>;
+};
+export declare function ControlQueryAutocomplete<T>({ name, label, control, required, searchBy, labelKey, multiple, disabled, valueKey, sortBy, hideErrorMessage, disableCloseOnSelect, textFieldProps, onChange, queryFunction, validate, itemQueryFunction, ...autocompleteProps }: ControlQueryAutocompleteProps<T>): JSX.Element;
+export default ControlQueryAutocomplete;

package/src/lib/Forms/ControlRadio.d.ts

@@ -0,0 +1,66 @@
+/// <reference types="react" />
+import { Control } from 'react-hook-form';
+import { ValidateFunc } from '../../interfaces';
+/**
+ * This interface is referencing the [[ControlRadioBtn]] component props.
+ * @category Forms
+ */
+export interface ControlRadioProps {
+    /**
+     * React Hook Form `control`
+     */
+    control: Control<any>;
+    /**
+     * React Hook Form control `name` propery
+     */
+    name: string;
+    /**
+     * Label for component
+     */
+    label?: string;
+    /**
+     * Radio group values
+     */
+    values: string[] | unknown[];
+    /**
+     * Is input required flag
+     */
+    required?: boolean;
+    /**
+     * React Hook Form `defaultValue`
+     */
+    defaultValue?: unknown;
+    /**
+     * Is disabled input flag
+     */
+    disabled?: boolean;
+    /**
+     * Hide error message flag
+     */
+    hideErrorMessage?: boolean;
+    /**
+     * Custom onChange functionƒ
+     */
+    onChange?: (event: React.ChangeEvent<HTMLInputElement>) => void;
+    /**
+     * React Hook Form validate function
+     * ```typescript
+     * type ValidateFunc = (value: string) => boolean | string;
+     * ```
+     */
+    validate?: ValidateFunc | Record<string, ValidateFunc>;
+    /**
+     * Key for option label
+     */
+    labelKey?: string;
+    /**
+     * Key for option value
+     */
+    valueKey?: string;
+}
+/**
+ * Material UI `Radio` controlled component. Used with react-hook-form
+ * @category Forms
+ */
+export declare const ControlRadio: ({ name, label, values, control, required, defaultValue, disabled, hideErrorMessage, labelKey, valueKey, validate, onChange: customOnChange, }: ControlRadioProps) => JSX.Element;
+export default ControlRadio;

package/src/lib/Forms/ControlSelect.d.ts

@@ -0,0 +1,67 @@
+/// <reference types="react" />
+import { TextFieldProps } from '@mui/material/TextField';
+import { Control } from 'react-hook-form';
+import { ValidateFunc } from '../../interfaces';
+/**
+ * This interface is referencing the [[ControlSelect]] component props.
+ * @category Forms
+ */
+export type ControlSelectProps = TextFieldProps & {
+    /**
+     * React Hook Form control `name` propery
+     */
+    name: string;
+    /**
+     * Label for MUI TextField select component
+     */
+    label?: string;
+    /**
+     * React Hook Form `control`
+     */
+    control: Control<any>;
+    /**
+     * Is input required flag
+     */
+    required?: boolean;
+    /**
+     * React Hook Form `defaultValue`
+     */
+    defaultValue?: unknown;
+    /**
+     * Is disabled input flag
+     */
+    disabled?: boolean;
+    /**
+     * React Hook Form validate function
+     * ```typescript
+     * type ValidateFunc = (value: string) => boolean | string;
+     * ```
+     */
+    validate?: ValidateFunc | Record<string, ValidateFunc>;
+    /**
+     * Hide error message flag
+     */
+    hideErrorMessage?: boolean;
+    /**
+     * Custom onChange functionƒ
+     */
+    onChange?: (event: React.ChangeEvent<HTMLInputElement>) => void;
+    /**
+     * Key for option label
+     */
+    labelKey?: string;
+    /**
+     * Key for option value
+     */
+    valueKey?: string;
+    /**
+     * Select options
+     */
+    options: string[] | unknown[];
+};
+/**
+ * Material UI `Select` controlled component. Used with react-hook-form
+ * @category Forms
+ */
+export declare const ControlSelect: ({ control, validate, name, label, required, defaultValue, disabled, hideErrorMessage, onChange: customOnChange, labelKey, valueKey, options, ...textFieldProps }: ControlSelectProps) => JSX.Element;
+export default ControlSelect;

package/src/lib/Forms/ControlSwitch.d.ts

@@ -0,0 +1,19 @@
+/// <reference types="react" />
+import { SwitchProps } from '@mui/material/Switch';
+import { Control } from 'react-hook-form';
+type Props = SwitchProps & {
+    /**
+     * React Hook Form `control`
+     */
+    control: Control<any>;
+    /**
+     * React Hook Form control `name` propery
+     */
+    name: string;
+    /**
+     * Material-UI FormControlLabel `label` prop
+     */
+    label?: string;
+};
+export declare const ControlSwitch: ({ control, name, label, ...switchProps }: Props) => JSX.Element;
+export default ControlSwitch;

package/src/lib/Forms/ControlTime.d.ts

@@ -0,0 +1,18 @@
+/// <reference types="react" />
+import { Control } from 'react-hook-form';
+type Props = {
+    /**
+     * React Hook Form `control`
+     */
+    control: Control<any>;
+    /**
+     * Is input required flag
+     */
+    required?: boolean;
+    name: string;
+    label?: string;
+    format?: string;
+    hideErrorMessage?: boolean;
+};
+export declare const ControlTime: ({ control, name, required, label, format, hideErrorMessage, }: Props) => JSX.Element;
+export default ControlTime;

package/src/lib/Forms/CopyButton.d.ts

@@ -0,0 +1,20 @@
+/// <reference types="react" />
+/**
+ * This interface is referencing the [[CopyButton]] component props.
+ * @category Forms
+ */
+export interface CopyButtonProps {
+    /**
+     * Text to copy
+     */
+    copyText: string;
+    /**
+     * Tooltip help text
+     */
+    helpText?: string;
+}
+/**
+ * Copy value button
+ * @category Forms
+ */
+export declare const CopyButton: ({ copyText, helpText }: CopyButtonProps) => JSX.Element;

package/src/lib/Forms/{index.ts → index.d.ts}

@@ -1,15 +1,15 @@
-export * from './ControlInput';
-export * from './ControlDebouncedInput';
-export * from './ControlSelect';
-export * from './ControlCheckbox';
-export * from './ControlRadio';
-export * from './ControlAutocomplete';
-export * from './ControlQueryAutocomplete';
-export * from './CopyButton';
-export * from './BackButton';
-export * from './ControlAceEditor';
-export * from './ControlNumberInput';
-export * from './ControlSwitch';
-export * from './ControlDate';
-export * from './ControlDateTime';
-export * from './ControlTime';
+export * from './ControlInput';
+export * from './ControlDebouncedInput';
+export * from './ControlSelect';
+export * from './ControlCheckbox';
+export * from './ControlRadio';
+export * from './ControlAutocomplete';
+export * from './ControlQueryAutocomplete';
+export * from './CopyButton';
+export * from './BackButton';
+export * from './ControlAceEditor';
+export * from './ControlNumberInput';
+export * from './ControlSwitch';
+export * from './ControlDate';
+export * from './ControlDateTime';
+export * from './ControlTime';

package/src/lib/Forms/useAutocomplete.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+declare const useAutocomplete: ({ valueKey, labelKey }: {
+    valueKey: any;
+    labelKey: any;
+}) => {
+    isOptionEqualToValue: (option: any, value: any) => boolean;
+    getOptionLabel: (option: any) => string;
+    renderOption: (props: any, option: any) => JSX.Element;
+};
+export default useAutocomplete;

package/src/lib/InfoItem/InfoItem.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+import 'ace-builds/src-noconflict/ace';
+import 'ace-builds/src-noconflict/mode-json';
+type Props = {
+    title: string;
+    text?: string;
+    json?: any;
+};
+export declare const InfoItem: ({ title, text, json }: Props) => JSX.Element;
+export default InfoItem;

package/src/lib/InfoItem/{index.ts → index.d.ts}

@@ -1 +1 @@
-export * from './InfoItem';
+export * from './InfoItem';

package/src/lib/JsonPathPicker/JsonPathPicker.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+import { JsonPathPickerProperty } from '../../interfaces';
+type Props = {
+    properties: JsonPathPickerProperty[];
+    open: boolean;
+    onClose: () => void;
+    onPaste: (path: string) => void;
+};
+export declare const JsonPathPicker: ({ open, onClose, onPaste, properties }: Props) => JSX.Element;
+export default JsonPathPicker;

package/src/lib/JsonPathPicker/PropertyStep.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="react" />
+import { PropertiesArrayType } from '../../interfaces';
+type Props = {
+    properties: PropertiesArrayType;
+    parentKey?: string;
+    activePath: string;
+    prefix?: string;
+    onClick: (path: string) => void;
+};
+declare const PropertyStep: ({ properties, parentKey, activePath, prefix, onClick, }: Props) => JSX.Element;
+export default PropertyStep;

package/src/lib/JsonPathPicker/{index.ts → index.d.ts}

@@ -1 +1 @@
-export * from './JsonPathPicker';
+export * from './JsonPathPicker';

package/src/lib/JsonView/JsonView.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+type Props = {
+    value: unknown;
+    height?: string;
+};
+export declare const JsonView: ({ value, height }: Props) => JSX.Element;
+export {};

package/src/lib/JsonView/{index.ts → index.d.ts}

@@ -1 +1 @@
-export * from './JsonView';
+export * from './JsonView';

package/src/lib/Loader/Loader.d.ts

@@ -0,0 +1,21 @@
+/// <reference types="react" />
+/**
+ * This interface is referencing the [[Loader]] component props.
+ * @category Common UI components
+ */
+export interface LoaderProps {
+    /**
+     * Background transparency flag. Default: `rgba(255, 255, 255, .3)`
+     */
+    transparent?: boolean;
+    /**
+     * CSS `position` property. Default: `absolute`
+     */
+    position?: 'absolute' | 'relative' | 'fixed';
+}
+/**
+ * Loader screen component. Used in the data loading process
+ * @category Common UI components
+ */
+export declare const Loader: ({ transparent, position }: LoaderProps) => JSX.Element;
+export default Loader;

package/src/lib/Loader/{index.ts → index.d.ts}

@@ -1 +1 @@
-export * from './Loader';
+export * from './Loader';

package/src/lib/Modals/JsonModalView.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+import 'ace-builds/src-noconflict/ace';
+import 'ace-builds/src-noconflict/mode-json';
+type Props = {
+    open: boolean;
+    value: string;
+    onClose: () => void;
+};
+export declare const JsonModalView: React.FC<Props>;
+export default JsonModalView;

package/src/lib/Modals/{index.ts → index.d.ts}

@@ -1 +1 @@
-export * from './JsonModalView';
+export * from './JsonModalView';

package/src/lib/Property/PropertyFiller/JsonEditor.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+import 'ace-builds/src-noconflict/mode-json';
+import { RefCallBack } from 'react-hook-form';
+type Props = {
+    validate?: boolean;
+    name: string;
+    inputRef: RefCallBack;
+};
+declare const JsonEditor: ({ validate, name, inputRef }: Props) => JSX.Element;
+export default JsonEditor;