@studyportals/campaign-management-api-interface 2.5.1-beta.0 → 3.0.1-0

package/index.d.ts

@@ -17,4 +17,5 @@ import { LinksCampaignManagementAPIClient } from './src/links-campaign-managemen
 import { SwappingEnabledLinkTypes } from "./src/domain/links/swapping-enabled-link-types.enum";
 export * from "./src/domain/campaign";
 export * from "./src/domain/users";
+export * from "./src/validation";
 export { AuditorCampaignManagementAPIClient, OrganisationsCampaignManagementAPIClient, CampaignManagementAPIClient, PrivateCampaignManagementAPIClient, UserCampaignManagementAPIClient, StudyCampaignManagementAPIClient, LinksCampaignManagementAPIClient, AuditorEntityType, AuditorOperation, LinkType, LinkEntityType, SwappingEnabledLinkTypes, GetAuditorDto, PersistGoogleLinkerResultDto, CampaignsEntitiesConfigDto, MinimalOrganisationDto, NumberMap, Pricing, ICampaignAuditorData };

package/index.js

@@ -51,4 +51,5 @@ const swapping_enabled_link_types_enum_1 = require("./src/domain/links/swapping-
 Object.defineProperty(exports, "SwappingEnabledLinkTypes", { enumerable: true, get: function () { return swapping_enabled_link_types_enum_1.SwappingEnabledLinkTypes; } });
 __exportStar(require("./src/domain/campaign"), exports);
 __exportStar(require("./src/domain/users"), exports);
+__exportStar(require("./src/validation"), exports);
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,yGAAkG;AAuBjG,mHAvBQ,2EAAkC,OAuBR;AAtBnC,qHAA8G;AAuB7G,yHAvBQ,uFAAwC,OAuBR;AAtBzC,yFAAmF;AAuBlF,4GAvBQ,4DAA2B,OAuBR;AAtB5B,kGAAwF;AA6BvF,kGA7BQ,4CAAiB,OA6BR;AA5BlB,8FAAqF;AA6BpF,iGA7BQ,yCAAgB,OA6BR;AA5BjB,0EAAqE;AAkCpE,8FAlCQ,+BAAa,OAkCR;AAjCd,qGAAgG;AAqC/F,2GArCQ,yDAA0B,OAqCR;AApC3B,gGAAgH;AA0C/G,wFA1CmB,+BAAO,OA0CnB;AAzCR,yGAAkG;AAkBjG,mHAlBQ,2EAAkC,OAkBR;AAjBnC,mGAA4F;AAkB3F,gHAlBQ,qEAA+B,OAkBR;AAjBhC,qGAA8F;AAkB7F,iHAlBQ,uEAAgC,OAkBR;AAjBjC,oGAA8F;AAmC7F,uGAnCQ,kDAAsB,OAmCR;AAlCvB,8EAAqE;AAsBpE,yFAtBQ,yBAAQ,OAsBR;AArBT,6GAAsG;AA2BrG,6GA3BQ,+DAA4B,OA2BR;AA1B7B,oFAA0E;AAqBzE,+FArBQ,sCAAc,OAqBR;AApBf,qGAA8F;AAc7F,iHAdQ,uEAAgC,OAcR;AAbjC,0GAA+F;AAoB9F,yGApBQ,2DAAwB,OAoBR;AAlBzB,wDAAsC;AACtC,qDAAmC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,yGAAkG;AAwBjG,mHAxBQ,2EAAkC,OAwBR;AAvBnC,qHAA8G;AAwB7G,yHAxBQ,uFAAwC,OAwBR;AAvBzC,yFAAmF;AAwBlF,4GAxBQ,4DAA2B,OAwBR;AAvB5B,kGAAwF;AA8BvF,kGA9BQ,4CAAiB,OA8BR;AA7BlB,8FAAqF;AA8BpF,iGA9BQ,yCAAgB,OA8BR;AA7BjB,0EAAqE;AAmCpE,8FAnCQ,+BAAa,OAmCR;AAlCd,qGAAgG;AAsC/F,2GAtCQ,yDAA0B,OAsCR;AArC3B,gGAAgH;AA2C/G,wFA3CmB,+BAAO,OA2CnB;AA1CR,yGAAkG;AAmBjG,mHAnBQ,2EAAkC,OAmBR;AAlBnC,mGAA4F;AAmB3F,gHAnBQ,qEAA+B,OAmBR;AAlBhC,qGAA8F;AAmB7F,iHAnBQ,uEAAgC,OAmBR;AAlBjC,oGAA8F;AAoC7F,uGApCQ,kDAAsB,OAoCR;AAnCvB,8EAAqE;AAuBpE,yFAvBQ,yBAAQ,OAuBR;AAtBT,6GAAsG;AA4BrG,6GA5BQ,+DAA4B,OA4BR;AA3B7B,oFAA0E;AAsBzE,+FAtBQ,sCAAc,OAsBR;AArBf,qGAA8F;AAe7F,iHAfQ,uEAAgC,OAeR;AAdjC,0GAA+F;AAqB9F,yGArBQ,2DAAwB,OAqBR;AAnBzB,wDAAsC;AACtC,qDAAmC;AACnC,mDAAiC"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@studyportals/campaign-management-api-interface",
-	"version": "2.5.1-beta.0",
+	"version": "3.0.1-0",
 	"scripts": {
 		"compile": "rm -fR bin && npx tsc",
 		"test-u": "jest -c jest.config.unit.json --maxWorkers=1",
@@ -30,8 +30,7 @@
 	},
 	"dependencies": {
 		"@studyportals/mb-platform-date-time": "^1.3.0",
-		"@studyportals/mb-platform-http-requests": "^2.7.1-beta.1",
-		"@studyportals/university-scheduler-interface": "^0.7.1-beta.0",
+		"@studyportals/mb-platform-http-requests": "^2.1.1",
 		"@types/chai": "^4.3.4",
 		"@types/jest": "^29.4.0",
 		"@types/node": "^16.9.4",

package/src/domain/campaign/campaign-editor-get-result.dto.d.ts

@@ -7,21 +7,20 @@ import { PartnershipType } from "./partnership-type.enum";
 export type CampaignEditorGetResultDto = {
     id: number;
     name: string;
-    startDate: Date | null;
-    endDate: Date | null;
-    partnershipType: PartnershipType | null;
+    startDate: Date;
+    endDate: Date;
+    partnershipType: PartnershipType;
     deliveryMode: DeliveryMode;
     campaignType: CampaignType;
-    currency: Currency | null;
-    budget: number | null;
-    isUncapped: boolean;
+    currency: Currency;
+    budget: number;
     isExcludedFromCampaignLift: boolean;
     tableauReportingEnabled: boolean;
     liveReportingEnabled: boolean;
     automaticReportingDisabled: boolean;
-    clientServicesPerson: number | null;
-    accountManager: number | null;
-    crmId: number | null;
+    clientServicesPerson: number;
+    accountManager: number;
+    crmId: number;
     region: Region;
     linkedOrganisations: MinimalOrganisationDto[];
 };

package/src/validation/campaign/mandatory-fields-validator.d.ts

@@ -0,0 +1,15 @@
+import { SpecificResult } from "../types/SpecificResult";
+import { ValidationResult } from "../types/ValidationResult";
+type DataType = Record<string, any>;
+export declare class CampaignMandatoryFieldsValidator {
+    static validate(data: unknown): ValidationResult;
+    static checkName(data: DataType): SpecificResult;
+    static checkDate(data: DataType, propertyName: string): SpecificResult;
+    static checkPartnershipType(data: DataType): SpecificResult;
+    static checkDeliveryMode(data: DataType): SpecificResult;
+    static checkCampaignType(data: DataType): SpecificResult;
+    static checkCurrency(data: DataType): SpecificResult;
+    static checkNumber(data: DataType, propertyName: string): SpecificResult;
+    static checkRegion(data: DataType): SpecificResult;
+}
+export {};

package/src/validation/campaign/mandatory-fields-validator.js

@@ -0,0 +1,126 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CampaignMandatoryFieldsValidator = void 0;
+const campaign_1 = require("../../domain/campaign");
+class CampaignMandatoryFieldsValidator {
+    static validate(data) {
+        const result = {
+            missing: [],
+            invalid: [],
+            valid: []
+        };
+        if (typeof data !== 'object' || data === null) {
+            result.missing.push('data');
+            return result;
+        }
+        result[this.checkName(data)].push('name');
+        result[this.checkDate(data, 'startDate')].push('startDate');
+        result[this.checkDate(data, 'endDate')].push('endDate');
+        result[this.checkPartnershipType(data)].push('partnershipType');
+        result[this.checkDeliveryMode(data)].push('deliveryMode');
+        result[this.checkCampaignType(data)].push('campaignType');
+        result[this.checkCurrency(data)].push('currency');
+        result[this.checkNumber(data, 'budget')].push('budget');
+        result[this.checkNumber(data, 'clientServicesPerson')].push('clientServicesPerson');
+        result[this.checkNumber(data, 'accountManager')].push('accountManager');
+        result[this.checkNumber(data, 'crmId')].push('crmId');
+        result[this.checkRegion(data)].push('region');
+        return result;
+    }
+    static checkName(data) {
+        if (!data.name) {
+            return 'missing';
+        }
+        if (typeof data.name === 'string') {
+            if (data.name.length === 0) {
+                return 'missing';
+            }
+            return 'valid';
+        }
+        return 'invalid';
+    }
+    static checkDate(data, propertyName) {
+        if (!data[propertyName]) {
+            return 'missing';
+        }
+        if (data[propertyName] instanceof Date) {
+            return 'valid';
+        }
+        return 'invalid';
+    }
+    static checkPartnershipType(data) {
+        if (!data.partnershipType) {
+            return 'invalid';
+        }
+        for (const value of Object.values(campaign_1.PartnershipType)) {
+            if (value === data.partnershipType) {
+                return 'valid';
+            }
+        }
+        return 'invalid';
+    }
+    static checkDeliveryMode(data) {
+        if (!data.deliveryMode) {
+            return 'missing';
+        }
+        const deliveryMode = data.deliveryMode;
+        switch (deliveryMode.type) {
+            case campaign_1.DeliveryType.EVENLY: {
+                return 'valid';
+            }
+            case campaign_1.DeliveryType.CUSTOM_OVERPERFORMANCE: {
+                if (typeof deliveryMode.overperformanceLimit === 'number' && deliveryMode.overperformanceLimit >= 0) {
+                    return 'valid';
+                }
+                return 'invalid';
+            }
+            default: {
+                return 'invalid';
+            }
+        }
+    }
+    static checkCampaignType(data) {
+        if (!data.campaignType) {
+            return 'missing';
+        }
+        for (const value of Object.values(campaign_1.CampaignType)) {
+            if (value === data.campaignType) {
+                return 'valid';
+            }
+        }
+        return 'invalid';
+    }
+    static checkCurrency(data) {
+        if (!data.currency) {
+            return 'missing';
+        }
+        for (const value of Object.values(campaign_1.Currency)) {
+            if (value === data.currency) {
+                return 'valid';
+            }
+        }
+        return 'invalid';
+    }
+    static checkNumber(data, propertyName) {
+        if (!data[propertyName]) {
+            return 'missing';
+        }
+        if (typeof data[propertyName] === 'number' && data[propertyName] >= 0) {
+            return 'valid';
+        }
+        return 'invalid';
+    }
+    static checkRegion(data) {
+        if (!data.region) {
+            return 'missing';
+        }
+        for (const value of Object.values(campaign_1.Region)) {
+            if (value === data.region) {
+                return 'valid';
+            }
+        }
+        return 'invalid';
+    }
+}
+exports.CampaignMandatoryFieldsValidator = CampaignMandatoryFieldsValidator;
+//# sourceMappingURL=mandatory-fields-validator.js.map

package/src/validation/campaign/mandatory-fields-validator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mandatory-fields-validator.js","sourceRoot":"","sources":["../../../../src/validation/campaign/mandatory-fields-validator.ts"],"names":[],"mappings":";;;AAAA,oDAAoH;AAOpH,MAAa,gCAAgC;IAErC,MAAM,CAAC,QAAQ,CAAC,IAAa;QACnC,MAAM,MAAM,GAAqB;YAChC,OAAO,EAAE,EAAE;YACX,OAAO,EAAE,EAAE;YACX,KAAK,EAAE,EAAE;SACT,CAAC;QAEF,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,EAAE;YAC9C,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC5B,OAAO,MAAM,CAAC;SACd;QAED,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC1C,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC5D,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACxD,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAChE,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC1D,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC1D,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAClD,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACxD,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,sBAAsB,CAAC,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;QACpF,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACxE,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACtD,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAE9C,OAAO,MAAM,CAAC;IACf,CAAC;IAEM,MAAM,CAAC,SAAS,CAAC,IAAc;QACrC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;YACf,OAAO,SAAS,CAAC;SACjB;QACD,IAAI,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE;YAClC,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC3B,OAAO,SAAS,CAAC;aACjB;YACD,OAAO,OAAO,CAAC;SACf;QACD,OAAO,SAAS,CAAC;IAClB,CAAC;IAEM,MAAM,CAAC,SAAS,CAAC,IAAc,EAAE,YAAoB;QAC3D,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE;YACxB,OAAO,SAAS,CAAC;SACjB;QACD,IAAI,IAAI,CAAC,YAAY,CAAC,YAAY,IAAI,EAAE;YACvC,OAAO,OAAO,CAAC;SACf;QACD,OAAO,SAAS,CAAC;IAClB,CAAC;IAEM,MAAM,CAAC,oBAAoB,CAAC,IAAc;QAChD,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE;YAC1B,OAAO,SAAS,CAAC;SACjB;QACD,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,0BAAe,CAAC,EAAE;YACnD,IAAI,KAAK,KAAK,IAAI,CAAC,eAAe,EAAE;gBACnC,OAAO,OAAO,CAAC;aACf;SACD;QACD,OAAO,SAAS,CAAC;IAClB,CAAC;IAEM,MAAM,CAAC,iBAAiB,CAAC,IAAc;QAC7C,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;YACvB,OAAO,SAAS,CAAC;SACjB;QACD,MAAM,YAAY,GAAG,IAAI,CAAC,YAA4B,CAAC;QAEvD,QAAQ,YAAY,CAAC,IAAI,EAAE;YAC1B,KAAK,uBAAY,CAAC,MAAM,CAAC,CAAC;gBACzB,OAAO,OAAO,CAAC;aACf;YACD,KAAK,uBAAY,CAAC,sBAAsB,CAAC,CAAC;gBACzC,IAAI,OAAO,YAAY,CAAC,oBAAoB,KAAK,QAAQ,IAAI,YAAY,CAAC,oBAAoB,IAAI,CAAC,EAAE;oBACpG,OAAO,OAAO,CAAC;iBACf;gBACD,OAAO,SAAS,CAAC;aACjB;YACD,OAAO,CAAC,CAAC;gBACR,OAAO,SAAS,CAAC;aACjB;SACD;IACF,CAAC;IAEM,MAAM,CAAC,iBAAiB,CAAC,IAAc;QAC7C,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;YACvB,OAAO,SAAS,CAAC;SACjB;QACD,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,uBAAY,CAAC,EAAE;YAChD,IAAI,KAAK,KAAK,IAAI,CAAC,YAAY,EAAE;gBAChC,OAAO,OAAO,CAAC;aACf;SACD;QACD,OAAO,SAAS,CAAC;IAClB,CAAC;IAEM,MAAM,CAAC,aAAa,CAAC,IAAc;QACzC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YACnB,OAAO,SAAS,CAAC;SACjB;QACD,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,mBAAQ,CAAC,EAAE;YAC5C,IAAI,KAAK,KAAK,IAAI,CAAC,QAAQ,EAAE;gBAC5B,OAAO,OAAO,CAAC;aACf;SACD;QACD,OAAO,SAAS,CAAC;IAClB,CAAC;IAEM,MAAM,CAAC,WAAW,CAAC,IAAc,EAAE,YAAoB;QAC7D,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE;YACxB,OAAO,SAAS,CAAC;SACjB;QACD,IAAI,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,QAAQ,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE;YACtE,OAAO,OAAO,CAAC;SACf;QACD,OAAO,SAAS,CAAC;IAClB,CAAC;IAEM,MAAM,CAAC,WAAW,CAAC,IAAc;QACvC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YACjB,OAAO,SAAS,CAAC;SACjB;QACD,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,iBAAM,CAAC,EAAE;YAC1C,IAAI,KAAK,KAAK,IAAI,CAAC,MAAM,EAAE;gBAC1B,OAAO,OAAO,CAAC;aACf;SACD;QACD,OAAO,SAAS,CAAC;IAClB,CAAC;CAED;AArID,4EAqIC"}

package/src/validation/index.d.ts

@@ -0,0 +1,4 @@
+import { CampaignMandatoryFieldsValidator } from "./campaign/mandatory-fields-validator";
+import { SpecificResult } from "./types/SpecificResult";
+import { ValidationResult } from "./types/ValidationResult";
+export { ValidationResult, SpecificResult, CampaignMandatoryFieldsValidator };

package/src/validation/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CampaignMandatoryFieldsValidator = void 0;
+const mandatory_fields_validator_1 = require("./campaign/mandatory-fields-validator");
+Object.defineProperty(exports, "CampaignMandatoryFieldsValidator", { enumerable: true, get: function () { return mandatory_fields_validator_1.CampaignMandatoryFieldsValidator; } });
+//# sourceMappingURL=index.js.map

package/src/validation/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/validation/index.ts"],"names":[],"mappings":";;;AAAA,sFAAyF;AAOxF,iHAPQ,6DAAgC,OAOR"}

package/src/validation/types/SpecificResult.d.ts

@@ -0,0 +1 @@
+export type SpecificResult = 'missing' | 'invalid' | 'valid';

package/src/validation/types/SpecificResult.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=SpecificResult.js.map

package/src/validation/types/SpecificResult.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SpecificResult.js","sourceRoot":"","sources":["../../../../src/validation/types/SpecificResult.ts"],"names":[],"mappings":""}

package/src/validation/types/ValidationResult.d.ts

@@ -0,0 +1,5 @@
+export type ValidationResult = {
+    missing: string[];
+    invalid: string[];
+    valid: string[];
+};

package/src/validation/types/ValidationResult.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ValidationResult.js.map

package/src/validation/types/ValidationResult.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ValidationResult.js","sourceRoot":"","sources":["../../../../src/validation/types/ValidationResult.ts"],"names":[],"mappings":""}