sec-edgar-api 1.0.3 → 1.0.5

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

@@ -0,0 +1,41 @@
+export interface XbrlFilingSummary {
+    baseTaxonomies: string[];
+    inputFiles: string[];
+    contextCount: number;
+    elementCount: number;
+    entityCount: number;
+    footnotesReported: boolean;
+    hasCalculationLinkbase: boolean;
+    hasPresentationLinkbase: boolean;
+    scenarioCount: number;
+    segmentCount: number;
+    tuplesReported: boolean;
+    unitCount: number;
+    version: string;
+    reportFormat: string;
+    reports: XbrlFilingSummaryReport[];
+}
+type XbrlFilingSummaryMenuCategory = 'Cover' | 'Statements' | 'Notes' | 'Policies' | 'Tables' | 'Details';
+type XbrlFilingSummaryReportType = 'Sheet' | 'Notes' | 'Book';
+export interface XbrlFilingSummaryReport {
+    longName: string;
+    shortName: string;
+    isDefault: boolean;
+    hasEmbeddedReports: boolean;
+    htmlFileName: string;
+    reportType: XbrlFilingSummaryReportType;
+    role: string;
+    menuCategory: XbrlFilingSummaryMenuCategory | null;
+    position: number;
+    parentRole: string | null;
+    instance: string;
+}
+/**
+ * Parse FilingSummary.xml
+ */
+export default class FilingSummaryParser {
+    private readonly xmlParser;
+    private toText;
+    parse(xml: string): XbrlFilingSummary | null;
+}
+export {};

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

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var XMLParser_1 = require("../XMLParser");
+var util_xbrl_1 = require("./util-xbrl");
+/**
+ * Parse FilingSummary.xml
+ */
+var FilingSummaryParser = /** @class */ (function () {
+    function FilingSummaryParser() {
+        this.xmlParser = new XMLParser_1.default();
+    }
+    FilingSummaryParser.prototype.toText = function (node) {
+        var _a;
+        return String(typeof node === 'object' && node !== null ? (_a = node['#text']) !== null && _a !== void 0 ? _a : '' : node || '');
+    };
+    FilingSummaryParser.prototype.parse = function (xml) {
+        var _this = this;
+        var _a, _b, _c, _d, _e, _f;
+        var parts = xml ? this.xmlParser.parse(xml) : null;
+        var filingSummary = parts === null || parts === void 0 ? void 0 : parts.FilingSummary;
+        if (!filingSummary)
+            return null;
+        var _g = filingSummary !== null && filingSummary !== void 0 ? filingSummary : {}, BaseTaxonomies = _g.BaseTaxonomies, ContextCount = _g.ContextCount, ElementCount = _g.ElementCount, EntityCount = _g.EntityCount, FootnotesReported = _g.FootnotesReported, HasCalculationLinkbase = _g.HasCalculationLinkbase, HasPresentationLinkbase = _g.HasPresentationLinkbase, InputFiles = _g.InputFiles, MyReports = _g.MyReports, ReportFormat = _g.ReportFormat, ScenarioCount = _g.ScenarioCount, SegmentCount = _g.SegmentCount, TuplesReported = _g.TuplesReported, UnitCount = _g.UnitCount, Version = _g.Version;
+        return {
+            version: util_xbrl_1.default.toString(this.toText(Version)) || '',
+            contextCount: util_xbrl_1.default.toNumber(this.toText(ContextCount)) || 0,
+            elementCount: util_xbrl_1.default.toNumber(this.toText(ElementCount)) || 0,
+            entityCount: util_xbrl_1.default.toNumber(this.toText(EntityCount)) || 0,
+            footnotesReported: util_xbrl_1.default.toBoolean(this.toText(FootnotesReported)) || false,
+            hasCalculationLinkbase: util_xbrl_1.default.toBoolean(this.toText(HasCalculationLinkbase)) || false,
+            hasPresentationLinkbase: util_xbrl_1.default.toBoolean(this.toText(HasPresentationLinkbase)) || false,
+            scenarioCount: util_xbrl_1.default.toNumber(this.toText(ScenarioCount)) || 0,
+            segmentCount: util_xbrl_1.default.toNumber(this.toText(SegmentCount)) || 0,
+            tuplesReported: util_xbrl_1.default.toBoolean(this.toText(TuplesReported)) || false,
+            unitCount: util_xbrl_1.default.toNumber(this.toText(UnitCount)) || 0,
+            reportFormat: util_xbrl_1.default.toString(this.toText(ReportFormat)) || '',
+            baseTaxonomies: (_b = (_a = BaseTaxonomies === null || BaseTaxonomies === void 0 ? void 0 : BaseTaxonomies.BaseTaxonomy) === null || _a === void 0 ? void 0 : _a.map(function (taxonomy) { return util_xbrl_1.default.toString(_this.toText(taxonomy)); })) !== null && _b !== void 0 ? _b : [],
+            inputFiles: (_d = (_c = InputFiles === null || InputFiles === void 0 ? void 0 : InputFiles.File) === null || _c === void 0 ? void 0 : _c.map(function (file) { return util_xbrl_1.default.toString(_this.toText(file)); })) !== null && _d !== void 0 ? _d : [],
+            reports: (_f = (_e = MyReports === null || MyReports === void 0 ? void 0 : MyReports.Report) === null || _e === void 0 ? void 0 : _e.map(function (report) { return ({
+                longName: util_xbrl_1.default.toString(_this.toText(report.LongName)) || '',
+                shortName: util_xbrl_1.default.toString(_this.toText(report.ShortName)) || '',
+                isDefault: util_xbrl_1.default.toBoolean(_this.toText(report.IsDefault)) || false,
+                hasEmbeddedReports: util_xbrl_1.default.toBoolean(_this.toText(report.HasEmbeddedReports)) || false,
+                htmlFileName: util_xbrl_1.default.toString(_this.toText(report.HtmlFileName)) || '',
+                reportType: util_xbrl_1.default.toString(_this.toText(report.ReportType)) || '',
+                role: util_xbrl_1.default.toString(_this.toText(report.Role)) || '',
+                menuCategory: util_xbrl_1.default.toString(_this.toText(report.MenuCategory)) || null,
+                position: util_xbrl_1.default.toNumber(_this.toText(report.Position)) || -1,
+                parentRole: util_xbrl_1.default.toString(_this.toText(report.ParentRole)) || null,
+                instance: util_xbrl_1.default.toString(_this.toText(report['@_instance'])) || '',
+            }); })) !== null && _f !== void 0 ? _f : [],
+        };
+    };
+    return FilingSummaryParser;
+}());
+exports.default = FilingSummaryParser;

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

