Feature/obi 483 refundable ammounts

.eslintignore

@@ -1,3 +1,4 @@
 node_modules/
 coverage/
-*.snap.ts
+*.snap.ts
+typings/

graphql/types/ReturnSettings.graphql

@@ -1,15 +1,13 @@
 input ReturnSettingsFilters {
   id: String
   sellerName: String
-
 }
 
 type ReturnSettingsList {
   list: [ReturnSettingsResponse!]!
   paging: Pagination!
 }
 
-
 type ReturnSettingsResponse {
   id: ID!
   sellerId: String

graphql/types/SellerSetting.graphql

@@ -15,7 +15,7 @@ type SellerSettingResponseList {
   sellers: [SellerSetting]
 }
 
-input SellerSettingInput  {
+input SellerSettingInput {
   id: String
   sellerId: String!
   parentAccount: String

masterdata/goodwill/schema.json

@@ -11,7 +11,9 @@
       "type": "string",
       "description": "Unique identifier for the seller."
     },
-    "status": { "$ref": "#/$defs/status" },
+    "status": {
+      "$ref": "#/$defs/status"
+    },
     "creditAmount": {
       "type": "number",
       "description": "Amount to be credited.",
@@ -40,11 +42,5 @@
       "default": "new"
     }
   },
-  "required": [
-    "orderId",
-    "creditAmount",
-    "reason",
-    "sellerId",
-    "refundPaymentData"
-  ]
+  "required": ["creditAmount", "reason", "sellerId", "refundPaymentData"]
 }

masterdata/goodwill/security.json

@@ -0,0 +1,3 @@
+{
+  "allowGetAll": true
+}

masterdata/orderRefundsSummary/schema.json

@@ -0,0 +1,47 @@
+{
+  "properties": {
+    "orderValue": {
+      "type": "integer"
+    },
+    "refundable": {
+      "type": "object",
+      "properties": {
+        "items": {
+          "type": "integer"
+        },
+        "shipping": {
+          "type": "integer"
+        }
+      },
+      "required": ["items", "shipping"]
+    },
+    "refunds": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "type": {
+            "type": "string",
+            "enum": ["goodwill", "prerefund", "refund", "invoice"]
+          },
+          "status": {
+            "type": "string",
+            "enum": ["pending", "accepted", "denied"]
+          },
+          "value": {
+            "type": "integer"
+          }
+        },
+        "required": ["id", "type", "status", "value"]
+      }
+    }
+  },
+  "required": ["orderValue", "refundable", "refunds"],
+  "v-cache": false,
+  "v-default-fields": ["id", "createdIn"],
+  "v-indexed": ["id"],
+  "v-immediate-indexing": true
+}

masterdata/orderRefundsSummary/security.json

@@ -0,0 +1,3 @@
+{
+  "allowGetAll": true
+}

node/clients/index.ts

@@ -2,24 +2,27 @@ import { IOClients, Sphinx } from '@vtex/api'
 import { vbaseFor, masterDataFor } from '@vtex/clients'
 
 import type { ReturnAppSettings } from '../../typings/ReturnAppSettings'
-import type { ReturnRequest } from '../../typings/ReturnRequest'
-import type { SellerSetting } from '../../typings/SellerSetting'
+import { SellerSetting } from '../../typings/SellerSetting'
 import { Catalog } from './catalog'
 import { OMSCustom as OMS } from './oms'
 import { GiftCard } from './giftCard'
 import { MailClient } from './mail'
 import Checkout from './checkout'
 import { VtexId } from './vtexId'
 import { CatalogGQL } from './catalogGQL'
+import ReturnRequestClient from './returnRequest'
+import OrderRefundsSummaryClient from './orderRefundsSummary'
 import { ProfileClient } from './profile'
 import { Marketplace } from './marketplace'
 import Scheduler from './scheduler'
 
+const SellerSetting = masterDataFor<SellerSetting>('sellerSetting')
+
 const ReturnAppSettingsClient = vbaseFor<string, ReturnAppSettings>(
   'appSettings'
 )
 
-const ReturnRequestClient = masterDataFor<ReturnRequest | any>('returnRequest')
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 const GoodwillClient = masterDataFor<Goodwill | any>('goodwill')
 const SellerSettingClient = masterDataFor<SellerSetting>('sellerSetting')
 const OrderRefundDetails =
