@driveup/schema 0.1.0

package/lib/system/event/log.entity.js

@@ -0,0 +1,202 @@
+"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);
+};
+var LogEntity_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LogEntity = void 0;
+const typeorm_1 = require("typeorm");
+const nestjs_i18n_1 = require("nestjs-i18n");
+const common_1 = require("@driveup/common");
+const utils_1 = require("../../utils");
+const DELIMITER = '.log.';
+/**
+ * Represents a system log entry for tracking events and activities.
+ * Logs record important actions and changes across different entity types
+ * (users, companies, agents, etc.) and can be localized for display.
+ *
+ * @extends TrackableEntity
+ */
+let LogEntity = LogEntity_1 = class LogEntity extends utils_1.TrackableEntity {
+    /**
+     * The type of event that is being logged.
+     * This can be used to categorize the log entry.
+     * @type {LogType}
+     */
+    scope;
+    /**
+     * The type of event that is being logged.
+     * This can be used to categorize the log entry.
+     * @type {string}
+     * @example 'user.identity.nameChanged'
+     */
+    event;
+    /**
+     * The id of the entity associated with the log entry.
+     * In relation with logType, can be userId, companyId, agentId, studentId, etc.
+     * This is used to filter logs by entity.
+     * @type {number}
+     */
+    entityId;
+    /**
+     * The content of the log entry.
+     * This should contain the details of the event being logged.
+     * @type {string}
+     */
+    content;
+    /**
+     * Creates a new LogEntity instance
+     * @param props - Partial properties to initialize the entity
+     */
+    constructor(props) {
+        super();
+        Object.assign(this, props);
+    }
+    /**
+     * Converts the entity to a Log model instance
+     * @returns Log model with type, event, content, and creation date
+     */
+    toModel() {
+        return new common_1.Log({
+            type: this.scope,
+            event: this.event,
+            content: this.content,
+            createdOn: this.createdOn
+        });
+    }
+    /**
+     * Converts the entity to a Log model instance
+     * @returns Log model with type, event, content, and creation date
+     */
+    toSummary() {
+        return this.toModel();
+    }
+    /**
+     * Creates and saves a new log entry
+     * @param props - Properties for the new log entry
+     * @returns Promise that resolves when the log is saved
+     */
+    static async from(props) {
+        const entity = new LogEntity_1(props);
+        await entity.save();
+    }
+    /**
+     * Generates localized content for user log entries
+     * @param event - The event identifier
+     * @param lang - Language code for translation
+     * @param metadata - Optional metadata for i18n interpolation
+     * @returns Localized log content string, or empty string if translation not found
+     */
+    static toUserContent(event, lang, metadata) {
+        const key = event + DELIMITER + common_1.LogType.User;
+        const content = nestjs_i18n_1.I18nContext.current().t(key, { args: metadata, lang });
+        return content === key ? '' : content;
+    }
+    /**
+     * Generates localized content for student log entries
+     * @param event - The event identifier
+     * @param lang - Language code for translation
+     * @param metadata - Optional metadata for i18n interpolation
+     * @returns Localized log content string, or empty string if translation not found
+     */
+    static toStudentContent(event, lang, metadata) {
+        const key = event + `.log.author`;
+        const content = nestjs_i18n_1.I18nContext.current().t(key, { args: metadata, lang });
+        return content === key ? '' : content;
+    }
+    /**
+     * Generates localized content for agent log entries
+     * @param event - The event identifier
+     * @param lang - Language code for translation
+     * @param metadata - Optional metadata for i18n interpolation
+     * @returns Localized log content string, or empty string if translation not found
+     */
+    static toAgentContent(event, lang, metadata) {
+        const key = event + DELIMITER + common_1.LogType.Agent;
+        const content = nestjs_i18n_1.I18nContext.current().t(key, { args: metadata, lang });
+        return content === key ? '' : content;
+    }
+    /**
+     * Generates localized content for instructor log entries
+     * @param event - The event identifier
+     * @param lang - Language code for translation
+     * @param metadata - Optional metadata for i18n interpolation
+     * @returns Localized log content string, or empty string if translation not found
+     */
+    static toInstructorContent(event, lang, metadata) {
+        const key = event + DELIMITER + common_1.LogType.Instructor;
+        const content = nestjs_i18n_1.I18nContext.current().t(key, { args: metadata, lang });
+        return content === key ? '' : content;
+    }
+    /**
+     * Generates localized content for company log entries
+     * @param event - The event identifier
+     * @param lang - Language code for translation
+     * @param metadata - Optional metadata for i18n interpolation
+     * @returns Localized log content string, or empty string if translation not found
+     */
+    static toCompanyContent(event, lang, metadata) {
+        const key = event + DELIMITER + common_1.LogType.Company;
+        const content = nestjs_i18n_1.I18nContext.current().t(key, { args: metadata, lang });
+        return content === key ? '' : content;
+    }
+    static toAuthorContent(event, lang, metadata) {
+        const key = event + DELIMITER + `author`;
+        const content = nestjs_i18n_1.I18nContext.current().t(key, { args: metadata, lang });
+        return content === key ? '' : content;
+    }
+    static toTargetContent(event, lang, metadata) {
+        const key = event + DELIMITER + `target`;
+        const content = nestjs_i18n_1.I18nContext.current().t(key, { args: metadata, lang });
+        return content === key ? '' : content;
+    }
+    static toSystemContent(event, metadata) {
+        const key = event + DELIMITER + common_1.LogType.System;
+        const content = nestjs_i18n_1.I18nContext.current().t(key, { args: metadata, lang: 'en' });
+        return content === key ? '' : content;
+    }
+    static toJobContent(event, metadata) {
+        const key = event + DELIMITER + common_1.LogType.Job;
+        const content = nestjs_i18n_1.I18nContext.current().t(key, { args: metadata, lang: 'en' });
+        return content === key ? '' : content;
+    }
+    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));
+        return activities.filter(a => a);
+    }
+};
+exports.LogEntity = LogEntity;
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'enum',
+        enum: common_1.LogType,
+        default: common_1.LogType.User,
+        nullable: true
+    }),
+    __metadata("design:type", String)
+], LogEntity.prototype, "scope", void 0);
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", String)
+], LogEntity.prototype, "event", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, default: null }),
+    __metadata("design:type", Number)
+], LogEntity.prototype, "entityId", void 0);
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", String)
+], LogEntity.prototype, "content", void 0);
+exports.LogEntity = LogEntity = LogEntity_1 = __decorate([
+    (0, typeorm_1.Entity)('systemLogs'),
+    __metadata("design:paramtypes", [Object])
+], LogEntity);
+//# sourceMappingURL=log.entity.js.map

