Expose MandateDetailsCreditCard type

[jp1987]

When using TypeScript, I can't seem to import MandateDetailsCreditCard as a type through @mollie/api-client, but only like so:

import type { MandateDetailsCreditCard } from '@mollie/api-client/dist/types/src/data/customers/mandates/data';

[janpaepke]

@Pimm: We mostly export enums from the data, but I don't think it would hurt to expose those types as well. Hence the pr.

[Pimm]

@janpaepke I think it could hurt, as MandateDetailsCreditCard is intended to be an internal type. Exporting it would make it part of the public API, which means we'll have to maintain it.

@jp1987 Could you elaborate on how you are currently using MandateDetailsCreditCard?

[jp1987]

@jp1987 Could you elaborate on how you are currently using MandateDetailsCreditCard?

@Pimm in a custom mapper:

export const mapCreditCardMandates = (client: IClient, mandate: Mandate) => {
  const mandateDetailsCreditCard = mandate.details as MandateDetailsCreditCard;
  return {
    active: client.mollieActiveMandateId === mandate.id,
    cardHolder: mandateDetailsCreditCard.cardHolder,
    cardLabel: mandateDetailsCreditCard.cardLabel,
    cardNumber: mandateDetailsCreditCard.cardNumber,
    mandateId: mandate.id,
    status: mandate.status,
  };
};

MandataDetails is exported like this: export type MandateDetails = MandateDetailsCreditCard | MandateDetailsDirectDebit; so we need to force the type.

[Pimm]

Thanks for elaborating, Jesper. I think this warrants a conversation about the types we (don't) want to expose.

A discriminated union might actually help in this specific case:

if (mandate.method == 'creditcard') {
  mandate.details.cardHolder // ← guaranteed to exist inside this if-block.
}

[janpaepke]

Not only would this help, but it would make the code more reliable.
For completeness, here's how I would suggest to refactor your code:

export const mapCreditCardMandates = (client: IClient, mandate: Mandate) => {
  if (mandate.method !== 'creditcard') {
    throw new Error(`Unexpected mandate method ${mandate.method}.`);
  }
  return {
    active: client.mollieActiveMandateId === mandate.id,
    cardHolder: mandateDetailsCreditCard.cardHolder,
    cardLabel: mandateDetailsCreditCard.cardLabel,
    cardNumber: mandateDetailsCreditCard.cardNumber,
    mandateId: mandate.id,
    status: mandate.status,
  };
};

This does NOT work currently, as the sdk does not expose this as a discriminated union.

@Pimm do you want to have this conversation here or open up a separate issue for this?