@driveup/schema 0.1.0

package/lib/user/verification.entity.js

@@ -0,0 +1,142 @@
+"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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserVerificationEntity = void 0;
+const typeorm_1 = require("typeorm");
+const common_1 = require("@driveup/common");
+const utils_1 = require("../utils");
+/**
+ * Represents a verification token for phone or email verification.
+ * Used for account verification, password recovery, and other secure operations.
+ * Tokens have expiration dates and track confirmation attempts.
+ *
+ * @extends TrackableEntity
+ */
+let UserVerificationEntity = class UserVerificationEntity extends utils_1.TrackableEntity {
+    /**
+     * Phone number to be verified
+     */
+    phone;
+    /**
+     * Email address to be verified
+     */
+    email;
+    /**
+     * Verification token (OTP or UUID)
+     */
+    token;
+    /**
+     * Optional URL for email verification links
+     */
+    url;
+    /**
+     * Whether the verification has been confirmed
+     * @default false
+     */
+    confirmed;
+    /**
+     * Expiration date/time for the verification token
+     */
+    expiredOn;
+    /**
+     * Number of verification attempts made
+     * @default 0
+     */
+    attempts;
+    /**
+     * Creates an instance of UserVerificationEntity
+     * @param props - Partial properties to initialize the entity
+     */
+    constructor(props) {
+        super();
+        Object.assign(this, props);
+    }
+    toModel() {
+        return {
+            id: this.id,
+            phone: this.phone,
+            email: this.email,
+            token: this.token,
+            url: this.url,
+            confirmed: this.confirmed,
+            expiredOn: this.expiredOn,
+            attempts: this.attempts,
+        };
+    }
+    /**
+     * Returns a summary representation of the user
+     * @returns Model instance (same as toModel())
+     */
+    toSummary() {
+        return this.toModel();
+    }
+    /**
+     * Retrieves all activity records for this verification
+     * @returns Array of Activity objects
+     */
+    async getActivities() {
+        const activities = [];
+        activities.push(await (0, utils_1.toActivity)(this.createdBy, common_1.ActivityType.createdBy));
+        activities.push(await (0, utils_1.toActivity)(this.createdOn, common_1.ActivityType.createdOn));
+        activities.push(await (0, utils_1.toActivity)(this.updatedBy, common_1.ActivityType.updatedBy));
+        activities.push(await (0, utils_1.toActivity)(this.updatedOn, common_1.ActivityType.updatedOn));
+        return activities.filter(a => a);
+    }
+};
+exports.UserVerificationEntity = UserVerificationEntity;
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", String)
+], UserVerificationEntity.prototype, "phone", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", String)
+], UserVerificationEntity.prototype, "email", void 0);
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", String)
+], UserVerificationEntity.prototype, "token", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", String)
+], UserVerificationEntity.prototype, "url", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+        default: false
+    }),
+    __metadata("design:type", Boolean)
+], UserVerificationEntity.prototype, "confirmed", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", Date)
+], UserVerificationEntity.prototype, "expiredOn", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ default: 0 }),
+    __metadata("design:type", Number)
+], UserVerificationEntity.prototype, "attempts", void 0);
+exports.UserVerificationEntity = UserVerificationEntity = __decorate([
+    (0, typeorm_1.Entity)('userVerifications'),
+    __metadata("design:paramtypes", [Object])
+], UserVerificationEntity);
+//# sourceMappingURL=verification.entity.js.map

