@axova/shared 1.0.2 → 1.1.0

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

@@ -0,0 +1,231 @@
+import { createId } from "@paralleldrive/cuid2";
+import { relations } from "drizzle-orm";
+import {
+	boolean,
+	decimal,
+	index,
+	jsonb,
+	pgTable,
+	text,
+	timestamp,
+	unique,
+	varchar,
+} from "drizzle-orm/pg-core";
+import { stores } from "./store-schema";
+
+export const storeSettings = pgTable(
+	"store_settings",
+	{
+		id: text("id")
+			.primaryKey()
+			.$defaultFn(() => createId()),
+		storeId: text("store_id")
+			.notNull()
+			.references(() => stores.id, { onDelete: "cascade" }),
+
+		storeCountry: varchar("store_country", { length: 100 })
+			.notNull()
+			.default("Ethiopia"),
+
+		storeCurrency: varchar("store_currency", { length: 3 })
+			.notNull()
+			.default("ETB"),
+
+		storeLanguage: varchar("store_language", { length: 10 })
+			.notNull()
+			.default("en"),
+
+		supportedLanguages: jsonb("supported_languages")
+			.$type<string[]>()
+			.notNull()
+			.default(["en"]),
+
+		supportedCurrencies: jsonb("supported_currencies")
+			.$type<string[]>()
+			.notNull()
+			.default(["ETB"]),
+
+		localizationSettings: jsonb("localization_settings")
+			.$type<{
+				dateFormat?: string;
+				timeFormat?: string;
+				numberFormat?: string;
+				firstDayOfWeek?: number;
+				weightUnit?: "kg" | "lb";
+				dimensionUnit?: "cm" | "inch";
+			}>()
+			.default({
+				dateFormat: "DD/MM/YYYY",
+				timeFormat: "HH:mm",
+				numberFormat: "1,234.56",
+				firstDayOfWeek: 0,
+				weightUnit: "kg",
+				dimensionUnit: "cm",
+			}),
+
+		generalSettings: jsonb("general_settings")
+			.$type<{
+				autoApplyTax?: boolean;
+				pricesIncludeTax?: boolean;
+				enableMultiCurrency?: boolean;
+				enableMultiLanguage?: boolean;
+				currencyDisplayFormat?: "symbol" | "code" | "both";
+			}>()
+			.default({
+				autoApplyTax: true,
+				pricesIncludeTax: false,
+				enableMultiCurrency: false,
+				enableMultiLanguage: false,
+				currencyDisplayFormat: "symbol",
+			}),
+
+		metadata: jsonb("metadata").$type<Record<string, unknown>>().default({}),
+
+		createdAt: timestamp("created_at", { withTimezone: true })
+			.defaultNow()
+			.notNull(),
+		updatedAt: timestamp("updated_at", { withTimezone: true })
+			.defaultNow()
+			.notNull(),
+	},
+	(table) => ({
+		storeIdIndex: index("idx_store_settings_store_id").on(table.storeId),
+		storeIdUnique: unique("idx_store_settings_store_unique").on(table.storeId),
+		countryIndex: index("idx_store_settings_country").on(table.storeCountry),
+	}),
+);
+
+export const marketRegions = pgTable(
+	"market_regions",
+	{
+		id: text("id")
+			.primaryKey()
+			.$defaultFn(() => createId()),
+		storeId: text("store_id")
+			.notNull()
+			.references(() => stores.id, { onDelete: "cascade" }),
+
+		regionName: varchar("region_name", { length: 100 }).notNull(),
+		regionCode: varchar("region_code", { length: 10 }).notNull(),
+
+		country: varchar("country", { length: 100 }).notNull().default("Ethiopia"),
+		countryCode: varchar("country_code", { length: 2 })
+			.notNull()
+			.default("ET"),
+
+		currency: varchar("currency", { length: 3 }).notNull().default("ETB"),
+		language: varchar("language", { length: 10 }).notNull().default("en"),
+
+		taxEnabled: boolean("tax_enabled").notNull().default(true),
+		taxPercentage: decimal("tax_percentage", { precision: 5, scale: 2 })
+			.notNull()
+			.default("15.00"),
+
+		taxName: varchar("tax_name", { length: 50 }).default("VAT"),
+
+		taxConfiguration: jsonb("tax_configuration")
+			.$type<{
+				taxType?: "VAT" | "GST" | "SALES_TAX" | "CUSTOM";
+				taxNumber?: string;
+				taxRegistrationDate?: string;
+				includeTaxInPrice?: boolean;
+				compoundTax?: boolean;
+				exemptCategories?: string[];
+				reducedRates?: Array<{
+					categoryId: string;
+					categoryName: string;
+					rate: number;
+				}>;
+			}>()
+			.default({
+				taxType: "VAT",
+				includeTaxInPrice: false,
+				compoundTax: false,
+				exemptCategories: [],
+				reducedRates: [],
+			}),
+
+		isDefault: boolean("is_default").notNull().default(false),
+		isActive: boolean("is_active").notNull().default(true),
+
+		shippingSettings: jsonb("shipping_settings")
+			.$type<{
+				enableShipping?: boolean;
+				freeShippingThreshold?: number;
+				defaultShippingRate?: number;
+				shippingZones?: Array<{
+					name: string;
+					rate: number;
+					estimatedDays: number;
+				}>;
+			}>()
+			.default({
+				enableShipping: true,
+				freeShippingThreshold: 0,
+				defaultShippingRate: 0,
+				shippingZones: [],
+			}),
+
+		paymentSettings: jsonb("payment_settings")
+			.$type<{
+				enabledPaymentMethods?: string[];
+				preferredPaymentMethod?: string;
+				paymentProcessingFee?: number;
+			}>()
+			.default({
+				enabledPaymentMethods: ["cash", "card"],
+				preferredPaymentMethod: "cash",
+				paymentProcessingFee: 0,
+			}),
+
+		metadata: jsonb("metadata").$type<Record<string, unknown>>().default({}),
+
+		createdAt: timestamp("created_at", { withTimezone: true })
+			.defaultNow()
+			.notNull(),
+		updatedAt: timestamp("updated_at", { withTimezone: true })
+			.defaultNow()
+			.notNull(),
+	},
+	(table) => ({
+		storeIdIndex: index("idx_market_regions_store_id").on(table.storeId),
+		regionCodeIndex: index("idx_market_regions_code").on(
+			table.storeId,
+			table.regionCode,
+		),
+		defaultIndex: index("idx_market_regions_default").on(
+			table.storeId,
+			table.isDefault,
+		),
+		activeIndex: index("idx_market_regions_active").on(
+			table.storeId,
+			table.isActive,
+		),
+		uniqueRegionCode: unique("idx_market_regions_unique_code").on(
+			table.storeId,
+			table.regionCode,
+		),
+	}),
+);
+
+export const storeSettingsRelations = relations(storeSettings, ({ one, many }) => ({
+	store: one(stores, {
+		fields: [storeSettings.storeId],
+		references: [stores.id],
+	}),
+}));
+
+export const marketRegionsRelations = relations(marketRegions, ({ one }) => ({
+	store: one(stores, {
+		fields: [marketRegions.storeId],
+		references: [stores.id],
+	}),
+}));
+
+export const storesRelationsExtended = relations(stores, ({ one, many }) => ({
+	settings: one(storeSettings, {
+		fields: [stores.id],
+		references: [storeSettings.storeId],
+	}),
+	marketRegions: many(marketRegions),
+}));

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

