@foru-ms/sdk 1.2.0 → 1.2.2

package/README.md

@@ -6,13 +6,13 @@ This SDK is fully typed and provides a comprehensive interface to the Foru.ms AP
 
 ## Features
 
-✨ **Fully Typed** - Complete TypeScript support with detailed type definitions  
-🔄 **Auto Retry** - Automatic retry logic for rate limits and server errors  
-📄 **Easy Pagination** - Built-in helpers for cursor-based pagination  
-🚨 **Rich Error Classes** - Specific error types for better error handling  
-🔐 **Webhook Verification** - Built-in signature verification for webhooks  
-📊 **Rate Limit Tracking** - Automatic tracking of API rate limits  
-📚 **Comprehensive Examples** - Detailed examples for common use cases
+**Fully Typed** - Complete TypeScript support with detailed type definitions  
+**Auto Retry** - Automatic retry logic for rate limits and server errors  
+**Easy Pagination** - Built-in helpers for cursor-based pagination  
+**Rich Error Classes** - Specific error types for better error handling  
+**Webhook Verification** - Built-in signature verification for webhooks  
+**Rate Limit Tracking** - Automatic tracking of API rate limits  
+**Comprehensive Examples** - Detailed examples for common use cases
 
 ## Installation
 
@@ -183,9 +183,11 @@ Check the `/examples` directory for detailed examples:
 *   `me()`: Get specific details of the currently authenticated user.
 *   `forgotPassword(email: string)`: Initiate password reset flow.
 *   `resetPassword(payload: { password: string; oldPassword?: string; email?: string; token?: string })`: Reset password using token or old password.
+*   `getSecurity()`: Get account security information for the authenticated user. Returns IP addresses, registration date, last seen timestamp, and verification status. **Requires authentication token.**
 
 ### Threads (`client.threads`)
 
+
 *   `list(params: { limit?: number; filter?: 'newest' | 'oldest'; tagId?: string; cursor?: string })`: List threads.
 *   `create(payload: CreateThreadPayload)`: Create a new thread.
 *   `retrieve(id: string)`: Get a thread by ID.
@@ -341,6 +343,7 @@ import {
   RegisterPayload,
   User,
   LoginResponse,
+  SecurityInfo,
   
   // Thread Types
   Thread,
@@ -504,21 +507,28 @@ We welcome contributions! Please see our contributing guidelines for more inform
 
 ## Support
 
-- 📧 Email: support@foru.ms
-- 📚 Documentation: https://docs.foru.ms
-- 🐛 Issues: https://github.com/foru-ms/sdk/issues
+- Support: https://foru.ms/support
+- Documentation: https://docs.foru.ms
+- Issues: https://github.com/foru-ms/sdk/issues
 
 ## Changelog
 
+### v1.2.1
+- README.md formatting and updates
+
 ### v1.2.0
 - Added custom error classes for better error handling
 - Added automatic retry logic with exponential backoff
 - Added pagination helpers for easy iteration
 - Added webhook signature verification
-- Added 22 new endpoints
+- Added new endpoints
+- Enhanced documentation and examples
+
+### v1.1.0
+- Added new endpoints
 - Enhanced documentation and examples
 
-### v1.x
+### v1.0.0
 - Initial SDK release with core functionality
 
 ## License

package/dist/resources/Auth.d.ts

@@ -21,4 +21,13 @@ export declare class AuthResource {
     }): Promise<{
         message: string;
     }>;
+    /**
+     * Get account security information for the authenticated user.
+     * This includes IP addresses, registration date, last seen timestamp, and verification status.
+     * Requires authentication token.
+     *
+     * @returns Promise<SecurityInfo> Security information including IPs and account activity
+     * @throws {ApiError} If not authenticated or user not found
+     */
+    getSecurity(): Promise<import('../types').SecurityInfo>;
 }

package/dist/resources/Auth.js

@@ -45,5 +45,18 @@ class AuthResource {
             body: JSON.stringify(body),
         });
     }
+    /**
+     * Get account security information for the authenticated user.
+     * This includes IP addresses, registration date, last seen timestamp, and verification status.
+     * Requires authentication token.
+     *
+     * @returns Promise<SecurityInfo> Security information including IPs and account activity
+     * @throws {ApiError} If not authenticated or user not found
+     */
+    async getSecurity() {
+        return this.client.request('/auth/security', {
+            method: 'GET',
+        });
+    }
 }
 exports.AuthResource = AuthResource;

package/dist/types.d.ts

@@ -113,6 +113,16 @@ export interface PostListResponse {
 export interface LoginResponse {
     token: string;
 }
+export interface SecurityInfo {
+    userId: string;
+    username: string;
+    registrationIp: string;
+    registrationDate: string;
+    lastIp: string;
+    lastSeenAt: string;
+    isOnline: boolean;
+    emailVerified: boolean;
+}
 export type ThreadFilter = 'newest' | 'oldest';
 export type InteractionType = 'created' | 'liked' | 'disliked' | 'upvoted' | 'downvoted' | 'subscribed';
 export interface Tag {

package/examples/authentication.ts

@@ -54,12 +54,24 @@ async function main() {
         });
         console.log('Password reset successful');
 
-        // Example 5: Check Authentication Status
+        // Example 5: Get Account Security Information
+        console.log('\n=== Account Security Info ===');
+        const securityInfo = await client.auth.getSecurity();
+        console.log('User ID:', securityInfo.userId);
+        console.log('Username:', securityInfo.username);
+        console.log('Registration IP:', securityInfo.registrationIp);
+        console.log('Registration Date:', new Date(securityInfo.registrationDate).toLocaleDateString());
+        console.log('Last IP:', securityInfo.lastIp);
+        console.log('Last Seen:', new Date(securityInfo.lastSeenAt).toLocaleString());
+        console.log('Is Online:', securityInfo.isOnline);
+        console.log('Email Verified:', securityInfo.emailVerified);
+
+        // Example 6: Check Authentication Status
         console.log('\n=== Authentication Status ===');
         console.log('Is authenticated:', client.isAuthenticated());
         console.log('Current token:', client.token);
 
-        // Example 6: Logout (clear token)
+        // Example 7: Logout (clear token)
         console.log('\n=== Logout ===');
         client.clearToken();
         console.log('Token cleared');

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@foru-ms/sdk",
-    "version": "1.2.0",
+    "version": "1.2.2",
     "description": "JavaScript SDK for Foru.ms",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",

package/src/resources/Auth.ts

@@ -61,4 +61,18 @@ export class AuthResource {
             body: JSON.stringify(body),
         });
     }
+
+    /**
+     * Get account security information for the authenticated user.
+     * This includes IP addresses, registration date, last seen timestamp, and verification status.
+     * Requires authentication token.
+     * 
+     * @returns Promise<SecurityInfo> Security information including IPs and account activity
+     * @throws {ApiError} If not authenticated or user not found
+     */
+    async getSecurity(): Promise<import('../types').SecurityInfo> {
+        return this.client.request<import('../types').SecurityInfo>('/auth/security', {
+            method: 'GET',
+        });
+    }
 }

package/src/types.ts

@@ -128,6 +128,17 @@ export interface LoginResponse {
     token: string;
 }
 
+export interface SecurityInfo {
+    userId: string;
+    username: string;
+    registrationIp: string;
+    registrationDate: string;
+    lastIp: string;
+    lastSeenAt: string;
+    isOnline: boolean;
+    emailVerified: boolean;
+}
+
 export type ThreadFilter = 'newest' | 'oldest';
 export type InteractionType = 'created' | 'liked' | 'disliked' | 'upvoted' | 'downvoted' | 'subscribed';