@studyportals/campaign-management-api-interface 0.4.2 → 0.6.0

package/index.d.ts

@@ -1,5 +1,7 @@
 import { AuditorCampaignManagementAPIClient } from "./src/auditor-campaign-management-api.client";
+import { CampaignManagementAPIClient } from "./src/campaign-management-api.client";
 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";
-export { AuditorCampaignManagementAPIClient, AuditorEntityType, AuditorOperation, GetAuditorDto };
+import { CampaignsEntitiesConfigDto } from "./src/domain/campaign/CampaignsEntitiesConfig.dto";
+export { AuditorCampaignManagementAPIClient, CampaignManagementAPIClient, AuditorEntityType, AuditorOperation, GetAuditorDto, CampaignsEntitiesConfigDto };

package/index.js

@@ -1,12 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GetAuditorDto = exports.AuditorOperation = exports.AuditorEntityType = exports.AuditorCampaignManagementAPIClient = void 0;
+exports.CampaignsEntitiesConfigDto = exports.GetAuditorDto = exports.AuditorOperation = exports.AuditorEntityType = exports.CampaignManagementAPIClient = exports.AuditorCampaignManagementAPIClient = void 0;
 const auditor_campaign_management_api_client_1 = require("./src/auditor-campaign-management-api.client");
 Object.defineProperty(exports, "AuditorCampaignManagementAPIClient", { enumerable: true, get: function () { return auditor_campaign_management_api_client_1.AuditorCampaignManagementAPIClient; } });
+const campaign_management_api_client_1 = require("./src/campaign-management-api.client");
+Object.defineProperty(exports, "CampaignManagementAPIClient", { enumerable: true, get: function () { return campaign_management_api_client_1.CampaignManagementAPIClient; } });
 const auditor_entity_type_enum_1 = require("./src/domain/auditor/enums/auditor-entity-type.enum");
 Object.defineProperty(exports, "AuditorEntityType", { enumerable: true, get: function () { return auditor_entity_type_enum_1.AuditorEntityType; } });
 const auditor_operation_enum_1 = require("./src/domain/auditor/enums/auditor-operation.enum");
 Object.defineProperty(exports, "AuditorOperation", { enumerable: true, get: function () { return auditor_operation_enum_1.AuditorOperation; } });
 const get_auditor_dto_1 = require("./src/domain/auditor/get-auditor.dto");
 Object.defineProperty(exports, "GetAuditorDto", { enumerable: true, get: function () { return get_auditor_dto_1.GetAuditorDto; } });
+const CampaignsEntitiesConfig_dto_1 = require("./src/domain/campaign/CampaignsEntitiesConfig.dto");
+Object.defineProperty(exports, "CampaignsEntitiesConfigDto", { enumerable: true, get: function () { return CampaignsEntitiesConfig_dto_1.CampaignsEntitiesConfigDto; } });
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,yGAAkG;AAO9F,mHAPK,2EAAkC,OAOL;AANtC,kGAAwF;AASpF,kGATK,4CAAiB,OASL;AARrB,8FAAqF;AASjF,iGATK,yCAAgB,OASL;AARpB,0EAAqE;AAWjE,8FAXK,+BAAa,OAWL"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,yGAAkG;AAS9F,mHATK,2EAAkC,OASL;AARtC,yFAAmF;AAS/E,4GATK,4DAA2B,OASL;AAR/B,kGAAwF;AAWpF,kGAXK,4CAAiB,OAWL;AAVrB,8FAAqF;AAWjF,iGAXK,yCAAgB,OAWL;AAVpB,0EAAqE;AAajE,8FAbK,+BAAa,OAaL;AAZjB,mGAA+F;AAe3F,2GAfK,wDAA0B,OAeL"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@studyportals/campaign-management-api-interface",
-	"version": "0.4.2",
+	"version": "0.6.0",
 	"scripts": {
 		"compile": "rm -fR bin && npx tsc",
 		"test-u": "jest -c jest.config.unit.json --silent --maxWorkers=1",
@@ -22,6 +22,7 @@
 		"eslint": "^8.33.0",
 		"jest": "^29.4.2",
 		"jest-mock-extended": "^3.0.1",
+		"superagent-mocker": "^0.5.2",
 		"ts-jest": "^29.0.5",
 		"ts-node": "^10.2.1"
 	},

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

@@ -1,16 +1,12 @@
 import "reflect-metadata";
