@hkdigital/lib-core 0.3.11 → 0.3.13

package/dist/config/generators/imagetools.js

@@ -1,189 +1,189 @@
-const DEFAULT_WIDTHS = [640, 1024, 1536, 1920];
-
-const DEFAULT_PRESETS = {
-	default: {
-		format: 'avif',
-		quality: '90'
-	},
-	render: {
-		format: 'jpg',
-		quality: '95',
-		as: 'metadata'
-	},
-	photo: {
-		format: 'jpg',
-		quality: '95',
-		as: 'metadata'
-	},
-	gradient: {
-		format: 'jpg',
-		quality: '95',
-		as: 'metadata'
-	},
-	drawing: {
-		format: 'avif',
-		quality: '90',
-		as: 'metadata'
-	},
-	savedata: {
-		format: 'avif',
-		quality: '85',
-		as: 'metadata'
-	},
-	blur: {
-		format: 'avif',
-		quality: '50',
-		blur: '75',
-		as: 'metadata'
-	}
-};
-
-/**
- * Configures and returns a function that can be used as
- * 'resolveConfigs' parameter in imagetools config
- *
- * @param {object} [options]
- * @param {number[]} [options.widths=DEFAULT_WIDTHS]
- *
- * @returns {(
- *   entries: [string, string[]][]
- * ) => (Record<string, string | string[]>[])}
- */
-export function generateResponseConfigs(options) {
-	//
-	// @see https://github.com/JonasKruckenberg/imagetools
-	//      /blob/main/docs/core/src/functions/resolveConfigs.md
-	//
-	return function resolveConfigs(entries /*, outputFormats*/) {
-		// console.log('resolveConfigs:entries', entries);
-
-		/** @type {Record<string, string | string[]>} */
-		const configPairs = {};
-
-		for (const current of entries) {
-			const key = current[0];
-			const value = current[1][0];
-
-			// @ts-ignore
-			configPairs[key] = value;
-		}
-
-		// @ts-ignore
-		const responsiveConfig = entries.find(([key]) => key === 'responsive');
-
-		if (!responsiveConfig) {
-			// Directive 'responsive' was not set => return original config
-
-			return [configPairs];
-
-			// Alternative: by returning undefined, the default resolveConfig is used
-			// return undefined;
-		}
-
-		const widths = options?.widths ?? DEFAULT_WIDTHS;
-
-		return widths.map((w) => {
-			return { ...configPairs, w: String(w) };
-		});
-	};
-}
-
-/**
- * Configures and returns a function that can be used as
- * 'defaultDirectives' parameter in imagetools config
- *
- * - This function runs before 'resolveConfigs'
- *
- * @param {object} [options]
- * @param {number[]} [options.presets=DEFAULT_PRESETS]
- */
-export function generateDefaultDirectives(options) {
-	/**
-	 * Function that sets a.o. format and quality directives if
-	 * the 'preset' driective is set
-	 *
-	 * @param {URL} url
-	 */
-	return function defaultDirectives(url) {
-		// Check the directive in the URL to determine which preset to use
-		const params = url.searchParams;
-
-		let presetName = params.get('preset');
-
-		// > Return metadata if directive 'responsive' is set
-
-		if (params.has('responsive')) {
-			params.set('as', 'metadata');
-		}
-
-		// > Process presets
-
-		if (presetName) {
-			params.delete('preset');
-		} else {
-			presetName = 'default';
-		}
-
-		const presets = options?.presets || DEFAULT_PRESETS;
-
-		// @ts-ignore
-		let preset = presets[presetName];
-
-		// console.log(`defaultDirectives [url=${url}]`, preset);
-
-		if (!preset) {
-			preset = DEFAULT_PRESETS.default;
-		}
-
-		for (const key in preset) {
-			params.set(key, preset[key]);
-		}
-
-		// TODO: process directive 'w''
-		// - generate only allowed widths
-		// - support width presets such as 'hd'
-
-		// let width = params.get('w');
-
-		// if (!width) {
-		// 	// Set max allowed width by default
-		// 	// width = 'hd';
-		// }
-
-		// let presets = {
-		//   sm: '640',
-		//   md: '1024',
-		//   lg: '1536',
-		//   hd: '1920'
-		// };
-
-		// // @ts-ignore
-		// let presetWidth = presets[width];
-		// console.log({ width, presetWidth });
-
-		// if (presetWidth) {
-		//   params.set('w', presetWidth);
-		// } else if (responsive || width === null) {
-		//   params.set('as', 'metadata');
-		//   params.delete('w');
-		//   // } else if (width === null) {
-		//   // 	// Set largest size is width parameter is missing
-		//   // 	params.set('w', presets.hd);
-		// } else {
-		//   throw new Error(
-		//     `Directive [w=${width}] is should be a preset value {sm,md,lg,hd,responsive}`
-		//   );
-
-		//   // let allowedWidths = new Set(['640', '1024', '1536', '1920']);
-		//   // if (!allowedWidths.has(width)) {
-		//   // 	throw new Error(`Width [${width}] is not in list of allowed widths`);
-		//   // }
-		// }
-
-		// params.set('withoutEnlargement', 'true');
-
-		// console.log('defaultDirectives:output params', params);
-
-		return params;
-	};
-}
+const DEFAULT_WIDTHS = [640, 1024, 1536, 1920];
+
+const DEFAULT_PRESETS = {
+	default: {
+		format: 'avif',
+		quality: '90'
+	},
+	render: {
+		format: 'jpg',
+		quality: '95',
+		as: 'metadata'
+	},
+	photo: {
+		format: 'jpg',
+		quality: '95',
+		as: 'metadata'
+	},
+	gradient: {
+		format: 'jpg',
+		quality: '95',
+		as: 'metadata'
+	},
+	drawing: {
+		format: 'avif',
+		quality: '90',
+		as: 'metadata'
+	},
+	savedata: {
+		format: 'avif',
+		quality: '85',
+		as: 'metadata'
+	},
+	blur: {
+		format: 'avif',
+		quality: '50',
+		blur: '75',
+		as: 'metadata'
+	}
+};
+
+/**
+ * Configures and returns a function that can be used as
+ * 'resolveConfigs' parameter in imagetools config
+ *
+ * @param {object} [options]
+ * @param {number[]} [options.widths=DEFAULT_WIDTHS]
+ *
+ * @returns {(
+ *   entries: [string, string[]][]
+ * ) => (Record<string, string | string[]>[])}
+ */
+export function generateResponseConfigs(options) {
+	//
+	// @see https://github.com/JonasKruckenberg/imagetools
+	//      /blob/main/docs/core/src/functions/resolveConfigs.md
+	//
+	return function resolveConfigs(entries /*, outputFormats*/) {
+		// console.log('resolveConfigs:entries', entries);
+
+		/** @type {Record<string, string | string[]>} */
+		const configPairs = {};
+
+		for (const current of entries) {
+			const key = current[0];
+			const value = current[1][0];
+
+			// @ts-ignore
+			configPairs[key] = value;
+		}
+
+		// @ts-ignore
+		const responsiveConfig = entries.find(([key]) => key === 'responsive');
+
+		if (!responsiveConfig) {
+			// Directive 'responsive' was not set => return original config
+
+			return [configPairs];
+
+			// Alternative: by returning undefined, the default resolveConfig is used
+			// return undefined;
+		}
+
+		const widths = options?.widths ?? DEFAULT_WIDTHS;
+
+		return widths.map((w) => {
+			return { ...configPairs, w: String(w) };
+		});
+	};
+}
+
+/**
+ * Configures and returns a function that can be used as
+ * 'defaultDirectives' parameter in imagetools config
+ *
+ * - This function runs before 'resolveConfigs'
+ *
+ * @param {object} [options]
+ * @param {number[]} [options.presets=DEFAULT_PRESETS]
+ */
+export function generateDefaultDirectives(options) {
+	/**
+	 * Function that sets a.o. format and quality directives if
+	 * the 'preset' driective is set
+	 *
+	 * @param {URL} url
+	 */
+	return function defaultDirectives(url) {
+		// Check the directive in the URL to determine which preset to use
+		const params = url.searchParams;
+
+		let presetName = params.get('preset');
+
+		// > Return metadata if directive 'responsive' is set
+
+		if (params.has('responsive')) {
+			params.set('as', 'metadata');
+		}
+
+		// > Process presets
+
+		if (presetName) {
+			params.delete('preset');
+		} else {
+			presetName = 'default';
+		}
+
+		const presets = options?.presets || DEFAULT_PRESETS;
+
+		// @ts-ignore
+		let preset = presets[presetName];
+
+		// console.log(`defaultDirectives [url=${url}]`, preset);
+
+		if (!preset) {
+			preset = DEFAULT_PRESETS.default;
+		}
+
+		for (const key in preset) {
+			params.set(key, preset[key]);
+		}
+
+		// TODO: process directive 'w''
+		// - generate only allowed widths
+		// - support width presets such as 'hd'
+
+		// let width = params.get('w');
+
+		// if (!width) {
+		// 	// Set max allowed width by default
+		// 	// width = 'hd';
+		// }
+
+		// let presets = {
+		//   sm: '640',
+		//   md: '1024',
+		//   lg: '1536',
+		//   hd: '1920'
+		// };
+
+		// // @ts-ignore
+		// let presetWidth = presets[width];
+		// console.log({ width, presetWidth });
+
+		// if (presetWidth) {
+		//   params.set('w', presetWidth);
+		// } else if (responsive || width === null) {
+		//   params.set('as', 'metadata');
+		//   params.delete('w');
+		//   // } else if (width === null) {
+		//   // 	// Set largest size is width parameter is missing
+		//   // 	params.set('w', presets.hd);
+		// } else {
+		//   throw new Error(
+		//     `Directive [w=${width}] is should be a preset value {sm,md,lg,hd,responsive}`
+		//   );
+
+		//   // let allowedWidths = new Set(['640', '1024', '1536', '1920']);
+		//   // if (!allowedWidths.has(width)) {
+		//   // 	throw new Error(`Width [${width}] is not in list of allowed widths`);
+		//   // }
+		// }
+
+		// params.set('withoutEnlargement', 'true');
+
+		// console.log('defaultDirectives:output params', params);
+
+		return params;
+	};
+}

