@pixels-online/pixels-client-js-sdk 1.16.0 → 1.17.0

package/dist/index.js

@@ -1280,19 +1280,47 @@ class OfferwallClient {
 }
 
 const keyPattern = /\{([a-zA-Z_][a-zA-Z0-9_]*)\}/g;
-// renders template by replacing {keyName} with values from dynamic
+/**
+ * This replaces {keyName} keys from the template with corresponding values from the dynamic object.
+ */
 function renderTemplate(template, dynamic) {
     if (!template)
         return '';
-    return template.replace(keyPattern, (match, key) => {
+    return template.replace(keyPattern, (_match, key) => {
+        if (dynamic && typeof dynamic[key] === 'boolean') {
+            return dynamic[key] ? '✓' : '✗';
+        }
         if (dynamic && dynamic[key] !== undefined) {
             return String(dynamic[key]);
         }
         return '{?}'; // indicate missing key
     });
 }
+/**
+ * This replaces {{keyName}} in dynamic condition keys with corresponding values from
+ * the PlayerOffer.trackers
+ *
+ * eg. a condition high_score_pet-{{surfacerPlayerId}} with high_score_pet-12345
+ */
+function replaceDynamicConditionKey(key, trackers) {
+    return key?.replace(/\{\{([a-zA-Z_][a-zA-Z0-9_]*)\}\}/g, (match, p1) => {
+        const value = trackers[p1];
+        return value !== undefined ? String(value) : match;
+    });
+}
+/** this replaces all of the dynamic conditions.keys by calling replaceDynamicConditionKey */
+function replaceDynamicConditionKeys(conditions, trackers) {
+    return conditions.map((condition) => ({
+        ...condition,
+        key: replaceDynamicConditionKey(condition.key, trackers),
+    }));
+}
 
-const meetsBaseConditions = ({ conditions, playerSnap, addDetails, }) => {
+const meetsBaseConditions = ({ conditions, playerSnap, addDetails, 
+/** this exists if calling meetsBaseConditions from meetsCompletionConditions. but surfacing
+ * check doesn't use this since we don't have a playerOffer at surfacing time
+ */
+playerOffer, }) => {
     const conditionData = [];
     let isValid = true;
     if (conditions?.minDaysInGame) {
@@ -1659,7 +1687,11 @@ const meetsBaseConditions = ({ conditions, playerSnap, addDetails, }) => {
     }
     // Evaluate dynamic conditions
     if (conditions?.dynamic?.conditions?.length) {
-        const dynamicResult = meetsDynamicConditions(playerSnap.dynamic || {}, conditions.dynamic);
+        const resolvedConditions = replaceDynamicConditionKeys(conditions.dynamic.conditions, playerOffer?.trackers || {});
+        const dynamicResult = meetsDynamicConditions(playerSnap.dynamic, {
+            ...conditions.dynamic,
+            conditions: resolvedConditions,
+        });
         if (addDetails) {
             conditionData.push({
                 isMet: dynamicResult,
@@ -1768,6 +1800,31 @@ const meetsSurfacingConditions = ({ surfacingConditions, playerSnap, context, pl
             return { isValid: false };
         }
     }
+    if (conditions.allowedCountries?.length) {
+        const playerCountry = playerSnap.ip?.countryCode;
+        if (!playerCountry || !conditions.allowedCountries.includes(playerCountry)) {
+            return { isValid: false };
+        }
+    }
+    if (conditions.restrictedCountries?.length) {
+        const playerCountry = playerSnap.ip?.countryCode;
+        if (!playerCountry) {
+            return { isValid: false };
+        }
+        if (conditions.restrictedCountries.includes(playerCountry)) {
+            return { isValid: false };
+        }
+    }
+    if (conditions.networkRestrictions?.length) {
+        if (!playerSnap.ip) {
+            return { isValid: false };
+        }
+        for (const restriction of conditions.networkRestrictions) {
+            if (playerSnap.ip[restriction]) {
+                return { isValid: false };
+            }
+        }
+    }
     return meetsBaseConditions({ conditions, playerSnap });
 };
 const hasConditions = (conditions) => {
@@ -1820,6 +1877,12 @@ const hasConditions = (conditions) => {
         return true;
     if (surCond.links && Object.keys(surCond.links).length > 0)
         return true;
+    if (surCond.allowedCountries?.length)
+        return true;
+    if (surCond.restrictedCountries?.length)
+        return true;
+    if (surCond.networkRestrictions?.length)
+        return true;
     const compCond = conditions;
     if (compCond.context)
         return true;
@@ -1841,9 +1904,21 @@ const hasConditions = (conditions) => {
         return true;
     return false;
 };
-const meetsCompletionConditions = ({ completionConditions, completionTrackers, playerSnap, addDetails = false, }) => {
+const offerMeetsCompletionConditions = (offer, snapshot) => {
+    return meetsCompletionConditions({
+        completionConditions: offer.completionConditions || {},
+        completionTrackers: offer.completionTrackers,
+        playerSnap: snapshot,
+        playerOffer: offer,
+        addDetails: true,
+    });
+};
+const meetsCompletionConditions = ({ completionConditions, completionTrackers, playerSnap, playerOffer, addDetails = false, maxClaimCount, }) => {
     if (completionConditions) {
         const conditions = completionConditions;
+        // For multi-claim offers, scale cumulative requirements by (claimedCount + 1)
+        const shouldScale = maxClaimCount === -1 || (maxClaimCount && maxClaimCount > 1);
+        const claimMultiplier = shouldScale ? (playerOffer.claimedCount || 0) + 1 : 1;
         const conditionData = [];
         let isValid = true;
         if (completionConditions?.context?.id) {
@@ -1866,13 +1941,14 @@ const meetsCompletionConditions = ({ completionConditions, completionTrackers, p
             }
         }
         if (conditions?.buyItem) {
-            const isDisqualify = (completionTrackers?.buyItem || 0) < (conditions.buyItem.amount || 1);
+            const scaledAmount = (conditions.buyItem.amount || 1) * claimMultiplier;
+            const isDisqualify = (completionTrackers?.buyItem || 0) < scaledAmount;
             if (addDetails) {
                 conditionData.push({
                     isMet: !isDisqualify,
                     kind: 'buyItem',
                     trackerAmount: completionTrackers?.buyItem || 0,
-                    text: `Buy ${conditions.buyItem.amount || 1} ${conditions.buyItem.name}`,
+                    text: `Buy ${scaledAmount} ${conditions.buyItem.name}`,
                 });
                 if (isDisqualify)
                     isValid = false;
@@ -1883,13 +1959,14 @@ const meetsCompletionConditions = ({ completionConditions, completionTrackers, p
             }
         }
         if (conditions?.spendCurrency) {
-            const isDisqualify = (completionTrackers?.spendCurrency || 0) < (conditions.spendCurrency.amount || 1);
+            const scaledAmount = (conditions.spendCurrency.amount || 1) * claimMultiplier;
+            const isDisqualify = (completionTrackers?.spendCurrency || 0) < scaledAmount;
             if (addDetails) {
                 conditionData.push({
                     isMet: !isDisqualify,
                     kind: 'spendCurrency',
                     trackerAmount: completionTrackers?.spendCurrency || 0,
-                    text: `Spend ${conditions.spendCurrency.amount || 1} ${conditions.spendCurrency.name}`,
+                    text: `Spend ${scaledAmount} ${conditions.spendCurrency.name}`,
                 });
                 if (isDisqualify)
                     isValid = false;
@@ -1900,15 +1977,17 @@ const meetsCompletionConditions = ({ completionConditions, completionTrackers, p
             }
         }
         if (conditions?.depositCurrency) {
-            const isDisqualify = (completionTrackers?.depositCurrency || 0) <
-                (conditions.depositCurrency.amount || 1);
+            const scaledAmount = (conditions.depositCurrency.amount || 1) * claimMultiplier;
+            const isDisqualify = (completionTrackers?.depositCurrency || 0) < scaledAmount;
             if (addDetails) {
                 conditionData.push({
                     isMet: !isDisqualify,
                     kind: 'depositCurrency',
                     trackerAmount: completionTrackers?.depositCurrency || 0,
-                    text: `Deposit ${conditions.depositCurrency.amount || 1} ${conditions.depositCurrency.name}`,
+                    text: `Deposit ${scaledAmount} ${conditions.depositCurrency.name}`,
                 });
+                if (isDisqualify)
+                    isValid = false;
             }
             else {
                 if (isDisqualify)
@@ -1916,12 +1995,13 @@ const meetsCompletionConditions = ({ completionConditions, completionTrackers, p
             }
         }
         if (conditions?.login) {
-            const isMet = completionTrackers?.login || false;
+            const isMet = new Date(playerSnap.snapshotLastUpdated || 0).getTime() >
+                new Date(playerOffer.createdAt || 0).getTime();
             if (addDetails) {
                 conditionData.push({
                     isMet,
                     kind: 'login',
-                    trackerAmount: completionTrackers?.login ? 1 : 0,
+                    trackerAmount: isMet ? 1 : 0,
                     text: `Login to the game`,
                 });
                 isValid = isMet;
@@ -1958,9 +2038,11 @@ const meetsCompletionConditions = ({ completionConditions, completionTrackers, p
             const hasContent = Boolean(mode === 'accumulate'
                 ? tSocial?.mode === 'accumulate'
                 : tSocial && tSocial.mode !== 'accumulate' && !!tSocial.videoId);
-            const minLikes = cSocial?.minLikes || 0;
-            const minViews = cSocial?.minViews || 0;
-            const minComments = cSocial?.minComments || 0;
+            // Only scale social metrics in accumulate mode (attach mode is single content)
+            const socialMultiplier = mode === 'accumulate' ? claimMultiplier : 1;
+            const minLikes = (cSocial?.minLikes || 0) * socialMultiplier;
+            const minViews = (cSocial?.minViews || 0) * socialMultiplier;
+            const minComments = (cSocial?.minComments || 0) * socialMultiplier;
             const likes = tSocial?.likes || 0;
             const views = tSocial?.views || 0;
             const comments = tSocial?.comments || 0;
@@ -2045,14 +2127,14 @@ const meetsCompletionConditions = ({ completionConditions, completionTrackers, p
         // Linked completions - wait for N linked entities to complete
         if (conditions?.linkedCompletions?.min) {
             const currentCount = completionTrackers?.linkedCompletions || 0;
-            const requiredCount = conditions.linkedCompletions.min;
-            const isDisqualify = currentCount < requiredCount;
+            const scaledMin = conditions.linkedCompletions.min * claimMultiplier;
+            const isDisqualify = currentCount < scaledMin;
             if (addDetails) {
                 conditionData.push({
                     isMet: !isDisqualify,
                     kind: 'linkedCompletions',
                     trackerAmount: currentCount,
-                    text: `Wait for ${requiredCount} linked ${requiredCount === 1 ? 'entity' : 'entities'} to complete`,
+                    text: `Wait for ${scaledMin} linked ${scaledMin === 1 ? 'entity' : 'entities'} to complete`,
                 });
                 if (isDisqualify)
                     isValid = false;
@@ -2063,7 +2145,12 @@ const meetsCompletionConditions = ({ completionConditions, completionTrackers, p
             }
         }
         if (conditions?.dynamicTracker?.conditions?.length) {
-            const dynamicResult = meetsDynamicConditions(completionTrackers?.dynamicTracker || {}, conditions.dynamicTracker);
+            const resolvedConditions = replaceDynamicConditionKeys(conditions.dynamicTracker.conditions, playerOffer?.trackers || {});
+            // now we have the game-defined conditions with {{}} keys populated. feed these conditions into evaluator
+            const dynamicResult = meetsDynamicConditions(completionTrackers?.dynamicTracker, {
+                ...conditions.dynamicTracker,
+                conditions: resolvedConditions,
+            }, claimMultiplier);
             if (addDetails) {
                 conditionData.push({
                     isMet: dynamicResult,
@@ -2082,6 +2169,7 @@ const meetsCompletionConditions = ({ completionConditions, completionTrackers, p
             conditions,
             playerSnap,
             addDetails: true,
+            playerOffer,
         });
         isValid = isValid && r.isValid;
         conditionData.push(...(r.conditionData || []));
@@ -2096,10 +2184,9 @@ const meetsCompletionConditions = ({ completionConditions, completionTrackers, p
  * @param completionConditions - The completion conditions to check
  * @param completionTrackers - The completion trackers (for buyItem, spendCurrency, etc.)
  * @param playerSnap - The player snapshot with field timestamps
- * @param expiryTime - The expiry timestamp in milliseconds
  * @returns true if all conditions were met before expiry, false otherwise
  */
-const meetsCompletionConditionsBeforeExpiry = ({ completionConditions, completionTrackers, playerSnap, expiryTime, }) => {
+const meetsCompletionConditionsBeforeExpiry = ({ completionConditions, completionTrackers, playerSnap, playerOffer, maxClaimCount, }) => {
     if (!completionConditions)
         return false;
     // Check if there are actually any conditions to evaluate
@@ -2109,10 +2196,15 @@ const meetsCompletionConditionsBeforeExpiry = ({ completionConditions, completio
     const conditionsMet = meetsCompletionConditions({
         completionConditions,
         completionTrackers,
+        playerOffer,
         playerSnap,
+        maxClaimCount,
     });
     if (!conditionsMet.isValid)
         return false;
+    if (!playerOffer.expiresAt)
+        return true;
+    const expiryTime = new Date(playerOffer.expiresAt).getTime();
     const lastSnapshotUpdate = new Date(playerSnap.snapshotLastUpdated).getTime();
     /**
      * Checks if a field was updated after the expiry time.
@@ -2223,16 +2315,30 @@ const meetsCompletionConditionsBeforeExpiry = ({ completionConditions, completio
  * Checks if a dynamic object meets a set of dynamic field conditions.
  * @param dynamicObj - The object with any key and string or number value.
  * @param conditions - Array of conditions to check.
+ * @param claimMultiplier - Multiplier to scale conditions (used for numeric comparisons).
  * @returns true if all conditions are met, false otherwise.
  */
 /**
  * Evaluates a single dynamic condition against the dynamic object.
  */
-function evaluateDynamicCondition(dynamicObj, cond) {
+function evaluateDynamicCondition(dynamicObj, cond, claimMultiplier = 1) {
+    if (!dynamicObj)
+        return false;
     const val = dynamicObj[cond.key];
     if (val === undefined)
         return false;
     const isNumber = typeof val === 'number';
+    const isBoolean = typeof val === 'boolean';
+    if (isBoolean) {
+        switch (cond.operator) {
+            case '==':
+                return val === Boolean(cond.compareTo);
+            case '!=':
+                return val !== Boolean(cond.compareTo);
+            default:
+                return false;
+        }
+    }
     const compareTo = isNumber ? Number(cond.compareTo) : String(cond.compareTo);
     switch (cond.operator) {
         case '==':
@@ -2243,13 +2349,13 @@ function evaluateDynamicCondition(dynamicObj, cond) {
     if (isNumber && typeof compareTo === 'number') {
         switch (cond.operator) {
             case '>':
-                return val > compareTo;
+                return val > compareTo * claimMultiplier;
             case '>=':
-                return val >= compareTo;
+                return val >= compareTo * claimMultiplier;
             case '<':
-                return val < compareTo;
+                return val < compareTo * claimMultiplier;
             case '<=':
-                return val <= compareTo;
+                return val <= compareTo * claimMultiplier;
         }
     }
     else if (!isNumber && typeof compareTo === 'string') {
@@ -2266,20 +2372,23 @@ function evaluateDynamicCondition(dynamicObj, cond) {
  * Evaluates a group of dynamic conditions with logical links (AND, OR, AND NOT).
  * @param dynamicObj - The player's dynamic object with any key and string or number value.
  * @param dynamicGroup - The group of conditions and links to check.
+ * @param claimMultiplier - Multiplier to scale conditions (used for numeric comparisons).
  * @returns true if the group evaluates to true, false otherwise.
  */
-function meetsDynamicConditions(dynamicObj, dynamicGroup) {
+function meetsDynamicConditions(dynamicObj, dynamicGroup, claimMultiplier = 1) {
     const { conditions, links } = dynamicGroup;
     if (!conditions || conditions.length === 0)
         return true;
+    if (!dynamicObj)
+        return false;
     // If no links, treat as AND between all conditions
     if (!links || links.length === 0) {
-        return conditions.every((cond) => evaluateDynamicCondition(dynamicObj, cond));
+        return conditions.every((cond) => evaluateDynamicCondition(dynamicObj, cond, claimMultiplier));
     }
     // Evaluate the first condition
-    let result = evaluateDynamicCondition(dynamicObj, conditions[0]);
+    let result = evaluateDynamicCondition(dynamicObj, conditions[0], claimMultiplier);
     for (let i = 0; i < links.length; i++) {
-        const nextCond = evaluateDynamicCondition(dynamicObj, conditions[i + 1]);
+        const nextCond = evaluateDynamicCondition(dynamicObj, conditions[i + 1], claimMultiplier);
         const link = links[i];
         if (link === 'AND') {
             result = result && nextCond;
@@ -2375,6 +2484,7 @@ exports.meetsCompletionConditionsBeforeExpiry = meetsCompletionConditionsBeforeE
 exports.meetsDynamicConditions = meetsDynamicConditions;
 exports.meetsSurfacingConditions = meetsSurfacingConditions;
 exports.offerListenerEvents = offerListenerEvents;
+exports.offerMeetsCompletionConditions = offerMeetsCompletionConditions;
 exports.rewardKinds = rewardKinds;
 exports.rewardSchema = rewardSchema;
 //# sourceMappingURL=index.js.map