sec-edgar-api 1.0.2 → 1.0.3

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

@@ -2,6 +2,7 @@ import type { XbrlLinkbase } from '../../../types';
 import XMLParser from '../XMLParser';
 export default class LinkbaseParser {
     private readonly xmlParser;
+    private readonly objectUtil;
     constructor(args?: {
         xmlParser?: XMLParser;
     });

package/build/services/DocumentParser/XBRLParser/LinkbaseParser.js

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+var ObjectUtil_1 = require("../ObjectUtil");
 var XMLParser_1 = require("../XMLParser");
 var util_xbrl_1 = require("./util-xbrl");
 var LinkbaseParser = /** @class */ (function () {
     function LinkbaseParser(args) {
+        this.objectUtil = new ObjectUtil_1.default();
         var _a = (args !== null && args !== void 0 ? args : {}).xmlParser, xmlParser = _a === void 0 ? new XMLParser_1.default() : _a;
         this.xmlParser = xmlParser;
     }
@@ -12,6 +14,7 @@ var LinkbaseParser = /** @class */ (function () {
         return this.parseLinkbaseDocument(parsed);
     };
     LinkbaseParser.prototype.parseLinkbaseDocument = function (value) {
+        var _this = this;
         value = util_xbrl_1.default.toObject(value);
         for (var key in value) {
             var parsedKey = util_xbrl_1.default.parseKey(key);
@@ -20,7 +23,16 @@ var LinkbaseParser = /** @class */ (function () {
                     return this.parseLinkbase(value[key]);
             }
         }
-        return null;
+        // if linkbase is not found, try iterating through keys to find it
+        var linkbase = null;
+        this.objectUtil.iterateKeysDeep(value, function (d) {
+            var k = util_xbrl_1.default.parseKey(d.key);
+            if (k === 'linkbase') {
+                d.breakLoop();
+                linkbase = _this.parseLinkbase(d.value);
+            }
+        });
+        return linkbase;
     };
     LinkbaseParser.prototype.parseItem = function (value) {
         value = util_xbrl_1.default.toObject(value);

package/build/util/util-xbrl.js

@@ -31,7 +31,22 @@ function getLabelByTaxonomy(labelLinkbase) {
     return labelByTaxonomy;
 }
 exports.getLabelByTaxonomy = getLabelByTaxonomy;
+function isPascaleCase(str) {
+    var startsWithUpperCase = str && str[0].toLowerCase() !== str[0];
+    return startsWithUpperCase && str.split('').some(function (c) { return c.toLowerCase() === c; });
+}
+var knownPrefixes = {
+    'us-gaap': true,
+    'ifrs-full': true,
+    dei: true,
+    srt: true,
+    country: true,
+};
 function getTaxonomyFromId(id) {
-    return id.split('_').slice(1, 3).join(':');
+    var parts = id.split('_');
+    var isLabelIndicatorPosition3 = parts[2] === 'lbl';
+    var isKnownPrefixPosition1 = knownPrefixes[parts[0]] === true;
+    var isNameInPosition2 = parts.length <= 2 || isLabelIndicatorPosition3 || isKnownPrefixPosition1 || isPascaleCase(parts[1]);
+    return isNameInPosition2 ? parts.slice(0, 2).join(':') : parts.slice(1, 3).join(':');
 }
 exports.getTaxonomyFromId = getTaxonomyFromId;

package/package.json

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