sec-edgar-api 0.5.9 → 0.5.11

package/build/services/DocumentParser/parsers/parse-xbrl.js

@@ -150,11 +150,11 @@ function buildReportsFromFacts(params) {
     return { reportFocus: reportFocus, reportByDateRange: reportByDateRange, factsFiltered: Array.from(factByName.values()) };
 }
 function parseXbrl(params) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
     var parser = new XBRLParser_1.default();
-    var xml = params.xml, _k = params.includeReport, includeReport = _k === void 0 ? true : _k, options = __rest(params, ["xml", "includeReport"]);
+    var xml = params.xml, _p = params.includeReport, includeReport = _p === void 0 ? true : _p, options = __rest(params, ["xml", "includeReport"]);
     var response = parser.parse(xml, options);
-    var _l = (_b = (_a = response.instance) === null || _a === void 0 ? void 0 : _a.xbrl) !== null && _b !== void 0 ? _b : {}, _m = _l.contexts, contexts = _m === void 0 ? [] : _m, _o = _l.factElements, factElements = _o === void 0 ? [] : _o;
+    var _q = (_b = (_a = response.instance) === null || _a === void 0 ? void 0 : _a.xbrl) !== null && _b !== void 0 ? _b : {}, _r = _q.contexts, contexts = _r === void 0 ? [] : _r, _s = _q.factElements, factElements = _s === void 0 ? [] : _s;
     var contextById = new Map();
     contexts.forEach(function (context) { return contextById.set(context.id, context); });
     var cik = response.header.cik;
@@ -197,16 +197,20 @@ function parseXbrl(params) {
                 month: Number(response.header.fiscalYearEnd.substring(0, 2)),
             },
         });
-        var _p = fiscalCalculator.getFiscalYearQuarter({ dateStr: response.header.reportDate }), quarter = _p.quarter, year = _p.year;
+        var reportDate = (_g = response.header.reportDate) !== null && _g !== void 0 ? _g : (_j = (_h = response.instance) === null || _h === void 0 ? void 0 : _h.xbrl.factElements.find(function (f) { return f.name === 'dei:DocumentPeriodEndDate'; })) === null || _j === void 0 ? void 0 : _j.text;
+        if (!reportDate) {
+            throw new Error("Report date not found. Unable to determine fiscal year and period. accn: ".concat(accessionNumber));
+        }
+        var _t = fiscalCalculator.getFiscalYearQuarter({ dateStr: reportDate !== null && reportDate !== void 0 ? reportDate : '' }), quarter = _t.quarter, year = _t.year;
         fiscalYear = year;
         fiscalPeriod = (quarter === 4 ? 'FY' : "Q".concat(quarter));
     }
     var factsForBuilder = includeReport ? facts : [];
-    var _q = buildReportsFromFacts({
+    var _u = buildReportsFromFacts({
         facts: factsForBuilder,
         pathSeparator: '>',
-        fiscalPeriod: (_g = factsForBuilder.find(function (f) { return f.name === 'dei:DocumentFiscalPeriodFocus'; })) === null || _g === void 0 ? void 0 : _g.value,
-        fiscalYear: Number((_j = (_h = factsForBuilder.find(function (f) { return f.name === 'dei:DocumentFiscalYearFocus'; })) === null || _h === void 0 ? void 0 : _h.value) !== null && _j !== void 0 ? _j : 0),
+        fiscalPeriod: (_k = factsForBuilder.find(function (f) { return f.name === 'dei:DocumentFiscalPeriodFocus'; })) === null || _k === void 0 ? void 0 : _k.value,
+        fiscalYear: Number((_m = (_l = factsForBuilder.find(function (f) { return f.name === 'dei:DocumentFiscalYearFocus'; })) === null || _l === void 0 ? void 0 : _l.value) !== null && _m !== void 0 ? _m : 0),
         cik: response.header.cik,
         filing: {
             acceptanceDateTime: response.header.acceptanceDatetime,
@@ -226,7 +230,29 @@ function parseXbrl(params) {
             url: "https://www.sec.gov/Archives/edgar/data/".concat(cik, "/").concat(accessionNumberNoHyphens, "/").concat(accessionNumber, ".txt"),
             urlPrimaryDocument: '',
         },
-    }), factsFiltered = _q.factsFiltered, reportFocus = _q.reportFocus, reportByDateRange = _q.reportByDateRange;
-    return __assign(__assign({}, response), { fiscalYear: fiscalYear, fiscalPeriod: fiscalPeriod, facts: factsFiltered, report: factsFiltered.length > 0 ? reportFocus : null, xml: xml, periodReports: Object.values(reportByDateRange) });
+    }), factsFiltered = _u.factsFiltered, reportFocus = _u.reportFocus, reportByDateRange = _u.reportByDateRange;
+    // Some concepts have members, but do not have a sum. add the sum to the report.
+    var periodReports = Object.values(reportByDateRange);
+    for (var _v = 0, periodReports_1 = periodReports; _v < periodReports_1.length; _v++) {
+        var report = periodReports_1[_v];
+        for (var key in report) {
+            if (!key.includes('>'))
+                continue;
+            var parts = key.split('>');
+            var concept = parts.shift();
+            var center = parts.slice(0, -1).join('>');
+            if (!concept || report[concept] !== undefined)
+                continue;
+            var sum = 0;
+            for (var k in report) {
+                var prefix = "".concat(concept, ">").concat(center, ">");
+                if (k.startsWith(prefix) && !((_o = k.split(prefix).pop()) === null || _o === void 0 ? void 0 : _o.includes('>'))) {
+                    sum += Number(typeof report[k] === 'number' ? report[k] : 0);
+                }
+            }
+            report[concept] = sum;
+        }
+    }
+    return __assign(__assign({}, response), { fiscalYear: fiscalYear, fiscalPeriod: fiscalPeriod, facts: factsFiltered, report: factsFiltered.length > 0 ? reportFocus : null, xml: xml, periodReports: periodReports });
 }
 exports.parseXbrl = parseXbrl;

