@earjar/audio-engine-ts 0.0.1

package/README.md

@@ -0,0 +1,42 @@
+# Audio Engine (Typescript)
+
+This is a media handling React hook.
+
+## Installation and Requirements
+> Requires Node 24 and higher
+
+Install by running
+```
+npm install @earjar/audio-engine-ts
+```
+___
+
+## Usage
+```tsx
+import { useAudioEngine } from "../hooks/AudioEngine";
+
+const MyComponent = () => {
+    const { load, play, pause, isPlaying } = useAudioEngine();
+
+    const handlePlayClick = async () => {
+        load("https://example.com/track.mp3");
+        await play();
+    };
+
+    return (
+        <button onClick={isPlaying ? pause : handlePlayClick}>
+            {isPlaying ? "Pause" : "Play"}
+        </button>
+    );
+};
+```
+___
+
+## Author
+
+Kamvelihle Gwijana
+- [Linkedin](https://www.linkedin.com/in/kamvelihle-gwijana)
+
+## License
+
+ISC

package/dist/index.d.mts

@@ -0,0 +1,9 @@
+declare const useAudioEngine: () => {
+    load: (src: string) => void;
+    play: () => Promise<void>;
+    pause: () => void;
+    isPlaying: boolean;
+};
+declare const playOneShot: (src: string) => void;
+
+export { playOneShot, useAudioEngine };

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+declare const useAudioEngine: () => {
+    load: (src: string) => void;
+    play: () => Promise<void>;
+    pause: () => void;
+    isPlaying: boolean;
+};
+declare const playOneShot: (src: string) => void;
+
+export { playOneShot, useAudioEngine };

package/dist/index.js

@@ -0,0 +1,78 @@
+"use client";
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  playOneShot: () => playOneShot,
+  useAudioEngine: () => useAudioEngine
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/hooks/AudioEngine.ts
+var import_react = require("react");
+var useAudioEngine = () => {
+  const audioRef = (0, import_react.useRef)(null);
+  const [isPlaying, setIsPlaying] = (0, import_react.useState)(false);
+  if (!audioRef.current) {
+    audioRef.current = new Audio();
+  }
+  (0, import_react.useEffect)(() => {
+    const audio = audioRef.current;
+    const handlePlay = () => setIsPlaying(true);
+    const handlePause = () => setIsPlaying(false);
+    const handleEnded = () => setIsPlaying(false);
+    audio.addEventListener("play", handlePlay);
+    audio.addEventListener("pause", handlePause);
+    audio.addEventListener("ended", handleEnded);
+    return () => {
+      audio.removeEventListener("play", handlePlay);
+      audio.removeEventListener("pause", handlePause);
+      audio.removeEventListener("ended", handleEnded);
+      audio.pause();
+    };
+  }, []);
+  const load = (0, import_react.useCallback)((src) => {
+    const audio = audioRef.current;
+    audio.src = src;
+    audio.load();
+  }, []);
+  const play = (0, import_react.useCallback)(async () => {
+    try {
+      await audioRef.current?.play();
+    } catch {
+      setIsPlaying(false);
+    }
+  }, []);
+  const pause = (0, import_react.useCallback)(() => {
+    audioRef.current?.pause();
+  }, []);
+  return { load, play, pause, isPlaying };
+};
+var playOneShot = (src) => {
+  const audio = new Audio(src);
+  audio.play().catch(() => {
+  });
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  playOneShot,
+  useAudioEngine
+});

package/dist/index.mjs

@@ -0,0 +1,51 @@
+"use client";
+
+// src/hooks/AudioEngine.ts
+import { useCallback, useEffect, useRef, useState } from "react";
+var useAudioEngine = () => {
+  const audioRef = useRef(null);
+  const [isPlaying, setIsPlaying] = useState(false);
+  if (!audioRef.current) {
+    audioRef.current = new Audio();
+  }
+  useEffect(() => {
+    const audio = audioRef.current;
+    const handlePlay = () => setIsPlaying(true);
+    const handlePause = () => setIsPlaying(false);
+    const handleEnded = () => setIsPlaying(false);
+    audio.addEventListener("play", handlePlay);
+    audio.addEventListener("pause", handlePause);
+    audio.addEventListener("ended", handleEnded);
+    return () => {
+      audio.removeEventListener("play", handlePlay);
+      audio.removeEventListener("pause", handlePause);
+      audio.removeEventListener("ended", handleEnded);
+      audio.pause();
+    };
+  }, []);
+  const load = useCallback((src) => {
+    const audio = audioRef.current;
+    audio.src = src;
+    audio.load();
+  }, []);
+  const play = useCallback(async () => {
+    try {
+      await audioRef.current?.play();
+    } catch {
+      setIsPlaying(false);
+    }
+  }, []);
+  const pause = useCallback(() => {
+    audioRef.current?.pause();
+  }, []);
+  return { load, play, pause, isPlaying };
+};
+var playOneShot = (src) => {
+  const audio = new Audio(src);
+  audio.play().catch(() => {
+  });
+};
+export {
+  playOneShot,
+  useAudioEngine
+};

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@earjar/audio-engine-ts",
+  "version": "0.0.1",
+  "description": "This is a media handling React hook.",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    },
+    "./dist/index.css": "./dist/index.css"
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsup"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Earjar/audio-engine-ts.git"
+  },
+  "keywords": [
+    "typescript",
+    "audio",
+    "react"
+  ],
+  "author": "kamvedev",
+  "license": "ISC",
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "commonjs",
+  "bugs": {
+    "url": "https://github.com/Earjar/audio-engine-ts/issues"
+  },
+  "homepage": "https://github.com/Earjar/audio-engine-ts#readme",
+  "devDependencies": {
+    "@types/react": "^16.8.0",
+    "tsup": "^8.5.1",
+    "typescript": "^5.7.3"
+  },
+  "peerDependencies": {
+    "react": "^16.8.0 || ^17.0.0 || ^18.0.0 || ^19.0.0"
+  }
+}