@momo-cloud/gami-sdk 0.0.53 → 0.0.67

package/README.md

@@ -120,31 +120,6 @@ await GamiSDK.endGame();
 
 ---
 
-#### `submit(options)`
-
-Submit game results to the backend.
-
-```typescript
-const result = await GamiSDK.submit({
-  steps: [
-    { action: 'start', timestamp: 1699000000000, data: {...} },
-    { action: 'move', timestamp: 1699000001000, data: {...} },
-    { action: 'end', timestamp: 1699000010000, data: {...} }
-  ],
-  score: 1500
-});
-
-console.log('Reward:', result.gift);
-```
-
-**Parameters:**
-- `steps` (array): Array of gameplay events for validation
-- `score` (number): Final score achieved
-
-**Returns:** `Promise<{ gift?: any, ... }>` - Server response with rewards
-
----
-
 ### Configuration & Data
 
 #### `getConfig()`
@@ -160,76 +135,77 @@ console.log('Game config:', config);
 
 ---
 
-#### `getBalance(options)`
+#### `getExchange()`
 
-Get user's balance for specified balance IDs.
+Load exchange metadata for the current game (coin → turn). The backend uses the fixed action `exchange_coin_to_turn`; the active `gameId` comes from `init`.
 
 ```typescript
-const balance = await GamiSDK.getBalance({
-  balanceIds: ['coin', 'gem', 'ticket']
-});
+const res = await GamiSDK.getExchange();
+const { balance, exchangeRate, counter, counterLimit, fromCurrency, toCurrency } = res.result;
+```
+
+**Returns:** `Promise<TGetExchangeResponse>` - Standard `response_info` plus `result` with rate, balances, counters, and currency pair
+
+---
 
-console.log('Coins:', balance.coin);
-console.log('Gems:', balance.gem);
+#### `postExchange(options)`
+
+Submit a coin-to-turn exchange for the current game.
+
+```typescript
+const res = await GamiSDK.postExchange({ amount: 100 });
+const { from, to, counter } = res.result;
 ```
 
 **Parameters:**
-- `balanceIds` (string[]): Array of balance identifiers
+- `amount` (number): Coin amount to convert
 
-**Returns:** `Promise<TBalance>` - Balance data object
+**Returns:** `Promise<TPostExchangeResponse>` - Updated `from` / `to` wallet snapshots and `counter` state
 
 ---
 
-#### `getBalanceConfig()`
+#### `spin()`
 
-Get available balance types (pockets) configuration.
+Perform a spinner spin for the current game. Sends `POST` to the twirler service with the active `gameId` (set via `init`).
 
 ```typescript
-const pockets = await GamiSDK.getBalanceConfig();
-console.log('Available balances:', pockets);
+const result = await GamiSDK.spin();
+console.log('Spin result:', result);
 ```
 
-**Returns:** `Promise<any>` - Pocket configuration
+**Returns:** `Promise<any>` - Server response with spin outcome (e.g. prize payload); exact shape follows the backend contract
 
 ---
 
-#### `getTheme(options)`
+#### `getBalance(options)`
 
-Fetch theme assets for the game.
+Get user's balance for specified balance IDs.
 
 ```typescript
-const theme = await GamiSDK.getTheme({
-  ext: 'json',
-  name: 'lunar-new-year'
+const { result: balance } = await GamiSDK.getBalance({
+  balanceId: ['turn', 'coin', 'gem', 'ticket']
 });
 
-console.log('Theme data:', theme);
+console.log('Coins:', balance.turn);
 ```
 
 **Parameters:**
-- `ext` (string): extension (rule)
-- `name` (string): Theme name/identifier
+- `balanceId` (string): Balance Id
 
-**Returns:** `Promise<any>` - Theme data
+**Returns:** `Promise<TBalance>` - Balance data object
 
 ---
 
-### Leaderboard & Rankings
-
-#### `getLeaderboard(options)`
+#### `getBalanceConfig()`
 
-Fetch leaderboard data.
+Get available balance types (pockets) configuration.
 
 ```typescript
-const res = await GamiSDK.getLeaderboard({
-  boardId: 'weekly',
-  limit: 50
-});
-
-console.log('Leaderboard:', res);
+const pockets = await GamiSDK.getBalanceConfig();
+console.log('Available balances:', pockets);
 ```
 
