tt-entities 0.0.14 → 0.0.16

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

@@ -0,0 +1,68 @@
+import {
+  Table,
+  Column,
+  Model,
+  ForeignKey,
+  BelongsTo,
+  HasMany,
+  BelongsToMany,
+  DataType,
+} from 'sequelize-typescript';
+import { Country } from './country.entity';
+import { ProductStore } from './product-store.entity';
+import { Product } from './product.entity';
+import { StoreInventory } from './store-inventory.entity';
+import { Inventory } from './inventory.entity';
+import { Status } from '../utils/enums/status';
+
+@Table
+export class Store extends Model {
+  @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({ allowNull: true })
+  declare logo?: string;
+
+  // ISO currency code e.g. KWD, SAR, QAR, USD
+  @Column({ allowNull: false, defaultValue: 'USD' })
+  declare currency: string;
+
+  @Column({ allowNull: true })
+  declare currencySymbolEn?: string;
+
+  @Column({ allowNull: true })
+  declare currencySymbolAr?: string;
+
+  @ForeignKey(() => Country)
+  @Column({ allowNull: true })
+  declare countryId?: number;
+
+  @Column({ defaultValue: false })
+  declare isGlobal: boolean;
+
+  @Column({
+    type: DataType.ENUM(...Object.values(Status)),
+    defaultValue: Status.ACTIVE,
+  })
+  declare status: Status;
+
+  // ─── Associations ─────────────────────────────────────────────────────────────
+
+  @BelongsTo(() => Country)
+  declare country: Country;
+
+  @BelongsToMany(() => Product, () => ProductStore)
+  declare products: Product[];
+
+  @BelongsToMany(() => Inventory, () => StoreInventory)
+  declare inventories: Inventory[];
+}

package/libs/tatayab-entities-library/src/entities/variant-option.entity.ts

@@ -0,0 +1,35 @@
+import {
+  Table,
+  Column,
+  Model,
+  ForeignKey,
+  BelongsTo,
+  DataType,
+} from 'sequelize-typescript';
+import { VariantType } from './variant-type.entity';
+import { Status } from '../utils/enums/status';
+
+@Table
+export class VariantOption extends Model {
+  @ForeignKey(() => VariantType)
+  @Column({ allowNull: false })
+  declare variantTypeId: number;
+
+  @Column({ allowNull: false })
+  declare nameEn: string;
+
+  @Column({ allowNull: false })
+  declare nameAr: string;
+
+  @Column({ defaultValue: 0 })
+  declare sortOrder: number;
+
+  @Column({
+    type: DataType.ENUM(...Object.values(Status)),
+    defaultValue: Status.ACTIVE,
+  })
+  declare status: Status;
+
+  @BelongsTo(() => VariantType)
+  declare variantType: VariantType;
+}

package/libs/tatayab-entities-library/src/entities/variant-type.entity.ts

@@ -0,0 +1,18 @@
+import { Table, Column, Model, HasMany } from 'sequelize-typescript';
+import { Status } from '../utils/enums/status';
+import { DataType } from 'sequelize-typescript';
+
+@Table
+export class VariantType extends Model {
+  @Column({ allowNull: false })
+  declare nameEn: string;
+
+  @Column({ allowNull: false })
+  declare nameAr: string;
+
+  @Column({
+    type: DataType.ENUM(...Object.values(Status)),
+    defaultValue: Status.ACTIVE,
+  })
+  declare status: Status;
+}

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

@@ -0,0 +1,65 @@
+import {
+  Table,
+  Column,
+  Model,
+  ForeignKey,
+  BelongsTo,
+  DataType,
+} from 'sequelize-typescript';
+import { Vendor } from './vendor.entity';
+import { Product } from './product.entity';
+import { ProductVariant } from './product-variant.entity';
+import { Status } from '../utils/enums/status';
+
+@Table
+export class VendorProduct extends Model {
+  @ForeignKey(() => Vendor)
+  @Column({ allowNull: false })
+  declare vendorId: number;
+
+  @ForeignKey(() => Product)
+  @Column({ allowNull: false })
+  declare productId: number;
+
+  // null = applies to product with no variants
+  @ForeignKey(() => ProductVariant)
+  @Column({ allowNull: true })
+  declare productVariantId?: number;
+
+  // Vendor's cost price to us
+  @Column({ type: DataType.DECIMAL(10, 3), allowNull: false })
+  declare costPrice: number;
+
+  // Vendor's SKU/reference code for this product
+  @Column({ allowNull: true })
+  declare vendorSku?: string;
+
+  // Typical lead time in days from this vendor
+  @Column({ allowNull: true })
+  declare leadTimeDays?: number;
+
+  // Minimum order quantity
+  @Column({ defaultValue: 1 })
+  declare moq: number;
+
+  // Is this the preferred/default vendor for this product?
+  @Column({ defaultValue: false })
+  declare isPreferred: boolean;
+
+  @Column({
+    type: DataType.ENUM(...Object.values(Status)),
+    defaultValue: Status.ACTIVE,
+  })
+  declare status: Status;
+
+  // ─── Associations ─────────────────────────────────────────────────────────────
+
+  @BelongsTo(() => Vendor)
+  declare vendor: Vendor;
+
+  @BelongsTo(() => Product)
+  declare product: Product;
+
+  @BelongsTo(() => ProductVariant)
+  declare variant?: ProductVariant;
+}

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

