@studyportals/campaign-management-api-interface 0.13.1 → 0.13.3

package/src/auditor-campaign-management-api.client.ts

@@ -1,54 +0,0 @@
-import "reflect-metadata";
-
-import { SuperAgentRequest } from "superagent";
-import { GetAuditorDto } from "./domain/auditor/get-auditor.dto";
-import { AuditorOperation } from "./domain/auditor/enums/auditor-operation.enum";
-import { injectable } from "inversify";
-
-import * as superagent from "superagent";
-
-@injectable()
-export class AuditorCampaignManagementAPIClient {
-    public constructor(
-        private readonly baseUrl: string
-    ) { }
-
-    public async getCampaignAuditorData(campaignID: number, jwt = ""): Promise<GetAuditorDto[]> {
-        const result = await this.getRequest(`auditor/campaigns/${campaignID}`, jwt);
-        const getAuditorDtos = result.body as GetAuditorDto[];
-
-        return getAuditorDtos;
-    }
-
-    public async storeCampaignAuditorData(operation: AuditorOperation, campaignID: number, username: string, isUserAction: boolean, data: any, jwt = ""): Promise<GetAuditorDto> {
-        const sendData = {
-            "operation": operation,
-            "entityID": campaignID,
-            "username": username,
-            "isUserAction": isUserAction,
-            "data": data
-        };
-
-        const result = await this.postRequest(`auditor/campaigns`, sendData, jwt);
-
-        return result.body as GetAuditorDto;
-    }
-
-
-    private async getRequest(relative: string = "", jwt = ""): Promise<SuperAgentRequest> {
-        return await superagent.get(this.buildBaseUrl(relative))
-            .set("Content-Type", "application/json")
-            .set("Authorization", jwt);
-    }
-
-    private async postRequest(relative: string = "", data: any, jwt = ""): Promise<SuperAgentRequest> {
-        return await superagent.post(this.buildBaseUrl(relative))
-            .set("Content-Type", "application/json")
-            .set("Authorization", jwt)
-            .send(data);
-    }
-
-    private buildBaseUrl(relative: string): string {
-        return `${this.baseUrl}/${relative}`;
-    }
-}

package/src/campaign-management-api.client.ts

@@ -1,68 +0,0 @@
-import "reflect-metadata";
-
-import { SuperAgentRequest } from "superagent";
-import { injectable } from "inversify";
-import { CampaignsEntitiesConfigDto } from "./domain/campaign/CampaignsEntitiesConfig.dto";
-
-import * as superagent from "superagent";
-
-@injectable()
-export class CampaignManagementAPIClient {
-	public constructor(
-		private readonly baseUrl: string
-	) {	}
-
-	public async addCampaignsEntitiesConfigs(campaignID: number, campaignsEntitiesConfigs: CampaignsEntitiesConfigDto[]): Promise<any> {
-		const path = `campaigns/add-campaigns-entities-configs`;
-		const data = {
-			campaignsEntitiesConfigs: campaignsEntitiesConfigs,
-			campaignID: campaignID
-		};
-
-		return await this.postRequest(path, data);
-	}
-
-	public async removeCampaignsEntitiesConfigsByID(campaignID: number, campaignsEntitiesConfigsIDs: number[]): Promise<any> {
-		const path = `campaigns/remove-campaigns-entities-configs`;
-		const data = { campaignsEntitiesConfigsIDs: campaignsEntitiesConfigsIDs, campaignID: campaignID };
-
-		return await this.postRequest(path, data);
-	}
-
-	public async clearCampaignsEntitiesConfigsByCampaignID(campaignID: number): Promise<any> {
-		const path = `campaigns/clear-campaigns-entities-configs`;
-		const data = { campaignID: campaignID };
-
-		return await this.postRequest(path, data);
-	}
-
-	public async setEntitiesBasic(campaignID: number, organisationIDs: number[], studyIDs: number[]): Promise<any> {
-		const path = `campaigns/set-entities-basic`;
-		const data = { 
-			organisationIDs: organisationIDs, 
-			studyIDs: studyIDs,
-			campaignID: campaignID
-		};
-
-		return await this.postRequest(path, data);
-	}
-
-	public async setEntitiesPremium(campaignID: number, organisationIDs: number[], studyIDs: number[]): Promise<any> {
-		const path = `campaigns/set-entities-premium`;
-		const data = { 
-			organisationIDs: organisationIDs, 
-			studyIDs: studyIDs,
-			campaignID: campaignID 
-		};
-
-		return await this.postRequest(path, data);
-	}
-
-	private async postRequest(relative: string = "", data: any): Promise<SuperAgentRequest> {
-        return await superagent.post(this.buildBaseUrl(relative)).set("Content-Type", "application/json").send(data);
-	}
-
-	private buildBaseUrl(relative: string): string {
-		return `${this.baseUrl}/${relative}`;
-	}
-}

