sec-edgar-api 0.5.8 → 0.5.10

package/build/services/DocumentParser/parsers/parse-xbrl.d.ts

@@ -1,4 +1,4 @@
-import type { FactItemExtended, ReportRaw, XMLParams } from '../../../types';
+import type { FactItemExtended, FiscalPeriod, ReportRaw, XMLParams } from '../../../types';
 import { GetDocumentXbrlParams } from '../../SecEdgarApi';
 import { XbrlParseResult } from '../XBRLParser/XBRLParser';
 interface ReportWithPeriod extends ReportRaw {
@@ -9,6 +9,8 @@ interface ReportWithPeriod extends ReportRaw {
 }
 export interface DocumentXbrlResult extends XbrlParseResult {
     report: ReportRaw | null;
+    fiscalYear: number;
+    fiscalPeriod: FiscalPeriod;
     facts: FactItemExtended[];
     xml: string;
     /** Facts grouped into reports by their start and end dates */

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

@@ -106,10 +106,12 @@ function buildReportsFromFacts(params) {
         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 suffix = (_s = fact === null || fact === void 0 ? void 0 : fact.segments) === null || _s === void 0 ? void 0 : _s.map(function (_a) {
-            var dimension = _a.dimension, value = _a.value;
-            return "".concat(dimension).concat(pathSeparator).concat(value);
-        }).join(pathSeparator);
+        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) {
+                var dimension = _a.dimension, value = _a.value;
+                return "".concat(dimension).concat(pathSeparator).concat(value);
+            }).join(pathSeparator);
         var nameKey = suffix ? "".concat(fact.name).concat(pathSeparator).concat(suffix) : fact.name;
         var roundPlaces = scale + decimals;
         var prevFactKey = "".concat(nameKey, "-").concat(dateKey);
@@ -148,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;
     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, _o = params.includeReport, includeReport = _o === void 0 ? true : _o, 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 _p = (_b = (_a = response.instance) === null || _a === void 0 ? void 0 : _a.xbrl) !== null && _b !== void 0 ? _b : {}, _q = _p.contexts, contexts = _q === void 0 ? [] : _q, _r = _p.factElements, factElements = _r === void 0 ? [] : _r;
     var contextById = new Map();
     contexts.forEach(function (context) { return contextById.set(context.id, context); });
     var cik = response.header.cik;
@@ -184,12 +186,31 @@ function parseXbrl(params) {
         }
         facts.push(factParsed);
     }
+    var fiscalPeriodFact = facts.find(function (f) { return f.name === 'dei:DocumentFiscalPeriodFocus'; });
+    var fiscalYearFact = facts.find(function (f) { return f.name === 'dei:DocumentFiscalYearFocus'; });
+    var fiscalYear = fiscalYearFact ? Number(fiscalYearFact.value) : 0;
+    var fiscalPeriod = fiscalPeriodFact ? fiscalPeriodFact.value : 'FY';
+    if (!fiscalPeriodFact || !fiscalYearFact) {
+        var fiscalCalculator = new FactFiscalCalculator_1.default({
+            fiscalYearEnd: {
+                day: Number(response.header.fiscalYearEnd.substring(2)),
+                month: Number(response.header.fiscalYearEnd.substring(0, 2)),
+            },
+        });
+        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 _s = fiscalCalculator.getFiscalYearQuarter({ dateStr: reportDate !== null && reportDate !== void 0 ? reportDate : '' }), quarter = _s.quarter, year = _s.year;
+        fiscalYear = year;
+        fiscalPeriod = (quarter === 4 ? 'FY' : "Q".concat(quarter));
+    }
     var factsForBuilder = includeReport ? facts : [];
-    var _p = buildReportsFromFacts({
+    var _t = 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,
@@ -209,7 +230,7 @@ function parseXbrl(params) {
             url: "https://www.sec.gov/Archives/edgar/data/".concat(cik, "/").concat(accessionNumberNoHyphens, "/").concat(accessionNumber, ".txt"),
             urlPrimaryDocument: '',
         },
-    }), factsFiltered = _p.factsFiltered, reportFocus = _p.reportFocus, reportByDateRange = _p.reportByDateRange;
-    return __assign(__assign({}, response), { facts: factsFiltered, report: factsFiltered.length > 0 ? reportFocus : null, xml: xml, periodReports: Object.values(reportByDateRange) });
+    }), 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) });
 }
 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/package.json

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