@doist/todoist-sdk 14.1.0 → 15.0.0

package/dist/types/utils/url-helpers.d.ts

@@ -30,3 +30,91 @@ export declare function getProjectUrl(projectId: string, name?: string): string;
  * @returns The URL string for the section view.
  */
 export declare function getSectionUrl(sectionId: string, name?: string): string;
+/**
+ * Generate the URL for a given label.
+ *
+ * @param labelId The ID of the label.
+ * @param name The name of the label.
+ * @returns The URL string for the label view.
+ */
+export declare function getLabelUrl(labelId: string, name?: string): string;
+/**
+ * Generate the URL for a given filter.
+ *
+ * @param filterId The ID of the filter.
+ * @param name The name of the filter.
+ * @returns The URL string for the filter view.
+ */
+export declare function getFilterUrl(filterId: string, name?: string): string;
+/**
+ * Generate the URL for a filter belonging to a workspace.
+ *
+ * @param workspaceId The ID of the workspace the filter belongs to.
+ * @param filterId The ID of the filter.
+ * @param name The name of the filter.
+ * @returns The URL string for the workspace filter view.
+ */
+export declare function getWorkspaceFilterUrl(workspaceId: string, filterId: string, name?: string): string;
+/**
+ * Generate the URL for a given workspace.
+ *
+ * @param workspaceId The ID of the workspace.
+ * @returns The URL string for the workspace view.
+ */
+export declare function getWorkspaceUrl(workspaceId: string): string;
+/**
+ * Generate the URL for the comments on a given task.
+ *
+ * @param taskId The ID of the task.
+ * @param content The content of the task.
+ * @returns The URL string for the task's comments.
+ */
+export declare function getTaskCommentsUrl(taskId: string, content?: string): string;
+/**
+ * Generate the URL for the comments on a given project.
+ *
+ * @param projectId The ID of the project.
+ * @param name The name of the project.
+ * @returns The URL string for the project's comments.
+ */
+export declare function getProjectCommentsUrl(projectId: string, name?: string): string;
+/**
+ * Generate the URL for a single comment on a given task.
+ *
+ * @param taskId The ID of the task.
+ * @param commentId The ID of the comment.
+ * @param content The content of the task.
+ * @returns The URL string for the comment.
+ */
+export declare function getTaskCommentUrl(taskId: string, commentId: string, content?: string): string;
+/**
+ * Generate the URL for a single comment on a given project.
+ *
+ * @param projectId The ID of the project.
+ * @param commentId The ID of the comment.
+ * @param name The name of the project.
+ * @returns The URL string for the comment.
+ */
+export declare function getProjectCommentUrl(projectId: string, commentId: string, name?: string): string;
+/** The kinds of Todoist entity a URL can point at. */
+export declare const TODOIST_LINK_TYPES: readonly ["task", "project", "filter", "label", "section", "workspace", "template", "comment", "label_by_name"];
+/** The kind of Todoist entity a URL points at. */
+export type TodoistLinkType = (typeof TODOIST_LINK_TYPES)[number];
+/** The entity a Todoist URL points at. */
+export type TodoistUrlInfo = {
+    /** The kind of entity the URL points at. */
+    type: TodoistLinkType;
+    /** The ID of the entity. */
+    id: string;
+    /** The ID of the workspace the entity belongs to, when the URL names one. */
+    workspaceId: string | null;
+    /** The ID of the comment the URL points at, when the URL names one. */
+    commentId: string | null;
+};
+/**
+ * Parse a Todoist URL into the entity it points at.
+ *
+ * @param url The URL to parse.
+ * @returns The entity the URL points at, or `null` if it is not a Todoist URL.
+ */
+export declare function parseTodoistUrl(url: string): TodoistUrlInfo | null;

package/package.json

