@jolibox/types 1.1.25 → 1.1.27

package/dist/commands/report.d.ts

@@ -1,4 +1,4 @@
-export type TrackEvent = 'jsSdkBegin' | 'onBeforeExit' | 'bootstrapModuleBeginToLoad' | 'bootstrapModuleLoaded' | 'implModuleBeginToLoad' | 'implModuleLoaded' | 'onDocumentReady' | 'joliboxServiceReady' | 'apiInvoked' | 'joliboxSpeedAnalysis' | 'joliboxNetRequestResult' | 'globalJsError' | 'CallRuntimeLoadFinished' | 'AdBreakJumpOut' | 'AdBreakHide' | 'CallAdsInit' | 'LoadAdsenseCompleted' | 'CallAdConfig' | 'PreventAdsCheating' | 'CallShowAdFn' | 'CallAdBreak' | 'CallAdUnit' | 'CallAdBreakDone' | 'CallBeforeAd' | 'CallAfterAd' | 'CallAdBreakTimeout' | 'CallAFVRequest' | 'CallAFVLoad' | 'CallAFVPlaying' | 'CallAFVCompleted' | 'CallAFVError' | 'AdSenseUnitStatusChanged' | 'OpenGame' | 'PlayGame' | 'CloseGame' | 'LevelFinished' | 'TaskFinished' | 'UseGameItem' | 'LevelUpgrade' | 'HistoryUserLevel' | 'HistoryUserScore' | 'GameFCP' | 'GameLCP' | 'GameTTFB';
+export type TrackEvent = 'jsSdkBegin' | 'onBeforeExit' | 'bootstrapModuleBeginToLoad' | 'bootstrapModuleLoaded' | 'implModuleBeginToLoad' | 'implModuleLoaded' | 'onDocumentReady' | 'joliboxServiceReady' | 'apiInvoked' | 'joliboxSpeedAnalysis' | 'joliboxNetRequestResult' | 'globalJsError' | 'CallRuntimeLoadFinished' | 'AdBreakJumpOut' | 'AdBreakHide' | 'CallAdsInit' | 'LoadAdsenseCompleted' | 'CallAdConfig' | 'PreventAdsCheating' | 'CallShowAdFn' | 'CallAdBreak' | 'CallAdUnit' | 'CallAdBreakDone' | 'CallBeforeAd' | 'CallAfterAd' | 'CallAdBreakTimeout' | 'CallAFVRequest' | 'CallAFVLoad' | 'CallAFVPlaying' | 'CallAFVCompleted' | 'CallAFVError' | 'AdSenseUnitStatusChanged' | 'OpenGame' | 'PlayGame' | 'CloseGame' | 'LevelFinished' | 'LevelUpgrade' | 'GamePlayEnded' | 'GameFCP' | 'GameLCP' | 'GameTTFB';
 export type PerformanceType = 'bootstrapModuleLoaded' | 'implementModuleLoaded' | 'joliboxGameServiceReady';
 export declare const REPORT_SYSTEM_TIMELINE = "ReportSDK.traceSystemTimeline";
 export declare const REPORT_SYSTEM_LOG = "ReportSDK.traceSystem";

package/dist/commands/response.d.ts

@@ -1,8 +1,9 @@
 export type StorageAPICode = 'NOT_FOUND' | 'PARAMETER_ERROR' | 'UNAUTHORIZED';
 export type CommonAPICode = 'SUCCESS' | 'FAILURE';
 export type ResponseType = StorageAPICode | CommonAPICode;