package/src/domain/auditor/campaigns/geotargeting.entities.ts

@@ -1,20 +0,0 @@
-interface NumberMap { [key: string]: number; }
-
-interface ICampaignAuditorData {
-    geo: any[];
-    pricing: Pricing;
-    geo_remainders: NumberMap;
-}
-
-class Pricing {
-    public constructor(
-        public s: NumberMap = {},
-        public o: NumberMap = {}
-    ) {}
-}
-
-export {
-    ICampaignAuditorData,
-    NumberMap,
-    Pricing
-};

package/src/domain/auditor/enums/auditor-entity-type.enum.ts

@@ -1,3 +0,0 @@
-export enum AuditorEntityType {
-    CAMPAIGN = "campaign"
-}

package/src/domain/auditor/get-auditor.dto.ts

@@ -1,33 +0,0 @@
-import { AuditorEntityType } from "./enums/auditor-entity-type.enum";
-import { AuditorOperation } from "./enums/auditor-operation.enum";
-
-export class GetAuditorDto {
-    public readonly id: number;
-    public readonly auditTime: string
-    public readonly operation: AuditorOperation
-    public readonly entityID: number
-    public readonly entityType: AuditorEntityType
-    public readonly username: string
-    public readonly isUserAction: boolean
-    public readonly data: any
-
-    public constructor(
-        id: number,
-        auditTime: string,
-        operation: AuditorOperation,
-        entityID: number,
-        entityType: AuditorEntityType,
-        username: string,
-        isUserAction: boolean,
-        data: any
-    ) {
-        this.id = id;
-        this.auditTime = auditTime;
-        this.operation = operation;
-        this.entityID = entityID;
-        this.entityType = entityType;
-        this.username = username;
-        this.isUserAction = isUserAction;
-        this.data = data;
-    }
-}

package/src/domain/campaign/CampaignsEntitiesConfig.dto.ts

@@ -1,7 +0,0 @@
-export class CampaignsEntitiesConfigDto {
-    public campaign_id: number;
-    public sp_id: number;
-    public product_id: number;
-    public product2_id: number | null = null;
-    public type: string;
-}

package/src/private-campaign-management-api.client.ts