@@ -0,0 +1,382 @@
+import { createId } from "@paralleldrive/cuid2";
+import { relations } from "drizzle-orm";
+import {
+	boolean,
+	index,
+	jsonb,
+	pgTable,
+	text,
+	timestamp,
+	varchar,
+	integer,
+} from "drizzle-orm/pg-core";
+import { stores } from "./store-schema";
+
+/**
+ * Storefront Configuration Schema
+ * Stores all visual, layout, and content configurations for multi-tenant storefronts
+ */
+export const storefrontConfigs = pgTable(
+	"storefront_configs",
+	{
+		id: text("id")
+			.primaryKey()
+			.$defaultFn(() => createId()),
+		storeId: text("store_id")
+			.notNull()
+			.references(() => stores.id, { onDelete: "cascade" }),
+
+		// Configuration type and version
+		configType: varchar("config_type", { length: 50 })
+			.notNull()
+			.default("default")
+			.$type<"default" | "custom" | "theme">(),
+		version: integer("version").notNull().default(1),
+		isActive: boolean("is_active").notNull().default(true),
+
+		// Branding Configuration
+		branding: jsonb("branding")
+			.$type<{
+				name?: string;
+				logo?: {
+					type?: "text" | "image" | "both";
+					text?: string;
+					image?: string;
+					imageWidth?: number;
+					imageHeight?: number;
+					showText?: boolean;
+				};
+				favicon?: string;
+				colors?: {
+					primary?: string;
+					secondary?: string;
+					accent?: string;
+					background?: string;
+					text?: string;
+					muted?: string;
+				};
+				typography?: {
+					headings?: {
+						family?: string;
+						weight?: string;
+						letterSpacing?: string;
+					};
+					body?: {
+						family?: string;
+						weight?: string;
+						letterSpacing?: string;
+					};
+					display?: {
+						family?: string;
+						weight?: string;
+						letterSpacing?: string;
+					};
+				};
+			}>()
+			.default({}),
+
+		// Layout Configuration
+		layout: jsonb("layout")
+			.$type<{
+				header?: {
+					announcement?: {
+						enabled?: boolean;
+						text?: string;
+						link?: {
+							text?: string;
+							url?: string;
+						};
+					};
+					navigation?: {
+						mainMenu?: Array<{
+							id: string;
+							label?: string;
+							url: string;
+							children?: Array<{ id: string; label?: string; url: string }>;
+						}>;
+						position?: "left" | "center" | "right";
+					};
+					features?: {
+						search?: boolean;
+						cart?: boolean;
+						wishlist?: boolean;
+						account?: boolean;
+						language?: boolean;
+						currency?: boolean;
+					};
+					sticky?: boolean;
+					transparent?: boolean;
+				};
+				footer?: {
+					columns?: Array<{
+						title?: string;
+						links?: Array<{ label?: string; url: string }>;
+					}>;
+					social?: Array<{
+						platform: string;
+						url?: string;
+						icon?: string;
+					}>;
+					payment?: Array<{
+						name: string;
+						icon?: string;
+					}>;
+					newsletter?: {
+						enabled?: boolean;
+						title?: string;
+						placeholder?: string;
+						buttonText?: string;
+					};
+					copyright?: string;
+					showPoweredBy?: boolean;
+				};
+				sidebar?: {
+					enabled?: boolean;
+					position?: "left" | "right";
+				};
+			}>()
+			.default({}),
+
+		// Pages Content Configuration
+		pages: jsonb("pages")
+			.$type<{
+				home?: {
+					hero?: {
+						badge?: string;
+						title?: string;
+						subtitle?: string;
+						cta?: {
+							text?: string;
+							link?: string;
+							variant?: "primary" | "secondary" | "outline";
+						};
+						secondaryCta?: {
+							text?: string;
+							link?: string;
+						};
+						backgroundImage?: string;
+						backgroundVideo?: string;
+						newsletter?: {
+							enabled?: boolean;
+							placeholder?: string;
+							buttonText?: string;
+						};
+						trustedBy?: {
+							enabled?: boolean;
+							text?: string;
+							logos?: Array<{ name: string; url: string }>;
+						};
+					};
+					features?: {
+						title?: string;
+						subtitle?: string;
+						items?: Array<{
+							icon?: string;
+							title: string;
+							description: string;
+						}>;
+					};
+					sections?: Array<{
+						id: string;
+						type: string;
+						enabled?: boolean;
+						data?: Record<string, unknown>;
+					}>;
+				};
+				about?: {
+					hero?: {
+						title?: string;
+						subtitle?: string;
+						image?: string;
+					};
+					vision?: {
+						title?: string;
+						content?: string;
+					};
+					values?: Array<{
+						title: string;
+						description: string;
+						icon?: string;
+					}>;
+				};
+				contact?: {
+					hero?: {
+						title?: string;
+						subtitle?: string;
+					};
+					form?: {
+						title?: string;
+						submitButton?: string;
+						successMessage?: string;
+					};
+					info?: {
+						address?: string;
+						phone?: string;
+						email?: string;
+						hours?: string;
+					};
+				};
+				[key: string]: unknown;
+			}>()
+			.default({}),
+
+		// Promotions & Popups Configuration
+		promotions: jsonb("promotions")
+			.$type<{
+				popup?: {
+					enabled?: boolean;
+					trigger?: "immediate" | "exit" | "scroll" | "time";
+					triggerValue?: number;
+					image?: {
+						url?: string;
+						alt?: string;
+					};
+					discount?: {
+						highlightText?: string;
+					};
+					copy?: {
+						title?: string;
+						descriptionPrefix?: string;
+						descriptionSuffix?: string;
+						offerEndsInLabel?: string;
+						emailPlaceholder?: string;
+						ctaButtonText?: string;
+						submittingText?: string;
+						successTitle?: string;
+						successDescription?: string;
+						finePrint?: string;
+					};
+					timer?: {
+						enabled?: boolean;
+						hours?: number;
+						minutes?: number;
+						seconds?: number;
+					};
+				};
+				banner?: {
+					enabled?: boolean;
+					text?: string;
+					link?: string;
+					backgroundColor?: string;
+					textColor?: string;
+				};
+				saleEvents?: Array<{
+					id: string;
+					name: string;
+					startDate?: string;
+					endDate?: string;
+					discountPercent?: number;
+					enabled?: boolean;
+				}>;
+			}>()
+			.default({}),
+
+		// Localization Configuration
+		localization: jsonb("localization")
+			.$type<{
+				languages?: Array<{
+					code: string;
+					name?: string;
+					flag?: string;
+					enabled?: boolean;
+				}>;
+				currencies?: Array<{
+					code: string;
+					symbol?: string;
+					flag?: string;
+					enabled?: boolean;
+				}>;
+				defaultLanguage?: string;
+				defaultCurrency?: string;
+			}>()
+			.default({}),
+
+		// Character Limits & Validation Rules
+		validationRules: jsonb("validation_rules")
+			.$type<{
+				homeHero?: {
+					badgeTextMax?: number;
+					titleMax?: number;
+					subtitleMax?: number;
+					newsletterPlaceholderMax?: number;
+					newsletterButtonTextMax?: number;
+					trustedByTextMax?: number;
+				};
+				[key: string]: unknown;
+			}>()
+			.default({}),
+
+		// SEO & Meta Configuration
+		seo: jsonb("seo")
+			.$type<{
+				defaultTitle?: string;
+				defaultDescription?: string;
+				defaultImage?: string;
+				keywords?: string[];
+				ogTags?: Record<string, string>;
+				twitterCard?: Record<string, string>;
+			}>()
+			.default({}),
+
+		// Custom Scripts & Integrations
+		integrations: jsonb("integrations")
+			.$type<{
+				googleAnalytics?: {
+					enabled?: boolean;
+					trackingId?: string;
+				};
+				facebookPixel?: {
+					enabled?: boolean;
+					pixelId?: string;
+				};
+				customScripts?: {
+					header?: string;
+					footer?: string;
+				};
+				chatWidget?: {
+					enabled?: boolean;
+					provider?: string;
+					config?: Record<string, unknown>;
+				};
+			}>()
+			.default({}),
+
+		// Additional metadata
+		metadata: jsonb("metadata").$type<Record<string, unknown>>().default({}),
+
+		// Audit fields
+		createdBy: text("created_by"),
+		updatedBy: text("updated_by"),
+		publishedAt: timestamp("published_at", { withTimezone: true }),
+		createdAt: timestamp("created_at", { withTimezone: true })
+			.defaultNow()
+			.notNull(),
+		updatedAt: timestamp("updated_at", { withTimezone: true })
+			.defaultNow()
+			.notNull(),
+		deletedAt: timestamp("deleted_at", { withTimezone: true }),
+	},
+	(table) => ({
+		storeIdIndex: index("idx_storefront_configs_store_id").on(table.storeId),
+		activeIndex: index("idx_storefront_configs_active").on(
+			table.storeId,
+			table.isActive,
+		),
+		typeIndex: index("idx_storefront_configs_type").on(table.configType),
+	}),
+);
+
+// Relations
+export const storefrontConfigsRelations = relations(
+	storefrontConfigs,
+	({ one }) => ({
+		store: one(stores, {
+			fields: [storefrontConfigs.storeId],
+			references: [stores.id],
+		}),
+	}),
+);
+
+// TypeScript types
+export type StorefrontConfig = typeof storefrontConfigs.$inferSelect;
+export type NewStorefrontConfig = typeof storefrontConfigs.$inferInsert;