@boostengine/collections 1.1.0 → 1.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +61 -68
  2. package/package.json +12 -2
package/README.md CHANGED
@@ -1,98 +1,91 @@
1
- # @boostengine/collections
1
+ # @boostengine/collections 📮
2
2
 
3
- > 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**.
3
+ [![npm version](https://img.shields.io/npm/v/@boostengine/collections.svg?style=flat-square&color=blue)](https://www.npmjs.com/package/@boostengine/collections)
4
+ [![npm downloads](https://img.shields.io/npm/dm/@boostengine/collections.svg?style=flat-square&color=green)](https://www.npmjs.com/package/@boostengine/collections)
5
+ [![license](https://img.shields.io/npm/l/@boostengine/collections.svg?style=flat-square)](https://github.com/boostengine/boostengine/blob/main/LICENSE)
6
+ [![Postman](https://img.shields.io/badge/Postman%20Schema-v2.1.0-orange.svg?style=flat-square)](https://www.postman.com/)
4
7
 
5
- 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.
8
+ > **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.**
9
+
10
+ Test endpoints, simulate webhook payloads, and verify signatures in Postman with zero manual JSON schema authoring.
6
11
 
7
12
  ---
8
13
 
9
- ## ⚡ 1-Click Quickstart (CLI)
14
+ ## 📸 Postman Workspace Hierarchy Preview
15
+
16
+ ```text
17
+ Postman Collections (@boostengine/collections)
18
+ ├── 💳 Payment Gateways
19
+ │ ├── [POST] Cashfree - Create Order Token (UPI / Intent)
20
+ │ ├── [POST] Razorpay - Create Standard Order
21
+ │ ├── [POST] PhonePe - Check Payment Status
22
+ │ ├── [POST] Stripe - Create PaymentIntent
23
+ │ └── [POST] Webhooks - Simulate PAYMENT_SUCCESS
24
+ ├── 🚚 Logistics & Courier APIs
25
+ │ ├── [GET] Shiprocket - Pincode Serviceability & Rate Check
26
+ │ ├── [POST] Delhivery - Generate AWB & Schedule Pickup
27
+ │ └── [GET] Unified Tracking - Multi-Hub Checkpoints
28
+ └── 📦 WMS & Multi-Channel Inventory
29
+ ├── [POST] EasyEcom - Stock Sync by SKU
30
+ └── [GET] Shopify Storefront - Catalog Graph Query
31
+ ```
10
32
 
11
- Export any or all collections and environment variables into your project:
33
+ ---
12
34
 
13
- ```bash
14
- # Export all 9 collections & environments (18 files)
15
- npx @boostengine/collections export all
16
-
17
- # Or export individually:
18
- npx @boostengine/collections export razorpay
19
- npx @boostengine/collections export cashfree
20
- npx @boostengine/collections export phonepe
21
- npx @boostengine/collections export paytm
22
- npx @boostengine/collections export stripe
23
- npx @boostengine/collections export easyecom
24
- npx @boostengine/collections export shiprocket
25
- npx @boostengine/collections export delhivery
26
- npx @boostengine/collections export shopify
27
-
28
- # Inspect available endpoints inside your terminal:
29
- npx @boostengine/collections info razorpay
30
- npx @boostengine/collections info cashfree
31
- npx @boostengine/collections info shiprocket
32
- ```
35
+ ## 🌟 Key Highlights
33
36
 
34
- ### 📥 How to Import into Postman / Bruno / Insomnia:
35
- 1. Open **Postman** (or Insomnia / Bruno / ThunderClient / Hoppscotch).
36
- 2. Click **Import** (Top left corner).
37
- 3. Drag & drop the exported `*.collection.json` and `*.env.json` files.
38
- 4. Select the imported Environment from the top-right dropdown, enter your API keys, and start sending requests!
37
+ - **🎯 1-Click Postman Import**: Import pre-configured collections with dynamic test scripts and pre-request HMAC hashing scripts.
38
+ - **🔐 Environment Variables**: Includes `.postman_environment.json` templates with sandboxes and production endpoints.
39
+ - **⚡ Webhook Simulators**: Pre-configured mock payloads for simulating real-world gateway events.
40
+ - **🛠️ Programmatic Access**: Inspect and export schemas directly inside Node.js scripts or CI/CD pipelines.
39
41
 
40
42
  ---
41
43
 
42
- ## 📦 What's Included (9 Exhaustive Enterprise Collections)
44
+ ## 📦 Installation
45
+
46
+ ```bash
47
+ # npm
48
+ npm install @boostengine/collections
43
49
 
44
- | Provider | Category | Modules & Endpoints Included |
45
- | :--- | :--- | :--- |
46
- | **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`) |
47
- | **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`) |
48
- | **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 |
49
- | **Paytm** | 💳 Payments | Initiate Transaction Token, Checkout SDK session, Transaction Status Verification (`/v3/order/status`), Refund Initiation & Status, S2S Webhook Callback simulator |
50
- | **Stripe** | 💳 Global | Checkout Sessions, PaymentIntents (Cards/Wallets), Customers & Saved Payment Methods, Products & Subscriptions, Refunds & Disputes, Webhooks Simulator |
51
- | **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 |
52
- | **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 |
53
- | **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 |
54
- | **Shopify** | 🛍️ Storefront | Products & Multi-variant catalog, Orders & Status Filter, Fulfillments & Tracking Number attachment, Customers API, Multi-location Inventory Levels, Webhooks |
50
+ # pnpm
51
+ pnpm add @boostengine/collections
52
+
53
+ # yarn
54
+ yarn add @boostengine/collections
55
+ ```
55
56
 
56
57
  ---
57
58
 
58
- ## 💻 Programmatic Node.js / TypeScript Usage
59
+ ## 🚀 Quickstart Guide
59
60
 
60
- You can also install this package as a dependency to programmatically parse or mock endpoints in backend integration tests:
61
+ ### 1. Export Collections to Your Local Workspace via CLI
61
62
 
62
63
  ```bash
63
- npm install -D @boostengine/collections
64
- ```
64
+ # Export all collections into a ./postman folder
65
+ npx @boostengine/collections export ./postman
65
66
 
66
- ```typescript
67
- import {
68
- listCollections,
69
- getCollection,
70
- razorpayCollection,
71
- cashfreeCollection,
72
- phonepeCollection,
73
- paytmCollection,
74
- shiprocketCollection,
75
- } from '@boostengine/collections';
76
-
77
- // 1. List metadata and available folders:
78
- console.log(listCollections());
79
-
80
- // 2. Access raw Postman JSON collections programmatically:
81
- console.log('Razorpay requests:', razorpayCollection.item.length);
82
- console.log('Cashfree schema:', cashfreeCollection.info.schema);
67
+ # List all available collection schemas
68
+ npx @boostengine/collections list
83
69
  ```
84
70
 
85
71
  ---
86
72
 
87
- ## 🔄 Updating Upstream Collections
73
+ ### 2. Programmatic Node.js Usage
88
74
 
89
- Run the built-in sync audit tool to check upstream API versions:
75
+ ```typescript
76
+ import { getCollection, getEnvironment, listCollections } from '@boostengine/collections';
90
77
 
91
- ```bash
92
- npm run sync:upstream
78
+ // List all available API collections
79
+ console.log(listCollections());
80
+ // ['razorpay', 'cashfree', 'phonepe', 'shiprocket', 'delhivery', 'easyecom']
81
+
82
+ // Get the Cashfree Postman JSON
83
+ const cashfreeCollection = getCollection('cashfree');
84
+ console.log(cashfreeCollection.info.name); // "Cashfree Payment Gateway"
93
85
  ```
94
86
 
95
87
  ---
96
88
 
97
89
  ## 📄 License
98
- MIT © Boost Engine Team
90
+
91
+ MIT © [Boost Engine](https://github.com/boostengine)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@boostengine/collections",
3
- "version": "1.1.0",
3
+ "version": "1.1.2",
4
4
  "description": "Production-ready Postman Collections (Schema v2.1.0) & Environments for Razorpay, Cashfree, PhonePe, Paytm, Stripe, EasyEcom WMS, Shiprocket, Delhivery & Shopify.",
5
5
  "author": "Boost Engine <boostengine001@gmail.com>",
6
6
  "license": "MIT",
@@ -22,8 +22,18 @@
22
22
  "warehouse-management",
23
23
  "india-ecommerce",
24
24
  "api-testing",
25
- "rest-api"
25
+ "rest-api",
26
+ "ecommerce-api-collections"
26
27
  ],
28
+ "homepage": "https://github.com/boostengine/boostengine/tree/main/packages/boost-collections#readme",
29
+ "repository": {
30
+ "type": "git",
31
+ "url": "https://github.com/boostengine/boostengine.git",
32
+ "directory": "packages/boost-collections"
33
+ },
34
+ "bugs": {
35
+ "url": "https://github.com/boostengine/boostengine/issues"
36
+ },
27
37
  "bin": {
28
38
  "boost-collections": "./bin/cli.cjs"
29
39
  },