We are excited to announce the release of the official JavaScript/TypeScript SDK for Foru.ms . This new SDK allows you to build powerful community features directly into your application with ease.
It is fully typed and provides a comprehensive, easy-to-use interface to the Foru.ms API.
npm install @foru-ms/sdk
# or
yarn add @foru-ms/sdk
# or
pnpm add @foru-ms/sdkimport { ForumClient } from '@foru-ms/sdk';
const client = new ForumClient({
apiKey: 'your_api_key',
// baseUrl: 'https://api.foru.ms/v1' // Optional
});
// Set an authentication token (JWT) for user-scoped requests
client.setToken('user_jwt_token');client.auth)login(payload: { login: string; password: string }): Login a user. Returns { token: string }.register(payload: RegisterPayload): Register a new user.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.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.update(id: string, payload: UpdateThreadPayload): Update a thread.delete(id: string): Delete a thread.getPosts(id: string, params: { cursor?: string; filter?: 'newest' | 'oldest' }): Get posts in a thread.like(id: string, userId: string, extendedData?: any): Like a thread.unlike(id: string, userId: string): Unlike a thread.dislike(id: string, userId: string, extendedData?: any): Dislike a thread.undislike(id: string, userId: string): Remove dislike from a thread.subscribe(id: string, userId: string): Subscribe to a thread.unsubscribe(id: string, userId: string): Unsubscribe from a thread.vote(id: string, userId: string, optionId: string): Vote in a thread poll.voteUpdate(id: string, userId: string, optionId: string): Change vote.unvote(id: string, userId: string): Remove vote.client.posts)list(params: { limit?: number; cursor?: string; filter?: 'newest' | 'oldest'; threadId?: string }): List posts (flat).create(payload: CreatePostPayload): Create a reply.retrieve(id: string): Get a post by ID.update(id: string, payload: UpdatePostPayload): Update a post.delete(id: string): Delete a post.getChildren(id: string, params: { cursor?: string; filter?: 'newest' | 'oldest' }): Get child posts (nested replies).like(id: string, userId: string, extendedData?: any): Like a post.unlike(id: string, userId: string): Unlike a post.dislike(id: string, userId: string, extendedData?: any): Dislike a post.undislike(id: string, userId: string): Remove dislike.upvote(id: string, userId: string, extendedData?: any): Upvote a post.unupvote(id: string, userId: string): Remove upvote.downvote(id: string, userId: string, extendedData?: any): Downvote a post.undownvote(id: string, userId: string): Remove downvote.client.users)list(params?: { query?: string; filter?: 'newest' | 'oldest'; cursor?: string }): List users.retrieve(userId: string): Get user by ID.create(payload: { username: string; email: string; password: string; displayName?: string; emailVerified?: boolean; roles?: string[]; bio?: string; signature?: string; url?: string; extendedData?: Record<string, any> }): Create a user (Admin).update(id: string, payload: { username?: string; email?: string; password?: string; displayName?: string; emailVerified?: boolean; roles?: string[]; bio?: string; signature?: string; url?: string; extendedData?: Record<string, any> }): Update a user.delete(id: string): Delete a user.getFollowers(id: string, params?: { query?: string; cursor?: string; filter?: 'newest' | 'oldest' }): Get user’s followers.getFollowing(id: string, params?: { query?: string; cursor?: string; filter?: 'newest' | 'oldest' }): Get who a user follows.follow(id: string, followerId: string, extendedData?: any): Follow a user.unfollow(id: string, followerId: string): Unfollow a user.client.tags)list(params?: { query?: string; cursor?: string }): List tags.create(payload: { name: string; description?: string; color?: string; extendedData?: Record<string, any> }): Create a tag.retrieve(id: string, params?: { userId?: string }): Get a tag.update(id: string, payload: { name?: string; description?: string; color?: string; extendedData?: Record<string, any> }): Update a tag.delete(id: string): Delete a tag.subscribe(id: string, userId: string): Subscribe to a tag.unsubscribe(id: string, userId: string): Unsubscribe from a tag.listSubscribed(params: { userId: string; query?: string; cursor?: string }): List tags a user is subscribed to.client.notifications)list(params: { userId: string; read?: boolean; filter?: 'newest' | 'oldest'; cursor?: string }): List notifications.markAllAsRead(userId: string, read?: boolean): Bulk update read status. Default is true.create(payload: { threadId?: string; postId?: string; privateMessageId?: string; notifierId: string; userId: string; type: string; description?: string; extendedData?: Record<string, any> }): Create a notification manually.retrieve(id: string): Get a notification.update(id: string, payload: { read: boolean }): Update a notification.delete(id: string): Delete a notification.client.search)search(params: { query: string; type: 'threads' | 'posts' | 'users' | 'tags'; cursor?: string }): Polymorphic search.client.webhooks)list(): List webhooks.create(payload: { name: string; url: string; events: string[] }): Create a webhook.retrieve(id: string): Get a webhook.update(id: string, payload: any): Update a webhook.delete(id: string): Delete a webhook.getDeliveries(id: string, params: { cursor?: string }): Get webhook delivery history.client.stats)get(params?: { filter?: string; threadCursor?: string; postCursor?: string; ... }): Get instance statistics.client.integrations)list(): Get all configured integrations.create(payload: { type: 'SLACK' | 'DISCORD' | 'SALESFORCE' | 'HUBSPOT' | 'OKTA' | 'AUTH0'; name: string; config: any }): Configure an integration (Slack, Discord, etc.).retrieve(id: string): Get integration details.delete(id: string): Remove an integration.client.privateMessages)list(params?: { query?: string; userId?: string; filter?: 'newest' | 'oldest'; cursor?: string }): List private messages.create(payload: { title?: string; body: string; recipientId: string; senderId?: string; extendedData?: Record<string, any> }): Send a direct message.retrieve(id: string): Get a message thread.reply(id: string, payload: { body: string; senderId: string; recipientId: string; extendedData?: Record<string, any> }): Reply to a message.delete(id: string): Delete a message.client.reports)list(params?: { reporterId?: string; reportedId?: string; read?: boolean; cursor?: string; filter?: 'newest' | 'oldest' }): List reports.create(payload: { reporterId: string; reportedId?: string; threadId?: string; postId?: string; privateMessageId?: string; type?: string; description?: string; extendedData?: Record<string, any> }): Submit a report.batchUpdate(payload: { reportIds: string[]; read: boolean }): Bulk update status.retrieve(id: string): Get a report.update(id: string, payload: { threadId?: string; postId?: string; privateMessageId?: string; reportedId?: string; reporterId?: string; type?: string; description?: string; read?: boolean; extendedData?: Record<string, any> }): Update report details.delete(id: string): Delete a report.updateStatus(id: string, read: boolean): Update read status of a report.client.roles)list(params?: { filter?: 'newest' | 'oldest'; cursor?: string }): List user roles.create(payload: { name: string; description?: string; color?: string; extendedData?: Record<string, any> }): Create a new role.retrieve(id: string): Get a role.update(id: string, payload: { name?: string; description?: string; color?: string; extendedData?: Record<string, any> }): Update a role.delete(id: string): Delete a role.client.sso)list(): List SSO providers.create(payload: { provider: 'OKTA' | 'AUTH0' | 'SAML'; domain: string; config: any }): Configure SSO.delete(id: string): Remove SSO provider.Import all available interfaces and types directly from the package:
import {
// Auth Types
RegisterPayload,
User,
LoginResponse,
// Thread Types
Thread,
CreateThreadPayload,
UpdateThreadPayload,
ThreadListResponse,
ThreadFilter,
// Post Types
Post,
CreatePostPayload,
UpdatePostPayload,
PostListResponse,
// Tag Types
Tag,
TagListResponse,
// User Types
UserListResponse,
// Notification Types
Notification,
NotificationListResponse,
// Search Types
SearchResponse,
// Webhook Types
Webhook,
WebhookListResponse,
// Stats Types
StatsResponse,
// Integration Types
Integration,
IntegrationListResponse,
// Private Message Types
PrivateMessage,
PrivateMessageListResponse,
// Report Types
Report,
ReportListResponse,
// Role Types
Role,
RoleListResponse,
// SSO Types
SSOProvider,
SSOProviderListResponse,
// Utility Types
PaginatedResponse,
InteractionType
} from '@foru-ms/sdk';All methods return a Promise. If the API returns a non-200 status, the Promise rejects with an Error object containing the server message.
try {
await client.threads.create({ ... });
} catch (err: any) {
console.error("Error creating thread:", err.message);
}MIT