Incorrect inferred typing when using operation and endpoint

[jakeleventhal]

When making calls the API using inferred types (endpoint + operation), I am getting the wrong type for my payload variable.

const payload = await this.sellingPartner.callAPI({
  endpoint: 'finances',
  operation: 'listFinancialEventGroups',
  query: {
    FinancialEventGroupStartedAfter: startDate.toISOString()
  }
});

It seems to think that i should be destructuring payload when the value is already destructured. Below is what i see when i log payload

[jakeleventhal]

@amz-tools

[jakeleventhal]

This is still an issue on 1.0.0 and is a blocker for wanting to have any sort of type inferencing

[jakeleventhal]

I can fix this myself. Can @amz-tools please provide some guidance for how to fix this?

[curiousElf]

@jakeleventhal How did you go about fixing this? Do we need to rewrite all the nested types ourselves?

[jakeleventhal]

@jakeleventhal How did you go about fixing this? Do we need to rewrite all the nested types ourselves?

import { GetOrderPath, GetOrderResponse } from 'amazon-sp-api/lib/typings/operations/orders';

  async getOrder(orderId: string): Promise<GetOrderResponse['payload']> {
    try {
      const order = await this.sellingPartner.callAPI({
        operation: 'orders.getOrder',
        path: { orderId } as GetOrderPath
      });

      return order;
    } catch (err) {
      const handledError = await this.handleAPIError(err);
      throw handledError;
    }
  }

annoying, but works

[jakeleventhal]

@amz-tools any guidance here? Will gladly take this on.

[GbalsaC]

This is still an issue, it'd be great if it could be corrected as others migrate to newest version and need to make use of type checking

[pradeep-gox]

+1

I assume this is the following piece of code in the SellingPartner.js lib file, which causes this problem. @amz-tools IMO, I think the developers could do the transformation/processing of the response. The raw json response from the sp-api should be returned for better consistency.

[pradeep-gox]

#290

[amz-tools]

@jakeleventhal @pradeep-gox Sorry this topic did not get the attention in the past as it should have. I see the issue. However changing it as proposed in #290 would result in a big breaking change for everyone.

I see basically three options:

1. Breaking change for everyone
2. Changing the Response typings to omit the payload and be able to use i.e. GetOrderResponse without the need to "fix it" like @jakeleventhal showed earlier. This would "only" break it for everyone using TS.
3. Introduce a new optional parameter that can be passed in the constructor config object that enables to return the raw json response as suggested by @pradeep-gox. The param would be false by default to prevent breaking changes when upgrading to the new version but enables everyone to handle it according to the current typings.

What do you think?

[jakeleventhal]

I prefer a major version upgrade with breaking changes to get a "correct" solution. If people do not pin packages, it is on them