@tmlmobilidade/strings 20251202.1817.5

package/dist/generate-random-number.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Generates a secure random number between 0 and 1.
+ * This function uses the Web Crypto API so it is suitable
+ * for cryptographic purposes.
+ * @returns A random number between 0 and 1
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/Crypto/getRandomValues
+ */
+export declare function generateRandomNumber(): number;

package/dist/generate-random-number.js

@@ -0,0 +1,14 @@
+/* * */
+import crypto from 'crypto';
+/**
+ * Generates a secure random number between 0 and 1.
+ * This function uses the Web Crypto API so it is suitable
+ * for cryptographic purposes.
+ * @returns A random number between 0 and 1
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/Crypto/getRandomValues
+ */
+export function generateRandomNumber() {
+    const array = new Uint32Array(1);
+    crypto.getRandomValues(array);
+    return array[0] / 2 ** 32;
+}

package/dist/generate-random-string.d.ts

@@ -0,0 +1,12 @@
+interface GenerateRandomStringProps {
+    length?: number;
+    type?: 'alphabetic' | 'alphanumeric' | 'numeric';
+}
+/**
+ * Creates a random string of a given length and type.
+ * @param length The length of the string to generate. Defaults to `6`.
+ * @param type The type of characters to include in the string. Defaults to `alphanumeric`.
+ * @returns A random string of the specified length.
+ */
+export declare function generateRandomString({ length, type }?: GenerateRandomStringProps): string;
+export {};

package/dist/generate-random-string.js

@@ -0,0 +1,32 @@
+/* * */
+import { generateRandomNumber } from './generate-random-number.js';
+/**
+ * Creates a random string of a given length and type.
+ * @param length The length of the string to generate. Defaults to `6`.
+ * @param type The type of characters to include in the string. Defaults to `alphanumeric`.
+ * @returns A random string of the specified length.
+ */
+export function generateRandomString({ length = 6, type = 'alphanumeric' } = {}) {
+    //
+    const numericSet = '0123456789';
+    const alphabeticSet = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
+    const alphanumericSet = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789';
+    let allowedCharacters;
+    switch (type) {
+        case 'alphabetic':
+            allowedCharacters = alphabeticSet;
+            break;
+        case 'numeric':
+            allowedCharacters = numericSet;
+            break;
+        default:
+            allowedCharacters = alphanumericSet;
+            break;
+    }
+    let result = '';
+    for (let i = 0; i < length; i++) {
+        result += allowedCharacters.charAt(Math.floor(generateRandomNumber() * allowedCharacters.length));
+    }
+    return result;
+    //
+}

package/dist/generate-random-token.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Generates a secure random token.
+ * This function uses the Node.js crypto module to generate
+ * a random token suitable for cryptographic purposes.
+ * @returns A random token as a hexadecimal string.
+ * @see https://nodejs.org/api/crypto.html#crypto_crypto_randombytes_size_callback
+ */
+export declare function generateRandomToken(): string;

package/dist/generate-random-token.js

@@ -0,0 +1,12 @@
+/* * */
+import crypto from 'crypto';
+/**
+ * Generates a secure random token.
+ * This function uses the Node.js crypto module to generate
+ * a random token suitable for cryptographic purposes.
+ * @returns A random token as a hexadecimal string.
+ * @see https://nodejs.org/api/crypto.html#crypto_crypto_randombytes_size_callback
+ */
+export function generateRandomToken() {
+    return crypto.randomBytes(32).toString('hex');
+}

package/dist/humanize.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Utility function that returns a humanized version of a string.
+ * @param value The string to humanize. Ex: `ThisIsAString`
+ * @returns The humanized string. Ex: `This Is A String`
+ */
+export declare function humanize(value: string): string;

package/dist/humanize.js

@@ -0,0 +1,13 @@
+/**
+ * Utility function that returns a humanized version of a string.
+ * @param value The string to humanize. Ex: `ThisIsAString`
+ * @returns The humanized string. Ex: `This Is A String`
+ */
+export function humanize(value) {
+    const str = value
+        .replace(/([a-z\d])([A-Z]+)/g, '$1 $2')
+        .replace(/\W|_/g, ' ')
+        .trim()
+        .toLowerCase();
+    return `${str.charAt(0).toUpperCase()}${str.slice(1)}`;
+}

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export * from './generate-random-number.js';
+export * from './generate-random-string.js';
+export * from './generate-random-token.js';
+export * from './humanize.js';
+export * from './normalize.js';
+export * from './truncate.js';
+export * from './validation.js';

