sec-edgar-api 0.0.3 → 0.0.6

package/build/services/DocumentParser/parsers/parse-form-13g.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseForm13g = void 0;
+var XMLParser_1 = require("../XMLParser");
+/**
+ * Form SC 13G - Holders
+ *
+ * example at https://www.sec.gov/Archives/edgar/data/320193/000119312523038262/d382361dsc13ga.htm
+ */
+function parseForm13g(params, xmlParser) {
+    var _a, _b, _c, _d;
+    if (xmlParser === void 0) { xmlParser = new XMLParser_1.default(); }
+    var xml = params.xml;
+    var textMap = xmlParser.getTableTextMap({ xml: xml });
+    var holders = [];
+    var getKey = function (text) {
+        var keyMap = {
+            'name of reporting': 'name',
+            'names of reporting': 'name',
+            'citizenship or place': 'origin',
+            'sole voting power': 'votingPowerSole',
+            'shared voting power': 'votingPowerShared',
+            'sole dispositive power': 'dispositivePowerSole',
+            'shared dispositive power': 'dispositivePowerShared',
+            'aggregate amount beneficially owned': 'shares',
+            'percent of class': 'percentOfClass',
+            'type of reporting person': 'typeOfReportingPerson',
+        };
+        var textLower = text.toLowerCase();
+        for (var key in keyMap) {
+            if (textLower.includes(key))
+                return keyMap[key];
+        }
+        return null;
+    };
+    var _loop_1 = function (text) {
+        var colName = getKey(text);
+        var isNewHolder = colName === 'name';
+        if (isNewHolder) {
+            if (((_a = holders[holders.length - 1]) === null || _a === void 0 ? void 0 : _a.name) === '') {
+                holders.pop();
+            }
+            holders.push({
+                name: '',
+                origin: '',
+                shares: 0,
+                percentOfClass: '',
+                votingPowerSole: null,
+                votingPowerShared: null,
+                dispositivePowerSole: null,
+                dispositivePowerShared: null,
+                typeOfReportingPerson: null,
+            });
+        }
+        var holder = holders[holders.length - 1];
+        // continue if no colName or if the value is already set
+        if (colName === null || ![0, '', null].includes(holder[colName]))
+            return "continue";
+        var textParts = text.split(' ').filter(function (t) { return t.trim() !== ''; });
+        var colNameIndex = textParts.findIndex(function (t) { return getKey(t) === colName; });
+        var value = (_c = (_b = textParts[colNameIndex + 1]) === null || _b === void 0 ? void 0 : _b.trim()) !== null && _c !== void 0 ? _c : '';
+        switch (colName) {
+            case 'shares':
+                holder.shares = Number(value.replace(/[^0-9]/g, '')) || 0;
+                break;
+            case 'typeOfReportingPerson':
+                holder[colName] = value === '' ? null : value;
+                break;
+            case 'votingPowerSole':
+            case 'votingPowerShared':
+            case 'dispositivePowerSole':
+            case 'dispositivePowerShared':
+                holder[colName] = value.toLowerCase() === 'none' ? null : value;
+                break;
+            default:
+                holder[colName] = value;
+        }
+    };
+    for (var _i = 0, _e = Array.from(textMap.values()); _i < _e.length; _i++) {
+        var text = _e[_i];
+        _loop_1(text);
+    }
+    if (((_d = holders[holders.length - 1]) === null || _d === void 0 ? void 0 : _d.name) === '') {
+        holders.pop();
+    }
+    return holders;
+}
+exports.parseForm13g = parseForm13g;

package/build/services/DocumentParser/parsers/parse-form-4.d.ts

@@ -0,0 +1,8 @@
+import { InsiderTransaction, XMLParams } from '../../../types';
+import XMLParser from '../XMLParser';
+/**
+ * Form 4 - Insider Transactions
+ *
+ * example at https://www.sec.gov/Archives/edgar/data/320193/000032019323000079/xslF345X05/wk-form4_1691533817.xml
+ */
+export declare function parseForm4(params: XMLParams, xmlParser?: XMLParser): InsiderTransaction[];

