@doist/twist-sdk 2.1.0 → 2.1.2

package/dist/cjs/batch-builder.js

@@ -61,6 +61,7 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BatchBuilder = void 0;
+var zod_1 = require("zod");
 var base_client_1 = require("./clients/base-client");
 var rest_client_1 = require("./rest-client");
 var case_conversion_1 = require("./utils/case-conversion");
@@ -201,13 +202,7 @@ var BatchBuilder = /** @class */ (function (_super) {
                                 // Validate with schema if provided
                                 var finalData = transformed;
                                 if (descriptor.schema && apiResponse.code >= 200 && apiResponse.code < 300) {
-                                    try {
-                                        finalData = descriptor.schema.parse(transformed);
-                                    }
-                                    catch (error) {
-                                        // If validation fails, include the error in the response
-                                        console.error('Batch response validation failed:', error);
-                                    }
+                                    finalData = descriptor.schema.parse(transformed);
                                 }
                                 // Parse headers string into object
                                 var headers = {};
@@ -264,7 +259,13 @@ var BatchBuilder = /** @class */ (function (_super) {
                         chunks = this.chunkRequests(__spreadArray([], requests, true), BatchBuilder.CHUNK_SIZE);
                         chunkPromises = chunks.map(function (chunk) {
                             return _this.executeSingleBatch(chunk).catch(function (error) {
-                                // Collect errors but don't fail fast - allow other chunks to complete
+                                // Rethrow schema validation errors — they indicate a programming
+                                // issue (wrong schema or unexpected API response shape) and should
+                                // not be silently swallowed.
+                                if (error instanceof zod_1.z.ZodError) {
+                                    throw error;
+                                }
+                                // Collect network/request errors but don't fail fast - allow other chunks to complete
                                 console.error('Batch chunk failed:', error);
                                 // Return error responses for all requests in this chunk
                                 return chunk.map(function () { return ({

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

@@ -55,9 +55,10 @@ var CommentsClient = /** @class */ (function (_super) {
         var method = 'GET';
         var url = "".concat(endpoints_1.ENDPOINT_COMMENTS, "/getone");
         var params = { id: id };
-        var schema = entities_1.CommentSchema;
+        // The API wraps the response in {"comment": {...}}, so we need to unwrap it
+        var wrappedSchema = zod_1.z.object({ comment: entities_1.CommentSchema }).transform(function (data) { return data.comment; });
         if (options === null || options === void 0 ? void 0 : options.batch) {
-            return { method: method, url: url, params: params, schema: schema };
+            return { method: method, url: url, params: params, schema: wrappedSchema };
         }
         return (0, rest_client_1.request)({
             httpMethod: method,
@@ -66,7 +67,7 @@ var CommentsClient = /** @class */ (function (_super) {
             apiToken: this.apiToken,
             payload: params,
             customFetch: this.customFetch,
-        }).then(function (response) { return schema.parse(response.data); });
+        }).then(function (response) { return wrappedSchema.parse(response.data); });
     };
     CommentsClient.prototype.createComment = function (args, options) {
         var method = 'POST';

package/dist/cjs/types/entities.js

@@ -11,7 +11,7 @@ var __assign = (this && this.__assign) || function () {
     return __assign.apply(this, arguments);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SearchResultSchema = exports.UnreadConversationSchema = exports.UnreadThreadSchema = exports.InboxThreadSchema = exports.ConversationMessageSchema = exports.WorkspaceUserSchema = exports.CommentSchema = exports.ConversationSchema = exports.GroupSchema = exports.ThreadSchema = exports.ChannelSchema = exports.WorkspaceSchema = exports.UserSchema = exports.SystemMessageSchema = void 0;
+exports.SearchResultSchema = exports.SEARCH_RESULT_TYPES = exports.UnreadConversationSchema = exports.UnreadThreadSchema = exports.InboxThreadSchema = exports.ConversationMessageSchema = exports.WorkspaceUserSchema = exports.CommentSchema = exports.ConversationSchema = exports.GroupSchema = exports.ThreadSchema = exports.ChannelSchema = exports.WorkspaceSchema = exports.UserSchema = exports.SystemMessageSchema = void 0;
 var zod_1 = require("zod");
 var url_helpers_1 = require("../utils/url-helpers");
 var enums_1 = require("./enums");
@@ -356,9 +356,10 @@ exports.UnreadConversationSchema = zod_1.z.object({
     directMention: zod_1.z.boolean(),
 });
 // SearchResult entity from API
+exports.SEARCH_RESULT_TYPES = ['thread', 'comment', 'message', 'conversation'];
 exports.SearchResultSchema = zod_1.z.object({
     id: zod_1.z.string(),
-    type: zod_1.z.enum(['thread', 'comment', 'message']),
+    type: zod_1.z.enum(exports.SEARCH_RESULT_TYPES),
     snippet: zod_1.z.string(),
     snippetCreatorId: zod_1.z.number(),
     snippetLastUpdated: zod_1.z.date(),

package/dist/esm/batch-builder.js

@@ -58,6 +58,7 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
     }
     return to.concat(ar || Array.prototype.slice.call(from));
 };
+import { z } from 'zod';
 import { BaseClient } from './clients/base-client.js';
 import { fetchWithRetry } from './rest-client.js';
 import { camelCaseKeys, snakeCaseKeys } from './utils/case-conversion.js';
@@ -198,13 +199,7 @@ var BatchBuilder = /** @class */ (function (_super) {
                                 // Validate with schema if provided
                                 var finalData = transformed;
                                 if (descriptor.schema && apiResponse.code >= 200 && apiResponse.code < 300) {
-                                    try {
-                                        finalData = descriptor.schema.parse(transformed);
-                                    }
-                                    catch (error) {
-                                        // If validation fails, include the error in the response
-                                        console.error('Batch response validation failed:', error);
-                                    }
+                                    finalData = descriptor.schema.parse(transformed);
                                 }
                                 // Parse headers string into object
                                 var headers = {};
@@ -261,7 +256,13 @@ var BatchBuilder = /** @class */ (function (_super) {
                         chunks = this.chunkRequests(__spreadArray([], requests, true), BatchBuilder.CHUNK_SIZE);
                         chunkPromises = chunks.map(function (chunk) {
                             return _this.executeSingleBatch(chunk).catch(function (error) {
-                                // Collect errors but don't fail fast - allow other chunks to complete
+                                // Rethrow schema validation errors — they indicate a programming
+                                // issue (wrong schema or unexpected API response shape) and should
+                                // not be silently swallowed.
+                                if (error instanceof z.ZodError) {
+                                    throw error;
+                                }
+                                // Collect network/request errors but don't fail fast - allow other chunks to complete
                                 console.error('Batch chunk failed:', error);
                                 // Return error responses for all requests in this chunk
                                 return chunk.map(function () { return ({

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

@@ -52,9 +52,10 @@ var CommentsClient = /** @class */ (function (_super) {
         var method = 'GET';
         var url = "".concat(ENDPOINT_COMMENTS, "/getone");
         var params = { id: id };
-        var schema = CommentSchema;
+        // The API wraps the response in {"comment": {...}}, so we need to unwrap it
+        var wrappedSchema = z.object({ comment: CommentSchema }).transform(function (data) { return data.comment; });
         if (options === null || options === void 0 ? void 0 : options.batch) {
-            return { method: method, url: url, params: params, schema: schema };
+            return { method: method, url: url, params: params, schema: wrappedSchema };
         }
         return request({
             httpMethod: method,
@@ -63,7 +64,7 @@ var CommentsClient = /** @class */ (function (_super) {
             apiToken: this.apiToken,
             payload: params,
             customFetch: this.customFetch,
-        }).then(function (response) { return schema.parse(response.data); });
+        }).then(function (response) { return wrappedSchema.parse(response.data); });
     };
     CommentsClient.prototype.createComment = function (args, options) {
         var method = 'POST';

package/dist/esm/types/entities.js

@@ -353,9 +353,10 @@ export var UnreadConversationSchema = z.object({
     directMention: z.boolean(),
 });
 // SearchResult entity from API
+export var SEARCH_RESULT_TYPES = ['thread', 'comment', 'message', 'conversation'];
 export var SearchResultSchema = z.object({
     id: z.string(),
-    type: z.enum(['thread', 'comment', 'message']),
+    type: z.enum(SEARCH_RESULT_TYPES),
     snippet: z.string(),
     snippetCreatorId: z.number(),
     snippetLastUpdated: z.date(),

package/dist/types/types/entities.d.ts

@@ -829,12 +829,15 @@ export declare const UnreadConversationSchema: z.ZodObject<{
     directMention: z.ZodBoolean;
 }, z.core.$strip>;
 export type UnreadConversation = z.infer<typeof UnreadConversationSchema>;
+export declare const SEARCH_RESULT_TYPES: readonly ["thread", "comment", "message", "conversation"];
+export type SearchResultType = (typeof SEARCH_RESULT_TYPES)[number];
 export declare const SearchResultSchema: z.ZodObject<{
     id: z.ZodString;
     type: z.ZodEnum<{
         thread: "thread";
         comment: "comment";
         message: "message";
+        conversation: "conversation";
     }>;
     snippet: z.ZodString;
     snippetCreatorId: z.ZodNumber;

package/package.json

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