@remotex-labs/xmap 3.0.0 → 3.0.2

package/dist/{components/parser.component.d.ts → parser.component.d.ts}

@@ -1,17 +1,61 @@
 /**
- * Export interfaces
+ * Interface representing a stack frame in a stack trace.
+ *
+ * This structure provides detailed information about the location
+ * of a specific frame in the stack trace, primarily used in error debugging and stack analysis.
+ * It optionally includes information about the line, column, file, function name, and other details
+ * about the origin of the code.
+ *
+ * Properties:
+ * - source: The source code relevant to the stack frame.
+ * - line: An optional line number in the code associated with this frame.
+ * - column: An optional column number in the line associated with this frame.
+ * - fileName: The name of the file associated with the frame, if available.
+ * - functionName: The name of the function where the stack frame is located, if available.
+ * - eval: Indicates if the stack frame originates from an evaluated script.
+ * - async: Indicates if the stack frame is part of an asynchronous operation.
+ * - native: Indicates if the stack frame is part of native code execution.
+ * - constructor: Indicates if the frame is related to an object constructor invocation.
+ * - evalOrigin: Optional information about the origin of the code if it resulted from an eval execution,
+ * including line number, column number, file name, and function name.
+ *
+ * @since 3.0.0
  */
-export { ParsedStackTrace, StackFrame } from "./interfaces/parse-component.interface";
+export interface StackFrame {
+    source: string;
+    line?: number;
+    column?: number;
+    fileName?: string;
+    functionName?: string;
+    eval: boolean;
+    async: boolean;
+    native: boolean;
+    constructor: boolean;
+    evalOrigin?: {
+        line?: number;
+        column?: number;
+        fileName?: string;
+        functionName?: string;
+    };
+}
 /**
- * Import will remove at compile time
+ * Represents a fully parsed error stack trace with structured information
+ *
+ * @see StackFrame
+ * @since 2.1.0
  */
-import type { ParsedStackTrace, StackFrame } from "./interfaces/parse-component.interface";
+export interface ParsedStackTrace {
+    name: string;
+    message: string;
+    stack: StackFrame[];
+    rawStack: string;
+}
 /**
  * Enumeration of JavaScript engines that can be detected from stack traces
  *
  * @since 2.1.0
  */
