@doist/todoist-sdk 9.3.0 → 9.5.0

package/dist/types/types/webhooks/envelope.d.ts

@@ -0,0 +1,34 @@
+import { z } from 'zod';
+/**
+ * Collaborator info for the user that triggered a webhook event.
+ * @see https://developer.todoist.com/sync/v1/#webhooks
+ */
+export declare const WebhookInitiatorSchema: z.ZodObject<{
+    id: z.ZodString;
+    fullName: z.ZodString;
+    email: z.ZodString;
+    imageId: z.ZodNullable<z.ZodString>;
+    isPremium: z.ZodBoolean;
+}, z.core.$strip>;
+/**
+ * Collaborator info for the user that triggered a webhook event.
+ */
+export type WebhookInitiator = z.infer<typeof WebhookInitiatorSchema>;
+/**
+ * Fields common to every webhook payload, regardless of `eventName`.
+ * Meant to be spread into per-event variant schemas.
+ */
+export declare const BaseWebhookEnvelopeShape: {
+    readonly version: z.ZodEnum<{
+        1: "1";
+    }>;
+    readonly userId: z.ZodString;
+    readonly initiator: z.ZodObject<{
+        id: z.ZodString;
+        fullName: z.ZodString;
+        email: z.ZodString;
+        imageId: z.ZodNullable<z.ZodString>;
+        isPremium: z.ZodBoolean;
+    }, z.core.$strip>;
+    readonly triggeredAt: z.ZodCoercedDate<unknown>;
+};

package/dist/types/types/webhooks/index.d.ts

@@ -0,0 +1,5 @@
+export * from './comments.js';
+export * from './envelope.js';
+export * from './labels.js';
+export * from './tasks.js';
+export * from './types.js';

package/dist/types/types/webhooks/labels.d.ts

