@smartico/public-api 0.0.47 → 0.0.48

package/docs/interfaces/TMissionOrBadge.md

@@ -0,0 +1,167 @@
+# Interface: TMissionOrBadge
+
+TMissionOrBadge interface describes the information of mission or badge defined in the system
+
+## Properties
+
+### id
+
+• **id**: `number`
+
+ID of the mission or badge
+
+___
+
+### type
+
+• **type**: ``"mission"`` \| ``"badge"``
+
+Type of entity. Can be 'mission' or 'badge'
+
+___
+
+### name
+
+• **name**: `string`
+
+Name of the mission or badge, translated to the user language
+
+___
+
+### desription
+
+• **desription**: `string`
+
+Description of the mission or badge, translated to the user language
+
+___
+
+### reward
+
+• **reward**: `string`
+
+Description of the mission reward if defined
+
+___
+
+### image
+
+• **image**: `string`
+
+URL of the image of the mission or badge
+
+___
+
+### is\_completed
+
+• **is\_completed**: `boolean`
+
+Indicator if the mission is completed or badge is granted
+
+___
+
+### is\_locked
+
+• **is\_locked**: `boolean`
+
+Indicator if the mission is locked. Means that it's visible to the user, but he cannot progress in it until it's unlocked.
+Mission may optionally contain the explanation of what should be done to unlock it in the unlock_mission_description property
+
+___
+
+### unlock\_mission\_description
+
+• **unlock\_mission\_description**: `string`
+
+Optional explaination of what should be done to unlock the mission
+
+___
+
+### is\_requires\_optin
+
+• **is\_requires\_optin**: `boolean`
+
+Indicator if the mission requires opt-in. Means that user should explicitly opt-in to the mission in order to start progressing in it
+
+___
+
+### is\_opted\_in
+
+• **is\_opted\_in**: `boolean`
+
+Indicator if the user opted-in to the mission
+
+___
+
+### time\_limit\_ms
+
+• **time\_limit\_ms**: `number`
+
+The amount of time in milliseconds that user has to complete the mission
+
+___
+
+### dt\_start
+
+• **dt\_start**: `number`
+
+The date when the mission was started, relevant for the time limited missions
+
+___
+
+### progress
+
+• **progress**: `number`
+
+The progress of the mission in percents calculated as the aggregated relative percentage of all tasks
+
+___
+
+### cta\_action
+
+• **cta\_action**: `string`
+
+The action that should be performed when user clicks on the mission or badge
+Can be URL or deep link, e.g. 'dp:deposit'. The most safe to execute CTA is to pass it to _smartico.do(cta_action);
+The 'dp' function will handle the CTA and will execute it in the most safe way
+
+___
+
+### cta\_text
+
+• **cta\_text**: `string`
+
+The text of the CTA button, e.g. 'Make a deposit'
+
+___
+
+### custom\_section\_id
+
+• **custom\_section\_id**: `number`
+
+The ID of the custom section where the mission or badge is assigned
+The list of custom sections can be retrieved using _smartico.api.getCustomSections() method (TODO-API)
+
+___
+
+### only\_in\_custom\_section
+
+• **only\_in\_custom\_section**: `boolean`
+
+The indicator if the mission or badge is visible only in the custom section and should be hidden from the main overview of missions/badges
+
+___
+
+### custom\_data
+
+• **custom\_data**: `any`
+
+The custom data of the mission or badge defined by operator. Can be a JSON object, string or number
+
+___
+
+### tasks
+
+• **tasks**: [`TMissionOrBadgeTask`](TMissionOrBadgeTask.md)[]
+
+The list of tasks of the mission or badge

package/docs/interfaces/TMissionOrBadgeTask.md

@@ -0,0 +1,35 @@
+# Interface: TMissionOrBadgeTask
+
+TMissionOrBadgeTask interface describes the information of tasks that belings to mission or badge. See also TMissionOrBadge
+
+## Properties
+
+### id
+
+• **id**: `number`
+
+ID of the task
+
+___
+
+### name
+
+• **name**: `string`
+
+Name of the task, translated to the user language
+
+___
+
+### is\_completed
+
+• **is\_completed**: `boolean`
+
+Indicator if the task is completed
+
+___
+
+### progress
+
+• **progress**: `number`
+
+The progress of the task in percents

package/docs/interfaces/TUserProfile.md

