@aalzehla/capacitor-contacts 0.0.4 → 8.0.0

package/ios/Plugin/ContactsPlugin.swift

@@ -0,0 +1,221 @@
+import Foundation
+import Capacitor
+import Contacts
+import ContactsUI
+
+enum CallingMethod {
+    case GetContact
+    case GetContacts
+    case CreateContact
+    case DeleteContact
+    case PickContact
+}
+
+@objc(ContactsPlugin)
+public class ContactsPlugin: CAPPlugin, CNContactPickerDelegate {
+    private let implementation = Contacts()
+
+    private var callingMethod: CallingMethod?
+
+    private var pickContactCallbackId: String?
+
+    @objc override public func checkPermissions(_ call: CAPPluginCall) {
+        let permissionState: String
+
+        switch CNContactStore.authorizationStatus(for: .contacts) {
+        case .notDetermined:
+            permissionState = "prompt"
+        case .restricted, .denied:
+            permissionState = "denied"
+        case .authorized:
+            permissionState = "granted"
+        case .limited:
+            permissionState = "limited"
+        @unknown default:
+            permissionState = "prompt"
+        }
+
+        call.resolve([
+            "contacts": permissionState
+        ])
+    }
+
+    @objc override public func requestPermissions(_ call: CAPPluginCall) {
+        CNContactStore().requestAccess(for: .contacts) { [weak self] _, _  in
+            self?.checkPermissions(call)
+        }
+    }
+
+    private func requestContactsPermission(_ call: CAPPluginCall, _ callingMethod: CallingMethod) {
+        self.callingMethod = callingMethod
+        if isContactsPermissionGranted() {
+            permissionCallback(call)
+        } else {
+            CNContactStore().requestAccess(for: .contacts) { [weak self] _, _  in
+                self?.permissionCallback(call)
+            }
+        }
+    }
+
+    private func isContactsPermissionGranted() -> Bool {
+        switch CNContactStore.authorizationStatus(for: .contacts) {
+        case .notDetermined, .restricted, .denied:
+            return false
+        case .authorized, .limited:
+            return true
+        @unknown default:
+            return false
+        }
+    }
+
+    private func permissionCallback(_ call: CAPPluginCall) {
+        let method = self.callingMethod
+
+        self.callingMethod = nil
+
+        if !isContactsPermissionGranted() {
+            call.reject("Permission is required to access contacts.")
+            return
+        }
+
+        switch method {
+        case .GetContact:
+            getContact(call)
+        case .GetContacts:
+            getContacts(call)
+        case .CreateContact:
+            createContact(call)
+        case .DeleteContact:
+            deleteContact(call)
+        case .PickContact:
+            pickContact(call)
+        default:
+            // No method was being called,
+            // so nothing has to be done here.
+            break
+        }
+    }
+
+    @objc func getContact(_ call: CAPPluginCall) {
+        if !isContactsPermissionGranted() {
+            requestContactsPermission(call, CallingMethod.GetContact)
+        } else {
+            let contactId = call.getString("contactId")
+
+            guard let contactId = contactId else {
+                call.reject("Parameter `contactId` not provided.")
+                return
+            }
+
+            let projectionInput = GetContactsProjectionInput(call.getObject("projection") ?? JSObject())
+
+            let contact = implementation.getContact(contactId, projectionInput)
+
+            guard let contact = contact else {
+                call.reject("Contact not found.")
+                return
+            }
+
+            call.resolve([
+                "contact": contact.getJSObject()
+            ])
+        }
+    }
+
+    @objc func getContacts(_ call: CAPPluginCall) {
+        if !isContactsPermissionGranted() {
+            requestContactsPermission(call, CallingMethod.GetContacts)
+        } else {
+            let projectionInput = GetContactsProjectionInput(call.getObject("projection") ?? JSObject())
+
+            let contacts = implementation.getContacts(projectionInput)
+
+            var contactsJSArray: JSArray = JSArray()
+
+            for contact in contacts {
+                contactsJSArray.append(contact.getJSObject())
+            }
+
+            call.resolve([
+                "contacts": contactsJSArray
+            ])
+        }
+    }
+
+    @objc func createContact(_ call: CAPPluginCall) {
+        if !isContactsPermissionGranted() {
+            requestContactsPermission(call, CallingMethod.CreateContact)
+        } else {
+            let contactInput = CreateContactInput.init(call.getObject("contact", JSObject()))
+
+            let contactId = implementation.createContact(contactInput)
+
+            guard let contactId = contactId else {
+                call.reject("Something went wrong.")
+                return
+            }
+
+            call.resolve([
+                "contactId": contactId
+            ])
+        }
+    }
+
+    @objc func deleteContact(_ call: CAPPluginCall) {
+        if !isContactsPermissionGranted() {
+            requestContactsPermission(call, CallingMethod.DeleteContact)
+        } else {
+            let contactId = call.getString("contactId")
+
+            guard let contactId = contactId else {
+                call.reject("Parameter `contactId` not provided.")
+                return
+            }
+
+            if !implementation.deleteContact(contactId) {
+                call.reject("Something went wrong.")
+                return
+            }
+
+            call.resolve()
+        }
+    }
+
+    @objc func pickContact(_ call: CAPPluginCall) {
+        if !isContactsPermissionGranted() {
+            requestContactsPermission(call, CallingMethod.PickContact)
+        } else {
+            DispatchQueue.main.async {
+                // Save the call and its callback id
+                self.bridge?.saveCall(call)
+                self.pickContactCallbackId = call.callbackId
+
+                // Initialize the contact picker
+                let contactPicker = CNContactPickerViewController()
+                // Mark current class as the delegate class,
+                // this will make the callback `contactPicker` actually work.
+                contactPicker.delegate = self
+                // Present (open) the native contact picker.
+                self.bridge?.viewController?.present(contactPicker, animated: true)
+            }
+        }
+    }
+
+    public func contactPicker(_ picker: CNContactPickerViewController, didSelect selectedContact: CNContact) {
+        let call = self.bridge?.savedCall(withID: self.pickContactCallbackId ?? "")
+
+        guard let call = call else {
+            return
+        }
+
+        let contact = ContactPayload(selectedContact.identifier)
+
+        contact.fillData(selectedContact)
+
+        call.resolve([
+            "contact": contact.getJSObject()
+        ])
+
+        self.bridge?.releaseCall(call)
+    }
+}

