Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 83x 83x 83x 83x 83x 83x 83x 83x 83x 83x 83x 83x 83x 83x 83x 1x 1x 83x 1x 1x 83x 83x 83x 83x 83x 83x 83x 83x 83x 83x 83x 83x 83x 83x 83x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 46x 12x 12x 46x 46x 46x 46x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 98x 15x 15x 98x 98x 83x 98x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 8x 2x 2x 8x 8x 8x 8x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 6x 3x 3x 3x 3x 3x 6x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 10x 1x 1x 10x 10x 9x 10x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 16x 5x 5x 16x 3x 3x 3x 16x 16x 8x 16x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 15x 3x 3x 15x 3x 3x 3x 15x 15x 9x 15x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 13x 3x 3x 13x 3x 3x 3x 13x 13x 7x 13x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 19x 3x 3x 19x 4x 4x 1x 1x 4x 4x 19x 19x 3x 3x 3x 3x 3x 9x 9x 9x 19x 19x 12x 19x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 21x 4x 4x 21x 21x 4x 4x 13x 3x 3x 3x 3x 3x 10x 9x 9x 1x 1x 1x 21x 21x 21x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 5x 5x 5x 5x 5x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 4x 4x 4x 4x 4x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 6x 3x 3x 3x 6x 1x 1x 2x 2x 2x 6x 6x 6x 1x 1x 1x 1x 1x 1x 1x 1x 1x 3x 3x 3x 3x 3x 3x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 21x 21x 21x 21x 21x 21x 21x 21x 21x 5x 5x 21x 21x 21x 11x 11x 21x 21x 21x 5x 5x 21x 21x 21x 1x 1x 21x 21x 21x 3x 3x 21x 21x 21x 3x 3x 21x 21x 21x 5x 5x 21x 21x 21x 2x 2x 21x 21x 21x 1x 1x 1x 1x 21x 21x 21x 21x 21x 1x | 'use strict';
import {addOrGetCustomAttributes, checkEnum, checkNameAndMail, escape} from './tools.ts';
import type ICalEvent from './event.ts';
import type ICalAlarm from './alarm.ts';
interface ICalInternalAttendeeData {
name: string | null;
email: string;
mailto: string | null;
sentBy: string | null;
status: ICalAttendeeStatus | null;
role: ICalAttendeeRole;
rsvp: boolean | null;
type: ICalAttendeeType | null;
delegatedTo: ICalAttendee | null;
delegatedFrom: ICalAttendee | null;
x: [string, string][];
}
export interface ICalAttendeeData {
name?: string | null;
email: string;
mailto?: string | null;
sentBy?: string | null;
status?: ICalAttendeeStatus | null;
role?: ICalAttendeeRole;
rsvp?: boolean | null;
type?: ICalAttendeeType | null;
delegatedTo?: ICalAttendee | ICalAttendeeData | string | null;
delegatedFrom?: ICalAttendee | ICalAttendeeData | string | null;
delegatesTo?: ICalAttendee | ICalAttendeeData | string | null;
delegatesFrom?: ICalAttendee | ICalAttendeeData | string | null;
x?: {key: string, value: string}[] | [string, string][] | Record<string, string>;
}
export interface ICalAttendeeJSONData {
name: string | null;
email: string;
mailto: string | null;
sentBy: string | null;
status: ICalAttendeeStatus | null;
role: ICalAttendeeRole;
rsvp: boolean | null;
type: ICalAttendeeType | null;
delegatedTo: string | null;
delegatedFrom: string | null;
x: {key: string, value: string}[];
}
export enum ICalAttendeeRole {
CHAIR = 'CHAIR',
REQ = 'REQ-PARTICIPANT',
OPT = 'OPT-PARTICIPANT',
NON = 'NON-PARTICIPANT'
}
export enum ICalAttendeeStatus {
ACCEPTED = 'ACCEPTED',
TENTATIVE = 'TENTATIVE',
DECLINED = 'DECLINED',
DELEGATED = 'DELEGATED',
NEEDSACTION = 'NEEDS-ACTION'
}
// ref: https://tools.ietf.org/html/rfc2445#section-4.2.3
export enum ICalAttendeeType {
INDIVIDUAL = 'INDIVIDUAL',
GROUP = 'GROUP',
RESOURCE = 'RESOURCE',
ROOM = 'ROOM',
UNKNOWN = 'UNKNOWN'
}
/**
* Usually you get an {@link ICalAttendee} object like this:
*
* ```javascript
* import ical from 'ical-generator';
* const calendar = ical();
* const event = calendar.createEvent();
* const attendee = event.createAttendee({ email: 'mail@example.com' });
* ```
*
* You can also use the {@link ICalAttendee} object directly:
*
* ```javascript
* import ical, {ICalAttendee} from 'ical-generator';
* const attendee = new ICalAttendee({ email: 'mail@example.com' });
* event.attendees([attendee]);
* ```
*/
export default class ICalAttendee {
private readonly data: ICalInternalAttendeeData;
private readonly parent: ICalEvent | ICalAlarm;
/**
* Constructor of {@link ICalAttendee}. The event reference is
* required to query the calendar's timezone when required.
*
* @param data Attendee Data
* @param parent Reference to ICalEvent object
*/
constructor(data: ICalAttendeeData, parent: ICalEvent | ICalAlarm) {
this.data = {
name: null,
email: '',
mailto: null,
sentBy: null,
status: null,
role: ICalAttendeeRole.REQ,
rsvp: null,
type: null,
delegatedTo: null,
delegatedFrom: null,
x: []
};
this.parent = parent;
if (!this.parent) {
throw new Error('`event` option required!');
}
if (!data.email) {
throw new Error('No value for `email` in ICalAttendee given!');
}
if (data.name !== undefined) this.name(data.name);
if (data.email !== undefined) this.email(data.email);
if (data.mailto !== undefined) this.mailto(data.mailto);
if (data.sentBy !== undefined) this.sentBy(data.sentBy);
if (data.status !== undefined) this.status(data.status);
if (data.role !== undefined) this.role(data.role);
if (data.rsvp !== undefined) this.rsvp(data.rsvp);
if (data.type !== undefined) this.type(data.type);
if (data.delegatedTo !== undefined) this.delegatedTo(data.delegatedTo);
if (data.delegatedFrom !== undefined) this.delegatedFrom(data.delegatedFrom);
if (data.delegatesTo) this.delegatesTo(data.delegatesTo);
if (data.delegatesFrom) this.delegatesFrom(data.delegatesFrom);
if (data.x !== undefined) this.x(data.x);
}
/**
* Get the attendee's name
* @since 0.2.0
*/
name(): string | null;
/**
* Set the attendee's name
* @since 0.2.0
*/
name(name: string | null): this;
name(name?: string | null): this | string | null {
if (name === undefined) {
return this.data.name;
}
this.data.name = name || null;
return this;
}
/**
* Get the attendee's email address
* @since 0.2.0
*/
email(): string;
/**
* Set the attendee's email address
* @since 0.2.0
*/
email(email: string): this;
email(email?: string): this | string {
if (!email) {
return this.data.email;
}
this.data.email = email;
return this;
}
/**
* Get the attendee's email address
* @since 1.3.0
*/
mailto(): string | null;
/**
* Set the attendee's email address
* @since 1.3.0
*/
mailto(mailto: string | null): this;
mailto(mailto?: string | null): this | string | null {
if (mailto === undefined) {
return this.data.mailto;
}
this.data.mailto = mailto || null;
return this;
}
/**
* Get the acting user's email adress
* @since 3.3.0
*/
sentBy(): string | null;
/**
* Set the acting user's email adress
* @since 3.3.0
*/
sentBy(email: string | null): this;
sentBy(email?: string | null): this | string | null {
if (!email) {
return this.data.sentBy;
}
this.data.sentBy = email;
return this;
}
/**
* Get attendee's role
* @since 0.2.0
*/
role(): ICalAttendeeRole;
/**
* Set the attendee's role, defaults to `REQ` / `REQ-PARTICIPANT`.
* Checkout {@link ICalAttendeeRole} for available roles.
*
* @since 0.2.0
*/
role(role: ICalAttendeeRole): this;
role(role?: ICalAttendeeRole): this | ICalAttendeeRole {
if (role === undefined) {
return this.data.role;
}
this.data.role = checkEnum(ICalAttendeeRole, role) as ICalAttendeeRole;
return this;
}
/**
* Get attendee's RSVP expectation
* @since 0.2.1
*/
rsvp(): boolean | null;
/**
* Set the attendee's RSVP expectation
* @since 0.2.1
*/
rsvp(rsvp: boolean | null): this;
rsvp(rsvp?: boolean | null): this | boolean | null {
if (rsvp === undefined) {
return this.data.rsvp;
}
if (rsvp === null) {
this.data.rsvp = null;
return this;
}
this.data.rsvp = Boolean(rsvp);
return this;
}
/**
* Get attendee's status
* @since 0.2.0
*/
status(): ICalAttendeeStatus | null;
/**
* Set the attendee's status. See {@link ICalAttendeeStatus}
* for available status options.
*
* @since 0.2.0
*/
status(status: ICalAttendeeStatus | null): this;
status(status?: ICalAttendeeStatus | null): this | ICalAttendeeStatus | null {
if (status === undefined) {
return this.data.status;
}
if (!status) {
this.data.status = null;
return this;
}
this.data.status = checkEnum(ICalAttendeeStatus, status) as ICalAttendeeStatus;
return this;
}
/**
* Get attendee's type (a.k.a. CUTYPE)
* @since 0.2.3
*/
type(): ICalAttendeeType;
/**
* Set attendee's type (a.k.a. CUTYPE).
* See {@link ICalAttendeeType} for available status options.
*
* @since 0.2.3
*/
type(type: ICalAttendeeType | null): this;
type(type?: ICalAttendeeType | null): this | ICalAttendeeType | null {
if (type === undefined) {
return this.data.type;
}
if (!type) {
this.data.type = null;
return this;
}
this.data.type = checkEnum(ICalAttendeeType, type) as ICalAttendeeType;
return this;
}
/**
* Get the attendee's delegated-to value.
* @since 0.2.0
*/
delegatedTo(): ICalAttendee | null;
/**
* Set the attendee's delegated-to field.
*
* Creates a new Attendee if the passed object is not already a
* {@link ICalAttendee} object. Will set the `delegatedTo` and
* `delegatedFrom` attributes.
*
* Will also set the `status` to `DELEGATED`, if attribute is set.
*
* ```javascript
* const cal = ical();
* const event = cal.createEvent();
* const attendee = cal.createAttendee();
*
* attendee.delegatesTo({email: 'foo@bar.com', name: 'Foo'});
```
*
* @since 0.2.0
*/
delegatedTo(delegatedTo: ICalAttendee | ICalAttendeeData | string | null): this;
delegatedTo(delegatedTo?: ICalAttendee | ICalAttendeeData | string | null): this | ICalAttendee | null {
if (delegatedTo === undefined) {
return this.data.delegatedTo;
}
if (!delegatedTo) {
this.data.delegatedTo = null;
if (this.data.status === ICalAttendeeStatus.DELEGATED) {
this.data.status = null;
}
return this;
}
if(typeof delegatedTo === 'string') {
this.data.delegatedTo = new ICalAttendee(
{ email: delegatedTo, ...checkNameAndMail('delegatedTo', delegatedTo) },
this.parent,
);
}
else if(delegatedTo instanceof ICalAttendee) {
this.data.delegatedTo = delegatedTo;
}
else {
this.data.delegatedTo = new ICalAttendee(delegatedTo, this.parent);
}
this.data.status = ICalAttendeeStatus.DELEGATED;
return this;
}
/**
* Get the attendee's delegated-from field
* @since 0.2.0
*/
delegatedFrom (): ICalAttendee | null;
/**
* Set the attendee's delegated-from field
*
* Creates a new Attendee if the passed object is not already a
* {@link ICalAttendee} object. Will set the `delegatedTo` and
* `delegatedFrom` attributes.
*
* @param delegatedFrom
*/
delegatedFrom (delegatedFrom: ICalAttendee | ICalAttendeeData | string | null): this;
delegatedFrom(delegatedFrom?: ICalAttendee | ICalAttendeeData | string | null): this | ICalAttendee | null {
if (delegatedFrom === undefined) {
return this.data.delegatedFrom;
}
if (!delegatedFrom) {
this.data.delegatedFrom = null;
}
else if(typeof delegatedFrom === 'string') {
this.data.delegatedFrom = new ICalAttendee(
{ email: delegatedFrom, ...checkNameAndMail('delegatedFrom', delegatedFrom) },
this.parent,
);
}
else if(delegatedFrom instanceof ICalAttendee) {
this.data.delegatedFrom = delegatedFrom;
}
else {
this.data.delegatedFrom = new ICalAttendee(delegatedFrom, this.parent);
}
return this;
}
/**
* Create a new attendee this attendee delegates to and returns
* this new attendee. Creates a new attendee if the passed object
* is not already an {@link ICalAttendee}.
*
* ```javascript
* const cal = ical();
* const event = cal.createEvent();
* const attendee = cal.createAttendee();
*
* attendee.delegatesTo({email: 'foo@bar.com', name: 'Foo'});
* ```
*
* @since 0.2.0
*/
delegatesTo (options: ICalAttendee | ICalAttendeeData | string): ICalAttendee {
const a = options instanceof ICalAttendee ? options : this.parent.createAttendee(options);
this.delegatedTo(a);
a.delegatedFrom(this);
return a;
}
/**
* Create a new attendee this attendee delegates from and returns
* this new attendee. Creates a new attendee if the passed object
* is not already an {@link ICalAttendee}.
*
* ```javascript
* const cal = ical();
* const event = cal.createEvent();
* const attendee = cal.createAttendee();
*
* attendee.delegatesFrom({email: 'foo@bar.com', name: 'Foo'});
* ```
*
* @since 0.2.0
*/
delegatesFrom (options: ICalAttendee | ICalAttendeeData | string): ICalAttendee {
const a = options instanceof ICalAttendee ? options : this.parent.createAttendee(options);
this.delegatedFrom(a);
a.delegatedTo(this);
return a;
}
/**
* Set X-* attributes. Woun't filter double attributes,
* which are also added by another method (e.g. status),
* so these attributes may be inserted twice.
*
* ```javascript
* attendee.x([
* {
* key: "X-MY-CUSTOM-ATTR",
* value: "1337!"
* }
* ]);
*
* attendee.x([
* ["X-MY-CUSTOM-ATTR", "1337!"]
* ]);
*
* attendee.x({
* "X-MY-CUSTOM-ATTR": "1337!"
* });
* ```
*
* @since 1.9.0
*/
x (keyOrArray: {key: string, value: string}[] | [string, string][] | Record<string, string>): this;
/**
* Set a X-* attribute. Woun't filter double attributes,
* which are also added by another method (e.g. status),
* so these attributes may be inserted twice.
*
* ```javascript
* attendee.x("X-MY-CUSTOM-ATTR", "1337!");
* ```
*
* @since 1.9.0
*/
x (keyOrArray: string, value: string): this;
/**
* Get all custom X-* attributes.
* @since 1.9.0
*/
x (): {key: string, value: string}[];
x (keyOrArray?: ({key: string, value: string})[] | [string, string][] | Record<string, string> | string, value?: string): this | void | ({key: string, value: string})[] {
if(keyOrArray === undefined) {
return addOrGetCustomAttributes (this.data);
}
if(typeof keyOrArray === 'string' && typeof value === 'string') {
addOrGetCustomAttributes (this.data, keyOrArray, value);
}
else if(typeof keyOrArray === 'object') {
addOrGetCustomAttributes (this.data, keyOrArray);
}
else {
throw new Error('Either key or value is not a string!');
}
return this;
}
/**
* Return a shallow copy of the attendee's options for JSON stringification.
* Can be used for persistence.
*
* @since 0.2.4
*/
toJSON(): ICalAttendeeJSONData {
return Object.assign({}, this.data, {
delegatedTo: this.data.delegatedTo?.email() || null,
delegatedFrom: this.data.delegatedFrom?.email() || null,
x: this.x()
});
}
/**
* Return generated attendee as a string.
*
* ```javascript
* console.log(attendee.toString()); // → ATTENDEE;ROLE=…
* ```
*/
toString (): string {
let g = 'ATTENDEE';
if (!this.data.email) {
throw new Error('No value for `email` in ICalAttendee given!');
}
// ROLE
g += ';ROLE=' + this.data.role;
// TYPE
if (this.data.type) {
g += ';CUTYPE=' + this.data.type;
}
// PARTSTAT
if (this.data.status) {
g += ';PARTSTAT=' + this.data.status;
}
// RSVP
if (this.data.rsvp !== null) {
g += ';RSVP=' + this.data.rsvp.toString().toUpperCase();
}
// SENT-BY
if (this.data.sentBy !== null) {
g += ';SENT-BY="mailto:' + this.data.sentBy + '"';
}
// DELEGATED-TO
if (this.data.delegatedTo) {
g += ';DELEGATED-TO="' + this.data.delegatedTo.email() + '"';
}
// DELEGATED-FROM
if (this.data.delegatedFrom) {
g += ';DELEGATED-FROM="' + this.data.delegatedFrom.email() + '"';
}
// CN / Name
if (this.data.name) {
g += ';CN="' + escape(this.data.name, true) + '"';
}
// EMAIL
if (this.data.email && this.data.mailto) {
g += ';EMAIL=' + escape(this.data.email, false);
}
// CUSTOM X ATTRIBUTES
if(this.data.x.length) {
g += ';' + this.data.x
.map(([key, value]) => key.toUpperCase() + '=' + escape(value, false))
.join(';');
}
g += ':MAILTO:' + escape(this.data.mailto || this.data.email, false) + '\r\n';
return g;
}
}
|