@hanzo/commerce 7.6.1 → 7.6.4

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 hanzo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/client.ts

@@ -25,15 +25,6 @@
  * })
  * window.location.href = session.checkoutUrl
  *
- * // Tokenize a card (S2S — no external SDK required)
- * const token = await commerce.tokenizeCard({
- *   number: '4242424242424242',
- *   expiryMonth: '12',
- *   expiryYear: '2027',
- *   cvc: '123',
- *   name: 'Jane Smith',
- * })
- *
  * // Subscribe
  * const sub = await commerce.subscribe({ planId: 'pro', userId: 'user_xyz' })
  * ```
@@ -67,6 +58,29 @@ export type Balance = {
   available: number
 }
 
+/**
+ * Tier-aware balance from GET /v1/billing/tier. effectiveAvailable folds the
+ * tenant's included plan allotment (e.g. the free-tier daily credit) into the
+ * prepaid available balance — gate on this to honor included usage first.
+ */
+export type TierResponse = {
+  user: string
+  tier: {
+    name: string
+    displayName?: string
+    maxAgents?: number
+    unlimitedAgents?: boolean
+    dailyCreditsCents?: number
+    allowedModels?: string[]
+  }
+  balance: {
+    currency: string
+    prepaidAvailable: number
+    dailyRemaining: number
+    effectiveAvailable: number
+  }
+}
+
 export type Transaction = {
   id?: string
   owner?: string
@@ -231,28 +245,6 @@ export type CheckoutSessionResponse = {
   }
 }
 
-// ---------------------------------------------------------------------------
-// Card tokenization (S2S — no provider SDK needed on the frontend)
-// ---------------------------------------------------------------------------
-
-export type CardTokenizeRequest = {
-  number: string
-  expiryMonth: string   // "01"–"12"
-  expiryYear: string    // "2025"–"2099"
-  cvc: string
-  name?: string
-  zip?: string
-}
-
-export type CardTokenizeResult = {
-  token: string
-  brand: string
-  last4: string
-  expiryMonth: string
-  expiryYear: string
-  provider: string
-}
-
 // ---------------------------------------------------------------------------
 // Payment method types
 // ---------------------------------------------------------------------------
@@ -270,6 +262,17 @@ export type PaymentMethod = {
     expMonth: number
     expYear: number
   }
+  bank_account?: {
+    bankName?: string
+    last4?: string
+    accountType?: 'checking' | 'savings'
+    routingNumber?: string
+  }
+  crypto?: {
+    chain: string
+    address: string
+    label?: string
+  }
   providerRef?: string
   providerType?: string
   createdAt?: string
@@ -349,6 +352,8 @@ export class Commerce {
       body?: unknown
       token?: string
       params?: Record<string, string>
+      /** Extra request headers, e.g. X-IAM-Org-Id for S2S calls. */
+      headers?: Record<string, string>
     },
   ): Promise<T> {
     const url = new URL(path, this.baseUrl)
@@ -365,6 +370,7 @@ export class Commerce {
     const authToken = opts?.token ?? this.token
     if (authToken) headers['Authorization'] = `Bearer ${authToken}`
     if (opts?.body) headers['Content-Type'] = 'application/json'
+    if (opts?.headers) Object.assign(headers, opts.headers)
 
     try {
       const res = await fetch(url.toString(), {
@@ -389,9 +395,9 @@ export class Commerce {
   // Balance
   // -----------------------------------------------------------------------
 
-  async getBalance(user: string, currency = 'usd', token?: string): Promise<Balance> {
+  async getBalance(user: string, currency = 'usd', token?: string, headers?: Record<string, string>): Promise<Balance> {
     return this.request<Balance>('/v1/billing/balance', {
-      params: { user, currency }, token,
+      params: { user, currency }, token, headers,
     })
   }
 
@@ -401,13 +407,25 @@ export class Commerce {
     })
   }
 
+  /**
+   * Tier-aware balance: prepaid available plus the tenant's included plan
+   * allotment (effectiveAvailable). Use this for the metering gate when you
+   * want included usage (e.g. free-tier daily credit) honored before prepaid
+   * funds are drawn down.
+   */
+  async getTier(user: string, opts?: { token?: string; headers?: Record<string, string> }): Promise<TierResponse> {
+    return this.request<TierResponse>('/v1/billing/tier', {
+      params: { user }, token: opts?.token, headers: opts?.headers,
+    })
+  }
+
   // -----------------------------------------------------------------------
   // Usage
   // -----------------------------------------------------------------------
 
-  async addUsageRecord(record: UsageRecord, token?: string): Promise<Transaction> {
+  async addUsageRecord(record: UsageRecord, token?: string, headers?: Record<string, string>): Promise<Transaction> {
     return this.request<Transaction>('/v1/billing/usage', {
-      method: 'POST', body: record, token,
+      method: 'POST', body: record, token, headers,
     })
   }
 
@@ -511,31 +529,6 @@ export class Commerce {
     })
   }
 
-  // -----------------------------------------------------------------------
-  // Card tokenization (S2S — no external SDK required)
-  // -----------------------------------------------------------------------
-
-  /**
-   * Tokenize a payment card server-side.
-   * No external SDK (Square.js, Stripe.js, etc.) is needed on the frontend.
-   * The card data is sent to the Hanzo Commerce API over HTTPS, which
-   * tokenizes via the configured payment provider (Stripe).
-   */
-  async tokenizeCard(card: CardTokenizeRequest, token?: string): Promise<CardTokenizeResult> {
-    return this.request<CardTokenizeResult>('/v1/billing/card/tokenize', {
-      method: 'POST',
-      body: {
-        number: card.number.replace(/\s/g, ''),
-        expiry_month: card.expiryMonth,
-        expiry_year: card.expiryYear,
-        cvc: card.cvc,
-        name: card.name,
-        zip: card.zip,
-      },
-      token,
-    })
-  }
-
   // -----------------------------------------------------------------------
   // Payment methods
   // -----------------------------------------------------------------------
@@ -544,25 +537,25 @@ export class Commerce {
     params: {
       customerId: string
       type: PaymentMethodType
-      token?: string          // from tokenizeCard
+      token?: string          // provider nonce (Square Web Payments SDK)
       providerRef?: string
       providerType?: string
     },
     token?: string,
   ): Promise<PaymentMethod> {
-    return this.request<PaymentMethod>('/v1/billing/payment-methods', {
+    return this.request<PaymentMethod>('/v1/billing/methods', {
       method: 'POST', body: params, token,
     })
   }
 
   async listPaymentMethods(customerId: string, token?: string): Promise<PaymentMethod[]> {
-    return this.request<PaymentMethod[]>('/v1/billing/payment-methods', {
+    return this.request<PaymentMethod[]>('/v1/billing/methods', {
       params: { customerId }, token,
     })
   }
 
   async removePaymentMethod(paymentMethodId: string, token?: string): Promise<void> {
-    await this.request<void>(`/v1/billing/payment-methods/${paymentMethodId}`, {
+    await this.request<void>(`/v1/billing/methods/${paymentMethodId}`, {
       method: 'DELETE', token,
     })
   }
@@ -687,6 +680,73 @@ export class Commerce {
       method: 'POST', body: params, token,
     })
   }
+
+  // -----------------------------------------------------------------------
+  // Crypto wallet deposit address
+  // -----------------------------------------------------------------------
+
+  /**
+   * Get or create a deposit address for a given chain.
+   * Used for crypto top-up — user sends funds to this address.
+   */
+  async getWalletAddress(params: { chain: string; userId: string }, token?: string): Promise<{ address: string; chain: string; qrCode?: string }> {
+    return this.request<{ address: string; chain: string; qrCode?: string }>('/api/wallet/account', {
+      method: 'POST',
+      body: { name: `${params.userId}-${params.chain}`, blockchainType: params.chain },
+      token,
+    })
+  }
+
+  // -----------------------------------------------------------------------
+  // Bank account (ACH) and crypto payment methods
+  // -----------------------------------------------------------------------
+
+  /**
+   * Add a bank account payment method (ACH).
+   * plaidToken from Plaid Link or Square bank OAuth.
+   */
+  async addBankAccount(
+    params: {
+      customerId: string
+      plaidToken?: string  // Plaid public token
+      bankName?: string
+      accountType?: 'checking' | 'savings'
+    },
+    token?: string,
+  ): Promise<PaymentMethod> {
+    return this.request<PaymentMethod>('/v1/billing/methods', {
+      method: 'POST',
+      body: { customerId: params.customerId, type: 'bank_account', plaidToken: params.plaidToken, bankName: params.bankName, accountType: params.accountType },
+      token,
+    })
+  }
+
+  async addCryptoWallet(
+    params: { customerId: string; chain: string; address: string; label?: string },
+    token?: string,
+  ): Promise<PaymentMethod> {
+    return this.request<PaymentMethod>('/v1/billing/methods', {
+      method: 'POST',
+      body: { customerId: params.customerId, type: 'crypto', chain: params.chain, address: params.address, label: params.label },
+      token,
+    })
+  }
+
+  // -----------------------------------------------------------------------
+  // Top-up
+  // -----------------------------------------------------------------------
+
+  /**
+   * Convenience: charge a saved payment method and deposit credits.
+   * amount is in cents.
+   */
+  async topup(params: { userId: string; paymentMethodId: string; amountCents: number; currency?: string }, token?: string): Promise<Transaction> {
+    return this.request<Transaction>('/v1/billing/topup', {
+      method: 'POST',
+      body: params,
+      token,
+    })
+  }
 }
 
 // ---------------------------------------------------------------------------

package/components/add-to-cart-widget.tsx

@@ -148,6 +148,9 @@ const AddToCartWidget: React.FC<{
         </div>
       <Button
         aria-label={'Add another ' + item.title + ' to the cart'}
+        itemProp='potentialAction'
+        itemScope
+        itemType='https://schema.org/AddAction'
         size={ghost || priSmaller ? 'xs' : 'default'}
 
         variant={primary || priSmaller ? 'primary' : 'ghost'}
@@ -168,6 +171,9 @@ const AddToCartWidget: React.FC<{
   ) : (
     <Button
       aria-label={'Add a ' + item.title + ' to cart'}
+      itemProp='potentialAction'
+      itemScope
+      itemType='https://schema.org/AddAction'
       size={ghost || priSmaller ? 'xs' : 'default'}
       variant={ghost ? 'ghost' : (primary || priSmaller ? 'primary' : 'outline')}
       rounded={ROUNDED_VAL}

package/components/item/product-card.tsx

@@ -26,16 +26,33 @@ const ProductCard: React.FC<ProductCardProps> = ({
   ...props
 }) => (
   <Card
+    itemScope
+    itemType='https://schema.org/Product'
     className={cn('max-h-[360px] lg:min-w-[200px] max-w-[260px] overflow-hidden', className)}
     {...props}
   >
+    {/* Standard schema.org Product microdata. Neutral and analytics-agnostic:
+        track.js `annotate`, GA4 Merchant, or any reader picks up the item with
+        zero per-app config. Machine values live in <meta> so the visible,
+        formatted UI is untouched. */}
+    <meta itemProp='name' content={item.title} />
+    <meta itemProp='sku' content={item.sku} />
     <CardHeader className='w-full border-b p-6 min-h-[180px] max-h-[240px] relative'>
       <MediaStack media={item} constrainTo={{w: 700, h:700}} clx='p-6' />
     </CardHeader>
     <CardContent className='grid gap-2.5 p-4'>
       <CardTitle className='text-sm sm:text-base flex flex-col justify-start items-center line-clap-3'>
         {item.title.split(', ').map((e, i) => (<p key={i}>{e}</p>))}
-        <p className='mt-1 font-semibold'>{formatCurrencyValue(item.price)}</p>
+        <p
+          className='mt-1 font-semibold'
+          itemProp='offers'
+          itemScope
+          itemType='https://schema.org/Offer'
+        >
+          <meta itemProp='price' content={String(item.price)} />
+          <meta itemProp='priceCurrency' content='USD' />
+          {formatCurrencyValue(item.price)}
+        </p>
       </CardTitle>
     </CardContent>
     <CardFooter className='p-4 flex flex-row justify-center'>

package/dist/billing.d.ts

@@ -0,0 +1,2 @@
+/** @hanzo/commerce/billing — re-exports from @hanzo/commerce/client */
+export * from './client';

package/dist/billing.js

@@ -0,0 +1,3 @@
+/** @hanzo/commerce/billing — re-exports from @hanzo/commerce/client */
+export * from './client';
+//# sourceMappingURL=billing.js.map

package/dist/billing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"billing.js","sourceRoot":"","sources":["../billing.ts"],"names":[],"mappings":"AAAA,uEAAuE;AACvE,cAAc,UAAU,CAAA"}