sec-edgar-api 0.3.2 → 0.3.4

package/build/services/Client/Client.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="node" />
 /// <reference types="node" />
+/// <reference types="node" />
 import { ClientRequest, IncomingMessage, RequestOptions } from 'http';
 type Primitive = string | number | boolean | null | undefined;
 interface HttpClient {

package/build/services/DocumentParser/XMLNode/XMLNode.js

@@ -66,13 +66,13 @@ var XMLNode = /** @class */ (function () {
         if (text === '')
             return null;
         var colNum = text
-            .replace(/,|\(|\)|\%/g, '')
+            .replace(/,|\(|\)|%/g, '')
             .replace(/\{\{/g, '')
             .replace(/\}\}/g, '')
             .trim();
         if (colNum === '-' || colNum === '$')
             return null;
-        colNum = colNum.replace(/\-|\$/g, '');
+        colNum = colNum.replace(/-|\$/g, '');
         var hasNumBeforeParenthesis = Boolean(/\d+\s*(?=\()/.test(text));
         colNum = hasNumBeforeParenthesis ? (_a = colNum.split(' ')[0]) === null || _a === void 0 ? void 0 : _a.trim() : colNum;
         if (!isNaN(Number(colNum))) {

package/build/services/DocumentParser/XMLParser.js

@@ -212,12 +212,10 @@ var XMLParser = /** @class */ (function () {
         };
         this.iterateXML({
             xml: xml,
-            onCloseTag: function (_a) {
-                var _b;
-                var path = _a.path;
-                var tag = path.split('.').pop();
+            onCloseTag: function () {
+                var _a;
                 if ((curNode === null || curNode === void 0 ? void 0 : curNode.getPath()) === boldPath) {
-                    curNode === null || curNode === void 0 ? void 0 : curNode.setText("".concat((_b = curNode === null || curNode === void 0 ? void 0 : curNode.getText()) !== null && _b !== void 0 ? _b : '', "}}"));
+                    curNode === null || curNode === void 0 ? void 0 : curNode.setText("".concat((_a = curNode === null || curNode === void 0 ? void 0 : curNode.getText()) !== null && _a !== void 0 ? _a : '', "}}"));
                     boldPath = null;
                 }
             },

package/build/services/DocumentParser/parsers/parse-current-filings-daily.js

@@ -11,19 +11,19 @@ function parseCurrentFilingsDaily(params) {
     var matchCount = Number((_g = (_f = matchHtml.split('>')[1]) === null || _f === void 0 ? void 0 : _f.split('<')[0]) === null || _g === void 0 ? void 0 : _g.trim()) || 0;
     var totalCount = Number((_j = (_h = totalHtml.split('>')[1]) === null || _h === void 0 ? void 0 : _h.split('<')[0]) === null || _j === void 0 ? void 0 : _j.trim()) || 0;
     var entries = lines.map(function (line) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
         var parts = line.split('<a ');
         var partDate = (_a = parts[0]) !== null && _a !== void 0 ? _a : '';
         var partNameCik = (_b = parts[parts.length - 1]) !== null && _b !== void 0 ? _b : '';
         var partAccessionForm = (_f = (_e = (_d = ((_c = parts[1]) !== null && _c !== void 0 ? _c : '').split('/Archives/edgar/data/')[1]) === null || _d === void 0 ? void 0 : _d.split('/')) === null || _e === void 0 ? void 0 : _e[1]) !== null && _f !== void 0 ? _f : '';
         var partNameCikParts = partNameCik.split('</a>');
-        var _q = partAccessionForm === null || partAccessionForm === void 0 ? void 0 : partAccessionForm.split('>'), accession = _q[0], formUnfiltered = _q[1];
-        var accessionNumber = ((_g = accession === null || accession === void 0 ? void 0 : accession.substring(0, accession.lastIndexOf('-'))) !== null && _g !== void 0 ? _g : '').trim();
-        var form = ((_h = formUnfiltered === null || formUnfiltered === void 0 ? void 0 : formUnfiltered.replace(/</g, '')) !== null && _h !== void 0 ? _h : '').trim();
-        var companyCik = Number((_l = (_k = (_j = partNameCikParts[0]) === null || _j === void 0 ? void 0 : _j.split('>')[1]) === null || _k === void 0 ? void 0 : _k.trim()) !== null && _l !== void 0 ? _l : '');
-        var companyName = (_o = (_m = partNameCikParts[1]) === null || _m === void 0 ? void 0 : _m.trim()) !== null && _o !== void 0 ? _o : '';
-        var filedDate = (_p = partDate.trim()) !== null && _p !== void 0 ? _p : '';
-        var _r = filedDate.split('-'), month = _r[0], day = _r[1], year = _r[2];
+        var _r = (_g = partAccessionForm === null || partAccessionForm === void 0 ? void 0 : partAccessionForm.split('>')) !== null && _g !== void 0 ? _g : [], accession = _r[0], formUnfiltered = _r[1];
+        var accessionNumber = ((_h = accession === null || accession === void 0 ? void 0 : accession.substring(0, accession.lastIndexOf('-'))) !== null && _h !== void 0 ? _h : '').trim();
+        var form = ((_j = formUnfiltered === null || formUnfiltered === void 0 ? void 0 : formUnfiltered.replace(/</g, '')) !== null && _j !== void 0 ? _j : '').trim();
+        var companyCik = Number((_m = (_l = (_k = partNameCikParts[0]) === null || _k === void 0 ? void 0 : _k.split('>')[1]) === null || _l === void 0 ? void 0 : _l.trim()) !== null && _m !== void 0 ? _m : '');
+        var companyName = (_p = (_o = partNameCikParts[1]) === null || _o === void 0 ? void 0 : _o.trim()) !== null && _p !== void 0 ? _p : '';
+        var filedDate = (_q = partDate.trim()) !== null && _q !== void 0 ? _q : '';
+        var _s = filedDate.split('-'), month = _s[0], day = _s[1], year = _s[2];
         return {
             accessionNumber: accessionNumber,
             form: form,

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

@@ -154,10 +154,11 @@ function parseForm4(params, xmlParser) {
                     continue;
                 case 'price':
                 case 'shares':
-                case 'sharesEnding':
+                case 'sharesEnding': {
                     var valueNum = Number(text.replace(/,/g, ''));
                     transaction[colName] = text === '' || isNaN(valueNum) ? null : valueNum;
                     continue;
+                }
                 default:
                     transaction[colName] = text;
             }
@@ -203,12 +204,13 @@ function parseForm4(params, xmlParser) {
                 case 'shares':
                 case 'sharesUnderlying':
                 case 'priceExcercised':
-                case 'sharesEnding':
+                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;
             }

package/build/services/ReportParser/ReportParser.d.ts

@@ -8,7 +8,7 @@ interface ReportParserArgs {
     propertyResolver?: PropertyResolver;
     keyTranslator?: Record<string, string[]>;
 }
-type TranslateRawReportsCallback<T> = (report: T extends undefined ? ReportTranslated : Record<keyof T, string | number>, reportRaw: ReportRaw, keyTranslator: T) => any;
+type TranslateRawReportsCallback<T> = (report: T extends undefined ? ReportTranslated : Record<keyof T, string | number>, reportRaw: ReportRaw, keyTranslator: T) => ReportTranslated | ReportRaw | Record<string, string | number | null>;
 /**
  * Takes company facts data from the SEC and translates them to reports as json objects.
  */

package/build/services/ReportParser/ReportWrapper.js

@@ -32,7 +32,7 @@ var ReportWrapper = /** @class */ (function (_super) {
             url: report.url,
             dateFiled: report.dateFiled,
             dateReport: report.dateReport,
-            fiscalPeriod: (_a = report.fiscalPeriod) !== null && _a !== void 0 ? _a : '',
+            fiscalPeriod: ((_a = report.fiscalPeriod) !== null && _a !== void 0 ? _a : ''),
             fiscalYear: report.fiscalYear,
             splitRatio: null,
             splitDate: null,

package/build/services/ReportRawBuilder/FactFiscalCalculator.d.ts

@@ -20,7 +20,6 @@ export default class FactFiscalCalculator {
     add(fact: {
         end: string;
         filed: string;
-        frame?: string;
     }): void;
     private getDaysBefore;
     setReportDates(params: SetReportDatesParams): void;

package/build/services/ReportRawBuilder/FactFiscalCalculator.js

@@ -16,7 +16,7 @@ var FactFiscalCalculator = /** @class */ (function () {
     }
     FactFiscalCalculator.prototype.add = function (fact) {
         var _a, _b, _c;
-        var end = fact.end, filed = fact.filed, frame = fact.frame;
+        var end = fact.end, filed = fact.filed;
         if (this.didResolve) {
             throw new Error('Cannot add fact after resolving');
         }

package/build/services/ReportRawBuilder/FactGrouper.d.ts

@@ -8,6 +8,7 @@ export default class FactGrouper {
     private preferFirstValue;
     private createFactGroup;
     private createGroupKey;
+    private toValue;
     /**
      * Map structure { 2022_Q3: { name: ... } }. NOTE: Does not include fiscal year report key.
      * All groups contain both trailing and period values, so use trailing from Q4 to get FY values.

package/build/services/ReportRawBuilder/FactGrouper.js

@@ -28,6 +28,9 @@ var FactGrouper = /** @class */ (function () {
         var fiscalYear = params.fiscalYear, quarter = params.quarter, name = params.name;
         return "".concat(fiscalYear, "_").concat(quarter, "_").concat(name);
     };
+    FactGrouper.prototype.toValue = function (value) {
+        return !isNaN(value) ? Number(value) : value || null;
+    };
     /**
      * Map structure { 2022_Q3: { name: ... } }. NOTE: Does not include fiscal year report key.
      * All groups contain both trailing and period values, so use trailing from Q4 to get FY values.
@@ -59,7 +62,7 @@ var FactGrouper = /** @class */ (function () {
             var period = periodResolver.getPeriod(fact);
             var isPeriodFact = period <= 3;
             var isTrailingFact = period > 3 || (isPeriodFact && quarter === 1);
-            var factValue = Number(fact.value);
+            var factValue = this.toValue(fact.value);
             // if no group exists, create from fact
             if (!factGroupByKey.has(groupKey)) {
                 var group_1 = this.createFactGroup({
@@ -79,9 +82,12 @@ var FactGrouper = /** @class */ (function () {
                     valuePeriodLast: isPeriodFact ? factValue : null,
                     valueTrailingFirst: isTrailingFact ? factValue : null,
                     valueTrailingLast: isTrailingFact ? factValue : null,
-                    values: [factValue],
+                    values: [],
                     facts: [fact],
                 });
+                if (factValue !== null) {
+                    group_1.values.push(factValue);
+                }
                 accnByFiled.set(fact.filed, (_b = fact.accn) !== null && _b !== void 0 ? _b : '');
                 unitByPropertyName.set(fact.name, fact.unit);
                 factGroupByKey.set(groupKey, group_1);
@@ -94,7 +100,7 @@ var FactGrouper = /** @class */ (function () {
             group.endLast = fact.end > group.endLast ? fact.end : group.endLast;
             group.filedFirst = fact.filed < group.filedFirst ? fact.filed : group.filedFirst;
             group.filedLast = fact.filed > group.filedLast ? fact.filed : group.filedLast;
-            if (!group.values.includes(factValue)) {
+            if (factValue !== null && !group.values.includes(factValue)) {
                 group.values.push(factValue);
             }
             if (!group.accn && periodResolver.isOriginalFiling({ end: fact.end, filed: fact.filed })) {
@@ -139,24 +145,26 @@ var FactGrouper = /** @class */ (function () {
                 var period = FactPeriodResolver_1.default.getPeriod(fact);
                 return fact.value === preferredValueTrailing && (period > 3 || period === 0);
             });
-            if (selectedFactPeriod) {
+            var valuePeriod = _this.toValue((_a = group.valueSplitAdjustedPeriod) !== null && _a !== void 0 ? _a : preferredValuePeriod);
+            var valueTrailing = _this.toValue((_b = group.valueSplitAdjustedTrailing) !== null && _b !== void 0 ? _b : preferredValueTrailing);
+            if (selectedFactPeriod && valuePeriod !== null) {
                 periodResolver.add({
                     end: selectedFactPeriod.end,
                     filed: selectedFactPeriod.filed,
                     name: selectedFactPeriod.name,
                     quarter: group.quarter,
-                    value: Number((_a = group.valueSplitAdjustedPeriod) !== null && _a !== void 0 ? _a : preferredValuePeriod),
+                    value: valuePeriod,
                     year: group.fiscalYear,
                     start: selectedFactPeriod.start,
                 });
             }
-            if (selectedFactTrailing) {
+            if (selectedFactTrailing && valueTrailing !== null) {
                 periodResolver.add({
                     end: selectedFactTrailing.end,
                     filed: selectedFactTrailing.filed,
                     name: selectedFactTrailing.name,
                     quarter: group.quarter,
-                    value: Number((_b = group.valueSplitAdjustedTrailing) !== null && _b !== void 0 ? _b : preferredValueTrailing),
+                    value: valueTrailing,
                     year: group.fiscalYear,
                     start: selectedFactTrailing.start,
                 });

package/build/services/ReportRawBuilder/FactSplitAdjuster.js

@@ -150,20 +150,30 @@ var FactSplitAdjuster = /** @class */ (function () {
      * Splits can be filed multiple times throughout different reports.
      */
     FactSplitAdjuster.prototype.didApplySplit = function (params) {
-        var isShareRatio = params.isShareRatio, factGroup = params.factGroup, split = params.split, isTrailing = params.isTrailing, _a = params.useOppositePeriodFallback, useOppositePeriodFallback = _a === void 0 ? true : _a;
+        var _a;
+        var isShareRatio = params.isShareRatio, factGroup = params.factGroup, split = params.split, isTrailing = params.isTrailing, _b = params.useOppositePeriodFallback, useOppositePeriodFallback = _b === void 0 ? true : _b;
         var splitVal = split.splitRatio;
-        if (!splitVal)
+        // string values are not adjusted
+        if (typeof ((_a = factGroup.valuePeriodFirst) !== null && _a !== void 0 ? _a : factGroup.valueTrailingFirst) === 'string') {
             return true;
-        // these first two criteria will take care of the majority of cases...
+        }
+        // can't apply split values of 0 or null
+        if (!splitVal) {
+            return true;
+        }
+        // these two criteria will take care of the majority of cases where the fact was not filed in
+        // the window of the first and last filing of the split
         if (factGroup.filedFirst > split.filedLast) {
             return true;
         }
         if (factGroup.filedLast < split.filedFirst) {
             return false;
         }
+        // fact that is being used as the group value
         var resolvedFact = factGroup.facts.find(function (f) {
             return isTrailing ? f.value === factGroup.valueTrailingFirst : f.value === factGroup.valuePeriodFirst;
         });
+        // if resolved fact not found, try checking trailing or period (whichever is not the current one)
         if (!resolvedFact && useOppositePeriodFallback) {
             return this.didApplySplit(__assign(__assign({}, params), { isTrailing: !isTrailing, useOppositePeriodFallback: false }));
         }
@@ -185,10 +195,10 @@ var FactSplitAdjuster = /** @class */ (function () {
                 return isAdjusted;
             }
         }
-        if ((resolvedFact === null || resolvedFact === void 0 ? void 0 : resolvedFact.filed) > split.filedLast) {
+        if ((resolvedFact === null || resolvedFact === void 0 ? void 0 : resolvedFact.filed) && resolvedFact.filed > split.filedLast) {
             return true;
         }
-        if ((resolvedFact === null || resolvedFact === void 0 ? void 0 : resolvedFact.filed) < split.filedFirst) {
+        if ((resolvedFact === null || resolvedFact === void 0 ? void 0 : resolvedFact.filed) && resolvedFact.filed < split.filedFirst) {
             return false;
         }
         // // if the filed date of the fact overlaps with the filed date of the split, try comparing the end dates
@@ -196,12 +206,12 @@ var FactSplitAdjuster = /** @class */ (function () {
             return false;
         }
         // if we still don't know, see if the split value puts us closer to the last known value or further
-        if (factGroup.valuePeriodLast !== null) {
+        if (typeof factGroup.valuePeriodLast === 'number') {
             var val = this.getGroupValue(factGroup, isTrailing);
             var valueWithSplit = isShareRatio ? val / splitVal : val * splitVal;
             return Math.abs(factGroup.valuePeriodLast - val) < Math.abs(factGroup.valuePeriodLast - valueWithSplit);
         }
-        if (factGroup.valueTrailingLast !== null) {
+        if (typeof factGroup.valueTrailingLast === 'number') {
             var val = this.getGroupValue(factGroup, isTrailing);
             var valueWithSplit = isShareRatio ? val / splitVal : val * splitVal;
             return Math.abs(factGroup.valueTrailingLast - val) < Math.abs(factGroup.valueTrailingLast - valueWithSplit);

package/build/services/ReportRawBuilder/ReportRawBuilder.d.ts

@@ -31,6 +31,7 @@ export default class ReportRawBuilder {
         factGroupsByReportKey: Map<string, FactGroup[]>;
         fiscalCalculator: FactFiscalCalculator;
         splits?: SplitData[];
+        accessionByYearQuarter?: Map<string, string>;
         minYear: number;
         maxYear: number;
         cik: number;

package/build/services/ReportRawBuilder/ReportRawBuilder.js

@@ -36,7 +36,8 @@ var ReportRawBuilder = /** @class */ (function () {
                 accessionByYearQuarter.set("".concat(year, "_").concat(quarter), accn);
         });
         var reportsCik = Number(facts[0].cik);
-        var fiscalCalculator = this.createFiscalCalculator({ facts: facts });
+        var fiscalCalculator = reportDates ? new FactFiscalCalculator_1.default() : this.createFiscalCalculator({ facts: facts });
+        reportDates === null || reportDates === void 0 ? void 0 : reportDates.forEach(function (params) { return fiscalCalculator.setReportDates(params); });
         var factGrouper = new FactGrouper_1.default();
         var factSplitAdjuster = new FactSplitAdjuster_1.default();
         // if splits not included in params and need to adjust, extract from facts
@@ -65,12 +66,11 @@ var ReportRawBuilder = /** @class */ (function () {
         return "".concat(year, "_").concat(isAnnual ? 'FY' : "Q".concat(quarter));
     };
     ReportRawBuilder.prototype.createReport = function (params) {
-        var _a;
-        var group = params.group, isAnnual = params.isAnnual, splitDate = params.splitDate, splitRatio = params.splitRatio, cik = params.cik;
+        var group = params.group, isAnnual = params.isAnnual, splitDate = params.splitDate, splitRatio = params.splitRatio, cik = params.cik, accessionNumber = params.accessionNumber;
         var fiscalPeriod = isAnnual ? 'FY' : "Q".concat(group.quarter);
-        var accessionNoHyphen = (_a = group.accn) === null || _a === void 0 ? void 0 : _a.replace(/-/g, '');
-        var url = group.accn
-            ? "https://www.sec.gov/Archives/edgar/data/".concat(cik, "/").concat(accessionNoHyphen, "/").concat(group.accn, ".txt")
+        var accessionNoHyphen = accessionNumber === null || accessionNumber === void 0 ? void 0 : accessionNumber.replace(/-/g, '');
+        var url = accessionNumber
+            ? "https://www.sec.gov/Archives/edgar/data/".concat(cik, "/").concat(accessionNoHyphen, "/").concat(accessionNumber, ".txt")
             : null;
         return {
             cik: cik,
@@ -89,7 +89,7 @@ var ReportRawBuilder = /** @class */ (function () {
     };
     ReportRawBuilder.prototype.buildReportsFromGroups = function (params) {
         var _this = this;
-        var factGroupsByReportKey = params.factGroupsByReportKey, minYear = params.minYear, maxYear = params.maxYear, cik = params.cik, splits = params.splits, fiscalCalculator = params.fiscalCalculator;
+        var factGroupsByReportKey = params.factGroupsByReportKey, minYear = params.minYear, maxYear = params.maxYear, cik = params.cik, splits = params.splits, fiscalCalculator = params.fiscalCalculator, accessionByYearQuarter = params.accessionByYearQuarter;
         var splitByFiscals = new Map();
         var reportByKey = new Map();
         splits === null || splits === void 0 ? void 0 : splits.forEach(function (split) {
@@ -97,16 +97,19 @@ var ReportRawBuilder = /** @class */ (function () {
             splitByFiscals.set("".concat(year, "_").concat(quarter), split);
         });
         factGroupsByReportKey.forEach(function (groups) {
-            var _a, _b, _c, _d, _e, _f;
+            var _a, _b, _c, _d, _e, _f, _g;
             var groupWithDates = groups.find(function (g) { return g.reportEnd; });
             if (!groupWithDates)
                 return;
-            var split = splitByFiscals.get("".concat(groupWithDates.fiscalYear, "_").concat(groupWithDates.quarter));
-            var splitDate = (_a = split === null || split === void 0 ? void 0 : split.endLast) !== null && _a !== void 0 ? _a : null;
-            var splitRatio = (_b = split === null || split === void 0 ? void 0 : split.splitRatio) !== null && _b !== void 0 ? _b : null;
+            var keyYearQuarter = "".concat(groupWithDates.fiscalYear, "_").concat(groupWithDates.quarter);
+            var split = splitByFiscals.get(keyYearQuarter);
+            var accessionNumber = (_a = accessionByYearQuarter === null || accessionByYearQuarter === void 0 ? void 0 : accessionByYearQuarter.get(keyYearQuarter)) !== null && _a !== void 0 ? _a : groupWithDates.accn;
+            var splitDate = (_b = split === null || split === void 0 ? void 0 : split.endLast) !== null && _b !== void 0 ? _b : null;
+            var splitRatio = (_c = split === null || split === void 0 ? void 0 : split.splitRatio) !== null && _c !== void 0 ? _c : null;
             var quarter = groupWithDates.quarter;
             var reportPeriod = _this.createReport({
                 group: groupWithDates,
+                accessionNumber: accessionNumber,
                 cik: cik,
                 isAnnual: false,
                 splitDate: splitDate,
@@ -119,7 +122,7 @@ var ReportRawBuilder = /** @class */ (function () {
             });
             for (var _i = 0, groups_1 = groups; _i < groups_1.length; _i++) {
                 var group = groups_1[_i];
-                var value = (_d = (_c = group.valuePeriodResolved) !== null && _c !== void 0 ? _c : group.valuePeriodFirst) !== null && _d !== void 0 ? _d : 0;
+                var value = (_e = (_d = group.valuePeriodResolved) !== null && _d !== void 0 ? _d : group.valuePeriodFirst) !== null && _e !== void 0 ? _e : 0;
                 reportPeriod[group.name] = _this.round(value);
             }
             reportByKey.set(reportKeyPeriod, reportPeriod);
@@ -127,20 +130,22 @@ var ReportRawBuilder = /** @class */ (function () {
                 return;
             var reportAnnual = _this.createReport({
                 group: groupWithDates,
+                accessionNumber: accessionNumber,
                 cik: cik,
                 isAnnual: true,
                 splitDate: splitDate,
                 splitRatio: splitRatio,
             });
             var reportKeyAnnual = "".concat(reportAnnual.fiscalYear, "_").concat(reportAnnual.fiscalPeriod);
-            for (var _g = 0, groups_2 = groups; _g < groups_2.length; _g++) {
-                var group = groups_2[_g];
-                var value = (_f = (_e = group.valueTrailingResolved) !== null && _e !== void 0 ? _e : group.valueTrailingFirst) !== null && _f !== void 0 ? _f : 0;
+            for (var _h = 0, groups_2 = groups; _h < groups_2.length; _h++) {
+                var group = groups_2[_h];
+                var value = (_g = (_f = group.valueTrailingResolved) !== null && _f !== void 0 ? _f : group.valueTrailingFirst) !== null && _g !== void 0 ? _g : 0;
                 reportAnnual[group.name] = _this.round(value);
             }
             reportByKey.set(reportKeyAnnual, reportAnnual);
         });
         var reports = [];
+        // sort reports by year and quarter
         for (var year = minYear; year <= maxYear; year++) {
             for (var quarter = 1; quarter <= 5; quarter++) {
                 var isAnnual = quarter === 5;

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

@@ -0,0 +1,4 @@
+import { FilingListDetails, FilingListItemTranslated } from '../../types';
+export default class FilingMapper {
+    mapFilingListDetails(cik: string | number, filingListDetails: FilingListDetails): FilingListItemTranslated[];
+}

package/build/services/SecEdgarApi/FilingMapper.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var FilingMapper = /** @class */ (function () {
+    function FilingMapper() {
+    }
+    FilingMapper.prototype.mapFilingListDetails = function (cik, filingListDetails) {
+        var _a;
+        var filings = [];
+        var accessionNumbers = filingListDetails.accessionNumber;
+        for (var i = 0; i < accessionNumbers.length; i++) {
+            var accessionStrTrimmed = (_a = accessionNumbers[i]) === null || _a === void 0 ? void 0 : _a.replace(/-/g, '');
+            var urlPrefix = "https://www.sec.gov/Archives/edgar/data/".concat(Number(cik), "/").concat(accessionStrTrimmed);
+            var filing = {
+                accessionNumber: accessionNumbers[i],
+                filingDate: filingListDetails.filingDate[i],
+                reportDate: filingListDetails.reportDate[i],
+                acceptanceDateTime: filingListDetails.acceptanceDateTime[i],
+                act: filingListDetails.act[i],
+                form: filingListDetails.form[i],
+                fileNumber: filingListDetails.fileNumber[i],
+                filmNumber: filingListDetails.filmNumber[i],
+                items: filingListDetails.items[i],
+                size: filingListDetails.size[i],
+                isXBRL: filingListDetails.isXBRL[i],
+                isInlineXBRL: filingListDetails.isInlineXBRL[i],
+                primaryDocument: filingListDetails.primaryDocument[i],
+                primaryDocDescription: filingListDetails.primaryDocDescription[i],
+                url: "".concat(urlPrefix, "/").concat(accessionNumbers[i], ".txt"),
+                urlPrimaryDocument: "".concat(urlPrefix, "/").concat(filingListDetails.primaryDocument[i]),
+            };
+            filings.push(filing);
+        }
+        return filings;
+    };
+    return FilingMapper;
+}());
+exports.default = FilingMapper;

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

@@ -7,6 +7,7 @@ export interface SendRequestParams {
 }
 interface SubmissionRequestWrapperArgs<T> {
     submissions: FilingListItemTranslated[];
+    usePrimaryDocument: boolean;
     options?: SubmissionRequestWrapperOptions;
     sendRequest: (params: SendRequestParams) => Promise<T>;
 }
@@ -20,6 +21,7 @@ export default class SubmissionRequestWrapper<T> {
     private readonly options;
     private readonly submissions;
     private readonly errors;
+    private readonly usePrimaryDocument;
     private readonly sendRequest;
     private requestCount;
     private isDone;

package/build/services/SecEdgarApi/RequestWrapper.js

@@ -38,11 +38,12 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 Object.defineProperty(exports, "__esModule", { value: true });
 var SubmissionRequestWrapper = /** @class */ (function () {
     function SubmissionRequestWrapper(args) {
-        var submissions = args.submissions, _a = args.options, options = _a === void 0 ? {} : _a, sendRequest = args.sendRequest;
+        var submissions = args.submissions, _a = args.options, options = _a === void 0 ? {} : _a, sendRequest = args.sendRequest, usePrimaryDocument = args.usePrimaryDocument;
         this.options = options;
         this.submissions = submissions;
         this.results = [];
         this.errors = [];
+        this.usePrimaryDocument = usePrimaryDocument;
         this.sendRequest = sendRequest;
         this.requestCount = 0;
         this.isDone = (options === null || options === void 0 ? void 0 : options.maxRequests) === 0;
@@ -55,7 +56,7 @@ var SubmissionRequestWrapper = /** @class */ (function () {
     };
     SubmissionRequestWrapper.prototype.requestNext = function () {
         return __awaiter(this, void 0, void 0, function () {
-            var _a, maxRequests, submission, isComplete, url, result, data, e_1, error;
+            var _a, maxRequests, submission, isComplete, url, urlPrimaryDocument, requestUrl, result, data, e_1, error;
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
@@ -69,7 +70,8 @@ var SubmissionRequestWrapper = /** @class */ (function () {
                                     result: null,
                                 }];
                         }
-                        url = submission.url;
+                        url = submission.url, urlPrimaryDocument = submission.urlPrimaryDocument;
+                        requestUrl = this.usePrimaryDocument ? urlPrimaryDocument : url;
                         this.requestCount++;
                         if (this.requestCount >= this.submissions.length || this.requestCount >= maxRequests) {
                             this.isDone = true;
@@ -77,7 +79,7 @@ var SubmissionRequestWrapper = /** @class */ (function () {
                         _b.label = 1;
                     case 1:
                         _b.trys.push([1, 3, , 4]);
-                        return [4 /*yield*/, this.sendRequest({ url: url })];
+                        return [4 /*yield*/, this.sendRequest({ url: requestUrl })];
                     case 2:
                         result = _b.sent();
                         data = {

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

@@ -4,6 +4,7 @@ import { IClient } from '../Client';
 import DocumentParser from '../DocumentParser';
 import ReportParser from '../ReportParser';
 import ReportWrapper from '../ReportParser/ReportWrapper';
+import FilingMapper from './FilingMapper';
 import SubmissionRequestWrapper from './RequestWrapper';
 import { IThrottler } from './Throttler';
 interface SecApiArgs {
@@ -12,6 +13,7 @@ interface SecApiArgs {
     cikBySymbol: Record<string, number>;
     reportParser: ReportParser;
     documentParser: DocumentParser;
+    filingMapper?: FilingMapper;
 }
 export interface CreateRequestWrapperParams {
     /** symbol or cik */
@@ -67,6 +69,7 @@ export default class SecEdgarApi {
     private readonly baseUrlSec;
     private readonly throttler;
     private readonly client;
+    private readonly filingMapper;
     readonly cikBySymbol: Record<string, number>;
     readonly reportParser: ReportParser;
     readonly documentParser: DocumentParser;
@@ -88,7 +91,9 @@ export default class SecEdgarApi {
      *
      * endpoint: `/submissions/CIK${cik}.json`
      */
-    getSubmissions(params: GetSymbolParams): Promise<{
+    getSubmissions(params: GetSymbolParams & {
+        includeOldFilings?: boolean;
+    }): Promise<{
         submissionList: SubmissionList;
         filings: FilingListItemTranslated[];
     }>;

package/build/services/SecEdgarApi/SecEdgarApi.js

@@ -51,6 +51,7 @@ 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 FilingMapper_1 = require("./FilingMapper");
 var RequestWrapper_1 = require("./RequestWrapper");
 var Throttler_1 = require("./Throttler");
 /**
@@ -66,13 +67,15 @@ var SecEdgarApi = /** @class */ (function () {
             cikBySymbol: cik_by_symbol_1.default,
             reportParser: new ReportParser_1.default(),
             documentParser: new DocumentParser_1.default(),
+            filingMapper: new FilingMapper_1.default(),
         }; }
-        var client = args.client, throttler = args.throttler, cikBySymbol = args.cikBySymbol, reportParser = args.reportParser, documentParser = args.documentParser;
+        var client = args.client, throttler = args.throttler, cikBySymbol = args.cikBySymbol, reportParser = args.reportParser, documentParser = args.documentParser, _a = args.filingMapper, filingMapper = _a === void 0 ? new FilingMapper_1.default() : _a;
         this.client = client;
         this.throttler = throttler;
         this.cikBySymbol = cikBySymbol;
         this.reportParser = reportParser;
         this.documentParser = documentParser;
+        this.filingMapper = filingMapper;
         this.baseUrlEdgar = 'https://data.sec.gov';
         this.baseUrlSec = 'https://www.sec.gov';
     }
@@ -81,61 +84,40 @@ var SecEdgarApi = /** @class */ (function () {
         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*/];
-                        });
-                    }); })];
+                return [2 /*return*/, new Promise(function (resolve, reject) {
+                        _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*/];
+                                }
+                            });
+                        }); });
+                    })];
             });
         });
     };
     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;
+        return this.filingMapper.mapFilingListDetails(cik, filingListDetails);
     };
     SecEdgarApi.prototype.getCreateRequestSubmissions = function (params, forms) {
         var symbol = params.symbol, filings = params.filings, _a = params.cutoffDate, cutoffDate = _a === void 0 ? new Date('1970-01-01') : _a;
@@ -168,19 +150,39 @@ var SecEdgarApi = /** @class */ (function () {
      * endpoint: `/submissions/CIK${cik}.json`
      */
     SecEdgarApi.prototype.getSubmissions = function (params) {
-        var _a;
         return __awaiter(this, void 0, void 0, function () {
-            var symbol, cik, submissionList;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
+            var symbol, includeOldFilings, cik, submissionList, additionalFilings, filings;
+            var _this = this;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
                     case 0:
-                        symbol = params.symbol;
+                        symbol = params.symbol, includeOldFilings = params.includeOldFilings;
                         cik = this.getCikString(symbol);
                         return [4 /*yield*/, this.request("".concat(this.baseUrlEdgar, "/submissions/CIK").concat(cik, ".json"))];
                     case 1:
-                        submissionList = _b.sent();
+                        submissionList = _a.sent();
+                        if (!includeOldFilings) return [3 /*break*/, 3];
+                        return [4 /*yield*/, Promise.all(submissionList.filings.files.map(function (file) {
+                                return _this.request("".concat(_this.baseUrlEdgar, "/submissions/").concat(file.name));
+                            }))];
+                    case 2:
+                        additionalFilings = _a.sent();
+                        additionalFilings.forEach(function (data) {
+                            var _loop_1 = function (key) {
+                                var k = key;
+                                var valuesCurrent = submissionList.filings.recent[k];
+                                var values = data[k];
+                                values.forEach(function (v) { return valuesCurrent.push(v); });
+                            };
+                            for (var key in data) {
+                                _loop_1(key);
+                            }
+                        });
+                        _a.label = 3;
+                    case 3:
                         submissionList.cik = Number(submissionList.cik);
-                        return [2 /*return*/, { submissionList: submissionList, filings: this.mapFilingListDetails(cik, (_a = submissionList === null || submissionList === void 0 ? void 0 : submissionList.filings) === null || _a === void 0 ? void 0 : _a.recent) }];
+                        filings = this.mapFilingListDetails(cik, submissionList.filings.recent);
+                        return [2 /*return*/, { submissionList: submissionList, filings: filings }];
                 }
             });
         });
@@ -260,7 +262,7 @@ var SecEdgarApi = /** @class */ (function () {
      */
     SecEdgarApi.prototype.getReports = function (params) {
         return __awaiter(this, void 0, void 0, function () {
-            var _a, withWrapper, _b, usePropertyResolver, reportsRaw, reports;
+            var _a, withWrapper, _b, usePropertyResolver, reportsRaw, reportsWithWrapper, reports;
             return __generator(this, function (_c) {
                 switch (_c.label) {
                     case 0:
@@ -268,8 +270,9 @@ var SecEdgarApi = /** @class */ (function () {
                         return [4 /*yield*/, this.getReportsRaw(__assign(__assign({}, params), { includeNamePrefix: false }))];
                     case 1:
                         reportsRaw = _c.sent();
-                        reports = this.reportParser.parseReportsFromRaw({ reportsRaw: reportsRaw, usePropertyResolver: usePropertyResolver });
-                        return [2 /*return*/, withWrapper ? reports : reports.map(function (report) { return report.getReport(); })];
+                        reportsWithWrapper = this.reportParser.parseReportsFromRaw({ reportsRaw: reportsRaw, usePropertyResolver: usePropertyResolver });
+                        reports = withWrapper ? reportsWithWrapper : reportsWithWrapper.map(function (report) { return report.getReport(); });
+                        return [2 /*return*/, reports];
                 }
             });
         });
@@ -402,7 +405,12 @@ var SecEdgarApi = /** @class */ (function () {
                 }
             });
         }); };
-        return new RequestWrapper_1.default({ submissions: submissions, options: options, sendRequest: sendRequest });
+        return new RequestWrapper_1.default({
+            submissions: submissions,
+            options: options,
+            sendRequest: sendRequest,
+            usePrimaryDocument: true,
+        });
     };
     /**
      * Used for getting institutional holders. extracts holders urls from submission list response, and parses the xml doc.
@@ -432,7 +440,12 @@ var SecEdgarApi = /** @class */ (function () {
                 }
             });
         }); };
-        return new RequestWrapper_1.default({ submissions: submissions, options: options, sendRequest: sendRequest });
+        return new RequestWrapper_1.default({
+            submissions: submissions,
+            options: options,
+            sendRequest: sendRequest,
+            usePrimaryDocument: true,
+        });
     };
     /**
      * Used for getting earnings report tables from submission files.
@@ -462,7 +475,12 @@ var SecEdgarApi = /** @class */ (function () {
                 }
             });
         }); };
-        return new RequestWrapper_1.default({ submissions: submissions, options: options, sendRequest: sendRequest });
+        return new RequestWrapper_1.default({
+            submissions: submissions,
+            options: options,
+            sendRequest: sendRequest,
+            usePrimaryDocument: true,
+        });
     };
     /**
      * Proxy statement includes list of holders, executiveCompensation, and other tables. returns FormDef14aData
@@ -491,7 +509,12 @@ var SecEdgarApi = /** @class */ (function () {
                 }
             });
         }); };
-        return new RequestWrapper_1.default({ submissions: submissions, options: options, sendRequest: sendRequest });
+        return new RequestWrapper_1.default({
+            submissions: submissions,
+            options: options,
+            sendRequest: sendRequest,
+            usePrimaryDocument: true,
+        });
     };
     /**
      * Gets list of latest filings.

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

@@ -2,17 +2,18 @@ interface OnProgressData {
     queueLength: number;
     countRunning: number;
 }
+type ResolveValue = any;
 interface ThrottlerArgs {
     maxConcurrent?: number;
     delayMs?: number;
     onProgress?: (data: OnProgressData) => void;
-    onResult?: (result: any) => void;
-    onError?: (err: any) => void;
-    onEnd?: (results: any[], errors: any[]) => void;
+    onResult?: (result: ResolveValue) => void;
+    onError?: (err: ResolveValue) => void;
+    onEnd?: (results: ResolveValue[], errors: ResolveValue[]) => void;
 }
 export interface IThrottler {
     setDelayMs(delayMs: number): void;
-    add: (fn: () => Promise<any>) => void;
+    add: (fn: () => Promise<ResolveValue>) => void;
 }
 export default class Throttler implements IThrottler {
     private readonly decrementTimeouts;
@@ -22,12 +23,12 @@ export default class Throttler implements IThrottler {
     private maxConcurrent;
     private delayMs;
     onProgress?: (data: OnProgressData) => void;
-    onResult?: (result: any) => void;
-    onError?: (err: any) => void;
-    onEnd?: (results: any[], errors: any[]) => void;
+    onResult?: (result: ResolveValue) => void;
+    onError?: (err: ResolveValue) => void;
+    onEnd?: (results: ResolveValue[], errors: ResolveValue[]) => void;
     constructor(args?: ThrottlerArgs);
     setDelayMs(delayMs: number): void;
-    add(fn: () => Promise<any>): void;
+    add(fn: () => Promise<ResolveValue>): void;
     private run;
 }
 export {};

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

@@ -29,18 +29,18 @@ export interface FactGroup {
     filedLast: string;
     endFirst: string;
     endLast: string;
-    values: number[];
+    values: (number | string)[];
     fiscalYear: number;
     quarter: number;
     facts: FactItem[];
-    valueSplitAdjustedPeriod: number | null;
-    valueSplitAdjustedTrailing: number | null;
-    valuePeriodResolved: number | null;
-    valueTrailingResolved: number | null;
-    valuePeriodFirst: number | null;
-    valuePeriodLast: number | null;
-    valueTrailingFirst: number | null;
-    valueTrailingLast: number | null;
+    valueSplitAdjustedPeriod: number | string | null;
+    valueSplitAdjustedTrailing: number | string | null;
+    valuePeriodResolved: number | string | null;
+    valueTrailingResolved: number | string | null;
+    valuePeriodFirst: number | string | null;
+    valuePeriodLast: number | string | null;
+    valueTrailingFirst: number | string | null;
+    valueTrailingLast: number | string | null;
 }
 export interface FactItemExtended extends FactItem {
     period: number;

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

@@ -53,6 +53,7 @@ export interface FilingListItemTranslated {
     primaryDocument: string;
     primaryDocDescription: string;
     url: string;
+    urlPrimaryDocument: string;
 }
 interface FilingList {
     recent: FilingListDetails;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "sec-edgar-api",
-    "version": "0.3.2",
+    "version": "0.3.4",
     "description": "Fetch and parse SEC earnings reports and other filings. Useful for financial analysis.",
     "main": "build/index.js",
     "author": "Andrew Evers (https://github.com/andyevers)",
@@ -13,7 +13,8 @@
     "scripts": {
         "test": "jest test",
         "build": "tsc",
-        "publish": "npm run build && npm publish"
+        "publish": "npm run build && npm publish",
+        "lint": "npx eslint src"
     },
     "keywords": [
         "sec",
@@ -26,11 +27,15 @@
         "reports"
     ],
     "devDependencies": {
+        "@eslint/js": "^9.11.1",
+        "@types/eslint__js": "^8.42.3",
         "@types/jest": "^29.5.2",
+        "eslint": "^9.11.1",
         "jest": "^29.5.0",
         "prettier": "^2.8.8",
         "ts-jest": "^29.1.0",
-        "typescript": "^5.1.3"
+        "typescript": "5.1.3",
+        "typescript-eslint": "^8.8.0"
     },
     "files": [
         "build/**/*"