@driveup/schema 0.1.0

package/README.md

@@ -0,0 +1,174 @@
+# @driveup/schema
+
+TypeORM entity schemas for the Driveup platform ecosystem.
+
+## Overview
+
+`@driveup/schema` provides TypeORM entity definitions and database schemas used across the Driveup platform. This package centralizes all database entity definitions to ensure consistency across microservices and applications.
+
+## Features
+
+- 📦 **TypeORM Entities** - Complete database entity definitions with decorators
+- 🔄 **Model Transformations** - Convert between entities and domain models
+- 📊 **Relationship Mappings** - Pre-configured entity relationships
+- 🛡️ **Type Safety** - Full TypeScript support with type definitions
+- 🏗️ **Trackable Entities** - Base entities with audit fields (created/updated by/on)
+
+## Installation
+
+```bash
+npm install @driveup/schema
+```
+
+### Peer Dependencies
+
+This package requires the following peer dependencies:
+
+```bash
+npm install typeorm reflect-metadata @driveup/common nestjs-i18n
+```
+
+## Usage
+
+### Basic Entity Import
+
+```typescript
+import { CompanyEntity, UserEntity } from '@driveup/schema';
+
+// Use in your repository
+const company = await CompanyEntity.findOne({ where: { id: 1 } });
+```
+
+### Converting Entities to Models
+
+```typescript
+import { CompanyBillEntity } from '@driveup/schema';
+
+const billEntity = await CompanyBillEntity.findOne({ 
+  where: { id: 1 } 
+});
+
+// Convert to domain model
+const billModel = billEntity.toModel();
+```
+
+### Working with Relationships
+
+```typescript
+import { CompanyBillEntity } from '@driveup/schema';
+
+const bill = await CompanyBillEntity.findOne({ where: { id: 1 } });
+
+// Access lazy-loaded relationships
+const company = await bill.company;
+const items = await bill.items;
+const transactions = await bill.transactions;
+```
+
+## Package Structure
+
+```
+src/
+├── catalog/          # Catalog entities (products, programs, addons)
+├── profile/          # Profile entities (agents, companies, students)
+│   ├── agent/
+│   ├── company/
+│   │   └── finances/ # Billing, transactions, credits
+│   └── student/
+├── system/           # System entities (settings, configurations)
+├── user/             # User entities and authentication
+└── utils/            # Utility base classes (TrackableEntity, etc.)
+```
+
+## Entity Categories
+
+### Catalog
+- **Addon** - Additional services and features
+- **Product** - Core product offerings
+- **Program** - Training programs
+- **PricePlan** - Pricing configurations
+- **Driving/Seed** - Driving-related catalogs
+
+### Profile
+- **Agent** - Agent profile and commission data
+- **Company** - Company profiles and settings
+- **Student** - Student profiles and progress
+- **Finances** - Bills, transactions, credits
+
+### System
+- System configurations and settings
+
+### User
+- User authentication and authorization data
+
+## Development
+
+### Build
+
+```bash
+npm run build
+```
+
+This compiles TypeScript files to the `lib/` directory.
+
+### Release
+
+```bash
+npm run release
+```
+
+This builds the package and publishes it to the npm registry.
+
+## Environment Requirements
+
+- **Node.js**: >= 22
+- **TypeScript**: Configured for ES2022
+- **TypeORM**: ^0.3.21
+
+## Integration
+
+This package is designed to work with:
+- **NestJS** applications
+- **TypeORM** as the ORM layer
+- **@driveup/common** for shared types and utilities
+
+### TypeORM Configuration Example
+
+```typescript
+import { DataSource } from 'typeorm';
+import * as Entities from '@driveup/schema';
+
+const dataSource = new DataSource({
+  type: 'postgres',
+  host: 'localhost',
+  port: 5432,
+  username: 'user',
+  password: 'password',
+  database: 'driveup',
+  entities: Object.values(Entities),
+  synchronize: false,
+  migrations: ['./migrations/*.ts']
+});
+```
+
+## Versioning
+
+This package follows [Semantic Versioning](https://semver.org/). Any changes must be accompanied by an appropriate version bump:
+
+- **MAJOR** - Breaking changes to entity structure
+- **MINOR** - New entities or non-breaking additions
+- **PATCH** - Bug fixes and documentation updates
+
+Version strategy is defined and managed by the CTO.
+
+## Support & Contact
+
+- **Author**: [Admir Serifi](https://twitter.com/admirsherifi)
+- **Owner**: [Intelact Solutions Ltd](https://intelact.co)
+- **Repository**: [GitHub](https://github.com/Intelact-Solutions/driveup-schema)
+
+## License
+
+**Private & Proprietary**
+
+This is private property of Intelact Solutions Ltd and is licensed only for use within Intelact Solutions products. Unauthorized use, distribution, or reproduction is strictly prohibited.

package/lib/catalog/addon/addon.entity.d.ts

@@ -0,0 +1,109 @@
+import { Activity, Addon, AddonType } from '@driveup/common';
+import { ColorContext, Content, Language, ProductType } from '@driveup/common';
+import { ProductEntity } from '../product/product.entity';
+import { AddonCountryEntity } from './country.entity';
+import { TrackableEntity } from '../../utils';
+/**
+ * Represents a system-wide addon in the catalog.
+ * Addons are optional features or services that can be added to products.
+ * Examples include appointment reminders, additional study materials, or premium support.
+ *
+ * @extends TrackableEntity<Addon>
+ */
+export declare class AddonEntity extends TrackableEntity<Addon> {
+    /**
+     * The type of addon (e.g., StudentAppointmentReminder, PremiumSupport)
+     * @default AddonType.StudentAppointmentReminder
+     */
+    type: AddonType;
+    /**
+     * Offer the addon for these products
+     * but the addons should offered separately as well
+     */
+    products: ProductType[];
+    /**
+     * UI color theme context for displaying the addon
+     * @default ColorContext.Primary
+     */
+    color: ColorContext;
+    /**
+     * Country localizations
+     */
+    translations: Content[];
+    /**
+     * Addon image
+     * Can be rewitten to support multiple images with language codes
+     */
+    imageUrl: string;
+    /**
+     * Addon active status
+     * Activating/deactivating an addon will not affect existing customers
+     * but will prevent new customers from purchasing the addon.
+     * Deactivating must set all country and company addons to enabled=false
+     */
+    active: boolean;
+    /**
+     * Sort by relevance
+     */
+    sort: number;
+    /**
+     * ID of the administrator who enabled this addon for the country
+     */
+    enabledBy: number;
+    /**
+     * Timestamp when the addon was enabled for the country
+     */
+    enabledOn: Date;
+    /**
+     * ID of the administrator who disabled this addon for the country
+     */
+    disabledBy: number;
+    /**
+     * Timestamp when the addon was disabled for the country
+     */
+    disabledOn: Date;
+    /**
+     * Country-specific configurations for this addon
+     * Each country can have different pricing and settings
+     */
+    countries: Promise<AddonCountryEntity[]>;
+    /**
+     * Creates an instance of AddonEntity
+     * @param props - Partial properties to initialize the entity
+     */
+    constructor(props?: Partial<AddonEntity>);
+    /**
+     * Converts the entity to a model object with localized content
+     * @param lang - Language code for localization (defaults to current context language)
+     * @returns Addon model instance with translated content
+     */
+    toModel(lang?: Language): Addon;
+    /**
+     * Converts the entity to a model object with localized content
+     * @param lang - Language code for localization (defaults to current context language)
+     * @returns Addon model instance with translated content
+     */
+    toSummary(lang?: Language): Addon;
+    /**
+     * Retrieves the translation for a specific language
+     * @param lang - Language code (defaults to current context language)
+     * @returns Content object with localized strings
+     */
+    getTranslation(lang?: Language): Content;
+    /**
+     * Retrieves all available translations for this addon
+     * @returns Array of Content objects for all languages
+     */
+    getTranslations(): Content[];
+    /**
+     * Retrieves all products associated with this addon
+     * @returns Array of ProductEntity instances
+     */
+    getProducts(): Promise<ProductEntity[]>;
+    /**
+     * Retrieves all activity records for this addon
+     * Includes creation, updates, enable/disable actions
+     * @returns Array of Activity objects
+     */
+    getActivities(): Promise<Activity[]>;
+}

package/lib/catalog/addon/addon.entity.js

@@ -0,0 +1,260 @@
+"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.AddonEntity = void 0;
+const nestjs_i18n_1 = require("nestjs-i18n");
+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 product_entity_1 = require("../product/product.entity");
+const country_entity_1 = require("./country.entity");
+const utils_1 = require("../../utils");
+/**
+ * Represents a system-wide addon in the catalog.
+ * Addons are optional features or services that can be added to products.
+ * Examples include appointment reminders, additional study materials, or premium support.
+ *
+ * @extends TrackableEntity<Addon>
+ */
+let AddonEntity = class AddonEntity extends utils_1.TrackableEntity {
+    /**
+     * The type of addon (e.g., StudentAppointmentReminder, PremiumSupport)
+     * @default AddonType.StudentAppointmentReminder
+     */
+    type;
+    /**
+     * Offer the addon for these products
+     * but the addons should offered separately as well
+     */
+    products;
+    /**
+     * UI color theme context for displaying the addon
+     * @default ColorContext.Primary
+     */
+    color;
+    /**
+     * Country localizations
+     */
+    translations;
+    /**
+     * Addon image
+     * Can be rewitten to support multiple images with language codes
+     */
+    imageUrl;
+    /**
+     * Addon active status
+     * Activating/deactivating an addon will not affect existing customers
+     * but will prevent new customers from purchasing the addon.
+     * Deactivating must set all country and company addons to enabled=false
+     */
+    active;
+    /**
+     * Sort by relevance
+     */
+    sort;
+    /**
+     * ID of the administrator who enabled this addon for the country
+     */
+    enabledBy;
+    /**
+     * Timestamp when the addon was enabled for the country
+     */
+    enabledOn;
+    /**
+     * ID of the administrator who disabled this addon for the country
+     */
+    disabledBy;
+    /**
+     * Timestamp when the addon was disabled for the country
+     */
+    disabledOn;
+    /**
+     * Country-specific configurations for this addon
+     * Each country can have different pricing and settings
+     */
+    countries;
+    /**
+     * Creates an instance of AddonEntity
+     * @param props - Partial properties to initialize the entity
+     */
+    constructor(props) {
+        super();
+        Object.assign(this, props);
+    }
+    /**
+     * Converts the entity to a model object with localized content
+     * @param lang - Language code for localization (defaults to current context language)
+     * @returns Addon model instance with translated content
+     */
+    toModel(lang) {
+        const translation = this.getTranslation(lang);
+        return new common_1.Addon({
+            id: this.id,
+            type: this.type,
+            color: this.color,
+            title: translation.title,
+            description: translation.description,
+            imageUrl: translation?.imageUrl || this.imageUrl,
+            active: this.active,
+            sort: this.sort,
+        });
+    }
+    /**
+     * Converts the entity to a model object with localized content
+     * @param lang - Language code for localization (defaults to current context language)
+     * @returns Addon model instance with translated content
+     */
+    toSummary(lang) {
+        return this.toModel(lang);
+    }
+    /**
+     * Retrieves the translation for a specific language
+     * @param lang - Language code (defaults to current context language)
+     * @returns Content object with localized strings
+     */
+    getTranslation(lang) {
+        const language = lang || nestjs_i18n_1.I18nContext.current()?.lang;
+        const translation = this.translations?.find(t => t.language === language);
+        return new common_2.Content({
+            title: translation?.title,
+            description: translation?.description,
+            content: translation?.content,
+            imageUrl: translation?.imageUrl || this.imageUrl,
+            link: translation?.link,
+        });
+    }
+    /**
+     * Retrieves all available translations for this addon
+     * @returns Array of Content objects for all languages
+     */
+    getTranslations() {
+        return this.translations?.map(t => new common_2.Content({
+            title: t.title,
+            description: t.description,
+            content: t.content,
+            imageUrl: t.imageUrl,
+            link: t.link,
+            language: t.language
+        }));
+    }
+    /**
+     * Retrieves all products associated with this addon
+     * @returns Array of ProductEntity instances
+     */
+    async getProducts() {
+        if (!this.products)
+            return [];
+        return await Promise.all(this.products?.map(async (type) => {
+            return await product_entity_1.ProductEntity.findOneBy({ type });
+        }));
+    }
+    /**
+     * Retrieves all activity records for this addon
+     * Includes creation, updates, enable/disable actions
+     * @returns Array of Activity objects
+     */
+    async getActivities() {
+        const activities = [];
+        activities.push(await (0, utils_1.toActivity)(this.createdBy, common_1.ActivityType.createdBy, staff_entity_1.StaffEntity));
+        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, staff_entity_1.StaffEntity));
+        activities.push(await (0, utils_1.toActivity)(this.updatedOn, common_1.ActivityType.updatedOn));
+        activities.push(await (0, utils_1.toActivity)(this.enabledBy, common_1.ActivityType.enabledBy, staff_entity_1.StaffEntity));
+        activities.push(await (0, utils_1.toActivity)(this.enabledOn, common_1.ActivityType.enabledOn));
+        activities.push(await (0, utils_1.toActivity)(this.disabledBy, common_1.ActivityType.disabledBy, staff_entity_1.StaffEntity));
+        activities.push(await (0, utils_1.toActivity)(this.disabledOn, common_1.ActivityType.disabledOn));
+        return activities.filter(a => a);
+    }
+};
+exports.AddonEntity = AddonEntity;
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'enum',
+        name: 'addonType',
+        enum: common_1.AddonType,
+        default: common_1.AddonType.StudentAppointmentReminder,
+        nullable: false
+    }),
+    __metadata("design:type", String)
+], AddonEntity.prototype, "type", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'set',
+        enum: common_2.ProductType,
+        default: [common_2.ProductType.DrivingCar],
+        nullable: false
+    }),
+    __metadata("design:type", Array)
+], AddonEntity.prototype, "products", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'enum',
+        enum: common_2.ColorContext,
+        default: common_2.ColorContext.Primary,
+        nullable: false
+    }),
+    __metadata("design:type", String)
+], AddonEntity.prototype, "color", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'simple-json',
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", Array)
+], AddonEntity.prototype, "translations", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", String)
+], AddonEntity.prototype, "imageUrl", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: false,
+        default: true
+    }),
+    __metadata("design:type", Boolean)
+], AddonEntity.prototype, "active", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: false,
+        default: 1
+    }),
+    __metadata("design:type", Number)
+], AddonEntity.prototype, "sort", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, default: null }),
+    __metadata("design:type", Number)
+], AddonEntity.prototype, "enabledBy", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, default: null }),
+    __metadata("design:type", Date)
+], AddonEntity.prototype, "enabledOn", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, default: null }),
+    __metadata("design:type", Number)
+], AddonEntity.prototype, "disabledBy", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, default: null }),
+    __metadata("design:type", Date)
+], AddonEntity.prototype, "disabledOn", void 0);
+__decorate([
+    (0, typeorm_1.OneToMany)(() => country_entity_1.AddonCountryEntity, country => country.addon),
+    __metadata("design:type", Promise)
+], AddonEntity.prototype, "countries", void 0);
+exports.AddonEntity = AddonEntity = __decorate([
+    (0, typeorm_1.Entity)('systemAddons'),
+    __metadata("design:paramtypes", [Object])
+], AddonEntity);
+//# sourceMappingURL=addon.entity.js.map

