@cstar.help/js 0.18.1 → 0.18.4

package/dist/library/index.cjs

@@ -49,7 +49,7 @@ var ErrorType = {
   API_ERROR: "api_error",
   SERVER_ERROR: "server_error"
 };
-var DEFAULT_DOC_URL = "https://cstar.help/developers/api/errors";
+var DEFAULT_DOC_URL = "https://www.cstar.help/developers/errors";
 function normalizeArgs(messageOrStatus, maybeBody, defaults) {
   if (typeof messageOrStatus === "string") {
     return {
@@ -92,7 +92,7 @@ var CStarAuthenticationErrorImpl = class extends CStarErrorImpl {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.AUTHENTICATION_ERROR,
       code: "authentication_failed",
-      doc_url: `${DEFAULT_DOC_URL}#authentication-error`
+      doc_url: `${DEFAULT_DOC_URL}#authentication-errors`
     });
     super(statusCode, resolved);
     this.name = "CStarAuthenticationError";
@@ -103,11 +103,11 @@ var CStarRateLimitErrorImpl = class extends CStarErrorImpl {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.RATE_LIMIT_ERROR,
       code: "rate_limit_exceeded",
-      doc_url: `${DEFAULT_DOC_URL}#rate-limit-error`
+      doc_url: `${DEFAULT_DOC_URL}#rate_limit_exceeded`
     });
     super(statusCode === 0 ? 429 : statusCode, resolved);
     this.name = "CStarRateLimitError";
-    this.retryAfter = retryAfter ?? 60;
+    this.retryAfter = retryAfter;
   }
 };
 var CStarNotFoundErrorImpl = class extends CStarErrorImpl {
@@ -115,7 +115,7 @@ var CStarNotFoundErrorImpl = class extends CStarErrorImpl {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.NOT_FOUND_ERROR,
       code: "resource_not_found",
-      doc_url: `${DEFAULT_DOC_URL}#not-found-error`
+      doc_url: `${DEFAULT_DOC_URL}#resource_not_found`
     });
     super(statusCode, resolved);
     this.name = "CStarNotFoundError";
@@ -126,7 +126,7 @@ var CStarValidationErrorImpl = class extends CStarErrorImpl {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.INVALID_REQUEST_ERROR,
       code: "validation_error",
-      doc_url: `${DEFAULT_DOC_URL}#validation-error`
+      doc_url: `${DEFAULT_DOC_URL}#invalid-request-errors`
     });
     super(statusCode, resolved);
     this.name = "CStarValidationError";
@@ -137,7 +137,7 @@ var CStarPermissionErrorImpl = class extends CStarErrorImpl {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.PERMISSION_ERROR,
       code: "permission_denied",
-      doc_url: `${DEFAULT_DOC_URL}#permission-error`
+      doc_url: `${DEFAULT_DOC_URL}#insufficient_permissions`
     });
     super(statusCode, resolved);
     this.name = "CStarPermissionError";
@@ -148,7 +148,7 @@ var CStarConflictErrorImpl = class extends CStarErrorImpl {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.CONFLICT_ERROR,
       code: "conflict",
-      doc_url: `${DEFAULT_DOC_URL}#conflict-error`
+      doc_url: `${DEFAULT_DOC_URL}#resource_conflict`
     });
     super(statusCode, resolved);
     this.name = "CStarConflictError";
@@ -159,7 +159,7 @@ var CStarServerErrorImpl = class extends CStarErrorImpl {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.SERVER_ERROR,
       code: "server_error",
-      doc_url: `${DEFAULT_DOC_URL}#server-error`
+      doc_url: `${DEFAULT_DOC_URL}#server-errors`
     });
     super(statusCode, resolved);
     this.name = "CStarServerError";
@@ -170,7 +170,7 @@ var CStarFeatureDisabledErrorImpl = class extends CStarErrorImpl {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.FEATURE_NOT_CONFIGURED,
       code: "feature_not_configured",
-      doc_url: `${DEFAULT_DOC_URL}#feature-not-configured`
+      doc_url: `${DEFAULT_DOC_URL}#feature_disabled`
     });
     super(statusCode, resolved);
     this.name = "CStarFeatureDisabledError";
