sec-edgar-api 0.3.3 → 0.4.0

package/build/services/ReportRawBuilder/ReportRawBuilder.js

@@ -36,7 +36,8 @@ var ReportRawBuilder = /** @class */ (function () {
                 accessionByYearQuarter.set("".concat(year, "_").concat(quarter), accn);
         });
         var reportsCik = Number(facts[0].cik);
-        var fiscalCalculator = this.createFiscalCalculator({ facts: facts });
+        var fiscalCalculator = reportDates ? new FactFiscalCalculator_1.default() : this.createFiscalCalculator({ facts: facts });
+        reportDates === null || reportDates === void 0 ? void 0 : reportDates.forEach(function (params) { return fiscalCalculator.setReportDates(params); });
         var factGrouper = new FactGrouper_1.default();
         var factSplitAdjuster = new FactSplitAdjuster_1.default();
         // if splits not included in params and need to adjust, extract from facts
@@ -65,12 +66,11 @@ var ReportRawBuilder = /** @class */ (function () {
         return "".concat(year, "_").concat(isAnnual ? 'FY' : "Q".concat(quarter));
     };
     ReportRawBuilder.prototype.createReport = function (params) {
-        var _a;
-        var group = params.group, isAnnual = params.isAnnual, splitDate = params.splitDate, splitRatio = params.splitRatio, cik = params.cik;
+        var group = params.group, isAnnual = params.isAnnual, splitDate = params.splitDate, splitRatio = params.splitRatio, cik = params.cik, accessionNumber = params.accessionNumber;
         var fiscalPeriod = isAnnual ? 'FY' : "Q".concat(group.quarter);
-        var accessionNoHyphen = (_a = group.accn) === null || _a === void 0 ? void 0 : _a.replace(/-/g, '');
-        var url = group.accn
-            ? "https://www.sec.gov/Archives/edgar/data/".concat(cik, "/").concat(accessionNoHyphen, "/").concat(group.accn, ".txt")
+        var accessionNoHyphen = accessionNumber === null || accessionNumber === void 0 ? void 0 : accessionNumber.replace(/-/g, '');
+        var url = accessionNumber
+            ? "https://www.sec.gov/Archives/edgar/data/".concat(cik, "/").concat(accessionNoHyphen, "/").concat(accessionNumber, ".txt")
             : null;
         return {
             cik: cik,
@@ -89,7 +89,7 @@ var ReportRawBuilder = /** @class */ (function () {
     };
     ReportRawBuilder.prototype.buildReportsFromGroups = function (params) {
         var _this = this;
-        var factGroupsByReportKey = params.factGroupsByReportKey, minYear = params.minYear, maxYear = params.maxYear, cik = params.cik, splits = params.splits, fiscalCalculator = params.fiscalCalculator;
+        var factGroupsByReportKey = params.factGroupsByReportKey, minYear = params.minYear, maxYear = params.maxYear, cik = params.cik, splits = params.splits, fiscalCalculator = params.fiscalCalculator, accessionByYearQuarter = params.accessionByYearQuarter;
         var splitByFiscals = new Map();
         var reportByKey = new Map();
         splits === null || splits === void 0 ? void 0 : splits.forEach(function (split) {
@@ -97,16 +97,19 @@ var ReportRawBuilder = /** @class */ (function () {
             splitByFiscals.set("".concat(year, "_").concat(quarter), split);
         });
         factGroupsByReportKey.forEach(function (groups) {
-            var _a, _b, _c, _d, _e, _f;
+            var _a, _b, _c, _d, _e, _f, _g;
             var groupWithDates = groups.find(function (g) { return g.reportEnd; });
             if (!groupWithDates)
                 return;
-            var split = splitByFiscals.get("".concat(groupWithDates.fiscalYear, "_").concat(groupWithDates.quarter));
-            var splitDate = (_a = split === null || split === void 0 ? void 0 : split.endLast) !== null && _a !== void 0 ? _a : null;
-            var splitRatio = (_b = split === null || split === void 0 ? void 0 : split.splitRatio) !== null && _b !== void 0 ? _b : null;
+            var keyYearQuarter = "".concat(groupWithDates.fiscalYear, "_").concat(groupWithDates.quarter);
+            var split = splitByFiscals.get(keyYearQuarter);
+            var accessionNumber = (_a = accessionByYearQuarter === null || accessionByYearQuarter === void 0 ? void 0 : accessionByYearQuarter.get(keyYearQuarter)) !== null && _a !== void 0 ? _a : groupWithDates.accn;
+            var splitDate = (_b = split === null || split === void 0 ? void 0 : split.endLast) !== null && _b !== void 0 ? _b : null;
+            var splitRatio = (_c = split === null || split === void 0 ? void 0 : split.splitRatio) !== null && _c !== void 0 ? _c : null;
             var quarter = groupWithDates.quarter;
             var reportPeriod = _this.createReport({
                 group: groupWithDates,
+                accessionNumber: accessionNumber,
                 cik: cik,
                 isAnnual: false,
                 splitDate: splitDate,
@@ -119,7 +122,7 @@ var ReportRawBuilder = /** @class */ (function () {
             });
             for (var _i = 0, groups_1 = groups; _i < groups_1.length; _i++) {
                 var group = groups_1[_i];
-                var value = (_d = (_c = group.valuePeriodResolved) !== null && _c !== void 0 ? _c : group.valuePeriodFirst) !== null && _d !== void 0 ? _d : 0;
+                var value = (_e = (_d = group.valuePeriodResolved) !== null && _d !== void 0 ? _d : group.valuePeriodFirst) !== null && _e !== void 0 ? _e : 0;
                 reportPeriod[group.name] = _this.round(value);
             }
             reportByKey.set(reportKeyPeriod, reportPeriod);
@@ -127,20 +130,22 @@ var ReportRawBuilder = /** @class */ (function () {
                 return;
             var reportAnnual = _this.createReport({
                 group: groupWithDates,
+                accessionNumber: accessionNumber,
                 cik: cik,
                 isAnnual: true,
                 splitDate: splitDate,
                 splitRatio: splitRatio,
             });
             var reportKeyAnnual = "".concat(reportAnnual.fiscalYear, "_").concat(reportAnnual.fiscalPeriod);
-            for (var _g = 0, groups_2 = groups; _g < groups_2.length; _g++) {
-                var group = groups_2[_g];
-                var value = (_f = (_e = group.valueTrailingResolved) !== null && _e !== void 0 ? _e : group.valueTrailingFirst) !== null && _f !== void 0 ? _f : 0;
+            for (var _h = 0, groups_2 = groups; _h < groups_2.length; _h++) {
+                var group = groups_2[_h];
+                var value = (_g = (_f = group.valueTrailingResolved) !== null && _f !== void 0 ? _f : group.valueTrailingFirst) !== null && _g !== void 0 ? _g : 0;
                 reportAnnual[group.name] = _this.round(value);
             }
             reportByKey.set(reportKeyAnnual, reportAnnual);
         });
         var reports = [];
+        // sort reports by year and quarter
         for (var year = minYear; year <= maxYear; year++) {
             for (var quarter = 1; quarter <= 5; quarter++) {
                 var isAnnual = quarter === 5;

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

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

package/build/services/SecEdgarApi/FilingMapper.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var FilingMapper = /** @class */ (function () {
+    function FilingMapper() {
+    }
+    FilingMapper.prototype.mapFilingListDetails = function (cik, filingListDetails) {
+        var _a;
+        var filings = [];
+        var accessionNumbers = filingListDetails.accessionNumber;
+        for (var i = 0; i < accessionNumbers.length; i++) {
+            var accessionStrTrimmed = (_a = accessionNumbers[i]) === null || _a === void 0 ? void 0 : _a.replace(/-/g, '');
+            var urlPrefix = "https://www.sec.gov/Archives/edgar/data/".concat(Number(cik), "/").concat(accessionStrTrimmed);
+            var filing = {
+                accessionNumber: accessionNumbers[i],
+                filingDate: filingListDetails.filingDate[i],
+                reportDate: filingListDetails.reportDate[i],
+                acceptanceDateTime: filingListDetails.acceptanceDateTime[i],
+                act: filingListDetails.act[i],
+                form: filingListDetails.form[i],
+                fileNumber: filingListDetails.fileNumber[i],
+                filmNumber: filingListDetails.filmNumber[i],
+                items: filingListDetails.items[i],
+                size: filingListDetails.size[i],
+                isXBRL: filingListDetails.isXBRL[i],
+                isInlineXBRL: filingListDetails.isInlineXBRL[i],
+                primaryDocument: filingListDetails.primaryDocument[i],
+                primaryDocDescription: filingListDetails.primaryDocDescription[i],
+                url: "".concat(urlPrefix, "/").concat(accessionNumbers[i], ".txt"),
+                urlPrimaryDocument: "".concat(urlPrefix, "/").concat(filingListDetails.primaryDocument[i]),
+            };
+            filings.push(filing);
+        }
+        return filings;
+    };
+    return FilingMapper;
+}());
+exports.default = FilingMapper;

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

@@ -7,6 +7,7 @@ export interface SendRequestParams {
 }
 interface SubmissionRequestWrapperArgs<T> {
     submissions: FilingListItemTranslated[];
+    usePrimaryDocument: boolean;
     options?: SubmissionRequestWrapperOptions;
     sendRequest: (params: SendRequestParams) => Promise<T>;
 }
@@ -20,6 +21,7 @@ export default class SubmissionRequestWrapper<T> {
     private readonly options;
     private readonly submissions;
     private readonly errors;
+    private readonly usePrimaryDocument;
     private readonly sendRequest;
     private requestCount;
     private isDone;

package/build/services/SecEdgarApi/RequestWrapper.js

@@ -38,11 +38,12 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 Object.defineProperty(exports, "__esModule", { value: true });
 var SubmissionRequestWrapper = /** @class */ (function () {
     function SubmissionRequestWrapper(args) {
-        var submissions = args.submissions, _a = args.options, options = _a === void 0 ? {} : _a, sendRequest = args.sendRequest;
+        var submissions = args.submissions, _a = args.options, options = _a === void 0 ? {} : _a, sendRequest = args.sendRequest, usePrimaryDocument = args.usePrimaryDocument;
         this.options = options;
         this.submissions = submissions;
         this.results = [];
         this.errors = [];
+        this.usePrimaryDocument = usePrimaryDocument;
         this.sendRequest = sendRequest;
         this.requestCount = 0;
         this.isDone = (options === null || options === void 0 ? void 0 : options.maxRequests) === 0;
@@ -55,7 +56,7 @@ var SubmissionRequestWrapper = /** @class */ (function () {
     };
     SubmissionRequestWrapper.prototype.requestNext = function () {
         return __awaiter(this, void 0, void 0, function () {
-            var _a, maxRequests, submission, isComplete, url, result, data, e_1, error;
+            var _a, maxRequests, submission, isComplete, url, urlPrimaryDocument, requestUrl, result, data, e_1, error;
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
@@ -69,7 +70,8 @@ var SubmissionRequestWrapper = /** @class */ (function () {
                                     result: null,
                                 }];
                         }
-                        url = submission.url;
+                        url = submission.url, urlPrimaryDocument = submission.urlPrimaryDocument;
+                        requestUrl = this.usePrimaryDocument ? urlPrimaryDocument : url;
                         this.requestCount++;
                         if (this.requestCount >= this.submissions.length || this.requestCount >= maxRequests) {
                             this.isDone = true;
@@ -77,7 +79,7 @@ var SubmissionRequestWrapper = /** @class */ (function () {
                         _b.label = 1;
                     case 1:
                         _b.trys.push([1, 3, , 4]);
-                        return [4 /*yield*/, this.sendRequest({ url: url })];
+                        return [4 /*yield*/, this.sendRequest({ url: requestUrl })];
                     case 2:
                         result = _b.sent();
                         data = {

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

@@ -2,8 +2,10 @@ import { CompanyFactFrame, CompanyFactListData, CompanyTickerItem, DailyFilingFo
 import { FilingListDetails, FilingListItemTranslated, SubmissionList } from '../../types/submission.type';
 import { IClient } from '../Client';
 import DocumentParser from '../DocumentParser';
+import { ParseXbrlOptions } from '../DocumentParser/XBRLParser/XBRLParser';
 import ReportParser from '../ReportParser';
 import ReportWrapper from '../ReportParser/ReportWrapper';
+import FilingMapper from './FilingMapper';
 import SubmissionRequestWrapper from './RequestWrapper';
 import { IThrottler } from './Throttler';
 interface SecApiArgs {
@@ -12,6 +14,7 @@ interface SecApiArgs {
     cikBySymbol: Record<string, number>;
     reportParser: ReportParser;
     documentParser: DocumentParser;
+    filingMapper?: FilingMapper;
 }
 export interface CreateRequestWrapperParams {
     /** symbol or cik */
@@ -57,6 +60,29 @@ export interface GetDocumentXMLParams {
     accessionNumber: string;
     primaryDocument: string;
 }
+export interface GetInsiderTransactionsParams {
+    page: number;
+    symbol: string | number;
+    itemsPerPage?: number;
+    isOwnerCik?: boolean;
+}
+export interface SearchCompaniesParams {
+    sic?: number;
+    /** Abbreviation of state: IL, CA, NY, etc... */
+    state?: string;
+    page: number;
+    itemsPerPage?: number;
+    /** Partial name of the company for search. */
+    company?: string;
+    companyMatch?: 'startsWith' | 'contains';
+}
+interface GetCurrentFilingsParams {
+    formType?: '4' | '3' | '10-Q' | '10-K' | 'SC 13G' | '13F-HR' | '8-K';
+    page?: number;
+    itemsPerPage?: number;
+    symbol?: string | number;
+    searchType?: 'include' | 'exclude' | 'only';
+}
 /**
  * Gets reports from companies filed with the SEC
  *
@@ -67,6 +93,7 @@ export default class SecEdgarApi {
     private readonly baseUrlSec;
     private readonly throttler;
     private readonly client;
+    private readonly filingMapper;
     readonly cikBySymbol: Record<string, number>;
     readonly reportParser: ReportParser;
     readonly documentParser: DocumentParser;
@@ -88,7 +115,9 @@ export default class SecEdgarApi {
      *
      * endpoint: `/submissions/CIK${cik}.json`
      */
-    getSubmissions(params: GetSymbolParams): Promise<{
+    getSubmissions(params: GetSymbolParams & {
+        includeOldFilings?: boolean;
+    }): Promise<{
         submissionList: SubmissionList;
         filings: FilingListItemTranslated[];
     }>;
@@ -232,12 +261,13 @@ export default class SecEdgarApi {
      */
     createRequestProxyStatement(params: CreateRequestWrapperParams): SubmissionRequestWrapper<FormDef14aData>;
     /**
-     * Gets list of latest filings.
+     * Gets list of filings for a day up to 5 days ago.
      *
      * @see https://www.sec.gov/edgar/searchedgar/currentevents
      */
     getCurrentFilingsDaily(params?: {
         formType?: DailyFilingFormType;
+        /** max 5 */
         lookbackDays?: number;
     }): Promise<{
         date: string;
@@ -251,5 +281,39 @@ export default class SecEdgarApi {
             filedDate: string;
         }[];
     }>;
+    getCurrentFilings(params?: GetCurrentFilingsParams): Promise<import("../../types").CurrentFilingsList>;
+    /**
+     * @see https://www.sec.gov/structureddata/rss-feeds-submitted-filings
+     */
+    getCurrentFilingsXBRL(params?: {
+        taxonomy?: 'usGaap' | 'mutualFund' | 'inlineXbrl' | 'allXbrl';
+    }): Promise<import("../../types").CurrentFilingsXBRL>;
+    getDocumentXbrl(params: {
+        url: string;
+    } & ParseXbrlOptions & {
+        includeReport?: boolean;
+    }): Promise<import("../DocumentParser/XBRLParser/XBRLParser").XbrlParseResult & {
+        report: ReportRaw | null;
+        facts: import("../../types").FactItem[];
+    }>;
+    /**
+     * Gets insider transactions for a provided symbol or CIK.
+     *
+     * To get transactions by a specific owner, set isOwnerCik to true and provide
+     * the owner CIK for the symbol parameter.
+     *
+     * example at https://www.sec.gov/cgi-bin/own-disp?action=getissuer&CIK=0000320193
+     */
+    getInsiderTransactions(params: GetInsiderTransactionsParams): Promise<{
+        transactions: import("../../types").InsiderTransaction[];
+        owners: import("../../types").Owner[];
+        issuers: import("../../types").Issuer[];
+    }>;
+    /**
+     * Search for companies from by name, sic code, or state.
+     */
+    searchCompanies(params: SearchCompaniesParams): Promise<{
+        items: import("../../types").CompanySearchResult[];
+    }>;
 }
 export {};