@driveup/schema 0.1.0

package/lib/profile/agent/agent.entity.d.ts

@@ -0,0 +1,95 @@
+import { AccountStatus, Language, Activity, Agent, Person } from '@driveup/common';
+import { BankAccount, Preference } from '@driveup/common';
+import { UserEntity } from '../../user/user.entity';
+import { AgentPayoutEntity } from './payout.entity';
+import { AgentPromotionEntity } from './promotion.entity';
+import { TrackableEntity } from '../../utils';
+/**
+ * Represents an agent profile in the system.
+ * Agents are users who promote Driveup services and earn commissions
+ * through a unique promotion code. They can receive payouts based on
+ * their generated revenue.
+ *
+ * @extends TrackableEntity<Agent>
+ */
+export declare class AgentEntity extends TrackableEntity<Agent> {
+    /**
+     * Reference to the user account
+     */
+    userId: number;
+    /**
+     * Account status of the agent profile
+     * @default AccountStatus.Pending
+     */
+    status: AccountStatus;
+    /**
+     * Agent's display name
+     */
+    name: string;
+    /**
+     * Preferred language for the agent interface
+     * @default Language.En
+     */
+    language: Language;
+    /**
+     * Unique promotion code for this agent
+     * Used by companies during onboarding to link to the agent
+     */
+    code: string;
+    /**
+     * Commission percentage earned on referred sales
+     * @default 50
+     */
+    percentage: number;
+    /**
+     * Bank account information for payouts
+     */
+    bankAccount: BankAccount;
+    /**
+     * Notification preferences stored as JSON
+     */
+    preferences: Preference[];
+    /**
+     * Agent user account
+     * User can have only one active agent profile
+     */
+    user: Promise<UserEntity>;
+    /**
+     * Agent promotions
+     */
+    promotions: Promise<AgentPromotionEntity[]>;
+    /**
+     * Promotion payouts
+     */
+    payouts: Promise<AgentPayoutEntity[]>;
+    /**
+     * Creates an instance of AgentEntity
+     * @param props - Partial properties to initialize the entity
+     */
+    constructor(props?: Partial<AgentEntity>);
+    /**
+     * Converts the entity to an Agent model instance
+     * @returns Agent model with basic information
+     */
+    toModel(): Promise<Agent>;
+    /**
+     * Converts the entity to an Agent model instance
+     * @returns Agent model with basic information
+     */
+    toSummary(): Promise<Agent>;
+    /**
+     * Converts the entity to a Person model
+     * @returns Promise resolving to Person model with basic contact information
+     */
+    toPerson(): Promise<Person>;
+    /**
+     * Retrieves notification preferences as typed Preference instances
+     * @returns Array of Preference objects or undefined if not set
+     */
+    getPreferences(): Preference<boolean>[];
+    /**
+     * Retrieves activity history for this agent
+     * @returns Promise resolving to array of Activity instances tracking creation and updates
+     */
+    getActivities(): Promise<Activity[]>;
+}

package/lib/profile/agent/agent.entity.js

