@studyportals/campaign-management-api-interface 0.32.0 → 0.33.1-1

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@studyportals/campaign-management-api-interface",
-	"version": "0.32.0",
+	"version": "0.33.1-1",
 	"scripts": {
 		"compile": "rm -fR bin && npx tsc",
 		"test-u": "jest -c jest.config.unit.json --maxWorkers=1",

package/src/domain/links/create-link.dto.d.ts

@@ -0,0 +1,8 @@
+import { LinkType } from "../studies/enums/link-type.enum";
+export declare class CreateLinkDto {
+    name?: string;
+    url: string;
+    description: string;
+    type: LinkType;
+    active: boolean;
+}

package/src/domain/links/create-link.dto.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateLinkDto = void 0;
+class CreateLinkDto {
+}
+exports.CreateLinkDto = CreateLinkDto;
+//# sourceMappingURL=create-link.dto.js.map

package/src/domain/links/create-link.dto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-link.dto.js","sourceRoot":"","sources":["../../../../src/domain/links/create-link.dto.ts"],"names":[],"mappings":";;;AAEA,MAAa,aAAa;CAMzB;AAND,sCAMC"}

package/src/domain/links/link-entity-type.enum.d.ts

@@ -0,0 +1,5 @@
+export declare enum LinkEntityType {
+    STUDY = "study",
+    ORGANISATION = "organisation",
+    COUNTRY = "country"
+}

package/src/domain/links/link-entity-type.enum.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LinkEntityType = void 0;
+var LinkEntityType;
+(function (LinkEntityType) {
+    LinkEntityType["STUDY"] = "study";
+    LinkEntityType["ORGANISATION"] = "organisation";
+    LinkEntityType["COUNTRY"] = "country";
+})(LinkEntityType = exports.LinkEntityType || (exports.LinkEntityType = {}));
+//# sourceMappingURL=link-entity-type.enum.js.map

package/src/domain/links/link-entity-type.enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"link-entity-type.enum.js","sourceRoot":"","sources":["../../../../src/domain/links/link-entity-type.enum.ts"],"names":[],"mappings":";;;AAAA,IAAY,cAIX;AAJD,WAAY,cAAc;IACzB,iCAAe,CAAA;IACf,+CAA6B,CAAA;IAC7B,qCAAmB,CAAA;AACpB,CAAC,EAJW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAIzB"}

package/src/domain/links/parent-entity.dto.d.ts

@@ -0,0 +1,5 @@
+import { LinkEntityType } from "./link-entity-type.enum";
+export declare class ParentEntityDto {
+    id: number;
+    type: LinkEntityType;
+}

package/src/domain/links/parent-entity.dto.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ParentEntityDto = void 0;
+class ParentEntityDto {
+}
+exports.ParentEntityDto = ParentEntityDto;
+//# sourceMappingURL=parent-entity.dto.js.map

package/src/domain/links/parent-entity.dto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parent-entity.dto.js","sourceRoot":"","sources":["../../../../src/domain/links/parent-entity.dto.ts"],"names":[],"mappings":";;;AAEA,MAAa,eAAe;CAG3B;AAHD,0CAGC"}

package/src/domain/links/update-link.dto.d.ts

@@ -0,0 +1,4 @@
+import { CreateLinkDto } from "./create-link.dto";
+export declare class UpdateLinkDto extends CreateLinkDto {
+    id: string;
+}

package/src/domain/links/update-link.dto.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdateLinkDto = void 0;
+const create_link_dto_1 = require("./create-link.dto");
+class UpdateLinkDto extends create_link_dto_1.CreateLinkDto {
+}
+exports.UpdateLinkDto = UpdateLinkDto;
+//# sourceMappingURL=update-link.dto.js.map

package/src/domain/links/update-link.dto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-link.dto.js","sourceRoot":"","sources":["../../../../src/domain/links/update-link.dto.ts"],"names":[],"mappings":";;;AAAA,uDAAiD;AAEjD,MAAa,aAAc,SAAQ,+BAAa;CAE/C;AAFD,sCAEC"}

package/src/domain/studies/enums/link-type.enum.d.ts

@@ -10,6 +10,6 @@ export declare enum LinkType {
     PIXEL = "pixel",
     YOUTUBE = "youtube",
     INSTAGRAM = "instagram",
-    SWAPPABLE = "swappable",
+    MICROSITE = "microsite",
     TUITION_FEE = "tuition-fee"
 }

package/src/domain/studies/enums/link-type.enum.js

@@ -14,7 +14,7 @@ var LinkType;
     LinkType["PIXEL"] = "pixel";
     LinkType["YOUTUBE"] = "youtube";
     LinkType["INSTAGRAM"] = "instagram";
-    LinkType["SWAPPABLE"] = "swappable";
+    LinkType["MICROSITE"] = "microsite";
     LinkType["TUITION_FEE"] = "tuition-fee";
 })(LinkType = exports.LinkType || (exports.LinkType = {}));
 //# sourceMappingURL=link-type.enum.js.map

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

