@geolonia/maps-core 0.0.1

package/dist/index.d.cts

@@ -0,0 +1,206 @@
+import maplibregl, { IControl, ControlPosition, Map, MapOptions, ExpiryData, StyleSpecification, StyleSwapOptions, StyleOptions, GetResourceResponse, MarkerOptions } from 'maplibre-gl';
+
+/**
+ * Custom Attribution Control using Shadow DOM.
+ * Based on maplibre-gl-js's AttributionControl.
+ * https://github.com/maplibre/maplibre-gl-js/blob/main/src/ui/control/attribution_control.ts
+ *
+ * Uses Shadow DOM to isolate attribution styles from the host page,
+ * preventing style conflicts. Collapses to an "i" icon on small maps.
+ */
+interface CustomAttributionControlOptions {
+    compact?: boolean;
+    customAttribution?: string | string[];
+}
+interface StyleDataEvent {
+    sourceDataType?: string;
+    dataType?: string;
+    type?: string;
+}
+declare class CustomAttributionControl implements IControl {
+    private options;
+    private _map;
+    private _compact;
+    private _container;
+    private _shadowContainer;
+    private _innerContainer;
+    private _compactButton;
+    private _editLink;
+    private _attribHTML;
+    private styleId;
+    private styleOwner;
+    private printQuery;
+    private onMediaPrintChange;
+    constructor(options?: CustomAttributionControlOptions);
+    getDefaultPosition(): ControlPosition;
+    onAdd(map: Map): HTMLDivElement;
+    onRemove(): void;
+    _setElementTitle(element: HTMLElement, title: string): void;
+    _toggleAttribution(): void;
+    _updateData(e: StyleDataEvent): void;
+    _updateAttributions(): void;
+    _updateCompact(): void;
+    _updateCompactMinimize(): void;
+}
+
+declare class GeoloniaControl implements IControl {
+    private container;
+    onAdd(): HTMLDivElement;
+    onRemove(): void;
+    getDefaultPosition(): ControlPosition;
+}
+
+type GeoloniaMapOptions = MapOptions & {
+    /** Geolonia API key */
+    apiKey?: string;
+    /** API stage (e.g. 'dev', 'v1') */
+    stage?: string;
+    /** Map style name or URL. Default: 'geolonia/basic-v2' */
+    style?: string;
+    /** Language for style labels. Default: 'auto' */
+    lang?: "ja" | "en" | "auto";
+    /** Show default marker at center */
+    marker?: boolean;
+    /** Marker color (CSS color string) */
+    markerColor?: string;
+    /** Automatically open marker popup on load */
+    openPopup?: boolean;
+    /** CSS selector for a custom marker element */
+    customMarker?: string;
+    /** Offset for custom marker as [x, y] */
+    customMarkerOffset?: [number, number];
+    /** Show loader animation during map load */
+    loader?: boolean;
+    /** Enable gesture handling for scroll pages */
+    gestureHandling?: boolean;
+    /** Navigation control. true, false, or a position string */
+    navigationControl?: boolean | ControlPosition;
+    /** Geolocate control */
+    geolocateControl?: boolean | ControlPosition;
+    /** Fullscreen control */
+    fullscreenControl?: boolean | ControlPosition;
+    /** Scale control */
+    scaleControl?: boolean | ControlPosition;
+    /** Geolonia logo control */
+    geoloniaControl?: boolean | ControlPosition;
+    /** GeoJSON URL or object for SimpleStyle */
+    geojson?: string | GeoJSON.GeoJSON;
+    /** Enable clustering for GeoJSON points */
+    cluster?: boolean;
+    /** Cluster marker color */
+    clusterColor?: string;
+    /** Simple vector tile URL */
+    simpleVector?: string;
+    /** Enable 3D mode */
+    "3d"?: boolean;
+};
+
+type GetImageCallback = (error?: Error | null, image?: HTMLImageElement | ImageBitmap | null, expiry?: ExpiryData | null) => void;
+declare function isGeoloniaTilesHost(url: string | URL): boolean;
+/**
+ * Resolve style name or URL to a full style URL.
+ */
+declare function getStyle(style: string, options: {
+    lang?: string;
+    apiKey?: string;
+}): string;
+/**
+ * Detect browser language.
+ */
+declare function getLang(): "ja" | "en";
+
+/**
+ * Geolonia Map - extends MapLibre GL Map with Geolonia-specific features.
+ * Accepts a GeoloniaMapOptions object directly (no DOM attribute parsing).
+ */
+declare class GeoloniaMap extends maplibregl.Map {
+    private geoloniaSourcesUrl;
+    private __styleExtensionLoadRequired;
+    constructor(options: GeoloniaMapOptions);
+    setStyle(style: string | StyleSpecification, options?: StyleSwapOptions & StyleOptions): this;
+    remove(): void;
+    loadImage(url: string, callback: GetImageCallback): void;
+    loadImage(url: string): Promise<GetResourceResponse<HTMLImageElement | ImageBitmap>>;
+}
+
+declare class GeoloniaMarker extends maplibregl.Marker {
+    constructor(options?: MarkerOptions);
+}
+
+declare class Keyring {
+    #private;
+    get apiKey(): string;
+    get stage(): string;
+    get isGeoloniaStyle(): boolean;
+    set isGeoloniaStyle(value: boolean);
+    setApiKey(key: string): void;
+    setStage(stage: string): void;
+    reset(): void;
+    /**
+     * Check if the given style is a Geolonia style (requires API key)
+     */
+    isGeoloniaStyleCheck(style: string): boolean;
+}
+declare const keyring: Keyring;
+
+declare class SimpleStyle {
+    _loadingPromise: Promise<unknown> | undefined;
+    private callFitBounds;
+    private geojson;
+    private map;
+    private options;
+    private _eventHandlers;
+    constructor(geojson: string | GeoJSON.GeoJSON, options?: Record<string, any>);
+    updateData(geojson: any): this;
+    addTo(map: any): this;
+    fitBounds(options?: {}): this;
+    /**
+     * Set polygon geometries.
+     */
+    setPolygonGeometries(): void;
+    /**
+     * Set line geometries.
+     */
+    setLineGeometries(): void;
+    /**
+     * Setup point geometries.
+     */
+    setPointGeometries(): void;
+    setPopup(map: any, source: string): Promise<void>;
+    /**
+     * Setup cluster markers
+     */
+    setCluster(): void;
+    remove(): this;
+    setGeoJSON(geojson: string | GeoJSON.GeoJSON): void;
+}
+
+declare class SimpleStyleVector {
+    private url;
+    private sourceName;
+    constructor(url: string);
+    addTo(map: any): void;
+    /**
+     * Set polygon geometries.
+     *
+     * @param map
+     */
+    setPolygonGeometries(map: any): void;
+    /**
+     * Set line geometries.
+     *
+     * @param map
+     */
+    setLineGeometries(map: any): void;
+    /**
+     * Setup point geometries.
+     *
+     * @param map
+     */
+    setPointGeometries(map: any): void;
+    setPopup(map: any, source: string): Promise<void>;
+}
+
+declare const VERSION = "0.1.0";
+
+export { CustomAttributionControl, GeoloniaControl, GeoloniaMap, type GeoloniaMapOptions, GeoloniaMarker, SimpleStyle, SimpleStyleVector, VERSION as coreVersion, getLang, getStyle, isGeoloniaTilesHost, keyring };