@@ -0,0 +1,223 @@
+"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.AgentEntity = void 0;
+const typeorm_1 = require("typeorm");
+const common_1 = require("@driveup/common");
+const common_2 = require("@driveup/common");
+const user_entity_1 = require("../../user/user.entity");
+const payout_entity_1 = require("./payout.entity");
+const promotion_entity_1 = require("./promotion.entity");
+const utils_1 = require("../../utils");
+/**
+ * Represents an agent profile in the system.
+ * Agents are users who promote Driveup services and earn commissions
+ * through a unique promotion code. They can receive payouts based on
+ * their generated revenue.
+ *
+ * @extends TrackableEntity<Agent>
+ */
+let AgentEntity = class AgentEntity extends utils_1.TrackableEntity {
+    /**
+     * Reference to the user account
+     */
+    userId;
+    /**
+     * Account status of the agent profile
+     * @default AccountStatus.Pending
+     */
+    status;
+    /**
+     * Agent's display name
+     */
+    name;
+    /**
+     * Preferred language for the agent interface
+     * @default Language.En
+     */
+    language;
+    /**
+     * Unique promotion code for this agent
+     * Used by companies during onboarding to link to the agent
+     */
+    code;
+    /**
+     * Commission percentage earned on referred sales
+     * @default 50
+     */
+    percentage;
+    /**
+     * Bank account information for payouts
+     */
+    bankAccount;
+    /**
+     * Notification preferences stored as JSON
+     */
+    preferences;
+    /**
+     * Agent user account
+     * User can have only one active agent profile
+     */
+    user;
+    /**
+     * Agent promotions
+     */
+    promotions;
+    /**
+     * Promotion payouts
+     */
+    payouts;
+    /**
+     * Creates an instance of AgentEntity
+     * @param props - Partial properties to initialize the entity
+     */
+    constructor(props) {
+        super();
+        Object.assign(this, props);
+    }
+    /**
+     * Converts the entity to an Agent model instance
+     * @returns Agent model with basic information
+     */
+    async toModel() {
+        const user = await this.user;
+        return new common_1.Agent({
+            id: this.id,
+            name: this.name || user.name,
+            imageUrl: user.imageUrl,
+            language: this.language || user.language,
+            code: this.code,
+            percentage: this.percentage,
+            status: this.status,
+            bankAccount: common_2.BankAccount.toInstance(this.bankAccount)
+        });
+    }
+    /**
+     * Converts the entity to an Agent model instance
+     * @returns Agent model with basic information
+     */
+    async toSummary() {
+        const user = await this.user;
+        return new common_1.Agent({
+            id: this.id,
+            name: this.name || user.name,
+            imageUrl: user.imageUrl,
+            language: this.language || user.language,
+            status: this.status
+        });
+    }
+    /**
+     * Converts the entity to a Person model
+     * @returns Promise resolving to Person model with basic contact information
+     */
+    async toPerson() {
+        const user = await this.user;
+        return new common_1.Person({
+            id: this.id,
+            name: this.name,
+            imageUrl: user.imageUrl,
+            phone: user.phone,
+            email: user.email
+        });
+    }
+    /**
+     * Retrieves notification preferences as typed Preference instances
+     * @returns Array of Preference objects or undefined if not set
+     */
+    getPreferences() {
+        if (!this.preferences)
+            return;
+        return this.preferences.map(common_2.Preference.toInstance);
+    }
+    /**
+     * Retrieves activity history for this agent
+     * @returns Promise resolving to array of Activity instances tracking creation and updates
+     */
+    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.AgentEntity = AgentEntity;
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", Number)
+], AgentEntity.prototype, "userId", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'enum',
+        enum: common_1.AccountStatus,
+        default: common_1.AccountStatus.Pending,
+        nullable: false
+    }),
+    __metadata("design:type", String)
+], AgentEntity.prototype, "status", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", String)
+], AgentEntity.prototype, "name", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'enum',
+        enum: common_1.Language,
+        default: common_1.Language.En,
+        nullable: true
+    }),
+    __metadata("design:type", String)
+], AgentEntity.prototype, "language", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ unique: true }),
+    __metadata("design:type", String)
+], AgentEntity.prototype, "code", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ default: 50 }),
+    __metadata("design:type", Number)
+], AgentEntity.prototype, "percentage", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'simple-json',
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", common_2.BankAccount)
+], AgentEntity.prototype, "bankAccount", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'simple-json',
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", Array)
+], AgentEntity.prototype, "preferences", void 0);
+__decorate([
+    (0, typeorm_1.ManyToOne)(() => user_entity_1.UserEntity, user => user.agentProfiles),
+    __metadata("design:type", Promise)
+], AgentEntity.prototype, "user", void 0);
+__decorate([
+    (0, typeorm_1.OneToMany)(() => promotion_entity_1.AgentPromotionEntity, promotion => promotion.agent),
+    __metadata("design:type", Promise)
+], AgentEntity.prototype, "promotions", void 0);
+__decorate([
+    (0, typeorm_1.OneToMany)(() => payout_entity_1.AgentPayoutEntity, payout => payout.agent),
+    __metadata("design:type", Promise)
+], AgentEntity.prototype, "payouts", void 0);
+exports.AgentEntity = AgentEntity = __decorate([
+    (0, typeorm_1.Entity)('agents'),
+    __metadata("design:paramtypes", [Object])
+], AgentEntity);
+//# sourceMappingURL=agent.entity.js.map

