@ailuracode/alpine-geo 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) ailuracode
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,46 @@
+# @ailuracode/alpine-geo
+
+Geolocation store for Alpine.js.
+
+**[Full documentation →](../../docs/geo.md)**
+
+## Install
+
+```bash
+npm install @ailuracode/alpine-geo alpinejs
+```
+
+## Quick example
+
+```js
+import Alpine from "alpinejs";
+import geo from "@ailuracode/alpine-geo";
+
+Alpine.plugin(geo);
+Alpine.start();
+```
+
+```html
+<button @click="$store.geo.request()" :disabled="$store.geo.isLoading">
+  Get location
+</button>
+
+<p x-show="$store.geo.hasPosition">
+  Lat: <span x-text="$store.geo.latitude"></span>,
+  Lng: <span x-text="$store.geo.longitude"></span>
+</p>
+
+<p x-show="$store.geo.hasError" x-text="$store.geo.error"></p>
+```
+
+## API summary
+
+| | |
+|-|-|
+| **Store** | `$store.geo` |
+| **Actions** | `request()`, `watch()`, `unwatch()`, `reset()` |
+| **Getters** | `hasPosition`, `isSupported`, `isWatching`, `isLoading`, `hasError` |
+
+## License
+
+MIT

package/dist/global.d.ts

@@ -0,0 +1,39 @@
+/// <reference types="@types/alpinejs" />
+
+export interface GeoPositionOptions {
+  enableHighAccuracy?: boolean;
+  timeout?: number;
+  maximumAge?: number;
+}
+
+export interface GeoStore {
+  latitude: number | null;
+  longitude: number | null;
+  accuracy: number | null;
+  altitude: number | null;
+  altitudeAccuracy: number | null;
+  heading: number | null;
+  speed: number | null;
+  timestamp: number | null;
+  error: string | null;
+  errorCode: number | null;
+  loading: boolean;
+  watching: boolean;
+  request(options?: GeoPositionOptions): Promise<boolean>;
+  watch(options?: GeoPositionOptions): boolean;
+  unwatch(): boolean;
+  reset(): boolean;
+  readonly hasPosition: boolean;
+  readonly isSupported: boolean;
+  readonly isWatching: boolean;
+  readonly isLoading: boolean;
+  readonly hasError: boolean;
+}
+
+declare global {
+  namespace Alpine {
+    interface Stores {
+      geo: GeoStore;
+    }
+  }
+}

package/dist/index.d.ts

@@ -0,0 +1,41 @@
+import AlpineType from 'alpinejs';
+
+interface GeoPositionOptions {
+    enableHighAccuracy?: boolean;
+    timeout?: number;
+    maximumAge?: number;
+}
+interface GeoStore {
+    latitude: number | null;
+    longitude: number | null;
+    accuracy: number | null;
+    altitude: number | null;
+    altitudeAccuracy: number | null;
+    heading: number | null;
+    speed: number | null;
+    timestamp: number | null;
+    error: string | null;
+    errorCode: number | null;
+    loading: boolean;
+    watching: boolean;
+    request(options?: GeoPositionOptions): Promise<boolean>;
+    watch(options?: GeoPositionOptions): boolean;
+    unwatch(): boolean;
+    reset(): boolean;
+    readonly hasPosition: boolean;
+    readonly isSupported: boolean;
+    readonly isWatching: boolean;
+    readonly isLoading: boolean;
+    readonly hasError: boolean;
+}
+/** Alpine.js geolocation plugin. Registers `$store.geo`. */
+declare function geoPlugin(Alpine: AlpineType.Alpine): void;
+declare global {
+    namespace Alpine {
+        interface Stores {
+            geo: GeoStore;
+        }
+    }
+}
+
+export { type GeoPositionOptions, type GeoStore, geoPlugin as default };

package/dist/index.js

