@doist/todoist-sdk 9.4.0 → 9.5.0

package/dist/cjs/test-utils/webhook-fixtures.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CLIENT_SECRET = void 0;
+exports.sign = sign;
+exports.rawTask = rawTask;
+exports.envelope = envelope;
+const node_crypto_1 = require("node:crypto");
+exports.CLIENT_SECRET = 'test-client-secret';
+/** HMAC-SHA256 signs a raw body with the test client secret (or an override). */
+function sign(body, secret = exports.CLIENT_SECRET) {
+    return (0, node_crypto_1.createHmac)('sha256', secret).update(body).digest('base64');
+}
+/**
+ * Snake_case task payload matching the v1 webhook wire shape.
+ */
+function rawTask(overrides = {}) {
+    return Object.assign({ id: '6XR4GqQQCW6Gv9h4', user_id: '2671355', project_id: '6XR4H993xv8H5qCR', section_id: null, parent_id: null, added_by_uid: '2671355', assigned_by_uid: null, responsible_uid: null, labels: [], deadline: null, duration: null, is_collapsed: false, checked: false, is_deleted: false, added_at: '2025-02-10T10:33:38.000000Z', completed_at: null, completed_by_uid: null, updated_at: '2025-02-10T10:33:38.000000Z', due: null, priority: 1, child_order: 3, content: 'Buy Milk', description: '', note_count: 0, day_order: -1, goal_ids: [], url: 'https://app.todoist.com/app/task/6XR4GqQQCW6Gv9h4' }, overrides);
+}
+/**
+ * Wraps an event's `event_data` in the snake_case envelope the backend sends
+ * (initiator, version, timestamps, etc). `extra` passes extra top-level keys
+ * like `event_data_extra`.
+ */
+function envelope(event, eventData, extra) {
+    return Object.assign({ version: '1', user_id: '2671355', initiator: {
+            id: '2671355',
+            full_name: 'Alice',
+            email: 'alice@example.com',
+            image_id: 'ad38375bdb094286af59f1eab36d8f20',
+            is_premium: true,
+        }, event_name: event, event_data: eventData, triggered_at: '2025-02-10T10:39:38.000000Z' }, extra);
+}

package/dist/cjs/types/webhooks/comments.js

