@cstar.help/js 0.5.0 → 0.5.2

package/dist/index.js

@@ -65,7 +65,7 @@ function parseError(statusCode, body, retryAfter) {
 }
 
 // src/client.ts
-var SDK_VERSION = "0.2.1";
+var SDK_VERSION = "0.5.0";
 var DEFAULT_BASE_URL = "https://www.cstar.help";
 var DEFAULT_API_VERSION = "2026-03-01";
 var DEFAULT_MAX_RETRIES = 3;
@@ -81,6 +81,11 @@ var HttpClient = class {
       timeout: config.timeout ?? DEFAULT_TIMEOUT
     };
     this.environment = config.apiKey.startsWith("sk_test_") || config.apiKey.startsWith("pk_test_") ? "test" : "live";
+    if (config.apiKey.startsWith("sk_") && typeof globalThis !== "undefined" && typeof globalThis.window !== "undefined") {
+      console.warn(
+        "[cStar] WARNING: Secret API key detected in a browser environment. This exposes your key to anyone viewing your site. Use CStarClient with secret keys on the server only. For client-side use, import from @cstar.help/js/chat, /library, or /community instead."
+      );
+    }
   }
   /**
    * Make an authenticated request to the cStar API.
@@ -116,6 +121,7 @@ var HttpClient = class {
         throw lastError;
       }
       if (response.ok) {
+        if (response.status === 204) return void 0;
         return await response.json();
       }
       const errorBody = await response.json().catch(() => null);
@@ -300,6 +306,46 @@ var WebhooksResource = class extends BaseResource {
       { body: params ?? {} }
     );
   }
+  /** Fire a test webhook event to all active webhooks and CLI listeners. */
+  async triggerTest(params, options) {
+    return this.client.request(
+      "POST",
+      "/webhooks/trigger-test",
+      { body: params, idempotencyKey: options?.idempotencyKey }
+    );
+  }
+  /** Get a sample webhook payload for an event type (used by Zapier). */
+  async sample(event) {
+    return this.client.request(
+      "GET",
+      `/webhooks/sample/${encodeURIComponent(event)}`
+    );
+  }
+  /** Subscribe to an event (REST Hooks / Zapier protocol). */
+  async subscribe(params, options) {
+    return this.client.request("POST", "/webhooks/subscribe", {
+      body: params,
+      idempotencyKey: options?.idempotencyKey
+    });
+  }
+  /** Unsubscribe from an event (REST Hooks / Zapier protocol). Returns void (204 No Content). */
+  async unsubscribe(subscriptionId) {
+    await this.client.request("DELETE", `/webhooks/subscribe/${subscriptionId}`);
+  }
+  /** Register a CLI listener (returns listenerId and signing secret). */
+  async listen(params, options) {
+    return this.client.request("POST", "/webhooks/listen", {
+      body: params,
+      idempotencyKey: options?.idempotencyKey
+    });
+  }
+  /** Deregister a CLI listener. */
+  async unlisten(listenerId) {
+    return this.client.request(
+      "DELETE",
+      `/webhooks/listen/${listenerId}`
+    );
+  }
 };
 
 // src/resources/automations.ts
