@deepintel-ltd/farmpro-contracts 1.5.14 → 1.5.16

package/dist/schemas/payments.schemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payments.schemas.d.ts","sourceRoot":"","sources":["../../src/schemas/payments.schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAQxB;;GAEG;AAGH,eAAO,MAAM,mBAAmB,0EAAwE,CAAC;AAGzG,eAAO,MAAM,qBAAqB,2BAAyB,CAAC;AAG5D,eAAO,MAAM,mBAAmB,yEAAuE,CAAC;AAGxG,eAAO,MAAM,oBAAoB,qEAAmE,CAAC;AAGrG,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAYV,CAAC;AAG3B,eAAO,MAAM,6BAA6B;;;;;;;;;;;;;;;;;;;;;EAOxC,CAAC;AAGH,eAAO,MAAM,6BAA6B;;;;;;;;;;;;EAIxC,CAAC;AAGH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGjC,CAAC;AAGF,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAAqD,CAAC;AACxF,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAAyD,CAAC;AAGhG,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;EASvC,CAAC;AAGH,eAAO,MAAM,oCAAoC;;;;;;;;;;;;;;;;;;;;;;;;;;;EAO/C,CAAC;AAGH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAoCnC,CAAC;AAGH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAChE,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AACpE,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAChE,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAClE,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AACxE,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAC;AAC/E,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAC;AAC/E,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AACpE,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAC5E,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC;AACzF,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oCAAoC,CAAC,CAAC;AAClG,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC"}

package/dist/schemas/payments.schemas.js

@@ -0,0 +1,105 @@
+import { z } from 'zod';
+import { timestampsSchema, createJsonApiResourceSchema, jsonApiSingleResponseSchema, jsonApiCollectionResponseSchema } from './common.schemas';
+/**
+ * Payment schemas - JSON:API compliant
+ */
+// Payment status enum
+export const paymentStatusSchema = z.enum(['pending', 'processing', 'completed', 'failed', 'cancelled']);
+// Payment currency enum
+export const paymentCurrencySchema = z.enum(['NGN', 'USD']);
+// Payment method enum
+export const paymentMethodSchema = z.enum(['card', 'bank_transfer', 'mobile_money', 'ussd', 'account']);
+// Payment gateway enum
+export const paymentGatewaySchema = z.enum(['flutterwave', 'paystack', 'stripe', 'paypal', 'other']);
+// Payment attributes schema (for JSON:API attributes object)
+export const paymentAttributesSchema = z.object({
+    amount: z.number().positive(),
+    currency: paymentCurrencySchema,
+    status: paymentStatusSchema,
+    paymentMethod: paymentMethodSchema.nullable().optional(),
+    gateway: paymentGatewaySchema,
+    gatewayTxRef: z.string().nullable().optional(),
+    gatewayTxId: z.string().nullable().optional(),
+    description: z.string().nullable().optional(),
+    metadata: z.record(z.unknown()).nullable().optional(),
+    failureReason: z.string().nullable().optional(),
+    paidAt: z.string().datetime().nullable().optional(),
+}).merge(timestampsSchema);
+// Payment attributes for creation (input)
+export const createPaymentAttributesSchema = z.object({
+    amount: z.number().positive(),
+    currency: paymentCurrencySchema.default('NGN'),
+    paymentMethod: paymentMethodSchema.optional(),
+    gateway: paymentGatewaySchema.default('flutterwave'), // Default to flutterwave for backward compatibility
+    description: z.string().max(500).optional(),
+    metadata: z.record(z.unknown()).optional(),
+});
+// Payment attributes for update (input) - typically only for admin operations
+export const updatePaymentAttributesSchema = z.object({
+    status: paymentStatusSchema.optional(),
+    failureReason: z.string().max(1000).optional(),
+    metadata: z.record(z.unknown()).optional(),
+});
+// Payment resource schema
+export const paymentResourceSchema = createJsonApiResourceSchema('payments', paymentAttributesSchema);
+// Payment response schemas
+export const paymentResponseSchema = jsonApiSingleResponseSchema(paymentResourceSchema);
+export const paymentListResponseSchema = jsonApiCollectionResponseSchema(paymentResourceSchema);
+// Flutterwave payment initialization request
+export const flutterwaveInitPaymentSchema = z.object({
+    amount: z.number().positive(),
+    currency: paymentCurrencySchema,
+    email: z.string().email(),
+    phone: z.string().optional(),
+    name: z.string().optional(),
+    paymentMethod: paymentMethodSchema.optional(),
+    description: z.string().max(500).optional(),
+    metadata: z.record(z.unknown()).optional(),
+});
+// Flutterwave payment initialization response
+export const flutterwaveInitPaymentResponseSchema = z.object({
+    status: z.literal('success'),
+    message: z.string(),
+    data: z.object({
+        link: z.string().url(), // Payment link for redirect
+        tx_ref: z.string(), // Transaction reference
+    }),
+});
+// Flutterwave webhook payload schema
+export const flutterwaveWebhookSchema = z.object({
+    event: z.string(),
+    data: z.object({
+        id: z.number(),
+        tx_ref: z.string(),
+        flw_ref: z.string(),
+        device_fingerprint: z.string().optional(),
+        amount: z.number(),
+        currency: z.string(),
+        charged_amount: z.number(),
+        app_fee: z.number(),
+        merchant_fee: z.number(),
+        processor_response: z.string().optional(),
+        auth_model: z.string().optional(),
+        card: z.object({
+            first_6digits: z.string().optional(),
+            last_4digits: z.string().optional(),
+            issuer: z.string().optional(),
+            country: z.string().optional(),
+            type: z.string().optional(),
+            token: z.string().optional(),
+            expiry: z.string().optional(),
+        }).optional(),
+        account_id: z.number(),
+        customer: z.object({
+            id: z.number(),
+            name: z.string(),
+            phone_number: z.string().optional(),
+            email: z.string(),
+            created_at: z.string(),
+        }),
+        status: z.string(),
+        payment_type: z.string(),
+        created_at: z.string(),
+        amount_settled: z.number().optional(),
+    }),
+});