@todoist/sdk 0.0.1 → 19.0.0

package/dist/types/types/ui-extensions/types.d.ts

@@ -0,0 +1,185 @@
+import { z } from 'zod';
+/**
+ * Discriminator values for the UI extension variants.
+ * Exposed as an enum-like object because the values are used in `z.literal()`
+ * across multiple variant schemas (see AGENTS.md "Discriminated unions" exception).
+ */
+export declare const UiExtensionTypeEnum: {
+    readonly ContextMenu: "context-menu";
+    readonly Composer: "composer";
+    readonly Settings: "settings";
+};
+/**
+ * All UI extension type values.
+ */
+export declare const UI_EXTENSION_TYPES: readonly ["context-menu", "composer", "settings"];
+/**
+ * Type of UI extension.
+ */
+export type UiExtensionType = (typeof UI_EXTENSION_TYPES)[number];
+/**
+ * Context locations where a context-menu extension can appear.
+ */
+export declare const CONTEXT_MENU_EXTENSION_CONTEXTS: readonly ["project", "task"];
+/**
+ * Context location of a context-menu UI extension.
+ */
+export type ContextMenuExtensionContext = (typeof CONTEXT_MENU_EXTENSION_CONTEXTS)[number];
+export declare const ContextMenuExtensionContextSchema: z.ZodEnum<{
+    task: "task";
+    project: "project";
+}>;
+/**
+ * Composer locations where a composer extension can appear.
+ */
+export declare const COMPOSER_EXTENSION_CONTEXTS: readonly ["task", "comment"];
+/**
+ * Composer location of a composer UI extension.
+ */
+export type ComposerExtensionContext = (typeof COMPOSER_EXTENSION_CONTEXTS)[number];
+export declare const ComposerExtensionContextSchema: z.ZodEnum<{
+    task: "task";
+    comment: "comment";
+}>;
+/**
+ * Shared fields across all UI extension variants.
+ */
+export declare const UiExtensionBaseSchema: z.ZodObject<{
+    id: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>;
+    integrationId: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>;
+    extensionId: z.ZodString;
+    url: z.ZodString;
+    icon: z.ZodNullable<z.ZodString>;
+    name: z.ZodString;
+    description: z.ZodString;
+    width: z.ZodNullable<z.ZodNumber>;
+    height: z.ZodNullable<z.ZodNumber>;
+    defVersion: z.ZodNumber;
+    minimumCardistVersion: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Schema for a context-menu UI extension.
+ */
+export declare const ContextMenuExtensionSchema: z.ZodObject<{
+    id: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>;
+    integrationId: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>;
+    extensionId: z.ZodString;
+    url: z.ZodString;
+    icon: z.ZodNullable<z.ZodString>;
+    name: z.ZodString;
+    description: z.ZodString;
+    width: z.ZodNullable<z.ZodNumber>;
+    height: z.ZodNullable<z.ZodNumber>;
+    defVersion: z.ZodNumber;
+    minimumCardistVersion: z.ZodString;
+    extensionType: z.ZodLiteral<"context-menu">;
+    contextType: z.ZodEnum<{
+        task: "task";
+        project: "project";
+    }>;
+}, z.core.$strip>;
+/**
+ * A context-menu UI extension.
+ */
+export type ContextMenuExtension = z.infer<typeof ContextMenuExtensionSchema>;
+/**
+ * Schema for a composer UI extension.
+ */
+export declare const ComposerExtensionSchema: z.ZodObject<{
+    id: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>;
+    integrationId: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>;
+    extensionId: z.ZodString;
+    url: z.ZodString;
+    icon: z.ZodNullable<z.ZodString>;
+    name: z.ZodString;
+    description: z.ZodString;
+    width: z.ZodNullable<z.ZodNumber>;
+    height: z.ZodNullable<z.ZodNumber>;
+    defVersion: z.ZodNumber;
+    minimumCardistVersion: z.ZodString;
+    extensionType: z.ZodLiteral<"composer">;
+    composerType: z.ZodEnum<{
+        task: "task";
+        comment: "comment";
+    }>;
+}, z.core.$strip>;
+/**
+ * A composer UI extension.
+ */
+export type ComposerExtension = z.infer<typeof ComposerExtensionSchema>;
+/**
+ * Schema for a settings UI extension.
+ */
+export declare const SettingsExtensionSchema: z.ZodObject<{
+    id: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>;
+    integrationId: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>;
+    extensionId: z.ZodString;
+    url: z.ZodString;
+    icon: z.ZodNullable<z.ZodString>;
+    name: z.ZodString;
+    description: z.ZodString;
+    width: z.ZodNullable<z.ZodNumber>;
+    height: z.ZodNullable<z.ZodNumber>;
+    defVersion: z.ZodNumber;
+    minimumCardistVersion: z.ZodString;
+    extensionType: z.ZodLiteral<"settings">;
+}, z.core.$strip>;
+/**
+ * A settings UI extension.
+ */
+export type SettingsExtension = z.infer<typeof SettingsExtensionSchema>;
+/**
+ * Discriminated union of all UI extension variants.
+ */
+export declare const UiExtensionSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    id: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>;
+    integrationId: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>;
+    extensionId: z.ZodString;
+    url: z.ZodString;
+    icon: z.ZodNullable<z.ZodString>;
+    name: z.ZodString;
+    description: z.ZodString;
+    width: z.ZodNullable<z.ZodNumber>;
+    height: z.ZodNullable<z.ZodNumber>;
+    defVersion: z.ZodNumber;
+    minimumCardistVersion: z.ZodString;
+    extensionType: z.ZodLiteral<"context-menu">;
+    contextType: z.ZodEnum<{
+        task: "task";
+        project: "project";
+    }>;
+}, z.core.$strip>, z.ZodObject<{
+    id: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>;
+    integrationId: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>;
+    extensionId: z.ZodString;
+    url: z.ZodString;
+    icon: z.ZodNullable<z.ZodString>;
+    name: z.ZodString;
+    description: z.ZodString;
+    width: z.ZodNullable<z.ZodNumber>;
+    height: z.ZodNullable<z.ZodNumber>;
+    defVersion: z.ZodNumber;
+    minimumCardistVersion: z.ZodString;
+    extensionType: z.ZodLiteral<"composer">;
+    composerType: z.ZodEnum<{
+        task: "task";
+        comment: "comment";
+    }>;
+}, z.core.$strip>, z.ZodObject<{
+    id: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>;
+    integrationId: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>;
+    extensionId: z.ZodString;
+    url: z.ZodString;
+    icon: z.ZodNullable<z.ZodString>;
+    name: z.ZodString;
+    description: z.ZodString;
+    width: z.ZodNullable<z.ZodNumber>;
+    height: z.ZodNullable<z.ZodNumber>;
+    defVersion: z.ZodNumber;
+    minimumCardistVersion: z.ZodString;
+    extensionType: z.ZodLiteral<"settings">;
+}, z.core.$strip>], "extensionType">;
+/**
+ * A UI extension attached to a developer application.
+ */
+export type UiExtension = z.infer<typeof UiExtensionSchema>;

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

