Merge pull request #8 from amosmachora/dev

Dev

.changeset/silent-bikes-exercise.md

@@ -0,0 +1,5 @@
+---
+"react-daraja": patch
+---
+
+completed stkPushRequest function

.npmignore

@@ -8,4 +8,5 @@ index.css
 index.ts
 tailwind.config.js
 tsconfig.json
-types.ts
+types.ts
+src/

README.md

@@ -1,9 +1,75 @@
-# react-daraja
+# React Daraja
 
-A react library to interact with Safaricom`s daraja APIS
+React Daraja is a typesafe Javascript library designed to simplify interactions with the Safaricom Daraja API, specifically for STK push requests. This library is suitable for both Node.js and React environments, allowing developers to seamlessly integrate M-Pesa payments into their applications.
 
-## We are not ready yet. A comprehensive documentation will be available when we go live
+## Installation
 
-Right now i am still testing this library.
+To install React Daraja, run the following command in your project's terminal:
 
-Peace.
+```bash
+  npm install react-daraja
+```
+
+## Getting Started
+
+Before using the library, make sure to set up the required environment variables in the .env file. These variables include:
+
+- **NODE_ENV**: Set the environment to either "production" or "development."
+
+- **MPESA_CONSUMER_KEY**: Consumer Key obtained from Safaricom Daraja.
+
+- **MPESA_CONSUMER_SECRET**: Consumer Secret obtained from Safaricom Daraja.
+
+- **MPESA_BUSINESS_SHORT_CODE**: Your M-Pesa business short code. For Sandbox use the code **174379**
+
+- **MPESA_TRANSACTION_TYPE**: Set the transaction type, either "CustomerPayBillOnline" or "CustomerBuyGoodsOnline."
+
+- **MPESA_API_PASS_KEY**: Your M-Pesa API pass key. For sandbox use **bfb279f9aa9bdbcf158e97dd71a467cd2e0c893059b10f78e6b72ada1ed2c919**
+
+The library throws errors if any of this values are missing from your .env file.
+
+## Usage/Examples
+
+- **STK Push Request**
+
+It allows you to initiate an STK push request for M-Pesa payments in **node**. Here is an example of how to use it:
+
+```javascript
+import { stkPushRequest } from "react-daraja";
+
+const makeSTKPushRequest = async () => {
+  try {
+    const response = await stkPushRequest({
+      phoneNumber: "254719428019",
+      amount: "100",
+      callbackURL: "https://example.com/api/stk-push-callback",
+      transactionDesc: "Payment for your service",
+      accountReference: "[email protected]",
+    });
+
+    console.log("STK Push Request Successful:", response);
+  } catch (error) {
+    console.error("Error:", error.message);
+  }
+};
+
+makeSTKPushRequest();
+```
+
+and thats it!. The library handles access tokens etc and caches them gracefully.
+
+Make sure to replace the placeholder values with your actual data.
+
+Note: Ensure that your environment variables are correctly set, and the provided values match your Safaricom Daraja account configuration.
+
+Don`t call stkPushRequest from the frontend though. You wil run into all forms of cors errors.
+
+## Compatibility
+
+React Daraja is compatible with Node.js and React environments. It provides a simple interface for initiating M-Pesa transactions using the Safaricom Daraja API.
+
+Some APIs are exclusively for Node Environments and some are just React Components so are only used in react.
+
+## License
+
+This library is licensed under the MIT License. Feel free to contribute or open issues on the GitHub repository. More APIs and components coming. Watch this repo for alerts.

src/access-token.ts