@@ -180,12 +180,12 @@ var CStarFeatureDisabledErrorImpl = class extends CStarErrorImpl {
 };
 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";
+    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://www.cstar.help/developers/sdk/js/realtime#ssr";
     super(0, {
       type: ErrorType.API_ERROR,
       code: "realtime_unavailable",
       message: resolved,
-      doc_url: "https://cstar.help/developers/sdk/realtime#ssr"
+      doc_url: "https://www.cstar.help/developers/sdk/js/realtime#ssr"
     });
     this.name = "CStarRealtimeUnavailableError";
   }
@@ -292,7 +292,10 @@ function parseError(statusCode, body, retryAfter) {
     doc_url: DEFAULT_DOC_URL
   };
   if (statusCode === 429) {
-    return new CStarRateLimitError(statusCode, errorBody, retryAfter ?? 60);
+    return new CStarRateLimitError(statusCode, errorBody, retryAfter);
+  }
+  if (errorBody.code === "feature_disabled") {
+    return new CStarFeatureDisabledError(statusCode, errorBody);
   }
   const StatusCls = STATUS_TO_CLASS[statusCode];
   if (StatusCls) {

package/dist/library/index.d.cts

@@ -1,4 +1,4 @@
-export { A as ApiErrorBody, C as CStarAuthenticationError, a as CStarConflictError, b as CStarError, c as CStarFeatureDisabledError, d as CStarNotFoundError, e as CStarPermissionError, f as CStarRateLimitError, g as CStarRealtimeUnavailableError, h as CStarServerError, i as CStarValidationError, E as ErrorType, p as parseError, j as parsePublicError } from '../errors-bW8CwTn4.cjs';
+export { A as ApiErrorBody, C as CStarAuthenticationError, a as CStarConflictError, b as CStarError, c as CStarFeatureDisabledError, d as CStarNotFoundError, e as CStarPermissionError, f as CStarRateLimitError, g as CStarRealtimeUnavailableError, h as CStarServerError, i as CStarValidationError, E as ErrorType, p as parseError, j as parsePublicError } from '../errors-BnUUTVlT.cjs';
 
 /** Configuration for the LibraryClient. */
 interface LibraryConfig {

package/dist/library/index.d.ts

@@ -1,4 +1,4 @@
-export { A as ApiErrorBody, C as CStarAuthenticationError, a as CStarConflictError, b as CStarError, c as CStarFeatureDisabledError, d as CStarNotFoundError, e as CStarPermissionError, f as CStarRateLimitError, g as CStarRealtimeUnavailableError, h as CStarServerError, i as CStarValidationError, E as ErrorType, p as parseError, j as parsePublicError } from '../errors-bW8CwTn4.js';
+export { A as ApiErrorBody, C as CStarAuthenticationError, a as CStarConflictError, b as CStarError, c as CStarFeatureDisabledError, d as CStarNotFoundError, e as CStarPermissionError, f as CStarRateLimitError, g as CStarRealtimeUnavailableError, h as CStarServerError, i as CStarValidationError, E as ErrorType, p as parseError, j as parsePublicError } from '../errors-BnUUTVlT.js';
 
 /** Configuration for the LibraryClient. */
 interface LibraryConfig {

package/dist/library/index.js

@@ -10,7 +10,7 @@ var ErrorType = {
   API_ERROR: "api_error",
   SERVER_ERROR: "server_error"
 };
-var DEFAULT_DOC_URL = "https://cstar.help/developers/api/errors";
+var DEFAULT_DOC_URL = "https://www.cstar.help/developers/errors";
 function normalizeArgs(messageOrStatus, maybeBody, defaults) {
   if (typeof messageOrStatus === "string") {
     return {
@@ -53,7 +53,7 @@ var CStarAuthenticationErrorImpl = class extends CStarErrorImpl {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.AUTHENTICATION_ERROR,
       code: "authentication_failed",
-      doc_url: `${DEFAULT_DOC_URL}#authentication-error`
+      doc_url: `${DEFAULT_DOC_URL}#authentication-errors`
     });
     super(statusCode, resolved);
     this.name = "CStarAuthenticationError";
@@ -64,11 +64,11 @@ var CStarRateLimitErrorImpl = class extends CStarErrorImpl {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.RATE_LIMIT_ERROR,
       code: "rate_limit_exceeded",
-      doc_url: `${DEFAULT_DOC_URL}#rate-limit-error`
+      doc_url: `${DEFAULT_DOC_URL}#rate_limit_exceeded`
     });
     super(statusCode === 0 ? 429 : statusCode, resolved);
     this.name = "CStarRateLimitError";
-    this.retryAfter = retryAfter ?? 60;
+    this.retryAfter = retryAfter;
   }
 };
 var CStarNotFoundErrorImpl = class extends CStarErrorImpl {
@@ -76,7 +76,7 @@ var CStarNotFoundErrorImpl = class extends CStarErrorImpl {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.NOT_FOUND_ERROR,
       code: "resource_not_found",
-      doc_url: `${DEFAULT_DOC_URL}#not-found-error`
+      doc_url: `${DEFAULT_DOC_URL}#resource_not_found`
     });
     super(statusCode, resolved);
     this.name = "CStarNotFoundError";
@@ -87,7 +87,7 @@ var CStarValidationErrorImpl = class extends CStarErrorImpl {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.INVALID_REQUEST_ERROR,
       code: "validation_error",
-      doc_url: `${DEFAULT_DOC_URL}#validation-error`
+      doc_url: `${DEFAULT_DOC_URL}#invalid-request-errors`
     });
     super(statusCode, resolved);
     this.name = "CStarValidationError";
@@ -98,7 +98,7 @@ var CStarPermissionErrorImpl = class extends CStarErrorImpl {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.PERMISSION_ERROR,
       code: "permission_denied",
-      doc_url: `${DEFAULT_DOC_URL}#permission-error`
+      doc_url: `${DEFAULT_DOC_URL}#insufficient_permissions`
     });
     super(statusCode, resolved);
     this.name = "CStarPermissionError";
