feat: type declaration #334

ankitdas13 · 2023-01-02T11:17:50Z

Feature Proposal

Added Declaration files for type support

Changes

There is no breaking changes, only package.json has been updated and added Razorpay, Api instance d.ts files including modules

Api reference

Addon api ✅
Plans api ✅
Items api ✅

Added (13 Feb)

(Reviewer Anurag)

Invoices api
Settlements api & api
fundAccount api

(Reviewer Siddhant)

Transfers api
Orders api

Added (14 Feb)

Payment api
QrCode api
Refund api
Virtual Account api

Customer api
PaymentLink api
Subscriptions api
Card api

Code snippets doc of all entities

Usage

import Razorpay = require("./dist/razorpay")

const instance =  new Razorpay({
    key_id: "",
    key_secret: ""
})

sidag95

Leaving some initial comments

sidag95 · 2023-01-16T09:50:05Z

lib/razorpay.d.ts

+
+declare class Razorpay {
+    static VERSION: string
+    static validateWebhookSignature: boolean


question: ‏Should this be a function that returns a boolean?

Added validateWebhookSignature from utility.d.ts with return type

sidag95 · 2023-01-16T10:07:09Z

lib/types/addons.d.ts

+    /**
+    * Fetches a addon given Addon ID
+    *
+    * @param {String} addonId


suggestion: ‏Lets add description for each param and return typedef

Added description from documentation

sidag95 · 2023-01-16T10:09:47Z

lib/types/addons.d.ts

+    * Fetches a addon given Addon ID
+    *
+    * @param {String} addonId
+    *


suggestion: ‏Lets add the optional callback param here

sidag95 · 2023-01-16T10:12:12Z

lib/types/addons.d.ts

+    *
+    * @param {String} addonId
+    *
+    * @return {Promise}


suggestion: ‏Lets update the return type based on whether the callback prop was provided

sidag95 · 2023-01-16T10:14:58Z

lib/types/addons.d.ts

+    /**
+    * Fetches a addon given Addon ID
+    *
+    * @param {String} addonId


question: ‏Is it {String} or {string} or it doesn't matter?

Changed to {string} according to JSDoc reference

sidag95 · 2023-01-16T10:16:52Z

lib/types/addons.d.ts

+    /**
+    * Get all addons
+    *
+    * @param {Object} params


suggestion: ‏Can we define the object structure here?

sidag95 · 2023-01-16T10:21:11Z

lib/types/api.d.ts

@@ -0,0 +1,41 @@
+interface IOption<T> {


suggestion: ‏Lets make the configuration options explicit instead of Generic

sidag95 · 2023-01-16T10:35:28Z

lib/types/api.d.ts

+    put(params: IPayload): Promise<any>
+    patch(params: IPayload): Promise<any>
+    delete(params: IPayload): Promise<any>
+    private allowedHeaders;


suggestion: ‏Lets remove these since these are internal and not exposed to the user

Removed all internal functions

sidag95 · 2023-01-16T10:40:30Z

lib/types/api.d.ts

+
+interface IPayload {
+    url: string,
+    params: IOption<any>


suggestion: ‏Make IPayload a Generic and pass that to a params, lets not use IOption here

Can we pass options to each API call?

sidag95 · 2023-01-16T10:42:50Z

lib/types/api.d.ts

+
+interface IPayload {
+    url: string,
+    params: IOption<any>


This is data and not params

Changed to data: T

sidag95 · 2023-01-23T07:46:09Z

lib/utils/razorpay-utils.d.ts

+* your webhook secret
+*
+*/
+export function validatePaymentVerification(payload: IRazorpayWebhook, signature: string, secret: string): boolean


suggestion: ‏Can we use union types here for the 3 different cases?

Used overloading here

sidag95 · 2023-01-23T07:51:02Z

lib/types/addons.d.ts

+     */
+    id: string,
+    /**
+     * The unique identifier of the created add-on.


question: ‏This is same as id?

Changed to Indicates the type of entity.

sidag95 · 2023-01-23T08:05:11Z

lib/types/addons.d.ts

+    description?: string;
+}
+
+export interface IRazorpayAddonId {


suggestion: ‏Lets rename this to IRazorpayAddon

sidag95 · 2023-01-23T08:30:19Z

lib/types/addons.d.ts

+import { IRazorpayItemId } from './items';
+
+
+export interface IRazorpayAddon {


suggestion: ‏Lets remove this in favour of IRazorpayItemCreateRequestBody

sidag95 · 2023-01-23T08:30:53Z

lib/types/items.d.ts

+    active?: boolean;
+  }
+
+  export interface IRazorpayItemId extends IRazorpayItem{


suggestion: ‏Lets rename this to IRazorpayItem

sidag95 · 2023-01-23T08:32:10Z

lib/types/items.d.ts

@@ -0,0 +1,64 @@
+import { IRazorpayQuery } from "./api";
+
+export interface IRazorpayItem {


suggestion: ‏Lets make this internal and rename to IRazorpayItemBaseRequestBody.

Then, lets create two implementations, IRazorpayItemCreateRequestBody extends IRazorpayItemBaseRequestBody
and IRazorpayItemUpdateRequestBody extends IRazorpayItemBaseRequestBody

Renamed these interfaces inside namespace

anuraghazra · 2023-02-08T08:18:45Z

lib/razorpay.d.ts

+
+declare class Razorpay {
+    static VERSION: string
+    static validateWebhookSignature(body: string, signature: string, secret: string): ReturnType<typeof validateWebhookSignature>


Suggested change

static validateWebhookSignature(body: string, signature: string, secret: string): ReturnType<typeof validateWebhookSignature>

static validateWebhookSignature: typeof validateWebhookSignature

Added typeof validateWebhookSignature

anuraghazra · 2023-02-08T08:19:52Z

lib/razorpay.d.ts

@@ -1 +1,48 @@
-declare module "razorpay";
+import API, { IRazorpayHeaders } from './types/api'
+import customers from "./types/customers"


Remove the imports if we are not adding the type.d.ts files for each module.

And instead add any:

customers: any;

anuraghazra · 2023-02-08T08:20:21Z

lib/razorpay.d.ts

+    constructor(config: IRazorpayConfig)
+    api: API
+    customers: ReturnType<typeof customers>
+    addons: ReturnType<typeof addons>


Nice to have:

Add jsdoc comment and link to API docs.

anuraghazra · 2023-02-08T08:21:04Z

lib/types/addons.d.ts

+    /**
+    * Delete a addon given Addon ID
+    *
+    * @param {string} addonId - addon id to be fetched 


We should not mix and match jsdoc types + typescript explicit types.

Just this will suffice:

@param addonId - addon id to be fetched

anuraghazra · 2023-02-08T08:23:33Z

lib/utils/razorpay-utils.d.ts

@@ -0,0 +1,56 @@
+export interface IRazorpayWebhook {


In the utils file, it will be a good thing if we also define the smaller util typedefs.

eg:

function getDateInSecs(date: Date): number { return (+new Date(date))/1000 } function normalizeDate(date: Date): number { return isNumber(date)? date : getDateInSecs(date) }

Typing smaller utils are good way to increase overall TS coverage since those utils might be used in lot of places, and TS will be able to infer more stricter types.

anuraghazra · 2023-02-08T08:24:46Z

lib/utils/razorpay-utils.d.ts

+export function validatePaymentVerification(payload: IRazorpayVerifyPayment, signature: string, secret: string): boolean
+export function validatePaymentVerification(payload: IRazorpayVerifySubscription, signature: string, secret: string): boolean
+export function validatePaymentVerification(payload: IRazorpayVerifyPaymentLink, signature: string, secret: string): boolean


These 3 overloads can be instead changed to use union since validatePaymentVerification function doesn't return anything different based on the payload param

export function validatePaymentVerification(payload: IRazorpayVerifyPayment | IRazorpayVerifySubscription | IRazorpayVerifyPaymentLink, signature: string, secret: string): boolean

anuraghazra · 2023-02-08T08:31:08Z

TODO:

Ensure no breaking change is happening cause of types.
Use yalc/verdaccio to test if the public types are correctly defined and getting resolved. (you can also try out this tool https://arethetypeswrong.github.io)

sidag95 · 2023-02-15T07:32:38Z

lib/types/api.d.ts

+
+export type RequiredOptional<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>
+
+export interface RazorpayQuery {


suggestion: ‏Lets name this RazorpayPaginationOptions

sidag95 · 2023-02-15T07:38:18Z

lib/types/settlements.d.ts

+        count: number;
+        items: Settlements.RazorpayInstantSettlement[];
+    }>
+    fetchAllOndemandSettlement(params: RazorpayQuery | { 'expand[]': 'ondemand_payouts' }, callback: (err: INormalizeError | null, data: {


question: ‏Why are these mutually exclusive? Isn't expand an optional parameter?

sidag95 · 2023-02-15T07:40:03Z

lib/types/settlements.d.ts

+    * @param params - Check [doc](https://razorpay.com/docs/api/settlements/instant#fetch-instant-settlement-by-id) for required params
+    * 
+    */
+    fetchOndemandSettlementById(settlementId: string, params: { 'expand[]': 'ondemand_payouts' }): Promise<Settlements.RazorpayInstantSettlement>;


suggestion: ‏Lets mark params and 'expand[]' optional

sidag95

Added a few comments

sidag95 · 2023-02-17T09:56:04Z

lib/types/transfers.d.ts

+         * These pairs can be useful for storing additional information about the entity. 
+         * A maximum of 15 key-value pairs, each of 256 characters (maximum), are supported.
+         */
+        notes?: IMap<string | number>;


question: ‏Can we confirm if this is an object or an array of objects?

sidag95 · 2023-02-17T10:23:51Z

lib/types/transfers.d.ts

+    * @param params - Check [doc](https://razorpay.com/docs/api/payments/route/transfers/#reverse-a-transfer) for required params
+    * 
+    */
+    reverse(transferId: string, params?: { amount: number }): Promise<Transfers.RazorpayReversal>


question: ‏Is params optional here?

sidag95 · 2023-02-17T10:24:15Z

lib/types/transfers.d.ts

+    * Fetch settlement details
+    * 
+    */
+    fetchSettlements(): Promise<{


question: ‏We can't pass anything to this function?

sidag95 · 2023-02-17T10:48:30Z

lib/types/virtualAccounts.d.ts

+        };
+    }
+
+    interface RazorpayVirtualAccountReceiver {


question: ‏Everything is optional?

sidag95 · 2023-02-17T11:04:30Z

lib/types/plans.d.ts

+    }
+}
+
+declare function plans(api: any): {


question: ‏ @ankitdas13 Payments has Plans types

ankitdas13 · 2023-02-17T13:53:36Z

@sidag95 Updated changelog.md for new release. Could you please let me know if it is looking good according to what we made changes?

## 2.8.5 - 

feat(Typescript): Migrated the SDK to TypeScript for better type safety and improved development experience.
- Added TypeScript definitions for all modules and functions in the SDK.
- Added comments throughout the codebase to improve readability and maintainability.
- Added a type declarations file (*.d.ts) to provide better type checking and editor support for consumers of the SDK.
- Improved the build process to incorporate the TypeScript compiler and generate both CommonJS and ES module versions of the SDK.

Overall, this update should provide a better developer experience for anyone using the SDK, by leveraging the power of TypeScript's static type checking and providing clearer documentation and comments throughout the codebase.

iAmServerless · 2023-02-21T07:40:00Z

CHANGELOG.md

+- Added TypeScript definitions for all modules and functions in the SDK.
+- Added comments throughout the codebase to improve readability and maintainability.
+- Added a type declarations file (*.d.ts) to provide better type checking and editor support for consumers of the SDK.
+- Improved the build process to incorporate the TypeScript compiler and generate both CommonJS and ES module versions of the SDK.


@sidag95 Are we also releasing ES modules? This is cool.

No this is not supported. @ankitdas13 Lets remove ES module version. We are not realsing it in ES modules. Let's remove this line.

sidag95 · 2023-02-21T08:58:46Z

package.json

@@ -7,7 +7,8 @@
  "scripts": {
    "prepublish": "npm test",
    "clean": "rm -rf dist && mkdir dist",
-    "cp-ts": "cp lib/razorpay.d.ts dist/",
+    "cp-types":"mkdir dist/types && cp lib/types/* dist/types && cp lib/utils/*d.ts dist/utils",


question: ‏Can we generate a single ts file and ship that? Do we have to copy all the type files here? Is that the standard practice?

If you see https://github.com/razorpay/blade/blob/master/packages/blade/package.json#L37, there seems to be a single ts file for all the components.

@anuraghazra Any comments on the above? Should we have a single type file or is shipping multiple files fine?

sidag95 · 2023-02-21T09:00:12Z

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog

+## 2.8.5 - 
+
+feat(Typescript): Migrated the SDK to TypeScript for better type safety and improved development experience.


suggestion: ‏We haven't migrated to Typescript yet. I think this is a little misleading. Lets just say that we are releasing typescript definitions for our consumers to use.

sidag95 · 2023-02-21T11:51:54Z

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog

+## 2.8.5 - 2023-02-21
+
+feat(Typescript): 


Suggested change

feat(Typescript):

feat(Typescript): add typescript definitions

sidag95 · 2023-02-21T11:52:05Z

CHANGELOG.md

+
+feat(Typescript): 
+
+- Added TypeScript definitions for all modules and functions in the SDK.


Suggested change

- Added TypeScript definitions for all modules and functions in the SDK.

- TypeScript definitions for all modules and functions in the SDK.

sidag95

LGTM

1995navinkumar · 2023-02-22T08:19:18Z

package.json

    "promise": "^8.1.0",
    "request": "^2.88.0",
-    "request-promise": "^4.2.6"
+    "request-promise": "^4.2.6",


Please note that this package is deprecated.

ankitdas13 added 2 commits January 2, 2023 16:46

type declaration files for addons & plans

feb0a80

update package.json

dadced7

ankitdas13 requested a review from sidag95 January 3, 2023 05:05

ankitdas13 added 3 commits January 3, 2023 16:17

changed plan declaration

fb20ad2

updated razorpay entity

985c67f

updated addon interface

608280d

sidag95 suggested changes Jan 16, 2023

View reviewed changes

added utility & callback func

18ba470

sidag95 reviewed Jan 23, 2023

View reviewed changes

added namespace and rename interface

fa280b9

ankitdas13 requested a review from sidag95 January 24, 2023 11:23

ankitdas13 added 2 commits February 3, 2023 13:22

added namespace and update plan interface

c9a7356

corrections in item & plan

18036a3

ankitdas13 requested a review from anuraghazra February 6, 2023 11:30

anuraghazra reviewed Feb 8, 2023

View reviewed changes

ankitdas13 added 3 commits February 8, 2023 19:46

added comments on entity

94bcd1b

rename interface

2d50c21

added utils typedef

aa28f8d

ankitdas13 requested a review from anuraghazra February 9, 2023 07:32

ankitdas13 requested a review from neeraj719714 February 14, 2023 10:16

added payments, qrcode, refund & virtualaccount entities

c08c6da

sidag95 reviewed Feb 15, 2023

View reviewed changes

pr comments changes

27d96a7

ankitdas13 requested a review from sidag95 February 16, 2023 10:29

added entities

eb41b06

sidag95 reviewed Feb 17, 2023

View reviewed changes

made correction and update changelog

a6de6a0

plan entity jsdoc correction

a3292c2

ankitdas13 requested a review from sidag95 February 17, 2023 13:56

ankitdas13 added 2 commits February 20, 2023 14:45

updated interfaces

d984583

correction in interface

ce8a201

ankitdas13 added the Tested label Feb 21, 2023

updated command

11587d6

ankitdas13 requested a review from iAmServerless February 21, 2023 07:39

iAmServerless approved these changes Feb 21, 2023

View reviewed changes

sidag95 reviewed Feb 21, 2023

View reviewed changes

updated feature description

e46c01b

sidag95 reviewed Feb 21, 2023

View reviewed changes

sidag95 approved these changes Feb 21, 2023

View reviewed changes

Merge branch 'master' into type-declaration

c2b5fec

1995navinkumar reviewed Feb 22, 2023

View reviewed changes

ankitdas13 added 2 commits February 22, 2023 17:05

update version

6656ca2

update tsconfig

97b78c7

ankitdas13 merged commit db52ce1 into master Feb 22, 2023

		import { IRazorpayItemId } from './items';


		export interface IRazorpayAddon {

		@@ -0,0 +1,64 @@
		import { IRazorpayQuery } from "./api";

		export interface IRazorpayItem {

	static validateWebhookSignature(body: string, signature: string, secret: string): ReturnType<typeof validateWebhookSignature>
	static validateWebhookSignature: typeof validateWebhookSignature


		export type RequiredOptional<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>

		export interface RazorpayQuery {

	feat(Typescript):
	feat(Typescript): add typescript definitions


		feat(Typescript):

		- Added TypeScript definitions for all modules and functions in the SDK.

	- Added TypeScript definitions for all modules and functions in the SDK.
	- TypeScript definitions for all modules and functions in the SDK.

feat: type declaration #334

feat: type declaration #334

Conversation

ankitdas13 commented Jan 2, 2023 • edited Loading

Feature Proposal

Changes

Api reference

Added (13 Feb)

(Reviewer Anurag)

(Reviewer Siddhant)

Added (14 Feb)

Code snippets doc of all entities

Usage

sidag95 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sidag95 Jan 23, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

anuraghazra commented Feb 8, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sidag95 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ankitdas13 commented Feb 17, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sidag95 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ankitdas13 commented Jan 2, 2023 •

edited

Loading

sidag95 Jan 23, 2023 •

edited

Loading

ankitdas13 commented Feb 17, 2023 •

edited

Loading