@softwarity/geojson-editor 1.0.16 → 1.0.18

package/types/geojson-editor.d.ts

@@ -1,497 +1,155 @@
 import type { Feature, FeatureCollection } from 'geojson';
-/** Geometry type names */
-export type GeometryType = 'Point' | 'MultiPoint' | 'LineString' | 'MultiLineString' | 'Polygon' | 'MultiPolygon';
-/** Position in the editor (line and column) */
-export interface CursorPosition {
-    line: number;
-    column: number;
-}
-/** Options for set/add/insertAt/open methods */
-export interface SetOptions {
-    /**
-     * Attributes to collapse after loading.
-     * - string[]: List of attribute names (e.g., ['coordinates', 'geometry'])
-     * - function: Dynamic function (feature, index) => string[]
-     * - '$root': Special keyword to collapse entire features
-     * - Empty array: No auto-collapse
-     * @default ['coordinates']
-     */
-    collapsed?: string[] | ((feature: Feature, index: number) => string[]);
-}
-/** Theme configuration */
-export interface ThemeConfig {
-    bgColor?: string;
-    textColor?: string;
-    caretColor?: string;
-    gutterBg?: string;
-    gutterBorder?: string;
-    gutterText?: string;
-    jsonKey?: string;
-    jsonString?: string;
-    jsonNumber?: string;
-    jsonBoolean?: string;
-    jsonNull?: string;
-    jsonPunct?: string;
-    jsonError?: string;
-    controlColor?: string;
-    controlBg?: string;
-    controlBorder?: string;
-    geojsonKey?: string;
-    geojsonType?: string;
-    geojsonTypeInvalid?: string;
-    jsonKeyInvalid?: string;
-}
-/** Theme settings for dark and light modes */
-export interface ThemeSettings {
-    dark?: ThemeConfig;
-    light?: ThemeConfig;
-}
-/** Color metadata for a line */
-interface ColorMeta {
-    attributeName: string;
-    color: string;
-}
-/** Boolean metadata for a line */
-interface BooleanMeta {
-    attributeName: string;
-    value: boolean;
-}
-/** Collapse button metadata */
-interface CollapseButtonMeta {
-    nodeKey: string;
-    nodeId: string;
-    isCollapsed: boolean;
-}
-/** Visibility button metadata */
-interface VisibilityButtonMeta {
-    featureKey: string;
-    isHidden: boolean;
-}
-/** Line metadata */
-interface LineMeta {
-    colors: ColorMeta[];
-    booleans: BooleanMeta[];
-    collapseButton: CollapseButtonMeta | null;
-    visibilityButton: VisibilityButtonMeta | null;
-    isHidden: boolean;
-    isCollapsed: boolean;
-    featureKey: string | null;
-}
-/** Visible line data */
-interface VisibleLine {
-    index: number;
-    content: string;
-    meta: LineMeta | undefined;
-}
-/** Feature range in the editor */
-interface FeatureRange {
-    startLine: number;
-    endLine: number;
-    featureIndex: number;
-}
+import type { SetOptions, ThemeSettings } from './types.js';
+
+export type { SetOptions, ThemeConfig, ThemeSettings } from './types.js';
+
 /** Input types accepted by API methods */
 export type FeatureInput = Feature | Feature[] | FeatureCollection;
