@guillotinaweb/react-gmi 0.29.2 → 0.30.1

package/README.md

@@ -141,4 +141,5 @@ This project is sponsored by <a href="https://www.vinissimus.com">Vinissimus Win
 [] Add richtext
 [X] Add scales in IImageAttachment
 [] Guillotina, no elimina l'info de l'imatge de l'objecte quan es borra, si que elimina l¡imatge, fer test a guillotina de IImageAttachment i @delete
-[] Poder posar per defecte un Panel properties, item properties etc a tots els tipus. Llegir-ho del context
+[] Poder posar per defecte un Panel properties, item properties etc a tots els tipus. Llegir-ho del context
+[] Mirar de fer generic el Traversal, per no haver de fer el "as" i poder dir de quin tipus és el context

package/dist/actions/copy_item.d.ts

@@ -1,6 +1,6 @@
-import { ItemModel } from '../models';
+import { GuillotinaCommonObject } from '../types/guillotina';
 interface Props {
-    item: ItemModel;
+    item: GuillotinaCommonObject;
 }
 export declare function CopyItem(props: Props): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/actions/move_item.d.ts

@@ -1,6 +1,6 @@
-import { ItemModel } from '../models';
+import { GuillotinaCommonObject } from '../types/guillotina';
 interface Props {
-    item: ItemModel;
+    item: GuillotinaCommonObject;
 }
 export declare function MoveItem(props: Props): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/actions/remove_item.d.ts

@@ -1,6 +1,6 @@
-import { ItemModel } from '../models';
+import { GuillotinaCommonObject } from '../types/guillotina';
 interface Props {
-    item: ItemModel;
+    item: GuillotinaCommonObject;
 }
 export declare function RemoveItem(props: Props): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/components/behaviors/iattachment.d.ts

