@thorprovider/blocks 0.1.0

package/dist/contracts.d.mts

@@ -0,0 +1,563 @@
+import { z } from 'zod';
+import { Money, ProductPreview, PaymentMethod } from '@thorprovider/types';
+
+/**
+ * Serialization contracts for spec-driven storefronts.
+ *
+ * These Zod schemas are the *serializable subset* of what a spec may write for
+ * a block. The component keeps its rich React interface; the catalog/registry
+ * is the adapter that maps these props to real component props and binds
+ * callbacks (see storefronts-on-blocks design D3). `z.infer` is the typed
+ * boundary between spec and catalog — a prop outside the schema is a compile
+ * error, not a runtime surprise.
+ *
+ * Data shapes are projections of the @thorprovider/types canon so that
+ * @thorprovider/adapters output validates without conflict:
+ * - Prices are plain numbers here while the canon `Money` is a decimal string
+ *   ({ amount: "45.00", currencyCode }). The projection happens at the
+ *   loader boundary.
+ * - Blocks use `title` while the canon `ProductPreview` uses `name`. Reconcile
+ *   via the canonical aliases below or the catalog/loader adapter.
+ */
+type CanonMoney = Money;
+type CanonProduct = ProductPreview;
+/**
+ * Fallback data-URI for required image fields when the data source has no
+ * image. Image fields are non-optional `z.string()` in these contracts, so the
+ * boundary must never emit `""` (React warns about `src=""`); it must emit a
+ * real, renderable value. Hosts may override with their own branded fallback
+ * (e.g. electrostore's `CATEGORY_IMAGE_FALLBACK`), but blocks ship a neutral
+ * one so direct consumers are safe by default.
+ */
+declare const PRODUCT_IMAGE_FALLBACK: string;
+declare const cardProductSchema: z.ZodObject<{
+    id: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+    title: z.ZodString;
+    price: z.ZodNumber;
+    originalPrice: z.ZodOptional<z.ZodNumber>;
+    image: z.ZodString;
+    badge: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    title: string;
+    image: string;
+    id: string | number;
+    price: number;
+    badge?: string | undefined;
+    originalPrice?: number | undefined;
+}, {
+    title: string;
+    image: string;
+    id: string | number;
+    price: number;
+    badge?: string | undefined;
+    originalPrice?: number | undefined;
+}>;
+type CardProduct = z.infer<typeof cardProductSchema>;
+declare const cartItemSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    price: z.ZodNumber;
+    quantity: z.ZodNumber;
+    image: z.ZodString;
+    variant: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    image: string;
+    id: string;
+    name: string;
+    price: number;
+    quantity: number;
+    variant?: string | undefined;
+}, {
+    image: string;
+    id: string;
+    name: string;
+    price: number;
+    quantity: number;
+    variant?: string | undefined;
+}>;
+type CartItem = z.infer<typeof cartItemSchema>;
+declare const recentlyViewedItemSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    price: z.ZodNumber;
+    image: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    image: string;
+    id: string;
+    name: string;
+    price: number;
+}, {
+    image: string;
+    id: string;
+    name: string;
+    price: number;
+}>;
+type RecentlyViewedItem = z.infer<typeof recentlyViewedItemSchema>;
+declare const promotionSchema: z.ZodObject<{
+    threshold: z.ZodNumber;
+    reward: z.ZodString;
+    icon: z.ZodDefault<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    icon: string;
+    threshold: number;
+    reward: string;
+}, {
+    threshold: number;
+    reward: string;
+    icon?: string | undefined;
+}>;
+type Promotion = z.infer<typeof promotionSchema>;
+declare const storeCategorySchema: z.ZodType<StoreCategory>;
+type StoreCategory = {
+    label: string;
+    href: string;
+    children?: StoreCategory[];
+    emphasis?: boolean;
+};
+declare const utilityLinkSchema: z.ZodObject<{
+    label: z.ZodString;
+    href: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    label: string;
+    href: string;
+}, {
+    label: string;
+    href: string;
+}>;
+type UtilityLink = z.infer<typeof utilityLinkSchema>;
+declare const navCartItemSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    variant: z.ZodString;
+    price: z.ZodNumber;
+    qty: z.ZodNumber;
+    image: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    variant: string;
+    image: string;
+    id: string;
+    name: string;
+    price: number;
+    qty: number;
+}, {
+    variant: string;
+    image: string;
+    id: string;
+    name: string;
+    price: number;
+    qty: number;
+}>;
+type NavCartItem = z.infer<typeof navCartItemSchema>;
+declare const storeUserSchema: z.ZodObject<{
+    name: z.ZodString;
+    email: z.ZodString;
+    avatar: z.ZodString;
+    initials: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    email: string;
+    name: string;
+    avatar: string;
+    initials: string;
+}, {
+    email: string;
+    name: string;
+    avatar: string;
+    initials: string;
+}>;
+type StoreUser = z.infer<typeof storeUserSchema>;
+declare const accountMenuItemSchema: z.ZodObject<{
+    label: z.ZodString;
+    href: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    icon: z.ZodOptional<z.ZodEnum<["orders", "wishlist", "addresses", "settings"]>>;
+}, "strip", z.ZodTypeAny, {
+    label: string;
+    href: string;
+    icon?: "orders" | "wishlist" | "addresses" | "settings" | undefined;
+    description?: string | undefined;
+}, {
+    label: string;
+    href: string;
+    icon?: "orders" | "wishlist" | "addresses" | "settings" | undefined;
+    description?: string | undefined;
+}>;
+type AccountMenuItem = z.infer<typeof accountMenuItemSchema>;
+/**
+ * Serialization contract for a payment method offered at checkout.
+ *
+ * A projection of `@thorprovider/types` `PaymentMethod` — the storefront-facing
+ * shape produced by the adapters transform. Checkout blocks render the method
+ * list from this data instead of hardcoding providers.
+ */
+declare const paymentMethodSchema: z.ZodType<PaymentMethod>;
+declare const buttonPropsSchema: z.ZodObject<{
+    variant: z.ZodOptional<z.ZodEnum<["default", "destructive", "outline", "secondary", "ghost", "link"]>>;
+    size: z.ZodOptional<z.ZodEnum<["default", "xs", "sm", "lg", "icon", "icon-xs", "icon-sm", "icon-lg"]>>;
+    disabled: z.ZodOptional<z.ZodBoolean>;
+    className: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    variant?: "default" | "secondary" | "destructive" | "outline" | "ghost" | "link" | undefined;
+    className?: string | undefined;
+    size?: "default" | "xs" | "sm" | "lg" | "icon" | "icon-xs" | "icon-sm" | "icon-lg" | undefined;
+    disabled?: boolean | undefined;
+}, {
+    variant?: "default" | "secondary" | "destructive" | "outline" | "ghost" | "link" | undefined;
+    className?: string | undefined;
+    size?: "default" | "xs" | "sm" | "lg" | "icon" | "icon-xs" | "icon-sm" | "icon-lg" | undefined;
+    disabled?: boolean | undefined;
+}>;
+type ButtonSpecProps = z.infer<typeof buttonPropsSchema>;
+declare const storeContainer1PropsSchema: z.ZodObject<{
+    size: z.ZodOptional<z.ZodEnum<["default", "narrow", "wide", "full"]>>;
+    className: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    className?: string | undefined;
+    size?: "default" | "narrow" | "wide" | "full" | undefined;
+}, {
+    className?: string | undefined;
+    size?: "default" | "narrow" | "wide" | "full" | undefined;
+}>;
+type StoreContainer1SpecProps = z.infer<typeof storeContainer1PropsSchema>;
+declare const productCard1PropsSchema: z.ZodObject<{
+    products: z.ZodArray<z.ZodObject<{
+        id: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+        title: z.ZodString;
+        price: z.ZodNumber;
+        originalPrice: z.ZodOptional<z.ZodNumber>;
+        image: z.ZodString;
+        badge: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        title: string;
+        image: string;
+        id: string | number;
+        price: number;
+        badge?: string | undefined;
+        originalPrice?: number | undefined;
+    }, {
+        title: string;
+        image: string;
+        id: string | number;
+        price: number;
+        badge?: string | undefined;
+        originalPrice?: number | undefined;
+    }>, "many">;
+    heading: z.ZodOptional<z.ZodString>;
+    maxItems: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    products: {
+        title: string;
+        image: string;
+        id: string | number;
+        price: number;
+        badge?: string | undefined;
+        originalPrice?: number | undefined;
+    }[];
+    heading?: string | undefined;
+    maxItems?: number | undefined;
+}, {
+    products: {
+        title: string;
+        image: string;
+        id: string | number;
+        price: number;
+        badge?: string | undefined;
+        originalPrice?: number | undefined;
+    }[];
+    heading?: string | undefined;
+    maxItems?: number | undefined;
+}>;
+type ProductCard1SpecProps = z.infer<typeof productCard1PropsSchema>;
+declare const shoppingCart4PropsSchema: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        price: z.ZodNumber;
+        quantity: z.ZodNumber;
+        image: z.ZodString;
+        variant: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        image: string;
+        id: string;
+        name: string;
+        price: number;
+        quantity: number;
+        variant?: string | undefined;
+    }, {
+        image: string;
+        id: string;
+        name: string;
+        price: number;
+        quantity: number;
+        variant?: string | undefined;
+    }>, "many">;
+    promotions: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        threshold: z.ZodNumber;
+        reward: z.ZodString;
+        icon: z.ZodDefault<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        icon: string;
+        threshold: number;
+        reward: string;
+    }, {
+        threshold: number;
+        reward: string;
+        icon?: string | undefined;
+    }>, "many">>;
+    recentlyViewed: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        price: z.ZodNumber;
+        image: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        image: string;
+        id: string;
+        name: string;
+        price: number;
+    }, {
+        image: string;
+        id: string;
+        name: string;
+        price: number;
+    }>, "many">>;
+    taxRate: z.ZodOptional<z.ZodNumber>;
+    titleLabel: z.ZodOptional<z.ZodString>;
+    subtotalLabel: z.ZodOptional<z.ZodString>;
+    taxLabel: z.ZodOptional<z.ZodString>;
+    shippingLabel: z.ZodOptional<z.ZodString>;
+    shippingFreeLabel: z.ZodOptional<z.ZodString>;
+    totalLabel: z.ZodOptional<z.ZodString>;
+    awayFromLabel: z.ZodOptional<z.ZodString>;
+    activatedLabel: z.ZodOptional<z.ZodString>;
+    itemsLabel: z.ZodOptional<z.ZodString>;
+    expressCheckoutLabel: z.ZodOptional<z.ZodString>;
+    expressLabel: z.ZodOptional<z.ZodString>;
+    standardLabel: z.ZodOptional<z.ZodString>;
+    estimatedDeliveryLabel: z.ZodOptional<z.ZodString>;
+    secureCheckoutLabel: z.ZodOptional<z.ZodString>;
+    recentlyViewedLabel: z.ZodOptional<z.ZodString>;
+    collapseLabel: z.ZodOptional<z.ZodString>;
+    expandLabel: z.ZodOptional<z.ZodString>;
+    checkoutLabel: z.ZodOptional<z.ZodString>;
+    quickCheckoutLabel: z.ZodOptional<z.ZodString>;
+    checkoutNowLabel: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    items: {
+        image: string;
+        id: string;
+        name: string;
+        price: number;
+        quantity: number;
+        variant?: string | undefined;
+    }[];
+    promotions: {
+        icon: string;
+        threshold: number;
+        reward: string;
+    }[];
+    recentlyViewed?: {
+        image: string;
+        id: string;
+        name: string;
+        price: number;
+    }[] | undefined;
+    taxRate?: number | undefined;
+    titleLabel?: string | undefined;
+    subtotalLabel?: string | undefined;
+    taxLabel?: string | undefined;
+    shippingLabel?: string | undefined;
+    shippingFreeLabel?: string | undefined;
+    totalLabel?: string | undefined;
+    awayFromLabel?: string | undefined;
+    activatedLabel?: string | undefined;
+    itemsLabel?: string | undefined;
+    expressCheckoutLabel?: string | undefined;
+    expressLabel?: string | undefined;
+    standardLabel?: string | undefined;
+    estimatedDeliveryLabel?: string | undefined;
+    secureCheckoutLabel?: string | undefined;
+    recentlyViewedLabel?: string | undefined;
+    collapseLabel?: string | undefined;
+    expandLabel?: string | undefined;
+    checkoutLabel?: string | undefined;
+    quickCheckoutLabel?: string | undefined;
+    checkoutNowLabel?: string | undefined;
+}, {
+    items: {
+        image: string;
+        id: string;
+        name: string;
+        price: number;
+        quantity: number;
+        variant?: string | undefined;
+    }[];
+    promotions?: {
+        threshold: number;
+        reward: string;
+        icon?: string | undefined;
+    }[] | undefined;
+    recentlyViewed?: {
+        image: string;
+        id: string;
+        name: string;
+        price: number;
+    }[] | undefined;
+    taxRate?: number | undefined;
+    titleLabel?: string | undefined;
+    subtotalLabel?: string | undefined;
+    taxLabel?: string | undefined;
+    shippingLabel?: string | undefined;
+    shippingFreeLabel?: string | undefined;
+    totalLabel?: string | undefined;
+    awayFromLabel?: string | undefined;
+    activatedLabel?: string | undefined;
+    itemsLabel?: string | undefined;
+    expressCheckoutLabel?: string | undefined;
+    expressLabel?: string | undefined;
+    standardLabel?: string | undefined;
+    estimatedDeliveryLabel?: string | undefined;
+    secureCheckoutLabel?: string | undefined;
+    recentlyViewedLabel?: string | undefined;
+    collapseLabel?: string | undefined;
+    expandLabel?: string | undefined;
+    checkoutLabel?: string | undefined;
+    quickCheckoutLabel?: string | undefined;
+    checkoutNowLabel?: string | undefined;
+}>;
+type ShoppingCart4SpecProps = z.infer<typeof shoppingCart4PropsSchema>;
+declare const navbar4PropsSchema: z.ZodObject<{
+    storeCategories: z.ZodArray<z.ZodType<StoreCategory, z.ZodTypeDef, StoreCategory>, "many">;
+    shippingNote: z.ZodString;
+    utilityLinks: z.ZodArray<z.ZodObject<{
+        label: z.ZodString;
+        href: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        label: string;
+        href: string;
+    }, {
+        label: string;
+        href: string;
+    }>, "many">;
+    logoText: z.ZodString;
+    logoHref: z.ZodOptional<z.ZodString>;
+    accountHref: z.ZodOptional<z.ZodString>;
+    searchQuery: z.ZodOptional<z.ZodString>;
+    items: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        variant: z.ZodString;
+        price: z.ZodNumber;
+        qty: z.ZodNumber;
+        image: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        variant: string;
+        image: string;
+        id: string;
+        name: string;
+        price: number;
+        qty: number;
+    }, {
+        variant: string;
+        image: string;
+        id: string;
+        name: string;
+        price: number;
+        qty: number;
+    }>, "many">>;
+    user: z.ZodOptional<z.ZodObject<{
+        name: z.ZodString;
+        email: z.ZodString;
+        avatar: z.ZodString;
+        initials: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        email: string;
+        name: string;
+        avatar: string;
+        initials: string;
+    }, {
+        email: string;
+        name: string;
+        avatar: string;
+        initials: string;
+    }>>;
+    accountMenuItems: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        label: z.ZodString;
+        href: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        icon: z.ZodOptional<z.ZodEnum<["orders", "wishlist", "addresses", "settings"]>>;
+    }, "strip", z.ZodTypeAny, {
+        label: string;
+        href: string;
+        icon?: "orders" | "wishlist" | "addresses" | "settings" | undefined;
+        description?: string | undefined;
+    }, {
+        label: string;
+        href: string;
+        icon?: "orders" | "wishlist" | "addresses" | "settings" | undefined;
+        description?: string | undefined;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    logoText: string;
+    storeCategories: StoreCategory[];
+    utilityLinks: {
+        label: string;
+        href: string;
+    }[];
+    shippingNote: string;
+    logoHref?: string | undefined;
+    user?: {
+        email: string;
+        name: string;
+        avatar: string;
+        initials: string;
+    } | undefined;
+    items?: {
+        variant: string;
+        image: string;
+        id: string;
+        name: string;
+        price: number;
+        qty: number;
+    }[] | undefined;
+    accountHref?: string | undefined;
+    searchQuery?: string | undefined;
+    accountMenuItems?: {
+        label: string;
+        href: string;
+        icon?: "orders" | "wishlist" | "addresses" | "settings" | undefined;
+        description?: string | undefined;
+    }[] | undefined;
+}, {
+    logoText: string;
+    storeCategories: StoreCategory[];
+    utilityLinks: {
+        label: string;
+        href: string;
+    }[];
+    shippingNote: string;
+    logoHref?: string | undefined;
+    user?: {
+        email: string;
+        name: string;
+        avatar: string;
+        initials: string;
+    } | undefined;
+    items?: {
+        variant: string;
+        image: string;
+        id: string;
+        name: string;
+        price: number;
+        qty: number;
+    }[] | undefined;
+    accountHref?: string | undefined;
+    searchQuery?: string | undefined;
+    accountMenuItems?: {
+        label: string;
+        href: string;
+        icon?: "orders" | "wishlist" | "addresses" | "settings" | undefined;
+        description?: string | undefined;
+    }[] | undefined;
+}>;
+type Navbar4SpecProps = z.infer<typeof navbar4PropsSchema>;
+
+export { type AccountMenuItem, type ButtonSpecProps, type CanonMoney, type CanonProduct, type CardProduct, type CartItem, type NavCartItem, type Navbar4SpecProps, PRODUCT_IMAGE_FALLBACK, type ProductCard1SpecProps, type Promotion, type RecentlyViewedItem, type ShoppingCart4SpecProps, type StoreCategory, type StoreContainer1SpecProps, type StoreUser, type UtilityLink, accountMenuItemSchema, buttonPropsSchema, cardProductSchema, cartItemSchema, navCartItemSchema, navbar4PropsSchema, paymentMethodSchema, productCard1PropsSchema, promotionSchema, recentlyViewedItemSchema, shoppingCart4PropsSchema, storeCategorySchema, storeContainer1PropsSchema, storeUserSchema, utilityLinkSchema };