@hiraokahypertools/pst-extractor 0.1.0-alpha.1

package/dist/PSTMessageStore.class.d.ts

@@ -0,0 +1,16 @@
+import { PropertyFinder } from './PAUtil';
+import { PLNode } from './PLNode';
+import { PLSubNode } from './PLSubNode';
+import { PSTObject } from './PSTObject.class';
+import { RootProvider } from './RootProvider';
+export declare class PSTMessageStore extends PSTObject {
+    /**
+     * Creates an instance of PSTMessageStore.
+     * Not much use other than to get the "name" of the PST file.
+     * @internal
+     * @param {PSTFile} rootProvider
+     * @param {DescriptorIndexNode} descriptorIndexNode
+     * @memberof PSTMessageStore
+     */
+    constructor(rootProvider: RootProvider, node: PLNode, subNode: PLSubNode, propertyFinder: PropertyFinder);
+}

package/dist/PSTMessageStore.class.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PSTMessageStore = void 0;
+const PSTObject_class_1 = require("./PSTObject.class");
+class PSTMessageStore extends PSTObject_class_1.PSTObject {
+    /**
+     * Creates an instance of PSTMessageStore.
+     * Not much use other than to get the "name" of the PST file.
+     * @internal
+     * @param {PSTFile} rootProvider
+     * @param {DescriptorIndexNode} descriptorIndexNode
+     * @memberof PSTMessageStore
+     */
+    constructor(rootProvider, node, subNode, propertyFinder) {
+        super(rootProvider, node, subNode, propertyFinder);
+    }
+}
+exports.PSTMessageStore = PSTMessageStore;

package/dist/PSTObject.class.d.ts

@@ -0,0 +1,107 @@
+/// <reference types="node" />
+import Long from 'long';
+import { PropertyFinder } from './PAUtil';
+import { PLNode } from './PLNode';
+import { PLSubNode } from './PLSubNode';
+import { Property } from './Property';
+import { RootProvider } from './RootProvider';
+export declare abstract class PSTObject {
+    protected _rootProvider: RootProvider;
+    protected _node: PLNode;
+    protected _subNode: PLSubNode;
+    protected _propertyFinder: PropertyFinder;
+    /**
+     * Creates an instance of PSTObject, the root class of most PST Items.
+     * @internal
+     * @memberof PSTObject
+     */
+    constructor(rootProvider: RootProvider, node: PLNode, subNode: PLSubNode, propertyFinder: PropertyFinder);
+    /**
+     * Get the node type for the descriptor id.
+     * @param {number} [descriptorIdentifier]
+     * @returns {number}
+     * @memberof PSTObject
+     */
+    protected getNodeType(descriptorIdentifier?: number): number;
+    /**
+     * @protected
+     * @param { number } identifier
+     * @param { number } [defaultValue]
+     * @returns { number }
+     * @memberof PSTObject
+     */
+    protected getIntItem(identifier: number, defaultValue?: number): number;
+    /**
+     * Get a boolean.
+     * @protected
+     * @param {number} identifier
+     * @param {boolean} [defaultValue]
+     * @returns {boolean}
+     * @memberof PSTObject
+     */
+    protected getBooleanItem(identifier: number, defaultValue?: boolean): boolean;
+    /**
+     * Get a double.
+     * @protected
+     * @param {number} identifier
+     * @param {number} [defaultValue]
+     * @returns {number}
+     * @memberof PSTObject
+     */
+    protected getDoubleItem(identifier: number, defaultValue?: number): number;
+    /**
+     * Get a long.
+     * @protected
+     * @param {number} identifier
+     * @param {long} [defaultValue]
+     * @returns {long}
+     * @memberof PSTObject
+     */
+    protected getLongItem(identifier: number, defaultValue?: Long): Long;
+    /**
+     * Get a string.
+     * @protected
+     * @param {number} identifier
+     * @param {number} [stringType]
+     * @param {string} [codepage]
+     * @returns {string}
+     * @memberof PSTObject
+     */
+    protected getStringItem(identifier: number, stringType?: number, codepage?: string): string;
+    /**
+     * Get a date.
+     * @param {number} identifier
+     * @returns {Date}
+     * @memberof PSTObject
+     */
+    protected getDateItem(identifier: number): Date | null;
+    /**
+     * Get a blob.
+     * @protected
+     * @param {number} identifier
+     * @returns {Buffer}
+     * @memberof PSTObject
+     */
+    protected getBinaryItem(identifier: number): Buffer | null;
+    /**
+     * Get the display name of this object.
+     * https://msdn.microsoft.com/en-us/library/office/cc842383.aspx
+     * @readonly
+     * @type {string}
+     * @memberof PSTObject
+     */
+    get displayName(): string;
+    /**
+     * Try to get specified property from PropertyContext.
+     *
+     * @param key `0x3001` is `PR_DISPLAY_NAME` for example
+     * @returns The found one will be returned. Otherwise `undefined` is returned.
+     */
+    getProperty(key: number): Property | undefined;
+    /**
+     * JSON the object.
+     * @returns {string}
+     * @memberof PSTObject
+     */
+    toJSON(): any;
+}

