@hiraokahypertools/pst-extractor 0.1.0-alpha.1

package/dist/PSTFile.class.d.ts

@@ -0,0 +1,144 @@
+import Long from 'long';
+import { PSTFolder } from './PSTFolder.class';
+import { PSTMessageStore } from './PSTMessageStore.class';
+import { NodeMap } from './NodeMap.class';
+import { PSTOpts } from './PSTOpts';
+import { PLStore } from './PLStore';
+export declare class PSTFile {
+    /**
+     * @internal
+     */
+    static ENCRYPTION_TYPE_NONE: number;
+    /**
+     * @internal
+     */
+    static ENCRYPTION_TYPE_COMPRESSIBLE: number;
+    static MESSAGE_STORE_DESCRIPTOR_IDENTIFIER: number;
+    static ROOT_FOLDER_DESCRIPTOR_IDENTIFIER: number;
+    /**
+     * @internal
+     */
+    static PST_TYPE_ANSI: number;
+    /**
+     * @internal
+     */
+    static PST_TYPE_ANSI_2: number;
+    /**
+     * @internal
+     */
+    static PST_TYPE_UNICODE: number;
+    /**
+     * @internal
+     */
+    static PST_TYPE_2013_UNICODE: number;
+    /**
+     * @internal
+     */
+    static PS_PUBLIC_STRINGS: number;
+    /**
+     * @internal
+     */
+    static PS_INTERNET_HEADERS: number;
+    /**
+     * @internal
+     */
+    static PSETID_Messaging: number;
+    /**
+     * @internal
+     */
+    static PSETID_Note: number;
+    /**
+     * @internal
+     */
+    static PSETID_PostRss: number;
+    /**
+     * @internal
+     */
+    static PSETID_Task: number;
+    /**
+     * @internal
+     */
+    static PSETID_UnifiedMessaging: number;
+    /**
+     * @internal
+     */
+    static PS_MAPI: number;
+    /**
+     * @internal
+     */
+    static PSETID_AirSync: number;
+    /**
+     * @internal
+     */
+    static PSETID_Sharing: number;
+    private _store;
+    private _resolver;
+    private static nodeMap;
+    /**
+     * Creates an instance of PSTFile.  File is opened in constructor.
+     * @internal
+     * @param {string} fileName
+     * @memberof PSTFile
+     */
+    constructor(store: PLStore, nodeMap: NodeMap, opts?: PSTOpts);
+    /**
+     * Close the file.
+     * @memberof PSTFile
+     */
+    close(): Promise<void>;
+    /**
+     * Get name to ID map item.
+     * @param {number} key
+     * @param {number} idx
+     * @returns {number}
+     * @memberof PSTFile
+     */
+    getNameToIdMapItem(key: number, idx: number): number;
+    /**
+     * Get public string to id map item.
+     * @static
+     * @param {string} key
+     * @returns {number}
+     * @memberof PSTFile
+     */
+    static getPublicStringToIdMapItem(key: string): number;
+    /**
+     * Get property name from id.
+     * @static
+     * @param {number} propertyId
+     * @param {boolean} bNamed
+     * @returns {string}
+     * @memberof PSTFile
+     */
+    static getPropertyName(propertyId: number, bNamed: boolean): string | undefined;
+    /**
+     * Get name to id map key.
+     * @static
+     * @param {number} propId
+     * @returns {long}
+     * @memberof PSTFile
+     */
+    static getNameToIdMapKey(propId: number): Long | undefined;
+    /**
+     * Get the message store of the PST file.  Note that this doesn't really
+     * have much information, better to look under the root folder.
+     * @returns {PSTMessageStore}
+     * @memberof PSTFile
+     */
+    getMessageStore(): Promise<PSTMessageStore>;
+    private getFolderOf;
+    private getItemOf;
+    /**
+     * Get the root folder for the PST file
+     * @returns {PSTFolder}
+     * @memberof PSTFile
+     */
+    getRootFolder(): Promise<PSTFolder>;
+    private getRootProvider;
+    /**
+     * JSON stringify the object properties.
+     * @returns {string}
+     * @memberof PSTFile
+     */
+    toJSON(): any;
+}

