tsdav

webdav request made easy

Features

• Easy to use, well documented JSON based WEBDAV API
• Works in both Browsers and Node.js
• Supports Both commonjs and esm
• 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 client = 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],
  });
})();

After v1.1.0, you have a new way of creating clients.

Google CALDAV

import { DAVClient } from 'tsdav';

const client = new DAVClient({
  serverUrl: 'https://apidata.googleusercontent.com/caldav/v2/',
  credentials: {
    refreshToken: 'YOUR_REFRESH_TOKEN_WITH_CALDAV_PERMISSION',
  },
  authMethod: 'Oauth',
  defaultAccountType: 'caldav',
});

(async () => {
  await googleClient.login();

  const calendars = await client.fetchCalendars();

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

Apple CARDDAV

import { DAVClient } from 'tsdav';

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

(async () => {
  await client.login();

  const addressBooks = await client.fetchAddressBooks();

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

Documentation

Check out the Documentation

License

MIT

Changelog

refers to Changelog

Debugging

this package uses debug package, add tsdav:* to DEBUG env variable to enable debug logs

Changelog

v1.1.0

breaking changes

• DAVClient is no longer a type returned by createDAVClient, instead it's a class that can be instantiated.
• timeRange in fetchCalendarObjects is now validated against ISO_8601 standard and invalid format will throw an error.
• typescript target changed to es2015, if you are on node >= 10 and browsers that are not IE and have been updated since 2015, you should be fine. support for es5 output is not possible with added esm support.

features

• added a new way to create DAVClient by new DAVClient(...params).
• added support for esm.

improvements

• typescript checks are now with strict enabled, which means better types and less bugs.
• added more exports, now all internal functions are exported.
• multiple documentation improvements.