-import { IRequestSender } from "@studyportals/mb-platform-http-requests";
-import { ISuperAgentRequestFactory } from "@studyportals/mb-platform-http-requests/src/i-super-agent-request-factory.interface";
 import { GetAuditorDto } from "./domain/auditor/get-auditor.dto";
 import { AuditorOperation } from "./domain/auditor/enums/auditor-operation.enum";
 export declare class AuditorCampaignManagementAPIClient {
-    private readonly superAgentRequestFactory;
-    private readonly requestSender;
     private readonly baseUrl;
-    constructor(superAgentRequestFactory: ISuperAgentRequestFactory, requestSender: IRequestSender, baseUrl: string);
+    constructor(baseUrl: string);
     getCampaignAuditorData(campaignID: number): Promise<GetAuditorDto[]>;
     storeCampaignAuditorData(operation: AuditorOperation, campaignID: number, username: string, isUserAction: boolean, data: any): Promise<GetAuditorDto>;
-    private createGetRequest;
-    private createPostRequest;
+    private getRequest;
+    private postRequest;
     private buildBaseUrl;
 }

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

@@ -12,16 +12,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AuditorCampaignManagementAPIClient = void 0;
 require("reflect-metadata");
 const inversify_1 = require("inversify");
+const superagent = require("superagent");
 let AuditorCampaignManagementAPIClient = class AuditorCampaignManagementAPIClient {
-    constructor(superAgentRequestFactory, requestSender, baseUrl) {
-        this.superAgentRequestFactory = superAgentRequestFactory;
-        this.requestSender = requestSender;
+    constructor(baseUrl) {
         this.baseUrl = baseUrl;
     }
     async getCampaignAuditorData(campaignID) {
-        const request = this.createGetRequest(`auditor/campaigns/${campaignID}`);
-        request.send();
-        return this.requestSender.sendAndExtractBody(request);
+        const result = await this.getRequest(`auditor/campaigns/${campaignID}`);
+        const getAuditorDtos = result.body;
+        return getAuditorDtos;
     }
     async storeCampaignAuditorData(operation, campaignID, username, isUserAction, data) {
         const sendData = {
@@ -31,15 +30,14 @@ let AuditorCampaignManagementAPIClient = class AuditorCampaignManagementAPIClien
             "isUserAction": isUserAction,
             "data": data
         };
-        const request = this.createPostRequest(`auditor/campaigns/${campaignID}`);
-        request.send(sendData);
-        return await this.requestSender.sendAndExtractBody(request);
+        const result = await this.postRequest(`auditor/campaigns`, sendData);
+        return result.body;
     }
-    createGetRequest(relative = "") {
-        return this.superAgentRequestFactory.get(this.buildBaseUrl(relative));
+    async getRequest(relative = "") {
+        return await superagent.get(this.buildBaseUrl(relative)).set("Content-Type", "application/json");
     }
-    createPostRequest(relative = "") {
-        return this.superAgentRequestFactory.post(this.buildBaseUrl(relative));
+    async postRequest(relative = "", data) {
+        return await superagent.post(this.buildBaseUrl(relative)).set("Content-Type", "application/json").send(data);
     }
     buildBaseUrl(relative) {
         return `${this.baseUrl}/${relative}`;
@@ -47,7 +45,7 @@ let AuditorCampaignManagementAPIClient = class AuditorCampaignManagementAPIClien
 };
 AuditorCampaignManagementAPIClient = __decorate([
     (0, inversify_1.injectable)(),
-    __metadata("design:paramtypes", [Object, Object, String])
+    __metadata("design:paramtypes", [String])
 ], AuditorCampaignManagementAPIClient);
 exports.AuditorCampaignManagementAPIClient = AuditorCampaignManagementAPIClient;
 //# sourceMappingURL=auditor-campaign-management-api.client.js.map

package/src/auditor-campaign-management-api.client.js.map

@@ -1 +1 @@
-{"version":3,"file":"auditor-campaign-management-api.client.js","sourceRoot":"","sources":["../../src/auditor-campaign-management-api.client.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4BAA0B;AAO1B,yCAAuC;AAGhC,IAAM,kCAAkC,GAAxC,MAAM,kCAAkC;IAC3C,YACqB,wBAAmD,EACzD,aAA6B,EAC7B,OAAe;QAFT,6BAAwB,GAAxB,wBAAwB,CAA2B;QACzD,kBAAa,GAAb,aAAa,CAAgB;QAC7B,YAAO,GAAP,OAAO,CAAQ;IAC1B,CAAC;IAEE,KAAK,CAAC,sBAAsB,CAAC,UAAkB;QAClD,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,qBAAqB,UAAU,EAAE,CAAC,CAAC;QAC/E,OAAO,CAAC,IAAI,EAAE,CAAC;QAET,OAAO,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAkB,OAAO,CAAC,CAAC;IAC3E,CAAC;IAEM,KAAK,CAAC,wBAAwB,CAAC,SAA2B,EAAE,UAAkB,EAAE,QAAgB,EAAE,YAAqB,EAAE,IAAS;QACrI,MAAM,QAAQ,GAAG;YACb,WAAW,EAAE,SAAS;YACtB,UAAU,EAAE,UAAU;YACtB,UAAU,EAAE,QAAQ;YACpB,cAAc,EAAE,YAAY;YAC5B,MAAM,EAAE,IAAI;SACf,CAAC;QAEF,MAAM,OAAO,GAAG,IAAI,CAAC,iBAAiB,CAAC,qBAAqB,UAAU,EAAE,CAAC,CAAC;QAChF,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEjB,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAgB,OAAO,CAAC,CAAC;IAC/E,CAAC;IAGO,gBAAgB,CAAC,WAAmB,EAAE;QAChD,OAAO,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;IACvE,CAAC;IAEU,iBAAiB,CAAC,WAAmB,EAAE;QACjD,OAAO,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;IACxE,CAAC;IAEO,YAAY,CAAC,QAAgB;QACpC,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,QAAQ,EAAE,CAAC;IACtC,CAAC;CACD,CAAA;AAzCY,kCAAkC;IAD9C,IAAA,sBAAU,GAAE;;GACA,kCAAkC,CAyC9C;AAzCY,gFAAkC"}
+{"version":3,"file":"auditor-campaign-management-api.client.js","sourceRoot":"","sources":["../../src/auditor-campaign-management-api.client.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4BAA0B;AAK1B,yCAAuC;AAEvC,yCAAyC;AAGlC,IAAM,kCAAkC,GAAxC,MAAM,kCAAkC;IAC3C,YACe,OAAe;QAAf,YAAO,GAAP,OAAO,CAAQ;IAC1B,CAAC;IAEE,KAAK,CAAC,sBAAsB,CAAC,UAAkB;QAClD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,qBAAqB,UAAU,EAAE,CAAC,CAAC;QACxE,MAAM,cAAc,GAAG,MAAM,CAAC,IAAuB,CAAC;QAEtD,OAAO,cAAc,CAAC;IAC1B,CAAC;IAEM,KAAK,CAAC,wBAAwB,CAAC,SAA2B,EAAE,UAAkB,EAAE,QAAgB,EAAE,YAAqB,EAAE,IAAS;QACrI,MAAM,QAAQ,GAAG;YACb,WAAW,EAAE,SAAS;YACtB,UAAU,EAAE,UAAU;YACtB,UAAU,EAAE,QAAQ;YACpB,cAAc,EAAE,YAAY;YAC5B,MAAM,EAAE,IAAI;SACf,CAAC;QAEF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,mBAAmB,EAAE,QAAQ,CAAC,CAAC;QAErE,OAAO,MAAM,CAAC,IAAqB,CAAC;IACxC,CAAC;IAGO,KAAK,CAAC,UAAU,CAAC,WAAmB,EAAE;QAChD,OAAO,MAAM,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;IAClG,CAAC;IAEU,KAAK,CAAC,WAAW,CAAC,WAAmB,EAAE,EAAE,IAAS;QACtD,OAAO,MAAM,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpH,CAAC;IAEO,YAAY,CAAC,QAAgB;QACpC,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,QAAQ,EAAE,CAAC;IACtC,CAAC;CACD,CAAA;AAtCY,kCAAkC;IAD9C,IAAA,sBAAU,GAAE;;GACA,kCAAkC,CAsC9C;AAtCY,gFAAkC"}

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

@@ -0,0 +1,13 @@
+import "reflect-metadata";
+import { CampaignsEntitiesConfigDto } from "./domain/campaign/CampaignsEntitiesConfig.dto";
+export declare class CampaignManagementAPIClient {
+    private readonly baseUrl;
+    constructor(baseUrl: string);
+    addCampaignsEntitiesConfigs(campaignsEntitiesConfigs: CampaignsEntitiesConfigDto[]): Promise<void>;
+    removeCampaignsEntitiesConfigsByID(campaignsEntitiesConfigsIDs: number[]): Promise<void>;
+    clearCampaignsEntitiesConfigsByCampaignID(campaignID: number): Promise<void>;
+    setEntitiesBasic(organisationIDs: number[], studyIDs: number[]): Promise<void>;
+    setEntitiesPremium(organisationIDs: number[], studyIDs: number[]): Promise<void>;
+    private postRequest;
+    private buildBaseUrl;
+}

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

@@ -0,0 +1,57 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CampaignManagementAPIClient = void 0;
+require("reflect-metadata");
+const inversify_1 = require("inversify");
+const superagent = require("superagent");
+let CampaignManagementAPIClient = class CampaignManagementAPIClient {
+    constructor(baseUrl) {
+        this.baseUrl = baseUrl;
+    }
+    async addCampaignsEntitiesConfigs(campaignsEntitiesConfigs) {
+        const path = `campaigns/add-campaigns-entities-configs`;
+        const data = { campaignsEntitiesConfigs: campaignsEntitiesConfigs };
+        const result = await this.postRequest(path, data);
+    }
+    async removeCampaignsEntitiesConfigsByID(campaignsEntitiesConfigsIDs) {
+        const path = `campaigns/remove-campaigns-entities-configs`;
+        const data = { campaignsEntitiesConfigsIDs: campaignsEntitiesConfigsIDs };
+        const result = await this.postRequest(path, data);
+    }
+    async clearCampaignsEntitiesConfigsByCampaignID(campaignID) {
+        const path = `campaigns/clear-campaigns-entities-configs`;
+        const data = { campaignID: campaignID };
+        const result = await this.postRequest(path, data);
+    }
+    async setEntitiesBasic(organisationIDs, studyIDs) {
+        const path = `campaigns/set-entities-basic`;
+        const data = { organisationIDs: organisationIDs, studyIDs: studyIDs };
+        const result = await this.postRequest(path, data);
+    }
+    async setEntitiesPremium(organisationIDs, studyIDs) {
+        const path = `campaigns/set-entities-premium`;
+        const data = { organisationIDs: organisationIDs, studyIDs: studyIDs };
+        const result = await this.postRequest(path, data);
+    }
+    async postRequest(relative = "", data) {
+        return await superagent.post(this.buildBaseUrl(relative)).set("Content-Type", "application/json").send(data);
+    }
+    buildBaseUrl(relative) {
+        return `${this.baseUrl}/${relative}`;
+    }
+};
+CampaignManagementAPIClient = __decorate([
+    (0, inversify_1.injectable)(),
+    __metadata("design:paramtypes", [String])
+], CampaignManagementAPIClient);
+exports.CampaignManagementAPIClient = CampaignManagementAPIClient;
+//# sourceMappingURL=campaign-management-api.client.js.map

package/src/campaign-management-api.client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"campaign-management-api.client.js","sourceRoot":"","sources":["../../src/campaign-management-api.client.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4BAA0B;AAG1B,yCAAuC;AAGvC,yCAAyC;AAGlC,IAAM,2BAA2B,GAAjC,MAAM,2BAA2B;IACvC,YACkB,OAAe;QAAf,YAAO,GAAP,OAAO,CAAQ;IAC7B,CAAC;IAEE,KAAK,CAAC,2BAA2B,CAAC,wBAAsD;QAC9F,MAAM,IAAI,GAAG,0CAA0C,CAAC;QACxD,MAAM,IAAI,GAAG,EAAE,wBAAwB,EAAE,wBAAwB,EAAE,CAAC;QAEpE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,kCAAkC,CAAC,2BAAqC;QACpF,MAAM,IAAI,GAAG,6CAA6C,CAAC;QAC3D,MAAM,IAAI,GAAG,EAAE,2BAA2B,EAAE,2BAA2B,EAAE,CAAC;QAE1E,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,yCAAyC,CAAC,UAAkB;QACxE,MAAM,IAAI,GAAG,4CAA4C,CAAC;QAC1D,MAAM,IAAI,GAAG,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC;QAExC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,eAAyB,EAAE,QAAkB;QAC1E,MAAM,IAAI,GAAG,8BAA8B,CAAC;QAC5C,MAAM,IAAI,GAAG,EAAE,eAAe,EAAE,eAAe,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC;QAEtE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAAC,eAAyB,EAAE,QAAkB;QAC5E,MAAM,IAAI,GAAG,gCAAgC,CAAC;QAC9C,MAAM,IAAI,GAAG,EAAE,eAAe,EAAE,eAAe,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC;QAEtE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACnD,CAAC;IAEO,KAAK,CAAC,WAAW,CAAC,WAAmB,EAAE,EAAE,IAAS;QACnD,OAAO,MAAM,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpH,CAAC;IAEO,YAAY,CAAC,QAAgB;QACpC,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,QAAQ,EAAE,CAAC;IACtC,CAAC;CACD,CAAA;AA/CY,2BAA2B;IADvC,IAAA,sBAAU,GAAE;;GACA,2BAA2B,CA+CvC;AA/CY,kEAA2B"}

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

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

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

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CampaignsEntitiesConfigDto = void 0;
+class CampaignsEntitiesConfigDto {
+    constructor() {
+        this.product2_id = null;
+    }
+}
+exports.CampaignsEntitiesConfigDto = CampaignsEntitiesConfigDto;
+//# sourceMappingURL=CampaignsEntitiesConfig.dto.js.map

package/src/domain/campaign/CampaignsEntitiesConfig.dto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CampaignsEntitiesConfig.dto.js","sourceRoot":"","sources":["../../../../src/domain/campaign/CampaignsEntitiesConfig.dto.ts"],"names":[],"mappings":";;;AAAA,MAAa,0BAA0B;IAAvC;QAIW,gBAAW,GAAkB,IAAI,CAAC;IAE7C,CAAC;CAAA;AAND,gEAMC"}