@sakuzu/maplibre-gl-draw 1.0.0 → 2.1.0

package/dist/api/import-export/index.js

@@ -1,107 +0,0 @@
-// SPDX-FileCopyrightText: 2026 SAKAIDA Atsushi
-// SPDX-License-Identifier: AGPL-3.0-only
-/**
- * Orchestrator of the Import/Export API
- *
- * createImportExportAPI is a thin orchestrator that detects the format and then delegates
- * to each import/export function. The implementation is spread across format-detection /
- * geojson-import / geojson-export / native-format / image-import / file-name.
- */
-import { isImageFile } from '../../shared/utils/image.js';
-import { buildExportFileName } from './file-name.js';
-import { isGeoJSONFeatureCollection, isNativeFormat } from './format-detection.js';
-import { exportGeoJSON } from './geojson-export.js';
-import { loadGeoJSON } from './geojson-import.js';
-import { loadImage } from './image-import.js';
-import { exportNative, loadNative } from './native-format.js';
-/**
- * Creates the Import/Export API
- *
- * @internal
- */
-export function createImportExportAPI(context) {
-    const { store, generateFeatureId, getCurrentLayerId, autoNameGenerator } = context;
-    const importDeps = {
-        store,
-        autoNameGenerator,
-        generateFeatureId,
-        getCurrentLayerId,
-    };
-    const api = {
-        /**
-         * Loads data or a file.
-         *
-         * Detects the kind of source automatically and handles it accordingly:
-         *   - File: detects the file kind automatically (image / .json / .geojson)
-         *   - object: detects the data format automatically (native format /
-         *     GeoJSON FeatureCollection)
-         */
-        async load(source, options) {
-            if (source instanceof File) {
-                if (isImageFile(source)) {
-                    return loadImage(source, options || {}, importDeps);
-                }
-                const fileName = source.name.toLowerCase();
-                const mimeType = source.type;
-                const isJsonFile = fileName.endsWith('.json') ||
-                    fileName.endsWith('.geojson') ||
-                    mimeType === 'application/json' ||
-                    mimeType === 'application/geo+json';
-                if (isJsonFile) {
-                    const text = await source.text();
-                    let data;
-                    try {
-                        data = JSON.parse(text);
-                    }
-                    catch (error) {
-                        const detail = error instanceof Error ? error.message : String(error);
-                        throw new Error(`Invalid JSON file "${source.name}": ${detail}`);
-                    }
-                    return api.load(data, options);
-                }
-                throw new Error(`Unsupported file type: ${source.type || source.name}`);
-            }
-            if (isNativeFormat(source)) {
-                return loadNative(source, { store });
-            }
-            if (isGeoJSONFeatureCollection(source)) {
-                return loadGeoJSON(source, importDeps, { flattenMulti: options?.flattenMulti });
-            }
-            throw new Error('Unsupported data format. Expected native format or GeoJSON FeatureCollection.');
-        },
-        /**
-         * Exports the data
-         */
-        export(format, options) {
-            const metadata = store.getMetadata();
-            if (format === 'native') {
-                const data = exportNative(store, options);
-                const fileName = options?.fileName || buildExportFileName(metadata, '.maplibre-gl-draw.json');
-                return {
-                    format: 'native',
-                    data: JSON.stringify(data, null, 2),
-                    mimeType: 'application/json',
-                    fileName,
-                };
-            }
-            if (format === 'geojson') {
-                const data = exportGeoJSON(store, options);
-                const fileName = options?.fileName || buildExportFileName(metadata, '.geojson');
-                return {
-                    format: 'geojson',
-                    data: JSON.stringify(data, null, 2),
-                    mimeType: 'application/geo+json',
-                    fileName,
-                };
-            }
-            throw new Error(`Unsupported export format: ${format}`);
-        },
-        /**
-         * Generates a suggested export file name
-         */
-        getSuggestedFileName() {
-            return buildExportFileName(store.getMetadata(), '.maplibre-gl-draw.json');
-        },
-    };
-    return api;
-}

package/dist/api/import-export/native-format.d.ts

