@todoist/sdk 0.0.1 → 18.0.0

package/dist/esm/test-utils/obsidian-fetch-adapter.js

@@ -0,0 +1,51 @@
+/**
+ * Creates a CustomFetch adapter for Obsidian's requestUrl API.
+ *
+ * This adapter bridges the gap between Obsidian's requestUrl interface and the
+ * standard fetch-like interface expected by the Todoist API SDK.
+ *
+ * Key differences handled by this adapter:
+ * - Obsidian returns response data as properties (response.json, response.text)
+ *   while the SDK expects methods (response.json(), response.text())
+ * - Obsidian's requestUrl bypasses CORS restrictions that would block standard fetch
+ * - Obsidian throws on HTTP errors by default; we set throw: false to handle manually
+ * - Obsidian doesn't provide statusText; we default to empty string
+ *
+ * @example
+ * ```typescript
+ * import { requestUrl } from 'obsidian';
+ * import { createObsidianFetchAdapter } from './obsidian-fetch-adapter.js';
+ *
+ * const api = new TodoistApi('your-token', {
+ *   customFetch: createObsidianFetchAdapter(requestUrl)
+ * });
+ * ```
+ *
+ * @param requestUrl - The Obsidian requestUrl function
+ * @returns A CustomFetch function compatible with the Todoist API SDK
+ */
+export function createObsidianFetchAdapter(requestUrl) {
+    return async (url, options) => {
+        // Build the request parameters in Obsidian's format
+        const requestParams = {
+            url,
+            method: (options === null || options === void 0 ? void 0 : options.method) || 'GET',
+            headers: options === null || options === void 0 ? void 0 : options.headers,
+            body: options === null || options === void 0 ? void 0 : options.body,
+            throw: false, // Don't throw on HTTP errors; let the SDK handle status codes
+        };
+        // Make the request using Obsidian's requestUrl
+        const response = await requestUrl(requestParams);
+        // Transform Obsidian's response format to match CustomFetchResponse interface
+        return {
+            ok: response.status >= 200 && response.status < 300,
+            status: response.status,
+            statusText: '', // Obsidian doesn't provide statusText
+            headers: response.headers,
+            // Wrap Obsidian's direct properties as methods returning promises
+            text: () => Promise.resolve(response.text),
+            json: () => Promise.resolve(response.json),
+            arrayBuffer: () => Promise.resolve(response.arrayBuffer),
+        };
+    };
+}

package/dist/esm/test-utils/test-defaults.js

@@ -0,0 +1,367 @@
+import { getProjectUrl, getTaskUrl, getSectionUrl } from '../utils/url-helpers.js';
+export const DEFAULT_TASK_ID = '1234';
+export const DEFAULT_TASK_CONTENT = 'This is a task';
+export const DEFAULT_TASK_DESCRIPTION = 'A description';
+export const DEFAULT_TASK_PRIORITY = 1;
+export const DEFAULT_ORDER = 3;
+export const DEFAULT_PROJECT_ID = '123';
+export const DEFAULT_PROJECT_NAME = 'This is a project';
+export const DEFAULT_PROJECT_VIEW_STYLE = 'list';
+const DEFAULT_LABEL_ID = '456';
+const DEFAULT_LABEL_NAME = 'This is a label';
+const DEFAULT_SECTION_ID = '456';
+const DEFAULT_SECTION_NAME = 'This is a section';
+const DEFAULT_PARENT_ID = '5678';
+const DEFAULT_ASSIGNEE = '1234';
+const DEFAULT_CREATOR = '1234';
+const DEFAULT_DATE = '2020-09-08T12:00:00Z';
+function defaultDate() {
+    return new Date(DEFAULT_DATE);
+}
+const DEFAULT_ENTITY_COLOR = 'berry_red';
+const DEFAULT_LABELS = ['personal', 'work', 'hobby'];
+const DEFAULT_USER_ID = '5';
+const DEFAULT_USER_NAME = 'A User';
+const DEFAULT_USER_EMAIL = 'atestuser@doist.com';
+const DEFAULT_COMMENT_ID = '4';
+const DEFAULT_COMMENT_CONTENT = 'A comment';
+const DEFAULT_COMMENT_REACTIONS = { '👍': ['1234', '5678'] };
+const DEFAULT_CAN_ASSIGN_TASKS = true;
+const DEFAULT_IS_ARCHIVED = false;
+const DEFAULT_IS_DELETED = false;
+const DEFAULT_IS_FROZEN = false;
+const DEFAULT_IS_COLLAPSED = false;
+// URL constants using the helper functions
+const DEFAULT_TASK_URL = getTaskUrl(DEFAULT_TASK_ID, DEFAULT_TASK_CONTENT);
+const DEFAULT_PROJECT_URL = getProjectUrl(DEFAULT_PROJECT_ID, DEFAULT_PROJECT_NAME);
+const DEFAULT_SECTION_URL = getSectionUrl(DEFAULT_SECTION_ID, DEFAULT_SECTION_NAME);
+export const DEFAULT_AUTH_TOKEN = 'AToken';
+export const DEFAULT_REQUEST_ID = 'ARequestID';
+export const INVALID_ENTITY_ID = 1234;
+export const DEFAULT_DUE_DATE = {
+    isRecurring: false,
+    string: 'a date string',
+    date: DEFAULT_DATE,
+    lang: 'en',
+    timezone: null,
+};
+export const DEFAULT_DURATION = {
+    amount: 10,
+    unit: 'minute',
+};
+export const DEFAULT_DEADLINE = {
+    date: '2020-09-08',
+    lang: 'en',
+};
+export const DEFAULT_TASK = {
+    id: DEFAULT_TASK_ID,
+    userId: DEFAULT_CREATOR,
+    projectId: DEFAULT_PROJECT_ID,
+    sectionId: DEFAULT_SECTION_ID,
+    parentId: DEFAULT_PARENT_ID,
+    addedByUid: DEFAULT_CREATOR,
+    assignedByUid: DEFAULT_CREATOR,
+    responsibleUid: DEFAULT_ASSIGNEE,
+    labels: DEFAULT_LABELS,
+    deadline: DEFAULT_DEADLINE,
+    duration: DEFAULT_DURATION,
+    checked: false,
+    isDeleted: DEFAULT_IS_DELETED,
+    addedAt: defaultDate(),
+    completedAt: null,
+    updatedAt: defaultDate(),
+    due: DEFAULT_DUE_DATE,
+    priority: DEFAULT_TASK_PRIORITY,
+    childOrder: DEFAULT_ORDER,
+    content: DEFAULT_TASK_CONTENT,
+    description: DEFAULT_TASK_DESCRIPTION,
+    dayOrder: DEFAULT_ORDER,
+    isCollapsed: DEFAULT_IS_COLLAPSED,
+    isUncompletable: false,
+    url: DEFAULT_TASK_URL,
+};
+export const INVALID_TASK = Object.assign(Object.assign({}, DEFAULT_TASK), { due: '2020-01-31' });
+export const TASK_WITH_OPTIONALS_AS_NULL = {
+    userId: DEFAULT_CREATOR,
+    id: DEFAULT_TASK_ID,
+    projectId: DEFAULT_PROJECT_ID,
+    sectionId: null,
+    parentId: null,
+    addedByUid: DEFAULT_CREATOR,
+    assignedByUid: null,
+    responsibleUid: null,
+    labels: [],
+    deadline: null,
+    duration: null,
+    checked: false,
+    isDeleted: DEFAULT_IS_DELETED,
+    addedAt: defaultDate(),
+    completedAt: null,
+    updatedAt: defaultDate(),
+    due: null,
+    priority: DEFAULT_TASK_PRIORITY,
+    childOrder: DEFAULT_ORDER,
+    content: DEFAULT_TASK_CONTENT,
+    description: DEFAULT_TASK_DESCRIPTION,
+    dayOrder: DEFAULT_ORDER,
+    isCollapsed: DEFAULT_IS_COLLAPSED,
+    isUncompletable: false,
+    url: DEFAULT_TASK_URL,
+};
+export const DEFAULT_PROJECT = {
+    id: DEFAULT_PROJECT_ID,
+    name: DEFAULT_PROJECT_NAME,
+    color: DEFAULT_ENTITY_COLOR,
+    childOrder: DEFAULT_ORDER,
+    parentId: DEFAULT_PROJECT_ID,
+    isFavorite: false,
+    isShared: false,
+    inboxProject: false,
+    viewStyle: DEFAULT_PROJECT_VIEW_STYLE,
+    canAssignTasks: DEFAULT_CAN_ASSIGN_TASKS,
+    isArchived: DEFAULT_IS_ARCHIVED,
+    isDeleted: DEFAULT_IS_DELETED,
+    isFrozen: DEFAULT_IS_FROZEN,
+    createdAt: defaultDate(),
+    updatedAt: defaultDate(),
+    defaultOrder: DEFAULT_ORDER,
+    description: '',
+    isCollapsed: DEFAULT_IS_COLLAPSED,
+    url: DEFAULT_PROJECT_URL,
+};
+export const INVALID_PROJECT = Object.assign(Object.assign({}, DEFAULT_PROJECT), { name: 123 });
+export const PROJECT_WITH_OPTIONALS_AS_NULL = Object.assign(Object.assign({}, DEFAULT_PROJECT), { parentId: null });
+export const DEFAULT_WORKSPACE_PROJECT = {
+    id: DEFAULT_PROJECT_ID,
+    name: DEFAULT_PROJECT_NAME,
+    color: DEFAULT_ENTITY_COLOR,
+    childOrder: DEFAULT_ORDER,
+    isFavorite: false,
+    isShared: true,
+    viewStyle: DEFAULT_PROJECT_VIEW_STYLE,
+    canAssignTasks: DEFAULT_CAN_ASSIGN_TASKS,
+    isArchived: DEFAULT_IS_ARCHIVED,
+    isDeleted: DEFAULT_IS_DELETED,
+    isFrozen: DEFAULT_IS_FROZEN,
+    createdAt: defaultDate(),
+    updatedAt: defaultDate(),
+    defaultOrder: DEFAULT_ORDER,
+    description: '',
+    isCollapsed: DEFAULT_IS_COLLAPSED,
+    url: DEFAULT_PROJECT_URL,
+    workspaceId: '100',
+    folderId: null,
+    collaboratorRoleDefault: 'READ_WRITE',
+    isInviteOnly: false,
+    isLinkSharingEnabled: true,
+    role: 'ADMIN',
+    status: 'ACTIVE',
+};
+export const DEFAULT_SECTION = {
+    id: DEFAULT_SECTION_ID,
+    userId: DEFAULT_USER_ID,
+    projectId: DEFAULT_PROJECT_ID,
+    addedAt: new Date('2025-03-28T14:01:23.334881Z'),
+    updatedAt: new Date('2025-03-28T14:01:23.334885Z'),
+    archivedAt: null,
+    name: DEFAULT_SECTION_NAME,
+    description: null,
+    sectionOrder: DEFAULT_ORDER,
+    isArchived: false,
+    isDeleted: false,
+    isCollapsed: false,
+    url: DEFAULT_SECTION_URL,
+};
+export const INVALID_SECTION = Object.assign(Object.assign({}, DEFAULT_SECTION), { projectId: undefined });
+export const DEFAULT_LABEL = {
+    id: DEFAULT_LABEL_ID,
+    name: DEFAULT_LABEL_NAME,
+    color: DEFAULT_ENTITY_COLOR,
+    order: DEFAULT_ORDER,
+    isFavorite: false,
+};
+export const INVALID_LABEL = Object.assign(Object.assign({}, DEFAULT_LABEL), { isFavorite: 'true' });
+export const DEFAULT_USER = {
+    id: DEFAULT_USER_ID,
+    name: DEFAULT_USER_NAME,
+    email: DEFAULT_USER_EMAIL,
+};
+export const INVALID_USER = Object.assign(Object.assign({}, DEFAULT_USER), { email: undefined });
+export const DEFAULT_ATTACHMENT = {
+    resourceType: 'file',
+    fileType: 'image/png',
+    fileUrl: 'https://someurl.com/image.jpg',
+    uploadState: 'completed',
+};
+export const INVALID_ATTACHMENT = Object.assign(Object.assign({}, DEFAULT_ATTACHMENT), { uploadState: 'something random' });
+export const DEFAULT_RAW_COMMENT = {
+    id: DEFAULT_COMMENT_ID,
+    postedUid: DEFAULT_USER_ID,
+    content: DEFAULT_COMMENT_CONTENT,
+    fileAttachment: DEFAULT_ATTACHMENT,
+    uidsToNotify: null,
+    isDeleted: false,
+    postedAt: defaultDate(),
+    reactions: DEFAULT_COMMENT_REACTIONS,
+    itemId: DEFAULT_TASK_ID,
+};
+export const DEFAULT_COMMENT = Object.assign(Object.assign({}, DEFAULT_RAW_COMMENT), { taskId: DEFAULT_RAW_COMMENT.itemId, itemId: undefined });
+export const DEFAULT_REMINDER_ID = '6XGgmFQrx44wfGHr';
+export const DEFAULT_RELATIVE_REMINDER = {
+    id: DEFAULT_REMINDER_ID,
+    itemId: DEFAULT_TASK_ID,
+    notifyUid: DEFAULT_USER_ID,
+    isDeleted: false,
+    type: 'relative',
+    minuteOffset: 30,
+    due: DEFAULT_DUE_DATE,
+    isUrgent: false,
+};
+export const DEFAULT_ABSOLUTE_REMINDER = {
+    id: DEFAULT_REMINDER_ID,
+    itemId: DEFAULT_TASK_ID,
+    notifyUid: DEFAULT_USER_ID,
+    isDeleted: false,
+    type: 'absolute',
+    due: DEFAULT_DUE_DATE,
+    isUrgent: true,
+};
+export const DEFAULT_LOCATION_REMINDER = {
+    id: DEFAULT_REMINDER_ID,
+    itemId: DEFAULT_TASK_ID,
+    notifyUid: DEFAULT_USER_ID,
+    isDeleted: false,
+    type: 'location',
+    name: 'Aliados',
+    locLat: '41.148581',
+    locLong: '-8.610945000000015',
+    locTrigger: 'on_enter',
+    radius: 100,
+};
+export const INVALID_COMMENT = Object.assign(Object.assign({}, DEFAULT_RAW_COMMENT), { isDeleted: 'true' });
+export const RAW_COMMENT_WITH_OPTIONALS_AS_NULL_TASK = Object.assign(Object.assign({}, DEFAULT_RAW_COMMENT), { fileAttachment: null, uidsToNotify: null, reactions: null });
+export const COMMENT_WITH_OPTIONALS_AS_NULL_TASK = Object.assign(Object.assign({}, RAW_COMMENT_WITH_OPTIONALS_AS_NULL_TASK), { taskId: RAW_COMMENT_WITH_OPTIONALS_AS_NULL_TASK.itemId, itemId: undefined });
+export const RAW_COMMENT_WITH_ATTACHMENT_WITH_OPTIONALS_AS_NULL = Object.assign(Object.assign({}, DEFAULT_RAW_COMMENT), { fileAttachment: {
+        resourceType: 'file',
+        fileName: null,
+        fileSize: null,
+        fileType: null,
+        fileDuration: null,
+        uploadState: null,
+        image: null,
+        imageWidth: null,
+        imageHeight: null,
+        url: null,
+        title: null,
+    } });
+export const COMMENT_WITH_ATTACHMENT_WITH_OPTIONALS_AS_NULL = Object.assign(Object.assign({}, RAW_COMMENT_WITH_ATTACHMENT_WITH_OPTIONALS_AS_NULL), { taskId: RAW_COMMENT_WITH_ATTACHMENT_WITH_OPTIONALS_AS_NULL.itemId, itemId: undefined });
+export const RAW_COMMENT_WITH_OPTIONALS_AS_NULL_PROJECT = Object.assign(Object.assign({}, DEFAULT_RAW_COMMENT), { itemId: undefined, projectId: DEFAULT_PROJECT_ID });
+export const COMMENT_WITH_OPTIONALS_AS_NULL_PROJECT = Object.assign(Object.assign({}, RAW_COMMENT_WITH_OPTIONALS_AS_NULL_PROJECT), { taskId: undefined });
+export const DEFAULT_FOLDER = {
+    id: '789',
+    name: 'This is a folder',
+    workspaceId: '100',
+    defaultOrder: 3,
+    childOrder: 3,
+    isDeleted: false,
+};
+export const DEFAULT_COLLABORATOR = {
+    id: DEFAULT_USER_ID,
+    email: DEFAULT_USER_EMAIL,
+    fullName: DEFAULT_USER_NAME,
+    timezone: 'UTC',
+    imageId: null,
+};
+export const DEFAULT_COLLABORATOR_STATE = {
+    userId: DEFAULT_USER_ID,
+    projectId: DEFAULT_PROJECT_ID,
+    state: 'active',
+    isDeleted: false,
+};
+export const DEFAULT_APP_ID = '42';
+export const DEFAULT_INSTALLATION_ID = '1001';
+export const DEFAULT_UI_EXTENSION_ID = '2002';
+export const DEFAULT_DISTRIBUTION_TOKEN = 'dist-token-abc';
+export const DEFAULT_ACCESS_TOKEN_ID = '3003';
+export const DEFAULT_APP = {
+    id: DEFAULT_APP_ID,
+    clientId: 'client-id-xyz',
+    status: 'public',
+    displayName: 'Sample App',
+    userId: DEFAULT_USER_ID,
+    createdAt: defaultDate(),
+    serviceUrl: 'https://example.com',
+    oauthRedirectUri: 'https://example.com/callback',
+    description: 'A sample app',
+    iconSm: 'https://example.com/icon-sm.png',
+    iconMd: 'https://example.com/icon-md.png',
+    iconLg: 'https://example.com/icon-lg.png',
+    appTokenScopes: ['data:read', 'task:add'],
+};
+export const DEFAULT_APP_WITH_USER_COUNT = Object.assign(Object.assign({}, DEFAULT_APP), { userCount: 12 });
+export const DEFAULT_APP_SECRETS = {
+    clientId: 'client-id-xyz',
+    clientSecret: 'client-secret-xyz',
+};
+export const DEFAULT_APP_VERIFICATION_TOKEN = {
+    verificationToken: 'verif-token-abc',
+};
+export const DEFAULT_APP_TEST_TOKEN = {
+    accessToken: 'test-token-xyz',
+};
+export const DEFAULT_APP_DISTRIBUTION_TOKEN = {
+    distributionToken: DEFAULT_DISTRIBUTION_TOKEN,
+};
+export const DEFAULT_APP_WEBHOOK = {
+    status: 'active',
+    callbackUrl: 'https://example.com/webhook',
+    version: '1',
+    events: ['item:added', 'item:completed'],
+};
+export const DEFAULT_APP_INSTALLATION = {
+    id: DEFAULT_INSTALLATION_ID,
+    creator: DEFAULT_USER_ID,
+    createdTs: 1700000000,
+    installationType: 'user',
+    appTokenScopesValidated: true,
+    integration: DEFAULT_APP,
+};
+export const DEFAULT_USER_AUTHORIZATION = {
+    accessTokenId: DEFAULT_ACCESS_TOKEN_ID,
+    scope: ['data:read', 'task:add'],
+    scopeDescriptions: ['Read data', 'Add tasks'],
+    createdAt: new Date('2025-01-01T00:00:00Z'),
+    app: {
+        id: DEFAULT_APP_ID,
+        displayName: 'Sample App',
+        description: 'A sample app',
+        serviceUrl: 'https://example.com',
+        iconMd: 'https://example.com/icon-md.png',
+    },
+};
+export const DEFAULT_UI_EXTENSION = {
+    id: DEFAULT_UI_EXTENSION_ID,
+    integrationId: DEFAULT_APP_ID,
+    extensionId: 'ext-guid-1',
+    extensionType: 'context-menu',
+    contextType: 'task',
+    url: 'https://example.com/extension',
+    icon: 'https://example.com/icon.png',
+    name: 'My Extension',
+    description: 'Does things in the task context menu',
+    width: 400,
+    height: 600,
+    defVersion: 2,
+    minimumCardistVersion: '0.60',
+};
+export const DEFAULT_NOTE = {
+    id: DEFAULT_COMMENT_ID,
+    projectId: DEFAULT_PROJECT_ID,
+    content: DEFAULT_COMMENT_CONTENT,
+    postedAt: defaultDate(),
+    fileAttachment: DEFAULT_ATTACHMENT,
+    postedUid: DEFAULT_USER_ID,
+    uidsToNotify: null,
+    reactions: DEFAULT_COMMENT_REACTIONS,
+    isDeleted: false,
+};

package/dist/esm/test-utils/transport-seam.js

@@ -0,0 +1,15 @@
+import { vi } from 'vitest';
+// In production the transport uses undici's own `fetch` (paired with the
+// dispatcher) so the request client and dispatcher stay on one undici version.
+// MSW intercepts the *global* `fetch`, not that separate undici instance, so
+// force the transport onto the global `fetch` for every test in the suite; MSW
+// then intercepts requests as usual. The real undici transport is covered
+// directly by `http-dispatcher.test.ts` and `fetch-with-retry.test.ts`, which
+// opt out of this seam with `vi.unmock('./http-dispatcher')`.
+//
+// This lives in its own setup file (not `msw-setup.ts`) because a hoisted
+// `vi.mock` in a module that also re-exports values corrupts those exports.
+vi.mock('../transport/http-dispatcher', async (importOriginal) => {
+    const actual = await importOriginal();
+    return Object.assign(Object.assign({}, actual), { getDefaultTransport: vi.fn(async () => undefined) });
+});

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, 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);
+}