package/lib/catalog/addon/addon.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"addon.entity.js","sourceRoot":"","sources":["../../../src/catalog/addon/addon.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,6CAA0C;AAC1C,qCAAoD;AACpD,4CAA2E;AAC3E,4CAA+E;AAC/E,kEAA8D;AAC9D,8DAA0D;AAC1D,qDAAsD;AACtD,uCAA0D;AAE1D;;;;;;GAMG;AAEI,IAAM,WAAW,GAAjB,MAAM,WAAY,SAAQ,uBAAsB;IAEtD;;;OAGG;IAQH,IAAI,CAAY;IAEhB;;;OAGG;IAOH,QAAQ,CAAgB;IAExB;;;OAGG;IAOH,KAAK,CAAe;IAEpB;;OAEG;IAMH,YAAY,CAAY;IAExB;;;OAGG;IAKH,QAAQ,CAAS;IAEjB;;;;;OAKG;IAKH,MAAM,CAAU;IAEhB;;OAEG;IAKH,IAAI,CAAS;IAEb;;OAEG;IAEH,SAAS,CAAS;IAElB;;OAEG;IAEH,SAAS,CAAO;IAEhB;;OAEG;IAEH,UAAU,CAAS;IAEnB;;OAEG;IAEH,UAAU,CAAO;IAEjB;;;OAGG;IAEH,SAAS,CAAgC;IAEzC;;;OAGG;IACH,YAAY,KAA4B;QACvC,KAAK,EAAE,CAAC;QACR,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,IAAe;QACtB,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAA;QAC7C,OAAO,IAAI,cAAK,CAAC;YAChB,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,KAAK,EAAE,WAAW,CAAC,KAAK;YACxB,WAAW,EAAE,WAAW,CAAC,WAAW;YACpC,QAAQ,EAAE,WAAW,EAAE,QAAQ,IAAI,IAAI,CAAC,QAAQ;YAChD,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,IAAI,EAAE,IAAI,CAAC,IAAI;SACf,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,IAAe;QACxB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACH,cAAc,CAAC,IAAe;QAC7B,MAAM,QAAQ,GAAG,IAAI,IAAI,yBAAW,CAAC,OAAO,EAAE,EAAE,IAAgB,CAAC;QACjE,MAAM,WAAW,GAAG,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC;QAC1E,OAAO,IAAI,gBAAO,CAAC;YAClB,KAAK,EAAE,WAAW,EAAE,KAAK;YACzB,WAAW,EAAE,WAAW,EAAE,WAAW;YACrC,OAAO,EAAE,WAAW,EAAE,OAAO;YAC7B,QAAQ,EAAE,WAAW,EAAE,QAAQ,IAAI,IAAI,CAAC,QAAQ;YAChD,IAAI,EAAE,WAAW,EAAE,IAAI;SACvB,CAAC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,eAAe;QACd,OAAO,IAAI,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,gBAAO,CAAC;YAC9C,KAAK,EAAE,CAAC,CAAC,KAAK;YACd,WAAW,EAAE,CAAC,CAAC,WAAW;YAC1B,OAAO,EAAE,CAAC,CAAC,OAAO;YAClB,QAAQ,EAAE,CAAC,CAAC,QAAQ;YACpB,IAAI,EAAE,CAAC,CAAC,IAAI;YACZ,QAAQ,EAAE,CAAC,CAAC,QAAQ;SACpB,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,WAAW;QAChB,IAAI,CAAC,IAAI,CAAC,QAAQ;YAAE,OAAO,EAAE,CAAC;QAC9B,OAAO,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC,KAAK,EAAC,IAAI,EAAC,EAAE;YACxD,OAAO,MAAM,8BAAa,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;QAChD,CAAC,CAAC,CAAC,CAAC;IACL,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,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,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,UAAU,EAAE,qBAAY,CAAC,UAAU,EAAE,0BAAW,CAAC,CAAC,CAAC;QACzF,UAAU,CAAC,IAAI,CAAC,MAAM,IAAA,kBAAU,EAAC,IAAI,CAAC,UAAU,EAAE,qBAAY,CAAC,UAAU,CAAC,CAAC,CAAC;QAC5E,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAClC,CAAC;CACD,CAAA;AAhNY,kCAAW;AAavB;IAPC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,WAAW;QACjB,IAAI,EAAE,kBAAS;QACf,OAAO,EAAE,kBAAS,CAAC,0BAA0B;QAC7C,QAAQ,EAAE,KAAK;KACf,CAAC;;yCACc;AAYhB;IANC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,KAAK;QACX,IAAI,EAAE,oBAAW;QACjB,OAAO,EAAE,CAAC,oBAAW,CAAC,UAAU,CAAC;QACjC,QAAQ,EAAE,KAAK;KACf,CAAC;;6CACsB;AAYxB;IANC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,qBAAY;QAClB,OAAO,EAAE,qBAAY,CAAC,OAAO;QAC7B,QAAQ,EAAE,KAAK;KACf,CAAC;;0CACkB;AAUpB;IALC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,aAAa;QACnB,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;iDACsB;AAUxB;IAJC,IAAA,gBAAM,EAAC;QACP,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;6CACe;AAYjB;IAJC,IAAA,gBAAM,EAAC;QACP,QAAQ,EAAE,KAAK;QACf,OAAO,EAAE,IAAI;KACb,CAAC;;2CACc;AAShB;IAJC,IAAA,gBAAM,EAAC;QACP,QAAQ,EAAE,KAAK;QACf,OAAO,EAAE,CAAC;KACV,CAAC;;yCACW;AAMb;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;;8CACxB;AAMlB;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;8BAC/B,IAAI;8CAAC;AAMhB;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;;+CACvB;AAMnB;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;8BAC9B,IAAI;+CAAC;AAOjB;IADC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,mCAAkB,EAAE,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;;8CACrB;sBA7G7B,WAAW;IADvB,IAAA,gBAAM,EAAC,cAAc,CAAC;;GACV,WAAW,CAgNvB"}

