@doist/todoist-sdk 9.1.0-next.2 → 9.1.1

package/dist/esm/todoist-api.js

@@ -1,9 +1,9 @@
 import { ActivityClient } from './clients/activity-client.js';
+import { AppClient } from './clients/app-client.js';
 import { BackupClient } from './clients/backup-client.js';
 import { CommentClient } from './clients/comment-client.js';
 import { EmailClient } from './clients/email-client.js';
 import { FolderClient } from './clients/folder-client.js';
-import { GoalsClient } from './clients/goals-client.js';
 import { IdMappingClient } from './clients/id-mapping-client.js';
 import { InsightsClient } from './clients/insights-client.js';
 import { LabelClient } from './clients/label-client.js';
@@ -13,6 +13,7 @@ import { ReminderClient } from './clients/reminder-client.js';
 import { SectionClient } from './clients/section-client.js';
 import { TaskClient } from './clients/task-client.js';
 import { TemplateClient } from './clients/template-client.js';
+import { UiExtensionClient } from './clients/ui-extension-client.js';
 import { UploadClient } from './clients/upload-client.js';
 import { WorkspaceClient } from './clients/workspace-client.js';
 import { ENDPOINT_REST_USER, getSyncBaseUri } from './consts/endpoints.js';
@@ -57,7 +58,8 @@ export class TodoistApi {
         this.activityClient = new ActivityClient(clientDeps);
         this.productivityClient = new ProductivityClient(clientDeps);
         this.workspaceClient = new WorkspaceClient(clientDeps);
-        this.goalsClient = new GoalsClient(clientDeps);
+        this.appClient = new AppClient(clientDeps);
+        this.uiExtensionClient = new UiExtensionClient(clientDeps);
     }
     /**
      * Executes a raw Sync API request.
@@ -937,37 +939,6 @@ export class TodoistApi {
     async deleteFolder(id, requestId) {
         return this.folderClient.deleteFolder(id, requestId);
     }
-    // ── Goals ──
-    async getGoals(args) {
-        return this.goalsClient.getGoals(args);
-    }
-    async searchGoals(args) {
-        return this.goalsClient.searchGoals(args);
-    }
-    async getGoal(id) {
-        return this.goalsClient.getGoal(id);
-    }
-    async addGoal(args, requestId) {
-        return this.goalsClient.addGoal(args, requestId);
-    }
-    async updateGoal(id, args, requestId) {
-        return this.goalsClient.updateGoal(id, args, requestId);
-    }
-    async deleteGoal(id, requestId) {
-        return this.goalsClient.deleteGoal(id, requestId);
-    }
-    async completeGoal(id, requestId) {
-        return this.goalsClient.completeGoal(id, requestId);
-    }
-    async uncompleteGoal(id, requestId) {
-        return this.goalsClient.uncompleteGoal(id, requestId);
-    }
-    async linkTaskToGoal(args, requestId) {
-        return this.goalsClient.linkTaskToGoal(args, requestId);
-    }
-    async unlinkTaskFromGoal(args, requestId) {
-        return this.goalsClient.unlinkTaskFromGoal(args, requestId);
-    }
     // ── Backups ──
     /**
      * Retrieves a list of available backups.
@@ -1294,4 +1265,269 @@ export class TodoistApi {
     async getWorkspaceArchivedProjects(args, requestId) {
         return this.workspaceClient.getWorkspaceArchivedProjects(args, requestId);
     }
+    // ---------------------------------------------------------------------------
+    // App management (dev:app_console scope)
+    // ---------------------------------------------------------------------------
+    /**
+     * Lists all developer applications owned by the authenticated user.
+     *
+     * Requires the `dev:app_console` scope.
+     *
+     * @param requestId - Optional request ID for idempotency.
+     * @returns A promise that resolves to the list of apps.
+     */
+    async getApps(requestId) {
+        return this.appClient.getApps(requestId);
+    }
+    /**
+     * Retrieves a single developer application by ID.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    async getApp(appId, requestId) {
+        return this.appClient.getApp(appId, requestId);
+    }
+    /**
+     * Creates a new developer application.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    async addApp(args, requestId) {
+        return this.appClient.addApp(args, requestId);
+    }
+    /**
+     * Updates a developer application.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    async updateApp(appId, args, requestId) {
+        return this.appClient.updateApp(appId, args, requestId);
+    }
+    /**
+     * Deletes a developer application.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    async deleteApp(appId, requestId) {
+        return this.appClient.deleteApp(appId, requestId);
+    }
+    /**
+     * Retrieves the OAuth client credentials (client ID and secret) for an app.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    async getAppSecrets(appId, requestId) {
+        return this.appClient.getAppSecrets(appId, requestId);
+    }
+    /**
+     * Rotates the app's OAuth client secret, returning the updated app record.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    async resetAppClientSecret(appId, requestId) {
+        return this.appClient.resetAppClientSecret(appId, requestId);
+    }
+    /**
+     * Revokes every access token issued for the given app.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    async revokeAppTokens(appId, requestId) {
+        return this.appClient.revokeAppTokens(appId, requestId);
+    }
+    /**
+     * Uploads an icon for a developer application. The `size` argument
+     * selects which icon slot to update (defaults to `'medium'`).
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    async uploadAppIcon(args, requestId) {
+        return this.appClient.uploadAppIcon(args, requestId);
+    }
+    /**
+     * Gets the currently issued developer test token for an app (null if none exists).
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    async getAppTestToken(appId, requestId) {
+        return this.appClient.getAppTestToken(appId, requestId);
+    }
+    /**
+     * Creates (or rotates) a developer test token for an app.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    async createAppTestToken(appId, requestId) {
+        return this.appClient.createAppTestToken(appId, requestId);
+    }
+    /**
+     * Gets the distribution token for an app, which third parties use to install it.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    async getAppDistributionToken(appId, requestId) {
+        return this.appClient.getAppDistributionToken(appId, requestId);
+    }
+    /**
+     * Gets the current webhook verification token for an app.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    async getAppVerificationToken(appId, requestId) {
+        return this.appClient.getAppVerificationToken(appId, requestId);
+    }
+    /**
+     * Resets the webhook verification token for an app, returning the new value.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    async resetAppVerificationToken(appId, requestId) {
+        return this.appClient.resetAppVerificationToken(appId, requestId);
+    }
+    /**
+     * Resolves a public-facing app view from a distribution token. Used during
+     * the installation flow to show prospective installers what the app does
+     * and which scopes it requests.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    async getAppByDistributionToken(distributionToken, requestId) {
+        return this.appClient.getAppByDistributionToken(distributionToken, requestId);
+    }
+    /**
+     * Gets the webhook configuration for an app (null if no webhook is configured).
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    async getAppWebhook(appId, requestId) {
+        return this.appClient.getAppWebhook(appId, requestId);
+    }
+    /**
+     * Creates or updates an app webhook configuration (upsert).
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    async updateAppWebhook(args, requestId) {
+        return this.appClient.updateAppWebhook(args, requestId);
+    }
+    /**
+     * Deletes an app webhook configuration.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    async deleteAppWebhook(appId, requestId) {
+        return this.appClient.deleteAppWebhook(appId, requestId);
+    }
+    /**
+     * Lists all apps installed on the authenticated user's account.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    async getAppInstallations(requestId) {
+        return this.appClient.getAppInstallations(requestId);
+    }
+    /**
+     * Installs an application via its distribution token.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    async installApp(args, requestId) {
+        return this.appClient.installApp(args, requestId);
+    }
+    /**
+     * Retrieves a single app installation by ID.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    async getAppInstallation(installationId, requestId) {
+        return this.appClient.getAppInstallation(installationId, requestId);
+    }
+    /**
+     * Updates an app installation.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    async updateAppInstallation(installationId, args, requestId) {
+        return this.appClient.updateAppInstallation(installationId, args, requestId);
+    }
+    /**
+     * Uninstalls (removes) an app installation.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    async uninstallApp(installationId, requestId) {
+        return this.appClient.uninstallApp(installationId, requestId);
+    }
+    /**
+     * Retrieves a single UI extension by ID.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    async getUiExtension(uiExtensionId, requestId) {
+        return this.uiExtensionClient.getUiExtension(uiExtensionId, requestId);
+    }
+    /**
+     * Lists UI extensions available (installed) in the web client for the current user.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    async getInstalledUiExtensions(requestId) {
+        return this.uiExtensionClient.getInstalledUiExtensions(requestId);
+    }
+    /**
+     * Lists all UI extensions belonging to a given app (integration).
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    async getUiExtensionsForApp(appId, requestId) {
+        return this.uiExtensionClient.getUiExtensionsForApp(appId, requestId);
+    }
+    /**
+     * Adds a new UI extension to an app.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    async addUiExtension(args, requestId) {
+        return this.uiExtensionClient.addUiExtension(args, requestId);
+    }
+    /**
+     * Updates an existing UI extension.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    async updateUiExtension(uiExtensionId, args, requestId) {
+        return this.uiExtensionClient.updateUiExtension(uiExtensionId, args, requestId);
+    }
+    /**
+     * Deletes a UI extension.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    async deleteUiExtension(uiExtensionId, requestId) {
+        return this.uiExtensionClient.deleteUiExtension(uiExtensionId, requestId);
+    }
+    /**
+     * Uploads an icon for a UI extension.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    async uploadUiExtensionIcon(args, requestId) {
+        return this.uiExtensionClient.uploadUiExtensionIcon(args, requestId);
+    }
+    /**
+     * Lists all apps the user has authorized (granted a token to).
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    async getUserAuthorizations(requestId) {
+        return this.appClient.getUserAuthorizations(requestId);
+    }
+    /**
+     * Revokes a specific user authorization (access token granted to a third-party app).
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    async revokeUserAuthorization(args, requestId) {
+        return this.appClient.revokeUserAuthorization(args, requestId);
+    }
 }

package/dist/esm/transport/http-client.js

@@ -95,6 +95,7 @@ export async function request(args) {
                 break;
             case 'POST':
             case 'PUT':
+            case 'PATCH':
             case 'DELETE': {
                 // Convert payload from camelCase to snake_case
                 // Note: While DELETE with body is uncommon, the Todoist API uses it for some endpoints

package/dist/esm/types/apps/types.js

@@ -0,0 +1,248 @@
+import { z } from 'zod';
+import { StringOrNumberSchema } from '../common.js';
+import { UI_EXTENSION_TYPES } from '../ui-extensions/types.js';
+/**
+ * Available statuses for a developer application.
+ */
+export const APP_STATUSES = ['public'];
+export const AppStatusSchema = z.enum(APP_STATUSES);
+/**
+ * Webhook event types that can be subscribed to.
+ *
+ * These are the friendly public names the backend uses in webhook payloads.
+ * The on-the-wire config endpoint uses a different (legacy) form (see
+ * {@link WEBHOOK_EVENT_WIRE_NAMES}); the SDK converts between the two
+ * so consumers only ever work with these pretty names.
+ *
+ * @see https://developer.todoist.com/sync/v1/#webhooks
+ */
+export const WEBHOOK_EVENTS = [
+    'item:added',
+    'item:updated',
+    'item:completed',
+    'item:uncompleted',
+    'item:deleted',
+    'note:added',
+    'note:updated',
+    'note:deleted',
+    'project:added',
+    'project:updated',
+    'project:deleted',
+    'project:archived',
+    'project:unarchived',
+    'section:added',
+    'section:updated',
+    'section:deleted',
+    'section:archived',
+    'section:unarchived',
+    'label:added',
+    'label:updated',
+    'label:deleted',
+    'filter:added',
+    'filter:updated',
+    'filter:deleted',
+    'reminder:fired',
+];
+export const WebhookEventSchema = z.enum(WEBHOOK_EVENTS);
+/**
+ * Raw wire-format webhook event names used by the config endpoint
+ * (`POST/GET /apps/<id>/webhook`). Exported for completeness — prefer
+ * {@link WEBHOOK_EVENTS} when working with the SDK.
+ */
+export const WEBHOOK_EVENT_WIRE_NAMES = [
+    'e_item_added',
+    'e_item_updated',
+    'e_item_completed',
+    'e_item_uncompleted',
+    'e_item_deleted',
+    'e_note_added',
+    'e_note_updated',
+    'e_note_deleted',
+    'e_project_added',
+    'e_project_updated',
+    'e_project_deleted',
+    'e_project_archived',
+    'e_project_unarchived',
+    'e_section_added',
+    'e_section_updated',
+    'e_section_deleted',
+    'e_section_archived',
+    'e_section_unarchived',
+    'e_label_added',
+    'e_label_updated',
+    'e_label_deleted',
+    'e_filter_added',
+    'e_filter_updated',
+    'e_filter_deleted',
+    'e_reminder_fired',
+];
+export const WebhookEventWireNameSchema = z.enum(WEBHOOK_EVENT_WIRE_NAMES);
+/**
+ * Translates a wire-format event name (`'e_item_added'`) to its pretty form (`'item:added'`).
+ */
+export function webhookEventFromWireName(wireName) {
+    // Strip leading `e_`, replace first `_` with `:`. The resulting string is
+    // guaranteed to be a `WebhookEvent` by construction of the two const arrays.
+    return wireName.slice(2).replace('_', ':');
+}
+/**
+ * Translates a pretty event name (`'item:added'`) to its wire-format form (`'e_item_added'`).
+ */
+export function webhookEventToWireName(event) {
+    return ('e_' + event.replace(':', '_'));
+}
+/**
+ * Available statuses for an app webhook.
+ */
+export const WEBHOOK_STATUSES = ['active', 'invalid'];
+export const WebhookStatusSchema = z.enum(WEBHOOK_STATUSES);
+/**
+ * Supported webhook payload versions. v9 is deprecated and intentionally excluded.
+ */
+export const WEBHOOK_VERSIONS = ['1'];
+export const WebhookVersionSchema = z.enum(WEBHOOK_VERSIONS);
+/**
+ * Available installation types for an app installation.
+ */
+export const INSTALLATION_TYPES = ['user'];
+export const InstallationTypeSchema = z.enum(INSTALLATION_TYPES);
+/**
+ * Transforms a comma-separated scope string into `string[] | null`.
+ *
+ * The backend stores `app_token_scopes` as a single comma-separated string
+ * (e.g. `"data:read,task:add"`). Reads are exposed as `string[]` (rather than
+ * `Permission[]`) so that newly added backend scopes don't break parsing —
+ * writes accept `Permission` for autocomplete while still permitting `string`
+ * (via `UpdateAppArgs`), so a fetched `App.appTokenScopes` can be round-tripped
+ * back into `updateApp()` without casts.
+ *
+ * Preserves `null` on read (backend returns `null` for apps that have had
+ * their scopes cleared via `updateApp({ appTokenScopes: null })`) so the
+ * read and write shapes line up and information is not lost.
+ */
+export const AppTokenScopesSchema = z
+    .string()
+    .nullable()
+    .transform((value) => {
+    if (value === null)
+        return null;
+    if (value === '')
+        return [];
+    return value.split(',').filter(Boolean);
+});
+/**
+ * Schema for a developer application.
+ * @see https://developer.todoist.com/api/v1/#tag/Apps
+ */
+export const AppSchema = z.object({
+    id: StringOrNumberSchema,
+    status: AppStatusSchema,
+    displayName: z.string(),
+    userId: StringOrNumberSchema,
+    createdAt: z.coerce.date(),
+    serviceUrl: z.string().nullable(),
+    oauthRedirectUri: z.string().nullable(),
+    description: z.string().nullable(),
+    iconSm: z.string().nullable(),
+    iconMd: z.string().nullable(),
+    iconLg: z.string().nullable(),
+    appTokenScopes: AppTokenScopesSchema,
+});
+/**
+ * Schema for a developer application that includes the user count.
+ * Returned by most endpoints that manage a single app (get, update, delete).
+ */
+export const AppWithUserCountSchema = AppSchema.extend({
+    userCount: z.number().int(),
+});
+/**
+ * OAuth client credentials for a developer application.
+ */
+export const AppSecretsSchema = z.object({
+    clientId: z.string(),
+    clientSecret: z.string(),
+});
+/**
+ * Webhook verification token for a developer application.
+ */
+export const AppVerificationTokenSchema = z.object({
+    verificationToken: z.string(),
+});
+/**
+ * Developer test access token for a developer application.
+ */
+export const AppTestTokenSchema = z.object({
+    accessToken: z.string().nullish(),
+});
+/**
+ * Distribution token for a developer application.
+ */
+export const AppDistributionTokenSchema = z.object({
+    distributionToken: z.string(),
+});
+/**
+ * Subset of an app returned when resolving by distribution token — used by the installation flow.
+ * Includes a lightweight list of the app's UI extensions (not full `UIExtension` records).
+ */
+export const AppByDistributionTokenUiExtensionSchema = z.object({
+    name: z.string(),
+    description: z.string(),
+    icon: z.string().nullable(),
+    extensionType: z.enum(UI_EXTENSION_TYPES),
+});
+export const AppByDistributionTokenSchema = z.object({
+    id: StringOrNumberSchema,
+    displayName: z.string(),
+    description: z.string().nullable(),
+    iconMd: z.string().nullable(),
+    appTokenScopes: AppTokenScopesSchema,
+    uiExtensions: z.array(AppByDistributionTokenUiExtensionSchema),
+});
+/**
+ * Schema for an app webhook.
+ *
+ * Events arrive from the wire in their `e_*` form and are transformed to
+ * their pretty `item:added`-style names for SDK consumers.
+ */
+export const AppWebhookSchema = z.object({
+    status: WebhookStatusSchema,
+    callbackUrl: z.string(),
+    version: WebhookVersionSchema,
+    events: z.array(WebhookEventWireNameSchema.transform(webhookEventFromWireName)),
+});
+/**
+ * Lightweight view of an app embedded in an installation record.
+ * Mirrors `AppSchema` shape — backend returns the same `ApplicationRestView`.
+ */
+export const InstalledIntegrationSchema = AppSchema;
+/**
+ * Schema for an installed application (integration installed to a user's account).
+ */
+export const AppInstallationSchema = z.object({
+    id: StringOrNumberSchema,
+    creator: StringOrNumberSchema,
+    createdTs: z.number().int(),
+    installationType: InstallationTypeSchema,
+    appTokenScopesValidated: z.boolean(),
+    integration: InstalledIntegrationSchema.nullable(),
+});
+/**
+ * Lightweight app info included on a user authorization record.
+ */
+export const UserAuthorizationAppSchema = z.object({
+    id: StringOrNumberSchema,
+    displayName: z.string(),
+    description: z.string().nullable(),
+    serviceUrl: z.string().nullable(),
+    iconMd: z.string().nullable(),
+});
+/**
+ * Schema for a user authorization entry — a token the user has granted to a third-party app.
+ */
+export const UserAuthorizationSchema = z.object({
+    accessTokenId: StringOrNumberSchema,
+    scope: z.array(z.string()),
+    scopeDescriptions: z.array(z.string()),
+    createdAt: z.coerce.date(),
+    app: UserAuthorizationAppSchema.nullable(),
+});