@@ -0,0 +1,63 @@
+import {
+  Table,
+  Column,
+  Model,
+  ForeignKey,
+  BelongsTo,
+  HasMany,
+  DataType,
+} from 'sequelize-typescript';
+import { Country } from './country.entity';
+import { Status } from '../utils/enums/status';
+
+@Table
+export class Vendor extends Model {
+  @Column({ allowNull: false })
+  declare nameEn: string;
+
+  @Column({ allowNull: false })
+  declare nameAr: string;
+
+  @Column({ allowNull: true })
+  declare contactPerson?: string;
+
+  @Column({ allowNull: true })
+  declare email?: string;
+
+  @Column({ allowNull: true })
+  declare phone?: string;
+
+  @Column({ type: DataType.TEXT, allowNull: true })
+  declare addressEn?: string;
+
+  @Column({ type: DataType.TEXT, allowNull: true })
+  declare addressAr?: string;
+
+  @ForeignKey(() => Country)
+  @Column({ allowNull: true })
+  declare countryId?: number;
+
+  @Column({ allowNull: true })
+  declare taxNumber?: string;
+
+  @Column({ allowNull: true })
+  declare commercialRegNumber?: string;
+
+  // Default payment terms in days (e.g. 30 = NET30)
+  @Column({ defaultValue: 0 })
+  declare paymentTermsDays: number;
+
+  @Column({ allowNull: true })
+  declare notes?: string;
+
+  @Column({
+    type: DataType.ENUM(...Object.values(Status)),
+    defaultValue: Status.ACTIVE,
+  })
+  declare status: Status;
+
+  // ─── Associations ─────────────────────────────────────────────────────────────
+
+  @BelongsTo(() => Country)
+  declare country: Country;
+}

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

@@ -1,5 +1,6 @@
 import { ModelCtor } from 'sequelize-typescript';
 
+// ─── Existing ─────────────────────────────────────────────────────────────────
 import { Country } from './entities/country.entity';
 import { Translation } from './entities/translation.entity';
 import { Area } from './entities/area.entity';
@@ -9,7 +10,37 @@ import { User } from './entities/user.entity';
 import { UserDevice } from './entities/userDevice.entity';
 import { ApiKey } from './entities/apikey.entity';
 
-// Entities Export
+// ─── Catalogue ────────────────────────────────────────────────────────────────
+import { Category } from './entities/category.entity';
+import { Brand } from './entities/brand.entity';
+import { VariantType } from './entities/variant-type.entity';
+import { VariantOption } from './entities/variant-option.entity';
+import { Product } from './entities/product.entity';
+import { ProductMedia } from './entities/product-media.entity';
+import { ProductVariant } from './entities/product-variant.entity';
+import { ProductVariantOption } from './entities/product-variant-option.entity';
+
+// ─── Stores ───────────────────────────────────────────────────────────────────
+import { Store } from './entities/store.entity';
+import { ProductStore } from './entities/product-store.entity';
+
+// ─── Inventory ────────────────────────────────────────────────────────────────
+import { Inventory } from './entities/inventory.entity';
+import { StoreInventory } from './entities/store-inventory.entity';
+import { InventoryStock } from './entities/inventory-stock.entity';
+import { StockMovement } from './entities/stock-movement.entity';
+
+// ─── Purchasing ───────────────────────────────────────────────────────────────
+import { Vendor } from './entities/vendor.entity';
+import { VendorProduct } from './entities/vendor-product.entity';
+import { PurchaseOrder } from './entities/purchase-order.entity';
+import { PurchaseOrderItem } from './entities/purchase-order-item.entity';
+
+// =============================================================================
+// EXPORTS
+// =============================================================================
+
+// ─── Existing ─────────────────────────────────────────────────────────────────
 export { ApiKey } from './entities/apikey.entity';
 export { Country } from './entities/country.entity';
 export { Translation } from './entities/translation.entity';
