@wocart/storefront 0.0.0-stage → 1.0.0

package/dist/schemas.js

@@ -0,0 +1,377 @@
+import { z } from "zod";
+export const ProductImageSchema = z.object({
+    id: z.string(),
+    src: z.string().url(),
+    srcSm: z.string().url().nullable(),
+    srcMd: z.string().url().nullable(),
+    srcLg: z.string().url().nullable(),
+    altText: z.string().nullable(),
+    position: z.number().int().min(0),
+});
+export const ProductVariantSchema = z.object({
+    id: z.string(),
+    productId: z.string(),
+    variations: z.record(z.string(), z.string()),
+    currency: z.string(),
+    price: z.number().int().min(0),
+    compareAtPrice: z.number().int().min(0).nullable(),
+    sku: z.string().nullable(),
+    barcode: z.string().nullable(),
+    inventory: z.number().int().min(0),
+    lowStockThreshold: z.number().int().min(0),
+    weightKg: z.number().min(0).nullable(),
+    imageId: z.string().nullable(),
+    isDefault: z.boolean(),
+    active: z.boolean(),
+    position: z.number().int().min(0),
+    createdAt: z.string().datetime(),
+    updatedAt: z.string().datetime(),
+});
+export const OfferSchema = z.object({
+    id: z.string(),
+    name: z.string(),
+    discountType: z.enum(["free", "free_shipping"]),
+    triggerQuantity: z.number().int(),
+    triggerVariantId: z.string().nullable(),
+    rewardQuantity: z.number().int(),
+    rewardProductId: z.string().nullable(),
+    rewardProductName: z.string(),
+    rewardVariantId: z.string().nullable(),
+    rewardVariantLabel: z.string().nullable(),
+});
+const productCategorySchema = z.object({
+    id: z.string(),
+    name: z.string(),
+    slug: z.string(),
+    description: z.string().nullable(),
+    parentId: z.string().nullable(),
+    imageUrl: z.string().url().nullable(),
+    metaTitle: z.string().nullable(),
+    metaDescription: z.string().nullable(),
+    metaKeywords: z.string().nullable(),
+    position: z.number().int().min(0),
+    createdAt: z.string().datetime(),
+    updatedAt: z.string().datetime(),
+});
+export const CategorySchema = productCategorySchema;
+const reviewStatsSchema = z.object({
+    avgRating: z.number(),
+    reviewCount: z.number().int(),
+});
+const productBaseFields = {
+    id: z.string(),
+    name: z.string(),
+    description: z.string().nullable(),
+    descriptionFormat: z.enum(["text", "html"]),
+    descriptionPlain: z.string().nullable(),
+    handle: z.string(),
+    currency: z.string(),
+    price: z.number(),
+    compareAtPrice: z.number().nullable(),
+    costPrice: z.number().nullable(),
+    type: z.enum(["PHYSICAL", "DIGITAL"]),
+    hasVariants: z.boolean(),
+    sku: z.string().nullable(),
+    inventory: z.number().int(),
+    trackInventory: z.boolean(),
+    lowStockThreshold: z.number().int(),
+    categoryId: z.string().nullable(),
+    visibility: z.boolean(),
+    status: z.enum(["DRAFT", "ACTIVE", "ARCHIVED"]),
+    showInStore: z.boolean(),
+    storeFeatured: z.boolean(),
+    deletedAt: z.string().datetime().nullable(),
+    publishedAt: z.string().datetime().nullable(),
+    createdAt: z.string().datetime(),
+    updatedAt: z.string().datetime(),
+    shippingProfileId: z.string().nullable().optional(),
+};
+const variantOptionSchema = z.object({
+    name: z.string(),
+    values: z.array(z.object({
+        value: z.string(),
+        // The key may be ABSENT, not just null: rows written before the colour
+        // picker existed never carry it, and a strict `.nullable()` would reject
+        // the whole product, since a failed read degrades to null. Normalising to
+        // null keeps the public shape `string | null` for every consumer.
+        hexColor: z.string().nullable().default(null),
+    })),
+});
+const rawProductFields = {
+    ...productBaseFields,
+    variantOptions: z.string().nullable(),
+    tags: z.string().nullable(),
+    coverImage: ProductImageSchema.nullable(),
+    reviewStats: reviewStatsSchema.nullable(),
+};
+export const ProductListSchema = z.object(rawProductFields);
+export const ProductSchema = z.object({
+    ...productBaseFields,
+    variantOptions: z.array(variantOptionSchema).nullable(),
+    tags: z.array(z.string()),
+    category: productCategorySchema.nullable(),
+    variants: z.array(ProductVariantSchema),
+    images: z.array(ProductImageSchema),
+    reviewStats: reviewStatsSchema.nullable(),
+    offers: z.array(OfferSchema),
+});
+export const StorePagePublicSchema = z.object({
+    id: z.string(),
+    kind: z.enum(["terms", "privacy", "refund", "shipping", "custom"]),
+    slug: z.string(),
+    locale: z.string(),
+    title: z.string(),
+    bodyHtml: z.string(),
+    metaTitle: z.string().nullable(),
+    metaDescription: z.string().nullable(),
+});
+/**
+ * The persisted theme page document (PageData): the
+ * TRANSPORT shape only. `sections` stays `unknown[]` so instances of a newer
+ * document reach the theme verbatim; the theme SDK's `parsePageData` owns the
+ * semantics (version, component types, props).
+ *
+ * **Loose on purpose**: unknown top-level keys must
+ * survive the transport, or a document's metadata would be destroyed before the
+ * theme SDK ever sees it.
+ */
+export const PageDocumentPayloadSchema = z.looseObject({
+    version: z.number().int(),
+    surface: z.string(),
+    sections: z.array(z.unknown()),
+});
+export const StorePageLinkSchema = z.object({
+    id: z.string(),
+    kind: z.enum(["terms", "privacy", "refund", "shipping", "custom"]),
+    slug: z.string(),
+    title: z.string(),
+    position: z.number().int(),
+});
+export const StoreLegalContactSchema = z.object({
+    contactEmail: z.string().nullable(),
+    contactPhone: z.string().nullable(),
+    deliveryMinDays: z.number().int(),
+    deliveryMaxDays: z.number().int(),
+});
+export const StoreWhatsAppWidgetSchema = z.object({
+    href: z.string(),
+    agentName: z.string().nullable(),
+    caption: z.string().nullable(),
+    avatarUrl: z.string().nullable(),
+    welcomeMessage: z.string().nullable(),
+    launcherLabel: z.string().nullable(),
+    ctaLabel: z.string().nullable(),
+    prefillGeneral: z.string().nullable(),
+    prefillProduct: z.string().nullable(),
+    thankYouButtonLabel: z.string().nullable().default(null),
+    prefillThankYou: z.string().nullable().default(null),
+    accent: z.enum(["whatsapp", "primary"]),
+    position: z.enum(["right", "left"]),
+    attention: z.boolean(),
+    surfaces: z.object({
+        home: z.boolean(),
+        catalog: z.boolean(),
+        product: z.boolean(),
+        pages: z.boolean(),
+        thankYou: z.boolean(),
+        checkout: z.boolean(),
+        landing: z.boolean(),
+    }),
+});
+export const CheckoutFormCustomFieldSchema = z.object({
+    id: z.string(),
+    label: z.string(),
+    type: z.enum(["text", "textarea", "number", "select"]),
+    required: z.boolean(),
+    options: z.array(z.string()).optional(),
+});
+export const CheckoutFormPolicySchema = z.object({
+    address: z.enum(["required", "optional", "hidden"]),
+    notes: z.enum(["optional", "hidden"]),
+    email: z.enum(["required", "optional", "hidden"]),
+    deliveryOptions: z.object({ home: z.boolean(), stopDesk: z.boolean() }),
+    customFields: z.array(CheckoutFormCustomFieldSchema),
+});
+export const StorefrontLanguageSchema = z.object({
+    code: z.string().min(1),
+    nativeName: z.string(),
+    direction: z.enum(["rtl", "ltr"]),
+});
+export const StoreConfigSchema = z.object({
+    id: z.string(),
+    name: z.string(),
+    domain: z.string().nullable(),
+    logoUrl: z.string().nullable(),
+    themeId: z.string(),
+    primaryColor: z.string(),
+    accentColor: z.string(),
+    bgColor: z.string(),
+    fontFamily: z.string(),
+    fontUrl: z.string().nullable(),
+    lang: z.string().min(1),
+    locale: z.string().min(1),
+    /**
+     * The published languages, primary first. Codes are open strings: the
+     * server owns which languages exist, so a new one never fails this parse.
+     */
+    locales: z.array(StorefrontLanguageSchema),
+    /** The requesting theme's text edits, one map per published language. */
+    contentOverrides: z.record(z.string(), z.record(z.string(), z.string())),
+    currency: z.string(),
+    currencySymbol: z.string(),
+    metaTitle: z.string().nullable(),
+    metaDescription: z.string().nullable(),
+    ogImage: z.string().nullable(),
+    announcementBar: z.string().nullable(),
+    reviewsEnabled: z.boolean(),
+    cartEnabled: z.boolean(),
+    freeShippingThreshold: z.number().int().nullable(),
+    cartShippingMode: z.enum(["highest", "default_profile"]).default("highest"),
+    otpEnabled: z.boolean(),
+    turnstileEnabled: z.boolean(),
+    turnstileSiteKey: z.string().nullable(),
+    status: z.enum(["active", "inactive"]),
+    createdAt: z.string().optional().default(() => new Date().toISOString()),
+    updatedAt: z.string().optional().default(() => new Date().toISOString()),
+    checkoutForm: CheckoutFormPolicySchema.default({
+        address: "optional",
+        notes: "optional",
+        email: "optional",
+        deliveryOptions: { home: true, stopDesk: true },
+        customFields: [],
+    }),
+    pixelId: z.string().nullable().default(null),
+    conversionEvent: z
+        .enum(["Purchase", "Purchase_Confirmed", "Purchase_Delivered", "Lead"])
+        .default("Purchase"),
+    pages: z.array(StorePageLinkSchema).default([]),
+    legalContact: StoreLegalContactSchema.nullable().default(null),
+    whatsapp: StoreWhatsAppWidgetSchema.nullable().default(null),
+});
+export const LandingPageImageSchema = z.object({
+    id: z.string(),
+    src: z.string(),
+    altText: z.string().nullable(),
+    position: z.number().int(),
+    width: z.number().int().nullable().default(null),
+    height: z.number().int().nullable().default(null),
+});
+export const LandingPageSchema = z.object({
+    id: z.string(),
+    slug: z.string(),
+    name: z.string(),
+    status: z.enum(["draft", "published", "archived"]),
+    imageGap: z.number().int(),
+    metaTitle: z.string().nullable(),
+    metaDescription: z.string().nullable(),
+    publishedAt: z.string().nullable(),
+    images: z.array(LandingPageImageSchema),
+    product: ProductSchema.nullable(),
+    tracking: z.object({
+        pixelId: z.string().nullable(),
+        conversionEvent: z.enum([
+            "Lead",
+            "Purchase",
+            "Purchase_Confirmed",
+            "Purchase_Delivered",
+        ]),
+    }),
+});
+export const WilayaRatesSchema = z.object({
+    home: z.number(),
+    stopDesk: z.number(),
+});
+export const ShippingRatesSchema = z.record(z.string(), WilayaRatesSchema);
+export const CommuneSchema = z.object({
+    id: z.string(),
+    name: z.string(),
+    nameAr: z.string(),
+});
+export const CartValidationLineSchema = z.object({
+    productId: z.string(),
+    variantId: z.string().nullable(),
+    variantLabel: z.string().nullable(),
+    productName: z.string(),
+    quantity: z.number().int(),
+    unitPrice: z.number(),
+    lineTotal: z.number(),
+    maxQuantity: z.number().nullable(),
+    blocker: z.enum(["missing", "unlisted", "out_of_stock"]).nullable(),
+});
+export const CartRewardSchema = z.object({
+    offerId: z.string(),
+    productId: z.string().nullable(),
+    productName: z.string().nullable(),
+    quantity: z.number().int(),
+});
+export const CartValidationSchema = z.object({
+    lines: z.array(CartValidationLineSchema),
+    subtotal: z.number(),
+    rewards: z.array(CartRewardSchema),
+    freeDelivery: z.object({
+        fromOffer: z.boolean(),
+        threshold: z.number().nullable(),
+        qualified: z.boolean(),
+        remaining: z.number(),
+    }),
+});
+export const CreatedOrderSchema = z.object({
+    orderId: z.string(),
+    orderNumber: z.string(),
+    price: z.number(),
+    deliveryFee: z.number(),
+    total: z.number(),
+});
+export const OrderTrackingSchema = z.object({
+    pixelId: z.string().nullable(),
+    event: z.enum(["Purchase", "Lead"]).nullable(),
+});
+/**
+ * The `{ id }` success payload of the write endpoints that only mint a row:
+ * POST /store/reviews and POST /store/abandoned.
+ */
+export const IdResponseSchema = z.object({
+    id: z.string(),
+});
+export const OtpSendResultSchema = z.discriminatedUnion("status", [
+    z.object({
+        status: z.literal("sent"),
+        requestId: z.string(),
+        expiresAt: z.number(),
+        maxAttempts: z.number(),
+    }),
+    z.object({
+        status: z.literal("unavailable"),
+        reason: z.string(),
+        bypassToken: z.string(),
+    }),
+]);
+export const OtpVerifyResultSchema = z.object({
+    status: z.literal("verified"),
+    otpToken: z.string(),
+});
+export const ReviewSchema = z.preprocess((raw) => {
+    if (typeof raw === "object" && raw !== null) {
+        const obj = raw;
+        return {
+            ...obj,
+            customerName: obj.customerName ?? obj.authorName ?? "Customer",
+        };
+    }
+    return raw;
+}, z.object({
+    id: z.string(),
+    customerName: z.string(),
+    rating: z.number(),
+    title: z.string().nullable().optional().default(null),
+    body: z.string(),
+    createdAt: z.string(),
+}));
+/**
+ * GET /store/reviews answers `{ success, data: rows, count, total }` — the
+ * total lives OUTSIDE `data`, so a caller that reads only `data` loses it.
+ */
+export const ReviewListEnvelopeSchema = z.object({
+    data: z.array(ReviewSchema),
+    total: z.number().int(),
+});

package/dist/server.d.ts

@@ -0,0 +1,4 @@
+export { createStoreClient } from "./client/index.js";
+export type { StoreClient } from "./client/index.js";
+export type { ClientResult } from "./client/core.js";
+export { StorefrontError, isStorefrontError } from "./client/errors.js";

package/dist/server.js

@@ -0,0 +1,2 @@
+export { createStoreClient } from "./client/index.js";
+export { StorefrontError, isStorefrontError } from "./client/errors.js";