magicbell-js 1.3.0 → 1.4.0

package/src/project-client/http/handlers/retry-handler.ts

@@ -45,7 +45,10 @@ export class RetryHandler implements RequestHandler {
   }
 
   private shouldRetry(error: Error): boolean {
-    return error instanceof HttpError && (error.metadata.status >= 500 || error.metadata.status === 408);
+    return (
+      error instanceof HttpError &&
+      (error.metadata.status >= 500 || error.metadata.status === 408 || error.metadata.status === 429)
+    );
   }
 
   private delay(delayMs: number | undefined): Promise<void> {

package/src/project-client/http/hooks/hook.ts

@@ -1,4 +1,4 @@
-type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS';
+type HttpMethod = 'CONNECT' | 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | 'TRACE';
 
 export interface HttpRequest {
   baseUrl: string;

package/src/project-client/http/serialization/query-serializer.ts

@@ -10,6 +10,11 @@ export class QuerySerializer extends Serializer {
     const query: string[] = [];
 
     queryParams.forEach((param) => {
+      // Skip parameters with undefined values
+      if (param.value === undefined) {
+        return;
+      }
+
       return query.push(`${this.serializeValue(param)}`);
     });
 

package/src/project-client/http/transport/request-builder.ts

@@ -7,6 +7,7 @@ import { Request } from './request.js';
 import {
   CreateRequestParameters,
   ErrorDefinition,
+  RequestCursorPagination,
   RequestPagination,
   RequestParameter,
   ResponseDefinition,
@@ -101,11 +102,30 @@ export class RequestBuilder<Page extends unknown[] = unknown[]> {
     return this;
   }
 
+  setFilename(filename?: string): RequestBuilder<Page> {
+    if (filename !== undefined) {
+      this.params.filename = filename;
+    }
+    return this;
+  }
+
+  setFilenames(filenames?: string[]): RequestBuilder<Page> {
+    if (filenames !== undefined) {
+      this.params.filenames = filenames;
+    }
+    return this;
+  }
+
   setPagination(pagination: RequestPagination<Page>): RequestBuilder<Page> {
     this.params.pagination = pagination;
     return this;
   }
 
+  setCursorPagination(pagination: RequestCursorPagination<Page>): RequestBuilder<Page> {
+    this.params.pagination = pagination;
+    return this;
+  }
+
   addAccessTokenAuth(accessToken?: string, prefix?: string): RequestBuilder<Page> {
     if (accessToken === undefined) {
       return this;
@@ -119,6 +139,7 @@ export class RequestBuilder<Page extends unknown[] = unknown[]> {
       encode: true,
       isLimit: false,
       isOffset: false,
+      isCursor: false,
     });
     return this;
   }
@@ -136,6 +157,7 @@ export class RequestBuilder<Page extends unknown[] = unknown[]> {
       encode: true,
       isLimit: false,
       isOffset: false,
+      isCursor: false,
     });
     return this;
   }
@@ -153,6 +175,7 @@ export class RequestBuilder<Page extends unknown[] = unknown[]> {
       encode: true,
       isLimit: false,
       isOffset: false,
+      isCursor: false,
     });
     return this;
   }
@@ -187,13 +210,14 @@ export class RequestBuilder<Page extends unknown[] = unknown[]> {
       encode: param.encode ?? true,
       isLimit: !!param.isLimit,
       isOffset: !!param.isOffset,
+      isCursor: !!param.isCursor,
     });
 
     return this;
   }
 
   addQueryParam(param: Partial<RequestParameter>): RequestBuilder<Page> {
-    if (param.value === undefined || param.key === undefined) {
+    if (param.key === undefined) {
       return this;
     }
 
@@ -205,6 +229,7 @@ export class RequestBuilder<Page extends unknown[] = unknown[]> {
       encode: param.encode ?? true,
       isLimit: !!param.isLimit,
       isOffset: !!param.isOffset,
+      isCursor: !!param.isCursor,
     });
 
     return this;
@@ -223,6 +248,7 @@ export class RequestBuilder<Page extends unknown[] = unknown[]> {
       encode: param.encode ?? false,
       isLimit: !!param.isLimit,
       isOffset: !!param.isOffset,
+      isCursor: !!param.isCursor,
     });
 
     return this;

