awesome-cordova-plugins/src/plugins/contacts.ts

import {Plugin, Cordova, InstanceProperty, CordovaInstance} from './plugin';
declare var window: any = {
    ContactAddress: (...args) => {},
    ContactProperties: (...args) => {},
    ContactOrganization: (...args) => {},
    ContactName: (...args) => {},
    ContactField: (...args) => {},
    ContactFindOptions: (...args) => {}
};
export interface IContactProperties {
    /** A globally unique identifier. */
    id?: string;
    /** The name of this Contact, suitable for display to end users. */
    displayName?: string;
    /** An object containing all components of a persons name. */
    name?: ContactName;
    /** A casual name by which to address the contact. */
    nickname?: string;
    /** An array of all the contact's phone numbers. */
    phoneNumbers?: IContactField[];
    /** An array of all the contact's email addresses. */
    emails?: IContactField[];
    /** An array of all the contact's addresses. */
    addresses?: ContactAddress[];
    /** An array of all the contact's IM addresses. */
    ims?: IContactField[];
    /** An array of all the contact's organizations. */
    organizations?: ContactOrganization[];
    /** The birthday of the contact. */
    birthday?: Date;
    /** A note about the contact. */
    note?: string;
    /** An array of the contact's photos. */
    photos?: IContactField[];
    /** An array of all the user-defined categories associated with the contact. */
    categories?: IContactField[];
    /** An array of web pages associated with the contact. */
    urls?: IContactField[];
}

export class Contact {

    private _objectInstance: any;

    @InstanceProperty
    get id() {return; }

    @InstanceProperty
    get displayName() {return; }

    @InstanceProperty
    get nickname() {return; }

    @InstanceProperty
    get phoneNumbers() {return; }

    @InstanceProperty
    get emails() {return; }

    @InstanceProperty
    get addresses() {return; }

    @InstanceProperty
    get ims() {return; }

    @InstanceProperty
    get organizations() {return; }

    @InstanceProperty
    get birthday() {return; }

    @InstanceProperty
    get note() {return; }

    @InstanceProperty
    get photos() {return; }

    @InstanceProperty
    get categories() {return; }

    @InstanceProperty
    get urls() {return; }


    constructor () {
        this._objectInstance = navigator.contacts.create();
    }

    clone(): Contact {
        // TODO manually clone the object
        return;
    }

    @CordovaInstance()
    remove(): Promise<any> {return; }

    @CordovaInstance()
    save(): Promise<any> {return; }

}

interface IContactError {
    /** Error code */
    code: number;
    /** Error message */
    message: string;
}

declare var ContactError: {
    new(code: number): IContactError;
    UNKNOWN_ERROR: number;
    INVALID_ARGUMENT_ERROR: number;
    TIMEOUT_ERROR: number;
    PENDING_OPERATION_ERROR: number;
    IO_ERROR: number;
    NOT_SUPPORTED_ERROR: number;
    PERMISSION_DENIED_ERROR: number
};

export interface IContactName {
    /** The complete name of the contact. */
    formatted?: string;
    /** The contact's family name. */
    familyName?: string;
    /** The contact's given name. */
    givenName?: string;
    /** The contact's middle name. */
    middleName?: string;
    /** The contact's prefix (example Mr. or Dr.) */
    honorificPrefix?: string;
    /** The contact's suffix (example Esq.). */
    honorificSuffix?: string;
}

export class ContactName implements IContactName {
    private _objectInstance: any;

    constructor(formatted?: string, familyName?: string, givenName?: string, middleName?: string, honorificPrefix?: string, honorificSuffix?: string) {
        this._objectInstance = new window.ContactName(formatted, familyName, givenName, middleName, honorificPrefix, honorificSuffix);
    }

    @InstanceProperty
    get formatted(): string {return; }
    @InstanceProperty
    get familyName(): string {return; }
    @InstanceProperty
    get givenName(): string {return; }
    @InstanceProperty
    get middleName(): string {return; }
    @InstanceProperty
    get honorificPrefix(): string {return; }
    @InstanceProperty
    get honorificSuffix(): string {return; }
}

export interface IContactField {
    /** A string that indicates what type of field this is, home for example. */
    type: string;
    /** The value of the field, such as a phone number or email address. */
    value: string;
    /** Set to true if this ContactField contains the user's preferred value. */
    pref: boolean;
}

export class ContactField implements IContactField {
    private _objectInstance: any;
    constructor(type?: string, value?: string, pref?: boolean) {
        this._objectInstance = new window.ContactField(type, value, pref);
    }
    @InstanceProperty
    get type(): string {return; }
    @InstanceProperty
    get value(): string {return; }
    @InstanceProperty
    get pref(): boolean {return; }
}

