@omen.foundation/game-sdk 1.0.0

package/README.md

@@ -0,0 +1,91 @@
+# @omen.foundation/game-sdk
+
+OmenX Game SDK for web applications - OAuth authentication and API integration.
+
+## Installation
+
+```bash
+npm install @omen.foundation/game-sdk
+```
+
+## Quick Start
+
+### Basic Usage
+
+```typescript
+import { OmenXGameSDK } from '@omen.foundation/game-sdk';
+
+const sdk = new OmenXGameSDK({
+  gameId: 'your-game-id',
+  onAuth: (authData) => {
+    console.log('Authenticated!', authData);
+    // User is now authenticated
+  },
+  onAuthError: (error) => {
+    console.error('Auth error:', error);
+  },
+});
+
+// Initialize SDK
+await sdk.init();
+```
+
+### OAuth Authentication
+
+For standalone games (not embedded in iframes):
+
+```typescript
+// Authenticate user via OAuth popup
+await sdk.authenticate({
+  redirectUri: 'https://yourgame.com/auth/callback',
+  enablePKCE: true, // Recommended for security
+});
+```
+
+### Iframe Authentication
+
+For games embedded in the OmenX frontend, authentication is automatic:
+
+```typescript
+const sdk = new OmenXGameSDK({
+  gameId: 'your-game-id',
+  enableIframeAuth: true, // Default: true
+  parentOrigin: 'https://omen.foundation', // Optional: for security
+  onAuth: (authData) => {
+    // Auth data received automatically from parent window
+  },
+});
+
+await sdk.init();
+```
+
+### Making API Calls
+
+```typescript
+// Make authenticated API calls
+const response = await sdk.apiCall('/v1/nfts/templates?gameId=your-game-id');
+const data = await response.json();
+```
+
+### Check Authentication Status
+
+```typescript
+if (sdk.isAuthenticated()) {
+  const authData = sdk.getAuthData();
+  console.log('User:', authData.walletAddress);
+}
+```
+
+### Logout
+
+```typescript
+await sdk.logout();
+```
+
+## API Reference
+
+See the [full documentation](./docs/README.md) for detailed API reference.
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,162 @@
+/**
+ * Authentication data received from OmenX
+ */
+interface AuthData {
+    accessToken: string;
+    walletAddress: string;
+    userId: string;
+    profileName?: string;
+    profilePicture?: string;
+    email?: string;
+    gameId: string;
+    timestamp: number;
+}
+/**
+ * User information structure
+ */
+interface UserInfo {
+    walletAddress: string;
+    userId: string;
+    profileName?: string;
+    profilePicture?: string;
+    email?: string;
+}
+/**
+ * Configuration for OmenXGameSDK
+ */
+interface OmenXGameSDKConfig {
+    /**
+     * Your game ID (from developer portal)
+     */
+    gameId: string;
+    /**
+     * OmenX API base URL (default: https://api.omen.foundation)
+     */
+    apiBaseUrl?: string;
+    /**
+     * OAuth authorization URL (default: https://api.omen.foundation/v1/oauth/authorize)
+     */
+    oauthAuthorizeUrl?: string;
+    /**
+     * OAuth token URL (default: https://api.omen.foundation/v1/oauth/token)
+     */
+    oauthTokenUrl?: string;
+    /**
+     * Callback when authentication succeeds
+     */
+    onAuth?: (authData: AuthData) => void;
+    /**
+     * Callback when authentication fails
+     */
+    onAuthError?: (error: Error) => void;
+    /**
+     * Callback when user logs out
+     */
+    onLogout?: () => void;
+    /**
+     * Enable iframe authentication (default: true)
+     * If true, SDK will listen for auth data from parent window
+     */
+    enableIframeAuth?: boolean;
+    /**
+     * Expected parent origin for iframe auth (security)
+     * If set, only messages from this origin will be accepted
+     */
+    parentOrigin?: string;
+    /**
+     * Storage key prefix for tokens (default: 'omenx_game_')
+     */
+    storageKeyPrefix?: string;
+}
+/**
+ * OAuth authentication options
+ */
+interface OAuthOptions {
+    /**
+     * Redirect URI (must be registered in developer portal)
+     */
+    redirectUri: string;
+    /**
+     * State parameter for CSRF protection (auto-generated if not provided)
+     */
+    state?: string;
+    /**
+     * Enable PKCE (default: true)
+     */
+    enablePKCE?: boolean;
+}
+/**
+ * API call options
+ */
+interface ApiCallOptions {
+    /**
+     * HTTP method (default: 'GET')
+     */
+    method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+    /**
+     * Request body
+     */
+    body?: any;
+    /**
+     * Request headers
+     */
+    headers?: Record<string, string>;
+    /**
+     * Whether to include authentication token (default: true)
+     */
+    includeAuth?: boolean;
+}
+
+/**
+ * OmenX Game SDK
+ *
+ * Provides authentication and API integration for games on the OmenX platform.
+ * Supports both OAuth-style authentication and iframe authentication passing.
+ */
+declare class OmenXGameSDK {
+    private config;
+    private oauthFlow;
+    private iframeAuth;
+    private tokenManager;
+    private currentAuthData;
+    constructor(config: OmenXGameSDKConfig);
+    /**
+     * Initialize the SDK
+     * Call this after creating an instance
+     */
+    init(): Promise<void>;
+    /**
+     * Authenticate user via OAuth popup
+     */
+    authenticate(options: OAuthOptions): Promise<AuthData>;
+    /**
+     * Get current authentication data
+     */
+    getAuthData(): AuthData | null;
+    /**
+     * Check if user is authenticated
+     */
+    isAuthenticated(): boolean;
+    /**
+     * Logout user
+     */
+    logout(): Promise<void>;
+    /**
+     * Make an authenticated API call
+     */
+    apiCall(endpoint: string, options?: ApiCallOptions): Promise<Response>;
+    /**
+     * Handle token received from OAuth flow
+     */
+    private handleTokenReceived;
+    /**
+     * Handle auth data from iframe
+     */
+    private handleAuthData;
+    /**
+     * Refresh access token using refresh token
+     */
+    private refreshAccessToken;
+}
+
+export { type ApiCallOptions, type AuthData, type OAuthOptions, OmenXGameSDK, type OmenXGameSDKConfig, type UserInfo };

