@neohm/nestend 8.0.1 → 8.1.0

package/dist/common/services/idempotency.service.d.ts

@@ -0,0 +1,25 @@
+import { DataSource, EntityManager } from 'typeorm';
+import { IdempotencyKeyEntity } from '../entities/idempotency.key.entity';
+import type { IdempotencyClaim, IdempotencyClaimInput } from '../types/idempotency.types';
+import { SystemPropertyService } from './system.property.service';
+export declare class IdempotencyService {
+    private readonly systemPropertyService;
+    private readonly dataSource?;
+    private readonly propertyCache;
+    constructor(systemPropertyService: SystemPropertyService, dataSource?: DataSource);
+    claim(manager: EntityManager, input: IdempotencyClaimInput): Promise<IdempotencyClaim>;
+    complete(manager: EntityManager, claim: string | IdempotencyKeyEntity, sourceId: string): Promise<void>;
+    hash(payload: unknown): string;
+    purgeExpired(): Promise<number>;
+    ttlMinutes(): Promise<number>;
+    lockTimeoutMs(): Promise<number>;
+    private attempt;
+    private insert;
+    private findExisting;
+    private setLockTimeout;
+    private isUniqueViolation;
+    private isLockTimeout;
+    private property;
+    private get connection();
+}
+//# sourceMappingURL=idempotency.service.d.ts.map

package/dist/common/services/idempotency.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"idempotency.service.d.ts","sourceRoot":"","sources":["../../../src/common/services/idempotency.service.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAE,aAAa,EAA8B,MAAM,SAAS,CAAC;AAIhF,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAO1E,OAAO,KAAK,EACV,gBAAgB,EAEhB,qBAAqB,EACtB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAOlE,qBACa,kBAAkB;IAI3B,OAAO,CAAC,QAAQ,CAAC,qBAAqB;IAC1B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC;IAJ1C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAqC;gBAGhD,qBAAqB,EAAE,qBAAqB,EAChC,UAAU,CAAC,EAAE,UAAU;IAIhD,KAAK,CACT,OAAO,EAAE,aAAa,EACtB,KAAK,EAAE,qBAAqB,GAC3B,OAAO,CAAC,gBAAgB,CAAC;IAkBtB,QAAQ,CACZ,OAAO,EAAE,aAAa,EACtB,KAAK,EAAE,MAAM,GAAG,oBAAoB,EACpC,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,IAAI,CAAC;IAUhB,IAAI,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM;IAOxB,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC;IAsB/B,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC;IAS7B,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;YASxB,OAAO;YAqCP,MAAM;IAyBpB,OAAO,CAAC,YAAY;YAkBN,cAAc;IAU5B,OAAO,CAAC,iBAAiB;IAQzB,OAAO,CAAC,aAAa;YASP,QAAQ;IAiBtB,OAAO,KAAK,UAAU,GAMrB;CACF"}

package/dist/common/services/idempotency.service.js

