Nocal

A lightweight nodejs calendar library.

Features

• Create, read, update, and delete calendar events
• SQLite database persistence
• ICS (iCalendar) export and import
• RESTful API server
• Basic and Bearer authentication support

Installation

npm install nocal

Usage

const nocal = require('nocal');

const cal = nocal.load('./calendar.db');

// Create an event
const eventId = await cal.createEvent({
  title: 'My Event',
  description: 'Description',
  startDate: '2023-10-01T10:00:00Z',
  endDate: '2023-10-01T11:00:00Z',
  rrule: 'FREQ=WEEKLY;BYDAY=MO'
});

// List events
const events = await cal.listEvents();

// Start API server - various ways
const server1 = await cal.start(3000); // port only
const server2 = await cal.start(3000, 'localhost'); // port and host
const server3 = await cal.start(3000, () => console.log('Started')); // with callback
const server4 = await cal.start({ port: 3000, host: 'localhost', auth: { type: 'basic', username: 'user', password: 'pass' } }); // options object

API

Methods

• load(dbPath): Load or create a calendar database
• createEvent(eventData): Create a new event
• listEvents(): Get all events
• updateEvent(id, updates): Update an event
• removeEvent(id): Delete an event
• exportIcs(): Export events as ICS
• importIcs(icsContent): Import events from ICS
• start(port, callback): Start REST API server

API Endpoints

• GET /events: List all events
• POST /events: Create a new event
• PUT /events/:id: Update an event
• DELETE /events/:id: Delete an event
• GET /export: Export as ICS

License

MIT