Auto backup before evolver run - 2026年 03月 06日 星期五 19:00:05 CST
This commit is contained in:
@@ -0,0 +1,12 @@
|
||||
{
|
||||
"reminder_file": "~/work/zq/20.领域/23-生活管理/提醒.md",
|
||||
"inbox_file": "~/work/zq/00.收件箱/01-速记本.md",
|
||||
"caldav_url": "https://micecola.top:5001/caldav/zhangqing/home/",
|
||||
"caldav_user": "zhangqing",
|
||||
"caldav_password": "MiceCola1265",
|
||||
"advance_days": [7, 3, 0],
|
||||
"log_file": "~/.openclaw/cron/scripts/calendar-reminder.log",
|
||||
"rclone_source": "nas-webdav:/home/Drive/工作区/张青/工作区/",
|
||||
"rclone_target": "~/work/zq/",
|
||||
"rclone_exclude": ".git/"
|
||||
}
|
||||
@@ -0,0 +1,549 @@
|
||||
#!/usr/bin/env node
|
||||
/**
|
||||
* 日历提醒系统 - Node.js 版本
|
||||
* 从备忘文件同步提醒事项到 CalDAV 日历
|
||||
*/
|
||||
|
||||
import fs from 'fs';
|
||||
import path from 'path';
|
||||
import { execSync } from 'child_process';
|
||||
import ICAL from 'ical.js';
|
||||
import https from 'https';
|
||||
|
||||
// 配置
|
||||
const CONFIG_FILE = path.join(process.env.HOME, '.openclaw/cron/scripts/calendar-reminder-config.json');
|
||||
|
||||
// 日志
|
||||
function log(level, message) {
|
||||
const timestamp = new Date().toISOString().replace('T', ' ').slice(0, 19);
|
||||
console.log(`${timestamp} - ${level} - ${message}`);
|
||||
}
|
||||
|
||||
// 加载配置
|
||||
function loadConfig() {
|
||||
const configPath = CONFIG_FILE.replace('~', process.env.HOME);
|
||||
return JSON.parse(fs.readFileSync(configPath, 'utf-8'));
|
||||
}
|
||||
|
||||
// 解析提醒文件
|
||||
function parseReminderFile(filePath) {
|
||||
const fullPath = filePath.replace('~', process.env.HOME);
|
||||
if (!fs.existsSync(fullPath)) {
|
||||
log('WARNING', `提醒文件不存在: ${filePath}`);
|
||||
return { periodic: [], single: [] };
|
||||
}
|
||||
|
||||
const content = fs.readFileSync(fullPath, 'utf-8');
|
||||
return parseReminders(content);
|
||||
}
|
||||
|
||||
function parseReminders(content) {
|
||||
const result = { periodic: [], single: [] };
|
||||
const lines = content.split('\n');
|
||||
let currentSection = null;
|
||||
|
||||
for (const line of lines) {
|
||||
const trimmed = line.trim();
|
||||
|
||||
if (trimmed.includes('# 周期性提醒')) {
|
||||
currentSection = 'periodic';
|
||||
continue;
|
||||
} else if (trimmed.includes('# 单次提醒')) {
|
||||
currentSection = 'single';
|
||||
continue;
|
||||
}
|
||||
|
||||
if (trimmed.startsWith('- [ ]')) {
|
||||
const item = trimmed.slice(5).trim();
|
||||
|
||||
if (currentSection === 'periodic') {
|
||||
const parsed = parsePeriodicItem(item);
|
||||
if (parsed) result.periodic.push(parsed);
|
||||
} else if (currentSection === 'single') {
|
||||
const parsed = parseSingleItem(item);
|
||||
if (parsed) result.single.push(parsed);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
function parsePeriodicItem(item) {
|
||||
// 每3年02-01:内容(下次:2027-02-01)
|
||||
let match = item.match(/每(\d+)年(\d{1,2})月(\d{1,2})日[::]\s*(.+?)(?:\s*(下次[::]\s*(\d{4})-(\d{1,2})-(\d{1,2})))?$/);
|
||||
if (match) {
|
||||
const result = {
|
||||
type: 'yearly_n',
|
||||
interval: parseInt(match[1]),
|
||||
month: parseInt(match[2]),
|
||||
day: parseInt(match[3]),
|
||||
content: match[4].trim()
|
||||
};
|
||||
if (match[5]) {
|
||||
result.nextYear = parseInt(match[5]);
|
||||
result.nextMonth = parseInt(match[6]);
|
||||
result.nextDay = parseInt(match[7]);
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
// 每年2月1日 或 每年02-01
|
||||
match = item.match(/每年(\d{1,2})月(\d{1,2})日[::]\s*(.+)$/);
|
||||
if (match) {
|
||||
return { type: 'yearly', month: parseInt(match[1]), day: parseInt(match[2]), content: match[3].trim() };
|
||||
}
|
||||
match = item.match(/每年(\d{1,2})-(\d{1,2})[::]\s*(.+)$/);
|
||||
if (match) {
|
||||
return { type: 'yearly', month: parseInt(match[1]), day: parseInt(match[2]), content: match[3].trim() };
|
||||
}
|
||||
|
||||
// 每半年 2月1日/8月1日 或 02-01/08-01
|
||||
match = item.match(/每半年(\d{1,2})月(\d{1,2})日\/(\d{1,2})月(\d{1,2})日[::]\s*(.+)$/);
|
||||
if (match) {
|
||||
return {
|
||||
type: 'half_yearly',
|
||||
dates: [
|
||||
{ month: parseInt(match[1]), day: parseInt(match[2]) },
|
||||
{ month: parseInt(match[3]), day: parseInt(match[4]) }
|
||||
],
|
||||
content: match[5].trim()
|
||||
};
|
||||
}
|
||||
match = item.match(/每半年(\d{1,2})-(\d{1,2})\/(\d{1,2})-(\d{1,2})[::]\s*(.+)$/);
|
||||
if (match) {
|
||||
return {
|
||||
type: 'half_yearly',
|
||||
dates: [
|
||||
{ month: parseInt(match[1]), day: parseInt(match[2]) },
|
||||
{ month: parseInt(match[3]), day: parseInt(match[4]) }
|
||||
],
|
||||
content: match[5].trim()
|
||||
};
|
||||
}
|
||||
|
||||
// 每年(双日期,实际上是每半年)
|
||||
match = item.match(/每年(\d{1,2})月(\d{1,2})日\/(\d{1,2})月(\d{1,2})日[::]\s*(.+)$/);
|
||||
if (match) {
|
||||
return {
|
||||
type: 'half_yearly',
|
||||
dates: [
|
||||
{ month: parseInt(match[1]), day: parseInt(match[2]) },
|
||||
{ month: parseInt(match[3]), day: parseInt(match[4]) }
|
||||
],
|
||||
content: match[5].trim()
|
||||
};
|
||||
}
|
||||
|
||||
// 每月
|
||||
match = item.match(/每月(\d{1,2})日?[::]\s*(.+)$/);
|
||||
if (match) {
|
||||
return { type: 'monthly', day: parseInt(match[1]), content: match[2].trim() };
|
||||
}
|
||||
|
||||
// 每周
|
||||
const dayMap = { '一': 1, '二': 2, '三': 3, '四': 4, '五': 5, '六': 6, '日': 7 };
|
||||
match = item.match(/每周([一二三四五六日]|[1-7])[::]\s*(.+)$/);
|
||||
if (match) {
|
||||
const weekday = dayMap[match[1]] || parseInt(match[1]);
|
||||
return { type: 'weekly', weekday, content: match[2].trim() };
|
||||
}
|
||||
|
||||
log('WARNING', `无法解析周期性提醒: ${item}`);
|
||||
return null;
|
||||
}
|
||||
|
||||
function parseSingleItem(item) {
|
||||
const match = item.match(/(\d{4})-(\d{1,2})-(\d{1,2})[::]\s*(.+)$/);
|
||||
if (match) {
|
||||
return {
|
||||
type: 'single',
|
||||
year: parseInt(match[1]),
|
||||
month: parseInt(match[2]),
|
||||
day: parseInt(match[3]),
|
||||
content: match[4].trim()
|
||||
};
|
||||
}
|
||||
log('WARNING', `无法解析单次提醒: ${item}`);
|
||||
return null;
|
||||
}
|
||||
|
||||
// 计算下次提醒时间
|
||||
function getNextOccurrence(reminder, today = new Date()) {
|
||||
const results = [];
|
||||
|
||||
switch (reminder.type) {
|
||||
case 'yearly':
|
||||
results.push(nextYearly(reminder.month, reminder.day, today));
|
||||
break;
|
||||
case 'yearly_n':
|
||||
results.push(nextYearlyN(reminder, today));
|
||||
break;
|
||||
case 'half_yearly':
|
||||
for (const d of reminder.dates) {
|
||||
results.push(nextYearly(d.month, d.day, today));
|
||||
}
|
||||
break;
|
||||
case 'monthly':
|
||||
results.push(nextMonthly(reminder.day, today));
|
||||
break;
|
||||
case 'weekly':
|
||||
results.push(nextWeekly(reminder.weekday, today));
|
||||
break;
|
||||
case 'single':
|
||||
results.push(new Date(reminder.year, reminder.month - 1, reminder.day));
|
||||
break;
|
||||
}
|
||||
|
||||
return results.filter(d => d !== null);
|
||||
}
|
||||
|
||||
function nextYearly(month, day, today) {
|
||||
try {
|
||||
const date = new Date(today.getFullYear(), month - 1, day);
|
||||
if (date < today) {
|
||||
return new Date(today.getFullYear() + 1, month - 1, day);
|
||||
}
|
||||
return date;
|
||||
} catch (e) {
|
||||
log('ERROR', `无效日期: ${month}月${day}日`);
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
function nextYearlyN(reminder, today) {
|
||||
if (reminder.nextYear) {
|
||||
const date = new Date(reminder.nextYear, reminder.nextMonth - 1, reminder.nextDay);
|
||||
if (date >= today) return date;
|
||||
}
|
||||
|
||||
try {
|
||||
const date = new Date(today.getFullYear(), reminder.month - 1, reminder.day);
|
||||
if (date < today) {
|
||||
return new Date(today.getFullYear() + reminder.interval, reminder.month - 1, reminder.day);
|
||||
}
|
||||
return date;
|
||||
} catch (e) {
|
||||
log('ERROR', `无效日期: ${reminder.month}月${reminder.day}日`);
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
function nextMonthly(day, today) {
|
||||
const year = today.getFullYear();
|
||||
const month = today.getMonth();
|
||||
|
||||
const lastDayOfMonth = new Date(year, month + 1, 0).getDate();
|
||||
const actualDay = Math.min(day, lastDayOfMonth);
|
||||
|
||||
let date = new Date(year, month, actualDay);
|
||||
if (date < today) {
|
||||
const nextMonth = month === 11 ? 0 : month + 1;
|
||||
const nextYear = month === 11 ? year + 1 : year;
|
||||
const lastDayOfNextMonth = new Date(nextYear, nextMonth + 1, 0).getDate();
|
||||
date = new Date(nextYear, nextMonth, Math.min(day, lastDayOfNextMonth));
|
||||
}
|
||||
return date;
|
||||
}
|
||||
|
||||
function nextWeekly(weekday, today) {
|
||||
// weekday: 1=周一, 7=周日
|
||||
const jsWeekday = weekday - 1; // JS: 0=周一, 6=周日
|
||||
const currentDay = today.getDay();
|
||||
const currentJsDay = currentDay === 0 ? 6 : currentDay - 1;
|
||||
|
||||
let daysAhead = jsWeekday - currentJsDay;
|
||||
if (daysAhead <= 0) daysAhead += 7;
|
||||
|
||||
const nextDate = new Date(today);
|
||||
nextDate.setDate(today.getDate() + daysAhead);
|
||||
return nextDate;
|
||||
}
|
||||
|
||||
// CalDAV 操作
|
||||
class CalDAVClient {
|
||||
constructor(url, user, password) {
|
||||
this.url = url;
|
||||
this.user = user;
|
||||
this.password = password;
|
||||
this.existingEvents = new Set(); // 存储已有事件的标识
|
||||
}
|
||||
|
||||
async connect() {
|
||||
try {
|
||||
// 获取日历事件列表
|
||||
const response = await this.request('REPORT', `<?xml version="1.0" encoding="utf-8"?>
|
||||
<c:calendar-query xmlns:c="urn:ietf:params:xml:ns:caldav">
|
||||
<d:prop xmlns:d="DAV:">
|
||||
<d:getetag />
|
||||
<c:calendar-data />
|
||||
</d:prop>
|
||||
<c:filter>
|
||||
<c:comp-filter name="VCALENDAR">
|
||||
<c:comp-filter name="VEVENT" />
|
||||
</c:comp-filter>
|
||||
</c:filter>
|
||||
</c:calendar-query>`);
|
||||
|
||||
// 解析已有事件
|
||||
this.parseExistingEvents(response);
|
||||
log('INFO', `成功连接到 CalDAV 日历,已有 ${this.existingEvents.size} 个事件`);
|
||||
return true;
|
||||
} catch (e) {
|
||||
log('ERROR', `连接 CalDAV 失败: ${e.message}`);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
parseExistingEvents(xmlResponse) {
|
||||
// 从 XML 响应中提取 VEVENT 并解析
|
||||
const vevents = xmlResponse.match(/BEGIN:VEVENT[\s\S]*?END:VEVENT/gi) || [];
|
||||
|
||||
for (const vevent of vevents) {
|
||||
// 提取 SUMMARY 和 DTSTART
|
||||
const summaryMatch = vevent.match(/SUMMARY[^:]*:(.+)/i);
|
||||
const dtstartMatch = vevent.match(/DTSTART[^:]*:([0-9T]+)/i);
|
||||
|
||||
if (summaryMatch && dtstartMatch) {
|
||||
let summary = summaryMatch[1].trim();
|
||||
// 移除可能的换行和特殊字符
|
||||
summary = summary.replace(/\\n/g, ' ').replace(/\r?\n/g, ' ').trim();
|
||||
|
||||
const dateStr = dtstartMatch[1].slice(0, 8); // YYYYMMDD
|
||||
// 用 summary + date 作为唯一标识
|
||||
const key = `${summary}|${dateStr}`;
|
||||
this.existingEvents.add(key);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
async request(method, body) {
|
||||
return new Promise((resolve, reject) => {
|
||||
const url = new URL(this.url);
|
||||
|
||||
const options = {
|
||||
hostname: url.hostname,
|
||||
port: url.port || 443,
|
||||
path: url.pathname,
|
||||
method: method || 'GET',
|
||||
headers: {
|
||||
'Authorization': 'Basic ' + Buffer.from(`${this.user}:${this.password}`).toString('base64'),
|
||||
'Content-Type': 'application/xml; charset=utf-8',
|
||||
'Depth': '1'
|
||||
},
|
||||
rejectUnauthorized: false // 禁用 SSL 验证
|
||||
};
|
||||
|
||||
const req = https.request(options, (res) => {
|
||||
let data = '';
|
||||
res.on('data', chunk => data += chunk);
|
||||
res.on('end', () => {
|
||||
if (res.statusCode >= 200 && res.statusCode < 300) {
|
||||
resolve(data);
|
||||
} else {
|
||||
reject(new Error(`HTTP ${res.statusCode}: ${data}`));
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
req.on('error', reject);
|
||||
if (body) req.write(body);
|
||||
req.end();
|
||||
});
|
||||
}
|
||||
|
||||
eventExists(content, reminderTime) {
|
||||
// 使用本地时间格式化日期,避免时区问题
|
||||
const year = reminderTime.getFullYear();
|
||||
const month = String(reminderTime.getMonth() + 1).padStart(2, '0');
|
||||
const day = String(reminderTime.getDate()).padStart(2, '0');
|
||||
const dateStr = `${year}${month}${day}`; // YYYYMMDD
|
||||
|
||||
const key = `${content}|${dateStr}`;
|
||||
return this.existingEvents.has(key);
|
||||
}
|
||||
|
||||
async createEvent(reminderTime, content, alarmMinutes = 0) {
|
||||
try {
|
||||
const vcalendar = new ICAL.Component(['vcalendar', [], []]);
|
||||
vcalendar.addPropertyWithValue('prodid', '-//Calendar Reminder//EN');
|
||||
vcalendar.addPropertyWithValue('version', '2.0');
|
||||
|
||||
const vevent = new ICAL.Component('vevent');
|
||||
const uid = `${Date.now()}-${Math.random().toString(36).slice(2)}@calendar-reminder`;
|
||||
|
||||
vevent.addPropertyWithValue('uid', uid);
|
||||
vevent.addPropertyWithValue('dtstart', ICAL.Time.fromJSDate(reminderTime, false));
|
||||
vevent.addPropertyWithValue('dtend', ICAL.Time.fromJSDate(new Date(reminderTime.getTime() + 3600000), false));
|
||||
vevent.addPropertyWithValue('summary', content);
|
||||
vevent.addPropertyWithValue('dtstamp', ICAL.Time.now());
|
||||
|
||||
// 添加提醒
|
||||
const valarm = new ICAL.Component('valarm');
|
||||
valarm.addPropertyWithValue('action', 'DISPLAY');
|
||||
valarm.addPropertyWithValue('description', content);
|
||||
valarm.addPropertyWithValue('trigger', ICAL.Duration.fromSeconds(-alarmMinutes * 60));
|
||||
vevent.addSubcomponent(valarm);
|
||||
|
||||
vcalendar.addSubcomponent(vevent);
|
||||
|
||||
const icalData = vcalendar.toString();
|
||||
|
||||
// 使用 PUT 创建事件
|
||||
const eventUrl = new URL(this.url);
|
||||
eventUrl.pathname = eventUrl.pathname.replace(/\/$/, '') + '/' + uid + '.ics';
|
||||
|
||||
await this.putEvent(eventUrl.toString(), icalData);
|
||||
log('INFO', `创建事件: ${content} @ ${reminderTime.toISOString().slice(0, 10)}`);
|
||||
return true;
|
||||
} catch (e) {
|
||||
log('ERROR', `创建事件失败: ${e.message}`);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
async putEvent(url, icalData) {
|
||||
return new Promise((resolve, reject) => {
|
||||
const urlObj = new URL(url);
|
||||
|
||||
const options = {
|
||||
hostname: urlObj.hostname,
|
||||
port: urlObj.port || 443,
|
||||
path: urlObj.pathname,
|
||||
method: 'PUT',
|
||||
headers: {
|
||||
'Authorization': 'Basic ' + Buffer.from(`${this.user}:${this.password}`).toString('base64'),
|
||||
'Content-Type': 'text/calendar; charset=utf-8',
|
||||
'Content-Length': Buffer.byteLength(icalData)
|
||||
},
|
||||
rejectUnauthorized: false
|
||||
};
|
||||
|
||||
const req = https.request(options, (res) => {
|
||||
let data = '';
|
||||
res.on('data', chunk => data += chunk);
|
||||
res.on('end', () => {
|
||||
if (res.statusCode >= 200 && res.statusCode < 300) {
|
||||
resolve(data);
|
||||
} else {
|
||||
reject(new Error(`HTTP ${res.statusCode}: ${data}`));
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
req.on('error', reject);
|
||||
req.write(icalData);
|
||||
req.end();
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
// NAS 同步
|
||||
function syncFromNAS(source, target, exclude) {
|
||||
try {
|
||||
const cmd = `rclone sync "${source}" "${target.replace('~', process.env.HOME)}" --exclude "${exclude}"`;
|
||||
log('INFO', `从 NAS 同步: ${cmd}`);
|
||||
execSync(cmd, { stdio: 'pipe', timeout: 300000 });
|
||||
log('INFO', '从 NAS 同步成功');
|
||||
return true;
|
||||
} catch (e) {
|
||||
log('ERROR', `从 NAS 同步失败: ${e.message}`);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
function syncToNAS(source, target, exclude) {
|
||||
try {
|
||||
const cmd = `rclone sync "${source.replace('~', process.env.HOME)}" "${target}" --exclude "${exclude}"`;
|
||||
log('INFO', `同步到 NAS: ${cmd}`);
|
||||
execSync(cmd, { stdio: 'pipe', timeout: 300000 });
|
||||
log('INFO', '同步到 NAS 成功');
|
||||
return true;
|
||||
} catch (e) {
|
||||
log('ERROR', `同步到 NAS 失败: ${e.message}`);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
// 主函数
|
||||
async function main() {
|
||||
log('INFO', '============================================================');
|
||||
log('INFO', '日历提醒系统启动 (Node.js)');
|
||||
log('INFO', '============================================================');
|
||||
|
||||
const config = loadConfig();
|
||||
const today = new Date();
|
||||
today.setHours(0, 0, 0, 0);
|
||||
|
||||
// 1. 从 NAS 同步
|
||||
if (config.rclone_source) {
|
||||
syncFromNAS(config.rclone_source, config.rclone_target, config.rclone_exclude);
|
||||
}
|
||||
|
||||
// 2. 解析提醒文件
|
||||
const reminders = parseReminderFile(config.reminder_file);
|
||||
log('INFO', `解析到 ${reminders.periodic.length} 个周期性提醒`);
|
||||
log('INFO', `解析到 ${reminders.single.length} 个单次提醒`);
|
||||
|
||||
// 3. 连接 CalDAV
|
||||
const caldav = new CalDAVClient(config.caldav_url, config.caldav_user, config.caldav_password);
|
||||
if (!await caldav.connect()) {
|
||||
log('ERROR', '无法连接到 CalDAV,请检查配置');
|
||||
return;
|
||||
}
|
||||
|
||||
const advanceDays = config.advance_days || [7, 3, 0];
|
||||
|
||||
// 4. 处理周期性提醒
|
||||
for (const reminder of reminders.periodic) {
|
||||
const nextTimes = getNextOccurrence(reminder, today);
|
||||
|
||||
for (const nextTime of nextTimes) {
|
||||
if (!nextTime) continue;
|
||||
|
||||
const content = reminder.content;
|
||||
|
||||
for (const days of advanceDays) {
|
||||
const reminderTime = new Date(nextTime);
|
||||
reminderTime.setDate(reminderTime.getDate() - days);
|
||||
|
||||
if (reminderTime >= today) {
|
||||
const eventTitle = `[提前${days}天] ${content}`;
|
||||
if (!caldav.eventExists(eventTitle, reminderTime)) {
|
||||
await caldav.createEvent(reminderTime, eventTitle, 0);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// 5. 处理单次提醒
|
||||
for (const reminder of reminders.single) {
|
||||
const reminderDate = new Date(reminder.year, reminder.month - 1, reminder.day);
|
||||
const content = reminder.content;
|
||||
|
||||
for (const days of advanceDays) {
|
||||
const reminderTime = new Date(reminderDate);
|
||||
reminderTime.setDate(reminderTime.getDate() - days);
|
||||
|
||||
if (reminderTime >= today) {
|
||||
const eventTitle = `[提前${days}天] ${content}`;
|
||||
if (!caldav.eventExists(eventTitle, reminderTime)) {
|
||||
await caldav.createEvent(reminderTime, eventTitle, 0);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// 6. 同步回 NAS
|
||||
if (config.rclone_source) {
|
||||
syncToNAS(config.rclone_target, config.rclone_source, config.rclone_exclude);
|
||||
}
|
||||
|
||||
log('INFO', '日历提醒系统完成');
|
||||
}
|
||||
|
||||
main().catch(e => {
|
||||
log('ERROR', `程序异常: ${e.message}`);
|
||||
process.exit(1);
|
||||
});
|
||||
@@ -0,0 +1,138 @@
|
||||
#!/usr/bin/env node
|
||||
/**
|
||||
* 清空 CalDAV 日历事件
|
||||
*/
|
||||
|
||||
import https from 'https';
|
||||
|
||||
const CONFIG = {
|
||||
url: 'https://micecola.top:5001/caldav/zhangqing/home/',
|
||||
user: 'zhangqing',
|
||||
password: 'MiceCola1265'
|
||||
};
|
||||
|
||||
function log(level, message) {
|
||||
const timestamp = new Date().toISOString().replace('T', ' ').slice(0, 19);
|
||||
console.log(`${timestamp} - ${level} - ${message}`);
|
||||
}
|
||||
|
||||
async function request(method, path = '', body = null) {
|
||||
return new Promise((resolve, reject) => {
|
||||
const url = new URL(CONFIG.url + path);
|
||||
|
||||
const options = {
|
||||
hostname: url.hostname,
|
||||
port: url.port || 443,
|
||||
path: url.pathname,
|
||||
method: method,
|
||||
headers: {
|
||||
'Authorization': 'Basic ' + Buffer.from(`${CONFIG.user}:${CONFIG.password}`).toString('base64'),
|
||||
'Content-Type': 'application/xml; charset=utf-8',
|
||||
'Depth': 'infinity'
|
||||
},
|
||||
rejectUnauthorized: false
|
||||
};
|
||||
|
||||
const req = https.request(options, (res) => {
|
||||
let data = '';
|
||||
res.on('data', chunk => data += chunk);
|
||||
res.on('end', () => {
|
||||
if (res.statusCode >= 200 && res.statusCode < 300) {
|
||||
resolve({ status: res.statusCode, data, headers: res.headers });
|
||||
} else {
|
||||
resolve({ status: res.statusCode, data, headers: res.headers });
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
req.on('error', reject);
|
||||
if (body) req.write(body);
|
||||
req.end();
|
||||
});
|
||||
}
|
||||
|
||||
async function getAllEvents() {
|
||||
// 使用 PROPFIND 获取日历内容
|
||||
const response = await request('PROPFIND', '', `<?xml version="1.0" encoding="utf-8"?>
|
||||
<d:propfind xmlns:d="DAV:">
|
||||
<d:prop>
|
||||
<d:resourcetype />
|
||||
<d:getcontenttype />
|
||||
</d:prop>
|
||||
</d:propfind>`);
|
||||
|
||||
// 提取所有 .ics 文件的 href(可能在 <href> 或 <propstat><prop><href> 中)
|
||||
const hrefs = [];
|
||||
|
||||
// 匹配所有 href,排除目录
|
||||
const allHrefs = response.data.match(/<href>([^<]+)<\/href>/gi) || [];
|
||||
for (const match of allHrefs) {
|
||||
const href = match.replace(/<\/?href>/gi, '');
|
||||
// 只保留 .ics 文件,排除目录
|
||||
if (href.endsWith('.ics')) {
|
||||
// 解码 URL 编码
|
||||
const decodedHref = decodeURIComponent(href);
|
||||
if (!hrefs.includes(decodedHref)) {
|
||||
hrefs.push(decodedHref);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return hrefs;
|
||||
}
|
||||
|
||||
async function deleteEvent(href) {
|
||||
return new Promise((resolve, reject) => {
|
||||
// href 是相对路径,需要用完整 URL
|
||||
const baseUrl = new URL(CONFIG.url);
|
||||
const fullPath = href.startsWith('/') ? href : '/' + href;
|
||||
|
||||
const options = {
|
||||
hostname: baseUrl.hostname,
|
||||
port: baseUrl.port || 443,
|
||||
path: fullPath,
|
||||
method: 'DELETE',
|
||||
headers: {
|
||||
'Authorization': 'Basic ' + Buffer.from(`${CONFIG.user}:${CONFIG.password}`).toString('base64')
|
||||
},
|
||||
rejectUnauthorized: false
|
||||
};
|
||||
|
||||
const req = https.request(options, (res) => {
|
||||
let data = '';
|
||||
res.on('data', chunk => data += chunk);
|
||||
res.on('end', () => resolve(res.statusCode));
|
||||
});
|
||||
|
||||
req.on('error', reject);
|
||||
req.end();
|
||||
});
|
||||
}
|
||||
|
||||
async function main() {
|
||||
log('INFO', '获取日历事件列表...');
|
||||
|
||||
const hrefs = await getAllEvents();
|
||||
log('INFO', `找到 ${hrefs.length} 个事件`);
|
||||
|
||||
let deleted = 0;
|
||||
let failed = 0;
|
||||
|
||||
for (const href of hrefs) {
|
||||
const status = await deleteEvent(href);
|
||||
if (status >= 200 && status < 300) {
|
||||
deleted++;
|
||||
log('INFO', `已删除: ${href.split('/').pop()}`);
|
||||
} else {
|
||||
failed++;
|
||||
log('ERROR', `删除失败 (${status}): ${href}`);
|
||||
}
|
||||
}
|
||||
|
||||
log('INFO', `完成: 删除 ${deleted} 个,失败 ${failed} 个`);
|
||||
}
|
||||
|
||||
main().catch(e => {
|
||||
log('ERROR', `程序异常: ${e.message}`);
|
||||
process.exit(1);
|
||||
});
|
||||
+14
@@ -0,0 +1,14 @@
|
||||
{
|
||||
"name": "scripts",
|
||||
"version": "1.0.0",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"node_modules/ical.js": {
|
||||
"version": "2.2.1",
|
||||
"resolved": "https://registry.npmjs.org/ical.js/-/ical.js-2.2.1.tgz",
|
||||
"integrity": "sha512-yK/UlPbEs316igb/tjRgbFA8ZV75rCsBJp/hWOatpyaPNlgw0dGDmU+FoicOcwX4xXkeXOkYiOmCqNPFpNPkQg==",
|
||||
"license": "MPL-2.0"
|
||||
}
|
||||
}
|
||||
}
|
||||
+373
@@ -0,0 +1,373 @@
|
||||
Mozilla Public License Version 2.0
|
||||
==================================
|
||||
|
||||
1. Definitions
|
||||
--------------
|
||||
|
||||
1.1. "Contributor"
|
||||
means each individual or legal entity that creates, contributes to
|
||||
the creation of, or owns Covered Software.
|
||||
|
||||
1.2. "Contributor Version"
|
||||
means the combination of the Contributions of others (if any) used
|
||||
by a Contributor and that particular Contributor's Contribution.
|
||||
|
||||
1.3. "Contribution"
|
||||
means Covered Software of a particular Contributor.
|
||||
|
||||
1.4. "Covered Software"
|
||||
means Source Code Form to which the initial Contributor has attached
|
||||
the notice in Exhibit A, the Executable Form of such Source Code
|
||||
Form, and Modifications of such Source Code Form, in each case
|
||||
including portions thereof.
|
||||
|
||||
1.5. "Incompatible With Secondary Licenses"
|
||||
means
|
||||
|
||||
(a) that the initial Contributor has attached the notice described
|
||||
in Exhibit B to the Covered Software; or
|
||||
|
||||
(b) that the Covered Software was made available under the terms of
|
||||
version 1.1 or earlier of the License, but not also under the
|
||||
terms of a Secondary License.
|
||||
|
||||
1.6. "Executable Form"
|
||||
means any form of the work other than Source Code Form.
|
||||
|
||||
1.7. "Larger Work"
|
||||
means a work that combines Covered Software with other material, in
|
||||
a separate file or files, that is not Covered Software.
|
||||
|
||||
1.8. "License"
|
||||
means this document.
|
||||
|
||||
1.9. "Licensable"
|
||||
means having the right to grant, to the maximum extent possible,
|
||||
whether at the time of the initial grant or subsequently, any and
|
||||
all of the rights conveyed by this License.
|
||||
|
||||
1.10. "Modifications"
|
||||
means any of the following:
|
||||
|
||||
(a) any file in Source Code Form that results from an addition to,
|
||||
deletion from, or modification of the contents of Covered
|
||||
Software; or
|
||||
|
||||
(b) any new file in Source Code Form that contains any Covered
|
||||
Software.
|
||||
|
||||
1.11. "Patent Claims" of a Contributor
|
||||
means any patent claim(s), including without limitation, method,
|
||||
process, and apparatus claims, in any patent Licensable by such
|
||||
Contributor that would be infringed, but for the grant of the
|
||||
License, by the making, using, selling, offering for sale, having
|
||||
made, import, or transfer of either its Contributions or its
|
||||
Contributor Version.
|
||||
|
||||
1.12. "Secondary License"
|
||||
means either the GNU General Public License, Version 2.0, the GNU
|
||||
Lesser General Public License, Version 2.1, the GNU Affero General
|
||||
Public License, Version 3.0, or any later versions of those
|
||||
licenses.
|
||||
|
||||
1.13. "Source Code Form"
|
||||
means the form of the work preferred for making modifications.
|
||||
|
||||
1.14. "You" (or "Your")
|
||||
means an individual or a legal entity exercising rights under this
|
||||
License. For legal entities, "You" includes any entity that
|
||||
controls, is controlled by, or is under common control with You. For
|
||||
purposes of this definition, "control" means (a) the power, direct
|
||||
or indirect, to cause the direction or management of such entity,
|
||||
whether by contract or otherwise, or (b) ownership of more than
|
||||
fifty percent (50%) of the outstanding shares or beneficial
|
||||
ownership of such entity.
|
||||
|
||||
2. License Grants and Conditions
|
||||
--------------------------------
|
||||
|
||||
2.1. Grants
|
||||
|
||||
Each Contributor hereby grants You a world-wide, royalty-free,
|
||||
non-exclusive license:
|
||||
|
||||
(a) under intellectual property rights (other than patent or trademark)
|
||||
Licensable by such Contributor to use, reproduce, make available,
|
||||
modify, display, perform, distribute, and otherwise exploit its
|
||||
Contributions, either on an unmodified basis, with Modifications, or
|
||||
as part of a Larger Work; and
|
||||
|
||||
(b) under Patent Claims of such Contributor to make, use, sell, offer
|
||||
for sale, have made, import, and otherwise transfer either its
|
||||
Contributions or its Contributor Version.
|
||||
|
||||
2.2. Effective Date
|
||||
|
||||
The licenses granted in Section 2.1 with respect to any Contribution
|
||||
become effective for each Contribution on the date the Contributor first
|
||||
distributes such Contribution.
|
||||
|
||||
2.3. Limitations on Grant Scope
|
||||
|
||||
The licenses granted in this Section 2 are the only rights granted under
|
||||
this License. No additional rights or licenses will be implied from the
|
||||
distribution or licensing of Covered Software under this License.
|
||||
Notwithstanding Section 2.1(b) above, no patent license is granted by a
|
||||
Contributor:
|
||||
|
||||
(a) for any code that a Contributor has removed from Covered Software;
|
||||
or
|
||||
|
||||
(b) for infringements caused by: (i) Your and any other third party's
|
||||
modifications of Covered Software, or (ii) the combination of its
|
||||
Contributions with other software (except as part of its Contributor
|
||||
Version); or
|
||||
|
||||
(c) under Patent Claims infringed by Covered Software in the absence of
|
||||
its Contributions.
|
||||
|
||||
This License does not grant any rights in the trademarks, service marks,
|
||||
or logos of any Contributor (except as may be necessary to comply with
|
||||
the notice requirements in Section 3.4).
|
||||
|
||||
2.4. Subsequent Licenses
|
||||
|
||||
No Contributor makes additional grants as a result of Your choice to
|
||||
distribute the Covered Software under a subsequent version of this
|
||||
License (see Section 10.2) or under the terms of a Secondary License (if
|
||||
permitted under the terms of Section 3.3).
|
||||
|
||||
2.5. Representation
|
||||
|
||||
Each Contributor represents that the Contributor believes its
|
||||
Contributions are its original creation(s) or it has sufficient rights
|
||||
to grant the rights to its Contributions conveyed by this License.
|
||||
|
||||
2.6. Fair Use
|
||||
|
||||
This License is not intended to limit any rights You have under
|
||||
applicable copyright doctrines of fair use, fair dealing, or other
|
||||
equivalents.
|
||||
|
||||
2.7. Conditions
|
||||
|
||||
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
|
||||
in Section 2.1.
|
||||
|
||||
3. Responsibilities
|
||||
-------------------
|
||||
|
||||
3.1. Distribution of Source Form
|
||||
|
||||
All distribution of Covered Software in Source Code Form, including any
|
||||
Modifications that You create or to which You contribute, must be under
|
||||
the terms of this License. You must inform recipients that the Source
|
||||
Code Form of the Covered Software is governed by the terms of this
|
||||
License, and how they can obtain a copy of this License. You may not
|
||||
attempt to alter or restrict the recipients' rights in the Source Code
|
||||
Form.
|
||||
|
||||
3.2. Distribution of Executable Form
|
||||
|
||||
If You distribute Covered Software in Executable Form then:
|
||||
|
||||
(a) such Covered Software must also be made available in Source Code
|
||||
Form, as described in Section 3.1, and You must inform recipients of
|
||||
the Executable Form how they can obtain a copy of such Source Code
|
||||
Form by reasonable means in a timely manner, at a charge no more
|
||||
than the cost of distribution to the recipient; and
|
||||
|
||||
(b) You may distribute such Executable Form under the terms of this
|
||||
License, or sublicense it under different terms, provided that the
|
||||
license for the Executable Form does not attempt to limit or alter
|
||||
the recipients' rights in the Source Code Form under this License.
|
||||
|
||||
3.3. Distribution of a Larger Work
|
||||
|
||||
You may create and distribute a Larger Work under terms of Your choice,
|
||||
provided that You also comply with the requirements of this License for
|
||||
the Covered Software. If the Larger Work is a combination of Covered
|
||||
Software with a work governed by one or more Secondary Licenses, and the
|
||||
Covered Software is not Incompatible With Secondary Licenses, this
|
||||
License permits You to additionally distribute such Covered Software
|
||||
under the terms of such Secondary License(s), so that the recipient of
|
||||
the Larger Work may, at their option, further distribute the Covered
|
||||
Software under the terms of either this License or such Secondary
|
||||
License(s).
|
||||
|
||||
3.4. Notices
|
||||
|
||||
You may not remove or alter the substance of any license notices
|
||||
(including copyright notices, patent notices, disclaimers of warranty,
|
||||
or limitations of liability) contained within the Source Code Form of
|
||||
the Covered Software, except that You may alter any license notices to
|
||||
the extent required to remedy known factual inaccuracies.
|
||||
|
||||
3.5. Application of Additional Terms
|
||||
|
||||
You may choose to offer, and to charge a fee for, warranty, support,
|
||||
indemnity or liability obligations to one or more recipients of Covered
|
||||
Software. However, You may do so only on Your own behalf, and not on
|
||||
behalf of any Contributor. You must make it absolutely clear that any
|
||||
such warranty, support, indemnity, or liability obligation is offered by
|
||||
You alone, and You hereby agree to indemnify every Contributor for any
|
||||
liability incurred by such Contributor as a result of warranty, support,
|
||||
indemnity or liability terms You offer. You may include additional
|
||||
disclaimers of warranty and limitations of liability specific to any
|
||||
jurisdiction.
|
||||
|
||||
4. Inability to Comply Due to Statute or Regulation
|
||||
---------------------------------------------------
|
||||
|
||||
If it is impossible for You to comply with any of the terms of this
|
||||
License with respect to some or all of the Covered Software due to
|
||||
statute, judicial order, or regulation then You must: (a) comply with
|
||||
the terms of this License to the maximum extent possible; and (b)
|
||||
describe the limitations and the code they affect. Such description must
|
||||
be placed in a text file included with all distributions of the Covered
|
||||
Software under this License. Except to the extent prohibited by statute
|
||||
or regulation, such description must be sufficiently detailed for a
|
||||
recipient of ordinary skill to be able to understand it.
|
||||
|
||||
5. Termination
|
||||
--------------
|
||||
|
||||
5.1. The rights granted under this License will terminate automatically
|
||||
if You fail to comply with any of its terms. However, if You become
|
||||
compliant, then the rights granted under this License from a particular
|
||||
Contributor are reinstated (a) provisionally, unless and until such
|
||||
Contributor explicitly and finally terminates Your grants, and (b) on an
|
||||
ongoing basis, if such Contributor fails to notify You of the
|
||||
non-compliance by some reasonable means prior to 60 days after You have
|
||||
come back into compliance. Moreover, Your grants from a particular
|
||||
Contributor are reinstated on an ongoing basis if such Contributor
|
||||
notifies You of the non-compliance by some reasonable means, this is the
|
||||
first time You have received notice of non-compliance with this License
|
||||
from such Contributor, and You become compliant prior to 30 days after
|
||||
Your receipt of the notice.
|
||||
|
||||
5.2. If You initiate litigation against any entity by asserting a patent
|
||||
infringement claim (excluding declaratory judgment actions,
|
||||
counter-claims, and cross-claims) alleging that a Contributor Version
|
||||
directly or indirectly infringes any patent, then the rights granted to
|
||||
You by any and all Contributors for the Covered Software under Section
|
||||
2.1 of this License shall terminate.
|
||||
|
||||
5.3. In the event of termination under Sections 5.1 or 5.2 above, all
|
||||
end user license agreements (excluding distributors and resellers) which
|
||||
have been validly granted by You or Your distributors under this License
|
||||
prior to termination shall survive termination.
|
||||
|
||||
************************************************************************
|
||||
* *
|
||||
* 6. Disclaimer of Warranty *
|
||||
* ------------------------- *
|
||||
* *
|
||||
* Covered Software is provided under this License on an "as is" *
|
||||
* basis, without warranty of any kind, either expressed, implied, or *
|
||||
* statutory, including, without limitation, warranties that the *
|
||||
* Covered Software is free of defects, merchantable, fit for a *
|
||||
* particular purpose or non-infringing. The entire risk as to the *
|
||||
* quality and performance of the Covered Software is with You. *
|
||||
* Should any Covered Software prove defective in any respect, You *
|
||||
* (not any Contributor) assume the cost of any necessary servicing, *
|
||||
* repair, or correction. This disclaimer of warranty constitutes an *
|
||||
* essential part of this License. No use of any Covered Software is *
|
||||
* authorized under this License except under this disclaimer. *
|
||||
* *
|
||||
************************************************************************
|
||||
|
||||
************************************************************************
|
||||
* *
|
||||
* 7. Limitation of Liability *
|
||||
* -------------------------- *
|
||||
* *
|
||||
* Under no circumstances and under no legal theory, whether tort *
|
||||
* (including negligence), contract, or otherwise, shall any *
|
||||
* Contributor, or anyone who distributes Covered Software as *
|
||||
* permitted above, be liable to You for any direct, indirect, *
|
||||
* special, incidental, or consequential damages of any character *
|
||||
* including, without limitation, damages for lost profits, loss of *
|
||||
* goodwill, work stoppage, computer failure or malfunction, or any *
|
||||
* and all other commercial damages or losses, even if such party *
|
||||
* shall have been informed of the possibility of such damages. This *
|
||||
* limitation of liability shall not apply to liability for death or *
|
||||
* personal injury resulting from such party's negligence to the *
|
||||
* extent applicable law prohibits such limitation. Some *
|
||||
* jurisdictions do not allow the exclusion or limitation of *
|
||||
* incidental or consequential damages, so this exclusion and *
|
||||
* limitation may not apply to You. *
|
||||
* *
|
||||
************************************************************************
|
||||
|
||||
8. Litigation
|
||||
-------------
|
||||
|
||||
Any litigation relating to this License may be brought only in the
|
||||
courts of a jurisdiction where the defendant maintains its principal
|
||||
place of business and such litigation shall be governed by laws of that
|
||||
jurisdiction, without reference to its conflict-of-law provisions.
|
||||
Nothing in this Section shall prevent a party's ability to bring
|
||||
cross-claims or counter-claims.
|
||||
|
||||
9. Miscellaneous
|
||||
----------------
|
||||
|
||||
This License represents the complete agreement concerning the subject
|
||||
matter hereof. If any provision of this License is held to be
|
||||
unenforceable, such provision shall be reformed only to the extent
|
||||
necessary to make it enforceable. Any law or regulation which provides
|
||||
that the language of a contract shall be construed against the drafter
|
||||
shall not be used to construe this License against a Contributor.
|
||||
|
||||
10. Versions of the License
|
||||
---------------------------
|
||||
|
||||
10.1. New Versions
|
||||
|
||||
Mozilla Foundation is the license steward. Except as provided in Section
|
||||
10.3, no one other than the license steward has the right to modify or
|
||||
publish new versions of this License. Each version will be given a
|
||||
distinguishing version number.
|
||||
|
||||
10.2. Effect of New Versions
|
||||
|
||||
You may distribute the Covered Software under the terms of the version
|
||||
of the License under which You originally received the Covered Software,
|
||||
or under the terms of any subsequent version published by the license
|
||||
steward.
|
||||
|
||||
10.3. Modified Versions
|
||||
|
||||
If you create software not governed by this License, and you want to
|
||||
create a new license for such software, you may create and use a
|
||||
modified version of this License if you rename the license and remove
|
||||
any references to the name of the license steward (except to note that
|
||||
such modified license differs from this License).
|
||||
|
||||
10.4. Distributing Source Code Form that is Incompatible With Secondary
|
||||
Licenses
|
||||
|
||||
If You choose to distribute Source Code Form that is Incompatible With
|
||||
Secondary Licenses under the terms of this version of the License, the
|
||||
notice described in Exhibit B of this License must be attached.
|
||||
|
||||
Exhibit A - Source Code Form License Notice
|
||||
-------------------------------------------
|
||||
|
||||
This Source Code Form is subject to the terms of the Mozilla Public
|
||||
License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
|
||||
If it is not possible or desirable to put the notice in a particular
|
||||
file, then You may include the notice in a location (such as a LICENSE
|
||||
file in a relevant directory) where a recipient would be likely to look
|
||||
for such a notice.
|
||||
|
||||
You may add additional accurate notices of copyright ownership.
|
||||
|
||||
Exhibit B - "Incompatible With Secondary Licenses" Notice
|
||||
---------------------------------------------------------
|
||||
|
||||
This Source Code Form is "Incompatible With Secondary Licenses", as
|
||||
defined by the Mozilla Public License, v. 2.0.
|
||||
+120
@@ -0,0 +1,120 @@
|
||||
# ical.js - Javascript parser for iCalendar, jCal, vCard, jCard.
|
||||
|
||||
This is a library to parse the formats defined in the following rfcs and their extensions:
|
||||
* [rfc 5545](http://tools.ietf.org/html/rfc5545) (iCalendar)
|
||||
* [rfc7265](http://tools.ietf.org/html/rfc7265) (jCal)
|
||||
* [rfc6350](http://tools.ietf.org/html/rfc6350) (vCard)
|
||||
* [rfc7095](http://tools.ietf.org/html/rfc7095) (jCard)
|
||||
|
||||
The initial goal was to use it as a replacement for libical in the [Mozilla Calendar
|
||||
Project](http://www.mozilla.org/projects/calendar/), but the library has been written with the web
|
||||
in mind. This library enables you to do all sorts of cool experiments with calendar data and the
|
||||
web. Most algorithms here were taken from [libical](https://github.com/libical/libical). If you are
|
||||
bugfixing this library, please check if the fix can be upstreamed to libical.
|
||||
|
||||
 [](https://coveralls.io/r/kewisch/ical.js) [](http://badge.fury.io/js/ical.js) [](https://cdnjs.com/libraries/ical.js)
|
||||
|
||||
## Sandbox and Validator
|
||||
|
||||
If you want to try out ICAL.js right now, there is a
|
||||
[jsfiddle](http://jsfiddle.net/kewisch/227efboL/) set up and ready to use.
|
||||
|
||||
The ICAL validator demonstrates how to use the library in a webpage, and helps verify iCalendar and
|
||||
jCal. [Try the validator online](http://kewisch.github.io/ical.js/validator.html)
|
||||
|
||||
The recurrence tester calculates occurrences based on a RRULE. It can be used to aid in
|
||||
creating test cases for the recurrence iterator.
|
||||
[Try the recurrence tester online](https://kewisch.github.io/ical.js/recur-tester.html).
|
||||
|
||||
## Installing
|
||||
|
||||
ICAL.js has no dependencies and is written in modern JavaScript. You can install ICAL.js via
|
||||
[npm](https://www.npmjs.com/), if you would like to use it in Node.js:
|
||||
```bash
|
||||
npm install ical.js
|
||||
```
|
||||
Then simply import it for use:
|
||||
```javascript
|
||||
import ICAL from "ical.js";
|
||||
```
|
||||
|
||||
If you are working with a browser, be aware this is an ES6 module:
|
||||
|
||||
```html
|
||||
<script type="module">
|
||||
import ICAL from "https://unpkg.com/ical.js/dist/ical.min.js";
|
||||
document.querySelector("button").addEventListener("click", () => {
|
||||
ICAL.parse(document.getElementById("txt").value);
|
||||
});
|
||||
</script>
|
||||
```
|
||||
|
||||
If you need to make use of a script tag, you can use the transpiled ES5 version:
|
||||
```html
|
||||
<script src="https://unpkg.com/ical.js/dist/ical.es5.min.cjs"></script>
|
||||
<textarea id="txt"></textarea>
|
||||
<button onclick="ICAL.parse(document.getElementById('txt').value)"></button>
|
||||
```
|
||||
|
||||
The browser examples above use the minified versions of the library, which is probably what you want.
|
||||
However, there are also unminified versions of ICAL.js available on unpkg.
|
||||
|
||||
- Unminified ES6 module: `https://unpkg.com/ical.js/dist/ical.js`
|
||||
- Unminified ES5 version: `https://unpkg.com/ical.js/dist/ical.es5.cjs`
|
||||
|
||||
## Timezones
|
||||
The stock ical.js does not register any timezones, due to the additional size it brings. If you'd
|
||||
like to do timezone conversion, and the timezone definitions are not included in the respective ics
|
||||
files, you'll need to use `ical.timezones.js` or its minified counterpart.
|
||||
|
||||
This file is not included in the distribution since it pulls in IANA timezones that might change
|
||||
regularly. See the github actions on building your own timezones during CI, or grab a recent build
|
||||
from main.
|
||||
|
||||
## Documentation
|
||||
|
||||
For a few guides with code samples, please check out
|
||||
[the wiki](https://github.com/kewisch/ical.js/wiki). If you prefer,
|
||||
full API documentation [is available here](http://kewisch.github.io/ical.js/api/).
|
||||
If you are missing anything, please don't hesitate to create an issue.
|
||||
|
||||
## Developing
|
||||
|
||||
To contribute to ICAL.js you need to set up the development environment. A simple `npm install` will
|
||||
get you set up. If you would like to help out and would like to discuss any API changes, please feel
|
||||
free to create an issue.
|
||||
|
||||
### Tests
|
||||
|
||||
The following test suites are available
|
||||
|
||||
npm run test-unit # Node unit tests
|
||||
npm run test-acceptance # Node acceptance tests
|
||||
npm run test-performance # Performance comparison tests
|
||||
npm run test-browser # Browser unit and acceptance tests
|
||||
|
||||
npm run test # Node unit and acceptance tests (This is fast and covers most aspects)
|
||||
npm run test-all # All of the above
|
||||
|
||||
See [the wiki](https://github.com/kewisch/ical.js/wiki/Running-Tests) for more details.
|
||||
|
||||
Code coverage is automatically generated for the node unit tests. You can [view the coverage
|
||||
results](https://coveralls.io/r/kewisch/ical.js) online, or run them locally to make sure new
|
||||
code is covered.
|
||||
|
||||
### Linters
|
||||
To make sure all ICAL.js code uses a common style, please run the linters using `npm run lint`.
|
||||
Please make sure you fix any issues shown by this command before sending a pull request.
|
||||
|
||||
### Documentation
|
||||
You can generate the documentation locally, this is also helpful to ensure the jsdoc you have
|
||||
written is valid. To do so, run `npm run jsdoc`. You will find the output in the `docs/api/`
|
||||
subdirectory.
|
||||
|
||||
### Packaging
|
||||
When you are done with your work, you can run `npm run build` to create the single-file build for
|
||||
use in the browser, including its minified counterpart and the source map.
|
||||
|
||||
## License
|
||||
ical.js is licensed under the
|
||||
[Mozilla Public License](https://www.mozilla.org/MPL/2.0/), version 2.0.
|
||||
+9717
File diff suppressed because it is too large
Load Diff
+5
File diff suppressed because one or more lines are too long
+9732
File diff suppressed because it is too large
Load Diff
+5
File diff suppressed because one or more lines are too long
+49
@@ -0,0 +1,49 @@
|
||||
export default Binary;
|
||||
/**
|
||||
* Represents the BINARY value type, which contains extra methods for encoding and decoding.
|
||||
*
|
||||
* @memberof ICAL
|
||||
*/
|
||||
declare class Binary {
|
||||
/**
|
||||
* Creates a binary value from the given string.
|
||||
*
|
||||
* @param {String} aString The binary value string
|
||||
* @return {Binary} The binary value instance
|
||||
*/
|
||||
static fromString(aString: string): Binary;
|
||||
/**
|
||||
* Creates a new ICAL.Binary instance
|
||||
*
|
||||
* @param {String} aValue The binary data for this value
|
||||
*/
|
||||
constructor(aValue: string);
|
||||
value: string;
|
||||
/**
|
||||
* The type name, to be used in the jCal object.
|
||||
* @default "binary"
|
||||
* @constant
|
||||
*/
|
||||
icaltype: string;
|
||||
/**
|
||||
* Base64 decode the current value
|
||||
*
|
||||
* @return {String} The base64-decoded value
|
||||
*/
|
||||
decodeValue(): string;
|
||||
/**
|
||||
* Encodes the passed parameter with base64 and sets the internal
|
||||
* value to the result.
|
||||
*
|
||||
* @param {String} aValue The raw binary value to encode
|
||||
*/
|
||||
setEncodedValue(aValue: string): void;
|
||||
_b64_encode(data: any): any;
|
||||
_b64_decode(data: any): any;
|
||||
/**
|
||||
* The string representation of this value
|
||||
* @return {String}
|
||||
*/
|
||||
toString(): string;
|
||||
}
|
||||
//# sourceMappingURL=binary.d.ts.map
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"version":3,"file":"binary.d.ts","sourceRoot":"","sources":["../../lib/ical/binary.js"],"names":[],"mappings":";AAKA;;;;GAIG;AACH;IACE;;;;;OAKG;IACH,oCAFY,MAAM,CAIjB;IAED;;;;OAIG;IACH,4BAEC;IADC,cAAmB;IAGrB;;;;OAIG;IACH,iBAAoB;IAEpB;;;;OAIG;IACH,sBAEC;IAED;;;;;OAKG;IACH,sCAEC;IAED,4BAiDC;IAED,4BAuDC;IAED;;;OAGG;IACH,mBAEC;CACF"}
|
||||
+235
@@ -0,0 +1,235 @@
|
||||
export default Component;
|
||||
/**
|
||||
* Imports the 'designSet' type from the "types.js" module
|
||||
*/
|
||||
export type designSet = import("./types.js").designSet;
|
||||
/**
|
||||
* Imports the 'Geo' type from the "types.js" module
|
||||
*/
|
||||
export type Geo = import("./types.js").Geo;
|
||||
/**
|
||||
* Wraps a jCal component, adding convenience methods to add, remove and update subcomponents and
|
||||
* properties.
|
||||
*
|
||||
* @memberof ICAL
|
||||
*/
|
||||
declare class Component {
|
||||
/**
|
||||
* Create an {@link ICAL.Component} by parsing the passed iCalendar string.
|
||||
*
|
||||
* @param {String} str The iCalendar string to parse
|
||||
*/
|
||||
static fromString(str: string): Component;
|
||||
/**
|
||||
* Creates a new Component instance.
|
||||
*
|
||||
* @param {Array|String} jCal Raw jCal component data OR name of new
|
||||
* component
|
||||
* @param {Component=} parent Parent component to associate
|
||||
*/
|
||||
constructor(jCal: any[] | string, parent?: Component | undefined);
|
||||
jCal: any[];
|
||||
parent: Component;
|
||||
/**
|
||||
* A cache of hydrated time zone objects which may be used by consumers, keyed
|
||||
* by time zone ID.
|
||||
*
|
||||
* @type {Map}
|
||||
* @private
|
||||
*/
|
||||
private _timezoneCache;
|
||||
/**
|
||||
* Hydrated properties are inserted into the _properties array at the same
|
||||
* position as in the jCal array, so it is possible that the array contains
|
||||
* undefined values for unhydrdated properties. To avoid iterating the
|
||||
* array when checking if all properties have been hydrated, we save the
|
||||
* count here.
|
||||
*
|
||||
* @type {Number}
|
||||
* @private
|
||||
*/
|
||||
private _hydratedPropertyCount;
|
||||
/**
|
||||
* The same count as for _hydratedPropertyCount, but for subcomponents
|
||||
*
|
||||
* @type {Number}
|
||||
* @private
|
||||
*/
|
||||
private _hydratedComponentCount;
|
||||
/**
|
||||
* @private
|
||||
*/
|
||||
private _components;
|
||||
/**
|
||||
* @private
|
||||
*/
|
||||
private _properties;
|
||||
/**
|
||||
* The name of this component
|
||||
*
|
||||
* @type {String}
|
||||
*/
|
||||
get name(): string;
|
||||
/**
|
||||
* The design set for this component, e.g. icalendar vs vcard
|
||||
*
|
||||
* @type {designSet}
|
||||
* @private
|
||||
*/
|
||||
private get _designSet();
|
||||
/**
|
||||
* @private
|
||||
*/
|
||||
private _hydrateComponent;
|
||||
/**
|
||||
* @private
|
||||
*/
|
||||
private _hydrateProperty;
|
||||
/**
|
||||
* Finds first sub component, optionally filtered by name.
|
||||
*
|
||||
* @param {String=} name Optional name to filter by
|
||||
* @return {?Component} The found subcomponent
|
||||
*/
|
||||
getFirstSubcomponent(name?: string | undefined): Component | null;
|
||||
/**
|
||||
* Finds all sub components, optionally filtering by name.
|
||||
*
|
||||
* @param {String=} name Optional name to filter by
|
||||
* @return {Component[]} The found sub components
|
||||
*/
|
||||
getAllSubcomponents(name?: string | undefined): Component[];
|
||||
/**
|
||||
* Returns true when a named property exists.
|
||||
*
|
||||
* @param {String} name The property name
|
||||
* @return {Boolean} True, when property is found
|
||||
*/
|
||||
hasProperty(name: string): boolean;
|
||||
/**
|
||||
* Finds the first property, optionally with the given name.
|
||||
*
|
||||
* @param {String=} name Lowercase property name
|
||||
* @return {?Property} The found property
|
||||
*/
|
||||
getFirstProperty(name?: string | undefined): Property | null;
|
||||
/**
|
||||
* Returns first property's value, if available.
|
||||
*
|
||||
* @param {String=} name Lowercase property name
|
||||
* @return {Binary | Duration | Period |
|
||||
* Recur | Time | UtcOffset | Geo | string | null} The found property value.
|
||||
*/
|
||||
getFirstPropertyValue(name?: string | undefined): Binary | Duration | Period | Recur | Time | UtcOffset | import("./types.js").Geo | string | null;
|
||||
/**
|
||||
* Get all properties in the component, optionally filtered by name.
|
||||
*
|
||||
* @param {String=} name Lowercase property name
|
||||
* @return {Property[]} List of properties
|
||||
*/
|
||||
getAllProperties(name?: string | undefined): Property[];
|
||||
/**
|
||||
* @private
|
||||
*/
|
||||
private _removeObjectByIndex;
|
||||
/**
|
||||
* @private
|
||||
*/
|
||||
private _removeObject;
|
||||
/**
|
||||
* @private
|
||||
*/
|
||||
private _removeAllObjects;
|
||||
/**
|
||||
* Adds a single sub component.
|
||||
*
|
||||
* @param {Component} component The component to add
|
||||
* @return {Component} The passed in component
|
||||
*/
|
||||
addSubcomponent(component: Component): Component;
|
||||
/**
|
||||
* Removes a single component by name or the instance of a specific
|
||||
* component.
|
||||
*
|
||||
* @param {Component|String} nameOrComp Name of component, or component
|
||||
* @return {Boolean} True when comp is removed
|
||||
*/
|
||||
removeSubcomponent(nameOrComp: Component | string): boolean;
|
||||
/**
|
||||
* Removes all components or (if given) all components by a particular
|
||||
* name.
|
||||
*
|
||||
* @param {String=} name Lowercase component name
|
||||
*/
|
||||
removeAllSubcomponents(name?: string | undefined): void;
|
||||
/**
|
||||
* Adds an {@link ICAL.Property} to the component.
|
||||
*
|
||||
* @param {Property} property The property to add
|
||||
* @return {Property} The passed in property
|
||||
*/
|
||||
addProperty(property: Property): Property;
|
||||
/**
|
||||
* Helper method to add a property with a value to the component.
|
||||
*
|
||||
* @param {String} name Property name to add
|
||||
* @param {String|Number|Object} value Property value
|
||||
* @return {Property} The created property
|
||||
*/
|
||||
addPropertyWithValue(name: string, value: string | number | any): Property;
|
||||
/**
|
||||
* Helper method that will update or create a property of the given name
|
||||
* and sets its value. If multiple properties with the given name exist,
|
||||
* only the first is updated.
|
||||
*
|
||||
* @param {String} name Property name to update
|
||||
* @param {String|Number|Object} value Property value
|
||||
* @return {Property} The created property
|
||||
*/
|
||||
updatePropertyWithValue(name: string, value: string | number | any): Property;
|
||||
/**
|
||||
* Removes a single property by name or the instance of the specific
|
||||
* property.
|
||||
*
|
||||
* @param {String|Property} nameOrProp Property name or instance to remove
|
||||
* @return {Boolean} True, when deleted
|
||||
*/
|
||||
removeProperty(nameOrProp: string | Property): boolean;
|
||||
/**
|
||||
* Removes all properties associated with this component, optionally
|
||||
* filtered by name.
|
||||
*
|
||||
* @param {String=} name Lowercase property name
|
||||
* @return {Boolean} True, when deleted
|
||||
*/
|
||||
removeAllProperties(name?: string | undefined): boolean;
|
||||
/**
|
||||
* Returns the Object representation of this component. The returned object
|
||||
* is a live jCal object and should be cloned if modified.
|
||||
* @return {Object}
|
||||
*/
|
||||
toJSON(): any;
|
||||
/**
|
||||
* The string representation of this component.
|
||||
* @return {String}
|
||||
*/
|
||||
toString(): string;
|
||||
/**
|
||||
* Retrieve a time zone definition from the component tree, if any is present.
|
||||
* If the tree contains no time zone definitions or the TZID cannot be
|
||||
* matched, returns null.
|
||||
*
|
||||
* @param {String} tzid The ID of the time zone to retrieve
|
||||
* @return {Timezone} The time zone corresponding to the ID, or null
|
||||
*/
|
||||
getTimeZoneByID(tzid: string): Timezone;
|
||||
}
|
||||
import Property from "./property.js";
|
||||
import Binary from "./binary.js";
|
||||
import Duration from "./duration.js";
|
||||
import Period from "./period.js";
|
||||
import Recur from "./recur.js";
|
||||
import Time from "./time.js";
|
||||
import UtcOffset from "./utc_offset.js";
|
||||
import Timezone from "./timezone.js";
|
||||
//# sourceMappingURL=component.d.ts.map
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"version":3,"file":"component.d.ts","sourceRoot":"","sources":["../../lib/ical/component.js"],"names":[],"mappings":";;;;wBAkCa,OAAO,YAAY,EAAE,SAAS;;;;kBAE9B,OAAO,YAAY,EAAE,GAAG;AAWrC;;;;;GAKG;AACH;IACE;;;;OAIG;IACH,0CAEC;IAED;;;;;;OAMG;IACH,kBAJW,cAAY,WAEZ,SAAS,cAgBnB;IAPC,YAAgB;IAEhB,kBAA4B;IA2B9B;;;;;;OAMG;IACH,uBAAsB;IA3BtB;;;;;;;;;OASG;IACH,+BAA2B;IAE3B;;;;;OAKG;IACH,gCAA4B;IAW5B;;OAEG;IACH,oBAAmB;IAEnB;;OAEG;IACH,oBAAmB;IAEnB;;;;OAIG;IACH,mBAEC;IAED;;;;;OAKG;IACH,yBAcC;IAED;;OAEG;IACH,0BAiBC;IAED;;OAEG;IACH,yBAiBC;IAED;;;;;OAKG;IACH,iDAFa,SAAS,QAsBrB;IAED;;;;;OAKG;IACH,gDAFY,SAAS,EAAE,CA4BtB;IAED;;;;;OAKG;IACH,mCAaC;IAED;;;;;OAKG;IACH,6CAFa,QAAQ,QAqBpB;IAED;;;;;;OAMG;IACH,kDAHY,MAAM,GAAG,QAAQ,GAAG,MAAM,GACrC,KAAO,GAAG,IAAI,GAAG,SAAS,8BAAS,MAAM,GAAG,IAAI,CAShD;IAED;;;;;OAKG;IACH,6CAFY,QAAQ,EAAE,CA4BrB;IAED;;OAEG;IACH,6BAcC;IAED;;OAEG;IACH,sBAuBC;IAED;;OAEG;IACH,0BAeC;IAED;;;;;OAKG;IACH,2BAHW,SAAS,GACR,SAAS,CAiBpB;IAED;;;;;;OAMG;IACH,+BAHW,SAAS,SAAO,WAS1B;IAED;;;;;OAKG;IACH,wDAIC;IAED;;;;;OAKG;IACH,sBAHW,QAAQ,GACP,QAAQ,CAqBnB;IAED;;;;;;OAMG;IACH,0CAHW,qBAAoB,GACnB,QAAQ,CASnB;IAED;;;;;;;;OAQG;IACH,6CAHW,qBAAoB,GACnB,QAAQ,CAYnB;IAED;;;;;;OAMG;IACH,2BAHW,SAAO,QAAQ,WASzB;IAED;;;;;;OAMG;IACH,wDAIC;IAED;;;;OAIG;IACH,cAEC;IAED;;;OAGG;IACH,mBAIC;IAED;;;;;;;OAOG;IACH,+BAFY,QAAQ,CAsCnB;CACF;qBApnBoB,eAAe;mBAajB,aAAa;qBANX,eAAe;mBASjB,aAAa;kBAGd,YAAY;iBAGb,WAAW;sBAZN,iBAAiB;qBATlB,eAAe"}
|
||||
+88
@@ -0,0 +1,88 @@
|
||||
export default ComponentParser;
|
||||
/**
|
||||
* The ComponentParser is used to process a String or jCal Object,
|
||||
* firing callbacks for various found components, as well as completion.
|
||||
*
|
||||
* @example
|
||||
* var options = {
|
||||
* // when false no events will be emitted for type
|
||||
* parseEvent: true,
|
||||
* parseTimezone: true
|
||||
* };
|
||||
*
|
||||
* var parser = new ICAL.ComponentParser(options);
|
||||
*
|
||||
* parser.onevent(eventComponent) {
|
||||
* //...
|
||||
* }
|
||||
*
|
||||
* // ontimezone, etc...
|
||||
*
|
||||
* parser.oncomplete = function() {
|
||||
*
|
||||
* };
|
||||
*
|
||||
* parser.process(stringOrComponent);
|
||||
*
|
||||
* @memberof ICAL
|
||||
*/
|
||||
declare class ComponentParser {
|
||||
/**
|
||||
* Creates a new ICAL.ComponentParser instance.
|
||||
*
|
||||
* @param {Object=} options Component parser options
|
||||
* @param {Boolean} options.parseEvent Whether events should be parsed
|
||||
* @param {Boolean} options.parseTimezeone Whether timezones should be parsed
|
||||
*/
|
||||
constructor(options?: any | undefined);
|
||||
/**
|
||||
* When true, parse events
|
||||
*
|
||||
* @type {Boolean}
|
||||
*/
|
||||
parseEvent: boolean;
|
||||
/**
|
||||
* When true, parse timezones
|
||||
*
|
||||
* @type {Boolean}
|
||||
*/
|
||||
parseTimezone: boolean;
|
||||
/**
|
||||
* Fired when parsing is complete
|
||||
* @callback
|
||||
*/
|
||||
oncomplete: () => void;
|
||||
/**
|
||||
* Fired if an error occurs during parsing.
|
||||
*
|
||||
* @callback
|
||||
* @param {Error} err details of error
|
||||
*/
|
||||
onerror: (err: any) => void;
|
||||
/**
|
||||
* Fired when a top level component (VTIMEZONE) is found
|
||||
*
|
||||
* @callback
|
||||
* @param {Timezone} component Timezone object
|
||||
*/
|
||||
ontimezone: (component: any) => void;
|
||||
/**
|
||||
* Fired when a top level component (VEVENT) is found.
|
||||
*
|
||||
* @callback
|
||||
* @param {Event} component Top level component
|
||||
*/
|
||||
onevent: (component: any) => void;
|
||||
/**
|
||||
* Process a string or parse ical object. This function itself will return
|
||||
* nothing but will start the parsing process.
|
||||
*
|
||||
* Events must be registered prior to calling this method.
|
||||
*
|
||||
* @param {Component|String|Object} ical The component to process,
|
||||
* either in its final form, as a jCal Object, or string representation
|
||||
*/
|
||||
process(ical: Component | string | any): void;
|
||||
}
|
||||
import Component from "./component.js";
|
||||
//# sourceMappingURL=component_parser.d.ts.map
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"version":3,"file":"component_parser.d.ts","sourceRoot":"","sources":["../../lib/ical/component_parser.js"],"names":[],"mappings":";AAUA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH;IACE;;;;;;OAMG;IACH,uCAQC;IAED;;;;OAIG;IACH,oBAAkB;IAElB;;;;OAIG;IACH,uBAAqB;IAKrB;;;OAGG;IACH,uBAAgD;IAEhD;;;;;OAKG;IACH,4BAAgD;IAEhD;;;;;OAKG;IACH,qCAAyD;IAEzD;;;;;OAKG;IACH,kCAAsD;IAEtD;;;;;;;;OAQG;IACH,cAHW,SAAS,eAAc,QA8CjC;CACF;sBArJqB,gBAAgB"}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
export default design;
|
||||
/**
|
||||
* Imports the 'designSet' type from the "types.js" module
|
||||
*/
|
||||
export type designSet = import("./types.js").designSet;
|
||||
declare namespace design {
|
||||
export let strict: boolean;
|
||||
export { icalSet as defaultSet };
|
||||
export let defaultType: string;
|
||||
export let components: any;
|
||||
export { icalSet as icalendar };
|
||||
export { vcardSet as vcard };
|
||||
export { vcard3Set as vcard3 };
|
||||
export function getDesignSet(componentName: string): import("./types.js").designSet;
|
||||
}
|
||||
/**
|
||||
* iCalendar design set
|
||||
* @type {designSet}
|
||||
*/
|
||||
declare let icalSet: designSet;
|
||||
/**
|
||||
* vCard 4.0 design set
|
||||
* @type {designSet}
|
||||
*/
|
||||
declare let vcardSet: designSet;
|
||||
/**
|
||||
* vCard 3.0 design set
|
||||
* @type {designSet}
|
||||
*/
|
||||
declare let vcard3Set: designSet;
|
||||
//# sourceMappingURL=design.d.ts.map
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"version":3,"file":"design.d.ts","sourceRoot":"","sources":["../../lib/ical/design.js"],"names":[],"mappings":";;;;wBAmBa,OAAO,YAAY,EAAE,SAAS;;;;;;;;;IA4+B3B,oFAGb;;AA1HH;;;GAGG;AACH,qBAFU,SAAS,CAQjB;AAEF;;;GAGG;AACH,sBAFU,SAAS,CAQjB;AAEF;;;GAGG;AACH,uBAFU,SAAS,CAQjB"}
|
||||
+188
@@ -0,0 +1,188 @@
|
||||
export default Duration;
|
||||
/**
|
||||
* This class represents the "duration" value type, with various calculation
|
||||
* and manipulation methods.
|
||||
*
|
||||
* @memberof ICAL
|
||||
*/
|
||||
declare class Duration {
|
||||
/**
|
||||
* Returns a new ICAL.Duration instance from the passed seconds value.
|
||||
*
|
||||
* @param {Number} aSeconds The seconds to create the instance from
|
||||
* @return {Duration} The newly created duration instance
|
||||
*/
|
||||
static fromSeconds(aSeconds: number): Duration;
|
||||
/**
|
||||
* Checks if the given string is an iCalendar duration value.
|
||||
*
|
||||
* @param {String} value The raw ical value
|
||||
* @return {Boolean} True, if the given value is of the
|
||||
* duration ical type
|
||||
*/
|
||||
static isValueString(string: any): boolean;
|
||||
/**
|
||||
* Creates a new {@link ICAL.Duration} instance from the passed string.
|
||||
*
|
||||
* @param {String} aStr The string to parse
|
||||
* @return {Duration} The created duration instance
|
||||
*/
|
||||
static fromString(aStr: string): Duration;
|
||||
/**
|
||||
* Creates a new ICAL.Duration instance from the given data object.
|
||||
*
|
||||
* @param {Object} aData An object with members of the duration
|
||||
* @param {Number=} aData.weeks Duration in weeks
|
||||
* @param {Number=} aData.days Duration in days
|
||||
* @param {Number=} aData.hours Duration in hours
|
||||
* @param {Number=} aData.minutes Duration in minutes
|
||||
* @param {Number=} aData.seconds Duration in seconds
|
||||
* @param {Boolean=} aData.isNegative If true, the duration is negative
|
||||
* @return {Duration} The createad duration instance
|
||||
*/
|
||||
static fromData(aData: {
|
||||
weeks?: number | undefined;
|
||||
days?: number | undefined;
|
||||
hours?: number | undefined;
|
||||
minutes?: number | undefined;
|
||||
seconds?: number | undefined;
|
||||
isNegative?: boolean | undefined;
|
||||
}): Duration;
|
||||
/**
|
||||
* Creates a new ICAL.Duration instance.
|
||||
*
|
||||
* @param {Object} data An object with members of the duration
|
||||
* @param {Number=} data.weeks Duration in weeks
|
||||
* @param {Number=} data.days Duration in days
|
||||
* @param {Number=} data.hours Duration in hours
|
||||
* @param {Number=} data.minutes Duration in minutes
|
||||
* @param {Number=} data.seconds Duration in seconds
|
||||
* @param {Boolean=} data.isNegative If true, the duration is negative
|
||||
*/
|
||||
constructor(data: {
|
||||
weeks?: number | undefined;
|
||||
days?: number | undefined;
|
||||
hours?: number | undefined;
|
||||
minutes?: number | undefined;
|
||||
seconds?: number | undefined;
|
||||
isNegative?: boolean | undefined;
|
||||
});
|
||||
wrappedJSObject: this;
|
||||
/**
|
||||
* The weeks in this duration
|
||||
* @type {Number}
|
||||
* @default 0
|
||||
*/
|
||||
weeks: number;
|
||||
/**
|
||||
* The days in this duration
|
||||
* @type {Number}
|
||||
* @default 0
|
||||
*/
|
||||
days: number;
|
||||
/**
|
||||
* The days in this duration
|
||||
* @type {Number}
|
||||
* @default 0
|
||||
*/
|
||||
hours: number;
|
||||
/**
|
||||
* The minutes in this duration
|
||||
* @type {Number}
|
||||
* @default 0
|
||||
*/
|
||||
minutes: number;
|
||||
/**
|
||||
* The seconds in this duration
|
||||
* @type {Number}
|
||||
* @default 0
|
||||
*/
|
||||
seconds: number;
|
||||
/**
|
||||
* The seconds in this duration
|
||||
* @type {Boolean}
|
||||
* @default false
|
||||
*/
|
||||
isNegative: boolean;
|
||||
/**
|
||||
* The class identifier.
|
||||
* @constant
|
||||
* @type {String}
|
||||
* @default "icalduration"
|
||||
*/
|
||||
icalclass: string;
|
||||
/**
|
||||
* The type name, to be used in the jCal object.
|
||||
* @constant
|
||||
* @type {String}
|
||||
* @default "duration"
|
||||
*/
|
||||
icaltype: string;
|
||||
/**
|
||||
* Returns a clone of the duration object.
|
||||
*
|
||||
* @return {Duration} The cloned object
|
||||
*/
|
||||
clone(): Duration;
|
||||
/**
|
||||
* The duration value expressed as a number of seconds.
|
||||
*
|
||||
* @return {Number} The duration value in seconds
|
||||
*/
|
||||
toSeconds(): number;
|
||||
/**
|
||||
* Reads the passed seconds value into this duration object. Afterwards,
|
||||
* members like {@link ICAL.Duration#days days} and {@link ICAL.Duration#weeks weeks} will be set up
|
||||
* accordingly.
|
||||
*
|
||||
* @param {Number} aSeconds The duration value in seconds
|
||||
* @return {Duration} Returns this instance
|
||||
*/
|
||||
fromSeconds(aSeconds: number): Duration;
|
||||
/**
|
||||
* Sets up the current instance using members from the passed data object.
|
||||
*
|
||||
* @param {Object} aData An object with members of the duration
|
||||
* @param {Number=} aData.weeks Duration in weeks
|
||||
* @param {Number=} aData.days Duration in days
|
||||
* @param {Number=} aData.hours Duration in hours
|
||||
* @param {Number=} aData.minutes Duration in minutes
|
||||
* @param {Number=} aData.seconds Duration in seconds
|
||||
* @param {Boolean=} aData.isNegative If true, the duration is negative
|
||||
*/
|
||||
fromData(aData: {
|
||||
weeks?: number | undefined;
|
||||
days?: number | undefined;
|
||||
hours?: number | undefined;
|
||||
minutes?: number | undefined;
|
||||
seconds?: number | undefined;
|
||||
isNegative?: boolean | undefined;
|
||||
}): void;
|
||||
/**
|
||||
* Resets the duration instance to the default values, i.e. PT0S
|
||||
*/
|
||||
reset(): void;
|
||||
/**
|
||||
* Compares the duration instance with another one.
|
||||
*
|
||||
* @param {Duration} aOther The instance to compare with
|
||||
* @return {Number} -1, 0 or 1 for less/equal/greater
|
||||
*/
|
||||
compare(aOther: Duration): number;
|
||||
/**
|
||||
* Normalizes the duration instance. For example, a duration with a value
|
||||
* of 61 seconds will be normalized to 1 minute and 1 second.
|
||||
*/
|
||||
normalize(): void;
|
||||
/**
|
||||
* The string representation of this duration.
|
||||
* @return {String}
|
||||
*/
|
||||
toString(): string;
|
||||
/**
|
||||
* The iCalendar string representation of this duration.
|
||||
* @return {String}
|
||||
*/
|
||||
toICALString(): string;
|
||||
}
|
||||
//# sourceMappingURL=duration.d.ts.map
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"version":3,"file":"duration.d.ts","sourceRoot":"","sources":["../../lib/ical/duration.js"],"names":[],"mappings":";AAUA;;;;;GAKG;AACH;IACE;;;;;OAKG;IACH,sCAFY,QAAQ,CAInB;IAED;;;;;;OAMG;IACH,2CAEC;IAED;;;;;OAKG;IACH,iCAFY,QAAQ,CAuBnB;IAED;;;;;;;;;;;OAWG;IACH;QAR0B,KAAK;QACL,IAAI;QACJ,KAAK;QACL,OAAO;QACP,OAAO;QACN,UAAU;QACzB,QAAQ,CAInB;IAED;;;;;;;;;;OAUG;IACH;QAPyB,KAAK;QACL,IAAI;QACJ,KAAK;QACL,OAAO;QACP,OAAO;QACN,UAAU;OAKnC;IAFC,sBAA2B;IAI7B;;;;OAIG;IACH,cAAU;IAEV;;;;OAIG;IACH,aAAS;IAET;;;;OAIG;IACH,cAAU;IAEV;;;;OAIG;IACH,gBAAY;IAEZ;;;;OAIG;IACH,gBAAY;IAEZ;;;;OAIG;IACH,oBAAmB;IAEnB;;;;;OAKG;IACH,kBAA2B;IAE3B;;;;;OAKG;IACH,iBAAsB;IAEtB;;;;OAIG;IACH,SAFY,QAAQ,CAInB;IAED;;;;OAIG;IACH,oBAIC;IAED;;;;;;;OAOG;IACH,+BAFY,QAAQ,CA0BnB;IAED;;;;;;;;;;OAUG;IACH;QAP0B,KAAK;QACL,IAAI;QACJ,KAAK;QACL,OAAO;QACP,OAAO;QACN,UAAU;aAUpC;IAED;;OAEG;IACH,cAOC;IAED;;;;;OAKG;IACH,gBAHW,QAAQ,UAOlB;IAED;;;OAGG;IACH,kBAEC;IAED;;;OAGG;IACH,mBAsCC;IAED;;;OAGG;IACH,uBAEC;CACF"}
|
||||
+240
@@ -0,0 +1,240 @@
|
||||
export default Event;
|
||||
/**
|
||||
* Imports the 'frequencyValues' type from the "types.js" module
|
||||
*/
|
||||
export type frequencyValues = import("./types.js").frequencyValues;
|
||||
/**
|
||||
* Imports the 'occurrenceDetails' type from the "types.js" module
|
||||
*/
|
||||
export type occurrenceDetails = import("./types.js").occurrenceDetails;
|
||||
/**
|
||||
* This lets typescript resolve our custom types in the
|
||||
* generated d.ts files (jsdoc typedefs are converted to typescript types).
|
||||
* Ignore prevents the typedefs from being documented more than once.
|
||||
* @ignore
|
||||
* @typedef {import("./types.js").frequencyValues} frequencyValues
|
||||
* Imports the 'frequencyValues' type from the "types.js" module
|
||||
* @typedef {import("./types.js").occurrenceDetails} occurrenceDetails
|
||||
* Imports the 'occurrenceDetails' type from the "types.js" module
|
||||
*/
|
||||
/**
|
||||
* ICAL.js is organized into multiple layers. The bottom layer is a raw jCal
|
||||
* object, followed by the component/property layer. The highest level is the
|
||||
* event representation, which this class is part of. See the
|
||||
* {@tutorial layers} guide for more details.
|
||||
*
|
||||
* @memberof ICAL
|
||||
*/
|
||||
declare class Event {
|
||||
static THISANDFUTURE: string;
|
||||
/**
|
||||
* Creates a new ICAL.Event instance.
|
||||
*
|
||||
* @param {Component=} component The ICAL.Component to base this event on
|
||||
* @param {Object} [options] Options for this event
|
||||
* @param {Boolean=} options.strictExceptions When true, will verify exceptions are related by
|
||||
* their UUID
|
||||
* @param {Array<Component|Event>=} options.exceptions
|
||||
* Exceptions to this event, either as components or events. If not
|
||||
* specified exceptions will automatically be set in relation of
|
||||
* component's parent
|
||||
*/
|
||||
constructor(component?: Component | undefined, options?: {
|
||||
strictExceptions?: boolean | undefined;
|
||||
exceptions?: Array<Component | Event> | undefined;
|
||||
});
|
||||
component: Component;
|
||||
_rangeExceptionCache: any;
|
||||
/**
|
||||
* List of related event exceptions.
|
||||
*
|
||||
* @type {Event[]}
|
||||
*/
|
||||
exceptions: Event[];
|
||||
rangeExceptions: any[];
|
||||
/**
|
||||
* When true, will verify exceptions are related by their UUID.
|
||||
*
|
||||
* @type {Boolean}
|
||||
*/
|
||||
strictExceptions: boolean;
|
||||
/**
|
||||
* Relates a given event exception to this object. If the given component
|
||||
* does not share the UID of this event it cannot be related and will throw
|
||||
* an exception.
|
||||
*
|
||||
* If this component is an exception it cannot have other exceptions
|
||||
* related to it.
|
||||
*
|
||||
* @param {Component|Event} obj Component or event
|
||||
*/
|
||||
relateException(obj: Component | Event): void;
|
||||
/**
|
||||
* Checks if this record is an exception and has the RANGE=THISANDFUTURE
|
||||
* value.
|
||||
*
|
||||
* @return {Boolean} True, when exception is within range
|
||||
*/
|
||||
modifiesFuture(): boolean;
|
||||
/**
|
||||
* Finds the range exception nearest to the given date.
|
||||
*
|
||||
* @param {Time} time usually an occurrence time of an event
|
||||
* @return {?Event} the related event/exception or null
|
||||
*/
|
||||
findRangeException(time: Time): Event | null;
|
||||
/**
|
||||
* Returns the occurrence details based on its start time. If the
|
||||
* occurrence has an exception will return the details for that exception.
|
||||
*
|
||||
* NOTE: this method is intend to be used in conjunction
|
||||
* with the {@link ICAL.Event#iterator iterator} method.
|
||||
*
|
||||
* @param {Time} occurrence time occurrence
|
||||
* @return {occurrenceDetails} Information about the occurrence
|
||||
*/
|
||||
getOccurrenceDetails(occurrence: Time): occurrenceDetails;
|
||||
/**
|
||||
* Builds a recur expansion instance for a specific point in time (defaults
|
||||
* to startDate).
|
||||
*
|
||||
* @param {Time=} startTime Starting point for expansion
|
||||
* @return {RecurExpansion} Expansion object
|
||||
*/
|
||||
iterator(startTime?: Time | undefined): RecurExpansion;
|
||||
/**
|
||||
* Checks if the event is recurring
|
||||
*
|
||||
* @return {Boolean} True, if event is recurring
|
||||
*/
|
||||
isRecurring(): boolean;
|
||||
/**
|
||||
* Checks if the event describes a recurrence exception. See
|
||||
* {@tutorial terminology} for details.
|
||||
*
|
||||
* @return {Boolean} True, if the event describes a recurrence exception
|
||||
*/
|
||||
isRecurrenceException(): boolean;
|
||||
/**
|
||||
* Returns the types of recurrences this event may have.
|
||||
*
|
||||
* Returned as an object with the following possible keys:
|
||||
*
|
||||
* - YEARLY
|
||||
* - MONTHLY
|
||||
* - WEEKLY
|
||||
* - DAILY
|
||||
* - MINUTELY
|
||||
* - SECONDLY
|
||||
*
|
||||
* @return {Object.<frequencyValues, Boolean>}
|
||||
* Object of recurrence flags
|
||||
*/
|
||||
getRecurrenceTypes(): any;
|
||||
set uid(value: string);
|
||||
/**
|
||||
* The uid of this event
|
||||
* @type {String}
|
||||
*/
|
||||
get uid(): string;
|
||||
set startDate(value: Time);
|
||||
/**
|
||||
* The start date
|
||||
* @type {Time}
|
||||
*/
|
||||
get startDate(): Time;
|
||||
set endDate(value: Time);
|
||||
/**
|
||||
* The end date. This can be the result directly from the property, or the
|
||||
* end date calculated from start date and duration. Setting the property
|
||||
* will remove any duration properties.
|
||||
* @type {Time}
|
||||
*/
|
||||
get endDate(): Time;
|
||||
set duration(value: Duration);
|
||||
/**
|
||||
* The duration. This can be the result directly from the property, or the
|
||||
* duration calculated from start date and end date. Setting the property
|
||||
* will remove any `dtend` properties.
|
||||
* @type {Duration}
|
||||
*/
|
||||
get duration(): Duration;
|
||||
set location(value: string);
|
||||
/**
|
||||
* The location of the event.
|
||||
* @type {String}
|
||||
*/
|
||||
get location(): string;
|
||||
/**
|
||||
* The attendees in the event
|
||||
* @type {Property[]}
|
||||
*/
|
||||
get attendees(): Property[];
|
||||
set summary(value: string);
|
||||
/**
|
||||
* The event summary
|
||||
* @type {String}
|
||||
*/
|
||||
get summary(): string;
|
||||
set description(value: string);
|
||||
/**
|
||||
* The event description.
|
||||
* @type {String}
|
||||
*/
|
||||
get description(): string;
|
||||
set color(value: string);
|
||||
/**
|
||||
* The event color from [rfc7986](https://datatracker.ietf.org/doc/html/rfc7986)
|
||||
* @type {String}
|
||||
*/
|
||||
get color(): string;
|
||||
set organizer(value: string);
|
||||
/**
|
||||
* The organizer value as an uri. In most cases this is a mailto: uri, but
|
||||
* it can also be something else, like urn:uuid:...
|
||||
* @type {String}
|
||||
*/
|
||||
get organizer(): string;
|
||||
set sequence(value: number);
|
||||
/**
|
||||
* The sequence value for this event. Used for scheduling
|
||||
* see {@tutorial terminology}.
|
||||
* @type {Number}
|
||||
*/
|
||||
get sequence(): number;
|
||||
set recurrenceId(value: Time);
|
||||
/**
|
||||
* The recurrence id for this event. See {@tutorial terminology} for details.
|
||||
* @type {Time}
|
||||
*/
|
||||
get recurrenceId(): Time;
|
||||
/**
|
||||
* Set/update a time property's value.
|
||||
* This will also update the TZID of the property.
|
||||
*
|
||||
* TODO: this method handles the case where we are switching
|
||||
* from a known timezone to an implied timezone (one without TZID).
|
||||
* This does _not_ handle the case of moving between a known
|
||||
* (by TimezoneService) timezone to an unknown timezone...
|
||||
*
|
||||
* We will not add/remove/update the VTIMEZONE subcomponents
|
||||
* leading to invalid ICAL data...
|
||||
* @private
|
||||
* @param {String} propName The property name
|
||||
* @param {Time} time The time to set
|
||||
*/
|
||||
private _setTime;
|
||||
_setProp(name: any, value: any): void;
|
||||
_firstProp(name: any): string | import("./binary.js").default | Duration | Time | import("./recur.js").default | import("./period.js").default | import("./utc_offset.js").default | import("./types.js").Geo;
|
||||
/**
|
||||
* The string representation of this event.
|
||||
* @return {String}
|
||||
*/
|
||||
toString(): string;
|
||||
}
|
||||
import Component from "./component.js";
|
||||
import Time from "./time.js";
|
||||
import RecurExpansion from "./recur_expansion.js";
|
||||
import Duration from "./duration.js";
|
||||
import Property from "./property.js";
|
||||
//# sourceMappingURL=event.d.ts.map
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"version":3,"file":"event.d.ts","sourceRoot":"","sources":["../../lib/ical/event.js"],"names":[],"mappings":";;;;8BAqBa,OAAO,YAAY,EAAE,eAAe;;;;gCAEpC,OAAO,YAAY,EAAE,iBAAiB;AAPnD;;;;;;;;;GASG;AAEH;;;;;;;GAOG;AACH;IA6CE,6BAAuC;IA5CvC;;;;;;;;;;;OAWG;IACH,wBATW,SAAS;QAES,gBAAgB;QAED,UAAU,GAA3C,MAAM,SAAS,GAAC,KAAK,CAAC;OAkChC;IAtBG,qBAA0B;IAK5B,0BAA+C;IAsBjD;;;;OAIG;IACH,YAFU,KAAK,EAAE,CAEC;IAzBhB,uBAAyB;IA2B3B;;;;OAIG;IACH,0BAAyB;IAEzB;;;;;;;;;OASG;IACH,qBAFW,SAAS,GAAC,KAAK,QAsCzB;IAED;;;;;OAKG;IACH,0BAOC;IAED;;;;;OAKG;IACH,yBAHW,IAAI,GACF,KAAK,QA8BjB;IAED;;;;;;;;;OASG;IACH,iCAHW,IAAI,GACH,iBAAiB,CAwE5B;IAED;;;;;;OAMG;IACH,qBAHW,IAAI,eACH,cAAc,CAOzB;IAED;;;;OAIG;IACH,uBAGC;IAED;;;;;OAKG;IACH,iCAEC;IAED;;;;;;;;;;;;;;OAcG;IACH,0BAYC;IAUD,uBAEC;IAVD;;;OAGG;IACH,kBAEC;IAcD,2BAEC;IAVD;;;OAGG;IACH,sBAEC;IA0BD,yBAKC;IAzBD;;;;;OAKG;IACH,oBAYC;IAuBD,8BAMC;IApBD;;;;;OAKG;IACH,yBAMC;IAkBD,4BAEC;IAVD;;;OAGG;IACH,uBAEC;IAMD;;;OAGG;IACH,4BAIC;IAUD,2BAEC;IAVD;;;OAGG;IACH,sBAEC;IAcD,+BAEC;IAVD;;;OAGG;IACH,0BAEC;IAcD,yBAEC;IAVD;;;OAGG;IACH,oBAEC;IAeD,6BAEC;IAXD;;;;OAIG;IACH,wBAEC;IAeD,4BAEC;IAXD;;;;OAIG;IACH,uBAEC;IAcD,8BAEC;IAVD;;;OAGG;IACH,yBAEC;IAMD;;;;;;;;;;;;;;OAcG;IACH,iBAoBC;IAED,sCAEC;IAED,8MAEC;IAED;;;OAGG;IACH,mBAEC;CACF;sBA3iBqB,gBAAgB;iBAKrB,WAAW;2BAGD,sBAAsB;qBAD5B,eAAe;qBANf,eAAe"}
|
||||
+123
@@ -0,0 +1,123 @@
|
||||
/**
|
||||
* Helper functions used in various places within ical.js
|
||||
* @module ICAL.helpers
|
||||
*/
|
||||
/**
|
||||
* Compiles a list of all referenced TZIDs in all subcomponents and
|
||||
* removes any extra VTIMEZONE subcomponents. In addition, if any TZIDs
|
||||
* are referenced by a component, but a VTIMEZONE does not exist,
|
||||
* an attempt will be made to generate a VTIMEZONE using ICAL.TimezoneService.
|
||||
*
|
||||
* @param {Component} vcal The top-level VCALENDAR component.
|
||||
* @return {Component} The ICAL.Component that was passed in.
|
||||
*/
|
||||
export function updateTimezones(vcal: Component): Component;
|
||||
/**
|
||||
* Checks if the given type is of the number type and also NaN.
|
||||
*
|
||||
* @param {Number} number The number to check
|
||||
* @return {Boolean} True, if the number is strictly NaN
|
||||
*/
|
||||
export function isStrictlyNaN(number: number): boolean;
|
||||
/**
|
||||
* Parses a string value that is expected to be an integer, when the valid is
|
||||
* not an integer throws a decoration error.
|
||||
*
|
||||
* @param {String} string Raw string input
|
||||
* @return {Number} Parsed integer
|
||||
*/
|
||||
export function strictParseInt(string: string): number;
|
||||
/**
|
||||
* Creates or returns a class instance of a given type with the initialization
|
||||
* data if the data is not already an instance of the given type.
|
||||
*
|
||||
* @example
|
||||
* var time = new ICAL.Time(...);
|
||||
* var result = ICAL.helpers.formatClassType(time, ICAL.Time);
|
||||
*
|
||||
* (result instanceof ICAL.Time)
|
||||
* // => true
|
||||
*
|
||||
* result = ICAL.helpers.formatClassType({}, ICAL.Time);
|
||||
* (result isntanceof ICAL.Time)
|
||||
* // => true
|
||||
*
|
||||
*
|
||||
* @param {Object} data object initialization data
|
||||
* @param {Object} type object type (like ICAL.Time)
|
||||
* @return {?} An instance of the found type.
|
||||
*/
|
||||
export function formatClassType(data: any, type: any): unknown;
|
||||
/**
|
||||
* Identical to indexOf but will only match values when they are not preceded
|
||||
* by a backslash character.
|
||||
*
|
||||
* @param {String} buffer String to search
|
||||
* @param {String} search Value to look for
|
||||
* @param {Number} pos Start position
|
||||
* @return {Number} The position, or -1 if not found
|
||||
*/
|
||||
export function unescapedIndexOf(buffer: string, search: string, pos: number): number;
|
||||
/**
|
||||
* Find the index for insertion using binary search.
|
||||
*
|
||||
* @param {Array} list The list to search
|
||||
* @param {?} seekVal The value to insert
|
||||
* @param {function(?,?)} cmpfunc The comparison func, that can
|
||||
* compare two seekVals
|
||||
* @return {Number} The insert position
|
||||
*/
|
||||
export function binsearchInsert(list: any[], seekVal: unknown, cmpfunc: (arg0: unknown, arg1: unknown) => any): number;
|
||||
/**
|
||||
* Clone the passed object or primitive. By default a shallow clone will be
|
||||
* executed.
|
||||
*
|
||||
* @param {*} aSrc The thing to clone
|
||||
* @param {Boolean=} aDeep If true, a deep clone will be performed
|
||||
* @return {*} The copy of the thing
|
||||
*/
|
||||
export function clone(aSrc: any, aDeep?: boolean | undefined): any;
|
||||
/**
|
||||
* Performs iCalendar line folding. A line ending character is inserted and
|
||||
* the next line begins with a whitespace.
|
||||
*
|
||||
* @example
|
||||
* SUMMARY:This line will be fold
|
||||
* ed right in the middle of a word.
|
||||
*
|
||||
* @param {String} aLine The line to fold
|
||||
* @return {String} The folded line
|
||||
*/
|
||||
export function foldline(aLine: string): string;
|
||||
/**
|
||||
* Pads the given string or number with zeros so it will have at least two
|
||||
* characters.
|
||||
*
|
||||
* @param {String|Number} data The string or number to pad
|
||||
* @return {String} The number padded as a string
|
||||
*/
|
||||
export function pad2(data: string | number): string;
|
||||
/**
|
||||
* Truncates the given number, correctly handling negative numbers.
|
||||
*
|
||||
* @param {Number} number The number to truncate
|
||||
* @return {Number} The truncated number
|
||||
*/
|
||||
export function trunc(number: number): number;
|
||||
/**
|
||||
* Poor-man's cross-browser object extension. Doesn't support all the
|
||||
* features, but enough for our usage. Note that the target's properties are
|
||||
* not overwritten with the source properties.
|
||||
*
|
||||
* @example
|
||||
* var child = ICAL.helpers.extend(parent, {
|
||||
* "bar": 123
|
||||
* });
|
||||
*
|
||||
* @param {Object} source The object to extend
|
||||
* @param {Object} target The object to extend with
|
||||
* @return {Object} Returns the target.
|
||||
*/
|
||||
export function extend(source: any, target: any): any;
|
||||
import Component from "./component.js";
|
||||
//# sourceMappingURL=helpers.d.ts.map
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../lib/ical/helpers.js"],"names":[],"mappings":"AAWA;;;GAGG;AAEH;;;;;;;;GAQG;AACH,sCAHW,SAAS,GACR,SAAS,CAgDpB;AAED;;;;;GAKG;AACH,uDAEC;AAED;;;;;;GAMG;AACH,uDAUC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,+DASC;AAED;;;;;;;;GAQG;AACH,sFASC;AAED;;;;;;;;GAQG;AACH,uHAyBC;AAED;;;;;;;GAOG;AACH,mEAwBC;AAED;;;;;;;;;;GAUG;AACH,gDAoBC;AAED;;;;;;GAMG;AACH,2BAHW,eAAa,UAsBvB;AAED;;;;;GAKG;AACH,8CAEC;AAED;;;;;;;;;;;;;GAaG;AACH,sDAQC;sBApTqB,gBAAgB"}
|
||||
+45
@@ -0,0 +1,45 @@
|
||||
declare namespace _default {
|
||||
export let foldLength: number;
|
||||
export let debug: boolean;
|
||||
export let newLineChar: string;
|
||||
export { Binary };
|
||||
export { Component };
|
||||
export { ComponentParser };
|
||||
export { Duration };
|
||||
export { Event };
|
||||
export { Period };
|
||||
export { Property };
|
||||
export { Recur };
|
||||
export { RecurExpansion };
|
||||
export { RecurIterator };
|
||||
export { Time };
|
||||
export { Timezone };
|
||||
export { TimezoneService };
|
||||
export { UtcOffset };
|
||||
export { VCardTime };
|
||||
export { parse };
|
||||
export { stringify };
|
||||
export { design };
|
||||
export { helpers };
|
||||
}
|
||||
export default _default;
|
||||
import Binary from "./binary.js";
|
||||
import Component from "./component.js";
|
||||
import ComponentParser from "./component_parser.js";
|
||||
import Duration from "./duration.js";
|
||||
import Event from "./event.js";
|
||||
import Period from "./period.js";
|
||||
import Property from "./property.js";
|
||||
import Recur from "./recur.js";
|
||||
import RecurExpansion from "./recur_expansion.js";
|
||||
import RecurIterator from "./recur_iterator.js";
|
||||
import Time from "./time.js";
|
||||
import Timezone from "./timezone.js";
|
||||
import TimezoneService from "./timezone_service.js";
|
||||
import UtcOffset from "./utc_offset.js";
|
||||
import VCardTime from "./vcard_time.js";
|
||||
import parse from "./parse.js";
|
||||
import stringify from "./stringify.js";
|
||||
import design from "./design.js";
|
||||
import * as helpers from "./helpers.js";
|
||||
//# sourceMappingURL=module.d.ts.map
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"version":3,"file":"module.d.ts","sourceRoot":"","sources":["../../lib/ical/module.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;mBAKmB,aAAa;sBACV,gBAAgB;4BACV,uBAAuB;qBAE9B,eAAe;kBAClB,YAAY;mBAGX,aAAa;qBACX,eAAe;kBAClB,YAAY;2BACH,sBAAsB;0BACvB,qBAAqB;iBAE9B,WAAW;qBACP,eAAe;4BACR,uBAAuB;sBAC7B,iBAAiB;sBACjB,iBAAiB;kBAXrB,YAAY;sBAMR,gBAAgB;mBAVnB,aAAa;yBAGP,cAAc"}
|
||||
+124
@@ -0,0 +1,124 @@
|
||||
/**
|
||||
* Parses iCalendar or vCard data into a raw jCal object. Consult
|
||||
* documentation on the {@tutorial layers|layers of parsing} for more
|
||||
* details.
|
||||
*
|
||||
* @function ICAL.parse
|
||||
* @memberof ICAL
|
||||
* @variation function
|
||||
* @todo Fix the API to be more clear on the return type
|
||||
* @param {String} input The string data to parse
|
||||
* @return {Object|Object[]} A single jCal object, or an array thereof
|
||||
*/
|
||||
declare function parse(input: string): any | any[];
|
||||
declare namespace parse {
|
||||
/**
|
||||
* Parse an iCalendar property value into the jCal for a single property
|
||||
*
|
||||
* @function ICAL.parse.property
|
||||
* @param {String} str
|
||||
* The iCalendar property string to parse
|
||||
* @param {designSet=} designSet
|
||||
* The design data to use for this property
|
||||
* @return {Object}
|
||||
* The jCal Object containing the property
|
||||
*/
|
||||
export function property(str: string, designSet?: import("./types.js").designSet): any;
|
||||
/**
|
||||
* Convenience method to parse a component. You can use ICAL.parse() directly
|
||||
* instead.
|
||||
*
|
||||
* @function ICAL.parse.component
|
||||
* @see ICAL.parse(function)
|
||||
* @param {String} str The iCalendar component string to parse
|
||||
* @return {Object} The jCal Object containing the component
|
||||
*/
|
||||
export function component(str: string): any;
|
||||
export { ParserError };
|
||||
/**
|
||||
* Handles a single line of iCalendar/vCard, updating the state.
|
||||
*
|
||||
* @private
|
||||
* @function ICAL.parse._handleContentLine
|
||||
* @param {String} line The content line to process
|
||||
* @param {parserState} state The current state of the line parsing
|
||||
*/
|
||||
export function _handleContentLine(line: string, state: import("./types.js").parserState): void;
|
||||
/**
|
||||
* Parse a value from the raw value into the jCard/jCal value.
|
||||
*
|
||||
* @private
|
||||
* @function ICAL.parse._parseValue
|
||||
* @param {String} value Original value
|
||||
* @param {String} type Type of value
|
||||
* @param {Object} designSet The design data to use for this value
|
||||
* @return {Object} varies on type
|
||||
*/
|
||||
export function _parseValue(value: string, type: string, designSet: any, structuredValue: any): any;
|
||||
/**
|
||||
* Parse parameters from a string to object.
|
||||
*
|
||||
* @function ICAL.parse._parseParameters
|
||||
* @private
|
||||
* @param {String} line A single unfolded line
|
||||
* @param {Number} start Position to start looking for properties
|
||||
* @param {Object} designSet The design data to use for this property
|
||||
* @return {Array} Array containing key/valye pairs of parsed parameters, the
|
||||
* parsed value, and the position of the last parameter found
|
||||
*/
|
||||
export function _parseParameters(line: string, start: number, designSet: any): any[];
|
||||
/**
|
||||
* Internal helper for rfc6868. Exposing this on ICAL.parse so that
|
||||
* hackers can disable the rfc6868 parsing if the really need to.
|
||||
*
|
||||
* @function ICAL.parse._rfc6868Escape
|
||||
* @param {String} val The value to escape
|
||||
* @return {String} The escaped value
|
||||
*/
|
||||
export function _rfc6868Escape(val: string): string;
|
||||
/**
|
||||
* Parse a multi value string. This function is used either for parsing
|
||||
* actual multi-value property's values, or for handling parameter values. It
|
||||
* can be used for both multi-value properties and structured value properties.
|
||||
*
|
||||
* @private
|
||||
* @function ICAL.parse._parseMultiValue
|
||||
* @param {String} buffer The buffer containing the full value
|
||||
* @param {String} delim The multi-value delimiter
|
||||
* @param {String} type The value type to be parsed
|
||||
* @param {Array.<?>} result The array to append results to, varies on value type
|
||||
* @param {String} innerMulti The inner delimiter to split each value with
|
||||
* @param {designSet} designSet The design data for this value
|
||||
* @return {?|Array.<?>} Either an array of results, or the first result
|
||||
*/
|
||||
export function _parseMultiValue(buffer: string, delim: string, type: string, result: any[], innerMulti: string, designSet: import("./types.js").designSet, structuredValue: any): any;
|
||||
/**
|
||||
* Process a complete buffer of iCalendar/vCard data line by line, correctly
|
||||
* unfolding content. Each line will be processed with the given callback
|
||||
*
|
||||
* @private
|
||||
* @function ICAL.parse._eachLine
|
||||
* @param {String} buffer The buffer to process
|
||||
* @param {function(?String, String)} callback The callback for each line
|
||||
*/
|
||||
export function _eachLine(buffer: string, callback: (arg0: string, arg1: string) => any): void;
|
||||
}
|
||||
export default parse;
|
||||
/**
|
||||
* Imports the 'parserState' type from the "types.js" module
|
||||
*/
|
||||
export type parserState = import("./types.js").parserState;
|
||||
/**
|
||||
* Imports the 'designSet' type from the "types.js" module
|
||||
*/
|
||||
export type designSet = import("./types.js").designSet;
|
||||
/**
|
||||
* An error that occurred during parsing.
|
||||
*
|
||||
* @param {String} message The error message
|
||||
* @memberof ICAL.parse
|
||||
* @extends {Error}
|
||||
*/
|
||||
declare class ParserError extends Error {
|
||||
}
|
||||
//# sourceMappingURL=parse.d.ts.map
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"version":3,"file":"parse.d.ts","sourceRoot":"","sources":["../../lib/ical/parse.js"],"names":[],"mappings":"AA4BA;;;;;;;;;;;GAWG;AACH,uCAFY,MAAO,KAAQ,CAyB1B;;IAED;;;;;;;;;;OAUG;IACH,uFAOC;IAED;;;;;;;;OAQG;IACH,4CAEC;;IAkBD;;;;;;;OAOG;IACH,gGA+KC;IAED;;;;;;;;;OASG;IACH,oGAKC;IAED;;;;;;;;;;OAUG;IACH,qFAkHC;IAED;;;;;;;OAOG;IACH,oDAIC;IAED;;;;;;;;;;;;;;OAcG;IACH,uLA8BC;IAED;;;;;;;;OAQG;IACH,+FA2CC;;;;;;0BA9hBY,OAAO,YAAY,EAAE,WAAW;;;;wBAEhC,OAAO,YAAY,EAAE,SAAS;AAmF3C;;;;;;GAMG;AACH;CAEC"}
|
||||
+146
@@ -0,0 +1,146 @@
|
||||
export default Period;
|
||||
/**
|
||||
* Imports the 'occurrenceDetails' type from the "types.js" module
|
||||
*/
|
||||
export type jCalComponent = import("./types.js").jCalComponent;
|
||||
/**
|
||||
* This lets typescript resolve our custom types in the
|
||||
* generated d.ts files (jsdoc typedefs are converted to typescript types).
|
||||
* Ignore prevents the typedefs from being documented more than once.
|
||||
* @ignore
|
||||
* @typedef {import("./types.js").jCalComponent} jCalComponent
|
||||
* Imports the 'occurrenceDetails' type from the "types.js" module
|
||||
*/
|
||||
/**
|
||||
* This class represents the "period" value type, with various calculation and manipulation methods.
|
||||
*
|
||||
* @memberof ICAL
|
||||
*/
|
||||
declare class Period {
|
||||
/**
|
||||
* Creates a new {@link ICAL.Period} instance from the passed string.
|
||||
*
|
||||
* @param {String} str The string to parse
|
||||
* @param {Property} prop The property this period will be on
|
||||
* @return {Period} The created period instance
|
||||
*/
|
||||
static fromString(str: string, prop: Property): Period;
|
||||
/**
|
||||
* Creates a new {@link ICAL.Period} instance from the given data object.
|
||||
* The passed data object cannot contain both and end date and a duration.
|
||||
*
|
||||
* @param {Object} aData An object with members of the period
|
||||
* @param {Time=} aData.start The start of the period
|
||||
* @param {Time=} aData.end The end of the period
|
||||
* @param {Duration=} aData.duration The duration of the period
|
||||
* @return {Period} The period instance
|
||||
*/
|
||||
static fromData(aData: {
|
||||
start?: Time | undefined;
|
||||
end?: Time | undefined;
|
||||
duration?: Duration | undefined;
|
||||
}): Period;
|
||||
/**
|
||||
* Returns a new period instance from the given jCal data array. The first
|
||||
* member is always the start date string, the second member is either a
|
||||
* duration or end date string.
|
||||
*
|
||||
* @param {jCalComponent} aData The jCal data array
|
||||
* @param {Property} aProp The property this jCal data is on
|
||||
* @param {Boolean} aLenient If true, data value can be both date and date-time
|
||||
* @return {Period} The period instance
|
||||
*/
|
||||
static fromJSON(aData: import("./types.js").jCalComponent, aProp: Property, aLenient: boolean): Period;
|
||||
/**
|
||||
* Creates a new ICAL.Period instance. The passed data object cannot contain both and end date and
|
||||
* a duration.
|
||||
*
|
||||
* @param {Object} aData An object with members of the period
|
||||
* @param {Time=} aData.start The start of the period
|
||||
* @param {Time=} aData.end The end of the period
|
||||
* @param {Duration=} aData.duration The duration of the period
|
||||
*/
|
||||
constructor(aData: {
|
||||
start?: Time | undefined;
|
||||
end?: Time | undefined;
|
||||
duration?: Duration | undefined;
|
||||
});
|
||||
wrappedJSObject: this;
|
||||
/**
|
||||
* The start of the period
|
||||
* @type {Time}
|
||||
*/
|
||||
start: Time;
|
||||
/**
|
||||
* The end of the period
|
||||
* @type {Time}
|
||||
*/
|
||||
end: Time;
|
||||
/**
|
||||
* The duration of the period
|
||||
* @type {Duration}
|
||||
*/
|
||||
duration: Duration;
|
||||
/**
|
||||
* The class identifier.
|
||||
* @constant
|
||||
* @type {String}
|
||||
* @default "icalperiod"
|
||||
*/
|
||||
icalclass: string;
|
||||
/**
|
||||
* The type name, to be used in the jCal object.
|
||||
* @constant
|
||||
* @type {String}
|
||||
* @default "period"
|
||||
*/
|
||||
icaltype: string;
|
||||
/**
|
||||
* Returns a clone of the duration object.
|
||||
*
|
||||
* @return {Period} The cloned object
|
||||
*/
|
||||
clone(): Period;
|
||||
/**
|
||||
* Calculates the duration of the period, either directly or by subtracting
|
||||
* start from end date.
|
||||
*
|
||||
* @return {Duration} The calculated duration
|
||||
*/
|
||||
getDuration(): Duration;
|
||||
/**
|
||||
* Calculates the end date of the period, either directly or by adding
|
||||
* duration to start date.
|
||||
*
|
||||
* @return {Time} The calculated end date
|
||||
*/
|
||||
getEnd(): Time;
|
||||
/**
|
||||
* Compare this period with a date or other period. To maintain the logic where a.compare(b)
|
||||
* returns 1 when a > b, this function will return 1 when the period is after the date, 0 when the
|
||||
* date is within the period, and -1 when the period is before the date. When comparing two
|
||||
* periods, as soon as they overlap in any way this will return 0.
|
||||
*
|
||||
* @param {Time|Period} dt The date or other period to compare with
|
||||
*/
|
||||
compare(dt: Time | Period): 0 | 1 | -1;
|
||||
/**
|
||||
* The string representation of this period.
|
||||
* @return {String}
|
||||
*/
|
||||
toString(): string;
|
||||
/**
|
||||
* The jCal representation of this period type.
|
||||
* @return {Object}
|
||||
*/
|
||||
toJSON(): any;
|
||||
/**
|
||||
* The iCalendar string representation of this period.
|
||||
* @return {String}
|
||||
*/
|
||||
toICALString(): string;
|
||||
}
|
||||
import Time from "./time.js";
|
||||
import Duration from "./duration.js";
|
||||
import Property from "./property.js";
|
||||
//# sourceMappingURL=period.d.ts.map
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"version":3,"file":"period.d.ts","sourceRoot":"","sources":["../../lib/ical/period.js"],"names":[],"mappings":";;;;4BAgBa,OAAO,YAAY,EAAE,aAAa;AAL/C;;;;;;;GAOG;AAEH;;;;GAIG;AACH;IACE;;;;;;OAMG;IACH,qCAHW,QAAQ,GACP,MAAM,CAwBjB;IAED;;;;;;;;;OASG;IACH;QALwB,KAAK,GAAlB,IAAI;QACS,GAAG,GAAhB,IAAI;QACa,QAAQ,GAAzB,QAAQ;QACP,MAAM,CAIjB;IAED;;;;;;;;;OASG;IACH,kEAJW,QAAQ,sBAEP,MAAM,CAsBjB;IAED;;;;;;;;OAQG;IACH;QAJwB,KAAK,GAAlB,IAAI;QACS,GAAG,GAAhB,IAAI;QACa,QAAQ,GAAzB,QAAQ;OA6BlB;IA1BC,sBAA2B;IA6B7B;;;OAGG;IACH,OAFU,IAAI,CAED;IAEb;;;OAGG;IACH,KAFU,IAAI,CAEH;IAEX;;;OAGG;IACH,UAFU,QAAQ,CAEF;IAEhB;;;;;OAKG;IACH,kBAAyB;IAEzB;;;;;OAKG;IACH,iBAAoB;IAEpB;;;;OAIG;IACH,SAFY,MAAM,CAQjB;IAED;;;;;OAKG;IACH,eAFY,QAAQ,CAQnB;IAED;;;;;OAKG;IACH,UAFY,IAAI,CAUf;IAED;;;;;;;OAOG;IACH,YAFW,IAAI,GAAC,MAAM,cAUrB;IAED;;;OAGG;IACH,mBAEC;IAED;;;OAGG;IACH,cAEC;IAED;;;OAGG;IACH,uBAGC;CACF;iBAhQgB,WAAW;qBACP,eAAe;qBAGf,eAAe"}
|
||||
+209
@@ -0,0 +1,209 @@
|
||||
export default Property;
|
||||
/**
|
||||
* Imports the 'designSet' type from the "types.js" module
|
||||
*/
|
||||
export type designSet = import("./types.js").designSet;
|
||||
/**
|
||||
* Imports the 'Geo' type from the "types.js" module
|
||||
*/
|
||||
export type Geo = import("./types.js").Geo;
|
||||
/**
|
||||
* This lets typescript resolve our custom types in the
|
||||
* generated d.ts files (jsdoc typedefs are converted to typescript types).
|
||||
* Ignore prevents the typedefs from being documented more than once.
|
||||
* @ignore
|
||||
* @typedef {import("./types.js").designSet} designSet
|
||||
* Imports the 'designSet' type from the "types.js" module
|
||||
* @typedef {import("./types.js").Geo} Geo
|
||||
* Imports the 'Geo' type from the "types.js" module
|
||||
*/
|
||||
/**
|
||||
* Provides a layer on top of the raw jCal object for manipulating a single property, with its
|
||||
* parameters and value.
|
||||
*
|
||||
* @memberof ICAL
|
||||
*/
|
||||
declare class Property {
|
||||
/**
|
||||
* Create an {@link ICAL.Property} by parsing the passed iCalendar string.
|
||||
*
|
||||
* @param {String} str The iCalendar string to parse
|
||||
* @param {designSet=} designSet The design data to use for this property
|
||||
* @return {Property} The created iCalendar property
|
||||
*/
|
||||
static fromString(str: string, designSet?: designSet | undefined): Property;
|
||||
/**
|
||||
* Creates a new ICAL.Property instance.
|
||||
*
|
||||
* It is important to note that mutations done in the wrapper directly mutate the jCal object used
|
||||
* to initialize.
|
||||
*
|
||||
* Can also be used to create new properties by passing the name of the property (as a String).
|
||||
*
|
||||
* @param {Array|String} jCal Raw jCal representation OR the new name of the property
|
||||
* @param {Component=} parent Parent component
|
||||
*/
|
||||
constructor(jCal: any[] | string, parent?: Component | undefined);
|
||||
_parent: Component;
|
||||
jCal: any[];
|
||||
/**
|
||||
* The value type for this property
|
||||
* @type {String}
|
||||
*/
|
||||
get type(): string;
|
||||
/**
|
||||
* The name of this property, in lowercase.
|
||||
* @type {String}
|
||||
*/
|
||||
get name(): string;
|
||||
set parent(p: Component);
|
||||
/**
|
||||
* The parent component for this property.
|
||||
* @type {Component}
|
||||
*/
|
||||
get parent(): Component;
|
||||
/**
|
||||
* The design set for this property, e.g. icalendar vs vcard
|
||||
*
|
||||
* @type {designSet}
|
||||
* @private
|
||||
*/
|
||||
private get _designSet();
|
||||
/**
|
||||
* Updates the type metadata from the current jCal type and design set.
|
||||
*
|
||||
* @private
|
||||
*/
|
||||
private _updateType;
|
||||
isDecorated: boolean;
|
||||
isMultiValue: boolean;
|
||||
isStructuredValue: boolean;
|
||||
/**
|
||||
* Hydrate a single value. The act of hydrating means turning the raw jCal
|
||||
* value into a potentially wrapped object, for example {@link ICAL.Time}.
|
||||
*
|
||||
* @private
|
||||
* @param {Number} index The index of the value to hydrate
|
||||
* @return {?Object} The decorated value.
|
||||
*/
|
||||
private _hydrateValue;
|
||||
_values: any[];
|
||||
/**
|
||||
* Decorate a single value, returning its wrapped object. This is used by
|
||||
* the hydrate function to actually wrap the value.
|
||||
*
|
||||
* @private
|
||||
* @param {?} value The value to decorate
|
||||
* @return {Object} The decorated value
|
||||
*/
|
||||
private _decorate;
|
||||
/**
|
||||
* Undecorate a single value, returning its raw jCal data.
|
||||
*
|
||||
* @private
|
||||
* @param {Object} value The value to undecorate
|
||||
* @return {?} The undecorated value
|
||||
*/
|
||||
private _undecorate;
|
||||
/**
|
||||
* Sets the value at the given index while also hydrating it. The passed
|
||||
* value can either be a decorated or undecorated value.
|
||||
*
|
||||
* @private
|
||||
* @param {?} value The value to set
|
||||
* @param {Number} index The index to set it at
|
||||
*/
|
||||
private _setDecoratedValue;
|
||||
/**
|
||||
* Gets a parameter on the property.
|
||||
*
|
||||
* @param {String} name Parameter name (lowercase)
|
||||
* @return {Array|String} Parameter value
|
||||
*/
|
||||
getParameter(name: string): any[] | string;
|
||||
/**
|
||||
* Gets first parameter on the property.
|
||||
*
|
||||
* @param {String} name Parameter name (lowercase)
|
||||
* @return {String} Parameter value
|
||||
*/
|
||||
getFirstParameter(name: string): string;
|
||||
/**
|
||||
* Sets a parameter on the property.
|
||||
*
|
||||
* @param {String} name The parameter name
|
||||
* @param {Array|String} value The parameter value
|
||||
*/
|
||||
setParameter(name: string, value: any[] | string): void;
|
||||
/**
|
||||
* Removes a parameter
|
||||
*
|
||||
* @param {String} name The parameter name
|
||||
*/
|
||||
removeParameter(name: string): void;
|
||||
/**
|
||||
* Get the default type based on this property's name.
|
||||
*
|
||||
* @return {String} The default type for this property
|
||||
*/
|
||||
getDefaultType(): string;
|
||||
/**
|
||||
* Sets type of property and clears out any existing values of the current
|
||||
* type.
|
||||
*
|
||||
* @param {String} type New iCAL type (see design.*.values)
|
||||
*/
|
||||
resetType(type: string): void;
|
||||
/**
|
||||
* Finds the first property value.
|
||||
*
|
||||
* @return {Binary | Duration | Period |
|
||||
* Recur | Time | UtcOffset | Geo | string | null} First property value
|
||||
*/
|
||||
getFirstValue(): Binary | Duration | Period | Recur | Time | UtcOffset | import("./types.js").Geo | string | null;
|
||||
/**
|
||||
* Gets all values on the property.
|
||||
*
|
||||
* NOTE: this creates an array during each call.
|
||||
*
|
||||
* @return {Array} List of values
|
||||
*/
|
||||
getValues(): any[];
|
||||
/**
|
||||
* Removes all values from this property
|
||||
*/
|
||||
removeAllValues(): void;
|
||||
/**
|
||||
* Sets the values of the property. Will overwrite the existing values.
|
||||
* This can only be used for multi-value properties.
|
||||
*
|
||||
* @param {Array} values An array of values
|
||||
*/
|
||||
setValues(values: any[]): void;
|
||||
/**
|
||||
* Sets the current value of the property. If this is a multi-value
|
||||
* property, all other values will be removed.
|
||||
*
|
||||
* @param {String|Object} value New property value.
|
||||
*/
|
||||
setValue(value: string | any): void;
|
||||
/**
|
||||
* Returns the Object representation of this component. The returned object
|
||||
* is a live jCal object and should be cloned if modified.
|
||||
* @return {Object}
|
||||
*/
|
||||
toJSON(): any;
|
||||
/**
|
||||
* The string representation of this component.
|
||||
* @return {String}
|
||||
*/
|
||||
toICALString(): string;
|
||||
}
|
||||
import Component from "./component.js";
|
||||
import Binary from "./binary.js";
|
||||
import Duration from "./duration.js";
|
||||
import Period from "./period.js";
|
||||
import Recur from "./recur.js";
|
||||
import Time from "./time.js";
|
||||
import UtcOffset from "./utc_offset.js";
|
||||
//# sourceMappingURL=property.d.ts.map
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"version":3,"file":"property.d.ts","sourceRoot":"","sources":["../../lib/ical/property.js"],"names":[],"mappings":";;;;wBAyCa,OAAO,YAAY,EAAE,SAAS;;;;kBAE9B,OAAO,YAAY,EAAE,GAAG;AAPrC;;;;;;;;;GASG;AAEH;;;;;GAKG;AACH;IACE;;;;;;OAMG;IACH,2CAHW,SAAS,eACR,QAAQ,CAInB;IAED;;;;;;;;;;OAUG;IACH,kBAHW,cAAY,WACZ,SAAS,cAanB;IAVC,mBAA6B;IAI3B,YAA0C;IAQ9C;;;OAGG;IACH,mBAEC;IAED;;;OAGG;IACH,mBAEC;IAUD,yBAWC;IAnBD;;;OAGG;IACH,wBAEC;IAeD;;;;;OAKG;IACH,yBAEC;IAED;;;;OAIG;IACH,oBAeC;IAVK,qBAAuB;IAMvB,sBAAmE;IACnE,2BAA6E;IAKnF;;;;;;;OAOG;IACH,sBAoBC;IARK,eAAiB;IAUvB;;;;;;;OAOG;IACH,kBAEC;IAED;;;;;;OAMG;IACH,oBAEC;IAED;;;;;;;OAOG;IACH,2BAcC;IAED;;;;;OAKG;IACH,4BAFY,cAAY,CAQvB;IAED;;;;;OAKG;IACH,wCAQC;IAED;;;;;OAKG;IACH,kCAFW,cAAY,QAUtB;IAED;;;;OAIG;IACH,oCAEC;IAED;;;;OAIG;IACH,yBAWC;IAED;;;;;OAKG;IACH,8BAIC;IAED;;;;;OAKG;IACH,iBAHY,MAAM,GAAG,QAAQ,GAAG,MAAM,GACrC,KAAO,GAAG,IAAI,GAAG,SAAS,8BAAS,MAAM,GAAG,IAAI,CAIhD;IAED;;;;;;OAMG;IACH,mBAgBC;IAED;;OAEG;IACH,wBAKC;IAED;;;;;OAKG;IACH,+BA2BC;IAED;;;;;OAKG;IACH,gBAFW,YAAa,QAavB;IAED;;;;OAIG;IACH,cAEC;IAED;;;OAGG;IACH,uBAIC;CACF;sBAraqB,gBAAgB;mBASnB,aAAa;qBANX,eAAe;mBASjB,aAAa;kBAGd,YAAY;iBAGb,WAAW;sBAZN,iBAAiB"}
|
||||
+348
@@ -0,0 +1,348 @@
|
||||
export default Recur;
|
||||
/**
|
||||
* Imports the 'weekDay' type from the "types.js" module
|
||||
*/
|
||||
export type weekDay = import("./types.js").weekDay;
|
||||
/**
|
||||
* Imports the 'frequencyValues' type from the "types.js" module
|
||||
*/
|
||||
export type frequencyValues = import("./types.js").frequencyValues;
|
||||
/**
|
||||
* This class represents the "recur" value type, used for example by RRULE. It provides methods to
|
||||
* calculate occurrences among others.
|
||||
*
|
||||
* @memberof ICAL
|
||||
*/
|
||||
declare class Recur {
|
||||
/**
|
||||
* Creates a new {@link ICAL.Recur} instance from the passed string.
|
||||
*
|
||||
* @param {String} string The string to parse
|
||||
* @return {Recur} The created recurrence instance
|
||||
*/
|
||||
static fromString(string: string): Recur;
|
||||
/**
|
||||
* Creates a new {@link ICAL.Recur} instance using members from the passed
|
||||
* data object.
|
||||
*
|
||||
* @param {Object} aData An object with members of the recurrence
|
||||
* @param {frequencyValues=} aData.freq The frequency value
|
||||
* @param {Number=} aData.interval The INTERVAL value
|
||||
* @param {weekDay=} aData.wkst The week start value
|
||||
* @param {Time=} aData.until The end of the recurrence set
|
||||
* @param {Number=} aData.count The number of occurrences
|
||||
* @param {Array.<Number>=} aData.bysecond The seconds for the BYSECOND part
|
||||
* @param {Array.<Number>=} aData.byminute The minutes for the BYMINUTE part
|
||||
* @param {Array.<Number>=} aData.byhour The hours for the BYHOUR part
|
||||
* @param {Array.<String>=} aData.byday The BYDAY values
|
||||
* @param {Array.<Number>=} aData.bymonthday The days for the BYMONTHDAY part
|
||||
* @param {Array.<Number>=} aData.byyearday The days for the BYYEARDAY part
|
||||
* @param {Array.<Number>=} aData.byweekno The weeks for the BYWEEKNO part
|
||||
* @param {Array.<Number>=} aData.bymonth The month for the BYMONTH part
|
||||
* @param {Array.<Number>=} aData.bysetpos The positionals for the BYSETPOS part
|
||||
*/
|
||||
static fromData(aData: {
|
||||
freq?: frequencyValues | undefined;
|
||||
interval?: number | undefined;
|
||||
wkst?: weekDay | undefined;
|
||||
until?: Time | undefined;
|
||||
count?: number | undefined;
|
||||
bysecond?: Array<number> | undefined;
|
||||
byminute?: Array<number> | undefined;
|
||||
byhour?: Array<number> | undefined;
|
||||
byday?: Array<string> | undefined;
|
||||
bymonthday?: Array<number> | undefined;
|
||||
byyearday?: Array<number> | undefined;
|
||||
byweekno?: Array<number> | undefined;
|
||||
bymonth?: Array<number> | undefined;
|
||||
bysetpos?: Array<number> | undefined;
|
||||
}): Recur;
|
||||
/**
|
||||
* Converts a recurrence string to a data object, suitable for the fromData
|
||||
* method.
|
||||
*
|
||||
* @private
|
||||
* @param {String} string The string to parse
|
||||
* @param {Boolean} fmtIcal If true, the string is considered to be an
|
||||
* iCalendar string
|
||||
* @return {Recur} The recurrence instance
|
||||
*/
|
||||
private static _stringToData;
|
||||
/**
|
||||
* Convert an ical representation of a day (SU, MO, etc..)
|
||||
* into a numeric value of that day.
|
||||
*
|
||||
* @param {String} string The iCalendar day name
|
||||
* @param {weekDay=} aWeekStart
|
||||
* The week start weekday, defaults to SUNDAY
|
||||
* @return {Number} Numeric value of given day
|
||||
*/
|
||||
static icalDayToNumericDay(string: string, aWeekStart?: weekDay | undefined): number;
|
||||
/**
|
||||
* Convert a numeric day value into its ical representation (SU, MO, etc..)
|
||||
*
|
||||
* @param {Number} num Numeric value of given day
|
||||
* @param {weekDay=} aWeekStart
|
||||
* The week start weekday, defaults to SUNDAY
|
||||
* @return {String} The ICAL day value, e.g SU,MO,...
|
||||
*/
|
||||
static numericDayToIcalDay(num: number, aWeekStart?: weekDay | undefined): string;
|
||||
/**
|
||||
* Create a new instance of the Recur class.
|
||||
*
|
||||
* @param {Object} data An object with members of the recurrence
|
||||
* @param {frequencyValues=} data.freq The frequency value
|
||||
* @param {Number=} data.interval The INTERVAL value
|
||||
* @param {weekDay=} data.wkst The week start value
|
||||
* @param {Time=} data.until The end of the recurrence set
|
||||
* @param {Number=} data.count The number of occurrences
|
||||
* @param {Array.<Number>=} data.bysecond The seconds for the BYSECOND part
|
||||
* @param {Array.<Number>=} data.byminute The minutes for the BYMINUTE part
|
||||
* @param {Array.<Number>=} data.byhour The hours for the BYHOUR part
|
||||
* @param {Array.<String>=} data.byday The BYDAY values
|
||||
* @param {Array.<Number>=} data.bymonthday The days for the BYMONTHDAY part
|
||||
* @param {Array.<Number>=} data.byyearday The days for the BYYEARDAY part
|
||||
* @param {Array.<Number>=} data.byweekno The weeks for the BYWEEKNO part
|
||||
* @param {Array.<Number>=} data.bymonth The month for the BYMONTH part
|
||||
* @param {Array.<Number>=} data.bysetpos The positionals for the BYSETPOS part
|
||||
*/
|
||||
constructor(data: {
|
||||
freq?: frequencyValues | undefined;
|
||||
interval?: number | undefined;
|
||||
wkst?: weekDay | undefined;
|
||||
until?: Time | undefined;
|
||||
count?: number | undefined;
|
||||
bysecond?: Array<number> | undefined;
|
||||
byminute?: Array<number> | undefined;
|
||||
byhour?: Array<number> | undefined;
|
||||
byday?: Array<string> | undefined;
|
||||
bymonthday?: Array<number> | undefined;
|
||||
byyearday?: Array<number> | undefined;
|
||||
byweekno?: Array<number> | undefined;
|
||||
bymonth?: Array<number> | undefined;
|
||||
bysetpos?: Array<number> | undefined;
|
||||
});
|
||||
wrappedJSObject: this;
|
||||
/**
|
||||
* An object holding the BY-parts of the recurrence rule
|
||||
* @memberof ICAL.Recur
|
||||
* @typedef {Object} byParts
|
||||
* @property {Array.<Number>=} BYSECOND The seconds for the BYSECOND part
|
||||
* @property {Array.<Number>=} BYMINUTE The minutes for the BYMINUTE part
|
||||
* @property {Array.<Number>=} BYHOUR The hours for the BYHOUR part
|
||||
* @property {Array.<String>=} BYDAY The BYDAY values
|
||||
* @property {Array.<Number>=} BYMONTHDAY The days for the BYMONTHDAY part
|
||||
* @property {Array.<Number>=} BYYEARDAY The days for the BYYEARDAY part
|
||||
* @property {Array.<Number>=} BYWEEKNO The weeks for the BYWEEKNO part
|
||||
* @property {Array.<Number>=} BYMONTH The month for the BYMONTH part
|
||||
* @property {Array.<Number>=} BYSETPOS The positionals for the BYSETPOS part
|
||||
*/
|
||||
/**
|
||||
* An object holding the BY-parts of the recurrence rule
|
||||
* @type {byParts}
|
||||
*/
|
||||
parts: {
|
||||
/**
|
||||
* The seconds for the BYSECOND part
|
||||
*/
|
||||
BYSECOND?: Array<number> | undefined;
|
||||
/**
|
||||
* The minutes for the BYMINUTE part
|
||||
*/
|
||||
BYMINUTE?: Array<number> | undefined;
|
||||
/**
|
||||
* The hours for the BYHOUR part
|
||||
*/
|
||||
BYHOUR?: Array<number> | undefined;
|
||||
/**
|
||||
* The BYDAY values
|
||||
*/
|
||||
BYDAY?: Array<string> | undefined;
|
||||
/**
|
||||
* The days for the BYMONTHDAY part
|
||||
*/
|
||||
BYMONTHDAY?: Array<number> | undefined;
|
||||
/**
|
||||
* The days for the BYYEARDAY part
|
||||
*/
|
||||
BYYEARDAY?: Array<number> | undefined;
|
||||
/**
|
||||
* The weeks for the BYWEEKNO part
|
||||
*/
|
||||
BYWEEKNO?: Array<number> | undefined;
|
||||
/**
|
||||
* The month for the BYMONTH part
|
||||
*/
|
||||
BYMONTH?: Array<number> | undefined;
|
||||
/**
|
||||
* The positionals for the BYSETPOS part
|
||||
*/
|
||||
BYSETPOS?: Array<number> | undefined;
|
||||
};
|
||||
/**
|
||||
* The interval value for the recurrence rule.
|
||||
* @type {Number}
|
||||
*/
|
||||
interval: number;
|
||||
/**
|
||||
* The week start day
|
||||
*
|
||||
* @type {weekDay}
|
||||
* @default ICAL.Time.MONDAY
|
||||
*/
|
||||
wkst: weekDay;
|
||||
/**
|
||||
* The end of the recurrence
|
||||
* @type {?Time}
|
||||
*/
|
||||
until: Time | null;
|
||||
/**
|
||||
* The maximum number of occurrences
|
||||
* @type {?Number}
|
||||
*/
|
||||
count: number | null;
|
||||
/**
|
||||
* The frequency value.
|
||||
* @type {frequencyValues}
|
||||
*/
|
||||
freq: frequencyValues;
|
||||
/**
|
||||
* The class identifier.
|
||||
* @constant
|
||||
* @type {String}
|
||||
* @default "icalrecur"
|
||||
*/
|
||||
icalclass: string;
|
||||
/**
|
||||
* The type name, to be used in the jCal object.
|
||||
* @constant
|
||||
* @type {String}
|
||||
* @default "recur"
|
||||
*/
|
||||
icaltype: string;
|
||||
/**
|
||||
* Create a new iterator for this recurrence rule. The passed start date
|
||||
* must be the start date of the event, not the start of the range to
|
||||
* search in.
|
||||
*
|
||||
* @example
|
||||
* let recur = comp.getFirstPropertyValue('rrule');
|
||||
* let dtstart = comp.getFirstPropertyValue('dtstart');
|
||||
* let iter = recur.iterator(dtstart);
|
||||
* for (let next = iter.next(); next; next = iter.next()) {
|
||||
* if (next.compare(rangeStart) < 0) {
|
||||
* continue;
|
||||
* }
|
||||
* console.log(next.toString());
|
||||
* }
|
||||
*
|
||||
* @param {Time} aStart The item's start date
|
||||
* @return {RecurIterator} The recurrence iterator
|
||||
*/
|
||||
iterator(aStart: Time): RecurIterator;
|
||||
/**
|
||||
* Returns a clone of the recurrence object.
|
||||
*
|
||||
* @return {Recur} The cloned object
|
||||
*/
|
||||
clone(): Recur;
|
||||
/**
|
||||
* Checks if the current rule is finite, i.e. has a count or until part.
|
||||
*
|
||||
* @return {Boolean} True, if the rule is finite
|
||||
*/
|
||||
isFinite(): boolean;
|
||||
/**
|
||||
* Checks if the current rule has a count part, and not limited by an until
|
||||
* part.
|
||||
*
|
||||
* @return {Boolean} True, if the rule is by count
|
||||
*/
|
||||
isByCount(): boolean;
|
||||
/**
|
||||
* Adds a component (part) to the recurrence rule. This is not a component
|
||||
* in the sense of {@link ICAL.Component}, but a part of the recurrence
|
||||
* rule, i.e. BYMONTH.
|
||||
*
|
||||
* @param {String} aType The name of the component part
|
||||
* @param {Array|String} aValue The component value
|
||||
*/
|
||||
addComponent(aType: string, aValue: any[] | string): void;
|
||||
/**
|
||||
* Sets the component value for the given by-part.
|
||||
*
|
||||
* @param {String} aType The component part name
|
||||
* @param {Array} aValues The component values
|
||||
*/
|
||||
setComponent(aType: string, aValues: any[]): void;
|
||||
/**
|
||||
* Gets (a copy) of the requested component value.
|
||||
*
|
||||
* @param {String} aType The component part name
|
||||
* @return {Array} The component part value
|
||||
*/
|
||||
getComponent(aType: string): any[];
|
||||
/**
|
||||
* Retrieves the next occurrence after the given recurrence id. See the
|
||||
* guide on {@tutorial terminology} for more details.
|
||||
*
|
||||
* NOTE: Currently, this method iterates all occurrences from the start
|
||||
* date. It should not be called in a loop for performance reasons. If you
|
||||
* would like to get more than one occurrence, you can iterate the
|
||||
* occurrences manually, see the example on the
|
||||
* {@link ICAL.Recur#iterator iterator} method.
|
||||
*
|
||||
* @param {Time} aStartTime The start of the event series
|
||||
* @param {Time} aRecurrenceId The date of the last occurrence
|
||||
* @return {Time} The next occurrence after
|
||||
*/
|
||||
getNextOccurrence(aStartTime: Time, aRecurrenceId: Time): Time;
|
||||
/**
|
||||
* Sets up the current instance using members from the passed data object.
|
||||
*
|
||||
* @param {Object} data An object with members of the recurrence
|
||||
* @param {frequencyValues=} data.freq The frequency value
|
||||
* @param {Number=} data.interval The INTERVAL value
|
||||
* @param {weekDay=} data.wkst The week start value
|
||||
* @param {Time=} data.until The end of the recurrence set
|
||||
* @param {Number=} data.count The number of occurrences
|
||||
* @param {Array.<Number>=} data.bysecond The seconds for the BYSECOND part
|
||||
* @param {Array.<Number>=} data.byminute The minutes for the BYMINUTE part
|
||||
* @param {Array.<Number>=} data.byhour The hours for the BYHOUR part
|
||||
* @param {Array.<String>=} data.byday The BYDAY values
|
||||
* @param {Array.<Number>=} data.bymonthday The days for the BYMONTHDAY part
|
||||
* @param {Array.<Number>=} data.byyearday The days for the BYYEARDAY part
|
||||
* @param {Array.<Number>=} data.byweekno The weeks for the BYWEEKNO part
|
||||
* @param {Array.<Number>=} data.bymonth The month for the BYMONTH part
|
||||
* @param {Array.<Number>=} data.bysetpos The positionals for the BYSETPOS part
|
||||
*/
|
||||
fromData(data: {
|
||||
freq?: frequencyValues | undefined;
|
||||
interval?: number | undefined;
|
||||
wkst?: weekDay | undefined;
|
||||
until?: Time | undefined;
|
||||
count?: number | undefined;
|
||||
bysecond?: Array<number> | undefined;
|
||||
byminute?: Array<number> | undefined;
|
||||
byhour?: Array<number> | undefined;
|
||||
byday?: Array<string> | undefined;
|
||||
bymonthday?: Array<number> | undefined;
|
||||
byyearday?: Array<number> | undefined;
|
||||
byweekno?: Array<number> | undefined;
|
||||
bymonth?: Array<number> | undefined;
|
||||
bysetpos?: Array<number> | undefined;
|
||||
}): void;
|
||||
/**
|
||||
* The jCal representation of this recurrence type.
|
||||
* @return {Object}
|
||||
*/
|
||||
toJSON(): any;
|
||||
/**
|
||||
* The string representation of this recurrence rule.
|
||||
* @return {String}
|
||||
*/
|
||||
toString(): string;
|
||||
}
|
||||
import Time from "./time.js";
|
||||
import RecurIterator from "./recur_iterator.js";
|
||||
//# sourceMappingURL=recur.d.ts.map
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"version":3,"file":"recur.d.ts","sourceRoot":"","sources":["../../lib/ical/recur.js"],"names":[],"mappings":";;;;sBAgBa,OAAO,YAAY,EAAE,OAAO;;;;8BAE5B,OAAO,YAAY,EAAE,eAAe;AAqBjD;;;;;GAKG;AACH;IACE;;;;;OAKG;IACH,mCAFY,KAAK,CAKhB;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH;QAfmC,IAAI,GAA5B,eAAe;QACA,QAAQ;QACP,IAAI,GAApB,OAAO;QACM,KAAK,GAAlB,IAAI;QACW,KAAK;QACG,QAAQ,GAA/B,aAAc;QACS,QAAQ,GAA/B,aAAc;QACS,MAAM,GAA7B,aAAc;QACS,KAAK,GAA5B,aAAc;QACS,UAAU,GAAjC,aAAc;QACS,SAAS,GAAhC,aAAc;QACS,QAAQ,GAA/B,aAAc;QACS,OAAO,GAA9B,aAAc;QACS,QAAQ,GAA/B,aAAc;cAIxB;IAED;;;;;;;;;OASG;IACH,6BAkCC;IAED;;;;;;;;OAQG;IACH,wDAJW,OAAO,sBASjB;IAED;;;;;;;OAOG;IACH,qDAJW,OAAO,sBAcjB;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH;QAfkC,IAAI,GAA3B,eAAe;QACD,QAAQ;QACP,IAAI,GAAnB,OAAO;QACK,KAAK,GAAjB,IAAI;QACU,KAAK;QACG,QAAQ,GAA9B,aAAc;QACQ,QAAQ,GAA9B,aAAc;QACQ,MAAM,GAA5B,aAAc;QACQ,KAAK,GAA3B,aAAc;QACQ,UAAU,GAAhC,aAAc;QACQ,SAAS,GAA/B,aAAc;QACQ,QAAQ,GAA9B,aAAc;QACQ,OAAO,GAA7B,aAAc;QACQ,QAAQ,GAA9B,aAAc;OASxB;IANC,sBAA2B;IAQ7B;;;;;;;;;;;;;OAaG;IAEH;;;OAGG;IACH;;;;mBAfc,aAAc;;;;mBACd,aAAc;;;;iBACd,aAAc;;;;gBACd,aAAc;;;;qBACd,aAAc;;;;oBACd,aAAc;;;;mBACd,aAAc;;;;kBACd,aAAc;;;;mBACd,aAAc;MAOf;IAEb;;;OAGG;IACH,iBAAa;IAEb;;;;;OAKG;IACH,MAHU,OAAO,CAGE;IAEnB;;;OAGG;IACH,OAFW,IAAI,QAEF;IAEb;;;OAGG;IACH,qBAAa;IAEb;;;OAGG;IACH,MAFU,eAAe,CAEb;IAEZ;;;;;OAKG;IACH,kBAAwB;IAExB;;;;;OAKG;IACH,iBAAmB;IAEnB;;;;;;;;;;;;;;;;;;OAkBG;IACH,iBAHW,IAAI,GACH,aAAa,CAOxB;IAED;;;;OAIG;IACH,SAFY,KAAK,CAIhB;IAED;;;;OAIG;IACH,oBAEC;IAED;;;;;OAKG;IACH,qBAEC;IAED;;;;;;;OAOG;IACH,oCAFW,cAAY,QAStB;IAED;;;;;OAKG;IACH,kDAEC;IAED;;;;;OAKG;IACH,mCAGC;IAED;;;;;;;;;;;;;OAaG;IACH,8BAJW,IAAI,iBACJ,IAAI,GACH,IAAI,CAef;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH;QAfkC,IAAI,GAA3B,eAAe;QACD,QAAQ;QACP,IAAI,GAAnB,OAAO;QACK,KAAK,GAAjB,IAAI;QACU,KAAK;QACG,QAAQ,GAA9B,aAAc;QACQ,QAAQ,GAA9B,aAAc;QACQ,MAAM,GAA5B,aAAc;QACQ,KAAK,GAA3B,aAAc;QACQ,UAAU,GAAhC,aAAc;QACQ,SAAS,GAA/B,aAAc;QACQ,QAAQ,GAA9B,aAAc;QACQ,OAAO,GAA7B,aAAc;QACQ,QAAQ,GAA9B,aAAc;aA4BxB;IAED;;;OAGG;IACH,cA2BC;IAED;;;OAGG;IACH,mBAmBC;CACF;iBA/dgB,WAAW;0BADF,qBAAqB"}
|
||||
+199
@@ -0,0 +1,199 @@
|
||||
export default RecurExpansion;
|
||||
/**
|
||||
* Primary class for expanding recurring rules. Can take multiple rrules, rdates, exdate(s) and
|
||||
* iterate (in order) over each next occurrence.
|
||||
*
|
||||
* Once initialized this class can also be serialized saved and continue iteration from the last
|
||||
* point.
|
||||
*
|
||||
* NOTE: it is intended that this class is to be used with {@link ICAL.Event} which handles recurrence
|
||||
* exceptions.
|
||||
*
|
||||
* @example
|
||||
* // assuming event is a parsed ical component
|
||||
* var event;
|
||||
*
|
||||
* var expand = new ICAL.RecurExpansion({
|
||||
* component: event,
|
||||
* dtstart: event.getFirstPropertyValue('dtstart')
|
||||
* });
|
||||
*
|
||||
* // remember there are infinite rules so it is a good idea to limit the scope of the iterations
|
||||
* // then resume later on.
|
||||
*
|
||||
* // next is always an ICAL.Time or null
|
||||
* var next;
|
||||
*
|
||||
* while (someCondition && (next = expand.next())) {
|
||||
* // do something with next
|
||||
* }
|
||||
*
|
||||
* // save instance for later
|
||||
* var json = JSON.stringify(expand);
|
||||
*
|
||||
* //...
|
||||
*
|
||||
* // NOTE: if the component's properties have changed you will need to rebuild the class and start
|
||||
* // over. This only works when the component's recurrence info is the same.
|
||||
* var expand = new ICAL.RecurExpansion(JSON.parse(json));
|
||||
*
|
||||
* @memberof ICAL
|
||||
*/
|
||||
declare class RecurExpansion {
|
||||
/**
|
||||
* Creates a new ICAL.RecurExpansion instance.
|
||||
*
|
||||
* The options object can be filled with the specified initial values. It can also contain
|
||||
* additional members, as a result of serializing a previous expansion state, as shown in the
|
||||
* example.
|
||||
*
|
||||
* @param {Object} options
|
||||
* Recurrence expansion options
|
||||
* @param {Time} options.dtstart
|
||||
* Start time of the event
|
||||
* @param {Component=} options.component
|
||||
* Component for expansion, required if not resuming.
|
||||
*/
|
||||
constructor(options: {
|
||||
dtstart: Time;
|
||||
component?: Component | undefined;
|
||||
});
|
||||
/**
|
||||
* Array of rdate instances.
|
||||
*
|
||||
* @type {Time[]}
|
||||
* @private
|
||||
*/
|
||||
private ruleDates;
|
||||
/**
|
||||
* Array of exdate instances.
|
||||
*
|
||||
* @type {Time[]}
|
||||
* @private
|
||||
*/
|
||||
private exDates;
|
||||
/**
|
||||
* True when iteration is fully completed.
|
||||
* @type {Boolean}
|
||||
*/
|
||||
complete: boolean;
|
||||
/**
|
||||
* Array of rrule iterators.
|
||||
*
|
||||
* @type {RecurIterator[]}
|
||||
* @private
|
||||
*/
|
||||
private ruleIterators;
|
||||
/**
|
||||
* Current position in ruleDates array.
|
||||
* @type {Number}
|
||||
* @private
|
||||
*/
|
||||
private ruleDateInc;
|
||||
/**
|
||||
* Current position in exDates array
|
||||
* @type {Number}
|
||||
* @private
|
||||
*/
|
||||
private exDateInc;
|
||||
/**
|
||||
* Current negative date.
|
||||
*
|
||||
* @type {Time}
|
||||
* @private
|
||||
*/
|
||||
private exDate;
|
||||
/**
|
||||
* Current additional date.
|
||||
*
|
||||
* @type {Time}
|
||||
* @private
|
||||
*/
|
||||
private ruleDate;
|
||||
/**
|
||||
* Start date of recurring rules.
|
||||
*
|
||||
* @type {Time}
|
||||
*/
|
||||
dtstart: Time;
|
||||
/**
|
||||
* Last expanded time
|
||||
*
|
||||
* @type {Time}
|
||||
*/
|
||||
last: Time;
|
||||
/**
|
||||
* Initialize the recurrence expansion from the data object. The options
|
||||
* object may also contain additional members, see the
|
||||
* {@link ICAL.RecurExpansion constructor} for more details.
|
||||
*
|
||||
* @param {Object} options
|
||||
* Recurrence expansion options
|
||||
* @param {Time} options.dtstart
|
||||
* Start time of the event
|
||||
* @param {Component=} options.component
|
||||
* Component for expansion, required if not resuming.
|
||||
*/
|
||||
fromData(options: {
|
||||
dtstart: Time;
|
||||
component?: Component | undefined;
|
||||
}): void;
|
||||
/**
|
||||
* Compare two ICAL.Time objects. When the second parameter is a DATE and the first parameter is
|
||||
* DATE-TIME, strip the time and compare only the days.
|
||||
*
|
||||
* @private
|
||||
* @param {Time} a The one object to compare
|
||||
* @param {Time} b The other object to compare
|
||||
*/
|
||||
private _compare_special;
|
||||
/**
|
||||
* Retrieve the next occurrence in the series.
|
||||
* @return {Time}
|
||||
*/
|
||||
next(): Time;
|
||||
/**
|
||||
* Converts object into a serialize-able format. This format can be passed
|
||||
* back into the expansion to resume iteration.
|
||||
* @return {Object}
|
||||
*/
|
||||
toJSON(): any;
|
||||
/**
|
||||
* Extract all dates from the properties in the given component. The
|
||||
* properties will be filtered by the property name.
|
||||
*
|
||||
* @private
|
||||
* @param {Component} component The component to search in
|
||||
* @param {String} propertyName The property name to search for
|
||||
* @return {Time[]} The extracted dates.
|
||||
*/
|
||||
private _extractDates;
|
||||
/**
|
||||
* Initialize the recurrence expansion.
|
||||
*
|
||||
* @private
|
||||
* @param {Component} component The component to initialize from.
|
||||
*/
|
||||
private _init;
|
||||
/**
|
||||
* Advance to the next exdate
|
||||
* @private
|
||||
*/
|
||||
private _nextExDay;
|
||||
/**
|
||||
* Advance to the next rule date
|
||||
* @private
|
||||
*/
|
||||
private _nextRuleDay;
|
||||
/**
|
||||
* Find and return the recurrence rule with the most recent event and
|
||||
* return it.
|
||||
*
|
||||
* @private
|
||||
* @return {?RecurIterator} Found iterator.
|
||||
*/
|
||||
private _nextRecurrenceIter;
|
||||
}
|
||||
import Time from "./time.js";
|
||||
import Component from "./component.js";
|
||||
//# sourceMappingURL=recur_expansion.d.ts.map
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"version":3,"file":"recur_expansion.d.ts","sourceRoot":"","sources":["../../lib/ical/recur_expansion.js"],"names":[],"mappings":";AAYA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH;IACE;;;;;;;;;;;;;OAaG;IACH;QALyB,OAAO,EAArB,IAAI;QAEgB,SAAS,GAA7B,SAAS;OAOnB;IAgBD;;;;;OAKG;IACH,kBAAiB;IAEjB;;;;;OAKG;IACH,gBAAe;IA5Bf;;;OAGG;IACH,kBAAiB;IAEjB;;;;;OAKG;IACH,sBAAqB;IAkBrB;;;;OAIG;IACH,oBAAgB;IAEhB;;;;OAIG;IACH,kBAAc;IAEd;;;;;OAKG;IACH,eAAc;IAEd;;;;;OAKG;IACH,iBAAgB;IAEhB;;;;OAIG;IACH,SAFU,IAAI,CAEC;IAEf;;;;OAIG;IACH,MAFU,IAAI,CAEF;IAEZ;;;;;;;;;;;OAWG;IACH;QALyB,OAAO,EAArB,IAAI;QAEgB,SAAS,GAA7B,SAAS;aA0CnB;IAED;;;;;;;OAOG;IACH,yBAIC;IAED;;;OAGG;IACH,QAFY,IAAI,CAqEf;IAED;;;;OAIG;IACH,cAuBC;IAED;;;;;;;;OAQG;IACH,sBAkBC;IAED;;;;;OAKG;IACH,cAwEC;IAED;;;OAGG;IACH,mBAEC;IAED;;;OAGG;IACH,qBAEC;IAED;;;;;;OAMG;IACH,4BAwCC;CACF;iBAregB,WAAW;sBAIN,gBAAgB"}
|
||||
+220
@@ -0,0 +1,220 @@
|
||||
export default RecurIterator;
|
||||
/**
|
||||
* Imports the 'weekDay' type from the "types.js" module
|
||||
*/
|
||||
export type weekDay = import("./types.js").weekDay;
|
||||
/**
|
||||
* This lets typescript resolve our custom types in the
|
||||
* generated d.ts files (jsdoc typedefs are converted to typescript types).
|
||||
* Ignore prevents the typedefs from being documented more than once.
|
||||
*
|
||||
* @ignore
|
||||
* @typedef {import("./types.js").weekDay} weekDay
|
||||
* Imports the 'weekDay' type from the "types.js" module
|
||||
*/
|
||||
/**
|
||||
* An iterator for a single recurrence rule. This class usually doesn't have to be instanciated
|
||||
* directly, the convenience method {@link ICAL.Recur#iterator} can be used.
|
||||
*
|
||||
* @memberof ICAL
|
||||
*/
|
||||
declare class RecurIterator {
|
||||
static _indexMap: {
|
||||
BYSECOND: number;
|
||||
BYMINUTE: number;
|
||||
BYHOUR: number;
|
||||
BYDAY: number;
|
||||
BYMONTHDAY: number;
|
||||
BYYEARDAY: number;
|
||||
BYWEEKNO: number;
|
||||
BYMONTH: number;
|
||||
BYSETPOS: number;
|
||||
};
|
||||
static _expandMap: {
|
||||
SECONDLY: number[];
|
||||
MINUTELY: number[];
|
||||
HOURLY: number[];
|
||||
DAILY: number[];
|
||||
WEEKLY: number[];
|
||||
MONTHLY: number[];
|
||||
YEARLY: number[];
|
||||
};
|
||||
static UNKNOWN: number;
|
||||
static CONTRACT: number;
|
||||
static EXPAND: number;
|
||||
static ILLEGAL: number;
|
||||
/**
|
||||
* Creates a new ICAL.RecurIterator instance. The options object may contain additional members
|
||||
* when resuming iteration from a previous run.
|
||||
*
|
||||
* @param {Object} options The iterator options
|
||||
* @param {Recur} options.rule The rule to iterate.
|
||||
* @param {Time} options.dtstart The start date of the event.
|
||||
* @param {Boolean=} options.initialized When true, assume that options are
|
||||
* from a previously constructed iterator. Initialization will not be
|
||||
* repeated.
|
||||
*/
|
||||
constructor(options: {
|
||||
rule: Recur;
|
||||
dtstart: Time;
|
||||
initialized?: boolean | undefined;
|
||||
});
|
||||
/**
|
||||
* True when iteration is finished.
|
||||
* @type {Boolean}
|
||||
*/
|
||||
completed: boolean;
|
||||
/**
|
||||
* The rule that is being iterated
|
||||
* @type {Recur}
|
||||
*/
|
||||
rule: Recur;
|
||||
/**
|
||||
* The start date of the event being iterated.
|
||||
* @type {Time}
|
||||
*/
|
||||
dtstart: Time;
|
||||
/**
|
||||
* The last occurrence that was returned from the
|
||||
* {@link RecurIterator#next} method.
|
||||
* @type {Time}
|
||||
*/
|
||||
last: Time;
|
||||
/**
|
||||
* The sequence number from the occurrence
|
||||
* @type {Number}
|
||||
*/
|
||||
occurrence_number: number;
|
||||
/**
|
||||
* The indices used for the {@link ICAL.RecurIterator#by_data} object.
|
||||
* @type {Object}
|
||||
* @private
|
||||
*/
|
||||
private by_indices;
|
||||
/**
|
||||
* If true, the iterator has already been initialized
|
||||
* @type {Boolean}
|
||||
* @private
|
||||
*/
|
||||
private initialized;
|
||||
/**
|
||||
* The initializd by-data.
|
||||
* @type {Object}
|
||||
* @private
|
||||
*/
|
||||
private by_data;
|
||||
/**
|
||||
* The expanded yeardays
|
||||
* @type {Array}
|
||||
* @private
|
||||
*/
|
||||
private days;
|
||||
/**
|
||||
* The index in the {@link ICAL.RecurIterator#days} array.
|
||||
* @type {Number}
|
||||
* @private
|
||||
*/
|
||||
private days_index;
|
||||
/**
|
||||
* Initialize the recurrence iterator from the passed data object. This
|
||||
* method is usually not called directly, you can initialize the iterator
|
||||
* through the constructor.
|
||||
*
|
||||
* @param {Object} options The iterator options
|
||||
* @param {Recur} options.rule The rule to iterate.
|
||||
* @param {Time} options.dtstart The start date of the event.
|
||||
* @param {Boolean=} options.initialized When true, assume that options are
|
||||
* from a previously constructed iterator. Initialization will not be
|
||||
* repeated.
|
||||
*/
|
||||
fromData(options: {
|
||||
rule: Recur;
|
||||
dtstart: Time;
|
||||
initialized?: boolean | undefined;
|
||||
}): void;
|
||||
/**
|
||||
* Initialize the iterator
|
||||
* @private
|
||||
*/
|
||||
private init;
|
||||
/**
|
||||
* Retrieve the next occurrence from the iterator.
|
||||
* @return {Time}
|
||||
*/
|
||||
next(again?: boolean): Time;
|
||||
next_second(): number;
|
||||
increment_second(inc: any): void;
|
||||
next_minute(): number;
|
||||
increment_minute(inc: any): void;
|
||||
next_hour(): number;
|
||||
increment_hour(inc: any): void;
|
||||
next_day(): number;
|
||||
next_week(): number;
|
||||
/**
|
||||
* Normalize each by day rule for a given year/month.
|
||||
* Takes into account ordering and negative rules
|
||||
*
|
||||
* @private
|
||||
* @param {Number} year Current year.
|
||||
* @param {Number} month Current month.
|
||||
* @param {Array} rules Array of rules.
|
||||
*
|
||||
* @return {Array} sorted and normalized rules.
|
||||
* Negative rules will be expanded to their
|
||||
* correct positive values for easier processing.
|
||||
*/
|
||||
private normalizeByMonthDayRules;
|
||||
/**
|
||||
* NOTES:
|
||||
* We are given a list of dates in the month (BYMONTHDAY) (23, etc..)
|
||||
* Also we are given a list of days (BYDAY) (MO, 2SU, etc..) when
|
||||
* both conditions match a given date (this.last.day) iteration stops.
|
||||
*
|
||||
* @private
|
||||
* @param {Boolean=} isInit When given true will not increment the
|
||||
* current day (this.last).
|
||||
*/
|
||||
private _byDayAndMonthDay;
|
||||
next_month(): number;
|
||||
next_weekday_by_week(): number;
|
||||
next_year(): 0 | 1;
|
||||
_nextByYearDay(): 0 | 1;
|
||||
/**
|
||||
* @param dow (eg: '1TU', '-1MO')
|
||||
* @param {weekDay=} aWeekStart The week start weekday
|
||||
* @return [pos, numericDow] (eg: [1, 3]) numericDow is relative to aWeekStart
|
||||
*/
|
||||
ruleDayOfWeek(dow: any, aWeekStart?: weekDay | undefined): any[];
|
||||
next_generic(aRuleType: any, aInterval: any, aDateAttr: any, aFollowingAttr: any, aPreviousIncr: any): number;
|
||||
increment_monthday(inc: any): void;
|
||||
increment_month(): void;
|
||||
increment_year(inc: any): void;
|
||||
increment_generic(inc: any, aDateAttr: any, aFactor: any, aNextIncrement: any): void;
|
||||
has_by_data(aRuleType: any): boolean;
|
||||
expand_year_days(aYear: any): number;
|
||||
expand_by_day(aYear: any): number[];
|
||||
is_day_in_byday(tt: any): 0 | 1;
|
||||
/**
|
||||
* Checks if given value is in BYSETPOS.
|
||||
*
|
||||
* @private
|
||||
* @param {Numeric} aPos position to check for.
|
||||
* @return {Boolean} false unless BYSETPOS rules exist
|
||||
* and the given value is present in rules.
|
||||
*/
|
||||
private check_set_position;
|
||||
sort_byday_rules(aRules: any): void;
|
||||
check_contract_restriction(aRuleType: any, v: any): boolean;
|
||||
check_contracting_rules(): boolean;
|
||||
setup_defaults(aRuleType: any, req: any, deftime: any): any;
|
||||
/**
|
||||
* Convert iterator into a serialize-able object. Will preserve current
|
||||
* iteration sequence to ensure the seamless continuation of the recurrence
|
||||
* rule.
|
||||
* @return {Object}
|
||||
*/
|
||||
toJSON(): any;
|
||||
}
|
||||
import Recur from "./recur.js";
|
||||
import Time from "./time.js";
|
||||
//# sourceMappingURL=recur_iterator.d.ts.map
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"version":3,"file":"recur_iterator.d.ts","sourceRoot":"","sources":["../../lib/ical/recur_iterator.js"],"names":[],"mappings":";;;;sBAea,OAAO,YAAY,EAAE,OAAO;AANzC;;;;;;;;GAQG;AAEH;;;;;GAKG;AACH;IACE;;;;;;;;;;MAUE;IAEF;;;;;;;;MAQE;IAEF,uBAAmB;IACnB,wBAAoB;IACpB,sBAAkB;IAClB,uBAAmB;IAEnB;;;;;;;;;;OAUG;IACH;QAN0B,IAAI,EAAnB,KAAK;QACS,OAAO,EAArB,IAAI;QACc,WAAW;OAMvC;IAED;;;OAGG;IACH,mBAAkB;IAElB;;;OAGG;IACH,MAFU,KAAK,CAEH;IAEZ;;;OAGG;IACH,SAFU,IAAI,CAEC;IAEf;;;;OAIG;IACH,MAFU,IAAI,CAEF;IAEZ;;;OAGG;IACH,0BAAsB;IAEtB;;;;OAIG;IACH,mBAAkB;IAElB;;;;OAIG;IACH,oBAAoB;IAEpB;;;;OAIG;IACH,gBAAe;IAEf;;;;OAIG;IACH,aAAY;IAEZ;;;;OAIG;IACH,mBAAe;IAEf;;;;;;;;;;;OAWG;IACH;QAN0B,IAAI,EAAnB,KAAK;QACS,OAAO,EAArB,IAAI;QACc,WAAW;aA8DvC;IAED;;;OAGG;IACH,aAyKC;IAED;;;OAGG;IACH,uBAFY,IAAI,CAqFf;IAED,sBAEC;IAED,iCAEC;IAED,sBAGC;IAED,iCAEC;IAED,oBAGC;IAED,+BAEC;IAED,mBAcC;IAED,oBAgCC;IAED;;;;;;;;;;;;OAYG;IACH,iCA2CC;IAED;;;;;;;;;OASG;IACH,0BAmIC;IAED,qBA2FC;IAED,+BAwDC;IAED,mBAsBC;IAED,wBAqBC;IAED;;;;OAIG;IACH,qCAHW,OAAO,qBAYjB;IAED,8GA2BC;IAED,mCAUC;IAED,wBAmCC;IAED,+BAIC;IAED,qFAOC;IAED,qCAEC;IAED,qCAmOC;IAED,oCAsDC;IAED,gCAgBC;IAED;;;;;;;OAOG;IACH,2BAOC;IAED,oCAaC;IAED,4DAqBC;IAED,mCAaC;IAED,4DAaC;IAED;;;;;OAKG;IACH,cAaC;CACF;kBAp7CiB,YAAY;iBACb,WAAW"}
|
||||
+95
@@ -0,0 +1,95 @@
|
||||
/**
|
||||
* Convert a full jCal/jCard array into a iCalendar/vCard string.
|
||||
*
|
||||
* @function ICAL.stringify
|
||||
* @variation function
|
||||
* @param {Array} jCal The jCal/jCard document
|
||||
* @return {String} The stringified iCalendar/vCard document
|
||||
*/
|
||||
declare function stringify(jCal: any[]): string;
|
||||
declare namespace stringify {
|
||||
/**
|
||||
* Converts an jCal component array into a ICAL string.
|
||||
* Recursive will resolve sub-components.
|
||||
*
|
||||
* Exact component/property order is not saved all
|
||||
* properties will come before subcomponents.
|
||||
*
|
||||
* @function ICAL.stringify.component
|
||||
* @param {Array} component
|
||||
* jCal/jCard fragment of a component
|
||||
* @param {designSet} designSet
|
||||
* The design data to use for this component
|
||||
* @return {String} The iCalendar/vCard string
|
||||
*/
|
||||
function component(component: any[], designSet: import("./types.js").designSet): string;
|
||||
/**
|
||||
* Converts a single jCal/jCard property to a iCalendar/vCard string.
|
||||
*
|
||||
* @function ICAL.stringify.property
|
||||
* @param {Array} property
|
||||
* jCal/jCard property array
|
||||
* @param {designSet} designSet
|
||||
* The design data to use for this property
|
||||
* @param {Boolean} noFold
|
||||
* If true, the line is not folded
|
||||
* @return {String} The iCalendar/vCard string
|
||||
*/
|
||||
function property(property: any[], designSet: import("./types.js").designSet, noFold: boolean): string;
|
||||
/**
|
||||
* Handles escaping of property values that may contain:
|
||||
*
|
||||
* COLON (:), SEMICOLON (;), or COMMA (,)
|
||||
*
|
||||
* If any of the above are present the result is wrapped
|
||||
* in double quotes.
|
||||
*
|
||||
* @function ICAL.stringify.paramPropertyValue
|
||||
* @param {String} value Raw property value
|
||||
* @param {boolean} force If value should be escaped even when unnecessary
|
||||
* @return {String} Given or escaped value when needed
|
||||
*/
|
||||
function paramPropertyValue(value: string, force: boolean): string;
|
||||
/**
|
||||
* Converts an array of ical values into a single
|
||||
* string based on a type and a delimiter value (like ",").
|
||||
*
|
||||
* @function ICAL.stringify.multiValue
|
||||
* @param {Array} values List of values to convert
|
||||
* @param {String} delim Used to join the values (",", ";", ":")
|
||||
* @param {String} type Lowecase ical value type
|
||||
* (like boolean, date-time, etc..)
|
||||
* @param {?String} innerMulti If set, each value will again be processed
|
||||
* Used for structured values
|
||||
* @param {designSet} designSet
|
||||
* The design data to use for this property
|
||||
*
|
||||
* @return {String} iCalendar/vCard string for value
|
||||
*/
|
||||
function multiValue(values: any[], delim: string, type: string, innerMulti: string, designSet: import("./types.js").designSet, structuredValue: any): string;
|
||||
/**
|
||||
* Processes a single ical value runs the associated "toICAL" method from the
|
||||
* design value type if available to convert the value.
|
||||
*
|
||||
* @function ICAL.stringify.value
|
||||
* @param {String|Number} value A formatted value
|
||||
* @param {String} type Lowercase iCalendar/vCard value type
|
||||
* (like boolean, date-time, etc..)
|
||||
* @return {String} iCalendar/vCard value for single value
|
||||
*/
|
||||
function value(value: string | number, type: string, designSet: any, structuredValue: any): string;
|
||||
/**
|
||||
* Internal helper for rfc6868. Exposing this on ICAL.stringify so that
|
||||
* hackers can disable the rfc6868 parsing if the really need to.
|
||||
*
|
||||
* @param {String} val The value to unescape
|
||||
* @return {String} The escaped value
|
||||
*/
|
||||
function _rfc6868Unescape(val: string): string;
|
||||
}
|
||||
export default stringify;
|
||||
/**
|
||||
* Imports the 'designSet' type from the "types.js" module
|
||||
*/
|
||||
export type designSet = import("./types.js").designSet;
|
||||
//# sourceMappingURL=stringify.d.ts.map
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"version":3,"file":"stringify.d.ts","sourceRoot":"","sources":["../../lib/ical/stringify.js"],"names":[],"mappings":"AAsBA;;;;;;;GAOG;AACH,gDAeC;;IAED;;;;;;;;;;;;;OAaG;IACH,wFAgCC;IAED;;;;;;;;;;;OAWG;IACH,uGAuGC;IAED;;;;;;;;;;;;OAYG;IACH,mEAUC;IAED;;;;;;;;;;;;;;;OAeG;IACH,6JAkBC;IAED;;;;;;;;;OASG;IACH,mGAKC;IAED;;;;;;OAMG;IACH,+CAIC;;;;;;wBA/RY,OAAO,YAAY,EAAE,SAAS"}
|
||||
+542
@@ -0,0 +1,542 @@
|
||||
export default Time;
|
||||
/**
|
||||
* Imports the 'weekDay' type from the "types.js" module
|
||||
*/
|
||||
export type weekDay = import("./types.js").weekDay;
|
||||
/**
|
||||
* Imports the 'timeInit' type from the "types.js" module
|
||||
*/
|
||||
export type timeInit = import("./types.js").timeInit;
|
||||
/**
|
||||
* This lets typescript resolve our custom types in the
|
||||
* generated d.ts files (jsdoc typedefs are converted to typescript types).
|
||||
* Ignore prevents the typedefs from being documented more than once.
|
||||
*
|
||||
* @ignore
|
||||
* @typedef {import("./types.js").weekDay} weekDay
|
||||
* Imports the 'weekDay' type from the "types.js" module
|
||||
*
|
||||
* @ignore
|
||||
* @typedef {import("./types.js").timeInit} timeInit
|
||||
* Imports the 'timeInit' type from the "types.js" module
|
||||
*/
|
||||
/**
|
||||
* @classdesc
|
||||
* iCalendar Time representation (similar to JS Date object). Fully
|
||||
* independent of system (OS) timezone / time. Unlike JS Date, the month
|
||||
* January is 1, not zero.
|
||||
*
|
||||
* @example
|
||||
* var time = new ICAL.Time({
|
||||
* year: 2012,
|
||||
* month: 10,
|
||||
* day: 11
|
||||
* minute: 0,
|
||||
* second: 0,
|
||||
* isDate: false
|
||||
* });
|
||||
*
|
||||
*
|
||||
* @memberof ICAL
|
||||
*/
|
||||
declare class Time {
|
||||
static _dowCache: {};
|
||||
static _wnCache: {};
|
||||
/**
|
||||
* Returns the days in the given month
|
||||
*
|
||||
* @param {Number} month The month to check
|
||||
* @param {Number} year The year to check
|
||||
* @return {Number} The number of days in the month
|
||||
*/
|
||||
static daysInMonth(month: number, year: number): number;
|
||||
/**
|
||||
* Checks if the year is a leap year
|
||||
*
|
||||
* @param {Number} year The year to check
|
||||
* @return {Boolean} True, if the year is a leap year
|
||||
*/
|
||||
static isLeapYear(year: number): boolean;
|
||||
/**
|
||||
* Create a new ICAL.Time from the day of year and year. The date is returned
|
||||
* in floating timezone.
|
||||
*
|
||||
* @param {Number} aDayOfYear The day of year
|
||||
* @param {Number} aYear The year to create the instance in
|
||||
* @return {Time} The created instance with the calculated date
|
||||
*/
|
||||
static fromDayOfYear(aDayOfYear: number, aYear: number): Time;
|
||||
/**
|
||||
* Returns a new ICAL.Time instance from a date string, e.g 2015-01-02.
|
||||
*
|
||||
* @deprecated Use {@link ICAL.Time.fromDateString} instead
|
||||
* @param {String} str The string to create from
|
||||
* @return {Time} The date/time instance
|
||||
*/
|
||||
static fromStringv2(str: string): Time;
|
||||
/**
|
||||
* Returns a new ICAL.Time instance from a date string, e.g 2015-01-02.
|
||||
*
|
||||
* @param {String} aValue The string to create from
|
||||
* @return {Time} The date/time instance
|
||||
*/
|
||||
static fromDateString(aValue: string): Time;
|
||||
/**
|
||||
* Returns a new ICAL.Time instance from a date-time string, e.g
|
||||
* 2015-01-02T03:04:05. If a property is specified, the timezone is set up
|
||||
* from the property's TZID parameter.
|
||||
*
|
||||
* @param {String} aValue The string to create from
|
||||
* @param {Property=} prop The property the date belongs to
|
||||
* @return {Time} The date/time instance
|
||||
*/
|
||||
static fromDateTimeString(aValue: string, prop?: Property | undefined): Time;
|
||||
/**
|
||||
* Returns a new ICAL.Time instance from a date or date-time string,
|
||||
*
|
||||
* @param {String} aValue The string to create from
|
||||
* @param {Property=} prop The property the date belongs to
|
||||
* @return {Time} The date/time instance
|
||||
*/
|
||||
static fromString(aValue: string, aProperty: any): Time;
|
||||
/**
|
||||
* Creates a new ICAL.Time instance from the given Javascript Date.
|
||||
*
|
||||
* @param {?Date} aDate The Javascript Date to read, or null to reset
|
||||
* @param {Boolean} [useUTC=false] If true, the UTC values of the date will be used
|
||||
*/
|
||||
static fromJSDate(aDate: Date | null, useUTC?: boolean): Time;
|
||||
/**
|
||||
* Creates a new ICAL.Time instance from the the passed data object.
|
||||
*
|
||||
* @param {timeInit} aData Time initialization
|
||||
* @param {Timezone=} aZone Timezone this position occurs in
|
||||
*/
|
||||
static fromData: (aData: timeInit, aZone?: Timezone | undefined) => Time;
|
||||
/**
|
||||
* Creates a new ICAL.Time instance from the current moment.
|
||||
* The instance is “floating” - has no timezone relation.
|
||||
* To create an instance considering the time zone, call
|
||||
* ICAL.Time.fromJSDate(new Date(), true)
|
||||
* @return {Time}
|
||||
*/
|
||||
static now(): Time;
|
||||
/**
|
||||
* Returns the date on which ISO week number 1 starts.
|
||||
*
|
||||
* @see Time#weekNumber
|
||||
* @param {Number} aYear The year to search in
|
||||
* @param {weekDay=} aWeekStart The week start weekday, used for calculation.
|
||||
* @return {Time} The date on which week number 1 starts
|
||||
*/
|
||||
static weekOneStarts(aYear: number, aWeekStart?: weekDay | undefined): Time;
|
||||
/**
|
||||
* Get the dominical letter for the given year. Letters range from A - G for
|
||||
* common years, and AG to GF for leap years.
|
||||
*
|
||||
* @param {Number} yr The year to retrieve the letter for
|
||||
* @return {String} The dominical letter.
|
||||
*/
|
||||
static getDominicalLetter(yr: number): string;
|
||||
static "__#1@#epochTime": any;
|
||||
/**
|
||||
* January 1st, 1970 as an ICAL.Time.
|
||||
* @type {Time}
|
||||
* @constant
|
||||
* @instance
|
||||
*/
|
||||
static get epochTime(): Time;
|
||||
static _cmp_attr(a: any, b: any, attr: any): 0 | 1 | -1;
|
||||
/**
|
||||
* The days that have passed in the year after a given month. The array has
|
||||
* two members, one being an array of passed days for non-leap years, the
|
||||
* other analog for leap years.
|
||||
* @example
|
||||
* var isLeapYear = ICAL.Time.isLeapYear(year);
|
||||
* var passedDays = ICAL.Time.daysInYearPassedMonth[isLeapYear][month];
|
||||
* @type {Array.<Array.<Number>>}
|
||||
*/
|
||||
static daysInYearPassedMonth: Array<Array<number>>;
|
||||
static SUNDAY: number;
|
||||
static MONDAY: number;
|
||||
static TUESDAY: number;
|
||||
static WEDNESDAY: number;
|
||||
static THURSDAY: number;
|
||||
static FRIDAY: number;
|
||||
static SATURDAY: number;
|
||||
/**
|
||||
* The default weekday for the WKST part.
|
||||
* @constant
|
||||
* @default ICAL.Time.MONDAY
|
||||
*/
|
||||
static DEFAULT_WEEK_START: number;
|
||||
/**
|
||||
* Creates a new ICAL.Time instance.
|
||||
*
|
||||
* @param {timeInit} data Time initialization
|
||||
* @param {Timezone} zone timezone this position occurs in
|
||||
*/
|
||||
constructor(data: timeInit, zone: Timezone);
|
||||
wrappedJSObject: this;
|
||||
/**
|
||||
* @type {timeInit}
|
||||
* @private
|
||||
*/
|
||||
private _time;
|
||||
/**
|
||||
* The class identifier.
|
||||
* @constant
|
||||
* @type {String}
|
||||
* @default "icaltime"
|
||||
*/
|
||||
icalclass: string;
|
||||
_cachedUnixTime: any;
|
||||
/**
|
||||
* The type name, to be used in the jCal object. This value may change and
|
||||
* is strictly defined by the {@link ICAL.Time#isDate isDate} member.
|
||||
* @type {String}
|
||||
* @default "date-time"
|
||||
*/
|
||||
get icaltype(): string;
|
||||
/**
|
||||
* The timezone for this time.
|
||||
* @type {Timezone}
|
||||
*/
|
||||
zone: Timezone;
|
||||
/**
|
||||
* Internal uses to indicate that a change has been made and the next read
|
||||
* operation must attempt to normalize the value (for example changing the
|
||||
* day to 33).
|
||||
*
|
||||
* @type {Boolean}
|
||||
* @private
|
||||
*/
|
||||
private _pendingNormalization;
|
||||
set year(val: number);
|
||||
/**
|
||||
* The year of this date.
|
||||
* @type {Number}
|
||||
*/
|
||||
get year(): number;
|
||||
set month(val: number);
|
||||
/**
|
||||
* The month of this date.
|
||||
* @type {Number}
|
||||
*/
|
||||
get month(): number;
|
||||
set day(val: number);
|
||||
/**
|
||||
* The day of this date.
|
||||
* @type {Number}
|
||||
*/
|
||||
get day(): number;
|
||||
set hour(val: number);
|
||||
/**
|
||||
* The hour of this date-time.
|
||||
* @type {Number}
|
||||
*/
|
||||
get hour(): number;
|
||||
set minute(val: number);
|
||||
/**
|
||||
* The minute of this date-time.
|
||||
* @type {Number}
|
||||
*/
|
||||
get minute(): number;
|
||||
set second(val: number);
|
||||
/**
|
||||
* The second of this date-time.
|
||||
* @type {Number}
|
||||
*/
|
||||
get second(): number;
|
||||
set isDate(val: boolean);
|
||||
/**
|
||||
* If true, the instance represents a date (as opposed to a date-time)
|
||||
* @type {Boolean}
|
||||
*/
|
||||
get isDate(): boolean;
|
||||
/**
|
||||
* @private
|
||||
* @param {String} attr Attribute to get (one of: year, month,
|
||||
* day, hour, minute, second, isDate)
|
||||
* @return {Number|Boolean} Current value for the attribute
|
||||
*/
|
||||
private _getTimeAttr;
|
||||
/**
|
||||
* @private
|
||||
* @param {String} attr Attribute to set (one of: year, month,
|
||||
* day, hour, minute, second, isDate)
|
||||
* @param {Number|Boolean} val New value for the attribute
|
||||
*/
|
||||
private _setTimeAttr;
|
||||
/**
|
||||
* Returns a clone of the time object.
|
||||
*
|
||||
* @return {Time} The cloned object
|
||||
*/
|
||||
clone(): Time;
|
||||
/**
|
||||
* Reset the time instance to epoch time
|
||||
*/
|
||||
reset(): void;
|
||||
/**
|
||||
* Reset the time instance to the given date/time values.
|
||||
*
|
||||
* @param {Number} year The year to set
|
||||
* @param {Number} month The month to set
|
||||
* @param {Number} day The day to set
|
||||
* @param {Number} hour The hour to set
|
||||
* @param {Number} minute The minute to set
|
||||
* @param {Number} second The second to set
|
||||
* @param {Timezone} timezone The timezone to set
|
||||
*/
|
||||
resetTo(year: number, month: number, day: number, hour: number, minute: number, second: number, timezone: Timezone): void;
|
||||
/**
|
||||
* Set up the current instance from the Javascript date value.
|
||||
*
|
||||
* @param {?Date} aDate The Javascript Date to read, or null to reset
|
||||
* @param {Boolean} [useUTC=false] If true, the UTC values of the date will be used
|
||||
*/
|
||||
fromJSDate(aDate: Date | null, useUTC?: boolean): this;
|
||||
/**
|
||||
* Sets up the current instance using members from the passed data object.
|
||||
*
|
||||
* @param {timeInit} aData Time initialization
|
||||
* @param {Timezone=} aZone Timezone this position occurs in
|
||||
*/
|
||||
fromData(aData: timeInit, aZone?: Timezone | undefined): this;
|
||||
/**
|
||||
* Calculate the day of week.
|
||||
* @param {weekDay=} aWeekStart
|
||||
* The week start weekday, defaults to SUNDAY
|
||||
* @return {weekDay}
|
||||
*/
|
||||
dayOfWeek(aWeekStart?: weekDay | undefined): weekDay;
|
||||
/**
|
||||
* Calculate the day of year.
|
||||
* @return {Number}
|
||||
*/
|
||||
dayOfYear(): number;
|
||||
/**
|
||||
* Returns a copy of the current date/time, rewound to the start of the
|
||||
* week. The resulting ICAL.Time instance is of icaltype date, even if this
|
||||
* is a date-time.
|
||||
*
|
||||
* @param {weekDay=} aWeekStart
|
||||
* The week start weekday, defaults to SUNDAY
|
||||
* @return {Time} The start of the week (cloned)
|
||||
*/
|
||||
startOfWeek(aWeekStart?: weekDay | undefined): Time;
|
||||
/**
|
||||
* Returns a copy of the current date/time, shifted to the end of the week.
|
||||
* The resulting ICAL.Time instance is of icaltype date, even if this is a
|
||||
* date-time.
|
||||
*
|
||||
* @param {weekDay=} aWeekStart
|
||||
* The week start weekday, defaults to SUNDAY
|
||||
* @return {Time} The end of the week (cloned)
|
||||
*/
|
||||
endOfWeek(aWeekStart?: weekDay | undefined): Time;
|
||||
/**
|
||||
* Returns a copy of the current date/time, rewound to the start of the
|
||||
* month. The resulting ICAL.Time instance is of icaltype date, even if
|
||||
* this is a date-time.
|
||||
*
|
||||
* @return {Time} The start of the month (cloned)
|
||||
*/
|
||||
startOfMonth(): Time;
|
||||
/**
|
||||
* Returns a copy of the current date/time, shifted to the end of the
|
||||
* month. The resulting ICAL.Time instance is of icaltype date, even if
|
||||
* this is a date-time.
|
||||
*
|
||||
* @return {Time} The end of the month (cloned)
|
||||
*/
|
||||
endOfMonth(): Time;
|
||||
/**
|
||||
* Returns a copy of the current date/time, rewound to the start of the
|
||||
* year. The resulting ICAL.Time instance is of icaltype date, even if
|
||||
* this is a date-time.
|
||||
*
|
||||
* @return {Time} The start of the year (cloned)
|
||||
*/
|
||||
startOfYear(): Time;
|
||||
/**
|
||||
* Returns a copy of the current date/time, shifted to the end of the
|
||||
* year. The resulting ICAL.Time instance is of icaltype date, even if
|
||||
* this is a date-time.
|
||||
*
|
||||
* @return {Time} The end of the year (cloned)
|
||||
*/
|
||||
endOfYear(): Time;
|
||||
/**
|
||||
* First calculates the start of the week, then returns the day of year for
|
||||
* this date. If the day falls into the previous year, the day is zero or negative.
|
||||
*
|
||||
* @param {weekDay=} aFirstDayOfWeek
|
||||
* The week start weekday, defaults to SUNDAY
|
||||
* @return {Number} The calculated day of year
|
||||
*/
|
||||
startDoyWeek(aFirstDayOfWeek?: weekDay | undefined): number;
|
||||
/**
|
||||
* Get the dominical letter for the current year. Letters range from A - G
|
||||
* for common years, and AG to GF for leap years.
|
||||
*
|
||||
* @param {Number} yr The year to retrieve the letter for
|
||||
* @return {String} The dominical letter.
|
||||
*/
|
||||
getDominicalLetter(): string;
|
||||
/**
|
||||
* Finds the nthWeekDay relative to the current month (not day). The
|
||||
* returned value is a day relative the month that this month belongs to so
|
||||
* 1 would indicate the first of the month and 40 would indicate a day in
|
||||
* the following month.
|
||||
*
|
||||
* @param {Number} aDayOfWeek Day of the week see the day name constants
|
||||
* @param {Number} aPos Nth occurrence of a given week day values
|
||||
* of 1 and 0 both indicate the first weekday of that type. aPos may
|
||||
* be either positive or negative
|
||||
*
|
||||
* @return {Number} numeric value indicating a day relative
|
||||
* to the current month of this time object
|
||||
*/
|
||||
nthWeekDay(aDayOfWeek: number, aPos: number): number;
|
||||
/**
|
||||
* Checks if current time is the nth weekday, relative to the current
|
||||
* month. Will always return false when rule resolves outside of current
|
||||
* month.
|
||||
*
|
||||
* @param {weekDay} aDayOfWeek Day of week to check
|
||||
* @param {Number} aPos Relative position
|
||||
* @return {Boolean} True, if it is the nth weekday
|
||||
*/
|
||||
isNthWeekDay(aDayOfWeek: weekDay, aPos: number): boolean;
|
||||
/**
|
||||
* Calculates the ISO 8601 week number. The first week of a year is the
|
||||
* week that contains the first Thursday. The year can have 53 weeks, if
|
||||
* January 1st is a Friday.
|
||||
*
|
||||
* Note there are regions where the first week of the year is the one that
|
||||
* starts on January 1st, which may offset the week number. Also, if a
|
||||
* different week start is specified, this will also affect the week
|
||||
* number.
|
||||
*
|
||||
* @see Time.weekOneStarts
|
||||
* @param {weekDay} aWeekStart The weekday the week starts with
|
||||
* @return {Number} The ISO week number
|
||||
*/
|
||||
weekNumber(aWeekStart: weekDay): number;
|
||||
/**
|
||||
* Adds the duration to the current time. The instance is modified in
|
||||
* place.
|
||||
*
|
||||
* @param {Duration} aDuration The duration to add
|
||||
*/
|
||||
addDuration(aDuration: Duration): void;
|
||||
/**
|
||||
* Subtract the date details (_excluding_ timezone). Useful for finding
|
||||
* the relative difference between two time objects excluding their
|
||||
* timezone differences.
|
||||
*
|
||||
* @param {Time} aDate The date to subtract
|
||||
* @return {Duration} The difference as a duration
|
||||
*/
|
||||
subtractDate(aDate: Time): Duration;
|
||||
/**
|
||||
* Subtract the date details, taking timezones into account.
|
||||
*
|
||||
* @param {Time} aDate The date to subtract
|
||||
* @return {Duration} The difference in duration
|
||||
*/
|
||||
subtractDateTz(aDate: Time): Duration;
|
||||
/**
|
||||
* Compares the ICAL.Time instance with another one, or a period.
|
||||
*
|
||||
* @param {Time|Period} aOther The instance to compare with
|
||||
* @return {Number} -1, 0 or 1 for less/equal/greater
|
||||
*/
|
||||
compare(other: any): number;
|
||||
/**
|
||||
* Compares only the date part of this instance with another one.
|
||||
*
|
||||
* @param {Time} other The instance to compare with
|
||||
* @param {Timezone} tz The timezone to compare in
|
||||
* @return {Number} -1, 0 or 1 for less/equal/greater
|
||||
*/
|
||||
compareDateOnlyTz(other: Time, tz: Timezone): number;
|
||||
/**
|
||||
* Convert the instance into another timezone. The returned ICAL.Time
|
||||
* instance is always a copy.
|
||||
*
|
||||
* @param {Timezone} zone The zone to convert to
|
||||
* @return {Time} The copy, converted to the zone
|
||||
*/
|
||||
convertToZone(zone: Timezone): Time;
|
||||
/**
|
||||
* Calculates the UTC offset of the current date/time in the timezone it is
|
||||
* in.
|
||||
*
|
||||
* @return {Number} UTC offset in seconds
|
||||
*/
|
||||
utcOffset(): number;
|
||||
/**
|
||||
* Returns an RFC 5545 compliant ical representation of this object.
|
||||
*
|
||||
* @return {String} ical date/date-time
|
||||
*/
|
||||
toICALString(): string;
|
||||
/**
|
||||
* The string representation of this date/time, in jCal form
|
||||
* (including : and - separators).
|
||||
* @return {String}
|
||||
*/
|
||||
toString(): string;
|
||||
/**
|
||||
* Converts the current instance to a Javascript date
|
||||
* @return {Date}
|
||||
*/
|
||||
toJSDate(): Date;
|
||||
_normalize(): this;
|
||||
/**
|
||||
* Adjust the date/time by the given offset
|
||||
*
|
||||
* @param {Number} aExtraDays The extra amount of days
|
||||
* @param {Number} aExtraHours The extra amount of hours
|
||||
* @param {Number} aExtraMinutes The extra amount of minutes
|
||||
* @param {Number} aExtraSeconds The extra amount of seconds
|
||||
* @param {Number=} aTime The time to adjust, defaults to the
|
||||
* current instance.
|
||||
*/
|
||||
adjust(aExtraDays: number, aExtraHours: number, aExtraMinutes: number, aExtraSeconds: number, aTime?: number | undefined): this;
|
||||
/**
|
||||
* Sets up the current instance from unix time, the number of seconds since
|
||||
* January 1st, 1970.
|
||||
*
|
||||
* @param {Number} seconds The seconds to set up with
|
||||
*/
|
||||
fromUnixTime(seconds: number): void;
|
||||
/**
|
||||
* Converts the current instance to seconds since January 1st 1970.
|
||||
*
|
||||
* @return {Number} Seconds since 1970
|
||||
*/
|
||||
toUnixTime(): number;
|
||||
/**
|
||||
* Converts time to into Object which can be serialized then re-created
|
||||
* using the constructor.
|
||||
*
|
||||
* @example
|
||||
* // toJSON will automatically be called
|
||||
* var json = JSON.stringify(mytime);
|
||||
*
|
||||
* var deserialized = JSON.parse(json);
|
||||
*
|
||||
* var time = new ICAL.Time(deserialized);
|
||||
*
|
||||
* @return {Object}
|
||||
*/
|
||||
toJSON(): any;
|
||||
}
|
||||
import Timezone from "./timezone.js";
|
||||
import Duration from "./duration.js";
|
||||
import Property from "./property.js";
|
||||
//# sourceMappingURL=time.d.ts.map
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"version":3,"file":"time.d.ts","sourceRoot":"","sources":["../../lib/ical/time.js"],"names":[],"mappings":";;;;sBAqBa,OAAO,YAAY,EAAE,OAAO;;;;uBAI5B,OAAO,YAAY,EAAE,QAAQ;AAV1C;;;;;;;;;;;;GAYG;AAEH;;;;;;;;;;;;;;;;;;EAkBE;AACF;IACE,qBAAsB;IACtB,oBAAqB;IAErB;;;;;;OAMG;IACH,wDAaC;IAED;;;;;OAKG;IACH,yCAMC;IAED;;;;;;;OAOG;IACH,yDAFY,IAAI,CAkCf;IAED;;;;;;OAMG;IACH,kCAFY,IAAI,CASf;IAED;;;;;OAKG;IACH,uCAFY,IAAI,CAef;IAED;;;;;;;;OAQG;IACH,iDAHW,QAAQ,eACP,IAAI,CAiDf;IAED;;;;;;OAMG;IACH,mDAFY,IAAI,CAQf;IAED;;;;;OAKG;IACH,yBAHY,IAAI,iCAMf;IAED;;;;;OAKG;IACH,yBAHW,QAAQ,UACR,QAAQ,sBAKjB;IAEF;;;;;;OAMG;IACH,cAFY,IAAI,CAIf;IAED;;;;;;;OAOG;IACH,iDAHW,OAAO,eACN,IAAI,CAsBf;IAED;;;;;;OAMG;IACH,8CASC;IAED,8BAAyB;IACzB;;;;;OAKG;IACH,6BAcC;IAED,wDAIC;IAED;;;;;;;;OAQG;IACH,8BAFU,MAAO,aAAc,CAAC,CAK9B;IAEF,sBAAkB;IAClB,sBAAkB;IAClB,uBAAmB;IACnB,yBAAqB;IACrB,wBAAoB;IACpB,sBAAkB;IAClB,wBAAoB;IAEpB;;;;OAIG;IACH,kCAA8B;IAE9B;;;;;OAKG;IACH,kBAHW,QAAQ,QACR,QAAQ,EAqBlB;IAlBC,sBAA2B;IAE3B;;;OAGG;IACH,cAAgC;IAclC;;;;;OAKG;IACH,kBAAuB;IACvB,qBAAuB;IAEvB;;;;;OAKG;IACH,uBAEC;IAED;;;OAGG;IACH,MAFU,QAAQ,CAEN;IAEZ;;;;;;;OAOG;IACH,8BAA8B;IAU9B,sBAEC;IAVD;;;OAGG;IACH,mBAEC;IAcD,uBAEC;IAVD;;;OAGG;IACH,oBAEC;IAcD,qBAEC;IAVD;;;OAGG;IACH,kBAEC;IAcD,sBAEC;IAVD;;;OAGG;IACH,mBAEC;IAcD,wBAEC;IAVD;;;OAGG;IACH,qBAEC;IAcD,wBAEC;IAVD;;;OAGG;IACH,qBAEC;IAcD,yBAEC;IAVD;;;OAGG;IACH,sBAEC;IAMD;;;;;OAKG;IACH,qBAOC;IAED;;;;;OAKG;IACH,qBAUC;IAED;;;;OAIG;IACH,SAFY,IAAI,CAIf;IAED;;OAEG;IACH,cAGC;IAED;;;;;;;;;;OAUG;IACH,0GAFW,QAAQ,QAYlB;IAED;;;;;OAKG;IACH,kBAHY,IAAI,iCA2Bf;IAED;;;;;OAKG;IACH,gBAHW,QAAQ,UACR,QAAQ,oBAuClB;IAED;;;;;OAKG;IACH,uBAJW,OAAO,eAEN,OAAO,CA0BlB;IAED;;;OAGG;IACH,oBAIC;IAED;;;;;;;;OAQG;IACH,yBAJW,OAAO,eAEN,IAAI,CAWf;IAED;;;;;;;;OAQG;IACH,uBAJW,OAAO,eAEN,IAAI,CAWf;IAED;;;;;;OAMG;IACH,gBAFY,IAAI,CAUf;IAED;;;;;;OAMG;IACH,cAFY,IAAI,CAUf;IAED;;;;;;OAMG;IACH,eAFY,IAAI,CAWf;IAED;;;;;;OAMG;IACH,aAFY,IAAI,CAWf;IAED;;;;;;;OAOG;IACH,+BAJW,OAAO,sBASjB;IAED;;;;;;OAMG;IACH,6BAEC;IAED;;;;;;;;;;;;;OAaG;IACH,qDAuEC;IAED;;;;;;;;OAQG;IACH,yBAJW,OAAO,yBAmBjB;IAED;;;;;;;;;;;;;OAaG;IACH,uBAHW,OAAO,UAmCjB;IAED;;;;;OAKG;IACH,uBAFW,QAAQ,QA0BlB;IAED;;;;;;;OAOG;IACH,oBAHW,IAAI,GACH,QAAQ,CAMnB;IAED;;;;;OAKG;IACH,sBAHW,IAAI,GACH,QAAQ,CAMnB;IAED;;;;;OAKG;IACH,4BAWC;IAED;;;;;;OAMG;IACH,yBAJW,IAAI,MACJ,QAAQ,UAalB;IAED;;;;;;OAMG;IACH,oBAHW,QAAQ,GACP,IAAI,CAYf;IAED;;;;;OAKG;IACH,oBAOC;IAED;;;;OAIG;IACH,uBAQC;IAED;;;;OAIG;IACH,mBAgBC;IAED;;;OAGG;IACH,YAFY,IAAI,CAaf;IAED,mBASC;IAED;;;;;;;;;OASG;IACH,gIAoFC;IAED;;;;;OAKG;IACH,oCAoBC;IAED;;;;OAIG;IACH,qBAoBC;IAED;;;;;;;;;;;;;OAaG;IACH,cA2BC;CACF;qBAt3CoB,eAAe;qBACf,eAAe;qBAKf,eAAe"}
|
||||
+169
@@ -0,0 +1,169 @@
|
||||
export default Timezone;
|
||||
/**
|
||||
* Timezone representation.
|
||||
*
|
||||
* @example
|
||||
* var vcalendar;
|
||||
* var timezoneComp = vcalendar.getFirstSubcomponent('vtimezone');
|
||||
* var tzid = timezoneComp.getFirstPropertyValue('tzid');
|
||||
*
|
||||
* var timezone = new ICAL.Timezone({
|
||||
* component: timezoneComp,
|
||||
* tzid
|
||||
* });
|
||||
*
|
||||
* @memberof ICAL
|
||||
*/
|
||||
declare class Timezone {
|
||||
static _compare_change_fn(a: any, b: any): 0 | 1 | -1;
|
||||
/**
|
||||
* Convert the date/time from one zone to the next.
|
||||
*
|
||||
* @param {Time} tt The time to convert
|
||||
* @param {Timezone} from_zone The source zone to convert from
|
||||
* @param {Timezone} to_zone The target zone to convert to
|
||||
* @return {Time} The converted date/time object
|
||||
*/
|
||||
static convert_time(tt: Time, from_zone: Timezone, to_zone: Timezone): Time;
|
||||
/**
|
||||
* Creates a new ICAL.Timezone instance from the passed data object.
|
||||
*
|
||||
* @param {Component|Object} aData options for class
|
||||
* @param {String|Component} aData.component
|
||||
* If aData is a simple object, then this member can be set to either a
|
||||
* string containing the component data, or an already parsed
|
||||
* ICAL.Component
|
||||
* @param {String} aData.tzid The timezone identifier
|
||||
* @param {String} aData.location The timezone locationw
|
||||
* @param {String} aData.tznames An alternative string representation of the
|
||||
* timezone
|
||||
* @param {Number} aData.latitude The latitude of the timezone
|
||||
* @param {Number} aData.longitude The longitude of the timezone
|
||||
*/
|
||||
static fromData(aData: Component | any): Timezone;
|
||||
/**
|
||||
* The instance describing the UTC timezone
|
||||
* @type {Timezone}
|
||||
* @constant
|
||||
* @instance
|
||||
*/
|
||||
static "__#2@#utcTimezone": Timezone;
|
||||
static get utcTimezone(): Timezone;
|
||||
/**
|
||||
* The instance describing the local timezone
|
||||
* @type {Timezone}
|
||||
* @constant
|
||||
* @instance
|
||||
*/
|
||||
static "__#2@#localTimezone": Timezone;
|
||||
static get localTimezone(): Timezone;
|
||||
/**
|
||||
* Adjust a timezone change object.
|
||||
* @private
|
||||
* @param {Object} change The timezone change object
|
||||
* @param {Number} days The extra amount of days
|
||||
* @param {Number} hours The extra amount of hours
|
||||
* @param {Number} minutes The extra amount of minutes
|
||||
* @param {Number} seconds The extra amount of seconds
|
||||
*/
|
||||
private static adjust_change;
|
||||
static _minimumExpansionYear: number;
|
||||
static EXTRA_COVERAGE: number;
|
||||
/**
|
||||
* Creates a new ICAL.Timezone instance, by passing in a tzid and component.
|
||||
*
|
||||
* @param {Component|Object} data options for class
|
||||
* @param {String|Component} data.component
|
||||
* If data is a simple object, then this member can be set to either a
|
||||
* string containing the component data, or an already parsed
|
||||
* ICAL.Component
|
||||
* @param {String} data.tzid The timezone identifier
|
||||
* @param {String} data.location The timezone locationw
|
||||
* @param {String} data.tznames An alternative string representation of the
|
||||
* timezone
|
||||
* @param {Number} data.latitude The latitude of the timezone
|
||||
* @param {Number} data.longitude The longitude of the timezone
|
||||
*/
|
||||
constructor(data: Component | any);
|
||||
wrappedJSObject: this;
|
||||
/**
|
||||
* Timezone identifier
|
||||
* @type {String}
|
||||
*/
|
||||
tzid: string;
|
||||
/**
|
||||
* Timezone location
|
||||
* @type {String}
|
||||
*/
|
||||
location: string;
|
||||
/**
|
||||
* Alternative timezone name, for the string representation
|
||||
* @type {String}
|
||||
*/
|
||||
tznames: string;
|
||||
/**
|
||||
* The primary latitude for the timezone.
|
||||
* @type {Number}
|
||||
*/
|
||||
latitude: number;
|
||||
/**
|
||||
* The primary longitude for the timezone.
|
||||
* @type {Number}
|
||||
*/
|
||||
longitude: number;
|
||||
/**
|
||||
* The vtimezone component for this timezone.
|
||||
* @type {Component}
|
||||
*/
|
||||
component: Component;
|
||||
/**
|
||||
* The year this timezone has been expanded to. All timezone transition
|
||||
* dates until this year are known and can be used for calculation
|
||||
*
|
||||
* @private
|
||||
* @type {Number}
|
||||
*/
|
||||
private expandedUntilYear;
|
||||
/**
|
||||
* The class identifier.
|
||||
* @constant
|
||||
* @type {String}
|
||||
* @default "icaltimezone"
|
||||
*/
|
||||
icalclass: string;
|
||||
/**
|
||||
* Sets up the current instance using members from the passed data object.
|
||||
*
|
||||
* @param {Component|Object} aData options for class
|
||||
* @param {String|Component} aData.component
|
||||
* If aData is a simple object, then this member can be set to either a
|
||||
* string containing the component data, or an already parsed
|
||||
* ICAL.Component
|
||||
* @param {String} aData.tzid The timezone identifier
|
||||
* @param {String} aData.location The timezone locationw
|
||||
* @param {String} aData.tznames An alternative string representation of the
|
||||
* timezone
|
||||
* @param {Number} aData.latitude The latitude of the timezone
|
||||
* @param {Number} aData.longitude The longitude of the timezone
|
||||
*/
|
||||
fromData(aData: Component | any): this;
|
||||
changes: any[];
|
||||
/**
|
||||
* Finds the utcOffset the given time would occur in this timezone.
|
||||
*
|
||||
* @param {Time} tt The time to check for
|
||||
* @return {Number} utc offset in seconds
|
||||
*/
|
||||
utcOffset(tt: Time): number;
|
||||
_findNearbyChange(change: any): number;
|
||||
_ensureCoverage(aYear: any): void;
|
||||
_expandComponent(aComponent: any, aYear: any, changes: any): any;
|
||||
/**
|
||||
* The string representation of this timezone.
|
||||
* @return {String}
|
||||
*/
|
||||
toString(): string;
|
||||
}
|
||||
import Component from "./component.js";
|
||||
import Time from "./time.js";
|
||||
//# sourceMappingURL=timezone.d.ts.map
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"version":3,"file":"timezone.d.ts","sourceRoot":"","sources":["../../lib/ical/timezone.js"],"names":[],"mappings":";AAYA;;;;;;;;;;;;;;GAcG;AACH;IACE,sDAoBC;IAED;;;;;;;OAOG;IACH,wBALW,IAAI,aACJ,QAAQ,WACR,QAAQ,GACP,IAAI,CAkBf;IAED;;;;;;;;;;;;;;OAcG;IACH,uBAZW,SAAS,MAAO,YAe1B;IAED;;;;;OAKG;IACH,4BAJU,QAAQ,CAIS;IAC3B,mCAOC;IAED;;;;;OAKG;IACH,8BAJU,QAAQ,CAIW;IAC7B,qCAOC;IAED;;;;;;;;OAQG;IACH,6BASC;IAED,qCAAkC;IAClC,8BAA0B;IAE1B;;;;;;;;;;;;;;OAcG;IACH,kBAZW,SAAS,MAAO,EAe1B;IAFC,sBAA2B;IAK7B;;;OAGG;IACH,aAAU;IAEV;;;OAGG;IACH,iBAAc;IAEd;;;OAGG;IACH,gBAAa;IAEb;;;OAGG;IACH,iBAAe;IAEf;;;OAGG;IACH,kBAAgB;IAEhB;;;OAGG;IACH,WAFU,SAAS,CAEF;IAEjB;;;;;;OAMG;IACH,0BAAsB;IAEtB;;;;;OAKG;IACH,kBAA2B;IAE3B;;;;;;;;;;;;;;OAcG;IACH,gBAZW,SAAS,MAAO,QAkD1B;IApCC,eAAiB;IAsCnB;;;;;OAKG;IACH,cAHW,IAAI,UAiFd;IAED,uCAaC;IAED,kCA2BC;IAED,iEAyGC;IAED;;;OAGG;IACH,mBAEC;CACF;sBAtgBqB,gBAAgB;iBADrB,WAAW"}
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
export default TimezoneService;
|
||||
declare namespace TimezoneService {
|
||||
const count: number;
|
||||
function reset(): void;
|
||||
function _hard_reset(): void;
|
||||
function has(tzid: string): boolean;
|
||||
function get(tzid: string): Timezone;
|
||||
function register(timezone: Timezone | Component, name?: string): void;
|
||||
function remove(tzid: string): Timezone;
|
||||
}
|
||||
import Timezone from "./timezone.js";
|
||||
import Component from "./component.js";
|
||||
//# sourceMappingURL=timezone_service.d.ts.map
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"version":3,"file":"timezone_service.d.ts","sourceRoot":"","sources":["../../lib/ical/timezone_service.js"],"names":[],"mappings":";;;IA8BS,uBAON;IACY,6BAEZ;IAQI,oCAMJ;IAQI,qCAMJ;IAYS,uEA+BT;IAQO,wCAMP;;qBAxHkB,eAAe;sBAGd,gBAAgB"}
|
||||
+217
@@ -0,0 +1,217 @@
|
||||
/**
|
||||
* The weekday, 1 = SUNDAY, 7 = SATURDAY. Access via
|
||||
* ICAL.Time.MONDAY, ICAL.Time.TUESDAY, ...
|
||||
*
|
||||
* @typedef {Number} weekDay
|
||||
* @memberof ICAL.Time
|
||||
*/
|
||||
/**
|
||||
* @typedef {Object} timeInit Time initialization
|
||||
* @property {Number=} year The year for this date
|
||||
* @property {Number=} month The month for this date
|
||||
* @property {Number=} day The day for this date
|
||||
* @property {Number=} hour The hour for this date
|
||||
* @property {Number=} minute The minute for this date
|
||||
* @property {Number=} second The second for this date
|
||||
* @property {Boolean=} isDate If true, the instance represents a date
|
||||
* (as opposed to a date-time)
|
||||
* @property {String=} timezone Timezone id if zone is unknown [internal]
|
||||
* @property {Timezone=} zone Resolved timezone object [internal]
|
||||
* @memberof ICAL.Time
|
||||
*/
|
||||
/**
|
||||
* Possible frequency values for the FREQ part
|
||||
* (YEARLY, MONTHLY, WEEKLY, DAILY, HOURLY, MINUTELY, SECONDLY)
|
||||
*
|
||||
* @typedef {String} frequencyValues
|
||||
* @memberof ICAL.Recur
|
||||
*/
|
||||
/**
|
||||
* This object is returned by {@link ICAL.Event#getOccurrenceDetails getOccurrenceDetails}
|
||||
* @memberof ICAL.Event
|
||||
* @typedef {Object} occurrenceDetails
|
||||
* @property {Time} recurrenceId The passed in recurrence id
|
||||
* @property {Event} item The occurrence
|
||||
* @property {Time} startDate The start of the occurrence
|
||||
* @property {Time} endDate The end of the occurrence
|
||||
*/
|
||||
/**
|
||||
* The state for parsing content lines from an iCalendar/vCard string.
|
||||
*
|
||||
* @private
|
||||
* @memberof ICAL.parse
|
||||
* @typedef {Object} parserState
|
||||
* @property {designSet} designSet The design set to use for parsing
|
||||
* @property {Component[]} stack The stack of components being processed
|
||||
* @property {Component} component The currently active component
|
||||
*/
|
||||
/**
|
||||
* A jCal component.
|
||||
*
|
||||
* TODO: Properly typedef this when https://github.com/hegemonic/catharsis/pull/70
|
||||
* is merged. Documentation is ignored until this can be documented properly.
|
||||
*
|
||||
* @example
|
||||
* ["vevent", [...properties here...], [...components here...] ]
|
||||
*
|
||||
* @ignore
|
||||
* @typedef {Array} jCalComponent
|
||||
* @property {String} 0 The component name
|
||||
* @property {jCalProperty[]} 1 The properties of this component
|
||||
* @property {jCalComponent[]} 2 The subcomponents of this component
|
||||
*/
|
||||
/**
|
||||
* A designSet describes value, parameter and property data. It is used by
|
||||
* ther parser and stringifier in components and properties to determine they
|
||||
* should be represented.
|
||||
*
|
||||
* @memberof ICAL.design
|
||||
* @typedef {Object} designSet
|
||||
* @property {Object} value Definitions for value types, keys are type names
|
||||
* @property {Object} param Definitions for params, keys are param names
|
||||
* @property {Object} property Definitions for properties, keys are property names
|
||||
* @property {boolean} propertyGroups If content lines may include a group name
|
||||
*/
|
||||
/**
|
||||
* The jCal Geo type. This is a tuple representing a geographical location.
|
||||
* The first element is the Latitude and the second element is the Longitude.
|
||||
*
|
||||
* TODO: Properly typedef this when https://github.com/hegemonic/catharsis/pull/70
|
||||
*
|
||||
* @typedef {Array} Geo
|
||||
* @property {Number} 0 Latitude
|
||||
* @property {Number} 1 Longitude
|
||||
*/
|
||||
export const _: {};
|
||||
/**
|
||||
* The weekday, 1 = SUNDAY, 7 = SATURDAY. Access via
|
||||
* ICAL.Time.MONDAY, ICAL.Time.TUESDAY, ...
|
||||
*/
|
||||
export type weekDay = number;
|
||||
/**
|
||||
* Time initialization
|
||||
*/
|
||||
export type timeInit = {
|
||||
/**
|
||||
* The year for this date
|
||||
*/
|
||||
year?: number | undefined;
|
||||
/**
|
||||
* The month for this date
|
||||
*/
|
||||
month?: number | undefined;
|
||||
/**
|
||||
* The day for this date
|
||||
*/
|
||||
day?: number | undefined;
|
||||
/**
|
||||
* The hour for this date
|
||||
*/
|
||||
hour?: number | undefined;
|
||||
/**
|
||||
* The minute for this date
|
||||
*/
|
||||
minute?: number | undefined;
|
||||
/**
|
||||
* The second for this date
|
||||
*/
|
||||
second?: number | undefined;
|
||||
/**
|
||||
* If true, the instance represents a date
|
||||
* (as opposed to a date-time)
|
||||
*/
|
||||
isDate?: boolean | undefined;
|
||||
/**
|
||||
* Timezone id if zone is unknown [internal]
|
||||
*/
|
||||
timezone?: string | undefined;
|
||||
/**
|
||||
* Resolved timezone object [internal]
|
||||
*/
|
||||
zone?: Timezone | undefined;
|
||||
};
|
||||
/**
|
||||
* Possible frequency values for the FREQ part
|
||||
* (YEARLY, MONTHLY, WEEKLY, DAILY, HOURLY, MINUTELY, SECONDLY)
|
||||
*/
|
||||
export type frequencyValues = string;
|
||||
/**
|
||||
* This object is returned by {@link ICAL.EventgetOccurrenceDetails getOccurrenceDetails}
|
||||
*/
|
||||
export type occurrenceDetails = {
|
||||
/**
|
||||
* The passed in recurrence id
|
||||
*/
|
||||
recurrenceId: Time;
|
||||
/**
|
||||
* The occurrence
|
||||
*/
|
||||
item: Event;
|
||||
/**
|
||||
* The start of the occurrence
|
||||
*/
|
||||
startDate: Time;
|
||||
/**
|
||||
* The end of the occurrence
|
||||
*/
|
||||
endDate: Time;
|
||||
};
|
||||
/**
|
||||
* The state for parsing content lines from an iCalendar/vCard string.
|
||||
*/
|
||||
export type parserState = {
|
||||
/**
|
||||
* The design set to use for parsing
|
||||
*/
|
||||
designSet: designSet;
|
||||
/**
|
||||
* The stack of components being processed
|
||||
*/
|
||||
stack: Component[];
|
||||
/**
|
||||
* The currently active component
|
||||
*/
|
||||
component: Component;
|
||||
};
|
||||
/**
|
||||
* A jCal component.
|
||||
*
|
||||
* TODO: Properly typedef this when https://github.com/hegemonic/catharsis/pull/70
|
||||
* is merged. Documentation is ignored until this can be documented properly.
|
||||
*/
|
||||
export type jCalComponent = any[];
|
||||
/**
|
||||
* A designSet describes value, parameter and property data. It is used by
|
||||
* ther parser and stringifier in components and properties to determine they
|
||||
* should be represented.
|
||||
*/
|
||||
export type designSet = {
|
||||
/**
|
||||
* Definitions for value types, keys are type names
|
||||
*/
|
||||
value: any;
|
||||
/**
|
||||
* Definitions for params, keys are param names
|
||||
*/
|
||||
param: any;
|
||||
/**
|
||||
* Definitions for properties, keys are property names
|
||||
*/
|
||||
property: any;
|
||||
/**
|
||||
* If content lines may include a group name
|
||||
*/
|
||||
propertyGroups: boolean;
|
||||
};
|
||||
/**
|
||||
* The jCal Geo type. This is a tuple representing a geographical location.
|
||||
* The first element is the Latitude and the second element is the Longitude.
|
||||
*
|
||||
* TODO: Properly typedef this when https://github.com/hegemonic/catharsis/pull/70
|
||||
*/
|
||||
export type Geo = any[];
|
||||
import Timezone from "./timezone";
|
||||
import Time from "./time";
|
||||
import Event from "./event";
|
||||
import Component from "./component";
|
||||
//# sourceMappingURL=types.d.ts.map
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../lib/ical/types.js"],"names":[],"mappings":"AAgBA;;;;;;GAMG;AAEH;;;;;;;;;;;;;GAaG;AAEH;;;;;;GAMG;AAEH;;;;;;;;GAQG;AAEH;;;;;;;;;GASG;AAEH;;;;;;;;;;;;;;GAcG;AAEH;;;;;;;;;;;GAWG;AAEH;;;;;;;;;GASG;AAEH,mBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAzEN,QAAQ;;;;;;;;;;;;;;kBAgBR,IAAI;;;;UACJ,KAAK;;;;eACL,IAAI;;;;aACJ,IAAI;;;;;;;;;eASJ,SAAS;;;;WACT,SAAS,EAAE;;;;eACX,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oBA6BT,OAAO;;;;;;;;;qBAhFA,YAAY;iBADhB,QAAQ;kBADP,SAAS;sBADL,aAAa"}
|
||||
+112
@@ -0,0 +1,112 @@
|
||||
export default UtcOffset;
|
||||
/**
|
||||
* This class represents the "utc-offset" value type, with various calculation and manipulation
|
||||
* methods.
|
||||
*
|
||||
* @memberof ICAL
|
||||
*/
|
||||
declare class UtcOffset {
|
||||
/**
|
||||
* Creates a new {@link ICAL.UtcOffset} instance from the passed string.
|
||||
*
|
||||
* @param {String} aString The string to parse
|
||||
* @return {Duration} The created utc-offset instance
|
||||
*/
|
||||
static fromString(aString: string): Duration;
|
||||
/**
|
||||
* Creates a new {@link ICAL.UtcOffset} instance from the passed seconds
|
||||
* value.
|
||||
*
|
||||
* @param {Number} aSeconds The number of seconds to convert
|
||||
*/
|
||||
static fromSeconds(aSeconds: number): UtcOffset;
|
||||
/**
|
||||
* Creates a new ICAL.UtcOffset instance.
|
||||
*
|
||||
* @param {Object} aData An object with members of the utc offset
|
||||
* @param {Number=} aData.hours The hours for the utc offset
|
||||
* @param {Number=} aData.minutes The minutes in the utc offset
|
||||
* @param {Number=} aData.factor The factor for the utc-offset, either -1 or 1
|
||||
*/
|
||||
constructor(aData: {
|
||||
hours?: number | undefined;
|
||||
minutes?: number | undefined;
|
||||
factor?: number | undefined;
|
||||
});
|
||||
/**
|
||||
* The hours in the utc-offset
|
||||
* @type {Number}
|
||||
*/
|
||||
hours: number;
|
||||
/**
|
||||
* The minutes in the utc-offset
|
||||
* @type {Number}
|
||||
*/
|
||||
minutes: number;
|
||||
/**
|
||||
* The sign of the utc offset, 1 for positive offset, -1 for negative
|
||||
* offsets.
|
||||
* @type {Number}
|
||||
*/
|
||||
factor: number;
|
||||
/**
|
||||
* The type name, to be used in the jCal object.
|
||||
* @constant
|
||||
* @type {String}
|
||||
* @default "utc-offset"
|
||||
*/
|
||||
icaltype: string;
|
||||
/**
|
||||
* Returns a clone of the utc offset object.
|
||||
*
|
||||
* @return {UtcOffset} The cloned object
|
||||
*/
|
||||
clone(): UtcOffset;
|
||||
/**
|
||||
* Sets up the current instance using members from the passed data object.
|
||||
*
|
||||
* @param {Object} aData An object with members of the utc offset
|
||||
* @param {Number=} aData.hours The hours for the utc offset
|
||||
* @param {Number=} aData.minutes The minutes in the utc offset
|
||||
* @param {Number=} aData.factor The factor for the utc-offset, either -1 or 1
|
||||
*/
|
||||
fromData(aData: {
|
||||
hours?: number | undefined;
|
||||
minutes?: number | undefined;
|
||||
factor?: number | undefined;
|
||||
}): void;
|
||||
/**
|
||||
* Sets up the current instance from the given seconds value. The seconds
|
||||
* value is truncated to the minute. Offsets are wrapped when the world
|
||||
* ends, the hour after UTC+14:00 is UTC-12:00.
|
||||
*
|
||||
* @param {Number} aSeconds The seconds to convert into an offset
|
||||
*/
|
||||
fromSeconds(aSeconds: number): this;
|
||||
/**
|
||||
* Convert the current offset to a value in seconds
|
||||
*
|
||||
* @return {Number} The offset in seconds
|
||||
*/
|
||||
toSeconds(): number;
|
||||
/**
|
||||
* Compare this utc offset with another one.
|
||||
*
|
||||
* @param {UtcOffset} other The other offset to compare with
|
||||
* @return {Number} -1, 0 or 1 for less/equal/greater
|
||||
*/
|
||||
compare(other: UtcOffset): number;
|
||||
_normalize(): void;
|
||||
/**
|
||||
* The iCalendar string representation of this utc-offset.
|
||||
* @return {String}
|
||||
*/
|
||||
toICALString(): string;
|
||||
/**
|
||||
* The string representation of this utc-offset.
|
||||
* @return {String}
|
||||
*/
|
||||
toString(): string;
|
||||
}
|
||||
import Duration from "./duration.js";
|
||||
//# sourceMappingURL=utc_offset.d.ts.map
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"version":3,"file":"utc_offset.d.ts","sourceRoot":"","sources":["../../lib/ical/utc_offset.js"],"names":[],"mappings":";AAWA;;;;;GAKG;AACH;IACE;;;;;OAKG;IACH,oCAFY,QAAQ,CAWnB;IAED;;;;;OAKG;IACH,gDAIC;IAED;;;;;;;OAOG;IACH;QAJ0B,KAAK;QACL,OAAO;QACP,MAAM;OAI/B;IAED;;;OAGG;IACH,cAAU;IAEV;;;OAGG;IACH,gBAAY;IAEZ;;;;OAIG;IACH,eAAW;IAEX;;;;;OAKG;IACH,iBAAwB;IAExB;;;;OAIG;IACH,SAFY,SAAS,CAIpB;IAED;;;;;;;OAOG;IACH;QAJ0B,KAAK;QACL,OAAO;QACP,MAAM;aAS/B;IAED;;;;;;OAMG;IACH,oCASC;IAED;;;;OAIG;IACH,oBAEC;IAED;;;;;OAKG;IACH,eAHW,SAAS,UAOnB;IAED,mBAiBC;IAED;;;OAGG;IACH,uBAEC;IAED;;;OAGG;IACH,mBAEC;CACF;qBAjLoB,eAAe"}
|
||||
+67
@@ -0,0 +1,67 @@
|
||||
export default VCardTime;
|
||||
/**
|
||||
* Describes a vCard time, which has slight differences to the ICAL.Time.
|
||||
* Properties can be null if not specified, for example for dates with
|
||||
* reduced accuracy or truncation.
|
||||
*
|
||||
* Note that currently not all methods are correctly re-implemented for
|
||||
* VCardTime. For example, comparison will have undefined results when some
|
||||
* members are null.
|
||||
*
|
||||
* Also, normalization is not yet implemented for this class!
|
||||
*
|
||||
* @memberof ICAL
|
||||
* @extends {Time}
|
||||
*/
|
||||
declare class VCardTime extends Time {
|
||||
/**
|
||||
* Returns a new ICAL.VCardTime instance from a date and/or time string.
|
||||
*
|
||||
* @param {String} aValue The string to create from
|
||||
* @param {String} aIcalType The type for this instance, e.g. date-and-or-time
|
||||
* @return {VCardTime} The date/time instance
|
||||
*/
|
||||
static fromDateAndOrTimeString(aValue: string, aIcalType: string): VCardTime;
|
||||
/**
|
||||
* Creates a new ICAL.VCardTime instance.
|
||||
*
|
||||
* @param {Object} data The data for the time instance
|
||||
* @param {Number=} data.year The year for this date
|
||||
* @param {Number=} data.month The month for this date
|
||||
* @param {Number=} data.day The day for this date
|
||||
* @param {Number=} data.hour The hour for this date
|
||||
* @param {Number=} data.minute The minute for this date
|
||||
* @param {Number=} data.second The second for this date
|
||||
* @param {Timezone|UtcOffset} zone The timezone to use
|
||||
* @param {String} icaltype The type for this date/time object
|
||||
*/
|
||||
constructor(data: {
|
||||
year?: number | undefined;
|
||||
month?: number | undefined;
|
||||
day?: number | undefined;
|
||||
hour?: number | undefined;
|
||||
minute?: number | undefined;
|
||||
second?: number | undefined;
|
||||
}, zone: Timezone | UtcOffset, icaltype: string);
|
||||
/**
|
||||
* The type name, to be used in the jCal object.
|
||||
* @type {String}
|
||||
* @default "date-and-or-time"
|
||||
*/
|
||||
icaltype: string;
|
||||
/**
|
||||
* Returns a clone of the vcard date/time object.
|
||||
*
|
||||
* @return {VCardTime} The cloned object
|
||||
*/
|
||||
clone(): VCardTime;
|
||||
_normalize(): this;
|
||||
/**
|
||||
* @inheritdoc
|
||||
*/
|
||||
utcOffset(...args: any[]): any;
|
||||
}
|
||||
import Time from "./time.js";
|
||||
import Timezone from "./timezone.js";
|
||||
import UtcOffset from "./utc_offset.js";
|
||||
//# sourceMappingURL=vcard_time.d.ts.map
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"version":3,"file":"vcard_time.d.ts","sourceRoot":"","sources":["../../lib/ical/vcard_time.js"],"names":[],"mappings":";AAWA;;;;;;;;;;;;;GAaG;AACH;IACE;;;;;;OAMG;IACH,mEAFY,SAAS,CAoCpB;IAGD;;;;;;;;;;;;OAYG;IACH;QATyB,IAAI;QACJ,KAAK;QACL,GAAG;QACH,IAAI;QACJ,MAAM;QACN,MAAM;aACpB,QAAQ,GAAC,SAAS,oBAM5B;IAUD;;;;OAIG;IACH,iBAA8B;IAE9B;;;;OAIG;IACH,SAFY,SAAS,CAIpB;IAED,mBAEC;IAED;;OAEG;IACH,+BAMC;CAwDF;iBA/KgB,WAAW;qBACP,eAAe;sBAFd,iBAAiB"}
|
||||
+173
@@ -0,0 +1,173 @@
|
||||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
* Portions Copyright (C) Philipp Kewisch */
|
||||
|
||||
/**
|
||||
* Represents the BINARY value type, which contains extra methods for encoding and decoding.
|
||||
*
|
||||
* @memberof ICAL
|
||||
*/
|
||||
class Binary {
|
||||
/**
|
||||
* Creates a binary value from the given string.
|
||||
*
|
||||
* @param {String} aString The binary value string
|
||||
* @return {Binary} The binary value instance
|
||||
*/
|
||||
static fromString(aString) {
|
||||
return new Binary(aString);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new ICAL.Binary instance
|
||||
*
|
||||
* @param {String} aValue The binary data for this value
|
||||
*/
|
||||
constructor(aValue) {
|
||||
this.value = aValue;
|
||||
}
|
||||
|
||||
/**
|
||||
* The type name, to be used in the jCal object.
|
||||
* @default "binary"
|
||||
* @constant
|
||||
*/
|
||||
icaltype = "binary";
|
||||
|
||||
/**
|
||||
* Base64 decode the current value
|
||||
*
|
||||
* @return {String} The base64-decoded value
|
||||
*/
|
||||
decodeValue() {
|
||||
return this._b64_decode(this.value);
|
||||
}
|
||||
|
||||
/**
|
||||
* Encodes the passed parameter with base64 and sets the internal
|
||||
* value to the result.
|
||||
*
|
||||
* @param {String} aValue The raw binary value to encode
|
||||
*/
|
||||
setEncodedValue(aValue) {
|
||||
this.value = this._b64_encode(aValue);
|
||||
}
|
||||
|
||||
_b64_encode(data) {
|
||||
// http://kevin.vanzonneveld.net
|
||||
// + original by: Tyler Akins (http://rumkin.com)
|
||||
// + improved by: Bayron Guevara
|
||||
// + improved by: Thunder.m
|
||||
// + improved by: Kevin van Zonneveld (http://kevin.vanzonneveld.net)
|
||||
// + bugfixed by: Pellentesque Malesuada
|
||||
// + improved by: Kevin van Zonneveld (http://kevin.vanzonneveld.net)
|
||||
// + improved by: Rafał Kukawski (http://kukawski.pl)
|
||||
// * example 1: base64_encode('Kevin van Zonneveld');
|
||||
// * returns 1: 'S2V2aW4gdmFuIFpvbm5ldmVsZA=='
|
||||
// mozilla has this native
|
||||
// - but breaks in 2.0.0.12!
|
||||
//if (typeof this.window['atob'] == 'function') {
|
||||
// return atob(data);
|
||||
//}
|
||||
let b64 = "ABCDEFGHIJKLMNOPQRSTUVWXYZ" +
|
||||
"abcdefghijklmnopqrstuvwxyz0123456789+/=";
|
||||
let o1, o2, o3, h1, h2, h3, h4, bits, i = 0,
|
||||
ac = 0,
|
||||
enc = "",
|
||||
tmp_arr = [];
|
||||
|
||||
if (!data) {
|
||||
return data;
|
||||
}
|
||||
|
||||
do { // pack three octets into four hexets
|
||||
o1 = data.charCodeAt(i++);
|
||||
o2 = data.charCodeAt(i++);
|
||||
o3 = data.charCodeAt(i++);
|
||||
|
||||
bits = o1 << 16 | o2 << 8 | o3;
|
||||
|
||||
h1 = bits >> 18 & 0x3f;
|
||||
h2 = bits >> 12 & 0x3f;
|
||||
h3 = bits >> 6 & 0x3f;
|
||||
h4 = bits & 0x3f;
|
||||
|
||||
// use hexets to index into b64, and append result to encoded string
|
||||
tmp_arr[ac++] = b64.charAt(h1) + b64.charAt(h2) + b64.charAt(h3) + b64.charAt(h4);
|
||||
} while (i < data.length);
|
||||
|
||||
enc = tmp_arr.join('');
|
||||
|
||||
let r = data.length % 3;
|
||||
|
||||
return (r ? enc.slice(0, r - 3) : enc) + '==='.slice(r || 3);
|
||||
|
||||
}
|
||||
|
||||
_b64_decode(data) {
|
||||
// http://kevin.vanzonneveld.net
|
||||
// + original by: Tyler Akins (http://rumkin.com)
|
||||
// + improved by: Thunder.m
|
||||
// + input by: Aman Gupta
|
||||
// + improved by: Kevin van Zonneveld (http://kevin.vanzonneveld.net)
|
||||
// + bugfixed by: Onno Marsman
|
||||
// + bugfixed by: Pellentesque Malesuada
|
||||
// + improved by: Kevin van Zonneveld (http://kevin.vanzonneveld.net)
|
||||
// + input by: Brett Zamir (http://brett-zamir.me)
|
||||
// + bugfixed by: Kevin van Zonneveld (http://kevin.vanzonneveld.net)
|
||||
// * example 1: base64_decode('S2V2aW4gdmFuIFpvbm5ldmVsZA==');
|
||||
// * returns 1: 'Kevin van Zonneveld'
|
||||
// mozilla has this native
|
||||
// - but breaks in 2.0.0.12!
|
||||
//if (typeof this.window['btoa'] == 'function') {
|
||||
// return btoa(data);
|
||||
//}
|
||||
let b64 = "ABCDEFGHIJKLMNOPQRSTUVWXYZ" +
|
||||
"abcdefghijklmnopqrstuvwxyz0123456789+/=";
|
||||
let o1, o2, o3, h1, h2, h3, h4, bits, i = 0,
|
||||
ac = 0,
|
||||
dec = "",
|
||||
tmp_arr = [];
|
||||
|
||||
if (!data) {
|
||||
return data;
|
||||
}
|
||||
|
||||
data += '';
|
||||
|
||||
do { // unpack four hexets into three octets using index points in b64
|
||||
h1 = b64.indexOf(data.charAt(i++));
|
||||
h2 = b64.indexOf(data.charAt(i++));
|
||||
h3 = b64.indexOf(data.charAt(i++));
|
||||
h4 = b64.indexOf(data.charAt(i++));
|
||||
|
||||
bits = h1 << 18 | h2 << 12 | h3 << 6 | h4;
|
||||
|
||||
o1 = bits >> 16 & 0xff;
|
||||
o2 = bits >> 8 & 0xff;
|
||||
o3 = bits & 0xff;
|
||||
|
||||
if (h3 == 64) {
|
||||
tmp_arr[ac++] = String.fromCharCode(o1);
|
||||
} else if (h4 == 64) {
|
||||
tmp_arr[ac++] = String.fromCharCode(o1, o2);
|
||||
} else {
|
||||
tmp_arr[ac++] = String.fromCharCode(o1, o2, o3);
|
||||
}
|
||||
} while (i < data.length);
|
||||
|
||||
dec = tmp_arr.join('');
|
||||
|
||||
return dec;
|
||||
}
|
||||
|
||||
/**
|
||||
* The string representation of this value
|
||||
* @return {String}
|
||||
*/
|
||||
toString() {
|
||||
return this.value;
|
||||
}
|
||||
}
|
||||
export default Binary;
|
||||
+635
@@ -0,0 +1,635 @@
|
||||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
* Portions Copyright (C) Philipp Kewisch */
|
||||
|
||||
import Property from "./property.js";
|
||||
import Timezone from "./timezone.js";
|
||||
import ICALParse from "./parse.js";
|
||||
import stringify from "./stringify.js";
|
||||
import design from "./design.js";
|
||||
// needed for typescript type resolution
|
||||
// eslint-disable-next-line no-unused-vars
|
||||
import Duration from "./duration.js";
|
||||
// needed for typescript type resolution
|
||||
// eslint-disable-next-line no-unused-vars
|
||||
import UtcOffset from "./utc_offset.js";
|
||||
// needed for typescript type resolution
|
||||
// eslint-disable-next-line no-unused-vars
|
||||
import Binary from "./binary.js";
|
||||
// needed for typescript type resolution
|
||||
// eslint-disable-next-line no-unused-vars
|
||||
import Period from "./period.js";
|
||||
// needed for typescript type resolution
|
||||
// eslint-disable-next-line no-unused-vars
|
||||
import Recur from "./recur.js";
|
||||
// needed for typescript type resolution
|
||||
// eslint-disable-next-line no-unused-vars
|
||||
import Time from "./time.js";
|
||||
|
||||
/**
|
||||
* This lets typescript resolve our custom types in the
|
||||
* generated d.ts files (jsdoc typedefs are converted to typescript types).
|
||||
* Ignore prevents the typedefs from being documented more than once.
|
||||
* @ignore
|
||||
* @typedef {import("./types.js").designSet} designSet
|
||||
* Imports the 'designSet' type from the "types.js" module
|
||||
* @typedef {import("./types.js").Geo} Geo
|
||||
* Imports the 'Geo' type from the "types.js" module
|
||||
*/
|
||||
|
||||
const NAME_INDEX = 0;
|
||||
const PROPERTY_INDEX = 1;
|
||||
const COMPONENT_INDEX = 2;
|
||||
|
||||
const PROPERTY_NAME_INDEX = 0;
|
||||
const PROPERTY_VALUE_INDEX = 3;
|
||||
|
||||
/**
|
||||
* Wraps a jCal component, adding convenience methods to add, remove and update subcomponents and
|
||||
* properties.
|
||||
*
|
||||
* @memberof ICAL
|
||||
*/
|
||||
class Component {
|
||||
/**
|
||||
* Create an {@link ICAL.Component} by parsing the passed iCalendar string.
|
||||
*
|
||||
* @param {String} str The iCalendar string to parse
|
||||
*/
|
||||
static fromString(str) {
|
||||
return new Component(ICALParse.component(str));
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new Component instance.
|
||||
*
|
||||
* @param {Array|String} jCal Raw jCal component data OR name of new
|
||||
* component
|
||||
* @param {Component=} parent Parent component to associate
|
||||
*/
|
||||
constructor(jCal, parent) {
|
||||
if (typeof(jCal) === 'string') {
|
||||
// jCal spec (name, properties, components)
|
||||
jCal = [jCal, [], []];
|
||||
}
|
||||
|
||||
// mostly for legacy reasons.
|
||||
this.jCal = jCal;
|
||||
|
||||
this.parent = parent || null;
|
||||
|
||||
if (!this.parent && this.name === 'vcalendar') {
|
||||
this._timezoneCache = new Map();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Hydrated properties are inserted into the _properties array at the same
|
||||
* position as in the jCal array, so it is possible that the array contains
|
||||
* undefined values for unhydrdated properties. To avoid iterating the
|
||||
* array when checking if all properties have been hydrated, we save the
|
||||
* count here.
|
||||
*
|
||||
* @type {Number}
|
||||
* @private
|
||||
*/
|
||||
_hydratedPropertyCount = 0;
|
||||
|
||||
/**
|
||||
* The same count as for _hydratedPropertyCount, but for subcomponents
|
||||
*
|
||||
* @type {Number}
|
||||
* @private
|
||||
*/
|
||||
_hydratedComponentCount = 0;
|
||||
|
||||
/**
|
||||
* A cache of hydrated time zone objects which may be used by consumers, keyed
|
||||
* by time zone ID.
|
||||
*
|
||||
* @type {Map}
|
||||
* @private
|
||||
*/
|
||||
_timezoneCache = null;
|
||||
|
||||
/**
|
||||
* @private
|
||||
*/
|
||||
_components = null;
|
||||
|
||||
/**
|
||||
* @private
|
||||
*/
|
||||
_properties = null;
|
||||
|
||||
/**
|
||||
* The name of this component
|
||||
*
|
||||
* @type {String}
|
||||
*/
|
||||
get name() {
|
||||
return this.jCal[NAME_INDEX];
|
||||
}
|
||||
|
||||
/**
|
||||
* The design set for this component, e.g. icalendar vs vcard
|
||||
*
|
||||
* @type {designSet}
|
||||
* @private
|
||||
*/
|
||||
get _designSet() {
|
||||
let parentDesign = this.parent && this.parent._designSet;
|
||||
if (!parentDesign && this.name == "vcard") {
|
||||
// We can't decide on vcard3 vs vcard4 just based on the component name, the version number is
|
||||
// in the version property. We also can't use hydrated properties here because it would lead
|
||||
// to recursion, but the spec says that the version property needs to be the very first one.
|
||||
let versionProp = this.jCal[PROPERTY_INDEX]?.[0];
|
||||
|
||||
if (versionProp && versionProp[PROPERTY_NAME_INDEX] == "version" && versionProp[PROPERTY_VALUE_INDEX] == "3.0") {
|
||||
return design.getDesignSet("vcard3");
|
||||
}
|
||||
}
|
||||
|
||||
return parentDesign || design.getDesignSet(this.name);
|
||||
}
|
||||
|
||||
/**
|
||||
* @private
|
||||
*/
|
||||
_hydrateComponent(index) {
|
||||
if (!this._components) {
|
||||
this._components = [];
|
||||
this._hydratedComponentCount = 0;
|
||||
}
|
||||
|
||||
if (this._components[index]) {
|
||||
return this._components[index];
|
||||
}
|
||||
|
||||
let comp = new Component(
|
||||
this.jCal[COMPONENT_INDEX][index],
|
||||
this
|
||||
);
|
||||
|
||||
this._hydratedComponentCount++;
|
||||
return (this._components[index] = comp);
|
||||
}
|
||||
|
||||
/**
|
||||
* @private
|
||||
*/
|
||||
_hydrateProperty(index) {
|
||||
if (!this._properties) {
|
||||
this._properties = [];
|
||||
this._hydratedPropertyCount = 0;
|
||||
}
|
||||
|
||||
if (this._properties[index]) {
|
||||
return this._properties[index];
|
||||
}
|
||||
|
||||
let prop = new Property(
|
||||
this.jCal[PROPERTY_INDEX][index],
|
||||
this
|
||||
);
|
||||
|
||||
this._hydratedPropertyCount++;
|
||||
return (this._properties[index] = prop);
|
||||
}
|
||||
|
||||
/**
|
||||
* Finds first sub component, optionally filtered by name.
|
||||
*
|
||||
* @param {String=} name Optional name to filter by
|
||||
* @return {?Component} The found subcomponent
|
||||
*/
|
||||
getFirstSubcomponent(name) {
|
||||
if (name) {
|
||||
let i = 0;
|
||||
let comps = this.jCal[COMPONENT_INDEX];
|
||||
let len = comps.length;
|
||||
|
||||
for (; i < len; i++) {
|
||||
if (comps[i][NAME_INDEX] === name) {
|
||||
let result = this._hydrateComponent(i);
|
||||
return result;
|
||||
}
|
||||
}
|
||||
} else {
|
||||
if (this.jCal[COMPONENT_INDEX].length) {
|
||||
return this._hydrateComponent(0);
|
||||
}
|
||||
}
|
||||
|
||||
// ensure we return a value (strict mode)
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Finds all sub components, optionally filtering by name.
|
||||
*
|
||||
* @param {String=} name Optional name to filter by
|
||||
* @return {Component[]} The found sub components
|
||||
*/
|
||||
getAllSubcomponents(name) {
|
||||
let jCalLen = this.jCal[COMPONENT_INDEX].length;
|
||||
let i = 0;
|
||||
|
||||
if (name) {
|
||||
let comps = this.jCal[COMPONENT_INDEX];
|
||||
let result = [];
|
||||
|
||||
for (; i < jCalLen; i++) {
|
||||
if (name === comps[i][NAME_INDEX]) {
|
||||
result.push(
|
||||
this._hydrateComponent(i)
|
||||
);
|
||||
}
|
||||
}
|
||||
return result;
|
||||
} else {
|
||||
if (!this._components ||
|
||||
(this._hydratedComponentCount !== jCalLen)) {
|
||||
for (; i < jCalLen; i++) {
|
||||
this._hydrateComponent(i);
|
||||
}
|
||||
}
|
||||
|
||||
return this._components || [];
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns true when a named property exists.
|
||||
*
|
||||
* @param {String} name The property name
|
||||
* @return {Boolean} True, when property is found
|
||||
*/
|
||||
hasProperty(name) {
|
||||
let props = this.jCal[PROPERTY_INDEX];
|
||||
let len = props.length;
|
||||
|
||||
let i = 0;
|
||||
for (; i < len; i++) {
|
||||
// 0 is property name
|
||||
if (props[i][NAME_INDEX] === name) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Finds the first property, optionally with the given name.
|
||||
*
|
||||
* @param {String=} name Lowercase property name
|
||||
* @return {?Property} The found property
|
||||
*/
|
||||
getFirstProperty(name) {
|
||||
if (name) {
|
||||
let i = 0;
|
||||
let props = this.jCal[PROPERTY_INDEX];
|
||||
let len = props.length;
|
||||
|
||||
for (; i < len; i++) {
|
||||
if (props[i][NAME_INDEX] === name) {
|
||||
let result = this._hydrateProperty(i);
|
||||
return result;
|
||||
}
|
||||
}
|
||||
} else {
|
||||
if (this.jCal[PROPERTY_INDEX].length) {
|
||||
return this._hydrateProperty(0);
|
||||
}
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns first property's value, if available.
|
||||
*
|
||||
* @param {String=} name Lowercase property name
|
||||
* @return {Binary | Duration | Period |
|
||||
* Recur | Time | UtcOffset | Geo | string | null} The found property value.
|
||||
*/
|
||||
getFirstPropertyValue(name) {
|
||||
let prop = this.getFirstProperty(name);
|
||||
if (prop) {
|
||||
return prop.getFirstValue();
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all properties in the component, optionally filtered by name.
|
||||
*
|
||||
* @param {String=} name Lowercase property name
|
||||
* @return {Property[]} List of properties
|
||||
*/
|
||||
getAllProperties(name) {
|
||||
let jCalLen = this.jCal[PROPERTY_INDEX].length;
|
||||
let i = 0;
|
||||
|
||||
if (name) {
|
||||
let props = this.jCal[PROPERTY_INDEX];
|
||||
let result = [];
|
||||
|
||||
for (; i < jCalLen; i++) {
|
||||
if (name === props[i][NAME_INDEX]) {
|
||||
result.push(
|
||||
this._hydrateProperty(i)
|
||||
);
|
||||
}
|
||||
}
|
||||
return result;
|
||||
} else {
|
||||
if (!this._properties ||
|
||||
(this._hydratedPropertyCount !== jCalLen)) {
|
||||
for (; i < jCalLen; i++) {
|
||||
this._hydrateProperty(i);
|
||||
}
|
||||
}
|
||||
|
||||
return this._properties || [];
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @private
|
||||
*/
|
||||
_removeObjectByIndex(jCalIndex, cache, index) {
|
||||
cache = cache || [];
|
||||
// remove cached version
|
||||
if (cache[index]) {
|
||||
let obj = cache[index];
|
||||
if ("parent" in obj) {
|
||||
obj.parent = null;
|
||||
}
|
||||
}
|
||||
|
||||
cache.splice(index, 1);
|
||||
|
||||
// remove it from the jCal
|
||||
this.jCal[jCalIndex].splice(index, 1);
|
||||
}
|
||||
|
||||
/**
|
||||
* @private
|
||||
*/
|
||||
_removeObject(jCalIndex, cache, nameOrObject) {
|
||||
let i = 0;
|
||||
let objects = this.jCal[jCalIndex];
|
||||
let len = objects.length;
|
||||
let cached = this[cache];
|
||||
|
||||
if (typeof(nameOrObject) === 'string') {
|
||||
for (; i < len; i++) {
|
||||
if (objects[i][NAME_INDEX] === nameOrObject) {
|
||||
this._removeObjectByIndex(jCalIndex, cached, i);
|
||||
return true;
|
||||
}
|
||||
}
|
||||
} else if (cached) {
|
||||
for (; i < len; i++) {
|
||||
if (cached[i] && cached[i] === nameOrObject) {
|
||||
this._removeObjectByIndex(jCalIndex, cached, i);
|
||||
return true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* @private
|
||||
*/
|
||||
_removeAllObjects(jCalIndex, cache, name) {
|
||||
let cached = this[cache];
|
||||
|
||||
// Unfortunately we have to run through all children to reset their
|
||||
// parent property.
|
||||
let objects = this.jCal[jCalIndex];
|
||||
let i = objects.length - 1;
|
||||
|
||||
// descending search required because splice
|
||||
// is used and will effect the indices.
|
||||
for (; i >= 0; i--) {
|
||||
if (!name || objects[i][NAME_INDEX] === name) {
|
||||
this._removeObjectByIndex(jCalIndex, cached, i);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds a single sub component.
|
||||
*
|
||||
* @param {Component} component The component to add
|
||||
* @return {Component} The passed in component
|
||||
*/
|
||||
addSubcomponent(component) {
|
||||
if (!this._components) {
|
||||
this._components = [];
|
||||
this._hydratedComponentCount = 0;
|
||||
}
|
||||
|
||||
if (component.parent) {
|
||||
component.parent.removeSubcomponent(component);
|
||||
}
|
||||
|
||||
let idx = this.jCal[COMPONENT_INDEX].push(component.jCal);
|
||||
this._components[idx - 1] = component;
|
||||
this._hydratedComponentCount++;
|
||||
component.parent = this;
|
||||
return component;
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes a single component by name or the instance of a specific
|
||||
* component.
|
||||
*
|
||||
* @param {Component|String} nameOrComp Name of component, or component
|
||||
* @return {Boolean} True when comp is removed
|
||||
*/
|
||||
removeSubcomponent(nameOrComp) {
|
||||
let removed = this._removeObject(COMPONENT_INDEX, '_components', nameOrComp);
|
||||
if (removed) {
|
||||
this._hydratedComponentCount--;
|
||||
}
|
||||
return removed;
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes all components or (if given) all components by a particular
|
||||
* name.
|
||||
*
|
||||
* @param {String=} name Lowercase component name
|
||||
*/
|
||||
removeAllSubcomponents(name) {
|
||||
let removed = this._removeAllObjects(COMPONENT_INDEX, '_components', name);
|
||||
this._hydratedComponentCount = 0;
|
||||
return removed;
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds an {@link ICAL.Property} to the component.
|
||||
*
|
||||
* @param {Property} property The property to add
|
||||
* @return {Property} The passed in property
|
||||
*/
|
||||
addProperty(property) {
|
||||
if (!(property instanceof Property)) {
|
||||
throw new TypeError('must be instance of ICAL.Property');
|
||||
}
|
||||
|
||||
if (!this._properties) {
|
||||
this._properties = [];
|
||||
this._hydratedPropertyCount = 0;
|
||||
}
|
||||
|
||||
if (property.parent) {
|
||||
property.parent.removeProperty(property);
|
||||
}
|
||||
|
||||
let idx = this.jCal[PROPERTY_INDEX].push(property.jCal);
|
||||
this._properties[idx - 1] = property;
|
||||
this._hydratedPropertyCount++;
|
||||
property.parent = this;
|
||||
return property;
|
||||
}
|
||||
|
||||
/**
|
||||
* Helper method to add a property with a value to the component.
|
||||
*
|
||||
* @param {String} name Property name to add
|
||||
* @param {String|Number|Object} value Property value
|
||||
* @return {Property} The created property
|
||||
*/
|
||||
addPropertyWithValue(name, value) {
|
||||
let prop = new Property(name);
|
||||
prop.setValue(value);
|
||||
|
||||
this.addProperty(prop);
|
||||
|
||||
return prop;
|
||||
}
|
||||
|
||||
/**
|
||||
* Helper method that will update or create a property of the given name
|
||||
* and sets its value. If multiple properties with the given name exist,
|
||||
* only the first is updated.
|
||||
*
|
||||
* @param {String} name Property name to update
|
||||
* @param {String|Number|Object} value Property value
|
||||
* @return {Property} The created property
|
||||
*/
|
||||
updatePropertyWithValue(name, value) {
|
||||
let prop = this.getFirstProperty(name);
|
||||
|
||||
if (prop) {
|
||||
prop.setValue(value);
|
||||
} else {
|
||||
prop = this.addPropertyWithValue(name, value);
|
||||
}
|
||||
|
||||
return prop;
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes a single property by name or the instance of the specific
|
||||
* property.
|
||||
*
|
||||
* @param {String|Property} nameOrProp Property name or instance to remove
|
||||
* @return {Boolean} True, when deleted
|
||||
*/
|
||||
removeProperty(nameOrProp) {
|
||||
let removed = this._removeObject(PROPERTY_INDEX, '_properties', nameOrProp);
|
||||
if (removed) {
|
||||
this._hydratedPropertyCount--;
|
||||
}
|
||||
return removed;
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes all properties associated with this component, optionally
|
||||
* filtered by name.
|
||||
*
|
||||
* @param {String=} name Lowercase property name
|
||||
* @return {Boolean} True, when deleted
|
||||
*/
|
||||
removeAllProperties(name) {
|
||||
let removed = this._removeAllObjects(PROPERTY_INDEX, '_properties', name);
|
||||
this._hydratedPropertyCount = 0;
|
||||
return removed;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the Object representation of this component. The returned object
|
||||
* is a live jCal object and should be cloned if modified.
|
||||
* @return {Object}
|
||||
*/
|
||||
toJSON() {
|
||||
return this.jCal;
|
||||
}
|
||||
|
||||
/**
|
||||
* The string representation of this component.
|
||||
* @return {String}
|
||||
*/
|
||||
toString() {
|
||||
return stringify.component(
|
||||
this.jCal, this._designSet
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve a time zone definition from the component tree, if any is present.
|
||||
* If the tree contains no time zone definitions or the TZID cannot be
|
||||
* matched, returns null.
|
||||
*
|
||||
* @param {String} tzid The ID of the time zone to retrieve
|
||||
* @return {Timezone} The time zone corresponding to the ID, or null
|
||||
*/
|
||||
getTimeZoneByID(tzid) {
|
||||
// VTIMEZONE components can only appear as a child of the VCALENDAR
|
||||
// component; walk the tree if we're not the root.
|
||||
if (this.parent) {
|
||||
return this.parent.getTimeZoneByID(tzid);
|
||||
}
|
||||
|
||||
// If there is no time zone cache, we are probably parsing an incomplete
|
||||
// file and will have no time zone definitions.
|
||||
if (!this._timezoneCache) {
|
||||
return null;
|
||||
}
|
||||
|
||||
if (this._timezoneCache.has(tzid)) {
|
||||
return this._timezoneCache.get(tzid);
|
||||
}
|
||||
|
||||
// If the time zone is not already cached, hydrate it from the
|
||||
// subcomponents.
|
||||
const zones = this.getAllSubcomponents('vtimezone');
|
||||
for (const zone of zones) {
|
||||
if (zone.getFirstProperty('tzid').getFirstValue() === tzid) {
|
||||
const hydratedZone = new Timezone({
|
||||
component: zone,
|
||||
tzid: tzid,
|
||||
});
|
||||
|
||||
this._timezoneCache.set(tzid, hydratedZone);
|
||||
|
||||
return hydratedZone;
|
||||
}
|
||||
}
|
||||
|
||||
// Per the standard, we should always have a time zone defined in a file
|
||||
// for any referenced TZID, but don't blow up if the file is invalid.
|
||||
return null;
|
||||
}
|
||||
}
|
||||
export default Component;
|
||||
+157
@@ -0,0 +1,157 @@
|
||||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
* Portions Copyright (C) Philipp Kewisch */
|
||||
|
||||
import ICALParse from "./parse.js";
|
||||
import Component from "./component.js";
|
||||
import Event from "./event.js";
|
||||
import Timezone from "./timezone.js";
|
||||
|
||||
/**
|
||||
* The ComponentParser is used to process a String or jCal Object,
|
||||
* firing callbacks for various found components, as well as completion.
|
||||
*
|
||||
* @example
|
||||
* var options = {
|
||||
* // when false no events will be emitted for type
|
||||
* parseEvent: true,
|
||||
* parseTimezone: true
|
||||
* };
|
||||
*
|
||||
* var parser = new ICAL.ComponentParser(options);
|
||||
*
|
||||
* parser.onevent(eventComponent) {
|
||||
* //...
|
||||
* }
|
||||
*
|
||||
* // ontimezone, etc...
|
||||
*
|
||||
* parser.oncomplete = function() {
|
||||
*
|
||||
* };
|
||||
*
|
||||
* parser.process(stringOrComponent);
|
||||
*
|
||||
* @memberof ICAL
|
||||
*/
|
||||
class ComponentParser {
|
||||
/**
|
||||
* Creates a new ICAL.ComponentParser instance.
|
||||
*
|
||||
* @param {Object=} options Component parser options
|
||||
* @param {Boolean} options.parseEvent Whether events should be parsed
|
||||
* @param {Boolean} options.parseTimezeone Whether timezones should be parsed
|
||||
*/
|
||||
constructor(options) {
|
||||
if (typeof(options) === 'undefined') {
|
||||
options = {};
|
||||
}
|
||||
|
||||
for (let [key, value] of Object.entries(options)) {
|
||||
this[key] = value;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* When true, parse events
|
||||
*
|
||||
* @type {Boolean}
|
||||
*/
|
||||
parseEvent = true;
|
||||
|
||||
/**
|
||||
* When true, parse timezones
|
||||
*
|
||||
* @type {Boolean}
|
||||
*/
|
||||
parseTimezone = true;
|
||||
|
||||
|
||||
/* SAX like events here for reference */
|
||||
|
||||
/**
|
||||
* Fired when parsing is complete
|
||||
* @callback
|
||||
*/
|
||||
oncomplete = /* c8 ignore next */ function() {};
|
||||
|
||||
/**
|
||||
* Fired if an error occurs during parsing.
|
||||
*
|
||||
* @callback
|
||||
* @param {Error} err details of error
|
||||
*/
|
||||
onerror = /* c8 ignore next */ function(err) {};
|
||||
|
||||
/**
|
||||
* Fired when a top level component (VTIMEZONE) is found
|
||||
*
|
||||
* @callback
|
||||
* @param {Timezone} component Timezone object
|
||||
*/
|
||||
ontimezone = /* c8 ignore next */ function(component) {};
|
||||
|
||||
/**
|
||||
* Fired when a top level component (VEVENT) is found.
|
||||
*
|
||||
* @callback
|
||||
* @param {Event} component Top level component
|
||||
*/
|
||||
onevent = /* c8 ignore next */ function(component) {};
|
||||
|
||||
/**
|
||||
* Process a string or parse ical object. This function itself will return
|
||||
* nothing but will start the parsing process.
|
||||
*
|
||||
* Events must be registered prior to calling this method.
|
||||
*
|
||||
* @param {Component|String|Object} ical The component to process,
|
||||
* either in its final form, as a jCal Object, or string representation
|
||||
*/
|
||||
process(ical) {
|
||||
//TODO: this is sync now in the future we will have a incremental parser.
|
||||
if (typeof(ical) === 'string') {
|
||||
ical = ICALParse(ical);
|
||||
}
|
||||
|
||||
if (!(ical instanceof Component)) {
|
||||
ical = new Component(ical);
|
||||
}
|
||||
|
||||
let components = ical.getAllSubcomponents();
|
||||
let i = 0;
|
||||
let len = components.length;
|
||||
let component;
|
||||
|
||||
for (; i < len; i++) {
|
||||
component = components[i];
|
||||
|
||||
switch (component.name) {
|
||||
case 'vtimezone':
|
||||
if (this.parseTimezone) {
|
||||
let tzid = component.getFirstPropertyValue('tzid');
|
||||
if (tzid) {
|
||||
this.ontimezone(new Timezone({
|
||||
tzid: tzid,
|
||||
component: component
|
||||
}));
|
||||
}
|
||||
}
|
||||
break;
|
||||
case 'vevent':
|
||||
if (this.parseEvent) {
|
||||
this.onevent(new Event(component));
|
||||
}
|
||||
break;
|
||||
default:
|
||||
continue;
|
||||
}
|
||||
}
|
||||
|
||||
//XXX: ideally we should do a "nextTick" here
|
||||
// so in all cases this is actually async.
|
||||
this.oncomplete();
|
||||
}
|
||||
}
|
||||
export default ComponentParser;
|
||||
+1029
File diff suppressed because it is too large
Load Diff
+374
@@ -0,0 +1,374 @@
|
||||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
* Portions Copyright (C) Philipp Kewisch */
|
||||
|
||||
import { isStrictlyNaN, trunc } from "./helpers.js";
|
||||
|
||||
const DURATION_LETTERS = /([PDWHMTS]{1,1})/;
|
||||
const DATA_PROPS_TO_COPY = ["weeks", "days", "hours", "minutes", "seconds", "isNegative"];
|
||||
|
||||
/**
|
||||
* This class represents the "duration" value type, with various calculation
|
||||
* and manipulation methods.
|
||||
*
|
||||
* @memberof ICAL
|
||||
*/
|
||||
class Duration {
|
||||
/**
|
||||
* Returns a new ICAL.Duration instance from the passed seconds value.
|
||||
*
|
||||
* @param {Number} aSeconds The seconds to create the instance from
|
||||
* @return {Duration} The newly created duration instance
|
||||
*/
|
||||
static fromSeconds(aSeconds) {
|
||||
return (new Duration()).fromSeconds(aSeconds);
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if the given string is an iCalendar duration value.
|
||||
*
|
||||
* @param {String} value The raw ical value
|
||||
* @return {Boolean} True, if the given value is of the
|
||||
* duration ical type
|
||||
*/
|
||||
static isValueString(string) {
|
||||
return (string[0] === 'P' || string[1] === 'P');
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new {@link ICAL.Duration} instance from the passed string.
|
||||
*
|
||||
* @param {String} aStr The string to parse
|
||||
* @return {Duration} The created duration instance
|
||||
*/
|
||||
static fromString(aStr) {
|
||||
let pos = 0;
|
||||
let dict = Object.create(null);
|
||||
let chunks = 0;
|
||||
|
||||
while ((pos = aStr.search(DURATION_LETTERS)) !== -1) {
|
||||
let type = aStr[pos];
|
||||
let numeric = aStr.slice(0, Math.max(0, pos));
|
||||
aStr = aStr.slice(pos + 1);
|
||||
|
||||
chunks += parseDurationChunk(type, numeric, dict);
|
||||
}
|
||||
|
||||
if (chunks < 2) {
|
||||
// There must be at least a chunk with "P" and some unit chunk
|
||||
throw new Error(
|
||||
'invalid duration value: Not enough duration components in "' + aStr + '"'
|
||||
);
|
||||
}
|
||||
|
||||
return new Duration(dict);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new ICAL.Duration instance from the given data object.
|
||||
*
|
||||
* @param {Object} aData An object with members of the duration
|
||||
* @param {Number=} aData.weeks Duration in weeks
|
||||
* @param {Number=} aData.days Duration in days
|
||||
* @param {Number=} aData.hours Duration in hours
|
||||
* @param {Number=} aData.minutes Duration in minutes
|
||||
* @param {Number=} aData.seconds Duration in seconds
|
||||
* @param {Boolean=} aData.isNegative If true, the duration is negative
|
||||
* @return {Duration} The createad duration instance
|
||||
*/
|
||||
static fromData(aData) {
|
||||
return new Duration(aData);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new ICAL.Duration instance.
|
||||
*
|
||||
* @param {Object} data An object with members of the duration
|
||||
* @param {Number=} data.weeks Duration in weeks
|
||||
* @param {Number=} data.days Duration in days
|
||||
* @param {Number=} data.hours Duration in hours
|
||||
* @param {Number=} data.minutes Duration in minutes
|
||||
* @param {Number=} data.seconds Duration in seconds
|
||||
* @param {Boolean=} data.isNegative If true, the duration is negative
|
||||
*/
|
||||
constructor(data) {
|
||||
this.wrappedJSObject = this;
|
||||
this.fromData(data);
|
||||
}
|
||||
|
||||
/**
|
||||
* The weeks in this duration
|
||||
* @type {Number}
|
||||
* @default 0
|
||||
*/
|
||||
weeks = 0;
|
||||
|
||||
/**
|
||||
* The days in this duration
|
||||
* @type {Number}
|
||||
* @default 0
|
||||
*/
|
||||
days = 0;
|
||||
|
||||
/**
|
||||
* The days in this duration
|
||||
* @type {Number}
|
||||
* @default 0
|
||||
*/
|
||||
hours = 0;
|
||||
|
||||
/**
|
||||
* The minutes in this duration
|
||||
* @type {Number}
|
||||
* @default 0
|
||||
*/
|
||||
minutes = 0;
|
||||
|
||||
/**
|
||||
* The seconds in this duration
|
||||
* @type {Number}
|
||||
* @default 0
|
||||
*/
|
||||
seconds = 0;
|
||||
|
||||
/**
|
||||
* The seconds in this duration
|
||||
* @type {Boolean}
|
||||
* @default false
|
||||
*/
|
||||
isNegative = false;
|
||||
|
||||
/**
|
||||
* The class identifier.
|
||||
* @constant
|
||||
* @type {String}
|
||||
* @default "icalduration"
|
||||
*/
|
||||
icalclass = "icalduration";
|
||||
|
||||
/**
|
||||
* The type name, to be used in the jCal object.
|
||||
* @constant
|
||||
* @type {String}
|
||||
* @default "duration"
|
||||
*/
|
||||
icaltype = "duration";
|
||||
|
||||
/**
|
||||
* Returns a clone of the duration object.
|
||||
*
|
||||
* @return {Duration} The cloned object
|
||||
*/
|
||||
clone() {
|
||||
return Duration.fromData(this);
|
||||
}
|
||||
|
||||
/**
|
||||
* The duration value expressed as a number of seconds.
|
||||
*
|
||||
* @return {Number} The duration value in seconds
|
||||
*/
|
||||
toSeconds() {
|
||||
let seconds = this.seconds + 60 * this.minutes + 3600 * this.hours +
|
||||
86400 * this.days + 7 * 86400 * this.weeks;
|
||||
return (this.isNegative ? -seconds : seconds);
|
||||
}
|
||||
|
||||
/**
|
||||
* Reads the passed seconds value into this duration object. Afterwards,
|
||||
* members like {@link ICAL.Duration#days days} and {@link ICAL.Duration#weeks weeks} will be set up
|
||||
* accordingly.
|
||||
*
|
||||
* @param {Number} aSeconds The duration value in seconds
|
||||
* @return {Duration} Returns this instance
|
||||
*/
|
||||
fromSeconds(aSeconds) {
|
||||
let secs = Math.abs(aSeconds);
|
||||
|
||||
this.isNegative = (aSeconds < 0);
|
||||
this.days = trunc(secs / 86400);
|
||||
|
||||
// If we have a flat number of weeks, use them.
|
||||
if (this.days % 7 == 0) {
|
||||
this.weeks = this.days / 7;
|
||||
this.days = 0;
|
||||
} else {
|
||||
this.weeks = 0;
|
||||
}
|
||||
|
||||
secs -= (this.days + 7 * this.weeks) * 86400;
|
||||
|
||||
this.hours = trunc(secs / 3600);
|
||||
secs -= this.hours * 3600;
|
||||
|
||||
this.minutes = trunc(secs / 60);
|
||||
secs -= this.minutes * 60;
|
||||
|
||||
this.seconds = secs;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets up the current instance using members from the passed data object.
|
||||
*
|
||||
* @param {Object} aData An object with members of the duration
|
||||
* @param {Number=} aData.weeks Duration in weeks
|
||||
* @param {Number=} aData.days Duration in days
|
||||
* @param {Number=} aData.hours Duration in hours
|
||||
* @param {Number=} aData.minutes Duration in minutes
|
||||
* @param {Number=} aData.seconds Duration in seconds
|
||||
* @param {Boolean=} aData.isNegative If true, the duration is negative
|
||||
*/
|
||||
fromData(aData) {
|
||||
for (let prop of DATA_PROPS_TO_COPY) {
|
||||
if (aData && prop in aData) {
|
||||
this[prop] = aData[prop];
|
||||
} else {
|
||||
this[prop] = 0;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Resets the duration instance to the default values, i.e. PT0S
|
||||
*/
|
||||
reset() {
|
||||
this.isNegative = false;
|
||||
this.weeks = 0;
|
||||
this.days = 0;
|
||||
this.hours = 0;
|
||||
this.minutes = 0;
|
||||
this.seconds = 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Compares the duration instance with another one.
|
||||
*
|
||||
* @param {Duration} aOther The instance to compare with
|
||||
* @return {Number} -1, 0 or 1 for less/equal/greater
|
||||
*/
|
||||
compare(aOther) {
|
||||
let thisSeconds = this.toSeconds();
|
||||
let otherSeconds = aOther.toSeconds();
|
||||
return (thisSeconds > otherSeconds) - (thisSeconds < otherSeconds);
|
||||
}
|
||||
|
||||
/**
|
||||
* Normalizes the duration instance. For example, a duration with a value
|
||||
* of 61 seconds will be normalized to 1 minute and 1 second.
|
||||
*/
|
||||
normalize() {
|
||||
this.fromSeconds(this.toSeconds());
|
||||
}
|
||||
|
||||
/**
|
||||
* The string representation of this duration.
|
||||
* @return {String}
|
||||
*/
|
||||
toString() {
|
||||
if (this.toSeconds() == 0) {
|
||||
return "PT0S";
|
||||
} else {
|
||||
let str = "";
|
||||
if (this.isNegative) str += "-";
|
||||
str += "P";
|
||||
let hasWeeks = false;
|
||||
if (this.weeks) {
|
||||
if (this.days || this.hours || this.minutes || this.seconds) {
|
||||
str += (this.weeks * 7 + this.days) + "D";
|
||||
} else {
|
||||
str += (this.weeks + "W");
|
||||
hasWeeks = true;
|
||||
}
|
||||
} else if (this.days) {
|
||||
str += (this.days + "D");
|
||||
}
|
||||
|
||||
if (!hasWeeks) {
|
||||
if (this.hours || this.minutes || this.seconds) {
|
||||
str += "T";
|
||||
if (this.hours) {
|
||||
str += this.hours + "H";
|
||||
}
|
||||
|
||||
if (this.minutes) {
|
||||
str += this.minutes + "M";
|
||||
}
|
||||
|
||||
if (this.seconds) {
|
||||
str += this.seconds + "S";
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return str;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* The iCalendar string representation of this duration.
|
||||
* @return {String}
|
||||
*/
|
||||
toICALString() {
|
||||
return this.toString();
|
||||
}
|
||||
}
|
||||
export default Duration;
|
||||
|
||||
/**
|
||||
* Internal helper function to handle a chunk of a duration.
|
||||
*
|
||||
* @private
|
||||
* @param {String} letter type of duration chunk
|
||||
* @param {String} number numeric value or -/+
|
||||
* @param {Object} dict target to assign values to
|
||||
*/
|
||||
function parseDurationChunk(letter, number, object) {
|
||||
let type;
|
||||
switch (letter) {
|
||||
case 'P':
|
||||
if (number && number === '-') {
|
||||
object.isNegative = true;
|
||||
} else {
|
||||
object.isNegative = false;
|
||||
}
|
||||
// period
|
||||
break;
|
||||
case 'D':
|
||||
type = 'days';
|
||||
break;
|
||||
case 'W':
|
||||
type = 'weeks';
|
||||
break;
|
||||
case 'H':
|
||||
type = 'hours';
|
||||
break;
|
||||
case 'M':
|
||||
type = 'minutes';
|
||||
break;
|
||||
case 'S':
|
||||
type = 'seconds';
|
||||
break;
|
||||
default:
|
||||
// Not a valid chunk
|
||||
return 0;
|
||||
}
|
||||
|
||||
if (type) {
|
||||
if (!number && number !== 0) {
|
||||
throw new Error(
|
||||
'invalid duration value: Missing number before "' + letter + '"'
|
||||
);
|
||||
}
|
||||
let num = parseInt(number, 10);
|
||||
if (isStrictlyNaN(num)) {
|
||||
throw new Error(
|
||||
'invalid duration value: Invalid number "' + number + '" before "' + letter + '"'
|
||||
);
|
||||
}
|
||||
object[type] = num;
|
||||
}
|
||||
|
||||
return 1;
|
||||
}
|
||||
+569
@@ -0,0 +1,569 @@
|
||||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
* Portions Copyright (C) Philipp Kewisch */
|
||||
|
||||
import { binsearchInsert } from "./helpers.js";
|
||||
import Component from "./component.js";
|
||||
import Property from "./property.js";
|
||||
import Timezone from "./timezone.js";
|
||||
// needed for typescript type resolution
|
||||
// eslint-disable-next-line no-unused-vars
|
||||
import Time from "./time.js";
|
||||
// eslint-disable-next-line no-unused-vars
|
||||
import Duration from "./duration.js";
|
||||
import RecurExpansion from "./recur_expansion.js";
|
||||
|
||||
/**
|
||||
* This lets typescript resolve our custom types in the
|
||||
* generated d.ts files (jsdoc typedefs are converted to typescript types).
|
||||
* Ignore prevents the typedefs from being documented more than once.
|
||||
* @ignore
|
||||
* @typedef {import("./types.js").frequencyValues} frequencyValues
|
||||
* Imports the 'frequencyValues' type from the "types.js" module
|
||||
* @typedef {import("./types.js").occurrenceDetails} occurrenceDetails
|
||||
* Imports the 'occurrenceDetails' type from the "types.js" module
|
||||
*/
|
||||
|
||||
/**
|
||||
* ICAL.js is organized into multiple layers. The bottom layer is a raw jCal
|
||||
* object, followed by the component/property layer. The highest level is the
|
||||
* event representation, which this class is part of. See the
|
||||
* {@tutorial layers} guide for more details.
|
||||
*
|
||||
* @memberof ICAL
|
||||
*/
|
||||
class Event {
|
||||
/**
|
||||
* Creates a new ICAL.Event instance.
|
||||
*
|
||||
* @param {Component=} component The ICAL.Component to base this event on
|
||||
* @param {Object} [options] Options for this event
|
||||
* @param {Boolean=} options.strictExceptions When true, will verify exceptions are related by
|
||||
* their UUID
|
||||
* @param {Array<Component|Event>=} options.exceptions
|
||||
* Exceptions to this event, either as components or events. If not
|
||||
* specified exceptions will automatically be set in relation of
|
||||
* component's parent
|
||||
*/
|
||||
constructor(component, options) {
|
||||
if (!(component instanceof Component)) {
|
||||
options = component;
|
||||
component = null;
|
||||
}
|
||||
|
||||
if (component) {
|
||||
this.component = component;
|
||||
} else {
|
||||
this.component = new Component('vevent');
|
||||
}
|
||||
|
||||
this._rangeExceptionCache = Object.create(null);
|
||||
this.exceptions = Object.create(null);
|
||||
this.rangeExceptions = [];
|
||||
|
||||
if (options && options.strictExceptions) {
|
||||
this.strictExceptions = options.strictExceptions;
|
||||
}
|
||||
|
||||
if (options && options.exceptions) {
|
||||
options.exceptions.forEach(this.relateException, this);
|
||||
} else if (this.component.parent && !this.isRecurrenceException()) {
|
||||
this.component.parent.getAllSubcomponents('vevent').forEach(function(event) {
|
||||
if (event.hasProperty('recurrence-id')) {
|
||||
this.relateException(event);
|
||||
}
|
||||
}, this);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
static THISANDFUTURE = 'THISANDFUTURE';
|
||||
|
||||
/**
|
||||
* List of related event exceptions.
|
||||
*
|
||||
* @type {Event[]}
|
||||
*/
|
||||
exceptions = null;
|
||||
|
||||
/**
|
||||
* When true, will verify exceptions are related by their UUID.
|
||||
*
|
||||
* @type {Boolean}
|
||||
*/
|
||||
strictExceptions = false;
|
||||
|
||||
/**
|
||||
* Relates a given event exception to this object. If the given component
|
||||
* does not share the UID of this event it cannot be related and will throw
|
||||
* an exception.
|
||||
*
|
||||
* If this component is an exception it cannot have other exceptions
|
||||
* related to it.
|
||||
*
|
||||
* @param {Component|Event} obj Component or event
|
||||
*/
|
||||
relateException(obj) {
|
||||
if (this.isRecurrenceException()) {
|
||||
throw new Error('cannot relate exception to exceptions');
|
||||
}
|
||||
|
||||
if (obj instanceof Component) {
|
||||
obj = new Event(obj);
|
||||
}
|
||||
|
||||
if (this.strictExceptions && obj.uid !== this.uid) {
|
||||
throw new Error('attempted to relate unrelated exception');
|
||||
}
|
||||
|
||||
let id = obj.recurrenceId.toString();
|
||||
|
||||
// we don't sort or manage exceptions directly
|
||||
// here the recurrence expander handles that.
|
||||
this.exceptions[id] = obj;
|
||||
|
||||
// index RANGE=THISANDFUTURE exceptions so we can
|
||||
// look them up later in getOccurrenceDetails.
|
||||
if (obj.modifiesFuture()) {
|
||||
let item = [
|
||||
obj.recurrenceId.toUnixTime(), id
|
||||
];
|
||||
|
||||
// we keep them sorted so we can find the nearest
|
||||
// value later on...
|
||||
let idx = binsearchInsert(
|
||||
this.rangeExceptions,
|
||||
item,
|
||||
compareRangeException
|
||||
);
|
||||
|
||||
this.rangeExceptions.splice(idx, 0, item);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if this record is an exception and has the RANGE=THISANDFUTURE
|
||||
* value.
|
||||
*
|
||||
* @return {Boolean} True, when exception is within range
|
||||
*/
|
||||
modifiesFuture() {
|
||||
if (!this.component.hasProperty('recurrence-id')) {
|
||||
return false;
|
||||
}
|
||||
|
||||
let range = this.component.getFirstProperty('recurrence-id').getParameter('range');
|
||||
return range === Event.THISANDFUTURE;
|
||||
}
|
||||
|
||||
/**
|
||||
* Finds the range exception nearest to the given date.
|
||||
*
|
||||
* @param {Time} time usually an occurrence time of an event
|
||||
* @return {?Event} the related event/exception or null
|
||||
*/
|
||||
findRangeException(time) {
|
||||
if (!this.rangeExceptions.length) {
|
||||
return null;
|
||||
}
|
||||
|
||||
let utc = time.toUnixTime();
|
||||
let idx = binsearchInsert(
|
||||
this.rangeExceptions,
|
||||
[utc],
|
||||
compareRangeException
|
||||
);
|
||||
|
||||
idx -= 1;
|
||||
|
||||
// occurs before
|
||||
if (idx < 0) {
|
||||
return null;
|
||||
}
|
||||
|
||||
let rangeItem = this.rangeExceptions[idx];
|
||||
|
||||
/* c8 ignore next 4 */
|
||||
if (utc < rangeItem[0]) {
|
||||
// sanity check only
|
||||
return null;
|
||||
}
|
||||
|
||||
return rangeItem[1];
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the occurrence details based on its start time. If the
|
||||
* occurrence has an exception will return the details for that exception.
|
||||
*
|
||||
* NOTE: this method is intend to be used in conjunction
|
||||
* with the {@link ICAL.Event#iterator iterator} method.
|
||||
*
|
||||
* @param {Time} occurrence time occurrence
|
||||
* @return {occurrenceDetails} Information about the occurrence
|
||||
*/
|
||||
getOccurrenceDetails(occurrence) {
|
||||
let id = occurrence.toString();
|
||||
let utcId = occurrence.convertToZone(Timezone.utcTimezone).toString();
|
||||
let item;
|
||||
let result = {
|
||||
//XXX: Clone?
|
||||
recurrenceId: occurrence
|
||||
};
|
||||
|
||||
if (id in this.exceptions) {
|
||||
item = result.item = this.exceptions[id];
|
||||
result.startDate = item.startDate;
|
||||
result.endDate = item.endDate;
|
||||
result.item = item;
|
||||
} else if (utcId in this.exceptions) {
|
||||
item = this.exceptions[utcId];
|
||||
result.startDate = item.startDate;
|
||||
result.endDate = item.endDate;
|
||||
result.item = item;
|
||||
} else {
|
||||
// range exceptions (RANGE=THISANDFUTURE) have a
|
||||
// lower priority then direct exceptions but
|
||||
// must be accounted for first. Their item is
|
||||
// always the first exception with the range prop.
|
||||
let rangeExceptionId = this.findRangeException(
|
||||
occurrence
|
||||
);
|
||||
let end;
|
||||
|
||||
if (rangeExceptionId) {
|
||||
let exception = this.exceptions[rangeExceptionId];
|
||||
|
||||
// range exception must modify standard time
|
||||
// by the difference (if any) in start/end times.
|
||||
result.item = exception;
|
||||
|
||||
let startDiff = this._rangeExceptionCache[rangeExceptionId];
|
||||
|
||||
if (!startDiff) {
|
||||
let original = exception.recurrenceId.clone();
|
||||
let newStart = exception.startDate.clone();
|
||||
|
||||
// zones must be same otherwise subtract may be incorrect.
|
||||
original.zone = newStart.zone;
|
||||
startDiff = newStart.subtractDate(original);
|
||||
|
||||
this._rangeExceptionCache[rangeExceptionId] = startDiff;
|
||||
}
|
||||
|
||||
let start = occurrence.clone();
|
||||
start.zone = exception.startDate.zone;
|
||||
start.addDuration(startDiff);
|
||||
|
||||
end = start.clone();
|
||||
end.addDuration(exception.duration);
|
||||
|
||||
result.startDate = start;
|
||||
result.endDate = end;
|
||||
} else {
|
||||
// no range exception standard expansion
|
||||
end = occurrence.clone();
|
||||
end.addDuration(this.duration);
|
||||
|
||||
result.endDate = end;
|
||||
result.startDate = occurrence;
|
||||
result.item = this;
|
||||
}
|
||||
}
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds a recur expansion instance for a specific point in time (defaults
|
||||
* to startDate).
|
||||
*
|
||||
* @param {Time=} startTime Starting point for expansion
|
||||
* @return {RecurExpansion} Expansion object
|
||||
*/
|
||||
iterator(startTime) {
|
||||
return new RecurExpansion({
|
||||
component: this.component,
|
||||
dtstart: startTime || this.startDate
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if the event is recurring
|
||||
*
|
||||
* @return {Boolean} True, if event is recurring
|
||||
*/
|
||||
isRecurring() {
|
||||
let comp = this.component;
|
||||
return comp.hasProperty('rrule') || comp.hasProperty('rdate');
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if the event describes a recurrence exception. See
|
||||
* {@tutorial terminology} for details.
|
||||
*
|
||||
* @return {Boolean} True, if the event describes a recurrence exception
|
||||
*/
|
||||
isRecurrenceException() {
|
||||
return this.component.hasProperty('recurrence-id');
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the types of recurrences this event may have.
|
||||
*
|
||||
* Returned as an object with the following possible keys:
|
||||
*
|
||||
* - YEARLY
|
||||
* - MONTHLY
|
||||
* - WEEKLY
|
||||
* - DAILY
|
||||
* - MINUTELY
|
||||
* - SECONDLY
|
||||
*
|
||||
* @return {Object.<frequencyValues, Boolean>}
|
||||
* Object of recurrence flags
|
||||
*/
|
||||
getRecurrenceTypes() {
|
||||
let rules = this.component.getAllProperties('rrule');
|
||||
let i = 0;
|
||||
let len = rules.length;
|
||||
let result = Object.create(null);
|
||||
|
||||
for (; i < len; i++) {
|
||||
let value = rules[i].getFirstValue();
|
||||
result[value.freq] = true;
|
||||
}
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
/**
|
||||
* The uid of this event
|
||||
* @type {String}
|
||||
*/
|
||||
get uid() {
|
||||
return this._firstProp('uid');
|
||||
}
|
||||
|
||||
set uid(value) {
|
||||
this._setProp('uid', value);
|
||||
}
|
||||
|
||||
/**
|
||||
* The start date
|
||||
* @type {Time}
|
||||
*/
|
||||
get startDate() {
|
||||
return this._firstProp('dtstart');
|
||||
}
|
||||
|
||||
set startDate(value) {
|
||||
this._setTime('dtstart', value);
|
||||
}
|
||||
|
||||
/**
|
||||
* The end date. This can be the result directly from the property, or the
|
||||
* end date calculated from start date and duration. Setting the property
|
||||
* will remove any duration properties.
|
||||
* @type {Time}
|
||||
*/
|
||||
get endDate() {
|
||||
let endDate = this._firstProp('dtend');
|
||||
if (!endDate) {
|
||||
let duration = this._firstProp('duration');
|
||||
endDate = this.startDate.clone();
|
||||
if (duration) {
|
||||
endDate.addDuration(duration);
|
||||
} else if (endDate.isDate) {
|
||||
endDate.day += 1;
|
||||
}
|
||||
}
|
||||
return endDate;
|
||||
}
|
||||
|
||||
set endDate(value) {
|
||||
if (this.component.hasProperty('duration')) {
|
||||
this.component.removeProperty('duration');
|
||||
}
|
||||
this._setTime('dtend', value);
|
||||
}
|
||||
|
||||
/**
|
||||
* The duration. This can be the result directly from the property, or the
|
||||
* duration calculated from start date and end date. Setting the property
|
||||
* will remove any `dtend` properties.
|
||||
* @type {Duration}
|
||||
*/
|
||||
get duration() {
|
||||
let duration = this._firstProp('duration');
|
||||
if (!duration) {
|
||||
return this.endDate.subtractDateTz(this.startDate);
|
||||
}
|
||||
return duration;
|
||||
}
|
||||
|
||||
set duration(value) {
|
||||
if (this.component.hasProperty('dtend')) {
|
||||
this.component.removeProperty('dtend');
|
||||
}
|
||||
|
||||
this._setProp('duration', value);
|
||||
}
|
||||
|
||||
/**
|
||||
* The location of the event.
|
||||
* @type {String}
|
||||
*/
|
||||
get location() {
|
||||
return this._firstProp('location');
|
||||
}
|
||||
|
||||
set location(value) {
|
||||
this._setProp('location', value);
|
||||
}
|
||||
|
||||
/**
|
||||
* The attendees in the event
|
||||
* @type {Property[]}
|
||||
*/
|
||||
get attendees() {
|
||||
//XXX: This is way lame we should have a better
|
||||
// data structure for this later.
|
||||
return this.component.getAllProperties('attendee');
|
||||
}
|
||||
|
||||
/**
|
||||
* The event summary
|
||||
* @type {String}
|
||||
*/
|
||||
get summary() {
|
||||
return this._firstProp('summary');
|
||||
}
|
||||
|
||||
set summary(value) {
|
||||
this._setProp('summary', value);
|
||||
}
|
||||
|
||||
/**
|
||||
* The event description.
|
||||
* @type {String}
|
||||
*/
|
||||
get description() {
|
||||
return this._firstProp('description');
|
||||
}
|
||||
|
||||
set description(value) {
|
||||
this._setProp('description', value);
|
||||
}
|
||||
|
||||
/**
|
||||
* The event color from [rfc7986](https://datatracker.ietf.org/doc/html/rfc7986)
|
||||
* @type {String}
|
||||
*/
|
||||
get color() {
|
||||
return this._firstProp('color');
|
||||
}
|
||||
|
||||
set color(value) {
|
||||
this._setProp('color', value);
|
||||
}
|
||||
|
||||
/**
|
||||
* The organizer value as an uri. In most cases this is a mailto: uri, but
|
||||
* it can also be something else, like urn:uuid:...
|
||||
* @type {String}
|
||||
*/
|
||||
get organizer() {
|
||||
return this._firstProp('organizer');
|
||||
}
|
||||
|
||||
set organizer(value) {
|
||||
this._setProp('organizer', value);
|
||||
}
|
||||
|
||||
/**
|
||||
* The sequence value for this event. Used for scheduling
|
||||
* see {@tutorial terminology}.
|
||||
* @type {Number}
|
||||
*/
|
||||
get sequence() {
|
||||
return this._firstProp('sequence');
|
||||
}
|
||||
|
||||
set sequence(value) {
|
||||
this._setProp('sequence', value);
|
||||
}
|
||||
|
||||
/**
|
||||
* The recurrence id for this event. See {@tutorial terminology} for details.
|
||||
* @type {Time}
|
||||
*/
|
||||
get recurrenceId() {
|
||||
return this._firstProp('recurrence-id');
|
||||
}
|
||||
|
||||
set recurrenceId(value) {
|
||||
this._setTime('recurrence-id', value);
|
||||
}
|
||||
|
||||
/**
|
||||
* Set/update a time property's value.
|
||||
* This will also update the TZID of the property.
|
||||
*
|
||||
* TODO: this method handles the case where we are switching
|
||||
* from a known timezone to an implied timezone (one without TZID).
|
||||
* This does _not_ handle the case of moving between a known
|
||||
* (by TimezoneService) timezone to an unknown timezone...
|
||||
*
|
||||
* We will not add/remove/update the VTIMEZONE subcomponents
|
||||
* leading to invalid ICAL data...
|
||||
* @private
|
||||
* @param {String} propName The property name
|
||||
* @param {Time} time The time to set
|
||||
*/
|
||||
_setTime(propName, time) {
|
||||
let prop = this.component.getFirstProperty(propName);
|
||||
|
||||
if (!prop) {
|
||||
prop = new Property(propName);
|
||||
this.component.addProperty(prop);
|
||||
}
|
||||
|
||||
// utc and local don't get a tzid
|
||||
if (
|
||||
time.zone === Timezone.localTimezone ||
|
||||
time.zone === Timezone.utcTimezone
|
||||
) {
|
||||
// remove the tzid
|
||||
prop.removeParameter('tzid');
|
||||
} else {
|
||||
prop.setParameter('tzid', time.zone.tzid);
|
||||
}
|
||||
|
||||
prop.setValue(time);
|
||||
}
|
||||
|
||||
_setProp(name, value) {
|
||||
this.component.updatePropertyWithValue(name, value);
|
||||
}
|
||||
|
||||
_firstProp(name) {
|
||||
return this.component.getFirstPropertyValue(name);
|
||||
}
|
||||
|
||||
/**
|
||||
* The string representation of this event.
|
||||
* @return {String}
|
||||
*/
|
||||
toString() {
|
||||
return this.component.toString();
|
||||
}
|
||||
}
|
||||
export default Event;
|
||||
|
||||
function compareRangeException(a, b) {
|
||||
if (a[0] > b[0]) return 1;
|
||||
if (b[0] > a[0]) return -1;
|
||||
return 0;
|
||||
}
|
||||
+317
@@ -0,0 +1,317 @@
|
||||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
* Portions Copyright (C) Philipp Kewisch */
|
||||
|
||||
import TimezoneService from "./timezone_service.js";
|
||||
// needed for typescript type resolution
|
||||
// eslint-disable-next-line no-unused-vars
|
||||
import Component from "./component.js";
|
||||
import ICALmodule from "./module.js";
|
||||
|
||||
/**
|
||||
* Helper functions used in various places within ical.js
|
||||
* @module ICAL.helpers
|
||||
*/
|
||||
|
||||
/**
|
||||
* Compiles a list of all referenced TZIDs in all subcomponents and
|
||||
* removes any extra VTIMEZONE subcomponents. In addition, if any TZIDs
|
||||
* are referenced by a component, but a VTIMEZONE does not exist,
|
||||
* an attempt will be made to generate a VTIMEZONE using ICAL.TimezoneService.
|
||||
*
|
||||
* @param {Component} vcal The top-level VCALENDAR component.
|
||||
* @return {Component} The ICAL.Component that was passed in.
|
||||
*/
|
||||
export function updateTimezones(vcal) {
|
||||
let allsubs, properties, vtimezones, reqTzid, i;
|
||||
|
||||
if (!vcal || vcal.name !== "vcalendar") {
|
||||
//not a top-level vcalendar component
|
||||
return vcal;
|
||||
}
|
||||
|
||||
//Store vtimezone subcomponents in an object reference by tzid.
|
||||
//Store properties from everything else in another array
|
||||
allsubs = vcal.getAllSubcomponents();
|
||||
properties = [];
|
||||
vtimezones = {};
|
||||
for (i = 0; i < allsubs.length; i++) {
|
||||
if (allsubs[i].name === "vtimezone") {
|
||||
let tzid = allsubs[i].getFirstProperty("tzid").getFirstValue();
|
||||
vtimezones[tzid] = allsubs[i];
|
||||
} else {
|
||||
properties = properties.concat(allsubs[i].getAllProperties());
|
||||
}
|
||||
}
|
||||
|
||||
//create an object with one entry for each required tz
|
||||
reqTzid = {};
|
||||
for (i = 0; i < properties.length; i++) {
|
||||
let tzid = properties[i].getParameter("tzid");
|
||||
if (tzid) {
|
||||
reqTzid[tzid] = true;
|
||||
}
|
||||
}
|
||||
|
||||
//delete any vtimezones that are not on the reqTzid list.
|
||||
for (let [tzid, comp] of Object.entries(vtimezones)) {
|
||||
if (!reqTzid[tzid]) {
|
||||
vcal.removeSubcomponent(comp);
|
||||
}
|
||||
}
|
||||
|
||||
//create any missing, but registered timezones
|
||||
for (let tzid of Object.keys(reqTzid)) {
|
||||
if (!vtimezones[tzid] && TimezoneService.has(tzid)) {
|
||||
vcal.addSubcomponent(TimezoneService.get(tzid).component);
|
||||
}
|
||||
}
|
||||
|
||||
return vcal;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if the given type is of the number type and also NaN.
|
||||
*
|
||||
* @param {Number} number The number to check
|
||||
* @return {Boolean} True, if the number is strictly NaN
|
||||
*/
|
||||
export function isStrictlyNaN(number) {
|
||||
return typeof(number) === 'number' && isNaN(number);
|
||||
}
|
||||
|
||||
/**
|
||||
* Parses a string value that is expected to be an integer, when the valid is
|
||||
* not an integer throws a decoration error.
|
||||
*
|
||||
* @param {String} string Raw string input
|
||||
* @return {Number} Parsed integer
|
||||
*/
|
||||
export function strictParseInt(string) {
|
||||
let result = parseInt(string, 10);
|
||||
|
||||
if (isStrictlyNaN(result)) {
|
||||
throw new Error(
|
||||
'Could not extract integer from "' + string + '"'
|
||||
);
|
||||
}
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates or returns a class instance of a given type with the initialization
|
||||
* data if the data is not already an instance of the given type.
|
||||
*
|
||||
* @example
|
||||
* var time = new ICAL.Time(...);
|
||||
* var result = ICAL.helpers.formatClassType(time, ICAL.Time);
|
||||
*
|
||||
* (result instanceof ICAL.Time)
|
||||
* // => true
|
||||
*
|
||||
* result = ICAL.helpers.formatClassType({}, ICAL.Time);
|
||||
* (result isntanceof ICAL.Time)
|
||||
* // => true
|
||||
*
|
||||
*
|
||||
* @param {Object} data object initialization data
|
||||
* @param {Object} type object type (like ICAL.Time)
|
||||
* @return {?} An instance of the found type.
|
||||
*/
|
||||
export function formatClassType(data, type) {
|
||||
if (typeof(data) === 'undefined') {
|
||||
return undefined;
|
||||
}
|
||||
|
||||
if (data instanceof type) {
|
||||
return data;
|
||||
}
|
||||
return new type(data);
|
||||
}
|
||||
|
||||
/**
|
||||
* Identical to indexOf but will only match values when they are not preceded
|
||||
* by a backslash character.
|
||||
*
|
||||
* @param {String} buffer String to search
|
||||
* @param {String} search Value to look for
|
||||
* @param {Number} pos Start position
|
||||
* @return {Number} The position, or -1 if not found
|
||||
*/
|
||||
export function unescapedIndexOf(buffer, search, pos) {
|
||||
while ((pos = buffer.indexOf(search, pos)) !== -1) {
|
||||
if (pos > 0 && buffer[pos - 1] === '\\') {
|
||||
pos += 1;
|
||||
} else {
|
||||
return pos;
|
||||
}
|
||||
}
|
||||
return -1;
|
||||
}
|
||||
|
||||
/**
|
||||
* Find the index for insertion using binary search.
|
||||
*
|
||||
* @param {Array} list The list to search
|
||||
* @param {?} seekVal The value to insert
|
||||
* @param {function(?,?)} cmpfunc The comparison func, that can
|
||||
* compare two seekVals
|
||||
* @return {Number} The insert position
|
||||
*/
|
||||
export function binsearchInsert(list, seekVal, cmpfunc) {
|
||||
if (!list.length)
|
||||
return 0;
|
||||
|
||||
let low = 0, high = list.length - 1,
|
||||
mid, cmpval;
|
||||
|
||||
while (low <= high) {
|
||||
mid = low + Math.floor((high - low) / 2);
|
||||
cmpval = cmpfunc(seekVal, list[mid]);
|
||||
|
||||
if (cmpval < 0)
|
||||
high = mid - 1;
|
||||
else if (cmpval > 0)
|
||||
low = mid + 1;
|
||||
else
|
||||
break;
|
||||
}
|
||||
|
||||
if (cmpval < 0)
|
||||
return mid; // insertion is displacing, so use mid outright.
|
||||
else if (cmpval > 0)
|
||||
return mid + 1;
|
||||
else
|
||||
return mid;
|
||||
}
|
||||
|
||||
/**
|
||||
* Clone the passed object or primitive. By default a shallow clone will be
|
||||
* executed.
|
||||
*
|
||||
* @param {*} aSrc The thing to clone
|
||||
* @param {Boolean=} aDeep If true, a deep clone will be performed
|
||||
* @return {*} The copy of the thing
|
||||
*/
|
||||
export function clone(aSrc, aDeep) {
|
||||
if (!aSrc || typeof aSrc != "object") {
|
||||
return aSrc;
|
||||
} else if (aSrc instanceof Date) {
|
||||
return new Date(aSrc.getTime());
|
||||
} else if ("clone" in aSrc) {
|
||||
return aSrc.clone();
|
||||
} else if (Array.isArray(aSrc)) {
|
||||
let arr = [];
|
||||
for (let i = 0; i < aSrc.length; i++) {
|
||||
arr.push(aDeep ? clone(aSrc[i], true) : aSrc[i]);
|
||||
}
|
||||
return arr;
|
||||
} else {
|
||||
let obj = {};
|
||||
for (let [name, value] of Object.entries(aSrc)) {
|
||||
if (aDeep) {
|
||||
obj[name] = clone(value, true);
|
||||
} else {
|
||||
obj[name] = value;
|
||||
}
|
||||
}
|
||||
return obj;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Performs iCalendar line folding. A line ending character is inserted and
|
||||
* the next line begins with a whitespace.
|
||||
*
|
||||
* @example
|
||||
* SUMMARY:This line will be fold
|
||||
* ed right in the middle of a word.
|
||||
*
|
||||
* @param {String} aLine The line to fold
|
||||
* @return {String} The folded line
|
||||
*/
|
||||
export function foldline(aLine) {
|
||||
let result = "";
|
||||
let line = aLine || "", pos = 0, line_length = 0;
|
||||
//pos counts position in line for the UTF-16 presentation
|
||||
//line_length counts the bytes for the UTF-8 presentation
|
||||
while (line.length) {
|
||||
let cp = line.codePointAt(pos);
|
||||
if (cp < 128) ++line_length;
|
||||
else if (cp < 2048) line_length += 2;//needs 2 UTF-8 bytes
|
||||
else if (cp < 65536) line_length += 3;
|
||||
else line_length += 4; //cp is less than 1114112
|
||||
if (line_length < ICALmodule.foldLength + 1)
|
||||
pos += cp > 65535 ? 2 : 1;
|
||||
else {
|
||||
result += ICALmodule.newLineChar + " " + line.slice(0, Math.max(0, pos));
|
||||
line = line.slice(Math.max(0, pos));
|
||||
pos = line_length = 0;
|
||||
}
|
||||
}
|
||||
return result.slice(ICALmodule.newLineChar.length + 1);
|
||||
}
|
||||
|
||||
/**
|
||||
* Pads the given string or number with zeros so it will have at least two
|
||||
* characters.
|
||||
*
|
||||
* @param {String|Number} data The string or number to pad
|
||||
* @return {String} The number padded as a string
|
||||
*/
|
||||
export function pad2(data) {
|
||||
if (typeof(data) !== 'string') {
|
||||
// handle fractions.
|
||||
if (typeof(data) === 'number') {
|
||||
data = parseInt(data);
|
||||
}
|
||||
data = String(data);
|
||||
}
|
||||
|
||||
let len = data.length;
|
||||
|
||||
switch (len) {
|
||||
case 0:
|
||||
return '00';
|
||||
case 1:
|
||||
return '0' + data;
|
||||
default:
|
||||
return data;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Truncates the given number, correctly handling negative numbers.
|
||||
*
|
||||
* @param {Number} number The number to truncate
|
||||
* @return {Number} The truncated number
|
||||
*/
|
||||
export function trunc(number) {
|
||||
return (number < 0 ? Math.ceil(number) : Math.floor(number));
|
||||
}
|
||||
|
||||
/**
|
||||
* Poor-man's cross-browser object extension. Doesn't support all the
|
||||
* features, but enough for our usage. Note that the target's properties are
|
||||
* not overwritten with the source properties.
|
||||
*
|
||||
* @example
|
||||
* var child = ICAL.helpers.extend(parent, {
|
||||
* "bar": 123
|
||||
* });
|
||||
*
|
||||
* @param {Object} source The object to extend
|
||||
* @param {Object} target The object to extend with
|
||||
* @return {Object} Returns the target.
|
||||
*/
|
||||
export function extend(source, target) {
|
||||
for (let key in source) {
|
||||
let descr = Object.getOwnPropertyDescriptor(source, key);
|
||||
if (descr && !Object.getOwnPropertyDescriptor(target, key)) {
|
||||
Object.defineProperty(target, key, descr);
|
||||
}
|
||||
}
|
||||
return target;
|
||||
}
|
||||
+73
@@ -0,0 +1,73 @@
|
||||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
* Portions Copyright (C) Philipp Kewisch */
|
||||
|
||||
import Binary from "./binary.js";
|
||||
import Component from "./component.js";
|
||||
import ComponentParser from "./component_parser.js";
|
||||
import design from "./design.js";
|
||||
import Duration from "./duration.js";
|
||||
import Event from "./event.js";
|
||||
import * as helpers from "./helpers.js";
|
||||
import parse from "./parse.js";
|
||||
import Period from "./period.js";
|
||||
import Property from "./property.js";
|
||||
import Recur from "./recur.js";
|
||||
import RecurExpansion from "./recur_expansion.js";
|
||||
import RecurIterator from "./recur_iterator.js";
|
||||
import stringify from "./stringify.js";
|
||||
import Time from "./time.js";
|
||||
import Timezone from "./timezone.js";
|
||||
import TimezoneService from "./timezone_service.js";
|
||||
import UtcOffset from "./utc_offset.js";
|
||||
import VCardTime from "./vcard_time.js";
|
||||
|
||||
/**
|
||||
* The main ICAL module. Provides access to everything else.
|
||||
*
|
||||
* @alias ICAL
|
||||
* @namespace ICAL
|
||||
* @property {ICAL.design} design
|
||||
* @property {ICAL.helpers} helpers
|
||||
*/
|
||||
export default {
|
||||
/**
|
||||
* The number of characters before iCalendar line folding should occur
|
||||
* @type {Number}
|
||||
* @default 75
|
||||
*/
|
||||
foldLength: 75,
|
||||
|
||||
debug: false,
|
||||
|
||||
/**
|
||||
* The character(s) to be used for a newline. The default value is provided by
|
||||
* rfc5545.
|
||||
* @type {String}
|
||||
* @default "\r\n"
|
||||
*/
|
||||
newLineChar: '\r\n',
|
||||
|
||||
Binary,
|
||||
Component,
|
||||
ComponentParser,
|
||||
Duration,
|
||||
Event,
|
||||
Period,
|
||||
Property,
|
||||
Recur,
|
||||
RecurExpansion,
|
||||
RecurIterator,
|
||||
Time,
|
||||
Timezone,
|
||||
TimezoneService,
|
||||
UtcOffset,
|
||||
VCardTime,
|
||||
|
||||
parse,
|
||||
stringify,
|
||||
|
||||
design,
|
||||
helpers
|
||||
};
|
||||
+557
@@ -0,0 +1,557 @@
|
||||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
* Portions Copyright (C) Philipp Kewisch */
|
||||
|
||||
import design from "./design.js";
|
||||
import { unescapedIndexOf } from "./helpers.js";
|
||||
|
||||
/**
|
||||
* This lets typescript resolve our custom types in the
|
||||
* generated d.ts files (jsdoc typedefs are converted to typescript types).
|
||||
* Ignore prevents the typedefs from being documented more than once.
|
||||
*
|
||||
* @ignore
|
||||
* @typedef {import("./types.js").parserState} parserState
|
||||
* Imports the 'parserState' type from the "types.js" module
|
||||
* @typedef {import("./types.js").designSet} designSet
|
||||
* Imports the 'designSet' type from the "types.js" module
|
||||
*/
|
||||
|
||||
const CHAR = /[^ \t]/;
|
||||
const VALUE_DELIMITER = ':';
|
||||
const PARAM_DELIMITER = ';';
|
||||
const PARAM_NAME_DELIMITER = '=';
|
||||
const DEFAULT_VALUE_TYPE = 'unknown';
|
||||
const DEFAULT_PARAM_TYPE = 'text';
|
||||
const RFC6868_REPLACE_MAP = { "^'": '"', "^n": "\n", "^^": "^" };
|
||||
|
||||
/**
|
||||
* Parses iCalendar or vCard data into a raw jCal object. Consult
|
||||
* documentation on the {@tutorial layers|layers of parsing} for more
|
||||
* details.
|
||||
*
|
||||
* @function ICAL.parse
|
||||
* @memberof ICAL
|
||||
* @variation function
|
||||
* @todo Fix the API to be more clear on the return type
|
||||
* @param {String} input The string data to parse
|
||||
* @return {Object|Object[]} A single jCal object, or an array thereof
|
||||
*/
|
||||
export default function parse(input) {
|
||||
let state = {};
|
||||
let root = state.component = [];
|
||||
|
||||
state.stack = [root];
|
||||
|
||||
parse._eachLine(input, function(err, line) {
|
||||
parse._handleContentLine(line, state);
|
||||
});
|
||||
|
||||
|
||||
// when there are still items on the stack
|
||||
// throw a fatal error, a component was not closed
|
||||
// correctly in that case.
|
||||
if (state.stack.length > 1) {
|
||||
throw new ParserError(
|
||||
'invalid ical body. component began but did not end'
|
||||
);
|
||||
}
|
||||
|
||||
state = null;
|
||||
|
||||
return (root.length == 1 ? root[0] : root);
|
||||
}
|
||||
|
||||
/**
|
||||
* Parse an iCalendar property value into the jCal for a single property
|
||||
*
|
||||
* @function ICAL.parse.property
|
||||
* @param {String} str
|
||||
* The iCalendar property string to parse
|
||||
* @param {designSet=} designSet
|
||||
* The design data to use for this property
|
||||
* @return {Object}
|
||||
* The jCal Object containing the property
|
||||
*/
|
||||
parse.property = function(str, designSet) {
|
||||
let state = {
|
||||
component: [[], []],
|
||||
designSet: designSet || design.defaultSet
|
||||
};
|
||||
parse._handleContentLine(str, state);
|
||||
return state.component[1][0];
|
||||
};
|
||||
|
||||
/**
|
||||
* Convenience method to parse a component. You can use ICAL.parse() directly
|
||||
* instead.
|
||||
*
|
||||
* @function ICAL.parse.component
|
||||
* @see ICAL.parse(function)
|
||||
* @param {String} str The iCalendar component string to parse
|
||||
* @return {Object} The jCal Object containing the component
|
||||
*/
|
||||
parse.component = function(str) {
|
||||
return parse(str);
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* An error that occurred during parsing.
|
||||
*
|
||||
* @param {String} message The error message
|
||||
* @memberof ICAL.parse
|
||||
* @extends {Error}
|
||||
*/
|
||||
class ParserError extends Error {
|
||||
name = this.constructor.name;
|
||||
}
|
||||
|
||||
// classes & constants
|
||||
parse.ParserError = ParserError;
|
||||
|
||||
|
||||
/**
|
||||
* Handles a single line of iCalendar/vCard, updating the state.
|
||||
*
|
||||
* @private
|
||||
* @function ICAL.parse._handleContentLine
|
||||
* @param {String} line The content line to process
|
||||
* @param {parserState} state The current state of the line parsing
|
||||
*/
|
||||
parse._handleContentLine = function(line, state) {
|
||||
// break up the parts of the line
|
||||
let valuePos = line.indexOf(VALUE_DELIMITER);
|
||||
let paramPos = line.indexOf(PARAM_DELIMITER);
|
||||
|
||||
let lastParamIndex;
|
||||
let lastValuePos;
|
||||
|
||||
// name of property or begin/end
|
||||
let name;
|
||||
let value;
|
||||
// params is only overridden if paramPos !== -1.
|
||||
// we can't do params = params || {} later on
|
||||
// because it sacrifices ops.
|
||||
let params = {};
|
||||
|
||||
/**
|
||||
* Different property cases
|
||||
*
|
||||
*
|
||||
* 1. RRULE:FREQ=foo
|
||||
* // FREQ= is not a param but the value
|
||||
*
|
||||
* 2. ATTENDEE;ROLE=REQ-PARTICIPANT;
|
||||
* // ROLE= is a param because : has not happened yet
|
||||
*/
|
||||
// when the parameter delimiter is after the
|
||||
// value delimiter then it is not a parameter.
|
||||
|
||||
if ((paramPos !== -1 && valuePos !== -1)) {
|
||||
// when the parameter delimiter is after the
|
||||
// value delimiter then it is not a parameter.
|
||||
if (paramPos > valuePos) {
|
||||
paramPos = -1;
|
||||
}
|
||||
}
|
||||
|
||||
let parsedParams;
|
||||
if (paramPos !== -1) {
|
||||
name = line.slice(0, Math.max(0, paramPos)).toLowerCase();
|
||||
parsedParams = parse._parseParameters(line.slice(Math.max(0, paramPos)), 0, state.designSet);
|
||||
if (parsedParams[2] == -1) {
|
||||
throw new ParserError("Invalid parameters in '" + line + "'");
|
||||
}
|
||||
params = parsedParams[0];
|
||||
// Handle parameter values with multiple entries
|
||||
let parsedParamLength;
|
||||
if (typeof parsedParams[1] === 'string') {
|
||||
parsedParamLength = parsedParams[1].length;
|
||||
} else {
|
||||
parsedParamLength = parsedParams[1].reduce((accumulator, currentValue) => {
|
||||
return accumulator + currentValue.length;
|
||||
}, 0);
|
||||
}
|
||||
lastParamIndex = parsedParamLength + parsedParams[2] + paramPos;
|
||||
if ((lastValuePos =
|
||||
line.slice(Math.max(0, lastParamIndex)).indexOf(VALUE_DELIMITER)) !== -1) {
|
||||
value = line.slice(Math.max(0, lastParamIndex + lastValuePos + 1));
|
||||
} else {
|
||||
throw new ParserError("Missing parameter value in '" + line + "'");
|
||||
}
|
||||
} else if (valuePos !== -1) {
|
||||
// without parmeters (BEGIN:VCAENDAR, CLASS:PUBLIC)
|
||||
name = line.slice(0, Math.max(0, valuePos)).toLowerCase();
|
||||
value = line.slice(Math.max(0, valuePos + 1));
|
||||
|
||||
if (name === 'begin') {
|
||||
let newComponent = [value.toLowerCase(), [], []];
|
||||
if (state.stack.length === 1) {
|
||||
state.component.push(newComponent);
|
||||
} else {
|
||||
state.component[2].push(newComponent);
|
||||
}
|
||||
state.stack.push(state.component);
|
||||
state.component = newComponent;
|
||||
if (!state.designSet) {
|
||||
state.designSet = design.getDesignSet(state.component[0]);
|
||||
}
|
||||
return;
|
||||
} else if (name === 'end') {
|
||||
state.component = state.stack.pop();
|
||||
return;
|
||||
}
|
||||
// If it is not begin/end, then this is a property with an empty value,
|
||||
// which should be considered valid.
|
||||
} else {
|
||||
/**
|
||||
* Invalid line.
|
||||
* The rational to throw an error is we will
|
||||
* never be certain that the rest of the file
|
||||
* is sane and it is unlikely that we can serialize
|
||||
* the result correctly either.
|
||||
*/
|
||||
throw new ParserError(
|
||||
'invalid line (no token ";" or ":") "' + line + '"'
|
||||
);
|
||||
}
|
||||
|
||||
let valueType;
|
||||
let multiValue = false;
|
||||
let structuredValue = false;
|
||||
let propertyDetails;
|
||||
let splitName;
|
||||
let ungroupedName;
|
||||
|
||||
// fetch the ungrouped part of the name
|
||||
if (state.designSet.propertyGroups && name.indexOf('.') !== -1) {
|
||||
splitName = name.split('.');
|
||||
params.group = splitName[0];
|
||||
ungroupedName = splitName[1];
|
||||
} else {
|
||||
ungroupedName = name;
|
||||
}
|
||||
|
||||
if (ungroupedName in state.designSet.property) {
|
||||
propertyDetails = state.designSet.property[ungroupedName];
|
||||
|
||||
if ('multiValue' in propertyDetails) {
|
||||
multiValue = propertyDetails.multiValue;
|
||||
}
|
||||
|
||||
if ('structuredValue' in propertyDetails) {
|
||||
structuredValue = propertyDetails.structuredValue;
|
||||
}
|
||||
|
||||
if (value && 'detectType' in propertyDetails) {
|
||||
valueType = propertyDetails.detectType(value);
|
||||
}
|
||||
}
|
||||
|
||||
// attempt to determine value
|
||||
if (!valueType) {
|
||||
if (!('value' in params)) {
|
||||
if (propertyDetails) {
|
||||
valueType = propertyDetails.defaultType;
|
||||
} else {
|
||||
valueType = DEFAULT_VALUE_TYPE;
|
||||
}
|
||||
} else {
|
||||
// possible to avoid this?
|
||||
valueType = params.value.toLowerCase();
|
||||
}
|
||||
}
|
||||
|
||||
delete params.value;
|
||||
|
||||
/**
|
||||
* Note on `var result` juggling:
|
||||
*
|
||||
* I observed that building the array in pieces has adverse
|
||||
* effects on performance, so where possible we inline the creation.
|
||||
* It is a little ugly but resulted in ~2000 additional ops/sec.
|
||||
*/
|
||||
|
||||
let result;
|
||||
if (multiValue && structuredValue) {
|
||||
value = parse._parseMultiValue(value, structuredValue, valueType, [], multiValue, state.designSet, structuredValue);
|
||||
result = [ungroupedName, params, valueType, value];
|
||||
} else if (multiValue) {
|
||||
result = [ungroupedName, params, valueType];
|
||||
parse._parseMultiValue(value, multiValue, valueType, result, null, state.designSet, false);
|
||||
} else if (structuredValue) {
|
||||
value = parse._parseMultiValue(value, structuredValue, valueType, [], null, state.designSet, structuredValue);
|
||||
result = [ungroupedName, params, valueType, value];
|
||||
} else {
|
||||
value = parse._parseValue(value, valueType, state.designSet, false);
|
||||
result = [ungroupedName, params, valueType, value];
|
||||
}
|
||||
// rfc6350 requires that in vCard 4.0 the first component is the VERSION
|
||||
// component with as value 4.0, note that 3.0 does not have this requirement.
|
||||
if (state.component[0] === 'vcard' && state.component[1].length === 0 &&
|
||||
!(name === 'version' && value === '4.0')) {
|
||||
state.designSet = design.getDesignSet("vcard3");
|
||||
}
|
||||
state.component[1].push(result);
|
||||
};
|
||||
|
||||
/**
|
||||
* Parse a value from the raw value into the jCard/jCal value.
|
||||
*
|
||||
* @private
|
||||
* @function ICAL.parse._parseValue
|
||||
* @param {String} value Original value
|
||||
* @param {String} type Type of value
|
||||
* @param {Object} designSet The design data to use for this value
|
||||
* @return {Object} varies on type
|
||||
*/
|
||||
parse._parseValue = function(value, type, designSet, structuredValue) {
|
||||
if (type in designSet.value && 'fromICAL' in designSet.value[type]) {
|
||||
return designSet.value[type].fromICAL(value, structuredValue);
|
||||
}
|
||||
return value;
|
||||
};
|
||||
|
||||
/**
|
||||
* Parse parameters from a string to object.
|
||||
*
|
||||
* @function ICAL.parse._parseParameters
|
||||
* @private
|
||||
* @param {String} line A single unfolded line
|
||||
* @param {Number} start Position to start looking for properties
|
||||
* @param {Object} designSet The design data to use for this property
|
||||
* @return {Array} Array containing key/valye pairs of parsed parameters, the
|
||||
* parsed value, and the position of the last parameter found
|
||||
*/
|
||||
parse._parseParameters = function(line, start, designSet) {
|
||||
let lastParam = start;
|
||||
let pos = 0;
|
||||
let delim = PARAM_NAME_DELIMITER;
|
||||
let result = {};
|
||||
let name, lcname;
|
||||
let value, valuePos = -1;
|
||||
let type, multiValue, mvdelim;
|
||||
|
||||
// find the next '=' sign
|
||||
// use lastParam and pos to find name
|
||||
// check if " is used if so get value from "->"
|
||||
// then increment pos to find next ;
|
||||
|
||||
while ((pos !== false) &&
|
||||
(pos = line.indexOf(delim, pos + 1)) !== -1) {
|
||||
|
||||
name = line.slice(lastParam + 1, pos);
|
||||
if (name.length == 0) {
|
||||
throw new ParserError("Empty parameter name in '" + line + "'");
|
||||
}
|
||||
lcname = name.toLowerCase();
|
||||
mvdelim = false;
|
||||
multiValue = false;
|
||||
|
||||
if (lcname in designSet.param && designSet.param[lcname].valueType) {
|
||||
type = designSet.param[lcname].valueType;
|
||||
} else {
|
||||
type = DEFAULT_PARAM_TYPE;
|
||||
}
|
||||
|
||||
if (lcname in designSet.param) {
|
||||
multiValue = designSet.param[lcname].multiValue;
|
||||
if (designSet.param[lcname].multiValueSeparateDQuote) {
|
||||
mvdelim = parse._rfc6868Escape('"' + multiValue + '"');
|
||||
}
|
||||
}
|
||||
|
||||
let nextChar = line[pos + 1];
|
||||
if (nextChar === '"') {
|
||||
valuePos = pos + 2;
|
||||
pos = line.indexOf('"', valuePos);
|
||||
if (multiValue && pos != -1) {
|
||||
let extendedValue = true;
|
||||
while (extendedValue) {
|
||||
if (line[pos + 1] == multiValue && line[pos + 2] == '"') {
|
||||
pos = line.indexOf('"', pos + 3);
|
||||
} else {
|
||||
extendedValue = false;
|
||||
}
|
||||
}
|
||||
}
|
||||
if (pos === -1) {
|
||||
throw new ParserError(
|
||||
'invalid line (no matching double quote) "' + line + '"'
|
||||
);
|
||||
}
|
||||
value = line.slice(valuePos, pos);
|
||||
lastParam = line.indexOf(PARAM_DELIMITER, pos);
|
||||
let propValuePos = line.indexOf(VALUE_DELIMITER, pos);
|
||||
// if either no next parameter or delimeter in property value, let's stop here
|
||||
if (lastParam === -1 || (propValuePos !== -1 && lastParam > propValuePos)) {
|
||||
pos = false;
|
||||
}
|
||||
} else {
|
||||
valuePos = pos + 1;
|
||||
|
||||
// move to next ";"
|
||||
let nextPos = line.indexOf(PARAM_DELIMITER, valuePos);
|
||||
let propValuePos = line.indexOf(VALUE_DELIMITER, valuePos);
|
||||
if (propValuePos !== -1 && nextPos > propValuePos) {
|
||||
// this is a delimiter in the property value, let's stop here
|
||||
nextPos = propValuePos;
|
||||
pos = false;
|
||||
} else if (nextPos === -1) {
|
||||
// no ";"
|
||||
if (propValuePos === -1) {
|
||||
nextPos = line.length;
|
||||
} else {
|
||||
nextPos = propValuePos;
|
||||
}
|
||||
pos = false;
|
||||
} else {
|
||||
lastParam = nextPos;
|
||||
pos = nextPos;
|
||||
}
|
||||
|
||||
value = line.slice(valuePos, nextPos);
|
||||
}
|
||||
|
||||
const length_before = value.length;
|
||||
value = parse._rfc6868Escape(value);
|
||||
valuePos += length_before - value.length;
|
||||
if (multiValue) {
|
||||
let delimiter = mvdelim || multiValue;
|
||||
value = parse._parseMultiValue(value, delimiter, type, [], null, designSet);
|
||||
} else {
|
||||
value = parse._parseValue(value, type, designSet);
|
||||
}
|
||||
|
||||
if (multiValue && (lcname in result)) {
|
||||
if (Array.isArray(result[lcname])) {
|
||||
result[lcname].push(value);
|
||||
} else {
|
||||
result[lcname] = [
|
||||
result[lcname],
|
||||
value
|
||||
];
|
||||
}
|
||||
} else {
|
||||
result[lcname] = value;
|
||||
}
|
||||
}
|
||||
return [result, value, valuePos];
|
||||
};
|
||||
|
||||
/**
|
||||
* Internal helper for rfc6868. Exposing this on ICAL.parse so that
|
||||
* hackers can disable the rfc6868 parsing if the really need to.
|
||||
*
|
||||
* @function ICAL.parse._rfc6868Escape
|
||||
* @param {String} val The value to escape
|
||||
* @return {String} The escaped value
|
||||
*/
|
||||
parse._rfc6868Escape = function(val) {
|
||||
return val.replace(/\^['n^]/g, function(x) {
|
||||
return RFC6868_REPLACE_MAP[x];
|
||||
});
|
||||
};
|
||||
|
||||
/**
|
||||
* Parse a multi value string. This function is used either for parsing
|
||||
* actual multi-value property's values, or for handling parameter values. It
|
||||
* can be used for both multi-value properties and structured value properties.
|
||||
*
|
||||
* @private
|
||||
* @function ICAL.parse._parseMultiValue
|
||||
* @param {String} buffer The buffer containing the full value
|
||||
* @param {String} delim The multi-value delimiter
|
||||
* @param {String} type The value type to be parsed
|
||||
* @param {Array.<?>} result The array to append results to, varies on value type
|
||||
* @param {String} innerMulti The inner delimiter to split each value with
|
||||
* @param {designSet} designSet The design data for this value
|
||||
* @return {?|Array.<?>} Either an array of results, or the first result
|
||||
*/
|
||||
parse._parseMultiValue = function(buffer, delim, type, result, innerMulti, designSet, structuredValue) {
|
||||
let pos = 0;
|
||||
let lastPos = 0;
|
||||
let value;
|
||||
if (delim.length === 0) {
|
||||
return buffer;
|
||||
}
|
||||
|
||||
// split each piece
|
||||
while ((pos = unescapedIndexOf(buffer, delim, lastPos)) !== -1) {
|
||||
value = buffer.slice(lastPos, pos);
|
||||
if (innerMulti) {
|
||||
value = parse._parseMultiValue(value, innerMulti, type, [], null, designSet, structuredValue);
|
||||
} else {
|
||||
value = parse._parseValue(value, type, designSet, structuredValue);
|
||||
}
|
||||
result.push(value);
|
||||
lastPos = pos + delim.length;
|
||||
}
|
||||
|
||||
// on the last piece take the rest of string
|
||||
value = buffer.slice(lastPos);
|
||||
if (innerMulti) {
|
||||
value = parse._parseMultiValue(value, innerMulti, type, [], null, designSet, structuredValue);
|
||||
} else {
|
||||
value = parse._parseValue(value, type, designSet, structuredValue);
|
||||
}
|
||||
result.push(value);
|
||||
|
||||
return result.length == 1 ? result[0] : result;
|
||||
};
|
||||
|
||||
/**
|
||||
* Process a complete buffer of iCalendar/vCard data line by line, correctly
|
||||
* unfolding content. Each line will be processed with the given callback
|
||||
*
|
||||
* @private
|
||||
* @function ICAL.parse._eachLine
|
||||
* @param {String} buffer The buffer to process
|
||||
* @param {function(?String, String)} callback The callback for each line
|
||||
*/
|
||||
parse._eachLine = function(buffer, callback) {
|
||||
let len = buffer.length;
|
||||
let lastPos = buffer.search(CHAR);
|
||||
let pos = lastPos;
|
||||
let line;
|
||||
let firstChar;
|
||||
|
||||
let newlineOffset;
|
||||
|
||||
do {
|
||||
pos = buffer.indexOf('\n', lastPos) + 1;
|
||||
|
||||
if (pos > 1 && buffer[pos - 2] === '\r') {
|
||||
newlineOffset = 2;
|
||||
} else {
|
||||
newlineOffset = 1;
|
||||
}
|
||||
|
||||
if (pos === 0) {
|
||||
pos = len;
|
||||
newlineOffset = 0;
|
||||
}
|
||||
|
||||
firstChar = buffer[lastPos];
|
||||
|
||||
if (firstChar === ' ' || firstChar === '\t') {
|
||||
// add to line
|
||||
line += buffer.slice(lastPos + 1, pos - newlineOffset);
|
||||
} else {
|
||||
if (line)
|
||||
callback(null, line);
|
||||
// push line
|
||||
line = buffer.slice(lastPos, pos - newlineOffset);
|
||||
}
|
||||
|
||||
lastPos = pos;
|
||||
} while (pos !== len);
|
||||
|
||||
// extra ending line
|
||||
line = line.trim();
|
||||
|
||||
if (line.length)
|
||||
callback(null, line);
|
||||
};
|
||||
+263
@@ -0,0 +1,263 @@
|
||||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
* Portions Copyright (C) Philipp Kewisch */
|
||||
|
||||
import Time from "./time.js";
|
||||
import Duration from "./duration.js";
|
||||
// needed for typescript type resolution
|
||||
// eslint-disable-next-line no-unused-vars
|
||||
import Property from "./property.js";
|
||||
|
||||
/**
|
||||
* This lets typescript resolve our custom types in the
|
||||
* generated d.ts files (jsdoc typedefs are converted to typescript types).
|
||||
* Ignore prevents the typedefs from being documented more than once.
|
||||
* @ignore
|
||||
* @typedef {import("./types.js").jCalComponent} jCalComponent
|
||||
* Imports the 'occurrenceDetails' type from the "types.js" module
|
||||
*/
|
||||
|
||||
/**
|
||||
* This class represents the "period" value type, with various calculation and manipulation methods.
|
||||
*
|
||||
* @memberof ICAL
|
||||
*/
|
||||
class Period {
|
||||
/**
|
||||
* Creates a new {@link ICAL.Period} instance from the passed string.
|
||||
*
|
||||
* @param {String} str The string to parse
|
||||
* @param {Property} prop The property this period will be on
|
||||
* @return {Period} The created period instance
|
||||
*/
|
||||
static fromString(str, prop) {
|
||||
let parts = str.split('/');
|
||||
|
||||
if (parts.length !== 2) {
|
||||
throw new Error(
|
||||
'Invalid string value: "' + str + '" must contain a "/" char.'
|
||||
);
|
||||
}
|
||||
|
||||
let options = {
|
||||
start: Time.fromDateTimeString(parts[0], prop)
|
||||
};
|
||||
|
||||
let end = parts[1];
|
||||
|
||||
if (Duration.isValueString(end)) {
|
||||
options.duration = Duration.fromString(end);
|
||||
} else {
|
||||
options.end = Time.fromDateTimeString(end, prop);
|
||||
}
|
||||
|
||||
return new Period(options);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new {@link ICAL.Period} instance from the given data object.
|
||||
* The passed data object cannot contain both and end date and a duration.
|
||||
*
|
||||
* @param {Object} aData An object with members of the period
|
||||
* @param {Time=} aData.start The start of the period
|
||||
* @param {Time=} aData.end The end of the period
|
||||
* @param {Duration=} aData.duration The duration of the period
|
||||
* @return {Period} The period instance
|
||||
*/
|
||||
static fromData(aData) {
|
||||
return new Period(aData);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a new period instance from the given jCal data array. The first
|
||||
* member is always the start date string, the second member is either a
|
||||
* duration or end date string.
|
||||
*
|
||||
* @param {jCalComponent} aData The jCal data array
|
||||
* @param {Property} aProp The property this jCal data is on
|
||||
* @param {Boolean} aLenient If true, data value can be both date and date-time
|
||||
* @return {Period} The period instance
|
||||
*/
|
||||
static fromJSON(aData, aProp, aLenient) {
|
||||
function fromDateOrDateTimeString(aValue, dateProp) {
|
||||
if (aLenient) {
|
||||
return Time.fromString(aValue, dateProp);
|
||||
} else {
|
||||
return Time.fromDateTimeString(aValue, dateProp);
|
||||
}
|
||||
}
|
||||
|
||||
if (Duration.isValueString(aData[1])) {
|
||||
return Period.fromData({
|
||||
start: fromDateOrDateTimeString(aData[0], aProp),
|
||||
duration: Duration.fromString(aData[1])
|
||||
});
|
||||
} else {
|
||||
return Period.fromData({
|
||||
start: fromDateOrDateTimeString(aData[0], aProp),
|
||||
end: fromDateOrDateTimeString(aData[1], aProp)
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new ICAL.Period instance. The passed data object cannot contain both and end date and
|
||||
* a duration.
|
||||
*
|
||||
* @param {Object} aData An object with members of the period
|
||||
* @param {Time=} aData.start The start of the period
|
||||
* @param {Time=} aData.end The end of the period
|
||||
* @param {Duration=} aData.duration The duration of the period
|
||||
*/
|
||||
constructor(aData) {
|
||||
this.wrappedJSObject = this;
|
||||
|
||||
if (aData && 'start' in aData) {
|
||||
if (aData.start && !(aData.start instanceof Time)) {
|
||||
throw new TypeError('.start must be an instance of ICAL.Time');
|
||||
}
|
||||
this.start = aData.start;
|
||||
}
|
||||
|
||||
if (aData && aData.end && aData.duration) {
|
||||
throw new Error('cannot accept both end and duration');
|
||||
}
|
||||
|
||||
if (aData && 'end' in aData) {
|
||||
if (aData.end && !(aData.end instanceof Time)) {
|
||||
throw new TypeError('.end must be an instance of ICAL.Time');
|
||||
}
|
||||
this.end = aData.end;
|
||||
}
|
||||
|
||||
if (aData && 'duration' in aData) {
|
||||
if (aData.duration && !(aData.duration instanceof Duration)) {
|
||||
throw new TypeError('.duration must be an instance of ICAL.Duration');
|
||||
}
|
||||
this.duration = aData.duration;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* The start of the period
|
||||
* @type {Time}
|
||||
*/
|
||||
start = null;
|
||||
|
||||
/**
|
||||
* The end of the period
|
||||
* @type {Time}
|
||||
*/
|
||||
end = null;
|
||||
|
||||
/**
|
||||
* The duration of the period
|
||||
* @type {Duration}
|
||||
*/
|
||||
duration = null;
|
||||
|
||||
/**
|
||||
* The class identifier.
|
||||
* @constant
|
||||
* @type {String}
|
||||
* @default "icalperiod"
|
||||
*/
|
||||
icalclass = "icalperiod";
|
||||
|
||||
/**
|
||||
* The type name, to be used in the jCal object.
|
||||
* @constant
|
||||
* @type {String}
|
||||
* @default "period"
|
||||
*/
|
||||
icaltype = "period";
|
||||
|
||||
/**
|
||||
* Returns a clone of the duration object.
|
||||
*
|
||||
* @return {Period} The cloned object
|
||||
*/
|
||||
clone() {
|
||||
return Period.fromData({
|
||||
start: this.start ? this.start.clone() : null,
|
||||
end: this.end ? this.end.clone() : null,
|
||||
duration: this.duration ? this.duration.clone() : null
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Calculates the duration of the period, either directly or by subtracting
|
||||
* start from end date.
|
||||
*
|
||||
* @return {Duration} The calculated duration
|
||||
*/
|
||||
getDuration() {
|
||||
if (this.duration) {
|
||||
return this.duration;
|
||||
} else {
|
||||
return this.end.subtractDate(this.start);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Calculates the end date of the period, either directly or by adding
|
||||
* duration to start date.
|
||||
*
|
||||
* @return {Time} The calculated end date
|
||||
*/
|
||||
getEnd() {
|
||||
if (this.end) {
|
||||
return this.end;
|
||||
} else {
|
||||
let end = this.start.clone();
|
||||
end.addDuration(this.duration);
|
||||
return end;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Compare this period with a date or other period. To maintain the logic where a.compare(b)
|
||||
* returns 1 when a > b, this function will return 1 when the period is after the date, 0 when the
|
||||
* date is within the period, and -1 when the period is before the date. When comparing two
|
||||
* periods, as soon as they overlap in any way this will return 0.
|
||||
*
|
||||
* @param {Time|Period} dt The date or other period to compare with
|
||||
*/
|
||||
compare(dt) {
|
||||
if (dt.compare(this.start) < 0) {
|
||||
return 1;
|
||||
} else if (dt.compare(this.getEnd()) > 0) {
|
||||
return -1;
|
||||
} else {
|
||||
return 0;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* The string representation of this period.
|
||||
* @return {String}
|
||||
*/
|
||||
toString() {
|
||||
return this.start + "/" + (this.end || this.duration);
|
||||
}
|
||||
|
||||
/**
|
||||
* The jCal representation of this period type.
|
||||
* @return {Object}
|
||||
*/
|
||||
toJSON() {
|
||||
return [this.start.toString(), (this.end || this.duration).toString()];
|
||||
}
|
||||
|
||||
/**
|
||||
* The iCalendar string representation of this period.
|
||||
* @return {String}
|
||||
*/
|
||||
toICALString() {
|
||||
return this.start.toICALString() + "/" +
|
||||
(this.end || this.duration).toICALString();
|
||||
}
|
||||
}
|
||||
export default Period;
|
||||
+439
@@ -0,0 +1,439 @@
|
||||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
* Portions Copyright (C) Philipp Kewisch */
|
||||
|
||||
const NAME_INDEX = 0;
|
||||
const PROP_INDEX = 1;
|
||||
const TYPE_INDEX = 2;
|
||||
const VALUE_INDEX = 3;
|
||||
|
||||
import design from "./design.js";
|
||||
import ICALStringify from "./stringify.js";
|
||||
import ICALParse from "./parse.js";
|
||||
|
||||
// needed for typescript type resolution
|
||||
// eslint-disable-next-line no-unused-vars
|
||||
import Component from "./component.js";
|
||||
// needed for typescript type resolution
|
||||
// eslint-disable-next-line no-unused-vars
|
||||
import Duration from "./duration.js";
|
||||
// needed for typescript type resolution
|
||||
// eslint-disable-next-line no-unused-vars
|
||||
import UtcOffset from "./utc_offset.js";
|
||||
// needed for typescript type resolution
|
||||
// eslint-disable-next-line no-unused-vars
|
||||
import Binary from "./binary.js";
|
||||
// needed for typescript type resolution
|
||||
// eslint-disable-next-line no-unused-vars
|
||||
import Period from "./period.js";
|
||||
// needed for typescript type resolution
|
||||
// eslint-disable-next-line no-unused-vars
|
||||
import Recur from "./recur.js";
|
||||
// needed for typescript type resolution
|
||||
// eslint-disable-next-line no-unused-vars
|
||||
import Time from "./time.js";
|
||||
|
||||
/**
|
||||
* This lets typescript resolve our custom types in the
|
||||
* generated d.ts files (jsdoc typedefs are converted to typescript types).
|
||||
* Ignore prevents the typedefs from being documented more than once.
|
||||
* @ignore
|
||||
* @typedef {import("./types.js").designSet} designSet
|
||||
* Imports the 'designSet' type from the "types.js" module
|
||||
* @typedef {import("./types.js").Geo} Geo
|
||||
* Imports the 'Geo' type from the "types.js" module
|
||||
*/
|
||||
|
||||
/**
|
||||
* Provides a layer on top of the raw jCal object for manipulating a single property, with its
|
||||
* parameters and value.
|
||||
*
|
||||
* @memberof ICAL
|
||||
*/
|
||||
class Property {
|
||||
/**
|
||||
* Create an {@link ICAL.Property} by parsing the passed iCalendar string.
|
||||
*
|
||||
* @param {String} str The iCalendar string to parse
|
||||
* @param {designSet=} designSet The design data to use for this property
|
||||
* @return {Property} The created iCalendar property
|
||||
*/
|
||||
static fromString(str, designSet) {
|
||||
return new Property(ICALParse.property(str, designSet));
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new ICAL.Property instance.
|
||||
*
|
||||
* It is important to note that mutations done in the wrapper directly mutate the jCal object used
|
||||
* to initialize.
|
||||
*
|
||||
* Can also be used to create new properties by passing the name of the property (as a String).
|
||||
*
|
||||
* @param {Array|String} jCal Raw jCal representation OR the new name of the property
|
||||
* @param {Component=} parent Parent component
|
||||
*/
|
||||
constructor(jCal, parent) {
|
||||
this._parent = parent || null;
|
||||
|
||||
if (typeof(jCal) === 'string') {
|
||||
// We are creating the property by name and need to detect the type
|
||||
this.jCal = [jCal, {}, design.defaultType];
|
||||
this.jCal[TYPE_INDEX] = this.getDefaultType();
|
||||
} else {
|
||||
this.jCal = jCal;
|
||||
}
|
||||
this._updateType();
|
||||
}
|
||||
|
||||
/**
|
||||
* The value type for this property
|
||||
* @type {String}
|
||||
*/
|
||||
get type() {
|
||||
return this.jCal[TYPE_INDEX];
|
||||
}
|
||||
|
||||
/**
|
||||
* The name of this property, in lowercase.
|
||||
* @type {String}
|
||||
*/
|
||||
get name() {
|
||||
return this.jCal[NAME_INDEX];
|
||||
}
|
||||
|
||||
/**
|
||||
* The parent component for this property.
|
||||
* @type {Component}
|
||||
*/
|
||||
get parent() {
|
||||
return this._parent;
|
||||
}
|
||||
|
||||
set parent(p) {
|
||||
// Before setting the parent, check if the design set has changed. If it
|
||||
// has, we later need to update the type if it was unknown before.
|
||||
let designSetChanged = !this._parent || (p && p._designSet != this._parent._designSet);
|
||||
|
||||
this._parent = p;
|
||||
|
||||
if (this.type == design.defaultType && designSetChanged) {
|
||||
this.jCal[TYPE_INDEX] = this.getDefaultType();
|
||||
this._updateType();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* The design set for this property, e.g. icalendar vs vcard
|
||||
*
|
||||
* @type {designSet}
|
||||
* @private
|
||||
*/
|
||||
get _designSet() {
|
||||
return this.parent ? this.parent._designSet : design.defaultSet;
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates the type metadata from the current jCal type and design set.
|
||||
*
|
||||
* @private
|
||||
*/
|
||||
_updateType() {
|
||||
let designSet = this._designSet;
|
||||
|
||||
if (this.type in designSet.value) {
|
||||
if ('decorate' in designSet.value[this.type]) {
|
||||
this.isDecorated = true;
|
||||
} else {
|
||||
this.isDecorated = false;
|
||||
}
|
||||
|
||||
if (this.name in designSet.property) {
|
||||
this.isMultiValue = ('multiValue' in designSet.property[this.name]);
|
||||
this.isStructuredValue = ('structuredValue' in designSet.property[this.name]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Hydrate a single value. The act of hydrating means turning the raw jCal
|
||||
* value into a potentially wrapped object, for example {@link ICAL.Time}.
|
||||
*
|
||||
* @private
|
||||
* @param {Number} index The index of the value to hydrate
|
||||
* @return {?Object} The decorated value.
|
||||
*/
|
||||
_hydrateValue(index) {
|
||||
if (this._values && this._values[index]) {
|
||||
return this._values[index];
|
||||
}
|
||||
|
||||
// for the case where there is no value.
|
||||
if (this.jCal.length <= (VALUE_INDEX + index)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
if (this.isDecorated) {
|
||||
if (!this._values) {
|
||||
this._values = [];
|
||||
}
|
||||
return (this._values[index] = this._decorate(
|
||||
this.jCal[VALUE_INDEX + index]
|
||||
));
|
||||
} else {
|
||||
return this.jCal[VALUE_INDEX + index];
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Decorate a single value, returning its wrapped object. This is used by
|
||||
* the hydrate function to actually wrap the value.
|
||||
*
|
||||
* @private
|
||||
* @param {?} value The value to decorate
|
||||
* @return {Object} The decorated value
|
||||
*/
|
||||
_decorate(value) {
|
||||
return this._designSet.value[this.type].decorate(value, this);
|
||||
}
|
||||
|
||||
/**
|
||||
* Undecorate a single value, returning its raw jCal data.
|
||||
*
|
||||
* @private
|
||||
* @param {Object} value The value to undecorate
|
||||
* @return {?} The undecorated value
|
||||
*/
|
||||
_undecorate(value) {
|
||||
return this._designSet.value[this.type].undecorate(value, this);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the value at the given index while also hydrating it. The passed
|
||||
* value can either be a decorated or undecorated value.
|
||||
*
|
||||
* @private
|
||||
* @param {?} value The value to set
|
||||
* @param {Number} index The index to set it at
|
||||
*/
|
||||
_setDecoratedValue(value, index) {
|
||||
if (!this._values) {
|
||||
this._values = [];
|
||||
}
|
||||
|
||||
if (typeof(value) === 'object' && 'icaltype' in value) {
|
||||
// decorated value
|
||||
this.jCal[VALUE_INDEX + index] = this._undecorate(value);
|
||||
this._values[index] = value;
|
||||
} else {
|
||||
// undecorated value
|
||||
this.jCal[VALUE_INDEX + index] = value;
|
||||
this._values[index] = this._decorate(value);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets a parameter on the property.
|
||||
*
|
||||
* @param {String} name Parameter name (lowercase)
|
||||
* @return {Array|String} Parameter value
|
||||
*/
|
||||
getParameter(name) {
|
||||
if (name in this.jCal[PROP_INDEX]) {
|
||||
return this.jCal[PROP_INDEX][name];
|
||||
} else {
|
||||
return undefined;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets first parameter on the property.
|
||||
*
|
||||
* @param {String} name Parameter name (lowercase)
|
||||
* @return {String} Parameter value
|
||||
*/
|
||||
getFirstParameter(name) {
|
||||
let parameters = this.getParameter(name);
|
||||
|
||||
if (Array.isArray(parameters)) {
|
||||
return parameters[0];
|
||||
}
|
||||
|
||||
return parameters;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets a parameter on the property.
|
||||
*
|
||||
* @param {String} name The parameter name
|
||||
* @param {Array|String} value The parameter value
|
||||
*/
|
||||
setParameter(name, value) {
|
||||
let lcname = name.toLowerCase();
|
||||
if (typeof value === "string" &&
|
||||
lcname in this._designSet.param &&
|
||||
'multiValue' in this._designSet.param[lcname]) {
|
||||
value = [value];
|
||||
}
|
||||
this.jCal[PROP_INDEX][name] = value;
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes a parameter
|
||||
*
|
||||
* @param {String} name The parameter name
|
||||
*/
|
||||
removeParameter(name) {
|
||||
delete this.jCal[PROP_INDEX][name];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the default type based on this property's name.
|
||||
*
|
||||
* @return {String} The default type for this property
|
||||
*/
|
||||
getDefaultType() {
|
||||
let name = this.jCal[NAME_INDEX];
|
||||
let designSet = this._designSet;
|
||||
|
||||
if (name in designSet.property) {
|
||||
let details = designSet.property[name];
|
||||
if ('defaultType' in details) {
|
||||
return details.defaultType;
|
||||
}
|
||||
}
|
||||
return design.defaultType;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets type of property and clears out any existing values of the current
|
||||
* type.
|
||||
*
|
||||
* @param {String} type New iCAL type (see design.*.values)
|
||||
*/
|
||||
resetType(type) {
|
||||
this.removeAllValues();
|
||||
this.jCal[TYPE_INDEX] = type;
|
||||
this._updateType();
|
||||
}
|
||||
|
||||
/**
|
||||
* Finds the first property value.
|
||||
*
|
||||
* @return {Binary | Duration | Period |
|
||||
* Recur | Time | UtcOffset | Geo | string | null} First property value
|
||||
*/
|
||||
getFirstValue() {
|
||||
return this._hydrateValue(0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets all values on the property.
|
||||
*
|
||||
* NOTE: this creates an array during each call.
|
||||
*
|
||||
* @return {Array} List of values
|
||||
*/
|
||||
getValues() {
|
||||
let len = this.jCal.length - VALUE_INDEX;
|
||||
|
||||
if (len < 1) {
|
||||
// it is possible for a property to have no value.
|
||||
return [];
|
||||
}
|
||||
|
||||
let i = 0;
|
||||
let result = [];
|
||||
|
||||
for (; i < len; i++) {
|
||||
result[i] = this._hydrateValue(i);
|
||||
}
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes all values from this property
|
||||
*/
|
||||
removeAllValues() {
|
||||
if (this._values) {
|
||||
this._values.length = 0;
|
||||
}
|
||||
this.jCal.length = 3;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the values of the property. Will overwrite the existing values.
|
||||
* This can only be used for multi-value properties.
|
||||
*
|
||||
* @param {Array} values An array of values
|
||||
*/
|
||||
setValues(values) {
|
||||
if (!this.isMultiValue) {
|
||||
throw new Error(
|
||||
this.name + ': does not not support mulitValue.\n' +
|
||||
'override isMultiValue'
|
||||
);
|
||||
}
|
||||
|
||||
let len = values.length;
|
||||
let i = 0;
|
||||
this.removeAllValues();
|
||||
|
||||
if (len > 0 &&
|
||||
typeof(values[0]) === 'object' &&
|
||||
'icaltype' in values[0]) {
|
||||
this.resetType(values[0].icaltype);
|
||||
}
|
||||
|
||||
if (this.isDecorated) {
|
||||
for (; i < len; i++) {
|
||||
this._setDecoratedValue(values[i], i);
|
||||
}
|
||||
} else {
|
||||
for (; i < len; i++) {
|
||||
this.jCal[VALUE_INDEX + i] = values[i];
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the current value of the property. If this is a multi-value
|
||||
* property, all other values will be removed.
|
||||
*
|
||||
* @param {String|Object} value New property value.
|
||||
*/
|
||||
setValue(value) {
|
||||
this.removeAllValues();
|
||||
if (typeof(value) === 'object' && 'icaltype' in value) {
|
||||
this.resetType(value.icaltype);
|
||||
}
|
||||
|
||||
if (this.isDecorated) {
|
||||
this._setDecoratedValue(value, 0);
|
||||
} else {
|
||||
this.jCal[VALUE_INDEX] = value;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the Object representation of this component. The returned object
|
||||
* is a live jCal object and should be cloned if modified.
|
||||
* @return {Object}
|
||||
*/
|
||||
toJSON() {
|
||||
return this.jCal;
|
||||
}
|
||||
|
||||
/**
|
||||
* The string representation of this component.
|
||||
* @return {String}
|
||||
*/
|
||||
toICALString() {
|
||||
return ICALStringify.property(
|
||||
this.jCal, this._designSet, true
|
||||
);
|
||||
}
|
||||
}
|
||||
export default Property;
|
||||
+576
@@ -0,0 +1,576 @@
|
||||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
* Portions Copyright (C) Philipp Kewisch */
|
||||
|
||||
import RecurIterator from "./recur_iterator.js";
|
||||
import Time from "./time.js";
|
||||
import design from "./design.js";
|
||||
import { strictParseInt, clone } from "./helpers.js";
|
||||
|
||||
/**
|
||||
* This lets typescript resolve our custom types in the
|
||||
* generated d.ts files (jsdoc typedefs are converted to typescript types).
|
||||
* Ignore prevents the typedefs from being documented more than once.
|
||||
*
|
||||
* @ignore
|
||||
* @typedef {import("./types.js").weekDay} weekDay
|
||||
* Imports the 'weekDay' type from the "types.js" module
|
||||
* @typedef {import("./types.js").frequencyValues} frequencyValues
|
||||
* Imports the 'frequencyValues' type from the "types.js" module
|
||||
*/
|
||||
|
||||
const VALID_DAY_NAMES = /^(SU|MO|TU|WE|TH|FR|SA)$/;
|
||||
const VALID_BYDAY_PART = /^([+-])?(5[0-3]|[1-4][0-9]|[1-9])?(SU|MO|TU|WE|TH|FR|SA)$/;
|
||||
const DOW_MAP = {
|
||||
SU: Time.SUNDAY,
|
||||
MO: Time.MONDAY,
|
||||
TU: Time.TUESDAY,
|
||||
WE: Time.WEDNESDAY,
|
||||
TH: Time.THURSDAY,
|
||||
FR: Time.FRIDAY,
|
||||
SA: Time.SATURDAY
|
||||
};
|
||||
|
||||
const REVERSE_DOW_MAP = Object.fromEntries(Object.entries(DOW_MAP).map(entry => entry.reverse()));
|
||||
|
||||
const ALLOWED_FREQ = ['SECONDLY', 'MINUTELY', 'HOURLY',
|
||||
'DAILY', 'WEEKLY', 'MONTHLY', 'YEARLY'];
|
||||
|
||||
/**
|
||||
* This class represents the "recur" value type, used for example by RRULE. It provides methods to
|
||||
* calculate occurrences among others.
|
||||
*
|
||||
* @memberof ICAL
|
||||
*/
|
||||
class Recur {
|
||||
/**
|
||||
* Creates a new {@link ICAL.Recur} instance from the passed string.
|
||||
*
|
||||
* @param {String} string The string to parse
|
||||
* @return {Recur} The created recurrence instance
|
||||
*/
|
||||
static fromString(string) {
|
||||
let data = this._stringToData(string, false);
|
||||
return new Recur(data);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new {@link ICAL.Recur} instance using members from the passed
|
||||
* data object.
|
||||
*
|
||||
* @param {Object} aData An object with members of the recurrence
|
||||
* @param {frequencyValues=} aData.freq The frequency value
|
||||
* @param {Number=} aData.interval The INTERVAL value
|
||||
* @param {weekDay=} aData.wkst The week start value
|
||||
* @param {Time=} aData.until The end of the recurrence set
|
||||
* @param {Number=} aData.count The number of occurrences
|
||||
* @param {Array.<Number>=} aData.bysecond The seconds for the BYSECOND part
|
||||
* @param {Array.<Number>=} aData.byminute The minutes for the BYMINUTE part
|
||||
* @param {Array.<Number>=} aData.byhour The hours for the BYHOUR part
|
||||
* @param {Array.<String>=} aData.byday The BYDAY values
|
||||
* @param {Array.<Number>=} aData.bymonthday The days for the BYMONTHDAY part
|
||||
* @param {Array.<Number>=} aData.byyearday The days for the BYYEARDAY part
|
||||
* @param {Array.<Number>=} aData.byweekno The weeks for the BYWEEKNO part
|
||||
* @param {Array.<Number>=} aData.bymonth The month for the BYMONTH part
|
||||
* @param {Array.<Number>=} aData.bysetpos The positionals for the BYSETPOS part
|
||||
*/
|
||||
static fromData(aData) {
|
||||
return new Recur(aData);
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts a recurrence string to a data object, suitable for the fromData
|
||||
* method.
|
||||
*
|
||||
* @private
|
||||
* @param {String} string The string to parse
|
||||
* @param {Boolean} fmtIcal If true, the string is considered to be an
|
||||
* iCalendar string
|
||||
* @return {Recur} The recurrence instance
|
||||
*/
|
||||
static _stringToData(string, fmtIcal) {
|
||||
let dict = Object.create(null);
|
||||
|
||||
// split is slower in FF but fast enough.
|
||||
// v8 however this is faster then manual split?
|
||||
let values = string.split(';');
|
||||
let len = values.length;
|
||||
|
||||
for (let i = 0; i < len; i++) {
|
||||
let parts = values[i].split('=');
|
||||
let ucname = parts[0].toUpperCase();
|
||||
let lcname = parts[0].toLowerCase();
|
||||
let name = (fmtIcal ? lcname : ucname);
|
||||
let value = parts[1];
|
||||
|
||||
if (ucname in partDesign) {
|
||||
let partArr = value.split(',');
|
||||
let partSet = new Set();
|
||||
|
||||
for (let part of partArr) {
|
||||
partSet.add(partDesign[ucname](part));
|
||||
}
|
||||
partArr = [...partSet];
|
||||
|
||||
dict[name] = (partArr.length == 1 ? partArr[0] : partArr);
|
||||
} else if (ucname in optionDesign) {
|
||||
optionDesign[ucname](value, dict, fmtIcal);
|
||||
} else {
|
||||
// Don't swallow unknown values. Just set them as they are.
|
||||
dict[lcname] = value;
|
||||
}
|
||||
}
|
||||
|
||||
return dict;
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert an ical representation of a day (SU, MO, etc..)
|
||||
* into a numeric value of that day.
|
||||
*
|
||||
* @param {String} string The iCalendar day name
|
||||
* @param {weekDay=} aWeekStart
|
||||
* The week start weekday, defaults to SUNDAY
|
||||
* @return {Number} Numeric value of given day
|
||||
*/
|
||||
static icalDayToNumericDay(string, aWeekStart) {
|
||||
//XXX: this is here so we can deal
|
||||
// with possibly invalid string values.
|
||||
let firstDow = aWeekStart || Time.SUNDAY;
|
||||
return ((DOW_MAP[string] - firstDow + 7) % 7) + 1;
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert a numeric day value into its ical representation (SU, MO, etc..)
|
||||
*
|
||||
* @param {Number} num Numeric value of given day
|
||||
* @param {weekDay=} aWeekStart
|
||||
* The week start weekday, defaults to SUNDAY
|
||||
* @return {String} The ICAL day value, e.g SU,MO,...
|
||||
*/
|
||||
static numericDayToIcalDay(num, aWeekStart) {
|
||||
//XXX: this is here so we can deal with possibly invalid number values.
|
||||
// Also, this allows consistent mapping between day numbers and day
|
||||
// names for external users.
|
||||
let firstDow = aWeekStart || Time.SUNDAY;
|
||||
let dow = (num + firstDow - Time.SUNDAY);
|
||||
if (dow > 7) {
|
||||
dow -= 7;
|
||||
}
|
||||
return REVERSE_DOW_MAP[dow];
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a new instance of the Recur class.
|
||||
*
|
||||
* @param {Object} data An object with members of the recurrence
|
||||
* @param {frequencyValues=} data.freq The frequency value
|
||||
* @param {Number=} data.interval The INTERVAL value
|
||||
* @param {weekDay=} data.wkst The week start value
|
||||
* @param {Time=} data.until The end of the recurrence set
|
||||
* @param {Number=} data.count The number of occurrences
|
||||
* @param {Array.<Number>=} data.bysecond The seconds for the BYSECOND part
|
||||
* @param {Array.<Number>=} data.byminute The minutes for the BYMINUTE part
|
||||
* @param {Array.<Number>=} data.byhour The hours for the BYHOUR part
|
||||
* @param {Array.<String>=} data.byday The BYDAY values
|
||||
* @param {Array.<Number>=} data.bymonthday The days for the BYMONTHDAY part
|
||||
* @param {Array.<Number>=} data.byyearday The days for the BYYEARDAY part
|
||||
* @param {Array.<Number>=} data.byweekno The weeks for the BYWEEKNO part
|
||||
* @param {Array.<Number>=} data.bymonth The month for the BYMONTH part
|
||||
* @param {Array.<Number>=} data.bysetpos The positionals for the BYSETPOS part
|
||||
*/
|
||||
constructor(data) {
|
||||
this.wrappedJSObject = this;
|
||||
this.parts = {};
|
||||
|
||||
if (data && typeof(data) === 'object') {
|
||||
this.fromData(data);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* An object holding the BY-parts of the recurrence rule
|
||||
* @memberof ICAL.Recur
|
||||
* @typedef {Object} byParts
|
||||
* @property {Array.<Number>=} BYSECOND The seconds for the BYSECOND part
|
||||
* @property {Array.<Number>=} BYMINUTE The minutes for the BYMINUTE part
|
||||
* @property {Array.<Number>=} BYHOUR The hours for the BYHOUR part
|
||||
* @property {Array.<String>=} BYDAY The BYDAY values
|
||||
* @property {Array.<Number>=} BYMONTHDAY The days for the BYMONTHDAY part
|
||||
* @property {Array.<Number>=} BYYEARDAY The days for the BYYEARDAY part
|
||||
* @property {Array.<Number>=} BYWEEKNO The weeks for the BYWEEKNO part
|
||||
* @property {Array.<Number>=} BYMONTH The month for the BYMONTH part
|
||||
* @property {Array.<Number>=} BYSETPOS The positionals for the BYSETPOS part
|
||||
*/
|
||||
|
||||
/**
|
||||
* An object holding the BY-parts of the recurrence rule
|
||||
* @type {byParts}
|
||||
*/
|
||||
parts = null;
|
||||
|
||||
/**
|
||||
* The interval value for the recurrence rule.
|
||||
* @type {Number}
|
||||
*/
|
||||
interval = 1;
|
||||
|
||||
/**
|
||||
* The week start day
|
||||
*
|
||||
* @type {weekDay}
|
||||
* @default ICAL.Time.MONDAY
|
||||
*/
|
||||
wkst = Time.MONDAY;
|
||||
|
||||
/**
|
||||
* The end of the recurrence
|
||||
* @type {?Time}
|
||||
*/
|
||||
until = null;
|
||||
|
||||
/**
|
||||
* The maximum number of occurrences
|
||||
* @type {?Number}
|
||||
*/
|
||||
count = null;
|
||||
|
||||
/**
|
||||
* The frequency value.
|
||||
* @type {frequencyValues}
|
||||
*/
|
||||
freq = null;
|
||||
|
||||
/**
|
||||
* The class identifier.
|
||||
* @constant
|
||||
* @type {String}
|
||||
* @default "icalrecur"
|
||||
*/
|
||||
icalclass = "icalrecur";
|
||||
|
||||
/**
|
||||
* The type name, to be used in the jCal object.
|
||||
* @constant
|
||||
* @type {String}
|
||||
* @default "recur"
|
||||
*/
|
||||
icaltype = "recur";
|
||||
|
||||
/**
|
||||
* Create a new iterator for this recurrence rule. The passed start date
|
||||
* must be the start date of the event, not the start of the range to
|
||||
* search in.
|
||||
*
|
||||
* @example
|
||||
* let recur = comp.getFirstPropertyValue('rrule');
|
||||
* let dtstart = comp.getFirstPropertyValue('dtstart');
|
||||
* let iter = recur.iterator(dtstart);
|
||||
* for (let next = iter.next(); next; next = iter.next()) {
|
||||
* if (next.compare(rangeStart) < 0) {
|
||||
* continue;
|
||||
* }
|
||||
* console.log(next.toString());
|
||||
* }
|
||||
*
|
||||
* @param {Time} aStart The item's start date
|
||||
* @return {RecurIterator} The recurrence iterator
|
||||
*/
|
||||
iterator(aStart) {
|
||||
return new RecurIterator({
|
||||
rule: this,
|
||||
dtstart: aStart
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a clone of the recurrence object.
|
||||
*
|
||||
* @return {Recur} The cloned object
|
||||
*/
|
||||
clone() {
|
||||
return new Recur(this.toJSON());
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if the current rule is finite, i.e. has a count or until part.
|
||||
*
|
||||
* @return {Boolean} True, if the rule is finite
|
||||
*/
|
||||
isFinite() {
|
||||
return !!(this.count || this.until);
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if the current rule has a count part, and not limited by an until
|
||||
* part.
|
||||
*
|
||||
* @return {Boolean} True, if the rule is by count
|
||||
*/
|
||||
isByCount() {
|
||||
return !!(this.count && !this.until);
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds a component (part) to the recurrence rule. This is not a component
|
||||
* in the sense of {@link ICAL.Component}, but a part of the recurrence
|
||||
* rule, i.e. BYMONTH.
|
||||
*
|
||||
* @param {String} aType The name of the component part
|
||||
* @param {Array|String} aValue The component value
|
||||
*/
|
||||
addComponent(aType, aValue) {
|
||||
let ucname = aType.toUpperCase();
|
||||
if (ucname in this.parts) {
|
||||
this.parts[ucname].push(aValue);
|
||||
} else {
|
||||
this.parts[ucname] = [aValue];
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the component value for the given by-part.
|
||||
*
|
||||
* @param {String} aType The component part name
|
||||
* @param {Array} aValues The component values
|
||||
*/
|
||||
setComponent(aType, aValues) {
|
||||
this.parts[aType.toUpperCase()] = aValues.slice();
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets (a copy) of the requested component value.
|
||||
*
|
||||
* @param {String} aType The component part name
|
||||
* @return {Array} The component part value
|
||||
*/
|
||||
getComponent(aType) {
|
||||
let ucname = aType.toUpperCase();
|
||||
return (ucname in this.parts ? this.parts[ucname].slice() : []);
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves the next occurrence after the given recurrence id. See the
|
||||
* guide on {@tutorial terminology} for more details.
|
||||
*
|
||||
* NOTE: Currently, this method iterates all occurrences from the start
|
||||
* date. It should not be called in a loop for performance reasons. If you
|
||||
* would like to get more than one occurrence, you can iterate the
|
||||
* occurrences manually, see the example on the
|
||||
* {@link ICAL.Recur#iterator iterator} method.
|
||||
*
|
||||
* @param {Time} aStartTime The start of the event series
|
||||
* @param {Time} aRecurrenceId The date of the last occurrence
|
||||
* @return {Time} The next occurrence after
|
||||
*/
|
||||
getNextOccurrence(aStartTime, aRecurrenceId) {
|
||||
let iter = this.iterator(aStartTime);
|
||||
let next;
|
||||
|
||||
do {
|
||||
next = iter.next();
|
||||
} while (next && next.compare(aRecurrenceId) <= 0);
|
||||
|
||||
if (next && aRecurrenceId.zone) {
|
||||
next.zone = aRecurrenceId.zone;
|
||||
}
|
||||
|
||||
return next;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets up the current instance using members from the passed data object.
|
||||
*
|
||||
* @param {Object} data An object with members of the recurrence
|
||||
* @param {frequencyValues=} data.freq The frequency value
|
||||
* @param {Number=} data.interval The INTERVAL value
|
||||
* @param {weekDay=} data.wkst The week start value
|
||||
* @param {Time=} data.until The end of the recurrence set
|
||||
* @param {Number=} data.count The number of occurrences
|
||||
* @param {Array.<Number>=} data.bysecond The seconds for the BYSECOND part
|
||||
* @param {Array.<Number>=} data.byminute The minutes for the BYMINUTE part
|
||||
* @param {Array.<Number>=} data.byhour The hours for the BYHOUR part
|
||||
* @param {Array.<String>=} data.byday The BYDAY values
|
||||
* @param {Array.<Number>=} data.bymonthday The days for the BYMONTHDAY part
|
||||
* @param {Array.<Number>=} data.byyearday The days for the BYYEARDAY part
|
||||
* @param {Array.<Number>=} data.byweekno The weeks for the BYWEEKNO part
|
||||
* @param {Array.<Number>=} data.bymonth The month for the BYMONTH part
|
||||
* @param {Array.<Number>=} data.bysetpos The positionals for the BYSETPOS part
|
||||
*/
|
||||
fromData(data) {
|
||||
for (let key in data) {
|
||||
let uckey = key.toUpperCase();
|
||||
|
||||
if (uckey in partDesign) {
|
||||
if (Array.isArray(data[key])) {
|
||||
this.parts[uckey] = data[key];
|
||||
} else {
|
||||
this.parts[uckey] = [data[key]];
|
||||
}
|
||||
} else {
|
||||
this[key] = data[key];
|
||||
}
|
||||
}
|
||||
|
||||
if (this.interval && typeof this.interval != "number") {
|
||||
optionDesign.INTERVAL(this.interval, this);
|
||||
}
|
||||
|
||||
if (this.wkst && typeof this.wkst != "number") {
|
||||
this.wkst = Recur.icalDayToNumericDay(this.wkst);
|
||||
}
|
||||
|
||||
if (this.until && !(this.until instanceof Time)) {
|
||||
this.until = Time.fromString(this.until);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* The jCal representation of this recurrence type.
|
||||
* @return {Object}
|
||||
*/
|
||||
toJSON() {
|
||||
let res = Object.create(null);
|
||||
res.freq = this.freq;
|
||||
|
||||
if (this.count) {
|
||||
res.count = this.count;
|
||||
}
|
||||
|
||||
if (this.interval > 1) {
|
||||
res.interval = this.interval;
|
||||
}
|
||||
|
||||
for (let [k, kparts] of Object.entries(this.parts)) {
|
||||
if (Array.isArray(kparts) && kparts.length == 1) {
|
||||
res[k.toLowerCase()] = kparts[0];
|
||||
} else {
|
||||
res[k.toLowerCase()] = clone(kparts);
|
||||
}
|
||||
}
|
||||
|
||||
if (this.until) {
|
||||
res.until = this.until.toString();
|
||||
}
|
||||
if ('wkst' in this && this.wkst !== Time.DEFAULT_WEEK_START) {
|
||||
res.wkst = Recur.numericDayToIcalDay(this.wkst);
|
||||
}
|
||||
return res;
|
||||
}
|
||||
|
||||
/**
|
||||
* The string representation of this recurrence rule.
|
||||
* @return {String}
|
||||
*/
|
||||
toString() {
|
||||
// TODO retain order
|
||||
let str = "FREQ=" + this.freq;
|
||||
if (this.count) {
|
||||
str += ";COUNT=" + this.count;
|
||||
}
|
||||
if (this.interval > 1) {
|
||||
str += ";INTERVAL=" + this.interval;
|
||||
}
|
||||
for (let [k, v] of Object.entries(this.parts)) {
|
||||
str += ";" + k + "=" + v;
|
||||
}
|
||||
if (this.until) {
|
||||
str += ';UNTIL=' + this.until.toICALString();
|
||||
}
|
||||
if ('wkst' in this && this.wkst !== Time.DEFAULT_WEEK_START) {
|
||||
str += ';WKST=' + Recur.numericDayToIcalDay(this.wkst);
|
||||
}
|
||||
return str;
|
||||
}
|
||||
}
|
||||
export default Recur;
|
||||
|
||||
function parseNumericValue(type, min, max, value) {
|
||||
let result = value;
|
||||
|
||||
if (value[0] === '+') {
|
||||
result = value.slice(1);
|
||||
}
|
||||
|
||||
result = strictParseInt(result);
|
||||
|
||||
if (min !== undefined && value < min) {
|
||||
throw new Error(
|
||||
type + ': invalid value "' + value + '" must be > ' + min
|
||||
);
|
||||
}
|
||||
|
||||
if (max !== undefined && value > max) {
|
||||
throw new Error(
|
||||
type + ': invalid value "' + value + '" must be < ' + min
|
||||
);
|
||||
}
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
const optionDesign = {
|
||||
FREQ: function(value, dict, fmtIcal) {
|
||||
// yes this is actually equal or faster then regex.
|
||||
// upside here is we can enumerate the valid values.
|
||||
if (ALLOWED_FREQ.indexOf(value) !== -1) {
|
||||
dict.freq = value;
|
||||
} else {
|
||||
throw new Error(
|
||||
'invalid frequency "' + value + '" expected: "' +
|
||||
ALLOWED_FREQ.join(', ') + '"'
|
||||
);
|
||||
}
|
||||
},
|
||||
|
||||
COUNT: function(value, dict, fmtIcal) {
|
||||
dict.count = strictParseInt(value);
|
||||
},
|
||||
|
||||
INTERVAL: function(value, dict, fmtIcal) {
|
||||
dict.interval = strictParseInt(value);
|
||||
if (dict.interval < 1) {
|
||||
// 0 or negative values are not allowed, some engines seem to generate
|
||||
// it though. Assume 1 instead.
|
||||
dict.interval = 1;
|
||||
}
|
||||
},
|
||||
|
||||
UNTIL: function(value, dict, fmtIcal) {
|
||||
if (value.length > 10) {
|
||||
dict.until = design.icalendar.value['date-time'].fromICAL(value);
|
||||
} else {
|
||||
dict.until = design.icalendar.value.date.fromICAL(value);
|
||||
}
|
||||
if (!fmtIcal) {
|
||||
dict.until = Time.fromString(dict.until);
|
||||
}
|
||||
},
|
||||
|
||||
WKST: function(value, dict, fmtIcal) {
|
||||
if (VALID_DAY_NAMES.test(value)) {
|
||||
dict.wkst = Recur.icalDayToNumericDay(value);
|
||||
} else {
|
||||
throw new Error('invalid WKST value "' + value + '"');
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
const partDesign = {
|
||||
BYSECOND: parseNumericValue.bind(undefined, 'BYSECOND', 0, 60),
|
||||
BYMINUTE: parseNumericValue.bind(undefined, 'BYMINUTE', 0, 59),
|
||||
BYHOUR: parseNumericValue.bind(undefined, 'BYHOUR', 0, 23),
|
||||
BYDAY: function(value) {
|
||||
if (VALID_BYDAY_PART.test(value)) {
|
||||
return value;
|
||||
} else {
|
||||
throw new Error('invalid BYDAY value "' + value + '"');
|
||||
}
|
||||
},
|
||||
BYMONTHDAY: parseNumericValue.bind(undefined, 'BYMONTHDAY', -31, 31),
|
||||
BYYEARDAY: parseNumericValue.bind(undefined, 'BYYEARDAY', -366, 366),
|
||||
BYWEEKNO: parseNumericValue.bind(undefined, 'BYWEEKNO', -53, 53),
|
||||
BYMONTH: parseNumericValue.bind(undefined, 'BYMONTH', 1, 12),
|
||||
BYSETPOS: parseNumericValue.bind(undefined, 'BYSETPOS', -366, 366)
|
||||
};
|
||||
+492
@@ -0,0 +1,492 @@
|
||||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
* Portions Copyright (C) Philipp Kewisch */
|
||||
|
||||
import Time from "./time.js";
|
||||
import RecurIterator from "./recur_iterator.js";
|
||||
// needed for typescript type resolution
|
||||
// eslint-disable-next-line no-unused-vars
|
||||
import Component from "./component.js";
|
||||
import { formatClassType, binsearchInsert } from "./helpers.js";
|
||||
|
||||
/**
|
||||
* Primary class for expanding recurring rules. Can take multiple rrules, rdates, exdate(s) and
|
||||
* iterate (in order) over each next occurrence.
|
||||
*
|
||||
* Once initialized this class can also be serialized saved and continue iteration from the last
|
||||
* point.
|
||||
*
|
||||
* NOTE: it is intended that this class is to be used with {@link ICAL.Event} which handles recurrence
|
||||
* exceptions.
|
||||
*
|
||||
* @example
|
||||
* // assuming event is a parsed ical component
|
||||
* var event;
|
||||
*
|
||||
* var expand = new ICAL.RecurExpansion({
|
||||
* component: event,
|
||||
* dtstart: event.getFirstPropertyValue('dtstart')
|
||||
* });
|
||||
*
|
||||
* // remember there are infinite rules so it is a good idea to limit the scope of the iterations
|
||||
* // then resume later on.
|
||||
*
|
||||
* // next is always an ICAL.Time or null
|
||||
* var next;
|
||||
*
|
||||
* while (someCondition && (next = expand.next())) {
|
||||
* // do something with next
|
||||
* }
|
||||
*
|
||||
* // save instance for later
|
||||
* var json = JSON.stringify(expand);
|
||||
*
|
||||
* //...
|
||||
*
|
||||
* // NOTE: if the component's properties have changed you will need to rebuild the class and start
|
||||
* // over. This only works when the component's recurrence info is the same.
|
||||
* var expand = new ICAL.RecurExpansion(JSON.parse(json));
|
||||
*
|
||||
* @memberof ICAL
|
||||
*/
|
||||
class RecurExpansion {
|
||||
/**
|
||||
* Creates a new ICAL.RecurExpansion instance.
|
||||
*
|
||||
* The options object can be filled with the specified initial values. It can also contain
|
||||
* additional members, as a result of serializing a previous expansion state, as shown in the
|
||||
* example.
|
||||
*
|
||||
* @param {Object} options
|
||||
* Recurrence expansion options
|
||||
* @param {Time} options.dtstart
|
||||
* Start time of the event
|
||||
* @param {Component=} options.component
|
||||
* Component for expansion, required if not resuming.
|
||||
*/
|
||||
constructor(options) {
|
||||
this.ruleDates = [];
|
||||
this.exDates = [];
|
||||
this.fromData(options);
|
||||
}
|
||||
|
||||
/**
|
||||
* True when iteration is fully completed.
|
||||
* @type {Boolean}
|
||||
*/
|
||||
complete = false;
|
||||
|
||||
/**
|
||||
* Array of rrule iterators.
|
||||
*
|
||||
* @type {RecurIterator[]}
|
||||
* @private
|
||||
*/
|
||||
ruleIterators = null;
|
||||
|
||||
/**
|
||||
* Array of rdate instances.
|
||||
*
|
||||
* @type {Time[]}
|
||||
* @private
|
||||
*/
|
||||
ruleDates = null;
|
||||
|
||||
/**
|
||||
* Array of exdate instances.
|
||||
*
|
||||
* @type {Time[]}
|
||||
* @private
|
||||
*/
|
||||
exDates = null;
|
||||
|
||||
/**
|
||||
* Current position in ruleDates array.
|
||||
* @type {Number}
|
||||
* @private
|
||||
*/
|
||||
ruleDateInc = 0;
|
||||
|
||||
/**
|
||||
* Current position in exDates array
|
||||
* @type {Number}
|
||||
* @private
|
||||
*/
|
||||
exDateInc = 0;
|
||||
|
||||
/**
|
||||
* Current negative date.
|
||||
*
|
||||
* @type {Time}
|
||||
* @private
|
||||
*/
|
||||
exDate = null;
|
||||
|
||||
/**
|
||||
* Current additional date.
|
||||
*
|
||||
* @type {Time}
|
||||
* @private
|
||||
*/
|
||||
ruleDate = null;
|
||||
|
||||
/**
|
||||
* Start date of recurring rules.
|
||||
*
|
||||
* @type {Time}
|
||||
*/
|
||||
dtstart = null;
|
||||
|
||||
/**
|
||||
* Last expanded time
|
||||
*
|
||||
* @type {Time}
|
||||
*/
|
||||
last = null;
|
||||
|
||||
/**
|
||||
* Initialize the recurrence expansion from the data object. The options
|
||||
* object may also contain additional members, see the
|
||||
* {@link ICAL.RecurExpansion constructor} for more details.
|
||||
*
|
||||
* @param {Object} options
|
||||
* Recurrence expansion options
|
||||
* @param {Time} options.dtstart
|
||||
* Start time of the event
|
||||
* @param {Component=} options.component
|
||||
* Component for expansion, required if not resuming.
|
||||
*/
|
||||
fromData(options) {
|
||||
let start = formatClassType(options.dtstart, Time);
|
||||
|
||||
if (!start) {
|
||||
throw new Error('.dtstart (ICAL.Time) must be given');
|
||||
} else {
|
||||
this.dtstart = start;
|
||||
}
|
||||
|
||||
if (options.component) {
|
||||
this._init(options.component);
|
||||
} else {
|
||||
this.last = formatClassType(options.last, Time) || start.clone();
|
||||
|
||||
if (!options.ruleIterators) {
|
||||
throw new Error('.ruleIterators or .component must be given');
|
||||
}
|
||||
|
||||
this.ruleIterators = options.ruleIterators.map(function(item) {
|
||||
return formatClassType(item, RecurIterator);
|
||||
});
|
||||
|
||||
this.ruleDateInc = options.ruleDateInc;
|
||||
this.exDateInc = options.exDateInc;
|
||||
|
||||
if (options.ruleDates) {
|
||||
this.ruleDates = options.ruleDates.map(item => formatClassType(item, Time));
|
||||
this.ruleDate = this.ruleDates[this.ruleDateInc];
|
||||
}
|
||||
|
||||
if (options.exDates) {
|
||||
this.exDates = options.exDates.map(item => formatClassType(item, Time));
|
||||
this.exDate = this.exDates[this.exDateInc];
|
||||
}
|
||||
|
||||
if (typeof(options.complete) !== 'undefined') {
|
||||
this.complete = options.complete;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Compare two ICAL.Time objects. When the second parameter is a DATE and the first parameter is
|
||||
* DATE-TIME, strip the time and compare only the days.
|
||||
*
|
||||
* @private
|
||||
* @param {Time} a The one object to compare
|
||||
* @param {Time} b The other object to compare
|
||||
*/
|
||||
_compare_special(a, b) {
|
||||
if (!a.isDate && b.isDate)
|
||||
return new Time({ year: a.year, month: a.month, day: a.day }).compare(b);
|
||||
return a.compare(b);
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve the next occurrence in the series.
|
||||
* @return {Time}
|
||||
*/
|
||||
next() {
|
||||
let iter;
|
||||
let next;
|
||||
let compare;
|
||||
|
||||
let maxTries = 500;
|
||||
let currentTry = 0;
|
||||
|
||||
while (true) {
|
||||
if (currentTry++ > maxTries) {
|
||||
throw new Error(
|
||||
'max tries have occurred, rule may be impossible to fulfill.'
|
||||
);
|
||||
}
|
||||
|
||||
next = this.ruleDate;
|
||||
iter = this._nextRecurrenceIter(this.last);
|
||||
|
||||
// no more matches
|
||||
// because we increment the rule day or rule
|
||||
// _after_ we choose a value this should be
|
||||
// the only spot where we need to worry about the
|
||||
// end of events.
|
||||
if (!next && !iter) {
|
||||
// there are no more iterators or rdates
|
||||
this.complete = true;
|
||||
break;
|
||||
}
|
||||
|
||||
// no next rule day or recurrence rule is first.
|
||||
if (!next || (iter && next.compare(iter.last) > 0)) {
|
||||
// must be cloned, recur will reuse the time element.
|
||||
next = iter.last.clone();
|
||||
// move to next so we can continue
|
||||
iter.next();
|
||||
}
|
||||
|
||||
// if the ruleDate is still next increment it.
|
||||
if (this.ruleDate === next) {
|
||||
this._nextRuleDay();
|
||||
}
|
||||
|
||||
this.last = next;
|
||||
|
||||
// check the negative rules
|
||||
if (this.exDate) {
|
||||
// EXDATE can be in DATE format, but DTSTART is in DATE-TIME format
|
||||
compare = this._compare_special(this.last, this.exDate);
|
||||
|
||||
if (compare > 0) {
|
||||
this._nextExDay();
|
||||
}
|
||||
|
||||
// if the current rule is excluded skip it.
|
||||
if (compare === 0) {
|
||||
this._nextExDay();
|
||||
continue;
|
||||
}
|
||||
}
|
||||
|
||||
//XXX: The spec states that after we resolve the final
|
||||
// list of dates we execute exdate this seems somewhat counter
|
||||
// intuitive to what I have seen most servers do so for now
|
||||
// I exclude based on the original date not the one that may
|
||||
// have been modified by the exception.
|
||||
return this.last;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts object into a serialize-able format. This format can be passed
|
||||
* back into the expansion to resume iteration.
|
||||
* @return {Object}
|
||||
*/
|
||||
toJSON() {
|
||||
function toJSON(item) {
|
||||
return item.toJSON();
|
||||
}
|
||||
|
||||
let result = Object.create(null);
|
||||
result.ruleIterators = this.ruleIterators.map(toJSON);
|
||||
|
||||
if (this.ruleDates) {
|
||||
result.ruleDates = this.ruleDates.map(toJSON);
|
||||
}
|
||||
|
||||
if (this.exDates) {
|
||||
result.exDates = this.exDates.map(toJSON);
|
||||
}
|
||||
|
||||
result.ruleDateInc = this.ruleDateInc;
|
||||
result.exDateInc = this.exDateInc;
|
||||
result.last = this.last.toJSON();
|
||||
result.dtstart = this.dtstart.toJSON();
|
||||
result.complete = this.complete;
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Extract all dates from the properties in the given component. The
|
||||
* properties will be filtered by the property name.
|
||||
*
|
||||
* @private
|
||||
* @param {Component} component The component to search in
|
||||
* @param {String} propertyName The property name to search for
|
||||
* @return {Time[]} The extracted dates.
|
||||
*/
|
||||
_extractDates(component, propertyName) {
|
||||
let result = [];
|
||||
let props = component.getAllProperties(propertyName);
|
||||
|
||||
for (let i = 0, len = props.length; i < len; i++) {
|
||||
for (let prop of props[i].getValues()) {
|
||||
let idx = binsearchInsert(
|
||||
result,
|
||||
prop,
|
||||
(a, b) => a.compare(b)
|
||||
);
|
||||
|
||||
// ordered insert
|
||||
result.splice(idx, 0, prop);
|
||||
}
|
||||
}
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initialize the recurrence expansion.
|
||||
*
|
||||
* @private
|
||||
* @param {Component} component The component to initialize from.
|
||||
*/
|
||||
_init(component) {
|
||||
this.ruleIterators = [];
|
||||
|
||||
this.last = this.dtstart.clone();
|
||||
|
||||
// to provide api consistency non-recurring
|
||||
// events can also use the iterator though it will
|
||||
// only return a single time.
|
||||
if (!component.hasProperty('rdate') &&
|
||||
!component.hasProperty('rrule') &&
|
||||
!component.hasProperty('recurrence-id')) {
|
||||
this.ruleDate = this.last.clone();
|
||||
this.complete = true;
|
||||
return;
|
||||
}
|
||||
|
||||
if (component.hasProperty('rdate')) {
|
||||
this.ruleDates = this._extractDates(component, 'rdate');
|
||||
|
||||
// special hack for cases where first rdate is prior
|
||||
// to the start date. We only check for the first rdate.
|
||||
// This is mostly for google's crazy recurring date logic
|
||||
// (contacts birthdays).
|
||||
if ((this.ruleDates[0]) &&
|
||||
(this.ruleDates[0].compare(this.dtstart) < 0)) {
|
||||
|
||||
this.ruleDateInc = 0;
|
||||
this.last = this.ruleDates[0].clone();
|
||||
} else {
|
||||
this.ruleDateInc = binsearchInsert(
|
||||
this.ruleDates,
|
||||
this.last,
|
||||
(a, b) => a.compare(b)
|
||||
);
|
||||
}
|
||||
|
||||
this.ruleDate = this.ruleDates[this.ruleDateInc];
|
||||
}
|
||||
|
||||
if (component.hasProperty('rrule')) {
|
||||
let rules = component.getAllProperties('rrule');
|
||||
let i = 0;
|
||||
let len = rules.length;
|
||||
|
||||
let rule;
|
||||
let iter;
|
||||
|
||||
for (; i < len; i++) {
|
||||
rule = rules[i].getFirstValue();
|
||||
iter = rule.iterator(this.dtstart);
|
||||
this.ruleIterators.push(iter);
|
||||
|
||||
// increment to the next occurrence so future
|
||||
// calls to next return times beyond the initial iteration.
|
||||
// XXX: I find this suspicious might be a bug?
|
||||
iter.next();
|
||||
}
|
||||
}
|
||||
|
||||
if (component.hasProperty('exdate')) {
|
||||
this.exDates = this._extractDates(component, 'exdate');
|
||||
// if we have a .last day we increment the index to beyond it.
|
||||
// When DTSTART is in DATE-TIME format, EXDATE is in DATE format and EXDATE is
|
||||
// the date of DTSTART, _compare_special finds this out and compareTime fails.
|
||||
this.exDateInc = binsearchInsert(
|
||||
this.exDates,
|
||||
this.last,
|
||||
this._compare_special
|
||||
);
|
||||
|
||||
this.exDate = this.exDates[this.exDateInc];
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Advance to the next exdate
|
||||
* @private
|
||||
*/
|
||||
_nextExDay() {
|
||||
this.exDate = this.exDates[++this.exDateInc];
|
||||
}
|
||||
|
||||
/**
|
||||
* Advance to the next rule date
|
||||
* @private
|
||||
*/
|
||||
_nextRuleDay() {
|
||||
this.ruleDate = this.ruleDates[++this.ruleDateInc];
|
||||
}
|
||||
|
||||
/**
|
||||
* Find and return the recurrence rule with the most recent event and
|
||||
* return it.
|
||||
*
|
||||
* @private
|
||||
* @return {?RecurIterator} Found iterator.
|
||||
*/
|
||||
_nextRecurrenceIter() {
|
||||
let iters = this.ruleIterators;
|
||||
|
||||
if (iters.length === 0) {
|
||||
return null;
|
||||
}
|
||||
|
||||
let len = iters.length;
|
||||
let iter;
|
||||
let iterTime;
|
||||
let iterIdx = 0;
|
||||
let chosenIter;
|
||||
|
||||
// loop through each iterator
|
||||
for (; iterIdx < len; iterIdx++) {
|
||||
iter = iters[iterIdx];
|
||||
iterTime = iter.last;
|
||||
|
||||
// if iteration is complete
|
||||
// then we must exclude it from
|
||||
// the search and remove it.
|
||||
if (iter.completed) {
|
||||
len--;
|
||||
if (iterIdx !== 0) {
|
||||
iterIdx--;
|
||||
}
|
||||
iters.splice(iterIdx, 1);
|
||||
continue;
|
||||
}
|
||||
|
||||
// find the most recent possible choice
|
||||
if (!chosenIter || chosenIter.last.compare(iterTime) > 0) {
|
||||
// that iterator is saved
|
||||
chosenIter = iter;
|
||||
}
|
||||
}
|
||||
|
||||
// the chosen iterator is returned but not mutated
|
||||
// this iterator contains the most recent event.
|
||||
return chosenIter;
|
||||
}
|
||||
}
|
||||
export default RecurExpansion;
|
||||
+1482
File diff suppressed because it is too large
Load Diff
+302
@@ -0,0 +1,302 @@
|
||||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
* Portions Copyright (C) Philipp Kewisch */
|
||||
|
||||
import design from "./design.js";
|
||||
import { foldline } from "./helpers.js";
|
||||
|
||||
/**
|
||||
* This lets typescript resolve our custom types in the
|
||||
* generated d.ts files (jsdoc typedefs are converted to typescript types).
|
||||
* Ignore prevents the typedefs from being documented more than once.
|
||||
*
|
||||
* @ignore
|
||||
* @typedef {import("./types.js").designSet} designSet
|
||||
* Imports the 'designSet' type from the "types.js" module
|
||||
*/
|
||||
|
||||
const LINE_ENDING = '\r\n';
|
||||
const DEFAULT_VALUE_TYPE = 'unknown';
|
||||
const RFC6868_REPLACE_MAP = { '"': "^'", "\n": "^n", "^": "^^" };
|
||||
|
||||
/**
|
||||
* Convert a full jCal/jCard array into a iCalendar/vCard string.
|
||||
*
|
||||
* @function ICAL.stringify
|
||||
* @variation function
|
||||
* @param {Array} jCal The jCal/jCard document
|
||||
* @return {String} The stringified iCalendar/vCard document
|
||||
*/
|
||||
export default function stringify(jCal) {
|
||||
if (typeof jCal[0] == "string") {
|
||||
// This is a single component
|
||||
jCal = [jCal];
|
||||
}
|
||||
|
||||
let i = 0;
|
||||
let len = jCal.length;
|
||||
let result = '';
|
||||
|
||||
for (; i < len; i++) {
|
||||
result += stringify.component(jCal[i]) + LINE_ENDING;
|
||||
}
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts an jCal component array into a ICAL string.
|
||||
* Recursive will resolve sub-components.
|
||||
*
|
||||
* Exact component/property order is not saved all
|
||||
* properties will come before subcomponents.
|
||||
*
|
||||
* @function ICAL.stringify.component
|
||||
* @param {Array} component
|
||||
* jCal/jCard fragment of a component
|
||||
* @param {designSet} designSet
|
||||
* The design data to use for this component
|
||||
* @return {String} The iCalendar/vCard string
|
||||
*/
|
||||
stringify.component = function(component, designSet) {
|
||||
let name = component[0].toUpperCase();
|
||||
let result = 'BEGIN:' + name + LINE_ENDING;
|
||||
|
||||
let props = component[1];
|
||||
let propIdx = 0;
|
||||
let propLen = props.length;
|
||||
|
||||
let designSetName = component[0];
|
||||
// rfc6350 requires that in vCard 4.0 the first component is the VERSION
|
||||
// component with as value 4.0, note that 3.0 does not have this requirement.
|
||||
if (designSetName === 'vcard' && component[1].length > 0 &&
|
||||
!(component[1][0][0] === "version" && component[1][0][3] === "4.0")) {
|
||||
designSetName = "vcard3";
|
||||
}
|
||||
designSet = designSet || design.getDesignSet(designSetName);
|
||||
|
||||
for (; propIdx < propLen; propIdx++) {
|
||||
result += stringify.property(props[propIdx], designSet) + LINE_ENDING;
|
||||
}
|
||||
|
||||
// Ignore subcomponents if none exist, e.g. in vCard.
|
||||
let comps = component[2] || [];
|
||||
let compIdx = 0;
|
||||
let compLen = comps.length;
|
||||
|
||||
for (; compIdx < compLen; compIdx++) {
|
||||
result += stringify.component(comps[compIdx], designSet) + LINE_ENDING;
|
||||
}
|
||||
|
||||
result += 'END:' + name;
|
||||
return result;
|
||||
};
|
||||
|
||||
/**
|
||||
* Converts a single jCal/jCard property to a iCalendar/vCard string.
|
||||
*
|
||||
* @function ICAL.stringify.property
|
||||
* @param {Array} property
|
||||
* jCal/jCard property array
|
||||
* @param {designSet} designSet
|
||||
* The design data to use for this property
|
||||
* @param {Boolean} noFold
|
||||
* If true, the line is not folded
|
||||
* @return {String} The iCalendar/vCard string
|
||||
*/
|
||||
stringify.property = function(property, designSet, noFold) {
|
||||
let name = property[0].toUpperCase();
|
||||
let jsName = property[0];
|
||||
let params = property[1];
|
||||
|
||||
if (!designSet) {
|
||||
designSet = design.defaultSet;
|
||||
}
|
||||
|
||||
let groupName = params.group;
|
||||
let line;
|
||||
if (designSet.propertyGroups && groupName) {
|
||||
line = groupName.toUpperCase() + "." + name;
|
||||
} else {
|
||||
line = name;
|
||||
}
|
||||
|
||||
for (let [paramName, value] of Object.entries(params)) {
|
||||
if (designSet.propertyGroups && paramName == 'group') {
|
||||
continue;
|
||||
}
|
||||
|
||||
let paramDesign = designSet.param[paramName];
|
||||
let multiValue = paramDesign && paramDesign.multiValue;
|
||||
if (multiValue && Array.isArray(value)) {
|
||||
value = value.map(function(val) {
|
||||
val = stringify._rfc6868Unescape(val);
|
||||
val = stringify.paramPropertyValue(val, paramDesign.multiValueSeparateDQuote);
|
||||
return val;
|
||||
});
|
||||
value = stringify.multiValue(value, multiValue, "unknown", null, designSet);
|
||||
} else {
|
||||
value = stringify._rfc6868Unescape(value);
|
||||
value = stringify.paramPropertyValue(value);
|
||||
}
|
||||
|
||||
line += ';' + paramName.toUpperCase() + '=' + value;
|
||||
}
|
||||
|
||||
if (property.length === 3) {
|
||||
// If there are no values, we must assume a blank value
|
||||
return line + ':';
|
||||
}
|
||||
|
||||
let valueType = property[2];
|
||||
|
||||
let propDetails;
|
||||
let multiValue = false;
|
||||
let structuredValue = false;
|
||||
let isDefault = false;
|
||||
|
||||
if (jsName in designSet.property) {
|
||||
propDetails = designSet.property[jsName];
|
||||
|
||||
if ('multiValue' in propDetails) {
|
||||
multiValue = propDetails.multiValue;
|
||||
}
|
||||
|
||||
if (('structuredValue' in propDetails) && Array.isArray(property[3])) {
|
||||
structuredValue = propDetails.structuredValue;
|
||||
}
|
||||
|
||||
if ('defaultType' in propDetails) {
|
||||
if (valueType === propDetails.defaultType) {
|
||||
isDefault = true;
|
||||
}
|
||||
} else {
|
||||
if (valueType === DEFAULT_VALUE_TYPE) {
|
||||
isDefault = true;
|
||||
}
|
||||
}
|
||||
} else {
|
||||
if (valueType === DEFAULT_VALUE_TYPE) {
|
||||
isDefault = true;
|
||||
}
|
||||
}
|
||||
|
||||
// push the VALUE property if type is not the default
|
||||
// for the current property.
|
||||
if (!isDefault) {
|
||||
// value will never contain ;/:/, so we don't escape it here.
|
||||
line += ';VALUE=' + valueType.toUpperCase();
|
||||
}
|
||||
|
||||
line += ':';
|
||||
|
||||
if (multiValue && structuredValue) {
|
||||
line += stringify.multiValue(
|
||||
property[3], structuredValue, valueType, multiValue, designSet, structuredValue
|
||||
);
|
||||
} else if (multiValue) {
|
||||
line += stringify.multiValue(
|
||||
property.slice(3), multiValue, valueType, null, designSet, false
|
||||
);
|
||||
} else if (structuredValue) {
|
||||
line += stringify.multiValue(
|
||||
property[3], structuredValue, valueType, null, designSet, structuredValue
|
||||
);
|
||||
} else {
|
||||
line += stringify.value(property[3], valueType, designSet, false);
|
||||
}
|
||||
|
||||
return noFold ? line : foldline(line);
|
||||
};
|
||||
|
||||
/**
|
||||
* Handles escaping of property values that may contain:
|
||||
*
|
||||
* COLON (:), SEMICOLON (;), or COMMA (,)
|
||||
*
|
||||
* If any of the above are present the result is wrapped
|
||||
* in double quotes.
|
||||
*
|
||||
* @function ICAL.stringify.paramPropertyValue
|
||||
* @param {String} value Raw property value
|
||||
* @param {boolean} force If value should be escaped even when unnecessary
|
||||
* @return {String} Given or escaped value when needed
|
||||
*/
|
||||
stringify.paramPropertyValue = function(value, force) {
|
||||
if (!force &&
|
||||
(value.indexOf(',') === -1) &&
|
||||
(value.indexOf(':') === -1) &&
|
||||
(value.indexOf(';') === -1)) {
|
||||
|
||||
return value;
|
||||
}
|
||||
|
||||
return '"' + value + '"';
|
||||
};
|
||||
|
||||
/**
|
||||
* Converts an array of ical values into a single
|
||||
* string based on a type and a delimiter value (like ",").
|
||||
*
|
||||
* @function ICAL.stringify.multiValue
|
||||
* @param {Array} values List of values to convert
|
||||
* @param {String} delim Used to join the values (",", ";", ":")
|
||||
* @param {String} type Lowecase ical value type
|
||||
* (like boolean, date-time, etc..)
|
||||
* @param {?String} innerMulti If set, each value will again be processed
|
||||
* Used for structured values
|
||||
* @param {designSet} designSet
|
||||
* The design data to use for this property
|
||||
*
|
||||
* @return {String} iCalendar/vCard string for value
|
||||
*/
|
||||
stringify.multiValue = function(values, delim, type, innerMulti, designSet, structuredValue) {
|
||||
let result = '';
|
||||
let len = values.length;
|
||||
let i = 0;
|
||||
|
||||
for (; i < len; i++) {
|
||||
if (innerMulti && Array.isArray(values[i])) {
|
||||
result += stringify.multiValue(values[i], innerMulti, type, null, designSet, structuredValue);
|
||||
} else {
|
||||
result += stringify.value(values[i], type, designSet, structuredValue);
|
||||
}
|
||||
|
||||
if (i !== (len - 1)) {
|
||||
result += delim;
|
||||
}
|
||||
}
|
||||
|
||||
return result;
|
||||
};
|
||||
|
||||
/**
|
||||
* Processes a single ical value runs the associated "toICAL" method from the
|
||||
* design value type if available to convert the value.
|
||||
*
|
||||
* @function ICAL.stringify.value
|
||||
* @param {String|Number} value A formatted value
|
||||
* @param {String} type Lowercase iCalendar/vCard value type
|
||||
* (like boolean, date-time, etc..)
|
||||
* @return {String} iCalendar/vCard value for single value
|
||||
*/
|
||||
stringify.value = function(value, type, designSet, structuredValue) {
|
||||
if (type in designSet.value && 'toICAL' in designSet.value[type]) {
|
||||
return designSet.value[type].toICAL(value, structuredValue);
|
||||
}
|
||||
return value;
|
||||
};
|
||||
|
||||
/**
|
||||
* Internal helper for rfc6868. Exposing this on ICAL.stringify so that
|
||||
* hackers can disable the rfc6868 parsing if the really need to.
|
||||
*
|
||||
* @param {String} val The value to unescape
|
||||
* @return {String} The escaped value
|
||||
*/
|
||||
stringify._rfc6868Unescape = function(val) {
|
||||
return val.replace(/[\n^"]/g, function(x) {
|
||||
return RFC6868_REPLACE_MAP[x];
|
||||
});
|
||||
};
|
||||
+1405
File diff suppressed because it is too large
Load Diff
+526
@@ -0,0 +1,526 @@
|
||||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
* Portions Copyright (C) Philipp Kewisch */
|
||||
|
||||
import Time from "./time.js";
|
||||
import Component from "./component.js";
|
||||
import ICALParse from "./parse.js";
|
||||
import { clone, binsearchInsert } from "./helpers.js";
|
||||
|
||||
const OPTIONS = ["tzid", "location", "tznames", "latitude", "longitude"];
|
||||
|
||||
/**
|
||||
* Timezone representation.
|
||||
*
|
||||
* @example
|
||||
* var vcalendar;
|
||||
* var timezoneComp = vcalendar.getFirstSubcomponent('vtimezone');
|
||||
* var tzid = timezoneComp.getFirstPropertyValue('tzid');
|
||||
*
|
||||
* var timezone = new ICAL.Timezone({
|
||||
* component: timezoneComp,
|
||||
* tzid
|
||||
* });
|
||||
*
|
||||
* @memberof ICAL
|
||||
*/
|
||||
class Timezone {
|
||||
static _compare_change_fn(a, b) {
|
||||
if (a.year < b.year) return -1;
|
||||
else if (a.year > b.year) return 1;
|
||||
|
||||
if (a.month < b.month) return -1;
|
||||
else if (a.month > b.month) return 1;
|
||||
|
||||
if (a.day < b.day) return -1;
|
||||
else if (a.day > b.day) return 1;
|
||||
|
||||
if (a.hour < b.hour) return -1;
|
||||
else if (a.hour > b.hour) return 1;
|
||||
|
||||
if (a.minute < b.minute) return -1;
|
||||
else if (a.minute > b.minute) return 1;
|
||||
|
||||
if (a.second < b.second) return -1;
|
||||
else if (a.second > b.second) return 1;
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert the date/time from one zone to the next.
|
||||
*
|
||||
* @param {Time} tt The time to convert
|
||||
* @param {Timezone} from_zone The source zone to convert from
|
||||
* @param {Timezone} to_zone The target zone to convert to
|
||||
* @return {Time} The converted date/time object
|
||||
*/
|
||||
static convert_time(tt, from_zone, to_zone) {
|
||||
if (tt.isDate ||
|
||||
from_zone.tzid == to_zone.tzid ||
|
||||
from_zone == Timezone.localTimezone ||
|
||||
to_zone == Timezone.localTimezone) {
|
||||
tt.zone = to_zone;
|
||||
return tt;
|
||||
}
|
||||
|
||||
let utcOffset = from_zone.utcOffset(tt);
|
||||
tt.adjust(0, 0, 0, - utcOffset);
|
||||
|
||||
utcOffset = to_zone.utcOffset(tt);
|
||||
tt.adjust(0, 0, 0, utcOffset);
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new ICAL.Timezone instance from the passed data object.
|
||||
*
|
||||
* @param {Component|Object} aData options for class
|
||||
* @param {String|Component} aData.component
|
||||
* If aData is a simple object, then this member can be set to either a
|
||||
* string containing the component data, or an already parsed
|
||||
* ICAL.Component
|
||||
* @param {String} aData.tzid The timezone identifier
|
||||
* @param {String} aData.location The timezone locationw
|
||||
* @param {String} aData.tznames An alternative string representation of the
|
||||
* timezone
|
||||
* @param {Number} aData.latitude The latitude of the timezone
|
||||
* @param {Number} aData.longitude The longitude of the timezone
|
||||
*/
|
||||
static fromData(aData) {
|
||||
let tt = new Timezone();
|
||||
return tt.fromData(aData);
|
||||
}
|
||||
|
||||
/**
|
||||
* The instance describing the UTC timezone
|
||||
* @type {Timezone}
|
||||
* @constant
|
||||
* @instance
|
||||
*/
|
||||
static #utcTimezone = null;
|
||||
static get utcTimezone() {
|
||||
if (!this.#utcTimezone) {
|
||||
this.#utcTimezone = Timezone.fromData({
|
||||
tzid: "UTC"
|
||||
});
|
||||
}
|
||||
return this.#utcTimezone;
|
||||
}
|
||||
|
||||
/**
|
||||
* The instance describing the local timezone
|
||||
* @type {Timezone}
|
||||
* @constant
|
||||
* @instance
|
||||
*/
|
||||
static #localTimezone = null;
|
||||
static get localTimezone() {
|
||||
if (!this.#localTimezone) {
|
||||
this.#localTimezone = Timezone.fromData({
|
||||
tzid: "floating"
|
||||
});
|
||||
}
|
||||
return this.#localTimezone;
|
||||
}
|
||||
|
||||
/**
|
||||
* Adjust a timezone change object.
|
||||
* @private
|
||||
* @param {Object} change The timezone change object
|
||||
* @param {Number} days The extra amount of days
|
||||
* @param {Number} hours The extra amount of hours
|
||||
* @param {Number} minutes The extra amount of minutes
|
||||
* @param {Number} seconds The extra amount of seconds
|
||||
*/
|
||||
static adjust_change(change, days, hours, minutes, seconds) {
|
||||
return Time.prototype.adjust.call(
|
||||
change,
|
||||
days,
|
||||
hours,
|
||||
minutes,
|
||||
seconds,
|
||||
change
|
||||
);
|
||||
}
|
||||
|
||||
static _minimumExpansionYear = -1;
|
||||
static EXTRA_COVERAGE = 5;
|
||||
|
||||
/**
|
||||
* Creates a new ICAL.Timezone instance, by passing in a tzid and component.
|
||||
*
|
||||
* @param {Component|Object} data options for class
|
||||
* @param {String|Component} data.component
|
||||
* If data is a simple object, then this member can be set to either a
|
||||
* string containing the component data, or an already parsed
|
||||
* ICAL.Component
|
||||
* @param {String} data.tzid The timezone identifier
|
||||
* @param {String} data.location The timezone locationw
|
||||
* @param {String} data.tznames An alternative string representation of the
|
||||
* timezone
|
||||
* @param {Number} data.latitude The latitude of the timezone
|
||||
* @param {Number} data.longitude The longitude of the timezone
|
||||
*/
|
||||
constructor(data) {
|
||||
this.wrappedJSObject = this;
|
||||
this.fromData(data);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Timezone identifier
|
||||
* @type {String}
|
||||
*/
|
||||
tzid = "";
|
||||
|
||||
/**
|
||||
* Timezone location
|
||||
* @type {String}
|
||||
*/
|
||||
location = "";
|
||||
|
||||
/**
|
||||
* Alternative timezone name, for the string representation
|
||||
* @type {String}
|
||||
*/
|
||||
tznames = "";
|
||||
|
||||
/**
|
||||
* The primary latitude for the timezone.
|
||||
* @type {Number}
|
||||
*/
|
||||
latitude = 0.0;
|
||||
|
||||
/**
|
||||
* The primary longitude for the timezone.
|
||||
* @type {Number}
|
||||
*/
|
||||
longitude = 0.0;
|
||||
|
||||
/**
|
||||
* The vtimezone component for this timezone.
|
||||
* @type {Component}
|
||||
*/
|
||||
component = null;
|
||||
|
||||
/**
|
||||
* The year this timezone has been expanded to. All timezone transition
|
||||
* dates until this year are known and can be used for calculation
|
||||
*
|
||||
* @private
|
||||
* @type {Number}
|
||||
*/
|
||||
expandedUntilYear = 0;
|
||||
|
||||
/**
|
||||
* The class identifier.
|
||||
* @constant
|
||||
* @type {String}
|
||||
* @default "icaltimezone"
|
||||
*/
|
||||
icalclass = "icaltimezone";
|
||||
|
||||
/**
|
||||
* Sets up the current instance using members from the passed data object.
|
||||
*
|
||||
* @param {Component|Object} aData options for class
|
||||
* @param {String|Component} aData.component
|
||||
* If aData is a simple object, then this member can be set to either a
|
||||
* string containing the component data, or an already parsed
|
||||
* ICAL.Component
|
||||
* @param {String} aData.tzid The timezone identifier
|
||||
* @param {String} aData.location The timezone locationw
|
||||
* @param {String} aData.tznames An alternative string representation of the
|
||||
* timezone
|
||||
* @param {Number} aData.latitude The latitude of the timezone
|
||||
* @param {Number} aData.longitude The longitude of the timezone
|
||||
*/
|
||||
fromData(aData) {
|
||||
this.expandedUntilYear = 0;
|
||||
this.changes = [];
|
||||
|
||||
if (aData instanceof Component) {
|
||||
// Either a component is passed directly
|
||||
this.component = aData;
|
||||
} else {
|
||||
// Otherwise the component may be in the data object
|
||||
if (aData && "component" in aData) {
|
||||
if (typeof aData.component == "string") {
|
||||
// If a string was passed, parse it as a component
|
||||
let jCal = ICALParse(aData.component);
|
||||
this.component = new Component(jCal);
|
||||
} else if (aData.component instanceof Component) {
|
||||
// If it was a component already, then just set it
|
||||
this.component = aData.component;
|
||||
} else {
|
||||
// Otherwise just null out the component
|
||||
this.component = null;
|
||||
}
|
||||
}
|
||||
|
||||
// Copy remaining passed properties
|
||||
for (let prop of OPTIONS) {
|
||||
if (aData && prop in aData) {
|
||||
this[prop] = aData[prop];
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// If we have a component but no TZID, attempt to get it from the
|
||||
// component's properties.
|
||||
if (this.component instanceof Component && !this.tzid) {
|
||||
this.tzid = this.component.getFirstPropertyValue('tzid');
|
||||
}
|
||||
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Finds the utcOffset the given time would occur in this timezone.
|
||||
*
|
||||
* @param {Time} tt The time to check for
|
||||
* @return {Number} utc offset in seconds
|
||||
*/
|
||||
utcOffset(tt) {
|
||||
if (this == Timezone.utcTimezone || this == Timezone.localTimezone) {
|
||||
return 0;
|
||||
}
|
||||
|
||||
this._ensureCoverage(tt.year);
|
||||
|
||||
if (!this.changes.length) {
|
||||
return 0;
|
||||
}
|
||||
|
||||
let tt_change = {
|
||||
year: tt.year,
|
||||
month: tt.month,
|
||||
day: tt.day,
|
||||
hour: tt.hour,
|
||||
minute: tt.minute,
|
||||
second: tt.second
|
||||
};
|
||||
|
||||
let change_num = this._findNearbyChange(tt_change);
|
||||
let change_num_to_use = -1;
|
||||
let step = 1;
|
||||
|
||||
// TODO: replace with bin search?
|
||||
for (;;) {
|
||||
let change = clone(this.changes[change_num], true);
|
||||
if (change.utcOffset < change.prevUtcOffset) {
|
||||
Timezone.adjust_change(change, 0, 0, 0, change.utcOffset);
|
||||
} else {
|
||||
Timezone.adjust_change(change, 0, 0, 0,
|
||||
change.prevUtcOffset);
|
||||
}
|
||||
|
||||
let cmp = Timezone._compare_change_fn(tt_change, change);
|
||||
|
||||
if (cmp >= 0) {
|
||||
change_num_to_use = change_num;
|
||||
} else {
|
||||
step = -1;
|
||||
}
|
||||
|
||||
if (step == -1 && change_num_to_use != -1) {
|
||||
break;
|
||||
}
|
||||
|
||||
change_num += step;
|
||||
|
||||
if (change_num < 0) {
|
||||
return 0;
|
||||
}
|
||||
|
||||
if (change_num >= this.changes.length) {
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
let zone_change = this.changes[change_num_to_use];
|
||||
let utcOffset_change = zone_change.utcOffset - zone_change.prevUtcOffset;
|
||||
|
||||
if (utcOffset_change < 0 && change_num_to_use > 0) {
|
||||
let tmp_change = clone(zone_change, true);
|
||||
Timezone.adjust_change(tmp_change, 0, 0, 0, tmp_change.prevUtcOffset);
|
||||
|
||||
if (Timezone._compare_change_fn(tt_change, tmp_change) < 0) {
|
||||
let prev_zone_change = this.changes[change_num_to_use - 1];
|
||||
|
||||
let want_daylight = false; // TODO
|
||||
|
||||
if (zone_change.is_daylight != want_daylight &&
|
||||
prev_zone_change.is_daylight == want_daylight) {
|
||||
zone_change = prev_zone_change;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// TODO return is_daylight?
|
||||
return zone_change.utcOffset;
|
||||
}
|
||||
|
||||
_findNearbyChange(change) {
|
||||
// find the closest match
|
||||
let idx = binsearchInsert(
|
||||
this.changes,
|
||||
change,
|
||||
Timezone._compare_change_fn
|
||||
);
|
||||
|
||||
if (idx >= this.changes.length) {
|
||||
return this.changes.length - 1;
|
||||
}
|
||||
|
||||
return idx;
|
||||
}
|
||||
|
||||
_ensureCoverage(aYear) {
|
||||
if (Timezone._minimumExpansionYear == -1) {
|
||||
let today = Time.now();
|
||||
Timezone._minimumExpansionYear = today.year;
|
||||
}
|
||||
|
||||
let changesEndYear = aYear;
|
||||
if (changesEndYear < Timezone._minimumExpansionYear) {
|
||||
changesEndYear = Timezone._minimumExpansionYear;
|
||||
}
|
||||
|
||||
changesEndYear += Timezone.EXTRA_COVERAGE;
|
||||
|
||||
if (!this.changes.length || this.expandedUntilYear < aYear) {
|
||||
let subcomps = this.component.getAllSubcomponents();
|
||||
let compLen = subcomps.length;
|
||||
let compIdx = 0;
|
||||
|
||||
for (; compIdx < compLen; compIdx++) {
|
||||
this._expandComponent(
|
||||
subcomps[compIdx], changesEndYear, this.changes
|
||||
);
|
||||
}
|
||||
|
||||
this.changes.sort(Timezone._compare_change_fn);
|
||||
this.expandedUntilYear = changesEndYear;
|
||||
}
|
||||
}
|
||||
|
||||
_expandComponent(aComponent, aYear, changes) {
|
||||
if (!aComponent.hasProperty("dtstart") ||
|
||||
!aComponent.hasProperty("tzoffsetto") ||
|
||||
!aComponent.hasProperty("tzoffsetfrom")) {
|
||||
return null;
|
||||
}
|
||||
|
||||
let dtstart = aComponent.getFirstProperty("dtstart").getFirstValue();
|
||||
let change;
|
||||
|
||||
function convert_tzoffset(offset) {
|
||||
return offset.factor * (offset.hours * 3600 + offset.minutes * 60);
|
||||
}
|
||||
|
||||
function init_changes() {
|
||||
let changebase = {};
|
||||
changebase.is_daylight = (aComponent.name == "daylight");
|
||||
changebase.utcOffset = convert_tzoffset(
|
||||
aComponent.getFirstProperty("tzoffsetto").getFirstValue()
|
||||
);
|
||||
|
||||
changebase.prevUtcOffset = convert_tzoffset(
|
||||
aComponent.getFirstProperty("tzoffsetfrom").getFirstValue()
|
||||
);
|
||||
|
||||
return changebase;
|
||||
}
|
||||
|
||||
if (!aComponent.hasProperty("rrule") && !aComponent.hasProperty("rdate")) {
|
||||
change = init_changes();
|
||||
change.year = dtstart.year;
|
||||
change.month = dtstart.month;
|
||||
change.day = dtstart.day;
|
||||
change.hour = dtstart.hour;
|
||||
change.minute = dtstart.minute;
|
||||
change.second = dtstart.second;
|
||||
|
||||
Timezone.adjust_change(change, 0, 0, 0, -change.prevUtcOffset);
|
||||
changes.push(change);
|
||||
} else {
|
||||
let props = aComponent.getAllProperties("rdate");
|
||||
for (let rdate of props) {
|
||||
let time = rdate.getFirstValue();
|
||||
change = init_changes();
|
||||
|
||||
change.year = time.year;
|
||||
change.month = time.month;
|
||||
change.day = time.day;
|
||||
|
||||
if (time.isDate) {
|
||||
change.hour = dtstart.hour;
|
||||
change.minute = dtstart.minute;
|
||||
change.second = dtstart.second;
|
||||
|
||||
if (dtstart.zone != Timezone.utcTimezone) {
|
||||
Timezone.adjust_change(change, 0, 0, 0, -change.prevUtcOffset);
|
||||
}
|
||||
} else {
|
||||
change.hour = time.hour;
|
||||
change.minute = time.minute;
|
||||
change.second = time.second;
|
||||
|
||||
if (time.zone != Timezone.utcTimezone) {
|
||||
Timezone.adjust_change(change, 0, 0, 0, -change.prevUtcOffset);
|
||||
}
|
||||
}
|
||||
|
||||
changes.push(change);
|
||||
}
|
||||
|
||||
let rrule = aComponent.getFirstProperty("rrule");
|
||||
|
||||
if (rrule) {
|
||||
rrule = rrule.getFirstValue();
|
||||
change = init_changes();
|
||||
|
||||
if (rrule.until && rrule.until.zone == Timezone.utcTimezone) {
|
||||
rrule.until.adjust(0, 0, 0, change.prevUtcOffset);
|
||||
rrule.until.zone = Timezone.localTimezone;
|
||||
}
|
||||
|
||||
let iterator = rrule.iterator(dtstart);
|
||||
|
||||
let occ;
|
||||
while ((occ = iterator.next())) {
|
||||
change = init_changes();
|
||||
if (occ.year > aYear || !occ) {
|
||||
break;
|
||||
}
|
||||
|
||||
change.year = occ.year;
|
||||
change.month = occ.month;
|
||||
change.day = occ.day;
|
||||
change.hour = occ.hour;
|
||||
change.minute = occ.minute;
|
||||
change.second = occ.second;
|
||||
change.isDate = occ.isDate;
|
||||
|
||||
Timezone.adjust_change(change, 0, 0, 0, -change.prevUtcOffset);
|
||||
changes.push(change);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return changes;
|
||||
}
|
||||
|
||||
/**
|
||||
* The string representation of this timezone.
|
||||
* @return {String}
|
||||
*/
|
||||
toString() {
|
||||
return (this.tznames ? this.tznames : this.tzid);
|
||||
}
|
||||
}
|
||||
export default Timezone;
|
||||
+129
@@ -0,0 +1,129 @@
|
||||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
* Portions Copyright (C) Philipp Kewisch */
|
||||
|
||||
import Timezone from "./timezone.js";
|
||||
// needed for typescript type resolution
|
||||
// eslint-disable-next-line no-unused-vars
|
||||
import Component from "./component.js";
|
||||
|
||||
let zones = null;
|
||||
|
||||
/**
|
||||
* @classdesc
|
||||
* Singleton class to contain timezones. Right now it is all manual registry in
|
||||
* the future we may use this class to download timezone information or handle
|
||||
* loading pre-expanded timezones.
|
||||
*
|
||||
* @exports module:ICAL.TimezoneService
|
||||
* @memberof ICAL
|
||||
*/
|
||||
const TimezoneService = {
|
||||
get count() {
|
||||
if (zones === null) {
|
||||
return 0;
|
||||
}
|
||||
|
||||
return Object.keys(zones).length;
|
||||
},
|
||||
|
||||
reset: function() {
|
||||
zones = Object.create(null);
|
||||
let utc = Timezone.utcTimezone;
|
||||
|
||||
zones.Z = utc;
|
||||
zones.UTC = utc;
|
||||
zones.GMT = utc;
|
||||
},
|
||||
_hard_reset: function() {
|
||||
zones = null;
|
||||
},
|
||||
|
||||
/**
|
||||
* Checks if timezone id has been registered.
|
||||
*
|
||||
* @param {String} tzid Timezone identifier (e.g. America/Los_Angeles)
|
||||
* @return {Boolean} False, when not present
|
||||
*/
|
||||
has: function(tzid) {
|
||||
if (zones === null) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return !!zones[tzid];
|
||||
},
|
||||
|
||||
/**
|
||||
* Returns a timezone by its tzid if present.
|
||||
*
|
||||
* @param {String} tzid Timezone identifier (e.g. America/Los_Angeles)
|
||||
* @return {Timezone | undefined} The timezone, or undefined if not found
|
||||
*/
|
||||
get: function(tzid) {
|
||||
if (zones === null) {
|
||||
this.reset();
|
||||
}
|
||||
|
||||
return zones[tzid];
|
||||
},
|
||||
|
||||
/**
|
||||
* Registers a timezone object or component.
|
||||
*
|
||||
* @param {Component|Timezone} timezone
|
||||
* The initialized zone or vtimezone.
|
||||
*
|
||||
* @param {String=} name
|
||||
* The name of the timezone. Defaults to the component's TZID if not
|
||||
* passed.
|
||||
*/
|
||||
register: function(timezone, name) {
|
||||
if (zones === null) {
|
||||
this.reset();
|
||||
}
|
||||
|
||||
// This avoids a breaking change by the change of argument order
|
||||
// TODO remove in v3
|
||||
if (typeof timezone === "string" && name instanceof Timezone) {
|
||||
[timezone, name] = [name, timezone];
|
||||
}
|
||||
|
||||
if (!name) {
|
||||
if (timezone instanceof Timezone) {
|
||||
name = timezone.tzid;
|
||||
} else {
|
||||
if (timezone.name === 'vtimezone') {
|
||||
timezone = new Timezone(timezone);
|
||||
name = timezone.tzid;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (!name) {
|
||||
throw new TypeError("Neither a timezone nor a name was passed");
|
||||
}
|
||||
|
||||
if (timezone instanceof Timezone) {
|
||||
zones[name] = timezone;
|
||||
} else {
|
||||
throw new TypeError('timezone must be ICAL.Timezone or ICAL.Component');
|
||||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* Removes a timezone by its tzid from the list.
|
||||
*
|
||||
* @param {String} tzid Timezone identifier (e.g. America/Los_Angeles)
|
||||
* @return {?Timezone} The removed timezone, or null if not registered
|
||||
*/
|
||||
remove: function(tzid) {
|
||||
if (zones === null) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return (delete zones[tzid]);
|
||||
}
|
||||
};
|
||||
|
||||
export default TimezoneService;
|
||||
+109
@@ -0,0 +1,109 @@
|
||||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
* Portions Copyright (C) Philipp Kewisch, 2024 */
|
||||
|
||||
// TODO: Once https://github.com/microsoft/TypeScript/issues/22160 and
|
||||
// https://github.com/microsoft/TypeScript/issues/46011 is fixed, update
|
||||
// @typedef(import(...)) to @import to avoid re-exporting the typedefs
|
||||
|
||||
/* eslint-disable no-unused-vars */
|
||||
// needed for typescript type resolution
|
||||
import Component from "./component";
|
||||
import Event from "./event";
|
||||
import Time from "./time";
|
||||
import Timezone from "./timezone";
|
||||
|
||||
/**
|
||||
* The weekday, 1 = SUNDAY, 7 = SATURDAY. Access via
|
||||
* ICAL.Time.MONDAY, ICAL.Time.TUESDAY, ...
|
||||
*
|
||||
* @typedef {Number} weekDay
|
||||
* @memberof ICAL.Time
|
||||
*/
|
||||
|
||||
/**
|
||||
* @typedef {Object} timeInit Time initialization
|
||||
* @property {Number=} year The year for this date
|
||||
* @property {Number=} month The month for this date
|
||||
* @property {Number=} day The day for this date
|
||||
* @property {Number=} hour The hour for this date
|
||||
* @property {Number=} minute The minute for this date
|
||||
* @property {Number=} second The second for this date
|
||||
* @property {Boolean=} isDate If true, the instance represents a date
|
||||
* (as opposed to a date-time)
|
||||
* @property {String=} timezone Timezone id if zone is unknown [internal]
|
||||
* @property {Timezone=} zone Resolved timezone object [internal]
|
||||
* @memberof ICAL.Time
|
||||
*/
|
||||
|
||||
/**
|
||||
* Possible frequency values for the FREQ part
|
||||
* (YEARLY, MONTHLY, WEEKLY, DAILY, HOURLY, MINUTELY, SECONDLY)
|
||||
*
|
||||
* @typedef {String} frequencyValues
|
||||
* @memberof ICAL.Recur
|
||||
*/
|
||||
|
||||
/**
|
||||
* This object is returned by {@link ICAL.Event#getOccurrenceDetails getOccurrenceDetails}
|
||||
* @memberof ICAL.Event
|
||||
* @typedef {Object} occurrenceDetails
|
||||
* @property {Time} recurrenceId The passed in recurrence id
|
||||
* @property {Event} item The occurrence
|
||||
* @property {Time} startDate The start of the occurrence
|
||||
* @property {Time} endDate The end of the occurrence
|
||||
*/
|
||||
|
||||
/**
|
||||
* The state for parsing content lines from an iCalendar/vCard string.
|
||||
*
|
||||
* @private
|
||||
* @memberof ICAL.parse
|
||||
* @typedef {Object} parserState
|
||||
* @property {designSet} designSet The design set to use for parsing
|
||||
* @property {Component[]} stack The stack of components being processed
|
||||
* @property {Component} component The currently active component
|
||||
*/
|
||||
|
||||
/**
|
||||
* A jCal component.
|
||||
*
|
||||
* TODO: Properly typedef this when https://github.com/hegemonic/catharsis/pull/70
|
||||
* is merged. Documentation is ignored until this can be documented properly.
|
||||
*
|
||||
* @example
|
||||
* ["vevent", [...properties here...], [...components here...] ]
|
||||
*
|
||||
* @ignore
|
||||
* @typedef {Array} jCalComponent
|
||||
* @property {String} 0 The component name
|
||||
* @property {jCalProperty[]} 1 The properties of this component
|
||||
* @property {jCalComponent[]} 2 The subcomponents of this component
|
||||
*/
|
||||
|
||||
/**
|
||||
* A designSet describes value, parameter and property data. It is used by
|
||||
* ther parser and stringifier in components and properties to determine they
|
||||
* should be represented.
|
||||
*
|
||||
* @memberof ICAL.design
|
||||
* @typedef {Object} designSet
|
||||
* @property {Object} value Definitions for value types, keys are type names
|
||||
* @property {Object} param Definitions for params, keys are param names
|
||||
* @property {Object} property Definitions for properties, keys are property names
|
||||
* @property {boolean} propertyGroups If content lines may include a group name
|
||||
*/
|
||||
|
||||
/**
|
||||
* The jCal Geo type. This is a tuple representing a geographical location.
|
||||
* The first element is the Latitude and the second element is the Longitude.
|
||||
*
|
||||
* TODO: Properly typedef this when https://github.com/hegemonic/catharsis/pull/70
|
||||
*
|
||||
* @typedef {Array} Geo
|
||||
* @property {Number} 0 Latitude
|
||||
* @property {Number} 1 Longitude
|
||||
*/
|
||||
|
||||
export const _ = {};
|
||||
+187
@@ -0,0 +1,187 @@
|
||||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
* Portions Copyright (C) Philipp Kewisch */
|
||||
|
||||
import { strictParseInt, trunc, pad2 } from "./helpers.js";
|
||||
// needed for typescript type resolution
|
||||
// eslint-disable-next-line no-unused-vars
|
||||
import Duration from "./duration.js";
|
||||
import design from "./design.js";
|
||||
|
||||
/**
|
||||
* This class represents the "utc-offset" value type, with various calculation and manipulation
|
||||
* methods.
|
||||
*
|
||||
* @memberof ICAL
|
||||
*/
|
||||
class UtcOffset {
|
||||
/**
|
||||
* Creates a new {@link ICAL.UtcOffset} instance from the passed string.
|
||||
*
|
||||
* @param {String} aString The string to parse
|
||||
* @return {Duration} The created utc-offset instance
|
||||
*/
|
||||
static fromString(aString) {
|
||||
// -05:00
|
||||
let options = {};
|
||||
//TODO: support seconds per rfc5545 ?
|
||||
options.factor = (aString[0] === '+') ? 1 : -1;
|
||||
options.hours = strictParseInt(aString.slice(1, 3));
|
||||
options.minutes = strictParseInt(aString.slice(4, 6));
|
||||
|
||||
return new UtcOffset(options);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new {@link ICAL.UtcOffset} instance from the passed seconds
|
||||
* value.
|
||||
*
|
||||
* @param {Number} aSeconds The number of seconds to convert
|
||||
*/
|
||||
static fromSeconds(aSeconds) {
|
||||
let instance = new UtcOffset();
|
||||
instance.fromSeconds(aSeconds);
|
||||
return instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new ICAL.UtcOffset instance.
|
||||
*
|
||||
* @param {Object} aData An object with members of the utc offset
|
||||
* @param {Number=} aData.hours The hours for the utc offset
|
||||
* @param {Number=} aData.minutes The minutes in the utc offset
|
||||
* @param {Number=} aData.factor The factor for the utc-offset, either -1 or 1
|
||||
*/
|
||||
constructor(aData) {
|
||||
this.fromData(aData);
|
||||
}
|
||||
|
||||
/**
|
||||
* The hours in the utc-offset
|
||||
* @type {Number}
|
||||
*/
|
||||
hours = 0;
|
||||
|
||||
/**
|
||||
* The minutes in the utc-offset
|
||||
* @type {Number}
|
||||
*/
|
||||
minutes = 0;
|
||||
|
||||
/**
|
||||
* The sign of the utc offset, 1 for positive offset, -1 for negative
|
||||
* offsets.
|
||||
* @type {Number}
|
||||
*/
|
||||
factor = 1;
|
||||
|
||||
/**
|
||||
* The type name, to be used in the jCal object.
|
||||
* @constant
|
||||
* @type {String}
|
||||
* @default "utc-offset"
|
||||
*/
|
||||
icaltype = "utc-offset";
|
||||
|
||||
/**
|
||||
* Returns a clone of the utc offset object.
|
||||
*
|
||||
* @return {UtcOffset} The cloned object
|
||||
*/
|
||||
clone() {
|
||||
return UtcOffset.fromSeconds(this.toSeconds());
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets up the current instance using members from the passed data object.
|
||||
*
|
||||
* @param {Object} aData An object with members of the utc offset
|
||||
* @param {Number=} aData.hours The hours for the utc offset
|
||||
* @param {Number=} aData.minutes The minutes in the utc offset
|
||||
* @param {Number=} aData.factor The factor for the utc-offset, either -1 or 1
|
||||
*/
|
||||
fromData(aData) {
|
||||
if (aData) {
|
||||
for (let [key, value] of Object.entries(aData)) {
|
||||
this[key] = value;
|
||||
}
|
||||
}
|
||||
this._normalize();
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets up the current instance from the given seconds value. The seconds
|
||||
* value is truncated to the minute. Offsets are wrapped when the world
|
||||
* ends, the hour after UTC+14:00 is UTC-12:00.
|
||||
*
|
||||
* @param {Number} aSeconds The seconds to convert into an offset
|
||||
*/
|
||||
fromSeconds(aSeconds) {
|
||||
let secs = Math.abs(aSeconds);
|
||||
|
||||
this.factor = aSeconds < 0 ? -1 : 1;
|
||||
this.hours = trunc(secs / 3600);
|
||||
|
||||
secs -= (this.hours * 3600);
|
||||
this.minutes = trunc(secs / 60);
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert the current offset to a value in seconds
|
||||
*
|
||||
* @return {Number} The offset in seconds
|
||||
*/
|
||||
toSeconds() {
|
||||
return this.factor * (60 * this.minutes + 3600 * this.hours);
|
||||
}
|
||||
|
||||
/**
|
||||
* Compare this utc offset with another one.
|
||||
*
|
||||
* @param {UtcOffset} other The other offset to compare with
|
||||
* @return {Number} -1, 0 or 1 for less/equal/greater
|
||||
*/
|
||||
compare(other) {
|
||||
let a = this.toSeconds();
|
||||
let b = other.toSeconds();
|
||||
return (a > b) - (b > a);
|
||||
}
|
||||
|
||||
_normalize() {
|
||||
// Range: 97200 seconds (with 1 hour inbetween)
|
||||
let secs = this.toSeconds();
|
||||
let factor = this.factor;
|
||||
while (secs < -43200) { // = UTC-12:00
|
||||
secs += 97200;
|
||||
}
|
||||
while (secs > 50400) { // = UTC+14:00
|
||||
secs -= 97200;
|
||||
}
|
||||
|
||||
this.fromSeconds(secs);
|
||||
|
||||
// Avoid changing the factor when on zero seconds
|
||||
if (secs == 0) {
|
||||
this.factor = factor;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* The iCalendar string representation of this utc-offset.
|
||||
* @return {String}
|
||||
*/
|
||||
toICALString() {
|
||||
return design.icalendar.value['utc-offset'].toICAL(this.toString());
|
||||
}
|
||||
|
||||
/**
|
||||
* The string representation of this utc-offset.
|
||||
* @return {String}
|
||||
*/
|
||||
toString() {
|
||||
return (this.factor == 1 ? "+" : "-") + pad2(this.hours) + ':' + pad2(this.minutes);
|
||||
}
|
||||
}
|
||||
export default UtcOffset;
|
||||
+183
@@ -0,0 +1,183 @@
|
||||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
* Portions Copyright (C) Philipp Kewisch */
|
||||
|
||||
import UtcOffset from "./utc_offset.js";
|
||||
import Time from "./time.js";
|
||||
import Timezone from "./timezone.js";
|
||||
import design from "./design.js";
|
||||
import { pad2, strictParseInt } from "./helpers.js";
|
||||
|
||||
/**
|
||||
* Describes a vCard time, which has slight differences to the ICAL.Time.
|
||||
* Properties can be null if not specified, for example for dates with
|
||||
* reduced accuracy or truncation.
|
||||
*
|
||||
* Note that currently not all methods are correctly re-implemented for
|
||||
* VCardTime. For example, comparison will have undefined results when some
|
||||
* members are null.
|
||||
*
|
||||
* Also, normalization is not yet implemented for this class!
|
||||
*
|
||||
* @memberof ICAL
|
||||
* @extends {Time}
|
||||
*/
|
||||
class VCardTime extends Time {
|
||||
/**
|
||||
* Returns a new ICAL.VCardTime instance from a date and/or time string.
|
||||
*
|
||||
* @param {String} aValue The string to create from
|
||||
* @param {String} aIcalType The type for this instance, e.g. date-and-or-time
|
||||
* @return {VCardTime} The date/time instance
|
||||
*/
|
||||
static fromDateAndOrTimeString(aValue, aIcalType) {
|
||||
function part(v, s, e) {
|
||||
return v ? strictParseInt(v.slice(s, s + e)) : null;
|
||||
}
|
||||
let parts = aValue.split('T');
|
||||
let dt = parts[0], tmz = parts[1];
|
||||
let splitzone = tmz ? design.vcard.value.time._splitZone(tmz) : [];
|
||||
let zone = splitzone[0], tm = splitzone[1];
|
||||
|
||||
let dtlen = dt ? dt.length : 0;
|
||||
let tmlen = tm ? tm.length : 0;
|
||||
|
||||
let hasDashDate = dt && dt[0] == '-' && dt[1] == '-';
|
||||
let hasDashTime = tm && tm[0] == '-';
|
||||
|
||||
let o = {
|
||||
year: hasDashDate ? null : part(dt, 0, 4),
|
||||
month: hasDashDate && (dtlen == 4 || dtlen == 7) ? part(dt, 2, 2) : dtlen == 7 ? part(dt, 5, 2) : dtlen == 10 ? part(dt, 5, 2) : null,
|
||||
day: dtlen == 5 ? part(dt, 3, 2) : dtlen == 7 && hasDashDate ? part(dt, 5, 2) : dtlen == 10 ? part(dt, 8, 2) : null,
|
||||
|
||||
hour: hasDashTime ? null : part(tm, 0, 2),
|
||||
minute: hasDashTime && tmlen == 3 ? part(tm, 1, 2) : tmlen > 4 ? hasDashTime ? part(tm, 1, 2) : part(tm, 3, 2) : null,
|
||||
second: tmlen == 4 ? part(tm, 2, 2) : tmlen == 6 ? part(tm, 4, 2) : tmlen == 8 ? part(tm, 6, 2) : null
|
||||
};
|
||||
|
||||
if (zone == 'Z') {
|
||||
zone = Timezone.utcTimezone;
|
||||
} else if (zone && zone[3] == ':') {
|
||||
zone = UtcOffset.fromString(zone);
|
||||
} else {
|
||||
zone = null;
|
||||
}
|
||||
|
||||
return new VCardTime(o, zone, aIcalType);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Creates a new ICAL.VCardTime instance.
|
||||
*
|
||||
* @param {Object} data The data for the time instance
|
||||
* @param {Number=} data.year The year for this date
|
||||
* @param {Number=} data.month The month for this date
|
||||
* @param {Number=} data.day The day for this date
|
||||
* @param {Number=} data.hour The hour for this date
|
||||
* @param {Number=} data.minute The minute for this date
|
||||
* @param {Number=} data.second The second for this date
|
||||
* @param {Timezone|UtcOffset} zone The timezone to use
|
||||
* @param {String} icaltype The type for this date/time object
|
||||
*/
|
||||
constructor(data, zone, icaltype) {
|
||||
super(data, zone);
|
||||
this.icaltype = icaltype || "date-and-or-time";
|
||||
}
|
||||
|
||||
/**
|
||||
* The class identifier.
|
||||
* @constant
|
||||
* @type {String}
|
||||
* @default "vcardtime"
|
||||
*/
|
||||
icalclass = "vcardtime";
|
||||
|
||||
/**
|
||||
* The type name, to be used in the jCal object.
|
||||
* @type {String}
|
||||
* @default "date-and-or-time"
|
||||
*/
|
||||
icaltype = "date-and-or-time";
|
||||
|
||||
/**
|
||||
* Returns a clone of the vcard date/time object.
|
||||
*
|
||||
* @return {VCardTime} The cloned object
|
||||
*/
|
||||
clone() {
|
||||
return new VCardTime(this._time, this.zone, this.icaltype);
|
||||
}
|
||||
|
||||
_normalize() {
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritdoc
|
||||
*/
|
||||
utcOffset() {
|
||||
if (this.zone instanceof UtcOffset) {
|
||||
return this.zone.toSeconds();
|
||||
} else {
|
||||
return Time.prototype.utcOffset.apply(this, arguments);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an RFC 6350 compliant representation of this object.
|
||||
*
|
||||
* @return {String} vcard date/time string
|
||||
*/
|
||||
toICALString() {
|
||||
return design.vcard.value[this.icaltype].toICAL(this.toString());
|
||||
}
|
||||
|
||||
/**
|
||||
* The string representation of this date/time, in jCard form
|
||||
* (including : and - separators).
|
||||
* @return {String}
|
||||
*/
|
||||
toString() {
|
||||
let y = this.year, m = this.month, d = this.day;
|
||||
let h = this.hour, mm = this.minute, s = this.second;
|
||||
|
||||
let hasYear = y !== null, hasMonth = m !== null, hasDay = d !== null;
|
||||
let hasHour = h !== null, hasMinute = mm !== null, hasSecond = s !== null;
|
||||
|
||||
let datepart = (hasYear ? pad2(y) + (hasMonth || hasDay ? '-' : '') : (hasMonth || hasDay ? '--' : '')) +
|
||||
(hasMonth ? pad2(m) : '') +
|
||||
(hasDay ? '-' + pad2(d) : '');
|
||||
let timepart = (hasHour ? pad2(h) : '-') + (hasHour && hasMinute ? ':' : '') +
|
||||
(hasMinute ? pad2(mm) : '') + (!hasHour && !hasMinute ? '-' : '') +
|
||||
(hasMinute && hasSecond ? ':' : '') +
|
||||
(hasSecond ? pad2(s) : '');
|
||||
|
||||
let zone;
|
||||
if (this.zone === Timezone.utcTimezone) {
|
||||
zone = 'Z';
|
||||
} else if (this.zone instanceof UtcOffset) {
|
||||
zone = this.zone.toString();
|
||||
} else if (this.zone === Timezone.localTimezone) {
|
||||
zone = '';
|
||||
} else if (this.zone instanceof Timezone) {
|
||||
let offset = UtcOffset.fromSeconds(this.zone.utcOffset(this));
|
||||
zone = offset.toString();
|
||||
} else {
|
||||
zone = '';
|
||||
}
|
||||
|
||||
switch (this.icaltype) {
|
||||
case "time":
|
||||
return timepart + zone;
|
||||
case "date-and-or-time":
|
||||
case "date-time":
|
||||
return datepart + (timepart == '--' ? '' : 'T' + timepart + zone);
|
||||
case "date":
|
||||
return datepart;
|
||||
}
|
||||
return null;
|
||||
}
|
||||
}
|
||||
export default VCardTime;
|
||||
+103
@@ -0,0 +1,103 @@
|
||||
{
|
||||
"name": "ical.js",
|
||||
"version": "2.2.1",
|
||||
"author": "Philipp Kewisch",
|
||||
"contributors": [
|
||||
"Github Contributors (https://github.com/kewisch/ical.js/graphs/contributors)"
|
||||
],
|
||||
"description": "Javascript parser for ics (rfc5545) and vcard (rfc6350) data",
|
||||
"main": "dist/ical.js",
|
||||
"types": "dist/types/module.d.ts",
|
||||
"type": "module",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/kewisch/ical.js.git"
|
||||
},
|
||||
"keywords": [
|
||||
"calendar",
|
||||
"iCalendar",
|
||||
"jCal",
|
||||
"vCard",
|
||||
"jCard",
|
||||
"parser"
|
||||
],
|
||||
"devDependencies": {
|
||||
"@babel/preset-env": "^7.28.0",
|
||||
"@eslint/js": "^9.32.0",
|
||||
"@octokit/core": "^7.0.3",
|
||||
"@rollup/plugin-babel": "^6.0.4",
|
||||
"@rollup/plugin-terser": "^0.4.4",
|
||||
"@rollup/plugin-typescript": "^12.1.4",
|
||||
"@stylistic/eslint-plugin": "^5.2.2",
|
||||
"benchmark": "^2.1.4",
|
||||
"c8": "^10.1.3",
|
||||
"chai": "^5.2.1",
|
||||
"clean-jsdoc-theme": "^4.3.0",
|
||||
"eslint": "^9.32.0",
|
||||
"eslint-plugin-html": "^8.1.3",
|
||||
"globals": "^16.3.0",
|
||||
"jsdoc": "^4.0.4",
|
||||
"jsdoc-tsimport-plugin": "^1.0.5",
|
||||
"karma": "^6.4.4",
|
||||
"karma-mocha": "^2.0.1",
|
||||
"karma-sauce-launcher": "^4.1.4",
|
||||
"karma-spec-reporter": "^0.0.36",
|
||||
"mocha": "^11.7.1",
|
||||
"node-fetch": "^3.3.2",
|
||||
"yauzl-promise": "^4.0.0"
|
||||
},
|
||||
"license": "MPL-2.0",
|
||||
"engine": {
|
||||
"node": ">=10"
|
||||
},
|
||||
"scripts": {
|
||||
"test": "npm run test-unit && npm run test-acceptance",
|
||||
"test-unit": "c8 mocha",
|
||||
"test-acceptance": "mocha test/acceptance/*_test.js",
|
||||
"test-performance": "mocha --reporter test/support/perfReporter.cjs test/performance/*_test.js",
|
||||
"test-browser": "karma start karma.conf.cjs",
|
||||
"test-all": "npm run test-unit && npm run test-acceptance && npm run test-performance && npm run test-browser",
|
||||
"build": "rollup -c",
|
||||
"lint": "eslint",
|
||||
"jsdoc": "rm -rf docs/api && jsdoc --configure jsdoc-prepare.json && rm -rf docs/api && jsdoc --configure jsdoc.json --verbose",
|
||||
"validator": "node tools/scriptutils.js replace-unpkg tools/validator.html docs/validator.html",
|
||||
"recurtester": "node tools/scriptutils.js replace-unpkg tools/recur-tester.html docs/recur-tester.html",
|
||||
"ghpages": "npm run jsdoc && npm run validator && npm run recurtester"
|
||||
},
|
||||
"exports": {
|
||||
"import": "./dist/ical.js",
|
||||
"require": "./dist/ical.es5.cjs",
|
||||
"types": "./dist/types/module.d.ts"
|
||||
},
|
||||
"files": [
|
||||
"dist/ical.js",
|
||||
"dist/ical.min.js",
|
||||
"dist/ical.es5.cjs",
|
||||
"dist/ical.es5.min.cjs",
|
||||
"dist/types/*",
|
||||
"lib/ical/*.js"
|
||||
],
|
||||
"mocha": {
|
||||
"ui": "tdd",
|
||||
"require": "test/support/helper.js",
|
||||
"reporter": "spec"
|
||||
},
|
||||
"c8": {
|
||||
"include": "lib/ical",
|
||||
"reporter": [
|
||||
"text",
|
||||
"html",
|
||||
"lcov"
|
||||
]
|
||||
},
|
||||
"saucelabs": {
|
||||
"SL_Chrome": {
|
||||
"base": "SauceLabs",
|
||||
"browserName": "chrome"
|
||||
},
|
||||
"SL_Firefox": {
|
||||
"base": "SauceLabs",
|
||||
"browserName": "firefox"
|
||||
}
|
||||
}
|
||||
}
|
||||
Generated
+22
@@ -0,0 +1,22 @@
|
||||
{
|
||||
"name": "scripts",
|
||||
"version": "1.0.0",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "scripts",
|
||||
"version": "1.0.0",
|
||||
"license": "ISC",
|
||||
"dependencies": {
|
||||
"ical.js": "^2.2.1"
|
||||
}
|
||||
},
|
||||
"node_modules/ical.js": {
|
||||
"version": "2.2.1",
|
||||
"resolved": "https://registry.npmjs.org/ical.js/-/ical.js-2.2.1.tgz",
|
||||
"integrity": "sha512-yK/UlPbEs316igb/tjRgbFA8ZV75rCsBJp/hWOatpyaPNlgw0dGDmU+FoicOcwX4xXkeXOkYiOmCqNPFpNPkQg==",
|
||||
"license": "MPL-2.0"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,16 @@
|
||||
{
|
||||
"name": "calendar-reminder",
|
||||
"version": "1.0.0",
|
||||
"description": "日历提醒同步系统",
|
||||
"type": "module",
|
||||
"main": "calendar-reminder.mjs",
|
||||
"scripts": {
|
||||
"start": "node calendar-reminder.mjs"
|
||||
},
|
||||
"keywords": ["calendar", "caldav", "reminder"],
|
||||
"author": "",
|
||||
"license": "ISC",
|
||||
"dependencies": {
|
||||
"ical.js": "^2.2.1"
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user