@smartico/public-api 0.0.5 → 0.0.7

package/src/Inbox/GetInboxMessagesResponse.ts

@@ -0,0 +1,7 @@
+import { ProtocolResponse } from "../Base/ProtocolResponse";
+import { InboxMessage } from "./InboxMessage";
+
+export interface GetInboxMessagesResponse extends ProtocolResponse {
+
+    log: InboxMessage[];
+}

package/src/Inbox/InboxMessage.ts

@@ -0,0 +1,16 @@
+import { InboxMessageType } from "./InboxMessageType";
+
+export interface InboxMessage {
+
+    createDate: string;
+    body: {
+        action: string;
+        body: string;
+        type: InboxMessageType;
+        image: string;
+        title: string;
+        html_body: string;
+    };
+    engagement_uuid: string;
+    ff: string;
+}

package/src/Inbox/InboxMessageType.ts

@@ -0,0 +1,13 @@
+export enum InboxMessageType {
+    Custom = 0,
+    MissionCompleted = 1,
+    MissionUnlocked = 2,
+    LeaderboardWon = 3,
+    LevelChanged = 4,
+    BonusGiven = 5,
+    PointsAdded = 6,
+    PointsUsed = 7,
+    PersonalMessage = 8
+}
+
+// keep in sync with BO enum

package/src/Inbox/index.ts

@@ -0,0 +1,11 @@
+import { GetInboxMessagesRequest } from "./GetInboxMessagesRequest";
+import { GetInboxMessagesResponse } from "./GetInboxMessagesResponse";
+import { InboxMessage } from "./InboxMessage";
+import { InboxMessageType } from "./InboxMessageType";
+
+export {
+    InboxMessage,
+    InboxMessageType,
+    GetInboxMessagesRequest,
+    GetInboxMessagesResponse,
+}

package/src/Leaderboard/GetLeaderBoardsRequest.ts

@@ -0,0 +1,11 @@
+import { ProtocolMessage } from "../Base/ProtocolMessage";
+import { LeaderBoardPeriodType } from "./LeaderBoardPeriodType";
+
+
+export interface  GetLeaderBoardsRequest extends ProtocolMessage {
+    // if not set will return all boards
+    period_type_id?: LeaderBoardPeriodType;
+    // can be >=1, if set will return snapshot for the previous period (1), or period before previous (2) etc
+    snapshot_offset?: number;
+    include_users?: boolean;
+}

package/src/Leaderboard/GetLeaderBoardsResponse.ts

@@ -0,0 +1,8 @@
+import { ProtocolResponse } from "../Base/ProtocolResponse";
+import { LeaderBoardDetails } from "./LeaderBoardDetails";
+
+export interface  GetLeaderBoardsResponse extends ProtocolResponse {
+
+    map: { [key: string]: LeaderBoardDetails };
+}
+

package/src/Leaderboard/LeaderBoardDetails.ts

@@ -0,0 +1,15 @@
+import { LeaderBoardPeriodType } from "./LeaderBoardPeriodType";
+import { LeaderBoardPosition } from "./LeaderBoardPosition";
+import { LeaderBoardPublicMeta } from "./LeaderBoardPublicMeta";
+
+export interface LeaderBoardDetails {
+
+    board_id: number;
+    period_type_id: LeaderBoardPeriodType;
+    create_date?: number; // 0 for the current
+    versiod_id: number; // 0 for the current
+    reward_points: number[];
+    board_public_meta: LeaderBoardPublicMeta;
+    positions: LeaderBoardPosition[];
+    userPosition: LeaderBoardPosition;
+}

package/src/Leaderboard/LeaderBoardPeriodType.ts

@@ -0,0 +1,5 @@
+export enum LeaderBoardPeriodType {
+    DAILY = 1,
+    WEEKLY = 2,
+    MONTHLY = 3
+}

package/src/Leaderboard/LeaderBoardPosition.ts

@@ -0,0 +1,12 @@
+export interface LeaderBoardPosition {
+
+    public_username?: string;
+    user_alt_name: string; // TODO Need remove it in future
+    position_in_board: number;
+    points_accumulated: number;
+    is_me: boolean;
+    level_id: number;
+    avatar_id: string;
+
+    avatar_url?: string;
+}

