feat: dropping support for non-native FormData implementations

.eslintrc

@@ -20,7 +20,12 @@
 
     "unicorn/prefer-node-protocol": "error",
 
-    "vitest/require-hook": "off"
+    "vitest/require-hook": [
+      "error",
+      {
+        "allowedFunctionCalls": ["runCustomFixtures"]
+      }
+    ]
   },
   "overrides": [
     {

.github/dependabot.yml

@@ -1,7 +1,7 @@
 version: 2
 updates:
   - package-ecosystem: github-actions
-    directory: "/"
+    directory: '/'
     schedule:
       interval: monthly
     reviewers:
@@ -19,7 +19,7 @@ updates:
       prefix-development: chore(deps-dev)
 
   - package-ecosystem: npm
-    directory: "/"
+    directory: '/'
     schedule:
       interval: monthly
     open-pull-requests-limit: 10
@@ -40,4 +40,4 @@ updates:
       # stringify-objectis now an ESM package and can't be used here without a rewrite.
       - dependency-name: stringify-object
         versions:
-          - ">= 4"
+          - '>= 4'

.github/workflows/ci.yml

@@ -8,7 +8,6 @@ on:
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     strategy:
@@ -18,13 +17,13 @@ jobs:
           - 20
 
     steps:
-    - uses: actions/checkout@v4
+      - uses: actions/checkout@v4
 
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v3
-      with:
-        node-version: ${{ matrix.node-version }}
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
 
-    - run: npm ci
-    - run: npm run build
-    - run: npm test
+      - run: npm ci
+      - run: npm run build
+      - run: npm test

.github/workflows/codeql-analysis.yml

@@ -1,4 +1,4 @@
-name: "CodeQL"
+name: 'CodeQL'
 
 on:
   push:
@@ -20,16 +20,16 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        language: [ 'javascript' ]
+        language: ['javascript']
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v4
+      - name: Checkout repository
+        uses: actions/checkout@v4
 
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
-      with:
-        languages: ${{ matrix.language }}
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: ${{ matrix.language }}
 
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2

.github/workflows/integration-node.yml

@@ -4,11 +4,11 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+      - uses: actions/checkout@v4
 
-    - name: Run tests
-      run: docker-compose run integration_node
+      - name: Run tests
+        run: docker-compose run integration_node
 
-    - name: Cleanup
-      if: always()
-      run: docker-compose down
+      - name: Cleanup
+        if: always()
+        run: docker-compose down

.github/workflows/integration-php.yml

@@ -4,11 +4,11 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+      - uses: actions/checkout@v4
 
-    - name: Run tests
-      run: docker-compose run integration_php
+      - name: Run tests
+        run: docker-compose run integration_php
 
-    - name: Cleanup
-      if: always()
-      run: docker-compose down
+      - name: Cleanup
+        if: always()
+        run: docker-compose down

.github/workflows/integration-python.yml

@@ -4,11 +4,11 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+      - uses: actions/checkout@v4
 
-    - name: Run tests
-      run: docker-compose run integration_python
+      - name: Run tests
+        run: docker-compose run integration_python
 
-    - name: Cleanup
-      if: always()
-      run: docker-compose down
+      - name: Cleanup
+        if: always()
+        run: docker-compose down

.github/workflows/integration-shell.yml

@@ -4,11 +4,11 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+      - uses: actions/checkout@v4
 
-    - name: Run tests
-      run: docker-compose run integration_shell
+      - name: Run tests
+        run: docker-compose run integration_shell
 
-    - name: Cleanup
-      if: always()
-      run: docker-compose down
+      - name: Cleanup
+        if: always()
+        run: docker-compose down

.vscode/settings.json

@@ -1,4 +1,10 @@
 {
-  "files.insertFinalNewline": false, // controlled by the .editorconfig at root since we can't map vscode settings directly to files (see: https://github.com/microsoft/vscode/issues/35350)
-  "editor.defaultFormatter": "esbenp.prettier-vscode"
+  "editor.codeActionsOnSave": {
+    "source.fixAll": true
+  },
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+
+  // controlled by the .editorconfig at root since we can't map vscode settings directly to files
+  // https://github.com/microsoft/vscode/issues/35350
+  "files.insertFinalNewline": false
 }

README.md

@@ -39,7 +39,7 @@ Type: `object`
 
 Available options:
 
-* `harIsAlreadyEncoded` (`boolean`): In the event of you supplying a `source` HAR that already contains escaped data (query and cookie parameters)strings, this allows you to disable automatic encoding of those parameters to prevent them from being double-escaped.
+- `harIsAlreadyEncoded` (`boolean`): In the event of you supplying a `source` HAR that already contains escaped data (query and cookie parameters)strings, this allows you to disable automatic encoding of those parameters to prevent them from being double-escaped.
 
 ### convert(target [, options])
 
@@ -64,11 +64,11 @@ const snippet = new HTTPSnippet({
 });
 
 // generate Node.js: Native output
-console.log(snippet.convert('node'));
+console.log(await snippet.convert('node'));
 
 // generate Node.js: Native output, indent with tabs
 console.log(
-  snippet.convert('node', {
+  await snippet.convert('node', {
     indent: '\t',
   }),
 );
@@ -104,13 +104,13 @@ const snippet = new HTTPSnippet({
 
 // generate Shell: cURL output
 console.log(
-  snippet.convert('shell', 'curl', {
+  await snippet.convert('shell', 'curl', {
     indent: '\t',
   }),
 );
 
 // generate Node.js: Unirest output
-console.log(snippet.convert('node', 'unirest'));
+console.log(await snippet.convert('node', 'unirest'));
 ```
 
 ### addTarget(target)
@@ -155,32 +155,31 @@ For detailed information on each target, please review the [wiki](https://github
 
 There are some major differences between this library and the [httpsnippet](https://github.com/Kong/httpsnippet) upstream:
 
-* Includes a full integration test suite for a handful of clients and targets.
-* Does not ship with a CLI component.
-* Does not do any HAR schema validation. It's just assumed that the HAR you're supplying to the library is already valid.
-* The main `HTTPSnippet` export contains an `options` argument for an `harIsAlreadyEncoded` option for disabling [escaping](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent) of cookies and query strings in URLs.
-  * We added this because all HARs that we interact with already have this data escaped and this option prevents them from being double encoded, thus corrupting the data.
-* Does not support the `insecureSkipVerify` option on `go:native`, `node:native`, `ruby:native`, and `shell:curl` as we don't want snippets generated for our users to bypass SSL certificate verification.
-* Node
-  * `fetch`
-    * Body payloads are treated as an object literal and wrapped within `JSON.stringify()`. We do this to keep those targets looking nicer with those kinds of payloads. This also applies to the JS `fetch` target as well.
-  * `request`
-    * Does not provide query string parameters in a `params` argument due to complexities with query encoding.
-* PHP
-  * `guzzle`
-    * Snippets have `require_once('vendor/autoload.php');` prefixed at the top.
-* Python
-  * `python3`
-    * Does not ship this client due to its incompatibility with being able to support file uploads.
-  * `requests`
-    * Does not provide query string parameters in a `params` argument due to complexities with query encoding.
+- Includes a full integration test suite for a handful of clients and targets.
+- Does not ship with a CLI component.
+- Does not do any HAR schema validation. It's just assumed that the HAR you're supplying to the library is already valid.
+- The main `HTTPSnippet` export contains an `options` argument for an `harIsAlreadyEncoded` option for disabling [escaping](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent) of cookies and query strings in URLs.
+  - We added this because all HARs that we interact with already have this data escaped and this option prevents them from being double encoded, thus corrupting the data.
+- Does not support the `insecureSkipVerify` option on `go:native`, `node:native`, `ruby:native`, and `shell:curl` as we don't want snippets generated for our users to bypass SSL certificate verification.
+- Node
+  - `fetch`
+    - Body payloads are treated as an object literal and wrapped within `JSON.stringify()`. We do this to keep those targets looking nicer with those kinds of payloads. This also applies to the JS `fetch` target as well.
+  - `request`
+    - Does not provide query string parameters in a `params` argument due to complexities with query encoding.
+- PHP
+  - `guzzle`
+    - Snippets have `require_once('vendor/autoload.php');` prefixed at the top.
+- Python
+  - `python3`
+    - Does not ship this client due to its incompatibility with being able to support file uploads.
+  - `requests`
+    - Does not provide query string parameters in a `params` argument due to complexities with query encoding.
 
 ## License
 
 [MIT](LICENSE) © [Kong](https://konghq.com)
 
 [license-url]: https://github.com/Kong/httpsnippet/blob/master/LICENSE
-
 [npm-url]: https://www.npmjs.com/package/@readme/httpsnippet
 [npm-license]: https://img.shields.io/npm/l/@readme/httpsnippet.svg?style=flat-square
 [npm-version]: https://img.shields.io/npm/v/@readme/httpsnippet.svg?style=flat-square