sec-edgar-api 0.0.6 → 0.1.0

package/build/services/ReportParser/ReportParser.js

@@ -21,16 +21,18 @@ var ReportParser = /** @class */ (function () {
      *
      * @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
      */
-    ReportParser.prototype.parseReports = function (companyFactListData) {
+    ReportParser.prototype.parseReports = function (companyFactListData, usePropertyResolver) {
+        if (usePropertyResolver === void 0) { usePropertyResolver = true; }
         var reportsRaw = this.reportRawParser.parseReports(companyFactListData, {
             reportsToInclude: ['ANNUAL', 'QUARTERLY'],
         });
-        return this.parseReportsFromRaw(reportsRaw);
+        return this.parseReportsFromRaw(reportsRaw, usePropertyResolver);
     };
     /**
      * Same as parseReports but accepts ReportRaw[] instead of CompanyFactListData
      */
-    ReportParser.prototype.parseReportsFromRaw = function (reportsRaw) {
+    ReportParser.prototype.parseReportsFromRaw = function (reportsRaw, usePropertyResolver) {
+        if (usePropertyResolver === void 0) { usePropertyResolver = true; }
         var reportByYearQuarter = new Map();
         var reportsRawFiltered = reportsRaw.filter(function (reportRaw) {
             return reportRaw.reportType === 'ANNUAL' || reportRaw.reportType === 'QUARTERLY';
@@ -42,7 +44,9 @@ var ReportParser = /** @class */ (function () {
             return report;
         });
         var reportWrappers = Array.from(reportByYearQuarter.values());
-        this.propertyResolver.resolveAll(reportWrappers);
+        if (usePropertyResolver) {
+            this.propertyResolver.resolveAll(reportWrappers);
+        }
         return reportWrappers;
     };
     /**

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

@@ -1,5 +1,5 @@
 import { ReportTranslated } from '../../types';
-declare type ExtendableReportProxy = {
+type ExtendableReportProxy = {
     new (report: ReportTranslated): ReportTranslated;
 };
 /**

package/build/services/ReportParser/ReportWrapper.js

@@ -22,8 +22,9 @@ var ReportTranslatedProxy_1 = require("./ReportTranslatedProxy");
 var ReportWrapper = /** @class */ (function (_super) {
     __extends(ReportWrapper, _super);
     function ReportWrapper(report, reportRaw, reportMap) {
+        var _this = this;
         var _a;
-        var _this = _super.call(this, report) || this;
+        _this = _super.call(this, report) || this;
         _this.report = report;
         _this.reportMap = reportMap !== null && reportMap !== void 0 ? reportMap : new Map();
         _this.reportRaw = reportRaw !== null && reportRaw !== void 0 ? reportRaw : {

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

@@ -5,7 +5,7 @@ interface SplitValueBetweenReportsParams {
     reports: ReportTranslated[];
     roundToPlaces: number;
 }
-export declare type ExcludeNulls<T> = {
+export type ExcludeNulls<T> = {
     [K in keyof T]: Exclude<T[K], null>;
 };
 export declare function getSingleNullKey<T>(obj: T): keyof T | null;

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

@@ -1,30 +1,37 @@
-export interface RequestWrapperOptions {
+import { FilingListItemTranslated } from '../../types/submission.type';
+export interface SubmissionRequestWrapperOptions {
     maxRequests?: number;
 }
 export interface SendRequestParams {
     url: string;
 }
-interface RequestWrapperArgs<T> {
-    urls: string[];
-    options?: RequestWrapperOptions;
-    sendRequest: (params: SendRequestParams) => Promise<T | T[]>;
+interface SubmissionRequestWrapperArgs<T> {
+    submissions: FilingListItemTranslated[];
+    options?: SubmissionRequestWrapperOptions;
+    sendRequest: (params: SendRequestParams) => Promise<T>;
 }
-export default class RequestWrapper<T> {
+interface SubmissionRequestWrapperResult<T> {
+    result: T | null;
+    error: string | null;
+    submission: FilingListItemTranslated;
+}
+export default class SubmissionRequestWrapper<T> {
     private results;
     private readonly options;
-    private readonly urls;
+    private readonly submissions;
     private readonly errors;
     private readonly sendRequest;
     private requestCount;
     private isDone;
-    constructor(args: RequestWrapperArgs<T>);
-    setOptions(options: RequestWrapperOptions): void;
-    requestNext(): Promise<T[] | null>;
+    constructor(args: SubmissionRequestWrapperArgs<T>);
+    setOptions(options: SubmissionRequestWrapperOptions): void;
+    requestNext(): Promise<SubmissionRequestWrapperResult<T>>;
     skip(count?: number): void;
-    requestAll(): Promise<T[]>;
+    requestAll(): Promise<SubmissionRequestWrapperResult<T>[]>;
     clearResults(): void;
-    getResults(): T[];
+    getResults(): SubmissionRequestWrapperResult<T>[];
     getErrors(): string[];
     getSize(): number;
+    getSubmissions(): FilingListItemTranslated[];
 }
 export {};

package/build/services/SecEdgarApi/RequestWrapper.js

@@ -14,7 +14,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
             if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
             if (y = 0, t) op = [op[0] & 2, t.value];
             switch (op[0]) {
@@ -36,35 +36,42 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-var RequestWrapper = /** @class */ (function () {
-    function RequestWrapper(args) {
-        var urls = args.urls, _a = args.options, options = _a === void 0 ? {} : _a, sendRequest = args.sendRequest;
+var SubmissionRequestWrapper = /** @class */ (function () {
+    function SubmissionRequestWrapper(args) {
+        var submissions = args.submissions, _a = args.options, options = _a === void 0 ? {} : _a, sendRequest = args.sendRequest;
         this.options = options;
-        this.urls = urls;
+        this.submissions = submissions;
         this.results = [];
         this.errors = [];
         this.sendRequest = sendRequest;
         this.requestCount = 0;
         this.isDone = (options === null || options === void 0 ? void 0 : options.maxRequests) === 0;
     }
-    RequestWrapper.prototype.setOptions = function (options) {
+    SubmissionRequestWrapper.prototype.setOptions = function (options) {
         for (var key in options) {
-            this.options[key] = options[key];
+            this.options[key] =
+                options[key];
         }
     };
-    RequestWrapper.prototype.requestNext = function () {
+    SubmissionRequestWrapper.prototype.requestNext = function () {
         return __awaiter(this, void 0, void 0, function () {
-            var _a, maxRequests, url, result, resultArr, e_1, error;
-            var _this = this;
+            var _a, maxRequests, submission, isComplete, url, result, data, e_1, error;
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
                         _a = this.options.maxRequests, maxRequests = _a === void 0 ? Infinity : _a;
-                        if (this.requestCount >= maxRequests || this.isDone)
-                            return [2 /*return*/, null];
-                        url = this.urls[this.requestCount];
+                        submission = this.submissions[this.requestCount];
+                        isComplete = this.requestCount >= maxRequests || this.isDone;
+                        if (isComplete || !submission) {
+                            return [2 /*return*/, {
+                                    submission: submission,
+                                    error: isComplete ? 'max requests reached' : 'no submission found',
+                                    result: null,
+                                }];
+                        }
+                        url = submission.url;
                         this.requestCount++;
-                        if (this.requestCount >= this.urls.length || this.requestCount >= maxRequests) {
+                        if (this.requestCount >= this.submissions.length || this.requestCount >= maxRequests) {
                             this.isDone = true;
                         }
                         _b.label = 1;
@@ -73,61 +80,68 @@ var RequestWrapper = /** @class */ (function () {
                         return [4 /*yield*/, this.sendRequest({ url: url })];
                     case 2:
                         result = _b.sent();
-                        resultArr = Array.isArray(result) ? result : [result];
-                        resultArr.forEach(function (result) { return _this.results.push(result); });
-                        return [2 /*return*/, resultArr];
+                        data = {
+                            submission: submission,
+                            error: null,
+                            result: result,
+                        };
+                        this.results.push(data);
+                        return [2 /*return*/, data];
                     case 3:
                         e_1 = _b.sent();
                         error = e_1;
                         this.errors.push(error.message);
-                        return [3 /*break*/, 4];
-                    case 4: return [2 /*return*/, null];
+                        return [2 /*return*/, {
+                                submission: submission,
+                                error: error.message,
+                                result: null,
+                            }];
+                    case 4: return [2 /*return*/];
                 }
             });
         });
     };
-    RequestWrapper.prototype.skip = function (count) {
+    SubmissionRequestWrapper.prototype.skip = function (count) {
         if (count === void 0) { count = 1; }
         this.requestCount += count;
     };
-    RequestWrapper.prototype.requestAll = function () {
+    SubmissionRequestWrapper.prototype.requestAll = function () {
         var _a;
         return __awaiter(this, void 0, void 0, function () {
-            var promises, maxRequests, i, resultsArr, resultsFlat;
+            var promises, maxRequests, i, results;
+            var _this = this;
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
                         promises = [];
-                        maxRequests = (_a = this.options.maxRequests) !== null && _a !== void 0 ? _a : this.urls.length;
+                        maxRequests = (_a = this.options.maxRequests) !== null && _a !== void 0 ? _a : this.submissions.length;
                         for (i = 0; i < maxRequests; i++) {
                             promises.push(this.requestNext());
                         }
                         return [4 /*yield*/, Promise.all(promises)];
                     case 1:
-                        resultsArr = _b.sent();
-                        resultsFlat = [];
-                        resultsArr.forEach(function (results) {
-                            results === null || results === void 0 ? void 0 : results.forEach(function (result) { return resultsFlat.push(result); });
-                        });
-                        this.clearResults();
-                        this.results = resultsFlat;
-                        return [2 /*return*/, resultsFlat];
+                        results = _b.sent();
+                        results.forEach(function (result) { return _this.results.push(result); });
+                        return [2 /*return*/, results];
                 }
             });
         });
     };
-    RequestWrapper.prototype.clearResults = function () {
+    SubmissionRequestWrapper.prototype.clearResults = function () {
         this.results = [];
     };
-    RequestWrapper.prototype.getResults = function () {
+    SubmissionRequestWrapper.prototype.getResults = function () {
         return this.results;
     };
-    RequestWrapper.prototype.getErrors = function () {
+    SubmissionRequestWrapper.prototype.getErrors = function () {
         return this.errors;
     };
-    RequestWrapper.prototype.getSize = function () {
-        return this.urls.length;
+    SubmissionRequestWrapper.prototype.getSize = function () {
+        return this.submissions.length;
+    };
+    SubmissionRequestWrapper.prototype.getSubmissions = function () {
+        return this.submissions;
     };
-    return RequestWrapper;
+    return SubmissionRequestWrapper;
 }());
-exports.default = RequestWrapper;
+exports.default = SubmissionRequestWrapper;

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

@@ -1,11 +1,11 @@
-import { CompanyFactFrame, CompanyFactListData, CompanyTickerItem, FieldDataResponse, Holder, InsiderTransaction, MultiCompanyFactFrame, ReportRaw, ReportTranslated } from '../../types';
+import { CompanyFactFrame, CompanyFactListData, CompanyTickerItem, FieldDataResponse, Holder, InsiderTransaction, MultiCompanyFactFrame, ReportRaw, ReportTranslated, TableData } from '../../types';
 import { FilingListDetails, FilingListItemTranslated, SubmissionList } from '../../types/submission.type';
 import { IClient } from '../Client';
 import DocumentParser from '../DocumentParser';
 import ReportParser from '../ReportParser';
 import { ParseReportsOptions } from '../ReportParser/ReportRawParser';
 import ReportWrapper from '../ReportParser/ReportWrapper';
-import RequestWrapper from './RequestWrapper';
+import SubmissionRequestWrapper from './RequestWrapper';
 import { IThrottler } from './Throttler';
 interface SecApiArgs {
     throttler: IThrottler;
@@ -30,6 +30,7 @@ export interface GetReportsParams {
     /** symbol or cik */
     symbol: string | number;
     withWrapper?: boolean;
+    usePropertyResolver?: boolean;
 }
 export interface GetFactParams {
     /** symbol or cik */
@@ -70,7 +71,7 @@ export default class SecEdgarApi {
     constructor(args?: SecApiArgs);
     private request;
     private mapFilingListDetails;
-    private getCreateRequestUrls;
+    private getCreateRequestSubmissions;
     /**
      * If symbol is not in cikBySymbol, assume it is a cik. does not make a request
      */
@@ -186,11 +187,11 @@ export default class SecEdgarApi {
      * const submissions = await secEdgarApi.getSubmissions({ symbol: 'AAPL' })
      * const requestWrapper = secEdgarApi.createRequestInsiderTransactions({ symbol: 'AAPL', filings: submissions.filings.recent })
      *
-     * const transactions1 = await requestWrapper.requestNext() // array of transactions from most recent doc
-     * const transactions2 = await requestWrapper.requestNext() // array of transactions from second most recent doc
+     * const transactions1 = (await requestWrapper.requestNext()).result // array of transactions from most recent doc
+     * const transactions2 = (await requestWrapper.requestNext()).result // array of transactions from second most recent doc
      * ```
      */
-    createRequestInsiderTransactions(params: CreateRequestWrapperParams): RequestWrapper<InsiderTransaction>;
+    createRequestInsiderTransactions(params: CreateRequestWrapperParams): SubmissionRequestWrapper<InsiderTransaction[]>;
     /**
      * Used for getting institutional holders. extracts holders urls from submission list response, and parses the xml doc.
      *
@@ -198,10 +199,22 @@ export default class SecEdgarApi {
      * const submissions = await secEdgarApi.getSubmissions({ symbol: 'AAPL' })
      * const requestWrapper = secEdgarApi.createRequestHolders({ symbol: 'AAPL', filings: submissions.filings.recent })
      *
-     * const holders1 = await requestWrapper.requestNext() // array of holders from most recent doc
-     * const holders2 = await requestWrapper.requestNext() // array of holders from second most recent doc
+     * const holders1 = (await requestWrapper.requestNext()).result // array of holders from most recent doc
+     * const holders2 = (await requestWrapper.requestNext()).result // array of holders from second most recent doc
      * ```
      */
-    createRequestHolders(params: CreateRequestWrapperParams): RequestWrapper<Holder>;
+    createRequestHolders(params: CreateRequestWrapperParams): SubmissionRequestWrapper<Holder[]>;
+    /**
+     * Used for getting earnings report tables from submission files.
+     *
+     * ```ts
+     * const submissions = await secEdgarApi.getSubmissions({ symbol: 'AAPL' })
+     * const requestWrapper = secEdgarApi.createRequesEarningsReports({ symbol: 'AAPL', filings: submissions.filings.recent })
+     *
+     * const tables1 = (await requestWrapper.requestNext()).result // array of tables from most recent doc
+     * const tables2 = (await requestWrapper.requestNext()).result // array of tables from second most recent doc
+     * ```
+     */
+    createRequestEarningsReports(params: CreateRequestWrapperParams): SubmissionRequestWrapper<TableData[]>;
 }
 export {};

package/build/services/SecEdgarApi/SecEdgarApi.js

@@ -14,7 +14,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
             if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
             if (y = 0, t) op = [op[0] & 2, t.value];
             switch (op[0]) {
@@ -126,22 +126,14 @@ var SecEdgarApi = /** @class */ (function () {
         }
         return filings;
     };
-    SecEdgarApi.prototype.getCreateRequestUrls = function (params, forms) {
+    SecEdgarApi.prototype.getCreateRequestSubmissions = function (params, forms) {
         var symbol = params.symbol, filings = params.filings, _a = params.cutoffDate, cutoffDate = _a === void 0 ? new Date('1970-01-01') : _a;
         var cik = this.getCikString(symbol);
         var filingsArr = Array.isArray(filings) ? filings : this.mapFilingListDetails(cik, filings);
-        var filingsFiltered = filingsArr.filter(function (_a) {
+        return filingsArr.filter(function (_a) {
             var form = _a.form, filingDate = _a.filingDate;
             return forms.includes(form) && new Date(filingDate).getTime() > cutoffDate.getTime();
         });
-        var urls = filingsFiltered.filter(function (_a) {
-            var form = _a.form;
-            return forms.includes(form);
-        }).map(function (_a) {
-            var url = _a.url;
-            return url;
-        });
-        return urls;
     };
     /**
      * If symbol is not in cikBySymbol, assume it is a cik. does not make a request
@@ -175,6 +167,7 @@ var SecEdgarApi = /** @class */ (function () {
                         return [4 /*yield*/, this.request("".concat(this.baseUrlEdgar, "/submissions/CIK").concat(cik, ".json"))];
                     case 1:
                         submissions = _a.sent();
+                        submissions.cik = Number(submissions.cik);
                         if (!includeTranslated)
                             return [2 /*return*/, submissions];
                         submissions.filings.recentTranslated = this.mapFilingListDetails(cik, submissions.filings.recent);
@@ -258,15 +251,15 @@ var SecEdgarApi = /** @class */ (function () {
      */
     SecEdgarApi.prototype.getReports = function (params) {
         return __awaiter(this, void 0, void 0, function () {
-            var symbol, _a, withWrapper, facts, reports;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
+            var symbol, _a, withWrapper, _b, usePropertyResolver, facts, reports;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
                     case 0:
-                        symbol = params.symbol, _a = params.withWrapper, withWrapper = _a === void 0 ? false : _a;
+                        symbol = params.symbol, _a = params.withWrapper, withWrapper = _a === void 0 ? false : _a, _b = params.usePropertyResolver, usePropertyResolver = _b === void 0 ? true : _b;
                         return [4 /*yield*/, this.getFacts({ symbol: symbol })];
                     case 1:
-                        facts = _b.sent();
-                        reports = this.reportParser.parseReports(facts);
+                        facts = _c.sent();
+                        reports = this.reportParser.parseReports(facts, usePropertyResolver);
                         return [2 /*return*/, withWrapper ? reports : reports.map(function (report) { return report.getReport(); })];
                 }
             });
@@ -373,13 +366,13 @@ var SecEdgarApi = /** @class */ (function () {
      * const submissions = await secEdgarApi.getSubmissions({ symbol: 'AAPL' })
      * const requestWrapper = secEdgarApi.createRequestInsiderTransactions({ symbol: 'AAPL', filings: submissions.filings.recent })
      *
-     * const transactions1 = await requestWrapper.requestNext() // array of transactions from most recent doc
-     * const transactions2 = await requestWrapper.requestNext() // array of transactions from second most recent doc
+     * const transactions1 = (await requestWrapper.requestNext()).result // array of transactions from most recent doc
+     * const transactions2 = (await requestWrapper.requestNext()).result // array of transactions from second most recent doc
      * ```
      */
     SecEdgarApi.prototype.createRequestInsiderTransactions = function (params) {
         var _this = this;
-        var urls = this.getCreateRequestUrls(params, ['4', '4/A', '5', '5/A']);
+        var submissions = this.getCreateRequestSubmissions(params, ['4', '4/A', '5', '5/A']);
         var options = { maxRequests: params.maxRequests };
         var sendRequest = function (params) { return __awaiter(_this, void 0, void 0, function () {
             var _a, _b;
@@ -394,7 +387,7 @@ var SecEdgarApi = /** @class */ (function () {
                 }
             });
         }); };
-        return new RequestWrapper_1.default({ urls: urls, options: options, sendRequest: sendRequest });
+        return new RequestWrapper_1.default({ submissions: submissions, options: options, sendRequest: sendRequest });
     };
     /**
      * Used for getting institutional holders. extracts holders urls from submission list response, and parses the xml doc.
@@ -403,13 +396,13 @@ var SecEdgarApi = /** @class */ (function () {
      * const submissions = await secEdgarApi.getSubmissions({ symbol: 'AAPL' })
      * const requestWrapper = secEdgarApi.createRequestHolders({ symbol: 'AAPL', filings: submissions.filings.recent })
      *
-     * const holders1 = await requestWrapper.requestNext() // array of holders from most recent doc
-     * const holders2 = await requestWrapper.requestNext() // array of holders from second most recent doc
+     * const holders1 = (await requestWrapper.requestNext()).result // array of holders from most recent doc
+     * const holders2 = (await requestWrapper.requestNext()).result // array of holders from second most recent doc
      * ```
      */
     SecEdgarApi.prototype.createRequestHolders = function (params) {
         var _this = this;
-        var urls = this.getCreateRequestUrls(params, ['SC 13G', 'SC 13G/A']);
+        var submissions = this.getCreateRequestSubmissions(params, ['SC 13G', 'SC 13G/A']);
         var options = { maxRequests: params.maxRequests };
         var sendRequest = function (params) { return __awaiter(_this, void 0, void 0, function () {
             var _a, _b;
@@ -424,7 +417,37 @@ var SecEdgarApi = /** @class */ (function () {
                 }
             });
         }); };
-        return new RequestWrapper_1.default({ urls: urls, options: options, sendRequest: sendRequest });
+        return new RequestWrapper_1.default({ submissions: submissions, options: options, sendRequest: sendRequest });
+    };
+    /**
+     * Used for getting earnings report tables from submission files.
+     *
+     * ```ts
+     * const submissions = await secEdgarApi.getSubmissions({ symbol: 'AAPL' })
+     * const requestWrapper = secEdgarApi.createRequesEarningsReports({ symbol: 'AAPL', filings: submissions.filings.recent })
+     *
+     * const tables1 = (await requestWrapper.requestNext()).result // array of tables from most recent doc
+     * const tables2 = (await requestWrapper.requestNext()).result // array of tables from second most recent doc
+     * ```
+     */
+    SecEdgarApi.prototype.createRequestEarningsReports = function (params) {
+        var _this = this;
+        var submissions = this.getCreateRequestSubmissions(params, ['10-Q', '10-Q/A', '10-K', '10-K/A']);
+        var options = { maxRequests: params.maxRequests };
+        var sendRequest = function (params) { return __awaiter(_this, void 0, void 0, function () {
+            var _a, _b;
+            var _c;
+            return __generator(this, function (_d) {
+                switch (_d.label) {
+                    case 0:
+                        _b = (_a = this.documentParser).parseEarningsTables;
+                        _c = {};
+                        return [4 /*yield*/, this.getDocumentXMLByUrl(params)];
+                    case 1: return [2 /*return*/, _b.apply(_a, [(_c.xml = _d.sent(), _c)])];
+                }
+            });
+        }); };
+        return new RequestWrapper_1.default({ submissions: submissions, options: options, sendRequest: sendRequest });
     };
     return SecEdgarApi;
 }());

package/build/services/SecEdgarApi/Throttler.js

@@ -14,7 +14,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
             if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
             if (y = 0, t) op = [op[0] & 2, t.value];
             switch (op[0]) {

package/build/services/SecEdgarApi/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[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];

package/build/types/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[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];

package/build/types/parsed-filings.type.d.ts

@@ -19,9 +19,9 @@ interface TransactionDescriptionByCode {
     K: 'Equity Swap';
     U: 'Disposition Change in Control';
 }
-export declare type TransactionType = 'Acquire' | 'Dispose';
-export declare type TransactionCode = keyof TransactionDescriptionByCode;
-export declare type TransactionDescription = TransactionDescriptionByCode[TransactionCode];
+export type TransactionType = 'Acquire' | 'Dispose';
+export type TransactionCode = keyof TransactionDescriptionByCode;
+export type TransactionDescription = TransactionDescriptionByCode[TransactionCode];
 export interface InsiderTransaction {
     filerName: string;
     filerPosition: string;
@@ -55,4 +55,12 @@ export interface Holder {
     dispositivePowerShared: string | null;
     typeOfReportingPerson: string | null;
 }
+export interface TableData {
+    title: string;
+    textBefore: string | null;
+    textAfter: string | null;
+    hasHeader: boolean;
+    sectionIndex: number;
+    rows: (string | number | null)[][];
+}
 export {};

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

@@ -1,7 +1,7 @@
 /**
  * Contains all keys matched from the report, along with the added keys dateEnd, dateFiled, fiscalPeriod, fiscalYear.
  */
-export declare type ReportRaw = {
+export type ReportRaw = {
     [key: string]: string | number | boolean;
     dateReport: string;
     dateFiled: string;
@@ -19,5 +19,5 @@ export declare type ReportRaw = {
  *
  * for dei, see https://www.sec.gov/structureddata/announcement/osd-announcement-2212-new-2022q4-taxonomies
  */
-export declare type ReportType = 'QUARTERLY' | 'ANNUAL' | '8K' | 'DOCUMENT_ENTITY_INFO';
-export declare type FiscalPeriod = 'Q1' | 'Q2' | 'Q3' | 'Q4' | 'FY';
+export type ReportType = 'QUARTERLY' | 'ANNUAL' | '8K' | 'DOCUMENT_ENTITY_INFO';
+export type FiscalPeriod = 'Q1' | 'Q2' | 'Q3' | 'Q4' | 'FY';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "sec-edgar-api",
-    "version": "0.0.6",
+    "version": "0.1.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/downloader.d.ts

@@ -1,6 +0,0 @@
-import FactsDownloader from './services/FactsDownloader';
-/**
- * Downloads companyfacts.zip from sec.gov and extracts the directory
- */
-declare const factsDownloader: FactsDownloader;
-export { factsDownloader };

package/build/downloader.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.factsDownloader = void 0;
-var FactsDownloader_1 = require("./services/FactsDownloader");
-/**
- * Downloads companyfacts.zip from sec.gov and extracts the directory
- */
-var factsDownloader = new FactsDownloader_1.default();
-exports.factsDownloader = factsDownloader;

package/build/services/FactFileReader/FactFileReader.d.ts

@@ -1,30 +0,0 @@
-import { CompanyFactListData } from '../../types/company-facts.type';
-interface FileManager {
-    readFileSync(path: string, encoding: string | object): string;
-}
-interface FactFileReaderArgs {
-    companyFactsDirname?: string;
-    cikBySymbol?: Record<string, number>;
-    fileManager?: FileManager;
-}
-interface ReadFactFileParams {
-    symbol: string;
-    companyFactsDirname: string;
-}
-/**
- * Reads files from companyfacts folder from sec
- */
-export default class FactFileReader {
-    private readonly fileManager;
-    private readonly cikBySymbol;
-    constructor(args?: FactFileReaderArgs);
-    getCikBySymbol(): Record<string, number>;
-    /**
-     * opens fact file from companyfacts directory
-     *
-     * @param symbol ex: AAPL
-     * @param companyFactsDirname ex: path.resolve(__dirname, './downloads/companyfacts')
-     */
-    readFactFile(params: ReadFactFileParams): CompanyFactListData;
-}
-export {};