@studyportals/campaign-management-api-interface 7.0.1-0 → 7.0.1-1

package/package.json

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

package/src/validation/campaign/campaign-lift-excluded-field-validator.d.ts

@@ -0,0 +1,22 @@
+import { PartnershipType } from "../../domain/campaign";
+export declare const USERS_ALLOWED_EDITING_CAMPAIGN_LIFT: number[];
+export declare const CAMPAIGN_LIFT_EXCLUDED_ALLOWED_PARTNERSHIP_TYPES: PartnershipType[];
+export declare class CampaignLiftExcludedFieldValidator {
+    /**
+     * Simple function checking if provided user has rights to edit the campaign lift excluded field.
+     *
+     * @param userId - ID of a user trying to edit the campaign lift excluded field
+     * @returns boolean - true if user has the rights, false otherwise
+     */
+    static validateRights(userId: number): boolean;
+    /**
+     *
+     * Function validates whether campaign with provided partnership type can be excluded from campaign lift.
+     * If campaign is not excluded from campaign lift, function returns true.
+     *
+     * @param isExcludedFromCampaignLift
+     * @param partnershipType
+     * @returns boolean - true if the data is valid, false if partnership type is not allowed to be excluded from campaign lift
+     */
+    static validateData(isExcludedFromCampaignLift: boolean, partnershipType: PartnershipType): boolean;
+}

package/src/validation/campaign/campaign-lift-excluded-field-validator.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CampaignLiftExcludedFieldValidator = exports.CAMPAIGN_LIFT_EXCLUDED_ALLOWED_PARTNERSHIP_TYPES = exports.USERS_ALLOWED_EDITING_CAMPAIGN_LIFT = void 0;
+const campaign_1 = require("../../domain/campaign");
+exports.USERS_ALLOWED_EDITING_CAMPAIGN_LIFT = [
+    3032728,
+    2089507
+];
+exports.CAMPAIGN_LIFT_EXCLUDED_ALLOWED_PARTNERSHIP_TYPES = [
+    campaign_1.PartnershipType.RBP,
+    campaign_1.PartnershipType.HYBRID_EBP,
+];
+class CampaignLiftExcludedFieldValidator {
+    /**
+     * Simple function checking if provided user has rights to edit the campaign lift excluded field.
+     *
+     * @param userId - ID of a user trying to edit the campaign lift excluded field
+     * @returns boolean - true if user has the rights, false otherwise
+     */
+    static validateRights(userId) {
+        return exports.USERS_ALLOWED_EDITING_CAMPAIGN_LIFT.includes(userId);
+    }
+    /**
+     *
+     * Function validates whether campaign with provided partnership type can be excluded from campaign lift.
+     * If campaign is not excluded from campaign lift, function returns true.
+     *
+     * @param isExcludedFromCampaignLift
+     * @param partnershipType
+     * @returns boolean - true if the data is valid, false if partnership type is not allowed to be excluded from campaign lift
+     */
+    static validateData(isExcludedFromCampaignLift, partnershipType) {
+        if (isExcludedFromCampaignLift === false) {
+            return true;
+        }
+        if (!exports.CAMPAIGN_LIFT_EXCLUDED_ALLOWED_PARTNERSHIP_TYPES.includes(partnershipType)) {
+            return false;
+        }
+        return true;
+    }
+}
+exports.CampaignLiftExcludedFieldValidator = CampaignLiftExcludedFieldValidator;
+//# sourceMappingURL=campaign-lift-excluded-field-validator.js.map

package/src/validation/campaign/campaign-lift-excluded-field-validator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"campaign-lift-excluded-field-validator.js","sourceRoot":"","sources":["../../../../src/validation/campaign/campaign-lift-excluded-field-validator.ts"],"names":[],"mappings":";;;AAAA,oDAAwD;AAE3C,QAAA,mCAAmC,GAAI;IACnD,OAAO;IACP,OAAO;CACP,CAAC;AAEW,QAAA,gDAAgD,GAAG;IAC/D,0BAAe,CAAC,GAAG;IACnB,0BAAe,CAAC,UAAU;CAC1B,CAAC;AAEF,MAAa,kCAAkC;IAC9C;;;;;OAKG;IACI,MAAM,CAAC,cAAc,CAAC,MAAc;QAC1C,OAAO,2CAAmC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,YAAY,CAAC,0BAAmC,EAAE,eAAgC;QAE/F,IAAI,0BAA0B,KAAK,KAAK,EAAE,CAAC;YAC1C,OAAO,IAAI,CAAC;QACb,CAAC;QAED,IAAI,CAAC,wDAAgD,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC;YACjF,OAAO,KAAK,CAAC;QACd,CAAC;QAED,OAAO,IAAI,CAAC;IACb,CAAC;CACD;AAhCD,gFAgCC"}

package/src/validation/index.d.ts

@@ -1,5 +1,6 @@
+import { CampaignLiftExcludedFieldValidator } from "./campaign/campaign-lift-excluded-field-validator";
 import { CampaignMandatoryFieldsValidator } from "./campaign/mandatory-fields-validator";
 import { SpecificResult } from "./types/SpecificResult";
 import { ValidationResult } from "./types/ValidationResult";
 export * from "./dto/organisations";
-export { ValidationResult, SpecificResult, CampaignMandatoryFieldsValidator };
+export { ValidationResult, SpecificResult, CampaignMandatoryFieldsValidator, CampaignLiftExcludedFieldValidator };

package/src/validation/index.js

@@ -14,7 +14,9 @@ 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.CampaignMandatoryFieldsValidator = exports.SpecificResult = void 0;
+exports.CampaignLiftExcludedFieldValidator = exports.CampaignMandatoryFieldsValidator = exports.SpecificResult = void 0;
+const campaign_lift_excluded_field_validator_1 = require("./campaign/campaign-lift-excluded-field-validator");
+Object.defineProperty(exports, "CampaignLiftExcludedFieldValidator", { enumerable: true, get: function () { return campaign_lift_excluded_field_validator_1.CampaignLiftExcludedFieldValidator; } });
 const mandatory_fields_validator_1 = require("./campaign/mandatory-fields-validator");
 Object.defineProperty(exports, "CampaignMandatoryFieldsValidator", { enumerable: true, get: function () { return mandatory_fields_validator_1.CampaignMandatoryFieldsValidator; } });
 const SpecificResult_1 = require("./types/SpecificResult");

package/src/validation/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/validation/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,sFAAyF;AASxF,iHATQ,6DAAgC,OASR;AARjC,2DAAwD;AAOvD,+FAPQ,+BAAc,OAOR;AAJf,sDAAoC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/validation/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,8GAAuG;AAWtG,mHAXQ,2EAAkC,OAWR;AAVnC,sFAAyF;AASxF,iHATQ,6DAAgC,OASR;AARjC,2DAAwD;AAOvD,+FAPQ,+BAAc,OAOR;AAJf,sDAAoC"}

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

@@ -1,5 +1,8 @@
+import { CampaignEditorGetResultDto } from "../../domain/campaign";
+type Properties = keyof CampaignEditorGetResultDto | "data";
 export type ValidationResult = {
-    missing: string[];
-    invalid: string[];
-    valid: string[];
+    missing: Properties[];
+    invalid: Properties[];
+    valid: Properties[];
 };
+export {};