-**Returns:** `Promise<TLeaderboard>` - Leaderboard data
+**Returns:** `Promise<any>` - Pocket configuration
 
 ---
 
@@ -852,11 +828,20 @@ Game Ready ✓
 The SDK is written in TypeScript and includes type definitions:
 
 ```typescript
-import GamiSDK, { TBalance, TLeaderboard, IUserInfo } from '@momo-cloud/gami-sdk';
+import GamiSDK, {
+  TBalance,
+  TGetExchangeResponse,
+  TLeaderboard,
+  TPostExchangeResponse,
+  IUserInfo
+} from '@momo-cloud/gami-sdk';
 
 const balance: TBalance = await GamiSDK.getBalance({
   balanceIds: ['coin']
 });
+
+const exchangeInfo: TGetExchangeResponse = await GamiSDK.getExchange();
+const posted: TPostExchangeResponse = await GamiSDK.postExchange({ amount: 100 });
 ```
 
 ### Vite Integration

package/dist/index.public.d.ts

@@ -1,4 +1,5 @@
-import { eventemitter3 } from 'eventemitter3';
+import { EventEmitter } from 'eventemitter3';
+import { EventSource as EventSource_2 } from 'eventsource';
 
 export declare const Calendar: CalendarAPI;
 
@@ -16,7 +17,7 @@ declare interface CalendarAPI {
     }): Promise<boolean>;
 }
 