@@ -109,7 +109,7 @@ var CStarConflictErrorImpl = class extends CStarErrorImpl {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.CONFLICT_ERROR,
       code: "conflict",
-      doc_url: `${DEFAULT_DOC_URL}#conflict-error`
+      doc_url: `${DEFAULT_DOC_URL}#resource_conflict`
     });
     super(statusCode, resolved);
     this.name = "CStarConflictError";
@@ -120,7 +120,7 @@ var CStarServerErrorImpl = class extends CStarErrorImpl {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.SERVER_ERROR,
       code: "server_error",
-      doc_url: `${DEFAULT_DOC_URL}#server-error`
+      doc_url: `${DEFAULT_DOC_URL}#server-errors`
     });
     super(statusCode, resolved);
     this.name = "CStarServerError";
@@ -131,7 +131,7 @@ var CStarFeatureDisabledErrorImpl = class extends CStarErrorImpl {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.FEATURE_NOT_CONFIGURED,
       code: "feature_not_configured",
-      doc_url: `${DEFAULT_DOC_URL}#feature-not-configured`
+      doc_url: `${DEFAULT_DOC_URL}#feature_disabled`
     });
     super(statusCode, resolved);
     this.name = "CStarFeatureDisabledError";
@@ -141,12 +141,12 @@ var CStarFeatureDisabledErrorImpl = class extends CStarErrorImpl {
 };
 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";
+    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://www.cstar.help/developers/sdk/js/realtime#ssr";
     super(0, {
       type: ErrorType.API_ERROR,
       code: "realtime_unavailable",
       message: resolved,
-      doc_url: "https://cstar.help/developers/sdk/realtime#ssr"
+      doc_url: "https://www.cstar.help/developers/sdk/js/realtime#ssr"
     });
     this.name = "CStarRealtimeUnavailableError";
   }
