@cstar.help/js 0.5.0 → 0.5.1

package/dist/community/index.js

@@ -2,9 +2,30 @@
 var DEFAULT_BASE_URL = "https://www.cstar.help";
 var CommunityClient = class {
   constructor(config) {
+    this.sessionToken = null;
+    this.teamId = null;
     this.baseUrl = (config.baseUrl ?? DEFAULT_BASE_URL).replace(/\/+$/, "");
     this.teamSlug = config.teamSlug;
   }
+  /**
+   * Set a session token from identity verification.
+   * This enables authenticated operations (create posts, vote, comment).
+   *
+   * The token is the same `sessionToken` returned by `ChatClient.identify()`.
+   */
+  setSessionToken(token, teamId) {
+    this.sessionToken = token;
+    if (teamId) this.teamId = teamId;
+  }
+  /** Clear the session token and return to read-only mode. */
+  clearSession() {
+    this.sessionToken = null;
+    this.teamId = null;
+  }
+  /** Whether the client has an active session token. */
+  get isAuthenticated() {
+    return this.sessionToken !== null;
+  }
   /** List all public community topics. */
   async topics() {
     const response = await this.fetch(
@@ -42,6 +63,134 @@ var CommunityClient = class {
       q: query
     });
   }
+  // ── Authenticated Actions (require setSessionToken) ──
+  /**
+   * Create a new community post. Requires an active session token.
+   *
+   * @throws Error if no session token is set or the request fails
+   */
+  async createPost(params) {
+    const teamId = this.resolveTeamId();
+    const response = await this.authenticatedFetch("/api/widget/community", {
+      method: "POST",
+      body: {
+        teamId,
+        action: "createPost",
+        title: params.title,
+        body: params.body,
+        topicId: params.topicId
+      }
+    });
+    return response.data.post;
+  }
+  /**
+   * Toggle vote on a post. Returns new vote state and count.
+   * Requires an active session token.
+   */
+  async vote(postId) {
+    const teamId = this.resolveTeamId();
+    const response = await this.authenticatedFetch("/api/widget/community", {
+      method: "POST",
+      body: { teamId, action: "vote", postId }
+    });
+    return response.data;
+  }
+  /**
+   * Add a comment to a post. Requires an active session token.
+   */
+  async comment(postId, params) {
+    const teamId = this.resolveTeamId();
+    const response = await this.authenticatedFetch("/api/widget/community", {
+      method: "POST",
+      body: {
+        teamId,
+        action: "createComment",
+        postId,
+        commentBody: params.body,
+        parentCommentId: params.parentCommentId ?? null
+      }
+    });
+    return response.data.comment;
+  }
+  /**
+   * Toggle follow on a post. Requires an active session token.
+   */
+  async follow(postId) {
+    const teamId = this.resolveTeamId();
+    const response = await this.authenticatedFetch("/api/widget/community", {
+      method: "POST",
+      body: { teamId, action: "follow", postId }
+    });
+    return response.data;
+  }
+  /**
+   * Check if the current user has voted on a specific post.
+   * Requires an active session token.
+   */
+  async getVoteStatus(postId) {
+    const teamId = this.resolveTeamId();
+    const response = await this.authenticatedFetch("/api/widget/community", {
+      method: "GET",
+      query: { teamId, postId }
+    });
+    return response.data.voted;
+  }
+  /**
+   * Check vote status for multiple posts in a single request.
+   * Returns a map of postId → voted boolean.
+   * Requires an active session token.
+   */
+  async bulkVoteStatus(postIds) {
+    if (postIds.length === 0) return {};
+    const teamId = this.resolveTeamId();
+    const response = await this.authenticatedFetch("/api/widget/community", {
+      method: "GET",
+      query: { teamId, postIds: postIds.join(",") }
+    });
+    return response.data;
+  }
+  // ── Internal Helpers ──
+  /**
+   * Resolve team slug to team ID (cached after first call).
+   * For authenticated operations that require teamId.
+   */
+  resolveTeamId() {
+    if (this.teamId) return this.teamId;
+    throw new Error(
+      "Team ID is required for authenticated operations. Pass it via setSessionToken(token, teamId) or use ChatClient.identify() which provides it automatically."
+    );
+  }
+  async authenticatedFetch(path, options) {
+    if (!this.sessionToken) {
+      throw new Error(
+        "Session token required. Call setSessionToken() or use ChatClient.identify() first."
+      );
+    }
+    let url = `${this.baseUrl}${path}`;
+    if (options.query) {
+      const params = new URLSearchParams();
+      for (const [key, value] of Object.entries(options.query)) {
+        if (value !== void 0) params.set(key, value);
+      }
+      const qs = params.toString();
+      if (qs) url += `?${qs}`;
+    }
+    const headers = {
+      "Content-Type": "application/json",
+      Authorization: `Bearer ${this.sessionToken}`
+    };
+    const response = await globalThis.fetch(url, {
+      method: options.method,
+      headers,
+      body: options.body ? JSON.stringify(options.body) : void 0
+    });
+    if (!response.ok) {
+      const errorBody = await response.json().catch(() => ({ error: { message: "Request failed" } }));
+      const message = typeof errorBody.error === "string" ? errorBody.error : errorBody.error?.message ?? `Community API error: ${response.status}`;
+      throw new Error(message);
+    }
+    return response.json();
+  }
   async fetch(path, query) {
     let url = `${this.baseUrl}${path}`;
     if (query) {

package/dist/index.cjs

@@ -97,7 +97,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;
@@ -113,6 +113,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.
@@ -148,6 +153,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);
@@ -332,6 +338,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
@@ -611,29 +657,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 } }
     );
   }
 };
@@ -713,10 +804,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", {
@@ -734,35 +821,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
     });
   }
 };
@@ -896,9 +1027,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);
   }
 };
 
@@ -962,6 +1123,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) {
@@ -1135,6 +1319,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) {
@@ -1158,6 +1343,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
@@ -1195,9 +1384,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
     });
   }
@@ -1237,6 +1426,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);