@frontiertower/frontier-sdk 0.2.1 → 0.3.0

package/README.md

@@ -60,7 +60,10 @@ Your app must declare required permissions in the Frontier app registry:
 
 ### User Permissions
 - `user:getDetails` - Access current user details
-- `user:getProfile` - Access user profile information
+- `user:getProfile` - Access current user profile information
+- `user:getReferralOverview` - Access referral statistics
+- `user:getReferralDetails` - Access detailed referral information
+- `user:addUserContact` - Add user contact information
 
 ### Chain Permissions
 - `chain:getCurrentNetwork` - Get current network name

package/dist/index.d.mts

@@ -461,12 +461,60 @@ interface UserProfile {
     /** Whether user has a usable password */
     hasUsablePassword: string;
 }
+/**
+ * Paginated response wrapper
+ */
+interface PaginatedResponse<T> {
+    /** Total count of items */
+    count: number;
+    /** Array of results */
+    results: T[];
+}
+/**
+ * Referral overview statistics
+ */
+interface ReferralOverview {
+    /** Total number of referrals */
+    totalReferrals: number;
+    /** Number of active referrals */
+    activeReferrals: number;
+    /** Total rewards earned */
+    totalRewards: number;
+}
+/**
+ * Detailed referral information
+ */
+interface ReferralDetails {
+    /** Referral ID */
+    id: string;
+    /** Referred user email */
+    email: string;
+    /** Referral status */
+    status: string;
+    /** Date of referral */
+    createdAt: string;
+    /** Reward amount */
+    reward?: number;
+}
+/**
+ * User contact information payload
+ */
+interface UserContactPayload {
+    /** Contact email */
+    email?: string;
+    /** Contact phone number */
+    phoneNumber?: string;
+    /** Additional contact information */
+    [key: string]: any;
+}
 /**
  * User access class for interacting with user information
  *
  * This class provides methods to:
  * - Get current user details
  * - Get detailed user profiles
+ * - Access referral information
+ * - Add user contact information
  *
  * All methods require appropriate permissions and authentication.
  */
