@remotex-labs/xmap 3.0.5 → 4.0.1

package/dist/parser.component.d.ts

@@ -1,61 +1,20 @@
+
 /**
- * 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
+ * This file was automatically generated by xBuild.
+ * DO NOT EDIT MANUALLY.
+ */
+ /**
+ * Export interfaces
  */
-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
+ * Import will remove at compile time
  */
-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 {
+declare const enum JSEngines {
     V8 = 0,
     SPIDERMONKEY = 1,
     JAVASCRIPT_CORE = 2,
@@ -107,14 +66,14 @@ export declare function normalizePath(filePath: string): string;
  * Creates a default stack frame object with initial values
  *
  * @param source - The original source line from the stack trace
- * @returns A new StackFrame object with default null values
+ * @returns A new StackFrameInterface object with default null values
  *
- * @see ParsedStackTrace
- * @see StackFrame
+ * @see ParsedStackTraceInterface
+ * @see StackFrameInterface
  *
  * @since 2.1.0
  */
-export declare function createDefaultFrame(source: string): StackFrame;
+export declare function createDefaultFrame(source: string): StackFrameInterface;
 /**
  * Safely parses a string value to an integer, handling undefined and null cases
  *
@@ -132,10 +91,10 @@ export declare function createDefaultFrame(source: string): StackFrame;
  */
 export declare function safeParseInt(value: string | undefined | null): number | undefined;
 /**
- * Parses a V8 JavaScript engine stack trace line into a structured StackFrame object
+ * Parses a V8 JavaScript engine stack trace line into a structured StackFrameInterface object
  *
  * @param line - The stack trace line to parse
- * @returns A StackFrame object containing the parsed information
+ * @returns A StackFrameInterface object containing the parsed information
  *
  * @remarks
  * Handles both standard V8 stack frames and eval-generated stack frames which
@@ -152,17 +111,17 @@ export declare function safeParseInt(value: string | undefined | null): number |
  *
  * @throws Error - If the line format doesn't match any known V8 pattern
  *
- * @see StackFrame
+ * @see StackFrameInterface
  * @see createDefaultFrame
  *
  * @since 2.1.0
  */
-export declare function parseV8StackLine(line: string): StackFrame;
+export declare function parseV8StackLine(line: string): StackFrameInterface;
 /**
- * Parses a SpiderMonkey JavaScript engine stack trace line into a structured StackFrame object
+ * Parses a SpiderMonkey JavaScript engine stack trace line into a structured StackFrameInterface object
  *
  * @param line - The stack trace line to parse
- * @returns A StackFrame object containing the parsed information
+ * @returns A StackFrameInterface object containing the parsed information
  *
  * @remarks
  * Handles both standard SpiderMonkey stack frames and eval/Function-generated stack frames
@@ -177,17 +136,17 @@ export declare function parseV8StackLine(line: string): StackFrame;
  * parseSpiderMonkeyStackLine("evalFn@/source.js line 5 > eval:1:5");
  * ```
  *
- * @see StackFrame
+ * @see StackFrameInterface
  * @see createDefaultFrame
  *
  * @since 2.1.0
  */
-export declare function parseSpiderMonkeyStackLine(line: string): StackFrame;
+export declare function parseSpiderMonkeyStackLine(line: string): StackFrameInterface;
 /**
- * Parses a JavaScriptCore engine stack trace line into a structured StackFrame object
+ * Parses a JavaScriptCore engine stack trace line into a structured StackFrameInterface object
  *
  * @param line - The stack trace line to parse
- * @returns A StackFrame object containing the parsed information
+ * @returns A StackFrameInterface object containing the parsed information
  *
  * @remarks
  * Handles both standard JavaScriptCore stack frames and eval-generated stack frames.
@@ -202,18 +161,18 @@ export declare function parseSpiderMonkeyStackLine(line: string): StackFrame;
  * parseJavaScriptCoreStackLine("eval code@");
  * ```
  *
- * @see StackFrame
+ * @see StackFrameInterface
  * @see createDefaultFrame
  *
  * @since 2.1.0
  */
-export declare function parseJavaScriptCoreStackLine(line: string): StackFrame;
+export declare function parseJavaScriptCoreStackLine(line: string): StackFrameInterface;
 /**
  * Parses a stack trace line based on the detected JavaScript engine
  *
  * @param line - The stack trace line to parse
  * @param engine - The JavaScript engine type that generated the stack trace
- * @returns A StackFrame object containing the parsed information
+ * @returns A StackFrameInterface object containing the parsed information
  *
  * @remarks
  * Delegates to the appropriate parsing function based on the JavaScript engine.
@@ -232,12 +191,41 @@ export declare function parseJavaScriptCoreStackLine(line: string): StackFrame;
  *
  * @since 2.1.0
  */
-export declare function parseStackLine(line: string, engine: JSEngines): StackFrame;
+export declare function parseStackLine(line: string, engine: JSEngines): StackFrameInterface;
+/**
+ * Extracts the stack frames from a full stack trace string, removing the error message line.
+ *
+ * @param stack - The full error stack string, possibly including the error message
+ * @returns The stack trace starting from the first stack frame, or an empty string if no frames are found
+ *
+ * @remarks
+ * This function scans the stack string for lines matching common stack frame formats,
+ * including V8 (`at ...`) and SpiderMonkey/JavaScriptCore (`function@file:line:column`) patterns.
+ * It returns only the portion of the stack that contains the frames, discarding the initial
+ * error message or any non-stack lines.
+ *
+ * @example
+ * ```ts
+ * const stack = `
+ * Error: Something went wrong
+ *     at doSomething (file.js:10:15)
+ *     at main (file.js:20:5)
+ * `;
+ *
+ * console.log(getStackWithoutMessage(stack));
+ * // Output:
+ * // at doSomething (file.js:10:15)
+ * // at main (file.js:20:5)
+ * ```
+ *
+ * @since 4.0.1
+ */
+export declare function getStackWithoutMessage(stack: string): string;
 /**
  * Parses a complete error stack trace into a structured format
  *
  * @param error - Error object or error message string to parse
- * @returns A ParsedStackTrace object containing structured stack trace information
+ * @returns A ParsedStackTraceInterface object containing structured stack trace information
  *
  * @remarks
  * Automatically detects the JavaScript engine from the stack format.
@@ -252,15 +240,68 @@ export declare function parseStackLine(line: string, engine: JSEngines): StackFr
  *   const parsedStack = parseErrorStack(error);
  *   console.log(parsedStack.name); // "Error"
  *   console.log(parsedStack.message); // "Something went wrong"
- *   console.log(parsedStack.stack); // Array of StackFrame objects
+ *   console.log(parsedStack.stack); // Array of StackFrameInterface objects
  * }
  * ```
  *
- * @see ParsedStackTrace
- * @see StackFrame
+ * @see ParsedStackTraceInterface
+ * @see StackFrameInterface
  * @see parseStackLine
  * @see detectJSEngine
  *
  * @since 2.1.0
  */
-export declare function parseErrorStack(error: Error | string): ParsedStackTrace;
+export declare function parseErrorStack(error: Error | string): ParsedStackTraceInterface;
+
+/**
+ * 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 StackFrameInterface {
+    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 StackFrameInterface
+ * @since 2.1.0
+ */
+export interface ParsedStackTraceInterface {
+    name: string;
+    message: string;
+    stack: StackFrameInterface[];
+    rawStack: string;
+}

package/package.json

@@ -5,10 +5,10 @@
     "types": "./dist/index.d.ts",
     "module": "./dist/esm/index.js",
     "author": "Garefild",
-    "version": "3.0.5",
+    "version": "4.0.1",
     "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",
+    "homepage": "https://remotex-labs.github.io/xMap/",
     "repository": {
         "type": "git",
         "url": "git+https://github.com/remotex-lab/xMap.git"
@@ -32,7 +32,7 @@
         "typescript runner"
     ],
     "engines": {
-        "node": ">=18"
+        "node": ">=20"
     },
     "typesVersions": {
         "*": {
@@ -86,19 +86,26 @@
         "lint": "xbuild --tc && eslint . -c ./eslint.config.mjs",
         "ci:test": "jest",
         "ci:clean": "rm -rf ./dist",
-        "ci:build": "npm run build"
+        "ci:build": "npm run build",
+        "docs:dev": "vitepress dev docs",
+        "docs:build": "vitepress build docs",
+        "docs:preview": "vitepress preview docs"
     },
     "devDependencies": {
-        "jest": "^29.7.0",
-        "eslint": "^9.24.0",
-        "typescript-eslint": "^8.29.0",
+        "jest": "^30.0.5",
+        "eslint": "^9.28.0",
+        "vitepress": "^1.6.4",
+        "typescript-eslint": "^8.40.0",
         "eslint-plugin-tsdoc": "^0.4.0",
-        "@swc/jest": "^0.2.37",
-        "@types/jest": "^29.5.14",
-        "@types/node": "^22.14.0",
-        "@remotex-labs/xbuild": "^1.5.7"
+        "vitepress-versioning-plugin": "^1.3.0",
+        "eslint-plugin-perfectionist": "^4.15.0",
+        "@swc/jest": "^0.2.39",
+        "@types/jest": "^30.0.0",
+        "@types/node": "^24.3.0",
+        "@remotex-labs/xbuild": "^1.6.0"
     },
     "dependencies": {
-        "typescript": "^5.8.3"
+        "typescript": "^5.9.2",
+        "@remotex-labs/xansi": "^1.1.1"
     }
 }