@remotex-labs/xmap 3.0.0 → 3.0.2

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

@@ -1,15 +1,98 @@
+import * as ts from "typescript";
 /**
- * Export interfaces
- */
-export type { HighlightSchemeInterface, HighlightNodeSegmentInterface } from "./interfaces/highlighter-component.interface";
-/**
- * Import will remove at compile time
+ * 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
  */
-import type { HighlightSchemeInterface } from "./interfaces/highlighter-component.interface";
+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;
+}
 /**
- * Imports
+ * 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 * as ts from 'typescript';
+export interface HighlightNodeSegmentInterface {
+    end: number;
+    start: number;
+    color: string;
+    reset: string;
+}
 /**
  * An enum containing ANSI escape sequences for various colors
  *
@@ -24,7 +107,7 @@ import * as ts from 'typescript';
  *
  * @since 1.0.0
  */
-export declare const enum Colors {
+export const enum Colors {
     reset = "\u001B[0m",
     gray = "\u001B[38;5;243m",
     darkGray = "\u001B[38;5;238m",
@@ -56,7 +139,7 @@ export declare const enum Colors {
  *
  * @since 1.0.0
  */
-export declare class CodeHighlighter {
+export class CodeHighlighter {
     private sourceFile;
     private code;
     private schema;
@@ -337,4 +420,4 @@ export declare class CodeHighlighter {
  *
  * @since 1.0.0
  */
-export declare function highlightCode(code: string, schema?: Partial<HighlightSchemeInterface>): string;
+export function highlightCode(code: string, schema?: Partial<HighlightSchemeInterface>): string;