@igo2/common 19.0.3 → 20.0.0-next.2

package/entity/entity-table-paginator/entity-table-paginator.interface.d.ts

@@ -1,8 +0,0 @@
-export interface EntityTablePaginatorOptions {
-    disabled?: boolean;
-    hidePageSize?: boolean;
-    pageIndex?: number;
-    pageSize?: number;
-    pageSizeOptions?: number[];
-    showFirstLastButtons?: boolean;
-}

package/entity/entity-table-paginator/entity-table-paginator.module.d.ts

@@ -1,10 +0,0 @@
-import * as i0 from "@angular/core";
-import * as i1 from "./entity-table-paginator.component";
-/**
- * @deprecated import the EntityTablePaginatorComponent directly
- */
-export declare class IgoEntityTablePaginatorModule {
-    static ɵfac: i0.ɵɵFactoryDeclaration<IgoEntityTablePaginatorModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<IgoEntityTablePaginatorModule, never, [typeof i1.EntityTablePaginatorComponent], [typeof i1.EntityTablePaginatorComponent]>;
-    static ɵinj: i0.ɵɵInjectorDeclaration<IgoEntityTablePaginatorModule>;
-}

package/entity/entity-table-paginator/index.d.ts

@@ -1,3 +0,0 @@
-export * from './entity-table-paginator.module';
-export * from './entity-table-paginator.component';
-export * from './entity-table-paginator.interface';

package/entity/entity.module.d.ts

@@ -1,16 +0,0 @@
-import { EntitySelectorComponent } from './entity-selector';
-import { EntityTableComponent } from './entity-table';
-import { EntityTablePaginatorComponent } from './entity-table-paginator';
-import * as i0 from "@angular/core";
-import * as i1 from "./entity-selector/entity-selector.component";
-import * as i2 from "./entity-table/entity-table.component";
-import * as i3 from "./entity-table-paginator/entity-table-paginator.component";
-export declare const ENTITY_DIRECTIVES: readonly [typeof EntitySelectorComponent, typeof EntityTableComponent, typeof EntityTablePaginatorComponent];
-/**
- * @deprecated import the components directly or ENTITY_DIRECTIVES for every components/directives
- */
-export declare class IgoEntityModule {
-    static ɵfac: i0.ɵɵFactoryDeclaration<IgoEntityModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<IgoEntityModule, never, [typeof i1.EntitySelectorComponent, typeof i2.EntityTableComponent, typeof i3.EntityTablePaginatorComponent], [typeof i1.EntitySelectorComponent, typeof i2.EntityTableComponent, typeof i3.EntityTablePaginatorComponent]>;
-    static ɵinj: i0.ɵɵInjectorDeclaration<IgoEntityModule>;
-}

package/entity/public_api.d.ts

@@ -1,5 +0,0 @@
-export * from './shared';
-export * from './entity.module';
-export * from './entity-selector';
-export * from './entity-table';
-export * from './entity-table-paginator';

package/entity/shared/entity.enums.d.ts

@@ -1,23 +0,0 @@
-export declare enum EntityOperationType {
-    Insert = "Insert",
-    Update = "Update",
-    Delete = "Delete"
-}
-export declare enum EntityTableColumnRenderer {
-    Default = "Default",
-    HTML = "HTML",
-    UnsanitizedHTML = "UnsanitizedHTML",
-    Editable = "Editable",
-    Icon = "Icon",
-    ButtonGroup = "ButtonGroup"
-}
-export declare enum EntityTableScrollBehavior {
-    Auto = "auto",
-    Instant = "instant",
-    Smooth = "smooth"
-}
-export declare enum EntityTableSelectionState {
-    None = "None",
-    All = "All",
-    Some = "Some"
-}

package/entity/shared/entity.interfaces.d.ts

