@igo2/common 1.15.3 → 16.0.0-rc.0

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

@@ -1,49 +1,49 @@
-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;
+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/lib/entity/shared/index.d.ts

@@ -1,9 +1,10 @@
-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';
+export * from './entity.enums';
+export * from './entity.interfaces';
+export * from './entity.utils';
+export * from './store';
+export * from './store-strategy';
+export * from './state';
+export * from './watcher';
+export * from './transaction';
+export * from './view';
+export * from './strategies';

package/lib/entity/shared/state.d.ts

@@ -1,103 +1,108 @@
-import { ReplaySubject } from 'rxjs';
-import { EntityKey, EntityState, EntityStateManagerOptions } from './entity.interfaces';
-/**
- * This class is used to track a store's entities state
- */
-export declare class EntityStateManager<E extends object, S extends EntityState = EntityState> {
-    /**
-     * 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;
-    private store;
-    constructor(options?: EntityStateManagerOptions);
-    /**
-     * 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;
-}
+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/lib/entity/shared/store-strategy.d.ts

@@ -0,0 +1,38 @@
+import { EntityState } from './entity.interfaces';
+import { EntityStoreStrategy } from './strategies/strategy';
+import { EntityStore, EntityStoreOptions } from './store';
+export declare class EntityStoreWithStrategy<E extends object = object, S extends EntityState = EntityState> extends EntityStore<E, S> {
+    /**
+     * Strategies
+     */
+    private strategies;
+    constructor(entities: E[], options?: EntityStoreOptions);
+    /**
+     * 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;
+}