@doist/todoist-sdk 14.2.0 → 15.0.0

package/dist/esm/utils/index.js

@@ -1,6 +1,6 @@
 export * from './colors.js';
 export * from './sanitization.js';
-export { getTaskUrl, getProjectUrl, getSectionUrl } from './url-helpers.js';
+export { getTaskUrl, getProjectUrl, getSectionUrl, getLabelUrl, getFilterUrl, getWorkspaceFilterUrl, getWorkspaceUrl, getTaskCommentsUrl, getProjectCommentsUrl, getTaskCommentUrl, getProjectCommentUrl, parseTodoistUrl, TODOIST_LINK_TYPES, } from './url-helpers.js';
 export { createCommand } from './sync-helpers.js';
 export * from './project-helpers.js';
 export * from './task-sorting.js';

package/dist/esm/utils/url-helpers.js

@@ -1,3 +1,5 @@
+import { LinkEnvironment } from '@doist/sdk-kmp/common';
+import { parseTodoistLink, todoistFilterUrl, todoistLabelUrl, todoistProjectCommentsUrl, todoistProjectCommentUrl, todoistProjectUrl, todoistSectionUrl, todoistTaskCommentsUrl, todoistTaskCommentUrl, todoistTaskUrl, todoistWorkspaceFilterUrl, todoistWorkspaceUrl, } from '@doist/sdk-kmp/todoist';
 import { TODOIST_WEB_URI } from '../consts/endpoints.js';
 /**
  * Formats a Date object to YYYY-MM-DD string format.
@@ -12,6 +14,23 @@ export function formatDateToYYYYMMDD(date) {
     const day = String(date.getDate()).padStart(2, '0');
     return `${year}-${month}-${day}`;
 }
+/**
+ * Builds a URL, falling back to a bare-id URL when the link builder rejects the
+ * given id. These helpers are called while parsing API responses, so generating
+ * a URL must never fail the parse.
+ *
+ * @param build Builds the URL.
+ * @param fallbackPath The path to fall back to, relative to the Todoist web app.
+ * @returns The built URL, or a bare-id URL if the id was rejected.
+ */
+function buildUrl(build, fallbackPath) {
+    try {
+        return build();
+    }
+    catch (_a) {
+        return `${TODOIST_WEB_URI}/${fallbackPath}`;
+    }
+}
 /**
  * Generate the URL for a given task.
  *
@@ -20,9 +39,7 @@ export function formatDateToYYYYMMDD(date) {
  * @returns The URL string for the task view.
  */
 export function getTaskUrl(taskId, content) {
-    const slug = content ? slugify(content) : undefined;
-    const path = slug ? `${slug}-${taskId}` : taskId;
-    return `${TODOIST_WEB_URI}/task/${path}`;
+    return buildUrl(() => todoistTaskUrl(taskId, content !== null && content !== void 0 ? content : '', LinkEnvironment.Production), `task/${taskId}`);
 }
 /**
  * Generate the URL for a given project.
@@ -32,9 +49,7 @@ export function getTaskUrl(taskId, content) {
  * @returns The URL string for the project view.
  */
 export function getProjectUrl(projectId, name) {
-    const slug = name ? slugify(name) : undefined;
-    const path = slug ? `${slug}-${projectId}` : projectId;
-    return `${TODOIST_WEB_URI}/project/${path}`;
+    return buildUrl(() => todoistProjectUrl(projectId, name !== null && name !== void 0 ? name : '', LinkEnvironment.Production), `project/${projectId}`);
 }
 /**
  * Generate the URL for a given section.
@@ -44,25 +59,138 @@ export function getProjectUrl(projectId, name) {
  * @returns The URL string for the section view.
  */
 export function getSectionUrl(sectionId, name) {
-    const slug = name ? slugify(name) : undefined;
-    const path = slug ? `${slug}-${sectionId}` : sectionId;
-    return `${TODOIST_WEB_URI}/section/${path}`;
+    return buildUrl(() => todoistSectionUrl(sectionId, name !== null && name !== void 0 ? name : '', LinkEnvironment.Production), `section/${sectionId}`);
+}
+/**
+ * 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 function getLabelUrl(labelId, name) {
+    return buildUrl(() => todoistLabelUrl(labelId, name !== null && name !== void 0 ? name : '', LinkEnvironment.Production), `label/${labelId}`);
+}
+/**
+ * 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 function getFilterUrl(filterId, name) {
+    return buildUrl(() => todoistFilterUrl(filterId, name !== null && name !== void 0 ? name : '', LinkEnvironment.Production), `filter/${filterId}`);
+}
+/**
+ * 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 function getWorkspaceFilterUrl(workspaceId, filterId, name) {
+    return buildUrl(() => todoistWorkspaceFilterUrl(workspaceId, filterId, name !== null && name !== void 0 ? name : '', LinkEnvironment.Production), `${workspaceId}/filter/${filterId}`);
+}
+/**
+ * Generate the URL for a given workspace.
+ *
+ * @param workspaceId The ID of the workspace.
+ * @returns The URL string for the workspace view.
+ */
+export function getWorkspaceUrl(workspaceId) {
+    return buildUrl(() => todoistWorkspaceUrl(workspaceId, LinkEnvironment.Production), workspaceId);
+}
+/**
+ * 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 function getTaskCommentsUrl(taskId, content) {
+    return buildUrl(() => todoistTaskCommentsUrl(taskId, content !== null && content !== void 0 ? content : '', LinkEnvironment.Production), `task/${taskId}/comments`);
+}
+/**
+ * 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 function getProjectCommentsUrl(projectId, name) {
+    return buildUrl(() => todoistProjectCommentsUrl(projectId, name !== null && name !== void 0 ? name : '', LinkEnvironment.Production), `project/${projectId}/comments`);
 }
 /**
- * Slugify function borrowed from Django.
+ * 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 function getTaskCommentUrl(taskId, commentId, content) {
+    return buildUrl(() => todoistTaskCommentUrl(taskId, content !== null && content !== void 0 ? content : '', commentId, LinkEnvironment.Production), `task/${taskId}#comment-${commentId}`);
+}
+/**
+ * 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 function getProjectCommentUrl(projectId, commentId, name) {
+    return buildUrl(() => todoistProjectCommentUrl(projectId, name !== null && name !== void 0 ? name : '', commentId, LinkEnvironment.Production), `project/${projectId}#comment-${commentId}`);
+}
+/** The kinds of Todoist entity a URL can point at. */
+export const TODOIST_LINK_TYPES = [
+    'task',
+    'project',
+    'filter',
+    'label',
+    'section',
+    'workspace',
+    'template',
+    'comment',
+    'label_by_name',
+];
+/**
+ * Maps the link parser's type names onto the types this SDK exposes. A name
+ * that is missing here is one this SDK does not know about, and is treated as
+ * an unrecognised URL rather than surfaced as a value outside the union.
+ */
+const LINK_TYPE_BY_PARSED_NAME = {
+    Task: 'task',
+    Project: 'project',
+    Filter: 'filter',
+    Label: 'label',
+    Section: 'section',
+    Workspace: 'workspace',
+    Template: 'template',
+    Comment: 'comment',
+    LabelByName: 'label_by_name',
+};
+/**
+ * Parse a Todoist URL into the entity it points at.
  *
- * @param value The string to slugify.
- * @returns The slugified string.
+ * @param url The URL to parse.
+ * @returns The entity the URL points at, or `null` if it is not a Todoist URL.
  */
