@pixels-online/pixels-client-js-sdk 1.20.0 → 1.21.0

package/README.md

@@ -394,7 +394,7 @@ This project is licensed under the AGPLv3 License - see the [LICENSE.md](LICENSE
 
 - [GitLab Repository](https://gitlab.com/pixels-online-oss/pixels-buildon-client-js-sdk)
 - [Issue Tracker](https://gitlab.com/pixels-online-oss/pixels-buildon-client-js-sdk/issues)
-- [Pixels BuildOn Documentation](https://docs.pixels.xyz)
+- [Pixels BuildOn Documentation](https://docs.stackedplatform.io)
 
 ## 📞 Support
 

package/dist/constants.d.ts

@@ -0,0 +1 @@
+export declare const stackedDomain = "stackedplatform.io";

package/dist/core/OfferwallClient.d.ts

@@ -6,7 +6,7 @@ import { IClientOffer } from '../types/offer';
 import { ConnectionState } from '../types/connection';
 import { IClientPlayer } from '../types/player';
 import { StackedLinkResult } from '../types/linking';
-export declare const mapEnvToOfferClientUrl: (env: "test" | "live" | (string & {})) => "https://offers.pixels.xyz" | "https://offers.sandbox.pixels.xyz" | "https://offers.staging.pixels.xyz" | "https://offers.preview.pixels.xyz" | "https://offers.dev.pixels.xyz";
+export declare const mapEnvToOfferClientUrl: (env: "test" | "live" | (string & {})) => "https://app.stackedplatform.io" | "https://app.sandbox.stackedplatform.io" | "https://app.staging.stackedplatform.io" | "https://app.dev.stackedplatform.io";
 export declare class OfferwallClient {
     private config;
     private endpoint;

package/dist/index.esm.js

@@ -332,21 +332,22 @@ class CustomEventSource {
     }
 }
 
+const stackedDomain = 'stackedplatform.io';
+
 const mapEnvToBuildOnApiUrl = (env) => {
     switch (env) {
         case 'live':
-            return 'https://api.pixels.xyz';
+            return `https://api.${stackedDomain}`;
         case 'test':
-            return 'https://api.sandbox.pixels.xyz';
+            return `https://api.sandbox.${stackedDomain}`;
         case 'staging':
-            return 'https://api.staging.pixels.xyz';
+            return `https://api.staging.${stackedDomain}`;
         case 'preview':
-            return 'https://api.preview.pixels.xyz';
         case 'dev':
         case 'development':
-            return 'https://api.dev.pixels.xyz';
+            return `https://api.dev.${stackedDomain}`;
         default:
-            return 'https://api.sandbox.pixels.xyz';
+            return `https://api.sandbox.${stackedDomain}`;
     }
 };
 
@@ -906,18 +907,17 @@ class AssetHelper {
 const mapEnvToOfferClientUrl = (env) => {
     switch (env) {
         case 'live':
-            return 'https://offers.pixels.xyz';
+            return `https://app.${stackedDomain}`;
         case 'test':
-            return 'https://offers.sandbox.pixels.xyz';
+            return `https://app.sandbox.${stackedDomain}`;
         case 'staging':
-            return 'https://offers.staging.pixels.xyz';
+            return `https://app.staging.${stackedDomain}`;
         case 'preview':
-            return 'https://offers.preview.pixels.xyz';
         case 'dev':
         case 'development':
-            return 'https://offers.dev.pixels.xyz';
+            return `https://app.dev.${stackedDomain}`;
         default:
-            return 'https://offers.sandbox.pixels.xyz';
+            return `https://app.sandbox.${stackedDomain}`;
     }
 };
 class OfferwallClient {
@@ -1388,6 +1388,7 @@ additionalData, }) => {
                 isMet: !isDisqualify,
                 kind: 'minDaysInGame',
                 trackerAmount: playerSnap.daysInGame || 0,
+                trackerGoal: conditions.minDaysInGame,
                 text: `More than ${conditions.minDaysInGame} Days in Game`,
             });
             if (isDisqualify)
@@ -1405,6 +1406,7 @@ additionalData, }) => {
                 isMet: !isDisqualify,
                 kind: 'minTrustScore',
                 trackerAmount: playerSnap.trustScore || 0,
+                trackerGoal: conditions.minTrustScore,
                 text: `More than ${conditions.minTrustScore} Rep`,
             });
             if (isDisqualify)
@@ -1436,12 +1438,12 @@ additionalData, }) => {
         const a = conditions.achievements[key];
         const playerAchData = playerSnap.achievements?.[key];
         if (!playerAchData) {
-            const isDisqualify = true;
             if (addDetails) {
                 conditionData.push({
-                    isMet: isDisqualify,
+                    isMet: false,
                     kind: 'achievements',
                     trackerAmount: 0,
+                    trackerGoal: 1,
                     text: `Have the achievement ${a.name}`,
                 });
                 isValid = false;
@@ -1451,12 +1453,13 @@ additionalData, }) => {
             }
         }
         if (a.minCount) {
-            const isDisqualify = (playerAchData?.count || 1) < a.minCount;
+            const isDisqualify = (playerAchData?.count || 0) < a.minCount;
             if (addDetails) {
                 conditionData.push({
                     isMet: !isDisqualify,
                     kind: 'achievements',
                     trackerAmount: playerAchData?.count || 0,
+                    trackerGoal: a.minCount,
                     text: `Have the achievement ${a.name} more than ${a.minCount} times`,
                 });
                 if (isDisqualify)
@@ -1478,6 +1481,7 @@ additionalData, }) => {
                     isMet: !isDisqualify,
                     kind: 'currencies',
                     trackerAmount: playerCurrencyData?.balance || 0,
+                    trackerGoal: c.min,
                     text: `Have more than ${c.min} ${c.name}`,
                 });
                 if (isDisqualify)
