@doist/twist-sdk 2.4.1 → 2.5.1

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

@@ -41,9 +41,10 @@ var SearchClient = /** @class */ (function (_super) {
     }
     SearchClient.prototype.search = function (args, options) {
         var params = {
-            query: args.query,
             workspace_id: args.workspaceId,
         };
+        if (args.query !== undefined)
+            params.query = args.query;
         if (args.channelIds)
             params.channel_ids = args.channelIds;
         if (args.authorIds)

package/dist/cjs/transport/http-dispatcher.js

@@ -68,9 +68,19 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getDefaultDispatcher = getDefaultDispatcher;
 exports.resetDefaultDispatcherForTests = resetDefaultDispatcherForTests;
+exports.suppressExperimentalWarningsSync = suppressExperimentalWarningsSync;
 // Use effectively-disabled keep-alive so short-lived CLI processes do not stay
 // open waiting on idle sockets. Undici requires positive values, so we use 1ms.
 var keepAliveOptions = {
@@ -111,18 +121,61 @@ function isNodeEnvironment() {
 }
 function createDefaultDispatcher() {
     return __awaiter(this, void 0, void 0, function () {
-        var EnvHttpProxyAgent;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
+        var _a, EnvHttpProxyAgent, interceptors, decompress;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
                 case 0:
                     if (!isNodeEnvironment()) {
                         return [2 /*return*/, undefined];
                     }
                     return [4 /*yield*/, Promise.resolve().then(function () { return __importStar(require('undici')); })];
                 case 1:
-                    EnvHttpProxyAgent = (_a.sent()).EnvHttpProxyAgent;
-                    return [2 /*return*/, new EnvHttpProxyAgent(keepAliveOptions)];
+                    _a = _b.sent(), EnvHttpProxyAgent = _a.EnvHttpProxyAgent, interceptors = _a.interceptors;
+                    decompress = suppressExperimentalWarningsSync(function () { return interceptors.decompress(); });
+                    return [2 /*return*/, new EnvHttpProxyAgent(keepAliveOptions).compose(decompress)];
             }
         });
     });
 }
+// undici emits an `ExperimentalWarning` the first time `interceptors.decompress()`
+// runs. The interceptor is stable for our gzipped-JSON-over-HTTPS use case;
+// silence the warning during dispatcher init only so it does not leak to every
+// consumer's stderr on the first request.
+//
+// `fn` must be synchronous so the override covers a single critical section
+// (microseconds) — no unrelated `ExperimentalWarning` from elsewhere can
+// interleave and be lost. We suppress every `ExperimentalWarning` rather than
+// pattern-matching the message text: the message wording is an undici
+// implementation detail (not a stable API), and the suppression window is
+// narrow enough that a coarse type filter is safe.
+//
+// Exported for direct unit testing — the integration path through
+// `getDefaultDispatcher()` cannot reliably exercise the helper because both
+// the dispatcher singleton and undici's internal `warningEmitted` flag are
+// once-per-process.
+function suppressExperimentalWarningsSync(fn) {
+    var originalEmit = process.emitWarning;
+    process.emitWarning = (function (warning, typeOrOptions) {
+        var _a;
+        var rest = [];
+        for (var _i = 2; _i < arguments.length; _i++) {
+            rest[_i - 2] = arguments[_i];
+        }
+        var type = typeof typeOrOptions === 'string'
+            ? typeOrOptions
+            : typeof typeOrOptions === 'object' && typeOrOptions !== null
+                ? typeOrOptions.type
+                : undefined;
+        if (type === 'ExperimentalWarning')
+            return;
+        (_a = originalEmit).call.apply(_a, __spreadArray([process,
+            warning,
+            typeOrOptions], rest, false));
+    });
+    try {
+        return fn();
+    }
+    finally {
+        process.emitWarning = originalEmit;
+    }
+}

package/dist/esm/clients/search-client.js

@@ -38,9 +38,10 @@ var SearchClient = /** @class */ (function (_super) {
     }
     SearchClient.prototype.search = function (args, options) {
         var params = {
-            query: args.query,
             workspace_id: args.workspaceId,
         };
+        if (args.query !== undefined)
+            params.query = args.query;
         if (args.channelIds)
             params.channel_ids = args.channelIds;
         if (args.authorIds)

package/dist/esm/transport/http-dispatcher.js

@@ -34,6 +34,15 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
 // Use effectively-disabled keep-alive so short-lived CLI processes do not stay
 // open waiting on idle sockets. Undici requires positive values, so we use 1ms.
 var keepAliveOptions = {
@@ -74,18 +83,68 @@ function isNodeEnvironment() {
 }
 function createDefaultDispatcher() {
     return __awaiter(this, void 0, void 0, function () {
-        var EnvHttpProxyAgent;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
+        var _a, EnvHttpProxyAgent, interceptors, decompress;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
                 case 0:
                     if (!isNodeEnvironment()) {
                         return [2 /*return*/, undefined];
                     }
-                    return [4 /*yield*/, import('undici')];
+                    return [4 /*yield*/, import('undici')
+                        // Compose the response-decompression interceptor so gzip/deflate/br/zstd
+                        // bodies are decoded before consumers parse them. Required on Node 24+:
+                        // attaching any custom dispatcher to the global `fetch` strips the
+                        // `content-encoding` header but does not actually decompress the body,
+                        // so callers receive raw gzipped bytes and `JSON.parse` fails.
+                        // See https://github.com/Doist/todoist-cli/issues/318.
+                    ];
                 case 1:
-                    EnvHttpProxyAgent = (_a.sent()).EnvHttpProxyAgent;
-                    return [2 /*return*/, new EnvHttpProxyAgent(keepAliveOptions)];
+                    _a = _b.sent(), EnvHttpProxyAgent = _a.EnvHttpProxyAgent, interceptors = _a.interceptors;
+                    decompress = suppressExperimentalWarningsSync(function () { return interceptors.decompress(); });
+                    return [2 /*return*/, new EnvHttpProxyAgent(keepAliveOptions).compose(decompress)];
             }
         });
     });
 }
