@lifeaz/lors-helper 1.0.0

package/dist/main.js

@@ -0,0 +1,321 @@
+import { z } from "zod";
+const uuidSchema = z.custom((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((v) => v != null && typeof v.isValid === "function");
+export const LangSchema = z.union([z.literal('fr'), z.literal('en'), z.literal('nl'), z.literal('de'), z.literal('it'), z.literal('es')]);
+export const ProfileTypeSchema = z.union([z.literal('_Individual_'), z.literal('_Small_Business_'), z.literal('_Company_')]);
+export const CartStepSchema = z.union([z.literal('_Profile_'), z.literal('_Offers_'), z.literal('_Information_'), z.literal('_Options_'), z.literal('_Delivery_'), z.literal('_Payment_')]);
+export const CartStatusSchema = z.union([z.literal('_Draft_'), z.literal('_Pending_'), z.literal('_Paid_'), z.literal('_Abandoned_'), z.literal('_Cancelled_')]);
+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 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 const ItemCategorySchema = z.union([z.literal('_Solution_'), z.literal('_Warranty_'), z.literal('_Accessory_'), z.literal('_Training_'), z.literal('_Delivery_')]);
+export const OfferTypeSchema = z.union([z.literal('_Purchase_'), z.literal('_Rental_')]);
+export const PriceRecurrenceSchema = z.union([z.literal('_One_Time_'), z.literal('_Monthly_'), z.literal('_Annually_')]);
+export const PaymentFrequencySchema = z.union([z.literal('_Monthly_'), z.literal('_Annually_')]);
+export const PaymentMethodSchema = z.union([z.literal('_Card_'), z.literal('_PayPal_'), z.literal('_SEPA_'), z.literal('_Alma_4x_')]);
+export const PaymentProviderSchema = z.union([z.literal('_Mollie_'), z.literal('_Alma_')]);
+export const DeliveryMethodSchema = z.union([z.literal('_Standard_'), z.literal('_Express_')]);
+export const DiscountValueTypeSchema = z.union([z.literal('_Percentage_'), z.literal('_Fixed_Amount_')]);
+export const DiscountTargetScopeSchema = z.union([z.literal('_Whole_Cart_'), z.literal('_Specific_Items_'), z.literal('_Item_Category_'), z.literal('_Delivery_')]);
+export const SurfaceSchema = z.union([z.literal('_All_'), z.literal('_Checkout_'), z.literal('_Storefront_')]);
+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 const AddressTypeSchema = z.union([z.literal('_Delivery_'), z.literal('_Billing_')]);
+export const AddressConfidenceSchema = z.union([z.literal('_Verified_'), z.literal('_Partial_')]);
+export const TermsTypeSchema = z.union([z.literal('_Terms_Of_Use_'), z.literal('_Terms_Of_Sales_')]);
+export const TestimonialTypeSchema = z.union([z.literal('_Text_'), z.literal('_Image_'), z.literal('_Video_')]);
+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 const GeozoneSchema = z.object({
+    id: uuidSchema,
+    name: z.string(),
+});
+export const CountrySchema = z.object({
+    id: uuidSchema,
+    geozone: GeozoneSchema,
+    iso: z.string(),
+    phonePrefix: z.string(),
+    name: z.string(),
+});
+export const StateSchema = z.object({
+    id: uuidSchema,
+    country: CountrySchema,
+    name: z.string(),
+    iso: z.string(),
+});
+export const CoordinatesSchema = z.object({
+    lat: z.number(),
+    lng: z.number(),
+});
+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 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 const TermsSchema = z.object({
+    id: uuidSchema,
+    type: TermsTypeSchema,
+    lang: LangSchema,
+    label: z.string(),
+    url: z.string(),
+    version: dayjsSchema,
+});
+export const CartTermsAcceptanceSchema = z.object({
+    id: uuidSchema,
+    termsId: uuidSchema,
+    acceptedAt: dayjsSchema,
+});
+export const CartTermsViewSchema = z.object({
+    current: z.array(TermsSchema),
+    required: z.array(TermsTypeSchema),
+    accepted: z.array(CartTermsAcceptanceSchema),
+});
+export const ItemPriceSchema = z.object({
+    recurrence: PriceRecurrenceSchema,
+    amount: z.number(),
+    currency: z.string(),
+});
+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 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 const PricingContextSchema = z.object({
+    cartId: uuidSchema,
+    profile: ProfileTypeSchema.nullable(),
+    offerType: OfferTypeSchema.nullable(),
+    countryIso: z.string(),
+});
+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 const PricingRecurrenceTotalSchema = z.object({
+    recurrence: PriceRecurrenceSchema,
+    currency: z.string(),
+    gross: AmountSchema,
+    discount: AmountSchema,
+    net: AmountSchema,
+    countryIso: z.string(),
+});
+export const AppliedDiscountBucketSchema = z.object({
+    excl: z.number(),
+    vat: z.number(),
+    incl: z.number(),
+});
+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 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 const CartPricingSchema = z.object({
+    context: PricingContextSchema,
+    lines: z.array(PricingLineSchema),
+    totalsByRecurrence: z.record(z.string(), PricingRecurrenceTotalSchema),
+    appliedDiscounts: z.array(AppliedDiscountSchema),
+    total: CartTotalSchema,
+});
+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 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 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 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 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 const OperationDetailSchema = OperationSummarySchema.extend({
+    assets: z.array(OperationAssetSchema),
+    itemsPricing: z.array(OperationItemPricingSchema),
+});
+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 const TestimonialCategorySchema = z.object({
+    id: uuidSchema,
+    lang: LangSchema,
+    name: z.string(),
+    order: z.number().int(),
+});
+export const HelpArticleSchema = z.object({
+    id: uuidSchema,
+    title: z.string(),
+    body: z.string(),
+    order: z.number().int(),
+});
+export const HelpCategorySchema = 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 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(),
+});

package/package.json

@@ -0,0 +1,59 @@
+{
+	"name": "@lifeaz/lors-helper",
+	"description": "Lifeaz Online Retail Storefront Helper",
+	"version": "1.0.0",
+	"versionCode": "200000001",
+	"main": "dist/main.js",
+	"files": [
+		"dist",
+		"src/main.ts"
+	],
+	"exports": {
+		".": {
+			"types": "./dist/main.d.ts",
+			"bun": "./src/main.ts",
+			"import": "./dist/main.js",
+			"require": "./dist/main.js"
+		}
+	},
+	"type": "module",
+	"types": "dist/main.d.ts",
+	"engines": {
+		"node": ">=20"
+	},
+	"cpu": [
+		"x86",
+		"x64",
+		"arm64"
+	],
+	"keywords": [
+		"lifeaz",
+		"lors",
+		"helper"
+	],
+	"scripts": {
+		"prepare": "bash ./.scripts/hooks-install.sh",
+		"build": "bunx tsc && bunx tsc-alias",
+		"prepublishOnly": "bun run build",
+		"build:version": "bash ./.scripts/bump.sh",
+		"build:version:ensure": "bash ./.scripts/bump.sh --no-build"
+	},
+	"peerDependencies": {
+		"dayjs": "^1.11.20",
+		"uuidv7": "^1.2.1",
+		"zod": "^4.3.0"
+	},
+	"devDependencies": {
+		"@types/node": "^24.3.0",
+		"rimraf": "^6.0.1",
+		"typescript": "^5.8.3",
+		"zod": "^4.3.6"
+	},
+	"lifeaz": {
+		"version": {
+			"short": 1,
+			"full": "1.0.0-b4",
+			"code": "100000004"
+		}
+	}
+}