@@ -0,0 +1,81 @@
+# Interface: TUserProfile
+
+TUser interface describes the information of the user
+The user object is returned by _smartico.api.getUserProfile() method.
+If you want to track the changes of the user profile, you can subscribe to the callback in the following way
+ _smartico.on('props_change', () => console.log(_smartico.api.getUserProfile()) );
+
+## Properties
+
+### core\_user\_language
+
+• **core\_user\_language**: `string`
+
+The language of the user
+
+___
+
+### ach\_points\_balance
+
+• **ach\_points\_balance**: `number`
+
+The current points balance that user can use in the Store, Mini-games, Tournaments, etc..
+
+___
+
+### ach\_points\_ever
+
+• **ach\_points\_ever**: `number`
+
+The amount of points that user collected in total
+
+___
+
+### core\_public\_tags
+
+• **core\_public\_tags**: `string`[]
+
+The array of the public tags set on the user object. 
+They can be treated as server-based cookies. 
+You can set tags using following method _smartico.event('core_public_tags_update', { core_public_tags: ['A', 'B'] } );
+And then you can check for the tags
+
+___
+
+### ach\_level\_current\_id
+
+• `Optional` **ach\_level\_current\_id**: `number`
+
+The ID of the current level of the user
+
+___
+
+### core\_is\_test\_account
+
+• `Optional` **core\_is\_test\_account**: `boolean`
+
+The indicator if user is marked as test user
+
+___
+
+### avatar\_url
+
+• `Optional` **avatar\_url**: `string`
+
+The URL to the user avatar
+
+___
+
+### public\_username
+
+• `Optional` **public\_username**: `string`
+
+The username of current user
+
+___
+
+### core\_inbox\_unread\_count
+
+• `Optional` **core\_inbox\_unread\_count**: `number`
+
+THe number of unread inbox messages

package/package.json

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

package/src/IntUtils.ts

@@ -32,6 +32,25 @@ class IntUtils {
         return v;
     }
 
+    public static JsonOrText = (str: string): any => {
+        if (str && str.includes && (str.includes('{') || str.includes('['))) {
+            try {
+                return JSON.parse(str)
+            } catch (e) {
+                return str;
+            }
+        }
+        return str;
+    }
+    
+    // public static wsTimeToEpoch = (time: string): number => {
+    //     if (time) {
+    //         return moment.utc(time, "DD/MM/YYYY HH:mm:ss").valueOf()
+    //     } else {
+    //         return null
+    //     }
+    // }    
+
 }
 
 

package/src/Level/GetLevelMapResponse.ts

@@ -1,7 +1,23 @@
 import { ProtocolResponse } from "../Base/ProtocolResponse";
+import { TLevel } from "../WSAPI/WSAPITypes";
 import { Level } from "./Level";
 
 export interface  GetLevelMapResponse extends ProtocolResponse {
 
     levels: Level[];
 }
+
+
+export const GetLevelMapResponseTransform = (levels: GetLevelMapResponse): TLevel[] => {
+    
+    return levels?.levels.map((l => ({
+        id: l.level_id,
+        name: l.level_public_meta.name,
+        description: l.level_public_meta.description,
+        image: l.level_public_meta.image_url,
+        required_points: l.required_points,
+        visibility_points: l.level_public_meta.visibility_points,
+        required_level_counter_1: l.required_level_counter_1,
+        required_level_counter_2: l.required_level_counter_2,
+    })));
+}

package/src/Missions/UserAchievement.ts

@@ -1,6 +1,9 @@
 
+import { IntUtils } from "../IntUtils";
+import { TMissionOrBadge } from "../WSAPI/WSAPITypes";
 import { AchievementPublicMeta } from "./AchievementPublicMeta";
 import { AchievementStatus } from "./AchievementStatus";
+import { AchievementTaskType } from "./AchievementTaskType";
 import { AchievementType } from "./AchievementType";
 import { UserAchievementTask } from "./UserAchievementTask";
 
@@ -23,3 +26,38 @@ export interface UserAchievement {
     ach_status_id?: AchievementStatus;
 }
 
