@xmobitea/gn-typescript-client 2.6.12-tsc → 2.6.13-tsc

package/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [2020 - 2025] [XmobiTea Family]
+   Copyright [2020 - 2026] [XmobiTea Family]
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

package/README.MD

@@ -0,0 +1 @@
+This is GearN-typescript-client-sdk use for GearN-server

package/dist/index.d.ts

@@ -136,12 +136,10 @@ import { UploadFileResponse } from "./runtime/entity/response/UploadFileResponse
 export { UploadFileResponse };
 import { InvalidMember } from "./runtime/entity/InvalidMember";
 import { OperationEvent } from "./runtime/entity/OperationEvent";
-import { OperationHelper } from "./runtime/entity/OperationHelper";
 import { OperationRequest } from "./runtime/entity/OperationRequest";
 import { OperationResponse } from "./runtime/entity/OperationResponse";
 export { InvalidMember };
 export { OperationEvent };
-export { OperationHelper };
 export { OperationRequest };
 export { OperationResponse };
 import { GNDebug, LogType } from "./runtime/logger/GNDebug";
@@ -196,10 +194,12 @@ import { GNSupport } from "./runtime/helper/GNSupport";
 import { CodeHelper } from "./runtime/helper/CodeHelper";
 import { ConverterService } from "./runtime/helper/ConverterService";
 import { GNUtils } from "./runtime/helper/GNUtils";
+import { OperationHelper } from "./runtime/helper/OperationHelper";
 export { GNSupport };
 export { CodeHelper };
 export { ConverterService };
 export { GNUtils };
+export { OperationHelper };
 import { DataMember, StringDataMember, BooleanDataMember, GNHashtableDataMember, GNArrayDataMember, NumberDataMember } from "./runtime/entity/DataMember";
 export { DataMember, StringDataMember, BooleanDataMember, GNHashtableDataMember, GNArrayDataMember, NumberDataMember };
 import { GNObjectMetadata, AbstractConstructor, Constructor, FieldDataType, GNObjectFieldMetadata } from "./runtime/entity/GNMetadata";

package/dist/index.js

@@ -125,11 +125,9 @@ export { HealthCheckResponse };
 import { UploadFileResponse } from "./runtime/entity/response/UploadFileResponse";
 export { UploadFileResponse };
 import { OperationEvent } from "./runtime/entity/OperationEvent";
-import { OperationHelper } from "./runtime/entity/OperationHelper";
 import { OperationRequest } from "./runtime/entity/OperationRequest";
 import { OperationResponse } from "./runtime/entity/OperationResponse";
 export { OperationEvent };
-export { OperationHelper };
 export { OperationRequest };
 export { OperationResponse };
 import { GNDebug, LogType } from "./runtime/logger/GNDebug";
@@ -190,10 +188,12 @@ import { GNSupport } from "./runtime/helper/GNSupport";
 import { CodeHelper } from "./runtime/helper/CodeHelper";
 import { ConverterService } from "./runtime/helper/ConverterService";
 import { GNUtils } from "./runtime/helper/GNUtils";
+import { OperationHelper } from "./runtime/helper/OperationHelper";
 export { GNSupport };
 export { CodeHelper };
 export { ConverterService };
 export { GNUtils };
+export { OperationHelper };
 import { DataMember, StringDataMember, BooleanDataMember, GNHashtableDataMember, GNArrayDataMember, NumberDataMember } from "./runtime/entity/DataMember";
 export { DataMember, StringDataMember, BooleanDataMember, GNHashtableDataMember, GNArrayDataMember, NumberDataMember };
 import { FieldDataType } from "./runtime/entity/GNMetadata";

package/dist/runtime/GNNetwork.d.ts