@@ -491,24 +539,82 @@ declare class UserAccess {
      */
     getDetails(): Promise<User>;
     /**
-     * Get user profile by ID
+     * Get current user profile
      *
-     * Returns detailed profile information for a specific user,
+     * Returns detailed profile information for the currently authenticated user,
      * including social media handles, preferences, and community information.
      *
-     * @param id - The profile ID to fetch
      * @returns UserProfile object with detailed information
-     * @throws {Error} If profile is not found or access is denied
+     * @throws {Error} If user is not authenticated or profile is not found
      *
      * @example
      * ```typescript
-     * const profile = await sdk.getUser().getProfile(123);
+     * const profile = await sdk.getUser().getProfile();
      * console.log('Nickname:', profile.nickname);
      * console.log('GitHub:', profile.githubHandle);
      * console.log('Community:', profile.communityName);
      * ```
      */
-    getProfile(id: number): Promise<UserProfile>;
+    getProfile(): Promise<UserProfile>;
+    /**
+     * Get referral overview for current user
+     *
+     * Returns statistics about the user's referrals, including total count,
+     * active referrals, and total rewards earned.
+     *
+     * @returns ReferralOverview object with referral statistics
+     * @throws {Error} If user is not authenticated
+     *
+     * @example
+     * ```typescript
+     * const overview = await sdk.getUser().getReferralOverview();
+     * console.log('Total referrals:', overview.totalReferrals);
+     * console.log('Total rewards:', overview.totalRewards);
+     * ```
+     */
+    getReferralOverview(): Promise<ReferralOverview>;
+    /**
+     * Get referral details for current user with optional pagination
+     *
+     * Returns detailed information about each referral, including status,
+     * date, and rewards. Supports pagination for large result sets.
+     *
+     * @param page - Optional page number for pagination (1-indexed)
+     * @returns Paginated response with referral details
+     * @throws {Error} If user is not authenticated
+     *
+     * @example
+     * ```typescript
+     * const details = await sdk.getUser().getReferralDetails();
+     * console.log('Total referrals:', details.count);
+     * details.results.forEach(ref => {
+     *   console.log(`${ref.email} - ${ref.status}`);
+     * });
+     *
+     * // With pagination
+     * const page2 = await sdk.getUser().getReferralDetails(2);
+     * ```
+     */
+    getReferralDetails(page?: number): Promise<PaginatedResponse<ReferralDetails>>;
+    /**
+     * Add user contact information
+     *
+     * Submits contact information for the current user. This can include
+     * email, phone number, or other contact details.
+     *
+     * @param data - Contact information payload
+     * @returns Promise that resolves when contact is added
+     * @throws {Error} If user is not authenticated or data is invalid
+     *
+     * @example
+     * ```typescript
+     * await sdk.getUser().addUserContact({
+     *   email: 'contact@example.com',
+     *   phoneNumber: '+1234567890'
+     * });
+     * ```
+     */
+    addUserContact(data: UserContactPayload): Promise<void>;
 }
 
 declare class FrontierSDK {

package/dist/index.d.ts

@@ -461,12 +461,60 @@ interface UserProfile {
     /** Whether user has a usable password */
     hasUsablePassword: string;
 }
+/**
+ * Paginated response wrapper
+ */
+interface PaginatedResponse<T> {
+    /** Total count of items */
+    count: number;
+    /** Array of results */
+    results: T[];
+}
+/**
+ * Referral overview statistics
+ */
+interface ReferralOverview {
+    /** Total number of referrals */
+    totalReferrals: number;
+    /** Number of active referrals */
+    activeReferrals: number;
+    /** Total rewards earned */
+    totalRewards: number;
+}
+/**
+ * Detailed referral information
+ */
+interface ReferralDetails {
+    /** Referral ID */
+    id: string;
+    /** Referred user email */
+    email: string;
+    /** Referral status */
+    status: string;
+    /** Date of referral */
+    createdAt: string;
+    /** Reward amount */
+    reward?: number;
+}
+/**
+ * User contact information payload
+ */
+interface UserContactPayload {
+    /** Contact email */
+    email?: string;
+    /** Contact phone number */
+    phoneNumber?: string;
+    /** Additional contact information */
+    [key: string]: any;
+}
 /**
  * User access class for interacting with user information
  *
  * This class provides methods to:
  * - Get current user details
  * - Get detailed user profiles
+ * - Access referral information
+ * - Add user contact information
  *
  * All methods require appropriate permissions and authentication.
  */
@@ -491,24 +539,82 @@ declare class UserAccess {
      */
     getDetails(): Promise<User>;
     /**
-     * Get user profile by ID
+     * Get current user profile
      *
-     * Returns detailed profile information for a specific user,
+     * Returns detailed profile information for the currently authenticated user,
      * including social media handles, preferences, and community information.
      *
-     * @param id - The profile ID to fetch
      * @returns UserProfile object with detailed information
-     * @throws {Error} If profile is not found or access is denied
+     * @throws {Error} If user is not authenticated or profile is not found
      *
      * @example
      * ```typescript
-     * const profile = await sdk.getUser().getProfile(123);
+     * const profile = await sdk.getUser().getProfile();
      * console.log('Nickname:', profile.nickname);
      * console.log('GitHub:', profile.githubHandle);
      * console.log('Community:', profile.communityName);
      * ```
      */
-    getProfile(id: number): Promise<UserProfile>;
+    getProfile(): Promise<UserProfile>;
+    /**
+     * Get referral overview for current user
+     *
+     * Returns statistics about the user's referrals, including total count,
+     * active referrals, and total rewards earned.
+     *
+     * @returns ReferralOverview object with referral statistics
+     * @throws {Error} If user is not authenticated
+     *
+     * @example
+     * ```typescript
+     * const overview = await sdk.getUser().getReferralOverview();
+     * console.log('Total referrals:', overview.totalReferrals);
+     * console.log('Total rewards:', overview.totalRewards);
+     * ```
+     */
+    getReferralOverview(): Promise<ReferralOverview>;
+    /**
+     * Get referral details for current user with optional pagination
+     *
+     * Returns detailed information about each referral, including status,
+     * date, and rewards. Supports pagination for large result sets.
+     *
+     * @param page - Optional page number for pagination (1-indexed)
+     * @returns Paginated response with referral details
+     * @throws {Error} If user is not authenticated
+     *
+     * @example
+     * ```typescript
+     * const details = await sdk.getUser().getReferralDetails();
+     * console.log('Total referrals:', details.count);
+     * details.results.forEach(ref => {
+     *   console.log(`${ref.email} - ${ref.status}`);
+     * });
+     *
+     * // With pagination
+     * const page2 = await sdk.getUser().getReferralDetails(2);
+     * ```
+     */
+    getReferralDetails(page?: number): Promise<PaginatedResponse<ReferralDetails>>;
+    /**
+     * Add user contact information
+     *
+     * Submits contact information for the current user. This can include
+     * email, phone number, or other contact details.
+     *
+     * @param data - Contact information payload
+     * @returns Promise that resolves when contact is added
+     * @throws {Error} If user is not authenticated or data is invalid
+     *
+     * @example
+     * ```typescript
+     * await sdk.getUser().addUserContact({
+     *   email: 'contact@example.com',
+     *   phoneNumber: '+1234567890'
+     * });
+     * ```
+     */
+    addUserContact(data: UserContactPayload): Promise<void>;
 }
 
 declare class FrontierSDK {

package/dist/index.js

@@ -397,25 +397,89 @@ var UserAccess = class {
     return this.sdk.request("user:getDetails");
   }
   /**
-   * Get user profile by ID
+   * Get current user profile
    * 
-   * Returns detailed profile information for a specific user,
+   * Returns detailed profile information for the currently authenticated user,
    * including social media handles, preferences, and community information.
    * 
-   * @param id - The profile ID to fetch
    * @returns UserProfile object with detailed information
-   * @throws {Error} If profile is not found or access is denied
+   * @throws {Error} If user is not authenticated or profile is not found
    * 
    * @example
    * ```typescript
-   * const profile = await sdk.getUser().getProfile(123);
+   * const profile = await sdk.getUser().getProfile();
    * console.log('Nickname:', profile.nickname);
    * console.log('GitHub:', profile.githubHandle);
    * console.log('Community:', profile.communityName);
    * ```
    */
-  async getProfile(id) {
-    return this.sdk.request("user:getProfile", { id });
+  async getProfile() {
+    return this.sdk.request("user:getProfile");
+  }
+  /**
+   * Get referral overview for current user
+   * 
+   * Returns statistics about the user's referrals, including total count,
+   * active referrals, and total rewards earned.
+   * 
+   * @returns ReferralOverview object with referral statistics
+   * @throws {Error} If user is not authenticated
+   * 
+   * @example
+   * ```typescript
+   * const overview = await sdk.getUser().getReferralOverview();
+   * console.log('Total referrals:', overview.totalReferrals);
+   * console.log('Total rewards:', overview.totalRewards);
+   * ```
+   */
+  async getReferralOverview() {
+    return this.sdk.request("user:getReferralOverview");
+  }
+  /**
+   * Get referral details for current user with optional pagination
+   * 
+   * Returns detailed information about each referral, including status,
+   * date, and rewards. Supports pagination for large result sets.
+   * 
+   * @param page - Optional page number for pagination (1-indexed)
+   * @returns Paginated response with referral details
+   * @throws {Error} If user is not authenticated
+   * 
+   * @example
+   * ```typescript
+   * const details = await sdk.getUser().getReferralDetails();
+   * console.log('Total referrals:', details.count);
+   * details.results.forEach(ref => {
+   *   console.log(`${ref.email} - ${ref.status}`);
+   * });
+   * 
+   * // With pagination
+   * const page2 = await sdk.getUser().getReferralDetails(2);
+   * ```
+   */
+  async getReferralDetails(page) {
+    return this.sdk.request("user:getReferralDetails", page ? { page } : void 0);
+  }
+  /**
+   * Add user contact information
+   * 
+   * Submits contact information for the current user. This can include
+   * email, phone number, or other contact details.
+   * 
+   * @param data - Contact information payload
+   * @returns Promise that resolves when contact is added
+   * @throws {Error} If user is not authenticated or data is invalid
+   * 
+   * @example
+   * ```typescript
+   * await sdk.getUser().addUserContact({
+   *   email: 'contact@example.com',
+   *   phoneNumber: '+1234567890'
+   * });
+   * ```
+   */
+  async addUserContact(data) {
+    return this.sdk.request("user:addUserContact", data);
   }
 };
 

package/dist/index.mjs

@@ -367,25 +367,89 @@ var UserAccess = class {
     return this.sdk.request("user:getDetails");
   }
   /**
-   * Get user profile by ID
+   * Get current user profile
    * 
-   * Returns detailed profile information for a specific user,
+   * Returns detailed profile information for the currently authenticated user,
    * including social media handles, preferences, and community information.
    * 
-   * @param id - The profile ID to fetch
    * @returns UserProfile object with detailed information
-   * @throws {Error} If profile is not found or access is denied
+   * @throws {Error} If user is not authenticated or profile is not found
    * 
    * @example
    * ```typescript
-   * const profile = await sdk.getUser().getProfile(123);
+   * const profile = await sdk.getUser().getProfile();
    * console.log('Nickname:', profile.nickname);
    * console.log('GitHub:', profile.githubHandle);
    * console.log('Community:', profile.communityName);
    * ```
    */
-  async getProfile(id) {
-    return this.sdk.request("user:getProfile", { id });
+  async getProfile() {
+    return this.sdk.request("user:getProfile");
+  }
+  /**
+   * Get referral overview for current user
+   * 
+   * Returns statistics about the user's referrals, including total count,
+   * active referrals, and total rewards earned.
+   * 
+   * @returns ReferralOverview object with referral statistics
+   * @throws {Error} If user is not authenticated
+   * 
+   * @example
+   * ```typescript
+   * const overview = await sdk.getUser().getReferralOverview();
+   * console.log('Total referrals:', overview.totalReferrals);
+   * console.log('Total rewards:', overview.totalRewards);
+   * ```
+   */
+  async getReferralOverview() {
+    return this.sdk.request("user:getReferralOverview");
+  }
+  /**
+   * Get referral details for current user with optional pagination
+   * 
+   * Returns detailed information about each referral, including status,
+   * date, and rewards. Supports pagination for large result sets.
+   * 
+   * @param page - Optional page number for pagination (1-indexed)
+   * @returns Paginated response with referral details
+   * @throws {Error} If user is not authenticated
+   * 
+   * @example
+   * ```typescript
+   * const details = await sdk.getUser().getReferralDetails();
+   * console.log('Total referrals:', details.count);
+   * details.results.forEach(ref => {
+   *   console.log(`${ref.email} - ${ref.status}`);
+   * });
+   * 
+   * // With pagination
+   * const page2 = await sdk.getUser().getReferralDetails(2);
+   * ```
+   */
+  async getReferralDetails(page) {
+    return this.sdk.request("user:getReferralDetails", page ? { page } : void 0);
+  }
+  /**
+   * Add user contact information
+   * 
+   * Submits contact information for the current user. This can include
+   * email, phone number, or other contact details.
+   * 
+   * @param data - Contact information payload
+   * @returns Promise that resolves when contact is added
+   * @throws {Error} If user is not authenticated or data is invalid
+   * 
+   * @example
+   * ```typescript
+   * await sdk.getUser().addUserContact({
+   *   email: 'contact@example.com',
+   *   phoneNumber: '+1234567890'
+   * });
+   * ```
+   */
+  async addUserContact(data) {
+    return this.sdk.request("user:addUserContact", data);
   }
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@frontiertower/frontier-sdk",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "SDK for building apps on Frontier Wallet",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",