browser-haptic 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Emirhan Kemal Kosem emirhankemalkosem@gmail.com
+
+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,86 @@
+# browser-haptic
+
+Lightweight haptic feedback for JavaScript. This repo uses **Bun**. Uses the [Vibration API](https://developer.mozilla.org/en-US/docs/Web/API/Vibration_API) where available (e.g. Android). On **iOS Safari 17.4+** it uses a hidden `input[switch]` toggle so the native switch haptic fires. No runtime dependencies.
+
+## Install
+
+```bash
+bun add browser-haptic
+```
+
+## Usage
+
+Import the default export as **`Haptic`** and call its methods:
+
+```ts
+import Haptic from "browser-haptic";
+
+if (Haptic.isSupported()) {
+  Haptic.light();
+  Haptic.success();
+  Haptic.vibrate([10, 50, 10, 50, 10]);
+}
+```
+
+**React example:**
+
+```tsx
+import Haptic from "browser-haptic";
+
+const App = () => {
+  const supported = Haptic.isSupported();
+
+  return (
+    <button onClick={() => Haptic.heavy()}>
+      Tap me
+    </button>
+  );
+};
+```
+
+You can also use named imports if you prefer: `import { light, success, isSupported } from "browser-haptic"`.
+
+## API
+
+| Method | Description |
+|--------|-------------|
+| `Haptic.isSupported()` | `true` if feedback is available (Vibration API or DOM for iOS switch fallback) |
+| `Haptic.hasVibration()` | `true` only when the Vibration API is available (e.g. Android) |
+| `Haptic.vibrate(pattern)` | Trigger feedback: `number` (ms) or `number[]` (vibrate/pause sequence) |
+| `Haptic.light()` | Short tap |
+| `Haptic.medium()` | Medium tap |
+| `Haptic.heavy()` | Strong tap |
+| `Haptic.success()` | Double tap |
+| `Haptic.warning()` | Triple tap |
+| `Haptic.error()` | Longer alert pattern |
+
+**Type:** `VibrationPattern` = `number | number[]` (for `vibrate()`).
+
+On iOS Safari 17.4+, `isSupported()` is `true` but `hasVibration()` is `false`; the library uses a hidden native switch toggle.
+
+## Test
+
+```bash
+bun test
+```
+
+Coverage (enforces 80% lines and functions):
+
+```bash
+bun run coverage
+```
+
+## Contributing
+
+Contributions are welcome. To get started:
+
+1. Fork the repo and clone it locally.
+2. Install dependencies: `bun install`
+3. Make your changes and run tests: `bun test`
+4. Open a pull request with a short description of the change.
+
+For bugs or feature ideas, please open an issue first so we can discuss.
+
+## License
+
+MIT

package/dist/haptic.d.ts

@@ -0,0 +1,24 @@
+export type VibrationPattern = number | number[];
+export interface Haptic {
+    hasVibration(): boolean;
+    isSupported(): boolean;
+    vibrate(pattern: VibrationPattern): void;
+    light(): void;
+    medium(): void;
+    heavy(): void;
+    success(): void;
+    warning(): void;
+    error(): void;
+}
+export declare const hasVibration: () => boolean;
+export declare const isSupported: () => boolean;
+export declare const vibrate: (pattern: VibrationPattern) => void;
+export declare const light: () => void;
+export declare const medium: () => void;
+export declare const heavy: () => void;
+export declare const success: () => void;
+export declare const warning: () => void;
+export declare const error: () => void;
+declare const Haptic: Haptic;
+export default Haptic;
+//# sourceMappingURL=haptic.d.ts.map

package/dist/haptic.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"haptic.d.ts","sourceRoot":"","sources":["../src/haptic.ts"],"names":[],"mappings":"AA4BA,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC;AAUjD,MAAM,WAAW,MAAM;IACrB,YAAY,IAAI,OAAO,CAAC;IACxB,WAAW,IAAI,OAAO,CAAC;IACvB,OAAO,CAAC,OAAO,EAAE,gBAAgB,GAAG,IAAI,CAAC;IACzC,KAAK,IAAI,IAAI,CAAC;IACd,MAAM,IAAI,IAAI,CAAC;IACf,KAAK,IAAI,IAAI,CAAC;IACd,OAAO,IAAI,IAAI,CAAC;IAChB,OAAO,IAAI,IAAI,CAAC;IAChB,KAAK,IAAI,IAAI,CAAC;CACf;AA6ED,eAAO,MAAM,YAAY,QAAO,OAA4B,CAAC;AAmB7D,eAAO,MAAM,WAAW,QAAO,OAG9B,CAAC;AAoBF,eAAO,MAAM,OAAO,GAAI,SAAS,gBAAgB,KAAG,IAAwB,CAAC;AAQ7E,eAAO,MAAM,KAAK,QAAO,IAA8B,CAAC;AAQxD,eAAO,MAAM,MAAM,QAAO,IAA+B,CAAC;AAQ1D,eAAO,MAAM,KAAK,QAAO,IAA8B,CAAC;AAQxD,eAAO,MAAM,OAAO,QAAO,IAAqC,CAAC;AASjE,eAAO,MAAM,OAAO,QAAO,IAAqC,CAAC;AAQjE,eAAO,MAAM,KAAK,QAAO,IAAmC,CAAC;AAE7D,QAAA,MAAM,MAAM,EAAE,MAUb,CAAC;AAiBF,eAAe,MAAM,CAAC"}