package/build/services/DocumentParser/parsers/parse-form-4.js

@@ -0,0 +1,220 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseForm4 = void 0;
+var XMLParser_1 = require("../XMLParser");
+/**
+ * Form 4 - Insider Transactions
+ *
+ * example at https://www.sec.gov/Archives/edgar/data/320193/000032019323000079/xslF345X05/wk-form4_1691533817.xml
+ */
+function parseForm4(params, xmlParser) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
+    if (xmlParser === void 0) { xmlParser = new XMLParser_1.default(); }
+    var xml = params.xml;
+    var textMap = xmlParser.getTableTextMap({ xml: xml, parentPath: 'html.body' });
+    var getTextBetween = function (text, before, after) {
+        var indexBefore = text.indexOf(before);
+        var indexAfter = after ? text.indexOf(after, indexBefore) : text.length;
+        return text.substring(indexBefore + before.length, indexAfter).trim();
+    };
+    var relationText = (_a = textMap.get('2.1.3')) !== null && _a !== void 0 ? _a : '';
+    var filerNameText = (_b = textMap.get('2.1.1')) !== null && _b !== void 0 ? _b : '';
+    var filterNameText = getTextBetween(filerNameText, '1. Name and Address of Reporting Person*', '(Last)');
+    var isDirector = relationText.substring(0, relationText.indexOf('Director')).includes('X');
+    var isOwner10 = getTextBetween(relationText, 'Director', '10% Owner').includes('X');
+    var isOfficer = getTextBetween(relationText, '10% Owner', 'Officer (give title below)').includes('X');
+    var isOther = getTextBetween(relationText, 'Officer (give title below)', 'Other (specify below)').includes('X');
+    var position = getTextBetween(relationText, 'Other (specify below)');
+    var filerPositionTypes = [];
+    if (isDirector)
+        filerPositionTypes.push('Director');
+    if (isOwner10)
+        filerPositionTypes.push('10% Owner');
+    if (isOfficer)
+        filerPositionTypes.push('Officer');
+    if (isOther)
+        filerPositionTypes.push('Other');
+    var codeTranslations = {
+        P: 'Purchase',
+        S: 'Sale',
+        V: 'Voluntary Reporting',
+        A: 'Grant',
+        D: 'Sale to Issuer',
+        F: 'Payment of Exercise Price',
+        I: 'Discretionary Transaction',
+        M: 'Conversion of Derivative Exempt',
+        C: 'Conversion of Derivative',
+        E: 'Expiration of Short Derivative Position',
+        H: 'Expiration of Long Derivative Position',
+        O: 'Exercise of out-of-the-money Derivative',
+        X: 'Exercise of in-the-money Derivative',
+        G: 'Gift',
+        L: 'Small Acquisition',
+        W: 'Acquisition or Disposition By Will or Laws',
+        Z: 'Voting Trust Deposit or Withdrawal',
+        J: 'Other Acquisition or Disposition',
+        K: 'Equity Swap',
+        U: 'Disposition Change in Control',
+    };
+    var toDate = function (str) {
+        if (str === '')
+            return '';
+        var _a = str.split('/'), month = _a[0], day = _a[1], year = _a[2];
+        return [month, day, year].some(function (x) { return x === undefined; }) ? '' : "".concat(year, "-").concat(month, "-").concat(day);
+    };
+    var createTransaction = function () { return ({
+        filerName: filterNameText,
+        filerPosition: position,
+        filerPositionTypes: filerPositionTypes,
+        category: 'Non-Derivative',
+        securityType: '',
+        securityTypeUnderlying: null,
+        date: '',
+        dateExecuted: null,
+        dateExpiration: null,
+        dateExercisable: null,
+        transactionType: null,
+        transactionCode: null,
+        transactionDescription: null,
+        price: null,
+        priceExcercised: null,
+        shares: null,
+        sharesUnderlying: null,
+        sharesEnding: null,
+        ownership: '',
+        explainationByKey: {},
+    }); };
+    var getColText = function (colKey) {
+        var _a, _b;
+        var text = (_a = textMap.get(colKey)) === null || _a === void 0 ? void 0 : _a.replace(/\(\d+\)|\$/g, '');
+        return (_b = text === null || text === void 0 ? void 0 : text.trim()) !== null && _b !== void 0 ? _b : '';
+    };
+    var headingNonDerivative = [
+        'securityType',
+        'date',
+        'dateExecuted',
+        'transactionCode',
+        '',
+        'shares',
+        'transactionType',
+        'price',
+        'sharesEnding',
+        'ownership',
+    ];
+    var headingDerivative = [
+        'securityType',
+        'priceExcercised',
+        'date',
+        'dateExecuted',
+        'transactionCode',
+        '',
+        'shares',
+        'shares',
+        'dateExercisable',
+        'dateExpiration',
+        'securityTypeUnderlying',
+        'sharesUnderlying',
+        'price',
+        'sharesEnding',
+        'ownership',
+    ];
+    var maxIterations = 10000;
+    var transactions = [];
+    transactionsNonDerivative: for (var row = 4; row < maxIterations; row++) {
+        var transaction = createTransaction();
+        transaction.category = 'Non-Derivative';
+        // get all non-derivative transactions
+        for (var col = 1; col < 11; col++) {
+            var colName = ((_c = headingNonDerivative[col - 1]) !== null && _c !== void 0 ? _c : '');
+            var colKey = "3.".concat(row, ".").concat(col);
+            var text = getColText(colKey);
+            var explanationNum = (_f = (_e = ((_d = textMap.get(colKey)) !== null && _d !== void 0 ? _d : '').match(/(?<=\()\d+(?=\))/g)) === null || _e === void 0 ? void 0 : _e[0]) !== null && _f !== void 0 ? _f : null;
+            var explanationText = explanationNum ? (_g = textMap.get("5.".concat(Number(explanationNum) + 1, ".1"))) !== null && _g !== void 0 ? _g : '' : null;
+            if (colName === '')
+                continue;
+            if (explanationText !== null)
+                transaction.explainationByKey[colName] = explanationText.trim();
+            if (!textMap.has(colKey))
+                break transactionsNonDerivative;
+            switch (colName) {
+                case 'transactionType':
+                    transaction.transactionType = text === 'A' ? 'Acquire' : 'Dispose';
+                    continue;
+                case 'transactionCode':
+                    transaction.transactionDescription = (_h = codeTranslations[text]) !== null && _h !== void 0 ? _h : '';
+                    transaction.transactionCode = text;
+                    continue;
+                case 'date':
+                    transaction.date = toDate(text);
+                    continue;
+                case 'dateExecuted':
+                case 'dateExercisable':
+                case 'dateExpiration':
+                    transaction[colName] = toDate(text) || null;
+                    continue;
+                case 'price':
+                case 'shares':
+                case 'sharesEnding':
+                    var valueNum = Number(text.replace(/,/g, ''));
+                    transaction[colName] = text === '' || isNaN(valueNum) ? null : valueNum;
+                    continue;
+                default:
+                    transaction[colName] = text;
+            }
+        }
+        transactions.push(transaction);
+    }
+    transactionsDerivative: for (var row = 4; row < maxIterations; row++) {
+        var transaction = createTransaction();
+        transaction.category = 'Derivative';
+        var textSharesAcquired = getColText("4.".concat(row, ".6"));
+        var textSharesDisposed = getColText("4.".concat(row, ".7"));
+        var sharesAcquired = Number(textSharesAcquired);
+        var sharesDisposed = Number(textSharesDisposed);
+        if (textSharesAcquired !== '' || textSharesDisposed !== '') {
+            transaction.transactionType = sharesAcquired - sharesDisposed > 0 ? 'Acquire' : 'Dispose';
+        }
+        for (var col = 1; col < 16; col++) {
+            var colName = ((_j = headingDerivative[col - 1]) !== null && _j !== void 0 ? _j : '');
+            var colKey = "4.".concat(row, ".").concat(col);
+            var text = ((_k = textMap.get(colKey)) !== null && _k !== void 0 ? _k : '').replace(/\(\d+\)|\$/g, '').trim();
+            var explanationNum = (_o = (_m = ((_l = textMap.get(colKey)) !== null && _l !== void 0 ? _l : '').match(/(?<=\()\d+(?=\))/g)) === null || _m === void 0 ? void 0 : _m[0]) !== null && _o !== void 0 ? _o : null;
+            var explanationText = explanationNum ? (_p = textMap.get("5.".concat(Number(explanationNum) + 1, ".1"))) !== null && _p !== void 0 ? _p : '' : null;
+            if (colName === '')
+                continue;
+            if (explanationText !== null)
+                transaction.explainationByKey[colName] = explanationText.trim();
+            if (!textMap.has(colKey))
+                break transactionsDerivative;
+            switch (colName) {
+                case 'transactionType':
+                    transaction.transactionType = text === 'A' ? 'Acquire' : 'Dispose';
+                    continue;
+                case 'transactionCode':
+                    transaction.transactionDescription = (_q = codeTranslations[text]) !== null && _q !== void 0 ? _q : '';
+                    transaction.transactionCode = text;
+                    continue;
+                case 'dateExecuted':
+                case 'dateExercisable':
+                case 'dateExpiration':
+                    transaction[colName] = toDate(text) || null;
+                    continue;
+                case 'price':
+                case 'shares':
+                case 'sharesUnderlying':
+                case 'priceExcercised':
+                case 'sharesEnding':
+                    if (colName === 'shares' && transaction.shares !== null)
+                        continue;
+                    var valueNum = Number(text.replace(/,/g, ''));
+                    transaction[colName] = text === '' || isNaN(valueNum) ? null : valueNum;
+                    continue;
+                default:
+                    transaction[colName] = text;
+            }
+        }
+        transactions.push(transaction);
+    }
+    return transactions;
+}
+exports.parseForm4 = parseForm4;

