sec-edgar-api 0.0.1

package/build/services/SecEdgarApi/SecConnector.d.ts

@@ -0,0 +1,47 @@
+import { CompanyFactFrame, CompanyFactListData, MultiCompanyFactFrame } from '../../types';
+import { SubmissionList } from '../../types/submission.type';
+import { IClient } from './Client';
+import { IThrottler } from './Throttler';
+interface SecApiArgs {
+    throttler: IThrottler;
+    client: IClient;
+    cikBySymbol: Record<string, number>;
+}
+export interface GetSymbolParams {
+    symbol: string;
+}
+export interface GetFactParams {
+    symbol: string;
+    fact: string;
+    taxonomy?: 'us-gaap' | 'dei' | 'invest' | string;
+}
+export interface GetFactFrameParams {
+    fact: string;
+    frame: string;
+    unit?: 'pure' | 'USD' | 'shares' | string;
+    taxonomy?: 'us-gaap' | 'dei' | 'invest' | string;
+}
+export interface ISecConnector {
+    getSubmissions(params: GetSymbolParams): Promise<SubmissionList>;
+    getFact(params: GetFactParams): Promise<CompanyFactFrame>;
+    getFacts(params: GetSymbolParams): Promise<CompanyFactListData>;
+    getFactFrame(params: GetFactFrameParams): Promise<MultiCompanyFactFrame>;
+}
+/**
+ * Gets reports from companies filed with the SEC
+ *
+ * @see https://www.sec.gov/edgar/sec-api-documentation
+ */
+export default class SecConnector implements ISecConnector {
+    private readonly throttler;
+    private readonly client;
+    private readonly cikBySymbol;
+    constructor(args?: SecApiArgs);
+    private getCikString;
+    private request;
+    getSubmissions(params: GetSymbolParams): Promise<SubmissionList>;
+    getFact(params: GetFactParams): Promise<CompanyFactFrame>;
+    getFacts(params: GetSymbolParams): Promise<CompanyFactListData>;
+    getFactFrame(params: GetFactFrameParams): Promise<MultiCompanyFactFrame>;
+}
+export {};

package/build/services/SecEdgarApi/SecConnector.js

