@ngxs-labs/entity-state
Version:
<p align="center"> <img src="https://raw.githubusercontent.com/ngxs-labs/emitter/master/docs/assets/logo.png"> </p>
95 lines • 11.8 kB
JavaScript
import { InvalidIdOfError, UnableToGenerateIdError } from './errors';
export var IdStrategy;
(function (IdStrategy) {
class IdGenerator {
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
*/
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.
* @param entity The entity to get the ID from
* @param state The current state
* @see getIdOf
* @see generateId
*/
getPresentIdOrGenerate(entity, state) {
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.
* @param entity The entity to get the ID from
* @see getIdOf
* @see InvalidIdOfError
*/
mustGetIdOf(entity) {
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
*/
getIdOf(entity) {
return entity[this.idKey];
}
}
IdStrategy.IdGenerator = IdGenerator;
class IncrementingIdGenerator extends IdGenerator {
constructor(idKey) {
super(idKey);
}
generateId(entity, state) {
const max = Math.max(-1, ...state.ids.map(id => parseInt(id, 10)));
return (max + 1).toString(10);
}
}
IdStrategy.IncrementingIdGenerator = IncrementingIdGenerator;
class UUIDGenerator extends IdGenerator {
constructor(idKey) {
super(idKey);
}
generateId(entity, state) {
let nextId;
do {
nextId = this.uuidv4();
} while (this.isIdInState(nextId, state));
return nextId;
}
uuidv4() {
// https://stackoverflow.com/a/2117523
return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
const r = (Math.random() * 16) | 0; // tslint:disable-line
const v = c === 'x' ? r : (r & 0x3) | 0x8; // tslint:disable-line
return v.toString(16);
});
}
}
IdStrategy.UUIDGenerator = UUIDGenerator;
class EntityIdGenerator extends IdGenerator {
constructor(idKey) {
super(idKey);
}
generateId(entity, state) {
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":"","sources":["../../../../src/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;QAa3D;;;;WAIG;QACH,WAAW,CAAC,EAAU,EAAE,KAA4B;YAClD,OAAO,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QAChC,CAAC;QAED;;;;;;;WAOG;QACH,sBAAsB,CAAC,MAAkB,EAAE,KAA4B;YACrE,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACvC,OAAO,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC9E,CAAC;QAED;;;;;WAKG;QACH,WAAW,CAAC,MAAW;YACrB,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAChC,IAAI,EAAE,KAAK,SAAS,EAAE;gBACpB,MAAM,IAAI,gBAAgB,EAAE,CAAC;aAC9B;YACD,OAAO,EAAE,CAAC;QACZ,CAAC;QAED;;;WAGG;QACH,OAAO,CAAC,MAAW;YACjB,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC5B,CAAC;KACF;IAzDqB,sBAAW,cAyDhC,CAAA;IAED,MAAa,uBAA2B,SAAQ,WAAc;QAC5D,YAAY,KAAc;YACxB,KAAK,CAAC,KAAK,CAAC,CAAC;QACf,CAAC;QAED,UAAU,CAAC,MAAkB,EAAE,KAA4B;YACzD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;YACnE,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;YACzD,IAAI,MAAM,CAAC;YACX,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,EAAE,UAAS,CAAC;gBACvE,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,sBAAsB;gBAC1D,MAAM,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,sBAAsB;gBACjE,OAAO,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YACxB,CAAC,CAAC,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;YACzD,MAAM,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;YACpC,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';\r\nimport { InvalidIdOfError, UnableToGenerateIdError } from './errors';\r\n\r\nexport namespace IdStrategy {\r\n  export abstract class IdGenerator<T> {\r\n    protected constructor(protected readonly idKey: keyof T) {}\r\n\r\n    /**\r\n     * Generates a completely new ID.\r\n     * The IdGenerator's implementation has to ensure that the generated ID does not exist in the current state.\r\n     * It can throw an UnableToGenerateIdError if it's unable to do so.\r\n     * @param entity The entity to generate an ID for\r\n     * @param state The current state\r\n     * @see getPresentIdOrGenerate\r\n     * @see UnableToGenerateIdError\r\n     */\r\n    abstract generateId(entity: Partial<T>, state: EntityStateModel<any>): string;\r\n\r\n    /**\r\n     * Checks if the given id is in the state's ID array\r\n     * @param id the ID to check\r\n     * @param state the current state\r\n     */\r\n    isIdInState(id: string, state: EntityStateModel<any>): boolean {\r\n      return state.ids.includes(id);\r\n    }\r\n\r\n    /**\r\n     * This function tries to get the present ID of the given entity with #getIdOf.\r\n     * If it's undefined the #generateId function will be used.\r\n     * @param entity The entity to get the ID from\r\n     * @param state The current state\r\n     * @see getIdOf\r\n     * @see generateId\r\n     */\r\n    getPresentIdOrGenerate(entity: Partial<T>, state: EntityStateModel<any>): string {\r\n      const presentId = this.getIdOf(entity);\r\n      return presentId === undefined ? this.generateId(entity, state) : presentId;\r\n    }\r\n\r\n    /**\r\n     * A wrapper for #getIdOf. If the function returns undefined an error will be thrown.\r\n     * @param entity The entity to get the ID from\r\n     * @see getIdOf\r\n     * @see InvalidIdOfError\r\n     */\r\n    mustGetIdOf(entity: any): string {\r\n      const id = this.getIdOf(entity);\r\n      if (id === undefined) {\r\n        throw new InvalidIdOfError();\r\n      }\r\n      return id;\r\n    }\r\n\r\n    /**\r\n     * Returns the ID for the given entity. Can return undefined.\r\n     * @param entity The entity to get the ID from\r\n     */\r\n    getIdOf(entity: any): string | undefined {\r\n      return entity[this.idKey];\r\n    }\r\n  }\r\n\r\n  export class IncrementingIdGenerator<T> extends IdGenerator<T> {\r\n    constructor(idKey: keyof T) {\r\n      super(idKey);\r\n    }\r\n\r\n    generateId(entity: Partial<T>, state: EntityStateModel<any>): string {\r\n      const max = Math.max(-1, ...state.ids.map(id => parseInt(id, 10)));\r\n      return (max + 1).toString(10);\r\n    }\r\n  }\r\n\r\n  export class UUIDGenerator<T> extends IdGenerator<T> {\r\n    constructor(idKey: keyof T) {\r\n      super(idKey);\r\n    }\r\n\r\n    generateId(entity: Partial<T>, state: EntityStateModel<any>): string {\r\n      let nextId;\r\n      do {\r\n        nextId = this.uuidv4();\r\n      } while (this.isIdInState(nextId, state));\r\n      return nextId;\r\n    }\r\n\r\n    private uuidv4(): string {\r\n      // https://stackoverflow.com/a/2117523\r\n      return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function(c) {\r\n        const r = (Math.random() * 16) | 0; // tslint:disable-line\r\n        const v = c === 'x' ? r : (r & 0x3) | 0x8; // tslint:disable-line\r\n        return v.toString(16);\r\n      });\r\n    }\r\n  }\r\n\r\n  export class EntityIdGenerator<T> extends IdGenerator<T> {\r\n    constructor(idKey: keyof T) {\r\n      super(idKey);\r\n    }\r\n\r\n    generateId(entity: Partial<T>, state: EntityStateModel<any>): string {\r\n      const id = this.mustGetIdOf(entity);\r\n      if (this.isIdInState(id, state)) {\r\n        throw new UnableToGenerateIdError(`The provided ID already exists: ${id}`);\r\n      }\r\n      return id;\r\n    }\r\n  }\r\n}\r\n"]}