@cstar.help/js 0.11.0 → 0.12.1

package/dist/webhook/index.d.cts

@@ -1,163 +0,0 @@
-/** Metadata: string key-value pairs. Max 50 keys, 40-char keys, 500-char values. */
-type Metadata = Record<string, string>;
-
-/** A message on a ticket. */
-interface Message {
-    id: string;
-    object: 'message';
-    sender: 'customer' | 'agent' | 'system';
-    content: string;
-    senderId: string | null;
-    senderName: string | null;
-    senderAvatarUrl: string | null;
-    createdAt: string;
-    mergedFromShortId: string | null;
-}
-
-/** A cStar support ticket. */
-interface Ticket {
-    id: string;
-    object: 'ticket';
-    title: string;
-    priority: 'low' | 'normal' | 'high' | 'urgent';
-    status: string;
-    customerId: string | null;
-    customerName: string | null;
-    assignedTo: string | null;
-    tags: string[];
-    notes: string | null;
-    messageCount: number;
-    responseDeadline: string | null;
-    resolutionDeadline: string | null;
-    firstResponseAt: string | null;
-    responseTier: string | null;
-    resolutionTier: string | null;
-    slaPaused: boolean;
-    metadata: Metadata;
-    createdAt: string;
-    closedAt: string | null;
-    updatedAt: string;
-    /** Present when expand includes 'messages' or on single-ticket GET. */
-    messages?: Message[];
-    /** Present when expand includes 'customer'. */
-    customer?: TicketCustomerSummary | null;
-}
-/** Inline customer summary when expanding on a ticket. */
-interface TicketCustomerSummary {
-    id: string;
-    object: 'customer';
-    name: string;
-    email: string;
-    sentiment: string;
-    status: string;
-}
-
-/** A cStar customer. */
-interface Customer {
-    id: string;
-    object: 'customer';
-    name: string;
-    email: string;
-    sentiment: string;
-    status: string;
-    tags: string[];
-    notes: string | null;
-    customFields: Record<string, unknown>;
-    ticketCount: number;
-    metadata: Metadata;
-    createdAt: string;
-    updatedAt: string;
-}
-
-/** A cStar knowledge base article. */
-interface Article {
-    id: string;
-    object: 'article';
-    title: string;
-    slug: string | null;
-    excerpt: string | null;
-    content: string | null;
-    categoryId: string | null;
-    status: 'draft' | 'published';
-    tags: string[];
-    notes: string | null;
-    viewCount: number;
-    useCount: number;
-    readTime: string;
-    isPublic: boolean;
-    publishedAt: string | null;
-    metaDescription: string | null;
-    metadata: Metadata;
-    createdAt: string;
-    updatedAt: string;
-}
-
-/** All webhook event types supported by cStar. */
-type WebhookEventType = 'ticket.created' | 'ticket.updated' | 'ticket.closed' | 'ticket.message_added' | 'customer.created' | 'customer.updated' | 'article.created' | 'article.published' | 'article.updated' | 'boss.spawned' | 'boss.defeated' | 'player.level_up' | 'achievement.unlocked' | 'survey.submitted';
-/** A webhook event delivered to your endpoint. */
-interface WebhookEvent<T extends WebhookEventType = WebhookEventType> {
-    /** Unique event ID (idempotency key). */
-    id: string;
-    /** Event type. */
-    type: T;
-    /** When the event was created (ISO 8601). */
-    created_at: string;
-    /** Team that owns this event. */
-    team_id: string;
-    /** Event-specific payload. */
-    data: WebhookEventData<T>;
-}
-/** Discriminated union mapping event types to their data payloads. */
-type WebhookEventData<T extends WebhookEventType> = T extends 'ticket.created' | 'ticket.updated' | 'ticket.closed' ? {
-    ticket: Ticket;
-} : T extends 'ticket.message_added' ? {
-    ticket: Ticket;
-    message: Message;
-} : T extends 'customer.created' | 'customer.updated' ? {
-    customer: Customer;
-} : T extends 'article.created' | 'article.published' | 'article.updated' ? {
-    article: Article;
-} : Record<string, unknown>;
-
-/** Thrown when webhook signature verification fails. */
-declare class WebhookSignatureVerificationError extends Error {
-    constructor(message: string);
-}
-/**
- * Verify a webhook signature and parse the event (synchronous, Node.js only).
- *
- * Uses Node.js `crypto` module for timing-safe HMAC comparison.
- * For browser/edge environments, use `constructEventAsync()`.
- *
- * @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+.
- *
- * @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 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.
- */
-declare function verifySignatureAsync(rawBody: string, signature: string, secret: string): Promise<boolean>;
-
-export { type WebhookEvent, WebhookSignatureVerificationError, constructEvent, constructEventAsync, verifySignature, verifySignatureAsync };

