@driveup/schema 0.1.0

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

@@ -0,0 +1,174 @@
+"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.AgentPromotionEntity = void 0;
+const typeorm_1 = require("typeorm");
+const common_1 = require("@driveup/common");
+const agent_entity_1 = require("./agent.entity");
+const payout_entity_1 = require("./payout.entity");
+const company_entity_1 = require("../company/company.entity");
+const transaction_entity_1 = require("../company/finances/billing/transaction.entity");
+const utils_1 = require("../../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>
+ */
+let AgentPromotionEntity = class AgentPromotionEntity extends utils_1.TrackableEntity {
+    /**
+     * Reference to the agent who generated this promotion
+     */
+    agentId;
+    /**
+     * Reference to the company that used the agent's promotion code
+     */
+    companyId;
+    /**
+     * Reference to the bill transaction associated with this promotion
+     */
+    transactionId;
+    /**
+     * Reference to the payout this promotion is included in
+     * Null if not yet paid out
+     */
+    payoutId;
+    /**
+     * The profit generated from this promotion
+     */
+    profit;
+    /**
+     * Start date of the promotion period
+     */
+    startDate;
+    /**
+     * End date of the promotion period
+     */
+    endDate;
+    /**
+     * Agent profile
+     */
+    agent;
+    /**
+     * Binded promotion for company (by promotion code in onboarding process)
+     */
+    company;
+    /**
+     * Payout containing this promotion
+     * Payouts are generated periodically and contain set of selected promotions
+     */
+    payout;
+    /**
+     * Reference to company bill transaction created for this promotion profit
+     */
+    transaction;
+    /**
+     * Creates an instance of AgentPromotionEntity
+     * @param props - Partial properties to initialize the entity
+     */
+    constructor(props) {
+        super();
+        Object.assign(this, props);
+    }
+    /**
+     * Converts the entity to a PayoutItem model instance
+     * @returns PayoutItem model with profit, period, and customer information
+     */
+    async toModel() {
+        return new common_1.PayoutItem({
+            id: this.id,
+            profit: this.profit,
+            period: new common_1.Period({
+                startDate: this.startDate,
+                endDate: this.endDate
+            }),
+            customer: (await this.company)?.toCustomer()
+        });
+    }
+    /**
+     * Converts the entity to a PayoutItem model instance
+     * @returns PayoutItem model with profit, period, and customer information
+     */
+    async toSummary() {
+        return await this.toModel();
+    }
+    /**
+     * Retrieves all activity records for this promotion
+     * Includes creation and update actions
+     * @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.AgentPromotionEntity = AgentPromotionEntity;
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", Number)
+], AgentPromotionEntity.prototype, "agentId", void 0);
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", Number)
+], AgentPromotionEntity.prototype, "companyId", void 0);
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", Number)
+], AgentPromotionEntity.prototype, "transactionId", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", Number)
+], AgentPromotionEntity.prototype, "payoutId", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: false,
+        default: 0
+    }),
+    __metadata("design:type", Number)
+], AgentPromotionEntity.prototype, "profit", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, default: null }),
+    __metadata("design:type", Date)
+], AgentPromotionEntity.prototype, "startDate", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, default: null }),
+    __metadata("design:type", Date)
+], AgentPromotionEntity.prototype, "endDate", void 0);
+__decorate([
+    (0, typeorm_1.ManyToOne)(() => agent_entity_1.AgentEntity, agent => agent.promotions),
+    __metadata("design:type", Promise)
+], AgentPromotionEntity.prototype, "agent", void 0);
+__decorate([
+    (0, typeorm_1.ManyToOne)(() => company_entity_1.CompanyEntity, company => company.agentPromotions),
+    __metadata("design:type", Promise)
+], AgentPromotionEntity.prototype, "company", void 0);
+__decorate([
+    (0, typeorm_1.ManyToOne)(() => payout_entity_1.AgentPayoutEntity, payout => payout.promotions),
+    __metadata("design:type", Promise)
+], AgentPromotionEntity.prototype, "payout", void 0);
+__decorate([
+    (0, typeorm_1.OneToOne)(() => transaction_entity_1.CompanyBillTransactionEntity, transaction => transaction.agentPromotion),
+    (0, typeorm_1.JoinColumn)(),
+    __metadata("design:type", Promise)
+], AgentPromotionEntity.prototype, "transaction", void 0);
+exports.AgentPromotionEntity = AgentPromotionEntity = __decorate([
+    (0, typeorm_1.Entity)('agentPromotions'),
+    __metadata("design:paramtypes", [Object])
+], AgentPromotionEntity);
+//# sourceMappingURL=promotion.entity.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"promotion.entity.js","sourceRoot":"","sources":["../../../src/profile/agent/promotion.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qCAA0E;AAC1E,4CAA6E;AAC7E,iDAA6C;AAC7C,mDAAoD;AACpD,8DAA0D;AAC1D,uFAA8F;AAC9F,uCAA0D;AAE1D;;;;;;GAMG;AAEI,IAAM,oBAAoB,GAA1B,MAAM,oBAAqB,SAAQ,uBAA2B;IAEpE;;OAEG;IAEH,OAAO,CAAS;IAEhB;;OAEG;IAEH,SAAS,CAAS;IAElB;;OAEG;IAEH,aAAa,CAAS;IAEtB;;;OAGG;IAKH,QAAQ,CAAS;IAEjB;;OAEG;IAKH,MAAM,CAAS;IAEf;;OAEG;IAEH,SAAS,CAAO;IAEhB;;OAEG;IAEH,OAAO,CAAO;IAEd;;OAEG;IAEH,KAAK,CAAuB;IAE5B;;OAEG;IAEH,OAAO,CAAyB;IAEhC;;;OAGG;IAEH,MAAM,CAA6B;IAEnC;;OAEG;IAGH,WAAW,CAAwC;IAEnD;;;OAGG;IACH,YAAY,KAAqC;QAChD,KAAK,EAAE,CAAC;QACR,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,OAAO;QACZ,OAAO,IAAI,mBAAU,CAAC;YACrB,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,MAAM,EAAE,IAAI,eAAM,CAAC;gBAClB,SAAS,EAAE,IAAI,CAAC,SAAS;gBACzB,OAAO,EAAE,IAAI,CAAC,OAAO;aACrB,CAAC;YACF,QAAQ,EAAE,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,EAAE,UAAU,EAAE;SAC5C,CAAC,CAAA;IACH,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,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;AA3HY,oDAAoB;AAMhC;IADC,IAAA,gBAAM,GAAE;;qDACO;AAMhB;IADC,IAAA,gBAAM,GAAE;;uDACS;AAMlB;IADC,IAAA,gBAAM,GAAE;;2DACa;AAUtB;IAJC,IAAA,gBAAM,EAAC;QACP,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;sDACe;AASjB;IAJC,IAAA,gBAAM,EAAC;QACP,QAAQ,EAAE,KAAK;QACf,OAAO,EAAE,CAAC;KACV,CAAC;;oDACa;AAMf;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAG,CAAC;8BAChC,IAAI;uDAAC;AAMhB;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;8BACjC,IAAI;qDAAC;AAMd;IADC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,0BAAW,EAAE,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC;;mDAC5B;AAM5B;IADC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,8BAAa,EAAE,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,eAAe,CAAC;;qDACnC;AAOhC;IADC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,iCAAiB,EAAE,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC;;oDAC7B;AAOnC;IAFC,IAAA,kBAAQ,EAAC,GAAG,EAAE,CAAC,iDAA4B,EAAE,WAAW,CAAC,EAAE,CAAC,WAAW,CAAC,cAAc,CAAC;IACvF,IAAA,oBAAU,GAAE;;yDACsC;+BA3EvC,oBAAoB;IADhC,IAAA,gBAAM,EAAC,iBAAiB,CAAC;;GACb,oBAAoB,CA2HhC"}

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

@@ -0,0 +1,234 @@
+import { Company, AccountStatus, Language, Activity } from '@driveup/common';
+import { WorkingHours, Holiday, Address, Preference } from '@driveup/common';
+import { BankAccount, Tax, Link, Customer } from '@driveup/common';
+import { CountryEntity } from '../../system/country/country.entity';
+import { CompanyExpenseEntity } from './finances/expense/expense.entity';
+import { CompanyExpenseCategoryEntity } from './finances/expense/category.entity';
+import { CompanyHandoverEntity } from './finances/handover/handover.entity';
+import { CompanyInvoiceEntity } from './finances/invoice/invoice.entity';
+import { CompanyPaymentMethodEntity } from './finances/payment/method.entity';
+import { CompanyBillEntity } from './finances/billing/bill.entity';
+import { CompanyProductEntity } from './product/product.entity';
+import { CompanyInstructorEntity } from './instructor/instructor.entity';
+import { AgentPromotionEntity } from '../agent/promotion.entity';
+import { TrackableEntity } from '../../utils';
+/**
+ * Represents a driving school company in the system.
+ * Companies offer training products, manage instructors and students,
+ * handle billing, and maintain their own settings and preferences.
+ * Each company operates within a specific country and can have multiple locations.
+ *
+ * @extends TrackableEntity<Company>
+ */
+export declare class CompanyEntity extends TrackableEntity<Company> {
+    /**
+     * Reference to the country this company operates in
+     */
+    countryId: number;
+    /**
+     * Unique identifier (UUID) for external references
+     * Auto-generated on creation
+     */
+    uid: string;
+    /**
+     * Account status of the company
+     * @default AccountStatus.Invited
+     */
+    status: AccountStatus;
+    /**
+     * Company name
+     */
+    name: string;
+    /**
+     * Company description for marketing purposes
+     */
+    description: string;
+    /**
+     * Primary language for company operations
+     * @default Language.De
+     */
+    language: Language;
+    /**
+     * Timezone for scheduling and appointments
+     * @default 'Europe/Zurich'
+     */
+    timezone: string;
+    /**
+     * URL to the company's logo image
+     */
+    logoUrl: string;
+    /**
+     * Promtion code from agent
+     */
+    promotionCode: string;
+    /**
+     * Company's physical address
+     */
+    address: Address;
+    /**
+     * Bank account information for payouts and payments
+     */
+    bankAccount: BankAccount;
+    /**
+     * Tax identification number
+     */
+    taxID: string;
+    /**
+     * Company operational locations
+     * Can have multiple training locations
+     */
+    locations: Address[];
+    /**
+     * Contact phone number
+     */
+    phone: string;
+    /**
+     * Contact email address
+     */
+    email: string;
+    /**
+     * Company website URL
+     */
+    homepage: string;
+    /**
+     * Social media and other related links
+     */
+    links: Link[];
+    /**
+     * Calculated field to optimize rating calculation
+     */
+    rating: number;
+    /**
+     * Company credit
+     * Global company wallet balance (can't be negative)
+     * Allow company to bay credit from PSP provider and use it for payments
+     * Can be used by payments if company product credit is not enough
+     */
+    credit: number;
+    /**
+     * Tax configuration for invoicing
+     */
+    tax: Tax;
+    /**
+     * Weekly working hours schedule
+     */
+    workingHours: WorkingHours[];
+    /**
+     * Company holidays and closure dates
+     */
+    holidays: Holiday[];
+    /**
+     * Company preferences and settings
+     */
+    preferences: Preference[];
+    /**
+     * ID of the staff member who closed this company
+     */
+    closedBy: number;
+    /**
+     * Timestamp when the company was closed
+     */
+    closedOn: Date;
+    /**
+     * Country relation
+     */
+    country: Promise<CountryEntity>;
+    /**
+     * Company products relation
+     */
+    products: Promise<CompanyProductEntity[]>;
+    /**
+     * Company bills relation
+     */
+    bills: Promise<CompanyBillEntity[]>;
+    /**
+     * Company payment methods relation
+     */
+    paymentMethods: Promise<CompanyPaymentMethodEntity[]>;
+    /**
+     * Company instructors relation
+     */
+    instructors: Promise<CompanyInstructorEntity[]>;
+    /**
+     * Company expenses relation
+     */
+    expenses: Promise<CompanyExpenseEntity[]>;
+    /**
+     * Company expense categories relation
+     */
+    expenseCategories: Promise<CompanyExpenseCategoryEntity[]>;
+    /**
+     * Handovers related to this company
+     */
+    handovers: Promise<CompanyHandoverEntity[]>;
+    /**
+     * Invoices related to this company
+     */
+    invoices: Promise<CompanyInvoiceEntity[]>;
+    /**
+     * Agent promotions related to this company
+     */
+    agentPromotions: Promise<AgentPromotionEntity[]>;
+    /**
+     * Creates a new CompanyEntity instance
+     * @param props - Partial properties to initialize the entity
+     */
+    constructor(props?: Partial<CompanyEntity>);
+    /**
+     * Converts the entity to a Company model instance with core information
+     * @returns Company model with essential company data
+     */
+    toModel(): Company;
+    /**
+     * Converts the entity to a Company summary model with minimal information
+     * @returns Company model with basic information for listings
+     */
+    toSummary(): Company;
+    /**
+     * Converts the entity to a Company model with all detailed information
+     * @returns Company model with complete information including address, bank account, tax, etc.
+     */
+    toModelWithDetails(): Company;
+    /**
+     * Converts the entity to a Customer model for invoicing purposes
+     * @returns Customer model with company information
+     */
+    toCustomer(): Customer;
+    /**
+     * Retrieves the owner of this company
+     * @returns Promise resolving to the CompanyInstructorEntity with Owner role
+     */
+    getOwner(): Promise<CompanyInstructorEntity>;
+    /**
+     * Retrieves all instructors associated with this company
+     * @param active - Optional flag to filter only active instructors
+     * @returns Promise resolving to array of CompanyInstructorEntity
+     */
+    getInstructors(active?: boolean): Promise<CompanyInstructorEntity[]>;
+    /**
+     * Retrieves all managers (owners and managers) associated with this company
+     * @param active - Optional flag to filter only active managers
+     * @returns Promise resolving to array of CompanyInstructorEntity with manager roles
+     */
+    getManagers(active?: boolean): Promise<CompanyInstructorEntity[]>;
+    /**
+     * Retrieves the active payment method for this company
+     * @returns Promise resolving to the active CompanyPaymentMethodEntity or null
+     */
+    getPaymentMethod(): Promise<CompanyPaymentMethodEntity>;
+    /**
+     * Calculates the total agent earnings from paid bills for this company
+     * @returns Promise resolving to the total agent profit amount
+     */
+    getAgentEarning(): Promise<number>;
+    /**
+     * Formats the company's full address as a single string
+     * @returns Formatted address string with location, address, and zip code
+     */
+    getFullAddress(): string;
+    /**
+     * Retrieves activity history for this company
+     * @returns Promise resolving to array of Activity instances tracking creation, updates, and closure
+     */
+    getActivities(): Promise<Activity[]>;
+}