@@ -1512,6 +1516,7 @@ additionalData, }) => {
                     isMet: !isDisqualify,
                     kind: 'currencies',
                     trackerAmount: playerCurrencyData?.in || 0,
+                    trackerGoal: c.in,
                     text: `Deposit at least ${c.in} ${c.name}`,
                 });
                 if (isDisqualify)
@@ -1529,6 +1534,7 @@ additionalData, }) => {
                     isMet: !isDisqualify,
                     kind: 'currencies',
                     trackerAmount: playerCurrencyData?.out || 0,
+                    trackerGoal: c.out,
                     text: `Withdraw at least ${c.out} ${c.name}`,
                 });
                 if (isDisqualify)
@@ -1550,6 +1556,7 @@ additionalData, }) => {
                     isMet: !isDisqualify,
                     kind: 'levels',
                     trackerAmount: playerLevelData?.level || 0,
+                    trackerGoal: l.min,
                     text: `Be above level ${l.min} ${l.name}`,
                 });
                 if (isDisqualify)
@@ -1584,12 +1591,13 @@ additionalData, }) => {
             const playerQuestData = playerSnap.quests?.[questId];
             const isDisqualify = playerQuestData
                 ? (playerQuestData?.completions || 0) < (quest.completions || 0)
-                : false;
+                : true; // if player has no data for this quest, they haven't completed it
             if (addDetails) {
                 conditionData.push({
                     isMet: !isDisqualify,
                     kind: 'quests',
                     trackerAmount: playerQuestData?.completions || 0,
+                    trackerGoal: quest.completions || 1,
                     text: quest.completions === 1
                         ? `Complete the quest ${quest.name}`
                         : (quest.completions || 0) < 1
@@ -1615,6 +1623,7 @@ additionalData, }) => {
                     isMet: !isDisqualify,
                     kind: 'memberships',
                     trackerAmount: playerMembershipsData?.count || 0,
+                    trackerGoal: m.minCount,
                     text: m.minCount > 1
                         ? `Have at least ${m.minCount} ${m.name} memberships`
                         : `Have a ${m.name} membership`,
@@ -1652,6 +1661,7 @@ additionalData, }) => {
                     isMet: !isDisqualify,
                     kind: 'memberships',
                     trackerAmount: Number((timeOwned / (1000 * 60 * 60 * 24)).toFixed(1)),
+                    trackerGoal: Number((m.minMs / (1000 * 60 * 60 * 24)).toFixed(1)),
                     text: `Own ${m.name} membership for at least ${(m.minMs /
                         (1000 * 60 * 60 * 24)).toFixed(1)} days`,
                 });
