@hkdigital/lib-sveltekit 0.1.67 → 0.1.68

package/dist/util/http/http-request.d.ts

@@ -20,6 +20,8 @@
  *
  *   e.g. options.headers = { "content-type": "application/json" }
  *
+ * @param {boolean} [_.withCredentials=false]
+ *
  * @param {requestHandler} [_.requestHandler]
  *
  * @param {number} [_.timeoutMs]
@@ -28,10 +30,11 @@
  *
  * @returns {Promise<Response>} responsePromise
  */
-export function httpGet({ url, urlSearchParams, headers, requestHandler, timeoutMs }: {
+export function httpGet({ url, urlSearchParams, headers, withCredentials, requestHandler, timeoutMs }: {
     url: string | URL;
     urlSearchParams?: object;
     headers?: object;
+    withCredentials?: boolean;
     requestHandler?: requestHandler;
     timeoutMs?: number;
 }): Promise<Response>;
@@ -49,6 +52,8 @@ export function httpGet({ url, urlSearchParams, headers, requestHandler, timeout
  *
  *   e.g. options.headers = { "content-type": "application/json" }
  *
+ * @param {boolean} [_.withCredentials=false]
+ *
  * @param {requestHandler} [_.requestHandler]
  *
  * @param {number} [_.timeoutMs]
@@ -57,10 +62,11 @@ export function httpGet({ url, urlSearchParams, headers, requestHandler, timeout
  *
  * @returns {Promise<Response>} responsePromise
  */
-export function httpPost({ url, body, headers, requestHandler, timeoutMs }: {
+export function httpPost({ url, body, headers, withCredentials, requestHandler, timeoutMs }: {
     url: string | URL;
     body?: any;
     headers?: object;
+    withCredentials?: boolean;
     requestHandler?: requestHandler;
     timeoutMs?: number;
 }): Promise<Response>;
@@ -83,6 +89,11 @@ export function httpPost({ url, body, headers, requestHandler, timeoutMs }: {
  *   Object that contains custom headers. A header is a name, value pair.
  *
  *   e.g. options.headers = { "content-type": "application/json" }
+ *
+  * @param {boolean} [_.withCredentials=false]
+ *   Whether to include credentials (cookies, HTTP authentication, and client
+ *   SSL certificates) with cross-origin requests. When true, sets fetch
+ *   credentials to 'include', otherwise to 'omit'.
  *
  * @param {requestHandler} [_.requestHandler]
  *
@@ -97,12 +108,13 @@ export function httpPost({ url, body, headers, requestHandler, timeoutMs }: {
  *
  * @returns {Promise<Response>} responsePromise
  */
-export function httpRequest({ method, url, urlSearchParams, body, headers, requestHandler, timeoutMs }: {
+export function httpRequest({ method, url, urlSearchParams, body, headers, withCredentials, requestHandler, timeoutMs }: {
     url: string | URL;
     method: string;
     urlSearchParams?: object;
     body?: any;
     headers?: object;
+    withCredentials?: boolean;
     requestHandler?: requestHandler;
     timeoutMs?: number;
 }): Promise<Response>;

package/dist/util/http/http-request.js

@@ -34,6 +34,8 @@ import { waitForAndCheckResponse } from './response.js';
  *
  *   e.g. options.headers = { "content-type": "application/json" }
  *
+ * @param {boolean} [_.withCredentials=false]
+ *
  * @param {requestHandler} [_.requestHandler]
  *
  * @param {number} [_.timeoutMs]
@@ -46,6 +48,7 @@ export async function httpGet({
 	url,
 	urlSearchParams,
 	headers,
+	withCredentials,
 	requestHandler,
 	timeoutMs
 }) {
@@ -75,6 +78,8 @@ export async function httpGet({
  *
  *   e.g. options.headers = { "content-type": "application/json" }
  *
+ * @param {boolean} [_.withCredentials=false]
+ *
  * @param {requestHandler} [_.requestHandler]
  *
  * @param {number} [_.timeoutMs]
@@ -87,6 +92,7 @@ export async function httpPost({
 	url,
 	body = null,
 	headers,
+	withCredentials,
 	requestHandler,
 	timeoutMs
 }) {
@@ -95,6 +101,7 @@ export async function httpPost({
 		url,
 		body,
 		headers,
+		withCredentials,
 		requestHandler,
 		timeoutMs
 	});
@@ -123,6 +130,11 @@ export async function httpPost({
  *   Object that contains custom headers. A header is a name, value pair.
  *
  *   e.g. options.headers = { "content-type": "application/json" }
+ *
+  * @param {boolean} [_.withCredentials=false]
+ *   Whether to include credentials (cookies, HTTP authentication, and client
+ *   SSL certificates) with cross-origin requests. When true, sets fetch
+ *   credentials to 'include', otherwise to 'omit'.
  *
  * @param {requestHandler} [_.requestHandler]
  *
@@ -143,6 +155,7 @@ export async function httpRequest({
 	urlSearchParams = null,
 	body = null,
 	headers,
+	withCredentials,
 	requestHandler,
 	timeoutMs
 }) {
@@ -171,7 +184,7 @@ export async function httpRequest({
 	const init = {
 		mode: 'cors',
 		cache: 'no-cache',
-		credentials: 'omit',
+		credentials: withCredentials ? 'include': 'omit',
 		redirect: 'follow',
 		referrerPolicy: 'no-referrer',
 		headers: requestHeaders

package/dist/util/http/json-request.d.ts

@@ -13,15 +13,18 @@
  *   the header name and the header value.
  *   E.g. [ "content-type", "application/json" ]
  *
+ * @param {boolean} [_.withCredentials=false]
+ *
  * @throws ResponseError
  *   If a network error occurred or the response was not ok
  *
  * @returns {Promise<any>} parsed JSON data
  */
-export function jsonGet({ url, urlSearchParams, headers }: {
+export function jsonGet({ url, urlSearchParams, headers, withCredentials }: {
     url: string | URL;
     urlSearchParams?: object;
     headers?: [string, string][];
+    withCredentials?: boolean;
 }): Promise<any>;
 /**
  * Make a POST request to fetch JSON encoded data
@@ -45,14 +48,17 @@ export function jsonGet({ url, urlSearchParams, headers }: {
  *   the header name and the header value.
  *   E.g. [ "content-type", "application/json" ]
  *
+ * @param {boolean} [_.withCredentials=false]
+ *
  * @throws ResponseError
  *   If a network error occurred or the response was not ok
  *
  * @returns {Promise<any>} parsed JSON data
  */
-export function jsonPost({ url, body, urlSearchParams, headers }: {
+export function jsonPost({ url, body, urlSearchParams, headers, withCredentials }: {
     url: string | URL;
     body: any;
     urlSearchParams?: object;
     headers?: [string, string][];
+    withCredentials?: boolean;
 }): Promise<any>;

package/dist/util/http/json-request.js

@@ -27,12 +27,19 @@ const ACCEPT = 'accept';
  *   the header name and the header value.
  *   E.g. [ "content-type", "application/json" ]
  *
+ * @param {boolean} [_.withCredentials=false]
+ *
  * @throws ResponseError
  *   If a network error occurred or the response was not ok
  *
  * @returns {Promise<any>} parsed JSON data
  */
-export async function jsonGet({ url, urlSearchParams, headers }) {
+export async function jsonGet({
+	url,
+	urlSearchParams,
+	headers,
+	withCredentials
+}) {
 	url = toURL(url);
 
 	if (!headers) {
@@ -45,7 +52,8 @@ export async function jsonGet({ url, urlSearchParams, headers }) {
 		method: METHOD_GET,
 		url,
 		urlSearchParams,
-		headers
+		headers,
+		withCredentials
 	});
 
 	const response = await waitForAndCheckResponse(responsePromise, url);
@@ -60,13 +68,18 @@ export async function jsonGet({ url, urlSearchParams, headers }) {
 		//
 		parsedResponse = await response.json();
 	} catch (e) {
-		throw new ResponseError(`Failed to JSON decode server response from [${decodeURI(url.href)}]`, {
-			cause: e
-		});
+		throw new ResponseError(
+			`Failed to JSON decode server response from [${decodeURI(url.href)}]`,
+			{
+				cause: e
+			}
+		);
 	}
 
 	if (parsedResponse.error) {
-		throw new ResponseError(`Server returned response error message [${parsedResponse.error}]`);
+		throw new ResponseError(
+			`Server returned response error message [${parsedResponse.error}]`
+		);
 	}
 
 	return parsedResponse;
@@ -94,12 +107,20 @@ export async function jsonGet({ url, urlSearchParams, headers }) {
  *   the header name and the header value.
  *   E.g. [ "content-type", "application/json" ]
  *
+ * @param {boolean} [_.withCredentials=false]
+ *
  * @throws ResponseError
  *   If a network error occurred or the response was not ok
  *
  * @returns {Promise<any>} parsed JSON data
  */
-export async function jsonPost({ url, body, urlSearchParams, headers }) {
+export async function jsonPost({
+	url,
+	body,
+	urlSearchParams,
+	headers,
+	withCredentials
+}) {
 	url = toURL(url);
 
 	if (!headers) {
@@ -113,7 +134,13 @@ export async function jsonPost({ url, body, urlSearchParams, headers }) {
 	headers[ACCEPT] = APPLICATION_JSON;
 	headers[CONTENT_TYPE] = APPLICATION_JSON;
 
-	const responsePromise = httpRequest({ method: METHOD_POST, url, body, urlSearchParams, headers });
+	const responsePromise = httpRequest({
+		method: METHOD_POST,
+		url,
+		body,
+		urlSearchParams,
+		headers
+	});
 
 	const response = await waitForAndCheckResponse(responsePromise, url);
 
@@ -128,7 +155,9 @@ export async function jsonPost({ url, body, urlSearchParams, headers }) {
 		parsedResponse = await response.json();
 	} catch (e) {
 		// console.log( response );
-		throw new ResponseError(`Failed to JSON decode server response from [${decodeURI(url.href)}]`);
+		throw new ResponseError(
+			`Failed to JSON decode server response from [${decodeURI(url.href)}]`
+		);
 	}
 
 	if (parsedResponse.error) {
@@ -136,7 +165,9 @@ export async function jsonPost({ url, body, urlSearchParams, headers }) {
 		// @note this is API specific, but it's quite logical
 		//
 		//
-		throw new ResponseError(`Server returned response error message [${parsedResponse.error}]`);
+		throw new ResponseError(
+			`Server returned response error message [${parsedResponse.error}]`
+		);
 	}
 
 	return parsedResponse;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@hkdigital/lib-sveltekit",
-	"version": "0.1.67",
+	"version": "0.1.68",
 	"author": {
 		"name": "HKdigital",
 		"url": "https://hkdigital.nl"