sec-edgar-api 0.5.0 → 0.5.1

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.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/ReportParser/ReportResolvable.d.ts

@@ -19,8 +19,6 @@ export default class ReportResolvable {
     constructor(args: {
         report: Record<string, string | number | null | boolean>;
         calculationMap?: CalculationMap;
-        /** Used for member facts */
-        pathSeparator?: string;
     });
     getMap(): CalculationMap;
     clearCache(): void;

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

@@ -336,6 +336,8 @@ export default class SecEdgarApi {
     }>;
     /**
      * Search for companies from by name, sic code, or state.
+     *
+     * example at https://www.sec.gov/cgi-bin/browse-edgar?action=getcompany&owner=exclude&&start=0&count=100&hidefilings=0&company=Apple&match=contains
      */
     searchCompanies(params: SearchCompaniesParams): Promise<{
         items: import("../../types").CompanySearchResult[];

package/build/services/SecEdgarApi/SecEdgarApi.js

@@ -701,6 +701,8 @@ var SecEdgarApi = /** @class */ (function () {
     };
     /**
      * Search for companies from by name, sic code, or state.
+     *
+     * example at https://www.sec.gov/cgi-bin/browse-edgar?action=getcompany&owner=exclude&&start=0&count=100&hidefilings=0&company=Apple&match=contains
      */
     SecEdgarApi.prototype.searchCompanies = function (params) {
         return __awaiter(this, void 0, void 0, function () {

package/build/types/company-search.type.d.ts

@@ -1,5 +1,7 @@
 export interface CompanySearchResult {
     cik: number;
+    sic: number | null;
+    sicDescription: string | null;
     companyName: string;
-    stateOrCountry: string;
+    stateOrCountry: string | null;
 }

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

@@ -11,6 +11,7 @@ export interface FilingItemXBRL {
     title: string;
     link: string;
     guid: string;
+    url: string;
     enclosureUrl: string;
     enclosureLength: number;
     enclosureType: string;

package/build/types/insider-transaction.type.d.ts

@@ -1,3 +1,4 @@
+export type TransactionCode = 'S' | 'V' | 'A' | 'D' | 'F' | 'I' | 'M' | 'C' | 'E' | 'H' | 'O' | 'X' | 'G' | 'L' | 'W' | 'Z' | 'J' | 'K' | 'U';
 export interface Owner {
     ownerName: string;
     ownerCik: number;
@@ -22,7 +23,29 @@ export interface InsiderTransaction {
     isDirectOwnership: boolean;
     securityTitle: string;
     transactionDate: string;
-    transactionCode: string;
+    /**
+     * ### Transaction Codes
+     * - S: Sale
+     * - V: Voluntary Reporting
+     * - A: Grant
+     * - D: Sale to Issuer
+     * - F: Payment of Exercise Price
+     * - I: Discretionary Transaction
+     * - M: Conversion of Derivative Exempt
+     * - C: Conversion of Derivative
+     * - E: Expiration of Short Derivative Position
+     * - H: Expiration of Long Derivative Position
+     * - O: Exercise of out-of-the-money Derivative
+     * - X: Exercise of in-the-money Derivative
+     * - G: Gift
+     * - L: Small Acquisition
+     * - W: Acquisition or Disposition By Will or Laws
+     * - Z: Voting Trust Deposit or Withdrawal
+     * - J: Other Acquisition or Disposition
+     * - K: Equity Swap
+     * - U: Disposition Change in Control
+     */
+    transactionCode: TransactionCode;
     transactionShares: number;
     sharesOwnedFollowingTransaction: number;
     lineNumber: number;
@@ -30,3 +53,26 @@ export interface InsiderTransaction {
     form: string;
     accessionNumber: string;
 }
+export type TransactionType = 'Acquire' | 'Dispose';
+export interface InsiderTransactionExtended {
+    filerName: string;
+    filerPosition: string;
+    filerPositionTypes: string[];
+    securityType: string;
+    securityTypeUnderlying: string | null;
+    category: 'Derivative' | 'Non-Derivative';
+    date: string;
+    dateExecuted: string | null;
+    dateExpiration: string | null;
+    dateExercisable: string | null;
+    transactionDescription: string | null;
+    transactionCode: TransactionCode | null;
+    transactionType: TransactionType | null;
+    sharesEnding: number | null;
+    shares: number | null;
+    sharesUnderlying: number | null;
+    price: number | null;
+    priceExcercised: number | null;
+    ownership: string;
+    explainationByKey: Partial<Record<keyof InsiderTransactionExtended, string>>;
+}

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

@@ -1,49 +1,4 @@
-interface TransactionDescriptionByCode {
-    S: 'Sale';
-    V: 'Voluntary Reporting';
-    A: 'Grant';
-    D: 'Sale to Issuer';
-    F: 'Payment of Exercise Price';
-    I: 'Discretionary Transaction';
-    M: 'Conversion of Derivative Exempt';
-    C: 'Conversion of Derivative';
-    E: 'Expiration of Short Derivative Position';
-    H: 'Expiration of Long Derivative Position';
-    O: 'Exercise of out-of-the-money Derivative';
-    X: 'Exercise of in-the-money Derivative';
-    G: 'Gift';
-    L: 'Small Acquisition';
-    W: 'Acquisition or Disposition By Will or Laws';
-    Z: 'Voting Trust Deposit or Withdrawal';
-    J: 'Other Acquisition or Disposition';
-    K: 'Equity Swap';
-    U: 'Disposition Change in Control';
-}
-export type TransactionType = 'Acquire' | 'Dispose';
-export type TransactionCode = keyof TransactionDescriptionByCode;
-export type TransactionDescription = TransactionDescriptionByCode[TransactionCode];
-export interface InsiderTransactionExtended {
-    filerName: string;
-    filerPosition: string;
-    filerPositionTypes: string[];
-    securityType: string;
-    securityTypeUnderlying: string | null;
-    category: 'Derivative' | 'Non-Derivative';
-    date: string;
-    dateExecuted: string | null;
-    dateExpiration: string | null;
-    dateExercisable: string | null;
-    transactionDescription: string | null;
-    transactionCode: TransactionCode | null;
-    transactionType: TransactionType | null;
-    sharesEnding: number | null;
-    shares: number | null;
-    sharesUnderlying: number | null;
-    price: number | null;
-    priceExcercised: number | null;
-    ownership: string;
-    explainationByKey: Partial<Record<keyof InsiderTransactionExtended, string>>;
-}
+import type { InsiderTransactionExtended } from './insider-transaction.type';
 export interface InstitutionalHolder {
     name: string;
     origin: string;
@@ -94,4 +49,3 @@ export interface FormDef14aData {
     holders: Holder[];
 }
 export type DailyFilingFormType = '10-K' | '10-Q' | '8-K' | '14' | '485' | 'S-8' | 'ALL';
-export {};

package/package.json

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