wip: easypost integration

graphql/schema.graphql

@@ -42,4 +42,5 @@ type Mutation {
     comment: ReturnRequestCommentInput
     refundData: RefundDataInput
   ): ReturnRequestResponse @withUserProfile
+  sendReturnLabel(requestId: String!, labelUrl: String!): Boolean
 }

graphql/types/ReturnRequest.graphql

@@ -45,6 +45,7 @@ input PickupReturnDataInput {
   country: String!
   zipCode: String!
   addressType: AddressType!
+  labelUrl: String!
 }
 
 enum AddressType {
@@ -110,7 +111,7 @@ type PickupReturnData {
   country: String!
   zipCode: String!
   addressType: AddressType!
-  returnLabel: String
+  labelUrl: String
 }
 
 type RefundPaymentData {

manifest.json

@@ -14,7 +14,8 @@
     "vtex.css-handles": "0.x",
     "vtex.easypost": "0.x",
     "vtex.tenant-graphql": "0.x",
-    "vtex.catalog-graphql": "1.x"
+    "vtex.catalog-graphql": "1.x",
+    "vtex.apps-graphql": "3.x"
   },
   "builders": {
     "admin": "0.x",

messages/context.json

@@ -308,6 +308,7 @@
   "return-app.return-request-details.order-id.link": "Order {orderId}",
   "return-app.return-request-details.current-status.request-id": "<b>Request id:</b> {id}",
   "return-app.return-request-details.current-status.status": "<b>Status:</b>",
+  "return-app.return-request-details.current-status.see-return-label": "See return label",
   "admin/return-app.return-request-list.table-data.requestId.tooltip": "Tooltip with an explanation of how the customer can access the data",
   "admin/return-app.settings.modal-warning.title": "Title of a modal to warn about max days settings",
   "admin/return-app.settings.modal-warning.first-paragraph": "First parahraph describing the warning",
@@ -320,6 +321,13 @@
   "store/return-app.return-order-details.pickup-address.drop-off-points.dropdown.placehoder": "Select a drop off point",
   "store/return-app.return-order-details.pickup-address.drop-off-points.dropdown.error": "There was an error loading the drop off points",
   "admin/return-app.return-request-details.localized-product-name.tooltip": "Tooltip for localized product names",
+  "admin/return-app.return-request-details.return-label.modal-title": "Are you sure you want to create a return shipping label?",
+  "admin/return-app.return-request-details.return-label.modal-message": "This action is irreversible. The created label will be sent via email to the customer.",
+  "admin/return-app.return-request-details.return-label.create-return-label": "Create return label",
+  "admin/return-app.return-request-details.return-label.see-return-label": "See return label",
+  "admin/return-app.return-request-details.return-label-info.tooltip": "Create a return shipping label and send it to the customer via email. The request status has to be processing. For this integration to work properly you must install and configure vtex.easypost.",
+  "admin/return-app.return-request-details.return-label.alert.success": "The return label was created successfully",
+  "admin/return-app.return-request-details.return-label.alert.error": "There was an error creating the return label, please try again.",
   "admin/return-app.settings.section.payment-options.refund-method-strategy.checkbox.label": "Automatically refund requests",
   "admin/return-app.settings.section.payment-options.refund-method-strategy.checkbox.description": "Automatically create the return invoice in the OMS for the requests",
   "return-app.return-request-details.payent-method.refund-option.refund-process": "Refund process: {automaticallyRefundPaymentMethod, select, true{Automatically} false{Manually}}",

messages/en.json

@@ -308,18 +308,26 @@
   "return-app.return-request-details.order-id.link": "Order {orderId}",
   "return-app.return-request-details.current-status.request-id": "<b>Request ID:</b> {id}",
   "return-app.return-request-details.current-status.status": "<b>Status:</b>",
+  "return-app.return-request-details.current-status.see-return-label": "See return label",
   "admin/return-app.return-request-list.table-data.requestId.tooltip": "Customers can see their request ID inside the request details",
   "admin/return-app.settings.modal-warning.title": "Please review your settings",
   "admin/return-app.settings.modal-warning.first-paragraph": "It looks like you are trying to save custom return options, none of which reach <b>{maxDays}</b>. This is the maximum days set for a return.",
   "admin/return-app.settings.modal-warning.second-paragraph": "A store user could potentially initiate the flow to create a return, but be unable to continue if their order date falls outside any of your custom options.",
   "admin/return-app.settings.modal-warning.third-paragraph": "If you click Edit, the maximum days for a return will be reduced from <b>{maxDays}</b> to <b>{customMaxDays}</b>. This is the Max Days shown in your custom return options.",
   "admin/return-app.settings.modal-warning.confirm": "Edit",
   "admin/return-app.settings.modal-warning.cancel": "Cancel",
-  "store/return-app.return-order-details.pickup-address.drop-off-points": "Select a drop-off point",
-  "store/return-app.return-order-details.pickup-address.drop-off-points.tooltip": "You can return your items in one of our selected drop-off points",
-  "store/return-app.return-order-details.pickup-address.drop-off-points.dropdown.placehoder": "Select a drop-off point",
-  "store/return-app.return-order-details.pickup-address.drop-off-points.dropdown.error": "There was an error loading the drop-off points",
+  "store/return-app.return-order-details.pickup-address.drop-off-points": "Select a drop off point",
+  "store/return-app.return-order-details.pickup-address.drop-off-points.tooltip": "You can return your items in one of our selected drop off points",
+  "store/return-app.return-order-details.pickup-address.drop-off-points.dropdown.placehoder": "Select a drop off point",
+  "store/return-app.return-order-details.pickup-address.drop-off-points.dropdown.error": "There was an error loading the drop off points",
   "admin/return-app.return-request-details.localized-product-name.tooltip": "Original item name from the order",
+  "admin/return-app.return-request-details.return-label.modal-title": "Are you sure you want to create a return shipping label?",
+  "admin/return-app.return-request-details.return-label.modal-message": "This action is irreversible. The created label will be sent via email to the customer.",
+  "admin/return-app.return-request-details.return-label.create-return-label": "Create return label",
+  "admin/return-app.return-request-details.return-label.see-return-label": "See return label",
+  "admin/return-app.return-request-details.return-label-info.tooltip": "Create a return shipping label and send it to the customer via email. The request status has to be processing. For this integration to work properly you must install and configure vtex.easypost.",
+  "admin/return-app.return-request-details.return-label.alert.success": "The return label was created successfully",
+  "admin/return-app.return-request-details.return-label.alert.error": "There was an error creating the return label, please try again.",
   "admin/return-app.settings.section.payment-options.refund-method-strategy.checkbox.label": "Automatically refund requests",
   "admin/return-app.settings.section.payment-options.refund-method-strategy.checkbox.description": "Automatically create a return invoice in OMS for the requests",
   "return-app.return-request-details.payent-method.refund-option.refund-process": "Refund process: {automaticallyRefundPaymentMethod, select, true{Automatic} false{Manual}}",

node/clients/mail.ts

@@ -5,6 +5,7 @@ import type {
   StatusUpdateMailData,
   ConfirmationMailData,
   Template,
+  ReturnLabelMailData,
 } from '../typings/mailClient'
 
 const MAIL_SERVICE_PATH = '/api/mail-service/pvt/sendmail'
@@ -21,7 +22,7 @@ export class MailClient extends JanusClient {
   }
 
   public sendMail(
-    mailData: StatusUpdateMailData | ConfirmationMailData
+    mailData: StatusUpdateMailData | ConfirmationMailData | ReturnLabelMailData
   ): Promise<string> {
     return this.http.post(MAIL_SERVICE_PATH, mailData, {
       metric: 'mail-post-send',
@@ -34,7 +35,7 @@ export class MailClient extends JanusClient {
     })
   }
 
-  public publishTemplate(template: Template): Promise<any> {
+  public publishTemplate(template: Template): Promise<unknown> {
     return this.http.post(TEMPLATE_RENDER_PATH, template, {
       headers: {
         ...this.options?.headers,

node/package.json

@@ -16,16 +16,17 @@
     "@vtex/tsconfig": "^0.6.0",
     "tslint": "^6.1.3",
     "tslint-config-vtex": "^2.1.0",
+    "vtex.apps-graphql": "http://vtex.vtexassets.com/_v/public/typings/v1/[email protected]/public/@types/vtex.apps-graphql",
     "vtex.catalog-graphql": "http://vtex.vtexassets.com/_v/public/typings/v1/[email protected]/public/@types/vtex.catalog-graphql",
     "vtex.css-handles": "http://vtex.vtexassets.com/_v/public/typings/v1/[email protected]/public/@types/vtex.css-handles",
     "vtex.easypost": "http://vtex.vtexassets.com/_v/public/typings/v1/[email protected]/public/@types/vtex.easypost",
     "vtex.format-currency": "http://vtex.vtexassets.com/_v/public/typings/v1/[email protected]/public/@types/vtex.format-currency",
     "vtex.my-account": "http://vtex.vtexassets.com/_v/public/typings/v1/[email protected]/public/@types/vtex.my-account",
     "vtex.my-account-commons": "http://vtex.vtexassets.com/_v/public/typings/v1/[email protected]/public/@types/vtex.my-account-commons",
     "vtex.render-runtime": "http://vtex.vtexassets.com/_v/public/typings/v1/[email protected]/public/@types/vtex.render-runtime",
-    "vtex.return-app": "http://vtex.vtexassets.com/_v/public/typings/v1/[email protected]/public/@types/vtex.return-app",
+    "vtex.return-app": "https://rraep--powerplanet.myvtex.com/_v/private/typings/linked/v1/[email protected]+build1662483831/public/@types/vtex.return-app",
     "vtex.store-graphql": "http://vtex.vtexassets.com/_v/public/typings/v1/[email protected]/public/@types/vtex.store-graphql",
-    "vtex.styleguide": "http://vtex.vtexassets.com/_v/public/typings/v1/[email protected].1/public/@types/vtex.styleguide",
+    "vtex.styleguide": "http://vtex.vtexassets.com/_v/public/typings/v1/[email protected].2/public/@types/vtex.styleguide",
     "vtex.tenant-graphql": "http://vtex.vtexassets.com/_v/public/typings/v1/[email protected]/public/@types/vtex.tenant-graphql"
   },
   "scripts": {

node/resolvers/index.ts

@@ -11,10 +11,12 @@ import { returnRequestList } from './returnRequestList'
 import { ReturnRequestResponse } from './ReturnRequestResponse'
 import { updateReturnRequestStatus } from './updateReturnRequestStatus'
 import { nearestPickupPoints } from './nearestPickupPoints'
+import { sendReturnLabel } from './sendReturnLabel'
 
 export const mutations = {
   createReturnRequest,
   updateReturnRequestStatus,
+  sendReturnLabel,
   ...settingsMutation,
 }
 

node/resolvers/sendReturnLabel.ts

@@ -0,0 +1,16 @@
+import { sendReturnLabelService } from '../services/sendReturnLabelService'
+
+interface QuerySendReturnLabelArgs {
+  requestId: string
+  labelUrl: string
+}
+
+export const sendReturnLabel = async (
+  _: unknown,
+  args: QuerySendReturnLabelArgs,
+  ctx: Context
+) => {
+  const { requestId, labelUrl } = args
+
+  return sendReturnLabelService(ctx, requestId, labelUrl)
+}

node/services/createReturnRequestService.ts

@@ -2,10 +2,7 @@ import type { ReturnRequestCreated, ReturnRequestInput } from 'vtex.return-app'
 import { UserInputError, ResolverError } from '@vtex/api'
 import type { DocumentResponse } from '@vtex/clients'
 
-import {
-  SETTINGS_PATH,
-  OMS_RETURN_REQUEST_CONFIRMATION,
-} from '../utils/constants'
+import { SETTINGS_PATH } from '../utils/constants'
 import { isUserAllowed } from '../utils/isUserAllowed'
 import { canOrderBeReturned } from '../utils/canOrderBeReturned'
 import { canReturnAllItems } from '../utils/canReturnAllItems'
@@ -17,6 +14,7 @@ import { createRefundableTotals } from '../utils/createRefundableTotals'
 import { OMS_RETURN_REQUEST_CONFIRMATION_TEMPLATE } from '../utils/templates'
 import type { ConfirmationMailData } from '../typings/mailClient'
 import { getCustomerEmail } from '../utils/getCostumerEmail'
+import { templateName } from '../utils/emailTemplates'
 import { validateItemCondition } from '../utils/validateItemCondition'
 
 export const createReturnRequestService = async (
@@ -285,7 +283,7 @@ export const createReturnRequestService = async (
   // We add a try/catch here so we avoid sending an error to the browser only if the email fails.
   try {
     const templateExists = await mail.getTemplate(
-      OMS_RETURN_REQUEST_CONFIRMATION(locale)
+      templateName('confirmation', locale)
     )
 
     if (!templateExists) {
@@ -305,7 +303,7 @@ export const createReturnRequestService = async (
     } = shippingData
 
     const mailData: ConfirmationMailData = {
-      templateName: OMS_RETURN_REQUEST_CONFIRMATION(locale),
+      templateName: templateName('confirmation', locale),
       jsonData: {
         data: {
           status: 'new',

node/services/sendReturnLabelService.ts

@@ -0,0 +1,96 @@
+import { ResolverError } from '@vtex/api'
+import type { ReturnRequest } from 'vtex.return-app'
+
+import type { ReturnLabelMailData } from '../typings/mailClient'
+import { templateName } from '../utils/emailTemplates'
+import { OMS_RETURN_REQUEST_LABEL_TEMPLATE } from '../utils/templates'
+import { formatRequestToPartialUpdate } from './updateRequestStatusService'
+
+export const sendReturnLabelService = async (
+  ctx: Context,
+  requestId: string,
+  labelUrl: string
+) => {
+  const {
+    clients: { mail, returnRequest: returnRequestClient },
+    vtex: { logger },
+  } = ctx
+
+  if (!requestId || !labelUrl) {
+    throw new ResolverError(
+      'The requestId or the labelUrl was not provided',
+      400
+    )
+  }
+
+  const returnRequest = (await returnRequestClient.get(requestId, [
+    '_all',
+  ])) as ReturnRequest
+
+  const {
+    pickupReturnData,
+    cultureInfoData: { locale },
+  } = returnRequest
+
+  const updatedPickupReturnData = {
+    ...pickupReturnData,
+    labelUrl,
+  }
+
+  const updatedRequest = {
+    ...formatRequestToPartialUpdate(returnRequest),
+    pickupReturnData: updatedPickupReturnData,
+  }
+
+  try {
+    await returnRequestClient.update(requestId, updatedRequest)
+  } catch (error) {
+    const mdValidationErrors = error?.response?.data?.errors[0]?.errors
+
+    const errorMessageString = mdValidationErrors
+      ? JSON.stringify(
+          {
+            message: 'Schema Validation error',
+            errors: mdValidationErrors,
+          },
+          null,
+          2
+        )
+      : error.message
+
+    throw new ResolverError(errorMessageString, error.response?.status || 500)
+  }
+
+  try {
+    const templateExists = await mail.getTemplate(templateName('label', locale))
+
+    if (!templateExists) {
+      await mail.publishTemplate(OMS_RETURN_REQUEST_LABEL_TEMPLATE(locale))
+    }
+
+    const { customerProfileData } = updatedRequest
+
+    const mailData: ReturnLabelMailData = {
+      templateName: templateName('label', locale),
+      jsonData: {
+        data: {
+          name: customerProfileData.name,
+          DocumentId: requestId,
+          email: customerProfileData.email,
+          labelUrl,
+        },
+      },
+    }
+
+    await mail.sendMail(mailData)
+  } catch (error) {
+    logger.warn({
+      message: `Failed to send email for return request ${requestId}`,
+      error,
+    })
+
+    return false
+  }
+
+  return true
+}

node/services/updateRequestStatusService.ts

@@ -15,14 +15,14 @@ import { validateStatusUpdate } from '../utils/validateStatusUpdate'
 import { createOrUpdateStatusPayload } from '../utils/createOrUpdateStatusPayload'
 import { createRefundData } from '../utils/createRefundData'
 import { handleRefund } from '../utils/handleRefund'
-import { OMS_RETURN_REQUEST_STATUS_UPDATE } from '../utils/constants'
 import { OMS_RETURN_REQUEST_STATUS_UPDATE_TEMPLATE } from '../utils/templates'
 import type { StatusUpdateMailData } from '../typings/mailClient'
+import { templateName } from '../utils/emailTemplates'
 
 // A partial update on MD requires all required field to be sent. https://vtex.slack.com/archives/C8EE14F1C/p1644422359807929
 // And the request to update fails when we pass the auto generated ones.
 // If any new field is added to the ReturnRequest as required, it has to be added here too.
-const formatRequestToPartialUpdate = (
+export const formatRequestToPartialUpdate = (
   request: ReturnRequest
 ): ReturnRequest => {
   const {
@@ -232,7 +232,7 @@ export const updateRequestStatusService = async (
   // We add a try/catch here so we avoid sending an error to the browser only if the email fails.
   try {
     const templateExists = await mail.getTemplate(
-      OMS_RETURN_REQUEST_STATUS_UPDATE(cultureInfoData?.locale)
+      templateName('status-update', cultureInfoData.locale)
     )
 
     if (!templateExists) {
@@ -251,7 +251,7 @@ export const updateRequestStatusService = async (
     } = updatedRequest
 
     const mailData: StatusUpdateMailData = {
-      templateName: OMS_RETURN_REQUEST_STATUS_UPDATE(cultureInfoData?.locale),
+      templateName: templateName('status-update', cultureInfoData.locale),
       jsonData: {
         data: {
           status: updatedStatus,
@@ -260,15 +260,22 @@ export const updateRequestStatusService = async (
           email: customerProfileData?.email ?? '',
           paymentMethod: refundPaymentData?.refundPaymentMethod ?? '',
           iban: refundPaymentData?.iban ?? '',
-          refundedAmount:
-            Number(updatedRefundData?.refundedItemsValue) +
-            Number(updatedRefundData?.refundedShippingValue),
         },
         products: items,
         refundStatusData: updatedRefundStatusData,
       },
     }
 
+    if (updatedRefundData?.refundedItemsValue) {
+      let refundedAmount = Number(updatedRefundData.refundedItemsValue)
+
+      if (updatedRefundData.refundedShippingValue) {
+        refundedAmount += Number(updatedRefundData.refundedShippingValue)
+      }
+
+      mailData.jsonData.data.refundedAmount = refundedAmount
+    }
+
     await mail.sendMail(mailData)
   } catch (error) {
     logger.warn({