package/lib/profile/agent/agent.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"agent.entity.js","sourceRoot":"","sources":["../../../src/profile/agent/agent.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qCAA+D;AAC/D,4CAAiG;AACjG,4CAA0D;AAC1D,wDAAoD;AACpD,mDAAoD;AACpD,yDAA0D;AAC1D,uCAA0D;AAE1D;;;;;;;GAOG;AAEI,IAAM,WAAW,GAAjB,MAAM,WAAY,SAAQ,uBAAsB;IAEtD;;OAEG;IAEH,MAAM,CAAS;IAEf;;;OAGG;IAOH,MAAM,CAAgB;IAEtB;;OAEG;IAKH,IAAI,CAAS;IAEb;;;OAGG;IAOH,QAAQ,CAAW;IAEnB;;;OAGG;IAEH,IAAI,CAAS;IAEb;;;OAGG;IAEH,UAAU,CAAS;IAEnB;;OAEG;IAMH,WAAW,CAAc;IAEzB;;OAEG;IAMH,WAAW,CAAe;IAE1B;;;OAGG;IAEH,IAAI,CAAqB;IAEzB;;OAEG;IAEH,UAAU,CAAkC;IAE5C;;OAEG;IAEH,OAAO,CAA+B;IAEtC;;;OAGG;IACH,YAAY,KAA4B;QACvC,KAAK,EAAE,CAAC;QACR,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,OAAO;QACZ,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC;QAC7B,OAAO,IAAI,cAAK,CAAC;YAChB,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI;YAC5B,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ;YACxC,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,WAAW,EAAE,oBAAW,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC;SACrD,CAAC,CAAA;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,SAAS;QACd,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC;QAC7B,OAAO,IAAI,cAAK,CAAC;YAChB,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI;YAC5B,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ;YACxC,MAAM,EAAE,IAAI,CAAC,MAAM;SACnB,CAAC,CAAA;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,QAAQ;QACb,MAAM,IAAI,GAAI,MAAM,IAAI,CAAC,IAAI,CAAC;QAC9B,OAAO,IAAI,eAAM,CAAC;YACjB,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,KAAK,EAAE,IAAI,CAAC,KAAK;SACjB,CAAC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,cAAc;QACb,IAAI,CAAC,IAAI,CAAC,WAAW;YAAE,OAAO;QAC9B,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,mBAAU,CAAC,UAAU,CAAC,CAAA;IACnD,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;AA5KY,kCAAW;AAMvB;IADC,IAAA,gBAAM,GAAE;;2CACM;AAYf;IANC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,sBAAa;QACnB,OAAO,EAAE,sBAAa,CAAC,OAAO;QAC9B,QAAQ,EAAE,KAAK;KACf,CAAC;;2CACoB;AAStB;IAJC,IAAA,gBAAM,EAAC;QACP,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;yCACW;AAYb;IANC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,iBAAQ;QACd,OAAO,EAAE,iBAAQ,CAAC,EAAE;QACpB,QAAQ,EAAE,IAAI;KACd,CAAC;;6CACiB;AAOnB;IADC,IAAA,gBAAM,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;;yCACZ;AAOb;IADC,IAAA,gBAAM,EAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;;+CACL;AAUnB;IALC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,aAAa;QACnB,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;8BACW,oBAAW;gDAAC;AAUzB;IALC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,aAAa;QACnB,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;gDACwB;AAO1B;IADC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,wBAAU,EAAE,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC;;yCAC/B;AAMzB;IADC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,uCAAoB,EAAE,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC;;+CACxB;AAM5C;IADC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,iCAAiB,EAAE,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC;;4CACrB;sBA5F1B,WAAW;IADvB,IAAA,gBAAM,EAAC,QAAQ,CAAC;;GACJ,WAAW,CA4KvB"}

package/lib/profile/agent/payout.entity.d.ts

