tt-entities 0.0.26 → 0.0.28

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

@@ -1,4 +1,6 @@
-import { Column, Model, Table } from 'sequelize-typescript';
+import { BelongsToMany, Column, Model, Table } from 'sequelize-typescript';
+import { PaymentMethod } from '@app/tatayab-entities-library/entities/payment-method.entity';
+import { PaymentMethodCountry } from '@app/tatayab-entities-library/entities/payment-method-country.entity';
 
 @Table
 export class Country extends Model {
@@ -22,4 +24,9 @@ export class Country extends Model {
 
   @Column
   declare exchangeRateToKwd: number;
+
+  // ─── Associations ─────────────────────────────────────────────────────────────
+
+  @BelongsToMany(() => PaymentMethod, () => PaymentMethodCountry)
+  declare paymentMethods: PaymentMethod[];
 }

package/libs/tatayab-entities-library/src/entities/payment-gateway.entity.ts

@@ -0,0 +1,56 @@
+import {
+  Table, Column, Model, HasMany, DataType,
+} from 'sequelize-typescript';
+import { PaymentMethod } from './payment-method.entity';
+
+export enum PaymentGatewayType {
+  BNPL        = 'bnpl',        // Buy Now Pay Later — Tabby, Tamara, Taly, Deema
+  CARD        = 'card',        // Visa/Mastercard — uPayment
+  KNET        = 'knet',        // K-Net — KFH
+  WALLET      = 'wallet',      // Apple Pay, Google Pay
+  BANK        = 'bank',        // Bank transfer
+}
+
+@Table
+export class PaymentGateway extends Model {
+  @Column({ allowNull: false, unique: true })
+  declare slug: string; // e.g. 'tabby', 'tamara', 'upayment', 'kfh'
+
+  @Column({ allowNull: false })
+  declare nameEn: string;
+
+  @Column({ allowNull: false })
+  declare nameAr: string;
+
+  @Column({
+    type: DataType.ENUM(...Object.values(PaymentGatewayType)),
+    allowNull: false,
+  })
+  declare type: PaymentGatewayType;
+
+  @Column({ allowNull: true })
+  declare logo?: string;
+
+  @Column({ allowNull: true })
+  declare website?: string;
+
+  // Credentials stored as JSON — managed by admin only, never exposed to users
+  // e.g. { "publicKey": "...", "secretKey": "...", "merchantId": "..." }
+  @Column({ type: DataType.JSON, allowNull: true })
+  declare credentials?: object;
+
+  // Sandbox/Production mode
+  @Column({ allowNull: false, defaultValue: false })
+  declare isSandbox: boolean;
+
+  @Column({ defaultValue: 0 })
+  declare sortOrder: number;
+
+  @Column({ allowNull: false, defaultValue: true })
+  declare isActive: boolean;
+
+  // ─── Associations ─────────────────────────────────────────────────────────────
+
+  @HasMany(() => PaymentMethod)
+  declare methods: PaymentMethod[];
+}

package/libs/tatayab-entities-library/src/entities/payment-method-country.entity.ts

@@ -0,0 +1,16 @@
+import {
+  Table, Column, Model, ForeignKey,
+} from 'sequelize-typescript';
+import { PaymentMethod } from './payment-method.entity';
+import { Country } from './country.entity';
+
+@Table
+export class PaymentMethodCountry extends Model {
+  @ForeignKey(() => PaymentMethod)
+  @Column({ allowNull: false })
+  declare paymentMethodId: number;
+
+  @ForeignKey(() => Country)
+  @Column({ allowNull: false })
+  declare countryId: number;
+}

package/libs/tatayab-entities-library/src/entities/payment-method.entity.ts

@@ -0,0 +1,84 @@
+import {
+  Table, Column, Model, ForeignKey, BelongsTo,
+  BelongsToMany, HasMany, DataType,
+} from 'sequelize-typescript';
+import { PaymentGateway } from './payment-gateway.entity';
+import { Country } from './country.entity';
+import { Store } from './store.entity';
+import { PaymentMethodCountry } from './payment-method-country.entity';
+import { StorePaymentMethod } from './store-payment-method.entity';
+
+export enum PaymentMethodType {
+  PAY_LATER       = 'pay_later',        // Tabby Pay Later, Tamara
+  INSTALLMENT     = 'installment',      // Tabby Installments, Deema
+  CREDIT_CARD     = 'credit_card',      // Visa, Mastercard
+  DEBIT_CARD      = 'debit_card',       // Debit cards
+  KNET            = 'knet',             // K-Net
+  APPLE_PAY       = 'apple_pay',
+  GOOGLE_PAY      = 'google_pay',
+  BANK_TRANSFER   = 'bank_transfer',
+}
+
+@Table
+export class PaymentMethod extends Model {
+  @ForeignKey(() => PaymentGateway)
+  @Column({ allowNull: false })
+  declare paymentGatewayId: number;
+
+  @Column({ allowNull: false, unique: true })
+  declare slug: string; // e.g. 'tabby_pay_later', 'knet', 'visa'
+
+  @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;
+
+  @Column({
+    type: DataType.ENUM(...Object.values(PaymentMethodType)),
+    allowNull: false,
+  })
+  declare type: PaymentMethodType;
+
+  @Column({ allowNull: true })
+  declare logo?: string;
+
+  // Processing fee percentage e.g. 1.5 means 1.5%
+  @Column({ type: DataType.DECIMAL(5, 2), allowNull: true, defaultValue: 0 })
+  declare feePercentage?: number;
+
+  // Fixed fee e.g. 0.100 KWD
+  @Column({ type: DataType.DECIMAL(10, 3), allowNull: true, defaultValue: 0 })
+  declare feeFixed?: number;
+
+  // Minimum order amount to use this method
+  @Column({ type: DataType.DECIMAL(10, 3), allowNull: true })
+  declare minOrderAmount?: number;
+
+  // Maximum order amount to use this method
+  @Column({ type: DataType.DECIMAL(10, 3), allowNull: true })
+  declare maxOrderAmount?: number;
+
+  @Column({ defaultValue: 0 })
+  declare sortOrder: number;
+
+  @Column({ allowNull: false, defaultValue: true })
+  declare isActive: boolean;
+
+  // ─── Associations ─────────────────────────────────────────────────────────────
+
+  @BelongsTo(() => PaymentGateway)
+  declare gateway: PaymentGateway;
+
+  @BelongsToMany(() => Country, () => PaymentMethodCountry)
+  declare countries: Country[];
+
+  @BelongsToMany(() => Store, () => StorePaymentMethod)
+  declare stores: Store[];
+}

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

@@ -0,0 +1,24 @@
+import {
+  Table, Column, Model, ForeignKey, DataType,
+} from 'sequelize-typescript';
+import { Store } from './store.entity';
+import { PaymentMethod } from './payment-method.entity';
+
+@Table
+export class StorePaymentMethod extends Model {
+  @ForeignKey(() => Store)
+  @Column({ allowNull: false })
+  declare storeId: number;
+
+  @ForeignKey(() => PaymentMethod)
+  @Column({ allowNull: false })
+  declare paymentMethodId: number;
+
+  // Store can override sort order for display
+  @Column({ defaultValue: 0 })
+  declare sortOrder: number;
+
+  // Store can enable/disable independently of global isActive
+  @Column({ allowNull: false, defaultValue: true })
+  declare isEnabled: boolean;
+}

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

@@ -14,6 +14,8 @@ import { Product } from './product.entity';
 import { StoreInventory } from './store-inventory.entity';
 import { Inventory } from './inventory.entity';
 import { Status } from '../utils/enums/status';
+import { PaymentMethod } from '@app/tatayab-entities-library/entities/payment-method.entity';
+import { StorePaymentMethod } from '@app/tatayab-entities-library/entities/store-payment-method.entity';
 
 @Table
 export class Store extends Model {
@@ -65,4 +67,7 @@ export class Store extends Model {
 
   @BelongsToMany(() => Inventory, () => StoreInventory)
   declare inventories: Inventory[];
+
+  @BelongsToMany(() => PaymentMethod, () => StorePaymentMethod)
+  declare paymentMethods: PaymentMethod[];
 }

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

@@ -44,6 +44,12 @@ import { PurchaseOrderItem } from './entities/purchase-order-item.entity';
 import { Permission } from './entities/permission.entity';
 import { RolePermission } from './entities/role-permission.entity';
 
+// ─── Payment Methods ──────────────────────────────────────────────────────────
+import { PaymentGateway } from './entities/payment-gateway.entity';
+import { PaymentMethod } from './entities/payment-method.entity';
+import { PaymentMethodCountry } from './entities/payment-method-country.entity';
+import { StorePaymentMethod } from './entities/store-payment-method.entity';
+
 // =============================================================================
 // EXPORTS
 // =============================================================================
@@ -71,7 +77,6 @@ export { ProductVariantOption } from './entities/product-variant-option.entity';
 export { Tag } from './entities/tag.entity';
 export { ProductTag } from './entities/product-tag.entity';
 
-
 // ─── Stores ───────────────────────────────────────────────────────────────────
 export { Store } from './entities/store.entity';
 export { ProductStore } from './entities/product-store.entity';
@@ -97,6 +102,18 @@ export {
 export { Permission } from './entities/permission.entity';
 export { RolePermission } from './entities/role-permission.entity';
 
+// ─── Payment Methods ──────────────────────────────────────────────────────────
+export {
+  PaymentGateway,
+  PaymentGatewayType,
+} from './entities/payment-gateway.entity';
+export {
+  PaymentMethod,
+  PaymentMethodType,
+} from './entities/payment-method.entity';
+export { PaymentMethodCountry } from './entities/payment-method-country.entity';
+export { StorePaymentMethod } from './entities/store-payment-method.entity';
+
 // ─── Enums ────────────────────────────────────────────────────────────────────
 export { OsName } from './utils/enums/osName';
 export { ProductApp } from './utils/enums/productApp';
@@ -145,6 +162,7 @@ export function getDbModels(): ModelCtor[] {
     StoreInventory,
     InventoryStock,
     StockMovement,
+    ShippingRule,
 
     // Purchasing
     Vendor,
@@ -155,5 +173,11 @@ export function getDbModels(): ModelCtor[] {
     // Permissions
     Permission,
     RolePermission,
+
+    // Payment
+    PaymentGateway,
+    PaymentMethod,
+    PaymentMethodCountry,
+    StorePaymentMethod,
   ];
 }

package/package.json

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