web-api(fix): include file or contents types in file_uploads arguments (

#1744)

packages/web-api/src/WebClient.ts

@@ -519,7 +519,7 @@ export class WebClient extends Methods {
     }
 
     // add multiple files data when file_uploads is supplied
-    if (options.file_uploads) {
+    if ('file_uploads' in options) {
       fileUploads = fileUploads.concat(await getMultipleFileUploadJobs(options, this.logger));
     }
     return fileUploads;

packages/web-api/src/file-upload.ts

@@ -5,8 +5,6 @@ import { errorWithCode, ErrorCode } from './errors';
 import {
   FilesCompleteUploadExternalArguments,
   FilesUploadV2Arguments,
-  FileUploadBinaryContents,
-  FileUploadStringContents,
   FileUploadV2,
   FileUploadV2Job,
 } from './types/request/files';
@@ -47,10 +45,16 @@ export async function getFileUploadJob(
       ...fileUploadJob,
     };
   }
-  return {
-    file: options.file,
-    ...fileUploadJob,
-  };
+  if ('file' in options) {
+    return {
+      file: options.file,
+      ...fileUploadJob,
+    };
+  }
+  throw errorWithCode(
+    new Error('Either a file or content field is required for valid file upload. You must supply one'),
+    ErrorCode.FileUploadInvalidArgumentsError,
+  );
 }
 
 /**
@@ -82,7 +86,7 @@ export async function getMultipleFileUploadJobs(
   options: FilesUploadV2Arguments,
   logger: Logger,
 ): Promise<FileUploadV2Job[]> {
-  if (options.file_uploads) {
+  if ('file_uploads' in options) {
     // go through each file_upload and create a job for it
     return Promise.all(options.file_uploads.map((upload) => {
       // ensure no omitted properties included in files_upload entry
@@ -108,14 +112,20 @@ export async function getMultipleFileUploadJobs(
       }
       if ('content' in upload) {
         return getFileUploadJob({
-          content: (upload as FileUploadStringContents).content,
+          content: upload.content,
           ...uploadJobArgs,
         }, logger);
       }
-      return getFileUploadJob({
-        file: (upload as FileUploadBinaryContents).file,
-        ...uploadJobArgs,
-      }, logger);
+      if ('file' in upload) {
+        return getFileUploadJob({
+          file: upload.file,
+          ...uploadJobArgs,
+        }, logger);
+      }
+      throw errorWithCode(
+        new Error('Either a file or content field is required for valid file upload. You must supply one'),
+        ErrorCode.FileUploadInvalidArgumentsError,
+      );
     }));
   }
   throw new Error(buildFilesUploadMissingMessage());

packages/web-api/src/types/helpers.ts

@@ -0,0 +1,2 @@
+/** Omit all keys K from possible union types T */
+export type ExcludeFromUnion<T, K extends string> = T extends T ? Omit<T, K> : never;

packages/web-api/src/types/request/files.ts

@@ -6,6 +6,7 @@ import type {
   TraditionalPagingEnabled,
 } from './common';
 import type { FilesGetUploadURLExternalResponse } from '../response/index';
+import type { ExcludeFromUnion } from '../helpers';
 
 interface FileArgument {
   /** @description Encoded file ID. */
@@ -147,10 +148,15 @@ export type FileUploadV2 = FileUpload & {
   snippet_type?: string;
 };
 
+interface FilesUploadV2ArgumentsMultipleFiles {
+  file_uploads: ExcludeFromUnion<FileUploadV2, 'channel_id' | 'channels' | 'initial_comment' | 'thread_ts'>[];
+}
+
 // https://slack.dev/node-slack-sdk/web-api#upload-a-file
-export type FilesUploadV2Arguments = FileUploadV2 & TokenOverridable & {
-  file_uploads?: Omit<FileUploadV2, 'channel_id' | 'channels' | 'initial_comment' | 'thread_ts'>[];
-};
+export type FilesUploadV2Arguments = TokenOverridable & (
+  | FileUploadV2
+  | (Omit<FileUploadV2, 'file' | 'content'> & FilesUploadV2ArgumentsMultipleFiles)
+);
 
 // Helper type intended for internal use in filesUploadV2 client method
 // Includes additional metadata required to complete a single file upload job