@@ -0,0 +1,70 @@
+import { BankAccount, Payout } from '@driveup/common';
+import { Activity, StatusType } from '@driveup/common';
+import { AgentEntity } from './agent.entity';
+import { AgentPromotionEntity } from './promotion.entity';
+import { TrackableEntity } from '../../utils';
+/**
+ * Represents a payout to an agent for their earned commissions.
+ * Payouts aggregate multiple promotions and track the payment status,
+ * amount, and bank account information.
+ *
+ * @extends TrackableEntity<Payout>
+ */
+export declare class AgentPayoutEntity extends TrackableEntity<Payout> {
+    /**
+     * Reference to the agent receiving the payout
+     */
+    agentId: number;
+    /**
+     * Payment status (Pending, Paid, Failed)
+     * @default StatusType.Pending
+     */
+    status: StatusType;
+    /**
+     * Total payout amount in the agent's currency
+     * Precision: 8 digits, Scale: 2 decimal places
+     * @default 0
+     */
+    amount: number;
+    /**
+     * Bank account information where the payout was sent
+     */
+    bankAccount: BankAccount;
+    /**
+     * Timestamp when the payout was completed
+     */
+    paidOn: Date;
+    /**
+     * ID of the staff member who processed the payout
+     */
+    paidBy: number;
+    /**
+     * Agent receiving this payout
+     */
+    agent: Promise<AgentEntity>;
+    /**
+     * Promotions included in this payout
+     */
+    promotions: Promise<AgentPromotionEntity[]>;
+    /**
+     * Creates an instance of AgentPayoutEntity
+     * @param props - Partial properties to initialize the entity
+     */
+    constructor(props?: Partial<AgentPayoutEntity>);
+    /**
+     * Converts the entity to a Payout model instance
+     * @returns Payout model with status, amount, and bank account information
+     */
+    toModel(): Promise<Payout>;
+    /**
+     * Converts the entity to a Payout model instance
+     * @returns Payout model with status, amount, and bank account information
+     */
+    toSummary(): Promise<Payout>;
+    /**
+     * Retrieves all activity records for this payout
+     * Includes creation and payment actions
+     * @returns Array of Activity objects
+     */
+    getActivities(): Promise<Activity[]>;
+}

package/lib/profile/agent/payout.entity.js

