@foru-ms/sdk 1.2.4 → 1.2.5

package/README.md

@@ -43,7 +43,6 @@ client.setToken('user_jwt_token');
 const thread = await client.threads.create({
   title: 'My First Thread',
   body: 'Hello, Foru.ms!',
-  userId: 'user-123',
 });
 
 // List threads with auto-pagination
@@ -137,7 +136,7 @@ const users = await client.users.list({ limit: 10 });
 
 // Limit applies to all paginated endpoints
 const posts = await client.posts.list({ limit: 25 });
-const notifications = await client.notifications.list({ userId: 'user-123', limit: 30 });
+const notifications = await client.notifications.list({ limit: 30 });
 ```
 
 ## Webhooks
@@ -553,6 +552,9 @@ We welcome contributions! Please see our contributing guidelines for more inform
 
 ## Changelog
 
+### v1.2.5
+- Added optional `userId` parameter to methods that accept it
+
 ### v1.2.4
 - Pagination Enhancement: Added configurable `limit` query parameter to all paginated endpoints
   - Allows clients to control page size (min: 1, max: 50, default: 15)

package/dist/resources/Notifications.d.ts

@@ -4,13 +4,13 @@ export declare class NotificationsResource {
     private client;
     constructor(client: ForumClient);
     list(params: {
-        userId: string;
+        userId?: string;
         read?: boolean;
         filter?: 'newest' | 'oldest';
         cursor?: string;
         limit?: number;
     }): Promise<NotificationListResponse>;
-    markAllAsRead(userId: string, read?: boolean): Promise<{
+    markAllAsRead(userId?: string, read?: boolean): Promise<{
         count: number;
     }>;
     retrieve(id: string): Promise<Notification>;
@@ -24,7 +24,7 @@ export declare class NotificationsResource {
         threadId?: string;
         postId?: string;
         privateMessageId?: string;
-        notifierId: string;
+        notifierId?: string;
         notifiedId: string;
         type: string;
         description?: string;

package/dist/resources/Posts.d.ts

@@ -15,7 +15,7 @@ export declare class PostsResource {
     retrieve(postId: string): Promise<import('../types').Post>;
     update(postId: string, payload: import('../types').UpdatePostPayload): Promise<import('../types').Post>;
     delete(postId: string, payload?: {
-        userId: string;
+        userId?: string;
     }): Promise<import('../types').Post & {
         deleted: boolean;
     }>;
@@ -26,25 +26,25 @@ export declare class PostsResource {
         limit?: number;
     }): Promise<any>;
     like(id: string, userId?: string, extendedData?: any): Promise<any>;
-    unlike(id: string, userId: string): Promise<any>;
+    unlike(id: string, userId?: string): Promise<any>;
     getLikes(id: string, params?: {
         cursor?: string;
         limit?: number;
     }): Promise<any>;
     dislike(id: string, userId?: string, extendedData?: any): Promise<any>;
-    undislike(id: string, userId: string): Promise<any>;
+    undislike(id: string, userId?: string): Promise<any>;
     getDislikes(id: string, params?: {
         cursor?: string;
         limit?: number;
     }): Promise<any>;
     upvote(id: string, userId?: string, extendedData?: any): Promise<any>;
-    unupvote(id: string, userId: string): Promise<any>;
+    unupvote(id: string, userId?: string): Promise<any>;
     getUpvotes(id: string, params?: {
         cursor?: string;
         limit?: number;
     }): Promise<any>;
     downvote(id: string, userId?: string, extendedData?: any): Promise<any>;
-    undownvote(id: string, userId: string): Promise<any>;
+    undownvote(id: string, userId?: string): Promise<any>;
     getDownvotes(id: string, params?: {
         cursor?: string;
         limit?: number;

package/dist/resources/Posts.js

@@ -59,7 +59,9 @@ class PostsResource {
         });
     }
     async unlike(id, userId) {
-        return this.client.request(`/post/${id}/likes?userId=${userId}`, {
+        return userId ? this.client.request(`/post/${id}/likes?userId=${userId}`, {
+            method: 'DELETE',
+        }) : this.client.request(`/post/${id}/likes`, {
             method: 'DELETE',
         });
     }
@@ -81,7 +83,9 @@ class PostsResource {
         });
     }
     async undislike(id, userId) {
-        return this.client.request(`/post/${id}/dislikes?userId=${userId}`, {
+        return userId ? this.client.request(`/post/${id}/dislikes?userId=${userId}`, {
+            method: 'DELETE',
+        }) : this.client.request(`/post/${id}/dislikes`, {
             method: 'DELETE',
         });
     }
@@ -103,7 +107,9 @@ class PostsResource {
         });
     }
     async unupvote(id, userId) {
-        return this.client.request(`/post/${id}/upvotes?userId=${userId}`, {
+        return userId ? this.client.request(`/post/${id}/upvotes?userId=${userId}`, {
+            method: 'DELETE',
+        }) : this.client.request(`/post/${id}/upvotes`, {
             method: 'DELETE',
         });
     }
@@ -125,7 +131,9 @@ class PostsResource {
         });
     }
     async undownvote(id, userId) {
-        return this.client.request(`/post/${id}/downvotes?userId=${userId}`, {
+        return userId ? this.client.request(`/post/${id}/downvotes?userId=${userId}`, {
+            method: 'DELETE',
+        }) : this.client.request(`/post/${id}/downvotes`, {
             method: 'DELETE',
         });
     }

package/dist/resources/Tags.d.ts

@@ -34,14 +34,14 @@ export declare class TagsResource {
         filter?: 'newest' | 'oldest';
         limit?: number;
     }): Promise<import('../types').ThreadListResponse>;
-    subscribe(id: string, userId: string): Promise<any>;
-    unsubscribe(id: string, userId: string): Promise<any>;
+    subscribe(id: string, userId?: string): Promise<any>;
+    unsubscribe(id: string, userId?: string): Promise<any>;
     getSubscribers(id: string, params?: {
         cursor?: string;
         limit?: number;
     }): Promise<any>;
     listSubscribed(params: {
-        userId: string;
+        userId?: string;
         query?: string;
         cursor?: string;
         limit?: number;

package/dist/resources/Tags.js

@@ -63,8 +63,9 @@ class TagsResource {
         });
     }
     async unsubscribe(id, userId) {
-        return this.client.request(`/tag/${id}/subscribers?userId=${userId}`, {
+        return this.client.request(`/tag/${id}/subscribers`, {
             method: 'DELETE',
+            body: JSON.stringify({ userId }),
         });
     }
     async getSubscribers(id, params) {

package/dist/resources/Threads.d.ts

@@ -16,7 +16,7 @@ export declare class ThreadsResource {
     retrieve(threadId: string): Promise<import('../types').Thread>;
     update(threadId: string, payload: import('../types').UpdateThreadPayload): Promise<import('../types').Thread>;
     delete(threadId: string, payload?: {
-        userId: string;
+        userId?: string;
     }): Promise<import('../types').Thread & {
         deleted: boolean;
     }>;
@@ -27,37 +27,37 @@ export declare class ThreadsResource {
         limit?: number;
     }): Promise<any>;
     like(id: string, userId?: string, extendedData?: any): Promise<any>;
-    unlike(id: string, userId: string): Promise<any>;
+    unlike(id: string, userId?: string): Promise<any>;
     getLikes(id: string, params?: {
         cursor?: string;
         limit?: number;
     }): Promise<any>;
     dislike(id: string, userId?: string, extendedData?: any): Promise<any>;
-    undislike(id: string, userId: string): Promise<any>;
+    undislike(id: string, userId?: string): Promise<any>;
     getDislikes(id: string, params?: {
         cursor?: string;
         limit?: number;
     }): Promise<any>;
-    subscribe(id: string, userId: string, extendedData?: any): Promise<any>;
-    unsubscribe(id: string, userId: string): Promise<any>;
+    subscribe(id: string, userId?: string, extendedData?: any): Promise<any>;
+    unsubscribe(id: string, userId?: string): Promise<any>;
     getSubscribers(id: string, params?: {
         cursor?: string;
         limit?: number;
     }): Promise<any>;
     upvote(id: string, userId?: string, extendedData?: any): Promise<any>;
-    unupvote(id: string, userId: string): Promise<any>;
+    unupvote(id: string, userId?: string): Promise<any>;
     getUpvotes(id: string, params?: {
         cursor?: string;
         limit?: number;
     }): Promise<any>;
     downvote(id: string, userId?: string, extendedData?: any): Promise<any>;
-    undownvote(id: string, userId: string): Promise<any>;
+    undownvote(id: string, userId?: string): Promise<any>;
     getDownvotes(id: string, params?: {
         cursor?: string;
         limit?: number;
     }): Promise<any>;
     getPoll(threadId: string, userId?: string): Promise<any>;
-    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>;
+    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

@@ -59,8 +59,9 @@ class ThreadsResource {
         });
     }
     async unlike(id, userId) {
-        return this.client.request(`/thread/${id}/likes?userId=${userId}`, {
+        return this.client.request(`/thread/${id}/likes`, {
             method: 'DELETE',
+            body: JSON.stringify({ userId }),
         });
     }
     async getLikes(id, params) {
@@ -81,8 +82,9 @@ class ThreadsResource {
         });
     }
     async undislike(id, userId) {
-        return this.client.request(`/thread/${id}/dislikes?userId=${userId}`, {
+        return this.client.request(`/thread/${id}/dislikes`, {
             method: 'DELETE',
+            body: JSON.stringify({ userId }),
         });
     }
     async getDislikes(id, params) {
@@ -103,8 +105,9 @@ class ThreadsResource {
         });
     }
     async unsubscribe(id, userId) {
-        return this.client.request(`/thread/${id}/subscribers?userId=${userId}`, {
+        return this.client.request(`/thread/${id}/subscribers`, {
             method: 'DELETE',
+            body: JSON.stringify({ userId }),
         });
     }
     async getSubscribers(id, params) {
@@ -125,8 +128,9 @@ class ThreadsResource {
         });
     }
     async unupvote(id, userId) {
-        return this.client.request(`/thread/${id}/upvotes?userId=${userId}`, {
+        return this.client.request(`/thread/${id}/upvotes`, {
             method: 'DELETE',
+            body: JSON.stringify({ userId }),
         });
     }
     async getUpvotes(id, params) {
@@ -147,8 +151,9 @@ class ThreadsResource {
         });
     }
     async undownvote(id, userId) {
-        return this.client.request(`/thread/${id}/downvotes?userId=${userId}`, {
+        return this.client.request(`/thread/${id}/downvotes`, {
             method: 'DELETE',
+            body: JSON.stringify({ userId }),
         });
     }
     async getDownvotes(id, params) {
@@ -183,8 +188,9 @@ class ThreadsResource {
         });
     }
     async unvote(id, userId) {
-        return this.client.request(`/thread/${id}/poll/votes?userId=${userId}`, {
+        return this.client.request(`/thread/${id}/poll/votes`, {
             method: 'DELETE',
+            body: JSON.stringify({ userId }),
         });
     }
 }

package/examples/error-handling.ts

@@ -59,7 +59,6 @@ async function main() {
         await client.threads.create({
             title: '', // Invalid: empty title
             body: 'Test',
-            userId: 'user-123',
         });
     } catch (error) {
         if (error instanceof ValidationError) {

package/examples/managing-threads.ts

@@ -79,7 +79,6 @@ async function main() {
     const post = await client.posts.create({
         threadId: newThread.id,
         body: 'Thanks for posting! Check out our documentation.',
-        userId: 'moderator-123',
     });
     console.log('Post created:', post.id);
 
@@ -87,7 +86,6 @@ async function main() {
     const reply = await client.posts.create({
         threadId: newThread.id,
         body: 'Thank you! That helps a lot.',
-        userId,
         parentId: post.id, // This makes it a reply
     });
     console.log('Reply created:', reply.id);

package/examples/pagination.ts

@@ -58,8 +58,7 @@ async function main() {
         const response = await client.posts.list({
             cursor,
             filter: 'newest',
-            type: 'created', // Only posts created by user
-            userId: 'user-123',
+            type: 'created',
         });
 
         console.log(`Page ${++pageCount}:`, response.posts.length, 'posts');

package/package.json

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

package/src/resources/Notifications.ts

@@ -9,7 +9,7 @@ export class NotificationsResource {
     }
 
     async list(params: {
-        userId: string;
+        userId?: string;
         read?: boolean;
         filter?: 'newest' | 'oldest';
         cursor?: string;
@@ -27,7 +27,7 @@ export class NotificationsResource {
         });
     }
 
-    async markAllAsRead(userId: string, read: boolean = true): Promise<{ count: number }> {
+    async markAllAsRead(userId?: string, read: boolean = true): Promise<{ count: number }> {
         return this.client.request<{ count: number }>('/notifications', {
             method: 'PATCH',
             body: JSON.stringify({ userId, read }),
@@ -56,7 +56,7 @@ export class NotificationsResource {
         threadId?: string;
         postId?: string;
         privateMessageId?: string;
-        notifierId: string;
+        notifierId?: string;
         notifiedId: string;
         type: string;
         description?: string;

package/src/resources/Posts.ts

@@ -50,7 +50,7 @@ export class PostsResource {
         });
     }
 
-    async delete(postId: string, payload?: { userId: string }): Promise<import('../types').Post & { deleted: boolean }> {
+    async delete(postId: string, payload?: { userId?: string }): Promise<import('../types').Post & { deleted: boolean }> {
         return this.client.request<import('../types').Post & { deleted: boolean }>(`/post/${postId}`, {
             method: 'DELETE',
             body: payload ? JSON.stringify(payload) : undefined,
@@ -80,8 +80,10 @@ export class PostsResource {
         });
     }
 
-    async unlike(id: string, userId: string): Promise<any> {
-        return this.client.request(`/post/${id}/likes?userId=${userId}`, {
+    async unlike(id: string, userId?: string): Promise<any> {
+        return userId ? this.client.request(`/post/${id}/likes?userId=${userId}`, {
+            method: 'DELETE',
+        }) : this.client.request(`/post/${id}/likes`, {
             method: 'DELETE',
         });
     }
@@ -108,8 +110,10 @@ export class PostsResource {
         });
     }
 
-    async undislike(id: string, userId: string): Promise<any> {
-        return this.client.request(`/post/${id}/dislikes?userId=${userId}`, {
+    async undislike(id: string, userId?: string): Promise<any> {
+        return userId ? this.client.request(`/post/${id}/dislikes?userId=${userId}`, {
+            method: 'DELETE',
+        }) : this.client.request(`/post/${id}/dislikes`, {
             method: 'DELETE',
         });
     }
@@ -136,8 +140,10 @@ export class PostsResource {
         });
     }
 
-    async unupvote(id: string, userId: string): Promise<any> {
-        return this.client.request(`/post/${id}/upvotes?userId=${userId}`, {
+    async unupvote(id: string, userId?: string): Promise<any> {
+        return userId ? this.client.request(`/post/${id}/upvotes?userId=${userId}`, {
+            method: 'DELETE',
+        }) : this.client.request(`/post/${id}/upvotes`, {
             method: 'DELETE',
         });
     }
@@ -164,8 +170,10 @@ export class PostsResource {
         });
     }
 
-    async undownvote(id: string, userId: string): Promise<any> {
-        return this.client.request(`/post/${id}/downvotes?userId=${userId}`, {
+    async undownvote(id: string, userId?: string): Promise<any> {
+        return userId ? this.client.request(`/post/${id}/downvotes?userId=${userId}`, {
+            method: 'DELETE',
+        }) : this.client.request(`/post/${id}/downvotes`, {
             method: 'DELETE',
         });
     }

package/src/resources/Tags.ts

@@ -84,16 +84,17 @@ export class TagsResource {
         });
     }
 
-    async subscribe(id: string, userId: string): Promise<any> {
+    async subscribe(id: string, userId?: string): Promise<any> {
         return this.client.request(`/tag/${id}/subscribers`, {
             method: 'POST',
             body: JSON.stringify({ userId }),
         });
     }
 
-    async unsubscribe(id: string, userId: string): Promise<any> {
-        return this.client.request(`/tag/${id}/subscribers?userId=${userId}`, {
+    async unsubscribe(id: string, userId?: string): Promise<any> {
+        return this.client.request(`/tag/${id}/subscribers`, {
             method: 'DELETE',
+            body: JSON.stringify({ userId }),
         });
     }
 
@@ -113,7 +114,7 @@ export class TagsResource {
     }
 
     async listSubscribed(params: {
-        userId: string;
+        userId?: string;
         query?: string;
         cursor?: string;
         limit?: number;

package/src/resources/Threads.ts

@@ -51,7 +51,7 @@ export class ThreadsResource {
         });
     }
 
-    async delete(threadId: string, payload?: { userId: string }): Promise<import('../types').Thread & { deleted: boolean }> {
+    async delete(threadId: string, payload?: { userId?: string }): Promise<import('../types').Thread & { deleted: boolean }> {
         return this.client.request<import('../types').Thread & { deleted: boolean }>(`/thread/${threadId}`, {
             method: 'DELETE',
             body: payload ? JSON.stringify(payload) : undefined,
@@ -81,9 +81,10 @@ export class ThreadsResource {
         });
     }
 
-    async unlike(id: string, userId: string): Promise<any> {
-        return this.client.request(`/thread/${id}/likes?userId=${userId}`, {
+    async unlike(id: string, userId?: string): Promise<any> {
+        return this.client.request(`/thread/${id}/likes`, {
             method: 'DELETE',
+            body: JSON.stringify({ userId }),
         });
     }
 
@@ -109,9 +110,10 @@ export class ThreadsResource {
         });
     }
 
-    async undislike(id: string, userId: string): Promise<any> {
-        return this.client.request(`/thread/${id}/dislikes?userId=${userId}`, {
+    async undislike(id: string, userId?: string): Promise<any> {
+        return this.client.request(`/thread/${id}/dislikes`, {
             method: 'DELETE',
+            body: JSON.stringify({ userId }),
         });
     }
 
@@ -130,16 +132,17 @@ export class ThreadsResource {
         return this.client.request(`/thread/${id}/dislikes?${searchParams.toString()}`, { method: 'GET' });
     }
 
-    async subscribe(id: string, userId: string, extendedData?: any): Promise<any> {
+    async subscribe(id: string, userId?: string, extendedData?: any): Promise<any> {
         return this.client.request(`/thread/${id}/subscribers`, {
             method: 'POST',
             body: JSON.stringify({ userId, extendedData }),
         });
     }
 
-    async unsubscribe(id: string, userId: string): Promise<any> {
-        return this.client.request(`/thread/${id}/subscribers?userId=${userId}`, {
+    async unsubscribe(id: string, userId?: string): Promise<any> {
+        return this.client.request(`/thread/${id}/subscribers`, {
             method: 'DELETE',
+            body: JSON.stringify({ userId }),
         });
     }
 
@@ -165,9 +168,10 @@ export class ThreadsResource {
         });
     }
 
-    async unupvote(id: string, userId: string): Promise<any> {
-        return this.client.request(`/thread/${id}/upvotes?userId=${userId}`, {
+    async unupvote(id: string, userId?: string): Promise<any> {
+        return this.client.request(`/thread/${id}/upvotes`, {
             method: 'DELETE',
+            body: JSON.stringify({ userId }),
         });
     }
 
@@ -193,9 +197,10 @@ export class ThreadsResource {
         });
     }
 
-    async undownvote(id: string, userId: string): Promise<any> {
-        return this.client.request(`/thread/${id}/downvotes?userId=${userId}`, {
+    async undownvote(id: string, userId?: string): Promise<any> {
+        return this.client.request(`/thread/${id}/downvotes`, {
             method: 'DELETE',
+            body: JSON.stringify({ userId }),
         });
     }
 
@@ -227,23 +232,24 @@ export class ThreadsResource {
         );
     }
 
-    async vote(id: string, optionId: string, userId: string): Promise<any> {
+    async vote(id: string, optionId: string, userId?: string): Promise<any> {
         return this.client.request(`/thread/${id}/poll/votes`, {
             method: 'POST',
             body: JSON.stringify({ optionId, userId }),
         });
     }
 
-    async voteUpdate(id: string, optionId: string, userId: string): Promise<any> {
+    async voteUpdate(id: string, optionId: string, userId?: string): Promise<any> {
         return this.client.request(`/thread/${id}/poll/votes`, {
             method: 'PUT',
             body: JSON.stringify({ optionId, userId }),
         });
     }
 
-    async unvote(id: string, userId: string): Promise<any> {
-        return this.client.request(`/thread/${id}/poll/votes?userId=${userId}`, {
+    async unvote(id: string, userId?: string): Promise<any> {
+        return this.client.request(`/thread/${id}/poll/votes`, {
             method: 'DELETE',
+            body: JSON.stringify({ userId }),
         });
     }
 }