simple-caldav

caldav in JavaScript; made easy.

Note on Completeness

The caldav and ICS specifications are large. Additionally, I'm not sure I ever want to implement them completely. But I saw the need to a simple module that works with e.g. radicale and provides decent developer experience. simple-caldav is that attempt.

Installation

$ npm i --save simple-caldav

Usage

For now, see tests.

Notes

We translate a VEVENT's STATUS in the whole library to the name _status to make sure we're not violating any reserved words rules of JavaScript.

Contributing

$ git clone git@github.com:TimDaub/simple-caldav.git
$ cd simple-caldav && npm i
$ npm run test

Changelog

0.3.5

Bug fix: When adding multiple alarms, ,BEGIN:VALARM would show up in VEVENT text

0.3.4

Bug fix: When adding a status to an event, in its ical representation status statement didn't add new \n new line instruction.

0.3.3

Add static SimpleCalDAV.extractUid(href) method.

0.3.2

Add _status property to event.

0.3.1

Bug fix: syncCollection wasn't able to detect a single VEVENT deletion event and simply returned an empty array.

0.3.0

Bug fix: Stop attempting to parse relative-time VALARMS, as ical.js isn't capable of doing that either. Relative-time VALARMS are now ignored instead. Previously they threw.

0.2.2

Bug fix: Ensure correct order of etag and href properties returned from syncCollection

0.2.1

Introduce new method for retrieving single events with uid: getEvent(uid)
Parse and include VALARMs in getEvent and listEvents

0.2.0

Removed TraversalError from code base entirely
listEvents now returns an empty array when no events are found or an invalid xml gets passed
Instead of throwing TraversalError, SimpleCalDAV.traverseXML now returns an empty array when path couldn't be found
Added getSyncToken method to retrieve a sync token from a server
Added syncCollection to receive a diff of an entire collection with a sync token
Added ServerError that is thrown when there are problems with the server

0.1.3

Fix bug in VALARM construction

0.1.2

Fix bug in VEVENT construction

0.1.1

Allow adding VALARMS to VEVENTS

0.1.0

Transform ical.js events to simple JSON objects and all customizable transformation parameter on listEvents method

0.0.1

Initial release

License

[WIP]

References

About

caldav in JavaScript; made easy.

Languages

Language:JavaScript 100.0%