smartCollectionSync

smartCollectionSync and smartCollectionSyncDetailed

smart version of collection sync that combines ctag based sync with webdav sync.

const { created, updated, deleted } = (
  await smartCollectionSyncDetailed({
    collection: {
      url: 'https://caldav.icloud.com/12345676/calendars/c623f6be-a2d4-4c60-932a-043e67025dde/',
      ctag: 'eWd9Vz8OwS0DE==',
      syncToken: 'eWdLSfo8439Vz8OwS0DE==',
      objects: [
        {
          etag: '"63758758580"',
          id: '0003ffbe-cb71-49f5-bc7b-9fafdd756784',
          data: 'BEGIN:VCALENDAR\nVERSION:2.0\nPRODID:-//ZContent.net//Zap Calendar 1.0//EN\nCALSCALE:GREGORIAN\nMETHOD:PUBLISH\nBEGIN:VEVENT\nSUMMARY:Abraham Lincoln\nUID:c7614cff-3549-4a00-9152-d25cc1fe077d\nSEQUENCE:0\nSTATUS:CONFIRMED\nTRANSP:TRANSPARENT\nRRULE:FREQ=YEARLY;INTERVAL=1;BYMONTH=2;BYMONTHDAY=12\nDTSTART:20080212\nDTEND:20080213\nDTSTAMP:20150421T141403\nCATEGORIES:U.S. Presidents,Civil War People\nLOCATION:Hodgenville, Kentucky\nGEO:37.5739497;-85.7399606\nDESCRIPTION:Born February 12, 1809\nSixteenth President (1861-1865)\n\n\n\n \nhttp://AmericanHistoryCalendar.com\nURL:http://americanhistorycalendar.com/peoplecalendar/1,328-abraham-lincol\n n\nEND:VEVENT\nEND:VCALENDAR',
          url: 'https://caldav.icloud.com/123456/calendars/A5639426-B73B-4F90-86AB-D70F7F603E75/test.ics',
        },
      ],
      objectMultiGet: calendarMultiGet,
    },
    method: 'webdav',
    account: {
      accountType: 'caldav',
      homeUrl: 'https://caldav.icloud.com/123456/calendars/',
    },
    headers: {
      authorization: 'Basic x0C9ueWd9Vz8OwS0DEAtkAlj',
    },
  })
).objects;

Arguments

• collection required, the target collection to sync
• collection.objectMultiGet required when WebDAV sync reports created or updated objects
• collection.fetchObjects required when basic sync detects a changed collection
• method defaults to auto detect, one of basic and webdav
• account DAVAccount to sync
• detailedResult deprecated, use smartCollectionSyncDetailed for the detailed result instead.
• headers request headers
• headersToExclude array of keys of the headers you want to exclude
• fetchOptions options to pass to underlying fetch function
• fetch custom fetch implementation

info

objects inside collection are not needed when using smartCollectionSyncDetailed.

Return Value

smartCollectionSync returns:

array of latest DAVObject

smartCollectionSyncDetailed returns:

an object of

• objects
  • created array of DAVObject
  • updated array of DAVObject
  • deleted array of DAVObject

Behavior

detect if collection support sync-collection REPORT

if they supports, use rfc6578 webdav sync to detect if collection changed,

else use ctag to detect if collection changed.

if collection changed, fetch the latest list of DAVObject from remote,

compare the provided list and the latest list to find out created, updated, and deleted objects.

The sync rejects with a clear error if the callback required by the selected method is missing. This prevents advancing a sync token or treating all local objects as deleted without first retrieving the remote changes.

When using smartCollectionSync,

fetch the latest list of DAVObject from changed collection using rfc6578 webdav sync and objectMultiGet

When using smartCollectionSyncDetailed,

return three list of separate objects for created, updated, and deleted