@decaf-ts/core 0.7.3 → 0.7.4

package/lib/ram/RamSequence.cjs

@@ -1,145 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RamSequence = void 0;
-const RamSequenceModel_1 = require("./model/RamSequenceModel.cjs");
-const db_decorators_1 = require("@decaf-ts/db-decorators");
-const persistence_1 = require("./../persistence/index.cjs");
-const repository_1 = require("./../repository/index.cjs");
-/**
- * @description RAM-specific sequence implementation
- * @summary Extends the base Sequence class to provide auto-incrementing sequence functionality
- * for the RAM adapter. This class manages sequences stored in memory, allowing for the generation
- * of sequential identifiers for entities.
- * @param {SequenceOptions} options - Configuration options for the sequence
- * @param {RamAdapter} adapter - The RAM adapter instance to use for storage
- * @class RamSequence
- * @category Ram
- * @example
- * ```typescript
- * // Create a new numeric sequence starting at 1
- * const sequence = new RamSequence({
- *   name: 'order_sequence',
- *   type: 'Number',
- *   startWith: 1,
- *   incrementBy: 1
- * }, ramAdapter);
- *
- * // Get the next value in the sequence
- * const nextId = await sequence.next();
- *
- * // Get a range of values
- * const idRange = await sequence.range(5); // Returns 5 sequential values
- * ```
- */
-class RamSequence extends persistence_1.Sequence {
-    constructor(options, adapter) {
-        super(options, adapter);
-        this.repo = repository_1.Repository.forModel(RamSequenceModel_1.RamSequenceModel, adapter.alias);
-    }
-    /**
-     * @description Retrieves the current value of the sequence
-     * @summary Gets the current value of the sequence from storage. If the sequence
-     * doesn't exist yet, it returns the configured starting value.
-     * @return A promise that resolves to the current sequence value
-     */
-    async current(...args) {
-        const contextArgs = await db_decorators_1.Context.args(db_decorators_1.OperationKeys.READ, RamSequenceModel_1.RamSequenceModel, args, this.adapter);
-        const ctx = contextArgs.context;
-        const { name, startWith } = this.options;
-        try {
-            const sequence = await this.repo.read(name, ctx);
-            return this.parse(sequence.current);
-        }
-        catch (e) {
-            if (e instanceof db_decorators_1.NotFoundError) {
-                if (typeof startWith === "undefined")
-                    throw new db_decorators_1.InternalError("Starting value is not defined for a non existing sequence");
-                try {
-                    return this.parse(startWith);
-                }
-                catch (e) {
-                    throw new db_decorators_1.InternalError(`Failed to parse initial value for sequence ${startWith}: ${e}`);
-                }
-            }
-            throw new db_decorators_1.InternalError(`Failed to retrieve current value for sequence ${name}: ${e}`);
-        }
-    }
-    /**
-     * @description Increments the sequence value
-     * @summary Increases the current sequence value by the specified amount and persists
-     * the new value to storage. This method handles both numeric and BigInt sequence types.
-     * @param {string | number | bigint} current - The current value of the sequence
-     * @param {number} [count] - Optional amount to increment by, defaults to the sequence's incrementBy value
-     * @return A promise that resolves to the new sequence value after incrementing
-     */
-    async increment(current, count, ctx) {
-        const { type, incrementBy, name } = this.options;
-        let next;
-        const toIncrementBy = count || incrementBy;
-        if (toIncrementBy % incrementBy !== 0)
-            throw new db_decorators_1.InternalError(`Value to increment does not consider the incrementBy setting: ${incrementBy}`);
-        switch (type) {
-            case "Number":
-                next = this.parse(current) + toIncrementBy;
-                break;
-            case "BigInt":
-                next = this.parse(current) + BigInt(toIncrementBy);
-                break;
-            case "String":
-                next = this.parse(current);
-                break;
-            default:
-                throw new db_decorators_1.InternalError("Should never happen");
-        }
-        let seq;
-        const repo = this.repo.override({
-            ignoredValidationProperties: ["updatedAt"],
-        });
-        try {
-            seq = await repo.update(new RamSequenceModel_1.RamSequenceModel({ id: name, current: next }), ctx);
-        }
-        catch (e) {
-            if (!(e instanceof db_decorators_1.NotFoundError)) {
-                throw e;
-            }
-            seq = await repo.create(new RamSequenceModel_1.RamSequenceModel({ id: name, current: next }), ctx);
-        }
-        return seq.current;
-    }
-    /**
-     * @description Gets the next value in the sequence
-     * @summary Retrieves the current value of the sequence and increments it by the
-     * configured increment amount. This is the main method used to get a new sequential value.
-     * @return A promise that resolves to the next value in the sequence
-     */
-    async next(...argz) {
-        const contextArgs = await db_decorators_1.Context.args(db_decorators_1.OperationKeys.UPDATE, RamSequenceModel_1.RamSequenceModel, argz, this.adapter);
-        const { context, args } = contextArgs;
-        const current = await this.current(...args);
-        return this.increment(current, undefined, context);
-    }
-    /**
-     * @description Generates a range of sequential values
-     * @summary Retrieves a specified number of sequential values from the sequence.
-     * This is useful when you need to allocate multiple IDs at once.
-     * The method increments the sequence by the total amount needed and returns all values in the range.
-     * @param {number} count - The number of sequential values to generate
-     * @return A promise that resolves to an array of sequential values
-     */
-    async range(count, ...argz) {
-        const contextArgs = await db_decorators_1.Context.args(db_decorators_1.OperationKeys.UPDATE, RamSequenceModel_1.RamSequenceModel, argz, this.adapter);
-        const { context, args } = contextArgs;
-        const current = (await this.current(...args));
-        const incrementBy = this.parse(this.options.incrementBy);
-        const next = await this.increment(current, this.parse(count) * incrementBy, context);
-        const range = [];
-        for (let i = 1; i <= count; i++) {
-            range.push(current + incrementBy * this.parse(i));
-        }
-        if (range[range.length - 1] !== next && this.options.type !== "String")
-            throw new db_decorators_1.InternalError("Miscalculation of range");
-        return range;
-    }
-}
-exports.RamSequence = RamSequence;
-//# sourceMappingURL=RamSequence.js.map