+// undici emits an `ExperimentalWarning` the first time `interceptors.decompress()`
+// runs. The interceptor is stable for our gzipped-JSON-over-HTTPS use case;
+// silence the warning during dispatcher init only so it does not leak to every
+// consumer's stderr on the first request.
+//
+// `fn` must be synchronous so the override covers a single critical section
+// (microseconds) — no unrelated `ExperimentalWarning` from elsewhere can
+// interleave and be lost. We suppress every `ExperimentalWarning` rather than
+// pattern-matching the message text: the message wording is an undici
+// implementation detail (not a stable API), and the suppression window is
+// narrow enough that a coarse type filter is safe.
+//
+// Exported for direct unit testing — the integration path through
+// `getDefaultDispatcher()` cannot reliably exercise the helper because both
+// the dispatcher singleton and undici's internal `warningEmitted` flag are
+// once-per-process.
+export function suppressExperimentalWarningsSync(fn) {
+    var originalEmit = process.emitWarning;
+    process.emitWarning = (function (warning, typeOrOptions) {
+        var _a;
+        var rest = [];
+        for (var _i = 2; _i < arguments.length; _i++) {
+            rest[_i - 2] = arguments[_i];
+        }
+        var type = typeof typeOrOptions === 'string'
+            ? typeOrOptions
+            : typeof typeOrOptions === 'object' && typeOrOptions !== null
+                ? typeOrOptions.type
+                : undefined;
+        if (type === 'ExperimentalWarning')
+            return;
+        (_a = originalEmit).call.apply(_a, __spreadArray([process,
+            warning,
+            typeOrOptions], rest, false));
+    });
+    try {
+        return fn();
+    }
+    finally {
+        process.emitWarning = originalEmit;
+    }
+}

package/dist/types/clients/search-client.d.ts

@@ -10,11 +10,11 @@ export declare class SearchClient extends BaseClient {
      * Searches across all threads and conversations in a workspace.
      *
      * @param args - The arguments for searching.
-     * @param args.query - The search query string.
+     * @param args.query - The search query string. Optional when `mentionSelf: true` is set; required otherwise.
      * @param args.workspaceId - The workspace ID to search in.
      * @param args.channelIds - Optional array of channel IDs to filter by.
      * @param args.authorIds - Optional array of author user IDs to filter by.
-     * @param args.mentionSelf - Optional flag to filter by mentions of the current user.
+     * @param args.mentionSelf - Optional flag to filter by mentions of the current user. When true, `query` may be omitted.
      * @param args.dateFrom - Optional start date for filtering (YYYY-MM-DD).
      * @param args.dateTo - Optional end date for filtering (YYYY-MM-DD).
      * @param args.limit - Optional limit on number of results returned.

package/dist/types/transport/http-dispatcher.d.ts

@@ -1,3 +1,4 @@
 import type { Dispatcher } from 'undici';
 export declare function getDefaultDispatcher(): Promise<Dispatcher | undefined>;
 export declare function resetDefaultDispatcherForTests(): void;
+export declare function suppressExperimentalWarningsSync<T>(fn: () => T): T;

package/dist/types/types/requests.d.ts

@@ -130,17 +130,22 @@ export type UpdateUserArgs = {
     awayMode?: AwayMode;
     offDays?: number[];
 };
-export type SearchArgs = {
-    query: string;
+type SearchArgsCommon = {
     workspaceId: number;
     channelIds?: number[];
     authorIds?: number[];
-    mentionSelf?: boolean;
     dateFrom?: string;
     dateTo?: string;
     limit?: number;
     cursor?: string;
 };
+export type SearchArgs = (SearchArgsCommon & {
+    query: string;
+    mentionSelf?: boolean;
+}) | (SearchArgsCommon & {
+    query?: string;
+    mentionSelf: true;
+});
 export type SearchThreadArgs = {
     query: string;
     threadId: number;
@@ -330,3 +335,4 @@ export type GetUserLocalTimeArgs = {
     workspaceId: number;
     userId: number;
 };
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@doist/twist-sdk",
-    "version": "2.4.1",
+    "version": "2.5.1",
     "description": "A TypeScript wrapper for the Twist REST API.",
     "author": "Doist developers",
     "homepage": "https://doist.github.io/twist-sdk-typescript/",