commerce-kit 0.0.40 → 0.1.0

package/README.md

@@ -1,75 +1,143 @@
 # commerce-kit
 
-`commerce-kit` is a simple TypeScript library designed specifically for e-commerce applications built with Next.js. It provides a range of utilities to interact with products, categories, and orders, seamlessly integrating with Stripe for payment processing.
+TypeScript SDK for building e-commerce apps. Works with Stripe and YNS APIs through a clean, unified interface. Built for Next.js, but plays nice with whatever you're using.
 
 Built by [Your Next Store](https://yournextstore.com).
 
 ## Features
 
-- **Product Browsing**: Easily fetch and display products.
-- **Category Management**: Manage and retrieve product categories.
-- **Order Handling**: Create and manage customer orders.
-- **Cart Operations**: Add products to cart and retrieve cart details.
-- **Stripe Integration**: Built-in support for payment processing using Stripe.
+- **Multi-provider**: Switch between Stripe and YNS without changing code
+- **GraphQL support**: Field selection for YNS, REST for Stripe
+- **Type-safe**: Full TypeScript with provider-specific types
+- **Tree-shakeable**: Only bundle what you use
+- **Zero config**: Works out of the box, customize when needed
 
-## Installation
-
-Install the package via npm:
+## Install
 
 ```bash
 npm install commerce-kit
 ```
 
-## Usage
-
-`commerce-kit` is intended for use with Next.js applications. Here's a simple example of how to use it to fetch and display products:
+## Quick start
 
 ```tsx
 import * as Commerce from "commerce-kit";
 import { formatMoney } from "commerce-kit/currencies";
-import Image from "next/image";
-import Link from "next/link";
 
+// Configure once
+Commerce.configure({
+  provider: "stripe", // or "yns"
+  stripe: { secretKey: process.env.STRIPE_SECRET_KEY }
+});
+
+// Use everywhere
 export async function ProductList() {
-  const products = await Commerce.productBrowse({ first: 6 });
+  const products = await Commerce.product.browse({ first: 6 });
 
   return (
-    <ul>
-      {products.map((product) => (
-        <li key={product.id}>
-          <Link href={`/product/${product.metadata.slug}`}>
-            <article>
-              {product.images[0] && (
-                <Image src={product.images[0]} width={300} height={300} alt={product.name} />
-              )}
-              <h2>{product.name}</h2>
-              {product.default_price.unit_amount && (
-                <p>
-                  {formatMoney({
-                    amount: product.default_price.unit_amount,
-                    currency: product.default_price.currency,
-                    locale: "en-US",
-                  })}
-                </p>
-              )}
-            </article>
-          </Link>
-        </li>
+    <div>
+      {products.data.map((product) => (
+        <div key={product.id}>
+          <h2>{product.name}</h2>
+          <p>{formatMoney({ amount: product.price, currency: product.currency })}</p>
+        </div>
       ))}
-    </ul>
+    </div>
   );
 }
 ```
 
-## Debugging
+## API
+
+### Products
+```tsx
+// Browse with filters
+const products = await Commerce.product.browse({
+  first: 10,
+  category: "electronics",
+  fields: ["id", "name", "price"] // GraphQL field selection (YNS only)
+});
+
+// Get single product  
+const product = await Commerce.product.get({ slug: "awesome-laptop" });
+
+// Search
+const results = await Commerce.product.search({ query: "macbook" });
+```
+
+### Cart
+```tsx
+// Add to cart
+const cart = await Commerce.cart.add({ 
+  variantId: "variant_123",
+  quantity: 2 
+});
+
+// Update quantity
+await Commerce.cart.update({ 
+  cartId: cart.cartId,
+  variantId: "variant_123", 
+  quantity: 3 
+});
+
+// Get cart
+const cartData = await Commerce.cart.get({ cartId: cart.cartId });
+```
+
+### Provider switching
+```tsx
+// Override provider per call
+const stripeProducts = await Commerce.product.browse({ 
+  first: 10,
+  _provider: "stripe" 
+});
+
+// Or use scoped instances
+const yns = Commerce.withProvider("yns");
+const stripe = Commerce.withProvider("stripe");
+
+const ynsProducts = await yns.product.browse({ first: 10 });
+const stripeProducts = await stripe.product.browse({ first: 10 });
+```
+
+## Providers
+
+### YNS
+```tsx
+Commerce.configure({
+  provider: "yns",
+  yns: {
+    endpoint: "https://api.yournextstore.com",
+    token: process.env.YNS_API_TOKEN
+  }
+});
+```
+
+### Stripe  
+```tsx
+Commerce.configure({
+  provider: "stripe",
+  stripe: {
+    secretKey: process.env.STRIPE_SECRET_KEY,
+    tagPrefix: "my-store" // optional
+  }
+});
+```
+
+## Migration
+
+Old way (still works):
+```tsx
+const products = await Commerce.productBrowse({ first: 6 });
+```
 
-This library uses a custom logger to output debug information. To control the debug output, use the `LOG_LEVEL` environment variable. The following levels are supported:
+New way (recommended):
+```tsx  
+const products = await Commerce.product.browse({ first: 6 });
+```
 
-- **ERROR** – Critical issue for a specific request that needs immediate attention.
-- **WARN** – Something that should be reviewed eventually.
-- **LOG** – Details on regular operations.
-- **DEBUG** – Debug information, including `time` and `timeEnd` function outputs.
+Same data, better DX, provider flexibility, GraphQL field selection.
 
 ## License
 
-This project is licensed under the AGPL Version 3 license – see the LICENSE.md file for details.
+AGPL-3.0 – see LICENSE.md

package/dist/currencies.d.ts

@@ -4,7 +4,7 @@ type Money = {
 };
 declare const getStripeAmountFromDecimal: ({ amount: major, currency }: Money) => number;
 declare const getDecimalFromStripeAmount: ({ amount: minor, currency }: Money) => number;
-declare const formatMoney: ({ amount: minor, currency, locale, }: Money & {
+declare const formatMoney: ({ amount: minor, currency, locale }: Money & {
     locale?: string;
 }) => string;