sec-edgar-api 0.1.0 → 0.2.1

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Andrew Evers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -24,12 +24,14 @@ Reports are all returned as a uniform interface:
 
 ```TS
 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
@@ -114,8 +116,6 @@ const reports = await secEdgarApi.getReports({ symbol: 'AAPL' })
 
 ## Resolvers
 
-**WARNING** Still in testing. Values may not be accurate for all companies since the properties provided in the reports differ.
-
 The main problem with the edgar API is that the property names and data provided are not uniform. You have to deal with companies omitting important data
 in some filings, or using different property keys for the same data point.
 

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

@@ -1,4 +1,4 @@
-import { InsiderTransaction, XMLParams } from '../../types';
+import { XMLParams } from '../../types';
 import XMLParser from './XMLParser';
 import parsers from './parsers';
 interface DocumentParserArgs {
@@ -9,8 +9,9 @@ export default class DocumentParser {
     private readonly parser;
     private readonly parsersByName;
     constructor(args?: DocumentParserArgs);
-    parseInsiderTransactions(params: XMLParams): InsiderTransaction[];
-    parseHolders(params: XMLParams): import("../../types").Holder[];
-    parseEarningsTables(params: XMLParams): import("../../types").TableData[];
+    parseForm4(params: XMLParams): import("../../types").Form4Data;
+    parseForm13g(params: XMLParams): import("../../types").Form13GData;
+    parseForm10k(params: XMLParams): import("../../types").Form10KData;
+    parseFormDef14a(params: XMLParams): import("../../types").FormDef14aData;
 }
 export {};

package/build/services/DocumentParser/DocumentParser.js

@@ -8,15 +8,18 @@ var DocumentParser = /** @class */ (function () {
         this.parser = parser;
         this.parsersByName = parsersByName;
     }
-    DocumentParser.prototype.parseInsiderTransactions = function (params) {
+    DocumentParser.prototype.parseForm4 = function (params) {
         return this.parsersByName.parseForm4(params, this.parser);
     };
-    DocumentParser.prototype.parseHolders = function (params) {
+    DocumentParser.prototype.parseForm13g = function (params) {
         return this.parsersByName.parseForm13g(params, this.parser);
     };
-    DocumentParser.prototype.parseEarningsTables = function (params) {
+    DocumentParser.prototype.parseForm10k = function (params) {
         return this.parsersByName.parseForm10k(params, this.parser);
     };
+    DocumentParser.prototype.parseFormDef14a = function (params) {
+        return this.parsersByName.parseFormDef14a(params, this.parser);
+    };
     return DocumentParser;
 }());
 exports.default = DocumentParser;

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

@@ -1,7 +1,6 @@
 import { RowNode } from './RowNode';
 import { XMLNode } from './XMLNode';
 export declare class ColNode extends XMLNode {
-    private colSpan;
     private index;
     private topSiblings;
     private bottomSiblings;
@@ -15,4 +14,5 @@ export declare class ColNode extends XMLNode {
     getNextSibling(): ColNode | null;
     getPreviousSibling(): ColNode | null;
     getColSpan(): number;
+    getRowSpan(): number;
 }

package/build/services/DocumentParser/XMLNode/ColNode.js

@@ -21,7 +21,6 @@ var ColNode = /** @class */ (function (_super) {
     __extends(ColNode, _super);
     function ColNode() {
         var _this = _super !== null && _super.apply(this, arguments) || this;
-        _this.colSpan = null;
         _this.index = null;
         _this.topSiblings = [];
         _this.bottomSiblings = [];
@@ -63,11 +62,11 @@ var ColNode = /** @class */ (function (_super) {
     };
     ColNode.prototype.getColSpan = function () {
         var _a;
-        if (this.colSpan)
-            return this.colSpan;
-        var colSpan = Number((_a = this.getAttributes().colspan) !== null && _a !== void 0 ? _a : 1);
-        this.colSpan = colSpan;
-        return colSpan;
+        return Number((_a = this.getAttributes().colspan) !== null && _a !== void 0 ? _a : 1);
+    };
+    ColNode.prototype.getRowSpan = function () {
+        var _a;
+        return Number((_a = this.getAttributes().rowspan) !== null && _a !== void 0 ? _a : 1);
     };
     return ColNode;
 }(XMLNode_1.XMLNode));

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

@@ -1,3 +1,5 @@
+import { TableData } from '../../../types';
 import { XMLNode } from './XMLNode';
 export declare class DocumentNode extends XMLNode {
+    parseTables(): TableData[];
 }

package/build/services/DocumentParser/XMLNode/DocumentNode.js

@@ -14,14 +14,88 @@ var __extends = (this && this.__extends) || (function () {
         d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
     };
 })();
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DocumentNode = void 0;
+var HRNode_1 = require("./HRNode");
+var NonTableNode_1 = require("./NonTableNode");
+var TableNode_1 = require("./TableNode");
 var XMLNode_1 = require("./XMLNode");
 var DocumentNode = /** @class */ (function (_super) {
     __extends(DocumentNode, _super);
     function DocumentNode() {
         return _super !== null && _super.apply(this, arguments) || this;
     }
+    DocumentNode.prototype.parseTables = function () {
+        var _a, _b, _c, _d;
+        var nodes = this.getChildren();
+        var tables = nodes.filter(function (child) { return child instanceof TableNode_1.TableNode; });
+        var curSectionIndex = 0;
+        var sectionIndexByTable = new Map();
+        var tableDataArr = [];
+        // map the section index of each table. new section starts for each <hr> tag.
+        for (var _i = 0, nodes_1 = nodes; _i < nodes_1.length; _i++) {
+            var node = nodes_1[_i];
+            if (node instanceof TableNode_1.TableNode) {
+                sectionIndexByTable.set(node, curSectionIndex);
+            }
+            else if (node instanceof HRNode_1.HRNode) {
+                curSectionIndex++;
+            }
+        }
+        var _loop_1 = function (table) {
+            table.mergeHeader();
+            table.removeEmptyTopRows();
+            var siblingsPrev = table.getSiblings({
+                dir: 'previous',
+                stopAtType: NonTableNode_1.NonTableNode,
+                includeStopAtType: true,
+            });
+            var siblingsNext = table.getSiblings({ dir: 'next', stopAtType: NonTableNode_1.NonTableNode, includeStopAtType: true });
+            // set the title based on the bold text in the previous siblings
+            var title = siblingsPrev.map(function (s) { return s.extractBold(); }).join(' | ');
+            var textBefore = siblingsPrev.map(function (s) { return s.getText(); }).join('\n');
+            var textAfter = siblingsNext.map(function (s) { return s.getText(); }).join('\n');
+            var header = table.getHeaderRow();
+            var headerTable = header === null || header === void 0 ? void 0 : header.toTable();
+            var topRow = table.getChildren()[0];
+            var topRowTable = !header ? topRow === null || topRow === void 0 ? void 0 : topRow.toTable() : null;
+            var prevTable = tableDataArr[tableDataArr.length - 1];
+            var isSameTableSize = prevTable ? ((_a = prevTable === null || prevTable === void 0 ? void 0 : prevTable.rows[0]) === null || _a === void 0 ? void 0 : _a.length) === ((_b = topRowTable === null || topRowTable === void 0 ? void 0 : topRowTable[0]) === null || _b === void 0 ? void 0 : _b.length) : false;
+            var isSameSection = prevTable ? prevTable.sectionIndex === sectionIndexByTable.get(table) : false;
+            var isSharedHeader = !!topRowTable && table.getTitle() === '' && isSameTableSize && isSameSection;
+            // some tables will be in the same section directly below another table and expected to have the same header.
+            if (isSharedHeader) {
+                topRowTable.unshift(__spreadArray([], prevTable.rows[0], true));
+                table.setTitle(prevTable.title);
+            }
+            var rows = (_c = headerTable !== null && headerTable !== void 0 ? headerTable : topRowTable) !== null && _c !== void 0 ? _c : [];
+            if (rows.length === 0)
+                return "continue";
+            tableDataArr.push({
+                title: title.trim(),
+                sectionIndex: (_d = sectionIndexByTable.get(table)) !== null && _d !== void 0 ? _d : -1,
+                hasHeader: Boolean(header) || isSharedHeader,
+                textBefore: textBefore,
+                textAfter: textAfter,
+                rows: rows.filter(function (r) { return r.length === rows[0].length; }),
+            });
+        };
+        // create table arrays
+        for (var _e = 0, tables_1 = tables; _e < tables_1.length; _e++) {
+            var table = tables_1[_e];
+            _loop_1(table);
+        }
+        return tableDataArr;
+    };
     return DocumentNode;
 }(XMLNode_1.XMLNode));
 exports.DocumentNode = DocumentNode;

package/build/services/DocumentParser/XMLNode/RowNode.js

@@ -76,22 +76,33 @@ var RowNode = /** @class */ (function (_super) {
      * ```
      */
     RowNode.prototype.getTableFromCols = function () {
-        var tableRowCols = [];
+        var _a, _b, _c;
         var colIndexRanges = this.getChildren().map(function (col) { return [col.getIndex(), col.getIndex() + col.getColSpan()]; });
-        for (var _i = 0, _a = this.getParent().getChildren(); _i < _a.length; _i++) {
-            var row = _a[_i];
-            var rowCols = colIndexRanges.map(function () { return []; });
-            for (var _b = 0, _c = row.getChildren(); _b < _c.length; _b++) {
-                var col = _c[_b];
-                var _d = [col.getIndex(), col.getIndex() + col.getColSpan()], indexStart = _d[0], indexEnd = _d[1];
+        var rows = this.getParent().getChildren();
+        var tableRowCols = rows.map(function () { return colIndexRanges.map(function () { return []; }); });
+        for (var rowIndex = 0; rowIndex < rows.length; rowIndex++) {
+            var row = rows[rowIndex];
+            var colsShift = 0;
+            var _loop_1 = function (col) {
+                var _e = [col.getIndex(), col.getIndex() + col.getColSpan()], indexStart = _e[0], indexEnd = _e[1];
+                // 	// TODO: Instead of shifting cols here, just shift them in XMLParser when they are created
+                while ((_a = tableRowCols[rowIndex][colsShift]) === null || _a === void 0 ? void 0 : _a.some(function (c) { return c.getParent() !== col.getParent(); })) {
+                    colsShift++;
+                }
+                // tableRowCols
                 for (var i = 0; i < colIndexRanges.length; i++) {
-                    var _e = colIndexRanges[i], boundaryStart = _e[0], boundaryEnd = _e[1];
+                    var _f = colIndexRanges[i], boundaryStart = _f[0], boundaryEnd = _f[1];
                     if (indexEnd <= boundaryStart || indexStart >= boundaryEnd)
                         continue;
-                    rowCols[i].push(col);
+                    for (var j = rowIndex; j < rowIndex + col.getRowSpan(); j++) {
+                        (_c = (_b = tableRowCols[j]) === null || _b === void 0 ? void 0 : _b[i + colsShift]) === null || _c === void 0 ? void 0 : _c.push(col);
+                    }
                 }
+            };
+            for (var _i = 0, _d = row.getChildren(); _i < _d.length; _i++) {
+                var col = _d[_i];
+                _loop_1(col);
             }
-            tableRowCols.push(rowCols);
         }
         return tableRowCols;
     };
@@ -121,12 +132,11 @@ var RowNode = /** @class */ (function (_super) {
                 var nextCol = (_b = colArr[colArr.length - 1]) === null || _b === void 0 ? void 0 : _b.getNextSibling();
                 var isMissingPercentSign = (nextCol === null || nextCol === void 0 ? void 0 : nextCol.getText().includes('%')) && nextCol.parseValue() === null;
                 var isMissingParenthesis = (nextCol === null || nextCol === void 0 ? void 0 : nextCol.getText().includes(')')) && colText.includes('(') && !colText.includes(')');
-                var colTextTrimmed = isMissingParenthesis ? "".concat(colText.trim(), ")") : colText.trim();
-                colTextTrimmed = isMissingPercentSign ? "".concat(colText.trim(), "%") : colText.trim();
-                colTextTrimmed = this.parseValue(colTextTrimmed);
-                colTextTrimmed =
-                    typeof colTextTrimmed === 'string' ? colTextTrimmed.replace(/\s+/g, ' ') : colTextTrimmed;
-                colTextArr.push(colTextTrimmed);
+                var colValue = isMissingParenthesis ? "".concat(colText.trim(), ")") : colText.trim();
+                colValue = isMissingPercentSign ? "".concat(colText.trim(), "%") : colText.trim();
+                colValue = this.parseValue(colValue);
+                colValue = typeof colValue === 'string' ? colValue.replace(/\s+/g, ' ') : colValue;
+                colTextArr.push(colValue);
             }
             tableTextArr.push(colTextArr);
         }

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

@@ -1,4 +1,4 @@
-interface XMLNodeArgs {
+export interface XMLNodeArgs {
     path?: string;
     attributesStr?: string;
 }

package/build/services/DocumentParser/XMLNode/XMLNode.js

@@ -47,30 +47,40 @@ var XMLNode = /** @class */ (function () {
         return boldText.replace(/\s+/g, ' ').trim();
     };
     XMLNode.prototype.parseValue = function (str) {
+        var _a;
         if (str === void 0) { str = this.text; }
         if (str === null)
             return null;
         var text = str
-            .replace(/\n| | /g, ' ')
+            .replace(/ | |\n/g, ' ')
             .replace(/®/g, '')
             .replace(/–|—|—/g, '-')
-            .replace(/’|“|”/g, "'")
-            .replace(/\}\}\{\{/g, ' ')
-            .replace(/\{\{|\}\}/g, '')
+            .replace(/’|“|”|’/g, "'")
+            .replace(/(?<=\{\{).*(?=\}\})/g, function (match) { return "{{".concat(match.replace(/\{\{/g, '').replace(/\}\}/g, ''), "}}"); })
+            .replace(/\{\{+/g, '{{')
+            .replace(/\}\}+/g, '}}')
             .replace(/\s+/, ' ')
             .trim();
         if (str.replace(/&#8211;|&#8212;|&#x2014;/g, '-') === '-')
             return '-';
         if (text === '')
             return null;
-        var colNum = text.replace(/,|\(|\)|\%/g, '').trim();
+        var colNum = text
+            .replace(/,|\(|\)|\%/g, '')
+            .replace(/\{\{/g, '')
+            .replace(/\}\}/g, '')
+            .trim();
         if (colNum === '-' || colNum === '$')
             return null;
         colNum = colNum.replace(/\-|\$/g, '');
+        var hasNumBeforeParenthesis = Boolean(/\d+\s*(?=\()/.test(text));
+        colNum = hasNumBeforeParenthesis ? (_a = colNum.split(' ')[0]) === null || _a === void 0 ? void 0 : _a.trim() : colNum;
         if (!isNaN(Number(colNum))) {
             if (text.includes('%'))
                 return text.replace(/[^a-zA-Z\d\s:]/g, '') === '' ? null : text;
-            return text.includes('(') || text.includes('-') ? Number(colNum) * -1 : Number(colNum);
+            return (text.trim().includes('(') && !hasNumBeforeParenthesis) || text.includes('-')
+                ? Number(colNum) * -1
+                : Number(colNum);
         }
         return text;
     };

package/build/services/DocumentParser/XMLParser.js

@@ -203,21 +203,21 @@ var XMLParser = /** @class */ (function () {
         var boldPath = null;
         var pushColToRow = function (col) {
             var _a;
-            var colSpan = col.getColSpan();
             var colIndex = curRowCols.length;
             col.setIndex(colIndex);
-            for (var i = 0; i < colSpan; i++) {
-                curRowCols.push(col);
-            }
+            var colSpan = col.getColSpan();
+            Array.from({ length: colSpan }).forEach(function () { return curRowCols.push(col); });
             var topSibling = (_a = prevRowCols[colIndex]) !== null && _a !== void 0 ? _a : null;
             topSibling === null || topSibling === void 0 ? void 0 : topSibling.addBottomSibling(col);
         };
         this.iterateXML({
             xml: xml,
-            onCloseTag: function () {
-                var _a;
+            onCloseTag: function (_a) {
+                var _b;
+                var path = _a.path;
+                var tag = path.split('.').pop();
                 if ((curNode === null || curNode === void 0 ? void 0 : curNode.getPath()) === boldPath) {
-                    curNode === null || curNode === void 0 ? void 0 : curNode.setText("".concat((_a = curNode === null || curNode === void 0 ? void 0 : curNode.getText()) !== null && _a !== void 0 ? _a : '', "}}"));
+                    curNode === null || curNode === void 0 ? void 0 : curNode.setText("".concat((_b = curNode === null || curNode === void 0 ? void 0 : curNode.getText()) !== null && _b !== void 0 ? _b : '', "}}"));
                     boldPath = null;
                 }
             },
@@ -299,6 +299,7 @@ var XMLParser = /** @class */ (function () {
                 }
             },
         });
+        documentNode.setText(xml);
         return documentNode;
     };
     return XMLParser;

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

@@ -1,9 +1,11 @@
 import { parseForm4 } from './parse-form-4';
 import { parseForm13g } from './parse-form-13g';
 import { parseForm10k } from './parse-form-10k';
+import { parseFormDef14a } from './parse-form-def14a';
 declare const parsers: {
     parseForm4: typeof parseForm4;
     parseForm13g: typeof parseForm13g;
     parseForm10k: typeof parseForm10k;
+    parseFormDef14a: typeof parseFormDef14a;
 };
 export default parsers;

package/build/services/DocumentParser/parsers/index.js

@@ -3,9 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var parse_form_4_1 = require("./parse-form-4");
 var parse_form_13g_1 = require("./parse-form-13g");
 var parse_form_10k_1 = require("./parse-form-10k");
+var parse_form_def14a_1 = require("./parse-form-def14a");
 var parsers = {
     parseForm4: parse_form_4_1.parseForm4,
     parseForm13g: parse_form_13g_1.parseForm13g,
     parseForm10k: parse_form_10k_1.parseForm10k,
+    parseFormDef14a: parse_form_def14a_1.parseFormDef14a,
 };
 exports.default = parsers;

package/build/services/DocumentParser/parsers/parse-form-10k.d.ts

@@ -1,3 +1,3 @@
-import { TableData, XMLParams } from '../../../types';
+import { Form10KData, XMLParams } from '../../../types';
 import XMLParser from '../XMLParser';
-export declare function parseForm10k(params: XMLParams, xmlParser?: XMLParser): TableData[];
+export declare function parseForm10k(params: XMLParams, xmlParser?: XMLParser): Form10KData;

package/build/services/DocumentParser/parsers/parse-form-10k.js

@@ -1,78 +1,25 @@
 "use strict";
-var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
-    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
-        if (ar || !(i in from)) {
-            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
-            ar[i] = from[i];
+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 to.concat(ar || Array.prototype.slice.call(from));
+        return t;
+    };
+    return __assign.apply(this, arguments);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseForm10k = void 0;
-var HRNode_1 = require("../XMLNode/HRNode");
-var NonTableNode_1 = require("../XMLNode/NonTableNode");
-var TableNode_1 = require("../XMLNode/TableNode");
 var XMLParser_1 = require("../XMLParser");
 function parseForm10k(params, xmlParser) {
-    var _a, _b, _c, _d;
     if (xmlParser === void 0) { xmlParser = new XMLParser_1.default(); }
     var xml = params.xml;
     var doc = xmlParser.getDocumentNode({ xml: xml });
-    var nodes = doc.getChildren();
-    var tables = nodes.filter(function (child) { return child instanceof TableNode_1.TableNode; });
-    var curSectionIndex = 0;
-    var sectionIndexByTable = new Map();
-    var tableDataArr = [];
-    // map the section index of each table. new section starts for each <hr> tag.
-    for (var _i = 0, nodes_1 = nodes; _i < nodes_1.length; _i++) {
-        var node = nodes_1[_i];
-        if (node instanceof TableNode_1.TableNode) {
-            sectionIndexByTable.set(node, curSectionIndex);
-        }
-        else if (node instanceof HRNode_1.HRNode) {
-            curSectionIndex++;
-        }
-    }
-    var _loop_1 = function (table) {
-        table.mergeHeader();
-        table.removeEmptyTopRows();
-        var siblingsPrev = table.getSiblings({ dir: 'previous', stopAtType: NonTableNode_1.NonTableNode, includeStopAtType: true });
-        var siblingsNext = table.getSiblings({ dir: 'next', stopAtType: NonTableNode_1.NonTableNode, includeStopAtType: true });
-        // set the title based on the bold text in the previous siblings
-        var title = siblingsPrev.map(function (s) { return s.extractBold(); }).join(' | ');
-        var textBefore = siblingsPrev.map(function (s) { return s.getText(); }).join('\n');
-        var textAfter = siblingsNext.map(function (s) { return s.getText(); }).join('\n');
-        var header = table.getHeaderRow();
-        var headerTable = header === null || header === void 0 ? void 0 : header.toTable();
-        var topRow = table.getChildren()[0];
-        var topRowTable = !header ? topRow === null || topRow === void 0 ? void 0 : topRow.toTable() : null;
-        var prevTable = tableDataArr[tableDataArr.length - 1];
-        var isSameTableSize = prevTable ? ((_a = prevTable === null || prevTable === void 0 ? void 0 : prevTable.rows[0]) === null || _a === void 0 ? void 0 : _a.length) === ((_b = topRowTable === null || topRowTable === void 0 ? void 0 : topRowTable[0]) === null || _b === void 0 ? void 0 : _b.length) : false;
-        var isSameSection = prevTable ? prevTable.sectionIndex === sectionIndexByTable.get(table) : false;
-        var isSharedHeader = !!topRowTable && table.getTitle() === '' && isSameTableSize && isSameSection;
-        // some tables will be in the same section directly below another table and expected to have the same header.
-        if (isSharedHeader) {
-            topRowTable.unshift(__spreadArray([], prevTable.rows[0], true));
-            table.setTitle(prevTable.title);
-        }
-        var rows = (_c = headerTable !== null && headerTable !== void 0 ? headerTable : topRowTable) !== null && _c !== void 0 ? _c : [];
-        if (rows.length === 0)
-            return "continue";
-        tableDataArr.push({
-            title: title.trim(),
-            sectionIndex: (_d = sectionIndexByTable.get(table)) !== null && _d !== void 0 ? _d : -1,
-            hasHeader: Boolean(header) || isSharedHeader,
-            textBefore: textBefore,
-            textAfter: textAfter,
-            rows: rows.filter(function (r) { return r.length === rows[0].length; }),
-        });
-    };
-    // create table arrays
-    for (var _e = 0, tables_1 = tables; _e < tables_1.length; _e++) {
-        var table = tables_1[_e];
-        _loop_1(table);
-    }
-    return tableDataArr;
+    var tables = doc.parseTables().map(function (table) { return (__assign(__assign({}, table), { rows: table.rows.map(function (row) {
+            return row.map(function (col) { return (typeof col === 'string' ? col.replace(/\{\{/g, '').replace(/\}\}/g, '') : col); });
+        }) })); });
+    return { tables: tables };
 }
 exports.parseForm10k = parseForm10k;

package/build/services/DocumentParser/parsers/parse-form-13g.d.ts

@@ -1,8 +1,8 @@
-import { Holder, XMLParams } from '../../../types';
+import { Form13GData, XMLParams } from '../../../types';
 import XMLParser from '../XMLParser';
 /**
- * Form SC 13G - Holders
+ * Form SC 13G - Institutional Holders
  *
  * example at https://www.sec.gov/Archives/edgar/data/320193/000119312523038262/d382361dsc13ga.htm
  */
-export declare function parseForm13g(params: XMLParams, xmlParser?: XMLParser): Holder[];
+export declare function parseForm13g(params: XMLParams, xmlParser?: XMLParser): Form13GData;

package/build/services/DocumentParser/parsers/parse-form-13g.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseForm13g = void 0;
 var XMLParser_1 = require("../XMLParser");
 /**
- * Form SC 13G - Holders
+ * Form SC 13G - Institutional Holders
  *
  * example at https://www.sec.gov/Archives/edgar/data/320193/000119312523038262/d382361dsc13ga.htm
  */
@@ -83,6 +83,6 @@ function parseForm13g(params, xmlParser) {
     if (((_d = holders[holders.length - 1]) === null || _d === void 0 ? void 0 : _d.name) === '') {
         holders.pop();
     }
-    return holders;
+    return { holders: holders };
 }
 exports.parseForm13g = parseForm13g;

package/build/services/DocumentParser/parsers/parse-form-4.d.ts

@@ -1,8 +1,8 @@
-import { InsiderTransaction, XMLParams } from '../../../types';
+import { Form4Data, XMLParams } from '../../../types';
 import XMLParser from '../XMLParser';
 /**
  * Form 4 - Insider Transactions
  *
  * example at https://www.sec.gov/Archives/edgar/data/320193/000032019323000079/xslF345X05/wk-form4_1691533817.xml
  */
-export declare function parseForm4(params: XMLParams, xmlParser?: XMLParser): InsiderTransaction[];
+export declare function parseForm4(params: XMLParams, xmlParser?: XMLParser): Form4Data;

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

@@ -215,6 +215,6 @@ function parseForm4(params, xmlParser) {
         }
         transactions.push(transaction);
     }
-    return transactions;
+    return { transactions: transactions };
 }
 exports.parseForm4 = parseForm4;

package/build/services/DocumentParser/parsers/parse-form-def14a.d.ts

@@ -0,0 +1,8 @@
+import { FormDef14aData, XMLParams } from '../../../types';
+import XMLParser from '../XMLParser';
+/**
+ * Form DEF 14a - Proxy Statement
+ *
+ * example at https://www.sec.gov/Archives/edgar/data/320193/000130817923000019/laap2023_def14a.htm
+ */
+export declare function parseFormDef14a(params: XMLParams, xmlParser?: XMLParser): FormDef14aData;

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

@@ -0,0 +1,126 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseFormDef14a = void 0;
+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, 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 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);
+        });
+        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 indexNonEquity = getIndex('non-equity') === -1 ? getIndex('option') : getIndex('non-equity');
+            var indexOther = getIndex('other');
+            var indexTotal = getIndex('total');
+            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 _v = 0, _w = findCompensationTables(type); _v < _w.length; _v++) {
+            var table = _w[_v];
+            _loop_2(table);
+        }
+    }
+    return { executiveCompensation: compensationArr, holders: holderArr };
+}
+exports.parseFormDef14a = parseFormDef14a;

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

@@ -1,4 +1,4 @@
-import { CompanyFactFrame, CompanyFactListData, CompanyTickerItem, FieldDataResponse, Holder, InsiderTransaction, MultiCompanyFactFrame, ReportRaw, ReportTranslated, TableData } from '../../types';
+import { CompanyFactFrame, CompanyFactListData, CompanyTickerItem, FieldDataResponse, Form10KData, Form13GData, Form4Data, FormDef14aData, MultiCompanyFactFrame, ReportRaw, ReportTranslated } from '../../types';
 import { FilingListDetails, FilingListItemTranslated, SubmissionList } from '../../types/submission.type';
 import { IClient } from '../Client';
 import DocumentParser from '../DocumentParser';
@@ -187,23 +187,23 @@ export default class SecEdgarApi {
      * const submissions = await secEdgarApi.getSubmissions({ symbol: 'AAPL' })
      * const requestWrapper = secEdgarApi.createRequestInsiderTransactions({ symbol: 'AAPL', filings: submissions.filings.recent })
      *
-     * const transactions1 = (await requestWrapper.requestNext()).result // array of transactions from most recent doc
-     * const transactions2 = (await requestWrapper.requestNext()).result // array of transactions from second most recent doc
+     * const transactions1 = (await requestWrapper.requestNext()).result.transactions // array of transactions from most recent doc
+     * const transactions2 = (await requestWrapper.requestNext()).result.transactions // array of transactions from second most recent doc
      * ```
      */
-    createRequestInsiderTransactions(params: CreateRequestWrapperParams): SubmissionRequestWrapper<InsiderTransaction[]>;
+    createRequestInsiderTransactions(params: CreateRequestWrapperParams): SubmissionRequestWrapper<Form4Data>;
     /**
      * Used for getting institutional holders. extracts holders urls from submission list response, and parses the xml doc.
      *
      * ```ts
      * const submissions = await secEdgarApi.getSubmissions({ symbol: 'AAPL' })
-     * const requestWrapper = secEdgarApi.createRequestHolders({ symbol: 'AAPL', filings: submissions.filings.recent })
+     * const requestWrapper = secEdgarApi.createRequestInstitutionalHolders({ symbol: 'AAPL', filings: submissions.filings.recent })
      *
-     * const holders1 = (await requestWrapper.requestNext()).result // array of holders from most recent doc
-     * const holders2 = (await requestWrapper.requestNext()).result // array of holders from second most recent doc
+     * const holders1 = (await requestWrapper.requestNext()).result.holders // array of holders from most recent doc
+     * const holders2 = (await requestWrapper.requestNext()).result.holders // array of holders from second most recent doc
      * ```
      */
-    createRequestHolders(params: CreateRequestWrapperParams): SubmissionRequestWrapper<Holder[]>;
+    createRequestInstitutionalHolders(params: CreateRequestWrapperParams): SubmissionRequestWrapper<Form13GData>;
     /**
      * Used for getting earnings report tables from submission files.
      *
@@ -211,10 +211,21 @@ export default class SecEdgarApi {
      * const submissions = await secEdgarApi.getSubmissions({ symbol: 'AAPL' })
      * const requestWrapper = secEdgarApi.createRequesEarningsReports({ symbol: 'AAPL', filings: submissions.filings.recent })
      *
-     * const tables1 = (await requestWrapper.requestNext()).result // array of tables from most recent doc
-     * const tables2 = (await requestWrapper.requestNext()).result // array of tables from second most recent doc
+     * const tables1 = (await requestWrapper.requestNext()).result.tables // array of tables from most recent doc
+     * const tables2 = (await requestWrapper.requestNext()).result.tables // array of tables from second most recent doc
      * ```
      */
-    createRequestEarningsReports(params: CreateRequestWrapperParams): SubmissionRequestWrapper<TableData[]>;
+    createRequestEarningsReports(params: CreateRequestWrapperParams): SubmissionRequestWrapper<Form10KData>;
+    /**
+     * Proxy statement includes list of holders, executiveCompensation, and other tables. returns FormDef14aData
+     *
+     * ```ts
+     * const submissions = await secEdgarApi.getSubmissions({ symbol: 'AAPL' })
+     * const requestWrapper = secEdgarApi.createRequesProxyStatement({ symbol: 'AAPL', filings: submissions.filings.recent })
+     *
+     * const { holders, executiveCompensation } = (await requestWrapper.requestNext()).result
+     * ```
+     */
+    createRequestProxyStatement(params: CreateRequestWrapperParams): SubmissionRequestWrapper<FormDef14aData>;
 }
 export {};

package/build/services/SecEdgarApi/SecEdgarApi.js

@@ -366,8 +366,8 @@ var SecEdgarApi = /** @class */ (function () {
      * const submissions = await secEdgarApi.getSubmissions({ symbol: 'AAPL' })
      * const requestWrapper = secEdgarApi.createRequestInsiderTransactions({ symbol: 'AAPL', filings: submissions.filings.recent })
      *
-     * const transactions1 = (await requestWrapper.requestNext()).result // array of transactions from most recent doc
-     * const transactions2 = (await requestWrapper.requestNext()).result // array of transactions from second most recent doc
+     * const transactions1 = (await requestWrapper.requestNext()).result.transactions // array of transactions from most recent doc
+     * const transactions2 = (await requestWrapper.requestNext()).result.transactions // array of transactions from second most recent doc
      * ```
      */
     SecEdgarApi.prototype.createRequestInsiderTransactions = function (params) {
@@ -380,7 +380,7 @@ var SecEdgarApi = /** @class */ (function () {
             return __generator(this, function (_d) {
                 switch (_d.label) {
                     case 0:
-                        _b = (_a = this.documentParser).parseInsiderTransactions;
+                        _b = (_a = this.documentParser).parseForm4;
                         _c = {};
                         return [4 /*yield*/, this.getDocumentXMLByUrl(params)];
                     case 1: return [2 /*return*/, _b.apply(_a, [(_c.xml = _d.sent(), _c)])];
@@ -394,13 +394,13 @@ var SecEdgarApi = /** @class */ (function () {
      *
      * ```ts
      * const submissions = await secEdgarApi.getSubmissions({ symbol: 'AAPL' })
-     * const requestWrapper = secEdgarApi.createRequestHolders({ symbol: 'AAPL', filings: submissions.filings.recent })
+     * const requestWrapper = secEdgarApi.createRequestInstitutionalHolders({ symbol: 'AAPL', filings: submissions.filings.recent })
      *
-     * const holders1 = (await requestWrapper.requestNext()).result // array of holders from most recent doc
-     * const holders2 = (await requestWrapper.requestNext()).result // array of holders from second most recent doc
+     * const holders1 = (await requestWrapper.requestNext()).result.holders // array of holders from most recent doc
+     * const holders2 = (await requestWrapper.requestNext()).result.holders // array of holders from second most recent doc
      * ```
      */
-    SecEdgarApi.prototype.createRequestHolders = function (params) {
+    SecEdgarApi.prototype.createRequestInstitutionalHolders = function (params) {
         var _this = this;
         var submissions = this.getCreateRequestSubmissions(params, ['SC 13G', 'SC 13G/A']);
         var options = { maxRequests: params.maxRequests };
@@ -410,7 +410,7 @@ var SecEdgarApi = /** @class */ (function () {
             return __generator(this, function (_d) {
                 switch (_d.label) {
                     case 0:
-                        _b = (_a = this.documentParser).parseHolders;
+                        _b = (_a = this.documentParser).parseForm13g;
                         _c = {};
                         return [4 /*yield*/, this.getDocumentXMLByUrl(params)];
                     case 1: return [2 /*return*/, _b.apply(_a, [(_c.xml = _d.sent(), _c)])];
@@ -426,8 +426,8 @@ var SecEdgarApi = /** @class */ (function () {
      * const submissions = await secEdgarApi.getSubmissions({ symbol: 'AAPL' })
      * const requestWrapper = secEdgarApi.createRequesEarningsReports({ symbol: 'AAPL', filings: submissions.filings.recent })
      *
-     * const tables1 = (await requestWrapper.requestNext()).result // array of tables from most recent doc
-     * const tables2 = (await requestWrapper.requestNext()).result // array of tables from second most recent doc
+     * const tables1 = (await requestWrapper.requestNext()).result.tables // array of tables from most recent doc
+     * const tables2 = (await requestWrapper.requestNext()).result.tables // array of tables from second most recent doc
      * ```
      */
     SecEdgarApi.prototype.createRequestEarningsReports = function (params) {
@@ -440,7 +440,36 @@ var SecEdgarApi = /** @class */ (function () {
             return __generator(this, function (_d) {
                 switch (_d.label) {
                     case 0:
-                        _b = (_a = this.documentParser).parseEarningsTables;
+                        _b = (_a = this.documentParser).parseForm10k;
+                        _c = {};
+                        return [4 /*yield*/, this.getDocumentXMLByUrl(params)];
+                    case 1: return [2 /*return*/, _b.apply(_a, [(_c.xml = _d.sent(), _c)])];
+                }
+            });
+        }); };
+        return new RequestWrapper_1.default({ submissions: submissions, options: options, sendRequest: sendRequest });
+    };
+    /**
+     * Proxy statement includes list of holders, executiveCompensation, and other tables. returns FormDef14aData
+     *
+     * ```ts
+     * const submissions = await secEdgarApi.getSubmissions({ symbol: 'AAPL' })
+     * const requestWrapper = secEdgarApi.createRequesProxyStatement({ symbol: 'AAPL', filings: submissions.filings.recent })
+     *
+     * const { holders, executiveCompensation } = (await requestWrapper.requestNext()).result
+     * ```
+     */
+    SecEdgarApi.prototype.createRequestProxyStatement = function (params) {
+        var _this = this;
+        var submissions = this.getCreateRequestSubmissions(params, ['DEF 14A']);
+        var options = { maxRequests: params.maxRequests };
+        var sendRequest = function (params) { return __awaiter(_this, void 0, void 0, function () {
+            var _a, _b;
+            var _c;
+            return __generator(this, function (_d) {
+                switch (_d.label) {
+                    case 0:
+                        _b = (_a = this.documentParser).parseFormDef14a;
                         _c = {};
                         return [4 /*yield*/, this.getDocumentXMLByUrl(params)];
                     case 1: return [2 /*return*/, _b.apply(_a, [(_c.xml = _d.sent(), _c)])];

package/build/types/parsed-filings.type.d.ts

@@ -44,7 +44,7 @@ export interface InsiderTransaction {
     ownership: string;
     explainationByKey: Partial<Record<keyof InsiderTransaction, string>>;
 }
-export interface Holder {
+export interface InstitutionalHolder {
     name: string;
     origin: string;
     shares: number;
@@ -63,4 +63,34 @@ export interface TableData {
     sectionIndex: number;
     rows: (string | number | null)[][];
 }
+export interface ExecutiveCompensation {
+    name: string;
+    position: string | null;
+    year: number | null;
+    salaryDollars: number | null;
+    bonusDollars: number | null;
+    stockAwardDollars: number | null;
+    nonEquityDollars: number | null;
+    otherDollars: number | null;
+    totalDollars: number | null;
+}
+export interface Holder {
+    name: string;
+    position: string | null;
+    shares: number | null;
+    percentOfClass: string | null;
+}
+export interface Form4Data {
+    transactions: InsiderTransaction[];
+}
+export interface Form10KData {
+    tables: TableData[];
+}
+export interface Form13GData {
+    holders: InstitutionalHolder[];
+}
+export interface FormDef14aData {
+    executiveCompensation: ExecutiveCompensation[];
+    holders: Holder[];
+}
 export {};

package/package.json

@@ -1,11 +1,11 @@
 {
     "name": "sec-edgar-api",
-    "version": "0.1.0",
+    "version": "0.2.1",
     "description": "Fetch and parse SEC earnings reports and other filings. Useful for financial analysis.",
     "main": "build/index.js",
     "author": "Andrew Evers (https://github.com/andyevers)",
     "homepage": "https://github.com/andyevers/sec-edgar-api#readme",
-    "license": "ISC",
+    "license": "MIT",
     "repository": {
         "type": "git",
         "url": "git+https://github.com/andyevers/sec-edgar-api.git"