+export const UserAchievementTransform = (items: UserAchievement[]): TMissionOrBadge[] => {
+
+    return items.filter( r => r.ach_id >= 1).map( r => (
+        {
+            id: r.ach_id,
+            name: r.ach_public_meta.name,
+            desription: r.ach_public_meta.description,
+            unlock_mission_description: r.ach_public_meta.unlock_mission_description,
+            image: r.ach_public_meta.image_url,
+            is_completed: r.isCompleted,
+            is_locked: r.isLocked,
+            is_requires_optin: r.requiresOptin,
+            is_opted_in: r.isOptedIn,
+            time_limit_ms: r.time_limit_ms,
+            dt_start: r.start_date as any, // TODO: convert to epoch
+            reward: r.ach_public_meta.reward,
+            progress: r.progress,
+            type: r.ach_type_id === AchievementType.Mission ? 'mission' : 'badge',
+            cta_action: r.ach_public_meta.cta_action,
+            cta_text: r.ach_public_meta.cta_text,
+            custom_section_id: r.ach_public_meta.custom_section_id,
+            only_in_custom_section: r.ach_public_meta.only_in_custom_section,
+            custom_data: IntUtils.JsonOrText(r.ach_public_meta.custom_data),
+            tasks: (r.achievementTasks || [])
+                .filter( t => t.task_type_id === AchievementTaskType.CompleteAchievement)
+                .map( t => ({
+                    id: t.task_id,
+                    name: t.task_public_meta?.name,
+                    is_completed: t.isCompleted,
+                    progress: t.userProgress,
+                }))
+        }
+    ));
+}    
+

package/src/SmarticoAPI.ts

@@ -12,21 +12,27 @@ import { GetLabelInfoResponse } from './Core/GetLabelInfoResponse';
 import { GetLabelInfoRequest } from './Core/GetLabelInfoRequest';
 import { GetInboxMessagesRequest, GetInboxMessagesResponse } from './Inbox';
 import { GetStoreItemsResponse } from './Store';
-import { AchievementType, GetAchievementMapRequest, GetAchievementMapResponse } from './Missions';
+import { AchievementType, GetAchievementMapRequest, GetAchievementMapResponse, UserAchievementTransform } from './Missions';
 import { GetTournamentInfoRequest, GetTournamentInfoResponse, GetTournamentsRequest, GetTournamentsResponse } from './Tournaments';
 import { GetLeaderBoardsRequest, GetLeaderBoardsResponse, LeaderBoardDetails, LeaderBoardPeriodType } from "./Leaderboard";
-import { GetLevelMapResponse } from "./Level";
+import { GetLevelMapResponse, GetLevelMapResponseTransform } from "./Level";
 import { WSAPI } from "./WSAPI/WSAPI";
+import { TLevel, TMissionOrBadge } from "./WSAPI/WSAPITypes";
 
 const PUBLIC_API_URL = 'https://papi{ENV_ID}.smartico.ai/services/public';
 const C_SOCKET_PROD = 'wss://api{ENV_ID}.smartico.ai/websocket/services';
 const AVATAR_DOMAIN = 'https://img{ENV_ID}.smr.vc';
 const DEFAULT_LANG_EN = "EN";
 
+interface Tracker {
+    label_api_key: string;
+    userPublicProps: any;
+}
 interface IOptions {
     logger?: ILogger;
     logCIDs?: ClassId[];
     logHTTPTiming?: boolean;
+    tracker?: Tracker;
 }
 
 type MessageSender = (message: any, publicApuUrl?: string, expectCID?: ClassId) => Promise<any>;
