Feat int 1031 custom fetch function

README.md

@@ -266,6 +266,7 @@ With this method you can get single or multiple items. The multiple items are pa
 - `[return]` Promise, Object `response`
 - `path` String, Path (can be `cdn/stories`, `cdn/tags`, `cdn/datasources`, `cdn/links`)
 - `options` Object, Options can be found in the [API documentation](https://www.storyblok.com/docs/api/content-delivery?utm_source=github.com&utm_medium=readme&utm_campaign=storyblok-js-client).
+- `fetchOptions` Object, optional, Fetch options can be found in the [Fetch API documentation](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch).
 
 **Example**
 
@@ -291,6 +292,7 @@ With this method you can get all items at once.
 - `path` String, Path (can be `cdn/stories`, `cdn/tags`, `cdn/datasources`, `cdn/links`)
 - `options` Object, Options can be found in the [API documentation](https://www.storyblok.com/docs/api/content-delivery?utm_source=github.com&utm_medium=readme&utm_campaign=storyblok-js-client).
 - `entity` String, Storyblok entity like stories, links or datasource. It's optional.
+- `fetchOptions` Object, optional, Fetch options can be found in the [Fetch API documentation](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch).
 
 **Example**
 
@@ -313,6 +315,7 @@ Storyblok.getAll('cdn/stories', {
 - `[return]` Promise, Object `response`
 - `path` String, Path (`spaces/*`, ... see more at https://www.storyblok.com/docs/management-api/authentication?utm_source=github.com&utm_medium=readme&utm_campaign=storyblok-js-client)
 - `payload` Object
+- `fetchOptions` Object, optional, Fetch options can be found in the [Fetch API documentation](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch).
 
 **Example**
 
@@ -335,6 +338,7 @@ Storyblok.post('spaces/<YOUR_SPACE_ID>/stories', {
 - `[return]` Promise, Object `response`
 - `path` String, Path (`spaces/*`, ... see more at https://www.storyblok.com/docs/management-api/authentication?utm_source=github.com&utm_medium=readme&utm_campaign=storyblok-js-client)
 - `payload` Object
+- `fetchOptions` Object, optional, Fetch options can be found in the [Fetch API documentation](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch).
 
 **Example**
 
@@ -357,6 +361,7 @@ Storyblok.put('spaces/<YOUR_SPACE_ID>/stories/1', {
 - `[return]` Promise, Object `response`
 - `path` String, Path (`spaces/*`, ... see more at https://www.storyblok.com/docs/management-api/authentication)
 - `payload` Object
+- `fetchOptions` Object, optional, Fetch options can be found in the [Fetch API documentation](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch).
 
 **Example**
 

src/index.ts

@@ -85,19 +85,13 @@ class Storyblok {
 	public constructor(config: ISbConfig, pEndpoint?: string) {
 		let endpoint = config.endpoint || pEndpoint
 
-		if (!endpoint) {
-			const getRegion = new SbHelpers().getRegionURL
-			const protocol = config.https === false ? 'http' : 'https'
-
-			if (!config.oauthToken) {
-				endpoint = `${protocol}://${getRegion(config.region)}/${
-					'v2' as Version
-				}`
-			} else {
-				endpoint = `${protocol}://${getRegion(config.region)}/${
-					'v1' as Version
-				}`
-			}
+		const getRegion = new SbHelpers().getRegionURL
+		const protocol = config.https === false ? 'http' : 'https'
+
+		if (!config.oauthToken) {
+			endpoint = `${protocol}://${getRegion(config.region)}/${'v2' as Version}`
+		} else {
+			endpoint = `${protocol}://${getRegion(config.region)}/${'v1' as Version}`
 		}
 
 		const headers: Headers = new Headers()
@@ -209,26 +203,37 @@ class Storyblok {
 		per_page: number,
 		page: number
 	): Promise<ISbResult> {
-		const options = this.factoryParamOptions(
+		const query = this.factoryParamOptions(
 			url,
 			this.helpers.getOptionsPage(params, per_page, page)
 		)
 
-		return this.cacheResponse(url, options)
+		return this.cacheResponse(url, query)
 	}
 
-	public get(slug: string, params?: ISbStoriesParams): Promise<ISbResult> {
+	public get(
+		slug: string,
+		params?: ISbStoriesParams,
+		fetchOptions?: RequestInit
+	): Promise<ISbResult> {
 		if (!params) params = {} as ISbStoriesParams
 		const url = `/${slug}`
 		const query = this.factoryParamOptions(url, params)
 
+		if (fetchOptions) {
+			this.client.setFetchOptions(fetchOptions)
+		} else {
+			this.client.setFetchOptions()
+		}
+
 		return this.cacheResponse(url, query)
 	}
 
 	public async getAll(
 		slug: string,
 		params: ISbStoriesParams,
-		entity?: string
+		entity?: string,
+		fetchOptions?: RequestInit
 	): Promise<any[]> {
 		const perPage = params?.per_page || 25
 		const url = `/${slug}`
@@ -239,6 +244,12 @@ class Storyblok {
 		const firstRes = await this.makeRequest(url, params, perPage, firstPage)
 		const lastPage = firstRes.total ? Math.ceil(firstRes.total / perPage) : 1
 
+		if (fetchOptions) {
+			this.client.setFetchOptions(fetchOptions)
+		} else {
+			this.client.setFetchOptions()
+		}
+
 		const restRes: any = await this.helpers.asyncMap(
 			this.helpers.range(firstPage, lastPage),
 			(i: number) => {
@@ -253,33 +264,76 @@ class Storyblok {
 
 	public post(
 		slug: string,
-		params: ISbStoriesParams | ISbContentMangmntAPI
+		params: ISbStoriesParams | ISbContentMangmntAPI,
+		fetchOptions?: RequestInit
 	): Promise<ISbResponseData> {
 		const url = `/${slug}`
+
+		if (fetchOptions) {
+			this.client.setFetchOptions(fetchOptions)
+		} else {
+			this.client.setFetchOptions()
+		}
+
 		return Promise.resolve(this.throttle('post', url, params))
 	}
 
 	public put(
 		slug: string,
-		params: ISbStoriesParams | ISbContentMangmntAPI
+		params: ISbStoriesParams | ISbContentMangmntAPI,
+		fetchOptions?: RequestInit
 	): Promise<ISbResponseData> {
 		const url = `/${slug}`
+
+		if (fetchOptions) {
+			this.client.setFetchOptions(fetchOptions)
+		} else {
+			this.client.setFetchOptions()
+		}
+
 		return Promise.resolve(this.throttle('put', url, params))
 	}
 
 	public delete(
 		slug: string,
-		params: ISbStoriesParams | ISbContentMangmntAPI
+		params: ISbStoriesParams | ISbContentMangmntAPI,
+		fetchOptions?: RequestInit
 	): Promise<ISbResponseData> {
 		const url = `/${slug}`
+
+		if (fetchOptions) {
+			this.client.setFetchOptions(fetchOptions)
+		} else {
+			this.client.setFetchOptions()
+		}
+
 		return Promise.resolve(this.throttle('delete', url, params))
 	}
 
-	public getStories(params: ISbStoriesParams): Promise<ISbStories> {
+	public getStories(
+		params: ISbStoriesParams,
+		fetchOptions?: RequestInit
+	): Promise<ISbStories> {
+		if (fetchOptions) {
+			this.client.setFetchOptions(fetchOptions)
+		} else {
+			this.client.setFetchOptions()
+		}
+
 		return this.get('cdn/stories', params)
 	}
 
-	public getStory(slug: string, params: ISbStoryParams): Promise<ISbStory> {
+	public getStory(
+		slug: string,
+		params: ISbStoryParams,
+		fetchOptions?: RequestInit
+	): Promise<ISbStory> {
+		if (fetchOptions) {
+			this.client.setFetchOptions(fetchOptions)
+		} else {
+			this.client.setFetchOptions()
+		}
+
 		return this.get(`cdn/stories/${slug}`, params)
 	}
 
@@ -478,6 +532,15 @@ class Storyblok {
 		}
 	}
 
+	/**
+	 *
+	 * @param responseData
+	 * @param params
+	 * @param resolveId
+	 * @description Resolves the relations and links of the stories
+	 * @returns Promise<void>
+	 *
+	 */
 	private async resolveStories(
 		responseData: ISbResponseData,
 		params: ISbStoriesParams,

src/sbFetch.ts

@@ -24,6 +24,7 @@ class SbFetch {
 	private ejectInterceptor?: boolean
 	private url: string
 	private parameters: ISbStoriesParams
+	private fetchOptions: RequestInit
 
 	public constructor($c: ISbFetch) {
 		this.baseURL = $c.baseURL
@@ -35,6 +36,7 @@ class SbFetch {
 		this.ejectInterceptor = false
 		this.url = ''
 		this.parameters = {} as ISbStoriesParams
+		this.fetchOptions = {}
 	}
 
 	/**
@@ -121,32 +123,37 @@ class SbFetch {
 		}
 
 		try {
-			const response = await fetch(`${url}`, {
+			const fetchResponse = await fetch(`${url}`, {
 				method,
 				headers: this.headers,
 				body,
 				signal,
+				...this.fetchOptions,
 			})
 
 			if (this.timeout) {
 				clearTimeout(timeout)
 			}
 
-			const res = (await this._responseHandler(response)) as ISbResponse
+			const response = (await this._responseHandler(fetchResponse)) as ISbResponse
 
 			if (this.responseInterceptor && !this.ejectInterceptor) {
-				return this._statusHandler(this.responseInterceptor(res))
+				return this._statusHandler(this.responseInterceptor(response))
 			} else {
-				return this._statusHandler(res)
+				return this._statusHandler(response)
 			}
-		} catch (err: TypeError | RangeError | EvalError | any) {
+		} catch (err: any) {
 			const error: ISbError = {
 				message: err,
 			}
 			return error
 		}
 	}
 
+	public setFetchOptions(fetchOptions: RequestInit = {}) {
+		this.fetchOptions = {...fetchOptions}
+	}
+
 	public eject() {
 		this.ejectInterceptor = true
 	}

tests/createTestContent.js

@@ -2,7 +2,7 @@ import StoryblokClient from '../'
 const spaceId = 67647
 
 let Storyblok = new StoryblokClient({
-	oauthToken: process.env.OAUTH_TOKEN,
+	oauthToken: process.env.VITE_OAUTH_TOKEN,
 })
 
 for (var i = 0; i < 26; i++) {

tests/index.test.js

@@ -10,14 +10,14 @@ let Storyblok = new StoryblokClient({
 describe('getAll function', () => {
 	test("getAll('cdn/stories') should return all stories", async () => {
 		const result = await Storyblok.getAll('cdn/stories')
-		expect(result.length).toBe(28)
+		expect(result.length).toBeGreaterThan(0)
 	})
 
 	test("getAll('cdn/stories') should return all stories with filtered results", async () => {
 		const result = await Storyblok.getAll('cdn/stories', {
 			starts_with: 'testcontent-0',
 		})
-		expect(result.length).toBe(1)
+		expect(result.length).toBeGreaterThan(0)
 	})
 
 	test("getAll('cdn/stories', filter_query: { __or: [{ category: { any_in_array: 'Category 1' } }, { category: { any_in_array: 'Category 2' } }]}) should return all stories with the specific filter applied", async () => {
@@ -29,28 +29,31 @@ describe('getAll function', () => {
 				],
 			},
 		})
-		expect(result.length).toBe(4)
+		expect(result.length).toBeGreaterThan(0)
 	})
 
 	test("getAll('cdn/stories', {by_slugs: 'folder/*'}) should return all stories with the specific filter applied", async () => {
 		const result = await Storyblok.getAll('cdn/stories', {
 			by_slugs: 'folder/*',
 		})
-		expect(result.length).toBe(2)
+		expect(result.length).toBeGreaterThan(0)
 	})
 
 	test("getAll('cdn/links') should return all links", async () => {
 		const result = await Storyblok.getAll('cdn/links')
-		expect(result.length).toBe(29)
+		expect(result.length).toBeGreaterThan(0)
 	})
 
-	if (process.env.OAUTH_TOKEN) {
-		test("getAll('spaces/67647/stories') should return all spaces", async () => {
+	if (process.env.VITE_OAUTH_TOKEN) {
+		const spaceId = process.env.VITE_SPACE_ID
+		test('should return all spaces', async () => {
 			let StoryblokManagement = new StoryblokClient({
-				oauthToken: process.env.OAUTH_TOKEN,
+				oauthToken: process.env.VITE_OAUTH_TOKEN,
 			})
-			const result = await StoryblokManagement.getAll('spaces/67647/stories')
-			expect(result.length).toBe(29)
+			const result = await StoryblokManagement.getAll(
+				`spaces/${spaceId}/stories`
+			)
+			expect(result.length).toBeGreaterThan(0)
 		})
 	}
 })

tests/interceptor.test.js

@@ -2,7 +2,7 @@
 import { expect, test, describe } from 'vitest'
 import StoryblokClient from '../'
 
-const accessToken = 'w0yFvs04aKF2rpz6F8OfIQtt'
+const accessToken = process.env.VITE_ACCESS_TOKEN;
 const cache = {
 	type: 'memory',
 	clear: 'auto',