boldsign 1.0.3 → 2.0.0

package/tests/unit/senderIdentitiesApi.spec.ts

@@ -0,0 +1,148 @@
+import { SenderIdentitiesApi } from '../../api/senderIdentitiesApi'; // Adjust path accordingly
+import * as sinon from 'sinon';
+
+describe('SenderIdentityApi Unit Test', () => {
+    let senderIdentityApiStub: sinon.SinonStubbedInstance<SenderIdentitiesApi>;
+
+    beforeEach(() => {
+        senderIdentityApiStub = sinon.createStubInstance(SenderIdentitiesApi);
+
+        // Stub the methods (e.g., createSenderIdentity, updateSenderIdentity) for SenderIdentityApi
+        senderIdentityApiStub.createSenderIdentity = sinon.stub().resolves({ senderIdentityId: 'sender_identity_id' });
+        senderIdentityApiStub.updateSenderIdentity = sinon.stub().resolves({
+            success: true,
+            message: 'Sender identity updated successfully',
+        });
+    });
+
+    afterEach(() => {
+        // Restore original functionality after each test
+        sinon.restore();
+    });
+
+    it('should mock and verify createSenderIdentity call', async () => {
+        const mockSenderIdentityCreated = {
+            senderIdentityId: 'sender_identity_id',
+        };
+
+        const senderIdentityData = {
+            name: 'New Sender Identity',
+            email: 'senderEmail@example.com',
+            phoneNumber: '9876543210',
+            companyName: 'Syncfusion',
+        };
+
+        senderIdentityApiStub.createSenderIdentity.resolves(mockSenderIdentityCreated);
+
+        const result = await senderIdentityApiStub.createSenderIdentity(senderIdentityData);
+
+        expect(result).toBeDefined();
+        expect(result.senderIdentityId).toBe('sender_identity_id');
+
+        sinon.assert.calledOnceWithExactly(senderIdentityApiStub.createSenderIdentity, senderIdentityData);
+    });
+
+    it('should mock and verify updateSenderIdentity call', async () => {
+        const mockUpdatedSenderIdentity = {
+            success: true,
+            message: 'Sender identity updated successfully',
+        };
+    
+        const senderIdentityId = 'sender_identity_id';
+        const updatedSenderIdentityData = {
+            name: 'Updated Sender Identity',
+            email: 'updatedSenderEmail@example.com',
+            phoneNumber: '1234567890',
+            companyName: 'Updated Syncfusion',
+        };
+    
+        senderIdentityApiStub.updateSenderIdentity.resolves(mockUpdatedSenderIdentity);
+    
+        const result = await senderIdentityApiStub.updateSenderIdentity(senderIdentityId, updatedSenderIdentityData);
+    
+        expect(result).toBeDefined();
+        expect(result.success).toBe(true);
+        expect(result.message).toBe('Sender identity updated successfully');
+    
+        sinon.assert.calledOnceWithExactly(
+            senderIdentityApiStub.updateSenderIdentity,
+            senderIdentityId,
+            updatedSenderIdentityData
+        );
+    });
+
+    it('should mock and verify deleteSenderIdentity call', async () => {
+        const mockDeleteResponse = {
+            success: true,
+            message: 'Sender identity deleted successfully',
+        };
+    
+        const senderIdentityId = 'sender_identity_id';
+    
+        senderIdentityApiStub.deleteSenderIdentity = sinon.stub().resolves(mockDeleteResponse);
+    
+        const result = await senderIdentityApiStub.deleteSenderIdentity(senderIdentityId);
+    
+        expect(result).toBeDefined();
+        expect(result.success).toBe(true);
+        expect(result.message).toBe('Sender identity deleted successfully');
+    
+        sinon.assert.calledOnceWithExactly(
+            senderIdentityApiStub.deleteSenderIdentity,
+            senderIdentityId
+        );
+    });
+
+    it('should mock and verify resendInvitationSenderIdentity call', async () => {
+        const mockResendResponse = {
+            success: true,
+            message: 'Invitation resent successfully',
+        };
+    
+        const senderIdentityId = 'sender_identity_id';
+    
+        senderIdentityApiStub.resendInvitationSenderIdentity = sinon.stub().resolves(mockResendResponse);
+    
+        const result = await senderIdentityApiStub.resendInvitationSenderIdentity(senderIdentityId);
+    
+        expect(result).toBeDefined();
+        expect(result.success).toBe(true);
+        expect(result.message).toBe('Invitation resent successfully');
+    
+        sinon.assert.calledOnceWithExactly(
+            senderIdentityApiStub.resendInvitationSenderIdentity,
+            senderIdentityId
+        );
+    });
+
+    it('should mock and verify listSenderIdentities call', async () => {
+        const mockListResponse = {
+            identities: [
+                {
+                    senderIdentityId: 'id_1',
+                    name: 'Sender One',
+                    email: 'sender1@example.com',
+                    companyName: 'Company One',
+                },
+                {
+                    senderIdentityId: 'id_2',
+                    name: 'Sender Two',
+                    email: 'sender2@example.com',
+                    companyName: 'Company Two',
+                },
+            ],
+        };
+    
+        senderIdentityApiStub.listSenderIdentities = sinon.stub().resolves(mockListResponse);
+
+        const result = await senderIdentityApiStub.listSenderIdentities();
+    
+        expect(result).toBeDefined();
+        expect(Array.isArray(result.identities)).toBe(true);
+        expect(result.identities).toHaveLength(2);
+        expect(result.identities[0].senderIdentityId).toBe('id_1');
+        expect(result.identities[1].email).toBe('sender2@example.com');
+    
+        sinon.assert.calledOnce(senderIdentityApiStub.listSenderIdentities);
+    });
+});

