Add unsafeNewRequest(unknown): unknown

* Add `unsafeNewRequest(unknown)` to allow for unsafe requests for TF
* The request object is passed directly to TF. No parsing is performed

Signed-off-by: Petr "Stone" Hracek <[email protected]>
Co-authored-by: Jan Macku <[email protected]>

README.md

@@ -50,6 +50,7 @@ const request = { /* https://api.dev.testing-farm.io/redoc#operation/request_a_n
 
 const response: NewRequestResponse = await api.newRequest(request);
 const response: unknown = await api.newRequest(request, false);
+const response: unknown = await api.unsafeNewRequest(request /* unknown type */);
 ```
 
 ### Test Request Details

src/index.ts

@@ -78,6 +78,10 @@ export default class TestingFarmAPI {
     );
   }
 
+  async unsafeNewRequest(request: unknown): Promise<unknown> {
+    return await this.link.post('requests', request);
+  }
+
   async requestDetails(requestId: string): Promise<Request>;
   async requestDetails(requestId: string, strict: boolean): Promise<unknown>;
   async requestDetails(requestId: string, strict?: boolean): Promise<unknown> {

test/integration/new-request.test.ts

@@ -22,4 +22,21 @@ describe('Test Testing Farm POST /requests', () => {
       `[Error: {"message":"Test section is empty or test type is wrong."}]`
     );
   });
+  test('unsafe request', async () => {
+    const api = new TestingFarmAPI('https://api.dev.testing-farm.io/v0.1');
+
+    const response = api.unsafeNewRequest({
+      api_key: 'api_key',
+      test: {},
+      environments: [
+        {
+          hardware: '{"something":"foobar"}',
+        },
+      ],
+    });
+
+    await expect(response).rejects.toThrowErrorMatchingInlineSnapshot(
+      `[Error: {"message":"Test section is empty or test type is wrong."}]`
+    );
+  });
 });