Merge pull request #16634 from mozilla/FXA-8891

feat(stripe-client): add stripe typings utility type and base types

libs/payments/legacy/src/lib/stripe-mapper.service.spec.ts

@@ -61,10 +61,9 @@ describe('StripeMapperService', () => {
       const validMetadata = StripeMetadataWithContentfulFactory({
         webIconURL: 'https://example.com/webIconURL',
       });
-      const stripePlan = PlanFactory({
-        product: ProductFactory({
-          metadata: validMetadata,
-        }),
+      const stripePlan = PlanFactory() as Stripe.Plan;
+      stripePlan.product = ProductFactory({
+        metadata: validMetadata,
       });
       const { mappedPlans, nonMatchingPlans } =
         await stripeMapper.mapContentfulToStripePlans(
@@ -89,10 +88,9 @@ describe('StripeMapperService', () => {
       const validMetadata = StripeMetadataWithContentfulFactory({
         webIconURL: 'https://example.com/webIconURL',
       });
-      const stripePlan = PlanFactory({
-        product: ProductFactory({
-          metadata: validMetadata,
-        }),
+      const stripePlan = PlanFactory() as Stripe.Plan;
+      stripePlan.product = ProductFactory({
+        metadata: validMetadata,
       });
       const { mappedPlans, nonMatchingPlans } =
         await stripeMapper.mapContentfulToStripePlans(
@@ -121,10 +119,10 @@ describe('StripeMapperService', () => {
         webIconURL: 'https://plan.override/emailIcon',
       });
       const stripePlan = PlanFactory({
-        product: ProductFactory({
-          metadata: validMetadata,
-        }),
         metadata: planOverrideMetadata,
+      }) as Stripe.Plan;
+      stripePlan.product = ProductFactory({
+        metadata: validMetadata,
       });
       const { mappedPlans, nonMatchingPlans } =
         await stripeMapper.mapContentfulToStripePlans(
@@ -147,10 +145,9 @@ describe('StripeMapperService', () => {
         productSet: 'set',
         productOrder: 'order',
       };
-      const stripePlan = PlanFactory({
-        product: ProductFactory({
-          metadata: productMetadata,
-        }),
+      const stripePlan = PlanFactory() as Stripe.Plan;
+      stripePlan.product = ProductFactory({
+        metadata: productMetadata,
       });
       const { mappedPlans, nonMatchingPlans } =
         await stripeMapper.mapContentfulToStripePlans(
@@ -190,18 +187,18 @@ describe('StripeMapperService', () => {
         metadata: productMetadata,
       });
       const stripePlan1 = PlanFactory({
-        product,
         metadata: StripeMetadataWithContentfulFactory({
           'product:details:1': 'Detail 1 in English',
         }),
-      });
+      }) as Stripe.Plan;
+      stripePlan1.product = product;
       const stripePlan2 = PlanFactory({
-        product,
         metadata: StripeMetadataWithContentfulFactory({
           'product:details:1': 'Detail 1 in French',
           'product:details:2': 'Detail 2 in French',
         }),
-      });
+      }) as Stripe.Plan;
+      stripePlan2.product = product;
 
       const { mappedPlans, nonMatchingPlans } =
         await stripeMapper.mapContentfulToStripePlans(
@@ -243,18 +240,18 @@ describe('StripeMapperService', () => {
         metadata: productMetadata,
       });
       const stripePlan1 = PlanFactory({
-        product,
         metadata: StripeMetadataWithContentfulFactory({
           'product:details:1': 'Detail 1 in German',
         }),
-      });
+      }) as Stripe.Plan;
+      stripePlan1.product = product;
       const stripePlan2 = PlanFactory({
-        product,
         metadata: StripeMetadataWithContentfulFactory({
           'product:details:1': 'Detail 1 in French',
           'product:details:2': 'Detail 2 in French',
         }),
-      });
+      }) as Stripe.Plan;
+      stripePlan2.product = product;
 
       const { mappedPlans, nonMatchingPlans } =
         await stripeMapper.mapContentfulToStripePlans(

libs/payments/paypal/src/lib/paypal.manager.spec.ts

@@ -208,14 +208,7 @@ describe('PaypalManager', () => {
         data: [mockPayPalSubscription],
       });
 
-      const mockCustomer = CustomerFactory({
-        subscriptions: {
-          object: 'list',
-          data: [mockPayPalSubscription],
-          has_more: true,
-          url: '/v1/customers/customer12345/subscriptions',
-        },
-      });
+      const mockCustomer = CustomerFactory();
 
       const expected = [mockPayPalSubscription];
 
@@ -224,7 +217,7 @@ describe('PaypalManager', () => {
         .mockResolvedValueOnce(mockSubscriptionList);
 
       const result = await paypalManager.getCustomerPayPalSubscriptions(
-        mockCustomer
+        mockCustomer.id
       );
       expect(result).toEqual(expected);
     });
@@ -287,7 +280,6 @@ describe('PaypalManager', () => {
       const mockInvoice = InvoiceFactory({
         amount_due: 50,
         currency: 'usd',
-        customer: mockCustomer,
       });
 
       stripeManager.fetchActiveCustomer = jest

libs/payments/paypal/src/lib/paypal.manager.ts

@@ -3,10 +3,11 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
 import { Injectable } from '@nestjs/common';
-import { Stripe } from 'stripe';
 
 import {
   ACTIVE_SUBSCRIPTION_STATUSES,
+  StripeCustomer,
+  StripeInvoice,
   StripeManager,
 } from '@fxa/payments/stripe';
 import { AccountDatabase } from '@fxa/shared/db/mysql/account';
@@ -62,7 +63,7 @@ export class PayPalManager {
    * Retrieves the customer’s current paypal billing agreement ID from the
    * auth database via the Paypal repository
    */
-  async getCustomerBillingAgreementId(customer: Stripe.Customer) {
+  async getCustomerBillingAgreementId(customer: StripeCustomer) {
     const paypalCustomer =
       await this.paypalCustomerManager.fetchPaypalCustomersByUid(
         customer.metadata.userid
@@ -80,10 +81,8 @@ export class PayPalManager {
   /**
    * Retrieves PayPal subscriptions
    */
-  async getCustomerPayPalSubscriptions(customer: Stripe.Customer) {
-    const subscriptions = await this.stripeManager.getSubscriptions(
-      customer.id
-    );
+  async getCustomerPayPalSubscriptions(customerId: string) {
+    const subscriptions = await this.stripeManager.getSubscriptions(customerId);
     return subscriptions.data.filter(
       (sub) =>
         ACTIVE_SUBSCRIPTION_STATUSES.includes(sub.status) &&
@@ -104,8 +103,8 @@ export class PayPalManager {
    * Process an invoice when amount is greater than minimum amount
    */
   async processNonZeroInvoice(
-    customer: Stripe.Customer,
-    invoice: Stripe.Invoice,
+    customer: StripeCustomer,
+    invoice: StripeInvoice,
     ipaddress?: string
   ) {
     // TODO in M3b: Implement legacy processInvoice as processNonZeroInvoice here
@@ -128,14 +127,15 @@ export class PayPalManager {
    * If amount is less than minimum amount, call processZeroInvoice
    * If amount is greater than minimum amount, call processNonZeroInvoice (legacy PaypalHelper processInvoice)
    */
-  async processInvoice(invoice: Stripe.Invoice) {
+  async processInvoice(invoice: StripeInvoice) {
+    if (!invoice.customer) throw new Error('Customer not present on invoice');
     const amountInCents = invoice.amount_due;
 
     if (amountInCents < this.stripeManager.getMinimumAmount(invoice.currency)) {
       return await this.processZeroInvoice(invoice.id);
     } else {
       const customer = await this.stripeManager.fetchActiveCustomer(
-        invoice.customer as string
+        invoice.customer
       );
       return await this.processNonZeroInvoice(customer, invoice);
     }

libs/payments/stripe/src/index.ts

@@ -14,3 +14,4 @@ export * from './lib/stripe.client';
 export * from './lib/stripe.constants';
 export * from './lib/stripe.error';
 export * from './lib/stripe.manager';
+export * from './lib/stripe.client.types';

libs/payments/stripe/src/lib/factories/card.factory.ts

@@ -3,9 +3,9 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
 import { faker } from '@faker-js/faker';
-import { Stripe } from 'stripe';
+import { StripeCard } from '../stripe.client.types';
 
-export const CardFactory = (override?: Partial<Stripe.Card>): Stripe.Card => ({
+export const CardFactory = (override?: Partial<StripeCard>): StripeCard => ({
   id: 'card',
   object: 'card',
   address_city: faker.location.city(),

libs/payments/stripe/src/lib/factories/customer.factory.ts

@@ -3,17 +3,21 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
 import { faker } from '@faker-js/faker';
-import { Stripe } from 'stripe';
-import { CardFactory } from './card.factory';
+import { StripeCustomer } from '../stripe.client.types';
 
 export const CustomerFactory = (
-  override?: Partial<Stripe.Customer>
-): Stripe.Customer => ({
+  override?: Partial<StripeCustomer>
+): StripeCustomer => ({
   id: `cus_${faker.string.alphanumeric({ length: 14 })}`,
   object: 'customer',
   balance: faker.number.int({ max: 1000 }),
   created: faker.number.int(),
-  default_source: CardFactory(),
+  tax: {
+    location: null,
+    automatic_tax: 'supported',
+    ip_address: faker.internet.ipv4(),
+  },
+  default_source: faker.string.uuid(),
   description: '',
   email: faker.internet.email(),
   invoice_settings: {

libs/payments/stripe/src/lib/factories/invoice-line-item.factory.ts

@@ -3,11 +3,11 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
 import { faker } from '@faker-js/faker';
-import { Stripe } from 'stripe';
+import { StripeInvoiceLineItem } from '../stripe.client.types';
 
 export const InvoiceLineItemFactory = (
-  override?: Partial<Stripe.InvoiceLineItem>
-): Stripe.InvoiceLineItem => ({
+  override?: Partial<StripeInvoiceLineItem>
+): StripeInvoiceLineItem => ({
   id: faker.string.alphanumeric(10),
   object: 'line_item',
   amount: faker.number.int({ max: 1000 }),

libs/payments/stripe/src/lib/factories/invoice.factory.ts

@@ -3,12 +3,12 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
 import { faker } from '@faker-js/faker';
-import { Stripe } from 'stripe';
 import { InvoiceLineItemFactory } from './invoice-line-item.factory';
+import { StripeInvoice } from '../stripe.client.types';
 
 export const InvoiceFactory = (
-  override?: Partial<Stripe.Invoice>
-): Stripe.Invoice => ({
+  override?: Partial<StripeInvoice>
+): StripeInvoice => ({
   id: `in_${faker.string.alphanumeric({ length: 24 })}`,
   object: 'invoice',
   account_country: null,

libs/payments/stripe/src/lib/factories/plan.factory.ts

@@ -3,9 +3,9 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
 import { faker } from '@faker-js/faker';
-import { Stripe } from 'stripe';
+import { StripePlan } from '../stripe.client.types';
 
-export const PlanFactory = (override?: Partial<Stripe.Plan>): Stripe.Plan => ({
+export const PlanFactory = (override?: Partial<StripePlan>): StripePlan => ({
   id: `plan_${faker.string.alphanumeric({ length: 24 })}`,
   object: 'plan',
   active: true,

libs/payments/stripe/src/lib/factories/price.factory.ts

@@ -3,11 +3,9 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
 import { faker } from '@faker-js/faker';
-import { Stripe } from 'stripe';
+import { StripePrice } from '../stripe.client.types';
 
-export const PriceFactory = (
-  override?: Partial<Stripe.Price>
-): Stripe.Price => ({
+export const PriceFactory = (override?: Partial<StripePrice>): StripePrice => ({
   id: `price_${faker.string.alphanumeric({ length: 24 })}`,
   object: 'price',
   active: true,

libs/payments/stripe/src/lib/factories/product.factory.ts

@@ -3,11 +3,11 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
 import { faker } from '@faker-js/faker';
-import { Stripe } from 'stripe';
+import { StripeProduct } from '../stripe.client.types';
 
 export const ProductFactory = (
-  override?: Partial<Stripe.Product>
-): Stripe.Product => ({
+  override?: Partial<StripeProduct>
+): StripeProduct => ({
   id: `prod_${faker.string.alphanumeric({ length: 14 })}`,
   object: 'product',
   active: true,

libs/payments/stripe/src/lib/factories/subscription.factory.ts

@@ -3,12 +3,16 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
 import { faker } from '@faker-js/faker';
-import { Stripe } from 'stripe';
 import { PriceFactory } from './price.factory';
+import {
+  StripeApiList,
+  StripeSubscription,
+  StripeSubscriptionItem,
+} from '../stripe.client.types';
 
 export const SubscriptionFactory = (
-  override?: Partial<Stripe.Subscription>
-): Stripe.Subscription => ({
+  override?: Partial<StripeSubscription>
+): StripeSubscription => ({
   id: `sub_${faker.string.alphanumeric({ length: 24 })}`,
   object: 'subscription',
   application: null,
@@ -64,8 +68,8 @@ export const SubscriptionFactory = (
 });
 
 export const SubscriptionItemFactory = (
-  override?: Partial<Stripe.SubscriptionItem>
-): Stripe.SubscriptionItem => ({
+  override?: Partial<StripeSubscriptionItem>
+): StripeSubscriptionItem => ({
   id: `si_${faker.string.alphanumeric({ length: 14 })}`,
   object: 'subscription_item',
   billing_thresholds: null,
@@ -102,8 +106,8 @@ export const SubscriptionItemFactory = (
 });
 
 export const SubscriptionListFactory = (
-  override?: Partial<Stripe.ApiList<Stripe.Subscription>>
-): Stripe.ApiList<Stripe.Subscription> => ({
+  override?: Partial<StripeApiList<StripeSubscription>>
+): StripeApiList<StripeSubscription> => ({
   object: 'list',
   url: '/v1/subscriptions',
   has_more: false,