Implement global file upload endpoints

Author: szuperaz

__tests__/file-uploads.test.ts

@@ -0,0 +1,71 @@
+import { beforeAll, describe, it, expect } from 'vitest';
+import { createTestClient } from './create-test-client';
+import { StreamClient } from '../src/StreamClient';
+import fs from 'fs';
+import path from 'path';
+import { File } from 'buffer';
+
+// Don't want to upload files and image every time we run the tests
+describe.skip('global file uploads', () => {
+  let client: StreamClient;
+  const user = {
+    id: 'stream-node-test-user',
+    role: 'admin',
+  };
+
+  beforeAll(async () => {
+    client = createTestClient();
+    await client.upsertUsers([user]);
+  });
+
+  it('upload and delete file', async () => {
+    // Read the test PDF file from assets
+    const filePath = path.join(__dirname, 'assets', 'test-file.pdf');
+    const fileBuffer = fs.readFileSync(filePath);
+
+    const response = await client.uploadFile({
+      file: new File([fileBuffer], 'test-file.pdf'),
+      user: { id: user.id },
+    });
+
+    expect(response).toBeDefined();
+    expect(response.file).toBeDefined();
+    expect(response.duration).toBeDefined();
+
+    const deleteResponse = await client.deleteFile({
+      url: response.file,
+    });
+
+    expect(deleteResponse).toBeDefined();
+  });
+
+  it('upload image', async () => {
+    // Read the test PDF file from assets
+    const filePath = path.join(__dirname, 'assets', 'test-image.jpg');
+    const fileBuffer = fs.readFileSync(filePath);
+
+    const uploadSizes = [
+      {
+        width: 100,
+        height: 100,
+        resize: 'scale',
+        crop: 'center',
+      },
+    ];
+
+    // Upload the file
+    const response = await client.uploadImage({
+      file: new File([fileBuffer], 'test-image.jpg'),
+      user: { id: user.id },
+      upload_sizes: uploadSizes,
+    });
+
+    expect(response.upload_sizes?.length).toBe(1);
+    expect(response.upload_sizes?.[0]).toMatchObject(uploadSizes[0]);
+    const deleteResponse = await client.deleteImage({
+      url: response.file,
+    });
+
+    expect(deleteResponse).toBeDefined();
+  });
+});

src/StreamClient.ts

@@ -8,6 +8,7 @@ import { QueryBannedUsersPayload, UserRequest } from './gen/models';
 import { StreamModerationClient } from './StreamModerationClient';
 import { ApiClient } from './ApiClient';
 import { StreamFeedsClient } from './StreamFeedsClient';
+import { File } from 'buffer';
 
 export interface StreamClientOptions {
   timeout?: number;
@@ -91,6 +92,30 @@ export class StreamClient extends CommonApi {
     return this.chat.queryBannedUsers(request);
   };
 
+  // @ts-expect-error API spec says file should be a string
+  uploadFile = (request: Omit<FileUploadRequest, 'file'> & { file: File }) => {
+    return super.uploadFile({
+      // @ts-expect-error API spec says file should be a string
+      file: request.file,
+      // @ts-expect-error form data will only work if this is a string
+      user: JSON.stringify(request.user),
+    });
+  };
+
+  // @ts-expect-error API spec says file should be a string
+  uploadImage = (
+    request: Omit<ImageUploadRequest, 'file'> & { file: File },
+  ) => {
+    return super.uploadImage({
+      // @ts-expect-error API spec says file should be a string
+      file: request.file,
+      // @ts-expect-error form data will only work if this is a string
+      user: JSON.stringify(request.user),
+      // @ts-expect-error form data will only work if this is a string
+      upload_sizes: JSON.stringify(request.upload_sizes),
+    });
+  };
+
   /**
    *
    * @param payload