@@ -253,7 +253,10 @@ function parseError(statusCode, body, retryAfter) {
     doc_url: DEFAULT_DOC_URL
   };
   if (statusCode === 429) {
-    return new CStarRateLimitError(statusCode, errorBody, retryAfter ?? 60);
+    return new CStarRateLimitError(statusCode, errorBody, retryAfter);
+  }
+  if (errorBody.code === "feature_disabled") {
+    return new CStarFeatureDisabledError(statusCode, errorBody);
   }
   const StatusCls = STATUS_TO_CLASS[statusCode];
   if (StatusCls) {

package/dist/quickhelp/index.cjs

@@ -50,7 +50,7 @@ var ErrorType = {
   API_ERROR: "api_error",
   SERVER_ERROR: "server_error"
 };
-var DEFAULT_DOC_URL = "https://cstar.help/developers/api/errors";
+var DEFAULT_DOC_URL = "https://www.cstar.help/developers/errors";
 function normalizeArgs(messageOrStatus, maybeBody, defaults) {
   if (typeof messageOrStatus === "string") {
     return {
@@ -93,7 +93,7 @@ var CStarAuthenticationErrorImpl = class extends CStarErrorImpl {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.AUTHENTICATION_ERROR,
       code: "authentication_failed",
-      doc_url: `${DEFAULT_DOC_URL}#authentication-error`
+      doc_url: `${DEFAULT_DOC_URL}#authentication-errors`
     });
     super(statusCode, resolved);
     this.name = "CStarAuthenticationError";
@@ -104,11 +104,11 @@ var CStarRateLimitErrorImpl = class extends CStarErrorImpl {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.RATE_LIMIT_ERROR,
       code: "rate_limit_exceeded",
-      doc_url: `${DEFAULT_DOC_URL}#rate-limit-error`
+      doc_url: `${DEFAULT_DOC_URL}#rate_limit_exceeded`
     });
     super(statusCode === 0 ? 429 : statusCode, resolved);
     this.name = "CStarRateLimitError";
-    this.retryAfter = retryAfter ?? 60;
+    this.retryAfter = retryAfter;
   }
 };
 var CStarNotFoundErrorImpl = class extends CStarErrorImpl {
@@ -116,7 +116,7 @@ var CStarNotFoundErrorImpl = class extends CStarErrorImpl {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.NOT_FOUND_ERROR,
       code: "resource_not_found",
-      doc_url: `${DEFAULT_DOC_URL}#not-found-error`
+      doc_url: `${DEFAULT_DOC_URL}#resource_not_found`
     });
     super(statusCode, resolved);
     this.name = "CStarNotFoundError";
@@ -127,7 +127,7 @@ var CStarValidationErrorImpl = class extends CStarErrorImpl {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.INVALID_REQUEST_ERROR,
       code: "validation_error",
-      doc_url: `${DEFAULT_DOC_URL}#validation-error`
+      doc_url: `${DEFAULT_DOC_URL}#invalid-request-errors`
     });
     super(statusCode, resolved);
     this.name = "CStarValidationError";
@@ -138,7 +138,7 @@ var CStarPermissionErrorImpl = class extends CStarErrorImpl {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.PERMISSION_ERROR,
       code: "permission_denied",
-      doc_url: `${DEFAULT_DOC_URL}#permission-error`
+      doc_url: `${DEFAULT_DOC_URL}#insufficient_permissions`
     });
     super(statusCode, resolved);
     this.name = "CStarPermissionError";
@@ -149,7 +149,7 @@ var CStarConflictErrorImpl = class extends CStarErrorImpl {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.CONFLICT_ERROR,
       code: "conflict",
-      doc_url: `${DEFAULT_DOC_URL}#conflict-error`
+      doc_url: `${DEFAULT_DOC_URL}#resource_conflict`
     });
     super(statusCode, resolved);
     this.name = "CStarConflictError";
@@ -160,7 +160,7 @@ var CStarServerErrorImpl = class extends CStarErrorImpl {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.SERVER_ERROR,
       code: "server_error",
-      doc_url: `${DEFAULT_DOC_URL}#server-error`
+      doc_url: `${DEFAULT_DOC_URL}#server-errors`
     });
     super(statusCode, resolved);
     this.name = "CStarServerError";
@@ -171,7 +171,7 @@ var CStarFeatureDisabledErrorImpl = class extends CStarErrorImpl {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.FEATURE_NOT_CONFIGURED,
       code: "feature_not_configured",
-      doc_url: `${DEFAULT_DOC_URL}#feature-not-configured`
+      doc_url: `${DEFAULT_DOC_URL}#feature_disabled`
     });
     super(statusCode, resolved);
     this.name = "CStarFeatureDisabledError";
