@xmobitea/gn-typescript-client 2.6.13 → 2.6.14

package/dist/runtime/constant/enumType/PermissionDataItem.d.ts

@@ -1,4 +1,26 @@
+/**
+ * Write-permission policy for a configured data-item key.
+ *
+ * The GearN backend lets each game declare its own custom-data
+ * keys (player data, statistics, currencies, tags). For each key
+ * the catalog can specify whether the value can be overwritten by
+ * subsequent normal-flow writes or whether it is treated as
+ * write-once / set-once.
+ *
+ * Surfaced in catalog metadata responses; the runtime enforces
+ * the rule when the matching `set*` operation runs.
+ */
 export declare enum PermissionDataItem {
+    /**
+     * Once written, the value cannot be replaced through normal
+     * write flows. Useful for first-creation timestamps,
+     * commitment tokens, or values that should only be reset by
+     * privileged admin operations.
+     */
     ReadOnly = 1,
+    /**
+     * Standard read/write semantics — subsequent writes replace
+     * the previous value.
+     */
     CanOverride = 2
 }

package/dist/runtime/constant/enumType/PushPlatformType.d.ts

@@ -1,4 +1,22 @@
+/**
+ * Mobile platform discriminator for push-notification registrations.
+ *
+ * Used when a player registers a device token with the GearN
+ * backend so the server can later route a push through the right
+ * platform service (FCM for Android, APNS for iOS).
+ *
+ * Surfaced on
+ * `MasterPlayerModels.PushNotificationRegistration.platformType`.
+ */
 export declare enum PushPlatformType {
+    /**
+     * Android — the registered token is an FCM token consumed by
+     * the backend's Firebase integration.
+     */
     Android = 1,
+    /**
+     * iOS — the registered token is an APNS token consumed by the
+     * backend's Apple push integration.
+     */
     iOS = 2
 }

package/dist/runtime/constant/enumType/RequestRole.d.ts

@@ -1,5 +1,37 @@
+/**
+ * Trust-boundary discriminator carried with every request.
+ *
+ * The backend evaluates the active auth token against a different
+ * permission table for each role, and the SDK uses the role to
+ * pick the correct secret key when calling routes that require
+ * one. The role is part of the wire frame produced by
+ * {@link OperationHelper.toSocketData} and the URL produced by
+ * {@link HttpPeer.send}.
+ *
+ * Each generated `*Api` namespace exposes the matching
+ * `.server` / `.admin` sub-namespaces when the underlying
+ * operations support those roles. Application code rarely picks
+ * a role manually — call the `.server.*` / `.admin.*` methods
+ * instead.
+ */
 export declare enum RequestRole {
+    /**
+     * Administrative scope. Reserved for operations tooling that
+     * authenticated as an admin account
+     * (`loginByAdminAccount`). The backend evaluates the token
+     * against the admin permission table.
+     */
     Admin = 1,
+    /**
+     * Trusted backend / server-to-server scope. Reserved for
+     * trusted backends like a game server or webhook handler
+     * authenticating with a server-side secret key.
+     */
     Server = 2,
+    /**
+     * Public client scope. Used by player applications running on
+     * untrusted devices. Most operations exposed by the SDK
+     * default to this role.
+     */
     Client = 3
 }

package/dist/runtime/constant/enumType/RequestType.d.ts

@@ -1,14 +1,84 @@
+/**
+ * Logical request domain used to route an operation to the right
+ * backend handler.
+ *
+ * Every request frame carries a {@link RequestType} plus an
+ * {@link OperationCode}; together they uniquely identify the
+ * operation. The SDK uses {@link CodeHelper.getRequestTypeName} to
+ * convert the numeric value to the lowercase-first-letter string
+ * the backend expects on the wire (e.g. `RequestType.Authenticate`
+ * → `"authenticate"` in the URL or socket frame).
+ *
+ * The numeric ordinals are part of the stable wire contract
+ * because they are used by every generated `*OperationRequest`
+ * subclass. Do not reorder.
+ */
 export declare enum RequestType {
+    /**
+     * Custom application-defined operations — reserved for code
+     * that ships its own ad-hoc handlers on the backend. The
+     * SDK's typed wrappers do not use this value directly.
+     */
     Custom = 0,
+    /**
+     * Authentication, registration, refresh-token and identity
+     * link/unlink operations. Routed through
+     * `GNNetwork.authenticate`.
+     */
     Authenticate = 1,
+    /**
+     * Per-character profile, friend, group and notification
+     * operations. Routed through `GNNetwork.characterPlayer`.
+     */
     CharacterPlayer = 2,
+    /**
+     * Content / file metadata, upload-token and download-token
+     * operations. Routed through `GNNetwork.content`.
+     */
     Content = 3,
+    /**
+     * Account-level player operations (master-player profile,
+     * link state, friends, groups, notifications). Routed through
+     * `GNNetwork.gamePlayer`.
+     */
     GamePlayer = 4,
+    /**
+     * Group / guild metadata, member roles, message wall, group
+     * currencies, group statistics. Routed through
+     * `GNNetwork.group`.
+     */
     Group = 5,
+    /**
+     * Inventory item metadata, ownership ledger, statistics, audit
+     * log. Routed through `GNNetwork.inventory`.
+     */
     Inventory = 6,
+    /**
+     * Master-player account / identity / profile operations
+     * (one master player per GearN account). Routed through
+     * `GNNetwork.masterPlayer`.
+     */
     MasterPlayer = 7,
+    /**
+     * Store catalog, purchase, gift, receipt validation and audit
+     * operations. Routed through `GNNetwork.storeInventory`.
+     */
     StoreInventory = 8,
+    /**
+     * Dashboard / admin operations. Routed through
+     * `GNNetwork.dashboard`. The backend evaluates admin
+     * privileges from the auth token, so this domain is not
+     * limited to {@link RequestRole.Admin}.
+     */
     Dashboard = 9,
+    /**
+     * Matchmaking ticket lifecycle and match-history operations.
+     * Routed through `GNNetwork.multiplayer`.
+     */
     Multiplayer = 10,
+    /**
+     * CloudScript execute, publish and version-management
+     * operations. Routed through `GNNetwork.cloudScript`.
+     */
     CloudScript = 11
 }