package/lib/user/verification.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"verification.entity.js","sourceRoot":"","sources":["../../src/user/verification.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qCAAyC;AACzC,4CAAyD;AACzD,oCAAuD;AAEvD;;;;;;GAMG;AAEI,IAAM,sBAAsB,GAA5B,MAAM,sBAAuB,SAAQ,uBAAe;IAE1D;;OAEG;IAKH,KAAK,CAAS;IAEd;;OAEG;IAKH,KAAK,CAAS;IAEd;;OAEG;IAEH,KAAK,CAAS;IAEd;;OAEG;IAKH,GAAG,CAAS;IAEZ;;;OAGG;IAKH,SAAS,CAAU;IAEnB;;OAEG;IAKH,SAAS,CAAO;IAEhB;;;OAGG;IAEH,QAAQ,CAAS;IAEjB;;;OAGG;IACH,YAAY,KAAuC;QAClD,KAAK,EAAE,CAAC;QACR,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC5B,CAAC;IAED,OAAO;QACN,OAAO;YACN,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACvB,CAAA;IACF,CAAC;IAED;;;OAGG;IACH,SAAS;QACR,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;IACvB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,aAAa;QAClB,MAAM,UAAU,GAAe,EAAE,CAAC;QAClC,UAAU,CAAC,IAAI,CAAC,MAAM,IAAA,kBAAU,EAAC,IAAI,CAAC,SAAS,EAAE,qBAAY,CAAC,SAAS,CAAC,CAAC,CAAC;QAC1E,UAAU,CAAC,IAAI,CAAC,MAAM,IAAA,kBAAU,EAAC,IAAI,CAAC,SAAS,EAAE,qBAAY,CAAC,SAAS,CAAC,CAAC,CAAC;QAC1E,UAAU,CAAC,IAAI,CAAC,MAAM,IAAA,kBAAU,EAAC,IAAI,CAAC,SAAS,EAAE,qBAAY,CAAC,SAAS,CAAC,CAAC,CAAC;QAC1E,UAAU,CAAC,IAAI,CAAC,MAAM,IAAA,kBAAU,EAAC,IAAI,CAAC,SAAS,EAAE,qBAAY,CAAC,SAAS,CAAC,CAAC,CAAC;QAC1E,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAClC,CAAC;CACD,CAAA;AAvGY,wDAAsB;AASlC;IAJC,IAAA,gBAAM,EAAC;QACP,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;qDACY;AASd;IAJC,IAAA,gBAAM,EAAC;QACP,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;qDACY;AAMd;IADC,IAAA,gBAAM,GAAE;;qDACK;AASd;IAJC,IAAA,gBAAM,EAAC;QACP,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;mDACU;AAUZ;IAJC,IAAA,gBAAM,EAAC;QACP,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,KAAK;KACd,CAAC;;yDACiB;AASnB;IAJC,IAAA,gBAAM,EAAC;QACP,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;8BACS,IAAI;yDAAC;AAOhB;IADC,IAAA,gBAAM,EAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;;wDACN;iCA3DL,sBAAsB;IADlC,IAAA,gBAAM,EAAC,mBAAmB,CAAC;;GACf,sBAAsB,CAuGlC"}

package/lib/utils/activity.helper.d.ts

@@ -0,0 +1,26 @@
+import { Activity, ActivityType, Person } from "@driveup/common";
+import { BaseEntity } from "typeorm";
+/**
+ * Creates an Activity instance from a value and activity type.
+ * Handles both user ID references (for 'by' activities) and Date values (for 'on' activities).
+ *
+ * This utility function is used to transform tracking fields (createdBy, updatedBy, etc.)
+ * into Activity objects with person or date information.
+ *
+ * @template T - Entity type that extends BaseEntity and has a toPerson method
+ * @param value - Either a user ID (number) or a Date
+ * @param type - The type of activity (e.g., createdBy, updatedBy, createdOn)
+ * @param entityClass - Entity class to fetch user data from (defaults to UserEntity)
+ * @returns Promise resolving to Activity instance or undefined if no value provided
+ *
+ * @example
+ * ```typescript
+ * const createdActivity = await toActivity(this.createdBy, ActivityType.createdBy, StaffEntity);
+ * const createdOnActivity = await toActivity(this.createdOn, ActivityType.createdOn);
+ * ```
+ */
+export declare function toActivity<T extends BaseEntity>(value: number | Date, type: ActivityType, entityClass?: {
+    findOneBy: (criteria: any) => Promise<T & {
+        toPerson: () => Person;
+    }>;
+}): Promise<Activity | undefined>;