@@ -37,11 +43,12 @@ class SmarticoAPI {
     private publicUrl: string;
     private wsUrl: string;
     private partnerUrl: string;
-    private avatarDomain: string;
+    public avatarDomain: string;
 
     private logger: ILogger;
     private logCIDs: ClassId[];
     private logHTTPTiming: boolean;
+    public tracker?: Tracker;
 
     public constructor(private label_api_key: string, private brand_api_key: string, private messageSender: MessageSender, options: IOptions = {}) {
 
@@ -53,11 +60,12 @@ class SmarticoAPI {
 
         this.logCIDs = options.logCIDs || [];
         this.logHTTPTiming = options.logHTTPTiming || false;
+        this.tracker = options.tracker;
 
         this.publicUrl = SmarticoAPI.getPublicUrl(label_api_key);
         this.wsUrl = SmarticoAPI.getPublicWsUrl(label_api_key);
 
-        this.avatarDomain = SmarticoAPI.getAvatarUrl(label_api_key);
+        this.avatarDomain = SmarticoAPI.getAvatarUrl(label_api_key || options.tracker?.label_api_key);
 
         this.label_api_key = SmarticoAPI.getCleanLabelApiKey(label_api_key);
 
@@ -335,6 +343,10 @@ class SmarticoAPI {
         return response;
     }
 
+    public async missionsGetItemsT(user_ext_id?: string): Promise<TMissionOrBadge[]> {
+        return UserAchievementTransform((await this.missionsGetItems(user_ext_id)).achievements);
+    }
+
     public async badgetsGetItems(user_ext_id: string): Promise<GetAchievementMapResponse> {
 
         const message = this.buildMessage<GetAchievementMapRequest, GetAchievementMapResponse>(user_ext_id, ClassId.GET_ACHIEVEMENT_MAP_REQUEST);
@@ -410,10 +422,15 @@ class SmarticoAPI {
 
     }
 
-    public async levelsGet(user_ext_id?: string ): Promise<GetLevelMapResponse> {
+    public async levelsGet(user_ext_id?: string): Promise<GetLevelMapResponse> {
         const message = this.buildMessage<any, GetLevelMapResponse>(user_ext_id, ClassId.GET_LEVEL_MAP_REQUEST);
         return await this.send<GetLevelMapResponse>(message, ClassId.GET_LEVEL_MAP_RESPONSE);
     }
+
+    public async levelsGetT(user_ext_id?: string): Promise<TLevel[]> {
+        return GetLevelMapResponseTransform(await this.levelsGet(user_ext_id));
+    }
+
     
     public getWSCalls(): WSAPI {
         return new WSAPI(this);

package/src/WSAPI/WSAPI.ts

@@ -1,18 +1,34 @@
+import { CoreUtils } from "../Core";
 import { SmarticoAPI } from "../SmarticoAPI";
 
-import { GetLevelMapClearedResponse, levelCleaner } from "./WSAPITypes";
+import { TLevel, TMissionOrBadge, TUserProfile } from "./WSAPITypes";
 
 /** @group General API */
 export class WSAPI {
-    private static api: SmarticoAPI;
-    
+
     /** @private */
-    constructor(api: SmarticoAPI) {
-        WSAPI.api = api;
+    constructor(private api: SmarticoAPI) {
     }
 
-    public async getLevelsTransformed(): Promise<GetLevelMapClearedResponse[]> {
-        const levels = await WSAPI.api.levelsGet(null);
-        return levelCleaner(levels);
+    /** Returns all the levels available the current user */
+    public async getUserProfile(): Promise<TUserProfile> {
+        if (this.api.tracker) {
+            const o: TUserProfile = Object.assign({}, this.api.tracker.userPublicProps);
+            o.avatar_url = CoreUtils.avatarUrl(this.api.tracker.userPublicProps.avatar_id, this.api.avatarDomain);
+            return o;
+        } else {
+            throw new Error('Tracker is not initialized, cannot getUserProfile');
+        }
+    }    
+
+    /** Returns all the levels available the current user */
+    public async getLevels(): Promise<TLevel[]> {
+        return this.api.levelsGetT(null);
     }
+
+    /** Returns all the missions available the current user */
+    public async getMissions(): Promise<TMissionOrBadge[]> {
+        return this.api.missionsGetItemsT(null);
+    }
+
 }

package/src/WSAPI/WSAPITypes.ts

@@ -1,29 +1,139 @@
-import { GetLevelMapResponse } from "../Level"
 
-// Levels
+/**
+ * TUser interface describes the information of the user
+ * The user object is returned by _smartico.api.getUserProfile() method.
+ * If you want to track the changes of the user profile, you can subscribe to the callback in the following way
+ *  _smartico.on('props_change', () => console.log(_smartico.api.getUserProfile()) );
+*/
 
-/** @group Levels response */
-export interface GetLevelMapClearedResponse {
+export interface TUserProfile {
+    /** The language of the user */
+    core_user_language: string;
+    /** The current points balance that user can use in the Store, Mini-games, Tournaments, etc.. */
+    ach_points_balance: number;
+    /** The amount of points that user collected in total */
+    ach_points_ever: number;
+    /** 
+     * The array of the public tags set on the user object. 
+     * They can be treated as server-based cookies. 
+     * You can set tags using following method _smartico.event('core_public_tags_update', { core_public_tags: ['A', 'B'] } );
+     * And then you can check for the tags
+    */  
+    core_public_tags: string[];
+    /** The ID of the current level of the user */
+    ach_level_current_id?: number;
+    /** The indicator if user is marked as test user */
+    core_is_test_account?: boolean;
+    /** The URL to the user avatar */
+    avatar_url?: string;
+    /** The username of current user */
+    public_username?: string;
+    /** THe number of unread inbox messages */
+    core_inbox_unread_count?: number;
+}
+
+/** 
+ * TLevel interface describes the information of each level defined in the system
+ * There is no order of the levels, but it can be calculated using required_points property
+ * The current level of user can be taken from the user object using ach_level_current_id property
+ * The progress to the next level can be calculated using ach_points_ever and required_points properties of next level
+ */
+export interface TLevel {
 
+    /** The ID of the Level */
     id: number,
+    /** The name of the Level, translated to the user language */
     name: string,
+    /** The description of the Level, translated to the user language */
     description: string,
+    /** The URL of the image of the Level */
     image: string,
+    /** The amount of points required to reach the Level */
     required_points: number,
+    /** Number of points that user should collect in order to see this level */
+    visibility_points: number;    
+    /** 
+     * The counter of 1st metric used to reach the Level. 
+     * Relevant in case of using advanced leveling logic
+     * https://help.smartico.ai/welcome/more/release-notes/september-2022#new-logic-for-leveling-users
+     * 
+    */
     required_level_counter_1: number,
+    /** 
+     * The counter of 2nd metric used to reach the Level. 
+     * Relevant in case of using advanced leveling logic
+     * https://help.smartico.ai/welcome/more/release-notes/september-2022#new-logic-for-leveling-users
+     * 
+    */    
     required_level_counter_2: number,
 }
 
-/** @hidden */
-export const levelCleaner = (levels: GetLevelMapResponse): GetLevelMapClearedResponse[] => {
-    
-    return levels?.levels.map((l => ({
-        id: l.level_id,
-        name: l.level_public_meta.name,
-        description: l.level_public_meta.description,
-        image: l.level_public_meta.image_url,
-        required_points: l.required_points,
-        required_level_counter_1: l.required_level_counter_1,
-        required_level_counter_2: l.required_level_counter_2,
-    })));
+/** 
+ * TMissionOrBadge interface describes the information of mission or badge defined in the system
+ */
+export interface TMissionOrBadge {
+    /** ID of the mission or badge  */
+    id: number;
+    /** Type of entity. Can be 'mission' or 'badge' */
+    type: 'mission' | 'badge',
+    /** Name of the mission or badge, translated to the user language */
+    name: string;
+    /** Description of the mission or badge, translated to the user language */
+    desription: string;
+    /** Description of the mission reward if defined */
+    reward: string;
+    /** URL of the image of the mission or badge */
+    image: string;
+    /** Indicator if the mission is completed or badge is granted */
+    is_completed: boolean;
+    /** Indicator if the mission is locked. Means that it's visible to the user, but he cannot progress in it until it's unlocked.
+     * Mission may optionally contain the explanation of what should be done to unlock it in the unlock_mission_description property
+     */
+    is_locked: boolean;
+    /** Optional explaination of what should be done to unlock the mission */
+    unlock_mission_description: string;
+    /** Indicator if the mission requires opt-in. Means that user should explicitly opt-in to the mission in order to start progressing in it */
+    is_requires_optin: boolean;
+    /** Indicator if the user opted-in to the mission */
+    is_opted_in: boolean;
+    /** The amount of time in milliseconds that user has to complete the mission */
+    time_limit_ms: number
+    /** The date when the mission was started, relevant for the time limited missions */
+    dt_start: number;
+    /** The progress of the mission in percents calculated as the aggregated relative percentage of all tasks */
+    progress: number;
+    /** 
+     * The action that should be performed when user clicks on the mission or badge
+     * Can be URL or deep link, e.g. 'dp:deposit'. The most safe to execute CTA is to pass it to _smartico.do(cta_action);
+     * The 'dp' function will handle the CTA and will execute it in the most safe way
+     */
+    cta_action: string,
+    /** The text of the CTA button, e.g. 'Make a deposit' */
+    cta_text: string,
+    /** 
+     * The ID of the custom section where the mission or badge is assigned
+     * The list of custom sections can be retrieved using _smartico.api.getCustomSections() method (TODO-API)
+    */
+    custom_section_id: number,
+    /** The indicator if the mission or badge is visible only in the custom section and should be hidden from the main overview of missions/badges */
+    only_in_custom_section: boolean,
+    /** The custom data of the mission or badge defined by operator. Can be a JSON object, string or number */
+    custom_data: any,
+
+    /** The list of tasks of the mission or badge */
+    tasks: TMissionOrBadgeTask[]
+}
+
+/** 
+ * TMissionOrBadgeTask interface describes the information of tasks that belings to mission or badge. See also TMissionOrBadge
+ */
+export interface TMissionOrBadgeTask {
+    /** ID of the task */
+    id: number,
+    /** Name of the task, translated to the user language */
+    name: string,
+    /** Indicator if the task is completed */
+    is_completed: boolean,
+    /** The progress of the task in percents */
+    progress: number
 }