package/ios/Plugin/CreateContactInput.swift

@@ -0,0 +1,187 @@
+import Foundation
+import Capacitor
+
+public class CreateContactInput {
+
+    // Name
+    public var nameGiven: String?
+    public var nameMiddle: String?
+    public var nameFamily: String?
+    public var namePrefix: String?
+    public var nameSuffix: String?
+
+    // Organization
+    public var organizationName: String?
+    public var organizationJobTitle: String?
+    public var organizationDepartment: String?
+
+    // Birthday
+    public var birthday: DateComponents?
+
+    // Note
+    public var note: String?
+
+    // Phones
+    public var phones: [PhoneInput] = []
+
+    // Emails
+    public var emails: [EmailInput] = []
+
+    // URLs
+    public var urls: [String] = []
+
+    // Postal Addresses
+    public var postalAddresses: [PostalAddressInput] = []
+
+    // Image
+    public var image: ImageInput?
+
+    init(_ fromJSONObject: JSObject) {
+        // Name
+        if let nameObject = fromJSONObject["name"] as? JSObject {
+            self.nameGiven = nameObject["given"] as? String
+            self.nameMiddle = nameObject["middle"] as? String
+            self.nameFamily = nameObject["family"] as? String
+            self.namePrefix = nameObject["prefix"] as? String
+            self.nameSuffix = nameObject["suffix"] as? String
+        }
+
+        // Organization
+        if let organizationObject = fromJSONObject["organization"] as? JSObject {
+            self.organizationName = organizationObject["company"] as? String
+            self.organizationJobTitle = organizationObject["jobTitle"] as? String
+            self.organizationDepartment = organizationObject["department"] as? String
+        }
+
+        // Birthday
+        if let birthdayObject = fromJSONObject["birthday"] as? JSObject {
+            let year = birthdayObject["year"] as? Int
+            let month = birthdayObject["month"] as? Int
+            let day = birthdayObject["day"] as? Int
+            let dateComponents = DateComponents(calendar: .current, timeZone: nil, year: year, month: month, day: day)
+
+            if dateComponents.isValidDate {
+                self.birthday = dateComponents
+            }
+        }
+
+        // Note
+        self.note = fromJSONObject["note"] as? String
+
+        // Phones
+        if let phonesArray = fromJSONObject["phones"] as? JSArray {
+            for phone in phonesArray {
+                if let phoneObject = phone as? JSObject {
+                    self.phones.append(PhoneInput.init(phoneObject))
+                }
+            }
+        }
+
+        // Emails
+        if let emailsArray = fromJSONObject["emails"] as? JSArray {
+            for email in emailsArray {
+                if let emailObject = email as? JSObject {
+                    self.emails.append(EmailInput.init(emailObject))
+                }
+            }
+        }
+
+        // URLs
+        if let urlsArray = fromJSONObject["urls"] as? JSArray {
+            for url in urlsArray {
+                if let url = url as? String {
+                    self.urls.append(url)
+                }
+            }
+        }
+
+        // Postal Addresses
+        if let postalAddressesArray = fromJSONObject["postalAddresses"] as? JSArray {
+            for postalAddress in postalAddressesArray {
+                if let postalAddressObject = postalAddress as? JSObject {
+                    self.postalAddresses.append(PostalAddressInput.init(postalAddressObject))
+                }
+            }
+        }
+
+        // Image
+        if let imageObject = fromJSONObject["image"] as? JSObject {
+            self.image = ImageInput.init(imageObject)
+        }
+    }
+
+    static func getType(_ type: String?, _ fromJSONObject: JSObject) -> String? {
+        // On Android, a custom label is saved with `type` set to "custom" and a separate `label` attribute.
+        // On iOS, on the contrary, the custom value is just saved into the `type` attribute.
+
+        if type == "custom" {
+            return fromJSONObject["label"] as? String ?? nil
+        }
+
+        return type
+    }
+
+    public class PhoneInput {
+
+        public var type: String?
+
+        public var number: String?
+
+        init(_ fromJSONObject: JSObject) {
+            let type = Contacts.phoneTypeMap.getValue(fromJSONObject["type"] as? String)
+
+            self.type = CreateContactInput.getType(type, fromJSONObject)
+
+            self.number = fromJSONObject["number"] as? String
+        }
+    }
+
+    public class EmailInput {
+
+        public var type: String?
+
+        public var address: String?
+
+        init(_ fromJSONObject: JSObject) {
+            let type = Contacts.emailTypeMap.getValue(fromJSONObject["type"] as? String)
+
+            self.type = CreateContactInput.getType(type, fromJSONObject)
+
+            self.address = fromJSONObject["address"] as? String
+        }
+    }
+
+    public class PostalAddressInput {
+
+        public var type: String?
+
+        public var street: String?
+        public var neighborhood: String?
+        public var city: String?
+        public var region: String?
+        public var postcode: String?
+        public var country: String?
+
+        init(_ fromJSONObject: JSObject) {
+            let type = Contacts.postalAddressTypeMap.getValue(fromJSONObject["type"] as? String)
+
+            self.type = CreateContactInput.getType(type, fromJSONObject)
+
+            self.street = fromJSONObject["street"] as? String
+            self.neighborhood = fromJSONObject["neighborhood"] as? String
+            self.city = fromJSONObject["city"] as? String
+            self.region = fromJSONObject["region"] as? String
+            self.postcode = fromJSONObject["postcode"] as? String
+            self.country = fromJSONObject["country"] as? String
+        }
+    }
+
+    public class ImageInput {
+
+        public var base64String: String?
+
+        init(_ fromJSONObject: JSObject) {
+            self.base64String = fromJSONObject["base64String"] as? String
+        }
+    }
+}

