@hkdigital/lib-core 0.3.1

package/dist/config/imagetools-config.js

@@ -0,0 +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;
+	};
+}

package/dist/config/imagetools.d.ts

@@ -0,0 +1,72 @@
+type ImageMeta = import('../typedef').ImageMeta;
+type ImageSource = import('../typedef').ImageSource;
+
+declare module '*?responsive' {
+  const out: ImageMeta[];
+  export default out;
+}
+
+declare module '*&responsive' {
+  const out: ImageMeta[];
+  export default out;
+}
+
+declare module '*?preset=photo' {
+  const out: ImageSource;
+  export default out;
+}
+
+declare module '*&preset=photo' {
+  const out: ImageSource;
+  export default out;
+}
+
+declare module '*?preset=render' {
+  const out: ImageSource;
+  export default out;
+}
+
+declare module '*&preset=render' {
+  const out: ImageSource;
+  export default out;
+}
+
+declare module '*?preset=gradient' {
+  const out: ImageSource;
+  export default out;
+}
+
+declare module '*&preset=gradient' {
+  const out: ImageSource;
+  export default out;
+}
+
+declare module '*?preset=drawing' {
+  const out: ImageSource;
+  export default out;
+}
+
+declare module '*&preset=drawing' {
+  const out: ImageSource;
+  export default out;
+}
+
+declare module '*?preset=savedata' {
+  const out: ImageSource;
+  export default out;
+}
+
+declare module '*&preset=savedata' {
+  const out: IImageSource;
+  export default out;
+}
+
+declare module '*?preset=blur' {
+  const out: ImageSource;
+  export default out;
+}
+
+declare module '*&preset=blur' {
+  const out: ImageSource;
+  export default out;
+}

package/dist/constants/bases.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Characters selected for their visually distinct shapes to improve
+ * human readability and reduce confusion.
+ */
+export const ALPHABET_BASE_HUMAN: "3456789abcdefghjkmnpqrstuvwxy";
+/**
+ * Base58 character set: alphanumeric characters excluding similar-looking
+ * ones (0, O, I, l) to prevent visual ambiguity.
+ */
+export const ALPHABET_BASE_58: "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz";

package/dist/constants/bases.js

@@ -0,0 +1,13 @@
+
+/**
+ * Characters selected for their visually distinct shapes to improve
+ * human readability and reduce confusion.
+ */
+ export const ALPHABET_BASE_HUMAN = '3456789abcdefghjkmnpqrstuvwxy';
+
+/**
+ * Base58 character set: alphanumeric characters excluding similar-looking
+ * ones (0, O, I, l) to prevent visual ambiguity.
+ */
+export const ALPHABET_BASE_58 =
+  '123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz';

package/dist/constants/errors/api.d.ts

@@ -0,0 +1,10 @@
+export class ResponseError extends Error {
+}
+export class AuthenticationError extends Error {
+}
+export class BadRequestError extends Error {
+}
+export class AbortError extends Error {
+}
+export class TimeoutError extends Error {
+}

package/dist/constants/errors/api.js

@@ -0,0 +1,9 @@
+export class ResponseError extends Error {}
+
+export class AuthenticationError extends Error {}
+
+export class BadRequestError extends Error {}
+
+export class AbortError extends Error {}
+
+export class TimeoutError extends Error {}

package/dist/constants/errors/generic.d.ts

@@ -0,0 +1,20 @@
+export class TypeOrValueError extends Error {
+}
+export class InternalError extends Error {
+}
+export class InternalEventOrLogError extends Error {
+}
+export class DetailedError extends Error {
+    /**
+     * @param {string} message - Error message
+     * @param {string|{[key: string]: any}|null} [details] - Additional details
+     * @param {Error|string} [cause] - Original error
+     */
+    constructor(message: string, details?: string | {
+        [key: string]: any;
+    } | null, cause?: Error | string);
+    details: string | {
+        [key: string]: any;
+    };
+    cause: string | Error;
+}

package/dist/constants/errors/generic.js

@@ -0,0 +1,20 @@
+export class TypeOrValueError extends Error {}
+
+export class InternalError extends Error {}
+
+export class InternalEventOrLogError extends Error {}
+
+export class DetailedError extends Error
+{
+  /**
+   * @param {string} message - Error message
+   * @param {string|{[key: string]: any}|null} [details] - Additional details
+   * @param {Error|string} [cause] - Original error
+   */
+  constructor(message, details, cause ) {
+    super(message);
+    this.name = 'DetailedError';
+    this.details = details ?? null;
+    this.cause = cause;
+  }
+}

