Skip to content

feat: add extras support to user.identify #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
edubkendo merged 2 commits into from
Jul 14, 2026
Merged

feat: add extras support to user.identify #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
48cb62a
feat: add extras support to user.identify
edubkendo Jul 9, 2026
860c2e6
fix: minor change for updateOnly example value; fixed false updateOnl…
Yihao-G Jul 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
139 changes: 139 additions & 0 deletions src/tracker.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@ describe('TESTING Tracker', () => {

describe('WHEN user.identify is called', () => {
beforeEach(async () => {
jest.useFakeTimers();

await tracker.user.identify({
id: 'test-user-id',
email: 'test@example.com',
Expand All @@ -70,6 +72,10 @@ describe('TESTING Tracker', () => {
});
});

afterEach(() => {
jest.useRealTimers();
});

it('SHOULD send the request to the default trackingApiBaseUrl', async () => {
expect(fetch).toHavePostedTimes(
1,
Expand All @@ -89,6 +95,52 @@ describe('TESTING Tracker', () => {
first_name: 'test',
last_name: 'test',
},
extras: {
created_at: new Date().toISOString(),
},
},
},
);
});
});

describe('WHEN user.identify is called with extras', () => {
beforeEach(async () => {
jest.useFakeTimers();

await tracker.user.identify({
id: 'test-user-id',
email: 'test@example.com',
data: {
first_name: 'test',
},
extras: {
createdAt: '2024-01-01T00:00:00.000Z',
updateOnly: true,
},
});
});

afterEach(() => {
jest.useRealTimers();
});

it('SHOULD send extras as snake_case fields', async () => {
expect(fetch).toHavePostedTimes(
1,
'https://api.getvero.com/api/v2/users/track?tracking_api_key=test-api-key',
{
body: {
id: 'test-user-id',
email: 'test@example.com',
channels: [],
data: {
first_name: 'test',
},
extras: {
created_at: '2024-01-01T00:00:00.000Z',
update_only: true,
},
},
},
);
Expand Down Expand Up @@ -263,6 +315,8 @@ describe('TESTING Tracker', () => {

describe('WHEN user.identify is called', () => {
beforeEach(async () => {
jest.useFakeTimers();

await tracker.user.identify({
id: 'test-user-id',
email: 'test@example.com',
Expand All @@ -280,6 +334,10 @@ describe('TESTING Tracker', () => {
});
});

afterEach(() => {
jest.useRealTimers();
});

it('SHOULD send the request to the specified trackingApiBaseUrl', () => {
expect(fetch).toHavePostedTimes(
1,
Expand All @@ -299,6 +357,9 @@ describe('TESTING Tracker', () => {
first_name: 'test',
last_name: 'test',
},
extras: {
created_at: new Date().toISOString(),
},
},
},
);
Expand Down Expand Up @@ -765,6 +826,9 @@ describe('TESTING Tracker', () => {
userAgent:
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36',
},
extras: {
created_at: new Date().toISOString(),
},
},
},
);
Expand Down Expand Up @@ -815,6 +879,81 @@ describe('TESTING Tracker', () => {
});
});

describe('WHEN user.identify is called with extras', () => {
Comment thread
Yihao-G marked this conversation as resolved.
beforeEach(async () => {
jest.useFakeTimers();

await tracker.user.identify({
id: 'test-user-id',
email: 'test@example.com',
data: {
first_name: 'test',
},
extras: {
createdAt: '2024-01-01T00:00:00.000Z',
updateOnly: true,
},
});
});

afterEach(() => {
jest.useRealTimers();
});

it('SHOULD send extras on the identify request only', async () => {
expect(fetch).toHavePostedTimes(
1,
'https://api.getvero.com/api/v2/users/track?tracking_api_key=test-api-key',
{
body: {
id: 'test-user-id',
email: 'test@example.com',
channels: [],
data: {
first_name: 'test',
language: 'en',
timezone: 10,
ianaTimezone: 'Australia/Sydney',
userAgent:
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36',
},
extras: {
created_at: '2024-01-01T00:00:00.000Z',
update_only: true,
},
},
},
);
});

it('SHOULD still track a "visited site" event with event extras', async () => {
expect(fetch).toHavePostedTimes(
1,
'https://api.getvero.com/api/v2/events/track?tracking_api_key=test-api-key',
{
body: {
identity: {
id: 'test-user-id',
email: 'test@example.com',
},
event_name: 'Visited site',
data: {
language: 'en',
timezone: 10,
ianaTimezone: 'Australia/Sydney',
userAgent:
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36',
},
extras: {
source: 'hostname.example.com',
created_at: new Date().toISOString(),
},
},
},
);
});
});

describe('WHEN user.unidentify is called', () => {
beforeEach(async () => {
await tracker.user.unidentify();
Expand Down
20 changes: 20 additions & 0 deletions src/tracker.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,22 @@ export interface UserIdentifyRequest extends NoSiteVisitEventRequest {
* @example { first_name: "Damien", last_name: "Brzoska", age: 30 }
*/
data?: Record<string, string | number>;
/**
* An object containing key value pairs that represent the reserved,
* Vero-specific `created_at` and `update_only` properties.
*
* @see {@link Tracker#user.identify}
*/
extras?: {
/**
* @example "2023-05-30T04:46:31+0000"
*/
createdAt?: string;
/**
* @example true
*/
updateOnly?: boolean;
};
}

export interface OptionalUserIdRequest {
Expand Down Expand Up @@ -318,6 +334,10 @@ class Tracker {
email: request.email,
channels: request.channels ?? [],
data: { ...request.data, ...getDefaultReservedUserData() },
extras: {
created_at: request.extras?.createdAt ?? new Date().toISOString(),
update_only: request.extras?.updateOnly,
},
});
this.identityStore?.save(request.id, request.email);

Expand Down
Loading