@hiraokahypertools/pst-extractor 0.1.0-alpha.1

package/dist/PSTTask.class.js

@@ -0,0 +1,206 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PSTTask = void 0;
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const OutlookProperties_1 = require("./OutlookProperties");
+const PSTMessage_class_1 = require("./PSTMessage.class");
+const PSTFile_class_1 = require("./PSTFile.class");
+const RecurrencePattern_class_1 = require("./RecurrencePattern.class");
+class PSTTask extends PSTMessage_class_1.PSTMessage {
+    /**
+     * Creates an instance of PSTTask.
+     * @internal
+     * @param {PSTFile} rootProvider
+     * @param {DescriptorIndexNode} descriptorIndexNode
+     * @param {Map<number, PSTDescriptorItem>} [localDescriptorItems]
+     * @memberof PSTTask
+     */
+    constructor(rootProvider, node, subNode, propertyFinder) {
+        super(rootProvider, node, subNode, propertyFinder);
+    }
+    /**
+     * Specifies the status of the user's progress on the task.
+     * https://msdn.microsoft.com/en-us/library/office/cc842120.aspx
+     * @readonly
+     * @type {number}
+     * @memberof PSTTask
+     */
+    get taskStatus() {
+        return this.getIntItem(this._rootProvider.getNameToIdMapItem(OutlookProperties_1.OutlookProperties.PidLidTaskStatus, PSTFile_class_1.PSTFile.PSETID_Task));
+    }
+    /**
+     * Indicates the progress the user has made on a task.
+     * https://msdn.microsoft.com/en-us/library/office/cc839932.aspx
+     * @readonly
+     * @type {number}
+     * @memberof PSTTask
+     */
+    get percentComplete() {
+        return this.getDoubleItem(this._rootProvider.getNameToIdMapItem(OutlookProperties_1.OutlookProperties.PidLidPercentComplete, PSTFile_class_1.PSTFile.PSETID_Task));
+    }
+    /**
+     * Specifies the date when the user completes the task.
+     * https://msdn.microsoft.com/en-us/library/office/cc815753.aspx
+     * @readonly
+     * @type {Date}
+     * @memberof PSTTask
+     */
+    get taskDateCompleted() {
+        return this.getDateItem(this._rootProvider.getNameToIdMapItem(OutlookProperties_1.OutlookProperties.PidLidTaskDateCompleted, PSTFile_class_1.PSTFile.PSETID_Task));
+    }
+    /**
+     * Indicates the number of minutes that the user performed a task.
+     * https://msdn.microsoft.com/en-us/library/office/cc842253.aspx
+     * @readonly
+     * @type {number}
+     * @memberof PSTTask
+     */
+    get taskActualEffort() {
+        return this.getIntItem(this._rootProvider.getNameToIdMapItem(OutlookProperties_1.OutlookProperties.PidLidTaskActualEffort, PSTFile_class_1.PSTFile.PSETID_Task));
+    }
+    /**
+     * 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
+     * @type {number}
+     * @memberof PSTTask
+     */
+    get taskEstimatedEffort() {
+        return this.getIntItem(this._rootProvider.getNameToIdMapItem(OutlookProperties_1.OutlookProperties.PidLidTaskEstimatedEffort, PSTFile_class_1.PSTFile.PSETID_Task));
+    }
+    /**
+     * Indicates which copy is the latest update of a task.
+     * https://msdn.microsoft.com/en-us/library/office/cc815510.aspx
+     * @readonly
+     * @type {number}
+     * @memberof PSTTask
+     */
+    get taskVersion() {
+        return this.getIntItem(this._rootProvider.getNameToIdMapItem(OutlookProperties_1.OutlookProperties.PidLidTaskVersion, PSTFile_class_1.PSTFile.PSETID_Task));
+    }
+    /**
+     * Indicates the task is complete.
+     * https://msdn.microsoft.com/en-us/library/office/cc839514.aspx
+     * @readonly
+     * @type {boolean}
+     * @memberof PSTTask
+     */
+    get isTaskComplete() {
+        return this.getBooleanItem(this._rootProvider.getNameToIdMapItem(OutlookProperties_1.OutlookProperties.PidLidTaskComplete, PSTFile_class_1.PSTFile.PSETID_Task));
+    }
+    /**
+     * Contains the name of the task owner.
+     * https://msdn.microsoft.com/en-us/library/office/cc842363.aspx
+     * @readonly
+     * @type {string}
+     * @memberof PSTTask
+     */
+    get taskOwner() {
+        return this.getStringItem(this._rootProvider.getNameToIdMapItem(OutlookProperties_1.OutlookProperties.PidLidTaskOwner, PSTFile_class_1.PSTFile.PSETID_Task));
+    }
+    /**
+     * Names the user who was last assigned the task.
+     * https://msdn.microsoft.com/en-us/library/office/cc815865.aspx
+     * @readonly
+     * @type {string}
+     * @memberof PSTTask
+     */
+    get taskAssigner() {
+        return this.getStringItem(this._rootProvider.getNameToIdMapItem(OutlookProperties_1.OutlookProperties.PidLidTaskAssigner, PSTFile_class_1.PSTFile.PSETID_Task));
+    }
+    /**
+     * Names the most recent user who was the task owner.
+     * https://msdn.microsoft.com/en-us/library/office/cc842278.aspx
+     * @readonly
+     * @type {string}
+     * @memberof PSTTask
+     */
+    get taskLastUser() {
+        return this.getStringItem(this._rootProvider.getNameToIdMapItem(OutlookProperties_1.OutlookProperties.PidLidTaskLastUser, PSTFile_class_1.PSTFile.PSETID_Task));
+    }
+    /**
+     * Provides an aid to custom sorting tasks.
+     * https://msdn.microsoft.com/en-us/library/office/cc765654.aspx
+     * @readonly
+     * @type {number}
+     * @memberof PSTTask
+     */
+    get taskOrdinal() {
+        return this.getIntItem(this._rootProvider.getNameToIdMapItem(OutlookProperties_1.OutlookProperties.PidLidTaskOrdinal, PSTFile_class_1.PSTFile.PSETID_Task));
+    }
+    /**
+     * Indicates whether the task includes a recurrence pattern.
+     * https://msdn.microsoft.com/en-us/library/office/cc765875.aspx
+     * @type {boolean}
+     * @memberof PSTTask
+     */
+    get isTaskRecurring() {
+        return this.getBooleanItem(this._rootProvider.getNameToIdMapItem(OutlookProperties_1.OutlookProperties.PidLidTaskFRecurring, PSTFile_class_1.PSTFile.PSETID_Task));
+    }
+    /**
+     * https://docs.microsoft.com/en-us/office/client-developer/outlook/mapi/pidlidtaskrecurrence-canonical-property
+     * @type {RecurrencePattern}
+     * @memberof PSTTask
+     */
+    get taskRecurrencePattern() {
+        const recurrenceBLOB = this.getBinaryItem(this._rootProvider.getNameToIdMapItem(OutlookProperties_1.OutlookProperties.PidLidTaskRecurrence, PSTFile_class_1.PSTFile.PSETID_Task));
+        return recurrenceBLOB && new RecurrencePattern_class_1.RecurrencePattern(recurrenceBLOB);
+    }
+    /**
+     * https://docs.microsoft.com/en-us/office/client-developer/outlook/mapi/pidlidtaskdeadoccurrence-canonical-property
+     * @type {boolean}
+     * @memberof PSTTask
+     */
+    get taskDeadOccurrence() {
+        return this.getBooleanItem(this._rootProvider.getNameToIdMapItem(OutlookProperties_1.OutlookProperties.PidLidTaskDeadOccurrence, PSTFile_class_1.PSTFile.PSETID_Task));
+    }
+    /**
+     * Indicates the role of the current user relative to the task.
+     * https://msdn.microsoft.com/en-us/library/office/cc842113.aspx
+     * @readonly
+     * @type {number}
+     * @memberof PSTTask
+     */
+    get taskOwnership() {
+        return this.getIntItem(this._rootProvider.getNameToIdMapItem(OutlookProperties_1.OutlookProperties.PidLidTaskOwnership, PSTFile_class_1.PSTFile.PSETID_Task));
+    }
+    /**
+     * Indicates the acceptance state of the task.
+     * https://msdn.microsoft.com/en-us/library/office/cc839689.aspx
+     * @readonly
+     * @type {number}
+     * @memberof PSTTask
+     */
+    get acceptanceState() {
+        return this.getIntItem(this._rootProvider.getNameToIdMapItem(OutlookProperties_1.OutlookProperties.PidLidTaskAcceptanceState, PSTFile_class_1.PSTFile.PSETID_Task));
+    }
+    /**
+     * JSON stringify the object properties.
+     * @returns {string}
+     * @memberof PSTTask
+     */
+    toJSON() {
+        const clone = Object.assign({
+            messageClass: this.messageClass,
+            subject: this.subject,
+            importance: this.importance,
+            transportMessageHeaders: this.transportMessageHeaders,
+            taskStatus: this.taskStatus,
+            percentComplete: this.percentComplete,
+            taskDateCompleted: this.taskDateCompleted,
+            taskActualEffort: this.taskActualEffort,
+            taskEstimatedEffort: this.taskEstimatedEffort,
+            taskVersion: this.taskVersion,
+            isTaskComplete: this.isTaskComplete,
+            taskOwner: this.taskOwner,
+            taskAssigner: this.taskAssigner,
+            taskLastUser: this.taskLastUser,
+            taskOrdinal: this.taskOrdinal,
+            isTaskRecurring: this.isTaskRecurring,
+            taskOwnership: this.taskOwnership,
+            acceptanceState: this.acceptanceState,
+        }, this);
+        return clone;
+    }
+}
+exports.PSTTask = PSTTask;

