@decaf-ts/core 0.5.1 → 0.5.3

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

@@ -1,7 +1,32 @@
 import type { ModelArg } from "@decaf-ts/decorator-validation";
 import { BaseModel } from "../../model";
+/**
+ * @description RAM sequence model for auto-incrementing values
+ * @summary A model class that represents a sequence in the RAM adapter. It stores the current value
+ * of a sequence that can be used for generating sequential identifiers for entities.
+ * The sequence is identified by its ID and maintains the current value.
+ * @param {ModelArg<Sequence>} seq - Initial sequence data
+ * @class Sequence
+ * @category Ram
+ * @example
+ * ```typescript
+ * // Create a new sequence
+ * const orderSequence = new Sequence({ id: 'order_seq', current: 1 });
+ *
+ * // Use the sequence to get the next value
+ * const nextOrderId = parseInt(orderSequence.current.toString()) + 1;
+ * orderSequence.current = nextOrderId;
+ * ```
+ */
 export declare class Sequence extends BaseModel {
+    /**
+     * @description Primary key identifier for the sequence
+     */
     id: string;
+    /**
+     * @description Current value of the sequence
+     * Used to generate the next sequential value
+     */
     current: string | number;
     constructor(seq?: ModelArg<Sequence>);
 }

package/lib/ram/types.cjs

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvcmFtL3R5cGVzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBDb25zdHJ1Y3RvciwgTW9kZWwgfSBmcm9tIFwiQGRlY2FmLXRzL2RlY29yYXRvci12YWxpZGF0aW9uXCI7XG5pbXBvcnQgeyBSZXBvc2l0b3J5IH0gZnJvbSBcIi4uL3JlcG9zaXRvcnlcIjtcbmltcG9ydCB7IENvbnRleHQsIFJlcG9zaXRvcnlGbGFncyB9IGZyb20gXCJAZGVjYWYtdHMvZGItZGVjb3JhdG9yc1wiO1xuaW1wb3J0IHsgUmFtQWRhcHRlciB9IGZyb20gXCIuL1JhbUFkYXB0ZXJcIjtcblxuZXhwb3J0IHR5cGUgUmFtU3RvcmFnZSA9IE1hcDxzdHJpbmcsIE1hcDxzdHJpbmcgfCBudW1iZXIsIGFueT4+O1xuXG5leHBvcnQgdHlwZSBSYXdSYW1RdWVyeTxNIGV4dGVuZHMgTW9kZWw+ID0ge1xuICBzZWxlY3Q6IHVuZGVmaW5lZCB8IChrZXlvZiBNKVtdO1xuICBmcm9tOiBDb25zdHJ1Y3RvcjxNPjtcbiAgd2hlcmU6IChlbDogTSkgPT4gYm9vbGVhbjtcbiAgc29ydD86IChlbDogTSwgZWwyOiBNKSA9PiBudW1iZXI7XG4gIGxpbWl0PzogbnVtYmVyO1xuICBza2lwPzogbnVtYmVyO1xufTtcblxuZXhwb3J0IGludGVyZmFjZSBSYW1GbGFncyBleHRlbmRzIFJlcG9zaXRvcnlGbGFncyB7XG4gIFVVSUQ6IHN0cmluZztcbn1cblxuZXhwb3J0IHR5cGUgUmFtUmVwb3NpdG9yeTxNIGV4dGVuZHMgTW9kZWw+ID0gUmVwb3NpdG9yeTxcbiAgTSxcbiAgUmF3UmFtUXVlcnk8YW55PixcbiAgUmFtQWRhcHRlcixcbiAgUmFtRmxhZ3MsXG4gIENvbnRleHQ8UmFtRmxhZ3M+XG4+O1xuIl19
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvcmFtL3R5cGVzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBDb25zdHJ1Y3RvciwgTW9kZWwgfSBmcm9tIFwiQGRlY2FmLXRzL2RlY29yYXRvci12YWxpZGF0aW9uXCI7XG5pbXBvcnQgeyBSZXBvc2l0b3J5IH0gZnJvbSBcIi4uL3JlcG9zaXRvcnlcIjtcbmltcG9ydCB7IENvbnRleHQsIFJlcG9zaXRvcnlGbGFncyB9IGZyb20gXCJAZGVjYWYtdHMvZGItZGVjb3JhdG9yc1wiO1xuaW1wb3J0IHsgUmFtQWRhcHRlciB9IGZyb20gXCIuL1JhbUFkYXB0ZXJcIjtcblxuLyoqXG4gKiBAZGVzY3JpcHRpb24gSW4tbWVtb3J5IHN0b3JhZ2Ugc3RydWN0dXJlIGZvciB0aGUgUkFNIGFkYXB0ZXJcbiAqIEBzdW1tYXJ5IEEgbmVzdGVkIE1hcCBzdHJ1Y3R1cmUgdGhhdCBzdG9yZXMgYWxsIGVudGl0aWVzIGJ5IHRoZWlyIHRhYmxlIG5hbWUgYW5kIHByaW1hcnkga2V5LlxuICogVGhlIG91dGVyIE1hcCB1c2VzIHRhYmxlIG5hbWVzIGFzIGtleXMsIHdoaWxlIHRoZSBpbm5lciBNYXAgdXNlcyBlbnRpdHkgSURzIGFzIGtleXMgYW5kIGVudGl0eSBpbnN0YW5jZXMgYXMgdmFsdWVzLlxuICogQHR5cGVkZWYge01hcDxzdHJpbmcsIE1hcDxzdHJpbmcgfCBudW1iZXIsIGFueT4+fSBSYW1TdG9yYWdlXG4gKiBAbWVtYmVyT2YgbW9kdWxlOmNvcmVcbiAqIEBjYXRlZ29yeSBSYW1cbiAqL1xuZXhwb3J0IHR5cGUgUmFtU3RvcmFnZSA9IE1hcDxzdHJpbmcsIE1hcDxzdHJpbmcgfCBudW1iZXIsIGFueT4+O1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBRdWVyeSBzcGVjaWZpY2F0aW9uIGZvciBSQU0gYWRhcHRlclxuICogQHN1bW1hcnkgRGVmaW5lcyB0aGUgc3RydWN0dXJlIG9mIGEgcXVlcnkgZm9yIHJldHJpZXZpbmcgZGF0YSBmcm9tIHRoZSBpbi1tZW1vcnkgc3RvcmFnZS5cbiAqIEl0IHNwZWNpZmllcyB3aGF0IGZpZWxkcyB0byBzZWxlY3QsIHdoaWNoIG1vZGVsIHRvIHF1ZXJ5LCBmaWx0ZXJpbmcgY29uZGl0aW9ucyxcbiAqIHNvcnRpbmcgY3JpdGVyaWEsIGFuZCBwYWdpbmF0aW9uIG9wdGlvbnMuXG4gKiBAdGVtcGxhdGUgTSAtIFRoZSBtb2RlbCB0eXBlIGJlaW5nIHF1ZXJpZWRcbiAqIEB0eXBlZGVmIHtPYmplY3R9IFJhd1JhbVF1ZXJ5XG4gKiBAcHJvcGVydHkgc2VsZWN0IC0gRmllbGRzIHRvIHNlbGVjdCBmcm9tIHRoZSBtb2RlbCwgb3IgdW5kZWZpbmVkIGZvciBhbGwgZmllbGRzXG4gKiBAcHJvcGVydHkge0NvbnN0cnVjdG9yPE0+fSBmcm9tIC0gVGhlIG1vZGVsIGNvbnN0cnVjdG9yIHRvIHF1ZXJ5XG4gKiBAcHJvcGVydHkge2Z1bmN0aW9uKE0pOiBib29sZWFufSB3aGVyZSAtIFByZWRpY2F0ZSBmdW5jdGlvbiBmb3IgZmlsdGVyaW5nIGVudGl0aWVzXG4gKiBAcHJvcGVydHkge2Z1bmN0aW9uKE0sIE0pOiBudW1iZXJ9IFtzb3J0XSAtIE9wdGlvbmFsIGNvbXBhcmF0b3IgZnVuY3Rpb24gZm9yIHNvcnRpbmcgcmVzdWx0c1xuICogQHByb3BlcnR5IHtudW1iZXJ9IFtsaW1pdF0gLSBPcHRpb25hbCBtYXhpbXVtIG51bWJlciBvZiByZXN1bHRzIHRvIHJldHVyblxuICogQHByb3BlcnR5IHtudW1iZXJ9IFtza2lwXSAtIE9wdGlvbmFsIG51bWJlciBvZiByZXN1bHRzIHRvIHNraXAgKGZvciBwYWdpbmF0aW9uKVxuICogQG1lbWJlck9mIG1vZHVsZTpjb3JlXG4gKiBAY2F0ZWdvcnkgUmFtXG4gKi9cbmV4cG9ydCB0eXBlIFJhd1JhbVF1ZXJ5PE0gZXh0ZW5kcyBNb2RlbD4gPSB7XG4gIHNlbGVjdDogdW5kZWZpbmVkIHwgKGtleW9mIE0pW107XG4gIGZyb206IENvbnN0cnVjdG9yPE0+O1xuICB3aGVyZTogKGVsOiBNKSA9PiBib29sZWFuO1xuICBzb3J0PzogKGVsOiBNLCBlbDI6IE0pID0+IG51bWJlcjtcbiAgbGltaXQ/OiBudW1iZXI7XG4gIHNraXA/OiBudW1iZXI7XG59O1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBGbGFncyBmb3IgUkFNIGFkYXB0ZXIgb3BlcmF0aW9uc1xuICogQHN1bW1hcnkgSW50ZXJmYWNlIHRoYXQgZXh0ZW5kcyB0aGUgYmFzZSByZXBvc2l0b3J5IGZsYWdzIHdpdGggUkFNLXNwZWNpZmljIGZsYWdzLlxuICogQ29udGFpbnMgdXNlciBpZGVudGlmaWNhdGlvbiBpbmZvcm1hdGlvbiBuZWVkZWQgZm9yIHRyYWNraW5nIGVudGl0eSBjcmVhdGlvbiBhbmQgdXBkYXRlcy5cbiAqIEBpbnRlcmZhY2UgUmFtRmxhZ3NcbiAqIEBwcm9wZXJ0eSB7c3RyaW5nfSBVVUlEIC0gVW5pcXVlIGlkZW50aWZpZXIgZm9yIHRoZSBjdXJyZW50IHVzZXJcbiAqIEBtZW1iZXJPZiBtb2R1bGU6Y29yZVxuICogQGNhdGVnb3J5IFJhbVxuICovXG5leHBvcnQgaW50ZXJmYWNlIFJhbUZsYWdzIGV4dGVuZHMgUmVwb3NpdG9yeUZsYWdzIHtcbiAgVVVJRDogc3RyaW5nO1xufVxuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBUeXBlIGRlZmluaXRpb24gZm9yIFJBTS1zcGVjaWZpYyByZXBvc2l0b3J5XG4gKiBAc3VtbWFyeSBBIHNwZWNpYWxpemVkIHJlcG9zaXRvcnkgdHlwZSBmb3Igd29ya2luZyB3aXRoIG1vZGVscyBpbiB0aGUgUkFNIGFkYXB0ZXIuXG4gKiBJdCBjb21iaW5lcyB0aGUgbW9kZWwgdHlwZSB3aXRoIFJBTS1zcGVjaWZpYyBxdWVyeSwgYWRhcHRlciwgZmxhZ3MsIGFuZCBjb250ZXh0IHR5cGVzLlxuICogQHRlbXBsYXRlIE0gLSBUaGUgbW9kZWwgdHlwZSBtYW5hZ2VkIGJ5IHRoZSByZXBvc2l0b3J5XG4gKiBAdHlwZWRlZiB7UmVwb3NpdG9yeTxNLCBSYXdSYW1RdWVyeTxhbnk+LCBSYW1BZGFwdGVyLCBSYW1GbGFncywgQ29udGV4dDxSYW1GbGFncz4+fSBSYW1SZXBvc2l0b3J5XG4gKiBAbWVtYmVyT2YgbW9kdWxlOmNvcmVcbiAqIEBjYXRlZ29yeSBSYW1cbiAqL1xuZXhwb3J0IHR5cGUgUmFtUmVwb3NpdG9yeTxNIGV4dGVuZHMgTW9kZWw+ID0gUmVwb3NpdG9yeTxcbiAgTSxcbiAgUmF3UmFtUXVlcnk8YW55PixcbiAgUmFtQWRhcHRlcixcbiAgUmFtRmxhZ3MsXG4gIENvbnRleHQ8UmFtRmxhZ3M+XG4+O1xuIl19

