@smartico/public-api 0.0.47 → 0.0.49

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
 }

package/tsconfig.json

@@ -16,11 +16,16 @@
     "typedocOptions": {
         "name": "Smartico API documentation",
         "entryPoints": ["src/WSAPI/WSAPI.ts", "src/WSAPI/WSAPITypes.ts"],
-        "out": "docs_test",
+        "out": "docs",
         "plugin": ["typedoc-plugin-markdown", "typedoc-plugin-merge-modules"],
-        "entryDocument": "README_TWO.md",
+        "entryDocument": "README.md",
         "disableSources": true,
         "excludePrivate": true,
+        "readme": "none",
+        "cleanOutputDir": true,
+        "hideBreadcrumbs": true,
+        "hideInPageTOC": true,
+        "sort": "source-order"
     }
   }
   

package/docs_test/README_TWO.md

@@ -1,57 +0,0 @@
-Smartico API documentation / [Modules](modules.md)
-
-# 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
-
-# Installation
-
-```bash
-npm install --save @smartico/public-api
-```
-
-## Usage
-
-```typescript
-import { SmarticoAPI } from '@smartico/public-api';
-
-const SAPI = new SmarticoAPI( 'your-label-api-key', 'your-brand-key', 'your-message-sender', { logger: console });
-            
-const response = await SAPI.miniGamesGetTemplates(rsUser.user_ext_id);
-
-response.templates.forEach( t => {
-    console.log(t.saw_template_ui_definition.name)
-}
-
-```
-
-## API 
-### To learn more about the capabilities of our API, go to the [API documentation](docs_test/modules.md)
-
-## Development and publishing process
-
-### Publishing process
-
-```sh
-git commit
-npm run build
-npm version patch
-npm run pub
-```
-
-###  Debug locally
-
-In the public-api project console:
-
-```sh
-npm link
-# when you are done
-npm unlink
-```
-
-Consumer project console:
-```bash
-npm link @smartico/public-api --legacy-peer-deps
-
-# when you are done
-npm unlink @smartico/public-api --legacy-peer-deps && npm install @smartico/public-api --legacy-peer-deps
-```

package/docs_test/classes/WSAPI.md

@@ -1,19 +0,0 @@
-[Smartico API documentation](../README_TWO.md) / [Modules](../modules.md) / WSAPI
-
-# Class: WSAPI
-
-## Table of contents
-
-### Methods
-
-- [getLevelsTransformed](WSAPI.md#getlevelstransformed)
-
-## Methods
-
-### getLevelsTransformed
-
-▸ **getLevelsTransformed**(): `Promise`<[`GetLevelMapClearedResponse`](../interfaces/GetLevelMapClearedResponse.md)[]\>
-
-#### Returns
-
-`Promise`<[`GetLevelMapClearedResponse`](../interfaces/GetLevelMapClearedResponse.md)[]\>

package/docs_test/interfaces/GetLevelMapClearedResponse.md

@@ -1,57 +0,0 @@
-[Smartico API documentation](../README_TWO.md) / [Modules](../modules.md) / GetLevelMapClearedResponse
-
-# Interface: GetLevelMapClearedResponse
-
-## Table of contents
-
-### Properties
-
-- [description](GetLevelMapClearedResponse.md#description)
-- [id](GetLevelMapClearedResponse.md#id)
-- [image](GetLevelMapClearedResponse.md#image)
-- [name](GetLevelMapClearedResponse.md#name)
-- [required\_level\_counter\_1](GetLevelMapClearedResponse.md#required_level_counter_1)
-- [required\_level\_counter\_2](GetLevelMapClearedResponse.md#required_level_counter_2)
-- [required\_points](GetLevelMapClearedResponse.md#required_points)
-
-## Properties
-
-### description
-
-• **description**: `string`
-
-___
-
-### id
-
-• **id**: `number`
-
-___
-
-### image
-
-• **image**: `string`
-
-___
-
-### name
-
-• **name**: `string`
-
-___
-
-### required\_level\_counter\_1
-
-• **required\_level\_counter\_1**: `number`
-
-___
-
-### required\_level\_counter\_2
-
-• **required\_level\_counter\_2**: `number`
-
-___
-
-### required\_points
-
-• **required\_points**: `number`

package/docs_test/modules.md

@@ -1,13 +0,0 @@
-[Smartico API documentation](README_TWO.md) / Modules
-
-# Smartico API documentation
-
-## Table of contents
-
-### General API
-
-- [WSAPI](classes/WSAPI.md)
-
-### Levels response
-
-- [GetLevelMapClearedResponse](interfaces/GetLevelMapClearedResponse.md)