package/lib/ram/RamSequence.d.ts

@@ -1,68 +0,0 @@
-import { RamSequenceModel } from "./model/RamSequenceModel";
-import { Sequence } from "../persistence";
-import { SequenceOptions } from "../interfaces";
-import { RamAdapter } from "./RamAdapter";
-import { Repo } from "../repository";
-import { MaybeContextualArg } from "../utils/index";
-/**
- * @description RAM-specific sequence implementation
- * @summary Extends the base Sequence class to provide auto-incrementing sequence functionality
- * for the RAM adapter. This class manages sequences stored in memory, allowing for the generation
- * of sequential identifiers for entities.
- * @param {SequenceOptions} options - Configuration options for the sequence
- * @param {RamAdapter} adapter - The RAM adapter instance to use for storage
- * @class RamSequence
- * @category Ram
- * @example
- * ```typescript
- * // Create a new numeric sequence starting at 1
- * const sequence = new RamSequence({
- *   name: 'order_sequence',
- *   type: 'Number',
- *   startWith: 1,
- *   incrementBy: 1
- * }, ramAdapter);
- *
- * // Get the next value in the sequence
- * const nextId = await sequence.next();
- *
- * // Get a range of values
- * const idRange = await sequence.range(5); // Returns 5 sequential values
- * ```
- */
-export declare class RamSequence extends Sequence {
-    protected repo: Repo<RamSequenceModel>;
-    constructor(options: SequenceOptions, adapter: RamAdapter);
-    /**
-     * @description Retrieves the current value of the sequence
-     * @summary Gets the current value of the sequence from storage. If the sequence
-     * doesn't exist yet, it returns the configured starting value.
-     * @return A promise that resolves to the current sequence value
-     */
-    current(...args: MaybeContextualArg<any>): Promise<string | number | bigint>;
-    /**
-     * @description Increments the sequence value
-     * @summary Increases the current sequence value by the specified amount and persists
-     * the new value to storage. This method handles both numeric and BigInt sequence types.
-     * @param {string | number | bigint} current - The current value of the sequence
-     * @param {number} [count] - Optional amount to increment by, defaults to the sequence's incrementBy value
-     * @return A promise that resolves to the new sequence value after incrementing
-     */
-    private increment;
-    /**
-     * @description Gets the next value in the sequence
-     * @summary Retrieves the current value of the sequence and increments it by the
-     * configured increment amount. This is the main method used to get a new sequential value.
-     * @return A promise that resolves to the next value in the sequence
-     */
-    next(...argz: MaybeContextualArg<any>): Promise<number | string | bigint>;
-    /**
-     * @description Generates a range of sequential values
-     * @summary Retrieves a specified number of sequential values from the sequence.
-     * This is useful when you need to allocate multiple IDs at once.
-     * The method increments the sequence by the total amount needed and returns all values in the range.
-     * @param {number} count - The number of sequential values to generate
-     * @return A promise that resolves to an array of sequential values
-     */
-    range(count: number, ...argz: MaybeContextualArg<any>): Promise<(number | string | bigint)[]>;
-}