@@ -1692,6 +1702,7 @@ additionalData, }) => {
                     isMet: !isDisqualify,
                     kind: 'stakedTokens',
                     trackerAmount: playerStakedData?.balance || 0,
+                    trackerGoal: s.min,
                     text: `Have at least ${s.min} ${s.name} staked`,
                 });
                 if (isDisqualify)
@@ -1715,7 +1726,15 @@ additionalData, }) => {
                         isMet: !isDisqualify,
                         kind: 'links',
                         trackerAmount: linkCount,
-                        text: `At least ${constraint.min} ${linkType} link(s)`,
+                        trackerGoal: constraint.min,
+                        text: constraint.template
+                            ? renderTemplate(constraint.template, {
+                                current: linkCount,
+                                min: constraint.min ?? 0,
+                                max: constraint.max ?? 0,
+                                type: linkType,
+                            })
+                            : `At least ${constraint.min} ${linkType} link(s)`,
                     });
                     if (isDisqualify)
                         isValid = false;
@@ -1732,7 +1751,14 @@ additionalData, }) => {
                         isMet: !isDisqualify,
                         kind: 'links',
                         trackerAmount: linkCount,
-                        text: `At most ${constraint.max} ${linkType} link(s)`,
+                        text: constraint.template
+                            ? renderTemplate(constraint.template, {
+                                current: linkCount,
+                                min: constraint.min ?? 0,
+                                max: constraint.max ?? 0,
+                                type: linkType,
+                            })
+                            : `At most ${constraint.max} ${linkType} link(s)`,
                     });
                     if (isDisqualify)
                         isValid = false;
@@ -1784,6 +1810,8 @@ additionalData, }) => {
             conditionData.push({
                 isMet,
                 kind: 'identifiers',
+                trackerAmount: isMet ? 1 : 0,
+                trackerGoal: 1,
                 text: displayText,
             });
             if (!isMet)
@@ -1810,6 +1838,7 @@ additionalData, }) => {
                     isMet: !isDisqualify,
                     kind: 'tokenBalances',
                     trackerAmount: totalBalance,
+                    trackerGoal: tokenCond.min,
                     text: `Have at least ${tokenCond.min} ${tokenCond.name || 'tokens'}`,
                 });
                 if (isDisqualify)
@@ -1840,7 +1869,7 @@ additionalData, }) => {
     }
     return { isValid, conditionData: addDetails ? conditionData : undefined };
 };
