geoproject-app/public/site/plugins/map-editor/src/utils/constants.js

27 lines
548 B
JavaScript
Raw Normal View History

refactor: comprehensive map-editor plugin refactoring (phases 1-3) This commit implements a complete refactoring of the map-editor plugin to improve code organization, reusability, and maintainability. ## Phase 1: Extraction of composables and factory functions **New composables:** - `useMarkers.js`: Centralized marker state and CRUD operations - Exports: markers, selectedMarkerId, editingMarker refs - Computed: canAddMarker, hasMarkers, selectedMarker - Methods: addMarker, updateMarker, deleteMarker, selectMarker, etc. - Includes createMarker() factory to eliminate code duplication - `useMapData.js`: Map data persistence (YAML load/save) - Exports: center, zoom refs - Methods: loadMapData, saveMapData, debouncedSave - Handles lifecycle cleanup of debounce timeouts **Benefits:** - Eliminated code duplication (2 identical marker creation blocks) - Separated business logic from UI concerns - Improved testability with pure functions - Added JSDoc documentation throughout ## Phase 2: Component extraction **New components:** - `MarkerList.vue`: Extracted sidebar UI from MapEditor.vue - Props: markers, selectedMarkerId, maxMarkers - Emits: add-marker, select-marker, edit-marker, delete-marker, select-location - Includes integrated GeocodeSearch component - Self-contained styles with scoped CSS **Benefits:** - MapEditor.vue reduced from 370 → 230 lines (-40%) - Clear separation of concerns (orchestration vs presentation) - Reusable component for potential future use - Easier to test and maintain ## Phase 3: Utils restructuring with JSDoc **New structure:** ``` utils/ ├── constants.js # NOMINATIM_API, MAP_DEFAULTS, DEBOUNCE_DELAYS ├── api/ │ └── nominatim.js # geocode() with full JSDoc typedefs └── helpers/ └── debounce.js # Generic debounce utility ``` **Removed:** - `utils/geocoding.js` (replaced by modular structure) **Benefits:** - Constants centralized for easy configuration - API layer separated from helpers - Complete JSDoc type annotations for better IDE support - Better organization following standard patterns ## Updated components **MapEditor.vue:** - Now uses useMarkers and useMapData composables - Uses MarkerList component instead of inline template - Cleaner setup function with better separation - Reduced from 537 → 256 lines (CSS moved to MarkerList) **GeocodeSearch.vue:** - Updated imports to use new utils structure - Uses DEBOUNCE_DELAYS constant instead of hardcoded value ## Build verification - ✅ npm run build successful - ✅ Bundle size unchanged (806.10 kB / 223.46 KiB gzipped) - ✅ All functionality preserved - ✅ No breaking changes ## Documentation - Added comprehensive README.md with: - Architecture overview - Composables usage examples - Component API documentation - Data flow diagrams - Development guide Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-01-28 16:29:15 +01:00
/**
* Map editor constants
*/
// Nominatim API configuration
export const NOMINATIM_API = {
BASE_URL: 'https://nominatim.openstreetmap.org/search',
USER_AGENT: 'GeoProject/1.0 (Kirby CMS Map Editor)',
RATE_LIMIT_MS: 1000, // 1 request per second
MIN_QUERY_LENGTH: 3,
MAX_RESULTS: 5,
DEFAULT_LANGUAGE: 'fr',
};
// Map defaults
export const MAP_DEFAULTS = {
CENTER: { lat: 43.836699, lon: 4.360054 },
ZOOM: 13,
MAX_MARKERS: 50,
};
// Debounce delays (ms)
export const DEBOUNCE_DELAYS = {
GEOCODING: 500,
AUTO_SAVE: 300,
};