package/build/services/ReportRawBuilder/FactFiscalCalculator.js

@@ -239,6 +239,9 @@ var FactFiscalCalculator = /** @class */ (function () {
         var _a;
         var dateStr = params.dateStr, endDateByYearProp = params.endDateByYear, fiscalYearEnd = params.fiscalYearEnd;
         var endDateByYear = endDateByYearProp !== null && endDateByYearProp !== void 0 ? endDateByYearProp : new Map();
+        if (!dateStr) {
+            throw new Error('No date provided, cannot determine fiscal year and quarter');
+        }
         if (fiscalYearEnd) {
             var month = fiscalYearEnd.month, day = fiscalYearEnd.day;
             var year = new Date().getFullYear();

package/build/services/ReportRawBuilder/ReportRawBuilder.js

@@ -48,7 +48,7 @@ var ReportRawBuilder = /** @class */ (function () {
         }
         var reportsCik = Number(facts[0].cik);
         var fiscalCalculator = new FactFiscalCalculator_1.default({
-            filings: filings === null || filings === void 0 ? void 0 : filings.filter(function (f) { return constants_1.FORMS_EARNINGS.includes(f.form); }),
+            filings: filings === null || filings === void 0 ? void 0 : filings.filter(function (f) { return constants_1.FORMS_EARNINGS.includes(f.form) && Boolean(f.reportDate); }),
             facts: facts,
             fiscalYearEnd: fiscalYearEnd,
         });

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

@@ -292,6 +292,8 @@ export default class SecEdgarApi {
     /**
      * Gets list of filings for a day up to 5 days ago.
      *
+     * NOTE: This has not been updated since 2014 and has had issues with not returning data.
+     *
      * @see https://www.sec.gov/edgar/searchedgar/currentevents
      */
     getCurrentFilingsDaily(params?: {
@@ -310,8 +312,16 @@ export default class SecEdgarApi {
             filedDate: string;
         }[];
     }>;
+    /**
+     * Lists all types of current filings including non XBRL. If fetching earnings reports,
+     * use getCurrentFilingsXbrl instead.
+     *
+     * @see https://www.sec.gov/cgi-bin/browse-edgar?action=getcurrent
+     */
     getCurrentFilings(params?: GetCurrentFilingsParams): Promise<import("../../types").CurrentFilingsList>;
     /**
+     * Fetches XBRL filings using the RSS feeds provided by the SEC.
+     *
      * @see https://www.sec.gov/structureddata/rss-feeds-submitted-filings
      */
     getCurrentFilingsXbrl(params?: {
@@ -334,6 +344,8 @@ export default class SecEdgarApi {
      * Search for companies from by name, sic code, or state.
      *
      * example at https://www.sec.gov/cgi-bin/browse-edgar?action=getcompany&owner=exclude&&start=0&count=100&hidefilings=0&company=Apple&match=contains
+     *
+     * TODO: Switch this to use output=atom in the url
      */
     searchCompanies(params: SearchCompaniesParams): Promise<{
         items: import("../../types").CompanySearchResult[];

package/build/services/SecEdgarApi/SecEdgarApi.js

@@ -588,6 +588,8 @@ var SecEdgarApi = /** @class */ (function () {
     /**
      * Gets list of filings for a day up to 5 days ago.
      *
+     * NOTE: This has not been updated since 2014 and has had issues with not returning data.
+     *
      * @see https://www.sec.gov/edgar/searchedgar/currentevents
      */
     SecEdgarApi.prototype.getCurrentFilingsDaily = function (params) {
@@ -620,6 +622,12 @@ var SecEdgarApi = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Lists all types of current filings including non XBRL. If fetching earnings reports,
+     * use getCurrentFilingsXbrl instead.
+     *
+     * @see https://www.sec.gov/cgi-bin/browse-edgar?action=getcurrent
+     */
     SecEdgarApi.prototype.getCurrentFilings = function (params) {
         var _a;
         return __awaiter(this, void 0, void 0, function () {
@@ -648,6 +656,8 @@ var SecEdgarApi = /** @class */ (function () {
         });
     };
     /**
+     * Fetches XBRL filings using the RSS feeds provided by the SEC.
+     *
      * @see https://www.sec.gov/structureddata/rss-feeds-submitted-filings
      */
     SecEdgarApi.prototype.getCurrentFilingsXbrl = function (params) {
@@ -703,6 +713,8 @@ var SecEdgarApi = /** @class */ (function () {
      * Search for companies from by name, sic code, or state.
      *
      * example at https://www.sec.gov/cgi-bin/browse-edgar?action=getcompany&owner=exclude&&start=0&count=100&hidefilings=0&company=Apple&match=contains
+     *
+     * TODO: Switch this to use output=atom in the url
      */
     SecEdgarApi.prototype.searchCompanies = function (params) {
         return __awaiter(this, void 0, void 0, function () {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "sec-edgar-api",
-    "version": "0.5.9",
+    "version": "0.5.11",
     "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)",