Upgrade to Capacitor 3 + improvements

.gitignore

@@ -1,2 +1,7 @@
 node_modules
 dist
+.gradle/
+.idea/
+build/
+*.iml
+local.properties

CalvinckhoCapacitorContactPicker.podspec

@@ -0,0 +1,14 @@
+
+ Pod::Spec.new do |s|
+ s.name = 'CalvinckhoCapacitorContactPicker'
+ s.version = '1.0.0'
+ s.summary = 'Allows users to select one or many contacts from their device.'
+ s.license = 'MIT'
+ s.homepage = 'https://github.com/calvinckho/capacitor-contact-picker'
+ s.author = 'Sean Perkins'
+ s.source = { :git => 'https://github.com/calvinckho/capacitor-contact-picker', :tag => s.version.to_s }
+ s.source_files = 'ios/Plugin/**/*.{swift,h,m,c,cc,mm,cpp}'
+ s.ios.deployment_target = '13.0'
+ s.swift_version = '5.1'
+ s.dependency 'Capacitor'
+ end

README.md

@@ -2,42 +2,111 @@
  <img width="150px" src="https://user-images.githubusercontent.com/13732623/63229908-7d8a8100-c1d3-11e9-955e-31aff33d07e1.png">
 </p>
 
-# @teamhive/capacitor-contact-picker
+# @calvinckho/capacitor-contact-picker
 
-<img src="https://img.shields.io/npm/v/teamhive/capacitor-contact-picker?style=flat-square" />
+<img src="https://img.shields.io/npm/v/@calvinckho/capacitor-contact-picker?style=flat-square" />
 
-This package allows you to use the native contact picker UI on Android or iOS for receiving contact information. iOS supports selecting multiple contacts. Android only support single selection. Both platforms will return the same payload structure, where the data exists.
+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. This project is a fork of [TeamMaestro's plugin](https://github.com/TeamMaestro/capacitor-contact-picker) made for Capacitor 2. The current repo supports Capacitor 5.
 
 ## Installation
+
+Install from NPM (release build):
+```
+npm install @calvinckho/capacitor-contact-picker
+```
+Install from Github. Make sure you insert the branch name at the end:
+```
+npm i git+ssh://[email protected]:calvinckho/capacitor-contact-picker#[branch name]
+```
+
+### iOS
+
+For iOS you need to set a usage description in your info.plist file. (Privacy Setting)
+Open xCode search for your info.plist file and press the tiny "+". Add the following entry:
+
 ```
-yarn add @teamhive/capacitor-contact-picker
-// or
-npm i @teamhive/capacitor-contact-picker
+Privacy - Contacts Usage Description
 ```
 
+Give it a value like:
+
+```
+"We need access to your contacts in order to do something."
+```
+
+Also, on iOS it is a best practice to ask for permission twice. See [here](https://blog.prototypr.io/3-best-practices-for-in-app-permissions-dce7d36544a4). 
+
 ### Android
-Register the plugin class in your `MainActivity.java`:
-```java
-import com.teamhive.capacitor.ContactPicker;
-
-public class MainActivity extends BridgeActivity {
- @Override
- public void onCreate(Bundle savedInstanceState) {
- ...
- add(ContactPicker.class);
- }
-}
+Add users permission in `AndroidManifest.xml`:
+```
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+ package="com.mycompany.app">
++ <uses-permission android:name="android.permission.READ_CONTACTS" />
+</manifest> 
 ```
 
-## Usage
+## Capacitor 3+ Usage
 ```ts
-import { Plugins } from '@capacitor/core';
+import { ContactPicker } from '@calvinckho/capacitor-contact-picker';
 
-const { ContactPicker } = Plugins;
-
-async openPicker() {
- const res = await ContactPicker.open();
- // res.value is an array of contacts
+try {
+ const contact: any = await ContactPicker.open();
+ /* method returns a JSON contact object or undefined if no contact was selected
+ sample contact object:
+ {
+ "displayName":"John Appleseed",
+ "contactId":"410FE041-5C4E-48DA-B4DE-04C15EA3DBAC",
+ "organizationName":"",
+ "jobTitle":"",
+ "emailAddresses":[{"type":"work","emailAddress":"[email protected]"}],
+ "givenName":"John",
+ "note":"College roommate",
+ "phoneNumbers":[{"type":"mobile","phoneNumber":"888-555-5512"},{"type":"home","phoneNumber":"888-555-1212"}],
+ "familyName":"Appleseed",
+ "postalAddresses":[{"postalCode":"30303","street":"3494 Kuhl Avenue","formattedAddress":"3494 Kuhl Avenue\nAtlanta GA 30303\nUSA","type":"work","state":"GA","city":"Atlanta","country":"USA","isoCountryCode":"us"},{"city":"Atlanta","street":"1234 Laurel Street","formattedAddress":"1234 Laurel Street\nAtlanta GA 30303\nUSA","type":"home","state":"GA","postalCode":"30303","country":"USA","isoCountryCode":"us"}],
+ "departmentName":"",
+ "nickname":""
+ }*/
+} catch(err) {
+ // handle method rejection when permission is not granted
 }
 
 ```
+### Returned Object Properties:
+```
+export interface Contact {
+ identifier?: string;
+ androidContactLookupKey?: string; // Android only
+ contactId?: string; // iOS only
+ givenName?: string;
+ familyName?: string;
+ nickname?: string;
+ fullName?: string;
+ jobTitle?: string;
+ departmentName?: string;
+ organizationName?: string;
+ note?: string;
+ emailAddresses: [{
+ type: String,
+ emailAddress: String,
+ }]
+ phoneNumbers: [{
+ type: String,
+ phoneNumber: String,
+ }]
+ postalAddresses: [{
+ type: String,
+ formattedAddress: String,
+ street: String,
+ pobox: String, // Android only
+ neighborhood: String, // Android only
+ city: String,
+ state: String,
+ postalCode: String,
+ country: String,
+ isoCountryCode: String, // iOS only
+ subAdministrativeArea: String, // iOS only
+ subLocality: String, // iOS only
+ }]
+}
+```