sec-edgar-api 0.2.1 → 0.2.3

package/build/services/ReportParser/ReportParser.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 var key_translations_1 = require("../../util/key-translations");
+var ReportRawResolvable_1 = require("../ReportBuilder/ReportRawResolvable");
 var PropertyResolver_1 = require("./PropertyResolver");
 var ReportRawParser_1 = require("./ReportRawParser");
 var ReportWrapper_1 = require("./ReportWrapper");
@@ -23,9 +24,7 @@ var ReportParser = /** @class */ (function () {
      */
     ReportParser.prototype.parseReports = function (companyFactListData, usePropertyResolver) {
         if (usePropertyResolver === void 0) { usePropertyResolver = true; }
-        var reportsRaw = this.reportRawParser.parseReports(companyFactListData, {
-            reportsToInclude: ['ANNUAL', 'QUARTERLY'],
-        });
+        var reportsRaw = this.reportRawParser.parseReports(companyFactListData);
         return this.parseReportsFromRaw(reportsRaw, usePropertyResolver);
     };
     /**
@@ -34,9 +33,7 @@ var ReportParser = /** @class */ (function () {
     ReportParser.prototype.parseReportsFromRaw = function (reportsRaw, usePropertyResolver) {
         if (usePropertyResolver === void 0) { usePropertyResolver = true; }
         var reportByYearQuarter = new Map();
-        var reportsRawFiltered = reportsRaw.filter(function (reportRaw) {
-            return reportRaw.reportType === 'ANNUAL' || reportRaw.reportType === 'QUARTERLY';
-        });
+        var reportsRawFiltered = reportsRaw;
         this.translateReportsRaw(reportsRawFiltered, function (report, reportRaw) {
             var fiscalPeriod = report.fiscalPeriod, fiscalYear = report.fiscalYear;
             var keyReport = "".concat(fiscalYear, "_").concat(fiscalPeriod);
@@ -54,36 +51,25 @@ var ReportParser = /** @class */ (function () {
      *
      * @see https://www.sec.gov/edgar/sec-api-documentation
      */
-    ReportParser.prototype.parseReportsRaw = function (companyFactListData, options) {
-        return this.reportRawParser.parseReports(companyFactListData, options);
+    ReportParser.prototype.parseReportsRaw = function (companyFactListData) {
+        return this.reportRawParser.parseReports(companyFactListData);
     };
     /**
      * parseReportsRaw but removes meta data from the report
      */
-    ReportParser.prototype.parseReportsRawNoMeta = function (companyFactListData, options) {
-        var reportsRaw = this.parseReportsRaw(companyFactListData, options);
+    ReportParser.prototype.parseReportsRawNoMeta = function (companyFactListData) {
+        var reportsRaw = this.parseReportsRaw(companyFactListData);
         reportsRaw.forEach(function (reportRaw) {
             var report = reportRaw;
             delete report.dateFiled;
             delete report.dateReport;
             delete report.fiscalPeriod;
             delete report.fiscalYear;
-            delete report.form;
-            delete report.frame;
-            delete report.isTTM;
-            delete report.reportType;
-            delete report.taxonomy;
+            delete report.splitRatio;
+            delete report.splitDate;
         });
         return reportsRaw;
     };
-    /**
-     * Avoids deep nesting logic while iteratating through company facts
-     *
-     * @param callback called on each company fact.
-     */
-    ReportParser.prototype.iterateCompanyFacts = function (companyFactListData, callback) {
-        this.reportRawParser.iterateCompanyFacts(companyFactListData, callback);
-    };
     /**
      * Translate ReportRaw to ReportTranslated by default, but can be used to translate to any object using both the callback and keyTranslator
      *
@@ -94,22 +80,24 @@ var ReportParser = /** @class */ (function () {
     ReportParser.prototype.translateReportsRaw = function (reportsRaw, callback, keyTranslator) {
         var keyTranslations = (keyTranslator !== null && keyTranslator !== void 0 ? keyTranslator : this.keyTranslator);
         var reports = [];
-        reportsRaw.forEach(function (reportRaw) {
+        reportsRaw.forEach(function (report) {
             var reportNew = {};
+            var reportRaw = new ReportRawResolvable_1.default(report);
             // iterate translation keys, ensuring same order and priority
             for (var key in keyTranslations) {
                 var keysRaw = keyTranslations[key];
                 reportNew[key] = null;
                 for (var _i = 0, keysRaw_1 = keysRaw; _i < keysRaw_1.length; _i++) {
                     var keyRaw = keysRaw_1[_i];
-                    if (reportRaw[keyRaw] === undefined)
+                    var value = reportRaw.get(keyRaw);
+                    if (value === undefined)
                         continue;
-                    reportNew[key] = reportRaw[keyRaw];
+                    reportNew[key] = value;
                     break;
                 }
             }
             var reportFiltered = callback
-                ? callback(reportNew, reportRaw, keyTranslations)
+                ? callback(reportNew, reportRaw.report, keyTranslations)
                 : reportNew;
             reports.push(reportFiltered);
         });

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

@@ -1,34 +1,5 @@
-import { CompanyFactListData } from '../../types/company-facts.type';
-import { ReportRaw, ReportType } from '../../types/report-raw.type';
-import FactIterator, { IterateFactsCallbackData } from './FactIterator';
-interface ReportRawParserArgs {
-    factIterator?: FactIterator;
-}
-export interface ParseReportsOptions {
-    /**
-     * Instantaneous data may be filed later than the original filing date.
-     * It is flagged by "I" at the end of the frame property. defaults to true. see https://www.sec.gov/edgar/sec-api-documentation
-     * */
-    mergeInstantaneousData?: boolean;
-    reportsToInclude?: ReportType | ReportType[] | null;
-}
-/**
- * @see https://www.sec.gov/edgar/sec-api-documentation
- */
+import { CompanyFactListData } from '../../types';
 export default class ReportRawParser {
-    private readonly factIterator;
-    constructor(args?: ReportRawParserArgs);
-    /**
-     * Avoids deep nesting logic while iteratating through company facts
-     *
-     * @param callback called on each company fact.
-     */
-    iterateCompanyFacts(companyFactListData: Pick<CompanyFactListData, 'facts'>, callback: (data: IterateFactsCallbackData) => void): void;
-    /**
-     * Returns raw reports in ascending order by report date. if date is the same, priority is filed date, frame, form
-     */
-    parseReports(companyFactListData: Pick<CompanyFactListData, 'facts'>, options?: ParseReportsOptions): ReportRaw[];
-    private getReportType;
-    private getFiscalYear;
+    private readonly reportBuilder;
+    parseReports(companyFactListData: CompanyFactListData): import("../../types").ReportRaw[];
 }
-export {};

package/build/services/ReportParser/ReportRawParser.js

@@ -1,153 +1,13 @@
 "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 FactIterator_1 = require("./FactIterator");
-/**
- * @see https://www.sec.gov/edgar/sec-api-documentation
- */
+var ReportBuilder_1 = require("../ReportBuilder");
 var ReportRawParser = /** @class */ (function () {
-    function ReportRawParser(args) {
-        var _a = (args !== null && args !== void 0 ? args : {}).factIterator, factIterator = _a === void 0 ? new FactIterator_1.default() : _a;
-        this.factIterator = factIterator;
+    function ReportRawParser() {
+        this.reportBuilder = new ReportBuilder_1.default();
     }
-    /**
-     * Avoids deep nesting logic while iteratating through company facts
-     *
-     * @param callback called on each company fact.
-     */
-    ReportRawParser.prototype.iterateCompanyFacts = function (companyFactListData, callback) {
-        this.factIterator.iterateCompanyFacts(companyFactListData, callback);
-    };
-    /**
-     * Returns raw reports in ascending order by report date. if date is the same, priority is filed date, frame, form
-     */
-    ReportRawParser.prototype.parseReports = function (companyFactListData, options) {
-        var _this = this;
-        var _a = options !== null && options !== void 0 ? options : {}, reportsToInclude = _a.reportsToInclude, mergeInstantaneousData = _a.mergeInstantaneousData;
-        // default to all report types
-        var reportsToIncludeSet = reportsToInclude
-            ? new Set(Array.isArray(reportsToInclude) ? reportsToInclude : [reportsToInclude])
-            : null;
-        // for getting the earliest filed date for each report
-        var datesFiledByDateForm = new Map();
-        // for mapping individual properties to the report
-        var reportsByKey = new Map();
-        // fiscal period only provided for filed date, used to map to later assign for quarter end date
-        var monthsFiledByFiscalPeriod = new Map();
-        // iterate individual properties AKA "facts"
-        this.iterateCompanyFacts(companyFactListData, function (_a) {
-            var _b, _c, _d, _e, _f, _g, _h;
-            var factValue = _a.factValue, propertyName = _a.propertyName, taxonomy = _a.taxonomy;
-            var filed = factValue.filed, val = factValue.val, form = factValue.form, fp = factValue.fp, dateReport = factValue.end;
-            // get frame for keys and to merge instantaneous data
-            var isInstantaneousData = (_c = (_b = factValue.frame) === null || _b === void 0 ? void 0 : _b.endsWith('I')) !== null && _c !== void 0 ? _c : false;
-            var isMergableFrame = (mergeInstantaneousData !== null && mergeInstantaneousData !== void 0 ? mergeInstantaneousData : true) && isInstantaneousData;
-            var frame = isMergableFrame ? (_d = factValue.frame) === null || _d === void 0 ? void 0 : _d.substring(0, factValue.frame.length - 1) : factValue.frame;
-            // keys to map report and file dates
-            var keyDateForm = "".concat(dateReport, "_").concat(form);
-            var keyReport = "".concat(frame, "_").concat(keyDateForm);
-            // set earliest date filed
-            var dateFiledPrev = (_e = datesFiledByDateForm.get(keyDateForm)) !== null && _e !== void 0 ? _e : filed;
-            var dateFiled = filed < dateFiledPrev ? filed : dateFiledPrev;
-            datesFiledByDateForm.set(keyDateForm, dateFiled);
-            // if frame is undefined, the value is no longer the most recent
-            if (!frame)
-                return;
-            var isTTM = frame.substring(6, 8).length !== 2;
-            var reportType = _this.getReportType({ form: form, taxonomy: taxonomy, isTTM: isTTM });
-            var isReportToInclude = (_f = reportsToIncludeSet === null || reportsToIncludeSet === void 0 ? void 0 : reportsToIncludeSet.has(reportType)) !== null && _f !== void 0 ? _f : true;
-            if (!isReportToInclude)
-                return;
-            // set the month filed, will be used to get the fiscal period and year
-            if (reportType === 'QUARTERLY' || reportType === 'ANNUAL') {
-                var monthFiled = Number(filed.substring(5, 7));
-                monthsFiledByFiscalPeriod.set(fp, ((_g = monthsFiledByFiscalPeriod.get(fp)) !== null && _g !== void 0 ? _g : new Set()).add(monthFiled));
-            }
-            var report = (_h = reportsByKey.get(keyReport)) !== null && _h !== void 0 ? _h : {
-                dateReport: dateReport,
-                dateFiled: dateFiled,
-                form: form,
-                isTTM: isTTM,
-                frame: frame,
-                taxonomy: taxonomy,
-                reportType: reportType,
-                // these will be updated
-                fiscalPeriod: 'FY',
-                fiscalYear: 0,
-            };
-            reportsByKey.set(keyReport, report);
-            // update earliest date filed
-            report.dateFiled = dateFiled;
-            report[propertyName] = val;
-        });
-        // end date is typically the month before the filed date, so subtract 1, set to 12 if 0
-        var fiscalPeriodsByMonth = new Map();
-        monthsFiledByFiscalPeriod.forEach(function (monthsSet, fiscalPeriod) {
-            monthsSet.forEach(function (month) { return fiscalPeriodsByMonth.set(month - 1 || 12, fiscalPeriod); });
-        });
-        // set fiscal period and year, then merge by year_quarter, because some reports have end dates a couple days apart
-        var reportsByYearPeriod = new Map();
-        reportsByKey.forEach(function (report) {
-            var _a;
-            var dateReport = report.dateReport, reportType = report.reportType;
-            var monthReport = Number(dateReport.substring(5, 7));
-            var fiscalPeriod = (_a = fiscalPeriodsByMonth.get(monthReport)) !== null && _a !== void 0 ? _a : 'FY';
-            // Q4 is always FY, so needs to be changed to Q4 (comes from fp property in fact)
-            report.fiscalPeriod = reportType === 'QUARTERLY' && fiscalPeriod === 'FY' ? 'Q4' : fiscalPeriod;
-            report.fiscalYear = _this.getFiscalYear({ dateReport: dateReport, reportType: reportType, fiscalPeriod: report.fiscalPeriod });
-            var keyReport = "".concat(report.fiscalYear, "_").concat(report.fiscalPeriod);
-            var reportPrev = reportsByYearPeriod.get(keyReport);
-            // if a report was already assigned to this key, merge and use the latest dateReport
-            if (reportPrev) {
-                var dateReport_1 = report.dateReport > reportPrev.dateReport ? report.dateReport : reportPrev.dateReport;
-                reportPrev.dateReport = dateReport_1;
-                reportsByYearPeriod.set(keyReport, __assign(__assign({}, reportPrev), report));
-            }
-            else {
-                reportsByYearPeriod.set(keyReport, report);
-            }
-        });
-        // return in ascending order by date report, date filed, frame, form
-        return Array.from(reportsByYearPeriod.values()).sort(function (a, b) {
-            var keyA = "".concat(a.fiscalYear, "_").concat(a.isTTM ? 'Q5' : a.fiscalPeriod, "_").concat(a.dateReport, "_").concat(a.dateFiled);
-            var keyB = "".concat(b.fiscalYear, "_").concat(b.isTTM ? 'Q5' : b.fiscalPeriod, "_").concat(b.dateReport, "_").concat(b.dateFiled);
-            return keyA > keyB ? 1 : -1;
-        });
-    };
-    ReportRawParser.prototype.getReportType = function (data) {
-        var form = data.form, taxonomy = data.taxonomy, isTTM = data.isTTM;
-        if (form === '8-K')
-            return '8K';
-        else if (taxonomy === 'dei')
-            return 'DOCUMENT_ENTITY_INFO';
-        else if (isTTM)
-            return 'ANNUAL';
-        return 'QUARTERLY';
-    };
-    ReportRawParser.prototype.getFiscalYear = function (data) {
-        var dateReport = data.dateReport, reportType = data.reportType, fiscalPeriod = data.fiscalPeriod;
-        var date = new Date("".concat(dateReport, "T00:00:00"));
-        var day = date.getDate();
-        var month = day < 14 ? date.getMonth() || 12 : date.getMonth() + 1;
-        var year = date.getFullYear();
-        var monthAddMap = {
-            Q1: 9,
-            Q2: 6,
-            Q3: 3,
-            Q4: 0,
-            FY: 0,
-        };
-        return month + monthAddMap[fiscalPeriod] > 12 && reportType === 'QUARTERLY' ? year + 1 : year;
+    ReportRawParser.prototype.parseReports = function (companyFactListData) {
+        var facts = this.reportBuilder.createFacts(companyFactListData).facts;
+        return this.reportBuilder.buildReports({ facts: facts });
     };
     return ReportRawParser;
 }());

package/build/services/ReportParser/ReportWrapper.js

@@ -28,15 +28,14 @@ var ReportWrapper = /** @class */ (function (_super) {
         _this.report = report;
         _this.reportMap = reportMap !== null && reportMap !== void 0 ? reportMap : new Map();
         _this.reportRaw = reportRaw !== null && reportRaw !== void 0 ? reportRaw : {
+            cik: report.cik,
+            url: report.url,
             dateFiled: report.dateFiled,
             dateReport: report.dateReport,
-            form: report.form,
-            isTTM: report.isTTM,
-            frame: '',
-            taxonomy: '',
-            reportType: report.isTTM ? 'ANNUAL' : 'QUARTERLY',
             fiscalPeriod: (_a = report.fiscalPeriod) !== null && _a !== void 0 ? _a : '',
             fiscalYear: report.fiscalYear,
+            splitRatio: null,
+            splitDate: null,
         };
         return _this;
     }

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

@@ -12,6 +12,7 @@ import { resolveFiscalYearCumulativeProperties } from './resolve-fiscal-year-cum
 import { resolveLiabilityCurrent } from './resolve-liability-current';
 import { resolveQ4FiscalYearMatchingProperties } from './resolve-q4-fiscal-year-matching-properties';
 import { resolveRevenueTotal } from './resolve-revenue-total';
+import { resolveSplitRatio } from './resolve-split-ratio';
 declare const resolvers: {
     resolveAssetNonCurrentPPEGross: typeof resolveAssetNonCurrentPPEGross;
     resolveExpenseDepreciation: typeof resolveExpenseDepreciation;
@@ -27,5 +28,6 @@ declare const resolvers: {
     resolveLiabilityCurrent: typeof resolveLiabilityCurrent;
     resolveQ4FiscalYearMatchingProperties: typeof resolveQ4FiscalYearMatchingProperties;
     resolveCashFlowWorkingCapitalNonCash: typeof resolveCashFlowWorkingCapitalNonCash;
+    resolveSplitRatio: typeof resolveSplitRatio;
 };
 export default resolvers;

package/build/services/ReportParser/resolvers/index.js

@@ -14,6 +14,7 @@ var resolve_fiscal_year_cumulative_properties_1 = require("./resolve-fiscal-year
 var resolve_liability_current_1 = require("./resolve-liability-current");
 var resolve_q4_fiscal_year_matching_properties_1 = require("./resolve-q4-fiscal-year-matching-properties");
 var resolve_revenue_total_1 = require("./resolve-revenue-total");
+var resolve_split_ratio_1 = require("./resolve-split-ratio");
 var resolvers = {
     resolveAssetNonCurrentPPEGross: resolve_asset_non_current_ppe_gross_1.resolveAssetNonCurrentPPEGross,
     resolveExpenseDepreciation: resolve_expense_depreciation_1.resolveExpenseDepreciation,
@@ -29,5 +30,6 @@ var resolvers = {
     resolveLiabilityCurrent: resolve_liability_current_1.resolveLiabilityCurrent,
     resolveQ4FiscalYearMatchingProperties: resolve_q4_fiscal_year_matching_properties_1.resolveQ4FiscalYearMatchingProperties,
     resolveCashFlowWorkingCapitalNonCash: resolve_cash_flow_working_capital_non_cash_1.resolveCashFlowWorkingCapitalNonCash,
+    resolveSplitRatio: resolve_split_ratio_1.resolveSplitRatio,
 };
 exports.default = resolvers;

package/build/services/ReportParser/resolvers/resolve-cash-flow-capex.js

@@ -7,9 +7,10 @@ var helpers_1 = require("./helpers");
  */
 function resolveCashFlowCapex(report) {
     var _a, _b, _c;
-    if (report.fiscalYear !== 2022 || report.cashFlowCapex !== null)
+    if (report.cashFlowCapex !== null)
         return;
-    var reportPrev = report.getReportOffset(-1, report.isTTM ? 'ANNUAL' : 'QUARTERLY');
+    var isFY = report.fiscalPeriod === 'FY';
+    var reportPrev = report.getReportOffset(-1, isFY ? 'ANNUAL' : 'QUARTERLY');
     var _d = report.getReportsFiscalYearByPeriod(), FY = _d.FY, Q1 = _d.Q1, Q2 = _d.Q2, Q3 = _d.Q3, Q4 = _d.Q4;
     if (FY === null) {
         report.cashFlowCapex = (_a = reportPrev === null || reportPrev === void 0 ? void 0 : reportPrev.cashFlowCapex) !== null && _a !== void 0 ? _a : null;
@@ -17,7 +18,7 @@ function resolveCashFlowCapex(report) {
     }
     var sumQuarters = [Q1, Q2, Q3, Q4].reduce(function (sum, rep) { var _a; return sum + ((_a = rep === null || rep === void 0 ? void 0 : rep.cashFlowCapex) !== null && _a !== void 0 ? _a : 0); }, 0);
     var reportsQuarterlyWithoutCapex = [Q1, Q2, Q3, Q4].filter(function (rep) { return rep && rep.cashFlowCapex === null; });
-    if (report.isTTM) {
+    if (isFY) {
         if (reportsQuarterlyWithoutCapex.length === 0)
             report.cashFlowCapex = sumQuarters;
         return;

package/build/services/ReportParser/resolvers/resolve-cash-flow-operating.js

@@ -27,7 +27,7 @@ function resolveCashFlowOperating(report) {
 }
 exports.resolveCashFlowOperating = resolveCashFlowOperating;
 function getCashFlowOperating(report) {
-    var reportPrev = report.getReportOffset(-1, report.isTTM ? 'ANNUAL' : 'QUARTERLY');
+    var reportPrev = report.getReportOffset(-1, report.fiscalPeriod === 'FY' ? 'ANNUAL' : 'QUARTERLY');
     if (!reportPrev)
         return null;
     var _a = report, incomeNet = _a.incomeNet, expenseDepreciation = _a.expenseDepreciation, cashFlowWorkingCapitalNonCash = _a.cashFlowWorkingCapitalNonCash;

package/build/services/ReportParser/resolvers/resolve-cash-flow-working-capital-non-cash.js

@@ -6,7 +6,7 @@ function resolveCashFlowWorkingCapitalNonCash(report) {
     if (report.cashFlowWorkingCapitalNonCash !== null)
         return;
     // the previous report is used to calculate the change in working capital in resolveCashFlowOperating
-    var reportWrapperPrev = report.getReportOffset(-1, report.isTTM ? 'ANNUAL' : 'QUARTERLY');
+    var reportWrapperPrev = report.getReportOffset(-1, report.fiscalPeriod === 'FY' ? 'ANNUAL' : 'QUARTERLY');
     var _a = report.getReportsFiscalYearByPeriod(), FY = _a.FY, Q1 = _a.Q1, Q2 = _a.Q2, Q3 = _a.Q3, Q4 = _a.Q4;
     for (var _i = 0, _b = [FY, Q1, Q2, Q3, Q4, reportWrapperPrev]; _i < _b.length; _i++) {
         var report_1 = _b[_i];

package/build/services/ReportParser/resolvers/resolve-expense-depreciation.js

@@ -81,7 +81,7 @@ function getDepreciationPercentOfPPE(report) {
     }
     // if checking depreciation using an annual report, we need to get the sum of the quarters
     var ppeDenominator = assetNonCurrentPPEGrossTTMOrPrev;
-    if (reportTTMOrPrev.isTTM && !report.isTTM) {
+    if (reportTTMOrPrev.fiscalPeriod === 'FY' && report.fiscalPeriod !== 'FY') {
         var _e = reportTTMOrPrev.getReportsFiscalYearByPeriod(), Q1 = _e.Q1, Q2 = _e.Q2, Q3 = _e.Q3, Q4 = _e.Q4;
         ppeDenominator = 0;
         for (var _i = 0, _f = [Q1, Q2, Q3, Q4]; _i < _f.length; _i++) {

package/build/services/ReportParser/resolvers/resolve-fiscal-year-cumulative-properties.js

@@ -12,24 +12,38 @@ function resolveFiscalYearCumulativeProperties(report) {
     matchProperty('assetNonCurrentPPEGross', Q4, FY);
     matchProperty('assetNonCurrentPPENet', Q4, FY);
     matchProperty('expenseDepreciationAccumulated', Q4, FY);
-    // keys that should not add up to the FY value
-    var keysToSkip = new Set([
-        'expenseDepreciationAccumulated',
-        'assetNonCurrentPPEGross',
-        'assetNonCurrentPPENet',
-        'dateFiled',
-        'dateReport',
-        'fiscalPeriod',
-        'fiscalYear',
-        'isTTM',
-        'form',
-        'sharesOutstanding',
-        'sharesOutstandingDiluted',
+    var keysToInclude = new Set([
+        'cashFlowCapex',
+        'cashFlowDeferredTax',
+        'cashFlowDividendsPaid',
+        'cashFlowDividendsPaidPreferred',
+        'cashFlowFree',
+        'cashFlowOperating',
+        'cashFlowWorkingCapitalNonCash',
+        'assetNonCurrentIntangibleLessGoodwill',
+        'expenseDepreciation',
+        'expenseInterest',
+        'expenseNonCashOther',
+        'expenseOperating',
+        'expenseResearchDevelopment',
+        'expenseStockCompensation',
+        'expenseTax',
+        'expenseTotal',
+        'ebit',
+        'ebitda',
+        'eps',
+        'epsDiluted',
+        'incomeNet',
+        'incomeOperating',
+        'profitGross',
+        'revenueCost',
+        'revenueOperating',
+        'revenueTotal',
     ]);
     var reportKeys = Object.keys(Q1);
     var keysToResolve = reportKeys.filter(function (key) {
         var reportsWithVal = [FY, Q1, Q2, Q3, Q4].filter(function (report) {
-            return typeof report[key] === 'number' && !keysToSkip.has(key);
+            return typeof report[key] === 'number' && keysToInclude.has(key);
         });
         // we want to get the keys that are in 4 of the 5 reports
         return reportsWithVal.length === 4;
@@ -48,7 +62,8 @@ function resolveFiscalYearCumulativeProperties(report) {
                 var rep = _c[_b];
                 if (rep && typeof rep[key] !== 'number') {
                     ;
-                    rep[key] = valueFY - sumQuarters;
+                    rep[key] =
+                        Math.round((valueFY - sumQuarters) * 10000) / 10000;
                     break;
                 }
             }

package/build/services/ReportParser/resolvers/resolve-q4-fiscal-year-matching-properties.js

@@ -8,10 +8,38 @@ function resolveQ4FiscalYearMatchingProperties(reportWrapper) {
     var _a = reportWrapper.getReportsFiscalYearByPeriod(), FY = _a.FY, Q1 = _a.Q1, Q2 = _a.Q2, Q3 = _a.Q3, Q4 = _a.Q4;
     if (!FY || !Q1 || !Q2 || !Q3 || !Q4)
         return;
-    // these properties should be the same for Q4 and FY
-    matchProperty('assetNonCurrentPPEGross', Q4, FY);
-    matchProperty('assetNonCurrentPPENet', Q4, FY);
-    matchProperty('expenseDepreciationAccumulated', Q4, FY);
+    var matchingProperties = [
+        'assetCurrent',
+        'assetCurrentAccountsReceivable',
+        'assetCurrentCashEquivalents',
+        'assetCurrentInventory',
+        'assetCurrentInvestments',
+        'assetNonCurrent',
+        'assetNonCurrentGoodwill',
+        'assetNonCurrentIntangibleLessGoodwill',
+        'assetNonCurrentInvestments',
+        'assetNonCurrentPPEGross',
+        'assetNonCurrentPPENet',
+        'assetTotal',
+        'liabilityCurrent',
+        'liabilityCurrentAccountsPayable',
+        'liabilityCurrentDebt',
+        'liabilityNonCurrent',
+        'liabilityNonCurrentDebt',
+        'liabilityTotal',
+        'equityRetainedEarnings',
+        'equityStockPreferred',
+        'equityTotal',
+        'dateFiled',
+        'dateReport',
+        'sharesOutstanding',
+        'sharesOutstandingDiluted',
+        'splitRatio',
+    ];
+    for (var _i = 0, matchingProperties_1 = matchingProperties; _i < matchingProperties_1.length; _i++) {
+        var property = matchingProperties_1[_i];
+        matchProperty(property, Q4, FY);
+    }
 }
 exports.resolveQ4FiscalYearMatchingProperties = resolveQ4FiscalYearMatchingProperties;
 function matchProperty(propertyName, reportA, reportB) {

package/build/services/ReportParser/resolvers/resolve-split-ratio.d.ts

@@ -0,0 +1,2 @@
+import ReportWrapper from '../ReportWrapper';
+export declare function resolveSplitRatio(report: ReportWrapper): void;

package/build/services/ReportParser/resolvers/resolve-split-ratio.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveSplitRatio = void 0;
+function resolveSplitRatio(report) {
+    var _a = report.getReportsFiscalYearByPeriod(), Q1 = _a.Q1, Q2 = _a.Q2, Q3 = _a.Q3, Q4 = _a.Q4;
+    var splitReport = null;
+    // FY will have already been matched with Q4 from resolve-q4-fiscal-year-matching-properties.ts
+    var takenRatios = new Set();
+    for (var _i = 0, _b = [Q4, Q3, Q2, Q1]; _i < _b.length; _i++) {
+        var report_1 = _b[_i];
+        if (!(report_1 === null || report_1 === void 0 ? void 0 : report_1.splitRatio))
+            continue;
+        if (takenRatios.has(report_1.splitRatio)) {
+            report_1.splitRatio = null;
+            continue;
+        }
+        splitReport = report_1;
+        takenRatios.add(report_1.splitRatio);
+    }
+    if (!splitReport)
+        return;
+    var prevReports = [
+        splitReport.getReportOffset(-1, 'QUARTERLY'),
+        splitReport.getReportOffset(-2, 'QUARTERLY'),
+        splitReport.getReportOffset(-3, 'QUARTERLY'),
+        splitReport.getReportOffset(-4, 'QUARTERLY'),
+        splitReport.getReportOffset(-1, 'ANNUAL'),
+    ];
+    prevReports.forEach(function (prevReport) {
+        if (prevReport === splitReport)
+            return;
+        if (prevReport && splitReport && prevReport.splitRatio === splitReport.splitRatio) {
+            prevReport.splitRatio = null;
+        }
+    });
+}
+exports.resolveSplitRatio = resolveSplitRatio;

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

@@ -3,7 +3,6 @@ import { FilingListDetails, FilingListItemTranslated, SubmissionList } from '../
 import { IClient } from '../Client';
 import DocumentParser from '../DocumentParser';
 import ReportParser from '../ReportParser';
-import { ParseReportsOptions } from '../ReportParser/ReportRawParser';
 import ReportWrapper from '../ReportParser/ReportWrapper';
 import SubmissionRequestWrapper from './RequestWrapper';
 import { IThrottler } from './Throttler';
@@ -139,7 +138,7 @@ export default class SecEdgarApi {
      * Parses reports from company facts. Calculates missing properties and uses a single interface
      * for all reports.
      */
-    getReportsRaw(params: GetSymbolParams & ParseReportsOptions): Promise<ReportRaw[]>;
+    getReportsRaw(params: GetSymbolParams): Promise<ReportRaw[]>;
     /**
      * Gets a list of all tickers and CIKs from `https://www.sec.gov/files/company_tickers.json`
      *

package/build/types/report-raw.type.d.ts

@@ -2,16 +2,15 @@
  * Contains all keys matched from the report, along with the added keys dateEnd, dateFiled, fiscalPeriod, fiscalYear.
  */
 export type ReportRaw = {
-    [key: string]: string | number | boolean;
+    [key: string]: string | number | boolean | null;
+    cik: number;
+    url: string | null;
     dateReport: string;
     dateFiled: string;
-    form: string;
-    isTTM: boolean;
-    frame: string;
-    taxonomy: string;
-    reportType: ReportType;
     fiscalPeriod: FiscalPeriod;
     fiscalYear: number;
+    splitRatio: number | null;
+    splitDate: string | null;
 };
 /**
  * QUARTERLY = 10-Q and 10-K forms for the quarter | ANNUAL = 10-K forms for the year |

package/build/types/report-translated.type.d.ts

@@ -1,11 +1,13 @@
 import { FiscalPeriod } from './report-raw.type';
 export interface ReportTranslated {
+    cik: number;
+    url: string | null;
     dateReport: string;
     dateFiled: string;
     fiscalPeriod: FiscalPeriod;
     fiscalYear: number;
-    form: string;
-    isTTM: boolean;
+    splitDate: string | null;
+    splitRatio: number | null;
     assetTotal: number | null;
     assetCurrent: number | null;
     assetCurrentCashEquivalents: number | null;

package/build/util/calculation-map-by-ns.d.ts

@@ -0,0 +1,6 @@
+/**
+ * TODO: Add this.
+ *
+ *  @see https://xbrl.us/xbrl-taxonomy/2024-us-gaap/
+ */
+export declare const calculationMapByNs: Record<string, Record<string, string[]>>;

package/build/util/calculation-map-by-ns.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.calculationMapByNs = void 0;
+/**
+ * TODO: Add this.
+ *
+ *  @see https://xbrl.us/xbrl-taxonomy/2024-us-gaap/
+ */
+exports.calculationMapByNs = {};