@geospatial-sdk/maplibre 0.0.5-dev.43 → 0.0.5-dev.45

package/README.md

@@ -1,11 +1,42 @@
-# `maplibre`
+# `@geospatial-sdk/maplibre`
 
-> TODO: description
+<!-- #region body -->
 
-## Usage
+This package provides utilities to create and manage [MapLibre GL JS](https://maplibre.org/) maps using the declarative Map Context model from `@geospatial-sdk/core`.
+
+## Installation
 
+```sh
+npm install @geospatial-sdk/maplibre
 ```
-const openlayers = require('maplibre');
 
-// TODO: DEMONSTRATE API
+## Usage
+
+```typescript
+import { createMapFromContext } from "@geospatial-sdk/maplibre";
+import type { MapContext } from "@geospatial-sdk/core";
+
+const mapContext: MapContext = {
+  layers: [
+    {
+      type: "xyz",
+      url: "https://tile.openstreetmap.org/{z}/{x}/{y}.png",
+    },
+  ],
+  view: {
+    center: [6, 48.5],
+    zoom: 5,
+  },
+};
+
+const map = await createMapFromContext(
+  mapContext,
+  document.getElementById("map"),
+);
 ```
+
+<!-- #endregion body -->
+
+## Documentation
+
+For more detailed API documentation, see the [documentation website](https://camptocamp.github.io/geospatial-sdk/docs/).

package/dist/index.d.ts

@@ -1,3 +1,8 @@
+/**
+ * {@include ../README.md#body}
+ *
+ * @module 📦 maplibre
+ */
 export * from "./map/index.js";
 export * from "./maplibre.models.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC"}

package/dist/index.js

@@ -1,2 +1,7 @@
+/**
+ * {@include ../README.md#body}
+ *
+ * @module 📦 maplibre
+ */
 export * from "./map/index.js";
 export * from "./maplibre.models.js";

package/dist/map/index.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @hideGroups
+ * @packageDocumentation
+ */
 export { createMapFromContext, resetMapFromContext } from "./create-map.js";
 export { applyContextDiffToMap } from "./apply-context-diff.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/map/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/map/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAC5E,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/map/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAC5E,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC"}

package/dist/map/index.js

@@ -1,2 +1,6 @@
+/**
+ * @hideGroups
+ * @packageDocumentation
+ */
 export { createMapFromContext, resetMapFromContext } from "./create-map.js";
 export { applyContextDiffToMap } from "./apply-context-diff.js";

package/lib/helpers/style.helpers.test.ts

@@ -1,5 +1,5 @@
 import { describe, expect, it } from "vitest";
-import { contextStyleToMaplibreLayers } from "./style.helpers";
+import { contextStyleToMaplibreLayers } from "./style.helpers.js";
 
 const defautlMaplibreFill = {
   type: "fill",

package/lib/index.ts

@@ -1,2 +1,8 @@
+/**
+ * {@include ../README.md#body}
+ *
+ * @module 📦 maplibre
+ */
+
 export * from "./map/index.js";
 export * from "./maplibre.models.js";

package/lib/map/apply-context-diff.test.ts

@@ -1,15 +1,13 @@
 import { beforeEach, describe, expect, it, vi } from "vitest";
-import { MapContext, MapContextDiff } from "@geospatial-sdk/core";
+import { MapContextDiff } from "@geospatial-sdk/core";
 import {
-  SAMPLE_CONTEXT,
   SAMPLE_LAYER1,
   SAMPLE_LAYER2,
   SAMPLE_LAYER3,
   SAMPLE_LAYER4,
-} from "@geospatial-sdk/core/fixtures/map-context.fixtures";
-import { applyContextDiffToMap } from "./apply-context-diff";
-import * as mapHelpers from "../helpers/map.helpers";
-import { getBeforeId } from "../helpers/map.helpers";
+} from "@geospatial-sdk/core/fixtures/map-context.fixtures.js";
+import { applyContextDiffToMap } from "./apply-context-diff.js";
+import * as mapHelpers from "../helpers/map.helpers.js";
 
 // Helper to create a fresh mock Map instance for each test
 function createMockMap() {
@@ -26,15 +24,10 @@ function createMockMap() {
 }
 
 describe("applyContextDiffToMap (mocked Map)", () => {
-  let context: MapContext;
   let diff: MapContextDiff;
   let map: ReturnType<typeof createMockMap>;
 
   beforeEach(async () => {
-    context = {
-      ...SAMPLE_CONTEXT,
-      layers: [SAMPLE_LAYER2, SAMPLE_LAYER1],
-    };
     map = createMockMap();
     map.getStyle.mockReturnValue({ layers: [], sources: {} });
   });
@@ -90,9 +83,6 @@ describe("applyContextDiffToMap (mocked Map)", () => {
     const generateLayerIdSpy = vi
       .spyOn(mapHelpers, "generateLayerId")
       .mockReturnValue("azreza");
-    const getBeforeId = vi
-      .spyOn(mapHelpers, "getBeforeId")
-      .mockReturnValue("azreza");
     const removeLayersFromSourceSpy = vi.spyOn(
       mapHelpers,
       "removeLayersFromSource",

package/lib/map/create-map.test.ts

@@ -5,9 +5,9 @@ import {
   MAP_CTX_LAYER_OGCAPI_FIXTURE,
   MAP_CTX_LAYER_WFS_FIXTURE,
   MAP_CTX_LAYER_WMS_FIXTURE,
-} from "@geospatial-sdk/core/fixtures/map-context.fixtures";
+} from "@geospatial-sdk/core/fixtures/map-context.fixtures.js";
 import { LayerGeojsonWithData, MapContextLayer } from "@geospatial-sdk/core";
-import { createLayer } from "./create-map";
+import { createLayer } from "./create-map.js";
 import {
   FillLayerSpecification,
   GeoJSONSourceSpecification,
@@ -16,8 +16,8 @@ import {
 import {
   FEATURE_COLLECTION_LINESTRING_FIXTURE_4326,
   FEATURE_COLLECTION_POLYGON_FIXTURE_4326,
-} from "@geospatial-sdk/core/fixtures/geojson.fixtures";
-import { PartialStyleSpecification } from "../maplibre.models";
+} from "@geospatial-sdk/core/fixtures/geojson.fixtures.js";
+import { PartialStyleSpecification } from "../maplibre.models.js";
 import {
   CircleLayerSpecification,
   LayerSpecification,

package/lib/map/index.ts

@@ -1,2 +1,7 @@
+/**
+ * @hideGroups
+ * @packageDocumentation
+ */
+
 export { createMapFromContext, resetMapFromContext } from "./create-map.js";
 export { applyContextDiffToMap } from "./apply-context-diff.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@geospatial-sdk/maplibre",
-  "version": "0.0.5-dev.43+a7f100d",
+  "version": "0.0.5-dev.45+a90fe28",
   "description": "Maplibre-related utilities",
   "keywords": [
     "maplibre",
@@ -33,7 +33,7 @@
     "maplibre-gl": "^5.7.3"
   },
   "dependencies": {
-    "@geospatial-sdk/core": "^0.0.5-dev.43+a7f100d"
+    "@geospatial-sdk/core": "^0.0.5-dev.45+a90fe28"
   },
-  "gitHead": "a7f100dfebe66dff0f44abb4c630917db89453fd"
+  "gitHead": "a90fe28ac749e1d35a976bdcfd02cb47357e8955"
 }