@smartico/public-api 0.0.437 → 0.0.439

package/docs/ui/missions/UIGuide_getMissions.md

@@ -31,7 +31,9 @@ note below):
      recurring), so only compare against it when it is set.
      Sort: `complete_date_ts` DESC (most recent first).
   3. **Locked** — `is_locked === true`, OR not yet available
-     (`active_from_ts > Date.now()`). Sort: `position` ASC.
+     (`active_from_ts > Date.now()`), OR outside its active weekdays /
+     days of the month (`activity_period_next_start_ts > Date.now()`).
+     Sort: `position` ASC.
   4. **In progress** — `is_opted_in === true`, OR (no opt-in required and
      `progress > 0`). Sort: `position` ASC.
   5. **Available** — everything else: opt-in required but not yet joined, or
@@ -108,6 +110,8 @@ Top-to-bottom structure (omit sections whose source field is empty):
   7. Lock icon overlay on the image when `is_locked === true`.
   8. Time-remaining block — "Available again in" countdown for
      recurring waiting; "Starts on" for `active_from_ts > now`;
+     "Opens in" countdown to `activity_period_next_start_ts` while it is
+     in the future (refetch with `getMissions` when it elapses);
      "Expired on" for missed; countdown for in-window.
   9. Full `description` (HTML).
   10. Action button — see the decision matrix below.
@@ -152,6 +156,8 @@ Apply in priority order; **first match wins**:
   5. `is_requires_optin && !is_opted_in` (and not locked) →
      **"Opt In" button**. Disable when:
        - `active_from_ts > Date.now()` (not yet started),
+       - `activity_period_next_start_ts > Date.now()` (outside its active
+         days — the server refuses the opt-in with `40013`),
        - the mission falls in the Missed bucket,
        - `active_till_ts && active_till_ts < Date.now()` (expired).
      While the opt-in request is in flight, show a loading indicator

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@smartico/public-api",
-	"version": "0.0.437",
+	"version": "0.0.439",
 	"description": "Smartico public API",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",

package/src/MiniGames/SAWGetTemplatesResponse.ts

@@ -31,6 +31,15 @@ const sawPrizeValue = (p: SAWPrize): number => {
 	return n > 0 ? n : p.prize_value;
 };
 