@@ -181,12 +181,12 @@ var CStarFeatureDisabledErrorImpl = class extends CStarErrorImpl {
 };
 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";
+    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://www.cstar.help/developers/sdk/js/realtime#ssr";
     super(0, {
       type: ErrorType.API_ERROR,
       code: "realtime_unavailable",
       message: resolved,
-      doc_url: "https://cstar.help/developers/sdk/realtime#ssr"
+      doc_url: "https://www.cstar.help/developers/sdk/js/realtime#ssr"
     });
     this.name = "CStarRealtimeUnavailableError";
   }
@@ -293,7 +293,10 @@ function parseError(statusCode, body, retryAfter) {
     doc_url: DEFAULT_DOC_URL
   };
   if (statusCode === 429) {
-    return new CStarRateLimitError(statusCode, errorBody, retryAfter ?? 60);
+    return new CStarRateLimitError(statusCode, errorBody, retryAfter);
+  }
+  if (errorBody.code === "feature_disabled") {
+    return new CStarFeatureDisabledError(statusCode, errorBody);
   }
   const StatusCls = STATUS_TO_CLASS[statusCode];
   if (StatusCls) {
@@ -408,7 +411,7 @@ var QuickHelpClient = class {
           type: "feature_not_configured",
           code: "feature_not_configured",
           message: body?.error?.message ?? "Quick Help is not available on this team. Enable an AI Agent (Settings \u2192 AI Agents) and configure Quick Help (Settings \u2192 Quick Help) before calling .ask().",
-          doc_url: "https://cstar.help/developers/api/errors#feature-not-configured",
+          doc_url: "https://www.cstar.help/developers/errors#service_unavailable",
           feature: "quickHelp",
           enable_url: `${this.baseUrl}/team/${encodeURIComponent(teamId)}/settings?section=quickHelp`
         });
@@ -417,11 +420,12 @@ var QuickHelpClient = class {
       const err = new QuickHelpError(message, {
         status: res.status,
         code: body?.error?.code,
+        reason: body?.error?.reason,
         retryAfterSeconds: parseRetryAfter(res.headers.get("retry-after"))
       });
       throw err;
     }
-    return body.data;
+    return { ...body.data, sources: body.data.sources ?? [] };
   }
 };
 var QuickHelpError = class extends Error {
@@ -430,6 +434,7 @@ var QuickHelpError = class extends Error {
     this.name = "QuickHelpError";
     this.status = opts.status;
     this.code = opts.code;
+    this.reason = opts.reason;
     this.retryAfterSeconds = opts.retryAfterSeconds;
   }
 };

package/dist/quickhelp/index.d.cts

@@ -1,4 +1,4 @@
-export { A as ApiErrorBody, C as CStarAuthenticationError, a as CStarConflictError, b as CStarError, c as CStarFeatureDisabledError, d as CStarNotFoundError, e as CStarPermissionError, f as CStarRateLimitError, g as CStarRealtimeUnavailableError, h as CStarServerError, i as CStarValidationError, E as ErrorType, p as parseError, j as parsePublicError } from '../errors-bW8CwTn4.cjs';
+export { A as ApiErrorBody, C as CStarAuthenticationError, a as CStarConflictError, b as CStarError, c as CStarFeatureDisabledError, d as CStarNotFoundError, e as CStarPermissionError, f as CStarRateLimitError, g as CStarRealtimeUnavailableError, h as CStarServerError, i as CStarValidationError, E as ErrorType, p as parseError, j as parsePublicError } from '../errors-BnUUTVlT.cjs';
 
 /**
  * Options for the QuickHelpClient. No auth — Quick Help is anonymous by
@@ -50,9 +50,30 @@ interface QuickHelpAskParams {
      */
     sessionId?: string | null;
 }
