@capawesome/capacitor-gyroscope 0.0.1

package/ios/Plugin/Enums/CustomError.swift

@@ -0,0 +1,20 @@
+import Foundation
+
+enum CustomError: Error {
+    case dataNotReceived
+    case notAvailable
+    case privacyDescriptionsMissing
+}
+
+extension CustomError: LocalizedError {
+    public var errorDescription: String? {
+        switch self {
+        case .dataNotReceived:
+            return NSLocalizedString("No gyroscope data received.", comment: "dataNotReceived")
+        case .notAvailable:
+            return NSLocalizedString("Not available on this device.", comment: "notAvailable")
+        case .privacyDescriptionsMissing:
+            return NSLocalizedString("One or more privacy descriptions are missing.", comment: "privacyDescriptionsMissing")
+        }
+    }
+}

package/ios/Plugin/Gyroscope.swift

@@ -0,0 +1,87 @@
+import Foundation
+import CoreMotion
+
+@objc public class Gyroscope: NSObject {
+    private var isRunning = false
+    private var lastMeasurement: Measurement?
+    private lazy var motionManager = CMMotionManager()
+    private let plugin: GyroscopePlugin
+    private let queue = OperationQueue()
+    private var updateInterval: TimeInterval = 0.25
+
+    init(plugin: GyroscopePlugin) {
+        self.plugin = plugin
+    }
+
+    @objc func getMeasurement(completion: @escaping (Measurement?, Error?) -> Void) {
+        guard motionManager.isGyroAvailable else {
+            completion(nil, CustomError.notAvailable)
+            return
+        }
+
+        if isRunning, let lastMeasurement = lastMeasurement {
+            completion(lastMeasurement, nil)
+            return
+        }
+
+        motionManager.gyroUpdateInterval = updateInterval
+        motionManager.startGyroUpdates(to: queue) { data, error in
+            if let error = error {
+                self.motionManager.stopGyroUpdates()
+                completion(nil, error)
+                return
+            }
+
+            guard let data = data else {
+                self.motionManager.stopGyroUpdates()
+                completion(nil, CustomError.dataNotReceived)
+                return
+            }
+
+            self.lastMeasurement = Measurement(data)
+            self.motionManager.stopGyroUpdates()
+            completion(self.lastMeasurement, nil)
+        }
+    }
+
+    @objc func isAvailable(completion: @escaping (IsAvailableResult?, Error?) -> Void) {
+        completion(IsAvailableResult(isAvailable: motionManager.isGyroAvailable), nil)
+    }
+
+    @objc public func startMeasurementUpdates(completion: @escaping (Error?) -> Void) {
+        guard motionManager.isGyroAvailable else {
+            completion(CustomError.notAvailable)
+            return
+        }
+        guard !isRunning else {
+            completion(nil)
+            return
+        }
+
+        motionManager.gyroUpdateInterval = updateInterval
+        motionManager.startGyroUpdates(to: queue) { data, _ in
+            if let data = data {
+                self.lastMeasurement = Measurement(data)
+                if let measurement = self.lastMeasurement {
+                    self.plugin.handleMeasurementEvent(measurement)
+                }
+            }
+        }
+
+        isRunning = true
+        completion(nil)
+    }
+
+    @objc func stopMeasurementUpdates(completion: ((Error?) -> Void)? = nil) {
+        guard motionManager.isGyroAvailable else {
+            completion?(CustomError.notAvailable)
+            return
+        }
+
+        motionManager.stopGyroUpdates()
+        if let completion = completion {
+            isRunning = false
+            completion(nil)
+        }
+    }
+}

package/ios/Plugin/GyroscopePlugin.swift

