nuxt-maplibre-gl 1.0.4 → 2.0.1

package/README.md

@@ -6,21 +6,43 @@
 
 ## Features
 
-- Auto-import 10+ map components (Maplibre, GeoJsonSource, FillLayer, etc.)
-- Auto-import 15+ composables (useFlyTo, useMapEventListener, etc.)
-- Auto-import CSS — no manual style import needed
-- SSR-safe — components register client-only, composables have browser guards
+- Auto-imports all 10 map components (Maplibre, GeoJsonSource, FillLayer, etc.)
+- Auto-imports all 38 composables (useFlyTo, useMapEventListener, etc.)
+- Auto-imports CSS — both `maplibre-gl/dist/maplibre-gl.css` and `vue3-maplibre-gl/dist/style.css`
+- SSR-safe — components register client-only, `maplibre-gl` is kept out of the server bundle
 - Zero configuration required
 
+`vue3-maplibre-gl` and `maplibre-gl` are dependencies of this module, so installing it is enough — there is nothing else to add to your app.
+
 ## Installation
 
+### Using Bun (Recommended)
+
 ```bash
 bun add nuxt-maplibre-gl
 ```
 
+### Using npm
+
+```bash
+npm install nuxt-maplibre-gl
+```
+
+### Using Yarn
+
+```bash
+yarn add nuxt-maplibre-gl
+```
+
+### Using pnpm
+
+```bash
+pnpm add nuxt-maplibre-gl
+```
+
 ## Setup
 
-Add to `nuxt.config.ts`:
+Add to `nuxt.config.ts`. The config key is `maplibre`, not the module name:
 
 ```typescript
 export default defineNuxtConfig({
@@ -28,8 +50,8 @@ export default defineNuxtConfig({
 
   // Optional configuration
   maplibre: {
-    css: true,    // auto-import CSS (default: true)
-    prefix: '',   // composable prefix (default: none)
+    css: true, // auto-import CSS (default: true)
+    prefix: '', // composable prefix (default: none)
   },
 });
 ```
@@ -70,23 +92,47 @@ const circleStyle = ref({ 'circle-radius': 6, 'circle-color': '#007cbf' });
 
 ## Auto-imported Components
 
-| Component | Description |
-|---|---|
-| `Maplibre` | Main map container |
-| `GeoJsonSource` | GeoJSON data source |
-| `FillLayer` | Fill polygons |
-| `CircleLayer` | Circle points |
-| `LineLayer` | Line features |
-| `SymbolLayer` | Icons and text |
-| `Marker` | HTML markers |
-| `PopUp` | Popup windows |
-| `Image` | Map images |
-| `GeolocateControls` | Geolocation |
+| Component           | Description         |
+| ------------------- | ------------------- |
+| `Maplibre`          | Main map container  |
+| `GeoJsonSource`     | GeoJSON data source |
+| `FillLayer`         | Fill polygons       |
+| `CircleLayer`       | Circle points       |
+| `LineLayer`         | Line features       |
+| `SymbolLayer`       | Icons and text      |
+| `Marker`            | HTML markers        |
+| `Popup`             | Popup windows       |
+| `Image`             | Map images          |
+| `GeolocateControls` | Geolocation         |
 
 ## Auto-imported Composables
 