package/lib/system/event/log.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"log.entity.js","sourceRoot":"","sources":["../../../src/system/event/log.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,qCAAyC;AACzC,6CAA0C;AAC1C,4CAAuE;AACvE,uCAA0D;AAE1D,MAAM,SAAS,GAAG,OAAO,CAAC;AAE1B;;;;;;GAMG;AAEI,IAAM,SAAS,iBAAf,MAAM,SAAU,SAAQ,uBAAoB;IAElD;;;;OAIG;IAOH,KAAK,CAAU;IAEf;;;;;OAKG;IAEH,KAAK,CAAS;IAEd;;;;;OAKG;IAEH,QAAQ,CAAS;IAEjB;;;;OAIG;IAEH,OAAO,CAAS;IAEhB;;;OAGG;IACH,YAAY,KAA0B;QACrC,KAAK,EAAE,CAAC;QACR,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACH,OAAO;QACN,OAAO,IAAI,YAAG,CAAC;YACd,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,SAAS,EAAE,IAAI,CAAC,SAAS;SACzB,CAAC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,SAAS;QACR,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,KAAyB;QAC1C,MAAM,MAAM,GAAG,IAAI,WAAS,CAAC,KAAK,CAAC,CAAC;QACpC,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;IACrB,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,aAAa,CAAC,KAAa,EAAE,IAAY,EAAE,QAAc;QAC/D,MAAM,GAAG,GAAG,KAAK,GAAC,SAAS,GAAC,gBAAO,CAAC,IAAI,CAAC;QACzC,MAAM,OAAO,GAAG,yBAAW,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAW,CAAC;QACjF,OAAO,OAAO,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;IACvC,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,gBAAgB,CAAC,KAAa,EAAE,IAAY,EAAE,QAAc;QAClE,MAAM,GAAG,GAAG,KAAK,GAAC,aAAa,CAAC;QAChC,MAAM,OAAO,GAAG,yBAAW,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAW,CAAC;QACjF,OAAO,OAAO,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;IACvC,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,cAAc,CAAC,KAAa,EAAE,IAAY,EAAE,QAAc;QAChE,MAAM,GAAG,GAAG,KAAK,GAAC,SAAS,GAAC,gBAAO,CAAC,KAAK,CAAC;QAC1C,MAAM,OAAO,GAAG,yBAAW,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAW,CAAC;QACjF,OAAO,OAAO,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;IACvC,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,mBAAmB,CAAC,KAAa,EAAE,IAAY,EAAE,QAAc;QACrE,MAAM,GAAG,GAAG,KAAK,GAAC,SAAS,GAAC,gBAAO,CAAC,UAAU,CAAC;QAC/C,MAAM,OAAO,GAAI,yBAAW,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAW,CAAC;QAClF,OAAO,OAAO,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;IACvC,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,gBAAgB,CAAC,KAAa,EAAE,IAAY,EAAE,QAAc;QAClE,MAAM,GAAG,GAAG,KAAK,GAAC,SAAS,GAAC,gBAAO,CAAC,OAAO,CAAC;QAC5C,MAAM,OAAO,GAAG,yBAAW,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAW,CAAC;QACjF,OAAO,OAAO,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;IACvC,CAAC;IAED,MAAM,CAAC,eAAe,CAAC,KAAa,EAAE,IAAY,EAAE,QAAc;QACjE,MAAM,GAAG,GAAG,KAAK,GAAC,SAAS,GAAC,QAAQ,CAAC;QACrC,MAAM,OAAO,GAAG,yBAAW,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAW,CAAC;QACjF,OAAO,OAAO,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;IACvC,CAAC;IAED,MAAM,CAAC,eAAe,CAAC,KAAa,EAAE,IAAY,EAAE,QAAc;QACjE,MAAM,GAAG,GAAG,KAAK,GAAC,SAAS,GAAC,QAAQ,CAAC;QACrC,MAAM,OAAO,GAAG,yBAAW,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAW,CAAC;QACjF,OAAO,OAAO,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;IACvC,CAAC;IAED,MAAM,CAAC,eAAe,CAAC,KAAa,EAAE,QAAc;QACnD,MAAM,GAAG,GAAG,KAAK,GAAC,SAAS,GAAC,gBAAO,CAAC,MAAM,CAAC;QAC3C,MAAM,OAAO,GAAG,yBAAW,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,CAAW,CAAC;QACvF,OAAO,OAAO,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;IACvC,CAAC;IAED,MAAM,CAAC,YAAY,CAAC,KAAa,EAAE,QAAc;QAChD,MAAM,GAAG,GAAG,KAAK,GAAC,SAAS,GAAC,gBAAO,CAAC,GAAG,CAAC;QACxC,MAAM,OAAO,GAAG,yBAAW,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,CAAW,CAAC;QACvF,OAAO,OAAO,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;IACvC,CAAC;IAED,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,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAClC,CAAC;CACD,CAAA;AAhLY,8BAAS;AAarB;IANC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,gBAAO;QACb,OAAO,EAAE,gBAAO,CAAC,IAAI;QACrB,QAAQ,EAAE,IAAI;KACd,CAAC;;wCACa;AASf;IADC,IAAA,gBAAM,GAAE;;wCACK;AASd;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;;2CACzB;AAQjB;IADC,IAAA,gBAAM,GAAE;;0CACO;oBAvCJ,SAAS;IADrB,IAAA,gBAAM,EAAC,YAAY,CAAC;;GACR,SAAS,CAgLrB"}

