@forge/teamwork-graph 3.1.0-next.3-experimental-4bd2ca0 → 3.1.0-next.3-experimental-ec29181

package/out/__test__/entity-operations.test.js

@@ -8,6 +8,7 @@ jest.mock('@forge/api');
 describe('TeamWorkGraphClient - setObjects', () => {
     let graphClient;
     let mockFetch;
+    const TEST_CONNECTION_ID = 'test-connection-123';
     beforeEach(() => {
         graphClient = new graph_1.TeamWorkGraphClient();
         mockFetch = jest.fn();
@@ -16,7 +17,8 @@ describe('TeamWorkGraphClient - setObjects', () => {
     });
     it('throws if objects array is empty', async () => {
         await expect(graphClient.setObjects({
-            objects: []
+            objects: [],
+            connectionId: TEST_CONNECTION_ID
         })).rejects.toThrow('objects array cannot be empty');
     });
     it('throws if more than 100 objects', async () => {
@@ -54,7 +56,8 @@ describe('TeamWorkGraphClient - setObjects', () => {
         };
         const manyObjects = Array(validators_1.MAX_BULK_OBJECTS + 1).fill(documentObject);
         await expect(graphClient.setObjects({
-            objects: manyObjects
+            objects: manyObjects,
+            connectionId: TEST_CONNECTION_ID
         })).rejects.toThrow(`Bulk ingestion supports maximum ${validators_1.MAX_BULK_OBJECTS} objects. Received ${validators_1.MAX_BULK_OBJECTS + 1}`);
     });
     it('posts to /api/v1/entities/bulk and returns response', async () => {
@@ -90,7 +93,7 @@ describe('TeamWorkGraphClient - setObjects', () => {
                 }
             }
         };
-        const req = { objects: [documentObject] };
+        const req = { objects: [documentObject], connectionId: TEST_CONNECTION_ID };
         const backendResponse = {
             accepted: [
                 {
@@ -153,7 +156,7 @@ describe('TeamWorkGraphClient - setObjects', () => {
                 lastActive: '2024-07-09T15:27:37.000Z'
             }
         };
-        const req = { objects: [messageObject] };
+        const req = { objects: [messageObject], connectionId: TEST_CONNECTION_ID };
         const backendResponse = {
             accepted: [
                 {
@@ -176,7 +179,7 @@ describe('TeamWorkGraphClient - setObjects', () => {
         expect(result).toEqual(expected);
     });
     it('throws if objects is not an array', async () => {
-        const req = { objects: null };
+        const req = { objects: null, connectionId: TEST_CONNECTION_ID };
         await expect(graphClient.setObjects(req)).rejects.toThrow('objects must be an array');
     });
     it('should pass Atl-Connection-Id header when connectionId is provided', async () => {
@@ -236,70 +239,11 @@ describe('TeamWorkGraphClient - setObjects', () => {
             })
         }));
     });
-    it('should not pass Atl-Connection-Id header when connectionId is not provided', async () => {
-        const documentObject = {
-            schemaVersion: '1.0',
-            id: 'my-document',
-            updateSequenceNumber: 123,
-            displayName: 'My Document',
-            url: 'https://document.com',
-            createdAt: '2024-04-16T09:01:32+00:00',
-            lastUpdatedAt: '2024-04-16T09:01:32+00:00',
-            permissions: [
-                {
-                    accessControls: [
-                        {
-                            principals: [
-                                {
-                                    type: 'EVERYONE'
-                                }
-                            ]
-                        }
-                    ]
-                }
-            ],
-            'atlassian:document': {
-                type: {
-                    category: 'DOCUMENT',
-                    iconUrl: 'http://icon.com'
-                },
-                content: {
-                    mimeType: 'text/plain',
-                    text: 'Really large content here...'
-                }
-            }
-        };
-        const req = { objects: [documentObject] };
-        const backendResponse = {
-            accepted: [
-                {
-                    entityType: 'atlassian:document',
-                    entityId: { id: 'my-document' },
-                    thirdPartyAri: 'ari:third-party:test::document/my-document'
-                }
-            ]
-        };
-        mockFetch.mockResolvedValueOnce({
-            ok: true,
-            json: () => Promise.resolve(backendResponse)
-        });
-        await graphClient.setObjects(req);
-        expect(mockFetch).toHaveBeenCalledWith((0, endpoints_1.getFullPath)(endpoints_1.ENDPOINTS.OBJECTS.BULK), expect.objectContaining({
-            method: 'POST',
-            headers: expect.objectContaining({
-                'Content-Type': 'application/json'
-            })
-        }));
-        expect(mockFetch).toHaveBeenCalledWith((0, endpoints_1.getFullPath)(endpoints_1.ENDPOINTS.OBJECTS.BULK), expect.not.objectContaining({
-            headers: expect.objectContaining({
-                'Atl-Connection-Id': expect.anything()
-            })
-        }));
-    });
 });
 describe('TeamWorkGraphClient - getObjectByExternalId', () => {
     let graphClient;
     let mockFetch;
+    const TEST_CONNECTION_ID = 'test-connection-123';
     beforeEach(() => {
         graphClient = new graph_1.TeamWorkGraphClient();
         mockFetch = jest.fn();
@@ -329,12 +273,16 @@ describe('TeamWorkGraphClient - getObjectByExternalId', () => {
         });
         const result = await graphClient.getObjectByExternalId({
             objectType: 'atlassian:document',
-            externalId: 'pipelines/123/builds/456'
+            externalId: 'pipelines/123/builds/456',
+            connectionId: TEST_CONNECTION_ID
         });
         expect(mockFetch).toHaveBeenCalledWith((0, endpoints_1.getFullPath)(endpoints_1.ENDPOINTS.OBJECTS.GET_BY_EXTERNAL_ID), {
             method: 'POST',
             redirect: 'follow',
-            headers: { 'Content-Type': 'application/json' },
+            headers: {
+                'Content-Type': 'application/json',
+                'Atl-Connection-Id': TEST_CONNECTION_ID
+            },
             body: JSON.stringify({
                 entityType: 'atlassian:document',
                 entityIds: ['pipelines/123/builds/456']
@@ -361,7 +309,8 @@ describe('TeamWorkGraphClient - getObjectByExternalId', () => {
         mockFetch.mockResolvedValueOnce(errorResponse);
         const result = await graphClient.getObjectByExternalId({
             objectType: 'atlassian:document',
-            externalId: 'nonexistent-entity'
+            externalId: 'nonexistent-entity',
+            connectionId: TEST_CONNECTION_ID
         });
         expect(result).toEqual({
             success: false,
@@ -372,13 +321,15 @@ describe('TeamWorkGraphClient - getObjectByExternalId', () => {
     it('should throw error when objectType is missing', async () => {
         await expect(graphClient.getObjectByExternalId({
             objectType: '',
-            externalId: 'pipelines/123/builds/456'
+            externalId: 'pipelines/123/builds/456',
+            connectionId: TEST_CONNECTION_ID
         })).rejects.toThrow('objectType is required');
     });
     it('should throw error when externalId is missing', async () => {
         await expect(graphClient.getObjectByExternalId({
             objectType: 'atlassian:document',
-            externalId: ''
+            externalId: '',
+            connectionId: TEST_CONNECTION_ID
         })).rejects.toThrow('externalId is required');
     });
     it('should pass Atl-Connection-Id header when connectionId is provided', async () => {
@@ -416,47 +367,11 @@ describe('TeamWorkGraphClient - getObjectByExternalId', () => {
             })
         }));
     });
-    it('should not pass Atl-Connection-Id header when connectionId is not provided', async () => {
-        const expectedObject = {
-            id: 'ari:cloud:teamwork-graph:object/123',
-            externalId: 'pipelines/123/builds/456',
-            objectType: 'atlassian:document',
-            displayName: 'Build Documentation',
-            description: 'Documentation for build process',
-            url: 'https://example.com/builds/456',
-            createdAt: '2024-01-01T00:00:00Z',
-            lastUpdatedAt: '2024-01-01T00:00:00Z',
-            meta: {
-                resourceType: 'Document',
-                created: '2024-01-01T00:00:00Z',
-                lastModified: '2024-01-01T00:00:00Z',
-                location: 'https://example.com/v2/entities/123'
-            }
-        };
-        mockFetch.mockResolvedValueOnce({
-            ok: true,
-            json: () => Promise.resolve({ entities: [expectedObject] })
-        });
-        await graphClient.getObjectByExternalId({
-            objectType: 'atlassian:document',
-            externalId: 'pipelines/123/builds/456'
-        });
-        expect(mockFetch).toHaveBeenCalledWith((0, endpoints_1.getFullPath)(endpoints_1.ENDPOINTS.OBJECTS.GET_BY_EXTERNAL_ID), expect.objectContaining({
-            method: 'POST',
-            headers: expect.objectContaining({
-                'Content-Type': 'application/json'
-            })
-        }));
-        expect(mockFetch).toHaveBeenCalledWith((0, endpoints_1.getFullPath)(endpoints_1.ENDPOINTS.OBJECTS.GET_BY_EXTERNAL_ID), expect.not.objectContaining({
-            headers: expect.objectContaining({
-                'Atl-Connection-Id': expect.anything()
-            })
-        }));
-    });
 });
 describe('TeamWorkGraphClient - deleteObjectsByExternalId', () => {
     let graphClient;
     let mockFetch;
+    const TEST_CONNECTION_ID = 'test-connection-123';
     beforeEach(() => {
         graphClient = new graph_1.TeamWorkGraphClient();
         mockFetch = jest.fn();
@@ -479,7 +394,8 @@ describe('TeamWorkGraphClient - deleteObjectsByExternalId', () => {
         });
         const result = await graphClient.deleteObjectsByExternalId({
             objectType: 'atlassian:document',
-            externalIds: ['pipelines/123/builds/456', 'pipelines/123/builds/789']
+            externalIds: ['pipelines/123/builds/456', 'pipelines/123/builds/789'],
+            connectionId: TEST_CONNECTION_ID
         });
         expect(mockFetch).toHaveBeenCalledWith((0, endpoints_1.getFullPath)(endpoints_1.ENDPOINTS.OBJECTS.BULK_DELETE), {
             method: 'DELETE',
@@ -488,39 +404,47 @@ describe('TeamWorkGraphClient - deleteObjectsByExternalId', () => {
                 entityIds: ['pipelines/123/builds/456', 'pipelines/123/builds/789']
             }),
             redirect: 'follow',
-            headers: { 'Content-Type': 'application/json' }
+            headers: {
+                'Content-Type': 'application/json',
+                'Atl-Connection-Id': TEST_CONNECTION_ID
+            }
         });
         expect(result).toEqual(expectedResponse);
     });
     it('should throw error when objectType is missing', async () => {
         await expect(graphClient.deleteObjectsByExternalId({
             objectType: '',
-            externalIds: ['pipelines/123/builds/456']
+            externalIds: ['pipelines/123/builds/456'],
+            connectionId: TEST_CONNECTION_ID
         })).rejects.toThrow('objectType is required');
     });
     it('should throw error when externalIds array is empty', async () => {
         await expect(graphClient.deleteObjectsByExternalId({
             objectType: 'atlassian:document',
-            externalIds: []
+            externalIds: [],
+            connectionId: TEST_CONNECTION_ID
         })).rejects.toThrow('externalIds array cannot be empty');
     });
     it('should throw error when externalIds array exceeds limit', async () => {
         const manyExternalIds = Array(validators_1.MAX_BULK_OBJECTS_DELETE + 1).fill('pipelines/123/builds/456');
         await expect(graphClient.deleteObjectsByExternalId({
             objectType: 'atlassian:document',
-            externalIds: manyExternalIds
+            externalIds: manyExternalIds,
+            connectionId: TEST_CONNECTION_ID
         })).rejects.toThrow(`Bulk object deletion supports maximum ${validators_1.MAX_BULK_OBJECTS_DELETE} objects`);
     });
     it('should throw error when externalIds is not an array', async () => {
         await expect(graphClient.deleteObjectsByExternalId({
             objectType: 'atlassian:document',
-            externalIds: null
+            externalIds: null,
+            connectionId: TEST_CONNECTION_ID
         })).rejects.toThrow('externalIds must be an array');
     });
 });
 describe('TeamWorkGraphClient - deleteObjectsByProperties', () => {
     let graphClient;
     let mockFetch;
+    const TEST_CONNECTION_ID = 'test-connection-123';
     beforeEach(() => {
         graphClient = new graph_1.TeamWorkGraphClient();
         mockFetch = jest.fn();
@@ -539,7 +463,8 @@ describe('TeamWorkGraphClient - deleteObjectsByProperties', () => {
             properties: {
                 environment: 'staging'
             },
-            objectType: 'atlassian:document'
+            objectType: 'atlassian:document',
+            connectionId: TEST_CONNECTION_ID
         });
         expect(mockFetch).toHaveBeenCalledWith((0, endpoints_1.getFullPath)(endpoints_1.ENDPOINTS.OBJECTS.DELETE_BY_PROPERTIES), {
             method: 'DELETE',
@@ -550,7 +475,10 @@ describe('TeamWorkGraphClient - deleteObjectsByProperties', () => {
                 entityType: 'atlassian:document'
             }),
             redirect: 'follow',
-            headers: { 'Content-Type': 'application/json' }
+            headers: {
+                'Content-Type': 'application/json',
+                'Atl-Connection-Id': TEST_CONNECTION_ID
+            }
         });
         expect(result).toEqual(expectedResponse);
     });
@@ -560,17 +488,30 @@ describe('TeamWorkGraphClient - deleteObjectsByProperties', () => {
                 environment: 'production',
                 status: 'completed'
             },
-            objectType: 'atlassian:document'
+            objectType: 'atlassian:document',
+            connectionId: TEST_CONNECTION_ID
         })).rejects.toThrow('properties object must contain exactly 1 property');
     });
     it('should throw error when properties is missing', async () => {
-        await expect(graphClient.deleteObjectsByProperties({ properties: {}, objectType: 'atlassian:document' })).rejects.toThrow('properties object cannot be empty');
+        await expect(graphClient.deleteObjectsByProperties({
+            properties: {},
+            objectType: 'atlassian:document',
+            connectionId: TEST_CONNECTION_ID
+        })).rejects.toThrow('properties object cannot be empty');
     });
     it('should throw error when properties is not an object', async () => {
-        await expect(graphClient.deleteObjectsByProperties({ properties: 'not-an-object', objectType: 'atlassian:document' })).rejects.toThrow('properties must be an object');
+        await expect(graphClient.deleteObjectsByProperties({
+            properties: 'not-an-object',
+            objectType: 'atlassian:document',
+            connectionId: TEST_CONNECTION_ID
+        })).rejects.toThrow('properties must be an object');
     });
     it('should throw error when properties object is empty', async () => {
-        await expect(graphClient.deleteObjectsByProperties({ properties: {}, objectType: 'atlassian:document' })).rejects.toThrow('properties object cannot be empty');
+        await expect(graphClient.deleteObjectsByProperties({
+            properties: {},
+            objectType: 'atlassian:document',
+            connectionId: TEST_CONNECTION_ID
+        })).rejects.toThrow('properties object cannot be empty');
     });
     it('should throw error when multiple properties are provided', async () => {
         await expect(graphClient.deleteObjectsByProperties({
@@ -579,13 +520,15 @@ describe('TeamWorkGraphClient - deleteObjectsByProperties', () => {
                 status: 'completed',
                 priority: 'high'
             },
-            objectType: 'atlassian:document'
+            objectType: 'atlassian:document',
+            connectionId: TEST_CONNECTION_ID
         })).rejects.toThrow('properties object must contain exactly 1 property');
     });
 });
 describe('TeamWorkGraphClient - bulk entities', () => {
     let graphClient;
     let mockFetch;
+    const TEST_CONNECTION_ID = 'test-connection-123';
     beforeEach(() => {
         graphClient = new graph_1.TeamWorkGraphClient();
         mockFetch = jest.fn();
@@ -622,7 +565,7 @@ describe('TeamWorkGraphClient - bulk entities', () => {
             ],
             'atlassian:branch': {}
         };
-        const req = { objects: [branchObject] };
+        const req = { objects: [branchObject], connectionId: TEST_CONNECTION_ID };
         const backendResponse = {
             accepted: [
                 {
@@ -686,7 +629,7 @@ describe('TeamWorkGraphClient - bulk entities', () => {
                 ]
             }
         };
-        const req = { objects: [commitObject] };
+        const req = { objects: [commitObject], connectionId: TEST_CONNECTION_ID };
         const backendResponse = {
             accepted: [
                 {
@@ -756,7 +699,7 @@ describe('TeamWorkGraphClient - bulk entities', () => {
                 ]
             }
         };
-        const req = { objects: [buildObject] };
+        const req = { objects: [buildObject], connectionId: TEST_CONNECTION_ID };
         const backendResponse = {
             accepted: [
                 {
@@ -849,7 +792,7 @@ describe('TeamWorkGraphClient - bulk entities', () => {
                 ]
             }
         };
-        const req = { objects: [featureFlagObject] };
+        const req = { objects: [featureFlagObject], connectionId: TEST_CONNECTION_ID };
         const backendResponse = {
             accepted: [
                 {
@@ -942,7 +885,7 @@ describe('TeamWorkGraphClient - bulk entities', () => {
                 ]
             }
         };
-        const req = { objects: [calendarEventObject] };
+        const req = { objects: [calendarEventObject], connectionId: TEST_CONNECTION_ID };
         const backendResponse = {
             accepted: [
                 {
@@ -1000,7 +943,7 @@ describe('TeamWorkGraphClient - bulk entities', () => {
                 ]
             }
         };
-        const req = { objects: [commentObject] };
+        const req = { objects: [commentObject], connectionId: TEST_CONNECTION_ID };
         const backendResponse = {
             accepted: [
                 {
@@ -1072,7 +1015,7 @@ describe('TeamWorkGraphClient - bulk entities', () => {
                 memberCount: 3
             }
         };
-        const req = { objects: [conversationObject] };
+        const req = { objects: [conversationObject], connectionId: TEST_CONNECTION_ID };
         const backendResponse = {
             accepted: [
                 {
@@ -1151,7 +1094,7 @@ describe('TeamWorkGraphClient - bulk entities', () => {
                 accountType: 'Enterprise'
             }
         };
-        const req = { objects: [customerOrgObject] };
+        const req = { objects: [customerOrgObject], connectionId: TEST_CONNECTION_ID };
         const backendResponse = {
             accepted: [
                 {
@@ -1229,7 +1172,7 @@ describe('TeamWorkGraphClient - bulk entities', () => {
                 isClosed: false
             }
         };
-        const req = { objects: [dealObject] };
+        const req = { objects: [dealObject], connectionId: TEST_CONNECTION_ID };
         const backendResponse = {
             accepted: [
                 { entityType: 'atlassian:deal', entityId: { id: 'deal-1' }, thirdPartyAri: 'ari:third-party:test::deal/deal-1' }
@@ -1304,7 +1247,7 @@ describe('TeamWorkGraphClient - bulk entities', () => {
                 region: 'us-east-1'
             }
         };
-        const req = { objects: [deploymentObject] };
+        const req = { objects: [deploymentObject], connectionId: TEST_CONNECTION_ID };
         const backendResponse = {
             accepted: [
                 {
@@ -1357,7 +1300,7 @@ describe('TeamWorkGraphClient - bulk entities', () => {
                 iconUrl: 'https://figma.com/icons/mobile-login-screen.svg'
             }
         };
-        const req = { objects: [designObject] };
+        const req = { objects: [designObject], connectionId: TEST_CONNECTION_ID };
         const backendResponse = {
             accepted: [
                 {
@@ -1439,7 +1382,7 @@ describe('TeamWorkGraphClient - bulk entities', () => {
                 watchersCount: 8
             }
         };
-        const req = { objects: [projectObject] };
+        const req = { objects: [projectObject], connectionId: TEST_CONNECTION_ID };
         const backendResponse = {
             accepted: [
                 {
@@ -1519,7 +1462,7 @@ describe('TeamWorkGraphClient - bulk entities', () => {
                 taskCount: 3
             }
         };
-        const req = { objects: [pullRequestObject] };
+        const req = { objects: [pullRequestObject], connectionId: TEST_CONNECTION_ID };
         const backendResponse = {
             accepted: [
                 {
@@ -1589,7 +1532,7 @@ describe('TeamWorkGraphClient - bulk entities', () => {
                 fullNounThirdPartyAri: 'ari:cloud:jira:company-site:issue/AUTH-123'
             }
         };
-        const req = { objects: [remoteLinkObject] };
+        const req = { objects: [remoteLinkObject], connectionId: TEST_CONNECTION_ID };
         const backendResponse = {
             accepted: [
                 {
@@ -1640,7 +1583,7 @@ describe('TeamWorkGraphClient - bulk entities', () => {
                 avatarDescription: 'Company logo representing the ecommerce backend repository'
             }
         };
-        const req = { objects: [repositoryObject] };
+        const req = { objects: [repositoryObject], connectionId: TEST_CONNECTION_ID };
         const backendResponse = {
             accepted: [
                 {
@@ -1700,7 +1643,7 @@ describe('TeamWorkGraphClient - bulk entities', () => {
                 serviceType: 'REST API'
             }
         };
-        const req = { objects: [softwareServiceObject] };
+        const req = { objects: [softwareServiceObject], connectionId: TEST_CONNECTION_ID };
         const backendResponse = {
             accepted: [
                 {
@@ -1757,7 +1700,7 @@ describe('TeamWorkGraphClient - bulk entities', () => {
                 labels: ['engineering', 'documentation', 'team-resources', 'best-practices', 'onboarding']
             }
         };
-        const req = { objects: [spaceObject] };
+        const req = { objects: [spaceObject], connectionId: TEST_CONNECTION_ID };
         const backendResponse = {
             accepted: [
                 {
@@ -1878,7 +1821,7 @@ describe('TeamWorkGraphClient - bulk entities', () => {
                 ]
             }
         };
-        const req = { objects: [videoObject] };
+        const req = { objects: [videoObject], connectionId: TEST_CONNECTION_ID };
         const backendResponse = {
             accepted: [
                 {
@@ -1973,7 +1916,7 @@ describe('TeamWorkGraphClient - bulk entities', () => {
                 team: 'Backend Infrastructure Team'
             }
         };
-        const req = { objects: [workItemObject] };
+        const req = { objects: [workItemObject], connectionId: TEST_CONNECTION_ID };
         const backendResponse = {
             accepted: [
                 {
@@ -2030,7 +1973,7 @@ describe('TeamWorkGraphClient - bulk entities', () => {
                 ]
             }
         };
-        const req = { objects: [dashboardObject] };
+        const req = { objects: [dashboardObject], connectionId: TEST_CONNECTION_ID };
         const backendResponse = {
             accepted: [
                 {
@@ -2087,7 +2030,7 @@ describe('TeamWorkGraphClient - bulk entities', () => {
                 environment: 'staging'
             }
         };
-        const req = { objects: [testObject] };
+        const req = { objects: [testObject], connectionId: TEST_CONNECTION_ID };
         const backendResponse = {
             accepted: [
                 {
@@ -2143,7 +2086,7 @@ describe('TeamWorkGraphClient - bulk entities', () => {
                 testType: 'unit'
             }
         };
-        const req = { objects: [testExecutionObject] };
+        const req = { objects: [testExecutionObject], connectionId: TEST_CONNECTION_ID };
         const backendResponse = {
             accepted: [
                 {
@@ -2194,7 +2137,7 @@ describe('TeamWorkGraphClient - bulk entities', () => {
             ],
             'atlassian:test-plan': {}
         };
-        const req = { objects: [testPlanObject] };
+        const req = { objects: [testPlanObject], connectionId: TEST_CONNECTION_ID };
         const backendResponse = {
             accepted: [
                 {
@@ -2255,7 +2198,7 @@ describe('TeamWorkGraphClient - bulk entities', () => {
                 environment: 'staging'
             }
         };
-        const req = { objects: [testRunObject] };
+        const req = { objects: [testRunObject], connectionId: TEST_CONNECTION_ID };
         const backendResponse = {
             accepted: [
                 {