@doist/todoist-sdk 15.2.0 → 15.3.1

package/README.md

@@ -178,6 +178,16 @@ const api = new TodoistApi('YOURTOKEN', { customFetch })
 - File upload bodies are a `Blob`, or a `ReadableStream` when uploading from a stream — a custom fetch must pass them through unchanged
 - Timeout parameter is optional and up to your custom implementation
 
+## Filter Queries
+
+Use `escapeFilterToken` for user-provided search text, handling validation and trimming in your code. Pass complete filter queries directly to `getTasksByFilter`.
+
+```typescript
+await api.getTasksByFilter({
+    query: `search: ${escapeFilterToken(searchText)}`,
+})
+```
+
 ## Development and Testing
 
 Instead of having an example app in the repository to assist development and testing, we have included [ts-node](https://github.com/TypeStrong/ts-node) as a dev dependency. This allows us to have a scratch file locally that can import and utilize the API while developing or reviewing pull requests without having to manage a separate app project.

package/dist/esm/utils/sanitization.js

@@ -110,3 +110,22 @@ export function getSanitizedContent(input) {
 export function getSanitizedTasks(tasks) {
     return tasks.map((task) => (Object.assign(Object.assign({}, task), { sanitizedContent: getSanitizedContent(task.content) })));
 }
+/**
+ * Escapes text for use as a token in a Todoist filter query.
+ *
+ * Prefixes parentheses, pipes, ampersands, exclamation marks, commas, and
+ * backslashes with a backslash. Quotes and asterisks are left unchanged.
+ * Whitespace validation and trimming are the caller's responsibility.
+ * Pass unescaped text to this function once, before inserting it into a query.
+ *
+ * @example
+ * const tasks = await api.getTasksByFilter({
+ *     query: `search: ${escapeFilterToken(searchText)}`,
+ * })
+ *
+ * @param text - The text to escape, not a complete filter query
+ * @returns The escaped text, with whitespace preserved
+ */
+export function escapeFilterToken(text) {
+    return text.replace(/[()|&!,\\]/g, '\\$&');
+}

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

@@ -33,3 +33,20 @@ export declare function getSanitizedContent(input: string): string;
  * @returns Array of tasks with added sanitizedContent property
  */
 export declare function getSanitizedTasks(tasks: Task[]): TaskWithSanitizedContent[];
+/**
+ * Escapes text for use as a token in a Todoist filter query.
+ *
+ * Prefixes parentheses, pipes, ampersands, exclamation marks, commas, and
+ * backslashes with a backslash. Quotes and asterisks are left unchanged.
+ * Whitespace validation and trimming are the caller's responsibility.
+ * Pass unescaped text to this function once, before inserting it into a query.
+ *
+ * @example
+ * const tasks = await api.getTasksByFilter({
+ *     query: `search: ${escapeFilterToken(searchText)}`,
+ * })
+ *
+ * @param text - The text to escape, not a complete filter query
+ * @returns The escaped text, with whitespace preserved
+ */
+export declare function escapeFilterToken(text: string): string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@doist/todoist-sdk",
-    "version": "15.2.0",
+    "version": "15.3.1",
     "description": "The official TypeScript SDK for the Todoist REST API.",
     "author": "Doist developers",
     "repository": "https://github.com/Doist/todoist-sdk-typescript",
@@ -72,7 +72,7 @@
         "ts-node": "10.9.2",
         "type-fest": "^5.0.0",
         "typescript": "5.9.3",
-        "vitest": "4.1.0"
+        "vitest": "4.1.11"
     },
     "peerDependencies": {
         "type-fest": "^4.12.0 || ^5.5.0"