package/dist/webhook/index.d.ts

@@ -1,163 +0,0 @@
-/** Metadata: string key-value pairs. Max 50 keys, 40-char keys, 500-char values. */
-type Metadata = Record<string, string>;
-
-/** A message on a ticket. */
-interface Message {
-    id: string;
-    object: 'message';
-    sender: 'customer' | 'agent' | 'system';
-    content: string;
-    senderId: string | null;
-    senderName: string | null;
-    senderAvatarUrl: string | null;
-    createdAt: string;
-    mergedFromShortId: string | null;
-}
-
-/** A cStar support ticket. */
-interface Ticket {
-    id: string;
-    object: 'ticket';
-    title: string;
-    priority: 'low' | 'normal' | 'high' | 'urgent';
-    status: string;
-    customerId: string | null;
-    customerName: string | null;
-    assignedTo: string | null;
-    tags: string[];
-    notes: string | null;
-    messageCount: number;
-    responseDeadline: string | null;
-    resolutionDeadline: string | null;
-    firstResponseAt: string | null;
-    responseTier: string | null;
-    resolutionTier: string | null;
-    slaPaused: boolean;
-    metadata: Metadata;
-    createdAt: string;
-    closedAt: string | null;
-    updatedAt: string;
-    /** Present when expand includes 'messages' or on single-ticket GET. */
-    messages?: Message[];
-    /** Present when expand includes 'customer'. */
-    customer?: TicketCustomerSummary | null;
-}
-/** Inline customer summary when expanding on a ticket. */
-interface TicketCustomerSummary {
-    id: string;
-    object: 'customer';
-    name: string;
-    email: string;
-    sentiment: string;
-    status: string;
-}
-
-/** A cStar customer. */
-interface Customer {
-    id: string;
-    object: 'customer';
-    name: string;
-    email: string;
-    sentiment: string;
-    status: string;
-    tags: string[];
-    notes: string | null;
-    customFields: Record<string, unknown>;
-    ticketCount: number;
-    metadata: Metadata;
-    createdAt: string;
-    updatedAt: string;
-}
-
-/** A cStar knowledge base article. */
-interface Article {
-    id: string;
-    object: 'article';
-    title: string;
-    slug: string | null;
-    excerpt: string | null;
-    content: string | null;
-    categoryId: string | null;
-    status: 'draft' | 'published';
-    tags: string[];
-    notes: string | null;
-    viewCount: number;
-    useCount: number;
-    readTime: string;
-    isPublic: boolean;
-    publishedAt: string | null;
-    metaDescription: string | null;
-    metadata: Metadata;
-    createdAt: string;
-    updatedAt: string;
-}
-
-/** All webhook event types supported by cStar. */
-type WebhookEventType = 'ticket.created' | 'ticket.updated' | 'ticket.closed' | 'ticket.message_added' | 'customer.created' | 'customer.updated' | 'article.created' | 'article.published' | 'article.updated' | 'boss.spawned' | 'boss.defeated' | 'player.level_up' | 'achievement.unlocked' | 'survey.submitted';
-/** A webhook event delivered to your endpoint. */
-interface WebhookEvent<T extends WebhookEventType = WebhookEventType> {
-    /** Unique event ID (idempotency key). */
-    id: string;
-    /** Event type. */
-    type: T;
-    /** When the event was created (ISO 8601). */
-    created_at: string;
-    /** Team that owns this event. */
-    team_id: string;
-    /** Event-specific payload. */
-    data: WebhookEventData<T>;
-}
-/** Discriminated union mapping event types to their data payloads. */
-type WebhookEventData<T extends WebhookEventType> = T extends 'ticket.created' | 'ticket.updated' | 'ticket.closed' ? {
-    ticket: Ticket;
-} : T extends 'ticket.message_added' ? {
-    ticket: Ticket;
-    message: Message;
-} : T extends 'customer.created' | 'customer.updated' ? {
-    customer: Customer;
-} : T extends 'article.created' | 'article.published' | 'article.updated' ? {
-    article: Article;
-} : Record<string, unknown>;
-
-/** Thrown when webhook signature verification fails. */
-declare class WebhookSignatureVerificationError extends Error {
-    constructor(message: string);
-}
-/**
- * Verify a webhook signature and parse the event (synchronous, Node.js only).
- *
- * Uses Node.js `crypto` module for timing-safe HMAC comparison.
- * For browser/edge environments, use `constructEventAsync()`.
- *
- * @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+.
- *
- * @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 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.
- */
-declare function verifySignatureAsync(rawBody: string, signature: string, secret: string): Promise<boolean>;
-
-export { type WebhookEvent, WebhookSignatureVerificationError, constructEvent, constructEventAsync, verifySignature, verifySignatureAsync };