@axova/shared 1.0.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/types.ts

@@ -0,0 +1,67 @@
+// Core types used across all schemas
+
+// Common result type for all operations
+export interface OperationResult<T = unknown> {
+	success: boolean;
+	data?: T;
+	error?: string;
+	metadata?: Record<string, unknown>;
+}
+
+// Paginated result wrapper
+export interface PaginatedResult<T> {
+	items: T[];
+	pagination: {
+		page: number;
+		limit: number;
+		total: number;
+		pages: number;
+		hasNext: boolean;
+		hasPrev: boolean;
+	};
+}
+
+// Multi-tenancy context
+export interface TenantContext {
+	tenantId: string;
+	storeId: string;
+	userId?: string;
+	userRole?: string;
+}
+
+// User context for operations
+export interface UserContext {
+	userId: string;
+	userName: string;
+	userRole: string;
+	permissions: string[];
+	tenantId: string;
+	storeId: string;
+}
+
+// Base filter interface
+export interface BaseFilter {
+	page?: number;
+	limit?: number;
+	sortBy?: string;
+	sortOrder?: "asc" | "desc";
+	search?: string;
+}
+
+// Date range filter
+export interface DateRangeFilter {
+	startDate?: string;
+	endDate?: string;
+}
+
+// Status filter
+export interface StatusFilter {
+	status?: string | string[];
+}
+
+// Location filter
+export interface LocationFilter {
+	locationId?: string;
+	locationType?: "warehouse" | "pos";
+	locationIds?: string[];
+}