package/dist/index.d.ts

@@ -0,0 +1,162 @@
+/**
+ * Authentication data received from OmenX
+ */
+interface AuthData {
+    accessToken: string;
+    walletAddress: string;
+    userId: string;
+    profileName?: string;
+    profilePicture?: string;
+    email?: string;
+    gameId: string;
+    timestamp: number;
+}
+/**
+ * User information structure
+ */
+interface UserInfo {
+    walletAddress: string;
+    userId: string;
+    profileName?: string;
+    profilePicture?: string;
+    email?: string;
+}
+/**
+ * Configuration for OmenXGameSDK
+ */
+interface OmenXGameSDKConfig {
+    /**
+     * Your game ID (from developer portal)
+     */
+    gameId: string;
+    /**
+     * OmenX API base URL (default: https://api.omen.foundation)
+     */
+    apiBaseUrl?: string;
+    /**
+     * OAuth authorization URL (default: https://api.omen.foundation/v1/oauth/authorize)
+     */
+    oauthAuthorizeUrl?: string;
+    /**
+     * OAuth token URL (default: https://api.omen.foundation/v1/oauth/token)
+     */
+    oauthTokenUrl?: string;
+    /**
+     * Callback when authentication succeeds
+     */
+    onAuth?: (authData: AuthData) => void;
+    /**
+     * Callback when authentication fails
+     */
+    onAuthError?: (error: Error) => void;
+    /**
+     * Callback when user logs out
+     */
+    onLogout?: () => void;
+    /**
+     * Enable iframe authentication (default: true)
+     * If true, SDK will listen for auth data from parent window
+     */
+    enableIframeAuth?: boolean;
+    /**
+     * Expected parent origin for iframe auth (security)
+     * If set, only messages from this origin will be accepted
+     */
+    parentOrigin?: string;
+    /**
+     * Storage key prefix for tokens (default: 'omenx_game_')
+     */
+    storageKeyPrefix?: string;
+}
+/**
+ * OAuth authentication options
+ */
+interface OAuthOptions {
+    /**
+     * Redirect URI (must be registered in developer portal)
+     */
+    redirectUri: string;
+    /**
+     * State parameter for CSRF protection (auto-generated if not provided)
+     */
+    state?: string;
+    /**
+     * Enable PKCE (default: true)
+     */
+    enablePKCE?: boolean;
+}
+/**
+ * API call options
+ */
+interface ApiCallOptions {
+    /**
+     * HTTP method (default: 'GET')
+     */
+    method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+    /**
+     * Request body
+     */
+    body?: any;
+    /**
+     * Request headers
+     */
+    headers?: Record<string, string>;
+    /**
+     * Whether to include authentication token (default: true)
+     */
+    includeAuth?: boolean;
+}
+
+/**
+ * OmenX Game SDK
+ *
+ * Provides authentication and API integration for games on the OmenX platform.
+ * Supports both OAuth-style authentication and iframe authentication passing.
+ */
+declare class OmenXGameSDK {
+    private config;
+    private oauthFlow;
+    private iframeAuth;
+    private tokenManager;
+    private currentAuthData;
+    constructor(config: OmenXGameSDKConfig);
+    /**
+     * Initialize the SDK
+     * Call this after creating an instance
+     */
+    init(): Promise<void>;
+    /**
+     * Authenticate user via OAuth popup
+     */
+    authenticate(options: OAuthOptions): Promise<AuthData>;
+    /**
+     * Get current authentication data
+     */
+    getAuthData(): AuthData | null;
+    /**
+     * Check if user is authenticated
+     */
+    isAuthenticated(): boolean;
+    /**
+     * Logout user
+     */
+    logout(): Promise<void>;
+    /**
+     * Make an authenticated API call
+     */
+    apiCall(endpoint: string, options?: ApiCallOptions): Promise<Response>;
+    /**
+     * Handle token received from OAuth flow
+     */
+    private handleTokenReceived;
+    /**
+     * Handle auth data from iframe
+     */
+    private handleAuthData;
+    /**
+     * Refresh access token using refresh token
+     */
+    private refreshAccessToken;
+}
+
+export { type ApiCallOptions, type AuthData, type OAuthOptions, OmenXGameSDK, type OmenXGameSDKConfig, type UserInfo };