sec-edgar-api 0.0.3 → 0.0.6

package/build/services/SecEdgarApi/SecEdgarApi.js

@@ -14,7 +14,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     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 {
+        while (_) 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]) {
@@ -36,75 +36,187 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+var cik_by_symbol_1 = require("../../util/cik-by-symbol");
+var Client_1 = require("../Client");
+var DocumentParser_1 = require("../DocumentParser");
 var ReportParser_1 = require("../ReportParser");
-var FactsDownloader_1 = require("./FactsDownloader");
-var SecConnector_1 = require("./SecConnector");
+var RequestWrapper_1 = require("./RequestWrapper");
+var Throttler_1 = require("./Throttler");
 /**
- * Gets company reports and filings from the SEC EDGAR API
- *
- * Requests are throttled with 120ms delay between requests to avoid rate limiting
+ * Gets reports from companies filed with the SEC
  *
  * @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(),
+            client: new Client_1.default(),
+            throttler: new Throttler_1.default(),
+            cikBySymbol: cik_by_symbol_1.default,
             reportParser: new ReportParser_1.default(),
-            factsDownloader: new FactsDownloader_1.default(),
+            documentParser: new DocumentParser_1.default(),
         }; }
-        var secConnector = args.secConnector, reportParser = args.reportParser, factsDownloader = args.factsDownloader;
-        this.secConnector = secConnector;
+        var client = args.client, throttler = args.throttler, cikBySymbol = args.cikBySymbol, reportParser = args.reportParser, documentParser = args.documentParser;
+        this.client = client;
+        this.throttler = throttler;
+        this.cikBySymbol = cikBySymbol;
         this.reportParser = reportParser;
-        this.factsDownloader = factsDownloader;
+        this.documentParser = documentParser;
+        this.baseUrlEdgar = 'https://data.sec.gov';
+        this.baseUrlSec = 'https://www.sec.gov';
     }
+    SecEdgarApi.prototype.request = function (url, isText) {
+        if (isText === void 0) { isText = false; }
+        return __awaiter(this, void 0, void 0, function () {
+            var _this = this;
+            return __generator(this, function (_a) {
+                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: url,
+                                                    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((isText ? responseData : 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*/];
+                        });
+                    }); })];
+            });
+        });
+    };
+    SecEdgarApi.prototype.mapFilingListDetails = function (cik, filingListDetails) {
+        var _a;
+        var filings = [];
+        for (var key in filingListDetails) {
+            var k = key;
+            var dataArr = filingListDetails[k];
+            for (var i = 0; i < dataArr.length; i++) {
+                filings[i] = (_a = filings[i]) !== null && _a !== void 0 ? _a : {};
+                var filing = filings[i];
+                filing[k] = dataArr[i];
+            }
+        }
+        for (var _i = 0, filings_1 = filings; _i < filings_1.length; _i++) {
+            var filing = filings_1[_i];
+            var accessionStr = filing.accessionNumber.replace(/-/g, '');
+            var primaryDocument = filing.primaryDocument;
+            filing.url = "https://www.sec.gov/Archives/edgar/data/".concat(Number(cik), "/").concat(accessionStr, "/").concat(primaryDocument);
+        }
+        return filings;
+    };
+    SecEdgarApi.prototype.getCreateRequestUrls = function (params, forms) {
+        var symbol = params.symbol, filings = params.filings, _a = params.cutoffDate, cutoffDate = _a === void 0 ? new Date('1970-01-01') : _a;
+        var cik = this.getCikString(symbol);
+        var filingsArr = Array.isArray(filings) ? filings : this.mapFilingListDetails(cik, filings);
+        var filingsFiltered = filingsArr.filter(function (_a) {
+            var form = _a.form, filingDate = _a.filingDate;
+            return forms.includes(form) && new Date(filingDate).getTime() > cutoffDate.getTime();
+        });
+        var urls = filingsFiltered.filter(function (_a) {
+            var form = _a.form;
+            return forms.includes(form);
+        }).map(function (_a) {
+            var url = _a.url;
+            return url;
+        });
+        return urls;
+    };
+    /**
+     * If symbol is not in cikBySymbol, assume it is a cik. does not make a request
+     */
+    SecEdgarApi.prototype.getCikString = function (symbol) {
+        var cik = this.cikBySymbol[symbol];
+        if (cik)
+            return cik.toString().padStart(10, '0');
+        if (!isNaN(Number(symbol)))
+            return Number(symbol).toString().padStart(10, '0');
+        throw new Error("".concat(symbol, " is not a known symbol or valid cik"));
+    };
     /**
-     * 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.
+     *
+     * endpoint: `/submissions/CIK${cik}.json`
      */
     SecEdgarApi.prototype.getSubmissions = function (params) {
         return __awaiter(this, void 0, void 0, function () {
+            var symbol, includeTranslated, cik, submissions;
             return __generator(this, function (_a) {
-                return [2 /*return*/, this.secConnector.getSubmissions(params)];
+                switch (_a.label) {
+                    case 0:
+                        symbol = params.symbol, includeTranslated = params.includeTranslated;
+                        cik = this.getCikString(symbol);
+                        return [4 /*yield*/, this.request("".concat(this.baseUrlEdgar, "/submissions/CIK").concat(cik, ".json"))];
+                    case 1:
+                        submissions = _a.sent();
+                        if (!includeTranslated)
+                            return [2 /*return*/, submissions];
+                        submissions.filings.recentTranslated = this.mapFilingListDetails(cik, submissions.filings.recent);
+                        return [2 /*return*/, submissions];
+                }
             });
         });
     };
     /**
-     * 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).
      *
-     * This API returns all the company concepts data for a company into a single API call:
+     * endpoint `/api/xbrl/companyconcept/CIK${cik}/${taxonomy}/${fact}.json`
      */