@@ -579,29 +625,74 @@ var NotificationsResource = class {
   constructor(client) {
     this.client = client;
   }
-  /** List notifications. */
+  /** List notifications for a user. */
   async list(params) {
     return this.client.request("GET", "/notifications", {
       query: params
     });
   }
-  /** Get unread notification count. */
-  async unreadCount() {
-    return this.client.request("GET", "/notifications/unread-count");
+  /** Get unread notification count for a user. */
+  async unreadCount(userId) {
+    return this.client.request("GET", "/notifications/unread-count", {
+      query: { userId }
+    });
   }
   /** Mark a single notification as read. */
-  async markRead(notificationId) {
+  async markRead(notificationId, userId) {
     return this.client.request(
       "PATCH",
-      `/notifications/${notificationId}`,
-      { body: { read: true } }
+      `/notifications/${notificationId}/read`,
+      { body: { userId } }
     );
   }
   /** Mark all notifications as read. */
-  async markAllRead() {
+  async markAllRead(userId) {
+    return this.client.request(
+      "POST",
+      "/notifications/mark-all-read",
+      { body: { userId } }
+    );
+  }
+  /** Delete (dismiss) a notification. For broadcast notifications, pass userId as a query param. */
+  async del(notificationId, params) {
+    return this.client.request(
+      "DELETE",
+      `/notifications/${notificationId}`,
+      { query: params }
+    );
+  }
+};
+
+// src/resources/mentions.ts
+var MentionsResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** List mentions for a user. */
+  async list(params) {
+    return this.client.request("GET", "/mentions", {
+      query: params
+    });
+  }
+  /** Get unread mention count for a user. */
+  async unreadCount(userId) {
+    return this.client.request("GET", "/mentions/unread-count", {
+      query: { userId }
+    });
+  }
+  /** Mark a single mention as read. */
+  async markRead(mentionId) {
+    return this.client.request(
+      "PATCH",
+      `/mentions/${mentionId}/read`
+    );
+  }
+  /** Mark all mentions as read for a user. */
+  async markAllRead(userId) {
     return this.client.request(
       "POST",
-      "/notifications/mark-all-read"
+      "/mentions/mark-all-read",
+      { body: { userId } }
     );
   }
 };
@@ -681,10 +772,6 @@ var SlaResource = class {
       query: params
     });
   }
