sec-edgar-api 0.5.1 → 0.5.2

package/build/services/DocumentParser/DocumentParser.d.ts

@@ -2,6 +2,7 @@ import { XMLParams } from '../../types';
 import { GetDocumentXbrlParams } from '../SecEdgarApi';
 import XMLParser from './XMLParserLegacy';
 import parsers from './parsers';
+import { DocumentXbrlResult } from './parsers/parse-xbrl';
 interface DocumentParserArgs {
     parser?: XMLParser;
     parsersByName?: typeof parsers;
@@ -36,10 +37,6 @@ export default class DocumentParser {
     };
     parseCurrentFilings(params: XMLParams): import("../../types").CurrentFilingsList;
     parseCurrentFilingsXbrl(params: XMLParams): import("../../types").CurrentFilingsXBRL;
-    parseXbrl(params: XMLParams & GetDocumentXbrlParams): import("./XBRLParser/XBRLParser").XbrlParseResult & {
-        report: import("../../types").ReportRaw | null;
-        facts: import("../../types").FactItemExtended[];
-        xml: string;
-    };
+    parseXbrl(params: XMLParams & GetDocumentXbrlParams): DocumentXbrlResult;
 }
 export {};

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

@@ -1,8 +1,9 @@
 import type { FactItemExtended, ReportRaw, XMLParams } from '../../../types';
 import { GetDocumentXbrlParams } from '../../SecEdgarApi';
 import { XbrlParseResult } from '../XBRLParser/XBRLParser';
-export declare function parseXbrl(params: XMLParams & GetDocumentXbrlParams): XbrlParseResult & {
+export interface DocumentXbrlResult extends XbrlParseResult {
     report: ReportRaw | null;
     facts: FactItemExtended[];
     xml: string;
-};
+}
+export declare function parseXbrl(params: XMLParams & GetDocumentXbrlParams): DocumentXbrlResult;

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