package/lib/ram/RamSequence.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"RamSequence.js","sourceRoot":"","sources":["../../src/ram/RamSequence.ts"],"names":[],"mappings":";;;AAAA,mEAA4D;AAC5D,2DAKiC;AACjC,4DAA0C;AAG1C,0DAAiD;AAGjD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAa,WAAY,SAAQ,sBAAQ;IAGvC,YAAY,OAAwB,EAAE,OAAmB;QACvD,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,mCAAgB,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;IACnE,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAO,CACX,GAAG,IAA6B;QAEhC,MAAM,WAAW,GAAG,MAAM,uBAAO,CAAC,IAAI,CACpC,6BAAa,CAAC,IAAI,EAClB,mCAAgB,EAChB,IAAI,EACJ,IAAI,CAAC,OAAO,CACb,CAAC;QACF,MAAM,GAAG,GAAG,WAAW,CAAC,OAAO,CAAC;QAChC,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QACzC,IAAI,CAAC;YACH,MAAM,QAAQ,GAAqB,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CACrD,IAAc,EACd,GAAG,CACJ,CAAC;YACF,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,OAA0B,CAAC,CAAC;QACzD,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,IAAI,CAAC,YAAY,6BAAa,EAAE,CAAC;gBAC/B,IAAI,OAAO,SAAS,KAAK,WAAW;oBAClC,MAAM,IAAI,6BAAa,CACrB,2DAA2D,CAC5D,CAAC;gBACJ,IAAI,CAAC;oBACH,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;gBAC/B,CAAC;gBAAC,OAAO,CAAM,EAAE,CAAC;oBAChB,MAAM,IAAI,6BAAa,CACrB,8CAA8C,SAAS,KAAK,CAAC,EAAE,CAChE,CAAC;gBACJ,CAAC;YACH,CAAC;YACD,MAAM,IAAI,6BAAa,CACrB,iDAAiD,IAAI,KAAK,CAAC,EAAE,CAC9D,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACK,KAAK,CAAC,SAAS,CACrB,OAAiC,EACjC,KAAyB,EACzB,GAAiB;QAEjB,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QACjD,IAAI,IAA8B,CAAC;QACnC,MAAM,aAAa,GAAG,KAAK,IAAI,WAAW,CAAC;QAC3C,IAAI,aAAa,GAAG,WAAW,KAAK,CAAC;YACnC,MAAM,IAAI,6BAAa,CACrB,iEAAiE,WAAW,EAAE,CAC/E,CAAC;QACJ,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,QAAQ;gBACX,IAAI,GAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAY,GAAG,aAAa,CAAC;gBACvD,MAAM;YACR,KAAK,QAAQ;gBACX,IAAI,GAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAY,GAAG,MAAM,CAAC,aAAa,CAAC,CAAC;gBAC/D,MAAM;YACR,KAAK,QAAQ;gBACX,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBAC3B,MAAM;YACR;gBACE,MAAM,IAAI,6BAAa,CAAC,qBAAqB,CAAC,CAAC;QACnD,CAAC;QACD,IAAI,GAAqB,CAAC;QAC1B,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;YAC9B,2BAA2B,EAAE,CAAC,WAAW,CAAC;SAC3C,CAAC,CAAC;QACH,IAAI,CAAC;YACH,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CACrB,IAAI,mCAAgB,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,EACjD,GAAG,CACJ,CAAC;QACJ,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,IAAI,CAAC,CAAC,CAAC,YAAY,6BAAa,CAAC,EAAE,CAAC;gBAClC,MAAM,CAAC,CAAC;YACV,CAAC;YACD,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CACrB,IAAI,mCAAgB,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,EACjD,GAAG,CACJ,CAAC;QACJ,CAAC;QAED,OAAO,GAAG,CAAC,OAAmC,CAAC;IACjD,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CACR,GAAG,IAA6B;QAEhC,MAAM,WAAW,GAAG,MAAM,uBAAO,CAAC,IAAI,CACpC,6BAAa,CAAC,MAAM,EACpB,mCAAgB,EAChB,IAAI,EACJ,IAAI,CAAC,OAAO,CACb,CAAC;QACF,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC;QACtC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,KAAK,CACT,KAAa,EACb,GAAG,IAA6B;QAEhC,MAAM,WAAW,GAAG,MAAM,uBAAO,CAAC,IAAI,CACpC,6BAAa,CAAC,MAAM,EACpB,mCAAgB,EAChB,IAAI,EACJ,IAAI,CAAC,OAAO,CACb,CAAC;QACF,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC;QACtC,MAAM,OAAO,GAAG,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAW,CAAC;QACxD,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAC5B,IAAI,CAAC,OAAO,CAAC,WAAqB,CACzB,CAAC;QACZ,MAAM,IAAI,GAA6B,MAAM,IAAI,CAAC,SAAS,CACzD,OAAO,EACN,IAAI,CAAC,KAAK,CAAC,KAAK,CAAY,GAAG,WAAW,EAC3C,OAAO,CACR,CAAC;QACF,MAAM,KAAK,GAAiC,EAAE,CAAC;QAC/C,KAAK,IAAI,CAAC,GAAW,CAAC,EAAE,CAAC,IAAI,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;YACxC,KAAK,CAAC,IAAI,CAAC,OAAO,GAAG,WAAW,GAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAY,CAAC,CAAC;QAChE,CAAC;QACD,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,IAAI,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,QAAQ;YACpE,MAAM,IAAI,6BAAa,CAAC,yBAAyB,CAAC,CAAC;QACrD,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAlKD,kCAkKC"}