package/dist/constants/errors/http.d.ts

@@ -0,0 +1,16 @@
+export class HttpError extends Error {
+    /**
+     * @param {number} status - HTTP status
+     * @param {string} message - Error message
+     * @param {string|{[key: string]: any}|null} [details] - Additional details
+     * @param {Error|string} [cause] - Original error
+     */
+    constructor(status: number, message: string, details?: string | {
+        [key: string]: any;
+    } | null, cause?: Error | string);
+    status: number;
+    details: string | {
+        [key: string]: any;
+    };
+    cause: string | Error;
+}

package/dist/constants/errors/http.js

@@ -0,0 +1,16 @@
+export class HttpError extends Error
+{
+  /**
+   * @param {number} status - HTTP status
+   * @param {string} message - Error message
+   * @param {string|{[key: string]: any}|null} [details] - Additional details
+   * @param {Error|string} [cause] - Original error
+   */
+  constructor(status, message, details, cause ) {
+    super(message);
+    this.status = status;
+    this.name = 'HttpError';
+    this.details = details ?? null;
+    this.cause = cause;
+  }
+}

package/dist/constants/errors/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./api.js";
+export * from "./generic.js";
+export * from "./http.js";
+export * from "./jwt.js";

package/dist/constants/errors/index.js

@@ -0,0 +1,4 @@
+export * from './api.js';
+export * from './generic.js';
+export * from './http.js';
+export * from './jwt.js';

package/dist/constants/errors/jwt.d.ts

@@ -0,0 +1,8 @@
+export class SecretKeyError extends Error {
+}
+export class TokenExpiredError extends Error {
+}
+export class JsonWebTokenError extends Error {
+}
+export class InvalidSignatureError extends Error {
+}

package/dist/constants/errors/jwt.js

@@ -0,0 +1,5 @@
+export class SecretKeyError extends Error {}
+export class TokenExpiredError extends Error {}
+
+export class JsonWebTokenError extends Error {}
+export class InvalidSignatureError extends Error {}

package/dist/constants/http/headers.d.ts

@@ -0,0 +1,5 @@
+export const ACCEPT: "accept";
+export const CONTENT_TYPE: "content-type";
+export const CONTENT_LENGTH: "content-length";
+export const AUTHORIZATION: "authorization";
+export const WWW_AUTHENTICATE: "www-authenticate";

package/dist/constants/http/headers.js

@@ -0,0 +1,6 @@
+export const ACCEPT = 'accept';
+export const CONTENT_TYPE = 'content-type';
+export const CONTENT_LENGTH = 'content-length';
+
+export const AUTHORIZATION = 'authorization';
+export const WWW_AUTHENTICATE = 'www-authenticate';

package/dist/constants/http/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./headers.js";
+export * from "./methods.js";

package/dist/constants/http/index.js

@@ -0,0 +1,2 @@
+export * from './headers.js';
+export * from './methods.js';

package/dist/constants/http/methods.d.ts

@@ -0,0 +1,7 @@
+export const METHOD_GET: "GET";
+export const METHOD_POST: "POST";
+export const METHOD_PUT: "PUT";
+export const METHOD_DELETE: "DELETE";
+export const METHOD_PATCH: "PATCH";
+export const METHOD_OPTIONS: "OPTIONS";
+export const METHOD_HEAD: "HEAD";

package/dist/constants/http/methods.js

@@ -0,0 +1,14 @@
+// Get & Post
+export const METHOD_GET = 'GET';
+export const METHOD_POST = 'POST';
+
+// And the REST
+export const METHOD_PUT = 'PUT';
+export const METHOD_DELETE = 'DELETE';
+export const METHOD_PATCH = 'PATCH';
+
+// Check CORS
+export const METHOD_OPTIONS = 'OPTIONS';
+
+// Head
+export const METHOD_HEAD = 'HEAD';

package/dist/constants/index.d.ts

@@ -0,0 +1,2 @@
+export * as regexp from "./regexp/index.js";
+export * as time from "./time.js";

package/dist/constants/index.js

@@ -0,0 +1,3 @@
+export * as regexp from './regexp/index.js';
+export * as time from './time.js';
+//export * as stateLabels from './state-labels/index.js';

package/dist/constants/mime/application.d.ts