-const meetsSurfacingConditions = ({ surfacingConditions, playerSnap, context, playerOffers, additionalData, }) => {
+const meetsSurfacingConditions = ({ surfacingConditions, playerSnap, context, playerOffers, ignoreRequiredCompletions, additionalData, }) => {
     if (surfacingConditions?.contexts?.length &&
         !surfacingConditions.contexts?.includes(context || '')) {
         // context is not in the list of surfacing contexts, so we don't want to surface this offer
@@ -1876,7 +1905,7 @@ const meetsSurfacingConditions = ({ surfacingConditions, playerSnap, context, pl
         }
     }
     if (conditions?.maxDaysInGame &&
-        (playerSnap.daysInGame || Infinity) > conditions.maxDaysInGame) {
+        (playerSnap.daysInGame ?? 0) > conditions.maxDaysInGame) {
         return { isValid: false };
     }
     if (conditions.loginStreak && (playerSnap.loginStreak || 0) < conditions.loginStreak) {
@@ -1899,7 +1928,7 @@ const meetsSurfacingConditions = ({ surfacingConditions, playerSnap, context, pl
     }
     if (conditions.completedOffers?.length) {
         const hasCompletedAllOffers = conditions.completedOffers.every((offerId) => completedOfferIds.has(offerId));
-        if (!hasCompletedAllOffers) {
+        if (!hasCompletedAllOffers && !ignoreRequiredCompletions) {
             return { isValid: false };
         }
     }
@@ -2060,7 +2089,8 @@ const meetsCompletionConditions = ({ completionConditions, completionTrackers, p
                 conditionData.push({
                     isMet: !isDisqualify,
                     kind: 'context',
-                    trackerAmount: 0,
+                    trackerAmount: hasTrackedContext ? 1 : 0,
+                    trackerGoal: 1,
                     text: completionConditions.context.name,
                 });
                 if (isDisqualify)
@@ -2084,6 +2114,7 @@ const meetsCompletionConditions = ({ completionConditions, completionTrackers, p
                     isMet: !isDisqualify,
                     kind: 'buyItem',
                     trackerAmount: trackerValue,
+                    trackerGoal: scaledAmount,
                     text: `Buy ${scaledAmount} ${conditions.buyItem.name}`,
                 });
                 if (isDisqualify)
@@ -2107,6 +2138,7 @@ const meetsCompletionConditions = ({ completionConditions, completionTrackers, p
                     isMet: !isDisqualify,
                     kind: 'spendCurrency',
                     trackerAmount: trackerValue,
+                    trackerGoal: scaledAmount,
                     text: `Spend ${scaledAmount} ${conditions.spendCurrency.name}`,
                 });
                 if (isDisqualify)
@@ -2130,6 +2162,7 @@ const meetsCompletionConditions = ({ completionConditions, completionTrackers, p
                     isMet: !isDisqualify,
                     kind: 'depositCurrency',
                     trackerAmount: trackerValue,
+                    trackerGoal: scaledAmount,
                     text: `Deposit ${scaledAmount} ${conditions.depositCurrency.name}`,
                 });
                 if (isDisqualify)
@@ -2148,9 +2181,11 @@ const meetsCompletionConditions = ({ completionConditions, completionTrackers, p
                     isMet,
                     kind: 'login',
                     trackerAmount: isMet ? 1 : 0,
+                    trackerGoal: 1,
                     text: `Login to the game`,
                 });
-                isValid = isMet;
+                if (!isMet)
+                    isValid = false;
             }
             else {
                 if (!isMet)
@@ -2166,7 +2201,8 @@ const meetsCompletionConditions = ({ completionConditions, completionTrackers, p
                 conditionData.push({
                     isMet: !isDisqualify,
                     kind: 'loginStreak',
-                    trackerAmount: (playerSnap.loginStreak || 0) - (completionTrackers?.currentLoginStreak || 0),
+                    trackerAmount: streakSinceOffer + 1,
+                    trackerGoal: conditions.loginStreak,
                     text: `Login streak of ${conditions.loginStreak || 0} days`,
                 });
                 if (isDisqualify)
@@ -2225,6 +2261,7 @@ const meetsCompletionConditions = ({ completionConditions, completionTrackers, p
                         isMet: hasContent,
                         kind: 'social',
                         trackerAmount: matchCount,
+                        trackerGoal: 1,
                         text: hasContent
                             ? `Found ${matchCount} matching ${platformText} post${matchCount !== 1 ? 's' : ''}`
                             : requiredWords.length > 0
@@ -2237,7 +2274,8 @@ const meetsCompletionConditions = ({ completionConditions, completionTrackers, p
                     conditionData.push({
                         isMet: hasContent,
                         kind: 'social',
-                        trackerAmount: 0,
+                        trackerAmount: hasContent ? 1 : 0,
+                        trackerGoal: 1,
                         text: !hasContent
                             ? requiredWords.length > 0
                                 ? `Attach a ${platformText} post with ${requiredWords.map((w) => `"${w}"`).join(', ')} in the title`
@@ -2250,6 +2288,7 @@ const meetsCompletionConditions = ({ completionConditions, completionTrackers, p
                         isMet: hasContent && likes >= minLikes,
                         kind: 'social',
                         trackerAmount: likes,
+                        trackerGoal: minLikes,
                         text: mode === 'accumulate'
                             ? `Combined ${minLikes} Likes`
                             : `Reach ${minLikes} Likes`,
@@ -2260,6 +2299,7 @@ const meetsCompletionConditions = ({ completionConditions, completionTrackers, p
                         isMet: hasContent && views >= minViews,
                         kind: 'social',
                         trackerAmount: views,
+                        trackerGoal: minViews,
                         text: mode === 'accumulate'
                             ? `Combined ${minViews} Views`
                             : `Reach ${minViews} Views`,
@@ -2270,6 +2310,7 @@ const meetsCompletionConditions = ({ completionConditions, completionTrackers, p
                         isMet: hasContent && comments >= minComments,
                         kind: 'social',
                         trackerAmount: comments,
+                        trackerGoal: minComments,
                         text: mode === 'accumulate'
                             ? `Combined ${minComments} Comments`
                             : `Reach ${minComments} Comments`,
@@ -2297,7 +2338,13 @@ const meetsCompletionConditions = ({ completionConditions, completionTrackers, p
                     isMet: !isDisqualify,
                     kind: 'linkedCompletions',
                     trackerAmount: currentCount,
-                    text: `Wait for ${scaledMin} linked ${scaledMin === 1 ? 'entity' : 'entities'} to complete`,
+                    trackerGoal: scaledMin,
+                    text: conditions.linkedCompletions.template
+                        ? renderTemplate(conditions.linkedCompletions.template, {
+                            current: currentCount,
+                            required: scaledMin,
+                        })
+                        : `Wait for ${scaledMin} linked ${scaledMin === 1 ? 'entity' : 'entities'} to complete`,
                 });
                 if (isDisqualify)
                     isValid = false;
@@ -2346,28 +2393,15 @@ const meetsCompletionConditions = ({ completionConditions, completionTrackers, p
                     updateMax(Math.floor(trackerValue / baseAmount));
                 }
                 if (addDetails) {
-                    let displayText;
-                    const eventType = condition.event;
-                    const name = condition.name || 'tokens';
-                    if (eventType === 'spend') {
-                        displayText = `Spend ${scaledAmount} ${name}`;
-                    }
-                    else if (eventType === 'earn') {
-                        displayText = `Earn ${scaledAmount} ${name}`;
-                    }
-                    else if (eventType === 'gain') {
-                        displayText = `Gain ${scaledAmount} ${name}`;
-                    }
-                    else if (eventType === 'lose') {
-                        displayText = `Lose ${scaledAmount} ${name}`;
-                    }
-                    else {
-                        displayText = `${name}: ${scaledAmount}`;
-                    }
+                    const displayText = renderTemplate(condition.template, {
+                        current: trackerValue,
+                        amount: scaledAmount,
+                    });
                     conditionData.push({
                         isMet: !isDisqualify,
                         kind: 'contractInteractions',
                         trackerAmount: trackerValue,
+                        trackerGoal: scaledAmount,
                         text: displayText,
                     });
                     if (isDisqualify)
@@ -2549,7 +2583,7 @@ function evaluateDynamicCondition(dynamicObj, cond, claimMultiplier = 1) {
     if (!dynamicObj)
         return false;
     const val = dynamicObj[cond.key];
-    if (val === undefined)
+    if (val == undefined)
         return false;
     const isNumber = typeof val === 'number';
     const isBoolean = typeof val === 'boolean';