@pautena/react-design-system 0.12.2 → 0.13.0-alpha.1

package/dist/hooks/types/components/value-displays/group-value-card/group-value-card.mock.d.ts

@@ -0,0 +1,5 @@
+import React from "react";
+import { GroupValueCardProps } from "./group-value-card";
+export declare const GroupValueCardDummy: ({ dense, editable, ...rest }: GroupValueCardProps & {
+    editable?: boolean | undefined;
+}) => React.JSX.Element;

package/dist/hooks/types/components/value-displays/group-value-card/index.d.ts

@@ -0,0 +1 @@
+export * from "./group-value-card";

package/dist/hooks/types/components/value-displays/index.d.ts

@@ -0,0 +1,10 @@
+export * from "./value-text";
+export * from "./value-card";
+export * from "./value-boolean";
+export * from "./value-datetime";
+export * from "./group-value-card";
+export * from "./value-base/value-displays.types";
+export * from "./value-rating";
+export * from "./value-base";
+export * from "./value-item";
+export * from "./value-label";

package/dist/hooks/types/components/value-displays/value-base/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./value-edit";
+export * from "./value-displays.types";

package/dist/hooks/types/components/value-displays/value-base/value-displays.types.d.ts

@@ -0,0 +1,30 @@
+export interface BaseValueProps<T> {
+    /**
+     * Name of the displayed value
+     */
+    label: string;
+    /**
+     * Value displayed
+     */
+    value?: T;
+    /**
+     * String rendered if value is undefined
+     */
+    placeholder?: string;
+    /**
+     * The value has to be displayed as compact or not.
+     * False by default
+     */
+    dense?: boolean;
+}
+export interface EditableValueProps<T> {
+    /**
+     * This field can be edited or not
+     */
+    editable?: boolean;
+    /**
+     * Callback executed when the value is edited
+     */
+    onEdit?: (value?: T) => void;
+}
+export declare const DefaultPlaceholder = "-";

package/dist/hooks/types/components/value-displays/value-base/value-edit.d.ts

@@ -0,0 +1,24 @@
+import React from "react";
+import { SxProps, Theme } from "@mui/material";
+export interface ValueEditButtonsProps {
+    onClickCancel: () => void;
+    onClickSubmit: () => void;
+    sx?: SxProps<Theme>;
+}
+export declare const ValueEditButtons: ({ onClickCancel, onClickSubmit, sx }: ValueEditButtonsProps) => React.JSX.Element;
+/**
+ * Hook to manage the editing behaviour
+ */
+export declare const useEditableValueDisplay: <T>(initialValue: T | undefined, onEdit: (value?: T | undefined) => void) => {
+    isEditing: boolean;
+    cancelEdit: () => void;
+    editValue: T | undefined;
+    setEditValue: React.Dispatch<React.SetStateAction<T | undefined>>;
+    startEdit: () => void;
+    submitEdit: () => void;
+};
+export interface ValueEditButtonProps {
+    dense?: boolean;
+    onClick: () => void;
+}
+export declare const ValueEditButton: ({ dense, onClick }: ValueEditButtonProps) => React.JSX.Element;

package/dist/hooks/types/components/value-displays/value-boolean/index.d.ts

@@ -0,0 +1 @@
+export * from "./value-boolean";

package/dist/hooks/types/components/value-displays/value-boolean/value-boolean.d.ts

@@ -0,0 +1,7 @@
+import React from "react";
+import { BaseValueProps, EditableValueProps } from "../value-base";
+export type ValueBooleanProps = BaseValueProps<boolean> & EditableValueProps<boolean>;
+/**
+ * Displays a boolean value with a label
+ */
+export declare const ValueBoolean: ({ label, value, placeholder, editable, dense, onEdit, }: ValueBooleanProps) => React.JSX.Element;

package/dist/hooks/types/components/value-displays/value-card/index.d.ts

@@ -0,0 +1 @@
+export * from "./value-card";

package/dist/hooks/types/components/value-displays/value-card/value-card.d.ts

@@ -0,0 +1,7 @@
+import React from "react";
+import { PropsWithChildren } from "react";
+export type ValueCardProps = PropsWithChildren;
+/**
+ * Container to show a labeled value
+ */
+export declare const ValueCard: ({ children }: ValueCardProps) => React.JSX.Element;

