@axova/shared 1.0.2 → 1.1.0

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

@@ -0,0 +1,682 @@
+import { createId } from "@paralleldrive/cuid2";
+import { relations } from "drizzle-orm";
+import {
+	boolean,
+	index,
+	integer,
+	jsonb,
+	pgTable,
+	text,
+	timestamp,
+	unique,
+	varchar,
+	numeric,
+} from "drizzle-orm/pg-core";
+
+// Core Store Table - Enhanced with performance optimizations
+export const stores = pgTable(
+	"stores",
+	{
+		id: text("id")
+			.primaryKey()
+			.$defaultFn(() => createId()),
+		userId: text("user_id").notNull(),
+		organizationId: text("organization_id"), // Organization ID from Fastify Better Auth
+		storeName: varchar("store_name", { length: 255 }).notNull(),
+		subdomain: varchar("subdomain", { length: 63 }).notNull(),
+		storeUrl: varchar("store_url", { length: 255 }),
+
+		// Core Settings
+		timezone: varchar("timezone", { length: 50 }).notNull().default("UTC"),
+		currency: varchar("currency", { length: 3 }).notNull().default("USD"),
+		languages: jsonb("languages").$type<string[]>().notNull().default(["en"]),
+
+		// Store Configuration
+		storeType: varchar("store_type", { length: 50 })
+			.notNull()
+			.default("STANDARD")
+			.$type<"STANDARD" | "PREMIUM" | "ENTERPRISE">(),
+
+		plan: varchar("plan", { length: 50 })
+			.notNull()
+			.default("FREE")
+			.$type<"FREE" | "BASIC" | "PRO" | "ENTERPRISE">(),
+
+		// Ethiopian Business Registration
+		tinNumber: varchar("tin_number", { length: 50 }),
+		businessType: varchar("business_type", { length: 20 })
+			.$type<"starter" | "business_owner">()
+			.default("starter"),
+		region: varchar("region", { length: 100 }),
+		subcity: varchar("subcity", { length: 100 }),
+		woreda: varchar("woreda", { length: 100 }),
+		houseNumber: varchar("house_number", { length: 50 }),
+		tradeNames: jsonb("trade_names").$type<string[]>().default([]),
+
+		// TIN Verification Status Tracking
+		tinVerificationStatus: varchar("tin_verification_status", { length: 30 })
+			.$type<"UNVERIFIED" | "PENDING" | "VERIFIED" | "FAILED" | "EXPIRED">()
+			.default("UNVERIFIED"),
+		tinVerifiedAt: timestamp("tin_verified_at", { withTimezone: true }),
+		tinVerifiedBy: text("tin_verified_by"),
+		tinVerificationData: jsonb("tin_verification_data")
+			.$type<Record<string, unknown>>()
+			.default({}),
+		tinVerificationErrors: jsonb("tin_verification_errors")
+			.$type<string[]>()
+			.default([]),
+		tinLastChecked: timestamp("tin_last_checked", { withTimezone: true }),
+
+		// Business Type Change Tracking
+		businessTypeChangedAt: timestamp("business_type_changed_at", { withTimezone: true }),
+		businessTypeChangedBy: text("business_type_changed_by"),
+		businessTypeChangeReason: text("business_type_change_reason"),
+		previousBusinessType: varchar("previous_business_type", { length: 20 })
+			.$type<"starter" | "business_owner">(),
+
+		// Store Additional Details
+		attributes: jsonb("attributes")
+			.$type<Record<string, unknown>>()
+			.default({}),
+		settings: jsonb("settings")
+			.$type<{
+				enablePublicListing?: boolean;
+				enableReviews?: boolean;
+				enableInventoryTracking?: boolean;
+				enableMultiCurrency?: boolean;
+				maintenanceMode?: boolean;
+				customCss?: string;
+				logoUrl?: string;
+				faviconUrl?: string;
+				themeColor?: string;
+			}>()
+			.default({}),
+
+		// Performance metrics
+		monthlyVisitors: integer("monthly_visitors").default(0),
+		totalOrders: integer("total_orders").default(0),
+		totalRevenue: integer("total_revenue").default(0), // in cents
+
+		// Status and lifecycle
+		isActive: boolean("is_active").notNull().default(true),
+		isPublished: boolean("is_published").notNull().default(false),
+		launchedAt: timestamp("launched_at", { withTimezone: true }),
+
+		// Audit fields
+		createdAt: timestamp("created_at", { withTimezone: true })
+			.defaultNow()
+			.notNull(),
+		updatedAt: timestamp("updated_at", { withTimezone: true })
+			.defaultNow()
+			.notNull(),
+		deletedAt: timestamp("deleted_at", { withTimezone: true }),
+	},
+	(table) => ({
+		// Primary indexes for performance
+		subdomainUnique: unique("idx_stores_subdomain_unique").on(table.subdomain),
+		storeNameIndex: index("idx_stores_name").on(table.storeName),
+		userIdIndex: index("idx_stores_user_id").on(table.userId),
+		organizationIdIndex: index("idx_stores_organization_id").on(
+			table.organizationId,
+		),
+
+		// Composite indexes for common queries
+		userActiveStoresIndex: index("idx_stores_user_active").on(
+			table.userId,
+			table.isActive,
+		),
+		activePublishedIndex: index("idx_stores_active_published").on(
+			table.isActive,
+			table.isPublished,
+		),
+		planTypeIndex: index("idx_stores_plan_type").on(
+			table.plan,
+			table.storeType,
+		),
+
+		// Performance tracking indexes
+		visitorsIndex: index("idx_stores_monthly_visitors").on(
+			table.monthlyVisitors,
+		),
+		revenueIndex: index("idx_stores_total_revenue").on(table.totalRevenue),
+
+		// Temporal indexes
+		createdAtIndex: index("idx_stores_created_at").on(table.createdAt),
+		launchedAtIndex: index("idx_stores_launched_at").on(table.launchedAt),
+
+		// Ethiopian business indexes
+		tinNumberIndex: index("idx_stores_tin_number").on(table.tinNumber),
+		businessTypeIndex: index("idx_stores_business_type").on(table.businessType),
+		locationIndex: index("idx_stores_location").on(
+			table.region,
+			table.subcity,
+			table.woreda,
+		),
+	}),
+);
+
+// Store Business Details Table - Enhanced
+export const storeBusinessDetails = pgTable(
+	"store_business_details",
+	{
+		id: text("id")
+			.primaryKey()
+			.$defaultFn(() => createId()),
+		storeId: text("store_id")
+			.notNull()
+			.references(() => stores.id, { onDelete: "cascade" }),
+
+		// Business Type and Legal Structure
+		businessType: varchar("business_type", { length: 20 })
+			.notNull()
+			.$type<"INDIVIDUAL" | "BUSINESS" | "NON_PROFIT" | "GOVERNMENT">()
+			.default("INDIVIDUAL"),
+
+		legalStructure: varchar("legal_structure", { length: 30 }).$type<
+			| "SOLE_PROPRIETORSHIP"
+			| "PARTNERSHIP"
+			| "LLC"
+			| "CORPORATION"
+			| "S_CORP"
+			| "NON_PROFIT"
+		>(),
+
+		// Ethiopian Registration Details
+		legalBusinessNameAmh: varchar("legal_business_name_amh", { length: 255 }),
+		registrationDate: timestamp("registration_date", { withTimezone: true }),
+		paidUpCapital: numeric("paid_up_capital", { precision: 15, scale: 2 }),
+		licenseDetails: jsonb("license_details").$type<any[]>().default([]),
+		associateInfo: jsonb("associate_info").$type<any[]>().default([]),
+		tradeNames: jsonb("trade_names").$type<string[]>().default([]),
+
+		// Business Details
+		businessName: varchar("business_name", { length: 255 }),
+		dbaName: varchar("dba_name", { length: 255 }), // "Doing Business As"
+		businessRegistrationNumber: varchar("business_registration_number", {
+			length: 100,
+		}),
+		taxIdentificationNumber: varchar("tax_identification_number", {
+			length: 100,
+		}),
+		vatNumber: varchar("vat_number", { length: 50 }),
+
+		// Address Information
+		businessAddress: jsonb("business_address").$type<{
+			street: string;
+			street2?: string;
+			city: string;
+			state: string;
+			postalCode: string;
+			country: string;
+		}>(),
+
+		mailingAddress: jsonb("mailing_address").$type<{
+			street: string;
+			street2?: string;
+			city: string;
+			state: string;
+			postalCode: string;
+			country: string;
+			sameAsBusiness?: boolean;
+		}>(),
+
+		// Industry and Size
+		industry: varchar("industry", { length: 100 }),
+		subIndustry: varchar("sub_industry", { length: 100 }),
+		employeeCount: varchar("employee_count", { length: 20 }).$type<
+			"1" | "2-10" | "11-50" | "51-200" | "201-500" | "500+"
+		>(),
+
+		// Financial Information
+		annualRevenue: varchar("annual_revenue", { length: 30 }).$type<
+			| "<10K"
+			| "10K-50K"
+			| "50K-100K"
+			| "100K-500K"
+			| "500K-1M"
+			| "1M-10M"
+			| "10M+"
+		>(),
+
+		// Verification Status
+		isVerified: boolean("is_verified").notNull().default(false),
+		verificationStatus: varchar("verification_status", { length: 30 })
+			.notNull()
+			.default("PENDING")
+			.$type<
+				"PENDING" | "IN_PROGRESS" | "VERIFIED" | "REJECTED" | "REQUIRES_UPDATE"
+			>(),
+
+		verificationDocuments: jsonb("verification_documents").$type<{
+			businessLicense?: string;
+			taxCertificate?: string;
+			bankStatement?: string;
+			proofOfAddress?: string;
+			other?: string[];
+		}>(),
+
+		verifiedAt: timestamp("verified_at", { withTimezone: true }),
+		verifiedBy: text("verified_by"),
+
+		createdAt: timestamp("created_at", { withTimezone: true })
+			.defaultNow()
+			.notNull(),
+		updatedAt: timestamp("updated_at", { withTimezone: true })
+			.defaultNow()
+			.notNull(),
+	},
+	(table) => ({
+		storeIdIndex: index("idx_business_details_store_id").on(table.storeId),
+		businessTypeIndex: index("idx_business_details_type").on(
+			table.businessType,
+		),
+		verificationStatusIndex: index("idx_business_details_verification").on(
+			table.verificationStatus,
+		),
+		industryIndex: index("idx_business_details_industry").on(table.industry),
+
+		// Composite indexes for verification workflows
+		verificationWorkflowIndex: index("idx_business_verification_workflow").on(
+			table.verificationStatus,
+			table.businessType,
+		),
+
+		// Ethiopian indexes
+		tinIndex: index("idx_business_details_tin").on(table.taxIdentificationNumber),
+		registrationDateIndex: index("idx_business_details_registration_date").on(table.registrationDate),
+	}),
+);
+
+// Store Contacts Table - Enhanced
+export const storeContacts = pgTable(
+	"store_contacts",
+	{
+		id: text("id")
+			.primaryKey()
+			.$defaultFn(() => createId()),
+		storeId: text("store_id")
+			.notNull()
+			.references(() => stores.id, { onDelete: "cascade" }),
+
+		// Primary Contact Information
+		contactEmail: varchar("contact_email", { length: 255 }).notNull(),
+		contactName: varchar("contact_name", { length: 255 }),
+		contactTitle: varchar("contact_title", { length: 100 }),
+
+		// Departmental Emails
+		supportEmail: varchar("support_email", { length: 255 }),
+		salesEmail: varchar("sales_email", { length: 255 }),
+		technicalEmail: varchar("technical_email", { length: 255 }),
+		billingEmail: varchar("billing_email", { length: 255 }),
+		marketingEmail: varchar("marketing_email", { length: 255 }),
+		legalEmail: varchar("legal_email", { length: 255 }),
+
+		// Phone Numbers with international support
+		primaryPhone: varchar("primary_phone", { length: 20 }),
+		supportPhone: varchar("support_phone", { length: 20 }),
+		whatsappNumber: varchar("whatsapp_number", { length: 20 }),
+		faxNumber: varchar("fax_number", { length: 20 }),
+
+		// Business Hours
+		businessHours: jsonb("business_hours").$type<{
+			timezone: string;
+			monday?: { open: string; close: string; closed?: boolean };
+			tuesday?: { open: string; close: string; closed?: boolean };
+			wednesday?: { open: string; close: string; closed?: boolean };
+			thursday?: { open: string; close: string; closed?: boolean };
+			friday?: { open: string; close: string; closed?: boolean };
+			saturday?: { open: string; close: string; closed?: boolean };
+			sunday?: { open: string; close: string; closed?: boolean };
+			holidays?: Array<{ date: string; name: string }>;
+		}>(),
+
+		// Emergency and After-hours Contact
+		emergencyContact: jsonb("emergency_contact").$type<{
+			name: string;
+			position: string;
+			phone: string;
+			email: string;
+			available24x7: boolean;
+			escalationProcess?: string;
+		}>(),
+
+		// Communication Preferences
+		preferredContactMethod: varchar("preferred_contact_method", { length: 20 })
+			.$type<"EMAIL" | "PHONE" | "SMS" | "WHATSAPP">()
+			.default("EMAIL"),
+
+		// Social Media and Other Channels
+		communicationChannels: jsonb("communication_channels").$type<{
+			slack?: string;
+			discord?: string;
+			telegram?: string;
+			skype?: string;
+			zoom?: string;
+			teams?: string;
+		}>(),
+
+		createdAt: timestamp("created_at", { withTimezone: true })
+			.defaultNow()
+			.notNull(),
+		updatedAt: timestamp("updated_at", { withTimezone: true })
+			.defaultNow()
+			.notNull(),
+	},
+	(table) => ({
+		storeIdIndex: index("idx_contacts_store_id").on(table.storeId),
+		contactEmailIndex: index("idx_contacts_email").on(table.contactEmail),
+		preferredMethodIndex: index("idx_contacts_preferred_method").on(
+			table.preferredContactMethod,
+		),
+	}),
+);
+
+// Store Social Profiles Table - Enhanced
+export const storeSocialProfiles = pgTable(
+	"store_social_profiles",
+	{
+		id: text("id")
+			.primaryKey()
+			.$defaultFn(() => createId()),
+		storeId: text("store_id")
+			.notNull()
+			.references(() => stores.id, { onDelete: "cascade" }),
+
+		// Major Social Platforms
+		facebookUrl: varchar("facebook_url", { length: 500 }),
+		facebookEnabled: boolean("facebook_enabled").notNull().default(false),
+		facebookPageId: varchar("facebook_page_id", { length: 100 }),
+
+		instagramUrl: varchar("instagram_url", { length: 500 }),
+		instagramEnabled: boolean("instagram_enabled").notNull().default(false),
+		instagramHandle: varchar("instagram_handle", { length: 100 }),
+
+		twitterUrl: varchar("twitter_url", { length: 500 }),
+		twitterEnabled: boolean("twitter_enabled").notNull().default(false),
+		twitterHandle: varchar("twitter_handle", { length: 100 }),
+
+		linkedinUrl: varchar("linkedin_url", { length: 500 }),
+		linkedinEnabled: boolean("linkedin_enabled").notNull().default(false),
+		linkedinPageId: varchar("linkedin_page_id", { length: 100 }),
+
+		youtubeUrl: varchar("youtube_url", { length: 500 }),
+		youtubeEnabled: boolean("youtube_enabled").notNull().default(false),
+		youtubeChannelId: varchar("youtube_channel_id", { length: 100 }),
+
+		tiktokUrl: varchar("tiktok_url", { length: 500 }),
+		tiktokEnabled: boolean("tiktok_enabled").notNull().default(false),
+		tiktokHandle: varchar("tiktok_handle", { length: 100 }),
+
+		pinterestUrl: varchar("pinterest_url", { length: 500 }),
+		pinterestEnabled: boolean("pinterest_enabled").notNull().default(false),
+		pinterestHandle: varchar("pinterest_handle", { length: 100 }),
+
+		// Professional and Niche Platforms
+		githubUrl: varchar("github_url", { length: 500 }),
+		githubEnabled: boolean("github_enabled").notNull().default(false),
+
+		snapchatUrl: varchar("snapchat_url", { length: 500 }),
+		snapchatEnabled: boolean("snapchat_enabled").notNull().default(false),
+
+		redditUrl: varchar("reddit_url", { length: 500 }),
+		redditEnabled: boolean("reddit_enabled").notNull().default(false),
+
+		// Messaging Platforms
+		discordUrl: varchar("discord_url", { length: 500 }),
+		discordEnabled: boolean("discord_enabled").notNull().default(false),
+
+		telegramUrl: varchar("telegram_url", { length: 500 }),
+		telegramEnabled: boolean("telegram_enabled").notNull().default(false),
+
+		whatsappUrl: varchar("whatsapp_url", { length: 500 }),
+		whatsappEnabled: boolean("whatsapp_enabled").notNull().default(false),
+
+		// Custom and Regional Platforms
+		customPlatforms: jsonb("custom_platforms")
+			.$type<
+				Array<{
+					name: string;
+					url: string;
+					enabled: boolean;
+					icon?: string;
+					displayOrder?: number;
+				}>
+			>()
+			.default([]),
+
+		// Social Media Strategy
+		socialMediaStrategy: jsonb("social_media_strategy").$type<{
+			primaryPlatforms: string[];
+			postingSchedule?: Record<string, string[]>; // platform -> days/times
+			contentThemes?: string[];
+			hashtagStrategy?: Record<string, string[]>; // platform -> hashtags
+			engagementGoals?: Record<string, number>;
+		}>(),
+
+		// Analytics and Tracking
+		socialAnalytics: jsonb("social_analytics")
+			.$type<{
+				trackingEnabled: boolean;
+				utmSource?: string;
+				utmMedium?: string;
+				utmCampaign?: string;
+				conversionTracking?: boolean;
+			}>()
+			.default({ trackingEnabled: false }),
+
+		createdAt: timestamp("created_at", { withTimezone: true })
+			.defaultNow()
+			.notNull(),
+		updatedAt: timestamp("updated_at", { withTimezone: true })
+			.defaultNow()
+			.notNull(),
+	},
+	(table) => ({
+		storeIdIndex: index("idx_social_store_id").on(table.storeId),
+		// Index for enabled platforms for quick filtering
+		enabledPlatformsIndex: index("idx_social_enabled_facebook").on(
+			table.storeId,
+			table.facebookEnabled,
+		),
+		enabledInstagramIndex: index("idx_social_enabled_instagram").on(
+			table.storeId,
+			table.instagramEnabled,
+		),
+		enabledTwitterIndex: index("idx_social_enabled_twitter").on(
+			table.storeId,
+			table.twitterEnabled,
+		),
+	}),
+);
+
+// Store Blogs Table - Enhanced
+export const storeBlogs = pgTable(
+	"store_blogs",
+	{
+		id: text("id")
+			.primaryKey()
+			.$defaultFn(() => createId()),
+		storeId: text("store_id")
+			.notNull()
+			.references(() => stores.id, { onDelete: "cascade" }),
+
+		// Content
+		title: varchar("title", { length: 255 }).notNull(),
+		slug: varchar("slug", { length: 255 }).notNull(),
+		excerpt: text("excerpt"),
+		content: text("content").notNull(),
+
+		// Media
+		featuredImage: varchar("featured_image", { length: 500 }),
+		gallery: jsonb("gallery").$type<string[]>().default([]),
+		media: jsonb("media")
+			.$type<
+				Array<{
+					type:
+					| "video"
+					| "audio"
+					| "podcast"
+					| "youtube"
+					| "vimeo"
+					| "spotify"
+					| "soundcloud"
+					| "other";
+					url: string;
+					title?: string;
+					description?: string;
+					thumbnail?: string;
+					duration?: number; // Duration in seconds
+					size?: number; // File size in bytes
+				}>
+			>()
+			.default([]),
+
+		// SEO and Metadata
+		metaTitle: varchar("meta_title", { length: 255 }),
+		metaDescription: text("meta_description"),
+		metaKeywords: jsonb("meta_keywords").$type<string[]>().default([]),
+		canonicalUrl: varchar("canonical_url", { length: 500 }),
+
+		// Content Organization
+		categoryId: text("category_id"),
+		tags: jsonb("tags").$type<string[]>().notNull().default([]),
+		topics: jsonb("topics").$type<string[]>().default([]),
+
+		// Publishing
+		status: varchar("status", { length: 20 })
+			.notNull()
+			.default("draft")
+			.$type<"draft" | "pending" | "published" | "archived" | "deleted">(),
+
+		publishedAt: timestamp("published_at", { withTimezone: true }),
+		scheduledFor: timestamp("scheduled_for", { withTimezone: true }),
+
+		// Authoring
+		authors: jsonb("authors")
+			.$type<
+				Array<{
+					id: string;
+					name: string;
+					role?: string;
+					bio?: string;
+					avatar?: string;
+				}>
+			>()
+			.notNull()
+			.default([]),
+
+		// Engagement and Analytics
+		viewCount: integer("view_count").default(0),
+		likeCount: integer("like_count").default(0),
+		shareCount: integer("share_count").default(0),
+		commentCount: integer("comment_count").default(0),
+
+		// Content Settings
+		allowComments: boolean("allow_comments").notNull().default(true),
+		allowSharing: boolean("allow_sharing").notNull().default(true),
+		allowRating: boolean("allow_rating").notNull().default(false),
+
+		// Features
+		isFeatured: boolean("is_featured").notNull().default(false),
+		isSticky: boolean("is_sticky").notNull().default(false),
+		isPremium: boolean("is_premium").notNull().default(false),
+
+		// Reading Experience
+		estimatedReadTime: integer("estimated_read_time"), // in minutes
+		difficulty: varchar("difficulty", { length: 20 }).$type<
+			"beginner" | "intermediate" | "advanced"
+		>(),
+
+		// Language and Localization
+		language: varchar("language", { length: 10 }).default("en"),
+		translations: jsonb("translations")
+			.$type<Record<string, string>>()
+			.default({}),
+
+		createdAt: timestamp("created_at", { withTimezone: true })
+			.defaultNow()
+			.notNull(),
+		updatedAt: timestamp("updated_at", { withTimezone: true })
+			.defaultNow()
+			.notNull(),
+	},
+	(table) => ({
+		storeIdIndex: index("idx_blog_store_id").on(table.storeId),
+		slugUniqueIndex: unique("idx_blog_slug_unique").on(
+			table.storeId,
+			table.slug,
+		),
+		statusIndex: index("idx_blog_status").on(table.status),
+		publishedAtIndex: index("idx_blog_published_at").on(table.publishedAt),
+
+		// Content discovery indexes
+		featuredIndex: index("idx_blog_featured").on(
+			table.isFeatured,
+			table.status,
+		),
+		categoryIndex: index("idx_blog_category").on(
+			table.categoryId,
+			table.status,
+		),
+
+		// Performance indexes
+		viewCountIndex: index("idx_blog_view_count").on(table.viewCount),
+
+		// Publishing workflow indexes
+		publishingWorkflowIndex: index("idx_blog_publishing_workflow").on(
+			table.status,
+			table.scheduledFor,
+		),
+	}),
+);
+
+// Relations
+export const storesRelations = relations(stores, ({ one, many }) => ({
+	businessDetails: one(storeBusinessDetails, {
+		fields: [stores.id],
+		references: [storeBusinessDetails.storeId],
+	}),
+	contacts: one(storeContacts, {
+		fields: [stores.id],
+		references: [storeContacts.storeId],
+	}),
+	socialProfiles: one(storeSocialProfiles, {
+		fields: [stores.id],
+		references: [storeSocialProfiles.storeId],
+	}),
+	blogs: many(storeBlogs),
+}));
+
+export const storeBusinessDetailsRelations = relations(
+	storeBusinessDetails,
+	({ one }) => ({
+		store: one(stores, {
+			fields: [storeBusinessDetails.storeId],
+			references: [stores.id],
+		}),
+	}),
+);
+
+export const storeContactsRelations = relations(storeContacts, ({ one }) => ({
+	store: one(stores, {
+		fields: [storeContacts.storeId],
+		references: [stores.id],
+	}),
+}));
+
+export const storeSocialProfilesRelations = relations(
+	storeSocialProfiles,
+	({ one }) => ({
+		store: one(stores, {
+			fields: [storeSocialProfiles.storeId],
+			references: [stores.id],
+		}),
+	}),
+);
+
+export const storeBlogsRelations = relations(storeBlogs, ({ one }) => ({
+	store: one(stores, {
+		fields: [storeBlogs.storeId],
+		references: [stores.id],
+	}),
+}));