#353, #392 Form data enhancements (#398)

* eslint improvements

* #388: removing ~ from dist folder

* v5.2.1

* new form-data usage PoC

* code formatting and fixes

* test fixes

Author: MrRefactoring

src/node/createAttachmentFromPath.ts

@@ -0,0 +1,18 @@
+import { open } from 'fs/promises';
+import { basename } from 'path';
+import type { Attachment } from '../version2/parameters';
+
+export async function createAttachmentFromPath(path: string, contentType?: string): Promise<Attachment> {
+  const filename = basename(path);
+
+  const fileHandle = await open(path, 'r');
+
+  const { size } = await fileHandle.stat();
+
+  return {
+    filename,
+    content: fileHandle.readableWebStream(),
+    contentType,
+    contentLength: size,
+  };
+}

src/services/formDataService/formDataService.ts

@@ -0,0 +1,78 @@
+import mime from 'mime';
+import type { ReadableStream as ReadableNodeStream } from 'node:stream/web';
+
+type FormDataValue = string | Blob | ArrayBuffer | ReadableStream | ReadableNodeStream;
+
+class FileWithSize extends File {
+  size: number = 0;
+}
+
+interface AppendOptions {
+  contentLength?: number;
+  contentType?: string;
+}
+
+export class FormDataService {
+  formData: FormData;
+
+  constructor() {
+    this.formData = new FormData();
+  }
+
+  async append(value: FormDataValue, filename: string, options: AppendOptions = {}) {
+    const blobOptions = {
+      type: options.contentType ?? mime.getType(filename) ?? undefined,
+    };
+
+    if (typeof value === 'string') {
+      this.formData.append('file', new Blob([value], blobOptions), filename);
+    } else if (value instanceof Blob) {
+      this.formData.append('file', new Blob([value], blobOptions), filename);
+    } else if (ArrayBuffer.isView(value) || value instanceof ArrayBuffer) {
+      this.formData.append('file', new Blob([value], blobOptions), filename);
+    } else if (value instanceof ReadableStream) {
+      const file = new FileWithSize([], filename, blobOptions);
+
+      if (options.contentLength != undefined) {
+        file.size = options.contentLength;
+        file.stream = () => value as ReadableStream;
+      } else {
+        const [streamForSize, streamForContent] = value.tee();
+
+        file.size = await this.getStreamSize(streamForSize);
+        file.stream = () => streamForContent as ReadableStream;
+      }
+
+      this.formData.append('file', file);
+    } else {
+      throw new Error('Invalid value'); // todo error handling
+    }
+  }
+
+  private async getStreamSize(stream: ReadableStream | ReadableNodeStream): Promise<number> {
+    let totalSize = 0;
+    const reader = stream.getReader();
+
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+    while (true) {
+      const { done, value } = await reader.read();
+      if (done) break;
+
+      if (value instanceof Uint8Array) {
+        totalSize += value.length;
+      } else if (typeof value === 'string') {
+        totalSize += new TextEncoder().encode(value).length;
+      } else if (value instanceof Blob) {
+        totalSize += value.size;
+      } else if (ArrayBuffer.isView(value) || value instanceof ArrayBuffer) {
+        totalSize += value.byteLength;
+      } else if (value === null || value === undefined) {
+        continue;
+      } else {
+        throw new Error(`Unsupported value type: ${typeof value}`);
+      }
+    }
+
+    return totalSize;
+  }
+}

src/services/formDataService/index.ts

@@ -0,0 +1 @@
+export * from './formDataService';

src/version2/parameters/addAttachment.ts

@@ -1,4 +1,4 @@
-import type { Readable } from 'node:stream';
+import type { ReadableStream as ReadableNodeStream } from 'node:stream/web';
 
 /**
  * Represents an attachment to be added to an issue.
@@ -13,6 +13,7 @@ import type { Readable } from 'node:stream';
  *   ```
  */
 export interface Attachment {
+  // todo JSDoc
   /**
    * The name of the attachment file.
    *
@@ -37,22 +38,20 @@ export interface Attachment {
    *   const fileContent = fs.readFileSync('./document.pdf');
    *   ```
    */
-  file: Buffer | ReadableStream | Readable | string | Blob | File;
+  content: ArrayBuffer | ReadableStream | ReadableNodeStream | string | Blob;
 
   /**
-   * Optional MIME type of the attachment. Example values include:
-   *
-   * - 'application/pdf'
-   * - 'image/png'
+   * Optional MIME type of the attachment.
    *
    * If not provided, the MIME type will be automatically detected based on the filename.
    *
    * @example
    *   ```typescript
-   *   const mimeType = 'application/pdf';
+   *   'application/pdf'
    *   ```
    */
-  mimeType?: string;
+  contentType?: string;
+  contentLength?: number; // todo JSDoc
 }
 
 /**
@@ -99,5 +98,5 @@ export interface AddAttachment {
    *   ];
    *   ```
    */
-  attachment: Attachment | Attachment[];
+  attachment: Attachment | Attachment[]; // todo JSDoc
 }