package/dist/PSTObject.class.js

@@ -0,0 +1,208 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PSTObject = void 0;
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const long_1 = __importDefault(require("long"));
+const OutlookProperties_1 = require("./OutlookProperties");
+class PSTObject {
+    /**
+     * Creates an instance of PSTObject, the root class of most PST Items.
+     * @internal
+     * @memberof PSTObject
+     */
+    constructor(rootProvider, node, subNode, propertyFinder) {
+        if (!propertyFinder) {
+            console.trace("propertyFinder not defined");
+        }
+        this._rootProvider = rootProvider;
+        this._node = node;
+        this._subNode = subNode;
+        this._propertyFinder = propertyFinder;
+    }
+    /**
+     * Get the node type for the descriptor id.
+     * @param {number} [descriptorIdentifier]
+     * @returns {number}
+     * @memberof PSTObject
+     */
+    getNodeType(descriptorIdentifier) {
+        if (descriptorIdentifier) {
+            return descriptorIdentifier & 0x1f;
+        }
+        else if (this._node.nodeId) {
+            return this._node.nodeId & 0x1f;
+        }
+        else {
+            return -1;
+        }
+    }
+    /**
+     * @protected
+     * @param { number } identifier
+     * @param { number } [defaultValue]
+     * @returns { number }
+     * @memberof PSTObject
+     */
+    getIntItem(identifier, defaultValue) {
+        if (!defaultValue) {
+            defaultValue = 0;
+        }
+        const property = this._propertyFinder.findByKey(identifier);
+        if (property !== undefined) {
+            const { value } = property;
+            if (typeof value === 'number') {
+                return value;
+            }
+        }
+        return defaultValue;
+    }
+    /**
+     * Get a boolean.
+     * @protected
+     * @param {number} identifier
+     * @param {boolean} [defaultValue]
+     * @returns {boolean}
+     * @memberof PSTObject
+     */
+    getBooleanItem(identifier, defaultValue) {
+        if (defaultValue === undefined) {
+            defaultValue = false;
+        }
+        const property = this._propertyFinder.findByKey(identifier);
+        if (property !== undefined) {
+            const { value } = property;
+            if (typeof value === 'boolean') {
+                return value;
+            }
+        }
+        return defaultValue;
+    }
+    /**
+     * Get a double.
+     * @protected
+     * @param {number} identifier
+     * @param {number} [defaultValue]
+     * @returns {number}
+     * @memberof PSTObject
+     */
+    getDoubleItem(identifier, defaultValue) {
+        if (defaultValue === undefined) {
+            defaultValue = 0;
+        }
+        const property = this._propertyFinder.findByKey(identifier);
+        if (property !== undefined) {
+            const { value } = property;
+            if (typeof value === 'number') {
+                return value;
+            }
+        }
+        return defaultValue;
+    }
+    /**
+     * Get a long.
+     * @protected
+     * @param {number} identifier
+     * @param {long} [defaultValue]
+     * @returns {long}
+     * @memberof PSTObject
+     */
+    getLongItem(identifier, defaultValue) {
+        if (defaultValue === undefined) {
+            defaultValue = long_1.default.ZERO;
+        }
+        const property = this._propertyFinder.findByKey(identifier);
+        if (property !== undefined) {
+            const { value } = property;
+            if (value instanceof long_1.default) {
+                return value;
+            }
+            else if (typeof value === 'number') {
+                return new long_1.default(value);
+            }
+        }
+        return defaultValue;
+    }
+    /**
+     * Get a string.
+     * @protected
+     * @param {number} identifier
+     * @param {number} [stringType]
+     * @param {string} [codepage]
+     * @returns {string}
+     * @memberof PSTObject
+     */
+    getStringItem(identifier, stringType, codepage) {
+        const property = this._propertyFinder.findByKey(identifier);
+        if (property !== undefined) {
+            const { value } = property;
+            if (typeof value === 'string') {
+                return value;
+            }
+        }
+        return '';
+    }
+    /**
+     * Get a date.
+     * @param {number} identifier
+     * @returns {Date}
+     * @memberof PSTObject
+     */
+    getDateItem(identifier) {
+        const property = this._propertyFinder.findByKey(identifier);
+        if (property !== undefined) {
+            const { value } = property;
+            if (value instanceof Date) {
+                return value;
+            }
+        }
+        return null;
+    }
+    /**
+     * Get a blob.
+     * @protected
+     * @param {number} identifier
+     * @returns {Buffer}
+     * @memberof PSTObject
+     */
+    getBinaryItem(identifier) {
+        const property = this._propertyFinder.findByKey(identifier);
+        if (property !== undefined) {
+            const { value } = property;
+            if (value instanceof ArrayBuffer) {
+                return Buffer.from(value);
+            }
+        }
+        return null;
+    }
+    /**
+     * Get the display name of this object.
+     * https://msdn.microsoft.com/en-us/library/office/cc842383.aspx
+     * @readonly
+     * @type {string}
+     * @memberof PSTObject
+     */
+    get displayName() {
+        return this.getStringItem(OutlookProperties_1.OutlookProperties.PR_DISPLAY_NAME);
+    }
+    /**
+     * Try to get specified property from PropertyContext.
+     *
+     * @param key `0x3001` is `PR_DISPLAY_NAME` for example
+     * @returns The found one will be returned. Otherwise `undefined` is returned.
+     */
+    getProperty(key) {
+        return this._propertyFinder.findByKey(key);
+    }
+    /**
+     * JSON the object.
+     * @returns {string}
+     * @memberof PSTObject
+     */
+    toJSON() {
+        return this;
+    }
+}
+exports.PSTObject = PSTObject;

