@studyportals/campaign-management-api-interface 16.0.0 → 16.1.0

package/index.d.ts

@@ -19,6 +19,7 @@ import { SuperAgentResponseCover } from "./src/domain/types/super-agent-response
 import { ProductsCampaignManagementAPIClient } from "./src/products-campaign-management-api.client";
 import { PublicStatusClient } from "./src/public-status-client";
 import { CampaignEditorFrontendStatusDto, StatusHealthy, StatusBlocked } from "./src/domain/types/campaign-editor-frontend-status.dto";
+import { PrivateUserCampaignManagementAPIClient } from "./src/private-user-campaign-management-api.client";
 export * from "./src/domain/campaign";
 export * from "./src/domain/users";
 export * from "./src/validation";
@@ -26,4 +27,4 @@ export * from "./src/domain/organisations";
 export * from "./src/domain/products";
 export * from "./src/domain/degrees";
 export * from "./src/campaign-saving";
-export { AuditorCampaignManagementAPIClient, OrganisationsCampaignManagementAPIClient, CampaignManagementAPIClient, PrivateCampaignManagementAPIClient, UserCampaignManagementAPIClient, StudyCampaignManagementAPIClient, LinksCampaignManagementAPIClient, ProductsCampaignManagementAPIClient, PublicStatusClient, AuditorEntityType, AuditorOperation, LinkType, LinkEntityType, SwappingEnabledLinkTypes, GetAuditorDto, PersistGoogleLinkerResultDto, CampaignsEntitiesConfigDto, MinimalOrganisationDto, CampaignEditorFrontendStatusDto, StatusHealthy, StatusBlocked, NumberMap, Pricing, ICampaignAuditorData, SuperAgentResponseCover };
+export { AuditorCampaignManagementAPIClient, OrganisationsCampaignManagementAPIClient, CampaignManagementAPIClient, PrivateCampaignManagementAPIClient, PrivateUserCampaignManagementAPIClient, UserCampaignManagementAPIClient, StudyCampaignManagementAPIClient, LinksCampaignManagementAPIClient, ProductsCampaignManagementAPIClient, PublicStatusClient, AuditorEntityType, AuditorOperation, LinkType, LinkEntityType, SwappingEnabledLinkTypes, GetAuditorDto, PersistGoogleLinkerResultDto, CampaignsEntitiesConfigDto, MinimalOrganisationDto, CampaignEditorFrontendStatusDto, StatusHealthy, StatusBlocked, NumberMap, Pricing, ICampaignAuditorData, SuperAgentResponseCover };