@@ -0,0 +1,96 @@
+"use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommentDeletedPayloadSchema = exports.CommentUpdatedPayloadSchema = exports.CommentAddedPayloadSchema = exports.WebhookCommentSchema = exports.WebhookProjectCommentSchema = exports.WebhookItemCommentSchema = exports.COMMENT_WEBHOOK_EVENTS = exports.CommentWebhookEventEnum = void 0;
+const zod_1 = require("zod");
+const types_1 = require("../comments/types");
+const types_2 = require("../tasks/types");
+const envelope_1 = require("./envelope");
+/**
+ * Enum-like object of comment (`note:*`) webhook event names. Single source
+ * of truth for the discriminator values — `COMMENT_WEBHOOK_EVENTS` and every
+ * `z.literal()` below derive from it.
+ *
+ * The on-the-wire event names remain `note:*` for historical reasons; the
+ * SDK types use `Comment*` to match the rest of the public API where the
+ * resource is named `Comment`.
+ */
+exports.CommentWebhookEventEnum = {
+    Added: 'note:added',
+    Updated: 'note:updated',
+    Deleted: 'note:deleted',
+};
+/**
+ * Webhook events that carry a comment as their `eventData`.
+ */
+exports.COMMENT_WEBHOOK_EVENTS = [
+    exports.CommentWebhookEventEnum.Added,
+    exports.CommentWebhookEventEnum.Updated,
+    exports.CommentWebhookEventEnum.Deleted,
+];
+/**
+ * Fields common to both item and project comment payloads.
+ *
+ * `postedAt` and `postedUid` are nullable here (unlike
+ * {@link RawCommentSchema}) because webhook payloads may omit them — for
+ * example when the poster could not be resolved, or on a deleted-note
+ * tombstone.
+ */
+const WebhookCommentBaseSchema = zod_1.z.object({
+    id: zod_1.z.string(),
+    content: zod_1.z.string(),
+    postedAt: zod_1.z.coerce.date().nullable(),
+    postedUid: zod_1.z.string().nullable(),
+    fileAttachment: types_1.AttachmentSchema.nullable(),
+    uidsToNotify: zod_1.z.array(zod_1.z.string()).nullable(),
+    reactions: zod_1.z.record(zod_1.z.string(), zod_1.z.array(zod_1.z.string())).nullable(),
+    isDeleted: zod_1.z.boolean(),
+});
+/**
+ * A comment attached to a task, delivered in a webhook payload.
+ *
+ * Webhook item-comment payloads carry two fields that don't appear on the
+ * REST comment resource: `url` (the direct task URL) and `item` (the full
+ * embedded {@link Task}). Both are parsed here so consumers handling a
+ * `note:added` event also get the task it belongs to.
+ *
+ * `itemId` is exposed as `taskId` to match the rest of the SDK surface.
+ */
+exports.WebhookItemCommentSchema = WebhookCommentBaseSchema.extend({
+    itemId: zod_1.z.string(),
+    url: zod_1.z.string(),
+    item: types_2.TaskSchema,
+})
+    .strict()
+    .transform((_a) => {
+    var { itemId } = _a, rest = __rest(_a, ["itemId"]);
+    return (Object.assign(Object.assign({}, rest), { taskId: itemId }));
+});
+/**
+ * A comment attached to a project, delivered in a webhook payload.
+ *
+ * Project comments do not carry the extra `url` or embedded project fields
+ * that item comments carry for the parent task.
+ */
+exports.WebhookProjectCommentSchema = WebhookCommentBaseSchema.extend({
+    projectId: zod_1.z.string(),
+}).strict();
+/**
+ * The `eventData` of a `note:*` webhook payload — either an item comment
+ * (includes `taskId` and an embedded {@link Task}) or a project comment
+ * (includes `projectId`). Narrow with `'taskId' in eventData`.
+ */
+exports.WebhookCommentSchema = zod_1.z.union([exports.WebhookItemCommentSchema, exports.WebhookProjectCommentSchema]);
+exports.CommentAddedPayloadSchema = zod_1.z.object(Object.assign(Object.assign({}, envelope_1.BaseWebhookEnvelopeShape), { eventName: zod_1.z.literal(exports.CommentWebhookEventEnum.Added), eventData: exports.WebhookCommentSchema }));
+exports.CommentUpdatedPayloadSchema = zod_1.z.object(Object.assign(Object.assign({}, envelope_1.BaseWebhookEnvelopeShape), { eventName: zod_1.z.literal(exports.CommentWebhookEventEnum.Updated), eventData: exports.WebhookCommentSchema }));
+exports.CommentDeletedPayloadSchema = zod_1.z.object(Object.assign(Object.assign({}, envelope_1.BaseWebhookEnvelopeShape), { eventName: zod_1.z.literal(exports.CommentWebhookEventEnum.Deleted), eventData: exports.WebhookCommentSchema }));

package/dist/cjs/types/webhooks/index.js

@@ -14,6 +14,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./comments"), exports);
 __exportStar(require("./envelope"), exports);
+__exportStar(require("./labels"), exports);
 __exportStar(require("./tasks"), exports);
 __exportStar(require("./types"), exports);

package/dist/cjs/types/webhooks/labels.js

