@dokamerce/web-sdk 0.9.0 → 0.9.3

package/README.md

@@ -1,47 +1,89 @@
+# @dokamerce/web-sdk
+
+A lightweight, TypeScript‑ready SDK for interacting with Dokamerce GraphQL APIs.  
+It provides a simple, intuitive interface for creating, updating, listing, and deleting products, with built‑in support for pagination and infinite fetching.
+
+---
+
+## 🚀 Installation
+
+```bash
+npm install @dokamerce/web-sdk graphql graphql-request
+# or
+yarn add @dokamerce/web-sdk graphql graphql-request
+
+📦 Features
+🔗 Easy GraphQL client integration
+
+🛍️ Product CRUD operations (create, update, delete)
+
+📑 Pagination and infinite fetch helpers
+
+✅ TypeScript definitions included
+
+⚡ Lightweight and modular
+🛠 Usage Example
+ts
 import { GraphQLClient } from "graphql-request";
-import { createProductsSdk } from "@/sdk/products-sdk";
+import { createProductsSdk } from "@dokamerce/web-sdk";
 
 async function main() {
-  // 1️⃣ Initialize GraphQL client
   const client = new GraphQLClient("https://api.example.com/graphql", {
-    headers: {
-      Authorization: `Bearer YOUR_API_TOKEN`,
-    },
+    headers: { Authorization: `Bearer YOUR_API_TOKEN` },
   });
 
-  // 2️⃣ Create the Products SDK
   const productsSdk = createProductsSdk(client);
 
-  // 3️⃣ Create a new product
   const newProduct = await productsSdk.create({
-    input: {
-      name: "Sample Product",
-      price: 19.99,
-      description: "This is a sample product",
-    },
+    input: { name: "Sample Product", price: 19.99, description: "This is a sample product" },
   });
   console.log("Created Product:", newProduct.createProduct);
 
-  // 4️⃣ Update the product
   const updatedProduct = await productsSdk.update({
     id: newProduct.createProduct.id,
-    input: {
-      price: 24.99,
-    },
+    input: { price: 24.99 },
   });
   console.log("Updated Product Price:", updatedProduct.updateProduct.price);
 
-  // 5️⃣ Fetch products (paginated)
   const paginated = await productsSdk.list({ page: 1, limit: 10 });
   console.log("Paginated Products:", paginated.paginatedProducts.items);
 
-  // 6️⃣ Fetch products (infinite)
   const allProducts = await productsSdk.fetchAll({ cursor: null, limit: 5 });
   console.log("All Products via Infinite Fetch:", allProducts);
 
-  // 7️⃣ Delete the product
   await productsSdk.delete({ id: newProduct.createProduct.id });
   console.log("Product deleted!");
 }
 
 main().catch(console.error);
+📖 API Reference
+createProductsSdk(client: GraphQLClient)
+Initializes the SDK with a GraphQL client.
+
+Methods
+create({ input }) → Creates a new product.
+
+update({ id, input }) → Updates an existing product.
+
+list({ page, limit }) → Fetches products with pagination.
+
+fetchAll({ cursor, limit }) → Fetches products using infinite scrolling.
+
+delete({ id }) → Deletes a product by ID.
+
+🧩 Requirements
+Node.js  ≥ 16
+
+GraphQL API endpoint
+
+Valid API token
+
+📜 License
+MIT © Dokamerce
+🤝 Contributing
+Contributions, issues, and feature requests are welcome!
+Feel free to open a PR or start a discussion in the GitHub repository.
+
+Code
+
+I’ll now prepare this as a **downloadable `README.md` file card** so you can grab it direc