@foru-ms/sdk 0.2.0 → 1.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Foru.ms
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -2,6 +2,8 @@
 
 The official JavaScript/TypeScript SDK for [Foru.ms](https://foru.ms). Build powerful community features directly into your application.
 
+This SDK is fully typed and provides a comprehensive interface to the Foru.ms API.
+
 ## Installation
 
 ```bash
@@ -12,130 +14,235 @@ yarn add @foru-ms/sdk
 pnpm add @foru-ms/sdk
 ```
 
-## Getting Started
-
-Initialize the client with your API key. You can find your API key in the Foru.ms dashboard.
+## Setup & Initialization
 
 ```typescript
 import { ForumClient } from '@foru-ms/sdk';
 
 const client = new ForumClient({
   apiKey: 'your_api_key',
-  // baseUrl: 'https://api.foru.ms/v1' // Optional, defaults to production URL
+  // baseUrl: 'https://api.foru.ms/v1' // Optional
 });
-```
-
-## Authentication
-
-Identify the current user to perform actions on their behalf. Use `authToken` obtained via login or your own auth provider integration.
-
-```typescript
-// Login with username/password
-const { token } = await client.auth.login({
-  login: 'username',
-  password: 'password'
-});
-
-// Or set an existing token
-client.setToken(token);
 
-// Get current user details
-const me = await client.auth.me();
+// Set an authentication token (JWT) for user-scoped requests
+client.setToken('user_jwt_token');
 ```
 
-## Usage Examples
+## API Reference
+
+### Auth (`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.
+
+### 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.
+*   `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.
+
+### Posts (`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.
+
+### Users (`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.
+
+
+### Tags (`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.
+
+
+### Notifications (`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; notifiedId: 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.
+
+### Search (`client.search`)
+
+*   `search(params: { query: string; type: 'threads' | 'posts' | 'users' | 'tags'; cursor?: string })`: Polymorphic search.
+
+### Webhooks (`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.
+
+### Stats (`client.stats`)
+
+*   `get(params?: { filter?: string; threadCursor?: string; postCursor?: string; ... })`: Get instance statistics.
+
+### Integrations (`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.
+
+### Private Messages (`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.
+
+### Reports (`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.
 
-### Threads
+### Roles (`client.roles`)
 
-```typescript
-// List threads
-const { threads } = await client.threads.list({ 
-  limit: 10,
-  filter: 'newest' 
-});
-
-// Create a thread
-const newThread = await client.threads.create({
-  title: 'Hello World',
-  body: 'This is my first thread via the SDK!',
-  tags: ['introduction', 'general']
-});
+*   `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.
 
-// Interact with a thread
-await client.threads.like(newThread.id, currentUser.id);
-```
+### SSO (`client.sso`)
 
-### Posts (Replies)
+*   `list()`: List SSO providers.
+*   `create(payload: { provider: 'OKTA' | 'AUTH0' | 'SAML'; domain: string; config: any })`: Configure SSO.
+*   `delete(id: string)`: Remove SSO provider.
 
-```typescript
-// Reply to a thread
-const post = await client.posts.create({
-  threadId: 'thread_123',
-  body: 'Great discussion!'
-});
+## Types
 
-// Get replies for a post (threaded view)
-const { posts } = await client.posts.getChildren('post_123');
-```
-
-### Users & Social
-
-```typescript
-// Follow a user
-await client.users.follow('target_user_id', 'current_user_id');
-
-// Get user feed/followers
-const { followers } = await client.users.getFollowers('user_123');
-```
-
-### Real-time Notifications
-
-```typescript
-// Get notifications
-const { list } = await client.notifications.list({ userId: 'user_123' });
-
-// Mark as read
-await client.notifications.markAllAsRead('user_123');
-```
-
-## Resources
-
-The SDK covers the full Foru.ms API surface:
-
-*   `client.auth`: Authentication & Registration
-*   `client.threads`: Discussions & Polls
-*   `client.posts`: Replies & Nested Comments
-*   `client.users`: User Profiles & Social Graph
-*   `client.tags`: Categorization & Subscriptions
-*   `client.notifications`: Alerts & Activity
-*   `client.search`: Unified Search
-*   `client.webhooks`: Event Subscriptions
-*   `client.stats`: Community Analytics
-*   `client.integrations`: 3rd Party Connections (Slack, Discord, etc.)
-*   `client.privateMessages`: Direct Messaging
-*   `client.reports`: Moderation & Safety
-*   `client.roles`: Permission Management
-*   `client.sso`: Single Sign-On Configuration
-
-## TypeScript Support
-
-This SDK is written in TypeScript and provides complete type definitions for all requests and responses.
+Import all available interfaces and types directly from the package:
 
 ```typescript
-import { Thread, User } from '@foru-ms/sdk';
-
-const thread: Thread = await client.threads.retrieve('thread_123');
+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';
 ```
 
 ## Error Handling
 
-API errors throw standard JavaScript errors with messages from the server.
+All methods return a Promise. If the API returns a non-200 status, the Promise rejects with an Error object containing the server message.
 
 ```typescript
 try {
   await client.threads.create({ ... });
-} catch (error) {
-  console.error('API Error:', error.message);
+} catch (err: any) {
+  console.error("Error creating thread:", err.message);
 }
 ```
 

package/package.json

@@ -1,15 +1,28 @@
 {
     "name": "@foru-ms/sdk",
-    "version": "0.2.0",
+    "version": "1.1.1",
+    "description": "JavaScript SDK for Foru.ms",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "scripts": {
         "build": "tsc",
         "prepublishOnly": "npm run build"
     },
-    "keywords": [],
-    "author": "",
-    "license": "ISC",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/foru-ms/sdk.git"
+    },
+    "keywords": [
+        "forums",
+        "sdk",
+        "api",
+        "community",
+        "social",
+        "typescript",
+        "discussion"
+    ],
+    "author": "Foru.ms",
+    "license": "MIT",
     "dependencies": {
         "cross-fetch": "^3.1.5"
     },