package/dist/runtime/constant/enumType/StoreItemType.d.ts

@@ -1,4 +1,25 @@
+/**
+ * Discriminator for store catalog entries that controls whether the
+ * item can be re-purchased.
+ *
+ * Distinct from {@link ItemType} — `ItemType` describes how the
+ * **inventory ledger** stacks instances, whereas `StoreItemType`
+ * controls what the **storefront** allows the player to buy.
+ *
+ * Configured at store-catalog setup time and surfaced on
+ * `StoreInventoryModels.StoreItemCatalog.storeItemType`.
+ */
 export declare enum StoreItemType {
+    /**
+     * One-time purchase — the storefront refuses subsequent buy
+     * attempts. Use for permanent unlocks (no-ads, premium pass,
+     * cosmetic packs).
+     */
     NonConsumable = 1,
+    /**
+     * Re-purchasable — players may buy and consume the item
+     * repeatedly. Use for currency packs, energy refills,
+     * single-use boosters.
+     */
     Consumable = 2
 }

package/dist/runtime/constant/enumType/StoreReceiveType.d.ts

@@ -1,7 +1,37 @@
+/**
+ * Provenance of a store-issued item that ends up in a player's
+ * inventory.
+ *
+ * Recorded on `StoreInventoryModels.PurchaseLog.receiveType` so the
+ * application can distinguish soft-currency in-game purchases
+ * from hard-currency platform receipts. Hard-currency entries
+ * also carry the matching receipt validation data on the same log
+ * row.
+ */
 export declare enum StoreReceiveType {
+    /**
+     * Standard in-game purchase paid for with player currencies
+     * (gold, gems, soft currency, ...). No platform receipt.
+     */
     Buy = 1,
+    /**
+     * Free gift / reward issued by gameplay or by an admin (login
+     * bonus, mail attachment, support compensation).
+     */
     Present = 2,
+    /**
+     * Platform purchase verified through Apple App Store receipt
+     * validation.
+     */
     AppleAppStore = 3,
+    /**
+     * Platform purchase verified through Facebook Store receipt
+     * validation.
+     */
     FacebookStore = 4,
+    /**
+     * Platform purchase verified through Google Play receipt
+     * validation.
+     */
     GooglePlayStore = 5
 }

package/dist/runtime/constant/errorCode/ErrorCode.d.ts

