@hkdigital/lib-sveltekit 0.2.8 → 0.2.9

package/dist/util/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/util/http/url.js

@@ -1,52 +1,52 @@
-import { TypeOrValueError } from '../../constants/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 '../../constants/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/util/image/index.js

@@ -1,86 +1,86 @@
-/**
- * Returns the unchanged image meta object or the last item of
- * an array of ImageMeta objects. This is assumed to be a list
- * of sorted responsive image formats, so it should be the
- * largest image.
- *
- * @param {ImageMeta|ImageMeta[]} imageMeta
- */
-export function toSingleImageMeta(imageMeta) {
-  if (Array.isArray(imageMeta)) {
-    if (!imageMeta.length) {
-      throw new Error('List of ImageMeta objects is empty');
-    }
-    imageMeta = imageMeta[imageMeta.length - 1];
-  }
-
-  if (typeof imageMeta === 'object') {
-    return imageMeta;
-  } else if (!imageMeta) {
-    throw new Error('Missing [imageMeta]');
-  }
-
-  throw new Error('Invalid value for parameter [imageMeta]');
-}
-
-/**
- * Calculate effective width based on container dimensions and fit mode
- *
- * @param {object} params
- * @param {number} [params.containerWidth] Container width in pixels
- * @param {number} [params.containerHeight] Container height in pixels
- * @param {number} params.imageAspectRatio Original image aspect ratio (width/height)
- * @param {'cover'|'contain'|'fill'} [params.fit='contain'] Fit mode
- * @returns {number} Effective width needed
- */
-export function calculateEffectiveWidth({
-  containerWidth,
-  containerHeight,
-  imageAspectRatio,
-  fit = 'contain'
-}) {
-  if (containerWidth && !containerHeight) {
-    // If only width is provided, use it
-
-    return containerWidth;
-  }
-
-  if (!containerWidth && containerHeight) {
-    // If only height is provided, calculate width based on aspect ratio
-
-    return containerHeight * imageAspectRatio;
-  }
-
-  if (containerWidth && containerHeight) {
-    // If both dimensions are provided, calculate based on fit mode
-
-    const containerAspectRatio = containerWidth / containerHeight;
-
-    switch (fit) {
-      case 'fill':
-        return containerWidth;
-
-      case 'contain':
-        if (containerAspectRatio > imageAspectRatio) {
-          // Height constrained, scale width accordingly
-
-          return containerHeight * imageAspectRatio;
-        }
-        return containerWidth;
-
-      case 'cover':
-        if (containerAspectRatio < imageAspectRatio) {
-          // Height constrained, scale width accordingly
-
-          return containerHeight * imageAspectRatio;
-        }
-        return containerWidth;
-
-      default:
-        return containerWidth;
-    }
-  }
-
-  // Fallback if neither dimension is provided
-  throw new Error('Either containerWidth or containerHeight must be provided');
-}
+/**
+ * Returns the unchanged image meta object or the last item of
+ * an array of ImageMeta objects. This is assumed to be a list
+ * of sorted responsive image formats, so it should be the
+ * largest image.
+ *
+ * @param {ImageMeta|ImageMeta[]} imageMeta
+ */
+export function toSingleImageMeta(imageMeta) {
+  if (Array.isArray(imageMeta)) {
+    if (!imageMeta.length) {
+      throw new Error('List of ImageMeta objects is empty');
+    }
+    imageMeta = imageMeta[imageMeta.length - 1];
+  }
+
+  if (typeof imageMeta === 'object') {
+    return imageMeta;
+  } else if (!imageMeta) {
+    throw new Error('Missing [imageMeta]');
+  }
+
+  throw new Error('Invalid value for parameter [imageMeta]');
+}
+
+/**
+ * Calculate effective width based on container dimensions and fit mode
+ *
+ * @param {object} params
+ * @param {number} [params.containerWidth] Container width in pixels
+ * @param {number} [params.containerHeight] Container height in pixels
+ * @param {number} params.imageAspectRatio Original image aspect ratio (width/height)
+ * @param {'cover'|'contain'|'fill'} [params.fit='contain'] Fit mode
+ * @returns {number} Effective width needed
+ */
+export function calculateEffectiveWidth({
+  containerWidth,
+  containerHeight,
+  imageAspectRatio,
+  fit = 'contain'
+}) {
+  if (containerWidth && !containerHeight) {
+    // If only width is provided, use it
+
+    return containerWidth;
+  }
+
+  if (!containerWidth && containerHeight) {
+    // If only height is provided, calculate width based on aspect ratio
+
+    return containerHeight * imageAspectRatio;
+  }
+
+  if (containerWidth && containerHeight) {
+    // If both dimensions are provided, calculate based on fit mode
+
+    const containerAspectRatio = containerWidth / containerHeight;
+
+    switch (fit) {
+      case 'fill':
+        return containerWidth;
+
+      case 'contain':
+        if (containerAspectRatio > imageAspectRatio) {
+          // Height constrained, scale width accordingly
+
+          return containerHeight * imageAspectRatio;
+        }
+        return containerWidth;
+
+      case 'cover':
+        if (containerAspectRatio < imageAspectRatio) {
+          // Height constrained, scale width accordingly
+
+          return containerHeight * imageAspectRatio;
+        }
+        return containerWidth;
+
+      default:
+        return containerWidth;
+    }
+  }
+
+  // Fallback if neither dimension is provided
+  throw new Error('Either containerWidth or containerHeight must be provided');
+}

package/dist/util/index.js

@@ -1,2 +1,2 @@
-export * as expect from './expect/index.js';
-export * as singleton from './singleton/index.js';
+export * as expect from './expect/index.js';
+export * as singleton from './singleton/index.js';