@first-iraqi-bank/sdk 0.1.0 → 0.1.2

package/README.md

@@ -42,30 +42,10 @@ pnpm add @first-iraqi-bank/sdk
 
 ### deno
 
-direct import with `npm:` prefix:
-
-```ts
-import { PaymentSDK } from "npm:@first-iraqi-bank/sdk@pre/payment"
-```
-
-Or after adding the package to the import maps of your `deno.json` file:
-
-```json
-{
-  "imports": {
-    "@first-iraqi-bank/sdk": "npm:@first-iraqi-bank/sdk@pre"
-  }
-}
-```
-
-import using the name of the package only:
-
-```ts
-import { PaymentSDK } from "@first-iraqi-bank/sdk/payment"
+```sh
+deno add npm:@first-iraqi-bank/sdk
 ```
 
-in `deno.json`:
-
 ### bun
 
 ```sh
@@ -151,6 +131,9 @@ This method sends a request to the First Iraqi Bank's server, creating a payment
      1. Bigger than 12 Hours
      2. Smaller than 7 Days
 
+   - `redirectUri` _(optional)_: an instance of [`URL`](https://developer.mozilla.org/en-US/docs/Web/API/URL_API) class, you can provide
+   a URL of your app where the user should be redirected when the payment was authorized, for example if you want FIB app to redirect user
+   back to some screen inside your app/website, this is used when you use **Pay with FIB** button in your.
    - `statusCallbackUrl` _(optional)_: an instance of [`URL`](https://developer.mozilla.org/en-US/docs/Web/API/URL_API) class, this must be the URL of your backend and specifically of an endpoint that can accept `POST` request, as FIB backend will call this endpoint when the status of the transaction changes. Omit it if you're not interested.
 
 2. `accessToken`: a previously fetched access token from [`authenticate`](#authenticate) method.
@@ -164,7 +147,8 @@ import { FIB } from "./fib.js"
 const paymentInput = {
   amount: 1000, // amount in IQD
   description: "Payment for Order #12345",
-  statusCallbackUrl: new URL("https://your.callback.url/status"),
+  redirectUri: new URL("https://example.com/payments"),
+  statusCallbackUrl: new URL("https://example.com/api/callbacks/payment/status"),
   refundableFor: { days: 1 },
   expiresIn: { hours: 1 },
 }
@@ -245,6 +229,7 @@ const res = await FIB.refundPayment(paymentId, accessToken)
 type PaymentInput = {
   amount: number
   description?: string
+  redirectUri?: URL
   statusCallbackUrl?: URL
   expiresIn?: Duration
   refundableFor?: Duration

package/dist/payment.cjs

@@ -89,11 +89,13 @@ var HTTP = class extends BaseHTTP {
     description,
     expiresIn,
     refundableFor,
+    redirectUri,
     statusCallbackUrl
   }, accessToken, signal) {
     const url = new URL("/protected/v1/payments", this.getBaseUrl());
     const body = {
       description,
+      redirectUri: redirectUri?.toString(),
       statusCallbackUrl: statusCallbackUrl?.toString(),
       refundableFor: refundableFor ? formatISODuration(refundableFor) : void 0,
       expiresIn: expiresIn ? formatISODuration(expiresIn) : void 0,
@@ -154,13 +156,21 @@ var PaymentSDK = class {
   }
   createPayment({
     amount,
-    statusCallbackUrl,
     description,
+    expiresIn,
     refundableFor,
-    expiresIn
+    redirectUri,
+    statusCallbackUrl
   }, accessToken, signal) {
     return this.#http.createPayment(
-      { amount, statusCallbackUrl, description, refundableFor, expiresIn },
+      {
+        amount,
+        description,
+        expiresIn,
+        refundableFor,
+        redirectUri,
+        statusCallbackUrl
+      },
       accessToken,
       signal
     );

package/dist/payment.d.cts

@@ -25,6 +25,7 @@ type PaymentInput = {
     amount: number;
     description?: string;
     statusCallbackUrl?: URL;
+    redirectUri?: URL;
     expiresIn?: Duration;
     refundableFor?: Duration;
 };
@@ -86,7 +87,7 @@ declare class PaymentSDK {
     #private;
     private constructor();
     authenticate(signal?: AbortSignal): Promise<TypedResponse<TokenResponse>>;
-    createPayment({ amount, statusCallbackUrl, description, refundableFor, expiresIn, }: PaymentInput, accessToken: string, signal?: AbortSignal): Promise<TypedResponse<PaymentResponse>>;
+    createPayment({ amount, description, expiresIn, refundableFor, redirectUri, statusCallbackUrl, }: PaymentInput, accessToken: string, signal?: AbortSignal): Promise<TypedResponse<PaymentResponse>>;
     getPaymentStatus(paymentId: string, accessToken: string, signal?: AbortSignal): Promise<TypedResponse<PaymentStatusResponse>>;
     cancelPayment(paymentId: string, accessToken: string, signal?: AbortSignal): Promise<Response>;
     refundPayment(paymentId: string, accessToken: string, signal?: AbortSignal): Promise<Response>;

package/dist/payment.d.ts

@@ -25,6 +25,7 @@ type PaymentInput = {
     amount: number;
     description?: string;
     statusCallbackUrl?: URL;
+    redirectUri?: URL;
     expiresIn?: Duration;
     refundableFor?: Duration;
 };
@@ -86,7 +87,7 @@ declare class PaymentSDK {
     #private;
     private constructor();
     authenticate(signal?: AbortSignal): Promise<TypedResponse<TokenResponse>>;
-    createPayment({ amount, statusCallbackUrl, description, refundableFor, expiresIn, }: PaymentInput, accessToken: string, signal?: AbortSignal): Promise<TypedResponse<PaymentResponse>>;
+    createPayment({ amount, description, expiresIn, refundableFor, redirectUri, statusCallbackUrl, }: PaymentInput, accessToken: string, signal?: AbortSignal): Promise<TypedResponse<PaymentResponse>>;
     getPaymentStatus(paymentId: string, accessToken: string, signal?: AbortSignal): Promise<TypedResponse<PaymentStatusResponse>>;
     cancelPayment(paymentId: string, accessToken: string, signal?: AbortSignal): Promise<Response>;
     refundPayment(paymentId: string, accessToken: string, signal?: AbortSignal): Promise<Response>;

package/dist/payment.js

@@ -63,11 +63,13 @@ var HTTP = class extends BaseHTTP {
     description,
     expiresIn,
     refundableFor,
+    redirectUri,
     statusCallbackUrl
   }, accessToken, signal) {
     const url = new URL("/protected/v1/payments", this.getBaseUrl());
     const body = {
       description,
+      redirectUri: redirectUri?.toString(),
       statusCallbackUrl: statusCallbackUrl?.toString(),
       refundableFor: refundableFor ? formatISODuration(refundableFor) : void 0,
       expiresIn: expiresIn ? formatISODuration(expiresIn) : void 0,
@@ -128,13 +130,21 @@ var PaymentSDK = class {
   }
   createPayment({
     amount,
-    statusCallbackUrl,
     description,
+    expiresIn,
     refundableFor,
-    expiresIn
+    redirectUri,
+    statusCallbackUrl
   }, accessToken, signal) {
     return this.#http.createPayment(
-      { amount, statusCallbackUrl, description, refundableFor, expiresIn },
+      {
+        amount,
+        description,
+        expiresIn,
+        refundableFor,
+        redirectUri,
+        statusCallbackUrl
+      },
       accessToken,
       signal
     );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@first-iraqi-bank/sdk",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Accept payment and send payout from and to First Iraqi Bank customers with ease!",
   "type": "module",
   "files": [