@@ -0,0 +1 @@
+export * from './requests.js';

package/dist/types/types/uploads/requests.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Arguments for uploading a file.
+ * @see https://developer.todoist.com/api/v1/#tag/Uploads/operation/upload_file_api_v1_uploads_post
+ */
+export type UploadFileArgs = {
+    /**
+     * The file content to upload. Can be:
+     * - Buffer: File content as a Buffer (requires fileName)
+     * - ReadableStream: File content as a stream (requires fileName)
+     * - string: Path to a file on the filesystem (fileName is optional, will be inferred from path)
+     */
+    file: Buffer | NodeJS.ReadableStream | string | Blob;
+    /**
+     * The name of the file. Required for Buffer and Stream inputs.
+     * Optional for file path strings and File objects (will be inferred if not provided).
+     */
+    fileName?: string;
+    /**
+     * The project ID to associate the upload with.
+     */
+    projectId?: string | null;
+};
+/**
+ * Arguments for deleting an uploaded file.
+ * @see https://developer.todoist.com/api/v1/#tag/Uploads/operation/delete_upload_api_v1_uploads_delete
+ */
+export type DeleteUploadArgs = {
+    /**
+     * The URL of the file to delete.
+     */
+    fileUrl: string;
+};

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

@@ -0,0 +1 @@
+export * from './types.js';

package/dist/types/types/users/types.d.ts

@@ -0,0 +1,67 @@
+import { z } from 'zod';
+export declare const UserSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    email: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Represents a user in Todoist (simplified for collaborators).
+ * @see https://developer.todoist.com/api/v1/#tag/User
+ */
+export type User = z.infer<typeof UserSchema>;
+export declare const TimezoneInfoSchema: z.ZodObject<{
+    gmtString: z.ZodString;
+    hours: z.ZodNumber;
+    isDst: z.ZodNumber;
+    minutes: z.ZodNumber;
+    timezone: z.ZodString;
+}, z.core.$strip>;
+/** Available user premium statuses. */
+export declare const PREMIUM_STATUSES: readonly ["not_premium", "current_personal_plan", "legacy_personal_plan", "teams_business_member"];
+/** Premium subscription status of a user. */
+export type PremiumStatus = (typeof PREMIUM_STATUSES)[number];
+export declare const CurrentUserSchema: z.ZodObject<{
+    id: z.ZodString;
+    email: z.ZodString;
+    fullName: z.ZodString;
+    avatarBig: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    avatarMedium: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    avatarS640: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    avatarSmall: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    businessAccountId: z.ZodNullable<z.ZodString>;
+    isPremium: z.ZodBoolean;
+    premiumStatus: z.ZodEnum<{
+        not_premium: "not_premium";
+        current_personal_plan: "current_personal_plan";
+        legacy_personal_plan: "legacy_personal_plan";
+        teams_business_member: "teams_business_member";
+    }>;
+    dateFormat: z.ZodNumber;
+    timeFormat: z.ZodNumber;
+    weeklyGoal: z.ZodNumber;
+    dailyGoal: z.ZodNumber;
+    completedCount: z.ZodNumber;
+    completedToday: z.ZodNumber;
+    karma: z.ZodNumber;
+    karmaTrend: z.ZodString;
+    lang: z.ZodString;
+    nextWeek: z.ZodNumber;
+    startDay: z.ZodNumber;
+    startPage: z.ZodString;
+    tzInfo: z.ZodObject<{
+        gmtString: z.ZodString;
+        hours: z.ZodNumber;
+        isDst: z.ZodNumber;
+        minutes: z.ZodNumber;
+        timezone: z.ZodString;
+    }, z.core.$strip>;
+    inboxProjectId: z.ZodString;
+    daysOff: z.ZodArray<z.ZodNumber>;
+    weekendStartDay: z.ZodNumber;
+    websocketUrl: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * Represents the current authenticated user with detailed information.
+ * @see https://developer.todoist.com/api/v1/#tag/User
+ */
+export type CurrentUser = z.infer<typeof CurrentUserSchema>;