sec-edgar-api 0.3.4 → 0.4.1

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

@@ -0,0 +1,142 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var XMLParser_1 = require("../XMLParser");
+var util_xbrl_1 = require("./util-xbrl");
+/* eslint-disable @typescript-eslint/no-explicit-any */
+var SchemaParser = /** @class */ (function () {
+    function SchemaParser() {
+        this.xmlParser = new XMLParser_1.default();
+    }
+    SchemaParser.prototype.parseAppInfo = function (value) {
+        var _this = this;
+        value = util_xbrl_1.default.toObject(value);
+        var appinfo = {};
+        for (var key in value) {
+            var parsedKey = util_xbrl_1.default.parseKey(key);
+            switch (parsedKey) {
+                case 'roleType':
+                    appinfo.roleType = util_xbrl_1.default.toArray(value[key]).map(function (v) { return _this.parseRoleType(v); });
+                    break;
+                case 'linkbaseRef':
+                    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_xbrl_1.default.toObject(value);
+        var roleType = {};
+        for (var key in value) {
+            var parsedKey = util_xbrl_1.default.parseKey(key);
+            switch (parsedKey) {
+                case 'usedOn':
+                    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_xbrl_1.default.toString(value[key]);
+                    break;
+            }
+        }
+        return roleType;
+    };
+    SchemaParser.prototype.parseLinkbaseRef = function (value) {
+        value = util_xbrl_1.default.toObject(value);
+        var item = {};
+        for (var key in value) {
+            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_xbrl_1.default.toObject(value);
+        var annotation = {};
+        for (var key in value) {
+            var parsedKey = util_xbrl_1.default.parseKey(key);
+            switch (parsedKey) {
+                case 'appinfo':
+                    annotation.appinfo = this.parseAppInfo(value[key]);
+                    break;
+                case 'documentation':
+                    annotation.documentation = util_xbrl_1.default.toString(value[key]);
+                    break;
+            }
+        }
+        return annotation;
+    };
+    SchemaParser.prototype.parseElement = function (value) {
+        value = util_xbrl_1.default.toObject(value);
+        var element = {
+            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_xbrl_1.default.parseKey(key);
+            switch (util_xbrl_1.default.parseKey(key)) {
+                case 'abstract':
+                case 'nillable':
+                case 'headUsable':
+                    element[parsedKey] = util_xbrl_1.default.toBoolean(value[key]);
+                    break;
+                case 'complexType':
+                case 'annotation':
+                    element[parsedKey] = util_xbrl_1.default.toObject(value[key]);
+                    break;
+                default:
+                    element[parsedKey] = util_xbrl_1.default.toString(value[key]);
+                    break;
+            }
+        }
+        return element;
+    };
+    SchemaParser.prototype.parseImport = function (value) {
+        value = util_xbrl_1.default.toObject(value);
+        return {
+            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 xbrl = util_xbrl_1.default.extractXbrlObject(this.xmlParser.parse(xml));
+        var schemaRaw = null;
+        for (var key in xbrl) {
+            if (util_xbrl_1.default.parseKey(key) !== 'schema')
+                continue;
+            schemaRaw = xbrl[key];
+            break;
+        }
+        var value = schemaRaw === null ? xbrl : schemaRaw;
+        var schema = {
+            xmlns: util_xbrl_1.default.toString(value['@_xmlns']),
+            _xmlnsProps: {},
+        };
+        for (var key in value) {
+            var parsedKey = util_xbrl_1.default.parseKey(key);
+            switch (parsedKey) {
+                case 'annotation':
+                    schema.annotation = this.parseAnnotation(value[key]);
+                    break;
+                case 'element':
+                    schema.element = util_xbrl_1.default.toArray(value[key]).map(function (v) { return _this.parseElement(v); });
+                    break;
+                case 'import':
+                    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_xbrl_1.default.toString(value[key]);
+                    }
+                    else {
+                        schema[parsedKey] = util_xbrl_1.default.toString(value[key]);
+                    }
+                    break;
+            }
+        }
+        return schema;
+    };
+    return SchemaParser;
+}());
+exports.default = SchemaParser;

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

@@ -0,0 +1,34 @@
+import { XbrlInstance, XbrlLinkbase, XbrlSchema } from '../../../types/xbrl.type';
+import { XbrlFormHeader } from './HeaderParser';
+export interface XbrlParseResult {
+    header: XbrlFormHeader;
+    schema: XbrlDocument<XbrlSchema> | null;
+    instance: XbrlDocument<XbrlInstance> | null;
+    linkbasePresentation: XbrlDocument<XbrlLinkbase> | null;
+    linkbaseCalculation: XbrlDocument<XbrlLinkbase> | null;
+    linkbaseDefinition: XbrlDocument<XbrlLinkbase> | null;
+    linkbaseLabel: XbrlDocument<XbrlLinkbase> | null;
+}
+interface XbrlDocument<T> {
+    description: string;
+    fileName: string;
+    sequence: number;
+    type: string;
+    xbrl: T;
+}
+interface ParseXbrlOptions {
+    includeInstance?: boolean;
+    includeLinkbases?: boolean;
+    includeSchema?: boolean;
+}
+export default class XBRLParser {
+    private readonly splitter;
+    private readonly headerParser;
+    private readonly linkbaseParser;
+    private readonly instanceParser;
+    private readonly schemaParser;
+    private filterDocuments;
+    private createXbrlDocument;
+    parse(xml: string, options?: ParseXbrlOptions): XbrlParseResult;
+}
+export {};

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

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var DocumentXmlSplitter_1 = require("../DocumentXmlSplitter");
+var HeaderParser_1 = require("./HeaderParser");
+var InstanceParser_1 = require("./InstanceParser");
+var LinkbaseParser_1 = require("./LinkbaseParser");
+var SchemaParser_1 = require("./SchemaParser");
+var XBRLParser = /** @class */ (function () {
+    function XBRLParser() {
+        this.splitter = new DocumentXmlSplitter_1.default();
+        this.headerParser = new HeaderParser_1.default();
+        this.linkbaseParser = new LinkbaseParser_1.default();
+        this.instanceParser = new InstanceParser_1.default();
+        this.schemaParser = new SchemaParser_1.default();
+    }
+    XBRLParser.prototype.filterDocuments = function (documents) {
+        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.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,
+            linkbaseCalculationDoc: (_e = xmlDocs.find(function (doc) { return doc.fileName.endsWith('_cal.xml'); })) !== null && _e !== void 0 ? _e : null,
+            linkbaseLabelDoc: (_f = xmlDocs.find(function (doc) { return doc.fileName.endsWith('_lab.xml'); })) !== null && _f !== void 0 ? _f : null,
+        };
+    };
+    XBRLParser.prototype.createXbrlDocument = function (doc, xbrl) {
+        if (!doc)
+            return null;
+        var description = doc.description, fileName = doc.fileName, sequence = doc.sequence, type = doc.type;
+        return xbrl ? { fileName: fileName, description: description, sequence: sequence, type: type, xbrl: xbrl } : null;
+    };
+    XBRLParser.prototype.parse = function (xml, options) {
+        var _a, _b, _c, _d, _e, _f;
+        var _g = options !== null && options !== void 0 ? options : {}, _h = _g.includeInstance, includeInstance = _h === void 0 ? true : _h, _j = _g.includeLinkbases, includeLinkbases = _j === void 0 ? true : _j, _k = _g.includeSchema, includeSchema = _k === void 0 ? true : _k;
+        var documents = this.splitter.splitDocumentXml({ xml: xml }).documents;
+        var _l = this.filterDocuments(documents), instanceDoc = _l.instanceDoc, linkbaseCalculationDoc = _l.linkbaseCalculationDoc, linkbaseDefinitionDoc = _l.linkbaseDefinitionDoc, linkbaseLabelDoc = _l.linkbaseLabelDoc, linkbasePresentationDoc = _l.linkbasePresentationDoc, schemaDoc = _l.schemaDoc;
+        var header = this.headerParser.parse(xml);
+        var instance = includeInstance ? this.instanceParser.parse((_a = instanceDoc === null || instanceDoc === void 0 ? void 0 : instanceDoc.content) !== null && _a !== void 0 ? _a : '') : null;
+        var schema = includeSchema ? this.schemaParser.parse((_b = schemaDoc === null || schemaDoc === void 0 ? void 0 : schemaDoc.content) !== null && _b !== void 0 ? _b : '') : null;
+        var linkbasePresentation = includeLinkbases
+            ? this.linkbaseParser.parse((_c = linkbasePresentationDoc === null || linkbasePresentationDoc === void 0 ? void 0 : linkbasePresentationDoc.content) !== null && _c !== void 0 ? _c : '')
+            : null;
+        var linkbaseCalculation = includeLinkbases
+            ? this.linkbaseParser.parse((_d = linkbaseCalculationDoc === null || linkbaseCalculationDoc === void 0 ? void 0 : linkbaseCalculationDoc.content) !== null && _d !== void 0 ? _d : '')
+            : null;
+        var linkbaseDefinition = includeLinkbases
+            ? this.linkbaseParser.parse((_e = linkbaseDefinitionDoc === null || linkbaseDefinitionDoc === void 0 ? void 0 : linkbaseDefinitionDoc.content) !== null && _e !== void 0 ? _e : '')
+            : null;
+        var linkbaseLabel = includeLinkbases ? this.linkbaseParser.parse((_f = linkbaseLabelDoc === null || linkbaseLabelDoc === void 0 ? void 0 : linkbaseLabelDoc.content) !== null && _f !== void 0 ? _f : '') : null;
+        return {
+            header: header,
+            instance: this.createXbrlDocument(instanceDoc, instance),
+            schema: this.createXbrlDocument(schemaDoc, schema),
+            linkbasePresentation: this.createXbrlDocument(linkbasePresentationDoc, linkbasePresentation),
+            linkbaseCalculation: this.createXbrlDocument(linkbaseCalculationDoc, linkbaseCalculation),
+            linkbaseDefinition: this.createXbrlDocument(linkbaseDefinitionDoc, linkbaseDefinition),
+            linkbaseLabel: this.createXbrlDocument(linkbaseLabelDoc, linkbaseLabel),
+        };
+    };
+    return XBRLParser;
+}());
+exports.default = XBRLParser;

package/build/services/DocumentParser/XBRLParser/util-xbrl.d.ts

@@ -0,0 +1,17 @@
+declare function toArray<T>(value: T): T;
+declare function toNumber(value: any): number;
+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 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 utilXbrl;

package/build/services/DocumentParser/XBRLParser/util-xbrl.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable @typescript-eslint/no-explicit-any */
+function toArray(value) {
+    return (Array.isArray(value) ? value : [value]).filter(Boolean);
+}
+function toNumber(value) {
+    return Number(value);
+}
+function toObject(value) {
+    value = Array.isArray(value) ? value[0] : value;
+    return (value && typeof value === 'object' ? value : {});
+}
+function toString(value) {
+    var _a;
+    value = typeof value === 'object' && value !== null ? (_a = value['#text']) !== null && _a !== void 0 ? _a : value : value;
+    return String(value || '');
+}
+function toBoolean(value) {
+    return typeof value === 'string' ? value.toLowerCase() === 'true' || value === '1' : Boolean(value);
+}
+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 : '';
+}
+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 = utilXbrl;

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

@@ -1,40 +1,11 @@
-import { DocumentNode } from './XMLNode/DocumentNode';
-interface OnCharacterData {
-    char: string;
-    index: number;
-    path: string;
-    pathOccurrenceCount: number;
-    attributesStr: string;
-}
-interface ParseTableNodesParams {
-    xml: string;
-}
-interface Parse2Params {
-    xml: string;
-    onCharacter?: (data: OnCharacterData) => void;
-    onOpenTag?: (data: OnCharacterData) => void;
-    onCloseTag?: (data: OnCharacterData) => void;
-}
-interface IterateTablesParams {
-    xml: string;
-    parentPath?: string;
-    trimSpaces?: boolean;
-    onCharacter?: (data: OnCharacterData & {
-        textMap: Map<string, string>;
-    }) => void;
-    onOpenTag?: (data: OnCharacterData & {
-        textMap: Map<string, string>;
-    }) => void;
-    onCloseTag?: (data: OnCharacterData & {
-        textMap: Map<string, string>;
-    }) => void;
-}
 export default class XMLParser {
-    iterateXML(params: Parse2Params): string[];
-    /**
-     * Returns text in each table cell mapped by `${table}.${row}.${col}`
-     */
-    getTableTextMap(params: IterateTablesParams): Map<string, string>;
-    getDocumentNode(params: ParseTableNodesParams): DocumentNode;
+    private readonly selfEnclosingTags;
+    mapAttributes(attributes: string[]): Map<string, string>;
+    parse(xml: string): Record<string, unknown>;
+    iterateXML(params: {
+        xml: string;
+        onOpenTag?: (tagName: string, attributes: string[], isSelfEnclosing: boolean) => void;
+        onCloseTag?: (tagName: string) => void;
+        onInnerText?: (text: string) => void;
+    }): void;
 }
-export {};