@smartico/public-api 0.0.4 → 0.0.6

package/README.md

@@ -1,8 +1,7 @@
-# The library for communication with Smartico API
-- Allows to make requests and receive a response over https
-- Describes data types
+# Smartico Public API
+API allows you to build and manage Smartico Gamification context on behalf of the user. It can be used in the JS/TS based frontend or in NodeJS backend
 
-# Install in your application
+# Installation
 
 ```bash
 npm install --save @smartico/public-api
@@ -11,65 +10,45 @@ npm install --save @smartico/public-api
 ## Usage
 
 ```typescript
-import { ProtocolRequest, GBaseRequest } from '@smartico/public-api';
+import { SmarticoAPI } from '@smartico/public-api';
 
-class Example {
-  
-    private static buildMessage<TRequest,TResponse>(rq: GBaseRequest): TResponse {
-
-        const message: ProtocolRequest = {
-            api_key: rq.label_api_key,
-            brand_key: rq.brand_key,
-            ext_user_id: rq.smartico_ext_user_id,
-            uuid: Util.uuid(),
-            ts: new Date().getTime(),
-        };
-
-        return message as any
-    }
+const SAPI = new SmarticoAPI( 'your-label-api-key', 'your-brand-key', { logger: console });
+            
+const response = await SAPI.miniGamesGetTemplates(rsUser.user_ext_id);
 
+response.templates.forEach( t => {
+    console.log(t.saw_template_ui_definition.name)
 }
-```
 
-## Pre-requisite for publish new version of package
+```
 
-### Set new package version
 
-```sh
-npm run build
-npm version [<newversion> | major | minor | patch ]
-```
+## Development and publishing process
 
-### Manual publish new version
+### Publishing process
 
 ```sh
+git commit
+npm run build
+npm version patch
 npm run pub
 ```
 
-# Developing & debugging locally
-
-### Enable Debug changes locally
-
-(reference article: https://terodox.tech/using-npm-link-for-package-development/)
+###  Debug locally
 
 In the public-api project console:
 
-1. Assure you are in the project folder (`cd <your-local-git-folder-for-this-project>/public-api `)
-2. Run:
-    ```sh
-    npm link
-    ```
-   This will create a symlink from the global `node_modules/@smartico/public-api` to your current folder - `<your-local-git-folder-for-this-project>/public-api`
+```sh
+npm link
+# when you are done
+npm unlink
+```
 
 Consumer project console:
 ```bash
 npm link @smartico/public-api
-```
-
-Now you are ready to debug locally the library!
 
-### Before you deploy !!! Cleanup if you enabled the debug changes locally steps above
-```bash
+# when you are done
 npm unlink npm link @smartico/public-api
 npm install npm link @smartico/public-api
-```
+```

package/dist/Base/ClassId.d.ts

@@ -1,14 +1,60 @@
 export declare enum ClassId {
-    GET_LABEL_INFO = 3,
-    GET_LABEL_INFO_RESPONSE = 4,
+    INIT = 3,
+    INIT_RESPONSE = 4,
     IDENTIFY = 5,
     IDENTIFY_RESPONSE = 6,
+    LOGIN = 7,
+    LOGOUT = 8,
     EVENT = 9,
     EVENT_RESPONSE = 10,
+    LOGIN_RESPONSE = 11,
+    LOGOUT_RESPONSE = 12,
     GET_TRANSLATIONS_REQUEST = 13,
     GET_TRANSLATIONS_RESPONSE = 14,
-    CHANGE_USERNAME = 159,
-    CHANGE_USERNAME_RESPONSE = 160,
+    CLIENT_ENGAGEMENT_IMPRESSION_REQUEST = 103,
+    CLIENT_ENGAGEMENT_ACTION_REQUEST = 104,
+    CLIENT_EXECUTE_DEEPLINK_EVENT = 105,
+    CLIENT_ENGAGEMENT_FAILED_REQUEST = 106,
+    CLIENT_EXECUTE_JS_EVENT = 107,
+    CLIENT_PUBLIC_PROPERTIES_CHANGED_EVENT = 108,
+    CLIENT_ENGAGEMENT_EVENT_NEW = 110,
+    CLIENT_SET_AVATAR_REQUEST = 157,
+    CLIENT_SET_AVATAR_RESPONSE = 158,
+    CLIENT_SET_CUSTOM_USERNAME_REQUEST = 159,
+    CLIENT_SET_CUSTOM_USERNAME_RESPONSE = 160,
+    GET_LEVEL_MAP_REQUEST = 500,
+    GET_LEVEL_MAP_RESPONSE = 501,
+    GET_ACHIEVEMENT_MAP_REQUEST = 502,
+    GET_ACHIEVEMENT_MAP_RESPONSE = 503,
+    RELOAD_ACHIEVEMENTS_EVENT = 504,
+    GET_LEADERS_BOARD_REQUEST = 505,
+    GET_LEADERS_BOARD_RESPONSE = 506,
+    GET_ACTIVITY_LOG_REQUEST = 507,
+    GET_ACTIVITY_LOG_RESPONSE = 508,
+    GET_SHOP_ITEMS_REQUEST = 509,
+    GET_SHOP_ITEMS_RESPONSE = 510,
+    BUY_SHOP_ITEM_REQUEST = 511,
+    BUY_SHOP_ITEM_RESPONSE = 512,
+    GET_INBOX_MESSAGES_REQUEST = 513,
+    GET_INBOX_MESSAGES_RESPONSE = 514,
+    GET_SHOP_CATEGORIES_REQUEST = 515,
+    GET_SHOP_CATEGORIES_RESPONSE = 516,
+    GET_TOURNAMENT_LOBBY_REQUEST = 517,
+    GET_TOURNAMENT_LOBBY_RESPONSE = 518,
+    GET_TOURNAMENT_INFO_REQUEST = 519,
+    GET_TOURNAMENT_INFO_RESPONSE = 520,
+    TOURNAMENT_REGISTER_REQUEST = 521,
+    TOURNAMENT_REGISTER_RESPONSE = 522,
+    GET_CUSTOM_SECTIONS_REQUEST = 523,
+    GET_CUSTOM_SECTIONS_RESPONSE = 524,
+    MISSION_OPTIN_REQUEST = 525,
+    MISSION_OPTIN_RESPONSE = 526,
+    GET_ACHIEVEMENT_USER_REQUEST = 527,
+    GET_ACHIEVEMENT_USER_RESPONSE = 528,
+    GET_BONUSES_REQUEST = 600,
+    GET_BONUSES_RESPONSE = 601,
+    CLAIM_BONUS_REQUEST = 602,
+    CLAIM_BONUS_RESPONSE = 603,
     SAW_GET_SPINS_REQUEST = 700,
     SAW_GET_SPINS_RESPONSE = 701,
     SAW_DO_SPIN_REQUEST = 702,
@@ -17,5 +63,8 @@ export declare enum ClassId {
     SAW_AKNOWLEDGE_RESPONSE = 705,
     SAW_SPINS_COUNT_PUSH = 706,
     SAW_SHOW_SPIN_PUSH = 707,
+    REGISTER_PUSH_NOTIFICATIONS_TOKEN_REQ = 1003,
+    REGISTER_PUSH_NOTIFICATIONS_TOKEN_RESP = 2003,
+    CLIENT_DEBUG_REQUEST = 77777,
     UNSUPPORTED_COMMAND = 99999
 }

package/dist/Core/GetLabelInfoRequest.d.ts

@@ -0,0 +1,3 @@
+import { ProtocolRequest } from "../Base/ProtocolRequest";
+export interface GetLabelInfoRequest extends ProtocolRequest {
+}

package/dist/Core/GetLabelInfoResponse.d.ts

@@ -0,0 +1,7 @@
+import { ProtocolResponse } from "../Base/ProtocolResponse";
+export interface GetLabelInfoResponse extends ProtocolResponse {
+    settings: {
+        [key: string]: string;
+    };
+    label_id: string;
+}

package/dist/Core/GetTranslationsRequest.d.ts

@@ -0,0 +1,7 @@
+import { ProtocolRequest } from "../Base/ProtocolRequest";
+import { TranslationArea } from "./TranslationArea";
+export interface GetTranslationsRequest extends ProtocolRequest {
+    hash_code: number;
+    areas: TranslationArea[];
+    lang_code: string;
+}

package/dist/Core/GetTranslationsResponse.d.ts

@@ -0,0 +1,7 @@
+import { ProtocolResponse } from "../Base/ProtocolResponse";
+export interface GetTranslationsResponse extends ProtocolResponse {
+    hash_code: number;
+    translations: {
+        [key: string]: string;
+    };
+}

package/dist/Core/PublicLabelSettings.d.ts

@@ -0,0 +1,28 @@
+export declare enum PublicLabelSettings {
+    FCM_SENDER_ID = "FCM_SENDER_ID",
+    PUBLIC_API_URL = "PUBLIC_API_URL",
+    FCM_SW_URL = "FCM_SW_URL",
+    RECORDING_ENABLED_FOR_ALL_USERS = "RECORDING_ENABLED_FOR_ALL_USERS",
+    JS_INJECTION = "JS_INJECTION",
+    GAMIFICATION_UI_MAIN = "GAMIFICATION_UI_MAIN",
+    GAMIFICATION_UI_WIDGET = "GAMIFICATION_UI_WIDGET",
+    GAMIFICATION_UI_MINI_GAME = "GAMIFICATION_UI_MINI_GAME",
+    GAMIFICATION_UI_SETTINGS = "GAMIFICATION_UI_SETTINGS",
+    GAMIFICATION_UI_MAIN_TEST = "GAMIFICATION_UI_MAIN_TEST",
+    GAMIFICATION_UI_WIDGET_TEST = "GAMIFICATION_UI_WIDGET_TEST",
+    GAMIFICATION_UI_SETTINGS_TEST = "GAMIFICATION_UI_SETTINGS_TEST",
+    FRONT_END_ALLOWED_LANGUAGES = "FRONT_END_ALLOWED_LANGUAGES",
+    FRONT_END_ALLOW_DOMAINS = "FRONT_END_ALLOW_DOMAINS",
+    DELAY_ENGAGEMENT_EXECUTION_ON_LOGIN_MS = "DELAY_ENGAGEMENT_EXECUTION_ON_LOGIN_MS",
+    SHADOW_LABEL_PUBLIC_KEY = "SHADOW_LABEL_PUBLIC_KEY",
+    DYNAMIC_IMAGE_DOMAIN = "DYNAMIC_IMAGE_DOMAIN",
+    GAMIFICATION_UI_LEVEL_ENABLED = "GAMIFICATION_UI_LEVEL_ENABLED",
+    GAMIFICATION_UI_LEVEL_IMAGE_MOB = "GAMIFICATION_UI_LEVEL_IMAGE_MOB",
+    GAMIFICATION_UI_LEVEL_IMAGE_DESK = "GAMIFICATION_UI_LEVEL_IMAGE_DESK",
+    GAMIFICATION_LEVELS_LOGIC2 = "GAMIFICATION_LEVELS_LOGIC2",
+    AVATAR_CUSTOM_IMAGE_MAX_ID = "AVATAR_CUSTOM_IMAGE_MAX_ID",
+    AVATAR_CUSTOM_IMAGE_FOLDER = "AVATAR_CUSTOM_IMAGE_FOLDER",
+    RETENTION_GAMES_CUSTOMER_ID = "RETENTION_GAMES_CUSTOMER_ID",
+    GAMIFICATION_SHOW_POWERED_BY = "GAMIFICATION_SHOW_POWERED_BY",
+    _system_leader_board_mask_username = "_system_leader_board_mask_username"
+}

package/dist/Core/PublicProperties.d.ts

@@ -0,0 +1,11 @@
+export interface PublicProperties {
+    core_user_language?: string;
+    ach_points_balance?: number;
+    ach_points_ever?: number;
+    ach_points_board_period_type_1?: number;
+    ach_points_board_period_type_2?: number;
+    ach_level_current_id?: number;
+    ach_level_current?: string;
+    core_is_test_account?: boolean;
+    ach_gamification_in_control_group?: boolean;
+}

package/dist/Core/ResponseIdentify.d.ts

@@ -0,0 +1,12 @@
+import { ProtocolResponse } from "../Base/ProtocolResponse";
+import { PublicProperties } from "./PublicProperties";
+interface ResponseIdentify extends ProtocolResponse {
+    user_id: number;
+    ext_user_id: string;
+    public_username: string;
+    avatar_id: string;
+    job: boolean;
+    props?: PublicProperties;
+    pubic_username_set: boolean;
+}
+export { ResponseIdentify };

package/dist/Core/TranslationArea.d.ts

@@ -0,0 +1,9 @@
+declare enum TranslationArea {
+    Casino = 1,
+    Gamification = 2,
+    Trading = 3,
+    Archived = 4,
+    Affiliation = 5,
+    RetentionGames = 6
+}
+export { TranslationArea };

package/dist/Core/index.d.ts

@@ -0,0 +1,8 @@
+import { GetLabelInfoRequest } from './GetLabelInfoRequest';
+import { GetLabelInfoResponse } from './GetLabelInfoResponse';
+import { GetTranslationsRequest } from './GetTranslationsRequest';
+import { GetTranslationsResponse } from './GetTranslationsResponse';
+import { PublicLabelSettings } from './PublicLabelSettings';
+import { ResponseIdentify } from './ResponseIdentify';
+import { TranslationArea } from './TranslationArea';
+export { GetTranslationsRequest, GetTranslationsResponse, GetLabelInfoRequest, GetLabelInfoResponse, TranslationArea, PublicLabelSettings, ResponseIdentify };

package/dist/Inbox/GetInboxMessagesRequest.d.ts

@@ -0,0 +1,5 @@
+import { ProtocolMessage } from "../Base/ProtocolMessage";
+export interface GetInboxMessagesRequest extends ProtocolMessage {
+    limit?: number;
+    offset?: number;
+}

package/dist/Inbox/GetInboxMessagesResponse.d.ts

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

package/dist/Inbox/InboxMessage.d.ts

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

package/dist/Inbox/InboxMessageType.d.ts

@@ -0,0 +1,11 @@
+export declare enum InboxMessageType {
+    Custom = 0,
+    MissionCompleted = 1,
+    MissionUnlocked = 2,
+    LeaderboardWon = 3,
+    LevelChanged = 4,
+    BonusGiven = 5,
+    PointsAdded = 6,
+    PointsUsed = 7,
+    PersonalMessage = 8
+}

package/dist/Inbox/index.d.ts

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

package/dist/MiniGames/SAWAskForUsername.d.ts

@@ -0,0 +1,4 @@
+export declare enum SAWAskForUsername {
+    NOASK = "no-ask",
+    ONSUMBIT = "on-submit"
+}

package/dist/MiniGames/SAWDoSpinResponse.d.ts

@@ -1,11 +1,5 @@
 import { ProtocolResponse } from "./../Base/ProtocolResponse";
-export declare enum SAWSpinErrorCode {
-    SAW_OK = 0,
-    SAW_NO_SPINS = 40001,
-    SAW_PRIZE_POOL_EMPTY = 40002,
-    SAW_NOT_ENOUGH_POINTS = 40003,
-    SAW_FAILED_MAX_SPINS_REACHED = 40004
-}
+import { SAWSpinErrorCode } from "./SAWSpinErrorCode";
 export interface SAWDoSpinResponse extends ProtocolResponse {
     errCode: SAWSpinErrorCode;
     errMsg?: string;

package/dist/MiniGames/SAWSpinErrorCode.d.ts

@@ -0,0 +1,7 @@
+export declare enum SAWSpinErrorCode {
+    SAW_OK = 0,
+    SAW_NO_SPINS = 40001,
+    SAW_PRIZE_POOL_EMPTY = 40002,
+    SAW_NOT_ENOUGH_POINTS = 40003,
+    SAW_FAILED_MAX_SPINS_REACHED = 40004
+}

package/dist/MiniGames/SAWTemplateUI.d.ts

@@ -1,7 +1,4 @@
-export declare enum AskForUsername {
-    NOASK = "no-ask",
-    ONSUMBIT = "on-submit"
-}
+import { SAWAskForUsername } from "./SAWAskForUsername";
 export interface SAWTemplateUI {
     skin: string;
     name: string;
@@ -25,7 +22,7 @@ export interface SAWTemplateUI {
     jackpot_symbol?: string;
     promo_image?: string;
     promo_text?: string;
-    ask_for_username?: AskForUsername;
+    ask_for_username?: SAWAskForUsername;
     show_prize_board?: boolean;
     max_spins_period_ms?: number;
 }

package/dist/MiniGames/SAWUtils.d.ts

@@ -0,0 +1,5 @@
+import { SAWTemplate } from "./SAWTemplate";
+declare class SAWUtils {
+    static canPlay: (t: SAWTemplate, pointsBalance: number) => boolean;
+}
+export { SAWUtils };

package/dist/MiniGames/index.d.ts

@@ -1,14 +1,17 @@
+import { SAWUtils } from "./SAWUtils";
 import { SAWAcknowledgeType } from "./SAWAcknowledgeType";
+import { SAWAskForUsername } from "./SAWAskForUsername";
 import { SAWBuyInType, SAWBuyInTypeName } from "./SAWBuyInType";
 import { SAWDoSpinRequest } from "./SAWDoSpinRequest";
-import { SAWDoSpinResponse, SAWSpinErrorCode } from "./SAWDoSpinResponse";
+import { SAWDoSpinResponse } from "./SAWDoSpinResponse";
 import { SAWGameType, SAWGameTypeName } from "./SAWGameType";
 import { SAWGetTemplatesRequest } from "./SAWGetTemplatesRequest";
 import { SAWGetTemplatesResponse } from "./SAWGetTemplatesResponse";
 import { SAWPrize } from "./SAWPrize";
 import { SAWPrizeType } from "./SAWPrizeType";
 import { SAWPrizeUI } from "./SAWPrizeUI";
+import { SAWSpinErrorCode } from "./SAWSpinErrorCode";
 import { SAWTemplate } from "./SAWTemplate";
 import { SAWTemplateUI } from "./SAWTemplateUI";
 import { SAWWinSoundType, SAWWinSoundFiles } from "./SAWWinSoundType";
-export { SAWAcknowledgeType, SAWBuyInType, SAWBuyInTypeName, SAWDoSpinRequest, SAWDoSpinResponse, SAWSpinErrorCode, SAWGameType, SAWGameTypeName, SAWGetTemplatesRequest, SAWGetTemplatesResponse, SAWPrize, SAWPrizeType, SAWPrizeUI, SAWTemplate, SAWTemplateUI, SAWWinSoundType, SAWWinSoundFiles };
+export { SAWUtils, SAWAcknowledgeType, SAWBuyInType, SAWBuyInTypeName, SAWDoSpinRequest, SAWDoSpinResponse, SAWGameType, SAWGameTypeName, SAWGetTemplatesRequest, SAWGetTemplatesResponse, SAWPrize, SAWPrizeType, SAWPrizeUI, SAWTemplate, SAWTemplateUI, SAWWinSoundType, SAWWinSoundFiles, SAWAskForUsername, SAWSpinErrorCode };

package/dist/NodeCache.d.ts

@@ -0,0 +1,9 @@
+declare class NodeCache {
+    private static ttlChecker;
+    private static cache;
+    constructor();
+    get(key: string): any;
+    set(key: string, value: any, ttlSeconds?: number): void;
+    flushAll(): void;
+}
+export { NodeCache };

package/dist/OCache.d.ts

@@ -0,0 +1,11 @@
+export declare enum ECacheContext {
+    Translations = 0,
+    LabelInfo = 1
+}
+export declare class OCache {
+    private static cache;
+    static get<T>(oKey: any, cacheContext: ECacheContext): T | undefined;
+    static set(oKey: any, o: any, cacheContext: ECacheContext, ttlSeconds?: number): void;
+    static use<T>(oKey: any, cacheContext: ECacheContext, f: () => Promise<T>, ttlSeconds?: number): Promise<T>;
+    static clear(cacheContext: ECacheContext): Promise<void>;
+}

package/dist/SmarticoAPI.d.ts

@@ -2,6 +2,10 @@ import { ClassId } from "./Base/ClassId";
 import { SAWGetTemplatesResponse } from './MiniGames/SAWGetTemplatesResponse';
 import { SAWTemplate } from './MiniGames/SAWTemplate';
 import { ILogger } from './ILogger';
+import { SAWDoSpinResponse } from './MiniGames';
+import { GetTranslationsResponse, ResponseIdentify, TranslationArea } from './Core';
+import { GetLabelInfoResponse } from './Core/GetLabelInfoResponse';
+import { GetInboxMessagesResponse } from './Inbox';
 interface IOptions {
     logger?: ILogger;
     logCIDs?: ClassId[];
@@ -11,13 +15,23 @@ declare class SmarticoAPI {
     private label_api_key;
     private brand_api_key;
     private publicUrl;
+    private avatarDomain;
     private logger;
     private logCIDs;
     private logHTTPTiming;
     constructor(label_api_key: string, brand_api_key: string, options?: IOptions);
     private send;
     private buildMessage;
-    miniGamesGetTemplates(user_ext_id: string): Promise<SAWGetTemplatesResponse>;
-    miniGamesFormatTemplatesForWidget(templates: SAWTemplate[], pointsBalance: number): any[];
+    coreReportCustomEvent(user_ext_id: string, eventType: string, payload?: any): Promise<any>;
+    coreGetTranslations(user_ext_id: string, lang_code: string, areas: TranslationArea[], cacheSec?: number): Promise<GetTranslationsResponse>;
+    coreIdentifyLabel(user_ext_id: string, cacheSec?: number): Promise<GetLabelInfoResponse>;
+    coreIdentifyUser(user_ext_id: string): Promise<ResponseIdentify>;
+    coreChangeUsername(user_ext_id: string, public_username_custom: string): Promise<{
+        public_username_custom: string;
+    }>;
+    sawGetTemplates(user_ext_id: string): Promise<SAWGetTemplatesResponse>;
+    sawFormatTemplatesForWidget(templates: SAWTemplate[], pointsBalance: number): Promise<any[]>;
+    sawSpinRequest(user_ext_id: string, saw_template_id: number, round_id: number): Promise<SAWDoSpinResponse>;
+    inboxGetMessages(user_ext_id: string, limit?: number, offset?: number): Promise<GetInboxMessagesResponse>;
 }
 export { SmarticoAPI };

package/dist/index.d.ts

@@ -1,5 +1,7 @@
 import { ClassId } from './Base/ClassId';
 import { ILogger } from './ILogger';
 import { SmarticoAPI } from './SmarticoAPI';
+export * from './Core';
 export * from './MiniGames';
+export * from './Inbox';
 export { SmarticoAPI, ClassId, ILogger };