commerce-kit 0.0.40 → 0.1.0

package/dist/index.d.ts

@@ -1,10 +1,11 @@
-import { CartMetadata, MappedCart } from './internal.js';
-export { MappedProduct, MappedShippingRate } from './internal.js';
 import Stripe from 'stripe';
 import { z, TypeOf } from 'zod';
+import { CartMetadata, MappedCart } from './internal.js';
+export { MappedProduct, MappedShippingRate } from './internal.js';
+export { formatMoney } from './currencies.js';
 
-type Cart = NonNullable<Awaited<ReturnType<typeof cartGet>>>;
-type Order = NonNullable<Awaited<ReturnType<typeof orderGet>>>;
+type Cart$1 = NonNullable<Awaited<ReturnType<typeof cartGet>>>;
+type Order$1 = NonNullable<Awaited<ReturnType<typeof orderGet>>>;
 declare function cartAdd({ productId, cartId }: {
     productId: string;
     cartId?: string;
@@ -42,9 +43,9 @@ declare function cartGet(cartId: string): Promise<{
         customer: Stripe.Customer | null;
         payment_method: Stripe.PaymentMethod | null;
         taxBreakdown: {
+            taxType: Stripe.Tax.Calculation.TaxBreakdown.TaxRateDetails.TaxType | (string & {});
             taxPercentage: string;
             taxAmount: number;
-            taxType: Stripe.Tax.Calculation.TaxBreakdown.TaxRateDetails.TaxType | (string & {});
         }[];
         id: string;
         object: "payment_intent";
@@ -63,7 +64,7 @@ declare function cartGet(cartId: string): Promise<{
         created: number;
         currency: string;
         description: string | null;
-        invoice: string | Stripe.Invoice | null;
+        excluded_payment_method_types: Array<Stripe.PaymentIntent.ExcludedPaymentMethodType> | null;
         last_payment_error: Stripe.PaymentIntent.LastPaymentError | null;
         latest_charge: string | Stripe.Charge | null;
         livemode: boolean;
@@ -72,6 +73,7 @@ declare function cartGet(cartId: string): Promise<{
         payment_method_configuration_details: Stripe.PaymentIntent.PaymentMethodConfigurationDetails | null;
         payment_method_options: Stripe.PaymentIntent.PaymentMethodOptions | null;
         payment_method_types: Array<string>;
+        presentment_details?: Stripe.PaymentIntent.PresentmentDetails;
         processing: Stripe.PaymentIntent.Processing | null;
         receipt_email: string | null;
         review: string | Stripe.Review | null;
@@ -123,8 +125,8 @@ declare function cartCreate({ productId }?: {
     productId?: string;
     cartId?: string;
 }): Promise<Stripe.Response<Stripe.PaymentIntent>>;
-declare function cartAddOptimistic({ cart, add, }: {
-    cart?: Cart | null;
+declare function cartAddOptimistic({ cart, add }: {
+    cart?: Cart$1 | null;
     add: string | undefined;
 }): Promise<{
     cart: {
@@ -154,9 +156,9 @@ declare function cartAddOptimistic({ cart, add, }: {
         customer?: Stripe.Customer | null | undefined;
         payment_method?: Stripe.PaymentMethod | null | undefined;
         taxBreakdown?: {
+            taxType: Stripe.Tax.Calculation.TaxBreakdown.TaxRateDetails.TaxType | (string & {});
             taxPercentage: string;
             taxAmount: number;
-            taxType: Stripe.Tax.Calculation.TaxBreakdown.TaxRateDetails.TaxType | (string & {});
         }[] | undefined;
         id?: string | undefined;
         object?: "payment_intent" | undefined;
@@ -174,7 +176,7 @@ declare function cartAddOptimistic({ cart, add, }: {
         created?: number | undefined;
         currency?: string | undefined;
         description?: string | null | undefined;
-        invoice?: string | Stripe.Invoice | null | undefined;
+        excluded_payment_method_types?: Stripe.PaymentIntent.ExcludedPaymentMethodType[] | null | undefined;
         last_payment_error?: Stripe.PaymentIntent.LastPaymentError | null | undefined;
         latest_charge?: string | Stripe.Charge | null | undefined;
         livemode?: boolean | undefined;
@@ -183,6 +185,7 @@ declare function cartAddOptimistic({ cart, add, }: {
         payment_method_configuration_details?: Stripe.PaymentIntent.PaymentMethodConfigurationDetails | null | undefined;
         payment_method_options?: Stripe.PaymentIntent.PaymentMethodOptions | null | undefined;
         payment_method_types?: string[] | undefined;
+        presentment_details?: Stripe.PaymentIntent.PresentmentDetails;
         processing?: Stripe.PaymentIntent.Processing | null | undefined;
         receipt_email?: string | null | undefined;
         review?: string | Stripe.Review | null | undefined;
@@ -372,9 +375,9 @@ declare function orderGet(orderId: string): Promise<{
         payment_method: Stripe.PaymentMethod | null;
         latest_charge: Stripe.Charge | null;
         taxBreakdown: {
+            taxType: Stripe.Tax.Calculation.TaxBreakdown.TaxRateDetails.TaxType | (string & {});
             taxPercentage: string;
             taxAmount: number;
-            taxType: Stripe.Tax.Calculation.TaxBreakdown.TaxRateDetails.TaxType | (string & {});
         }[];
         metadata: {
             shippingRateId?: string | undefined;
@@ -416,7 +419,7 @@ declare function orderGet(orderId: string): Promise<{
         currency: string;
         customer: string | Stripe.Customer | Stripe.DeletedCustomer | null;
         description: string | null;
-        invoice: string | Stripe.Invoice | null;
+        excluded_payment_method_types: Array<Stripe.PaymentIntent.ExcludedPaymentMethodType> | null;
         last_payment_error: Stripe.PaymentIntent.LastPaymentError | null;
         livemode: boolean;
         next_action: Stripe.PaymentIntent.NextAction | null;
@@ -424,6 +427,7 @@ declare function orderGet(orderId: string): Promise<{
         payment_method_configuration_details: Stripe.PaymentIntent.PaymentMethodConfigurationDetails | null;
         payment_method_options: Stripe.PaymentIntent.PaymentMethodOptions | null;
         payment_method_types: Array<string>;
+        presentment_details?: Stripe.PaymentIntent.PresentmentDetails;
         processing: Stripe.PaymentIntent.Processing | null;
         receipt_email: string | null;
         review: string | Stripe.Review | null;
@@ -533,9 +537,9 @@ declare const getCartWithProductsById: (cartId: string) => Promise<{
         customer: Stripe.Customer | null;
         payment_method: Stripe.PaymentMethod | null;
         taxBreakdown: {
+            taxType: Stripe.Tax.Calculation.TaxBreakdown.TaxRateDetails.TaxType | (string & {});
             taxPercentage: string;
             taxAmount: number;
-            taxType: Stripe.Tax.Calculation.TaxBreakdown.TaxRateDetails.TaxType | (string & {});
         }[];
         id: string;
         object: "payment_intent";
@@ -554,7 +558,7 @@ declare const getCartWithProductsById: (cartId: string) => Promise<{
         created: number;
         currency: string;
         description: string | null;
-        invoice: string | Stripe.Invoice | null;
+        excluded_payment_method_types: Array<Stripe.PaymentIntent.ExcludedPaymentMethodType> | null;
         last_payment_error: Stripe.PaymentIntent.LastPaymentError | null;
         latest_charge: string | Stripe.Charge | null;
         livemode: boolean;
@@ -563,6 +567,7 @@ declare const getCartWithProductsById: (cartId: string) => Promise<{
         payment_method_configuration_details: Stripe.PaymentIntent.PaymentMethodConfigurationDetails | null;
         payment_method_options: Stripe.PaymentIntent.PaymentMethodOptions | null;
         payment_method_types: Array<string>;
+        presentment_details?: Stripe.PaymentIntent.PresentmentDetails;
         processing: Stripe.PaymentIntent.Processing | null;
         receipt_email: string | null;
         review: string | Stripe.Review | null;
@@ -648,29 +653,7 @@ declare const getAddressSchema: (tr: {
     phone: z.ZodDefault<z.ZodNullable<z.ZodOptional<z.ZodString>>>;
     taxId: z.ZodDefault<z.ZodNullable<z.ZodOptional<z.ZodString>>>;
     email: z.ZodDefault<z.ZodNullable<z.ZodOptional<z.ZodString>>>;
-}, "strip", z.ZodTypeAny, {
-    name: string;
-    taxId: string | null;
-    city: string;
-    country: string;
-    line1: string;
-    line2: string | null;
-    postalCode: string;
-    state: string | null;
-    phone: string | null;
-    email: string | null;
-}, {
-    name: string;
-    city: string;
-    country: string;
-    line1: string;
-    postalCode: string;
-    taxId?: string | null | undefined;
-    line2?: string | null | undefined;
-    state?: string | null | undefined;
-    phone?: string | null | undefined;
-    email?: string | null | undefined;
-}>;
+}, z.core.$strip>;
 type AddressSchema = TypeOf<ReturnType<typeof getAddressSchema>>;
 /**
  * @internal
@@ -763,7 +746,7 @@ declare function productReviewBrowse(params: {
     first?: number;
     last?: number;
     offset?: number;
-    filter?: {};
+    filter?: Record<string, never>;
 }): Promise<Review[] | null>;
 declare function productReviewAdd(params: {
     productId: string;
@@ -779,6 +762,369 @@ declare const contextGet: () => Promise<{
     publishableKey: string | undefined;
 }>;
 
+interface BaseProvider {
+    productBrowse(params: ProductBrowseParams): Promise<ProductBrowseResult>;
+    productGet(params: ProductGetParams): Promise<Product | null>;
+    productSearch?(params: ProductSearchParams): Promise<ProductSearchResult>;
+    cartAdd(params: CartAddParams): Promise<{
+        cartId: string;
+    }>;
+    cartUpdate(params: CartUpdateParams): Promise<{
+        cartId: string;
+    }>;
+    cartClear(params: CartClearParams): Promise<{
+        cartId: string;
+    }>;
+    cartGet(params: CartGetParams): Promise<Cart | null>;
+    orderGet?(params: OrderGetParams): Promise<Order | null>;
+    orderList?(params: OrderListParams): Promise<OrderListResult>;
+}
+interface StripeProviderConfig {
+    secretKey?: string;
+    tagPrefix?: string;
+}
+interface YnsProviderConfig {
+    endpoint: string;
+    token: string;
+}
+interface CommerceConfig {
+    provider: "stripe" | "yns";
+    stripe?: StripeProviderConfig;
+    yns?: YnsProviderConfig;
+}
+interface Product {
+    id: string;
+    name: string;
+    slug?: string;
+    summary?: string;
+    images: string[];
+    active: boolean;
+    price: number;
+    currency: string;
+    stock?: number;
+}
+interface Cart {
+    id: string;
+    customerId?: string;
+    items: CartItem[];
+    total: number;
+    currency: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface CartItem {
+    id: string;
+    productId: string;
+    variantId?: string;
+    quantity: number;
+    price: number;
+}
+interface Order {
+    id: string;
+    customerId?: string;
+    items: CartItem[];
+    total: number;
+    currency: string;
+    status: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface ProductBrowseParams {
+    first?: number;
+    offset?: number;
+    category?: string;
+    query?: string;
+    active?: boolean;
+    orderBy?: string;
+    orderDirection?: "asc" | "desc";
+    fields?: string[];
+    _provider?: "stripe" | "yns";
+}
+interface ProductGetParams {
+    slug?: string;
+    id?: string;
+    fields?: string[];
+    _provider?: "stripe" | "yns";
+}
+interface ProductSearchParams {
+    query: string;
+    limit?: number;
+    fields?: string[];
+    _provider?: "stripe" | "yns";
+}
+interface CartAddParams {
+    variantId: string;
+    cartId?: string;
+    quantity?: number;
+    subscriptionId?: string;
+    _provider?: "stripe" | "yns";
+}
+interface CartUpdateParams {
+    cartId: string;
+    variantId: string;
+    quantity: number;
+    _provider?: "stripe" | "yns";
+}
+interface CartClearParams {
+    cartId: string;
+    _provider?: "stripe" | "yns";
+}
+interface CartGetParams {
+    cartId: string;
+    _provider?: "stripe" | "yns";
+}
+interface OrderGetParams {
+    orderId: string;
+    _provider?: "stripe" | "yns";
+}
+interface OrderListParams {
+    customerId?: string;
+    limit?: number;
+    offset?: number;
+    _provider?: "stripe" | "yns";
+}
+interface ProductBrowseResult {
+    data: Product[];
+    meta: {
+        count: number;
+        offset: number;
+        limit: number;
+        hasMore: boolean;
+    };
+}
+interface ProductSearchResult {
+    data: Product[];
+    total: number;
+}
+interface OrderListResult {
+    data: Order[];
+    meta: {
+        count: number;
+        offset: number;
+        limit: number;
+        hasMore: boolean;
+    };
+}
+
+/**
+ * Configure the Commerce SDK with provider settings
+ */
+declare function configure(config: CommerceConfig): void;
+
+/**
+ * Cart resource operations
+ */
+declare const cart: {
+    /**
+     * Add item to cart
+     *
+     * @example
+     * ```typescript
+     * import { cart } from "commerce-kit";
+     *
+     * // Add to existing cart
+     * const result = await cart.add({
+     *   variantId: "variant_123",
+     *   cartId: "cart_abc",
+     *   quantity: 2
+     * });
+     *
+     * // Create new cart if no cartId provided
+     * const newCart = await cart.add({
+     *   variantId: "variant_456"
+     * });
+     *
+     * // Override provider
+     * const stripeCart = await cart.add({
+     *   variantId: "price_123",
+     *   cartId: "pi_456",
+     *   _provider: "stripe"
+     * });
+     * ```
+     */
+    add(params: CartAddParams): Promise<{
+        cartId: string;
+    }>;
+    /**
+     * Update item quantity in cart
+     *
+     * @example
+     * ```typescript
+     * import { cart } from "commerce-kit";
+     *
+     * // Update quantity
+     * const result = await cart.update({
+     *   cartId: "cart_123",
+     *   variantId: "variant_456",
+     *   quantity: 3
+     * });
+     *
+     * // Set quantity to 0 to remove item
+     * const removed = await cart.update({
+     *   cartId: "cart_123",
+     *   variantId: "variant_456",
+     *   quantity: 0
+     * });
+     * ```
+     */
+    update(params: CartUpdateParams): Promise<{
+        cartId: string;
+    }>;
+    /**
+     * Clear all items from cart
+     *
+     * @example
+     * ```typescript
+     * import { cart } from "commerce-kit";
+     *
+     * const result = await cart.clear({
+     *   cartId: "cart_123"
+     * });
+     * ```
+     */
+    clear(params: CartClearParams): Promise<{
+        cartId: string;
+    }>;
+    /**
+     * Get cart details with all items
+     *
+     * @example
+     * ```typescript
+     * import { cart } from "commerce-kit";
+     *
+     * const cartData = await cart.get({
+     *   cartId: "cart_123"
+     * });
+     *
+     * if (cartData) {
+     *   console.log(`Cart has ${cartData.items.length} items`);
+     *   console.log(`Total: ${cartData.total} ${cartData.currency}`);
+     * }
+     * ```
+     */
+    get(params: CartGetParams): Promise<Cart | null>;
+};
+
+/**
+ * Order resource operations
+ */
+declare const order: {
+    /**
+     * Get a single order by ID
+     *
+     * @example
+     * ```typescript
+     * import { order } from "commerce-kit";
+     *
+     * const orderData = await order.get({
+     *   orderId: "order_123"
+     * });
+     *
+     * if (orderData) {
+     *   console.log(`Order status: ${orderData.status}`);
+     *   console.log(`Order total: ${orderData.total} ${orderData.currency}`);
+     * }
+     * ```
+     */
+    get(params: OrderGetParams): Promise<Order | null>;
+    /**
+     * List orders with optional filtering and pagination
+     *
+     * @example
+     * ```typescript
+     * import { order } from "commerce-kit";
+     *
+     * // List all orders
+     * const orders = await order.list({
+     *   limit: 20,
+     *   offset: 0
+     * });
+     *
+     * // List orders for specific customer
+     * const customerOrders = await order.list({
+     *   customerId: "customer_123",
+     *   limit: 10
+     * });
+     *
+     * console.log(`Found ${orders.meta.count} orders`);
+     * ```
+     */
+    list(params?: OrderListParams): Promise<OrderListResult>;
+};
+
+/**
+ * Product resource operations
+ */
+declare const product: {
+    /**
+     * Browse/list products with optional filtering and pagination
+     *
+     * @example
+     * ```typescript
+     * import { product } from "commerce-kit";
+     *
+     * const products = await product.browse({
+     *   first: 10,
+     *   category: "electronics"
+     * });
+     *
+     * // With GraphQL field selection (YNS only)
+     * const productsWithFields = await product.browse({
+     *   first: 5,
+     *   fields: ["id", "name", "price", "images"]
+     * });
+     *
+     * // Override provider for specific call
+     * const stripeProducts = await product.browse({
+     *   first: 10,
+     *   _provider: "stripe"
+     * });
+     * ```
+     */
+    browse(params?: ProductBrowseParams): Promise<ProductBrowseResult>;
+    /**
+     * Get a single product by slug or ID
+     *
+     * @example
+     * ```typescript
+     * import { product } from "commerce-kit";
+     *
+     * const productData = await product.get({ slug: "awesome-product" });
+     *
+     * // With GraphQL field selection (YNS only)
+     * const productWithFields = await product.get({
+     *   slug: "awesome-product",
+     *   fields: ["id", "name", "price", "category.name"]
+     * });
+     *
+     * // Get by ID instead of slug
+     * const productById = await product.get({ id: "prod_123" });
+     * ```
+     */
+    get(params: ProductGetParams): Promise<Product | null>;
+    /**
+     * Search products by query string
+     *
+     * @example
+     * ```typescript
+     * import { product } from "commerce-kit";
+     *
+     * const searchResults = await product.search({
+     *   query: "laptop computer",
+     *   limit: 20
+     * });
+     *
+     * // With field selection
+     * const searchWithFields = await product.search({
+     *   query: "smartphone",
+     *   fields: ["id", "name", "price"],
+     *   limit: 10
+     * });
+     * ```
+     */
+    search(params: ProductSearchParams): Promise<ProductSearchResult>;
+};
+
 declare const provider: ({ tags, revalidate, cache, tagPrefix, secretKey, }: {
     tags?: NextFetchRequestConfig["tags"];
     revalidate?: NextFetchRequestConfig["revalidate"];
@@ -787,4 +1133,42 @@ declare const provider: ({ tags, revalidate, cache, tagPrefix, secretKey, }: {
     secretKey: string | undefined;
 }) => Stripe;
 
-export { type AddressSchema, type Cart, MappedCart, type Order, type ProductsFromMetadata, accountGet, calculateCartTotalNet, calculateCartTotalNetWithoutShipping, calculateCartTotalPossiblyWithTax, cartAdd, cartAddOptimistic, cartChangeQuantity, cartCount, cartCreate, cartGet, cartSaveBillingAddress, cartSaveEmail, cartSaveShipping, cartSaveTax, cartSetQuantity, cartUpdateQuantity, categoryBrowse, contextGet, fileGet, getAddressSchema, getCartWithProductsById, getProductsFromCart, getProductsFromMetadata, orderGet, productBrowse, productGet, productGetById, productReviewAdd, productReviewBrowse, provider, shippingBrowse, shippingGet, taxDefaultGet, updatePaymentIntent };
+/**
+ * Create a scoped Commerce instance with a specific provider
+ *
+ * @example
+ * ```typescript
+ * import { withProvider } from "commerce-kit";
+ *
+ * const ynsCommerce = withProvider("yns");
+ * const stripeCommerce = withProvider("stripe");
+ *
+ * const ynsProducts = await ynsCommerce.product.browse({ first: 10 });
+ * const stripeProducts = await stripeCommerce.product.browse({ first: 10 });
+ * ```
+ */
+declare function withProvider(provider: "stripe" | "yns"): {
+    product: {
+        browse(params: any): Promise<ProductBrowseResult>;
+        get(params: any): Promise<Product | null>;
+        search(params: any): Promise<ProductSearchResult>;
+    };
+    cart: {
+        add(params: any): Promise<{
+            cartId: string;
+        }>;
+        update(params: any): Promise<{
+            cartId: string;
+        }>;
+        clear(params: any): Promise<{
+            cartId: string;
+        }>;
+        get(params: any): Promise<Cart | null>;
+    };
+    order: {
+        get(params: any): Promise<Order | null>;
+        list(params?: any): Promise<OrderListResult>;
+    };
+};
+
+export { type AddressSchema, type BaseProvider, type Cart$1 as Cart, type CartAddParams, type CartClearParams, type CartGetParams, type CartUpdateParams, type Cart as CommerceCart, type CartItem as CommerceCartItem, type CommerceConfig, type Order as CommerceOrder, MappedCart, type Order$1 as Order, type Product, type ProductBrowseParams, type ProductGetParams, type ProductsFromMetadata, accountGet, calculateCartTotalNet, calculateCartTotalNetWithoutShipping, calculateCartTotalPossiblyWithTax, cart, cartAdd, cartAddOptimistic, cartChangeQuantity, cartCount, cartCreate, cartGet, cartSaveBillingAddress, cartSaveEmail, cartSaveShipping, cartSaveTax, cartSetQuantity, cartUpdateQuantity, categoryBrowse, configure, contextGet, fileGet, getAddressSchema, getCartWithProductsById, getProductsFromCart, getProductsFromMetadata, order, orderGet, product, productBrowse, productGet, productGetById, productReviewAdd, productReviewBrowse, provider, shippingBrowse, shippingGet, taxDefaultGet, updatePaymentIntent, withProvider };