@@ -1,92 +0,0 @@
-import { Observable } from 'rxjs';
-import { EntityTableColumnRenderer } from './entity.enums';
-export type EntityKey = string | number;
-export type EntityState = Record<string, any>;
-export interface EntityRecord<E extends object, S extends EntityState = EntityState> {
-    entity: E;
-    state: S;
-    revision: number;
-    ref: string;
-    edition?: boolean;
-}
-export interface EntityStoreStrategyOptions {
-}
-export interface EntityStoreStrategyFuncOptions extends EntityStoreStrategyOptions {
-    filterClauseFunc: EntityFilterClause;
-}
-export interface EntityTransactionOptions {
-    getKey?: (entity: object) => EntityKey;
-}
-export type EntityFilterClause<E = object> = (entity: E) => boolean;
-export interface EntitySortClause<E = object> {
-    valueAccessor: (entity: E) => string | number;
-    direction: string;
-    nullsFirst?: boolean;
-}
-export interface EntityJoinClause {
-    source: Observable<any | void>;
-    reduce: (param1: object, param2: any) => object;
-}
-export interface EntityOperationState {
-    added: boolean;
-    canceled: boolean;
-}
-export interface EntityTableTemplate {
-    columns: EntityTableColumn[];
-    selection?: boolean;
-    selectionCheckbox?: boolean;
-    selectMany?: boolean;
-    sort?: boolean;
-    fixedHeader?: boolean;
-    tableHeight?: string;
-    valueAccessor?: (entity: object, property: string, record: EntityRecord<object>) => any;
-    headerClassFunc?: () => Record<string, boolean>;
-    rowClassFunc?: (entity: object, record: EntityRecord<object>) => Record<string, boolean>;
-    cellClassFunc?: (entity: object, column: EntityTableColumn, record: EntityRecord<object>) => Record<string, boolean>;
-}
-export interface EntityTableColumnValidation {
-    readonly?: boolean;
-    mandatory?: boolean;
-    maxlength?: number;
-    minlength?: number;
-    minValue?: number;
-    maxValue?: number;
-}
-export interface TableRelation {
-    table: string;
-}
-export interface EntityTableColumn {
-    validation?: EntityTableColumnValidation;
-    name: string;
-    title: string;
-    renderer?: EntityTableColumnRenderer;
-    valueAccessor?: (entity: object, record: EntityRecord<object>) => any;
-    visible?: boolean;
-    linkColumnForce?: string;
-    sort?: boolean;
-    type?: string;
-    multiple?: boolean;
-    domainValues?: SelectOption[];
-    relation?: TableRelation;
-    tooltip?: string;
-    cellClassFunc?: (entity: object, record: EntityRecord<object>) => Record<string, boolean>;
-    step?: number;
-    icon?: string;
-    onBlur?: (event: Event) => void;
-    onChange?: (event: Event) => void;
-    onClick?: (event: Event) => void;
-    onFocus?: (event: Event) => void;
-}
-export interface SelectOption {
-    id: number;
-    value: string;
-    disabled?: boolean;
-}
-export interface EntityTableButton {
-    icon: string;
-    click: (entity: object, record: EntityRecord<object>) => void;
-    color?: 'primary' | 'accent' | 'warn';
-    disabled?: boolean;
-    style?: 'mat-mini-fab' | 'mat-icon-button';
-    editMode?: boolean;
-}

package/entity/shared/entity.utils.d.ts

@@ -1,49 +0,0 @@
-import { EntityKey } from './entity.interfaces';
-/**
- * Get an entity's named property. Nested properties are supported
- * with the dotted notation. (i.e 'author.name')
- *
- * Note: this method is a 'best attempt' at getting an entity's property.
- * It fits the most common cases but you might need to explicitely define
- * a property getter when using an EntityStore, for example.
- * @param entity Entity
- * @param property Property name
- * @returns Property value
- */
-export declare function getEntityProperty(entity: object, property: string): any;
-/**
- * Get an entity's id. An entity's id can be one of:
- * 'entity.meta.id', 'entity.meta.idProperty' or 'entity.id'.
- *
- * Note: See the note in the 'getEntityProperty' documentation.
- * @param entity Entity
- * @returns Entity id
- */
-export declare function getEntityId(entity: object): EntityKey;
-/**
- * Get an entity's title. An entity's title can be one of:
- * 'entity.meta.title', 'entity.meta.titleProperty' or 'entity.title'.
- * @param entity Entity
- * @returns Entity title
- */
-export declare function getEntityTitle(entity: object): string;
-/**
- * Get an entity's HTML title. An entity's HTML title can be one of:
- * 'entity.meta.titleHtml', 'entity.meta.titleHtmlProperty' or 'entity.titleHtml'.
- * @param entity Entity
- * @returns Entity HTML title
- */
-export declare function getEntityTitleHtml(entity: object): string;
-/**
- * Get an entity's icon. An entity's icon can be one of:
- * 'entity.meta.icon', 'entity.meta.iconProperty' or 'entity.icon'.
- * @param entity Entity
- * @returns Entity icon
- */
-export declare function getEntityIcon(entity: object): string;
-/**
- * Get an entity's revision.
- * @param entity Entity
- * @returns Entity revision
- */
-export declare function getEntityRevision(entity: object): number;

