tt-entities 0.0.44 → 0.0.46

package/libs/tatayab-entities-library/src/entities/run-sheet-order.entity.ts

@@ -0,0 +1,50 @@
+import {
+  Table,
+  Column,
+  Model,
+  ForeignKey,
+  BelongsTo,
+  DataType,
+} from 'sequelize-typescript';
+import { RunSheet } from './run-sheet.entity';
+import { Order } from './order.entity';
+
+export enum RunSheetOrderStatus {
+  ASSIGNED = 'assigned', // Order added to runsheet, marked shipped
+  DELIVERED = 'delivered', // Confirmed delivered on completion
+  RETURNED = 'returned', // Not delivered — returned to packed
+}
+
+@Table
+export class RunSheetOrder extends Model {
+  @ForeignKey(() => RunSheet)
+  @Column({ allowNull: false })
+  declare runSheetId: number;
+
+  @ForeignKey(() => Order)
+  @Column({ allowNull: false }) // one order belongs to one runsheet at a time
+  declare orderId: number;
+
+  @Column({
+    type: DataType.ENUM(...Object.values(RunSheetOrderStatus)),
+    allowNull: false,
+    defaultValue: RunSheetOrderStatus.ASSIGNED,
+  })
+  declare status: RunSheetOrderStatus;
+
+  // Filled when status = returned — why was this order not delivered
+  @Column({ type: DataType.TEXT, allowNull: true })
+  declare returnReason?: string;
+
+  // Snapshot of order number for display even if order is modified
+  @Column({ allowNull: true })
+  declare orderNumber?: string;
+
+  // ── Associations ─────────────────────────────────────────────────────────────
+
+  @BelongsTo(() => RunSheet)
+  declare runSheet: RunSheet;
+
+  @BelongsTo(() => Order)
+  declare order: Order;
+}

package/libs/tatayab-entities-library/src/entities/run-sheet.entity.ts

@@ -0,0 +1,68 @@
+import {
+  Table, Column, Model, ForeignKey, BelongsTo,
+  HasMany, DataType,
+} from 'sequelize-typescript';
+import { SysUser } from './sys.user.entity';
+import { RunSheetOrder } from './run-sheet-order.entity';
+
+export enum RunSheetStatus {
+  OPEN        = 'open',         // Created, orders assigned, all moved to shipped
+  OUT_FOR_DELIVERY = 'out_for_delivery', // Driver is on the road
+  COMPLETED   = 'completed',    // All orders delivered
+  PARTIALLY_COMPLETED = 'partially_completed', // Some delivered, some returned to packed
+  CANCELLED   = 'cancelled',
+}
+
+@Table
+export class RunSheet extends Model {
+  // Auto-generated e.g. RS-2026-00001
+  @Column({ allowNull: false, unique: true })
+  declare runSheetNumber: string;
+
+  @Column({
+    type: DataType.ENUM(...Object.values(RunSheetStatus)),
+    allowNull: false,
+    defaultValue: RunSheetStatus.OPEN,
+  })
+  declare status: RunSheetStatus;
+
+  // Driver / delivery person name
+  @Column({ allowNull: true })
+  declare driverName?: string;
+
+  @Column({ allowNull: true })
+  declare driverPhone?: string;
+
+  // Vehicle / route reference
+  @Column({ allowNull: true })
+  declare vehicleRef?: string;
+
+  @Column({ type: DataType.TEXT, allowNull: true })
+  declare notes?: string;
+
+  // Timestamps for lifecycle
+  @Column({ type: DataType.DATE, allowNull: true })
+  declare dispatchedAt?: Date; // when moved to out_for_delivery
+
+  @Column({ type: DataType.DATE, allowNull: true })
+  declare completedAt?: Date;
+
+  @ForeignKey(() => SysUser)
+  @Column({ allowNull: true })
+  declare createdBy?: number;
+
+  @ForeignKey(() => SysUser)
+  @Column({ allowNull: true })
+  declare completedBy?: number;
+
+  // ── Associations ─────────────────────────────────────────────────────────────
+
+  @BelongsTo(() => SysUser, { foreignKey: 'createdBy', as: 'creator' })
+  declare creator?: SysUser;
+
+  @BelongsTo(() => SysUser, { foreignKey: 'completedBy', as: 'completer' })
+  declare completer?: SysUser;
+
+  @HasMany(() => RunSheetOrder)
+  declare runSheetOrders: RunSheetOrder[];
+}

package/libs/tatayab-entities-library/src/index.ts

@@ -75,6 +75,8 @@ import { OrderItemBundleSelection } from './entities/order-item-bundle-selection
 import { OrderStatusHistory } from './entities/order-status-history.entity';
 import { UserTransaction } from './entities/user-transaction.entity';
 import { PurchaseOrderOrderItem } from './entities/purchase-order-order-item.entity';
+import { RunSheet } from './entities/run-sheet.entity';
+import { RunSheetOrder } from './entities/run-sheet-order.entity';
 
 // =============================================================================
 // EXPORTS
@@ -101,6 +103,11 @@ export {
   BannerFilters,
 } from './entities/banner.entity';
 export { AppConfig } from './entities/app-config.entity';
+export { RunSheet, RunSheetStatus } from './entities/run-sheet.entity';
+export {
+  RunSheetOrder,
+  RunSheetOrderStatus,
+} from './entities/run-sheet-order.entity';
 
 // ─── Catalogue ────────────────────────────────────────────────────────────────
 export { Category } from './entities/category.entity';
@@ -281,5 +288,8 @@ export function getDbModels(): ModelCtor[] {
     Banner,
 
     AppConfig,
+
+    RunSheet,
+    RunSheetOrder,
   ];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tt-entities",
-  "version": "0.0.44",
+  "version": "0.0.46",
   "description": "Tatayab entities library",
   "main": "dist/libs/tatayab-entities-library/index.js",
   "types": "dist/libs/tatayab-entities-library/index.d.ts",