@@ -0,0 +1,143 @@
+"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 __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 cik_by_symbol_1 = require("../../util/cik-by-symbol");
+var Client_1 = require("./Client");
+var Throttler_1 = require("./Throttler");
+/**
+ * Gets reports from companies filed with the SEC
+ *
+ * @see https://www.sec.gov/edgar/sec-api-documentation
+ */
+var SecConnector = /** @class */ (function () {
+    function SecConnector(args) {
+        if (args === void 0) { args = { client: new Client_1.default(), throttler: new Throttler_1.default(), cikBySymbol: cik_by_symbol_1.default }; }
+        var client = args.client, throttler = args.throttler, cikBySymbol = args.cikBySymbol;
+        this.client = client;
+        this.throttler = throttler;
+        this.cikBySymbol = cikBySymbol;
+    }
+    SecConnector.prototype.getCikString = function (symbol) {
+        var _a;
+        var cik = (_a = this.cikBySymbol[symbol]) !== null && _a !== void 0 ? _a : '';
+        return cik.toString().padStart(10, '0');
+    };
+    SecConnector.prototype.request = function (path) {
+        return __awaiter(this, void 0, void 0, function () {
+            var baseUrl;
+            var _this = this;
+            return __generator(this, function (_a) {
+                baseUrl = 'https://data.sec.gov';
+                return [2 /*return*/, new Promise(function (resolve, reject) { return __awaiter(_this, void 0, void 0, function () {
+                        var _this = this;
+                        return __generator(this, function (_a) {
+                            this.throttler.add(function () { return __awaiter(_this, void 0, void 0, function () {
+                                var response, responseData, e_1;
+                                var _a, _b;
+                                return __generator(this, function (_c) {
+                                    switch (_c.label) {
+                                        case 0:
+                                            _c.trys.push([0, 2, , 3]);
+                                            return [4 /*yield*/, this.client.request({
+                                                    url: "".concat(baseUrl).concat(path),
+                                                    onError: function (err) { return reject(err); },
+                                                })];
+                                        case 1:
+                                            response = _c.sent();
+                                            responseData = (_b = (_a = response.data) === null || _a === void 0 ? void 0 : _a.toString('utf-8')) !== null && _b !== void 0 ? _b : null;
+                                            if (response.statusCode >= 400 || typeof responseData !== 'string') {
+                                                reject("Request failed with status ".concat(response.statusCode, " ").concat(response.message));
+                                            }
+                                            resolve(JSON.parse(responseData));
+                                            return [3 /*break*/, 3];
+                                        case 2:
+                                            e_1 = _c.sent();
+                                            reject(e_1);
+                                            return [3 /*break*/, 3];
+                                        case 3: return [2 /*return*/];
+                                    }
+                                });
+                            }); });
+                            return [2 /*return*/];
+                        });
+                    }); })];
+            });
+        });
+    };
+    SecConnector.prototype.getSubmissions = function (params) {
+        return __awaiter(this, void 0, void 0, function () {
+            var symbol, cik;
+            return __generator(this, function (_a) {
+                symbol = params.symbol;
+                cik = this.getCikString(symbol);
+                return [2 /*return*/, this.request("/submissions/CIK".concat(cik, ".json"))];
+            });
+        });
+    };
+    SecConnector.prototype.getFact = function (params) {
+        return __awaiter(this, void 0, void 0, function () {
+            var symbol, fact, _a, taxonomy, cik;
+            return __generator(this, function (_b) {
+                symbol = params.symbol, fact = params.fact, _a = params.taxonomy, taxonomy = _a === void 0 ? 'us-gaap' : _a;
+                cik = this.getCikString(symbol);
+                return [2 /*return*/, this.request("/api/xbrl/companyconcept/CIK".concat(cik, "/").concat(taxonomy, "/").concat(fact, ".json"))];
+            });
+        });
+    };
+    SecConnector.prototype.getFacts = function (params) {
+        return __awaiter(this, void 0, void 0, function () {
+            var symbol, cik;
+            return __generator(this, function (_a) {
+                symbol = params.symbol;
+                cik = this.getCikString(symbol);
+                return [2 /*return*/, this.request("/api/xbrl/companyfacts/CIK".concat(cik, ".json"))];
+            });
+        });
+    };
+    SecConnector.prototype.getFactFrame = function (params) {
+        return __awaiter(this, void 0, void 0, function () {
+            var fact, frame, _a, taxonomy, _b, unit;
+            return __generator(this, function (_c) {
+                fact = params.fact, frame = params.frame, _a = params.taxonomy, taxonomy = _a === void 0 ? 'us-gaap' : _a, _b = params.unit, unit = _b === void 0 ? 'pure' : _b;
+                return [2 /*return*/, this.request("/api/xbrl/frames/".concat(taxonomy, "/").concat(fact, "/").concat(unit, "/").concat(frame, ".json"))];
+            });
+        });
+    };
+    return SecConnector;
+}());
+exports.default = SecConnector;

package/build/services/SecEdgarApi/SecEdgarApi.d.ts