package/dist/hooks/types/components/value-displays/value-content/index.d.ts

@@ -0,0 +1 @@
+export * from "./value-content";

package/dist/hooks/types/components/value-displays/value-content/value-content.d.ts

@@ -0,0 +1,38 @@
+import { SxProps, Theme } from "@mui/material";
+import React from "react";
+export declare const getValueContentLabelId: (label: string) => string;
+export interface ValueContentProps {
+    /**
+     * Name of the displayed value
+     */
+    label: string;
+    /**
+     * If true, the label will not be shown
+     */
+    hideLabel?: boolean;
+    /**
+     * If defined, a tooltip is going to be added arround the children;
+     */
+    tooltip?: string;
+    /**
+     * Timeout before the tooltip appears when the user hovers the value
+     */
+    tooltipEnterDelay?: number;
+    /**
+     * Component that's going to be renderd under the label
+     */
+    children: React.ReactElement<any, any>;
+    /**
+     * The value has to be displayed as compact or not.
+     * False by default
+     */
+    dense?: boolean;
+    /**
+     * Custom styles for the root component
+     */
+    sx?: SxProps<Theme>;
+}
+/**
+ * Displays a string value with a label
+ */
+export declare const ValueContent: ({ label, hideLabel, tooltip, tooltipEnterDelay, children, dense, sx, }: ValueContentProps) => React.JSX.Element;

package/dist/hooks/types/components/value-displays/value-datetime/index.d.ts

@@ -0,0 +1 @@
+export * from "./value-datetime";

package/dist/hooks/types/components/value-displays/value-datetime/value-datetime.d.ts

@@ -0,0 +1,17 @@
+import React from "react";
+import { BaseValueProps, EditableValueProps } from "../value-base/value-displays.types";
+export type EditInputType = "datetime" | "date" | "time";
+export interface ValueDatetimeProps extends BaseValueProps<Date>, EditableValueProps<Date> {
+    /**
+     * Datetime format
+     */
+    format: string;
+    /**
+     * Edit input type
+     */
+    editInputType?: EditInputType;
+}
+/**
+ * Displays a formated datetime with a label
+ */
+export declare const ValueDatetime: ({ label, value: valueProp, format: fmt, placeholder, editable, editInputType, dense, onEdit, }: ValueDatetimeProps) => React.JSX.Element;

package/dist/hooks/types/components/value-displays/value-image/index.d.ts

@@ -0,0 +1 @@
+export * from "./value-image";

package/dist/hooks/types/components/value-displays/value-image/value-image.d.ts

@@ -0,0 +1,12 @@
+import React from "react";
+import { BaseValueProps } from "../value-base/value-displays.types";
+export interface ValueImageProps extends BaseValueProps<string> {
+    /**
+     * Image size
+     */
+    size?: number;
+}
+/**
+ * Displays a image value with a label
+ */
+export declare const ValueImage: ({ label, value, size: sizeArg, dense }: ValueImageProps) => React.JSX.Element;

package/dist/hooks/types/components/value-displays/value-item/index.d.ts

@@ -0,0 +1 @@
+export * from "./value-item";

package/dist/hooks/types/components/value-displays/value-item/value-item.d.ts

@@ -0,0 +1,13 @@
+import { GridProps } from "@mui/material";
+import { ResponsiveStyleValue } from "@mui/system";
+import { PropsWithChildren, FunctionComponent, ReactElement } from "react";
+export type ValueItemProps = PropsWithChildren<Omit<GridProps, "item" | "container"> & {
+    bordered?: ResponsiveStyleValue<boolean>;
+}>;
+export type ValueItemComponent = FunctionComponent<ValueItemProps>;
+export type ValueItemElement = ReactElement<ValueItemProps, ValueItemComponent>;
+export declare const valueItemClasses: {
+    root: string;
+    content: string;
+};
+export declare const ValueItem: ValueItemComponent;

package/dist/hooks/types/components/value-displays/value-label/index.d.ts

@@ -0,0 +1 @@
+export * from "./value-label";

package/dist/hooks/types/components/value-displays/value-label/value-label.d.ts

