@boostengine/collections 1.0.0 → 1.1.1

package/README.md

@@ -1,111 +1,91 @@
-# @boostengine/collections
+# @boostengine/collections 📮
 
-> Production-ready **Postman Collections (v2.1.0)** and **Environment Templates** for Indian eCommerce APIs: **Razorpay Payment Gateway** and **EasyEcom WMS & ERP**.
+[![npm version](https://img.shields.io/npm/v/@boostengine/collections.svg?style=flat-square&color=blue)](https://www.npmjs.com/package/@boostengine/collections)
+[![npm downloads](https://img.shields.io/npm/dm/@boostengine/collections.svg?style=flat-square&color=green)](https://www.npmjs.com/package/@boostengine/collections)
+[![license](https://img.shields.io/npm/l/@boostengine/collections.svg?style=flat-square)](https://github.com/boostengine/boostengine/blob/main/LICENSE)
+[![Postman](https://img.shields.io/badge/Postman%20Schema-v2.1.0-orange.svg?style=flat-square)](https://www.postman.com/)
 
-Includes a zero-install **CLI tool** (`npx @boostengine/collections export`) to dump ready-to-import Postman JSON files into any project in 1 second.
+> **Pre-built, production-ready Postman Collections (Schema v2.1.0) and Environments for Indian and global eCommerce APIs: Razorpay, Cashfree, PhonePe, Paytm, Stripe, EasyEcom WMS, Shiprocket, Delhivery, and Shopify.**
 
----
-
-## ⚡ Quickstart (CLI)
+Test endpoints, simulate webhook payloads, and verify signatures in Postman with zero manual JSON schema authoring.
 
-Export complete collections and environment variables into your current working directory without installing:
+---
 
-```bash
-# Export all collections & environments
-npx @boostengine/collections export all
+## 📸 Postman Workspace Hierarchy Preview
+
+```text
+  Postman Collections (@boostengine/collections)
+  ├── 💳 Payment Gateways
+  │   ├── [POST] Cashfree - Create Order Token (UPI / Intent)
+  │   ├── [POST] Razorpay - Create Standard Order
+  │   ├── [POST] PhonePe - Check Payment Status
+  │   ├── [POST] Stripe - Create PaymentIntent
+  │   └── [POST] Webhooks - Simulate PAYMENT_SUCCESS
+  ├── 🚚 Logistics & Courier APIs
+  │   ├── [GET]  Shiprocket - Pincode Serviceability & Rate Check
+  │   ├── [POST] Delhivery - Generate AWB & Schedule Pickup
+  │   └── [GET]  Unified Tracking - Multi-Hub Checkpoints
+  └── 📦 WMS & Multi-Channel Inventory
+      ├── [POST] EasyEcom - Stock Sync by SKU
+      └── [GET]  Shopify Storefront - Catalog Graph Query
+```
 
-# Or export individually:
-npx @boostengine/collections export razorpay
-npx @boostengine/collections export easyecom
+---
 
-# Inspect available endpoints inside terminal:
-npx @boostengine/collections info razorpay
-```
+## 🌟 Key Highlights
 
-### 📥 How to Import into Postman / Bruno / Insomnia:
-1. Open **Postman** (or Insomnia / Bruno / ThunderClient).
-2. Click **Import** (Top left).
-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!
+- **🎯 1-Click Postman Import**: Import pre-configured collections with dynamic test scripts and pre-request HMAC hashing scripts.
+- **🔐 Environment Variables**: Includes `.postman_environment.json` templates with sandboxes and production endpoints.
+- **⚡ Webhook Simulators**: Pre-configured mock payloads for simulating real-world gateway events.
+- **🛠️ Programmatic Access**: Inspect and export schemas directly inside Node.js scripts or CI/CD pipelines.
 
 ---
 
-## 📦 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
+## 📦 Installation
 
----
+```bash
+# npm
+npm install @boostengine/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)
+# pnpm
+pnpm add @boostengine/collections
+
+# yarn
+yarn add @boostengine/collections
+```
 
 ---
 
-## 💻 Programmatic Node.js / TypeScript Usage
+## 🚀 Quickstart Guide
 
-You can also install this package as a dev dependency to programmatically parse or mock endpoints in your backend tests:
+### 1. Export Collections to Your Local Workspace via CLI
 
 ```bash
-npm install -D @boostengine/collections
+# Export all collections into a ./postman folder
+npx @boostengine/collections export ./postman
+
+# List all available collection schemas
+npx @boostengine/collections list
 ```
 
+---
+
+### 2. Programmatic Node.js Usage
+
 ```typescript
-import {
-  razorpayCollection,
-  easyecomCollection,
-  listCollections,
-  getCollection,
-  exportToDirectory,
-} from '@boostengine/collections';
-
-// List available collection summaries
-const available = listCollections();
-console.log(available);
-
-// Access raw Postman Schema v2.1.0 JSON object
-console.log(razorpayCollection.info.name);
-console.log(easyecomCollection.item.length);
-
-// Programmatically dump files in CI/CD or setup scripts
-exportToDirectory('all', './postman');
+import { getCollection, getEnvironment, listCollections } from '@boostengine/collections';
+
+// List all available API collections
+console.log(listCollections()); 
+// ['razorpay', 'cashfree', 'phonepe', 'shiprocket', 'delhivery', 'easyecom']
+
+// Get the Cashfree Postman JSON
+const cashfreeCollection = getCollection('cashfree');
+console.log(cashfreeCollection.info.name); // "Cashfree Payment Gateway"
 ```
 
 ---
 
 ## 📄 License
+
 MIT © [Boost Engine](https://github.com/boostengine)

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);