package/ios/Plugin/GetContactsProjectionInput.swift

@@ -0,0 +1,119 @@
+import Foundation
+import Capacitor
+import Contacts
+
+public class GetContactsProjectionInput {
+    // Name
+    private var name: Bool?
+
+    // Organization
+    private var organization: Bool?
+
+    // Birthday
+    private var birthday: Bool?
+
+    // Note
+    private var note: Bool?
+
+    // Phones
+    private var phones: Bool?
+
+    // Emails
+    private var emails: Bool?
+
+    // URLs
+    private var urls: Bool?
+
+    // Postal Addresses
+    private var postalAddresses: Bool?
+
+    // Image
+    private var image: Bool?
+
+    init(_ fromJSONObject: JSObject) {
+        // Name
+        self.name = fromJSONObject["name"] as? Bool
+
+        // Organization
+        self.organization = fromJSONObject["organization"] as? Bool
+
+        // Birthday
+        self.birthday = fromJSONObject["birthday"] as? Bool
+
+        // Note
+        self.note = fromJSONObject["note"] as? Bool
+
+        // Phones
+        self.phones = fromJSONObject["phones"] as? Bool
+
+        // Emails
+        self.emails = fromJSONObject["emails"] as? Bool
+
+        // URLs
+        self.urls = fromJSONObject["urls"] as? Bool
+
+        // Postal Addresses
+        self.postalAddresses = fromJSONObject["postalAddresses"] as? Bool
+
+        // Image
+        self.image = fromJSONObject["image"] as? Bool
+    }
+
+    public func getProjection() -> [CNKeyDescriptor] {
+        var projection: [CNKeyDescriptor] = []
+
+        // Name
+        if self.name == true {
+            projection.append(CNContactFormatter.descriptorForRequiredKeys(for: .fullName))
+            projection.append(CNContactGivenNameKey as CNKeyDescriptor)
+            projection.append(CNContactMiddleNameKey as CNKeyDescriptor)
+            projection.append(CNContactFamilyNameKey as CNKeyDescriptor)
+            projection.append(CNContactNamePrefixKey as CNKeyDescriptor)
+            projection.append(CNContactNameSuffixKey as CNKeyDescriptor)
+        }
+
+        // Organization
+        if self.organization == true {
+            projection.append(CNContactOrganizationNameKey as CNKeyDescriptor)
+            projection.append(CNContactJobTitleKey as CNKeyDescriptor)
+            projection.append(CNContactDepartmentNameKey as CNKeyDescriptor)
+        }
+
+        // Birthday
+        if self.birthday == true {
+            projection.append(CNContactBirthdayKey as CNKeyDescriptor)
+        }
+
+        // Note
+        if self.note == true {
+            projection.append(CNContactNoteKey as CNKeyDescriptor)
+        }
+
+        // Phones
+        if self.phones == true {
+            projection.append(CNContactPhoneNumbersKey as CNKeyDescriptor)
+        }
+
+        // Emails
+        if self.emails == true {
+            projection.append(CNContactEmailAddressesKey as CNKeyDescriptor)
+        }
+
+        // URLs
+        if self.urls == true {
+            projection.append(CNContactUrlAddressesKey as CNKeyDescriptor)
+        }
+
+        // Postal Addresses
+        if self.postalAddresses == true {
+            projection.append(CNContactPostalAddressesKey as CNKeyDescriptor)
+        }
+
+        // Image
+        if self.image == true {
+            projection.append(CNContactImageDataKey as CNKeyDescriptor)
+        }
+
+        return projection
+    }
+}

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

