@cstar.help/js 0.12.1 → 0.14.0

package/dist/quickhelp/index.js

@@ -1,12 +1,211 @@
+// src/errors.ts
+var ErrorType = {
+  AUTHENTICATION_ERROR: "authentication_error",
+  PERMISSION_ERROR: "permission_error",
+  INVALID_REQUEST_ERROR: "invalid_request_error",
+  NOT_FOUND_ERROR: "not_found_error",
+  CONFLICT_ERROR: "conflict_error",
+  RATE_LIMIT_ERROR: "rate_limit_error",
+  FEATURE_NOT_CONFIGURED: "feature_not_configured",
+  API_ERROR: "api_error",
+  SERVER_ERROR: "server_error"
+};
+var DEFAULT_DOC_URL = "https://cstar.help/developers/api/errors";
+function normalizeArgs(messageOrStatus, maybeBody, defaults) {
+  if (typeof messageOrStatus === "string") {
+    return {
+      statusCode: defaults?.code === "rate_limit_error" ? 429 : 0,
+      body: {
+        type: defaults?.type ?? ErrorType.API_ERROR,
+        code: defaults?.code ?? "sdk_error",
+        message: messageOrStatus,
+        doc_url: defaults?.doc_url ?? DEFAULT_DOC_URL,
+        ...defaults?.feature ? { feature: defaults.feature } : {},
+        ...defaults?.enable_url ? { enable_url: defaults.enable_url } : {}
+      }
+    };
+  }
+  return {
+    statusCode: messageOrStatus,
+    body: maybeBody ?? {
+      type: defaults?.type ?? ErrorType.API_ERROR,
+      code: defaults?.code ?? "unknown_error",
+      message: defaults?.message ?? `Request failed with status ${messageOrStatus}`,
+      doc_url: defaults?.doc_url ?? DEFAULT_DOC_URL
+    }
+  };
+}
+var CStarError = class extends Error {
+  constructor(messageOrStatus, body) {
+    const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body);
+    super(resolved.message);
+    this.name = "CStarError";
+    this.type = resolved.type;
+    this.code = resolved.code;
+    this.param = resolved.param;
+    this.docUrl = resolved.doc_url;
+    this.requestId = resolved.request_id;
+    this.statusCode = statusCode;
+  }
+};
+var CStarAuthenticationError = class extends CStarError {
+  constructor(messageOrStatus, body) {
+    const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
+      type: ErrorType.AUTHENTICATION_ERROR,
+      code: "authentication_failed",
+      doc_url: `${DEFAULT_DOC_URL}#authentication-error`
+    });
+    super(statusCode, resolved);
+    this.name = "CStarAuthenticationError";
+  }
+};
+var CStarRateLimitError = class extends CStarError {
+  constructor(messageOrStatus, body, retryAfter) {
+    const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
+      type: ErrorType.RATE_LIMIT_ERROR,
+      code: "rate_limit_exceeded",
+      doc_url: `${DEFAULT_DOC_URL}#rate-limit-error`
+    });
+    super(statusCode === 0 ? 429 : statusCode, resolved);
+    this.name = "CStarRateLimitError";
+    this.retryAfter = retryAfter ?? 60;
+  }
+};
+var CStarNotFoundError = class extends CStarError {
+  constructor(messageOrStatus, body) {
+    const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
+      type: ErrorType.NOT_FOUND_ERROR,
+      code: "resource_not_found",
+      doc_url: `${DEFAULT_DOC_URL}#not-found-error`
+    });
+    super(statusCode, resolved);
+    this.name = "CStarNotFoundError";
+  }
+};
+var CStarValidationError = class extends CStarError {
+  constructor(messageOrStatus, body) {
+    const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
+      type: ErrorType.INVALID_REQUEST_ERROR,
+      code: "validation_error",
+      doc_url: `${DEFAULT_DOC_URL}#validation-error`
+    });
+    super(statusCode, resolved);
+    this.name = "CStarValidationError";
+  }
+};
+var CStarPermissionError = class extends CStarError {
+  constructor(messageOrStatus, body) {
+    const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
+      type: ErrorType.PERMISSION_ERROR,
+      code: "permission_denied",
+      doc_url: `${DEFAULT_DOC_URL}#permission-error`
+    });
+    super(statusCode, resolved);
+    this.name = "CStarPermissionError";
+  }
+};
+var CStarConflictError = class extends CStarError {
+  constructor(messageOrStatus, body) {
+    const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
+      type: ErrorType.CONFLICT_ERROR,
+      code: "conflict",
+      doc_url: `${DEFAULT_DOC_URL}#conflict-error`
+    });
+    super(statusCode, resolved);
+    this.name = "CStarConflictError";
+  }
+};
+var CStarServerError = class extends CStarError {
+  constructor(messageOrStatus, body) {
+    const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
+      type: ErrorType.SERVER_ERROR,
+      code: "server_error",
+      doc_url: `${DEFAULT_DOC_URL}#server-error`
+    });
+    super(statusCode, resolved);
+    this.name = "CStarServerError";
+  }
+};
+var CStarFeatureDisabledError = class extends CStarError {
+  constructor(messageOrStatus, body) {
+    const { statusCode, body: resolved } = normalizeArgs(messageOrStatus, body, {
+      type: ErrorType.FEATURE_NOT_CONFIGURED,
+      code: "feature_not_configured",
+      doc_url: `${DEFAULT_DOC_URL}#feature-not-configured`
+    });
+    super(statusCode, resolved);
+    this.name = "CStarFeatureDisabledError";
+    this.feature = resolved.feature ?? "unknown";
+    this.enableUrl = resolved.enable_url ?? "";
+  }
+};
+var TYPE_TO_CLASS = {
+  [ErrorType.AUTHENTICATION_ERROR]: CStarAuthenticationError,
+  [ErrorType.PERMISSION_ERROR]: CStarPermissionError,
+  [ErrorType.RATE_LIMIT_ERROR]: CStarRateLimitError,
+  [ErrorType.NOT_FOUND_ERROR]: CStarNotFoundError,
+  [ErrorType.INVALID_REQUEST_ERROR]: CStarValidationError,
+  [ErrorType.CONFLICT_ERROR]: CStarConflictError,
+  [ErrorType.SERVER_ERROR]: CStarServerError,
+  [ErrorType.FEATURE_NOT_CONFIGURED]: CStarFeatureDisabledError
+};
+
 // src/quickhelp/index.ts
 var DEFAULT_BASE_URL = "https://www.cstar.help";
 var QuickHelpClient = class {
   constructor(config) {
-    if (!config?.teamId) {
-      throw new Error("QuickHelpClient: teamId is required");
+    this.resolveTeamIdPromise = null;
+    if (!config?.teamId && !config?.teamSlug) {
+      throw new Error(
+        'QuickHelpClient: either `teamId` or `teamSlug` is required. Pass `teamSlug` (e.g. "acme") for the easiest setup.'
+      );
     }
     this.baseUrl = (config.baseUrl ?? DEFAULT_BASE_URL).replace(/\/+$/, "");
-    this.teamId = config.teamId;
+    this.teamId = config.teamId ?? null;
+    this.teamSlug = config.teamSlug ?? null;
+    this.publishableKey = config.publishableKey ?? null;
+    this.mode = this.publishableKey?.startsWith("pk_test_") ? "test" : "live";
+    if (this.publishableKey && !/^pk_(test|live)_/.test(this.publishableKey)) {
+      throw new Error(
+        "[cStar] QuickHelpClient: publishableKey must start with `pk_test_` or `pk_live_`. Secret keys (`sk_*`) cannot be used in browser/anonymous contexts."
+      );
+    }
+  }
+  authHeaders() {
+    return this.publishableKey ? { Authorization: `Bearer ${this.publishableKey}` } : {};
+  }
+  /**
+   * Resolve `teamSlug` → `teamId` lazily on the first call that needs it.
+   * Cached for the life of the client. NEW-v2-05.
+   */
+  async resolveTeamId() {
+    if (this.teamId) return this.teamId;
+    if (!this.teamSlug) throw new Error("QuickHelpClient: no teamId or teamSlug set");
+    if (this.resolveTeamIdPromise) return this.resolveTeamIdPromise;
+    this.resolveTeamIdPromise = (async () => {
+      const url = `${this.baseUrl}/api/widget/team-by-slug?teamSlug=${encodeURIComponent(this.teamSlug)}`;
+      const res = await globalThis.fetch(url, { method: "GET", headers: this.authHeaders() });
+      if (!res.ok) {
+        throw new Error(
+          `QuickHelpClient: could not resolve teamSlug "${this.teamSlug}" (HTTP ${res.status}).`
+        );
+      }
+      const body = await res.json();
+      const id = body?.data?.teamId;
+      if (!id) {
+        throw new Error(
+          `QuickHelpClient: lookup for teamSlug "${this.teamSlug}" returned no teamId.`
+        );
+      }
+      this.teamId = id;
+      return id;
+    })();
+    try {
+      return await this.resolveTeamIdPromise;
+    } catch (err) {
+      this.resolveTeamIdPromise = null;
+      throw err;
+    }
   }
   /**
    * Fetch the sanitized public config (title, subtitle, placeholder,
@@ -16,8 +215,9 @@ var QuickHelpClient = class {
    * Returns `null` if Quick Help is disabled on the team (404).
    */
   async config() {
-    const url = `${this.baseUrl}/api/quickhelp/config/${encodeURIComponent(this.teamId)}`;
-    const res = await globalThis.fetch(url, { method: "GET" });
+    const teamId = await this.resolveTeamId();
+    const url = `${this.baseUrl}/api/quickhelp/config/${encodeURIComponent(teamId)}`;
+    const res = await globalThis.fetch(url, { method: "GET", headers: this.authHeaders() });
     if (res.status === 404) return null;
     if (!res.ok) {
       const body2 = await res.json().catch(() => null);
@@ -33,18 +233,29 @@ var QuickHelpClient = class {
    * property set from the response body.
    */
   async ask(params) {
+    const teamId = await this.resolveTeamId();
     const url = `${this.baseUrl}/api/quickhelp/ask`;
     const res = await globalThis.fetch(url, {
       method: "POST",
-      headers: { "Content-Type": "application/json" },
+      headers: { "Content-Type": "application/json", ...this.authHeaders() },
       body: JSON.stringify({
-        team_id: this.teamId,
+        team_id: teamId,
         session_id: params.sessionId ?? null,
         question: params.question
       })
     });
     const body = await res.json().catch(() => null);
     if (!res.ok || !body?.success || !body.data) {
+      if (res.status === 503 || body?.error?.code === "feature_not_configured") {
+        throw new CStarFeatureDisabledError(res.status, {
+          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",
+          feature: "quickHelp",
+          enable_url: `${this.baseUrl}/team/${encodeURIComponent(teamId)}/settings?section=quickHelp`
+        });
+      }
       const message = body?.error?.message ?? `Quick Help ask failed: ${res.status}`;
       const err = new QuickHelpError(message, {
         status: res.status,

package/dist/webhook/index.cjs

@@ -21,9 +21,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var webhook_exports = {};
 __export(webhook_exports, {
   WebhookSignatureVerificationError: () => WebhookSignatureVerificationError,
-  constructEvent: () => constructEvent,
   constructEventAsync: () => constructEventAsync,
-  verifySignature: () => verifySignature,
   verifySignatureAsync: () => verifySignatureAsync
 });
 module.exports = __toCommonJS(webhook_exports);
@@ -33,14 +31,6 @@ var WebhookSignatureVerificationError = class extends Error {
     this.name = "WebhookSignatureVerificationError";
   }
 };
-function constructEvent(rawBody, signature, secret) {
-  if (!verifySignature(rawBody, signature, secret)) {
-    throw new WebhookSignatureVerificationError(
-      "Webhook signature verification failed. Ensure you are using the raw request body and the correct endpoint secret."
-    );
-  }
-  return JSON.parse(rawBody);
-}
 async function constructEventAsync(rawBody, signature, secret) {
   const valid = await verifySignatureAsync(rawBody, signature, secret);
   if (!valid) {
@@ -50,12 +40,6 @@ async function constructEventAsync(rawBody, signature, secret) {
   }
   return JSON.parse(rawBody);
 }
-function verifySignature(rawBody, signature, secret) {
-  const crypto2 = require("crypto");
-  const expected = "sha256=" + crypto2.createHmac("sha256", secret).update(rawBody).digest("hex");
-  if (signature.length !== expected.length) return false;
-  return crypto2.timingSafeEqual(Buffer.from(signature), Buffer.from(expected));
-}
 async function verifySignatureAsync(rawBody, signature, secret) {
   const encoder = new TextEncoder();
   const key = await crypto.subtle.importKey(
@@ -77,8 +61,6 @@ async function verifySignatureAsync(rawBody, signature, secret) {
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   WebhookSignatureVerificationError,
-  constructEvent,
   constructEventAsync,
-  verifySignature,
   verifySignatureAsync
 });