@smartico/public-api 0.0.46 → 0.0.47

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smartico/public-api",
-  "version": "0.0.46",
+  "version": "0.0.47",
   "description": "Smartico public API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -23,7 +23,8 @@
     "bump-tracker": "cd ../tracker && npm install @smartico/public-api@latest --legacy-peer-deps",
     "bump-ach": "cd ../tracker/ach && npm install @smartico/public-api@latest --legacy-peer-deps",
     "bump-bo-server": "cd ../bo_server/server && source ~/.nvm/nvm.sh && nvm use v13.13.0 && npm install @smartico/public-api@latest",
-    "bump-bo-client": "cd ../bo_server/client && source ~/.nvm/nvm.sh && nvm use v13.13.0 && npm install @smartico/public-api@latest"
+    "bump-bo-client": "cd ../bo_server/client && source ~/.nvm/nvm.sh && nvm use v13.13.0 && npm install @smartico/public-api@latest",
+    "doc": "typedoc"
   },
   "author": "",
   "license": "ISC",
@@ -34,6 +35,9 @@
   "devDependencies": {
     "@types/node-fetch": "^2.6.2",
     "microbundle": "0.15.0",
-    "npm-run-all": "4.1.5"
+    "npm-run-all": "4.1.5",
+    "typedoc": "^0.24.8",
+    "typedoc-plugin-markdown": "^3.15.4",
+    "typedoc-plugin-merge-modules": "^5.0.1"
   }
 }

package/src/SmarticoAPI.ts

@@ -16,7 +16,7 @@ import { AchievementType, GetAchievementMapRequest, GetAchievementMapResponse }
 import { GetTournamentInfoRequest, GetTournamentInfoResponse, GetTournamentsRequest, GetTournamentsResponse } from './Tournaments';
 import { GetLeaderBoardsRequest, GetLeaderBoardsResponse, LeaderBoardDetails, LeaderBoardPeriodType } from "./Leaderboard";
 import { GetLevelMapResponse } from "./Level";
-
+import { WSAPI } from "./WSAPI/WSAPI";
 
 const PUBLIC_API_URL = 'https://papi{ENV_ID}.smartico.ai/services/public';
 const C_SOCKET_PROD = 'wss://api{ENV_ID}.smartico.ai/websocket/services';
@@ -29,7 +29,7 @@ interface IOptions {
     logHTTPTiming?: boolean;
 }
 
-type MessageSender = (message: any, publicApuUrl: string) => Promise<any>;
+type MessageSender = (message: any, publicApuUrl?: string, expectCID?: ClassId) => Promise<any>;
 
 
 class SmarticoAPI {
@@ -101,7 +101,7 @@ class SmarticoAPI {
         
         try {
             const timeStart = new Date().getTime();
-            result = await this.messageSender(message, this.publicUrl);
+            result = await this.messageSender(message, this.publicUrl, expectCID);
             const timeEnd = new Date().getTime();
 
             if (this.logHTTPTiming) {
@@ -410,9 +410,13 @@ 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);
+        return await this.send<GetLevelMapResponse>(message, ClassId.GET_LEVEL_MAP_RESPONSE);
+    }
+    
+    public getWSCalls(): WSAPI {
+        return new WSAPI(this);
     }
 
 }

package/src/WSAPI/WSAPI.ts

@@ -0,0 +1,18 @@
+import { SmarticoAPI } from "../SmarticoAPI";
+
+import { GetLevelMapClearedResponse, levelCleaner } from "./WSAPITypes";
+
+/** @group General API */
+export class WSAPI {
+    private static api: SmarticoAPI;
+    
+    /** @private */
+    constructor(api: SmarticoAPI) {
+        WSAPI.api = api;
+    }
+
+    public async getLevelsTransformed(): Promise<GetLevelMapClearedResponse[]> {
+        const levels = await WSAPI.api.levelsGet(null);
+        return levelCleaner(levels);
+    }
+}

package/src/WSAPI/WSAPITypes.ts

@@ -0,0 +1,29 @@
+import { GetLevelMapResponse } from "../Level"
+
+// Levels
+
+/** @group Levels response */
+export interface GetLevelMapClearedResponse {
+
+    id: number,
+    name: string,
+    description: string,
+    image: string,
+    required_points: number,
+    required_level_counter_1: number,
+    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,
+    })));
+}

package/tsconfig.json

@@ -12,6 +12,15 @@
     },
     "include": [
         "src/**/*"
-    ]
+    ],
+    "typedocOptions": {
+        "name": "Smartico API documentation",
+        "entryPoints": ["src/WSAPI/WSAPI.ts", "src/WSAPI/WSAPITypes.ts"],
+        "out": "docs_test",
+        "plugin": ["typedoc-plugin-markdown", "typedoc-plugin-merge-modules"],
+        "entryDocument": "README_TWO.md",
+        "disableSources": true,
+        "excludePrivate": true,
+    }
   }