@@ -0,0 +1,10 @@
+import React from "react";
+import { BaseValueProps } from "../value-base";
+import { LabelVariant } from "~/components/data-display";
+export type ValueLabelProps = BaseValueProps<string | number | string[] | number[]> & {
+    variant: LabelVariant | LabelVariant[];
+};
+/**
+ * Displays a label component value with a label
+ */
+export declare const ValueLabel: ({ label, value: valueProp, placeholder, variant, }: ValueLabelProps) => React.JSX.Element;

package/dist/hooks/types/components/value-displays/value-rating/index.d.ts

@@ -0,0 +1 @@
+export * from "./value-rating";

package/dist/hooks/types/components/value-displays/value-rating/value-rating.d.ts

@@ -0,0 +1,9 @@
+import React from "react";
+import { BaseValueProps, EditableValueProps } from "../value-base/value-displays.types";
+export type ValueRatingProps = BaseValueProps<number> & {
+    maxRating?: number;
+} & EditableValueProps<number>;
+/**
+ * Displays a number using stars
+ */
+export declare const ValueRating: ({ label, value, maxRating, editable, dense, onEdit, }: ValueRatingProps) => React.JSX.Element;

package/dist/hooks/types/components/value-displays/value-text/index.d.ts

@@ -0,0 +1 @@
+export * from "./value-text";

package/dist/hooks/types/components/value-displays/value-text/value-text.d.ts

@@ -0,0 +1,7 @@
+import React from "react";
+import { BaseValueProps, EditableValueProps } from "../value-base";
+export type ValueTextProps = BaseValueProps<string | number> & EditableValueProps<string>;
+/**
+ * Displays a string value with a label
+ */
+export declare const ValueText: ({ label, value: valueProp, placeholder, editable, dense, onEdit, }: ValueTextProps) => React.JSX.Element;

package/dist/hooks/types/generators/generators.mock.d.ts

@@ -0,0 +1,30 @@
+import { BasicModelInstance, FieldType, Model } from "./generators.model";
+export declare const BirthDateFormat = "dd/MM/yyyy";
+export declare const ReturnTimeFormat = "HH:mm";
+export declare const TradeDateFormat = "dd/MM/yyyy HH:mm";
+export declare const mockModel: Model;
+export interface MockInstance {
+    id: string;
+    firstName: string;
+    middleName: string;
+    lastName: string;
+    age: number;
+    birthDate: Date;
+    car: {
+        model: string;
+        manufacturer: string;
+        color: string;
+        type: string[];
+        vin: string;
+        vrm: string;
+        returnTime: Date;
+    };
+    quantity: number;
+    available: boolean;
+    currency: string;
+    tradeDate: Date;
+    [key: string]: FieldType;
+    codes: string[];
+    identifiers: string[];
+}
+export declare const createModelInstance: <T extends BasicModelInstance>(model: Model, seed?: number) => T;

package/dist/hooks/types/generators/generators.model.d.ts

@@ -0,0 +1,92 @@
+/**
+ * MODEL TYPES
+ * Types used to specify the model
+ */
+export type ModelFieldTypes = "string" | "number" | "string[]" | "number[]" | "boolean" | "enum" | "multienum" | "date" | "time" | "datetime";
+type Base = {
+    id: string;
+    description: string;
+    name: string;
+    listable?: boolean;
+    updatable?: boolean;
+    required?: boolean;
+};
+type Breakpoints = {
+    xs?: number;
+    sm?: number;
+    md?: number;
+    lg?: number;
+    xl?: number;
+};
+type StringField = {
+    type: "string";
+};
+type StringArrayField = {
+    type: "string[]";
+};
+type NumberField = {
+    type: "number";
+};
+type NumberArrayField = {
+    type: "number[]";
+};
+type BooleanField = {
+    type: "boolean";
+};
+type EnumField = {
+    type: "enum";
+    value: string[];
+};
+type MultiEnumField = {
+    type: "multienum";
+    value: string[];
+};
+type DateField = {
+    type: "date";
+    format: string;
+    default: Date;
+};
+type TimeField = {
+    type: "time";
+    format: string;
+    default: Date;
+};
+type DatetimeField = {
+    type: "datetime";
+    format: string;
+    default: Date;
+};
+type SingleFields = StringField | NumberField | StringArrayField | NumberArrayField | BooleanField | EnumField | MultiEnumField | DateField | TimeField | DatetimeField;
+export type GroupField = {
+    type: "group";
+    value: (Base & Breakpoints & SingleFields)[];
+} & Base;
+export type ArrayGroupField = {
+    type: "group[]";
+    value: (Base & Breakpoints & SingleFields)[];
+} & Base;
+type Fields = SingleFields | GroupField | ArrayGroupField;
+export type ModelField = Base & Breakpoints & Fields;
+export type Model = {
+    fields: ModelField[];
+};
+/**
+ * INSTANCE TYPES
+ * Types used to represent an instance of a model specification
+ */
+export type BaseFieldType = string | number | boolean | Date;
+export type ArrayFieldType = string[] | number[];
+export type SingleFieldType = BaseFieldType | ArrayFieldType;
+export type GroupInstanceType = {
+    [key: string]: SingleFieldType;
+};
+export type ArrayInstanceType = {
+    [key: string]: SingleFieldType;
+}[];
+export type FieldType = SingleFieldType | GroupInstanceType;
+export interface BasicModelInstance {
+    id: string;
+    [key: string]: FieldType;
+}
+export declare const newInstanceFromValuesOrZeroValue: <T extends BasicModelInstance>(model: Model, values?: T | undefined) => T;
+export {};