-export declare const enum JSEngines {
+export const enum JSEngines {
     V8 = 0,
     SPIDERMONKEY = 1,
     JAVASCRIPT_CORE = 2,
@@ -33,7 +77,7 @@ export declare const enum JSEngines {
  *
  * @since 2.1.0
  */
-export declare function detectJSEngine(stack: string): JSEngines;
+export function detectJSEngine(stack: string): JSEngines;
 /**
  * Normalizes file paths from various formats to a standard format
  *
@@ -58,7 +102,7 @@ export declare function detectJSEngine(stack: string): JSEngines;
  *
  * @since 2.1.0
  */
-export declare function normalizePath(filePath: string): string;
+export function normalizePath(filePath: string): string;
 /**
  * Creates a default stack frame object with initial values
  *
@@ -70,7 +114,7 @@ export declare function normalizePath(filePath: string): string;
  *
  * @since 2.1.0
  */
-export declare function createDefaultFrame(source: string): StackFrame;
+export function createDefaultFrame(source: string): StackFrame;
 /**
  * Safely parses a string value to an integer, handling undefined and null cases
  *
@@ -86,7 +130,7 @@ export declare function createDefaultFrame(source: string): StackFrame;
  *
  * @since 2.1.0
  */
-export declare function safeParseInt(value: string | undefined | null): number | undefined;
+export function safeParseInt(value: string | undefined | null): number | undefined;
 /**
  * Parses a V8 JavaScript engine stack trace line into a structured StackFrame object
  *
@@ -113,7 +157,7 @@ export declare function safeParseInt(value: string | undefined | null): number |
  *
  * @since 2.1.0
  */
-export declare function parseV8StackLine(line: string): StackFrame;
+export function parseV8StackLine(line: string): StackFrame;
 /**
  * Parses a SpiderMonkey JavaScript engine stack trace line into a structured StackFrame object
  *
@@ -138,7 +182,7 @@ export declare function parseV8StackLine(line: string): StackFrame;
  *
  * @since 2.1.0
  */
-export declare function parseSpiderMonkeyStackLine(line: string): StackFrame;
+export function parseSpiderMonkeyStackLine(line: string): StackFrame;
 /**
  * Parses a JavaScriptCore engine stack trace line into a structured StackFrame object
  *
@@ -163,7 +207,7 @@ export declare function parseSpiderMonkeyStackLine(line: string): StackFrame;
  *
  * @since 2.1.0
  */
-export declare function parseJavaScriptCoreStackLine(line: string): StackFrame;
+export function parseJavaScriptCoreStackLine(line: string): StackFrame;
 /**
  * Parses a stack trace line based on the detected JavaScript engine
  *
@@ -188,7 +232,7 @@ export declare function parseJavaScriptCoreStackLine(line: string): StackFrame;
  *
  * @since 2.1.0
  */
-export declare function parseStackLine(line: string, engine: JSEngines): StackFrame;
+export function parseStackLine(line: string, engine: JSEngines): StackFrame;
 /**
  * Parses a complete error stack trace into a structured format
  *
@@ -219,4 +263,4 @@ export declare function parseStackLine(line: string, engine: JSEngines): StackFr
  *
  * @since 2.1.0
  */
-export declare function parseErrorStack(error: Error | string): ParsedStackTrace;
+export function parseErrorStack(error: Error | string): ParsedStackTrace;

package/package.json

@@ -5,7 +5,7 @@
     "types": "./dist/index.d.ts",
     "module": "./dist/esm/index.js",
     "author": "Garefild",
-    "version": "3.0.0",
+    "version": "3.0.2",
     "license": "Mozilla Public License Version 2.0",
     "description": "A library with a sourcemap parser and TypeScript code formatter for the CLI",
     "homepage": "https://github.com/remotex-lab/xMap",
@@ -34,44 +34,44 @@
     "engines": {
         "node": ">=18"
     },
+    "typesVersions": {
+        "*": {
+            "*": [
+                "./dist/*"
+            ],
+            "parser.component": [
+                "./dist/parser.component.d.ts"
+            ],
+            "formatter.component": [
+                "./dist/formatter.component.d.ts"
+            ],
+            "highlighter.component": [
+                "./dist/highlighter.component.d.ts"
+            ]
+        }
+    },
     "exports": {
-        "./package.json": "./package.json",
         ".": {
             "types": "./dist/index.d.ts",
-            "import": {
-                "default": "./dist/esm/index.js"
-            },
-            "require": {
-                "default": "./dist/cjs/index.js"
-            }
+            "import": "./dist/esm/index.js",
+            "require": "./dist/cjs/index.js"
         },
         "./parser.component": {
-            "types": "./dist/components/parser.component.d.ts",
-            "import": {
-                "default": "./dist/esm/parser.component.js"
-            },
-            "require": {
-                "default": "./dist/cjs/parser.component.js"
-            }
+            "types": "./dist/parser.component.d.ts",
+            "import": "./dist/esm/parser.component.js",
+            "require": "./dist/cjs/parser.component.js"
         },
         "./formatter.component": {
-            "types": "./dist/components/formatter.component.d.ts",
-            "import": {
-                "default": "./dist/esm/formatter.component.js"
-            },
-            "require": {
-                "default": "./dist/cjs/formatter.component.js"
-            }
+            "types": "./dist/formatter.component.d.ts",
+            "import": "./dist/esm/formatter.component.js",
+            "require": "./dist/cjs/formatter.component.js"
         },
         "./highlighter.component": {
-            "types": "./dist/components/highlighter.component.d.ts",
-            "import": {
-                "default": "./dist/esm/highlighter.component.js"
-            },
-            "require": {
-                "default": "./dist/cjs/highlighter.component.js"
-            }
-        }
+            "types": "./dist/highlighter.component.d.ts",
+            "import": "./dist/esm/highlighter.component.js",
+            "require": "./dist/cjs/highlighter.component.js"
+        },
+        "./package.json": "./package.json"
     },
     "files": [
         "dist",
@@ -90,13 +90,13 @@
     },
     "devDependencies": {
         "jest": "^29.7.0",
-        "eslint": "^9.22.0",
+        "eslint": "^9.23.0",
         "typescript-eslint": "^8.27.0",
         "eslint-plugin-tsdoc": "^0.4.0",
         "@swc/jest": "^0.2.37",
         "@types/jest": "^29.5.14",
         "@types/node": "^22.13.11",
-        "@remotex-labs/xbuild": "^1.5.3"
+        "@remotex-labs/xbuild": "^1.5.5"
     },
     "dependencies": {
         "typescript": "^5.8.2"

package/dist/components/base64.component.d.ts

@@ -1,70 +0,0 @@
-/**
- * Encodes a given number using Variable-Length Quantity (VLQ) encoding. Negative numbers are encoded by
- * converting to a non-negative representation and the continuation bit is used to indicate if more bytes follow.
- *
- * @param value - The number to be encoded
- * @returns The VLQ encoded string represented as Base64 characters
- *
- * @throws Error - If the value cannot be properly encoded
- *
- * @remarks The encoding process shifts the value left by 1 bit to accommodate a sign bit in the least significant position.
- * Negative values have their sign bit set to 1, while positive values have it set to 0.
- *
- * @example
- * ```ts
- * // Encoding a positive number
- * const encoded = encodeVLQ(25);  // Returns "Y"
- *
- * // Encoding a negative number
- * const encodedNegative = encodeVLQ(-25);  // Returns "Z"
- * ```
- *
- * @see decodeVLQ - For the corresponding decode function
- *
- * @since 1.0.0
- */
-export declare function encodeVLQ(value: number): string;
-/**
- * Encodes an array of numbers using VLQ encoding by individually encoding each number and concatenating the results.
- *
- * @param values - The array of numbers to be encoded
- * @returns The concatenated VLQ encoded string
- *
- * @example
- * ```ts
- * // Encoding multiple values
- * const encoded = encodeArrayVLQ([1, 0, -5]);  // Returns "CAAK"
- * ```
- *
- * @see encodeVLQ - The underlying function used to encode each number
- *
- * @since 1.0.0
- */
-export declare function encodeArrayVLQ(values: number[]): string;
-/**
- * Decodes a VLQ encoded string back into an array of numbers by processing Base64 characters and continuation bits.
- *
- * @param data - The VLQ encoded string
- * @returns The array of decoded numbers
- *
- * @throws Error - If the string contains invalid Base64 characters
- *
- * @remarks The decoding process examines each Base64 character,
- * checking for continuation bits and progressively building up numeric values.
- * The sign bit is extracted from the least significant position
- * to determine if the original number was negative.
- *
- * @example
- * ```ts
- * // Decoding a simple VLQ string
- * const decoded = decodeVLQ("Y");  // Returns [25]
- *
- * // Decoding multiple values
- * const multiDecoded = decodeVLQ("CAAK");  // Returns [1, 0, -5]
- * ```
- *
- * @see encodeVLQ - For the corresponding encode function
- *
- * @since 1.0.0
- */
-export declare function decodeVLQ(data: string): number[];

package/dist/components/formatter.component.d.ts

@@ -1,68 +0,0 @@
-/**
- * Export interfaces
- */
-export type { AnsiOptionInterface, FormatCodeInterface } from "./interfaces/formatter-component.interface";
-/**
- * Import will remove at compile time
- */
-import type { PositionWithCodeInterface } from "../services/interfaces/source-service.interface";
-import type { AnsiOptionInterface, FormatCodeInterface } from "./interfaces/formatter-component.interface";
-/**
- * Formats a code snippet with optional line padding and custom actions
- *
- * @param code - The source code | stack to be formatted
- * @param options - Configuration options for formatting the code
- * @returns A formatted string of the code snippet with applied padding and custom actions
- *
- * @remarks
- * This function takes a code string and an options object to format the code snippet.
- * It applies padding to line numbers and can trigger custom actions for specific lines.
- * Options include padding (default 10), startLine (default 0), and custom actions for specific lines.
- *
- * @example
- * ```ts
- * const formattedCode = formatCode(code, {
- *     padding: 8,
- *     startLine: 5,
- *     action: {
- *         triggerLine: 7,
- *         callback: (lineString, padding, lineNumber) => {
- *             return `Custom formatting for line ${lineNumber}: ${lineString}`;
- *         }
- *     }
- * });
- * ```
- *
- * @since 1.0.0
- */
-export declare function formatCode(code: string, options?: FormatCodeInterface): string;
-/**
- * Formats a code snippet around an error location with special highlighting
- *
- * @param sourcePosition - An object containing information about the source code and error location
- * @param ansiOption - Optional configuration for ANSI color codes
- * @returns A formatted string representing the relevant code snippet with error highlighting
- *
- * @throws Error - If the provided sourcePosition object has invalid line or column numbers
- *
- * @remarks
- * This function takes a sourcePosition object with code content and error location information,
- * then uses formatCode to format and highlight the relevant code snippet around the error.
- * The sourcePosition object should contain code (string), line (number), column (number),
- * and optional startLine (number, defaults to 1).
- *
- * @example
- * ```ts
- * const formattedErrorCode = formatErrorCode({
- *     code: "const x = 1;\nconst y = x.undefined;\n",
- *     line: 2,
- *     column: 15,
- *     startLine: 1
- * });
- * ```
- *
- * @see formatCode - The underlying function used for basic code formatting
- *
- * @since 1.0.0
- */
-export declare function formatErrorCode(sourcePosition: PositionWithCodeInterface, ansiOption?: AnsiOptionInterface): string;

package/dist/components/interfaces/formatter-component.interface.d.ts

@@ -1,60 +0,0 @@
-/**
- * A callback function for formatting code lines
- *
- * @param lineString - The content of the line to be formatted
- * @param padding - The amount of padding to be applied to the line
- * @param line - The line number of the line to be formatted
- * @returns Formatted line string
- *
- * @since 1.0.0
- */
-export type FormatCodeCallbackType = (lineString: string, padding: number, line: number) => string;
-/**
- * Configuration options for formatting code
- *
- * @since 1.0.0
- */
-export interface FormatCodeInterface {
-    /**
-     * The amount of padding to be applied to each line
-     * @since 1.0.0
-     */
-    padding?: number;
-    /**
-     * The starting line number for formatting
-     * @since 1.0.0
-     */
-    startLine?: number;
-    /**
-     * An optional action object specifying a line where a callback function should be triggered.
-     * @since 1.0.0
-     */
-    action?: {
-        /**
-         * The line number at which the callback function should be triggered.
-         * @since 1.0.0
-         */
-        triggerLine: number;
-        /**
-         * The callback function to be executed when the trigger line is encountered.
-         * @since 1.0.0
-         */
-        callback: FormatCodeCallbackType;
-    };
-}
-/**
- * Configuration for ANSI color styling of error pointers
- * @since 1.0.0
- */
-export interface AnsiOptionInterface {
-    /**
-     * ANSI color code to apply to the error pointer
-     * @since 1.0.0
-     */
-    color: string;
-    /**
-     * ANSI reset code to restore default styling after the error pointer
-     * @since 1.0.0
-     */
-    reset: string;
-}

package/dist/components/interfaces/highlighter-component.interface.d.ts

@@ -1,94 +0,0 @@
-/**
- * Defines the color scheme for syntax highlighting different code elements.
- *
- * @interface HighlightSchemeInterface
- *
- * @property enumColor - Color code for enum declarations and references
- * @property typeColor - Color code for type annotations and primitive types
- * @property classColor - Color code for class declarations and references
- * @property stringColor - Color code for string literals and template strings
- * @property keywordColor - Color code for language keywords
- * @property commentColor - Color code for comments (single-line and multi-line)
- * @property functionColor - Color code for function declarations and calls
- * @property variableColor - Color code for variable declarations and references
- * @property interfaceColor - Color code for interface declarations and references
- * @property parameterColor - Color code for function and method parameters
- * @property getAccessorColor - Color code for getter accessor methods
- * @property numericLiteralColor - Color code for numeric literals
- * @property methodSignatureColor - Color code for method signatures in interfaces
- * @property regularExpressionColor - Color code for regular expression literals
- * @property propertyAssignmentColor - Color code for property assignments in object literals
- * @property propertyAccessExpressionColor - Color code for property access expressions
- * @property expressionWithTypeArgumentsColor - Color code for type arguments in expressions
- *
- * @example
- * ```ts
- * const darkTheme: HighlightSchemeInterface = {
- *   enumColor: Colors.cyan,
- *   typeColor: Colors.blue,
- *   classColor: Colors.yellow,
- *   // ...other color definitions
- * };
- * ```
- *
- * @since 1.0.0
- */
-export interface HighlightSchemeInterface {
-    enumColor: string;
-    typeColor: string;
-    classColor: string;
-    stringColor: string;
-    keywordColor: string;
-    commentColor: string;
-    functionColor: string;
-    variableColor: string;
-    interfaceColor: string;
-    parameterColor: string;
-    getAccessorColor: string;
-    numericLiteralColor: string;
-    methodSignatureColor: string;
-    regularExpressionColor: string;
-    propertyAssignmentColor: string;
-    propertyAccessExpressionColor: string;
-    expressionWithTypeArgumentsColor: string;
-}
-/**
- * Represents a segment of source code to be highlighted with specific styling.
- *
- * @interface HighlightNodeSegmentInterface
- *
- * @property start - The starting character position of the segment in the source text
- * @property end - The ending character position of the segment in the source text
- * @property color - The color or style code to apply to this segment
- * @property reset - The reset code that returns formatting to normal after this segment
- *
- * @remarks
- * Segments are the fundamental units of the highlighting system.
- * Each segment represents a portion of text that should receive specific styling.
- * When the source code is processed for display,
- * these segments are used to insert the appropriate color/style codes at the correct positions.
- *
- * The highlighter maintains a collection of these segments and applies them
- * in position order to create the complete highlighted output.
- *
- * @example
- * ```ts
- * const keywordSegment: HighlightNodeSegmentInterface = {
- *   start: 0,
- *   end: 6,
- *   color: '\x1b[34m', // Blue for the keyword "import"
- *   reset: '\x1b[0m'   // Reset to default
- * };
- * ```
- *
- * @see HighlightSchemeInterface
- * @see addSegment
- *
- * @since 1.0.0
- */
-export interface HighlightNodeSegmentInterface {
-    end: number;
-    start: number;
-    color: string;
-    reset: string;
-}

package/dist/components/interfaces/parse-component.interface.d.ts

@@ -1,52 +0,0 @@
-/**
- * Interface representing a stack frame in a stack trace.
- *
- * This structure provides detailed information about the location
- * of a specific frame in the stack trace, primarily used in error debugging and stack analysis.
- * It optionally includes information about the line, column, file, function name, and other details
- * about the origin of the code.
- *
- * Properties:
- * - source: The source code relevant to the stack frame.
- * - line: An optional line number in the code associated with this frame.
- * - column: An optional column number in the line associated with this frame.
- * - fileName: The name of the file associated with the frame, if available.
- * - functionName: The name of the function where the stack frame is located, if available.
- * - eval: Indicates if the stack frame originates from an evaluated script.
- * - async: Indicates if the stack frame is part of an asynchronous operation.
- * - native: Indicates if the stack frame is part of native code execution.
- * - constructor: Indicates if the frame is related to an object constructor invocation.
- * - evalOrigin: Optional information about the origin of the code if it resulted from an eval execution,
- * including line number, column number, file name, and function name.
- *
- * @since 3.0.0
- */
-export interface StackFrame {
-    source: string;
-    line?: number;
-    column?: number;
-    fileName?: string;
-    functionName?: string;
-    eval: boolean;
-    async: boolean;
-    native: boolean;
-    constructor: boolean;
-    evalOrigin?: {
-        line?: number;
-        column?: number;
-        fileName?: string;
-        functionName?: string;
-    };
-}
-/**
- * Represents a fully parsed error stack trace with structured information
- *
- * @see StackFrame
- * @since 2.1.0
- */
-export interface ParsedStackTrace {
-    name: string;
-    message: string;
-    stack: StackFrame[];
-    rawStack: string;
-}