@ngrx/data 20.0.1 → 21.0.0-beta.0

package/src/selectors/entity-selectors.d.ts

@@ -1,117 +0,0 @@
-import { MemoizedSelector } from '@ngrx/store';
-import { Selector } from '@ngrx/store';
-import { Dictionary } from '@ngrx/entity';
-import { EntityCache } from '../reducers/entity-cache';
-import { EntityCacheSelector } from './entity-cache-selector';
-import { EntityCollection, ChangeStateMap } from '../reducers/entity-collection';
-import { EntityCollectionCreator } from '../reducers/entity-collection-creator';
-import { EntityMetadata } from '../entity-metadata/entity-metadata';
-import * as i0 from "@angular/core";
-/**
- * The selector functions for entity collection members,
- * Selects from the entity collection to the collection member
- * Contrast with {EntitySelectors}.
- */
-export interface CollectionSelectors<T> {
-    readonly [selector: string]: any;
-    /** Count of entities in the cached collection. */
-    readonly selectCount: Selector<EntityCollection<T>, number>;
-    /** All entities in the cached collection. */
-    readonly selectEntities: Selector<EntityCollection<T>, T[]>;
-    /** Map of entity keys to entities */
-    readonly selectEntityMap: Selector<EntityCollection<T>, Dictionary<T>>;
-    /** Filter pattern applied by the entity collection's filter function */
-    readonly selectFilter: Selector<EntityCollection<T>, string>;
-    /** Entities in the cached collection that pass the filter function */
-    readonly selectFilteredEntities: Selector<EntityCollection<T>, T[]>;
-    /** Keys of the cached collection, in the collection's native sort order */
-    readonly selectKeys: Selector<EntityCollection<T>, string[] | number[]>;
-    /** True when the collection has been fully loaded. */
-    readonly selectLoaded: Selector<EntityCollection<T>, boolean>;
-    /** True when a multi-entity query command is in progress. */
-    readonly selectLoading: Selector<EntityCollection<T>, boolean>;
-    /** ChangeState (including original values) of entities with unsaved changes */
-    readonly selectChangeState: Selector<EntityCollection<T>, ChangeStateMap<T>>;
-}
-/**
- * The selector functions for entity collection members,
- * Selects from store root, through EntityCache, to the entity collection member
- * Contrast with {CollectionSelectors}.
- */
-export interface EntitySelectors<T> {
-    /** Name of the entity collection for these selectors */
-    readonly entityName: string;
-    readonly [name: string]: MemoizedSelector<EntityCollection<T>, any> | string;
-    /** The cached EntityCollection itself */
-    readonly selectCollection: MemoizedSelector<Object, EntityCollection<T>>;
-    /** Count of entities in the cached collection. */
-    readonly selectCount: MemoizedSelector<Object, number>;
-    /** All entities in the cached collection. */
-    readonly selectEntities: MemoizedSelector<Object, T[]>;
-    /** The EntityCache */
-    readonly selectEntityCache: MemoizedSelector<Object, EntityCache>;
-    /** Map of entity keys to entities */
-    readonly selectEntityMap: MemoizedSelector<Object, Dictionary<T>>;
-    /** Filter pattern applied by the entity collection's filter function */
-    readonly selectFilter: MemoizedSelector<Object, string>;
-    /** Entities in the cached collection that pass the filter function */
-    readonly selectFilteredEntities: MemoizedSelector<Object, T[]>;
-    /** Keys of the cached collection, in the collection's native sort order */
-    readonly selectKeys: MemoizedSelector<Object, string[] | number[]>;
-    /** True when the collection has been fully loaded. */
-    readonly selectLoaded: MemoizedSelector<Object, boolean>;
-    /** True when a multi-entity query command is in progress. */
-    readonly selectLoading: MemoizedSelector<Object, boolean>;
-    /** ChangeState (including original values) of entities with unsaved changes */
-    readonly selectChangeState: MemoizedSelector<Object, ChangeStateMap<T>>;
-}
-/** Creates EntitySelector functions for entity collections. */
-export declare class EntitySelectorsFactory {
-    private entityCollectionCreator;
-    private selectEntityCache;
-    constructor(entityCollectionCreator?: EntityCollectionCreator, selectEntityCache?: EntityCacheSelector);
-    /**
-     * Create the NgRx selector from the store root to the named collection,
-     * e.g. from Object to Heroes.
-     * @param entityName the name of the collection
-     */
-    createCollectionSelector<T = any, C extends EntityCollection<T> = EntityCollection<T>>(entityName: string): MemoizedSelector<Object, C, (s1: EntityCache) => C>;
-    /**
-     * Creates entity collection selectors from metadata.
-     * @param metadata - EntityMetadata for the collection.
-     * May be partial but much have `entityName`.
-     */
-    createCollectionSelectors<T, S extends CollectionSelectors<T> = CollectionSelectors<T>>(metadata: EntityMetadata<T>): S;
-    /**
-     * Creates default entity collection selectors for an entity type.
-     * Use the metadata overload for additional collection selectors.
-     * @param entityName - name of the entity type
-     */
-    createCollectionSelectors<T, S extends CollectionSelectors<T> = CollectionSelectors<T>>(entityName: string): S;
-    /**
-     * Creates the store-rooted selectors for an entity collection.
-     * {EntitySelectors$Factory} turns them into selectors$.
-     *
-     * @param metadata - EntityMetadata for the collection.
-     * May be partial but much have `entityName`.
-     *
-     * Based on ngrx/entity/state_selectors.ts
-     * Differs in that these selectors select from the NgRx store root,
-     * through the collection, to the collection members.
-     */
-    create<T, S extends EntitySelectors<T> = EntitySelectors<T>>(metadata: EntityMetadata<T>): S;
-    /**
-     * Creates the default store-rooted selectors for an entity collection.
-     * {EntitySelectors$Factory} turns them into selectors$.
-     * Use the metadata overload for additional collection selectors.
-     *
-     * @param entityName - name of the entity type.
-     *
-     * Based on ngrx/entity/state_selectors.ts
-     * Differs in that these selectors select from the NgRx store root,
-     * through the collection, to the collection members.
-     */
-    create<T, S extends EntitySelectors<T> = EntitySelectors<T>>(entityName: string): S;
-    static ɵfac: i0.ɵɵFactoryDeclaration<EntitySelectorsFactory, [{ optional: true; }, { optional: true; }]>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<EntitySelectorsFactory>;
-}