package/build/services/FactsDownloader/Downloader.d.ts

@@ -0,0 +1,26 @@
+/// <reference types="node" />
+import { WriteStream } from 'fs';
+import { IClient, RequestParams } from '../Client';
+export interface DownloadParams extends RequestParams {
+    filename: string;
+    createDirIfNotExists?: boolean;
+}
+export interface IDownloader {
+    download(params: DownloadParams): Promise<boolean>;
+}
+interface FileManager {
+    createWriteStream(path: string): WriteStream;
+    existsSync(path: string): boolean;
+    mkdirSync(path: string): void;
+}
+interface DownloaderArgs {
+    client: IClient;
+    fileManager: FileManager;
+}
+export default class Downlaoder implements IDownloader {
+    private readonly client;
+    private readonly fileManager;
+    constructor(args?: DownloaderArgs);
+    download(params: DownloadParams): Promise<boolean>;
+}
+export {};

package/build/services/FactsDownloader/Downloader.js

@@ -0,0 +1,102 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+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 __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var fs = require("fs");
+var Client_1 = require("../Client");
+var Downlaoder = /** @class */ (function () {
+    function Downlaoder(args) {
+        if (args === void 0) { args = { client: new Client_1.default(), fileManager: fs }; }
+        var client = args.client, fileManager = args.fileManager;
+        this.client = client;
+        this.fileManager = fileManager;
+    }
+    Downlaoder.prototype.download = function (params) {
+        var _this = this;
+        var filename = params.filename, onSuccess = params.onSuccess, onError = params.onError, _a = params.createDirIfNotExists, createDirIfNotExists = _a === void 0 ? false : _a, rest = __rest(params, ["filename", "onSuccess", "onError", "createDirIfNotExists"]);
+        return new Promise(function (resolve, reject) { return __awaiter(_this, void 0, void 0, function () {
+            var dir, file;
+            return __generator(this, function (_a) {
+                dir = filename.substring(0, filename.lastIndexOf('/'));
+                if (dir.length > 0 && createDirIfNotExists && !this.fileManager.existsSync(dir)) {
+                    this.fileManager.mkdirSync(dir);
+                }
+                file = this.fileManager.createWriteStream(filename);
+                file.on('close', function () { return resolve(true); });
+                file.on('finish', function () { return file.close(); });
+                file.on('error', function (err) {
+                    file.destroy();
+                    onError === null || onError === void 0 ? void 0 : onError(err);
+                    reject(false);
+                });
+                this.client
+                    .request(__assign(__assign({ onError: onError }, rest), { onResponse: function (res) {
+                        var _a;
+                        res.pipe(file);
+                        (_a = rest.onResponse) === null || _a === void 0 ? void 0 : _a.call(rest, res);
+                    } }))
+                    .then(function (res) { return onSuccess === null || onSuccess === void 0 ? void 0 : onSuccess(res); })
+                    .catch(function () { return reject(false); });
+                return [2 /*return*/];
+            });
+        }); });
+    };
+    return Downlaoder;
+}());
+exports.default = Downlaoder;