package/lib/ram/types.d.ts

@@ -2,7 +2,31 @@ import { Constructor, Model } from "@decaf-ts/decorator-validation";
 import { Repository } from "../repository";
 import { Context, RepositoryFlags } from "@decaf-ts/db-decorators";
 import { RamAdapter } from "./RamAdapter";
+/**
+ * @description In-memory storage structure for the RAM adapter
+ * @summary A nested Map structure that stores all entities by their table name and primary key.
+ * The outer Map uses table names as keys, while the inner Map uses entity IDs as keys and entity instances as values.
+ * @typedef {Map<string, Map<string | number, any>>} RamStorage
+ * @memberOf module:core
+ * @category Ram
+ */
 export type RamStorage = Map<string, Map<string | number, any>>;
+/**
+ * @description Query specification for RAM adapter
+ * @summary Defines the structure of a query for retrieving data from the in-memory storage.
+ * It specifies what fields to select, which model to query, filtering conditions,
+ * sorting criteria, and pagination options.
+ * @template M - The model type being queried
+ * @typedef {Object} RawRamQuery
+ * @property select - Fields to select from the model, or undefined for all fields
+ * @property {Constructor<M>} from - The model constructor to query
+ * @property {function(M): boolean} where - Predicate function for filtering entities
+ * @property {function(M, M): number} [sort] - Optional comparator function for sorting results
+ * @property {number} [limit] - Optional maximum number of results to return
+ * @property {number} [skip] - Optional number of results to skip (for pagination)
+ * @memberOf module:core
+ * @category Ram
+ */
 export type RawRamQuery<M extends Model> = {
     select: undefined | (keyof M)[];
     from: Constructor<M>;
@@ -11,7 +35,25 @@ export type RawRamQuery<M extends Model> = {
     limit?: number;
     skip?: number;
 };
+/**
+ * @description Flags for RAM adapter operations
+ * @summary Interface that extends the base repository flags with RAM-specific flags.
+ * Contains user identification information needed for tracking entity creation and updates.
+ * @interface RamFlags
+ * @property {string} UUID - Unique identifier for the current user
+ * @memberOf module:core
+ * @category Ram
+ */
 export interface RamFlags extends RepositoryFlags {
     UUID: string;
 }
+/**
+ * @description Type definition for RAM-specific repository
+ * @summary A specialized repository type for working with models in the RAM adapter.
+ * It combines the model type with RAM-specific query, adapter, flags, and context types.
+ * @template M - The model type managed by the repository
+ * @typedef {Repository<M, RawRamQuery<any>, RamAdapter, RamFlags, Context<RamFlags>>} RamRepository
+ * @memberOf module:core
+ * @category Ram
+ */
 export type RamRepository<M extends Model> = Repository<M, RawRamQuery<any>, RamAdapter, RamFlags, Context<RamFlags>>;