@venizia/ignis 0.0.5-2 → 0.0.5-20

package/dist/base/models/enrichers/user-audit.enricher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"user-audit.enricher.d.ts","sourceRoot":"","sources":["../../../../src/base/models/enrichers/user-audit.enricher.ts"],"names":[],"mappings":"AACA,OAAO,EAAW,uBAAuB,EAAE,oBAAoB,EAAQ,MAAM,qBAAqB,CAAC;AACnG,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAErD,KAAK,oBAAoB,GAAG;IAC1B,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAC9B,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,OAAO,CAAC,EAAE,oBAAoB,CAAC;IAC/B,QAAQ,CAAC,EAAE,oBAAoB,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,wBAAwB,CAClC,iBAAiB,SAAS,kBAAkB,GAAG,kBAAkB,IAC/D,iBAAiB,GAAG;IACtB,SAAS,EAAE,uBAAuB,CAAC,MAAM,CAAC,GAAG,oBAAoB,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC,CAAC;IACjG,UAAU,EAAE,uBAAuB,CAAC,MAAM,CAAC,GAAG,oBAAoB,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC,CAAC;CACnG,CAAC;AAsBF,eAAO,MAAM,2BAA2B,GAAI,OAAO,yBAAyB;;;CAgB3E,CAAC;AAEF,eAAO,MAAM,eAAe,GAAI,iBAAiB,SAAS,kBAAkB,GAAG,kBAAkB,EAC/F,YAAY,iBAAiB,EAC7B,OAAO,yBAAyB,KAC/B,wBAAwB,CAAC,iBAAiB,CAG5C,CAAC"}
+{"version":3,"file":"user-audit.enricher.d.ts","sourceRoot":"","sources":["../../../../src/base/models/enrichers/user-audit.enricher.ts"],"names":[],"mappings":"AACA,OAAO,EAAW,uBAAuB,EAAE,oBAAoB,EAAQ,MAAM,qBAAqB,CAAC;AAGnG,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAErD,KAAK,oBAAoB,GAAG;IAC1B,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAC9B,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,OAAO,CAAC,EAAE,oBAAoB,CAAC;IAC/B,QAAQ,CAAC,EAAE,oBAAoB,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,wBAAwB,CAClC,iBAAiB,SAAS,kBAAkB,GAAG,kBAAkB,IAC/D,iBAAiB,GAAG;IACtB,SAAS,EAAE,uBAAuB,CAAC,MAAM,CAAC,GAAG,oBAAoB,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC,CAAC;IACjG,UAAU,EAAE,uBAAuB,CAAC,MAAM,CAAC,GAAG,oBAAoB,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC,CAAC;CACnG,CAAC;AAyEF,eAAO,MAAM,2BAA2B,GAAI,OAAO,yBAAyB;;;CAU3E,CAAC;AAEF,eAAO,MAAM,eAAe,GAAI,iBAAiB,SAAS,kBAAkB,GAAG,kBAAkB,EAC/F,YAAY,iBAAiB,EAC7B,OAAO,yBAAyB,KAC/B,wBAAwB,CAAC,iBAAiB,CAG5C,CAAC"}

package/dist/base/models/enrichers/user-audit.enricher.js

@@ -3,14 +3,56 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.enrichUserAudit = exports.generateUserAuditColumnDefs = void 0;
 const ignis_helpers_1 = require("@venizia/ignis-helpers");
 const pg_core_1 = require("drizzle-orm/pg-core");