@@ -0,0 +1,3 @@
+export const APPLICATION_JSON: "application/json";
+export const APPLICATION_XML: "application/xml";
+export const OCTET_STREAM: "application/octet-stream";

package/dist/constants/mime/application.js

@@ -0,0 +1,5 @@
+export const APPLICATION_JSON = 'application/json';
+export const APPLICATION_XML = 'application/xml';
+
+// "arbitrary binary data"as defined in RFC 2046
+export const OCTET_STREAM = 'application/octet-stream';

package/dist/constants/mime/audio.d.ts

@@ -0,0 +1,10 @@
+export const AUDIO_BASIC: "audio/basic";
+export const AUDIO_MIDI: "audio/mid";
+export const AUDIO_WAV: "audio/vnd.wav";
+export const AUDIO_MP3: "audio/mpeg";
+export const AUDIO_MP4: "audio/mp4";
+export const AUDIO_AIF: "audio/x-aiff";
+export const AUDIO_AIFC: "audio/x-aiff";
+export const AUDIO_AIFF: "audio/x-aiff";
+export const AUDIO_M3U: "audio/x-mpegurl";
+export const AUDIO_OGG: "audio/ogg";

package/dist/constants/mime/audio.js

@@ -0,0 +1,13 @@
+export const AUDIO_BASIC = 'audio/basic';
+export const AUDIO_MIDI = 'audio/mid';
+export const AUDIO_WAV = 'audio/vnd.wav';
+
+export const AUDIO_MP3 = 'audio/mpeg';
+export const AUDIO_MP4 = 'audio/mp4';
+
+export const AUDIO_AIF = 'audio/x-aiff';
+export const AUDIO_AIFC = 'audio/x-aiff';
+export const AUDIO_AIFF = 'audio/x-aiff';
+
+export const AUDIO_M3U = 'audio/x-mpegurl';
+export const AUDIO_OGG = 'audio/ogg';

package/dist/constants/mime/image.d.ts

@@ -0,0 +1,3 @@
+export const IMAGE_PNG: "image/png";
+export const IMAGE_JPEG: "image/jpeg";
+export const IMAGE_WEBP: "image/webp";

package/dist/constants/mime/image.js

@@ -0,0 +1,3 @@
+export const IMAGE_PNG = 'image/png';
+export const IMAGE_JPEG = 'image/jpeg';
+export const IMAGE_WEBP = 'image/webp';

package/dist/constants/mime/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./application.js";
+export * from "./audio.js";
+export * from "./text.js";
+export * from "./image.js";

package/dist/constants/mime/index.js

@@ -0,0 +1,4 @@
+export * from './application.js';
+export * from './audio.js';
+export * from './text.js';
+export * from './image.js';

package/dist/constants/mime/text.d.ts

@@ -0,0 +1,2 @@
+export const TEXT_PLAIN: "text/plain";
+export const TEXT_HTML: "text/html";

package/dist/constants/mime/text.js

@@ -0,0 +1,2 @@
+export const TEXT_PLAIN = 'text/plain';
+export const TEXT_HTML = 'text/html';

package/dist/constants/regexp/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./text.js";
+export * from "./user.js";
+export * from "./web.js";

package/dist/constants/regexp/index.js

@@ -0,0 +1,31 @@
+/**
+ * Index file for various regexp categories
+ *
+ * @note
+ * To enable unicode search, use the unicode flag 'u'.
+ *
+ * \p and \P are only supported in Unicode-aware mode. In Unicode-unaware mode,
+ * they are identity escapes for the p or P character.
+ *
+ * @note
+ * To enable unicode symbols that consist of multiple 'code points'(characters),
+ * such a some emoji, you must use the flag 'v'.
+ *
+ * @eg
+ * const re = new RegExp('^[${Latin_Number}]', 'u');
+ *
+ * @eg
+ * const re = new RegExp('^[${Symbols_Emoji}]', 'v');
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/
+ *      Reference/Regular_expressions/Unicode_character_class_escape
+ *
+ * @see https://javascript.info/regexp-unicode
+ *
+ * @see https://v8.dev/features/regexp-v-flag
+ *
+ * @see https://www.regular-expressions.info/unicode.html
+ */
+export * from './text.js';
+export * from './user.js';
+export * from './web.js';

package/dist/constants/regexp/inspiratie.js__