@@ -1,15 +0,0 @@
-/**
- * Import / export of the native format
- */
-import type { Store } from '../../store/store.js';
-import type { Data, ExportOptions, LoadResult } from '../../store/types.js';
-/**
- * Exports the current data in the native format
- */
-export declare function exportNative(store: Store, options?: ExportOptions): Data;
-/**
- * Imports the native format (replaces the existing data)
- */
-export declare function loadNative(data: Data, deps: {
-    store: Store;
-}): Promise<LoadResult>;

package/dist/api/import-export/style-validation.d.ts

@@ -1,27 +0,0 @@
-/**
- * Validation of an imported feature style
- *
- * A style arrives from a file (the maplibre-gl-draw:style property of GeoJSON, the style of a
- * native feature, the simplestyle-spec keys) and reaches the renderer, which parses the
- * colors as #rgb / #rrggbb and uses the numbers as they are. A value of the wrong type or
- * form (a number or null for a color, `red`, an opacity of 5) would make the parsing throw or
- * produce NaN, so each known key is checked here and a key that fails is dropped. Keys this
- * library does not define are kept unchanged, whatever their value: they belong to the host or
- * to an extension, which gives features keys of its own and checks their values where it reads
- * them (values reach the Store through updateFeature and a replaced store as well, without
- * passing here).
- */
-import type { FeatureStyle } from '../../store/types.js';
-type Check = (value: unknown) => boolean;
-/** A #rgb or #rrggbb color */
-export declare const isHexColor: Check;
-/**
- * Returns the usable part of an imported style
- *
- * A key of FeatureStyle whose value fails its check is dropped; every other key is kept.
- *
- * @param value The style as read from the file
- * @returns The style, or undefined when the value is not an object or nothing is left
- */
-export declare function sanitizeFeatureStyle(value: unknown): FeatureStyle | undefined;
-export {};

package/dist/api/import-export/style-validation.js

@@ -1,49 +0,0 @@
-// SPDX-FileCopyrightText: 2026 SAKAIDA Atsushi
-// SPDX-License-Identifier: AGPL-3.0-only
-import { setOwnProperty } from './own-property.js';
-const HEX_COLOR = /^#(?:[0-9a-f]{3}|[0-9a-f]{6})$/i;
-/** A #rgb or #rrggbb color */
-export const isHexColor = (value) => typeof value === 'string' && HEX_COLOR.test(value);
-const isFiniteNumber = (value) => typeof value === 'number' && Number.isFinite(value);
-const isOpacity = (value) => isFiniteNumber(value) && value >= 0 && value <= 1;
-const isNonNegative = (value) => isFiniteNumber(value) && value >= 0;
-const oneOf = (...values) => (value) => typeof value === 'string' && values.includes(value);
-/** The check of every key of FeatureStyle */
-const STYLE_CHECK_TABLE = {
-    fillColor: isHexColor,
-    fillOpacity: isOpacity,
-    strokeColor: isHexColor,
-    strokeWidth: isNonNegative,
-    strokeOpacity: isOpacity,
-    lineStyle: oneOf('solid', 'dashed', 'dotted'),
-    pointRadius: isNonNegative,
-    pointColor: isHexColor,
-    pointShape: oneOf('circle', 'square', 'triangle', 'star'),
-    imageOpacity: isOpacity,
-};
-const STYLE_CHECKS = new Map(Object.entries(STYLE_CHECK_TABLE));
-function isRecord(value) {
-    return typeof value === 'object' && value !== null && !Array.isArray(value);
-}
-/**
- * Returns the usable part of an imported style
- *
- * A key of FeatureStyle whose value fails its check is dropped; every other key is kept.
- *
- * @param value The style as read from the file
- * @returns The style, or undefined when the value is not an object or nothing is left
- */
-export function sanitizeFeatureStyle(value) {
-    if (!isRecord(value))
-        return undefined;
-    const style = {};
-    let kept = 0;
-    for (const [key, entry] of Object.entries(value)) {
-        const check = STYLE_CHECKS.get(key);
-        if (check && !check(entry))
-            continue;
-        setOwnProperty(style, key, entry);
-        kept++;
-    }
-    return kept > 0 ? style : undefined;
-}

