Fix shallow copy mutation in normalize payload functions

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@envoy/envoy-integrations-sdk",
-  "version": "2.5.0",
+  "version": "2.5.1",
   "description": "SDK for building Envoy integrations.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

src/payloads/EntryPayload.ts

@@ -87,7 +87,7 @@ type EntryPayload = {
 
 export function normalizeEntryPayload(payload: EntryPayload): EntryPayload {
   const { 'signed-in-at': signedInAt, 'signed-out-at': signedOutAt, 'legal-docs': legalDocs } = payload.attributes;
-  const normalized = { ...payload };
+  const normalized = { ...payload, attributes: { ...payload.attributes } };
   normalized.attributes['signed-in-at'] = DateTime.fromSQL(signedInAt, { zone: 'UTC' }).toISO();
   if (signedOutAt) {
     normalized.attributes['signed-out-at'] = DateTime.fromSQL(signedOutAt, { zone: 'UTC' }).toISO();

src/payloads/InvitePayload.ts

@@ -73,7 +73,7 @@ type InvitePayload = {
 
 export function normalizeInvitePayload(payload: InvitePayload): InvitePayload {
   const { 'legal-docs': legalDocs } = payload.attributes;
-  const normalized = { ...payload };
+  const normalized = { ...payload, attributes: { ...payload.attributes } };
   if (Array.isArray(legalDocs) && legalDocs.length) {
     normalized.attributes['legal-docs'] = legalDocs.map((doc) => ({
       ...doc,

test/payloads/EntryPayload.test.ts

@@ -0,0 +1,64 @@
+import EntryPayload, { normalizeEntryPayload } from '../../src/payloads/EntryPayload';
+
+const makePayload = (attributeOverrides = {}): EntryPayload => ({
+  id: '1',
+  type: 'entries' as const,
+  attributes: {
+    'full-name': 'Jane Doe',
+    email: 'jane@example.com',
+    'employee-screening-flow': false,
+    host: null,
+    'host-email': null,
+    'private-notes': null,
+    'signed-in-at': '2024-01-15 10:30:00',
+    thumbnails: { large: null, original: null, small: null },
+    'flow-name': 'Default',
+    'user-data': [],
+    ...attributeOverrides,
+  },
+  relationships: {
+    location: { data: { id: 'loc1', type: 'locations' as const } },
+  },
+});
+
+describe('normalizeEntryPayload', () => {
+  it('converts signed-in-at from SQL to ISO', () => {
+    const result = normalizeEntryPayload(makePayload());
+
+    expect(result.attributes['signed-in-at']).toBe('2024-01-15T10:30:00.000Z');
+  });
+
+  it('converts signed-out-at from SQL to ISO when present', () => {
+    const result = normalizeEntryPayload(makePayload({ 'signed-out-at': '2024-01-15 11:00:00' }));
+
+    expect(result.attributes['signed-out-at']).toBe('2024-01-15T11:00:00.000Z');
+  });
+
+  it('converts legal-docs signed-at from SQL to ISO', () => {
+    const legalDocs = [
+      { id: 'doc1', url: 'https://example.com/doc1', 'signed-at': '2024-01-15 10:30:00', agreement: { id: 'a1' } },
+    ];
+
+    const result = normalizeEntryPayload(makePayload({ 'legal-docs': legalDocs }));
+
+    expect(result.attributes['legal-docs']?.[0]['signed-at']).toBe('2024-01-15T10:30:00.000Z');
+  });
+
+  it('does not mutate the original payload', () => {
+    const payload = makePayload();
+
+    normalizeEntryPayload(payload);
+
+    expect(payload.attributes['signed-in-at']).toBe('2024-01-15 10:30:00');
+  });
+
+  it('produces the same result when called twice on the same payload', () => {
+    const payload = makePayload();
+
+    const first = normalizeEntryPayload(payload);
+    const second = normalizeEntryPayload(payload);
+
+    expect(second.attributes['signed-in-at']).toBe(first.attributes['signed-in-at']);
+    expect(second.attributes['signed-in-at']).not.toBeNull();
+  });
+});

test/payloads/InvitePayload.test.ts

@@ -0,0 +1,76 @@
+import InvitePayload, { normalizeInvitePayload } from '../../src/payloads/InvitePayload';
+
+const makePayload = (attributeOverrides = {}): InvitePayload => ({
+  id: '1',
+  type: 'invites' as const,
+  attributes: {
+    'employee-screening-flow': false,
+    'full-name': 'Jane Doe',
+    email: 'jane@example.com',
+    'inviter-name': null,
+    'inviter-email': null,
+    'expected-arrival-time': '2024-01-15T10:30:00.000Z',
+    'private-notes': null,
+    arrived: false,
+    'been-here-before': false,
+    'flow-name': 'Default',
+    'flow-id': 'flow1',
+    'user-data': [],
+    'secret-token': 'secret',
+    'edit-token': 'edit',
+    'photo-url': null,
+    'qr-code': null,
+    'qr-code-sent-at': null,
+    'preregistration-complete': false,
+    'reminder-sent-at': null,
+    ...attributeOverrides,
+  },
+  relationships: {
+    location: { data: { id: 'loc1', type: 'locations' as const } },
+  },
+});
+
+describe('normalizeInvitePayload', () => {
+  it('returns the payload unchanged when there are no legal-docs', () => {
+    const payload = makePayload();
+
+    const result = normalizeInvitePayload(payload);
+
+    expect(result.attributes).toEqual(payload.attributes);
+  });
+
+  it('converts legal-docs signed-at from SQL to ISO', () => {
+    const legalDocs = [
+      { id: 'doc1', url: 'https://example.com/doc1', 'signed-at': '2024-01-15 10:30:00', agreement: { id: 'a1' } },
+    ];
+
+    const result = normalizeInvitePayload(makePayload({ 'legal-docs': legalDocs }));
+
+    expect(result.attributes['legal-docs']?.[0]['signed-at']).toBe('2024-01-15T10:30:00.000Z');
+  });
+
+  it('does not mutate the original payload', () => {
+    const legalDocs = [
+      { id: 'doc1', url: 'https://example.com/doc1', 'signed-at': '2024-01-15 10:30:00', agreement: { id: 'a1' } },
+    ];
+    const payload = makePayload({ 'legal-docs': legalDocs });
+
+    normalizeInvitePayload(payload);
+
+    expect(payload.attributes['legal-docs']).toBe(legalDocs);
+    expect(payload.attributes['legal-docs']?.[0]['signed-at']).toBe('2024-01-15 10:30:00');
+  });
+
+  it('produces the same result when called twice on the same payload', () => {
+    const legalDocs = [
+      { id: 'doc1', url: 'https://example.com/doc1', 'signed-at': '2024-01-15 10:30:00', agreement: { id: 'a1' } },
+    ];
+    const payload = makePayload({ 'legal-docs': legalDocs });
+
+    const first = normalizeInvitePayload(payload);
+    const second = normalizeInvitePayload(payload);
+
+    expect(second.attributes['legal-docs']?.[0]['signed-at']).toBe(first.attributes['legal-docs']?.[0]['signed-at']);
+    expect(second.attributes['legal-docs']?.[0]['signed-at']).not.toBeNull();
+  });
+});