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

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/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/{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/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/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/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/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

package/examples/cocos-creator/GearNExample.ts.txt

@@ -0,0 +1,176 @@
+/**
+ * GearNExample.ts - Example Cocos Creator 3.x Component using GearN SDK
+ * 
+ * This component demonstrates how to integrate the GearN SDK
+ * with a Cocos Creator 3.x project.
+ * 
+ * Installation:
+ * 1. npm install @xmobitea/gn-typescript-client
+ * 2. Copy this file to your Cocos Creator project's scripts folder
+ * 3. Attach to a Node in your scene
+ */
+
+import { _decorator, Component, log, warn, error } from 'cc';
+
+// Import GearN SDK
+import {
+    GNNetwork,
+    GNServerSettings,
+    GNServerSettingsOptions,
+    LogType,
+    MessageType
+} from '@xmobitea/gn-typescript-client';
+
+const { ccclass, property } = _decorator;
+
+@ccclass('GearNExample')
+export class GearNExample extends Component {
+
+    @property({ tooltip: "GearN Server HTTP URL" })
+    httpUrl: string = "http://localhost:8080";
+
+    @property({ tooltip: "GearN Server Socket URL" })
+    socketUrl: string = "ws://localhost:8080";
+
+    @property({ tooltip: "Your Game/App Secret Key" })
+    secretKey: string = "";
+
+    @property({ tooltip: "Enable debug logging" })
+    enableDebugLog: boolean = true;
+
+    start() {
+        this.initializeGearN();
+    }
+
+    /**
+     * Initialize GearN SDK
+     */
+    private initializeGearN(): void {
+        try {
+            // Create server settings
+            const settings: GNServerSettingsOptions = {
+                httpUrl: this.httpUrl,
+                socketUrl: this.socketUrl,
+                secretKey: this.secretKey,
+                useSocket: true,
+                useHttp: true,
+                logType: this.enableDebugLog ? LogType.All : LogType.None,
+                sendRate: 30,
+                messageType: MessageType.MsgPack,
+                socketReconnectDelay: 1000,
+                socketPingInterval: 3000,
+                socketPingTimeout: 5000,
+                httpRequestTimeout: 10,
+            };
+
+            const gnServerSettings = new GNServerSettings(settings);
+
+            // Initialize GearN
+            GNNetwork.init(gnServerSettings);
+
+            log('[GearN] SDK initialized successfully!');
+            log('[GearN] Platform:', GNNetwork.getPlatform());
+
+            // Subscribe to connection events
+            this.setupConnectionHandlers();
+
+        } catch (err) {
+            error('[GearN] Failed to initialize SDK:', err);
+        }
+    }
+
+    /**
+     * Setup socket connection event handlers
+     */
+    private setupConnectionHandlers(): void {
+        GNNetwork.subscriberOnConnectHandler(() => {
+            log('[GearN] Socket connected! SID:', GNNetwork.getSocketSId());
+
+            // Authenticate after connection
+            this.onSocketConnected();
+        });
+
+        GNNetwork.subscriberOnDisconnectHandler(() => {
+            warn('[GearN] Socket disconnected!');
+        });
+    }
+
+    /**
+     * Called when socket is connected
+     */
+    private onSocketConnected(): void {
+        // Example: Send auth token if already logged in
+        const authStatus = GNNetwork.getAuthenticateStatus();
+        if (authStatus.getAuthToken()) {
+            GNNetwork.sendRequestAuthSocket();
+            log('[GearN] Auth token sent to socket');
+        }
+    }
+
+    /**
+     * Connect to socket server
+     */
+    public connectSocket(): void {
+        log('[GearN] Connecting to socket...');
+        GNNetwork.connectSocket(() => {
+            log('[GearN] Socket connection initiated');
+        });
+    }
+
+    /**
+     * Disconnect from socket server
+     */
+    public disconnectSocket(): void {
+        log('[GearN] Disconnecting from socket...');
+        GNNetwork.disconnectSocket(() => {
+            log('[GearN] Socket disconnected');
+        });
+    }
+
+    /**
+     * Example: Login with device ID
+     */
+    public async loginWithDeviceId(deviceId: string): Promise<void> {
+        try {
+            log('[GearN] Logging in with device ID:', deviceId);
+
+            const response = await GNNetwork.authenticate.loginDeviceIdAsync({
+                deviceId: deviceId,
+                createAccount: true,
+            });
+
+            if (response.hasError()) {
+                error('[GearN] Login failed:', response.getDebugMessage());
+                return;
+            }
+
+            log('[GearN] Login successful!');
+            log('[GearN] User ID:', GNNetwork.getAuthenticateStatus().getUserId());
+
+            // Connect socket after successful login
+            this.connectSocket();
+
+        } catch (err) {
+            error('[GearN] Login error:', err);
+        }
+    }
+
+    /**
+     * Example: Get server health status
+     */
+    public async checkServerHealth(): Promise<void> {
+        try {
+            const response = await GNNetwork.healthCheckAsync();
+            log('[GearN] Server health:', response);
+        } catch (err) {
+            error('[GearN] Health check failed:', err);
+        }
+    }
+
+    onDestroy() {
+        // Cleanup: disconnect socket when component is destroyed
+        if (GNNetwork.isSocketConnected()) {
+            GNNetwork.disconnectSocket();
+        }
+    }
+}

package/package.json

@@ -1,18 +1,19 @@
 {
   "name": "@xmobitea/gn-typescript-client",
-  "version": "2.6.12-tsc",
+  "version": "2.6.13",
   "description": "GearN Typescript Client SDK by XmobiTea (Pro)",
   "types": "dist/index.d.ts",
   "main": "dist/index.js",
   "scripts": {
-    "dev": "rm -rf ./dist && npm run buildnode && npm run debug",
+    "dev": "rm -rf ./dist && npm run build:node && npm run debug",
     "debug": "node index.js",
     "test": "mocha -r ts-node/register ./test/**/*.test.ts",
-    "buildnode": "webpack --config webpack.config.mjs --mode production --stats-modules",
-    "buildudm": "webpack --config webpack.config.udm.mjs --mode production --stats-modules",
-    "buildminudm": "webpack --config webpack.config.min.udm.mjs --mode production --stats-modules",
-    "build": "rm -rf ./dist && npm run buildnode && npm run buildudm && npm run buildminudm",
+    "build:node": "webpack --config webpack.config.mjs --mode production --stats-modules",
+    "build:udm": "webpack --config webpack.config.udm.mjs --mode production --stats-modules",
+    "build:minudm": "webpack --config webpack.config.min.udm.mjs --mode production --stats-modules",
+    "build": "rm -rf ./dist && npm run build:node && npm run build:udm && npm run build:minudm",
     "build:withoutwebpack": "rm -rf ./dist && tsc",
+    "build:cocos": "rm -rf ./dist && webpack --config webpack.config.cocos.mjs --mode production --stats-modules",
     "push": "npm run build && npm publish && git push"
   },
   "author": "changx.develop@gmail.com (https://xmobitea.com)",
@@ -32,10 +33,10 @@
     "webpack-node-externals": "^3.0.0"
   },
   "dependencies": {
-    "@msgpack/msgpack": "^2.8.0",
-    "axios": "^1.10.0",
+    "@msgpack/msgpack": "^3.1.3",
+    "axios": "^1.13.2",
     "reflect-metadata": "^0.2.2",
-    "socket.io-client": "^4.8.1",
+    "socket.io-client": "^4.8.3",
     "store": "^2.0.12"
   },
   "directories": {
@@ -62,4 +63,4 @@
   "engines": {
     "node": ">=20.0.0"
   }
-}
+}

package/srcSwift/Package.swift

@@ -0,0 +1,32 @@
+// swift-tools-version: 5.7
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+    name: "GearN",
+    products: [
+        // Products define the executables and libraries a package produces, making them visible to other packages.
+        .library(
+            name: "GearN",
+            targets: ["GearN"]),
+    ],
+    dependencies: [
+        // Dependencies declare other packages that this package depends on.
+        .package(url: "https://github.com/socketio/socket.io-client-swift", from: "16.1.1"),
+    ],
+    targets: [
+        // Targets are the basic building blocks of a package, defining a module or a test suite.
+        // Targets can depend on other targets in this package and products from dependencies.
+        .target(
+            name: "GearN",
+            dependencies: [
+                .product(name: "SocketIO", package: "socket.io-client-swift")
+            ],
+            path: "Sources/GearN"),
+        .testTarget(
+            name: "GearNTests",
+            dependencies: ["GearN"],
+            path: "Tests/GearNTests"),
+    ]
+)