@@ -31,10 +31,10 @@ export default class ReportParser {
     /**
      * Same as parseReports but accepts ReportRaw[] instead of CompanyFactListData
      */
-    parseReportsFromRaw<T = ReportTranslated>(params: {
-        reportsRaw: ReportRaw[];
+    translateReport<T = ReportTranslated>(params: {
+        report: ReportRaw;
         calculationMap?: CalculationMap<T>;
-    }): (ReportRaw & T)[];
+    }): ReportRaw & T;
     /**
      * Parse raw reports
      *
@@ -48,6 +48,8 @@ export default class ReportParser {
      */
     buildReports(params: BuildReportsParams): ReportRaw[];
     /**
+     * @deprecated use translateReport
+     *
      * Translate ReportRaw to ReportTranslated by default, but can be used to translate to any object using both the callback and keyTranslator
      *
      * @param reportsRaw this is the output of parseReportsRaw

package/build/services/ReportParser/ReportParser.js

@@ -53,31 +53,32 @@ var ReportParser = /** @class */ (function () {
     /**
      * Same as parseReports but accepts ReportRaw[] instead of CompanyFactListData
      */
-    ReportParser.prototype.parseReportsFromRaw = function (params) {
-        var reportsRaw = params.reportsRaw, calculationMap = params.calculationMap;
+    ReportParser.prototype.translateReport = function (params) {
+        var _a;
+        var report = params.report, calculationMap = params.calculationMap;
         var calcMap = calculationMap !== null && calculationMap !== void 0 ? calculationMap : this.defaultCalculationMap;
-        return reportsRaw.map(function (report) {
-            var _a;
-            var reportNew = {
-                cik: report.cik,
-                dateFiled: report.dateFiled,
-                dateReport: report.dateReport,
-                fiscalPeriod: report.fiscalPeriod,
-                url: report.url,
-                fiscalYear: report.fiscalYear,
-                splitDate: report.splitDate,
-                splitRatio: report.splitRatio,
-            };
-            var reportResolvable = new ReportResolvable_1.default({
-                report: report,
-                calculationMap: calcMap,
-            });
-            for (var key in calcMap) {
-                var value = (_a = reportResolvable.get(key)) !== null && _a !== void 0 ? _a : null;
+        var reportNew = {
+            cik: report.cik,
+            dateFiled: report.dateFiled,
+            dateReport: report.dateReport,
+            fiscalPeriod: report.fiscalPeriod,
+            url: report.url,
+            fiscalYear: report.fiscalYear,
+            splitDate: report.splitDate,
+            splitRatio: report.splitRatio,
+        };
+        var reportResolvable = new ReportResolvable_1.default({
+            report: report,
+            calculationMap: calcMap,
+        });
+        for (var key in calcMap) {
+            var value = (_a = reportResolvable.get(key)) !== null && _a !== void 0 ? _a : null;
+            // use first truthy value
+            if (!reportNew[key]) {
                 reportNew[key] = value;
             }
-            return reportNew;
-        });
+        }
+        return reportNew;
     };
     /**
      * Parse raw reports
@@ -96,6 +97,8 @@ var ReportParser = /** @class */ (function () {
         return this.reportBuilder.buildReports(params);
     };
     /**
+     * @deprecated use translateReport
+     *
      * Translate ReportRaw to ReportTranslated by default, but can be used to translate to any object using both the callback and keyTranslator
      *
      * @param reportsRaw this is the output of parseReportsRaw

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

@@ -22,9 +22,7 @@ export default class FactFiscalCalculator {
         facts?: Pick<FactItem, 'end' | 'filed'>[];
         filings?: Pick<FilingListItemTranslated, 'form' | 'reportDate' | 'filingDate' | 'accessionNumber'>[];
     });
-    useFilingsForDates(params: {
-        filings: Pick<FilingListItemTranslated, 'form' | 'reportDate' | 'filingDate' | 'accessionNumber'>[];
-    }): void;
+    private useFilingsForDates;
     add(fact: {
         end: string;
         filed: string;

package/build/services/ReportRawBuilder/FactFiscalCalculator.js

@@ -15,9 +15,7 @@ var FactFiscalCalculator = /** @class */ (function () {
         this.filedDateCountByEndDate = new Map();
         this.didResolve = false;
         var _a = params !== null && params !== void 0 ? params : {}, _b = _a.facts, facts = _b === void 0 ? [] : _b, _c = _a.filings, filings = _c === void 0 ? [] : _c;
-        if (filings.length > 0) {
-            this.useFilingsForDates({ filings: filings });
-        }
+        this.useFilingsForDates({ filings: filings });
         facts.forEach(function (fact) { return _this.add(fact); });
     }
     FactFiscalCalculator.prototype.useFilingsForDates = function (params) {

package/build/services/ReportRawBuilder/FactPeriodResolver.js

@@ -197,20 +197,9 @@ var FactPeriodResolver = /** @class */ (function () {
         var _this = this;
         this.propertiesByYear.forEach(function (properties, year) {
             properties.forEach(function (propertyName) {
-                var _a, _b;
+                var _a;
                 for (var i = 0; i < 4; i++) {
                     var bucketSum = (_a = _this.sumByQuarterByPropertyByYear.get(year)) === null || _a === void 0 ? void 0 : _a.get(propertyName);
-                    var bucketQuarter = _this.getOrSetBucketArr(_this.valueByQuarterByPropertyByYear, year, propertyName);
-                    if (bucketSum && !bucketSum.has(i)) {
-                        var prevSum = 0;
-                        var quarterSum = 0;
-                        for (var j = 0; j < i; j++) {
-                            prevSum = quarterSum;
-                            quarterSum = (_b = bucketSum.get(j)) !== null && _b !== void 0 ? _b : quarterSum;
-                        }
-                        bucketSum.set(i, quarterSum);
-                        bucketQuarter.set(i, quarterSum - prevSum);
-                    }
                     var value = bucketSum === null || bucketSum === void 0 ? void 0 : bucketSum.get(i);
                     if (value === undefined)
                         continue;

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

@@ -1,18 +1,22 @@
-import type { CompanyFactListData, FactGroup, FactItem, ReportRaw, SplitData } from '../../types';
-import FactFiscalCalculator, { SetReportDatesParams } from './FactFiscalCalculator';
+import type { CompanyFactListData, FactGroup, FactItem, FilingListItemTranslated, ReportRaw, SplitData } from '../../types';
+import FactFiscalCalculator from './FactFiscalCalculator';
 export interface BuildReportsParams {
     facts: FactItem[];
     /**
      * for more accurate dates, add this. Otherwise, dates will be inferred
      * using the fact periods. The filing and report dates can be found in the SubmissionList (segEdgarApi.getSubmissions)
      */
-    reportDates?: SetReportDatesParams[];
+    filings?: Pick<FilingListItemTranslated, 'form' | 'reportDate' | 'filingDate' | 'accessionNumber'>[];
     /**
      * Splits will be extracted from facts if not provided.
      */
     splits?: SplitData[];
     resolvePeriodValues?: boolean;
     adjustForSplits?: boolean;
+    /**
+     * For member facts (facts with segments), the separator between the fact name and the segments.
+     */
+    pathSeparatorForMemberFacts?: string;
 }
 /**
  * Builds ReportRaw objects from company facts. Adjusts for splits and resolves period values.
@@ -22,7 +26,7 @@ export default class ReportRawBuilder {
     createFacts(companyFacts: CompanyFactListData, includeNamePrefix?: boolean): {
         facts: FactItem[];
     };
-    private createFiscalCalculator;
+    private getFactKey;
     buildReports(params: BuildReportsParams): ReportRaw[];
     private createReportKey;
     private createReport;

package/build/services/ReportRawBuilder/ReportRawBuilder.js

@@ -1,5 +1,17 @@
 "use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+var constants_1 = require("../../util/constants");
 var FactFiscalCalculator_1 = require("./FactFiscalCalculator");
 var FactGrouper_1 = require("./FactGrouper");
 var FactRecordBuilder_1 = require("./FactRecordBuilder");
@@ -15,43 +27,49 @@ var ReportRawBuilder = /** @class */ (function () {
         if (includeNamePrefix === void 0) { includeNamePrefix = false; }
         return this.factRecordBuilder.createFacts(companyFacts, includeNamePrefix);
     };
-    ReportRawBuilder.prototype.createFiscalCalculator = function (params) {
-        var facts = params.facts;
-        var fiscalCalculator = new FactFiscalCalculator_1.default();
-        for (var _i = 0, facts_1 = facts; _i < facts_1.length; _i++) {
-            var fact = facts_1[_i];
-            fiscalCalculator.add(fact);
-        }
-        return fiscalCalculator;
+    ReportRawBuilder.prototype.getFactKey = function (fact, pathSeparator) {
+        var _a;
+        var suffix = (_a = fact.segments) === null || _a === void 0 ? void 0 : _a.map(function (_a) {
+            var dimension = _a.dimension, value = _a.value;
+            return "".concat(dimension).concat(pathSeparator).concat(value);
+        }).join(pathSeparator);
+        return suffix ? "".concat(fact.name).concat(pathSeparator).concat(suffix) : fact.name;
     };
     ReportRawBuilder.prototype.buildReports = function (params) {
-        var facts = params.facts, reportDates = params.reportDates, splitsProp = params.splits, _a = params.resolvePeriodValues, resolvePeriodValues = _a === void 0 ? true : _a, _b = params.adjustForSplits, adjustForSplits = _b === void 0 ? true : _b;
+        var _this = this;
+        var factsProp = params.facts, filings = params.filings, splitsProp = params.splits, _a = params.resolvePeriodValues, resolvePeriodValues = _a === void 0 ? true : _a, _b = params.adjustForSplits, adjustForSplits = _b === void 0 ? true : _b, _c = params.pathSeparatorForMemberFacts, pathSeparatorForMemberFacts = _c === void 0 ? '>' : _c;
+        // Rename member facts to prevent overwriting parent facts.
+        var facts = factsProp.map(function (fact) {
+            var factKey = _this.getFactKey(fact, pathSeparatorForMemberFacts);
+            return __assign(__assign({}, fact), { name: factKey });
+        });
         if (facts.length === 0) {
             return [];
         }
+        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); }),
+            facts: facts,
+        });
         var accessionByYearQuarter = new Map();
-        reportDates === null || reportDates === void 0 ? void 0 : reportDates.forEach(function (params) {
-            var year = params.year, quarter = params.quarter, accn = params.accn;
-            if (accn)
-                accessionByYearQuarter.set("".concat(year, "_").concat(quarter), accn);
+        filings === null || filings === void 0 ? void 0 : filings.forEach(function (f) {
+            var _a = fiscalCalculator.getFiscalYearQuarter({ dateStr: f.reportDate }), year = _a.year, quarter = _a.quarter;
+            accessionByYearQuarter.set(f.accessionNumber, "".concat(year, "_").concat(quarter));
         });
-        var reportsCik = Number(facts[0].cik);
-        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
         var splits = adjustForSplits
             ? splitsProp !== null && splitsProp !== void 0 ? splitsProp : factSplitAdjuster.getSplits({ splitFacts: factSplitAdjuster.filterSplitFacts({ facts: facts }) })
             : splitsProp;
-        var _c = factGrouper.buildFactGroupsByReportKey({
+        var _d = factGrouper.buildFactGroupsByReportKey({
             facts: facts,
             cik: reportsCik,
             fiscalCalculator: fiscalCalculator,
             resolvePeriodValues: resolvePeriodValues,
             generateMissingGroups: false,
             splits: splits,
-        }), factGroupsByReportKey = _c.factGroupsByReportKey, maxYear = _c.maxYear, minYear = _c.minYear;
+        }), factGroupsByReportKey = _d.factGroupsByReportKey, maxYear = _d.maxYear, minYear = _d.minYear;
         return this.buildReportsFromGroups({
             factGroupsByReportKey: factGroupsByReportKey,
             fiscalCalculator: fiscalCalculator,

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

@@ -231,11 +231,7 @@ export default class SecEdgarApi {
      *
      * Use "include" params to specify what to parse. If not provided, all data is parsed.
      */
-    getDocumentXbrl(params: GetDocumentXbrlParams): Promise<import("../DocumentParser/XBRLParser/XBRLParser").XbrlParseResult & {
-        report: ReportRaw | null;
-        facts: import("../../types").FactItemExtended[];
-        xml: string;
-    }>;
+    getDocumentXbrl(params: GetDocumentXbrlParams): Promise<import("../DocumentParser/parsers/parse-xbrl").DocumentXbrlResult>;
     /**
      * Builds a url for a document. If fileName is not provided, it defaults to `${accessionNumber}.txt`
      *

package/build/services/SecEdgarApi/SecEdgarApi.js

@@ -302,17 +302,17 @@ var SecEdgarApi = /** @class */ (function () {
      */
     SecEdgarApi.prototype.getReports = function (params) {
         return __awaiter(this, void 0, void 0, function () {
-            var calculationMap, reportsRaw;
+            var calculationMap, reports;
+            var _this = this;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
                         calculationMap = params.calculationMap;
                         return [4 /*yield*/, this.getReportsRaw(__assign(__assign({}, params), { includeNamePrefix: true }))];
                     case 1:
-                        reportsRaw = _a.sent();
-                        return [2 /*return*/, this.reportParser.parseReportsFromRaw({
-                                reportsRaw: reportsRaw,
-                                calculationMap: calculationMap,
+                        reports = _a.sent();
+                        return [2 /*return*/, reports.map(function (report) {
+                                return _this.reportParser.translateReport({ report: report, calculationMap: calculationMap });
                             })];
                 }
             });

package/build/util/constants.d.ts

@@ -1,2 +1,4 @@
 declare const KEY_SPLIT = "StockholdersEquityNoteStockSplitConversionRatio1";
-export { KEY_SPLIT };
+declare const FORMS_EARNINGS: string[];
+declare const FORMS_EARNINGS_ANNUAL: string[];
+export { KEY_SPLIT, FORMS_EARNINGS, FORMS_EARNINGS_ANNUAL };

package/build/util/constants.js

@@ -1,5 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.KEY_SPLIT = void 0;
+exports.FORMS_EARNINGS_ANNUAL = exports.FORMS_EARNINGS = exports.KEY_SPLIT = void 0;
 var KEY_SPLIT = 'StockholdersEquityNoteStockSplitConversionRatio1';
 exports.KEY_SPLIT = KEY_SPLIT;
+var FORMS_EARNINGS = ['10-Q', '10-K', '20-F', '40-F'];
+exports.FORMS_EARNINGS = FORMS_EARNINGS;
+var FORMS_EARNINGS_ANNUAL = ['10-K', '20-F', '40-F'];
+exports.FORMS_EARNINGS_ANNUAL = FORMS_EARNINGS_ANNUAL;

package/build/util/key-translations.d.ts

@@ -1,5 +1,7 @@
 import type { ReportTranslated } from '../types/report-translated.type';
 /**
+ * @deprecated use calculationMap for ReportResolvable
+ *
  * Checks if any of the array keys exist in the object to assign to the translated key
  * These were checked against Yahoo Finance values, adding the ones that most often matched the yahoo values
  */

package/build/util/key-translations.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 /**
+ * @deprecated use calculationMap for ReportResolvable
+ *
  * Checks if any of the array keys exist in the object to assign to the translated key
  * These were checked against Yahoo Finance values, adding the ones that most often matched the yahoo values
  */

package/package.json

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