package/entity/shared/index.d.ts

@@ -1,9 +0,0 @@
-export * from './entity.enums';
-export * from './entity.interfaces';
-export * from './entity.utils';
-export * from './store';
-export * from './state';
-export * from './watcher';
-export * from './transaction';
-export * from './view';
-export * from './strategies';

package/entity/shared/state.d.ts

@@ -1,108 +0,0 @@
-import { ReplaySubject } from 'rxjs';
-import { EntityKey, EntityState } from './entity.interfaces';
-interface EntityStateManagerOptions<E extends object> {
-    getKey?: (entity: object) => EntityKey;
-    index?: Map<EntityKey, E>;
-}
-/**
- * This class is used to track a store's entities state
- */
-export declare class EntityStateManager<E extends object, S extends EntityState = EntityState> {
-    private options;
-    /**
-     * State index
-     */
-    readonly index: Map<EntityKey, S>;
-    /**
-     * Change emitter
-     */
-    readonly change$: ReplaySubject<void>;
-    /**
-     * Method to get an entity's id
-     */
-    readonly getKey: (E: any) => EntityKey;
-    constructor(options?: EntityStateManagerOptions<E>);
-    /**
-     * Clear state
-     */
-    clear(): void;
-    /**
-     * Get an entity's state
-     * @param entity Entity
-     * @returns State
-     */
-    get(entity: E): S;
-    /**
-     * Set an entity's state
-     * @param entity Entity
-     * @param state State
-     */
-    set(entity: E, state: S): void;
-    /**
-     * Set many entitie's state
-     * @param entitie Entities
-     * @param state State
-     */
-    setMany(entities: E[], state: S): void;
-    /**
-     * Set state of all entities that already have a state. This is not
-     * the same as setting the state of all the store's entities.
-     * @param state State
-     */
-    setAll(state: S): void;
-    /**
-     * Update an entity's state
-     * @param entity Entity
-     * @param changes State changes
-     */
-    update(entity: E, changes: Partial<S>, exclusive?: boolean): void;
-    /**
-     * Update many entitie's state
-     * @param entitie Entities
-     * @param changes State changes
-     */
-    updateMany(entities: E[], changes: Partial<S>, exclusive?: boolean): void;
-    /**
-     * Reversee an entity's state
-     * @param entity Entity
-     * @param keys State keys to reverse
-     */
-    reverse(entity: E, keys: string[]): void;
-    /**
-     * Reverse many entitie's state
-     * @param entitie Entities
-     * @param keys State keys to reverse
-     */
-    reverseMany(entities: E[], keys: string[]): void;
-    /**
-     * Update state of all entities that already have a state. This is not
-     * the same as updating the state of all the store's entities.
-     * @param changes State
-     */
-    updateAll(changes: Partial<S>): void;
-    /**
-     * When some state changes are flagged as 'exclusive', reverse
-     * the state of all other entities. Changes are reversable when
-     * they are boolean.
-     * @param entitie Entities
-     * @param changes State changes
-     */
-    private updateManyExclusive;
-    /**
-     * Compute a 'reversed' version of some state changes.
-     * Changes are reversable when they are boolean.
-     * @param changes State changes
-     * @returns Reversed state changes
-     */
-    private reverseChanges;
-    /**
-     * Return all the keys in that state and in the store it's bound to, if any.
-     * @returns Set of keys
-     */
-    private getAllKeys;
-    /**
-     * Emit 'change' event
-     */
-    private next;
-}
-export {};

package/entity/shared/store.d.ts