@@ -0,0 +1,7 @@
+import { XbrlMetaLinks } from '../../../types/metalinks.type';
+/**
+ * Parse MetaLinks.json
+ */
+export declare class MetaLinksParser {
+    parse(xml: string): XbrlMetaLinks | null;
+}

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

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MetaLinksParser = void 0;
+/**
+ * Parse MetaLinks.json
+ */
+var MetaLinksParser = /** @class */ (function () {
+    function MetaLinksParser() {
+    }
+    MetaLinksParser.prototype.parse = function (xml) {
+        if (!xml)
+            return null;
+        try {
+            var numberKeys_1 = new Set(['decimals', 'order']);
+            var booleanKeys_1 = new Set(['xsiNil', 'isDefault']);
+            return JSON.parse(xml.substring(xml.indexOf('{'), xml.lastIndexOf('}') + 1), function (key, value) {
+                if (numberKeys_1.has(key) && !isNaN(value)) {
+                    return Number(value);
+                }
+                if (booleanKeys_1.has(key)) {
+                    if (value === 'false')
+                        return false;
+                    if (value === 'true')
+                        return true;
+                }
+                return value;
+            });
+        }
+        catch (_a) {
+            return null;
+        }
+    };
+    return MetaLinksParser;
+}());
+exports.MetaLinksParser = MetaLinksParser;

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