@@ -0,0 +1,160 @@
+"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.AgentPayoutEntity = void 0;
+const typeorm_1 = require("typeorm");
+const common_1 = require("@driveup/common");
+const common_2 = require("@driveup/common");
+const staff_entity_1 = require("../../system/staff/staff.entity");
+const agent_entity_1 = require("./agent.entity");
+const promotion_entity_1 = require("./promotion.entity");
+const utils_1 = require("../../utils");
+/**
+ * Represents a payout to an agent for their earned commissions.
+ * Payouts aggregate multiple promotions and track the payment status,
+ * amount, and bank account information.
+ *
+ * @extends TrackableEntity<Payout>
+ */
+let AgentPayoutEntity = class AgentPayoutEntity extends utils_1.TrackableEntity {
+    /**
+     * Reference to the agent receiving the payout
+     */
+    agentId;
+    /**
+     * Payment status (Pending, Paid, Failed)
+     * @default StatusType.Pending
+     */
+    status;
+    /**
+     * Total payout amount in the agent's currency
+     * Precision: 8 digits, Scale: 2 decimal places
+     * @default 0
+     */
+    amount;
+    /**
+     * Bank account information where the payout was sent
+     */
+    bankAccount;
+    /**
+     * Timestamp when the payout was completed
+     */
+    paidOn;
+    /**
+     * ID of the staff member who processed the payout
+     */
+    paidBy;
+    /**
+     * Agent receiving this payout
+     */
+    agent;
+    /**
+     * Promotions included in this payout
+     */
+    promotions;
+    /**
+     * Creates an instance of AgentPayoutEntity
+     * @param props - Partial properties to initialize the entity
+     */
+    constructor(props) {
+        super();
+        Object.assign(this, props);
+    }
+    /**
+     * Converts the entity to a Payout model instance
+     * @returns Payout model with status, amount, and bank account information
+     */
+    async toModel() {
+        return new common_1.Payout({
+            id: this.id,
+            status: this.status,
+            amount: this.amount,
+            bankAccount: common_1.BankAccount.toInstance(this.bankAccount)
+        });
+    }
+    /**
+     * Converts the entity to a Payout model instance
+     * @returns Payout model with status, amount, and bank account information
+     */
+    async toSummary() {
+        return await this.toModel();
+    }
+    /**
+     * Retrieves all activity records for this payout
+     * Includes creation and payment actions
+     * @returns Array of Activity objects
+     */
+    async getActivities() {
+        const activities = [];
+        activities.push(await (0, utils_1.toActivity)(this.createdBy, common_2.ActivityType.createdBy, staff_entity_1.StaffEntity));
+        activities.push(await (0, utils_1.toActivity)(this.createdOn, common_2.ActivityType.createdOn));
+        activities.push(await (0, utils_1.toActivity)(this.paidBy, common_2.ActivityType.paidBy, staff_entity_1.StaffEntity));
+        activities.push(await (0, utils_1.toActivity)(this.paidOn, common_2.ActivityType.paidOn));
+        return activities.filter(a => a);
+    }
+};
+exports.AgentPayoutEntity = AgentPayoutEntity;
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", Number)
+], AgentPayoutEntity.prototype, "agentId", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'enum',
+        enum: [
+            common_2.StatusType.Pending,
+            common_2.StatusType.Paid,
+            common_2.StatusType.Failed
+        ],
+        default: common_2.StatusType.Pending,
+        nullable: false
+    }),
+    __metadata("design:type", String)
+], AgentPayoutEntity.prototype, "status", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'decimal',
+        precision: 8,
+        scale: 2,
+        default: 0,
+        nullable: false
+    }),
+    __metadata("design:type", Number)
+], AgentPayoutEntity.prototype, "amount", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'simple-json',
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", common_1.BankAccount)
+], AgentPayoutEntity.prototype, "bankAccount", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, default: null }),
+    __metadata("design:type", Date)
+], AgentPayoutEntity.prototype, "paidOn", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, default: null }),
+    __metadata("design:type", Number)
+], AgentPayoutEntity.prototype, "paidBy", void 0);
+__decorate([
+    (0, typeorm_1.ManyToOne)(() => agent_entity_1.AgentEntity, agent => agent.payouts),
+    __metadata("design:type", Promise)
+], AgentPayoutEntity.prototype, "agent", void 0);
+__decorate([
+    (0, typeorm_1.OneToMany)(() => promotion_entity_1.AgentPromotionEntity, promotion => promotion.payout),
+    __metadata("design:type", Promise)
+], AgentPayoutEntity.prototype, "promotions", void 0);
+exports.AgentPayoutEntity = AgentPayoutEntity = __decorate([
+    (0, typeorm_1.Entity)('agentPayouts'),
+    __metadata("design:paramtypes", [Object])
+], AgentPayoutEntity);
+//# sourceMappingURL=payout.entity.js.map

package/lib/profile/agent/payout.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payout.entity.js","sourceRoot":"","sources":["../../../src/profile/agent/payout.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qCAA+D;AAC/D,4CAAsD;AACtD,4CAAqE;AACrE,kEAA8D;AAC9D,iDAA6C;AAC7C,yDAA0D;AAC1D,uCAA0D;AAE1D;;;;;;GAMG;AAEI,IAAM,iBAAiB,GAAvB,MAAM,iBAAkB,SAAQ,uBAAuB;IAE7D;;OAEG;IAEH,OAAO,CAAS;IAEhB;;;OAGG;IAWH,MAAM,CAAa;IAEnB;;;;OAIG;IAQH,MAAM,CAAS;IAEf;;OAEG;IAMH,WAAW,CAAc;IAEzB;;OAEG;IAEH,MAAM,CAAO;IAEb;;OAEG;IAEH,MAAM,CAAS;IAEf;;OAEG;IAEH,KAAK,CAAuB;IAE5B;;OAEG;IAEH,UAAU,CAAkC;IAE5C;;;OAGG;IACH,YAAY,KAAkC;QAC7C,KAAK,EAAE,CAAC;QACR,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,OAAO;QACZ,OAAO,IAAI,eAAM,CAAC;YACjB,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,WAAW,EAAE,oBAAW,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC;SACrD,CAAC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,SAAS;QACd,OAAO,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;IAC7B,CAAC;IAED;;;;OAIG;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,EAAE,0BAAW,CAAC,CAAC,CAAC;QACvF,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,MAAM,EAAE,qBAAY,CAAC,MAAM,EAAE,0BAAW,CAAC,CAAC,CAAC;QACjF,UAAU,CAAC,IAAI,CAAC,MAAM,IAAA,kBAAU,EAAC,IAAI,CAAC,MAAM,EAAE,qBAAY,CAAC,MAAM,CAAC,CAAC,CAAC;QACpE,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAClC,CAAC;CACD,CAAA;AAnHY,8CAAiB;AAM7B;IADC,IAAA,gBAAM,GAAE;;kDACO;AAgBhB;IAVC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE;YACL,mBAAU,CAAC,OAAO;YAClB,mBAAU,CAAC,IAAI;YACf,mBAAU,CAAC,MAAM;SACjB;QACD,OAAO,EAAE,mBAAU,CAAC,OAAO;QAC3B,QAAQ,EAAE,KAAK;KACf,CAAC;;iDACiB;AAcnB;IAPC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,SAAS;QACf,SAAS,EAAE,CAAC;QACZ,KAAK,EAAE,CAAC;QACR,OAAO,EAAE,CAAC;QACV,QAAQ,EAAE,KAAK;KACf,CAAC;;iDACa;AAUf;IALC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,aAAa;QACnB,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;8BACW,oBAAW;sDAAC;AAMzB;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;8BAClC,IAAI;iDAAC;AAMb;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;;iDAC3B;AAMf;IADC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,0BAAW,EAAE,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC;;gDACzB;AAM5B;IADC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,uCAAoB,EAAE,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC;;qDACzB;4BAtEhC,iBAAiB;IAD7B,IAAA,gBAAM,EAAC,cAAc,CAAC;;GACV,iBAAiB,CAmH7B"}

