@ailuracode/alpine-platform 1.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,69 @@
+# @ailuracode/alpine-platform
+
+Alpine.js magic for detecting the client's operating system and platform.
+
+## Install
+
+```bash
+npm install @ailuracode/alpine-platform alpinejs
+```
+
+## Setup
+
+```js
+import Alpine from "alpinejs";
+import platform from "@ailuracode/alpine-platform";
+
+Alpine.plugin(platform);
+Alpine.start();
+```
+
+## Magic API
+
+| Property | Type | Description |
+|----------|------|-------------|
+| `name` | `"macos" \| "windows" \| "linux" \| "ios" \| "android" \| "chromeos" \| "unknown"` | Resolved platform |
+| `isMac` | `boolean` | Desktop macOS |
+| `isWindows` | `boolean` | Windows |
+| `isLinux` | `boolean` | Desktop Linux |
+| `isIos` | `boolean` | iOS / iPadOS |
+| `isAndroid` | `boolean` | Android |
+| `isChromeos` | `boolean` | ChromeOS |
+
+## HTML examples
+
+```html
+<p x-show="$platform.isMac">Use ⌘ shortcuts</p>
+<p x-show="$platform.isWindows">Use Ctrl shortcuts</p>
+<p x-show="$platform.isIos">Open from the Home Screen for full support</p>
+
+<p>Platform: <span x-text="$platform.name"></span></p>
+```
+
+## Exported helpers
+
+Pure detection functions are exported for use in other packages or tests:
+
+```js
+import {
+  detectPlatformName,
+  isAndroidDevice,
+  isIosDevice,
+  isLinuxDevice,
+  isMacDevice,
+  isWindowsDevice,
+  readPlatformState,
+} from "@ailuracode/alpine-platform";
+```
+
+Detection uses `navigator.userAgentData.platform` when available, then falls back to `navigator.userAgent` and `navigator.platform`. iPadOS desktop mode is detected via `MacIntel` + `maxTouchPoints > 1`.
+
+## Notes
+
+- Read-only magic — no store
+- CSS-framework agnostic
+- For viewport breakpoints use `@ailuracode/alpine-screen`; for touch hardware use `@ailuracode/alpine-touch`
+
+## License
+
+MIT

package/dist/global.d.ts

@@ -0,0 +1,28 @@
+/// <reference types="@types/alpinejs" />
+
+export type PlatformName =
+  | "macos"
+  | "windows"
+  | "linux"
+  | "ios"
+  | "android"
+  | "chromeos"
+  | "unknown";
+
+export interface PlatformMagic {
+  name: PlatformName;
+  isMac: boolean;
+  isWindows: boolean;
+  isLinux: boolean;
+  isIos: boolean;
+  isAndroid: boolean;
+  isChromeos: boolean;
+}
+
+declare global {
+  namespace Alpine {
+    interface Magics<T> {
+      $platform: PlatformMagic;
+    }
+  }
+}

package/dist/index.d.ts

@@ -0,0 +1,39 @@
+import AlpineType from 'alpinejs';
+
+type PlatformName = "macos" | "windows" | "linux" | "ios" | "android" | "chromeos" | "unknown";
+interface PlatformMagic {
+    name: PlatformName;
+    isMac: boolean;
+    isWindows: boolean;
+    isLinux: boolean;
+    isIos: boolean;
+    isAndroid: boolean;
+    isChromeos: boolean;
+}
+/** Detects iOS/iPadOS (including iPadOS desktop UA). */
+declare function isIosDevice(): boolean;
+/** Detects Android phones and tablets. */
+declare function isAndroidDevice(): boolean;
+/** Detects ChromeOS devices. */
+declare function isChromeOsDevice(): boolean;
+/** Detects desktop Windows. */
+declare function isWindowsDevice(): boolean;
+/** Detects desktop macOS (excludes iOS/iPadOS). */
+declare function isMacDevice(): boolean;
+/** Detects desktop Linux (excludes Android and ChromeOS). */
+declare function isLinuxDevice(): boolean;
+/** Resolves the primary platform name for the current environment. */
+declare function detectPlatformName(): PlatformName;
+/** Reads the current platform state from the environment. */
+declare function readPlatformState(): PlatformMagic;
+/** Alpine.js platform plugin. Registers reactive magic `$platform`. */
+declare function platformPlugin(Alpine: AlpineType.Alpine): void;
+declare global {
+    namespace Alpine {
+        interface Magics<T> {
+            $platform: PlatformMagic;
+        }
+    }
+}
+
+export { type PlatformMagic, type PlatformName, platformPlugin as default, detectPlatformName, isAndroidDevice, isChromeOsDevice, isIosDevice, isLinuxDevice, isMacDevice, isWindowsDevice, readPlatformState };