package/dist/hooks/types/generators/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./object-details";
+export * from "./model-router";
+export * from "./generators.model";
+export * from "./model-form";
+export * from "./table-list";

package/dist/hooks/types/generators/model-form/index.d.ts

@@ -0,0 +1 @@
+export * from "./model-form";

package/dist/hooks/types/generators/model-form/model-form-field.d.ts

@@ -0,0 +1,11 @@
+import React from "react";
+import { ModelField } from "../generators.model";
+export interface ModelFormField {
+    field: ModelField;
+    update: boolean;
+    dense?: boolean;
+    path?: string[];
+    value: any;
+    onChangeValue: (path: string[], value: any) => void;
+}
+export declare const ModelFormField: ({ field, path, value, dense, update, onChangeValue, }: ModelFormField) => React.JSX.Element | null;

package/dist/hooks/types/generators/model-form/model-form.d.ts

@@ -0,0 +1,10 @@
+import React from "react";
+import { Model, BasicModelInstance } from "../generators.model";
+export interface ModelFormProps<T extends BasicModelInstance> {
+    model: Model;
+    dense?: boolean;
+    initialValues?: T;
+    saveButtonText: string;
+    onSubmit: (values: T) => void;
+}
+export declare const ModelForm: <T extends BasicModelInstance>({ model, saveButtonText, dense, onSubmit, initialValues, }: ModelFormProps<T>) => React.JSX.Element;

package/dist/hooks/types/generators/model-router/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./model-router";
+export * from "./model-router.types";

package/dist/hooks/types/generators/model-router/model-router.d.ts

@@ -0,0 +1,5 @@
+import React from "react";
+import { BasicModelInstance } from "../generators.model";
+import { AddScreenProps, DetailsScreenProps, ListScreenProps, UpdateScreenProps } from "./screens";
+export type ModelRouterProps<T extends BasicModelInstance> = DetailsScreenProps<T> & ListScreenProps<T> & AddScreenProps<T> & UpdateScreenProps<T>;
+export declare const ModelRouter: <T extends BasicModelInstance>(props: ModelRouterProps<T>) => React.JSX.Element;

package/dist/hooks/types/generators/model-router/model-router.types.d.ts

@@ -0,0 +1,9 @@
+export interface RequestState {
+    idle?: boolean;
+    loading?: boolean;
+    error?: string;
+    success?: boolean;
+}
+export declare const IdleRequest: RequestState;
+export declare const LoadingRequest: RequestState;
+export declare const SuccessRequest: RequestState;

package/dist/hooks/types/generators/model-router/screens/add-screen.d.ts

@@ -0,0 +1,17 @@
+import React from "react";
+import { BasicModelInstance } from "../../generators.model";
+import { RequestState } from "../model-router.types";
+import { BaseScreenProps } from "./screens.types";
+export interface AddScreenProps<T extends BasicModelInstance> extends BaseScreenProps {
+    /**
+     * Callback executed when the user wants to
+     * add a new item
+     */
+    onSubmitNewItem: (obj: T) => void;
+    /**
+     * Current status of the request to retrieve
+     * add a new item
+     */
+    newItemRequest: RequestState;
+}
+export declare const AddScreen: <T extends BasicModelInstance>({ model, modelName, basePath, onSubmitNewItem, newItemRequest, }: AddScreenProps<T>) => React.JSX.Element;