package/build/services/FactsDownloader/FactsDownloader.d.ts

@@ -0,0 +1,37 @@
+/// <reference types="node" />
+import { IDownloader } from './Downloader';
+import Unzipper from './Unzipper';
+interface FactsDownloaderArgs {
+    downloader: IDownloader;
+    unzipper: Unzipper;
+}
+interface OnChunkData {
+    percentComplete: number;
+    chunk: Buffer;
+    stage: 'download' | 'unzip';
+}
+export interface DownloadCompanyFactsDirectoryParams {
+    outputDirname: string;
+    unzip?: boolean;
+    onChunk?: (data: OnChunkData) => void;
+    onDownloadComplete?: () => void;
+    onComplete?: () => void;
+    onError?: (err: Error) => void;
+}
+export interface IFactsDownloader {
+    downloadCompanyFactsDirectory(params: DownloadCompanyFactsDirectoryParams): Promise<boolean>;
+}
+export default class FactsDownloader implements IFactsDownloader {
+    private readonly unzipper;
+    private readonly downloader;
+    constructor(args?: FactsDownloaderArgs);
+    /**
+     * Downloads the companyfacts.zip file and extracts the directory containing all company
+     * reports available from sec.gov. After downloading, you can use factFileReader and reportParser
+     * to get and read reports.
+     *
+     * Note: Over 15GB of data is downloaded and extracted.
+     */
+    downloadCompanyFactsDirectory(params: DownloadCompanyFactsDirectoryParams): Promise<boolean>;
+}
+export {};

