@boostengine/collections 1.0.0 → 1.1.0

package/README.md

@@ -1,84 +1,63 @@
 # @boostengine/collections
 
-> Production-ready **Postman Collections (v2.1.0)** and **Environment Templates** for Indian eCommerce APIs: **Razorpay Payment Gateway** and **EasyEcom WMS & ERP**.
+> Production-ready **Postman Collections (Schema v2.1.0)** and **Environment Templates** for the world's leading eCommerce & Payment APIs: **Razorpay, Cashfree, PhonePe, Paytm, Stripe, EasyEcom WMS, Shiprocket, Delhivery, and Shopify**.
 
-Includes a zero-install **CLI tool** (`npx @boostengine/collections export`) to dump ready-to-import Postman JSON files into any project in 1 second.
+Includes a zero-install **1-second CLI tool** (`npx @boostengine/collections export all`) to dump ready-to-import Postman JSON files into any project instantly.
 
 ---
 
-## ⚡ Quickstart (CLI)
+## ⚡ 1-Click Quickstart (CLI)
 
-Export complete collections and environment variables into your current working directory without installing:
+Export any or all collections and environment variables into your project:
 
 ```bash
-# Export all collections & environments
+# Export all 9 collections & environments (18 files)
 npx @boostengine/collections export all
 
 # Or export individually:
 npx @boostengine/collections export razorpay
+npx @boostengine/collections export cashfree
+npx @boostengine/collections export phonepe
+npx @boostengine/collections export paytm
+npx @boostengine/collections export stripe
 npx @boostengine/collections export easyecom
+npx @boostengine/collections export shiprocket
+npx @boostengine/collections export delhivery
+npx @boostengine/collections export shopify
 
-# Inspect available endpoints inside terminal:
+# Inspect available endpoints inside your terminal:
 npx @boostengine/collections info razorpay
+npx @boostengine/collections info cashfree
+npx @boostengine/collections info shiprocket
 ```
 
 ### 📥 How to Import into Postman / Bruno / Insomnia:
-1. Open **Postman** (or Insomnia / Bruno / ThunderClient).
-2. Click **Import** (Top left).
+1. Open **Postman** (or Insomnia / Bruno / ThunderClient / Hoppscotch).
+2. Click **Import** (Top left corner).
 3. Drag & drop the exported `*.collection.json` and `*.env.json` files.
-4. Select the imported Environment from top-right dropdown, paste your API keys, and start sending requests!
+4. Select the imported Environment from the top-right dropdown, enter your API keys, and start sending requests!
 
 ---
 
-## 📦 What's Included
-
-### 1. 💳 Razorpay eCommerce API Collection (`razorpay.collection.json`)
-Official REST APIs configured with Basic Authentication:
-* **Orders API**:
-  - `POST /v1/orders` (Create order with amount, currency, notes, receipt)
-  - `GET /v1/orders/:id` (Fetch order details)
-  - `GET /v1/orders/:id/payments` (Fetch all payments attempted against order)
-  - `GET /v1/orders` (List recent orders with pagination)
-* **Payments API**:
-  - `GET /v1/payments/:id` (Fetch payment status, UPI VPA, card details)
-  - `POST /v1/payments/:id/capture` (Manual payment capture)
-  - `PATCH /v1/payments/:id` (Update custom payment notes)
-* **Refunds API**:
-  - `POST /v1/payments/:id/refund` (Instant & normal customer refunds)
-  - `GET /v1/refunds/:id` (Check refund status)
-  - `GET /v1/refunds` (List recent refunds)
-* **Webhook Simulator**:
-  - `order.paid` mock payload
-  - `payment.failed` mock payload
-  - `payment.captured` mock payload
-  - `refund.processed` mock payload
-  - HMAC SHA256 signature verification guidance
+## 📦 What's Included (9 Exhaustive Enterprise Collections)
 