package/dist/api/import-export/types.d.ts

@@ -1,26 +0,0 @@
-/**
- * Types internal to the Import/Export module
- */
-import type { Feature, FileData } from '../../store/types.js';
-/**
- * GeoJSON import result (internal use).
- *
- * For a feature that contains image data, fileData is returned alongside it.
- */
-export interface ConvertedFeatureResult {
-    feature: Feature;
-    fileData?: FileData;
-}
-/**
- * Options for GeoJSON import
- */
-export interface GeoJSONImportOptions {
-    /**
-     * Whether to expand Multi* geometries into features with a single geometry
-     *
-     * The default is false, which keeps MultiPoint / MultiLineString / MultiPolygon
-     * as Multi features as they are (so properties are not duplicated).
-     * Setting it to true expands them as before, assigning a new ID to each part.
-     */
-    flattenMulti?: boolean;
-}

package/dist/api/index.d.ts

@@ -1,15 +0,0 @@
-/**
- * API module
- *
- * Only the symbols that src/index.ts publishes are listed here (see "The public
- * surface" in CONTRIBUTING.md). Internal code imports from the defining file.
- */
-export type { CustomFeatureHandler, CustomFeatureRenderer, CustomOverlayRenderer, CustomRendererDrawContext, CustomResizeResult, LayerAwareOverlayRenderer, } from '../extension/index.js';
-export type { EventPayloads, MapLibreGLDraw, TerrainDiagnostics, TerrainRenderDiagnostics, } from './api.js';
-export type { Options } from './context.js';
-export type { GeometryApi, GeometryApiDeps, GeometryBufferOptions, GeometryOperations, } from './geometry-operations.js';
-export { createGeometryApi } from './geometry-operations.js';
-export type { InputOperations, SyntheticInputOptions, SyntheticKeyOptions, SyntheticLngLat, SyntheticModifiers, } from './input-api.js';
-export type { SnappingOperations } from './snapping-api.js';
-export type { TopologyOperations } from './topology-api.js';
-export type { TracingOperations } from './tracing-api.js';

package/dist/api/index.js

@@ -1,3 +0,0 @@
-// SPDX-FileCopyrightText: 2026 SAKAIDA Atsushi
-// SPDX-License-Identifier: AGPL-3.0-only
-export { createGeometryApi } from './geometry-operations.js';

package/dist/api/input-api.d.ts

