@omen.foundation/game-sdk 1.0.14 → 1.0.16

package/dist/index.d.mts

@@ -74,8 +74,9 @@ interface OmenXGameSDKConfig {
 interface OAuthOptions {
     /**
      * Redirect URI (must be registered in developer portal)
+     * If not provided, defaults to `${window.location.origin}/auth/callback`
      */
-    redirectUri: string;
+    redirectUri?: string;
     /**
      * State parameter for CSRF protection (auto-generated if not provided)
      */
@@ -106,6 +107,38 @@ interface ApiCallOptions {
      */
     includeAuth?: boolean;
 }
+interface VipTierInfo {
+    tierIndex: number;
+    tierKey: string;
+    displayName: string;
+    allocationBoundary: number;
+    usdPrice?: number;
+    perksDescription?: string;
+    active?: boolean;
+    /** Structured perks from tiers JSON (e.g. GAME_BONUS_POINTS_LEVEL). */
+    perks?: Record<string, unknown>;
+    tierPerksShortDescription?: string;
+    /** Games read this (1–21) for Game Alpha Access (higher tiers), Game Beta Access (lower tiers), or in-game gifts. */
+    gameBonusPointsLevel?: number;
+}
+interface VipStatus {
+    walletAddress: string;
+    entitlement: number;
+    claimed: number;
+    claimable: number;
+    tier: VipTierInfo;
+    nextTier: VipTierInfo | null;
+    phaseIndex: number;
+    claimingAllowed: boolean;
+    phaseClaimingClosed?: boolean;
+    currentEpoch?: {
+        epochId: string;
+        startAt: string;
+        endAt: string;
+        epochPoolAmount: number;
+        estimatedShare?: number;
+    };
+}
 
 /**
  * OmenX Game SDK
@@ -153,6 +186,16 @@ declare class OmenXGameSDK {
      * Handle auth data from iframe
      */
     private handleAuthData;
+    /**
+     * Get current VIP status for the authenticated user (tier, allocation, claimable, perks).
+     * Games can read tier.gameBonusPointsLevel (1–21) for Alpha/Beta access or in-game gifts.
+     */
+    getVipStatus(): Promise<VipStatus | null>;
+    /**
+     * Get the current user's game bonus points level (1–21) from their VIP tier.
+     * Use for Game Alpha Access (e.g. level >= 6), Game Beta Access (e.g. level >= 1), or in-game gifts.
+     */
+    getGameBonusPointsLevel(): Promise<number | null>;
     /**
      * Refresh access token using refresh token
      */
@@ -194,12 +237,19 @@ declare class OmenXServerSDK {
     /**
      * Player Operations
      */
+    /**
+     * Get full player data: NFTs (system + game) and balances for a wallet.
+     * Requires both nfts:read and balances:read scopes.
+     */
+    getPlayer(wallet: string, chainId: string): Promise<any>;
     /**
      * Get native and ERC20 token balances for a wallet
      */
     getPlayerBalances(wallet: string, chainId: string): Promise<any>;
     /**
-     * Get paginated NFTs for a wallet
+     * Get paginated NFTs for a wallet.
+     * With no contract: returns OmenX system NFTs (Asset Manager, Faucet, Early Adopter) + game NFTs.
+     * With contract: returns only NFTs for that contract.
      */
     getPlayerNfts(wallet: string, chainId: string, options?: {
         contract?: string;
@@ -273,6 +323,27 @@ declare class OmenXServerSDK {
         dropTableId: string;
         recipientAddress: string;
     }): Promise<any>;
+    /**
+     * VIP Points (Developer pool)
+     * Requires scope: vip_points:write.
+     * Grants VIP points to a player from this game's allocated pool. Enforces total allocation and max per quest.
+     * Call from your game backend only (API key auth); not for client-side use.
+     */
+    grantVipPoints(params: {
+        /** Player wallet address (0x-prefixed, 40 hex chars). */
+        wallet: string;
+        /** Points to grant (positive integer). Capped by pool remaining and max per quest. */
+        amount: number;
+        /** Optional quest/activity id for idempotency or auditing. */
+        questId?: string;
+    }): Promise<{
+        success: boolean;
+        data?: {
+            wallet: string;
+            amount: number;
+            phaseIndex?: number;
+        };
+    }>;
 }
 
-export { type ApiCallOptions, type AuthData, type OAuthOptions, OmenXGameSDK, type OmenXGameSDKConfig, OmenXServerSDK, type UserInfo };
+export { type ApiCallOptions, type AuthData, type OAuthOptions, OmenXGameSDK, type OmenXGameSDKConfig, OmenXServerSDK, type UserInfo, type VipStatus, type VipTierInfo };

package/dist/index.d.ts

@@ -74,8 +74,9 @@ interface OmenXGameSDKConfig {
 interface OAuthOptions {
     /**
      * Redirect URI (must be registered in developer portal)
+     * If not provided, defaults to `${window.location.origin}/auth/callback`
      */
-    redirectUri: string;
+    redirectUri?: string;
     /**
      * State parameter for CSRF protection (auto-generated if not provided)
      */
@@ -106,6 +107,38 @@ interface ApiCallOptions {
      */
     includeAuth?: boolean;
 }
+interface VipTierInfo {
+    tierIndex: number;
+    tierKey: string;
+    displayName: string;
+    allocationBoundary: number;
+    usdPrice?: number;
+    perksDescription?: string;
+    active?: boolean;
+    /** Structured perks from tiers JSON (e.g. GAME_BONUS_POINTS_LEVEL). */
+    perks?: Record<string, unknown>;
+    tierPerksShortDescription?: string;
+    /** Games read this (1–21) for Game Alpha Access (higher tiers), Game Beta Access (lower tiers), or in-game gifts. */
+    gameBonusPointsLevel?: number;
+}
+interface VipStatus {
+    walletAddress: string;
+    entitlement: number;
+    claimed: number;
+    claimable: number;
+    tier: VipTierInfo;
+    nextTier: VipTierInfo | null;
+    phaseIndex: number;
+    claimingAllowed: boolean;
+    phaseClaimingClosed?: boolean;
+    currentEpoch?: {
+        epochId: string;
+        startAt: string;
+        endAt: string;
+        epochPoolAmount: number;
+        estimatedShare?: number;
+    };
+}
 
 /**
  * OmenX Game SDK
@@ -153,6 +186,16 @@ declare class OmenXGameSDK {
      * Handle auth data from iframe
      */
     private handleAuthData;
+    /**
+     * Get current VIP status for the authenticated user (tier, allocation, claimable, perks).
+     * Games can read tier.gameBonusPointsLevel (1–21) for Alpha/Beta access or in-game gifts.
+     */
+    getVipStatus(): Promise<VipStatus | null>;
+    /**
+     * Get the current user's game bonus points level (1–21) from their VIP tier.
+     * Use for Game Alpha Access (e.g. level >= 6), Game Beta Access (e.g. level >= 1), or in-game gifts.
+     */
+    getGameBonusPointsLevel(): Promise<number | null>;
     /**
      * Refresh access token using refresh token
      */
@@ -194,12 +237,19 @@ declare class OmenXServerSDK {
     /**
      * Player Operations
      */
+    /**
+     * Get full player data: NFTs (system + game) and balances for a wallet.
+     * Requires both nfts:read and balances:read scopes.
+     */
+    getPlayer(wallet: string, chainId: string): Promise<any>;
     /**
      * Get native and ERC20 token balances for a wallet
      */
     getPlayerBalances(wallet: string, chainId: string): Promise<any>;
     /**
-     * Get paginated NFTs for a wallet
+     * Get paginated NFTs for a wallet.
+     * With no contract: returns OmenX system NFTs (Asset Manager, Faucet, Early Adopter) + game NFTs.
+     * With contract: returns only NFTs for that contract.
      */
     getPlayerNfts(wallet: string, chainId: string, options?: {
         contract?: string;
@@ -273,6 +323,27 @@ declare class OmenXServerSDK {
         dropTableId: string;
         recipientAddress: string;
     }): Promise<any>;
+    /**
+     * VIP Points (Developer pool)
+     * Requires scope: vip_points:write.
+     * Grants VIP points to a player from this game's allocated pool. Enforces total allocation and max per quest.
+     * Call from your game backend only (API key auth); not for client-side use.
+     */
+    grantVipPoints(params: {
+        /** Player wallet address (0x-prefixed, 40 hex chars). */
+        wallet: string;
+        /** Points to grant (positive integer). Capped by pool remaining and max per quest. */
+        amount: number;
+        /** Optional quest/activity id for idempotency or auditing. */
+        questId?: string;
+    }): Promise<{
+        success: boolean;
+        data?: {
+            wallet: string;
+            amount: number;
+            phaseIndex?: number;
+        };
+    }>;
 }
 
-export { type ApiCallOptions, type AuthData, type OAuthOptions, OmenXGameSDK, type OmenXGameSDKConfig, OmenXServerSDK, type UserInfo };
+export { type ApiCallOptions, type AuthData, type OAuthOptions, OmenXGameSDK, type OmenXGameSDKConfig, OmenXServerSDK, type UserInfo, type VipStatus, type VipTierInfo };