package/lib/utils/activity.helper.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toActivity = toActivity;
+const common_1 = require("@driveup/common");
+const user_entity_1 = require("../user/user.entity");
+/**
+ * Creates an Activity instance from a value and activity type.
+ * Handles both user ID references (for 'by' activities) and Date values (for 'on' activities).
+ *
+ * This utility function is used to transform tracking fields (createdBy, updatedBy, etc.)
+ * into Activity objects with person or date information.
+ *
+ * @template T - Entity type that extends BaseEntity and has a toPerson method
+ * @param value - Either a user ID (number) or a Date
+ * @param type - The type of activity (e.g., createdBy, updatedBy, createdOn)
+ * @param entityClass - Entity class to fetch user data from (defaults to UserEntity)
+ * @returns Promise resolving to Activity instance or undefined if no value provided
+ *
+ * @example
+ * ```typescript
+ * const createdActivity = await toActivity(this.createdBy, ActivityType.createdBy, StaffEntity);
+ * const createdOnActivity = await toActivity(this.createdOn, ActivityType.createdOn);
+ * ```
+ */
+async function toActivity(value, type, entityClass = user_entity_1.UserEntity) {
+    if (!value)
+        return;
+    if (typeof value === 'number') {
+        const id = value;
+        const entity = await entityClass.findOneBy({ id });
+        const person = entity?.toPerson();
+        return new common_1.Activity({ type, person });
+    }
+    if (value instanceof Date) {
+        return new common_1.Activity({ type, date: value });
+    }
+    return;
+}
+//# sourceMappingURL=activity.helper.js.map

package/lib/utils/activity.helper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"activity.helper.js","sourceRoot":"","sources":["../../src/utils/activity.helper.ts"],"names":[],"mappings":";;AAuBA,gCAkBC;AAzCD,4CAAiE;AAEjE,qDAAiD;AAEjD;;;;;;;;;;;;;;;;;;GAkBG;AACI,KAAK,UAAU,UAAU,CAC/B,KAAoB,EACpB,IAAkB,EAClB,cAEI,wBAAU;IAEd,IAAI,CAAC,KAAK;QAAE,OAAO;IACnB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC/B,MAAM,EAAE,GAAG,KAAe,CAAC;QAC3B,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,SAAS,CAAC,EAAC,EAAE,EAAC,CAAC,CAAA;QAChD,MAAM,MAAM,GAAG,MAAM,EAAE,QAAQ,EAAE,CAAC;QAClC,OAAO,IAAI,iBAAQ,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;IACvC,CAAC;IACD,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;QAC3B,OAAO,IAAI,iBAAQ,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IAC5C,CAAC;IACD,OAAO;AACR,CAAC"}

package/lib/utils/index.d.ts

@@ -0,0 +1,4 @@
+export * from './activity.helper';
+export * from './json-metrics.transform';
+export * from './numeric.transform';
+export * from './trackable.entity';

package/lib/utils/index.js

@@ -0,0 +1,21 @@
+"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("./activity.helper"), exports);
+__exportStar(require("./json-metrics.transform"), exports);
+__exportStar(require("./numeric.transform"), exports);
+__exportStar(require("./trackable.entity"), exports);
+//# sourceMappingURL=index.js.map

package/lib/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAkC;AAClC,2DAAyC;AACzC,sDAAoC;AACpC,qDAAmC"}

package/lib/utils/json-metrics.transform.d.ts

