@orion-js/helpers 4.0.0-next.0 → 4.0.0-next.2

package/dist/index.d.ts

@@ -1,16 +1,17 @@
-// Generated by dts-bundle-generator v9.5.1
-
 /**
  * Creates a timeout with a promise
  */
 declare const _default: (time: number) => Promise<void>;
-declare function _default$1(object: any): string;
+
+declare function export_default(object: any): string;
+
 /**
  * Returns a random ID
  * @param charsCount length of the ID
  * @param chars characters used to generate the ID
  */
-export function generateId(charsCount?: number, chars?: string): string;
+declare function generateId(charsCount?: number, chars?: string): string;
+
 /**
  * Creates a map (object) from an array of items, using a specified property as the key.
  *
@@ -27,7 +28,8 @@ export function generateId(charsCount?: number, chars?: string): string;
  * // Returns { '1': { id: 1, name: 'Item 1' }, '2': { id: 2, name: 'Item 2' } }
  * createMap([{ id: 1, name: 'Item 1' }, { id: 2, name: 'Item 2' }], 'id')
  */
-export function createMap<T>(array: Array<T>, key?: string): Record<string, T>;
+declare function createMap<T>(array: Array<T>, key?: string): Record<string, T>;
+
 /**
  * Creates a grouped map from an array of items, using a specified property as the key.
  *
@@ -49,20 +51,21 @@ export function createMap<T>(array: Array<T>, key?: string): Record<string, T>;
  *   { id: 3, category: 'category1' }
  * ], 'category')
  */
-export function createMapArray<T>(array: Array<T>, key?: string): Record<string, Array<T>>;
+declare function createMapArray<T>(array: Array<T>, key?: string): Record<string, Array<T>>;
+
 /**
  * Interface representing the standardized error information structure for Orion errors.
  * This is used by the getInfo method to provide consistent error reporting.
  */