@@ -0,0 +1,54 @@
+"use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LabelDeletedPayloadSchema = exports.LabelUpdatedPayloadSchema = exports.LabelAddedPayloadSchema = exports.WebhookLabelSchema = exports.LABEL_WEBHOOK_EVENTS = exports.LabelWebhookEventEnum = void 0;
+const zod_1 = require("zod");
+const types_1 = require("../labels/types");
+const envelope_1 = require("./envelope");
+/**
+ * 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.
+ */
+exports.LabelWebhookEventEnum = {
+    Added: 'label:added',
+    Updated: 'label:updated',
+    Deleted: 'label:deleted',
+};
+/** Webhook events that carry a label as their `eventData`. */
+exports.LABEL_WEBHOOK_EVENTS = [
+    exports.LabelWebhookEventEnum.Added,
+    exports.LabelWebhookEventEnum.Updated,
+    exports.LabelWebhookEventEnum.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.
+ */
+exports.WebhookLabelSchema = types_1.LabelSchema.omit({ order: true })
+    .extend({
+    itemOrder: zod_1.z.number().int().nullable(),
+    isDeleted: zod_1.z.boolean(),
+})
+    .transform((_a) => {
+    var { itemOrder } = _a, rest = __rest(_a, ["itemOrder"]);
+    return (Object.assign(Object.assign({}, rest), { order: itemOrder }));
+});
+exports.LabelAddedPayloadSchema = zod_1.z.object(Object.assign(Object.assign({}, envelope_1.BaseWebhookEnvelopeShape), { eventName: zod_1.z.literal(exports.LabelWebhookEventEnum.Added), eventData: exports.WebhookLabelSchema }));
+exports.LabelUpdatedPayloadSchema = zod_1.z.object(Object.assign(Object.assign({}, envelope_1.BaseWebhookEnvelopeShape), { eventName: zod_1.z.literal(exports.LabelWebhookEventEnum.Updated), eventData: exports.WebhookLabelSchema }));
+exports.LabelDeletedPayloadSchema = zod_1.z.object(Object.assign(Object.assign({}, envelope_1.BaseWebhookEnvelopeShape), { eventName: zod_1.z.literal(exports.LabelWebhookEventEnum.Deleted), eventData: exports.WebhookLabelSchema }));

package/dist/cjs/types/webhooks/types.js

@@ -4,13 +4,25 @@ exports.WebhookEventSchema = exports.WebhookPayloadSchema = exports.UntypedWebho
 const zod_1 = require("zod");
 const types_1 = require("../apps/types");
 Object.defineProperty(exports, "WebhookEventSchema", { enumerable: true, get: function () { return types_1.WebhookEventSchema; } });
+const comments_1 = require("./comments");
 const envelope_1 = require("./envelope");
+const labels_1 = require("./labels");
 const tasks_1 = require("./tasks");
-const untypedEventNames = types_1.WEBHOOK_EVENTS.filter((event) => !tasks_1.TASK_WEBHOOK_EVENTS.includes(event));
+/**
+ * Events whose payloads have been narrowed per resource. Each phase adds to
+ * this list; {@link UntypedWebhookPayloadSchema} below is derived by taking
+ * every {@link WebhookEvent} not present here.
+ */
+const TYPED_WEBHOOK_EVENTS = [
+    ...tasks_1.TASK_WEBHOOK_EVENTS,
+    ...comments_1.COMMENT_WEBHOOK_EVENTS,
+    ...labels_1.LABEL_WEBHOOK_EVENTS,
+];
+const untypedEventNames = types_1.WEBHOOK_EVENTS.filter((event) => !TYPED_WEBHOOK_EVENTS.includes(event));
 /**
  * A single branch covering every event whose payload has not yet been typed
  * per resource. Follow-up PRs will replace slices of this with dedicated
- * variants (notes, projects, sections, labels, filters, reminders).
+ * variants (projects, sections, filters, reminders).
  */
 exports.UntypedWebhookPayloadSchema = zod_1.z.object(Object.assign(Object.assign({}, envelope_1.BaseWebhookEnvelopeShape), { eventName: zod_1.z.enum(untypedEventNames), eventData: zod_1.z.unknown(), eventDataExtra: zod_1.z.unknown().optional() }));
 /**
@@ -20,9 +32,11 @@ exports.UntypedWebhookPayloadSchema = zod_1.z.object(Object.assign(Object.assign
  * (`item:added`) in the `event_name` field, so consumers using
  * `parseWebhookPayload` receive camelCase fields directly.
  *
- * Typed today: `item:*` events carry a parsed {@link Task}. Other events
- * still expose `eventData` as `unknown`; they will be narrowed in follow-up
- * PRs (notes, projects, sections, labels, filters, reminders).
+ * Typed today: `item:*` events carry a parsed {@link Task}; `note:*` events
+ * carry a parsed comment (item-comment or project-comment); `label:*` events
+ * carry a parsed label. Other events still expose `eventData` as `unknown`;
+ * they will be narrowed in follow-up PRs (projects, sections, filters,
+ * reminders).
  */
 exports.WebhookPayloadSchema = zod_1.z.discriminatedUnion('eventName', [
     tasks_1.TaskAddedPayloadSchema,
@@ -30,5 +44,11 @@ exports.WebhookPayloadSchema = zod_1.z.discriminatedUnion('eventName', [
     tasks_1.TaskCompletedPayloadSchema,
     tasks_1.TaskUncompletedPayloadSchema,
     tasks_1.TaskDeletedPayloadSchema,
+    comments_1.CommentAddedPayloadSchema,
+    comments_1.CommentUpdatedPayloadSchema,
+    comments_1.CommentDeletedPayloadSchema,
+    labels_1.LabelAddedPayloadSchema,
+    labels_1.LabelUpdatedPayloadSchema,
+    labels_1.LabelDeletedPayloadSchema,
     exports.UntypedWebhookPayloadSchema,
 ]);

package/dist/esm/test-utils/webhook-fixtures.js

@@ -0,0 +1,26 @@
+import { createHmac } from 'node:crypto';
+export const CLIENT_SECRET = 'test-client-secret';
+/** HMAC-SHA256 signs a raw body with the test client secret (or an override). */
+export function sign(body, secret = CLIENT_SECRET) {
+    return createHmac('sha256', secret).update(body).digest('base64');
+}
+/**
+ * Snake_case task payload matching the v1 webhook wire shape.
+ */
+export function rawTask(overrides = {}) {
+    return Object.assign({ id: '6XR4GqQQCW6Gv9h4', user_id: '2671355', project_id: '6XR4H993xv8H5qCR', section_id: null, parent_id: null, added_by_uid: '2671355', assigned_by_uid: null, responsible_uid: null, labels: [], deadline: null, duration: null, is_collapsed: false, checked: false, is_deleted: false, added_at: '2025-02-10T10:33:38.000000Z', completed_at: null, completed_by_uid: null, updated_at: '2025-02-10T10:33:38.000000Z', due: null, priority: 1, child_order: 3, content: 'Buy Milk', description: '', note_count: 0, day_order: -1, goal_ids: [], url: 'https://app.todoist.com/app/task/6XR4GqQQCW6Gv9h4' }, overrides);
+}
+/**
+ * Wraps an event's `event_data` in the snake_case envelope the backend sends
+ * (initiator, version, timestamps, etc). `extra` passes extra top-level keys
+ * like `event_data_extra`.
+ */
+export function envelope(event, eventData, extra) {
+    return Object.assign({ version: '1', user_id: '2671355', initiator: {
+            id: '2671355',
+            full_name: 'Alice',
+            email: 'alice@example.com',
+            image_id: 'ad38375bdb094286af59f1eab36d8f20',
+            is_premium: true,
+        }, event_name: event, event_data: eventData, triggered_at: '2025-02-10T10:39:38.000000Z' }, extra);
+}

package/dist/esm/types/webhooks/comments.js

@@ -0,0 +1,93 @@
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+import { z } from 'zod';
+import { AttachmentSchema } from '../comments/types.js';
+import { TaskSchema } from '../tasks/types.js';
+import { BaseWebhookEnvelopeShape } from './envelope.js';
+/**
+ * Enum-like object of comment (`note:*`) webhook event names. Single source
+ * of truth for the discriminator values — `COMMENT_WEBHOOK_EVENTS` and every
+ * `z.literal()` below derive from it.
+ *
+ * The on-the-wire event names remain `note:*` for historical reasons; the
+ * SDK types use `Comment*` to match the rest of the public API where the
+ * resource is named `Comment`.
+ */
+export const CommentWebhookEventEnum = {
+    Added: 'note:added',
+    Updated: 'note:updated',
+    Deleted: 'note:deleted',
+};
+/**
+ * Webhook events that carry a comment as their `eventData`.
+ */
+export const COMMENT_WEBHOOK_EVENTS = [
+    CommentWebhookEventEnum.Added,
+    CommentWebhookEventEnum.Updated,
+    CommentWebhookEventEnum.Deleted,
+];
+/**
+ * Fields common to both item and project comment payloads.
+ *
+ * `postedAt` and `postedUid` are nullable here (unlike
+ * {@link RawCommentSchema}) because webhook payloads may omit them — for
+ * example when the poster could not be resolved, or on a deleted-note
+ * tombstone.
+ */
+const WebhookCommentBaseSchema = z.object({
+    id: z.string(),
+    content: z.string(),
+    postedAt: z.coerce.date().nullable(),
+    postedUid: z.string().nullable(),
+    fileAttachment: AttachmentSchema.nullable(),
+    uidsToNotify: z.array(z.string()).nullable(),
+    reactions: z.record(z.string(), z.array(z.string())).nullable(),
+    isDeleted: z.boolean(),
+});
+/**
+ * A comment attached to a task, delivered in a webhook payload.
+ *
+ * Webhook item-comment payloads carry two fields that don't appear on the
+ * REST comment resource: `url` (the direct task URL) and `item` (the full
+ * embedded {@link Task}). Both are parsed here so consumers handling a
+ * `note:added` event also get the task it belongs to.
+ *
+ * `itemId` is exposed as `taskId` to match the rest of the SDK surface.
+ */
+export const WebhookItemCommentSchema = WebhookCommentBaseSchema.extend({
+    itemId: z.string(),
+    url: z.string(),
+    item: TaskSchema,
+})
+    .strict()
+    .transform((_a) => {
+    var { itemId } = _a, rest = __rest(_a, ["itemId"]);
+    return (Object.assign(Object.assign({}, rest), { taskId: itemId }));
+});
+/**
+ * A comment attached to a project, delivered in a webhook payload.
+ *
+ * Project comments do not carry the extra `url` or embedded project fields
+ * that item comments carry for the parent task.
+ */
+export const WebhookProjectCommentSchema = WebhookCommentBaseSchema.extend({
+    projectId: z.string(),
+}).strict();
+/**
+ * The `eventData` of a `note:*` webhook payload — either an item comment
+ * (includes `taskId` and an embedded {@link Task}) or a project comment
+ * (includes `projectId`). Narrow with `'taskId' in eventData`.
+ */
+export const WebhookCommentSchema = z.union([WebhookItemCommentSchema, WebhookProjectCommentSchema]);
+export const CommentAddedPayloadSchema = z.object(Object.assign(Object.assign({}, BaseWebhookEnvelopeShape), { eventName: z.literal(CommentWebhookEventEnum.Added), eventData: WebhookCommentSchema }));
+export const CommentUpdatedPayloadSchema = z.object(Object.assign(Object.assign({}, BaseWebhookEnvelopeShape), { eventName: z.literal(CommentWebhookEventEnum.Updated), eventData: WebhookCommentSchema }));
+export const CommentDeletedPayloadSchema = z.object(Object.assign(Object.assign({}, BaseWebhookEnvelopeShape), { eventName: z.literal(CommentWebhookEventEnum.Deleted), eventData: WebhookCommentSchema }));

package/dist/esm/types/webhooks/index.js

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

package/dist/esm/types/webhooks/labels.js

@@ -0,0 +1,51 @@
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+import { z } from 'zod';
+import { LabelSchema } from '../labels/types.js';
+import { BaseWebhookEnvelopeShape } from './envelope.js';
+/**
+ * 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 const LabelWebhookEventEnum = {
+    Added: 'label:added',
+    Updated: 'label:updated',
+    Deleted: 'label:deleted',
+};
+/** Webhook events that carry a label as their `eventData`. */
+export const LABEL_WEBHOOK_EVENTS = [
+    LabelWebhookEventEnum.Added,
+    LabelWebhookEventEnum.Updated,
+    LabelWebhookEventEnum.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 const WebhookLabelSchema = LabelSchema.omit({ order: true })
+    .extend({
+    itemOrder: z.number().int().nullable(),
+    isDeleted: z.boolean(),
+})
+    .transform((_a) => {
+    var { itemOrder } = _a, rest = __rest(_a, ["itemOrder"]);
+    return (Object.assign(Object.assign({}, rest), { order: itemOrder }));
+});
+export const LabelAddedPayloadSchema = z.object(Object.assign(Object.assign({}, BaseWebhookEnvelopeShape), { eventName: z.literal(LabelWebhookEventEnum.Added), eventData: WebhookLabelSchema }));
+export const LabelUpdatedPayloadSchema = z.object(Object.assign(Object.assign({}, BaseWebhookEnvelopeShape), { eventName: z.literal(LabelWebhookEventEnum.Updated), eventData: WebhookLabelSchema }));
+export const LabelDeletedPayloadSchema = z.object(Object.assign(Object.assign({}, BaseWebhookEnvelopeShape), { eventName: z.literal(LabelWebhookEventEnum.Deleted), eventData: WebhookLabelSchema }));

package/dist/esm/types/webhooks/types.js

@@ -1,12 +1,24 @@
 import { z } from 'zod';
 import { WEBHOOK_EVENTS, WebhookEventSchema } from '../apps/types.js';
+import { COMMENT_WEBHOOK_EVENTS, CommentAddedPayloadSchema, CommentDeletedPayloadSchema, CommentUpdatedPayloadSchema, } from './comments.js';
 import { BaseWebhookEnvelopeShape } from './envelope.js';
+import { LABEL_WEBHOOK_EVENTS, LabelAddedPayloadSchema, LabelDeletedPayloadSchema, LabelUpdatedPayloadSchema, } from './labels.js';
 import { TASK_WEBHOOK_EVENTS, TaskAddedPayloadSchema, TaskCompletedPayloadSchema, TaskDeletedPayloadSchema, TaskUncompletedPayloadSchema, TaskUpdatedPayloadSchema, } from './tasks.js';
-const untypedEventNames = WEBHOOK_EVENTS.filter((event) => !TASK_WEBHOOK_EVENTS.includes(event));
+/**
+ * Events whose payloads have been narrowed per resource. Each phase adds to
+ * this list; {@link UntypedWebhookPayloadSchema} below is derived by taking
+ * every {@link WebhookEvent} not present here.
+ */
+const TYPED_WEBHOOK_EVENTS = [
+    ...TASK_WEBHOOK_EVENTS,
+    ...COMMENT_WEBHOOK_EVENTS,
+    ...LABEL_WEBHOOK_EVENTS,
+];
+const untypedEventNames = WEBHOOK_EVENTS.filter((event) => !TYPED_WEBHOOK_EVENTS.includes(event));
 /**
  * A single branch covering every event whose payload has not yet been typed
  * per resource. Follow-up PRs will replace slices of this with dedicated
- * variants (notes, projects, sections, labels, filters, reminders).
+ * variants (projects, sections, filters, reminders).
  */
 export const UntypedWebhookPayloadSchema = z.object(Object.assign(Object.assign({}, BaseWebhookEnvelopeShape), { eventName: z.enum(untypedEventNames), eventData: z.unknown(), eventDataExtra: z.unknown().optional() }));
 /**
@@ -16,9 +28,11 @@ export const UntypedWebhookPayloadSchema = z.object(Object.assign(Object.assign(
  * (`item:added`) in the `event_name` field, so consumers using
  * `parseWebhookPayload` receive camelCase fields directly.
  *
- * Typed today: `item:*` events carry a parsed {@link Task}. Other events
- * still expose `eventData` as `unknown`; they will be narrowed in follow-up
- * PRs (notes, projects, sections, labels, filters, reminders).
+ * Typed today: `item:*` events carry a parsed {@link Task}; `note:*` events
+ * carry a parsed comment (item-comment or project-comment); `label:*` events
+ * carry a parsed label. Other events still expose `eventData` as `unknown`;
+ * they will be narrowed in follow-up PRs (projects, sections, filters,
+ * reminders).
  */
 export const WebhookPayloadSchema = z.discriminatedUnion('eventName', [
     TaskAddedPayloadSchema,
@@ -26,6 +40,12 @@ export const WebhookPayloadSchema = z.discriminatedUnion('eventName', [
     TaskCompletedPayloadSchema,
     TaskUncompletedPayloadSchema,
     TaskDeletedPayloadSchema,
+    CommentAddedPayloadSchema,
+    CommentUpdatedPayloadSchema,
+    CommentDeletedPayloadSchema,
+    LabelAddedPayloadSchema,
+    LabelUpdatedPayloadSchema,
+    LabelDeletedPayloadSchema,
     UntypedWebhookPayloadSchema,
 ]);
 export { WebhookEventSchema };

package/dist/types/test-utils/webhook-fixtures.d.ts

@@ -0,0 +1,13 @@
+export declare const CLIENT_SECRET = "test-client-secret";
+/** HMAC-SHA256 signs a raw body with the test client secret (or an override). */
+export declare function sign(body: string, secret?: string): string;
+/**
+ * Snake_case task payload matching the v1 webhook wire shape.
+ */
+export declare function rawTask(overrides?: Record<string, unknown>): Record<string, unknown>;
+/**
+ * Wraps an event's `event_data` in the snake_case envelope the backend sends
+ * (initiator, version, timestamps, etc). `extra` passes extra top-level keys
+ * like `event_data_extra`.
+ */
+export declare function envelope(event: string, eventData: unknown, extra?: Record<string, unknown>): Record<string, unknown>;