@@ -0,0 +1,35 @@
+import { ValueTransformer } from 'typeorm';
+/**
+ * TypeORM value transformer for JSON metrics columns.
+ * Converts metric values in JSON objects to numeric types, ensuring all values
+ * are valid numbers (defaulting to 0 for invalid or null values).
+ * Useful for database columns that store metrics as JSON key-value pairs.
+ *
+ * @implements {ValueTransformer}
+ * @example
+ * ```typescript
+ * @Column({
+ *   type: 'json',
+ *   transformer: new ColumnJsonMetricsTransformer()
+ * })
+ * metrics: Record<string, number>;
+ * ```
+ */
+export declare class ColumnJsonMetricsTransformer implements ValueTransformer {
+    /**
+     * Transforms a JSON object before persisting to the database.
+     * Converts all values in the JSON object to numbers, defaulting to 0 for invalid values.
+     *
+     * @param json - The JSON object to transform
+     * @returns Transformed JSON object with numeric values, or null if input is null/undefined
+     */
+    to(json?: Record<string, any> | null): Record<string, any> | null;
+    /**
+     * Transforms a JSON object when loading from the database.
+     * Converts all values in the JSON object to numbers, defaulting to 0 for invalid values.
+     *
+     * @param json - The JSON object loaded from the database
+     * @returns Transformed JSON object with numeric values, or null if input is null/undefined
+     */
+    from(json?: Record<string, any> | null): Record<string, any> | null;
+}

package/lib/utils/json-metrics.transform.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ColumnJsonMetricsTransformer = void 0;
+/**
+ * Type guard that checks if a value is null or undefined.
+ *
+ * @template T - The type of the value being checked
+ * @param obj - The value to check
+ * @returns True if the value is null or undefined, false otherwise
+ */
+function isNullOrUndefined(obj) {
+    return typeof obj === 'undefined' || obj === null;
+}
+/**
+ * TypeORM value transformer for JSON metrics columns.
+ * Converts metric values in JSON objects to numeric types, ensuring all values
+ * are valid numbers (defaulting to 0 for invalid or null values).
+ * Useful for database columns that store metrics as JSON key-value pairs.
+ *
+ * @implements {ValueTransformer}
+ * @example
+ * ```typescript
+ * @Column({
+ *   type: 'json',
+ *   transformer: new ColumnJsonMetricsTransformer()
+ * })
+ * metrics: Record<string, number>;
+ * ```
+ */
+class ColumnJsonMetricsTransformer {
+    /**
+     * Transforms a JSON object before persisting to the database.
+     * Converts all values in the JSON object to numbers, defaulting to 0 for invalid values.
+     *
+     * @param json - The JSON object to transform
+     * @returns Transformed JSON object with numeric values, or null if input is null/undefined
+     */
+    to(json) {
+        if (!isNullOrUndefined(json)) {
+            for (const key in json) {
+                if (Object.prototype.hasOwnProperty.call(json, key)) {
+                    const value = json[key];
+                    if (!isNullOrUndefined(value)) {
+                        const res = parseFloat(value);
+                        json[key] = isNaN(res) ? 0 : res;
+                    }
+                    else {
+                        json[key] = 0;
+                    }
+                }
+            }
+            return json;
+        }
+        return null;
+    }
+    /**
+     * Transforms a JSON object when loading from the database.
+     * Converts all values in the JSON object to numbers, defaulting to 0 for invalid values.
+     *
+     * @param json - The JSON object loaded from the database
+     * @returns Transformed JSON object with numeric values, or null if input is null/undefined
+     */
+    from(json) {
+        if (!isNullOrUndefined(json)) {
+            for (const key in json) {
+                if (Object.prototype.hasOwnProperty.call(json, key)) {
+                    const value = json[key];
+                    if (!isNullOrUndefined(value)) {
+                        const res = parseFloat(value);
+                        json[key] = isNaN(res) ? 0 : res;
+                    }
+                    else {
+                        json[key] = 0;
+                    }
+                }
+            }
+            return json;
+        }
+        return null;
+    }
+}
+exports.ColumnJsonMetricsTransformer = ColumnJsonMetricsTransformer;
+//# sourceMappingURL=json-metrics.transform.js.map