@@ -1,158 +0,0 @@
-import type { Coordinate } from '../store/types.js';
-/**
- * The coordinate of a synthetic input
- *
- * Either `{ lng, lat }` or `[lng, lat]` (Coordinate) can be passed. The screen position is
- * computed with `map.project`, so the caller does not prepare it.
- */
-export type SyntheticLngLat = {
-    lng: number;
-    lat: number;
-} | Coordinate;
-/**
- * The modifier keys of a synthetic input (an omitted key is false)
- */
-export interface SyntheticModifiers {
-    /** Whether Shift is held */
-    shift?: boolean;
-    /** Whether Alt (Option) is held; by default it releases snapping */
-    alt?: boolean;
-    /** Whether Ctrl is held */
-    ctrl?: boolean;
-    /** Whether Meta (Cmd) is held */
-    meta?: boolean;
-}
-/**
- * The options of a synthetic input (click / move)
- *
- * @example
- * ```typescript
- * // Place the point exactly where the numbers say, without snapping
- * draw.input.click([139.7, 35.68], { snap: false });
- * ```
- */
-export interface SyntheticInputOptions {
-    /** The modifier keys. When omitted, they are all false */
-    modifiers?: SyntheticModifiers;
-    /**
-     * Whether to pass through snapping (default true)
-     *
-     * Setting it to false raises `snap: false` on the normalized event, and the InputRouter
-     * distributes the raw coordinate to the modes without going through the SnapService. Use it
-     * when an exact coordinate is to be given numerically.
-     */
-    snap?: boolean;
-}
-/**
- * The options of a synthetic key input
- *
- * @example
- * ```typescript
- * draw.input.key('g', { modifiers: { ctrl: true } }); // groups the selection in select mode
- * ```
- */
-export interface SyntheticKeyOptions {
-    /** The modifier keys. When omitted, they are all false */
-    modifiers?: SyntheticModifiers;
-    /**
-     * The value equivalent to KeyboardEvent.code
-     *
-     * When omitted, it is inferred from key (alphanumerics become KeyA / Digit1, anything else
-     * is the same as key).
-     */
-    code?: string;
-}
-/**
- * The synthetic input of a draw instance, reached as `draw.input`: clicks, moves and keys
- * given to the modes from code.
- *
- * It is the path for giving points to a drawing mode from numeric input (a distance and a
- * bearing, absolute coordinates), from tests and from automation. The events enter where
- * real input is dispatched, so snapping and the plugins see them as usual and a mode needs
- * no special branch. The thresholds of real input (the click / drag distinction) are not
- * involved. A synthetic event counts as mouse input, and its `originalEvent` is a stand-in
- * marked with `synthetic: true`. The input fields of a numeric input UI are not part of the
- * library.
- *
- * @example
- * ```typescript
- * draw.setMode('draw_line');
- * draw.input.click([139.7, 35.68]);
- * draw.input.click([139.71, 35.68]);
- * draw.input.click([139.71, 35.69]);
- * draw.input.key('Enter');
- * // Finishing returns to select mode with the new feature selected
- * const [line] = draw.getSelectedFeatures();
- * ```
- */
-export interface InputOperations {
-    /**
-     * Synthesizes a click.
-     *
-     * So that the order matches that of a real cursor, it distributes a `mousemove` at the same
-     * coordinate and then distributes a `click`. The drawing modes interpret a click by looking
-     * at the state built up by the movement (the radius of a circle, the proximity test of the
-     * start and end points of a line or polygon), so these two are the minimal sequence that
-     * advances the drawing. Clicking the first point of a polygon again closes it; a circle takes
-     * a click on its center and one on its edge.
-     *
-     * @param lngLat where to click
-     * @param options the modifier keys and whether to snap
-     *
-     * @example
-     * ```typescript
-     * draw.setMode('draw_circle');
-     * draw.input.click([139.7, 35.68]); // the center
-     * draw.input.click([139.71, 35.68]); // sets the radius and finishes
-     * ```
-     */
-    click(lngLat: SyntheticLngLat, options?: SyntheticInputOptions): void;
-    /**
-     * Synthesizes a mouse move.
-     *
-     * It moves the preview while drawing (the tentative geometry) without adding a point.
-     *
-     * @param lngLat where the pointer moves to
-     * @param options the modifier keys and whether to snap
-     */
-    move(lngLat: SyntheticLngLat, options?: SyntheticInputOptions): void;
-    /**
-     * Synthesizes a key input (keydown).
-     *
-     * Enter finishes the drawing, Escape cancels it, and Backspace / Delete removes the last
-     * vertex. There is no path in the library that reads keyup, so only keydown is
-     * distributed.
-     *
-     * @param key the value of `KeyboardEvent.key` (`Enter`, `Escape`, `a` and so on)
-     * @param options the modifier keys and the `KeyboardEvent.code`
-     *
-     * @example
-     * ```typescript
-     * draw.input.key('Backspace'); // remove the last vertex
-     * draw.input.key('Escape'); // cancel the drawing
-     * ```
-     */
-    key(key: string, options?: SyntheticKeyOptions): void;
-    /**
-     * Switches the holding of pointer-originated input.
-     *
-     * It is the entry point for stopping pointer interruptions while the keyboard is deciding
-     * the coordinate, such as in a numeric input panel. While it is held, the click / dblclick /
-     * mousemove of the real pointer no longer reach the modes, and only synthetic input (click /
-     * move / key) moves the coordinate. Panning and zooming the map (mousedown / drag events)
-     * keep working while it is held.
-     *
-     * Be sure to set it back to false once the panel is closed.
-     *
-     * @param held true to hold the pointer input, false to release it
-     *
-     * @example
-     * ```typescript
-     * numericPanel.onopen = () => draw.input.setPointerHold(true);
-     * numericPanel.onclose = () => draw.input.setPointerHold(false);
-     * ```
-     */
-    setPointerHold(held: boolean): void;
-    /** Whether pointer-originated input is being held */
-    isPointerHeld(): boolean;
-}

