tt-entities 0.0.31 → 0.0.32

package/libs/tatayab-entities-library/src/entities/coupon-product.entity.ts

@@ -0,0 +1,25 @@
+import { Table, Column, Model, ForeignKey, BelongsTo } from 'sequelize-typescript';
+import { Coupon } from './coupon.entity';
+import { Product } from './product.entity';
+import { ProductVariant } from './product-variant.entity';
+
+@Table
+export class CouponProduct extends Model {
+  @ForeignKey(() => Coupon)
+  @Column({ allowNull: false })
+  declare couponId: number;
+
+  @ForeignKey(() => Product)
+  @Column({ allowNull: false })
+  declare productId: number;
+
+  // null = applies to all variants of this product
+  // set = applies only to this specific variant
+  @ForeignKey(() => ProductVariant)
+  @Column({ allowNull: true })
+  declare productVariantId?: number;
+
+  @BelongsTo(() => Coupon)         declare coupon: Coupon;
+  @BelongsTo(() => Product)        declare product: Product;
+  @BelongsTo(() => ProductVariant) declare variant?: ProductVariant;
+}

package/libs/tatayab-entities-library/src/entities/coupon-store.entity.ts

@@ -0,0 +1,17 @@
+import { Table, Column, Model, ForeignKey, BelongsTo } from 'sequelize-typescript';
+import { Coupon } from './coupon.entity';
+import { Store } from './store.entity';
+
+@Table
+export class CouponStore extends Model {
+  @ForeignKey(() => Coupon)
+  @Column({ allowNull: false })
+  declare couponId: number;
+
+  @ForeignKey(() => Store)
+  @Column({ allowNull: false })
+  declare storeId: number;
+
+  @BelongsTo(() => Coupon) declare coupon: Coupon;
+  @BelongsTo(() => Store)  declare store: Store;
+}

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

@@ -0,0 +1,27 @@
+import { Table, Column, Model, ForeignKey, BelongsTo } from 'sequelize-typescript';
+import { Coupon } from './coupon.entity';
+import { User } from './user.entity';
+
+@Table
+export class CouponUser extends Model {
+  @ForeignKey(() => Coupon)
+  @Column({ allowNull: false })
+  declare couponId: number;
+
+  @ForeignKey(() => User)
+  @Column({ allowNull: false })
+  declare userId: number;
+
+  // How many times this specific user has used this coupon
+  @Column({ allowNull: false, defaultValue: 0 })
+  declare usedCount: number;
+
+  // Whether this coupon was pre-assigned to this user
+  // true = user-specific coupon (isUserSpecific=true on coupon)
+  // false = just tracking usage of a public coupon
+  @Column({ allowNull: false, defaultValue: false })
+  declare isPreAssigned: boolean;
+
+  @BelongsTo(() => Coupon) declare coupon: Coupon;
+  @BelongsTo(() => User)   declare user: User;
+}

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

