sec-edgar-api 0.2.3 → 0.3.0

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 (35) hide show
  1. package/README.md +1 -0
  2. package/build/services/ReportParser/ReportParser.d.ts +6 -13
  3. package/build/services/ReportParser/ReportParser.js +15 -22
  4. package/build/services/ReportRawBuilder/FactGrouper.d.ts +27 -0
  5. package/build/services/ReportRawBuilder/FactGrouper.js +206 -0
  6. package/build/services/{ReportBuilder → ReportRawBuilder}/FactPeriodResolver.d.ts +46 -2
  7. package/build/services/{ReportBuilder → ReportRawBuilder}/FactPeriodResolver.js +81 -20
  8. package/build/services/ReportRawBuilder/FactRecordBuilder.d.ts +9 -0
  9. package/build/services/{ReportBuilder → ReportRawBuilder}/FactRecordBuilder.js +6 -24
  10. package/build/services/ReportRawBuilder/FactSplitAdjuster.d.ts +43 -0
  11. package/build/services/ReportRawBuilder/FactSplitAdjuster.js +242 -0
  12. package/build/services/ReportRawBuilder/ReportRawBuilder.d.ts +39 -0
  13. package/build/services/ReportRawBuilder/ReportRawBuilder.js +158 -0
  14. package/build/services/ReportRawBuilder/index.d.ts +2 -0
  15. package/build/services/ReportRawBuilder/index.js +4 -0
  16. package/build/services/SecEdgarApi/SecEdgarApi.d.ts +10 -2
  17. package/build/services/SecEdgarApi/SecEdgarApi.js +29 -11
  18. package/build/types/common.type.d.ts +41 -0
  19. package/build/types/company-facts.type.d.ts +29 -2
  20. package/package.json +1 -1
  21. package/build/services/ReportBuilder/FactRecordBuilder.d.ts +0 -10
  22. package/build/services/ReportBuilder/FactSplitAdjuster.d.ts +0 -46
  23. package/build/services/ReportBuilder/FactSplitAdjuster.js +0 -203
  24. package/build/services/ReportBuilder/ReportBuilder.d.ts +0 -40
  25. package/build/services/ReportBuilder/ReportBuilder.js +0 -186
  26. package/build/services/ReportBuilder/ReportRawResolvable.d.ts +0 -17
  27. package/build/services/ReportBuilder/ReportRawResolvable.js +0 -114
  28. package/build/services/ReportBuilder/index.d.ts +0 -2
  29. package/build/services/ReportBuilder/index.js +0 -4
  30. package/build/services/ReportParser/ReportRawParser.d.ts +0 -5
  31. package/build/services/ReportParser/ReportRawParser.js +0 -14
  32. package/build/util/calculation-map-by-ns.d.ts +0 -6
  33. package/build/util/calculation-map-by-ns.js +0 -9
  34. /package/build/services/{ReportBuilder → ReportRawBuilder}/FactFiscalCalculator.d.ts +0 -0
  35. /package/build/services/{ReportBuilder → ReportRawBuilder}/FactFiscalCalculator.js +0 -0