@@ -5,7 +5,7 @@ import { AccessTokenResponse } from "../types";
 
 export const generateAccessToken = async (): Promise<AccessTokenResponse> => {
   const credentials = `${CONSUMER_KEY}:${CONSUMER_SECRET}`;
-  const encodedCredentials = btoa(credentials);
+  const encodedAuthString = Buffer.from(credentials).toString("base64");
 
   const token: AccessTokenResponse = cache.get("act");
 
@@ -18,16 +18,16 @@ export const generateAccessToken = async (): Promise<AccessTokenResponse> => {
       `${BASE_URL}/oauth/v1/generate?grant_type=client_credentials`,
       {
         headers: {
-          Authorization: `Bearer ${encodedCredentials}`,
-          "Access-Control-Allow-Origin": "*",
+          Authorization: `Basic ${encodedAuthString}`,
         },
       }
     );
 
-    cache.put("act", res.data, res.data.expires_in);
+    cache.put("act", res.data, 3600);
 
     return res.data;
   } catch (err: any) {
+    console.error(err);
     throw new Error(
       `Error occurred with status code ${err.response?.status}, ${err.response?.statusText}`
     );

src/env.ts

@@ -19,17 +19,19 @@ export const CONSUMER_SECRET = assertValue(
 );
 
 export const BUSINESS_SHORT_CODE = assertValue(
-  process.env.BUSINESS_SHORT_CODE,
-  "Missing environment variable: BUSINESS_SHORT_CODE"
+  process.env.MPESA_BUSINESS_SHORT_CODE,
+  "Missing environment variable: MPESA_BUSINESS_SHORT_CODE"
 );
 
-export const PRODUCTION_PASS_KEY =
-  ENVIRONMENT === "production"
-    ? assertValue(
-        process.env.PRODUCTION_PASS_KEY,
-        "Missing environment variable: PRODUCTION_PASS_KEY"
-      )
-    : null;
+export const MPESA_TRANSACTION_TYPE = assertValue(
+  process.env.MPESA_TRANSACTION_TYPE,
+  "Missing environment variable: MPESA_TRANSACTION_TYPE"
+);
+
+export const PASSKEY = assertValue(
+  process.env.MPESA_API_PASS_KEY,
+  "Missing environment variable: PASSKEY"
+);
 
 function assertValue<T>(v: T | undefined, errorMessage: string): T {
   if (v === undefined) {

src/index.ts

@@ -27,15 +27,15 @@ import { generateAccessToken } from "./access-token";
 export const getStateOfALNMOnlinePayment = async (
   stateOfALNMOnlinePaymentBody: StateOfALNMOnlinePaymentBody
 ): Promise<StateOfALNMOnlinePaymentResponse> => {
-  const accessToken = await generateAccessToken();
+  const { access_token } = await generateAccessToken();
 
   try {
     const res: StateOfALNMOnlinePaymentResponse = await axios.post(
       `${BASE_URL}/mpesa/stkpushquery/v1/query`,
       stateOfALNMOnlinePaymentBody,
       {
         headers: {
-          Authorization: `Bearer ${accessToken}`,
+          Authorization: `Bearer ${access_token}`,
         },
       }
     );
@@ -51,15 +51,15 @@ export const getStateOfALNMOnlinePayment = async (
 export const registerC2BUrl = async (
   registerUrlBody: RegisterUrlBody
 ): Promise<RegisterUrlResponse> => {
-  const accessToken = await generateAccessToken();
+  const { access_token } = await generateAccessToken();
 
   try {
     const res: RegisterUrlResponse = await axios.post(
       `${BASE_URL}/mpesa/c2b/v1/registerurl`,
       registerUrlBody,
       {
         headers: {
-          Authorization: `Bearer ${accessToken}`,
+          Authorization: `Bearer ${access_token}`,
         },
       }
     );
@@ -75,15 +75,15 @@ export const registerC2BUrl = async (
 export const b2cPaymentRequest = async (
   b2CBody: B2CRequestBody
 ): Promise<B2CRequestResponse> => {
-  const accessToken = await generateAccessToken();
+  const { access_token } = await generateAccessToken();
 
   try {
     const res: B2CRequestResponse = await axios.post(
       `${BASE_URL}/mpesa/b2c/v1/paymentrequest`,
       b2CBody,
       {
         headers: {
-          Authorization: `Bearer ${accessToken}`,
+          Authorization: `Bearer ${access_token}`,
         },
       }
     );
@@ -98,15 +98,15 @@ export const b2cPaymentRequest = async (
 export const b2bPaymentRequest = async (
   body: BusinessRequestBody
 ): Promise<BusinessRequestResponse> => {
-  const accessToken = await generateAccessToken();
+  const { access_token } = await generateAccessToken();
 
   try {
     const res: BusinessRequestResponse = await axios.post(
       `${BASE_URL}/mpesa/b2b/v1/paymentrequest`,
       body,
       {
         headers: {
-          Authorization: `Bearer ${accessToken}`,
+          Authorization: `Bearer ${access_token}`,
         },
       }
     );
@@ -121,15 +121,15 @@ export const b2bPaymentRequest = async (
 export const getTransactionStatus = async (
   transactionStatusBody: TransactionStatusBody
 ): Promise<TransactionStatusResponse> => {
-  const accessToken = await generateAccessToken();
+  const { access_token } = await generateAccessToken();
 
   try {
     const res: TransactionStatusResponse = await axios.post(
       `${BASE_URL}/mpesa/transactionstatus/v1/query`,
       transactionStatusBody,
       {
         headers: {
-          Authorization: `Bearer ${accessToken}`,
+          Authorization: `Bearer ${access_token}`,
         },
       }
     );
@@ -144,15 +144,15 @@ export const getTransactionStatus = async (
 export const getAccountBalance = async (
   accountBalance: AccountBalanceBody
 ): Promise<AccountBalanceResponse> => {
-  const accessToken = await generateAccessToken();
+  const { access_token } = await generateAccessToken();
 
   try {
     const res: AccountBalanceResponse = await axios.post(
       `${BASE_URL}/mpesa/accountbalance/v1/query`,
       accountBalance,
       {
         headers: {
-          Authorization: `Bearer ${accessToken}`,
+          Authorization: `Bearer ${access_token}`,
         },
       }
     );
@@ -167,15 +167,15 @@ export const getAccountBalance = async (
 export const reverseC2BTransaction = async (
   body: ReverseC2BTransactionBody
 ): Promise<ReverseC2BTransactionResponse> => {
-  const accessToken = await generateAccessToken();
+  const { access_token } = await generateAccessToken();
 
   try {
     const res: ReverseC2BTransactionResponse = await axios.post(
       `${BASE_URL}/mpesa/reversal/v1/request`,
       body,
       {
         headers: {
-          Authorization: `Bearer ${accessToken}`,
+          Authorization: `Bearer ${access_token}`,
         },
       }
     );
@@ -190,15 +190,15 @@ export const reverseC2BTransaction = async (
 export const remitTax = async (
   body: TaxRemittanceBody
 ): Promise<TaxRemittanceResponse> => {
-  const accessToken = await generateAccessToken();
+  const { access_token } = await generateAccessToken();
 
   try {
     const res: TaxRemittanceResponse = await axios.post(
       `${BASE_URL}/mpesa/b2b/v1/remittax`,
       body,
       {
         headers: {
-          Authorization: `Bearer ${accessToken}`,
+          Authorization: `Bearer ${access_token}`,
         },
       }
     );
@@ -212,3 +212,4 @@ export const remitTax = async (
 
 export { stkPushRequest } from "./stk-push";
 export { QRCodeDisplay } from "../components/QRCodeDisplay";
+export * from "../types";