@asteby/storefront 0.0.0-stage → 0.1.0

package/dist/types-BdaQ9Pxq.d.cts

@@ -0,0 +1,375 @@
+/**
+ * Storefront API v1 contract types.
+ *
+ * Field names match the wire format exactly (snake_case). Money amounts are
+ * decimal strings ("1899.00") so no precision is lost in transit.
+ */
+type Money = {
+    amount: string;
+    currency_code: string;
+};
+type Image = {
+    url: string;
+    alt: string | null;
+    width?: number;
+    height?: number;
+};
+type SEO = {
+    title: string | null;
+    description: string | null;
+};
+type PageInfo = {
+    has_next_page: boolean;
+    end_cursor: string | null;
+};
+type Connection<T> = {
+    nodes: T[];
+    page_info: PageInfo;
+    total_count?: number;
+};
+type ProductOption = {
+    name: string;
+    values: string[];
+};
+type SelectedOption = {
+    name: string;
+    value: string;
+};
+type ProductVariant = {
+    id: string;
+    sku: string;
+    title: string;
+    selected_options: SelectedOption[];
+    price: Money;
+    compare_at_price: Money | null;
+    available_for_sale: boolean;
+    quantity_available: number | null;
+    image: Image | null;
+    barcode: string | null;
+};
+type ProductAttributeValue = string | number | boolean;
+type ProductCategory = {
+    id: string;
+    handle: string;
+    title: string;
+};
+type MoneyRange = {
+    min: Money;
+    max: Money;
+};
+type Product = {
+    id: string;
+    handle: string;
+    title: string;
+    description: string;
+    /** HTML sanitized server-side. */
+    description_html: string;
+    /** Brand. */
+    vendor: string | null;
+    product_type: string | null;
+    category: ProductCategory | null;
+    tags: string[];
+    /** Free-form typed attributes, e.g. tire specs: width, aspect, rim, size_key. */
+    attributes: Record<string, ProductAttributeValue>;
+    featured_image: Image | null;
+    images: Image[];
+    options: ProductOption[];
+    variants: ProductVariant[];
+    price_range: MoneyRange;
+    compare_at_price_range: MoneyRange | null;
+    available_for_sale: boolean;
+    seo: SEO;
+    /** RFC 3339. */
+    updated_at: string;
+};
+type Collection = {
+    id: string;
+    handle: string;
+    title: string;
+    description: string;
+    image: Image | null;
+    seo: SEO;
+    parent_handle: string | null;
+};
+type FacetValue = {
+    value: string;
+    label: string;
+    count: number;
+};
+type Facet = {
+    key: string;
+    label: string;
+    type: 'list' | 'price_range';
+    values: FacetValue[];
+};
+type ProductSort = 'relevance' | 'price_asc' | 'price_desc' | 'newest' | 'title_asc';
+type ProductConnection = Connection<Product> & {
+    facets: Facet[];
+};
+type StockLevel = {
+    sku: string;
+    quantity_available: number;
+};
+type ShopContact = {
+    email: string | null;
+    phone: string | null;
+    whatsapp: string | null;
+};
+type ShopBranch = {
+    id: string;
+    name: string;
+    address: string;
+    city: string;
+    phone: string | null;
+    lat: number | null;
+    lng: number | null;
+    hours: string | null;
+};
+type ShopPolicies = {
+    free_shipping_min: Money | null;
+    returns_days: number | null;
+};
+type Shop = {
+    name: string;
+    description: string | null;
+    domain: string | null;
+    currency_code: string;
+    locale: string;
+    locales: string[];
+    country_code: string;
+    logo: Image | null;
+    contact: ShopContact;
+    branches: ShopBranch[];
+    policies: ShopPolicies;
+};
+/**
+ * Postal address. The contract references `Address` without spelling it out;
+ * this is the shape the client sends and the mock returns.
+ */
+type Address = {
+    /** Present on saved customer addresses. */
+    id?: string;
+    first_name: string | null;
+    last_name: string | null;
+    company: string | null;
+    address1: string;
+    address2: string | null;
+    city: string;
+    province: string | null;
+    zip: string;
+    country_code: string;
+    phone: string | null;
+};
+type AddressInput = Partial<Omit<Address, 'id' | 'address1' | 'city' | 'zip' | 'country_code'>> & Pick<Address, 'address1' | 'city' | 'zip' | 'country_code'>;
+type CartLineMerchandise = ProductVariant & {
+    product: Pick<Product, 'handle' | 'title' | 'featured_image'>;
+};
+type CartLine = {
+    id: string;
+    quantity: number;
+    merchandise: CartLineMerchandise;
+    cost: {
+        total: Money;
+        unit: Money;
+        compare_at_unit: Money | null;
+    };
+};
+type CartDiscountCode = {
+    code: string;
+    applicable: boolean;
+};
+type CartBuyer = {
+    email: string | null;
+    phone: string | null;
+    customer_id: string | null;
+};
+type DeliveryMethod = 'shipping' | 'pickup';
+type CartDelivery = {
+    method: DeliveryMethod | null;
+    rate_id: string | null;
+    branch_id: string | null;
+};
+type CartCost = {
+    subtotal: Money;
+    discount: Money;
+    shipping: Money | null;
+    tax: Money | null;
+    total: Money;
+    tax_included: boolean;
+};
+type Cart = {
+    id: string;
+    lines: CartLine[];
+    total_quantity: number;
+    discount_codes: CartDiscountCode[];
+    buyer: CartBuyer;
+    shipping_address: Address | null;
+    delivery: CartDelivery;
+    cost: CartCost;
+    updated_at: string;
+};
+type CartLineInput = {
+    variant_id: string;
+    quantity: number;
+};
+type CartLineUpdateInput = {
+    id: string;
+    quantity: number;
+};
+type CartBuyerInput = {
+    email?: string | null;
+    phone?: string | null;
+};
+type ShippingRate = {
+    id: string;
+    title: string;
+    cost: Money;
+    eta: string | null;
+};
+type PickupOption = {
+    branch_id: string;
+    name: string;
+};
+type DeliveryOptions = {
+    rates: ShippingRate[];
+    pickup: PickupOption[];
+};
+type DeliveryInput = {
+    method: DeliveryMethod;
+    rate_id?: string;
+    branch_id?: string;
+};
+type InvoiceRequest = {
+    rfc?: string;
+    legal_name?: string;
+    tax_regime?: string;
+    zip?: string;
+    cfdi_use?: string;
+    email?: string;
+    [key: string]: unknown;
+};
+type CheckoutInput = {
+    payment_method: string;
+    invoice?: InvoiceRequest;
+    return_url: string;
+};
+type CheckoutPayment = {
+    provider: string;
+    status: string;
+    redirect_url?: string | null;
+    client_secret?: string | null;
+};
+type CheckoutResult = {
+    order: {
+        id: string;
+        number: string;
+    };
+    payment: CheckoutPayment;
+};
+type Customer = {
+    id: string;
+    email: string | null;
+    phone: string | null;
+    first_name: string | null;
+    last_name: string | null;
+    default_address_id: string | null;
+    created_at: string;
+};
+type CustomerIdentifier = {
+    email: string;
+    phone?: never;
+} | {
+    phone: string;
+    email?: never;
+};
+type CustomerSessionInput = CustomerIdentifier & {
+    code: string;
+};
+type CustomerSession = {
+    token: string;
+    expires_at: string;
+    customer: Customer;
+};
+type OrderLine = {
+    title: string;
+    variant_title: string | null;
+    sku: string | null;
+    quantity: number;
+    unit: Money;
+    total: Money;
+    image: Image | null;
+};
+type Order = {
+    id: string;
+    number: string;
+    status: string;
+    created_at: string;
+    total: Money;
+    lines: OrderLine[];
+};
+type ReturnRequestInput = {
+    lines: {
+        sku: string;
+        quantity: number;
+    }[];
+    reason?: string;
+};
+type ReturnRequest = {
+    id: string;
+    order_id: string;
+    status: string;
+};
+type InvoiceResult = {
+    status: string;
+    url?: string | null;
+};
+type Theme = {
+    /** Design tokens, e.g. `{ primary: '#0f766e', 'primary-foreground': '#ffffff' }`. */
+    tokens: Record<string, string>;
+    /** Font roles, e.g. `{ heading: 'Inter', body: 'Inter' }`. */
+    fonts: Record<string, string>;
+    /** Base radius as a CSS length, e.g. `0.5rem`. */
+    radius: string;
+};
+type Section<P extends Record<string, unknown> = Record<string, unknown>> = {
+    id: string;
+    type: string;
+    props: P;
+};
+type Page = {
+    handle: string;
+    title: string;
+    seo: SEO;
+    sections: Section[];
+};
+type MenuItem = {
+    title: string;
+    url: string;
+    items?: MenuItem[];
+};
+type Menu = {
+    handle?: string;
+    items: MenuItem[];
+};
+type Article = {
+    id: string;
+    handle: string;
+    title: string;
+    excerpt: string | null;
+    content_html: string;
+    image: Image | null;
+    author: string | null;
+    tags: string[];
+    published_at: string;
+    seo: SEO;
+};
+type StorefrontErrorCode = 'validation' | 'unauthorized' | 'forbidden' | 'not_found' | 'conflict' | 'insufficient_stock' | 'price_mismatch' | 'invalid_state' | 'rate_limited' | 'not_modified' | 'server_error' | 'network' | 'timeout' | 'aborted' | 'invalid_response' | (string & {});
+type StorefrontErrorBody = {
+    error: {
+        code: StorefrontErrorCode;
+        message: string;
+        field?: string;
+    };
+};
+
+export type { ShopBranch as $, Address as A, Money as B, Cart as C, DeliveryInput as D, MoneyRange as E, Facet as F, OrderLine as G, PageInfo as H, Image as I, PickupOption as J, Product as K, ProductAttributeValue as L, Menu as M, ProductCategory as N, Order as O, Page as P, ProductConnection as Q, ProductOption as R, ProductSort as S, ProductVariant as T, ReturnRequest as U, ReturnRequestInput as V, SEO as W, Section as X, SelectedOption as Y, ShippingRate as Z, Shop as _, AddressInput as a, ShopContact as a0, ShopPolicies as a1, StockLevel as a2, StorefrontErrorBody as a3, StorefrontErrorCode as a4, Theme as a5, Article as b, CartBuyer as c, CartBuyerInput as d, CartCost as e, CartDelivery as f, CartDiscountCode as g, CartLine as h, CartLineInput as i, CartLineMerchandise as j, CartLineUpdateInput as k, CheckoutInput as l, CheckoutPayment as m, CheckoutResult as n, Collection as o, Connection as p, Customer as q, CustomerIdentifier as r, CustomerSession as s, CustomerSessionInput as t, DeliveryMethod as u, DeliveryOptions as v, FacetValue as w, InvoiceRequest as x, InvoiceResult as y, MenuItem as z };