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

package/dist/utils/conditions.d.ts

@@ -1,10 +1,15 @@
 import { ISurfacingCondition, IPlayerSnapshot, ICompletionCondition, IBaseCondition, ICompletionTrackers } from '../types/player';
 import { IDynamicGroup } from '../types/player';
-import { IPlayerOffer } from '../types/offer';
-export declare const meetsBaseConditions: ({ conditions, playerSnap, addDetails, }: {
+import { IClientOffer, IOffer, IPlayerOffer, IPlayerOfferTrackers, IStrippedSnapshot } from '../types/offer';
+export declare const meetsBaseConditions: ({ conditions, playerSnap, addDetails, playerOffer, }: {
     conditions: IBaseCondition;
-    playerSnap: IPlayerSnapshot;
+    playerSnap: IPlayerSnapshot | IStrippedSnapshot;
     addDetails?: boolean;
+    playerOffer?: {
+        createdAt?: Date | number;
+        claimedCount?: number;
+        trackers?: Record<string, any>;
+    };
 }) => {
     isValid: boolean;
     conditionData?: undefined;
@@ -35,11 +40,29 @@ export declare const meetsSurfacingConditions: ({ surfacingConditions, playerSna
     }[] | undefined;
 };
 export declare const hasConditions: (conditions: ICompletionCondition | ISurfacingCondition) => boolean;
-export declare const meetsCompletionConditions: ({ completionConditions, completionTrackers, playerSnap, addDetails, }: {
+export declare const offerMeetsCompletionConditions: (offer: IClientOffer, snapshot: IPlayerSnapshot) => {
+    isValid: boolean;
+    conditionData?: undefined;
+} | {
+    isValid: boolean;
+    conditionData: {
+        isMet: boolean;
+        kind?: keyof ICompletionCondition | "context";
+        trackerAmount?: number;
+        text: string;
+    }[];
+};
+export declare const meetsCompletionConditions: ({ completionConditions, completionTrackers, playerSnap, playerOffer, addDetails, maxClaimCount, }: {
     completionConditions: ICompletionCondition;
     completionTrackers?: ICompletionTrackers;
-    playerSnap: IPlayerSnapshot;
+    playerSnap: IPlayerSnapshot | IStrippedSnapshot;
+    playerOffer: {
+        createdAt?: Date | number;
+        claimedCount?: number;
+        trackers?: Record<string, any>;
+    };
     addDetails?: boolean;
+    maxClaimCount?: number;
 }) => {
     isValid: boolean;
     conditionData?: undefined;
@@ -59,19 +82,37 @@ export declare const meetsCompletionConditions: ({ completionConditions, complet
  * @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
  */
-export declare const meetsCompletionConditionsBeforeExpiry: ({ completionConditions, completionTrackers, playerSnap, expiryTime, }: {
+export declare const meetsCompletionConditionsBeforeExpiry: ({ completionConditions, completionTrackers, playerSnap, playerOffer, maxClaimCount, }: {
     completionConditions: ICompletionCondition;
     completionTrackers?: ICompletionTrackers;
     playerSnap: IPlayerSnapshot;
-    expiryTime: number;
+    playerOffer: {
+        createdAt?: Date | number;
+        claimedCount?: number;
+        trackers?: Record<string, any>;
+        expiresAt?: Date | number | string;
+    };
+    maxClaimCount?: number;
 }) => boolean;
 /**
  * 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.
  */
-export declare function meetsDynamicConditions(dynamicObj: Record<string, string | number>, dynamicGroup: IDynamicGroup): boolean;
+export declare function meetsDynamicConditions(dynamicObj: Record<string, string | number | boolean> | undefined, dynamicGroup: IDynamicGroup, claimMultiplier?: number): boolean;
+/**
+ * Checks if a PlayerOffer meets its claimable conditions (completed -> claimable transition).
+ * @param claimableConditions - The offer's claimableConditions (from IOffer)
+ * @param claimableTrackers - The player offer's claimableTrackers
+ */
+export declare function meetsClaimableConditions({ claimableConditions, playerOfferTrackers, claimableTrackers, }: {
+    claimableConditions?: IOffer['claimableConditions'];
+    playerOfferTrackers?: IPlayerOfferTrackers;
+    claimableTrackers?: IPlayerOffer['claimableTrackers'];
+}): {
+    isValid: boolean;
+};

package/dist/utils/template.d.ts

@@ -1,2 +1,19 @@
+import { IDynamicCondition } from '../types/player';
 export declare function extractTemplateKeys(template: string | undefined): Set<string>;
-export declare function renderTemplate(template: string | undefined, dynamic: Record<string, string | number> | undefined): string;
+/**
+ * This replaces {keyName} keys from the template with corresponding values from the dynamic object.
+ */
+export declare function renderTemplate(template: string | undefined, dynamic: Record<string, string | number | boolean> | undefined): string;
+/**
+ * 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
+ */
+export declare function replaceDynamicConditionKey(key: string, trackers: Record<string, any>): string;
+/** this replaces all of the dynamic conditions.keys by calling replaceDynamicConditionKey */
+export declare function replaceDynamicConditionKeys(conditions: Array<IDynamicCondition>, trackers: Record<string, any>): {
+    key: string;
+    compareTo: string | number | boolean;
+    operator: import("../types/player").DynamicConditionOperator;
+}[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pixels-online/pixels-client-js-sdk",
-  "version": "1.15.0",
+  "version": "1.17.0",
   "description": "Pixels Client JS SDK",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",
@@ -67,6 +67,7 @@
     "prettier": "^3.6.2",
     "rimraf": "^6.0.1",
     "rollup": "^4.50.1",
+    "semantic-release": "25.0.2",
     "ts-jest": "^29.4.1",
     "ts-node": "^10.9.2",
     "tslib": "^2.8.1",