@@ -0,0 +1,160 @@
+import { z } from 'zod';
+/**
+ * Enum-like object of label (`label:*`) webhook event names. Single source
+ * of truth for the discriminator values — `LABEL_WEBHOOK_EVENTS` and every
+ * `z.literal()` below derive from it.
+ */
+export declare const LabelWebhookEventEnum: {
+    readonly Added: "label:added";
+    readonly Updated: "label:updated";
+    readonly Deleted: "label:deleted";
+};
+/** Webhook events that carry a label as their `eventData`. */
+export declare const LABEL_WEBHOOK_EVENTS: readonly ["label:added", "label:updated", "label:deleted"];
+/**
+ * A label as delivered in a webhook payload.
+ *
+ * Webhook label payloads differ from the REST label shape in two ways:
+ * they use `item_order` (not `order`) and always include `is_deleted`. This
+ * schema reuses {@link LabelSchema}, swapping `order` for `itemOrder` on
+ * the input side and renaming it back after validation, and surfaces
+ * `isDeleted` for downstream filtering.
+ */
+export declare const WebhookLabelSchema: z.ZodPipe<z.ZodObject<{
+    name: z.ZodString;
+    id: z.ZodString;
+    color: z.ZodString;
+    isFavorite: z.ZodBoolean;
+    itemOrder: z.ZodNullable<z.ZodNumber>;
+    isDeleted: z.ZodBoolean;
+}, z.core.$strip>, z.ZodTransform<{
+    order: number | null;
+    name: string;
+    id: string;
+    color: string;
+    isFavorite: boolean;
+    isDeleted: boolean;
+}, {
+    name: string;
+    id: string;
+    color: string;
+    isFavorite: boolean;
+    itemOrder: number | null;
+    isDeleted: boolean;
+}>>;
+/** A label as delivered in a webhook payload. */
+export type WebhookLabel = z.infer<typeof WebhookLabelSchema>;
+export declare const LabelAddedPayloadSchema: z.ZodObject<{
+    eventName: z.ZodLiteral<"label:added">;
+    eventData: z.ZodPipe<z.ZodObject<{
+        name: z.ZodString;
+        id: z.ZodString;
+        color: z.ZodString;
+        isFavorite: z.ZodBoolean;
+        itemOrder: z.ZodNullable<z.ZodNumber>;
+        isDeleted: z.ZodBoolean;
+    }, z.core.$strip>, z.ZodTransform<{
+        order: number | null;
+        name: string;
+        id: string;
+        color: string;
+        isFavorite: boolean;
+        isDeleted: boolean;
+    }, {
+        name: string;
+        id: string;
+        color: string;
+        isFavorite: boolean;
+        itemOrder: number | null;
+        isDeleted: boolean;
+    }>>;
+    version: z.ZodEnum<{
+        1: "1";
+    }>;
+    userId: z.ZodString;
+    initiator: z.ZodObject<{
+        id: z.ZodString;
+        fullName: z.ZodString;
+        email: z.ZodString;
+        imageId: z.ZodNullable<z.ZodString>;
+        isPremium: z.ZodBoolean;
+    }, z.core.$strip>;
+    triggeredAt: z.ZodCoercedDate<unknown>;
+}, z.core.$strip>;
+export type LabelAddedPayload = z.infer<typeof LabelAddedPayloadSchema>;
+export declare const LabelUpdatedPayloadSchema: z.ZodObject<{
+    eventName: z.ZodLiteral<"label:updated">;
+    eventData: z.ZodPipe<z.ZodObject<{
+        name: z.ZodString;
+        id: z.ZodString;
+        color: z.ZodString;
+        isFavorite: z.ZodBoolean;
+        itemOrder: z.ZodNullable<z.ZodNumber>;
+        isDeleted: z.ZodBoolean;
+    }, z.core.$strip>, z.ZodTransform<{
+        order: number | null;
+        name: string;
+        id: string;
+        color: string;
+        isFavorite: boolean;
+        isDeleted: boolean;
+    }, {
+        name: string;
+        id: string;
+        color: string;
+        isFavorite: boolean;
+        itemOrder: number | null;
+        isDeleted: boolean;
+    }>>;
+    version: z.ZodEnum<{
+        1: "1";
+    }>;
+    userId: z.ZodString;
+    initiator: z.ZodObject<{
+        id: z.ZodString;
+        fullName: z.ZodString;
+        email: z.ZodString;
+        imageId: z.ZodNullable<z.ZodString>;
+        isPremium: z.ZodBoolean;
+    }, z.core.$strip>;
+    triggeredAt: z.ZodCoercedDate<unknown>;
+}, z.core.$strip>;
+export type LabelUpdatedPayload = z.infer<typeof LabelUpdatedPayloadSchema>;
+export declare const LabelDeletedPayloadSchema: z.ZodObject<{
+    eventName: z.ZodLiteral<"label:deleted">;
+    eventData: z.ZodPipe<z.ZodObject<{
+        name: z.ZodString;
+        id: z.ZodString;
+        color: z.ZodString;
+        isFavorite: z.ZodBoolean;
+        itemOrder: z.ZodNullable<z.ZodNumber>;
+        isDeleted: z.ZodBoolean;
+    }, z.core.$strip>, z.ZodTransform<{
+        order: number | null;
+        name: string;
+        id: string;
+        color: string;
+        isFavorite: boolean;
+        isDeleted: boolean;
+    }, {
+        name: string;
+        id: string;
+        color: string;
+        isFavorite: boolean;
+        itemOrder: number | null;
+        isDeleted: boolean;
+    }>>;
+    version: z.ZodEnum<{
+        1: "1";
+    }>;
+    userId: z.ZodString;
+    initiator: z.ZodObject<{
+        id: z.ZodString;
+        fullName: z.ZodString;
+        email: z.ZodString;
+        imageId: z.ZodNullable<z.ZodString>;
+        isPremium: z.ZodBoolean;
+    }, z.core.$strip>;
+    triggeredAt: z.ZodCoercedDate<unknown>;
+}, z.core.$strip>;
+export type LabelDeletedPayload = z.infer<typeof LabelDeletedPayloadSchema>;