@@ -0,0 +1,181 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IdempotencyService = void 0;
+const common_1 = require("@nestjs/common");
+const crypto_1 = require("crypto");
+const typeorm_1 = require("typeorm");
+const idempotency_exception_1 = require("../../global/exceptions/idempotency.exception");
+const operation_exception_1 = require("../../global/exceptions/operation.exception");
+const environment_util_1 = require("../../global/utilities/environment.util");
+const idempotency_key_entity_1 = require("../entities/idempotency.key.entity");
+const idempotency_enum_1 = require("../enums/idempotency.enum");
+const canonical_json_1 = require("../helpers/canonical.json");
+const system_property_service_1 = require("./system.property.service");
+let IdempotencyService = class IdempotencyService {
+    constructor(systemPropertyService, dataSource) {
+        this.systemPropertyService = systemPropertyService;
+        this.dataSource = dataSource;
+        this.propertyCache = new Map();
+    }
+    async claim(manager, input) {
+        const requestHash = this.hash(input.payload);
+        const [ttlMinutes, lockTimeoutMs] = await Promise.all([
+            this.ttlMinutes(),
+            this.lockTimeoutMs(),
+        ]);
+        await this.setLockTimeout(manager, `${lockTimeoutMs}ms`);
+        try {
+            return await this.attempt(manager, input, requestHash, ttlMinutes);
+        }
+        catch (error) {
+            if (this.isLockTimeout(error))
+                throw idempotency_exception_1.IdempotencyException.inProgress();
+            throw error;
+        }
+    }
+    async complete(manager, claim, sourceId) {
+        const row = typeof claim === 'string'
+            ? await manager.findOneByOrFail(idempotency_key_entity_1.IdempotencyKeyEntity, { id: claim })
+            : claim;
+        row.source_id = sourceId;
+        await manager.save(row);
+    }
+    hash(payload) {
+        return (0, crypto_1.createHash)(idempotency_enum_1.IdempotencyDefault.HASH_ALGORITHM)
+            .update((0, canonical_json_1.canonicalJson)(payload))
+            .digest('hex');
+    }
+    async purgeExpired() {
+        let removed = 0;
+        for (let batch = 0; batch < Number(idempotency_enum_1.IdempotencyLimit.PURGE_MAX_BATCHES); batch++) {
+            const count = await this.connection.transaction(async (trx) => {
+                const expired = await trx.find(idempotency_key_entity_1.IdempotencyKeyEntity, {
+                    where: { expires_at: (0, typeorm_1.LessThan)(new Date()) },
+                    order: { expires_at: 'ASC' },
+                    take: Number(idempotency_enum_1.IdempotencyLimit.PURGE_BATCH_SIZE),
+                });
+                if (expired.length)
+                    await trx.remove(expired);
+                return expired.length;
+            });
+            removed += count;
+            if (count < Number(idempotency_enum_1.IdempotencyLimit.PURGE_BATCH_SIZE))
+                break;
+        }
+        return removed;
+    }
+    async ttlMinutes() {
+        return this.property(idempotency_enum_1.IdempotencyDefault.TTL_PROPERTY, idempotency_enum_1.IdempotencyLimit.TTL_MINUTES, idempotency_enum_1.IdempotencyLimit.TTL_MIN_MINUTES, idempotency_enum_1.IdempotencyLimit.TTL_MAX_MINUTES);
+    }
+    async lockTimeoutMs() {
+        return this.property(idempotency_enum_1.IdempotencyDefault.LOCK_TIMEOUT_PROPERTY, idempotency_enum_1.IdempotencyLimit.LOCK_TIMEOUT_MS, idempotency_enum_1.IdempotencyLimit.LOCK_TIMEOUT_MIN_MS, idempotency_enum_1.IdempotencyLimit.LOCK_TIMEOUT_MAX_MS);
+    }
+    async attempt(manager, input, requestHash, ttlMinutes) {
+        for (let attempt = 1;; attempt++) {
+            const claim = await this.insert(manager, input, requestHash, ttlMinutes);
+            if (claim)
+                return {
+                    status: idempotency_enum_1.IdempotencyClaimStatus.CLAIMED,
+                    claimId: claim.id,
+                    claim,
+                };
+            const retry = attempt < Number(idempotency_enum_1.IdempotencyLimit.CLAIM_ATTEMPTS);
+            const existing = await this.findExisting(manager, input);
+            if (!existing) {
+                if (retry)
+                    continue;
+                throw idempotency_exception_1.IdempotencyException.inProgress();
+            }
+            if (retry && existing.expires_at.getTime() <= Date.now()) {
+                await manager.remove(existing);
+                continue;
+            }
+            if (existing.request_hash !== requestHash)
+                throw idempotency_exception_1.IdempotencyException.keyReused();
+            if (!existing.source_id)
+                throw idempotency_exception_1.IdempotencyException.inProgress();
+            return {
+                status: idempotency_enum_1.IdempotencyClaimStatus.REPLAY,
+                sourceId: existing.source_id,
+            };
+        }
+    }
+    async insert(manager, input, requestHash, ttlMinutes) {
+        const claim = new idempotency_key_entity_1.IdempotencyKeyEntity();
+        claim.tenant_id = input.tenantId;
+        claim.user_id = input.userId;
+        claim.source_type = input.sourceType;
+        claim.key = input.key;
+        claim.request_hash = requestHash;
+        claim.expires_at = new Date(Date.now() + ttlMinutes * idempotency_enum_1.IdempotencyLimit.MS_PER_MINUTE);
+        try {
+            await manager.transaction((nested) => nested.save(claim));
+        }
+        catch (error) {
+            if (this.isUniqueViolation(error))
+                return null;
+            throw error;
+        }
+        return claim;
+    }
+    findExisting(manager, input) {
+        return manager
+            .createQueryBuilder(idempotency_key_entity_1.IdempotencyKeyEntity, 'k')
+            .where(`coalesce(k.tenant_id, '${idempotency_enum_1.IdempotencyDefault.NO_TENANT}'::uuid) = CAST(:tenant AS uuid)`, { tenant: input.tenantId ?? idempotency_enum_1.IdempotencyDefault.NO_TENANT })
+            .andWhere('k.source_type = :sourceType', {
+            sourceType: input.sourceType,
+        })
+            .andWhere('k.key = :key', { key: input.key })
+            .getOne();
+    }
+    async setLockTimeout(manager, value) {
+        await manager.query(`SELECT set_config('${idempotency_enum_1.IdempotencyDefault.LOCK_TIMEOUT_SETTING}', $1, true)`, [value]);
+    }
+    isUniqueViolation(error) {
+        return (error instanceof typeorm_1.QueryFailedError &&
+            error.driverError?.code ===
+                String(idempotency_enum_1.IdempotencyDefault.UNIQUE_VIOLATION_CODE));
+    }
+    isLockTimeout(error) {
+        return (error instanceof typeorm_1.QueryFailedError &&
+            error.driverError?.code ===
+                String(idempotency_enum_1.IdempotencyDefault.LOCK_NOT_AVAILABLE_CODE));
+    }
+    async property(identifier, fallback, min, max) {
+        const hit = this.propertyCache.get(identifier);
+        if (hit && hit.expiresAt > Date.now())
+            return hit.value;
+        const raw = await this.systemPropertyService.get(identifier);
+        const value = (0, environment_util_1.envInt)(raw ?? undefined, fallback, { min, max });
+        this.propertyCache.set(identifier, {
+            value,
+            expiresAt: Date.now() + Number(idempotency_enum_1.IdempotencyLimit.PROPERTY_CACHE_MS),
+        });
+        return value;
+    }
+    get connection() {
+        if (!this.dataSource)
+            throw new operation_exception_1.OperationException('IdempotencyService requires TypeOrmModule to be configured with a data source');
+        return this.dataSource;
+    }
+};
+exports.IdempotencyService = IdempotencyService;
+exports.IdempotencyService = IdempotencyService = __decorate([
+    (0, common_1.Injectable)(),
+    __param(1, (0, common_1.Optional)()),
+    __metadata("design:paramtypes", [system_property_service_1.SystemPropertyService,
+        typeorm_1.DataSource])
+], IdempotencyService);
+//# sourceMappingURL=idempotency.service.js.map