package/dist/haptic.js

@@ -0,0 +1,75 @@
+const PRESETS = {
+    light: 10,
+    medium: 20,
+    heavy: 40,
+    success: [10, 50, 10],
+    warning: [30, 30, 30],
+    error: [50, 30, 50, 30, 50],
+};
+const hasVibrationAPI = () => typeof navigator !== "undefined" && typeof navigator.vibrate === "function";
+const hasDOM = () => typeof document !== "undefined" && !!document.body;
+const fireIOSSwitch = () => {
+    if (!hasDOM())
+        return;
+    try {
+        const label = document.createElement("label");
+        label.setAttribute("aria-hidden", "true");
+        label.style.cssText =
+            "position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0;";
+        const input = document.createElement("input");
+        input.type = "checkbox";
+        input.setAttribute("switch", "");
+        label.appendChild(input);
+        document.body.appendChild(label);
+        label.click();
+        document.body.removeChild(label);
+    }
+    catch {
+    }
+};
+const toPatternArray = (pattern) => Array.isArray(pattern) ? [...pattern] : [pattern];
+const trigger = (pattern) => {
+    if (hasVibrationAPI()) {
+        try {
+            const p = Array.isArray(pattern) ? [...pattern] : pattern;
+            navigator.vibrate(p);
+        }
+        catch {
+        }
+        return;
+    }
+    const arr = toPatternArray(pattern);
+    let delay = 0;
+    for (let i = 0; i < arr.length; i += 2) {
+        const vibrateMs = arr[i] ?? 0;
+        const pauseMs = arr[i + 1] ?? 0;
+        if (vibrateMs > 0)
+            setTimeout(fireIOSSwitch, delay);
+        delay += vibrateMs + pauseMs;
+    }
+};
+export const hasVibration = () => hasVibrationAPI();
+export const isSupported = () => {
+    if (typeof navigator === "undefined" || typeof document === "undefined")
+        return false;
+    return hasVibrationAPI() || hasDOM();
+};
+export const vibrate = (pattern) => trigger(pattern);
+export const light = () => trigger(PRESETS.light);
+export const medium = () => trigger(PRESETS.medium);
+export const heavy = () => trigger(PRESETS.heavy);
+export const success = () => trigger([...PRESETS.success]);
+export const warning = () => trigger([...PRESETS.warning]);
+export const error = () => trigger([...PRESETS.error]);
+const Haptic = {
+    hasVibration,
+    isSupported,
+    vibrate,
+    light,
+    medium,
+    heavy,
+    success,
+    warning,
+    error,
+};
+export default Haptic;

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { hasVibration, isSupported, vibrate, light, medium, heavy, success, warning, error, type VibrationPattern, type Haptic, } from "./haptic.js";
+export { default } from "./haptic.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EACZ,WAAW,EACX,OAAO,EACP,KAAK,EACL,MAAM,EACN,KAAK,EACL,OAAO,EACP,OAAO,EACP,KAAK,EACL,KAAK,gBAAgB,EACrB,KAAK,MAAM,GACZ,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC"}

package/dist/index.js

@@ -0,0 +1,2 @@
+export { hasVibration, isSupported, vibrate, light, medium, heavy, success, warning, error, } from "./haptic.js";
+export { default } from "./haptic.js";

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "browser-haptic",
+  "version": "1.0.0",
+  "description": "Lightweight haptic feedback for JS (Vibration API + iOS Safari switch fallback). No deps.",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "test": "bun test",
+    "coverage": "bun test --coverage",
+    "clean": "node -e \"require('fs').rmSync('dist',{recursive:true,force:true})\"",
+    "build": "bun run clean && tsc",
+    "prepublishOnly": "bun run build"
+  },
+  "packageManager": "bun",
+  "keywords": [
+    "browser-haptic",
+    "haptic",
+    "vibration",
+    "vibrate",
+    "ios",
+    "safari",
+    "feedback",
+    "mobile",
+    "vibration-api"
+  ],
+  "license": "MIT",
+  "engines": {
+    "node": ">=18"
+  },
+  "devDependencies": {
+    "typescript": "^5.3.0"
+  }
+}