@remotex-labs/xmap 3.0.5 → 4.0.1

package/dist/highlighter.component.d.ts

@@ -1,127 +1,19 @@
-import type * as ts from "typescript";
+
 /**
- * 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
+ * This file was automatically generated by xBuild.
+ * DO NOT EDIT MANUALLY.
  */
-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;
-}
+ import ts from 'typescript';
+
 /**
- * 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
+ * Import will remove at compile time
  */
-export interface HighlightNodeSegmentInterface {
-    end: number;
-    start: number;
-    color: string;
-    reset: string;
-}
 /**
- * An enum containing ANSI escape sequences for various colors
- *
- * @remarks
- * This enum is primarily intended for terminal output and won't work directly in JavaScript for web development.
- * It defines color codes for various colors and a reset code to return to the default text color.
- *
- * @example
- * ```ts
- * console.log(`${Colors.red}This text will be red in the terminal.${Colors.reset}`);
- * ```
- *
- * @since 1.0.0
+ * Imports
+ */
+/**
+ * Export interfaces
  */
-export declare const enum Colors {
-    reset = "\u001B[0m",
-    gray = "\u001B[38;5;243m",
-    darkGray = "\u001B[38;5;238m",
-    lightCoral = "\u001B[38;5;203m",
-    lightOrange = "\u001B[38;5;215m",
-    oliveGreen = "\u001B[38;5;149m",
-    burntOrange = "\u001B[38;5;208m",
-    lightGoldenrodYellow = "\u001B[38;5;221m",
-    lightYellow = "\u001B[38;5;230m",
-    canaryYellow = "\u001B[38;5;227m",
-    deepOrange = "\u001B[38;5;166m",
-    lightGray = "\u001B[38;5;252m",
-    brightPink = "\u001B[38;5;197m"
-}
 /**
  * Class responsible for applying semantic highlighting to a source code string based on a given color scheme
  *
@@ -188,7 +80,7 @@ export declare class CodeHighlighter {
      *
      * @param start - The starting index position in the source text
      * @param end - The ending index position in the source text (optional)
-     * @returns The substring of source text between the start and end positions
+     * @returns The substring of a source text between the start and end positions
      *
      * @remarks
      * This utility method provides access to specific portions of the source code
@@ -204,7 +96,7 @@ export declare class CodeHighlighter {
      * // Extract a variable name
      * const variableName = this.getSegmentSource(10, 15);
      *
-     * // Extract from a position to the end of source
+     * // Extract from a position to the end of a source
      * const remaining = this.getSegmentSource(100);
      * ```
      *
@@ -219,8 +111,7 @@ export declare class CodeHighlighter {
      *
      * @param start - The starting position of the segment in the source text
      * @param end - The ending position of the segment in the source text
-     * @param color - The color code to apply to this segment
-     * @param reset - The color reset code to apply after the segment (defaults to the standard reset code)
+     * @param color - The {@link ColorFunctionType} to apply to this segment
      *
      * @remarks
      * This method creates a unique key for each segment based on its position and stores the segment information in a map.
@@ -233,10 +124,10 @@ export declare class CodeHighlighter {
      * @example
      * ```ts
      * // Highlight a variable name in red
-     * this.addSegment(10, 15, Colors.red);
+     * this.addSegment(10, 15, xterm.red);
      *
-     * // Highlight a keyword with custom color and reset
-     * this.addSegment(20, 26, Colors.blue, Colors.customReset);
+     * // Highlight a keyword with custom color
+     * this.addSegment(20, 26, xterm.blue);
      * ```
      *
      * @see Colors
@@ -292,7 +183,7 @@ export declare class CodeHighlighter {
      *    keyword range (between FirstKeyword and LastKeyword) and highlights it using
      *    the keyword color.
      *
-     * Each identified token is added to the segments collection with appropriate position
+     * Each identified token is added to the segment collection with the appropriate position
      * and color information.
      *
      * @example
@@ -371,7 +262,7 @@ export declare class CodeHighlighter {
      *
      * @remarks
      * This method identifies the node's kind and applies the appropriate color for highlighting.
-     * It handles various syntax kinds including literals (string, numeric, regular expressions),
+     * It handles various syntax kinds, including literals (string, numeric, regular expressions),
      * template expressions, identifiers, and type references.
      * For complex node types like template expressions and identifiers, it delegates to specialized processing methods.
      *
@@ -382,7 +273,7 @@ export declare class CodeHighlighter {
      * // Inside the CodeHighlighter class
      * const node = sourceFile.getChildAt(0);
      * this.processNode(node);
-     * // Node is now added to the segments map with appropriate colors
+     * // Node is now added to the segment map with appropriate colors
      * ```
      *
      * @see processTemplateExpression
@@ -421,3 +312,153 @@ export declare class CodeHighlighter {
  * @since 1.0.0
  */
 export declare function highlightCode(code: string, schema?: Partial<HighlightSchemeInterface>): string;
+
+/**
+ * Represents a function that applies coloring or formatting to strings.
+ *
+ * @param args - Strings to be formatted
+ * @returns The formatted string
+ *
+ * @since 1.0.0
+ */
+export type ColorFunctionType = (...args: Array<string>) => string;
+/**
+ * Defines a color scheme for syntax highlighting various code elements.
+ *
+ * @remarks
+ * Each property is a {@link ColorFunctionType} that formats a specific type of syntax element,
+ * such as enums, classes, keywords, or literals.
+ *
+ * @see ColorFunctionType
+ * @since 1.0.0
+ */
+export interface HighlightSchemeInterface {
+    /**
+     * Color function for enum names.
+     * @since 1.0.0
+     */
+    enumColor: ColorFunctionType;
+    /**
+     * Color function for type names.
+     * @since 1.0.0
+     */
+    typeColor: ColorFunctionType;
+    /**
+     * Color function for class names.
+     * @since 1.0.0
+     */
+    classColor: ColorFunctionType;
+    /**
+     * Color function for string literals.
+     * @since 1.0.0
+     */
+    stringColor: ColorFunctionType;
+    /**
+     * Color function for language keywords.
+     * @since 1.0.0
+     */
+    keywordColor: ColorFunctionType;
+    /**
+     * Color function for comments.
+     * @since 1.0.0
+     */
+    commentColor: ColorFunctionType;
+    /**
+     * Color function for function names.
+     * @since 1.0.0
+     */
+    functionColor: ColorFunctionType;
+    /**
+     * Color function for variable names.
+     * @since 1.0.0
+     */
+    variableColor: ColorFunctionType;
+    /**
+     * Color function for interface names.
+     * @since 1.0.0
+     */
+    interfaceColor: ColorFunctionType;
+    /**
+     * Color function for function/method parameters.
+     * @since 1.0.0
+     */
+    parameterColor: ColorFunctionType;
+    /**
+     * Color function for getter accessor names.
+     * @since 1.0.0
+     */
+    getAccessorColor: ColorFunctionType;
+    /**
+     * Color function for numeric literals.
+     * @since 1.0.0
+     */
+    numericLiteralColor: ColorFunctionType;
+    /**
+     * Color function for method signatures.
+     * @since 1.0.0
+     */
+    methodSignatureColor: ColorFunctionType;
+    /**
+     * Color function for regular expressions.
+     * @since 1.0.0
+     */
+    regularExpressionColor: ColorFunctionType;
+    /**
+     * Color function for property assignments.
+     * @since 1.0.0
+     */
+    propertyAssignmentColor: ColorFunctionType;
+    /**
+     * Color function for property access expressions.
+     * @since 1.0.0
+     */
+    propertyAccessExpressionColor: ColorFunctionType;
+    /**
+     * Color function for expressions with type arguments.
+     * @since 1.0.0
+     */
+    expressionWithTypeArgumentsColor: ColorFunctionType;
+}
+/**
+ * Represents a segment of source code to be highlighted with specific styling.
+ *
+ * @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: xterm.red
+ * };
+ * ```
+ *
+ * @see addSegment
+ * @see HighlightSchemeInterface
+ *
+ * @since 1.0.0
+ */
+export interface HighlightNodeSegmentInterface {
+    /**
+     * The starting character position of the segment in the source text.
+     * @since 1.0.0
+     */
+    start: number;
+    /**
+     * The ending character position of the segment in the source text.
+     * @since 1.0.0
+     */
+    end: number;
+    /**
+     * The color or style code to apply to this segment.
+     * @since 1.0.0
+     */
+    color: ColorFunctionType;
+}