@cstar.help/js 0.14.0 → 0.15.1

package/dist/chat/index.d.ts

@@ -111,30 +111,21 @@ interface Ticket {
  * Paginated ticket list response.
  *
  * As of `@cstar.help/js@0.14.0` the canonical fields match the admin SDK and
- * library SDK envelopes (`{ data, pagination, hasMore }`). The legacy
- * `tickets` and `cursor` fields are kept as aliases — they reference the
- * same data — and will be removed in the next major. Closes F-037.
+ * library SDK envelopes (`{ data, pagination, hasMore }`). Closes F-037.
+ *
+ * Breaking change in 0.15.0 (B-11): the deprecated `tickets` and `cursor`
+ * top-level aliases are removed. Read `data` and `pagination.cursor`.
  */
 interface TicketListResponse {
-    /** Tickets on this page (canonical). */
+    /** Tickets on this page. */
     data: Ticket[];
-    /** Pagination cursor + a flag for whether more pages exist (canonical). */
+    /** Pagination cursor + a flag for whether more pages exist. */
     pagination: {
         cursor: string | null;
         hasMore: boolean;
     };
     /** Convenience copy of `pagination.hasMore`. */
     hasMore: boolean;
-    /**
-     * @deprecated since 0.14.0 — use `data`. Same array reference for now.
-     *   Will be removed in the next major.
-     */
-    tickets: Ticket[];
-    /**
-     * @deprecated since 0.14.0 — use `pagination.cursor`. Same value.
-     *   Will be removed in the next major.
-     */
-    cursor: string | null;
 }
 /** A message on a ticket. */
 interface Message {
@@ -494,6 +485,18 @@ declare class ChatClient {
     private initRealtimeFromSession;
     /** @internal Get the stored team ID for requests that need it. */
     getTeamId(): string | null;
+    /**
+     * Resolve a team ID, lazily looking it up from `teamSlug` if no team ID
+     * has been cached yet. Used by `tickets.list` and friends so that a
+     * caller who constructed `new ChatClient({ teamSlug, publishableKey })`
+     * doesn't have to manually call `loginWithCredentials` before reading
+     * public data.
+     *
+     * Closes NEW-v3-05 — `TicketsState(chatClient)` previously errored
+     * `"Missing teamId"` when the chat client was teamSlug-only because the
+     * tickets sub-resource read `getTeamId()` synchronously and bailed.
+     */
+    ensureTeamId(): Promise<string>;
     /** @internal Set team ID from identify response or other source. */
     setTeamId(teamId: string): void;
     /** @internal Wait for realtime to be initialized (for testing). */

package/dist/chat/index.js

@@ -621,6 +621,27 @@ var ChatClient = class {
   getTeamId() {
     return this.teamId;
   }
+  /**
+   * Resolve a team ID, lazily looking it up from `teamSlug` if no team ID
+   * has been cached yet. Used by `tickets.list` and friends so that a
+   * caller who constructed `new ChatClient({ teamSlug, publishableKey })`
+   * doesn't have to manually call `loginWithCredentials` before reading
+   * public data.
+   *
+   * Closes NEW-v3-05 — `TicketsState(chatClient)` previously errored
+   * `"Missing teamId"` when the chat client was teamSlug-only because the
+   * tickets sub-resource read `getTeamId()` synchronously and bailed.
+   */
+  async ensureTeamId() {
+    if (this.teamId) return this.teamId;
+    if (!this.teamSlug) {
+      throw new ChatClientAuthError(
+        "Missing teamId. Construct ChatClient with `teamSlug` or call `setTeamId()` / `identify()` / `loginWithCredentials()` first."
+      );
+    }
+    this.teamId = await this.resolveTeamIdFromSlug();
+    return this.teamId;
+  }
   /** @internal Set team ID from identify response or other source. */
   setTeamId(teamId) {
     this.teamId = teamId;
@@ -706,8 +727,10 @@ var TicketsApi = class {
   }
   /** List tickets for the identified customer. */
   async list(params) {
-    const teamId = this.chat.getTeamId();
-    if (!teamId) throw new ChatClientAuthError("Not identified. Call chat.identify() first.");
+    if (this.chat.getAuthMode() === null) {
+      throw new ChatClientAuthError("Not identified. Call chat.identify() first.");
+    }
+    const teamId = await this.chat.ensureTeamId();
     const response = await this.chat.fetch("/api/widget/conversations", {
       method: "GET",
       query: {
@@ -722,16 +745,15 @@ var TicketsApi = class {
     return {
       data,
       pagination: { cursor, hasMore },
-      hasMore,
-      // Deprecated aliases — same references, no extra allocation.
-      tickets: data,
-      cursor
+      hasMore
     };
   }
   /** Create a new ticket. */
   async create(params) {
-    const teamId = this.chat.getTeamId();
-    if (!teamId) throw new ChatClientAuthError("Not identified. Call chat.identify() first.");
+    if (this.chat.getAuthMode() === null) {
+      throw new ChatClientAuthError("Not identified. Call chat.identify() first.");
+    }
+    const teamId = await this.chat.ensureTeamId();
     const response = await this.chat.fetch("/api/widget/tickets", {
       method: "POST",
       body: {

package/dist/community/index.cjs

@@ -20,7 +20,20 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/community/index.ts
 var community_exports = {};
 __export(community_exports, {
-  CommunityClient: () => CommunityClient
+  CStarAuthenticationError: () => CStarAuthenticationError,
+  CStarConflictError: () => CStarConflictError,
+  CStarError: () => CStarError,
+  CStarFeatureDisabledError: () => CStarFeatureDisabledError,
+  CStarNotFoundError: () => CStarNotFoundError,
+  CStarPermissionError: () => CStarPermissionError,
+  CStarRateLimitError: () => CStarRateLimitError,
+  CStarRealtimeUnavailableError: () => CStarRealtimeUnavailableError,
+  CStarServerError: () => CStarServerError,
+  CStarValidationError: () => CStarValidationError,
+  CommunityClient: () => CommunityClient,
+  ErrorType: () => ErrorType,
+  parseError: () => parseError,
+  parsePublicError: () => parsePublicError
 });
 module.exports = __toCommonJS(community_exports);
 
@@ -61,7 +74,7 @@ function normalizeArgs(messageOrStatus, maybeBody, defaults) {
     }
   };
 }
-var CStarError = class extends Error {
+var CStarErrorImpl = class extends Error {
   constructor(messageOrStatus, body) {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body);
     super(resolved.message);
@@ -74,7 +87,7 @@ var CStarError = class extends Error {
     this.statusCode = statusCode;
   }
 };
-var CStarAuthenticationError = class extends CStarError {
+var CStarAuthenticationErrorImpl = class extends CStarErrorImpl {
   constructor(messageOrStatus, body) {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.AUTHENTICATION_ERROR,
@@ -85,7 +98,7 @@ var CStarAuthenticationError = class extends CStarError {
     this.name = "CStarAuthenticationError";
   }
 };
-var CStarRateLimitError = class extends CStarError {
+var CStarRateLimitErrorImpl = class extends CStarErrorImpl {
   constructor(messageOrStatus, body, retryAfter) {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.RATE_LIMIT_ERROR,
@@ -97,7 +110,7 @@ var CStarRateLimitError = class extends CStarError {
     this.retryAfter = retryAfter ?? 60;
   }
 };
-var CStarNotFoundError = class extends CStarError {
+var CStarNotFoundErrorImpl = class extends CStarErrorImpl {
   constructor(messageOrStatus, body) {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.NOT_FOUND_ERROR,
@@ -108,7 +121,7 @@ var CStarNotFoundError = class extends CStarError {
     this.name = "CStarNotFoundError";
   }
 };
-var CStarValidationError = class extends CStarError {
+var CStarValidationErrorImpl = class extends CStarErrorImpl {
   constructor(messageOrStatus, body) {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.INVALID_REQUEST_ERROR,
@@ -119,7 +132,7 @@ var CStarValidationError = class extends CStarError {
     this.name = "CStarValidationError";
   }
 };
-var CStarPermissionError = class extends CStarError {
+var CStarPermissionErrorImpl = class extends CStarErrorImpl {
   constructor(messageOrStatus, body) {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.PERMISSION_ERROR,
@@ -130,7 +143,7 @@ var CStarPermissionError = class extends CStarError {
     this.name = "CStarPermissionError";
   }
 };
-var CStarConflictError = class extends CStarError {
+var CStarConflictErrorImpl = class extends CStarErrorImpl {
   constructor(messageOrStatus, body) {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.CONFLICT_ERROR,
@@ -141,7 +154,7 @@ var CStarConflictError = class extends CStarError {
     this.name = "CStarConflictError";
   }
 };
-var CStarServerError = class extends CStarError {
+var CStarServerErrorImpl = class extends CStarErrorImpl {
   constructor(messageOrStatus, body) {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.SERVER_ERROR,
@@ -152,7 +165,7 @@ var CStarServerError = class extends CStarError {
     this.name = "CStarServerError";
   }
 };
-var CStarFeatureDisabledError = class extends CStarError {
+var CStarFeatureDisabledErrorImpl = class extends CStarErrorImpl {
   constructor(messageOrStatus, body) {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.FEATURE_NOT_CONFIGURED,
@@ -165,6 +178,62 @@ var CStarFeatureDisabledError = class extends CStarError {
     this.enableUrl = resolved.enable_url ?? "";
   }
 };
+var CStarRealtimeUnavailableErrorImpl = class extends CStarErrorImpl {
+  constructor(message) {
+    const resolved = message ?? "EventSource is not available in this environment. Real-time subscriptions only work in the browser. Move the call to a client-only path (`useEffect` / `onMount`), or pass an `eventSource` polyfill via the realtime options. See https://cstar.help/developers/sdk/realtime#ssr";
+    super(0, {
+      type: ErrorType.API_ERROR,
+      code: "realtime_unavailable",
+      message: resolved,
+      doc_url: "https://cstar.help/developers/sdk/realtime#ssr"
+    });
+    this.name = "CStarRealtimeUnavailableError";
+  }
+};
+var REGISTRY_KEY = /* @__PURE__ */ Symbol.for("@cstar.help/js/errors/v1");
+var globalSlot = globalThis;
+var registry = globalSlot[REGISTRY_KEY] ?? (globalSlot[REGISTRY_KEY] = {
+  CStarError: CStarErrorImpl,
+  CStarAuthenticationError: CStarAuthenticationErrorImpl,
+  CStarRateLimitError: CStarRateLimitErrorImpl,
+  CStarNotFoundError: CStarNotFoundErrorImpl,
+  CStarValidationError: CStarValidationErrorImpl,
+  CStarPermissionError: CStarPermissionErrorImpl,
+  CStarConflictError: CStarConflictErrorImpl,
+  CStarServerError: CStarServerErrorImpl,
+  CStarFeatureDisabledError: CStarFeatureDisabledErrorImpl,
+  CStarRealtimeUnavailableError: CStarRealtimeUnavailableErrorImpl
+});
+var NAME_FIXES = [
+  "CStarError",
+  "CStarAuthenticationError",
+  "CStarRateLimitError",
+  "CStarNotFoundError",
+  "CStarValidationError",
+  "CStarPermissionError",
+  "CStarConflictError",
+  "CStarServerError",
+  "CStarFeatureDisabledError",
+  "CStarRealtimeUnavailableError"
+];
+for (const key of NAME_FIXES) {
+  if (registry[key].name !== key) {
+    Object.defineProperty(registry[key], "name", {
+      value: key,
+      configurable: true
+    });
+  }
+}
+var CStarError = registry.CStarError;
+var CStarAuthenticationError = registry.CStarAuthenticationError;
+var CStarRateLimitError = registry.CStarRateLimitError;
+var CStarNotFoundError = registry.CStarNotFoundError;
+var CStarValidationError = registry.CStarValidationError;
+var CStarPermissionError = registry.CStarPermissionError;
+var CStarConflictError = registry.CStarConflictError;
+var CStarServerError = registry.CStarServerError;
+var CStarFeatureDisabledError = registry.CStarFeatureDisabledError;
+var CStarRealtimeUnavailableError = registry.CStarRealtimeUnavailableError;
 function parsePublicError(status, body, fallbackMessage) {
   const obj = body && typeof body === "object" ? body : null;
   const errVal = obj?.error;
@@ -529,5 +598,18 @@ var CommunityClient = class {
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  CommunityClient
+  CStarAuthenticationError,
+  CStarConflictError,
+  CStarError,
+  CStarFeatureDisabledError,
+  CStarNotFoundError,
+  CStarPermissionError,
+  CStarRateLimitError,
+  CStarRealtimeUnavailableError,
+  CStarServerError,
+  CStarValidationError,
+  CommunityClient,
+  ErrorType,
+  parseError,
+  parsePublicError
 });