docs: changed details related to new method signatures #2876

shahednasser · 2022-12-22T11:52:11Z

Changed details in the Payment Provider docs regarding new method signature.

Closes DOCS-390

changeset-bot · 2022-12-22T11:52:15Z

⚠️ No Changeset found

Latest commit: 12b98e9

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

adrien2p

Here are few changes 💪

adrien2p · 2023-01-04T08:34:20Z

docs/content/advanced/backend/payment/how-to-create-payment-provider.md

-  Cart, Data, Payment, PaymentSession, 
-  PaymentSessionStatus, TransactionBaseService, 
-} from "@medusajs/medusa"
+import { AbstractPaymentService, Context, Data, Payment, PaymentSession, PaymentSessionStatus, TransactionBaseService } from "@medusajs/medusa"
 import { EntityManager } from "typeorm"

 class MyPaymentService extends AbstractPaymentService<TransactionBaseService> {


todo: The class is not template, rm TransactionBaseService

adrien2p · 2023-01-04T08:35:29Z

docs/content/advanced/backend/payment/how-to-create-payment-provider.md

-  Cart, Data, Payment, PaymentSession, 
-  PaymentSessionStatus, TransactionBaseService, 
-} from "@medusajs/medusa"
+import { AbstractPaymentService, Context, Data, Payment, PaymentSession, PaymentSessionStatus, TransactionBaseService } from "@medusajs/medusa"
 import { EntityManager } from "typeorm"

 class MyPaymentService extends AbstractPaymentService<TransactionBaseService> {
  protected manager_: EntityManager
  protected transactionManager_: EntityManager


todo: | undefined

adrien2p · 2023-01-04T08:36:31Z

docs/content/advanced/backend/payment/how-to-create-payment-provider.md

    throw new Error("Method not implemented.")
  }
