@opendfieldmap/map 0.1.0-alpha.0

package/dist/tileVersion.d.ts

@@ -0,0 +1,7 @@
+import type { OEMFloor, OEMRegion } from '@opendfieldmap/core';
+export interface OEMTileLookup {
+    covered: boolean;
+    version?: string;
+}
+export declare const lookupOEMTile: (coverage: OEMRegion["coverage"], floor: OEMFloor, zoom: number, x: number, y: number) => OEMTileLookup;
+export declare const appendOEMTileVersion: (url: string, version?: string) => string;

package/dist/types.d.ts

@@ -0,0 +1,78 @@
+import type { OEMManifest, OEMPointFilter, OEMPosition, OEMResources, OEMView } from '@opendfieldmap/core';
+/** Optional static layers controlled independently by the host. */
+export interface OEMFeatures {
+    points?: boolean;
+    labels?: boolean;
+    boundaries?: boolean;
+}
+/** Low-level rendering options used by the public Widget package. */
+export interface OEMOptions {
+    resources: OEMResources;
+    manifest?: OEMManifest;
+    regionId?: string;
+    floorId?: string;
+    locale?: string;
+    theme?: 'light' | 'dark';
+    view?: OEMView;
+    features?: OEMFeatures;
+    pointFilter?: OEMPointFilter;
+    /** Groups nearby markers by point type. Defaults to true. */
+    markerClustering?: boolean;
+    /** Prevents user drag and trackpad-pan gestures without blocking programmatic view changes. */
+    lockDrag?: boolean;
+    /** Prevents user zoom gestures without blocking programmatic view changes. */
+    lockZoom?: boolean;
+    signal?: AbortSignal;
+    onError?: (error: Error) => void;
+}
+/** Lifecycle events emitted by a low-level OEM map instance. */
+export interface OEMEvents {
+    viewchange: OEMView;
+    regionchange: {
+        regionId: string;
+    };
+    floorchange: {
+        floorId: string;
+    };
+    loading: {
+        feature: 'points' | 'labels' | 'boundaries';
+        loading: boolean;
+    };
+    load: {
+        regionId: string;
+        floorId: string;
+    };
+    error: Error;
+}
+/** Controls whether a programmatic zoom uses Leaflet's native transition. */
+export interface OEMZoomOptions {
+    animate?: boolean;
+}
+/**
+ * The framework-agnostic OEM rendering kernel.
+ *
+ * The embeddable Widget exposes a smaller surface and does not pass through
+ * Leaflet or map-layer objects.
+ */
+export interface OEM {
+    readonly manifest: OEMManifest;
+    readonly destroyed: boolean;
+    getView(): OEMView;
+    setView(view: OEMView): void;
+    setZoom(zoom: number, options?: OEMZoomOptions): void;
+    fitBounds(bounds: [OEMPosition, OEMPosition]): void;
+    setRegion(regionId: string): Promise<void>;
+    setFloor(floorId: string): void;
+    setLocale(locale: string): Promise<void>;
+    getLocale(): {
+        requested: string;
+        resolved: string;
+    };
+    setTheme(theme: 'light' | 'dark'): void;
+    setFeatures(features: OEMFeatures): Promise<void>;
+    setPointFilter(filter: OEMPointFilter): void;
+    setMarkerClustering(enabled: boolean): void;
+    resize(): void;
+    on<Event extends keyof OEMEvents>(event: Event, handler: (payload: OEMEvents[Event]) => void): () => void;
+    destroy(): void;
+}

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@opendfieldmap/map",
+  "version": "0.1.0-alpha.0",
+  "description": "Rendering kernel for Open Endfield Map widgets",
+  "type": "module",
+  "license": "AGPL-3.0-only",
+  "files": [
+    "dist",
+    "LICENSE"
+  ],
+  "sideEffects": [
+    "**/*.css"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./style.css": "./dist/style.css"
+  },
+  "dependencies": {
+    "leaflet": "1.9.4",
+    "leaflet.markercluster": "1.5.3",
+    "trackpad-input": "0.1.1",
+    "@opendfieldmap/core": "^0.1.0-alpha.0"
+  },
+  "devDependencies": {
+    "@types/leaflet": "1.9.16",
+    "@types/leaflet.markercluster": "1.5.6"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}