@axova/shared 1.0.0

package/src/schemas/customer/customer-schema.ts

@@ -0,0 +1,576 @@
+import { createId } from "@paralleldrive/cuid2";
+import {
+	boolean,
+	decimal,
+	index,
+	integer,
+	jsonb,
+	pgTable,
+	text,
+	timestamp,
+	varchar,
+} from "drizzle-orm/pg-core";
+
+// Customers Table - Core customer information
+export const customers = pgTable(
+	"customers",
+	{
+		id: text("id")
+			.primaryKey()
+			.$defaultFn(() => createId()),
+
+		// Basic Info
+		userId: text("user_id").notNull().unique(), // Links to auth system
+		email: varchar("email", { length: 255 }).notNull().unique(),
+		firstName: varchar("first_name", { length: 100 }).notNull(),
+		lastName: varchar("last_name", { length: 100 }).notNull(),
+		phoneNumber: varchar("phone_number", { length: 20 }),
+		dateOfBirth: timestamp("date_of_birth", { withTimezone: true }),
+
+		// Customer Status
+		status: varchar("status", { length: 20 })
+			.notNull()
+			.default("ACTIVE")
+			.$type<"ACTIVE" | "INACTIVE" | "SUSPENDED" | "BANNED">(),
+
+		customerType: varchar("customer_type", { length: 30 })
+			.notNull()
+			.default("RETAIL")
+			.$type<"RETAIL" | "WHOLESALE" | "VIP" | "BUSINESS">(),
+
+		// Customer Source and Registration
+		registrationSource: varchar("registration_source", { length: 30 })
+			.notNull()
+			.default("ONLINE")
+			.$type<"ONLINE" | "WALK_IN" | "PHONE" | "REFERRAL" | "SOCIAL_MEDIA">(),
+
+		storeLocationId: text("store_location_id"), // For walk-in customers
+
+		// Profile Information
+		gender: varchar("gender", { length: 20 }).$type<
+			"MALE" | "FEMALE" | "OTHER" | "PREFER_NOT_TO_SAY"
+		>(),
+		profilePicture: text("profile_picture"),
+		bio: text("bio"),
+
+		// Preferences
+		preferredLanguage: varchar("preferred_language", { length: 10 })
+			.notNull()
+			.default("en"),
+		preferredCurrency: varchar("preferred_currency", { length: 3 })
+			.notNull()
+			.default("USD"),
+		timezone: varchar("timezone", { length: 50 }).notNull().default("UTC"),
+
+		// Communication Preferences
+		marketingConsent: boolean("marketing_consent").notNull().default(false),
+		emailNotifications: boolean("email_notifications").notNull().default(true),
+		smsNotifications: boolean("sms_notifications").notNull().default(false),
+		pushNotifications: boolean("push_notifications").notNull().default(true),
+
+		// Purchase Metrics
+		totalOrders: integer("total_orders").notNull().default(0),
+		totalSpent: decimal("total_spent", { precision: 12, scale: 2 })
+			.notNull()
+			.default("0.00"),
+		averageOrderValue: decimal("average_order_value", {
+			precision: 12,
+			scale: 2,
+		})
+			.notNull()
+			.default("0.00"),
+
+		// Interaction Metrics
+		totalVisits: integer("total_visits").notNull().default(0),
+		totalInteractions: integer("total_interactions").notNull().default(0),
+
+		// Tracking
+		lastActiveAt: timestamp("last_active_at", { withTimezone: true }),
+		lastOrderAt: timestamp("last_order_at", { withTimezone: true }),
+		firstOrderAt: timestamp("first_order_at", { withTimezone: true }),
+
+		// Timestamps
+		createdAt: timestamp("created_at", { withTimezone: true })
+			.defaultNow()
+			.notNull(),
+		updatedAt: timestamp("updated_at", { withTimezone: true })
+			.defaultNow()
+			.notNull(),
+	},
+	(table) => ({
+		userIdIndex: index("idx_customers_user_id").on(table.userId),
+		emailIndex: index("idx_customers_email").on(table.email),
+		statusIndex: index("idx_customers_status").on(table.status),
+		typeIndex: index("idx_customers_type").on(table.customerType),
+		registrationSourceIndex: index("idx_customers_registration_source").on(
+			table.registrationSource,
+		),
+		storeLocationIndex: index("idx_customers_store_location").on(
+			table.storeLocationId,
+		),
+		lastActiveIndex: index("idx_customers_last_active").on(table.lastActiveAt),
+	}),
+);
+
+// Customer Addresses Table
+export const customerAddresses = pgTable(
+	"customer_addresses",
+	{
+		id: text("id")
+			.primaryKey()
+			.$defaultFn(() => createId()),
+
+		customerId: text("customer_id")
+			.notNull()
+			.references(() => customers.id, { onDelete: "cascade" }),
+
+		// Address Type
+		type: varchar("type", { length: 20 })
+			.notNull()
+			.$type<"BILLING" | "SHIPPING" | "BOTH">(),
+
+		// Address Details
+		label: varchar("label", { length: 50 }), // e.g., "Home", "Work", "Office"
+		firstName: varchar("first_name", { length: 100 }).notNull(),
+		lastName: varchar("last_name", { length: 100 }).notNull(),
+		company: varchar("company", { length: 100 }),
+		addressLine1: text("address_line_1").notNull(),
+		addressLine2: text("address_line_2"),
+		city: varchar("city", { length: 100 }).notNull(),
+		state: varchar("state", { length: 100 }).notNull(),
+		postalCode: varchar("postal_code", { length: 20 }).notNull(),
+		country: varchar("country", { length: 2 }).notNull(), // ISO country code
+		phoneNumber: varchar("phone_number", { length: 20 }),
+
+		// Status
+		isDefault: boolean("is_default").notNull().default(false),
+		isActive: boolean("is_active").notNull().default(true),
+
+		// Verification
+		isVerified: boolean("is_verified").notNull().default(false),
+		verifiedAt: timestamp("verified_at", { withTimezone: true }),
+
+		// Timestamps
+		createdAt: timestamp("created_at", { withTimezone: true })
+			.defaultNow()
+			.notNull(),
+		updatedAt: timestamp("updated_at", { withTimezone: true })
+			.defaultNow()
+			.notNull(),
+	},
+	(table) => ({
+		customerIdIndex: index("idx_addresses_customer_id").on(table.customerId),
+		typeIndex: index("idx_addresses_type").on(table.type),
+		defaultIndex: index("idx_addresses_default").on(table.isDefault),
+		countryIndex: index("idx_addresses_country").on(table.country),
+	}),
+);
+
+// Customer Support Tickets Table
+export const customerSupportTickets = pgTable(
+	"customer_support_tickets",
+	{
+		id: text("id")
+			.primaryKey()
+			.$defaultFn(() => createId()),
+
+		customerId: text("customer_id")
+			.notNull()
+			.references(() => customers.id, { onDelete: "cascade" }),
+
+		// Ticket Details
+		ticketNumber: varchar("ticket_number", { length: 20 }).notNull().unique(),
+		subject: varchar("subject", { length: 255 }).notNull(),
+		description: text("description").notNull(),
+		category: varchar("category", { length: 50 })
+			.notNull()
+			.$type<
+				| "GENERAL_INQUIRY"
+				| "ORDER_ISSUE"
+				| "BILLING_ISSUE"
+				| "TECHNICAL_SUPPORT"
+				| "PRODUCT_QUESTION"
+				| "RETURN_REFUND"
+				| "ACCOUNT_ISSUE"
+				| "COMPLAINT"
+				| "FEATURE_REQUEST"
+			>(),
+
+		// Priority and Status
+		priority: varchar("priority", { length: 20 })
+			.notNull()
+			.default("MEDIUM")
+			.$type<"LOW" | "MEDIUM" | "HIGH" | "URGENT" | "CRITICAL">(),
+
+		status: varchar("status", { length: 20 })
+			.notNull()
+			.default("OPEN")
+			.$type<
+				"OPEN" | "IN_PROGRESS" | "PENDING_CUSTOMER" | "RESOLVED" | "CLOSED"
+			>(),
+
+		// Assignment
+		assignedTo: text("assigned_to"), // Admin/Support user ID
+		assignedAt: timestamp("assigned_at", { withTimezone: true }),
+
+		// Resolution
+		resolution: text("resolution"),
+		resolvedAt: timestamp("resolved_at", { withTimezone: true }),
+		closedAt: timestamp("closed_at", { withTimezone: true }),
+
+		// Customer Satisfaction
+		satisfactionRating: integer("satisfaction_rating"), // 1-5
+		satisfactionFeedback: text("satisfaction_feedback"),
+
+		// Metadata
+		tags: jsonb("tags").$type<string[]>().default([]),
+		metadata: jsonb("metadata").$type<Record<string, unknown>>().default({}),
+
+		// Timestamps
+		createdAt: timestamp("created_at", { withTimezone: true })
+			.defaultNow()
+			.notNull(),
+		updatedAt: timestamp("updated_at", { withTimezone: true })
+			.defaultNow()
+			.notNull(),
+	},
+	(table) => ({
+		customerIdIndex: index("idx_tickets_customer_id").on(table.customerId),
+		ticketNumberIndex: index("idx_tickets_number").on(table.ticketNumber),
+		statusIndex: index("idx_tickets_status").on(table.status),
+		priorityIndex: index("idx_tickets_priority").on(table.priority),
+		categoryIndex: index("idx_tickets_category").on(table.category),
+		assignedIndex: index("idx_tickets_assigned").on(table.assignedTo),
+		createdAtIndex: index("idx_tickets_created_at").on(table.createdAt),
+	}),
+);
+
+// Customer Reviews Table
+export const customerReviews = pgTable(
+	"customer_reviews",
+	{
+		id: text("id")
+			.primaryKey()
+			.$defaultFn(() => createId()),
+
+		customerId: text("customer_id")
+			.notNull()
+			.references(() => customers.id, { onDelete: "cascade" }),
+
+		// Review Target
+		targetType: varchar("target_type", { length: 30 })
+			.notNull()
+			.$type<"PRODUCT" | "STORE" | "ORDER" | "SERVICE">(),
+		targetId: text("target_id").notNull(),
+
+		// Review Content
+		rating: integer("rating").notNull(), // 1-5
+		title: varchar("title", { length: 255 }),
+		reviewText: text("review_text"),
+		images: jsonb("images").$type<string[]>().default([]),
+
+		// Review Status
+		status: varchar("status", { length: 20 })
+			.notNull()
+			.default("PENDING")
+			.$type<"PENDING" | "APPROVED" | "REJECTED" | "FLAGGED">(),
+
+		isVerifiedPurchase: boolean("is_verified_purchase")
+			.notNull()
+			.default(false),
+
+		// Moderation
+		moderatedBy: text("moderated_by"),
+		moderatedAt: timestamp("moderated_at", { withTimezone: true }),
+		moderationNotes: text("moderation_notes"),
+
+		// Helpfulness
+		helpfulVotes: integer("helpful_votes").notNull().default(0),
+		unhelpfulVotes: integer("unhelpful_votes").notNull().default(0),
+
+		// Timestamps
+		createdAt: timestamp("created_at", { withTimezone: true })
+			.defaultNow()
+			.notNull(),
+		updatedAt: timestamp("updated_at", { withTimezone: true })
+			.defaultNow()
+			.notNull(),
+	},
+	(table) => ({
+		customerIdIndex: index("idx_reviews_customer_id").on(table.customerId),
+		targetIndex: index("idx_reviews_target").on(
+			table.targetType,
+			table.targetId,
+		),
+		ratingIndex: index("idx_reviews_rating").on(table.rating),
+		statusIndex: index("idx_reviews_status").on(table.status),
+		verifiedIndex: index("idx_reviews_verified").on(table.isVerifiedPurchase),
+		createdAtIndex: index("idx_reviews_created_at").on(table.createdAt),
+	}),
+);
+
+// Customer Visit History Table
+export const customerVisitHistory = pgTable(
+	"customer_visit_history",
+	{
+		id: text("id")
+			.primaryKey()
+			.$defaultFn(() => createId()),
+
+		customerId: text("customer_id")
+			.notNull()
+			.references(() => customers.id, { onDelete: "cascade" }),
+
+		// Visit Details
+		visitType: varchar("visit_type", { length: 30 })
+			.notNull()
+			.$type<
+				| "WEBSITE"
+				| "STORE_VISIT"
+				| "PHONE_CALL"
+				| "EMAIL"
+				| "CHAT"
+				| "SOCIAL_MEDIA"
+			>(),
+
+		storeLocationId: text("store_location_id"), // For physical visits
+		sessionId: text("session_id"), // For online visits
+
+		// Visit Data
+		duration: integer("duration"), // in minutes
+		pagesViewed: integer("pages_viewed"), // for online visits
+		productsViewed: jsonb("products_viewed").$type<string[]>().default([]),
+
+		// Interaction Details
+		interactionCount: integer("interaction_count").notNull().default(0),
+		hasInteraction: boolean("has_interaction").notNull().default(false),
+
+		// Visit Outcome
+		outcome: varchar("outcome", { length: 30 }).$type<
+			"BROWSING" | "INQUIRY" | "PURCHASE" | "SUPPORT" | "COMPLAINT" | "RETURN"
+		>(),
+
+		// Notes and Context
+		notes: text("notes"),
+		metadata: jsonb("metadata").$type<Record<string, unknown>>().default({}),
+
+		// Timestamps
+		visitStartAt: timestamp("visit_start_at", { withTimezone: true }).notNull(),
+		visitEndAt: timestamp("visit_end_at", { withTimezone: true }),
+		createdAt: timestamp("created_at", { withTimezone: true })
+			.defaultNow()
+			.notNull(),
+	},
+	(table) => ({
+		customerIdIndex: index("idx_visits_customer_id").on(table.customerId),
+		visitTypeIndex: index("idx_visits_type").on(table.visitType),
+		storeLocationIndex: index("idx_visits_store_location").on(
+			table.storeLocationId,
+		),
+		visitDateIndex: index("idx_visits_date").on(table.visitStartAt),
+		outcomeIndex: index("idx_visits_outcome").on(table.outcome),
+	}),
+);
+
+// Customer Interaction History Table
+export const customerInteractionHistory = pgTable(
+	"customer_interaction_history",
+	{
+		id: text("id")
+			.primaryKey()
+			.$defaultFn(() => createId()),
+
+		customerId: text("customer_id")
+			.notNull()
+			.references(() => customers.id, { onDelete: "cascade" }),
+
+		visitId: text("visit_id").references(() => customerVisitHistory.id, {
+			onDelete: "cascade",
+		}),
+
+		// Interaction Details
+		interactionType: varchar("interaction_type", { length: 30 })
+			.notNull()
+			.$type<
+				| "PRODUCT_VIEW"
+				| "PRODUCT_INQUIRY"
+				| "ADD_TO_CART"
+				| "WISHLIST_ADD"
+				| "SEARCH"
+				| "FILTER_USE"
+				| "SUPPORT_REQUEST"
+				| "COMPLAINT"
+				| "FEEDBACK"
+				| "NEWSLETTER_SIGNUP"
+			>(),
+
+		// Target Information
+		targetType: varchar("target_type", { length: 30 }).$type<
+			"PRODUCT" | "CATEGORY" | "BRAND" | "PAGE" | "FEATURE" | "SUPPORT"
+		>(),
+		targetId: text("target_id"),
+
+		// Interaction Data
+		interactionData: jsonb("interaction_data")
+			.$type<Record<string, unknown>>()
+			.default({}),
+
+		// Staff/Agent Information (for in-store or assisted interactions)
+		staffId: text("staff_id"),
+		staffName: varchar("staff_name", { length: 100 }),
+
+		// Context
+		description: text("description"),
+		outcome: varchar("outcome", { length: 30 }).$type<
+			"POSITIVE" | "NEUTRAL" | "NEGATIVE" | "UNRESOLVED" | "COMPLETED"
+		>(),
+
+		// Timestamps
+		createdAt: timestamp("created_at", { withTimezone: true })
+			.defaultNow()
+			.notNull(),
+	},
+	(table) => ({
+		customerIdIndex: index("idx_interactions_customer_id").on(table.customerId),
+		visitIdIndex: index("idx_interactions_visit_id").on(table.visitId),
+		interactionTypeIndex: index("idx_interactions_type").on(
+			table.interactionType,
+		),
+		targetIndex: index("idx_interactions_target").on(
+			table.targetType,
+			table.targetId,
+		),
+		staffIndex: index("idx_interactions_staff").on(table.staffId),
+		createdAtIndex: index("idx_interactions_created_at").on(table.createdAt),
+	}),
+);
+
+// Customer Notes Table
+export const customerNotes = pgTable(
+	"customer_notes",
+	{
+		id: text("id")
+			.primaryKey()
+			.$defaultFn(() => createId()),
+
+		customerId: text("customer_id")
+			.notNull()
+			.references(() => customers.id, { onDelete: "cascade" }),
+
+		// Note Details
+		noteType: varchar("note_type", { length: 30 })
+			.notNull()
+			.$type<
+				| "GENERAL"
+				| "PREFERENCE"
+				| "COMPLAINT"
+				| "COMPLIMENT"
+				| "SPECIAL_REQUEST"
+				| "VIP_NOTE"
+				| "ALERT"
+				| "FOLLOW_UP"
+			>(),
+
+		title: varchar("title", { length: 255 }),
+		content: text("content").notNull(),
+
+		// Priority and Visibility
+		priority: varchar("priority", { length: 20 })
+			.notNull()
+			.default("NORMAL")
+			.$type<"LOW" | "NORMAL" | "HIGH" | "URGENT">(),
+
+		isVisible: boolean("is_visible").notNull().default(true),
+		isAlert: boolean("is_alert").notNull().default(false),
+
+		// Staff Information
+		createdBy: text("created_by").notNull(), // Staff/user ID
+		createdByName: varchar("created_by_name", { length: 100 }).notNull(),
+
+		// Context
+		relatedOrderId: text("related_order_id"),
+		relatedTicketId: text("related_ticket_id"),
+
+		// Follow-up
+		followUpRequired: boolean("follow_up_required").notNull().default(false),
+		followUpDate: timestamp("follow_up_date", { withTimezone: true }),
+		followUpCompleted: boolean("follow_up_completed").notNull().default(false),
+
+		// Timestamps
+		createdAt: timestamp("created_at", { withTimezone: true })
+			.defaultNow()
+			.notNull(),
+		updatedAt: timestamp("updated_at", { withTimezone: true })
+			.defaultNow()
+			.notNull(),
+	},
+	(table) => ({
+		customerIdIndex: index("idx_notes_customer_id").on(table.customerId),
+		noteTypeIndex: index("idx_notes_type").on(table.noteType),
+		priorityIndex: index("idx_notes_priority").on(table.priority),
+		alertIndex: index("idx_notes_alert").on(table.isAlert),
+		followUpIndex: index("idx_notes_follow_up").on(
+			table.followUpRequired,
+			table.followUpDate,
+		),
+		createdByIndex: index("idx_notes_created_by").on(table.createdBy),
+	}),
+);
+
+// Customer Preferences Table
+export const customerPreferences = pgTable(
+	"customer_preferences",
+	{
+		id: text("id")
+			.primaryKey()
+			.$defaultFn(() => createId()),
+
+		customerId: text("customer_id")
+			.notNull()
+			.references(() => customers.id, { onDelete: "cascade" })
+			.unique(),
+
+		// Shopping Preferences
+		preferredCategories: jsonb("preferred_categories")
+			.$type<string[]>()
+			.default([]),
+		preferredBrands: jsonb("preferred_brands").$type<string[]>().default([]),
+		priceRange: jsonb("price_range")
+			.$type<{ min?: number; max?: number }>()
+			.default({}),
+
+		// Notification Preferences
+		emailMarketing: boolean("email_marketing").notNull().default(false),
+		smsMarketing: boolean("sms_marketing").notNull().default(false),
+		pushMarketing: boolean("push_marketing").notNull().default(false),
+		orderUpdates: boolean("order_updates").notNull().default(true),
+		productRecommendations: boolean("product_recommendations")
+			.notNull()
+			.default(true),
+		priceDropAlerts: boolean("price_drop_alerts").notNull().default(false),
+		backInStockAlerts: boolean("back_in_stock_alerts").notNull().default(false),
+
+		// Privacy Preferences
+		dataSharing: boolean("data_sharing").notNull().default(false),
+		analyticsTracking: boolean("analytics_tracking").notNull().default(true),
+		personalizedExperience: boolean("personalized_experience")
+			.notNull()
+			.default(true),
+
+		// Custom Preferences
+		customPreferences: jsonb("custom_preferences")
+			.$type<Record<string, unknown>>()
+			.default({}),
+
+		// Timestamps
+		createdAt: timestamp("created_at", { withTimezone: true })
+			.defaultNow()
+			.notNull(),
+		updatedAt: timestamp("updated_at", { withTimezone: true })
+			.defaultNow()
+			.notNull(),
+	},
+	(table) => ({
+		customerIdIndex: index("idx_preferences_customer_id").on(table.customerId),
+	}),
+);