-  /** Get a single SLA rule. */
-  async get(ruleId) {
-    return this.client.request("GET", `/sla/rules/${ruleId}`);
-  }
   /** Create an SLA rule. */
   async create(params, options) {
     return this.client.request("POST", "/sla/rules", {
@@ -702,35 +789,79 @@ var SlaResource = class {
   async del(ruleId) {
     return this.client.request("DELETE", `/sla/rules/${ruleId}`);
   }
+  /** Reorder SLA rules by providing an ordered array of IDs. */
+  async reorder(orderedIds) {
+    return this.client.request("PUT", "/sla/rules/reorder", {
+      body: { orderedIds }
+    });
+  }
+  /** Get SLA compliance metrics. */
+  async metrics(params) {
+    return this.client.request("GET", "/sla/metrics", {
+      query: params
+    });
+  }
 };
 
 // src/resources/analytics.ts
-var AnalyticsResource = class {
+var CsatSurveysResource = class {
   constructor(client) {
     this.client = client;
   }
-  /** Get analytics overview. */
-  async overview(params) {
-    return this.client.request("GET", "/analytics/overview", {
+  /** List CSAT surveys. */
+  async list(params) {
+    return this.client.request("GET", "/csat/surveys", {
       query: params
     });
   }
-  /** Get per-agent performance stats. */
-  async agents(params) {
-    return this.client.request("GET", "/analytics/agents", {
+  /** Get a single CSAT survey. */
+  async get(surveyId) {
+    return this.client.request("GET", `/csat/surveys/${surveyId}`);
+  }
+  /** Create and send a CSAT survey. */
+  async create(params) {
+    return this.client.request("POST", "/csat/surveys", {
+      body: params
+    });
+  }
+};
+var AnalyticsResource = class {
+  constructor(client) {
+    this.client = client;
+    this.csatSurveys = new CsatSurveysResource(client);
+  }
+  /** Get analytics data. Specify type to control the response shape. */
+  async get(params) {
+    return this.client.request("GET", "/analytics", {
       query: params
     });
   }
+  /** Get analytics overview (shortcut for type=overview). */
+  async overview(params) {
+    return this.get({ ...params, type: "overview" });
+  }
+  /** Get agent performance stats (shortcut for type=performance). */
+  async performance(params) {
+    return this.get({ ...params, type: "performance" });
+  }
+  /** Get library analytics (shortcut for type=library). */
+  async library(params) {
+    return this.get({ ...params, type: "library" });
+  }
   /** Get CSAT statistics. */
   async csatStats(params) {
     return this.client.request("GET", "/csat/stats", {
       query: params
     });
   }
-  /** List individual CSAT responses. */
-  async csatResponses(params) {
-    return this.client.request("GET", "/csat/responses", {
-      query: params
+  /** Get CSAT settings. */
+  async csatSettings() {
+    return this.client.request("GET", "/csat/settings");
+  }
+  /** Update CSAT settings. */
+  async updateCsatSettings(params) {
+    return this.client.request("PATCH", "/csat/settings", {
+      body: params
     });
   }
 };
@@ -864,9 +995,39 @@ var ActivityResource = class {
 };
 
 // src/resources/customerGroups.ts
+var CustomerGroupMembersResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** List members in a group. */
+  async list(groupId, params) {
+    return this.client.request(
+      "GET",
+      `/customer-groups/${groupId}/members`,
+      { query: params }
+    );
+  }
+  /** Add member(s) to a group. */
+  async add(groupId, params, options) {
+    return this.client.request(
+      "POST",
+      `/customer-groups/${groupId}/members`,
+      { body: params, idempotencyKey: options?.idempotencyKey }
+    );
+  }
+  /** Remove a member from a group. */
+  async remove(groupId, customerId) {
+    return this.client.request(
+      "DELETE",
+      `/customer-groups/${groupId}/members`,
+      { query: { customerId } }
+    );
+  }
+};
 var CustomerGroupsResource = class extends BaseResource {
   constructor(client) {
     super(client, "/customer-groups");
+    this.members = new CustomerGroupMembersResource(client);
   }
 };
 
@@ -930,6 +1091,29 @@ var AchievementsResource = class {
       query: params
     });
   }
+  /** Get recently unlocked achievements across the team. */
+  async recent(params) {
+    return this.client.request("GET", "/game/achievements/recent", {
+      query: params
+    });
+  }
+};
+var GameActivityResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** Get the team activity feed. */
+  async list(params) {
+    return this.client.request("GET", "/game/activity", {
+      query: params
+    });
+  }
+  /** Get activity for a specific member. */
+  async forMember(memberId, params) {
+    return this.client.request("GET", `/game/activity/member/${memberId}`, {
+      query: params
+    });
+  }
 };
 var QuestsResource = class {
   constructor(client) {
@@ -1103,6 +1287,7 @@ var GameResource = class {
     this.cosmetics = new CosmeticsResource(client);
     this.seasons = new SeasonsResource(client);
     this.skills = new SkillsResource(client);
+    this.activity = new GameActivityResource(client);
   }
   /** Get current player stats. */
   async player(params) {
@@ -1126,6 +1311,10 @@ var GameResource = class {
       query: params
     });
   }
+  /** Get game balance configuration (read-only constants). */
+  async config() {
+    return this.client.request("GET", "/game/config");
+  }
 };
 
 // src/resources/ai.ts
@@ -1163,9 +1352,9 @@ var ViewsResource = class extends BaseResource {
   constructor(client) {
     super(client, "/views");
   }
-  /** Execute a view — returns the filtered results. */
+  /** Execute a view — returns the filtered results. The server uses the view's entity_type to determine which table to query. */
   async execute(viewId, params) {
-    return this.client.request("GET", `/views/${viewId}/tickets`, {
+    return this.client.request("GET", `/views/${viewId}/execute`, {
       query: params
     });
   }
@@ -1205,6 +1394,7 @@ var CStarClient = class {
     this.members = new MembersResource(this.client);
     this.settings = new SettingsResource(this.client);
     this.notifications = new NotificationsResource(this.client);
+    this.mentions = new MentionsResource(this.client);
     this.attachments = new AttachmentsResource(this.client);
     this.customFields = new CustomFieldsResource(this.client);
     this.sla = new SlaResource(this.client);

package/package.json

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

package/dist/community/index.d.cts

@@ -1,115 +0,0 @@
-/** Configuration for the CommunityClient. */
-interface CommunityConfig {
-    /** Team slug (e.g., 'acme'). Identifies the community to query. */
-    teamSlug: string;
-    /** Override the base URL (defaults to https://www.cstar.help). */
-    baseUrl?: string;
-}
-/** A discussion topic/category in the community. */
-interface CommunityTopic {
-    id: string;
-    name: string;
-    slug: string;
-    description: string | null;
-    icon: string;
-    visibility: 'public' | 'members_only';
-    sort_order: number;
-}
-/** A public community post. */
-interface CommunityPost {
-    id: string;
-    title: string;
-    slug: string;
-    body: string;
-    status: 'open' | 'answered' | 'officially_answered' | 'planned' | 'not_planned' | 'completed' | 'under_review';
-    visibility: 'public' | 'members_only';
-    voteCount: number;
-    commentCount: number;
-    isPinned: boolean;
-    isFeatured: boolean;
-    isLocked: boolean;
-    commentsEnabled: boolean;
-    topicName: string;
-    topicSlug: string;
-    authorName: string;
-    authorAvatar: string;
-    authorBio: string;
-    authorPostCount: number;
-    authorCommentCount: number;
-    isTeamMember: boolean;
-    lastActivityAt: string;
-    createdAt: string;
-}
-/** A comment on a community post. */
-interface CommunityComment {
-    id: string;
-    body: string;
-    isOfficial: boolean;
-    voteScore: number;
-    parentCommentId: string | null;
-    authorName: string;
-    authorAvatar: string;
-    authorBio: string;
-    authorPostCount: number;
-    authorCommentCount: number;
-    isTeamMember: boolean;
-    createdAt: string;
-}
-/** Parameters for listing posts. */
-interface CommunityPostListParams {
-    /** Filter by topic slug. */
-    topicSlug?: string;
-    /** Filter by status. */
-    status?: string;
-    /** Sort order (default: 'recent'). */
-    sort?: 'recent' | 'votes' | 'comments';
-    /** Max results per page. */
-    limit?: number;
-    /** Pagination offset. */
-    offset?: number;
-}
-/** Search results. */
-interface CommunitySearchResult {
-    data: CommunityPost[];
-    count: number;
-    query: string;
-}
-/** A single post with its comments. */
-interface CommunityPostDetail {
-    post: CommunityPost;
-    comments: CommunityComment[];
-}
-
-/**
- * Public community client. No authentication required.
- *
- * ```typescript
- * const community = new CommunityClient({ teamSlug: 'acme' });
- * const topics = await community.topics();
- * const posts = await community.posts({ topicSlug: 'feedback', sort: 'votes' });
- * const post = await community.post('my-feature-request');
- * const results = await community.search('dark mode');
- * ```
- */
-declare class CommunityClient {
-    private readonly baseUrl;
-    private readonly teamSlug;
-    constructor(config: CommunityConfig);
-    /** List all public community topics. */
-    topics(): Promise<CommunityTopic[]>;
-    /** List public posts, optionally filtered by topic, status, or sort order. */
-    posts(params?: CommunityPostListParams): Promise<{
-        posts: CommunityPost[];
-        count: number;
-    }>;
-    /** Get a single post by slug, including all comments. */
-    post(slug: string): Promise<CommunityPostDetail>;
-    /**
-     * Full-text search across post titles and bodies.
-     * Returns matching posts with relevance ranking.
-     */
-    search(query: string): Promise<CommunitySearchResult>;
-    private fetch;
-}
-
-export { CommunityClient, type CommunityComment, type CommunityConfig, type CommunityPost, type CommunityPostDetail, type CommunityPostListParams, type CommunitySearchResult, type CommunityTopic };

package/dist/community/index.d.ts

@@ -1,115 +0,0 @@
-/** Configuration for the CommunityClient. */
-interface CommunityConfig {
-    /** Team slug (e.g., 'acme'). Identifies the community to query. */
-    teamSlug: string;
-    /** Override the base URL (defaults to https://www.cstar.help). */
-    baseUrl?: string;
-}
-/** A discussion topic/category in the community. */
-interface CommunityTopic {
-    id: string;
-    name: string;
-    slug: string;
-    description: string | null;
-    icon: string;
-    visibility: 'public' | 'members_only';
-    sort_order: number;
-}
-/** A public community post. */
-interface CommunityPost {
-    id: string;
-    title: string;
-    slug: string;
-    body: string;
-    status: 'open' | 'answered' | 'officially_answered' | 'planned' | 'not_planned' | 'completed' | 'under_review';
-    visibility: 'public' | 'members_only';
-    voteCount: number;
-    commentCount: number;
-    isPinned: boolean;
-    isFeatured: boolean;
-    isLocked: boolean;
-    commentsEnabled: boolean;
-    topicName: string;
-    topicSlug: string;
-    authorName: string;
-    authorAvatar: string;
-    authorBio: string;
-    authorPostCount: number;
-    authorCommentCount: number;
-    isTeamMember: boolean;
-    lastActivityAt: string;
-    createdAt: string;
-}
-/** A comment on a community post. */
-interface CommunityComment {
-    id: string;
-    body: string;
-    isOfficial: boolean;
-    voteScore: number;
-    parentCommentId: string | null;
-    authorName: string;
-    authorAvatar: string;
-    authorBio: string;
-    authorPostCount: number;
-    authorCommentCount: number;
-    isTeamMember: boolean;
-    createdAt: string;
-}
-/** Parameters for listing posts. */
-interface CommunityPostListParams {
-    /** Filter by topic slug. */
-    topicSlug?: string;
-    /** Filter by status. */
-    status?: string;
-    /** Sort order (default: 'recent'). */
-    sort?: 'recent' | 'votes' | 'comments';
-    /** Max results per page. */
-    limit?: number;
-    /** Pagination offset. */
-    offset?: number;
-}
-/** Search results. */
-interface CommunitySearchResult {
-    data: CommunityPost[];
-    count: number;
-    query: string;
-}
-/** A single post with its comments. */
-interface CommunityPostDetail {
-    post: CommunityPost;
-    comments: CommunityComment[];
-}
-
-/**
- * Public community client. No authentication required.
- *
- * ```typescript
- * const community = new CommunityClient({ teamSlug: 'acme' });
- * const topics = await community.topics();
- * const posts = await community.posts({ topicSlug: 'feedback', sort: 'votes' });
- * const post = await community.post('my-feature-request');
- * const results = await community.search('dark mode');
- * ```
- */
-declare class CommunityClient {
-    private readonly baseUrl;
-    private readonly teamSlug;
-    constructor(config: CommunityConfig);
-    /** List all public community topics. */
-    topics(): Promise<CommunityTopic[]>;
-    /** List public posts, optionally filtered by topic, status, or sort order. */
-    posts(params?: CommunityPostListParams): Promise<{
-        posts: CommunityPost[];
-        count: number;
-    }>;
-    /** Get a single post by slug, including all comments. */
-    post(slug: string): Promise<CommunityPostDetail>;
-    /**
-     * Full-text search across post titles and bodies.
-     * Returns matching posts with relevance ranking.
-     */
-    search(query: string): Promise<CommunitySearchResult>;
-    private fetch;
-}
-
-export { CommunityClient, type CommunityComment, type CommunityConfig, type CommunityPost, type CommunityPostDetail, type CommunityPostListParams, type CommunitySearchResult, type CommunityTopic };