@@ -1,52 +1,234 @@
+/**
+ * Domain-level error codes carried **inside successful responses**.
+ *
+ * These are **not** transport errors — for transport-level
+ * failures see {@link ReturnCode}. The two-tier model:
+ * - {@link ReturnCode} describes "did the request reach the server,
+ *   pass validation, and produce a response?".
+ * - `ErrorCode` describes "given that the request was processed,
+ *   what did the business logic return?".
+ *
+ * The SDK reads this value out of `ParameterCode.ErrorCode` on
+ * the response parameter bag inside
+ * {@link CustomOperationResponse.setupOperationResponse} and
+ * exposes it as `responseObject.errorCode`. Application code
+ * checks both layers in order:
+ *
+ * ```ts
+ * if (response.hasReturnCodeError()) return showTransportError(response);
+ * if (response.errorCode !== ErrorCode.Ok) return showDomainError(response);
+ * // success path: read response.responseData
+ * ```
+ *
+ * The error catalogue is intentionally large because the GearN
+ * backend uses fine-grained codes so the application can pick the
+ * right localised user message. Most codes are self-explanatory
+ * but the per-entry comments below capture any non-obvious
+ * scenarios (rate-limit triggers, prerequisite chains, ...).
+ *
+ * Wire-protocol contract: the numeric values are persisted in
+ * server logs and analytics so reordering them is a
+ * coordinated-change operation.
+ */
 export declare class ErrorCode {
+    /**
+     * The business operation completed successfully.
+     */
     static readonly Ok: number;
+    /**
+     * The requested username/account does not exist.
+     */
     static readonly AccountNotFound: number;
+    /**
+     * The provided account password is incorrect.
+     */
     static readonly AccountPasswordWrong: number;
+    /**
+     * The requested username already exists and cannot be created again.
+     */
     static readonly AccountUsernameExists: number;
+    /**
+     * The provided token could not be verified or decoded.
+     */
     static readonly VerifyTokenError: number;
+    /**
+     * An external/provider verification step failed.
+     */
     static readonly VerifyFailed: number;
+    /**
+     * The target character player does not exist.
+     */
     static readonly CharacterPlayerNotFound: number;
+    /**
+     * The target wallet or owner does not have enough currency to complete the operation.
+     */
     static readonly NotEnoughCurrency: number;
+    /**
+     * The requested key does not exist in the target data set.
+     */
     static readonly KeyNotFound: number;
+    /**
+     * The target inventory item does not exist.
+     */
     static readonly ItemNotFound: number;
+    /**
+     * The referenced catalog id does not exist.
+     */
     static readonly CatalogIdNotFound: number;
+    /**
+     * The target group does not exist.
+     */
     static readonly GroupNotFound: number;
+    /**
+     * The resolved owner entity does not exist.
+     */
     static readonly OwnerNotFound: number;
+    /**
+     * The referenced class id does not exist.
+     */
     static readonly ClassIdNotFound: number;
+    /**
+     * The target group member or relationship member does not exist.
+     */
     static readonly MemberNotFound: number;
+    /**
+     * The player is not currently a member of the target group.
+     */
     static readonly PlayerNotMember: number;
+    /**
+     * The target game player does not exist.
+     */
     static readonly GamePlayerNotFound: number;
+    /**
+     * The requested file metadata or physical file does not exist.
+     */
     static readonly FileNotFound: number;
+    /**
+     * The file metadata exists but the file content has not been uploaded yet.
+     */
     static readonly FileNotUpload: number;
+    /**
+     * The requested owner type is not supported by the target operation.
+     */
     static readonly OwnerTypeNotSupport: number;
+    /**
+     * The item cannot be stacked, so amount-based operations are invalid.
+     */
     static readonly ItemNotStackable: number;
+    /**
+     * The target game does not exist.
+     */
     static readonly GameNotFound: number;
-    static readonly GameIsExists: number;
+    /**
+     * The game already exists and cannot be created again with the same identity.
+     */
+    static readonly GameExists: number;
+    /**
+     * The requested secret-info record does not exist.
+     */
     static readonly SecretInfoNotFound: number;
-    static readonly SecretInfoIsExists: number;
+    /**
+     * The secret-info record already exists.
+     */
+    static readonly SecretInfoExists: number;
+    /**
+     * The requested external identity is not linked to the current account.
+     */
     static readonly ExternalNotLinked: number;
+    /**
+     * The external identity is already linked to a different account.
+     */
     static readonly ExternalLinkedOtherAccount: number;
+    /**
+     * The external provider/value pair conflicts with an existing linked value.
+     */
     static readonly ExternalLinkedOtherValue: number;
+    /**
+     * The target master player does not exist.
+     */
     static readonly MasterPlayerNotFound: number;
+    /**
+     * The target store item does not exist.
+     */
     static readonly StoreItemNotFound: number;
+    /**
+     * The buyer entity does not exist.
+     */
     static readonly BuyerNotFound: number;
+    /**
+     * The requested store item cannot be purchased in the current state or by the current buyer.
+     */
     static readonly CanNotBuyThisStoreItem: number;
+    /**
+     * An exception occurred while validating a platform receipt.
+     */
     static readonly ExceptionWhenValidateReceipt: number;
+    /**
+     * The target store/provider configuration is invalid.
+     */
     static readonly StoreInvalid: number;
+    /**
+     * The provided purchase receipt is invalid.
+     */
     static readonly ReceiptInvalid: number;
-    static readonly StoreItemHadBeenRemove: number;
-    static readonly DisplayNameHasUse: number;
+    /**
+     * The target store item was removed and can no longer be used for purchase flows.
+     */
+    static readonly StoreItemRemoved: number;
+    /**
+     * The requested display name is already in use.
+     */
+    static readonly DisplayNameUsed: number;
+    /**
+     * The target player is currently banned.
+     */
     static readonly PlayerBan: number;
+    /**
+     * The target matchmaking ticket does not exist.
+     */
     static readonly MatchmakingTicketNotFound: number;
+    /**
+     * The matchmaking ticket already completed and cannot be joined or modified further.
+     */
     static readonly MatchmakingTicketAlreadyCompleted: number;
-    static readonly MatchmakingPlayerHasNotJoinedTicket: number;
+    /**
+     * The player is not a member of the referenced matchmaking ticket.
+     */
+    static readonly MatchmakingPlayerNotJoinedTicket: number;
+    /**
+     * The requested match does not exist.
+     */
     static readonly MatchNotFound: number;
-    static readonly MatchmakingPlayerHasJoinedOtherTicket: number;
+    /**
+     * The player already joined a different matchmaking ticket that conflicts with this request.
+     */
+    static readonly MatchmakingPlayerJoinedOtherTicket: number;
+    /**
+     * The referenced matchmaking queue does not exist.
+     */
     static readonly MatchmakingQueueNotFound: number;
+    /**
+     * The requested ticket size violates queue configuration.
+     */
     static readonly TicketSizeError: number;
+    /**
+     * CloudScript execution failed inside the target function.
+     */
     static readonly ExecuteError: number;
+    /**
+     * The requested CloudScript version is invalid or unavailable.
+     */
     static readonly VersionInvalid: number;
+    /**
+     * The provided email address is syntactically or semantically invalid.
+     */
     static readonly EmailInvalid: number;
-    static readonly StoreItemHadPurchaseAndNonConsumable: number;
-    static readonly StoreItemHadExists: number;
+    /**
+     * The buyer already owns this non-consumable store item.
+     */
+    static readonly StoreItemPurchasedAndNonConsumable: number;
+    /**
+     * The store item already exists and cannot be created again with the same identity.
+     */
+    static readonly StoreItemExists: number;
 }

