Add Shop API extensions

.changeset/pretty-hairs-pay.md

@@ -0,0 +1,5 @@
+---
+"vendure-mpesa-plugin": patch
+---
+
+add shop api extensions to check and verify payment status

README.md

@@ -43,6 +43,8 @@ export const config: VendureConfig = {
 
 3. Calling the `addPaymentToOrder` mutation on the storefront with the corresponing payment method code will initiate an STK push to the customer's phone.
 
+4. Call the `verifyMpesaTransaction` mutation periodically on the storefront to verify the transaction status.
+
 ## Reference
 
 -   [Mpesa Daraja API Docs](https://developer.safaricom.co.ke/Documentation)

src/api/api-extensions.ts

@@ -0,0 +1,7 @@
+import gql from "graphql-tag"
+
+export const shopApiExtensions = gql`
+    extend type Mutation {
+        verifyMpesaTransaction(transactionId: String!): Boolean!
+    }
+`

src/api/mpesa-shop.resolver.ts

@@ -0,0 +1,21 @@
+import { Args, Mutation, Resolver } from "@nestjs/graphql"
+import { Ctx, RequestContext } from "@vendure/core"
+
+import { MpesaService } from "../service/mpesa.service"
+
+@Resolver()
+export class MpesaShopResolver {
+    constructor(private readonly mpesaService: MpesaService) {}
+
+    @Mutation()
+    async verifyMpesaTransaction(
+        @Ctx() ctx: RequestContext,
+        @Args() args: { transactionId: string }
+    ): Promise<boolean> {
+        const isSuccessful = await this.mpesaService.verifyMpesaPayment(
+            ctx,
+            args.transactionId
+        )
+        return isSuccessful
+    }
+}

src/mpesa.plugin.ts

@@ -1,6 +1,8 @@
 import { PluginCommonModule, VendurePlugin } from "@vendure/core"
 
+import { shopApiExtensions } from "./api/api-extensions"
 import { CallbackWebhookController } from "./api/callback-webhook.controller"
+import { MpesaShopResolver } from "./api/mpesa-shop.resolver"
 import { mpesaEligibilityChecker } from "./config/mpesa-eligibility-checker"
 import { mpesaPaymentMethodHandler } from "./config/mpesa.handler"
 import { MPESA_PLUGIN_INIT_OPTIONS } from "./constants"
@@ -68,6 +70,10 @@ export interface MpesaPluginOptions {
         )
         return config
     },
+    shopApiExtensions: {
+        schema: shopApiExtensions,
+        resolvers: [MpesaShopResolver]
+    },
     providers: [
         {
             provide: MPESA_PLUGIN_INIT_OPTIONS,

src/service/mpesa.service.ts

@@ -99,6 +99,16 @@ export class MpesaService {
         }
     }
 
+    async verifyMpesaPayment(ctx: RequestContext, transactionId: string) {
+        const payment = await this.getPaymentByTransactionId(ctx, transactionId)
+
+        if (!payment) {
+            return false
+        }
+
+        return payment.state === "Settled"
+    }
+
     async settlePayment(ctx: RequestContext, transactionId: string) {
         const isTransactionSuccessful =
             await this.checkTransactionStatus(transactionId)