@foru-ms/sdk 1.2.7 → 1.3.0

package/README.md

@@ -201,7 +201,7 @@ Check the `/examples` directory for detailed examples:
 ### Auth (`client.auth`)
 
 *   `login(payload: { login: string; password: string })`: Login a user. Returns `{ token: string }`.
-*   `register(payload: RegisterPayload)`: Register a new user.
+*   `register(payload: RegisterPayload)`: Register a new user. Returns `{ user: User, token: string }`. Token is automatically set on the client.
 *   `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.
@@ -382,6 +382,7 @@ import {
   RegisterPayload,
   User,
   LoginResponse,
+  RegisterResponse,
   SecurityInfo,
   
   // Thread Types
@@ -552,6 +553,12 @@ We welcome contributions! Please see our contributing guidelines for more inform
 
 ## Changelog
 
+### v1.3.0
+- Added Auth resource, authentication example, and related types
+
+### v1.2.8
+- Added Poll resource for poll management
+
 ### v1.2.7
 - Fixed issue with optional parameters not being optional in typescript
 

package/dist/resources/Auth.d.ts

@@ -1,5 +1,5 @@
 import { ForumClient } from '../Client';
-import { LoginResponse } from '../types';
+import { LoginResponse, RegisterResponse } from '../types';
 export declare class AuthResource {
     private client;
     constructor(client: ForumClient);
@@ -7,7 +7,7 @@ export declare class AuthResource {
         login: string;
         password: string;
     }): Promise<LoginResponse>;
-    register(payload: import('../types').RegisterPayload): Promise<import('../types').User>;
+    register(payload: import('../types').RegisterPayload): Promise<RegisterResponse>;
     me(): Promise<import('../types').User>;
     forgotPassword(email: string): Promise<{
         resetToken?: string;

package/dist/resources/Auth.js

@@ -16,10 +16,14 @@ class AuthResource {
         return response;
     }
     async register(payload) {
-        return this.client.request('/auth/register', {
+        const response = await this.client.request('/auth/register', {
             method: 'POST',
             body: JSON.stringify(payload),
         });
+        if (response.token) {
+            this.client.setToken(response.token);
+        }
+        return response;
     }
     async me() {
         return this.client.request('/auth/me', {

package/dist/resources/Threads.d.ts

@@ -1,5 +1,6 @@
 import { ForumClient } from '../Client';
 import { ThreadListResponse, ThreadFilter, InteractionType } from '../types';
+import { PollResults } from '../response-types';
 export declare class ThreadsResource {
     private client;
     constructor(client: ForumClient);
@@ -57,6 +58,7 @@ export declare class ThreadsResource {
         limit?: number;
     }): Promise<any>;
     getPoll(threadId: string, userId?: string): Promise<any>;
+    getPollResults(threadId: string, userId?: string): Promise<PollResults>;
     vote(id: string, optionId: string, userId?: string): Promise<any>;
     voteUpdate(id: string, optionId: string, userId?: string): Promise<any>;
     unvote(id: string, userId?: string): Promise<any>;

package/dist/resources/Threads.js

@@ -175,6 +175,14 @@ class ThreadsResource {
         const query = searchParams.toString();
         return this.client.request(`/thread/${threadId}/poll${query ? `?${query}` : ''}`, { method: 'GET' });
     }
+    async getPollResults(threadId, userId) {
+        const searchParams = new URLSearchParams();
+        if (userId) {
+            searchParams.append('userId', userId);
+        }
+        const query = searchParams.toString();
+        return this.client.request(`/thread/${threadId}/poll/results${query ? `?${query}` : ''}`, { method: 'GET' });
+    }
     async vote(id, optionId, userId) {
         return this.client.request(`/thread/${id}/poll/votes`, {
             method: 'POST',

package/dist/response-types.d.ts

@@ -78,6 +78,28 @@ export interface PollOption {
     /** Extended data */
     extendedData?: Record<string, any>;
 }
+/**
+ * Simplified poll option for results
+ */
+export interface PollOptionResult {
+    /** The ID of the poll option */
+    id: string;
+    /** The title of the poll option */
+    title: string;
+    /** The color of the poll option */
+    color?: string;
+    /** The number of votes this option received */
+    votes: number;
+}
+/**
+ * Poll results data
+ */
+export interface PollResults {
+    /** List of poll options with results */
+    options: PollOptionResult[];
+    /** The option ID that the user voted for, or null if they haven't voted */
+    userVote?: string | null;
+}
 /**
  * Response for batch operations
  */

package/dist/types.d.ts

@@ -113,6 +113,10 @@ export interface PostListResponse {
 export interface LoginResponse {
     token: string;
 }
+export interface RegisterResponse {
+    user: User;
+    token: string;
+}
 export interface SecurityInfo {
     userId: string;
     username: string;

package/examples/authentication.ts

@@ -14,13 +14,15 @@ async function main() {
     try {
         // Example 1: User Registration
         console.log('=== User Registration ===');
-        const newUser = await client.auth.register({
+        const { user, token } = await client.auth.register({
             username: 'john_doe',
             email: 'john@example.com',
             password: 'securePassword123',
             displayName: 'John Doe',
         });
-        console.log('User registered:', newUser);
+        console.log('User registered:', user);
+        console.log('Auth token:', token);
+        // Note: Token is automatically set on the client
 
         // Example 2: User Login
         console.log('\n=== User Login ===');
@@ -29,9 +31,7 @@ async function main() {
             password: 'securePassword123',
         });
         console.log('Login successful, token:', loginResponse.token);
-
-        // Store the token for authenticated requests
-        client.setToken(loginResponse.token);
+        // Note: Token is automatically set on the client
 
         // Example 3: Get Current User
         console.log('\n=== Get Current User ===');

package/examples/managing-threads.ts

@@ -1,3 +1,4 @@
+// @ts-ignore
 import { ForumClient } from '@foru-ms/sdk';
 
 /**
@@ -70,8 +71,12 @@ async function main() {
     await client.threads.vote(pollThread.id, 'option-id-1', userId);
     console.log('Vote cast');
 
+    // Get poll
+    const poll = await client.threads.getPoll(pollThread.id, userId);
+    console.log('Poll:', poll);
+
     // Get poll results
-    const pollResults = await client.threads.getPoll(pollThread.id, userId);
+    const pollResults = await client.threads.getPollResults(pollThread.id, userId);
     console.log('Poll results:', pollResults);
 
     // Example 7: Add Posts to Thread

package/package.json

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

package/src/resources/Auth.ts

@@ -1,5 +1,5 @@
 import { ForumClient } from '../Client';
-import { LoginResponse } from '../types';
+import { LoginResponse, RegisterResponse } from '../types';
 
 export class AuthResource {
     private client: ForumClient;
@@ -21,11 +21,17 @@ export class AuthResource {
         return response;
     }
 
-    async register(payload: import('../types').RegisterPayload): Promise<import('../types').User> {
-        return this.client.request<import('../types').User>('/auth/register', {
+    async register(payload: import('../types').RegisterPayload): Promise<RegisterResponse> {
+        const response = await this.client.request<RegisterResponse>('/auth/register', {
             method: 'POST',
             body: JSON.stringify(payload),
         });
+
+        if (response.token) {
+            this.client.setToken(response.token);
+        }
+
+        return response;
     }
 
     async me(): Promise<import('../types').User> {

package/src/resources/Threads.ts

@@ -1,5 +1,6 @@
 import { ForumClient } from '../Client';
 import { ThreadListResponse, ThreadFilter, InteractionType } from '../types';
+import { PollResults } from '../response-types';
 
 export class ThreadsResource {
     private client: ForumClient;
@@ -232,6 +233,19 @@ export class ThreadsResource {
         );
     }
 
+    async getPollResults(threadId: string, userId?: string): Promise<PollResults> {
+        const searchParams = new URLSearchParams();
+        if (userId) {
+            searchParams.append('userId', userId);
+        }
+
+        const query = searchParams.toString();
+        return this.client.request<PollResults>(
+            `/thread/${threadId}/poll/results${query ? `?${query}` : ''}`,
+            { method: 'GET' }
+        );
+    }
+
     async vote(id: string, optionId: string, userId?: string): Promise<any> {
         return this.client.request(`/thread/${id}/poll/votes`, {
             method: 'POST',

package/src/response-types.ts

@@ -85,6 +85,30 @@ export interface PollOption {
     extendedData?: Record<string, any>;
 }
 
+/**
+ * Simplified poll option for results
+ */
+export interface PollOptionResult {
+    /** The ID of the poll option */
+    id: string;
+    /** The title of the poll option */
+    title: string;
+    /** The color of the poll option */
+    color?: string;
+    /** The number of votes this option received */
+    votes: number;
+}
+
+/**
+ * Poll results data
+ */
+export interface PollResults {
+    /** List of poll options with results */
+    options: PollOptionResult[];
+    /** The option ID that the user voted for, or null if they haven't voted */
+    userVote?: string | null;
+}
+
 /**
  * Response for batch operations
  */

package/src/types.ts

@@ -128,6 +128,11 @@ export interface LoginResponse {
     token: string;
 }
 
+export interface RegisterResponse {
+    user: User;
+    token: string;
+}
+
 export interface SecurityInfo {
     userId: string;
     username: string;