@capgo/capacitor-proximity 8.1.1

package/CapgoCapacitorProximity.podspec

@@ -0,0 +1,17 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name = 'CapgoCapacitorProximity'
+  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/Sources/**/*.{swift,h,m,c,cc,mm,cpp}'
+  s.ios.deployment_target = '15.0'
+  s.dependency 'Capacitor'
+  s.swift_version = '5.1'
+end

package/Package.swift

@@ -0,0 +1,28 @@
+// swift-tools-version: 5.9
+import PackageDescription
+
+let package = Package(
+    name: "CapgoCapacitorProximity",
+    platforms: [.iOS(.v15)],
+    products: [
+        .library(
+            name: "CapgoCapacitorProximity",
+            targets: ["CapacitorProximityPlugin"])
+    ],
+    dependencies: [
+        .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", from: "8.0.0")
+    ],
+    targets: [
+        .target(
+            name: "CapacitorProximityPlugin",
+            dependencies: [
+                .product(name: "Capacitor", package: "capacitor-swift-pm"),
+                .product(name: "Cordova", package: "capacitor-swift-pm")
+            ],
+            path: "ios/Sources/CapacitorProximityPlugin"),
+        .testTarget(
+            name: "CapacitorProximityPluginTests",
+            dependencies: ["CapacitorProximityPlugin"],
+            path: "ios/Tests/CapacitorProximityPluginTests")
+    ]
+)

package/README.md

