@doist/todoist-sdk 9.4.0 → 9.6.0

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

@@ -0,0 +1,45 @@
+import { z } from 'zod';
+import { getSectionUrl } from '../../utils/url-helpers.js';
+import { SectionBaseSchema } from '../sections/types.js';
+import { BaseWebhookEnvelopeShape } from './envelope.js';
+/**
+ * Enum-like object of section (`section:*`) webhook event names. Single
+ * source of truth for the discriminator values — `SECTION_WEBHOOK_EVENTS`
+ * and every `z.literal()` below derive from it.
+ */
+export const SectionWebhookEventEnum = {
+    Added: 'section:added',
+    Updated: 'section:updated',
+    Deleted: 'section:deleted',
+    Archived: 'section:archived',
+    Unarchived: 'section:unarchived',
+};
+/** Webhook events that carry a section as their `eventData`. */
+export const SECTION_WEBHOOK_EVENTS = [
+    SectionWebhookEventEnum.Added,
+    SectionWebhookEventEnum.Updated,
+    SectionWebhookEventEnum.Deleted,
+    SectionWebhookEventEnum.Archived,
+    SectionWebhookEventEnum.Unarchived,
+];
+/**
+ * A section as delivered in a webhook payload.
+ *
+ * Reuses {@link SectionBaseSchema} and overrides `updatedAt` to tolerate
+ * payloads that deliver it as `null` or omit the key entirely — tombstones
+ * and never-updated sections come through without an `updated_at` value.
+ * The result is normalised to `Date | null` so consumers don't have to
+ * handle three shapes. Surfaces the computed `url` so the exposed shape
+ * matches {@link Section}.
+ */
+export const WebhookSectionSchema = SectionBaseSchema.extend({
+    updatedAt: z.coerce
+        .date()
+        .nullish()
+        .transform((value) => value !== null && value !== void 0 ? value : null),
+}).transform((data) => (Object.assign(Object.assign({}, data), { url: getSectionUrl(data.id, data.name) })));
+export const SectionAddedPayloadSchema = z.object(Object.assign(Object.assign({}, BaseWebhookEnvelopeShape), { eventName: z.literal(SectionWebhookEventEnum.Added), eventData: WebhookSectionSchema }));
+export const SectionUpdatedPayloadSchema = z.object(Object.assign(Object.assign({}, BaseWebhookEnvelopeShape), { eventName: z.literal(SectionWebhookEventEnum.Updated), eventData: WebhookSectionSchema }));
+export const SectionDeletedPayloadSchema = z.object(Object.assign(Object.assign({}, BaseWebhookEnvelopeShape), { eventName: z.literal(SectionWebhookEventEnum.Deleted), eventData: WebhookSectionSchema }));
+export const SectionArchivedPayloadSchema = z.object(Object.assign(Object.assign({}, BaseWebhookEnvelopeShape), { eventName: z.literal(SectionWebhookEventEnum.Archived), eventData: WebhookSectionSchema }));
+export const SectionUnarchivedPayloadSchema = z.object(Object.assign(Object.assign({}, BaseWebhookEnvelopeShape), { eventName: z.literal(SectionWebhookEventEnum.Unarchived), eventData: WebhookSectionSchema }));

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

@@ -1,12 +1,28 @@
 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 { PROJECT_WEBHOOK_EVENTS, ProjectAddedPayloadSchema, ProjectArchivedPayloadSchema, ProjectDeletedPayloadSchema, ProjectUnarchivedPayloadSchema, ProjectUpdatedPayloadSchema, } from './projects.js';
+import { SECTION_WEBHOOK_EVENTS, SectionAddedPayloadSchema, SectionArchivedPayloadSchema, SectionDeletedPayloadSchema, SectionUnarchivedPayloadSchema, SectionUpdatedPayloadSchema, } from './sections.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,
+    ...PROJECT_WEBHOOK_EVENTS,
+    ...SECTION_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 (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 +32,12 @@ 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; `project:*` events carry a parsed {@link Project}
+ * (personal or workspace); `section:*` events carry a parsed
+ * {@link WebhookSection}. Other events still expose `eventData` as
+ * `unknown`; they will be narrowed in follow-up PRs (filters, reminders).
  */
 export const WebhookPayloadSchema = z.discriminatedUnion('eventName', [
     TaskAddedPayloadSchema,
@@ -26,6 +45,22 @@ export const WebhookPayloadSchema = z.discriminatedUnion('eventName', [
     TaskCompletedPayloadSchema,
     TaskUncompletedPayloadSchema,
     TaskDeletedPayloadSchema,
+    CommentAddedPayloadSchema,
+    CommentUpdatedPayloadSchema,
+    CommentDeletedPayloadSchema,
+    LabelAddedPayloadSchema,
+    LabelUpdatedPayloadSchema,
+    LabelDeletedPayloadSchema,
+    ProjectAddedPayloadSchema,
+    ProjectUpdatedPayloadSchema,
+    ProjectDeletedPayloadSchema,
+    ProjectArchivedPayloadSchema,
+    ProjectUnarchivedPayloadSchema,
+    SectionAddedPayloadSchema,
+    SectionUpdatedPayloadSchema,
+    SectionDeletedPayloadSchema,
+    SectionArchivedPayloadSchema,
+    SectionUnarchivedPayloadSchema,
     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>;

package/dist/types/types/sections/types.d.ts

@@ -1,4 +1,22 @@
 import { z } from 'zod';
+/**
+ * Raw section fields (the persisted shape). Exposed so schemas that extend
+ * or override a field — notably the webhook variant — can reuse the base
+ * without duplicating every field.
+ */
+export declare const SectionBaseSchema: z.ZodObject<{
+    id: z.ZodString;
+    userId: z.ZodString;
+    projectId: z.ZodString;
+    addedAt: z.ZodCoercedDate<unknown>;
+    updatedAt: z.ZodCoercedDate<unknown>;
+    archivedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+    name: z.ZodString;
+    sectionOrder: z.ZodNumber;
+    isArchived: z.ZodBoolean;
+    isDeleted: z.ZodBoolean;
+    isCollapsed: z.ZodBoolean;
+}, z.core.$strip>;
 export declare const SectionSchema: z.ZodPipe<z.ZodObject<{
     id: z.ZodString;
     userId: z.ZodString;