[BUG] ICheckout types are not exported

[splacentino]

When working with Typescript, I'd like to use pre-built types from ICheckout (and other) namespace (AccountInfo, ...).
Because they have no export prefix, tsc compiler does not recognize and process them.

To Reproduce

1. Declare a function as this:

export function getPaymentMethods(): Promise<ICheckout.PaymentResponse> {
  return return checkout.paymentMethods({...})
}

Where you CANNOT import the specific interface as

import { PaymentResponse /*, ICheckout */ } from "@adyen/api-library"

nor

import { PaymentResponse /*, ICheckout */ } from "@adyen/api-library/dist/lib/src/typings/checkout";

2. Build your code using tsc --build (this code is part of a composite project).

Expected behavior
Successful build.

Actual behaviour

$ tsc --build
../composite-project/dist/src/adyen.d.ts:73:13 - error TS2503: Cannot find namespace 'ICheckout'.

73 }): Promise<ICheckout.PaymentMethodsResponse>;

Desktop (please complete the following information):

• OS: Mac | Linux
• Node Version: 12.14
• NPM Version: 6.13
• Adyen version: 3.1.3

[KadoBOT]

Hi @splacentino

You don't import type definition files. All types are already compiled and available within the library (see here), which means you don't need to import the types to use them if you are using the library.

I just tested your code, and this works:

import { Client, CheckoutAPI } from '@adyen/api-library'

const client = new Client({ apiKey: '1234', environment: 'TEST' })
const checkout = new CheckoutAPI(client)

function getPaymentMethods(): Promise<ICheckout.PaymentMethodsResponse> {
    return checkout.paymentMethods({ merchantAccount: 'testMerchantAccount' })
}

Also, in your case, the return type is inherited, based on the type definitions of the checkout.paymentMethods. Since you manually specified the return type, you are telling the compiler that the expected return type is PaymentResponse, when the correct one is PaymentMethodsResponse, which is wrong. So in this case, you don't need to specify the return type:

[KadoBOT]

Since this is not a bug, I'll close the issue. But feel free to leave any comments.

[splacentino]

Hi @KadoBOT

I made a typo in the example, indeed.

Self types import does not look good enough. Could you try with two separate projects a and b where b is composite ts project imported in project a.

Transpilation of project b when building project a (tsc --build) will throw an error regarding types.

[KadoBOT]

How the project is currently set up, it expects you to have the library installed. So it indeed it might fail for cases like yours. If you need to use the types on a different project, you would need the types to be independent, in other words, to be a package (i.e @types/@adyen/api-library).

If you feel like, you can open a feature request for that, but that would depend on more requests as is not a priority for us right now. Or, you can add the types to the @types repo yourself.

Lemme know if that helps.

[splacentino]

@KadoBOT Thank you for your advices.

Regarding your previous message I was able to apply workaround:

1. import "@adyen/api-library/dist/lib/src/typings"; in specific file
2. "declaration": true in composite tsconfig.json project

[KadoBOT]

@splacentino that's great! Thanks for the update.