sec-edgar-api 0.2.4 → 0.3.0

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

@@ -1,3 +1,4 @@
+import { FactItem } from './company-facts.type';
 export interface XMLParams {
     xml: string;
 }
@@ -10,3 +11,43 @@ export interface FieldDataResponse<Field extends string = string> {
     fields: Field[];
     data: (string | number)[][];
 }
+export interface SplitData {
+    filedFirst: string;
+    filedLast: string;
+    endFirst: string;
+    endLast: string;
+    splitRatio: number;
+}
+export interface FactGroup {
+    name: string;
+    unit: string;
+    accn: string;
+    reportEnd: string;
+    reportFiled: string;
+    isResolverGenerated: boolean;
+    filedFirst: string;
+    filedLast: string;
+    endFirst: string;
+    endLast: string;
+    values: number[];
+    fiscalYear: number;
+    quarter: number;
+    facts: FactItem[];
+    valueSplitAdjustedPeriod: number | null;
+    valueSplitAdjustedTrailing: number | null;
+    valuePeriodResolved: number | null;
+    valueTrailingResolved: number | null;
+    valuePeriodFirst: number | null;
+    valuePeriodLast: number | null;
+    valueTrailingFirst: number | null;
+    valueTrailingLast: number | null;
+}
+export interface FactItemExtended extends FactItem {
+    period: number;
+    year: number;
+    quarter: number;
+    periodValue: number | null;
+    trailingValue: number | null;
+    splitValue: number | null;
+    splitsApplied: number[];
+}

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