package/dist/api/input-api.js

@@ -1,144 +0,0 @@
-// SPDX-FileCopyrightText: 2026 SAKAIDA Atsushi
-// SPDX-License-Identifier: AGPL-3.0-only
-/** The state in which no modifier key is pressed */
-const NO_MODIFIERS = { shift: false, ctrl: false, alt: false, meta: false };
-/**
- * The marker that indicates a synthetic event
- *
- * Attaching it to originalEvent makes it distinguishable from a real event in plugins and
- * while debugging.
- *
- * @internal
- */
-export const SYNTHETIC_EVENT_MARKER = 'synthetic';
-function toLngLat(lngLat) {
-    return Array.isArray(lngLat) ? { lng: lngLat[0], lat: lngLat[1] } : lngLat;
-}
-function toModifiers(modifiers) {
-    if (!modifiers)
-        return { ...NO_MODIFIERS };
-    return {
-        shift: modifiers.shift ?? false,
-        ctrl: modifiers.ctrl ?? false,
-        alt: modifiers.alt ?? false,
-        meta: modifiers.meta ?? false,
-    };
-}
-/**
- * Infers the equivalent of KeyboardEvent.code from key
- */
-function inferCode(key) {
-    if (/^[a-zA-Z]$/.test(key))
-        return `Key${key.toUpperCase()}`;
-    if (/^[0-9]$/.test(key))
-        return `Digit${key}`;
-    if (key === ' ')
-        return 'Space';
-    return key;
-}
-/**
- * A synthetic originalEvent (the equivalent of a MouseEvent)
- *
- * It is a minimal dummy that has only the members the InputRouter and the modes touch.
- * What the implementation touches is only preventDefault / stopPropagation (when the
- * InputRouter consumes onMouseDown, and the shortcuts of the select mode) and target (the
- * container test of the plugin interactions), so it is given those plus the fields for
- * reading the modifier keys and the coordinate.
- */
-function createSyntheticMouseEvent(type, point, modifiers) {
-    return {
-        type,
-        [SYNTHETIC_EVENT_MARKER]: true,
-        button: 0,
-        buttons: 0,
-        // A synthetic input has no offset on the page, so put in the canvas-relative coordinate as is
-        clientX: point.x,
-        clientY: point.y,
-        target: null,
-        currentTarget: null,
-        shiftKey: modifiers.shift,
-        ctrlKey: modifiers.ctrl,
-        altKey: modifiers.alt,
-        metaKey: modifiers.meta,
-        defaultPrevented: false,
-        preventDefault() { },
-        stopPropagation() { },
-        stopImmediatePropagation() { },
-    };
-}
-/**
- * A synthetic originalEvent (the equivalent of a KeyboardEvent)
- */
-function createSyntheticKeyboardEvent(key, code, modifiers) {
-    return {
-        type: 'keydown',
-        [SYNTHETIC_EVENT_MARKER]: true,
-        key,
-        code,
-        repeat: false,
-        target: null,
-        currentTarget: null,
-        shiftKey: modifiers.shift,
-        ctrlKey: modifiers.ctrl,
-        altKey: modifiers.alt,
-        metaKey: modifiers.meta,
-        defaultPrevented: false,
-        preventDefault() { },
-        stopPropagation() { },
-        stopImmediatePropagation() { },
-    };
-}
-/** @internal */
-export function createInputApi(deps) {
-    const { map, inputRouter } = deps;
-    /**
-     * Builds a normalized mouse event
-     *
-     * The screen point is computed with map.project (a value with the same meaning as the point
-     * the InputNormalizer receives from MapLibre).
-     */
-    function buildMouseEvent(type, lngLat, options) {
-        const resolved = toLngLat(lngLat);
-        const projected = map.project([resolved.lng, resolved.lat]);
-        const point = { x: projected.x, y: projected.y };
-        const modifiers = toModifiers(options?.modifiers);
-        return {
-            type,
-            point,
-            lngLat: { lng: resolved.lng, lat: resolved.lat },
-            originalEvent: createSyntheticMouseEvent(type, point, modifiers),
-            modifiers,
-            snap: options?.snap ?? true,
-        };
-    }
-    return {
-        input: {
-            click(lngLat, options) {
-                // Use the same order as a real cursor (move, then click).
-                inputRouter.dispatch(buildMouseEvent('mousemove', lngLat, options));
-                inputRouter.dispatch(buildMouseEvent('click', lngLat, options));
-            },
-            move(lngLat, options) {
-                inputRouter.dispatch(buildMouseEvent('mousemove', lngLat, options));
-            },
-            setPointerHold(held) {
-                inputRouter.setPointerHold(held);
-            },
-            isPointerHeld() {
-                return inputRouter.isPointerHeld();
-            },
-            key(key, options) {
-                const modifiers = toModifiers(options?.modifiers);
-                const code = options?.code ?? inferCode(key);
-                const event = {
-                    type: 'keydown',
-                    key,
-                    code,
-                    modifiers,
-                    originalEvent: createSyntheticKeyboardEvent(key, code, modifiers),
-                };
-                inputRouter.dispatch(event);
-            },
-        },
-    };
-}