package/lib/system/policy/policy.entity.d.ts

@@ -0,0 +1,90 @@
+import { ColorContext, Content, Language, Metadata } from '@driveup/common';
+import { Policy, PolicyType, Activity } from '@driveup/common';
+import { UserAlertEntity } from '../../user/alert.entity';
+import { TrackableEntity } from '../../utils';
+/**
+ * Represents a system policy or compliance requirement.
+ * Policies define rules and requirements that users must follow or complete,
+ * such as adding recovery email, updating profile information, or accepting terms.
+ * When activated, policies can trigger user alerts.
+ *
+ * @extends TrackableEntity
+ */
+export declare class PolicyEntity extends TrackableEntity<Policy> {
+    /**
+     * Type of policy (e.g., MissingRecoveryEmail, ProfileIncomplete)
+     * @default PolicyType.MissingRecoveryEmail
+     */
+    type: PolicyType;
+    /**
+     * UI color context for displaying the policy alert
+     * @default ColorContext.Info
+     */
+    color: ColorContext;
+    /**
+     * URL to the policy's representative image or icon
+     */
+    imageUrl: string;
+    /**
+     * Localized content for the policy (title, description, instructions)
+     */
+    translations: Content[];
+    /**
+     * Additional metadata for policy configuration
+     */
+    metadata: Metadata[];
+    /**
+     * Policy active status - controls whether new alerts are created
+     */
+    active: boolean;
+    /**
+     * ID of the staff member who enabled this policy
+     */
+    enabledBy: number;
+    /**
+     * Date when the policy was enabled
+     */
+    enabledOn: Date;
+    /**
+     * ID of the staff member who disabled this policy
+     */
+    disabledBy: number;
+    /**
+     * Date when the policy was disabled
+     */
+    disabledOn: Date;
+    /**
+     * User alerts generated from this policy
+     */
+    alerts: Promise<UserAlertEntity[]>;
+    /**
+     * Creates a new PolicyEntity instance
+     * @param props - Partial properties to initialize the entity
+     */
+    constructor(props?: Partial<PolicyEntity>);
+    /**
+     * Converts the entity to a Policy model instance
+     * @param lang - Optional language for translations
+     * @returns Policy model with localized content
+     */
+    toModel(lang?: Language): Policy;
+    /**
+     * Converts the entity to a Policy summary instance
+     * @param lang - Optional language for translations
+     * @returns Policy model with localized content
+     */
+    toSummary(lang?: Language): Policy;
+    /**
+     * Gets the localized translation for the policy
+     * @param lang - Optional language code; defaults to current i18n context or English
+     * @returns Content instance with translated title and description
+     */
+    getTranslation(lang?: Language): Content;
+    /**
+     * Gets all available translations for the policy
+     * @returns Array of Content instances for all languages
+     */
+    getTranslations(): Content[];
+    getMetadata(): Metadata<any>[];
+    getActivities(): Promise<Activity[]>;
+}