package/dist/PSTOpts.d.ts

@@ -0,0 +1,24 @@
+export interface PSTOpts {
+    /**
+     * Specify character encoding usable with `iconv-lite` package.
+     *
+     * This is used to obtain unicode string from ArrayBuffer of ansiString PT_STRING8.
+     *
+     * It is rare case that pst/ost files store ansiString,
+     * because recent Outlook applications are Unicode based.
+     *
+     * This applies to pst files generated by older versions of Outlook.
+     *
+     * And {@link ansiEncoding} is required because ANSI code page depends on
+     * Windows's system locale can be acquired by [GetOEMCP](https://docs.microsoft.com/en-us/windows/win32/api/winnls/nf-winnls-getoemcp) API.
+     *
+     * OEMCP cannot be obtained from pure JavaScript environment,
+     * especially on Web browser environment.
+     * Thus you need to specify considered one.
+     */
+    ansiEncoding?: string;
+    /**
+     * Otherwise, you can provide your own converter (from ansiString to unicode string).
+     */
+    convertAnsiString?: (arrayBuffer: ArrayBuffer) => Promise<string>;
+}

package/dist/PSTOpts.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/PSTRecipient.class.d.ts

@@ -0,0 +1,68 @@
+import { PropertyFinder } from './PAUtil';
+import { PLNode } from './PLNode';
+import { PLSubNode } from './PLSubNode';
+import { PSTObject } from './PSTObject.class';
+import { RootProvider } from './RootProvider';
+export declare class PSTRecipient extends PSTObject {
+    /**
+     * Creates an instance of PSTRecipient.
+     * @internal
+     * @param {Map<number, PSTTableItem>} recipientDetails
+     * @memberof PSTRecipient
+     */
+    constructor(rootProvider: RootProvider, node: PLNode, subNode: PLSubNode, propertyFinder: PropertyFinder);
+    /**
+     * Contains the recipient type for a message recipient.
+     * https://msdn.microsoft.com/en-us/library/office/cc839620.aspx
+     * @readonly
+     * @type {number}
+     * @memberof PSTMessage
+     */
+    get recipientType(): number;
+    /**
+     * Contains the messaging user's e-mail address type, such as SMTP.
+     * https://msdn.microsoft.com/en-us/library/office/cc815548.aspx
+     * @readonly
+     * @type {string}
+     * @memberof PSTMessage
+     */
+    get addrType(): string;
+    /**
+     * Contains the messaging user's e-mail address.
+     * https://msdn.microsoft.com/en-us/library/office/cc842372.aspx
+     * @readonly
+     * @type {string}
+     * @memberof PSTMessage
+     */
+    get emailAddress(): string;
+    /**
+     * Specifies a bit field that describes the recipient status.
+     * https://msdn.microsoft.com/en-us/library/office/cc815629.aspx
+     * @readonly
+     * @type {number}
+     * @memberof PSTRecipient
+     */
+    get recipientFlags(): number;
+    /**
+     * Specifies the location of the current recipient in the recipient table.
+     * https://msdn.microsoft.com/en-us/library/ee201359(v=exchg.80).aspx
+     * @readonly
+     * @type {number}
+     * @memberof PSTRecipient
+     */
+    get recipientOrder(): number;
+    /**
+     * Contains the SMTP address for the address book object.
+     * https://msdn.microsoft.com/en-us/library/office/cc842421.aspx
+     * @readonly
+     * @type {string}
+     * @memberof PSTRecipient
+     */
+    get smtpAddress(): string;
+    /**
+     * JSON stringify the object properties.
+     * @returns {string}
+     * @memberof PSTRecipient
+     */
+    toJSON(): any;
+}

