@lifeaz/lors-helper 1.0.0

package/src/main.ts

@@ -0,0 +1,443 @@
+import { z } from "zod";
+import type { Dayjs } from "dayjs";
+import type { UUID } from "uuidv7";
+
+const uuidSchema = z.custom<UUID>((v) => typeof v === "string" && /^[0-9a-f]{8}-[0-9a-f]{4}-[1-8][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i.test(v));
+const dayjsSchema = z.custom<Dayjs>((v) => v != null && typeof (v as { isValid?: () => boolean }).isValid === "function");
+
+export type Lang = 'fr' | 'en' | 'nl' | 'de' | 'it' | 'es';
+export const LangSchema = z.union([z.literal('fr'), z.literal('en'), z.literal('nl'), z.literal('de'), z.literal('it'), z.literal('es')]);
+
+export type ProfileType = '_Individual_' | '_Small_Business_' | '_Company_';
+export const ProfileTypeSchema = z.union([z.literal('_Individual_'), z.literal('_Small_Business_'), z.literal('_Company_')]);
+
+export type CartStep = '_Profile_' | '_Offers_' | '_Information_' | '_Options_' | '_Delivery_' | '_Payment_';
+export const CartStepSchema = z.union([z.literal('_Profile_'), z.literal('_Offers_'), z.literal('_Information_'), z.literal('_Options_'), z.literal('_Delivery_'), z.literal('_Payment_')]);
+
+export type CartStatus = '_Draft_' | '_Pending_' | '_Paid_' | '_Abandoned_' | '_Cancelled_';
+export const CartStatusSchema = z.union([z.literal('_Draft_'), z.literal('_Pending_'), z.literal('_Paid_'), z.literal('_Abandoned_'), z.literal('_Cancelled_')]);
+
+export type OrderStatus = '_Pending_' | '_Paid_' | '_In_Production_' | '_In_Delivery_' | '_Delivered_' | '_Cancelled_' | '_Refunded_';
+export const OrderStatusSchema = z.union([z.literal('_Pending_'), z.literal('_Paid_'), z.literal('_In_Production_'), z.literal('_In_Delivery_'), z.literal('_Delivered_'), z.literal('_Cancelled_'), z.literal('_Refunded_')]);
+
+export type PaymentStatus = '_Open_' | '_Pending_' | '_Authorized_' | '_Paid_' | '_Failed_' | '_Cancelled_' | '_Expired_' | '_Refunded_' | '_Chargeback_';
+export const PaymentStatusSchema = z.union([z.literal('_Open_'), z.literal('_Pending_'), z.literal('_Authorized_'), z.literal('_Paid_'), z.literal('_Failed_'), z.literal('_Cancelled_'), z.literal('_Expired_'), z.literal('_Refunded_'), z.literal('_Chargeback_')]);
+
+export type ItemCategory = '_Solution_' | '_Warranty_' | '_Accessory_' | '_Training_' | '_Delivery_';
+export const ItemCategorySchema = z.union([z.literal('_Solution_'), z.literal('_Warranty_'), z.literal('_Accessory_'), z.literal('_Training_'), z.literal('_Delivery_')]);
+
+export type OfferType = '_Purchase_' | '_Rental_';
+export const OfferTypeSchema = z.union([z.literal('_Purchase_'), z.literal('_Rental_')]);
+
+export type PriceRecurrence = '_One_Time_' | '_Monthly_' | '_Annually_';
+export const PriceRecurrenceSchema = z.union([z.literal('_One_Time_'), z.literal('_Monthly_'), z.literal('_Annually_')]);
+
+export type PaymentFrequency = '_Monthly_' | '_Annually_';
+export const PaymentFrequencySchema = z.union([z.literal('_Monthly_'), z.literal('_Annually_')]);
+
+export type PaymentMethod = '_Card_' | '_PayPal_' | '_SEPA_' | '_Alma_4x_';
+export const PaymentMethodSchema = z.union([z.literal('_Card_'), z.literal('_PayPal_'), z.literal('_SEPA_'), z.literal('_Alma_4x_')]);
+
+export type PaymentProvider = '_Mollie_' | '_Alma_';
+export const PaymentProviderSchema = z.union([z.literal('_Mollie_'), z.literal('_Alma_')]);
+
+export type DeliveryMethod = '_Standard_' | '_Express_';
+export const DeliveryMethodSchema = z.union([z.literal('_Standard_'), z.literal('_Express_')]);
+
+export type DiscountValueType = '_Percentage_' | '_Fixed_Amount_';
+export const DiscountValueTypeSchema = z.union([z.literal('_Percentage_'), z.literal('_Fixed_Amount_')]);
+
+export type DiscountTargetScope = '_Whole_Cart_' | '_Specific_Items_' | '_Item_Category_' | '_Delivery_';
+export const DiscountTargetScopeSchema = z.union([z.literal('_Whole_Cart_'), z.literal('_Specific_Items_'), z.literal('_Item_Category_'), z.literal('_Delivery_')]);
+
+export type Surface = '_All_' | '_Checkout_' | '_Storefront_';
+export const SurfaceSchema = z.union([z.literal('_All_'), z.literal('_Checkout_'), z.literal('_Storefront_')]);
+
+export type OperationAssetType = '_Banner_Header_' | '_Banner_Mini_' | '_Banner_Sub_Header_' | '_Hero_' | '_Popup_Welcome_' | '_Popup_Operation_' | '_Popup_Technical_' | '_Strikethrough_Price_' | '_Discount_Section_' | '_Tag_' | '_Text_Banner_' | '_Page_Background_';
+export const OperationAssetTypeSchema = z.union([z.literal('_Banner_Header_'), z.literal('_Banner_Mini_'), z.literal('_Banner_Sub_Header_'), z.literal('_Hero_'), z.literal('_Popup_Welcome_'), z.literal('_Popup_Operation_'), z.literal('_Popup_Technical_'), z.literal('_Strikethrough_Price_'), z.literal('_Discount_Section_'), z.literal('_Tag_'), z.literal('_Text_Banner_'), z.literal('_Page_Background_')]);
+
+export type AddressType = '_Delivery_' | '_Billing_';
+export const AddressTypeSchema = z.union([z.literal('_Delivery_'), z.literal('_Billing_')]);
+
+export type AddressConfidence = '_Verified_' | '_Partial_';
+export const AddressConfidenceSchema = z.union([z.literal('_Verified_'), z.literal('_Partial_')]);
+
+export type TermsType = '_Terms_Of_Use_' | '_Terms_Of_Sales_';
+export const TermsTypeSchema = z.union([z.literal('_Terms_Of_Use_'), z.literal('_Terms_Of_Sales_')]);
+
+export type TestimonialType = '_Text_' | '_Image_' | '_Video_';
+export const TestimonialTypeSchema = z.union([z.literal('_Text_'), z.literal('_Image_'), z.literal('_Video_')]);
+
+export type CartItemSource = '_User_' | '_System_';
+export const CartItemSourceSchema = z.union([z.literal('_User_'), z.literal('_System_')]);
+
+export const AmountSchema = z.object({
+	excl: z.number(),
+	vat: z.number(),
+	incl: z.number(),
+});
+export type Amount = z.infer<typeof AmountSchema>;
+
+export const GeozoneSchema = z.object({
+	id: uuidSchema,
+	name: z.string(),
+});
+export type Geozone = z.infer<typeof GeozoneSchema>;
+
+export const CountrySchema = z.object({
+	id: uuidSchema,
+	geozone: GeozoneSchema,
+	iso: z.string(),
+	phonePrefix: z.string(),
+	name: z.string(),
+});
+export type Country = z.infer<typeof CountrySchema>;
+
+export const StateSchema = z.object({
+	id: uuidSchema,
+	country: CountrySchema,
+	name: z.string(),
+	iso: z.string(),
+});
+export type State = z.infer<typeof StateSchema>;
+
+export const CoordinatesSchema = z.object({
+	lat: z.number(),
+	lng: z.number(),
+});
+export type Coordinates = z.infer<typeof CoordinatesSchema>;
+
+export const AddressSchema = z.object({
+	id: uuidSchema,
+	stringified: z.string(),
+	confidence: AddressConfidenceSchema,
+	country: CountrySchema.nullable(),
+	state: StateSchema.nullable(),
+	alias: z.string().nullable(),
+	line: z.string(),
+	details: z.string().nullable(),
+	postcode: z.string().nullable(),
+	city: z.string().nullable(),
+	placeId: z.string().nullable(),
+	coordinates: CoordinatesSchema.nullable(),
+});
+export type Address = z.infer<typeof AddressSchema>;
+
+export const ContactSchema = z.object({
+	id: uuidSchema,
+	firstName: z.string(),
+	lastName: z.string(),
+	email: z.string().nullable(),
+	phone: z.string().nullable(),
+	company: z.string().nullable(),
+	vatNumber: z.string().nullable(),
+});
+export type Contact = z.infer<typeof ContactSchema>;
+
+export const TermsSchema = z.object({
+	id: uuidSchema,
+	type: TermsTypeSchema,
+	lang: LangSchema,
+	label: z.string(),
+	url: z.string(),
+	version: dayjsSchema,
+});
+export type Terms = z.infer<typeof TermsSchema>;
+
+export const CartTermsAcceptanceSchema = z.object({
+	id: uuidSchema,
+	termsId: uuidSchema,
+	acceptedAt: dayjsSchema,
+});
+export type CartTermsAcceptance = z.infer<typeof CartTermsAcceptanceSchema>;
+
+export const CartTermsViewSchema = z.object({
+	current: z.array(TermsSchema),
+	required: z.array(TermsTypeSchema),
+	accepted: z.array(CartTermsAcceptanceSchema),
+});
+export type CartTermsView = z.infer<typeof CartTermsViewSchema>;
+
+export const ItemPriceSchema = z.object({
+	recurrence: PriceRecurrenceSchema,
+	amount: z.number(),
+	currency: z.string(),
+});
+export type ItemPrice = z.infer<typeof ItemPriceSchema>;
+
+export const ItemSchema = z.object({
+	id: uuidSchema,
+	category: ItemCategorySchema,
+	offerType: OfferTypeSchema.nullable(),
+	sku: z.string().nullable(),
+	name: z.string().nullable(),
+	description: z.string().nullable(),
+	isMainOffer: z.boolean(),
+	visible: z.boolean(),
+	maxPerCart: z.number().int().positive().nullable(),
+	prices: z.array(ItemPriceSchema),
+	allowedProfiles: z.array(ProfileTypeSchema),
+});
+export type Item = z.infer<typeof ItemSchema>;
+
+export const CartItemSchema = z.object({
+	id: uuidSchema,
+	cartId: uuidSchema,
+	itemId: uuidSchema,
+	quantity: z.number().int().positive(),
+	addedBy: CartItemSourceSchema,
+	category: ItemCategorySchema,
+	offerType: OfferTypeSchema.nullable(),
+	sku: z.string().nullable(),
+	isMainOffer: z.boolean(),
+	visible: z.boolean(),
+	maxPerCart: z.number().int().positive().nullable(),
+});
+export type CartItem = z.infer<typeof CartItemSchema>;
+
+export const PricingContextSchema = z.object({
+	cartId: uuidSchema,
+	profile: ProfileTypeSchema.nullable(),
+	offerType: OfferTypeSchema.nullable(),
+	countryIso: z.string(),
+});
+export type PricingContext = z.infer<typeof PricingContextSchema>;
+
+export const PricingLineSchema = z.object({
+	cartItemId: uuidSchema,
+	itemId: uuidSchema,
+	quantity: z.number().int().positive(),
+	category: ItemCategorySchema,
+	sku: z.string().nullable(),
+	name: z.string().nullable(),
+	recurrence: PriceRecurrenceSchema,
+	currency: z.string(),
+	unit: AmountSchema,
+	line: AmountSchema,
+	vatRate: z.number(),
+	countryIso: z.string(),
+	matchKind: z.string().nullable(),
+});
+export type PricingLine = z.infer<typeof PricingLineSchema>;
+
+export const PricingRecurrenceTotalSchema = z.object({
+	recurrence: PriceRecurrenceSchema,
+	currency: z.string(),
+	gross: AmountSchema,
+	discount: AmountSchema,
+	net: AmountSchema,
+	countryIso: z.string(),
+});
+export type PricingRecurrenceTotal = z.infer<typeof PricingRecurrenceTotalSchema>;
+
+export const AppliedDiscountBucketSchema = z.object({
+	excl: z.number(),
+	vat: z.number(),
+	incl: z.number(),
+});
+export type AppliedDiscountBucket = z.infer<typeof AppliedDiscountBucketSchema>;
+
+export const AppliedDiscountSchema = z.object({
+	cartDiscountId: uuidSchema,
+	discountId: uuidSchema,
+	code: z.string(),
+	label: z.string().nullable(),
+	targetScope: DiscountTargetScopeSchema,
+	valueType: DiscountValueTypeSchema,
+	appliesToOneTime: z.boolean(),
+	appliesToRecurring: z.boolean(),
+	stackable: z.boolean(),
+	value: z.number().nullable(),
+	byRecurrence: z.record(z.string(), AppliedDiscountBucketSchema),
+});
+export type AppliedDiscount = z.infer<typeof AppliedDiscountSchema>;
+
+export const CartTotalSchema = z.object({
+	currency: z.string(),
+	oneTime: z.object({
+		excl: z.number(),
+		incl: z.number(),
+	}),
+	recurring: z.object({
+		excl: z.number(),
+		incl: z.number(),
+		frequency: PaymentFrequencySchema.nullable(),
+	}),
+});
+export type CartTotal = z.infer<typeof CartTotalSchema>;
+
+export const CartPricingSchema = z.object({
+	context: PricingContextSchema,
+	lines: z.array(PricingLineSchema),
+	totalsByRecurrence: z.record(z.string(), PricingRecurrenceTotalSchema),
+	appliedDiscounts: z.array(AppliedDiscountSchema),
+	total: CartTotalSchema,
+});
+export type CartPricing = z.infer<typeof CartPricingSchema>;
+
+export const CartSchema = z.object({
+	id: uuidSchema,
+	reference: z.string(),
+	secret: z.string(),
+	status: CartStatusSchema,
+	currentStep: CartStepSchema,
+	maxReachedStep: CartStepSchema,
+	profile: ProfileTypeSchema.nullable(),
+	offerType: OfferTypeSchema.nullable(),
+	paymentMethod: PaymentMethodSchema.nullable(),
+	paymentFrequency: PaymentFrequencySchema.nullable(),
+	deliveryMethod: DeliveryMethodSchema.nullable(),
+	devices: z.number().int().nonnegative(),
+	locale: LangSchema,
+	vatNumber: z.string().nullable(),
+	multiAddressesCallback: z.boolean(),
+	createdAt: dayjsSchema,
+	updatedAt: dayjsSchema,
+});
+export type Cart = z.infer<typeof CartSchema>;
+
+export const OrderSchema = z.object({
+	id: uuidSchema,
+	reference: z.string(),
+	secret: z.string(),
+	status: OrderStatusSchema,
+	cartId: uuidSchema,
+	profile: ProfileTypeSchema,
+	offerType: OfferTypeSchema,
+	paymentFrequency: PaymentFrequencySchema.nullable(),
+	deliveryMethod: DeliveryMethodSchema,
+	currency: z.string(),
+	oneTime: AmountSchema,
+	recurring: AmountSchema,
+	createdAt: dayjsSchema,
+	updatedAt: dayjsSchema,
+});
+export type Order = z.infer<typeof OrderSchema>;
+
+export const OperationSummarySchema = z.object({
+	id: uuidSchema,
+	slug: z.string(),
+	name: z.string(),
+	description: z.string().nullable(),
+	startsAt: dayjsSchema,
+	endsAt: dayjsSchema,
+	priority: z.number().int(),
+	autoApplyDiscount: z.boolean(),
+	discountId: uuidSchema.nullable(),
+	discountCode: z.string().nullable(),
+	discountLabel: z.string().nullable(),
+	discountValueType: DiscountValueTypeSchema.nullable(),
+	discountValue: z.number().nullable(),
+});
+export type OperationSummary = z.infer<typeof OperationSummarySchema>;
+
+export const OperationAssetSchema = z.object({
+	id: uuidSchema,
+	operationId: uuidSchema,
+	type: OperationAssetTypeSchema,
+	surface: SurfaceSchema,
+	lang: LangSchema.nullable(),
+	order: z.number().int(),
+	pageUrlPattern: z.string().nullable(),
+	content: z.unknown(),
+	styles: z.unknown().nullable(),
+	createdAt: dayjsSchema,
+	updatedAt: dayjsSchema,
+});
+export type OperationAsset = z.infer<typeof OperationAssetSchema>;
+
+export const OperationItemPricingSchema = z.object({
+	id: uuidSchema,
+	operationId: uuidSchema,
+	itemId: uuidSchema,
+	profile: ProfileTypeSchema,
+	recurrence: PriceRecurrenceSchema,
+	originalExclVat: z.number(),
+	discountedExclVat: z.number(),
+	currency: z.string(),
+	sku: z.string().nullable(),
+});
+export type OperationItemPricing = z.infer<typeof OperationItemPricingSchema>;
+
+export const OperationDetailSchema = OperationSummarySchema.extend({
+	assets: z.array(OperationAssetSchema),
+	itemsPricing: z.array(OperationItemPricingSchema),
+});
+export type OperationDetail = z.infer<typeof OperationDetailSchema>;
+
+export const TestimonialSchema = z.object({
+	id: uuidSchema,
+	lang: LangSchema,
+	type: TestimonialTypeSchema,
+	author: z.string(),
+	content: z.string().nullable(),
+	altText: z.string().nullable(),
+	imageUrl: z.string().nullable(),
+	videoUrl: z.string().nullable(),
+	rating: z.number().int().min(1).max(5).nullable(),
+	publishedAt: dayjsSchema,
+	order: z.number().int(),
+});
+export type Testimonial = z.infer<typeof TestimonialSchema>;
+
+export const TestimonialCategorySchema = z.object({
+	id: uuidSchema,
+	lang: LangSchema,
+	name: z.string(),
+	order: z.number().int(),
+});
+export type TestimonialCategory = z.infer<typeof TestimonialCategorySchema>;
+
+export const HelpArticleSchema = z.object({
+	id: uuidSchema,
+	title: z.string(),
+	body: z.string(),
+	order: z.number().int(),
+});
+export type HelpArticle = z.infer<typeof HelpArticleSchema>;
+
+export type HelpCategory = {
+	id: UUID;
+	parentId: UUID | null;
+	lang: Lang;
+	name: string;
+	description: string | null;
+	logoUrl: string | null;
+	order: number;
+	articles: HelpArticle[];
+	subCategories: HelpCategory[];
+};
+
+export const HelpCategorySchema: z.ZodType<HelpCategory> = z.object({
+	id: uuidSchema,
+	parentId: uuidSchema.nullable(),
+	lang: LangSchema,
+	name: z.string(),
+	description: z.string().nullable(),
+	logoUrl: z.string().nullable(),
+	order: z.number().int(),
+	articles: z.array(HelpArticleSchema),
+	subCategories: z.array(z.lazy(() => HelpCategorySchema)),
+});
+
+export const HelpPageSchema = z.object({
+	id: uuidSchema,
+	slug: z.string(),
+	name: z.string(),
+	createdAt: dayjsSchema,
+});
+export type HelpPage = z.infer<typeof HelpPageSchema>;
+
+export const ContactRequestInputSchema = z.object({
+	firstName: z.string().min(1),
+	lastName: z.string().min(1),
+	email: z.string().email(),
+	phone: z.string().min(1),
+	company: z.string().nullable().optional(),
+	devices: z.number().int().nonnegative().optional(),
+	content: z.string().min(1).max(5000),
+	captchaToken: z.string().min(1),
+	profile: ProfileTypeSchema.optional(),
+	locale: LangSchema.optional(),
+});
+export type ContactRequestInput = z.infer<typeof ContactRequestInputSchema>;