-export interface OrionErrorInformation {
-	/** The error code or identifier */
-	error: string;
-	/** Human-readable error message */
-	message: string;
-	/** Additional error metadata or context */
-	extra: any;
-	/** The sub-type of error. For example for permissions errors it could be 'read', 'write', 'admin' */
-	type?: string;
+interface OrionErrorInformation {
+    /** The error code or identifier */
+    error: string;
+    /** Human-readable error message */
+    message: string;
+    /** Additional error metadata or context */
+    extra: any;
+    /** The sub-type of error. For example for permissions errors it could be 'read', 'write', 'admin' */
+    type?: string;
 }
 /**
  * Base error class for all Orion-specific errors.
@@ -77,18 +80,19 @@ export interface OrionErrorInformation {
  * @property code - Error code for identifying the error type
  * @property extra - Additional error context or metadata
  */
-export declare class OrionError extends Error {
-	isOrionError: boolean;
-	isUserError: boolean;
-	isPermissionsError: boolean;
-	code: string;
-	extra: any;
-	/**
-	 * Returns a standardized representation of the error information.
-	 * @returns An object containing error details in a consistent format
-	 */
-	getInfo: () => OrionErrorInformation;
+declare class OrionError extends Error {
+    isOrionError: boolean;
+    isUserError: boolean;
+    isPermissionsError: boolean;
+    code: string;
+    extra: any;
+    /**
+     * Returns a standardized representation of the error information.
+     * @returns An object containing error details in a consistent format
+     */
+    getInfo: () => OrionErrorInformation;
 }
+
 /**
  * Error class for permission-related errors in the Orion framework.
  *
@@ -99,32 +103,33 @@ export declare class OrionError extends Error {
  *
  * @extends OrionError
  */
-export declare class PermissionsError extends OrionError {
-	/**
-	 * Creates a new PermissionsError instance.
-	 *
-	 * @param permissionErrorType - Identifies the specific permission that was violated
-	 *                              (e.g., 'read', 'write', 'admin')
-	 * @param extra - Additional error context or metadata. Can include a custom message
-	 *                via the message property.
-	 *
-	 * @example
-	 * // Basic usage
-	 * throw new PermissionsError('delete_document')
-	 *
-	 * @example
-	 * // With custom message
-	 * throw new PermissionsError('access_admin', { message: 'Admin access required' })
-	 *
-	 * @example
-	 * // With additional context
-	 * throw new PermissionsError('edit_user', {
-	 *   userId: 'user123',
-	 *   requiredRole: 'admin'
-	 * })
-	 */
-	constructor(permissionErrorType: any, extra?: any);
+declare class PermissionsError extends OrionError {
+    /**
+     * Creates a new PermissionsError instance.
+     *
+     * @param permissionErrorType - Identifies the specific permission that was violated
+     *                              (e.g., 'read', 'write', 'admin')
+     * @param extra - Additional error context or metadata. Can include a custom message
+     *                via the message property.
+     *
+     * @example
+     * // Basic usage
+     * throw new PermissionsError('delete_document')
+     *
+     * @example
+     * // With custom message
+     * throw new PermissionsError('access_admin', { message: 'Admin access required' })
+     *
+     * @example
+     * // With additional context
+     * throw new PermissionsError('edit_user', {
+     *   userId: 'user123',
+     *   requiredRole: 'admin'
+     * })
+     */
+    constructor(permissionErrorType: any, extra?: any);
 }
+
 /**
  * Error class for user-facing errors in the Orion framework.
  *
@@ -134,29 +139,34 @@ export declare class PermissionsError extends OrionError {
  *
  * @extends OrionError
  */
-export declare class UserError extends OrionError {
-	/**
-	 * Creates a new UserError instance.
-	 *
-	 * @param code - Error code identifier. If only one parameter is provided,
-	 *               this will be used as the message and code will default to 'error'.
-	 * @param message - Human-readable error message. Optional if code is provided.
-	 * @param extra - Additional error context or metadata.
-	 *
-	 * @example
-	 * // Basic usage
-	 * throw new UserError('invalid_input', 'The provided email is invalid')
-	 *
-	 * @example
-	 * // Using only a message (code will be 'error')
-	 * throw new UserError('Input validation failed')
-	 *
-	 * @example
-	 * // With extra metadata
-	 * throw new UserError('rate_limit', 'Too many requests', { maxRequests: 100 })
-	 */
-	constructor(code: string, message?: string, extra?: any);
+declare class UserError extends OrionError {
+    /**
+     * Creates a new UserError instance.
+     *
+     * @param code - Error code identifier. If only one parameter is provided,
+     *               this will be used as the message and code will default to 'error'.
+     * @param message - Human-readable error message. Optional if code is provided.
+     * @param extra - Additional error context or metadata.
+     *
+     * @example
+     * // Basic usage
+     * throw new UserError('invalid_input', 'The provided email is invalid')
+     *
+     * @example
+     * // Using only a message (code will be 'error')
+     * throw new UserError('Input validation failed')
+     *
+     * @example
+     * // With extra metadata
+     * throw new UserError('rate_limit', 'Too many requests', { maxRequests: 100 })
+     */
+    constructor(code: string, message?: string, extra?: any);
 }
+
+/**
+ * @file Exports all error classes used in the Orion framework
+ */
+
 /**
  * Type guard to check if an error is an OrionError
  *
@@ -175,27 +185,29 @@ export declare class UserError extends OrionError {
  *   }
  * }
  */
-export declare function isOrionError(error: any): error is OrionError;
+declare function isOrionError(error: any): error is OrionError;
 /**
  * Type guard to check if an error is a UserError
  *
  * @param error - Any error object to test
  * @returns True if the error is a UserError instance
  */
-export declare function isUserError(error: any): error is UserError;
+declare function isUserError(error: any): error is UserError;
 /**
  * Type guard to check if an error is a PermissionsError
  *
  * @param error - Any error object to test
  * @returns True if the error is a PermissionsError instance
  */
-export declare function isPermissionsError(error: any): error is PermissionsError;
+declare function isPermissionsError(error: any): error is PermissionsError;
+
 /**
  * Compose `middleware` returning
  * a fully valid middleware comprised
  * of all those which are passed.
  */
-export declare function composeMiddlewares(middleware: any): (context: any, next?: any) => Promise<any>;
+declare function composeMiddlewares(middleware: any): (context: any, next?: any) => Promise<any>;
+
 /**
  * Executes an asynchronous function with automatic retries on failure.
  *
@@ -218,9 +230,11 @@ export declare function composeMiddlewares(middleware: any): (context: any, next
  *   1000
  * );
  */
-export declare function executeWithRetries<TFunc extends () => Promise<any>>(fn: TFunc, retries: number, timeout: number): Promise<ReturnType<TFunc>>;
-export declare function generateUUID(): any;
-export declare function generateUUIDWithPrefix(prefix: string): string;
+declare function executeWithRetries<TFunc extends () => Promise<any>>(fn: TFunc, retries: number, timeout: number): Promise<ReturnType<TFunc>>;
+
+declare function generateUUID(): any;
+declare function generateUUIDWithPrefix(prefix: string): string;
+
 /**
  * Removes diacritical marks (accents) from text without any other modifications.
  * This is the most basic normalization function that others build upon.
@@ -228,7 +242,7 @@ export declare function generateUUIDWithPrefix(prefix: string): string;
  * @param text - The input string to process
  * @returns String with accents removed but otherwise unchanged
  */
-export declare function removeAccentsOnly(text: string): string;
+declare function removeAccentsOnly(text: string): string;
 /**
  * Normalizes text by removing diacritical marks (accents) and trimming whitespace.
  * Builds on removeAccentsOnly and adds whitespace trimming.
@@ -236,7 +250,7 @@ export declare function removeAccentsOnly(text: string): string;
  * @param text - The input string to normalize
  * @returns Normalized string with accents removed and whitespace trimmed
  */
-export declare function removeAccentsAndTrim(text: string): string;
+declare function removeAccentsAndTrim(text: string): string;
 /**
  * Normalizes text for search purposes by:
  * - Removing diacritical marks (accents)
@@ -249,7 +263,7 @@ export declare function removeAccentsAndTrim(text: string): string;
  * @param text - The input string to normalize for search
  * @returns Search-optimized string in lowercase with accents removed
  */
-export declare function normalizeForSearch(text: string): string;
+declare function normalizeForSearch(text: string): string;
 /**
  * Normalizes text for search purposes by:
  * - Removing diacritical marks (accents)
@@ -263,7 +277,7 @@ export declare function normalizeForSearch(text: string): string;
  * @param text - The input string to normalize for compact search
  * @returns Compact search-optimized string with no spaces
  */
-export declare function normalizeForCompactSearch(text: string): string;
+declare function normalizeForCompactSearch(text: string): string;
 /**
  * Normalizes text for search token processing by:
  * - Removing diacritical marks (accents)
@@ -277,7 +291,7 @@ export declare function normalizeForCompactSearch(text: string): string;
  * @param text - The input string to normalize for tokenized search
  * @returns Search token string with only alphanumeric characters and spaces
  */
-export declare function normalizeForSearchToken(text: string): string;
+declare function normalizeForSearchToken(text: string): string;
 /**
  * Normalizes a string specifically for use as a file key (e.g., in S3 or other storage systems).
  * Performs the following transformations:
@@ -290,7 +304,8 @@ export declare function normalizeForSearchToken(text: string): string;
  * @param text - The input string to normalize for file key usage
  * @returns A storage-safe string suitable for use as a file key
  */
-export declare function normalizeForFileKey(text: string): string;
+declare function normalizeForFileKey(text: string): string;
+
 /**
  * Generates an array of search tokens from input text and optional metadata.
  *
@@ -313,22 +328,22 @@ export declare function normalizeForFileKey(text: string): string;
  * // Returns ['hello', 'world', '_id:123']
  * getSearchTokens('Hello, World!', { id: '123' })
  */
-export declare function getSearchTokens(text: string[] | string, meta?: Record<string, string>): string[];
+declare function getSearchTokens(text: string[] | string, meta?: Record<string, string>): string[];
 /**
  * Interface for parameters used in generating search queries from tokens.
  *
  * @property filter - Optional string to filter search results
  * @property [key: string] - Additional key-value pairs for metadata filtering
  */
-export interface SearchQueryForTokensParams {
-	filter?: string;
-	[key: string]: string;
+interface SearchQueryForTokensParams {
+    filter?: string;
+    [key: string]: string;
 }
 /**
  * Options for customizing the search query generation behavior.
  * Currently empty but provided for future extensibility.
  */
-export type SearchQueryForTokensOptions = {};
+type SearchQueryForTokensOptions = {};
 /**
  * Generates a MongoDB-compatible query object based on the provided parameters.
  *
@@ -349,14 +364,10 @@ export type SearchQueryForTokensOptions = {};
  * // Returns { $all: [/^search/, '_category:books'] }
  * getSearchQueryForTokens({ filter: 'search', category: 'books' })
  */
-export declare function getSearchQueryForTokens(params?: SearchQueryForTokensParams, _options?: SearchQueryForTokensOptions): {
-	$all: (string | RegExp)[];
+declare function getSearchQueryForTokens(params?: SearchQueryForTokensParams, _options?: SearchQueryForTokensOptions): {
+    $all: (string | RegExp)[];
 };
-export declare function shortenMongoId(string: string): string;
 
-export {
-	_default as sleep,
-	_default$1 as hashObject,
-};
+declare function shortenMongoId(string: string): string;
 
-export {};
+export { OrionError, type OrionErrorInformation, PermissionsError, type SearchQueryForTokensOptions, type SearchQueryForTokensParams, UserError, composeMiddlewares, createMap, createMapArray, executeWithRetries, generateId, generateUUID, generateUUIDWithPrefix, getSearchQueryForTokens, getSearchTokens, export_default as hashObject, isOrionError, isPermissionsError, isUserError, normalizeForCompactSearch, normalizeForFileKey, normalizeForSearch, normalizeForSearchToken, removeAccentsAndTrim, removeAccentsOnly, shortenMongoId, _default as sleep };