package/dist/common/services/idempotency.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"idempotency.service.js","sourceRoot":"","sources":["../../../src/common/services/idempotency.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAAsD;AACtD,mCAAoC;AACpC,qCAAgF;AAChF,yFAAqF;AACrF,qFAAiF;AACjF,8EAAiE;AACjE,+EAA0E;AAC1E,gEAImC;AACnC,8DAA0D;AAM1D,uEAAkE;AAQ3D,IAAM,kBAAkB,GAAxB,MAAM,kBAAkB;IAG7B,YACmB,qBAA4C,EACjD,UAAwC;QADnC,0BAAqB,GAArB,qBAAqB,CAAuB;QAChC,eAAU,GAAV,UAAU,CAAa;QAJrC,kBAAa,GAAG,IAAI,GAAG,EAA0B,CAAC;IAKhE,CAAC;IAGJ,KAAK,CAAC,KAAK,CACT,OAAsB,EACtB,KAA4B;QAE5B,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC7C,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACpD,IAAI,CAAC,UAAU,EAAE;YACjB,IAAI,CAAC,aAAa,EAAE;SACrB,CAAC,CAAC;QAGH,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,aAAa,IAAI,CAAC,CAAC;QACzD,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC;QACrE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC;gBAAE,MAAM,4CAAoB,CAAC,UAAU,EAAE,CAAC;YACvE,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAGD,KAAK,CAAC,QAAQ,CACZ,OAAsB,EACtB,KAAoC,EACpC,QAAgB;QAEhB,MAAM,GAAG,GACP,OAAO,KAAK,KAAK,QAAQ;YACvB,CAAC,CAAC,MAAM,OAAO,CAAC,eAAe,CAAC,6CAAoB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC;YACpE,CAAC,CAAC,KAAK,CAAC;QACZ,GAAG,CAAC,SAAS,GAAG,QAAQ,CAAC;QACzB,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC1B,CAAC;IAGD,IAAI,CAAC,OAAgB;QACnB,OAAO,IAAA,mBAAU,EAAC,qCAAkB,CAAC,cAAc,CAAC;aACjD,MAAM,CAAC,IAAA,8BAAa,EAAC,OAAO,CAAC,CAAC;aAC9B,MAAM,CAAC,KAAK,CAAC,CAAC;IACnB,CAAC;IAGD,KAAK,CAAC,YAAY;QAChB,IAAI,OAAO,GAAG,CAAC,CAAC;QAChB,KACE,IAAI,KAAK,GAAG,CAAC,EACb,KAAK,GAAG,MAAM,CAAC,mCAAgB,CAAC,iBAAiB,CAAC,EAClD,KAAK,EAAE,EACP,CAAC;YACD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;gBAC5D,MAAM,OAAO,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,6CAAoB,EAAE;oBACnD,KAAK,EAAE,EAAE,UAAU,EAAE,IAAA,kBAAQ,EAAC,IAAI,IAAI,EAAE,CAAC,EAAE;oBAC3C,KAAK,EAAE,EAAE,UAAU,EAAE,KAAK,EAAE;oBAC5B,IAAI,EAAE,MAAM,CAAC,mCAAgB,CAAC,gBAAgB,CAAC;iBAChD,CAAC,CAAC;gBACH,IAAI,OAAO,CAAC,MAAM;oBAAE,MAAM,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;gBAC9C,OAAO,OAAO,CAAC,MAAM,CAAC;YACxB,CAAC,CAAC,CAAC;YACH,OAAO,IAAI,KAAK,CAAC;YACjB,IAAI,KAAK,GAAG,MAAM,CAAC,mCAAgB,CAAC,gBAAgB,CAAC;gBAAE,MAAM;QAC/D,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,UAAU;QACd,OAAO,IAAI,CAAC,QAAQ,CAClB,qCAAkB,CAAC,YAAY,EAC/B,mCAAgB,CAAC,WAAW,EAC5B,mCAAgB,CAAC,eAAe,EAChC,mCAAgB,CAAC,eAAe,CACjC,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,aAAa;QACjB,OAAO,IAAI,CAAC,QAAQ,CAClB,qCAAkB,CAAC,qBAAqB,EACxC,mCAAgB,CAAC,eAAe,EAChC,mCAAgB,CAAC,mBAAmB,EACpC,mCAAgB,CAAC,mBAAmB,CACrC,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,OAAO,CACnB,OAAsB,EACtB,KAA4B,EAC5B,WAAmB,EACnB,UAAkB;QAElB,KAAK,IAAI,OAAO,GAAG,CAAC,GAAI,OAAO,EAAE,EAAE,CAAC;YAElC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC;YACzE,IAAI,KAAK;gBACP,OAAO;oBACL,MAAM,EAAE,yCAAsB,CAAC,OAAO;oBACtC,OAAO,EAAE,KAAK,CAAC,EAAE;oBACjB,KAAK;iBACN,CAAC;YAEJ,MAAM,KAAK,GAAG,OAAO,GAAG,MAAM,CAAC,mCAAgB,CAAC,cAAc,CAAC,CAAC;YAChE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YACzD,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,IAAI,KAAK;oBAAE,SAAS;gBACpB,MAAM,4CAAoB,CAAC,UAAU,EAAE,CAAC;YAC1C,CAAC;YACD,IAAI,KAAK,IAAI,QAAQ,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;gBACzD,MAAM,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;gBAC/B,SAAS;YACX,CAAC;YACD,IAAI,QAAQ,CAAC,YAAY,KAAK,WAAW;gBACvC,MAAM,4CAAoB,CAAC,SAAS,EAAE,CAAC;YACzC,IAAI,CAAC,QAAQ,CAAC,SAAS;gBAAE,MAAM,4CAAoB,CAAC,UAAU,EAAE,CAAC;YACjE,OAAO;gBACL,MAAM,EAAE,yCAAsB,CAAC,MAAM;gBACrC,QAAQ,EAAE,QAAQ,CAAC,SAAS;aAC7B,CAAC;QACJ,CAAC;IACH,CAAC;IAGO,KAAK,CAAC,MAAM,CAClB,OAAsB,EACtB,KAA4B,EAC5B,WAAmB,EACnB,UAAkB;QAElB,MAAM,KAAK,GAAG,IAAI,6CAAoB,EAAE,CAAC;QACzC,KAAK,CAAC,SAAS,GAAG,KAAK,CAAC,QAAQ,CAAC;QACjC,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC;QAC7B,KAAK,CAAC,WAAW,GAAG,KAAK,CAAC,UAAU,CAAC;QACrC,KAAK,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC;QACtB,KAAK,CAAC,YAAY,GAAG,WAAW,CAAC;QACjC,KAAK,CAAC,UAAU,GAAG,IAAI,IAAI,CACzB,IAAI,CAAC,GAAG,EAAE,GAAG,UAAU,GAAG,mCAAgB,CAAC,aAAa,CACzD,CAAC;QACF,IAAI,CAAC;YACH,MAAM,OAAO,CAAC,WAAW,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;QAC5D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC;gBAAE,OAAO,IAAI,CAAC;YAC/C,MAAM,KAAK,CAAC;QACd,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAGO,YAAY,CAClB,OAAsB,EACtB,KAA4B;QAE5B,OAAO,OAAO;aACX,kBAAkB,CAAC,6CAAoB,EAAE,GAAG,CAAC;aAC7C,KAAK,CACJ,0BAA0B,qCAAkB,CAAC,SAAS,kCAAkC,EACxF,EAAE,MAAM,EAAE,KAAK,CAAC,QAAQ,IAAI,qCAAkB,CAAC,SAAS,EAAE,CAC3D;aACA,QAAQ,CAAC,6BAA6B,EAAE;YACvC,UAAU,EAAE,KAAK,CAAC,UAAU;SAC7B,CAAC;aACD,QAAQ,CAAC,cAAc,EAAE,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,CAAC;aAC5C,MAAM,EAAE,CAAC;IACd,CAAC;IAGO,KAAK,CAAC,cAAc,CAC1B,OAAsB,EACtB,KAAa;QAEb,MAAM,OAAO,CAAC,KAAK,CACjB,sBAAsB,qCAAkB,CAAC,oBAAoB,cAAc,EAC3E,CAAC,KAAK,CAAC,CACR,CAAC;IACJ,CAAC;IAEO,iBAAiB,CAAC,KAAc;QACtC,OAAO,CACL,KAAK,YAAY,0BAAgB;YAChC,KAAK,CAAC,WAA6C,EAAE,IAAI;gBACxD,MAAM,CAAC,qCAAkB,CAAC,qBAAqB,CAAC,CACnD,CAAC;IACJ,CAAC;IAEO,aAAa,CAAC,KAAc;QAClC,OAAO,CACL,KAAK,YAAY,0BAAgB;YAChC,KAAK,CAAC,WAA6C,EAAE,IAAI;gBACxD,MAAM,CAAC,qCAAkB,CAAC,uBAAuB,CAAC,CACrD,CAAC;IACJ,CAAC;IAGO,KAAK,CAAC,QAAQ,CACpB,UAAkB,EAClB,QAAgB,EAChB,GAAW,EACX,GAAW;QAEX,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC/C,IAAI,GAAG,IAAI,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE;YAAE,OAAO,GAAG,CAAC,KAAK,CAAC;QACxD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC7D,MAAM,KAAK,GAAG,IAAA,yBAAM,EAAC,GAAG,IAAI,SAAS,EAAE,QAAQ,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC;QAC/D,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,UAAU,EAAE;YACjC,KAAK;YACL,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,mCAAgB,CAAC,iBAAiB,CAAC;SACnE,CAAC,CAAC;QACH,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAY,UAAU;QACpB,IAAI,CAAC,IAAI,CAAC,UAAU;YAClB,MAAM,IAAI,wCAAkB,CAC1B,+EAA+E,CAChF,CAAC;QACJ,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;CACF,CAAA;AA9NY,gDAAkB;6BAAlB,kBAAkB;IAD9B,IAAA,mBAAU,GAAE;IAMR,WAAA,IAAA,iBAAQ,GAAE,CAAA;qCAD6B,+CAAqB;QACnB,oBAAU;GAL3C,kBAAkB,CA8N9B"}