+
 /**
  * GeoJSON Editor Web Component
- * Monaco-like architecture with virtualized line rendering
+ * A feature-rich GeoJSON editor with syntax highlighting, collapsible nodes, and inline controls.
  */
 declare class GeoJsonEditor extends HTMLElement {
-    lines: string[];
-    collapsedNodes: Set<string>;
-    hiddenFeatures: Set<string>;
-    private _nodeIdCounter;
-    private _lineToNodeId;
-    private _nodeIdToLines;
-    visibleLines: VisibleLine[];
-    lineMetadata: Map<number, LineMeta>;
-    featureRanges: Map<string, FeatureRange>;
-    viewportHeight: number;
-    lineHeight: number;
-    bufferLines: number;
-    private _lastStartIndex;
-    private _lastEndIndex;
-    private _lastTotalLines;
-    private _scrollRaf;
-    cursorLine: number;
-    cursorColumn: number;
-    selectionStart: CursorPosition | null;
-    selectionEnd: CursorPosition | null;
-    private renderTimer;
-    private inputTimer;
-    themes: ThemeSettings;
-    private _undoStack;
-    private _redoStack;
-    private _maxHistorySize;
-    private _lastActionTime;
-    private _lastActionType;
-    private _groupingDelay;
-    private _isSelecting;
-    private _isComposing;
-    private _blockRender;
-    private _charWidth;
-    private _contextMapCache;
-    private _contextMapLinesLength;
-    private _contextMapFirstLine;
-    private _contextMapLastLine;
-    constructor();
-    _invalidateRenderCache(): void;
-    /**
-     * Create a snapshot of current editor state
-     * @returns {Object} State snapshot
-     */
-    _createSnapshot(): {
-        lines: string[];
-        cursorLine: number;
-        cursorColumn: number;
-        timestamp: number;
-    };
-    /**
-     * Restore editor state from snapshot
-     * @param {Object} snapshot - State to restore
-     */
-    _restoreSnapshot(snapshot: any): void;
-    /**
-     * Save current state to undo stack before making changes
-     * @param {string} actionType - Type of action (insert, delete, paste, etc.)
-     */
-    _saveToHistory(actionType?: string): void;
-    /**
-     * Undo last action
-     * @returns {boolean} True if undo was performed
-     */
-    undo(): boolean;
-    /**
-     * Redo previously undone action
-     * @returns {boolean} True if redo was performed
-     */
-    redo(): boolean;
-    /**
-     * Clear undo/redo history
-     */
-    clearHistory(): void;
-    /**
-     * Check if undo is available
-     * @returns {boolean}
-     */
-    canUndo(): boolean;
-    /**
-     * Check if redo is available
-     * @returns {boolean}
-     */
-    canRedo(): boolean;
-    _generateNodeId(): string;
-    /**
-     * Check if a line is inside a collapsed node (hidden lines between opening and closing)
-     * @param {number} lineIndex - The line index to check
-     * @returns {Object|null} - The collapsed range info or null
-     */
-    _getCollapsedRangeForLine(lineIndex: any): {
-        startLine: number;
-        endLine: number;
-        nodeKey?: string;
-        isRootFeature?: boolean;
-        nodeId: string;
-    };
-    /**
-     * Check if cursor is on the closing line of a collapsed node
-     * @param {number} lineIndex - The line index to check
-     * @returns {Object|null} - The collapsed range info or null
-     */
-    _getCollapsedClosingLine(lineIndex: any): {
-        startLine: number;
-        endLine: number;
-        nodeKey?: string;
-        isRootFeature?: boolean;
-        nodeId: string;
-    };
-    /**
-     * Get the position of the closing bracket on a line
-     * @param {string} line - The line content
-     * @returns {number} - Position of bracket or -1
-     */
-    _getClosingBracketPos(line: any): number;
-    /**
-     * Check if cursor is on the opening line of a collapsed node
-     * @param {number} lineIndex - The line index to check
-     * @returns {Object|null} - The collapsed range info or null
-     */
-    _getCollapsedNodeAtLine(lineIndex: any): {
-        startLine: number;
-        endLine: number;
-        nodeKey?: string;
-        isRootFeature?: boolean;
-        nodeId: string;
-    };
-    /**
-     * Check if cursor is on a line that has a collapsible node (expanded or collapsed)
-     * @param {number} lineIndex - The line index to check
-     * @returns {Object|null} - The node info with isCollapsed flag or null
-     */
-    _getCollapsibleNodeAtLine(lineIndex: any): {
-        startLine: number;
-        endLine: number;
-        nodeKey?: string;
-        isRootFeature?: boolean;
-        nodeId: string;
-        isCollapsed: boolean;
-    };
-    /**
-     * Find the innermost expanded node that contains the given line
-     * Used for Shift+Tab to collapse the parent node from anywhere inside it
-     * @param {number} lineIndex - The line index to check
-     * @returns {Object|null} - The containing node info or null
-     */
-    _getContainingExpandedNode(lineIndex: any): any;
-    /**
-     * Delete an entire collapsed node (opening line to closing line)
-     * @param {Object} range - The range info {startLine, endLine}
-     */
-    _deleteCollapsedNode(range: any): void;
-    /**
-     * Rebuild nodeId mappings after content changes
-     * Preserves collapsed state by matching nodeKey + sequential occurrence
-     */
-    _rebuildNodeIdMappings(): void;
-    static get observedAttributes(): string[];
-    connectedCallback(): void;
-    disconnectedCallback(): void;
-    attributeChangedCallback(name: any, oldValue: any, newValue: any): void;
-    get readonly(): boolean;
-    get value(): string;
-    get placeholder(): string;
-    get prefix(): string;
-    get suffix(): string;
-    render(): void;
-    setupEventListeners(): void;
-    /**
-     * Set the editor content from a string value
-     */
-    setValue(value: any, autoCollapse?: boolean): void;
-    /**
-     * Get full content as string (expanded, no hidden markers)
-     */
-    getContent(): string;
-    /**
-     * Update derived state from model
-     * Rebuilds line-to-nodeId mapping while preserving collapsed state
-     */
-    updateModel(): void;
-    /**
-     * Update view state without rebuilding nodeId mappings
-     * Used for collapse/expand operations where content doesn't change
-     */
-    updateView(): void;
-    /**
-     * Compute feature ranges (which lines belong to which feature)
-     */
-    computeFeatureRanges(): void;
-    /**
-     * Compute metadata for each line (colors, booleans, collapse buttons, etc.)
-     */
-    computeLineMetadata(): void;
-    /**
-     * Compute which lines are visible (not inside collapsed nodes)
-     */
-    computeVisibleLines(): void;
-    scheduleRender(): void;
-    renderViewport(): void;
-    /**
-     * Insert cursor element at the specified column position
-     * Uses absolute positioning to avoid affecting text layout
-     */
-    _insertCursor(column: any): string;
-    /**
-     * Add selection highlight to a line
-     */
-    _addSelectionHighlight(html: any, lineIndex: any, content: any): any;
-    /**
-     * Get character width for monospace font
-     */
-    _getCharWidth(): number;
-    renderGutter(startIndex: any, endIndex: any): void;
-    syncGutterScroll(): void;
-    handleInput(): void;
-    handleKeydown(e: any): void;
-    _handleEnter(ctx: any): void;
-    _handleBackspace(ctx: any): void;
-    _handleDelete(ctx: any): void;
-    _handleTab(isShiftKey: any, ctx: any): void;
-    insertNewline(): void;
-    deleteBackward(): void;
-    deleteForward(): void;
-    /**
-     * Move cursor vertically, skipping hidden collapsed lines only
-     */
-    moveCursorSkipCollapsed(deltaLine: any): void;
-    /**
-     * Move cursor horizontally with smart navigation around collapsed nodes
-     */
-    moveCursorHorizontal(delta: any): void;
-    _moveCursorRight(): void;
-    _moveCursorLeft(): void;
-    /**
-     * Scroll viewport to ensure cursor is visible
-     */
-    _scrollToCursor(): void;
-    /**
-     * Handle arrow key with optional selection and word jump
-     */
-    _handleArrowKey(deltaLine: any, deltaCol: any, isShift: any, isCtrl?: boolean): void;
-    /**
-     * Move cursor by word (Ctrl+Arrow)
-     * Behavior matches VSCode/Monaco:
-     * - Ctrl+Right: move to end of current word, or start of next word
-     * - Ctrl+Left: move to start of current word, or start of previous word
-     */
-    _moveCursorByWord(direction: any): void;
-    /**
-     * Handle Home/End with optional selection
-     */
-    _handleHomeEnd(key: any, isShift: any, onClosingLine: any): void;
-    /**
-     * Select all content
-     */
-    _selectAll(): void;
-    /**
-     * Get selected text
-     */
-    _getSelectedText(): string;
-    /**
-     * Normalize selection so start is before end
-     */
-    _normalizeSelection(): {
-        start: CursorPosition;
-        end: CursorPosition;
-    };
-    /**
-     * Check if there is an active selection
-     */
-    _hasSelection(): boolean;
-    /**
-     * Clear the current selection
-     */
-    _clearSelection(): void;
-    /**
-     * Delete selected text
-     */
-    _deleteSelection(): boolean;
-    insertText(text: any): void;
-    handlePaste(e: any): void;
-    handleCopy(e: any): void;
-    handleCut(e: any): void;
-    /**
-     * Get line/column position from mouse event
-     */
-    _getPositionFromClick(e: any): {
-        line: number;
-        column: number;
-    };
-    handleGutterClick(e: any): void;
-    handleEditorClick(e: any): void;
-    toggleCollapse(nodeId: any): void;
-    autoCollapseCoordinates(): void;
-    /**
-     * Helper to apply collapsed option from API methods
-     * @param {object} options - Options object with optional collapsed property
-     * @param {array} features - Features array for function mode
-     */
-    _applyCollapsedFromOptions(options: any, features: any): void;
-    /**
-     * Apply collapsed option to nodes
-     * @param {string[]|function} collapsed - Attributes to collapse or function returning them
-     * @param {array} features - Features array for function mode (optional)
-     */
-    _applyCollapsedOption(collapsed: any, features?: any): void;
-    toggleFeatureVisibility(featureKey: any): void;
-    showColorPicker(indicator: any, line: any, currentColor: any, attributeName: any): void;
-    updateColorValue(line: any, newColor: any, attributeName: any): void;
-    updateBooleanValue(line: any, newValue: any, attributeName: any): void;
-    formatAndUpdate(): void;
-    emitChange(): void;
-    updateReadonly(): void;
-    updatePlaceholderVisibility(): void;
-    updatePlaceholderContent(): void;
-    updatePrefixSuffix(): void;
-    updateThemeCSS(): void;
-    _parseSelectorToHostRule(selector: any): string;
-    setTheme(theme: ThemeSettings): void;
-    resetTheme(): void;
-    _getFeatureKey(feature: any): string;
-    _countBrackets(line: any, openBracket: any): {
-        open: number;
-        close: number;
-    };
-    /**
-     * Find all collapsible ranges using the mappings built by _rebuildNodeIdMappings
-     * This method only READS the existing mappings, it doesn't create new IDs
-     */
-    _findCollapsibleRanges(): any[];
-    _findClosingLine(startLine: any, openBracket: any): any;
-    _buildContextMap(): Map<any, any>;
-    _highlightSyntax(text: any, context: any, meta: any): any;
-    _validateGeoJSON(parsed: any): any[];
-    /**
-     * Validate a single feature object
-     * @param {object} feature - The feature to validate
-     * @throws {Error} If the feature is invalid
-     */
-    _validateFeature(feature: any): void;
-    /**
-     * Normalize input to an array of features
-     * Accepts: FeatureCollection, Feature[], or single Feature
-     * @param {object|array} input - Input to normalize
-     * @returns {array} Array of features
-     * @throws {Error} If input is invalid
-     */
-    _normalizeToFeatures(input: any): any[];
-    /**
-     * Replace all features in the editor
-     * Accepts: FeatureCollection, Feature[], or single Feature
-     * @param {object|array} input - Features to set
-     * @param {object} options - Optional settings
-     * @param {string[]|function} options.collapsed - Attributes to collapse (default: ['coordinates'])
-     *   - string[]: List of attributes to collapse (e.g., ['coordinates', 'geometry'])
-     *   - function(feature, index): Returns string[] of attributes to collapse per feature
-     *   - Use '$root' to collapse the entire feature
-     * @throws {Error} If input is invalid
-     */
-    set(input: FeatureInput, options?: SetOptions): void;
-    /**
-     * Add features to the end of the editor
-     * Accepts: FeatureCollection, Feature[], or single Feature
-     * @param {object|array} input - Features to add
-     * @param {object} options - Optional settings
-     * @param {string[]|function} options.collapsed - Attributes to collapse (default: ['coordinates'])
-     * @throws {Error} If input is invalid
-     */
-    add(input: FeatureInput, options?: SetOptions): void;
-    /**
-     * Insert features at a specific index
-     * Accepts: FeatureCollection, Feature[], or single Feature
-     * @param {object|array} input - Features to insert
-     * @param {number} index - Index to insert at (negative = from end)
-     * @param {object} options - Optional settings
-     * @param {string[]|function} options.collapsed - Attributes to collapse (default: ['coordinates'])
-     * @throws {Error} If input is invalid
-     */
-    insertAt(input: FeatureInput, index: number, options?: SetOptions): void;
-    removeAt(index: number): Feature | undefined;
-    removeAll(): Feature[];
-    get(index: number): Feature | undefined;
-    getAll(): Feature[];
-    emit(): void;
-    /**
-     * Save GeoJSON to a file (triggers download)
-     */
-    save(filename?: string): boolean;
-    /**
-     * Open a GeoJSON file from the client filesystem
-     * Note: Available even in readonly mode via API (only Ctrl+O shortcut is blocked)
-     * @param {object} options - Optional settings
-     * @param {string[]|function} options.collapsed - Attributes to collapse (default: ['coordinates'])
-     * @returns {Promise<boolean>} Promise that resolves to true if file was loaded successfully
-     */
-    open(options?: SetOptions): Promise<boolean>;
-    _parseFeatures(): any;
+  /** Current editor content as string */
+  get value(): string;
+
+  /** Placeholder text when editor is empty */
+  get placeholder(): string;
+
+  /** Prefix text displayed before editor content */
+  get prefix(): string;
+
+  /** Suffix text displayed after editor content */
+  get suffix(): string;
+
+  /** Whether the editor is in readonly mode */
+  get readonly(): boolean;
+
+  /**
+   * Set the editor content from a string value
+   * @param value - JSON string content
+   * @param autoCollapse - Whether to auto-collapse coordinates (default: true)
+   */
+  setValue(value: string | null, autoCollapse?: boolean): void;
+
+  /**
+   * Get full content as string (expanded, no hidden markers)
+   */
+  getContent(): string;
+
+  /**
+   * Replace all features in the editor
+   * @param input - FeatureCollection, Feature[], or single Feature
+   * @param options - Optional settings (collapsed attributes)
+   * @throws Error if input is invalid
+   */
+  set(input: FeatureInput, options?: SetOptions): void;
+
+  /**
+   * Add features to the end of the editor
+   * @param input - FeatureCollection, Feature[], or single Feature
+   * @param options - Optional settings (collapsed attributes)
+   * @throws Error if input is invalid
+   */
+  add(input: FeatureInput, options?: SetOptions): void;
+
+  /**
+   * Insert features at a specific index
+   * @param input - FeatureCollection, Feature[], or single Feature
+   * @param index - Index to insert at (negative = from end)
+   * @param options - Optional settings (collapsed attributes)
+   * @throws Error if input is invalid
+   */
+  insertAt(input: FeatureInput, index: number, options?: SetOptions): void;
+
+  /**
+   * Remove feature at index
+   * @param index - Index to remove (negative = from end)
+   * @returns The removed feature, or undefined if index is out of bounds
+   */
+  removeAt(index: number): Feature | undefined;
+
+  /**
+   * Remove all features
+   * @returns Array of all removed features
+   */
+  removeAll(): Feature[];
+
+  /**
+   * Get feature at index
+   * @param index - Index to get (negative = from end)
+   * @returns The feature, or undefined if index is out of bounds
+   */
+  get(index: number): Feature | undefined;
+
+  /**
+   * Get all features as an array
+   */
+  getAll(): Feature[];
+
+  /**
+   * Emit the current document on the change event
+   */
+  emit(): void;
+
+  /**
+   * Save GeoJSON to a file (triggers download)
+   * @param filename - Filename for download (default: 'features.geojson')
+   * @returns true if save was successful
+   */
+  save(filename?: string): boolean;
+
+  /**
+   * Open a GeoJSON file from the client filesystem
+   * @param options - Optional settings (collapsed attributes)
+   * @returns Promise that resolves to true if file was loaded successfully
+   */
+  open(options?: SetOptions): Promise<boolean>;
+
+  /**
+   * Undo last action
+   * @returns true if undo was performed
+   */
+  undo(): boolean;
+
+  /**
+   * Redo previously undone action
+   * @returns true if redo was performed
+   */
+  redo(): boolean;
+
+  /**
+   * Check if undo is available
+   */
+  canUndo(): boolean;
+
+  /**
+   * Check if redo is available
+   */
+  canRedo(): boolean;
+
+  /**
+   * Clear undo/redo history
+   */
+  clearHistory(): void;
+
+  /**
+   * Set custom theme colors
+   * @param theme - Theme settings for dark and light modes
+   */
+  setTheme(theme: ThemeSettings): void;
+
+  /**
+   * Reset theme to defaults
+   */
+  resetTheme(): void;
+
+  /**
+   * Get current theme settings
+   * @returns Copy of current theme settings
+   */
+  getTheme(): ThemeSettings;
 }
