@pikku/fetch 0.12.4 → 0.12.5

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.12.5
+
+### Patch Changes
+
+- 6f06813: Add `CorePikkuFetch.setHeader(name, value)` to set or clear an arbitrary request header (passing `null` removes it). Enables per-client headers such as admin impersonation (`x-pikku-impersonate-user-id`) without subclassing the fetch client.
+
 ## 0.12.4
 
 ### Patch Changes

package/dist/cjs/core-pikku-fetch.d.ts

@@ -27,6 +27,7 @@ export type CorePikkuFetchOptions = {
 export declare class CorePikkuFetch {
     private options;
     private authHeaders;
+    private extraHeaders;
     /**
      * Constructs a new instance of the `CorePikkuFetch` class.
      *
@@ -39,6 +40,7 @@ export declare class CorePikkuFetch {
      * @returns {Record<string, string>} - The headers for the request.
      */
     private getHeaders;
+    setHeader(name: string, value: string | null): void;
     /**
      * Sets the server URL for subsequent requests.
      *

package/dist/cjs/core-pikku-fetch.js

@@ -26,6 +26,7 @@ class CorePikkuFetch {
     constructor(options = {}) {
         this.options = options;
         this.authHeaders = {};
+        this.extraHeaders = {};
         this.authHeaders = options.authHeaders || {};
     }
     /**
@@ -34,9 +35,7 @@ class CorePikkuFetch {
      * @returns {Record<string, string>} - The headers for the request.
      */
     getHeaders() {
-        const headers = {
-            'Content-Type': 'application/json',
-        };
+        const headers = Object.assign({ 'Content-Type': 'application/json' }, this.extraHeaders);
         if (this.authHeaders.jwt) {
             headers.Authorization = `Bearer ${this.authHeaders.jwt}`;
         }
@@ -45,6 +44,14 @@ class CorePikkuFetch {
         }
         return headers;
     }
+    setHeader(name, value) {
+        if (value === null) {
+            delete this.extraHeaders[name];
+        }
+        else {
+            this.extraHeaders[name] = value;
+        }
+    }
     /**
      * Sets the server URL for subsequent requests.
      *

package/dist/esm/core-pikku-fetch.d.ts

@@ -27,6 +27,7 @@ export type CorePikkuFetchOptions = {
 export declare class CorePikkuFetch {
     private options;
     private authHeaders;
+    private extraHeaders;
     /**
      * Constructs a new instance of the `CorePikkuFetch` class.
      *
@@ -39,6 +40,7 @@ export declare class CorePikkuFetch {
      * @returns {Record<string, string>} - The headers for the request.
      */
     private getHeaders;
+    setHeader(name: string, value: string | null): void;
     /**
      * Sets the server URL for subsequent requests.
      *

package/dist/esm/core-pikku-fetch.js

@@ -8,6 +8,7 @@ import { corePikkuFetch } from './pikku-fetch.js';
 export class CorePikkuFetch {
     options;
     authHeaders = {};
+    extraHeaders = {};
     /**
      * Constructs a new instance of the `CorePikkuFetch` class.
      *
@@ -25,6 +26,7 @@ export class CorePikkuFetch {
     getHeaders() {
         const headers = {
             'Content-Type': 'application/json',
+            ...this.extraHeaders,
         };
         if (this.authHeaders.jwt) {
             headers.Authorization = `Bearer ${this.authHeaders.jwt}`;
@@ -34,6 +36,14 @@ export class CorePikkuFetch {
         }
         return headers;
     }
+    setHeader(name, value) {
+        if (value === null) {
+            delete this.extraHeaders[name];
+        }
+        else {
+            this.extraHeaders[name] = value;
+        }
+    }
     /**
      * Sets the server URL for subsequent requests.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pikku/fetch",
-  "version": "0.12.4",
+  "version": "0.12.5",
   "author": "yasser.fadl@gmail.com",
   "license": "MIT",
   "type": "module",

package/src/core-pikku-fetch.ts

@@ -32,6 +32,7 @@ export type CorePikkuFetchOptions = {
  */
 export class CorePikkuFetch {
   private authHeaders: AuthHeaders = {}
+  private extraHeaders: Record<string, string> = {}
 
   /**
    * Constructs a new instance of the `CorePikkuFetch` class.
@@ -50,6 +51,7 @@ export class CorePikkuFetch {
   private getHeaders(): Record<string, string> {
     const headers: Record<string, string> = {
       'Content-Type': 'application/json',
+      ...this.extraHeaders,
     }
     if (this.authHeaders.jwt) {
       headers.Authorization = `Bearer ${this.authHeaders.jwt}`
@@ -59,6 +61,14 @@ export class CorePikkuFetch {
     return headers
   }
 
+  public setHeader(name: string, value: string | null): void {
+    if (value === null) {
+      delete this.extraHeaders[name]
+    } else {
+      this.extraHeaders[name] = value
+    }
+  }
+
   /**
    * Sets the server URL for subsequent requests.
    *

package/src/index.test.ts

@@ -1,5 +1,5 @@
 import assert from 'node:assert/strict'
-import { describe, test } from 'node:test'
+import { describe, test, afterEach } from 'node:test'
 
 import { CorePikkuFetch, corePikkuFetch } from './index.js'
 
@@ -9,3 +9,46 @@ describe('@pikku/fetch', () => {
     assert.equal(typeof corePikkuFetch, 'function')
   })
 })
+
+describe('CorePikkuFetch.setHeader', () => {
+  const realFetch = globalThis.fetch
+  afterEach(() => {
+    globalThis.fetch = realFetch
+  })
+
+  const capture = () => {
+    const seen: { headers?: Record<string, string> } = {}
+    globalThis.fetch = (async (_input: any, init?: any) => {
+      seen.headers = (init?.headers ?? {}) as Record<string, string>
+      return new Response('{}', {
+        status: 200,
+        headers: { 'content-type': 'application/json' },
+      })
+    }) as typeof fetch
+    return seen
+  }
+
+  test('sends a set header on every request', async () => {
+    const seen = capture()
+    const client = new CorePikkuFetch({ serverUrl: 'https://api.test' })
+    client.setHeader('x-pikku-impersonate-user-id', 'u_guest')
+    await client.fetch('/anything', 'GET', undefined)
+    assert.equal(seen.headers?.['x-pikku-impersonate-user-id'], 'u_guest')
+  })
+
+  test('removes the header when set to null', async () => {
+    const seen = capture()
+    const client = new CorePikkuFetch({ serverUrl: 'https://api.test' })
+    client.setHeader('x-pikku-impersonate-user-id', 'u_guest')
+    client.setHeader('x-pikku-impersonate-user-id', null)
+    await client.fetch('/anything', 'GET', undefined)
+    assert.equal(seen.headers?.['x-pikku-impersonate-user-id'], undefined)
+  })
+
+  test('no header is sent by default (inherits the session)', async () => {
+    const seen = capture()
+    const client = new CorePikkuFetch({ serverUrl: 'https://api.test' })
+    await client.fetch('/anything', 'GET', undefined)
+    assert.equal(seen.headers?.['x-pikku-impersonate-user-id'], undefined)
+  })
+})