package/tests/unit/teamApi.spec.ts

@@ -0,0 +1,94 @@
+import { TeamsApi } from '../../api/teamsApi';
+import * as sinon from 'sinon';
+
+describe('TeamApi Unit Test', () => {
+    let teamApiStub: sinon.SinonStubbedInstance<TeamsApi>;
+
+    beforeEach(() => {
+        // Create a stub instance for the TeamsApi
+        teamApiStub = sinon.createStubInstance(TeamsApi);
+
+        // Stub the methods (e.g., createTeam, updateTeam) for TeamsApi
+        teamApiStub.createTeam = sinon.stub().resolves({ teamId: 'team_id' });
+        teamApiStub.updateTeam = sinon.stub().resolves({
+            success: true,
+            message: 'Team updated successfully',
+        });
+    });
+
+    afterEach(() => {
+        sinon.restore();
+    });
+
+    it('should mock and verify createTeam call', async () => {
+        const mockTeamCreated = {
+            teamId: 'team_id',
+        };
+
+        const teamData = {
+            name: 'New Team',
+            description: 'A test team for Syncfusion',
+        };
+
+        teamApiStub.createTeam.resolves(mockTeamCreated);
+
+        const result = await teamApiStub.createTeam(teamData);
+
+        expect(result).toBeDefined();
+        expect(result.teamId).toBe('team_id');
+
+        sinon.assert.calledOnceWithExactly(teamApiStub.createTeam, teamData);
+    });
+
+    it('should mock and verify getTeamDetails call', async () => {
+        const teamId = 'team_id';
+
+        const mockTeamDetails = {
+            teamId: 'team_id',
+            name: 'Engineering Team',
+            description: 'Handles product development',
+            members: ['user1', 'user2'],
+        };
+
+        teamApiStub.getTeamDetails = sinon.stub().resolves(mockTeamDetails);
+
+        const result = await teamApiStub.getTeamDetails(teamId);
+
+        expect(result).toBeDefined();
+        expect(result.teamId).toBe('team_id');
+        expect(result.name).toBe('Engineering Team');
+        expect(result.members).toContain('user1');
+        expect(result.members.length).toBe(2);
+
+        sinon.assert.calledOnceWithExactly(teamApiStub.getTeamDetails, teamId);
+    });
+
+    it('should mock and verify listTeams call', async () => {
+        const mockListResponse = {
+            teams: [
+                {
+                    teamId: 'team_1',
+                    name: 'Engineering',
+                    description: 'Handles product development',
+                },
+                {
+                    teamId: 'team_2',
+                    name: 'Marketing',
+                    description: 'Manages marketing campaigns',
+                },
+            ],
+        };
+
+        teamApiStub.listTeams = sinon.stub().resolves(mockListResponse);
+
+        const result = await teamApiStub.listTeams();
+
+        expect(result).toBeDefined();
+        expect(Array.isArray(result.teams)).toBe(true);
+        expect(result.teams.length).toBe(2);
+        expect(result.teams[0].name).toBe('Engineering');
+        expect(result.teams[1].teamId).toBe('team_2');
+
+        sinon.assert.calledOnce(teamApiStub.listTeams);
+    });
+});

