@hkdigital/lib-core 0.3.11 → 0.3.13

package/dist/network/http/typedef.js

@@ -1,93 +1,93 @@
-/**
- * @typedef {Object} HttpRequestOptions
- * @property {string|URL} url URL string or URL object for the request
- * @property {string} [method] HTTP method to use (GET, POST, etc.)
- *
- * @property {Object|URLSearchParams} [urlSearchParams]
- *   Parameters to add to the URL
- *
- * @property {*} [body] Request body (for POST, PUT, etc.)
- * @property {Object} [headers] HTTP headers as name-value pairs
- * @property {boolean} [withCredentials] Whether to include credentials
- * @property {number} [timeoutMs] Request timeout in milliseconds
- * @property {Function} [requestHandler] Handler for abort/timeout control
- * @property {string} [mode] CORS mode ('cors', 'no-cors', 'same-origin')
- * @property {string} [cache] Cache mode ('default', 'no-cache', etc.)
- * @property {string} [redirect] Redirect mode ('follow', 'error', 'manual')
- * @property {string} [referrerPolicy] Referrer policy
- * @property {boolean} [cacheEnabled] Enable or disabled automatic caching
- */
-
-/**
- * @typedef {Object} RequestHandlerParams
- *
- * @property {AbortController} controller
- *   The AbortController instance for this request
- *
- * @property {(reason?: Error) => void} abort Function to abort the request
- * @property {(delayMs: number) => void} timeout Function to set a timeout
- */
-
-/**
- * @callback RequestHandler
- * @param {RequestHandlerParams} params Parameters for controlling the request
- * @returns {void}
- */
-
-/**
- * @typedef {Object} JsonGetOptions
- * @property {string|URL} url URL string or URL object for the request
- *
- * @property {Object|URLSearchParams} [urlSearchParams]
- *   Parameters to add to the URL
- *
- * @property {Object} [headers] HTTP headers as name-value pairs
- * @property {boolean} [withCredentials] Whether to include credentials
- * @property {number} [timeoutMs] Request timeout in milliseconds
- * @property {RequestHandler} [requestHandler] Handler for abort/timeout control
- * @property {string} [mode] CORS mode ('cors', 'no-cors', 'same-origin')
- * @property {string} [cache] Cache mode ('default', 'no-cache', etc.)
- * @property {string} [redirect] Redirect mode ('follow', 'error', 'manual')
- * @property {string} [referrerPolicy] Referrer policy
- * @property {boolean} [cacheEnabled] Enable or disabled automatic caching
- */
-
-/**
- * @typedef {Object} JsonPostOptions
- * @property {string|URL} url URL string or URL object for the request
- * @property {*} body Request body (will be sent as JSON)
- *
- * @property {Object|URLSearchParams} [urlSearchParams]
- *   Parameters to add to the URL
- *
- * @property {Object} [headers] HTTP headers as name-value pairs
- * @property {boolean} [withCredentials] Whether to include credentials
- * @property {number} [timeoutMs] Request timeout in milliseconds
- * @property {RequestHandler} [requestHandler] Handler for abort/timeout control
- * @property {string} [mode] CORS mode ('cors', 'no-cors', 'same-origin')
- * @property {string} [cache] Cache mode ('default', 'no-cache', etc.)
- * @property {string} [redirect] Redirect mode ('follow', 'error', 'manual')
- * @property {string} [referrerPolicy] Referrer policy
- * @property {boolean} [cacheEnabled] Enable or disabled automatic caching
- */
-
-/**
- * @typedef {Object} StaleInfo
- * @property {boolean} isStale Whether the response contains stale data
- *
- * @property {Promise<Response>|null} fresh
- *   Promise that resolves to fresh data (if available)
- *
- * @property {number} timestamp When the response was originally cached
- * @property {number|null} expires When the response expires
- */
-
-/**
- * @typedef {Response} ResponseWithStale
- * @property {boolean} isStale Whether this response contains stale data
- *
- * @property {Promise<Response>|null} fresh
- *   Promise for fresh data if this is stale
- */
-
-export {};
+/**
+ * @typedef {Object} HttpRequestOptions
+ * @property {string|URL} url URL string or URL object for the request
+ * @property {string} [method] HTTP method to use (GET, POST, etc.)
+ *
+ * @property {Object|URLSearchParams} [urlSearchParams]
+ *   Parameters to add to the URL
+ *
+ * @property {*} [body] Request body (for POST, PUT, etc.)
+ * @property {Object} [headers] HTTP headers as name-value pairs
+ * @property {boolean} [withCredentials] Whether to include credentials
+ * @property {number} [timeoutMs] Request timeout in milliseconds
+ * @property {Function} [requestHandler] Handler for abort/timeout control
+ * @property {string} [mode] CORS mode ('cors', 'no-cors', 'same-origin')
+ * @property {string} [cache] Cache mode ('default', 'no-cache', etc.)
+ * @property {string} [redirect] Redirect mode ('follow', 'error', 'manual')
+ * @property {string} [referrerPolicy] Referrer policy
+ * @property {boolean} [cacheEnabled] Enable or disabled automatic caching
+ */
+
+/**
+ * @typedef {Object} RequestHandlerParams
+ *
+ * @property {AbortController} controller
+ *   The AbortController instance for this request
+ *
+ * @property {(reason?: Error) => void} abort Function to abort the request
+ * @property {(delayMs: number) => void} timeout Function to set a timeout
+ */
+
+/**
+ * @callback RequestHandler
+ * @param {RequestHandlerParams} params Parameters for controlling the request
+ * @returns {void}
+ */
+
+/**
+ * @typedef {Object} JsonGetOptions
+ * @property {string|URL} url URL string or URL object for the request
+ *
+ * @property {Object|URLSearchParams} [urlSearchParams]
+ *   Parameters to add to the URL
+ *
+ * @property {Object} [headers] HTTP headers as name-value pairs
+ * @property {boolean} [withCredentials] Whether to include credentials
+ * @property {number} [timeoutMs] Request timeout in milliseconds
+ * @property {RequestHandler} [requestHandler] Handler for abort/timeout control
+ * @property {string} [mode] CORS mode ('cors', 'no-cors', 'same-origin')
+ * @property {string} [cache] Cache mode ('default', 'no-cache', etc.)
+ * @property {string} [redirect] Redirect mode ('follow', 'error', 'manual')
+ * @property {string} [referrerPolicy] Referrer policy
+ * @property {boolean} [cacheEnabled] Enable or disabled automatic caching
+ */
+
+/**
+ * @typedef {Object} JsonPostOptions
+ * @property {string|URL} url URL string or URL object for the request
+ * @property {*} body Request body (will be sent as JSON)
+ *
+ * @property {Object|URLSearchParams} [urlSearchParams]
+ *   Parameters to add to the URL
+ *
+ * @property {Object} [headers] HTTP headers as name-value pairs
+ * @property {boolean} [withCredentials] Whether to include credentials
+ * @property {number} [timeoutMs] Request timeout in milliseconds
+ * @property {RequestHandler} [requestHandler] Handler for abort/timeout control
+ * @property {string} [mode] CORS mode ('cors', 'no-cors', 'same-origin')
+ * @property {string} [cache] Cache mode ('default', 'no-cache', etc.)
+ * @property {string} [redirect] Redirect mode ('follow', 'error', 'manual')
+ * @property {string} [referrerPolicy] Referrer policy
+ * @property {boolean} [cacheEnabled] Enable or disabled automatic caching
+ */
+
+/**
+ * @typedef {Object} StaleInfo
+ * @property {boolean} isStale Whether the response contains stale data
+ *
+ * @property {Promise<Response>|null} fresh
+ *   Promise that resolves to fresh data (if available)
+ *
+ * @property {number} timestamp When the response was originally cached
+ * @property {number|null} expires When the response expires
+ */
+
+/**
+ * @typedef {Response} ResponseWithStale
+ * @property {boolean} isStale Whether this response contains stale data
+ *
+ * @property {Promise<Response>|null} fresh
+ *   Promise for fresh data if this is stale
+ */
+
+export {};

