mirror of
https://github.com/kennethnym/aris.git
synced 2026-03-20 17:11:17 +00:00
kenneth
851e6af951
Add @aris/source-caldav package that fetches calendar events from any CalDAV server via tsdav + ical.js. - Supports Basic auth and OAuth via explicit authMethod discriminant - serverUrl provided at construction time, not hardcoded - Optional timeZone for correct local day boundaries - Credentials cleared from memory after client login - Failed calendar fetches logged, not silently dropped - Login promise cached with retry on failure Co-authored-by: Ona <no-reply@ona.com>
59 lines
1.6 KiB
Markdown
59 lines
1.6 KiB
Markdown
# @aris/source-caldav
|
|
|
|
A FeedSource that fetches calendar events from any CalDAV server.
|
|
|
|
## Usage
|
|
|
|
```ts
|
|
import { CalDavSource } from "@aris/source-caldav"
|
|
|
|
// Basic auth (Nextcloud, Radicale, Baikal, iCloud, etc.)
|
|
const source = new CalDavSource({
|
|
serverUrl: "https://caldav.example.com",
|
|
authMethod: "basic",
|
|
username: "user",
|
|
password: "pass",
|
|
lookAheadDays: 7, // optional, default: 0 (today only)
|
|
timeZone: "America/New_York", // optional, default: UTC
|
|
})
|
|
|
|
// OAuth
|
|
const source = new CalDavSource({
|
|
serverUrl: "https://caldav.provider.com",
|
|
authMethod: "oauth",
|
|
accessToken: "...",
|
|
refreshToken: "...",
|
|
tokenUrl: "https://provider.com/oauth/token",
|
|
})
|
|
```
|
|
|
|
### iCloud
|
|
|
|
Use your Apple ID email as the username and an [app-specific password](https://support.apple.com/en-us/102654):
|
|
|
|
```ts
|
|
const source = new CalDavSource({
|
|
serverUrl: "https://caldav.icloud.com",
|
|
authMethod: "basic",
|
|
username: "you@icloud.com",
|
|
password: "<app-specific-password>",
|
|
})
|
|
```
|
|
|
|
## Testing
|
|
|
|
```bash
|
|
bun test
|
|
```
|
|
|
|
### Live test
|
|
|
|
`bun run test:live` connects to a real CalDAV server and prints all events to the console. It prompts for:
|
|
|
|
- **CalDAV server URL** — e.g. `https://caldav.icloud.com`
|
|
- **Username** — your account email
|
|
- **Password** — your password (or app-specific password for iCloud)
|
|
- **Look-ahead days** — how many days beyond today to fetch (default: 0)
|
|
|
|
The script runs both `fetchContext` and `fetchItems`, printing the calendar context (in-progress events, next event, today's count) followed by each event with its title, time, location, signals, and attendees.
|