package/dist/api/instance-api.d.ts

@@ -1,38 +0,0 @@
-/**
- * Instance API
- *
- * Provides the basic operations of a MapLibreGLDraw instance (getting the Map / Store,
- * switching the Mode, Metadata, destroy). It gathers the related methods that are small and
- * not large enough to deserve a file of their own.
- */
-import type { CustomLayerInterface as MapLibreCustomLayerInterface, Map as MapLibreMap } from 'maplibre-gl';
-import type { InputRouter } from '../dispatcher/input-router.js';
-import type { InputNormalizer } from '../dispatcher/normalizer.js';
-import type { ModeManager } from '../modes/manager.js';
-import type { PluginManager } from '../plugins/plugin-manager.js';
-import type { AutoNameGenerator } from '../shared/utils/name-generator.js';
-import type { PixelRatioSource } from '../shared/utils/pixel-ratio.js';
-import type { EventBridge } from '../store/event-bridge.js';
-import type { Store } from '../store/store.js';
-import type { RenderCoordinator } from '../view/coordinator.js';
-import type { CustomLayerInterface } from '../view/layer/index.js';
-import type { MapLibreGLDraw } from './api.js';
-export type InstanceApi = Pick<MapLibreGLDraw, 'getMap' | 'getStore' | 'getMode' | 'setMode' | 'getMetadata' | 'setMetadata' | 'isReadOnly' | 'setReadOnly' | 'isInteractionLocked' | 'setInteractionLock' | 'getRenderSlots' | 'getRenderScale' | 'setRenderScale' | 'getPixelRatio' | 'getTerrainDiagnostics' | 'hasPendingWork' | 'isLocallyHidden' | 'getLocallyHidden' | 'setLocallyHidden' | 'destroy'>;
-export interface InstanceApiDeps {
-    map: MapLibreMap;
-    store: Store;
-    modeManager: ModeManager;
-    eventBridge: EventBridge;
-    renderCoordinator: RenderCoordinator;
-    inputRouter: InputRouter;
-    inputNormalizer: InputNormalizer;
-    customLayer: MapLibreCustomLayerInterface | CustomLayerInterface;
-    autoNameGenerator: AutoNameGenerator;
-    /** Needed in order to unregister the plugins on destroy (releasing the extension point
-     * registries) */
-    pluginManager: PluginManager;
-    /** The source of the render scale (the actual object held by the Context; setRenderScale
-     * rewrites it) */
-    pixelRatioSource: PixelRatioSource;
-}
-export declare function createInstanceApi(deps: InstanceApiDeps): InstanceApi;