@@ -1,180 +0,0 @@
-import { BehaviorSubject } from 'rxjs';
-import { EntityKey, EntityRecord, EntityState } from './entity.interfaces';
-import { EntityStateManager } from './state';
-import type { EntityStoreStrategy } from './strategies/strategy';
-import { EntityView } from './view';
-export interface EntityStoreOptions {
-    getKey?: (entity: object) => EntityKey;
-    getProperty?: (entity: object, property: string) => any;
-}
-/**
- * An entity store class holds any number of entities
- * as well as their state. It can be observed, filtered and sorted and
- * provides methods to insert, update or delete entities.
- */
-export declare class EntityStore<E extends object = object, S extends EntityState = EntityState> {
-    /**
-     * Observable of the raw entities
-     */
-    readonly entities$: BehaviorSubject<E[]>;
-    /**
-     * Number of entities
-     */
-    readonly count$: BehaviorSubject<number>;
-    get count(): number;
-    /**
-     * Whether the store is empty
-     */
-    readonly empty$: BehaviorSubject<boolean>;
-    get empty(): boolean;
-    /**
-     * Entity store state
-     */
-    readonly state: EntityStateManager<E, S>;
-    /**
-     * View of all the entities
-     */
-    readonly view: EntityView<E>;
-    /**
-     * View of all the entities and their state
-     */
-    readonly stateView: EntityView<E, EntityRecord<E, S>>;
-    /**
-     * Method to get an entity's id
-     */
-    readonly getKey: (E: any) => EntityKey;
-    /**
-     * Method to get an entity's named property
-     */
-    readonly getProperty: (E: any, prop: string) => any;
-    /**
-     * Store index
-     */
-    get index(): Map<EntityKey, E>;
-    private _index;
-    /**
-     * Store index
-     */
-    get pristine(): boolean;
-    private _pristine;
-    /**
-     * Strategies
-     */
-    private strategies;
-    constructor(entities: E[], options?: EntityStoreOptions);
-    /**
-     * Get an entity from the store by key
-     * @param key Key
-     * @returns Entity
-     */
-    get(key: EntityKey): E;
-    /**
-     * Get all entities in the store
-     * @returns Array of entities
-     */
-    all(): E[];
-    /**
-     * Set this store's entities
-     * @param entities Entities
-     */
-    load(entities: E[], pristine?: boolean): void;
-    /**
-     * Clear the store's entities but keep the state and views intact.
-     * Views won't return any data but future data will be subject to the
-     * current views filter and sort
-     */
-    softClear(): void;
-    /**
-     * Clear the store's entities, state and views
-     */
-    clear(): void;
-    destroy(): void;
-    /**
-     * Insert an entity into the store
-     * @param entity Entity
-     */
-    insert(entity: E): void;
-    /**
-     * Insert many entities into the store
-     * @param entities Entities
-     */
-    insertMany(entities: E[]): void;
-    /**
-     * Update or insert an entity into the store
-     * @param entity Entity
-     */
-    update(entity: E): void;
-    /**
-     * Update or insert many entities into the store
-     * @param entities Entities
-     */
-    updateMany(entities: E[]): void;
-    /**
-     * Add a strategy to this store
-     * @param strategy Entity store strategy
-     * @returns Entity store
-     */
-    addStrategy(strategy: EntityStoreStrategy, activate?: boolean): EntityStore;
-    /**
-     * Remove a strategy from this store
-     * @param strategy Entity store strategy
-     * @returns Entity store
-     */
-    removeStrategy(strategy: EntityStoreStrategy): EntityStore;
-    /**
-     * Return strategies of a given type
-     * @param type Entity store strategy class
-     * @returns Strategies
-     */
-    getStrategyOfType(type: typeof EntityStoreStrategy): EntityStoreStrategy;
-    /**
-     * Activate strategies of a given type
-     * @param type Entity store strategy class
-     */
-    activateStrategyOfType(type: typeof EntityStoreStrategy): void;
-    /**
-     * Deactivate strategies of a given type
-     * @param type Entity store strategy class
-     */
-    deactivateStrategyOfType(type: typeof EntityStoreStrategy): void;
-    /**
-     * Delete an entity from the store
-     * @param entity Entity
-     */
-    delete(entity: E): void;
-    /**
-     * Delete many entities from the store
-     * @param entities Entities
-     */
-    deleteMany(entities: E[]): void;
-    /**
-     * Generate a complete index of all the entities
-     * @param entities Entities
-     * @returns Index
-     */
-    private generateIndex;
-    /**
-     * Push the index's entities into the entities$ observable
-     */
-    private next;
-    /**
-     * Update the store's count and empty
-     */
-    private updateCount;
-    /**
-     * Create the entity state manager
-     * @returns EntityStateManager
-     */
-    private createStateManager;
-    /**
-     * Create the data view
-     * @returns EntityView<E>
-     */
-    private createDataView;
-    /**
-     * Create the state view
-     * @returns EntityView<EntityRecord<E>>
-     */
-    private createStateView;
-    private statesAreTheSame;
-}

package/entity/shared/strategies/filter-custom-function.d.ts

