sec-edgar-api 0.2.2 → 0.2.4

package/build/services/DocumentParser/parsers/parse-form-def14a.js

@@ -1,177 +1,126 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseFormDef14a = void 0;
-var HtmlTableExtractor_1 = require("../HtmlTableExtractor");
+var XMLParser_1 = require("../XMLParser");
 /**
  * Form DEF 14a - Proxy Statement
  *
  * example at https://www.sec.gov/Archives/edgar/data/320193/000130817923000019/laap2023_def14a.htm
  */
-function parseFormDef14a(params) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
+function parseFormDef14a(params, xmlParser) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s;
+    if (xmlParser === void 0) { xmlParser = new XMLParser_1.default(); }
     var xml = params.xml;
-    var parser = new HtmlTableExtractor_1.default();
-    var tables = parser.extractTables(xml, {
-        stripHtml: true,
-        tagsToExclude: ['sup'],
-        stripParenthesis: true,
-    });
-    var compensationTables = [];
-    for (var _i = 0, tables_1 = tables; _i < tables_1.length; _i++) {
-        var table = tables_1[_i];
-        var compensationRows = [];
-        var bodyIndex = table.rows.findIndex(function (row) { return row.some(function (col) { return !col.isHeaderRowCell; }); });
-        var headerIndex = bodyIndex - 1;
-        var textBefore = parser.stripHtml(table.htmlBefore, { tagsToExclude: ['sup'] }).toLowerCase();
-        var hasNameRow = (_a = table.rows[headerIndex]) === null || _a === void 0 ? void 0 : _a.some(function (col) { return "".concat(col.valueParsed).toLowerCase().includes('name'); });
-        var hasSalaryRow = (_b = table.rows[headerIndex]) === null || _b === void 0 ? void 0 : _b.some(function (col) {
-            return "".concat(col.valueParsed).toLowerCase().includes('salary');
+    var doc = xmlParser.getDocumentNode({ xml: xml });
+    var tables = doc.parseTables();
+    var usedTables = [];
+    var compensationArr = [];
+    var holderArr = [];
+    var findCompensationTables = function (type) {
+        var tablesFound = tables.filter(function (table) {
+            var _a, _b, _c, _d, _e;
+            var hasNameRow = (_a = table.rows[0]) === null || _a === void 0 ? void 0 : _a.some(function (col) { return "".concat(col).toLowerCase().includes('name'); });
+            var hasTotalRow = (_b = table.rows[0]) === null || _b === void 0 ? void 0 : _b.some(function (col) { return "".concat(col).toLowerCase().includes('total'); });
+            var hasAwardRow = (_c = table.rows[0]) === null || _c === void 0 ? void 0 : _c.some(function (col) { return "".concat(col).toLowerCase().includes('award'); });
+            var titleLower = table.title.toLowerCase();
+            var textLower = (_e = (_d = table.textBefore) === null || _d === void 0 ? void 0 : _d.toLowerCase()) !== null && _e !== void 0 ? _e : '';
+            var isTitleMatch = titleLower.includes(type) && titleLower.includes('compensation');
+            var isTextMatch = hasNameRow && hasTotalRow && hasAwardRow && textLower.includes(type);
+            return (isTitleMatch || isTextMatch) && !usedTables.includes(table);
         });
-        var hasTotalRow = (_c = table.rows[headerIndex]) === null || _c === void 0 ? void 0 : _c.some(function (col) { return "".concat(col.valueParsed).toLowerCase().includes('total'); });
-        var isCompensationTable = Boolean(hasNameRow && hasTotalRow && hasSalaryRow);
-        if (!isCompensationTable)
-            continue;
-        var defaultPosition = 'Executive';
-        if (textBefore.includes('executive'))
-            defaultPosition = 'Executive';
-        else if (textBefore.includes('director'))
-            defaultPosition = 'Director';
-        var _loop_1 = function (i) {
-            var row = table.rows[i];
-            var getIndex = function (search, isNum, isYear) {
-                if (isNum === void 0) { isNum = true; }
-                if (isYear === void 0) { isYear = false; }
-                return row.findIndex(function (col) {
-                    var hasType = isNum ? typeof col.valueParsed === 'number' : true;
-                    var hasSearch = "".concat(col.headerCol).toLowerCase().includes(search);
-                    var hasYear = !isYear || (Number(col.valueParsed) > 1900 && Number(col.valueParsed) < 2100);
-                    return hasType && hasSearch && hasYear;
-                });
-            };
-            var indexName = getIndex('name', false);
-            var indexYear = getIndex('year', true, true);
+        tablesFound.forEach(function (t) { return usedTables.push(t); });
+        return tablesFound;
+    };
+    var tablesHolder = tables.filter(function (table) {
+        var _a, _b;
+        var hasNameRow = (_a = table.rows[0]) === null || _a === void 0 ? void 0 : _a.some(function (col) { return "".concat(col).toLowerCase().includes('name'); });
+        var hasPercent = (_b = table.rows[0]) === null || _b === void 0 ? void 0 : _b.some(function (col) { return "".concat(col).toLowerCase().includes('percent'); });
+        var titleLower = table.title.toLowerCase();
+        var isTitleMatch = titleLower.includes('security') && titleLower.includes('owner') && titleLower.includes('beneficial');
+        return isTitleMatch && hasNameRow && hasPercent;
+    });
+    var foundHoldersKeys = new Set();
+    var _loop_1 = function (table) {
+        var header = table.rows[0];
+        var getIndex = function (search) { return header.findIndex(function (col) { return "".concat(col).toLowerCase().includes(search); }); };
+        var indexName = getIndex('name');
+        var indexPercent = getIndex('percent');
+        var indexShares = (_b = (_a = table.rows[1]) === null || _a === void 0 ? void 0 : _a.findIndex(function (col) { return typeof col === 'number' && !isNaN(col); })) !== null && _b !== void 0 ? _b : -1;
+        for (var i = 1; i < table.rows.length; i++) {
+            for (var i_1 = 1; i_1 < table.rows.length; i_1++) {
+                var nameVal = (_d = (_c = table.rows[i_1]) === null || _c === void 0 ? void 0 : _c[indexName]) !== null && _d !== void 0 ? _d : null;
+                if (typeof nameVal !== 'string')
+                    continue;
+                var nameParts = nameVal.split('}}');
+                var namePartsSpaces = nameVal.split(' ');
+                var position = (_e = nameParts[1]) !== null && _e !== void 0 ? _e : namePartsSpaces.slice(2, namePartsSpaces.length).join(' ');
+                var name_1 = nameParts[1] ? nameParts[0] : namePartsSpaces.slice(0, 2).join(' ');
+                var holder = {
+                    name: name_1.replace(/{{/g, '').replace(/}}/g, '').trim(),
+                    position: position.replace(/{{/g, '').replace(/}}/g, '').trim() || null,
+                    shares: Number((_f = table.rows[i_1]) === null || _f === void 0 ? void 0 : _f[indexShares]) || null,
+                    percentOfClass: String((_g = table.rows[i_1]) === null || _g === void 0 ? void 0 : _g[indexPercent]) || null,
+                };
+                var key = "".concat(holder.name).concat(holder.position).concat(holder.shares).concat(holder.percentOfClass);
+                if (!foundHoldersKeys.has(key))
+                    holderArr.push(holder);
+                foundHoldersKeys.add(key);
+            }
+        }
+    };
+    for (var _i = 0, tablesHolder_1 = tablesHolder; _i < tablesHolder_1.length; _i++) {
+        var table = tablesHolder_1[_i];
+        _loop_1(table);
+    }
+    for (var _t = 0, _u = ['director', 'executive', 'summary']; _t < _u.length; _t++) {
+        var type = _u[_t];
+        var _loop_2 = function (table) {
+            if (!table)
+                return "continue";
+            var header = table.rows[0];
+            var getIndex = function (search) { return header.findIndex(function (col) { return "".concat(col).toLowerCase().includes(search); }); };
+            var indexName = getIndex('name');
+            var indexYear = getIndex('year');
             var indexSalary = getIndex('salary') === -1 ? getIndex('cash') : getIndex('salary');
             var indexBonus = getIndex('bonus');
             var indexStock = getIndex('stock');
-            var indexOption = getIndex('non-equity') === -1 ? getIndex('option') : getIndex('non-equity');
+            var indexNonEquity = getIndex('non-equity') === -1 ? getIndex('option') : getIndex('non-equity');
             var indexOther = getIndex('other');
             var indexTotal = getIndex('total');
-            var nameHtml = String((_e = (_d = row[indexName]) === null || _d === void 0 ? void 0 : _d.html) !== null && _e !== void 0 ? _e : '');
-            var nameParts = nameHtml
-                .replace(/\n/g, ' ')
-                .replace(/<sup.*?sup>/gi, '')
-                .replace(/&.*?;/g, '')
-                .split(/<.*?>/g)
-                .filter(function (str) { return str.replace(/\W/gi, '').length > 0; })
-                .map(function (str) { return str.replace(/(\s|\n|\t)+/g, ' ').trim(); });
-            var year = Number((_f = row[indexYear]) === null || _f === void 0 ? void 0 : _f.valueParsed) ||
-                Number(String((_g = row[indexYear]) === null || _g === void 0 ? void 0 : _g.valueParsed)
-                    .split(/\W/g)
-                    .find(function (str) { return str.length === 4; })) ||
-                null;
-            var name_1 = String(parser.parseValue(((_h = nameParts[0]) === null || _h === void 0 ? void 0 : _h.trim()) || '', { stripHtml: false, stripParenthesis: true }) || '');
-            var position = String(parser.parseValue((_j = nameParts.slice(1)) === null || _j === void 0 ? void 0 : _j.join(' '), { stripHtml: false, stripParenthesis: true }) || '');
-            var isValidPosition = position.replace(/\W/gi, '').length > 0 && isNaN(Number(position));
-            compensationRows.push({
-                name: name_1.replace(/\s+/g, ' '),
-                position: isValidPosition ? position || defaultPosition : defaultPosition,
-                year: year,
-                positionLevel: defaultPosition || 'Executive',
-                salaryDollars: Number((_k = row[indexSalary]) === null || _k === void 0 ? void 0 : _k.valueParsed) || null,
-                bonusDollars: Number((_l = row[indexBonus]) === null || _l === void 0 ? void 0 : _l.valueParsed) || null,
-                stockAwardDollars: Number((_m = row[indexStock]) === null || _m === void 0 ? void 0 : _m.valueParsed) || null,
-                nonEquityDollars: Number((_o = row[indexOption]) === null || _o === void 0 ? void 0 : _o.valueParsed) || null,
-                otherDollars: Number((_p = row[indexOther]) === null || _p === void 0 ? void 0 : _p.valueParsed) || null,
-                totalDollars: Number((_q = row[indexTotal]) === null || _q === void 0 ? void 0 : _q.valueParsed) || null,
-            });
+            var defaultPosition = {
+                director: 'Director',
+                executive: 'Executive',
+                summary: null,
+            }[type];
+            for (var i = 1; i < table.rows.length; i++) {
+                var nameVal = (_j = (_h = table.rows[i]) === null || _h === void 0 ? void 0 : _h[indexName]) !== null && _j !== void 0 ? _j : null;
+                if (typeof nameVal !== 'string')
+                    continue;
+                var nameParts = nameVal.split('}}');
+                var namePartsSpaces = nameVal.split(' ');
+                var position = (_k = nameParts[1]) !== null && _k !== void 0 ? _k : namePartsSpaces.slice(2, namePartsSpaces.length).join(' ');
+                var name_2 = nameParts[1] ? nameParts[0] : namePartsSpaces.slice(0, 2).join(' ');
+                var compensation = {
+                    name: name_2.replace(/{{/g, '').replace(/}}/g, '').trim(),
+                    position: position.replace(/{{/g, '').replace(/}}/g, '').trim() || (defaultPosition !== null && defaultPosition !== void 0 ? defaultPosition : null),
+                    year: Number((_l = table.rows[i]) === null || _l === void 0 ? void 0 : _l[indexYear]) || null,
+                    salaryDollars: Number((_m = table.rows[i]) === null || _m === void 0 ? void 0 : _m[indexSalary]) || null,
+                    bonusDollars: Number((_o = table.rows[i]) === null || _o === void 0 ? void 0 : _o[indexBonus]) || null,
+                    stockAwardDollars: Number((_p = table.rows[i]) === null || _p === void 0 ? void 0 : _p[indexStock]) || null,
+                    nonEquityDollars: Number((_q = table.rows[i]) === null || _q === void 0 ? void 0 : _q[indexNonEquity]) || null,
+                    otherDollars: Number((_r = table.rows[i]) === null || _r === void 0 ? void 0 : _r[indexOther]) || null,
+                    totalDollars: Number((_s = table.rows[i]) === null || _s === void 0 ? void 0 : _s[indexTotal]) || null,
+                };
+                if (compensation.totalDollars !== null) {
+                    compensationArr.push(compensation);
+                }
+            }
         };
-        for (var i = bodyIndex; i < table.rows.length; i++) {
-            _loop_1(i);
+        for (var _v = 0, _w = findCompensationTables(type); _v < _w.length; _v++) {
+            var table = _w[_v];
+            _loop_2(table);
         }
-        compensationTables.push(compensationRows);
     }
-    mergeYearRows(compensationTables);
-    var tablesFlat = flattenTables(compensationTables);
-    return { executiveCompensation: tablesFlat };
+    return { executiveCompensation: compensationArr, holders: holderArr };
 }
 exports.parseFormDef14a = parseFormDef14a;
-function flattenTables(tables) {
-    var isDefaultPosition = function (position) { return position === 'Director' || position === 'Executive'; };
-    var compensationByNameYear = new Map();
-    var resolveProperty = function (a, b) {
-        if (a === null && b === null)
-            return null;
-        if (a === null && b !== null)
-            return b;
-        if (a !== null && b === null)
-            return a;
-        if (typeof a === 'number' && typeof b === 'number') {
-            return Math.max(a, b);
-        }
-        if (typeof a === 'string' && typeof b === 'string') {
-            return isDefaultPosition(a) ? b : a;
-        }
-        return b;
-    };
-    for (var _i = 0, tables_2 = tables; _i < tables_2.length; _i++) {
-        var table = tables_2[_i];
-        for (var _a = 0, table_1 = table; _a < table_1.length; _a++) {
-            var row = table_1[_a];
-            var key = "".concat(row.name, "_").concat(row.year);
-            var curRow = compensationByNameYear.get(key) || row;
-            compensationByNameYear.set(key, curRow);
-            for (var key_1 in row) {
-                var k = key_1;
-                curRow[k] = resolveProperty(curRow[k], row[k]);
-            }
-        }
-    }
-    return Array.from(compensationByNameYear.values());
-}
-function mergeYearRows(compensationTables) {
-    var _a;
-    var isDefaultPosition = function (position) { return position === 'Director' || position === 'Executive'; };
-    var positionByName = new Map();
-    for (var _i = 0, compensationTables_1 = compensationTables; _i < compensationTables_1.length; _i++) {
-        var table = compensationTables_1[_i];
-        var uniqueYears = Array.from(new Set(table.map(function (row) { return row.year; }))).filter(Boolean);
-        if (uniqueYears.length <= 1)
-            continue;
-        var isDesc = uniqueYears[0] > uniqueYears[1];
-        for (var i = 1; i < table.length; i++) {
-            var row = table[i];
-            var rowPrev = table[i - 1];
-            var year = Number(row.year);
-            var yearPrev = Number(rowPrev.year);
-            if (yearPrev && !year) {
-                year = isDesc ? yearPrev - 1 : yearPrev + 1;
-                row.year = year;
-            }
-            else if (!yearPrev && year) {
-                yearPrev = isDesc ? year - 1 : year + 1;
-                rowPrev.year = yearPrev;
-            }
-            var isIncrementYear = isDesc ? year < yearPrev : year > yearPrev;
-            var isSamePersonDiffYear = isIncrementYear && year && yearPrev;
-            var isSameName = row.name === rowPrev.name;
-            var isSamePosition = row.position === rowPrev.position;
-            var mergedNamePosition = "".concat(isSameName ? '' : row.name || '', " ").concat(isDefaultPosition(row.position) || isSamePosition ? '' : row.position || '').trim();
-            var mergedPosition = isDefaultPosition(rowPrev.position)
-                ? mergedNamePosition
-                : "".concat(rowPrev.position || '', " ").concat(mergedNamePosition).trim();
-            var nameNew = rowPrev.name || row.name;
-            var positionNew = ((_a = rowPrev.position) === null || _a === void 0 ? void 0 : _a.includes(mergedNamePosition)) ? rowPrev.position : mergedPosition;
-            if (isSamePersonDiffYear) {
-                rowPrev.position = positionNew;
-                row.position = positionNew;
-                rowPrev.name = nameNew;
-                row.name = nameNew;
-            }
-            positionByName.set(row.name, String(row.position));
-        }
-        for (var _b = 0, table_2 = table; _b < table_2.length; _b++) {
-            var row = table_2[_b];
-            row.position = positionByName.get(row.name) || row.position;
-        }
-    }
-}

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

@@ -6,6 +6,10 @@ export interface SetReportDatesParams {
     isAnnual: boolean;
     accn: string;
 }
+/**
+ * Gets the fiscal period for a given date. does this by checking when the FY end periods are,
+ * Then measures the offset from the end date to the next/previous fiscal year end.
+ */
 export default class FactFiscalCalculator {
     private readonly endDateByYear;
     private readonly fiscalsByEndDate;

package/build/services/ReportBuilder/FactFiscalCalculator.js

@@ -1,5 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Gets the fiscal period for a given date. does this by checking when the FY end periods are,
+ * Then measures the offset from the end date to the next/previous fiscal year end.
+ */
 var FactFiscalCalculator = /** @class */ (function () {
     function FactFiscalCalculator() {
         this.endDateByYear = new Map();

package/build/services/ReportBuilder/FactPeriodResolver.d.ts

@@ -1,4 +1,9 @@
 import { FiscalPeriod } from '../../types/report-raw.type';
+/**
+ * Resolves quarterly and annual values for a property. This is because filers provide total values for the
+ * current fiscal year, rather than values for the individual quarters
+ * ex: Net income for Q2 will give 6 months revenue, not 3 month.
+ */
 export default class FactPeriodResolver {
     /** Values for each quarter [numQ1, numQ2, numQ3, numQ4] */
     private readonly valueByQuarterByPropertyByYear;
@@ -30,8 +35,7 @@ export default class FactPeriodResolver {
         end: string;
         value: number | string;
         name: string;
-        dateReport: string;
-        dateFiled: string;
+        filed: string;
     }): void;
     private readonly unresolvedReports;
     private buildUnresolvedReports;

package/build/services/ReportBuilder/FactPeriodResolver.js

@@ -1,6 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 var ReportRawResolvable_1 = require("./ReportRawResolvable");
+/**
+ * Resolves quarterly and annual values for a property. This is because filers provide total values for the
+ * current fiscal year, rather than values for the individual quarters
+ * ex: Net income for Q2 will give 6 months revenue, not 3 month.
+ */
 var FactPeriodResolver = /** @class */ (function () {
     function FactPeriodResolver(args) {
         /** Values for each quarter [numQ1, numQ2, numQ3, numQ4] */
@@ -111,7 +116,7 @@ var FactPeriodResolver = /** @class */ (function () {
         return report;
     };
     FactPeriodResolver.prototype.add = function (params) {
-        var year = params.year, value = params.value, propertyName = params.name, quarter = params.quarter, start = params.start, end = params.end, dateReport = params.dateReport, dateFiled = params.dateFiled;
+        var year = params.year, value = params.value, propertyName = params.name, quarter = params.quarter, start = params.start, end = params.end, filed = params.filed;
         var period = this.getPeriod({ start: start, end: end });
         this.addPropertyByYear(this.propertiesByYear, year, propertyName);
         if (typeof value === 'string') {

package/build/services/ReportBuilder/FactRecordBuilder.d.ts

@@ -1,7 +1,10 @@
 import { FactItem } from './ReportBuilder';
 import { CompanyFactListData } from '../../types';
+/**
+ * Builds an array of fact records.
+ */
 export default class FactRecordBuilder {
-    createFacts(data: CompanyFactListData): {
+    createFacts(data: CompanyFactListData, filterDuplicates?: boolean): {
         facts: FactItem[];
     };
 }

package/build/services/ReportBuilder/FactRecordBuilder.js

@@ -1,11 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Builds an array of fact records.
+ */
 var FactRecordBuilder = /** @class */ (function () {
     function FactRecordBuilder() {
     }
-    FactRecordBuilder.prototype.createFacts = function (data) {
+    FactRecordBuilder.prototype.createFacts = function (data, filterDuplicates) {
+        if (filterDuplicates === void 0) { filterDuplicates = false; }
         var facts = data.facts, cik = data.cik;
-        var factItems = [];
+        var factsByKey = new Map();
+        var keyIndex = 0;
+        var createKey = function (params) {
+            if (!filterDuplicates)
+                return keyIndex++;
+            var start = params.start, end = params.end, filed = params.filed, propertyName = params.propertyName;
+            return "".concat(start !== null && start !== void 0 ? start : '', "_").concat(end, "_").concat(filed, "_").concat(propertyName);
+        };
         for (var prefix in facts) {
             var factByPropertyName = facts[prefix];
             for (var propertyName in factByPropertyName) {
@@ -15,6 +26,7 @@ var FactRecordBuilder = /** @class */ (function () {
                     for (var _i = 0, factValues_1 = factValues; _i < factValues_1.length; _i++) {
                         var factValue = factValues_1[_i];
                         var end = factValue.end, start = factValue.start, val = factValue.val, filed = factValue.filed, accn = factValue.accn, form = factValue.form, fp = factValue.fp, frame = factValue.frame, fy = factValue.fy;
+                        var mapKey = createKey({ propertyName: propertyName, end: end, filed: filed, start: start });
                         var name_1 = "".concat(prefix, ":").concat(propertyName);
                         var item = {
                             cik: cik,
@@ -37,12 +49,22 @@ var FactRecordBuilder = /** @class */ (function () {
                             item.frame = frame;
                         if (fy)
                             item.fy = fy;
-                        factItems.push(item);
+                        var prevFact = factsByKey.get(mapKey);
+                        if (!prevFact) {
+                            factsByKey.set(mapKey, item);
+                            continue;
+                        }
+                        // use whichever is closer to the report end date
+                        var shouldPush = new Date(item.filed).getTime() - new Date(item.end).getTime() <
+                            new Date(prevFact.filed).getTime() - new Date(prevFact.end).getTime();
+                        if (shouldPush) {
+                            factsByKey.set(mapKey, item);
+                        }
                     }
                 }
             }
         }
-        return { facts: factItems };
+        return { facts: Array.from(factsByKey.values()) };
     };
     return FactRecordBuilder;
 }());

package/build/services/ReportBuilder/FactSplitAdjuster.d.ts

@@ -6,10 +6,15 @@ interface SplitData {
     value: number;
     firstFiled: string;
     fiscalYear: number;
+    fiscalPeriod: FiscalPeriod;
 }
 type FactItemWithFiscalsNumeric = Omit<FactItemWithFiscals, 'cik' | 'value'> & {
     value: number;
 };
+/**
+ * Adjust share-based property values for splits. Checks where the split was applied,
+ * and adjusts all previously filed share facts accordingly.
+ */
 export default class FactSplitAdjuster {
     private readonly splitKey;
     private readonly splitByFiscalYearAmount;
@@ -18,10 +23,16 @@ export default class FactSplitAdjuster {
     private readonly resolvedProperties;
     private sortedSplits;
     private getMap;
-    add(fact: FactItemWithFiscalsNumeric): void;
+    private filedFirstLastBySplitKey;
+    add(fact: FactItemWithFiscalsNumeric & {
+        filedLast?: string;
+    }): void;
     getSplitsAsc(): SplitData[];
     isSplitProperty(propertyName: string): boolean;
     addSplitData(data: Omit<SplitData, 'firstFiled'>): void;
+    /**
+     * TODO: Find a more reliable way of checking if the split has already been applied.
+     */
     private didApplySplit;
     isSplitAdjustableUnit(unit: string): boolean;
     isShareRatioUnit(unit: string): boolean;

package/build/services/ReportBuilder/FactSplitAdjuster.js

@@ -11,6 +11,10 @@ var __assign = (this && this.__assign) || function () {
     return __assign.apply(this, arguments);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Adjust share-based property values for splits. Checks where the split was applied,
+ * and adjusts all previously filed share facts accordingly.
+ */
 var FactSplitAdjuster = /** @class */ (function () {
     function FactSplitAdjuster() {
         this.splitKey = 'StockholdersEquityNoteStockSplitConversionRatio1';
@@ -19,15 +23,17 @@ var FactSplitAdjuster = /** @class */ (function () {
         this.factsAnnaulByYearByPropertyName = new Map();
         this.resolvedProperties = new Set();
         this.sortedSplits = null;
+        this.filedFirstLastBySplitKey = new Map();
     }
     FactSplitAdjuster.prototype.getMap = function (map, propertyName) {
         var _a;
         return (_a = map.get(propertyName)) !== null && _a !== void 0 ? _a : map.set(propertyName, new Map()).get(propertyName);
     };
     FactSplitAdjuster.prototype.add = function (fact) {
+        var _a;
         var propertyName = fact.name, year = fact.year, fiscalPeriod = fact.fiscalPeriod, unit = fact.unit, filed = fact.filed, value = fact.value, end = fact.end;
         if (this.isSplitProperty(propertyName)) {
-            this.addSplitData({ end: end, filed: filed, fiscalYear: year, value: Number(value) });
+            this.addSplitData({ end: end, filed: filed, fiscalYear: year, value: Number(value), fiscalPeriod: fiscalPeriod });
             return;
         }
         if (!this.isSplitAdjustableUnit(unit))
@@ -40,6 +46,10 @@ var FactSplitAdjuster = /** @class */ (function () {
             ? this.getMap(this.factsAnnaulByYearByPropertyName, propertyName)
             : this.getMap(this.factsByYearQuarterByPropertyName, propertyName);
         var key = "".concat(year, "_").concat(fiscalPeriod);
+        this.filedFirstLastBySplitKey.set(key, {
+            firstFiled: filed,
+            lastFiled: (_a = fact.filedLast) !== null && _a !== void 0 ? _a : filed,
+        });
         map.set(key, fact);
     };
     FactSplitAdjuster.prototype.getSplitsAsc = function () {
@@ -84,23 +94,30 @@ var FactSplitAdjuster = /** @class */ (function () {
             this.sortedSplits = null;
         }
     };
+    /**
+     * TODO: Find a more reliable way of checking if the split has already been applied.
+     */
     FactSplitAdjuster.prototype.didApplySplit = function (params) {
-        var nextValue = params.nextValue, prevValue = params.prevValue, split = params.split, isShareRatio = params.isShareRatio, value = params.value, filed = params.filed;
-        if (filed > split.filed) {
+        var _a;
+        var isShareRatio = params.isShareRatio, nextFact = params.nextFact, prevFact = params.prevFact, fact = params.fact, split = params.split;
+        var _b = (_a = this.filedFirstLastBySplitKey.get("".concat(split.fiscalYear, "_").concat(split.fiscalPeriod))) !== null && _a !== void 0 ? _a : {}, firstFiled = _b.firstFiled, lastFiled = _b.lastFiled;
+        if (fact.filed > lastFiled) {
             return true;
         }
-        if (filed < split.firstFiled) {
+        if (fact.filed < firstFiled) {
             return false;
         }
-        var valWithSplit = isShareRatio ? value / split.value : value * split.value;
-        if (nextValue !== null) {
-            var difference = Math.abs(nextValue - value);
-            var differenceSplit = Math.abs(nextValue - valWithSplit);
+        var val = fact.value;
+        var splitVal = split.value;
+        var valWithSplit = isShareRatio ? splitVal * val : val / splitVal;
+        if (nextFact) {
+            var difference = Math.abs(nextFact.value - val);
+            var differenceSplit = Math.abs(nextFact.value - valWithSplit);
             return difference < differenceSplit;
         }
-        if (prevValue !== null) {
-            var difference = Math.abs(prevValue - value);
-            var differenceSplit = Math.abs(prevValue - valWithSplit);
+        if (prevFact) {
+            var difference = Math.abs(prevFact.value - val);
+            var differenceSplit = Math.abs(prevFact.value - valWithSplit);
             return difference < differenceSplit;
         }
         return false;
@@ -154,7 +171,7 @@ var FactSplitAdjuster = /** @class */ (function () {
         });
     };
     FactSplitAdjuster.prototype.adjustValuesForSplits = function (params) {
-        var _a, _b, _c, _d;
+        var _a, _b;
         var facts = params.facts;
         var splits = this.getSplitsAsc();
         if (facts.length === 0 || splits.length === 0)
@@ -165,17 +182,22 @@ var FactSplitAdjuster = /** @class */ (function () {
             for (var factIndex = facts.length - 1; factIndex >= 0; factIndex--) {
                 var fact = facts[factIndex];
                 var value = fact.value, filed = fact.filed;
-                var nextValue = (_b = (_a = facts[factIndex + 1]) === null || _a === void 0 ? void 0 : _a.value) !== null && _b !== void 0 ? _b : null;
-                var prevValue = (_d = (_c = facts[factIndex - 1]) === null || _c === void 0 ? void 0 : _c.value) !== null && _d !== void 0 ? _d : null;
+                var nextFact = (_a = facts[factIndex + 1]) !== null && _a !== void 0 ? _a : null;
+                var prevFact = (_b = facts[factIndex - 1]) !== null && _b !== void 0 ? _b : null;
+                // const nextValue = facts[factIndex + 1]?.value ?? null
+                // const prevValue = facts[factIndex - 1]?.value ?? null
                 var didApplySplit = this.didApplySplit({
-                    filed: filed,
+                    // filed,
                     isShareRatio: isShareRatio,
-                    nextValue: nextValue,
-                    prevValue: prevValue,
+                    // nextValue,
+                    // prevValue,
+                    fact: fact,
+                    nextFact: nextFact,
+                    prevFact: prevFact,
                     split: split,
-                    value: value,
+                    // value,
                 });
-                if (didApplySplit) {
+                if (didApplySplit || !split.value) {
                     continue;
                 }
                 if (isShareRatio) {

package/build/services/ReportBuilder/ReportBuilder.d.ts

@@ -25,6 +25,9 @@ export interface FactItemWithFiscals extends FactItem {
     fiscalPeriod: FiscalPeriod;
     year: number;
 }
+/**
+ * Builds ReportRaw objects from facts. also applies splits and adjusts for fiscal periods.
+ */
 export default class ReportBuilder {
     private readonly factRecordBuilder;
     createFacts(companyFacts: CompanyFactListData): {