@@ -0,0 +1,92 @@
+import { CompanyFactFrame, CompanyFactListData, MultiCompanyFactFrame, ReportRaw, SubmissionList } from '../../types';
+import ReportParser from '../ReportParser';
+import { ParseReportsOptions } from '../ReportParser/ReportRawParser';
+import ReportWrapper from '../ReportParser/ReportWrapper';
+import { DownloadCompanyFactsDirectoryParams, IFactsDownloader } from './FactsDownloader';
+import { GetFactFrameParams, GetFactParams, GetSymbolParams, ISecConnector } from './SecConnector';
+interface SecEdgarApiArgs {
+    secConnector: ISecConnector;
+    reportParser: ReportParser;
+    factsDownloader: IFactsDownloader;
+}
+/**
+ * Gets company reports and filings from the SEC EDGAR API
+ *
+ * Requests are throttled with 120ms delay between requests to avoid rate limiting
+ *
+ * @see https://www.sec.gov/edgar/sec-api-documentation
+ */
+export default class SecEdgarApi {
+    private readonly reportParser;
+    private readonly secConnector;
+    private readonly factsDownloader;
+    constructor(args?: SecEdgarApiArgs);
+    /**
+     * endpoint: /submissions/CIK${cik}.json
+     *
+     * This JSON data structure contains metadata such as current name, former name,
+     * and stock exchanges and ticker symbols of publicly-traded companies. The object’s
+     * property path contains at least one year’s of filing or to 1,000 (whichever is more)
+     * of the most recent filings in a compact columnar data array. If the entity has
+     * additional filings, files will contain an array of additional JSON files and the
+     * date range for the filings each one contains.
+     */
+    getSubmissions(params: GetSymbolParams): Promise<SubmissionList>;
+    /**
+     * endpoint /api/xbrl/companyconcept/CIK${cik}/${taxonomy}/${fact}.json
+     *
+     * This API returns all the company concepts data for a company into a single API call:
+     */
+    getFacts(params: GetSymbolParams): Promise<CompanyFactListData>;
+    /**
+     * endpoint /api/xbrl/companyconcept/CIK${cik}/${taxonomy}/${fact}.json
+     *
+     * The company-concept API returns all the XBRL disclosures from a single company (CIK)
+     * and concept (a taxonomy and tag) into a single JSON file, with a separate array
+     * of facts for each units on measure that the company has chosen to disclose
+     * (e.g. net profits reported in U.S. dollars and in Canadian dollars).
+     */
+    getFact(params: GetFactParams): Promise<CompanyFactFrame>;
+    /**
+     * endpoint /api/xbrl/frames/${taxonomy}/${fact}/${unit}/${frame}.json
+     *
+     * The xbrl/frames API aggregates one fact for each reporting entity that is last filed
+     * that most closely fits the calendrical period requested. This API supports for annual,
+     * quarterly and instantaneous data:
+     *
+     * data.sec.gov/api/xbrl/frames/us-gaap/AccountsPayableCurrent/USD/CY2019Q1I.json
+     *
+     * Where the units of measure specified in the XBRL contains a numerator and a denominator,
+     * these are separated by “-per-” such as “USD-per-shares”. Note that the default unit
+     * in XBRL is “pure”.
+     *
+     * The period format is CY#### for annual data (duration 365 days +/- 30 days), CY####Q#
+     * for quarterly data (duration 91 days +/- 30 days), and CY####Q#I for instantaneous data.
+     * Because company financial calendars can start and end on any month or day and even
+     * change in length from quarter to quarter to according to the day of the week, the frame
+     * data is assembled by the dates that best align with a calendar quarter or year. Data
+     * users should be mindful different reporting start and end dates for facts contained
+     * in a frame.
+     */
+    getFactFrame(params: GetFactFrameParams): Promise<MultiCompanyFactFrame>;
+    /**
+     * Parses reports from company facts. Calculates missing properties and uses a single interface
+     * for all reports. This includes only 10-K and 10-Q annual and quarterly reports. To include
+     * all reports, use getReportsRaw
+     *
+     * Note that calculated properties are estimated if they are not available in the company facts.
+     */
+    getReports(params: GetSymbolParams): Promise<ReportWrapper[]>;
+    /**
+     * Parses reports from company facts. Calculates missing properties and uses a single interface
+     * for all reports.
+     */
+    getReportsRaw(params: GetSymbolParams & ParseReportsOptions): Promise<ReportRaw[]>;
+    /**
+     * 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.
+     */
+    downloadCompanyFactsDirectory(params: DownloadCompanyFactsDirectoryParams): Promise<boolean>;
+}
+export {};

package/build/services/SecEdgarApi/SecEdgarApi.js