package/dist/PSTRecipient.class.js

@@ -0,0 +1,105 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PSTRecipient = void 0;
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const OutlookProperties_1 = require("./OutlookProperties");
+const PSTObject_class_1 = require("./PSTObject.class");
+// Class containing recipient information
+class PSTRecipient extends PSTObject_class_1.PSTObject {
+    /**
+     * Creates an instance of PSTRecipient.
+     * @internal
+     * @param {Map<number, PSTTableItem>} recipientDetails
+     * @memberof PSTRecipient
+     */
+    constructor(rootProvider, node, subNode, propertyFinder) {
+        super(rootProvider, node, subNode, propertyFinder);
+    }
+    /**
+     * Contains the recipient type for a message recipient.
+     * https://msdn.microsoft.com/en-us/library/office/cc839620.aspx
+     * @readonly
+     * @type {number}
+     * @memberof PSTMessage
+     */
+    get recipientType() {
+        return this.getIntItem(OutlookProperties_1.OutlookProperties.PR_RECIPIENT_TYPE);
+    }
+    /**
+     * Contains the messaging user's e-mail address type, such as SMTP.
+     * https://msdn.microsoft.com/en-us/library/office/cc815548.aspx
+     * @readonly
+     * @type {string}
+     * @memberof PSTMessage
+     */
+    get addrType() {
+        return this.getStringItem(OutlookProperties_1.OutlookProperties.PR_ADDRTYPE);
+    }
+    /**
+     * Contains the messaging user's e-mail address.
+     * https://msdn.microsoft.com/en-us/library/office/cc842372.aspx
+     * @readonly
+     * @type {string}
+     * @memberof PSTMessage
+     */
+    get emailAddress() {
+        return this.getStringItem(OutlookProperties_1.OutlookProperties.PR_EMAIL_ADDRESS);
+    }
+    /**
+     * Specifies a bit field that describes the recipient status.
+     * https://msdn.microsoft.com/en-us/library/office/cc815629.aspx
+     * @readonly
+     * @type {number}
+     * @memberof PSTRecipient
+     */
+    get recipientFlags() {
+        return this.getIntItem(OutlookProperties_1.OutlookProperties.PR_RECIPIENT_FLAGS);
+    }
+    /**
+     * Specifies the location of the current recipient in the recipient table.
+     * https://msdn.microsoft.com/en-us/library/ee201359(v=exchg.80).aspx
+     * @readonly
+     * @type {number}
+     * @memberof PSTRecipient
+     */
+    get recipientOrder() {
+        return this.getIntItem(OutlookProperties_1.OutlookProperties.PidTagRecipientOrder);
+    }
+    /**
+     * Contains the SMTP address for the address book object.
+     * https://msdn.microsoft.com/en-us/library/office/cc842421.aspx
+     * @readonly
+     * @type {string}
+     * @memberof PSTRecipient
+     */
+    get smtpAddress() {
+        // If the recipient address type is SMTP, we can simply return the recipient address.
+        const addressType = this.addrType;
+        if (addressType != null && addressType.toLowerCase() === 'smtp') {
+            const addr = this.emailAddress;
+            if (addr != null && addr.length != 0) {
+                return addr;
+            }
+        }
+        // Otherwise, we have to hope the SMTP address is present as the PidTagPrimarySmtpAddress property.
+        return this.getStringItem(OutlookProperties_1.OutlookProperties.PR_SMTP_ADDRESS);
+    }
+    /**
+     * JSON stringify the object properties.
+     * @returns {string}
+     * @memberof PSTRecipient
+     */
+    toJSON() {
+        const clone = Object.assign({
+            displayName: this.displayName,
+            smtpAddress: this.smtpAddress,
+            recipientType: this.recipientType,
+            addrType: this.addrType,
+            emailAddress: this.emailAddress,
+            recipientFlags: this.recipientFlags,
+            recipientOrder: this.recipientOrder,
+        }, this);
+        return clone;
+    }
+}
+exports.PSTRecipient = PSTRecipient;