package/src/Leaderboard/LeaderBoardPublicMeta.ts

@@ -0,0 +1,6 @@
+export interface LeaderBoardPublicMeta {
+
+    name: string;
+    description: string;
+    rules: string;
+}

package/src/Leaderboard/index.ts

@@ -0,0 +1,17 @@
+import { GetLeaderBoardsRequest } from "./GetLeaderBoardsRequest";
+import { GetLeaderBoardsResponse } from "./GetLeaderBoardsResponse";
+import { LeaderBoardDetails } from "./LeaderBoardDetails";
+import { LeaderBoardPeriodType } from "./LeaderBoardPeriodType";
+import { LeaderBoardPosition } from "./LeaderBoardPosition";
+import { LeaderBoardPublicMeta } from "./LeaderBoardPublicMeta";
+
+
+export {
+    GetLeaderBoardsRequest,
+    GetLeaderBoardsResponse,
+    LeaderBoardDetails,
+    LeaderBoardPeriodType,
+    LeaderBoardPosition,
+    LeaderBoardPublicMeta,
+
+}

package/src/Missions/AchievementOptinRequest.ts

@@ -0,0 +1,7 @@
+import { ProtocolMessage } from "../Base/ProtocolMessage";
+
+
+export interface AchievementOptinRequest extends ProtocolMessage {
+
+    achievementId: number;
+}

package/src/Missions/AchievementOptinResponse.ts

@@ -0,0 +1,5 @@
+import { ProtocolResponse } from "../Base/ProtocolResponse";
+
+export interface AchievementOptinResponse extends ProtocolResponse {
+
+}

package/src/Missions/AchievementPublicMeta.ts

@@ -0,0 +1,17 @@
+export interface AchievementPublicMeta {
+
+    description?: string;
+    unlock_mission_description?: string;
+    cta_text?: string;
+    cta_action?: string;
+    label_tag?: string;
+    reward?: string;
+    image_url?: string;
+    name?: string;
+    position?: number;
+    hide_tasks?: boolean;
+    hide_locked_mission?: boolean;
+    custom_section_id?: number;
+    only_in_custom_section?: boolean;
+
+}

package/src/Missions/AchievementStatus.ts

@@ -0,0 +1,9 @@
+export enum AchievementStatus {
+
+    Draft = 1,
+    AvailableUnlocked = 2,
+    AvailableLocked = 3,
+    Archived = 4,
+    FeaturedManually = 5,
+    FeaturedAI = 6
+}

package/src/Missions/AchievementTaskPublicMeta.ts

@@ -0,0 +1,4 @@
+export interface AchievementTaskPublicMeta {
+
+    name?: string;
+}

package/src/Missions/AchievementTaskType.ts

@@ -0,0 +1,4 @@
+export enum AchievementTaskType {
+    CompleteAchievement = 1,
+    UnlockAchievement = 2
+}

package/src/Missions/AchievementType.ts

@@ -0,0 +1,5 @@
+export enum AchievementType {
+
+    Mission = 1,
+    Badge = 2
+}

package/src/Missions/GetAchievementMapRequest.ts

@@ -0,0 +1,5 @@
+import { ProtocolMessage } from "../Base/ProtocolMessage";
+
+export interface GetAchievementMapRequest extends ProtocolMessage {
+
+}

package/src/Missions/GetAchievementMapResponse.ts

@@ -0,0 +1,8 @@
+import { ProtocolResponse } from "../Base/ProtocolResponse";
+import { UserAchievement } from "./UserAchievement";
+
+
+export interface GetAchievementMapResponse extends ProtocolResponse {
+
+    achievements?: UserAchievement[];
+}

package/src/Missions/ReloadAchievementsEvent.ts

@@ -0,0 +1,5 @@
+import { ProtocolResponse } from "../Base/ProtocolResponse";
+
+export interface ReloadAchievementsEvent extends ProtocolResponse {
+
+}

package/src/Missions/UserAchievement.ts