package/src/utils/correlation-id-generator.d.ts

@@ -1,20 +0,0 @@
-import * as i0 from "@angular/core";
-/**
- * Generates a string id beginning 'CRID',
- * followed by a monotonically increasing integer for use as a correlation id.
- * As they are produced locally by a singleton service,
- * these ids are guaranteed to be unique only
- * for the duration of a single client browser instance.
- * Ngrx entity dispatcher query and save methods call this service to generate default correlation ids.
- * Do NOT use for entity keys.
- */
-export declare class CorrelationIdGenerator {
-    /** Seed for the ids */
-    protected seed: number;
-    /** Prefix of the id, 'CRID; */
-    protected prefix: string;
-    /** Return the next correlation id */
-    next(): string;
-    static ɵfac: i0.ɵɵFactoryDeclaration<CorrelationIdGenerator, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<CorrelationIdGenerator>;
-}

package/src/utils/default-logger.d.ts

@@ -1,9 +0,0 @@
-import { Logger } from './interfaces';
-import * as i0 from "@angular/core";
-export declare class DefaultLogger implements Logger {
-    error(message?: any, extra?: any): void;
-    log(message?: any, extra?: any): void;
-    warn(message?: any, extra?: any): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<DefaultLogger, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<DefaultLogger>;
-}