@@ -1,80 +0,0 @@
-import "reflect-metadata";
-
-import { SuperAgentRequest } from "superagent";
-import { injectable } from "inversify";
-import { CampaignsEntitiesConfigDto } from "./domain/campaign/CampaignsEntitiesConfig.dto";
-import { ISuperAgentRequestFactory, SignedRequestSender } from "@studyportals/mb-platform-http-requests";
-
-@injectable()
-export class PrivateCampaignManagementAPIClient {
-	public constructor(
-        private readonly superAgentRequestFactory: ISuperAgentRequestFactory,
-        private readonly requestSender: SignedRequestSender,
-		private readonly baseUrl: string
-	) {	}
-
-	public async addCampaignsEntitiesConfigs(campaignID: number, campaignsEntitiesConfigs: CampaignsEntitiesConfigDto[]): Promise<any> {
-		const path = `private/campaigns/add-campaigns-entities-configs`;
-		const data = {
-			campaignsEntitiesConfigs: campaignsEntitiesConfigs,
-			campaignID: campaignID
-		};
-
-		return await this.postRequest(path, data);
-	}
-
-	public async removeCampaignsEntitiesConfigsByID(campaignID: number, campaignsEntitiesConfigsIDs: number[]): Promise<any> {
-		const path = `private/campaigns/remove-campaigns-entities-configs`;
-		const data = { campaignsEntitiesConfigsIDs: campaignsEntitiesConfigsIDs, campaignID: campaignID };
-
-		return await this.postRequest(path, data);
-	}
-
-	public async clearCampaignsEntitiesConfigsByCampaignID(campaignID: number): Promise<any> {
-		const path = `private/campaigns/clear-campaigns-entities-configs`;
-		const data = { campaignID: campaignID };
-
-		return await this.postRequest(path, data);
-	}
-
-	public async setEntitiesBasic(campaignID: number, organisationIDs: number[], studyIDs: number[]): Promise<any> {
-		const path = `private/campaigns/set-entities-basic`;
-		const data = { 
-			organisationIDs: organisationIDs, 
-			studyIDs: studyIDs,
-			campaignID: campaignID
-		};
-
-		return await this.postRequest(path, data);
-	}
-
-	public async setEntitiesPremium(campaignID: number, organisationIDs: number[], studyIDs: number[]): Promise<any> {
-		const path = `private/campaigns/set-entities-premium`;
-		const data = { 
-			organisationIDs: organisationIDs, 
-			studyIDs: studyIDs,
-			campaignID: campaignID
-		};
-
-		return await this.postRequest(path, data);
-	}
-
-	private async postRequest(relative: string = "", data: any): Promise<any> {
-        const request = this.createPostRequest(relative);
-		return await this.sendRequest(request, data);
-	}
-
-    private createPostRequest(relative: string = ""): SuperAgentRequest {
-		const url = this.buildBaseUrl(relative);
-		return this.superAgentRequestFactory.post(url);
-	}
-
-    private async sendRequest(request: SuperAgentRequest, payload: any): Promise<any> {
-		request.send(payload);
-		return await this.requestSender.send(request);
-	}
-
-	private buildBaseUrl(relative: string): string {
-		return `${this.baseUrl}/${relative}`;
-	}
-}

package/tests-u/domain/auditor/auditor-campaign-management-api-client.test.ts