@@ -0,0 +1,11 @@
+import "reflect-metadata";
+import { CreateLinkDto } from "./domain/links/create-link.dto";
+import { UpdateLinkDto } from "./domain/links/update-link.dto";
+import { ParentEntityDto } from "./domain/links/parent-entity.dto";
+export declare class LinksCampaignManagementAPIClient {
+    private readonly baseUrl;
+    constructor(baseUrl: string);
+    createOrUpdateLinks(parentEntity: ParentEntityDto, linksToCreate: CreateLinkDto[], linksToUpdate: UpdateLinkDto[], jwt?: string): Promise<void>;
+    private postRequest;
+    private buildBaseUrl;
+}

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

@@ -0,0 +1,49 @@
+"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.LinksCampaignManagementAPIClient = void 0;
+require("reflect-metadata");
+const inversify_1 = require("inversify");
+const superagent = require("superagent");
+let LinksCampaignManagementAPIClient = class LinksCampaignManagementAPIClient {
+    constructor(baseUrl) {
+        this.baseUrl = baseUrl;
+    }
+    async createOrUpdateLinks(parentEntity, linksToCreate, linksToUpdate, jwt = "") {
+        const sendData = {
+            entityType: parentEntity.type,
+            entityId: parentEntity.id,
+            linksToCreate,
+            linksToUpdate
+        };
+        // update path when decided on the path and if changed
+        const path = 'links/create-or-update-links';
+        const result = await this.postRequest(path, sendData, jwt);
+        if (result.status !== 200) {
+            throw new Error("Failed to create or update links");
+        }
+    }
+    async postRequest(relative = "", data, jwt = "") {
+        return await superagent.post(this.buildBaseUrl(relative))
+            .set("Content-Type", "application/json")
+            .set("Authorization", jwt)
+            .send(data);
+    }
+    buildBaseUrl(relative) {
+        return `${this.baseUrl}/${relative}`;
+    }
+};
+LinksCampaignManagementAPIClient = __decorate([
+    (0, inversify_1.injectable)(),
+    __metadata("design:paramtypes", [String])
+], LinksCampaignManagementAPIClient);
+exports.LinksCampaignManagementAPIClient = LinksCampaignManagementAPIClient;
+//# sourceMappingURL=links-campaign-management-api.client.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"links-campaign-management-api.client.js","sourceRoot":"","sources":["../../src/links-campaign-management-api.client.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4BAA0B;AAM1B,yCAAuC;AAEvC,yCAAyC;AASlC,IAAM,gCAAgC,GAAtC,MAAM,gCAAgC;IAC5C,YACkB,OAAe;QAAf,YAAO,GAAP,OAAO,CAAQ;IAC7B,CAAC;IAEE,KAAK,CAAC,mBAAmB,CAC/B,YAA6B,EAC7B,aAA8B,EAC9B,aAA8B,EAC9B,MAAc,EAAE;QAEhB,MAAM,QAAQ,GAAG;YAChB,UAAU,EAAE,YAAY,CAAC,IAAI;YAC7B,QAAQ,EAAE,YAAY,CAAC,EAAE;YACzB,aAAa;YACb,aAAa;SACb,CAAC;QACF,sDAAsD;QACtD,MAAM,IAAI,GAAG,8BAA8B,CAAC;QAC5C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;QAC3D,IAAI,MAAM,CAAC,MAAM,KAAK,GAAG,EAAE;YAC1B,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;SACpD;IACF,CAAC;IAEO,KAAK,CAAC,WAAW,CAAC,WAAmB,EAAE,EAAE,IAAS,EAAE,GAAG,GAAG,EAAE;QACnE,OAAO,MAAM,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;aACvD,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC;aACvC,GAAG,CAAC,eAAe,EAAE,GAAG,CAAC;aACzB,IAAI,CAAC,IAAI,CAAC,CAAC;IACd,CAAC;IAGO,YAAY,CAAC,QAAgB;QACpC,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,QAAQ,EAAE,CAAC;IACtC,CAAC;CACD,CAAA;AApCY,gCAAgC;IAD5C,IAAA,sBAAU,GAAE;;GACA,gCAAgC,CAoC5C;AApCY,4EAAgC"}

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