package/lib/system/policy/policy.entity.js

@@ -0,0 +1,226 @@
+"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.PolicyEntity = void 0;
+const typeorm_1 = require("typeorm");
+const nestjs_i18n_1 = require("nestjs-i18n");
+const common_1 = require("@driveup/common");
+const common_2 = require("@driveup/common");
+const alert_entity_1 = require("../../user/alert.entity");
+const staff_entity_1 = require("../staff/staff.entity");
+const utils_1 = require("../../utils");
+/**
+ * Represents a system policy or compliance requirement.
+ * Policies define rules and requirements that users must follow or complete,
+ * such as adding recovery email, updating profile information, or accepting terms.
+ * When activated, policies can trigger user alerts.
+ *
+ * @extends TrackableEntity
+ */
+let PolicyEntity = class PolicyEntity extends utils_1.TrackableEntity {
+    /**
+     * Type of policy (e.g., MissingRecoveryEmail, ProfileIncomplete)
+     * @default PolicyType.MissingRecoveryEmail
+     */
+    type;
+    /**
+     * UI color context for displaying the policy alert
+     * @default ColorContext.Info
+     */
+    color;
+    /**
+     * URL to the policy's representative image or icon
+     */
+    imageUrl;
+    /**
+     * Localized content for the policy (title, description, instructions)
+     */
+    translations;
+    /**
+     * Additional metadata for policy configuration
+     */
+    metadata;
+    /**
+     * Policy active status - controls whether new alerts are created
+     */
+    active;
+    /**
+     * ID of the staff member who enabled this policy
+     */
+    enabledBy;
+    /**
+     * Date when the policy was enabled
+     */
+    enabledOn;
+    /**
+     * ID of the staff member who disabled this policy
+     */
+    disabledBy;
+    /**
+     * Date when the policy was disabled
+     */
+    disabledOn;
+    /**
+     * User alerts generated from this policy
+     */
+    alerts;
+    /**
+     * Creates a new PolicyEntity instance
+     * @param props - Partial properties to initialize the entity
+     */
+    constructor(props) {
+        super();
+        Object.assign(this, props);
+    }
+    /**
+     * Converts the entity to a Policy model instance
+     * @param lang - Optional language for translations
+     * @returns Policy model with localized content
+     */
+    toModel(lang) {
+        const transaltion = this.getTranslation(lang);
+        return new common_2.Policy({
+            id: this.id,
+            type: this.type,
+            color: this.color,
+            active: this.active,
+            title: transaltion.title,
+            description: transaltion.description,
+            imageUrl: transaltion.imageUrl,
+            metadata: this.getMetadata(),
+        });
+    }
+    /**
+     * Converts the entity to a Policy summary instance
+     * @param lang - Optional language for translations
+     * @returns Policy model with localized content
+     */
+    toSummary(lang) {
+        return this.toModel(lang);
+    }
+    /**
+     * Gets the localized translation for the policy
+     * @param lang - Optional language code; defaults to current i18n context or English
+     * @returns Content instance with translated title and description
+     */
+    getTranslation(lang) {
+        const language = (lang || nestjs_i18n_1.I18nContext.current()?.lang) || common_1.Language.En;
+        const translation = this.translations?.find(t => t.language === language);
+        return new common_1.Content({
+            title: translation?.title,
+            description: translation?.description,
+            content: translation?.content,
+            imageUrl: translation?.imageUrl,
+            link: translation?.link,
+        });
+    }
+    /**
+     * Gets all available translations for the policy
+     * @returns Array of Content instances for all languages
+     */
+    getTranslations() {
+        return this.translations?.map(t => new common_1.Content({
+            title: t.title,
+            description: t.description,
+            content: t.content,
+            imageUrl: t.imageUrl,
+            link: t.link,
+            language: t.language
+        }));
+    }
+    getMetadata() {
+        return this.metadata?.map(m => common_1.Metadata.toInstance(m));
+    }
+    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.updatedBy, common_2.ActivityType.updatedBy, staff_entity_1.StaffEntity));
+        activities.push(await (0, utils_1.toActivity)(this.updatedOn, common_2.ActivityType.updatedOn));
+        activities.push(await (0, utils_1.toActivity)(this.enabledBy, common_2.ActivityType.enabledBy, staff_entity_1.StaffEntity));
+        activities.push(await (0, utils_1.toActivity)(this.enabledOn, common_2.ActivityType.createdOn));
+        activities.push(await (0, utils_1.toActivity)(this.disabledBy, common_2.ActivityType.disabledBy, staff_entity_1.StaffEntity));
+        activities.push(await (0, utils_1.toActivity)(this.disabledOn, common_2.ActivityType.disabledOn));
+        return activities.filter(a => a);
+    }
+};
+exports.PolicyEntity = PolicyEntity;
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'enum',
+        name: 'policyType',
+        enum: common_2.PolicyType,
+        default: common_2.PolicyType.MissingRecoveryEmail,
+        nullable: false
+    }),
+    __metadata("design:type", String)
+], PolicyEntity.prototype, "type", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'enum',
+        enum: common_1.ColorContext,
+        default: common_1.ColorContext.Info,
+        nullable: false
+    }),
+    __metadata("design:type", String)
+], PolicyEntity.prototype, "color", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", String)
+], PolicyEntity.prototype, "imageUrl", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'simple-json',
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", Array)
+], PolicyEntity.prototype, "translations", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'simple-json',
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", Array)
+], PolicyEntity.prototype, "metadata", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, default: null }),
+    __metadata("design:type", Boolean)
+], PolicyEntity.prototype, "active", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, default: null }),
+    __metadata("design:type", Number)
+], PolicyEntity.prototype, "enabledBy", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, default: null }),
+    __metadata("design:type", Date)
+], PolicyEntity.prototype, "enabledOn", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, default: null }),
+    __metadata("design:type", Number)
+], PolicyEntity.prototype, "disabledBy", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, default: null }),
+    __metadata("design:type", Date)
+], PolicyEntity.prototype, "disabledOn", void 0);
+__decorate([
+    (0, typeorm_1.OneToMany)(() => alert_entity_1.UserAlertEntity, alert => alert.policy),
+    __metadata("design:type", Promise)
+], PolicyEntity.prototype, "alerts", void 0);
+exports.PolicyEntity = PolicyEntity = __decorate([
+    (0, typeorm_1.Entity)('systemPolicies'),
+    __metadata("design:paramtypes", [Object])
+], PolicyEntity);
+//# sourceMappingURL=policy.entity.js.map