package/dist/index.js

@@ -0,0 +1,121 @@
+// src/index.ts
+function getNavigator() {
+  return typeof navigator !== "undefined" ? navigator : void 0;
+}
+function getClientHintPlatform() {
+  const nav = getNavigator();
+  return nav?.userAgentData?.platform?.toLowerCase();
+}
+function isIosDevice() {
+  const nav = getNavigator();
+  if (!nav) {
+    return false;
+  }
+  const ua = nav.userAgent;
+  if (/iPad|iPhone|iPod/i.test(ua)) {
+    return true;
+  }
+  return nav.platform === "MacIntel" && nav.maxTouchPoints > 1;
+}
+function isAndroidDevice() {
+  const nav = getNavigator();
+  if (!nav) {
+    return false;
+  }
+  return /Android/i.test(nav.userAgent);
+}
+function isChromeOsDevice() {
+  const nav = getNavigator();
+  if (!nav) {
+    return false;
+  }
+  return /CrOS/i.test(nav.userAgent);
+}
+function isWindowsDevice() {
+  const nav = getNavigator();
+  if (!nav) {
+    return false;
+  }
+  const hint = getClientHintPlatform();
+  if (hint === "windows") {
+    return true;
+  }
+  return /Win/i.test(nav.platform) || /Windows/i.test(nav.userAgent);
+}
+function isMacDevice() {
+  if (isIosDevice()) {
+    return false;
+  }
+  const nav = getNavigator();
+  if (!nav) {
+    return false;
+  }
+  const hint = getClientHintPlatform();
+  if (hint === "macos") {
+    return true;
+  }
+  return /Mac/i.test(nav.platform) || /Macintosh/i.test(nav.userAgent);
+}
+function isLinuxDevice() {
+  if (isAndroidDevice() || isChromeOsDevice()) {
+    return false;
+  }
+  const nav = getNavigator();
+  if (!nav) {
+    return false;
+  }
+  const hint = getClientHintPlatform();
+  if (hint === "linux") {
+    return true;
+  }
+  return /Linux/i.test(nav.platform) || /X11/i.test(nav.userAgent);
+}
+function detectPlatformName() {
+  if (isIosDevice()) {
+    return "ios";
+  }
+  if (isAndroidDevice()) {
+    return "android";
+  }
+  if (isChromeOsDevice()) {
+    return "chromeos";
+  }
+  if (isWindowsDevice()) {
+    return "windows";
+  }
+  if (isMacDevice()) {
+    return "macos";
+  }
+  if (isLinuxDevice()) {
+    return "linux";
+  }
+  return "unknown";
+}
+function readPlatformState() {
+  const name = detectPlatformName();
+  return {
+    name,
+    isMac: name === "macos",
+    isWindows: name === "windows",
+    isLinux: name === "linux",
+    isIos: name === "ios",
+    isAndroid: name === "android",
+    isChromeos: name === "chromeos"
+  };
+}
+function platformPlugin(Alpine) {
+  const state = Alpine.reactive(readPlatformState());
+  Alpine.magic("platform", () => state);
+}
+export {
+  platformPlugin as default,
+  detectPlatformName,
+  isAndroidDevice,
+  isChromeOsDevice,
+  isIosDevice,
+  isLinuxDevice,
+  isMacDevice,
+  isWindowsDevice,
+  readPlatformState
+};
+//# 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 type PlatformName =\n  | \"macos\"\n  | \"windows\"\n  | \"linux\"\n  | \"ios\"\n  | \"android\"\n  | \"chromeos\"\n  | \"unknown\";\n\nexport interface PlatformMagic {\n  name: PlatformName;\n  isMac: boolean;\n  isWindows: boolean;\n  isLinux: boolean;\n  isIos: boolean;\n  isAndroid: boolean;\n  isChromeos: boolean;\n}\n\ntype NavigatorWithUserAgentData = Navigator & {\n  userAgentData?: {\n    platform?: string;\n  };\n};\n\nfunction getNavigator(): Navigator | undefined {\n  return typeof navigator !== \"undefined\" ? navigator : undefined;\n}\n\nfunction getClientHintPlatform(): string | undefined {\n  const nav = getNavigator() as NavigatorWithUserAgentData | undefined;\n  return nav?.userAgentData?.platform?.toLowerCase();\n}\n\n/** Detects iOS/iPadOS (including iPadOS desktop UA). */\nexport function isIosDevice(): boolean {\n  const nav = getNavigator();\n  if (!nav) {\n    return false;\n  }\n\n  const ua = nav.userAgent;\n  if (/iPad|iPhone|iPod/i.test(ua)) {\n    return true;\n  }\n\n  return nav.platform === \"MacIntel\" && nav.maxTouchPoints > 1;\n}\n\n/** Detects Android phones and tablets. */\nexport function isAndroidDevice(): boolean {\n  const nav = getNavigator();\n  if (!nav) {\n    return false;\n  }\n\n  return /Android/i.test(nav.userAgent);\n}\n\n/** Detects ChromeOS devices. */\nexport function isChromeOsDevice(): boolean {\n  const nav = getNavigator();\n  if (!nav) {\n    return false;\n  }\n\n  return /CrOS/i.test(nav.userAgent);\n}\n\n/** Detects desktop Windows. */\nexport function isWindowsDevice(): boolean {\n  const nav = getNavigator();\n  if (!nav) {\n    return false;\n  }\n\n  const hint = getClientHintPlatform();\n  if (hint === \"windows\") {\n    return true;\n  }\n\n  return /Win/i.test(nav.platform) || /Windows/i.test(nav.userAgent);\n}\n\n/** Detects desktop macOS (excludes iOS/iPadOS). */\nexport function isMacDevice(): boolean {\n  if (isIosDevice()) {\n    return false;\n  }\n\n  const nav = getNavigator();\n  if (!nav) {\n    return false;\n  }\n\n  const hint = getClientHintPlatform();\n  if (hint === \"macos\") {\n    return true;\n  }\n\n  return /Mac/i.test(nav.platform) || /Macintosh/i.test(nav.userAgent);\n}\n\n/** Detects desktop Linux (excludes Android and ChromeOS). */\nexport function isLinuxDevice(): boolean {\n  if (isAndroidDevice() || isChromeOsDevice()) {\n    return false;\n  }\n\n  const nav = getNavigator();\n  if (!nav) {\n    return false;\n  }\n\n  const hint = getClientHintPlatform();\n  if (hint === \"linux\") {\n    return true;\n  }\n\n  return /Linux/i.test(nav.platform) || /X11/i.test(nav.userAgent);\n}\n\n/** Resolves the primary platform name for the current environment. */\nexport function detectPlatformName(): PlatformName {\n  if (isIosDevice()) {\n    return \"ios\";\n  }\n  if (isAndroidDevice()) {\n    return \"android\";\n  }\n  if (isChromeOsDevice()) {\n    return \"chromeos\";\n  }\n  if (isWindowsDevice()) {\n    return \"windows\";\n  }\n  if (isMacDevice()) {\n    return \"macos\";\n  }\n  if (isLinuxDevice()) {\n    return \"linux\";\n  }\n\n  return \"unknown\";\n}\n\n/** Reads the current platform state from the environment. */\nexport function readPlatformState(): PlatformMagic {\n  const name = detectPlatformName();\n\n  return {\n    name,\n    isMac: name === \"macos\",\n    isWindows: name === \"windows\",\n    isLinux: name === \"linux\",\n    isIos: name === \"ios\",\n    isAndroid: name === \"android\",\n    isChromeos: name === \"chromeos\",\n  };\n}\n\n/** Alpine.js platform plugin. Registers reactive magic `$platform`. */\nexport default function platformPlugin(Alpine: AlpineType.Alpine): void {\n  const state = Alpine.reactive(readPlatformState());\n\n  Alpine.magic(\"platform\", () => state);\n}\n\ndeclare global {\n  namespace Alpine {\n    interface Magics<T> {\n      $platform: PlatformMagic;\n    }\n  }\n}\n"],"mappings":";AA2BA,SAAS,eAAsC;AAC7C,SAAO,OAAO,cAAc,cAAc,YAAY;AACxD;AAEA,SAAS,wBAA4C;AACnD,QAAM,MAAM,aAAa;AACzB,SAAO,KAAK,eAAe,UAAU,YAAY;AACnD;AAGO,SAAS,cAAuB;AACrC,QAAM,MAAM,aAAa;AACzB,MAAI,CAAC,KAAK;AACR,WAAO;AAAA,EACT;AAEA,QAAM,KAAK,IAAI;AACf,MAAI,oBAAoB,KAAK,EAAE,GAAG;AAChC,WAAO;AAAA,EACT;AAEA,SAAO,IAAI,aAAa,cAAc,IAAI,iBAAiB;AAC7D;AAGO,SAAS,kBAA2B;AACzC,QAAM,MAAM,aAAa;AACzB,MAAI,CAAC,KAAK;AACR,WAAO;AAAA,EACT;AAEA,SAAO,WAAW,KAAK,IAAI,SAAS;AACtC;AAGO,SAAS,mBAA4B;AAC1C,QAAM,MAAM,aAAa;AACzB,MAAI,CAAC,KAAK;AACR,WAAO;AAAA,EACT;AAEA,SAAO,QAAQ,KAAK,IAAI,SAAS;AACnC;AAGO,SAAS,kBAA2B;AACzC,QAAM,MAAM,aAAa;AACzB,MAAI,CAAC,KAAK;AACR,WAAO;AAAA,EACT;AAEA,QAAM,OAAO,sBAAsB;AACnC,MAAI,SAAS,WAAW;AACtB,WAAO;AAAA,EACT;AAEA,SAAO,OAAO,KAAK,IAAI,QAAQ,KAAK,WAAW,KAAK,IAAI,SAAS;AACnE;AAGO,SAAS,cAAuB;AACrC,MAAI,YAAY,GAAG;AACjB,WAAO;AAAA,EACT;AAEA,QAAM,MAAM,aAAa;AACzB,MAAI,CAAC,KAAK;AACR,WAAO;AAAA,EACT;AAEA,QAAM,OAAO,sBAAsB;AACnC,MAAI,SAAS,SAAS;AACpB,WAAO;AAAA,EACT;AAEA,SAAO,OAAO,KAAK,IAAI,QAAQ,KAAK,aAAa,KAAK,IAAI,SAAS;AACrE;AAGO,SAAS,gBAAyB;AACvC,MAAI,gBAAgB,KAAK,iBAAiB,GAAG;AAC3C,WAAO;AAAA,EACT;AAEA,QAAM,MAAM,aAAa;AACzB,MAAI,CAAC,KAAK;AACR,WAAO;AAAA,EACT;AAEA,QAAM,OAAO,sBAAsB;AACnC,MAAI,SAAS,SAAS;AACpB,WAAO;AAAA,EACT;AAEA,SAAO,SAAS,KAAK,IAAI,QAAQ,KAAK,OAAO,KAAK,IAAI,SAAS;AACjE;AAGO,SAAS,qBAAmC;AACjD,MAAI,YAAY,GAAG;AACjB,WAAO;AAAA,EACT;AACA,MAAI,gBAAgB,GAAG;AACrB,WAAO;AAAA,EACT;AACA,MAAI,iBAAiB,GAAG;AACtB,WAAO;AAAA,EACT;AACA,MAAI,gBAAgB,GAAG;AACrB,WAAO;AAAA,EACT;AACA,MAAI,YAAY,GAAG;AACjB,WAAO;AAAA,EACT;AACA,MAAI,cAAc,GAAG;AACnB,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAGO,SAAS,oBAAmC;AACjD,QAAM,OAAO,mBAAmB;AAEhC,SAAO;AAAA,IACL;AAAA,IACA,OAAO,SAAS;AAAA,IAChB,WAAW,SAAS;AAAA,IACpB,SAAS,SAAS;AAAA,IAClB,OAAO,SAAS;AAAA,IAChB,WAAW,SAAS;AAAA,IACpB,YAAY,SAAS;AAAA,EACvB;AACF;AAGe,SAAR,eAAgC,QAAiC;AACtE,QAAM,QAAQ,OAAO,SAAS,kBAAkB,CAAC;AAEjD,SAAO,MAAM,YAAY,MAAM,KAAK;AACtC;","names":[]}

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@ailuracode/alpine-platform",
+  "version": "1.1.0",
+  "description": "Alpine.js client platform and operating system detection magic",
+  "type": "module",
+  "license": "MIT",
+  "author": "ailuracode",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ailuracode/alpine.git",
+    "directory": "packages/platform"
+  },
+  "bugs": {
+    "url": "https://github.com/ailuracode/alpine/issues"
+  },
+  "homepage": "https://github.com/ailuracode/alpine/tree/master/packages/platform#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",
+    "platform",
+    "os",
+    "operating-system",
+    "user-agent",
+    "macos",
+    "windows",
+    "linux",
+    "ios",
+    "android"
+  ],
+  "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"
+  }
+}