@@ -0,0 +1,184 @@
+"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 __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 ReportParser_1 = require("../ReportParser");
+var FactsDownloader_1 = require("./FactsDownloader");
+var SecConnector_1 = require("./SecConnector");
+/**
+ * Gets company reports and filings from the SEC EDGAR API
+ *
+ * Requests are throttled with 120ms delay between requests to avoid rate limiting
+ *
+ * @see https://www.sec.gov/edgar/sec-api-documentation
+ */
+var SecEdgarApi = /** @class */ (function () {
+    function SecEdgarApi(args) {
+        if (args === void 0) { args = {
+            secConnector: new SecConnector_1.default(),
+            reportParser: new ReportParser_1.default(),
+            factsDownloader: new FactsDownloader_1.default(),
+        }; }
+        var secConnector = args.secConnector, reportParser = args.reportParser, factsDownloader = args.factsDownloader;
+        this.secConnector = secConnector;
+        this.reportParser = reportParser;
+        this.factsDownloader = factsDownloader;
+    }
+    /**
+     * endpoint: /submissions/CIK${cik}.json
+     *
+     * This JSON data structure contains metadata such as current name, former name,
+     * and stock exchanges and ticker symbols of publicly-traded companies. The object’s
+     * property path contains at least one year’s of filing or to 1,000 (whichever is more)
+     * of the most recent filings in a compact columnar data array. If the entity has
+     * additional filings, files will contain an array of additional JSON files and the
+     * date range for the filings each one contains.
+     */
+    SecEdgarApi.prototype.getSubmissions = function (params) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.secConnector.getSubmissions(params)];
+            });
+        });
+    };
+    /**
+     * endpoint /api/xbrl/companyconcept/CIK${cik}/${taxonomy}/${fact}.json
+     *
+     * This API returns all the company concepts data for a company into a single API call:
+     */
+    SecEdgarApi.prototype.getFacts = function (params) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.secConnector.getFacts(params)];
+            });
+        });
+    };
+    /**
+     * endpoint /api/xbrl/companyconcept/CIK${cik}/${taxonomy}/${fact}.json
+     *
+     * The company-concept API returns all the XBRL disclosures from a single company (CIK)
+     * and concept (a taxonomy and tag) into a single JSON file, with a separate array
+     * of facts for each units on measure that the company has chosen to disclose
+     * (e.g. net profits reported in U.S. dollars and in Canadian dollars).
+     */
+    SecEdgarApi.prototype.getFact = function (params) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.secConnector.getFact(params)];
+            });
+        });
+    };
+    /**
+     * endpoint /api/xbrl/frames/${taxonomy}/${fact}/${unit}/${frame}.json
+     *
+     * The xbrl/frames API aggregates one fact for each reporting entity that is last filed
+     * that most closely fits the calendrical period requested. This API supports for annual,
+     * quarterly and instantaneous data:
+     *
+     * data.sec.gov/api/xbrl/frames/us-gaap/AccountsPayableCurrent/USD/CY2019Q1I.json
+     *
+     * Where the units of measure specified in the XBRL contains a numerator and a denominator,
+     * these are separated by “-per-” such as “USD-per-shares”. Note that the default unit
+     * in XBRL is “pure”.
+     *
+     * The period format is CY#### for annual data (duration 365 days +/- 30 days), CY####Q#
+     * for quarterly data (duration 91 days +/- 30 days), and CY####Q#I for instantaneous data.
+     * Because company financial calendars can start and end on any month or day and even
+     * change in length from quarter to quarter to according to the day of the week, the frame
+     * data is assembled by the dates that best align with a calendar quarter or year. Data
+     * users should be mindful different reporting start and end dates for facts contained
+     * in a frame.
+     */
+    SecEdgarApi.prototype.getFactFrame = function (params) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.secConnector.getFactFrame(params)];
+            });
+        });
+    };
+    /**
+     * Parses reports from company facts. Calculates missing properties and uses a single interface
+     * for all reports. This includes only 10-K and 10-Q annual and quarterly reports. To include
+     * all reports, use getReportsRaw
+     *
+     * Note that calculated properties are estimated if they are not available in the company facts.
+     */
+    SecEdgarApi.prototype.getReports = function (params) {
+        return __awaiter(this, void 0, void 0, function () {
+            var facts;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getFacts(params)];
+                    case 1:
+                        facts = _a.sent();
+                        return [2 /*return*/, this.reportParser.parseReports(facts)];
+                }
+            });
+        });
+    };
+    /**
+     * Parses reports from company facts. Calculates missing properties and uses a single interface
+     * for all reports.
+     */
+    SecEdgarApi.prototype.getReportsRaw = function (params) {
+        return __awaiter(this, void 0, void 0, function () {
+            var facts;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getFacts(params)];
+                    case 1:
+                        facts = _a.sent();
+                        return [2 /*return*/, this.reportParser.parseReportsRaw(facts)];
+                }
+            });
+        });
+    };
+    /**
+     * 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.
+     */
+    SecEdgarApi.prototype.downloadCompanyFactsDirectory = function (params) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.factsDownloader.downloadCompanyFactsDirectory(params)];
+            });
+        });
+    };
+    return SecEdgarApi;
+}());
+exports.default = SecEdgarApi;