@@ -0,0 +1,126 @@
+import {
+  Table, Column, Model, HasMany, DataType,
+} from 'sequelize-typescript';
+import { CouponStore } from './coupon-store.entity';
+import { CouponProduct } from './coupon-product.entity';
+import { CouponUser } from './coupon-user.entity';
+
+export enum CouponDiscountType {
+  FIXED      = 'fixed',      // Fixed amount deducted e.g. KD 2.000
+  PERCENTAGE = 'percentage', // Percentage e.g. 15% off
+}
+
+export enum CouponAppliesTo {
+  SUBTOTAL  = 'subtotal',  // Applies to cart item total
+  DELIVERY  = 'delivery',  // Applies to shipping fee only
+  VAT       = 'vat',       // VAT free (removes VAT amount)
+}
+
+export enum CouponOsTarget {
+  ALL     = 'all',
+  IOS     = 'ios',
+  ANDROID = 'android',
+  WEB     = 'web',
+}
+
+@Table
+export class Coupon extends Model {
+  // ── Identity ──────────────────────────────────────────────────────────────────
+  @Column({ allowNull: false, unique: true })
+  declare code: string; // The code the user types e.g. WELCOME20
+
+  @Column({ allowNull: false })
+  declare nameEn: string;
+
+  @Column({ allowNull: false })
+  declare nameAr: string;
+
+  @Column({ type: DataType.TEXT, allowNull: true })
+  declare descriptionEn?: string;
+
+  @Column({ type: DataType.TEXT, allowNull: true })
+  declare descriptionAr?: string;
+
+  // ── Validity period ───────────────────────────────────────────────────────────
+  @Column({ type: DataType.DATE, allowNull: false })
+  declare startsAt: Date;
+
+  @Column({ type: DataType.DATE, allowNull: false })
+  declare expiresAt: Date;
+
+  // ── Discount ──────────────────────────────────────────────────────────────────
+  @Column({
+    type: DataType.ENUM(...Object.values(CouponDiscountType)),
+    allowNull: false,
+    defaultValue: CouponDiscountType.PERCENTAGE,
+  })
+  declare discountType: CouponDiscountType;
+
+  // The amount or percentage value
+  @Column({ type: DataType.DECIMAL(10, 3), allowNull: false })
+  declare discountValue: number;
+
+  // Max deduction cap (only relevant for percentage type)
+  // e.g. 20% off but max KD 5 deduction
+  @Column({ type: DataType.DECIMAL(10, 3), allowNull: true })
+  declare maxDiscountAmount?: number;
+
+  // ── Applies to ────────────────────────────────────────────────────────────────
+  @Column({
+    type: DataType.ENUM(...Object.values(CouponAppliesTo)),
+    allowNull: false,
+    defaultValue: CouponAppliesTo.SUBTOTAL,
+  })
+  declare appliesTo: CouponAppliesTo;
+
+  // ── Minimum order value required ─────────────────────────────────────────────
+  @Column({ type: DataType.DECIMAL(10, 3), allowNull: true, defaultValue: 0 })
+  declare minOrderAmount?: number;
+
+  // ── OS targeting ─────────────────────────────────────────────────────────────
+  @Column({
+    type: DataType.ENUM(...Object.values(CouponOsTarget)),
+    allowNull: false,
+    defaultValue: CouponOsTarget.ALL,
+  })
+  declare osTarget: CouponOsTarget;
+
+  // ── Usage limits ──────────────────────────────────────────────────────────────
+  // null = unlimited uses globally
+  @Column({ type: DataType.INTEGER, allowNull: true })
+  declare maxUsesTotal?: number;
+
+  // null = unlimited per user
+  @Column({ type: DataType.INTEGER, allowNull: true, defaultValue: 1 })
+  declare maxUsesPerUser?: number;
+
+  // Counter — incremented on each successful use (checked against maxUsesTotal)
+  @Column({ type: DataType.INTEGER, allowNull: false, defaultValue: 0 })
+  declare totalUsed: number;
+
+  // ── Scope flags ───────────────────────────────────────────────────────────────
+  // When true: applies only to products/stores/users in the junction tables
+  // When false: applies globally regardless of junction table contents
+  @Column({ allowNull: false, defaultValue: false })
+  declare isStoreSpecific: boolean;
+
+  @Column({ allowNull: false, defaultValue: false })
+  declare isProductSpecific: boolean;
+
+  @Column({ allowNull: false, defaultValue: false })
+  declare isUserSpecific: boolean;
+
+  @Column({ allowNull: false, defaultValue: true })
+  declare isActive: boolean;
+
+  // ── Associations ──────────────────────────────────────────────────────────────
+
+  @HasMany(() => CouponStore)
+  declare couponStores: CouponStore[];
+
+  @HasMany(() => CouponProduct)
+  declare couponProducts: CouponProduct[];
+
+  @HasMany(() => CouponUser)
+  declare couponUsers: CouponUser[];
+}

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

@@ -58,6 +58,12 @@ import { Cart } from './entities/cart.entity';
 import { CartItem } from './entities/cart-item.entity';
 import { CartItemBundleSelection } from './entities/cart-item-bundle-selection.entity';
 
+// ─── Coupons ───────────────────────────────────────────────────────────────────
+import { Coupon } from './entities/coupon.entity';
+import { CouponStore } from './entities/coupon-store.entity';
+import { CouponProduct } from './entities/coupon-product.entity';
+import { CouponUser } from './entities/coupon-user.entity';
+
 // =============================================================================
 // EXPORTS
 // =============================================================================
@@ -130,6 +136,17 @@ export { Cart, CartStatus } from './entities/cart.entity';
 export { CartItem, CartItemType } from './entities/cart-item.entity';
 export { CartItemBundleSelection } from './entities/cart-item-bundle-selection.entity';
 
+// ─── Coupons ───────────────────────────────────────────────────────────────────
+export {
+  Coupon,
+  CouponDiscountType,
+  CouponAppliesTo,
+  CouponOsTarget,
+} from './entities/coupon.entity';
+export { CouponStore } from './entities/coupon-store.entity';
+export { CouponProduct } from './entities/coupon-product.entity';
+export { CouponUser } from './entities/coupon-user.entity';
+
 // ─── Enums ────────────────────────────────────────────────────────────────────
 export { OsName } from './utils/enums/osName';
 export { ProductApp } from './utils/enums/productApp';
@@ -203,5 +220,11 @@ export function getDbModels(): ModelCtor[] {
     Cart,
     CartItem,
     CartItemBundleSelection,
+
+    //Coupon
+    Coupon,
+    CouponStore,
+    CouponProduct,
+    CouponUser,
   ];
 }

package/package.json

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