@@ -19,16 +50,52 @@ export { SysUser } from './entities/sys.user.entity';
 export { User } from './entities/user.entity';
 export { UserDevice } from './entities/userDevice.entity';
 
-// Other Utils Classes
+// ─── Catalogue ────────────────────────────────────────────────────────────────
+export { Category } from './entities/category.entity';
+export { Brand } from './entities/brand.entity';
+export { VariantType } from './entities/variant-type.entity';
+export { VariantOption } from './entities/variant-option.entity';
+export { Product } from './entities/product.entity';
+export { ProductMedia, MediaType } from './entities/product-media.entity';
+export { ProductVariant } from './entities/product-variant.entity';
+export { ProductVariantOption } from './entities/product-variant-option.entity';
+
+// ─── Stores ───────────────────────────────────────────────────────────────────
+export { Store } from './entities/store.entity';
+export { ProductStore } from './entities/product-store.entity';
+
+// ─── Inventory ────────────────────────────────────────────────────────────────
+export { Inventory } from './entities/inventory.entity';
+export { StoreInventory } from './entities/store-inventory.entity';
+export { InventoryStock } from './entities/inventory-stock.entity';
+export { StockMovement } from './entities/stock-movement.entity';
+
+// ─── Purchasing ───────────────────────────────────────────────────────────────
+export { Vendor } from './entities/vendor.entity';
+export { VendorProduct } from './entities/vendor-product.entity';
+export { PurchaseOrder } from './entities/purchase-order.entity';
+export {
+  PurchaseOrderItem,
+  PurchaseOrderItemStatus,
+} from './entities/purchase-order-item.entity';
+
+// ─── Enums ────────────────────────────────────────────────────────────────────
 export { OsName } from './utils/enums/osName';
 export { ProductApp } from './utils/enums/productApp';
 export { VersionType } from './utils/enums/versiontype';
 export { Language } from './utils/enums/language';
 export { Status } from './utils/enums/status';
 export { Gender } from './utils/enums/gender';
+export { PurchaseOrderStatus } from './utils/enums/purchaseOrderStatus';
+export { StockMovementType } from './utils/enums/stockMovementType';
+
+// =============================================================================
+// MODEL REGISTRY
+// =============================================================================
 
 export function getDbModels(): ModelCtor[] {
   return [
+    // Existing
     ApiKey,
     Area,
     Country,
@@ -37,5 +104,31 @@ export function getDbModels(): ModelCtor[] {
     Translation,
     User,
     UserDevice,
+
+    // Catalogue
+    Category,
+    Brand,
+    VariantType,
+    VariantOption,
+    Product,
+    ProductMedia,
+    ProductVariant,
+    ProductVariantOption,
+
+    // Stores
+    Store,
+    ProductStore,
+
+    // Inventory
+    Inventory,
+    StoreInventory,
+    InventoryStock,
+    StockMovement,
+
+    // Purchasing
+    Vendor,
+    VendorProduct,
+    PurchaseOrder,
+    PurchaseOrderItem,
   ];
 }

package/libs/tatayab-entities-library/src/utils/enums/purchaseOrderStatus.ts

@@ -0,0 +1,8 @@
+export enum PurchaseOrderStatus {
+  DRAFT = 'draft',
+  SENT_TO_VENDOR = 'sent_to_vendor',
+  PARTIALLY_RECEIVED = 'partially_received',
+  FULLY_RECEIVED = 'fully_received',
+  CLOSED = 'closed',
+  CANCELLED = 'cancelled',
+}

package/libs/tatayab-entities-library/src/utils/enums/stockMovementType.ts

@@ -0,0 +1,20 @@
+export enum StockMovementType {
+  // Stock coming in
+  RECEIVED = 'received',           // PO received into inventory
+
+  // Stock going out or being held
+  RESERVED = 'reserved',           // Reserved for a pending order
+  RESERVATION_RELEASED = 'reservation_released', // Order cancelled, stock freed
+
+  // Manual adjustments
+  ADJUSTMENT_ADD = 'adjustment_add',       // Manual stock increase
+  ADJUSTMENT_REMOVE = 'adjustment_remove', // Manual stock decrease (damage, loss)
+
+  // Returns
+  RETURNED_FROM_CUSTOMER = 'returned_from_customer',
+  RETURNED_TO_VENDOR = 'returned_to_vendor',
+
+  // Transfers
+  TRANSFER_IN = 'transfer_in',   // Moved in from another inventory
+  TRANSFER_OUT = 'transfer_out', // Moved out to another inventory
+}

package/package.json

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