-    SecEdgarApi.prototype.getFacts = function (params) {
+    SecEdgarApi.prototype.getFact = function (params) {
         return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                return [2 /*return*/, this.secConnector.getFacts(params)];
+            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("".concat(this.baseUrlEdgar, "/api/xbrl/companyconcept/CIK").concat(cik, "/").concat(taxonomy, "/").concat(fact, ".json"))];
             });
         });
     };
     /**
-     * endpoint /api/xbrl/companyconcept/CIK${cik}/${taxonomy}/${fact}.json
+     * Returns all the company concepts data for a company into a single API call:
      *
-     * 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).
+     * endpoint `/api/xbrl/companyconcept/CIK${cik}/${taxonomy}/${fact}.json`
      */
-    SecEdgarApi.prototype.getFact = function (params) {
+    SecEdgarApi.prototype.getFacts = function (params) {
         return __awaiter(this, void 0, void 0, function () {
+            var symbol, cik;
             return __generator(this, function (_a) {
-                return [2 /*return*/, this.secConnector.getFact(params)];
+                symbol = params.symbol;
+                cik = this.getCikString(symbol);
+                return [2 /*return*/, this.request("".concat(this.baseUrlEdgar, "/api/xbrl/companyfacts/CIK").concat(cik, ".json"))];
             });
         });
     };
     /**
-     * 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:
@@ -122,11 +234,15 @@ var SecEdgarApi = /** @class */ (function () {
      * 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.
+     *
+     * endpoint `/api/xbrl/frames/${taxonomy}/${fact}/${unit}/${frame}.json`
      */
     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)];
+            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("".concat(this.baseUrlEdgar, "/api/xbrl/frames/").concat(taxonomy, "/").concat(fact, "/").concat(unit, "/").concat(frame, ".json"))];
             });
         });
     };
@@ -142,13 +258,16 @@ var SecEdgarApi = /** @class */ (function () {
      */
     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)];
+            var symbol, _a, withWrapper, facts, reports;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        symbol = params.symbol, _a = params.withWrapper, withWrapper = _a === void 0 ? false : _a;
+                        return [4 /*yield*/, this.getFacts({ symbol: symbol })];
                     case 1:
-                        facts = _a.sent();
-                        return [2 /*return*/, this.reportParser.parseReports(facts)];
+                        facts = _b.sent();
+                        reports = this.reportParser.parseReports(facts);
+                        return [2 /*return*/, withWrapper ? reports : reports.map(function (report) { return report.getReport(); })];
                 }
             });
         });
@@ -171,19 +290,142 @@ var SecEdgarApi = /** @class */ (function () {
         });
     };
     /**
-     * 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.
+     * Gets a list of all tickers and CIKs from `https://www.sec.gov/files/company_tickers.json`
      *
-     * Note: Over 15GB of data is downloaded and extracted.
+     * Note that they key cik_str is actually a number. To get cik string, you can do `${cik_str}`.padStart(10, '0')
      */