-export declare const GameEvent: eventemitter3<string | symbol, any>;
+export declare const GameEvent: EventEmitter<string | symbol, any>;
 
 declare const GamiSDK: {
     setServerTime: (value: number) => void;
@@ -24,6 +25,7 @@ declare const GamiSDK: {
     token: string;
     gameId: string;
     userId: string | undefined;
+    appProfile: TAppProfile;
     userInfo: IUserInfo | null;
     deviceInfo: TDeviceInfo;
     isBrowser: boolean;
@@ -51,20 +53,18 @@ declare const GamiSDK: {
     startGame: () => Promise<any>;
     endGame: () => Promise<void>;
     getBalance: (params: {
-        balanceIds: string[];
+        balanceId: string;
     }) => Promise<any>;
     getBalanceConfig: () => Promise<any>;
     getConfig: () => Promise<any>;
-    getTheme: (params: {
-        ext: string;
-        name: string;
-    }) => Promise<any>;
-    submit: (params: {
-        steps: any[];
-        score: number;
-    }) => Promise<any>;
+    getExchange: (params?: {
+        actionId?: string;
+    }) => Promise<TGetExchangeResponse>;
+    postExchange: (params: {
+        amount: number;
+        actionId?: string;
+    }) => Promise<TPostExchangeResponse>;
     spin: () => Promise<any>;
-    getMilestone: () => Promise<any>;
     getLeaderboard: (params: {
         boardId: string;
         group?: "friend" | "global";
@@ -78,6 +78,9 @@ declare const GamiSDK: {
         page: number;
         limit: number;
     }) => Promise<any>;
+    getMission: (params: {
+        viewId?: string;
+    }) => Promise<any>;
     showToast: (params: {
         title?: string;
         description: string;
@@ -87,6 +90,9 @@ declare const GamiSDK: {
     showAlert: (title: string, message: string, buttons?: string[]) => any;
     setItem: (key: string, obj: any) => void;
     getItem: (key: string) => Promise<unknown>;
+    setProfile: (profile: {
+        avatar: string;
+    }) => void;
     openWeb: ({ url, html, title }: {
         url?: string;
         html?: string;
@@ -101,16 +107,17 @@ declare const GamiSDK: {
         subject?: string;
     }) => Promise<any>;
     copyToClipBoard: (text: string, message?: string) => Promise<any>;
-    shareFacebook: (url: string) => Promise<any>;
+    shareFacebook: (link: string) => Promise<any>;
+    shareFacebookImage: (image: string) => Promise<any>;
     shareMessenger: (link: string) => Promise<any>;
-    requestPermission: (permission: string) => Promise<any>;
+    requestPermission: (permission: string, showPopupPermission?: boolean) => Promise<any>;
     checkPermission: (permission: string) => Promise<any>;
     getContacts: ({ isMoMo, contactType }?: {
-        isMoMo?: boolean;
+        isMoMo?: boolean | undefined;
         contactType?: "device" | string | undefined;
     }) => Promise<any[]>;
     formatUrl: (origin: string, args?: any[]) => string;
-    request: ({ path, method, subDomain, params, body, formData, extraHeader, useCloudMsg, mockData }: {
+    request: ({ path, method, subDomain, params, body, formData, extraHeader, useCloudMsg, useSendMessage, mockData, SignSecure }: {
         path: string;
         method: string;
         subDomain?: string;
@@ -119,9 +126,11 @@ declare const GamiSDK: {
         formData?: any;
         extraHeader?: any;
         useCloudMsg?: boolean;
+        useSendMessage?: boolean;
         mockData?: any;
+        SignSecure?: boolean;
     }) => Promise<any>;
-    fetch: ({ path, method, subDomain, params, body, formData, extraHeader, mockData }: {
+    fetch: ({ path, method, subDomain, params, body, formData, extraHeader, mockData, useCloudMsg, useSendMessage }: {
         path: string;
         method: string;
         params?: any[];
@@ -130,7 +139,17 @@ declare const GamiSDK: {
         formData?: any;
         extraHeader?: any;
         mockData?: any;
+        useCloudMsg?: boolean;
+        useSendMessage?: boolean;
     }) => Promise<any>;
+    screenTracking: ({ game_id, event_name, action_name, screen_name, extra, error_code }: {
+        game_id?: string;
+        event_name: string;
+        action_name: string;
+        screen_name: string;
+        extra?: object;
+        error_code?: string | number;
+    }) => void;
     fetchBinary: ({ url }: {
         url: string;
     }) => Promise<unknown>;
@@ -176,15 +195,8 @@ declare const GamiSDK: {
         pinKey?: string;
     }, callback: (data: any) => void) => void;
     UploadImage: (base64: string) => Promise<string>;
+    getScreenShot: () => Promise<unknown>;
     trackingEvent: (event: string, data: any) => void;
-    screenTracking: ({ game_id, event_name, action_name, screen_name, extra, error_code }: {
-        game_id?: string;
-        event_name: string;
-        action_name: string;
-        screen_name: string;
-        extra?: object;
-        error_code?: string | number;
-    }) => void;
     startRefId: ({ refId, refExtra, useWeb }: {
         refId: string;
         refExtra?: string | object;
@@ -210,9 +222,22 @@ export declare interface IUserInfo {
     avatar?: string;
 }
 
+export declare class SSE {
+    static create(url: string): EventSource_2;
+}
+
 declare const Storage_2: IStorageAPI;
 export { Storage_2 as Storage }
 
+declare type TAppProfile = {
+    id: string;
+    userId: string;
+    name: string;
+    displayName: string;
+    avatar: string;
+    userInputDateOfBirth: string;
+};
+
 export declare type TDeviceInfo = {
     appVersion: string;
     buildVersion: string;
@@ -222,6 +247,48 @@ export declare type TDeviceInfo = {
     devicePerformance?: string;
 };
 
+export declare type TGetExchangeResponse = {
+    response_info: {
+        error_message: string;
+        error_code: number;
+        event_tracking: string;
+    };
+    result: {
+        balance: number;
+        exchangeRate: number;
+        counter: number;
+        counterLimit: number;
+        fromCurrency: string;
+        toCurrency: string;
+    };
+};
+
+export declare type TPostExchangeResponse = {
+    response_info: {
+        error_message: string;
+        error_code: number;
+        event_tracking: string;
+    };
+    result: {
+        from: {
+            walletType: string;
+            currency: string;
+            before: number;
+            after: number;
+        };
+        to: {
+            walletType: string;
+            currency: string;
+            before: number;
+            after: number;
+        };
+        counter: {
+            value: number;
+            limit: number;
+        };
+    };
+};
+
 export declare const Utils: {
     num10to11: (number: string) => string;
     num11to10: (number: string) => string;