@@ -1,99 +0,0 @@
-import { suite, test } from "@testdeck/jest";
-import { MockProxy, mock } from "jest-mock-extended";
-import { assert } from "chai";
-import { AuditorCampaignManagementAPIClient } from "../../../src/auditor-campaign-management-api.client";
-import { IRequestSender, ISuperAgentRequestFactory, RequestSender } from "@studyportals/mb-platform-http-requests";
-import { SuperAgentRequest } from "superagent";
-import { AuditorOperation } from "../../../src/domain/auditor/enums/auditor-operation.enum";
-import * as superagent from "superagent";
-
-
-const superagentMock = require("superagent-mocker")(superagent);
-
-@suite
-class AuditorCampaignManagementAPIClientTest {
-    private auditorCampaignManagementAPIClient: AuditorCampaignManagementAPIClient;
-    private mockedRequestSender: MockProxy<IRequestSender> = mock<IRequestSender>();
-    private mockedRequest: MockProxy<SuperAgentRequest> = mock<SuperAgentRequest>();
-    private mockedSuperAgentRequestFactory: MockProxy<ISuperAgentRequestFactory> = mock<ISuperAgentRequestFactory>();
-    private mockedBaseUrl = "SomeBaseUrl";
-
-    public before() {
-        this.mockedSuperAgentRequestFactory.get.mockReturnValue(this.mockedRequest);
-        this.mockedSuperAgentRequestFactory.post.mockReturnValue(this.mockedRequest);
-
-        this.auditorCampaignManagementAPIClient = new AuditorCampaignManagementAPIClient(this.mockedBaseUrl);
-    }
-
-    @test()
-    public async getCampaignAuditorData__CorrectlyCalled() {
-        const receivedAuditorData = [
-            {
-                "id": 17428964,
-                "auditTime": "2023-00-00 13:55:09",
-                "operation": "update",
-                "entityID": 1,
-                "entityType": "campaign",
-                "username": "Jens Testing",
-                "isUserAction": true,
-                "data": "{\"geo\":[{\"s\":10000,\"o\":10000,\"c\":{\"sp\":1000,\"lp\":2000,\"p\":3000,\"b\":4000}},{\"s\":10000,\"o\":10000,\"c\":{\"sp\":1000,\"lp\":2000,\"p\":3000,\"b\":4000}},{\"s\":10000,\"o\":10000,\"c\":{\"sp\":1000,\"lp\":2000,\"p\":3000,\"b\":4000}}],\"pricing\":{\"s\":{\"100\":1000,\"200\":2000,\"300\":3000,\"400\":3000,\"500\":3000},\"o\":{\"100\":1000,\"200\":2000,\"300\":3000,\"400\":3000,\"500\":3000}},\"cpm\":{\"s\":{\"p\":1000,\"b\":2000},\"o\":{\"p\":1000,\"b\":2000}}}"
-            },
-            {
-                "id": 17428967,
-                "auditTime": "2023-00-00 14:55:54",
-                "operation": "update",
-                "entityID": 1,
-                "entityType": "campaign",
-                "username": "Jens Testing",
-                "isUserAction": true,
-                "data": "{\"geo\":[{\"s\":10000,\"o\":10000,\"c\":{\"sp\":1000,\"lp\":2000,\"p\":3000,\"b\":4000}},{\"s\":10000,\"o\":10000,\"c\":{\"sp\":1000,\"lp\":2000,\"p\":3000,\"b\":4000}},{\"s\":10000,\"o\":10000,\"c\":{\"sp\":1000,\"lp\":2000,\"p\":3000,\"b\":4000}}],\"pricing\":{\"s\":{\"100\":1000,\"200\":2000,\"300\":3000,\"400\":3000,\"500\":3000},\"o\":{\"100\":1000,\"200\":2000,\"300\":3000,\"400\":3000,\"500\":3000}},\"cpm\":{\"s\":{\"p\":1000,\"b\":2000},\"o\":{\"p\":1000,\"b\":2000}}}"
-            }
-        ];
-        this.mockedRequestSender.sendAndExtractBody.mockResolvedValue(receivedAuditorData);
-
-        const campaignID = 1;
-        superagentMock.get(`${this.mockedBaseUrl}/auditor/campaigns/${campaignID}`, () => {
-            return {
-                body: receivedAuditorData
-            }
-        });
-
-        const result = await this.auditorCampaignManagementAPIClient.getCampaignAuditorData(campaignID);
-
-        assert.equal(result[0].id, receivedAuditorData[0].id);
-        assert.equal(result[1].id, receivedAuditorData[1].id);
-    }
-
-    @test()
-    public async storeCampaignAuditorData__CorrectlyCalled() {
-        const sendData = {
-            "operation": "update",
-            "entityID": 1,
-            "username": "SomeName",
-            "isUserAction": true,
-            "data": {"some":"data"}
-        };
-
-        const id = 17428967;
-        const receivedData = {
-            "id": id,
-            "auditTime": "2023-00-00 14:55:54",
-            "operation": "update",
-            "entityID": 1,
-            "entityType": "campaign",
-            "username": "Jens Testing",
-            "isUserAction": true,
-            "data": "{\"geo\":[{\"s\":10000,\"o\":10000,\"c\":{\"sp\":1000,\"lp\":2000,\"p\":3000,\"b\":4000}},{\"s\":10000,\"o\":10000,\"c\":{\"sp\":1000,\"lp\":2000,\"p\":3000,\"b\":4000}},{\"s\":10000,\"o\":10000,\"c\":{\"sp\":1000,\"lp\":2000,\"p\":3000,\"b\":4000}}],\"pricing\":{\"s\":{\"100\":1000,\"200\":2000,\"300\":3000,\"400\":3000,\"500\":3000},\"o\":{\"100\":1000,\"200\":2000,\"300\":3000,\"400\":3000,\"500\":3000}},\"cpm\":{\"s\":{\"p\":1000,\"b\":2000},\"o\":{\"p\":1000,\"b\":2000}}}"
-        }
-
-        superagentMock.post(`${this.mockedBaseUrl}/auditor/campaigns`, () => {
-            return {
-                body: receivedData
-            }
-        });
-
-        const result = await this.auditorCampaignManagementAPIClient.storeCampaignAuditorData(AuditorOperation.UPDATE, sendData.entityID, sendData.username, sendData.isUserAction, sendData.data);
-
-        assert.equal(result.id, id);
-    }
-}

