@capawesome/capacitor-screen-reader 0.0.1

package/ios/Plugin/Enums/CustomError.swift

@@ -0,0 +1,21 @@
+import Foundation
+
+enum CustomError: Error {
+    case valueMissing
+
+    var code: String? {
+        switch self {
+        case .valueMissing:
+            return nil
+        }
+    }
+}
+
+extension CustomError: LocalizedError {
+    public var errorDescription: String? {
+        switch self {
+        case .valueMissing:
+            return NSLocalizedString("value must be provided.", comment: "valueMissing")
+        }
+    }
+}

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/ios/Plugin/ScreenReader.swift

@@ -0,0 +1,71 @@
+import Foundation
+import UIKit
+
+@objc public class ScreenReader: NSObject {
+    private let plugin: ScreenReaderPlugin
+
+    private var isObserving = false
+
+    private var lastEnabled = false
+
+    init(plugin: ScreenReaderPlugin) {
+        self.plugin = plugin
+    }
+
+    deinit {
+        NotificationCenter.default.removeObserver(self)
+    }
+
+    @objc public func announce(_ options: AnnounceOptions, completion: @escaping (Error?) -> Void) {
+        let value = options.value
+        DispatchQueue.main.async {
+            UIAccessibility.post(notification: .announcement, argument: value)
+            completion(nil)
+        }
+    }
+
+    @objc public func isEnabled(completion: @escaping (IsEnabledResult?, Error?) -> Void) {
+        DispatchQueue.main.async {
+            completion(IsEnabledResult(enabled: UIAccessibility.isVoiceOverRunning), nil)
+        }
+    }
+
+    func startObserving() {
+        DispatchQueue.main.async { [weak self] in
+            guard let self = self, !self.isObserving else {
+                return
+            }
+            self.isObserving = true
+            self.lastEnabled = UIAccessibility.isVoiceOverRunning
+            NotificationCenter.default.addObserver(
+                self,
+                selector: #selector(self.handleVoiceOverStatusDidChange),
+                name: UIAccessibility.voiceOverStatusDidChangeNotification,
+                object: nil
+            )
+        }
+    }
+
+    func stopObserving() {
+        DispatchQueue.main.async { [weak self] in
+            guard let self = self, self.isObserving else {
+                return
+            }
+            self.isObserving = false
+            NotificationCenter.default.removeObserver(
+                self,
+                name: UIAccessibility.voiceOverStatusDidChangeNotification,
+                object: nil
+            )
+        }
+    }
+
+    @objc private func handleVoiceOverStatusDidChange() {
+        let enabled = UIAccessibility.isVoiceOverRunning
+        guard enabled != lastEnabled else {
+            return
+        }
+        lastEnabled = enabled
+        plugin.notifyStateChangeListeners(StateChangeEvent(enabled: enabled))
+    }
+}

package/ios/Plugin/ScreenReaderPlugin.swift

@@ -0,0 +1,86 @@
+import Foundation
+import Capacitor
+
+@objc(ScreenReaderPlugin)
+public class ScreenReaderPlugin: CAPPlugin, CAPBridgedPlugin {
+    public let identifier = "ScreenReaderPlugin"
+    public let jsName = "ScreenReader"
+    public let pluginMethods: [CAPPluginMethod] = [
+        CAPPluginMethod(name: "announce", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "isEnabled", returnType: CAPPluginReturnPromise)
+    ]
+
+    public static let eventStateChange = "stateChange"
+
+    public static let tag = "ScreenReaderPlugin"
+
+    private var implementation: ScreenReader?
+
+    override public func load() {
+        self.implementation = ScreenReader(plugin: self)
+    }
+
+    @objc override public func addListener(_ call: CAPPluginCall) {
+        super.addListener(call)
+        implementation?.startObserving()
+    }
+
+    @objc func announce(_ call: CAPPluginCall) {
+        do {
+            let options = try AnnounceOptions(call)
+            implementation?.announce(options) { error in
+                if let error = error {
+                    self.rejectCall(call, error)
+                    return
+                }
+                self.resolveCall(call)
+            }
+        } catch {
+            rejectCall(call, error)
+        }
+    }
+
+    @objc func isEnabled(_ call: CAPPluginCall) {
+        implementation?.isEnabled { result, error in
+            if let error = error {
+                self.rejectCall(call, error)
+                return
+            }
+            self.resolveCall(call, result)
+        }
+    }
+
+    public func notifyStateChangeListeners(_ event: StateChangeEvent) {
+        self.notifyListeners(Self.eventStateChange, data: event.toJSObject() as? [String: Any])
+    }
+
+    @objc override public func removeAllListeners(_ call: CAPPluginCall) {
+        super.removeAllListeners(call)
+        implementation?.stopObserving()
+    }
+
+    @objc override public func removeListener(_ call: CAPPluginCall) {
+        super.removeListener(call)
+        if !hasListeners(Self.eventStateChange) {
+            implementation?.stopObserving()
+        }
+    }
+
+    private func rejectCall(_ call: CAPPluginCall, _ error: Error) {
+        CAPLog.print("[", ScreenReaderPlugin.tag, "] ", error)
+        let code = (error as? CustomError)?.code
+        call.reject(error.localizedDescription, code)
+    }
+
+    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/package.json

@@ -0,0 +1,95 @@
+{
+  "name": "@capawesome/capacitor-screen-reader",
+  "version": "0.0.1",
+  "description": "Capacitor plugin to interact with screen readers.",
+  "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/",
+    "CapawesomeCapacitorScreenReader.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/sdks/capacitor/screen-reader/",
+  "keywords": [
+    "capacitor",
+    "plugin",
+    "native",
+    "screen reader",
+    "accessibility",
+    "voiceover",
+    "talkback"
+  ],
+  "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 ScreenReaderPlugin --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"
+  }
+}