@kenjiuno/msgreader - npm Package Compare versions

Comparing version 1.17.0-alpha.5 to 1.17.0-alpha.6

lib/AppointmentRecurParser.d.ts

@@ -154,9 +154,11 @@ import DataStream from "./DataStream";
     /**
-     * - Sa (1 bit):  (0x00000040) The event occurs on Saturday.
-     * - F (1 bit):  (0x00000020) The event occurs on Friday.
-     * - Th (1 bit):  (0x00000010) The event occurs on Thursday.
-     * - W (1 bit):  (0x00000008) The event occurs on Wednesday.
-     * - Tu (1 bit):  (0x00000004) The event occurs on Tuesday.
-     * - M (1 bit):  (0x00000002) The event occurs on Monday.
-     * - Su (1 bit):  (0x00000001) The event occurs on Sunday.
+     * ```
+     * Sa (1 bit):  (0x00000040) The event occurs on Saturday.
+     * F  (1 bit):  (0x00000020) The event occurs on Friday.
+     * Th (1 bit):  (0x00000010) The event occurs on Thursday.
+     * W  (1 bit):  (0x00000008) The event occurs on Wednesday.
+     * Tu (1 bit):  (0x00000004) The event occurs on Tuesday.
+     * M  (1 bit):  (0x00000002) The event occurs on Monday.
+     * Su (1 bit):  (0x00000001) The event occurs on Sunday.
+     * ```
      */
@@ -183,9 +185,11 @@ dayOfWeekBits: number;
     /**
-     * - Sa (1 bit):  The event occurs on Saturday.
-     * - F (1 bit):  The event occurs on Friday.
-     * - Th (1 bit):  The event occurs on Thursday.
-     * - W (1 bit):  The event occurs on Wednesday.
-     * - Tu (1 bit):  The event occurs on Tuesday.
-     * - M (1 bit):  The event occurs on Monday.
-     * - Su (1 bit):  The event occurs on Sunday.
+     * ```
+     * Sa (1 bit):  (0x00000040) The event occurs on Saturday.
+     * F  (1 bit):  (0x00000020) The event occurs on Friday.
+     * Th (1 bit):  (0x00000010) The event occurs on Thursday.
+     * W  (1 bit):  (0x00000008) The event occurs on Wednesday.
+     * Tu (1 bit):  (0x00000004) The event occurs on Tuesday.
+     * M  (1 bit):  (0x00000002) The event occurs on Monday.
+     * Su (1 bit):  (0x00000001) The event occurs on Sunday.
+     * ```
      */
@@ -197,2 +201,10 @@ dayOfWeekBits: number;
      * It MUST be equal to one of the values listed in the following table.
+     *
+     * Name   | Value      | Meaning
+     * -------|------------|---------------------------------------------------------------------------------------
+     * First  | 0x00000001 | The recurrence falls on the first occurrence of the days specified in every month.
+     * Second | 0x00000002 | The recurrence falls on the second occurrence of the days specified in every month.
+     * Third  | 0x00000003 | The recurrence falls on the third occurrence of the days specified in every month.
+     * Fourth | 0x00000004 | The recurrence falls on the fourth occurrence of the days specified in every month.
+     * Last   | 0x00000005 | The recurrence falls on the last occurrence of the days specified in every month.
      */
@@ -204,2 +216,9 @@ n: number;
  *
