sec-edgar-api 0.4.2 → 0.5.1

package/README.md

@@ -56,7 +56,6 @@ interface ReportTranslated {
 
 	equityTotal: number | null
 	equityRetainedEarnings: number | null
-	equityStockPreferred: number | null
 
 	sharesOutstanding: number | null
 	sharesOutstandingDiluted: number | null
@@ -83,16 +82,21 @@ interface ReportTranslated {
 	expenseDepreciationAccumulated: number | null
 	expenseStockCompensation: number | null
 	expenseNonCashOther: number | null
+	expenseSellingGeneralAdministrative: number | null
 
 	incomeOperating: number | null
 	incomeNet: number | null
+	incomePretax: number | null
 
 	cashFlowFree: number | null
 	cashFlowDividendsPaid: number | null
 	cashFlowDividendsPaidPreferred: number | null
 
-	cashFlowCapex: number | null
 	cashFlowOperating: number | null
+	cashFlowInvesting: number | null
+	cashFlowFinancing: number | null
+
+	cashFlowCapex: number | null
 	cashFlowDeferredTax: number | null
 
 	cashFlowWorkingCapitalNonCash: number | null

package/build/index.d.ts

@@ -1,5 +1,7 @@
 import ReportParser from './services/ReportParser';
 import SecEdgarApi from './services/SecEdgarApi';
+import ReportResolvable from './services/ReportParser/ReportResolvable';
+import { utilMap } from './util/util-map';
 /**
  * Takes company facts data from the SEC and translates them to
  * reports as json objects.
@@ -12,5 +14,5 @@ declare const reportParser: ReportParser;
  * @see https://www.sec.gov/edgar/sec-api-documentation
  */
 declare const secEdgarApi: SecEdgarApi;
-export { reportParser, secEdgarApi };
-export * from './types';
+export { reportParser, secEdgarApi, ReportResolvable, utilMap };
+export type * from './types';

package/build/index.js

@@ -1,22 +1,12 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.secEdgarApi = exports.reportParser = void 0;
+exports.utilMap = exports.ReportResolvable = exports.secEdgarApi = exports.reportParser = void 0;
 var ReportParser_1 = require("./services/ReportParser");
 var SecEdgarApi_1 = require("./services/SecEdgarApi");
+var ReportResolvable_1 = require("./services/ReportParser/ReportResolvable");
+exports.ReportResolvable = ReportResolvable_1.default;
+var util_map_1 = require("./util/util-map");
+Object.defineProperty(exports, "utilMap", { enumerable: true, get: function () { return util_map_1.utilMap; } });
 /**
  * Takes company facts data from the SEC and translates them to
  * reports as json objects.
@@ -31,4 +21,3 @@ exports.reportParser = reportParser;
  */
 var secEdgarApi = new SecEdgarApi_1.default();
 exports.secEdgarApi = secEdgarApi;
-__exportStar(require("./types"), exports);

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

@@ -38,7 +38,7 @@ export default class DocumentParser {
     parseCurrentFilingsXbrl(params: XMLParams): import("../../types").CurrentFilingsXBRL;
     parseXbrl(params: XMLParams & GetDocumentXbrlParams): import("./XBRLParser/XBRLParser").XbrlParseResult & {
         report: import("../../types").ReportRaw | null;
-        facts: import("../../types").FactItem[];
+        facts: import("../../types").FactItemExtended[];
         xml: string;
     };
 }

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

@@ -1,4 +1,4 @@
-import { XbrlInstance } from '../../../types/xbrl.type';
+import type { XbrlInstance } from '../../../types/xbrl.type';
 export default class InstanceParser {
     private readonly xmlParser;
     private parseContext;

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

@@ -1,4 +1,4 @@
-import { XbrlLinkbase } from '../../../types/xbrl.type';
+import type { XbrlLinkbase } from '../../../types';
 import XMLParser from '../XMLParser';
 export default class LinkbaseParser {
     private readonly xmlParser;

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

@@ -1,4 +1,4 @@
-import { XbrlSchema } from '../../../types/xbrl.type';
+import type { XbrlSchema } from '../../../types/xbrl.type';
 export default class SchemaParser {
     private readonly xmlParser;
     private parseAppInfo;

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

@@ -1,4 +1,4 @@
-import { XbrlInstance, XbrlLinkbase, XbrlSchema } from '../../../types/xbrl.type';
+import type { XbrlInstance, XbrlLinkbase, XbrlSchema } from '../../../types';
 import { XbrlFormHeader } from './HeaderParser';
 export interface XbrlParseResult {
     header: XbrlFormHeader;

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

@@ -1,7 +1,14 @@
 export default class XMLParser {
     private readonly selfEnclosingTags;
+    private readonly textSelectStrategy;
+    private readonly tagsToIgnore;
+    private readonly textConcatDivider;
+    constructor(params?: {
+        textSelectStrategy?: 'useFirst' | 'useLast' | 'concatenate';
+        textConcatDivider?: string;
+    });
     mapAttributes(attributes: string[]): Map<string, string>;
-    parse(xml: string): Record<string, unknown>;
+    parse(xml: string): any;
     iterateXML(params: {
         xml: string;
         onOpenTag?: (tagName: string, attributes: string[], isSelfEnclosing: boolean) => void;

package/build/services/DocumentParser/XMLParser.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 var XMLParser = /** @class */ (function () {
-    function XMLParser() {
+    function XMLParser(params) {
         this.selfEnclosingTags = new Set([
             '!doctype',
             '?xml',
@@ -14,6 +14,10 @@ var XMLParser = /** @class */ (function () {
             'filename',
             'description',
         ]);
+        this.tagsToIgnore = new Set(['script', '?xml']);
+        var _a = params !== null && params !== void 0 ? params : {}, _b = _a.textSelectStrategy, textSelectStrategy = _b === void 0 ? 'useFirst' : _b, _c = _a.textConcatDivider, textConcatDivider = _c === void 0 ? '<>' : _c;
+        this.textSelectStrategy = textSelectStrategy;
+        this.textConcatDivider = textConcatDivider;
     }
     XMLParser.prototype.mapAttributes = function (attributes) {
         var attributesMap = new Map();
@@ -25,6 +29,7 @@ var XMLParser = /** @class */ (function () {
         });
         return attributesMap;
     };
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     XMLParser.prototype.parse = function (xml) {
         var _this = this;
         var currentObj = {};
@@ -35,7 +40,7 @@ var XMLParser = /** @class */ (function () {
                 var newObj = {};
                 var obj = currentObj;
                 var isComment = tagName.startsWith('!--');
-                if (isComment || tagName === '?xml')
+                if (isComment || _this.tagsToIgnore.has(tagName.toLowerCase()))
                     return;
                 if (obj[tagName] === undefined) {
                     obj[tagName] = newObj;
@@ -60,10 +65,24 @@ var XMLParser = /** @class */ (function () {
                 if (!textTrimmed)
                     return;
                 var obj = currentObj;
-                obj['#text'] = textTrimmed;
+                switch (_this.textSelectStrategy) {
+                    case 'useFirst':
+                        if (obj['#text'])
+                            return;
+                        obj['#text'] = textTrimmed;
+                        break;
+                    case 'useLast':
+                        obj['#text'] = textTrimmed;
+                        break;
+                    case 'concatenate':
+                        obj['#text'] = obj['#text']
+                            ? "".concat(obj['#text'], " ").concat(_this.textConcatDivider, " ").concat(textTrimmed)
+                            : textTrimmed;
+                        break;
+                }
             },
-            onCloseTag: function () {
-                if (objPath.length === 1)
+            onCloseTag: function (tagName) {
+                if (objPath.length === 1 || _this.tagsToIgnore.has(tagName.toLowerCase()))
                     return;
                 objPath.pop();
                 currentObj = objPath[objPath.length - 1];

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

@@ -1,5 +1,4 @@
-import { XMLParams } from '../../../types';
-import { CompanySearchResult } from '../../../types/company-search.type';
+import type { CompanySearchResult, XMLParams } from '../../../types';
 export declare function parseCompanies(params: XMLParams): {
     items: CompanySearchResult[];
 };

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

@@ -1,51 +1,33 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseCompanies = void 0;
-var HtmlTableExtractor_1 = require("../../HtmlTableExtractor");
+var XMLParser_1 = require("../XMLParser");
 function parseCompanies(params) {
-    var _a, _b, _c, _d;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t;
     var xml = params.xml;
-    var parser = new HtmlTableExtractor_1.default();
-    var tables = parser.extractTables(xml, {
-        stripHtml: true,
-        tagsToExclude: ['sup'],
-        stripParenthesis: true,
-        removeEmptyColumns: false,
-        getHeaderRowIndex: function (data) {
-            return data.rows.findIndex(function (row) {
-                var isNotEmptyRow = row.some(function (cell) { return cell.html.replace(/<.*?>/g, '').replace(/&.*?;/g, '').replace(/\s/g, '').length > 0; });
-                return isNotEmptyRow;
-            });
-        },
-    });
-    var header = ['cik', 'company_name', 'state_country'];
-    var table = tables.find(function (t) { return t.rows.some(function (r) { return r.some(function (c) { return c.html.includes('CIK'); }); }); });
+    var parser = new XMLParser_1.default({ textSelectStrategy: 'concatenate', textConcatDivider: '<>' });
+    var result = parser.parse(xml);
+    var body = (_b = (_a = result.html) === null || _a === void 0 ? void 0 : _a.body) !== null && _b !== void 0 ? _b : {};
+    var bodyDivs = Array.isArray(body.div) ? body.div : [body.div].filter(Boolean);
+    var contentDiv = (_c = bodyDivs.find(function (d) { return d && typeof d === 'object' && d['@_id'] === 'contentDiv'; })) !== null && _c !== void 0 ? _c : {};
+    var tableDivs = Array.isArray(contentDiv.div) ? contentDiv.div : [contentDiv.div].filter(Boolean);
+    var tableDiv = (_d = tableDivs.find(function (d) { return d && typeof d === 'object' && d['@_id'] === 'seriesDiv'; })) !== null && _d !== void 0 ? _d : {};
+    var rows = (_j = (_f = (_e = tableDiv.table) === null || _e === void 0 ? void 0 : _e.tr) !== null && _f !== void 0 ? _f : (_h = (_g = tableDiv.table) === null || _g === void 0 ? void 0 : _g.tbody) === null || _h === void 0 ? void 0 : _h.tr) !== null && _j !== void 0 ? _j : [];
+    rows = (Array.isArray(rows) ? rows : [rows])
+        .filter(function (r) { return r === null || r === void 0 ? void 0 : r.td; })
+        .map(function (r) { return (Array.isArray(r.td) ? r.td : [r.td]).filter(Boolean); });
     var items = [];
-    for (var _i = 0, _e = (_a = table === null || table === void 0 ? void 0 : table.rows) !== null && _a !== void 0 ? _a : []; _i < _e.length; _i++) {
-        var row = _e[_i];
-        if ((_b = row[0]) === null || _b === void 0 ? void 0 : _b.isHeaderRowCell)
+    for (var _i = 0, rows_1 = rows; _i < rows_1.length; _i++) {
+        var row = rows_1[_i];
+        var cik = Number((_l = (_k = row[0]) === null || _k === void 0 ? void 0 : _k.a) === null || _l === void 0 ? void 0 : _l['#text']) || 0;
+        if (!cik)
             continue;
-        var item = {
-            cik: 0,
-            companyName: '',
-            stateOrCountry: '',
-        };
-        for (var _f = 0, row_1 = row; _f < row_1.length; _f++) {
-            var cell = row_1[_f];
-            var colName = header[cell.colIndex];
-            switch (colName) {
-                case 'cik':
-                    item.cik = Number(cell.valueParsed) || 0;
-                    break;
-                case 'company_name':
-                    item.companyName = String(((_d = (_c = cell.html.split('>')[1]) === null || _c === void 0 ? void 0 : _c.split('<')[0]) === null || _d === void 0 ? void 0 : _d.split('/')[0]) || cell.valueParsed).trim();
-                    break;
-                case 'state_country':
-                    item.stateOrCountry = String(cell.valueParsed || '');
-                    break;
-            }
-        }
-        items.push(item);
+        var row1Parts = (_o = (((_m = row[1]) === null || _m === void 0 ? void 0 : _m['#text']) || '').split('<>')) !== null && _o !== void 0 ? _o : [];
+        var sic = Number((_q = (_p = row[1]) === null || _p === void 0 ? void 0 : _p.a) === null || _q === void 0 ? void 0 : _q['#text']) || null;
+        var companyName = row1Parts[0].trim();
+        var sicDescription = sic ? ((_r = row1Parts.pop()) === null || _r === void 0 ? void 0 : _r.replace('-', '').trim()) || null : null;
+        var stateOrCountry = ((_t = (_s = row[2]) === null || _s === void 0 ? void 0 : _s.a) === null || _t === void 0 ? void 0 : _t['#text']) || null;
+        items.push({ cik: cik, sic: sic, sicDescription: sicDescription, companyName: companyName, stateOrCountry: stateOrCountry });
     }
     return { items: items };
 }

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

@@ -65,6 +65,7 @@ function parseCurrentFilingsXbrl(params) {
                 case 'item': {
                     result.items.push({
                         title: '',
+                        url: '',
                         companyName: '',
                         cikNumber: 0,
                         link: '',
@@ -99,6 +100,13 @@ function parseCurrentFilingsXbrl(params) {
             }
         },
     });
+    // add url to each filing
+    result.items.forEach(function (item) {
+        var cikNumber = item.cikNumber, accessionNumber = item.accessionNumber;
+        var accessionNoHyphen = accessionNumber.replace(/-/g, '');
+        var filePath = "".concat(Number(cikNumber), "/").concat(accessionNoHyphen, "/").concat(accessionNumber, ".txt");
+        item.url = "https://www.sec.gov/Archives/edgar/data/".concat(filePath);
+    });
     return result;
 }
 exports.parseCurrentFilingsXbrl = parseCurrentFilingsXbrl;

package/build/services/DocumentParser/parsers/parse-insider-transaction.d.ts

@@ -1,5 +1,4 @@
-import { XMLParams } from '../../../types';
-import { InsiderTransaction, Issuer, Owner } from '../../../types/insider-transaction.type';
+import type { InsiderTransaction, Issuer, Owner, XMLParams } from '../../../types';
 export declare function parseInsiderTransactions(params: XMLParams): {
     transactions: InsiderTransaction[];
     owners: Owner[];

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

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

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

@@ -43,12 +43,7 @@ function buildReportsFromFacts(params) {
         fiscalYear: fiscalYear,
     };
     // if there is a split fact, make sure it's from the current fiscal year
-    var allowedMonthsPriorForSplit = fiscalPeriod === 'FY' ? 12 : 3;
-    var splitFact = facts.find(function (f) {
-        var _a;
-        return f.name.endsWith(constants_1.KEY_SPLIT) &&
-            isWithinDays({ dateA: f.filed, dateB: (_a = filing === null || filing === void 0 ? void 0 : filing.reportDate) !== null && _a !== void 0 ? _a : '', days: allowedMonthsPriorForSplit * 30 });
-    });
+    var splitFact = facts.find(function (f) { var _a; return f.name.endsWith(constants_1.KEY_SPLIT) && isWithinDays({ dateA: f.filed, dateB: (_a = filing === null || filing === void 0 ? void 0 : filing.reportDate) !== null && _a !== void 0 ? _a : '', days: 90 }); });
     var reportFocus = {
         cik: Number(cik !== null && cik !== void 0 ? cik : reportFactValues.cik),
         dateFiled: (_d = filing === null || filing === void 0 ? void 0 : filing.filingDate) !== null && _d !== void 0 ? _d : '',
@@ -71,8 +66,11 @@ function buildReportsFromFacts(params) {
             startDate: (_j = fact.start) !== null && _j !== void 0 ? _j : '',
             endDate: fact.end,
         });
-        var isFocusFact = (_k = isFocusFactByDateKey.get(dateKey)) !== null && _k !== void 0 ? _k : isWithinDays({ dateA: fact.end, dateB: reportFocus.dateReport, days: 45 });
-        isFocusFactByDateKey.set(dateKey, isFocusFact);
+        var isSplitFact = fact === splitFact;
+        var isFocusFact = (_k = isFocusFactByDateKey.get(dateKey)) !== null && _k !== void 0 ? _k : (isWithinDays({ dateA: fact.end, dateB: reportFocus.dateReport, days: 45 }) || isSplitFact);
+        if (!isSplitFact) {
+            isFocusFactByDateKey.set(dateKey, isFocusFact);
+        }
         var el = fact;
         var scale = Number((_l = el.scale) !== null && _l !== void 0 ? _l : 0) || 0;
         var decimals = Number((_m = el.decimals) !== null && _m !== void 0 ? _m : 0) || 0;
@@ -106,8 +104,14 @@ function buildReportsFromFacts(params) {
         factByName.set(prevFactKey, fact);
         reportByDateRange[dateKey][nameKey] = fact.value;
         if (isFocusFact) {
+            if (prevFact)
+                prevFact.isUsedInReport = false;
+            fact.isUsedInReport = true;
             reportFocus[nameKey] = fact.value;
         }
+        else {
+            fact.isUsedInReport = false;
+        }
     }
     return { reportFocus: reportFocus, reportByDateRange: reportByDateRange, factsFiltered: Array.from(factByName.values()) };
 }

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

@@ -1,12 +1,13 @@
-import { CompanyFactListData, ReportRaw, ReportTranslated } from '../../types';
+import type { CalculationMap, CompanyFactListData, ReportRaw, ReportTranslated } from '../../types';
 import ReportRawBuilder from '../ReportRawBuilder';
-import { GetReportsRawParams } from '../SecEdgarApi';
+import { BuildReportsParams } from '../ReportRawBuilder/ReportRawBuilder';
 import PropertyResolver from './PropertyResolver';
 import ReportWrapper from './ReportWrapper';
 interface ReportParserArgs {
     reportBuilder?: ReportRawBuilder;
     propertyResolver?: PropertyResolver;
     keyTranslator?: Record<string, string[]>;
+    defaultCalculationMap?: CalculationMap<ReportTranslated>;
 }
 type TranslateRawReportsCallback<T> = (report: T extends undefined ? ReportTranslated : Record<keyof T, string | number>, reportRaw: ReportRaw, keyTranslator: T) => ReportTranslated | ReportRaw | Record<string, string | number | null>;
 /**
@@ -16,24 +17,36 @@ export default class ReportParser {
     private readonly keyTranslator;
     private readonly propertyResolver;
     private readonly reportBuilder;
+    private defaultCalculationMap;
     constructor(args?: ReportParserArgs);
     /**
      * Same as parseReports but accepts ReportRaw[] instead of CompanyFactListData
+     *
+     * @deprecated Formerly parseReportsFromRaw. Will be removed in future version.
      */
-    parseReportsFromRaw(params: {
+    parseReportsFromRawLegacy(params: {
         reportsRaw: ReportRaw[];
         usePropertyResolver?: boolean;
     }): ReportWrapper[];
+    /**
+     * Same as parseReports but accepts ReportRaw[] instead of CompanyFactListData
+     */
+    parseReportsFromRaw<T = ReportTranslated>(params: {
+        reportsRaw: ReportRaw[];
+        calculationMap?: CalculationMap<T>;
+    }): (ReportRaw & T)[];
     /**
      * Parse raw reports
      *
      * @see https://www.sec.gov/edgar/sec-api-documentation
      */
-    parseReportsRaw(companyFactListData: CompanyFactListData, options?: Omit<GetReportsRawParams, 'symbol'>): ReportRaw[];
+    parseReportsRaw(companyFactListData: CompanyFactListData, options: Omit<BuildReportsParams, 'facts'> & {
+        includeNamePrefix?: boolean;
+    }): ReportRaw[];
     /**
-     * parseReportsRaw but removes meta data from the report
+     * Builds ReportRaw[] from facts
      */
-    parseReportsRawNoMeta(companyFactListData: CompanyFactListData): Record<string, number>[];
+    buildReports(params: BuildReportsParams): ReportRaw[];
     /**
      * Translate ReportRaw to ReportTranslated by default, but can be used to translate to any object using both the callback and keyTranslator
      *

package/build/services/ReportParser/ReportParser.js

@@ -1,23 +1,40 @@
 "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 calculation_map_1 = require("../../util/calculation-map");
 var key_translations_1 = require("../../util/key-translations");
+var util_map_1 = require("../../util/util-map");
 var ReportRawBuilder_1 = require("../ReportRawBuilder");
 var PropertyResolver_1 = require("./PropertyResolver");
+var ReportResolvable_1 = require("./ReportResolvable");
 var ReportWrapper_1 = require("./ReportWrapper");
 /**
  * Takes company facts data from the SEC and translates them to reports as json objects.
  */
 var ReportParser = /** @class */ (function () {
     function ReportParser(args) {
-        var _a = args !== null && args !== void 0 ? args : {}, _b = _a.propertyResolver, propertyResolver = _b === void 0 ? new PropertyResolver_1.default() : _b, _c = _a.reportBuilder, reportBuilder = _c === void 0 ? new ReportRawBuilder_1.default() : _c, _d = _a.keyTranslator, keyTranslator = _d === void 0 ? key_translations_1.default : _d;
+        var _a = args !== null && args !== void 0 ? args : {}, _b = _a.propertyResolver, propertyResolver = _b === void 0 ? new PropertyResolver_1.default() : _b, _c = _a.reportBuilder, reportBuilder = _c === void 0 ? new ReportRawBuilder_1.default() : _c, _d = _a.keyTranslator, keyTranslator = _d === void 0 ? key_translations_1.default : _d, _e = _a.defaultCalculationMap, defaultCalculationMap = _e === void 0 ? util_map_1.utilMap.expandMap(calculation_map_1.calculationMapCondensed) : _e;
         this.keyTranslator = keyTranslator;
         this.propertyResolver = propertyResolver;
         this.reportBuilder = reportBuilder;
+        this.defaultCalculationMap = defaultCalculationMap;
     }
     /**
      * Same as parseReports but accepts ReportRaw[] instead of CompanyFactListData
+     *
+     * @deprecated Formerly parseReportsFromRaw. Will be removed in future version.
      */
-    ReportParser.prototype.parseReportsFromRaw = function (params) {
+    ReportParser.prototype.parseReportsFromRawLegacy = function (params) {
         var reportsRaw = params.reportsRaw, _a = params.usePropertyResolver, usePropertyResolver = _a === void 0 ? true : _a;
         var reportByYearQuarter = new Map();
         var reportsRawFiltered = reportsRaw;
@@ -33,36 +50,50 @@ var ReportParser = /** @class */ (function () {
         }
         return reportWrappers;
     };
+    /**
+     * Same as parseReports but accepts ReportRaw[] instead of CompanyFactListData
+     */
+    ReportParser.prototype.parseReportsFromRaw = function (params) {
+        var reportsRaw = params.reportsRaw, 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;
+                reportNew[key] = value;
+            }
+            return reportNew;
+        });
+    };
     /**
      * Parse raw reports
      *
      * @see https://www.sec.gov/edgar/sec-api-documentation
      */
     ReportParser.prototype.parseReportsRaw = function (companyFactListData, options) {
-        if (options === void 0) { options = {}; }
-        var adjustForSplits = options.adjustForSplits, resolvePeriodValues = options.resolvePeriodValues, includeNamePrefix = options.includeNamePrefix;
+        var includeNamePrefix = options.includeNamePrefix;
         var facts = this.reportBuilder.createFacts(companyFactListData, includeNamePrefix).facts;
-        return this.reportBuilder.buildReports({
-            facts: facts,
-            adjustForSplits: adjustForSplits,
-            resolvePeriodValues: resolvePeriodValues,
-        });
+        return this.reportBuilder.buildReports(__assign({ facts: facts }, options));
     };
     /**
-     * parseReportsRaw but removes meta data from the report
+     * Builds ReportRaw[] from facts
      */
-    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.splitRatio;
-            delete report.splitDate;
-        });
-        return reportsRaw;
+    ReportParser.prototype.buildReports = function (params) {
+        return this.reportBuilder.buildReports(params);
     };
     /**
      * Translate ReportRaw to ReportTranslated by default, but can be used to translate to any object using both the callback and keyTranslator

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

@@ -0,0 +1,50 @@
+import type { CalculationMapCalculation, CalculationMap } from '../../types/calculation-map.type';
+interface GetCalculatedFromGroupResult {
+    missingKeys: string[] | null;
+    isMissingRequiredKey: boolean;
+    hasAtLeastOneKey: boolean;
+    value: number | null;
+}
+interface GetCalculatedFromGroupParams {
+    group: CalculationMapCalculation;
+    breakIfMissingRequiredKey?: boolean;
+}
+export default class ReportResolvable {
+    readonly report: Record<string, string | number | null | boolean>;
+    private readonly calculationMap;
+    private readonly keyStack;
+    private readonly calculatedValues;
+    private readonly usedGroupIndexesByKey;
+    private depth;
+    constructor(args: {
+        report: Record<string, string | number | null | boolean>;
+        calculationMap?: CalculationMap;
+    });
+    getMap(): CalculationMap;
+    clearCache(): void;
+    /**
+     * Used when testing to remove groups that are not being used.
+     */
+    getUsedGroupIndexesByKey(): Record<string, number[]>;
+    /**
+     * Gets value from report, or calculates it using calculationMap.
+     */
+    get(key: string): string | number | null | boolean | undefined;
+    /**
+     * Returns 0 for non-numeric values
+     */
+    getNumber(key: string): number;
+    getCalculatedFromGroup(params: GetCalculatedFromGroupParams): GetCalculatedFromGroupResult;
+    private _get;
+    private _getCalculatedFromGroup;
+    /**
+     * @param skipSingleMatch When true, skips groups that match only one key. Used for testing groups.
+     */
+    getCalculated(key: string, skipSingleMatch?: boolean): {
+        value: string | number | boolean | null;
+        groupIndex: number;
+    };
+    private _getCalculated;
+    toJSON(): Record<string, string | number | boolean | null>;
+}
+export {};