-  updatePaymentData(paymentSessionData: Data, data: Data): Promise<Data> {
+  async updatePaymentData(paymentSessionData: Data, data: Data): Promise<Data> {


todo: async updatePaymentData(paymentSessionData: PaymentSessionData, data: Data): Promise<PaymentSessionData>

adrien2p · 2023-01-04T08:37:23Z

docs/content/advanced/backend/payment/how-to-create-payment-provider.md

    throw new Error("Method not implemented.")
  }
-  createPayment(cart: Cart): Promise<Data> {
+  async createPayment(context: Context): Promise<PaymentSessionResponse> {


todo: Cart & PaymentContext)

Should we include Cart though? Because we're moving to PaymentContext and Cart is used for backwards compatibility (from my understanding)

The thing is that TS will error out because the typings are mismatched. PaymentContext can't be assigned to Cart & PaymentContext

Ah ok I didn't notice that. Will make the change!

adrien2p · 2023-01-04T08:37:50Z

docs/content/advanced/backend/payment/how-to-create-payment-provider.md

    throw new Error("Method not implemented.")
  }
-  updatePayment(paymentSessionData: Data, cart: Cart): Promise<Data> {
+  async updatePayment(paymentSessionData: Data, context: Context): Promise<PaymentSessionResponse> {


todo:
paymentSessionData: PaymentSessionData, context: Cart & PaymentContext

adrien2p · 2023-01-04T08:40:28Z

docs/content/advanced/backend/payment/how-to-create-payment-provider.md

@@ -137,8 +130,8 @@ Additionally, if you’re creating your Payment Provider as an external plugin t
 ```ts
 class MyPaymentService extends AbstractPaymentService<TransactionBaseService> {


todo: rm template

adrien2p · 2023-01-04T08:42:09Z

docs/content/advanced/backend/payment/how-to-create-payment-provider.md

+
+For example, in Stripe this method is used to initialize a Payment Intent for the customer.
+
+The method receives a context object as a first parameter. This object is of type `PaymentContext` and has the following properties:


todo: is of type Cart & PaymentContext.
This is for the backward compatibility. do you think it should be mentioned? plus it will change soon with the new payment processor API. I let you choose

adrien2p · 2023-01-04T08:43:29Z

docs/content/advanced/backend/payment/how-to-create-payment-provider.md


 class MyPaymentService extends AbstractPaymentService<TransactionBaseService> {
  // ...
-  async createPayment(cart: Cart): Promise<Data> {
+  async createPayment(context: PaymentContext): Promise<PaymentSessionResponse> {


todo: Cart & PaymentContext

adrien2p · 2023-01-04T08:45:17Z

docs/content/advanced/backend/payment/how-to-create-payment-provider.md

@@ -244,24 +267,56 @@ A line item refers to a product in the cart.

 :::

-It accepts the `data` field of the Payment Session as the first parameter and the cart as an object for the second parameter.
+It accepts the `data` field of the Payment Session as the first parameter and a context object as a second parameter. This object is of type `PaymentContext` and has the following properties:


todo: same as the previous one

adrien2p · 2023-01-04T08:46:53Z

docs/content/advanced/backend/payment/how-to-create-payment-provider.md


 <!-- eslint-disable max-len -->

 ```ts
-import { Cart, Data } from "@medusajs/medusa"
+import { PaymentContext, Data } from "@medusajs/medusa"


todo: To update according to previous todo's

adrien2p

LGTM 🎉 just some description still showing PaymentContext only but I suppose it is the final choice is that right?

shahednasser · 2023-01-05T08:43:44Z

@adrien2p yes I added a note about how before v1.7.2 Cart was allowed but moving forward it's recommended to use PaymentContext even though it's still backwards compatible at the moment

docs: changed details related to new method signatures

14a53e6

shahednasser requested a review from a team as a code owner December 22, 2022 11:52

shahednasser requested a review from adrien2p December 22, 2022 11:52

shahednasser added 5 commits December 22, 2022 16:43

updated the information regarding update_requests

a8e6536

small changes to the text

04574f7

Merge branch 'master' into docs/payment-provider-updates-171

f785f76

lint fixes

974905a

fixed constructor

d4fb094

adrien2p requested changes Jan 4, 2023

View reviewed changes

fixes based on review

12b98e9

shahednasser requested a review from adrien2p January 4, 2023 14:28

adrien2p approved these changes Jan 5, 2023

View reviewed changes

shahednasser merged commit 8ba27a2 into master Jan 5, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: changed details related to new method signatures #2876

docs: changed details related to new method signatures #2876

shahednasser commented Dec 22, 2022

changeset-bot bot commented Dec 22, 2022 •

edited

Loading

adrien2p left a comment

adrien2p Jan 4, 2023

adrien2p Jan 4, 2023

adrien2p Jan 4, 2023

adrien2p Jan 4, 2023

shahednasser Jan 4, 2023

adrien2p Jan 4, 2023 •

edited

Loading

shahednasser Jan 4, 2023

adrien2p Jan 4, 2023

adrien2p Jan 4, 2023

adrien2p Jan 4, 2023

adrien2p Jan 4, 2023

adrien2p Jan 4, 2023

adrien2p Jan 4, 2023

adrien2p left a comment

shahednasser commented Jan 5, 2023

		@@ -137,8 +130,8 @@ Additionally, if you’re creating your Payment Provider as an external plugin t
		```ts
		class MyPaymentService extends AbstractPaymentService<TransactionBaseService> {


		For example, in Stripe this method is used to initialize a Payment Intent for the customer.

		The method receives a context object as a first parameter. This object is of type `PaymentContext` and has the following properties:

docs: changed details related to new method signatures #2876

docs: changed details related to new method signatures #2876

Conversation

shahednasser commented Dec 22, 2022

changeset-bot bot commented Dec 22, 2022 • edited Loading

⚠️ No Changeset found

adrien2p 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

adrien2p Jan 4, 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

adrien2p left a comment

Choose a reason for hiding this comment

shahednasser commented Jan 5, 2023

changeset-bot bot commented Dec 22, 2022 •

edited

Loading

adrien2p Jan 4, 2023 •

edited

Loading