chore(backend): Added types to webhook json for waitlist entry (clerk#5148)

Co-authored-by: panteliselef <panteliselef@outlook.com>

Author: mackenzienolan

.changeset/green-starfishes-hear.md

@@ -0,0 +1,9 @@
+---
+'@clerk/backend': minor
+---
+
+Add waitlist entry types
+- `WaitlistEntryJSON`
+- `WaitlistEntryWebhookEvent`
+
+Update `WebhookEvent` to include `WaitlistEntryWebhookEvent`

.changeset/tender-suits-rush.md

@@ -0,0 +1,5 @@
+---
+"@clerk/nextjs": patch
+---
+
+Re-export `WaitlistEntryJSON` from `@clerk/nextjs/server`.

packages/backend/src/api/resources/JSON.ts

@@ -34,6 +34,7 @@ export const ObjectType = {
   SignUpAttempt: 'sign_up_attempt',
   SmsMessage: 'sms_message',
   User: 'user',
+  WaitlistEntry: 'waitlist_entry',
   Web3Wallet: 'web3_wallet',
   Token: 'token',
   TotalCount: 'total_count',
@@ -382,6 +383,17 @@ export interface VerificationJSON extends ClerkResourceJSON {
   message?: string | null;
 }
 
+export interface WaitlistEntryJSON extends ClerkResourceJSON {
+  created_at: number;
+  email_address: string;
+  id: string;
+  invitation: InvitationJSON | null;
+  is_locked: boolean;
+  object: typeof ObjectType.WaitlistEntry;
+  status: string;
+  updated_at: number;
+}
+
 export interface Web3WalletJSON extends ClerkResourceJSON {
   object: typeof ObjectType.Web3Wallet;
   web3_wallet: string;

packages/backend/src/api/resources/Webhooks.ts

@@ -10,6 +10,7 @@ import type {
   SessionJSON,
   SMSMessageJSON,
   UserJSON,
+  WaitlistEntryJSON,
 } from './JSON';
 
 type Webhook<EvtType, Data> = { type: EvtType; object: 'event'; data: Data };
@@ -52,6 +53,8 @@ export type PermissionWebhookEvent = Webhook<
   PermissionJSON
 >;
 
+export type WaitlistEntryWebhookEvent = Webhook<'waitlistEntry.created' | 'waitlistEntry.updated', WaitlistEntryJSON>;
+
 export type WebhookEvent =
   | UserWebhookEvent
   | SessionWebhookEvent
@@ -62,6 +65,7 @@ export type WebhookEvent =
   | OrganizationMembershipWebhookEvent
   | OrganizationInvitationWebhookEvent
   | RoleWebhookEvent
-  | PermissionWebhookEvent;
+  | PermissionWebhookEvent
+  | WaitlistEntryWebhookEvent;
 
 export type WebhookEventType = WebhookEvent['type'];

packages/backend/src/api/resources/index.ts

@@ -46,6 +46,7 @@ export type {
   SessionWebhookEvent,
   SMSWebhookEvent,
   UserWebhookEvent,
+  WaitlistEntryWebhookEvent,
   WebhookEvent,
   WebhookEventType,
 } from './Webhooks';

packages/backend/src/index.ts

@@ -80,6 +80,7 @@ export type {
   SMSMessageJSON,
   UserJSON,
   VerificationJSON,
+  WaitlistEntryJSON,
   Web3WalletJSON,
   DeletedObjectJSON,
   PaginatedResponseJSON,
@@ -126,6 +127,7 @@ export type {
   SessionWebhookEvent,
   SMSWebhookEvent,
   UserWebhookEvent,
+  WaitlistEntryWebhookEvent,
   WebhookEvent,
   WebhookEventType,
 } from './api/resources/Webhooks';

packages/nextjs/src/server/index.ts

@@ -20,6 +20,7 @@ export type {
   SessionJSON,
   SMSMessageJSON,
   UserJSON,
+  WaitlistEntryJSON,
   WebhookEvent,
   WebhookEventType,
   UserWebhookEvent,
@@ -32,6 +33,7 @@ export type {
   RoleWebhookEvent,
   SessionWebhookEvent,
   SMSWebhookEvent,
+  WaitlistEntryWebhookEvent,
 } from '@clerk/backend';
 
 /**