package/lib/utils/json-metrics.transform.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"json-metrics.transform.js","sourceRoot":"","sources":["../../src/utils/json-metrics.transform.ts"],"names":[],"mappings":";;;AAEA;;;;;;GAMG;AACH,SAAS,iBAAiB,CAAI,GAAyB;IACtD,OAAO,OAAO,GAAG,KAAK,WAAW,IAAI,GAAG,KAAK,IAAI,CAAC;AACnD,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAa,4BAA4B;IACxC;;;;;;OAMG;IACH,EAAE,CAAC,IAAiC;QACnC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC;YAC9B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACxB,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC;oBACrD,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;oBACxB,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE,CAAC;wBAC/B,MAAM,GAAG,GAAG,UAAU,CAAC,KAAY,CAAC,CAAC;wBACrC,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;oBAClC,CAAC;yBAAM,CAAC;wBACP,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;oBACf,CAAC;gBACF,CAAC;YACF,CAAC;YACD,OAAO,IAAW,CAAC;QACpB,CAAC;QACD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;OAMG;IACH,IAAI,CAAC,IAAiC;QACrC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC;YAC9B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACxB,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC;oBACrD,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;oBACxB,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE,CAAC;wBAC/B,MAAM,GAAG,GAAG,UAAU,CAAC,KAAY,CAAC,CAAC;wBACrC,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;oBAClC,CAAC;yBAAM,CAAC;wBACP,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;oBACf,CAAC;gBACF,CAAC;YACF,CAAC;YACD,OAAO,IAAW,CAAC;QACpB,CAAC;QACD,OAAO,IAAI,CAAC;IACb,CAAC;CACD;AAlDD,oEAkDC"}

package/lib/utils/numeric.transform.d.ts

@@ -0,0 +1,38 @@
+import { ValueTransformer } from 'typeorm';
+/**
+ * TypeORM value transformer for numeric columns.
+ * Handles conversion between JavaScript numbers and database numeric types,
+ * ensuring values are valid numbers (defaulting to 0 for invalid or null values).
+ * Particularly useful for DECIMAL columns that may return string values from the database.
+ *
+ * @implements {ValueTransformer}
+ * @example
+ * ```typescript
+ * @Column({
+ *   type: 'decimal',
+ *   precision: 8,
+ *   scale: 2,
+ *   transformer: new ColumnNumericTransformer()
+ * })
+ * price: number;
+ * ```
+ */
+export declare class ColumnNumericTransformer implements ValueTransformer {
+    /**
+     * Transforms a number value before persisting to the database.
+     * Converts the value to a float, defaulting to 0 for invalid or null values.
+     *
+     * @param val - The number value to transform
+     * @returns Validated numeric value, or 0 if input is invalid or null/undefined
+     */
+    to(val?: number | null): number | null;
+    /**
+     * Transforms a string value when loading from the database.
+     * Converts the string to a float number, defaulting to 0 for invalid or null values.
+     * Database DECIMAL columns often return values as strings, so this conversion is necessary.
+     *
+     * @param val - The string value loaded from the database
+     * @returns Parsed numeric value, or 0 if input is invalid or null/undefined
+     */
+    from(val?: string | null): number | null;
+}

package/lib/utils/numeric.transform.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ColumnNumericTransformer = void 0;
+/**
+ * Type guard that checks if a value is null or undefined.
+ *
+ * @template T - The type of the value being checked
+ * @param obj - The value to check
+ * @returns True if the value is null or undefined, false otherwise
+ */
+function isNullOrUndefined(obj) {
+    return typeof obj === 'undefined' || obj === null;
+}
+/**
+ * TypeORM value transformer for numeric columns.
+ * Handles conversion between JavaScript numbers and database numeric types,
+ * ensuring values are valid numbers (defaulting to 0 for invalid or null values).
+ * Particularly useful for DECIMAL columns that may return string values from the database.
+ *
+ * @implements {ValueTransformer}
+ * @example
+ * ```typescript
+ * @Column({
+ *   type: 'decimal',
+ *   precision: 8,
+ *   scale: 2,
+ *   transformer: new ColumnNumericTransformer()
+ * })
+ * price: number;
+ * ```
+ */
+class ColumnNumericTransformer {
+    /**
+     * Transforms a number value before persisting to the database.
+     * Converts the value to a float, defaulting to 0 for invalid or null values.
+     *
+     * @param val - The number value to transform
+     * @returns Validated numeric value, or 0 if input is invalid or null/undefined
+     */
+    to(val) {
+        if (!isNullOrUndefined(val)) {
+            const res = parseFloat(val);
+            if (isNaN(res)) {
+                return 0;
+            }
+            else {
+                return res;
+            }
+        }
+        return 0;
+    }
+    /**
+     * Transforms a string value when loading from the database.
+     * Converts the string to a float number, defaulting to 0 for invalid or null values.
+     * Database DECIMAL columns often return values as strings, so this conversion is necessary.
+     *
+     * @param val - The string value loaded from the database
+     * @returns Parsed numeric value, or 0 if input is invalid or null/undefined
+     */
+    from(val) {
+        if (!isNullOrUndefined(val)) {
+            const res = parseFloat(val);
+            if (isNaN(res)) {
+                return 0;
+            }
+            else {
+                return res;
+            }
+        }
+        return 0;
+    }
+}
+exports.ColumnNumericTransformer = ColumnNumericTransformer;
+//# sourceMappingURL=numeric.transform.js.map

