initial commit

.eslintignore

@@ -0,0 +1,2 @@
+build
+dist

.npmrc

@@ -0,0 +1 @@
+engine-strict=false

.nvmrc

@@ -0,0 +1 @@
+18.12.0

.prettierignore

@@ -0,0 +1,2 @@
+build
+dist

CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## 1.0.0
+  * initial release

CONTRIBUTING.md

@@ -1,3 +1,46 @@
 # Contributing
 
-TODO
+This guide provides instructions for contributing to this Capacitor plugin.
+
+## Developing
+
+### Local Setup
+
+1. Fork and clone the repo.
+2. Install the dependencies.
+
+    ```shell
+    npm install
+    ```
+
+### Scripts
+
+#### `npm run build`
+
+Build the plugin web assets and generate plugin API documentation using [`@capacitor/docgen`](https://github.com/ionic-team/capacitor-docgen).
+
+It will compile the TypeScript code from `src/` into ESM JavaScript in `dist/esm/`. These files are used in apps with bundlers when your plugin is imported.
+
+Then, Rollup will bundle the code into a single file at `dist/plugin.js`. This file is used in apps without bundlers by including it as a script in `index.html`.
+
+#### `npm run verify`
+
+Build and validate the web and native projects.
+
+This is useful to run in CI to verify that the plugin builds for all platforms.
+
+#### `npm run lint` / `npm run fmt`
+
+Check formatting and code quality, autoformat/autofix if possible.
+
+This template is integrated with ESLint, Prettier, and SwiftLint. Using these tools is completely optional, but the [Capacitor Community](https://github.com/capacitor-community/) strives to have consistent code style and structure for easier cooperation.
+
+## Publishing
+
+There is a `prepublishOnly` hook in `package.json` which prepares the plugin before publishing, so all you need to do is run:
+
+```shell
+npm publish
+```
+
+> **Note**: The [`files`](https://docs.npmjs.com/cli/v7/configuring-npm/package-json#files) array in `package.json` specifies which files get published. If you rename files/directories or add files elsewhere, you may need to update it.

CapacitorCommunityVolumeButtons.podspec

@@ -0,0 +1,17 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name = 'CapacitorCommunityVolumeButtons'
+  s.version = package['version']
+  s.summary = package['description']
+  s.license = package['license']
+  s.homepage = package['repository']['url']
+  s.author = package['author']
+  s.source = { :git => package['repository']['url'], :tag => s.version.to_s }
+  s.source_files = 'ios/Plugin/**/*.{swift,h,m,c,cc,mm,cpp}'
+  s.ios.deployment_target  = '13.0'
+  s.dependency 'Capacitor'
+  s.swift_version = '5.1'
+end

README.md

@@ -1,36 +1,161 @@
 <p align="center"><br><img src="https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png" width="128" height="128" /></p>
 <h3 align="center">Example</h3>
-<p align="center"><strong><code>@capacitor-community/example</code></strong></p>
+<p align="center"><strong><code>@capacitor-community/volume-buttons</code></strong></p>
 <p align="center">
-  Capacitor community plugin for something awesome.
+  Capacitor community plugin to listen to hardware volume button presses
 </p>
 
 <p align="center">
   <img src="https://img.shields.io/maintenance/yes/2020?style=flat-square" />
-  <a href="https://github.com/capacitor-community/example/actions?query=workflow%3A%22CI%22"><img src="https://img.shields.io/github/workflow/status/capacitor-community/example/CI?style=flat-square" /></a>
-  <a href="https://www.npmjs.com/package/@capacitor-community/example"><img src="https://img.shields.io/npm/l/@capacitor-community/example?style=flat-square" /></a>
+  <a href="https://github.com/capacitor-community/volume-buttons/actions?query=workflow%3A%22CI%22"><img src="https://img.shields.io/github/workflow/status/capacitor-community/volume-buttons/CI?style=flat-square" /></a>
+  <a href="https://www.npmjs.com/package/@capacitor-community/volume-buttons"><img src="https://img.shields.io/npm/l/@capacitor-community/volume-buttons?style=flat-square" /></a>
 <br>
-  <a href="https://www.npmjs.com/package/@capacitor-community/example"><img src="https://img.shields.io/npm/dw/@capacitor-community/example?style=flat-square" /></a>
-  <a href="https://www.npmjs.com/package/@capacitor-community/example"><img src="https://img.shields.io/npm/v/@capacitor-community/example?style=flat-square" /></a>
+  <a href="https://www.npmjs.com/package/@capacitor-community/volume-buttons"><img src="https://img.shields.io/npm/dw/@capacitor-community/volume-buttons?style=flat-square" /></a>
+  <a href="https://www.npmjs.com/package/@capacitor-community/volume-buttons"><img src="https://img.shields.io/npm/v/@capacitor-community/volume-buttons?style=flat-square" /></a>
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-<a href="#contributors-"><img src="https://img.shields.io/badge/all%20contributors-0-orange?style=flat-square" /></a>
+<a href="#contributors-"><img src="https://img.shields.io/badge/all%20contributors-1-orange?style=flat-square" /></a>
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 </p>
 
+## Table of Contents
+
+- [Maintainers](#maintainers)
+- [About](#about)
+- [Supported Platforms](#supported-platforms)
+- [Installation](#installation)
+- [API](#api)
+- [Troubleshooting](#troubleshooting)
+
 ## Maintainers
 
-| Maintainer | GitHub | Social |
-| -----------| -------| -------|
-| Ionitron (example) | [Ionitron](https://github.com/ionitron) | [@ionitron](https://twitter.com/ionitron) |
+| Maintainer | GitHub                                | Active |
+| ---------- | ------------------------------------- | ------ |
+| ryaa       | [ryaa](https://github.com/ryaa)       | yes    |
+
+## About
+
+This plugins allows to listen for the events fired when the user presses the hardware volume up or down button of the device. An object that contains only one property is passed to the callback - see [VolumeButtonsResult](#VolumeButtonsResult).
+This plugin contains code derived from or inspired by https://github.com/CipherBitCorp/VolumeButtonHandler and https://github.com/thiagobrez/capacitor-volume-buttons plugins.
+<br>
+
+**Features:**
+- support receiving events when the volume is max or min (make sure to use **`disableSystemVolumeHandler`** on iOS platform - see [VolumeButtonsOptions](#VolumeButtonsOptions))
+- keep receiving events after the application sent to and returns from the background
+- supports Android and iOS platforms
+
+<br>
+**NOTE**: The plugin version 1.0.0 is compatible with Capacitor 5 which requires gradle version 8.0
+
+## Supported Platforms
+
+- iOS
+- Android
 
 ## Installation
 
-TODO
+```bash
+npm install @capacitor-community/volume-buttons
+npx cap sync
+```
+
+## API
+
+<docgen-index>
+
+* [`watchVolume(...)`](#watchvolume)
+* [`clearWatch()`](#clearwatch)
+* [Interfaces](#interfaces)
+* [Type Aliases](#type-aliases)
+
+</docgen-index>
+
+<docgen-api>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+### watchVolume(...)
+
+```typescript
+watchVolume(options: VolumeButtonsOptions, callback: VolumeButtonsCallback) => Promise<CallbackID>
+```
+
+Set up a watch for he hardware volume buttons changes
+
+| Param          | Type                                                                    |
+| -------------- | ----------------------------------------------------------------------- |
+| **`options`**  | <code><a href="#volumebuttonsoptions">VolumeButtonsOptions</a></code>   |
+| **`callback`** | <code><a href="#volumebuttonscallback">VolumeButtonsCallback</a></code> |
+
+**Returns:** <code>Promise&lt;string&gt;</code>
+
+**Since:** 1.0.0
+
+--------------------
+
+
+### clearWatch()
 
-## Configuration
+```typescript
+clearWatch() => Promise<void>
+```
 
-TODO
+Clear the existing watch
+
+**Since:** 1.0.0
+
+--------------------
+
+
+### Interfaces
+
+
+#### VolumeButtonsOptions
+
+| Prop                             | Type                 | Description                                                                                                                                                                                                                                                                                                                                                                                                   | Since |
+| -------------------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
+| **`disableSystemVolumeHandler`** | <code>boolean</code> | This parameter can be used to disable the system volume handler (iOS only). If this is true, when up or down volume button is tapped, the system volume will always be reset to either the initial volume (the volume which was current when the volume buttons are started to be tracked/listened) or to 0.05 if the initial volume is less then 0.05 or to 0.95 if the initial volume is greater then 0.95. | 1.0.0 |
+
+
+#### VolumeButtonsResult
+
+| Prop            | Type                        | Description                                                            | Since |
+| --------------- | --------------------------- | ---------------------------------------------------------------------- | ----- |
+| **`direction`** | <code>'up' \| 'down'</code> | This indicates either the volume up or volume down button was pressed. | 1.0.0 |
+
+
+### Type Aliases
+
+
+#### VolumeButtonsCallback
+
+<code>(result: <a href="#volumebuttonsresult">VolumeButtonsResult</a>, err?: any): void</code>
+
+
+#### CallbackID
+
+<code>string</code>
+
+</docgen-api>
 
 ## Usage
 
-TODO
+### Add volume button listener in the app
+```
+import { VolumeButtons } from '@capacitor-community/volume-buttons';
+
+const options: VolumeButtonsOptions = {};
+const callback: VolumeButtonsCallback = (result: VolumeButtonsResult, err?: any) => {
+  console.log('result', result);
+};
+if (this.platform.is('ios')) {
+  options.disableSystemVolumeHandler = true;
+}
+await VolumeButtons.watchVolume(options, callback);
+```
+
+### Remove volume button listener in the app
+```
+import { VolumeButtons } from '@capacitor-community/volume-buttons';
+
+await VolumeButtons.clearWatch();
+```
+

android/.gitignore

@@ -0,0 +1 @@
+/build

android/build.gradle

@@ -0,0 +1,58 @@
+ext {
+    junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.6.1'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.1.5'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.5.1'
+}
+
+buildscript {
+    repositories {
+        google()
+        mavenCentral()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:8.0.0'
+    }
+}
+
+apply plugin: 'com.android.library'
+
+android {
+    namespace "com.ryltsov.alex.plugins.volume.buttons"
+    compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 33
+    defaultConfig {
+        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 22
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 33
+        versionCode 1000
+        versionName "1.0.0"
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+    }
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+    lintOptions {
+        abortOnError false
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_17
+        targetCompatibility JavaVersion.VERSION_17
+    }
+}
+
+repositories {
+    google()
+    mavenCentral()
+}
+
+
+dependencies {
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+    implementation project(':capacitor-android')
+    implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
+    testImplementation "junit:junit:$junitVersion"
+    androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
+    androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"
+}

android/gradle.properties

@@ -0,0 +1,22 @@
+# Project-wide Gradle settings.
+
+# IDE (e.g. Android Studio) users:
+# Gradle settings configured through the IDE *will override*
+# any settings specified in this file.
+
+# For more details on how to configure your build environment visit
+# http://www.gradle.org/docs/current/userguide/build_environment.html
+
+# Specifies the JVM arguments used for the daemon process.
+# The setting is particularly useful for tweaking memory settings.
+org.gradle.jvmargs=-Xmx1536m
+
+# When configured, Gradle will run in incubating parallel mode.
+# This option should only be used with decoupled projects. More details, visit
+# http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
+# org.gradle.parallel=true
+
+# AndroidX package structure to make it clearer which packages are bundled with the
+# Android operating system, and which are packaged with your app's APK
+# https://developer.android.com/topic/libraries/support-library/androidx-rn
+android.useAndroidX=true

android/gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,6 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.0.2-all.zip
+networkTimeout=10000
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists