@ifto/mantine-kit 0.0.0-stage → 0.2.0

package/dist/util/EnumUtil.js

@@ -0,0 +1,32 @@
+"use client";
+// src/util/EnumUtil.ts
+/**
+* Returns the number values of an enum. Values of other types are not returned.
+* @param enumType enum to read the values from
+*/
+function getEnumValues(enumType) {
+	return Object.values(enumType).filter((value) => typeof value === "number");
+}
+/**
+* Returns the keys of an enum.
+* @param enumType enum to read the keys from
+* @template KeyType type of the returned keys. The keys are strings by default. To use them to read the enum values
+*           as an array (`MyEnum[key]`), use `keyof typeof MyEnum`.
+*/
+function getEnumKeys(enumType) {
+	return Object.values(enumType).filter((key) => typeof key === "string").map((key) => key);
+}
+/**
+* Returns a `Map` whose keys are the values of the enum items and whose values are the keys of these items.
+* @param enumType enum to read the entries from
+* @template KeyType type of the returned keys. The keys are strings by default. To use them to read the enum values
+*           as an array (`MyEnum[key]`), use `keyof typeof MyEnum`.
+*/
+function getEnumEntries(enumType) {
+	const map = /* @__PURE__ */ new Map();
+	Object.entries(enumType).filter(([, value]) => typeof value === "number").forEach(([key, value]) => map.set(value, key));
+	return map;
+}
+export { getEnumEntries, getEnumKeys, getEnumValues };
+
+//# sourceMappingURL=EnumUtil.js.map

package/dist/util/EnumUtil.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EnumUtil.js","names":[],"sources":["../../src/util/EnumUtil.ts"],"sourcesContent":["/**\n * Returns the number values of an enum. Values of other types are not returned.\n * @param enumType enum to read the values from\n */\nexport function getEnumValues(enumType: object): number[] {\n    return Object.values(enumType).filter(value => typeof value === 'number');\n}\n\n/**\n * Returns the keys of an enum.\n * @param enumType enum to read the keys from\n * @template KeyType type of the returned keys. The keys are strings by default. To use them to read the enum values\n *           as an array (`MyEnum[key]`), use `keyof typeof MyEnum`.\n */\nexport function getEnumKeys<KeyType = string>(enumType: object): KeyType[] {\n    return Object.values(enumType)\n        .filter(key => typeof key === 'string')\n        .map(key => key as KeyType);\n}\n\n/**\n * Returns a `Map` whose keys are the values of the enum items and whose values are the keys of these items.\n * @param enumType enum to read the entries from\n * @template KeyType type of the returned keys. The keys are strings by default. To use them to read the enum values\n *           as an array (`MyEnum[key]`), use `keyof typeof MyEnum`.\n */\nexport function getEnumEntries<KeyType = string>(enumType: object): Map<number, KeyType> {\n    const map = new Map<number, KeyType>();\n    Object.entries(enumType)\n        .filter(([, value]) => typeof value === 'number')\n        .forEach(([key, value]) => map.set(value, key as KeyType));\n\n    return map;\n}\n"],"mappings":";;;;;;AAIA,SAAgB,cAAc,UAA4B;CACtD,OAAO,OAAO,OAAO,QAAQ,CAAC,CAAC,QAAO,UAAS,OAAO,UAAU,QAAQ;AAC5E;;;;;;;AAQA,SAAgB,YAA8B,UAA6B;CACvE,OAAO,OAAO,OAAO,QAAQ,CAAC,CACzB,QAAO,QAAO,OAAO,QAAQ,QAAQ,CAAC,CACtC,KAAI,QAAO,GAAc;AAClC;;;;;;;AAQA,SAAgB,eAAiC,UAAwC;CACrF,MAAM,sBAAM,IAAI,IAAqB;CACrC,OAAO,QAAQ,QAAQ,CAAC,CACnB,QAAQ,GAAG,WAAW,OAAO,UAAU,QAAQ,CAAC,CAChD,SAAS,CAAC,KAAK,WAAW,IAAI,IAAI,OAAO,GAAc,CAAC;CAE7D,OAAO;AACX"}

package/dist/util/FormUtil.d.ts

@@ -0,0 +1,8 @@
+import type { UseFormReturnType } from '@mantine/form';
+import { Identifiable } from '../model/Identifiable';
+/**
+ * Fills a form with the data of a saved record. A record without an id (not saved yet) is ignored.
+ * @param initialize {@link UseFormReturnType#initialize} function of the form
+ * @param data data to fill the form with
+ */
+export declare function initForm<D extends Identifiable>(initialize: UseFormReturnType<D>['initialize'], data: D | null): void;

package/dist/util/FormUtil.js

@@ -0,0 +1,14 @@
+"use client";
+// src/util/FormUtil.ts
+/**
+* Fills a form with the data of a saved record. A record without an id (not saved yet) is ignored.
+* @param initialize {@link UseFormReturnType#initialize} function of the form
+* @param data data to fill the form with
+*/
+function initForm(initialize, data) {
+	if (!data?.id) return;
+	initialize(data);
+}
+export { initForm };
+
+//# sourceMappingURL=FormUtil.js.map