-    SecEdgarApi.prototype.downloadCompanyFactsDirectory = function (params) {
+    SecEdgarApi.prototype.getCompanyTickerList = function () {
         return __awaiter(this, void 0, void 0, function () {
+            var response;
             return __generator(this, function (_a) {
-                return [2 /*return*/, this.factsDownloader.downloadCompanyFactsDirectory(params)];
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.request("".concat(this.baseUrlSec, "/files/company_tickers.json"))];
+                    case 1:
+                        response = _a.sent();
+                        return [2 /*return*/, Object.values(response)];
+                }
             });
         });
     };
+    /**
+     * Gets a list of all tickers and CIKs with exchange and company name from `https://www.sec.gov/files/company_tickers_exchange.json`
+     *
+     * response: { fields: ['cik', 'name', 'ticker', 'exchange'], data: [ [320193,'Apple Inc.','AAPL','Nasdaq'], ... ] }
+     */
+    SecEdgarApi.prototype.getCompanyTickerExchangeList = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.request("".concat(this.baseUrlSec, "/files/company_tickers_exchange.json"))];
+            });
+        });
+    };
+    /**
+     * Gets a list of all mutual funds from `https://www.sec.gov/files/company_tickers_mf.json`
+     *
+     * response: { fields: ['cik','seriesId','classId','symbol'], data: [ [2110,'S000009184','C000024954','LACAX'], ... ] }
+     */
+    SecEdgarApi.prototype.getMutualFundList = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.request("".concat(this.baseUrlSec, "/files/company_tickers_mf.json"))];
+            });
+        });
+    };
+    /**
+     * Gets a raw xml document string. the parameters are found in the submission list response. (response.filings.recent or response.filings.recentTranslated)
+     *
+     * Some form types can be parsed using the DocumentParser such as form 4 (insider transactions) and form 13g (institutional holders)
+     *
+     * endpoint: `https://www.sec.gov/Archives/edgar/data/${cik}/${accessionNumber}/${primaryDocument}`
+     *
+     * @see https://www.sec.gov/forms for a list of form types
+     */
+    SecEdgarApi.prototype.getDocumentXML = function (params) {
+        return __awaiter(this, void 0, void 0, function () {
+            var accessionNumber, primaryDocument, symbol, cik;
+            return __generator(this, function (_a) {
+                accessionNumber = params.accessionNumber, primaryDocument = params.primaryDocument, symbol = params.symbol;
+                cik = this.cikBySymbol[symbol];
+                return [2 /*return*/, this.request("".concat(this.baseUrlSec, "/Archives/edgar/data/").concat(cik, "/").concat(accessionNumber.replace(/-/g, ''), "/").concat(primaryDocument), true)];
+            });
+        });
+    };
+    /**
+     * Gets a raw xml document string. the url is found in the submission list response. (response.filings.recentTranslated.url)
+     *
+     * Some form types can be parsed using the DocumentParser such as form 4 (insider transactions) and form 13g (institutional holders)
+     *
+     * endpoint: `https://www.sec.gov/Archives/edgar/data/${cik}/${accessionNumber}/${primaryDocument}`
+     *
+     * @see https://www.sec.gov/forms for a list of form types
+     */
+    SecEdgarApi.prototype.getDocumentXMLByUrl = function (params) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.request(params.url, true)];
+            });
+        });
+    };
+    /**
+     * Used for getting insider transactions. extracts insider transaction urls from submission list response, and parses the xml doc.
+     *
+     * ```ts
+     * const submissions = await secEdgarApi.getSubmissions({ symbol: 'AAPL' })
+     * const requestWrapper = secEdgarApi.createRequestInsiderTransactions({ symbol: 'AAPL', filings: submissions.filings.recent })
+     *
+     * const transactions1 = await requestWrapper.requestNext() // array of transactions from most recent doc
+     * const transactions2 = await requestWrapper.requestNext() // array of transactions from second most recent doc
+     * ```
+     */
+    SecEdgarApi.prototype.createRequestInsiderTransactions = function (params) {
+        var _this = this;
+        var urls = this.getCreateRequestUrls(params, ['4', '4/A', '5', '5/A']);
+        var options = { maxRequests: params.maxRequests };
+        var sendRequest = function (params) { return __awaiter(_this, void 0, void 0, function () {
+            var _a, _b;
+            var _c;
+            return __generator(this, function (_d) {
+                switch (_d.label) {
+                    case 0:
+                        _b = (_a = this.documentParser).parseInsiderTransactions;
+                        _c = {};
+                        return [4 /*yield*/, this.getDocumentXMLByUrl(params)];
+                    case 1: return [2 /*return*/, _b.apply(_a, [(_c.xml = _d.sent(), _c)])];
+                }
+            });
+        }); };
+        return new RequestWrapper_1.default({ urls: urls, options: options, sendRequest: sendRequest });
+    };
+    /**
+     * Used for getting institutional holders. extracts holders urls from submission list response, and parses the xml doc.
+     *
+     * ```ts
+     * const submissions = await secEdgarApi.getSubmissions({ symbol: 'AAPL' })
+     * const requestWrapper = secEdgarApi.createRequestHolders({ symbol: 'AAPL', filings: submissions.filings.recent })
+     *
+     * const holders1 = await requestWrapper.requestNext() // array of holders from most recent doc
+     * const holders2 = await requestWrapper.requestNext() // array of holders from second most recent doc
+     * ```
+     */
+    SecEdgarApi.prototype.createRequestHolders = function (params) {
+        var _this = this;
+        var urls = this.getCreateRequestUrls(params, ['SC 13G', 'SC 13G/A']);
+        var options = { maxRequests: params.maxRequests };
+        var sendRequest = function (params) { return __awaiter(_this, void 0, void 0, function () {
+            var _a, _b;
+            var _c;
+            return __generator(this, function (_d) {
+                switch (_d.label) {
+                    case 0:
+                        _b = (_a = this.documentParser).parseHolders;
+                        _c = {};
+                        return [4 /*yield*/, this.getDocumentXMLByUrl(params)];
+                    case 1: return [2 /*return*/, _b.apply(_a, [(_c.xml = _d.sent(), _c)])];
+                }
+            });
+        }); };
+        return new RequestWrapper_1.default({ urls: urls, options: options, sendRequest: sendRequest });
+    };
     return SecEdgarApi;
 }());
 exports.default = SecEdgarApi;

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