@@ -1,6 +1,8 @@
-import { GuillotinaFile, GuillotinaSchemaProperties } from '../../types/guillotina';
+import { GuillotinaFile, GuillotinaSchemaProperty } from '../../types/guillotina';
 interface Props {
-    properties: GuillotinaSchemaProperties;
+    properties: {
+        file: GuillotinaSchemaProperty;
+    };
     values: {
         file: GuillotinaFile;
     };

package/dist/components/behaviors/imultiimageorderedattachment.d.ts

@@ -2,7 +2,9 @@ import { GuillotinaFile, GuillotinaSchemaProperties } from '../../types/guilloti
 interface Props {
     properties: GuillotinaSchemaProperties;
     values: {
-        images: GuillotinaFile[];
+        images: {
+            [key: string]: GuillotinaFile;
+        };
     };
 }
 export declare function IMultiImageOrderedAttachment({ properties, values }: Props): import("react/jsx-runtime").JSX.Element;

package/dist/components/behaviors/iworkflow.d.ts

@@ -1 +1 @@
-export declare function IWorkflow(): import("react/jsx-runtime").JSX.Element;
+export declare function IWorkflow(): import("react/jsx-runtime").JSX.Element | null;

package/dist/components/context_toolbar.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-export declare function CreateButton(): import("react/jsx-runtime").JSX.Element;
+export declare function CreateButton(): import("react/jsx-runtime").JSX.Element | null;
 interface Props {
     AddButton?: React.FC;
 }

package/dist/components/fields/editComponent.d.ts

@@ -1,9 +1,10 @@
 /// <reference types="react" />
-import { GuillotinaItemsProperty } from '../../types/guillotina';
+import { GuillotinaSchemaProperty } from '../../types/guillotina';
+import { EditableFieldValue } from '../../types/global';
 interface Props {
-    schema: GuillotinaItemsProperty;
-    val: any;
-    setValue: (value: any) => void;
+    schema: GuillotinaSchemaProperty;
+    val: EditableFieldValue;
+    setValue: (value: EditableFieldValue) => void;
     dataTest?: string;
     className?: string;
     placeholder?: string;

package/dist/components/fields/editableField.d.ts

@@ -1,8 +1,10 @@
+import { EditableFieldValue } from '../../types/global';
+import { GuillotinaSchemaProperty } from '../../types/guillotina';
 interface Props {
     field: string;
-    value: any;
+    value: EditableFieldValue;
     ns?: string;
-    schema?: any;
+    schema?: GuillotinaSchemaProperty;
     modifyContent?: boolean;
     required?: boolean;
 }

package/dist/components/fields/renderField.d.ts

@@ -1,14 +1,17 @@
 /// <reference types="react" />
 import { GuillotinaSchemaProperty } from '../../types/guillotina';
+import { EditableFieldValue } from '../../types/global';
+type PlainType = string | boolean | number;
 interface RenderFieldProps {
-    value: any;
+    value: EditableFieldValue;
     Widget?: React.ComponentType<{
-        value: any;
-        schema: GuillotinaSchemaProperty;
+        value: EditableFieldValue;
+        schema?: GuillotinaSchemaProperty;
+        modifyContent?: boolean;
     }>;
     schema?: GuillotinaSchemaProperty;
 }
-export declare function RenderField({ value, Widget, schema }: RenderFieldProps): any;
+export declare function RenderField({ value, Widget, schema }: RenderFieldProps): import("react/jsx-runtime").JSX.Element | import("react/jsx-runtime").JSX.Element[] | PlainType;
 interface SearchRenderFieldProps {
     schema: GuillotinaSchemaProperty;
     value: string | string[];
@@ -24,7 +27,7 @@ export declare const VocabularyRenderField: ({ schema, value, modifyContent, }:
 interface RenderFieldComponentProps {
     schema: GuillotinaSchemaProperty;
     field: string;
-    val: any;
+    val: EditableFieldValue;
     modifyContent?: boolean;
 }
 export declare function RenderFieldComponent({ schema, field, val, modifyContent, }: RenderFieldComponentProps): import("react/jsx-runtime").JSX.Element;

package/dist/components/flash.d.ts

@@ -1 +1 @@
-export declare function Flash(): import("react/jsx-runtime").JSX.Element;
+export declare function Flash(): import("react/jsx-runtime").JSX.Element | null;

package/dist/components/input/email.d.ts

@@ -1,7 +1,7 @@
 interface Props {
     value?: string;
     dataTest?: string;
-    onChange?: (value: string) => void;
+    onChange: (value: string) => void;
     placeholder?: string;
     id?: string;
 }

package/dist/components/input/form_builder.d.ts

@@ -3,8 +3,8 @@ import { IndexSignature } from '../../types/global';
 import { GuillotinaSchema } from '../../types/guillotina';
 interface Props {
     schema: GuillotinaSchema;
-    formData?: any;
-    onSubmit: (formData: any, initialData: any) => void;
+    formData?: IndexSignature;
+    onSubmit: (formData: IndexSignature, initialData: IndexSignature) => void;
     actionName: string;
     children?: React.ReactNode;
     exclude?: string[];

package/dist/components/input/input.d.ts

@@ -13,7 +13,7 @@ interface Props {
     errorMessage?: string;
     dataTest?: string;
     autofocus?: boolean;
-    onChange?: (value: string) => void;
+    onChange: (value: string) => void | undefined;
     type?: string;
     value?: string;
     required?: boolean;

package/dist/components/input/search_input.d.ts

@@ -4,7 +4,7 @@ interface Props {
     onChange?: (value: string) => void;
     error?: string;
     errorZoneClassName?: string;
-    traversal?: Traversal;
+    traversal: Traversal;
     path?: string;
     qs?: string[][];
     queryCondition?: string;

package/dist/components/input/search_input_list.d.ts

@@ -4,9 +4,9 @@ interface Props {
     onChange: (value: string[]) => void;
     error?: string;
     errorZoneClassName?: string;
-    traversal?: Traversal;
+    traversal: Traversal;
     path?: string;
-    qs?: string[];
+    qs?: string[][];
     queryCondition?: string;
     value: string[];
     btnClass?: string;

package/dist/components/input/select_vocabulary.d.ts

@@ -3,10 +3,10 @@ interface Props {
     vocabularyName: string;
     className?: string;
     classWrap?: string;
-    val?: string;
+    val?: string | string[];
     dataTest?: string;
     multiple?: boolean;
-    onChange?: (value: string) => void;
+    onChange?: (value: string | string[]) => void;
     appendDefault?: boolean;
     id?: string;
     placeholder?: string;

package/dist/components/input/upload.d.ts

@@ -1,9 +1,8 @@
-import { InputHTMLAttributes } from 'react';
 import { LightFile } from '../../types/global';
 interface Props {
     label?: string;
     dataTest?: string;
     onChange: (file: LightFile) => void;
 }
-export declare function FileUpload({ label, onChange, dataTest, }: Props & InputHTMLAttributes<HTMLInputElement>): import("react/jsx-runtime").JSX.Element;
+export declare function FileUpload({ label, onChange, dataTest }: Props): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/components/pagination.d.ts

@@ -4,5 +4,5 @@ interface Props {
     doPaginate: (page: number) => void;
     pager: number;
 }
-export declare function Pagination({ current, total, doPaginate, pager }: Props): import("react/jsx-runtime").JSX.Element;
+export declare function Pagination({ current, total, doPaginate, pager }: Props): import("react/jsx-runtime").JSX.Element | null;
 export {};

package/dist/components/panel/permissions.d.ts

@@ -1,4 +1,4 @@
-export declare function PanelPermissions(): import("react/jsx-runtime").JSX.Element;
+export declare function PanelPermissions(): import("react/jsx-runtime").JSX.Element | null;
 interface AddPermissionProps {
     refresh: (state: number) => void;
     reset: number;

package/dist/components/panel/permissions_prinperm.d.ts

@@ -1,9 +1,9 @@
 interface Props {
-    principals: {
+    principals?: {
         text: string;
         value: string;
     }[];
-    permissions: {
+    permissions?: {
         text: string;
         value: string;
     }[];

package/dist/components/panel/permissions_prinrole.d.ts

@@ -1,5 +1,5 @@
 interface Props {
-    principals: {
+    principals?: {
         text: string;
         value: string;
     }[];

package/dist/components/panel/permissions_roleperm.d.ts

@@ -3,7 +3,7 @@ interface Props {
         text: string;
         value: string;
     }[];
-    permissions: {
+    permissions?: {
         text: string;
         value: string;
     }[];

package/dist/components/path.d.ts

@@ -1 +1 @@
-export declare function Path(): false | import("react/jsx-runtime").JSX.Element;
+export declare function Path(): import("react/jsx-runtime").JSX.Element | null;

package/dist/components/properties_view.d.ts

@@ -1,7 +1,7 @@
 import React from 'react';
 export declare function PropertiesButtonView(): React.FunctionComponentElement<{
     Ctx: import("../contexts").Traversal;
-}>;
+}> | null;
 export declare function PropertiesView(): React.FunctionComponentElement<{
     Ctx: import("../contexts").Traversal;
-}>;
+}> | null;

package/dist/components/search_labels.d.ts

@@ -1,5 +1,5 @@
 interface Props {
     query?: string;
 }
-export declare function SearchLabels({ query }: Props): import("react/jsx-runtime").JSX.Element;
+export declare function SearchLabels({ query }: Props): import("react/jsx-runtime").JSX.Element | null;
 export {};

package/dist/components/search_options_labels.d.ts

@@ -5,5 +5,5 @@ interface Props {
         text: string;
     }[];
 }
-export declare function SearchOptionsLabels({ query, options }: Props): import("react/jsx-runtime").JSX.Element;
+export declare function SearchOptionsLabels({ query, options }: Props): import("react/jsx-runtime").JSX.Element | null;
 export {};

package/dist/components/search_vocabulary_labels.d.ts

@@ -1,6 +1,6 @@
 interface Props {
     query?: string;
-    vocabularyName?: string;
+    vocabularyName: string;
 }
-export declare function SearchVocabularyLabels({ query, vocabularyName }: Props): import("react/jsx-runtime").JSX.Element;
+export declare function SearchVocabularyLabels({ query, vocabularyName }: Props): import("react/jsx-runtime").JSX.Element | null;
 export {};

package/dist/components/selected_items_actions.d.ts

@@ -1,17 +1,31 @@
 /// <reference types="react" />
 import { SearchItem } from '../types/guillotina';
+/**
+ * Actions to apply after select some items
+ * Ex: Delete, Move, Copy...
+ */
 interface PropsItemsActionsProvider {
     items: SearchItem[];
     children: React.ReactNode;
 }
 export declare function ItemsActionsProvider({ items, children, }: PropsItemsActionsProvider): import("react/jsx-runtime").JSX.Element;
+/**
+ * Checkbox component without props that consume the ItemsActionsContext
+ * and it select/unselect all items of the page.
+ */
 export declare function AllItemsCheckbox({ dataTest }: {
     dataTest?: string;
 }): import("react/jsx-runtime").JSX.Element;
+/**
+ * Checkbox component to select ONE item.
+ */
 interface PropsItemCheckbox {
     item: SearchItem;
     dataTest?: string;
 }
 export declare function ItemCheckbox({ item, dataTest }: PropsItemCheckbox): import("react/jsx-runtime").JSX.Element;
+/**
+ * Dropdown to choose some action to apply to the selected items.
+ */
 export declare function ItemsActionsDropdown(): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/components/tabs.d.ts

@@ -2,9 +2,11 @@ import React from 'react';
 import { IndexSignature } from '../types/global';
 interface Props {
     tabs: IndexSignature;
-    currentTab?: string;
+    currentTab: string;
     rightToolbar?: React.ReactNode;
-    fallback?: React.ComponentType;
+    fallback?: React.ComponentType<{
+        title: string;
+    }>;
 }
 export declare function TabsPanel({ tabs, currentTab, rightToolbar, fallback, }: Props): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/components/widgets/tags.d.ts

@@ -1,6 +1,9 @@
 interface Props {
     items: string[];
-    available?: string[];
+    available?: {
+        value: string;
+        text: string;
+    }[];
     title: string;
     noData: string;
     onChange: (items: string[]) => void;

package/dist/contexts/index.d.ts

@@ -2,45 +2,47 @@ import { Dispatch } from 'react';
 import { GuillotinaClient } from '../lib/client.js';
 import { Auth } from '../lib/auth.js';
 import { IndexSignature } from '../types/global';
-import { GuillotinaGlobalState } from '../reducers/guillotina';
+import { GuillotinaGlobalState, GuillotinaReducerActionTypes } from '../reducers/guillotina';
+import { GuillotinaCommonObject } from '../types/guillotina.js';
 export declare const AuthContext: import("react").Context<{}>;
-export declare const ClientContext: import("react").Context<GuillotinaClient>;
+export declare const ClientContext: import("react").Context<GuillotinaClient | null>;
 interface PropsTraversal {
     client: GuillotinaClient;
     auth: Auth;
     state: GuillotinaGlobalState;
     dispatch: Dispatch<{
-        type: string;
+        type: GuillotinaReducerActionTypes;
         payload: IndexSignature;
     }>;
     registry: IndexSignature;
     flash: (action: string, result: string) => void;
     url: string;
+    children?: React.ReactNode;
 }
 export declare class Traversal {
     private dispatch;
-    state: any;
-    client: any;
-    registry: any;
-    url: any;
-    auth: any;
+    state: GuillotinaGlobalState;
+    client: GuillotinaClient;
+    registry: IndexSignature<any>;
+    url: string;
+    auth: Auth;
     constructor({ flash, ...props }: PropsTraversal);
     refresh({ transparent }?: {
-        transparent?: boolean;
+        transparent?: boolean | undefined;
     }): void;
-    get path(): any;
-    get pathPrefix(): any;
-    get context(): any;
-    get containerPath(): any;
-    apply(data: any): void;
-    flash(message: any, type: any): void;
+    get path(): string;
+    get pathPrefix(): string;
+    get context(): GuillotinaCommonObject;
+    get containerPath(): string;
+    apply(data: IndexSignature): void;
+    flash(message: string, type: string): void;
     clearFlash(): void;
-    doAction(action: any, params?: {}): void;
+    doAction(action: string, params?: {}): void;
     cancelAction(): void;
-    hasPerm(permission: any): boolean;
-    filterTabs(tabs: any, tabsPermissions: any): {};
+    hasPerm(permission: string): boolean;
+    filterTabs(tabs: IndexSignature, tabsPermissions: IndexSignature): IndexSignature<any>;
 }
-export declare const TraversalContext: import("react").Context<Traversal>;
+export declare const TraversalContext: import("react").Context<Traversal | null>;
 export declare function TraversalProvider({ children, ...props }: PropsTraversal & {
     children: React.ReactNode;
 }): import("react/jsx-runtime").JSX.Element;

package/dist/forms/required_fields.d.ts

@@ -1,7 +1,6 @@
+import { IndexSignature } from '../types/global';
 interface Props {
-    onSubmit: (data: {
-        [key: string]: any;
-    }) => void;
+    onSubmit: (data: IndexSignature) => void;
     actionName?: string;
     title?: string;
     dataTest?: string;

package/dist/forms/users.d.ts

@@ -3,7 +3,7 @@ import { IndexSignature } from '../types/global';
 interface Props {
     children: React.ReactNode;
     onSubmit: (data: IndexSignature) => void;
-    actionName?: string;
+    actionName: string;
     formData?: IndexSignature;
     exclude?: string[];
     remotes?: IndexSignature;

package/dist/hooks/useClickAway.d.ts

@@ -1 +1,2 @@
-export default function useClickAway(ref: any, onClickAway: any, events?: string[]): void;
+/// <reference types="react" />
+export default function useClickAway(ref: React.RefObject<HTMLElement>, onClickAway: (event: Event) => void, events?: string[]): void;

package/dist/hooks/useConfig.d.ts

@@ -7,11 +7,13 @@ interface IConfig {
     Permissions: string[];
     SearchEngine: string;
     SizeImages?: string[];
-    icons?: string[];
+    icons?: {
+        [key: string]: string;
+    };
     properties_default?: string[];
     properties_ignore_fields?: string[];
     fieldHaveDeleteButton: (schema: GuillotinaSchemaProperty) => boolean;
 }
-export declare const Config: IConfig;
+export declare const defaultConfig: IConfig;
 export declare function useConfig(cfg?: {}): IConfig;
 export {};

package/dist/hooks/useCrudContext.d.ts

@@ -1,4 +1,5 @@
-interface State<T = unknown> {
+import { Traversal } from '../contexts';
+interface State<T> {
     loading?: boolean;
     isError?: boolean;
     errorMessage?: string;
@@ -6,15 +7,15 @@ interface State<T = unknown> {
     response?: unknown;
 }
 export declare function useCrudContext<T>(): {
-    Ctx: import("../contexts").Traversal;
-    patch: (data: any, endpoint?: any, body?: boolean) => Promise<State<unknown>>;
-    del: (data?: {}, endpoint?: any, body?: boolean) => Promise<State<unknown>>;
-    post: (data: any, endpoint?: any, body?: boolean) => Promise<State<unknown>>;
-    get: (endpoint?: any) => Promise<State<unknown>>;
-    loading?: boolean;
-    isError?: boolean;
-    errorMessage?: string;
-    result?: T;
+    Ctx: Traversal;
+    patch: (data?: {}, endpoint?: string | undefined, body?: boolean) => Promise<State<T>>;
+    del: (data?: {}, endpoint?: string | undefined, body?: boolean) => Promise<State<T>>;
+    post: (data?: {}, endpoint?: string | undefined, body?: boolean) => Promise<State<T>>;
+    get: (endpoint?: string | undefined) => Promise<State<T>>;
+    loading?: boolean | undefined;
+    isError?: boolean | undefined;
+    errorMessage?: string | undefined;
+    result?: T | undefined;
     response?: unknown;
 };
 export {};

package/dist/hooks/useInput.d.ts

@@ -1,10 +1,11 @@
-declare const useInput: (onChange: any, value: any, validator: any) => {
-    onChange: (ev: any) => void;
+import { ChangeEvent } from 'react';
+declare const useInput: (onChange: (value: string) => void | undefined, value: string, validators: ((value: string) => boolean)[]) => {
+    onChange: (ev: ChangeEvent<HTMLInputElement>) => void;
     onFocus: () => void;
     onBlur: () => void;
     state: {
         hasError: boolean;
-        value: any;
+        value: string;
     };
 };
 export default useInput;

package/dist/hooks/useRegistry.d.ts

@@ -1,38 +1,33 @@
 import { FolderCtx } from '../views/folder';
 import React from 'react';
-import { GuillotinaSchema } from '../types/guillotina';
+import { GuillotinaCommonObject, ItemColumn, RegistrySchema } from '../types/guillotina';
 export interface IRegistry {
     paths: {
         [key: string]: React.FC;
     };
     views: {
-        [key: string]: React.FC | React.ComponentType;
+        [key: string]: React.FC | React.ComponentType<any>;
     };
     actions: {
-        [key: string]: React.FC;
+        [key: string]: (props: any) => JSX.Element;
     };
     forms: {
-        [key: string]: React.FC;
+        [key: string]: (props: any) => JSX.Element;
     };
     behaviors: {
-        [key: string]: React.FC;
+        [key: string]: (props: any | undefined) => JSX.Element | null;
     };
     itemsColumn: {
-        [key: string]: () => {
-            label: string;
-            key: string;
-            isSortable?: boolean;
-            child: React.ReactNode;
-        }[];
+        [key: string]: () => ItemColumn[];
     };
     schemas: {
-        [key: string]: GuillotinaSchema;
+        [key: string]: RegistrySchema;
     };
     properties: {
         [key: string]: React.FC;
     };
     components: {
-        [key: string]: React.FC;
+        [key: string]: (props: any) => React.ReactNode | null | undefined;
     };
     searchEngineQueryParamsFunction: {
         [key: string]: string;
@@ -47,22 +42,27 @@ export interface IRegistry {
         };
     };
 }
-export declare const defaultComponent: (context: any) => typeof FolderCtx;
-export declare function useRegistry(data: any): {
+export declare const defaultComponent: (context: GuillotinaCommonObject) => typeof FolderCtx;
+export declare function useRegistry(data: IRegistry): {
     registry: IRegistry;
-    get: (key: any, param: any, fallback?: any) => any;
-    getForm: (type: string, fallback?: React.FC<{}>) => React.FC<{}>;
-    getComponent: (context: any, path: any, fallback?: any) => any;
-    getAction: (type: string, fallback?: React.FC<{}>) => React.FC<{}>;
-    getBehavior: (type: string, fallback: React.FC<{}>) => React.FC<{}>;
-    getProperties: (type: string) => {};
-    getItemsColumn: (type: any) => {
-        label: string;
+    get: (key: keyof IRegistry, param: string, fallback?: undefined) => string | React.ComponentClass<any, any> | string[] | React.FC<{}> | RegistrySchema | ((props: any) => JSX.Element | null) | (() => ItemColumn[]) | ((props: any) => React.ReactNode) | {
+        direction: "des" | "asc";
+        field: string;
+    } | undefined;
+    getForm: (type: string, fallback: React.FC<{}>) => (props: any) => JSX.Element;
+    getComponent: (context: GuillotinaCommonObject | undefined, path: string, fallback?: undefined) => React.ComponentClass<any, any> | React.FC<{}> | typeof FolderCtx | undefined;
+    getAction: (type: string, fallback?: React.FC<{}> | undefined) => (props: any) => JSX.Element;
+    getBehavior: (type: string, fallback: React.FC<{}>) => (props: any) => JSX.Element | null;
+    getProperties: (type: string) => React.FC<{}>;
+    getItemsColumn: (type: string) => ItemColumn[] | undefined;
+    getFieldsToFilter: (type: string, fallback?: string[]) => string[];
+    getDefaultSortValue: (type: string, fallback?: {
         key: string;
-        isSortable?: boolean;
-        child: React.ReactNode;
-    }[];
-    getFieldsToFilter: (type: string, fallback: any) => any;
-    getDefaultSortValue: (type: string, fallback: any) => any;
-    getSchemas: (type: string) => {};
+        direction: string;
+    }) => {
+        direction: "des" | "asc";
+        field: string;
+    };
+    getSchemas: (type: string) => RegistrySchema;
+    getView: (name: string) => React.ComponentType<any> | React.FC<{}>;
 };

package/dist/hooks/useSetState.d.ts

@@ -1 +1,6 @@
-export default function useSetState<T>(initialState: any): [T, (value: Partial<T>) => void];
+export type TSetState<T> = (newPartialState: Partial<T>) => void;
+/**
+ * Do setState like react class component.
+ */
+declare function useSetState<T extends object>(initialState: T): [T, TSetState<T>];
+export default useSetState;