@decaf-ts/core
Version:
Core persistence module for the decaf framework
100 lines • 11.7 kB
JavaScript
import { sequenceNameForModel } from "./../identity/utils.js";
import { InternalError } from "@decaf-ts/db-decorators";
import { Logging } from "@decaf-ts/logging";
/**
* @description Abstract base class for sequence generation
* @summary Provides a framework for generating sequential values (like primary keys) in the persistence layer.
* Implementations of this class handle the specifics of how sequences are stored and incremented in different
* database systems.
* @param {SequenceOptions} options - Configuration options for the sequence generator
* @class Sequence
* @example
* ```typescript
* // Example implementation for a specific database
* class PostgresSequence extends Sequence {
* constructor(options: SequenceOptions) {
* super(options);
* }
*
* async next(): Promise<number> {
* // Implementation to get next value from PostgreSQL sequence
* const result = await this.options.executor.raw(`SELECT nextval('${this.options.name}')`);
* return parseInt(result.rows[0].nextval);
* }
*
* async current(): Promise<number> {
* // Implementation to get current value from PostgreSQL sequence
* const result = await this.options.executor.raw(`SELECT currval('${this.options.name}')`);
* return parseInt(result.rows[0].currval);
* }
*
* async range(count: number): Promise<number[]> {
* // Implementation to get a range of values
* const values: number[] = [];
* for (let i = 0; i < count; i++) {
* values.push(await this.next());
* }
* return values;
* }
* }
*
* // Usage
* const sequence = new PostgresSequence({
* name: 'user_id_seq',
* executor: dbExecutor
* });
*
* const nextId = await sequence.next();
* ```
*/
export class Sequence {
/**
* @description Accessor for the logger instance
* @summary Gets or initializes the logger for this sequence
* @return {Logger} The logger instance
*/
get log() {
if (!this.logger)
this.logger = Logging.for(this);
return this.logger;
}
/**
* @description Creates a new sequence instance
* @summary Protected constructor that initializes the sequence with the provided options
*/
constructor(options) {
this.options = options;
}
/**
* @description Gets the primary key sequence name for a model
* @summary Utility method that returns the standardized sequence name for a model's primary key
* @template M - The model type
* @param {M|Constructor<M>} model - The model instance or constructor
* @return {string} The sequence name for the model's primary key
*/
static pk(model) {
return sequenceNameForModel(model, "pk");
}
/**
* @description Parses a sequence value to the appropriate type
* @summary Converts a sequence value to the specified type (Number or BigInt)
* @param {"Number"|"BigInt"|undefined} type - The target type to convert to
* @param {string|number|bigint} value - The value to convert
* @return {string|number|bigint} The converted value
*/
static parseValue(type, value) {
switch (type) {
case "Number":
return typeof value === "string"
? parseInt(value)
: typeof value === "number"
? value
: BigInt(value);
case "BigInt":
return BigInt(value);
default:
throw new InternalError("Should never happen");
}
}
}
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"Sequence.js","sourceRoot":"","sources":["../../../src/persistence/Sequence.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAE,+BAA0B;AAEzD,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAU,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,MAAM,OAAgB,QAAQ;IAO5B;;;;OAIG;IACH,IAAc,GAAG;QACf,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,IAAW,CAAC,CAAC;QACzD,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;OAGG;IACH,YAAyC,OAAwB;QAAxB,YAAO,GAAP,OAAO,CAAiB;IAAG,CAAC;IAwBrE;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,CAAkB,KAAyB;QAClD,OAAO,oBAAoB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,UAAU,CACf,IAAqC,EACrC,KAA+B;QAE/B,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,QAAQ;gBACX,OAAO,OAAO,KAAK,KAAK,QAAQ;oBAC9B,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC;oBACjB,CAAC,CAAC,OAAO,KAAK,KAAK,QAAQ;wBACzB,CAAC,CAAC,KAAK;wBACP,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACtB,KAAK,QAAQ;gBACX,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;YACvB;gBACE,MAAM,IAAI,aAAa,CAAC,qBAAqB,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;CACF","sourcesContent":["import { Constructor, Model } from \"@decaf-ts/decorator-validation\";\nimport { sequenceNameForModel } from \"../identity/utils\";\nimport { SequenceOptions } from \"../interfaces/SequenceOptions\";\nimport { InternalError } from \"@decaf-ts/db-decorators\";\nimport { Logger, Logging } from \"@decaf-ts/logging\";\n\n/**\n * @description Abstract base class for sequence generation\n * @summary Provides a framework for generating sequential values (like primary keys) in the persistence layer.\n * Implementations of this class handle the specifics of how sequences are stored and incremented in different\n * database systems.\n * @param {SequenceOptions} options - Configuration options for the sequence generator\n * @class Sequence\n * @example\n * ```typescript\n * // Example implementation for a specific database\n * class PostgresSequence extends Sequence {\n *   constructor(options: SequenceOptions) {\n *     super(options);\n *   }\n *\n *   async next(): Promise<number> {\n *     // Implementation to get next value from PostgreSQL sequence\n *     const result = await this.options.executor.raw(`SELECT nextval('${this.options.name}')`);\n *     return parseInt(result.rows[0].nextval);\n *   }\n *\n *   async current(): Promise<number> {\n *     // Implementation to get current value from PostgreSQL sequence\n *     const result = await this.options.executor.raw(`SELECT currval('${this.options.name}')`);\n *     return parseInt(result.rows[0].currval);\n *   }\n *\n *   async range(count: number): Promise<number[]> {\n *     // Implementation to get a range of values\n *     const values: number[] = [];\n *     for (let i = 0; i < count; i++) {\n *       values.push(await this.next());\n *     }\n *     return values;\n *   }\n * }\n *\n * // Usage\n * const sequence = new PostgresSequence({\n *   name: 'user_id_seq',\n *   executor: dbExecutor\n * });\n *\n * const nextId = await sequence.next();\n * ```\n */\nexport abstract class Sequence {\n  /**\n   * @description Logger instance for this sequence\n   * @summary Lazily initialized logger for the sequence instance\n   */\n  private logger!: Logger;\n\n  /**\n   * @description Accessor for the logger instance\n   * @summary Gets or initializes the logger for this sequence\n   * @return {Logger} The logger instance\n   */\n  protected get log() {\n    if (!this.logger) this.logger = Logging.for(this as any);\n    return this.logger;\n  }\n\n  /**\n   * @description Creates a new sequence instance\n   * @summary Protected constructor that initializes the sequence with the provided options\n   */\n  protected constructor(protected readonly options: SequenceOptions) {}\n\n  /**\n   * @description Gets the next value in the sequence\n   * @summary Retrieves the next value from the sequence, incrementing it in the process\n   * @return A promise that resolves to the next value in the sequence\n   */\n  abstract next(): Promise<string | number | bigint>;\n\n  /**\n   * @description Gets the current value of the sequence\n   * @summary Retrieves the current value of the sequence without incrementing it\n   * @return A promise that resolves to the current value in the sequence\n   */\n  abstract current(): Promise<string | number | bigint>;\n\n  /**\n   * @description Gets a range of sequential values\n   * @summary Retrieves multiple sequential values at once, which can be more efficient than calling next() multiple times\n   * @param {number} count - The number of sequential values to retrieve\n   * @return A promise that resolves to an array of sequential values\n   */\n  abstract range(count: number): Promise<(number | string | bigint)[]>;\n\n  /**\n   * @description Gets the primary key sequence name for a model\n   * @summary Utility method that returns the standardized sequence name for a model's primary key\n   * @template M - The model type\n   * @param {M|Constructor<M>} model - The model instance or constructor\n   * @return {string} The sequence name for the model's primary key\n   */\n  static pk<M extends Model>(model: M | Constructor<M>) {\n    return sequenceNameForModel(model, \"pk\");\n  }\n\n  /**\n   * @description Parses a sequence value to the appropriate type\n   * @summary Converts a sequence value to the specified type (Number or BigInt)\n   * @param {\"Number\"|\"BigInt\"|undefined} type - The target type to convert to\n   * @param {string|number|bigint} value - The value to convert\n   * @return {string|number|bigint} The converted value\n   */\n  static parseValue(\n    type: \"Number\" | \"BigInt\" | undefined,\n    value: string | number | bigint\n  ): string | number | bigint {\n    switch (type) {\n      case \"Number\":\n        return typeof value === \"string\"\n          ? parseInt(value)\n          : typeof value === \"number\"\n            ? value\n            : BigInt(value);\n      case \"BigInt\":\n        return BigInt(value);\n      default:\n        throw new InternalError(\"Should never happen\");\n    }\n  }\n}\n"]}