package/dist/common/services/record.history.service.d.ts

@@ -0,0 +1,16 @@
+import { DataSource } from 'typeorm';
+import { PaginatedResult } from '../types/paginated.result.types';
+import type { RecordHistoryChange, RecordHistoryEntry, RecordHistoryFilter, RecordHistoryOptions, RecordHistorySource } from '../types/record.history.types';
+export declare class RecordHistoryService {
+    private readonly dataSource?;
+    constructor(dataSource?: DataSource);
+    log(source: RecordHistorySource, before: object | null, after: object | null, actorId: string | null, options?: RecordHistoryOptions): Promise<void>;
+    history(sourceType: string, sourceId: string, filter?: RecordHistoryFilter): Promise<PaginatedResult<RecordHistoryEntry>>;
+    diff(before: object | null, after: object | null, options?: RecordHistoryOptions): RecordHistoryChange[];
+    private skippedFields;
+    private metadataOf;
+    private isRelation;
+    private toEntry;
+    private get connection();
+}
+//# sourceMappingURL=record.history.service.d.ts.map

package/dist/common/services/record.history.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"record.history.service.d.ts","sourceRoot":"","sources":["../../../src/common/services/record.history.service.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAkB,MAAM,SAAS,CAAC;AAUrD,OAAO,EACL,eAAe,EAGhB,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EACV,mBAAmB,EACnB,kBAAkB,EAClB,mBAAmB,EACnB,oBAAoB,EAEpB,mBAAmB,EAEpB,MAAM,+BAA+B,CAAC;AAOvC,qBACa,oBAAoB;IACP,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC;gBAAX,UAAU,CAAC,EAAE,UAAU;IAG1D,GAAG,CACP,MAAM,EAAE,mBAAmB,EAC3B,MAAM,EAAE,MAAM,GAAG,IAAI,EACrB,KAAK,EAAE,MAAM,GAAG,IAAI,EACpB,OAAO,EAAE,MAAM,GAAG,IAAI,EACtB,OAAO,GAAE,oBAAyB,GACjC,OAAO,CAAC,IAAI,CAAC;IA0BV,OAAO,CACX,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,MAAM,CAAC,EAAE,mBAAmB,GAC3B,OAAO,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAC;IA4C/C,IAAI,CACF,MAAM,EAAE,MAAM,GAAG,IAAI,EACrB,KAAK,EAAE,MAAM,GAAG,IAAI,EACpB,OAAO,GAAE,oBAAyB,GACjC,mBAAmB,EAAE;IAexB,OAAO,CAAC,aAAa;IAsBrB,OAAO,CAAC,UAAU;IAUlB,OAAO,CAAC,UAAU;IAMlB,OAAO,CAAC,OAAO;IAkBf,OAAO,KAAK,UAAU,GAMrB;CACF"}

package/dist/common/services/record.history.service.js

@@ -0,0 +1,153 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RecordHistoryService = void 0;
+const common_1 = require("@nestjs/common");
+const typeorm_1 = require("typeorm");
+const admin_user_entity_1 = require("../../auth/entities/admin.user.entity");
+const user_entity_1 = require("../../auth/entities/user.entity");
+const operation_exception_1 = require("../../global/exceptions/operation.exception");
+const root_entity_1 = require("../entities/root.entity");
+const system_audit_log_entity_1 = require("../entities/system.audit.log.entity");
+const audit_action_enum_1 = require("../enums/audit.action.enum");
+const constant_pair_1 = require("../helpers/constant.pair");
+const record_history_enum_1 = require("../enums/record.history.enum");
+const canonical_json_1 = require("../helpers/canonical.json");
+const paginated_result_types_1 = require("../types/paginated.result.types");
+let RecordHistoryService = class RecordHistoryService {
+    constructor(dataSource) {
+        this.dataSource = dataSource;
+    }
+    async log(source, before, after, actorId, options = {}) {
+        const changes = this.diff(before, after, options);
+        if (!changes.length)
+            return;
+        const oldValue = {};
+        const newValue = {};
+        for (const change of changes) {
+            oldValue[change.field] = change.from;
+            newValue[change.field] = change.to;
+        }
+        const manager = options.manager ?? this.connection.manager;
+        await manager.insert(system_audit_log_entity_1.SystemAuditLogEntity, {
+            source_type: source.sourceType,
+            source_id: source.sourceId,
+            action_id: constant_pair_1.ConstantPair.id(audit_action_enum_1.AuditAction, audit_action_enum_1.AuditActionId, options.action ?? audit_action_enum_1.AuditAction.UPDATE),
+            user_id: actorId,
+            old_value: oldValue,
+            new_value: newValue,
+        });
+    }
+    async history(sourceType, sourceId, filter) {
+        const { page, limit } = (0, paginated_result_types_1.clampPagination)(filter);
+        const filtered = this.connection
+            .createQueryBuilder(system_audit_log_entity_1.SystemAuditLogEntity, 'log')
+            .where('log.source_type = :sourceType', { sourceType })
+            .andWhere('log.source_id = :sourceId', { sourceId })
+            .andWhere('log.deleted_at IS NULL');
+        const [rows, total] = await Promise.all([
+            filtered
+                .clone()
+                .leftJoin(user_entity_1.UserEntity, 'actor_user', 'actor_user.id = log.user_id')
+                .leftJoin(admin_user_entity_1.AdminUserEntity, 'actor_admin', 'actor_admin.id = log.user_id')
+                .leftJoin('log.action', 'action')
+                .select('log.id', 'id')
+                .addSelect('action.identifier', 'action')
+                .addSelect('log.user_id', 'user_id')
+                .addSelect('coalesce(actor_user.full_name, actor_admin.name)', 'user_name')
+                .addSelect('log.old_value', 'old_value')
+                .addSelect('log.new_value', 'new_value')
+                .addSelect('log.created_at', 'created_at')
+                .orderBy('log.created_at', 'DESC')
+                .addOrderBy('log.sn', 'DESC')
+                .offset((page - 1) * limit)
+                .limit(limit)
+                .getRawMany(),
+            filtered.getCount(),
+        ]);
+        return (0, paginated_result_types_1.buildPaginated)(rows.map((row) => this.toEntry(row)), total, page, limit);
+    }
+    diff(before, after, options = {}) {
+        const from = (before ?? {});
+        const to = (after ?? {});
+        const skipped = this.skippedFields(before, after, options);
+        const fields = new Set([...Object.keys(from), ...Object.keys(to)]);
+        const changes = [];
+        for (const field of fields) {
+            if (skipped.has(field))
+                continue;
+            if (this.isRelation(from[field]) || this.isRelation(to[field]))
+                continue;
+            if ((0, canonical_json_1.canonicalJson)(from[field]) === (0, canonical_json_1.canonicalJson)(to[field]))
+                continue;
+            changes.push({ field, from: from[field], to: to[field] });
+        }
+        return changes;
+    }
+    skippedFields(before, after, options) {
+        const skipped = new Set([
+            ...record_history_enum_1.RECORD_HISTORY_SKIPPED_FIELDS,
+            ...(options.skip ?? []),
+        ]);
+        const metadata = this.metadataOf(options, options.entity ?? after?.constructor ?? before?.constructor);
+        if (metadata) {
+            for (const column of metadata.columns)
+                if (column.isSelect === false)
+                    skipped.add(column.propertyName);
+            for (const relation of metadata.relations)
+                skipped.add(relation.propertyName);
+        }
+        return skipped;
+    }
+    metadataOf(options, target) {
+        const connection = options.manager?.connection ?? this.dataSource;
+        if (!target || !connection?.hasMetadata(target))
+            return null;
+        return connection.getMetadata(target);
+    }
+    isRelation(value) {
+        if (Array.isArray(value))
+            return value.length > 0 && value.every((item) => this.isRelation(item));
+        return value instanceof root_entity_1.RootEntity;
+    }
+    toEntry(row) {
+        const from = row.old_value ?? {};
+        const to = row.new_value ?? {};
+        const fields = new Set([...Object.keys(from), ...Object.keys(to)]);
+        return {
+            id: row.id,
+            action: row.action,
+            user_id: row.user_id,
+            user_name: row.user_name,
+            changes: [...fields].map((field) => ({
+                field,
+                from: from[field] ?? null,
+                to: to[field] ?? null,
+            })),
+            created_at: row.created_at,
+        };
+    }
+    get connection() {
+        if (!this.dataSource)
+            throw new operation_exception_1.OperationException('RecordHistoryService requires TypeOrmModule to be configured with a data source');
+        return this.dataSource;
+    }
+};
+exports.RecordHistoryService = RecordHistoryService;
+exports.RecordHistoryService = RecordHistoryService = __decorate([
+    (0, common_1.Injectable)(),
+    __param(0, (0, common_1.Optional)()),
+    __metadata("design:paramtypes", [typeorm_1.DataSource])
+], RecordHistoryService);
+//# sourceMappingURL=record.history.service.js.map

