chore: renamed plugin class to avoid collision with the original capacitor device plugin

Author: ryaa

README.md

@@ -39,7 +39,7 @@ This plugin offers the API which has been removed from @capacitor/device plugin
 
 ## About
 
-This plugin offers the API which has been removed from `@capacitor/device` plugin in v7.0 (getInfo() no longer returns diskFree, diskTotal, realDiskFree and realDiskTotal) as some apps still require this. For more details also see https://capacitorjs.com/docs/updating/7-0#device
+This plugin offers the API which has been removed from `@capacitor/device` plugin in v7.0 (getInfo() no longer returns diskFree, diskTotal, realDiskFree and realDiskTotal). For more details also see https://capacitorjs.com/docs/updating/7-0#device
 
 This plugin contains code derived from or inspired by [@capacitor/device](https://github.com/ionic-team/capacitor-plugins/tree/main/device) plugin.
 Please note that it is a community plugin, not maintained by the Capacitor team.
@@ -104,10 +104,10 @@ For detailed steps on how to do this, please see the [Capacitor Docs](https://ca
 ## Example Plugin Usage
 
 ```typescript
-import { Device } from '@capacitor-community/device';
+import { CommunityDevice } from '@capacitor-community/device';
 
 const logDeviceInfo = async () => {
-  const info = await Device.getInfo();
+  const info = await CommunityDevice.getInfo();
 
   console.log(info);
 };
@@ -117,8 +117,8 @@ const logDeviceInfo = async () => {
 
 <docgen-index>
 
-* [`getInfo()`](#getinfo)
-* [Interfaces](#interfaces)
+- [`getInfo()`](#getinfo)
+- [Interfaces](#interfaces)
 
 </docgen-index>
 
@@ -128,22 +128,20 @@ const logDeviceInfo = async () => {
 ### getInfo()
 
 ```typescript
-getInfo() => Promise<DeviceInfo>
+getInfo() => Promise<CommunityDeviceInfo>
 ```
 
 Return information about the underlying device/os/platform.
 
-**Returns:** <code>Promise&lt;<a href="#deviceinfo">DeviceInfo</a>&gt;</code>
+**Returns:** <code>Promise&lt;<a href="#communitydeviceinfo">CommunityDeviceInfo</a>&gt;</code>
 
 **Since:** 7.0.0
 
---------------------
-
+---
 
 ### Interfaces
 
-
-#### DeviceInfo
+#### CommunityDeviceInfo
 
 | Prop                | Type                | Description                                                                                                                                                                                                                     | Since |
 | ------------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |

…/ryltsov/alex/plugins/device/Device.java …alex/plugins/device/CommunityDevice.javaandroid/src/main/java/com/ryltsov/alex/plugins/device/Device.java renamed to android/src/main/java/com/ryltsov/alex/plugins/device/CommunityDevice.java android/src/main/java/com/ryltsov/alex/plugins/device/Device.java renamed to android/src/main/java/com/ryltsov/alex/plugins/device/CommunityDevice.java

@@ -1,11 +1,9 @@
 package com.ryltsov.alex.plugins.device;
 
-import android.content.Context;
 import android.os.Environment;
 import android.os.StatFs;
-import android.util.Log;
 
-public class Device {
+public class CommunityDevice {
 
     public long getDiskFree() {
         StatFs statFs = new StatFs(Environment.getRootDirectory().getAbsolutePath());

…ov/alex/plugins/device/DevicePlugin.java …lugins/device/CommunityDevicePlugin.javaandroid/src/main/java/com/ryltsov/alex/plugins/device/DevicePlugin.java renamed to android/src/main/java/com/ryltsov/alex/plugins/device/CommunityDevicePlugin.java android/src/main/java/com/ryltsov/alex/plugins/device/DevicePlugin.java renamed to android/src/main/java/com/ryltsov/alex/plugins/device/CommunityDevicePlugin.java

@@ -6,14 +6,14 @@
 import com.getcapacitor.PluginMethod;
 import com.getcapacitor.annotation.CapacitorPlugin;
 
-@CapacitorPlugin(name = "Device")
-public class DevicePlugin extends Plugin {
+@CapacitorPlugin(name = "CommunityDevice")
+public class CommunityDevicePlugin extends Plugin {
 
-    private Device implementation;
+    private CommunityDevice implementation;
 
     @Override
     public void load() {
-        implementation = new Device();
+        implementation = new CommunityDevice();
     }
 
     @PluginMethod

example-app/src/app/home/home.page.ts

@@ -5,7 +5,7 @@ import {
 } from '@ionic/angular/standalone';
 
 // NATIVE
-import { Device, DeviceInfo } from '@capacitor-community/device';
+import { CommunityDevice, CommunityDeviceInfo } from '@capacitor-community/device';
 
 @Component({
   selector: 'app-home',
@@ -17,13 +17,13 @@ import { Device, DeviceInfo } from '@capacitor-community/device';
 })
 export class HomePage {
 
-  public deviceInfo: DeviceInfo | undefined;
+  public deviceInfo: CommunityDeviceInfo | undefined;
 
   constructor() { }
 
   public async showDeviceInfo(): Promise<void> {
     try {
-      const info: DeviceInfo = await Device.getInfo();
+      const info: CommunityDeviceInfo = await CommunityDevice.getInfo();
       console.log('info', info);
       this.deviceInfo = info;
     } catch (error) {

ios/Sources/DevicePlugin/Device.swift …urces/DevicePlugin/CommunityDevice.swiftios/Sources/DevicePlugin/Device.swift renamed to ios/Sources/DevicePlugin/CommunityDevice.swift ios/Sources/DevicePlugin/Device.swift renamed to ios/Sources/DevicePlugin/CommunityDevice.swift

@@ -1,6 +1,6 @@
 import Foundation
 
-@objc public class Device: NSObject {
+@objc public class CommunityDevice: NSObject {
     /**
      * Get free disk space
      */

…/Sources/DevicePlugin/DevicePlugin.swift …DevicePlugin/CommunityDevicePlugin.swiftios/Sources/DevicePlugin/DevicePlugin.swift renamed to ios/Sources/DevicePlugin/CommunityDevicePlugin.swift ios/Sources/DevicePlugin/DevicePlugin.swift renamed to ios/Sources/DevicePlugin/CommunityDevicePlugin.swift

@@ -5,14 +5,14 @@ import Capacitor
  * Please read the Capacitor iOS Plugin Development Guide
  * here: https://capacitorjs.com/docs/plugins/ios
  */
-@objc(DevicePlugin)
-public class DevicePlugin: CAPPlugin, CAPBridgedPlugin {
-    public let identifier = "DevicePlugin"
-    public let jsName = "Device"
+@objc(CommunityDevicePlugin)
+public class CommunityDevicePlugin: CAPPlugin, CAPBridgedPlugin {
+    public let identifier = "CommunityDevicePlugin"
+    public let jsName = "CommunityDevice"
     public let pluginMethods: [CAPPluginMethod] = [
         CAPPluginMethod(name: "getInfo", returnType: CAPPluginReturnPromise),
     ]
-    private let implementation = Device()
+    private let implementation = CommunityDevice()
 
     @objc func getInfo(_ call: CAPPluginCall) {
 

package.json

@@ -42,7 +42,7 @@
     "eslint": "eslint . --ext ts",
     "prettier": "prettier \"**/*.{css,html,ts,js,java}\" --plugin=prettier-plugin-java",
     "swiftlint": "node-swiftlint",
-    "docgen": "docgen --api DevicePlugin --output-readme README.md --output-json dist/docs.json",
+    "docgen": "docgen --api CommunityDevicePlugin --output-readme README.md --output-json dist/docs.json",
     "build": "npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs",
     "clean": "rimraf ./dist",
     "watch": "tsc --watch",

src/definitions.ts

@@ -1,8 +1,4 @@
-// export interface DevicePlugin {
-//   echo(options: { value: string }): Promise<{ value: string }>;
-// }
-
-export interface DeviceInfo {
+export interface CommunityDeviceInfo {
   /**
    * How much free disk space is available on the normal data storage
    * path for the os, in bytes.
@@ -42,11 +38,11 @@ export interface DeviceInfo {
   realDiskTotal?: number;
 }
 
-export interface DevicePlugin {
+export interface CommunityDevicePlugin {
   /**
    * Return information about the underlying device/os/platform.
    *
    * @since 7.0.0
    */
-  getInfo(): Promise<DeviceInfo>;
+  getInfo(): Promise<CommunityDeviceInfo>;
 }

src/index.ts

@@ -1,10 +1,10 @@
 import { registerPlugin } from '@capacitor/core';
 
-import type { DevicePlugin } from './definitions';
+import type { CommunityDevicePlugin } from './definitions';
 
-const Device = registerPlugin<DevicePlugin>('Device', {
-  web: () => import('./web').then((m) => new m.DeviceWeb()),
+const CommunityDevice = registerPlugin<CommunityDevicePlugin>('CommunityDevice', {
+  web: () => import('./web').then((m) => new m.CommunityDeviceWeb()),
 });
 
 export * from './definitions';
-export { Device };
+export { CommunityDevice };

src/web.ts

@@ -1,9 +1,9 @@
 import { WebPlugin } from '@capacitor/core';
 
-import type { DeviceInfo, DevicePlugin } from './definitions';
+import type { CommunityDeviceInfo, CommunityDevicePlugin } from './definitions';
 
-export class DeviceWeb extends WebPlugin implements DevicePlugin {
-  async getInfo(): Promise<DeviceInfo> {
+export class CommunityDeviceWeb extends WebPlugin implements CommunityDevicePlugin {
+  async getInfo(): Promise<CommunityDeviceInfo> {
     throw this.unavailable('getInfo is not supported on web');
   }
 }