@hkdigital/lib-sveltekit 0.2.19 → 0.2.21

package/dist/util/http/errors.js

@@ -1,97 +1,97 @@
-import * as expect from '../expect/index.js';
-
-import { CONTENT_TYPE } from '../../constants/http/index.js';
-
-import { APPLICATION_JSON } from '../../constants/mime/index.js';
-
-/**
- * Try to get error information from the server error response
- *
- * This method tries to get error info from JSON responses. The
- * error info may be set as one of the following properties
- *
- * - message
- * - error
- * - messages (array)
- * - errors (array)
- *
- * Otherwise tris method will use the plain text response
- *
- * @param {object} response
- *
- * @returns {Error} error
- */
-export async function getErrorFromResponse(response) {
-	expect.object(response);
-
-	let message;
-	let details = null;
-
-	const headers = response.headers;
-	const contentType = headers.get(CONTENT_TYPE);
-
-	let content;
-
-	if (contentType === APPLICATION_JSON) {
-		content = await response.json();
-
-		if (content instanceof Object) {
-			if (typeof content.message === 'string') {
-				// Use string propery 'message' as error message
-				message = content.message;
-			} else if (typeof content.error === 'string') {
-				// Use string propery 'error' as error message
-				message = content.error;
-			} else {
-				if (Array.isArray(content.errors)) {
-					// Use array propery 'errors' for error messages
-
-					details = content.errors;
-				} else if (Array.isArray(content.messages)) {
-					// Use array propery 'messages' for error messages
-
-					details = content.messages;
-				}
-
-				if (details) {
-					// Multiple error messages (array) =>
-					//   create string respresentation by combining
-					//   text parts from all error messages
-					const tmp = [];
-
-					for (const current of details) {
-						if (typeof current === 'string') {
-							// Error is a string
-							tmp.push(current);
-						} else if (current instanceof Object && typeof current.message === 'string') {
-							// Error is an object with string property 'message'
-							tmp.push(current.message);
-						} else {
-							// JSON stringify everything else
-							tmp.push(JSON.stringify(current));
-						}
-					} // end for
-
-					message = tmp.join(', ');
-				}
-			}
-		}
-	} else {
-		const tmp = await response.text();
-
-		if (tmp.length) {
-			message = tmp;
-		} else {
-			message = response.statusText;
-		}
-	}
-	// console.log( "message", message );
-
-	const error = new Error(message);
-
-	if (details) {
-		error.details = details;
-	}
-
-	return error;
-}
+import * as expect from '../expect/index.js';
+
+import { CONTENT_TYPE } from '../../constants/http/index.js';
+
+import { APPLICATION_JSON } from '../../constants/mime/index.js';
+
+/**
+ * Try to get error information from the server error response
+ *
+ * This method tries to get error info from JSON responses. The
+ * error info may be set as one of the following properties
+ *
+ * - message
+ * - error
+ * - messages (array)
+ * - errors (array)
+ *
+ * Otherwise tris method will use the plain text response
+ *
+ * @param {object} response
+ *
+ * @returns {Error} error
+ */
+export async function getErrorFromResponse(response) {
+	expect.object(response);
+
+	let message;
+	let details = null;
+
+	const headers = response.headers;
+	const contentType = headers.get(CONTENT_TYPE);
+
+	let content;
+
+	if (contentType === APPLICATION_JSON) {
+		content = await response.json();
+
+		if (content instanceof Object) {
+			if (typeof content.message === 'string') {
+				// Use string propery 'message' as error message
+				message = content.message;
+			} else if (typeof content.error === 'string') {
+				// Use string propery 'error' as error message
+				message = content.error;
+			} else {
+				if (Array.isArray(content.errors)) {
+					// Use array propery 'errors' for error messages
+
+					details = content.errors;
+				} else if (Array.isArray(content.messages)) {
+					// Use array propery 'messages' for error messages
+
+					details = content.messages;
+				}
+
+				if (details) {
+					// Multiple error messages (array) =>
+					//   create string respresentation by combining
+					//   text parts from all error messages
+					const tmp = [];
+
+					for (const current of details) {
+						if (typeof current === 'string') {
+							// Error is a string
+							tmp.push(current);
+						} else if (current instanceof Object && typeof current.message === 'string') {
+							// Error is an object with string property 'message'
+							tmp.push(current.message);
+						} else {
+							// JSON stringify everything else
+							tmp.push(JSON.stringify(current));
+						}
+					} // end for
+
+					message = tmp.join(', ');
+				}
+			}
+		}
+	} else {
+		const tmp = await response.text();
+
+		if (tmp.length) {
+			message = tmp;
+		} else {
+			message = response.statusText;
+		}
+	}
+	// console.log( "message", message );
+
+	const error = new Error(message);
+
+	if (details) {
+		error.details = details;
+	}
+
+	return error;
+}

package/dist/util/http/headers.js