package/lib/system/policy/policy.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"policy.entity.js","sourceRoot":"","sources":["../../../src/system/policy/policy.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qCAAoD;AACpD,6CAA0C;AAC1C,4CAA6E;AAC7E,4CAA4E;AAC5E,0DAA0D;AAC1D,wDAAoD;AACpD,uCAA0D;AAE1D;;;;;;;GAOG;AAEI,IAAM,YAAY,GAAlB,MAAM,YAAa,SAAQ,uBAAuB;IAExD;;;OAGG;IAQH,IAAI,CAAa;IAEjB;;;OAGG;IAOH,KAAK,CAAe;IAEpB;;OAEG;IAKH,QAAQ,CAAS;IAEjB;;OAEG;IAMH,YAAY,CAAY;IAExB;;OAEG;IAMH,QAAQ,CAAa;IAErB;;OAEG;IAEH,MAAM,CAAU;IAEhB;;OAEG;IAEH,SAAS,CAAS;IAElB;;OAEG;IAEH,SAAS,CAAO;IAEhB;;OAEG;IAEH,UAAU,CAAS;IAEnB;;OAEG;IAEH,UAAU,CAAO;IAEjB;;OAEG;IAEH,MAAM,CAA6B;IAEnC;;;OAGG;IACH,YAAY,KAA6B;QACxC,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,CAAC;QAC9C,OAAO,IAAI,eAAM,CAAC;YACjB,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,KAAK,EAAE,WAAW,CAAC,KAAK;YACxB,WAAW,EAAE,WAAW,CAAC,WAAW;YACpC,QAAQ,EAAE,WAAW,CAAC,QAAQ;YAC9B,QAAQ,EAAE,IAAI,CAAC,WAAW,EAAE;SAC5B,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,CAAC,IAAI,IAAI,yBAAW,CAAC,OAAO,EAAE,EAAE,IAAgB,CAAC,IAAI,iBAAQ,CAAC,EAAE,CAAC;QAClF,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;YAC/B,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,WAAW;QACV,OAAO,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,iBAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;IACxD,CAAC;IAED,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;AAjLY,oCAAY;AAaxB;IAPC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,YAAY;QAClB,IAAI,EAAE,mBAAU;QAChB,OAAO,EAAE,mBAAU,CAAC,oBAAoB;QACxC,QAAQ,EAAE,KAAK;KACf,CAAC;;0CACe;AAYjB;IANC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,qBAAY;QAClB,OAAO,EAAE,qBAAY,CAAC,IAAI;QAC1B,QAAQ,EAAE,KAAK;KACf,CAAC;;2CACkB;AASpB;IAJC,IAAA,gBAAM,EAAC;QACP,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;8CACe;AAUjB;IALC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,aAAa;QACnB,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;kDACsB;AAUxB;IALC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,aAAa;QACnB,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;8CACmB;AAMrB;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;;4CAC1B;AAMhB;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;;+CACxB;AAMlB;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;8BAC/B,IAAI;+CAAC;AAMhB;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;;gDACvB;AAMnB;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;8BAC9B,IAAI;gDAAC;AAMjB;IADC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,8BAAe,EAAE,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC;;4CACrB;uBA1FvB,YAAY;IADxB,IAAA,gBAAM,EAAC,gBAAgB,CAAC;;GACZ,YAAY,CAiLxB"}