----
-
-### 2. 🏬 EasyEcom Warehouse & ERP Collection (`easyecom.collection.json`)
-Official REST APIs configured with Bearer Token Authentication:
-* **Orders API**:
-  - `GET /orders/v2/getOrders` (Fetch pending & unfulfilled orders)
-  - `POST /orders/v2/createOrder` (Push new storefront orders into ERP)
-  - `POST /orders/v2/updateOrderStatus` (Update fulfillment status to Shipped/Delivered)
-  - `POST /orders/v2/cancelOrder` (Cancel order and auto-restore warehouse inventory)
-* **Inventory & Multi-Warehouse Stock**:
-  - `GET /inventory/v2/getInventoryDetails` (Check sellable stock by SKU)
-  - `POST /inventory/v2/updateInventory` (Sync warehouse inventory count)
-  - `GET /inventory/v2/getWarehouses` (List all active fulfillment centers)
-* **Master Catalog**:
-  - `GET /catalog/v2/getMasterProducts` (Fetch product master records)
-  - `POST /catalog/v2/createProduct` (Register master SKU with HSN code & dimensions)
-* **Shipping & Manifests**:
-  - `POST /shipping/v2/generateAwb` (Generate shipping label & tracking number)
-  - `POST /shipping/v2/createManifest` (Create courier handover manifest PDF)
+| Provider | Category | Modules & Endpoints Included |
+| :--- | :--- | :--- |
+| **Razorpay** | 💳 Payments | Orders, Payments & Manual Capture, Payment Links, Dynamic UPI QR, Smart Collect (Virtual Accounts), Customers & Tokenized Card Vault, GST Invoices, Subscriptions & Plans, Refunds, Webhook Simulator (`order.paid`, `payment.failed`, `refund.processed`, `virtual_account.credited`) |
+| **Cashfree** | 💳 Payments & Banking | Orders (Drop-in Session), Seamless Direct UPI Intent/Collect/Netbanking, Payment Links, Bank Account Verification (Penny Drop), UPI VPA Verification, PAN Verification, Instant Payouts & Disbursals, Subscriptions, Refunds, Webhooks (`PAYMENT_SUCCESS`, `PAYMENT_FAILED`, `REFUND_STATUS`) |
+| **PhonePe** | 💳 Payments | Standard Hosted Pay Page, Custom Mobile App UPI Intent, UPI Collect (VPA handle), Dynamic QR Codes, S2S Status Check (`/pg/v1/status`), Refunds, S2S Webhook Simulator with automatic Base64 & SHA256 `X-VERIFY` pre-request calculation |
+| **Paytm** | 💳 Payments | Initiate Transaction Token, Checkout SDK session, Transaction Status Verification (`/v3/order/status`), Refund Initiation & Status, S2S Webhook Callback simulator |
+| **Stripe** | 💳 Global | Checkout Sessions, PaymentIntents (Cards/Wallets), Customers & Saved Payment Methods, Products & Subscriptions, Refunds & Disputes, Webhooks Simulator |
+| **EasyEcom** | 🏬 WMS / ERP | Storefront Orders Push, Pending Orders, Status Updates, Multi-Warehouse Stock Sync, Single & Bulk SKU updates, Master Catalog SKUs & Barcodes, Dispatch Manifests, Inward Returns Reconciliation |
+| **Shiprocket** | 🚚 Logistics | Auth JWT, Domestic & International Pincode Serviceability & Rates, Custom & Bulk Orders, Customer Address Update, Reverse Return Orders, AWB Generation, Courier Pickup Request, Manifests, Thermal Shipping Labels, Tax Invoices, Live Tracking, NDR Actions (Re-attempt / RTO), Webhooks |
+| **Delhivery** | 🚚 Logistics | Pincode Serviceability Check, Rate & Freight Calculator, Bulk Waybill Pool, Surface/Express CMU Manifest, Address Update, Cancel Shipment, Warehouse Pickup Request, Packing Slips & PDF Barcode Labels, Live Package Tracking, Webhooks |
+| **Shopify** | 🛍️ Storefront | Products & Multi-variant catalog, Orders & Status Filter, Fulfillments & Tracking Number attachment, Customers API, Multi-location Inventory Levels, Webhooks |
 
 ---
 
 ## 💻 Programmatic Node.js / TypeScript Usage
 
-You can also install this package as a dev dependency to programmatically parse or mock endpoints in your backend tests:
+You can also install this package as a dependency to programmatically parse or mock endpoints in backend integration tests:
 
 ```bash
 npm install -D @boostengine/collections
@@ -86,26 +65,34 @@ npm install -D @boostengine/collections
 
 ```typescript
 import {
-  razorpayCollection,
-  easyecomCollection,
   listCollections,
   getCollection,
-  exportToDirectory,
+  razorpayCollection,
+  cashfreeCollection,
+  phonepeCollection,
+  paytmCollection,
+  shiprocketCollection,
 } from '@boostengine/collections';
 
