feat: enhance type checking for tests (#171)

vijayasingam-paddle · web-flow · commit ca59e040ab8b · 2025-08-01T10:49:33.000+01:00
diff --git a/.github/workflows/build-test.yml b/.github/workflows/build-test.yml
@@ -68,4 +68,4 @@ jobs:
         run: pnpm build
 
       - name: Test
-        run: pnpm test
+        run: pnpm test && pnpm typecheck:tests
diff --git a/package.json b/package.json
@@ -15,6 +15,7 @@
     "build-esm": "tsc -b tsconfig.esm.json && echo '{\"type\":\"module\"}' > ./dist/esm/package.json",
     "build-cjs": "tsc -b tsconfig.cjs.json && echo '{\"type\":\"commonjs\"}' > ./dist/cjs/package.json",
     "build-types": "tsc -b tsconfig.types.json",
+    "typecheck:tests": "tsc -b tsconfig.tests.json",
     "prettier": "prettier --check ./src",
     "prettier:fix": "prettier --check ./src --write",
     "lint": "eslint ./src",
diff --git a/src/__tests__/internal/logger.test.ts b/src/__tests__/internal/logger.test.ts
@@ -1,4 +1,3 @@
-import { type Response } from 'node-fetch';
 import { LogLevel } from '../../internal/index.js';
 import { Logger } from '../../internal/base/logger.js';
 
diff --git a/src/__tests__/mocks/notifications/payment-method-saved.mock.ts b/src/__tests__/mocks/notifications/payment-method-saved.mock.ts
@@ -4,9 +4,10 @@
  *  Changes may be overwritten as part of auto-generation.
  */
 
-import { type IEventsResponse, type IPaymentMethodResponse } from '../../../types/index.js';
+import { type IEventsResponse } from '../../../types/index.js';
+import { IPaymentMethodNotificationResponse } from '../../../notifications/index.js';
 
-export const PaymentMethodSavedMock: IEventsResponse<IPaymentMethodResponse> = {
+export const PaymentMethodSavedMock: IEventsResponse<IPaymentMethodNotificationResponse> = {
   event_id: 'evt_01hwvkmsge7bhq1a31s35784zt',
   event_type: 'payment_method.saved',
   occurred_at: '2024-05-02T02:55:25.198953Z',
diff --git a/src/__tests__/mocks/notifications/subscription-activated.mock.ts b/src/__tests__/mocks/notifications/subscription-activated.mock.ts
@@ -14,7 +14,6 @@ export const SubscriptionActivatedMock: IEventsResponse<ISubscriptionNotificatio
   notification_id: 'ntf_01h7ht60qc1tcdk0hfms98bmhp',
   data: {
     id: 'sub_01h7ht5z5wdg9pz18jx1fagp8k',
-    transaction_id: 'txn_01h8bxpvx398a7zbawb77y0kp5',
     items: [
       {
         price: {
diff --git a/src/__tests__/mocks/notifications/subscription-canceled.mock.ts b/src/__tests__/mocks/notifications/subscription-canceled.mock.ts
@@ -14,7 +14,6 @@ export const SubscriptionCanceledMock: IEventsResponse<ISubscriptionNotification
   notification_id: 'ntf_01h7jk37xbxzq9f7fdery7eab5',
   data: {
     id: 'sub_01h7ht5z5wdg9pz18jx1fagp8k',
-    transaction_id: 'txn_01h8bxpvx398a7zbawb77y0kp5',
     items: [
       {
         price: {
diff --git a/src/__tests__/mocks/notifications/subscription-created.mock.ts b/src/__tests__/mocks/notifications/subscription-created.mock.ts
@@ -4,10 +4,10 @@
  *  Changes may be overwritten as part of auto-generation.
  */
 
-import { ISubscriptionNotificationResponse } from '../../../notifications/index.js';
+import type { ISubscriptionCreatedNotificationResponse } from '../../../notifications/index.js';
 import { IEventsResponse } from '../../../types/index.js';
 
-export const SubscriptionCreatedMock: IEventsResponse<ISubscriptionNotificationResponse> = {
+export const SubscriptionCreatedMock: IEventsResponse<ISubscriptionCreatedNotificationResponse> = {
   event_id: 'evt_01h7ht60jy5hpdv5x8tfsaxje4',
   event_type: 'subscription.created',
   occurred_at: '2023-08-11T08:07:38.334150Z',
diff --git a/src/__tests__/mocks/notifications/subscription-imported.mock.ts b/src/__tests__/mocks/notifications/subscription-imported.mock.ts
@@ -14,7 +14,6 @@ export const SubscriptionImportedMock: IEventsResponse<ISubscriptionNotification
   notification_id: 'ntf_01gxwxwnjq16bhp2pz9p78cbk1',
   data: {
     id: 'sub_01gxwxwn84xqf0690d7qn5r2g7',
-    transaction_id: 'txn_01h8bxpvx398a7zbawb77y0kp5',
     items: [
       {
         price: {
diff --git a/src/__tests__/mocks/notifications/subscription-past-due.mock.ts b/src/__tests__/mocks/notifications/subscription-past-due.mock.ts
@@ -14,7 +14,6 @@ export const SubscriptionPastDueMock: IEventsResponse<ISubscriptionNotificationR
   notification_id: 'ntf_01h7jagthb2kg1vqtf6rr8xspa',
   data: {
     id: 'sub_01h7ht5z5wdg9pz18jx1fagp8k',
-    transaction_id: 'txn_01h8bxpvx398a7zbawb77y0kp5',
     items: [
       {
         price: {
diff --git a/src/__tests__/mocks/notifications/subscription-paused.mock.ts b/src/__tests__/mocks/notifications/subscription-paused.mock.ts
@@ -14,7 +14,6 @@ export const SubscriptionPausedMock: IEventsResponse<ISubscriptionNotificationRe
   notification_id: 'ntf_01h7jcst74a4417kz8eedqty0e',
   data: {
     id: 'sub_01h7ht5z5wdg9pz18jx1fagp8k',
-    transaction_id: 'txn_01h8bxpvx398a7zbawb77y0kp5',
     items: [
       {
         price: {
diff --git a/src/__tests__/mocks/notifications/subscription-resumed.mock.ts b/src/__tests__/mocks/notifications/subscription-resumed.mock.ts
@@ -14,7 +14,6 @@ export const SubscriptionResumedMock: IEventsResponse<ISubscriptionNotificationR
   notification_id: 'ntf_01h7je74gef2bx0d5e9qkzyvrb',
   data: {
     id: 'sub_01h7ht5z5wdg9pz18jx1fagp8k',
-    transaction_id: 'txn_01h8bxpvx398a7zbawb77y0kp5',
     items: [
       {
         price: {
diff --git a/src/__tests__/mocks/notifications/subscription-trialing.mock.ts b/src/__tests__/mocks/notifications/subscription-trialing.mock.ts
@@ -14,7 +14,6 @@ export const SubscriptionTrialingMock: IEventsResponse<ISubscriptionNotification
   notification_id: 'ntf_01h84cka91b65gy90qhe2tw2q6',
   data: {
     id: 'sub_01h84ck8sg4ebkpzqb9x2mtjjf',
-    transaction_id: 'txn_01h8bxpvx398a7zbawb77y0kp5',
     items: [
       {
         price: {
diff --git a/src/__tests__/mocks/notifications/subscription-updated.mock.ts b/src/__tests__/mocks/notifications/subscription-updated.mock.ts
@@ -14,7 +14,6 @@ export const SubscriptionUpdatedMock: IEventsResponse<ISubscriptionNotificationR
   notification_id: 'ntf_01h7j296hkp15d34485ywewrgd',
   data: {
     id: 'sub_01h7ht5z5wdg9pz18jx1fagp8k',
-    transaction_id: 'txn_01h8bxpvx398a7zbawb77y0kp5',
     items: [
       {
         price: {
diff --git a/src/__tests__/mocks/resources/notification-settings.mock.ts b/src/__tests__/mocks/resources/notification-settings.mock.ts
@@ -62,6 +62,7 @@ export const NotificationSettingsMock: INotificationSettingsResponse = {
       name: 'address.updated',
     },
   ],
+  traffic_source: 'platform',
 };
 
 export const NotificationSettingsMockResponse: Response<INotificationSettingsResponse> = {
diff --git a/src/__tests__/mocks/resources/payment-methods.mock.ts b/src/__tests__/mocks/resources/payment-methods.mock.ts
@@ -21,6 +21,7 @@ export const PaymentMethodMock: IPaymentMethodResponse = {
     cardholder_name: 'Sam Miller',
   },
   paypal: null,
+  underlying_details: null,
   origin: 'saved_during_purchase',
   saved_at: '2024-05-03T11:50:23.422Z',
   updated_at: '2024-05-03T11:50:23.422Z',
diff --git a/src/__tests__/mocks/resources/pricing-preview.mock.ts b/src/__tests__/mocks/resources/pricing-preview.mock.ts
@@ -48,6 +48,9 @@ export const PricingPreviewMock: IPricingPreviewResponse = {
               created_at: '2024-10-12T07:20:50.52Z',
               updated_at: '2024-10-13T07:20:50.52Z',
               import_meta: { external_id: '9b95b0b8-e10f-441a-862e-1936a6d818ab', imported_from: 'billing_platform' },
+              discount_group_id: null,
+              discount_group: null,
+              mode: 'standard',
             },
             formatted_total: '$100',
             total: '10000',
diff --git a/src/__tests__/mocks/resources/transactions.mock.ts b/src/__tests__/mocks/resources/transactions.mock.ts
@@ -280,6 +280,7 @@ export const TransactionMock: ITransactionResponse = {
           last4: '',
           type: 'american_express',
         },
+        underlying_details: null,
       },
       created_at: '2024-10-12T07:20:50.52Z',
       captured_at: '2024-10-12T07:20:50.52Z',
diff --git a/src/__tests__/resources/customer-portal-sessions.test.ts b/src/__tests__/resources/customer-portal-sessions.test.ts
@@ -27,6 +27,6 @@ describe('CustomerPortalSessionsResource', () => {
     expect(createdCustomerPortalSession).toBeDefined();
     expect(createdCustomerPortalSession.id).toBeDefined();
     expect(createdCustomerPortalSession.customerId).toBe(customerId);
-    expect(createdCustomerPortalSession.urls.subscriptions[0].id).toBe(subscriptionIds[0]);
+    expect(createdCustomerPortalSession.urls.subscriptions[0]?.id).toBe(subscriptionIds[0]);
   });
 });
diff --git a/src/__tests__/resources/simulation-runs.test.ts b/src/__tests__/resources/simulation-runs.test.ts
@@ -43,13 +43,13 @@ describe('SimulationRunsResource', () => {
     const queryParams: ListSimulationRunQueryParameters = {
       after: '2',
       id: ['1234'],
-      include: ['price'],
+      include: ['events'],
     };
 
     const simulationRunCollection = simulationRunsResource.list(simulationId, queryParams);
     const simulationRuns = await simulationRunCollection.next();
 
-    expect(paddleInstance.get).toHaveBeenCalledWith(`/simulations/${simulationId}/runs?after=2&id=1234&include=price`);
+    expect(paddleInstance.get).toHaveBeenCalledWith(`/simulations/${simulationId}/runs?after=2&id=1234&include=events`);
     expect(simulationRuns.length).toBe(1);
   });
 
@@ -76,7 +76,7 @@ describe('SimulationRunsResource', () => {
     const simulationRunsResource = new SimulationRunsResource(paddleInstance);
 
     const queryParams: GetSimulationRunQueryParameters = {
-      include: ['price'],
+      include: ['events'],
     };
     const simulationRun = await simulationRunsResource.get(simulationId, simulationRunId, queryParams);
 
diff --git a/src/notifications/types/shared/payment-method-details.ts b/src/notifications/types/shared/payment-method-details.ts
@@ -11,5 +11,5 @@ import { IPaymentMethodUnderlyingDetailsNotification } from './payment-method-un
 export interface IPaymentMethodDetailsNotification {
   type: PaymentType;
   card: IPaymentCardNotificationResponse | null;
-  underlying_details: IPaymentMethodUnderlyingDetailsNotification;
+  underlying_details: IPaymentMethodUnderlyingDetailsNotification | null;
 }
diff --git a/src/types/shared/payment-method-details.ts b/src/types/shared/payment-method-details.ts
@@ -11,5 +11,5 @@ import { IPaymentMethodUnderlyingDetails } from './payment-method-underlying-det
 export interface IPaymentMethodDetails {
   type: PaymentType;
   card: IPaymentCardResponse | null;
-  underlying_details: IPaymentMethodUnderlyingDetails;
+  underlying_details: IPaymentMethodUnderlyingDetails | null;
 }
diff --git a/tsconfig.tests.json b/tsconfig.tests.json
@@ -0,0 +1,12 @@
+{
+  "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    "noEmit": true,
+    "module": "esnext"
+  },
+  "exclude": [
+    "./src/index.cjs.edge.ts",
+    "./src/index.esm.node.ts",
+    "./src/index.esm.edge.ts"
+  ]
+}

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-import { type Response } from 'node-fetch';`
`2`	`1`	`import { LogLevel } from '../../internal/index.js';`
`3`	`2`	`import { Logger } from '../../internal/base/logger.js';`
`4`	`3`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,6 @@ export const SubscriptionActivatedMock: IEventsResponse<ISubscriptionNotificatio`
`14`	`14`	`notification_id: 'ntf_01h7ht60qc1tcdk0hfms98bmhp',`
`15`	`15`	`data: {`
`16`	`16`	`id: 'sub_01h7ht5z5wdg9pz18jx1fagp8k',`
`17`		`- transaction_id: 'txn_01h8bxpvx398a7zbawb77y0kp5',`
`18`	`17`	`items: [`
`19`	`18`	`{`
`20`	`19`	`price: {`