@driveup/schema 0.1.0

package/lib/system/staff/staff.entity.js

@@ -0,0 +1,186 @@
+"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 StaffEntity_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StaffEntity = void 0;
+const typeorm_1 = require("typeorm");
+const common_1 = require("@driveup/common");
+const utils_1 = require("../../utils");
+const utils_2 = require("../../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
+ */
+let StaffEntity = StaffEntity_1 = class StaffEntity extends utils_2.TrackableEntity {
+    /**
+     * Current account status
+     * @default AccountStatus.Pending
+     */
+    status;
+    /**
+     * Staff role defining permissions and responsibilities
+     * @default StaffRole.CustomerSupportManager
+     */
+    role;
+    /**
+     * Preferred language for the staff member
+     * @default Language.En
+     */
+    language;
+    /**
+     * Full name of the staff member
+     */
+    name;
+    /**
+     * Phone number (unique identifier for authentication)
+     */
+    phone;
+    /**
+     * Email address for notifications and communication
+     */
+    email;
+    /**
+     * URL to the staff member's profile image
+     */
+    imageUrl;
+    /**
+     * Unique identifier (UUID) for external references
+     */
+    uid;
+    /**
+     * Creates a new StaffEntity instance
+     * @param props - Partial properties to initialize the entity
+     */
+    constructor(props) {
+        super();
+        Object.assign(this, props);
+    }
+    /**
+     * Converts the entity to a Staff model instance
+     * @returns Staff model with core staff information
+     */
+    toModel() {
+        return new common_1.Staff({
+            id: this.id,
+            uid: this.uid,
+            role: this.role,
+            name: this.name,
+            phone: this.phone,
+            email: this.email,
+            imageUrl: this.imageUrl
+        });
+    }
+    /**
+     * Converts the entity to a Staff model instance
+     * @returns Staff model with core staff information
+     */
+    toSummary() {
+        return this.toModel();
+    }
+    /**
+     * Converts the entity to a Person model instance
+     * @returns Person model with basic personal information
+     */
+    toPerson() {
+        return new common_1.Person({
+            id: this.id,
+            name: this.name,
+            phone: this.phone,
+            email: this.email,
+            imageUrl: this.imageUrl
+        });
+    }
+    /**
+     * Retrieves activity history for this staff member
+     * @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, StaffEntity_1));
+        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, StaffEntity_1));
+        activities.push(await (0, utils_1.toActivity)(this.updatedOn, common_1.ActivityType.updatedOn));
+        return activities.filter(a => a);
+    }
+};
+exports.StaffEntity = StaffEntity;
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'enum',
+        enum: common_1.AccountStatus,
+        default: common_1.AccountStatus.Pending,
+        nullable: false
+    }),
+    __metadata("design:type", String)
+], StaffEntity.prototype, "status", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'enum',
+        enum: common_1.StaffRole,
+        default: common_1.StaffRole.CustomerSupportManager,
+        nullable: false
+    }),
+    __metadata("design:type", String)
+], StaffEntity.prototype, "role", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'enum',
+        enum: common_1.Language,
+        default: common_1.Language.En,
+        nullable: true
+    }),
+    __metadata("design:type", String)
+], StaffEntity.prototype, "language", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", String)
+], StaffEntity.prototype, "name", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: false,
+        unique: true
+    }),
+    __metadata("design:type", String)
+], StaffEntity.prototype, "phone", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", String)
+], StaffEntity.prototype, "email", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", String)
+], StaffEntity.prototype, "imageUrl", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+        unique: true
+    }),
+    (0, typeorm_1.Generated)('uuid'),
+    __metadata("design:type", String)
+], StaffEntity.prototype, "uid", void 0);
+exports.StaffEntity = StaffEntity = StaffEntity_1 = __decorate([
+    (0, typeorm_1.Entity)('systemStaff'),
+    __metadata("design:paramtypes", [Object])
+], StaffEntity);
+//# sourceMappingURL=staff.entity.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"staff.entity.js","sourceRoot":"","sources":["../../../src/system/staff/staff.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,qCAAoD;AACpD,4CAA4G;AAC5G,uCAAyC;AACzC,uCAA8C;AAE9C;;;;;;;GAOG;AAEI,IAAM,WAAW,mBAAjB,MAAM,WAAY,SAAQ,uBAAsB;IAEtD;;;OAGG;IAOH,MAAM,CAAgB;IAEtB;;;OAGG;IAOH,IAAI,CAAY;IAEhB;;;OAGG;IAOH,QAAQ,CAAW;IAEnB;;OAEG;IAKH,IAAI,CAAS;IAEb;;OAEG;IAKH,KAAK,CAAS;IAEd;;OAEG;IAKH,KAAK,CAAS;IAEd;;OAEG;IAKH,QAAQ,CAAS;IAEjB;;OAEG;IAMH,GAAG,CAAS;IAEZ;;;OAGG;IACH,YAAY,KAA4B;QACvC,KAAK,EAAE,CAAC;QACR,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACH,OAAO;QACN,OAAO,IAAI,cAAK,CAAC;YAChB,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACvB,CAAC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,SAAS;QACR,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;IACvB,CAAC;IAED;;;OAGG;IACH,QAAQ;QACP,OAAO,IAAI,eAAM,CAAC;YACjB,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACvB,CAAC,CAAC;IACJ,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,EAAE,aAAW,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,aAAW,CAAC,CAAC,CAAC;QACvF,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;AA/IY,kCAAW;AAYvB;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;AAYtB;IANC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,kBAAS;QACf,OAAO,EAAE,kBAAS,CAAC,sBAAsB;QACzC,QAAQ,EAAE,KAAK;KACf,CAAC;;yCACc;AAYhB;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;AASnB;IAJC,IAAA,gBAAM,EAAC;QACP,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;yCACW;AASb;IAJC,IAAA,gBAAM,EAAC;QACP,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE,IAAI;KACZ,CAAC;;0CACY;AASd;IAJC,IAAA,gBAAM,EAAC;QACP,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;0CACY;AASd;IAJC,IAAA,gBAAM,EAAC;QACP,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;6CACe;AAUjB;IALC,IAAA,gBAAM,EAAC;QACP,QAAQ,EAAE,IAAI;QACd,MAAM,EAAE,IAAI;KACZ,CAAC;IACD,IAAA,mBAAS,EAAC,MAAM,CAAC;;wCACN;sBAlFA,WAAW;IADvB,IAAA,gBAAM,EAAC,aAAa,CAAC;;GACT,WAAW,CA+IvB"}