-// List available collection summaries
-const available = listCollections();
-console.log(available);
+// 1. List metadata and available folders:
+console.log(listCollections());
+
+// 2. Access raw Postman JSON collections programmatically:
+console.log('Razorpay requests:', razorpayCollection.item.length);
+console.log('Cashfree schema:', cashfreeCollection.info.schema);
+```
+
+---
 
-// Access raw Postman Schema v2.1.0 JSON object
-console.log(razorpayCollection.info.name);
-console.log(easyecomCollection.item.length);
+## 🔄 Updating Upstream Collections
 
-// Programmatically dump files in CI/CD or setup scripts
-exportToDirectory('all', './postman');
+Run the built-in sync audit tool to check upstream API versions:
+
+```bash
+npm run sync:upstream
 ```
 
 ---
 
 ## 📄 License
-MIT © [Boost Engine](https://github.com/boostengine)
+MIT © Boost Engine Team

package/bin/cli.cjs

@@ -14,6 +14,34 @@ const collections = {
     docs: 'https://razorpay.com/docs/api',
     description: 'Orders, Payments, Refunds & Webhook Simulator',
   },
+  cashfree: {
+    name: 'Cashfree Payments API Collection',
+    collectionFile: path.join(collectionsDir, 'cashfree.collection.json'),
+    envFile: path.join(envsDir, 'cashfree.env.json'),
+    docs: 'https://docs.cashfree.com/reference',
+    description: 'Payment Gateway PG v2023-08-01 Orders, Payments, Refunds, Webhooks',
+  },
+  phonepe: {
+    name: 'PhonePe Payment Gateway Collection',
+    collectionFile: path.join(collectionsDir, 'phonepe.collection.json'),
+    envFile: path.join(envsDir, 'phonepe.env.json'),
+    docs: 'https://developer.phonepe.com/v1/reference',
+    description: 'Standard Pay, Order Status Check, Refunds & S2S Webhooks',
+  },
+  paytm: {
+    name: 'Paytm Payment Gateway Collection',
+    collectionFile: path.join(collectionsDir, 'paytm.collection.json'),
+    envFile: path.join(envsDir, 'paytm.env.json'),
+    docs: 'https://developer.paytm.com/docs/api',
+    description: 'Initiate Transaction, Status Check, Refunds & S2S Callback',
+  },
+  stripe: {
+    name: 'Stripe Global Payments Collection',
+    collectionFile: path.join(collectionsDir, 'stripe.collection.json'),
+    envFile: path.join(envsDir, 'stripe.env.json'),
+    docs: 'https://stripe.com/docs/api',
+    description: 'Checkout Sessions, PaymentIntents, Customers & Refunds',
+  },
   easyecom: {
     name: 'EasyEcom eCommerce & Warehouse API Collection',
     collectionFile: path.join(collectionsDir, 'easyecom.collection.json'),
@@ -21,6 +49,27 @@ const collections = {
     docs: 'https://api.easyecom.com/documentation',
     description: 'Orders, Multi-Warehouse Inventory, Catalog & Shipping Manifests',
   },
+  shiprocket: {
+    name: 'Shiprocket Logistics API Collection',
+    collectionFile: path.join(collectionsDir, 'shiprocket.collection.json'),
+    envFile: path.join(envsDir, 'shiprocket.env.json'),
+    docs: 'https://apidocs.shiprocket.in',
+    description: 'Auth, Pincode Serviceability, Order Creation, AWB & Live Tracking',
+  },
+  delhivery: {
+    name: 'Delhivery Express Shipping Collection',
+    collectionFile: path.join(collectionsDir, 'delhivery.collection.json'),
+    envFile: path.join(envsDir, 'delhivery.env.json'),
+    docs: 'https://delhivery.com/developer',
+    description: 'Pin-codes Serviceability, Waybill Creation & Live Package Tracking',
+  },
+  shopify: {
+    name: 'Shopify Admin REST API Collection',
+    collectionFile: path.join(collectionsDir, 'shopify.collection.json'),
+    envFile: path.join(envsDir, 'shopify.env.json'),
+    docs: 'https://shopify.dev/docs/api/admin-rest',
+    description: 'Storefront Products, Orders, Inventory Levels & Webhooks',
+  },
 };
 
 const args = process.argv.slice(2);