package/dist/network/http/url.js

@@ -1,52 +1,52 @@
-import { TypeOrValueError } from '../../errors/index.js';
-
-/**
- * Returns an URL instance
- * - Prefixes the URL with the current orign if the url is relative
- *
- * @param {string|URL} url
- *
- * @returns {URL} url instance
- */
-export function toURL(url) {
-	if (typeof url === 'string') {
-		if (hasProtocol(url)) {
-			return new URL(url);
-		} else {
-			// Use location.origin aas baseUrl
-			return new URL(url, location.origin);
-		}
-	} else if (!(url instanceof URL)) {
-		throw new TypeOrValueError('Missing or invalid parameter [url]');
-	}
-
-	// already an URL instance
-	return url;
-}
-
-/**
- * Checks if the url starts with a protocol specification such
- * as https://
- *
- * @param {string} url
- *
- * @return {boolean} true if the value looks like an array
- */
-export function hasProtocol(url) {
-	if (/^([a-zA-Z]{2,})s?:\/\//.test(url)) {
-		return true;
-	}
-
-	return false;
-}
-
-/**
- * Convert an url to an absolute url and apply decodeURI to
- * convert URI encoded characters to normal characters
- *
- * @param {string|URL} url
- */
-export function href(url) {
-	const urlObj = toURL(url);
-	return decodeURI(urlObj.href);
-}
+import { TypeOrValueError } from '../../errors/index.js';
+
+/**
+ * Returns an URL instance
+ * - Prefixes the URL with the current orign if the url is relative
+ *
+ * @param {string|URL} url
+ *
+ * @returns {URL} url instance
+ */
+export function toURL(url) {
+	if (typeof url === 'string') {
+		if (hasProtocol(url)) {
+			return new URL(url);
+		} else {
+			// Use location.origin aas baseUrl
+			return new URL(url, location.origin);
+		}
+	} else if (!(url instanceof URL)) {
+		throw new TypeOrValueError('Missing or invalid parameter [url]');
+	}
+
+	// already an URL instance
+	return url;
+}
+
+/**
+ * Checks if the url starts with a protocol specification such
+ * as https://
+ *
+ * @param {string} url
+ *
+ * @return {boolean} true if the value looks like an array
+ */
+export function hasProtocol(url) {
+	if (/^([a-zA-Z]{2,})s?:\/\//.test(url)) {
+		return true;
+	}
+
+	return false;
+}
+
+/**
+ * Convert an url to an absolute url and apply decodeURI to
+ * convert URI encoded characters to normal characters
+ *
+ * @param {string|URL} url
+ */
+export function href(url) {
+	const urlObj = toURL(url);
+	return decodeURI(urlObj.href);
+}

package/dist/network/http.js

@@ -1,6 +1,6 @@
-export * from './http/headers.js';
-export * from './http/errors.js';
-export * from './http/url.js';
-export * from './http/response.js';
-export * from './http/http-request.js';
+export * from './http/headers.js';
+export * from './http/errors.js';
+export * from './http/url.js';
+export * from './http/response.js';
+export * from './http/http-request.js';
 export * from './http/json-request.js';