@@ -1,3 +1,4 @@
+import { FiscalPeriod } from './report-raw.type';
 export interface CompanyFactListData {
     cik: number;
     entityName: string;
@@ -6,11 +7,12 @@ export interface CompanyFactListData {
 export interface CompanyFactList {
     dei: Record<string, CompanyFact>;
     invest?: Record<string, CompanyFact>;
+    srt?: Record<string, CompanyFact>;
     'us-gaap'?: Record<string, CompanyFact>;
 }
 export interface CompanyFact {
-    label: string;
-    description: string;
+    label: string | null;
+    description: string | null;
     units: Record<string, FactValue[]>;
 }
 export interface FactValue {
@@ -51,3 +53,28 @@ export interface MultiCompanyFactFrame {
     pts: number;
     data: MultiCompanyFactFrameItem[];
 }
+export interface FactItem {
+    cik: number | string;
+    end: string;
+    filed: string;
+    name: string;
+    unit: string;
+    value: number | string;
+    start?: string;
+    hasSegments?: boolean;
+    accn?: string;
+    form?: string;
+    fp?: string;
+    frame?: string;
+    fy?: number;
+    /** For XBRL reports only */
+    segments?: {
+        value: string;
+        dimension: string;
+    }[];
+    uuid?: string;
+}
+export interface FactItemWithFiscals extends FactItem {
+    fiscalPeriod: FiscalPeriod;
+    year: number;
+}

package/package.json

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

package/build/services/ReportBuilder/FactRecordBuilder.d.ts

@@ -1,10 +0,0 @@
-import { FactItem } from './ReportBuilder';
-import { CompanyFactListData } from '../../types';
-/**
- * Builds an array of fact records.
- */
-export default class FactRecordBuilder {
-    createFacts(data: CompanyFactListData, filterDuplicates?: boolean): {
-        facts: FactItem[];
-    };
-}

package/build/services/ReportBuilder/FactSplitAdjuster.d.ts

@@ -1,50 +0,0 @@
-import { FiscalPeriod } from '../../types/report-raw.type';
-import { FactItemWithFiscals } from './ReportBuilder';
-interface SplitData {
-    end: string;
-    filed: string;
-    value: number;
-    firstFiled: string;
-    fiscalYear: number;
-    fiscalPeriod: FiscalPeriod;
-}
-type FactItemWithFiscalsNumeric = Omit<FactItemWithFiscals, 'cik' | 'value'> & {
-    value: number;
-};
-/**
- * Adjust share-based property values for splits. Checks where the split was applied,
- * and adjusts all previously filed share facts accordingly.
- */
-export default class FactSplitAdjuster {
-    private readonly splitKey;
-    private readonly splitByFiscalYearAmount;
-    private readonly factsByYearQuarterByPropertyName;
-    private readonly factsAnnaulByYearByPropertyName;
-    private readonly resolvedProperties;
-    private sortedSplits;
-    private getMap;
-    private filedFirstLastBySplitKey;
-    add(fact: FactItemWithFiscalsNumeric & {
-        filedLast?: string;
-    }): void;
-    getSplitsAsc(): SplitData[];
-    isSplitProperty(propertyName: string): boolean;
-    addSplitData(data: Omit<SplitData, 'firstFiled'>): void;
-    /**
-     * TODO: Find a more reliable way of checking if the split has already been applied.
-     */
-    private didApplySplit;
-    isSplitAdjustableUnit(unit: string): boolean;
-    isShareRatioUnit(unit: string): boolean;
-    private getSortedFacts;
-    resolveProperty(propertyName: string): void;
-    get(propertyName: string, year: number, fiscalPeriod: FiscalPeriod): number | undefined;
-    forEach(callback: (params: {
-        propertyName: string;
-        year: number;
-        fiscalPeriod: FiscalPeriod;
-        value: number;
-    }) => void): void;
-    private adjustValuesForSplits;
-}
-export {};

package/build/services/ReportBuilder/FactSplitAdjuster.js

@@ -1,214 +0,0 @@
-"use strict";
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Adjust share-based property values for splits. Checks where the split was applied,
- * and adjusts all previously filed share facts accordingly.
- */
-var FactSplitAdjuster = /** @class */ (function () {
-    function FactSplitAdjuster() {
-        this.splitKey = 'StockholdersEquityNoteStockSplitConversionRatio1';
-        this.splitByFiscalYearAmount = new Map();
-        this.factsByYearQuarterByPropertyName = new Map();
-        this.factsAnnaulByYearByPropertyName = new Map();
-        this.resolvedProperties = new Set();
-        this.sortedSplits = null;
-        this.filedFirstLastBySplitKey = new Map();
-    }
-    FactSplitAdjuster.prototype.getMap = function (map, propertyName) {
-        var _a;
-        return (_a = map.get(propertyName)) !== null && _a !== void 0 ? _a : map.set(propertyName, new Map()).get(propertyName);
-    };
-    FactSplitAdjuster.prototype.add = function (fact) {
-        var _a;
-        var propertyName = fact.name, year = fact.year, fiscalPeriod = fact.fiscalPeriod, unit = fact.unit, filed = fact.filed, value = fact.value, end = fact.end;
-        if (this.isSplitProperty(propertyName)) {
-            this.addSplitData({ end: end, filed: filed, fiscalYear: year, value: Number(value), fiscalPeriod: fiscalPeriod });
-            return;
-        }
-        if (!this.isSplitAdjustableUnit(unit))
-            return;
-        if (this.resolvedProperties.has(propertyName)) {
-            throw new Error("Property ".concat(propertyName, " has already been resolved"));
-        }
-        var isAnnual = fiscalPeriod === 'FY';
-        var map = isAnnual
-            ? this.getMap(this.factsAnnaulByYearByPropertyName, propertyName)
-            : this.getMap(this.factsByYearQuarterByPropertyName, propertyName);
-        var key = "".concat(year, "_").concat(fiscalPeriod);
-        this.filedFirstLastBySplitKey.set(key, {
-            firstFiled: filed,
-            lastFiled: (_a = fact.filedLast) !== null && _a !== void 0 ? _a : filed,
-        });
-        map.set(key, fact);
-    };
-    FactSplitAdjuster.prototype.getSplitsAsc = function () {
-        if (this.sortedSplits)
-            return this.sortedSplits;
-        var sortedSplits = Array.from(this.splitByFiscalYearAmount.values()).sort(function (a, b) {
-            return a.filed < b.filed ? -1 : 1;
-        });
-        this.sortedSplits = sortedSplits;
-        return sortedSplits;
-    };
-    FactSplitAdjuster.prototype.isSplitProperty = function (propertyName) {
-        return propertyName === this.splitKey;
-    };
-    FactSplitAdjuster.prototype.addSplitData = function (data) {
-        var end = data.end, filed = data.filed, fiscalYear = data.fiscalYear, value = data.value;
-        var split = value;
-        var key = "".concat(fiscalYear, "-").concat(split);
-        var prevSplit = this.splitByFiscalYearAmount.get(key);
-        if (!prevSplit) {
-            this.splitByFiscalYearAmount.set(key, __assign(__assign({}, data), { firstFiled: filed }));
-            this.sortedSplits = null;
-            return;
-        }
-        var curEnd = end;
-        var curFiled = filed;
-        var prevEnd = prevSplit.end;
-        var prevFiled = prevSplit.filed;
-        var shouldUpdateFactItem = !prevSplit || prevEnd < curEnd || (prevEnd === curEnd && prevFiled > curFiled);
-        var shouldUpdateFirstFiled = prevFiled > curFiled;
-        if (shouldUpdateFactItem) {
-            var curData = this.splitByFiscalYearAmount.get(key);
-            curData.end = end;
-            curData.filed = filed;
-            curData.value = value;
-            curData.fiscalYear = fiscalYear;
-            this.sortedSplits = null;
-        }
-        if (shouldUpdateFirstFiled) {
-            var curData = this.splitByFiscalYearAmount.get(key);
-            curData.firstFiled = curFiled;
-            this.sortedSplits = null;
-        }
-    };
-    /**
-     * TODO: Find a more reliable way of checking if the split has already been applied.
-     */
-    FactSplitAdjuster.prototype.didApplySplit = function (params) {
-        var _a;
-        var isShareRatio = params.isShareRatio, nextFact = params.nextFact, prevFact = params.prevFact, fact = params.fact, split = params.split;
-        var _b = (_a = this.filedFirstLastBySplitKey.get("".concat(split.fiscalYear, "_").concat(split.fiscalPeriod))) !== null && _a !== void 0 ? _a : {}, firstFiled = _b.firstFiled, lastFiled = _b.lastFiled;
-        if (fact.filed > lastFiled) {
-            return true;
-        }
-        if (fact.filed < firstFiled) {
-            return false;
-        }
-        var val = fact.value;
-        var splitVal = split.value;
-        var valWithSplit = isShareRatio ? splitVal * val : val / splitVal;
-        if (nextFact) {
-            var difference = Math.abs(nextFact.value - val);
-            var differenceSplit = Math.abs(nextFact.value - valWithSplit);
-            return difference < differenceSplit;
-        }
-        if (prevFact) {
-            var difference = Math.abs(prevFact.value - val);
-            var differenceSplit = Math.abs(prevFact.value - valWithSplit);
-            return difference < differenceSplit;
-        }
-        return false;
-    };
-    FactSplitAdjuster.prototype.isSplitAdjustableUnit = function (unit) {
-        return unit.toLowerCase().includes('share');
-    };
-    FactSplitAdjuster.prototype.isShareRatioUnit = function (unit) {
-        var unitLower = unit.toLowerCase();
-        return unitLower !== 'shares' && unitLower.includes('share'); // ex: USD/shares or USD-per-share
-    };
-    FactSplitAdjuster.prototype.getSortedFacts = function (propertyName, isAnnual) {
-        var _a, _b, _c;
-        var bucket = isAnnual ? this.factsAnnaulByYearByPropertyName : this.factsByYearQuarterByPropertyName;
-        var facts = Array.from((_b = (_a = bucket.get(propertyName)) === null || _a === void 0 ? void 0 : _a.values()) !== null && _b !== void 0 ? _b : []);
-        return (_c = facts.sort(function (a, b) { return (a.filed < b.filed ? -1 : 1); })) !== null && _c !== void 0 ? _c : [];
-    };
-    FactSplitAdjuster.prototype.resolveProperty = function (propertyName) {
-        if (this.resolvedProperties.has(propertyName))
-            return;
-        var factsAscQuarter = this.getSortedFacts(propertyName, false);
-        var factsAscAnnual = this.getSortedFacts(propertyName, true);
-        this.adjustValuesForSplits({ facts: factsAscQuarter });
-        this.adjustValuesForSplits({ facts: factsAscAnnual });
-        this.resolvedProperties.add(propertyName);
-    };
-    FactSplitAdjuster.prototype.get = function (propertyName, year, fiscalPeriod) {
-        var _a;
-        this.resolveProperty(propertyName);
-        var key = "".concat(year, "_").concat(fiscalPeriod);
-        var isAnnual = fiscalPeriod === 'FY';
-        var bucket = isAnnual ? this.factsAnnaulByYearByPropertyName : this.factsByYearQuarterByPropertyName;
-        var fact = (_a = bucket.get(propertyName)) === null || _a === void 0 ? void 0 : _a.get(key);
-        return fact === null || fact === void 0 ? void 0 : fact.value;
-    };
-    FactSplitAdjuster.prototype.forEach = function (callback) {
-        var _this = this;
-        this.factsByYearQuarterByPropertyName.forEach(function (factsByYearQuarter, propertyName) {
-            _this.resolveProperty(propertyName);
-            factsByYearQuarter.forEach(function (fact, key) {
-                var _a = key.split('_'), year = _a[0], fiscalPeriod = _a[1];
-                callback({ propertyName: propertyName, year: Number(year), fiscalPeriod: fiscalPeriod, value: Number(fact.value) });
-            });
-        });
-        this.factsAnnaulByYearByPropertyName.forEach(function (factsByYear, propertyName) {
-            _this.resolveProperty(propertyName);
-            factsByYear.forEach(function (fact, key) {
-                var _a = key.split('_'), year = _a[0], fiscalPeriod = _a[1];
-                callback({ propertyName: propertyName, year: Number(year), fiscalPeriod: fiscalPeriod, value: Number(fact.value) });
-            });
-        });
-    };
-    FactSplitAdjuster.prototype.adjustValuesForSplits = function (params) {
-        var _a, _b;
-        var facts = params.facts;
-        var splits = this.getSplitsAsc();
-        if (facts.length === 0 || splits.length === 0)
-            return;
-        var isShareRatio = this.isShareRatioUnit(facts[0].unit);
-        for (var splitIndex = splits.length - 1; splitIndex >= 0; splitIndex--) {
-            var split = splits[splitIndex];
-            for (var factIndex = facts.length - 1; factIndex >= 0; factIndex--) {
-                var fact = facts[factIndex];
-                var value = fact.value, filed = fact.filed;
-                var nextFact = (_a = facts[factIndex + 1]) !== null && _a !== void 0 ? _a : null;
-                var prevFact = (_b = facts[factIndex - 1]) !== null && _b !== void 0 ? _b : null;
-                // const nextValue = facts[factIndex + 1]?.value ?? null
-                // const prevValue = facts[factIndex - 1]?.value ?? null
-                var didApplySplit = this.didApplySplit({
-                    // filed,
-                    isShareRatio: isShareRatio,
-                    // nextValue,
-                    // prevValue,
-                    fact: fact,
-                    nextFact: nextFact,
-                    prevFact: prevFact,
-                    split: split,
-                    // value,
-                });
-                if (didApplySplit || !split.value) {
-                    continue;
-                }
-                if (isShareRatio) {
-                    fact.value /= split.value;
-                }
-                else {
-                    fact.value *= split.value;
-                }
-            }
-        }
-    };
-    return FactSplitAdjuster;
-}());
-exports.default = FactSplitAdjuster;

package/build/services/ReportBuilder/ReportBuilder.d.ts

@@ -1,40 +0,0 @@
-import { CompanyFactListData, FiscalPeriod, ReportRaw } from '../../types';
-import { SetReportDatesParams } from './FactFiscalCalculator';
-export interface FactItem {
-    cik: number | string;
-    end: string;
-    filed: string;
-    name: string;
-    unit: string;
-    value: number | string;
-    start?: string;
-    hasSegments?: boolean;
-    accn?: string;
-    form?: string;
-    fp?: string;
-    frame?: string;
-    fy?: number;
-    /** For XBRL reports only */
-    segments?: {
-        value: string;
-        dimension: string;
-    }[];
-    uuid?: string;
-}
-export interface FactItemWithFiscals extends FactItem {
-    fiscalPeriod: FiscalPeriod;
-    year: number;
-}
-/**
- * Builds ReportRaw objects from facts. also applies splits and adjusts for fiscal periods.
- */
-export default class ReportBuilder {
-    private readonly factRecordBuilder;
-    createFacts(companyFacts: CompanyFactListData): {
-        facts: FactItem[];
-    };
-    buildReports(params: {
-        facts: FactItem[];
-        reportDates?: SetReportDatesParams[];
-    }): ReportRaw[];
-}

package/build/services/ReportBuilder/ReportBuilder.js

@@ -1,200 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var FactFiscalCalculator_1 = require("./FactFiscalCalculator");
-var FactPeriodResolver_1 = require("./FactPeriodResolver");
-var FactRecordBuilder_1 = require("./FactRecordBuilder");
-var FactSplitAdjuster_1 = require("./FactSplitAdjuster");
-/**
- * Builds ReportRaw objects from facts. also applies splits and adjusts for fiscal periods.
- */
-var ReportBuilder = /** @class */ (function () {
-    function ReportBuilder() {
-        this.factRecordBuilder = new FactRecordBuilder_1.default();
-    }
-    ReportBuilder.prototype.createFacts = function (companyFacts) {
-        return this.factRecordBuilder.createFacts(companyFacts);
-    };
-    ReportBuilder.prototype.buildReports = function (params) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
-        var facts = params.facts, reportDates = params.reportDates;
-        if (facts.length === 0) {
-            return [];
-        }
-        var accessionByYearQuarter = new Map();
-        reportDates === null || reportDates === void 0 ? void 0 : reportDates.forEach(function (params) {
-            var year = params.year, quarter = params.quarter, accn = params.accn;
-            if (accn)
-                accessionByYearQuarter.set("".concat(year, "_").concat(quarter), accn);
-        });
-        var reportsCik = Number(facts[0].cik);
-        var factFiscalCalculator = new FactFiscalCalculator_1.default();
-        var factPeriodResolver = new FactPeriodResolver_1.default({ cik: reportsCik });
-        var factSplitAdjuster = new FactSplitAdjuster_1.default();
-        facts.forEach(function (fact) { return factFiscalCalculator.add(fact); });
-        reportDates === null || reportDates === void 0 ? void 0 : reportDates.forEach(function (params) { return factFiscalCalculator.setReportDates(params); });
-        var unitByPropertyName = new Map();
-        var splitDateDataByKey = new Map();
-        var minYear = Infinity;
-        var maxYear = -Infinity;
-        var countByAccnByYearQuarter = new Map();
-        var filedByPropertyYearQuarterValue = new Map();
-        var filedLastByPropertyYearQuarterValue = new Map();
-        for (var _i = 0, facts_1 = facts; _i < facts_1.length; _i++) {
-            var fact = facts_1[_i];
-            var end = fact.end, name_1 = fact.name, unit = fact.unit, segments = fact.segments, start = fact.start, value = fact.value, cik = fact.cik, form = fact.form, filed = fact.filed, accn = fact.accn;
-            if (Number(fact.cik) !== Number(reportsCik)) {
-                throw new Error("All facts must have the same cik ".concat(reportsCik, " !== ").concat(Number(cik)));
-            }
-            var segmentValue = segments === null || segments === void 0 ? void 0 : segments.map(function (seg) { return "".concat(seg.dimension, "_").concat(seg.value); }).join('&');
-            var propertyName = (_a = name_1.split(':').pop()) !== null && _a !== void 0 ? _a : '';
-            var propertyNameWithSegment = propertyName + (segmentValue ? "_".concat(segmentValue) : '');
-            var _m = factFiscalCalculator.getFiscalYearQuarter({ dateStr: end }), quarter = _m.quarter, year = _m.year;
-            if (year < minYear)
-                minYear = year;
-            if (year > maxYear)
-                maxYear = year;
-            var splitKey = "".concat(year, "_").concat(value);
-            var factFiledKey = "".concat(year, "_").concat(quarter, "_").concat(propertyNameWithSegment, "_").concat(value);
-            var isSplit = factSplitAdjuster.isSplitProperty(propertyName);
-            unitByPropertyName.set(propertyNameWithSegment, unit);
-            var prevFirstFiled = filedByPropertyYearQuarterValue.get(factFiledKey);
-            var prevLastFiled = filedLastByPropertyYearQuarterValue.get(factFiledKey);
-            if (!prevFirstFiled || prevFirstFiled > filed) {
-                filedByPropertyYearQuarterValue.set(factFiledKey, filed);
-            }
-            if (!prevLastFiled || prevLastFiled < filed) {
-                filedLastByPropertyYearQuarterValue.set(factFiledKey, filed);
-            }
-            if (isSplit) {
-                var isNewLatestDate = new Date(end) > new Date((_c = (_b = splitDateDataByKey.get(splitKey)) === null || _b === void 0 ? void 0 : _b.end) !== null && _c !== void 0 ? _c : 0);
-                splitDateDataByKey.set(splitKey, {
-                    end: isNewLatestDate ? end : (_e = (_d = splitDateDataByKey.get(splitKey)) === null || _d === void 0 ? void 0 : _d.end) !== null && _e !== void 0 ? _e : end,
-                    quarter: isNewLatestDate ? quarter : (_g = (_f = splitDateDataByKey.get(splitKey)) === null || _f === void 0 ? void 0 : _f.quarter) !== null && _g !== void 0 ? _g : quarter,
-                    firstFiled: (_h = filedByPropertyYearQuarterValue.get(factFiledKey)) !== null && _h !== void 0 ? _h : filed,
-                    lastFiled: (_j = filedLastByPropertyYearQuarterValue.get(factFiledKey)) !== null && _j !== void 0 ? _j : filed,
-                });
-            }
-            var accnKey = "".concat(year, "_").concat(quarter);
-            var accnGiven = accessionByYearQuarter.get(accnKey);
-            var filedDistance = Math.abs(new Date(filed).getTime() - new Date(end !== null && end !== void 0 ? end : 0).getTime()) / 86400000;
-            var isFiledRecent = filedDistance < 60;
-            if (!accnGiven && isFiledRecent && accn && (!form || form === '10-K' || form === '10-Q')) {
-                var countByAccn = (_k = countByAccnByYearQuarter.get(accnKey)) !== null && _k !== void 0 ? _k : new Map();
-                countByAccn.set(accn, ((_l = countByAccn.get(accn)) !== null && _l !== void 0 ? _l : 0) + 1);
-                countByAccnByYearQuarter.set(accnKey, countByAccn);
-            }
-            factPeriodResolver.add({
-                year: year,
-                start: start,
-                end: end,
-                name: propertyNameWithSegment,
-                quarter: quarter,
-                value: value,
-                filed: filed,
-            });
-        }
-        countByAccnByYearQuarter.forEach(function (countByAccn, yearQuarter) {
-            if (accessionByYearQuarter.has(yearQuarter))
-                return;
-            var maxCount = 0;
-            var accessionNumber = '';
-            countByAccn.forEach(function (count, accn) {
-                if (count > maxCount) {
-                    maxCount = count;
-                    accessionNumber = accn;
-                }
-            });
-            accessionByYearQuarter.set(yearQuarter, accessionNumber);
-        });
-        minYear = Number.isFinite(minYear) ? minYear : new Date().getFullYear();
-        maxYear = Number.isFinite(maxYear) ? maxYear : new Date().getFullYear();
-        var reportsByKey = new Map();
-        // resolves quarterly and annual properties and creates reports
-        factPeriodResolver.forEach(function (data) {
-            var _a, _b;
-            var fiscalPeriod = data.fiscalPeriod, propertyName = data.propertyName, value = data.value, year = data.year;
-            var key = "".concat(year, "_").concat(fiscalPeriod);
-            var quarter = fiscalPeriod === 'FY' ? 4 : Number(fiscalPeriod[1]);
-            var dates = factFiscalCalculator.getDatesByYearQuarter({ quarter: quarter, year: year });
-            var _c = dates !== null && dates !== void 0 ? dates : { filed: '', end: '' }, filed = _c.filed, end = _c.end;
-            var accessionNumber = accessionByYearQuarter.get("".concat(year, "_").concat(quarter));
-            var accessionNoHyphen = accessionNumber === null || accessionNumber === void 0 ? void 0 : accessionNumber.replace(/-/g, '');
-            var url = accessionNumber
-                ? "https://www.sec.gov/Archives/edgar/data/".concat(reportsCik, "/").concat(accessionNoHyphen, "/").concat(accessionNumber, ".txt")
-                : null;
-            if (!reportsByKey.has(key)) {
-                reportsByKey.set(key, {
-                    cik: reportsCik,
-                    url: url,
-                    dateFiled: filed,
-                    dateReport: end,
-                    fiscalPeriod: fiscalPeriod,
-                    fiscalYear: year,
-                    splitDate: null,
-                    splitRatio: null,
-                });
-            }
-            var filedKey = "".concat(year, "_").concat(quarter, "_").concat(propertyName, "_").concat(value);
-            // add facts to adjust for splits
-            factSplitAdjuster.add({
-                end: end,
-                // use the original fact filed date instead of the report filed date to know if the fact has been split.
-                filed: (_a = filedByPropertyYearQuarterValue.get(filedKey)) !== null && _a !== void 0 ? _a : filed,
-                fiscalPeriod: fiscalPeriod,
-                name: propertyName,
-                unit: (_b = unitByPropertyName.get(propertyName)) !== null && _b !== void 0 ? _b : '',
-                year: year,
-                value: Number(value),
-                accn: accessionNumber !== null && accessionNumber !== void 0 ? accessionNumber : '',
-            });
-            var report = reportsByKey.get(key);
-            report[propertyName] = value;
-        });
-        // iterate through facts adjustable for splits and assign values to reports
-        factSplitAdjuster.forEach(function (data) {
-            var year = data.year, fiscalPeriod = data.fiscalPeriod, propertyName = data.propertyName, value = data.value;
-            var key = "".concat(year, "_").concat(fiscalPeriod);
-            var report = reportsByKey.get(key);
-            if (!report)
-                return;
-            report[propertyName] = Math.round(value * 10000) / 10000;
-        });
-        // add split dates and values to reports
-        factSplitAdjuster.getSplitsAsc().forEach(function (split) {
-            var _a, _b, _c, _d;
-            var _e = factFiscalCalculator.getFiscalYearQuarter({ dateStr: split.end }), quarter = _e.quarter, year = _e.year;
-            var keySplit = "".concat(year, "_").concat(split.value);
-            var splitDateData = (_a = splitDateDataByKey.get(keySplit)) !== null && _a !== void 0 ? _a : { end: null, quarter: null };
-            var splitDate = (_b = splitDateData.end) !== null && _b !== void 0 ? _b : split.filed;
-            var splitQuarter = (_c = splitDateData.quarter) !== null && _c !== void 0 ? _c : quarter;
-            var fiscalPeriod = "Q".concat(splitQuarter);
-            var keyReport = "".concat(year, "_").concat(fiscalPeriod);
-            var report = reportsByKey.get(keyReport);
-            var reportAnnual = splitQuarter === 4 ? (_d = reportsByKey.get("".concat(year, "_FY"))) !== null && _d !== void 0 ? _d : null : null;
-            if (report) {
-                report.splitRatio = split.value;
-                report.splitDate = splitDate;
-            }
-            // also assign to annual for Q4
-            if (reportAnnual) {
-                reportAnnual.splitRatio = split.value;
-                reportAnnual.splitDate = splitDate;
-            }
-        });
-        // sort reports ASC by year and quarter
-        var reportsSorted = [];
-        for (var year = minYear; year <= maxYear; year++) {
-            for (var i = 0; i < 5; i++) {
-                var fiscalPeriod = i === 4 ? 'FY' : "Q".concat(i + 1);
-                var key = "".concat(year, "_").concat(fiscalPeriod);
-                var report = reportsByKey.get(key);
-                if (report && report.dateReport) {
-                    reportsSorted.push(report);
-                }
-            }
-        }
-        return reportsSorted;
-    };
-    return ReportBuilder;
-}());
-exports.default = ReportBuilder;

package/build/services/ReportBuilder/ReportRawResolvable.d.ts

@@ -1,17 +0,0 @@
-import { ReportRaw } from '../../types';
-export type TemplateCode = 'I' | 'T' | 'B' | 'M' | 'N' | 'U';
-export default class ReportRawResolvable {
-    readonly report: ReportRaw;
-    private readonly emptyKeys;
-    private readonly addedProps;
-    private readonly calcMap;
-    private readonly templateCode;
-    private readonly keyStack;
-    constructor(report: ReportRaw, templateCode?: TemplateCode | null, calcMap?: Record<string, Record<string, string[]>>);
-    get(key: string): string | number | boolean | undefined;
-    getNumber(key: string): number;
-    isAdded(key: string): boolean;
-    private getChildKeysArr;
-    private calculateNumericKey;
-    toJSON(): ReportRaw;
-}