tt-entities 0.0.38 → 0.0.40

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

@@ -0,0 +1,121 @@
+import {
+  Model,
+  Table,
+  Column,
+  DataType,
+  ForeignKey,
+  BelongsTo,
+} from 'sequelize-typescript';
+
+// ── Where the banner appears ──────────────────────────────────────────────────
+export enum BannerPlacement {
+  HOME = 'home', // horizontal list on the home page
+  CATEGORY = 'category', // top of a specific category page
+  BRAND = 'brand', // top of a specific brand page
+  SEARCH = 'search', // search results page
+  CUSTOM = 'custom', // any future placement — identified by placementKey
+}
+
+export enum BannerStatus {
+  ACTIVE = 'active',
+  INACTIVE = 'inactive',
+  DRAFT = 'draft',
+}
+
+// ── Filter shape stored in the JSON column ────────────────────────────────────
+// All fields are optional — any combination is valid.
+// An empty object {} means "show everything" (no filter).
+export interface BannerFilters {
+  categoryIds?: number[]; // products/bundles in these categories
+  brandIds?: number[]; // products belonging to these brands
+  tagSlugs?: string[]; // products tagged with any of these slugs
+  types?: ('product' | 'bundle')[]; // limit to only products or only bundles
+  isFeatured?: boolean; // only featured items
+  minPrice?: number;
+  maxPrice?: number;
+  // Future: collectionId, promotionId, etc.
+}
+
+@Table
+export class Banner extends Model {
+  // ── Identity ────────────────────────────────────────────────────────────────
+  @Column({ allowNull: false })
+  declare titleEn: string;
+
+  @Column({ allowNull: false })
+  declare titleAr: string;
+
+  @Column({ type: DataType.TEXT, allowNull: true })
+  declare subtitleEn: string | null;
+
+  @Column({ type: DataType.TEXT, allowNull: true })
+  declare subtitleAr: string | null;
+
+  // ── Media ───────────────────────────────────────────────────────────────────
+  @Column({ allowNull: false })
+  declare coverImage: string; // S3 URL
+
+  @Column({ allowNull: true })
+  declare coverImageMobile: string | null; // optional separate mobile crop
+
+  // ── Placement ───────────────────────────────────────────────────────────────
+  // WHERE this banner appears
+  @Column({
+    type: DataType.ENUM(...Object.values(BannerPlacement)),
+    allowNull: false,
+    defaultValue: BannerPlacement.HOME,
+  })
+  declare placement: BannerPlacement;
+
+  // For placement=category → placementRefId = categoryId
+  // For placement=brand    → placementRefId = brandId
+  // For placement=home/search/custom → null
+  @Column({ allowNull: true })
+  declare placementRefId?: number;
+
+  // Human-readable key for custom placements (e.g. "ramadan_sale", "checkout_top")
+  @Column({ allowNull: true })
+  declare placementKey?: string;
+
+  // ── Catalog filters (what products/bundles appear INSIDE the banner) ─────────
+  // Stored as JSON — resolved at runtime via CatalogListService
+  @Column({
+    type: DataType.JSON,
+    allowNull: false,
+    defaultValue: {},
+  })
+  declare filters: BannerFilters;
+
+  // Max number of items to return inside the banner (null = use API default)
+  @Column({ allowNull: true })
+  declare itemLimit?: number;
+
+  // ── CTA (optional tap action on the banner cover itself) ─────────────────────
+  @Column({ allowNull: true })
+  declare ctaLabelEn?: string;
+
+  @Column({ allowNull: true })
+  declare ctaLabelAr?: string;
+
+  // Deep link or web URL the cover image taps to
+  @Column({ allowNull: true })
+  declare ctaUrl?: string;
+
+  // ── Scheduling ───────────────────────────────────────────────────────────────
+  @Column({ type: DataType.DATE, allowNull: true })
+  declare startDate?: Date; // null = show immediately
+
+  @Column({ type: DataType.DATE, allowNull: true })
+  declare endDate?: Date; // null = show indefinitely
+
+  // ── Display ─────────────────────────────────────────────────────────────────
+  @Column({ defaultValue: 0 })
+  declare sortOrder: number;
+
+  @Column({
+    type: DataType.ENUM(...Object.values(BannerStatus)),
+    allowNull: false,
+    defaultValue: BannerStatus.DRAFT,
+  })
+  declare status: BannerStatus;
+}

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

@@ -10,6 +10,8 @@ export enum FavoriteCatalogItemType {
 }
 
 @Table({
+  paranoid: false, // hard delete only — soft delete breaks the unique constraint on re-add
+  timestamps: true, // keeps createdAt / updatedAt, no deletedAt column
   indexes: [
     {
       // Prevent duplicate favorites for the same item

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

@@ -11,6 +11,7 @@ import { ApiKey } from './entities/apikey.entity';
 import { UserAddress } from './entities/user-address.entity';
 import { UserFavorite } from './entities/user-favorite.entity';
 import { UserFavoriteCatalog } from './entities/user-favorite-catalog.entity';
+import { Banner } from './entities/banner.entity';
 
 // ─── Catalogue ────────────────────────────────────────────────────────────────
 import { Category } from './entities/category.entity';
@@ -92,6 +93,12 @@ export {
   UserFavoriteCatalog,
   FavoriteCatalogItemType,
 } from './entities/user-favorite-catalog.entity';
+export {
+  Banner,
+  BannerPlacement,
+  BannerStatus,
+  BannerFilters,
+} from './entities/banner.entity';
 
 // ─── Catalogue ────────────────────────────────────────────────────────────────
 export { Category } from './entities/category.entity';
@@ -267,5 +274,8 @@ export function getDbModels(): ModelCtor[] {
     OrderStatusHistory,
     UserTransaction,
     PurchaseOrderOrderItem,
+
+    // Banners
+    Banner,
   ];
 }

package/package.json

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