@@ -0,0 +1,25 @@
+
+import { AchievementPublicMeta } from "./AchievementPublicMeta";
+import { AchievementStatus } from "./AchievementStatus";
+import { AchievementType } from "./AchievementType";
+import { UserAchievementTask } from "./UserAchievementTask";
+
+export interface UserAchievement {
+
+    ach_id?: number;
+    ach_type_id?: AchievementType;
+    ach_public_meta?: AchievementPublicMeta;
+    isCompleted?: boolean;
+    isLocked?: boolean;
+    requiresOptin?: boolean;
+    isOptedIn?: boolean;
+    start_date?: string; // time when mission unlocked or opted-in. Needed to calculated "remaining time" in case time_limit_ms is set
+    time_limit_ms?: number;
+    progress?: number;
+    complete_date?: string;
+    unlock_date?: string;
+    completed_tasks?: number;
+    achievementTasks?: UserAchievementTask[];
+    ach_status_id?: AchievementStatus;
+}
+

package/src/Missions/UserAchievementTask.ts

@@ -0,0 +1,17 @@
+import { AchievementTaskPublicMeta } from "./AchievementTaskPublicMeta";
+import { AchievementTaskType } from "./AchievementTaskType";
+
+export interface UserAchievementTask {
+
+    task_id?: number;
+    task_public_meta?: AchievementTaskPublicMeta;
+    points_reward?: number;
+    task_type_id: AchievementTaskType;
+    isCompleted?: boolean;
+    userExecutedCount?: number;
+    userProgress?: number;
+    lastExecutionDate: string;
+    unlocked_by_mission_id?: number;
+    unlocked_by_level_id?: number;
+}
+

package/src/Missions/index.ts

@@ -0,0 +1,28 @@
+import { AchievementOptinRequest } from "./AchievementOptinRequest";
+import { AchievementOptinResponse } from "./AchievementOptinResponse";
+import { AchievementPublicMeta } from "./AchievementPublicMeta";
+import { AchievementStatus } from "./AchievementStatus";
+import { AchievementTaskPublicMeta } from "./AchievementTaskPublicMeta";
+import { AchievementTaskType } from "./AchievementTaskType";
+import { AchievementType } from "./AchievementType";
+import { GetAchievementMapRequest } from "./GetAchievementMapRequest";
+import { GetAchievementMapResponse } from "./GetAchievementMapResponse";
+import { ReloadAchievementsEvent } from "./ReloadAchievementsEvent";
+import { UserAchievement } from "./UserAchievement";
+import { UserAchievementTask } from "./UserAchievementTask";
+
+
+export {
+    AchievementOptinRequest,
+    AchievementOptinResponse,
+    AchievementPublicMeta,
+    AchievementStatus,
+    AchievementTaskPublicMeta,
+    AchievementTaskType,
+    AchievementType,
+    GetAchievementMapRequest,
+    GetAchievementMapResponse,
+    ReloadAchievementsEvent,
+    UserAchievement,
+    UserAchievementTask,
+}

package/src/NodeCache.ts

@@ -0,0 +1,45 @@
+
+class NodeCache {
+
+    private static ttlChecker: NodeJS.Timeout;
+
+    private static cache: { [key: string] : any } = {};
+
+    constructor() {
+        if (NodeCache.ttlChecker === undefined) {
+            NodeCache.ttlChecker = setInterval(() => {
+                const now = new Date().getTime();
+                for (const key in NodeCache.cache) {
+                    if (NodeCache.cache.hasOwnProperty(key)) {
+                        const o = NodeCache.cache[key];
+                        if (o.ttl < now) {
+                            delete NodeCache.cache[key];
+                        }
+                    }
+                }
+            }, 1000);
+        }
+    }
+
+    public get(key: string): any {
+        const o = NodeCache.cache[key];
+        if (o !== undefined && o.ttl > new Date().getTime()) {
+            return o.value;
+        }
+    }
+
+    public set(key: string, value: any, ttlSeconds: number = 60) {
+        NodeCache.cache[key] = {
+            value,
+            ttl: new Date().getTime() + ttlSeconds * 1000
+        }
+    }
+
+    public flushAll() {
+        NodeCache.cache = {};
+    }
+
+}
+
+
+export { NodeCache }

package/src/OCache.ts

