sec-edgar-api 0.2.2 → 0.2.3

package/build/services/ReportParser/ReportParser.d.ts

@@ -23,7 +23,7 @@ export default class ReportParser {
      *
      * @param companyFactListData This is the json file contents of CIK[number].json file from the SEC website. You can find these using their API or by downloading the companyfacts.zip file: https://www.sec.gov/edgar/sec-api-documentation
      */
-    parseReports(companyFactListData: Pick<CompanyFactListData, 'facts'>, usePropertyResolver?: boolean): ReportWrapper[];
+    parseReports(companyFactListData: CompanyFactListData, usePropertyResolver?: boolean): ReportWrapper[];
     /**
      * Same as parseReports but accepts ReportRaw[] instead of CompanyFactListData
      */
@@ -33,11 +33,11 @@ export default class ReportParser {
      *
      * @see https://www.sec.gov/edgar/sec-api-documentation
      */
-    parseReportsRaw(companyFactListData: Pick<CompanyFactListData, 'facts'>): ReportRaw[];
+    parseReportsRaw(companyFactListData: CompanyFactListData): ReportRaw[];
     /**
      * parseReportsRaw but removes meta data from the report
      */
-    parseReportsRawNoMeta(companyFactListData: Pick<CompanyFactListData, 'facts'>): Record<string, number>[];
+    parseReportsRawNoMeta(companyFactListData: CompanyFactListData): Record<string, number>[];
     /**
      * Translate ReportRaw to ReportTranslated by default, but can be used to translate to any object using both the callback and keyTranslator
      *

package/build/services/ReportParser/ReportParser.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 var key_translations_1 = require("../../util/key-translations");
+var ReportRawResolvable_1 = require("../ReportBuilder/ReportRawResolvable");
 var PropertyResolver_1 = require("./PropertyResolver");
 var ReportRawParser_1 = require("./ReportRawParser");
 var ReportWrapper_1 = require("./ReportWrapper");
@@ -79,22 +80,24 @@ var ReportParser = /** @class */ (function () {
     ReportParser.prototype.translateReportsRaw = function (reportsRaw, callback, keyTranslator) {
         var keyTranslations = (keyTranslator !== null && keyTranslator !== void 0 ? keyTranslator : this.keyTranslator);
         var reports = [];
-        reportsRaw.forEach(function (reportRaw) {
+        reportsRaw.forEach(function (report) {
             var reportNew = {};
+            var reportRaw = new ReportRawResolvable_1.default(report);
             // iterate translation keys, ensuring same order and priority
             for (var key in keyTranslations) {
                 var keysRaw = keyTranslations[key];
                 reportNew[key] = null;
                 for (var _i = 0, keysRaw_1 = keysRaw; _i < keysRaw_1.length; _i++) {
                     var keyRaw = keysRaw_1[_i];
-                    if (reportRaw[keyRaw] === undefined)
+                    var value = reportRaw.get(keyRaw);
+                    if (value === undefined)
                         continue;
-                    reportNew[key] = reportRaw[keyRaw];
+                    reportNew[key] = value;
                     break;
                 }
             }
             var reportFiltered = callback
-                ? callback(reportNew, reportRaw, keyTranslations)
+                ? callback(reportNew, reportRaw.report, keyTranslations)
                 : reportNew;
             reports.push(reportFiltered);
         });

package/build/services/ReportParser/ReportRawParser.d.ts

@@ -1,11 +1,5 @@
-import { CompanyFactListData, ReportRaw } from '../../types';
-import FactItemFactory from './FactItemFactory';
-interface ReportRawParserArgs {
-    factItemFactory?: FactItemFactory;
-}
+import { CompanyFactListData } from '../../types';
 export default class ReportRawParser {
-    private readonly factItemFactory;
-    constructor(args?: ReportRawParserArgs);
-    parseReports(companyFactListData: Pick<CompanyFactListData, 'facts'>): ReportRaw[];
+    private readonly reportBuilder;
+    parseReports(companyFactListData: CompanyFactListData): import("../../types").ReportRaw[];
 }
-export {};

package/build/services/ReportParser/ReportRawParser.js

@@ -1,41 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-var FactItemFactory_1 = require("./FactItemFactory");
+var ReportBuilder_1 = require("../ReportBuilder");
 var ReportRawParser = /** @class */ (function () {
-    function ReportRawParser(args) {
-        var _a = (args !== null && args !== void 0 ? args : {}).factItemFactory, factItemFactory = _a === void 0 ? new FactItemFactory_1.default() : _a;
-        this.factItemFactory = factItemFactory;
+    function ReportRawParser() {
+        this.reportBuilder = new ReportBuilder_1.default();
     }
     ReportRawParser.prototype.parseReports = function (companyFactListData) {
-        var _a;
-        var _b = this.factItemFactory.createFactItems(companyFactListData), factItems = _b.factItems, factSplitMap = _b.factSplitMap;
-        var reportByYearPeriod = new Map();
-        for (var _i = 0, factItems_1 = factItems; _i < factItems_1.length; _i++) {
-            var factItem = factItems_1[_i];
-            if (!factItem.factValue.frame) {
-                continue;
-            }
-            var key = "".concat(factItem.fiscalYear, "-").concat(factItem.fiscalPeriod);
-            var report = (_a = reportByYearPeriod.get(key)) !== null && _a !== void 0 ? _a : {
-                dateReport: factItem.fiscalPeriodEnd,
-                dateFiled: factItem.fiscalPeriodFiled,
-                fiscalPeriod: factItem.fiscalPeriod,
-                fiscalYear: factItem.fiscalYear,
-                splitRatio: null,
-                splitDate: null,
-            };
-            if (factSplitMap.isSplitFact(factItem)) {
-                report.splitRatio = factItem.factValue.val;
-                report.splitDate = factItem.factValue.end;
-            }
-            report[factItem.propertyName] = factSplitMap.getSplitAdjustedValue(factItem);
-            reportByYearPeriod.set(key, report);
-        }
-        return Array.from(reportByYearPeriod.values()).sort(function (a, b) {
-            var keyA = "".concat(a.dateReport, "_").concat(a.fiscalPeriod === 'FY' ? 'Q5' : a.fiscalPeriod);
-            var keyB = "".concat(b.dateReport, "_").concat(b.fiscalPeriod === 'FY' ? 'Q5' : b.fiscalPeriod);
-            return keyA < keyB ? -1 : 1;
-        });
+        var facts = this.reportBuilder.createFacts(companyFactListData).facts;
+        return this.reportBuilder.buildReports({ facts: facts });
     };
     return ReportRawParser;
 }());

package/build/services/ReportParser/ReportWrapper.js

@@ -28,6 +28,8 @@ var ReportWrapper = /** @class */ (function (_super) {
         _this.report = report;
         _this.reportMap = reportMap !== null && reportMap !== void 0 ? reportMap : new Map();
         _this.reportRaw = reportRaw !== null && reportRaw !== void 0 ? reportRaw : {
+            cik: report.cik,
+            url: report.url,
             dateFiled: report.dateFiled,
             dateReport: report.dateReport,
             fiscalPeriod: (_a = report.fiscalPeriod) !== null && _a !== void 0 ? _a : '',

package/build/services/ReportParser/resolvers/resolve-fiscal-year-cumulative-properties.js

@@ -62,7 +62,8 @@ function resolveFiscalYearCumulativeProperties(report) {
                 var rep = _c[_b];
                 if (rep && typeof rep[key] !== 'number') {
                     ;
-                    rep[key] = valueFY - sumQuarters;
+                    rep[key] =
+                        Math.round((valueFY - sumQuarters) * 10000) / 10000;
                     break;
                 }
             }

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

@@ -1,16 +1,17 @@
-import { CompanyFactFrame, CompanyFactListData, CompanyTickerItem, FieldDataResponse, FiscalPeriod, MultiCompanyFactFrame, ReportRaw, ReportTranslated } from '../../types';
+import { CompanyFactFrame, CompanyFactListData, CompanyTickerItem, FieldDataResponse, Form10KData, Form13GData, Form4Data, FormDef14aData, MultiCompanyFactFrame, ReportRaw, ReportTranslated } from '../../types';
 import { FilingListDetails, FilingListItemTranslated, SubmissionList } from '../../types/submission.type';
 import { IClient } from '../Client';
-import _parsers from '../DocumentParser/parsers';
+import DocumentParser from '../DocumentParser';
 import ReportParser from '../ReportParser';
 import ReportWrapper from '../ReportParser/ReportWrapper';
+import SubmissionRequestWrapper from './RequestWrapper';
 import { IThrottler } from './Throttler';
 interface SecApiArgs {
     throttler: IThrottler;
     client: IClient;
     cikBySymbol: Record<string, number>;
     reportParser: ReportParser;
-    parsers: typeof _parsers;
+    documentParser: DocumentParser;
 }
 export interface CreateRequestWrapperParams {
     /** symbol or cik */
@@ -46,7 +47,12 @@ export interface GetDocumentXMLParams {
     /** symbol or cik */
     symbol: string | number;
     accessionNumber: string;
-    primaryDocument?: string;
+    primaryDocument: string;
+}
+export interface GetSubmissionsParams {
+    /** symbol or cik */
+    symbol: string;
+    includeTranslated?: boolean;
 }
 /**
  * Gets reports from companies filed with the SEC
@@ -60,12 +66,11 @@ export default class SecEdgarApi {
     private readonly client;
     readonly cikBySymbol: Record<string, number>;
     readonly reportParser: ReportParser;
-    private readonly parsers;
+    readonly documentParser: DocumentParser;
     constructor(args?: SecApiArgs);
     private request;
     private mapFilingListDetails;
-    private filterSubmissionsInFiscalPeriodAsc;
-    private extractSubmissionsWithXml;
+    private getCreateRequestSubmissions;
     /**
      * If symbol is not in cikBySymbol, assume it is a cik. does not make a request
      */
@@ -80,7 +85,7 @@ export default class SecEdgarApi {
      *
      * endpoint: `/submissions/CIK${cik}.json`
      */
-    getSubmissions(params: GetSymbolParams): Promise<SubmissionList>;
+    getSubmissions(params: GetSubmissionsParams): Promise<SubmissionList>;
     /**
      * The company-concept API returns all the XBRL disclosures from a single company (CIK)
      * and concept (a taxonomy and tag) into a single JSON file, with a separate array
@@ -153,8 +158,7 @@ export default class SecEdgarApi {
      */
     getMutualFundList(): Promise<FieldDataResponse<'cik' | 'seriesId' | 'classId' | 'symbol'>>;
     /**
-     * Gets a raw xml document string. the parameters are found in the submission list response.
-     * (response.filings.recent or response.filings.recentTranslated)
+     * Gets a raw xml document string. the parameters are found in the submission list response. (response.filings.recent or response.filings.recentTranslated)
      *
      * Some form types can be parsed using the DocumentParser such as form 4 (insider transactions) and form 13g (institutional holders)
      *
@@ -176,94 +180,51 @@ export default class SecEdgarApi {
         url: string;
     }): Promise<string>;
     /**
-     * Used for getting security holdings.
-     *
-     * Forms: 13F, 13F/A, 13F-HR, 13F-HR/A
+     * Used for getting insider transactions. extracts insider transaction urls from submission list response, and parses the xml doc.
      *
-     * Extracts holdings urls from submission list response, and parses the xml doc.
+     * ```ts
+     * const submissions = await secEdgarApi.getSubmissions({ symbol: 'AAPL' })
+     * const requestWrapper = secEdgarApi.createRequestInsiderTransactions({ symbol: 'AAPL', filings: submissions.filings.recent })
      *
-     * Sends 2 requests by default, 1 request if submissions is provided, and 0 requests if documentXml is provided.
-     *
-     * WARNING: XML and HTML docs can be formatted differently and is prone to innacuracies.
+     * const transactions1 = (await requestWrapper.requestNext()).result.transactions // array of transactions from most recent doc
+     * const transactions2 = (await requestWrapper.requestNext()).result.transactions // array of transactions from second most recent doc
+     * ```
      */
-    getHoldings(params: {
-        symbol: string;
-        lookback?: number;
-        fiscalYear?: number;
-        fiscalPeriod?: FiscalPeriod;
-        submissions?: SubmissionList;
-        documentXml?: string;
-    }): Promise<{
-        url: string | null;
-        holdingsForm: import("../../types").Form13FData | null;
-        submissions: FilingListItemTranslated[];
-    }>;
+    createRequestInsiderTransactions(params: CreateRequestWrapperParams): SubmissionRequestWrapper<Form4Data>;
     /**
-     * Gets institutional holders that have a large stake in the company.
-     * If multiple submissions are found within the fiscal period, uses the first submission.
-     *
-     * Forms: SC 13G, SC 13G/A
+     * Used for getting institutional holders. extracts holders urls from submission list response, and parses the xml doc.
      *
-     * Sends 2 requests by default, 1 request if submissions is provided, and 0 requests if documentXml is provided.
+     * ```ts
+     * const submissions = await secEdgarApi.getSubmissions({ symbol: 'AAPL' })
+     * const requestWrapper = secEdgarApi.createRequestInstitutionalHolders({ symbol: 'AAPL', filings: submissions.filings.recent })
      *
-     * WARNING: XML and HTML docs can be formatted differently and is prone to innacuracies.
+     * const holders1 = (await requestWrapper.requestNext()).result.holders // array of holders from most recent doc
+     * const holders2 = (await requestWrapper.requestNext()).result.holders // array of holders from second most recent doc
+     * ```
      */
-    getInstitutionalHolders(params: {
-        symbol: string;
-        lookback?: number;
-        fiscalPeriod?: FiscalPeriod;
-        fiscalYear?: number;
-        submissions?: SubmissionList;
-        documentXml?: string;
-    }): Promise<{
-        url: string | null;
-        institutionalHolders: import("../../types").InstitutionalHolder[];
-        submissions: FilingListItemTranslated[];
-    }>;
+    createRequestInstitutionalHolders(params: CreateRequestWrapperParams): SubmissionRequestWrapper<Form13GData>;
     /**
-     * Gets executive compensation from the proxy statement.
+     * Used for getting earnings report tables from submission files.
      *
-     * Forms: DEF 14A
+     * ```ts
+     * const submissions = await secEdgarApi.getSubmissions({ symbol: 'AAPL' })
+     * const requestWrapper = secEdgarApi.createRequesEarningsReports({ symbol: 'AAPL', filings: submissions.filings.recent })
      *
-     * Sends 2 requests by default, 1 request if submissions is provided, and 0 requests if documentXml is provided.
-     *
-     * WARNING: XML and HTML docs can be formatted differently and is prone to innacuracies.
+     * const tables1 = (await requestWrapper.requestNext()).result.tables // array of tables from most recent doc
+     * const tables2 = (await requestWrapper.requestNext()).result.tables // array of tables from second most recent doc
+     * ```
      */
-    getExecutivesCompensation(params: {
-        symbol: string;
-        lookback?: number;
-        fiscalYear?: number;
-        submissions?: SubmissionList;
-        documentXml?: string;
-    }): Promise<{
-        url: string | null;
-        executiveCompensation: import("../../types").ExecutiveCompensation[];
-        submissions: FilingListItemTranslated[];
-    }>;
+    createRequestEarningsReports(params: CreateRequestWrapperParams): SubmissionRequestWrapper<Form10KData>;
     /**
-     * Gets insider transactions - when a company's executives buy or sell shares, options, or other securities in the company.
-     *
-     * Forms: 4, 4/A, 5, 5/A
+     * Proxy statement includes list of holders, executiveCompensation, and other tables. returns FormDef14aData
      *
-     * Sends 2 requests by default, 1 request if submissions is provided, and 0 requests if documentXml is provided.
+     * ```ts
+     * const submissions = await secEdgarApi.getSubmissions({ symbol: 'AAPL' })
+     * const requestWrapper = secEdgarApi.createRequesProxyStatement({ symbol: 'AAPL', filings: submissions.filings.recent })
      *
-     * WARNING: XML and HTML docs can be formatted differently and is prone to innacuracies.
-     */
-    getInsiderTransaction(params: {
-        symbol: string;
-        lookback: number;
-        submissions?: SubmissionList;
-        documentXml?: string;
-    }): Promise<{
-        url: string | null;
-        insiderTransaction: import("../../types").Form4Data | null;
-        submissions: FilingListItemTranslated[];
-    }>;
-    /**
-     * @see https://www.sec.gov/structureddata/rss-feeds-submitted-filings
+     * const { holders, executiveCompensation } = (await requestWrapper.requestNext()).result
+     * ```
      */
-    getCurrentFilings(params?: {
-        taxonomy?: 'usGaap' | 'mutualFund' | 'inlineXbrl' | 'allXbrl';
-    }): Promise<import("../../types/current-filings.type").CurrentFilingsList | null>;
+    createRequestProxyStatement(params: CreateRequestWrapperParams): SubmissionRequestWrapper<FormDef14aData>;
 }
 export {};