@foru-ms/sdk 1.2.6 → 1.2.8

package/README.md

@@ -552,6 +552,12 @@ We welcome contributions! Please see our contributing guidelines for more inform
 
 ## Changelog
 
+### v1.2.8
+- Added Poll resource for poll management
+
+### v1.2.7
+- Fixed issue with optional parameters not being optional in typescript
+
 ### v1.2.6
 - Fixed issue with optional parameters not being optional in typescript
 

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/resources/Users.d.ts

@@ -59,8 +59,8 @@ export declare class UsersResource {
         nextUserCursor?: string;
         count: number;
     }>;
-    follow(id: string, followerId: string, extendedData?: any): Promise<any>;
-    unfollow(id: string, followerId: string): Promise<any>;
+    follow(id: string, followerId?: string, extendedData?: any): Promise<any>;
+    unfollow(id: string, followerId?: string): Promise<any>;
     getFollowing(id: string, params?: {
         query?: string;
         cursor?: string;

package/dist/resources/Users.js

@@ -86,8 +86,9 @@ class UsersResource {
         });
     }
     async unfollow(id, followerId) {
-        return this.client.request(`/user/${id}/followers?followerId=${followerId}`, {
+        return this.client.request(`/user/${id}/followers`, {
             method: 'DELETE',
+            body: JSON.stringify({ followerId }),
         });
     }
     async getFollowing(id, params) {

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/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.6",
+    "version": "1.2.8",
     "description": "JavaScript SDK for Foru.ms",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",

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/resources/Users.ts

@@ -133,16 +133,17 @@ export class UsersResource {
         });
     }
 
-    async follow(id: string, followerId: string, extendedData?: any): Promise<any> {
+    async follow(id: string, followerId?: string, extendedData?: any): Promise<any> {
         return this.client.request(`/user/${id}/followers`, {
             method: 'POST',
             body: JSON.stringify({ followerId, extendedData }),
         });
     }
 
-    async unfollow(id: string, followerId: string): Promise<any> {
-        return this.client.request(`/user/${id}/followers?followerId=${followerId}`, {
+    async unfollow(id: string, followerId?: string): Promise<any> {
+        return this.client.request(`/user/${id}/followers`, {
             method: 'DELETE',
+            body: JSON.stringify({ followerId }),
         });
     }
 

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
  */