@@ -42,8 +45,12 @@ export class Clients extends IOClients {
     return this.getOrSet('catalogGQL', CatalogGQL)
   }
 
-  public get returnRequest() {
-    return this.getOrSet('returnRequest', ReturnRequestClient)
+  public get returnRequestClient() {
+    return this.getOrSet('ReturnRequestClient', ReturnRequestClient)
+  }
+
+  public get orderRefundsSummaryClient() {
+    return this.getOrSet('OrderRefundsSummaryClient', OrderRefundsSummaryClient)
   }
 
   public get goodwill() {

node/clients/mail.ts

@@ -38,7 +38,7 @@ export class MailClient extends JanusClient {
     return this.http.post(TEMPLATE_RENDER_PATH, template, {
       headers: {
         ...this.options?.headers,
-        VtexIdClientAutCookie: this.context.adminUserAuthToken || '',
+        VtexIdClientAutCookie: this.context.adminUserAuthToken ?? '',
       },
       metric: 'mail-post-template',
     })

node/clients/oms.ts

@@ -65,8 +65,9 @@ export class OMSCustom extends OMS {
       invoice,
       {
         headers: {
-          VtexIdClientAutCookie: this.context.adminUserAuthToken ?? this.context.authToken ?? '',
-            'X-Vtex-Use-Https': 'true',
+          VtexIdClientAutCookie:
+            this.context.adminUserAuthToken ?? this.context.authToken ?? '',
+          'X-Vtex-Use-Https': 'true',
         },
         metric: 'oms-create-invoice',
       }

node/clients/orderRefundsSummary.ts

@@ -0,0 +1,9 @@
+import { masterDataFor } from '@vtex/clients'
+
+import type { OrderRefundsSummary } from '../../typings/OrderRefundsSummary'
+
+const OrderRefundsSummaryClient = masterDataFor<OrderRefundsSummary>(
+  'orderRefundsSummary'
+)
+
+export default OrderRefundsSummaryClient

node/clients/returnRequest.ts

@@ -0,0 +1,7 @@
+import { masterDataFor } from '@vtex/clients'
+
+import type { ReturnRequest } from '../../typings/ReturnRequest'
+
+const ReturnRequestClient = masterDataFor<ReturnRequest>('returnRequest')
+
+export default ReturnRequestClient

node/clients/vtexId.ts

@@ -59,7 +59,7 @@ export class VtexId extends JanusClient {
       const response = await this.http.get(`/api/vlm/account?an=${account}`, {
         metric: 'vtexid-get-account',
         headers: {
-          VtexIdClientAutCookie: token || '',
+          VtexIdClientAutCookie: token ?? '',
         },
       })
 

node/index.ts

@@ -33,11 +33,13 @@ const {
   sellerValidation,
   getOrdersList,
   createGiftcard,
+  getOrderRefundsSummary,
   createPrerefund,
   invoice,
 } = middlewares
 
 const TIMEOUT_MS = 5000
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 const catalogMemoryCache = new LRUCache<string, any>({ max: 5000 })
 
 const clients: ClientsConfig<Clients> = {
@@ -208,7 +210,10 @@ export default new Service<Clients, State, ParamsContext>({
       POST: [ping],
     }),
     invoice: method({
-      POST: [auth, invoice],
+      POST: [invoice],
+    }),
+    orderSummary: method({
+      POST: [getOrderRefundsSummary],
     }),
   },
   graphql: {

node/middlewares/errorHandler.ts

@@ -11,7 +11,7 @@ export async function errorHandler(ctx: Context, next: () => Promise<void>) {
       error,
     })
 
-    ctx.status = error.status || error.response?.status || 500
+    ctx.status = error.status ?? error.response?.status ?? 500
     ctx.body = { error: error.message }
     ctx.app.emit('error', error, ctx)
   }

node/middlewares/getOrderRefundsSummary.ts

@@ -0,0 +1,44 @@
+import returnOrderRefundsSumaryService from '../services/returnOrderRefundsSummaryService'
+
+async function getOrderRefundsSummary(ctx: Context) {
+  try {
+    const {
+      vtex: {
+        logger,
+        route: { params },
+      },
+      clients: {
+        returnRequestClient,
+        oms,
+        goodwill,
+        orderRefundsSummaryClient,
+      },
+    } = ctx
+
+    const orderId = params.orderId as string
+
+    const response = await returnOrderRefundsSumaryService({
+      clients: {
+        goodwillClient: goodwill,
+        logger,
+        omsClient: oms,
+        orderRefundsSummaryClient,
+        returnRequestClient,
+      },
+      orderId,
+    })
+
+    if (response === null) throw new Error('Internal error')
+
+    ctx.body = {
+      data: response,
+    }
+    ctx.status = 200
+  } catch (e) {
+    ctx.status = 500
+  }
+
+  ctx.set('Cache-Control', 'no-cache')
+}
+
+export default getOrderRefundsSummary

node/middlewares/index.ts

@@ -11,6 +11,7 @@ import { sellerValidation } from './sellerValidation'
 import { getOrdersList } from './getOrdersList'
 import { createGiftcard } from './giftcard'
 import { exportRequests } from './exportRequests'
+import getOrderRefundsSummary from './getOrderRefundsSummary'
 import { createPrerefund } from './createPrerefund'
 import { invoice } from './invoice'
 
@@ -30,6 +31,7 @@ export const middlewares = {
   getOrdersList,
   createGiftcard,
   exportRequests,
+  getOrderRefundsSummary,
   createPrerefund,
-  invoice
+  invoice,
 }

node/middlewares/invoice.ts

@@ -1,5 +1,6 @@
-import { json } from "co-body"
-import { createInvoice } from "../services/createInvoice"
+import { json } from 'co-body'
+
+import { createInvoice } from '../services/createInvoice'
 
 export async function invoice(ctx: Context): Promise<any> {
   const {
@@ -10,8 +11,8 @@ export async function invoice(ctx: Context): Promise<any> {
       },
     },
   } = ctx
+
   const body = await json(req)
 
   ctx.body = await createInvoice(ctx, orderId, body)
-
 }

node/middlewares/sellerSetting.ts

@@ -7,7 +7,7 @@ import {
 import { SETTINGS_PATH } from '../utils/constants'
 
 export async function saveSellerSetting(ctx: Context) {
-  const { body }: any = ctx || {}
+  const { body }: any = ctx ?? {}
 
   ctx.set('Cache-Control', 'no-cache')
 
@@ -25,8 +25,8 @@ export async function saveSellerSetting(ctx: Context) {
 
     ctx.status = 200
   } catch (error) {
-    ctx.body = error?.response?.data || error.response?.statusText || error
-    ctx.status = error.response?.status || 400
+    ctx.body = error?.response?.data ?? error.response?.statusText ?? error
+    ctx.status = error.response?.status ?? 400
   }
 }
 
@@ -73,7 +73,7 @@ export async function returnSellerSetting(ctx: Context) {
       throw new UserInputError('sellerId is required')
     }
   } catch (error) {
-    ctx.body = error?.response?.data || error.response?.statusText || error
-    ctx.status = error.response?.status || 400
+    ctx.body = error?.response?.data ?? error.response?.statusText ?? error
+    ctx.status = error.response?.status ?? 400
   }
 }

node/middlewares/sellerValidation.ts

@@ -22,11 +22,10 @@ export async function sellerValidation(
   let seller = ''
   const sellerNameSettintgs = settings?.sellerId
 
-  seller = sellerNameSettintgs || sellerName
+  seller = sellerNameSettintgs ?? sellerName
   const { sellerId } = params as { sellerId: string }
-  if (
-    (_sellerName || _sellerId || seller || sellerId || body.sellerId)
-  ) {
+
+  if (_sellerName || _sellerId || seller || sellerId || body.sellerId) {
     const accountName = String(
       _sellerName || _sellerId || seller || sellerId || body.sellerId
     )

node/middlewares/setSchema.ts

@@ -1,10 +1,10 @@
-import { SCHEMAS } from "../utils/constants"
+import { SCHEMAS } from '../utils/constants'
 
 export async function setSchemaVersion(
   ctx: Context,
   next: () => Promise<any>
 ): Promise<any> {
-  ctx.clients.returnRequest.schema = SCHEMAS.DEFAULT
+  ctx.clients.returnRequestClient.schema = SCHEMAS.DEFAULT
   ctx.clients.goodwill.schema = SCHEMAS.DEFAULT
   ctx.clients.sellerSetting.schema = SCHEMAS.DEFAULT
   ctx.clients.orderRefundDetails.schema = SCHEMAS.DEFAULT