✨ Implement icloud contacts service

Author: lepirlouit

src/index.ts

@@ -12,6 +12,7 @@ import { iCloudDriveService } from "./services/drive";
 import { iCloudFindMyService } from "./services/findMy";
 import { iCloudPhotosService } from "./services/photos";
 import { iCloudUbiquityService } from "./services/ubiquity";
+import { iCloudContactsService } from "./services/contacts";
 import { AccountInfo } from "./types";
 
 export type { iCloudAuthenticationStore } from "./auth/authStore";
@@ -476,7 +477,8 @@ export default class iCloudService extends EventEmitter {
         ubiquity: iCloudUbiquityService,
         drivews: iCloudDriveService,
         calendar: iCloudCalendarService,
-        photos: iCloudPhotosService
+        photos: iCloudPhotosService,
+        contacts: iCloudContactsService
     };
 
     // Returns an instance of the 'account' (Account Details) service.
@@ -494,6 +496,8 @@ export default class iCloudService extends EventEmitter {
     getService(service: "calendar"): iCloudCalendarService
     // Returns an instance of the 'photos' (iCloud Photos) service.
     getService(service: "photos"): iCloudPhotosService
+    // Returns an instance of the 'contacts' (iCloud Contacts) service.
+    getService(service: "contacts"): iCloudContactsService
     /**
      * Returns an instance of the specified service. Results are cached, so subsequent calls will return the same instance.
      * @param service The service name to return an instance of. Must be one of the keys in {@link iCloudService.serviceConstructors}.

src/services/contacts.ts

@@ -0,0 +1,84 @@
+import fetch from "node-fetch";
+import iCloudService from "..";
+interface iCloudFieldLabel{
+    field: string;
+    label: string;
+}
+interface iCloudContact{
+    firstName?: string;
+    lastName?: string;
+    isGuardianApproved: boolean;
+    emailAddresses?: Array<iCloudFieldLabel>;
+    contactId: string;
+    normalized: string;
+    phones?: Array<iCloudFieldLabel>;
+    urls?: Array<iCloudFieldLabel>;
+    dates?: Array<iCloudFieldLabel>;
+    relatedNames?: Array<iCloudFieldLabel>;
+    notes?: string;
+    birthday?: string;
+    etag: string;
+    whitelisted: boolean;
+    isCompany: boolean;
+    profiles?: { field: string; label: string; user: string }[];
+    IMs?: { field: { IMService: string; userName: string; }; label: string; }[];
+    photo?: { signature: string; url: string; crop: { x: number; y: number; width: number; height: number; } }
+    streetAddresses?: {
+        field: {
+            country: string;
+            countryCode: string;
+            street?: string;
+            city?: string;
+            postalCode?: string;
+            state?: string;
+        };
+        label: string;
+    }[];
+}
+interface iCloudContactsStartupResponse {
+    syncToken: string;
+    prefToken: string;
+    contacts: Array<iCloudContact>;
+}
+interface iCloudContactsContactsResponse {
+    contacts: Array<iCloudContact>;
+}
+
+export class iCloudContactsService {
+    service: iCloudService;
+    serviceUri: string;
+    constructor(service: iCloudService, serviceUri: string) {
+        this.service = service;
+        this.serviceUri = serviceUri;
+    }
+    // fetch contacts
+    async contacts() {
+        const params = {
+            locale: "en_US",
+            order: "last,first"
+        };
+        const url = new URL("/co/startup", this.serviceUri);
+        url.search = new URLSearchParams({ ...params, clientVersion: "2.1" }).toString();
+
+        const request = await fetch(url.href, {
+            headers: this.service.authStore.getHeaders()
+        });
+        const json = await request.json() as iCloudContactsStartupResponse;
+
+        const paramsNext = {
+            ...params,
+            prefToken: json.prefToken,
+            syncToken: json.syncToken,
+            limit: "0",
+            offset: "0"
+        };
+        const urlNext = new URL("/co/contacts", this.serviceUri);
+        urlNext.search = new URLSearchParams({ ...paramsNext, clientVersion: "2.1" }).toString();
+        const nextRequest = await fetch(urlNext.href, {
+            headers: this.service.authStore.getHeaders()
+        });
+        const nextJson = await nextRequest.json()as iCloudContactsContactsResponse;
+
+        return nextJson.contacts;
+    }
+}

test/contacts.js

@@ -0,0 +1,11 @@
+const authenticate = require("./authenticate");
+
+authenticate.then(async(icloud) => {
+    const contactsService = icloud.getService("contacts");
+    const contacts = await contactsService.contacts();
+
+    console.log(`You have ${contacts.length} contacts`);
+    const firstContact = contacts[0];
+    console.log(`Let's get first your contact detail: ${firstContact.lastName}`);
+    console.log(JSON.stringify(firstContact, null, 4));
+});