package/dist/hooks/types/generators/model-router/screens/details-screen.d.ts

@@ -0,0 +1,21 @@
+import React from "react";
+import { RequestState } from "../model-router.types";
+import { BaseScreenProps } from "./screens.types";
+import { BasicModelInstance } from "../../generators.model";
+export interface DetailsScreenProps<T extends BasicModelInstance> extends BaseScreenProps {
+    /**
+     * Callback executed each time we want
+     * the details information of an item
+     */
+    onRequestItem: (id: string) => void;
+    /**
+     * Current status of the request to retrieve
+     * an item
+     */
+    itemRequest: RequestState;
+    /**
+     * Item to be displayed
+     */
+    detailsItem?: T;
+}
+export declare const DetailsScreen: <T extends BasicModelInstance>({ model, modelName, basePath, onRequestItem, itemRequest, detailsItem, }: DetailsScreenProps<T>) => React.JSX.Element;

package/dist/hooks/types/generators/model-router/screens/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./update-screen";
+export * from "./list-screen";
+export * from "./add-screen";
+export * from "./details-screen";

package/dist/hooks/types/generators/model-router/screens/list-screen.d.ts

@@ -0,0 +1,31 @@
+import React from "react";
+import { BasicModelInstance } from "../../generators.model";
+import { RequestState } from "../model-router.types";
+import { BaseScreenProps } from "./screens.types";
+export interface ListScreenProps<T extends BasicModelInstance> extends BaseScreenProps {
+    /**
+     * Callback executed each time the list screen
+     * requests for a data update
+     */
+    onRequestList: () => void;
+    /**
+     * List of items to be displayed in the list screen
+     */
+    listData: T[];
+    /**
+     * Callback executed when the user clicks an option
+     * to delete an item
+     */
+    onClickDeleteItem: (item: T) => void;
+    /**
+     * Current status of the request to retrieve
+     * the list items
+     */
+    listRequest: RequestState;
+    /**
+     * Current status of the request to delete
+     * an item
+     */
+    deleteRequest: RequestState;
+}
+export declare const ListScreen: <T extends BasicModelInstance>({ model, modelName, listData, listRequest, deleteRequest, basePath, deleteFeature, updateFeature, addFeature, detailsFeature, onRequestList, onClickDeleteItem, }: ListScreenProps<T>) => React.JSX.Element;

package/dist/hooks/types/generators/model-router/screens/screens.types.d.ts

@@ -0,0 +1,31 @@
+import { Model } from "../../generators.model";
+export interface BaseScreenProps {
+    /**
+     * UI-friendly string that represents the model
+     */
+    modelName: string;
+    /**
+     * Structure that represents the fields of the model
+     */
+    model: Model;
+    /**
+     * Path to attach before each internal ModelRouter path
+     */
+    basePath?: string;
+    /**
+     * If true delete features are enabled
+     */
+    deleteFeature?: boolean;
+    /**
+     * If true update features are enabled
+     */
+    updateFeature?: boolean;
+    /**
+     * If true add features are enabled
+     */
+    addFeature?: boolean;
+    /**
+     * If true details features are enabled
+     */
+    detailsFeature?: boolean;
+}

package/dist/hooks/types/generators/model-router/screens/update-screen.d.ts

@@ -0,0 +1,30 @@
+import React from "react";
+import { BasicModelInstance } from "../../generators.model";
+import { RequestState } from "../model-router.types";
+import { BaseScreenProps } from "./screens.types";
+export interface UpdateScreenProps<T extends BasicModelInstance> extends BaseScreenProps {
+    /**
+     * Callback executed when the user wants to update
+     * an item
+     */
+    onSubmitUpdateItem: (obj: T) => void;
+    /**
+     * Current status of the request to update an item
+     */
+    submitUpdateItemRequest: RequestState;
+    /**
+     * Current status of the request to retrieve
+     * the item to be updated
+     */
+    updateItemRequest: RequestState;
+    /**
+     * Callback executed to retrive the item that
+     * has to going tobe updated
+     */
+    onRequestUpdateItem: (id: string) => void;
+    /**
+     * Item that is going to be updated
+     */
+    updateItem?: T;
+}
+export declare const UpdateScreen: <T extends BasicModelInstance>({ model, modelName, basePath, submitUpdateItemRequest, updateItemRequest, updateItem, onSubmitUpdateItem, onRequestUpdateItem, }: UpdateScreenProps<T>) => React.JSX.Element;