package/dist/common/services/record.history.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"record.history.service.js","sourceRoot":"","sources":["../../../src/common/services/record.history.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAAsD;AACtD,qCAAqD;AACrD,6EAAwE;AACxE,iEAA6D;AAC7D,qFAAiF;AACjF,yDAAqD;AACrD,iFAA2E;AAC3E,kEAAwE;AACxE,4DAAwD;AACxD,sEAA6E;AAC7E,8DAA0D;AAC1D,4EAIyC;AAiBlC,IAAM,oBAAoB,GAA1B,MAAM,oBAAoB;IAC/B,YAAyC,UAAuB;QAAvB,eAAU,GAAV,UAAU,CAAa;IAAG,CAAC;IAGpE,KAAK,CAAC,GAAG,CACP,MAA2B,EAC3B,MAAqB,EACrB,KAAoB,EACpB,OAAsB,EACtB,UAAgC,EAAE;QAElC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;QAClD,IAAI,CAAC,OAAO,CAAC,MAAM;YAAE,OAAO;QAE5B,MAAM,QAAQ,GAAsC,EAAE,CAAC;QACvD,MAAM,QAAQ,GAAsC,EAAE,CAAC;QACvD,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC;YACrC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,EAAE,CAAC;QACrC,CAAC;QACD,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC;QAC3D,MAAM,OAAO,CAAC,MAAM,CAAC,8CAAoB,EAAE;YACzC,WAAW,EAAE,MAAM,CAAC,UAAU;YAC9B,SAAS,EAAE,MAAM,CAAC,QAAQ;YAC1B,SAAS,EAAE,4BAAY,CAAC,EAAE,CACxB,+BAAW,EACX,iCAAa,EACb,OAAO,CAAC,MAAM,IAAI,+BAAW,CAAC,MAAM,CACrC;YACD,OAAO,EAAE,OAAO;YAChB,SAAS,EAAE,QAAQ;YACnB,SAAS,EAAE,QAAQ;SACpB,CAAC,CAAC;IACL,CAAC;IAGD,KAAK,CAAC,OAAO,CACX,UAAkB,EAClB,QAAgB,EAChB,MAA4B;QAE5B,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,IAAA,wCAAe,EAAC,MAAM,CAAC,CAAC;QAEhD,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU;aAC7B,kBAAkB,CAAC,8CAAoB,EAAE,KAAK,CAAC;aAC/C,KAAK,CAAC,+BAA+B,EAAE,EAAE,UAAU,EAAE,CAAC;aACtD,QAAQ,CAAC,2BAA2B,EAAE,EAAE,QAAQ,EAAE,CAAC;aACnD,QAAQ,CAAC,wBAAwB,CAAC,CAAC;QACtC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACtC,QAAQ;iBACL,KAAK,EAAE;iBACP,QAAQ,CAAC,wBAAU,EAAE,YAAY,EAAE,6BAA6B,CAAC;iBACjE,QAAQ,CACP,mCAAe,EACf,aAAa,EACb,8BAA8B,CAC/B;iBACA,QAAQ,CAAC,YAAY,EAAE,QAAQ,CAAC;iBAChC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC;iBACtB,SAAS,CAAC,mBAAmB,EAAE,QAAQ,CAAC;iBACxC,SAAS,CAAC,aAAa,EAAE,SAAS,CAAC;iBACnC,SAAS,CACR,kDAAkD,EAClD,WAAW,CACZ;iBACA,SAAS,CAAC,eAAe,EAAE,WAAW,CAAC;iBACvC,SAAS,CAAC,eAAe,EAAE,WAAW,CAAC;iBACvC,SAAS,CAAC,gBAAgB,EAAE,YAAY,CAAC;iBACzC,OAAO,CAAC,gBAAgB,EAAE,MAAM,CAAC;iBACjC,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC;iBAC5B,MAAM,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC;iBAC1B,KAAK,CAAC,KAAK,CAAC;iBACZ,UAAU,EAAoB;YACjC,QAAQ,CAAC,QAAQ,EAAE;SACpB,CAAC,CAAC;QACH,OAAO,IAAA,uCAAc,EACnB,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EACpC,KAAK,EACL,IAAI,EACJ,KAAK,CACN,CAAC;IACJ,CAAC;IAGD,IAAI,CACF,MAAqB,EACrB,KAAoB,EACpB,UAAgC,EAAE;QAElC,MAAM,IAAI,GAAG,CAAC,MAAM,IAAI,EAAE,CAAwB,CAAC;QACnD,MAAM,EAAE,GAAG,CAAC,KAAK,IAAI,EAAE,CAAwB,CAAC;QAChD,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;QAC3D,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QACnE,MAAM,OAAO,GAA0B,EAAE,CAAC;QAC1C,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC;gBAAE,SAAS;YACjC,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;gBAAE,SAAS;YACzE,IAAI,IAAA,8BAAa,EAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,IAAA,8BAAa,EAAC,EAAE,CAAC,KAAK,CAAC,CAAC;gBAAE,SAAS;YACtE,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAC5D,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAEO,aAAa,CACnB,MAAqB,EACrB,KAAoB,EACpB,OAA6B;QAE7B,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC;YACtB,GAAG,mDAA6B;YAChC,GAAG,CAAC,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC;SACxB,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAC9B,OAAO,EACP,OAAO,CAAC,MAAM,IAAI,KAAK,EAAE,WAAW,IAAI,MAAM,EAAE,WAAW,CAC5D,CAAC;QACF,IAAI,QAAQ,EAAE,CAAC;YACb,KAAK,MAAM,MAAM,IAAI,QAAQ,CAAC,OAAO;gBACnC,IAAI,MAAM,CAAC,QAAQ,KAAK,KAAK;oBAAE,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;YAClE,KAAK,MAAM,QAAQ,IAAI,QAAQ,CAAC,SAAS;gBACvC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QACvC,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAEO,UAAU,CAChB,OAA6B,EAC7B,MAAsC;QAEtC,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,EAAE,UAAU,IAAI,IAAI,CAAC,UAAU,CAAC;QAClE,IAAI,CAAC,MAAM,IAAI,CAAC,UAAU,EAAE,WAAW,CAAC,MAAM,CAAC;YAAE,OAAO,IAAI,CAAC;QAC7D,OAAO,UAAU,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IACxC,CAAC;IAGO,UAAU,CAAC,KAAc;QAC/B,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;YACtB,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1E,OAAO,KAAK,YAAY,wBAAU,CAAC;IACrC,CAAC;IAEO,OAAO,CAAC,GAAqB;QACnC,MAAM,IAAI,GAAG,GAAG,CAAC,SAAS,IAAI,EAAE,CAAC;QACjC,MAAM,EAAE,GAAG,GAAG,CAAC,SAAS,IAAI,EAAE,CAAC;QAC/B,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QACnE,OAAO;YACL,EAAE,EAAE,GAAG,CAAC,EAAE;YACV,MAAM,EAAE,GAAG,CAAC,MAAM;YAClB,OAAO,EAAE,GAAG,CAAC,OAAO;YACpB,SAAS,EAAE,GAAG,CAAC,SAAS;YACxB,OAAO,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;gBACnC,KAAK;gBACL,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI;gBACzB,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,IAAI;aACtB,CAAC,CAAC;YACH,UAAU,EAAE,GAAG,CAAC,UAAU;SAC3B,CAAC;IACJ,CAAC;IAED,IAAY,UAAU;QACpB,IAAI,CAAC,IAAI,CAAC,UAAU;YAClB,MAAM,IAAI,wCAAkB,CAC1B,iFAAiF,CAClF,CAAC;QACJ,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;CACF,CAAA;AAtKY,oDAAoB;+BAApB,oBAAoB;IADhC,IAAA,mBAAU,GAAE;IAEE,WAAA,IAAA,iBAAQ,GAAE,CAAA;qCAA+B,oBAAU;GADrD,oBAAoB,CAsKhC"}

