@smartico/public-api 0.0.208 → 0.0.210

package/dist/Missions/AchievementAvailabilityStatus.d.ts

@@ -0,0 +1,61 @@
+/** Possible statuses of the mission availability.
+ *  Notes:
+ *   - Recurring missions have a special field next_recurrence_date_ts, but it's only relevant if the mission has no active till date or the next recurrence date is before the active till date.
+ *   - For a locked mission or mission that requires opt-in, the time limit should be calculated as dt_start + time_limit_ms. For a mission that does not require opt-in or type is not Locked, it should be the highest value of dt_start and active_from_ts (if defined) + time_limit_ms.
+ * */
+export declare enum AchievementAvailabilityStatus {
+    /** Mission without date/time restrictions or with passed active from date and no opt-in required and mission is unlocked */
+    Available = 0,
+    /** Mission without date/time restrictions or with passed active from date, opt-in is required, user is not opted-in or mission is locked */
+    AvailableInactive = 1,
+    /** Mission without date/time restrictions or with passed active from date, opt-in is required, user is opted-in or mission is unlocked*/
+    AvailableActive = 2,
+    /** Mission with active from date defined, date is in future.
+     * Field: active_from_ts
+    */
+    UnavailableWithActiveFrom = 3,
+    /** Mission with active till date defined, date is in future, and no opt-in required and mission is unlocked.
+     * Field: active_till_ts
+    */
+    AvailableWithActiveTill = 4,
+    /** Mission with active till date defined, date is in future, and opt-in is required, user is not opted in or mission is locked.
+     * Fields: active_till_ts, is_requires_optin, is_opted_in, is_locked.
+    */
+    AvailableWithActiveTillInactive = 5,
+    /** Mission with active till date defined, date is in future, and opt-in is required, user is opted in or mission is unlocked.
+     * Fields: active_till_ts, is_requires_optin, is_opted_in, is_locked.
+    */
+    AvailableWithActiveTillActive = 6,
+    /** Available mission with time limit, and opt-in is required or mission is unlocked.
+     * The time limit is calculated as the sum of two properties: (highest value from dt_start and active_from_ts) + time_limit_ms.
+     *
+    */
+    AvailableLimited = 7,
+    /** Available mission with time limit, opt-in is required, user is not opted-in or mission is locked.
+     * Time limit at this stage is not relevant, user should be opted-in or mission should be unlocked.
+    */
+    AvailableLimitedInactive = 8,
+    /** Available mission with time limit, opt-in is required, user is opted-in or mission unlocked.
+      * The time limit is calculated as the sum of two properties: dt_start + time_limit_ms.
+     */
+    AvailableLimitedActive = 9,
+    /** Available mission with time limit and active till date, opt-in is not required and mission is unlocked.
+     * Fields: active_till_ts, time_limit_ms, dt_start, active_from_ts;
+     * The time limit is calculated as the sum of two properties: (highest value from dt_start and active_from_ts) + time_limit_ms.
+    */
+    AvailableFullyLimited = 10,
+    /** Available mission with time limit and active till date, opt-in is required, user is not opted in or mission is locked.
+      * Fields: active_till_ts, time_limit_ms, dt_start, active_from_ts, is_requires_optin, is_opted_in, is_locked.
+      * On this stage only active_till_ts is relevant. time_limit_ms is ignored because user should be opted in.
+     */
+    AvailableFullyLimitedInactive = 11,
+    /** Available mission with time limit and active till date, opt-in is required, user is opted in or mission is unlocked.
+     * Fields: active_till_ts, time_limit_ms, dt_start, is_requires_optin, is_opted_in, is_locked.
+     * The time limit is calculated as the sum of two properties: dt_start + time_limit_ms.
+    */
+    AvailableFullyLimitedActive = 12,
+    /** Missed mission when active till date is already passed. is_completed field indicating if mission is completed or just missed  */
+    MissedByActiveTill = 13,
+    /** Missed mission when start_date + time_limit_ms is already passed. is_completed field indicating if mission is completed or just missed  */
+    MissedByLimitInTime = 14
+}

package/dist/Missions/MissionsUtils.d.ts

@@ -0,0 +1,6 @@
+import { AchievementAvailabilityStatus } from "./AchievementAvailabilityStatus";
+import { UserAchievement } from "./UserAchievement";
+export declare class MissionUtils {
+    static getAvailabilityStatus: (mission: UserAchievement) => AchievementAvailabilityStatus;
+    static getMs: (ts: number) => number;
+}

package/dist/Missions/index.d.ts

