@cstar.help/js 0.2.1 → 0.3.1

package/dist/auth/index.cjs

@@ -23,7 +23,7 @@ __export(auth_exports, {
   AuthClient: () => AuthClient
 });
 module.exports = __toCommonJS(auth_exports);
-var DEFAULT_BASE_URL = "https://app.cstar.help";
+var DEFAULT_BASE_URL = "https://www.cstar.help";
 var AuthClient = class {
   constructor(config) {
     this.session = null;

package/dist/auth/index.d.cts

@@ -2,7 +2,7 @@
 interface AuthConfig {
     /** Team slug (e.g., 'acme'). Identifies which team's customers to authenticate. */
     teamSlug: string;
-    /** Override the base URL (defaults to https://app.cstar.help). */
+    /** Override the base URL (defaults to https://www.cstar.help). */
     baseUrl?: string;
 }
 /** A customer identity returned from auth endpoints. */

package/dist/auth/index.d.ts

@@ -2,7 +2,7 @@
 interface AuthConfig {
     /** Team slug (e.g., 'acme'). Identifies which team's customers to authenticate. */
     teamSlug: string;
-    /** Override the base URL (defaults to https://app.cstar.help). */
+    /** Override the base URL (defaults to https://www.cstar.help). */
     baseUrl?: string;
 }
 /** A customer identity returned from auth endpoints. */

package/dist/auth/index.js

@@ -1,5 +1,5 @@
 // src/auth/index.ts
-var DEFAULT_BASE_URL = "https://app.cstar.help";
+var DEFAULT_BASE_URL = "https://www.cstar.help";
 var AuthClient = class {
   constructor(config) {
     this.session = null;

package/dist/chat/index.cjs

@@ -275,7 +275,7 @@ var PresenceManager = class {
 };
 
 // src/chat/index.ts
-var DEFAULT_BASE_URL = "https://app.cstar.help";
+var DEFAULT_BASE_URL = "https://www.cstar.help";
 var DEFAULT_POLLING_INTERVAL = 3e3;
 var ChatClient = class {
   constructor(config) {

package/dist/chat/index.d.cts

@@ -2,7 +2,7 @@
 interface ChatConfig {
     /** Team slug (e.g., 'acme'). Used to identify the team. */
     teamSlug: string;
-    /** Override the base URL (defaults to https://app.cstar.help). */
+    /** Override the base URL (defaults to https://www.cstar.help). */
     baseUrl?: string;
     /** Supabase project URL for realtime subscriptions (optional). */
     supabaseUrl?: string;

package/dist/chat/index.d.ts

@@ -2,7 +2,7 @@
 interface ChatConfig {
     /** Team slug (e.g., 'acme'). Used to identify the team. */
     teamSlug: string;
-    /** Override the base URL (defaults to https://app.cstar.help). */
+    /** Override the base URL (defaults to https://www.cstar.help). */
     baseUrl?: string;
     /** Supabase project URL for realtime subscriptions (optional). */
     supabaseUrl?: string;

package/dist/chat/index.js

@@ -239,7 +239,7 @@ var PresenceManager = class {
 };
 
 // src/chat/index.ts
-var DEFAULT_BASE_URL = "https://app.cstar.help";
+var DEFAULT_BASE_URL = "https://www.cstar.help";
 var DEFAULT_POLLING_INTERVAL = 3e3;
 var ChatClient = class {
   constructor(config) {

package/dist/index.cjs

@@ -97,8 +97,8 @@ function parseError(statusCode, body, retryAfter) {
 }
 
 // src/client.ts
-var SDK_VERSION = "0.2.0";
-var DEFAULT_BASE_URL = "https://app.cstar.help";
+var SDK_VERSION = "0.2.1";
+var DEFAULT_BASE_URL = "https://www.cstar.help";
 var DEFAULT_API_VERSION = "2026-03-01";
 var DEFAULT_MAX_RETRIES = 3;
 var DEFAULT_TIMEOUT = 3e4;
@@ -328,6 +328,13 @@ var WebhooksResource = class extends BaseResource {
   }
 };
 
+// src/resources/categories.ts
+var CategoriesResource = class extends BaseResource {
+  constructor(client) {
+    super(client, "/categories");
+  }
+};
+
 // src/index.ts
 var CStarClient = class {
   constructor(config) {
@@ -336,6 +343,7 @@ var CStarClient = class {
     this.customers = new CustomersResource(this.client);
     this.articles = new ArticlesResource(this.client);
     this.webhooks = new WebhooksResource(this.client);
+    this.categories = new CategoriesResource(this.client);
   }
   /** Whether this client is using test mode keys (sk_test_* or pk_test_*). */
   get isTestMode() {

package/dist/index.d.cts

@@ -429,6 +429,48 @@ declare class WebhooksResource extends BaseResource<Webhook, WebhookListParams,
     }): Promise<ApiResponse<WebhookTestResult>>;
 }
 
+/** A cStar article category. */
+interface Category {
+    id: string;
+    object: 'category';
+    name: string;
+    slug: string;
+    description: string | null;
+    icon: string | null;
+    color: string | null;
+    sortOrder: number;
+    isPublic: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+/** Parameters for listing categories. */
+interface CategoryListParams extends PaginationParams {
+    isPublic?: boolean;
+}
+/** Parameters for creating a category. */
+interface CategoryCreateParams {
+    name: string;
+    description?: string;
+    icon?: string;
+    color?: string;
+    sortOrder?: number;
+    isPublic?: boolean;
+}
+/** Parameters for updating a category. */
+interface CategoryUpdateParams {
+    name?: string;
+    description?: string;
+    icon?: string;
+    color?: string;
+    sortOrder?: number;
+    isPublic?: boolean;
+}
+
+/** Manage article categories. */
+declare class CategoriesResource extends BaseResource<Category, CategoryListParams, CategoryCreateParams, CategoryUpdateParams> {
+    constructor(client: HttpClient);
+}
+
 /** Error type constants matching the cStar API. */
 declare const ErrorType: {
     readonly AUTHENTICATION_ERROR: "authentication_error";
@@ -480,7 +522,7 @@ interface CStarClientConfig {
     apiKey: string;
     /** Your team ID. */
     teamId: string;
-    /** Override the base URL (defaults to https://app.cstar.help). */
+    /** Override the base URL (defaults to https://www.cstar.help). */
     baseUrl?: string;
     /** API version header (defaults to 2026-03-01). */
     version?: string;
@@ -510,10 +552,12 @@ declare class CStarClient {
     readonly articles: ArticlesResource;
     /** Manage webhook endpoints. */
     readonly webhooks: WebhooksResource;
+    /** Manage article categories. */
+    readonly categories: CategoriesResource;
     private readonly client;
     constructor(config: CStarClientConfig);
     /** Whether this client is using test mode keys (sk_test_* or pk_test_*). */
     get isTestMode(): boolean;
 }
 
-export { type ApiErrorBody, type ApiResponse, type Article, type ArticleCreateParams, type ArticleListParams, type ArticleUpdateParams, CStarAuthenticationError, CStarClient, type CStarClientConfig, CStarError, CStarNotFoundError, CStarRateLimitError, CStarValidationError, type Customer, type CustomerCreateParams, type CustomerListParams, type CustomerUpdateParams, type DeleteResponse, ErrorType, type ListResponse, type Message, type MessageCreateParams, type Metadata, type PaginationInfo, type PaginationParams, type RequestOptions, type Ticket, type TicketCreateParams, type TicketCustomerSummary, type TicketListParams, type TicketUpdateParams, type Webhook, type WebhookCreateParams, type WebhookEvent, type WebhookEventData, type WebhookEventType, type WebhookListParams, type WebhookTestResult, type WebhookUpdateParams };
+export { type ApiErrorBody, type ApiResponse, type Article, type ArticleCreateParams, type ArticleListParams, type ArticleUpdateParams, CStarAuthenticationError, CStarClient, type CStarClientConfig, CStarError, CStarNotFoundError, CStarRateLimitError, CStarValidationError, type Category, type CategoryCreateParams, type CategoryListParams, type CategoryUpdateParams, type Customer, type CustomerCreateParams, type CustomerListParams, type CustomerUpdateParams, type DeleteResponse, ErrorType, type ListResponse, type Message, type MessageCreateParams, type Metadata, type PaginationInfo, type PaginationParams, type RequestOptions, type Ticket, type TicketCreateParams, type TicketCustomerSummary, type TicketListParams, type TicketUpdateParams, type Webhook, type WebhookCreateParams, type WebhookEvent, type WebhookEventData, type WebhookEventType, type WebhookListParams, type WebhookTestResult, type WebhookUpdateParams };

package/dist/index.d.ts

@@ -429,6 +429,48 @@ declare class WebhooksResource extends BaseResource<Webhook, WebhookListParams,
     }): Promise<ApiResponse<WebhookTestResult>>;
 }
 
+/** A cStar article category. */
+interface Category {
+    id: string;
+    object: 'category';
+    name: string;
+    slug: string;
+    description: string | null;
+    icon: string | null;
+    color: string | null;
+    sortOrder: number;
+    isPublic: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+/** Parameters for listing categories. */
+interface CategoryListParams extends PaginationParams {
+    isPublic?: boolean;
+}
+/** Parameters for creating a category. */
+interface CategoryCreateParams {
+    name: string;
+    description?: string;
+    icon?: string;
+    color?: string;
+    sortOrder?: number;
+    isPublic?: boolean;
+}
+/** Parameters for updating a category. */
+interface CategoryUpdateParams {
+    name?: string;
+    description?: string;
+    icon?: string;
+    color?: string;
+    sortOrder?: number;
+    isPublic?: boolean;
+}
+
+/** Manage article categories. */
+declare class CategoriesResource extends BaseResource<Category, CategoryListParams, CategoryCreateParams, CategoryUpdateParams> {
+    constructor(client: HttpClient);
+}
+
 /** Error type constants matching the cStar API. */
 declare const ErrorType: {
     readonly AUTHENTICATION_ERROR: "authentication_error";
@@ -480,7 +522,7 @@ interface CStarClientConfig {
     apiKey: string;
     /** Your team ID. */
     teamId: string;
-    /** Override the base URL (defaults to https://app.cstar.help). */
+    /** Override the base URL (defaults to https://www.cstar.help). */
     baseUrl?: string;
     /** API version header (defaults to 2026-03-01). */
     version?: string;
@@ -510,10 +552,12 @@ declare class CStarClient {
     readonly articles: ArticlesResource;
     /** Manage webhook endpoints. */
     readonly webhooks: WebhooksResource;
+    /** Manage article categories. */
+    readonly categories: CategoriesResource;
     private readonly client;
     constructor(config: CStarClientConfig);
     /** Whether this client is using test mode keys (sk_test_* or pk_test_*). */
     get isTestMode(): boolean;
 }
 
-export { type ApiErrorBody, type ApiResponse, type Article, type ArticleCreateParams, type ArticleListParams, type ArticleUpdateParams, CStarAuthenticationError, CStarClient, type CStarClientConfig, CStarError, CStarNotFoundError, CStarRateLimitError, CStarValidationError, type Customer, type CustomerCreateParams, type CustomerListParams, type CustomerUpdateParams, type DeleteResponse, ErrorType, type ListResponse, type Message, type MessageCreateParams, type Metadata, type PaginationInfo, type PaginationParams, type RequestOptions, type Ticket, type TicketCreateParams, type TicketCustomerSummary, type TicketListParams, type TicketUpdateParams, type Webhook, type WebhookCreateParams, type WebhookEvent, type WebhookEventData, type WebhookEventType, type WebhookListParams, type WebhookTestResult, type WebhookUpdateParams };
+export { type ApiErrorBody, type ApiResponse, type Article, type ArticleCreateParams, type ArticleListParams, type ArticleUpdateParams, CStarAuthenticationError, CStarClient, type CStarClientConfig, CStarError, CStarNotFoundError, CStarRateLimitError, CStarValidationError, type Category, type CategoryCreateParams, type CategoryListParams, type CategoryUpdateParams, type Customer, type CustomerCreateParams, type CustomerListParams, type CustomerUpdateParams, type DeleteResponse, ErrorType, type ListResponse, type Message, type MessageCreateParams, type Metadata, type PaginationInfo, type PaginationParams, type RequestOptions, type Ticket, type TicketCreateParams, type TicketCustomerSummary, type TicketListParams, type TicketUpdateParams, type Webhook, type WebhookCreateParams, type WebhookEvent, type WebhookEventData, type WebhookEventType, type WebhookListParams, type WebhookTestResult, type WebhookUpdateParams };

package/dist/index.js

@@ -65,8 +65,8 @@ function parseError(statusCode, body, retryAfter) {
 }
 
 // src/client.ts
-var SDK_VERSION = "0.2.0";
-var DEFAULT_BASE_URL = "https://app.cstar.help";
+var SDK_VERSION = "0.2.1";
+var DEFAULT_BASE_URL = "https://www.cstar.help";
 var DEFAULT_API_VERSION = "2026-03-01";
 var DEFAULT_MAX_RETRIES = 3;
 var DEFAULT_TIMEOUT = 3e4;
@@ -296,6 +296,13 @@ var WebhooksResource = class extends BaseResource {
   }
 };
 
+// src/resources/categories.ts
+var CategoriesResource = class extends BaseResource {
+  constructor(client) {
+    super(client, "/categories");
+  }
+};
+
 // src/index.ts
 var CStarClient = class {
   constructor(config) {
@@ -304,6 +311,7 @@ var CStarClient = class {
     this.customers = new CustomersResource(this.client);
     this.articles = new ArticlesResource(this.client);
     this.webhooks = new WebhooksResource(this.client);
+    this.categories = new CategoriesResource(this.client);
   }
   /** Whether this client is using test mode keys (sk_test_* or pk_test_*). */
   get isTestMode() {

package/dist/library/index.cjs

@@ -23,7 +23,7 @@ __export(library_exports, {
   LibraryClient: () => LibraryClient
 });
 module.exports = __toCommonJS(library_exports);
-var DEFAULT_BASE_URL = "https://app.cstar.help";
+var DEFAULT_BASE_URL = "https://www.cstar.help";
 var LibraryClient = class {
   constructor(config) {
     this.resolvedTeamId = null;
@@ -67,6 +67,28 @@ var LibraryClient = class {
     if (params?.limit) queryParams.limit = String(params.limit);
     return this.fetch(`/api/library/${this.teamSlug}/search`, queryParams);
   }
+  /**
+   * Record a view for an article. Call this from the client when an article
+   * page is displayed to track view counts accurately.
+   *
+   * ```typescript
+   * // On article page mount
+   * await library.recordView('getting-started');
+   * ```
+   */
+  async recordView(slug) {
+    const url = `${this.baseUrl}/api/library/${this.teamSlug}/articles/${slug}/view`;
+    const response = await globalThis.fetch(url, {
+      method: "POST",
+      headers: { "Content-Type": "application/json" }
+    });
+    if (!response.ok) {
+      const errorBody = await response.json().catch(() => ({ error: "Request failed" }));
+      throw new Error(errorBody.error ?? `View tracking failed: ${response.status}`);
+    }
+    const body = await response.json();
+    return { viewCount: body.viewCount };
+  }
   /** Get the most viewed articles, sorted by view count descending. */
   async popularArticles(limit = 5) {
     const articles = await this.articles({ limit: 50 });

package/dist/library/index.d.cts

@@ -2,7 +2,7 @@
 interface LibraryConfig {
     /** Team slug (e.g., 'acme'). Identifies the knowledge base to query. */
     teamSlug: string;
-    /** Override the base URL (defaults to https://app.cstar.help). */
+    /** Override the base URL (defaults to https://www.cstar.help). */
     baseUrl?: string;
 }
 /** A published article in the public knowledge base. */
@@ -82,6 +82,18 @@ declare class LibraryClient {
      * Returns matching articles with relevance ranking.
      */
     search(query: string, params?: LibrarySearchParams): Promise<LibrarySearchResult>;
+    /**
+     * Record a view for an article. Call this from the client when an article
+     * page is displayed to track view counts accurately.
+     *
+     * ```typescript
+     * // On article page mount
+     * await library.recordView('getting-started');
+     * ```
+     */
+    recordView(slug: string): Promise<{
+        viewCount: number;
+    }>;
     /** Get the most viewed articles, sorted by view count descending. */
     popularArticles(limit?: number): Promise<LibraryArticle[]>;
     /** Get aggregate stats for this knowledge base (article count, category count, total views). */

package/dist/library/index.d.ts

@@ -2,7 +2,7 @@
 interface LibraryConfig {
     /** Team slug (e.g., 'acme'). Identifies the knowledge base to query. */
     teamSlug: string;
-    /** Override the base URL (defaults to https://app.cstar.help). */
+    /** Override the base URL (defaults to https://www.cstar.help). */
     baseUrl?: string;
 }
 /** A published article in the public knowledge base. */
@@ -82,6 +82,18 @@ declare class LibraryClient {
      * Returns matching articles with relevance ranking.
      */
     search(query: string, params?: LibrarySearchParams): Promise<LibrarySearchResult>;
+    /**
+     * Record a view for an article. Call this from the client when an article
+     * page is displayed to track view counts accurately.
+     *
+     * ```typescript
+     * // On article page mount
+     * await library.recordView('getting-started');
+     * ```
+     */
+    recordView(slug: string): Promise<{
+        viewCount: number;
+    }>;
     /** Get the most viewed articles, sorted by view count descending. */
     popularArticles(limit?: number): Promise<LibraryArticle[]>;
     /** Get aggregate stats for this knowledge base (article count, category count, total views). */

package/dist/library/index.js

@@ -1,5 +1,5 @@
 // src/library/index.ts
-var DEFAULT_BASE_URL = "https://app.cstar.help";
+var DEFAULT_BASE_URL = "https://www.cstar.help";
 var LibraryClient = class {
   constructor(config) {
     this.resolvedTeamId = null;
@@ -43,6 +43,28 @@ var LibraryClient = class {
     if (params?.limit) queryParams.limit = String(params.limit);
     return this.fetch(`/api/library/${this.teamSlug}/search`, queryParams);
   }
+  /**
+   * Record a view for an article. Call this from the client when an article
+   * page is displayed to track view counts accurately.
+   *
+   * ```typescript
+   * // On article page mount
+   * await library.recordView('getting-started');
+   * ```
+   */
+  async recordView(slug) {
+    const url = `${this.baseUrl}/api/library/${this.teamSlug}/articles/${slug}/view`;
+    const response = await globalThis.fetch(url, {
+      method: "POST",
+      headers: { "Content-Type": "application/json" }
+    });
+    if (!response.ok) {
+      const errorBody = await response.json().catch(() => ({ error: "Request failed" }));
+      throw new Error(errorBody.error ?? `View tracking failed: ${response.status}`);
+    }
+    const body = await response.json();
+    return { viewCount: body.viewCount };
+  }
   /** Get the most viewed articles, sorted by view count descending. */
   async popularArticles(limit = 5) {
     const articles = await this.articles({ limit: 50 });

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@cstar.help/js",
-	"version": "0.2.1",
+	"version": "0.3.1",
 	"description": "Official TypeScript SDK for the cStar customer support platform",
 	"type": "module",
 	"main": "./dist/index.cjs",