package/build/services/SecEdgarApi/Throttler.d.ts

@@ -0,0 +1,34 @@
+interface OnProgressData {
+    queueLength: number;
+    countRunning: number;
+}
+interface ThrottlerArgs {
+    maxConcurrent?: number;
+    delayMs?: number;
+    onProgress?: (data: OnProgressData) => void;
+    onResult?: (result: any) => void;
+    onError?: (err: any) => void;
+    onEnd?: (results: any[], errors: any[]) => void;
+}
+export interface IThrottler {
+    setDelayMs(delayMs: number): void;
+    add: (fn: () => Promise<any>) => void;
+}
+export default class Throttler implements IThrottler {
+    private readonly queue;
+    private readonly results;
+    private readonly errors;
+    private countRunning;
+    private maxConcurrent;
+    private delayMs;
+    onProgress?: (data: OnProgressData) => void;
+    onResult?: (result: any) => void;
+    onError?: (err: any) => void;
+    onEnd?: (results: any[], errors: any[]) => void;
+    constructor(args?: ThrottlerArgs);
+    setMaxConcurrent(maxConcurrent: number): void;
+    setDelayMs(delayMs: number): void;
+    add(fn: () => Promise<any>): void;
+    private run;
+}
+export {};

package/build/services/SecEdgarApi/Throttler.js

@@ -0,0 +1,111 @@
+"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 __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 Throttler = /** @class */ (function () {
+    function Throttler(args) {
+        if (args === void 0) { args = {}; }
+        var _a = args.maxConcurrent, maxConcurrent = _a === void 0 ? 1 : _a, _b = args.delayMs, delayMs = _b === void 0 ? 120 : _b, onProgress = args.onProgress, onResult = args.onResult, onError = args.onError, onEnd = args.onEnd;
+        this.maxConcurrent = maxConcurrent;
+        this.delayMs = delayMs;
+        this.countRunning = 0;
+        this.queue = [];
+        this.results = [];
+        this.errors = [];
+        this.onProgress = onProgress;
+        this.onResult = onResult;
+        this.onError = onError;
+        this.onEnd = onEnd;
+    }
+    Throttler.prototype.setMaxConcurrent = function (maxConcurrent) {
+        this.maxConcurrent = maxConcurrent;
+    };
+    Throttler.prototype.setDelayMs = function (delayMs) {
+        this.delayMs = delayMs;
+    };
+    Throttler.prototype.add = function (fn) {
+        this.queue.push(fn);
+        this.run();
+    };
+    Throttler.prototype.run = function () {
+        var _a, _b, _c, _d;
+        return __awaiter(this, void 0, void 0, function () {
+            var fn, result, err_1;
+            var _this = this;
+            return __generator(this, function (_e) {
+                switch (_e.label) {
+                    case 0:
+                        if (this.countRunning >= this.maxConcurrent) {
+                            return [2 /*return*/];
+                        }
+                        if (this.queue.length === 0) {
+                            if (this.countRunning === 0) {
+                                (_a = this.onEnd) === null || _a === void 0 ? void 0 : _a.call(this, this.results, this.errors);
+                            }
+                            return [2 /*return*/];
+                        }
+                        this.countRunning++;
+                        fn = this.queue.shift();
+                        _e.label = 1;
+                    case 1:
+                        _e.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, fn()];
+                    case 2:
+                        result = _e.sent();
+                        this.results.push(result);
+                        (_b = this.onResult) === null || _b === void 0 ? void 0 : _b.call(this, result);
+                        return [3 /*break*/, 4];
+                    case 3:
+                        err_1 = _e.sent();
+                        this.errors.push(err_1);
+                        (_c = this.onError) === null || _c === void 0 ? void 0 : _c.call(this, err_1);
+                        return [3 /*break*/, 4];
+                    case 4:
+                        this.countRunning--;
+                        (_d = this.onProgress) === null || _d === void 0 ? void 0 : _d.call(this, {
+                            queueLength: this.queue.length,
+                            countRunning: this.countRunning,
+                        });
+                        setTimeout(function () { return _this.run(); }, this.delayMs);
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    return Throttler;
+}());
+exports.default = Throttler;

package/build/services/SecEdgarApi/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 {};