@doist/comms-sdk 3.0.2 → 3.2.0

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

@@ -1,7 +1,9 @@
-import { ENDPOINT_ATTACHMENTS } from '../consts/endpoints.js';
+import { z } from 'zod';
+import { ENDPOINT_ATTACHMENTS, ENDPOINT_FILES } from '../consts/endpoints.js';
+import { request } from '../transport/http-client.js';
 import { AttachmentSchema } from '../types/entities.js';
 import { uploadMultipartFile } from '../utils/multipart-upload.js';
-import { isValidUuidV7Base58, resolveCreateId, UuidV7Error } from '../utils/uuidv7.js';
+import { isValidUuidV7Base58, resolveCreateId, resolveReferenceId, UuidV7Error, } from '../utils/uuidv7.js';
 import { BaseClient } from './base-client.js';
 /**
  * Resolve the `attachment_id`: validate a caller-supplied value (throwing an
@@ -15,14 +17,40 @@ function resolveAttachmentId(attachmentId) {
     }
     return resolveCreateId(attachmentId);
 }
+export const IMAGE_READ_MIME_TYPES = ['image/jpeg', 'image/png', 'image/webp'];
+const IMAGE_READ_MAX_BYTES = 5 * 1024 * 1024;
+export const ImageReadResultSchema = z.object({
+    mimeType: z.enum(IMAGE_READ_MIME_TYPES),
+    // The API allows 5 MiB of image bytes. Base64 encodes each three-byte group
+    // as four characters, including padding for the last group.
+    dataBase64: z
+        .string()
+        .min(1)
+        .max(4 * Math.ceil(IMAGE_READ_MAX_BYTES / 3))
+        .base64(),
+    byteLength: z.number().int().positive().max(IMAGE_READ_MAX_BYTES),
+});
 /**
- * Client for uploading file attachments to Comms.
+ * Client for uploading attachments and reading thread images.
  *
  * Attachments are uploaded independently, then referenced by passing the returned
  * {@link Attachment} into the `attachments` array of `comments.createComment`,
  * `conversationMessages.createMessage`, and similar calls.
  */
 export class AttachmentsClient extends BaseClient {
+    /** Read one thread image under the caller's content scope. */
+    async readImage(uploadId, threadId) {
+        const id = resolveReferenceId(uploadId, 'uploadId');
+        const checkedThreadId = resolveReferenceId(threadId, 'threadId');
+        const response = await request({
+            httpMethod: 'GET',
+            baseUri: this.getBaseUri(),
+            relativePath: `${ENDPOINT_FILES}/image/${checkedThreadId}/${id}`,
+            apiToken: this.apiToken,
+            customFetch: this.customFetch,
+        });
+        return ImageReadResultSchema.parse(response.data);
+    }
     /**
      * Uploads a file and returns the created {@link Attachment}.
      *

package/dist/esm/consts/endpoints.js

@@ -27,4 +27,5 @@ export const ENDPOINT_REACTIONS = 'reactions';
 export const ENDPOINT_SEARCH = 'search';
 export const ENDPOINT_CONVERSATION_MESSAGES = 'conversation_messages';
 export const ENDPOINT_ATTACHMENTS = 'attachments';
+export const ENDPOINT_FILES = 'files';
 export const ENDPOINT_HOOKS = 'hooks';

package/dist/esm/index.js

@@ -1,6 +1,6 @@
 export * from './authentication.js';
 export * from './migration.js';
-export { AttachmentsClient } from './clients/attachments-client.js';
+export { AttachmentsClient, IMAGE_READ_MIME_TYPES, ImageReadResultSchema, } from './clients/attachments-client.js';
 export { ChannelsClient } from './clients/channels-client.js';
 export { CommentsClient } from './clients/comments-client.js';
 export { ConversationMessagesClient } from './clients/conversation-messages-client.js';

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

@@ -1,14 +1,29 @@
+import { z } from 'zod';
 import { type Attachment } from '../types/entities.js';
 import type { UploadAttachmentArgs } from '../types/requests.js';
 import { BaseClient } from './base-client.js';
+export declare const IMAGE_READ_MIME_TYPES: readonly ["image/jpeg", "image/png", "image/webp"];
+export type ImageReadMimeType = (typeof IMAGE_READ_MIME_TYPES)[number];
+export declare const ImageReadResultSchema: z.ZodObject<{
+    mimeType: z.ZodEnum<{
+        "image/png": "image/png";
+        "image/jpeg": "image/jpeg";
+        "image/webp": "image/webp";
+    }>;
+    dataBase64: z.ZodString;
+    byteLength: z.ZodNumber;
+}, z.core.$strip>;
+export type ImageReadResult = z.infer<typeof ImageReadResultSchema>;
 /**
- * Client for uploading file attachments to Comms.
+ * Client for uploading attachments and reading thread images.
  *
  * Attachments are uploaded independently, then referenced by passing the returned
  * {@link Attachment} into the `attachments` array of `comments.createComment`,
  * `conversationMessages.createMessage`, and similar calls.
  */
 export declare class AttachmentsClient extends BaseClient {
+    /** Read one thread image under the caller's content scope. */
+    readImage(uploadId: string, threadId: string): Promise<ImageReadResult>;
     /**
      * Uploads a file and returns the created {@link Attachment}.
      *

package/dist/types/consts/endpoints.d.ts

@@ -23,4 +23,5 @@ export declare const ENDPOINT_REACTIONS = "reactions";
 export declare const ENDPOINT_SEARCH = "search";
 export declare const ENDPOINT_CONVERSATION_MESSAGES = "conversation_messages";
 export declare const ENDPOINT_ATTACHMENTS = "attachments";
+export declare const ENDPOINT_FILES = "files";
 export declare const ENDPOINT_HOOKS = "hooks";

package/dist/types/index.d.ts

@@ -1,6 +1,6 @@
 export * from './authentication.js';
 export * from './migration.js';
-export { AttachmentsClient } from './clients/attachments-client.js';
+export { AttachmentsClient, IMAGE_READ_MIME_TYPES, ImageReadResultSchema, type ImageReadMimeType, type ImageReadResult, } from './clients/attachments-client.js';
 export { ChannelsClient } from './clients/channels-client.js';
 export { CommentsClient } from './clients/comments-client.js';
 export { ConversationMessagesClient } from './clients/conversation-messages-client.js';

package/package.json

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