refactor getTreatmentsRequestPayloadToGateType and export types from types.ts

Author: shtukas

src/server/signin-gate/libPure.ts

@@ -355,7 +355,7 @@ export const decideGuGateTypeNonConsentedIreland = (
 };
 
 export const getTreatmentsRequestPayloadToGateType = (
-    getTreatmentsRequestPayload: GetTreatmentsRequestPayload,
+    payload: GetTreatmentsRequestPayload,
 ): GateType => {
     // This function is a pure function (without any side effects) which gets the body
     // of a '/auxia/get-treatments' request and returns the correct GateType.
@@ -378,18 +378,15 @@ export const getTreatmentsRequestPayloadToGateType = (
     // body.shouldServeDismissible take priority over the fact that body.showDefaultGate
     // could possibly have value 'mandatory'
 
-    if (
-        getTreatmentsRequestPayload.showDefaultGate !== undefined &&
-        getTreatmentsRequestPayload.shouldServeDismissible
-    ) {
+    if (payload.showDefaultGate !== undefined && payload.shouldServeDismissible) {
         return 'GuDismissible';
     }
 
     // --------------------------------------------------------------
     // The attribute showDefaultGate overrides any other behavior
 
-    if (getTreatmentsRequestPayload.showDefaultGate) {
-        if (getTreatmentsRequestPayload.showDefaultGate == 'mandatory') {
+    if (payload.showDefaultGate) {
+        if (payload.showDefaultGate == 'mandatory') {
             return 'GuMandatory';
         } else {
             return 'GuDismissible';
@@ -403,10 +400,10 @@ export const getTreatmentsRequestPayloadToGateType = (
     // might be decommissioned in the future.
 
     if (
-        !isValidContentType(getTreatmentsRequestPayload.contentType) ||
-        !isValidSection(getTreatmentsRequestPayload.sectionId) ||
-        !isValidTagIds(getTreatmentsRequestPayload.tagIds) ||
-        !articleIdentifierIsAllowed(getTreatmentsRequestPayload.articleIdentifier)
+        !isValidContentType(payload.contentType) ||
+        !isValidSection(payload.sectionId) ||
+        !isValidTagIds(payload.tagIds) ||
+        !articleIdentifierIsAllowed(payload.articleIdentifier)
     ) {
         return 'None';
     }
@@ -417,13 +414,13 @@ export const getTreatmentsRequestPayloadToGateType = (
     // traffic (consented or not consented) to Auxia. (For privacy vigilantes reading this,
     // Auxia is not going to process non consented traffic for targetting.)
 
-    if (getTreatmentsRequestPayload.countryCode === 'IE') {
-        if (mvtIdIsAuxiaAudienceShare(getTreatmentsRequestPayload.mvtId)) {
+    if (payload.countryCode === 'IE') {
+        if (mvtIdIsAuxiaAudienceShare(payload.mvtId)) {
             return 'AuxiaAPI';
         } else {
             return decideGuGateTypeNonConsentedIreland(
-                getTreatmentsRequestPayload.dailyArticleCount,
-                getTreatmentsRequestPayload.gateDisplayCount,
+                payload.dailyArticleCount,
+                payload.gateDisplayCount,
             );
         }
     }
@@ -440,9 +437,9 @@ export const getTreatmentsRequestPayloadToGateType = (
     // That split used to be done client side, but it's now been moved to SDC and is driven by
     // `mvtIdIsAuxiaAudienceShare`.
 
-    if (!mvtIdIsAuxiaAudienceShare(getTreatmentsRequestPayload.mvtId)) {
-        if (getTreatmentsRequestPayload.should_show_legacy_gate_tmp) {
-            return decideGateTypeNoneOrDismissible(getTreatmentsRequestPayload.gateDismissCount);
+    if (!mvtIdIsAuxiaAudienceShare(payload.mvtId)) {
+        if (payload.should_show_legacy_gate_tmp) {
+            return decideGateTypeNoneOrDismissible(payload.gateDismissCount);
         } else {
             return 'None';
         }

src/server/signin-gate/types.ts

@@ -2,27 +2,27 @@
 // Types
 // --------------------------------------------------------
 
-interface AuxiaAPIContextualAttributeString {
+export interface AuxiaAPIContextualAttributeString {
     key: string;
     stringValue: string;
 }
 
-interface AuxiaAPIContextualAttributeBoolean {
+export interface AuxiaAPIContextualAttributeBoolean {
     key: string;
     boolValue: boolean;
 }
 
-interface AuxiaAPIContextualAttributeInteger {
+export interface AuxiaAPIContextualAttributeInteger {
     key: string;
     integerValue: number;
 }
 
-type AuxiaAPIGenericContexualAttribute =
+export type AuxiaAPIGenericContexualAttribute =
     | AuxiaAPIContextualAttributeString
     | AuxiaAPIContextualAttributeBoolean
     | AuxiaAPIContextualAttributeInteger;
 
-interface AuxiaAPISurface {
+export interface AuxiaAPISurface {
     surface: string;
     maximumTreatmentCount: number;
 }