@@ -1,4 +1,5 @@
-import NodeCache from 'node-cache';
+import { NodeCache } from "./NodeCache";
+
 
 export enum ECacheContext {
     Translations,
@@ -18,7 +19,7 @@ export class OCache {
         const key = cacheContext.toString() + '_' + JSON.stringify(oKey);
 
         if (this.cache[cacheContext] === undefined) {
-            this.cache[cacheContext] = new NodeCache( { useClones: !WITH_REF_CACHE.includes(cacheContext) } );
+            this.cache[cacheContext] = new NodeCache( );
         }
 
         return this.cache[cacheContext].get(key);

package/src/SmarticoAPI.ts

@@ -12,6 +12,7 @@ import { ECacheContext, OCache } from './OCache';
 import { GetTranslationsRequest, GetTranslationsResponse, ResponseIdentify, TranslationArea } from './Core';
 import { GetLabelInfoResponse } from './Core/GetLabelInfoResponse';
 import { GetLabelInfoRequest } from './Core/GetLabelInfoRequest';
+import { GetInboxMessagesRequest, GetInboxMessagesResponse } from './Inbox';
 
 const PUBLIC_API_URL = 'https://papi{ENV_ID}.smartico.ai/services/public';
 const AVATAR_DOMAIN = 'https://img{ENV_ID}.smr.vc';
@@ -182,9 +183,9 @@ class SmarticoAPI {
         
         return OCache.use<GetLabelInfoResponse>(`${this.label_api_key} - ${this.brand_api_key}`, ECacheContext.LabelInfo, async () => {
 
-            const message = this.buildMessage<GetLabelInfoResponse, GetLabelInfoRequest>(user_ext_id, ClassId.GET_LABEL_INFO);
+            const message = this.buildMessage<GetLabelInfoResponse, GetLabelInfoRequest>(user_ext_id, ClassId.INIT);
 
-            return this.send<GetLabelInfoResponse>(message, ClassId.GET_LABEL_INFO_RESPONSE)
+            return this.send<GetLabelInfoResponse>(message, ClassId.INIT_RESPONSE)
             
         }, cacheSec);
         
@@ -207,11 +208,11 @@ class SmarticoAPI {
 
     public async coreChangeUsername(user_ext_id: string, public_username_custom: string): Promise<{ public_username_custom: string }> {
         
-        const message = this.buildMessage<any, any>(user_ext_id, ClassId.CHANGE_USERNAME, {
+        const message = this.buildMessage<any, any>(user_ext_id, ClassId.CLIENT_SET_CUSTOM_USERNAME_REQUEST, {
             public_username_custom
         });
         
-        return this.send(message, ClassId.CHANGE_USERNAME_RESPONSE);
+        return this.send(message, ClassId.CLIENT_SET_CUSTOM_USERNAME_RESPONSE);
     }
 
 
@@ -291,6 +292,19 @@ class SmarticoAPI {
         return spinAttemptResponse;
     }        
 
+    public async inboxGetMessages(user_ext_id: string, limit: number = 10, offset: number = 0): Promise<GetInboxMessagesResponse> {
+
+        const message = this.buildMessage<GetInboxMessagesRequest, GetInboxMessagesResponse>(user_ext_id, ClassId.GET_ACTIVITY_LOG_REQUEST, {
+            limit,
+            offset
+        });
+
+        const response = await this.send<GetInboxMessagesResponse>(message);
+
+        return response;
+
+    }    
+
 }
 
 export { SmarticoAPI }

package/src/Store/BuyShopItemErrorCode.ts

@@ -0,0 +1,10 @@
+export enum BuyShopItemErrorCode {
+    FAILED_TO_BUY_SHOP_ITEM = 121,
+    SHOP_NO_BALANCE = 11000,
+    SHOP_WRONG_LABEL = 11001,
+    SHOP_FAILED_TO_BUY_BONUS = 11002, // remote product restriction
+    SHOP_FAILED_TO_BUY_SHOP_ITEM_CONDITION = 11003, // when not visible but trying to buy. Shoudnt happen
+    SHOP_FAILED_TO_BUY_SHOP_ITEM_CONDITION_PURSHASE = 11004, // when visible but not matching to purchase segment
+    SHOP_FAILED_TO_BUY_MATCHING_BONUS = 11005,
+    SHOP_FAILED_MAX_BOUGHT_ITEMS_REACHED = 11006
+}

package/src/Store/BuyShopItemRequest.ts

@@ -0,0 +1,5 @@
+import { ProtocolMessage } from "../Base/ProtocolMessage";
+
+export interface BuyShopItemRequest extends ProtocolMessage {
+    itemId: number;
+}

package/src/Store/BuyShopItemResponse.ts

@@ -0,0 +1,6 @@
+import { ProtocolResponse } from "../Base/ProtocolResponse";
+
+export interface BuyShopItemResponse extends ProtocolResponse {
+    success?: boolean;
+}
+

package/src/Store/GetCategoriesShopResponse.ts

@@ -0,0 +1,11 @@
+import { ProtocolResponse } from "../Base/ProtocolResponse";
+import { ShopCategory } from "./ShopCategory";
+
+
+export interface GetCategoriesShopResponse extends ProtocolResponse {
+
+    categories: ShopCategory[];
+}
+
+
+

package/src/Store/GetShopItemsResponse.ts

@@ -0,0 +1,7 @@
+
+import { ProtocolResponse } from "../Base/ProtocolResponse";
+import { ShopItem } from "./ShopItem";
+
+export interface GetShopItemsResponse extends ProtocolResponse {
+    items: ShopItem[];
+}

package/src/Store/ShopCategory.ts

@@ -0,0 +1,7 @@
+import { ShopCategoryPublicMeta } from "./ShopCategoryPublicMeta";
+
+export interface ShopCategory {
+
+    id?: number;
+    publicMeta?: ShopCategoryPublicMeta;
+}

package/src/Store/ShopCategoryPublicMeta.ts

@@ -0,0 +1,5 @@
+export interface ShopCategoryPublicMeta {
+
+    name?: string;
+    order?: number;
+}

package/src/Store/ShopItem.ts

@@ -0,0 +1,10 @@
+import { ShopItemPublicMeta } from "./ShopItemPublicMeta";
+import { ShopItemType } from "./ShopItemType";
+
+export interface ShopItem {
+    id: number;
+    itemTypeId: ShopItemType;
+    itemPublicMeta: ShopItemPublicMeta;
+    categoryIds?: number[];
+    canBuy?: boolean;
+}

package/src/Store/ShopItemPublicMeta.ts

@@ -0,0 +1,10 @@
+export interface ShopItemPublicMeta {
+    price: string;
+    image_url: string;
+    name: string;
+    description: string;
+    label_tag: string;
+    limit_message: string;
+    priority: number;
+    related_items: number[];    
+}

package/src/Store/ShopItemType.ts

@@ -0,0 +1,5 @@
+export enum ShopItemType {
+    Bonus = 1,
+    Manual = 2
+}
+

package/src/Store/index.ts

@@ -0,0 +1,25 @@
+import { BuyShopItemErrorCode } from "./BuyShopItemErrorCode";
+import { BuyShopItemRequest } from "./BuyShopItemRequest";
+import { BuyShopItemResponse } from "./BuyShopItemResponse";
+import { GetCategoriesShopResponse } from "./GetCategoriesShopResponse";
+import { GetShopItemsResponse } from "./GetShopItemsResponse";
+import { ShopCategory } from "./ShopCategory";
+import { ShopCategoryPublicMeta } from "./ShopCategoryPublicMeta";
+import { ShopItem } from "./ShopItem";
+import { ShopItemPublicMeta } from "./ShopItemPublicMeta";
+import { ShopItemType } from "./ShopItemType";
+
+
+export {
+    BuyShopItemErrorCode,
+    BuyShopItemRequest,
+    BuyShopItemResponse,
+    GetCategoriesShopResponse,
+    GetShopItemsResponse,
+    ShopCategory,
+    ShopCategoryPublicMeta,
+    ShopItem,
+    ShopItemPublicMeta,
+    ShopItemType,
+
+}

package/src/index.ts

@@ -2,8 +2,13 @@ import { ClassId } from './Base/ClassId'
 import { ILogger } from './ILogger';
 import { SmarticoAPI } from './SmarticoAPI'
 
-export * from './MiniGames';
 export * from './Core';
+export * from './Inbox';
+export * from './Leaderboard';
+export * from './MiniGames';
+export * from './Missions';
+export * from './Store';
+
 
 export {
     SmarticoAPI,