@@ -1,20 +1,17 @@
 {
     "name": "@doist/todoist-sdk",
-    "version": "14.1.0",
+    "version": "15.0.0",
     "description": "The official TypeScript SDK for the Todoist REST API.",
     "author": "Doist developers",
     "repository": "https://github.com/Doist/todoist-sdk-typescript",
     "homepage": "https://doist.github.io/todoist-sdk-typescript/",
     "license": "MIT",
     "type": "module",
-    "main": "dist/cjs/index.js",
-    "module": "dist/esm/index.js",
     "types": "dist/types/index.d.ts",
     "exports": {
         ".": {
             "types": "./dist/types/index.d.ts",
-            "import": "./dist/esm/index.js",
-            "require": "./dist/cjs/index.js"
+            "default": "./dist/esm/index.js"
         }
     },
     "publishConfig": {
@@ -36,13 +33,11 @@
         "test:watch": "vitest",
         "test:coverage": "vitest run --coverage",
         "api:request": "node ./scripts/todoist-api-request.cjs",
-        "build:cjs": "npx tsc -p tsconfig.cjs.json",
         "build:esm": "npx tsc -p tsconfig.esm.json",
         "build:fix-esm": "node scripts/fix-esm-imports.cjs",
         "build:fix-dts": "node scripts/fix-dts-imports.cjs",
-        "build:post": "echo '{\"type\":\"commonjs\"}' > dist/cjs/package.json",
-        "build": "npm-run-all clean build:cjs build:esm build:fix-esm build:fix-dts build:post",
-        "attw": "attw --pack --ignore-rules fallback-condition false-esm",
+        "build": "npm-run-all clean build:esm build:fix-esm build:fix-dts",
+        "attw": "attw --pack --ignore-rules cjs-resolves-to-esm",
         "integrity-checks": "npm-run-all clean check test build attw",
         "prepublishOnly": "npm run integrity-checks",
         "prepare": "npm run build"
@@ -51,11 +46,11 @@
         "fflate": "0.8.2"
     },
     "dependencies": {
+        "@doist/sdk-kmp": "0.2.3",
         "camelcase": "6.3.0",
         "emoji-regex": "10.6.0",
-        "form-data": "4.0.6",
         "ts-custom-error": "^3.2.0",
-        "undici": "7.24.8",
+        "undici": "^7.29.0",
         "uuid": "11.1.1",
         "zod": "4.3.6"
     },
@@ -92,7 +87,6 @@
         "*.{ts,tsx,json,md,yml,yaml}": "oxfmt --no-error-on-unmatched-pattern"
     },
     "files": [
-        "dist/cjs/**/*",
         "dist/esm/**/*",
         "dist/types/**/*",
         "!dist/**/*.test.js",

package/dist/cjs/authentication.js

@@ -1,317 +0,0 @@
-"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.TOKEN_ENDPOINT_AUTH_METHODS = exports.PERMISSIONS = void 0;
-exports.getAuthStateParameter = getAuthStateParameter;
-exports.getAuthorizationUrl = getAuthorizationUrl;
-exports.getAuthToken = getAuthToken;
-exports.refreshAuthToken = refreshAuthToken;
-exports.revokeToken = revokeToken;
-exports.migratePersonalToken = migratePersonalToken;
-exports.registerClient = registerClient;
-const uuid_1 = require("uuid");
-const endpoints_1 = require("./consts/endpoints");
-const http_client_1 = require("./transport/http-client");
-const types_1 = require("./types");
-/** Available OAuth2 permission scopes. */
-exports.PERMISSIONS = [
-    'task:add',
-    'data:read',
-    'data:read_write',
-    'data:delete',
-    'project:delete',
-    'backups:read',
-    'billing:read',
-    'billing:read_write',
-    'dev:app_console',
-];
-/** Supported token endpoint authentication methods for dynamic client registration. */
-exports.TOKEN_ENDPOINT_AUTH_METHODS = [
-    'client_secret_post',
-    'client_secret_basic',
-    'none',
-];
-/**
- * Creates a Basic Authentication header value from client credentials.
- * @param clientId - The OAuth client ID
- * @param clientSecret - The OAuth client secret
- * @returns The Basic Auth header value (without the 'Basic ' prefix)
- */
-function createBasicAuthHeader(clientId, clientSecret) {
-    const credentials = `${clientId}:${clientSecret}`;
-    return Buffer.from(credentials).toString('base64');
-}
-/**
- * Generates a random state parameter for OAuth2 authorization.
- * The state parameter helps prevent CSRF attacks.
- *
- * @example
- * ```typescript
- * const state = getAuthStateParameter()
- * // Store state in session
- * const authUrl = getAuthorizationUrl(clientId, ['data:read'], state)
- * ```
- *
- * @returns A random UUID v4 string
- */
-function getAuthStateParameter() {
-    return (0, uuid_1.v4)();
-}
-/**
- * Generates the authorization URL for the OAuth2 flow.
- *
- * The `clientId` can be either a traditional client ID string (e.g. from
- * {@link registerClient}) or an HTTPS URL pointing to a client metadata document,
- * as defined in {@link https://drafts.ietf.org/doc/draft-ietf-oauth-client-id-metadata-document/ RFC draft-ietf-oauth-client-id-metadata-document}.
- *
- * @example
- * ```typescript
- * const url = getAuthorizationUrl({
- *   clientId: 'your-client-id',
- *   permissions: ['data:read', 'task:add'],
- *   state,
- * })
- * // Redirect user to url
- * ```
- *
- * @returns The full authorization URL to redirect users to
- * @see https://developer.todoist.com/api/v1/#tag/Authorization/OAuth
- */
-function getAuthorizationUrl({ clientId, permissions, state, baseUrl, }) {
-    if (!(permissions === null || permissions === void 0 ? void 0 : permissions.length)) {
-        throw new Error('At least one scope value should be passed for permissions.');
-    }
-    const scope = permissions.join(',');
-    return `${(0, endpoints_1.getAuthBaseUri)(baseUrl)}${endpoints_1.ENDPOINT_AUTHORIZATION}?client_id=${encodeURIComponent(clientId)}&scope=${scope}&state=${state}`;
-}
-/**
- * Exchanges an authorization code for an access token.
- *
- * @example
- * ```typescript
- * const { accessToken } = await getAuthToken({
- *   clientId: 'your-client-id',
- *   clientSecret: 'your-client-secret',
- *   code: authCode
- * })
- * ```
- *
- * @returns The access token response
- * @throws {@link TodoistRequestError} If the token exchange fails
- */
-/**
- * Posts a payload to the OAuth token endpoint and returns the token response,
- * mapping any failure to a {@link TodoistRequestError} with `errorMessage`.
- * Shared by {@link getAuthToken} and {@link refreshAuthToken}.
- */
-async function requestAuthToken(payload, errorMessage, options) {
-    var _a;
-    try {
-        const response = await (0, http_client_1.request)({
-            httpMethod: 'POST',
-            baseUri: (0, endpoints_1.getAuthBaseUri)(options === null || options === void 0 ? void 0 : options.baseUrl),
-            relativePath: endpoints_1.ENDPOINT_GET_TOKEN,
-            apiToken: undefined,
-            payload,
-            customFetch: options === null || options === void 0 ? void 0 : options.customFetch,
-        });
-        if (response.status !== 200 || !((_a = response.data) === null || _a === void 0 ? void 0 : _a.accessToken)) {
-            throw new types_1.TodoistRequestError(errorMessage, response.status, response.data);
-        }
-        return response.data;
-    }
-    catch (error) {
-        // Re-throw with custom message for authentication failures
-        const err = error;
-        throw new types_1.TodoistRequestError(errorMessage, err.httpStatusCode, err.responseData);
-    }
-}
-async function getAuthToken(args, options) {
-    if (typeof options === 'string') {
-        throw new TypeError('Passing baseUrl as a string is no longer supported. Use an options object instead: getAuthToken(args, { baseUrl })');
-    }
-    return requestAuthToken(Object.assign({}, args), 'Authentication token exchange failed.', options);
-}
-/**
- * Exchanges a refresh token for a new access token using the OAuth2
- * `refresh_token` grant.
- *
- * Only relevant for OAuth apps that have refresh tokens enabled (the default for
- * new apps). Apps without them never receive a `refreshToken` from
- * {@link getAuthToken}, so they have nothing to pass here — their access tokens
- * are long-lived instead.
- *
- * Omit `clientSecret` for public clients registered with
- * `tokenEndpointAuthMethod: 'none'`.
- *
- * @example
- * ```typescript
- * const { accessToken, refreshToken } = await refreshAuthToken({
- *   clientId: 'your-client-id',
- *   clientSecret: 'your-client-secret',
- *   refreshToken: storedRefreshToken,
- * })
- * ```
- *
- * @returns The refreshed token. The server rotates the refresh token, so the
- * response carries a new `refreshToken` — persist it in place of the old one.
- * @throws {@link TodoistRequestError} If the refresh fails
- */
-async function refreshAuthToken(args, options) {
-    const payload = {
-        clientId: args.clientId,
-        refreshToken: args.refreshToken,
-        grantType: 'refresh_token',
-    };
-    if (args.clientSecret !== undefined) {
-        payload.clientSecret = args.clientSecret;
-    }
-    return requestAuthToken(payload, 'Authentication token refresh failed.', options);
-}
-/**
- * Revokes a token using the RFC 7009 OAuth 2.0 Token Revocation standard.
- *
- * This function uses HTTP Basic Authentication with client credentials and follows
- * the RFC 7009 specification for token revocation.
- *
- * @example
- * ```typescript
- * await revokeToken({
- *   clientId: 'your-client-id',
- *   clientSecret: 'your-client-secret',
- *   token: 'access-token-to-revoke'
- * })
- * ```
- *
- * @returns True if revocation was successful
- * @see https://datatracker.ietf.org/doc/html/rfc7009
- * @see https://developer.todoist.com/api/v1/#tag/Authorization
- */
-async function revokeToken(args, options) {
-    if (typeof options === 'string') {
-        throw new TypeError('Passing baseUrl as a string is no longer supported. Use an options object instead: revokeToken(args, { baseUrl })');
-    }
-    const baseUrl = options === null || options === void 0 ? void 0 : options.baseUrl;
-    const customFetch = options === null || options === void 0 ? void 0 : options.customFetch;
-    const { clientId, clientSecret, token } = args;
-    // Create Basic Auth header as per RFC 7009
-    const basicAuth = createBasicAuthHeader(clientId, clientSecret);
-    const customHeaders = {
-        Authorization: `Basic ${basicAuth}`,
-    };
-    // Request body only contains the token and optional token_type_hint
-    const requestBody = {
-        token,
-        token_type_hint: 'access_token',
-    };
-    const response = await (0, http_client_1.request)({
-        httpMethod: 'POST',
-        baseUri: (0, endpoints_1.getSyncBaseUri)(baseUrl),
-        relativePath: endpoints_1.ENDPOINT_REVOKE,
-        apiToken: undefined,
-        payload: requestBody,
-        requestId: undefined,
-        hasSyncCommands: false,
-        customHeaders: customHeaders,
-        customFetch,
-    });
-    return (0, http_client_1.isSuccess)(response);
-}
-/**
- * Migrates a personal API token to an OAuth access token.
- *
- * This allows applications to transition users from personal API tokens
- * to proper OAuth tokens without requiring the user to go through the
- * full OAuth authorization flow.
- *
- * @example
- * ```typescript
- * const { accessToken } = await migratePersonalToken({
- *   clientId: 'your-client-id',
- *   clientSecret: 'your-client-secret',
- *   personalToken: 'user-personal-token',
- *   scope: 'data:read_write,data:delete'
- * })
- * ```
- *
- * @returns The new OAuth token response
- * @throws {@link TodoistRequestError} If the migration fails
- */
-async function migratePersonalToken(args, options) {
-    var _a;
-    const baseUrl = options === null || options === void 0 ? void 0 : options.baseUrl;
-    const customFetch = options === null || options === void 0 ? void 0 : options.customFetch;
-    try {
-        const response = await (0, http_client_1.request)({
-            httpMethod: 'POST',
-            baseUri: (0, endpoints_1.getSyncBaseUri)(baseUrl),
-            relativePath: endpoints_1.ENDPOINT_REST_ACCESS_TOKENS_MIGRATE,
-            apiToken: undefined,
-            payload: Object.assign(Object.assign({}, args), { scope: args.scope.join(',') }),
-            customFetch,
-        });
-        if (response.status !== 200 || !((_a = response.data) === null || _a === void 0 ? void 0 : _a.accessToken)) {
-            throw new types_1.TodoistRequestError('Personal token migration failed.', response.status, response.data);
-        }
-        return response.data;
-    }
-    catch (error) {
-        const err = error;
-        throw new types_1.TodoistRequestError('Personal token migration failed.', err.httpStatusCode, err.responseData);
-    }
-}
-/**
- * Registers a new OAuth client via Dynamic Client Registration (RFC 7591).
- *
- * @example
- * ```typescript
- * const client = await registerClient({
- *   redirectUris: ['https://example.com/callback'],
- *   clientName: 'My App',
- *   scope: ['data:read_write', 'task:add'],
- * })
- * // Use client.clientId and client.clientSecret for OAuth flows
- * ```
- *
- * @returns The registered client details
- * @throws {@link TodoistRequestError} If the registration fails
- * @see {@link https://datatracker.ietf.org/doc/html/rfc7591 RFC 7591}
- */
-async function registerClient(args, options) {
-    var _a, _b;
-    const baseUrl = options === null || options === void 0 ? void 0 : options.baseUrl;
-    const customFetch = options === null || options === void 0 ? void 0 : options.customFetch;
-    try {
-        const response = await (0, http_client_1.request)({
-            httpMethod: 'POST',
-            baseUri: (0, endpoints_1.getAuthBaseUri)(baseUrl),
-            relativePath: endpoints_1.ENDPOINT_REGISTER,
-            apiToken: undefined,
-            payload: Object.assign(Object.assign({}, args), { scope: (_a = args.scope) === null || _a === void 0 ? void 0 : _a.join(' ') }),
-            customFetch,
-        });
-        if (!(0, http_client_1.isSuccess)(response) || !((_b = response.data) === null || _b === void 0 ? void 0 : _b.clientId)) {
-            throw new types_1.TodoistRequestError('Dynamic client registration failed.', response.status, response.data);
-        }
-        const _c = response.data, { clientIdIssuedAt, clientSecretExpiresAt, scope } = _c, rest = __rest(_c, ["clientIdIssuedAt", "clientSecretExpiresAt", "scope"]);
-        return Object.assign(Object.assign({}, rest), { scope: scope ? scope.split(' ') : undefined, clientIdIssuedAt: clientIdIssuedAt !== undefined ? new Date(clientIdIssuedAt * 1000) : undefined, clientSecretExpiresAt: clientSecretExpiresAt === undefined
-                ? undefined
-                : clientSecretExpiresAt === 0
-                    ? null
-                    : new Date(clientSecretExpiresAt * 1000) });
-    }
-    catch (error) {
-        const err = error;
-        throw new types_1.TodoistRequestError('Dynamic client registration failed.', err.httpStatusCode, err.responseData);
-    }
-}

package/dist/cjs/clients/activity-client.js

@@ -1,63 +0,0 @@
-"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.ActivityClient = void 0;
-const endpoints_1 = require("../consts/endpoints");
-const http_client_1 = require("../transport/http-client");
-const activity_helpers_1 = require("../utils/activity-helpers");
-const url_helpers_1 = require("../utils/url-helpers");
-const validators_1 = require("../utils/validators");
-const base_client_1 = require("./base-client");
-/**
- * Internal sub-client handling the activity-log endpoint.
- *
- * Instantiated by `TodoistApi`; the public `getActivityLogs` method on
- * `TodoistApi` delegates here. See `todoist-api.ts` for user-facing
- * JSDoc.
- */
-class ActivityClient extends base_client_1.BaseClient {
-    async getActivityLogs(args = {}) {
-        // Convert Date objects to YYYY-MM-DD strings
-        const dateFrom = args.dateFrom instanceof Date ? (0, url_helpers_1.formatDateToYYYYMMDD)(args.dateFrom) : args.dateFrom;
-        const dateTo = args.dateTo instanceof Date ? (0, url_helpers_1.formatDateToYYYYMMDD)(args.dateTo) : args.dateTo;
-        // Destructure out raw date, filter-type, and removed legacy fields so they don't leak into payload
-        const _a = args, { dateFrom: _dateFrom, dateTo: _dateTo, objectEventTypes, objectType: _objectType, eventType: _eventType, since: _since, until: _until } = _a, rest = __rest(_a, ["dateFrom", "dateTo", "objectEventTypes", "objectType", "eventType", "since", "until"]);
-        // Build normalized objectEventTypes for the API
-        let normalizedObjectEventTypes;
-        if (objectEventTypes !== undefined) {
-            const arr = Array.isArray(objectEventTypes) ? objectEventTypes : [objectEventTypes];
-            normalizedObjectEventTypes = arr.map(activity_helpers_1.normalizeObjectEventTypeForApi);
-        }
-        const processedArgs = Object.assign(Object.assign(Object.assign(Object.assign({}, rest), (dateFrom !== undefined ? { dateFrom } : {})), (dateTo !== undefined ? { dateTo } : {})), (normalizedObjectEventTypes !== undefined
-            ? { objectEventTypes: normalizedObjectEventTypes }
-            : {}));
-        const { data: { results, nextCursor }, } = await (0, http_client_1.request)({
-            httpMethod: 'GET',
-            baseUri: this.syncApiBase,
-            relativePath: endpoints_1.ENDPOINT_REST_ACTIVITIES,
-            apiToken: this.authToken,
-            customFetch: this.customFetch,
-            payload: processedArgs,
-        });
-        // Convert legacy API object types back to modern SDK types
-        const normalizedResults = results.map((event) => {
-            const normalizedType = (0, activity_helpers_1.denormalizeObjectTypeFromApi)(event.objectType);
-            return Object.assign(Object.assign({}, event), { objectType: normalizedType || event.objectType });
-        });
-        return {
-            results: (0, validators_1.validateActivityEventArray)(normalizedResults),
-            nextCursor,
-        };
-    }
-}
-exports.ActivityClient = ActivityClient;