package/lib/utils/numeric.transform.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"numeric.transform.js","sourceRoot":"","sources":["../../src/utils/numeric.transform.ts"],"names":[],"mappings":";;;AAEA;;;;;;GAMG;AACH,SAAS,iBAAiB,CAAI,GAAyB;IACtD,OAAO,OAAO,GAAG,KAAK,WAAW,IAAI,GAAG,KAAK,IAAI,CAAC;AACnD,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAa,wBAAwB;IACpC;;;;;;OAMG;IACH,EAAE,CAAC,GAAmB;QACrB,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,CAAC;YAC7B,MAAM,GAAG,GAAG,UAAU,CAAC,GAAU,CAAC,CAAC;YACnC,IAAI,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;gBAChB,OAAO,CAAC,CAAC;YACV,CAAC;iBAAM,CAAC;gBACP,OAAO,GAAG,CAAC;YACZ,CAAC;QACF,CAAC;QACD,OAAO,CAAC,CAAC;IACV,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,GAAmB;QACvB,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,CAAC;YAC7B,MAAM,GAAG,GAAG,UAAU,CAAC,GAAU,CAAC,CAAC;YACnC,IAAI,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;gBAChB,OAAO,CAAC,CAAC;YACV,CAAC;iBAAM,CAAC;gBACP,OAAO,GAAG,CAAC;YACZ,CAAC;QACF,CAAC;QACD,OAAO,CAAC,CAAC;IACV,CAAC;CACD;AAvCD,4DAuCC"}

package/lib/utils/trackable.entity.d.ts

@@ -0,0 +1,82 @@
+import { Activity, Language } from '@driveup/common';
+import { BaseEntity } from 'typeorm';
+/**
+ * Abstract base entity with comprehensive audit tracking properties.
+ * Provides automatic tracking of creation, updates, and soft deletion with user attribution.
+ * All entities requiring an audit trail should extend this class.
+ *
+ * @template T - The model type that the entity converts to
+ * @extends BaseEntity
+ *
+ * @example
+ * ```typescript
+ * @Entity('users')
+ * export class UserEntity extends TrackableEntity<User> {
+ *   // entity properties
+ *
+ *   toModel() {
+ *     return new User({ id: this.id, ... });
+ *   }
+ *
+ *   async getActivities() {
+ *     return [];
+ *   }
+ * }
+ * ```
+ */
+export declare abstract class TrackableEntity<T = any> extends BaseEntity {
+    /**
+     * Primary key - auto-generated sequential ID
+     */
+    id: number;
+    /**
+     * ID of the user who created this entity
+     */
+    createdBy: number;
+    /**
+     * Timestamp when the entity was created
+     * Automatically set by TypeORM
+     */
+    createdOn: Date;
+    /**
+     * ID of the user who last updated this entity
+     */
+    updatedBy: number;
+    /**
+     * Timestamp when the entity was last updated
+     * Automatically updated by TypeORM
+     */
+    updatedOn: Date;
+    /**
+     * ID of the user who soft-deleted this entity
+     */
+    deletedBy: number;
+    /**
+     * Timestamp when the entity was soft-deleted
+     * When set, the entity is excluded from normal queries
+     */
+    deletedOn: Date;
+    /**
+     * Converts the entity to its corresponding model instance.
+     * Must be implemented by child classes to define transformation logic.
+     *
+     * @param lang - Optional language for localized content
+     * @returns Model instance or Promise resolving to model instance
+     */
+    abstract toModel(lang?: Language): T | Promise<T>;
+    /**
+     * Converts the entity to a summary representation.
+     * Must be implemented by child classes to define summary transformation logic.
+     *
+     * @param lang - Optional language for localized content
+     * @returns Summary model instance or Promise resolving to summary model instance
+     */
+    abstract toSummary(lang?: Language): T | Promise<T>;
+    /**
+     * Retrieves all activity records associated with this entity.
+     * Must be implemented by child classes to return their specific activity relations.
+     *
+     * @returns Promise resolving to array of Activity objects
+     */
+    abstract getActivities(): Promise<Activity[]>;
+}