package/dist/runtime/constant/parameterCode/ParameterCode.d.ts

@@ -1,3 +1,35 @@
+/**
+ * Wire-level parameter key catalogue.
+ *
+ * Every value here is the literal string used as a dictionary key
+ * inside the {@link GNHashtable} payloads exchanged between the
+ * SDK and the GearN backend. The `@*DataMember({ code: ... })`
+ * decorators on the model classes consume these constants to map
+ * a TypeScript property name onto the matching wire key (and the
+ * inverse for deserialisation).
+ *
+ * The constants are also used directly by:
+ * - {@link PeerBase.onResponseHandler} when it reads
+ *   `ReturnCode`, `Parameters`, `DebugMessage`, `ResponseId`,
+ *   `InvalidRequestParameters` from the raw response.
+ * - The auth-token / user-id / `Ts` mirror inside the same handler.
+ * - {@link SocketPeer.onEventHandler} when it pulls `EventCode`
+ *   and `Parameters` from a server-pushed event frame.
+ *
+ * Wire-protocol contract: renaming a value here without a
+ * coordinated backend change breaks every operation that uses
+ * it. The list grows over time but ordering is irrelevant — keys
+ * are looked up by name, not by index.
+ *
+ * Reading the entries: each constant is named in `PascalCase` and
+ * holds the matching `camelCase` wire key. Use the matching
+ * `@*DataMember` decorator to bind a property to a key:
+ *
+ * ```ts
+ * @StringDataMember({ code: ParameterCode.Username, mustNonNull: true })
+ * public username: string;
+ * ```
+ */
 export declare class ParameterCode {
     static readonly AuthToken: string;
     static readonly Ts: string;
@@ -205,7 +237,7 @@ export declare class ParameterCode {
     static readonly Group: string;
     static readonly Inventory: string;
     static readonly StoreInventory: string;
-    static readonly MasterAdmin: string;
+    static readonly Dashboard: string;
     static readonly LoginByAccount: string;
     static readonly LoginByAndroidDeviceId: string;
     static readonly LoginByApple: string;
@@ -260,7 +292,7 @@ export declare class ParameterCode {
     static readonly SetDisplayName: string;
     static readonly GetTsCreate: string;
     static readonly GetIpAddressCreate: string;
-    static readonly SetTsLastLogin: string;
+    static readonly UpdateTsLastLogin: string;
     static readonly GetTsLastLogin: string;
     static readonly SetPlayerBan: string;
     static readonly GetPlayerBan: string;
@@ -611,7 +643,5 @@ export declare class ParameterCode {
     static readonly OwnerIds: string;
     static readonly GetStoreUsed: string;
     static readonly RemoveStoreUsed: string;
-    static readonly AdminSecretKeys: string;
-    static readonly ServerSecretKeys: string;
-    static readonly PlayerSecretKeys: string;
+    static readonly SecretKeys: string;
 }