@doist/todoist-sdk 8.0.1 → 8.1.0

package/dist/cjs/authentication.js

@@ -1,11 +1,23 @@
 "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.PERMISSIONS = void 0;
+exports.TOKEN_ENDPOINT_AUTH_METHODS = exports.PERMISSIONS = void 0;
 exports.getAuthStateParameter = getAuthStateParameter;
 exports.getAuthorizationUrl = getAuthorizationUrl;
 exports.getAuthToken = getAuthToken;
 exports.revokeToken = revokeToken;
 exports.migratePersonalToken = migratePersonalToken;
+exports.registerClient = registerClient;
 const http_client_1 = require("./transport/http-client");
 const uuid_1 = require("uuid");
 const types_1 = require("./types");
@@ -19,6 +31,12 @@ exports.PERMISSIONS = [
     'project:delete',
     'backups:read',
 ];
+/** 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
@@ -48,13 +66,17 @@ function getAuthStateParameter() {
 /**
  * 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(
- *   'your-client-id',
- *   ['data:read', 'task:add'],
- *   state
- * )
+ * const url = getAuthorizationUrl({
+ *   clientId: 'your-client-id',
+ *   permissions: ['data:read', 'task:add'],
+ *   state,
+ * })
  * // Redirect user to url
  * ```
  *
@@ -66,7 +88,7 @@ function getAuthorizationUrl({ clientId, permissions, state, baseUrl, }) {
         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=${clientId}&scope=${scope}&state=${state}`;
+    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.
@@ -202,3 +224,48 @@ async function migratePersonalToken(args, options) {
         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/consts/endpoints.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ENDPOINT_REST_ID_MAPPINGS = exports.ENDPOINT_REST_EMAILS = exports.ENDPOINT_REST_BACKUPS_DOWNLOAD = exports.ENDPOINT_REST_BACKUPS = exports.ENDPOINT_REST_ACCESS_TOKENS_MIGRATE = exports.ENDPOINT_REST_TEMPLATES_IMPORT_FROM_ID = exports.ENDPOINT_REST_TEMPLATES_IMPORT_FROM_FILE = exports.ENDPOINT_REST_TEMPLATES_CREATE_FROM_FILE = exports.ENDPOINT_REST_TEMPLATES_URL = exports.ENDPOINT_REST_TEMPLATES_FILE = exports.ENDPOINT_REST_TASKS_COMPLETED = exports.ENDPOINT_REST_PROJECTS_MOVE_TO_PERSONAL = exports.ENDPOINT_REST_PROJECTS_MOVE_TO_WORKSPACE = exports.SECTION_UNARCHIVE = exports.SECTION_ARCHIVE = exports.ENDPOINT_REST_PROJECT_JOIN = exports.ENDPOINT_REST_PROJECT_FULL = exports.ENDPOINT_REST_PROJECTS_PERMISSIONS = exports.ENDPOINT_REST_PROJECTS_ARCHIVED_COUNT = exports.PROJECT_UNARCHIVE = exports.PROJECT_ARCHIVE = exports.ENDPOINT_REST_UPLOADS = exports.ENDPOINT_REST_ACTIVITIES = exports.ENDPOINT_REST_PRODUCTIVITY = exports.ENDPOINT_REST_USER = exports.ENDPOINT_REST_PROJECT_COLLABORATORS = exports.ENDPOINT_REST_PROJECTS_ARCHIVED = exports.ENDPOINT_REST_PROJECTS_SEARCH = exports.ENDPOINT_REST_PROJECTS = exports.ENDPOINT_REST_TASK_MOVE = exports.ENDPOINT_REST_TASK_REOPEN = exports.ENDPOINT_REST_TASK_CLOSE = exports.ENDPOINT_REST_LOCATION_REMINDERS = exports.ENDPOINT_REST_REMINDERS = exports.ENDPOINT_REST_COMMENTS = exports.ENDPOINT_REST_LABELS_SHARED_REMOVE = exports.ENDPOINT_REST_LABELS_SHARED_RENAME = exports.ENDPOINT_REST_LABELS_SHARED = exports.ENDPOINT_REST_LABELS_SEARCH = exports.ENDPOINT_REST_LABELS = exports.ENDPOINT_REST_SECTIONS_SEARCH = exports.ENDPOINT_REST_SECTIONS = exports.ENDPOINT_REST_TASKS_COMPLETED_SEARCH = exports.ENDPOINT_REST_TASKS_COMPLETED_BY_DUE_DATE = exports.ENDPOINT_REST_TASKS_COMPLETED_BY_COMPLETION_DATE = exports.ENDPOINT_REST_TASKS_FILTER = exports.ENDPOINT_REST_TASKS = exports.API_BASE_URI = exports.API_VERSION = exports.TODOIST_WEB_URI = void 0;
-exports.ENDPOINT_WORKSPACE_MEMBERS = exports.ENDPOINT_WORKSPACE_USERS = exports.ENDPOINT_WORKSPACE_PLAN_DETAILS = exports.ENDPOINT_WORKSPACE_LOGO = exports.ENDPOINT_WORKSPACE_JOIN = exports.ENDPOINT_WORKSPACE_INVITATIONS_DELETE = exports.ENDPOINT_WORKSPACE_INVITATIONS_ALL = exports.ENDPOINT_WORKSPACE_INVITATIONS = exports.ENDPOINT_REST_WORKSPACES = exports.ENDPOINT_REST_FOLDERS = exports.ENDPOINT_REVOKE = exports.ENDPOINT_GET_TOKEN = exports.ENDPOINT_AUTHORIZATION = exports.ENDPOINT_SYNC = exports.ENDPOINT_SYNC_QUICK_ADD = exports.ENDPOINT_REST_MOVED_IDS = void 0;
+exports.ENDPOINT_WORKSPACE_MEMBERS = exports.ENDPOINT_WORKSPACE_USERS = exports.ENDPOINT_WORKSPACE_PLAN_DETAILS = exports.ENDPOINT_WORKSPACE_LOGO = exports.ENDPOINT_WORKSPACE_JOIN = exports.ENDPOINT_WORKSPACE_INVITATIONS_DELETE = exports.ENDPOINT_WORKSPACE_INVITATIONS_ALL = exports.ENDPOINT_WORKSPACE_INVITATIONS = exports.ENDPOINT_REST_WORKSPACES = exports.ENDPOINT_REST_FOLDERS = exports.ENDPOINT_REGISTER = exports.ENDPOINT_REVOKE = exports.ENDPOINT_GET_TOKEN = exports.ENDPOINT_AUTHORIZATION = exports.ENDPOINT_SYNC = exports.ENDPOINT_SYNC_QUICK_ADD = exports.ENDPOINT_REST_MOVED_IDS = void 0;
 exports.getSyncBaseUri = getSyncBaseUri;
 exports.getAuthBaseUri = getAuthBaseUri;
 exports.getWorkspaceInvitationAcceptEndpoint = getWorkspaceInvitationAcceptEndpoint;
@@ -84,6 +84,7 @@ exports.ENDPOINT_SYNC = 'sync';
 exports.ENDPOINT_AUTHORIZATION = 'authorize';
 exports.ENDPOINT_GET_TOKEN = 'access_token';
 exports.ENDPOINT_REVOKE = 'revoke';
+exports.ENDPOINT_REGISTER = 'register';
 exports.ENDPOINT_REST_FOLDERS = 'folders';
 // Workspace endpoints
 exports.ENDPOINT_REST_WORKSPACES = 'workspaces';

package/dist/esm/authentication.js

@@ -1,7 +1,18 @@
+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;
+};
 import { request, isSuccess } from './transport/http-client.js';
 import { v4 as uuid } from 'uuid';
 import { TodoistRequestError } from './types/index.js';
-import { getAuthBaseUri, getSyncBaseUri, ENDPOINT_AUTHORIZATION, ENDPOINT_GET_TOKEN, ENDPOINT_REVOKE, ENDPOINT_REST_ACCESS_TOKENS_MIGRATE, } from './consts/endpoints.js';
+import { getAuthBaseUri, getSyncBaseUri, ENDPOINT_AUTHORIZATION, ENDPOINT_GET_TOKEN, ENDPOINT_REVOKE, ENDPOINT_REGISTER, ENDPOINT_REST_ACCESS_TOKENS_MIGRATE, } from './consts/endpoints.js';
 /** Available OAuth2 permission scopes. */
 export const PERMISSIONS = [
     'task:add',
@@ -11,6 +22,12 @@ export const PERMISSIONS = [
     'project:delete',
     'backups:read',
 ];
+/** Supported token endpoint authentication methods for dynamic client registration. */
+export const 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
@@ -40,13 +57,17 @@ export function getAuthStateParameter() {
 /**
  * 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(
- *   'your-client-id',
- *   ['data:read', 'task:add'],
- *   state
- * )
+ * const url = getAuthorizationUrl({
+ *   clientId: 'your-client-id',
+ *   permissions: ['data:read', 'task:add'],
+ *   state,
+ * })
  * // Redirect user to url
  * ```
  *
@@ -58,7 +79,7 @@ export function getAuthorizationUrl({ clientId, permissions, state, baseUrl, })
         throw new Error('At least one scope value should be passed for permissions.');
     }
     const scope = permissions.join(',');
-    return `${getAuthBaseUri(baseUrl)}${ENDPOINT_AUTHORIZATION}?client_id=${clientId}&scope=${scope}&state=${state}`;
+    return `${getAuthBaseUri(baseUrl)}${ENDPOINT_AUTHORIZATION}?client_id=${encodeURIComponent(clientId)}&scope=${scope}&state=${state}`;
 }
 /**
  * Exchanges an authorization code for an access token.
@@ -194,3 +215,48 @@ export async function migratePersonalToken(args, options) {
         throw new 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}
+ */
+export 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 request({
+            httpMethod: 'POST',
+            baseUri: getAuthBaseUri(baseUrl),
+            relativePath: ENDPOINT_REGISTER,
+            apiToken: undefined,
+            payload: Object.assign(Object.assign({}, args), { scope: (_a = args.scope) === null || _a === void 0 ? void 0 : _a.join(' ') }),
+            customFetch,
+        });
+        if (!isSuccess(response) || !((_b = response.data) === null || _b === void 0 ? void 0 : _b.clientId)) {
+            throw new 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 TodoistRequestError('Dynamic client registration failed.', err.httpStatusCode, err.responseData);
+    }
+}

package/dist/esm/consts/endpoints.js

@@ -65,6 +65,7 @@ export const ENDPOINT_SYNC = 'sync';
 export const ENDPOINT_AUTHORIZATION = 'authorize';
 export const ENDPOINT_GET_TOKEN = 'access_token';
 export const ENDPOINT_REVOKE = 'revoke';
+export const ENDPOINT_REGISTER = 'register';
 export const ENDPOINT_REST_FOLDERS = 'folders';
 // Workspace endpoints
 export const ENDPOINT_REST_WORKSPACES = 'workspaces';

package/dist/types/authentication.d.ts

@@ -13,6 +13,51 @@ export declare const PERMISSIONS: readonly ["task:add", "data:read", "data:read_
  * @see {@link https://developer.todoist.com/api/v1/#tag/Authorization}
  */
 export type Permission = (typeof PERMISSIONS)[number];
+/** Supported token endpoint authentication methods for dynamic client registration. */
+export declare const TOKEN_ENDPOINT_AUTH_METHODS: readonly ["client_secret_post", "client_secret_basic", "none"];
+/**
+ * Authentication method used at the token endpoint.
+ * @see {@link https://datatracker.ietf.org/doc/html/rfc7591#section-2 RFC 7591 Section 2}
+ */
+export type TokenEndpointAuthMethod = (typeof TOKEN_ENDPOINT_AUTH_METHODS)[number];
+/**
+ * Parameters for registering a new OAuth client via Dynamic Client Registration.
+ * @see {@link https://datatracker.ietf.org/doc/html/rfc7591 RFC 7591}
+ */
+export type ClientRegistrationRequest = {
+    redirectUris: string[];
+    clientName?: string;
+    clientUri?: string;
+    logoUri?: string;
+    scope?: readonly Permission[];
+    grantTypes?: string[];
+    responseTypes?: string[];
+    tokenEndpointAuthMethod?: TokenEndpointAuthMethod;
+};
+type RawClientRegistrationResponse = {
+    clientId: string;
+    clientSecret?: string;
+    clientName: string;
+    redirectUris: string[];
+    scope?: string;
+    grantTypes: string[];
+    responseTypes: string[];
+    tokenEndpointAuthMethod: string;
+    clientIdIssuedAt?: number;
+    clientSecretExpiresAt?: number;
+    clientUri?: string;
+    logoUri?: string;
+};
+/**
+ * Response from a successful dynamic client registration.
+ * @see {@link https://datatracker.ietf.org/doc/html/rfc7591#section-3.2.1 RFC 7591 Section 3.2.1}
+ */
+export type ClientRegistrationResponse = Omit<RawClientRegistrationResponse, 'clientIdIssuedAt' | 'clientSecretExpiresAt' | 'scope'> & {
+    scope?: Permission[];
+    clientIdIssuedAt?: Date;
+    /** `null` indicates the client secret never expires. Absent when no secret is issued. */
+    clientSecretExpiresAt?: Date | null;
+};
 /**
  * Parameters required to exchange an authorization code for an access token.
  * @see https://developer.todoist.com/api/v1/#tag/Authorization/OAuth
@@ -80,13 +125,17 @@ export declare function getAuthStateParameter(): string;
 /**
  * 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(
- *   'your-client-id',
- *   ['data:read', 'task:add'],
- *   state
- * )
+ * const url = getAuthorizationUrl({
+ *   clientId: 'your-client-id',
+ *   permissions: ['data:read', 'task:add'],
+ *   state,
+ * })
  * // Redirect user to url
  * ```
  *
@@ -156,3 +205,22 @@ export declare function revokeToken(args: RevokeTokenRequestArgs, options?: Auth
  * @throws {@link TodoistRequestError} If the migration fails
  */
 export declare function migratePersonalToken(args: MigratePersonalTokenArgs, options?: AuthOptions): Promise<MigratePersonalTokenResponse>;
+/**
+ * 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}
+ */
+export declare function registerClient(args: ClientRegistrationRequest, options?: AuthOptions): Promise<ClientRegistrationResponse>;
+export {};

package/dist/types/consts/endpoints.d.ts

@@ -56,6 +56,7 @@ export declare const ENDPOINT_SYNC = "sync";
 export declare const ENDPOINT_AUTHORIZATION = "authorize";
 export declare const ENDPOINT_GET_TOKEN = "access_token";
 export declare const ENDPOINT_REVOKE = "revoke";
+export declare const ENDPOINT_REGISTER = "register";
 export declare const ENDPOINT_REST_FOLDERS = "folders";
 export declare const ENDPOINT_REST_WORKSPACES = "workspaces";
 export declare const ENDPOINT_WORKSPACE_INVITATIONS = "workspaces/invitations";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@doist/todoist-sdk",
-    "version": "8.0.1",
+    "version": "8.1.0",
     "description": "The official TypeScript SDK for the Todoist REST API.",
     "author": "Doist developers",
     "repository": "https://github.com/Doist/todoist-sdk-typescript",