+/** A help article or page an answer was drawn from. */
+interface QuickHelpSource {
+    title: string;
+    /**
+     * Public URL: the article in your help center (your verified custom help
+     * domain, or your cStar library), or a page on one of your Atlas sites.
+     * `null` when the source has no public page, for example when your public
+     * library is off or the article is test data. Show the title as text then.
+     */
+    url: string | null;
+}
 interface QuickHelpAskResult {
     sessionId: string;
+    /**
+     * The answer, in light markdown. It comes only from your published help
+     * content. When nothing matches, it is a fixed "not covered" message plus
+     * your configured contact options, and `turnOutcome` is `escalated`.
+     */
     answer: string;
+    /**
+     * The articles and pages this answer used. Empty when the help content
+     * did not cover the question.
+     */
+    sources: QuickHelpSource[];
     turnOutcome: QuickHelpTurnOutcome;
     turnNumber: number;
 }
@@ -121,12 +142,15 @@ declare class QuickHelpClient {
 declare class QuickHelpError extends Error {
     readonly status: number;
     readonly code?: string;
+    /** The Quick Help cause behind `code`, e.g. `rate_limited`. */
+    readonly reason?: string;
     readonly retryAfterSeconds?: number;
     constructor(message: string, opts: {
         status: number;
         code?: string;
+        reason?: string;
         retryAfterSeconds?: number;
     });
 }
 
-export { type QuickHelpAskParams, type QuickHelpAskResult, QuickHelpClient, type QuickHelpConfig, QuickHelpError, type QuickHelpPublicConfig, type QuickHelpTurnOutcome };
+export { type QuickHelpAskParams, type QuickHelpAskResult, QuickHelpClient, type QuickHelpConfig, QuickHelpError, type QuickHelpPublicConfig, type QuickHelpSource, type QuickHelpTurnOutcome };

package/dist/quickhelp/index.d.ts

@@ -1,4 +1,4 @@
-export { A as ApiErrorBody, C as CStarAuthenticationError, a as CStarConflictError, b as CStarError, c as CStarFeatureDisabledError, d as CStarNotFoundError, e as CStarPermissionError, f as CStarRateLimitError, g as CStarRealtimeUnavailableError, h as CStarServerError, i as CStarValidationError, E as ErrorType, p as parseError, j as parsePublicError } from '../errors-bW8CwTn4.js';
+export { A as ApiErrorBody, C as CStarAuthenticationError, a as CStarConflictError, b as CStarError, c as CStarFeatureDisabledError, d as CStarNotFoundError, e as CStarPermissionError, f as CStarRateLimitError, g as CStarRealtimeUnavailableError, h as CStarServerError, i as CStarValidationError, E as ErrorType, p as parseError, j as parsePublicError } from '../errors-BnUUTVlT.js';
 
 /**
  * Options for the QuickHelpClient. No auth — Quick Help is anonymous by
@@ -50,9 +50,30 @@ interface QuickHelpAskParams {
      */
     sessionId?: string | null;
 }
+/** A help article or page an answer was drawn from. */
+interface QuickHelpSource {
+    title: string;
+    /**
+     * Public URL: the article in your help center (your verified custom help
+     * domain, or your cStar library), or a page on one of your Atlas sites.
+     * `null` when the source has no public page, for example when your public
+     * library is off or the article is test data. Show the title as text then.
+     */
+    url: string | null;
+}
 interface QuickHelpAskResult {
     sessionId: string;
+    /**
+     * The answer, in light markdown. It comes only from your published help
+     * content. When nothing matches, it is a fixed "not covered" message plus
+     * your configured contact options, and `turnOutcome` is `escalated`.
+     */
     answer: string;
+    /**
+     * The articles and pages this answer used. Empty when the help content
+     * did not cover the question.
+     */
+    sources: QuickHelpSource[];
     turnOutcome: QuickHelpTurnOutcome;
     turnNumber: number;
 }
