@openlup/platform 0.17.0 → 0.19.0

package/dist/pricing/quotePrimitives.js

@@ -0,0 +1,18 @@
+import { z } from "zod";
+/** Currency acceptance belongs to the host's settlement profile. */
+export function createCommerceQuotePrimitives(commerceCurrencySchema) {
+    const commerceTaxCountrySchema = z.string().trim().regex(/^[A-Z]{2}$/);
+    const commerceTaxCategorySchema = z.string().trim().regex(/^[a-z][a-z0-9_]*$/);
+    const commerceTaxLegalBasisSchema = z.string().trim().min(1).max(200);
+    const commerceSkuSchema = z
+        .string()
+        .trim()
+        .min(1)
+        .max(128)
+        .regex(/^[a-zA-Z0-9._:-]+$/);
+    const commerceMoneySchema = z.object({
+        amountMinor: z.number().int().nonnegative(),
+        currency: commerceCurrencySchema,
+    });
+    return { commerceCurrencySchema, commerceTaxCountrySchema, commerceTaxCategorySchema, commerceTaxLegalBasisSchema, commerceSkuSchema, commerceMoneySchema };
+}

package/dist/pricing/quotePromotionEvidence.d.ts

@@ -0,0 +1,39 @@
+import { z } from "zod";
+import type { QuotePromotionEvidence } from "./contracts/evidence.js";
+export declare const quoteDiscountSchema: z.ZodObject<{
+    promotionId: z.ZodString;
+    code: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    label: z.ZodOptional<z.ZodString>;
+    appliesTo: z.ZodEnum<{
+        line: "line";
+        shipping: "shipping";
+        order_total: "order_total";
+    }>;
+    amountOffMinor: z.ZodNumber;
+    reasonCode: z.ZodString;
+    customerSemantic: z.ZodOptional<z.ZodEnum<{
+        first_purchase_10: "first_purchase_10";
+        first_subscription_50: "first_subscription_50";
+        bundle_5: "bundle_5";
+    }>>;
+    promotionEngineVersion: z.ZodOptional<z.ZodLiteral<"promotion-engine.v2">>;
+    promotionCodeId: z.ZodOptional<z.ZodString>;
+    promotionCodeRevision: z.ZodOptional<z.ZodNumber>;
+    promotionDefinitionFingerprint: z.ZodOptional<z.ZodString>;
+    promotionCodeScopes: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+        one_time: "one_time";
+        subscription_initial: "subscription_initial";
+    }>>>;
+    promotionMinimumReferenceMinor: z.ZodOptional<z.ZodNumber>;
+    promotionCodeValidTo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    promotionBenefitKind: z.ZodOptional<z.ZodEnum<{
+        target_percentage: "target_percentage";
+        percentage: "percentage";
+        fixed_amount: "fixed_amount";
+        free_shipping: "free_shipping";
+    }>>;
+    promotionBenefitValueBps: z.ZodOptional<z.ZodNumber>;
+    promotionBenefitValueMinor: z.ZodOptional<z.ZodNumber>;
+    floorApplied: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>;
+export declare function hasValidV2PromotionEvidence(discount: QuotePromotionEvidence): boolean;

package/dist/pricing/quotePromotionEvidence.js

@@ -0,0 +1,73 @@
+import { z } from "zod";
+const uuidSchema = z.string().uuid();
+export const quoteDiscountSchema = z
+    .object({
+    promotionId: z.string().trim().min(1).max(120),
+    code: z.string().trim().min(1).max(80).nullable().optional(),
+    label: z.string().trim().min(1).max(200).optional(),
+    appliesTo: z.enum(["order_total", "line", "shipping"]),
+    amountOffMinor: z.number().int().positive(),
+    reasonCode: z.string().trim().min(1).max(120),
+    customerSemantic: z.enum([
+        "first_purchase_10", "first_subscription_50", "bundle_5",
+    ]).optional(),
+    promotionEngineVersion: z.literal("promotion-engine.v2").optional(),
+    promotionCodeId: z.string().uuid().optional(),
+    promotionCodeRevision: z.number().int().positive().optional(),
+    promotionDefinitionFingerprint: z.string().regex(/^[0-9a-f]{64}$/).optional(),
+    promotionCodeScopes: z.array(z.enum(["one_time", "subscription_initial"])).min(1).max(2).optional(),
+    promotionMinimumReferenceMinor: z.number().int().nonnegative().optional(),
+    promotionCodeValidTo: z.string().datetime({ offset: true }).nullable().optional(),
+    promotionBenefitKind: z.enum([
+        "target_percentage", "percentage", "fixed_amount", "free_shipping",
+    ]).optional(),
+    promotionBenefitValueBps: z.number().int().min(1).max(9_999).optional(),
+    promotionBenefitValueMinor: z.number().int().positive().optional(),
+    floorApplied: z.boolean().optional(),
+})
+    .strict()
+    .superRefine((discount, context) => {
+    if (!hasValidV2PromotionEvidence(discount)) {
+        context.addIssue({ code: "custom", message: "v2 promotion discount evidence is incomplete" });
+    }
+});
+export function hasValidV2PromotionEvidence(discount) {
+    const carriesEvidence = discount.promotionEngineVersion !== undefined ||
+        discount.promotionCodeId !== undefined ||
+        discount.promotionCodeRevision !== undefined ||
+        discount.promotionDefinitionFingerprint !== undefined ||
+        discount.promotionCodeScopes !== undefined ||
+        discount.promotionMinimumReferenceMinor !== undefined ||
+        discount.promotionCodeValidTo !== undefined ||
+        discount.promotionBenefitKind !== undefined ||
+        discount.promotionBenefitValueBps !== undefined ||
+        discount.promotionBenefitValueMinor !== undefined || discount.floorApplied !== undefined;
+    return !carriesEvidence || (discount.promotionEngineVersion === "promotion-engine.v2" &&
+        discount.reasonCode === "promotion_code_v2" &&
+        Boolean(discount.code) &&
+        uuidSchema.safeParse(discount.promotionCodeId).success &&
+        discount.promotionCodeRevision !== undefined &&
+        /^[0-9a-f]{64}$/.test(discount.promotionDefinitionFingerprint ?? "") &&
+        validScopes(discount.promotionCodeScopes) &&
+        (discount.promotionMinimumReferenceMinor ?? -1) >= 0 &&
+        discount.promotionCodeValidTo !== undefined &&
+        discount.promotionBenefitKind !== undefined &&
+        benefitValueMatchesKind(discount) &&
+        discount.floorApplied !== undefined &&
+        uuidSchema.safeParse(discount.promotionId).success);
+}
+function validScopes(scopes) {
+    return Boolean(scopes?.length && scopes.length <= 2 &&
+        new Set(scopes).size === scopes.length &&
+        scopes.every((scope) => scope === "one_time" || scope === "subscription_initial"));
+}
+function benefitValueMatchesKind(discount) {
+    const percentage = discount.promotionBenefitKind === "target_percentage" ||
+        discount.promotionBenefitKind === "percentage";
+    return percentage === (discount.promotionBenefitValueBps !== undefined) &&
+        (discount.promotionBenefitKind === "fixed_amount") ===
+            (discount.promotionBenefitValueMinor !== undefined) &&
+        (discount.promotionBenefitKind !== "free_shipping" ||
+            (discount.promotionBenefitValueBps === undefined &&
+                discount.promotionBenefitValueMinor === undefined));
+}