@decaf-ts/core 0.18.0 → 0.19.0

package/lib/types/ram/handlers.d.cts

@@ -0,0 +1,24 @@
+import { Model } from "@decaf-ts/decorator-validation";
+import { RelationsMetadata } from "../model/index.cjs";
+import { RamRepository } from "./types.cjs";
+import { ContextOf } from "../persistence/index.cjs";
+/**
+ * @description Sets the created by field on a model during RAM create/update operations
+ * @summary Automatically populates a model field with the UUID from the context during create or update operations.
+ * This function is designed to be used as a handler for RAM operations to track entity creation.
+ * @template M - Type of the model being created/updated
+ * @template R - Type of the repository handling the model
+ * @template V - Type of the relations metadata
+ * @template F - Type of the RAM flags
+ * @template C - Type of the context
+ * @param {R} this - The repository instance
+ * @param {Context<F>} context - The operation context containing user identification
+ * @param {V} data - The relations metadata
+ * @param key - The property key to set with the UUID
+ * @param {M} model - The model instance being created/updated
+ * @return {Promise<void>} A promise that resolves when the field has been set
+ * @function createdByOnRamCreateUpdate
+ * @memberOf module:core
+ * @category Ram
+ */
+export declare function createdByOnRamCreateUpdate<M extends Model, R extends RamRepository<M>>(this: R, context: ContextOf<R>, data: RelationsMetadata, key: keyof M, model: M): Promise<void>;

package/lib/types/ram/handlers.d.mts

@@ -0,0 +1,24 @@
+import { Model } from "@decaf-ts/decorator-validation";
+import { RelationsMetadata } from "../model/index.js";
+import { RamRepository } from "./types.js";
+import { ContextOf } from "../persistence/index.js";
+/**
+ * @description Sets the created by field on a model during RAM create/update operations
+ * @summary Automatically populates a model field with the UUID from the context during create or update operations.
+ * This function is designed to be used as a handler for RAM operations to track entity creation.
+ * @template M - Type of the model being created/updated
+ * @template R - Type of the repository handling the model
+ * @template V - Type of the relations metadata
+ * @template F - Type of the RAM flags
+ * @template C - Type of the context
+ * @param {R} this - The repository instance
+ * @param {Context<F>} context - The operation context containing user identification
+ * @param {V} data - The relations metadata
+ * @param key - The property key to set with the UUID
+ * @param {M} model - The model instance being created/updated
+ * @return {Promise<void>} A promise that resolves when the field has been set
+ * @function createdByOnRamCreateUpdate
+ * @memberOf module:core
+ * @category Ram
+ */
+export declare function createdByOnRamCreateUpdate<M extends Model, R extends RamRepository<M>>(this: R, context: ContextOf<R>, data: RelationsMetadata, key: keyof M, model: M): Promise<void>;

package/lib/types/ram/index.d.cts

@@ -0,0 +1,12 @@
+/**
+ * @description Exports for the ram module.
+ * @summary This file exports all the necessary components for the ram functionality, including the RamAdapter, constants, handlers, and more.
+ * @module core/ram
+ */
+import "../overrides";
+export * from "./constants.cjs";
+export * from "./handlers.cjs";
+export * from "./RamPaginator.cjs";
+export * from "./RamStatement.cjs";
+export * from "./types.cjs";
+export * from "./RamAdapter.cjs";

package/lib/types/ram/index.d.mts

@@ -0,0 +1,12 @@
+/**
+ * @description Exports for the ram module.
+ * @summary This file exports all the necessary components for the ram functionality, including the RamAdapter, constants, handlers, and more.
+ * @module core/ram
+ */
+import "../overrides";
+export * from "./constants.js";
+export * from "./handlers.js";
+export * from "./RamPaginator.js";
+export * from "./RamStatement.js";
+export * from "./types.js";
+export * from "./RamAdapter.js";

package/lib/types/ram/types.d.cts

@@ -0,0 +1,50 @@
+import { Model } from "@decaf-ts/decorator-validation";
+import { Repository } from "../repository/index.cjs";
+import { Constructor } from "@decaf-ts/decoration";
+import { Adapter, AdapterFlags } from "../persistence/index.cjs";
+import { Context } from "../persistence/Context.cjs";
+import { MultiLock } from "@decaf-ts/transactional-decorators";
+import { PrimaryKeyType } from "@decaf-ts/db-decorators";
+/**
+ * @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<PrimaryKeyType, any>>;
+export type RawRamQuery<M extends Model = any> = {
+    select: undefined | (keyof M)[];
+    from: Constructor<M>;
+    where: (el: M) => boolean;
+    sort?: (el: M, el2: M) => number;
+    groupBy?: (keyof M)[];
+    limit?: number;
+    skip?: number;
+    count?: keyof M | null;
+    countDistinct?: keyof M;
+    min?: keyof M;
+    max?: keyof M;
+    sum?: keyof M;
+    avg?: keyof M;
+    distinct?: keyof M;
+};
+/**
+ * @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 AdapterFlags {
+    UUID: string;
+}
+export type RamRepository<M extends Model<boolean>> = Repository<M, Adapter<RamConfig, RamStorage, RawRamQuery<any>, RamContext>>;
+export type RamContext = Context<RamFlags>;
+export type RamConfig = {
+    user: string;
+    lock?: MultiLock;
+};

package/lib/types/ram/types.d.mts

@@ -0,0 +1,50 @@
+import { Model } from "@decaf-ts/decorator-validation";
+import { Repository } from "../repository/index.js";
+import { Constructor } from "@decaf-ts/decoration";
+import { Adapter, AdapterFlags } from "../persistence/index.js";
+import { Context } from "../persistence/Context.js";
+import { MultiLock } from "@decaf-ts/transactional-decorators";
+import { PrimaryKeyType } from "@decaf-ts/db-decorators";
+/**
+ * @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<PrimaryKeyType, any>>;
+export type RawRamQuery<M extends Model = any> = {
+    select: undefined | (keyof M)[];
+    from: Constructor<M>;
+    where: (el: M) => boolean;
+    sort?: (el: M, el2: M) => number;
+    groupBy?: (keyof M)[];
+    limit?: number;
+    skip?: number;
+    count?: keyof M | null;
+    countDistinct?: keyof M;
+    min?: keyof M;
+    max?: keyof M;
+    sum?: keyof M;
+    avg?: keyof M;
+    distinct?: keyof M;
+};
+/**
+ * @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 AdapterFlags {
+    UUID: string;
+}
+export type RamRepository<M extends Model<boolean>> = Repository<M, Adapter<RamConfig, RamStorage, RawRamQuery<any>, RamContext>>;
+export type RamContext = Context<RamFlags>;
+export type RamConfig = {
+    user: string;
+    lock?: MultiLock;
+};