-All 15+ composables from vue3-maplibre-gl are auto-imported:
-`useCreateMaplibre`, `useFlyTo`, `useEaseTo`, `useJumpTo`, `useMapEventListener`, etc.
+All 38 composables from vue3-maplibre-gl are auto-imported — `useCreateMaplibre`,
+`useMaplibre`, `useFlyTo`, `useEaseTo`, `useJumpTo`, `useMapEventListener`,
+`useCreateGeoJsonSource` and the rest. Set `prefix` to namespace them: with
+`prefix: 'map'` they are imported as `mapUseFlyTo`, `mapUseMapEventListener`, and
+so on.
+
+The full reference lives at
+[vue-maplibre-gl.pages.dev/api/composables](https://vue-maplibre-gl.pages.dev/api/composables).
+
+## Documentation
+
+- [SSR / Nuxt guide](https://vue-maplibre-gl.pages.dev/guide/ssr-nuxt) — what this module configures, and how to use it without the module
+- [Components API](https://vue-maplibre-gl.pages.dev/api/components)
+- [Composables API](https://vue-maplibre-gl.pages.dev/api/composables)
+- [Examples](https://vue-maplibre-gl.pages.dev/examples/)
+
+## Releasing
+
+This module depends on `vue3-maplibre-gl` by version range, and both are published from the same repository. Release them in this order, from the repository root:
+
+1. `bun run publish:vue` — publishes the root package.
+2. `bun run publish:nuxt` — refuses to run until the `vue3-maplibre-gl` range in `nuxt/package.json` resolves on npm, then refreshes `nuxt/bun.lock`, builds, and publishes.
+
+Neither script picks a version. Set `version` in the manifest yourself before releasing, so the bump reflects what actually changed — this module tracks `vue3-maplibre-gl` by major, so a new major there is a new major here.
+
+Commit the refreshed `nuxt/bun.lock` afterwards.
 
 ## License
 

package/dist/module.d.mts

@@ -1,7 +1,7 @@
 import * as _nuxt_schema from '@nuxt/schema';
 
 interface ModuleOptions {
-    /** Auto-import vue3-maplibre-gl CSS (default: true) */
+    /** Auto-import the MapLibre GL and vue3-maplibre-gl stylesheets (default: true) */
     css?: boolean;
     /** Prefix for auto-imported composables (default: none) */
     prefix?: string;

package/dist/module.json

@@ -2,14 +2,15 @@
   "name": "nuxt-maplibre-gl",
   "configKey": "maplibre",
   "description": "Nuxt module for vue3-maplibre-gl with auto-import, SSR support, and full TypeScript",
+  "docs": "https://vue-maplibre-gl.pages.dev/",
   "links": {
-    "documentation": "https://github.com/danh121097/vue-maplibre-gl",
+    "documentation": "https://vue-maplibre-gl.pages.dev/",
     "repository": "https://github.com/danh121097/vue-maplibre-gl"
   },
   "compatibility": {
     "nuxt": ">=3.0.0"
   },
-  "version": "1.0.4",
+  "version": "2.0.1",
   "builder": {
     "@nuxt/module-builder": "1.0.2",
     "unbuild": "3.6.1"

package/dist/module.mjs

@@ -5,8 +5,12 @@ const module$1 = defineNuxtModule({
     name: "nuxt-maplibre-gl",
     configKey: "maplibre",
     description: "Nuxt module for vue3-maplibre-gl with auto-import, SSR support, and full TypeScript",
+    // `docs` is what nuxt.com/modules reads out of the published
+    // dist/module.json to link the listing at the documentation site; without
+    // it the listing falls back to the GitHub repository.
+    docs: "https://vue-maplibre-gl.pages.dev/",
     links: {
-      documentation: "https://github.com/danh121097/vue-maplibre-gl",
+      documentation: "https://vue-maplibre-gl.pages.dev/",
       repository: "https://github.com/danh121097/vue-maplibre-gl"
     },
     compatibility: {
@@ -17,10 +21,13 @@ const module$1 = defineNuxtModule({
     css: true,
     prefix: ""
   },
-  setup(options, nuxt) {
-    const { resolve } = createResolver(import.meta.url);
+  async setup(options, nuxt) {
+    const { resolve, resolvePath } = createResolver(import.meta.url);
     if (options.css) {
-      nuxt.options.css.push("vue3-maplibre-gl/dist/style.css");
+      nuxt.options.css.push(
+        await resolvePath("maplibre-gl/dist/maplibre-gl.css"),
+        await resolvePath("vue3-maplibre-gl/dist/style.css")
+      );
     }
     nuxt.options.build.transpile.push("vue3-maplibre-gl");
     nuxt.options.vite.optimizeDeps ??= {};
@@ -33,21 +40,37 @@ const module$1 = defineNuxtModule({
       mode: "client"
     });
     const composables = [
+      // Map instance
       "useCreateMaplibre",
       "useMaplibre",
+      "useMaplibreConfig",
+      // Layers
+      "useCreateLayer",
       "useCreateFillLayer",
       "useCreateCircleLayer",
       "useCreateLineLayer",
       "useCreateSymbolLayer",
+      "useLayer",
+      // Sources
       "useCreateGeoJsonSource",
       "useGeoJsonSource",
+      // Map objects
+      "useCreateMarker",
+      "useCreatePopup",
+      "useCreateImage",
+      // Controls
+      "useGeolocateControl",
+      // Events
       "useMapEventListener",
       "useLayerEventListener",
       "useGeolocateEventListener",
+      "useMapReloadEvent",
+      // Camera
       "useFlyTo",
       "useEaseTo",
       "useJumpTo",
       "useFitBounds",
+      "useFitScreenCoordinates",
       "useCameraForBounds",
       "useZoomTo",
       "useZoomIn",
@@ -57,7 +80,12 @@ const module$1 = defineNuxtModule({
       "useRotateTo",
       "useResetNorth",
       "useResetNorthPitch",
-      "useSnapToNorth"
+      "useSnapToNorth",
+      // Utilities
+      "useDebounce",
+      "useDebouncedRef",
+      "useDebouncedWatch",
+      "useLogger"
     ];
     addImports(
       composables.map((name) => ({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-maplibre-gl",
-  "version": "1.0.4",
+  "version": "2.0.1",
   "description": "Nuxt module for vue3-maplibre-gl — auto-import components, composables, CSS, and SSR configuration",
   "type": "module",
   "license": "MIT",
@@ -8,7 +8,7 @@
     "name": "Danh Nguyen",
     "url": "https://harrynguyen.work"
   },
-  "homepage": "https://github.com/danh121097/vue-maplibre-gl#readme",
+  "homepage": "https://vue-maplibre-gl.pages.dev/",
   "bugs": {
     "url": "https://github.com/danh121097/vue-maplibre-gl/issues"
   },
@@ -46,14 +46,12 @@
     "dev:prepare": "nuxt-module-build build --stub && nuxi prepare playground",
     "dev": "nuxi dev playground",
     "build": "nuxt-module-build build",
-    "prepack": "nuxt-module-build build",
-    "test": "vitest run",
-    "publish:manual": "npm publish --provenance --access public",
-    "publish:manual:otp": "npm publish --provenance --access public --otp=$NPM_OTP"
+    "prepack": "nuxt-module-build build"
   },
   "dependencies": {
     "@nuxt/kit": "^3.15.0",
-    "vue3-maplibre-gl": "^5.0.0"
+    "maplibre-gl": "^5.6.1",
+    "vue3-maplibre-gl": "^6.0.0"
   },
   "devDependencies": {
     "@nuxt/module-builder": "^1.0.2",