iamcal 2.0.0 → 2.1.1

package/lib/components/TimeZone.js

@@ -2,15 +2,18 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TimeZone = void 0;
 const component_1 = require("../component");
-const parse_1 = require("../parse");
+const date_1 = require("../date");
+const TimeZoneOffset_1 = require("./TimeZoneOffset");
 /**
  * Represents a VTIMEZONE component, containing time zone definitions.
  */
 class TimeZone extends component_1.Component {
+    name = 'VTIMEZONE';
     constructor(a) {
-        var component;
+        let component;
         if (a instanceof component_1.Component) {
             component = a;
+            TimeZone.prototype.validate.call(component);
         }
         else {
             const tzid = a;
@@ -19,25 +22,31 @@ class TimeZone extends component_1.Component {
         }
         super(component.name, component.properties, component.components);
     }
-    id() {
+    validate() {
+        if (this.name !== 'VTIMEZONE')
+            throw new component_1.ComponentValidationError('Component name must be VEVENT');
+        const requiredProperties = ['TZID'];
+        this.validateAllProperties(requiredProperties);
+    }
+    getId() {
         return this.getProperty('TZID').value;
     }
     setId(value) {
         return this.setProperty('TZID', value);
     }
-    lastMod() {
-        const text = this.getProperty('LAST-MOD');
+    getLastModified() {
+        const text = this.getProperty('LAST-MODIFIED');
         if (!text)
             return;
-        return (0, parse_1.parseDate)(text);
+        return (0, date_1.parseDateProperty)(text);
     }
-    setLastMod(value) {
-        return this.setProperty('LAST-MOD', value.toISOString());
+    setLastModified(value) {
+        return this.setProperty('LAST-MODIFIED', value.toISOString());
     }
-    removeLastMod() {
+    removeLastModified() {
         this.removePropertiesWithName('LAST-MOD');
     }
-    url() {
+    getUrl() {
         return this.getProperty('TZURL')?.value;
     }
     setUrl(value) {
@@ -46,87 +55,73 @@ class TimeZone extends component_1.Component {
     removeUrl() {
         this.removePropertiesWithName('TZURL');
     }
-    /** Get all time offsets. */
-    offsets() {
+    /**
+     * Get all time offsets.
+     * @returns An array of time zone offsets defined in this time zone.
+     */
+    getOffsets() {
         const offsets = [];
         this.components.forEach(component => {
-            if (component.name === 'STANDARD' || component.name === 'DAYLIGHT') {
-                offsets.push(new TimeZoneOffset(component));
+            if (component.name === 'STANDARD' ||
+                component.name === 'DAYLIGHT') {
+                offsets.push(new TimeZoneOffset_1.TimeZoneOffset(component));
             }
         });
         return offsets;
     }
-    /** Get standard/winter time offsets. */
-    standardOffsets() {
-        return this.getComponents('STANDARD').map(c => new TimeZoneOffset(c));
-    }
-    /** Get daylight savings time offsets. */
-    daylightOffsets() {
-        return this.getComponents('DAYLIGHT').map(c => new TimeZoneOffset(c));
-    }
+    /**
+     * Get standard/winter time offsets.
+     * @returns An array of time zone offsets defined in this time zone that are of type STANDARD.
+     */
+    getStandardOffsets() {
+        return this.getComponentsWithName('STANDARD').map(c => new TimeZoneOffset_1.TimeZoneOffset(c));
+    }
+    /**
+     * Get daylight savings time offsets.
+     * @returns An array of time zone offsets defined in this time zone that are of type DAYLIGHT.
+     */
+    getDaylightOffsets() {
+        return this.getComponentsWithName('DAYLIGHT').map(c => new TimeZoneOffset_1.TimeZoneOffset(c));
+    }
+    /* eslint-disable */
+    /**
+     * @deprecated Use {@link getId} instead.
+     */
+    id = this.getId;
+    /**
+     * @deprecated Use {@link getLastModified} instead.
+     */
+    lastMod = this.getLastModified;
+    /**
+     * @deprecated Use {@link setLastModified} instead.
+     */
+    setLastMod = this.setLastModified;
+    /**
+     * @deprecated Use {@link removeLastModified} instead.
+     */
+    removeLastMod = this.removeLastModified;
+    /**
+     * @deprecated Use {@link getUrl} instead.
+     */
+    url = this.getUrl;
+    /**
+     * Get all time offsets.
+     * @returns An array of time zone offsets defined in this time zone.
+     * @deprecated Use {@link getOffsets} instead.
+     */
+    offsets = this.getOffsets;
+    /**
+     * Get standard/winter time offsets.
+     * @returns An array of time zone offsets defined in this time zone that are of type STANDARD.
+     * @deprecated Use {@link getStandardOffsets} instead.
+     */
+    standardOffsets = this.getStandardOffsets;
+    /**
+     * Get daylight savings time offsets.
+     * @returns An array of time zone offsets defined in this time zone that are of type DAYLIGHT.
+     * @deprecated Use {@link getDaylightOffsets} instead.
+     */
+    daylightOffsets = this.getDaylightOffsets;
 }
 exports.TimeZone = TimeZone;
-/** Represents a STANDARD or DAYLIGHT component, defining a time zone offset. */
-class TimeZoneOffset extends component_1.Component {
-    constructor(a, b, c, d) {
-        var component;
-        if (a instanceof component_1.Component) {
-            component = a;
-        }
-        else {
-            const name = a;
-            const start = b;
-            const offsetFrom = c;
-            const offsetTo = d;
-            component = new component_1.Component(name);
-            component.setProperty('DTSTART', (0, parse_1.toDateTimeString)(start));
-            component.setProperty('TZOFFSETFROM', offsetFrom);
-            component.setProperty('TZOFFSETTO', offsetTo);
-        }
-        super(component.name, component.properties, component.components);
-    }
-    start() {
-        return (0, parse_1.parseDate)(this.getProperty('DTSTART'));
-    }
-    setStart(value, fullDay = false) {
-        if (fullDay) {
-            this.setProperty('DTSTART', (0, parse_1.toDateString)(value));
-            this.setPropertyParams('DTSTART', ['VALUE=DATE']);
-        }
-        else {
-            this.setProperty('DTSTART', (0, parse_1.toDateTimeString)(value));
-        }
-        return this;
-    }
-    offsetFrom() {
-        return this.getProperty('TZOFFSETFROM').value;
-    }
-    setOffsetFrom(value) {
-        return this.setProperty('TZOFFSETFROM', value);
-    }
-    offsetTo() {
-        return this.getProperty('TZOFFSETTO').value;
-    }
-    setOffsetTo(value) {
-        return this.setProperty('TZOFFSETTO', value);
-    }
-    comment() {
-        return this.getProperty('COMMENT')?.value;
-    }
-    setComment(value) {
-        return this.setProperty('COMMENT', value);
-    }
-    removeComment() {
-        this.removePropertiesWithName('COMMENT');
-    }
-    timeZoneName() {
-        return this.getProperty('TZNAME')?.value;
-    }
-    setTimeZoneName(value) {
-        return this.setProperty('TZNAME', value);
-    }
-    removeTimeZoneName() {
-        this.removePropertiesWithName('TZNAME');
-    }
-}
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiVGltZVpvbmUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY29tcG9uZW50cy9UaW1lWm9uZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSw0Q0FBd0M7QUFDeEMsb0NBQW9FO0FBRXBFOztHQUVHO0FBQ0gsTUFBYSxRQUFTLFNBQVEscUJBQVM7SUFHbkMsWUFBWSxDQUFxQjtRQUM3QixJQUFJLFNBQW9CLENBQUE7UUFDeEIsSUFBSSxDQUFDLFlBQVkscUJBQVMsRUFBRSxDQUFDO1lBQ3pCLFNBQVMsR0FBRyxDQUFjLENBQUE7UUFDOUIsQ0FBQzthQUFNLENBQUM7WUFDSixNQUFNLElBQUksR0FBRyxDQUFXLENBQUE7WUFDeEIsU0FBUyxHQUFHLElBQUkscUJBQVMsQ0FBQyxXQUFXLENBQUMsQ0FBQTtZQUN0QyxTQUFTLENBQUMsV0FBVyxDQUFDLE1BQU0sRUFBRSxJQUFJLENBQUMsQ0FBQTtRQUN2QyxDQUFDO1FBQ0QsS0FBSyxDQUFDLFNBQVMsQ0FBQyxJQUFJLEVBQUUsU0FBUyxDQUFDLFVBQVUsRUFBRSxTQUFTLENBQUMsVUFBVSxDQUFDLENBQUE7SUFDckUsQ0FBQztJQUVELEVBQUU7UUFDRSxPQUFPLElBQUksQ0FBQyxXQUFXLENBQUMsTUFBTSxDQUFFLENBQUMsS0FBSyxDQUFBO0lBQzFDLENBQUM7SUFFRCxLQUFLLENBQUMsS0FBYTtRQUNmLE9BQU8sSUFBSSxDQUFDLFdBQVcsQ0FBQyxNQUFNLEVBQUUsS0FBSyxDQUFDLENBQUE7SUFDMUMsQ0FBQztJQUVELE9BQU87UUFDSCxNQUFNLElBQUksR0FBRyxJQUFJLENBQUMsV0FBVyxDQUFDLFVBQVUsQ0FBQyxDQUFBO1FBQ3pDLElBQUksQ0FBQyxJQUFJO1lBQUUsT0FBTTtRQUNqQixPQUFPLElBQUEsaUJBQVMsRUFBQyxJQUFJLENBQUMsQ0FBQTtJQUMxQixDQUFDO0lBRUQsVUFBVSxDQUFDLEtBQVc7UUFDbEIsT0FBTyxJQUFJLENBQUMsV0FBVyxDQUFDLFVBQVUsRUFBRSxLQUFLLENBQUMsV0FBVyxFQUFFLENBQUMsQ0FBQTtJQUM1RCxDQUFDO0lBRUQsYUFBYTtRQUNULElBQUksQ0FBQyx3QkFBd0IsQ0FBQyxVQUFVLENBQUMsQ0FBQTtJQUM3QyxDQUFDO0lBRUQsR0FBRztRQUNDLE9BQU8sSUFBSSxDQUFDLFdBQVcsQ0FBQyxPQUFPLENBQUMsRUFBRSxLQUFLLENBQUE7SUFDM0MsQ0FBQztJQUVELE1BQU0sQ0FBQyxLQUFhO1FBQ2hCLE9BQU8sSUFBSSxDQUFDLFdBQVcsQ0FBQyxPQUFPLEVBQUUsS0FBSyxDQUFDLENBQUE7SUFDM0MsQ0FBQztJQUVELFNBQVM7UUFDTCxJQUFJLENBQUMsd0JBQXdCLENBQUMsT0FBTyxDQUFDLENBQUE7SUFDMUMsQ0FBQztJQUVELDRCQUE0QjtJQUM1QixPQUFPO1FBQ0gsTUFBTSxPQUFPLEdBQXFCLEVBQUUsQ0FBQTtRQUNwQyxJQUFJLENBQUMsVUFBVSxDQUFDLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRTtZQUNoQyxJQUFJLFNBQVMsQ0FBQyxJQUFJLEtBQUssVUFBVSxJQUFJLFNBQVMsQ0FBQyxJQUFJLEtBQUssVUFBVSxFQUFFLENBQUM7Z0JBQ2pFLE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBSSxjQUFjLENBQUMsU0FBUyxDQUFDLENBQUMsQ0FBQTtZQUMvQyxDQUFDO1FBQ0wsQ0FBQyxDQUFDLENBQUE7UUFDRixPQUFPLE9BQU8sQ0FBQTtJQUNsQixDQUFDO0lBRUQsd0NBQXdDO0lBQ3hDLGVBQWU7UUFDWCxPQUFPLElBQUksQ0FBQyxhQUFhLENBQUMsVUFBVSxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUMsSUFBSSxjQUFjLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQTtJQUN6RSxDQUFDO0lBRUQseUNBQXlDO0lBQ3pDLGVBQWU7UUFDWCxPQUFPLElBQUksQ0FBQyxhQUFhLENBQUMsVUFBVSxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUMsSUFBSSxjQUFjLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQTtJQUN6RSxDQUFDO0NBQ0o7QUFyRUQsNEJBcUVDO0FBS0QsZ0ZBQWdGO0FBQ2hGLE1BQU0sY0FBZSxTQUFRLHFCQUFTO0lBVWxDLFlBQVksQ0FBeUIsRUFBRSxDQUFRLEVBQUUsQ0FBVSxFQUFFLENBQVU7UUFDbkUsSUFBSSxTQUFvQixDQUFBO1FBQ3hCLElBQUksQ0FBQyxZQUFZLHFCQUFTLEVBQUUsQ0FBQztZQUN6QixTQUFTLEdBQUcsQ0FBYyxDQUFBO1FBQzlCLENBQUM7YUFBTSxDQUFDO1lBQ0osTUFBTSxJQUFJLEdBQUcsQ0FBZSxDQUFBO1lBQzVCLE1BQU0sS0FBSyxHQUFHLENBQVMsQ0FBQTtZQUN2QixNQUFNLFVBQVUsR0FBRyxDQUFXLENBQUE7WUFDOUIsTUFBTSxRQUFRLEdBQUcsQ0FBVyxDQUFBO1lBQzVCLFNBQVMsR0FBRyxJQUFJLHFCQUFTLENBQUMsSUFBSSxDQUFDLENBQUE7WUFDL0IsU0FBUyxDQUFDLFdBQVcsQ0FBQyxTQUFTLEVBQUUsSUFBQSx3QkFBZ0IsRUFBQyxLQUFLLENBQUMsQ0FBQyxDQUFBO1lBQ3pELFNBQVMsQ0FBQyxXQUFXLENBQUMsY0FBYyxFQUFFLFVBQVUsQ0FBQyxDQUFBO1lBQ2pELFNBQVMsQ0FBQyxXQUFXLENBQUMsWUFBWSxFQUFFLFFBQVEsQ0FBQyxDQUFBO1FBQ2pELENBQUM7UUFDRCxLQUFLLENBQUMsU0FBUyxDQUFDLElBQUksRUFBRSxTQUFTLENBQUMsVUFBVSxFQUFFLFNBQVMsQ0FBQyxVQUFVLENBQUMsQ0FBQTtJQUNyRSxDQUFDO0lBRUQsS0FBSztRQUNELE9BQU8sSUFBQSxpQkFBUyxFQUFDLElBQUksQ0FBQyxXQUFXLENBQUMsU0FBUyxDQUFFLENBQUMsQ0FBQTtJQUNsRCxDQUFDO0lBRUQsUUFBUSxDQUFDLEtBQVcsRUFBRSxVQUFtQixLQUFLO1FBQzFDLElBQUksT0FBTyxFQUFFLENBQUM7WUFDVixJQUFJLENBQUMsV0FBVyxDQUFDLFNBQVMsRUFBRSxJQUFBLG9CQUFZLEVBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQTtZQUNoRCxJQUFJLENBQUMsaUJBQWlCLENBQUMsU0FBUyxFQUFFLENBQUMsWUFBWSxDQUFDLENBQUMsQ0FBQTtRQUNyRCxDQUFDO2FBQU0sQ0FBQztZQUNKLElBQUksQ0FBQyxXQUFXLENBQUMsU0FBUyxFQUFFLElBQUEsd0JBQWdCLEVBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQTtRQUN4RCxDQUFDO1FBQ0QsT0FBTyxJQUFJLENBQUE7SUFDZixDQUFDO0lBRUQsVUFBVTtRQUNOLE9BQU8sSUFBSSxDQUFDLFdBQVcsQ0FBQyxjQUFjLENBQUUsQ0FBQyxLQUFlLENBQUE7SUFDNUQsQ0FBQztJQUVELGFBQWEsQ0FBQyxLQUFhO1FBQ3ZCLE9BQU8sSUFBSSxDQUFDLFdBQVcsQ0FBQyxjQUFjLEVBQUUsS0FBSyxDQUFDLENBQUE7SUFDbEQsQ0FBQztJQUVELFFBQVE7UUFDSixPQUFPLElBQUksQ0FBQyxXQUFXLENBQUMsWUFBWSxDQUFFLENBQUMsS0FBZSxDQUFBO0lBQzFELENBQUM7SUFFRCxXQUFXLENBQUMsS0FBYTtRQUNyQixPQUFPLElBQUksQ0FBQyxXQUFXLENBQUMsWUFBWSxFQUFFLEtBQUssQ0FBQyxDQUFBO0lBQ2hELENBQUM7SUFFRCxPQUFPO1FBQ0gsT0FBTyxJQUFJLENBQUMsV0FBVyxDQUFDLFNBQVMsQ0FBQyxFQUFFLEtBQUssQ0FBQTtJQUM3QyxDQUFDO0lBRUQsVUFBVSxDQUFDLEtBQWE7UUFDcEIsT0FBTyxJQUFJLENBQUMsV0FBVyxDQUFDLFNBQVMsRUFBRSxLQUFLLENBQUMsQ0FBQTtJQUM3QyxDQUFDO0lBRUQsYUFBYTtRQUNULElBQUksQ0FBQyx3QkFBd0IsQ0FBQyxTQUFTLENBQUMsQ0FBQTtJQUM1QyxDQUFDO0lBRUQsWUFBWTtRQUNSLE9BQU8sSUFBSSxDQUFDLFdBQVcsQ0FBQyxRQUFRLENBQUMsRUFBRSxLQUFLLENBQUE7SUFDNUMsQ0FBQztJQUVELGVBQWUsQ0FBQyxLQUFhO1FBQ3pCLE9BQU8sSUFBSSxDQUFDLFdBQVcsQ0FBQyxRQUFRLEVBQUUsS0FBSyxDQUFDLENBQUE7SUFDNUMsQ0FBQztJQUVELGtCQUFrQjtRQUNkLElBQUksQ0FBQyx3QkFBd0IsQ0FBQyxRQUFRLENBQUMsQ0FBQTtJQUMzQyxDQUFDO0NBQ0oifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiVGltZVpvbmUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY29tcG9uZW50cy9UaW1lWm9uZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSw0Q0FBa0U7QUFDbEUsa0NBQStEO0FBRS9ELHFEQUFpRDtBQUVqRDs7R0FFRztBQUNILE1BQWEsUUFBUyxTQUFRLHFCQUFTO0lBQ25DLElBQUksR0FBRyxXQUFXLENBQUE7SUFJbEIsWUFBWSxDQUFxQjtRQUM3QixJQUFJLFNBQW9CLENBQUE7UUFDeEIsSUFBSSxDQUFDLFlBQVkscUJBQVMsRUFBRSxDQUFDO1lBQ3pCLFNBQVMsR0FBRyxDQUFjLENBQUE7WUFDMUIsUUFBUSxDQUFDLFNBQVMsQ0FBQyxRQUFRLENBQUMsSUFBSSxDQUFDLFNBQVMsQ0FBQyxDQUFBO1FBQy9DLENBQUM7YUFBTSxDQUFDO1lBQ0osTUFBTSxJQUFJLEdBQUcsQ0FBVyxDQUFBO1lBQ3hCLFNBQVMsR0FBRyxJQUFJLHFCQUFTLENBQUMsV0FBVyxDQUFDLENBQUE7WUFDdEMsU0FBUyxDQUFDLFdBQVcsQ0FBQyxNQUFNLEVBQUUsSUFBSSxDQUFDLENBQUE7UUFDdkMsQ0FBQztRQUNELEtBQUssQ0FBQyxTQUFTLENBQUMsSUFBSSxFQUFFLFNBQVMsQ0FBQyxVQUFVLEVBQUUsU0FBUyxDQUFDLFVBQVUsQ0FBQyxDQUFBO0lBQ3JFLENBQUM7SUFFRCxRQUFRO1FBQ0osSUFBSSxJQUFJLENBQUMsSUFBSSxLQUFLLFdBQVc7WUFDekIsTUFBTSxJQUFJLG9DQUF3QixDQUFDLCtCQUErQixDQUFDLENBQUE7UUFDdkUsTUFBTSxrQkFBa0IsR0FBd0IsQ0FBQyxNQUFNLENBQUMsQ0FBQTtRQUN4RCxJQUFJLENBQUMscUJBQXFCLENBQUMsa0JBQWtCLENBQUMsQ0FBQTtJQUNsRCxDQUFDO0lBRUQsS0FBSztRQUNELE9BQU8sSUFBSSxDQUFDLFdBQVcsQ0FBQyxNQUFNLENBQUUsQ0FBQyxLQUFLLENBQUE7SUFDMUMsQ0FBQztJQUVELEtBQUssQ0FBQyxLQUFhO1FBQ2YsT0FBTyxJQUFJLENBQUMsV0FBVyxDQUFDLE1BQU0sRUFBRSxLQUFLLENBQUMsQ0FBQTtJQUMxQyxDQUFDO0lBRUQsZUFBZTtRQUNYLE1BQU0sSUFBSSxHQUFHLElBQUksQ0FBQyxXQUFXLENBQUMsZUFBZSxDQUFDLENBQUE7UUFDOUMsSUFBSSxDQUFDLElBQUk7WUFBRSxPQUFNO1FBQ2pCLE9BQU8sSUFBQSx3QkFBaUIsRUFBQyxJQUFJLENBQUMsQ0FBQTtJQUNsQyxDQUFDO0lBRUQsZUFBZSxDQUFDLEtBQVc7UUFDdkIsT0FBTyxJQUFJLENBQUMsV0FBVyxDQUFDLGVBQWUsRUFBRSxLQUFLLENBQUMsV0FBVyxFQUFFLENBQUMsQ0FBQTtJQUNqRSxDQUFDO0lBRUQsa0JBQWtCO1FBQ2QsSUFBSSxDQUFDLHdCQUF3QixDQUFDLFVBQVUsQ0FBQyxDQUFBO0lBQzdDLENBQUM7SUFFRCxNQUFNO1FBQ0YsT0FBTyxJQUFJLENBQUMsV0FBVyxDQUFDLE9BQU8sQ0FBQyxFQUFFLEtBQUssQ0FBQTtJQUMzQyxDQUFDO0lBRUQsTUFBTSxDQUFDLEtBQWE7UUFDaEIsT0FBTyxJQUFJLENBQUMsV0FBVyxDQUFDLE9BQU8sRUFBRSxLQUFLLENBQUMsQ0FBQTtJQUMzQyxDQUFDO0lBRUQsU0FBUztRQUNMLElBQUksQ0FBQyx3QkFBd0IsQ0FBQyxPQUFPLENBQUMsQ0FBQTtJQUMxQyxDQUFDO0lBRUQ7OztPQUdHO0lBQ0gsVUFBVTtRQUNOLE1BQU0sT0FBTyxHQUFxQixFQUFFLENBQUE7UUFDcEMsSUFBSSxDQUFDLFVBQVUsQ0FBQyxPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUU7WUFDaEMsSUFDSSxTQUFTLENBQUMsSUFBSSxLQUFLLFVBQVU7Z0JBQzdCLFNBQVMsQ0FBQyxJQUFJLEtBQUssVUFBVSxFQUMvQixDQUFDO2dCQUNDLE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBSSwrQkFBYyxDQUFDLFNBQVMsQ0FBQyxDQUFDLENBQUE7WUFDL0MsQ0FBQztRQUNMLENBQUMsQ0FBQyxDQUFBO1FBQ0YsT0FBTyxPQUFPLENBQUE7SUFDbEIsQ0FBQztJQUVEOzs7T0FHRztJQUNILGtCQUFrQjtRQUNkLE9BQU8sSUFBSSxDQUFDLHFCQUFxQixDQUFDLFVBQVUsQ0FBQyxDQUFDLEdBQUcsQ0FDN0MsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxJQUFJLCtCQUFjLENBQUMsQ0FBQyxDQUFDLENBQzdCLENBQUE7SUFDTCxDQUFDO0lBRUQ7OztPQUdHO0lBQ0gsa0JBQWtCO1FBQ2QsT0FBTyxJQUFJLENBQUMscUJBQXFCLENBQUMsVUFBVSxDQUFDLENBQUMsR0FBRyxDQUM3QyxDQUFDLENBQUMsRUFBRSxDQUFDLElBQUksK0JBQWMsQ0FBQyxDQUFDLENBQUMsQ0FDN0IsQ0FBQTtJQUNMLENBQUM7SUFFRCxvQkFBb0I7SUFFcEI7O09BRUc7SUFDSCxFQUFFLEdBQUcsSUFBSSxDQUFDLEtBQUssQ0FBQTtJQUVmOztPQUVHO0lBQ0gsT0FBTyxHQUFHLElBQUksQ0FBQyxlQUFlLENBQUE7SUFFOUI7O09BRUc7SUFDSCxVQUFVLEdBQUcsSUFBSSxDQUFDLGVBQWUsQ0FBQTtJQUVqQzs7T0FFRztJQUNILGFBQWEsR0FBRyxJQUFJLENBQUMsa0JBQWtCLENBQUE7SUFFdkM7O09BRUc7SUFDSCxHQUFHLEdBQUcsSUFBSSxDQUFDLE1BQU0sQ0FBQTtJQUVqQjs7OztPQUlHO0lBQ0gsT0FBTyxHQUFHLElBQUksQ0FBQyxVQUFVLENBQUE7SUFFekI7Ozs7T0FJRztJQUNILGVBQWUsR0FBRyxJQUFJLENBQUMsa0JBQWtCLENBQUE7SUFFekM7Ozs7T0FJRztJQUNILGVBQWUsR0FBRyxJQUFJLENBQUMsa0JBQWtCLENBQUE7Q0FDNUM7QUEvSUQsNEJBK0lDIn0=

package/lib/components/TimeZoneOffset.d.ts

@@ -0,0 +1,103 @@
+import { Component } from '../component';
+import { CalendarDateOrTime } from '../date';
+export declare const knownOffsetTypes: string[];
+export type OffsetType = (typeof knownOffsetTypes)[number];
+type Digit = '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9';
+export type Offset = `${'-' | '+'}${Digit}${Digit}${Digit}${Digit}`;
+/**
+ * Represents a STANDARD or DAYLIGHT subcomponent, defining a time zone offset.
+ */
+export declare class TimeZoneOffset extends Component {
+    /**
+     * @param type If this is a STANDARD or DAYLIGHT component.
+     * @param start From when this offset is active.
+     * @param offsetFrom The offset that is in use prior to this time zone observance.
+     * @param offsetTo The offset that is in use during this time zone observance.
+     */
+    constructor(type: OffsetType, start: CalendarDateOrTime | Date, offsetFrom: Offset, offsetTo: Offset);
+    constructor(component: Component);
+    validate(): void;
+    /**
+     * Get the date or time when this time zone offset starts.
+     * @returns The start date or time of this time zone offset.
+     */
+    getStart(): CalendarDateOrTime;
+    /**
+     * Set the date or time when this time zone offset starts.
+     * @param value The start date or time.
+     * @returns The TimeZoneOffset instance for chaining.
+     */
+    setStart(value: CalendarDateOrTime | Date): this;
+    /**
+     * Get the offset which is offset from during this time zone offset.
+     * @returns The offset in a format such as "+0100" or "-0230".
+     */
+    getOffsetFrom(): Offset;
+    /**
+     * Set the offset to offset from during this time zone offset.
+     * @param value An offset such as "+0100" or "-0230".
+     * @returns The TimeZoneOffset instance for chaining.
+     */
+    setOffsetFrom(value: Offset): this;
+    /**
+     * Get the offset which is offset to during this time zone offset.
+     * @returns The offset in a format such as "+0100" or "-0230".
+     */
+    getOffsetTo(): Offset;
+    /**
+     * Set the offset to offset to during this time zone offset.
+     * @param value An offset such as "+0100" or "-0230".
+     * @returns The TimeZoneOffset instance for chaining.
+     */
+    setOffsetTo(value: Offset): this;
+    getComment(): string | undefined;
+    setComment(value: string): this;
+    removeComment(): void;
+    /**
+     * Get the name of this time zone offset.
+     * @returns The time zone offset name if it exists.
+     */
+    getTimeZoneName(): string | undefined;
+    /**
+     * Set the name of this time zone offset.
+     * @param value The new name.
+     * @returns The TimeZoneOffset instance for chaining.
+     * @example
+     * timeZoneOffset.setTimeZoneName('EST')
+     */
+    setTimeZoneName(value: string): this;
+    /**
+     * Remove the name of this time zone offset.
+     */
+    removeTimeZoneName(): void;
+    /**
+     * Get the date or time when this time zone offset starts.
+     * @returns The start date or time of this time zone offset.
+     * @deprecated Use {@link getStart} instead.
+     */
+    start: () => CalendarDateOrTime;
+    /**
+     * Get the offset which is offset from during this time zone offset.
+     * @returns The offset in a format such as "+0100" or "-0230".
+     * @deprecated Use {@link getOffsetFrom} instead.
+     */
+    offsetFrom: () => Offset;
+    /**
+     * Get the offset which is offset to during this time zone offset.
+     * @returns The offset in a format such as "+0100" or "-0230".
+     * @deprecated Use {@link getOffsetTo} instead.
+     */
+    offsetTo: () => Offset;
+    /**
+     * @deprecated Use {@link getComment} instead.
+     */
+    comment: () => string | undefined;
+    /**
+     * Get the name of this time zone offset.
+     * @returns The time zone offset name if it exists.
+     * @deprecated Use {@link getTimeZoneName} instead.
+     */
+    timeZoneName: () => string | undefined;
+}
+export {};
+//# sourceMappingURL=TimeZoneOffset.d.ts.map

package/lib/components/TimeZoneOffset.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TimeZoneOffset.d.ts","sourceRoot":"","sources":["../../src/components/TimeZoneOffset.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAA4B,MAAM,cAAc,CAAA;AAClE,OAAO,EAAE,kBAAkB,EAAkC,MAAM,SAAS,CAAA;AAG5E,eAAO,MAAM,gBAAgB,UAA2B,CAAA;AACxD,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAA;AAC1D,KAAK,KAAK,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAA;AACtE,MAAM,MAAM,MAAM,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,EAAE,CAAA;AAEnE;;GAEG;AACH,qBAAa,cAAe,SAAQ,SAAS;IACzC;;;;;OAKG;gBAEC,IAAI,EAAE,UAAU,EAChB,KAAK,EAAE,kBAAkB,GAAG,IAAI,EAChC,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM;gBAER,SAAS,EAAE,SAAS;IAwBhC,QAAQ,IAAI,IAAI;IAchB;;;OAGG;IACH,QAAQ,IAAI,kBAAkB;IAI9B;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,kBAAkB,GAAG,IAAI,GAAG,IAAI;IAIhD;;;OAGG;IACH,aAAa,IAAI,MAAM;IAIvB;;;;OAIG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAIlC;;;OAGG;IACH,WAAW,IAAI,MAAM;IAIrB;;;;OAIG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAIhC,UAAU,IAAI,MAAM,GAAG,SAAS;IAIhC,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAI/B,aAAa;IAIb;;;OAGG;IACH,eAAe,IAAI,MAAM,GAAG,SAAS;IAIrC;;;;;;OAMG;IACH,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAIpC;;OAEG;IACH,kBAAkB;IAMlB;;;;OAIG;IACH,KAAK,QA5FO,kBAAkB,CA4FT;IAErB;;;;OAIG;IACH,UAAU,QAlFO,MAAM,CAkFQ;IAE/B;;;;OAIG;IACH,QAAQ,QAxEO,MAAM,CAwEM;IAE3B;;OAEG;IACH,OAAO,QAhEO,MAAM,GAAG,SAAS,CAgEP;IAEzB;;;;OAIG;IACH,YAAY,QAvDO,MAAM,GAAG,SAAS,CAuDF;CACtC"}

package/lib/components/TimeZoneOffset.js

@@ -0,0 +1,148 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TimeZoneOffset = exports.knownOffsetTypes = void 0;
+const component_1 = require("../component");
+const date_1 = require("../date");
+exports.knownOffsetTypes = ['DAYLIGHT', 'STANDARD'];
+/**
+ * Represents a STANDARD or DAYLIGHT subcomponent, defining a time zone offset.
+ */
+class TimeZoneOffset extends component_1.Component {
+    constructor(a, b, c, d) {
+        let component;
+        if (a instanceof component_1.Component) {
+            component = a;
+            TimeZoneOffset.prototype.validate.call(component);
+        }
+        else {
+            const name = a;
+            const start = (0, date_1.convertDate)(b);
+            const offsetFrom = c;
+            const offsetTo = d;
+            component = new component_1.Component(name);
+            component.setProperty('DTSTART', start);
+            component.setProperty('TZOFFSETFROM', offsetFrom);
+            component.setProperty('TZOFFSETTO', offsetTo);
+        }
+        super(component.name, component.properties, component.components);
+    }
+    validate() {
+        if (!exports.knownOffsetTypes.includes(this.name)) {
+            throw new component_1.ComponentValidationError('Component name must be STANDARD or DAYLIGHT');
+        }
+        const requiredProperties = [
+            'DTSTART',
+            'TZOFFSETFROM',
+            'TZOFFSETTO',
+        ];
+        this.validateAllProperties(requiredProperties);
+    }
+    /**
+     * Get the date or time when this time zone offset starts.
+     * @returns The start date or time of this time zone offset.
+     */
+    getStart() {
+        return (0, date_1.parseDateProperty)(this.getProperty('DTSTART'));
+    }
+    /**
+     * Set the date or time when this time zone offset starts.
+     * @param value The start date or time.
+     * @returns The TimeZoneOffset instance for chaining.
+     */
+    setStart(value) {
+        return this.setProperty('DTSTART', (0, date_1.convertDate)(value));
+    }
+    /**
+     * Get the offset which is offset from during this time zone offset.
+     * @returns The offset in a format such as "+0100" or "-0230".
+     */
+    getOffsetFrom() {
+        return this.getProperty('TZOFFSETFROM').value;
+    }
+    /**
+     * Set the offset to offset from during this time zone offset.
+     * @param value An offset such as "+0100" or "-0230".
+     * @returns The TimeZoneOffset instance for chaining.
+     */
+    setOffsetFrom(value) {
+        return this.setProperty('TZOFFSETFROM', value);
+    }
+    /**
+     * Get the offset which is offset to during this time zone offset.
+     * @returns The offset in a format such as "+0100" or "-0230".
+     */
+    getOffsetTo() {
+        return this.getProperty('TZOFFSETTO').value;
+    }
+    /**
+     * Set the offset to offset to during this time zone offset.
+     * @param value An offset such as "+0100" or "-0230".
+     * @returns The TimeZoneOffset instance for chaining.
+     */
+    setOffsetTo(value) {
+        return this.setProperty('TZOFFSETTO', value);
+    }
+    getComment() {
+        return this.getProperty('COMMENT')?.value;
+    }
+    setComment(value) {
+        return this.setProperty('COMMENT', value);
+    }
+    removeComment() {
+        this.removePropertiesWithName('COMMENT');
+    }
+    /**
+     * Get the name of this time zone offset.
+     * @returns The time zone offset name if it exists.
+     */
+    getTimeZoneName() {
+        return this.getProperty('TZNAME')?.value;
+    }
+    /**
+     * Set the name of this time zone offset.
+     * @param value The new name.
+     * @returns The TimeZoneOffset instance for chaining.
+     * @example
+     * timeZoneOffset.setTimeZoneName('EST')
+     */
+    setTimeZoneName(value) {
+        return this.setProperty('TZNAME', value);
+    }
+    /**
+     * Remove the name of this time zone offset.
+     */
+    removeTimeZoneName() {
+        this.removePropertiesWithName('TZNAME');
+    }
+    /* eslint-disable */
+    /**
+     * Get the date or time when this time zone offset starts.
+     * @returns The start date or time of this time zone offset.
+     * @deprecated Use {@link getStart} instead.
+     */
+    start = this.getStart;
+    /**
+     * Get the offset which is offset from during this time zone offset.
+     * @returns The offset in a format such as "+0100" or "-0230".
+     * @deprecated Use {@link getOffsetFrom} instead.
+     */
+    offsetFrom = this.getOffsetFrom;
+    /**
+     * Get the offset which is offset to during this time zone offset.
+     * @returns The offset in a format such as "+0100" or "-0230".
+     * @deprecated Use {@link getOffsetTo} instead.
+     */
+    offsetTo = this.getOffsetTo;
+    /**
+     * @deprecated Use {@link getComment} instead.
+     */
+    comment = this.getComment;
+    /**
+     * Get the name of this time zone offset.
+     * @returns The time zone offset name if it exists.
+     * @deprecated Use {@link getTimeZoneName} instead.
+     */
+    timeZoneName = this.getTimeZoneName;
+}
+exports.TimeZoneOffset = TimeZoneOffset;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiVGltZVpvbmVPZmZzZXQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY29tcG9uZW50cy9UaW1lWm9uZU9mZnNldC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSw0Q0FBa0U7QUFDbEUsa0NBQTRFO0FBRy9ELFFBQUEsZ0JBQWdCLEdBQUcsQ0FBQyxVQUFVLEVBQUUsVUFBVSxDQUFDLENBQUE7QUFLeEQ7O0dBRUc7QUFDSCxNQUFhLGNBQWUsU0FBUSxxQkFBUztJQWN6QyxZQUNJLENBQXlCLEVBQ3pCLENBQTZCLEVBQzdCLENBQVUsRUFDVixDQUFVO1FBRVYsSUFBSSxTQUFvQixDQUFBO1FBQ3hCLElBQUksQ0FBQyxZQUFZLHFCQUFTLEVBQUUsQ0FBQztZQUN6QixTQUFTLEdBQUcsQ0FBYyxDQUFBO1lBQzFCLGNBQWMsQ0FBQyxTQUFTLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxTQUFTLENBQUMsQ0FBQTtRQUNyRCxDQUFDO2FBQU0sQ0FBQztZQUNKLE1BQU0sSUFBSSxHQUFHLENBQWUsQ0FBQTtZQUM1QixNQUFNLEtBQUssR0FBRyxJQUFBLGtCQUFXLEVBQUMsQ0FBRSxDQUFDLENBQUE7WUFDN0IsTUFBTSxVQUFVLEdBQUcsQ0FBVyxDQUFBO1lBQzlCLE1BQU0sUUFBUSxHQUFHLENBQVcsQ0FBQTtZQUM1QixTQUFTLEdBQUcsSUFBSSxxQkFBUyxDQUFDLElBQUksQ0FBQyxDQUFBO1lBQy9CLFNBQVMsQ0FBQyxXQUFXLENBQUMsU0FBUyxFQUFFLEtBQUssQ0FBQyxDQUFBO1lBQ3ZDLFNBQVMsQ0FBQyxXQUFXLENBQUMsY0FBYyxFQUFFLFVBQVUsQ0FBQyxDQUFBO1lBQ2pELFNBQVMsQ0FBQyxXQUFXLENBQUMsWUFBWSxFQUFFLFFBQVEsQ0FBQyxDQUFBO1FBQ2pELENBQUM7UUFDRCxLQUFLLENBQUMsU0FBUyxDQUFDLElBQUksRUFBRSxTQUFTLENBQUMsVUFBVSxFQUFFLFNBQVMsQ0FBQyxVQUFVLENBQUMsQ0FBQTtJQUNyRSxDQUFDO0lBRUQsUUFBUTtRQUNKLElBQUksQ0FBQyx3QkFBZ0IsQ0FBQyxRQUFRLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxFQUFFLENBQUM7WUFDeEMsTUFBTSxJQUFJLG9DQUF3QixDQUM5Qiw2Q0FBNkMsQ0FDaEQsQ0FBQTtRQUNMLENBQUM7UUFDRCxNQUFNLGtCQUFrQixHQUEwQjtZQUM5QyxTQUFTO1lBQ1QsY0FBYztZQUNkLFlBQVk7U0FDZixDQUFBO1FBQ0QsSUFBSSxDQUFDLHFCQUFxQixDQUFDLGtCQUFrQixDQUFDLENBQUE7SUFDbEQsQ0FBQztJQUVEOzs7T0FHRztJQUNILFFBQVE7UUFDSixPQUFPLElBQUEsd0JBQWlCLEVBQUMsSUFBSSxDQUFDLFdBQVcsQ0FBQyxTQUFTLENBQUUsQ0FBQyxDQUFBO0lBQzFELENBQUM7SUFFRDs7OztPQUlHO0lBQ0gsUUFBUSxDQUFDLEtBQWdDO1FBQ3JDLE9BQU8sSUFBSSxDQUFDLFdBQVcsQ0FBQyxTQUFTLEVBQUUsSUFBQSxrQkFBVyxFQUFDLEtBQUssQ0FBQyxDQUFDLENBQUE7SUFDMUQsQ0FBQztJQUVEOzs7T0FHRztJQUNILGFBQWE7UUFDVCxPQUFPLElBQUksQ0FBQyxXQUFXLENBQUMsY0FBYyxDQUFFLENBQUMsS0FBZSxDQUFBO0lBQzVELENBQUM7SUFFRDs7OztPQUlHO0lBQ0gsYUFBYSxDQUFDLEtBQWE7UUFDdkIsT0FBTyxJQUFJLENBQUMsV0FBVyxDQUFDLGNBQWMsRUFBRSxLQUFLLENBQUMsQ0FBQTtJQUNsRCxDQUFDO0lBRUQ7OztPQUdHO0lBQ0gsV0FBVztRQUNQLE9BQU8sSUFBSSxDQUFDLFdBQVcsQ0FBQyxZQUFZLENBQUUsQ0FBQyxLQUFlLENBQUE7SUFDMUQsQ0FBQztJQUVEOzs7O09BSUc7SUFDSCxXQUFXLENBQUMsS0FBYTtRQUNyQixPQUFPLElBQUksQ0FBQyxXQUFXLENBQUMsWUFBWSxFQUFFLEtBQUssQ0FBQyxDQUFBO0lBQ2hELENBQUM7SUFFRCxVQUFVO1FBQ04sT0FBTyxJQUFJLENBQUMsV0FBVyxDQUFDLFNBQVMsQ0FBQyxFQUFFLEtBQUssQ0FBQTtJQUM3QyxDQUFDO0lBRUQsVUFBVSxDQUFDLEtBQWE7UUFDcEIsT0FBTyxJQUFJLENBQUMsV0FBVyxDQUFDLFNBQVMsRUFBRSxLQUFLLENBQUMsQ0FBQTtJQUM3QyxDQUFDO0lBRUQsYUFBYTtRQUNULElBQUksQ0FBQyx3QkFBd0IsQ0FBQyxTQUFTLENBQUMsQ0FBQTtJQUM1QyxDQUFDO0lBRUQ7OztPQUdHO0lBQ0gsZUFBZTtRQUNYLE9BQU8sSUFBSSxDQUFDLFdBQVcsQ0FBQyxRQUFRLENBQUMsRUFBRSxLQUFLLENBQUE7SUFDNUMsQ0FBQztJQUVEOzs7Ozs7T0FNRztJQUNILGVBQWUsQ0FBQyxLQUFhO1FBQ3pCLE9BQU8sSUFBSSxDQUFDLFdBQVcsQ0FBQyxRQUFRLEVBQUUsS0FBSyxDQUFDLENBQUE7SUFDNUMsQ0FBQztJQUVEOztPQUVHO0lBQ0gsa0JBQWtCO1FBQ2QsSUFBSSxDQUFDLHdCQUF3QixDQUFDLFFBQVEsQ0FBQyxDQUFBO0lBQzNDLENBQUM7SUFFRCxvQkFBb0I7SUFFcEI7Ozs7T0FJRztJQUNILEtBQUssR0FBRyxJQUFJLENBQUMsUUFBUSxDQUFBO0lBRXJCOzs7O09BSUc7SUFDSCxVQUFVLEdBQUcsSUFBSSxDQUFDLGFBQWEsQ0FBQTtJQUUvQjs7OztPQUlHO0lBQ0gsUUFBUSxHQUFHLElBQUksQ0FBQyxXQUFXLENBQUE7SUFFM0I7O09BRUc7SUFDSCxPQUFPLEdBQUcsSUFBSSxDQUFDLFVBQVUsQ0FBQTtJQUV6Qjs7OztPQUlHO0lBQ0gsWUFBWSxHQUFHLElBQUksQ0FBQyxlQUFlLENBQUE7Q0FDdEM7QUE5S0Qsd0NBOEtDIn0=

package/lib/components/index.d.ts

@@ -1,4 +1,5 @@
 export * from './Calendar';
 export * from './CalendarEvent';
 export * from './TimeZone';
+export * from './TimeZoneOffset';
 //# sourceMappingURL=index.d.ts.map

package/lib/components/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/components/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,YAAY,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/components/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,YAAY,CAAA;AAC1B,cAAc,kBAAkB,CAAA"}

package/lib/components/index.js

@@ -17,4 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./Calendar"), exports);
 __exportStar(require("./CalendarEvent"), exports);
 __exportStar(require("./TimeZone"), exports);
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY29tcG9uZW50cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7Ozs7Ozs7O0FBQUEsNkNBQTBCO0FBQzFCLGtEQUErQjtBQUMvQiw2Q0FBMEIifQ==
+__exportStar(require("./TimeZoneOffset"), exports);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY29tcG9uZW50cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7Ozs7Ozs7O0FBQUEsNkNBQTBCO0FBQzFCLGtEQUErQjtBQUMvQiw2Q0FBMEI7QUFDMUIsbURBQWdDIn0=

package/lib/date.d.ts

@@ -0,0 +1,165 @@
+import { type Property } from './property';
+export declare const ONE_SECOND_MS = 1000;
+export declare const ONE_MINUTE_MS: number;
+export declare const ONE_HOUR_MS: number;
+export declare const ONE_DAY_MS: number;
+export interface CalendarDateOrTime {
+    /**
+     * Create a property from this date.
+     * @param name The name of the property.
+     */
+    toProperty(name: string): Property;
+    /**
+     * Get the string value of this date.
+     * @returns An iCalendar date or date-time string.
+     */
+    getValue(): string;
+    /**
+     * Get the date value of this date. For {@link CalendarDate} this is the
+     * time at the start of the day.
+     * @returns The date value of this date.
+     */
+    getDate(): Date;
+    /**
+     * Check if this date represents a full day, as opposed to a date-time.
+     * @returns `true` if this object is a {@link CalendarDate}.
+     */
+    isFullDay(): boolean;
+}
+/**
+ * Represents a DATE value as defined by RFC5545.
+ * This is a date without a time, representing a whole day.
+ */
+export declare class CalendarDate implements CalendarDateOrTime {
+    private date;
+    constructor(date: Date | string | CalendarDateOrTime);
+    toProperty(name: string): Property;
+    getValue(): string;
+    getDate(): Date;
+    isFullDay(): boolean;
+}
+export declare class CalendarDateTime implements CalendarDateOrTime {
+    private date;
+    constructor(date: Date | string | CalendarDateOrTime);
+    toProperty(name: string): Property;
+    getValue(): string;
+    getDate(): Date;
+    isFullDay(): boolean;
+}
+/**
+ * Pad a number with leading zeros.
+ * @param num The number to pad with zeros.
+ * @param length How many digits the resulting string should have.
+ * @returns The padded string.
+ * @throws If the digits of `num` is greater than `length`.
+ * @throws If `num` is NaN, a decimal or negative.
+ * @throws If `length` is not NaN, a decimal or less than 1.
+ */
+export declare function padZeros(num: number, length: number): string;
+/**
+ * Pad zeros for the year component of a date string.
+ * @param year The year, should be positive.
+ * @returns The 4-digit padded year.
+ */
+export declare function padYear(year: number): string;
+/**
+ * Pad zeros for the month component of a date string.
+ * @param month The month, should be between 1 and 12.
+ * @returns The 2-digit padded month.
+ */
+export declare function padMonth(month: number): string;
+/**
+ * Pad zeros for the day component of a date string.
+ * @param day The day, should be between 1 and 31.
+ * @returns The 2-digit padded day.
+ */
+export declare function padDay(day: number): string;
+/**
+ * Pad zeros for the hours component of a time string.
+ * @param hours The hours, should be between 0 and 23.
+ * @returns The 2-digit padded hours.
+ */
+export declare function padHours(hours: number): string;
+/**
+ * Pad zeros for the minutes component of a time string.
+ * @param minutes The minutes, should be between 0 and 59.
+ * @returns The 2-digit padded minutes.
+ */
+export declare function padMinutes(minutes: number): string;
+/**
+ * Pad zeros for the seconds component of a time string.
+ * @param seconds The seconds, should be between 0 and 59.
+ * @returns The 2-digit padded seconds.
+ */
+export declare function padSeconds(seconds: number): string;
+/**
+ * Parse a date property into a {@link CalendarDateOrTime}.
+ * @param dateProperty The property to parse.
+ * @param defaultType The default value type to be used if the property does not have an explicit value type.
+ * @returns The parsed date as a {@link CalendarDateOrTime}.
+ * @throws If the value is invalid for the value type.
+ * @throws If the value type is not `DATE-TIME` or `DATE`.
+ */
+export declare function parseDateProperty(dateProperty: Property, defaultType?: 'DATE-TIME' | 'DATE'): CalendarDateOrTime;
+/**
+ * Format a date as an iCalendar compatible time string. The day of the date is
+ * ignored.
+ * @param date The date to convert to a time string.
+ * @returns The time of the date formatted according to the iCalendar specification.
+ * @throws If the date is invalid.
+ */
+export declare function toTimeString(date: Date): string;
+/**
+ * Format a date as an iCalendar compatible date string.
+ * @param date The date to convert to a date string.
+ * @returns A date string formatted according to the iCalendar specification.
+ * @throws If the date is invalid.
+ */
+export declare function toDateString(date: Date): string;
+/**
+ * Format a date as an iCalendar compatible date-time string.
+ * @param date The date to convert to a date-time string.
+ * @returns A date-time string formatted according to the iCalendar specification.
+ * @throws If the date is invalid.
+ */
+export declare function toDateTimeString(date: Date): string;
+/**
+ * Format a date as an iCalendar compatible date-time string. Offsets the date
+ * to UTC using `timeZoneOffset`.
+ * @param date The date in local time to convert to UTC and a date-time string.
+ * @param timeZoneOffset The timezone offset in minutes.
+ * @returns A UTC date-time string formatted according to the iCalendar specification.
+ * @throws If the date is invalid.
+ * @throws If the offset is invalid.
+ * @example
+ * // The timezone offset for CET (Central European Time)
+ * const timeZoneOffsetCET = -60 // +01:00
+ * const date = new Date('2025-08-07T12:00:00') // The time in CET
+ * // Returns "20250807T110000Z"
+ * const utcDate = toDateTimeStringUTC(date, timeZoneOffsetCET)
+ */
+export declare function toDateTimeStringUTC(date: Date, timeZoneOffset: number): string;
+/**
+ * Parse a date-time string to a `Date`.
+ * @param dateTime A date-time string formatted according to the iCalendar specification.
+ * @returns The parsed date-time.
+ * @throws If the date is invalid.
+ */
+export declare function parseDateTimeString(dateTime: string): Date;
+/**
+ * Parse a date string to a `Date`.
+ * @param date A date-time string formatted according to the iCalendar specification.
+ * @returns The parsed date.
+ * @throws If the date is invalid.
+ */
+export declare function parseDateString(date: string): Date;
+/**
+ * Convert `Date` objects to a {@link CalendarDateOrTime} object or return as
+ * is if `date` is already a {@link CalendarDateOrTime}.
+ * @param date The date object to convert.
+ * @param fullDay If `true`, a `Date` object is converted to {@link CalendarDate}, otherwise `Date` is converted to {@link CalendarDateTime}.
+ * @returns A {@link CalendarDateOrTime} as described above.
+ */
+export declare function convertDate<T extends CalendarDateOrTime>(date: Date | T, fullDay?: false): T | CalendarDateTime;
+export declare function convertDate<T extends CalendarDateOrTime>(date: Date | T, fullDay: true): T | CalendarDate;
+//# sourceMappingURL=date.d.ts.map