sec-edgar-api 0.0.2 → 0.0.3

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

@@ -35,6 +35,10 @@ export default class ReportParser {
      * @see https://www.sec.gov/edgar/sec-api-documentation
      */
     parseReportsRaw(companyFactListData: Pick<CompanyFactListData, 'facts'>, options?: ParseReportsOptions): ReportRaw[];
+    /**
+     * parseReportsRaw but removes meta data from the report
+     */
+    parseReportsRawNoMeta(companyFactListData: Pick<CompanyFactListData, 'facts'>, options?: ParseReportsOptions): Record<string, number>[];
     /**
      * Avoids deep nesting logic while iteratating through company facts
      *

package/build/services/ReportParser/ReportParser.js

@@ -53,6 +53,25 @@ var ReportParser = /** @class */ (function () {
     ReportParser.prototype.parseReportsRaw = function (companyFactListData, options) {
         return this.reportRawParser.parseReports(companyFactListData, options);
     };
+    /**
+     * parseReportsRaw but removes meta data from the report
+     */
+    ReportParser.prototype.parseReportsRawNoMeta = function (companyFactListData, options) {
+        var reportsRaw = this.parseReportsRaw(companyFactListData, options);
+        reportsRaw.forEach(function (reportRaw) {
+            var report = reportRaw;
+            delete report.dateFiled;
+            delete report.dateReport;
+            delete report.fiscalPeriod;
+            delete report.fiscalYear;
+            delete report.form;
+            delete report.frame;
+            delete report.isTTM;
+            delete report.reportType;
+            delete report.taxonomy;
+        });
+        return reportsRaw;
+    };
     /**
      * Avoids deep nesting logic while iteratating through company facts
      *

package/build/services/SecEdgarApi/FactsDownloader.js

@@ -65,7 +65,6 @@ var FactsDownloader = /** @class */ (function () {
             var _this = this;
             return __generator(this, function (_b) {
                 outputDirname = params.outputDirname, onChunk = params.onChunk, onDownloadComplete = params.onDownloadComplete, onError = params.onError, onComplete = params.onComplete, _a = params.unzip, unzip = _a === void 0 ? true : _a;
-                // writes download and unzip progress with percentage in terminal if useWriteProgressBar is true
                 return [2 /*return*/, new Promise(function (resolve, reject) { return __awaiter(_this, void 0, void 0, function () {
                         var filename, e_1;
                         return __generator(this, function (_a) {

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

@@ -70,11 +70,14 @@ export default class SecEdgarApi {
      */
     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
-     *
-     * Note that calculated properties are estimated if they are not available in the company facts.
+     * all reports, use getReportsRaw.
      */
     getReports(params: GetSymbolParams): Promise<ReportWrapper[]>;
     /**
@@ -86,6 +89,8 @@ export default class SecEdgarApi {
      * Downloads the companyfacts.zip file and extracts the directory containing all company
      * reports available from sec.gov. After downloading, you can use factFileReader and reportParser
      * to get and read reports.
+     *
+     * Note: Over 15GB of data is downloaded and extracted.
      */
     downloadCompanyFactsDirectory(params: DownloadCompanyFactsDirectoryParams): Promise<boolean>;
 }

package/build/services/SecEdgarApi/SecEdgarApi.js

@@ -131,11 +131,14 @@ var SecEdgarApi = /** @class */ (function () {
         });
     };
     /**
+     * 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
-     *
-     * Note that calculated properties are estimated if they are not available in the company facts.
+     * all reports, use getReportsRaw.
      */
     SecEdgarApi.prototype.getReports = function (params) {
         return __awaiter(this, void 0, void 0, function () {
@@ -171,6 +174,8 @@ var SecEdgarApi = /** @class */ (function () {
      * Downloads the companyfacts.zip file and extracts the directory containing all company
      * reports available from sec.gov. After downloading, you can use factFileReader and reportParser
      * to get and read reports.
+     *
+     * Note: Over 15GB of data is downloaded and extracted.
      */
     SecEdgarApi.prototype.downloadCompanyFactsDirectory = function (params) {
         return __awaiter(this, void 0, void 0, function () {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "sec-edgar-api",
-    "version": "0.0.2",
+    "version": "0.0.3",
     "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)",
@@ -15,7 +15,8 @@
     },
     "scripts": {
         "test": "jest test",
-        "build": "tsc"
+        "build": "tsc",
+        "publish": "npm run build && npm publish"
     },
     "keywords": [
         "sec",