sec-edgar-api 0.2.1 → 0.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/build/services/ReportBuilder/FactFiscalCalculator.d.ts +51 -0
  2. package/build/services/ReportBuilder/FactFiscalCalculator.js +232 -0
  3. package/build/services/ReportBuilder/FactPeriodResolver.d.ts +48 -0
  4. package/build/services/ReportBuilder/FactPeriodResolver.js +190 -0
  5. package/build/services/ReportBuilder/FactRecordBuilder.d.ts +10 -0
  6. package/build/services/ReportBuilder/FactRecordBuilder.js +71 -0
  7. package/build/services/ReportBuilder/FactSplitAdjuster.d.ts +46 -0
  8. package/build/services/ReportBuilder/FactSplitAdjuster.js +203 -0
  9. package/build/services/ReportBuilder/ReportBuilder.d.ts +40 -0
  10. package/build/services/ReportBuilder/ReportBuilder.js +186 -0
  11. package/build/services/ReportBuilder/ReportRawResolvable.d.ts +17 -0
  12. package/build/services/ReportBuilder/ReportRawResolvable.js +114 -0
  13. package/build/services/ReportBuilder/index.d.ts +2 -0
  14. package/build/services/ReportBuilder/index.js +4 -0
  15. package/build/services/ReportParser/PropertyResolver.d.ts +1 -0
  16. package/build/services/ReportParser/PropertyResolver.js +1 -0
  17. package/build/services/ReportParser/ReportParser.d.ts +4 -11
  18. package/build/services/ReportParser/ReportParser.js +15 -27
  19. package/build/services/ReportParser/ReportRawParser.d.ts +3 -32
  20. package/build/services/ReportParser/ReportRawParser.js +6 -146
  21. package/build/services/ReportParser/ReportWrapper.js +4 -5
  22. package/build/services/ReportParser/resolvers/index.d.ts +2 -0
  23. package/build/services/ReportParser/resolvers/index.js +2 -0
  24. package/build/services/ReportParser/resolvers/resolve-cash-flow-capex.js +4 -3
  25. package/build/services/ReportParser/resolvers/resolve-cash-flow-operating.js +1 -1
  26. package/build/services/ReportParser/resolvers/resolve-cash-flow-working-capital-non-cash.js +1 -1
  27. package/build/services/ReportParser/resolvers/resolve-expense-depreciation.js +1 -1
  28. package/build/services/ReportParser/resolvers/resolve-fiscal-year-cumulative-properties.js +30 -15
  29. package/build/services/ReportParser/resolvers/resolve-q4-fiscal-year-matching-properties.js +32 -4
  30. package/build/services/ReportParser/resolvers/resolve-split-ratio.d.ts +2 -0
  31. package/build/services/ReportParser/resolvers/resolve-split-ratio.js +37 -0
  32. package/build/services/SecEdgarApi/SecEdgarApi.d.ts +1 -2
  33. package/build/types/report-raw.type.d.ts +5 -6
  34. package/build/types/report-translated.type.d.ts +4 -2
  35. package/build/util/calculation-map-by-ns.d.ts +6 -0
  36. package/build/util/calculation-map-by-ns.js +9 -0
  37. package/build/util/key-translations.js +5 -2
  38. package/package.json +1 -1
  39. package/build/services/ReportParser/FactIterator.d.ts +0 -18
  40. package/build/services/ReportParser/FactIterator.js +0 -35
@@ -6,12 +6,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
6
6
  */
7
7
  var keyTranslations = {
8
8
  // --- Added from ReportParser --- //
9
+ cik: ['cik'],
10
+ url: ['url'],
9
11
  dateReport: ['dateReport'],
10
12
  dateFiled: ['dateFiled'],
11
13
  fiscalPeriod: ['fiscalPeriod'],
12
14
  fiscalYear: ['fiscalYear'],
13
- form: ['form'],
14
- isTTM: ['isTTM'],
15
+ splitDate: ['splitDate'],
16
+ splitRatio: ['StockholdersEquityNoteStockSplitConversionRatio1'],
15
17
  // ------------------------------- //
16
18
  assetTotal: ['Assets'],
17
19
  assetCurrent: ['AssetsCurrent', 'CurrentAssets'],
@@ -94,6 +96,7 @@ var keyTranslations = {
94
96
  'ConvertibleLongTermNotesPayable',
95
97
  'LongTermNotesAndLoans',
96
98
  'DebtAndCapitalLeaseObligations',
99
+ 'LongTermDebtAndCapitalLeaseObligationsIncludingCurrentMaturities',
97
100
  ],
98
101
  equityTotal: [
99
102
  'StockholdersEquity',
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "sec-edgar-api",
3
- "version": "0.2.1",
3
+ "version": "0.2.3",
4
4
  "description": "Fetch and parse SEC earnings reports and other filings. Useful for financial analysis.",
5
5
  "main": "build/index.js",
6
6
  "author": "Andrew Evers (https://github.com/andyevers)",
@@ -1,18 +0,0 @@
1
- import { CompanyFactListData, FactValue } from '../../types/company-facts.type';
2
- export interface IterateFactsCallbackData {
3
- factValue: FactValue;
4
- propertyName: string;
5
- description: string;
6
- label: string;
7
- unit: string;
8
- taxonomy: string;
9
- stopIteration: () => void;
10
- }
11
- export default class FactIterator {
12
- /**
13
- * Avoids deep nesting logic while iteratating through company facts
14
- *
15
- * @param callback called on each company fact.
16
- */
17
- iterateCompanyFacts(companyFactListData: Pick<CompanyFactListData, 'facts'>, callback: (data: IterateFactsCallbackData) => void): void;
18
- }
@@ -1,35 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- var FactIterator = /** @class */ (function () {
4
- function FactIterator() {
5
- }
6
- /**
7
- * Avoids deep nesting logic while iteratating through company facts
8
- *
9
- * @param callback called on each company fact.
10
- */
11
- FactIterator.prototype.iterateCompanyFacts = function (companyFactListData, callback) {
12
- var facts = companyFactListData.facts;
13
- var shouldContinue = true;
14
- var stopIteration = function () {
15
- shouldContinue = false;
16
- };
17
- for (var taxonomy in facts) {
18
- var factByPropertyName = facts[taxonomy];
19
- for (var propertyName in factByPropertyName) {
20
- var _a = factByPropertyName[propertyName], description = _a.description, label = _a.label, units = _a.units;
21
- for (var unit in units) {
22
- var factValues = units[unit];
23
- for (var _i = 0, factValues_1 = factValues; _i < factValues_1.length; _i++) {
24
- var factValue = factValues_1[_i];
25
- callback({ factValue: factValue, taxonomy: taxonomy, propertyName: propertyName, unit: unit, description: description, label: label, stopIteration: stopIteration });
26
- if (!shouldContinue)
27
- return;
28
- }
29
- }
30
- }
31
- }
32
- };
33
- return FactIterator;
34
- }());
35
- exports.default = FactIterator;