tt-entities 0.0.53 → 0.0.55

package/libs/tatayab-entities-library/src/entities/user-transaction.entity.ts

@@ -3,6 +3,7 @@ import {
 } from 'sequelize-typescript';
 import { User } from './user.entity';
 import { Order } from './order.entity';
+import { Store } from './store.entity';
 
 export enum TransactionType {
   DEBIT  = 'debit',   // money leaves user balance
@@ -10,12 +11,12 @@ export enum TransactionType {
 }
 
 export enum TransactionCategory {
-  ORDER_PAYMENT      = 'order_payment',      // DEBIT: paid for order
+  ORDER_PAYMENT      = 'order_payment',      // DEBIT:  paid for order
   ORDER_REFUND       = 'order_refund',       // CREDIT: refund received
-  GIFT_SENT          = 'gift_sent',          // DEBIT: sent gift to someone
+  GIFT_SENT          = 'gift_sent',          // DEBIT:  sent gift to someone
   GIFT_RECEIVED      = 'gift_received',      // CREDIT: received a gift
   BALANCE_TOP_UP     = 'balance_top_up',     // CREDIT: topped up wallet
-  BALANCE_WITHDRAWAL = 'balance_withdrawal', // DEBIT: withdrew balance
+  BALANCE_WITHDRAWAL = 'balance_withdrawal', // DEBIT:  withdrew balance
   COUPON_CREDIT      = 'coupon_credit',      // CREDIT: coupon cashback
   ADJUSTMENT         = 'adjustment',         // DEBIT or CREDIT: manual admin adjustment
   CASHBACK           = 'cashback',           // CREDIT: loyalty cashback
@@ -27,6 +28,15 @@ export class UserTransaction extends Model {
   @Column({ allowNull: false })
   declare userId: number;
 
+  /**
+   * The store this transaction belongs to.
+   * NULL only for legacy rows migrated before this column existed.
+   * All new transactions MUST have a storeId so the balance is store-scoped.
+   */
+  @ForeignKey(() => Store)
+  @Column({ allowNull: true })
+  declare storeId?: number;
+
   @Column({
     type: DataType.ENUM(...Object.values(TransactionType)),
     allowNull: false,
@@ -43,27 +53,28 @@ export class UserTransaction extends Model {
   @Column({ type: DataType.DECIMAL(10, 3), allowNull: false })
   declare amount: number;
 
-  // Running balance AFTER this transaction
+  /**
+   * Running balance for this (userId, storeId) pair AFTER this transaction.
+   * Previously this mirrored User.walletBalance which was global — now it
+   * correctly reflects the per-store balance.
+   */
   @Column({ type: DataType.DECIMAL(10, 3), allowNull: false, defaultValue: 0 })
   declare balanceAfter: number;
 
-  // Currency of the transaction
+  // Currency — must always match the store's currency
   @Column({ allowNull: false, defaultValue: 'KWD' })
   declare currency: string;
 
-  // Bilingual description shown in the app
   @Column({ allowNull: false })
   declare descriptionEn: string;
 
   @Column({ allowNull: false })
   declare descriptionAr: string;
 
-  // Reference to the related order (if applicable)
   @ForeignKey(() => Order)
   @Column({ allowNull: true })
   declare orderId?: number;
 
-  // External reference (payment gateway transaction ID, etc.)
   @Column({ allowNull: true })
   declare externalReference?: string;
 
@@ -71,11 +82,13 @@ export class UserTransaction extends Model {
   @Column({ allowNull: false, defaultValue: 'completed' })
   declare status: string;
 
-  // ── Associations ──────────────────────────────────────────────────────────────
-
+  // ── Associations ──────────────────────────────────────────────────────────
   @BelongsTo(() => User)
   declare user: User;
 
+  @BelongsTo(() => Store)
+  declare store?: Store;
+
   @BelongsTo(() => Order)
   declare order?: Order;
 }

package/libs/tatayab-entities-library/src/entities/user-wallet-balance.entity.ts

@@ -0,0 +1,50 @@
+import {
+  Model,
+  Table,
+  Column,
+  ForeignKey,
+  BelongsTo,
+  DataType,
+  Unique,
+} from 'sequelize-typescript';
+import { User } from './user.entity';
+import { Store } from './store.entity';
+
+/**
+ * UserWalletBalance — per-user, per-store wallet balance.
+ *
+ * WHY: A user may shop in multiple stores (Kuwait, Saudi, UAE...) each with
+ * their own currency. Wallet credits from a Saudi store refund can only be
+ * spent in that same store. Mixing them into a single `walletBalance` on User
+ * would mean 30 KWD + 120 SAR = meaningless 150.
+ *
+ * One row per (userId, storeId) pair. Created on first credit if it doesn't
+ * exist yet (upsert pattern).
+ */
+@Table
+export class UserWalletBalance extends Model {
+  @ForeignKey(() => User)
+  @Column({ allowNull: false })
+  declare userId: number;
+
+  @ForeignKey(() => Store)
+  @Column({ allowNull: false })
+  declare storeId: number;
+
+  @Column({ type: DataType.DECIMAL(10, 3), allowNull: false, defaultValue: 0 })
+  declare balance: number;
+
+  /**
+   * Denormalized from Store.currency — avoids a join every time we need to
+   * show the currency symbol. Updated automatically when Store currency changes
+   * (rare, but handled in WalletService.credit / WalletService.debit).
+   */
+  @Column({ allowNull: false, defaultValue: 'KWD' })
+  declare currency: string;
+
+  @BelongsTo(() => User)
+  declare user: User;
+
+  @BelongsTo(() => Store)
+  declare store: Store;
+}

package/libs/tatayab-entities-library/src/entities/user.entity.ts

@@ -28,6 +28,9 @@ export class User extends Model {
   @Column
   declare password: string;
 
+  @Column({ allowNull: true, defaultValue: null })
+  declare legacyPasswordHash?: string;
+
   @Column({
     type: DataType.ENUM(...Object.values(Status)),
     defaultValue: Status.ACTIVE,

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

@@ -80,6 +80,7 @@ import { RunSheetOrder } from './entities/run-sheet-order.entity';
 import { Refund } from './entities/refund.entity';
 import { PurchaseOrderReceipt } from './entities/purchase-order-receipt.entity';
 import { PurchaseOrderReceiptItem } from './entities/purchase-order-receipt-item.entity';
+import { UserWalletBalance } from './entities/user-wallet-balance.entity';
 
 // =============================================================================
 // EXPORTS
@@ -113,6 +114,8 @@ export {
 } from './entities/run-sheet-order.entity';
 
 export { Refund, RefundMethod, RefundStatus } from './entities/refund.entity';
+export { UserWalletBalance } from './entities/user-wallet-balance.entity';
+
 
 
 // ─── Catalogue ────────────────────────────────────────────────────────────────
@@ -229,6 +232,8 @@ export function getDbModels(): ModelCtor[] {
     UserAddress,
     UserFavorite,
     UserFavoriteCatalog,
+    UserTransaction,
+    UserWalletBalance,
 
     // Catalogue
     Category,
@@ -289,7 +294,6 @@ export function getDbModels(): ModelCtor[] {
     OrderItem,
     OrderItemBundleSelection,
     OrderStatusHistory,
-    UserTransaction,
     PurchaseOrderOrderItem,
 
     // Banners

package/package.json

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