mumz-strapi-plugin-coupon 1.1.0 → 1.1.1

package/README.md

@@ -1,311 +1,22 @@
-# Strapi Plugin - Coupon Management
-
+#Strapi Plugin - Coupon Management
 A centralized coupon management system for Strapi that handles validation, redemption, and tracking across multiple service domains.
 
 ## Requirements
-
 - Strapi 5.0.0 or higher
 - Node.js 18.0.0 or higher
 - npm 6.0.0 or higher
 - PostgreSQL, MySQL, or SQLite
 
 ## Features
-
-- ✅ Centralized coupon creation and management
-- ✅ Cross-domain coupon support (Homecare, Nannies, Gear Refresh, etc.)
-- ✅ Flexible discount types (percentage, flat)
-- ✅ Usage limits and validity periods
-- ✅ User eligibility validation
-- ✅ Service-specific applicability
-- ✅ Complete redemption audit trail
-- ✅ RESTful API endpoints
-- ✅ Race condition protection for concurrent redemptions
-- ✅ Input validation and sanitization
-- ✅ Rate limiting on public endpoints
-- ✅ TypeScript support with full type definitions
-
-## Installation
-
-### Using npm (via GitHub)
-
-```bash
-npm install github:mumzworld-tech/mumz-services-coupons-strapi-plugin
-```
-
-### Using yarn (via GitHub)
-
-```bash
-yarn add github:mumzworld-tech/mumz-services-coupons-strapi-plugin
-```
-
-## Configuration
-
-Add the plugin to your Strapi configuration:
-
-**`config/plugins.js`** or **`config/plugins.ts`**:
-
-```javascript
-module.exports = {
-  'coupon': {
-    enabled: true,
-    resolve: './node_modules/mumz-strapi-plugin-coupon'
-  },
-};
-```
-
-## API Endpoints
-
-### 1. Validate Coupon
-
-**POST** `/api/coupon/validate`
-
-Validates a coupon for a user before applying it.
-
-**Request Body:**
-```json
-{
-  "couponCode": "WELCOME10",
-  "phoneNumber": "+97155XXXXXX",
-  "orderAmount": 250.00
-}
-```
-
-**Success Response:**
-```json
-{
-  "isValid": true,
-  "discountType": "percentage",
-  "discountValue": 10,
-  "discountAmount": 25,
-  "finalAmount": 225.00,
-  "message": "Coupon applied successfully."
-}
-```
-
-**Error Response:**
-```json
-{
-  "isValid": false,
-  "errorCode": "COUPON_EXPIRED",
-  "message": "This coupon has expired."
-}
-```
-
-### 2. Redeem Coupon
-
-**POST** `/api/coupon/redeem`
-
-Marks a coupon as redeemed once successfully applied.
-
-**Request Body:**
-```json
-{
-  "couponCode": "WELCOME10",
-  "phoneNumber": "+97155XXXXXX",
-  "orderId": "order_67890",
-  "orderAmount": 250.00
-}
-```
-
-**Response:**
-```json
-{
-  "success": true,
-  "message": "Coupon redeemed successfully.",
-  "redemptionId": "redeem_1"
-}
-```
-
-### 3. Create Coupon (No Auth Required)
-
-**POST** `/api/coupon`
-
-Create new coupons. Authentication has been disabled for easier integration.
-
-**Request Body:**
-```json
-{
-  "code": "SUMMER25",
-  "discountType": "flat",
-  "discountValue": 25,
-  "maxUsage": 1000,
-  "validFrom": "2025-05-01T00:00:00Z",
-  "validTo": "2025-06-30T23:59:59Z"
-}
-```
-
-**Response:**
-```json
-{
-  "couponId": "coupon_abc123",
-  "message": "Coupon created successfully."
-}
-```
-
-## Error Codes
-
-| Code | Description |
-|------|-------------|
-| `COUPON_NOT_FOUND` | Coupon code does not exist |
-| `COUPON_EXPIRED` | Coupon validity period has expired |
-| `COUPON_ALREADY_USED` | User has already redeemed this coupon |
-| `USAGE_LIMIT_REACHED` | Coupon usage limit has been reached |
-
-## Quick Start
-
-### 1. Installation
-
-See [INSTALLATION.md](./INSTALLATION.md) for detailed installation instructions.
-
-```bash
-# Install from GitHub
-npm install github:mumzworld-tech/mumz-services-coupons-strapi-plugin#v1.0.0
-
-# Configure in config/plugins.js
-module.exports = {
-  'coupon': {
-    enabled: true,
-    resolve: './node_modules/mumz-strapi-plugin-coupon',
-  },
-};
-
-# Build and start Strapi
-npm run build
-npm run develop
-```
-
-### 2. Verify Installation
-
-Check that the plugin loaded successfully:
-- Admin panel shows **Coupon** and **Redemption** content types
-- Routes are registered: `npx strapi routes:list | grep coupon`
-- See console logs: "Coupon plugin registered" and "Coupon plugin bootstrapped"
-
-### 3. Test the Plugin
-
-See [TESTING.md](./TESTING.md) for comprehensive testing instructions.
-
-```bash
-# Create a test coupon via API
-curl -X POST http://localhost:1337/api/coupon \
-  -H "Content-Type: application/json" \
-  -d '{
-    "code": "WELCOME10",
-    "discountType": "percentage",
-    "discountValue": 10,
-    "maxUsage": 1000,
-    "validFrom": "2025-01-01T00:00:00Z",
-    "validTo": "2025-12-31T23:59:59Z",
-    "description": "Welcome discount - 10% off"
-  }'
-
-# Validate the coupon
-curl -X POST http://localhost:1337/api/coupon/validate \
-  -H "Content-Type: application/json" \
-  -d '{
-    "couponCode": "WELCOME10",
-    "phoneNumber": "+971551234567",
-    "orderAmount": 250.00
-  }'
-```
-
-## Development
-
-### Prerequisites
-
-- Node.js >= 18.x
-- npm >= 6.x
-
-### Setup
-
-```bash
-# Install dependencies
-npm install
-
-# Build the plugin
-npm run build
-
-# Watch mode for development
-npm run watch
-```
-
-### Building for Production
-
-```bash
-npm run clean
-npm run build
-```
-
-## Publishing to GitHub
-
-See [PUBLISHING.md](./PUBLISHING.md) for detailed instructions on publishing this plugin internally via GitHub.
-
-## TypeScript Usage
-
-The plugin is written in TypeScript and provides full type definitions:
-
-```typescript
-import type {
-  ValidateCouponRequest,
-  ValidationResponse,
-  RedeemCouponRequest,
-  RedemptionResponse,
-  CreateCouponRequest,
-  CreateResponse
-} from 'strapi-plugin-coupon/dist/services/coupon';
-
-// Example: Validate a coupon
-const result: ValidationResponse = await strapi
-  .plugin('coupon')
-  .service('coupon')
-  .validate({
-    couponCode: 'WELCOME10',
-    service: 'homecare',
-    phoneNumber: '+971551234567',
-    orderAmount: 250.00,
-  });
-
-if (result.isValid) {
-  console.log(`Discount: ${result.discountAmount}`);
-  console.log(`Final Amount: ${result.finalAmount}`);
-}
-```
-
-## Rate Limiting
-
-The plugin implements rate limiting on public endpoints:
-- `/validate`: 10 requests per minute per IP
-- `/redeem`: 5 requests per minute per IP
-
-The plugin uses in-memory rate limiting which is suitable for single-instance deployments.
-
-## Security Features
-
-- ✅ Input validation on all endpoints
-- ✅ Protection against SQL injection
-- ✅ Race condition prevention using optimistic locking
-- ✅ Phone number validation (E.164 format)
-- ✅ Service and coupon code validation
-- ✅ Rate limiting to prevent abuse
-
-## Troubleshooting
-
-### Build fails with TypeScript errors
-
-Ensure dependencies are installed:
-```bash
-npm install
-npm run build
-```
-
-### Plugin not loading in Strapi
-
-Verify the plugin configuration in `config/plugins.js` and ensure the plugin is properly installed in `node_modules`.
-
-### Rate limit errors (429)
-
-Default rate limits are 10 req/min for validate, 5 req/min for redeem. These can be adjusted in the route configuration.
-
-## License
-
-MIT
+✅ Centralized coupon creation and management
+✅ Cross-domain coupon support (Homecare, Nannies, Gear Refresh, etc.)
+✅ Flexible discount types (percentage, flat)
+✅ Usage limits and validity periods
+✅ User eligibility validation
+✅ Service-specific applicability
+✅ Complete redemption audit trail
+✅ RESTful API endpoints
+✅ Race condition protection for concurrent redemptions
+✅ Input validation and sanitization
+✅ Rate limiting on public endpoints
+✅ TypeScript support with full type definitions

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mumz-strapi-plugin-coupon",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "Strapi plugin for centralized coupon management across multiple services",
   "strapi": {
     "name": "coupon",