@momo-cloud/gami-sdk 0.0.95 → 0.0.98

package/README.md

@@ -87,9 +87,9 @@ await GamiSDK.startGame();
 Typical game loop calls (signatures match `IGameApi`):
 
 - `getConfig({ ext? })`
-- `getBalance({ balanceId? })`
+- `getBalance({ balanceId? })` — `balanceId` accepts a single `string` or an array `string[]`
 - `getBalanceConfig()`
-- `spin({ checkCounter?, giftCate?, isBonus? })`
+- `spin({ checkCounter?, giftCate?, isBonus? })` — `giftCate` is a free-form `string`
 - `shake()`
 - `getCoinBalance()`
 - `getCoinExchangeInfo({ actionId? })`
@@ -242,7 +242,27 @@ if (res?.response_info?.error_code !== 0) {
 }
 ```
 
-## 8) Leaderboard APIs
+## 8) Balance API
+
+### Fetch a single balance
+
+```ts
+const res = await GamiSDK.getBalance({ balanceId: 'turn' });
+```
+
+### Fetch multiple balances in one call
+
+Pass a `string[]` to request several balance IDs at once. The server receives them as a comma-separated list.
+
+```ts
+const res = await GamiSDK.getBalance({ balanceId: ['turn', 'coin', 'ticket'] });
+```
+
+The result shape is always `TBalance` regardless of how many IDs were requested. Omitting `balanceId` defaults to `'turn'`.
+
+---
+
+## 9) Leaderboard APIs
 
 ### Read leaderboard
 
@@ -270,7 +290,7 @@ await GamiSDK.submitLeaderboard({
 
 `gameId` and `userId` are injected automatically from the SDK session — do not pass them manually.
 
-## 9) Browser vs Host Runtime
+## 10) Browser vs Host Runtime
 
 - In MoMo host: full platform bridge behavior is available.
 - In browser/dev mode: host-only behavior may be mocked, no-op, or limited.
@@ -280,7 +300,7 @@ Integration recommendation:
 - Keep game domain flow independent from host-only APIs.
 - Wrap optional host actions with graceful fallback in browser.
 
-## 10) Build and Publish Modes
+## 11) Build and Publish Modes
 
 This repository supports two build modes:
 
@@ -302,7 +322,7 @@ npm run publish:npm
 npm run publish:all
 ```
 
-## 11) Integration Checklist
+## 12) Integration Checklist
 
 Before releasing a game integration:
 
@@ -314,7 +334,7 @@ Before releasing a game integration:
 - Local cache keys use SDK helpers to avoid collisions
 - Permissions flow validated for calendar/contacts/image capture
 
-## 12) Minimal End-to-End Example
+## 13) Minimal End-to-End Example
 
 ```ts
 import GamiSDK from '@momo-cloud/gami-sdk';
@@ -340,7 +360,7 @@ export async function run() {
 }
 ```
 
-## 13) Notes for Architects
+## 14) Notes for Architects
 
 - Keep `GamiSDK` behind your own `sdkService` adapter in app code.
 - Separate domain logic from host bridge calls for easier testability.

package/dist/index.public.d.ts

@@ -4,6 +4,29 @@ export declare const GameEvent: EventEmitter<string | symbol, any>;
 export declare const GamiSDK: Record<string, any>;
 export default GamiSDK;
 