package/dist/PSTUtil.class.d.ts

@@ -0,0 +1,134 @@
+/// <reference types="node" />
+import Long from 'long';
+import { PSTMessage } from './PSTMessage.class';
+import { PLNode } from './PLNode';
+import { PropertyValueResolver } from './PropertyValueResolver';
+import { PropertyFinder } from './PAUtil';
+import { PLSubNode } from './PLSubNode';
+import { RootProvider } from './RootProvider';
+/**
+ * Utility functions for PST components
+ * @export
+ * @class PSTUtil
+ */
+export declare class PSTUtil {
+    static compEnc: number[];
+    static codePages: Map<number, string>;
+    static propertyName: Map<number, string>;
+    static NID_TYPE_HID: number;
+    static NID_TYPE_INTERNAL: number;
+    static NID_TYPE_NORMAL_FOLDER: number;
+    static NID_TYPE_SEARCH_FOLDER: number;
+    static NID_TYPE_NORMAL_MESSAGE: number;
+    static NID_TYPE_ATTACHMENT: number;
+    static NID_TYPE_SEARCH_UPDATE_QUEUE: number;
+    static NID_TYPE_SEARCH_CRITERIA_OBJECT: number;
+    static NID_TYPE_ASSOC_MESSAGE: number;
+    static NID_TYPE_CONTENTS_TABLE_INDEX: number;
+    static NID_TYPE_RECEIVE_FOLDER_TABLE: number;
+    static NID_TYPE_OUTGOING_QUEUE_TABLE: number;
+    static NID_TYPE_HIERARCHY_TABLE: number;
+    static NID_TYPE_CONTENTS_TABLE: number;
+    static NID_TYPE_ASSOC_CONTENTS_TABLE: number;
+    static NID_TYPE_SEARCH_CONTENTS_TABLE: number;
+    static NID_TYPE_ATTACHMENT_TABLE: number;
+    static NID_TYPE_RECIPIENT_TABLE: number;
+    static NID_TYPE_SEARCH_TABLE_INDEX: number;
+    static NID_TYPE_LTP: number;
+    /**
+     * Convert little endian bytes to long
+     * @static
+     * @param {Buffer} data
+     * @param {number} [start]
+     * @param {number} [end]
+     * @returns {long}
+     * @memberof PSTUtil
+     */
+    static convertLittleEndianBytesToLong(data: Buffer, start?: number, end?: number): Long;
+    /**
+     * Convert big endian bytes to long
+     * @static
+     * @param {Buffer} data
+     * @param {number} [start]
+     * @param {number} [end]
+     * @returns {long}
+     * @memberof PSTUtil
+     */
+    static convertBigEndianBytesToLong(data: Buffer, start?: number, end?: number): Long;
+    /**
+     * Handle strings using codepages.
+     * @static
+     * @param {number} propertyId
+     * @returns
+     * @memberof PSTUtil
+     */
+    static getInternetCodePageCharset(propertyId: number): string | undefined;
+    /**
+     * Create JS string from buffer.
+     * @static
+     * @param {Buffer} data
+     * @param {number} stringType
+     * @param {string} codepage
+     * @returns
+     * @memberof PSTUtil
+     */
+    static createJavascriptString(data: Buffer, stringType: number, codepage?: string): string;
+    /**
+     * Copy from one array to another
+     * @static
+     * @param {Buffer} src
+     * @param {number} srcPos
+     * @param {Buffer} dest
+     * @param {number} destPos
+     * @param {number} length
+     * @memberof PSTUtil
+     */
+    static arraycopy(src: Buffer, srcPos: number, dest: Buffer, destPos: number, length: number): void;
+    /**
+     * Determine if character is alphanumeric
+     *
+     * @static
+     * @memberof PSTUtil
+     */
+    static isAlphaNumeric: (ch: string) => boolean;
+    /**
+     * Decode a lump of data that has been encrypted with the compressible encryption
+     * @static
+     * @param {Buffer} data
+     * @returns {Buffer}
+     * @memberof PSTUtil
+     */
+    static decode(data: Buffer): Buffer;
+    /**
+     * Decode a lump of data that has been encrypted with the compressible encryption
+     * @static
+     * @param {Buffer} data
+     * @returns {Buffer}
+     * @memberof PSTUtil
+     */
+    static decodeArray(data: Uint8Array): Uint8Array;
+    /**
+     * Creates object based on message class
+     * https://msdn.microsoft.com/en-us/vba/outlook-vba/articles/item-types-and-message-classes
+     * @static
+     * @param {PSTFile} rootProvider
+     * @param {DescriptorIndexNode} folderIndexNode
+     * @param {PSTTableBC} table
+     * @param {Map<number, PSTDescriptorItem>} localDescriptorItems
+     * @returns {PSTMessage}
+     * @memberof PSTUtil
+     */
+    static createAppropriatePSTMessageObject(rootProvider: RootProvider, node: PLNode, subNode: PLSubNode, resolver: PropertyValueResolver, propertyFinderDelegation: PropertyFinder | undefined): Promise<PSTMessage>;
+    /**
+     * Converts a Windows FILETIME into a {@link Date}. The Windows FILETIME structure holds a date and time associated with a
+     * file. The structure identifies a 64-bit integer specifying the number of 100-nanosecond intervals which have passed since
+     * January 1, 1601. This 64-bit value is split into the two double words stored in the structure.
+     *
+     * @static
+     * @param {long} hi
+     * @param {long} low
+     * @returns {Date}
+     * @memberof PSTUtil
+     */
+    static filetimeToDate(hi: Long, low: Long): Date;
+}