@rewritetoday/types 1.0.1 → 1.0.3

package/README.md

@@ -43,6 +43,9 @@ Types used in direct API requests.
 
   - Suffix `Data` → data returned by the API
   E.g.: `RESTGetListWebhooksData`
+  
+- Prefix `Webhook*`
+Represents any data that come from a webhook.
 
 <div align="center">
 
@@ -66,6 +69,35 @@ async function fetchHooks() {
 
 <div align="center">
 
+### Typing webhook events
+
+We are using [Bun](https://elysiajs.com/) here as example, but you can use it however you want.
+
+</div>
+
+```ts
+import { type WebhookEvent, WebhookEventType } from '@rewritetoday/types/v1';
+
+const server = Bun.serve({
+	port: 3000,
+	routes: {
+		async '/webhooks/rewrite'(request) {
+			const event: WebhookEvent = await request.json();
+			
+			switch (event.type) {
+				case WebhookEventType.MessageSent:
+					console.log('Hey, a new message!');
+					
+					return Response.json({});
+				case ...
+			}
+		},
+	},
+});
+```
+
+<div align="center">
+
 ### Using Route Builders
 
 </div>

package/dist/v1/index.d.ts

@@ -7,3 +7,4 @@ export * from './resources/templates';
 export * from './resources/webhooks';
 export * from './rest';
 export { API_BASE_URL, Routes } from './routes';
+export * from './webhooks';

package/dist/v1/index.js

@@ -7,3 +7,4 @@ export * from './resources/templates';
 export * from './resources/webhooks';
 export * from './rest';
 export { API_BASE_URL, Routes } from './routes';
+export * from './webhooks';

package/dist/v1/webhooks.d.ts

@@ -0,0 +1,130 @@
+import type { Snowflake } from './resources/globals';
+import type { APIMessage, MessageStatus, MessageType } from './resources/message';
+import type { APIOTPMessage } from './resources/otp';
+import { WebhookEventType } from './resources/webhooks';
+export interface WebhookBase<Type extends WebhookEventType, Data extends object> {
+    /** Event name. See {@link WebhookEventType}. */
+    type: Type;
+    /** The data of the event. */
+    data: Data & {
+        /** The ID of the project that sent the OTP message. See {@link Snowflake}. */
+        projectId: Snowflake;
+    };
+    /** Webhook event identifier. See {@link Snowflake}. */
+    id: Snowflake;
+    /** Timestamp when Rewrite sent the event. */
+    createdAt: string;
+}
+/** https://docs.rewritetoday.com/en/webhooks/events/sms-otp */
+export type WebhookSMSOTPEvent = WebhookBase<WebhookEventType.SMSOTP, Omit<APIMessage, 'type' | 'status'> & {
+    /** OTP data. */
+    otp: Pick<APIOTPMessage, 'prefix' | 'expiresAt'>;
+    /** The type of the message. Always {@link MessageType.OTP} */
+    type: MessageType.OTP;
+    /** Latest delivery status known by Rewrite. Always {@link MessageStatus.Sent} */
+    status: MessageStatus.Sent;
+}>;
+/** https://docs.rewritetoday.com/en/webhooks/events/message-sent */
+export type WebhookMessageSentEvent = WebhookBase<WebhookEventType.MessageSent, Omit<APIMessage, 'type' | 'status'> & {
+    /** The type of the message. Always {@link MessageType.SMS} */
+    type: MessageType.SMS;
+    /** Latest delivery status known by Rewrite. Always {@link MessageStatus.Sent} */
+    status: MessageStatus.Sent;
+}>;
+/** https://docs.rewritetoday.com/en/webhooks/events/message-batch */
+export type WebhookMessageBatchEvent = WebhookBase<WebhookEventType.MessageBatch, {
+    /** Message ID in {@link Snowflake} format. */
+    id: Snowflake;
+    /**
+     * The IDs of the messages in {@link Snowflake} format that were sent.
+     *
+     * @remarks Can be longer than the original number of request items when some entries were segmented into multiple SMS parts.
+     * @see {@link https://docs.rewritetoday.com/en/webhooks/events/message-batch}
+     */
+    ids: Snowflake[];
+}>;
+/** https://docs.rewritetoday.com/en/webhooks/events/message-queued */
+export type WebhookMessageQueuedEvent = WebhookBase<WebhookEventType.MessageQueued, Omit<APIMessage, 'type' | 'status'> & {
+    /** The type of the message. Always {@link MessageType.SMS} */
+    type: MessageType.SMS;
+    /** Latest delivery status known by Rewrite. Always {@link MessageStatus.Queued} */
+    status: MessageStatus.Queued;
+}>;
+/**
+ * https://docs.rewritetoday.com/en/webhooks/events/message-delivered
+ *
+ * @wip
+ */
+export type WebhookMessageDeliveredEvent = WebhookBase<WebhookEventType.MessageDelivered, never>;
+/** https://docs.rewritetoday.com/en/webhooks/events/message-scheduled */
+export type WebhookMessageScheduledEvent = WebhookBase<WebhookEventType.MessageScheduled, Omit<APIMessage, 'type' | 'status' | 'scheduledAt'> & {
+    /** Scheduled send time, when the message was delayed intentionally. */
+    scheduledAt: string;
+    /** The type of the message. Always {@link MessageType.SMS} */
+    type: MessageType.SMS;
+    /** Latest delivery status known by Rewrite. Always {@link MessageStatus.Scheduled} */
+    status: MessageStatus.Scheduled;
+}>;
+/** https://docs.rewritetoday.com/en/webhooks/events/message-failed */
+export type WebhookMessageFailedEvent = WebhookBase<WebhookEventType.MessageFailed, Omit<APIMessage, 'status'> & {
+    /** Latest delivery status known by Rewrite. Always {@link MessageStatus.Failed} */
+    status: MessageStatus.Failed;
+    /** The error explaining why the message failed. */
+    error: {
+        /** A human-readable error code. */
+        code: string;
+        /** Internal message error. */
+        message: string;
+    };
+}>;
+/** https://docs.rewritetoday.com/en/webhooks/events/message-canceled */
+export type WebhookMessageCanceledEvent = WebhookBase<WebhookEventType.MessageCanceled, Omit<APIMessage, 'type' | 'status' | ('scheduledAt' & {
+    /** Scheduled send time, when the message was delayed intentionally. */
+    scheduledAt: string;
+    /** The type of the message. Always {@link MessageType.SMS} */
+    type: MessageType.SMS;
+    /** Latest delivery status known by Rewrite. Always {@link MessageStatus.Canceled} */
+    status: MessageStatus.Canceled;
+})>>;
+/** https://docs.rewritetoday.com/en/webhooks */
+export type WebhookEvent = WebhookSMSOTPEvent | WebhookMessageSentEvent | WebhookMessageBatchEvent | WebhookMessageQueuedEvent | WebhookMessageDeliveredEvent | WebhookMessageScheduledEvent | WebhookMessageFailedEvent | WebhookMessageCanceledEvent;
+/**
+ * Checks whether the event is a {@link WebhookEventType.SMSOTP} or not
+ * @param event The event data received from Rewrite
+ */
+export declare function isWebhookSMSOTPEvent(event: WebhookEvent): event is WebhookSMSOTPEvent;
+/**
+ * Checks whether the event is a {@link WebhookEventType.MessageSent} or not
+ * @param event The event data received from Rewrite
+ */
+export declare function isWebhookMessageSentEvent(event: WebhookEvent): event is WebhookMessageSentEvent;
+/**
+ * Checks whether the event is a {@link WebhookEventType.MessageBatch} or not
+ * @param event The event data received from Rewrite
+ */
+export declare function isWebhookMessageBatchEvent(event: WebhookEvent): event is WebhookMessageBatchEvent;
+/**
+ * Checks whether the event is a {@link WebhookEventType.MessageQueued} or not
+ * @param event The event data received from Rewrite
+ */
+export declare function isWebhookMessageQueuedEvent(event: WebhookEvent): event is WebhookMessageQueuedEvent;
+/**
+ * Checks whether the event is a {@link WebhookEventType.MessageDelivered} or not
+ * @param event The event data received from Rewrite
+ */
+export declare function isWebhookMessageDeliveredEvent(event: WebhookEvent): event is WebhookMessageDeliveredEvent;
+/**
+ * Checks whether the event is a {@link WebhookEventType.MessageScheduled} or not
+ * @param event The event data received from Rewrite
+ */
+export declare function isWebhookMessageScheduledEvent(event: WebhookEvent): event is WebhookMessageScheduledEvent;
+/**
+ * Checks whether the event is a {@link WebhookEventType.MessageFailed} or not
+ * @param event The event data received from Rewrite
+ */
+export declare function isWebhookMessageFailedEvent(event: WebhookEvent): event is WebhookMessageFailedEvent;
+/**
+ * Checks whether the event is a {@link WebhookEventType.MessageCanceled} or not
+ * @param event The event data received from Rewrite
+ */
+export declare function isWebhookMessageCanceledEvent(event: WebhookEvent): event is WebhookMessageCanceledEvent;

package/dist/v1/webhooks.js

@@ -0,0 +1,57 @@
+import { WebhookEventType } from './resources/webhooks';
+/**
+ * Checks whether the event is a {@link WebhookEventType.SMSOTP} or not
+ * @param event The event data received from Rewrite
+ */
+export function isWebhookSMSOTPEvent(event) {
+    return event.type === WebhookEventType.SMSOTP;
+}
+/**
+ * Checks whether the event is a {@link WebhookEventType.MessageSent} or not
+ * @param event The event data received from Rewrite
+ */
+export function isWebhookMessageSentEvent(event) {
+    return event.type === WebhookEventType.MessageSent;
+}
+/**
+ * Checks whether the event is a {@link WebhookEventType.MessageBatch} or not
+ * @param event The event data received from Rewrite
+ */
+export function isWebhookMessageBatchEvent(event) {
+    return event.type === WebhookEventType.MessageBatch;
+}
+/**
+ * Checks whether the event is a {@link WebhookEventType.MessageQueued} or not
+ * @param event The event data received from Rewrite
+ */
+export function isWebhookMessageQueuedEvent(event) {
+    return event.type === WebhookEventType.MessageQueued;
+}
+/**
+ * Checks whether the event is a {@link WebhookEventType.MessageDelivered} or not
+ * @param event The event data received from Rewrite
+ */
+export function isWebhookMessageDeliveredEvent(event) {
+    return event.type === WebhookEventType.MessageDelivered;
+}
+/**
+ * Checks whether the event is a {@link WebhookEventType.MessageScheduled} or not
+ * @param event The event data received from Rewrite
+ */
+export function isWebhookMessageScheduledEvent(event) {
+    return event.type === WebhookEventType.MessageScheduled;
+}
+/**
+ * Checks whether the event is a {@link WebhookEventType.MessageFailed} or not
+ * @param event The event data received from Rewrite
+ */
+export function isWebhookMessageFailedEvent(event) {
+    return event.type === WebhookEventType.MessageFailed;
+}
+/**
+ * Checks whether the event is a {@link WebhookEventType.MessageCanceled} or not
+ * @param event The event data received from Rewrite
+ */
+export function isWebhookMessageCanceledEvent(event) {
+    return event.type === WebhookEventType.MessageCanceled;
+}

package/dist/version.d.ts

@@ -1,7 +1,7 @@
 /**
  * Current version of [@rewritetoday/types](https://www.npmjs.com/package/@rewritetoday/types).
  */
-export declare const version: "1.0.1";
+export declare const version: "1.0.3";
 /**
  * Current Rewrite API version.
  */

package/dist/version.js

@@ -2,7 +2,7 @@
 /**
  * Current version of [@rewritetoday/types](https://www.npmjs.com/package/@rewritetoday/types).
  */
-export const version = '1.0.1';
+export const version = '1.0.3';
 /**
  * Current Rewrite API version.
  */

package/package.json

@@ -1,5 +1,5 @@
 {
-	"version": "1.0.1",
+	"version": "1.0.3",
 	"name": "@rewritetoday/types",
 	"description": "Official Rewrite API typings that are always up to date",
 	"type": "module",