feat(request): decode URL strings for better Code Samples (#224)

* chore(request): add support for cookies in request building

* test(buildHarRequest): add tests

* feat(request): decode URL strings for better Code Samples

Closes #223

* chore(request): add contentType to request

* test(buildHarRequest): add test for decoding percent-encoded spaces and Unicode characters

Author: enzonotario

src/lib/codeSamples/buildHarRequest.ts

@@ -6,7 +6,7 @@ export function buildHarRequest(
 ): HarRequest {
   const harRequest: HarRequest = {
     method: oaRequest.method.toUpperCase(),
-    url: oaRequest.url.toString(),
+    url: decodeURI(oaRequest.url.toString()),
     httpVersion: 'HTTP/1.1',
     headers: Object.entries(oaRequest.headers).map(([name, value]) => ({
       name: name.replace(/\b\w/g, letter => letter.toUpperCase()), // Convert to title case.

src/lib/codeSamples/buildRequest.ts

@@ -134,6 +134,7 @@ export function buildRequest({
   body = undefined,
   headers = undefined,
   variables = {},
+  cookies = {},
 }: Partial<OARequest>): OARequest {
   const resolvedVariables = setExamplesAsVariables(parameters, variables)
 
@@ -194,5 +195,7 @@ export function buildRequest({
     variables: resolvedVariables,
     headers: resolvedHeaders,
     query: resolvedQuery,
+    cookies,
+    contentType: resolvedHeaders['content-type'],
   })
 }

test/lib/buildRequest.test.ts

@@ -223,6 +223,31 @@ describe('buildRequest', () => {
   })
 })
 
+describe('cookies', () => {
+  it('builds request with cookies', () => {
+    const request = buildRequest({
+      path: '/users',
+      method: 'GET',
+      baseUrl: 'https://api.example.com',
+      parameters: [],
+      cookies: { session: 'abc123' },
+    })
+    expect(request.cookies.session).toBe('abc123')
+  })
+
+  it('builds request with multiple cookies', () => {
+    const request = buildRequest({
+      path: '/users',
+      method: 'GET',
+      baseUrl: 'https://api.example.com',
+      parameters: [],
+      cookies: { session: 'abc123', user: 'john' },
+    })
+    expect(request.cookies.session).toBe('abc123')
+    expect(request.cookies.user).toBe('john')
+  })
+})
+
 describe('update request', () => {
   it('updates request with new headers', () => {
     const request = buildRequest({
@@ -345,4 +370,21 @@ describe('update request', () => {
 
     expect(fixedRequest.query.search).toBeUndefined()
   })
+
+  it('updates request with new cookies', () => {
+    const request = buildRequest({
+      baseUrl: 'https://api.example.com',
+      path: '/resource',
+      method: 'GET',
+      cookies: { session: 'old-session' },
+    })
+
+    const fixedRequest = buildRequest({
+      ...request,
+      cookies: { session: 'new-session', user: 'john' },
+    })
+
+    expect(fixedRequest.cookies.session).toBe('new-session')
+    expect(fixedRequest.cookies.user).toBe('john')
+  })
 })