@cstar.help/js 0.6.0 → 0.6.5

package/dist/chat/index.d.cts

@@ -134,6 +134,7 @@ interface CommunityCreatedPost {
     visibility: string;
     voteCount: number;
     commentCount: number;
+    customFields: Record<string, string>;
     topicName: string;
     topicSlug: string;
     authorName: string;

package/dist/chat/index.d.ts

@@ -134,6 +134,7 @@ interface CommunityCreatedPost {
     visibility: string;
     voteCount: number;
     commentCount: number;
+    customFields: Record<string, string>;
     topicName: string;
     topicSlug: string;
     authorName: string;

package/dist/community/index.d.cts

@@ -42,6 +42,7 @@ interface CommunityCreatedPost {
     visibility: string;
     voteCount: number;
     commentCount: number;
+    customFields: Record<string, string>;
     topicName: string;
     topicSlug: string;
     authorName: string;

package/dist/community/index.d.ts

@@ -42,6 +42,7 @@ interface CommunityCreatedPost {
     visibility: string;
     voteCount: number;
     commentCount: number;
+    customFields: Record<string, string>;
     topicName: string;
     topicSlug: string;
     authorName: string;

package/dist/index.cjs

@@ -292,7 +292,7 @@ var CStarRealtime = class {
     this.maxRetries = options?.maxRetries ?? 10;
     this.types = options?.types;
   }
-  /** Subscribe to a specific event type. Supports wildcards (e.g., 'ticket.*'). */
+  /** Subscribe to a specific event type. Supports wildcards (e.g., 'ticket.*'). Returns an unsubscribe function. */
   on(eventType, handler) {
     let set = this.handlers.get(eventType);
     if (!set) {
@@ -301,13 +301,17 @@ var CStarRealtime = class {
     }
     set.add(handler);
     this.ensureConnected();
-    return this;
+    return () => {
+      set.delete(handler);
+    };
   }
-  /** Subscribe to all events. */
+  /** Subscribe to all events. Returns an unsubscribe function. */
   onAny(handler) {
     this.anyHandlers.add(handler);
     this.ensureConnected();
-    return this;
+    return () => {
+      this.anyHandlers.delete(handler);
+    };
   }
   /** Handle connection errors. */
   onError(handler) {

package/dist/index.d.cts

@@ -94,10 +94,10 @@ declare class CStarRealtime {
     private readonly maxRetries;
     private readonly types;
     constructor(httpClient: HttpClient, options?: RealtimeOptions);
-    /** Subscribe to a specific event type. Supports wildcards (e.g., 'ticket.*'). */
-    on<T = unknown>(eventType: string, handler: EventHandler<T>): this;
-    /** Subscribe to all events. */
-    onAny<T = unknown>(handler: EventHandler<T>): this;
+    /** Subscribe to a specific event type. Supports wildcards (e.g., 'ticket.*'). Returns an unsubscribe function. */
+    on<T = unknown>(eventType: string, handler: EventHandler<T>): () => void;
+    /** Subscribe to all events. Returns an unsubscribe function. */
+    onAny<T = unknown>(handler: EventHandler<T>): () => void;
     /** Handle connection errors. */
     onError(handler: ErrorHandler): this;
     /** Handle connection state changes. */
@@ -846,6 +846,11 @@ interface CommunityAttachment {
     size_bytes: number;
     storage_path: string;
 }
+/** Custom field configuration entry for a topic. */
+interface TopicFieldConfigEntry {
+    fieldId: string;
+    required: boolean;
+}
 /** A community discussion topic (category/board). */
 interface CommunityTopic {
     id: string;
@@ -855,6 +860,7 @@ interface CommunityTopic {
     icon: string;
     visibility: 'public' | 'members_only';
     sortOrder: number;
+    customFieldConfig: TopicFieldConfigEntry[];
     postCount: number;
     createdAt: string;
 }
@@ -874,6 +880,7 @@ interface CommunityPost {
     isFeatured: boolean;
     isLocked: boolean;
     commentsEnabled: boolean;
+    customFields: Record<string, string>;
     attachments: CommunityAttachment[];
     authorName: string;
     lastActivityAt: string;
@@ -906,6 +913,7 @@ interface CommunityPostCreateParams {
     body?: string;
     topicId: string;
     visibility?: 'public' | 'members_only';
+    customFields?: Record<string, string>;
     attachments?: CommunityAttachment[];
 }
 /** Parameters for updating a community post. */
@@ -919,6 +927,7 @@ interface CommunityPostUpdateParams {
     isLocked?: boolean;
     isHidden?: boolean;
     commentsEnabled?: boolean;
+    customFields?: Record<string, string>;
     attachments?: CommunityAttachment[];
 }
 /** Parameters for creating a comment on a community post. */

package/dist/index.d.ts

@@ -94,10 +94,10 @@ declare class CStarRealtime {
     private readonly maxRetries;
     private readonly types;
     constructor(httpClient: HttpClient, options?: RealtimeOptions);
-    /** Subscribe to a specific event type. Supports wildcards (e.g., 'ticket.*'). */
-    on<T = unknown>(eventType: string, handler: EventHandler<T>): this;
-    /** Subscribe to all events. */
-    onAny<T = unknown>(handler: EventHandler<T>): this;
+    /** Subscribe to a specific event type. Supports wildcards (e.g., 'ticket.*'). Returns an unsubscribe function. */
+    on<T = unknown>(eventType: string, handler: EventHandler<T>): () => void;
+    /** Subscribe to all events. Returns an unsubscribe function. */
+    onAny<T = unknown>(handler: EventHandler<T>): () => void;
     /** Handle connection errors. */
     onError(handler: ErrorHandler): this;
     /** Handle connection state changes. */
@@ -846,6 +846,11 @@ interface CommunityAttachment {
     size_bytes: number;
     storage_path: string;
 }
+/** Custom field configuration entry for a topic. */
+interface TopicFieldConfigEntry {
+    fieldId: string;
+    required: boolean;
+}
 /** A community discussion topic (category/board). */
 interface CommunityTopic {
     id: string;
@@ -855,6 +860,7 @@ interface CommunityTopic {
     icon: string;
     visibility: 'public' | 'members_only';
     sortOrder: number;
+    customFieldConfig: TopicFieldConfigEntry[];
     postCount: number;
     createdAt: string;
 }
@@ -874,6 +880,7 @@ interface CommunityPost {
     isFeatured: boolean;
     isLocked: boolean;
     commentsEnabled: boolean;
+    customFields: Record<string, string>;
     attachments: CommunityAttachment[];
     authorName: string;
     lastActivityAt: string;
@@ -906,6 +913,7 @@ interface CommunityPostCreateParams {
     body?: string;
     topicId: string;
     visibility?: 'public' | 'members_only';
+    customFields?: Record<string, string>;
     attachments?: CommunityAttachment[];
 }
 /** Parameters for updating a community post. */
@@ -919,6 +927,7 @@ interface CommunityPostUpdateParams {
     isLocked?: boolean;
     isHidden?: boolean;
     commentsEnabled?: boolean;
+    customFields?: Record<string, string>;
     attachments?: CommunityAttachment[];
 }
 /** Parameters for creating a comment on a community post. */

package/dist/index.js

@@ -254,7 +254,7 @@ var CStarRealtime = class {
     this.maxRetries = options?.maxRetries ?? 10;
     this.types = options?.types;
   }
-  /** Subscribe to a specific event type. Supports wildcards (e.g., 'ticket.*'). */
+  /** Subscribe to a specific event type. Supports wildcards (e.g., 'ticket.*'). Returns an unsubscribe function. */
   on(eventType, handler) {
     let set = this.handlers.get(eventType);
     if (!set) {
@@ -263,13 +263,17 @@ var CStarRealtime = class {
     }
     set.add(handler);
     this.ensureConnected();
-    return this;
+    return () => {
+      set.delete(handler);
+    };
   }
-  /** Subscribe to all events. */
+  /** Subscribe to all events. Returns an unsubscribe function. */
   onAny(handler) {
     this.anyHandlers.add(handler);
     this.ensureConnected();
-    return this;
+    return () => {
+      this.anyHandlers.delete(handler);
+    };
   }
   /** Handle connection errors. */
   onError(handler) {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@cstar.help/js",
-	"version": "0.6.0",
+	"version": "0.6.5",
 	"description": "Official TypeScript SDK for the cStar customer support platform",
 	"type": "module",
 	"main": "./dist/index.cjs",