@katlux/providers 0.1.1-alpha.101 → 0.1.1-alpha.103

package/dist/index.d.cts

@@ -47,7 +47,8 @@ declare enum EDataFilterOperator {
 }
 declare enum ECacheStrategy {
     Application = "Application",
-    Session = "Session",
+    ServerSession = "ServerSession",
+    BrowserSession = "BrowserSession",
     Memory = "Memory",
     LocalStorage = "LocalStorage",
     IndexedDB = "IndexedDB",
@@ -150,6 +151,8 @@ interface IDataProviderOptions {
     contextKey?: string;
     urlPageParam?: string;
     refreshOnMutation?: boolean;
+    filterDebounce?: number;
+    sortDebounce?: number;
 }
 
 interface ITreeNode<TRow = TDataRow> {
@@ -293,7 +296,7 @@ declare abstract class ADataProvider<TRow = TDataRow> {
         selectedRows: TRow[];
         selectAll: boolean;
     };
-    setFilter(filter: IDataFilter | null): void;
+    setFilter(filter: IDataFilter | null, immediate?: boolean): void;
     setSortList(sortList: IDataSort[], immediate?: boolean): void;
     setCurrentPage(currentPage: number): void;
     setPageSize(pageSize: number): void;
@@ -308,10 +311,22 @@ declare abstract class ADataProvider<TRow = TDataRow> {
 }
 
 declare class CFlatClientDataProvider<TRow = TDataRow> extends ADataProvider<TRow> {
-    allData: TRow[];
+    private _allData;
     filteredData: TRow[];
+    private _rowMap;
+    private _filterDirty;
+    private _sortDirty;
     constructor(options?: IDataProviderOptions);
+    get allData(): TRow[];
+    set allData(data: TRow[]);
+    get rowMap(): readonly TRow[];
     setData(data: TRow[]): void;
+    setFilter(filter: IDataFilter | null, immediate?: boolean): void;
+    setSortList(sortList: IDataSort[], immediate?: boolean): void;
+    /**
+     * Explicitly rebuilds the reference map array if row properties inside allData were mutated in-place.
+     */
+    updateMap(): void;
     refreshData(options?: {
         disableCache?: boolean;
     }): Promise<void>;
@@ -439,7 +454,9 @@ declare class CTreeClientDataProvider<TRow extends TDataRow = TDataRow> extends
     private _staticNodesCache;
     private _nodeMapCache;
     private _sortedNodeIdsCache;
+    private _filteredNodesCache;
     invalidateStaticCache(): void;
+    setFilter(filter: IDataFilter | null, immediate?: boolean): void;
     private get _staticNodes();
     private get _nodeMap();
     private get _sortedNodeIds();
@@ -622,9 +639,9 @@ declare class CacheProviderFactory {
     static clearInstances(): void;
 }
 
-declare class CSessionCache extends ACacheProvider {
+declare class CServerSessionCache extends ACacheProvider {
     private static instance;
-    static getInstance(): CSessionCache;
+    static getInstance(): CServerSessionCache;
     static get storage(): Map<string, Map<string, ICacheEntry<any>>>;
     static getSnapshot(): Map<string, Map<string, ICacheEntry<any>>>;
     static MAX_SERVER_SESSIONS: number;
@@ -634,7 +651,6 @@ declare class CSessionCache extends ACacheProvider {
      */
     static purgeExpiredServerSessions(): void;
     private sessionIdCache;
-    private sessionId;
     private readonly SESSION_ID_KEY;
     constructor();
     /**
@@ -642,7 +658,8 @@ declare class CSessionCache extends ACacheProvider {
      */
     private generateSessionId;
     /**
-     * Get or create sessionId
+     * Get or create sessionId — server-only path.
+     * Returns '__no_session__' sentinel when no isolatable H3 event context is available.
      */
     private getSessionId;
     getKeyList(context?: any): Promise<Array<string>>;
@@ -654,6 +671,30 @@ declare class CSessionCache extends ACacheProvider {
     cleanupExpired(): Promise<void>;
 }
 
+/**
+ * CBrowserSessionCache — client-side tab-lifetime cache backed by window.sessionStorage.
+ *
+ * - Server-side: all write operations store only into the SSR context payload for hydration
+ *   transfer to the client. No server memory is allocated.
+ * - Client-side: reads and writes use window.sessionStorage exclusively.
+ * - Hydration: on the first client-side get() miss, checks the SSR payload and promotes
+ *   the entry into sessionStorage for subsequent reads.
+ *
+ * Storage key prefix: 'bscache:' (distinct from the server session 'cache:' prefix)
+ */
+declare class CBrowserSessionCache extends ACacheProvider {
+    private static instance;
+    static getInstance(): CBrowserSessionCache;
+    private readonly PREFIX;
+    getKeyList(_context?: any): Promise<string[]>;
+    get<T>(key: string, context?: any): Promise<T | null>;
+    set<T>(key: string, data: T, lifetime: number, context?: any): Promise<void>;
+    remove(key: string, _context?: any): Promise<void>;
+    removeByPrefix(prefix: string, _context?: any): Promise<void>;
+    getRemainingTime(key: string, _context?: any): Promise<number | null>;
+    cleanupExpired(_context?: any): Promise<void>;
+}
+
 declare class CCookieCache extends ACacheProvider {
     private static instance;
     static getInstance(): CCookieCache;
@@ -1046,5 +1087,5 @@ declare function getAppRouter(): any;
  */
 declare function onPlatformReady(cb: () => void): void;
 
-export { AAPIDataProvider, ADataProvider, CAPIFlatClientDataProvider, CAPIFlatServerDataProvider, CAPITreeClientDataProvider, CAPITreeServerDataProvider, CApplicationCache, CCookieCache, CFlatClientDataProvider, CFlatServerDataProvider, CIndexedDBCache, CLocalStorageCache, CMemoryCache, CSessionCache, CTreeClientDataProvider, CTreeServerDataProvider, CacheProviderFactory, DefaultHydrationAdapter, ECacheStrategy, EDataFilterOperator, EQueueStorage, KatluxIndexedDB, QueueStorageFactory, RequestProvider, RequestProviderRegistry, RequestQueue, SENSITIVE_HEADER_KEYS, applyOperator, clearSSRData, compareAnd, compareEqual, compareIn, compareOr, compareValues, debounce, evaluateFilter, fetchWithSSR, filterData, filterTreeData, getAppRoute, getAppRouter, getHydrationAdapter, getPlatformApp, getSSRData, getSSRPayload, onPlatformReady, setHydrationAdapter, sortData, useDebounce, useFilterLogic, useSortLogic };
+export { AAPIDataProvider, ADataProvider, CAPIFlatClientDataProvider, CAPIFlatServerDataProvider, CAPITreeClientDataProvider, CAPITreeServerDataProvider, CApplicationCache, CBrowserSessionCache, CCookieCache, CFlatClientDataProvider, CFlatServerDataProvider, CIndexedDBCache, CLocalStorageCache, CMemoryCache, CServerSessionCache, CTreeClientDataProvider, CTreeServerDataProvider, CacheProviderFactory, DefaultHydrationAdapter, ECacheStrategy, EDataFilterOperator, EQueueStorage, KatluxIndexedDB, QueueStorageFactory, RequestProvider, RequestProviderRegistry, RequestQueue, SENSITIVE_HEADER_KEYS, applyOperator, clearSSRData, compareAnd, compareEqual, compareIn, compareOr, compareValues, debounce, evaluateFilter, fetchWithSSR, filterData, filterTreeData, getAppRoute, getAppRouter, getHydrationAdapter, getPlatformApp, getSSRData, getSSRPayload, onPlatformReady, setHydrationAdapter, sortData, useDebounce, useFilterLogic, useSortLogic };
 export type { CacheDriverLoader, ICacheEntry, IDataFilter, IDataProviderOptions, IDataResult, IDataSort, IDeadLetterItem, IDebouncedFunction, IFlushOptions, IKDatatableAction, IPlatformRouter, IQueueStorageAdapter, IQueuedOperation, IRequestOptions, ISSRHydrationAdapter, ITreeDataProvider, ITreeDataProviderOptions, ITreeNode, ITreeNodeStatic, KProductItemData, KProductRowAction, TDataProviderListener, TDataRow, TKatluxStore, TPageDataHandler, TQueueItemStatus, TTreePageDataHandler, TTreeRow, TUnsubscribe, TreePaginationMode };

package/dist/index.d.mts

@@ -47,7 +47,8 @@ declare enum EDataFilterOperator {
 }
 declare enum ECacheStrategy {
     Application = "Application",
-    Session = "Session",
+    ServerSession = "ServerSession",
+    BrowserSession = "BrowserSession",
     Memory = "Memory",
     LocalStorage = "LocalStorage",
     IndexedDB = "IndexedDB",
@@ -150,6 +151,8 @@ interface IDataProviderOptions {
     contextKey?: string;
     urlPageParam?: string;
     refreshOnMutation?: boolean;
+    filterDebounce?: number;
+    sortDebounce?: number;
 }
 
 interface ITreeNode<TRow = TDataRow> {
@@ -293,7 +296,7 @@ declare abstract class ADataProvider<TRow = TDataRow> {
         selectedRows: TRow[];
         selectAll: boolean;
     };
-    setFilter(filter: IDataFilter | null): void;
+    setFilter(filter: IDataFilter | null, immediate?: boolean): void;
     setSortList(sortList: IDataSort[], immediate?: boolean): void;
     setCurrentPage(currentPage: number): void;
     setPageSize(pageSize: number): void;
@@ -308,10 +311,22 @@ declare abstract class ADataProvider<TRow = TDataRow> {
 }
 
 declare class CFlatClientDataProvider<TRow = TDataRow> extends ADataProvider<TRow> {
-    allData: TRow[];
+    private _allData;
     filteredData: TRow[];
+    private _rowMap;
+    private _filterDirty;
+    private _sortDirty;
     constructor(options?: IDataProviderOptions);
+    get allData(): TRow[];
+    set allData(data: TRow[]);
+    get rowMap(): readonly TRow[];
     setData(data: TRow[]): void;
+    setFilter(filter: IDataFilter | null, immediate?: boolean): void;
+    setSortList(sortList: IDataSort[], immediate?: boolean): void;
+    /**
+     * Explicitly rebuilds the reference map array if row properties inside allData were mutated in-place.
+     */
+    updateMap(): void;
     refreshData(options?: {
         disableCache?: boolean;
     }): Promise<void>;
@@ -439,7 +454,9 @@ declare class CTreeClientDataProvider<TRow extends TDataRow = TDataRow> extends
     private _staticNodesCache;
     private _nodeMapCache;
     private _sortedNodeIdsCache;
+    private _filteredNodesCache;
     invalidateStaticCache(): void;
+    setFilter(filter: IDataFilter | null, immediate?: boolean): void;
     private get _staticNodes();
     private get _nodeMap();
     private get _sortedNodeIds();
@@ -622,9 +639,9 @@ declare class CacheProviderFactory {
     static clearInstances(): void;
 }
 
-declare class CSessionCache extends ACacheProvider {
+declare class CServerSessionCache extends ACacheProvider {
     private static instance;
-    static getInstance(): CSessionCache;
+    static getInstance(): CServerSessionCache;
     static get storage(): Map<string, Map<string, ICacheEntry<any>>>;
     static getSnapshot(): Map<string, Map<string, ICacheEntry<any>>>;
     static MAX_SERVER_SESSIONS: number;
@@ -634,7 +651,6 @@ declare class CSessionCache extends ACacheProvider {
      */
     static purgeExpiredServerSessions(): void;
     private sessionIdCache;
-    private sessionId;
     private readonly SESSION_ID_KEY;
     constructor();
     /**
@@ -642,7 +658,8 @@ declare class CSessionCache extends ACacheProvider {
      */
     private generateSessionId;
     /**
-     * Get or create sessionId
+     * Get or create sessionId — server-only path.
+     * Returns '__no_session__' sentinel when no isolatable H3 event context is available.
      */
     private getSessionId;
     getKeyList(context?: any): Promise<Array<string>>;
@@ -654,6 +671,30 @@ declare class CSessionCache extends ACacheProvider {
     cleanupExpired(): Promise<void>;
 }
 
+/**
+ * CBrowserSessionCache — client-side tab-lifetime cache backed by window.sessionStorage.
+ *
+ * - Server-side: all write operations store only into the SSR context payload for hydration
+ *   transfer to the client. No server memory is allocated.
+ * - Client-side: reads and writes use window.sessionStorage exclusively.
+ * - Hydration: on the first client-side get() miss, checks the SSR payload and promotes
+ *   the entry into sessionStorage for subsequent reads.
+ *
+ * Storage key prefix: 'bscache:' (distinct from the server session 'cache:' prefix)
+ */
+declare class CBrowserSessionCache extends ACacheProvider {
+    private static instance;
+    static getInstance(): CBrowserSessionCache;
+    private readonly PREFIX;
+    getKeyList(_context?: any): Promise<string[]>;
+    get<T>(key: string, context?: any): Promise<T | null>;
+    set<T>(key: string, data: T, lifetime: number, context?: any): Promise<void>;
+    remove(key: string, _context?: any): Promise<void>;
+    removeByPrefix(prefix: string, _context?: any): Promise<void>;
+    getRemainingTime(key: string, _context?: any): Promise<number | null>;
+    cleanupExpired(_context?: any): Promise<void>;
+}
+
 declare class CCookieCache extends ACacheProvider {
     private static instance;
     static getInstance(): CCookieCache;
@@ -1046,5 +1087,5 @@ declare function getAppRouter(): any;
  */
 declare function onPlatformReady(cb: () => void): void;
 
-export { AAPIDataProvider, ADataProvider, CAPIFlatClientDataProvider, CAPIFlatServerDataProvider, CAPITreeClientDataProvider, CAPITreeServerDataProvider, CApplicationCache, CCookieCache, CFlatClientDataProvider, CFlatServerDataProvider, CIndexedDBCache, CLocalStorageCache, CMemoryCache, CSessionCache, CTreeClientDataProvider, CTreeServerDataProvider, CacheProviderFactory, DefaultHydrationAdapter, ECacheStrategy, EDataFilterOperator, EQueueStorage, KatluxIndexedDB, QueueStorageFactory, RequestProvider, RequestProviderRegistry, RequestQueue, SENSITIVE_HEADER_KEYS, applyOperator, clearSSRData, compareAnd, compareEqual, compareIn, compareOr, compareValues, debounce, evaluateFilter, fetchWithSSR, filterData, filterTreeData, getAppRoute, getAppRouter, getHydrationAdapter, getPlatformApp, getSSRData, getSSRPayload, onPlatformReady, setHydrationAdapter, sortData, useDebounce, useFilterLogic, useSortLogic };
+export { AAPIDataProvider, ADataProvider, CAPIFlatClientDataProvider, CAPIFlatServerDataProvider, CAPITreeClientDataProvider, CAPITreeServerDataProvider, CApplicationCache, CBrowserSessionCache, CCookieCache, CFlatClientDataProvider, CFlatServerDataProvider, CIndexedDBCache, CLocalStorageCache, CMemoryCache, CServerSessionCache, CTreeClientDataProvider, CTreeServerDataProvider, CacheProviderFactory, DefaultHydrationAdapter, ECacheStrategy, EDataFilterOperator, EQueueStorage, KatluxIndexedDB, QueueStorageFactory, RequestProvider, RequestProviderRegistry, RequestQueue, SENSITIVE_HEADER_KEYS, applyOperator, clearSSRData, compareAnd, compareEqual, compareIn, compareOr, compareValues, debounce, evaluateFilter, fetchWithSSR, filterData, filterTreeData, getAppRoute, getAppRouter, getHydrationAdapter, getPlatformApp, getSSRData, getSSRPayload, onPlatformReady, setHydrationAdapter, sortData, useDebounce, useFilterLogic, useSortLogic };
 export type { CacheDriverLoader, ICacheEntry, IDataFilter, IDataProviderOptions, IDataResult, IDataSort, IDeadLetterItem, IDebouncedFunction, IFlushOptions, IKDatatableAction, IPlatformRouter, IQueueStorageAdapter, IQueuedOperation, IRequestOptions, ISSRHydrationAdapter, ITreeDataProvider, ITreeDataProviderOptions, ITreeNode, ITreeNodeStatic, KProductItemData, KProductRowAction, TDataProviderListener, TDataRow, TKatluxStore, TPageDataHandler, TQueueItemStatus, TTreePageDataHandler, TTreeRow, TUnsubscribe, TreePaginationMode };

package/dist/index.d.ts

@@ -47,7 +47,8 @@ declare enum EDataFilterOperator {
 }
 declare enum ECacheStrategy {
     Application = "Application",
-    Session = "Session",
+    ServerSession = "ServerSession",
+    BrowserSession = "BrowserSession",
     Memory = "Memory",
     LocalStorage = "LocalStorage",
     IndexedDB = "IndexedDB",
@@ -150,6 +151,8 @@ interface IDataProviderOptions {
     contextKey?: string;
     urlPageParam?: string;
     refreshOnMutation?: boolean;
+    filterDebounce?: number;
+    sortDebounce?: number;
 }
 
 interface ITreeNode<TRow = TDataRow> {
@@ -293,7 +296,7 @@ declare abstract class ADataProvider<TRow = TDataRow> {
         selectedRows: TRow[];
         selectAll: boolean;
     };
-    setFilter(filter: IDataFilter | null): void;
+    setFilter(filter: IDataFilter | null, immediate?: boolean): void;
     setSortList(sortList: IDataSort[], immediate?: boolean): void;
     setCurrentPage(currentPage: number): void;
     setPageSize(pageSize: number): void;
@@ -308,10 +311,22 @@ declare abstract class ADataProvider<TRow = TDataRow> {
 }
 
 declare class CFlatClientDataProvider<TRow = TDataRow> extends ADataProvider<TRow> {
-    allData: TRow[];
+    private _allData;
     filteredData: TRow[];
+    private _rowMap;
+    private _filterDirty;
+    private _sortDirty;
     constructor(options?: IDataProviderOptions);
+    get allData(): TRow[];
+    set allData(data: TRow[]);
+    get rowMap(): readonly TRow[];
     setData(data: TRow[]): void;
+    setFilter(filter: IDataFilter | null, immediate?: boolean): void;
+    setSortList(sortList: IDataSort[], immediate?: boolean): void;
+    /**
+     * Explicitly rebuilds the reference map array if row properties inside allData were mutated in-place.
+     */
+    updateMap(): void;
     refreshData(options?: {
         disableCache?: boolean;
     }): Promise<void>;
@@ -439,7 +454,9 @@ declare class CTreeClientDataProvider<TRow extends TDataRow = TDataRow> extends
     private _staticNodesCache;
     private _nodeMapCache;
     private _sortedNodeIdsCache;
+    private _filteredNodesCache;
     invalidateStaticCache(): void;
+    setFilter(filter: IDataFilter | null, immediate?: boolean): void;
     private get _staticNodes();
     private get _nodeMap();
     private get _sortedNodeIds();
@@ -622,9 +639,9 @@ declare class CacheProviderFactory {
     static clearInstances(): void;
 }
 
-declare class CSessionCache extends ACacheProvider {
+declare class CServerSessionCache extends ACacheProvider {
     private static instance;
-    static getInstance(): CSessionCache;
+    static getInstance(): CServerSessionCache;
     static get storage(): Map<string, Map<string, ICacheEntry<any>>>;
     static getSnapshot(): Map<string, Map<string, ICacheEntry<any>>>;
     static MAX_SERVER_SESSIONS: number;
@@ -634,7 +651,6 @@ declare class CSessionCache extends ACacheProvider {
      */
     static purgeExpiredServerSessions(): void;
     private sessionIdCache;
-    private sessionId;
     private readonly SESSION_ID_KEY;
     constructor();
     /**
@@ -642,7 +658,8 @@ declare class CSessionCache extends ACacheProvider {
      */
     private generateSessionId;
     /**
-     * Get or create sessionId
+     * Get or create sessionId — server-only path.
+     * Returns '__no_session__' sentinel when no isolatable H3 event context is available.
      */
     private getSessionId;
     getKeyList(context?: any): Promise<Array<string>>;
@@ -654,6 +671,30 @@ declare class CSessionCache extends ACacheProvider {
     cleanupExpired(): Promise<void>;
 }
 
+/**
+ * CBrowserSessionCache — client-side tab-lifetime cache backed by window.sessionStorage.
+ *
+ * - Server-side: all write operations store only into the SSR context payload for hydration
+ *   transfer to the client. No server memory is allocated.
+ * - Client-side: reads and writes use window.sessionStorage exclusively.
+ * - Hydration: on the first client-side get() miss, checks the SSR payload and promotes
+ *   the entry into sessionStorage for subsequent reads.
+ *
+ * Storage key prefix: 'bscache:' (distinct from the server session 'cache:' prefix)
+ */
+declare class CBrowserSessionCache extends ACacheProvider {
+    private static instance;
+    static getInstance(): CBrowserSessionCache;
+    private readonly PREFIX;
+    getKeyList(_context?: any): Promise<string[]>;
+    get<T>(key: string, context?: any): Promise<T | null>;
+    set<T>(key: string, data: T, lifetime: number, context?: any): Promise<void>;
+    remove(key: string, _context?: any): Promise<void>;
+    removeByPrefix(prefix: string, _context?: any): Promise<void>;
+    getRemainingTime(key: string, _context?: any): Promise<number | null>;
+    cleanupExpired(_context?: any): Promise<void>;
+}
+
 declare class CCookieCache extends ACacheProvider {
     private static instance;
     static getInstance(): CCookieCache;
@@ -1046,5 +1087,5 @@ declare function getAppRouter(): any;
  */
 declare function onPlatformReady(cb: () => void): void;
 
-export { AAPIDataProvider, ADataProvider, CAPIFlatClientDataProvider, CAPIFlatServerDataProvider, CAPITreeClientDataProvider, CAPITreeServerDataProvider, CApplicationCache, CCookieCache, CFlatClientDataProvider, CFlatServerDataProvider, CIndexedDBCache, CLocalStorageCache, CMemoryCache, CSessionCache, CTreeClientDataProvider, CTreeServerDataProvider, CacheProviderFactory, DefaultHydrationAdapter, ECacheStrategy, EDataFilterOperator, EQueueStorage, KatluxIndexedDB, QueueStorageFactory, RequestProvider, RequestProviderRegistry, RequestQueue, SENSITIVE_HEADER_KEYS, applyOperator, clearSSRData, compareAnd, compareEqual, compareIn, compareOr, compareValues, debounce, evaluateFilter, fetchWithSSR, filterData, filterTreeData, getAppRoute, getAppRouter, getHydrationAdapter, getPlatformApp, getSSRData, getSSRPayload, onPlatformReady, setHydrationAdapter, sortData, useDebounce, useFilterLogic, useSortLogic };
+export { AAPIDataProvider, ADataProvider, CAPIFlatClientDataProvider, CAPIFlatServerDataProvider, CAPITreeClientDataProvider, CAPITreeServerDataProvider, CApplicationCache, CBrowserSessionCache, CCookieCache, CFlatClientDataProvider, CFlatServerDataProvider, CIndexedDBCache, CLocalStorageCache, CMemoryCache, CServerSessionCache, CTreeClientDataProvider, CTreeServerDataProvider, CacheProviderFactory, DefaultHydrationAdapter, ECacheStrategy, EDataFilterOperator, EQueueStorage, KatluxIndexedDB, QueueStorageFactory, RequestProvider, RequestProviderRegistry, RequestQueue, SENSITIVE_HEADER_KEYS, applyOperator, clearSSRData, compareAnd, compareEqual, compareIn, compareOr, compareValues, debounce, evaluateFilter, fetchWithSSR, filterData, filterTreeData, getAppRoute, getAppRouter, getHydrationAdapter, getPlatformApp, getSSRData, getSSRPayload, onPlatformReady, setHydrationAdapter, sortData, useDebounce, useFilterLogic, useSortLogic };
 export type { CacheDriverLoader, ICacheEntry, IDataFilter, IDataProviderOptions, IDataResult, IDataSort, IDeadLetterItem, IDebouncedFunction, IFlushOptions, IKDatatableAction, IPlatformRouter, IQueueStorageAdapter, IQueuedOperation, IRequestOptions, ISSRHydrationAdapter, ITreeDataProvider, ITreeDataProviderOptions, ITreeNode, ITreeNodeStatic, KProductItemData, KProductRowAction, TDataProviderListener, TDataRow, TKatluxStore, TPageDataHandler, TQueueItemStatus, TTreePageDataHandler, TTreeRow, TUnsubscribe, TreePaginationMode };