package/dist/common/services/system.constant.service.d.ts

@@ -0,0 +1,24 @@
+import { ModuleRef } from '@nestjs/core';
+import { DataSource } from 'typeorm';
+import type { SystemConstantView } from '../types/system.constant.types';
+export declare class SystemConstantService {
+    private readonly moduleRef;
+    private readonly dataSource?;
+    private catalogue;
+    private loading;
+    private generation;
+    constructor(moduleRef: ModuleRef, dataSource?: DataSource);
+    id(typeIdentifier: string, constantIdentifier: string): Promise<string>;
+    resolve(id: string): Promise<SystemConstantView | null>;
+    list(typeIdentifier: string): Promise<SystemConstantView[]>;
+    assertOfType(id: string, typeIdentifier: string): Promise<void>;
+    invalidate(): void;
+    private load;
+    private fetch;
+    private compare;
+    private ttlMs;
+    private properties;
+    private key;
+    private get connection();
+}
+//# sourceMappingURL=system.constant.service.d.ts.map

package/dist/common/services/system.constant.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"system.constant.service.d.ts","sourceRoot":"","sources":["../../../src/common/services/system.constant.service.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AASrC,OAAO,KAAK,EAEV,kBAAkB,EACnB,MAAM,gCAAgC,CAAC;AAOxC,qBACa,qBAAqB;IAO9B,OAAO,CAAC,QAAQ,CAAC,SAAS;IACd,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC;IAP1C,OAAO,CAAC,SAAS,CAAwC;IACzD,OAAO,CAAC,OAAO,CAAiD;IAEhE,OAAO,CAAC,UAAU,CAAK;gBAGJ,SAAS,EAAE,SAAS,EACR,UAAU,CAAC,EAAE,UAAU;IAIhD,EAAE,CACN,cAAc,EAAE,MAAM,EACtB,kBAAkB,EAAE,MAAM,GACzB,OAAO,CAAC,MAAM,CAAC;IAYZ,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC;IAKvD,IAAI,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAS3D,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAWrE,UAAU,IAAI,IAAI;YAMJ,IAAI;YAkBJ,KAAK;IAmCnB,OAAO,CAAC,OAAO;YAaD,KAAK;IAgBnB,OAAO,CAAC,UAAU;IAQlB,OAAO,CAAC,GAAG;IAIX,OAAO,KAAK,UAAU,GAIrB;CACF"}

package/dist/common/services/system.constant.service.js