@@ -1,7 +1,7 @@
 {
   "name": "@aalzehla/capacitor-contacts",
-  "version": "0.0.4",
-  "description": "This capacitor plugin allows you to use the native contact picker UI on Android or iOS for single contact selection. Both platforms will return the same payload structure, where the data exists.",
+  "version": "8.0.0",
+  "description": "Contacts Plugin for Capacitor",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
   "types": "dist/esm/index.d.ts",
@@ -10,59 +10,62 @@
     "android/src/main/",
     "android/build.gradle",
     "dist/",
-    "ios/Sources",
-    "ios/Tests",
-    "Package.swift",
-    "AalzehlaCapacitorContacts.podspec"
+    "ios/Plugin/",
+    "CapacitorCommunityContacts.podspec"
   ],
-  "author": "Ateik Alzehla",
+  "author": "",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/aalzehla/capacitor-contacts.git"
+    "url": "git+https://github.com/capacitor-community/contacts.git"
   },
   "bugs": {
-    "url": "https://github.com/aalzehla/capacitor-contacts/issues"
+    "url": "https://github.com/capacitor-community/contacts/issues"
   },
   "keywords": [
     "capacitor",
-    "plugin",
-    "native"
+    "plugin"
   ],
   "scripts": {
     "verify": "npm run verify:ios && npm run verify:android && npm run verify:web",
-    "verify:ios": "xcodebuild -scheme CapacitorContacts -destination generic/platform=iOS",
+    "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}\"",
+    "prettier": "prettier \"**/*.{css,html,ts,js,java}\" --plugin=prettier-plugin-java --write",
     "swiftlint": "node-swiftlint",
-    "docgen": "docgen --api CapacitorContactsPlugin --output-readme README.md --output-json dist/docs.json",
-    "build": "npm run clean && npm run docgen && tsc && rollup -c rollup.config.js",
+    "docgen": "docgen --api ContactsPlugin --output-readme ./docs/api.md",
+    "build": "npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs",
     "clean": "rimraf ./dist",
     "watch": "tsc --watch",
-    "prepublishOnly": "npm run build"
+    "prepublishOnly": "npm run build",
+    "release": "standard-version"
   },
   "devDependencies": {
-    "@capacitor/android": "^7.2.0",
-    "@capacitor/core": "^7.2.0",
-    "@capacitor/docgen": "^0.2.2",
-    "@capacitor/ios": "^7.2.0",
+    "@capacitor/android": "^8.0.0",
+    "@capacitor/core": "^8.0.0",
+    "@capacitor/ios": "^8.0.0",
+    "@commitlint/cli": "^17.3.0",
+    "@commitlint/config-conventional": "^17.3.0",
     "@ionic/eslint-config": "^0.4.0",
-    "@ionic/prettier-config": "^1.0.1",
-    "@ionic/swiftlint-config": "^1.1.2",
-    "eslint": "^8.57.0",
-    "prettier": "~2.3.0",
-    "prettier-plugin-java": "~1.0.2",
-    "rimraf": "^3.0.2",
-    "rollup": "^2.32.0",
-    "swiftlint": "^1.0.1",
-    "typescript": "~4.1.5"
+    "@ionic/prettier-config": "^4.0.0",
+    "@ionic/swiftlint-config": "^2.0.0",
+    "@tafelnl/capacitor-docgen": "^0.1.1",
+    "@types/node": "^24.10.1",
+    "eslint": "^8.57.1",
+    "husky": "^8.0.2",
+    "prettier": "^3.6.2",
+    "prettier-plugin-java": "^2.7.7",
+    "rimraf": "^6.1.0",
+    "rollup": "^4.53.2",
+    "standard-version": "^9.5.0",
+    "swiftlint": "^2.0.0",
+    "typescript": "^5.9.3"
   },
   "peerDependencies": {
-    "@capacitor/core": "^7.2.0"
+    "@capacitor/core": ">=8.0.0"
   },
   "prettier": "@ionic/prettier-config",
   "swiftlint": "@ionic/swiftlint-config",

package/Package.swift

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