@driveup/schema 0.1.4 → 0.1.5

package/lib/utils/index.d.ts

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

package/lib/utils/index.js

@@ -17,5 +17,5 @@ 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);
+__exportStar(require("./trackable"), exports);
 //# sourceMappingURL=index.js.map

package/lib/utils/index.js.map

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

package/lib/utils/trackable.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.js

@@ -0,0 +1,69 @@
+"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 {
+}
+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.js.map

package/lib/utils/trackable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"trackable.js","sourceRoot":"","sources":["../../src/utils/trackable.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,qCAA2H;AAE3H;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAsB,eAAuB,SAAQ,oBAAU;CAyE9D;AAzED,0CAyEC;AAnEA;IADC,IAAA,gCAAsB,GAAE;;2CACd;AAMX;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;;kDACxB;AAOlB;IADC,IAAA,0BAAgB,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;8BACzC,IAAI;kDAAC;AAMhB;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;;kDACxB;AAOlB;IADC,IAAA,0BAAgB,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;8BACzC,IAAI;kDAAC;AAMhB;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;;kDACxB;AAOlB;IADC,IAAA,0BAAgB,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;8BACzC,IAAI;kDAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@driveup/schema",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "description": "Driveup Entity Schema",
   "author": "Intelact Solutions Ltd.",
   "main": "lib/index.js",