@ngxs-labs/entity-state
Version:
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 7.0.5.
180 lines • 13.5 kB
JavaScript
/**
* @fileoverview added by tsickle
* @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
*/
import { InvalidIdOfError, UnableToGenerateIdError } from './errors';
export var IdStrategy;
(function (IdStrategy) {
/**
* @abstract
* @template T
*/
class IdGenerator {
/**
* @protected
* @param {?} idKey
*/
constructor(idKey) {
this.idKey = idKey;
}
/**
* Checks if the given id is in the state's ID array
* @param {?} id the ID to check
* @param {?} state the current state
* @return {?}
*/
isIdInState(id, state) {
return state.ids.includes(id);
}
/**
* This function tries to get the present ID of the given entity with #getIdOf.
* If it's undefined the #generateId function will be used.
* @see getIdOf / generateId
* @param {?} entity The entity to get the ID from
* @param {?} state The current state
* @return {?}
*/
getPresentIdOrGenerate(entity, state) {
/** @type {?} */
const presentId = this.getIdOf(entity);
return presentId === undefined ? this.generateId(entity, state) : presentId;
}
/**
* A wrapper for #getIdOf. If the function returns undefined an error will be thrown.
* @see getIdOf / InvalidIdOfError
* @param {?} entity The entity to get the ID from
* @return {?}
*/
mustGetIdOf(entity) {
/** @type {?} */
const id = this.getIdOf(entity);
if (id === undefined) {
throw new InvalidIdOfError();
}
return id;
}
/**
* Returns the ID for the given entity. Can return undefined.
* @param {?} entity The entity to get the ID from
* @return {?}
*/
getIdOf(entity) {
return entity[this.idKey];
}
}
IdStrategy.IdGenerator = IdGenerator;
if (false) {
/**
* @type {?}
* @protected
*/
IdGenerator.prototype.idKey;
/**
* Generates a completely new ID.
* The IdGenerator's implementation has to ensure that the generated ID does not exist in the current state.
* It can throw an UnableToGenerateIdError if it's unable to do so.
* @see getPresentIdOrGenerate / UnableToGenerateIdError
* @abstract
* @param {?} entity The entity to generate an ID for
* @param {?} state The current state
* @return {?}
*/
IdGenerator.prototype.generateId = function (entity, state) { };
}
/**
* @template T
*/
class IncrementingIdGenerator extends IdGenerator {
/**
* @param {?} idKey
*/
constructor(idKey) {
super(idKey);
}
/**
* @param {?} entity
* @param {?} state
* @return {?}
*/
generateId(entity, state) {
/** @type {?} */
const max = Math.max(-1, ...state.ids.map((/**
* @param {?} id
* @return {?}
*/
id => parseInt(id, 10))));
return (max + 1).toString(10);
}
}
IdStrategy.IncrementingIdGenerator = IncrementingIdGenerator;
/**
* @template T
*/
class UUIDGenerator extends IdGenerator {
/**
* @param {?} idKey
*/
constructor(idKey) {
super(idKey);
}
/**
* @param {?} entity
* @param {?} state
* @return {?}
*/
generateId(entity, state) {
/** @type {?} */
let nextId;
do {
nextId = this.uuidv4();
} while (this.isIdInState(nextId, state));
return nextId;
}
/**
* @private
* @return {?}
*/
uuidv4() {
// https://stackoverflow.com/a/2117523
return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, (/**
* @param {?} c
* @return {?}
*/
function (c) {
/** @type {?} */
const r = (Math.random() * 16) | 0;
// tslint:disable-line
/** @type {?} */
const v = c === 'x' ? r : (r & 0x3) | 0x8;
return v.toString(16);
}));
}
}
IdStrategy.UUIDGenerator = UUIDGenerator;
/**
* @template T
*/
class EntityIdGenerator extends IdGenerator {
/**
* @param {?} idKey
*/
constructor(idKey) {
super(idKey);
}
/**
* @param {?} entity
* @param {?} state
* @return {?}
*/
generateId(entity, state) {
/** @type {?} */
const id = this.mustGetIdOf(entity);
if (this.isIdInState(id, state)) {
throw new UnableToGenerateIdError(`The provided ID already exists: ${id}`);
}
return id;
}
}
IdStrategy.EntityIdGenerator = EntityIdGenerator;
})(IdStrategy || (IdStrategy = {}));
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"id-strategy.js","sourceRoot":"ng://@ngxs-labs/entity-state/","sources":["lib/id-strategy.ts"],"names":[],"mappings":";;;;AACA,OAAO,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,MAAM,UAAU,CAAC;AAErE,MAAM,KAAW,UAAU,CA2G1B;AA3GD,WAAiB,UAAU;;;;;IACzB,MAAsB,WAAW;;;;;QAC/B,YAAyC,KAAc;YAAd,UAAK,GAAL,KAAK,CAAS;QAAG,CAAC;;;;;;;QAkB3D,WAAW,CAAC,EAAU,EAAE,KAA4B;YAClD,OAAO,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QAChC,CAAC;;;;;;;;;QAUD,sBAAsB,CAAC,MAAkB,EAAE,KAA4B;;kBAC/D,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;YACtC,OAAO,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC9E,CAAC;;;;;;;QAQD,WAAW,CAAC,MAAW;;kBACf,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;YAC/B,IAAI,EAAE,KAAK,SAAS,EAAE;gBACpB,MAAM,IAAI,gBAAgB,EAAE,CAAC;aAC9B;YACD,OAAO,EAAE,CAAC;QACZ,CAAC;;;;;;QAMD,OAAO,CAAC,MAAW;YACjB,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC5B,CAAC;KACF;IAzDqB,sBAAW,cAyDhC,CAAA;;;;;;QAxDuB,4BAAiC;;;;;;;;;;;QAWvD,gEAA8E;;;;;IA+ChF,MAAa,uBAA2B,SAAQ,WAAc;;;;QAC5D,YAAY,KAAc;YACxB,KAAK,CAAC,KAAK,CAAC,CAAC;QACf,CAAC;;;;;;QAED,UAAU,CAAC,MAAkB,EAAE,KAA4B;;kBACnD,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG;;;;YAAC,EAAE,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAC,EAAC,CAAC;YAClE,OAAO,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QAChC,CAAC;KACF;IATY,kCAAuB,0BASnC,CAAA;;;;IAED,MAAa,aAAiB,SAAQ,WAAc;;;;QAClD,YAAY,KAAc;YACxB,KAAK,CAAC,KAAK,CAAC,CAAC;QACf,CAAC;;;;;;QAED,UAAU,CAAC,MAAkB,EAAE,KAA4B;;gBACrD,MAAM;YACV,GAAG;gBACD,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;aACxB,QAAQ,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE;YAC1C,OAAO,MAAM,CAAC;QAChB,CAAC;;;;;QAEO,MAAM;YACZ,sCAAsC;YACtC,OAAO,sCAAsC,CAAC,OAAO,CAAC,OAAO;;;;YAAE,UAAS,CAAC;;sBACjE,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC;;;sBAC5B,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG;gBACzC,OAAO,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YACxB,CAAC,EAAC,CAAC;QACL,CAAC;KACF;IArBY,wBAAa,gBAqBzB,CAAA;;;;IAED,MAAa,iBAAqB,SAAQ,WAAc;;;;QACtD,YAAY,KAAc;YACxB,KAAK,CAAC,KAAK,CAAC,CAAC;QACf,CAAC;;;;;;QAED,UAAU,CAAC,MAAkB,EAAE,KAA4B;;kBACnD,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC;YACnC,IAAI,IAAI,CAAC,WAAW,CAAC,EAAE,EAAE,KAAK,CAAC,EAAE;gBAC/B,MAAM,IAAI,uBAAuB,CAAC,mCAAmC,EAAE,EAAE,CAAC,CAAC;aAC5E;YACD,OAAO,EAAE,CAAC;QACZ,CAAC;KACF;IAZY,4BAAiB,oBAY7B,CAAA;AACH,CAAC,EA3GgB,UAAU,KAAV,UAAU,QA2G1B","sourcesContent":["import { EntityStateModel } from './models';\nimport { InvalidIdOfError, UnableToGenerateIdError } from './errors';\n\nexport namespace IdStrategy {\n  export abstract class IdGenerator<T> {\n    protected constructor(protected readonly idKey: keyof T) {}\n\n    /**\n     * Generates a completely new ID.\n     * The IdGenerator's implementation has to ensure that the generated ID does not exist in the current state.\n     * It can throw an UnableToGenerateIdError if it's unable to do so.\n     * @param entity The entity to generate an ID for\n     * @param state The current state\n     * @see getPresentIdOrGenerate\n     * @see UnableToGenerateIdError\n     */\n    abstract generateId(entity: Partial<T>, state: EntityStateModel<any>): string;\n\n    /**\n     * Checks if the given id is in the state's ID array\n     * @param id the ID to check\n     * @param state the current state\n     */\n    isIdInState(id: string, state: EntityStateModel<any>): boolean {\n      return state.ids.includes(id);\n    }\n\n    /**\n     * This function tries to get the present ID of the given entity with #getIdOf.\n     * If it's undefined the #generateId function will be used.\n     * @param entity The entity to get the ID from\n     * @param state The current state\n     * @see getIdOf\n     * @see generateId\n     */\n    getPresentIdOrGenerate(entity: Partial<T>, state: EntityStateModel<any>): string {\n      const presentId = this.getIdOf(entity);\n      return presentId === undefined ? this.generateId(entity, state) : presentId;\n    }\n\n    /**\n     * A wrapper for #getIdOf. If the function returns undefined an error will be thrown.\n     * @param entity The entity to get the ID from\n     * @see getIdOf\n     * @see InvalidIdOfError\n     */\n    mustGetIdOf(entity: any): string {\n      const id = this.getIdOf(entity);\n      if (id === undefined) {\n        throw new InvalidIdOfError();\n      }\n      return id;\n    }\n\n    /**\n     * Returns the ID for the given entity. Can return undefined.\n     * @param entity The entity to get the ID from\n     */\n    getIdOf(entity: any): string | undefined {\n      return entity[this.idKey];\n    }\n  }\n\n  export class IncrementingIdGenerator<T> extends IdGenerator<T> {\n    constructor(idKey: keyof T) {\n      super(idKey);\n    }\n\n    generateId(entity: Partial<T>, state: EntityStateModel<any>): string {\n      const max = Math.max(-1, ...state.ids.map(id => parseInt(id, 10)));\n      return (max + 1).toString(10);\n    }\n  }\n\n  export class UUIDGenerator<T> extends IdGenerator<T> {\n    constructor(idKey: keyof T) {\n      super(idKey);\n    }\n\n    generateId(entity: Partial<T>, state: EntityStateModel<any>): string {\n      let nextId;\n      do {\n        nextId = this.uuidv4();\n      } while (this.isIdInState(nextId, state));\n      return nextId;\n    }\n\n    private uuidv4(): string {\n      // https://stackoverflow.com/a/2117523\n      return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function(c) {\n        const r = (Math.random() * 16) | 0; // tslint:disable-line\n        const v = c === 'x' ? r : (r & 0x3) | 0x8; // tslint:disable-line\n        return v.toString(16);\n      });\n    }\n  }\n\n  export class EntityIdGenerator<T> extends IdGenerator<T> {\n    constructor(idKey: keyof T) {\n      super(idKey);\n    }\n\n    generateId(entity: Partial<T>, state: EntityStateModel<any>): string {\n      const id = this.mustGetIdOf(entity);\n      if (this.isIdInState(id, state)) {\n        throw new UnableToGenerateIdError(`The provided ID already exists: ${id}`);\n      }\n      return id;\n    }\n  }\n}\n"]}