@cedx/base 0.3.0 → 0.4.0

package/ReadMe.md

@@ -1,5 +1,5 @@
 # Belin.io Base
-![.NET](https://badgen.net/badge/.net/%3E%3D9.0/green) ![Version](https://badgen.net/badge/project/v0.3.0/blue) ![Licence](https://badgen.net/badge/licence/MIT/blue)
+![.NET](https://badgen.net/badge/.net/%3E%3D9.0/green) ![Version](https://badgen.net/badge/project/v0.4.0/blue) ![Licence](https://badgen.net/badge/licence/MIT/blue)
 
 Base library by [Cédric Belin](https://belin.io), full stack developer,
 implemented in [C#](https://learn.microsoft.com/en-us/dotnet/csharp) and [TypeScript](https://www.typescriptlang.org).

package/lib/String.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Converts the first character to uppercase.
+ * @param value The string to process.
+ * @param locale The current locale.
+ * @returns The processed string.
+ */
+export declare function capitalize(value: string, locale?: Intl.Locale | string): string;
+/**
+ * Replaces all new lines in the specified value by HTML line breaks.
+ * @param value The string to format.
+ * @returns The formatted string.
+ */
+export declare function newLineToBr(value: string): string;
+/**
+ * Reverses the specified string.
+ * @param value The string to reverse.
+ * @returns The reversed string.
+ */
+export declare function reverse(value: string): string;
+/**
+ * Converts a string to an array.
+ * @param value The string to split into characters or chunks.
+ * @param splitLength The maximum length of the chunks.
+ * @returns An array whose elements contain the characters or chunks.
+ */
+export declare function split(value: string, splitLength?: number): string[];
+/**
+ * Removes the HTML tags from the specified string.
+ * @param value The string to process.
+ * @returns The processed string.
+ */
+export declare function stripTags(value: string): string;
+/**
+ * Removes whitespace from both ends of the items of the specified array.
+ * @param array The array to process.
+ * @returns The input array.
+ */
+export declare function trimArray<T>(array: T[]): T[];
+/**
+ * Removes whitespace from both ends of the properties of the specified object.
+ * @param object The object to process.
+ * @returns The input object.
+ */
+export declare function trimObject<T>(object: Record<string, T>): Record<string, T>;
+/**
+ * Truncates the specified string to the given number of characters.
+ * @param value The string to be truncated.
+ * @param length The maximum length.
+ * @param ellipsis The ellipsis to append to the truncated text.
+ * @returns The truncated string.
+ */
+export declare function truncate(value: string, length: number, ellipsis?: string): string;
+/**
+ * Replaces invalid XML characters in a string with their valid XML equivalent.
+ * @param value The string to process.
+ * @returns The processed string.
+ */
+export declare function xmlEscape(value: string): string;
+//# sourceMappingURL=String.d.ts.map

package/lib/String.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"String.d.ts","sourceRoot":"","sources":["../src/Client/String.ts"],"names":[],"mappings":"AAWA;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,GAAE,IAAI,CAAC,MAAM,GAAC,MAA2B,GAAG,MAAM,CAEjG;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAEjD;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAE7C;AAED;;;;;GAKG;AACH,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,SAAI,GAAG,MAAM,EAAE,CAE9D;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAE/C;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,CAG5C;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAG1E;AAED;;;;;;GAMG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,SAAQ,GAAG,MAAM,CAEhF;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAE/C"}

package/lib/String.js

@@ -0,0 +1,92 @@
+/**
+ * The mapping between special characters and the corresponding XML entities.
+ */
+const xmlEntities = new Map([
+    ["&", "&"],
+    ["<", "&lt;"],
+    [">", "&gt;"],
+    ['"', "&quot;"],
+    ["'", "&#39;"]
+]);
+/**
+ * Converts the first character to uppercase.
+ * @param value The string to process.
+ * @param locale The current locale.
+ * @returns The processed string.
+ */
+export function capitalize(value, locale = navigator.language) {
+    return value.charAt(0).toLocaleUpperCase(locale) + value.slice(1);
+}
+/**
+ * Replaces all new lines in the specified value by HTML line breaks.
+ * @param value The string to format.
+ * @returns The formatted string.
+ */
+export function newLineToBr(value) {
+    return value.split(/\r?\n/g).join("<br>");
+}
+/**
+ * Reverses the specified string.
+ * @param value The string to reverse.
+ * @returns The reversed string.
+ */
+export function reverse(value) {
+    return Array.from(value).reverse().join("");
+}
+/**
+ * Converts a string to an array.
+ * @param value The string to split into characters or chunks.
+ * @param splitLength The maximum length of the chunks.
+ * @returns An array whose elements contain the characters or chunks.
+ */
+export function split(value, splitLength = 1) {
+    return splitLength == 1 ? Array.from(value) : (value.match(new RegExp(`.{1,${splitLength}}`, "gsy")) ?? []);
+}
+/**
+ * Removes the HTML tags from the specified string.
+ * @param value The string to process.
+ * @returns The processed string.
+ */
+export function stripTags(value) {
+    return value.replace(/<[^>]+>/g, "");
+}
+/**
+ * Removes whitespace from both ends of the items of the specified array.
+ * @param array The array to process.
+ * @returns The input array.
+ */
+export function trimArray(array) {
+    for (const [index, value] of array.entries())
+        if (typeof value == "string")
+            Reflect.set(array, index, value.trim());
+    return array;
+}
+/**
+ * Removes whitespace from both ends of the properties of the specified object.
+ * @param object The object to process.
+ * @returns The input object.
+ */
+export function trimObject(object) {
+    for (const [key, value] of Object.entries(object))
+        if (typeof value == "string")
+            Reflect.set(object, key, value.trim());
+    return object;
+}
+/**
+ * Truncates the specified string to the given number of characters.
+ * @param value The string to be truncated.
+ * @param length The maximum length.
+ * @param ellipsis The ellipsis to append to the truncated text.
+ * @returns The truncated string.
+ */
+export function truncate(value, length, ellipsis = "...") {
+    return value.length > length ? value.slice(0, length) + ellipsis : value;
+}
+/**
+ * Replaces invalid XML characters in a string with their valid XML equivalent.
+ * @param value The string to process.
+ * @returns The processed string.
+ */
+export function xmlEscape(value) {
+    return value.replace(/[&<>"']/g, character => xmlEntities.get(character) ?? character);
+}

package/lib/UI/MenuActivator.d.ts

@@ -2,7 +2,6 @@
  * A component that activates the items of a menu based on the current document URL.
  */
 export declare class MenuActivator extends HTMLElement {
-    #private;
     /**
      * Method invoked when this component is connected.
      */

package/lib/UI/MenuActivator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MenuActivator.d.ts","sourceRoot":"","sources":["../../src/Client/UI/MenuActivator.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;;IAc7C;;OAEG;IACH,iBAAiB,IAAI,IAAI;CAQzB;AAED;;GAEG;AACH,OAAO,CAAC,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,qBAAqB;QAC9B,gBAAgB,EAAE,aAAa,CAAC;KAChC;CACD"}
+{"version":3,"file":"MenuActivator.d.ts","sourceRoot":"","sources":["../../src/Client/UI/MenuActivator.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAS7C;;OAEG;IACH,iBAAiB,IAAI,IAAI;CAQzB;AAED;;GAEG;AACH,OAAO,CAAC,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,qBAAqB;QAC9B,gBAAgB,EAAE,aAAa,CAAC;KAChC;CACD"}

package/lib/UI/MenuActivator.js

@@ -2,10 +2,6 @@
  * A component that activates the items of a menu based on the current document URL.
  */
 export class MenuActivator extends HTMLElement {
-    /**
-     * The root element.
-     */
-    #root = this.firstElementChild;
     /**
      * Registers the component.
      */
@@ -16,7 +12,7 @@ export class MenuActivator extends HTMLElement {
      * Method invoked when this component is connected.
      */
     connectedCallback() {
-        for (const anchor of this.#root.getElementsByTagName("a"))
+        for (const anchor of this.firstElementChild.getElementsByTagName("a"))
             if (anchor.href != location.href)
                 anchor.classList.remove("active");
             else {

package/package.json

@@ -7,7 +7,7 @@
 	"name": "@cedx/base",
 	"repository": "cedx/base",
 	"type": "module",
-	"version": "0.3.0",
+	"version": "0.4.0",
 	"devDependencies": {
 		"@playwright/browser-chromium": "^1.54.2",
 		"@types/bootstrap": "^5.2.10",

package/src/Client/String.ts

@@ -0,0 +1,97 @@
+/**
+ * The mapping between special characters and the corresponding XML entities.
+ */
+const xmlEntities = new Map([
+	["&", "&"],
+	["<", "&lt;"],
+	[">", "&gt;"],
+	['"', "&quot;"],
+	["'", "&#39;"]
+]);
+
+/**
+ * Converts the first character to uppercase.
+ * @param value The string to process.
+ * @param locale The current locale.
+ * @returns The processed string.
+ */
+export function capitalize(value: string, locale: Intl.Locale|string = navigator.language): string {
+	return value.charAt(0).toLocaleUpperCase(locale) + value.slice(1);
+}
+
+/**
+ * Replaces all new lines in the specified value by HTML line breaks.
+ * @param value The string to format.
+ * @returns The formatted string.
+ */
+export function newLineToBr(value: string): string {
+	return value.split(/\r?\n/g).join("<br>");
+}
+
+/**
+ * Reverses the specified string.
+ * @param value The string to reverse.
+ * @returns The reversed string.
+ */
+export function reverse(value: string): string {
+	return Array.from(value).reverse().join("");
+}
+
+/**
+ * Converts a string to an array.
+ * @param value The string to split into characters or chunks.
+ * @param splitLength The maximum length of the chunks.
+ * @returns An array whose elements contain the characters or chunks.
+ */
+export function split(value: string, splitLength = 1): string[] {
+	return splitLength == 1 ? Array.from(value) : (value.match(new RegExp(`.{1,${splitLength}}`, "gsy")) ?? []);
+}
+
+/**
+ * Removes the HTML tags from the specified string.
+ * @param value The string to process.
+ * @returns The processed string.
+ */
+export function stripTags(value: string): string {
+	return value.replace(/<[^>]+>/g, "");
+}
+
+/**
+ * Removes whitespace from both ends of the items of the specified array.
+ * @param array The array to process.
+ * @returns The input array.
+ */
+export function trimArray<T>(array: T[]): T[] {
+	for (const [index, value] of array.entries()) if (typeof value == "string") Reflect.set(array, index, value.trim());
+	return array;
+}
+
+/**
+ * Removes whitespace from both ends of the properties of the specified object.
+ * @param object The object to process.
+ * @returns The input object.
+ */
+export function trimObject<T>(object: Record<string, T>): Record<string, T> {
+	for (const [key, value] of Object.entries(object)) if (typeof value == "string") Reflect.set(object, key, value.trim());
+	return object;
+}
+
+/**
+ * Truncates the specified string to the given number of characters.
+ * @param value The string to be truncated.
+ * @param length The maximum length.
+ * @param ellipsis The ellipsis to append to the truncated text.
+ * @returns The truncated string.
+ */
+export function truncate(value: string, length: number, ellipsis = "..."): string {
+	return value.length > length ? value.slice(0, length) + ellipsis : value;
+}
+
+/**
+ * Replaces invalid XML characters in a string with their valid XML equivalent.
+ * @param value The string to process.
+ * @returns The processed string.
+ */
+export function xmlEscape(value: string): string {
+	return value.replace(/[&<>"']/g, character => xmlEntities.get(character) ?? character);
+}

package/src/Client/UI/MenuActivator.ts

@@ -3,11 +3,6 @@
  */
 export class MenuActivator extends HTMLElement {
 
-	/**
-	 * The root element.
-	 */
-	readonly #root = this.firstElementChild!;
-
 	/**
 	 * Registers the component.
 	 */
@@ -19,7 +14,7 @@ export class MenuActivator extends HTMLElement {
 	 * Method invoked when this component is connected.
 	 */
 	connectedCallback(): void {
-		for (const anchor of this.#root.getElementsByTagName("a"))
+		for (const anchor of this.firstElementChild!.getElementsByTagName("a"))
 			if (anchor.href != location.href) anchor.classList.remove("active");
 			else {
 				anchor.classList.add("active");

package/lib/Html/MenuAlignment.d.ts

@@ -1,18 +0,0 @@
-/**
- * Defines the alignment of a dropdown menu.
- */
-export declare const MenuAlignment: Readonly<{
-    /**
-     * The dropdown menu is right aligned.
-     */
-    End: "End";
-    /**
-     * The dropdown menu is left aligned.
-     */
-    Start: "Start";
-}>;
-/**
- * Defines the alignment of a dropdown menu.
- */
-export type MenuAlignment = typeof MenuAlignment[keyof typeof MenuAlignment];
-//# sourceMappingURL=MenuAlignment.d.ts.map

package/lib/Html/MenuAlignment.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"MenuAlignment.d.ts","sourceRoot":"","sources":["../../src/Client/Html/MenuAlignment.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,aAAa;IAEzB;;OAEG;;IAGH;;OAEG;;EAEF,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,aAAa,CAAC,MAAM,OAAO,aAAa,CAAC,CAAC"}

package/lib/Html/MenuAlignment.js

@@ -1,13 +0,0 @@
-/**
- * Defines the alignment of a dropdown menu.
- */
-export const MenuAlignment = Object.freeze({
-    /**
-     * The dropdown menu is right aligned.
-     */
-    End: "End",
-    /**
-     * The dropdown menu is left aligned.
-     */
-    Start: "Start"
-});

package/src/Client/Html/MenuAlignment.ts

@@ -1,20 +0,0 @@
-/**
- * Defines the alignment of a dropdown menu.
- */
-export const MenuAlignment = Object.freeze({
-
-	/**
-	 * The dropdown menu is right aligned.
-	 */
-	End: "End",
-
-	/**
-	 * The dropdown menu is left aligned.
-	 */
-	Start: "Start"
-});
-
-/**
- * Defines the alignment of a dropdown menu.
- */
-export type MenuAlignment = typeof MenuAlignment[keyof typeof MenuAlignment];