@@ -41,7 +41,7 @@ export declare class GNNetwork {
     static getServerTimestamp(): number;
     static getAuthenticateStatus(): AuthenticateStatus;
     static getGameId(): string;
-    static getPlatform(): number;
+    static getPlatform(): string;
     static authenticate: AuthenticateApi;
     static characterPlayer: CharacterPlayerApi;
     static content: ContentApi;

package/dist/runtime/GNNetwork.js

@@ -3,7 +3,7 @@ import { GNDebug } from "./logger/GNDebug";
 import { GNSupport } from "./helper/GNSupport";
 import { NetworkingPeer } from "./networking/NetworkingPeer";
 import { CodeHelper } from "./helper/CodeHelper";
-import store from "store";
+import { StorageService } from "./helper/StorageService";
 import { ServiceUpdate } from "./typescript/ServiceUpdate";
 import { AuthenticateApi } from "./GNNetworkAuthenticateApi";
 import { CharacterPlayerApi } from "./GNNetworkCharacterPlayerApi";
@@ -46,7 +46,20 @@ export class GNNetwork {
         return GNNetwork.peer.gameId;
     }
     static getPlatform() {
-        return 17;
+        const platform = GNSupport.getPlatformType();
+        // if (platform == "browser" || platform == "nodejs") {
+        //     return platform;
+        // }
+        // else if (platform == "cocos") {
+        //     if (cc.sys.platform === cc.sys.ANDROID) {
+        //         console.log('Running on Android');
+        //     } else if (cc.sys.platform === cc.sys.IPHONE) {
+        //         console.log('Running on iOS');
+        //     } else if (cc.sys.isBrowser) {
+        //         console.log('Running in a Web Browser');
+        //     }
+        // }
+        return platform;
     }
     static init(gnServerSettings) {
         if (GNNetwork.gnServerSettings != null) {
@@ -61,9 +74,9 @@ export class GNNetwork {
         GNNetwork.initGNDebug();
         GNDebug.log("GNNetwork init on " + (GNSupport.isBrowser() ? "browser." : "server.") + " Version: " + GNNetwork.getClientSdkVersion());
         GNNetwork.initGNSocketObject();
-        GNNetwork.peer.authenticateStatus.setAuthToken(store.get(GNNetwork.AUTH_TOKEN_KEY, ""));
-        GNNetwork.peer.authenticateStatus.setUserId(store.get(GNNetwork.USER_ID_KEY, ""));
-        GNNetwork.peer.gameId = store.get(GNNetwork.GAME_ID_KEY, "");
+        GNNetwork.peer.authenticateStatus.setAuthToken(StorageService.getString(GNNetwork.AUTH_TOKEN_KEY, ""));
+        GNNetwork.peer.authenticateStatus.setUserId(StorageService.getString(GNNetwork.USER_ID_KEY, ""));
+        GNNetwork.peer.gameId = StorageService.getString(GNNetwork.GAME_ID_KEY, "");
         GNNetwork.authenticate = new AuthenticateApi();
         GNNetwork.characterPlayer = new CharacterPlayerApi();
         GNNetwork.content = new ContentApi();
@@ -77,13 +90,13 @@ export class GNNetwork {
         GNNetwork.cloudScript = new CloudScriptApi();
     }
     static setNewAuthenticateStatus(authenticateStatus) {
-        store.set(GNNetwork.AUTH_TOKEN_KEY, authenticateStatus.getAuthToken());
-        store.set(GNNetwork.USER_ID_KEY, authenticateStatus.getUserId());
+        StorageService.setString(GNNetwork.AUTH_TOKEN_KEY, authenticateStatus.getAuthToken());
+        StorageService.setString(GNNetwork.USER_ID_KEY, authenticateStatus.getUserId());
         GNNetwork.peer.authenticateStatus.setAuthToken(authenticateStatus.getAuthToken());
         GNNetwork.peer.authenticateStatus.setUserId(authenticateStatus.getUserId());
     }
     static setGameId(gameId) {
-        store.set(GNNetwork.GAME_ID_KEY, gameId);
+        StorageService.setString(GNNetwork.GAME_ID_KEY, gameId);
         GNNetwork.peer.gameId = gameId;
     }
     static getClientSdkVersion() {

package/dist/runtime/common/GNData.js

@@ -115,9 +115,7 @@ export class GNHashtable extends GNData {
         return Object.keys(this.dict).length;
     }
     containsKey(k) {
-        let keys = Object.keys(this.dict);
-        let kStr = k.toString();
-        return keys.indexOf(kStr) != -1;
+        return this.dict.hasOwnProperty(k);
     }
     get(k, def) {
         let value = this.dict[k];
@@ -156,11 +154,11 @@ export class GNArrayBuilder {
         return this;
     }
     build() {
-        let awnser = new GNArray();
+        let answer = new GNArray();
         this.array.forEach(o => {
-            awnser.add(o);
+            answer.add(o);
         });
-        return awnser;
+        return answer;
     }
     constructor() {
         this.array = [];

package/dist/runtime/helper/GNSupport.d.ts

@@ -1,5 +1,25 @@
+type PlatformType = "cocos" | "browser" | "nodejs";
 export declare class GNSupport {
     private static _isBrowser;
+    private static _isCocosCreator;
+    private static _platformType;
+    private static _initialized;
     static init(): void;
+    /**
+     * Check if running in standard browser environment
+     */
     static isBrowser(): boolean;
+    /**
+     * Check if running in Cocos Creator 3.x environment
+     */
+    static isCocosCreator(): boolean;
+    /**
+     * Check if running in Node.js environment
+     */
+    static isNodeJS(): boolean;
+    /**
+     * Get the current platform type
+     */
+    static getPlatformType(): PlatformType;
 }
+export {};

package/dist/runtime/helper/GNSupport.js

@@ -1,8 +1,47 @@
+// Types from ../types/cocos.d.ts are automatically available
 export class GNSupport {
     static init() {
+        if (this._initialized)
+            return;
+        // Check for Cocos Creator 3.x first (has cc.sys)
+        this._isCocosCreator = (typeof cc !== "undefined" && cc.sys !== undefined);
+        // Browser check (has window but not Node.js)
         this._isBrowser = (typeof window !== "undefined");
+        // Determine platform type
+        if (this._isCocosCreator) {
+            this._platformType = "cocos";
+        }
+        else if (this._isBrowser) {
+            this._platformType = "browser";
+        }
+        else {
+            this._platformType = "nodejs";
+        }
+        this._initialized = true;
     }
+    /**
+     * Check if running in standard browser environment
+     */
     static isBrowser() {
         return this._isBrowser;
     }
+    /**
+     * Check if running in Cocos Creator 3.x environment
+     */
+    static isCocosCreator() {
+        return this._isCocosCreator;
+    }
+    /**
+     * Check if running in Node.js environment
+     */
+    static isNodeJS() {
+        return this._platformType === "nodejs";
+    }
+    /**
+     * Get the current platform type
+     */
+    static getPlatformType() {
+        return this._platformType;
+    }
 }
+GNSupport._initialized = false;

package/dist/runtime/{entity → helper}/OperationHelper.d.ts

@@ -1,6 +1,6 @@
 import { RequestRole } from "./../constant/enumType/RequestRole";
 import { RequestType } from "./../constant/enumType/RequestType";
-import { OperationRequest } from "./OperationRequest";
+import { OperationRequest } from "./../entity/OperationRequest";
 export declare class OperationHelper {
     static toSocketData(requestType: RequestType, role: RequestRole, request: OperationRequest): any;
     static toHttpData(requestType: RequestType, role: RequestRole, request: OperationRequest): any;

package/dist/runtime/{entity → helper}/OperationHelper.js

@@ -1,4 +1,4 @@
-import { CodeHelper } from "./../helper/CodeHelper";
+import { CodeHelper } from "./CodeHelper";
 export class OperationHelper {
     static toSocketData(requestType, role, request) {
         let requestId = request.getRequestId();

package/dist/runtime/helper/StorageService.d.ts

@@ -0,0 +1,18 @@
+/**
+ * StorageService - Cross-platform storage abstraction for GearN SDK
+ * Supports: Browser localStorage, Node.js, Cocos Creator 3.x
+ */
+export declare class StorageService {
+    /**
+     * Get a value from storage
+     * @param key Storage key
+     * @param defaultValue Default value if key doesn't exist
+     */
+    static getString(key: string, defaultValue?: string): any;
+    /**
+     * Set a value in storage
+     * @param key Storage key
+     * @param value Value to store
+     */
+    static setString(key: string, value: string): void;
+}

package/dist/runtime/helper/StorageService.js

@@ -0,0 +1,62 @@
+/**
+ * StorageService - Cross-platform storage abstraction for GearN SDK
+ * Supports: Browser localStorage, Node.js, Cocos Creator 3.x
+ */
+import store from "store";
+import { GNSupport } from "./GNSupport";
+// Types from ../types/cocos.d.ts are automatically available
+export class StorageService {
+    /**
+     * Get a value from storage
+     * @param key Storage key
+     * @param defaultValue Default value if key doesn't exist
+     */
+    static getString(key, defaultValue = "") {
+        try {
+            const _platform = GNSupport.getPlatformType();
+            let value = null;
+            switch (_platform) {
+                case "cocos":
+                    value = cc.sys.localStorage.getItem(key);
+                    break;
+                case "browser":
+                    value = window.localStorage.getItem(key);
+                    break;
+                case "nodejs":
+                    return store.get(key, defaultValue);
+            }
+            if (value === null || value === undefined) {
+                return defaultValue;
+            }
+            return value;
+        }
+        catch (error) {
+            console.warn("[StorageService] Error getting value for key:", key, error);
+            return defaultValue;
+        }
+    }
+    /**
+     * Set a value in storage
+     * @param key Storage key
+     * @param value Value to store
+     */
+    static setString(key, value) {
+        try {
+            const _platform = GNSupport.getPlatformType();
+            switch (_platform) {
+                case "cocos":
+                    cc.sys.localStorage.setItem(key, value);
+                    break;
+                case "browser":
+                    window.localStorage.setItem(key, value);
+                    break;
+                case "nodejs":
+                    store.set(key, value);
+                    break;
+            }
+        }
+        catch (error) {
+            console.warn("[StorageService] Error setting value for key:", key, error);
+        }
+    }
+}

package/dist/runtime/networking/NetworkingPeer.d.ts

@@ -10,7 +10,7 @@ import { RequestType } from "./../constant/enumType/RequestType";
 import { RequestRole } from "./../constant/enumType/RequestRole";
 import { GetAuthInfoResponse } from "./../entity/response/GetAuthInfoResponse";
 import { UploadFileResponse } from "./../entity/response/UploadFileResponse";
-import { HealthCheckResponse } from "../entity/response/HealthCheckResponse";
+import { HealthCheckResponse } from "./../entity/response/HealthCheckResponse";
 export declare class NetworkingPeer {
     static readonly SYNC_TS: string;
     static readonly GET_AUTH_INFO: string;

package/dist/runtime/networking/NetworkingPeer.js

@@ -18,6 +18,8 @@ export class NetworkingPeer {
             count++;
             totalPing += this.socketPeer.ping;
         }
+        if (count == 0)
+            return -1;
         return totalPing / count;
     }
     getClientId() {
@@ -25,13 +27,13 @@ export class NetworkingPeer {
     }
     setServerTimeMilliseconds(currentServerMilliseconds) {
         this.lastCurrentServerMilliseconds = currentServerMilliseconds;
-        this.lastGetCurrentMilliseconds = Date.now() / 1000;
+        this.lastGetCurrentMilliseconds = Date.now();
     }
     getServerTimestamp() {
-        return this.lastCurrentServerMilliseconds + ((Date.now() / 1000 - this.lastGetCurrentMilliseconds) * 1000);
+        return this.lastCurrentServerMilliseconds + ((Date.now() - this.lastGetCurrentMilliseconds) * 1000);
     }
     initPeer() {
-        this.setServerTimeMilliseconds(new Date().getUTCMilliseconds());
+        this.setServerTimeMilliseconds(Date.now());
         let gnServerSettings = GNNetwork.getGNServerSettings();
         if (gnServerSettings == null)
             throw new Error("Null GN Server Settings, please find it now");

package/dist/runtime/networking/OperationPending.js

@@ -3,7 +3,7 @@ export class OperationPending {
     constructor(requestType, role, operationRequest, onOperationResponse, authToken, secretKey, customTags, gameId) {
         this.operationRequest = operationRequest;
         this.onOperationResponse = onOperationResponse;
-        this.timeout = Date.now() / 1000 + OperationRequest.defaultTimeOut;
+        this.timeout = Date.now() + OperationRequest.defaultTimeOut * 1000;
         this.firstSend = 0;
         this.secondsSend = 0;
         this.requestType = requestType;
@@ -32,17 +32,17 @@ export class OperationPending {
         return this.customTags;
     }
     onSend() {
-        this.firstSend = Date.now() / 1000;
-        this.timeout = this.firstSend + this.operationRequest.getTimeout();
+        this.firstSend = Date.now();
+        this.timeout = this.firstSend + this.operationRequest.getTimeout() * 1000;
     }
     onRecv() {
-        this.secondsSend = Date.now() / 1000;
+        this.secondsSend = Date.now();
     }
     getExecuteTimerInMs() {
         return (this.secondsSend - this.firstSend);
     }
     isTimeout() {
-        return this.timeout < Date.now() / 1000;
+        return this.timeout < Date.now();
     }
     getOperationRequest() {
         return this.operationRequest;

package/dist/runtime/networking/PeerBase.js

@@ -5,7 +5,7 @@ import { OperationResponse } from "./../entity/OperationResponse";
 import { GNNetwork } from "./../GNNetwork";
 import { GNDebug } from "./../logger/GNDebug";
 import { OperationPending } from "./OperationPending";
-import store from "store";
+import { StorageService } from "./../helper/StorageService";
 export class PeerBase {
     constructor() {
         this.perMsgTimer = 0;
@@ -35,7 +35,7 @@ export class PeerBase {
         this.setSendRate(gnServerSettings.getSendRate());
     }
     enqueue(requestType, role, operationRequest, onOperationResponse, authToken, secretKey, customTags, gameId) {
-        if (!this.isUsing) {
+        if (!this.isUse) {
             GNDebug.logError("[GearN] Server Settings dont setup to use this to send operation request.");
             return;
         }
@@ -49,7 +49,7 @@ export class PeerBase {
         return this.isUse;
     }
     service() {
-        if (!this.isUsing)
+        if (!this.isUse)
             return;
         let nowSecond = Date.now() / 1000;
         if (this.checkTimeoutOperationPending < nowSecond) {
@@ -112,12 +112,12 @@ export class PeerBase {
                     if (parameters.containsKey(ParameterCode.AuthToken)) {
                         let authToken = parameters.getString(ParameterCode.AuthToken);
                         GNNetwork.getAuthenticateStatus().setAuthToken(authToken);
-                        store.set(GNNetwork.AUTH_TOKEN_KEY, authToken);
+                        StorageService.setString(GNNetwork.AUTH_TOKEN_KEY, authToken);
                     }
                     if (parameters.containsKey(ParameterCode.UserId)) {
                         let userId = parameters.getString(ParameterCode.UserId);
                         GNNetwork.getAuthenticateStatus().setUserId(userId);
-                        store.set(GNNetwork.USER_ID_KEY, userId);
+                        StorageService.setString(GNNetwork.USER_ID_KEY, userId);
                     }
                     if (parameters.containsKey(ParameterCode.Ts)) {
                         GNNetwork.peer.setServerTimeMilliseconds(parameters.getNumber(ParameterCode.Ts, new Date().getUTCMilliseconds()));

package/dist/runtime/networking/http/NetworkingPeerAxiosRequest.js

@@ -86,7 +86,7 @@ export class NetworkingPeerAxiosRequest extends NetworkingHttpPeerBase {
         }
         else if (postType == PostType.MsgPack) {
             let content = param.toData();
-            body = Buffer.from(MessagePackConverterService.serialize(content));
+            body = new Uint8Array(MessagePackConverterService.serialize(content));
             headers[Commands.CONTENT_TYPE] = Commands.APPLICATION_MSGPACK;
             headers[Commands.ACCEPT] = Commands.APPLICATION_MSGPACK;
             if (!GNSupport.isBrowser())

package/dist/runtime/networking/socket/NetworkingPeerSocketIOClient.js

@@ -2,7 +2,7 @@ import { Commands } from "./../../constant/Commands";
 import { GNDebug } from "./../../logger/GNDebug";
 import { NetworkingSocketPeerBase, SocketPacket } from "./NetworkingSocketPeerBase";
 import { GNNetwork } from "./../../GNNetwork";
-import { OperationHelper } from "./../../entity/OperationHelper";
+import { OperationHelper } from "./../../helper/OperationHelper";
 import { Manager } from "socket.io-client";
 import { ParameterCode } from "./../../constant/parameterCode/ParameterCode";
 import { MessagePackConverterService } from "./../../helper/MessagePackConverterService";

package/dist/runtime/typescript/ServiceUpdate.d.ts

@@ -1,6 +1,8 @@
 import { NetworkingPeer } from "./../networking/NetworkingPeer";
 export declare class ServiceUpdate {
+    private intervalId;
     peer: NetworkingPeer;
     run(): void;
+    stop(): void;
     private update;
 }

package/dist/runtime/typescript/ServiceUpdate.js

@@ -1,10 +1,20 @@
 export class ServiceUpdate {
+    constructor() {
+        this.intervalId = null;
+    }
     run() {
-        let thiz = this;
-        setInterval(() => {
-            thiz.update();
+        if (this.intervalId)
+            return;
+        this.intervalId = setInterval(() => {
+            this.update();
         }, 50);
     }
+    stop() {
+        if (!this.intervalId)
+            return;
+        clearInterval(this.intervalId);
+        this.intervalId = null;
+    }
     update() {
         if (this.peer != null)
             this.peer.service();

package/docs/COCOS_CREATOR_INTEGRATION.md

@@ -0,0 +1,116 @@
+# GearN SDK - Cocos Creator 3.x Integration Guide
+
+## Overview
+
+GearN TypeScript SDK hỗ trợ đầy đủ Cocos Creator 3.x thông qua npm package.
+
+## Installation
+
+### 1. Cài đặt qua npm
+
+Trong thư mục project Cocos Creator của bạn:
+
+```bash
+npm install @xmobitea/gn-typescript-client
+```
+
+### 2. TypeScript Configuration
+
+Đảm bảo `tsconfig.json` của Cocos Creator project có cài đặt tương thích:
+
+```json
+{
+  "compilerOptions": {
+    "esModuleInterop": true,
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true
+  }
+}
+```
+
+## Basic Usage
+
+### Initialize SDK
+
+```typescript
+import { GNNetwork, GNServerSettings, LogType, MessageType } from '@xmobitea/gn-typescript-client';
+
+// Tạo server settings
+const settings = new GNServerSettings({
+    httpUrl: "http://your-server:8080",
+    socketUrl: "ws://your-server:8080",
+    secretKey: "your-secret-key",
+    useSocket: true,
+    useHttp: true,
+    logType: LogType.All,
+    sendRate: 30,
+    messageType: MessageType.MsgPack,
+});
+
+// Initialize
+GNNetwork.init(settings);
+```
+
+### Authentication
+
+```typescript
+// Login với Device ID
+const response = await GNNetwork.authenticate.loginDeviceIdAsync({
+    deviceId: "unique-device-id",
+    createAccount: true,
+});
+
+if (!response.hasError()) {
+    console.log("User ID:", GNNetwork.getAuthenticateStatus().getUserId());
+}
+```
+
+### Socket Connection
+
+```typescript
+// Subscribe events
+GNNetwork.subscriberOnConnectHandler(() => {
+    console.log("Connected!");
+    GNNetwork.sendRequestAuthSocket();
+});
+
+GNNetwork.subscriberOnDisconnectHandler(() => {
+    console.log("Disconnected!");
+});
+
+// Connect
+GNNetwork.connectSocket();
+```
+
+## Example Component
+
+Xem file mẫu hoàn chỉnh tại: [examples/cocos-creator/GearNExample.ts](../examples/cocos-creator/GearNExample.ts)
+
+## Platform Detection
+
+SDK tự động phát hiện Cocos Creator environment:
+
+```typescript
+import { GNSupport } from '@xmobitea/gn-typescript-client';
+
+if (GNSupport.isCocosCreator()) {
+    console.log("Running in Cocos Creator");
+}
+```
+
+## Storage
+
+SDK tự động sử dụng `cc.sys.localStorage` trong Cocos Creator để lưu auth token.
+
+## Troubleshooting
+
+### Module not found
+Đảm bảo đã chạy `npm install` trong project folder.
+
+### Build errors
+Kiểm tra `tsconfig.json` có `esModuleInterop: true`.
+
+## Support
+
+- GitHub Issues: https://github.com/XmobiTea-Family/GearN-typescript-client-sdk/issues
+- Homepage: https://gearn.net