package/lib/ram/model/RamSequenceModel.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"RamSequenceModel.js","sourceRoot":"","sources":["../../../src/ram/model/RamSequenceModel.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yEAAiE;AAEjE,mDAAsD;AACtD,yDAAoC;AAEpC;;;;;;;;;;;;;;;;;GAiBG;AAGI,IAAM,gBAAgB,GAAtB,MAAM,gBAAiB,SAAQ,iBAAS;IAe7C,YAAY,GAAgC;QAC1C,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF,CAAA;AAlBY,4CAAgB;AAK3B;IADC,IAAA,aAAE,GAAE;;4CACO;AAQZ;IAFC,IAAA,+BAAQ,GAAE;IACV,IAAA,aAAK,GAAE;;iDACkB;2BAbf,gBAAgB;IAF5B,IAAA,aAAK,EAAC,eAAe,CAAC;IACtB,IAAA,4BAAK,GAAE;;GACK,gBAAgB,CAkB5B"}

package/lib/ram/model/index.cjs

@@ -1,18 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./RamSequenceModel.cjs"), exports);
-//# sourceMappingURL=index.js.map

package/lib/ram/model/index.d.ts

@@ -1 +0,0 @@
-export * from "./RamSequenceModel";

package/lib/ram/model/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/ram/model/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yDAAmC"}