@cstar.help/js 0.12.1 → 0.14.0

package/dist/webhook/node.d.ts

@@ -0,0 +1,440 @@
+/** Every webhook event type cStar can dispatch. */
+type WebhookEventType = 'article.created' | 'article.deleted' | 'article.published' | 'article.updated' | 'boss.damaged' | 'boss.defeated' | 'boss.spawned' | 'community_post.commented' | 'community_post.created' | 'community_post.deleted' | 'community_post.status_changed' | 'community_post.updated' | 'community_post.voted' | 'customer.created' | 'customer.deleted' | 'customer.updated' | 'customer_group.created' | 'customer_group.deleted' | 'customer_group.updated' | 'player.achievement_unlocked' | 'player.level_up' | 'player.quest_completed' | 'player.streak_milestone' | 'player.xp_gained' | 'social.high_five_sent' | 'social.one_up_sent' | 'survey.submitted' | 'ticket.assigned' | 'ticket.closed' | 'ticket.created' | 'ticket.deleted' | 'ticket.message_added' | 'ticket.updated';
+/** Payload for `article.created` events. */
+interface ArticleCreatedPayload {
+    article: {
+        id: string;
+        title: string;
+        slug: string;
+        is_public: boolean;
+        created_at: string;
+    };
+}
+/** Payload for `article.deleted` events. */
+interface ArticleDeletedPayload {
+    id: string;
+}
+/** Payload for `article.published` events. */
+interface ArticlePublishedPayload {
+    article: {
+        id: string;
+        title: string;
+        slug: string;
+        is_public: boolean;
+        published_at: string;
+    };
+}
+/** Payload for `article.updated` events. */
+interface ArticleUpdatedPayload {
+    article: {
+        id: string;
+        title: string;
+        slug: string;
+        is_public: boolean;
+    };
+}
+/** Payload for `boss.damaged` events. */
+interface BossDamagedPayload {
+    boss: {
+        id: string;
+        current_hp: number;
+    };
+    damage: number;
+    by: {
+        agent_id: string;
+        name: string;
+    };
+}
+/** Payload for `boss.defeated` events. */
+interface BossDefeatedPayload {
+    boss: {
+        id: string;
+        name: string;
+    };
+    final_blow_by: {
+        agent_id: string;
+        name: string;
+    };
+    team_xp_awarded: number;
+}
+/** Payload for `boss.spawned` events. */
+interface BossSpawnedPayload {
+    boss: {
+        id: string;
+        name: string;
+        level: number;
+        max_hp: number;
+    };
+}
+/** Payload for `community_post.commented` events. */
+interface CommunityPostCommentedPayload {
+    comment: {
+        id: string;
+        post_id: string;
+        content: string;
+        author_id: string;
+        created_at: string;
+    };
+}
+/** Payload for `community_post.created` events. */
+interface CommunityPostCreatedPayload {
+    post: {
+        id: string;
+        prefixed_id: string;
+        title: string;
+        status: string;
+        visibility: string;
+        topic: string;
+        created_at: string;
+    };
+}
+/** Payload for `community_post.deleted` events. */
+interface CommunityPostDeletedPayload {
+    post: {
+        id: string;
+        prefixed_id?: string;
+        title?: string;
+    };
+}
+/** Payload for `community_post.status_changed` events. */
+interface CommunityPostStatusChangedPayload {
+    post: {
+        id: string;
+        title: string;
+        status: string;
+        visibility: string;
+    };
+}
+/** Payload for `community_post.updated` events. */
+interface CommunityPostUpdatedPayload {
+    post: {
+        id: string;
+        title: string;
+        status: string;
+        visibility: string;
+    };
+}
+/** Payload for `community_post.voted` events. */
+interface CommunityPostVotedPayload {
+    post: {
+        id: string;
+        vote_count: number;
+    };
+    voter: {
+        id: string;
+    };
+    direction: string;
+}
+/** Payload for `customer.created` events. */
+interface CustomerCreatedPayload {
+    customer: {
+        id: string;
+        name: string;
+        email: string;
+        status: string;
+        tags: Array<string>;
+        created_at: string;
+    };
+}
+/** Payload for `customer.deleted` events. */
+interface CustomerDeletedPayload {
+    id: string;
+}
+/** Payload for `customer.updated` events. */
+interface CustomerUpdatedPayload {
+    customer: {
+        id: string;
+        name: string;
+        email: string;
+        status: string;
+        tags: Array<string>;
+    };
+    changes: {
+        tags: {
+            from: Array<string>;
+            to: Array<string>;
+        };
+    };
+}
+/** Payload for `customer_group.created` events. */
+interface CustomerGroupCreatedPayload {
+    group: {
+        id: string;
+        name: string;
+        color: string;
+        member_count: number;
+    };
+}
+/** Payload for `customer_group.deleted` events. */
+interface CustomerGroupDeletedPayload {
+    customer_group: {
+        id: string;
+    };
+}
+/** Payload for `customer_group.updated` events. */
+interface CustomerGroupUpdatedPayload {
+    group: {
+        id: string;
+        name: string;
+        color: string;
+        member_count: number;
+    };
+}
+/** Payload for `player.achievement_unlocked` events. */
+interface PlayerAchievementUnlockedPayload {
+    player: {
+        agent_id: string;
+        name: string;
+    };
+    achievement: {
+        id: string;
+        name: string;
+        xp: number;
+    };
+}
+/** Payload for `player.level_up` events. */
+interface PlayerLevelUpPayload {
+    player: {
+        agent_id: string;
+        name: string;
+    };
+    level: {
+        from: number;
+        to: number;
+    };
+    title_unlocked: string;
+}
+/** Payload for `player.quest_completed` events. */
+interface PlayerQuestCompletedPayload {
+    player: {
+        agent_id: string;
+        name: string;
+    };
+    quest: {
+        id: string;
+        name: string;
+        xp: number;
+    };
+}
+/** Payload for `player.streak_milestone` events. */
+interface PlayerStreakMilestonePayload {
+    player: {
+        agent_id: string;
+        name: string;
+    };
+    streak_days: number;
+    milestone: number;
+}
+/** Payload for `player.xp_gained` events. */
+interface PlayerXpGainedPayload {
+    player: {
+        agent_id: string;
+        name: string;
+    };
+    amount: number;
+    reason: string;
+    ticket_id: string;
+}
+/** Payload for `social.high_five_sent` events. */
+interface SocialHighFiveSentPayload {
+    from_team: {
+        id: string;
+        name: string;
+    };
+    to_team: {
+        id: string;
+        name: string;
+    };
+    message: string;
+}
+/** Payload for `social.one_up_sent` events. */
+interface SocialOneUpSentPayload {
+    from: {
+        agent_id: string;
+        name: string;
+    };
+    to: {
+        agent_id: string;
+        name: string;
+    };
+    ticket_id: string;
+    message: string;
+}
+/** Payload for `survey.submitted` events. */
+interface SurveySubmittedPayload {
+    survey: {
+        id: string;
+        ticket_id: string;
+        score: number;
+        comment: string;
+        submitted_at: string;
+    };
+    customer: {
+        id: string;
+        email: string;
+    };
+}
+/** Payload for `ticket.assigned` events. */
+interface TicketAssignedPayload {
+    ticket: {
+        id: string;
+        prefixed_id: string;
+    };
+    assignee: {
+        id: string;
+        name: string;
+        email: string;
+    };
+    previous_assignee: null;
+}
+/** Payload for `ticket.closed` events. */
+interface TicketClosedPayload {
+    ticket: {
+        id: string;
+        prefixed_id: string;
+        title: string;
+        status: string;
+        priority: string;
+        channel: string;
+        resolved_at: string;
+    };
+    changes?: Record<string, {
+        from: string;
+        to: string;
+    }>;
+}
+/** Payload for `ticket.created` events. */
+interface TicketCreatedPayload {
+    ticket: {
+        id: string;
+        prefixed_id: string;
+        title: string;
+        status: string;
+        priority: string;
+        channel: string;
+        customer_id: string;
+        created_at: string;
+    };
+    customer: {
+        id: string;
+        name: string;
+        email: string;
+    };
+}
+/** Payload for `ticket.deleted` events. */
+interface TicketDeletedPayload {
+    id: string;
+}
+/** Payload for `ticket.message_added` events. */
+interface TicketMessageAddedPayload {
+    ticket: {
+        id: string;
+        dashboard_url: string | null;
+    };
+    message: {
+        id: string;
+        sender: string;
+        sender_name: string | null;
+        content: string;
+        created_at: string;
+    };
+    customer?: {
+        id: string;
+        name: string | null;
+        email: string | null;
+    };
+}
+/** Payload for `ticket.updated` events. */
+interface TicketUpdatedPayload {
+    ticket: {
+        id: string;
+        prefixed_id: string;
+        title: string;
+        status: string;
+        priority: string;
+        channel: 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 {
+    'article.created': ArticleCreatedPayload;
+    'article.deleted': ArticleDeletedPayload;
+    'article.published': ArticlePublishedPayload;
+    'article.updated': ArticleUpdatedPayload;
+    'boss.damaged': BossDamagedPayload;
+    'boss.defeated': BossDefeatedPayload;
+    'boss.spawned': BossSpawnedPayload;
+    'community_post.commented': CommunityPostCommentedPayload;
+    'community_post.created': CommunityPostCreatedPayload;
+    'community_post.deleted': CommunityPostDeletedPayload;
+    'community_post.status_changed': CommunityPostStatusChangedPayload;
+    'community_post.updated': CommunityPostUpdatedPayload;
+    'community_post.voted': CommunityPostVotedPayload;
+    'customer.created': CustomerCreatedPayload;
+    'customer.deleted': CustomerDeletedPayload;
+    'customer.updated': CustomerUpdatedPayload;
+    'customer_group.created': CustomerGroupCreatedPayload;
+    'customer_group.deleted': CustomerGroupDeletedPayload;
+    'customer_group.updated': CustomerGroupUpdatedPayload;
+    'player.achievement_unlocked': PlayerAchievementUnlockedPayload;
+    'player.level_up': PlayerLevelUpPayload;
+    'player.quest_completed': PlayerQuestCompletedPayload;
+    'player.streak_milestone': PlayerStreakMilestonePayload;
+    'player.xp_gained': PlayerXpGainedPayload;
+    'social.high_five_sent': SocialHighFiveSentPayload;
+    'social.one_up_sent': SocialOneUpSentPayload;
+    'survey.submitted': SurveySubmittedPayload;
+    'ticket.assigned': TicketAssignedPayload;
+    'ticket.closed': TicketClosedPayload;
+    'ticket.created': TicketCreatedPayload;
+    'ticket.deleted': TicketDeletedPayload;
+    'ticket.message_added': TicketMessageAddedPayload;
+    'ticket.updated': TicketUpdatedPayload;
+}
+/** 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: WebhookEventDataMap[T];
+}
+
+/** 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's `node:crypto` for timing-safe HMAC comparison. For browser, Edge,
+ * Workers, or any non-Node runtime, use `constructEventAsync` from
+ * `@cstar.help/js/webhook` instead.
+ *
+ * @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 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;
+
+export { type WebhookEvent, WebhookSignatureVerificationError, constructEvent, verifySignature };

package/dist/webhook/node.js

@@ -0,0 +1,30 @@
+// src/webhook/node.ts
+import { createHmac, timingSafeEqual } from "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=" + createHmac("sha256", secret).update(rawBody).digest("hex");
+  if (signature.length !== expected.length) return false;
+  return timingSafeEqual(Buffer.from(signature), Buffer.from(expected));
+}
+export {
+  WebhookSignatureVerificationError,
+  constructEvent,
+  verifySignature
+};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@cstar.help/js",
-	"version": "0.12.1",
+	"version": "0.14.0",
 	"description": "Official TypeScript SDK for the cStar customer support platform",
 	"type": "module",
 	"main": "./dist/index.cjs",
@@ -47,6 +47,16 @@
 				"default": "./dist/webhook/index.cjs"
 			}
 		},
+		"./webhook/node": {
+			"import": {
+				"types": "./dist/webhook/node.d.ts",
+				"default": "./dist/webhook/node.js"
+			},
+			"require": {
+				"types": "./dist/webhook/node.d.cts",
+				"default": "./dist/webhook/node.cjs"
+			}
+		},
 		"./community": {
 			"import": {
 				"types": "./dist/community/index.d.ts",
@@ -96,7 +106,9 @@
 		"dev": "tsup --watch",
 		"test": "vitest run",
 		"test:watch": "vitest",
-		"typecheck": "tsc --noEmit"
+		"typecheck": "tsc --noEmit",
+		"check:dts": "node scripts/check-dts.mjs",
+		"prepublishOnly": "yarn build && yarn check:dts"
 	},
 	"keywords": [
 		"cstar",