rocketchat-ts-sdk 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 RocketChat SDK
+
+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

@@ -0,0 +1,342 @@
+# RocketChat SDK
+
+A comprehensive TypeScript SDK for the RocketChat API, providing easy-to-use methods for interacting with RocketChat servers.
+
+## Features
+
+- 🚀 **Full TypeScript support** with comprehensive type definitions
+- 📦 **Modular architecture** with organized resource classes
+- 🔐 **Authentication handling** with automatic token management
+- 🌐 **HTTP client abstraction** built on Axios
+- 📚 **Complete API coverage** for channels, groups, direct messages, users, and chat
+- 🛠️ **Built-in error handling** with structured response types
+- 📖 **Extensive documentation** with code examples
+
+## Installation
+
+```bash
+npm install rocketchat-sdk
+# or
+yarn add rocketchat-sdk
+# or
+pnpm add rocketchat-sdk
+```
+
+## Quick Start
+
+### Basic Setup
+
+```typescript
+import { RocketChatSDK } from "rocketchat-sdk";
+
+const rocketChat = new RocketChatSDK({
+  baseUrl: "https://your-rocketchat-server.com",
+  username: "your-username",
+  password: "your-password",
+});
+
+// Login
+const loginResult = await rocketChat.login();
+if (loginResult.success) {
+  console.log("Logged in successfully!");
+}
+```
+
+### Using Auth Token
+
+```typescript
+const rocketChat = new RocketChatSDK({
+  baseUrl: "https://your-rocketchat-server.com",
+  userId: "your-user-id",
+  authToken: "your-auth-token",
+});
+```
+
+## API Reference
+
+### Chat Operations
+
+#### Send a Message
+
+```typescript
+const result = await rocketChat.chat.postMessage(
+  "roomId",
+  "Hello, World!",
+  "BotAlias", // optional alias
+  "🚀", // optional emoji
+  "avatar-url", // optional avatar
+);
+
+if (result.success) {
+  console.log("Message sent:", result.data.message);
+}
+```
+
+#### Update a Message
+
+```typescript
+await rocketChat.chat.update("roomId", "messageId", "Updated message text");
+```
+
+#### Delete a Message
+
+```typescript
+await rocketChat.chat.delete("roomId", "messageId");
+```
+
+#### React to a Message
+
+```typescript
+await rocketChat.chat.react("messageId", "👍", true); // add reaction
+await rocketChat.chat.react("messageId", "👍", false); // remove reaction
+```
+
+### Channel Operations
+
+#### Create a Channel
+
+```typescript
+const result = await rocketChat.channels.create(
+  "general-discussion",
+  ["user1", "user2"], // optional members
+  false, // readOnly flag
+);
+```
+
+#### Get Channel Info
+
+```typescript
+const info = await rocketChat.channels.info("channelId");
+// or by name
+const info = await rocketChat.channels.info(undefined, "general");
+```
+
+#### Join a Channel
+
+```typescript
+await rocketChat.channels.join("channelId");
+// or by name
+await rocketChat.channels.join(undefined, "general");
+```
+
+#### List All Channels
+
+```typescript
+const channels = await rocketChat.channels.list(0, 50); // offset, count
+```
+
+#### Invite User to Channel
+
+```typescript
+await rocketChat.channels.invite("channelId", "userId");
+```
+
+### Group Operations
+
+#### Create a Private Group
+
+```typescript
+const result = await rocketChat.groups.create(
+  "private-team",
+  ["user1", "user2"],
+  false, // readOnly
+);
+```
+
+#### Get Group Members
+
+```typescript
+const members = await rocketChat.groups.members("groupId");
+```
+
+### Direct Message Operations
+
+#### Create Direct Message
+
+```typescript
+const dm = await rocketChat.dm.create("username");
+```
+
+#### Get DM History
+
+```typescript
+const history = await rocketChat.dm.history(
+  "roomId",
+  new Date(), // latest
+  undefined, // oldest
+  true, // inclusive
+  0, // offset
+  20, // count
+);
+```
+
+### User Operations
+
+#### Get User Info
+
+```typescript
+const user = await rocketChat.users.info("userId");
+// or by username
+const user = await rocketChat.users.info(undefined, "john.doe");
+```
+
+#### Create User
+
+```typescript
+const newUser = await rocketChat.users.create(
+  "john.doe", // username
+  "john@example.com", // email
+  "securePassword123", // password
+  "John Doe", // name
+  true, // active
+  ["user"], // roles
+  true, // joinDefaultChannels
+  false, // requirePasswordChange
+);
+```
+
+#### Set User Status
+
+```typescript
+await rocketChat.users.setStatus("Working on awesome features!", "busy");
+```
+
+#### List All Users
+
+```typescript
+const users = await rocketChat.users.list(0, 50);
+```
+
+## Configuration Options
+
+```typescript
+interface RocketChatConfig {
+  baseUrl: string; // RocketChat server URL
+  userId?: string; // User ID (for token auth)
+  authToken?: string; // Auth token (for token auth)
+  username?: string; // Username (for password auth)
+  password?: string; // Password (for password auth)
+}
+```
+
+## Response Format
+
+All API methods return a standardized response format:
+
+```typescript
+interface RocketChatResponse<T = any> {
+  success: boolean;
+  data?: T;
+  error?: string;
+  errorType?: string;
+}
+```
+
+### Handling Responses
+
+```typescript
+const result = await rocketChat.chat.postMessage("roomId", "Hello!");
+
+if (result.success) {
+  // Success case
+  console.log("Message:", result.data.message);
+} else {
+  // Error case
+  console.error("Error:", result.error);
+}
+```
+
+## Error Handling
+
+The SDK provides comprehensive error handling:
+
+```typescript
+try {
+  const result = await rocketChat.channels.create("test-channel");
+  if (!result.success) {
+    console.error("Failed to create channel:", result.error);
+  }
+} catch (error) {
+  console.error("Network or unexpected error:", error);
+}
+```
+
+## Advanced Usage
+
+### Direct Client Access
+
+For advanced use cases, you can access the underlying HTTP client:
+
+```typescript
+const client = rocketChat.getClient();
+const customResult = await client.get("/custom-endpoint");
+```
+
+### Custom Headers and Configuration
+
+The SDK uses Axios internally. You can extend functionality by accessing the client:
+
+```typescript
+const client = rocketChat.getClient();
+// Add custom interceptors, headers, etc.
+```
+
+## TypeScript Support
+
+The SDK is built with TypeScript and provides comprehensive type definitions:
+
+```typescript
+import {
+  RocketChatSDK,
+  RocketChatConfig,
+  Channel,
+  Message,
+  User,
+} from "rocketchat-sdk";
+
+// All types are fully typed
+const config: RocketChatConfig = {
+  baseUrl: "https://chat.example.com",
+  username: "admin",
+  password: "password",
+};
+
+const sdk = new RocketChatSDK(config);
+```
+
+## Building from Source
+
+1. Clone the repository
+2. Install dependencies: `npm install`
+3. Build: `npm run build`
+4. Test: `npm test`
+5. Lint: `npm run lint`
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Add tests
+5. Run the linter and tests
+6. Submit a pull request
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file for details.
+
+## Support
+
+- 📖 [API Documentation](https://developer.rocket.chat/reference/api)
+- 🐛 [Report Issues](https://github.com/yourusername/rocketchat-sdk/issues)
+- 💬 [Discussions](https://github.com/yourusername/rocketchat-sdk/discussions)
+
+## Changelog
+
+### v1.0.0
+
+- Initial release
+- Full TypeScript support
+- Complete API coverage for core features
+- Authentication handling
+- Comprehensive error handling

package/dist/client.d.ts

@@ -0,0 +1,17 @@
+import { RocketChatConfig, RocketChatResponse } from "./types";
+export declare class RocketChatClient {
+    private api;
+    private config;
+    constructor(config: RocketChatConfig);
+    login(username?: string, password?: string): Promise<RocketChatResponse<{
+        authToken: string;
+        userId: string;
+        me: any;
+    }>>;
+    logout(): Promise<RocketChatResponse>;
+    get<T = any>(endpoint: string, params?: Record<string, any>): Promise<RocketChatResponse<T>>;
+    post<T = any>(endpoint: string, data?: any): Promise<RocketChatResponse<T>>;
+    put<T = any>(endpoint: string, data?: any): Promise<RocketChatResponse<T>>;
+    delete<T = any>(endpoint: string): Promise<RocketChatResponse<T>>;
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAE/D,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,GAAG,CAAgB;IAC3B,OAAO,CAAC,MAAM,CAAmB;gBAErB,MAAM,EAAE,gBAAgB;IAmB9B,KAAK,CACT,QAAQ,CAAC,EAAE,MAAM,EACjB,QAAQ,CAAC,EAAE,MAAM,GAChB,OAAO,CACR,kBAAkB,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,GAAG,CAAA;KAAE,CAAC,CACnE;IA+BK,MAAM,IAAI,OAAO,CAAC,kBAAkB,CAAC;IAerC,GAAG,CAAC,CAAC,GAAG,GAAG,EACf,QAAQ,EAAE,MAAM,EAChB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC3B,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;IAe3B,IAAI,CAAC,CAAC,GAAG,GAAG,EAChB,QAAQ,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,GAAG,GACT,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;IAe3B,GAAG,CAAC,CAAC,GAAG,GAAG,EACf,QAAQ,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,GAAG,GACT,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;IAe3B,MAAM,CAAC,CAAC,GAAG,GAAG,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;CAcxE"}

package/dist/index.d.ts

@@ -0,0 +1,40 @@
+import { RocketChatClient } from "./client";
+import { RocketChatConfig } from "./types";
+import { ChannelResource } from "./resources/channelResource";
+import { ChatResource } from "./resources/chatResource";
+import { DirectMessageResource } from "./resources/dmResource";
+import { GroupResource } from "./resources/groupResource";
+import { UserResource } from "./resources/userResource";
+export declare class RocketChatSDK {
+    private client;
+    channels: ChannelResource;
+    chat: ChatResource;
+    dm: DirectMessageResource;
+    groups: GroupResource;
+    users: UserResource;
+    constructor(config: RocketChatConfig);
+    /**
+     * Login to RocketChat
+     */
+    login(username?: string, password?: string): Promise<import("./types").RocketChatResponse<{
+        authToken: string;
+        userId: string;
+        me: any;
+    }>>;
+    /**
+     * Logout from RocketChat
+     */
+    logout(): Promise<import("./types").RocketChatResponse<any>>;
+    /**
+     * Get the underlying client for direct API access
+     */
+    getClient(): RocketChatClient;
+}
+export * from "./types";
+export { RocketChatClient } from "./client";
+export { ChannelResource } from "./resources/channelResource";
+export { ChatResource } from "./resources/chatResource";
+export { DirectMessageResource } from "./resources/dmResource";
+export { GroupResource } from "./resources/groupResource";
+export { UserResource } from "./resources/userResource";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAC5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAExD,qBAAa,aAAa;IACxB,OAAO,CAAC,MAAM,CAAmB;IAC1B,QAAQ,EAAE,eAAe,CAAC;IAC1B,IAAI,EAAE,YAAY,CAAC;IACnB,EAAE,EAAE,qBAAqB,CAAC;IAC1B,MAAM,EAAE,aAAa,CAAC;IACtB,KAAK,EAAE,YAAY,CAAC;gBAEf,MAAM,EAAE,gBAAgB;IASpC;;OAEG;IACG,KAAK,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM;;;;;IAIhD;;OAEG;IACG,MAAM;IAIZ;;OAEG;IACH,SAAS;CAGV;AAGD,cAAc,SAAS,CAAC;AACxB,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAC5C,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC"}