package/src/project-client/http/transport/request-fetch-adapter.ts

@@ -65,7 +65,7 @@ export class RequestFetchAdapter<T> implements HttpAdapter {
       for (const line of lineDecoder.splitLines(value)) {
         yield {
           metadata,
-          raw: line,
+          raw: this.toArrayBuffer(line),
         };
       }
     }
@@ -73,7 +73,7 @@ export class RequestFetchAdapter<T> implements HttpAdapter {
     for (const line of lineDecoder.flush()) {
       yield {
         metadata,
-        raw: line,
+        raw: this.toArrayBuffer(line),
       };
     }
   }
@@ -128,4 +128,8 @@ export class RequestFetchAdapter<T> implements HttpAdapter {
 
     return headers;
   }
+
+  private toArrayBuffer(uint8Array: Uint8Array): ArrayBuffer {
+    return uint8Array.buffer.slice(uint8Array.byteOffset, uint8Array.byteOffset + uint8Array.byteLength);
+  }
 }

package/src/project-client/http/transport/request.ts

@@ -9,6 +9,8 @@ import { ContentType, HttpMethod, RetryOptions, SdkConfig, ValidationOptions } f
 import {
   CreateRequestParameters,
   ErrorDefinition,
+  isRequestCursorPagination,
+  RequestCursorPagination,
   RequestPagination,
   RequestParameter,
   ResponseDefinition,
@@ -43,7 +45,11 @@ export class Request<PageSchema = unknown[]> {
 
   public retry: RetryOptions = {} as any;
 
-  public pagination?: RequestPagination<PageSchema>;
+  public pagination?: RequestPagination<PageSchema> | RequestCursorPagination<PageSchema>;
+
+  public filename?: string;
+
+  public filenames?: string[];
 
   private readonly pathPattern: string;
 
@@ -64,6 +70,8 @@ export class Request<PageSchema = unknown[]> {
     this.retry = params.retry;
     this.validation = params.validation;
     this.pagination = params.pagination;
+    this.filename = params.filename;
+    this.filenames = params.filenames;
   }
 
   addHeaderParam(key: string, param: RequestParameter): void {
@@ -165,6 +173,8 @@ export class Request<PageSchema = unknown[]> {
       requestContentType: overrides?.requestContentType ?? this.requestContentType,
       retry: overrides?.retry ?? this.retry,
       validation: overrides?.validation ?? this.validation,
+      filename: overrides?.filename ?? this.filename,
+      filenames: overrides?.filenames ?? this.filenames,
     };
     return new Request({
       ...createRequestParams,
@@ -180,17 +190,28 @@ export class Request<PageSchema = unknown[]> {
     return new HeaderSerializer().serialize(this.headers);
   }
 
-  public nextPage(): void {
+  public nextPage(cursor?: string): void {
     if (!this.pagination) {
       return;
     }
 
-    const offsetParam = this.getOffsetParam();
-    if (!offsetParam) {
+    // Check if this is cursor pagination using type guard
+    if (isRequestCursorPagination(this.pagination)) {
+      const cursorParam = this.getCursorParam();
+      if (cursorParam && cursor !== undefined) {
+        cursorParam.value = cursor;
+      }
       return;
     }
 
-    offsetParam.value = Number(offsetParam.value) + this.pagination.pageSize;
+    // Handle limit-offset pagination
+    const offsetParam = this.getOffsetParam();
+    if (offsetParam) {
+      if (this.pagination.pageSize === undefined) {
+        throw new Error('pageSize is required for limit-offset pagination');
+      }
+      offsetParam.value = Number(offsetParam.value) + this.pagination.pageSize;
+    }
   }
 
   private constructPath(): string {
@@ -202,6 +223,11 @@ export class Request<PageSchema = unknown[]> {
     return offsetParam;
   }
 
+  private getCursorParam(): RequestParameter | undefined {
+    const cursorParam = this.getAllParams().find((param) => param.isCursor);
+    return cursorParam;
+  }
+
   private getAllParams(): RequestParameter[] {
     const allParams: RequestParameter[] = [];
 

package/src/project-client/http/transport/transport-hook-adapter.ts

@@ -84,6 +84,7 @@ export class TransportHookAdapter<T> {
         explode: requestParam?.explode ?? false,
         isLimit: requestParam?.isLimit ?? false,
         isOffset: requestParam?.isOffset ?? false,
+        isCursor: requestParam?.isCursor ?? false,
       });
     });
     return transportParams;

package/src/project-client/http/transport/types.ts

@@ -31,7 +31,9 @@ export interface CreateRequestParameters<Page = unknown[]> {
   requestContentType: ContentType;
   validation: ValidationOptions;
   retry: RetryOptions;
-  pagination?: RequestPagination<Page>;
+  pagination?: RequestPagination<Page> | RequestCursorPagination<Page>;
+  filename?: string;
+  filenames?: string[];
 }
 
 export interface RequestParameter {
@@ -42,10 +44,24 @@ export interface RequestParameter {
   style: SerializationStyle;
   isLimit: boolean;
   isOffset: boolean;
+  isCursor: boolean;
 }
 
 export interface RequestPagination<Page> {
-  pageSize: number;
+  pageSize?: number;
   pagePath: string[];
   pageSchema?: ZodType<Page, any, any>;
 }
+
+export interface RequestCursorPagination<Page> {
+  pagePath: string[];
+  pageSchema?: ZodType<Page, any, any>;
+  cursorPath: string[];
+  cursorSchema?: ZodType<string | null | undefined>;
+}
+
+export function isRequestCursorPagination<Page>(
+  pagination: RequestPagination<Page> | RequestCursorPagination<Page> | undefined,
+): pagination is RequestCursorPagination<Page> {
+  return !!pagination && 'cursorPath' in pagination;
+}

package/src/project-client/http/types.ts

@@ -3,7 +3,7 @@ import { ZodType } from 'zod';
 import { Environment } from './environment.js';
 import { Request } from './transport/request.js';
 
-export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS';
+export type HttpMethod = 'CONNECT' | 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | 'TRACE';
 
 export interface SdkConfig {
   baseUrl?: string;
@@ -26,6 +26,14 @@ export interface HttpResponse<T = unknown> {
   raw: ArrayBuffer;
 }
 
+export interface PaginatedHttpResponse<T = unknown> extends HttpResponse<T> {
+  // Marker interface for pagination responses
+}
+
+export interface CursorPaginatedHttpResponse<T = unknown> extends HttpResponse<T> {
+  nextCursor?: string | null;
+}
+
 export interface RequestHandler {
   next?: RequestHandler;
 

package/src/project-client/http/utils/content-type.ts

@@ -1,33 +1,50 @@
 import { ContentType } from '../types.js';
 
 export function getContentTypeDefinition(contentType: string): ContentType {
-  if (contentType.startsWith('application/') && contentType.includes('xml')) {
+  const ct = contentType.toLowerCase();
+
+  if (ct.startsWith('application/') && ct.includes('xml')) {
     return ContentType.Xml;
   }
 
-  if (contentType.toLowerCase() === 'application/x-www-form-urlencoded') {
+  if (ct === 'application/x-www-form-urlencoded') {
     return ContentType.FormUrlEncoded;
   }
 
-  if (contentType.toLowerCase() === 'text/event-stream') {
+  if (ct === 'text/event-stream') {
     return ContentType.EventStream;
   }
 
-  if (contentType.toLowerCase().startsWith('text/')) {
+  // Check for JSON content types (including text/json) before text types
+  if (ct === 'application/json' || ct === 'text/json' || ct.includes('+json')) {
+    return ContentType.Json;
+  }
+
+  if (ct === 'application/javascript') {
+    return ContentType.Text;
+  }
+
+  if (ct.startsWith('text/')) {
+    return ContentType.Text;
+  }
+
+  // SVG is text-based XML, not binary
+  if (ct === 'image/svg+xml') {
     return ContentType.Text;
   }
 
-  if (contentType.toLowerCase().startsWith('image/')) {
+  if (ct.startsWith('image/')) {
     return ContentType.Image;
   }
 
-  if (contentType.toLowerCase() === 'application/octet-stream') {
+  if (ct === 'application/octet-stream' || ct === 'application/pdf') {
     return ContentType.Binary;
   }
 
-  if (contentType.toLowerCase() === 'application/json') {
-    return ContentType.Json;
+  // Wildcard content type
+  if (ct === '*/*') {
+    return ContentType.Binary;
   }
 
-  return ContentType.Json;
+  return ContentType.Binary;
 }

package/src/project-client/index.ts

@@ -5,6 +5,7 @@ import { ChannelsService } from './services/channels/index.js';
 import { EventsService } from './services/events/index.js';
 import { IntegrationsService } from './services/integrations/index.js';
 import { UsersService } from './services/users/index.js';
+import { WorkflowsService } from './services/workflows/index.js';
 
 export { Environment } from './http/environment.js';
 export * from './http/index.js';
@@ -14,6 +15,7 @@ export * from './services/common/index.js';
 export * from './services/events/index.js';
 export * from './services/integrations/index.js';
 export * from './services/users/index.js';
+export * from './services/workflows/index.js';
 
 export class Client {
   public readonly broadcasts: BroadcastsService;
@@ -26,6 +28,8 @@ export class Client {
 
   public readonly users: UsersService;
 
+  public readonly workflows: WorkflowsService;
+
   constructor(public config: SdkConfig) {
     this.broadcasts = new BroadcastsService(this.config);
 
@@ -36,6 +40,8 @@ export class Client {
     this.integrations = new IntegrationsService(this.config);
 
     this.users = new UsersService(this.config);
+
+    this.workflows = new WorkflowsService(this.config);
   }
 
   set baseUrl(baseUrl: string) {
@@ -44,6 +50,7 @@ export class Client {
     this.events.baseUrl = baseUrl;
     this.integrations.baseUrl = baseUrl;
     this.users.baseUrl = baseUrl;
+    this.workflows.baseUrl = baseUrl;
   }
 
   set environment(environment: Environment) {
@@ -52,6 +59,7 @@ export class Client {
     this.events.baseUrl = environment;
     this.integrations.baseUrl = environment;
     this.users.baseUrl = environment;
+    this.workflows.baseUrl = environment;
   }
 
   set timeoutMs(timeoutMs: number) {
@@ -60,6 +68,7 @@ export class Client {
     this.events.timeoutMs = timeoutMs;
     this.integrations.timeoutMs = timeoutMs;
     this.users.timeoutMs = timeoutMs;
+    this.workflows.timeoutMs = timeoutMs;
   }
 
   set token(token: string) {
@@ -68,6 +77,7 @@ export class Client {
     this.events.token = token;
     this.integrations.token = token;
     this.users.token = token;
+    this.workflows.token = token;
   }
 }
 

package/src/project-client/services/broadcasts/broadcasts-service.ts

@@ -16,8 +16,8 @@ export class BroadcastsService extends BaseService {
    * @param {number} [params.limit] -
    * @param {string} [params.startingAfter] -
    * @param {string} [params.endingBefore] -
-   * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
-   * @returns {Promise<HttpResponse<BroadcastCollection>>} OK
+   * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
+   * @returns {Promise<HttpResponse<BroadcastCollection>>} - OK
    */
   async listBroadcasts(
     params?: ListBroadcastsParams,
@@ -57,8 +57,8 @@ export class BroadcastsService extends BaseService {
 
   /**
    * Creates a new broadcast. When a broadcast is created, it generates individual notifications for relevant users within the project.
-   * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
-   * @returns {Promise<HttpResponse<Broadcast>>} Created
+   * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
+   * @returns {Promise<HttpResponse<Broadcast>>} - Created
    */
   async createBroadcast(body: Broadcast, requestConfig?: RequestConfig): Promise<HttpResponse<Broadcast>> {
     const request = new RequestBuilder()
@@ -86,8 +86,8 @@ export class BroadcastsService extends BaseService {
   /**
    * Retrieves detailed information about a specific broadcast by its ID. Includes the broadcast's configuration and current status.
    * @param {string} broadcastId -
-   * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
-   * @returns {Promise<HttpResponse<Broadcast>>} OK
+   * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
+   * @returns {Promise<HttpResponse<Broadcast>>} - OK
    */
   async fetchBroadcast(broadcastId: string, requestConfig?: RequestConfig): Promise<HttpResponse<Broadcast>> {
     const request = new RequestBuilder()