package/dist/esm/types/index.js

@@ -9,7 +9,6 @@ export * from './productivity/index.js';
 export * from './activity/index.js';
 export * from './workspaces/index.js';
 export * from './folders/index.js';
-export * from './goals/index.js';
 export * from './insights/index.js';
 export * from './backups/index.js';
 export * from './id-mappings/index.js';
@@ -19,3 +18,5 @@ export * from './templates/index.js';
 export * from './errors.js';
 export * from './http.js';
 export * from './sync/index.js';
+export * from './apps/index.js';
+export * from './ui-extensions/index.js';

package/dist/esm/types/sync/commands/index.js

@@ -11,7 +11,6 @@ export * from './workspaces.js';
 export * from './folders.js';
 export * from './workspace-filters.js';
 export * from './workspace-goals.js';
-export * from './goals.js';
 export * from './notifications.js';
 export * from './sharing.js';
 export * from './view-options.js';

package/dist/esm/types/sync/resource-types.js

@@ -29,7 +29,6 @@ export const SYNC_RESOURCE_TYPES = [
     'role_actions',
     'folders',
     'workspace_goals',
-    'goals',
     'day_orders',
     'calendars',
     'calendar_accounts',

package/dist/esm/types/sync/response.js

@@ -1,5 +1,4 @@
 import { z } from 'zod';
-import { GoalSchema } from '../goals/types.js';
 import { LabelSchema } from '../labels/types.js';
 import { ProjectSchema } from '../projects/types.js';
 import { SectionSchema } from '../sections/types.js';
@@ -44,7 +43,6 @@ export const SyncResponseSchema = z.looseObject({
     projectViewOptionsDefaults: z.array(ProjectViewOptionsDefaultsSchema).optional(),
     roleActions: z.array(z.record(z.string(), z.unknown())).optional(),
     folders: z.array(FolderSchema).optional(),
-    goals: z.array(GoalSchema).optional(),
     workspaceGoals: z.array(WorkspaceGoalSchema).optional(),
     dayOrders: z.record(z.string(), z.number()).optional(),
     calendars: z.array(CalendarSchema).optional(),