-export interface StandardResponse<R> {
+export interface StandardResponse<R, E = unknown> {
     code: ResponseType;
     message: string;
     data?: R;
+    extra?: E;
 }

package/dist/commands/task-track.d.ts

@@ -1,37 +1,23 @@
 import { StandardResponse } from './response';
 export declare const LEVEL_FINISHED = "TaskTrackerSDK.levelFinished";
-export declare const TASK_FINISHED = "TaskTrackerSDK.taskFinished";
-export declare const TASK_EVENT = "TaskTrackerSDK.taskEvent";
+export declare const GAME_PLAY_ENDED = "TaskTrackerSDK.gamePlayEnded";
 export declare const LEVEL_UPGRADE = "TaskTrackerSDK.levelUpgrade";
-export declare const HISTORY_USER_SCORE = "TaskTrackerSDK.historyUserScore";
-export declare const HISTORY_USER_LEVEL = "TaskTrackerSDK.historyUserLevel";
 export type TaskResponse = Promise<StandardResponse<void>>;
 export interface TaskTrackCommandParams {
-    [LEVEL_FINISHED]: (levelId: string | number, params: {
-        result: boolean;
-        duration: number;
+    [LEVEL_FINISHED]: (params: {
+        levelId: string | number;
+        duration?: number;
+        rating?: number;
+        score?: number;
     }) => TaskResponse;
-    [TASK_FINISHED]: (taskId: string | number, params: {
-        duration: number;
+    [GAME_PLAY_ENDED]: (params: {
+        duration?: number;
+        rating?: number;
+        score: number;
     }) => TaskResponse;
-    [TASK_EVENT]: (taskId: string | number, params: {
-        tools?: {
-            id: string | number;
-            name: string;
-            count?: number;
-            description?: string;
-            price?: {
-                amount: number;
-                unit: string;
-            };
-        }[];
-        awards?: {
-            id: string | number;
-            name: string;
-        }[];
+    [LEVEL_UPGRADE]: (params: {
+        levelId: string | number;
+        name?: string;
     }) => TaskResponse;
-    [LEVEL_UPGRADE]: (levelId: string | number, name: string) => TaskResponse;
-    [HISTORY_USER_LEVEL]: (level: number) => TaskResponse;
-    [HISTORY_USER_SCORE]: (score: number) => TaskResponse;
 }
 export type TaskTrackCommandType = keyof TaskTrackCommandParams;

package/dist/sdks/task-tracker.d.ts

@@ -1,24 +1,48 @@
 import { TaskResponse } from '../commands/task-track';
 export interface TaskTracker {
-    onLevelFinished(levelId: string | number, result: boolean, duration: number): Promise<TaskResponse>;
-    onTaskFinished(taskId: string | number, duration: number): Promise<TaskResponse>;
-    onTaskEvent(taskId: string | number, params: {
-        tools?: {
-            id: string | number;
-            name: string;
-            count?: number;
-            description?: string;
-            price?: {
-                amount: number;
-                unit: string;
-            };
-        }[];
-        awards?: {
-            id: string | number;
-            name: string;
-        }[];
+    /**
+     * Handles completion of a game level by sending analytics data to the backend
+     *
+     * @param params - Object containing level completion details:
+     * @param params.levelId - Unique identifier for the completed level (string or number)
+     * @param params.duration - Optional time spent in the level (milliseconds)
+     * @param params.rating - Optional user rating for the level
+     * @param params.score - Optional final score achieved in the level
+     * @returns Promise resolving to TaskResponse or error message if validation fails
+     * @throws {Promise} Rejects with error if params is not an object
+     */
+    onLevelFinished(params: {
+        levelId: string | number;
+        duration?: number;
+        rating?: number;
+        score?: number;
+    }): Promise<TaskResponse>;
+    /**
+     * Records completion of a gameplay session with final metrics
+     *
+     * @param params - Object containing gameplay session details:
+     * @param params.duration - Optional total time spent in gameplay (milliseconds)
+     * @param params.rating - Optional user rating for the gameplay session
+     * @param params.score - Mandatory final score achieved during gameplay
+     * @returns Promise resolving to TaskResponse or error message if validation fails
+     * @throws {Promise} Rejects with error if params is not an object
+     */
+    onGamePlayEnded(params: {
+        duration?: number;
+        rating?: number;
+        score: number;
+    }): Promise<TaskResponse>;
+    /**
+     * Tracks player progression when they upgrade to a new level
+     *
+     * @param params - Object containing level upgrade details:
+     * @param params.levelId - Unique identifier for the new level (string or number)
+     * @param params.name - Optional display name for the upgraded level
+     * @returns Promise resolving to TaskResponse or error message if validation fails
+     * @throws {Promise} Rejects with error if params is not an object
+     */
+    onLevelUpgrade(params: {
+        levelId: string | number;
+        name?: string;
     }): Promise<TaskResponse>;
-    onLevelUpgrade(levelId: string | number, name: string): Promise<TaskResponse>;
-    onHistoryUserLevel(level: number): Promise<TaskResponse>;
-    onHistoryUserScore(score: number): Promise<TaskResponse>;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@jolibox/types",
   "description": "This project is common types used for JS-SDk interfere & implement",
-  "version": "1.1.25",
+  "version": "1.1.27",
   "typings": "dist/index.d.ts",
   "license": "MIT",
   "files": [