tsdav

webdav request made easy

Features

• Easy to use, well documented JSON based WEBDAV API
• Works in both Browsers and Node.js
• OAuth2 & Basic Auth helpers built-in
• Native typescript, fully linted and well tested
• Supports WEBDAV, CALDAV, CARDDAV
• End to end tested with Apple & Google Cloud.

Install

npm install tsdav

or

yarn add tsdav

Quickstart

Google CALDAV

import { createDAVClient } from 'tsdav';

(async () => {
  const googleClient = await createDAVClient({
    serverUrl: 'https://apidata.googleusercontent.com/caldav/v2/',
    credentials: {
      refreshToken: 'YOUR_REFRESH_TOKEN_WITH_CALDAV_PERMISSION',
    },
    authMethod: 'Oauth',
    defaultAccountType: 'caldav',
  });

  const calendars = await client.fetchCalendars();

  const calendarObjects = await client.fetchCalendarObjects({
    calendar: calendars[0],
  });
})();

Apple CARDDAV

import { createDAVClient } from 'tsdav';

(async () => {
  const client = await createDAVClient({
    serverUrl: 'https://contacts.icloud.com',
    credentials: {
      username: 'YOUR_APPLE_ID',
      password: 'YOUR_APP_SPECIFIC_PASSWORD',
    },
    authMethod: 'Basic',
    defaultAccountType: 'carddav',
  });

  const addressBooks = await client.fetchAddressBooks();

  const vcards = await client.fetchVCards({
    addressBook: addressBooks[0],
  });
})();

Documentation

Check out the Documentation

License

MIT

RELEASE NOTES

v1.0.5

Fixed a bug where timeRange filter sometimes might be in the wrong format.

v1.0.3

Fixed a bug where calendar objects with http in its id would cause operations on it to fail.