sec-edgar-api 0.0.3 → 0.0.6

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 (51) hide show
  1. package/README.md +15 -43
  2. package/build/downloader.d.ts +6 -0
  3. package/build/downloader.js +9 -0
  4. package/build/index.d.ts +2 -7
  5. package/build/index.js +12 -8
  6. package/build/services/Client/Client.d.ts +43 -0
  7. package/build/services/Client/Client.js +104 -0
  8. package/build/services/Client/index.d.ts +3 -0
  9. package/build/services/Client/index.js +15 -0
  10. package/build/services/DocumentParser/DocumentParser.d.ts +15 -0
  11. package/build/services/DocumentParser/DocumentParser.js +19 -0
  12. package/build/services/DocumentParser/XMLParser.d.ts +25 -0
  13. package/build/services/DocumentParser/XMLParser.js +178 -0
  14. package/build/services/DocumentParser/index.d.ts +2 -0
  15. package/build/services/DocumentParser/index.js +4 -0
  16. package/build/services/DocumentParser/parsers/index.d.ts +7 -0
  17. package/build/services/DocumentParser/parsers/index.js +9 -0
  18. package/build/services/DocumentParser/parsers/parse-form-13g.d.ts +8 -0
  19. package/build/services/DocumentParser/parsers/parse-form-13g.js +88 -0
  20. package/build/services/DocumentParser/parsers/parse-form-4.d.ts +8 -0
  21. package/build/services/DocumentParser/parsers/parse-form-4.js +220 -0
  22. package/build/services/FactsDownloader/Downloader.d.ts +26 -0
  23. package/build/services/FactsDownloader/Downloader.js +102 -0
  24. package/build/services/FactsDownloader/FactsDownloader.d.ts +37 -0
  25. package/build/services/FactsDownloader/FactsDownloader.js +131 -0
  26. package/build/services/FactsDownloader/Unzipper.d.ts +40 -0
  27. package/build/services/FactsDownloader/Unzipper.js +40 -0
  28. package/build/services/FactsDownloader/index.d.ts +2 -0
  29. package/build/services/FactsDownloader/index.js +4 -0
  30. package/build/services/ReportParser/ReportParser.d.ts +1 -1
  31. package/build/services/ReportParser/ReportTranslatedProxy.d.ts +1 -1
  32. package/build/services/ReportParser/ReportWrapper.js +1 -2
  33. package/build/services/ReportParser/resolvers/helpers.d.ts +1 -1
  34. package/build/services/SecEdgarApi/RequestWrapper.d.ts +30 -0
  35. package/build/services/SecEdgarApi/RequestWrapper.js +133 -0
  36. package/build/services/SecEdgarApi/SecConnector.d.ts +1 -1
  37. package/build/services/SecEdgarApi/SecConnector.js +1 -1
  38. package/build/services/SecEdgarApi/SecEdgarApi.d.ts +140 -30
  39. package/build/services/SecEdgarApi/SecEdgarApi.js +284 -42
  40. package/build/services/SecEdgarApi/Throttler.d.ts +1 -2
  41. package/build/services/SecEdgarApi/Throttler.js +13 -13
  42. package/build/services/SecEdgarApi/index.js +1 -5
  43. package/build/types/common.type.d.ts +12 -0
  44. package/build/types/common.type.js +2 -0
  45. package/build/types/index.d.ts +2 -0
  46. package/build/types/index.js +3 -5
  47. package/build/types/parsed-filings.type.d.ts +58 -0
  48. package/build/types/parsed-filings.type.js +2 -0
  49. package/build/types/report-raw.type.d.ts +3 -3
  50. package/build/types/submission.type.d.ts +19 -1
  51. package/package.json +1 -5
package/build/types/submission.type.d.ts CHANGED
@@ -21,7 +21,7 @@ interface FileData {
21
21
  filingFrom: string;
22
22
  filingTo: string;
23
23
  }
24
- interface FilingListDetails {
24
+ export interface FilingListDetails {
25
25
  accessionNumber: string[];
26
26
  filingDate: string[];
27
27
  reportDate: string[];
@@ -37,9 +37,27 @@ interface FilingListDetails {
37
37
  primaryDocument: string[];
38
38
  primaryDocDescription: string[];
39
39
  }
40
+ export interface FilingListItemTranslated {
41
+ accessionNumber: string;
42
+ filingDate: string;
43
+ reportDate: string;
44
+ acceptanceDateTime: string;
45
+ act: string;
46
+ form: string;
47
+ fileNumber: string;
48
+ filmNumber: string;
49
+ items: string;
50
+ size: number;
51
+ isXBRL: number;
52
+ isInlineXBRL: number;
53
+ primaryDocument: string;
54
+ primaryDocDescription: string;
55
+ url: string;
56
+ }
40
57
  interface FilingList {
41
58
  recent: FilingListDetails;
42
59
  files: FileData[];
60
+ recentTranslated?: FilingListItemTranslated[];
43
61
  }
44
62
  export interface SubmissionList {
45
63
  cik: number;
package/package.json CHANGED
@@ -1,14 +1,11 @@
1
1
  {
2
2
  "name": "sec-edgar-api",
3
- "version": "0.0.3",
3
+ "version": "0.0.6",
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)",
7
7
  "homepage": "https://github.com/andyevers/sec-edgar-api#readme",
8
8
  "license": "ISC",
9
- "dependencies": {
10
- "unzipper": "^0.10.14"
11
- },
12
9
  "repository": {
13
10
  "type": "git",
14
11
  "url": "git+https://github.com/andyevers/sec-edgar-api.git"
@@ -30,7 +27,6 @@
30
27
  ],
31
28
  "devDependencies": {
32
29
  "@types/jest": "^29.5.2",
33
- "@types/unzipper": "^0.10.6",
34
30
  "jest": "^29.5.0",
35
31
  "prettier": "^2.8.8",
36
32
  "ts-jest": "^29.1.0",