@@ -0,0 +1,127 @@
+// src/index.ts
+function applyPosition(store, position) {
+  store.latitude = position.coords.latitude;
+  store.longitude = position.coords.longitude;
+  store.accuracy = position.coords.accuracy;
+  store.altitude = position.coords.altitude;
+  store.altitudeAccuracy = position.coords.altitudeAccuracy;
+  store.heading = position.coords.heading;
+  store.speed = position.coords.speed;
+  store.timestamp = position.timestamp;
+  store.error = null;
+  store.errorCode = null;
+}
+function applyError(store, error) {
+  store.error = error.message;
+  store.errorCode = error.code;
+}
+function clearCoords(store) {
+  store.latitude = null;
+  store.longitude = null;
+  store.accuracy = null;
+  store.altitude = null;
+  store.altitudeAccuracy = null;
+  store.heading = null;
+  store.speed = null;
+  store.timestamp = null;
+}
+function clearPosition(store) {
+  clearCoords(store);
+  store.error = null;
+  store.errorCode = null;
+}
+function geoPlugin(Alpine) {
+  const supported = typeof navigator.geolocation?.getCurrentPosition === "function";
+  let watchId = null;
+  const geoStore = {
+    latitude: null,
+    longitude: null,
+    accuracy: null,
+    altitude: null,
+    altitudeAccuracy: null,
+    heading: null,
+    speed: null,
+    timestamp: null,
+    error: null,
+    errorCode: null,
+    loading: false,
+    watching: false,
+    get hasPosition() {
+      return this.latitude !== null && this.longitude !== null;
+    },
+    get isSupported() {
+      return supported;
+    },
+    get isWatching() {
+      return this.watching;
+    },
+    get isLoading() {
+      return this.loading;
+    },
+    get hasError() {
+      return this.error !== null;
+    },
+    request(options) {
+      if (!supported) {
+        this.error = "Geolocation is not supported";
+        this.errorCode = null;
+        return Promise.resolve(false);
+      }
+      this.loading = true;
+      this.error = null;
+      this.errorCode = null;
+      return new Promise((resolve) => {
+        navigator.geolocation.getCurrentPosition(
+          (position) => {
+            applyPosition(this, position);
+            this.loading = false;
+            resolve(true);
+          },
+          (error) => {
+            clearCoords(this);
+            applyError(this, error);
+            this.loading = false;
+            resolve(false);
+          },
+          options
+        );
+      });
+    },
+    watch(options) {
+      if (!supported || this.watching) {
+        return false;
+      }
+      this.error = null;
+      this.errorCode = null;
+      watchId = navigator.geolocation.watchPosition(
+        (position) => {
+          applyPosition(this, position);
+        },
+        (error) => {
+          applyError(this, error);
+        },
+        options
+      );
+      this.watching = true;
+      return true;
+    },
+    unwatch() {
+      if (watchId === null) {
+        return false;
+      }
+      navigator.geolocation.clearWatch(watchId);
+      watchId = null;
+      this.watching = false;
+      return true;
+    },
+    reset() {
+      clearPosition(this);
+      return true;
+    }
+  };
+  Alpine.store("geo", geoStore);
+}
+export {
+  geoPlugin as default
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type AlpineType from \"alpinejs\";\n\nexport interface GeoPositionOptions {\n  enableHighAccuracy?: boolean;\n  timeout?: number;\n  maximumAge?: number;\n}\n\nexport interface GeoStore {\n  latitude: number | null;\n  longitude: number | null;\n  accuracy: number | null;\n  altitude: number | null;\n  altitudeAccuracy: number | null;\n  heading: number | null;\n  speed: number | null;\n  timestamp: number | null;\n  error: string | null;\n  errorCode: number | null;\n  loading: boolean;\n  watching: boolean;\n  request(options?: GeoPositionOptions): Promise<boolean>;\n  watch(options?: GeoPositionOptions): boolean;\n  unwatch(): boolean;\n  reset(): boolean;\n  readonly hasPosition: boolean;\n  readonly isSupported: boolean;\n  readonly isWatching: boolean;\n  readonly isLoading: boolean;\n  readonly hasError: boolean;\n}\n\nfunction applyPosition(store: GeoStore, position: GeolocationPosition): void {\n  store.latitude = position.coords.latitude;\n  store.longitude = position.coords.longitude;\n  store.accuracy = position.coords.accuracy;\n  store.altitude = position.coords.altitude;\n  store.altitudeAccuracy = position.coords.altitudeAccuracy;\n  store.heading = position.coords.heading;\n  store.speed = position.coords.speed;\n  store.timestamp = position.timestamp;\n  store.error = null;\n  store.errorCode = null;\n}\n\nfunction applyError(store: GeoStore, error: GeolocationPositionError): void {\n  store.error = error.message;\n  store.errorCode = error.code;\n}\n\nfunction clearCoords(store: GeoStore): void {\n  store.latitude = null;\n  store.longitude = null;\n  store.accuracy = null;\n  store.altitude = null;\n  store.altitudeAccuracy = null;\n  store.heading = null;\n  store.speed = null;\n  store.timestamp = null;\n}\n\nfunction clearPosition(store: GeoStore): void {\n  clearCoords(store);\n  store.error = null;\n  store.errorCode = null;\n}\n\n/** Alpine.js geolocation plugin. Registers `$store.geo`. */\nexport default function geoPlugin(Alpine: AlpineType.Alpine): void {\n  const supported = typeof navigator.geolocation?.getCurrentPosition === \"function\";\n  let watchId: number | null = null;\n\n  const geoStore: GeoStore = {\n    latitude: null,\n    longitude: null,\n    accuracy: null,\n    altitude: null,\n    altitudeAccuracy: null,\n    heading: null,\n    speed: null,\n    timestamp: null,\n    error: null,\n    errorCode: null,\n    loading: false,\n    watching: false,\n\n    get hasPosition() {\n      return this.latitude !== null && this.longitude !== null;\n    },\n\n    get isSupported() {\n      return supported;\n    },\n\n    get isWatching() {\n      return this.watching;\n    },\n\n    get isLoading() {\n      return this.loading;\n    },\n\n    get hasError() {\n      return this.error !== null;\n    },\n\n    request(options?: GeoPositionOptions) {\n      if (!supported) {\n        this.error = \"Geolocation is not supported\";\n        this.errorCode = null;\n        return Promise.resolve(false);\n      }\n\n      this.loading = true;\n      this.error = null;\n      this.errorCode = null;\n\n      return new Promise((resolve) => {\n        navigator.geolocation.getCurrentPosition(\n          (position) => {\n            applyPosition(this, position);\n            this.loading = false;\n            resolve(true);\n          },\n          (error) => {\n            clearCoords(this);\n            applyError(this, error);\n            this.loading = false;\n            resolve(false);\n          },\n          options\n        );\n      });\n    },\n\n    watch(options?: GeoPositionOptions) {\n      if (!supported || this.watching) {\n        return false;\n      }\n\n      this.error = null;\n      this.errorCode = null;\n\n      watchId = navigator.geolocation.watchPosition(\n        (position) => {\n          applyPosition(this, position);\n        },\n        (error) => {\n          applyError(this, error);\n        },\n        options\n      );\n\n      this.watching = true;\n      return true;\n    },\n\n    unwatch() {\n      if (watchId === null) {\n        return false;\n      }\n\n      navigator.geolocation.clearWatch(watchId);\n      watchId = null;\n      this.watching = false;\n      return true;\n    },\n\n    reset() {\n      clearPosition(this);\n      return true;\n    },\n  };\n\n  Alpine.store(\"geo\", geoStore);\n}\n\ndeclare global {\n  namespace Alpine {\n    interface Stores {\n      geo: GeoStore;\n    }\n  }\n}\n"],"mappings":";AAgCA,SAAS,cAAc,OAAiB,UAAqC;AAC3E,QAAM,WAAW,SAAS,OAAO;AACjC,QAAM,YAAY,SAAS,OAAO;AAClC,QAAM,WAAW,SAAS,OAAO;AACjC,QAAM,WAAW,SAAS,OAAO;AACjC,QAAM,mBAAmB,SAAS,OAAO;AACzC,QAAM,UAAU,SAAS,OAAO;AAChC,QAAM,QAAQ,SAAS,OAAO;AAC9B,QAAM,YAAY,SAAS;AAC3B,QAAM,QAAQ;AACd,QAAM,YAAY;AACpB;AAEA,SAAS,WAAW,OAAiB,OAAuC;AAC1E,QAAM,QAAQ,MAAM;AACpB,QAAM,YAAY,MAAM;AAC1B;AAEA,SAAS,YAAY,OAAuB;AAC1C,QAAM,WAAW;AACjB,QAAM,YAAY;AAClB,QAAM,WAAW;AACjB,QAAM,WAAW;AACjB,QAAM,mBAAmB;AACzB,QAAM,UAAU;AAChB,QAAM,QAAQ;AACd,QAAM,YAAY;AACpB;AAEA,SAAS,cAAc,OAAuB;AAC5C,cAAY,KAAK;AACjB,QAAM,QAAQ;AACd,QAAM,YAAY;AACpB;AAGe,SAAR,UAA2B,QAAiC;AACjE,QAAM,YAAY,OAAO,UAAU,aAAa,uBAAuB;AACvE,MAAI,UAAyB;AAE7B,QAAM,WAAqB;AAAA,IACzB,UAAU;AAAA,IACV,WAAW;AAAA,IACX,UAAU;AAAA,IACV,UAAU;AAAA,IACV,kBAAkB;AAAA,IAClB,SAAS;AAAA,IACT,OAAO;AAAA,IACP,WAAW;AAAA,IACX,OAAO;AAAA,IACP,WAAW;AAAA,IACX,SAAS;AAAA,IACT,UAAU;AAAA,IAEV,IAAI,cAAc;AAChB,aAAO,KAAK,aAAa,QAAQ,KAAK,cAAc;AAAA,IACtD;AAAA,IAEA,IAAI,cAAc;AAChB,aAAO;AAAA,IACT;AAAA,IAEA,IAAI,aAAa;AACf,aAAO,KAAK;AAAA,IACd;AAAA,IAEA,IAAI,YAAY;AACd,aAAO,KAAK;AAAA,IACd;AAAA,IAEA,IAAI,WAAW;AACb,aAAO,KAAK,UAAU;AAAA,IACxB;AAAA,IAEA,QAAQ,SAA8B;AACpC,UAAI,CAAC,WAAW;AACd,aAAK,QAAQ;AACb,aAAK,YAAY;AACjB,eAAO,QAAQ,QAAQ,KAAK;AAAA,MAC9B;AAEA,WAAK,UAAU;AACf,WAAK,QAAQ;AACb,WAAK,YAAY;AAEjB,aAAO,IAAI,QAAQ,CAAC,YAAY;AAC9B,kBAAU,YAAY;AAAA,UACpB,CAAC,aAAa;AACZ,0BAAc,MAAM,QAAQ;AAC5B,iBAAK,UAAU;AACf,oBAAQ,IAAI;AAAA,UACd;AAAA,UACA,CAAC,UAAU;AACT,wBAAY,IAAI;AAChB,uBAAW,MAAM,KAAK;AACtB,iBAAK,UAAU;AACf,oBAAQ,KAAK;AAAA,UACf;AAAA,UACA;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACH;AAAA,IAEA,MAAM,SAA8B;AAClC,UAAI,CAAC,aAAa,KAAK,UAAU;AAC/B,eAAO;AAAA,MACT;AAEA,WAAK,QAAQ;AACb,WAAK,YAAY;AAEjB,gBAAU,UAAU,YAAY;AAAA,QAC9B,CAAC,aAAa;AACZ,wBAAc,MAAM,QAAQ;AAAA,QAC9B;AAAA,QACA,CAAC,UAAU;AACT,qBAAW,MAAM,KAAK;AAAA,QACxB;AAAA,QACA;AAAA,MACF;AAEA,WAAK,WAAW;AAChB,aAAO;AAAA,IACT;AAAA,IAEA,UAAU;AACR,UAAI,YAAY,MAAM;AACpB,eAAO;AAAA,MACT;AAEA,gBAAU,YAAY,WAAW,OAAO;AACxC,gBAAU;AACV,WAAK,WAAW;AAChB,aAAO;AAAA,IACT;AAAA,IAEA,QAAQ;AACN,oBAAc,IAAI;AAClB,aAAO;AAAA,IACT;AAAA,EACF;AAEA,SAAO,MAAM,OAAO,QAAQ;AAC9B;","names":[]}

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@ailuracode/alpine-geo",
+  "version": "0.1.0",
+  "description": "Alpine.js geolocation store",
+  "type": "module",
+  "license": "MIT",
+  "author": "ailuracode",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ailuracode/alpine.git",
+    "directory": "packages/geo"
+  },
+  "bugs": {
+    "url": "https://github.com/ailuracode/alpine/issues"
+  },
+  "homepage": "https://github.com/ailuracode/alpine/tree/master/packages/geo#readme",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./global": {
+      "types": "./dist/global.d.ts"
+    }
+  },
+  "types": "./dist/global.d.ts",
+  "peerDependencies": {
+    "alpinejs": "^3.0.0",
+    "@types/alpinejs": "^3.13.11"
+  },
+  "peerDependenciesMeta": {
+    "@types/alpinejs": {
+      "optional": true
+    }
+  },
+  "keywords": [
+    "alpinejs",
+    "alpine",
+    "plugin",
+    "geolocation",
+    "gps",
+    "location"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts --format esm --dts --clean --sourcemap --out-dir dist && cp src/global.d.ts dist/global.d.ts",
+    "test": "vitest run --config ../../vitest.config.js test"
+  }
+}