package/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Pricing = exports.MinimalOrganisationDto = exports.CampaignsEntitiesConfigDto = exports.PersistGoogleLinkerResultDto = exports.GetAuditorDto = exports.SwappingEnabledLinkTypes = exports.LinkEntityType = exports.LinkType = exports.AuditorOperation = exports.AuditorEntityType = exports.PublicStatusClient = exports.ProductsCampaignManagementAPIClient = exports.LinksCampaignManagementAPIClient = exports.StudyCampaignManagementAPIClient = exports.UserCampaignManagementAPIClient = exports.PrivateCampaignManagementAPIClient = exports.CampaignManagementAPIClient = exports.OrganisationsCampaignManagementAPIClient = exports.AuditorCampaignManagementAPIClient = void 0;
+exports.Pricing = exports.MinimalOrganisationDto = exports.CampaignsEntitiesConfigDto = exports.PersistGoogleLinkerResultDto = exports.GetAuditorDto = exports.SwappingEnabledLinkTypes = exports.LinkEntityType = exports.LinkType = exports.AuditorOperation = exports.AuditorEntityType = exports.PublicStatusClient = exports.ProductsCampaignManagementAPIClient = exports.LinksCampaignManagementAPIClient = exports.StudyCampaignManagementAPIClient = exports.UserCampaignManagementAPIClient = exports.PrivateUserCampaignManagementAPIClient = exports.PrivateCampaignManagementAPIClient = exports.CampaignManagementAPIClient = exports.OrganisationsCampaignManagementAPIClient = 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 organisations_campaign_management_api_client_1 = require("./src/organisations-campaign-management-api.client");
@@ -53,6 +53,8 @@ const products_campaign_management_api_client_1 = require("./src/products-campai
 Object.defineProperty(exports, "ProductsCampaignManagementAPIClient", { enumerable: true, get: function () { return products_campaign_management_api_client_1.ProductsCampaignManagementAPIClient; } });
 const public_status_client_1 = require("./src/public-status-client");
 Object.defineProperty(exports, "PublicStatusClient", { enumerable: true, get: function () { return public_status_client_1.PublicStatusClient; } });
+const private_user_campaign_management_api_client_1 = require("./src/private-user-campaign-management-api.client");
+Object.defineProperty(exports, "PrivateUserCampaignManagementAPIClient", { enumerable: true, get: function () { return private_user_campaign_management_api_client_1.PrivateUserCampaignManagementAPIClient; } });
 __exportStar(require("./src/domain/campaign"), exports);
 __exportStar(require("./src/domain/users"), exports);
 __exportStar(require("./src/validation"), exports);

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,yGAAkG;AAgCjG,mHAhCQ,2EAAkC,OAgCR;AA/BnC,qHAA8G;AAgC7G,yHAhCQ,uFAAwC,OAgCR;AA/BzC,yFAAmF;AAgClF,4GAhCQ,4DAA2B,OAgCR;AA/B5B,kGAAwF;AAwCvF,kGAxCQ,4CAAiB,OAwCR;AAvClB,8FAAqF;AAwCpF,iGAxCQ,yCAAgB,OAwCR;AAvCjB,0EAAqE;AA6CpE,8FA7CQ,+BAAa,OA6CR;AA5Cd,qGAAgG;AAgD/F,2GAhDQ,yDAA0B,OAgDR;AA/C3B,gGAAgH;AA0D/G,wFA1DmB,+BAAO,OA0DnB;AAzDR,yGAAkG;AA2BjG,mHA3BQ,2EAAkC,OA2BR;AA1BnC,mGAA4F;AA2B3F,gHA3BQ,qEAA+B,OA2BR;AA1BhC,qGAA8F;AA2B7F,iHA3BQ,uEAAgC,OA2BR;AA1BjC,oGAA8F;AA8C7F,uGA9CQ,kDAAsB,OA8CR;AA7CvB,8EAAqE;AAiCpE,yFAjCQ,yBAAQ,OAiCR;AAhCT,6GAAsG;AAsCrG,6GAtCQ,+DAA4B,OAsCR;AArC7B,oFAA0E;AAgCzE,+FAhCQ,sCAAc,OAgCR;AA/Bf,qGAA8F;AAuB7F,iHAvBQ,uEAAgC,OAuBR;AAtBjC,0GAA+F;AA+B9F,yGA/BQ,2DAAwB,OA+BR;AA7BzB,2GAAoG;AAqBnG,oHArBQ,6EAAmC,OAqBR;AApBpC,qEAAgE;AAqB/D,mGArBQ,yCAAkB,OAqBR;AAlBnB,wDAAsC;AACtC,qDAAmC;AACnC,mDAAiC;AACjC,6DAA2C;AAC3C,wDAAsC;AACtC,uDAAqC;AACrC,wDAAsC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,yGAAkG;AAiCjG,mHAjCQ,2EAAkC,OAiCR;AAhCnC,qHAA8G;AAiC7G,yHAjCQ,uFAAwC,OAiCR;AAhCzC,yFAAmF;AAiClF,4GAjCQ,4DAA2B,OAiCR;AAhC5B,kGAAwF;AA0CvF,kGA1CQ,4CAAiB,OA0CR;AAzClB,8FAAqF;AA0CpF,iGA1CQ,yCAAgB,OA0CR;AAzCjB,0EAAqE;AA+CpE,8FA/CQ,+BAAa,OA+CR;AA9Cd,qGAAgG;AAkD/F,2GAlDQ,yDAA0B,OAkDR;AAjD3B,gGAAgH;AA4D/G,wFA5DmB,+BAAO,OA4DnB;AA3DR,yGAAkG;AA4BjG,mHA5BQ,2EAAkC,OA4BR;AA3BnC,mGAA4F;AA6B3F,gHA7BQ,qEAA+B,OA6BR;AA5BhC,qGAA8F;AA6B7F,iHA7BQ,uEAAgC,OA6BR;AA5BjC,oGAA8F;AAgD7F,uGAhDQ,kDAAsB,OAgDR;AA/CvB,8EAAqE;AAmCpE,yFAnCQ,yBAAQ,OAmCR;AAlCT,6GAAsG;AAwCrG,6GAxCQ,+DAA4B,OAwCR;AAvC7B,oFAA0E;AAkCzE,+FAlCQ,sCAAc,OAkCR;AAjCf,qGAA8F;AAyB7F,iHAzBQ,uEAAgC,OAyBR;AAxBjC,0GAA+F;AAiC9F,yGAjCQ,2DAAwB,OAiCR;AA/BzB,2GAAoG;AAuBnG,oHAvBQ,6EAAmC,OAuBR;AAtBpC,qEAAgE;AAuB/D,mGAvBQ,yCAAkB,OAuBR;AArBnB,mHAA2G;AAgB1G,uHAhBQ,oFAAsC,OAgBR;AAdvC,wDAAsC;AACtC,qDAAmC;AACnC,mDAAiC;AACjC,6DAA2C;AAC3C,wDAAsC;AACtC,uDAAqC;AACrC,wDAAsC"}

package/package.json

@@ -1,49 +1,49 @@
-{
-	"name": "@studyportals/campaign-management-api-interface",
-	"version": "16.0.0",
-	"scripts": {
-		"compile": "rm -fR bin && npx tsc",
-		"test-u": "jest -c jest.config.unit.json --maxWorkers=1",
-		"test-i": "nyc mocha src tests-i",
-		"prepare-deployment": "npm run test-u && npm run compile && cp package.json bin/package.json && rm -fR bin/tests-u",
-		"predeploy": "npm run prepare-deployment",
-		"deploy": "npm publish ./bin --access=public",
-		"deploy-patch": "npm version patch && npm run deploy",
-		"deploy-minor": "npm version minor && npm run deploy",
-		"deploy-major": "npm version major && npm run deploy",
-		"deploy-beta": "npm version prerelease && npm run deploy -- --tag beta"
-	},
-	"author": "SPNightsWatch",
-	"license": "ISC",
-	"types": "bin/index.d.ts",
-	"devDependencies": {
-		"@studyportals/code-style": "^2.2.1",
-		"@testdeck/jest": "^0.3.3",
-		"@types/chai": "^4.3.4",
-		"@types/jest": "^29.4.0",
-		"@types/node": "^22.18.0",
-		"@types/superagent": "^8.1.9",
-		"chai": "^4.3.4",
-		"eslint": "^8.33.0",
-		"jest": "^29.4.2",
-		"jest-mock-extended": "^3.0.1",
-		"superagent": "^8.1.2",
-		"superagent-mocker": "^0.5.2",
-		"ts-jest": "^29.0.5",
-		"ts-node": "^10.9.2",
-		"typescript": "^5.5.4"
-	},
-	"dependencies": {
-		"@studyportals/mb-platform-date-time": "^1.3.1",
-		"@studyportals/mb-platform-http-requests": "^2.8.0",
-		"@studyportals/university-scheduler-interface": "^0.7.0",
-		"class-transformer": "^0.5.1",
-		"class-validator": "^0.14.1",
-		"inversify": "^6.0.1",
-		"reflect-metadata": "^0.1.13"
-	},
-	"engines": {
-		"node": ">=18 <=22",
-		"npm ": "10.x"
-	}
-}
+{
+	"name": "@studyportals/campaign-management-api-interface",
+	"version": "16.1.0",
+	"scripts": {
+		"compile": "rm -fR bin && npx tsc",
+		"test-u": "jest -c jest.config.unit.json --maxWorkers=1",
+		"test-i": "nyc mocha src tests-i",
+		"prepare-deployment": "npm run test-u && npm run compile && cp package.json bin/package.json && rm -fR bin/tests-u",
+		"predeploy": "npm run prepare-deployment",
+		"deploy": "npm publish ./bin --access=public",
+		"deploy-patch": "npm version patch && npm run deploy",
+		"deploy-minor": "npm version minor && npm run deploy",
+		"deploy-major": "npm version major && npm run deploy",
+		"deploy-beta": "npm version prerelease && npm run deploy -- --tag beta"
+	},
+	"author": "SPNightsWatch",
+	"license": "ISC",
+	"types": "bin/index.d.ts",
+	"devDependencies": {
+		"@studyportals/code-style": "^2.2.1",
+		"@testdeck/jest": "^0.3.3",
+		"@types/chai": "^4.3.4",
+		"@types/jest": "^29.4.0",
+		"@types/node": "^22.18.0",
+		"@types/superagent": "^8.1.9",
+		"chai": "^4.3.4",
+		"eslint": "^8.33.0",
+		"jest": "^29.4.2",
+		"jest-mock-extended": "^3.0.1",
+		"superagent": "^8.1.2",
+		"superagent-mocker": "^0.5.2",
+		"ts-jest": "^29.0.5",
+		"ts-node": "^10.9.2",
+		"typescript": "^5.5.4"
+	},
+	"dependencies": {
+		"@studyportals/mb-platform-date-time": "^1.3.1",
+		"@studyportals/mb-platform-http-requests": "^2.8.0",
+		"@studyportals/university-scheduler-interface": "^0.7.0",
+		"class-transformer": "^0.5.1",
+		"class-validator": "^0.14.1",
+		"inversify": "^6.0.1",
+		"reflect-metadata": "^0.1.13"
+	},
+	"engines": {
+		"node": ">=18 <=22",
+		"npm ": "10.x"
+	}
+}

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

@@ -0,0 +1,18 @@
+import "reflect-metadata";
+import { ISuperAgentRequestFactory, SignedRequestSender } from "@studyportals/mb-platform-http-requests";
+import { CreateClientDto, UserDto } from "./domain/users";
+export declare class PrivateUserCampaignManagementAPIClient {
+    private readonly superAgentRequestFactory;
+    private readonly requestSender;
+    private readonly baseUrl;
+    constructor(superAgentRequestFactory: ISuperAgentRequestFactory, requestSender: SignedRequestSender, baseUrl: string);
+    getUserById(id: number): Promise<UserDto>;
+    getUserByEmail(email: string): Promise<UserDto>;
+    createClient(user: CreateClientDto): Promise<number>;
+    private getRequest;
+    private createGetRequest;
+    private postRequest;
+    private createPostRequest;
+    private sendRequest;
+    private buildBaseUrl;
+}

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

@@ -0,0 +1,64 @@
+"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.PrivateUserCampaignManagementAPIClient = void 0;
+require("reflect-metadata");
+const inversify_1 = require("inversify");
+const mb_platform_http_requests_1 = require("@studyportals/mb-platform-http-requests");
+let PrivateUserCampaignManagementAPIClient = class PrivateUserCampaignManagementAPIClient {
+    constructor(superAgentRequestFactory, requestSender, baseUrl) {
+        this.superAgentRequestFactory = superAgentRequestFactory;
+        this.requestSender = requestSender;
+        this.baseUrl = baseUrl;
+    }
+    async getUserById(id) {
+        const path = `private/users/get-user-by-id?id=${id}`;
+        return await this.getRequest(path);
+    }
+    async getUserByEmail(email) {
+        const path = `private/users/get-user-by-email?email=${encodeURIComponent(email)}`;
+        return await this.getRequest(path);
+    }
+    async createClient(user) {
+        const path = 'private/users/create-client';
+        const result = await this.postRequest(path, user);
+        return Number(result.text);
+    }
+    async getRequest(relative = "") {
+        const request = this.createGetRequest(relative);
+        return await this.requestSender.sendAndExtractBody(request);
+    }
+    createGetRequest(relative = "") {
+        const url = this.buildBaseUrl(relative);
+        return this.superAgentRequestFactory.get(url);
+    }
+    async postRequest(relative = "", data) {
+        const request = this.createPostRequest(relative);
+        return await this.sendRequest(request, data);
+    }
+    createPostRequest(relative = "") {
+        const url = this.buildBaseUrl(relative);
+        return this.superAgentRequestFactory.post(url);
+    }
+    async sendRequest(request, payload) {
+        request.send(payload);
+        return await this.requestSender.send(request);
+    }
+    buildBaseUrl(relative) {
+        return `${this.baseUrl}/${relative}`;
+    }
+};
+exports.PrivateUserCampaignManagementAPIClient = PrivateUserCampaignManagementAPIClient;
+exports.PrivateUserCampaignManagementAPIClient = PrivateUserCampaignManagementAPIClient = __decorate([
+    (0, inversify_1.injectable)(),
+    __metadata("design:paramtypes", [Object, mb_platform_http_requests_1.SignedRequestSender, String])
+], PrivateUserCampaignManagementAPIClient);
+//# sourceMappingURL=private-user-campaign-management-api.client.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"private-user-campaign-management-api.client.js","sourceRoot":"","sources":["../../src/private-user-campaign-management-api.client.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4BAA0B;AAG1B,yCAAuC;AACvC,uFAAyG;AAIlG,IAAM,sCAAsC,GAA5C,MAAM,sCAAsC;IAElD,YACkB,wBAAmD,EACnD,aAAkC,EAClC,OAAe;QAFf,6BAAwB,GAAxB,wBAAwB,CAA2B;QACnD,kBAAa,GAAb,aAAa,CAAqB;QAClC,YAAO,GAAP,OAAO,CAAQ;IAC7B,CAAC;IAEE,KAAK,CAAC,WAAW,CAAC,EAAU;QAClC,MAAM,IAAI,GAAG,mCAAmC,EAAE,EAAE,CAAC;QACrD,OAAO,MAAM,IAAI,CAAC,UAAU,CAAU,IAAI,CAAC,CAAC;IAC7C,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,KAAa;QACxC,MAAM,IAAI,GAAG,yCAAyC,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAC;QAClF,OAAO,MAAM,IAAI,CAAC,UAAU,CAAU,IAAI,CAAC,CAAC;IAC7C,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,IAAqB;QAC9C,MAAM,IAAI,GAAG,6BAA6B,CAAC;QAC3C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAClD,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAGO,KAAK,CAAC,UAAU,CAAI,WAAmB,EAAE;QAChD,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QAChD,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAI,OAAO,CAAC,CAAC;IAChE,CAAC;IAEO,gBAAgB,CAAC,WAAmB,EAAE;QAC7C,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC/C,CAAC;IAEO,KAAK,CAAC,WAAW,CAAC,WAAmB,EAAE,EAAE,IAAS;QACzD,MAAM,OAAO,GAAG,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QACjD,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAC9C,CAAC;IAEO,iBAAiB,CAAC,WAAmB,EAAE;QAC9C,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAChD,CAAC;IAEO,KAAK,CAAC,WAAW,CAAC,OAA0B,EAAE,OAAY;QACjE,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACtB,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/C,CAAC;IAEO,YAAY,CAAC,QAAgB;QACpC,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,QAAQ,EAAE,CAAC;IACtC,CAAC;CACD,CAAA;AArDY,wFAAsC;iDAAtC,sCAAsC;IADlD,IAAA,sBAAU,GAAE;6CAKqB,+CAAmB;GAJxC,sCAAsC,CAqDlD"}