Skip to main content

Changelog

What changed and when. We follow semver. Breaking changes get a 30-day notice before they ship — no surprises in your error logs on a Friday.

API v1 (Current)

SPA rebind for Quick Help: window.CStarQuickHelp.rescan()

  • Quick Help embeds (data-cstar-quickhelp) now have the same SPA rebind escape hatch that CStarChat and CStarLibrary already shipped: window.CStarQuickHelp.rescan() can be called from a router lifecycle hook after a client-side navigation. Hosts mounted by an earlier route stay mounted; new hosts get discovered and bound; detached hosts get cleaned up so the internal instance list doesn't grow unbounded.
  • Works in two states: if Quick Help wasn't enabled or wasn't on the page at first load, the stub-level rescan() triggers a fresh init (config fetch + module load + mount). If the real api was already installed, rescan() just re-walks the DOM. Both paths are idempotent — calling rescan() repeatedly is safe.
  • WIDGET_VERSION bumps 56; existing customers pick up the new code on next page load.

CLI 0.8.5 — community topics subcommand group

  • cstar community topics create / update / delete — full topic CRUD via the CLI. Previously only listed via cstar community topics. Bare topics still defaults to listing.
  • Publish-order fix: @cstar.help/js@0.16.0 needs to ship to npm before any @cstar.help/cli@0.8.3+ install will resolve. The CLI imports WEBHOOK_EVENT_CATALOG as a runtime symbol added in SDK 0.16.0; 0.15.x doesn't have it. CLI 0.8.5 keeps the same dep range; both packages ship together.

SPA support: window.CStarChat.rescan()

  • Single-page apps (SvelteKit, React Router, Next.js App Router, etc.) can now call window.CStarChat.rescan() after a client-side route change to re-bind any newly-mounted data-cstar-* elements. window.CStarLibrary.rescan() does the same for library widgets.
  • The widget's MutationObserver was also widened to catch panels, message containers, input elements, and other data-cstar-* markup — previously only newly-mounted launchers triggered a re-bind.
  • cstar community topics create, topics update, and topics delete CLI commands now expose the topic CRUD that was previously only reachable from the dashboard. (CLI 0.8.5+; the earlier 0.8.4 used flat topic-create names but that version was never installable due to the SDK publish-order block above.)

Current SDK versions

  • @cstar.help/js@0.16.0 — bare-resource returns, nine entry points (admin, auth, chat, library, community, quickhelp, proactive, webhook, webhook/node), typed error classes, per-call client.lastMeta, optional offline queue, exports WEBHOOK_EVENT_CATALOG as a runtime symbol consumed by the CLI.
  • @cstar.help/react@0.10.0 — chat, library, community, and dashboard providers with matching hooks; SSR-safe.
  • @cstar.help/svelte@0.9.0 — Svelte 5 rune-based state classes for chat, library, community, and dashboard; subpath exports dropped (single root entry).
  • @cstar.help/cli@0.8.5 — 21 commands including automations, seed, create, tutorial, doctor, env, config, community topics create/update/delete; 19 MCP tools.
  • Webhook signatures use Stripe-style format (t=<unix>,v1=<hex>) with 300s replay tolerance. Legacy sha256=<hex> is still verified for backward compatibility but no longer emitted.

SDK v0.2.0 — Customer Auth & Library

  • @cstar.help/js/auth — New AuthClient for customer signup, login, and session management
  • LibraryClient — New popularArticles() and stats() methods for public knowledge bases
  • All SDK packages bumped to v0.2.0 (js, cli, react, svelte)
  • 115 tests passing across the JS SDK (13 new auth tests)

Developer Portal Launch

  • Developer documentation portal at /developers
  • Interactive API playground with live requests
  • Framework-specific quickstart guides (React, Svelte, vanilla JS)

CLI Tool + MCP Server

  • @cstar.help/cli — developer CLI with 9 commands
  • MCP server mode for AI agent integration (cstar mcp-server --stdio)
  • Webhook forwarding (cstar listen) for local development
  • API request log streaming (cstar logs --tail)

Framework SDKs

  • @cstar.help/react — React hooks with 34 tests
  • @cstar.help/svelte — Svelte 5 rune classes with 32 tests
  • Real-time message and typing subscriptions

TypeScript SDK

  • @cstar.help/js — Core TypeScript client with 102 tests
  • Full CRUD for tickets, customers, articles, and webhooks
  • Webhook signature verification utilities

REST API Foundation

  • REST API v1 at /api/v1/teams/{teamId}
  • API key authentication (secret + publishable)
  • Rate limiting (1,000 req/hour secret, 100 req/hour publishable)
  • Webhook delivery with HMAC-SHA256 signing and retry logic
  • Gamification events: boss battles, level-ups, achievements