package/dist/util/FormUtil.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FormUtil.js","names":[],"sources":["../../src/util/FormUtil.ts"],"sourcesContent":["import type { UseFormReturnType } from '@mantine/form';\n\nimport { Identifiable } from '../model/Identifiable';\n\n/**\n * Fills a form with the data of a saved record. A record without an id (not saved yet) is ignored.\n * @param initialize {@link UseFormReturnType#initialize} function of the form\n * @param data data to fill the form with\n */\nexport function initForm<D extends Identifiable>(initialize: UseFormReturnType<D>['initialize'], data: D | null): void {\n    if (!data?.id) return;\n\n    initialize(data);\n}\n"],"mappings":";;;;;;;AASA,SAAgB,SAAiC,YAAgD,MAAsB;CACnH,IAAI,CAAC,MAAM,IAAI;CAEf,WAAW,IAAI;AACnB"}

package/dist/util/HtmlUtil.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Escapes the HTML special characters of a text, so it is shown as text, and not interpreted as HTML, when inserted in
+ * an HTML snippet built as a string (e.g. an ECharts tooltip). It prevents data typed by a user with a tag (e.g.
+ * `<img onerror=...>`) from running JavaScript (XSS).
+ * @param text text to escape
+ * @return the text with `&`, `<`, `>`, `"` and `'` replaced by the corresponding HTML entities
+ */
+export declare function escapeHtml(text: string): string;

package/dist/util/HtmlUtil.js