export interface IContactAddress {
    /** Set to true if this ContactAddress contains the user's preferred value. */
    pref?: boolean;
    /** A string indicating what type of field this is, home for example. */
    type?: string;
    /** The full address formatted for display. */
    formatted?: string;
    /** The full street address. */
    streetAddress?: string;
    /** The city or locality. */
    locality?: string;
    /** The state or region. */
    region?: string;
    /** The zip code or postal code. */
    postalCode?: string;
    /** The country name. */
    country?: string;
}

export class ContactAddress implements IContactAddress {
    private _objectInstance: any;

    constructor (pref?: boolean,
                 type?: string,
                 formatted?: string,
                 streetAddress?: string,
                 locality?: string,
                 region?: string,
                 postalCode?: string,
                 country?: string) {
        this._objectInstance = new window.ContactAddress(pref, type, formatted, streetAddress, locality, region, postalCode, country);
    }

    @InstanceProperty
    get pref(): boolean {return; }

    @InstanceProperty
    get type(): string {return; }

    @InstanceProperty
    get formatted(): string {return; }

    @InstanceProperty
    get streetAddress(): string {return; }

    @InstanceProperty
    get locality(): string {return; }

    @InstanceProperty
    get region(): string {return; }

    @InstanceProperty
    get postalCode(): string {return; }

    @InstanceProperty
    get country(): string {return; }
}

export interface IContactOrganization {
    /** Set to true if this ContactOrganization contains the user's preferred value. */
    pref?: boolean;
    /** A string that indicates what type of field this is, home for example. */
    type?: string;
    /** The name of the organization. */
    name?: string;
    /** The department the contract works for. */
    department?: string;
    /** The contact's title at the organization. */
    title?: string;
}

export class ContactOrganization implements IContactOrganization {
    private _objectInstance: any;
    constructor () {
        this._objectInstance = new window.ContactOrganization();
    }
    @InstanceProperty
    get pref(): boolean {return; }

    @InstanceProperty
    get type(): string {return; }

    @InstanceProperty
    get name(): string {return; }

    @InstanceProperty
    get department(): string {return; }

    @InstanceProperty
    get title(): string {return; }
}

/** Search options to filter navigator.contacts.  */
interface IContactFindOptions {
    /** The search string used to find navigator.contacts. */
    filter?: string;
    /** Determines if the find operation returns multiple navigator.contacts. */
    multiple?: boolean;
    /* Contact fields to be returned back. If specified, the resulting Contact object only features values for these fields. */
    desiredFields?: string[];
}

export class ContactFindOptions implements IContactFindOptions {
    private _objectInstance: any;
    constructor () {
        this._objectInstance = new window.ContactFindOptions();
    }
    @InstanceProperty
    public get filter(): string {return; }

    @InstanceProperty
    public get multiple(): boolean {return; }

    @InstanceProperty
    public get desiredFields(): any {return; }

    @InstanceProperty
    public get hasPhoneNumber(): boolean {return; }
}

/**
 * @name Contacts
 * @description
 * Access and manage Contacts on the device.
 *
 * Requires plugin: `cordova-plugin-contacts`
 * For full info, please see the [Cordova Contacts plugin docs](https://github.com/apache/cordova-plugin-contacts)
 *
 * @usage
 *
 * ```js
 * import {Contacts} from 'ionic-native';
 *
 *
 *
 * Contacts.create({
 *   displayName: "Mr. Ionitron"
 * }).then((contact) => {}, (err) => {})
 * ```
 *
 *
 */
@Plugin({
  plugin: 'cordova-plugin-contacts',
  pluginRef: 'navigator.contacts',
  repo: 'https://github.com/apache/cordova-plugin-contacts'
})
export class Contacts {

    static create(): Contact {
        return new Contact();
    }

    // TODO add fieldType options

  /**
   * Search for contacts in the Contacts list.
   *
   * Example: Contacts.find(['*'], { filter: 'Max' }) // will search for a displayName of 'Max'
   *
   * @param fields {string[]}  Contact fields to be used as a search qualifier.
   *  A zero-length contactFields parameter is invalid and results in ContactError.INVALID_ARGUMENT_ERROR.
   *  A contactFields value of "*" searches all contact fields.
   *
   * @param options {Object} the options to query with:
   *   filter: The search string used to find navigator.contacts. (string) (Default: "")
   *   multiple: Determines if the find operation returns multiple navigator.contacts. (Boolean) (Default: false)
   *   desiredFields: Contact fields to be returned back. If specified, the resulting Contact object only features values for these fields. (DOMString[]) [Optional]
   *   hasPhoneNumber(Android only): Filters the search to only return contacts with a phone number informed. (Boolean) (Default: false)
   *
   * @return Returns a Promise that resolves with the search results (an array of Contact objects)
   */
  @Cordova({
    successIndex: 1,
    errorIndex: 2
  })
  static find(fields: string[], options?: any): Promise<any> { return; }


  /**
   * Select a single Contact.
   * @return Returns a Promise that resolves with the selected Contact
   */
  @Cordova()
  static pickContact(): Promise<any> { return; }
}