@openlup/platform 0.26.0 → 0.28.0

package/dist/commerce/configuratorIntentSchemas.d.ts

@@ -0,0 +1,63 @@
+import { z } from "zod";
+export declare const CONFIGURATOR_INTENT_VERSION = "commerce.configurator_intent.v1";
+export declare const configuratorModeSchema: z.ZodEnum<{
+    one_time: "one_time";
+    subscription: "subscription";
+}>;
+export declare const configuratorContactSchema: z.ZodObject<{
+    firstName: z.ZodString;
+    lastName: z.ZodString;
+    email: z.ZodString;
+    phone: z.ZodString;
+}, z.core.$strict>;
+export declare const configuratorAddressCoreSchema: z.ZodObject<{
+    street: z.ZodString;
+    postalCode: z.ZodString;
+    city: z.ZodString;
+    country: z.ZodString;
+}, z.core.$strict>;
+export declare function createConfiguratorIntentSchemas(skuSchema: z.ZodType<string, string>): {
+    configuratorVariantCoreSchema: z.ZodObject<{
+        variantId: z.ZodString;
+        sku: z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>;
+        qty: z.ZodNumber;
+    }, z.core.$strict>;
+    configuratorIntentCoreSchema: z.ZodObject<{
+        version: z.ZodLiteral<"commerce.configurator_intent.v1">;
+        idempotencyKey: z.ZodString;
+        mode: z.ZodEnum<{
+            one_time: "one_time";
+            subscription: "subscription";
+        }>;
+        cadenceDays: z.ZodDefault<z.ZodNullable<z.ZodNumber>>;
+        promoCodes: z.ZodDefault<z.ZodArray<z.ZodString>>;
+        visitorId: z.ZodOptional<z.ZodString>;
+        contact: z.ZodObject<{
+            firstName: z.ZodString;
+            lastName: z.ZodString;
+            email: z.ZodString;
+            phone: z.ZodString;
+        }, z.core.$strict>;
+        address: z.ZodObject<{
+            street: z.ZodString;
+            postalCode: z.ZodString;
+            city: z.ZodString;
+            country: z.ZodString;
+        }, z.core.$strict>;
+        selectedVariants: z.ZodArray<z.ZodObject<{
+            variantId: z.ZodString;
+            sku: z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>;
+            qty: z.ZodNumber;
+        }, z.core.$strict>>;
+        offerVersion: z.ZodOptional<z.ZodString>;
+        minimumUnits: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>;
+};
+export declare function validateConfiguratorIntentCore(intent: {
+    mode: "one_time" | "subscription";
+    cadenceDays: number | null;
+    minimumUnits?: number;
+    selectedVariants: readonly {
+        qty: number;
+    }[];
+}, ctx: z.RefinementCtx, defaultMinimumUnits: number): void;

package/dist/commerce/configuratorIntentSchemas.js

@@ -0,0 +1,43 @@
+import { z } from "zod";
+import { commerceIdempotencyKeySchema, commerceMinimumUnits, commerceMinimumUnitsSchema, commerceOfferVersionSchema } from "./contractPrimitives.js";
+export const CONFIGURATOR_INTENT_VERSION = "commerce.configurator_intent.v1";
+export const configuratorModeSchema = z.enum(["one_time", "subscription"]);
+export const configuratorContactSchema = z.object({
+    firstName: z.string().trim().min(1).max(80), lastName: z.string().trim().min(1).max(80),
+    email: z.string().trim().email().max(160), phone: z.string().trim().min(6).max(32),
+}).strict();
+export const configuratorAddressCoreSchema = z.object({
+    street: z.string().trim().min(3).max(160), postalCode: z.string().trim().min(3).max(16),
+    city: z.string().trim().min(2).max(120), country: z.string().regex(/^[A-Z]{2}$/),
+}).strict();
+export function createConfiguratorIntentSchemas(skuSchema) {
+    const configuratorVariantCoreSchema = z.object({
+        variantId: z.string().trim().min(1).max(120),
+        sku: skuSchema,
+        qty: z.number().int().positive().max(99),
+    }).strict();
+    const configuratorIntentCoreSchema = z.object({
+        version: z.literal(CONFIGURATOR_INTENT_VERSION),
+        idempotencyKey: commerceIdempotencyKeySchema,
+        mode: configuratorModeSchema,
+        cadenceDays: z.number().int().positive().max(120).nullable().default(null),
+        promoCodes: z.array(z.string().trim().min(1).max(80)).max(20).default([]),
+        visitorId: z.string().trim().min(1).max(120).optional(),
+        contact: configuratorContactSchema,
+        address: configuratorAddressCoreSchema,
+        selectedVariants: z.array(configuratorVariantCoreSchema).min(1).max(50),
+        offerVersion: commerceOfferVersionSchema.optional(),
+        minimumUnits: commerceMinimumUnitsSchema.optional(),
+    }).strict();
+    return { configuratorVariantCoreSchema, configuratorIntentCoreSchema };
+}
+export function validateConfiguratorIntentCore(intent, ctx, defaultMinimumUnits) {
+    if (intent.mode === "subscription" && !intent.cadenceDays) {
+        ctx.addIssue({ code: z.ZodIssueCode.custom, message: "subscription intent requires cadenceDays", path: ["cadenceDays"] });
+    }
+    const selectedUnitCount = intent.selectedVariants.reduce((total, variant) => total + variant.qty, 0);
+    const minimumUnits = commerceMinimumUnits(intent, defaultMinimumUnits);
+    if (selectedUnitCount < minimumUnits) {
+        ctx.addIssue({ code: z.ZodIssueCode.custom, message: `selected variants require at least ${minimumUnits} total units`, path: ["selectedVariants"] });
+    }
+}

package/dist/commerce/contractPrimitives.d.ts

@@ -0,0 +1,50 @@
+import { z } from "zod";
+export declare const cartStatusSchema: z.ZodEnum<{
+    draft: "draft";
+}>;
+export declare const checkoutStatusSchema: z.ZodEnum<{
+    not_configured: "not_configured";
+    created: "created";
+    expired: "expired";
+}>;
+export declare const orderDraftStatusSchema: z.ZodEnum<{
+    draft: "draft";
+}>;
+export declare const orderStatusSchema: z.ZodEnum<{
+    failed: "failed";
+    cancelled: "cancelled";
+    paid: "paid";
+    pending_payment: "pending_payment";
+    draft: "draft";
+    expired: "expired";
+    fulfillment_pending: "fulfillment_pending";
+    fulfilled: "fulfilled";
+    refunded: "refunded";
+}>;
+export declare const paymentStatusSchema: z.ZodEnum<{
+    requires_action: "requires_action";
+    failed: "failed";
+    paid: "paid";
+    expired: "expired";
+    refunded: "refunded";
+    not_started: "not_started";
+    processing: "processing";
+    partially_refunded: "partially_refunded";
+    disputed: "disputed";
+}>;
+export declare const commerceIdempotencyKeySchema: z.ZodString;
+/** Hosts add their own sizing kinds and profile fields. */
+export declare const commerceSizeConstraintCoreSchema: z.ZodObject<{
+    kind: z.ZodEnum<{
+        unit_count: "unit_count";
+        total_weight_g: "total_weight_g";
+    }>;
+    value: z.ZodNumber;
+}, z.core.$strict>;
+/** Opaque offer tokens are transported, never interpreted by commerce. */
+export declare const commerceOfferVersionSchema: z.ZodString;
+export declare const commerceMinimumUnitsSchema: z.ZodNumber;
+/** Client asks do not establish trusted checkout admission. */
+export declare function commerceMinimumUnits(input: {
+    minimumUnits?: number | null;
+}, defaultMinimumUnits: number): number;

package/dist/commerce/contractPrimitives.js

@@ -0,0 +1,25 @@
+import { z } from "zod";
+import { CART_STATUSES, CHECKOUT_STATUSES, ORDER_DRAFT_STATUSES, ORDER_STATUSES, PAYMENT_STATUSES } from "./contracts/state.js";
+export const cartStatusSchema = z.enum(CART_STATUSES);
+export const checkoutStatusSchema = z.enum(CHECKOUT_STATUSES);
+export const orderDraftStatusSchema = z.enum(ORDER_DRAFT_STATUSES);
+export const orderStatusSchema = z.enum(ORDER_STATUSES);
+export const paymentStatusSchema = z.enum(PAYMENT_STATUSES);
+export const commerceIdempotencyKeySchema = z
+    .string()
+    .trim()
+    .min(8)
+    .max(120)
+    .regex(/^[a-zA-Z0-9._:-]+$/);
+/** Hosts add their own sizing kinds and profile fields. */
+export const commerceSizeConstraintCoreSchema = z.object({
+    kind: z.enum(["unit_count", "total_weight_g"]),
+    value: z.number().int().positive(),
+}).strict();
+/** Opaque offer tokens are transported, never interpreted by commerce. */
+export const commerceOfferVersionSchema = z.string().max(40).regex(/^[a-z][a-z0-9]*(?:[._-][a-z0-9]+)*$/);
+export const commerceMinimumUnitsSchema = z.number().int().min(1).max(99);
+/** Client asks do not establish trusted checkout admission. */
+export function commerceMinimumUnits(input, defaultMinimumUnits) {
+    return input.minimumUnits ?? defaultMinimumUnits;
+}

package/dist/commerce/contracts/availability.d.ts

@@ -0,0 +1,23 @@
+export type CommerceOfferAvailabilityStatus = "available" | "low_stock" | "out_of_stock" | "unknown";
+export interface CommerceOfferAvailabilityRequestItem {
+    sku: string;
+    productSlug: string;
+    variantId: string;
+    requestedQuantity: number;
+    checkoutMode: "one_time" | "subscription";
+}
+export interface CommerceOfferAvailability {
+    sku: string;
+    productSlug: string;
+    variantId: string;
+    status: CommerceOfferAvailabilityStatus;
+    visibleInConfigurator: boolean;
+    sellableNow: number | null;
+    reasonCode: string;
+    source: string;
+}
+export interface CommerceOfferAvailabilityPort {
+    getAvailability(input: {
+        items: readonly CommerceOfferAvailabilityRequestItem[];
+    }): Promise<CommerceOfferAvailability[]>;
+}

package/dist/commerce/contracts/availability.js

@@ -0,0 +1 @@
+export {};

package/dist/commerce/contracts/fulfillmentRecovery.d.ts

@@ -0,0 +1,25 @@
+export type TimedFulfillmentSignal = {
+    id?: undefined | null | string;
+    token: undefined | null | string;
+    occurredAt: undefined | null | string;
+};
+export type ReleasedProviderExceptionHold = {
+    orderId: undefined | null | string;
+    status: undefined | null | string;
+    reason: undefined | null | string;
+    createdBy: undefined | null | string;
+    releasedBy: undefined | null | string;
+    metadata: unknown;
+};
+export type ProviderStatusEvidence = {
+    fulfillmentOrderId: undefined | null | string;
+    providerStatus: undefined | null | string;
+    localStatus: undefined | null | string;
+    id?: undefined | null | string;
+    token: undefined | null | string;
+    occurredAt: undefined | null | string;
+};
+export type ResolvedProviderExceptionRecovery = {
+    clearedExceptionEvidenceIds: ReadonlySet<string>;
+    recoveryEvidenceIds: ReadonlySet<string>;
+};

package/dist/commerce/contracts/fulfillmentRecovery.js

@@ -0,0 +1 @@
+export {};

package/dist/commerce/contracts/index.d.ts

@@ -0,0 +1,13 @@
+export type { CommerceOfferAvailabilityStatus, CommerceOfferAvailabilityRequestItem, CommerceOfferAvailability, CommerceOfferAvailabilityPort } from "./availability.js";
+export type { RecoveryDestinationIntent, RecoveryDestinationPolicyInput, RecoveryDestinationSource, RecoveryDestinationState } from "./recovery.js";
+export type { CommerceFulfillmentEligibilityInput, CartStatus, CheckoutStatus, OrderDraftStatus, OrderStatus, PaymentStatus, OmsFulfillmentBlockReason, OmsInventoryStatus } from "./state.js";
+export type { CartDraft, CheckoutSessionPlaceholder, OrderDraftSummary, OrderSummary, PaymentSummary } from "./order.js";
+export type AsyncCheckoutStatus = "pending_provider_action" | "requires_action" | "processing" | "paid" | "failed" | "expired";
+export type CheckoutKind = "one_time" | "subscription_initial";
+export type * from "./ports.js";
+export type * from "./runtimePorts.js";
+export type { ConfiguratorIntent, ConfiguratorIntentPersistenceResponse, CheckoutResumeDraftState, CheckoutResumeDraft, CommerceCustomerDefaultsSnapshot } from "./intent.js";
+export type * from "./orderMoney.js";
+export type { OmsPaymentStatus } from "./state.js";
+export type * from "./fulfillmentRecovery.js";
+export type * from "./omsTypes.js";

package/dist/commerce/contracts/index.js

@@ -0,0 +1 @@
+export {};

package/dist/commerce/contracts/intent.d.ts

@@ -0,0 +1,86 @@
+/** Neutral configurator state. Profiles, sizing policy and provider evidence are host extensions. */
+export interface ConfiguratorIntent {
+    version: "commerce.configurator_intent.v1";
+    idempotencyKey: string;
+    mode: "one_time" | "subscription";
+    cadenceDays: number | null;
+    promoCodes: string[];
+    visitorId?: string;
+    contact: {
+        firstName: string;
+        lastName: string;
+        email: string;
+        phone: string;
+    };
+    address: {
+        street: string;
+        postalCode: string;
+        city: string;
+        country: string;
+    };
+    selectedVariants: Array<{
+        variantId: string;
+        sku: string;
+        qty: number;
+    }>;
+    offerVersion?: string;
+    minimumUnits?: number;
+}
+export interface ConfiguratorIntentPersistenceResponse {
+    contractVersion: "commerce.configurator_intent_persistence.v1";
+    intentVersion: "commerce.configurator_intent.v1";
+    idempotencyKey: string;
+    clientId: string;
+    addressId: string;
+    clientMatchReason?: "client_created" | "client_match_exact_email" | "client_match_plus_normalized_fallback";
+    replayed: boolean;
+}
+export interface CheckoutResumeDraftState<Completion, RedactedField extends string> {
+    version: "commerce.checkout_resume.v1";
+    mode: "one_time" | "subscription" | null;
+    cadenceDays: number | null;
+    cart: {
+        items: Array<{
+            sku: string;
+            productSlug: string | null;
+            variantId: string | null;
+            quantity: number;
+        }>;
+    };
+    completion: Completion;
+    redactedFields: RedactedField[];
+}
+export interface CheckoutResumeDraft<Section extends string, State> {
+    id: string;
+    contractVersion: "commerce.checkout_resume.v1";
+    lastSectionId: Section;
+    draftState: State;
+    expiresAt: string;
+    createdAt: string;
+    updatedAt: string;
+    replayed: boolean;
+}
+export interface CommerceCustomerDefaultsSnapshot<Scope, Method> {
+    version: "commerce.customer_defaults_snapshot.v1";
+    clientId: string;
+    payment: {
+        available: boolean;
+        scope: Scope | null;
+        methodKind: Method | null;
+        source: "customer_payment_preferences";
+        applied: false;
+    };
+    addresses: {
+        hasDefaultShippingAddress: boolean;
+        defaultShippingAddressId: string | null;
+        hasDefaultBillingAddress: boolean;
+        defaultBillingAddressId: string | null;
+        hasDefaultOrdererProfile: boolean;
+        defaultOrdererProfileId: string | null;
+        hasDeliveryNotes: boolean;
+        hasCourierInstructions: boolean;
+        source: "customer_address_profiles";
+        applied: false;
+    };
+    redactedFields: Array<"contact" | "orderer_profile" | "shipping_address" | "billing_address" | "delivery_notes" | "courier_instructions" | "payment_provider" | "payment_secret">;
+}

package/dist/commerce/contracts/intent.js

@@ -0,0 +1 @@
+export {};