sec-edgar-api 0.4.0 → 0.4.2

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

@@ -1,5 +1,5 @@
 import { XMLParams } from '../../types';
-import { ParseXbrlOptions } from './XBRLParser/XBRLParser';
+import { GetDocumentXbrlParams } from '../SecEdgarApi';
 import XMLParser from './XMLParserLegacy';
 import parsers from './parsers';
 interface DocumentParserArgs {
@@ -36,11 +36,10 @@ export default class DocumentParser {
     };
     parseCurrentFilings(params: XMLParams): import("../../types").CurrentFilingsList;
     parseCurrentFilingsXbrl(params: XMLParams): import("../../types").CurrentFilingsXBRL;
-    parseXbrl(params: XMLParams & ParseXbrlOptions & {
-        includeReport?: boolean;
-    }): import("./XBRLParser/XBRLParser").XbrlParseResult & {
+    parseXbrl(params: XMLParams & GetDocumentXbrlParams): import("./XBRLParser/XBRLParser").XbrlParseResult & {
         report: import("../../types").ReportRaw | null;
         facts: import("../../types").FactItem[];
+        xml: string;
     };
 }
 export {};

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

@@ -1,52 +1,52 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 var XMLParser_1 = require("../XMLParser");
-var util_type_1 = require("./util-type");
+var util_xbrl_1 = require("./util-xbrl");
 var InstanceParser = /** @class */ (function () {
     function InstanceParser() {
         this.xmlParser = new XMLParser_1.default();
     }
     InstanceParser.prototype.parseContext = function (node) {
         var _a, _b, _c, _d, _e, _f, _g;
-        var context = util_type_1.default.toObject(node);
-        var id = util_type_1.default.toString(context['@_id']);
-        var entity = util_type_1.default.toObject((_a = context['xbrli:entity']) !== null && _a !== void 0 ? _a : context['entity']);
-        var entityIdentifier = util_type_1.default.toObject((_b = entity['xbrli:identifier']) !== null && _b !== void 0 ? _b : entity['identifier']);
-        var entityIdentifierText = util_type_1.default.toString(entityIdentifier['#text']);
-        var entityIdentifierScheme = util_type_1.default.toString(entityIdentifier['@_scheme']);
-        var segment = util_type_1.default.toObject((_c = entity['xbrli:segment']) !== null && _c !== void 0 ? _c : entity['segment']);
-        var segmentExplicitMembers = util_type_1.default.toArray(segment['xbrldi:explicitMember']);
-        var segmentTypedMembers = util_type_1.default.toArray(segment['xbrldi:typedMember']);
+        var context = util_xbrl_1.default.toObject(node);
+        var id = util_xbrl_1.default.toString(context['@_id']);
+        var entity = util_xbrl_1.default.toObject((_a = context['xbrli:entity']) !== null && _a !== void 0 ? _a : context['entity']);
+        var entityIdentifier = util_xbrl_1.default.toObject((_b = entity['xbrli:identifier']) !== null && _b !== void 0 ? _b : entity['identifier']);
+        var entityIdentifierText = util_xbrl_1.default.toString(entityIdentifier['#text']);
+        var entityIdentifierScheme = util_xbrl_1.default.toString(entityIdentifier['@_scheme']);
+        var segment = util_xbrl_1.default.toObject((_c = entity['xbrli:segment']) !== null && _c !== void 0 ? _c : entity['segment']);
+        var segmentExplicitMembers = util_xbrl_1.default.toArray(segment['xbrldi:explicitMember']);
+        var segmentTypedMembers = util_xbrl_1.default.toArray(segment['xbrldi:typedMember']);
         var segments = [];
         segmentTypedMembers.forEach(function (member) {
             var _a;
-            member = util_type_1.default.toObject(member);
+            member = util_xbrl_1.default.toObject(member);
             var dimension = (_a = member['@_dimension']) !== null && _a !== void 0 ? _a : '';
             segments.push({
-                value: util_type_1.default.toString(member["".concat(dimension, ".domain")]),
-                dimension: util_type_1.default.toString(dimension),
+                value: util_xbrl_1.default.toString(member["".concat(dimension, ".domain")]),
+                dimension: util_xbrl_1.default.toString(dimension),
             });
         });
         segmentExplicitMembers.forEach(function (member) {
-            member = util_type_1.default.toObject(member);
+            member = util_xbrl_1.default.toObject(member);
             segments.push({
-                value: util_type_1.default.toString(member['#text']),
-                dimension: util_type_1.default.toString(member['@_dimension']),
+                value: util_xbrl_1.default.toString(member['#text']),
+                dimension: util_xbrl_1.default.toString(member['@_dimension']),
             });
         });
-        var period = util_type_1.default.toObject((_d = context['xbrli:period']) !== null && _d !== void 0 ? _d : context['period']);
+        var period = util_xbrl_1.default.toObject((_d = context['xbrli:period']) !== null && _d !== void 0 ? _d : context['period']);
         var periodObj = {};
         var startDate = (_e = period['xbrli:startDate']) !== null && _e !== void 0 ? _e : period['startDate'];
         var endDate = (_f = period['xbrli:endDate']) !== null && _f !== void 0 ? _f : period['endDate'];
         var instant = (_g = period['xbrli:instant']) !== null && _g !== void 0 ? _g : period['instant'];
         if (startDate) {
-            periodObj.startDate = util_type_1.default.toString(startDate);
+            periodObj.startDate = util_xbrl_1.default.toString(startDate);
         }
         if (endDate) {
-            periodObj.endDate = util_type_1.default.toString(endDate);
+            periodObj.endDate = util_xbrl_1.default.toString(endDate);
         }
         if (instant) {
-            periodObj.instant = util_type_1.default.toString(instant);
+            periodObj.instant = util_xbrl_1.default.toString(instant);
         }
         return {
             id: id,
@@ -62,7 +62,7 @@ var InstanceParser = /** @class */ (function () {
     };
     InstanceParser.prototype.parse = function (xml) {
         var _this = this;
-        var _a, _b, _c;
+        var _a, _b;
         var contentLower = xml.toLowerCase();
         var indexXbrlStart = contentLower.indexOf('<xbrl');
         var indexXbrlEnd = contentLower.lastIndexOf('</xbrl');
@@ -70,12 +70,11 @@ var InstanceParser = /** @class */ (function () {
         if (indexXbrlStart === -1) {
             return { factElements: [], contexts: [], units: [] };
         }
-        var doc = this.xmlParser.parse(xbrlContent);
-        var xbrl = (_a = doc.xbrl) !== null && _a !== void 0 ? _a : doc.XBRL;
-        var contexts = util_type_1.default
-            .toArray((_b = xbrl === null || xbrl === void 0 ? void 0 : xbrl.context) !== null && _b !== void 0 ? _b : [])
+        var xbrl = util_xbrl_1.default.extractXbrlObject(this.xmlParser.parse(xbrlContent));
+        var contexts = util_xbrl_1.default
+            .toArray((_a = xbrl === null || xbrl === void 0 ? void 0 : xbrl.context) !== null && _a !== void 0 ? _a : [])
             .map(function (context) { return _this.parseContext(context); });
-        var units = util_type_1.default.toArray((_c = xbrl === null || xbrl === void 0 ? void 0 : xbrl.unit) !== null && _c !== void 0 ? _c : []).map(function (unit) {
+        var units = util_xbrl_1.default.toArray((_b = xbrl === null || xbrl === void 0 ? void 0 : xbrl.unit) !== null && _b !== void 0 ? _b : []).map(function (unit) {
             var _a, _b, _c;
             return ({
                 id: (_a = unit['@_id']) !== null && _a !== void 0 ? _a : '',
@@ -84,8 +83,8 @@ var InstanceParser = /** @class */ (function () {
         });
         var factElements = [];
         for (var name_1 in xbrl) {
-            for (var _i = 0, _d = util_type_1.default.toArray(xbrl[name_1]); _i < _d.length; _i++) {
-                var element = _d[_i];
+            for (var _i = 0, _c = util_xbrl_1.default.toArray(xbrl[name_1]); _i < _c.length; _i++) {
+                var element = _c[_i];
                 if (!element['@_contextRef'])
                     continue;
                 var factElement = { name: name_1, id: '', contextRef: '' };

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

@@ -1,21 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 var XMLParser_1 = require("../XMLParser");
-var util_type_1 = require("./util-type");
+var util_xbrl_1 = require("./util-xbrl");
 var LinkbaseParser = /** @class */ (function () {
     function LinkbaseParser(args) {
         var _a = (args !== null && args !== void 0 ? args : {}).xmlParser, xmlParser = _a === void 0 ? new XMLParser_1.default() : _a;
         this.xmlParser = xmlParser;
     }
     LinkbaseParser.prototype.parse = function (xml) {
-        var _a, _b;
-        var parsed = this.xmlParser.parse(xml);
-        return this.parseLinkbaseDocument((_b = (_a = parsed.XBRL) !== null && _a !== void 0 ? _a : parsed.xbrl) !== null && _b !== void 0 ? _b : parsed);
+        var parsed = util_xbrl_1.default.extractXbrlObject(this.xmlParser.parse(xml));
+        return this.parseLinkbaseDocument(parsed);
     };
     LinkbaseParser.prototype.parseLinkbaseDocument = function (value) {
-        value = util_type_1.default.toObject(value);
+        value = util_xbrl_1.default.toObject(value);
         for (var key in value) {
-            var parsedKey = util_type_1.default.parseKey(key);
+            var parsedKey = util_xbrl_1.default.parseKey(key);
             switch (parsedKey) {
                 case 'linkbase':
                     return this.parseLinkbase(value[key]);
@@ -24,21 +23,21 @@ var LinkbaseParser = /** @class */ (function () {
         return null;
     };
     LinkbaseParser.prototype.parseItem = function (value) {
-        value = util_type_1.default.toObject(value);
+        value = util_xbrl_1.default.toObject(value);
         var item = {};
         for (var key in value) {
-            var parsedKey = util_type_1.default.parseKey(key);
+            var parsedKey = util_xbrl_1.default.parseKey(key);
             switch (parsedKey) {
                 case 'closed':
-                    item[parsedKey] = util_type_1.default.toBoolean(value[key]);
+                    item[parsedKey] = util_xbrl_1.default.toBoolean(value[key]);
                     break;
                 case 'priority':
                 case 'order':
                 case 'weight':
-                    item[parsedKey] = util_type_1.default.toNumber(value[key]);
+                    item[parsedKey] = util_xbrl_1.default.toNumber(value[key]);
                     break;
                 default:
-                    item[parsedKey] = util_type_1.default.toString(value[key]);
+                    item[parsedKey] = util_xbrl_1.default.toString(value[key]);
                     break;
             }
         }
@@ -46,24 +45,24 @@ var LinkbaseParser = /** @class */ (function () {
     };
     LinkbaseParser.prototype.parseLinkbase = function (value) {
         var _this = this;
-        value = util_type_1.default.toObject(value);
+        value = util_xbrl_1.default.toObject(value);
         var linkbase = {};
         for (var key in value) {
-            var parsedKey = util_type_1.default.parseKey(key);
+            var parsedKey = util_xbrl_1.default.parseKey(key);
             switch (parsedKey) {
                 case 'referenceLink':
                 case 'labelLink':
                 case 'presentationLink':
                 case 'calculationLink':
                 case 'definitionLink':
-                    linkbase[parsedKey] = util_type_1.default.toArray(value[key]).map(function (v) { return _this.parseItemExtended(v); });
+                    linkbase[parsedKey] = util_xbrl_1.default.toArray(value[key]).map(function (v) { return _this.parseItemExtended(v); });
                     break;
                 case 'roleRef':
                 case 'arcroleRef':
-                    linkbase[parsedKey] = util_type_1.default.toArray(value[key]).map(function (v) { return _this.parseItem(v); });
+                    linkbase[parsedKey] = util_xbrl_1.default.toArray(value[key]).map(function (v) { return _this.parseItem(v); });
                     break;
                 default:
-                    linkbase[parsedKey] = util_type_1.default.toString(value[key]);
+                    linkbase[parsedKey] = util_xbrl_1.default.toString(value[key]);
                     break;
             }
         }
@@ -75,7 +74,7 @@ var LinkbaseParser = /** @class */ (function () {
             type: 'extended',
         };
         for (var key in value) {
-            var parsedKey = util_type_1.default.parseKey(key);
+            var parsedKey = util_xbrl_1.default.parseKey(key);
             switch (parsedKey) {
                 case 'loc':
                 case 'calculationArc':
@@ -85,10 +84,10 @@ var LinkbaseParser = /** @class */ (function () {
                 case 'footnoteArc':
                 case 'label':
                 case 'footnote':
-                    item[parsedKey] = util_type_1.default.toArray(value[key]).map(function (v) { return _this.parseItem(v); });
+                    item[parsedKey] = util_xbrl_1.default.toArray(value[key]).map(function (v) { return _this.parseItem(v); });
                     break;
                 default:
-                    item[parsedKey] = util_type_1.default.toString(value[key]);
+                    item[parsedKey] = util_xbrl_1.default.toString(value[key]);
                     break;
             }
         }

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

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 var XMLParser_1 = require("../XMLParser");
-var util_type_1 = require("./util-type");
+var util_xbrl_1 = require("./util-xbrl");
 /* eslint-disable @typescript-eslint/no-explicit-any */
 var SchemaParser = /** @class */ (function () {
     function SchemaParser() {
@@ -9,130 +9,128 @@ var SchemaParser = /** @class */ (function () {
     }
     SchemaParser.prototype.parseAppInfo = function (value) {
         var _this = this;
-        value = util_type_1.default.toObject(value);
+        value = util_xbrl_1.default.toObject(value);
         var appinfo = {};
         for (var key in value) {
-            var parsedKey = util_type_1.default.parseKey(key);
+            var parsedKey = util_xbrl_1.default.parseKey(key);
             switch (parsedKey) {
                 case 'roleType':
-                    appinfo.roleType = util_type_1.default.toArray(value[key]).map(function (v) { return _this.parseRoleType(v); });
+                    appinfo.roleType = util_xbrl_1.default.toArray(value[key]).map(function (v) { return _this.parseRoleType(v); });
                     break;
                 case 'linkbaseRef':
-                    appinfo.linkbaseRef = util_type_1.default.toArray(value[key]).map(function (v) { return _this.parseLinkbaseRef(v); });
+                    appinfo.linkbaseRef = util_xbrl_1.default.toArray(value[key]).map(function (v) { return _this.parseLinkbaseRef(v); });
                     break;
             }
         }
         return appinfo;
     };
     SchemaParser.prototype.parseRoleType = function (value) {
-        value = util_type_1.default.toObject(value);
+        value = util_xbrl_1.default.toObject(value);
         var roleType = {};
         for (var key in value) {
-            var parsedKey = util_type_1.default.parseKey(key);
+            var parsedKey = util_xbrl_1.default.parseKey(key);
             switch (parsedKey) {
                 case 'usedOn':
-                    roleType[parsedKey] = util_type_1.default.toArray(value[key]).map(function (v) { return util_type_1.default.toString(v['#text']); });
+                    roleType[parsedKey] = util_xbrl_1.default.toArray(value[key]).map(function (v) { return util_xbrl_1.default.toString(v['#text']); });
                     break;
                 default:
-                    roleType[parsedKey] = util_type_1.default.toString(value[key]);
+                    roleType[parsedKey] = util_xbrl_1.default.toString(value[key]);
                     break;
             }
         }
         return roleType;
     };
     SchemaParser.prototype.parseLinkbaseRef = function (value) {
-        value = util_type_1.default.toObject(value);
+        value = util_xbrl_1.default.toObject(value);
         var item = {};
         for (var key in value) {
-            var parsedKey = util_type_1.default.parseKey(key);
-            item[parsedKey] = util_type_1.default.toString(value[key]);
+            var parsedKey = util_xbrl_1.default.parseKey(key);
+            item[parsedKey] = util_xbrl_1.default.toString(value[key]);
         }
         return item;
     };
     SchemaParser.prototype.parseAnnotation = function (value) {
-        value = util_type_1.default.toObject(value);
+        value = util_xbrl_1.default.toObject(value);
         var annotation = {};
         for (var key in value) {
-            var parsedKey = util_type_1.default.parseKey(key);
+            var parsedKey = util_xbrl_1.default.parseKey(key);
             switch (parsedKey) {
                 case 'appinfo':
                     annotation.appinfo = this.parseAppInfo(value[key]);
                     break;
                 case 'documentation':
-                    annotation.documentation = util_type_1.default.toString(value[key]);
+                    annotation.documentation = util_xbrl_1.default.toString(value[key]);
                     break;
             }
         }
         return annotation;
     };
     SchemaParser.prototype.parseElement = function (value) {
-        value = util_type_1.default.toObject(value);
+        value = util_xbrl_1.default.toObject(value);
         var element = {
-            id: util_type_1.default.toString(value['@_id']),
-            name: util_type_1.default.toString(value['@_name']),
-            type: util_type_1.default.toString(value['@_type']),
+            id: util_xbrl_1.default.toString(value['@_id']),
+            name: util_xbrl_1.default.toString(value['@_name']),
+            type: util_xbrl_1.default.toString(value['@_type']),
         };
         for (var key in value) {
-            var parsedKey = util_type_1.default.parseKey(key);
-            switch (util_type_1.default.parseKey(key)) {
+            var parsedKey = util_xbrl_1.default.parseKey(key);
+            switch (util_xbrl_1.default.parseKey(key)) {
                 case 'abstract':
                 case 'nillable':
                 case 'headUsable':
-                    element[parsedKey] = util_type_1.default.toBoolean(value[key]);
+                    element[parsedKey] = util_xbrl_1.default.toBoolean(value[key]);
                     break;
                 case 'complexType':
                 case 'annotation':
-                    element[parsedKey] = util_type_1.default.toObject(value[key]);
+                    element[parsedKey] = util_xbrl_1.default.toObject(value[key]);
                     break;
                 default:
-                    element[parsedKey] = util_type_1.default.toString(value[key]);
+                    element[parsedKey] = util_xbrl_1.default.toString(value[key]);
                     break;
             }
         }
         return element;
     };
     SchemaParser.prototype.parseImport = function (value) {
-        value = util_type_1.default.toObject(value);
+        value = util_xbrl_1.default.toObject(value);
         return {
-            namespace: util_type_1.default.toString(value['@_namespace']),
-            schemaLocation: util_type_1.default.toString(value['@_schemaLocation']),
+            namespace: util_xbrl_1.default.toString(value['@_namespace']),
+            schemaLocation: util_xbrl_1.default.toString(value['@_schemaLocation']),
         };
     };
     SchemaParser.prototype.parse = function (xml) {
         var _this = this;
-        var _a, _b;
-        var parsed = this.xmlParser.parse(xml);
-        var xbrl = (_b = (_a = parsed.XBRL) !== null && _a !== void 0 ? _a : parsed.xbrl) !== null && _b !== void 0 ? _b : parsed;
+        var xbrl = util_xbrl_1.default.extractXbrlObject(this.xmlParser.parse(xml));
         var schemaRaw = null;
         for (var key in xbrl) {
-            if (util_type_1.default.parseKey(key) !== 'schema')
+            if (util_xbrl_1.default.parseKey(key) !== 'schema')
                 continue;
             schemaRaw = xbrl[key];
             break;
         }
         var value = schemaRaw === null ? xbrl : schemaRaw;
         var schema = {
-            xmlns: util_type_1.default.toString(value['@_xmlns']),
+            xmlns: util_xbrl_1.default.toString(value['@_xmlns']),
             _xmlnsProps: {},
         };
         for (var key in value) {
-            var parsedKey = util_type_1.default.parseKey(key);
+            var parsedKey = util_xbrl_1.default.parseKey(key);
             switch (parsedKey) {
                 case 'annotation':
                     schema.annotation = this.parseAnnotation(value[key]);
                     break;
                 case 'element':
-                    schema.element = util_type_1.default.toArray(value[key]).map(function (v) { return _this.parseElement(v); });
+                    schema.element = util_xbrl_1.default.toArray(value[key]).map(function (v) { return _this.parseElement(v); });
                     break;
                 case 'import':
-                    schema.import = util_type_1.default.toArray(value[key]).map(function (v) { return _this.parseImport(v); });
+                    schema.import = util_xbrl_1.default.toArray(value[key]).map(function (v) { return _this.parseImport(v); });
                     break;
                 default:
                     if (key.startsWith('@_xmlns:')) {
-                        schema._xmlnsProps[parsedKey] = util_type_1.default.toString(value[key]);
+                        schema._xmlnsProps[parsedKey] = util_xbrl_1.default.toString(value[key]);
                     }
                     else {
-                        schema[parsedKey] = util_type_1.default.toString(value[key]);
+                        schema[parsedKey] = util_xbrl_1.default.toString(value[key]);
                     }
                     break;
             }

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

@@ -16,7 +16,7 @@ interface XbrlDocument<T> {
     type: string;
     xbrl: T;
 }
-export interface ParseXbrlOptions {
+interface ParseXbrlOptions {
     includeInstance?: boolean;
     includeLinkbases?: boolean;
     includeSchema?: boolean;

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

@@ -17,7 +17,11 @@ var XBRLParser = /** @class */ (function () {
         var _a, _b, _c, _d, _e, _f;
         var xmlDocs = documents.filter(function (doc) { return doc.fileName.endsWith('.xml') || doc.fileName.endsWith('.xsd'); });
         return {
-            instanceDoc: (_a = xmlDocs.find(function (doc) { return doc.fileName.endsWith('_htm.xml'); })) !== null && _a !== void 0 ? _a : null,
+            instanceDoc: (_a = xmlDocs.find(function (doc) {
+                return doc.description.toLowerCase().includes('instance doc') ||
+                    doc.fileName.endsWith('_htm.xml') ||
+                    (doc.content.includes('<us-gaap') && doc.content.includes('<context'));
+            })) !== null && _a !== void 0 ? _a : null,
             schemaDoc: (_b = xmlDocs.find(function (doc) { return doc.fileName.endsWith('.xsd'); })) !== null && _b !== void 0 ? _b : null,
             linkbasePresentationDoc: (_c = xmlDocs.find(function (doc) { return doc.fileName.endsWith('_pre.xml'); })) !== null && _c !== void 0 ? _c : null,
             linkbaseDefinitionDoc: (_d = xmlDocs.find(function (doc) { return doc.fileName.endsWith('_def.xml'); })) !== null && _d !== void 0 ? _d : null,

package/build/services/DocumentParser/XBRLParser/{util-type.d.ts → util-xbrl.d.ts}

@@ -4,12 +4,14 @@ declare function toObject<T>(value: T): T;
 declare function toString(value: any): string;
 declare function toBoolean(value: any): boolean;
 declare function parseKey(key: string): string;
-declare const utilType: {
+declare function extractXbrlObject(value: any): any;
+declare const utilXbrl: {
     toArray: typeof toArray;
     toNumber: typeof toNumber;
     toObject: typeof toObject;
     toString: typeof toString;
     toBoolean: typeof toBoolean;
     parseKey: typeof parseKey;
+    extractXbrlObject: typeof extractXbrlObject;
 };
-export default utilType;
+export default utilXbrl;

package/build/services/DocumentParser/XBRLParser/{util-type.js → util-xbrl.js}

@@ -23,12 +23,28 @@ function parseKey(key) {
     var _a, _b;
     return (_b = (_a = key.split(':').pop()) === null || _a === void 0 ? void 0 : _a.replace('@_', '').replace('#', '')) !== null && _b !== void 0 ? _b : '';
 }
-var utilType = {
+function extractXbrlObject(value) {
+    var _a;
+    var xbrl = value;
+    if (typeof xbrl !== 'object' || xbrl === null) {
+        return null;
+    }
+    for (var i = 0; i < 10; i++) {
+        var xbrlChild = (_a = xbrl.XBRL) !== null && _a !== void 0 ? _a : xbrl.xbrl;
+        if (xbrlChild)
+            xbrl = xbrlChild;
+        else
+            break;
+    }
+    return xbrl;
+}
+var utilXbrl = {
     toArray: toArray,
     toNumber: toNumber,
     toObject: toObject,
     toString: toString,
     toBoolean: toBoolean,
     parseKey: parseKey,
+    extractXbrlObject: extractXbrlObject,
 };
-exports.default = utilType;
+exports.default = utilXbrl;

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

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

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

@@ -23,6 +23,7 @@ var __rest = (this && this.__rest) || function (s, e) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseXbrl = void 0;
+var constants_1 = require("../../../util/constants");
 var XBRLParser_1 = require("../XBRLParser/XBRLParser");
 function isWithinDays(params) {
     var dateA = params.dateA, dateB = params.dateB, days = params.days;
@@ -31,7 +32,7 @@ function isWithinDays(params) {
     return daysDiff < days;
 }
 function buildReportsFromFacts(params) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s;
     var filing = params.filing, facts = params.facts, fiscalPeriod = params.fiscalPeriod, fiscalYear = params.fiscalYear, pathSeparator = params.pathSeparator, cikProp = params.cik;
     var urlParts = (_a = filing === null || filing === void 0 ? void 0 : filing.url.split('/')) !== null && _a !== void 0 ? _a : [];
     var cik = cikProp !== null && cikProp !== void 0 ? cikProp : urlParts[(_b = urlParts.indexOf('data')) !== null && _b !== void 0 ? _b : -1];
@@ -41,15 +42,22 @@ function buildReportsFromFacts(params) {
         fiscalPeriod: fiscalPeriod,
         fiscalYear: fiscalYear,
     };
+    // if there is a split fact, make sure it's from the current fiscal year
+    var allowedMonthsPriorForSplit = fiscalPeriod === 'FY' ? 12 : 3;
+    var splitFact = facts.find(function (f) {
+        var _a;
+        return f.name.endsWith(constants_1.KEY_SPLIT) &&
+            isWithinDays({ dateA: f.filed, dateB: (_a = filing === null || filing === void 0 ? void 0 : filing.reportDate) !== null && _a !== void 0 ? _a : '', days: allowedMonthsPriorForSplit * 30 });
+    });
     var reportFocus = {
         cik: Number(cik !== null && cik !== void 0 ? cik : reportFactValues.cik),
         dateFiled: (_d = filing === null || filing === void 0 ? void 0 : filing.filingDate) !== null && _d !== void 0 ? _d : '',
         dateReport: String((_e = filing === null || filing === void 0 ? void 0 : filing.reportDate) !== null && _e !== void 0 ? _e : reportFactValues.dateReport),
         fiscalPeriod: (fiscalPeriod !== null && fiscalPeriod !== void 0 ? fiscalPeriod : reportFactValues.fiscalPeriod),
         fiscalYear: Number(fiscalYear !== null && fiscalYear !== void 0 ? fiscalYear : reportFactValues.fiscalYear),
-        splitDate: null,
-        splitRatio: null,
-        url: (_f = filing === null || filing === void 0 ? void 0 : filing.url) !== null && _f !== void 0 ? _f : '',
+        splitDate: (_f = splitFact === null || splitFact === void 0 ? void 0 : splitFact.end) !== null && _f !== void 0 ? _f : null,
+        splitRatio: (splitFact === null || splitFact === void 0 ? void 0 : splitFact.value) ? Number(splitFact.value) : null,
+        url: (_g = filing === null || filing === void 0 ? void 0 : filing.url) !== null && _g !== void 0 ? _g : '',
     };
     var reportByDateRange = {};
     var factByName = new Map();
@@ -59,16 +67,16 @@ function buildReportsFromFacts(params) {
     for (var _i = 0, facts_1 = facts; _i < facts_1.length; _i++) {
         var fact = facts_1[_i];
         var dateKey = fact.start ? "".concat(fact.start, "_").concat(fact.end) : fact.end;
-        (_g = reportByDateRange[dateKey]) !== null && _g !== void 0 ? _g : (reportByDateRange[dateKey] = {
-            startDate: (_h = fact.start) !== null && _h !== void 0 ? _h : '',
+        (_h = reportByDateRange[dateKey]) !== null && _h !== void 0 ? _h : (reportByDateRange[dateKey] = {
+            startDate: (_j = fact.start) !== null && _j !== void 0 ? _j : '',
             endDate: fact.end,
         });
-        var isFocusFact = (_j = isFocusFactByDateKey.get(dateKey)) !== null && _j !== void 0 ? _j : isWithinDays({ dateA: fact.end, dateB: reportFocus.dateReport, days: 45 });
+        var isFocusFact = (_k = isFocusFactByDateKey.get(dateKey)) !== null && _k !== void 0 ? _k : isWithinDays({ dateA: fact.end, dateB: reportFocus.dateReport, days: 45 });
         isFocusFactByDateKey.set(dateKey, isFocusFact);
         var el = fact;
-        var scale = Number((_k = el.scale) !== null && _k !== void 0 ? _k : 0) || 0;
-        var decimals = Number((_l = el.decimals) !== null && _l !== void 0 ? _l : 0) || 0;
-        var suffix = (_m = fact === null || fact === void 0 ? void 0 : fact.segments) === null || _m === void 0 ? void 0 : _m.map(function (_a) {
+        var scale = Number((_l = el.scale) !== null && _l !== void 0 ? _l : 0) || 0;
+        var decimals = Number((_m = el.decimals) !== null && _m !== void 0 ? _m : 0) || 0;
+        var suffix = (_o = fact === null || fact === void 0 ? void 0 : fact.segments) === null || _o === void 0 ? void 0 : _o.map(function (_a) {
             var dimension = _a.dimension, value = _a.value;
             return "".concat(dimension).concat(pathSeparator).concat(value);
         }).join(pathSeparator);
@@ -82,8 +90,8 @@ function buildReportsFromFacts(params) {
             var prevRounding = roundPlacesByName.get(prevFactKey);
             var prevScale = scaleByName.get(prevFactKey);
             var prevFact_1 = factByName.get(prevFactKey);
-            var prevUnit = (_p = (_o = prevFact_1 === null || prevFact_1 === void 0 ? void 0 : prevFact_1.unit) === null || _o === void 0 ? void 0 : _o.split('_').pop()) === null || _p === void 0 ? void 0 : _p.toLowerCase();
-            var unit = (_r = (_q = fact.unit) === null || _q === void 0 ? void 0 : _q.split('_').pop()) === null || _r === void 0 ? void 0 : _r.toLowerCase();
+            var prevUnit = (_q = (_p = prevFact_1 === null || prevFact_1 === void 0 ? void 0 : prevFact_1.unit) === null || _p === void 0 ? void 0 : _p.split('_').pop()) === null || _q === void 0 ? void 0 : _q.toLowerCase();
+            var unit = (_s = (_r = fact.unit) === null || _r === void 0 ? void 0 : _r.split('_').pop()) === null || _s === void 0 ? void 0 : _s.toLowerCase();
             var shouldSkip = [
                 (prevUnit === null || prevUnit === void 0 ? void 0 : prevUnit.length) === 3 && (unit === null || unit === void 0 ? void 0 : unit.length) === 3 && prevUnit !== unit && prevUnit === 'usd',
                 (prevRounding !== null && prevRounding !== void 0 ? prevRounding : 0) < roundPlaces,
@@ -166,6 +174,6 @@ function parseXbrl(params) {
             urlPrimaryDocument: '',
         },
     }), factsFiltered = _p.factsFiltered, reportFocus = _p.reportFocus;
-    return __assign(__assign({}, response), { facts: factsFiltered, report: reportFocus });
+    return __assign(__assign({}, response), { facts: factsFiltered, report: factsFiltered.length > 0 ? reportFocus : null, xml: xml });
 }
 exports.parseXbrl = parseXbrl;

package/build/services/ReportRawBuilder/FactSplitAdjuster.js

@@ -20,6 +20,7 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
     return to.concat(ar || Array.prototype.slice.call(from));
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+var constants_1 = require("../../util/constants");
 var FactPeriodResolver_1 = require("./FactPeriodResolver");
 /**
  * Splits can be filed multiple times throughout different reports. There is no clear
@@ -29,7 +30,7 @@ var FactPeriodResolver_1 = require("./FactPeriodResolver");
  */
 var FactSplitAdjuster = /** @class */ (function () {
     function FactSplitAdjuster() {
-        this.keySplit = 'StockholdersEquityNoteStockSplitConversionRatio1';
+        this.keySplit = constants_1.KEY_SPLIT;
         this.preferFirstValue = true;
     }
     FactSplitAdjuster.prototype.getGroupValue = function (factGroup, isTrailing) {

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

@@ -2,7 +2,6 @@ import { CompanyFactFrame, CompanyFactListData, CompanyTickerItem, DailyFilingFo
 import { FilingListDetails, FilingListItemTranslated, SubmissionList } from '../../types/submission.type';
 import { IClient } from '../Client';
 import DocumentParser from '../DocumentParser';
-import { ParseXbrlOptions } from '../DocumentParser/XBRLParser/XBRLParser';
 import ReportParser from '../ReportParser';
 import ReportWrapper from '../ReportParser/ReportWrapper';
 import FilingMapper from './FilingMapper';
@@ -54,12 +53,6 @@ export interface GetFactFrameParams {
     unit?: 'pure' | 'USD' | 'shares' | string;
     taxonomy?: 'us-gaap' | 'dei' | 'invest' | string;
 }
-export interface GetDocumentXMLParams {
-    /** symbol or cik */
-    symbol: string | number;
-    accessionNumber: string;
-    primaryDocument: string;
-}
 export interface GetInsiderTransactionsParams {
     page: number;
     symbol: string | number;
@@ -83,6 +76,15 @@ interface GetCurrentFilingsParams {
     symbol?: string | number;
     searchType?: 'include' | 'exclude' | 'only';
 }
+export interface GetDocumentXbrlParams {
+    url?: string;
+    symbol?: string | number;
+    accessionNumber?: string;
+    includeReport?: boolean;
+    includeInstance?: boolean;
+    includeLinkbases?: boolean;
+    includeSchema?: boolean;
+}
 /**
  * Gets reports from companies filed with the SEC
  *
@@ -192,7 +194,8 @@ export default class SecEdgarApi {
      */
     getMutualFundList(): Promise<FieldDataResponse<'cik' | 'seriesId' | 'classId' | 'symbol'>>;
     /**
-     * Gets a raw xml document string. the parameters are found in the submission list response.
+     * If url is provided, all other props are ignored. Otherwise, both accessionNumber
+     * and symbol (symbol or cik) are required. provide fileName if different from `${accessionNumber}.txt`
      *
      * Some form types can be parsed using the DocumentParser such as form 4 (insider transactions) and form 13g (institutional holders)
      *
@@ -200,19 +203,32 @@ export default class SecEdgarApi {
      *
      * @see https://www.sec.gov/forms for a list of form types
      */
-    getDocumentXML(params: GetDocumentXMLParams): Promise<string>;
+    getDocument(params: {
+        url?: string;
+        symbol?: string | number;
+        accessionNumber?: string;
+        fileName?: string;
+    }): Promise<string>;
     /**
-     * Gets a raw xml document string. the url is found in the submission list response. (response.filings.recentTranslated.url)
-     *
-     * Some form types can be parsed using the DocumentParser such as form 4 (insider transactions) and form 13g (institutional holders)
+     * Fetches SEC document and parses XBRL data. If url is provided, symbol and accessionNumber are ignored.
      *
-     * endpoint: `https://www.sec.gov/Archives/edgar/data/${cik}/${accessionNumber}/${primaryDocument}`
+     * Use "include" params to specify what to parse. If not provided, all data is parsed.
+     */
+    getDocumentXbrl(params: GetDocumentXbrlParams): Promise<import("../DocumentParser/XBRLParser/XBRLParser").XbrlParseResult & {
+        report: ReportRaw | null;
+        facts: import("../../types").FactItem[];
+        xml: string;
+    }>;
+    /**
+     * Builds a url for a document. If fileName is not provided, it defaults to `${accessionNumber}.txt`
      *
-     * @see https://www.sec.gov/forms for a list of form types
+     * format: `https://www.sec.gov/Archives/edgar/data/${cik}/${accessionNumberNoHyphen)}/${fileNameAccessionFile}`
      */
-    getDocumentXMLByUrl(params: {
-        url: string;
-    }): Promise<string>;
+    buildDocumentUrl(params: {
+        symbol: string | number;
+        accessionNumber: string;
+        fileName?: string;
+    }): string;
     /**
      * Used for getting insider transactions. extracts insider transaction urls from submission list response, and parses the xml doc.
      *
@@ -285,17 +301,9 @@ export default class SecEdgarApi {
     /**
      * @see https://www.sec.gov/structureddata/rss-feeds-submitted-filings
      */
-    getCurrentFilingsXBRL(params?: {
+    getCurrentFilingsXbrl(params?: {
         taxonomy?: 'usGaap' | 'mutualFund' | 'inlineXbrl' | 'allXbrl';
     }): Promise<import("../../types").CurrentFilingsXBRL>;
-    getDocumentXbrl(params: {
-        url: string;
-    } & ParseXbrlOptions & {
-        includeReport?: boolean;
-    }): Promise<import("../DocumentParser/XBRLParser/XBRLParser").XbrlParseResult & {
-        report: ReportRaw | null;
-        facts: import("../../types").FactItem[];
-    }>;
     /**
      * Gets insider transactions for a provided symbol or CIK.
      *

package/build/services/SecEdgarApi/SecEdgarApi.js

@@ -354,7 +354,8 @@ var SecEdgarApi = /** @class */ (function () {
         });
     };
     /**
-     * Gets a raw xml document string. the parameters are found in the submission list response.
+     * If url is provided, all other props are ignored. Otherwise, both accessionNumber
+     * and symbol (symbol or cik) are required. provide fileName if different from `${accessionNumber}.txt`
      *
      * Some form types can be parsed using the DocumentParser such as form 4 (insider transactions) and form 13g (institutional holders)
      *
@@ -362,32 +363,50 @@ var SecEdgarApi = /** @class */ (function () {
      *
      * @see https://www.sec.gov/forms for a list of form types
      */
-    SecEdgarApi.prototype.getDocumentXML = function (params) {
+    SecEdgarApi.prototype.getDocument = function (params) {
         return __awaiter(this, void 0, void 0, function () {
-            var accessionNumber, primaryDocument, symbol, cik;
-            return __generator(this, function (_a) {
-                accessionNumber = params.accessionNumber, primaryDocument = params.primaryDocument, symbol = params.symbol;
-                cik = this.cikBySymbol[symbol];
-                return [2 /*return*/, this.request("".concat(this.baseUrlSec, "/Archives/edgar/data/").concat(cik, "/").concat(accessionNumber.replace(/-/g, ''), "/").concat(primaryDocument), true)];
+            var _a, accessionNumber, fileName, _b, symbol, urlProp, url;
+            return __generator(this, function (_c) {
+                _a = params.accessionNumber, accessionNumber = _a === void 0 ? '' : _a, fileName = params.fileName, _b = params.symbol, symbol = _b === void 0 ? '' : _b, urlProp = params.url;
+                if (!urlProp && (!accessionNumber || !symbol)) {
+                    throw new Error('Must provide either url or (a)ccessionNumber and symbol)');
+                }
+                url = urlProp !== null && urlProp !== void 0 ? urlProp : this.buildDocumentUrl({ symbol: symbol, accessionNumber: accessionNumber, fileName: fileName });
+                return [2 /*return*/, this.request(url, true)];
             });
         });
     };
     /**
-     * Gets a raw xml document string. the url is found in the submission list response. (response.filings.recentTranslated.url)
-     *
-     * Some form types can be parsed using the DocumentParser such as form 4 (insider transactions) and form 13g (institutional holders)
-     *
-     * endpoint: `https://www.sec.gov/Archives/edgar/data/${cik}/${accessionNumber}/${primaryDocument}`
+     * Fetches SEC document and parses XBRL data. If url is provided, symbol and accessionNumber are ignored.
      *
-     * @see https://www.sec.gov/forms for a list of form types
+     * Use "include" params to specify what to parse. If not provided, all data is parsed.
      */
-    SecEdgarApi.prototype.getDocumentXMLByUrl = function (params) {
+    SecEdgarApi.prototype.getDocumentXbrl = function (params) {
         return __awaiter(this, void 0, void 0, function () {
+            var url, accessionNumber, symbol, options, xml;
             return __generator(this, function (_a) {
-                return [2 /*return*/, this.request(params.url, true)];
+                switch (_a.label) {
+                    case 0:
+                        url = params.url, accessionNumber = params.accessionNumber, symbol = params.symbol, options = __rest(params, ["url", "accessionNumber", "symbol"]);
+                        return [4 /*yield*/, this.getDocument({ url: url, accessionNumber: accessionNumber, symbol: symbol })];
+                    case 1:
+                        xml = _a.sent();
+                        return [2 /*return*/, this.documentParser.parseXbrl(__assign({ xml: xml }, options))];
+                }
             });
         });
     };
+    /**
+     * Builds a url for a document. If fileName is not provided, it defaults to `${accessionNumber}.txt`
+     *
+     * format: `https://www.sec.gov/Archives/edgar/data/${cik}/${accessionNumberNoHyphen)}/${fileNameAccessionFile}`
+     */
+    SecEdgarApi.prototype.buildDocumentUrl = function (params) {
+        var symbol = params.symbol, accessionNumber = params.accessionNumber, fileNameProp = params.fileName;
+        var cik = Number(this.getCikString(symbol));
+        var fileName = fileNameProp !== null && fileNameProp !== void 0 ? fileNameProp : "".concat(accessionNumber, ".txt");
+        return "".concat(this.baseUrlSec, "/Archives/edgar/data/").concat(cik, "/").concat(accessionNumber.replace(/-/g, ''), "/").concat(fileName);
+    };
     /**
      * Used for getting insider transactions. extracts insider transaction urls from submission list response, and parses the xml doc.
      *
@@ -411,7 +430,7 @@ var SecEdgarApi = /** @class */ (function () {
                     case 0:
                         _b = (_a = this.documentParser).parseForm4;
                         _c = {};
-                        return [4 /*yield*/, this.getDocumentXMLByUrl(params)];
+                        return [4 /*yield*/, this.getDocument(params)];
                     case 1: return [2 /*return*/, _b.apply(_a, [(_c.xml = _d.sent(), _c)])];
                 }
             });
@@ -446,7 +465,7 @@ var SecEdgarApi = /** @class */ (function () {
                     case 0:
                         _b = (_a = this.documentParser).parseForm13g;
                         _c = {};
-                        return [4 /*yield*/, this.getDocumentXMLByUrl(params)];
+                        return [4 /*yield*/, this.getDocument(params)];
                     case 1: return [2 /*return*/, _b.apply(_a, [(_c.xml = _d.sent(), _c)])];
                 }
             });
@@ -490,7 +509,7 @@ var SecEdgarApi = /** @class */ (function () {
                     case 0:
                         _b = (_a = this.documentParser).parseForm10k;
                         _c = {};
-                        return [4 /*yield*/, this.getDocumentXMLByUrl(params)];
+                        return [4 /*yield*/, this.getDocument(params)];
                     case 1: return [2 /*return*/, _b.apply(_a, [(_c.xml = _d.sent(), _c)])];
                 }
             });
@@ -524,7 +543,7 @@ var SecEdgarApi = /** @class */ (function () {
                     case 0:
                         _b = (_a = this.documentParser).parseFormDef14a;
                         _c = {};
-                        return [4 /*yield*/, this.getDocumentXMLByUrl(params)];
+                        return [4 /*yield*/, this.getDocument(params)];
                     case 1: return [2 /*return*/, _b.apply(_a, [(_c.xml = _d.sent(), _c)])];
                 }
             });
@@ -579,7 +598,7 @@ var SecEdgarApi = /** @class */ (function () {
                 switch (_e.label) {
                     case 0:
                         _b = params !== null && params !== void 0 ? params : {}, _c = _b.page, page = _c === void 0 ? 1 : _c, _d = _b.itemsPerPage, itemsPerPage = _d === void 0 ? 100 : _d, formType = _b.formType, searchType = _b.searchType, symbol = _b.symbol;
-                        type = (_a = formType === null || formType === void 0 ? void 0 : formType.replace(/\s/, '+')) !== null && _a !== void 0 ? _a : null;
+                        type = (_a = formType === null || formType === void 0 ? void 0 : formType.trim().replace(/\s/g, '+')) !== null && _a !== void 0 ? _a : null;
                         owner = searchType !== null && searchType !== void 0 ? searchType : ((formType === null || formType === void 0 ? void 0 : formType.includes(' ')) ? 'include' : 'only');
                         offset = (page - 1) * Math.max(1, itemsPerPage || 100);
                         cik = symbol ? Number(this.getCikString(symbol)) : null;
@@ -601,7 +620,7 @@ var SecEdgarApi = /** @class */ (function () {
     /**
      * @see https://www.sec.gov/structureddata/rss-feeds-submitted-filings
      */
-    SecEdgarApi.prototype.getCurrentFilingsXBRL = function (params) {
+    SecEdgarApi.prototype.getCurrentFilingsXbrl = function (params) {
         return __awaiter(this, void 0, void 0, function () {
             var _a, taxonomy, urlByTaxonomy, url, xml;
             return __generator(this, function (_b) {
@@ -623,21 +642,6 @@ var SecEdgarApi = /** @class */ (function () {
             });
         });
     };
-    SecEdgarApi.prototype.getDocumentXbrl = function (params) {
-        return __awaiter(this, void 0, void 0, function () {
-            var url, options, xml;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        url = params.url, options = __rest(params, ["url"]);
-                        return [4 /*yield*/, this.getDocumentXMLByUrl({ url: url })];
-                    case 1:
-                        xml = _a.sent();
-                        return [2 /*return*/, this.documentParser.parseXbrl(__assign({ xml: xml }, options))];
-                }
-            });
-        });
-    };
     /**
      * Gets insider transactions for a provided symbol or CIK.
      *

package/build/util/constants.d.ts

@@ -0,0 +1,2 @@
+declare const KEY_SPLIT = "StockholdersEquityNoteStockSplitConversionRatio1";
+export { KEY_SPLIT };

package/build/util/constants.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KEY_SPLIT = void 0;
+var KEY_SPLIT = 'StockholdersEquityNoteStockSplitConversionRatio1';
+exports.KEY_SPLIT = KEY_SPLIT;

package/package.json

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