Merge pull request #53 from alitnk/fix/zarinpal-required-description

fix: make `description` field required in zarinpal
alitnk · Jul 31, 2023 · 47531c4 · 47531c4
2 parents 210474a + 8138e81
commit 47531c4
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 6 deletions.
diff --git a/src/drivers/zarinpal/api.ts b/src/drivers/zarinpal/api.ts
@@ -33,7 +33,7 @@ export interface RequestPaymentReq {
   /**
    * 		توضیحات مربوط به تراکنش
    */
-  description?: string;
+  description: string;
 
   /**
    * 		صفحه بازگشت مشتري، پس از انجام عمل پرداخت
@@ -157,7 +157,11 @@ export const tConfig = t.intersection([
 
 export type Config = t.TypeOf<typeof tConfig>;
 
-export const tRequestOptions = t.intersection([t.partial({ mobile: t.string, email: t.string }), tBaseRequestOptions]);
+export const tRequestOptions = t.intersection([
+  t.partial({ mobile: t.string, email: t.string }),
+  t.type({ description: t.string }),
+  tBaseRequestOptions,
+]);
 
 export type RequestOptions = t.TypeOf<typeof tRequestOptions>;
 

diff --git a/test/drivers/zarinpal.spec.ts b/test/drivers/zarinpal.spec.ts
@@ -18,7 +18,9 @@ describe('Zarinpal Driver', () => {
 
     const driver = getPaymentDriver<Zarinpal>('zarinpal', { merchantId: '2134' });
 
-    expect(typeof (await driver.requestPayment({ amount: 2000, callbackUrl: 'asd' })).url).toBe('string');
+    expect(typeof (await driver.requestPayment({ amount: 2000, callbackUrl: 'asd', description: 'test' })).url).toBe(
+      'string',
+    );
   });
 
   it('throws payment errors accordingly', async () => {
@@ -31,9 +33,9 @@ describe('Zarinpal Driver', () => {
 
     const driver = getPaymentDriver<Zarinpal>('zarinpal', { merchantId: '2134' });
 
-    await expect(async () => await driver.requestPayment({ amount: 2000, callbackUrl: 'asd' })).rejects.toThrow(
-      RequestException,
-    );
+    await expect(
+      async () => await driver.requestPayment({ amount: 2000, callbackUrl: 'asd', description: 'test' }),
+    ).rejects.toThrow(RequestException);
   });
 
   it('verifies the purchase correctly', async () => {