package/build/services/FactsDownloader/FactsDownloader.js

@@ -0,0 +1,131 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+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 __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var Downloader_1 = require("./Downloader");
+var Unzipper_1 = require("./Unzipper");
+var FactsDownloader = /** @class */ (function () {
+    function FactsDownloader(args) {
+        if (args === void 0) { args = {
+            downloader: new Downloader_1.default(),
+            unzipper: new Unzipper_1.default(),
+        }; }
+        var unzipper = args.unzipper, downloader = args.downloader;
+        this.unzipper = unzipper;
+        this.downloader = downloader;
+    }
+    /**
+     * Downloads the companyfacts.zip file and extracts the directory containing all company
+     * reports available from sec.gov. After downloading, you can use factFileReader and reportParser
+     * to get and read reports.
+     *
+     * Note: Over 15GB of data is downloaded and extracted.
+     */
+    FactsDownloader.prototype.downloadCompanyFactsDirectory = function (params) {
+        return __awaiter(this, void 0, void 0, function () {
+            var outputDirname, onChunk, onDownloadComplete, onError, onComplete, _a, unzip;
+            var _this = this;
+            return __generator(this, function (_b) {
+                outputDirname = params.outputDirname, onChunk = params.onChunk, onDownloadComplete = params.onDownloadComplete, onError = params.onError, onComplete = params.onComplete, _a = params.unzip, unzip = _a === void 0 ? true : _a;
+                return [2 /*return*/, new Promise(function (resolve, reject) { return __awaiter(_this, void 0, void 0, function () {
+                        var filename, e_1;
+                        return __generator(this, function (_a) {
+                            switch (_a.label) {
+                                case 0:
+                                    filename = "".concat(outputDirname, ".zip");
+                                    _a.label = 1;
+                                case 1:
+                                    _a.trys.push([1, 5, , 6]);
+                                    // download from sec
+                                    return [4 /*yield*/, this.downloader.download({
+                                            url: 'https://www.sec.gov/Archives/edgar/daily-index/xbrl/companyfacts.zip',
+                                            filename: filename,
+                                            createDirIfNotExists: true,
+                                            resolveData: false,
+                                            headers: {
+                                                'Accept-Encoding': 'gzip, deflate',
+                                            },
+                                            onError: function (err) { return reject(err); },
+                                            onChunk: onChunk ? function (data) { return onChunk === null || onChunk === void 0 ? void 0 : onChunk(__assign(__assign({}, data), { stage: 'download' })); } : undefined,
+                                        })];
+                                case 2:
+                                    // download from sec
+                                    _a.sent();
+                                    onDownloadComplete === null || onDownloadComplete === void 0 ? void 0 : onDownloadComplete();
+                                    if (!unzip) return [3 /*break*/, 4];
+                                    // unzip companyfacts.zip
+                                    return [4 /*yield*/, this.unzipper.unzip({
+                                            inputFilename: filename,
+                                            outputDirname: outputDirname,
+                                            deleteOriginal: true,
+                                            onError: function (err) { return reject(err); },
+                                            onChunk: onChunk ? function (data) { return onChunk === null || onChunk === void 0 ? void 0 : onChunk(__assign(__assign({}, data), { stage: 'unzip' })); } : undefined,
+                                        })];
+                                case 3:
+                                    // unzip companyfacts.zip
+                                    _a.sent();
+                                    _a.label = 4;
+                                case 4:
+                                    onComplete === null || onComplete === void 0 ? void 0 : onComplete();
+                                    resolve(true);
+                                    return [3 /*break*/, 6];
+                                case 5:
+                                    e_1 = _a.sent();
+                                    onError === null || onError === void 0 ? void 0 : onError(e_1);
+                                    reject(e_1);
+                                    return [3 /*break*/, 6];
+                                case 6: return [2 /*return*/];
+                            }
+                        });
+                    }); })];
+            });
+        });
+    };
+    return FactsDownloader;
+}());
+exports.default = FactsDownloader;

package/build/services/FactsDownloader/Unzipper.d.ts

@@ -0,0 +1,40 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import * as fs from 'fs';
+import { ReadStream } from 'fs';
+import { ParseStream } from 'unzipper';
+interface IFileManager {
+    createReadStream(path: string): ReadStream;
+    unlinkSync(path: string): void;
+    statSync(path: string): fs.Stats;
+}
+interface IFileUnzipper {
+    Extract(options: {
+        path: string;
+    }): ParseStream;
+}
+interface UnzipperArgs {
+    unzipper: IFileUnzipper;
+    fileManager: IFileManager;
+}
+interface OnChunkData {
+    percentComplete: number;
+    chunk: Buffer;
+}
+interface UnzipParams {
+    inputFilename: string;
+    outputDirname: string;
+    onChunk?: (data: OnChunkData) => void;
+    onError?: (err: Error) => void;
+    deleteOriginal?: boolean;
+}
+export interface IUnzipper {
+    unzip(params: UnzipParams): Promise<any>;
+}
+export default class Unzipper implements IUnzipper {
+    private readonly fileManager;
+    private readonly unzipper;
+    constructor(args?: UnzipperArgs);
+    unzip(params: UnzipParams): Promise<unknown>;
+}
+export {};