+export declare const AudioPlayer: {
+    init(options: { baseURL: string }): void;
+    play(name: string, options?: { loop?: boolean; volume?: number }): Promise<any>;
+    playMusic(name: string, options?: { loop?: boolean; volume?: number; onComplete?: () => void }): Promise<any>;
+    stop(name: string): void;
+    pause(name?: string): void;
+    resume(name?: string): void;
+    setVolume(name: string, value: number): void;
+    setMute(name: string, value: boolean): void;
+    musicVolume: number;
+    enableSfx: boolean;
+    enable: boolean;
+};
+
+export declare const Storage: {
+    cacheJson(key: string, value: object): void;
+    cacheValue(key: string, value: string): void;
+    getJson<T = any>(key: string, defaultVal?: T): Promise<T>;
+    getValue(key: string, defaultVal?: string): Promise<string | undefined>;
+    cacheFile(url: string): Promise<string>;
+    getInCache(url: string): string | undefined;
+};
+
 export type IUserInfo = {
     id: string;
     name?: string;
@@ -20,15 +43,263 @@ export type TDeviceInfo = {
     devicePerformance?: string;
 };
 
-export type TGetExchangeResponse = any;
-export type TPostExchangeResponse = any;
-export type TSpin = any;
-export type TShake = any;
-export type TCoinBalanceResponse = any;
-export type TBalance = any;
-export type TBalanceConfig = any;
-export type TGameConfig = any;
-export type THistory = any;
-export type TEvent = any;
-export type TLeaderboard = any;
-export type TMissionResponse = any;
+export type TResponseInfo = {
+    error_message: string;
+    error_code: number;
+    event_tracking: string;
+};
+
+export type TGetExchangeResponse = {
+    response_info: TResponseInfo;
+    result: {
+        balance: number;
+        exchangeRate: number;
+        counter: number;
+        counterLimit: number;
+        fromCurrency: string;
+        toCurrency: string;
+    };
+};
+
+export type TPostExchangeResponse = {
+    response_info: TResponseInfo;
+    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 type TSpin = {
+    response_info: TResponseInfo;
+    result: {
+        time: number;
+        statusCode: number;
+        countTurnLeft: number;
+        requestId: string;
+        counter: number;
+        giftInfo: {
+            giftId: string;
+            giftCode: string;
+            imgUrl: string;
+            walletType: number;
+            ver: number;
+            amount: number;
+            agent: string;
+            duration: number;
+            giftDesc: string;
+            ctaStatus: string;
+            title: string;
+            description: string;
+            quantity: number;
+            iconUrl: string;
+            index: number;
+            notiId: string;
+            extra: string;
+        };
+    };
+};
+
+export type TShake = {
+    response_info: TResponseInfo;
+    result: {
+        time: number;
+        statusCode: number;
+        countTurnLeft: number;
+        requestId: string;
+        giftInfo: {
+            giftId: string;
+            giftCode: string;
+            imgUrl: string;
+            walletType: number;
+            ver: number;
+            amount: string;
+            agent: string;
+            duration: string;
+            giftDesc: string;
+            ctaStatus: string;
+            revision: string;
+            status: string;
+            createdDate: string;
+            createdUser: string;
+            updatedDate: string;
+            updatedUser: string;
+            giftPackage: string;
+            title: string;
+            description: string;
+            quantity: number;
+            index: number;
+            iconUrl: string;
+        };
+    };
+};
+
+export type TCoinBalanceResponse = {
+    response_info: TResponseInfo;
+    result: { userId: string; balance: number };
+};
+
+export type TBalance = {
+    response_info: TResponseInfo;
+    result: { balances: { turn: number; icon: string } };
+};
+
+export type TBalanceConfig = {
+    response_info: TResponseInfo;
+    result: {
+        config: { balanceId: string; name: string; icon: string }[];
+        balances: { [key: string]: number };
+    };
+};
+
+export type TGameConfigCampaign = {
+    gameId: string;
+    gameidTitle: string;
+    startTime: number;
+    endTime: number;
+    ruleDetail: string;
+    icon: string;
+    themes: any;
+    status: boolean;
+};
+
+export type TGameConfig = {
+    response_info: TResponseInfo;
+    result: { time: number; campaign: TGameConfigCampaign };
+};
+
+export type THistoryItem = {
+    tag: string[];
+    icon: string;
+    title: string;
+    desc: string;
+    refId: string;
+    refExtra: string;
+    timestamp: number;
+};
+
+export type THistory = {
+    response_info: TResponseInfo;
+    result: { history: THistoryItem[]; category: string[] };
+};
+
+export type TeventItem = {
+    id: string;
+    startMs: number;
+    endMs: number;
+    title: string;
+    banner1x2: string;
+    banner1x1: string;
+    refId: string;
+};
+
+export type TEvent = {
+    response_info: TResponseInfo;
+    result: TeventItem[];
+};
+
+export type TLeaderboardItem = {
+    name: string;
+    avatar: string;
+    rank: number;
+    score: number;
+};
+
+export type TLeaderboard = {
+    response_info: TResponseInfo;
+    result: {
+        serverTime: number;
+        resetTime: number;
+        metadata: TLeaderboardItem;
+        board: TLeaderboardItem[];
+    };
+};
+
+export interface TMissionBalanceItem {
+    balanceAmount: number;
+    balanceId: string;
+}
+
+export interface TMissionInstructionStep {
+    title: string;
+    image: string;
+    instruction: string;
+}
+
+export interface TMissionInstructionInfo {
+    steps: TMissionInstructionStep[];
+}
+
+export interface TMissionRewardCondition {
+    rewardId: string;
+    conditionType: string;
+    conditionValue: number;
+    numAvailableReward: number;
+    numReceivedReward: number;
+    canGetReward: boolean;
+    isAutoClaimReward: boolean;
+}
+
+export interface TMissionSucceededCounter {
+    counterId: string;
+    limitType: string;
+    limitUnit: number;
+    startTime: number;
+    endTime: number;
+    upperBound: number;
+    numSucceeded: number;
+    isMainCounter: boolean;
+    rewardConditions: TMissionRewardCondition[];
+}
+
+export interface TMissionInfo {
+    title?: string;
+    description?: string;
+    icon?: string;
+    ctaText?: string;
+    refId?: string;
+    refExtra?: string | Record<string, unknown> | null;
+    progressData?: string;
+    rewardText?: string;
+    missionType?: string;
+    frameType?: string;
+    videoLink?: string;
+    videoDesc?: string;
+    balanceList?: TMissionBalanceItem[];
+    shareTitle?: string;
+    shareDescription?: string;
+    shareImgUrl?: string;
+    linkShare?: string;
+    instructionInfo?: TMissionInstructionInfo;
+    instruction_info?: TMissionInstructionInfo;
+    bonusInfo: TMissionBonusInfo;
+}
+
+export interface TMissionBonusInfo {
+    missionId: string;
+    missionInfo: TMissionInfo;
+    endMission: number;
+    succeededCounter: TMissionSucceededCounter[];
+    globalSucceededCounter: TMissionSucceededCounter[];
+    isCompleted: boolean;
+}
+
+export interface TMissionItem {
+    missionId: string;
+    missionInfo: TMissionInfo;
+    startMission: number;
+    endMission: number;
+    group: string;
+    sort: number;
+    succeededCounter: TMissionSucceededCounter[];
+    globalSucceededCounter: TMissionSucceededCounter[];
+    isCompleted: boolean;
+    canGetReward: boolean;
+    isComingSoon: boolean;
+    isExpired: boolean;
+}
+
+export interface TMissionResponse {
+    response_info: TResponseInfo;
+    result: TMissionItem[];
+}