@@ -0,0 +1,116 @@
+import Foundation
+import Capacitor
+
+@objc(GyroscopePlugin)
+public class GyroscopePlugin: CAPPlugin, CAPBridgedPlugin {
+    public let identifier = "GyroscopePlugin"
+    public let jsName = "Gyroscope"
+    public let pluginMethods: [CAPPluginMethod] = [
+        CAPPluginMethod(name: "getMeasurement", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "isAvailable", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "startMeasurementUpdates", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "stopMeasurementUpdates", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "checkPermissions", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "requestPermissions", returnType: CAPPluginReturnPromise)
+    ]
+
+    public static let measurementEvent = "measurement"
+
+    public static let tag = "GyroscopePlugin"
+
+    private var implementation: Gyroscope?
+
+    override public func load() {
+        self.implementation = Gyroscope(plugin: self)
+    }
+
+    @objc override public func checkPermissions(_ call: CAPPluginCall) {
+        call.resolve(["gyroscope": "granted"])
+    }
+
+    @objc func getMeasurement(_ call: CAPPluginCall) {
+        if !hasUsageDescription(forKey: "NSMotionUsageDescription") {
+            rejectCall(call, CustomError.privacyDescriptionsMissing)
+            return
+        }
+
+        implementation?.getMeasurement { result, error in
+            if let error = error {
+                self.rejectCall(call, error)
+                return
+            }
+            self.resolveCall(call, result)
+        }
+    }
+
+    @objc func handleMeasurementEvent(_ event: Measurement) {
+        if let data = event.toJSObject() as? JSObject {
+            notifyListeners(GyroscopePlugin.measurementEvent, data: data)
+        }
+    }
+
+    @objc func isAvailable(_ call: CAPPluginCall) {
+        implementation?.isAvailable { result, error in
+            if let error = error {
+                self.rejectCall(call, error)
+                return
+            }
+            self.resolveCall(call, result)
+        }
+    }
+
+    @objc override public func removeAllListeners(_ call: CAPPluginCall) {
+        super.removeAllListeners(call)
+        implementation?.stopMeasurementUpdates()
+    }
+
+    @objc override public func requestPermissions(_ call: CAPPluginCall) {
+        call.resolve(["gyroscope": "granted"])
+    }
+
+    @objc func startMeasurementUpdates(_ call: CAPPluginCall) {
+        if !hasUsageDescription(forKey: "NSMotionUsageDescription") {
+            rejectCall(call, CustomError.privacyDescriptionsMissing)
+            return
+        }
+
+        implementation?.startMeasurementUpdates { error in
+            if let error = error {
+                self.rejectCall(call, error)
+                return
+            }
+            self.resolveCall(call)
+        }
+    }
+
+    @objc func stopMeasurementUpdates(_ call: CAPPluginCall) {
+        implementation?.stopMeasurementUpdates { error in
+            if let error = error {
+                self.rejectCall(call, error)
+                return
+            }
+            self.resolveCall(call)
+        }
+    }
+
+    private func hasUsageDescription(forKey key: String) -> Bool {
+        return Bundle.main.object(forInfoDictionaryKey: key) is String
+    }
+
+    private func rejectCall(_ call: CAPPluginCall, _ error: Error) {
+        CAPLog.print("[", GyroscopePlugin.tag, "] ", error)
+        call.reject(error.localizedDescription)
+    }
+
+    private func resolveCall(_ call: CAPPluginCall) {
+        call.resolve()
+    }
+
+    private func resolveCall(_ call: CAPPluginCall, _ result: Result?) {
+        if let result = result?.toJSObject() as? JSObject {
+            call.resolve(result)
+        } else {
+            call.resolve()
+        }
+    }
+}

package/ios/Plugin/Info.plist

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>$(DEVELOPMENT_LANGUAGE)</string>
+	<key>CFBundleExecutable</key>
+	<string>$(EXECUTABLE_NAME)</string>
+	<key>CFBundleIdentifier</key>
+	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundleName</key>
+	<string>$(PRODUCT_NAME)</string>
+	<key>CFBundlePackageType</key>
+	<string>FMWK</string>
+	<key>CFBundleShortVersionString</key>
+	<string>1.0</string>
+	<key>CFBundleVersion</key>
+	<string>$(CURRENT_PROJECT_VERSION)</string>
+	<key>NSPrincipalClass</key>
+	<string></string>
+</dict>
+</plist>

package/ios/Plugin/Protocols/Result.swift

@@ -0,0 +1,5 @@
+import Capacitor
+
+@objc public protocol Result {
+    @objc func toJSObject() -> AnyObject
+}

package/package.json

@@ -0,0 +1,91 @@
+{
+  "name": "@capawesome/capacitor-gyroscope",
+  "version": "0.0.1",
+  "description": "Capacitor plugin to read the device's gyroscope sensor.",
+  "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/Plugin/",
+    "CapawesomeCapacitorGyroscope.podspec",
+    "Package.swift"
+  ],
+  "author": "Robin Genz <mail@robingenz.dev>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/capawesome-team/capacitor-plugins.git"
+  },
+  "bugs": {
+    "url": "https://github.com/capawesome-team/capacitor-plugins/issues"
+  },
+  "funding": [
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/capawesome-team/"
+    },
+    {
+      "type": "opencollective",
+      "url": "https://opencollective.com/capawesome"
+    }
+  ],
+  "homepage": "https://capawesome.io/docs/plugins/gyroscope/",
+  "keywords": [
+    "capacitor",
+    "plugin",
+    "native"
+  ],
+  "scripts": {
+    "verify": "npm run verify:ios && npm run verify:android && npm run verify:web",
+    "verify:ios": "cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..",
+    "verify:android": "cd android && ./gradlew clean build test && cd ..",
+    "verify:web": "npm run build",
+    "lint": "npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint",
+    "fmt": "npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format",
+    "eslint": "eslint . --ext ts",
+    "prettier": "prettier \"**/*.{css,html,ts,js,java}\"",
+    "swiftlint": "node-swiftlint",
+    "docgen": "docgen --api GyroscopePlugin --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",
+    "ios:pod:install": "cd ios && pod install --repo-update && cd ..",
+    "ios:spm:install": "cd ios && swift package resolve && cd ..",
+    "prepublishOnly": "npm run build"
+  },
+  "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",
+    "eslint": "8.57.0",
+    "prettier-plugin-java": "2.6.7",
+    "rimraf": "6.1.2",
+    "rollup": "4.53.3",
+    "swiftlint": "2.0.0",
+    "typescript": "5.9.3"
+  },
+  "peerDependencies": {
+    "@capacitor/core": ">=8.0.0"
+  },
+  "eslintConfig": {
+    "extends": "@ionic/eslint-config/recommended"
+  },
+  "capacitor": {
+    "ios": {
+      "src": "ios"
+    },
+    "android": {
+      "src": "android"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}