sec-edgar-api 0.4.1 → 0.5.0

package/build/services/ReportRawBuilder/FactFiscalCalculator.js

@@ -5,7 +5,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * Then measures the offset from the end date to the next/previous fiscal year end.
  */
 var FactFiscalCalculator = /** @class */ (function () {
-    function FactFiscalCalculator() {
+    function FactFiscalCalculator(params) {
+        var _this = this;
         this.endDateByYear = new Map();
         this.fiscalsByEndDate = new Map();
         this.datesByFiscals = new Map();
@@ -13,7 +14,39 @@ var FactFiscalCalculator = /** @class */ (function () {
         this.endDateCountMap = new Map();
         this.filedDateCountByEndDate = new Map();
         this.didResolve = false;
+        var _a = params !== null && params !== void 0 ? params : {}, _b = _a.facts, facts = _b === void 0 ? [] : _b, _c = _a.filings, filings = _c === void 0 ? [] : _c;
+        if (filings.length > 0) {
+            this.useFilingsForDates({ filings: filings });
+        }
+        facts.forEach(function (fact) { return _this.add(fact); });
     }
+    FactFiscalCalculator.prototype.useFilingsForDates = function (params) {
+        var _this = this;
+        var filings = params.filings;
+        var endDateByYear = new Map();
+        filings.forEach(function (_a) {
+            var reportDate = _a.reportDate, form = _a.form;
+            if (form === '10-K' || form === '20-F') {
+                endDateByYear.set(Number(reportDate.substring(0, 4)), new Date(reportDate));
+            }
+        });
+        filings.forEach(function (filing) {
+            if (filing.form === '10-K' || filing.form === '10-Q' || filing.form === '20-F' || filing.form === '40-F') {
+                var _a = _this.getFiscalYearQuarter({
+                    dateStr: filing.reportDate,
+                    endDateByYear: endDateByYear,
+                }), quarter = _a.quarter, year = _a.year;
+                _this.setReportDates({
+                    accn: filing.accessionNumber,
+                    end: filing.reportDate,
+                    filed: filing.filingDate,
+                    isAnnual: filing.form === '10-K' || filing.form === '20-F',
+                    quarter: quarter,
+                    year: year,
+                });
+            }
+        });
+    };
     FactFiscalCalculator.prototype.add = function (fact) {
         var _a, _b, _c;
         var end = fact.end, filed = fact.filed;

package/build/services/ReportRawBuilder/FactGrouper.d.ts

@@ -1,4 +1,4 @@
-import { FactItem, FactGroup, SplitData } from '../../types';
+import type { FactItem, FactGroup, SplitData } from '../../types';
 import FactFiscalCalculator from './FactFiscalCalculator';
 /**
  * There are many facts properties for the same period but filed at different times.

package/build/services/ReportRawBuilder/FactPeriodResolver.d.ts

@@ -1,4 +1,4 @@
-import { FiscalPeriod } from '../../types/report-raw.type';
+import type { FiscalPeriod } from '../../types/report-raw.type';
 /**
  * Resolves quarterly and annual values for a property. This is because filers provide total values for the
  * current fiscal year, rather than values for the individual quarters

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

@@ -1,4 +1,4 @@
-import { CompanyFactListData, FactItem } from '../../types';
+import type { CompanyFactListData, FactItem } from '../../types';
 /**
  * Builds an array of fact records.
  */

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

@@ -1,4 +1,4 @@
-import { CompanyFactListData, FactGroup, FactItem, FactValue, SplitData } from '../../types';
+import type { CompanyFactListData, FactGroup, FactItem, FactValue, SplitData } from '../../types';
 /**
  * Splits can be filed multiple times throughout different reports. There is no clear
  * indication on when the split is executed or what facts the split has been applied to. This

package/build/services/ReportRawBuilder/ReportRawBuilder.d.ts

@@ -1,6 +1,6 @@
-import { CompanyFactListData, FactGroup, FactItem, ReportRaw, SplitData } from '../../types';
+import type { CompanyFactListData, FactGroup, FactItem, ReportRaw, SplitData } from '../../types';
 import FactFiscalCalculator, { SetReportDatesParams } from './FactFiscalCalculator';
-interface BuildReportsParams {
+export interface BuildReportsParams {
     facts: FactItem[];
     /**
      * for more accurate dates, add this. Otherwise, dates will be inferred
@@ -37,4 +37,3 @@ export default class ReportRawBuilder {
         cik: number;
     }): ReportRaw[];
 }
-export {};

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

@@ -1,4 +1,4 @@
-import { FilingListDetails, FilingListItemTranslated } from '../../types';
+import type { FilingListDetails, FilingListItemTranslated } from '../../types';
 export default class FilingMapper {
     mapFilingListDetails(cik: string | number, filingListDetails: FilingListDetails): FilingListItemTranslated[];
 }

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

@@ -1,4 +1,4 @@
-import { FilingListItemTranslated } from '../../types/submission.type';
+import type { FilingListItemTranslated } from '../../types/submission.type';
 export interface SubmissionRequestWrapperOptions {
     maxRequests?: number;
 }

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

@@ -1,5 +1,4 @@
-import { CompanyFactFrame, CompanyFactListData, CompanyTickerItem, DailyFilingFormType, FieldDataResponse, Form10KData, Form13GData, Form4Data, FormDef14aData, MultiCompanyFactFrame, ReportRaw, ReportTranslated } from '../../types';
-import { FilingListDetails, FilingListItemTranslated, SubmissionList } from '../../types/submission.type';
+import type { CompanyFactFrame, CompanyFactListData, CompanyTickerItem, DailyFilingFormType, FieldDataResponse, Form10KData, Form13GData, Form4Data, FormDef14aData, MultiCompanyFactFrame, ReportRaw, ReportTranslated, FilingListDetails, FilingListItemTranslated, SubmissionList, CalculationMap } from '../../types';
 import { IClient } from '../Client';
 import DocumentParser from '../DocumentParser';
 import ReportParser from '../ReportParser';
@@ -160,6 +159,19 @@ export default class SecEdgarApi {
      * endpoint `/api/xbrl/frames/${taxonomy}/${fact}/${unit}/${frame}.json`
      */
     getFactFrame(params: GetFactFrameParams): Promise<MultiCompanyFactFrame>;
+    /**
+     * Note: Properties that are not provied from report are calculated an may not be accurate,
+     * verify results finance.yahoo.com (ex: https://finance.yahoo.com/quote/AAPL/financials)
+     *
+     * Please contribute to improve resolving report properties: https://github.com/andyevers/sec-edgar-api
+     *
+     * Parses reports from company facts. Calculates missing properties and uses a single interface
+     * for all reports. This includes only 10-K and 10-Q annual and quarterly reports. To include
+     * all reports, use getReportsRaw.
+     *
+     * @deprecated Formerly getReports. This will be removed in a future version.
+     */
+    getReportsLegacy<T extends GetReportsParams>(params: T): Promise<T['withWrapper'] extends true ? ReportWrapper[] : ReportTranslated[]>;
     /**
      * Note: Properties that are not provied from report are calculated an may not be accurate,
      * verify results finance.yahoo.com (ex: https://finance.yahoo.com/quote/AAPL/financials)
@@ -170,7 +182,12 @@ export default class SecEdgarApi {
      * for all reports. This includes only 10-K and 10-Q annual and quarterly reports. To include
      * all reports, use getReportsRaw.
      */
-    getReports<T extends GetReportsParams>(params: T): Promise<T['withWrapper'] extends true ? ReportWrapper[] : ReportTranslated[]>;
+    getReports<R = ReportTranslated>(params: {
+        symbol: string | number;
+        adjustForSplits?: boolean;
+        resolvePeriodValues?: boolean;
+        calculationMap?: CalculationMap<R>;
+    }): Promise<(typeof params.calculationMap extends undefined ? ReportTranslated : ReportRaw & R)[]>;
     /**
      * Parses reports from company facts.
      */
@@ -216,7 +233,7 @@ export default class SecEdgarApi {
      */
     getDocumentXbrl(params: GetDocumentXbrlParams): Promise<import("../DocumentParser/XBRLParser/XBRLParser").XbrlParseResult & {
         report: ReportRaw | null;
-        facts: import("../../types").FactItem[];
+        facts: import("../../types").FactItemExtended[];
         xml: string;
     }>;
     /**
@@ -301,7 +318,7 @@ 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>;
     /**

package/build/services/SecEdgarApi/SecEdgarApi.js

@@ -270,8 +270,10 @@ var SecEdgarApi = /** @class */ (function () {
      * Parses reports from company facts. Calculates missing properties and uses a single interface
      * for all reports. This includes only 10-K and 10-Q annual and quarterly reports. To include
      * all reports, use getReportsRaw.
+     *
+     * @deprecated Formerly getReports. This will be removed in a future version.
      */
-    SecEdgarApi.prototype.getReports = function (params) {
+    SecEdgarApi.prototype.getReportsLegacy = function (params) {
         return __awaiter(this, void 0, void 0, function () {
             var _a, withWrapper, _b, usePropertyResolver, reportsRaw, reportsWithWrapper, reports;
             return __generator(this, function (_c) {
@@ -281,13 +283,41 @@ var SecEdgarApi = /** @class */ (function () {
                         return [4 /*yield*/, this.getReportsRaw(__assign(__assign({}, params), { includeNamePrefix: false }))];
                     case 1:
                         reportsRaw = _c.sent();
-                        reportsWithWrapper = this.reportParser.parseReportsFromRaw({ reportsRaw: reportsRaw, usePropertyResolver: usePropertyResolver });
+                        reportsWithWrapper = this.reportParser.parseReportsFromRawLegacy({ reportsRaw: reportsRaw, usePropertyResolver: usePropertyResolver });
                         reports = withWrapper ? reportsWithWrapper : reportsWithWrapper.map(function (report) { return report.getReport(); });
                         return [2 /*return*/, reports];
                 }
             });
         });
     };
+    /**
+     * Note: Properties that are not provied from report are calculated an may not be accurate,
+     * verify results finance.yahoo.com (ex: https://finance.yahoo.com/quote/AAPL/financials)
+     *
+     * Please contribute to improve resolving report properties: https://github.com/andyevers/sec-edgar-api
+     *
+     * Parses reports from company facts. Calculates missing properties and uses a single interface
+     * for all reports. This includes only 10-K and 10-Q annual and quarterly reports. To include
+     * all reports, use getReportsRaw.
+     */
+    SecEdgarApi.prototype.getReports = function (params) {
+        return __awaiter(this, void 0, void 0, function () {
+            var calculationMap, reportsRaw;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        calculationMap = params.calculationMap;
+                        return [4 /*yield*/, this.getReportsRaw(__assign(__assign({}, params), { includeNamePrefix: true }))];
+                    case 1:
+                        reportsRaw = _a.sent();
+                        return [2 /*return*/, this.reportParser.parseReportsFromRaw({
+                                reportsRaw: reportsRaw,
+                                calculationMap: calculationMap,
+                            })];
+                }
+            });
+        });
+    };
     /**
      * Parses reports from company facts.
      */
@@ -403,7 +433,7 @@ var SecEdgarApi = /** @class */ (function () {
      */
     SecEdgarApi.prototype.buildDocumentUrl = function (params) {
         var symbol = params.symbol, accessionNumber = params.accessionNumber, fileNameProp = params.fileName;
-        var cik = this.getCikString(symbol);
+        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);
     };
@@ -598,7 +628,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;
@@ -620,7 +650,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) {

package/build/types/calculation-map.type.d.ts

@@ -0,0 +1,13 @@
+export type CalculationMap<T = any> = Record<keyof T, CalculationMapItem>;
+export interface CalculationMapCalculationItem {
+    key: string;
+    weight: number;
+    isRequired: boolean;
+}
+export interface CalculationMapCalculation {
+    calculation: CalculationMapCalculationItem[];
+}
+export interface CalculationMapItem {
+    groups: CalculationMapCalculation[];
+}
+export type CalculationMapCondensed<T = object> = Record<keyof T, (string | number)[][][]>;

package/build/types/calculation-map.type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,4 +1,4 @@
-import { FactItem } from './company-facts.type';
+import type { FactItem } from './company-facts.type';
 export interface XMLParams {
     xml: string;
 }
@@ -42,12 +42,3 @@ export interface FactGroup {
     valueTrailingFirst: number | string | null;
     valueTrailingLast: number | string | 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,4 +1,4 @@
-import { FiscalPeriod } from './report-raw.type';
+import type { FiscalPeriod } from './report-raw.type';
 export interface CompanyFactListData {
     cik: number;
     entityName: string;
@@ -74,6 +74,11 @@ export interface FactItem {
     }[];
     uuid?: string;
 }
+export interface FactItemExtended extends FactItem {
+    isUsedInReport?: boolean;
+    decimals?: number;
+    scale?: number;
+}
 export interface FactItemWithFiscals extends FactItem {
     fiscalPeriod: FiscalPeriod;
     year: number;

package/build/types/index.d.ts

@@ -1,9 +1,11 @@
-export * from './company-facts.type';
-export * from './report-raw.type';
-export * from './report-translated.type';
-export * from './submission.type';
-export * from './parsed-filings.type';
-export * from './common.type';
-export * from './insider-transaction.type';
-export * from './company-search.type';
-export * from './current-filings.type';
+export type * from './company-facts.type';
+export type * from './report-raw.type';
+export type * from './report-translated.type';
+export type * from './submission.type';
+export type * from './parsed-filings.type';
+export type * from './common.type';
+export type * from './insider-transaction.type';
+export type * from './company-search.type';
+export type * from './current-filings.type';
+export type * from './xbrl.type';
+export type * from './calculation-map.type';

package/build/types/index.js

@@ -1,25 +1,2 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./company-facts.type"), exports);
-__exportStar(require("./report-raw.type"), exports);
-__exportStar(require("./report-translated.type"), exports);
-__exportStar(require("./submission.type"), exports);
-__exportStar(require("./parsed-filings.type"), exports);
-__exportStar(require("./common.type"), exports);
-__exportStar(require("./insider-transaction.type"), exports);
-__exportStar(require("./company-search.type"), exports);
-__exportStar(require("./current-filings.type"), exports);

package/build/types/report-translated.type.d.ts

@@ -1,4 +1,4 @@
-import { FiscalPeriod } from './report-raw.type';
+import type { FiscalPeriod } from './report-raw.type';
 export interface ReportTranslated {
     cik: number;
     url: string | null;
@@ -28,7 +28,6 @@ export interface ReportTranslated {
     liabilityNonCurrentDebt: number | null;
     equityTotal: number | null;
     equityRetainedEarnings: number | null;
-    equityStockPreferred: number | null;
     sharesOutstanding: number | null;
     sharesOutstandingDiluted: number | null;
     eps: number | null;
@@ -48,13 +47,17 @@ export interface ReportTranslated {
     expenseDepreciationAccumulated: number | null;
     expenseStockCompensation: number | null;
     expenseNonCashOther: number | null;
+    expenseSellingGeneralAdministrative: number | null;
     incomeOperating: number | null;
     incomeNet: number | null;
+    incomePretax: number | null;
     cashFlowFree: number | null;
     cashFlowDividendsPaid: number | null;
     cashFlowDividendsPaidPreferred: number | null;
-    cashFlowCapex: number | null;
     cashFlowOperating: number | null;
+    cashFlowInvesting: number | null;
+    cashFlowFinancing: number | null;
+    cashFlowCapex: number | null;
     cashFlowDeferredTax: number | null;
     cashFlowWorkingCapitalNonCash: number | null;
 }

package/build/util/calculation-map.d.ts

@@ -0,0 +1,2 @@
+import { CalculationMapCondensed, ReportTranslated } from '../types';
+export declare const calculationMapCondensed: CalculationMapCondensed<ReportTranslated>;