package/lib/catalog/addon/country.entity.d.ts

@@ -0,0 +1,112 @@
+import { Activity, Addon, Language, Metadata } from '@driveup/common';
+import { CountryEntity } from '../../system/country/country.entity';
+import { CompanyProductAddonEntity } from '../../profile/company/product/addon.entity';
+import { AddonEntity } from './addon.entity';
+import { TrackableEntity } from '../../utils';
+/**
+ * Represents an addon configuration for a specific country.
+ * This entity manages the country-specific pricing, availability, and localization
+ * of addons within the system. Each addon can have different settings per country.
+ *
+ * @template T - Type parameter for custom metadata structure
+ */
+export declare class AddonCountryEntity extends TrackableEntity<Addon> {
+    /**
+     * Unique identifier for the addon-country relationship
+     */
+    /**
+     * Reference to the addon this configuration belongs to
+     */
+    addonId: number;
+    /**
+     * Reference to the country this configuration applies to
+     */
+    countryId: number;
+    /**
+     * Base price for the addon in the country's currency
+     * Precision: 8 digits, Scale: 2 decimal places
+     */
+    price: number;
+    /**
+     * Value Added Tax (VAT) rate applicable to this addon in the specific country
+     * Precision: 8 digits, Scale: 2 decimal places
+     */
+    vat: number;
+    /**
+     * Number of free benefits included with the addon
+     * Used for promotional purposes or trial periods
+     */
+    freeBenefits: number;
+    /**
+     * Addon active status
+     * Activating/deactivating an addon will not affect existing customers
+     * but will prevent new customers from purchasing the addon.
+     * Deactivating must set all country and company addons to enabled=false
+     */
+    active: boolean;
+    /**
+     * Sort by country relevance
+     */
+    sort: number;
+    /**
+     * Additional metadata
+     */
+    metadata: Metadata[];
+    /**
+     * ID of the administrator who enabled this addon for the country
+     */
+    enabledBy: number;
+    /**
+     * Timestamp when the addon was enabled for the country
+     */
+    enabledOn: Date;
+    /**
+     * ID of the administrator who disabled this addon for the country
+     */
+    disabledBy: number;
+    /**
+     * Timestamp when the addon was disabled for the country
+     */
+    disabledOn: Date;
+    /**
+     * Addon relation
+     */
+    addon: Promise<AddonEntity>;
+    /**
+     * Country relation
+     */
+    country: Promise<CountryEntity>;
+    /**
+     * Company addon relation
+     * Companies that have this addon assigned
+     */
+    companyProducts: Promise<CompanyProductAddonEntity[]>;
+    /**
+     * Creates an instance of AddonCountryEntity
+     * @param props - Partial properties to initialize the entity
+     */
+    constructor(props?: Partial<AddonCountryEntity>);
+    /**
+     * Converts the entity to an Addon model with country-specific pricing and settings
+     * @param lang - Language code for localization (defaults to current context language)
+     * @returns Addon model instance with country-specific data
+     */
+    toModel(lang?: Language): Promise<Addon>;
+    /**
+     * Converts the entity to an Addon model with country-specific pricing and settings
+     * @param lang - Language code for localization (defaults to current context language)
+     * @returns Addon model instance with country-specific data
+     */
+    toSummary(lang?: Language): Promise<Addon>;
+    /**
+     * Retrieves metadata as typed Metadata instances
+     * @returns Array of Metadata objects
+     */
+    getMetadata(): Metadata<any>[];
+    /**
+     * Retrieves all activity records for this addon-country configuration
+     * Includes creation, updates, enable/disable actions
+     * @returns Array of Activity objects
+     */
+    getActivities(): Promise<Activity[]>;
+}