@hiraokahypertools/pst-extractor 0.2.0-alpha.2 → 0.4.0-alpha.1

package/dist/IPSTTask.d.ts

@@ -0,0 +1,98 @@
+import type { IRecurrencePattern } from "./IRecurrencePattern.js";
+export interface IPSTTask {
+    /**
+     * Specifies the status of the user's progress on the task.
+     * https://msdn.microsoft.com/en-us/library/office/cc842120.aspx
+     * @readonly
+       */
+    get taskStatus(): number;
+    /**
+     * Indicates the progress the user has made on a task.
+     * https://msdn.microsoft.com/en-us/library/office/cc839932.aspx
+     * @readonly
+       */
+    get percentComplete(): number;
+    /**
+     * Specifies the date when the user completes the task.
+     * https://msdn.microsoft.com/en-us/library/office/cc815753.aspx
+     * @readonly
+       */
+    get taskDateCompleted(): Date | null;
+    /**
+     * Indicates the number of minutes that the user performed a task.
+     * https://msdn.microsoft.com/en-us/library/office/cc842253.aspx
+     * @readonly
+       */
+    get taskActualEffort(): number;
+    /**
+     * Indicates the amount of time, in minutes, that the user expects to perform a task.
+     * https://msdn.microsoft.com/en-us/library/office/cc842485.aspx
+     * @readonly
+       */
+    get taskEstimatedEffort(): number;
+    /**
+     * Indicates which copy is the latest update of a task.
+     * https://msdn.microsoft.com/en-us/library/office/cc815510.aspx
+     * @readonly
+       */
+    get taskVersion(): number;
+    /**
+     * Indicates the task is complete.
+     * https://msdn.microsoft.com/en-us/library/office/cc839514.aspx
+     * @readonly
+       */
+    get isTaskComplete(): boolean;
+    /**
+     * Contains the name of the task owner.
+     * https://msdn.microsoft.com/en-us/library/office/cc842363.aspx
+     * @readonly
+       */
+    get taskOwner(): string;
+    /**
+     * Names the user who was last assigned the task.
+     * https://msdn.microsoft.com/en-us/library/office/cc815865.aspx
+     * @readonly
+       */
+    get taskAssigner(): string;
+    /**
+     * Names the most recent user who was the task owner.
+     * https://msdn.microsoft.com/en-us/library/office/cc842278.aspx
+     * @readonly
+       */
+    get taskLastUser(): string;
+    /**
+     * Provides an aid to custom sorting tasks.
+     * https://msdn.microsoft.com/en-us/library/office/cc765654.aspx
+     * @readonly
+       */
+    get taskOrdinal(): number;
+    /**
+     * Indicates whether the task includes a recurrence pattern.
+     * https://msdn.microsoft.com/en-us/library/office/cc765875.aspx
+       */
+    get isTaskRecurring(): boolean;
+    /**
+     * https://docs.microsoft.com/en-us/office/client-developer/outlook/mapi/pidlidtaskrecurrence-canonical-property
+       */
+    get taskRecurrencePattern(): IRecurrencePattern | null;
+    /**
+     * https://docs.microsoft.com/en-us/office/client-developer/outlook/mapi/pidlidtaskdeadoccurrence-canonical-property
+       */
+    get taskDeadOccurrence(): boolean;
+    /**
+     * Indicates the role of the current user relative to the task.
+     * https://msdn.microsoft.com/en-us/library/office/cc842113.aspx
+     * @readonly
+       */
+    get taskOwnership(): number;
+    /**
+     * Indicates the acceptance state of the task.
+     * https://msdn.microsoft.com/en-us/library/office/cc839689.aspx
+     * @readonly
+       */
+    get acceptanceState(): number;
+    /**
+     * JSON stringify the object properties.
+      */
+    toJSON(): any;
+}

package/dist/IPSTTask.js

@@ -0,0 +1 @@
+export {};

package/dist/IRecurrencePattern.d.ts

@@ -0,0 +1,14 @@
+import type { EndType, MonthNthSpecific, PatternType, RecurFrequency, WeekSpecific } from "./RecurrencePattern.class.js";
+export interface IRecurrencePattern {
+    recurFrequency: RecurFrequency;
+    patternType: PatternType;
+    firstDateTime: Date;
+    period: number;
+    patternTypeSpecific: null | number | WeekSpecific | MonthNthSpecific;
+    endType: EndType;
+    occurrenceCount: number;
+    firstDOW: number;
+    startDate: Date;
+    endDate: Date;
+    toJSON(): any;
+}