package/dist/hooks/types/generators/model-router/stories/templates.d.ts

@@ -0,0 +1,21 @@
+import { MockInstance } from "../../generators.mock";
+export declare const onRequestListAction: import("@storybook/addon-actions").HandlerFunction;
+export declare const onSubmitNewItemAction: import("@storybook/addon-actions").HandlerFunction;
+export declare const onRequestItem: import("@storybook/addon-actions").HandlerFunction;
+export declare const onRequestUpdateItemAction: import("@storybook/addon-actions").HandlerFunction;
+export declare const onSubmitUpdateAction: import("@storybook/addon-actions").HandlerFunction;
+export declare const onRequestDeleteAction: import("@storybook/addon-actions").HandlerFunction;
+export declare const REQUEST_TIMEOUT = 2000;
+export declare const item1: MockInstance;
+export declare const data: MockInstance[];
+export declare const baseArgs: {
+    modelName: string;
+    model: import("../..").Model;
+    listData: MockInstance[];
+    listRequest: import("../model-router.types").RequestState;
+    deleteRequest: import("../model-router.types").RequestState;
+    newItemRequest: import("../model-router.types").RequestState;
+    updateItemRequest: import("../model-router.types").RequestState;
+    submitUpdateItemRequest: import("../model-router.types").RequestState;
+    itemRequest: import("../model-router.types").RequestState;
+};

package/dist/hooks/types/generators/object-details/index.d.ts

@@ -0,0 +1 @@
+export * from "./object-details";

package/dist/hooks/types/generators/object-details/object-details.d.ts

@@ -0,0 +1,8 @@
+import React from "react";
+import { Model, BasicModelInstance } from "../generators.model";
+export interface ObjectDetailsProps<T extends BasicModelInstance> {
+    model: Model;
+    dense?: boolean;
+    instance: T;
+}
+export declare const ObjectDetails: <T extends BasicModelInstance>({ model, instance, dense, }: ObjectDetailsProps<T>) => React.JSX.Element;

package/dist/hooks/types/generators/table-list/index.d.ts

@@ -0,0 +1 @@
+export * from "./table-list";

package/dist/hooks/types/generators/table-list/table-list.d.ts

@@ -0,0 +1,19 @@
+import React from "react";
+import { HeadCell, Order } from "../../components/tables/enhanced-table";
+import { BasicModelInstance } from "../generators.model";
+export interface TableRowOption<T extends BasicModelInstance> {
+    id: string;
+    label: string;
+    onClick: (item: T) => void;
+}
+export interface TableListProps<T extends BasicModelInstance> {
+    columns: HeadCell<T>[];
+    data: T[];
+    search?: boolean;
+    defaultSort: string;
+    defaultOrder?: Order;
+    loading?: boolean;
+    options?: TableRowOption<T>[];
+    onClick?: (d: T) => void;
+}
+export declare const TableList: <T extends BasicModelInstance>({ columns: columnsProp, options, data, onClick, search, defaultSort, defaultOrder, loading, }: TableListProps<T>) => React.JSX.Element;

package/dist/hooks/types/hooks/index.d.ts

@@ -0,0 +1 @@
+export * from "./routing";

package/dist/hooks/types/hooks/routing/index.d.ts

@@ -0,0 +1 @@
+export * from "./routing.hooks";

package/dist/hooks/types/hooks/routing/routing.hooks.d.ts

@@ -0,0 +1,5 @@
+export interface NavigateWhenValueChangesOptions<T> {
+    from: T;
+    to: T;
+}
+export declare const useNavigateWhenValueChanges: <T>(path: string, value: T | undefined, { from, to }: NavigateWhenValueChangesOptions<T>) => void;