sec-edgar-api 0.5.10 → 0.5.12

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

@@ -36,8 +36,8 @@ function isWithinDays(params) {
     return daysDiff < days;
 }
 function buildReportsFromFacts(params) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w;
-    var filing = params.filing, facts = params.facts, fiscalPeriod = params.fiscalPeriod, fiscalYear = params.fiscalYear, pathSeparator = params.pathSeparator, cikProp = params.cik;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v;
+    var filing = params.filing, facts = params.facts, fiscalPeriod = params.fiscalPeriod, fiscalYear = params.fiscalYear, pathSeparator = params.pathSeparator, cikProp = params.cik, fiscalYearEnd = params.fiscalYearEnd;
     var urlParts = (_a = filing === null || filing === void 0 ? void 0 : filing.url.split('/')) !== null && _a !== void 0 ? _a : [];
     var cik = cikProp !== null && cikProp !== void 0 ? cikProp : urlParts[(_b = urlParts.indexOf('data')) !== null && _b !== void 0 ? _b : -1];
     var reportFactValues = {
@@ -63,37 +63,36 @@ function buildReportsFromFacts(params) {
     var roundPlacesByName = new Map();
     var scaleByName = new Map();
     var isFocusFactByDateKey = new Map();
-    var dateYearEnd = new Date(reportFocus.dateReport);
-    var offsetByFiscalPeriod = { Q1: 9, Q2: 6, Q3: 3, Q4: 0, FY: 0 };
-    dateYearEnd.setMonth(dateYearEnd.getMonth() + ((_h = offsetByFiscalPeriod[reportFocus.fiscalPeriod]) !== null && _h !== void 0 ? _h : 0));
+    var fiscalYearEndMonth = Number(fiscalYearEnd.substring(0, 2));
+    var fiscalYearEndDay = Number(fiscalYearEnd.substring(2));
     var fiscalCalculator = new FactFiscalCalculator_1.default({
         filings: filing ? [filing] : undefined,
         facts: facts,
-        fiscalYearEnd: { day: dateYearEnd.getDate(), month: dateYearEnd.getMonth() + 1 },
+        fiscalYearEnd: { day: fiscalYearEndDay, month: fiscalYearEndMonth },
     });
     var fiscalsByDateKey = new Map();
     for (var _i = 0, facts_1 = facts; _i < facts_1.length; _i++) {
         var fact = facts_1[_i];
         var dateKey = fact.start ? "".concat(fact.start, "_").concat(fact.end) : fact.end;
         if (!fiscalsByDateKey.has(dateKey)) {
-            var _x = fiscalCalculator.getFiscalYearQuarter({ dateStr: fact.end }), quarter = _x.quarter, year = _x.year;
+            var _w = fiscalCalculator.getFiscalYearQuarter({ dateStr: fact.end }), quarter = _w.quarter, year = _w.year;
             var period = FactPeriodResolver_1.default.getPeriod({ end: fact.end, start: fact.start });
             var fiscalPeriod_1 = (period === 12 && quarter === 4 ? 'FY' : "Q".concat(quarter));
             fiscalsByDateKey.set(dateKey, { fiscalYear: year, fiscalPeriod: fiscalPeriod_1 });
         }
         var isSplitFact = fact === splitFact;
-        var isFocusFact = (_j = isFocusFactByDateKey.get(dateKey)) !== null && _j !== void 0 ? _j : (isWithinDays({ dateA: fact.end, dateB: reportFocus.dateReport, days: 45 }) || isSplitFact);
-        (_k = reportByDateRange[dateKey]) !== null && _k !== void 0 ? _k : (reportByDateRange[dateKey] = {
+        var isFocusFact = (_h = isFocusFactByDateKey.get(dateKey)) !== null && _h !== void 0 ? _h : (isWithinDays({ dateA: fact.end, dateB: reportFocus.dateReport, days: 45 }) || isSplitFact);
+        (_j = reportByDateRange[dateKey]) !== null && _j !== void 0 ? _j : (reportByDateRange[dateKey] = {
             cik: reportFocus.cik,
             url: '',
-            splitDate: (_l = splitFact === null || splitFact === void 0 ? void 0 : splitFact.end) !== null && _l !== void 0 ? _l : null,
+            splitDate: (_k = splitFact === null || splitFact === void 0 ? void 0 : splitFact.end) !== null && _k !== void 0 ? _k : null,
             splitRatio: (splitFact === null || splitFact === void 0 ? void 0 : splitFact.value) ? Number(splitFact.value) : null,
             dateFiled: reportFocus.dateFiled,
             dateReport: fact.end,
-            fiscalPeriod: (_m = fiscalsByDateKey.get(dateKey)) === null || _m === void 0 ? void 0 : _m.fiscalPeriod,
-            startDate: (_o = fact.start) !== null && _o !== void 0 ? _o : '',
+            fiscalPeriod: (_l = fiscalsByDateKey.get(dateKey)) === null || _l === void 0 ? void 0 : _l.fiscalPeriod,
+            startDate: (_m = fact.start) !== null && _m !== void 0 ? _m : '',
             endDate: fact.end,
-            fiscalYear: (_p = fiscalsByDateKey.get(dateKey)) === null || _p === void 0 ? void 0 : _p.fiscalYear,
+            fiscalYear: (_o = fiscalsByDateKey.get(dateKey)) === null || _o === void 0 ? void 0 : _o.fiscalYear,
             period: FactPeriodResolver_1.default.getPeriod({ start: fact.start, end: fact.end }),
             isCurrentPeriod: isFocusFact,
         });
@@ -104,11 +103,11 @@ function buildReportsFromFacts(params) {
             isFocusFactByDateKey.set(dateKey, isFocusFact);
         }
         var el = fact;
-        var scale = Number((_q = el.scale) !== null && _q !== void 0 ? _q : 0) || 0;
-        var decimals = Number((_r = el.decimals) !== null && _r !== void 0 ? _r : 0) || 0;
+        var scale = Number((_p = el.scale) !== null && _p !== void 0 ? _p : 0) || 0;
+        var decimals = Number((_q = el.decimals) !== null && _q !== void 0 ? _q : 0) || 0;
         var suffix = fact.name.includes(pathSeparator)
             ? null
-            : (_s = fact === null || fact === void 0 ? void 0 : fact.segments) === null || _s === void 0 ? void 0 : _s.map(function (_a) {
+            : (_r = fact === null || fact === void 0 ? void 0 : fact.segments) === null || _r === void 0 ? void 0 : _r.map(function (_a) {
                 var dimension = _a.dimension, value = _a.value;
                 return "".concat(dimension).concat(pathSeparator).concat(value);
             }).join(pathSeparator);
@@ -122,8 +121,8 @@ function buildReportsFromFacts(params) {
             var prevRounding = roundPlacesByName.get(prevFactKey);
             var prevScale = scaleByName.get(prevFactKey);
             var prevFact_1 = factByName.get(prevFactKey);
-            var prevUnit = (_u = (_t = prevFact_1 === null || prevFact_1 === void 0 ? void 0 : prevFact_1.unit) === null || _t === void 0 ? void 0 : _t.split('_').pop()) === null || _u === void 0 ? void 0 : _u.toLowerCase();
-            var unit = (_w = (_v = fact.unit) === null || _v === void 0 ? void 0 : _v.split('_').pop()) === null || _w === void 0 ? void 0 : _w.toLowerCase();
+            var prevUnit = (_t = (_s = prevFact_1 === null || prevFact_1 === void 0 ? void 0 : prevFact_1.unit) === null || _s === void 0 ? void 0 : _s.split('_').pop()) === null || _t === void 0 ? void 0 : _t.toLowerCase();
+            var unit = (_v = (_u = fact.unit) === null || _u === void 0 ? void 0 : _u.split('_').pop()) === null || _v === void 0 ? void 0 : _v.toLowerCase();
             var shouldSkip = [
                 (prevUnit === null || prevUnit === void 0 ? void 0 : prevUnit.length) === 3 && (unit === null || unit === void 0 ? void 0 : unit.length) === 3 && prevUnit !== unit && prevUnit === 'usd',
                 (prevRounding !== null && prevRounding !== void 0 ? prevRounding : 0) < roundPlaces,
@@ -212,6 +211,7 @@ function parseXbrl(params) {
         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,
+        fiscalYearEnd: response.header.fiscalYearEnd,
         filing: {
             acceptanceDateTime: response.header.acceptanceDatetime,
             accessionNumber: accessionNumber,
@@ -231,6 +231,8 @@ function parseXbrl(params) {
             urlPrimaryDocument: '',
         },
     }), factsFiltered = _t.factsFiltered, reportFocus = _t.reportFocus, reportByDateRange = _t.reportByDateRange;
-    return __assign(__assign({}, response), { fiscalYear: fiscalYear, fiscalPeriod: fiscalPeriod, facts: factsFiltered, report: factsFiltered.length > 0 ? reportFocus : null, xml: xml, periodReports: Object.values(reportByDateRange) });
+    // Some concepts have members, but do not have a sum. add the sum to the report.
+    var periodReports = Object.values(reportByDateRange);
+    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/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.10",
+    "version": "0.5.12",
     "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)",