@@ -0,0 +1,95 @@
+//
+// EXT_LATIN_TOKENS_LC
+// - Extended list of latin tokens, works for most latin languages
+//
+// @note
+//   Both upper- and lower case extended latin tokens are:
+//   "ŠŒŽšœžŸñÑÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÒÓÔÕÖØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðòóôõöøùúûüýþÿ"
+//
+// TODO:
+//   Replace with unicode property escapes when supported ES2018
+//   (not yet supported by MS Edge 12)
+//   https://github.com/tc39/proposal-regexp-unicode-property-escapes
+//   http://unicode.org/Public/UNIDATA/PropertyValueAliases.txt
+//   https://www.fileformat.info/info/unicode/category/index.htm
+//   https://github.com/danielberndt/babel-plugin-utf-8-regex/
+//     blob/master/src/transformer.js
+//
+export const EXT_LATIN_TOKENS_LC = 'šœžÿñàáâãäåæçèéêëìíîïðòóôõöøùúûüýþß';
+
+// RegExp and RegExp part constants
+
+// TODO:
+//   regexAstralSymbols = /[\uD800-\uDBFF][\uDC00-\uDFFF]/g;
+//   "-~.,`'\"‘’“”„±€$@%&¡¿©®"
+//   REP_PUNCTUATION = ",.¡!¿?;:-";
+
+export const C = {
+  EXT_LATIN_TOKENS_LC,
+  REP_NUMBER: '0-9',
+  REP_LETTER_LC: `a-z${EXT_LATIN_TOKENS_LC}`,
+  REP_LETTER_NUMBER_LC: `0-9a-z${EXT_LATIN_TOKENS_LC}`
+};
+
+export const RE_EMAIL = new RegExp(
+  '^(([^<>()[\\]\\.,;:\\s@"]+(.[^<>()[\\]\\.,;:\\s@"]+)*)|(".+"))@((([' +
+    '\\-' +
+    C.REP_LETTER_NUMBER_LC +
+    ']+\\.)+[' +
+    C.REP_LETTER_LC +
+    ']{2,}))$',
+  'i'
+);
+
+// export const RE_URL = << TODO
+
+export const RE_PHONE =
+  /(^\+[0-9]{2}|^\+[0-9]{2}\(0\)|^\(\+[0-9]{2}\)\(0\)|^00[0-9]{2}|^0)([0-9]{9}$|[0-9\-\s]{10}$)/;
+
+export const RE_POSTCODE_DUTCH = /^[1-9]{1}[0-9]{3} ?[A-Za-z]{2}$/;
+
+export const RE_PLACE_DUTCH = new RegExp(
+  "^['`]{0,1}" +
+    `[${C.REP_LETTER_LC}]{0,}` +
+    '[-\\s]{0,1}' +
+    `[${C.REP_LETTER_LC}]{2,}$`,
+  'i'
+);
+
+// export const RE_NAME =
+//   new RegExp( `^[${C.REP_LETTER_LC}\\s-\`']{2,}$`, "i" );
+
+export const RE_NAME = new RegExp(
+  `^[${C.REP_LETTER_LC}]{1}` + `[${C.REP_LETTER_LC}\\s-\`'\\.]{0,}$`,
+  'i'
+);
+
+export const RE_FANTASY_NAME = new RegExp(
+  '^[' +
+    C.REP_LETTER_NUMBER_LC +
+    "\\x20!@#\\$%\\^&\\*\\(\\)-_+=\\|:;'\"'`~<,>.?/\\\\]{2,}$",
+  'i'
+);
+
+export const RE_ADDRESS = new RegExp(
+  '^[' + C.REP_LETTER_NUMBER_LC + '.,°\\s-]{2,}$',
+  'i'
+);
+
+export const RE_HAS_A_LETTER_OR_NUMBER = new RegExp('[a-z0-9]+', 'i');
+
+export const RE_MULTIPLE_SPACES = new RegExp('[\\s]{2,}', 'g');
+// export const RE_MULTIPLE_SPACES = /  +/g
+
+export const RE_LABEL = new RegExp('^[a-z0-9_-]{2,}$');
+
+export const RE_COLLECTION_NAME = new RegExp('^[a-z0-9\\s-_]{1,}$', 'i');
+
+export const RE_URI_COMPONENT = new RegExp(
+  '^[' + C.REP_LETTER_LC + '\\s-_]{1,}$',
+  'i'
+);
+
+//
+// @see https://usefulshortcuts.com/alt-codes/accents-alt-codes.php
+//