The minimalistic document archiving platform.
import type { EventName } from './webhooks.constants';
export type WebhookPayload<T extends EventName, D extends Record<string, unknown>> = {
event: T;
payload: D;
};
export type DocumentCreatedPayload = WebhookPayload<
'document:created',
{
documentId: string;
organizationId: string;
name: string;
createdAt: Date;
updatedAt: Date;
}
>;
export type DocumentDeletedPayload = WebhookPayload<
'document:deleted',
{
documentId: string;
organizationId: string;
}
>;
export type DocumentUpdatedPayload = WebhookPayload<
'document:updated',
{
documentId: string;
organizationId: string;
name?: string;
content?: string;
}
>;
export type DocumentTagAddedPayload = WebhookPayload<
'document:tag:added',
{
documentId: string;
organizationId: string;
tagId: string;
tagName: string;
}
>;
export type DocumentTagRemovedPayload = WebhookPayload<
'document:tag:removed',
{
documentId: string;
organizationId: string;
tagId: string;
tagName: string;
}
>;
export type WebhookPayloads =
| DocumentCreatedPayload
| DocumentDeletedPayload
| DocumentUpdatedPayload
| DocumentTagAddedPayload
| DocumentTagRemovedPayload;
type ExtractEventName<T> = T extends WebhookPayload<infer E, any> ? E : never;
export type BuildStandardWebhookEventPayload<T extends WebhookPayloads> = {
type: T['event'];
timestamp: string;
data: T['payload'];
};
export type BuildWebhookEvents<T extends WebhookPayloads> = {
[K in ExtractEventName<T>]: (
args: BuildStandardWebhookEventPayload<Extract<T, WebhookPayload<K, any>>>,
) => void;
};
export type WebhookEvents = BuildWebhookEvents<WebhookPayloads>;
export type StandardWebhookEventPayload = BuildStandardWebhookEventPayload<WebhookPayloads>;