rocketchat-ts-sdk 1.2.9 → 1.4.0

package/README.md

@@ -15,11 +15,11 @@ A comprehensive TypeScript SDK for the RocketChat API, providing easy-to-use met
 ## Installation
 
 ```bash
-npm install rocketchat-sdk
+npm install rocketchat-ts-sdk
 # or
-yarn add rocketchat-sdk
+yarn add rocketchat-ts-sdk
 # or
-pnpm add rocketchat-sdk
+pnpm add rocketchat-ts-sdk
 ```
 
 ## Quick Start
@@ -27,7 +27,7 @@ pnpm add rocketchat-sdk
 ### Basic Setup
 
 ```typescript
-import { RocketChatSDK } from "rocketchat-sdk";
+import { RocketChatSDK } from "rocketchat-ts-sdk";
 
 const rocketChat = new RocketChatSDK({
   baseUrl: "https://your-rocketchat-server.com",
@@ -281,6 +281,35 @@ const client = rocketChat.getClient();
 // Add custom interceptors, headers, etc.
 ```
 
+### Request Cancellation with AbortSignal
+
+You can cancel requests using the optional `signal` parameter with AbortController:
+
+```typescript
+// Create an AbortController
+const controller = new AbortController();
+const { signal } = controller;
+
+// Use the signal with any API method
+const messagePromise = rocketChat.chat.getMessage(
+  { msgId: "message-id" },
+  {}, // custom headers
+  signal, // optional AbortSignal
+);
+
+// Cancel the request if needed
+controller.abort();
+
+// The promise will reject with an AbortError
+try {
+  const result = await messagePromise;
+} catch (error) {
+  if (error.name === "AbortError") {
+    console.log("Request was cancelled");
+  }
+}
+```
+
 ## TypeScript Support
 
 The SDK is built with TypeScript and provides comprehensive type definitions:
@@ -328,8 +357,8 @@ 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)
+- 🐛 [Report Issues](https://github.com/rakify/rocketchat-ts-sdk/issues)
+- 💬 [Discussions](https://github.com/rakify/rocketchat-ts-sdk/discussions)
 
 ## Changelog
 

package/dist/client.d.ts

@@ -14,6 +14,6 @@ export declare class RocketChatClient {
     post<T = any>(endpoint: string, data?: any, headers?: Record<string, string>): Promise<RocketChatResponse<T>>;
     put<T = any>(endpoint: string, data?: any, headers?: Record<string, string>): Promise<RocketChatResponse<T>>;
     delete<T = any>(endpoint: string, headers?: Record<string, string>): Promise<RocketChatResponse<T>>;
-    request<T = any>(method: Method, endpoint: string, data?: any, params?: Record<string, any>, headers?: Record<string, string>, isMultipart?: boolean): Promise<RocketChatResponse<T>>;
+    request<T = any>(method: Method, endpoint: string, data?: any, params?: Record<string, any>, headers?: Record<string, string>, isMultipart?: boolean, signal?: AbortSignal): Promise<RocketChatResponse<T>>;
 }
 //# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAc,EAAqC,MAAM,EAAE,MAAM,OAAO,CAAC;AACzE,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,EAC5B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;IAe3B,IAAI,CAAC,CAAC,GAAG,GAAG,EAChB,QAAQ,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,GAAG,EACV,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;IAe3B,GAAG,CAAC,CAAC,GAAG,GAAG,EACf,QAAQ,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,GAAG,EACV,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;IAe3B,MAAM,CAAC,CAAC,GAAG,GAAG,EAClB,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;IAe3B,OAAO,CAAC,CAAC,GAAG,GAAG,EACnB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,GAAG,EACV,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC5B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAChC,WAAW,CAAC,EAAE,OAAO,GACpB,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;CA6BlC"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAc,EAAqC,MAAM,EAAE,MAAM,OAAO,CAAC;AACzE,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,EAC5B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;IAe3B,IAAI,CAAC,CAAC,GAAG,GAAG,EAChB,QAAQ,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,GAAG,EACV,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;IAe3B,GAAG,CAAC,CAAC,GAAG,GAAG,EACf,QAAQ,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,GAAG,EACV,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;IAe3B,MAAM,CAAC,CAAC,GAAG,GAAG,EAClB,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;IAe3B,OAAO,CAAC,CAAC,GAAG,GAAG,EACnB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,GAAG,EACV,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC5B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAChC,WAAW,CAAC,EAAE,OAAO,EACrB,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;CA8BlC"}