@todoist/sdk 0.0.1 → 18.0.0

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

@@ -0,0 +1,120 @@
+/**
+ * Formats a Date object to YYYY-MM-DD string format.
+ *
+ * @internal
+ * @param date The Date object to format.
+ * @returns The formatted date string in YYYY-MM-DD format.
+ */
+export declare function formatDateToYYYYMMDD(date: Date): string;
+/**
+ * Generate the URL for a given task.
+ *
+ * @param taskId The ID of the task.
+ * @param content The content of the task.
+ * @returns The URL string for the task view.
+ */
+export declare function getTaskUrl(taskId: string, content?: string): string;
+/**
+ * Generate the URL for a given project.
+ *
+ * @param projectId The ID of the project.
+ * @param name The name of the project.
+ * @returns The URL string for the project view.
+ */
+export declare function getProjectUrl(projectId: string, name?: string): string;
+/**
+ * Generate the URL for a given section.
+ *
+ * @param sectionId The ID of the section.
+ * @param name The name of the section.
+ * @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;