+ * Quick code snippet to obtain JavaScript date from Gregorian calendar:
+ *
+ * ```js
+ * new Date(-11644473600000 + startDate * 1000 * 60);
+ * new Date(-11644473600000 + endDate * 1000 * 60);
+ * ```
+ *
  * @see [[MS-OXOCAL]: RecurrencePattern Structure | Microsoft Learn](https://learn.microsoft.com/en-us/openspecs/exchange_server_protocols/ms-oxocal/cf7153b4-f8b5-4cb6-bf14-e78d21f94814)
@@ -225,2 +244,13 @@ */
      * The valid recurrence pattern types are listed in the following table.
+     *
+     * Name       | Value  | Meaning
+     * -----------|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------
+     * Day        | 0x0000 | The event has a daily recurrence.
+     * Week       | 0x0001 | The event has a weekly recurrence.
+     * Month      | 0x0002 | The event has a monthly recurrence.
+     * MonthEnd   | 0x0004 | The event has a month-end recurrence.
+     * MonthNth   | 0x0003 | The event has an every nth month pattern.
+     * HjMonth    | 0x000A | The event has a monthly recurrence in the Hijri calendar. For this value in the PatternType field, the value of the CalendarType field SHOULD be set to 0x0000.
+     * HjMonthNth | 0x000B | The event has an every nth month pattern in the Hijri calendar. For this value in the PatternType field, the value of the CalendarType field MUST be set to 0x0000.
+     * HjMonthEnd | 0x000C | The event has a month end recurrence in the Hijri calendar. For this value in the PatternType field, the value of the CalendarType field MUST be set to 0x0000.
      */
@@ -232,2 +262,26 @@ patternType: PatternType;
      * The acceptable values for the calendar type are listed in the following table.
+     *
+     * Name                       | Value  | Meaning
+     * ---------------------------|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+     * Default                    | 0x0000 | The default value for the calendar type is Gregorian. If the value of the PatternType field is HjMonth, HjMonthNth, or HjMonthEnd and the value of the CalendarType field is Default, this recurrence uses the Hijri calendar.
+     * CAL_GREGORIAN              | 0x0001 | Gregorian (localized) calendar
+     * CAL_GREGORIAN_US           | 0x0002 | Gregorian (U.S.) calendar
+     * CAL_JAPAN                  | 0x0003 | Japanese Emperor era calendar
+     * CAL_TAIWAN                 | 0x0004 | Taiwan calendar
+     * CAL_KOREA                  | 0x0005 | Korean Tangun era calendar
+     * CAL_HIJRI                  | 0x0006 | Hijri (Arabic Lunar) calendar
+     * CAL_THAI                   | 0x0007 | Thai calendar
+     * CAL_HEBREW                 | 0x0008 | Hebrew lunar calendar
+     * CAL_GREGORIAN_ME_FRENCH    | 0x0009 | Gregorian Middle East French calendar
+     * CAL_GREGORIAN_ARABIC       | 0x000A | Gregorian Arabic calendar
+     * CAL_GREGORIAN_XLIT_ENGLISH | 0x000B | Gregorian transliterated English calendar
+     * CAL_GREGORIAN_XLIT_FRENCH  | 0x000C | Gregorian transliterated French calendar
+     * CAL_LUNAR_JAPANESE         | 0x000E | Japanese lunar calendar
+     * CAL_CHINESE_LUNAR          | 0x000F | Chinese lunar calendar
+     * CAL_SAKA                   | 0x0010 | Saka era calendar
+     * CAL_LUNAR_ETO_CHN          | 0x0011 | Lunar ETO Chinese calendar
+     * CAL_LUNAR_ETO_KOR          | 0x0012 | Lunar ETO Korean calendar
+     * CAL_LUNAR_ROKUYOU          | 0x0013 | Lunar Rokuyou calendar
+     * CAL_LUNAR_KOREAN           | 0x0014 | Korean lunar calendar
+     * CAL_UMALQURA               | 0x0017 | Um Al Qura calendar
      */
@@ -241,3 +295,3 @@ calendarType: CalendarType;
      * The value of the FirstDateTime field is used to determine the valid dates of a recurring series,
-     * as specified in section 2.2.1.44.1.2.
+     * as specified in section [2.2.1.44.1.2](https://learn.microsoft.com/en-us/openspecs/exchange_server_protocols/ms-oxocal/181a11eb-0f26-4d8f-8292-8c77dcfb03e3).
      */
@@ -247,8 +301,14 @@ firstDateTime: number;
      * An integer that specifies the interval at which the meeting pattern specified in
-     * PatternTypeSpecific field repeats. The Period value MUST be between 1 and the maximum recurrence interval,
-     * which is 999 days for daily recurrences, 99 weeks for weekly recurrences,
-     * and 99 months for monthly recurrences.
+     * PatternTypeSpecific field repeats. The {@link period} value MUST be between 1 and the
+     * maximum recurrence interval, which is 999 days for daily recurrences,
+     * 99 weeks for weekly recurrences, and 99 months for monthly recurrences.
      *
      * The following table lists the values for this field based on the recurrence frequency,
-     * which is specified in the RecurFrequency field.
+     * which is specified in the {@link recurFrequency} field.
+     *
+     * Frequency                    | Value
+     * -----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+     * Daily recurrence             | The period is stored as the minutes in whole number of days. For example, to define a recurrence that occurs every two days, the {@link period} field is set to 0x00000B40, which equals 2880 minutes, or two days.
+     * Weekly recurrence            | The period is stored in weeks. For example, if the {@link period} field is set to 0x00000002, the meeting occurs every two weeks.
+     * Monthly or yearly recurrence | The period is stored in months. If the recurrence is a yearly recurrence, The {@link period} field MUST be set to 12.
      */
@@ -258,3 +318,4 @@ period: number;
      * This field is only used for scheduling tasks; otherwise the value MUST be zero (0).
-     * For more details about sliding tasks, see [MS-OXOTASK] section 3.1.4.6.2.
+     * For more details about sliding tasks, see [[MS-OXOTASK]](https://learn.microsoft.com/en-us/openspecs/exchange_server_protocols/ms-oxotask/55600ec0-6195-4730-8436-59c7931ef27e)
+     * section [3.1.4.6.2](https://learn.microsoft.com/en-us/openspecs/exchange_server_protocols/ms-oxotask/860665d1-b309-4a64-9e8a-7051126ad7ee).
      */
@@ -269,2 +330,8 @@ slidingFlag: number;
      * This field MUST be set to one of the values listed in the following table.
+     *
+     * Recurrence range type   | Value
+     * ------------------------|-------------------------------------------
+     * End after date          | 0x00002021
+     * End after N occurrences | 0x00002022
+     * Never end               | SHOULD be 0x00002023 but can be 0xFFFFFFFF
      */
@@ -282,2 +349,12 @@ endType: EndType;
      * This field MUST be set to one of the values listed in the following table.
+     *
+     * Day       | Value
+     * ----------|-----------
+     * Sunday    | 0x00000000
+     * Monday    | 0x00000001
+     * Tuesday   | 0x00000002
+     * Wednesday | 0x00000003
+     * Thursday  | 0x00000004
+     * Friday    | 0x00000005
+     * Saturday  | 0x00000006
      */
@@ -305,3 +382,3 @@ firstDOW: number;
      * and midnight of the specified day, in the time zone specified by the
-     * PidLidTimeZoneStruct property (section 2.2.1.39).
+     * PidLidTimeZoneStruct property (section [2.2.1.39](https://learn.microsoft.com/en-us/openspecs/exchange_server_protocols/ms-oxocal/c7d7d00f-984c-4af6-9634-8c602eb05b5f)).
      *
@@ -404,2 +481,15 @@ * The dates are ordered from earliest to latest.
      * The valid flags for this field are summarized in the following table.
+     *
+     * Flag                 | Value  | Meaning
+     * ---------------------|--------|--------------------------------------------------------------------------------------------------------------------------------------
+     * ARO_SUBJECT          | 0x0001 | Indicates that the Subject, SubjectLength, and SubjectLength2 fields are present.
+     * ARO_MEETINGTYPE      | 0x0002 | Indicates that the MeetingType field is present.
+     * ARO_REMINDERDELTA    | 0x0004 | Indicates that the ReminderDelta field is present.
+     * ARO_REMINDER         | 0x0008 | Indicates that the ReminderSet field is present.
+     * ARO_LOCATION         | 0x0010 | Indicates that the Location, LocationLength, and LocationLength2 fields are present.
+     * ARO_BUSYSTATUS       | 0x0020 | Indicates that the BusyStatus field is present.
+     * ARO_ATTACHMENT       | 0x0040 | Indicates that the attachment field is present.
+     * ARO_SUBTYPE          | 0x0080 | Indicates that the SubType field is present.
+     * ARO_APPTCOLOR        | 0x0100 | Indicates that the AppointmentColor field is present.
+     * ARO_EXCEPTIONAL_BODY | 0x0200 | Indicates that the [Exception Embedded Message object](https://learn.microsoft.com/en-us/openspecs/exchange_server_protocols/ms-oxocal/ffc6fee6-5a9b-418f-be28-457cc707e665#gt_e37f1f62-1a3d-4744-84cb-8de32536fcfc) has the PidTagRtfCompressed property ([[MS-OXCMSG]](https://learn.microsoft.com/en-us/openspecs/exchange_server_protocols/ms-oxcmsg/7fd7ec40-deec-4c06-9493-1bc06b349682) section [2.2.1.56.4](https://learn.microsoft.com/en-us/openspecs/exchange_server_protocols/ms-oxcmsg/fcb7ba29-c4d5-4298-bbf6-1182dc88c018)) set on it.
      */
@@ -409,23 +499,42 @@ overrideFlags: OverrideFlags;
      * A non-null-terminated, non-Unicode string that is the value of the PidTagNormalizedSubject property
-     * ([MS-OXCMSG] section 2.2.1.10) in the Exception Embedded Message object.
+     * ([[MS-OXCMSG]](https://learn.microsoft.com/en-us/openspecs/exchange_server_protocols/ms-oxcmsg/7fd7ec40-deec-4c06-9493-1bc06b349682)
+     * section [2.2.1.10](https://learn.microsoft.com/en-us/openspecs/exchange_server_protocols/ms-oxcmsg/44445cab-af0d-4098-96e8-92ca96f08a73)) in the Exception Embedded Message object.
+     *
+     * -or-
+     *
+     * The Unicode string value for the exception's PidTagNormalizedSubject property ([[MS-OXCMSG]](https://learn.microsoft.com/en-us/openspecs/exchange_server_protocols/ms-oxcmsg/7fd7ec40-deec-4c06-9493-1bc06b349682)
+     * section [2.2.1.10](https://learn.microsoft.com/en-us/openspecs/exchange_server_protocols/ms-oxcmsg/44445cab-af0d-4098-96e8-92ca96f08a73)).
+     * Note that the WideCharSubject field is not null-terminated.
      */
     subject?: string;
     /**
-     * The value of the PidLidAppointmentStateFlags property (section 2.2.1.10) in the Exception Embedded Message object.
+     * The value of the PidLidAppointmentStateFlags property (section [2.2.1.10](https://learn.microsoft.com/en-us/openspecs/exchange_server_protocols/ms-oxocal/9be16fe9-810e-40d1-9f2a-27b2803fe911))
+     * in the Exception Embedded Message object.
      */
     meetingType?: number;
     /**
-     * The value for the PidLidReminderDelta property ([MS-OXORMDR] section 2.2.1.3) in the Exception Embedded Message object.
+     * The value for the PidLidReminderDelta property ([[MS-OXORMDR]](https://learn.microsoft.com/en-us/openspecs/exchange_server_protocols/ms-oxormdr/5454ebcc-e5d1-4da8-a598-d393b101caab)
+     * section [2.2.1.3](https://learn.microsoft.com/en-us/openspecs/exchange_server_protocols/ms-oxormdr/e2d6fb35-1d7e-41a9-9053-e14cbc12c38c))
+     * in the Exception Embedded Message object.
      */
     reminderDelta?: number;
     /**
-     * The value for the PidLidReminderSet property ([MS-OXORMDR] section 2.2.1.1) in the Exception Embedded Message object.
+     * The value for the PidLidReminderSet property ([[MS-OXORMDR]](https://learn.microsoft.com/en-us/openspecs/exchange_server_protocols/ms-oxormdr/5454ebcc-e5d1-4da8-a598-d393b101caab)
+     * section [2.2.1.1](https://learn.microsoft.com/en-us/openspecs/exchange_server_protocols/ms-oxormdr/5a387ab7-3c6b-4e5d-b207-43aca5470c94))
+     * in the Exception Embedded Message object.
      */
     reminderSet?: number;
     /**
-     * A non-Unicode string that is the value of the PidLidLocation property (section 2.2.1.4) in the Exception Embedded Message object.
+     * A non-Unicode string that is the value of the PidLidLocation property (section [2.2.1.4](https://learn.microsoft.com/en-us/openspecs/exchange_server_protocols/ms-oxocal/a512de38-5c46-4909-8f11-181029ba70ee))
+     * in the Exception Embedded Message object.
+     *
+     * -or-
+     *
+     * The Unicode string value for the PidLidLocation property (section [2.2.1.4](https://learn.microsoft.com/en-us/openspecs/exchange_server_protocols/ms-oxocal/a512de38-5c46-4909-8f11-181029ba70ee))
+     * in the Exception Embedded Message object. Note that the WideCharLocation field is not null-terminated.
      */
     location?: string;
     /**
-     * The value for the PidLidBusyStatus property (section 2.2.1.2) in the Exception Embedded Message object.
+     * The value for the PidLidBusyStatus property (section [2.2.1.2](https://learn.microsoft.com/en-us/openspecs/exchange_server_protocols/ms-oxocal/1ff3f49b-458f-4ed7-928e-711d9bfc09ac))
+     * in the Exception Embedded Message object.
      *
@@ -442,3 +551,5 @@ * For possible values, see section 2.2.1.2.
     /**
-     * The value for the PidLidAppointmentSubType property (section 2.2.1.9) in the Exception Embedded Message object.
+     * The value for the PidLidAppointmentSubType property (section [2.2.1.9](https://learn.microsoft.com/en-us/openspecs/exchange_server_protocols/ms-oxocal/53421288-a85e-4790-927d-d7be13efb166))
+     * in the Exception Embedded Message object.
+     *
      * For possible values, see section 2.2.1.9.
@@ -454,3 +565,4 @@ */
     /**
-     * The value of the PidLidChangeHighlight property (section 2.2.6.2) in the Exception object.
+     * The value of the PidLidChangeHighlight property (section [2.2.6.2](https://learn.microsoft.com/en-us/openspecs/exchange_server_protocols/ms-oxocal/f77e6e3e-5f54-46d5-9315-0f96af037803))
+     * in the [Exception object](https://learn.microsoft.com/en-us/openspecs/exchange_server_protocols/ms-oxocal/ffc6fee6-5a9b-418f-be28-457cc707e665#gt_dd432053-7490-4147-b19d-7e107e8f86d4).
      */
@@ -467,3 +579,3 @@ changeHighlight?: number;
     /**
-     * This field is a RecurrencePattern structure, as specified in section 2.2.1.44.1,
+     * This field is a RecurrencePattern structure, as specified in section [2.2.1.44.1](https://learn.microsoft.com/en-us/openspecs/exchange_server_protocols/ms-oxocal/cf7153b4-f8b5-4cb6-bf14-e78d21f94814),
      * that defines the recurrences.
@@ -470,0 +582,0 @@ */

lib/MsgReader.d.ts

 import { TzDefinition } from './TZDEFINITIONParser';
 import { TzReg } from './TZREGParser';
 import { AppointmentRecur } from './AppointmentRecurParser';
-export { TzDefinitionRule, TzDefinition } from './TZDEFINITIONParser';
+export { TzDefinitionRule, TzDefinition, TransitionSystemTime } from './TZDEFINITIONParser';
 export { TzReg } from './TZREGParser';
@@ -6,0 +6,0 @@ export { RecurFrequency, PatternType, CalendarType, EndType, PatternTypeWeek, PatternTypeMonth, PatternTypeMonthNth, RecurrencePattern, OverrideFlags, ExceptionInfo, AppointmentRecur, } from './AppointmentRecurParser';

package.json

 {
   "name": "@kenjiuno/msgreader",
-  "version": "1.17.0-alpha.5",
+  "version": "1.17.0-alpha.6",
   "description": "Outlook Item File (.msg) reader in JavaScript Npm Module",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

No alert changes

Improved metrics

Total package byte prevSize

368837

increased by2.9%

Lines of code

10018

increased by1.16%

No dependency changes