@@ -41,12 +41,10 @@ let OrganisationsCampaignManagementAPIClient = class OrganisationsCampaignManage
         }
     }
     async postRequest(relative = "", data, jwt = "") {
-        const request = superagent.post(this.buildBaseUrl(relative))
-            .set("Content-Type", "application/json");
-        if (jwt && jwt.length > 0) {
-            request.set("Authorization", jwt);
-        }
-        return await request.send(data);
+        return await superagent.post(this.buildBaseUrl(relative))
+            .set("Content-Type", "application/json")
+            .set("Authorization", jwt)
+            .send(data);
     }
     async getRequest(relative = "", jwt = "") {
         return await superagent.get(this.buildBaseUrl(relative))

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

@@ -1 +1 @@
-{"version":3,"file":"organisations-campaign-management-api.client.js","sourceRoot":"","sources":["../../src/organisations-campaign-management-api.client.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4BAA0B;AAG1B,yCAAuC;AAEvC,yCAAyC;AAIlC,IAAM,wCAAwC,GAA9C,MAAM,wCAAwC;IACpD,YACkB,OAAe;QAAf,YAAO,GAAP,OAAO,CAAQ;IAC7B,CAAC;IAEE,KAAK,CAAC,sBAAsB,CAAC,cAAsB,EAAE,GAAG,GAAG,EAAE;QACnE,IAAI;YACH,MAAM,IAAI,GAAG,yBAAyB,cAAc,EAAE,CAAC;YACvD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;YAEhD,OAAO,MAAM,CAAC,IAA8B,CAAC;SAC7C;QAAC,OAAO,KAAK,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,iCAAiC,KAAK,EAAE,CAAC,CAAC;SAC1D;IACF,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAAC,UAAkB,EAAE,KAAK,GAAG,EAAE,EAAE,GAAG,GAAC,EAAE;QACtE,IAAI;YACH,MAAM,IAAI,GAAG,sBAAsB,CAAC;YACpC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE;gBAC3C,UAAU,EAAE,UAAU;gBACtB,KAAK,EAAE,KAAK;aACZ,EAAE,GAAG,CAAC,CAAC;YAER,OAAO,MAAM,CAAC,IAAgC,CAAC;SAC/C;QAAC,OAAO,KAAK,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,8BAA8B,KAAK,EAAE,CAAC,CAAC;SACvD;IACF,CAAC;IAEO,KAAK,CAAC,WAAW,CAAC,WAAmB,EAAE,EAAE,IAAS,EAAE,MAAc,EAAE;QAC3E,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;aAC1D,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAE1C,IAAG,GAAG,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE;YACzB,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC;SAClC;QAED,OAAO,MAAM,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAEO,KAAK,CAAC,UAAU,CAAC,WAAmB,EAAE,EAAE,GAAG,GAAG,EAAE;QACvD,OAAO,MAAM,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;aACtD,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC;aACvC,GAAG,CAAC,eAAe,EAAE,GAAG,CAAC;aACzB,IAAI,EAAE,CAAC;IACV,CAAC;IAGO,YAAY,CAAC,QAAgB;QACpC,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,QAAQ,EAAE,CAAC;IACtC,CAAC;CACD,CAAA;AApDY,wCAAwC;IADpD,IAAA,sBAAU,GAAE;;GACA,wCAAwC,CAoDpD;AApDY,4FAAwC"}
+{"version":3,"file":"organisations-campaign-management-api.client.js","sourceRoot":"","sources":["../../src/organisations-campaign-management-api.client.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4BAA0B;AAG1B,yCAAuC;AAEvC,yCAAyC;AAIlC,IAAM,wCAAwC,GAA9C,MAAM,wCAAwC;IACpD,YACkB,OAAe;QAAf,YAAO,GAAP,OAAO,CAAQ;IAC7B,CAAC;IAEE,KAAK,CAAC,sBAAsB,CAAC,cAAsB,EAAE,GAAG,GAAG,EAAE;QACnE,IAAI;YACH,MAAM,IAAI,GAAG,yBAAyB,cAAc,EAAE,CAAC;YACvD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;YAEhD,OAAO,MAAM,CAAC,IAA8B,CAAC;SAC7C;QAAC,OAAO,KAAK,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,iCAAiC,KAAK,EAAE,CAAC,CAAC;SAC1D;IACF,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAAC,UAAkB,EAAE,KAAK,GAAG,EAAE,EAAE,GAAG,GAAC,EAAE;QACtE,IAAI;YACH,MAAM,IAAI,GAAG,sBAAsB,CAAC;YACpC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE;gBAC3C,UAAU,EAAE,UAAU;gBACtB,KAAK,EAAE,KAAK;aACZ,EAAE,GAAG,CAAC,CAAC;YAER,OAAO,MAAM,CAAC,IAAgC,CAAC;SAC/C;QAAC,OAAO,KAAK,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,8BAA8B,KAAK,EAAE,CAAC,CAAC;SACvD;IACF,CAAC;IAEO,KAAK,CAAC,WAAW,CAAC,WAAmB,EAAE,EAAE,IAAS,EAAE,GAAG,GAAG,EAAE;QACnE,OAAO,MAAM,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;aACvD,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC;aACvC,GAAG,CAAC,eAAe,EAAE,GAAG,CAAC;aACzB,IAAI,CAAC,IAAI,CAAC,CAAC;IACd,CAAC;IAEO,KAAK,CAAC,UAAU,CAAC,WAAmB,EAAE,EAAE,GAAG,GAAG,EAAE;QACvD,OAAO,MAAM,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;aACtD,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC;aACvC,GAAG,CAAC,eAAe,EAAE,GAAG,CAAC;aACzB,IAAI,EAAE,CAAC;IACV,CAAC;IAGO,YAAY,CAAC,QAAgB;QACpC,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,QAAQ,EAAE,CAAC;IACtC,CAAC;CACD,CAAA;AAhDY,wCAAwC;IADpD,IAAA,sBAAU,GAAE;;GACA,wCAAwC,CAgDpD;AAhDY,4FAAwC"}