+
 export default GeoJsonEditor;

package/types/types.d.ts

@@ -0,0 +1,44 @@
+import type { Feature } from 'geojson';
+/**
+ * Public types - exported from the package
+ */
+/** Options for set/add/insertAt/open methods */
+export interface SetOptions {
+    /**
+     * Attributes to collapse after loading.
+     * - string[]: List of attribute names (e.g., ['coordinates', 'geometry'])
+     * - function: Dynamic function (feature, index) => string[]
+     * - '$root': Special keyword to collapse entire features
+     * - Empty array: No auto-collapse
+     * @default ['coordinates']
+     */
+    collapsed?: string[] | ((feature: Feature | null, index: number) => string[]);
+}
+/** Theme configuration */
+export interface ThemeConfig {
+    bgColor?: string;
+    textColor?: string;
+    caretColor?: string;
+    gutterBg?: string;
+    gutterBorder?: string;
+    gutterText?: string;
+    jsonKey?: string;
+    jsonString?: string;
+    jsonNumber?: string;
+    jsonBoolean?: string;
+    jsonNull?: string;
+    jsonPunct?: string;
+    jsonError?: string;
+    controlColor?: string;
+    controlBg?: string;
+    controlBorder?: string;
+    geojsonKey?: string;
+    geojsonType?: string;
+    geojsonTypeInvalid?: string;
+    jsonKeyInvalid?: string;
+}
+/** Theme settings for dark and light modes */
+export interface ThemeSettings {
+    dark?: ThemeConfig;
+    light?: ThemeConfig;
+}