@@ -17,3 +17,4 @@ export * from './GetAchCategoriesResponse';
 export * from './GetAchCategoriesRequest';
 export * from './AchClaimPrizeRequest';
 export * from './AchClaimPrizeResponse';
+export * from './AchievementAvailabilityStatus';

package/dist/SmarticoLib/index.d.ts

@@ -1494,18 +1494,27 @@ export interface UserAchievement {
     time_limit_ms?: number;
     progress?: number;
     complete_date?: string;
+    complete_date_ts?: number;
     unlock_date?: string;
     milliseconds_till_available?: number;
     completed_tasks?: number;
     achievementTasks?: UserAchievementTask[];
+    next_recurrence_date_ts?: number;
     ach_status_id?: AchievementStatus;
     scheduledMissionType?: ScheduledMissionType;
     related_games?: AchRelatedGame[];
     active_from_ts?: number;
+    active_till_ts?: number;
     ach_categories?: number[];
+    recurring_quantity?: number;
+    completed_count?: number;
     ach_completed_id?: number;
     requires_prize_claim?: boolean;
     prize_claimed_date_ts?: number;
+    completed_today?: boolean;
+    completed_this_week?: boolean;
+    completed_this_month?: boolean;
+    custom_section_type_id?: number;
 }
 export interface GetAchievementMapResponse extends ProtocolResponse {
     achievements?: UserAchievement[];

package/dist/WSAPI/WSAPITypes.d.ts

@@ -1,6 +1,7 @@
 import { BuyStoreItemErrorCode } from '../Store';
 import { MiniGamePrizeTypeName, SAWAcknowledgeTypeName, SAWBuyInTypeName, SAWGameTypeName, SAWSpinErrorCode, SAWTemplate } from '../MiniGames';
 import { TournamentRegistrationError, TournamentRegistrationStatusName, TournamentRegistrationTypeName } from '../Tournaments';
+import { AchievementAvailabilityStatus } from '../Missions';
 import { LeaderBoardPeriodType } from '../Leaderboard';
 import { AchCustomLayoutTheme, AchCustomSectionType, AchMissionsTabsOptions, AchOverviewMissionsFilter } from '../CustomSections';
 import { BonusStatus, BonusTemplateMetaMap, BonusMetaMap } from '../Bonuses';
@@ -44,7 +45,7 @@ export interface TMiniGamePrize {
     /** The custom data of the mini-game defined by operator in the BackOffice. Can be a JSON object, string or number */
     custom_data?: any;
     /** Prize modifiers that will multiply by 2x, 5x or 10x the current total. This will not affect the final Prize Amount that will be awarded. */
-    prize_modifiers?: PrizeModifiers;
+    prize_modifiers?: PrizeModifiers[];
     /** When enabled, you can split prize value by decimal values */
     allow_split_decimal?: boolean;
 }
@@ -120,6 +121,7 @@ export interface TMiniGameTemplate {
     activeFromDate?: number;
     activeTillDate?: number;
     steps_to_finish_game?: number;
+    custom_section_id?: number;
 }
 /**
  * TUser describes the information of the user
@@ -435,7 +437,7 @@ export interface TMissionOrBadge {
     active_from_ts: number;
     /** Holds time till mission will become unavailable, for the missions that are targeted to be available from specific date/time */
     active_till_ts: number;
-    /** The date when the mission was started, relevant for the time limited missions */
+    /** The date when the mission was started, relevant for the time limited missions, also indicating opt-it date for mission that requires opt-in and unlock date for Locked mission. */
     dt_start: number;
     /** The progress of the mission in percents calculated as the aggregated relative percentage of all tasks */
     progress: number;
@@ -490,6 +492,12 @@ export interface TMissionOrBadge {
     max_completion_count?: number;
     /** Current completion count for Recurring upon completion missions */
     completion_count?: number;
+    /** The date/timestamp for recurring missions, which indicating the time remaining until the next recurrence of the mission.
+     * Note that if a mission has an "Active till" date defined, this field is not relevant after that date.
+    */
+    next_recurrence_date_ts?: number;
+    /** Availability status of the mission depends on the defined time limits */
+    availability_status?: AchievementAvailabilityStatus;
 }
 export interface AchRelatedGame {
     /** The ID of the related game */

package/dist/index.js

@@ -409,6 +409,7 @@ var SAWTemplatesTransform = function SAWTemplatesTransform(items) {
       activeTillDate: r.activeTillDate,
       next_available_spin_ts: r.next_available_spin_ts,
       steps_to_finish_game: r.saw_template_ui_definition.steps_to_finish_game,
+      custom_section_id: r.saw_template_ui_definition.custom_section_id,
       prizes: r.prizes.map(function (p) {
         var y = {
           id: p.saw_prize_id,
@@ -926,6 +927,217 @@ exports.AchievementType = void 0;
   AchievementType[AchievementType["Badge"] = 2] = "Badge";
 })(exports.AchievementType || (exports.AchievementType = {}));
 
+/** Possible statuses of the mission availability.
+ *  Notes:
+ *   - Recurring missions have a special field next_recurrence_date_ts, but it's only relevant if the mission has no active till date or the next recurrence date is before the active till date.
+ *   - For a locked mission or mission that requires opt-in, the time limit should be calculated as dt_start + time_limit_ms. For a mission that does not require opt-in or type is not Locked, it should be the highest value of dt_start and active_from_ts (if defined) + time_limit_ms.
+ * */
+exports.AchievementAvailabilityStatus = void 0;
+(function (AchievementAvailabilityStatus) {
+  /** Mission without date/time restrictions or with passed active from date and no opt-in required and mission is unlocked */
+  AchievementAvailabilityStatus[AchievementAvailabilityStatus["Available"] = 0] = "Available";
+  /** Mission without date/time restrictions or with passed active from date, opt-in is required, user is not opted-in or mission is locked */
+  AchievementAvailabilityStatus[AchievementAvailabilityStatus["AvailableInactive"] = 1] = "AvailableInactive";
+  /** Mission without date/time restrictions or with passed active from date, opt-in is required, user is opted-in or mission is unlocked*/
+  AchievementAvailabilityStatus[AchievementAvailabilityStatus["AvailableActive"] = 2] = "AvailableActive";
+  /** Mission with active from date defined, date is in future.
+   * Field: active_from_ts
+  */
+  AchievementAvailabilityStatus[AchievementAvailabilityStatus["UnavailableWithActiveFrom"] = 3] = "UnavailableWithActiveFrom";
+  /** Mission with active till date defined, date is in future, and no opt-in required and mission is unlocked.
+   * Field: active_till_ts
+  */
+  AchievementAvailabilityStatus[AchievementAvailabilityStatus["AvailableWithActiveTill"] = 4] = "AvailableWithActiveTill";
+  /** Mission with active till date defined, date is in future, and opt-in is required, user is not opted in or mission is locked.
+   * Fields: active_till_ts, is_requires_optin, is_opted_in, is_locked.
+  */
+  AchievementAvailabilityStatus[AchievementAvailabilityStatus["AvailableWithActiveTillInactive"] = 5] = "AvailableWithActiveTillInactive";
+  /** Mission with active till date defined, date is in future, and opt-in is required, user is opted in or mission is unlocked.
+   * Fields: active_till_ts, is_requires_optin, is_opted_in, is_locked.
+  */
+  AchievementAvailabilityStatus[AchievementAvailabilityStatus["AvailableWithActiveTillActive"] = 6] = "AvailableWithActiveTillActive";
+  /** Available mission with time limit, and opt-in is required or mission is unlocked.
+   * The time limit is calculated as the sum of two properties: (highest value from dt_start and active_from_ts) + time_limit_ms.
+   *
+  */
+  AchievementAvailabilityStatus[AchievementAvailabilityStatus["AvailableLimited"] = 7] = "AvailableLimited";
+  /** Available mission with time limit, opt-in is required, user is not opted-in or mission is locked.
+   * Time limit at this stage is not relevant, user should be opted-in or mission should be unlocked.
+  */
+  AchievementAvailabilityStatus[AchievementAvailabilityStatus["AvailableLimitedInactive"] = 8] = "AvailableLimitedInactive";
+  /** Available mission with time limit, opt-in is required, user is opted-in or mission unlocked.
+    * The time limit is calculated as the sum of two properties: dt_start + time_limit_ms.
+   */
+  AchievementAvailabilityStatus[AchievementAvailabilityStatus["AvailableLimitedActive"] = 9] = "AvailableLimitedActive";
+  /** Available mission with time limit and active till date, opt-in is not required and mission is unlocked.
+   * Fields: active_till_ts, time_limit_ms, dt_start, active_from_ts;
+   * The time limit is calculated as the sum of two properties: (highest value from dt_start and active_from_ts) + time_limit_ms.
+  */
+  AchievementAvailabilityStatus[AchievementAvailabilityStatus["AvailableFullyLimited"] = 10] = "AvailableFullyLimited";
+  /** Available mission with time limit and active till date, opt-in is required, user is not opted in or mission is locked.
+    * Fields: active_till_ts, time_limit_ms, dt_start, active_from_ts, is_requires_optin, is_opted_in, is_locked.
+    * On this stage only active_till_ts is relevant. time_limit_ms is ignored because user should be opted in.
+   */
+  AchievementAvailabilityStatus[AchievementAvailabilityStatus["AvailableFullyLimitedInactive"] = 11] = "AvailableFullyLimitedInactive";
+  /** Available mission with time limit and active till date, opt-in is required, user is opted in or mission is unlocked.
+   * Fields: active_till_ts, time_limit_ms, dt_start, is_requires_optin, is_opted_in, is_locked.
+   * The time limit is calculated as the sum of two properties: dt_start + time_limit_ms.
+  */
+  AchievementAvailabilityStatus[AchievementAvailabilityStatus["AvailableFullyLimitedActive"] = 12] = "AvailableFullyLimitedActive";
+  /** Missed mission when active till date is already passed. is_completed field indicating if mission is completed or just missed  */
+  AchievementAvailabilityStatus[AchievementAvailabilityStatus["MissedByActiveTill"] = 13] = "MissedByActiveTill";
+  /** Missed mission when start_date + time_limit_ms is already passed. is_completed field indicating if mission is completed or just missed  */
+  AchievementAvailabilityStatus[AchievementAvailabilityStatus["MissedByLimitInTime"] = 14] = "MissedByLimitInTime";
+})(exports.AchievementAvailabilityStatus || (exports.AchievementAvailabilityStatus = {}));
+
+var _class;
+var MissionUtils = function MissionUtils() {};
+_class = MissionUtils;
+MissionUtils.getAvailabilityStatus = function (mission) {
+  if (!mission) {
+    return null;
+  }
+  var activeFrom = mission.active_from_ts ? _class.getMs(mission.active_from_ts) : null;
+  var activeTill = mission.active_till_ts ? _class.getMs(mission.active_till_ts) : null;
+  var startDate = mission.start_date_ts ? _class.getMs(mission.start_date_ts) : null;
+  var timeLimit = mission.time_limit_ms;
+  var requiresOptIn = mission.requiresOptin;
+  var optedIn = mission.isOptedIn;
+  var isLockedMission = mission.ach_status_id === exports.AchievementStatus.AvailableLocked;
+  var isLocked = mission.isLocked;
+  if (!activeFrom && !activeTill && !timeLimit) {
+    if (requiresOptIn) {
+      if (optedIn) {
+        return exports.AchievementAvailabilityStatus.AvailableActive;
+      } else {
+        return exports.AchievementAvailabilityStatus.AvailableInactive;
+      }
+    } else if (isLockedMission) {
+      if (!isLocked) {
+        return exports.AchievementAvailabilityStatus.AvailableActive;
+      } else {
+        return exports.AchievementAvailabilityStatus.AvailableInactive;
+      }
+    } else {
+      return exports.AchievementAvailabilityStatus.Available;
+    }
+  }
+  if (activeFrom && activeFrom > Date.now()) {
+    return exports.AchievementAvailabilityStatus.UnavailableWithActiveFrom;
+  }
+  if (activeFrom && activeFrom < Date.now() || !activeFrom) {
+    if (!activeTill && !timeLimit) {
+      if (requiresOptIn) {
+        if (optedIn) {
+          return exports.AchievementAvailabilityStatus.AvailableActive;
+        } else {
+          return exports.AchievementAvailabilityStatus.AvailableInactive;
+        }
+      } else if (isLockedMission) {
+        if (!isLocked) {
+          return exports.AchievementAvailabilityStatus.AvailableActive;
+        } else {
+          return exports.AchievementAvailabilityStatus.AvailableInactive;
+        }
+      } else {
+        return exports.AchievementAvailabilityStatus.Available;
+      }
+    }
+    if (activeTill && !timeLimit) {
+      if (activeTill > Date.now()) {
+        if (requiresOptIn) {
+          if (optedIn) {
+            return exports.AchievementAvailabilityStatus.AvailableWithActiveTillActive;
+          } else {
+            return exports.AchievementAvailabilityStatus.AvailableWithActiveTillInactive;
+          }
+        } else if (isLockedMission) {
+          if (!isLocked) {
+            return exports.AchievementAvailabilityStatus.AvailableWithActiveTillActive;
+          } else {
+            return exports.AchievementAvailabilityStatus.AvailableWithActiveTillInactive;
+          }
+        } else {
+          return exports.AchievementAvailabilityStatus.AvailableWithActiveTill;
+        }
+      } else {
+        return exports.AchievementAvailabilityStatus.MissedByActiveTill;
+      }
+    }
+    if (timeLimit && !activeTill) {
+      if (requiresOptIn) {
+        var endDate = startDate + timeLimit;
+        if (optedIn) {
+          if (endDate > Date.now()) {
+            return exports.AchievementAvailabilityStatus.AvailableLimitedActive;
+          } else {
+            return exports.AchievementAvailabilityStatus.MissedByLimitInTime;
+          }
+        } else {
+          return exports.AchievementAvailabilityStatus.AvailableLimitedInactive;
+        }
+      } else if (isLockedMission) {
+        var _endDate = startDate + timeLimit;
+        if (!isLocked) {
+          if (_endDate > Date.now()) {
+            return exports.AchievementAvailabilityStatus.AvailableLimitedActive;
+          } else {
+            return exports.AchievementAvailabilityStatus.MissedByLimitInTime;
+          }
+        } else {
+          return exports.AchievementAvailabilityStatus.AvailableLimitedInactive;
+        }
+      } else {
+        var _endDate2 = activeFrom && activeFrom > startDate ? activeFrom + timeLimit : startDate + timeLimit;
+        if (_endDate2 > Date.now()) {
+          return exports.AchievementAvailabilityStatus.AvailableLimited;
+        } else {
+          return exports.AchievementAvailabilityStatus.MissedByLimitInTime;
+        }
+      }
+    }
+    if (timeLimit && activeTill) {
+      if (activeTill > Date.now()) {
+        if (requiresOptIn) {
+          if (optedIn) {
+            var _endDate3 = startDate + timeLimit;
+            if (_endDate3 > Date.now()) {
+              return exports.AchievementAvailabilityStatus.AvailableFullyLimitedActive;
+            } else {
+              return exports.AchievementAvailabilityStatus.MissedByLimitInTime;
+            }
+          } else {
+            return exports.AchievementAvailabilityStatus.AvailableFullyLimitedInactive;
+          }
+        } else if (isLockedMission) {
+          if (!isLocked) {
+            var _endDate4 = startDate + timeLimit;
+            if (_endDate4 > Date.now()) {
+              return exports.AchievementAvailabilityStatus.AvailableFullyLimitedActive;
+            } else {
+              return exports.AchievementAvailabilityStatus.MissedByLimitInTime;
+            }
+          } else {
+            return exports.AchievementAvailabilityStatus.AvailableFullyLimitedInactive;
+          }
+        } else {
+          var _endDate5 = activeFrom && activeFrom > startDate ? activeFrom + timeLimit : startDate + timeLimit;
+          if (_endDate5 > Date.now()) {
+            return exports.AchievementAvailabilityStatus.AvailableFullyLimited;
+          } else {
+            return exports.AchievementAvailabilityStatus.MissedByLimitInTime;
+          }
+        }
+      } else {
+        return exports.AchievementAvailabilityStatus.MissedByActiveTill;
+      }
+    }
+  }
+};
+MissionUtils.getMs = function (ts) {
+  return new Date(ts).getTime();
+};
+
 var UserAchievementTransform = function UserAchievementTransform(items) {
   return items.filter(function (r) {
     return r.ach_id >= 1;
@@ -947,7 +1159,7 @@ var UserAchievementTransform = function UserAchievementTransform(items) {
       is_opted_in: r.isOptedIn,
       time_limit_ms: r.time_limit_ms,
       active_from_ts: r.active_from_ts,
-      active_till_ts: r.active_from_ts,
+      active_till_ts: r.active_till_ts,
       dt_start: r.start_date_ts,
       reward: r.ach_public_meta.reward,
       progress: r.progress,
@@ -997,8 +1209,12 @@ var UserAchievementTransform = function UserAchievementTransform(items) {
       completed_today: completedToday,
       completed_this_week: completedThisWeek,
       completed_this_month: completedThisMonth,
-      custom_section_type_id: r.ach_public_meta.custom_section_type_id
+      custom_section_type_id: r.ach_public_meta.custom_section_type_id,
+      availability_status: MissionUtils.getAvailabilityStatus(r)
     };
+    if (r.ach_status_id === exports.AchievementStatus.Recurring) {
+      x.next_recurrence_date_ts = r.next_recurrence_date_ts;
+    }
     if (r.ach_status_id === exports.AchievementStatus.RecurringUponCompletion) {
       x.completion_count = r.completed_count;
       x.max_completion_count = r.recurring_quantity;