@myrmidon/paged-data-browsers 4.0.1 → 5.0.0

package/lib/components/range-view/range-view.component.d.ts

@@ -1,23 +0,0 @@
-import * as i0 from "@angular/core";
-export declare class RangeViewComponent {
-    /**
-     * The domain of the range view (start, limit).
-     */
-    domain: import("@angular/core").InputSignal<number[]>;
-    /**
-     * The range of the range view (start, limit).
-     */
-    range: import("@angular/core").InputSignal<number[]>;
-    /**
-     * The width of the component.
-     */
-    width: import("@angular/core").InputSignal<number>;
-    /**
-     * The height of the component.
-     */
-    height: import("@angular/core").InputSignal<number>;
-    scaledRange: import("@angular/core").Signal<number[]>;
-    constructor();
-    static ɵfac: i0.ɵɵFactoryDeclaration<RangeViewComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<RangeViewComponent, "pdb-range-view", never, { "domain": { "alias": "domain"; "required": false; "isSignal": true; }; "range": { "alias": "range"; "required": false; "isSignal": true; }; "width": { "alias": "width"; "required": false; "isSignal": true; }; "height": { "alias": "height"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
-}

package/lib/services/lru-cache.d.ts

@@ -1,59 +0,0 @@
-/**
- * A Least Recently Used cache that can be used to store any type of object.
- * The cache works in two modes: considering the size of the objects or not.
- * If the size is considered, the cache will have a maximum size and will
- * remove the oldest objects when the maximum size is reached. Note that
- * the size is only roughly estimated. This avoids removing too many
- * entries from the cache when the maximum is reached.
- * If the size is not considered, the cache will have a maximum number of
- * objects and will remove the oldest objects when the maximum number is
- * reached.
- */
-export declare class LRUCache<T> {
-    private _maxSize;
-    private _totalSize;
-    private _considerSize;
-    private _cache;
-    private _sizes;
-    /**
-     * Creates a new cache.
-     * @param maxSize The maximum size of the cache. This is either
-     * the maximum number of items in the cache (when considerSize
-     * is false) or the maximum total size of all items in the
-     * cache in bytes (when considerSize is true).
-     * @param considerSize True if the size of the objects should be
-     * considered.
-     */
-    constructor(maxSize: number, considerSize?: boolean);
-    /**
-     * Get an item from the cache.
-     * @param key The key of the item to get.
-     * @returns The item or undefined if the item is not in the cache.
-     */
-    get(key: string): T | undefined;
-    /**
-     * Check if an item is in the cache.
-     * @param key The key of the item to check.
-     * @returns True if the item is in cache.
-     */
-    has(key: string): boolean;
-    /**
-     * Put an item in the cache.
-     * @param key The key of the item to put.
-     * @param item The item to put.
-     * @param size The estimated size of the item in bytes.
-     * This must be calculated by the caller but only when
-     * considerSize is true.
-     */
-    put(key: string, item: T, size: number): void;
-    /**
-     * Clear the cache.
-     */
-    clear(): void;
-    /**
-     * Estimate the size of an object in bytes.
-     * @param obj The object to calculate the size of.
-     * @returns The estimated size of the object in bytes.
-     */
-    static calculateObjectSize(obj: any): number;
-}

package/lib/services/paged-list.store.d.ts

@@ -1,133 +0,0 @@
-import { Observable } from 'rxjs';
-import { DataPage } from '@myrmidon/ngx-tools';
-/**
- * Options for the paged list store.
- */
-export interface PagedListStoreOptions {
-    /**
-     * The size of pages in the store.
-     */
-    pageSize: number;
-    /**
-     * The size of the cache for pages in the store.
-     */
-    cacheSize: number;
-    /**
-     * A custom function for building the cache key for the given page number
-     * and filter.
-     * @param pageNumber The page number.
-     * @param filter The filter.
-     * @returns A string to be used as cache key.
-     */
-    buildCacheKey?: (pageNumber: number, filter: any) => string;
-}
-/**
- * Default options for the paged list store.
- */
-export declare const DEFAULT_PAGED_LIST_STORE_OPTIONS: PagedListStoreOptions;
-/**
- * The interface to be implemented by the service used by PagedListStore.
- */
-export interface PagedListStoreService<F, E> {
-    /**
-     * Load the page with the given number.
-     * @param pageNumber The page number to load.
-     * @param pageSize The size of the page to load.
-     * @param filter The filter to apply.
-     */
-    loadPage(pageNumber: number, pageSize: number, filter: F): Observable<DataPage<E>>;
-}
-/**
- * A generic paged list store using a filter object of type F
- * and a list of elements of type E.
- */
-export declare class PagedListStore<F, E> {
-    private _service;
-    private _pageSize;
-    private readonly _customCacheKeyBuilder?;
-    private _page$;
-    private _filter$;
-    private readonly _cache;
-    /**
-     * The page. It is updated when the page is changed or the filter is changed.
-     */
-    page$: Observable<Readonly<DataPage<E>>>;
-    /**
-     * The filter. It is updated when the filter is changed.
-     */
-    filter$: Observable<Readonly<F>>;
-    /**
-     * The size of nodes pages in this store. If you change it, the store
-     * is reset. The default value is 20.
-     */
-    get pageSize(): number;
-    set pageSize(value: number);
-    /**
-     * Create a new paged list store.
-     * @param options Options for the paged list store.
-     */
-    constructor(_service: PagedListStoreService<F, E>, options?: PagedListStoreOptions);
-    /**
-     * Returns true if the store is empty, false otherwise.
-     * @returns true if the store is empty, false otherwise.
-     */
-    isEmpty(): boolean;
-    /**
-     * Build the cache key for the given page number and filter.
-     * The default implementation just returns a stringified object
-     * containing the page number and the filter. You may override
-     * this method to provide a custom cache key.
-     * @param pageNumber The page number.
-     * @param filter The filter.
-     * @returns A string to be used as cache key.
-     */
-    buildCacheKey(pageNumber: number, filter: F): string;
-    /**
-     * Load the page with the given number.
-     * @param pageNumber the page number to load.
-     */
-    private loadPage;
-    /**
-     * Set the page with the given number.
-     * @param pageNumber The page number to load.
-     * @param pageSize The page size.
-     * @returns Promise which resolves when the page is loaded.
-     */
-    setPage(pageNumber: number, pageSize?: number): Promise<void>;
-    /**
-     * Get the current page.
-     * @returns The current page.
-     */
-    getPage(): DataPage<E>;
-    /**
-     * Apply the given filter and load the first page.
-     * @param filter The filter to apply.
-     * @returns Promise which resolves when the page is loaded.
-     */
-    setFilter(filter: F): Promise<void>;
-    /**
-     * Get the current filter.
-     * @returns The current filter.
-     */
-    getFilter(): F;
-    /**
-     * Reset the filter and load the first page. The cache is cleared.
-     * @returns Promise which resolves when the page is loaded.
-     */
-    reset(): Promise<void>;
-    /**
-     * Clear the store. The cache is cleared and the page is emptied.
-     */
-    clear(): void;
-    /**
-     * Clear the cache.
-     */
-    clearCache(): void;
-    /**
-     * Check if the page with the given number and filter is in cache.
-     * @param pageNumber The page number.
-     * @param filter The filter.
-     * @returns True if the page is in cache, false otherwise.
-     */
-    hasCachedPage(pageNumber: number, filter: F): boolean;
-}

package/lib/services/paged-tree.store.d.ts

@@ -1,242 +0,0 @@
-import { Observable } from 'rxjs';
-import { DataPage } from '@myrmidon/ngx-tools';
-/**
- * A tree node. Your data service should return a list of these nodes
- * or of any type extending this interface.
- */
-export interface TreeNode {
-    id: number;
-    parentId?: number;
-    y: number;
-    x: number;
-    label: string;
-    tag?: string;
-    hasChildren?: boolean;
-}
-/**
- * A filter for tree nodes.
- */
-export interface TreeNodeFilter {
-    tags?: string[];
-    parentId?: number;
-}
-/**
- * Paging information for a paged tree node.
- */
-export interface PagingInfo {
-    pageNumber: number;
-    pageCount: number;
-    total: number;
-}
-/**
- * A tree node with paging information, used in NodeBrowserStore.
- */
-export interface PagedTreeNode<F extends TreeNodeFilter> extends TreeNode {
-    paging: PagingInfo;
-    expanded?: boolean;
-    filter?: F;
-}
-/**
- * The interface to be implemented by the service used by NodeBrowserStore
- * to load nodes.
- */
-export interface PagedTreeStoreService<F extends TreeNodeFilter> {
-    /**
-     * Get the specified page of nodes.
-     * @param filter The filter.
-     * @param pageNumber The page number.
-     * @param pageSize The page size.
-     * @param hasMockRoot If true, the root node is a mock node provided by your
-     * service, which implies that its Y value is 0 rather than 1. Default is
-     * false, meaning that your service will return a single root node with Y
-     * value 1.
-     */
-    getNodes(filter: F, pageNumber: number, pageSize: number, hasMockRoot?: boolean): Observable<DataPage<TreeNode>>;
-}
-/**
- * Options for the NodeBrowserStore.
- */
-export interface PagedTreeStoreOptions {
-    /**
-     * The size of pages in the store.
-     */
-    pageSize: number;
-    /**
-     * The size of the cache for pages in the store.
-     */
-    cacheSize: number;
-    /**
-     * A custom function for building the cache key for the given page number
-     * and filter.
-     * @param pageNumber The page number.
-     * @param filter The filter.
-     * @returns A string to be used as cache key.
-     */
-    buildCacheKey?: (pageNumber: number, filter: any) => string;
-    /**
-     * If true, the root node is a mock node provided by your service, which
-     * implies that its Y value is 0 rather than 1. Default is false, meaning
-     * that there are many root-level nodes, all with parent ID = undefined.
-     */
-    hasMockRoot?: boolean;
-}
-/**
- * A store for the node browser component. This store is used to keep a
- * list of nodes, and to load them from the API. It also keeps the root
- * node. Every tree node in the list is extended with page number,
- * page count and total items, plus expansion-related metadata.
- * The store keeps a flat list of these tree nodes, allowing users to
- * expand and collapse them.
- * F is the type of the filter object, E is the type of the paged tree nodes.
- */
-export declare class PagedTreeStore<E extends PagedTreeNode<F>, F extends TreeNodeFilter> {
-    private _service;
-    private _nodes$;
-    private _filter$;
-    private readonly _customCacheKeyBuilder?;
-    private readonly _cache;
-    private readonly _hasMockRoot;
-    private _pageSize;
-    private _dirty?;
-    /**
-     * The flat list of paged nodes in this store.
-     */
-    nodes$: Observable<Readonly<E[]>>;
-    /**
-     * The global filter for all the nodes.
-     */
-    filter$: Observable<Readonly<F>>;
-    /**
-     * The size of nodes pages in this store. If you change it, the store
-     * is reset. The default value is 20.
-     */
-    get pageSize(): number;
-    set pageSize(value: number);
-    /**
-     * Create an instance of the store.
-     * @param _service The service used to load nodes.
-     * @param options The options to configure this store.
-     */
-    constructor(_service: PagedTreeStoreService<F>, options?: PagedTreeStoreOptions);
-    /**
-     * Gets the global filter, eventually overridden with values
-     * from the specified node's filter.
-     * @param node The optional node.
-     * @returns The filter.
-     */
-    private getFilter;
-    /**
-     * Checks if this store is empty.
-     * @returns True if this store is empty.
-     */
-    isEmpty(): boolean;
-    /**
-     * Gets all the nodes in the store.
-     * @returns The nodes.
-     */
-    getNodes(): Readonly<PagedTreeNode<F>[]>;
-    /**
-     * Get the root node of the tree.
-     * @returns The root node of the tree or undefined if empty.
-     */
-    getRootNode(): PagedTreeNode<F> | undefined;
-    /**
-     * Build the cache key for the given page number and filter.
-     * The default implementation just returns a stringified object
-     * containing the page number and the filter. You may override
-     * this method to provide a custom cache key.
-     * @param pageNumber The page number.
-     * @param filter The filter.
-     * @returns A string to be used as cache key.
-     */
-    buildCacheKey(pageNumber: number, filter: F): string;
-    /**
-     * Get the specified page of nodes, either from cache or from the server.
-     * When the page is retrieved from the server, it is stored in cache.
-     * @param filter The filter to apply.
-     * @param pageNumber The page number to get.
-     * @returns Observable of the page of nodes.
-     */
-    private getPageFromCacheOrServer;
-    /**
-     * Create paged tree nodes from a page of tree nodes, by providing further
-     * metadata like page number, page count and total items.
-     * @param page The page to create nodes from.
-     * @returns Paged nodes.
-     */
-    private createPageNodes;
-    /**
-     * Sets the filter for this store. Whenever the filter is set,
-     * the store is reset.
-     * @param filter The filter.
-     * @returns true if tree was changed, false otherwise.
-     */
-    setFilter(filter: F): Promise<boolean>;
-    /**
-     * Reset the store, loading the root nodes and their children.
-     * @returns true if tree was changed, false otherwise.
-     */
-    reset(): Promise<boolean>;
-    /**
-     * Set the node filter for the node with the specified ID.
-     * @param id The node ID.
-     * @param filter The filter to set.
-     * @returns Promise with true if filter was set, false otherwise.
-     */
-    setNodeFilter(id: number, filter?: F | null): Promise<boolean>;
-    /**
-     * Expand the node with the specified ID. If the node is not expandable,
-     * or it is already expanded, this method does nothing.
-     * @param node The ID of the node to expand.
-     * @returns Promise with true if the node was expanded, false otherwise.
-     */
-    expand(id: number): Promise<boolean>;
-    /**
-     * Expand all the descendants of the node with the specified ID.
-     *
-     * @param id The ID of the node to expand, or undefined to expand the
-     * descendants of all the root level nodes.
-     * @returns Promise.
-     */
-    expandAll(id?: number): Promise<boolean>;
-    getChildren(id: number): E[];
-    private removeDescendants;
-    /**
-     * Collapse the node with the specified ID. If the node is not expandable,
-     * or it is already collapsed, this method does nothing.
-     * @param node The node to collapse.
-     * @returns Promise with true if the node was collapsed, false otherwise.
-     */
-    collapse(id: number): Promise<boolean>;
-    /**
-     * Collapse all the descendants of the node with the specified ID.
-     *
-     * @param id The ID of the node to collapse, or undefined to collapse the
-     * descendants of all the root level nodes.
-     * @returns Promise.
-     */
-    collapseAll(id?: number): Promise<boolean>;
-    /**
-     * Change the page including the node with the specified ID.
-     * @param parentId The ID of the parent node whose children are inside the page
-     * you want to change.
-     * @param pageNumber The new page number.
-     * @returns Promise with true if the page was changed, false otherwise.
-     */
-    changePage(parentId: number, pageNumber: number): Promise<boolean>;
-    /**
-     * Clear the store. The cache is cleared and the nodes are removed.
-     */
-    clear(): void;
-    /**
-     * Clear the cache.
-     */
-    clearCache(): void;
-    /**
-     * Check if the page with the given number and filter is in cache.
-     * @param pageNumber The page number.
-     * @param filter The filter.
-     * @returns True if the page is in cache, false otherwise.
-     */
-    hasCachedPage(pageNumber: number, filter: F): boolean;
-}

package/public-api.d.ts

@@ -1,6 +0,0 @@
-export * from './lib/components/compact-pager/compact-pager.component';
-export * from './lib/components/range-view/range-view.component';
-export * from './lib/components/browser-tree-node/browser-tree-node.component';
-export * from './lib/services/paged-list.store';
-export * from './lib/services/paged-tree.store';
-export * from './lib/services/lru-cache';