@@ -0,0 +1,176 @@
+# @capgo/capacitor-proximity
+ <a href="https://capgo.app/"><img src='https://raw.githubusercontent.com/Cap-go/capgo/main/assets/capgo_banner.png' alt='Capgo - Instant updates for capacitor'/></a>
+
+<div align="center">
+  <h2><a href="https://capgo.app/?ref=plugin_proximity"> ➡️ Get Instant updates for your App with Capgo</a></h2>
+  <h2><a href="https://capgo.app/consulting/?ref=plugin_proximity"> Missing a feature? We'll build the plugin for you 💪</a></h2>
+</div>
+
+Capacitor plugin for enabling proximity monitoring in mobile apps.
+
+## Why this plugin
+
+This plugin wraps the native proximity APIs used by iOS and Android so a Capacitor app can:
+
+- Enable proximity monitoring when a screen should react to the user's face or hand.
+- Disable it cleanly when the flow ends.
+- Check whether the current device supports the sensor.
+- Read the plugin version from native code.
+
+On iOS, the plugin forwards directly to `UIDevice.isProximityMonitoringEnabled`.
+On Android, it listens to the device proximity sensor and dims the active app window while the sensor is covered.
+
+## Platform support
+
+| Platform | Support |
+|----------|---------|
+| iOS      | ✅ Uses native proximity monitoring |
+| Android  | ✅ Uses `Sensor.TYPE_PROXIMITY` and dims the current app window |
+| Web      | ❌ Not available |
+
+## Compatibility
+
+| Plugin version | Capacitor compatibility | Maintained |
+| -------------- | ----------------------- | ---------- |
+| v8.*.*         | v8.*.*                  | ✅         |
+| v7.*.*         | v7.*.*                  | On demand  |
+| v6.*.*         | v6.*.*                  | ❌         |
+| v5.*.*         | v5.*.*                  | ❌         |
+
+> The plugin major version follows the Capacitor major version.
+
+## Install
+
+```bash
+bun add @capgo/capacitor-proximity
+bunx cap sync
+```
+
+## Usage
+
+```ts
+import { CapacitorProximity } from '@capgo/capacitor-proximity';
+
+const status = await CapacitorProximity.getStatus();
+
+if (status.available) {
+  await CapacitorProximity.enable();
+
+  // ...run your near-ear or face-down flow...
+
+  await CapacitorProximity.disable();
+}
+```
+
+## Notes
+
+- Test on a real device. Simulators and most desktop browsers do not expose a proximity sensor.
+- On Android, the plugin only affects the current app window. It does not control the full system display outside your app.
+- On iOS, Apple controls the exact screen-off behavior once proximity monitoring is enabled.
+
+## Example app
+
+The `example-app/` folder contains a small Vite demo for checking status, enabling the plugin, disabling it, and reading the native version.
+
+## API
+
+<docgen-index>
+
+* [`enable()`](#enable)
+* [`disable()`](#disable)
+* [`getStatus()`](#getstatus)
+* [`getPluginVersion()`](#getpluginversion)
+* [Interfaces](#interfaces)
+
+</docgen-index>
+<!-- test-->
+<docgen-api>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+Capacitor plugin for enabling proximity monitoring in mobile apps.
+
+### enable()
+
+```typescript
+enable() => Promise<void>
+```
+
+Enable proximity monitoring.
+
+On iOS this enables `UIDevice.isProximityMonitoringEnabled`.
+On Android this starts listening to `TYPE_PROXIMITY` and dims the current
+app window while the sensor is covered.
+
+**Since:** 0.0.1
+
+--------------------
+
+
+### disable()
+
+```typescript
+disable() => Promise<void>
+```
+
+Disable proximity monitoring.
+
+This restores the default app window behavior and stops sensor monitoring.
+
+**Since:** 0.0.1
+
+--------------------
+
+
+### getStatus()
+
+```typescript
+getStatus() => Promise<ProximityStatusResult>
+```
+
+Get the current sensor availability and plugin enabled state.
+
+**Returns:** <code>Promise&lt;<a href="#proximitystatusresult">ProximityStatusResult</a>&gt;</code>
+
+**Since:** 0.0.1
+
+--------------------
+
+
+### getPluginVersion()
+
+```typescript
+getPluginVersion() => Promise<PluginVersionResult>
+```
+
+Get the current native plugin version.
+
+**Returns:** <code>Promise&lt;<a href="#pluginversionresult">PluginVersionResult</a>&gt;</code>
+
+**Since:** 0.0.1
+
+--------------------
+
+
+### Interfaces
+
+
+#### ProximityStatusResult
+
+Result returned by `getStatus()`.
+
+| Prop            | Type                                     | Description                                                      | Since |
+| --------------- | ---------------------------------------- | ---------------------------------------------------------------- | ----- |
+| **`available`** | <code>boolean</code>                     | Whether the current device exposes a usable proximity sensor.    | 0.0.1 |
+| **`enabled`**   | <code>boolean</code>                     | Whether proximity monitoring is currently enabled by the plugin. | 0.0.1 |
+| **`platform`**  | <code>'ios' \| 'android' \| 'web'</code> | Platform label returned by the native or web implementation.     | 0.0.1 |
+
+
+#### PluginVersionResult
+
+Result returned when requesting the plugin version.
+
+| Prop          | Type                | Description                   | Since |
+| ------------- | ------------------- | ----------------------------- | ----- |
+| **`version`** | <code>string</code> | Native plugin version string. | 0.0.1 |
+
+</docgen-api>

package/android/build.gradle

@@ -0,0 +1,59 @@
+ext {
+    junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.7.1'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.3.0'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.7.0'
+}
+
+buildscript {
+    repositories {
+        google()
+        mavenCentral()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:8.13.0'
+    }
+}
+
+apply plugin: 'com.android.library'
+
+android {
+    namespace = "app.capgo.proximity"
+    compileSdk = project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 36
+    defaultConfig {
+        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 24
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 36
+        versionCode 1
+        versionName "1.0"
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+    }
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
+        }
+    }
+    lintOptions {
+        abortOnError = false
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_21
+        targetCompatibility JavaVersion.VERSION_21
+    }
+}
+
+repositories {
+    google()
+    mavenCentral()
+}
+
+
+dependencies {
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+    implementation project(':capacitor-android')
+    annotationProcessor 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"
+}

package/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

package/android/proguard-rules.pro

@@ -0,0 +1,21 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile

package/android/settings.gradle

@@ -0,0 +1,2 @@
+include ':capacitor-android'
+project(':capacitor-android').projectDir = new File('../node_modules/@capacitor/android/capacitor')

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,3 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+    <uses-feature android:name="android.hardware.sensor.proximity" android:required="false" />
+</manifest>

package/android/src/main/java/app/capgo/proximity/CapacitorProximity.java

@@ -0,0 +1,160 @@
+package app.capgo.proximity;
+
+import android.app.Activity;
+import android.content.Context;
+import android.hardware.Sensor;
+import android.hardware.SensorEvent;
+import android.hardware.SensorEventListener;
+import android.hardware.SensorManager;
+import android.view.Window;
+import android.view.WindowManager;
+import com.getcapacitor.JSObject;
+import com.getcapacitor.Logger;
+import com.getcapacitor.PluginCall;
+
+public class CapacitorProximity {
+
+    public static final String PLUGIN_VERSION = "8.0.0";
+    private static final String TAG = "CapacitorProximity";
+
+    private final Activity activity;
+    private final SensorManager sensorManager;
+    private final Sensor proximitySensor;
+
+    private SensorEventListener proximitySensorListener;
+    private boolean enabled = false;
+    private float originalBrightness = WindowManager.LayoutParams.BRIGHTNESS_OVERRIDE_NONE;
+    private boolean originalKeepScreenOn = false;
+
+    public CapacitorProximity(Activity activity) {
+        this.activity = activity;
+
+        if (activity != null) {
+            sensorManager = (SensorManager) activity.getSystemService(Context.SENSOR_SERVICE);
+            proximitySensor = sensorManager != null ? sensorManager.getDefaultSensor(Sensor.TYPE_PROXIMITY) : null;
+        } else {
+            sensorManager = null;
+            proximitySensor = null;
+        }
+    }
+
+    public void enable(PluginCall call) {
+        if (activity == null) {
+            call.reject("Activity not available.");
+            return;
+        }
+
+        if (proximitySensor == null || sensorManager == null) {
+            call.reject("Proximity sensor not available on this device.");
+            return;
+        }
+
+        if (enabled) {
+            call.resolve();
+            return;
+        }
+
+        Window window = activity.getWindow();
+        WindowManager.LayoutParams params = window.getAttributes();
+        originalBrightness = params.screenBrightness;
+        originalKeepScreenOn = (params.flags & WindowManager.LayoutParams.FLAG_KEEP_SCREEN_ON) != 0;
+
+        proximitySensorListener = new SensorEventListener() {
+            @Override
+            public void onSensorChanged(SensorEvent event) {
+                if (event.sensor.getType() != Sensor.TYPE_PROXIMITY) {
+                    return;
+                }
+
+                float distance = event.values[0];
+                boolean isNear = distance < proximitySensor.getMaximumRange();
+
+                if (isNear) {
+                    dimScreen();
+                } else {
+                    restoreScreen();
+                }
+            }
+
+            @Override
+            public void onAccuracyChanged(Sensor sensor, int accuracy) {
+                // No-op
+            }
+        };
+
+        boolean registered = sensorManager.registerListener(proximitySensorListener, proximitySensor, SensorManager.SENSOR_DELAY_NORMAL);
+
+        if (!registered) {
+            proximitySensorListener = null;
+            call.reject("Failed to register the proximity sensor listener.");
+            return;
+        }
+
+        enabled = true;
+        call.resolve();
+    }
+
+    public void disable(PluginCall call) {
+        stopMonitoring();
+        call.resolve();
+    }
+
+    public JSObject getStatus() {
+        JSObject result = new JSObject();
+        result.put("available", proximitySensor != null);
+        result.put("enabled", enabled);
+        result.put("platform", "android");
+        return result;
+    }
+
+    public String getPluginVersion() {
+        return PLUGIN_VERSION;
+    }
+
+    public void stopMonitoring() {
+        restoreScreen();
+
+        if (sensorManager != null && proximitySensorListener != null) {
+            sensorManager.unregisterListener(proximitySensorListener);
+            proximitySensorListener = null;
+        }
+
+        enabled = false;
+    }
+
+    private void dimScreen() {
+        if (activity == null) {
+            return;
+        }
+
+        try {
+            Window window = activity.getWindow();
+            WindowManager.LayoutParams params = window.getAttributes();
+            params.flags |= WindowManager.LayoutParams.FLAG_KEEP_SCREEN_ON;
+            params.screenBrightness = 0.0f;
+            window.setAttributes(params);
+        } catch (Exception exception) {
+            Logger.error(TAG, "Failed to dim the app window.", exception);
+        }
+    }
+
+    private void restoreScreen() {
+        if (activity == null) {
+            return;
+        }
+
+        try {
+            Window window = activity.getWindow();
+            WindowManager.LayoutParams params = window.getAttributes();
+
+            params.screenBrightness = originalBrightness;
+            if (!originalKeepScreenOn) {
+                params.flags &= ~WindowManager.LayoutParams.FLAG_KEEP_SCREEN_ON;
+            }
+
+            window.setAttributes(params);
+        } catch (Exception exception) {
+            Logger.error(TAG, "Failed to restore the app window.", exception);
+        }
+    }
+}

package/android/src/main/java/app/capgo/proximity/CapacitorProximityPlugin.java

@@ -0,0 +1,49 @@
+package app.capgo.proximity;
+
+import com.getcapacitor.JSObject;
+import com.getcapacitor.Plugin;
+import com.getcapacitor.PluginCall;
+import com.getcapacitor.PluginMethod;
+import com.getcapacitor.annotation.CapacitorPlugin;
+
+@CapacitorPlugin(name = "CapacitorProximity")
+public class CapacitorProximityPlugin extends Plugin {
+
+    private CapacitorProximity implementation;
+
+    @Override
+    public void load() {
+        super.load();
+        implementation = new CapacitorProximity(getActivity());
+    }
+
+    @Override
+    protected void handleOnDestroy() {
+        if (implementation != null) {
+            implementation.stopMonitoring();
+        }
+        super.handleOnDestroy();
+    }
+
+    @PluginMethod
+    public void enable(PluginCall call) {
+        bridge.executeOnMainThread(() -> implementation.enable(call));
+    }
+
+    @PluginMethod
+    public void disable(PluginCall call) {
+        bridge.executeOnMainThread(() -> implementation.disable(call));
+    }
+
+    @PluginMethod
+    public void getStatus(PluginCall call) {
+        call.resolve(implementation.getStatus());
+    }
+
+    @PluginMethod
+    public void getPluginVersion(PluginCall call) {
+        JSObject result = new JSObject();
+        result.put("version", implementation.getPluginVersion());
+        call.resolve(result);
+    }
+}

package/dist/docs.json

@@ -0,0 +1,193 @@
+{
+  "api": {
+    "name": "CapacitorProximityPlugin",
+    "slug": "capacitorproximityplugin",
+    "docs": "Capacitor plugin for enabling proximity monitoring in mobile apps.",
+    "tags": [
+      {
+        "text": "0.0.1",
+        "name": "since"
+      }
+    ],
+    "methods": [
+      {
+        "name": "enable",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise that resolves when proximity monitoring is active"
+          },
+          {
+            "name": "since",
+            "text": "0.0.1"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait CapacitorProximity.enable();\n```"
+          }
+        ],
+        "docs": "Enable proximity monitoring.\n\nOn iOS this enables `UIDevice.isProximityMonitoringEnabled`.\nOn Android this starts listening to `TYPE_PROXIMITY` and dims the current\napp window while the sensor is covered.",
+        "complexTypes": [],
+        "slug": "enable"
+      },
+      {
+        "name": "disable",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise that resolves when proximity monitoring is disabled"
+          },
+          {
+            "name": "since",
+            "text": "0.0.1"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait CapacitorProximity.disable();\n```"
+          }
+        ],
+        "docs": "Disable proximity monitoring.\n\nThis restores the default app window behavior and stops sensor monitoring.",
+        "complexTypes": [],
+        "slug": "disable"
+      },
+      {
+        "name": "getStatus",
+        "signature": "() => Promise<ProximityStatusResult>",
+        "parameters": [],
+        "returns": "Promise<ProximityStatusResult>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise resolving to the current plugin status"
+          },
+          {
+            "name": "since",
+            "text": "0.0.1"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst status = await CapacitorProximity.getStatus();\n```"
+          }
+        ],
+        "docs": "Get the current sensor availability and plugin enabled state.",
+        "complexTypes": [
+          "ProximityStatusResult"
+        ],
+        "slug": "getstatus"
+      },
+      {
+        "name": "getPluginVersion",
+        "signature": "() => Promise<PluginVersionResult>",
+        "parameters": [],
+        "returns": "Promise<PluginVersionResult>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise resolving to the plugin version"
+          },
+          {
+            "name": "since",
+            "text": "0.0.1"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst { version } = await CapacitorProximity.getPluginVersion();\n```"
+          }
+        ],
+        "docs": "Get the current native plugin version.",
+        "complexTypes": [
+          "PluginVersionResult"
+        ],
+        "slug": "getpluginversion"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "ProximityStatusResult",
+      "slug": "proximitystatusresult",
+      "docs": "Result returned by `getStatus()`.",
+      "tags": [
+        {
+          "text": "0.0.1",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "available",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether the current device exposes a usable proximity sensor.",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "enabled",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether proximity monitoring is currently enabled by the plugin.",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "platform",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Platform label returned by the native or web implementation.",
+          "complexTypes": [],
+          "type": "'ios' | 'android' | 'web'"
+        }
+      ]
+    },
+    {
+      "name": "PluginVersionResult",
+      "slug": "pluginversionresult",
+      "docs": "Result returned when requesting the plugin version.",
+      "tags": [
+        {
+          "text": "0.0.1",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "version",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Native plugin version string.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [],
+  "pluginConfigs": []
+}

package/dist/esm/definitions.d.ts

@@ -0,0 +1,95 @@
+/**
+ * Result returned by `getStatus()`.
+ *
+ * @since 0.0.1
+ */
+export interface ProximityStatusResult {
+    /**
+     * Whether the current device exposes a usable proximity sensor.
+     *
+     * @since 0.0.1
+     */
+    available: boolean;
+    /**
+     * Whether proximity monitoring is currently enabled by the plugin.
+     *
+     * @since 0.0.1
+     */
+    enabled: boolean;
+    /**
+     * Platform label returned by the native or web implementation.
+     *
+     * @since 0.0.1
+     */
+    platform: 'ios' | 'android' | 'web';
+}
+/**
+ * Result returned when requesting the plugin version.
+ *
+ * @since 0.0.1
+ */
+export interface PluginVersionResult {
+    /**
+     * Native plugin version string.
+     *
+     * @since 0.0.1
+     */
+    version: string;
+}
+/**
+ * Capacitor plugin for enabling proximity monitoring in mobile apps.
+ *
+ * @since 0.0.1
+ */
+export interface CapacitorProximityPlugin {
+    /**
+     * Enable proximity monitoring.
+     *
+     * On iOS this enables `UIDevice.isProximityMonitoringEnabled`.
+     * On Android this starts listening to `TYPE_PROXIMITY` and dims the current
+     * app window while the sensor is covered.
+     *
+     * @returns Promise that resolves when proximity monitoring is active
+     * @since 0.0.1
+     * @example
+     * ```typescript
+     * await CapacitorProximity.enable();
+     * ```
+     */
+    enable(): Promise<void>;
+    /**
+     * Disable proximity monitoring.
+     *
+     * This restores the default app window behavior and stops sensor monitoring.
+     *
+     * @returns Promise that resolves when proximity monitoring is disabled
+     * @since 0.0.1
+     * @example
+     * ```typescript
+     * await CapacitorProximity.disable();
+     * ```
+     */
+    disable(): Promise<void>;
+    /**
+     * Get the current sensor availability and plugin enabled state.
+     *
+     * @returns Promise resolving to the current plugin status
+     * @since 0.0.1
+     * @example
+     * ```typescript
+     * const status = await CapacitorProximity.getStatus();
+     * ```
+     */
+    getStatus(): Promise<ProximityStatusResult>;
+    /**
+     * Get the current native plugin version.
+     *
+     * @returns Promise resolving to the plugin version
+     * @since 0.0.1
+     * @example
+     * ```typescript
+     * const { version } = await CapacitorProximity.getPluginVersion();
+     * ```
+     */
+    getPluginVersion(): Promise<PluginVersionResult>;
+}

package/dist/esm/definitions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=definitions.js.map

package/dist/esm/definitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Result returned by `getStatus()`.\n *\n * @since 0.0.1\n */\nexport interface ProximityStatusResult {\n  /**\n   * Whether the current device exposes a usable proximity sensor.\n   *\n   * @since 0.0.1\n   */\n  available: boolean;\n\n  /**\n   * Whether proximity monitoring is currently enabled by the plugin.\n   *\n   * @since 0.0.1\n   */\n  enabled: boolean;\n\n  /**\n   * Platform label returned by the native or web implementation.\n   *\n   * @since 0.0.1\n   */\n  platform: 'ios' | 'android' | 'web';\n}\n\n/**\n * Result returned when requesting the plugin version.\n *\n * @since 0.0.1\n */\nexport interface PluginVersionResult {\n  /**\n   * Native plugin version string.\n   *\n   * @since 0.0.1\n   */\n  version: string;\n}\n\n/**\n * Capacitor plugin for enabling proximity monitoring in mobile apps.\n *\n * @since 0.0.1\n */\nexport interface CapacitorProximityPlugin {\n  /**\n   * Enable proximity monitoring.\n   *\n   * On iOS this enables `UIDevice.isProximityMonitoringEnabled`.\n   * On Android this starts listening to `TYPE_PROXIMITY` and dims the current\n   * app window while the sensor is covered.\n   *\n   * @returns Promise that resolves when proximity monitoring is active\n   * @since 0.0.1\n   * @example\n   * ```typescript\n   * await CapacitorProximity.enable();\n   * ```\n   */\n  enable(): Promise<void>;\n\n  /**\n   * Disable proximity monitoring.\n   *\n   * This restores the default app window behavior and stops sensor monitoring.\n   *\n   * @returns Promise that resolves when proximity monitoring is disabled\n   * @since 0.0.1\n   * @example\n   * ```typescript\n   * await CapacitorProximity.disable();\n   * ```\n   */\n  disable(): Promise<void>;\n\n  /**\n   * Get the current sensor availability and plugin enabled state.\n   *\n   * @returns Promise resolving to the current plugin status\n   * @since 0.0.1\n   * @example\n   * ```typescript\n   * const status = await CapacitorProximity.getStatus();\n   * ```\n   */\n  getStatus(): Promise<ProximityStatusResult>;\n\n  /**\n   * Get the current native plugin version.\n   *\n   * @returns Promise resolving to the plugin version\n   * @since 0.0.1\n   * @example\n   * ```typescript\n   * const { version } = await CapacitorProximity.getPluginVersion();\n   * ```\n   */\n  getPluginVersion(): Promise<PluginVersionResult>;\n}\n"]}

package/dist/esm/index.d.ts

@@ -0,0 +1,4 @@
+import type { CapacitorProximityPlugin } from './definitions';
+declare const CapacitorProximity: CapacitorProximityPlugin;
+export * from './definitions';
+export { CapacitorProximity };

package/dist/esm/index.js

@@ -0,0 +1,7 @@
+import { registerPlugin } from '@capacitor/core';
+const CapacitorProximity = registerPlugin('CapacitorProximity', {
+    web: () => import('./web').then((module) => new module.CapacitorProximityWeb()),
+});
+export * from './definitions';
+export { CapacitorProximity };
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,MAAM,kBAAkB,GAAG,cAAc,CAA2B,oBAAoB,EAAE;IACxF,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,qBAAqB,EAAE,CAAC;CAChF,CAAC,CAAC;AAEH,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,kBAAkB,EAAE,CAAC","sourcesContent":["import { registerPlugin } from '@capacitor/core';\n\nimport type { CapacitorProximityPlugin } from './definitions';\n\nconst CapacitorProximity = registerPlugin<CapacitorProximityPlugin>('CapacitorProximity', {\n  web: () => import('./web').then((module) => new module.CapacitorProximityWeb()),\n});\n\nexport * from './definitions';\nexport { CapacitorProximity };\n"]}

package/dist/esm/web.d.ts

@@ -0,0 +1,8 @@
+import { WebPlugin } from '@capacitor/core';
+import type { CapacitorProximityPlugin, PluginVersionResult, ProximityStatusResult } from './definitions';
+export declare class CapacitorProximityWeb extends WebPlugin implements CapacitorProximityPlugin {
+    enable(): Promise<void>;
+    disable(): Promise<void>;
+    getStatus(): Promise<ProximityStatusResult>;
+    getPluginVersion(): Promise<PluginVersionResult>;
+}

package/dist/esm/web.js

@@ -0,0 +1,22 @@
+import { WebPlugin } from '@capacitor/core';
+export class CapacitorProximityWeb extends WebPlugin {
+    async enable() {
+        throw this.unavailable('Proximity monitoring is not available on web.');
+    }
+    async disable() {
+        throw this.unavailable('Proximity monitoring is not available on web.');
+    }
+    async getStatus() {
+        return {
+            available: false,
+            enabled: false,
+            platform: 'web',
+        };
+    }
+    async getPluginVersion() {
+        return {
+            version: 'web',
+        };
+    }
+}
+//# sourceMappingURL=web.js.map

package/dist/esm/web.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web.js","sourceRoot":"","sources":["../../src/web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAI5C,MAAM,OAAO,qBAAsB,SAAQ,SAAS;IAClD,KAAK,CAAC,MAAM;QACV,MAAM,IAAI,CAAC,WAAW,CAAC,+CAA+C,CAAC,CAAC;IAC1E,CAAC;IAED,KAAK,CAAC,OAAO;QACX,MAAM,IAAI,CAAC,WAAW,CAAC,+CAA+C,CAAC,CAAC;IAC1E,CAAC;IAED,KAAK,CAAC,SAAS;QACb,OAAO;YACL,SAAS,EAAE,KAAK;YAChB,OAAO,EAAE,KAAK;YACd,QAAQ,EAAE,KAAK;SAChB,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,gBAAgB;QACpB,OAAO;YACL,OAAO,EAAE,KAAK;SACf,CAAC;IACJ,CAAC;CACF","sourcesContent":["import { WebPlugin } from '@capacitor/core';\n\nimport type { CapacitorProximityPlugin, PluginVersionResult, ProximityStatusResult } from './definitions';\n\nexport class CapacitorProximityWeb extends WebPlugin implements CapacitorProximityPlugin {\n  async enable(): Promise<void> {\n    throw this.unavailable('Proximity monitoring is not available on web.');\n  }\n\n  async disable(): Promise<void> {\n    throw this.unavailable('Proximity monitoring is not available on web.');\n  }\n\n  async getStatus(): Promise<ProximityStatusResult> {\n    return {\n      available: false,\n      enabled: false,\n      platform: 'web',\n    };\n  }\n\n  async getPluginVersion(): Promise<PluginVersionResult> {\n    return {\n      version: 'web',\n    };\n  }\n}\n"]}

package/dist/plugin.cjs.js

@@ -0,0 +1,36 @@
+'use strict';
+
+var core = require('@capacitor/core');
+
+const CapacitorProximity = core.registerPlugin('CapacitorProximity', {
+    web: () => Promise.resolve().then(function () { return web; }).then((module) => new module.CapacitorProximityWeb()),
+});
+
+class CapacitorProximityWeb extends core.WebPlugin {
+    async enable() {
+        throw this.unavailable('Proximity monitoring is not available on web.');
+    }
+    async disable() {
+        throw this.unavailable('Proximity monitoring is not available on web.');
+    }
+    async getStatus() {
+        return {
+            available: false,
+            enabled: false,
+            platform: 'web',
+        };
+    }
+    async getPluginVersion() {
+        return {
+            version: 'web',
+        };
+    }
+}
+
+var web = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    CapacitorProximityWeb: CapacitorProximityWeb
+});
+
+exports.CapacitorProximity = CapacitorProximity;
+//# sourceMappingURL=plugin.cjs.js.map

package/dist/plugin.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.cjs.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst CapacitorProximity = registerPlugin('CapacitorProximity', {\n    web: () => import('./web').then((module) => new module.CapacitorProximityWeb()),\n});\nexport * from './definitions';\nexport { CapacitorProximity };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from '@capacitor/core';\nexport class CapacitorProximityWeb extends WebPlugin {\n    async enable() {\n        throw this.unavailable('Proximity monitoring is not available on web.');\n    }\n    async disable() {\n        throw this.unavailable('Proximity monitoring is not available on web.');\n    }\n    async getStatus() {\n        return {\n            available: false,\n            enabled: false,\n            platform: 'web',\n        };\n    }\n    async getPluginVersion() {\n        return {\n            version: 'web',\n        };\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;;AACK,MAAC,kBAAkB,GAAGA,mBAAc,CAAC,oBAAoB,EAAE;AAChE,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,IAAI,MAAM,CAAC,qBAAqB,EAAE,CAAC;AACnF,CAAC;;ACFM,MAAM,qBAAqB,SAASC,cAAS,CAAC;AACrD,IAAI,MAAM,MAAM,GAAG;AACnB,QAAQ,MAAM,IAAI,CAAC,WAAW,CAAC,+CAA+C,CAAC;AAC/E,IAAI;AACJ,IAAI,MAAM,OAAO,GAAG;AACpB,QAAQ,MAAM,IAAI,CAAC,WAAW,CAAC,+CAA+C,CAAC;AAC/E,IAAI;AACJ,IAAI,MAAM,SAAS,GAAG;AACtB,QAAQ,OAAO;AACf,YAAY,SAAS,EAAE,KAAK;AAC5B,YAAY,OAAO,EAAE,KAAK;AAC1B,YAAY,QAAQ,EAAE,KAAK;AAC3B,SAAS;AACT,IAAI;AACJ,IAAI,MAAM,gBAAgB,GAAG;AAC7B,QAAQ,OAAO;AACf,YAAY,OAAO,EAAE,KAAK;AAC1B,SAAS;AACT,IAAI;AACJ;;;;;;;;;"}

package/dist/plugin.js

@@ -0,0 +1,39 @@
+var capacitorProximity = (function (exports, core) {
+    'use strict';
+
+    const CapacitorProximity = core.registerPlugin('CapacitorProximity', {
+        web: () => Promise.resolve().then(function () { return web; }).then((module) => new module.CapacitorProximityWeb()),
+    });
+
+    class CapacitorProximityWeb extends core.WebPlugin {
+        async enable() {
+            throw this.unavailable('Proximity monitoring is not available on web.');
+        }
+        async disable() {
+            throw this.unavailable('Proximity monitoring is not available on web.');
+        }
+        async getStatus() {
+            return {
+                available: false,
+                enabled: false,
+                platform: 'web',
+            };
+        }
+        async getPluginVersion() {
+            return {
+                version: 'web',
+            };
+        }
+    }
+
+    var web = /*#__PURE__*/Object.freeze({
+        __proto__: null,
+        CapacitorProximityWeb: CapacitorProximityWeb
+    });
+
+    exports.CapacitorProximity = CapacitorProximity;
+
+    return exports;
+
+})({}, capacitorExports);
+//# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst CapacitorProximity = registerPlugin('CapacitorProximity', {\n    web: () => import('./web').then((module) => new module.CapacitorProximityWeb()),\n});\nexport * from './definitions';\nexport { CapacitorProximity };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from '@capacitor/core';\nexport class CapacitorProximityWeb extends WebPlugin {\n    async enable() {\n        throw this.unavailable('Proximity monitoring is not available on web.');\n    }\n    async disable() {\n        throw this.unavailable('Proximity monitoring is not available on web.');\n    }\n    async getStatus() {\n        return {\n            available: false,\n            enabled: false,\n            platform: 'web',\n        };\n    }\n    async getPluginVersion() {\n        return {\n            version: 'web',\n        };\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;AACK,UAAC,kBAAkB,GAAGA,mBAAc,CAAC,oBAAoB,EAAE;IAChE,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,IAAI,MAAM,CAAC,qBAAqB,EAAE,CAAC;IACnF,CAAC;;ICFM,MAAM,qBAAqB,SAASC,cAAS,CAAC;IACrD,IAAI,MAAM,MAAM,GAAG;IACnB,QAAQ,MAAM,IAAI,CAAC,WAAW,CAAC,+CAA+C,CAAC;IAC/E,IAAI;IACJ,IAAI,MAAM,OAAO,GAAG;IACpB,QAAQ,MAAM,IAAI,CAAC,WAAW,CAAC,+CAA+C,CAAC;IAC/E,IAAI;IACJ,IAAI,MAAM,SAAS,GAAG;IACtB,QAAQ,OAAO;IACf,YAAY,SAAS,EAAE,KAAK;IAC5B,YAAY,OAAO,EAAE,KAAK;IAC1B,YAAY,QAAQ,EAAE,KAAK;IAC3B,SAAS;IACT,IAAI;IACJ,IAAI,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,OAAO;IACf,YAAY,OAAO,EAAE,KAAK;IAC1B,SAAS;IACT,IAAI;IACJ;;;;;;;;;;;;;;;"}

package/ios/Sources/CapacitorProximityPlugin/CapacitorProximity.swift

@@ -0,0 +1,31 @@
+import Foundation
+import UIKit
+
+@objc public class CapacitorProximity: NSObject {
+    public static let pluginVersion = "8.0.0"
+
+    @objc public func enable() -> Bool {
+        UIDevice.current.isProximityMonitoringEnabled = true
+        return UIDevice.current.isProximityMonitoringEnabled
+    }
+
+    @objc public func disable() {
+        UIDevice.current.isProximityMonitoringEnabled = false
+    }
+
+    @objc public func isAvailable() -> Bool {
+        let original = UIDevice.current.isProximityMonitoringEnabled
+        UIDevice.current.isProximityMonitoringEnabled = true
+        let available = UIDevice.current.isProximityMonitoringEnabled
+        UIDevice.current.isProximityMonitoringEnabled = original
+        return available
+    }
+
+    @objc public func isEnabled() -> Bool {
+        UIDevice.current.isProximityMonitoringEnabled
+    }
+
+    @objc public func getPluginVersion() -> String {
+        Self.pluginVersion
+    }
+}

package/ios/Sources/CapacitorProximityPlugin/CapacitorProximityPlugin.swift

@@ -0,0 +1,54 @@
+import Capacitor
+import Foundation
+
+@objc(CapacitorProximityPlugin)
+public class CapacitorProximityPlugin: CAPPlugin, CAPBridgedPlugin {
+    public let identifier = "CapacitorProximityPlugin"
+    public let jsName = "CapacitorProximity"
+    public let pluginMethods: [CAPPluginMethod] = [
+        CAPPluginMethod(name: "enable", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "disable", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "getStatus", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "getPluginVersion", returnType: CAPPluginReturnPromise)
+    ]
+
+    private let implementation = CapacitorProximity()
+
+    deinit {
+        implementation.disable()
+    }
+
+    @objc func enable(_ call: CAPPluginCall) {
+        DispatchQueue.main.async {
+            if self.implementation.enable() {
+                call.resolve()
+                return
+            }
+
+            call.reject("Proximity sensor not available on this device.")
+        }
+    }
+
+    @objc func disable(_ call: CAPPluginCall) {
+        DispatchQueue.main.async {
+            self.implementation.disable()
+            call.resolve()
+        }
+    }
+
+    @objc func getStatus(_ call: CAPPluginCall) {
+        DispatchQueue.main.async {
+            call.resolve([
+                "available": self.implementation.isAvailable(),
+                "enabled": self.implementation.isEnabled(),
+                "platform": "ios"
+            ])
+        }
+    }
+
+    @objc func getPluginVersion(_ call: CAPPluginCall) {
+        call.resolve([
+            "version": implementation.getPluginVersion()
+        ])
+    }
+}

package/ios/Tests/CapacitorProximityPluginTests/CapacitorProximityPluginTests.swift

@@ -0,0 +1,9 @@
+import XCTest
+@testable import CapacitorProximityPlugin
+
+class CapacitorProximityPluginTests: XCTestCase {
+    func testGetPluginVersion() {
+        let implementation = CapacitorProximity()
+        XCTAssertEqual("8.0.0", implementation.getPluginVersion())
+    }
+}

package/package.json

@@ -0,0 +1,93 @@
+{
+  "name": "@capgo/capacitor-proximity",
+  "version": "8.1.1",
+  "description": "Capacitor plugin for enabling proximity monitoring in mobile apps.",
+  "main": "dist/plugin.cjs.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
+  "unpkg": "dist/plugin.js",
+  "files": [
+    "android/src/main/",
+    "android/build.gradle",
+    "dist/",
+    "ios/Sources",
+    "ios/Tests",
+    "android/gradle.properties",
+    "android/settings.gradle",
+    "android/proguard-rules.pro",
+    "Package.swift",
+    "CapgoCapacitorProximity.podspec"
+  ],
+  "author": "Capgo",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Cap-go/capacitor-proximity.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Cap-go/capacitor-proximity/issues"
+  },
+  "homepage": "https://capgo.app/docs/plugins/proximity/",
+  "keywords": [
+    "capacitor",
+    "plugin",
+    "proximity",
+    "sensor",
+    "screen",
+    "ios",
+    "android"
+  ],
+  "scripts": {
+    "verify": "bun run verify:ios && bun run verify:android && bun run verify:web",
+    "verify:ios": "xcodebuild -scheme CapgoCapacitorProximity -destination generic/platform=iOS",
+    "verify:android": "cd android && ./gradlew clean build test && cd ..",
+    "verify:web": "bun run build",
+    "lint": "bun run eslint && bun run prettier -- --check && bun run swiftlint -- lint",
+    "fmt": "bun run eslint -- --fix && bun run prettier -- --write && bun run swiftlint -- --fix --format",
+    "eslint": "eslint . --ext .ts",
+    "prettier": "prettier-pretty-check \"**/*.{css,html,ts,js,java}\" --plugin=prettier-plugin-java",
+    "swiftlint": "node-swiftlint",
+    "docgen": "docgen --api CapacitorProximityPlugin --output-readme README.md --output-json dist/docs.json",
+    "build": "bun run clean && bun run docgen && tsc && rollup -c rollup.config.mjs",
+    "clean": "rimraf ./dist",
+    "watch": "tsc --watch",
+    "prepublishOnly": "bun run build",
+    "check:wiring": "node scripts/check-capacitor-plugin-wiring.mjs"
+  },
+  "devDependencies": {
+    "@capacitor/android": "^8.0.0",
+    "@capacitor/cli": "^8.0.0",
+    "@capacitor/core": "^8.0.0",
+    "@capacitor/docgen": "^0.3.1",
+    "@capacitor/ios": "^8.0.0",
+    "@ionic/eslint-config": "^0.4.0",
+    "@ionic/prettier-config": "^4.0.0",
+    "@ionic/swiftlint-config": "^2.0.0",
+    "@types/node": "^24.10.1",
+    "eslint": "^8.57.1",
+    "eslint-plugin-import": "^2.31.0",
+    "prettier": "^3.6.2",
+    "prettier-pretty-check": "^0.2.0",
+    "prettier-plugin-java": "^2.7.7",
+    "rimraf": "^6.1.0",
+    "rollup": "^4.53.2",
+    "swiftlint": "^2.0.0",
+    "typescript": "^5.9.3"
+  },
+  "peerDependencies": {
+    "@capacitor/core": ">=8.0.0"
+  },
+  "prettier": "@ionic/prettier-config",
+  "swiftlint": "@ionic/swiftlint-config",
+  "eslintConfig": {
+    "extends": "@ionic/eslint-config/recommended"
+  },
+  "capacitor": {
+    "ios": {
+      "src": "ios"
+    },
+    "android": {
+      "src": "android"
+    }
+  }
+}