@@ -0,0 +1,151 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SystemConstantService = void 0;
+const common_1 = require("@nestjs/common");
+const core_1 = require("@nestjs/core");
+const typeorm_1 = require("typeorm");
+const operation_exception_1 = require("../../global/exceptions/operation.exception");
+const environment_util_1 = require("../../global/utilities/environment.util");
+const system_constant_entity_1 = require("../entities/system.constant.entity");
+const system_constant_enum_1 = require("../enums/system.constant.enum");
+const system_property_service_1 = require("./system.property.service");
+let SystemConstantService = class SystemConstantService {
+    constructor(moduleRef, dataSource) {
+        this.moduleRef = moduleRef;
+        this.dataSource = dataSource;
+        this.catalogue = null;
+        this.loading = null;
+        this.generation = 0;
+    }
+    async id(typeIdentifier, constantIdentifier) {
+        const catalogue = await this.load();
+        const id = catalogue.byKey.get(this.key(typeIdentifier, constantIdentifier));
+        if (!id)
+            throw new operation_exception_1.OperationException(`${system_constant_enum_1.SystemConstantMessage.NOT_SEEDED}: ${typeIdentifier} / ${constantIdentifier}`);
+        return id;
+    }
+    async resolve(id) {
+        return (await this.load()).byId.get(id) ?? null;
+    }
+    async list(typeIdentifier) {
+        const catalogue = await this.load();
+        return (catalogue.byType.get(typeIdentifier) ?? []).flatMap((id) => {
+            const view = catalogue.byId.get(id);
+            return view ? [view] : [];
+        });
+    }
+    async assertOfType(id, typeIdentifier) {
+        const constant = await this.resolve(id);
+        if (constant?.type_identifier !== typeIdentifier)
+            throw new common_1.BadRequestException(system_constant_enum_1.SystemConstantMessage.WRONG_TYPE);
+    }
+    invalidate() {
+        this.generation += 1;
+        this.catalogue = null;
+        this.loading = null;
+    }
+    async load() {
+        const current = this.catalogue;
+        if (current && Date.now() - current.loadedAt < current.ttlMs)
+            return current;
+        const generation = this.generation;
+        let loading = this.loading;
+        if (loading === null) {
+            const started = this.fetch().finally(() => {
+                if (this.loading === started)
+                    this.loading = null;
+            });
+            this.loading = started;
+            loading = started;
+        }
+        const catalogue = await loading;
+        if (generation === this.generation)
+            this.catalogue = catalogue;
+        return catalogue;
+    }
+    async fetch() {
+        const [rows, ttlMs] = await Promise.all([
+            this.connection.getRepository(system_constant_entity_1.SystemConstantEntity).find({
+                relations: { type: true },
+            }),
+            this.ttlMs(),
+        ]);
+        const live = rows
+            .filter((row) => row.type && !row.type.deleted_at)
+            .sort((left, right) => this.compare(left, right));
+        const catalogue = {
+            byId: new Map(),
+            byKey: new Map(),
+            byType: new Map(),
+            loadedAt: Date.now(),
+            ttlMs,
+        };
+        for (const row of live) {
+            const typeIdentifier = row.type.identifier;
+            catalogue.byId.set(row.id, {
+                id: row.id,
+                type_identifier: typeIdentifier,
+                identifier: row.identifier,
+                name: row.name,
+                value: row.value ?? null,
+                is_system: row.is_system,
+            });
+            catalogue.byKey.set(this.key(typeIdentifier, row.identifier), row.id);
+            const ids = catalogue.byType.get(typeIdentifier) ?? [];
+            ids.push(row.id);
+            catalogue.byType.set(typeIdentifier, ids);
+        }
+        return catalogue;
+    }
+    compare(left, right) {
+        const order = (row) => {
+            const value = Number(row.attributes?.[system_constant_enum_1.SystemConstantDefault.SORT_ORDER_ATTRIBUTE]);
+            return Number.isFinite(value) ? value : Number.MAX_SAFE_INTEGER;
+        };
+        return order(left) - order(right) || left.name.localeCompare(right.name);
+    }
+    async ttlMs() {
+        const value = await this.properties()?.get(system_constant_enum_1.SystemConstantDefault.CACHE_TTL_PROPERTY);
+        const seconds = (0, environment_util_1.envInt)(value ?? undefined, system_constant_enum_1.SystemConstantBound.CACHE_TTL_SECONDS, {
+            min: system_constant_enum_1.SystemConstantBound.CACHE_TTL_MIN_SECONDS,
+            max: system_constant_enum_1.SystemConstantBound.CACHE_TTL_MAX_SECONDS,
+        });
+        return seconds * system_constant_enum_1.SystemConstantBound.MS_PER_SECOND;
+    }
+    properties() {
+        try {
+            return this.moduleRef.get(system_property_service_1.SystemPropertyService, { strict: false });
+        }
+        catch {
+            return null;
+        }
+    }
+    key(typeIdentifier, constantIdentifier) {
+        return `${typeIdentifier}:${constantIdentifier}`;
+    }
+    get connection() {
+        if (!this.dataSource)
+            throw new operation_exception_1.OperationException(system_constant_enum_1.SystemConstantMessage.NO_DATA_SOURCE);
+        return this.dataSource;
+    }
+};
+exports.SystemConstantService = SystemConstantService;
+exports.SystemConstantService = SystemConstantService = __decorate([
+    (0, common_1.Injectable)(),
+    __param(1, (0, common_1.Optional)()),
+    __metadata("design:paramtypes", [core_1.ModuleRef,
+        typeorm_1.DataSource])
+], SystemConstantService);
+//# sourceMappingURL=system.constant.service.js.map

package/dist/common/services/system.constant.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"system.constant.service.js","sourceRoot":"","sources":["../../../src/common/services/system.constant.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAA2E;AAC3E,uCAAyC;AACzC,qCAAqC;AACrC,qFAAiF;AACjF,8EAAiE;AACjE,+EAA0E;AAC1E,wEAIuC;AAKvC,uEAAkE;AAO3D,IAAM,qBAAqB,GAA3B,MAAM,qBAAqB;IAMhC,YACmB,SAAoB,EACzB,UAAwC;QADnC,cAAS,GAAT,SAAS,CAAW;QACR,eAAU,GAAV,UAAU,CAAa;QAP9C,cAAS,GAAmC,IAAI,CAAC;QACjD,YAAO,GAA4C,IAAI,CAAC;QAExD,eAAU,GAAG,CAAC,CAAC;IAKpB,CAAC;IAGJ,KAAK,CAAC,EAAE,CACN,cAAsB,EACtB,kBAA0B;QAE1B,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QACpC,MAAM,EAAE,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAC5B,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAC7C,CAAC;QACF,IAAI,CAAC,EAAE;YACL,MAAM,IAAI,wCAAkB,CAC1B,GAAG,4CAAqB,CAAC,UAAU,KAAK,cAAc,MAAM,kBAAkB,EAAE,CACjF,CAAC;QACJ,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,EAAU;QACtB,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC;IAClD,CAAC;IAGD,KAAK,CAAC,IAAI,CAAC,cAAsB;QAC/B,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QACpC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE;YACjE,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YACpC,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5B,CAAC,CAAC,CAAC;IACL,CAAC;IAGD,KAAK,CAAC,YAAY,CAAC,EAAU,EAAE,cAAsB;QACnD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACxC,IAAI,QAAQ,EAAE,eAAe,KAAK,cAAc;YAC9C,MAAM,IAAI,4BAAmB,CAAC,4CAAqB,CAAC,UAAU,CAAC,CAAC;IACpE,CAAC;IAOD,UAAU;QACR,IAAI,CAAC,UAAU,IAAI,CAAC,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;IACtB,CAAC;IAEO,KAAK,CAAC,IAAI;QAChB,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC;QAC/B,IAAI,OAAO,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,QAAQ,GAAG,OAAO,CAAC,KAAK;YAC1D,OAAO,OAAO,CAAC;QACjB,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QACnC,IAAI,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC3B,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;YACrB,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE;gBACxC,IAAI,IAAI,CAAC,OAAO,KAAK,OAAO;oBAAE,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;YACpD,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;YACvB,OAAO,GAAG,OAAO,CAAC;QACpB,CAAC;QACD,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC;QAChC,IAAI,UAAU,KAAK,IAAI,CAAC,UAAU;YAAE,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC/D,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,KAAK,CAAC,KAAK;QACjB,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACtC,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,6CAAoB,CAAC,CAAC,IAAI,CAAC;gBACvD,SAAS,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE;aAC1B,CAAC;YACF,IAAI,CAAC,KAAK,EAAE;SACb,CAAC,CAAC;QACH,MAAM,IAAI,GAAG,IAAI;aACd,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC;aACjD,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;QACpD,MAAM,SAAS,GAA4B;YACzC,IAAI,EAAE,IAAI,GAAG,EAAE;YACf,KAAK,EAAE,IAAI,GAAG,EAAE;YAChB,MAAM,EAAE,IAAI,GAAG,EAAE;YACjB,QAAQ,EAAE,IAAI,CAAC,GAAG,EAAE;YACpB,KAAK;SACN,CAAC;QACF,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,MAAM,cAAc,GAAG,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC;YAC3C,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,EAAE;gBACzB,EAAE,EAAE,GAAG,CAAC,EAAE;gBACV,eAAe,EAAE,cAAc;gBAC/B,UAAU,EAAE,GAAG,CAAC,UAAU;gBAC1B,IAAI,EAAE,GAAG,CAAC,IAAI;gBACd,KAAK,EAAE,GAAG,CAAC,KAAK,IAAI,IAAI;gBACxB,SAAS,EAAE,GAAG,CAAC,SAAS;aACzB,CAAC,CAAC;YACH,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,GAAG,CAAC,UAAU,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;YACtE,MAAM,GAAG,GAAG,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC;YACvD,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YACjB,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC;QAC5C,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,OAAO,CACb,IAA0B,EAC1B,KAA2B;QAE3B,MAAM,KAAK,GAAG,CAAC,GAAyB,EAAU,EAAE;YAClD,MAAM,KAAK,GAAG,MAAM,CAClB,GAAG,CAAC,UAAU,EAAE,CAAC,4CAAqB,CAAC,oBAAoB,CAAC,CAC7D,CAAC;YACF,OAAO,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,gBAAgB,CAAC;QAClE,CAAC,CAAC;QACF,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC3E,CAAC;IAEO,KAAK,CAAC,KAAK;QACjB,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,EAAE,GAAG,CACxC,4CAAqB,CAAC,kBAAkB,CACzC,CAAC;QACF,MAAM,OAAO,GAAG,IAAA,yBAAM,EACpB,KAAK,IAAI,SAAS,EAClB,0CAAmB,CAAC,iBAAiB,EACrC;YACE,GAAG,EAAE,0CAAmB,CAAC,qBAAqB;YAC9C,GAAG,EAAE,0CAAmB,CAAC,qBAAqB;SAC/C,CACF,CAAC;QACF,OAAO,OAAO,GAAG,0CAAmB,CAAC,aAAa,CAAC;IACrD,CAAC;IAGO,UAAU;QAChB,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,+CAAqB,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;QACtE,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAEO,GAAG,CAAC,cAAsB,EAAE,kBAA0B;QAC5D,OAAO,GAAG,cAAc,IAAI,kBAAkB,EAAE,CAAC;IACnD,CAAC;IAED,IAAY,UAAU;QACpB,IAAI,CAAC,IAAI,CAAC,UAAU;YAClB,MAAM,IAAI,wCAAkB,CAAC,4CAAqB,CAAC,cAAc,CAAC,CAAC;QACrE,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;CACF,CAAA;AA7JY,sDAAqB;gCAArB,qBAAqB;IADjC,IAAA,mBAAU,GAAE;IASR,WAAA,IAAA,iBAAQ,GAAE,CAAA;qCADiB,gBAAS;QACK,oBAAU;GAR3C,qBAAqB,CA6JjC"}

package/dist/common/system.property.module.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"system.property.module.d.ts","sourceRoot":"","sources":["../../src/common/system.property.module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAoB,MAAM,gBAAgB,CAAC;AAOjE,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AACjF,YAAY,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AA2BjF,qBAKa,oBAAoB;IAC/B,MAAM,CAAC,QAAQ,CAAC,OAAO,GAAE,2BAAgC,GAAG,aAAa;CAQ1E"}
+{"version":3,"file":"system.property.module.d.ts","sourceRoot":"","sources":["../../src/common/system.property.module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAoB,MAAM,gBAAgB,CAAC;AAQjE,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AACjF,YAAY,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAuCjF,qBAKa,oBAAoB;IAC/B,MAAM,CAAC,QAAQ,CAAC,OAAO,GAAE,2BAAgC,GAAG,aAAa;CAQ1E"}

package/dist/common/system.property.module.js

@@ -14,6 +14,7 @@ const common_module_1 = require("./common.module");
 const cache_service_1 = require("./services/cache.service");
 const encryption_service_1 = require("./services/encryption.service");
 const system_property_service_1 = require("./services/system.property.service");
+const idempotency_service_1 = require("./services/idempotency.service");
 function createSystemPropertyProviders(options = {}) {
     return [
         {
@@ -25,6 +26,14 @@ function createSystemPropertyProviders(options = {}) {
                 cache_service_1.CacheService,
             ],
         },
+        {
+            provide: idempotency_service_1.IdempotencyService,
+            useFactory: (systemPropertyService, dataSource) => new idempotency_service_1.IdempotencyService(systemPropertyService, dataSource),
+            inject: [
+                system_property_service_1.SystemPropertyService,
+                (0, typeorm_1.getDataSourceToken)(options.dataSourceName),
+            ],
+        },
     ];
 }
 let SystemPropertyModule = SystemPropertyModule_1 = class SystemPropertyModule {
@@ -33,7 +42,7 @@ let SystemPropertyModule = SystemPropertyModule_1 = class SystemPropertyModule {
             module: SystemPropertyModule_1,
             imports: [common_module_1.CommonModule],
             providers: createSystemPropertyProviders(options),
-            exports: [system_property_service_1.SystemPropertyService],
+            exports: [system_property_service_1.SystemPropertyService, idempotency_service_1.IdempotencyService],
         };
     }
 };
@@ -42,7 +51,7 @@ exports.SystemPropertyModule = SystemPropertyModule = SystemPropertyModule_1 = _
     (0, common_1.Module)({
         imports: [common_module_1.CommonModule],
         providers: createSystemPropertyProviders(),
-        exports: [system_property_service_1.SystemPropertyService],
+        exports: [system_property_service_1.SystemPropertyService, idempotency_service_1.IdempotencyService],
     })
 ], SystemPropertyModule);
 //# sourceMappingURL=system.property.module.js.map