+const GEMS_DIAMONDS_TYPES: TMiniGamePrize['gems_diamonds_type'][] = ['gems', 'diamonds', 'gems-and-diamonds'];
+
+/** Which currency a gems-and-diamonds prize gives (`_gems_diamonds_type`: 0 gems, 1 diamonds, 2 both). */
+const sawGemsDiamondsType = (p: SAWPrize): TMiniGamePrize['gems_diamonds_type'] => {
+	if (p.prize_type_id !== SAWPrizeType.GEMS_AND_DIAMONDS) return undefined;
+	const d = p.prize_details_json;
+	return GEMS_DIAMONDS_TYPES[d?._gems_diamonds_type] ?? (d?.gems && d?.diamonds ? 'gems-and-diamonds' : d?.diamonds ? 'diamonds' : 'gems');
+};
+
 export const SAWTemplatesTransform = (items: SAWTemplate[]): TMiniGameTemplate[] => {
 	return items.map((r) => {
 		const x: TMiniGameTemplate = {
@@ -85,6 +94,7 @@ export const SAWTemplatesTransform = (items: SAWTemplate[]): TMiniGameTemplate[]
 					name: p.saw_prize_ui_definition.name,
 					prize_type: MiniGamePrizeTypeNamed(p.prize_type_id),
 					prize_value: sawPrizeValue(p),
+					gems_diamonds_type: sawGemsDiamondsType(p),
 					font_size: p.saw_prize_ui_definition.font_size,
 					font_size_mobile: p.saw_prize_ui_definition.font_size_mobile,
 					icon: p.saw_prize_ui_definition.icon,

package/src/Missions/AchievementAvailabilityStatus.ts

@@ -14,8 +14,8 @@ export enum AchievementAvailabilityStatus {
     /** 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
+    /** Mission with active from date defined, date is in future, or a mission available only on some weekdays / days of the month that is outside its active days.
+     * Field: activity_period_next_start_ts when set (the time the mission opens next), otherwise active_from_ts
     */
     UnavailableWithActiveFrom = 3,
 

package/src/Missions/MissionsUtils.ts

@@ -56,6 +56,11 @@ export class MissionUtils {
             return null;
         }
 
+        // a mission available only on some weekdays / days of the month, currently outside them
+        if (mission.activity_period_next_start_ts && MissionUtils.getMs(mission.activity_period_next_start_ts) > Date.now()) {
+            return AchievementAvailabilityStatus.UnavailableWithActiveFrom;
+        }
+
         const activeFrom = mission.active_from_ts ? MissionUtils.getMs(mission.active_from_ts) : null
         const activeTill = mission.active_till_ts ? MissionUtils.getMs(mission.active_till_ts) : null;
         const startDate = mission.start_date_ts ? MissionUtils.getMs(mission.start_date_ts) : null;

package/src/Missions/UserAchievement.ts

@@ -35,6 +35,7 @@ export interface UserAchievement {
 	related_games?: AchRelatedGame[];
 	active_from_ts?: number; // indicates when 'scheduled' mission is active from,
 	active_till_ts?: number; // indicates when 'scheduled' mission is active till,
+	activity_period_next_start_ts?: number; // when a mission limited to some weekdays / days of the month opens next; set only while it is outside its active days
 	ach_categories?: number[];
 	recurring_quantity?: number; // max completion count for Recurring upon completion
 	completed_count?: number; // completion count for Recurring upon completion
@@ -102,6 +103,7 @@ export const UserAchievementTransform = (items: UserAchievement[]): TMissionOrBa
 				time_limit_ms: r.time_limit_ms,
 				active_from_ts: r.active_from_ts,
 				active_till_ts: r.active_till_ts,
+				activity_period_next_start_ts: r.activity_period_next_start_ts,
 				dt_start: r.start_date_ts,
 				reward: r.ach_public_meta.reward,
 				progress: r.progress,

package/src/WSAPI/WSAPIMissions.ts

@@ -61,6 +61,10 @@ export class WSAPIMissions extends WSAPIGeneral {
 	 * - `RECURRING` missions between cycles, until the next cycle starts.
 	 * - `RECURRING_QUANTITY` missions outside their `active_from_ts` /
 	 *   `active_till_ts` window.
+	 * - Missions available only on some weekdays or days of the month, while
+	 *   outside those days — unless the mission is configured to be shown
+	 *   before it opens (then it arrives with `activity_period_next_start_ts`),
+	 *   and always once it will not open again. Completed missions stay.
 	 *
 	 * Client-side filtering you may still want: missions with
 	 * `only_in_custom_section: true` are intended for their custom-section
@@ -79,7 +83,9 @@ export class WSAPIMissions extends WSAPIGeneral {
 	 *    missions) at least one cycle done / the cap reached — see the recurring
 	 *    caveats below. Sort by `complete_date_ts` DESC.
 	 * 3. **Locked** — `is_locked === true`, OR not yet started
-	 *    (`active_from_ts > Date.now()`). Sort by `position` ASC.
+	 *    (`active_from_ts > Date.now()`), OR outside its active days
+	 *    (`activity_period_next_start_ts > Date.now()` — show an "opens in"
+	 *    countdown to it, and refetch when it elapses). Sort by `position` ASC.
 	 * 4. **In-progress** — `is_opted_in === true`, OR (no opt-in required and
 	 *    `progress > 0`). Sort by `position` ASC.
 	 * 5. **Available** — everything else (opt-in required but not yet joined, or
@@ -416,8 +422,9 @@ export class WSAPIMissions extends WSAPIGeneral {
 	 *   means local mission state was stale (e.g. user opted in from another
 	 *   session/tab).
 	 * - `40013` — mission not opt-in-able: missing `requires_optin`, in
-	 *   DRAFT/ARCHIVED state, or outside its `active_from_ts` /
-	 *   `active_till_ts` window.
+	 *   DRAFT/ARCHIVED state, outside its `active_from_ts` /
+	 *   `active_till_ts` window, or outside its active weekdays / days of the
+	 *   month (`activity_period_next_start_ts` is set).
 	 * - `40014` — mission is locked; user has unlock-tasks remaining.
 	 *   Surface the mission's `unlock_mission_description` to guide them.
 	 * - other non-zero — generic server error. Surface `err_message` if any.

package/src/WSAPI/WSAPITypes.ts

@@ -33,6 +33,8 @@ export interface TMiniGamePrize {
 	 * For example for prize '100 points' the prize_value will be 100, for '100 free spins' 100, for '50 Diamonds' 50.
 	*/
 	prize_value?: number;
+	/** For 'gems-and-diamonds' prizes — which currency the prize gives: 'gems', 'diamonds', or 'gems-and-diamonds' (both; `prize_value` is then their sum). Absent for other types */
+	gems_diamonds_type?: 'gems' | 'diamonds' | 'gems-and-diamonds';
 	/** Custom font size in px for rendering the prize name on the game surface (e.g. a wheel sector), desktop */
 	font_size?: number;
 	/** Custom font size in px for the prize name, mobile; falls back to `font_size` when absent */
@@ -885,6 +887,9 @@ export interface TMissionOrBadge {
 	/** Holds time till mission will become unavailable, for the missions that are targeted to be available from specific date/time */
 	active_till_ts: number;
 
+	/** Time (epoch ms) when a mission that is available only on some weekdays or days of the month opens next. Set only while the mission is outside its active days and is shown before it opens; absent when it is open now or has no such limit */
+	activity_period_next_start_ts?: number;
+
 	/** 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 */