@drop-africa/drop-js 0.1.1 → 0.1.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Drop Africa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -8,12 +8,12 @@ Embed payment QR codes in your web app and poll for payment status changes in re
 
 ## Features
 
-- **QR Code Rendering**: High-quality, scannable QR codes with customizable styling
-- **Real-time Polling**: Automatic status updates with configurable intervals
+- **QR Code Rendering**: Scannable QR codes with customizable styling
+- **Polling**: Automatic status updates with configurable intervals
 - **Copyable Links**: Optional fallback for users who can't scan QR codes
 - **TypeScript Support**: Full type definitions included
-- **Validation**: Comprehensive input validation with clear error messages
-- **Browser Compatible**: Works in all modern browsers (Chrome, Firefox, Safari, Edge)
+- **Validation**: Input validation with descriptive error messages
+- **Browser Compatible**: Works in modern browsers (Chrome, Firefox, Safari, Edge)
 - **Lightweight**: ~22KB gzipped (ESM), ~19KB gzipped (UMD)
 
 ## Installation
@@ -50,7 +50,7 @@ npm install @drop-africa/drop-js
 ### NPM/React Usage
 
 ```typescript
-import { Drop } from '@drop-africa/drop-js';
+import { Drop, PaymentStatuses } from '@drop-africa/drop-js';
 
 function PaymentPage() {
   useEffect(() => {
@@ -59,7 +59,7 @@ function PaymentPage() {
       instanceUrl: 'https://drop.africa/api/v1/payment-accounts/acc_123/payment-intents/pi_456',
       containerId: 'payment-qr',
       onStatusChange: (status) => {
-        if (status === 'succeeded') {
+        if (status === PaymentStatuses.SUCCEEDED) {
           console.log('Payment successful!');
         }
       }
@@ -157,7 +157,7 @@ const status = instance.getStatus();
 | `succeeded` | Payment completed successfully |
 | `failed` | Payment failed (insufficient funds, network error, etc.) |
 | `cancelled` | Payment cancelled by customer or merchant |
-| `expired` | Payment intent expired (typically after 15 minutes) |
+| `expired` | Payment intent expired (typically after 24 hours) |
 
 ### Color Formats
 
@@ -244,6 +244,30 @@ Drop.create({
 | `VALIDATION_ERROR` | Invalid configuration | ❌ |
 | `UNKNOWN` | Unexpected error | ❌ |
 
+### Using Constants
+
+For type-safe handling, use the exported constants instead of string literals:
+
+```typescript
+import { Drop, ErrorCodes, PaymentStatuses } from '@drop-africa/drop-js';
+
+Drop.create({
+  clientSecret: 'pi_secret_1234567890',
+  instanceUrl: '...',
+  containerId: 'payment-qr',
+  onStatusChange: (status) => {
+    if (status === PaymentStatuses.SUCCEEDED) {
+      console.log('Payment successful!');
+    }
+  },
+  onError: (error) => {
+    if (error.code === ErrorCodes.NETWORK_ERROR) {
+      console.error('Network issue:', error.message);
+    }
+  }
+});
+```
+
 ## Browser Support
 
 Drop.js works in all modern browsers:
@@ -260,7 +284,7 @@ Drop.js works in all modern browsers:
 Full TypeScript definitions are included. Import types directly:
 
 ```typescript
-import { Drop, DropConfig, DropInstance, DropPaymentStatus, DropError } from '@drop-africa/drop-js';
+import { Drop, DropConfig, DropInstance, DropPaymentStatus, DropError, ErrorCodes, PaymentStatuses } from '@drop-africa/drop-js';
 
 const config: DropConfig = {
   clientSecret: 'pi_secret_1234567890',
@@ -277,11 +301,11 @@ const status: DropPaymentStatus = instance.getStatus();
 ### React Component
 
 ```typescript
-import { Drop, DropPaymentStatus } from '@drop-africa/drop-js';
+import { Drop, DropPaymentStatus, PaymentStatuses } from '@drop-africa/drop-js';
 import { useEffect, useState } from 'react';
 
 export function Payment({ clientSecret, instanceUrl }) {
-  const [status, setStatus] = useState<DropPaymentStatus>('initiated');
+  const [status, setStatus] = useState<DropPaymentStatus>(PaymentStatuses.INITIATED);
 
   useEffect(() => {
     const instance = await Drop.create({
@@ -296,7 +320,7 @@ export function Payment({ clientSecret, instanceUrl }) {
 
   return (
     <div>
-      {status === 'succeeded' ? (
+      {status === PaymentStatuses.SUCCEEDED ? (
         <p>Payment successful!</p>
       ) : (
         <div id="payment-qr"></div>
@@ -311,17 +335,17 @@ export function Payment({ clientSecret, instanceUrl }) {
 ```vue
 <template>
   <div>
-    <div v-if="status === 'succeeded'">Payment successful!</div>
+    <div v-if="status === PaymentStatuses.SUCCEEDED">Payment successful!</div>
     <div v-else id="payment-qr"></div>
   </div>
 </template>
 
 <script setup>
-import { Drop } from '@drop-africa/drop-js';
+import { Drop, PaymentStatuses } from '@drop-africa/drop-js';
 import { ref, onMounted, onUnmounted } from 'vue';
 
 const props = defineProps(['clientSecret', 'instanceUrl']);
-const status = ref('initiated');
+const status = ref(PaymentStatuses.INITIATED);
 let instance;
 
 onMounted(async () => {
@@ -355,13 +379,15 @@ onUnmounted(() => {
 
   <script src="https://cdn.drop.africa/sdk/drop.js"></script>
   <script>
+    const { PaymentStatuses } = Drop;
+
     Drop.create({
       clientSecret: 'pi_secret_1234567890abcdef',
       instanceUrl: 'https://drop.africa/api/v1/payment-accounts/acc_123/payment-intents/pi_456',
       containerId: 'payment-qr',
       onStatusChange: (status) => {
         document.getElementById('status').textContent = `Status: ${status}`;
-        if (status === 'succeeded') {
+        if (status === PaymentStatuses.SUCCEEDED) {
           alert('Payment successful!');
         }
       },
@@ -376,10 +402,10 @@ onUnmounted(() => {
 
 ## Links
 
-- [Documentation](https://github.com/Fabaladibbasey/drop/tree/main/sdk/drop-js)
-- [GitHub Repository](https://github.com/Fabaladibbasey/drop)
+- [Documentation](https://github.com/drop-africa/Drop.js-SDK#readme)
+- [GitHub Repository](https://github.com/drop-africa/Drop.js-SDK)
 - [npm Package](https://www.npmjs.com/package/@drop-africa/drop-js)
-- [Issues](https://github.com/Fabaladibbasey/drop/issues)
+- [Issues](https://github.com/drop-africa/Drop.js-SDK/issues)
 
 ## License