@doist/comms-sdk 0.8.0 → 0.9.0

package/dist/cjs/types/entities.js

@@ -420,16 +420,29 @@ exports.UnreadConversationSchema = zod_1.z.object({
     directMention: zod_1.z.boolean(),
 });
 // SearchResult entity from API.
+// The API currently only emits 'thread' and 'conversation' results: a match inside a
+// comment is returned as a 'thread' result with `commentId` set, and a match inside a
+// message as a 'conversation' result with `messageId` set.
 exports.SEARCH_RESULT_TYPES = ['thread', 'comment', 'message', 'conversation'];
 exports.SearchResultSchema = zod_1.z.object({
+    /**
+     * Opaque search-result key in the form `thread_<threadId>` or
+     * `conversation_<conversationId>`. Unique per result; not a Comms object id — use
+     * `threadId`, `conversationId`, `commentId`, or `messageId` to reference objects.
+     */
     id: zod_1.z.string(),
     type: zod_1.z.enum(exports.SEARCH_RESULT_TYPES),
     snippet: zod_1.z.string(),
     snippetCreatorId: zod_1.z.number(),
     snippetLastUpdated: zod_1.z.date(),
+    /** The owning thread id. Set by the API on 'thread' results. */
     threadId: zod_1.z.string().nullable().optional(),
+    /** The owning conversation id. Set by the API on 'conversation' results. */
     conversationId: zod_1.z.string().nullable().optional(),
+    /** The matched comment id, set on 'thread' results when the match is a comment. */
     commentId: zod_1.z.string().nullable().optional(),
+    /** The matched message id, set by the API on 'conversation' results. */
+    messageId: zod_1.z.union([zod_1.z.string(), zod_1.z.number()]).transform(String).nullable().optional(),
     channelId: zod_1.z.string().nullable().optional(),
     channelName: zod_1.z.string().nullable().optional(),
     channelColor: zod_1.z.number().nullable().optional(),

package/dist/esm/types/entities.js

@@ -410,16 +410,29 @@ export const UnreadConversationSchema = z.object({
     directMention: z.boolean(),
 });
 // SearchResult entity from API.
+// The API currently only emits 'thread' and 'conversation' results: a match inside a
+// comment is returned as a 'thread' result with `commentId` set, and a match inside a
+// message as a 'conversation' result with `messageId` set.
 export const SEARCH_RESULT_TYPES = ['thread', 'comment', 'message', 'conversation'];
 export const SearchResultSchema = z.object({
+    /**
+     * Opaque search-result key in the form `thread_<threadId>` or
+     * `conversation_<conversationId>`. Unique per result; not a Comms object id — use
+     * `threadId`, `conversationId`, `commentId`, or `messageId` to reference objects.
+     */
     id: z.string(),
     type: z.enum(SEARCH_RESULT_TYPES),
     snippet: z.string(),
     snippetCreatorId: z.number(),
     snippetLastUpdated: z.date(),
+    /** The owning thread id. Set by the API on 'thread' results. */
     threadId: z.string().nullable().optional(),
+    /** The owning conversation id. Set by the API on 'conversation' results. */
     conversationId: z.string().nullable().optional(),
+    /** The matched comment id, set on 'thread' results when the match is a comment. */
     commentId: z.string().nullable().optional(),
+    /** The matched message id, set by the API on 'conversation' results. */
+    messageId: z.union([z.string(), z.number()]).transform(String).nullable().optional(),
     channelId: z.string().nullable().optional(),
     channelName: z.string().nullable().optional(),
     channelColor: z.number().nullable().optional(),

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

@@ -2818,6 +2818,7 @@ export declare const SearchResultSchema: z.ZodObject<{
     threadId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     conversationId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     commentId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    messageId: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>>>;
     channelId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     channelName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     channelColor: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@doist/comms-sdk",
-    "version": "0.8.0",
+    "version": "0.9.0",
     "description": "A TypeScript wrapper for the Comms REST API.",
     "author": "Doist developers",
     "homepage": "https://doist.github.io/comms-sdk-typescript/",