@@ -121,12 +142,15 @@ declare class QuickHelpClient {
 declare class QuickHelpError extends Error {
     readonly status: number;
     readonly code?: string;
+    /** The Quick Help cause behind `code`, e.g. `rate_limited`. */
+    readonly reason?: string;
     readonly retryAfterSeconds?: number;
     constructor(message: string, opts: {
         status: number;
         code?: string;
+        reason?: string;
         retryAfterSeconds?: number;
     });
 }
 
-export { type QuickHelpAskParams, type QuickHelpAskResult, QuickHelpClient, type QuickHelpConfig, QuickHelpError, type QuickHelpPublicConfig, type QuickHelpTurnOutcome };
+export { type QuickHelpAskParams, type QuickHelpAskResult, QuickHelpClient, type QuickHelpConfig, QuickHelpError, type QuickHelpPublicConfig, type QuickHelpSource, type QuickHelpTurnOutcome };

package/dist/quickhelp/index.js

@@ -10,7 +10,7 @@ var ErrorType = {
   API_ERROR: "api_error",
   SERVER_ERROR: "server_error"
 };
-var DEFAULT_DOC_URL = "https://cstar.help/developers/api/errors";
+var DEFAULT_DOC_URL = "https://www.cstar.help/developers/errors";
 function normalizeArgs(messageOrStatus, maybeBody, defaults) {
   if (typeof messageOrStatus === "string") {
     return {
@@ -53,7 +53,7 @@ var CStarAuthenticationErrorImpl = class extends CStarErrorImpl {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.AUTHENTICATION_ERROR,
       code: "authentication_failed",
-      doc_url: `${DEFAULT_DOC_URL}#authentication-error`
+      doc_url: `${DEFAULT_DOC_URL}#authentication-errors`
     });
     super(statusCode, resolved);
     this.name = "CStarAuthenticationError";
@@ -64,11 +64,11 @@ var CStarRateLimitErrorImpl = class extends CStarErrorImpl {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.RATE_LIMIT_ERROR,
       code: "rate_limit_exceeded",
-      doc_url: `${DEFAULT_DOC_URL}#rate-limit-error`
+      doc_url: `${DEFAULT_DOC_URL}#rate_limit_exceeded`
     });
     super(statusCode === 0 ? 429 : statusCode, resolved);
     this.name = "CStarRateLimitError";
-    this.retryAfter = retryAfter ?? 60;
+    this.retryAfter = retryAfter;
   }
 };
 var CStarNotFoundErrorImpl = class extends CStarErrorImpl {
@@ -76,7 +76,7 @@ var CStarNotFoundErrorImpl = class extends CStarErrorImpl {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.NOT_FOUND_ERROR,
       code: "resource_not_found",
-      doc_url: `${DEFAULT_DOC_URL}#not-found-error`
+      doc_url: `${DEFAULT_DOC_URL}#resource_not_found`
     });
     super(statusCode, resolved);
     this.name = "CStarNotFoundError";
@@ -87,7 +87,7 @@ var CStarValidationErrorImpl = class extends CStarErrorImpl {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.INVALID_REQUEST_ERROR,
       code: "validation_error",
-      doc_url: `${DEFAULT_DOC_URL}#validation-error`
+      doc_url: `${DEFAULT_DOC_URL}#invalid-request-errors`
     });
     super(statusCode, resolved);
     this.name = "CStarValidationError";
@@ -98,7 +98,7 @@ var CStarPermissionErrorImpl = class extends CStarErrorImpl {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.PERMISSION_ERROR,
       code: "permission_denied",
-      doc_url: `${DEFAULT_DOC_URL}#permission-error`
+      doc_url: `${DEFAULT_DOC_URL}#insufficient_permissions`
     });
     super(statusCode, resolved);
     this.name = "CStarPermissionError";
@@ -109,7 +109,7 @@ var CStarConflictErrorImpl = class extends CStarErrorImpl {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.CONFLICT_ERROR,
       code: "conflict",
-      doc_url: `${DEFAULT_DOC_URL}#conflict-error`
+      doc_url: `${DEFAULT_DOC_URL}#resource_conflict`
     });
     super(statusCode, resolved);
     this.name = "CStarConflictError";
@@ -120,7 +120,7 @@ var CStarServerErrorImpl = class extends CStarErrorImpl {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.SERVER_ERROR,
       code: "server_error",
-      doc_url: `${DEFAULT_DOC_URL}#server-error`
+      doc_url: `${DEFAULT_DOC_URL}#server-errors`
     });
     super(statusCode, resolved);
     this.name = "CStarServerError";