@@ -1,4 +1,7 @@
 import type { XbrlInstance, XbrlLinkbase, XbrlSchema } from '../../../types';
+import { XbrlMetaLinks } from '../../../types/metalinks.type';
+import { DocumentData } from '../DocumentXmlSplitter';
+import { XbrlFilingSummary } from './FilingSummaryParser';
 import { XbrlFormHeader } from './HeaderParser';
 export interface XbrlParseResult {
     header: XbrlFormHeader;
@@ -8,6 +11,15 @@ export interface XbrlParseResult {
     linkbaseCalculation: XbrlDocument<XbrlLinkbase> | null;
     linkbaseDefinition: XbrlDocument<XbrlLinkbase> | null;
     linkbaseLabel: XbrlDocument<XbrlLinkbase> | null;
+    /**
+     * FilingSummary.xml content
+     */
+    filingSummary: XbrlFilingSummary | null;
+    /**
+     * MetaLinks.json content
+     */
+    metaLinks: XbrlMetaLinks | null;
+    documents: DocumentData[];
 }
 interface XbrlDocument<T> {
     description: string;
@@ -27,6 +39,8 @@ export default class XBRLParser {
     private readonly linkbaseParser;
     private readonly instanceParser;
     private readonly schemaParser;
+    private readonly filingSummaryParser;
+    private readonly metaLinksParser;
     private filterDocuments;
     private createXbrlDocument;
     parse(xml: string, options?: ParseXbrlOptions): XbrlParseResult;

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

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 var DocumentXmlSplitter_1 = require("../DocumentXmlSplitter");
+var FilingSummaryParser_1 = require("./FilingSummaryParser");
 var HeaderParser_1 = require("./HeaderParser");
 var InstanceParser_1 = require("./InstanceParser");
 var LinkbaseParser_1 = require("./LinkbaseParser");
+var MetaLinksParser_1 = require("./MetaLinksParser");
 var SchemaParser_1 = require("./SchemaParser");
 var XBRLParser = /** @class */ (function () {
     function XBRLParser() {
@@ -12,9 +14,11 @@ var XBRLParser = /** @class */ (function () {
         this.linkbaseParser = new LinkbaseParser_1.default();
         this.instanceParser = new InstanceParser_1.default();
         this.schemaParser = new SchemaParser_1.default();
+        this.filingSummaryParser = new FilingSummaryParser_1.default();
+        this.metaLinksParser = new MetaLinksParser_1.MetaLinksParser();
     }
     XBRLParser.prototype.filterDocuments = function (documents) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
         var xmlDocs = documents.filter(function (doc) { return doc.fileName.endsWith('.xml') || doc.fileName.endsWith('.xsd'); });
         var instanceDoc = (_a = xmlDocs.find(function (doc) {
             return doc.description.toLowerCase().includes('instance doc') ||
@@ -28,6 +32,8 @@ var XBRLParser = /** @class */ (function () {
             linkbaseDefinitionDoc: (_f = (_e = xmlDocs.find(function (doc) { return doc.fileName.endsWith('_def.xml'); })) !== null && _e !== void 0 ? _e : xmlDocs.find(function (doc) { return doc !== instanceDoc && doc.content.includes('link:definitionLink>'); })) !== null && _f !== void 0 ? _f : null,
             linkbaseCalculationDoc: (_h = (_g = xmlDocs.find(function (doc) { return doc.fileName.endsWith('_cal.xml'); })) !== null && _g !== void 0 ? _g : xmlDocs.find(function (doc) { return doc !== instanceDoc && doc.content.includes('link:calculationLink>'); })) !== null && _h !== void 0 ? _h : null,
             linkbaseLabelDoc: (_k = (_j = xmlDocs.find(function (doc) { return doc.fileName.endsWith('_lab.xml'); })) !== null && _j !== void 0 ? _j : xmlDocs.find(function (doc) { return doc !== instanceDoc && doc.content.includes('link:labelLink>'); })) !== null && _k !== void 0 ? _k : null,
+            filingSummaryDoc: (_l = xmlDocs.find(function (doc) { return doc.fileName === 'FilingSummary.xml'; })) !== null && _l !== void 0 ? _l : null,
+            metaLinks: (_m = documents.find(function (doc) { return doc.fileName === 'MetaLinks.json'; })) !== null && _m !== void 0 ? _m : null,
         };
     };
     XBRLParser.prototype.createXbrlDocument = function (doc, xbrl) {
@@ -37,10 +43,10 @@ var XBRLParser = /** @class */ (function () {
         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 _a, _b, _c, _d, _e, _f, _g, _h;
+        var _j = options !== null && options !== void 0 ? options : {}, _k = _j.includeInstance, includeInstance = _k === void 0 ? true : _k, _l = _j.includeLinkbases, includeLinkbases = _l === void 0 ? true : _l, _m = _j.includeSchema, includeSchema = _m === void 0 ? true : _m;
         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 _o = this.filterDocuments(documents), instanceDoc = _o.instanceDoc, linkbaseCalculationDoc = _o.linkbaseCalculationDoc, linkbaseDefinitionDoc = _o.linkbaseDefinitionDoc, linkbaseLabelDoc = _o.linkbaseLabelDoc, linkbasePresentationDoc = _o.linkbasePresentationDoc, schemaDoc = _o.schemaDoc, filingSummaryDoc = _o.filingSummaryDoc, metaLinks = _o.metaLinks;
         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;
@@ -62,6 +68,9 @@ var XBRLParser = /** @class */ (function () {
             linkbaseCalculation: this.createXbrlDocument(linkbaseCalculationDoc, linkbaseCalculation),
             linkbaseDefinition: this.createXbrlDocument(linkbaseDefinitionDoc, linkbaseDefinition),
             linkbaseLabel: this.createXbrlDocument(linkbaseLabelDoc, linkbaseLabel),
+            filingSummary: this.filingSummaryParser.parse((_g = filingSummaryDoc === null || filingSummaryDoc === void 0 ? void 0 : filingSummaryDoc.content) !== null && _g !== void 0 ? _g : ''),
+            metaLinks: this.metaLinksParser.parse((_h = metaLinks === null || metaLinks === void 0 ? void 0 : metaLinks.content) !== null && _h !== void 0 ? _h : ''),
+            documents: documents,
         };
     };
     return XBRLParser;

package/build/services/ReportRawBuilder/ReportRawBuilder.js

@@ -54,6 +54,8 @@ var ReportRawBuilder = /** @class */ (function () {
         });
         var accessionByYearQuarter = new Map();
         filings === null || filings === void 0 ? void 0 : filings.forEach(function (f) {
+            if (!f.reportDate)
+                return;
             var _a = fiscalCalculator.getFiscalYearQuarter({ dateStr: f.reportDate }), year = _a.year, quarter = _a.quarter;
             accessionByYearQuarter.set(f.accessionNumber, "".concat(year, "_").concat(quarter));
         });

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

@@ -1,4 +1,4 @@
-import type { CompanyFactFrame, CompanyFactListData, CompanyTickerItem, DailyFilingFormType, FieldDataResponse, Form10KData, Form13GData, Form4Data, FormDef14aData, MultiCompanyFactFrame, ReportRaw, ReportTranslated, FilingListDetails, FilingListItemTranslated, SubmissionList, CalculationMap } from '../../types';
+import type { CompanyFactFrame, CompanyFactListData, CompanyTickerItem, DailyFilingFormType, FieldDataResponse, Form10KData, Form13GData, Form4Data, FormDef14aData, MultiCompanyFactFrame, ReportRaw, ReportTranslated, FilingListDetails, FilingListItemTranslated, SubmissionList, CalculationMap, SplitData } from '../../types';
 import { IClient } from '../Client';
 import DocumentParser from '../DocumentParser';
 import ReportParser from '../ReportParser';
@@ -31,6 +31,9 @@ export interface GetReportsRawParams {
     includeNamePrefix?: boolean;
     adjustForSplits?: boolean;
     resolvePeriodValues?: boolean;
+    filings?: Pick<FilingListItemTranslated, 'form' | 'reportDate' | 'filingDate' | 'accessionNumber'>[];
+    /** useful when the latest split has not shown up yet in an XBRL report */
+    splits?: SplitData[];
 }
 export interface GetReportsParams extends Omit<GetReportsRawParams, 'includeNamePrefix'> {
     /** symbol or cik */
@@ -187,6 +190,9 @@ export default class SecEdgarApi {
         adjustForSplits?: boolean;
         resolvePeriodValues?: boolean;
         calculationMap?: CalculationMap<R>;
+        filings?: Pick<FilingListItemTranslated, 'form' | 'reportDate' | 'filingDate' | 'accessionNumber'>[];
+        /** useful when the latest split has not shown up yet in an XBRL report */
+        splits?: SplitData[];
     }): Promise<(typeof params.calculationMap extends undefined ? ReportTranslated : ReportRaw & R)[]>;
     /**
      * Parses reports from company facts.

package/build/services/SecEdgarApi/SecEdgarApi.js

@@ -323,11 +323,11 @@ var SecEdgarApi = /** @class */ (function () {
      */
     SecEdgarApi.prototype.getReportsRaw = function (params) {
         return __awaiter(this, void 0, void 0, function () {
-            var symbol, _a, includeNamePrefix, _b, adjustForSplits, _c, resolvePeriodValues, companyFacts, reports;
+            var symbol, _a, includeNamePrefix, _b, adjustForSplits, _c, resolvePeriodValues, splits, filings, companyFacts, reports;
             return __generator(this, function (_d) {
                 switch (_d.label) {
                     case 0:
-                        symbol = params.symbol, _a = params.includeNamePrefix, includeNamePrefix = _a === void 0 ? false : _a, _b = params.adjustForSplits, adjustForSplits = _b === void 0 ? true : _b, _c = params.resolvePeriodValues, resolvePeriodValues = _c === void 0 ? true : _c;
+                        symbol = params.symbol, _a = params.includeNamePrefix, includeNamePrefix = _a === void 0 ? false : _a, _b = params.adjustForSplits, adjustForSplits = _b === void 0 ? true : _b, _c = params.resolvePeriodValues, resolvePeriodValues = _c === void 0 ? true : _c, splits = params.splits, filings = params.filings;
                         return [4 /*yield*/, this.getFacts({ symbol: symbol })];
                     case 1:
                         companyFacts = _d.sent();
@@ -335,6 +335,8 @@ var SecEdgarApi = /** @class */ (function () {
                             adjustForSplits: adjustForSplits,
                             resolvePeriodValues: resolvePeriodValues,
                             includeNamePrefix: includeNamePrefix,
+                            splits: splits,
+                            filings: filings,
                         });
                         return [2 /*return*/, reports];
                 }

package/build/types/common.type.d.ts

@@ -12,10 +12,15 @@ export interface FieldDataResponse<Field extends string = string> {
     data: (string | number)[][];
 }
 export interface SplitData {
+    /** The filed date of the report in which the split was first filed */
     filedFirst: string;
+    /** The filed date of the report in which the split was last filed */
     filedLast: string;
+    /** The period end date of the report in which the split was first filed */
     endFirst: string;
+    /** The period end date of the report in which the split was last filed */
     endLast: string;
+    /** ex: forward split 1:20 = 20, reverse split 20:1 = 0.05 */
     splitRatio: number;
 }
 export interface FactGroup {

package/build/types/metalinks.type.d.ts

@@ -0,0 +1,131 @@
+export interface XbrlMetaLinks {
+    version: string;
+    instance: Record<string, XbrlFilingMetaInstance>;
+    std_ref: Record<string, XbrlStdRef>;
+}
+export interface XbrlStdRefFlat extends XbrlStdRef {
+    key: string;
+}
+export interface XbrlFilingMetaInstance {
+    nsprefix: string;
+    nsuri: string;
+    dts: Dts;
+    keyStandard: number;
+    keyCustom: number;
+    axisStandard: number;
+    axisCustom: number;
+    memberStandard: number;
+    memberCustom: number;
+    hidden: Record<string, number>;
+    contextCount: number;
+    entityCount: number;
+    segmentCount: number;
+    elementCount: number;
+    unitCount: number;
+    baseTaxonomies: Record<string, number>;
+    report: Record<string, XbrlReport>;
+    tag: Record<string, Tag>;
+}
+export interface Dts {
+    inline: CalculationLink;
+    schema: Schema;
+    calculationLink: CalculationLink;
+    definitionLink: CalculationLink;
+    labelLink: CalculationLink;
+    presentationLink: CalculationLink;
+}
+export interface CalculationLink {
+    local: string[];
+}
+export interface Schema {
+    local: string[];
+    remote: string[];
+}
+export interface XbrlReport {
+    role: string;
+    longName: string;
+    shortName: string;
+    isDefault: boolean;
+    groupType: GroupType;
+    subGroupType: SubGroupType;
+    menuCat: MenuCategory;
+    order: number;
+    firstAnchor: Anchor;
+    uniqueAnchor: Anchor | null;
+}
+export interface Anchor {
+    contextRef: string;
+    name: string;
+    unitRef: UnitRef | null;
+    xsiNil: string;
+    lang: string;
+    decimals: number | null;
+    ancestors: string[];
+    reportCount: number;
+    baseRef: string;
+    first?: boolean;
+    unique?: boolean;
+}
+type UnitRef = 'entity' | 'number' | 'shares' | 'usd' | 'usdPerShare';
+export declare enum GroupType {
+    Disclosure = "disclosure",
+    Document = "document",
+    Statement = "statement"
+}
+type MenuCategory = 'Cover' | 'Details' | 'Notes' | 'Policies' | 'Statements' | 'Tables';
+type SubGroupType = 'details' | 'parenthetical' | 'policies' | 'tables';
+export interface Tag {
+    xbrltype: XbrlType;
+    nsuri: string;
+    localname: string;
+    presentation?: string[];
+    lang: Record<string, {
+        role: TagRole;
+    }>;
+    auth_ref: string[];
+    crdr?: CreditOrDebit;
+    calculation?: {
+        [key: string]: Calculation;
+    };
+}
+export interface Calculation {
+    parentTag: null | string;
+    weight: number | null;
+    order: number | null;
+    root?: boolean;
+}
+type CreditOrDebit = 'credit' | 'debit';
+export interface TagRole {
+    terseLabel?: string;
+    label: string;
+    documentation?: string;
+    negatedTerseLabel?: string;
+    verboseLabel?: string;
+    periodStartLabel?: string;
+    negatedPeriodEndLabel?: string;
+    negatedPeriodStartLabel?: string;
+    periodEndLabel?: string;
+    totalLabel?: string;
+    negatedLabel?: string;
+    negatedTotalLabel?: string;
+    netLabel?: string;
+}
+type XbrlType = 'booleanItemType' | 'centralIndexKeyItemType' | 'dateItemType' | 'decimalItemType' | 'domainItemType' | 'durationItemType' | 'edgarExchangeCodeItemType' | 'edgarStateCountryItemType' | 'employerIdItemType' | 'enumerationSetItemType' | 'fileNumberItemType' | 'filerCategoryItemType' | 'fiscalPeriodItemType' | 'gMonthDayItemType' | 'gYearItemType' | 'integerItemType' | 'internationalNameItemType' | 'monetaryItemType' | 'nonemptySequenceNumberItemType' | 'normalizedStringItemType' | 'perShareItemType' | 'percentItemType' | 'pureItemType' | 'securityTitleItemType' | 'sharesItemType' | 'stateOrProvinceItemType' | 'stringItemType' | 'submissionTypeItemType' | 'textBlockItemType' | 'tradingSymbolItemType' | 'yesNoItemType';
+export interface XbrlStdRef {
+    role: string;
+    Name: string;
+    Section?: string;
+    Paragraph?: string;
+    SubTopic?: string;
+    Topic?: string;
+    Publisher: string;
+    URI?: string;
+    Subparagraph?: string;
+    Number?: string;
+    Subsection?: string;
+    Footnote?: string;
+    Sentence?: string;
+    Clause?: string;
+    Subclause?: string;
+}
+export {};

package/build/types/metalinks.type.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GroupType = void 0;
+var GroupType;
+(function (GroupType) {
+    GroupType["Disclosure"] = "disclosure";
+    GroupType["Document"] = "document";
+    GroupType["Statement"] = "statement";
+})(GroupType || (exports.GroupType = GroupType = {}));

package/build/util/calculation-map.js

@@ -111,8 +111,8 @@ exports.calculationMapCondensed = {
             ['incomeNet', 1, 1],
         ],
     ],
-    eps: [[['us-gaap:EarningsPerShareBasic', 1, 0]]],
-    epsDiluted: [[['us-gaap:EarningsPerShareDiluted', 1, 0]]],
+    eps: [[['us-gaap:EarningsPerShareBasic', 1, 0]], [['us-gaap:EarningsPerShareBasicAndDiluted', 1, 0]]],
+    epsDiluted: [[['us-gaap:EarningsPerShareDiluted', 1, 0]], [['us-gaap:EarningsPerShareBasicAndDiluted', 1, 0]]],
     equityRetainedEarnings: [[['us-gaap:RetainedEarningsAccumulatedDeficit', 1, 0]]],
     equityTotal: [
         [['us-gaap:StockholdersEquity', 1, 0]],
@@ -287,6 +287,10 @@ exports.calculationMapCondensed = {
         [['us-gaap:WeightedAverageNumberOfSharesOutstandingBasic', 1, 0]],
         [['us-gaap:CommonStockSharesOutstanding', 1, 0]],
         [['dei:EntityCommonStockSharesOutstanding', 1, 0]],
+        [['us-gaap:WeightedAverageNumberOfSharesOutstandingBasicAndDiluted', 1, 0]],
+    ],
+    sharesOutstandingDiluted: [
+        [['us-gaap:WeightedAverageNumberOfDilutedSharesOutstanding', 1, 0]],
+        [['us-gaap:WeightedAverageNumberOfSharesOutstandingBasicAndDiluted', 1, 0]],
     ],
-    sharesOutstandingDiluted: [[['us-gaap:WeightedAverageNumberOfDilutedSharesOutstanding', 1, 0]]],
 };

package/build/util/util-xbrl.js

@@ -19,6 +19,10 @@ function getLabelByTaxonomy(labelLinkbase) {
             }
             // label, terseLabel, or verboseLabel
             var labelType = role.substring(role.lastIndexOf('/') + 1);
+            // skip periodStartLabel. Used for beginning cash position, but overwrites end cash position.
+            if (labelType === 'periodStartLabel') {
+                return;
+            }
             if (labelType === 'verboseLabel') {
                 taxonomyWithVerboseLabels.add(taxonomy);
             }

package/package.json

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