feat: load headers

hypermedia-app · Nov 17, 2021 · f6cf34c · f6cf34c
1 parent c311f3f
commit f6cf34c
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 5 deletions.
diff --git a/.changeset/gold-lions-cover.md b/.changeset/gold-lions-cover.md
@@ -0,0 +1,5 @@
+---
+"alcaeus": minor
+---
+
+Make it possible to override request headers from `Resource#load` method
diff --git a/src/Resources/CoreMixins/ResourceLoaderMixin.ts b/src/Resources/CoreMixins/ResourceLoaderMixin.ts
@@ -6,15 +6,15 @@ import type { HydraClient, HydraResponse } from '../../alcaeus'
 
 declare module '@tpluscode/rdfine' {
     export interface RdfResource<D extends DatasetCore = DatasetCore> {
-        load?<T extends RdfResource<D>>(): Promise<HydraResponse<D, T>>
+        load?<T extends RdfResource<D>>(headers?: HeadersInit): Promise<HydraResponse<D, T>>
     }
 }
 
 export function createResourceLoaderMixin(alcaeus: () => HydraClient<any>) {
     function ResourceLoaderMixin<Base extends Constructor>(base: Base) {
         return class extends base {
-            public load<T extends Resource<any>>() {
-                return alcaeus().loadResource<T>(this.id.value)
+            public load<T extends Resource<any>>(headers?: HeadersInit) {
+                return alcaeus().loadResource<T>(this.id.value, headers)
             }
         }
     }

diff --git a/tests/Resources/ResourceLoaderMixin-spec.ts b/tests/Resources/ResourceLoaderMixin-spec.ts
@@ -21,7 +21,7 @@ describe('ResourceLoaderMixin', () => {
     })
 
     describe('load', () => {
-        let alcaeus
+        let alcaeus: any
         let HydraResource: ReturnType<ReturnType<typeof createResourceLoaderMixin>>
 
         beforeEach(() => {
@@ -41,7 +41,24 @@ describe('ResourceLoaderMixin', () => {
             resource.load()
 
             // then
-            expect(alcaeus.loadResource.calledWithExactly('http://example.com/resource')).toBeTruthy()
+            expect(alcaeus.loadResource.calledWithMatch('http://example.com/resource')).toBeTruthy()
+        })
+
+        it('passes additional headers', () => {
+            // given
+            const node = cf({ dataset: $rdf.dataset() })
+                .namedNode('http://example.com/resource')
+            const resource = new HydraResource(node)
+
+            // when
+            resource.load({
+                Prefer: 'foo-bar: baz',
+            })
+
+            // then
+            expect(alcaeus.loadResource.calledWithMatch('http://example.com/resource', {
+                Prefer: 'foo-bar: baz',
+            })).toBeTruthy()
         })
     })
 })