@@ -1,51 +0,0 @@
-import { EntityStoreStrategyFuncOptions } from '../entity.interfaces';
-import { EntityStore } from '../store';
-import { EntityStoreStrategy } from './strategy';
-/**
- * When active, this strategy filters a store's stateView to return
- * selected entities only.
- */
-export declare class EntityStoreFilterCustomFuncStrategy extends EntityStoreStrategy {
-    protected options: EntityStoreStrategyFuncOptions;
-    constructor(options: EntityStoreStrategyFuncOptions);
-    /**
-     * Store / filter ids map
-     */
-    private filters;
-    /**
-     * Bind this strategy to a store and start filtering it
-     * @param store Entity store
-     */
-    bindStore(store: EntityStore): void;
-    /**
-     * Unbind this strategy from a store and stop filtering it
-     * @param store Entity store
-     */
-    unbindStore(store: EntityStore): void;
-    /**
-     * Start filtering all stores
-     * @internal
-     */
-    protected doActivate(): void;
-    /**
-     * Stop filtering all stores
-     * @internal
-     */
-    protected doDeactivate(): void;
-    /**
-     * Filter all stores
-     */
-    private filterAll;
-    /**
-     * Unfilter all stores
-     */
-    private unfilterAll;
-    /**
-     * Filter a store and add it to the filters map
-     */
-    private filterStore;
-    /**
-     * Unfilter a store and delete it from the filters map
-     */
-    private unfilterStore;
-}

package/entity/shared/strategies/filter-selection.d.ts

@@ -1,48 +0,0 @@
-import { EntityStore } from '../store';
-import { EntityStoreStrategy } from './strategy';
-/**
- * When active, this strategy filters a store's stateView to return
- * selected entities only.
- */
-export declare class EntityStoreFilterSelectionStrategy extends EntityStoreStrategy {
-    /**
-     * Store / filter ids map
-     */
-    private filters;
-    /**
-     * Bind this strategy to a store and start filtering it
-     * @param store Entity store
-     */
-    bindStore(store: EntityStore): void;
-    /**
-     * Unbind this strategy from a store and stop filtering it
-     * @param store Entity store
-     */
-    unbindStore(store: EntityStore): void;
-    /**
-     * Start filtering all stores
-     * @internal
-     */
-    protected doActivate(): void;
-    /**
-     * Stop filtering all stores
-     * @internal
-     */
-    protected doDeactivate(): void;
-    /**
-     * Filter all stores
-     */
-    private filterAll;
-    /**
-     * Unfilter all stores
-     */
-    private unfilterAll;
-    /**
-     * Filter a store and add it to the filters map
-     */
-    private filterStore;
-    /**
-     * Unfilter a store and delete it from the filters map
-     */
-    private unfilterStore;
-}

package/entity/shared/strategies/index.d.ts

@@ -1,3 +0,0 @@
-export * from './strategy';
-export * from './filter-custom-function';
-export * from './filter-selection';

package/entity/shared/strategies/strategy.d.ts

@@ -1,56 +0,0 @@
-import { BehaviorSubject } from 'rxjs';
-import { EntityStoreStrategyOptions } from '../entity.interfaces';
-import type { EntityStore } from '../store';
-/**
- * Entity store strategies. They can do pretty much anything during a store's
- * lifetime. For example, they may act as triggers when something happens.
- * Sharing a strategy is a good idea when multiple strategies would have
- * on cancelling effect on each other.
- *
- * At creation, strategy is inactive and needs to be manually activated.
- */
-export declare class EntityStoreStrategy {
-    protected options: EntityStoreStrategyOptions;
-    /**
-     * Feature store
-     * @internal
-     */
-    protected stores: EntityStore[];
-    /**
-     * Whether this strategy is active
-     * @internal
-     */
-    get active(): boolean;
-    readonly active$: BehaviorSubject<boolean>;
-    constructor(options?: EntityStoreStrategyOptions);
-    /**
-     * Activate the strategy. If it's already active, it'll be deactivated
-     * and activated again.
-     */
-    activate(): void;
-    /**
-     * Activate the strategy. If it's already active, it'll be deactivated
-     * and activated again.
-     */
-    deactivate(): void;
-    /**
-     * Bind this strategy to a store
-     * @param store Feature store
-     */
-    bindStore(store: EntityStore): void;
-    /**
-     * Unbind this strategy from store
-     * @param store Feature store
-     */
-    unbindStore(store: EntityStore): void;
-    /**
-     * Do the stataegy activation
-     * @internal
-     */
-    protected doActivate(): void;
-    /**
-     * Do the strategy deactivation
-     * @internal
-     */
-    protected doDeactivate(): void;
-}