package/dist/index.js

@@ -0,0 +1,7 @@
+export * from './generate-random-number.js';
+export * from './generate-random-string.js';
+export * from './generate-random-token.js';
+export * from './humanize.js';
+export * from './normalize.js';
+export * from './truncate.js';
+export * from './validation.js';

package/dist/normalize.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Normalizes a string by converting it to lowercase, removing diacritics,
+ * and replacing accented characters with their non-accented equivalents.
+ * This is useful for case-insensitive and accent-insensitive string comparisons.
+ * @param value The string to normalize. Ex: `Café`
+ * @returns The normalized string. Ex: `cafe`
+ */
+export declare function normalizeString(value: string): string;

package/dist/normalize.js

@@ -0,0 +1,17 @@
+/**
+ * Normalizes a string by converting it to lowercase, removing diacritics,
+ * and replacing accented characters with their non-accented equivalents.
+ * This is useful for case-insensitive and accent-insensitive string comparisons.
+ * @param value The string to normalize. Ex: `Café`
+ * @returns The normalized string. Ex: `cafe`
+ */
+export function normalizeString(value) {
+    // Return an empty string if the value is invalid
+    if (typeof value !== 'string')
+        return '';
+    // Normalize the string
+    return value
+        .toLowerCase()
+        .normalize('NFD')
+        .replace(/[\u0300-\u036f]/g, '');
+}

package/dist/truncate.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Truncates a string to a specified length and adds ellipsis if necessary.
+ * @param str The string to truncate.
+ * @param length The maximum length of the truncated string.
+ * @returns The truncated string with ellipsis if it exceeds the specified length, or the original string if it does not.
+ */
+export declare const truncate: (str: null | string, length: number) => null | string;

package/dist/truncate.js

@@ -0,0 +1,11 @@
+/**
+ * Truncates a string to a specified length and adds ellipsis if necessary.
+ * @param str The string to truncate.
+ * @param length The maximum length of the truncated string.
+ * @returns The truncated string with ellipsis if it exceeds the specified length, or the original string if it does not.
+ */
+export const truncate = (str, length) => {
+    if (!str || str.length <= length)
+        return str;
+    return `${str.slice(0, length - 3)}...`;
+};

package/dist/validation.d.ts

@@ -0,0 +1,2 @@
+export declare function isEmail(email: string): boolean;
+export declare function isUrl(url: string): boolean;

package/dist/validation.js

@@ -0,0 +1,9 @@
+/* * */
+import { z } from 'zod';
+/* * */
+export function isEmail(email) {
+    return z.string().email().safeParse(email).success;
+}
+export function isUrl(url) {
+    return z.string().url().safeParse(url).success;
+}

package/package.json

@@ -0,0 +1,48 @@
+{
+	"name": "@tmlmobilidade/strings",
+	"version": "20251202.1817.5",
+	"author": {
+		"email": "iso@tmlmobilidade.pt",
+		"name": "TML-ISO"
+	},
+	"license": "AGPL-3.0-or-later",
+	"homepage": "https://github.com/tmlmobilidade/go#readme",
+	"bugs": {
+		"url": "https://github.com/tmlmobilidade/go/issues"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/tmlmobilidade/go.git"
+	},
+	"keywords": [
+		"public transit",
+		"tml",
+		"transportes metropolitanos de lisboa",
+		"go"
+	],
+	"publishConfig": {
+		"access": "public"
+	},
+	"type": "module",
+	"files": [
+		"dist"
+	],
+	"main": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"scripts": {
+		"build": "tsc && resolve-tspaths",
+		"lint": "eslint ./src/ && tsc --noEmit",
+		"lint:fix": "eslint ./src/ --fix",
+		"watch": "tsc-watch --onSuccess 'resolve-tspaths'"
+	},
+	"dependencies": {
+		"zod": "3.25.76"
+	},
+	"devDependencies": {
+		"@tmlmobilidade/tsconfig": "*",
+		"@types/node": "24.10.1",
+		"resolve-tspaths": "0.8.23",
+		"tsc-watch": "7.2.0",
+		"typescript": "5.9.3"
+	}
+}