package/lib/profile/agent/promotion.entity.d.ts

@@ -0,0 +1,82 @@
+import { Activity, PayoutItem } from '@driveup/common';
+import { AgentEntity } from './agent.entity';
+import { AgentPayoutEntity } from './payout.entity';
+import { CompanyEntity } from '../company/company.entity';
+import { CompanyBillTransactionEntity } from '../company/finances/billing/transaction.entity';
+import { TrackableEntity } from '../../utils';
+/**
+ * Represents a promotion generated by an agent.
+ * Tracks the relationship between an agent, a referred company, and the
+ * resulting profit. Promotions can be included in payouts for commission distribution.
+ *
+ * @extends TrackableEntity<PayoutItem>
+ */
+export declare class AgentPromotionEntity extends TrackableEntity<PayoutItem> {
+    /**
+     * Reference to the agent who generated this promotion
+     */
+    agentId: number;
+    /**
+     * Reference to the company that used the agent's promotion code
+     */
+    companyId: number;
+    /**
+     * Reference to the bill transaction associated with this promotion
+     */
+    transactionId: number;
+    /**
+     * Reference to the payout this promotion is included in
+     * Null if not yet paid out
+     */
+    payoutId: number;
+    /**
+     * The profit generated from this promotion
+     */
+    profit: number;
+    /**
+     * Start date of the promotion period
+     */
+    startDate: Date;
+    /**
+     * End date of the promotion period
+     */
+    endDate: Date;
+    /**
+     * Agent profile
+     */
+    agent: Promise<AgentEntity>;
+    /**
+     * Binded promotion for company (by promotion code in onboarding process)
+     */
+    company: Promise<CompanyEntity>;
+    /**
+     * Payout containing this promotion
+     * Payouts are generated periodically and contain set of selected promotions
+     */
+    payout: Promise<AgentPayoutEntity>;
+    /**
+     * Reference to company bill transaction created for this promotion profit
+     */
+    transaction: Promise<CompanyBillTransactionEntity>;
+    /**
+     * Creates an instance of AgentPromotionEntity
+     * @param props - Partial properties to initialize the entity
+     */
+    constructor(props?: Partial<AgentPromotionEntity>);
+    /**
+     * Converts the entity to a PayoutItem model instance
+     * @returns PayoutItem model with profit, period, and customer information
+     */
+    toModel(): Promise<PayoutItem>;
+    /**
+     * Converts the entity to a PayoutItem model instance
+     * @returns PayoutItem model with profit, period, and customer information
+     */
+    toSummary(): Promise<PayoutItem>;
+    /**
+     * Retrieves all activity records for this promotion
+     * Includes creation and update actions
+     * @returns Array of Activity objects
+     */
+    getActivities(): Promise<Activity[]>;
+}