(chore): update readme

.fernignore

@@ -1 +1,5 @@
 # Specify files that shouldn't be modified by Fern
+
+src/Client.ts
+src/core/form-data-utils/FormDataWrapper.ts
+README.md

README.md

@@ -0,0 +1,132 @@
+# FileForge TypeScript Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://buildwithfern.com/)
+
+The FileForge TypeScript library provides convenient access to the FileForge API from JavaScript/TypeScript.
+
+## Documentation
+
+API reference documentation is available [here](https://fileforge.docs.buildwithfern.com/api-reference/pdf/converts-a-doc-or-docx-document-to-pdf).
+
+## Installation
+
+```bash
+npm install --save fileforge
+# or
+yarn add fileforge
+```
+
+## Usage
+
+```typescript
+import { FileForgeClient, FileForge } from 'guesty';
+import * as fs from "fs";
+
+const fileforge = new FileForgeClient({
+  apiKey: "...", 
+});
+
+await fileforge.generate({
+    files: [
+        fs.readStream("index.html"),
+    ],
+    options: {
+        fileName: "output.pdf"
+    }
+});
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), 
+a subclass of [FileForgeError](./src/errors/FileForgeError.ts) will be thrown:
+
+```ts
+import { FileForgeError } from 'fileforge';
+
+try {
+  await fileforge.generate(...);
+} catch (err) {
+  if (err instanceof FileForgeError) {
+    console.log(err.statusCode); 
+    console.log(err.message);
+    console.log(err.body); 
+  }
+}
+```
+
+## Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be
+retried as long as the request is deemed retriable and the number of retry attempts has not grown larger
+than the configured retry limit (default: 2).
+
+A request is deemed retriable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+
+Use the `maxRetries` request option to configure this behavior. 
+
+```ts
+const response = await fileforge.generate(..., {
+  maxRetries: 0 // override maxRetries at the request level
+});
+```
+
+## Timeouts
+
+The SDK defaults to a 60 second timout. Use the `timeoutInSeconds` option to 
+configure this behavior. 
+
+```ts
+const response = await fileforge.generate(..., {
+  timeoutInSeconds: 30 // override timeout to 30s
+});
+```
+
+## Runtime compatiblity
+
+The SDK defaults to `node-fetch` but will use the global fetch client if present. The SDK 
+works in the following runtimes: 
+
+The following runtimes are supported:
+
+- Node.js 18+ 
+- Vercel 
+- Cloudflare Workers
+- Deno v1.25+
+- Bun 1.0+
+- React Native
+
+### Customizing Fetch client
+
+The SDK provides a way for you to customize the underlying HTTP client / Fetch function. If you're 
+running in an unsupported environment, this provides a way for you to break the glass and 
+ensure the SDK works. 
+
+```ts
+import { FileForge } from 'fileforge';
+
+const guesty = new FileForge({
+  apiKey: "...",
+  fetcher: // provide your implementation here
+});
+```
+
+## Beta status
+
+This SDK is in beta, and there may be breaking changes between versions without a major version update. 
+Therefore, we recommend pinning the package version to a specific version in your package.json file. 
+This way, you can install the same version each time without breaking changes unless you are 
+intentionally looking for the latest version.
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically. 
+Additions made directly to this library would have to be moved over to our generation code, 
+otherwise they would be overwritten upon the next generated release. Feel free to open a 
+PR as a proof of concept, but know that we will not be able to merge it as-is. 
+
+We suggest [opening an issue](https://github.com/FlatFilers/flatfile-node/issues) first to discuss with us!

src/Client.ts

@@ -42,7 +42,7 @@ export class FileForgeClient {
         requestOptions?: FileForgeClient.RequestOptions
     ): Promise<stream.Readable> {
         const _request = new core.FormDataWrapper();
-        await _request.append("options", JSON.stringify(request.options));
+        await _request.append("options", JSON.stringify(request.options), { contentType: "application/json"});
         for (const _file of files) {
             await _request.append("files", _file);
         }

src/core/form-data-utils/FormDataWrapper.ts

@@ -1,7 +1,7 @@
 import { RUNTIME } from "../runtime";
 
 interface CrossPlatformFormData {
-    append(key: string, value: any): void;
+    append(key: string, value: any, options?: { contentType?: string }): void;
 }
 
 class FormDataRequestBody {
@@ -49,25 +49,55 @@ class FormDataRequestBody {
     }
 }
 
+export declare namespace FormDataWrapper {
+    interface AppendOptions {
+        contentType?: string;
+    }
+}
+
 /**
  * FormDataWrapper is a utility to make form data
  * requests across both Browser and Node.js runtimes.
  */
 export class FormDataWrapper {
     private fd: CrossPlatformFormData | undefined;
 
-    public async append(name: string, value: any): Promise<void> {
+    public async append(name: string, value: any, opts: FormDataWrapper.AppendOptions = {}): Promise<void> {
         if (this.fd == null) {
             if (RUNTIME.type === "node") {
-                this.fd = new (await import("formdata-node")).FormData();
+                const fdNode = new (await import("formdata-node")).FormData();
+                this.fd = new FormDataNodeWrapper(fdNode);
             } else {
                 this.fd = new (await import("form-data")).default();
             }
         }
-        this.fd.append(name, value);
+        this.fd.append(name, value, opts);
     }
 
     public getRequest(): FormDataRequestBody {
         return new FormDataRequestBody(this.fd);
     }
 }
+
+
+interface FormDataNode {
+    append(name: string, value: unknown, fileName?: string): void;
+}
+
+class FormDataNodeWrapper implements CrossPlatformFormData {
+
+    private fd: FormDataNode;
+
+    public constructor(fd: FormDataNode) {
+        this.fd = fd;
+    }
+
+    append(key: string, value: any, options: { contentType?: string | undefined; } = {}): void {
+        if (options.contentType == null) {
+            this.fd.append(key, value);
+        } else {
+            this.fd.append(key, new Blob([value], { type: options.contentType}))
+        }
+    }
+
+}