feat: Change CustomData type definition (#188)

Author: davidgrayston-paddle

CHANGELOG.md

@@ -26,6 +26,12 @@ adding additional type guards.
 
 - Added support for new payment methods `blik`, `mb_way`, `pix` and `upi`. See [related changelog](https://developer.paddle.com/changelog/2025/blik-mbway-payment-methods).
 
+### Changed
+
+- `CustomData` type definition is now `Record<string, any>`
+
+---
+
 ## 3.2.1 - 2025-08-26
 
 ### Fixed

src/__tests__/entities/custom-data.test.ts

@@ -0,0 +1,20 @@
+import { CustomData } from '../../entities/index.js';
+
+interface IMyCustomData {
+  customer_reference_id: string;
+}
+
+describe('CustomData', () => {
+  test('without casting to a custom type', () => {
+    const customData: CustomData = { customer_reference_id: 'abcd1234' };
+
+    expect(customData['customer_reference_id']).toBe('abcd1234');
+  });
+
+  test('casts to a custom type', () => {
+    const customData: CustomData = { customer_reference_id: 'abcd1234' };
+    const myCustomData = customData as IMyCustomData;
+
+    expect(myCustomData?.customer_reference_id).toBe('abcd1234');
+  });
+});

src/entities/index.ts

@@ -28,4 +28,5 @@ export * from './simulation/index.js';
 export * from './simulation-run/index.js';
 export * from './simulation-run-event/index.js';
 
-export type CustomData = object;
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type CustomData = Record<string, any>;

src/types/shared/custom-data.ts

@@ -4,4 +4,5 @@
  *  Changes may be overwritten as part of auto-generation.
  */
 
-export type ICustomData = object;
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type ICustomData = Record<string, any>;