package/dist/PSTFile.class.js

@@ -0,0 +1,221 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PSTFile = void 0;
+const PSTFolder_class_1 = require("./PSTFolder.class");
+const PSTMessageStore_class_1 = require("./PSTMessageStore.class");
+const PSTUtil_class_1 = require("./PSTUtil.class");
+const NodeMap_class_1 = require("./NodeMap.class");
+const PAUtil_1 = require("./PAUtil");
+const PHUtil_1 = require("./PHUtil");
+const PropertyContextUtil_1 = require("./PropertyContextUtil");
+const PropertyValueResolverV1_1 = require("./PropertyValueResolverV1");
+const iconv_lite_1 = __importDefault(require("iconv-lite"));
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+class PSTFile {
+    /**
+     * Creates an instance of PSTFile.  File is opened in constructor.
+     * @internal
+     * @param {string} fileName
+     * @memberof PSTFile
+     */
+    constructor(store, nodeMap, opts) {
+        PSTFile.nodeMap = nodeMap;
+        this._store = store;
+        this._resolver = new PropertyValueResolverV1_1.PropertyValueResolverV1((array) => __awaiter(this, void 0, void 0, function* () {
+            return iconv_lite_1.default.decode(Buffer.from(array), (opts && opts.ansiEncoding) || "latin1");
+        }));
+    }
+    /**
+     * Close the file.
+     * @memberof PSTFile
+     */
+    close() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this._store.close();
+        });
+    }
+    /**
+     * Get name to ID map item.
+     * @param {number} key
+     * @param {number} idx
+     * @returns {number}
+     * @memberof PSTFile
+     */
+    getNameToIdMapItem(key, idx) {
+        return PSTFile.nodeMap.getId(key, idx);
+    }
+    /**
+     * Get public string to id map item.
+     * @static
+     * @param {string} key
+     * @returns {number}
+     * @memberof PSTFile
+     */
+    static getPublicStringToIdMapItem(key) {
+        return PSTFile.nodeMap.getId(key);
+    }
+    /**
+     * Get property name from id.
+     * @static
+     * @param {number} propertyId
+     * @param {boolean} bNamed
+     * @returns {string}
+     * @memberof PSTFile
+     */
+    static getPropertyName(propertyId, bNamed) {
+        return PSTUtil_class_1.PSTUtil.propertyName.get(propertyId);
+    }
+    /**
+     * Get name to id map key.
+     * @static
+     * @param {number} propId
+     * @returns {long}
+     * @memberof PSTFile
+     */
+    static getNameToIdMapKey(propId) {
+        return PSTFile.nodeMap.getNumericName(propId);
+    }
+    /**
+     * Get the message store of the PST file.  Note that this doesn't really
+     * have much information, better to look under the root folder.
+     * @returns {PSTMessageStore}
+     * @memberof PSTFile
+     */
+    getMessageStore() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const node = this._store.getOneNodeBy(PSTFile.MESSAGE_STORE_DESCRIPTOR_IDENTIFIER);
+            if (node === undefined) {
+                throw new Error("MESSAGE_STORE_DESCRIPTOR not found");
+            }
+            const heap = yield (0, PHUtil_1.getHeapFrom)(node.getSubNode());
+            const pc = yield (0, PropertyContextUtil_1.getPropertyContext)(heap, this._resolver);
+            const propertyFinder = (0, PAUtil_1.createPropertyFinder)(yield pc.list());
+            return new PSTMessageStore_class_1.PSTMessageStore(this.getRootProvider(), node, node.getSubNode(), propertyFinder);
+        });
+    }
+    getFolderOf(node) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const heap = yield (0, PHUtil_1.getHeapFrom)(node.getSubNode());
+            const pc = yield (0, PropertyContextUtil_1.getPropertyContext)(heap, this._resolver);
+            const propertyFinder = (0, PAUtil_1.createPropertyFinder)(yield pc.list());
+            const output = new PSTFolder_class_1.PSTFolder(this.getRootProvider(), node, node.getSubNode(), propertyFinder);
+            return output;
+        });
+    }
+    getItemOf(node, subNode, propertyFinder) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield PSTUtil_class_1.PSTUtil.createAppropriatePSTMessageObject(this.getRootProvider(), node, subNode, this._resolver, propertyFinder);
+        });
+    }
+    /**
+     * Get the root folder for the PST file
+     * @returns {PSTFolder}
+     * @memberof PSTFile
+     */
+    getRootFolder() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const node = this._store.getOneNodeBy(PSTFile.ROOT_FOLDER_DESCRIPTOR_IDENTIFIER);
+            if (node === undefined) {
+                throw new Error("ROOT_FOLDER_DESCRIPTOR not found");
+            }
+            return yield this.getFolderOf(node);
+        });
+    }
+    getRootProvider() {
+        return {
+            resolver: this._resolver,
+            getNameToIdMapItem: this.getNameToIdMapItem.bind(this),
+            getItemOf: this.getItemOf.bind(this),
+            getFolderOf: this.getFolderOf.bind(this),
+        };
+    }
+    /**
+     * JSON stringify the object properties.
+     * @returns {string}
+     * @memberof PSTFile
+     */
+    toJSON() {
+        return this;
+    }
+}
+exports.PSTFile = PSTFile;
+/**
+ * @internal
+ */
+PSTFile.ENCRYPTION_TYPE_NONE = 0;
+/**
+ * @internal
+ */
+PSTFile.ENCRYPTION_TYPE_COMPRESSIBLE = 1;
+PSTFile.MESSAGE_STORE_DESCRIPTOR_IDENTIFIER = 33;
+PSTFile.ROOT_FOLDER_DESCRIPTOR_IDENTIFIER = 290;
+/**
+ * @internal
+ */
+PSTFile.PST_TYPE_ANSI = 14;
+/**
+ * @internal
+ */
+PSTFile.PST_TYPE_ANSI_2 = 15;
+/**
+ * @internal
+ */
+PSTFile.PST_TYPE_UNICODE = 23;
+/**
+ * @internal
+ */
+PSTFile.PST_TYPE_2013_UNICODE = 36;
+/**
+ * @internal
+ */
+PSTFile.PS_PUBLIC_STRINGS = 0;
+/**
+ * @internal
+ */
+PSTFile.PS_INTERNET_HEADERS = 3;
+/**
+ * @internal
+ */
+PSTFile.PSETID_Messaging = 7;
+/**
+ * @internal
+ */
+PSTFile.PSETID_Note = 8;
+/**
+ * @internal
+ */
+PSTFile.PSETID_PostRss = 9;
+/**
+ * @internal
+ */
+PSTFile.PSETID_Task = 10;
+/**
+ * @internal
+ */
+PSTFile.PSETID_UnifiedMessaging = 11;
+/**
+ * @internal
+ */
+PSTFile.PS_MAPI = 12;
+/**
+ * @internal
+ */
+PSTFile.PSETID_AirSync = 13;
+/**
+ * @internal
+ */
+PSTFile.PSETID_Sharing = 14;
+// node tree maps
+PSTFile.nodeMap = new NodeMap_class_1.NodeMap();