@@ -1,75 +1,75 @@
-import * as expect from '../expect/index.js';
-
-/**
- * Set headers in an existing `Headers` object
- *
- * This function adds or updates headers in an existing Headers object.
- * Existing headers with the same name will be overwritten.
- * The supplied `Headers` object will be updated in place.
- *
- * @param {Headers} target
- *   Headers object to set the extra headers in
- *
- * @param {null|object|[string, string][]} [pairs]
- *   Headers to add, can be null, an object of name-value pairs,
- *   or an array of [name, value] pairs
- *
- * @throws {Error} If target is not a Headers object
- * @throws {Error} If pairs is a Headers object
- * @throws {Error} If pairs is not null, object, or array
- * @throws {Error} If any header name or value is empty
- *
- * @example
- * // Add headers from an object
- * const headers = new Headers();
- * setRequestHeaders(headers, {
- *   'content-type': 'application/json',
- *   'accept': 'application/json'
- * });
- *
- * @example
- * // Add headers from an array of pairs
- * const headers = new Headers();
- * setRequestHeaders(headers, [
- *   ['content-type', 'application/json'],
- *   ['authorization', 'Bearer token123']
- * ]);
- *
- * @example
- * // Passing null is valid and does nothing
- * setRequestHeaders(headers, null);
- */
-export function setRequestHeaders(target, pairs) {
-  if (!(target instanceof Headers)) {
-    throw new Error('Invalid parameter [target] (expected Headers object)');
-  }
-
-  // expect.objectNoArray(pairs);
-
-  if (pairs instanceof Headers) {
-    throw new Error(
-    	'Invalid parameter [pairs] (should not be a Headers object)');
-  }
-
-  if (!pairs) {
-    return;
-  }
-
-  if (typeof pairs !== 'object') {
-    throw new Error('Invalid value for parameter [pairs]');
-  }
-
-  if (!Array.isArray(pairs)) {
-    pairs = Object.entries(pairs);
-  }
-
-  for (const [name, value] of pairs) {
-    expect.notEmptyString(name);
-    expect.notEmptyString(value);
-
-    // @note Headers should be encoded lowercase in HTTP2
-    const nameLower = name.toLowerCase();
-
-    target.set(nameLower, value); /* overwrites existing value */
-  }
-}
+import * as expect from '../expect/index.js';
+
+/**
+ * Set headers in an existing `Headers` object
+ *
+ * This function adds or updates headers in an existing Headers object.
+ * Existing headers with the same name will be overwritten.
+ * The supplied `Headers` object will be updated in place.
+ *
+ * @param {Headers} target
+ *   Headers object to set the extra headers in
+ *
+ * @param {null|object|[string, string][]} [pairs]
+ *   Headers to add, can be null, an object of name-value pairs,
+ *   or an array of [name, value] pairs
+ *
+ * @throws {Error} If target is not a Headers object
+ * @throws {Error} If pairs is a Headers object
+ * @throws {Error} If pairs is not null, object, or array
+ * @throws {Error} If any header name or value is empty
+ *
+ * @example
+ * // Add headers from an object
+ * const headers = new Headers();
+ * setRequestHeaders(headers, {
+ *   'content-type': 'application/json',
+ *   'accept': 'application/json'
+ * });
+ *
+ * @example
+ * // Add headers from an array of pairs
+ * const headers = new Headers();
+ * setRequestHeaders(headers, [
+ *   ['content-type', 'application/json'],
+ *   ['authorization', 'Bearer token123']
+ * ]);
+ *
+ * @example
+ * // Passing null is valid and does nothing
+ * setRequestHeaders(headers, null);
+ */
+export function setRequestHeaders(target, pairs) {
+  if (!(target instanceof Headers)) {
+    throw new Error('Invalid parameter [target] (expected Headers object)');
+  }
+
+  // expect.objectNoArray(pairs);
+
+  if (pairs instanceof Headers) {
+    throw new Error(
+    	'Invalid parameter [pairs] (should not be a Headers object)');
+  }
+
+  if (!pairs) {
+    return;
+  }
+
+  if (typeof pairs !== 'object') {
+    throw new Error('Invalid value for parameter [pairs]');
+  }
+
+  if (!Array.isArray(pairs)) {
+    pairs = Object.entries(pairs);
+  }
+
+  for (const [name, value] of pairs) {
+    expect.notEmptyString(name);
+    expect.notEmptyString(value);
+
+    // @note Headers should be encoded lowercase in HTTP2
+    const nameLower = name.toLowerCase();
+
+    target.set(nameLower, value); /* overwrites existing value */
+  }
+}

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

@@ -62,6 +62,170 @@ export function httpGet(options: import("./typedef").HttpRequestOptions): Promis
  * });
  */
 export function httpPost(options: import("./typedef").HttpRequestOptions): Promise<Response>;