package/dist/PSTTask.class.d.ts

@@ -0,0 +1,146 @@
+import { PSTMessage } from './PSTMessage.class';
+import { RecurrencePattern } from './RecurrencePattern.class';
+import { PLNode } from './PLNode';
+import { PropertyFinder } from './PAUtil';
+import { PLSubNode } from './PLSubNode';
+import { RootProvider } from './RootProvider';
+export declare class PSTTask extends PSTMessage {
+    /**
+     * Creates an instance of PSTTask.
+     * @internal
+     * @param {PSTFile} rootProvider
+     * @param {DescriptorIndexNode} descriptorIndexNode
+     * @param {Map<number, PSTDescriptorItem>} [localDescriptorItems]
+     * @memberof PSTTask
+     */
+    constructor(rootProvider: RootProvider, node: PLNode, subNode: PLSubNode, propertyFinder: 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(): number;
+    /**
+     * 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(): number;
+    /**
+     * 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(): Date | null;
+    /**
+     * 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(): 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
+     * @type {number}
+     * @memberof PSTTask
+     */
+    get taskEstimatedEffort(): number;
+    /**
+     * 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(): number;
+    /**
+     * Indicates the task is complete.
+     * https://msdn.microsoft.com/en-us/library/office/cc839514.aspx
+     * @readonly
+     * @type {boolean}
+     * @memberof PSTTask
+     */
+    get isTaskComplete(): boolean;
+    /**
+     * Contains the name of the task owner.
+     * https://msdn.microsoft.com/en-us/library/office/cc842363.aspx
+     * @readonly
+     * @type {string}
+     * @memberof PSTTask
+     */
+    get taskOwner(): string;
+    /**
+     * 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(): string;
+    /**
+     * 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(): string;
+    /**
+     * Provides an aid to custom sorting tasks.
+     * https://msdn.microsoft.com/en-us/library/office/cc765654.aspx
+     * @readonly
+     * @type {number}
+     * @memberof PSTTask
+     */
+    get taskOrdinal(): number;
+    /**
+     * Indicates whether the task includes a recurrence pattern.
+     * https://msdn.microsoft.com/en-us/library/office/cc765875.aspx
+     * @type {boolean}
+     * @memberof PSTTask
+     */
+    get isTaskRecurring(): boolean;
+    /**
+     * https://docs.microsoft.com/en-us/office/client-developer/outlook/mapi/pidlidtaskrecurrence-canonical-property
+     * @type {RecurrencePattern}
+     * @memberof PSTTask
+     */
+    get taskRecurrencePattern(): RecurrencePattern | null;
+    /**
+     * https://docs.microsoft.com/en-us/office/client-developer/outlook/mapi/pidlidtaskdeadoccurrence-canonical-property
+     * @type {boolean}
+     * @memberof PSTTask
+     */
+    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
+     * @type {number}
+     * @memberof PSTTask
+     */
+    get taskOwnership(): number;
+    /**
+     * Indicates the acceptance state of the task.
+     * https://msdn.microsoft.com/en-us/library/office/cc839689.aspx
+     * @readonly
+     * @type {number}
+     * @memberof PSTTask
+     */
+    get acceptanceState(): number;
+    /**
+     * JSON stringify the object properties.
+     * @returns {string}
+     * @memberof PSTTask
+     */
+    toJSON(): any;
+}