package/dist/index.d.ts

@@ -0,0 +1,206 @@
+import maplibregl, { IControl, ControlPosition, Map, MapOptions, ExpiryData, StyleSpecification, StyleSwapOptions, StyleOptions, GetResourceResponse, MarkerOptions } from 'maplibre-gl';
+
+/**
+ * Custom Attribution Control using Shadow DOM.
+ * Based on maplibre-gl-js's AttributionControl.
+ * https://github.com/maplibre/maplibre-gl-js/blob/main/src/ui/control/attribution_control.ts
+ *
+ * Uses Shadow DOM to isolate attribution styles from the host page,
+ * preventing style conflicts. Collapses to an "i" icon on small maps.
+ */
+interface CustomAttributionControlOptions {
+    compact?: boolean;
+    customAttribution?: string | string[];
+}
+interface StyleDataEvent {
+    sourceDataType?: string;
+    dataType?: string;
+    type?: string;
+}
+declare class CustomAttributionControl implements IControl {
+    private options;
+    private _map;
+    private _compact;
+    private _container;
+    private _shadowContainer;
+    private _innerContainer;
+    private _compactButton;
+    private _editLink;
+    private _attribHTML;
+    private styleId;
+    private styleOwner;
+    private printQuery;
+    private onMediaPrintChange;
+    constructor(options?: CustomAttributionControlOptions);
+    getDefaultPosition(): ControlPosition;
+    onAdd(map: Map): HTMLDivElement;
+    onRemove(): void;
+    _setElementTitle(element: HTMLElement, title: string): void;
+    _toggleAttribution(): void;
+    _updateData(e: StyleDataEvent): void;
+    _updateAttributions(): void;
+    _updateCompact(): void;
+    _updateCompactMinimize(): void;
+}
+
+declare class GeoloniaControl implements IControl {
+    private container;
+    onAdd(): HTMLDivElement;
+    onRemove(): void;
+    getDefaultPosition(): ControlPosition;
+}
+
+type GeoloniaMapOptions = MapOptions & {
+    /** Geolonia API key */
+    apiKey?: string;
+    /** API stage (e.g. 'dev', 'v1') */
+    stage?: string;
+    /** Map style name or URL. Default: 'geolonia/basic-v2' */
+    style?: string;
+    /** Language for style labels. Default: 'auto' */
+    lang?: "ja" | "en" | "auto";
+    /** Show default marker at center */
+    marker?: boolean;
+    /** Marker color (CSS color string) */
+    markerColor?: string;
+    /** Automatically open marker popup on load */
+    openPopup?: boolean;
+    /** CSS selector for a custom marker element */
+    customMarker?: string;
+    /** Offset for custom marker as [x, y] */
+    customMarkerOffset?: [number, number];
+    /** Show loader animation during map load */
+    loader?: boolean;
+    /** Enable gesture handling for scroll pages */
+    gestureHandling?: boolean;
+    /** Navigation control. true, false, or a position string */
+    navigationControl?: boolean | ControlPosition;
+    /** Geolocate control */
+    geolocateControl?: boolean | ControlPosition;
+    /** Fullscreen control */
+    fullscreenControl?: boolean | ControlPosition;
+    /** Scale control */
+    scaleControl?: boolean | ControlPosition;
+    /** Geolonia logo control */
+    geoloniaControl?: boolean | ControlPosition;
+    /** GeoJSON URL or object for SimpleStyle */
+    geojson?: string | GeoJSON.GeoJSON;
+    /** Enable clustering for GeoJSON points */
+    cluster?: boolean;
+    /** Cluster marker color */
+    clusterColor?: string;
+    /** Simple vector tile URL */
+    simpleVector?: string;
+    /** Enable 3D mode */
+    "3d"?: boolean;
+};
+
+type GetImageCallback = (error?: Error | null, image?: HTMLImageElement | ImageBitmap | null, expiry?: ExpiryData | null) => void;
+declare function isGeoloniaTilesHost(url: string | URL): boolean;
+/**
+ * Resolve style name or URL to a full style URL.
+ */
+declare function getStyle(style: string, options: {
+    lang?: string;
+    apiKey?: string;
+}): string;
+/**
+ * Detect browser language.
+ */
+declare function getLang(): "ja" | "en";
+
+/**
+ * Geolonia Map - extends MapLibre GL Map with Geolonia-specific features.
+ * Accepts a GeoloniaMapOptions object directly (no DOM attribute parsing).
+ */
+declare class GeoloniaMap extends maplibregl.Map {
+    private geoloniaSourcesUrl;
+    private __styleExtensionLoadRequired;
+    constructor(options: GeoloniaMapOptions);
+    setStyle(style: string | StyleSpecification, options?: StyleSwapOptions & StyleOptions): this;
+    remove(): void;
+    loadImage(url: string, callback: GetImageCallback): void;
+    loadImage(url: string): Promise<GetResourceResponse<HTMLImageElement | ImageBitmap>>;
+}
+
+declare class GeoloniaMarker extends maplibregl.Marker {
+    constructor(options?: MarkerOptions);
+}
+
+declare class Keyring {
+    #private;
+    get apiKey(): string;
+    get stage(): string;
+    get isGeoloniaStyle(): boolean;
+    set isGeoloniaStyle(value: boolean);
+    setApiKey(key: string): void;
+    setStage(stage: string): void;
+    reset(): void;
+    /**
+     * Check if the given style is a Geolonia style (requires API key)
+     */
+    isGeoloniaStyleCheck(style: string): boolean;
+}
+declare const keyring: Keyring;
+
+declare class SimpleStyle {
+    _loadingPromise: Promise<unknown> | undefined;
+    private callFitBounds;
+    private geojson;
+    private map;
+    private options;
+    private _eventHandlers;
+    constructor(geojson: string | GeoJSON.GeoJSON, options?: Record<string, any>);
+    updateData(geojson: any): this;
+    addTo(map: any): this;
+    fitBounds(options?: {}): this;
+    /**
+     * Set polygon geometries.
+     */
+    setPolygonGeometries(): void;
+    /**
+     * Set line geometries.
+     */
+    setLineGeometries(): void;
+    /**
+     * Setup point geometries.
+     */
+    setPointGeometries(): void;
+    setPopup(map: any, source: string): Promise<void>;
+    /**
+     * Setup cluster markers
+     */
+    setCluster(): void;
+    remove(): this;
+    setGeoJSON(geojson: string | GeoJSON.GeoJSON): void;
+}
+
+declare class SimpleStyleVector {
+    private url;
+    private sourceName;
+    constructor(url: string);
+    addTo(map: any): void;
+    /**
+     * Set polygon geometries.
+     *
+     * @param map
+     */
+    setPolygonGeometries(map: any): void;
+    /**
+     * Set line geometries.
+     *
+     * @param map
+     */
+    setLineGeometries(map: any): void;
+    /**
+     * Setup point geometries.
+     *
+     * @param map
+     */
+    setPointGeometries(map: any): void;
+    setPopup(map: any, source: string): Promise<void>;
+}
+
+declare const VERSION = "0.1.0";
+
+export { CustomAttributionControl, GeoloniaControl, GeoloniaMap, type GeoloniaMapOptions, GeoloniaMarker, SimpleStyle, SimpleStyleVector, VERSION as coreVersion, getLang, getStyle, isGeoloniaTilesHost, keyring };