+/**
+ * Make a PUT request
+ *
+ * This function performs an HTTP PUT request, typically used for updating
+ * or replacing resources. It supports optional body, headers, credentials,
+ * and timeout functionality.
+ *
+ * @param {import('./typedef').HttpRequestOptions} options
+ *   Request configuration options
+ *
+ * @returns {Promise<Response>} Response promise
+ *
+ * @example
+ * // Update a user resource
+ * const response = await httpPut({
+ *   url: 'https://api.example.com/users/123',
+ *   body: JSON.stringify({ name: 'John Doe', email: 'john.doe@example.com' }),
+ *   headers: { 'content-type': 'application/json' }
+ * });
+ *
+ * @example
+ * // Replace a resource with timeout
+ * const response = await httpPut({
+ *   url: 'https://api.example.com/documents/456',
+ *   body: documentData,
+ *   timeoutMs: 10000 // 10 seconds timeout
+ * });
+ */
+export function httpPut(options: import("./typedef").HttpRequestOptions): Promise<Response>;
+/**
+ * Make a DELETE request
+ *
+ * This function performs an HTTP DELETE request, typically used for
+ * removing resources. It supports optional headers, credentials,
+ * and timeout functionality.
+ *
+ * @param {import('./typedef').HttpRequestOptions} options
+ *   Request configuration options
+ *
+ * @returns {Promise<Response>} Response promise
+ *
+ * @example
+ * // Delete a user resource
+ * const response = await httpDelete({
+ *   url: 'https://api.example.com/users/123'
+ * });
+ *
+ * @example
+ * // Delete with authorization and timeout
+ * const response = await httpDelete({
+ *   url: 'https://api.example.com/posts/456',
+ *   headers: { 'authorization': 'Bearer token123' },
+ *   timeoutMs: 5000
+ * });
+ */
+export function httpDelete(options: import("./typedef").HttpRequestOptions): Promise<Response>;
+/**
+ * Make a PATCH request
+ *
+ * This function performs an HTTP PATCH request, typically used for
+ * partial updates to resources. It supports optional body, headers,
+ * credentials, and timeout functionality.
+ *
+ * @param {import('./typedef').HttpRequestOptions} options
+ *   Request configuration options
+ *
+ * @returns {Promise<Response>} Response promise
+ *
+ * @example
+ * // Partially update a user's email
+ * const response = await httpPatch({
+ *   url: 'https://api.example.com/users/123',
+ *   body: JSON.stringify({ email: 'newemail@example.com' }),
+ *   headers: { 'content-type': 'application/json' }
+ * });
+ *
+ * @example
+ * // Apply JSON Patch operations
+ * const response = await httpPatch({
+ *   url: 'https://api.example.com/documents/456',
+ *   body: JSON.stringify([
+ *     { op: 'replace', path: '/title', value: 'New Title' },
+ *     { op: 'add', path: '/tags/-', value: 'updated' }
+ *   ]),
+ *   headers: { 'content-type': 'application/json-patch+json' }
+ * });
+ */
+export function httpPatch(options: import("./typedef").HttpRequestOptions): Promise<Response>;
+/**
+ * Make an OPTIONS request
+ *
+ * This function performs an HTTP OPTIONS request, typically used for
+ * discovering allowed methods on a resource or for CORS preflight requests.
+ * It supports optional headers, credentials, and timeout functionality.
+ *
+ * @param {import('./typedef').HttpRequestOptions} options
+ *   Request configuration options
+ *
+ * @returns {Promise<Response>} Response promise
+ *
+ * @example
+ * // Check allowed methods on a resource
+ * const response = await httpOptions({
+ *   url: 'https://api.example.com/users/123'
+ * });
+ *
+ * const allowedMethods = response.headers.get('Allow');
+ * console.log('Allowed methods:', allowedMethods);
+ *
+ * @example
+ * // CORS preflight check
+ * const response = await httpOptions({
+ *   url: 'https://api.example.com/data',
+ *   headers: {
+ *     'Access-Control-Request-Method': 'POST',
+ *     'Access-Control-Request-Headers': 'Content-Type'
+ *   }
+ * });
+ */
+export function httpOptions(options: import("./typedef").HttpRequestOptions): Promise<Response>;
+/**
+ * Make a HEAD request
+ *
+ * This function performs an HTTP HEAD request, which returns only the
+ * headers of a response without the body. It's useful for checking
+ * resource existence, getting metadata, or cache validation.
+ *
+ * @param {import('./typedef').HttpRequestOptions} options
+ *   Request configuration options
+ *
+ * @returns {Promise<Response>} Response promise (with empty body)
+ *
+ * @example
+ * // Check if a resource exists
+ * const response = await httpHead({
+ *   url: 'https://api.example.com/users/123'
+ * });
+ *
+ * if (response.ok) {
+ *   console.log('User exists');
+ *   console.log('Last modified:', response.headers.get('Last-Modified'));
+ * }
+ *
+ * @example
+ * // Get content length without downloading
+ * const response = await httpHead({
+ *   url: 'https://api.example.com/large-file.zip'
+ * });
+ *
+ * const contentLength = response.headers.get('Content-Length');
+ * console.log('File size:', contentLength, 'bytes');
+ *
+ * @example
+ * // Cache validation
+ * const response = await httpHead({
+ *   url: 'https://api.example.com/data',
+ *   headers: { 'If-None-Match': '"cached-etag-value"' }
+ * });
+ *
+ * if (response.status === 304) {
+ *   console.log('Cache is still valid');
+ * }
+ */
+export function httpHead(options: import("./typedef").HttpRequestOptions): Promise<Response>;
 /**
  * Make an HTTP request (low-level function)
  *