package/dist/IRecurrencePattern.js

@@ -0,0 +1 @@
+export {};

package/dist/LZFu.class.d.ts

@@ -5,7 +5,6 @@ export declare class LZFu {
      * @static
      * @param {Buffer} data
      * @returns {string}
-     * @memberof LZFu
      */
     static decode(data: Buffer): string;
 }

package/dist/LZFu.class.js

@@ -6,7 +6,6 @@ export class LZFu {
      * @static
      * @param {Buffer} data
      * @returns {string}
-     * @memberof LZFu
      */
     static decode(data) {
         // const compressedSize: number = PSTUtil.convertLittleEndianBytesToLong(

package/dist/NodeMap.class.d.ts

@@ -1,8 +1,8 @@
 import Long from 'long';
 /**
  * Stores node names (both alpha and numeric) in node maps for quick lookup.
- * @export
- * @class NodeMap
+ *
+ * @internal
  */
 export declare class NodeMap {
     private nameToId;
@@ -13,7 +13,6 @@ export declare class NodeMap {
      * @param {*} key
      * @param {number} propId
      * @param {number} [idx]
-     * @memberof NodeMap
      */
     setId(key: any, propId: number, idx?: number): void;
     /**
@@ -21,14 +20,12 @@ export declare class NodeMap {
      * @param {*} key
      * @param {number} [idx]
      * @returns {number}
-     * @memberof NodeMap
      */
     getId(key: any, idx?: number): number;
     /**
      * Get a node from the map.
      * @param {number} propId
      * @returns {long}
-     * @memberof NodeMap
      */
     getNumericName(propId: number): Long | undefined;
     private transformKey;

package/dist/NodeMap.class.js

@@ -2,8 +2,8 @@
 import Long from 'long';
 /**
  * Stores node names (both alpha and numeric) in node maps for quick lookup.
- * @export
- * @class NodeMap
+ *
+ * @internal
  */
 export class NodeMap {
     constructor() {
@@ -16,7 +16,6 @@ export class NodeMap {
      * @param {*} key
      * @param {number} propId
      * @param {number} [idx]
-     * @memberof NodeMap
      */
     setId(key, propId, idx) {
         if (typeof key === 'number' && idx !== undefined) {
@@ -39,7 +38,6 @@ export class NodeMap {
      * @param {*} key
      * @param {number} [idx]
      * @returns {number}
-     * @memberof NodeMap
      */
     getId(key, idx) {
         let id = undefined;
@@ -61,7 +59,6 @@ export class NodeMap {
      * Get a node from the map.
      * @param {number} propId
      * @returns {long}
-     * @memberof NodeMap
      */
     getNumericName(propId) {
         const lkey = this.idToNumericName.get(propId);

package/dist/PAUtil.d.ts

@@ -5,6 +5,9 @@ import { NodeMap } from "./NodeMap.class.js";
 import type { PLNode } from "./PLNode.js";
 import type { Property } from "./Property.js";
 import type { PropertyValueResolver } from "./PropertyValueResolver.js";
+/**
+ * @internal
+ */
 export interface PropertyFinder {
     findByKey(key: number): Property | undefined;
     all(): Property[];
@@ -12,7 +15,11 @@ export interface PropertyFinder {
 /**
  * Process name to ID map.
  *
+ * @internal
  * @param nameToIdMapDescriptorNode nodeId 97
  */
 export declare function processNameToIDMap(nameToIdMapDescriptorNode: PLNode, resolver: PropertyValueResolver): Promise<NodeMap>;
+/**
+ * @internal
+ */
 export declare function createPropertyFinder(props: Property[]): PropertyFinder;

package/dist/PAUtil.js

@@ -26,6 +26,7 @@ const guidMap = new Map([
 /**
  * Process name to ID map.
  *
+ * @internal
  * @param nameToIdMapDescriptorNode nodeId 97
  */
 export async function processNameToIDMap(nameToIdMapDescriptorNode, resolver) {
@@ -118,6 +119,9 @@ export async function processNameToIDMap(nameToIdMapDescriptorNode, resolver) {
     }
     return nodeMap;
 }
+/**
+ * @internal
+ */
 export function createPropertyFinder(props) {
     return {
         findByKey(key) {

package/dist/PSTActivity.class.d.ts

@@ -3,7 +3,8 @@ import type { PLNode } from './PLNode.js';
 import type { PropertyFinder } from './PAUtil.js';
 import type { PLSubNode } from './PLSubNode.js';
 import type { RootProvider } from './RootProvider.js';
-export declare class PSTActivity extends PSTMessage {
+import type { IPSTActivity } from './IPSTActivity.js';
+export declare class PSTActivity extends PSTMessage implements IPSTActivity {
     /**
      * Creates an instance of PSTActivity.  Represents Journal entries, class IPM.Activity.
      * https://msdn.microsoft.com/en-us/library/office/aa204771(v=office.11).aspx
@@ -11,7 +12,6 @@ export declare class PSTActivity extends PSTMessage {
      * @param {PSTFile} rootProvider
      * @param {DescriptorIndexNode} descriptorIndexNode
      * @param {Map<number, PSTDescriptorItem>} [localDescriptorItems]
-     * @memberof PSTActivity
      */
     constructor(rootProvider: RootProvider, node: PLNode, subNode: PLSubNode, propertyFinder: PropertyFinder);
     /**
@@ -19,7 +19,6 @@ export declare class PSTActivity extends PSTMessage {
      * https://msdn.microsoft.com/en-us/library/office/cc839662.aspx
      * @readonly
      * @type {string}
-     * @memberof PSTActivity
      */
     get logType(): string;
     /**
@@ -27,7 +26,6 @@ export declare class PSTActivity extends PSTMessage {
      * https://msdn.microsoft.com/en-us/library/office/cc842339.aspx
      * @readonly
      * @type {Date}
-     * @memberof PSTActivity
      */
     get logStart(): Date | null;
     /**
@@ -35,7 +33,6 @@ export declare class PSTActivity extends PSTMessage {
      * https://msdn.microsoft.com/en-us/library/office/cc765536.aspx
      * @readonly
      * @type {number}
-     * @memberof PSTActivity
      */
     get logDuration(): number;
     /**
@@ -43,7 +40,6 @@ export declare class PSTActivity extends PSTMessage {
      * https://msdn.microsoft.com/en-us/library/office/cc839572.aspx
      * @readonly
      * @type {Date}
-     * @memberof PSTActivity
      */
     get logEnd(): Date | null;
     /**
@@ -51,7 +47,6 @@ export declare class PSTActivity extends PSTMessage {
      * https://msdn.microsoft.com/en-us/library/office/cc815433.aspx
      * @readonly
      * @type {number}
-     * @memberof PSTActivity
      */
     get logFlags(): number;
     /**
@@ -59,7 +54,6 @@ export declare class PSTActivity extends PSTMessage {
      * https://msdn.microsoft.com/en-us/library/office/cc839873.aspx
      * @readonly
      * @type {boolean}
-     * @memberof PSTActivity
      */
     get isDocumentPrinted(): boolean;
     /**
@@ -67,7 +61,6 @@ export declare class PSTActivity extends PSTMessage {
      * https://msdn.microsoft.com/en-us/library/office/cc815488.aspx
      * @readonly
      * @type {boolean}
-     * @memberof PSTActivity
      */
     get isDocumentSaved(): boolean;
     /**
@@ -75,7 +68,6 @@ export declare class PSTActivity extends PSTMessage {
      * https://msdn.microsoft.com/en-us/library/office/cc839558.aspx
      * @readonly
      * @type {boolean}
-     * @memberof PSTActivity
      */
     get isDocumentRouted(): boolean;
     /**
@@ -83,7 +75,6 @@ export declare class PSTActivity extends PSTMessage {
      * https://msdn.microsoft.com/en-us/library/office/cc815353.aspx
      * @readonly
      * @type {boolean}
-     * @memberof PSTActivity
      */
     get isDocumentPosted(): boolean;
     /**
@@ -91,13 +82,11 @@ export declare class PSTActivity extends PSTMessage {
      * https://msdn.microsoft.com/en-us/library/office/cc815500.aspx
      * @readonly
      * @type {string}
-     * @memberof PSTActivity
      */
     get logTypeDesc(): string;
     /**
      * JSON stringify the object properties.
      * @returns {string}
-     * @memberof PSTActivity
      */
     toJSON(): any;
 }

package/dist/PSTActivity.class.js

@@ -10,7 +10,6 @@ export class PSTActivity extends PSTMessage {
      * @param {PSTFile} rootProvider
      * @param {DescriptorIndexNode} descriptorIndexNode
      * @param {Map<number, PSTDescriptorItem>} [localDescriptorItems]
-     * @memberof PSTActivity
      */
     constructor(rootProvider, node, subNode, propertyFinder) {
         super(rootProvider, node, subNode, propertyFinder);
@@ -20,7 +19,6 @@ export class PSTActivity extends PSTMessage {
      * https://msdn.microsoft.com/en-us/library/office/cc839662.aspx
      * @readonly
      * @type {string}
-     * @memberof PSTActivity
      */
     get logType() {
         return this.getStringItem(this._rootProvider.getNameToIdMapItem(OutlookProperties.PidLidLogType, OutlookProperties.PSETID_Log));
@@ -30,7 +28,6 @@ export class PSTActivity extends PSTMessage {
      * https://msdn.microsoft.com/en-us/library/office/cc842339.aspx
      * @readonly
      * @type {Date}
-     * @memberof PSTActivity
      */
     get logStart() {
         return this.getDateItem(this._rootProvider.getNameToIdMapItem(OutlookProperties.PidLidLogStart, OutlookProperties.PSETID_Log));
@@ -40,7 +37,6 @@ export class PSTActivity extends PSTMessage {
      * https://msdn.microsoft.com/en-us/library/office/cc765536.aspx
      * @readonly
      * @type {number}
-     * @memberof PSTActivity
      */
     get logDuration() {
         return this.getIntItem(this._rootProvider.getNameToIdMapItem(OutlookProperties.PidLidLogDuration, OutlookProperties.PSETID_Log));
@@ -50,7 +46,6 @@ export class PSTActivity extends PSTMessage {
      * https://msdn.microsoft.com/en-us/library/office/cc839572.aspx
      * @readonly
      * @type {Date}
-     * @memberof PSTActivity
      */
     get logEnd() {
         return this.getDateItem(this._rootProvider.getNameToIdMapItem(OutlookProperties.PidLidLogEnd, OutlookProperties.PSETID_Log));
@@ -60,7 +55,6 @@ export class PSTActivity extends PSTMessage {
      * https://msdn.microsoft.com/en-us/library/office/cc815433.aspx
      * @readonly
      * @type {number}
-     * @memberof PSTActivity
      */
     get logFlags() {
         return this.getIntItem(this._rootProvider.getNameToIdMapItem(OutlookProperties.PidLidLogFlags, OutlookProperties.PSETID_Log));
@@ -70,7 +64,6 @@ export class PSTActivity extends PSTMessage {
      * https://msdn.microsoft.com/en-us/library/office/cc839873.aspx
      * @readonly
      * @type {boolean}
-     * @memberof PSTActivity
      */
     get isDocumentPrinted() {
         return this.getBooleanItem(this._rootProvider.getNameToIdMapItem(OutlookProperties.PidLidLogDocumentPrinted, OutlookProperties.PSETID_Log));
@@ -80,7 +73,6 @@ export class PSTActivity extends PSTMessage {
      * https://msdn.microsoft.com/en-us/library/office/cc815488.aspx
      * @readonly
      * @type {boolean}
-     * @memberof PSTActivity
      */
     get isDocumentSaved() {
         return this.getBooleanItem(this._rootProvider.getNameToIdMapItem(OutlookProperties.PidLidLogDocumentSaved, OutlookProperties.PSETID_Log));
@@ -90,7 +82,6 @@ export class PSTActivity extends PSTMessage {
      * https://msdn.microsoft.com/en-us/library/office/cc839558.aspx
      * @readonly
      * @type {boolean}
-     * @memberof PSTActivity
      */
     get isDocumentRouted() {
         return this.getBooleanItem(this._rootProvider.getNameToIdMapItem(OutlookProperties.PidLidLogDocumentRouted, OutlookProperties.PSETID_Log));
@@ -100,7 +91,6 @@ export class PSTActivity extends PSTMessage {
      * https://msdn.microsoft.com/en-us/library/office/cc815353.aspx
      * @readonly
      * @type {boolean}
-     * @memberof PSTActivity
      */
     get isDocumentPosted() {
         return this.getBooleanItem(this._rootProvider.getNameToIdMapItem(OutlookProperties.PidLidLogDocumentPosted, OutlookProperties.PSETID_Log));
@@ -110,7 +100,6 @@ export class PSTActivity extends PSTMessage {
      * https://msdn.microsoft.com/en-us/library/office/cc815500.aspx
      * @readonly
      * @type {string}
-     * @memberof PSTActivity
      */
     get logTypeDesc() {
         return this.getStringItem(this._rootProvider.getNameToIdMapItem(OutlookProperties.PidLidLogTypeDesc, OutlookProperties.PSETID_Log));
@@ -118,7 +107,6 @@ export class PSTActivity extends PSTMessage {
     /**
      * JSON stringify the object properties.
      * @returns {string}
-     * @memberof PSTActivity
      */
     toJSON() {
         const clone = Object.assign({