package/tests-u/domain/auditor/enums/auditor-entity-type-enum.test.ts

@@ -1,22 +0,0 @@
-import { suite, test } from "@testdeck/jest";
-import { assert } from "chai";
-import { AuditorEntityType } from "../../../../src/domain/auditor/enums/auditor-entity-type.enum";
-
-@suite
-class AuditorEntityTypeEnumTest {
-    @test()
-    public hasEnumValues_ExpectedValues_Successful() {
-        const auditorEntityKeys = this.getAllEntityKeys();
-
-        assert.isTrue(auditorEntityKeys.length === 1);
-        
-        assert.isTrue(AuditorEntityType.CAMPAIGN === "campaign");
-    }
-
-
-    private getAllEntityKeys(): string[] {
-        return [
-            "CAMPAIGN"
-        ]
-    }
-}

package/tests-u/domain/auditor/enums/auditor-operation-enum.test.ts

@@ -1,34 +0,0 @@
-import { suite, test } from "@testdeck/jest";
-import { assert } from "chai";
-import { AuditorOperation } from "../../../../src/domain/auditor/enums/auditor-operation.enum";
-
-@suite
-class AuditorOperationEnumTest {
-    @test()
-    public hasEnumValues_ExpectedValues_Successful() {
-        const auditorEntityKeys = this.getAllEntityKeys();
-
-        assert.isTrue(auditorEntityKeys.length === 7);
-        
-        assert.isTrue(AuditorOperation.CLEANUP === "cleanup");
-        assert.isTrue(AuditorOperation.UPDATE === "update");
-        assert.isTrue(AuditorOperation.CREATE === "create");
-        assert.isTrue(AuditorOperation.LINK === "link");
-        assert.isTrue(AuditorOperation.UNLINK === "unlink");
-        assert.isTrue(AuditorOperation.DELETE === "delete");
-        assert.isTrue(AuditorOperation.ENDOR === "endor");
-    }
-
-
-    private getAllEntityKeys(): string[] {
-        return [
-            "CLEANUP",
-            "UPDATE",
-            "CREATE",
-            "LINK",
-            "UNLINK",
-            "DELETE",
-            "ENDOR"
-        ]
-    }
-}

package/tests-u/domain/auditor/get-auditor-entity.test.ts

@@ -1,34 +0,0 @@
-import { UTCDateTime } from "@studyportals/mb-platform-date-time";
-import { suite, test } from "@testdeck/jest";
-import { assert } from "chai";
-import { AuditorEntityType } from "../../../src/domain/auditor/enums/auditor-entity-type.enum";
-import { AuditorOperation } from "../../../src/domain/auditor/enums/auditor-operation.enum";
-import { GetAuditorDto } from "../../../src/domain/auditor/get-auditor.dto";
-
-@suite
-class GetAuditorEntityTest {
-    @test()
-    public hasEnumValues_ExpectedValues_Successful() {
-        const id = 1;
-        const auditTime = UTCDateTime.now().toString();
-        const operation = AuditorOperation.CREATE;
-        const entityID = 2;
-        const entityType = AuditorEntityType.CAMPAIGN;
-        const username = "SomeUser";
-        const isUserAction = true;
-        const data = {
-            "SomeDataKey": "SomeDataValue"
-        };
-
-        const getAuditorEntity = new GetAuditorDto(id, auditTime, operation, entityID, entityType, username, isUserAction, data);
-
-        assert.equal(getAuditorEntity.id, id);
-        assert.equal(getAuditorEntity.auditTime, auditTime);
-        assert.equal(getAuditorEntity.operation, operation);
-        assert.equal(getAuditorEntity.entityID, entityID);
-        assert.equal(getAuditorEntity.entityType, entityType);
-        assert.equal(getAuditorEntity.username, username);
-        assert.equal(getAuditorEntity.isUserAction, isUserAction);
-        assert.equal(getAuditorEntity.data, data);
-    }
-}

package/tests-u/domain/campaign/campaign-management-api-client.test.ts