@@ -15,10 +15,10 @@ export interface IThrottler {
     add: (fn: () => Promise<any>) => void;
 }
 export default class Throttler implements IThrottler {
+    private readonly decrementTimeouts;
     private readonly queue;
     private readonly results;
     private readonly errors;
-    private countRunning;
     private maxConcurrent;
     private delayMs;
     onProgress?: (data: OnProgressData) => void;
@@ -26,7 +26,6 @@ export default class Throttler implements IThrottler {
     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;

package/build/services/SecEdgarApi/Throttler.js

@@ -14,7 +14,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     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 {
+        while (_) 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]) {
@@ -39,10 +39,10 @@ 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;
+        var _a = args.maxConcurrent, maxConcurrent = _a === void 0 ? 10 : _a, _b = args.delayMs, delayMs = _b === void 0 ? 1100 : _b, onProgress = args.onProgress, onResult = args.onResult, onError = args.onError, onEnd = args.onEnd;
         this.maxConcurrent = maxConcurrent;
         this.delayMs = delayMs;
-        this.countRunning = 0;
+        this.decrementTimeouts = new Set();
         this.queue = [];
         this.results = [];
         this.errors = [];
@@ -51,9 +51,6 @@ var Throttler = /** @class */ (function () {
         this.onError = onError;
         this.onEnd = onEnd;
     }
-    Throttler.prototype.setMaxConcurrent = function (maxConcurrent) {
-        this.maxConcurrent = maxConcurrent;
-    };
     Throttler.prototype.setDelayMs = function (delayMs) {
         this.delayMs = delayMs;
     };
@@ -64,22 +61,27 @@ var Throttler = /** @class */ (function () {
     Throttler.prototype.run = function () {
         var _a, _b, _c, _d;
         return __awaiter(this, void 0, void 0, function () {
-            var fn, result, err_1;
+            var countRunning, fn, decrementTimeout, result, err_1;
             var _this = this;
             return __generator(this, function (_e) {
                 switch (_e.label) {
                     case 0:
-                        if (this.countRunning >= this.maxConcurrent) {
+                        countRunning = this.decrementTimeouts.size;
+                        if (countRunning >= this.maxConcurrent) {
                             return [2 /*return*/];
                         }
                         if (this.queue.length === 0) {
-                            if (this.countRunning === 0) {
+                            if (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();
+                        decrementTimeout = setTimeout(function () {
+                            _this.decrementTimeouts.delete(decrementTimeout);
+                            _this.run();
+                        }, this.delayMs);
+                        this.decrementTimeouts.add(decrementTimeout);
                         _e.label = 1;
                     case 1:
                         _e.trys.push([1, 3, , 4]);
@@ -95,12 +97,10 @@ var Throttler = /** @class */ (function () {
                         (_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,
+                            countRunning: this.decrementTimeouts.size,
                         });
-                        setTimeout(function () { return _this.run(); }, this.delayMs);
                         return [2 /*return*/];
                 }
             });

package/build/services/SecEdgarApi/index.js

@@ -1,11 +1,7 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/build/types/common.type.d.ts

@@ -0,0 +1,12 @@
+export interface XMLParams {
+    xml: string;
+}
+export interface CompanyTickerItem {
+    cik_str: number;
+    ticker: string;
+    title: string;
+}
+export interface FieldDataResponse<Field extends string = string> {
+    fields: Field[];
+    data: (string | number)[][];
+}

package/build/types/common.type.js

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

package/build/types/index.d.ts

@@ -2,3 +2,5 @@ export * from './company-facts.type';
 export * from './report-raw.type';
 export * from './report-translated.type';
 export * from './submission.type';
+export * from './parsed-filings.type';
+export * from './common.type';

package/build/types/index.js

@@ -1,11 +1,7 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -18,3 +14,5 @@ __exportStar(require("./company-facts.type"), exports);
 __exportStar(require("./report-raw.type"), exports);
 __exportStar(require("./report-translated.type"), exports);
 __exportStar(require("./submission.type"), exports);
+__exportStar(require("./parsed-filings.type"), exports);
+__exportStar(require("./common.type"), exports);

package/build/types/parsed-filings.type.d.ts

@@ -0,0 +1,58 @@
+interface TransactionDescriptionByCode {
+    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';
+}
+export declare type TransactionType = 'Acquire' | 'Dispose';
+export declare type TransactionCode = keyof TransactionDescriptionByCode;
+export declare type TransactionDescription = TransactionDescriptionByCode[TransactionCode];
+export interface InsiderTransaction {
+    filerName: string;
+    filerPosition: string;
+    filerPositionTypes: string[];
+    securityType: string;
+    securityTypeUnderlying: string | null;
+    category: 'Derivative' | 'Non-Derivative';
+    date: string;
+    dateExecuted: string | null;
+    dateExpiration: string | null;
+    dateExercisable: string | null;
+    transactionDescription: string | null;
+    transactionCode: TransactionCode | null;
+    transactionType: TransactionType | null;
+    sharesEnding: number | null;
+    shares: number | null;
+    sharesUnderlying: number | null;
+    price: number | null;
+    priceExcercised: number | null;
+    ownership: string;
+    explainationByKey: Partial<Record<keyof InsiderTransaction, string>>;
+}
+export interface Holder {
+    name: string;
+    origin: string;
+    shares: number;
+    percentOfClass: string;
+    votingPowerSole: string | null;
+    votingPowerShared: string | null;
+    dispositivePowerSole: string | null;
+    dispositivePowerShared: string | null;
+    typeOfReportingPerson: string | null;
+}
+export {};

package/build/types/parsed-filings.type.js

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

package/build/types/report-raw.type.d.ts

@@ -1,7 +1,7 @@
 /**
  * Contains all keys matched from the report, along with the added keys dateEnd, dateFiled, fiscalPeriod, fiscalYear.
  */
-export type ReportRaw = {
+export declare type ReportRaw = {
     [key: string]: string | number | boolean;
     dateReport: string;
     dateFiled: string;
@@ -19,5 +19,5 @@ export type ReportRaw = {
  *
  * for dei, see https://www.sec.gov/structureddata/announcement/osd-announcement-2212-new-2022q4-taxonomies
  */
-export type ReportType = 'QUARTERLY' | 'ANNUAL' | '8K' | 'DOCUMENT_ENTITY_INFO';
-export type FiscalPeriod = 'Q1' | 'Q2' | 'Q3' | 'Q4' | 'FY';
+export declare type ReportType = 'QUARTERLY' | 'ANNUAL' | '8K' | 'DOCUMENT_ENTITY_INFO';
+export declare type FiscalPeriod = 'Q1' | 'Q2' | 'Q3' | 'Q4' | 'FY';