package/dist/PSTFolder.class.d.ts

@@ -0,0 +1,111 @@
+import { PSTObject } from './PSTObject.class';
+import { PLNode } from './PLNode';
+import { PropertyFinder } from './PAUtil';
+import { PSTMessage } from './PSTMessage.class';
+import { PLSubNode } from './PLSubNode';
+import { RootProvider } from './RootProvider';
+/**
+ * Represents a folder in the PST File.  Allows you to access child folders or items.
+ * Items are accessed through a sort of cursor arrangement.  This allows for
+ * incremental reading of a folder which may have _lots_ of emails.
+ * @export
+ * @class PSTFolder
+ * @extends {PSTObject}
+ */
+export declare class PSTFolder extends PSTObject {
+    private _subFoldersProvider;
+    private _emailsProvider;
+    /**
+     * Creates an instance of PSTFolder.
+     * Represents a folder in the PST File.  Allows you to access child folders or items.
+     * Items are accessed through a sort of cursor arrangement.  This allows for
+     * incremental reading of a folder which may have _lots_ of emails.
+     * @internal
+     * @param {PSTFile} rootProvider
+     * @param {DescriptorIndexNode} descriptorIndexNode
+     * @param {Map<number, PSTDescriptorItem>} [localDescriptorItems]
+     * @memberof PSTFolder
+     */
+    constructor(rootProvider: RootProvider, node: PLNode, subNode: PLSubNode, propertyFinder: PropertyFinder);
+    private getEmailsProvider;
+    private getSubFoldersProvider;
+    /**
+     * Get folders in one fell swoop, since there's not usually thousands of them.
+     * @returns {PSTFolder[]}
+     * @memberof PSTFolder
+     */
+    getSubFolders(): Promise<PSTFolder[]>;
+    getSubFolder(index: number): Promise<PSTFolder>;
+    /**
+     * The number of child folders in this folder
+     * @readonly
+     * @type {number}
+     * @memberof PSTFolder
+     */
+    getSubFolderCount(): Promise<number>;
+    /**
+     * Number of emails in this folder
+     * @readonly
+     * @type {number}
+     * @memberof PSTFolder
+     */
+    getEmailCount(): Promise<number>;
+    getEmail(index: number): Promise<PSTMessage>;
+    getEmails(): Promise<PSTMessage[]>;
+    /**
+     * Contains a constant that indicates the folder type.
+     * https://msdn.microsoft.com/en-us/library/office/cc815373.aspx
+     * @readonly
+     * @type {number}
+     * @memberof PSTFolder
+     */
+    get folderType(): number;
+    /**
+     * Contains the number of messages in a folder, as computed by the message store.
+     * For a number calculated by the library use getEmailCount
+     * @readonly
+     * @type {number}
+     * @memberof PSTFolder
+     */
+    get contentCount(): number;
+    /**
+     * Contains the number of unread messages in a folder, as computed by the message store.
+     * https://msdn.microsoft.com/en-us/library/office/cc841964.aspx
+     * @readonly
+     * @type {number}
+     * @memberof PSTFolder
+     */
+    get unreadCount(): number;
+    /**
+     * Contains TRUE if a folder contains subfolders.
+     * once again, read from the PST, use getSubFolderCount if you want to know
+     * @readonly
+     * @type {boolean}
+     * @memberof PSTFolder
+     */
+    get hasSubfolders(): boolean;
+    /**
+     * Contains a text string describing the type of a folder. Although this property is
+     * generally ignored, versions of Microsoft® Exchange Server prior to Exchange Server
+     * 2003 Mailbox Manager expect this property to be present.
+     * https://msdn.microsoft.com/en-us/library/office/cc839839.aspx
+     * @readonly
+     * @type {string}
+     * @memberof PSTFolder
+     */
+    get containerClass(): string;
+    /**
+     * Contains a bitmask of flags describing capabilities of an address book container.
+     * https://msdn.microsoft.com/en-us/library/office/cc839610.aspx
+     * @readonly
+     * @type {number}
+     * @memberof PSTFolder
+     */
+    get containerFlags(): number;
+    /**
+     * JSON stringify the object properties.
+     * @returns {string}
+     * @memberof PSTFolder
+     */
+    toJSON(): any;
+}