@doist/comms-sdk 0.8.0 → 0.10.0

package/dist/cjs/types/entities.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SearchResultSchema = exports.SEARCH_RESULT_TYPES = exports.UnreadConversationSchema = exports.UnreadThreadSchema = exports.InboxThreadSchema = exports.ConversationMessageSchema = exports.ConversationMessageObjectSchema = exports.WorkspaceUserSchema = exports.CommentSchema = exports.CommentObjectSchema = exports.ConversationSchema = exports.ConversationObjectSchema = exports.GroupSchema = exports.ThreadSchema = exports.ThreadObjectSchema = exports.ChannelSchema = exports.ChannelObjectSchema = exports.WorkspaceSchema = exports.UserSchema = exports.BaseUserSchema = exports.RequestAttachmentSchema = exports.AttachmentSchema = exports.HookSubscribeResponseSchema = exports.StatusOkSchema = exports.SystemMessageSchema = void 0;
+exports.SearchResultSchema = exports.ConversationSearchResultSchema = exports.ThreadSearchResultSchema = exports.SEARCH_RESULT_TYPES = exports.UnreadConversationSchema = exports.UnreadThreadSchema = exports.InboxThreadSchema = exports.ConversationMessageSchema = exports.ConversationMessageObjectSchema = exports.WorkspaceUserSchema = exports.CommentSchema = exports.CommentObjectSchema = exports.ConversationSchema = exports.ConversationObjectSchema = exports.GroupSchema = exports.ThreadSchema = exports.ThreadObjectSchema = exports.ChannelSchema = exports.ChannelObjectSchema = exports.WorkspaceSchema = exports.UserSchema = exports.BaseUserSchema = exports.RequestAttachmentSchema = exports.AttachmentSchema = exports.HookSubscribeResponseSchema = exports.StatusOkSchema = exports.SystemMessageSchema = void 0;
 exports.createChannelSchema = createChannelSchema;
 exports.createThreadSchema = createThreadSchema;
 exports.createConversationSchema = createConversationSchema;
@@ -420,19 +420,43 @@ 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({
+// The API 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.
+const searchResultBaseShape = {
+    /**
+     * 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(),
-    threadId: zod_1.z.string().nullable().optional(),
-    conversationId: zod_1.z.string().nullable().optional(),
-    commentId: zod_1.z.string().nullable().optional(),
     channelId: zod_1.z.string().nullable().optional(),
     channelName: zod_1.z.string().nullable().optional(),
     channelColor: zod_1.z.number().nullable().optional(),
     title: zod_1.z.string().nullable().optional(),
     closed: zod_1.z.boolean().nullable().optional(),
+};
+exports.SEARCH_RESULT_TYPES = ['thread', 'conversation'];
+exports.ThreadSearchResultSchema = zod_1.z.object({
+    ...searchResultBaseShape,
+    type: zod_1.z.literal('thread'),
+    /** The owning thread id. */
+    threadId: zod_1.z.string(),
+    /** The matched comment id, set when the match is a comment. */
+    commentId: zod_1.z.string().nullable().optional(),
+});
+exports.ConversationSearchResultSchema = zod_1.z.object({
+    ...searchResultBaseShape,
+    type: zod_1.z.literal('conversation'),
+    /** The owning conversation id. */
+    conversationId: zod_1.z.string(),
+    /** The matched message id. */
+    messageId: zod_1.z.union([zod_1.z.string(), zod_1.z.number()]).transform(String).nullable().optional(),
 });
+exports.SearchResultSchema = zod_1.z.discriminatedUnion('type', [
+    exports.ThreadSearchResultSchema,
+    exports.ConversationSearchResultSchema,
+]);

package/dist/esm/types/entities.js

@@ -410,19 +410,43 @@ export const UnreadConversationSchema = z.object({
     directMention: z.boolean(),
 });
 // SearchResult entity from API.
-export const SEARCH_RESULT_TYPES = ['thread', 'comment', 'message', 'conversation'];
-export const SearchResultSchema = z.object({
+// The API 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.
+const searchResultBaseShape = {
+    /**
+     * 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(),
-    threadId: z.string().nullable().optional(),
-    conversationId: z.string().nullable().optional(),
-    commentId: z.string().nullable().optional(),
     channelId: z.string().nullable().optional(),
     channelName: z.string().nullable().optional(),
     channelColor: z.number().nullable().optional(),
     title: z.string().nullable().optional(),
     closed: z.boolean().nullable().optional(),
+};
+export const SEARCH_RESULT_TYPES = ['thread', 'conversation'];
+export const ThreadSearchResultSchema = z.object({
+    ...searchResultBaseShape,
+    type: z.literal('thread'),
+    /** The owning thread id. */
+    threadId: z.string(),
+    /** The matched comment id, set when the match is a comment. */
+    commentId: z.string().nullable().optional(),
+});
+export const ConversationSearchResultSchema = z.object({
+    ...searchResultBaseShape,
+    type: z.literal('conversation'),
+    /** The owning conversation id. */
+    conversationId: z.string(),
+    /** The matched message id. */
+    messageId: z.union([z.string(), z.number()]).transform(String).nullable().optional(),
 });
+export const SearchResultSchema = z.discriminatedUnion('type', [
+    ThreadSearchResultSchema,
+    ConversationSearchResultSchema,
+]);

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

@@ -2802,28 +2802,65 @@ 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 declare const SEARCH_RESULT_TYPES: readonly ["thread", "conversation"];
 export type SearchResultType = (typeof SEARCH_RESULT_TYPES)[number];
-export declare const SearchResultSchema: z.ZodObject<{
+export declare const ThreadSearchResultSchema: z.ZodObject<{
+    type: z.ZodLiteral<"thread">;
+    threadId: z.ZodString;
+    commentId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     id: z.ZodString;
-    type: z.ZodEnum<{
-        thread: "thread";
-        message: "message";
-        comment: "comment";
-        conversation: "conversation";
-    }>;
     snippet: z.ZodString;
     snippetCreatorId: z.ZodNumber;
     snippetLastUpdated: z.ZodDate;
-    threadId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    conversationId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    commentId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     channelId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     channelName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     channelColor: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
     title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     closed: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
 }, z.core.$strip>;
+export type ThreadSearchResult = z.infer<typeof ThreadSearchResultSchema>;
+export declare const ConversationSearchResultSchema: z.ZodObject<{
+    type: z.ZodLiteral<"conversation">;
+    conversationId: z.ZodString;
+    messageId: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>>>;
+    id: z.ZodString;
+    snippet: z.ZodString;
+    snippetCreatorId: z.ZodNumber;
+    snippetLastUpdated: z.ZodDate;
+    channelId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    channelName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    channelColor: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    closed: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+}, z.core.$strip>;
+export type ConversationSearchResult = z.infer<typeof ConversationSearchResultSchema>;
+export declare const SearchResultSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"thread">;
+    threadId: z.ZodString;
+    commentId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    id: z.ZodString;
+    snippet: z.ZodString;
+    snippetCreatorId: z.ZodNumber;
+    snippetLastUpdated: z.ZodDate;
+    channelId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    channelName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    channelColor: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    closed: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"conversation">;
+    conversationId: z.ZodString;
+    messageId: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>>>;
+    id: z.ZodString;
+    snippet: z.ZodString;
+    snippetCreatorId: z.ZodNumber;
+    snippetLastUpdated: z.ZodDate;
+    channelId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    channelName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    channelColor: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    closed: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+}, z.core.$strip>], "type">;
 export type SearchResult = z.infer<typeof SearchResultSchema>;
 export type SearchResponse = {
     items: SearchResult[];

package/package.json

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