package/tests/unit/templateApi.spec.ts

@@ -0,0 +1,307 @@
+import { TemplateApi } from '../../api/templateApi';
+import * as sinon from 'sinon';
+
+describe('TemplateApi Unit Test', () => {
+    let templateApiStub: sinon.SinonStubbedInstance<TemplateApi>;
+
+    beforeEach(() => {
+        // Create a stub instance of TemplateApi
+        templateApiStub = sinon.createStubInstance(TemplateApi);
+    });
+
+    afterEach(() => {
+        sinon.restore();
+    });
+
+    it('should mock and verify createTemplate call', async () => {
+        const templateData = {
+            name: 'Sample Template',
+            fields: {
+                Title: 'title',
+                Description: 'description',
+                DocumentTitle: 'documentTitle',
+                Files: 'path/to/file.png',
+                BrandId: 'brand_id',
+                onBehalfOf: 'email_example',
+            }
+        };
+
+        const mockCreatedTemplate = {
+            id: 'templateId',
+            name: 'Sample Template'
+        };
+
+        templateApiStub.createTemplate.resolves(mockCreatedTemplate);
+
+        const result = await templateApiStub.createTemplate(templateData);
+
+        expect(result.id).toEqual('templateId');
+
+        sinon.assert.calledOnceWithExactly(templateApiStub.createTemplate, templateData);
+    });
+
+    it('should mock and verify listTemplates call', async () => {
+        const mockTemplatesList = [
+            { id: 'template1', name: 'Template One' },
+            { id: 'template2', name: 'Template Two' }
+        ];
+
+        templateApiStub.listTemplates.resolves(mockTemplatesList);
+
+        const result = await templateApiStub.listTemplates();
+
+        expect(result).toBeDefined();
+        expect(Array.isArray(result)).toBe(true);
+        expect(result.length).toBe(2);
+        expect(result[0].id).toBe('template1');
+        expect(result[1].name).toBe('Template Two');
+
+        sinon.assert.calledOnce(templateApiStub.listTemplates);
+    });
+
+    it('should mock and verify deleteTemplate call', async () => {
+        const templateId = 'templateIdToDelete';
+
+        const mockDeleteResponse = {
+            success: true,
+            message: 'Template deleted successfully'
+        };
+
+        templateApiStub.deleteTemplate.resolves(mockDeleteResponse);
+
+        const result = await templateApiStub.deleteTemplate(templateId);
+
+        expect(result).toBeDefined();
+        expect(result.success).toBe(true);
+        expect(result.message).toBe('Template deleted successfully');
+
+        sinon.assert.calledOnceWithExactly(templateApiStub.deleteTemplate, templateId);
+    });
+
+    it('should mock and verify getTemplateDetails call', async () => {
+        const templateId = 'template123';
+        const mockTemplateDetails = {
+            id: 'template123',
+            name: 'Detailed Template',
+            fields: {
+                Title: 'Sample Title',
+                Description: 'Some description'
+            }
+        };
+    
+        templateApiStub.getTemplateDetails = sinon.stub().resolves(mockTemplateDetails);
+    
+        const result = await templateApiStub.getTemplateDetails(templateId);
+    
+        expect(result).toBeDefined();
+        expect(result.id).toBe('template123');
+        expect(result.name).toBe('Detailed Template');
+    
+        sinon.assert.calledOnceWithExactly(templateApiStub.getTemplateDetails, templateId);
+    });
+
+    it('should mock and verify editTemplate (updateTemplate) call', async () => {
+        const templateId = 'template123';
+        const updateData = {
+            name: 'Updated Template',
+            fields: {
+                Title: 'Updated Title',
+                Description: 'Updated description',
+                DocumentTitle: 'Updated documentTitle',
+                Files: 'path/to/updated_file.png',
+                BrandId: 'updated_brand_id',
+                onBehalfOf: 'updated_email@example.com',
+            }
+        };
+    
+        const mockUpdatedTemplate = {
+            id: 'template123',
+            name: 'Updated Template',
+            fields: updateData.fields
+        };
+    
+        templateApiStub.updateTemplate = sinon.stub().resolves(mockUpdatedTemplate);
+    
+        const result = await templateApiStub.updateTemplate(templateId, updateData);
+    
+        expect(result).toBeDefined();
+        expect(result.id).toBe(templateId);
+        expect(result.name).toBe('Updated Template');
+    
+        sinon.assert.calledOnceWithExactly(templateApiStub.updateTemplate, templateId, updateData);
+    });
+
+    it('should mock and verify addTemplateTag call', async () => {
+        const templateId = 'template123';
+        const tagData = {
+            tag: 'new-tag',
+        };
+
+        const mockAddTagResponse = {
+            success: true,
+            message: 'Tag added successfully to the template',
+            templateId: 'template123',
+            tags: ['new-tag'],
+        };
+
+        templateApiStub.addTemplateTag = sinon.stub().resolves(mockAddTagResponse);
+
+        const result = await templateApiStub.addTemplateTag(templateId, tagData);
+
+        expect(result).toBeDefined();
+        expect(result.success).toBe(true);
+        expect(result.message).toBe('Tag added successfully to the template');
+        expect(result.templateId).toBe(templateId);
+        expect(result.tags).toEqual(['new-tag']);
+
+        sinon.assert.calledOnceWithExactly(templateApiStub.addTemplateTag, templateId, tagData);
+    });
+
+    it('should mock and verify deleteTemplateTag call', async () => {
+        const templateId = 'template123';
+        const tagData = {
+            tag: 'new-tag',
+        };
+
+        const mockDeleteTagResponse = {
+            success: true,
+            message: 'Tag deleted successfully from the template',
+            templateId: 'template123',
+            tags: [],
+        };
+
+        templateApiStub.deleteTemplateTag = sinon.stub().resolves(mockDeleteTagResponse);
+
+        const result = await templateApiStub.deleteTemplateTag(templateId, tagData);
+
+        expect(result).toBeDefined();
+        expect(result.success).toBe(true);
+        expect(result.message).toBe('Tag deleted successfully from the template');
+        expect(result.templateId).toBe(templateId);
+        expect(result.tags).toEqual([]);
+
+        sinon.assert.calledOnceWithExactly(templateApiStub.deleteTemplateTag, templateId, tagData);
+    });
+
+    it('should mock and verify downloadTemplate call', async () => {
+        const templateId = 'template123';
+        const mockDownloadResponse = Buffer.from('some template data');
+
+        templateApiStub.downloadTemplate = sinon.stub().resolves(mockDownloadResponse);
+
+        const result = await templateApiStub.downloadTemplate(templateId);
+
+        expect(result).toBeDefined();
+        expect(result).toBeInstanceOf(Buffer);
+        expect(result.toString()).toBe(mockDownloadResponse.toString());
+
+        sinon.assert.calledOnceWithExactly(templateApiStub.downloadTemplate, templateId);
+    });
+
+    it('should mock and verify createEmbeddedTemplate call', async () => {
+        const embeddedTemplateData = {
+            name: 'Embedded Template',
+            fields: {
+                Title: 'title',
+                Description: 'description',
+                DocumentTitle: 'documentTitle',
+                Files: 'path/to/file.pdf',
+                BrandId: 'brand123',
+                onBehalfOf: 'user@example.com',
+            },
+            redirectUrl: 'https://your-app.com/redirect',
+        };
+
+        const mockEmbeddedTemplateResponse = {
+            templateId: 'embeddedTemplate123',
+            url: 'https://signing-service.com/embedded/template/embeddedTemplate123',
+            expiresAt: '2025-12-31T23:59:59Z'
+        };
+
+        templateApiStub.createEmbeddedTemplate = sinon.stub().resolves(mockEmbeddedTemplateResponse);
+
+        const result = await templateApiStub.createEmbeddedTemplate(embeddedTemplateData);
+
+        expect(result).toBeDefined();
+        expect(result.templateId).toBe('embeddedTemplate123');
+        expect(result.url).toContain('/embedded/template/embeddedTemplate123');
+        expect(result.expiresAt).toBe('2025-12-31T23:59:59Z');
+
+        sinon.assert.calledOnceWithExactly(templateApiStub.createEmbeddedTemplate, embeddedTemplateData);
+    });
+
+    it('should mock and verify editEmbeddedTemplate call', async () => {
+        const templateId = 'embeddedTemplate123';
+        const updateData = {
+            name: 'Updated Embedded Template',
+            fields: {
+                Title: 'Updated Title',
+                Description: 'Updated Description',
+                DocumentTitle: 'Updated Doc Title',
+                Files: 'path/to/updated_file.pdf',
+                BrandId: 'updatedBrand456',
+                onBehalfOf: 'updateduser@example.com',
+            },
+            redirectUrl: 'https://your-app.com/updated-redirect',
+        };
+
+        const mockUpdatedEmbeddedTemplateResponse = {
+            templateId: templateId,
+            name: 'Updated Embedded Template',
+            url: 'https://signing-service.com/embedded/template/embeddedTemplate123',
+            expiresAt: '2025-12-31T23:59:59Z',
+            updated: true
+        };
+
+        templateApiStub.editEmbeddedTemplate = sinon.stub().resolves(mockUpdatedEmbeddedTemplateResponse);
+
+        const result = await templateApiStub.editEmbeddedTemplate(templateId, updateData);
+
+        expect(result).toBeDefined();
+        expect(result.templateId).toBe(templateId);
+        expect(result.name).toBe('Updated Embedded Template');
+        expect(result.url).toContain('/embedded/template/embeddedTemplate123');
+        expect(result.updated).toBe(true);
+        expect(result.expiresAt).toBe('2025-12-31T23:59:59Z');
+
+        sinon.assert.calledOnceWithExactly(templateApiStub.editEmbeddedTemplate, templateId, updateData);
+    });
+
+    it('should mock and verify createEmbeddedRequestLinkFromTemplate call', async () => {
+        const templateId = 'template123';
+        const requestData = {
+            title: 'Embedded Signing Request',
+            message: 'Please sign this document via embedded link.',
+            roles: [
+                {
+                    role: 'Signer',
+                    name: 'Jane Doe',
+                    email: 'jane.doe@example.com',
+                }
+            ],
+            redirectUrl: 'https://your-app.com/redirect-after-signing',
+            onBehalfOf: 'admin@example.com',
+            isSandbox: true,
+            labels: ['embedded', 'request'],
+        };
+
+        const mockResponse = {
+            requestId: 'req789',
+            url: 'https://signing-service.com/embedded/request/req789',
+            expiresAt: '2025-12-31T23:59:59Z',
+            templateId: 'template123',
+        };
+
+        templateApiStub.createEmbeddedRequestLinkFromTemplate = sinon.stub().resolves(mockResponse);
+
+        const result = await templateApiStub.createEmbeddedRequestLinkFromTemplate(templateId, requestData);
+
+        expect(result).toBeDefined();
+        expect(result.requestId).toBe('req789');
+        expect(result.url).toContain('/embedded/request/req789');
+        expect(result.templateId).toBe(templateId);
+        expect(result.expiresAt).toBe('2025-12-31T23:59:59Z');
+
+        sinon.assert.calledOnceWithExactly(templateApiStub.createEmbeddedRequestLinkFromTemplate, templateId, requestData);
+    });
+});