@mgarlik/datastore 0.1.22 → 0.1.24

package/dist/index.d.cts

@@ -1,6 +1,65 @@
 import React$1, { ReactNode } from 'react';
+import { filterType } from '@mgarlik/json-filter';
 import { D as DataStoreStorage } from './storage-D_xv8gFb.cjs';
 
+type formTypes = "textInput" | "select" | "switch" | "dateTime" | "radio";
+
+type textInputProps = {
+    placeholder?: string;
+    multiline?: boolean;
+    numberOfLines?: number;
+    secure: boolean;
+};
+
+type switchProps = {
+    thumbColor?: string;
+    trackColor?: { true: string; false: string };
+};
+
+type dateTimeProps = {
+    mode: "date" | "time" | "datetime";
+};
+
+type DataSourceOptions = {
+    dataProvider: string;
+    filter?: filterType;
+    map: Record<string, string>;
+};
+
+type selectProps = {
+    multiple?: boolean;
+    options?:
+    | Array<{ value: string | number; label: string }>
+    | { dataSource: DataSourceOptions };
+};
+
+// type selectProps = {
+//     multiple?: boolean;
+//     options?:
+//     Array<{ value: string | number; label: string }>
+//     | {
+//         dataSource: ProviderDataSourceType & {
+//             map: { value: string; label: string };
+//         };
+//     };
+// };
+
+type FormTypeMap = {
+    textInput: textInputProps;
+    select: selectProps;
+    switch: switchProps;
+    dateTime: dateTimeProps;
+    radio: never; // zatím žádné props
+};
+
+type FormTypeObject = {
+    [K in keyof FormTypeMap]: FormTypeMap[K] extends never
+    ? { type: K; props?: never }
+    : { type: K; props?: FormTypeMap[K] };
+}[keyof FormTypeMap];
+
+type formType = formTypes | FormTypeObject;
+
 type ProviderDataSourceType = {
     /**
      * Adresa pro CRUD data
@@ -16,6 +75,7 @@ type ProviderDataSourceType = {
         delete?: string;
         // updates?: { [key: string]: string };
     };
+    dataProvider?: string;
     /**
      * Prime zadani pole dat
      * */
@@ -29,7 +89,7 @@ type ProviderDataSourceType = {
      * Nacist vsechny pole bez ohledu na schema
      */
     readAllFields?: boolean;
-    filter?: FilterType$1;
+    filter?: filterType;
     /**
      * Nazvy naslouchajicich socketu
      */
@@ -41,9 +101,6 @@ type DataProviderActionType = "create" | "update" | "delete";
 //TODO: Rule type
 type RuleType = {};
 
-//TODO: Filter type
-type FilterType$1 = {};
-
 type ProviderEditorType = {
     title?: string;
     /**
@@ -64,23 +121,24 @@ type ProviderLayoutType = {
     variant?: "grouped" | "insetGrouped" | "plain";
     tooltip?: string | React.ReactNode;
     sections?: {
-        id: string;
+        id?: string;
         title?: string;
         description?: string;
         footer?: string;
         tooltip?: string | React.ReactNode;
-        visible?: boolean | JsonFilter;
+        visible?: boolean | filterType;
         items: Array<{
             field: string;
-            form?: "textInput" | "select" | "switch" | "dateTime";
+            form?: formType;
             label?: string; // jen override
-            visible?: boolean | JsonFilter;
+            visible?: boolean | filterType;
             tooltip?: string | React.ReactNode;
         }>;
     }[];
 };
+type ProviderLayoutsType = { [key: string]: ProviderLayoutType };
 
-type ProviderSchemaItemType = {
+type BasicProviderSchemaItemType = {
     /**
      * Zdrojove pole pro hodnotu (např. "name" nebo "price"). Pokud není uvedeno, očekává se, že hodnota bude přímo v kořenovém objektu.
      */
@@ -89,44 +147,28 @@ type ProviderSchemaItemType = {
      * Výchozí hodnota pole, která se použije, pokud není poskytnuta žádná jiná hodnota. Může být typu string, number, boolean nebo jiného vhodného typu v závislosti na kontextu použití.
      */
     default?: any;
+}
+
+type ProviderSchemaItemType = BasicProviderSchemaItemType & {
+    /** Typ hodnoty */
+    type?: "string" | "number" | "date" | "boolean";
     /**
      * Povolene hodnoty
      *
      */
     enum?: any[];
     /**
-     * Je pole vyžadováno pri editaci?
+     * Je pole vyžadováno pro model ( pri create nebo pri update )?
      */
     required?: boolean;
-    /**
-     * Je pole pri editaci viditelné?
-     */
-    visibility?: "hidden" | "visible";
     /**
      * Polozku lze editovat
      */
     editable?: boolean | RuleType;
-    type?: "string" | "number" | "date" | "boolean";
-    form?: "textInput" | "select" | "switch" | "dateTime" | "radio";
-    multiple?: boolean;
-    mode?: "screen";
-    title?: string;
-    placeholder?: string;
-    // Pro select a radio
-    options?: { value: any; label?: string, icon?: string }[] | {
-        dataProvider: ProviderTypes;
-        optionKeys?: { value: string; label: LabelProps | { title: string; icon: string } };
-        filter?: string | RuleType;
-    };
+    form?: formType;
+    label?: string;
     description?: string;
-    /** TODO: Divna definice labelu */
-    optionKeys?: { value: string; label: LabelProps | { title: string; icon: string } };
     validations?: ValidationType;
-    /**
-     * Text input nezobrazuje znaky
-     */
-    secure?: boolean;
-    hidden?: boolean;
 };
 
 type DataProviderType = {
@@ -150,7 +192,26 @@ type DataProviderType = {
     autoCreate?: boolean;
     schema?: { [key: string]: ProviderSchemaItemType };
     editor?: ProviderEditorType;
-    layout?: ProviderLayoutType;
+    /**
+     * Rozvržení pro zobrazení dat (např. v tabulce, formuláři atd.). 
+     * Může být jedno pro všechny stavy ("default") nebo specifické pro každý stav ("edit", "preview").
+     * Lze vytvořit i vlastní stavy (např. "compact", "detailed") a přiřadit jim specifické rozvržení.
+     * 
+     * @example
+     * layout: {
+     *   default: { ... }, // rozvržení pro všechny stavy
+     *   edit: { ... },    // rozvržení pro stav "edit"
+     *   preview: { ... }, // rozvržení pro stav "preview"
+     *   compact: { ... }  // vlastní stav "compact"
+     * }
+     * 
+     * Form vyzaduje rozvržení pro stav "edit" a pro náhled používá rozvržení "preview". Pokud je aktuální stav "compact", použije se rozvržení "compact". Pokud není rozvržení pro aktuální stav definováno, použije se rozvržení "default".
+     * 
+     * Pokud není uvedeno, použije se rozvržení "default" pro všechny stavy.
+     * Pokud je uvedeno pouze rozvržení pro specifické stavy (např. "edit", "preview"), ale není uvedeno "default", pak se pro ostatní stavy použije první definované rozvržení.    
+     */
+    layout?: ProviderLayoutsType;
+    // layouts?: ProviderLayoutsType;
     /**
      * Jake akce jsou povolene pro dataSource. Pokud neni uvedeno, jsou povolene vsechny
      */
@@ -392,35 +453,11 @@ interface UseDataProviderResult {
     /** Vytvoří novou položku providera. */
     createItem: (data: JSONType, callback?: (value: JSONType) => void) => Promise<JSONType>;
 }
-/**
- * Zaregistruje/zpřístupní providera a vrátí normalizované dokumenty spolu s CRUD helpery.
- *
- * @param id Provider id nebo inline definice providera.
- * @param params Parametry šablony používané při renderu URI/definice.
- * @param dataFilter Volitelný client-side filtr dokumentů providera.
- * @param settings Volitelný závislý dokument použitý pro přepočet dat.
- */
-declare const useDataProvider: (
-/**
- * Provider id nebo objekt data {key: value}
- */
-id: string | {
+declare const useDataProvider: (id: string | {
     [key: string]: any;
-} | false, 
-/**
- * Parametry pro prerenderovani providera (profiles/<%= profileId %>)
- */
-params?: {
+} | false, params?: {
     [key: string]: string;
-} | null, 
-/**
- * Filtrovani dat
- */
-dataFilter?: JSONType | null, 
-/**
- * Nejake nastaveni
- */
-settings?: {
+} | null, dataFilter?: filterType | null, settings?: {
     documentId?: string;
     document?: JSONType;
 }) => UseDataProviderResult;

package/dist/index.d.ts

@@ -1,6 +1,65 @@
 import React$1, { ReactNode } from 'react';
+import { filterType } from '@mgarlik/json-filter';
 import { D as DataStoreStorage } from './storage-D_xv8gFb.js';
 
+type formTypes = "textInput" | "select" | "switch" | "dateTime" | "radio";
+
+type textInputProps = {
+    placeholder?: string;
+    multiline?: boolean;
+    numberOfLines?: number;
+    secure: boolean;
+};
+
+type switchProps = {
+    thumbColor?: string;
+    trackColor?: { true: string; false: string };
+};
+
+type dateTimeProps = {
+    mode: "date" | "time" | "datetime";
+};
+
+type DataSourceOptions = {
+    dataProvider: string;
+    filter?: filterType;
+    map: Record<string, string>;
+};
+
+type selectProps = {
+    multiple?: boolean;
+    options?:
+    | Array<{ value: string | number; label: string }>
+    | { dataSource: DataSourceOptions };
+};
+
+// type selectProps = {
+//     multiple?: boolean;
+//     options?:
+//     Array<{ value: string | number; label: string }>
+//     | {
+//         dataSource: ProviderDataSourceType & {
+//             map: { value: string; label: string };
+//         };
+//     };
+// };
+
+type FormTypeMap = {
+    textInput: textInputProps;
+    select: selectProps;
+    switch: switchProps;
+    dateTime: dateTimeProps;
+    radio: never; // zatím žádné props
+};
+
+type FormTypeObject = {
+    [K in keyof FormTypeMap]: FormTypeMap[K] extends never
+    ? { type: K; props?: never }
+    : { type: K; props?: FormTypeMap[K] };
+}[keyof FormTypeMap];
+
+type formType = formTypes | FormTypeObject;
+
 type ProviderDataSourceType = {
     /**
      * Adresa pro CRUD data
@@ -16,6 +75,7 @@ type ProviderDataSourceType = {
         delete?: string;
         // updates?: { [key: string]: string };
     };
+    dataProvider?: string;
     /**
      * Prime zadani pole dat
      * */
@@ -29,7 +89,7 @@ type ProviderDataSourceType = {
      * Nacist vsechny pole bez ohledu na schema
      */
     readAllFields?: boolean;
-    filter?: FilterType$1;
+    filter?: filterType;
     /**
      * Nazvy naslouchajicich socketu
      */
@@ -41,9 +101,6 @@ type DataProviderActionType = "create" | "update" | "delete";
 //TODO: Rule type
 type RuleType = {};
 
-//TODO: Filter type
-type FilterType$1 = {};
-
 type ProviderEditorType = {
     title?: string;
     /**
@@ -64,23 +121,24 @@ type ProviderLayoutType = {
     variant?: "grouped" | "insetGrouped" | "plain";
     tooltip?: string | React.ReactNode;
     sections?: {
-        id: string;
+        id?: string;
         title?: string;
         description?: string;
         footer?: string;
         tooltip?: string | React.ReactNode;
-        visible?: boolean | JsonFilter;
+        visible?: boolean | filterType;
         items: Array<{
             field: string;
-            form?: "textInput" | "select" | "switch" | "dateTime";
+            form?: formType;
             label?: string; // jen override
-            visible?: boolean | JsonFilter;
+            visible?: boolean | filterType;
             tooltip?: string | React.ReactNode;
         }>;
     }[];
 };
+type ProviderLayoutsType = { [key: string]: ProviderLayoutType };
 
-type ProviderSchemaItemType = {
+type BasicProviderSchemaItemType = {
     /**
      * Zdrojove pole pro hodnotu (např. "name" nebo "price"). Pokud není uvedeno, očekává se, že hodnota bude přímo v kořenovém objektu.
      */
@@ -89,44 +147,28 @@ type ProviderSchemaItemType = {
      * Výchozí hodnota pole, která se použije, pokud není poskytnuta žádná jiná hodnota. Může být typu string, number, boolean nebo jiného vhodného typu v závislosti na kontextu použití.
      */
     default?: any;
+}
+
+type ProviderSchemaItemType = BasicProviderSchemaItemType & {
+    /** Typ hodnoty */
+    type?: "string" | "number" | "date" | "boolean";
     /**
      * Povolene hodnoty
      *
      */
     enum?: any[];
     /**
-     * Je pole vyžadováno pri editaci?
+     * Je pole vyžadováno pro model ( pri create nebo pri update )?
      */
     required?: boolean;
-    /**
-     * Je pole pri editaci viditelné?
-     */
-    visibility?: "hidden" | "visible";
     /**
      * Polozku lze editovat
      */
     editable?: boolean | RuleType;
-    type?: "string" | "number" | "date" | "boolean";
-    form?: "textInput" | "select" | "switch" | "dateTime" | "radio";
-    multiple?: boolean;
-    mode?: "screen";
-    title?: string;
-    placeholder?: string;
-    // Pro select a radio
-    options?: { value: any; label?: string, icon?: string }[] | {
-        dataProvider: ProviderTypes;
-        optionKeys?: { value: string; label: LabelProps | { title: string; icon: string } };
-        filter?: string | RuleType;
-    };
+    form?: formType;
+    label?: string;
     description?: string;
-    /** TODO: Divna definice labelu */
-    optionKeys?: { value: string; label: LabelProps | { title: string; icon: string } };
     validations?: ValidationType;
-    /**
-     * Text input nezobrazuje znaky
-     */
-    secure?: boolean;
-    hidden?: boolean;
 };
 
 type DataProviderType = {
@@ -150,7 +192,26 @@ type DataProviderType = {
     autoCreate?: boolean;
     schema?: { [key: string]: ProviderSchemaItemType };
     editor?: ProviderEditorType;
-    layout?: ProviderLayoutType;
+    /**
+     * Rozvržení pro zobrazení dat (např. v tabulce, formuláři atd.). 
+     * Může být jedno pro všechny stavy ("default") nebo specifické pro každý stav ("edit", "preview").
+     * Lze vytvořit i vlastní stavy (např. "compact", "detailed") a přiřadit jim specifické rozvržení.
+     * 
+     * @example
+     * layout: {
+     *   default: { ... }, // rozvržení pro všechny stavy
+     *   edit: { ... },    // rozvržení pro stav "edit"
+     *   preview: { ... }, // rozvržení pro stav "preview"
+     *   compact: { ... }  // vlastní stav "compact"
+     * }
+     * 
+     * Form vyzaduje rozvržení pro stav "edit" a pro náhled používá rozvržení "preview". Pokud je aktuální stav "compact", použije se rozvržení "compact". Pokud není rozvržení pro aktuální stav definováno, použije se rozvržení "default".
+     * 
+     * Pokud není uvedeno, použije se rozvržení "default" pro všechny stavy.
+     * Pokud je uvedeno pouze rozvržení pro specifické stavy (např. "edit", "preview"), ale není uvedeno "default", pak se pro ostatní stavy použije první definované rozvržení.    
+     */
+    layout?: ProviderLayoutsType;
+    // layouts?: ProviderLayoutsType;
     /**
      * Jake akce jsou povolene pro dataSource. Pokud neni uvedeno, jsou povolene vsechny
      */
@@ -392,35 +453,11 @@ interface UseDataProviderResult {
     /** Vytvoří novou položku providera. */
     createItem: (data: JSONType, callback?: (value: JSONType) => void) => Promise<JSONType>;
 }
-/**
- * Zaregistruje/zpřístupní providera a vrátí normalizované dokumenty spolu s CRUD helpery.
- *
- * @param id Provider id nebo inline definice providera.
- * @param params Parametry šablony používané při renderu URI/definice.
- * @param dataFilter Volitelný client-side filtr dokumentů providera.
- * @param settings Volitelný závislý dokument použitý pro přepočet dat.
- */
-declare const useDataProvider: (
-/**
- * Provider id nebo objekt data {key: value}
- */
-id: string | {
+declare const useDataProvider: (id: string | {
     [key: string]: any;
-} | false, 
-/**
- * Parametry pro prerenderovani providera (profiles/<%= profileId %>)
- */
-params?: {
+} | false, params?: {
     [key: string]: string;
-} | null, 
-/**
- * Filtrovani dat
- */
-dataFilter?: JSONType | null, 
-/**
- * Nejake nastaveni
- */
-settings?: {
+} | null, dataFilter?: filterType | null, settings?: {
     documentId?: string;
     document?: JSONType;
 }) => UseDataProviderResult;