@tmlmobilidade/utils 20251031.1051.3 → 20251202.1817.5

package/dist/src/permissions.d.ts

@@ -1,46 +0,0 @@
-import { type Permission } from '@tmlmobilidade/types';
-/**
- * Get a permission from a list of permissions
- * @param permissions - The list of permissions
- * @param scope - The scope of the permission
- * @param action - The action of the permission
- * @returns The permission
- */
-export declare function getPermission(permissions: Permission<unknown>[], scope: string, action: string): Permission<unknown>;
-/**
- * Check if a permission exists in a list of permissions.
- * @param permissions The list of permissions.
- * @param scope The scope of the permission.
- * @param action The action of the permission.
- * @returns The permission object or undefined if not found.
- */
-export declare function hasPermission(permissions: Permission<unknown>[], scope: string, action: string): boolean;
-export interface HasPermissionResourceArgs<T> {
-    action: string;
-    permissions?: Permission<T>[];
-    resource_key: keyof T;
-    scope: string;
-    value: unknown;
-}
-type HasPermissionResourceArgsWithPermissions<T> = HasPermissionResourceArgs<T> & {
-    permissions: Permission<T>[];
-};
-/**
- * Check if a value exists in a resource of a permission
- * @param permissions - The list of permissions
- * @param value - The value to check
- * @param resource_key - The key of the resource
- * @param scope - The scope of the permission
- * @param action - The action of the permission
- * @returns The permission
- */
-export declare function hasPermissionResource<T>({ action, permissions, resource_key, scope, value }: HasPermissionResourceArgsWithPermissions<T>): boolean;
-/**
- * Ensure a permission is granted in a fastify request
- * @param request - The FastifyRequest
- * @param reply - The FastifyReply
- * @param params - The parameters of the permission
- * @returns The allowed
- */
-export declare function hasAPIResourcePermission<T>(request: any, params: HasPermissionResourceArgs<T>): boolean;
-export {};

package/dist/src/permissions.js

@@ -1,77 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-/* * */
-import { ALLOW_ALL_FLAG } from '@tmlmobilidade/lib';
-import { mergekit } from 'mergekit';
-/**
- * Get a permission from a list of permissions
- * @param permissions - The list of permissions
- * @param scope - The scope of the permission
- * @param action - The action of the permission
- * @returns The permission
- */
-export function getPermission(permissions, scope, action) {
-    return mergekit([...(permissions ?? [])], {
-        appendArrays: true,
-        dedupArrays: true,
-        onlyObjectWithKeyValues: [
-            { key: 'scope', value: scope },
-            { key: 'action', value: action },
-        ],
-    });
-}
-/**
- * Check if a permission exists in a list of permissions.
- * @param permissions The list of permissions.
- * @param scope The scope of the permission.
- * @param action The action of the permission.
- * @returns The permission object or undefined if not found.
- */
-export function hasPermission(permissions, scope, action) {
-    return permissions.find(permission => permission.scope === scope && permission.action === action) !== undefined;
-}
-/**
- * Check if a value exists in a resource of a permission
- * @param permissions - The list of permissions
- * @param value - The value to check
- * @param resource_key - The key of the resource
- * @param scope - The scope of the permission
- * @param action - The action of the permission
- * @returns The permission
- */
-export function hasPermissionResource({ action, permissions, resource_key, scope, value }) {
-    if (!permissions)
-        return false;
-    const permission = permissions.find(permission => permission.action === action && permission.scope === scope);
-    if (!permission)
-        return false;
-    // Check if value exists in the permission.resource[resource_key]
-    const resourceValues = permission.resource?.[resource_key];
-    if (!resourceValues)
-        return false;
-    // If is Array
-    if (Array.isArray(resourceValues) && resourceValues.includes(ALLOW_ALL_FLAG))
-        return true;
-    if (Array.isArray(resourceValues) && resourceValues.includes(value))
-        return true;
-    // If is not Array, check if value is equal to resourceValues
-    if (resourceValues === value)
-        return true;
-    return false;
-}
-/**
- * Ensure a permission is granted in a fastify request
- * @param request - The FastifyRequest
- * @param reply - The FastifyReply
- * @param params - The parameters of the permission
- * @returns The allowed
- */
-export function hasAPIResourcePermission(request, params) {
-    const allowed = hasPermissionResource({
-        action: params.action,
-        permissions: request.permissions,
-        resource_key: params.resource_key,
-        scope: params.scope,
-        value: params.value,
-    });
-    return allowed;
-}

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

@@ -1,8 +0,0 @@
-/**
- * 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/src/random/generate-random-number.js

@@ -1,14 +0,0 @@
-/* * */
-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/src/random/generate-random-string.d.ts

@@ -1,12 +0,0 @@
-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/src/random/generate-random-string.js

@@ -1,32 +0,0 @@
-/* * */
-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/src/random/generate-random-token.d.ts

@@ -1,8 +0,0 @@
-/**
- * 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/src/random/generate-random-token.js

@@ -1,12 +0,0 @@
-/* * */
-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/src/random/index.d.ts

@@ -1,3 +0,0 @@
-export * from './generate-random-number.js';
-export * from './generate-random-string.js';
-export * from './generate-random-token.js';

package/dist/src/random/index.js

@@ -1,3 +0,0 @@
-export * from './generate-random-number.js';
-export * from './generate-random-string.js';
-export * from './generate-random-token.js';

package/dist/src/strings/index.d.ts

@@ -1,2 +0,0 @@
-export * from './normalize-string.js';
-export * from './validation.js';

package/dist/src/strings/index.js

@@ -1,2 +0,0 @@
-export * from './normalize-string.js';
-export * from './validation.js';

package/dist/src/strings/normalize-string.d.ts

@@ -1,8 +0,0 @@
-/**
- * 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.
- * @returns The normalized string.
- */
-export declare function normalizeString(value: string): string;

package/dist/src/strings/normalize-string.js

@@ -1,18 +0,0 @@
-/* * */
-/**
- * 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.
- * @returns The normalized string.
- */
-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/src/strings/validation.d.ts

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

package/dist/src/strings/validation.js

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