package/src/utils/default-pluralizer.d.ts

@@ -1,18 +0,0 @@
-import { EntityPluralNames } from './interfaces';
-import * as i0 from "@angular/core";
-export declare class DefaultPluralizer {
-    pluralNames: EntityPluralNames;
-    constructor(pluralNames: EntityPluralNames[]);
-    /**
-     * Pluralize a singular name using common English language pluralization rules
-     * Examples: "company" -> "companies", "employee" -> "employees", "tax" -> "taxes"
-     */
-    pluralize(name: string): string;
-    /**
-     * Register a mapping of entity type name to the entity name's plural
-     * @param pluralNames {EntityPluralNames} plural names for entity types
-     */
-    registerPluralNames(pluralNames: EntityPluralNames): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<DefaultPluralizer, [{ optional: true; }]>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<DefaultPluralizer>;
-}

package/src/utils/guid-fns.d.ts

@@ -1,24 +0,0 @@
-/**
-  Client-side id-generators
-
-  These GUID utility functions are not used by @ngrx/data itself at this time.
-  They are included as candidates for generating persistable correlation ids if that becomes desirable.
-  They are also safe for generating unique entity ids on the client.
-
-  Note they produce 32-character hexadecimal UUID strings,
-  not the 128-bit representation found in server-side languages and databases.
-
-  These utilities are experimental and may be withdrawn or replaced in future.
-*/
-/** Alias for getUuid(). Compare with getGuidComb(). */
-export declare function getGuid(): string;
-/**
- * Creates a sortable, pseudo-GUID (globally unique identifier)
- * whose trailing 6 bytes (12 hex digits) are time-based
- * Start either with the given getTime() value, seedTime,
- * or get the current time in ms.
- *
- * @param seed {number} - optional seed for reproducible time-part
- */
-export declare function getGuidComb(seed?: number): string;
-export declare function guidComparer(l: string, r: string): number;

package/src/utils/interfaces.d.ts

@@ -1,16 +0,0 @@
-import { InjectionToken } from '@angular/core';
-export declare abstract class Logger {
-    abstract error(message?: any, ...optionalParams: any[]): void;
-    abstract log(message?: any, ...optionalParams: any[]): void;
-    abstract warn(message?: any, ...optionalParams: any[]): void;
-}
-/**
- * Mapping of entity type name to its plural
- */
-export interface EntityPluralNames {
-    [entityName: string]: string;
-}
-export declare const PLURAL_NAMES_TOKEN: InjectionToken<EntityPluralNames>;
-export declare abstract class Pluralizer {
-    abstract pluralize(name: string): string;
-}

package/src/utils/utilities.d.ts

@@ -1,26 +0,0 @@
-import { IdSelector, Update } from '@ngrx/entity';
-/**
- * Default function that returns the entity's primary key (pkey).
- * Assumes that the entity has an `id` pkey property.
- * Returns `undefined` if no entity or `id`.
- * Every selectId fn must return `undefined` when it cannot produce a full pkey.
- */
-export declare function defaultSelectId(entity: any): any;
-/**
- * Flatten first arg if it is an array
- * Allows fn with ...rest signature to be called with an array instead of spread
- * Example:
- * ```
- * // See entity-action-operators.ts
- * const persistOps = [EntityOp.QUERY_ALL, EntityOp.ADD, ...];
- * actions.pipe(ofEntityOp(...persistOps)) // works
- * actions.pipe(ofEntityOp(persistOps)) // also works
- * ```
- * */
-export declare function flattenArgs<T>(args?: any[]): T[];
-/**
- * Return a function that converts an entity (or partial entity) into the `Update<T>`
- * whose `id` is the primary key and
- * `changes` is the entity (or partial entity of changes).
- */
-export declare function toUpdateFactory<T>(selectId?: IdSelector<T>): (entity: Partial<T>) => Update<T>;