+const context_storage_1 = require("hono/context-storage");
+const common_1 = require("../../../components/auth/authenticate/common");
+/**
+ * Get current user ID from Hono context storage.
+ * Returns null if context unavailable (background jobs, migrations, tests).
+ *
+ * CAUTIONS: if using fire-and-forget promise, this could be run outside of async context => cannot detect AUDIT_USER_ID
+ */
+const getCurrentUserId = (opts) => {
+    const context = (0, context_storage_1.tryGetContext)();
+    if (!context) {
+        if (!opts.allowAnonymous) {
+            throw (0, ignis_helpers_1.getError)({
+                message: `[getCurrentUserId] Invalid request context to identify user | columnName: ${opts.columnField} | allowAnonymous: ${opts.allowAnonymous}`,
+            });
+        }
+        return null;
+    }
+    const userId = context.get(common_1.Authentication.AUDIT_USER_ID);
+    if (!userId && !opts.allowAnonymous) {
+        throw (0, ignis_helpers_1.getError)({
+            message: `[getCurrentUserId] No AUDIT_USER_ID found in request context | columnName: ${opts.columnField} | allowAnonymous: ${opts.allowAnonymous} | userId: ${userId}`,
+        });
+    }
+    return userId ?? null;
+};
 const buildUserAuditColumn = (opts) => {
     const { columnOpts, columnField } = opts;
     switch (columnOpts.dataType) {
         case 'number': {
-            return (0, pg_core_1.integer)(columnOpts.columnName);
+            const col = (0, pg_core_1.integer)(columnOpts.columnName).$type();
+            const userIdGetter = () => getCurrentUserId({
+                columnField,
+                allowAnonymous: columnOpts.allowAnonymous ?? true,
+            });
+            // createdBy: only set on creation | modifiedBy: set on creation AND update
+            return columnField === 'createdBy'
+                ? col.$default(userIdGetter)
+                : col.$default(userIdGetter).$onUpdate(userIdGetter);
         }
         case 'string': {
-            return (0, pg_core_1.text)(columnOpts.columnName);
+            const col = (0, pg_core_1.text)(columnOpts.columnName).$type();
+            const userIdGetter = () => getCurrentUserId({
+                columnField,
+                allowAnonymous: columnOpts.allowAnonymous ?? true,
+            });
+            // createdBy: only set on creation | modifiedBy: set on creation AND update
+            return columnField === 'createdBy'
+                ? col.$default(userIdGetter)
+                : col.$default(userIdGetter).$onUpdate(userIdGetter);
         }
         default: {
             throw (0, ignis_helpers_1.getError)({
@@ -20,16 +62,10 @@ const buildUserAuditColumn = (opts) => {
     }
 };
 const generateUserAuditColumnDefs = (opts) => {
-    const { created = { dataType: 'number', columnName: 'created_by' }, modified = { dataType: 'number', columnName: 'modified_by' }, } = opts ?? {};
+    const { created = { dataType: 'number', columnName: 'created_by', allowAnonymous: true }, modified = { dataType: 'number', columnName: 'modified_by', allowAnonymous: true }, } = opts ?? {};
     return {
-        createdBy: buildUserAuditColumn({
-            columnOpts: created,
-            columnField: 'createdBy',
-        }),
-        modifiedBy: buildUserAuditColumn({
-            columnOpts: modified,
-            columnField: 'modifiedBy',
-        }),
+        createdBy: buildUserAuditColumn({ columnOpts: created, columnField: 'createdBy' }),
+        modifiedBy: buildUserAuditColumn({ columnOpts: modified, columnField: 'modifiedBy' }),
     };
 };
 exports.generateUserAuditColumnDefs = generateUserAuditColumnDefs;

package/dist/base/models/enrichers/user-audit.enricher.js.map

@@ -1 +1 @@
-{"version":3,"file":"user-audit.enricher.js","sourceRoot":"","sources":["../../../../src/base/models/enrichers/user-audit.enricher.ts"],"names":[],"mappings":";;;AAAA,0DAAkD;AAClD,iDAAmG;AAoBnG,MAAM,oBAAoB,GAAG,CAAC,IAG7B,EAAE,EAAE;IACH,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;IACzC,QAAQ,UAAU,CAAC,QAAQ,EAAE,CAAC;QAC5B,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,OAAO,IAAA,iBAAO,EAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QACxC,CAAC;QACD,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,OAAO,IAAA,cAAI,EAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QACrC,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,IAAA,wBAAQ,EAAC;gBACb,OAAO,EAAE,2CAA2C,WAAW,cAAe,UAAmC,CAAC,QAAQ,gCAAgC;aAC3J,CAAC,CAAC;QACL,CAAC;IACH,CAAC;AACH,CAAC,CAAC;AAEK,MAAM,2BAA2B,GAAG,CAAC,IAAgC,EAAE,EAAE;IAC9E,MAAM,EACJ,OAAO,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,YAAY,EAAE,EAC1D,QAAQ,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,aAAa,EAAE,GAC7D,GAAG,IAAI,IAAI,EAAE,CAAC;IAEf,OAAO;QACL,SAAS,EAAE,oBAAoB,CAAC;YAC9B,UAAU,EAAE,OAAO;YACnB,WAAW,EAAE,WAAW;SACzB,CAAC;QACF,UAAU,EAAE,oBAAoB,CAAC;YAC/B,UAAU,EAAE,QAAQ;YACpB,WAAW,EAAE,YAAY;SAC1B,CAAC;KACH,CAAC;AACJ,CAAC,CAAC;AAhBW,QAAA,2BAA2B,+BAgBtC;AAEK,MAAM,eAAe,GAAG,CAC7B,UAA6B,EAC7B,IAAgC,EACa,EAAE;IAC/C,MAAM,IAAI,GAAG,IAAA,mCAA2B,EAAC,IAAI,CAAC,CAAC;IAC/C,OAAO,EAAE,GAAG,UAAU,EAAE,GAAG,IAAI,EAAiD,CAAC;AACnF,CAAC,CAAC;AANW,QAAA,eAAe,mBAM1B"}
+{"version":3,"file":"user-audit.enricher.js","sourceRoot":"","sources":["../../../../src/base/models/enrichers/user-audit.enricher.ts"],"names":[],"mappings":";;;AAAA,0DAAkD;AAClD,iDAAmG;AACnG,0DAAqD;AACrD,kEAAuE;AAqBvE;;;;;GAKG;AACH,MAAM,gBAAgB,GAAG,CAAI,IAAsD,EAAY,EAAE;IAC/F,MAAM,OAAO,GAAG,IAAA,+BAAa,GAAE,CAAC;IAChC,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YACzB,MAAM,IAAA,wBAAQ,EAAC;gBACb,OAAO,EAAE,6EAA6E,IAAI,CAAC,WAAW,sBAAsB,IAAI,CAAC,cAAc,EAAE;aAClJ,CAAC,CAAC;QACL,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,uBAAc,CAAC,aAAa,CAAC,CAAC;IACzD,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;QACpC,MAAM,IAAA,wBAAQ,EAAC;YACb,OAAO,EAAE,8EAA8E,IAAI,CAAC,WAAW,sBAAsB,IAAI,CAAC,cAAc,cAAc,MAAM,EAAE;SACvK,CAAC,CAAC;IACL,CAAC;IAED,OAAQ,MAAY,IAAI,IAAI,CAAC;AAC/B,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,IAG7B,EAAE,EAAE;IACH,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;IAEzC,QAAQ,UAAU,CAAC,QAAQ,EAAE,CAAC;QAC5B,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,MAAM,GAAG,GAAG,IAAA,iBAAO,EAAC,UAAU,CAAC,UAAU,CAAC,CAAC,KAAK,EAAiB,CAAC;YAClE,MAAM,YAAY,GAAG,GAAG,EAAE,CACxB,gBAAgB,CAAS;gBACvB,WAAW;gBACX,cAAc,EAAE,UAAU,CAAC,cAAc,IAAI,IAAI;aAClD,CAAC,CAAC;YAEL,2EAA2E;YAC3E,OAAO,WAAW,KAAK,WAAW;gBAChC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,YAAY,CAAC;gBAC5B,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QACzD,CAAC;QAED,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,MAAM,GAAG,GAAG,IAAA,cAAI,EAAC,UAAU,CAAC,UAAU,CAAC,CAAC,KAAK,EAAiB,CAAC;YAC/D,MAAM,YAAY,GAAG,GAAG,EAAE,CACxB,gBAAgB,CAAS;gBACvB,WAAW;gBACX,cAAc,EAAE,UAAU,CAAC,cAAc,IAAI,IAAI;aAClD,CAAC,CAAC;YAEL,2EAA2E;YAC3E,OAAO,WAAW,KAAK,WAAW;gBAChC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,YAAY,CAAC;gBAC5B,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QACzD,CAAC;QAED,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,IAAA,wBAAQ,EAAC;gBACb,OAAO,EAAE,2CAA2C,WAAW,cAAe,UAAmC,CAAC,QAAQ,gCAAgC;aAC3J,CAAC,CAAC;QACL,CAAC;IACH,CAAC;AACH,CAAC,CAAC;AAEK,MAAM,2BAA2B,GAAG,CAAC,IAAgC,EAAE,EAAE;IAC9E,MAAM,EACJ,OAAO,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,YAAY,EAAE,cAAc,EAAE,IAAI,EAAE,EAChF,QAAQ,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,aAAa,EAAE,cAAc,EAAE,IAAI,EAAE,GACnF,GAAG,IAAI,IAAI,EAAE,CAAC;IAEf,OAAO;QACL,SAAS,EAAE,oBAAoB,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC;QAClF,UAAU,EAAE,oBAAoB,CAAC,EAAE,UAAU,EAAE,QAAQ,EAAE,WAAW,EAAE,YAAY,EAAE,CAAC;KACtF,CAAC;AACJ,CAAC,CAAC;AAVW,QAAA,2BAA2B,+BAUtC;AAEK,MAAM,eAAe,GAAG,CAC7B,UAA6B,EAC7B,IAAgC,EACa,EAAE;IAC/C,MAAM,IAAI,GAAG,IAAA,mCAA2B,EAAC,IAAI,CAAC,CAAC;IAC/C,OAAO,EAAE,GAAG,UAAU,EAAE,GAAG,IAAI,EAAiD,CAAC;AACnF,CAAC,CAAC;AANW,QAAA,eAAe,mBAM1B"}

package/dist/base/repositories/common/constants.d.ts

@@ -1,18 +1,77 @@
 import { TConstValue } from '@venizia/ignis-helpers';
+/**
+ * Default pagination limit for repository queries.
+ * Used when no limit is explicitly specified in filter options.
+ */
 export declare const DEFAULT_LIMIT = 10;
+/**
+ * Defines the operation scope for repository instances.
+ * Controls whether a repository can perform read-only or read-write operations.
+ *
+ * @example
+ * ```typescript
+ * // Check if a scope is valid
+ * RepositoryOperationScopes.isValid('READ_ONLY'); // true
+ *
+ * // Use in repository configuration
+ * const scope = RepositoryOperationScopes.READ_WRITE;
+ * ```
+ */
 export declare class RepositoryOperationScopes {
+    /** Repository can only perform read operations (find, count, existsWith). */
     static readonly READ_ONLY = "READ_ONLY";
+    /** Repository can only perform write operations (create, update, delete). */
     static readonly WRITE_ONLY = "WRITE_ONLY";
+    /** Repository can perform both read and write operations. */
     static readonly READ_WRITE = "READ_WRITE";
+    /** Set of all valid operation scopes for validation. */
     static readonly SCHEME_SET: Set<string>;
+    /**
+     * Validates if a given string is a valid operation scope.
+     *
+     * @param orgType - The scope string to validate
+     * @returns True if the scope is valid, false otherwise
+     */
     static isValid(orgType: string): boolean;
 }
+/**
+ * Type representing valid repository operation scope values.
+ * Derived from {@link RepositoryOperationScopes} static properties.
+ */
 export type TRepositoryOperationScope = TConstValue<typeof RepositoryOperationScopes>;
+/**
+ * Defines the type of relation between entities in the ORM.
+ * Used for configuring entity relationships (one-to-one, one-to-many, many-to-one).
+ *
+ * @example
+ * ```typescript
+ * // Define a one-to-many relation
+ * const relation: TRelationConfig = {
+ *   name: 'posts',
+ *   type: RelationTypes.MANY,
+ *   schema: PostSchema,
+ *   metadata: { fields: [Post.schema.authorId], references: [User.schema.id] }
+ * };
+ * ```
+ */
 export declare class RelationTypes {
+    /** Represents a one-to-one or many-to-one relation. */
     static readonly ONE = "one";
+    /** Represents a one-to-many relation. */
     static readonly MANY = "many";
+    /** Set of all valid relation types for validation. */
     static readonly SCHEME_SET: Set<string>;
+    /**
+     * Validates if a given string is a valid relation type.
+     *
+     * @param orgType - The relation type string to validate
+     * @returns True if the relation type is valid, false otherwise
+     */
     static isValid(orgType: string): boolean;
 }
+/**
+ * Type representing valid relation type values.
+ * Derived from {@link RelationTypes} static properties.
+ */
 export type TRelationType = TConstValue<typeof RelationTypes>;
 //# sourceMappingURL=constants.d.ts.map

package/dist/base/repositories/common/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../../src/base/repositories/common/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAErD,eAAO,MAAM,aAAa,KAAK,CAAC;AAGhC,qBAAa,yBAAyB;IACpC,MAAM,CAAC,QAAQ,CAAC,SAAS,eAAe;IACxC,MAAM,CAAC,QAAQ,CAAC,UAAU,gBAAgB;IAC1C,MAAM,CAAC,QAAQ,CAAC,UAAU,gBAAgB;IAE1C,MAAM,CAAC,QAAQ,CAAC,UAAU,cAA+D;IAEzF,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;CAGzC;AAED,MAAM,MAAM,yBAAyB,GAAG,WAAW,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAGtF,qBAAa,aAAa;IACxB,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS;IAC5B,MAAM,CAAC,QAAQ,CAAC,IAAI,UAAU;IAE9B,MAAM,CAAC,QAAQ,CAAC,UAAU,cAAkC;IAE5D,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;CAGzC;AAED,MAAM,MAAM,aAAa,GAAG,WAAW,CAAC,OAAO,aAAa,CAAC,CAAC"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../../src/base/repositories/common/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAErD;;;GAGG;AACH,eAAO,MAAM,aAAa,KAAK,CAAC;AAEhC;;;;;;;;;;;;GAYG;AACH,qBAAa,yBAAyB;IACpC,6EAA6E;IAC7E,MAAM,CAAC,QAAQ,CAAC,SAAS,eAAe;IAExC,6EAA6E;IAC7E,MAAM,CAAC,QAAQ,CAAC,UAAU,gBAAgB;IAE1C,6DAA6D;IAC7D,MAAM,CAAC,QAAQ,CAAC,UAAU,gBAAgB;IAE1C,wDAAwD;IACxD,MAAM,CAAC,QAAQ,CAAC,UAAU,cAA+D;IAEzF;;;;;OAKG;IACH,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;CAGzC;AAED;;;GAGG;AACH,MAAM,MAAM,yBAAyB,GAAG,WAAW,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAEtF;;;;;;;;;;;;;;GAcG;AACH,qBAAa,aAAa;IACxB,uDAAuD;IACvD,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS;IAE5B,yCAAyC;IACzC,MAAM,CAAC,QAAQ,CAAC,IAAI,UAAU;IAE9B,sDAAsD;IACtD,MAAM,CAAC,QAAQ,CAAC,UAAU,cAAkC;IAE5D;;;;;OAKG;IACH,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;CAGzC;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,WAAW,CAAC,OAAO,aAAa,CAAC,CAAC"}

package/dist/base/repositories/common/constants.js

@@ -1,23 +1,72 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RelationTypes = exports.RepositoryOperationScopes = exports.DEFAULT_LIMIT = void 0;
+/**
+ * Default pagination limit for repository queries.
+ * Used when no limit is explicitly specified in filter options.
+ */
 exports.DEFAULT_LIMIT = 10;
-// --------------------------------------------------------------------------------------
+/**
+ * Defines the operation scope for repository instances.
+ * Controls whether a repository can perform read-only or read-write operations.
+ *
+ * @example
+ * ```typescript
+ * // Check if a scope is valid
+ * RepositoryOperationScopes.isValid('READ_ONLY'); // true
+ *
+ * // Use in repository configuration
+ * const scope = RepositoryOperationScopes.READ_WRITE;
+ * ```
+ */
 class RepositoryOperationScopes {
+    /** Repository can only perform read operations (find, count, existsWith). */
     static { this.READ_ONLY = 'READ_ONLY'; }
+    /** Repository can only perform write operations (create, update, delete). */
     static { this.WRITE_ONLY = 'WRITE_ONLY'; }
+    /** Repository can perform both read and write operations. */
     static { this.READ_WRITE = 'READ_WRITE'; }
+    /** Set of all valid operation scopes for validation. */
     static { this.SCHEME_SET = new Set([this.READ_ONLY, this.WRITE_ONLY, this.READ_WRITE]); }
+    /**
+     * Validates if a given string is a valid operation scope.
+     *
+     * @param orgType - The scope string to validate
+     * @returns True if the scope is valid, false otherwise
+     */
     static isValid(orgType) {
         return this.SCHEME_SET.has(orgType);
     }
 }
 exports.RepositoryOperationScopes = RepositoryOperationScopes;
-// --------------------------------------------------------------------------------------
+/**
+ * Defines the type of relation between entities in the ORM.
+ * Used for configuring entity relationships (one-to-one, one-to-many, many-to-one).
+ *
+ * @example
+ * ```typescript
+ * // Define a one-to-many relation
+ * const relation: TRelationConfig = {
+ *   name: 'posts',
+ *   type: RelationTypes.MANY,
+ *   schema: PostSchema,
+ *   metadata: { fields: [Post.schema.authorId], references: [User.schema.id] }
+ * };
+ * ```
+ */
 class RelationTypes {
+    /** Represents a one-to-one or many-to-one relation. */
     static { this.ONE = 'one'; }
+    /** Represents a one-to-many relation. */
     static { this.MANY = 'many'; }
+    /** Set of all valid relation types for validation. */
     static { this.SCHEME_SET = new Set([this.ONE, this.MANY]); }
+    /**
+     * Validates if a given string is a valid relation type.
+     *
+     * @param orgType - The relation type string to validate
+     * @returns True if the relation type is valid, false otherwise
+     */
     static isValid(orgType) {
         return this.SCHEME_SET.has(orgType);
     }

package/dist/base/repositories/common/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../../src/base/repositories/common/constants.ts"],"names":[],"mappings":";;;AAEa,QAAA,aAAa,GAAG,EAAE,CAAC;AAEhC,yFAAyF;AACzF,MAAa,yBAAyB;aACpB,cAAS,GAAG,WAAW,CAAC;aACxB,eAAU,GAAG,YAAY,CAAC;aAC1B,eAAU,GAAG,YAAY,CAAC;aAE1B,eAAU,GAAG,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IAEzF,MAAM,CAAC,OAAO,CAAC,OAAe;QAC5B,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC;;AATH,8DAUC;AAID,yFAAyF;AACzF,MAAa,aAAa;aACR,QAAG,GAAG,KAAK,CAAC;aACZ,SAAI,GAAG,MAAM,CAAC;aAEd,eAAU,GAAG,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAE5D,MAAM,CAAC,OAAO,CAAC,OAAe;QAC5B,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC;;AARH,sCASC"}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../../src/base/repositories/common/constants.ts"],"names":[],"mappings":";;;AAEA;;;GAGG;AACU,QAAA,aAAa,GAAG,EAAE,CAAC;AAEhC;;;;;;;;;;;;GAYG;AACH,MAAa,yBAAyB;IACpC,6EAA6E;aAC7D,cAAS,GAAG,WAAW,CAAC;IAExC,6EAA6E;aAC7D,eAAU,GAAG,YAAY,CAAC;IAE1C,6DAA6D;aAC7C,eAAU,GAAG,YAAY,CAAC;IAE1C,wDAAwD;aACxC,eAAU,GAAG,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IAEzF;;;;;OAKG;IACH,MAAM,CAAC,OAAO,CAAC,OAAe;QAC5B,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC;;AArBH,8DAsBC;AAQD;;;;;;;;;;;;;;GAcG;AACH,MAAa,aAAa;IACxB,uDAAuD;aACvC,QAAG,GAAG,KAAK,CAAC;IAE5B,yCAAyC;aACzB,SAAI,GAAG,MAAM,CAAC;IAE9B,sDAAsD;aACtC,eAAU,GAAG,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAE5D;;;;;OAKG;IACH,MAAM,CAAC,OAAO,CAAC,OAAe;QAC5B,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC;;AAlBH,sCAmBC"}