@@ -1,111 +0,0 @@
-import { suite, test } from "@testdeck/jest";
-import { MockProxy, mock } from "jest-mock-extended";
-import { assert } from "chai";
-import { ISuperAgentRequestFactory } from "@studyportals/mb-platform-http-requests";
-import { SuperAgentRequest } from "superagent";
-import * as superagent from "superagent";
-import { CampaignManagementAPIClient } from "../../../src/campaign-management-api.client";
-import { CampaignsEntitiesConfigDto } from "../../../src/domain/campaign/CampaignsEntitiesConfig.dto";
-
-
-const superagentMock = require("superagent-mocker")(superagent);
-
-@suite
-class CampaignManagementAPIClientTest {
-    private campaignManagementAPIClient: CampaignManagementAPIClient;
-    private mockedRequest: MockProxy<SuperAgentRequest> = mock<SuperAgentRequest>();
-    private mockedSuperAgentRequestFactory: MockProxy<ISuperAgentRequestFactory> = mock<ISuperAgentRequestFactory>();
-    private mockedBaseUrl = "SomeBaseUrl";
-
-    public before() {
-        this.mockedSuperAgentRequestFactory.post.mockReturnValue(this.mockedRequest);
-
-        this.campaignManagementAPIClient = new CampaignManagementAPIClient(this.mockedBaseUrl);
-    }
-
-    @test()
-    public async addCampaignsEntitiesConfigs__CorrectlyCalled() {
-        const postData: CampaignsEntitiesConfigDto = {
-            campaign_id: 1,
-            sp_id: 1,
-            product_id: 12,
-            product2_id: null,
-            type: "study"
-        };
-
-        superagentMock.post(`${this.mockedBaseUrl}/campaigns/add-campaigns-entities-configs`, () => {});
-
-        try {
-            const result = await this.campaignManagementAPIClient.addCampaignsEntitiesConfigs(1, [postData]);
-        } catch {
-            assert.fail();
-        }
-        
-        assert.ok(true);
-    }
-
-    @test()
-    public async removeCampaignsEntitiesConfigsByID__CorrectlyCalled() {
-        const campaignID = 1;
-        const entityIDs = [ 1 ];
-
-        superagentMock.post(`${this.mockedBaseUrl}/campaigns/remove-campaigns-entities-configs`, () => {});
-
-        try {
-            const result = await this.campaignManagementAPIClient.removeCampaignsEntitiesConfigsByID(campaignID, entityIDs);
-        } catch {
-            assert.fail();
-        }
-        
-        assert.ok(true);
-    }
-
-    @test()
-    public async clearCampaignsEntitiesConfigsByCampaignID__CorrectlyCalled() {
-        const postData = 1;
-
-        superagentMock.post(`${this.mockedBaseUrl}/campaigns/clear-campaigns-entities-configs`, () => {});
-
-        try {
-            const result = await this.campaignManagementAPIClient.clearCampaignsEntitiesConfigsByCampaignID(postData);
-        } catch {
-            assert.fail();
-        }
-        
-        assert.ok(true);
-    }
-
-    @test()
-    public async setEntitiesBasic__CorrectlyCalled() {
-        const campaignID = 1;
-        const organisationIDs = [1];
-        const studyIDs = [5];
-
-        superagentMock.post(`${this.mockedBaseUrl}/campaigns/set-entities-basic`, () => {});
-
-        try {
-            const result = await this.campaignManagementAPIClient.setEntitiesBasic(campaignID, organisationIDs, studyIDs);
-        } catch {
-            assert.fail();
-        }
-        
-        assert.ok(true);
-    }
-
-    @test()
-    public async setEntitiesPremium__CorrectlyCalled() {
-        const campaignID = 1;
-        const organisationIDs = [1];
-        const studyIDs = [5];
-
-        superagentMock.post(`${this.mockedBaseUrl}/campaigns/set-entities-premium`, () => {});
-
-        try {
-            const result = await this.campaignManagementAPIClient.setEntitiesPremium(campaignID, organisationIDs, studyIDs);
-        } catch {
-            assert.fail();
-        }
-        
-        assert.ok(true);
-    }
-}