@@ -0,0 +1,23 @@
+"use client";
+// src/util/HtmlUtil.ts
+/** Characters with a special meaning in HTML and the entities that represent them as text. */
+var HTML_ENTITIES = {
+	"&": "&",
+	"<": "&lt;",
+	">": "&gt;",
+	"\"": "&quot;",
+	"'": "&#39;"
+};
+/**
+* Escapes the HTML special characters of a text, so it is shown as text, and not interpreted as HTML, when inserted in
+* an HTML snippet built as a string (e.g. an ECharts tooltip). It prevents data typed by a user with a tag (e.g.
+* `<img onerror=...>`) from running JavaScript (XSS).
+* @param text text to escape
+* @return the text with `&`, `<`, `>`, `"` and `'` replaced by the corresponding HTML entities
+*/
+function escapeHtml(text) {
+	return text.replace(/[&<>"']/g, (char) => HTML_ENTITIES[char]);
+}
+export { escapeHtml };
+
+//# sourceMappingURL=HtmlUtil.js.map

package/dist/util/HtmlUtil.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HtmlUtil.js","names":[],"sources":["../../src/util/HtmlUtil.ts"],"sourcesContent":["/** Characters with a special meaning in HTML and the entities that represent them as text. */\nconst HTML_ENTITIES: Record<string, string> = {\n    '&': '&amp;',\n    '<': '&lt;',\n    '>': '&gt;',\n    '\"': '&quot;',\n    \"'\": '&#39;'\n};\n\n/**\n * Escapes the HTML special characters of a text, so it is shown as text, and not interpreted as HTML, when inserted in\n * an HTML snippet built as a string (e.g. an ECharts tooltip). It prevents data typed by a user with a tag (e.g.\n * `<img onerror=...>`) from running JavaScript (XSS).\n * @param text text to escape\n * @return the text with `&`, `<`, `>`, `\"` and `'` replaced by the corresponding HTML entities\n */\nexport function escapeHtml(text: string): string {\n    return text.replace(/[&<>\"']/g, char => HTML_ENTITIES[char]);\n}\n"],"mappings":";;;AACA,IAAM,gBAAwC;CAC1C,KAAK;CACL,KAAK;CACL,KAAK;CACL,MAAK;CACL,KAAK;AACT;;;;;;;;AASA,SAAgB,WAAW,MAAsB;CAC7C,OAAO,KAAK,QAAQ,aAAY,SAAQ,cAAc,KAAK;AAC/D"}

package/dist/util/Notifications.d.ts

@@ -0,0 +1,30 @@
+import { hideNotification } from '@mantine/notifications';
+export { hideNotification };
+/**
+ * Shows a success message.
+ * @param message message of the notification
+ * @param title title of the notification; components give the one of their locale (`common.success`)
+ * @return the id of the notification, to hide it later with {@link hideNotification}
+ */
+export declare function showSuccessNotification(message: string, title?: string): string;
+/**
+ * Shows a warning: something that did not go as expected, but is not an error (e.g. an action done only in part).
+ * @param message message of the warning
+ * @param title title of the warning; components give the one of their locale (`common.warning`)
+ * @return the id of the notification, to hide it later with {@link hideNotification}
+ */
+export declare function showWarningNotification(message: string, title?: string): string;
+/**
+ * Shows an error.
+ * @param error error to show, used when there is no `message`
+ * @param message message of the notification; if absent, the message of the error
+ * @param title title of the notification; components give the one of their locale (`common.error`)
+ * @return the id of the notification, to hide it later with {@link hideNotification}
+ */
+export declare function showErrorNotification(error: unknown, message?: string, title?: string): string;
+/**
+ * Returns the message of an error, to show to the user.
+ * @param error the error, which may be an {@link Error}, an object with `message` or any other thrown value
+ * @return the `message` attribute of the error, if any, or the error itself converted to text
+ */
+export declare function errorMessage(error: unknown): string;

package/dist/util/Notifications.js

@@ -0,0 +1,59 @@
+"use client";
+import { DEFAULT_MESSAGES } from "../i18n/resolveMessages.js";
+import { hideNotification, showNotification } from "@mantine/notifications";
+// src/util/Notifications.tsx
+/**
+* Shows a success message.
+* @param message message of the notification
+* @param title title of the notification; components give the one of their locale (`common.success`)
+* @return the id of the notification, to hide it later with {@link hideNotification}
+*/
+function showSuccessNotification(message, title = DEFAULT_MESSAGES.common.success) {
+	return showNotification({
+		withBorder: true,
+		color: "green",
+		title,
+		message
+	});
+}
+/**
+* Shows a warning: something that did not go as expected, but is not an error (e.g. an action done only in part).
+* @param message message of the warning
+* @param title title of the warning; components give the one of their locale (`common.warning`)
+* @return the id of the notification, to hide it later with {@link hideNotification}
+*/
+function showWarningNotification(message, title = DEFAULT_MESSAGES.common.warning) {
+	return showNotification({
+		withBorder: true,
+		color: "yellow",
+		title,
+		message
+	});
+}
+/**
+* Shows an error.
+* @param error error to show, used when there is no `message`
+* @param message message of the notification; if absent, the message of the error
+* @param title title of the notification; components give the one of their locale (`common.error`)
+* @return the id of the notification, to hide it later with {@link hideNotification}
+*/
+function showErrorNotification(error, message, title = DEFAULT_MESSAGES.common.error) {
+	return showNotification({
+		withBorder: true,
+		color: "red",
+		title,
+		message: message ?? errorMessage(error)
+	});
+}
+/**
+* Returns the message of an error, to show to the user.
+* @param error the error, which may be an {@link Error}, an object with `message` or any other thrown value
+* @return the `message` attribute of the error, if any, or the error itself converted to text
+*/
+function errorMessage(error) {
+	if (typeof error === "object" && error !== null && "message" in error) return String(error.message);
+	return String(error);
+}
+export { errorMessage, hideNotification, showErrorNotification, showSuccessNotification, showWarningNotification };
+
+//# sourceMappingURL=Notifications.js.map

package/dist/util/Notifications.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Notifications.js","names":[],"sources":["../../src/util/Notifications.tsx"],"sourcesContent":["import { hideNotification, showNotification } from '@mantine/notifications';\n\nimport { DEFAULT_MESSAGES } from '../i18n/resolveMessages';\n\nexport { hideNotification };\n\n/**\n * Shows a success message.\n * @param message message of the notification\n * @param title title of the notification; components give the one of their locale (`common.success`)\n * @return the id of the notification, to hide it later with {@link hideNotification}\n */\nexport function showSuccessNotification(message: string, title: string = DEFAULT_MESSAGES.common.success): string {\n    return showNotification({\n        withBorder: true,\n        color: 'green',\n        title,\n        message\n    });\n}\n\n/**\n * Shows a warning: something that did not go as expected, but is not an error (e.g. an action done only in part).\n * @param message message of the warning\n * @param title title of the warning; components give the one of their locale (`common.warning`)\n * @return the id of the notification, to hide it later with {@link hideNotification}\n */\nexport function showWarningNotification(message: string, title: string = DEFAULT_MESSAGES.common.warning): string {\n    return showNotification({\n        withBorder: true,\n        color: 'yellow',\n        title,\n        message\n    });\n}\n\n/**\n * Shows an error.\n * @param error error to show, used when there is no `message`\n * @param message message of the notification; if absent, the message of the error\n * @param title title of the notification; components give the one of their locale (`common.error`)\n * @return the id of the notification, to hide it later with {@link hideNotification}\n */\nexport function showErrorNotification(\n    error: unknown,\n    message?: string,\n    title: string = DEFAULT_MESSAGES.common.error\n): string {\n    return showNotification({\n        withBorder: true,\n        color: 'red',\n        title,\n        message: message ?? errorMessage(error)\n    });\n}\n\n/**\n * Returns the message of an error, to show to the user.\n * @param error the error, which may be an {@link Error}, an object with `message` or any other thrown value\n * @return the `message` attribute of the error, if any, or the error itself converted to text\n */\nexport function errorMessage(error: unknown): string {\n    if (typeof error === 'object' && error !== null && 'message' in error) return String(error.message);\n    return String(error);\n}\n"],"mappings":";;;;;;;;;;AAYA,SAAgB,wBAAwB,SAAiB,QAAgB,iBAAiB,OAAO,SAAiB;CAC9G,OAAO,iBAAiB;EACpB,YAAY;EACZ,OAAO;EACP;EACA;CACJ,CAAC;AACL;;;;;;;AAQA,SAAgB,wBAAwB,SAAiB,QAAgB,iBAAiB,OAAO,SAAiB;CAC9G,OAAO,iBAAiB;EACpB,YAAY;EACZ,OAAO;EACP;EACA;CACJ,CAAC;AACL;;;;;;;;AASA,SAAgB,sBACZ,OACA,SACA,QAAgB,iBAAiB,OAAO,OAClC;CACN,OAAO,iBAAiB;EACpB,YAAY;EACZ,OAAO;EACP;EACA,SAAS,WAAW,aAAa,KAAK;CAC1C,CAAC;AACL;;;;;;AAOA,SAAgB,aAAa,OAAwB;CACjD,IAAI,OAAO,UAAU,YAAY,UAAU,QAAQ,aAAa,OAAO,OAAO,OAAO,MAAM,OAAO;CAClG,OAAO,OAAO,KAAK;AACvB"}

package/dist/util/NumberUtil.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Returns the fractional part of a number.
+ * @param value number to get the fractional part from
+ */
+declare function getDecimalPlaces(value: number): number;
+/**
+ * Checks whether a number has no fractional part.
+ * @param value number to check
+ */
+declare function hasNoDecimalPlaces(value: number): boolean;
+/**
+ * Formats a number according to a locale, with a fixed number of decimal places.
+ * @param number number to format
+ * @param minimumFractionDigits decimal places shown (the number is rounded to them)
+ * @param locale locale of the format; defaults to `en-US`
+ * @return the formatted number, such as "1.234,56" in `pt-BR` or "1,234.56" in `en-US`
+ */
+declare function numberFormat(number: number, minimumFractionDigits?: number, locale?: string): string;
+export { getDecimalPlaces, hasNoDecimalPlaces, numberFormat };

package/dist/util/NumberUtil.js

@@ -0,0 +1,33 @@
+"use client";
+import { DEFAULT_LOCALE } from "../i18n/KitLocale.js";
+// src/util/NumberUtil.ts
+/**
+* Returns the fractional part of a number.
+* @param value number to get the fractional part from
+*/
+function getDecimalPlaces(value) {
+	return value - Number(value.toFixed(0));
+}
+/**
+* Checks whether a number has no fractional part.
+* @param value number to check
+*/
+function hasNoDecimalPlaces(value) {
+	return getDecimalPlaces(value) === 0;
+}
+/**
+* Formats a number according to a locale, with a fixed number of decimal places.
+* @param number number to format
+* @param minimumFractionDigits decimal places shown (the number is rounded to them)
+* @param locale locale of the format; defaults to `en-US`
+* @return the formatted number, such as "1.234,56" in `pt-BR` or "1,234.56" in `en-US`
+*/
+function numberFormat(number, minimumFractionDigits = 2, locale = DEFAULT_LOCALE) {
+	return new Intl.NumberFormat(locale, {
+		minimumFractionDigits,
+		maximumFractionDigits: minimumFractionDigits
+	}).format(number);
+}
+export { getDecimalPlaces, hasNoDecimalPlaces, numberFormat };
+
+//# sourceMappingURL=NumberUtil.js.map

package/dist/util/NumberUtil.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NumberUtil.js","names":[],"sources":["../../src/util/NumberUtil.ts"],"sourcesContent":["import { DEFAULT_LOCALE } from '../i18n/KitLocale';\n\n/**\n * Returns the fractional part of a number.\n * @param value number to get the fractional part from\n */\nfunction getDecimalPlaces(value: number): number {\n    return value - Number(value.toFixed(0));\n}\n\n/**\n * Checks whether a number has no fractional part.\n * @param value number to check\n */\nfunction hasNoDecimalPlaces(value: number): boolean {\n    return getDecimalPlaces(value) === 0;\n}\n\n/**\n * Formats a number according to a locale, with a fixed number of decimal places.\n * @param number number to format\n * @param minimumFractionDigits decimal places shown (the number is rounded to them)\n * @param locale locale of the format; defaults to `en-US`\n * @return the formatted number, such as \"1.234,56\" in `pt-BR` or \"1,234.56\" in `en-US`\n */\nfunction numberFormat(number: number, minimumFractionDigits: number = 2, locale: string = DEFAULT_LOCALE): string {\n    const formatter = new Intl.NumberFormat(locale, {\n        minimumFractionDigits,\n        maximumFractionDigits: minimumFractionDigits\n    });\n    return formatter.format(number);\n}\n\nexport { getDecimalPlaces, hasNoDecimalPlaces, numberFormat };\n"],"mappings":";;;;;;;AAMA,SAAS,iBAAiB,OAAuB;CAC7C,OAAO,QAAQ,OAAO,MAAM,QAAQ,CAAC,CAAC;AAC1C;;;;;AAMA,SAAS,mBAAmB,OAAwB;CAChD,OAAO,iBAAiB,KAAK,MAAM;AACvC;;;;;;;;AASA,SAAS,aAAa,QAAgB,wBAAgC,GAAG,SAAiB,gBAAwB;CAK9G,OAAO,IAJe,KAAK,aAAa,QAAQ;EAC5C;EACA,uBAAuB;CAC3B,CACO,CAAA,CAAU,OAAO,MAAM;AAClC"}

package/dist/util/ObjectUtil.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Plain object, whose attributes can be read and assigned by name.
+ */
+type PlainObject = Record<string, unknown>;
+/**
+ * Checks whether a value is a plain object (a `{}` literal), and not an array, `null`, a date, a function etc.
+ * Only plain objects are merged recursively by {@link mergeDeep}.
+ * @param value value to check
+ * @return `true` if the value is a plain object, which can be merged recursively
+ */
+export declare function isPlainObject(value: unknown): value is PlainObject;
+/**
+ * Merges two objects recursively, returning a new object without changing the original ones.
+ * The attributes of `override` take precedence over the ones of `base`. When an attribute is a plain object in both,
+ * they are merged recursively; otherwise (including arrays), the value of `override` replaces the one of `base`.
+ * `undefined` attributes in `override` are ignored, keeping the value of `base`.
+ * @param base object with the default values
+ * @param override object with the values that replace the ones of `base`
+ * @return a new object with both merged
+ */
+export declare function mergeDeep<T extends object>(base: T, override: Partial<T>): T;
+export {};

package/dist/util/ObjectUtil.js

@@ -0,0 +1,34 @@
+"use client";
+// src/util/ObjectUtil.ts
+/**
+* Checks whether a value is a plain object (a `{}` literal), and not an array, `null`, a date, a function etc.
+* Only plain objects are merged recursively by {@link mergeDeep}.
+* @param value value to check
+* @return `true` if the value is a plain object, which can be merged recursively
+*/
+function isPlainObject(value) {
+	if (value === null || typeof value !== "object") return false;
+	const prototype = Object.getPrototypeOf(value);
+	return prototype === Object.prototype || prototype === null;
+}
+/**
+* Merges two objects recursively, returning a new object without changing the original ones.
+* The attributes of `override` take precedence over the ones of `base`. When an attribute is a plain object in both,
+* they are merged recursively; otherwise (including arrays), the value of `override` replaces the one of `base`.
+* `undefined` attributes in `override` are ignored, keeping the value of `base`.
+* @param base object with the default values
+* @param override object with the values that replace the ones of `base`
+* @return a new object with both merged
+*/
+function mergeDeep(base, override) {
+	const result = { ...base };
+	for (const [key, overrideValue] of Object.entries(override)) {
+		if (overrideValue === void 0) continue;
+		const baseValue = result[key];
+		result[key] = isPlainObject(baseValue) && isPlainObject(overrideValue) ? mergeDeep(baseValue, overrideValue) : overrideValue;
+	}
+	return result;
+}
+export { isPlainObject, mergeDeep };
+
+//# sourceMappingURL=ObjectUtil.js.map

package/dist/util/ObjectUtil.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ObjectUtil.js","names":[],"sources":["../../src/util/ObjectUtil.ts"],"sourcesContent":["/**\n * Plain object, whose attributes can be read and assigned by name.\n */\ntype PlainObject = Record<string, unknown>;\n\n/**\n * Checks whether a value is a plain object (a `{}` literal), and not an array, `null`, a date, a function etc.\n * Only plain objects are merged recursively by {@link mergeDeep}.\n * @param value value to check\n * @return `true` if the value is a plain object, which can be merged recursively\n */\nexport function isPlainObject(value: unknown): value is PlainObject {\n    if (value === null || typeof value !== 'object') return false;\n    const prototype = Object.getPrototypeOf(value);\n\n    return prototype === Object.prototype || prototype === null;\n}\n\n/**\n * Merges two objects recursively, returning a new object without changing the original ones.\n * The attributes of `override` take precedence over the ones of `base`. When an attribute is a plain object in both,\n * they are merged recursively; otherwise (including arrays), the value of `override` replaces the one of `base`.\n * `undefined` attributes in `override` are ignored, keeping the value of `base`.\n * @param base object with the default values\n * @param override object with the values that replace the ones of `base`\n * @return a new object with both merged\n */\nexport function mergeDeep<T extends object>(base: T, override: Partial<T>): T {\n    const result = { ...base } as PlainObject;\n\n    for (const [key, overrideValue] of Object.entries(override)) {\n        if (overrideValue === undefined) continue;\n\n        const baseValue = result[key];\n        result[key] =\n            isPlainObject(baseValue) && isPlainObject(overrideValue)\n                ? mergeDeep(baseValue, overrideValue)\n                : overrideValue;\n    }\n\n    return result as T;\n}\n"],"mappings":";;;;;;;;AAWA,SAAgB,cAAc,OAAsC;CAChE,IAAI,UAAU,QAAQ,OAAO,UAAU,UAAU,OAAO;CACxD,MAAM,YAAY,OAAO,eAAe,KAAK;CAE7C,OAAO,cAAc,OAAO,aAAa,cAAc;AAC3D;;;;;;;;;;AAWA,SAAgB,UAA4B,MAAS,UAAyB;CAC1E,MAAM,SAAS,EAAE,GAAG,KAAK;CAEzB,KAAK,MAAM,CAAC,KAAK,kBAAkB,OAAO,QAAQ,QAAQ,GAAG;EACzD,IAAI,kBAAkB,KAAA,GAAW;EAEjC,MAAM,YAAY,OAAO;EACzB,OAAO,OACH,cAAc,SAAS,KAAK,cAAc,aAAa,IACjD,UAAU,WAAW,aAAa,IAClC;CACd;CAEA,OAAO;AACX"}

package/dist/util/SearchParamsUtil.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Query string in the format of the `searchParams` prop that Next.js gives to pages (in a `Promise`, since Next.js
+ * 15): each parameter has a value, an array of values (when it repeats in the URL) or `undefined` (when it is absent).
+ */
+type SearchParams = Record<string, string | string[] | undefined>;
+/**
+ * Returns the value of a query string parameter received by a page.
+ * @param searchParams URL parameters, as received by the page (already resolved with `use()` or `await`)
+ * @param name name of the parameter
+ * @return the value of the parameter; the first one, if it repeats in the URL; or `null`, if it is absent
+ */
+declare function getSearchParam(searchParams: SearchParams, name: string): string | null;
+/** Value of a parameter when building a URL. `undefined`, `null` and an empty string leave the parameter out. */
+type SearchParamValue = number | string | null | undefined;
+/**
+ * Builds a URL with the query string of the parameters that have a value.
+ * @param path path of the page
+ * @param params parameters indexed by name; the ones without a value ({@link SearchParamValue}) are left out
+ * @return the path with the query string, or just the path if no parameter has a value
+ */
+declare function buildUrl(path: string, params: Record<string, SearchParamValue>): string;
+export type { SearchParams, SearchParamValue };
+export { buildUrl, getSearchParam };

package/dist/util/SearchParamsUtil.js

@@ -0,0 +1,29 @@
+"use client";
+// src/util/SearchParamsUtil.ts
+/**
+* Returns the value of a query string parameter received by a page.
+* @param searchParams URL parameters, as received by the page (already resolved with `use()` or `await`)
+* @param name name of the parameter
+* @return the value of the parameter; the first one, if it repeats in the URL; or `null`, if it is absent
+*/
+function getSearchParam(searchParams, name) {
+	const value = searchParams[name];
+	return (Array.isArray(value) ? value[0] : value) ?? null;
+}
+/**
+* Builds a URL with the query string of the parameters that have a value.
+* @param path path of the page
+* @param params parameters indexed by name; the ones without a value ({@link SearchParamValue}) are left out
+* @return the path with the query string, or just the path if no parameter has a value
+*/
+function buildUrl(path, params) {
+	const query = new URLSearchParams();
+	Object.entries(params).forEach(([name, value]) => {
+		if (value !== void 0 && value !== null && value !== "") query.set(name, String(value));
+	});
+	const queryString = query.toString();
+	return queryString ? `${path}?${queryString}` : path;
+}
+export { buildUrl, getSearchParam };
+
+//# sourceMappingURL=SearchParamsUtil.js.map

package/dist/util/SearchParamsUtil.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SearchParamsUtil.js","names":[],"sources":["../../src/util/SearchParamsUtil.ts"],"sourcesContent":["/**\n * Query string in the format of the `searchParams` prop that Next.js gives to pages (in a `Promise`, since Next.js\n * 15): each parameter has a value, an array of values (when it repeats in the URL) or `undefined` (when it is absent).\n */\ntype SearchParams = Record<string, string | string[] | undefined>;\n\n/**\n * Returns the value of a query string parameter received by a page.\n * @param searchParams URL parameters, as received by the page (already resolved with `use()` or `await`)\n * @param name name of the parameter\n * @return the value of the parameter; the first one, if it repeats in the URL; or `null`, if it is absent\n */\nfunction getSearchParam(searchParams: SearchParams, name: string): string | null {\n    const value = searchParams[name];\n    return (Array.isArray(value) ? value[0] : value) ?? null;\n}\n\n/** Value of a parameter when building a URL. `undefined`, `null` and an empty string leave the parameter out. */\ntype SearchParamValue = number | string | null | undefined;\n\n/**\n * Builds a URL with the query string of the parameters that have a value.\n * @param path path of the page\n * @param params parameters indexed by name; the ones without a value ({@link SearchParamValue}) are left out\n * @return the path with the query string, or just the path if no parameter has a value\n */\nfunction buildUrl(path: string, params: Record<string, SearchParamValue>): string {\n    const query = new URLSearchParams();\n    Object.entries(params).forEach(([name, value]) => {\n        if (value !== undefined && value !== null && value !== '') query.set(name, String(value));\n    });\n\n    const queryString = query.toString();\n    return queryString ? `${path}?${queryString}` : path;\n}\n\nexport type { SearchParams, SearchParamValue };\nexport { buildUrl, getSearchParam };\n"],"mappings":";;;;;;;;AAYA,SAAS,eAAe,cAA4B,MAA6B;CAC7E,MAAM,QAAQ,aAAa;CAC3B,QAAQ,MAAM,QAAQ,KAAK,IAAI,MAAM,KAAK,UAAU;AACxD;;;;;;;AAWA,SAAS,SAAS,MAAc,QAAkD;CAC9E,MAAM,QAAQ,IAAI,gBAAgB;CAClC,OAAO,QAAQ,MAAM,CAAC,CAAC,SAAS,CAAC,MAAM,WAAW;EAC9C,IAAI,UAAU,KAAA,KAAa,UAAU,QAAQ,UAAU,IAAI,MAAM,IAAI,MAAM,OAAO,KAAK,CAAC;CAC5F,CAAC;CAED,MAAM,cAAc,MAAM,SAAS;CACnC,OAAO,cAAc,GAAG,KAAK,GAAG,gBAAgB;AACpD"}

package/dist/util/TransformData.d.ts

@@ -0,0 +1,14 @@
+import { ReactNode } from 'react';
+/** Converts the dates of the form data, without changing the input or the structure of the arrays. */
+export declare function formatValues(obj: object): Record<string, unknown>;
+/**
+ * If the props of a component have no `placeholder`, builds the placeholder from the `label` prop (e.g. the label
+ * "Region" gives "Select the Region" in `en-US`). It is not a React hook: it just transforms the given props.
+ * @param placeholder function that builds the placeholder from the label
+ * @param props props of the component
+ * @return a copy of the props, with the given placeholder or the one built from the label
+ */
+export declare const withPlaceholderFromLabel: <P extends {
+    placeholder?: string;
+    label?: ReactNode;
+}>(placeholder: (label: string) => string, props: P) => P;

package/dist/util/TransformData.js

@@ -0,0 +1,31 @@
+"use client";
+import { formatDateToISO } from "./DateUtil.js";
+// src/util/TransformData.ts
+/**
+* Converts a form value to the format sent to the backend: dates in ISO 8601, recursively inside arrays and objects.
+* @param value value of a form field
+*/
+function formatValue(value) {
+	if (value instanceof Date) return formatDateToISO(value);
+	if (Array.isArray(value)) return value.map(formatValue);
+	if (typeof value === "object" && value !== null) return formatValues(value);
+	return value;
+}
+/** Converts the dates of the form data, without changing the input or the structure of the arrays. */
+function formatValues(obj) {
+	return Object.fromEntries(Object.entries(obj).map(([key, value]) => [key, formatValue(value)]));
+}
+/**
+* If the props of a component have no `placeholder`, builds the placeholder from the `label` prop (e.g. the label
+* "Region" gives "Select the Region" in `en-US`). It is not a React hook: it just transforms the given props.
+* @param placeholder function that builds the placeholder from the label
+* @param props props of the component
+* @return a copy of the props, with the given placeholder or the one built from the label
+*/
+var withPlaceholderFromLabel = (placeholder, props) => ({
+	...props,
+	placeholder: props.placeholder || placeholder(String(props.label))
+});
+export { formatValues, withPlaceholderFromLabel };
+
+//# sourceMappingURL=TransformData.js.map

package/dist/util/TransformData.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TransformData.js","names":[],"sources":["../../src/util/TransformData.ts"],"sourcesContent":["import { ReactNode } from 'react';\n\nimport { formatDateToISO } from './DateUtil';\n\n/**\n * Converts a form value to the format sent to the backend: dates in ISO 8601, recursively inside arrays and objects.\n * @param value value of a form field\n */\nfunction formatValue(value: unknown): unknown {\n    if (value instanceof Date) return formatDateToISO(value);\n    if (Array.isArray(value)) return value.map(formatValue);\n    if (typeof value === 'object' && value !== null) return formatValues(value);\n\n    return value;\n}\n\n/** Converts the dates of the form data, without changing the input or the structure of the arrays. */\nexport function formatValues(obj: object): Record<string, unknown> {\n    return Object.fromEntries(Object.entries(obj).map(([key, value]) => [key, formatValue(value)]));\n}\n\n/**\n * If the props of a component have no `placeholder`, builds the placeholder from the `label` prop (e.g. the label\n * \"Region\" gives \"Select the Region\" in `en-US`). It is not a React hook: it just transforms the given props.\n * @param placeholder function that builds the placeholder from the label\n * @param props props of the component\n * @return a copy of the props, with the given placeholder or the one built from the label\n */\nexport const withPlaceholderFromLabel = <P extends { placeholder?: string; label?: ReactNode }>(\n    placeholder: (label: string) => string,\n    props: P\n): P => ({ ...props, placeholder: props.placeholder || placeholder(String(props.label)) });\n"],"mappings":";;;;;;;AAQA,SAAS,YAAY,OAAyB;CAC1C,IAAI,iBAAiB,MAAM,OAAO,gBAAgB,KAAK;CACvD,IAAI,MAAM,QAAQ,KAAK,GAAG,OAAO,MAAM,IAAI,WAAW;CACtD,IAAI,OAAO,UAAU,YAAY,UAAU,MAAM,OAAO,aAAa,KAAK;CAE1E,OAAO;AACX;;AAGA,SAAgB,aAAa,KAAsC;CAC/D,OAAO,OAAO,YAAY,OAAO,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,KAAK,WAAW,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC;AAClG;;;;;;;;AASA,IAAa,4BACT,aACA,WACK;CAAE,GAAG;CAAO,aAAa,MAAM,eAAe,YAAY,OAAO,MAAM,KAAK,CAAC;AAAE"}

package/dist/util/ValidationUtil.d.ts

@@ -0,0 +1,9 @@
+import { z } from 'zod';
+/**
+ * Creates the validation rule of a required field that stores the id of an item chosen in a select (e.g. the region
+ * of a city). The field starts with `0` (nothing chosen) and receives `null` when the select is cleared; in both cases,
+ * the validation fails with the given message.
+ * @param message message shown in the field when no valid item was chosen
+ * @return the Zod schema that accepts only positive integer ids
+ */
+export declare function selectedId(message: string): z.ZodNumberFormat;

package/dist/util/ValidationUtil.js

@@ -0,0 +1,16 @@
+"use client";
+import { z } from "zod";
+// src/util/ValidationUtil.ts
+/**
+* Creates the validation rule of a required field that stores the id of an item chosen in a select (e.g. the region
+* of a city). The field starts with `0` (nothing chosen) and receives `null` when the select is cleared; in both cases,
+* the validation fails with the given message.
+* @param message message shown in the field when no valid item was chosen
+* @return the Zod schema that accepts only positive integer ids
+*/
+function selectedId(message) {
+	return z.int({ error: message }).positive({ error: message });
+}
+export { selectedId };
+
+//# sourceMappingURL=ValidationUtil.js.map

package/dist/util/ValidationUtil.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ValidationUtil.js","names":[],"sources":["../../src/util/ValidationUtil.ts"],"sourcesContent":["import { z } from 'zod';\n\n/**\n * Creates the validation rule of a required field that stores the id of an item chosen in a select (e.g. the region\n * of a city). The field starts with `0` (nothing chosen) and receives `null` when the select is cleared; in both cases,\n * the validation fails with the given message.\n * @param message message shown in the field when no valid item was chosen\n * @return the Zod schema that accepts only positive integer ids\n */\nexport function selectedId(message: string): z.ZodNumberFormat {\n    return z.int({ error: message }).positive({ error: message });\n}\n"],"mappings":";;;;;;;;;;AASA,SAAgB,WAAW,SAAoC;CAC3D,OAAO,EAAE,IAAI,EAAE,OAAO,QAAQ,CAAC,CAAC,CAAC,SAAS,EAAE,OAAO,QAAQ,CAAC;AAChE"}

package/dist/util/parseActionsPageParams.d.ts

@@ -0,0 +1,14 @@
+import { FormType } from '../component/template/FormPage/FormType';
+import { FormRouteSegments } from '../router/FormRouteSegments';
+/** Action of a form page, read from the URL: create, edit or view, with the record id in the last two. */
+export type FormRoute = {
+    action: FormType;
+    id?: string;
+};
+/**
+ * Converts the segments of the catch-all route of a feature (e.g. `create`, `edit/:id`, `view/:id`) to the
+ * form action. Throws an error if the segments do not form one of these routes.
+ * @param params URL segments after the route of the feature (e.g. `['edit', '5']`)
+ * @param segments names of the create, edit and view segments; defaults to {@link DEFAULT_FORM_ROUTE_SEGMENTS}
+ */
+export declare function parseActionsPageParams(params: string[] | string | null | undefined, segments?: FormRouteSegments): FormRoute;

package/dist/util/parseActionsPageParams.js

@@ -0,0 +1,29 @@
+"use client";
+import { FormType } from "../component/template/FormPage/FormType.js";
+import { DEFAULT_FORM_ROUTE_SEGMENTS } from "../router/FormRouteSegments.js";
+// src/util/parseActionsPageParams.ts
+/**
+* Converts the segments of the catch-all route of a feature (e.g. `create`, `edit/:id`, `view/:id`) to the
+* form action. Throws an error if the segments do not form one of these routes.
+* @param params URL segments after the route of the feature (e.g. `['edit', '5']`)
+* @param segments names of the create, edit and view segments; defaults to {@link DEFAULT_FORM_ROUTE_SEGMENTS}
+*/
+function parseActionsPageParams(params, segments = DEFAULT_FORM_ROUTE_SEGMENTS) {
+	const slugItems = Array.isArray(params) ? params : [params ?? ""];
+	const type = slugItems[0];
+	const id = slugItems[1];
+	if (id && type === segments.edit) return {
+		action: FormType.Edit,
+		id
+	};
+	if (id && type === segments.view) return {
+		action: FormType.View,
+		id
+	};
+	if (type === segments.create) return { action: FormType.Create };
+	const msg = slugItems.length == 1 && slugItems[0] == "" ? "Missing params" : "Invalid params: " + slugItems;
+	throw new Error(msg);
+}
+export { parseActionsPageParams };
+
+//# sourceMappingURL=parseActionsPageParams.js.map

package/dist/util/parseActionsPageParams.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parseActionsPageParams.js","names":[],"sources":["../../src/util/parseActionsPageParams.ts"],"sourcesContent":["import { FormType } from '../component/template/FormPage/FormType';\nimport { DEFAULT_FORM_ROUTE_SEGMENTS, FormRouteSegments } from '../router/FormRouteSegments';\n\n/** Action of a form page, read from the URL: create, edit or view, with the record id in the last two. */\nexport type FormRoute = { action: FormType; id?: string };\n\n/**\n * Converts the segments of the catch-all route of a feature (e.g. `create`, `edit/:id`, `view/:id`) to the\n * form action. Throws an error if the segments do not form one of these routes.\n * @param params URL segments after the route of the feature (e.g. `['edit', '5']`)\n * @param segments names of the create, edit and view segments; defaults to {@link DEFAULT_FORM_ROUTE_SEGMENTS}\n */\nexport function parseActionsPageParams(\n    params: string[] | string | null | undefined,\n    segments: FormRouteSegments = DEFAULT_FORM_ROUTE_SEGMENTS\n): FormRoute {\n    const slugItems = Array.isArray(params) ? params : [params ?? ''];\n    const type = slugItems[0];\n    const id = slugItems[1];\n\n    if (id && type === segments.edit) {\n        return { action: FormType.Edit, id };\n    }\n    if (id && type === segments.view) {\n        return { action: FormType.View, id };\n    }\n    if (type === segments.create) {\n        return { action: FormType.Create };\n    }\n\n    // An array with a single empty element means that no parameter was given.\n    const msg = slugItems.length == 1 && slugItems[0] == '' ? 'Missing params' : 'Invalid params: ' + slugItems;\n    throw new Error(msg);\n}\n"],"mappings":";;;;;;;;;;AAYA,SAAgB,uBACZ,QACA,WAA8B,6BACrB;CACT,MAAM,YAAY,MAAM,QAAQ,MAAM,IAAI,SAAS,CAAC,UAAU,EAAE;CAChE,MAAM,OAAO,UAAU;CACvB,MAAM,KAAK,UAAU;CAErB,IAAI,MAAM,SAAS,SAAS,MACxB,OAAO;EAAE,QAAQ,SAAS;EAAM;CAAG;CAEvC,IAAI,MAAM,SAAS,SAAS,MACxB,OAAO;EAAE,QAAQ,SAAS;EAAM;CAAG;CAEvC,IAAI,SAAS,SAAS,QAClB,OAAO,EAAE,QAAQ,SAAS,OAAO;CAIrC,MAAM,MAAM,UAAU,UAAU,KAAK,UAAU,MAAM,KAAK,mBAAmB,qBAAqB;CAClG,MAAM,IAAI,MAAM,GAAG;AACvB"}