@cstar.help/js 0.12.0 → 0.13.0

package/dist/quickhelp/index.js

@@ -1,3 +1,155 @@
+// 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 {
@@ -7,6 +159,16 @@ var QuickHelpClient = class {
     }
     this.baseUrl = (config.baseUrl ?? DEFAULT_BASE_URL).replace(/\/+$/, "");
     this.teamId = config.teamId;
+    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}` } : {};
   }
   /**
    * Fetch the sanitized public config (title, subtitle, placeholder,
@@ -17,7 +179,7 @@ var QuickHelpClient = class {
    */
   async config() {
     const url = `${this.baseUrl}/api/quickhelp/config/${encodeURIComponent(this.teamId)}`;
-    const res = await globalThis.fetch(url, { method: "GET" });
+    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);
@@ -36,7 +198,7 @@ var QuickHelpClient = class {
     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,
         session_id: params.sessionId ?? null,
@@ -45,6 +207,16 @@ var QuickHelpClient = class {
     });
     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(this.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
 });

package/dist/webhook/index.d.cts

@@ -298,6 +298,10 @@ interface TicketClosedPayload {
         channel: string;
         resolved_at: string;
     };
+    changes?: Record<string, {
+        from: string;
+        to: string;
+    }>;
 }
 /** Payload for `ticket.created` events. */
 interface TicketCreatedPayload {
@@ -350,12 +354,13 @@ interface TicketUpdatedPayload {
         priority: string;
         channel: string;
     };
-    changes: {
-        priority: {
-            from: string;
-            to: string;
-        };
-    };
+    changes?: Record<string, {
+        from: string;
+        to: string;
+    } | {
+        from: Array<string>;
+        to: Array<string>;
+    }>;
 }
 /** Maps each event type to its payload interface — used internally for the discriminated union. */
 interface WebhookEventDataMap {
@@ -412,23 +417,12 @@ declare class WebhookSignatureVerificationError extends Error {
     constructor(message: string);
 }
 /**
- * Verify a webhook signature and parse the event (synchronous, Node.js only).
+ * Verify a webhook signature and parse the event.
  *
- * Uses Node.js `crypto` module for timing-safe HMAC comparison.
- * For browser/edge environments, use `constructEventAsync()`.
+ * Uses the Web Crypto API — works in browsers, Cloudflare Workers, Vercel Edge,
+ * Deno, Bun, and Node.js 18+. This is the recommended API for all runtimes.
  *
- * @param rawBody - Raw request body as a string (NOT parsed JSON)
- * @param signature - Value of the `X-Signature` header
- * @param secret - Your webhook endpoint's secret (`whsec_*`)
- * @returns Parsed and verified webhook event
- * @throws {WebhookSignatureVerificationError} If verification fails
- */
-declare function constructEvent(rawBody: string, signature: string, secret: string): WebhookEvent;
-/**
- * Verify a webhook signature and parse the event (async, works everywhere).
- *
- * Uses the Web Crypto API — compatible with browsers, Deno, Cloudflare Workers,
- * and Node.js 18+.
+ * For a synchronous Node-only variant, import from `@cstar.help/js/webhook/node`.
  *
  * @param rawBody - Raw request body as a string (NOT parsed JSON)
  * @param signature - Value of the `X-Signature` header
@@ -438,14 +432,9 @@ declare function constructEvent(rawBody: string, signature: string, secret: stri
  */
 declare function constructEventAsync(rawBody: string, signature: string, secret: string): Promise<WebhookEvent>;
 /**
- * Verify an HMAC-SHA256 signature (synchronous, Node.js only).
- * Uses timing-safe comparison to prevent timing attacks.
- */
-declare function verifySignature(rawBody: string, signature: string, secret: string): boolean;
-/**
- * Verify an HMAC-SHA256 signature (async, works everywhere).
- * Uses the Web Crypto API with constant-time comparison.
+ * Verify an HMAC-SHA256 signature using the Web Crypto API.
+ * Constant-time comparison to prevent timing attacks.
  */
 declare function verifySignatureAsync(rawBody: string, signature: string, secret: string): Promise<boolean>;
 
-export { type WebhookEvent, WebhookSignatureVerificationError, constructEvent, constructEventAsync, verifySignature, verifySignatureAsync };
+export { type WebhookEvent, WebhookSignatureVerificationError, constructEventAsync, verifySignatureAsync };

package/dist/webhook/index.d.ts

@@ -298,6 +298,10 @@ interface TicketClosedPayload {
         channel: string;
         resolved_at: string;
     };
+    changes?: Record<string, {
+        from: string;
+        to: string;
+    }>;
 }
 /** Payload for `ticket.created` events. */
 interface TicketCreatedPayload {
@@ -350,12 +354,13 @@ interface TicketUpdatedPayload {
         priority: string;
         channel: string;
     };
-    changes: {
-        priority: {
-            from: string;
-            to: string;
-        };
-    };
+    changes?: Record<string, {
+        from: string;
+        to: string;
+    } | {
+        from: Array<string>;
+        to: Array<string>;
+    }>;
 }
 /** Maps each event type to its payload interface — used internally for the discriminated union. */
 interface WebhookEventDataMap {
@@ -412,23 +417,12 @@ declare class WebhookSignatureVerificationError extends Error {
     constructor(message: string);
 }
 /**
- * Verify a webhook signature and parse the event (synchronous, Node.js only).
+ * Verify a webhook signature and parse the event.
  *
- * Uses Node.js `crypto` module for timing-safe HMAC comparison.
- * For browser/edge environments, use `constructEventAsync()`.
+ * Uses the Web Crypto API — works in browsers, Cloudflare Workers, Vercel Edge,
+ * Deno, Bun, and Node.js 18+. This is the recommended API for all runtimes.
  *
- * @param rawBody - Raw request body as a string (NOT parsed JSON)
- * @param signature - Value of the `X-Signature` header
- * @param secret - Your webhook endpoint's secret (`whsec_*`)
- * @returns Parsed and verified webhook event
- * @throws {WebhookSignatureVerificationError} If verification fails
- */
-declare function constructEvent(rawBody: string, signature: string, secret: string): WebhookEvent;
-/**
- * Verify a webhook signature and parse the event (async, works everywhere).
- *
- * Uses the Web Crypto API — compatible with browsers, Deno, Cloudflare Workers,
- * and Node.js 18+.
+ * For a synchronous Node-only variant, import from `@cstar.help/js/webhook/node`.
  *
  * @param rawBody - Raw request body as a string (NOT parsed JSON)
  * @param signature - Value of the `X-Signature` header
@@ -438,14 +432,9 @@ declare function constructEvent(rawBody: string, signature: string, secret: stri
  */
 declare function constructEventAsync(rawBody: string, signature: string, secret: string): Promise<WebhookEvent>;
 /**
- * Verify an HMAC-SHA256 signature (synchronous, Node.js only).
- * Uses timing-safe comparison to prevent timing attacks.
- */
-declare function verifySignature(rawBody: string, signature: string, secret: string): boolean;
-/**
- * Verify an HMAC-SHA256 signature (async, works everywhere).
- * Uses the Web Crypto API with constant-time comparison.
+ * Verify an HMAC-SHA256 signature using the Web Crypto API.
+ * Constant-time comparison to prevent timing attacks.
  */
 declare function verifySignatureAsync(rawBody: string, signature: string, secret: string): Promise<boolean>;
 
-export { type WebhookEvent, WebhookSignatureVerificationError, constructEvent, constructEventAsync, verifySignature, verifySignatureAsync };
+export { type WebhookEvent, WebhookSignatureVerificationError, constructEventAsync, verifySignatureAsync };

package/dist/webhook/index.js

@@ -1,10 +1,3 @@
-var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
-  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
-}) : x)(function(x) {
-  if (typeof require !== "undefined") return require.apply(this, arguments);
-  throw Error('Dynamic require of "' + x + '" is not supported');
-});
-
 // src/webhook/index.ts
 var WebhookSignatureVerificationError = class extends Error {
   constructor(message) {
@@ -12,14 +5,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) {
@@ -29,12 +14,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(
@@ -55,8 +34,6 @@ async function verifySignatureAsync(rawBody, signature, secret) {
 }
 export {
   WebhookSignatureVerificationError,
-  constructEvent,
   constructEventAsync,
-  verifySignature,
   verifySignatureAsync
 };

package/dist/webhook/node.cjs

@@ -0,0 +1,57 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/webhook/node.ts
+var node_exports = {};
+__export(node_exports, {
+  WebhookSignatureVerificationError: () => WebhookSignatureVerificationError,
+  constructEvent: () => constructEvent,
+  verifySignature: () => verifySignature
+});
+module.exports = __toCommonJS(node_exports);
+var import_node_crypto = require("crypto");
+
+// src/webhook/index.ts
+var WebhookSignatureVerificationError = class extends Error {
+  constructor(message) {
+    super(message);
+    this.name = "WebhookSignatureVerificationError";
+  }
+};
+
+// src/webhook/node.ts
+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);
+}
+function verifySignature(rawBody, signature, secret) {
+  const expected = "sha256=" + (0, import_node_crypto.createHmac)("sha256", secret).update(rawBody).digest("hex");
+  if (signature.length !== expected.length) return false;
+  return (0, import_node_crypto.timingSafeEqual)(Buffer.from(signature), Buffer.from(expected));
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  WebhookSignatureVerificationError,
+  constructEvent,
+  verifySignature
+});