@@ -131,7 +131,7 @@ var CStarFeatureDisabledErrorImpl = class extends CStarErrorImpl {
     const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
       type: ErrorType.FEATURE_NOT_CONFIGURED,
       code: "feature_not_configured",
-      doc_url: `${DEFAULT_DOC_URL}#feature-not-configured`
+      doc_url: `${DEFAULT_DOC_URL}#feature_disabled`
     });
     super(statusCode, resolved);
     this.name = "CStarFeatureDisabledError";
@@ -141,12 +141,12 @@ var CStarFeatureDisabledErrorImpl = class extends CStarErrorImpl {
 };
 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";
+    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://www.cstar.help/developers/sdk/js/realtime#ssr";
     super(0, {
       type: ErrorType.API_ERROR,
       code: "realtime_unavailable",
       message: resolved,
-      doc_url: "https://cstar.help/developers/sdk/realtime#ssr"
+      doc_url: "https://www.cstar.help/developers/sdk/js/realtime#ssr"
     });
     this.name = "CStarRealtimeUnavailableError";
   }
@@ -253,7 +253,10 @@ function parseError(statusCode, body, retryAfter) {
     doc_url: DEFAULT_DOC_URL
   };
   if (statusCode === 429) {
-    return new CStarRateLimitError(statusCode, errorBody, retryAfter ?? 60);
+    return new CStarRateLimitError(statusCode, errorBody, retryAfter);
+  }
+  if (errorBody.code === "feature_disabled") {
+    return new CStarFeatureDisabledError(statusCode, errorBody);
   }
   const StatusCls = STATUS_TO_CLASS[statusCode];
   if (StatusCls) {
@@ -368,7 +371,7 @@ var QuickHelpClient = class {
           type: "feature_not_configured",
           code: "feature_not_configured",
           message: body?.error?.message ?? "Quick Help is not available on this team. Enable an AI Agent (Settings \u2192 AI Agents) and configure Quick Help (Settings \u2192 Quick Help) before calling .ask().",
-          doc_url: "https://cstar.help/developers/api/errors#feature-not-configured",
+          doc_url: "https://www.cstar.help/developers/errors#service_unavailable",
           feature: "quickHelp",
           enable_url: `${this.baseUrl}/team/${encodeURIComponent(teamId)}/settings?section=quickHelp`
         });
@@ -377,11 +380,12 @@ var QuickHelpClient = class {
       const err = new QuickHelpError(message, {
         status: res.status,
         code: body?.error?.code,
+        reason: body?.error?.reason,
         retryAfterSeconds: parseRetryAfter(res.headers.get("retry-after"))
       });
       throw err;
     }
-    return body.data;
+    return { ...body.data, sources: body.data.sources ?? [] };
   }
 };
 var QuickHelpError = class extends Error {
@@ -390,6 +394,7 @@ var QuickHelpError = class extends Error {
     this.name = "QuickHelpError";
     this.status = opts.status;
     this.code = opts.code;
+    this.reason = opts.reason;
     this.retryAfterSeconds = opts.retryAfterSeconds;
   }
 };

package/dist/{types-DF7GprCV.d.cts → types-BHCahwev.d.cts}

@@ -1,4 +1,4 @@
-/** Attachment metadata for community posts and comments (images only, max 5MB each). */
+/** Attachment metadata for community posts and comments (images only, max 4 MB each). */
 interface CommunityAttachment {
     filename: string;
     content_type: string;
@@ -30,7 +30,7 @@ interface CommunityCreatePostParams {
     topicId: string;
     /** Custom field values keyed by field definition ID. */
     customFields?: Record<string, string>;
-    /** Image attachments (max 10, images only, 5MB each). */
+    /** Image attachments (max 10, images only, 4 MB each). */
     attachments?: CommunityAttachment[];
 }
 /** Parameters for updating a post as the original author. */
@@ -53,7 +53,7 @@ interface CommunityCreateCommentParams {
     body: string;
     /** Parent comment ID for replies (optional, 1-level nesting). */
     parentCommentId?: string | null;
-    /** Image attachments (max 5, images only, 5MB each). */
+    /** Image attachments (max 5, images only, 4 MB each). */
     attachments?: CommunityAttachment[];
 }
 /** Response from creating a post. */