package/lib/utils/trackable.entity.js

@@ -0,0 +1,100 @@
+"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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TrackableEntity = void 0;
+const typeorm_1 = require("typeorm");
+/**
+ * Abstract base entity with comprehensive audit tracking properties.
+ * Provides automatic tracking of creation, updates, and soft deletion with user attribution.
+ * All entities requiring an audit trail should extend this class.
+ *
+ * @template T - The model type that the entity converts to
+ * @extends BaseEntity
+ *
+ * @example
+ * ```typescript
+ * @Entity('users')
+ * export class UserEntity extends TrackableEntity<User> {
+ *   // entity properties
+ *
+ *   toModel() {
+ *     return new User({ id: this.id, ... });
+ *   }
+ *
+ *   async getActivities() {
+ *     return [];
+ *   }
+ * }
+ * ```
+ */
+class TrackableEntity extends typeorm_1.BaseEntity {
+    /**
+     * Primary key - auto-generated sequential ID
+     */
+    id;
+    /**
+     * ID of the user who created this entity
+     */
+    createdBy;
+    /**
+     * Timestamp when the entity was created
+     * Automatically set by TypeORM
+     */
+    createdOn;
+    /**
+     * ID of the user who last updated this entity
+     */
+    updatedBy;
+    /**
+     * Timestamp when the entity was last updated
+     * Automatically updated by TypeORM
+     */
+    updatedOn;
+    /**
+     * ID of the user who soft-deleted this entity
+     */
+    deletedBy;
+    /**
+     * Timestamp when the entity was soft-deleted
+     * When set, the entity is excluded from normal queries
+     */
+    deletedOn;
+}
+exports.TrackableEntity = TrackableEntity;
+__decorate([
+    (0, typeorm_1.PrimaryGeneratedColumn)(),
+    __metadata("design:type", Number)
+], TrackableEntity.prototype, "id", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, default: null }),
+    __metadata("design:type", Number)
+], TrackableEntity.prototype, "createdBy", void 0);
+__decorate([
+    (0, typeorm_1.CreateDateColumn)({ nullable: true, default: null }),
+    __metadata("design:type", Date)
+], TrackableEntity.prototype, "createdOn", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, default: null }),
+    __metadata("design:type", Number)
+], TrackableEntity.prototype, "updatedBy", void 0);
+__decorate([
+    (0, typeorm_1.UpdateDateColumn)({ nullable: true, default: null }),
+    __metadata("design:type", Date)
+], TrackableEntity.prototype, "updatedOn", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, default: null }),
+    __metadata("design:type", Number)
+], TrackableEntity.prototype, "deletedBy", void 0);
+__decorate([
+    (0, typeorm_1.DeleteDateColumn)({ nullable: true, default: null }),
+    __metadata("design:type", Date)
+], TrackableEntity.prototype, "deletedOn", void 0);
+//# sourceMappingURL=trackable.entity.js.map