package/lib/system/staff/staff.entity.d.ts

@@ -0,0 +1,72 @@
+import { AccountStatus, Language, Person, StaffRole, Activity, Staff } from '@driveup/common';
+import { TrackableEntity } from '../../utils';
+/**
+ * Represents a staff member in the system.
+ * Staff members are administrators or support personnel who manage
+ * the platform, assist customers, and perform system operations.
+ * Each staff member has a specific role and permissions.
+ *
+ * @extends TrackableEntity
+ */
+export declare class StaffEntity extends TrackableEntity<Staff> {
+    /**
+     * Current account status
+     * @default AccountStatus.Pending
+     */
+    status: AccountStatus;
+    /**
+     * Staff role defining permissions and responsibilities
+     * @default StaffRole.CustomerSupportManager
+     */
+    role: StaffRole;
+    /**
+     * Preferred language for the staff member
+     * @default Language.En
+     */
+    language: Language;
+    /**
+     * Full name of the staff member
+     */
+    name: string;
+    /**
+     * Phone number (unique identifier for authentication)
+     */
+    phone: string;
+    /**
+     * Email address for notifications and communication
+     */
+    email: string;
+    /**
+     * URL to the staff member's profile image
+     */
+    imageUrl: string;
+    /**
+     * Unique identifier (UUID) for external references
+     */
+    uid: string;
+    /**
+     * Creates a new StaffEntity instance
+     * @param props - Partial properties to initialize the entity
+     */
+    constructor(props?: Partial<StaffEntity>);
+    /**
+     * Converts the entity to a Staff model instance
+     * @returns Staff model with core staff information
+     */
+    toModel(): Staff;
+    /**
+     * Converts the entity to a Staff model instance
+     * @returns Staff model with core staff information
+     */
+    toSummary(): Staff;
+    /**
+     * Converts the entity to a Person model instance
+     * @returns Person model with basic personal information
+     */
+    toPerson(): Person;
+    /**
+     * Retrieves activity history for this staff member
+     * @returns Promise resolving to array of Activity instances tracking creation and updates
+     */
+    getActivities(): Promise<Activity[]>;
+}