@@ -1,114 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- var calculation_map_by_ns_1 = require("../../util/calculation-map-by-ns");
4
- var ReportRawResolvable = /** @class */ (function () {
5
- function ReportRawResolvable(report, templateCode, calcMap) {
6
- if (templateCode === void 0) { templateCode = null; }
7
- if (calcMap === void 0) { calcMap = calculation_map_by_ns_1.calculationMapByNs; }
8
- this.emptyKeys = new Set();
9
- this.addedProps = new Set();
10
- this.keyStack = new Set();
11
- this.templateCode = templateCode !== null && templateCode !== void 0 ? templateCode : 'N';
12
- this.report = report;
13
- this.calcMap = calcMap;
14
- }
15
- ReportRawResolvable.prototype.get = function (key) {
16
- var _a;
17
- return (_a = this.report[key]) !== null && _a !== void 0 ? _a : this.calculateNumericKey(key, key);
18
- };
19
- ReportRawResolvable.prototype.getNumber = function (key) {
20
- return Number(this.get(key)) || 0;
21
- };
22
- ReportRawResolvable.prototype.isAdded = function (key) {
23
- return this.addedProps.has(key);
24
- };
25
- ReportRawResolvable.prototype.getChildKeysArr = function (key) {
26
- var calcsByRole = this.calcMap[key];
27
- if (calcsByRole === undefined) {
28
- return [];
29
- }
30
- if (calcsByRole._) {
31
- return [calcsByRole._];
32
- }
33
- var preferredKeys = [];
34
- switch (this.templateCode) {
35
- case 'I':
36
- preferredKeys = [
37
- 'StatementOfCashFlowsIndirectInvestmentBasedOperations',
38
- 'StatementOfFinancialPositionUnclassified-InvestmentBasedOperations',
39
- 'StatementOfCashFlowsIndirectDepositBasedOperations',
40
- 'StatementOfFinancialPositionUnclassified-DepositBasedOperationsFirstAlternate',
41
- 'StatementOfFinancialPositionUnclassified-DepositBasedOperations',
42
- ];
43
- break;
44
- case 'B':
45
- preferredKeys = [
46
- 'StatementOfFinancialPositionUnclassified-DepositBasedOperationsFirstAlternate',
47
- 'StatementOfFinancialPositionUnclassified-DepositBasedOperations',
48
- ];
49
- break;
50
- }
51
- var k = preferredKeys.find(function (k) { return calcsByRole[k]; });
52
- if (!k) {
53
- k = Object.keys(calcsByRole)[0];
54
- }
55
- return Object.keys(calcsByRole)
56
- .sort(function (a, b) {
57
- var indexA = preferredKeys.indexOf(a);
58
- var indexB = preferredKeys.indexOf(b);
59
- if (indexB === -1)
60
- return -1;
61
- if (indexA === -1)
62
- return 1;
63
- return indexA - indexB;
64
- })
65
- .map(function (k) { return calcsByRole[k]; });
66
- };
67
- ReportRawResolvable.prototype.calculateNumericKey = function (key, topLevelKey) {
68
- var _a;
69
- if (this.keyStack.has(key)) {
70
- return undefined;
71
- }
72
- this.keyStack.add(key);
73
- if (this.emptyKeys.has(key)) {
74
- return undefined;
75
- }
76
- var childKeysArr = this.getChildKeysArr(key);
77
- if (childKeysArr.length === 0) {
78
- return undefined;
79
- }
80
- var didAdd = false;
81
- var finalSum = 0;
82
- for (var _i = 0, childKeysArr_1 = childKeysArr; _i < childKeysArr_1.length; _i++) {
83
- var childKeys = childKeysArr_1[_i];
84
- var sum = 0;
85
- for (var _b = 0, childKeys_1 = childKeys; _b < childKeys_1.length; _b++) {
86
- var k = childKeys_1[_b];
87
- var _c = k.split('|'), childKey = _c[0], weightStr = _c[1];
88
- var value = (_a = this.report[childKey]) !== null && _a !== void 0 ? _a : this.calculateNumericKey(childKey, topLevelKey);
89
- if (typeof value !== 'number') {
90
- continue;
91
- }
92
- didAdd = true;
93
- sum += value * Number(weightStr);
94
- }
95
- if (sum === 0) {
96
- continue;
97
- }
98
- finalSum = sum;
99
- break;
100
- }
101
- if (!didAdd) {
102
- this.emptyKeys.add(key);
103
- return undefined;
104
- }
105
- this.report[key] = finalSum;
106
- this.addedProps.add(key);
107
- return finalSum;
108
- };
109
- ReportRawResolvable.prototype.toJSON = function () {
110
- return this.report;
111
- };
112
- return ReportRawResolvable;
113
- }());
114
- exports.default = ReportRawResolvable;
@@ -1,2 +0,0 @@
1
- import ReportBuilder from './ReportBuilder';
2
- export default ReportBuilder;
@@ -1,4 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- var ReportBuilder_1 = require("./ReportBuilder");
4
- exports.default = ReportBuilder_1.default;
@@ -1,5 +0,0 @@
1
- import { CompanyFactListData } from '../../types';
2
- export default class ReportRawParser {
3
- private readonly reportBuilder;
4
- parseReports(companyFactListData: CompanyFactListData): import("../../types").ReportRaw[];
5
- }
@@ -1,14 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- var ReportBuilder_1 = require("../ReportBuilder");
4
- var ReportRawParser = /** @class */ (function () {
5
- function ReportRawParser() {
6
- this.reportBuilder = new ReportBuilder_1.default();
7
- }
8
- ReportRawParser.prototype.parseReports = function (companyFactListData) {
9
- var facts = this.reportBuilder.createFacts(companyFactListData).facts;
10
- return this.reportBuilder.buildReports({ facts: facts });
11
- };
12
- return ReportRawParser;
13
- }());
14
- exports.default = ReportRawParser;
@@ -1,6 +0,0 @@
1
- /**
2
- * TODO: Add this.
3
- *
4
- * @see https://xbrl.us/xbrl-taxonomy/2024-us-gaap/
5
- */
6
- export declare const calculationMapByNs: Record<string, Record<string, string[]>>;
@@ -1,9 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.calculationMapByNs = void 0;
4
- /**
5
- * TODO: Add this.
6
- *
7
- * @see https://xbrl.us/xbrl-taxonomy/2024-us-gaap/
8
- */
9
- exports.calculationMapByNs = {};