package/dist/config/generators/vite.js

@@ -1,142 +1,148 @@
-import { readFileSync } from 'fs';
-import { resolve } from 'path';
-
-/**
- * Generates a Vite configuration object with common HKdigital settings
- *
- * @param {object} [options] Configuration options
- * @param {boolean} [options.enableImagetools=true] Enable vite-imagetools plugin
- * @param {boolean} [options.enableVitest=true] Include Vitest configuration
- * @param {boolean} [options.enableSvelteKit=true] Enable SvelteKit plugin
- * @param {object} [options.customDefines={}] Additional define values
- * @param {Array} [options.customPlugins=[]] Additional Vite plugins
- * @param {object} [options.imagetoolsOptions={}] Options for imagetools config
- * @param {string} [options.packageJsonPath='./package.json'] Path to package.json
- *
- * @returns {Promise<object>} Vite configuration object
- */
-export async function generateViteConfig(options = {}) {
-  const {
-    enableImagetools = true,
-    enableVitest = true,
-    enableSvelteKit = true,
-    customDefines = {},
-    customPlugins = [],
-    imagetoolsOptions = {},
-    packageJsonPath = './package.json'
-  } = options;
-
-  // Read package.json for version
-  const packageJson = JSON.parse(
-    readFileSync(resolve(packageJsonPath), 'utf-8')
-  );
-
-  const plugins = [...customPlugins];
-
-  // Add SvelteKit plugin (provides $lib alias and other SvelteKit features)
-  if (enableSvelteKit) {
-    try {
-      const { sveltekit } = await import('@sveltejs/kit/vite');
-      plugins.push(sveltekit());
-    } catch (error) {
-      console.error(error);
-      console.warn(
-        '@sveltejs/kit/vite not found. Install it to enable SvelteKit support.'
-      );
-    }
-  }
-
-  // Conditionally add imagetools
-  if (enableImagetools) {
-    try {
-      const { imagetools } = await import('vite-imagetools');
-      const { 
-        generateDefaultDirectives, 
-        generateResponseConfigs 
-      } = await import('./imagetools.js');
-
-      plugins.push(
-        imagetools({
-          defaultDirectives: generateDefaultDirectives(imagetoolsOptions),
-          resolveConfigs: generateResponseConfigs(imagetoolsOptions)
-        })
-      );
-    } catch (error) {
-      console.error(error);
-      console.warn(
-        'vite-imagetools not found. Install it to enable imagetools support.'
-      );
-    }
-  }
-
-  const config = {
-    plugins,
-    define: {
-      'import.meta.env.VITE_APP_VERSION': JSON.stringify(packageJson.version),
-      'import.meta.env.VITE_BUILD_TIMESTAMP': JSON.stringify(
-        new Date().toISOString()
-      ),
-      ...customDefines
-    }
-  };
-
-  if (enableVitest) {
-    config.test = {
-      include: [
-        'src/**/*.{test,spec}.{js,ts}',
-        'src/**/*.svelte.{test,spec}.{js,ts}'
-      ]
-    };
-  }
-
-  return config;
-}
-
-/**
- * Generates build-time defines for Vite
- *
- * @param {object} [options] Configuration options
- * @param {string} [options.packageJsonPath='./package.json'] Path to package.json
- * @param {object} [options.customDefines={}] Additional define values
- *
- * @returns {object} Define configuration object
- */
-export function generateViteDefines(options = {}) {
-  const {
-    packageJsonPath = './package.json',
-    customDefines = {}
-  } = options;
-
-  const packageJson = JSON.parse(
-    readFileSync(resolve(packageJsonPath), 'utf-8')
-  );
-
-  return {
-    'import.meta.env.VITE_APP_VERSION': JSON.stringify(packageJson.version),
-    'import.meta.env.VITE_BUILD_TIMESTAMP': JSON.stringify(
-      new Date().toISOString()
-    ),
-    ...customDefines
-  };
-}
-
-/**
- * Generates Vitest configuration
- *
- * @param {object} [options] Configuration options
- * @param {string[]} [options.additionalPatterns=[]] Additional test patterns
- *
- * @returns {object} Vitest configuration object
- */
-export function generateVitestConfig(options = {}) {
-  const { additionalPatterns = [] } = options;
-
-  const defaultPatterns = [
-    'src/**/*.{test,spec}.{js,ts}',
-    'src/**/*.svelte.{test,spec}.{js,ts}'
-  ];
-
-  return {
-    include: [...defaultPatterns, ...additionalPatterns]
-  };
-}
+import { readFileSync } from 'fs';
+import { resolve } from 'path';
+
+/**
+ * Generates a Vite configuration object with common HKdigital settings
+ *
+ * @param {object} [options] Configuration options
+ * @param {boolean} [options.enableImagetools=true] Enable vite-imagetools plugin
+ * @param {boolean} [options.enableVitest=true] Include Vitest configuration
+ * @param {boolean} [options.enableSvelteKit=true] Enable SvelteKit plugin
+ * @param {object} [options.customDefines={}] Additional define values
+ * @param {Array} [options.customPlugins=[]] Additional Vite plugins
+ * @param {object} [options.imagetoolsOptions={}] Options for imagetools config
+ * @param {string} [options.packageJsonPath='./package.json'] Path to package.json
+ *
+ * @returns {Promise<object>} Vite configuration object
+ */
+export async function generateViteConfig(options = {}) {
+  const {
+    enableImagetools = true,
+    enableVitest = true,
+    enableSvelteKit = true,
+    customDefines = {},
+    customPlugins = [],
+    imagetoolsOptions = {},
+    packageJsonPath = './package.json'
+  } = options;
+
+  // Read package.json for version
+  const packageJson = JSON.parse(
+    readFileSync(resolve(packageJsonPath), 'utf-8')
+  );
+
+  const plugins = [...customPlugins];
+
+  // Add SvelteKit plugin (provides $lib alias and other SvelteKit features)
+  if (enableSvelteKit) {
+    try {
+      const { sveltekit } = await import('@sveltejs/kit/vite');
+      plugins.push(sveltekit());
+    } catch (error) {
+      console.error(error);
+      console.warn(
+        '@sveltejs/kit/vite not found. Install it to enable SvelteKit support.'
+      );
+    }
+  }
+
+  // Conditionally add imagetools
+  if (enableImagetools) {
+    try {
+      const { imagetools } = await import('vite-imagetools');
+      const { 
+        generateDefaultDirectives, 
+        generateResponseConfigs 
+      } = await import('./imagetools.js');
+
+      plugins.push(
+        imagetools({
+          defaultDirectives: generateDefaultDirectives(imagetoolsOptions),
+          resolveConfigs: generateResponseConfigs(imagetoolsOptions)
+        })
+      );
+    } catch (error) {
+      const errorMessage = `
+╭─────────────────────────────────────────────────────────────╮
+│                     Missing Dependency                      │
+├─────────────────────────────────────────────────────────────┤
+│  'vite-imagetools' is required when enableImagetools: true  │
+│  Install it with: pnpm add -D vite-imagetools               │
+│  Or set enableImagetools: false                             │
+╰─────────────────────────────────────────────────────────────╯`;
+      console.error(errorMessage);
+      throw new Error('vite-imagetools is required when enableImagetools: true');
+    }
+  }
+
+  const config = {
+    plugins,
+    define: {
+      'import.meta.env.VITE_APP_VERSION': JSON.stringify(packageJson.version),
+      'import.meta.env.VITE_BUILD_TIMESTAMP': JSON.stringify(
+        new Date().toISOString()
+      ),
+      ...customDefines
+    }
+  };
+
+  if (enableVitest) {
+    config.test = {
+      include: [
+        'src/**/*.{test,spec}.{js,ts}',
+        'src/**/*.svelte.{test,spec}.{js,ts}'
+      ]
+    };
+  }
+
+  return config;
+}
+
+/**
+ * Generates build-time defines for Vite
+ *
+ * @param {object} [options] Configuration options
+ * @param {string} [options.packageJsonPath='./package.json'] Path to package.json
+ * @param {object} [options.customDefines={}] Additional define values
+ *
+ * @returns {object} Define configuration object
+ */
+export function generateViteDefines(options = {}) {
+  const {
+    packageJsonPath = './package.json',
+    customDefines = {}
+  } = options;
+
+  const packageJson = JSON.parse(
+    readFileSync(resolve(packageJsonPath), 'utf-8')
+  );
+
+  return {
+    'import.meta.env.VITE_APP_VERSION': JSON.stringify(packageJson.version),
+    'import.meta.env.VITE_BUILD_TIMESTAMP': JSON.stringify(
+      new Date().toISOString()
+    ),
+    ...customDefines
+  };
+}
+
+/**
+ * Generates Vitest configuration
+ *
+ * @param {object} [options] Configuration options
+ * @param {string[]} [options.additionalPatterns=[]] Additional test patterns
+ *
+ * @returns {object} Vitest configuration object
+ */
+export function generateVitestConfig(options = {}) {
+  const { additionalPatterns = [] } = options;
+
+  const defaultPatterns = [
+    'src/**/*.{test,spec}.{js,ts}',
+    'src/**/*.svelte.{test,spec}.{js,ts}'
+  ];
+
+  return {
+    include: [...defaultPatterns, ...additionalPatterns]
+  };
+}