-function slugify(value) {
-    // Convert to ASCII
-    let result = value.normalize('NFKD').replace(/[\u0300-\u036f]/g, '');
-    // Remove non-ASCII characters
-    result = result.replace(/[^\x20-\x7E]/g, '');
-    // Convert to lowercase and replace non-alphanumeric characters with dashes
-    result = result.toLowerCase().replace(/[^\w\s-]/g, '');
-    // Replace spaces and repeated dashes with single dashes
-    result = result.replace(/[-\s]+/g, '-');
-    // Strip dashes from the beginning and end
-    return result.replace(/^-+|-+$/g, '');
+export function parseTodoistUrl(url) {
+    var _a, _b;
+    const link = parseTodoistLink(url);
+    if (!link) {
+        return null;
+    }
+    const type = LINK_TYPE_BY_PARSED_NAME[link.type.name];
+    if (!type) {
+        return null;
+    }
+    return {
+        type,
+        id: link.id,
+        workspaceId: (_a = link.workspaceId) !== null && _a !== void 0 ? _a : null,
+        commentId: (_b = link.commentId) !== null && _b !== void 0 ? _b : null,
+    };
 }

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

@@ -1,6 +1,7 @@
 export * from './colors.js';
 export * from './sanitization.js';
-export { getTaskUrl, getProjectUrl, getSectionUrl } from './url-helpers.js';
+export { getTaskUrl, getProjectUrl, getSectionUrl, getLabelUrl, getFilterUrl, getWorkspaceFilterUrl, getWorkspaceUrl, getTaskCommentsUrl, getProjectCommentsUrl, getTaskCommentUrl, getProjectCommentUrl, parseTodoistUrl, TODOIST_LINK_TYPES, } from './url-helpers.js';
+export type { TodoistLinkType, TodoistUrlInfo } from './url-helpers.js';
 export { createCommand } from './sync-helpers.js';
 export * from './project-helpers.js';
 export * from './task-sorting.js';

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.2.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,6 +46,7 @@
         "fflate": "0.8.2"
     },
     "dependencies": {
+        "@doist/sdk-kmp": "0.2.3",
         "camelcase": "6.3.0",
         "emoji-regex": "10.6.0",
         "ts-custom-error": "^3.2.0",
@@ -91,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",