data-analyst-mcp 0.0.0-stage → 0.3.1
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.
- package/README.md +261 -2
- package/dist/adapters/_acf_tidy.d.ts +18 -0
- package/dist/adapters/_acf_tidy.js +432 -0
- package/dist/adapters/_acf_tidy.js.map +1 -0
- package/dist/adapters/_actuaries_read.d.ts +38 -0
- package/dist/adapters/_actuaries_read.js +728 -0
- package/dist/adapters/_actuaries_read.js.map +1 -0
- package/dist/adapters/_census_micro.d.ts +70 -0
- package/dist/adapters/_census_micro.js +622 -0
- package/dist/adapters/_census_micro.js.map +1 -0
- package/dist/adapters/_census_util.d.ts +40 -0
- package/dist/adapters/_census_util.js +275 -0
- package/dist/adapters/_census_util.js.map +1 -0
- package/dist/adapters/_dol_states.d.ts +6 -0
- package/dist/adapters/_dol_states.js +58 -0
- package/dist/adapters/_dol_states.js.map +1 -0
- package/dist/adapters/_govinfo_entities.d.ts +4 -0
- package/dist/adapters/_govinfo_entities.js +6 -0
- package/dist/adapters/_govinfo_entities.js.map +1 -0
- package/dist/adapters/_govinfo_json.d.ts +13 -0
- package/dist/adapters/_govinfo_json.js +107 -0
- package/dist/adapters/_govinfo_json.js.map +1 -0
- package/dist/adapters/_govinfo_py.d.ts +22 -0
- package/dist/adapters/_govinfo_py.js +272 -0
- package/dist/adapters/_govinfo_py.js.map +1 -0
- package/dist/adapters/_govinfo_xml.d.ts +22 -0
- package/dist/adapters/_govinfo_xml.js +233 -0
- package/dist/adapters/_govinfo_xml.js.map +1 -0
- package/dist/adapters/_hud_excel.d.ts +2 -0
- package/dist/adapters/_hud_excel.js +166 -0
- package/dist/adapters/_hud_excel.js.map +1 -0
- package/dist/adapters/_omb_grid.d.ts +17 -0
- package/dist/adapters/_omb_grid.js +132 -0
- package/dist/adapters/_omb_grid.js.map +1 -0
- package/dist/adapters/_omb_util.d.ts +40 -0
- package/dist/adapters/_omb_util.js +192 -0
- package/dist/adapters/_omb_util.js.map +1 -0
- package/dist/adapters/_usaspending_state.d.ts +6 -0
- package/dist/adapters/_usaspending_state.js +54 -0
- package/dist/adapters/_usaspending_state.js.map +1 -0
- package/dist/adapters/_usda-fna_book.d.ts +59 -0
- package/dist/adapters/_usda-fna_book.js +869 -0
- package/dist/adapters/_usda-fna_book.js.map +1 -0
- package/dist/adapters/_usda-fna_pdf.d.ts +20 -0
- package/dist/adapters/_usda-fna_pdf.js +361 -0
- package/dist/adapters/_usda-fna_pdf.js.map +1 -0
- package/dist/adapters/_usda-outlook_read.d.ts +70 -0
- package/dist/adapters/_usda-outlook_read.js +362 -0
- package/dist/adapters/_usda-outlook_read.js.map +1 -0
- package/dist/adapters/acf.d.ts +3 -0
- package/dist/adapters/acf.js +187 -0
- package/dist/adapters/acf.js.map +1 -0
- package/dist/adapters/actuaries.d.ts +3 -0
- package/dist/adapters/actuaries.js +293 -0
- package/dist/adapters/actuaries.js.map +1 -0
- package/dist/adapters/bts.d.ts +3 -0
- package/dist/adapters/bts.js +26 -0
- package/dist/adapters/bts.js.map +1 -0
- package/dist/adapters/census-geocoder.d.ts +10 -0
- package/dist/adapters/census-geocoder.js +47 -0
- package/dist/adapters/census-geocoder.js.map +1 -0
- package/dist/adapters/census.d.ts +17 -0
- package/dist/adapters/census.js +983 -0
- package/dist/adapters/census.js.map +1 -0
- package/dist/adapters/cfpb.d.ts +7 -0
- package/dist/adapters/cfpb.js +348 -0
- package/dist/adapters/cfpb.js.map +1 -0
- package/dist/adapters/clinical-trials.d.ts +3 -0
- package/dist/adapters/clinical-trials.js +135 -0
- package/dist/adapters/clinical-trials.js.map +1 -0
- package/dist/adapters/cms.d.ts +3 -0
- package/dist/adapters/cms.js +292 -0
- package/dist/adapters/cms.js.map +1 -0
- package/dist/adapters/college-scorecard.d.ts +3 -0
- package/dist/adapters/college-scorecard.js +122 -0
- package/dist/adapters/college-scorecard.js.map +1 -0
- package/dist/adapters/congress.d.ts +33 -0
- package/dist/adapters/congress.js +589 -0
- package/dist/adapters/congress.js.map +1 -0
- package/dist/adapters/dhs-ohss.d.ts +13 -0
- package/dist/adapters/dhs-ohss.js +598 -0
- package/dist/adapters/dhs-ohss.js.map +1 -0
- package/dist/adapters/doj-news.d.ts +7 -0
- package/dist/adapters/doj-news.js +286 -0
- package/dist/adapters/doj-news.js.map +1 -0
- package/dist/adapters/dol.d.ts +4 -0
- package/dist/adapters/dol.js +634 -0
- package/dist/adapters/dol.js.map +1 -0
- package/dist/adapters/eia.d.ts +15 -0
- package/dist/adapters/eia.js +456 -0
- package/dist/adapters/eia.js.map +1 -0
- package/dist/adapters/epa-aqs.d.ts +3 -0
- package/dist/adapters/epa-aqs.js +357 -0
- package/dist/adapters/epa-aqs.js.map +1 -0
- package/dist/adapters/epa.d.ts +3 -0
- package/dist/adapters/epa.js +298 -0
- package/dist/adapters/epa.js.map +1 -0
- package/dist/adapters/fbi.d.ts +3 -0
- package/dist/adapters/fbi.js +192 -0
- package/dist/adapters/fbi.js.map +1 -0
- package/dist/adapters/fda.d.ts +5 -0
- package/dist/adapters/fda.js +184 -0
- package/dist/adapters/fda.js.map +1 -0
- package/dist/adapters/fdic.d.ts +4 -0
- package/dist/adapters/fdic.js +95 -0
- package/dist/adapters/fdic.js.map +1 -0
- package/dist/adapters/fec.d.ts +3 -0
- package/dist/adapters/fec.js +142 -0
- package/dist/adapters/fec.js.map +1 -0
- package/dist/adapters/fed-board.d.ts +12 -0
- package/dist/adapters/fed-board.js +581 -0
- package/dist/adapters/fed-board.js.map +1 -0
- package/dist/adapters/federal-register.d.ts +11 -0
- package/dist/adapters/federal-register.js +43 -0
- package/dist/adapters/federal-register.js.map +1 -0
- package/dist/adapters/fhfa.d.ts +3 -0
- package/dist/adapters/fhfa.js +253 -0
- package/dist/adapters/fhfa.js.map +1 -0
- package/dist/adapters/fsa.d.ts +9 -0
- package/dist/adapters/fsa.js +335 -0
- package/dist/adapters/fsa.js.map +1 -0
- package/dist/adapters/govinfo.d.ts +30 -0
- package/dist/adapters/govinfo.js +636 -0
- package/dist/adapters/govinfo.js.map +1 -0
- package/dist/adapters/gsa-calc.d.ts +10 -0
- package/dist/adapters/gsa-calc.js +318 -0
- package/dist/adapters/gsa-calc.js.map +1 -0
- package/dist/adapters/hud.d.ts +3 -0
- package/dist/adapters/hud.js +200 -0
- package/dist/adapters/hud.js.map +1 -0
- package/dist/adapters/index.d.ts +3 -0
- package/dist/adapters/index.js +25 -0
- package/dist/adapters/index.js.map +1 -0
- package/dist/adapters/irs-soi.d.ts +6 -0
- package/dist/adapters/irs-soi.js +576 -0
- package/dist/adapters/irs-soi.js.map +1 -0
- package/dist/adapters/naep.d.ts +15 -0
- package/dist/adapters/naep.js +341 -0
- package/dist/adapters/naep.js.map +1 -0
- package/dist/adapters/nhtsa.d.ts +10 -0
- package/dist/adapters/nhtsa.js +239 -0
- package/dist/adapters/nhtsa.js.map +1 -0
- package/dist/adapters/nih.d.ts +5 -0
- package/dist/adapters/nih.js +196 -0
- package/dist/adapters/nih.js.map +1 -0
- package/dist/adapters/noaa.d.ts +3 -0
- package/dist/adapters/noaa.js +148 -0
- package/dist/adapters/noaa.js.map +1 -0
- package/dist/adapters/nrel.d.ts +3 -0
- package/dist/adapters/nrel.js +186 -0
- package/dist/adapters/nrel.js.map +1 -0
- package/dist/adapters/nws.d.ts +3 -0
- package/dist/adapters/nws.js +119 -0
- package/dist/adapters/nws.js.map +1 -0
- package/dist/adapters/omb.d.ts +15 -0
- package/dist/adapters/omb.js +517 -0
- package/dist/adapters/omb.js.map +1 -0
- package/dist/adapters/open-payments.d.ts +5 -0
- package/dist/adapters/open-payments.js +149 -0
- package/dist/adapters/open-payments.js.map +1 -0
- package/dist/adapters/pbgc.d.ts +13 -0
- package/dist/adapters/pbgc.js +283 -0
- package/dist/adapters/pbgc.js.map +1 -0
- package/dist/adapters/philfed.d.ts +12 -0
- package/dist/adapters/philfed.js +59 -0
- package/dist/adapters/philfed.js.map +1 -0
- package/dist/adapters/regulations.d.ts +6 -0
- package/dist/adapters/regulations.js +58 -0
- package/dist/adapters/regulations.js.map +1 -0
- package/dist/adapters/sec.d.ts +13 -0
- package/dist/adapters/sec.js +504 -0
- package/dist/adapters/sec.js.map +1 -0
- package/dist/adapters/senate-lobbying.d.ts +3 -0
- package/dist/adapters/senate-lobbying.js +181 -0
- package/dist/adapters/senate-lobbying.js.map +1 -0
- package/dist/adapters/snapqc.d.ts +32 -0
- package/dist/adapters/snapqc.js +701 -0
- package/dist/adapters/snapqc.js.map +1 -0
- package/dist/adapters/treasury-yields.d.ts +3 -0
- package/dist/adapters/treasury-yields.js +170 -0
- package/dist/adapters/treasury-yields.js.map +1 -0
- package/dist/adapters/usaspending.d.ts +3 -0
- package/dist/adapters/usaspending.js +340 -0
- package/dist/adapters/usaspending.js.map +1 -0
- package/dist/adapters/usda-fna.d.ts +7 -0
- package/dist/adapters/usda-fna.js +707 -0
- package/dist/adapters/usda-fna.js.map +1 -0
- package/dist/adapters/usda-fooddata.d.ts +3 -0
- package/dist/adapters/usda-fooddata.js +101 -0
- package/dist/adapters/usda-fooddata.js.map +1 -0
- package/dist/adapters/usda-nass.d.ts +3 -0
- package/dist/adapters/usda-nass.js +108 -0
- package/dist/adapters/usda-nass.js.map +1 -0
- package/dist/adapters/usda-outlook.d.ts +12 -0
- package/dist/adapters/usda-outlook.js +696 -0
- package/dist/adapters/usda-outlook.js.map +1 -0
- package/dist/adapters/usgs.d.ts +9 -0
- package/dist/adapters/usgs.js +265 -0
- package/dist/adapters/usgs.js.map +1 -0
- package/dist/adapters/usitc.d.ts +18 -0
- package/dist/adapters/usitc.js +170 -0
- package/dist/adapters/usitc.js.map +1 -0
- package/dist/adapters/uspto.d.ts +3 -0
- package/dist/adapters/uspto.js +47 -0
- package/dist/adapters/uspto.js.map +1 -0
- package/dist/adapters/world-bank.d.ts +3 -0
- package/dist/adapters/world-bank.js +163 -0
- package/dist/adapters/world-bank.js.map +1 -0
- package/dist/analysis/cite.d.ts +31 -0
- package/dist/analysis/cite.js +229 -0
- package/dist/analysis/cite.js.map +1 -0
- package/dist/analysis/combine.d.ts +27 -0
- package/dist/analysis/combine.js +198 -0
- package/dist/analysis/combine.js.map +1 -0
- package/dist/analysis/compute.d.ts +62 -0
- package/dist/analysis/compute.js +583 -0
- package/dist/analysis/compute.js.map +1 -0
- package/dist/analysis/expr.d.ts +69 -0
- package/dist/analysis/expr.js +780 -0
- package/dist/analysis/expr.js.map +1 -0
- package/dist/analysis/factfmt.d.ts +16 -0
- package/dist/analysis/factfmt.js +187 -0
- package/dist/analysis/factfmt.js.map +1 -0
- package/dist/analysis/facts.d.ts +63 -0
- package/dist/analysis/facts.js +355 -0
- package/dist/analysis/facts.js.map +1 -0
- package/dist/analysis/handoff.d.ts +58 -0
- package/dist/analysis/handoff.js +208 -0
- package/dist/analysis/handoff.js.map +1 -0
- package/dist/analysis/pyfmt.d.ts +16 -0
- package/dist/analysis/pyfmt.js +156 -0
- package/dist/analysis/pyfmt.js.map +1 -0
- package/dist/analysis/rerun.d.ts +13 -0
- package/dist/analysis/rerun.js +125 -0
- package/dist/analysis/rerun.js.map +1 -0
- package/dist/analysis/table.d.ts +18 -0
- package/dist/analysis/table.js +109 -0
- package/dist/analysis/table.js.map +1 -0
- package/dist/analysis/tools.d.ts +67 -0
- package/dist/analysis/tools.js +217 -0
- package/dist/analysis/tools.js.map +1 -0
- package/dist/analysis/write_table.d.ts +13 -0
- package/dist/analysis/write_table.js +59 -0
- package/dist/analysis/write_table.js.map +1 -0
- package/dist/bin/cli.d.ts +10 -0
- package/dist/bin/cli.js +177 -0
- package/dist/bin/cli.js.map +1 -0
- package/dist/core/cache.d.ts +14 -0
- package/dist/core/cache.js +90 -0
- package/dist/core/cache.js.map +1 -0
- package/dist/core/context.d.ts +12 -0
- package/dist/core/context.js +15 -0
- package/dist/core/context.js.map +1 -0
- package/dist/core/env.d.ts +14 -0
- package/dist/core/env.js +52 -0
- package/dist/core/env.js.map +1 -0
- package/dist/core/generic-rest.d.ts +61 -0
- package/dist/core/generic-rest.js +639 -0
- package/dist/core/generic-rest.js.map +1 -0
- package/dist/core/http.d.ts +120 -0
- package/dist/core/http.js +514 -0
- package/dist/core/http.js.map +1 -0
- package/dist/core/keys.d.ts +43 -0
- package/dist/core/keys.js +174 -0
- package/dist/core/keys.js.map +1 -0
- package/dist/core/manual.d.ts +41 -0
- package/dist/core/manual.js +218 -0
- package/dist/core/manual.js.map +1 -0
- package/dist/core/package.d.ts +58 -0
- package/dist/core/package.js +228 -0
- package/dist/core/package.js.map +1 -0
- package/dist/core/packs.d.ts +139 -0
- package/dist/core/packs.js +173 -0
- package/dist/core/packs.js.map +1 -0
- package/dist/core/policy.d.ts +69 -0
- package/dist/core/policy.js +189 -0
- package/dist/core/policy.js.map +1 -0
- package/dist/core/py.d.ts +40 -0
- package/dist/core/py.js +171 -0
- package/dist/core/py.js.map +1 -0
- package/dist/core/routing.d.ts +10 -0
- package/dist/core/routing.js +39 -0
- package/dist/core/routing.js.map +1 -0
- package/dist/core/tabular.d.ts +21 -0
- package/dist/core/tabular.js +229 -0
- package/dist/core/tabular.js.map +1 -0
- package/dist/deep/_bea_api.d.ts +102 -0
- package/dist/deep/_bea_api.js +457 -0
- package/dist/deep/_bea_api.js.map +1 -0
- package/dist/deep/_bea_fetch.d.ts +151 -0
- package/dist/deep/_bea_fetch.js +1274 -0
- package/dist/deep/_bea_fetch.js.map +1 -0
- package/dist/deep/_bea_util.d.ts +14 -0
- package/dist/deep/_bea_util.js +156 -0
- package/dist/deep/_bea_util.js.map +1 -0
- package/dist/deep/_bls_api.d.ts +84 -0
- package/dist/deep/_bls_api.js +231 -0
- package/dist/deep/_bls_api.js.map +1 -0
- package/dist/deep/_bls_ids.d.ts +43 -0
- package/dist/deep/_bls_ids.js +188 -0
- package/dist/deep/_bls_ids.js.map +1 -0
- package/dist/deep/_bls_lib.d.ts +61 -0
- package/dist/deep/_bls_lib.js +442 -0
- package/dist/deep/_bls_lib.js.map +1 -0
- package/dist/deep/_fred_api.d.ts +148 -0
- package/dist/deep/_fred_api.js +545 -0
- package/dist/deep/_fred_api.js.map +1 -0
- package/dist/deep/_fred_pack.d.ts +162 -0
- package/dist/deep/_fred_pack.js +1027 -0
- package/dist/deep/_fred_pack.js.map +1 -0
- package/dist/deep/_fred_py.d.ts +40 -0
- package/dist/deep/_fred_py.js +199 -0
- package/dist/deep/_fred_py.js.map +1 -0
- package/dist/deep/_ipums_bundle.d.ts +29 -0
- package/dist/deep/_ipums_bundle.js +194 -0
- package/dist/deep/_ipums_bundle.js.map +1 -0
- package/dist/deep/_ipums_ddi.d.ts +23 -0
- package/dist/deep/_ipums_ddi.js +162 -0
- package/dist/deep/_ipums_ddi.js.map +1 -0
- package/dist/deep/_opm_io.d.ts +26 -0
- package/dist/deep/_opm_io.js +383 -0
- package/dist/deep/_opm_io.js.map +1 -0
- package/dist/deep/_opm_parquet.d.ts +31 -0
- package/dist/deep/_opm_parquet.js +744 -0
- package/dist/deep/_opm_parquet.js.map +1 -0
- package/dist/deep/_opm_py.d.ts +6 -0
- package/dist/deep/_opm_py.js +74 -0
- package/dist/deep/_opm_py.js.map +1 -0
- package/dist/deep/_treasury_api.d.ts +48 -0
- package/dist/deep/_treasury_api.js +221 -0
- package/dist/deep/_treasury_api.js.map +1 -0
- package/dist/deep/_treasury_context.d.ts +34 -0
- package/dist/deep/_treasury_context.js +142 -0
- package/dist/deep/_treasury_context.js.map +1 -0
- package/dist/deep/_treasury_lib.d.ts +109 -0
- package/dist/deep/_treasury_lib.js +686 -0
- package/dist/deep/_treasury_lib.js.map +1 -0
- package/dist/deep/bea.d.ts +3 -0
- package/dist/deep/bea.js +248 -0
- package/dist/deep/bea.js.map +1 -0
- package/dist/deep/bls.d.ts +3 -0
- package/dist/deep/bls.js +220 -0
- package/dist/deep/bls.js.map +1 -0
- package/dist/deep/fred.d.ts +3 -0
- package/dist/deep/fred.js +325 -0
- package/dist/deep/fred.js.map +1 -0
- package/dist/deep/ipums.d.ts +59 -0
- package/dist/deep/ipums.js +744 -0
- package/dist/deep/ipums.js.map +1 -0
- package/dist/deep/opm.d.ts +56 -0
- package/dist/deep/opm.js +1033 -0
- package/dist/deep/opm.js.map +1 -0
- package/dist/deep/treasury.d.ts +3 -0
- package/dist/deep/treasury.js +218 -0
- package/dist/deep/treasury.js.map +1 -0
- package/dist/envelope.d.ts +47 -0
- package/dist/envelope.js +88 -0
- package/dist/envelope.js.map +1 -0
- package/dist/index.d.ts +277 -0
- package/dist/index.js +106 -0
- package/dist/index.js.map +1 -0
- package/dist/remote/app.d.ts +21 -0
- package/dist/remote/app.js +218 -0
- package/dist/remote/app.js.map +1 -0
- package/dist/remote/oauth.d.ts +14 -0
- package/dist/remote/oauth.js +90 -0
- package/dist/remote/oauth.js.map +1 -0
- package/dist/remote/pages.d.ts +8 -0
- package/dist/remote/pages.js +56 -0
- package/dist/remote/pages.js.map +1 -0
- package/dist/remote/sign.d.ts +4 -0
- package/dist/remote/sign.js +40 -0
- package/dist/remote/sign.js.map +1 -0
- package/dist/remote/store.d.ts +31 -0
- package/dist/remote/store.js +129 -0
- package/dist/remote/store.js.map +1 -0
- package/dist/report/audit_answer.d.ts +94 -0
- package/dist/report/audit_answer.js +1349 -0
- package/dist/report/audit_answer.js.map +1 -0
- package/dist/report/audit_report.d.ts +23 -0
- package/dist/report/audit_report.js +637 -0
- package/dist/report/audit_report.js.map +1 -0
- package/dist/report/build_report.d.ts +27 -0
- package/dist/report/build_report.js +1168 -0
- package/dist/report/build_report.js.map +1 -0
- package/dist/report/method_audit.d.ts +47 -0
- package/dist/report/method_audit.js +716 -0
- package/dist/report/method_audit.js.map +1 -0
- package/dist/report/policyset.d.ts +50 -0
- package/dist/report/policyset.js +421 -0
- package/dist/report/policyset.js.map +1 -0
- package/dist/report/py.d.ts +58 -0
- package/dist/report/py.js +311 -0
- package/dist/report/py.js.map +1 -0
- package/dist/report/scan_secrets.d.ts +24 -0
- package/dist/report/scan_secrets.js +265 -0
- package/dist/report/scan_secrets.js.map +1 -0
- package/dist/report/style_check.d.ts +29 -0
- package/dist/report/style_check.js +173 -0
- package/dist/report/style_check.js.map +1 -0
- package/dist/report/tools.d.ts +87 -0
- package/dist/report/tools.js +167 -0
- package/dist/report/tools.js.map +1 -0
- package/dist/server.d.ts +5 -0
- package/dist/server.js +247 -0
- package/dist/server.js.map +1 -0
- package/dist/session.d.ts +47 -0
- package/dist/session.js +107 -0
- package/dist/session.js.map +1 -0
- package/dist/toolkit.d.ts +21 -0
- package/dist/toolkit.js +2 -0
- package/dist/toolkit.js.map +1 -0
- package/dist/tools.d.ts +299 -0
- package/dist/tools.js +491 -0
- package/dist/tools.js.map +1 -0
- package/guide/WORKFLOW.md +134 -0
- package/guide/assets/disclaimer.txt +1 -0
- package/guide/assets/download_data.ps1 +162 -0
- package/guide/assets/download_data.sh +143 -0
- package/guide/assets/report_template.html +597 -0
- package/guide/references/report_patterns.md +199 -0
- package/guide/references/routing.md +171 -0
- package/guide/references/style_guide.md +398 -0
- package/package.json +54 -4
- package/packs/acf/endpoints.json +114 -0
- package/packs/acf/policy.json +104 -0
- package/packs/acf/source.md +138 -0
- package/packs/actuaries/endpoints.json +82 -0
- package/packs/actuaries/policy.json +109 -0
- package/packs/actuaries/source.md +137 -0
- package/packs/bea/assets/download_bea.ps1 +182 -0
- package/packs/bea/assets/download_bea.sh +144 -0
- package/packs/bea/docs/bea_api.md +461 -0
- package/packs/bea/docs/datasets.md +157 -0
- package/packs/bea/docs/report_patterns.md +112 -0
- package/packs/bea/policy.json +170 -0
- package/packs/bea/source.md +152 -0
- package/packs/bls/assets/download_bls.ps1 +152 -0
- package/packs/bls/assets/download_bls.sh +167 -0
- package/packs/bls/docs/analysis_patterns.md +108 -0
- package/packs/bls/docs/bls_api.md +73 -0
- package/packs/bls/docs/series_ids.md +149 -0
- package/packs/bls/policy.json +238 -0
- package/packs/bls/series_ids.json +1375 -0
- package/packs/bls/source.md +156 -0
- package/packs/bts/endpoints.json +347 -0
- package/packs/bts/policy.json +94 -0
- package/packs/bts/source.md +97 -0
- package/packs/cdc/endpoints.json +197 -0
- package/packs/cdc/policy.json +83 -0
- package/packs/cdc/source.md +74 -0
- package/packs/census/endpoints.json +99 -0
- package/packs/census/policy.json +238 -0
- package/packs/census/source.md +304 -0
- package/packs/census-geocoder/endpoints.json +70 -0
- package/packs/census-geocoder/policy.json +80 -0
- package/packs/census-geocoder/source.md +53 -0
- package/packs/cfpb/endpoints.json +327 -0
- package/packs/cfpb/policy.json +119 -0
- package/packs/cfpb/source.md +96 -0
- package/packs/clinical-trials/endpoints.json +167 -0
- package/packs/clinical-trials/policy.json +84 -0
- package/packs/clinical-trials/source.md +82 -0
- package/packs/cms/endpoints.json +69 -0
- package/packs/cms/policy.json +96 -0
- package/packs/cms/source.md +112 -0
- package/packs/college-scorecard/endpoints.json +253 -0
- package/packs/college-scorecard/policy.json +106 -0
- package/packs/college-scorecard/source.md +92 -0
- package/packs/congress/endpoints.json +1701 -0
- package/packs/congress/policy.json +117 -0
- package/packs/congress/source.md +190 -0
- package/packs/dhs-ohss/endpoints.json +66 -0
- package/packs/dhs-ohss/policy.json +107 -0
- package/packs/dhs-ohss/source.md +120 -0
- package/packs/doj-news/endpoints.json +59 -0
- package/packs/doj-news/policy.json +96 -0
- package/packs/doj-news/source.md +99 -0
- package/packs/dol/endpoints.json +818 -0
- package/packs/dol/policy.json +135 -0
- package/packs/dol/source.md +181 -0
- package/packs/eia/endpoints.json +718 -0
- package/packs/eia/policy.json +112 -0
- package/packs/eia/source.md +112 -0
- package/packs/epa/endpoints.json +292 -0
- package/packs/epa/policy.json +99 -0
- package/packs/epa/source.md +99 -0
- package/packs/epa-aqs/endpoints.json +174 -0
- package/packs/epa-aqs/policy.json +96 -0
- package/packs/epa-aqs/source.md +97 -0
- package/packs/fbi/endpoints.json +1842 -0
- package/packs/fbi/policy.json +118 -0
- package/packs/fbi/source.md +108 -0
- package/packs/fda/endpoints.json +238 -0
- package/packs/fda/policy.json +121 -0
- package/packs/fda/source.md +117 -0
- package/packs/fdic/endpoints.json +417 -0
- package/packs/fdic/policy.json +83 -0
- package/packs/fdic/source.md +92 -0
- package/packs/fec/endpoints.json +708 -0
- package/packs/fec/policy.json +93 -0
- package/packs/fec/source.md +90 -0
- package/packs/fed-board/endpoints.json +89 -0
- package/packs/fed-board/policy.json +136 -0
- package/packs/fed-board/source.md +118 -0
- package/packs/federal-register/endpoints.json +143 -0
- package/packs/federal-register/policy.json +86 -0
- package/packs/federal-register/source.md +98 -0
- package/packs/fema/endpoints.json +646 -0
- package/packs/fema/policy.json +103 -0
- package/packs/fema/source.md +103 -0
- package/packs/fhfa/endpoints.json +105 -0
- package/packs/fhfa/policy.json +109 -0
- package/packs/fhfa/source.md +108 -0
- package/packs/fred/assets/download_fred.ps1 +122 -0
- package/packs/fred/assets/download_fred.sh +123 -0
- package/packs/fred/docs/analysis_patterns.md +124 -0
- package/packs/fred/docs/fred_api.md +94 -0
- package/packs/fred/docs/series.md +188 -0
- package/packs/fred/policy.json +253 -0
- package/packs/fred/source.md +142 -0
- package/packs/fsa/endpoints.json +150 -0
- package/packs/fsa/policy.json +99 -0
- package/packs/fsa/source.md +102 -0
- package/packs/govinfo/endpoints.json +520 -0
- package/packs/govinfo/policy.json +116 -0
- package/packs/govinfo/source.md +241 -0
- package/packs/gsa-calc/endpoints.json +93 -0
- package/packs/gsa-calc/policy.json +97 -0
- package/packs/gsa-calc/source.md +108 -0
- package/packs/hud/endpoints.json +147 -0
- package/packs/hud/policy.json +84 -0
- package/packs/hud/source.md +97 -0
- package/packs/ipums/assets/download_ipums.ps1 +215 -0
- package/packs/ipums/assets/download_ipums.sh +192 -0
- package/packs/ipums/docs/ipums_api.md +67 -0
- package/packs/ipums/docs/report_patterns.md +117 -0
- package/packs/ipums/docs/variables.md +284 -0
- package/packs/ipums/lib/fetch_text.json +112 -0
- package/packs/ipums/policy.json +215 -0
- package/packs/ipums/source.md +169 -0
- package/packs/irs-soi/endpoints.json +114 -0
- package/packs/irs-soi/policy.json +107 -0
- package/packs/irs-soi/source.md +124 -0
- package/packs/medicaid/endpoints.json +412 -0
- package/packs/medicaid/policy.json +108 -0
- package/packs/medicaid/source.md +136 -0
- package/packs/naep/endpoints.json +217 -0
- package/packs/naep/policy.json +100 -0
- package/packs/naep/source.md +120 -0
- package/packs/nhtsa/endpoints.json +132 -0
- package/packs/nhtsa/policy.json +93 -0
- package/packs/nhtsa/source.md +109 -0
- package/packs/nih/endpoints.json +453 -0
- package/packs/nih/policy.json +86 -0
- package/packs/nih/source.md +108 -0
- package/packs/noaa/endpoints.json +432 -0
- package/packs/noaa/policy.json +95 -0
- package/packs/noaa/source.md +88 -0
- package/packs/nrel/endpoints.json +328 -0
- package/packs/nrel/policy.json +96 -0
- package/packs/nrel/source.md +91 -0
- package/packs/nws/endpoints.json +272 -0
- package/packs/nws/policy.json +82 -0
- package/packs/nws/source.md +81 -0
- package/packs/nyfed/endpoints.json +80 -0
- package/packs/nyfed/policy.json +92 -0
- package/packs/nyfed/source.md +89 -0
- package/packs/omb/endpoints.json +460 -0
- package/packs/omb/policy.json +106 -0
- package/packs/omb/source.md +130 -0
- package/packs/open-payments/endpoints.json +298 -0
- package/packs/open-payments/policy.json +101 -0
- package/packs/open-payments/source.md +99 -0
- package/packs/opm/assets/download_opm.ps1 +125 -0
- package/packs/opm/assets/download_opm.sh +85 -0
- package/packs/opm/docs/fields.md +184 -0
- package/packs/opm/docs/opm_api.md +71 -0
- package/packs/opm/docs/report_patterns.md +83 -0
- package/packs/opm/lib/data_dictionary.csv +73 -0
- package/packs/opm/policy.json +142 -0
- package/packs/opm/source.md +137 -0
- package/packs/pbgc/endpoints.json +483 -0
- package/packs/pbgc/policy.json +94 -0
- package/packs/pbgc/source.md +95 -0
- package/packs/philfed/endpoints.json +85 -0
- package/packs/philfed/policy.json +94 -0
- package/packs/philfed/source.md +125 -0
- package/packs/port.json +287 -0
- package/packs/regulations/endpoints.json +288 -0
- package/packs/regulations/policy.json +86 -0
- package/packs/regulations/source.md +84 -0
- package/packs/sec/endpoints.json +237 -0
- package/packs/sec/policy.json +86 -0
- package/packs/sec/source.md +101 -0
- package/packs/senate-lobbying/endpoints.json +554 -0
- package/packs/senate-lobbying/policy.json +99 -0
- package/packs/senate-lobbying/source.md +100 -0
- package/packs/snapqc/endpoints.json +1426 -0
- package/packs/snapqc/policy.json +92 -0
- package/packs/snapqc/source.md +96 -0
- package/packs/treasury/catalog.json +2267 -0
- package/packs/treasury/docs/api_guide.md +245 -0
- package/packs/treasury/docs/datasets.md +56 -0
- package/packs/treasury/docs/report_patterns.md +126 -0
- package/packs/treasury/policy.json +159 -0
- package/packs/treasury/source.md +170 -0
- package/packs/treasury-yields/endpoints.json +226 -0
- package/packs/treasury-yields/policy.json +86 -0
- package/packs/treasury-yields/source.md +80 -0
- package/packs/usaspending/endpoints.json +1316 -0
- package/packs/usaspending/policy.json +109 -0
- package/packs/usaspending/source.md +103 -0
- package/packs/usda-fna/endpoints.json +427 -0
- package/packs/usda-fna/policy.json +133 -0
- package/packs/usda-fna/source.md +217 -0
- package/packs/usda-fooddata/endpoints.json +181 -0
- package/packs/usda-fooddata/policy.json +94 -0
- package/packs/usda-fooddata/source.md +105 -0
- package/packs/usda-nass/endpoints.json +324 -0
- package/packs/usda-nass/policy.json +95 -0
- package/packs/usda-nass/source.md +85 -0
- package/packs/usda-outlook/endpoints.json +86 -0
- package/packs/usda-outlook/policy.json +109 -0
- package/packs/usda-outlook/source.md +144 -0
- package/packs/usgs/endpoints.json +313 -0
- package/packs/usgs/policy.json +95 -0
- package/packs/usgs/source.md +96 -0
- package/packs/usitc/endpoints.json +74 -0
- package/packs/usitc/policy.json +111 -0
- package/packs/usitc/source.md +90 -0
- package/packs/uspto/endpoints.json +141 -0
- package/packs/uspto/policy.json +95 -0
- package/packs/uspto/source.md +101 -0
- package/packs/va/endpoints.json +414 -0
- package/packs/va/policy.json +101 -0
- package/packs/va/source.md +129 -0
- package/packs/world-bank/endpoints.json +122 -0
- package/packs/world-bank/policy.json +101 -0
- package/packs/world-bank/source.md +93 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"philfed.js","sourceRoot":"","sources":["../../src/adapters/philfed.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AAEtC,MAAM,UAAU,GAAG,0EAA0E,CAAC;AAC9F,MAAM,QAAQ,GAAG,6GAA6G,CAAC;AAE/H,SAAS,UAAU,CAAC,MAAc,EAAE,IAAY;IAC9C,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;IACpG,IAAI,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QAClE,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,uBAAuB,CAAC,CAAC,CAAC,cAAc,CAAC;QACxI,OAAO,sCAAsC,IAAI,UAAU,MAAM,6CAA6C;YAC5G,8FAA8F;YAC9F,qFAAqF,UAAU,GAAG,CAAC;IACvG,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,0DAA0D;AAC1D,SAAS,GAAG,CAAC,CAAU;IACrB,IAAI,OAAO,CAAC,KAAK,QAAQ;QAAE,OAAO,CAAC,CAAC;IACpC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IAC/C,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAC1B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;QAAE,OAAO,IAAI,CAAC;IACnC,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;IAC5C,IAAI,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC;IACvE,IAAI,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,GAAG,CAAC;IAClC,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC;AACnB,CAAC;AAED,SAAS,MAAM,CAAC,GAAQ;IACtB,MAAM,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC9C,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;AAC7E,CAAC;AAED,SAAS,SAAS,CAAC,CAAU;IAC3B,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;IACjB,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC;QAAE,OAAO,EAAE,CAAC;IACpD,MAAM,CAAC,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC;IACtE,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,cAAc,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC;AACrJ,CAAC;AAED,SAAS,QAAQ,CAAC,CAAU;IAC1B,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,SAAS,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACrH,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;AACvF,CAAC;AAED,SAAS,SAAS,CAAC,GAAgB,EAAE,GAAQ,EAAE,IAAW;IACxD,MAAM,IAAI,GAAG,GAAG,CAAC,QAAQ,CAAC;IAC1B,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QACpB,IAAI,CAAC,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,UAAU,CAAC,IAAI,MAAM,IAAI,CAAC;YAAE,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC;QAC/F,IAAI,IAAI,KAAK,YAAY,IAAI,MAAM,IAAI,CAAC;YAAE,OAAO,EAAE,WAAW,EAAE,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC;QAC1F,IAAI,IAAI,KAAK,WAAW,IAAI,QAAQ,IAAI,CAAC;YAAE,OAAO,EAAE,cAAc,EAAE,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC;QAC/F,OAAO,CAAC,CAAC;IACX,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,OAAO,GAAY,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC;AACnD,eAAe,OAAO,CAAC"}
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Regulations.gov pack hooks.
|
|
3
|
+
*
|
|
4
|
+
* - normalize: JSON:API rows come as id/type/attributes.*; drop the "attributes." prefix from column names (values
|
|
5
|
+
* unchanged) so tables read naturally.
|
|
6
|
+
* - manualItems: links carry api_key=DEMO_KEY, which works in any browser at low limits (api.data.gov's public demo
|
|
7
|
+
* key); the user may replace it with their own key.
|
|
8
|
+
* - keyOnlyNeeds: DEMO_KEY allows only about 10 requests an hour on this API, so large requests need a key.
|
|
9
|
+
*/
|
|
10
|
+
import path from "node:path";
|
|
11
|
+
import { PACKS_DIR } from "../core/env.js";
|
|
12
|
+
import * as gr from "../core/generic-rest.js";
|
|
13
|
+
import { readJson } from "../core/policy.js";
|
|
14
|
+
const DEMO_LIMIT = 8;
|
|
15
|
+
export function normalize(req, ep, rows) {
|
|
16
|
+
if (ep.records === "meta") { // comment_count: the filters asked for and the total
|
|
17
|
+
const filters = Object.fromEntries(Object.entries(req.params || {}).filter(([k]) => k.startsWith("filter[")));
|
|
18
|
+
return rows.map((r) => ({ ...filters, totalElements: r.totalElements ?? "" }));
|
|
19
|
+
}
|
|
20
|
+
return rows.map((r) => {
|
|
21
|
+
const n = {};
|
|
22
|
+
for (const [k, v] of Object.entries(r)) {
|
|
23
|
+
let k2 = k.startsWith("attributes.") ? k.slice("attributes.".length) : k;
|
|
24
|
+
if (k2 in n && k2 !== k)
|
|
25
|
+
k2 = k;
|
|
26
|
+
n[k2] = v;
|
|
27
|
+
}
|
|
28
|
+
return n;
|
|
29
|
+
});
|
|
30
|
+
}
|
|
31
|
+
function calls(spec) {
|
|
32
|
+
const eps = readJson(path.join(PACKS_DIR, "regulations"), "endpoints.json").endpoints;
|
|
33
|
+
let n = 0;
|
|
34
|
+
for (const r of spec.requests || []) {
|
|
35
|
+
const pg = (eps[r.endpoint || ""] || {}).paging || {};
|
|
36
|
+
if (pg.type === "page" && r.max_rows)
|
|
37
|
+
n += Math.max(1, Math.ceil(Math.trunc(Number(r.max_rows)) / Math.trunc(Number(pg.size || 250))));
|
|
38
|
+
else
|
|
39
|
+
n += 1;
|
|
40
|
+
}
|
|
41
|
+
return n;
|
|
42
|
+
}
|
|
43
|
+
function keyOnlyNeeds(spec) {
|
|
44
|
+
const n = calls(spec);
|
|
45
|
+
return n > DEMO_LIMIT ? [`about ${n} API calls (the keyless DEMO_KEY allows about 10 an hour on Regulations.gov)`] : [];
|
|
46
|
+
}
|
|
47
|
+
function manualItems(spec, pack) {
|
|
48
|
+
const items = gr.manualItems(pack, spec);
|
|
49
|
+
for (const it of items) {
|
|
50
|
+
it.url += (it.url.includes("?") ? "&" : "?") + "api_key=DEMO_KEY";
|
|
51
|
+
it.note = (it.note ? it.note + "; " : "") +
|
|
52
|
+
"DEMO_KEY is api.data.gov's public demo key (about 10 requests an hour); replace it with your own key for more";
|
|
53
|
+
}
|
|
54
|
+
return items;
|
|
55
|
+
}
|
|
56
|
+
const adapter = { normalize, keyOnlyNeeds, manualItems };
|
|
57
|
+
export default adapter;
|
|
58
|
+
//# sourceMappingURL=regulations.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"regulations.js","sourceRoot":"","sources":["../../src/adapters/regulations.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAE9C,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C,MAAM,UAAU,GAAG,CAAC,CAAC;AAErB,MAAM,UAAU,SAAS,CAAC,GAAyC,EAAE,EAAO,EAAE,IAAW;IACvF,IAAI,EAAE,CAAC,OAAO,KAAK,MAAM,EAAE,CAAC,CAAC,qDAAqD;QAChF,MAAM,OAAO,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAC9G,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,aAAa,EAAE,CAAC,CAAC,aAAa,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;IACjF,CAAC;IACD,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QACpB,MAAM,CAAC,GAAQ,EAAE,CAAC;QAClB,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;YACvC,IAAI,EAAE,GAAG,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACzE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC;gBAAE,EAAE,GAAG,CAAC,CAAC;YAChC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;QACZ,CAAC;QACD,OAAO,CAAC,CAAC;IACX,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,KAAK,CAAC,IAAU;IACvB,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,CAAC,EAAE,gBAAgB,CAAC,CAAC,SAAS,CAAC;IACtF,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,QAAQ,IAAI,EAAE,EAAE,CAAC;QACpC,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC;QACtD,IAAI,EAAE,CAAC,IAAI,KAAK,MAAM,IAAI,CAAC,CAAC,QAAQ;YAAE,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;;YAClI,CAAC,IAAI,CAAC,CAAC;IACd,CAAC;IACD,OAAO,CAAC,CAAC;AACX,CAAC;AAED,SAAS,YAAY,CAAC,IAAU;IAC9B,MAAM,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;IACtB,OAAO,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,8EAA8E,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAC1H,CAAC;AAED,SAAS,WAAW,CAAC,IAAU,EAAE,IAAU;IACzC,MAAM,KAAK,GAAG,EAAE,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACzC,KAAK,MAAM,EAAE,IAAI,KAAK,EAAE,CAAC;QACvB,EAAE,CAAC,GAAG,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,kBAAkB,CAAC;QAClE,EAAE,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;YACvC,+GAA+G,CAAC;IACpH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,OAAO,GAAY,EAAE,SAAS,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC;AAClE,eAAe,OAAO,CAAC"}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type { Adapter, Row } from "../core/packs.js";
|
|
2
|
+
export declare const DEFAULT_UA = "data-analyst/1.0 (U.S. government open data analysis tool)";
|
|
3
|
+
export declare function userAgent(): string;
|
|
4
|
+
/** Length of a duration fact in days (end - start + 1); "" for instant facts (no start). */
|
|
5
|
+
export declare function days(start: unknown, end: unknown): number | "";
|
|
6
|
+
/** A ratio unit is keyed 'USD/shares' in company_concept and company_facts but written 'USD-per-shares'
|
|
7
|
+
* in the frames URL (SEC's API doc; verified 2026-10-22). Accept either spelling and send the one the endpoint uses. */
|
|
8
|
+
export declare function unitFor(endpoint: string, unit: unknown): any;
|
|
9
|
+
/** frames_only: one value per period, periods that do not overlap (see the Python adapter's notes): a period with no
|
|
10
|
+
* framed fact keeps its latest-filed fact when its length is one the series has. Returns [rows, restored, skipped]. */
|
|
11
|
+
export declare function onePerPeriod(rows: Row[], duration?: string | null): [Row[], number, number];
|
|
12
|
+
declare const adapter: Adapter;
|
|
13
|
+
export default adapter;
|
|
@@ -0,0 +1,504 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* SEC EDGAR adapter (data.sec.gov XBRL and submissions APIs, efts.sec.gov full-text search). Keyless.
|
|
3
|
+
*
|
|
4
|
+
* User-Agent: SEC's fair-access policy asks every automated client to identify itself with a contact
|
|
5
|
+
* email ("Sample Company Name AdminContact@<sample company domain>.com") and to stay under 10 requests a
|
|
6
|
+
* second. The pack sends SEC_USER_AGENT (environment variable, or "env" in keys.json or Claude Code's settings.json)
|
|
7
|
+
* when set, else a generic tool name. It never sends a User-Agent that contains a GitHub URL, because SEC's
|
|
8
|
+
* firewall answers HTTP 403 to those (verified 2026-10-20).
|
|
9
|
+
* data.sec.gov and efts.sec.gov accept the generic name; www.sec.gov (company_tickers.json, the
|
|
10
|
+
* Archives) needs a contact email, so this pack resolves tickers with efts instead.
|
|
11
|
+
*
|
|
12
|
+
* Every response is reshaped here (columnar submissions arrays, nested XBRL units), so fetch() replaces
|
|
13
|
+
* the generic fetch. Published values are never changed: rows keep val, unit, fy, fp, form, filed, frame.
|
|
14
|
+
*/
|
|
15
|
+
import fs from "node:fs";
|
|
16
|
+
import * as gr from "../core/generic-rest.js";
|
|
17
|
+
import { DataError } from "../core/http.js";
|
|
18
|
+
import * as keys from "../core/keys.js";
|
|
19
|
+
import { parsePyJson, pyStr, pyUrlencode } from "../core/py.js";
|
|
20
|
+
export const DEFAULT_UA = "data-analyst/1.0 (U.S. government open data analysis tool)";
|
|
21
|
+
const UA_ENV = "SEC_USER_AGENT";
|
|
22
|
+
const EFTS = "https://efts.sec.gov/LATEST/search-index";
|
|
23
|
+
const ARCHIVES = "https://www.sec.gov/Archives/edgar/data";
|
|
24
|
+
const CO_EPS = ["submissions", "company_concept", "company_facts", "insider_filings"];
|
|
25
|
+
const fmt = (n) => n.toLocaleString("en-US");
|
|
26
|
+
/** Python str() of a value, with None as "None" (as str(None) gives inside f-strings and sort keys). */
|
|
27
|
+
const pstr = (v) => (v === null || v === undefined ? "None" : pyStr(v));
|
|
28
|
+
/** dict.get(k, d): the default only when the key is absent (a JSON null stays null). */
|
|
29
|
+
const get = (o, k, d = null) => (o && typeof o === "object" && k in o ? o[k] : d);
|
|
30
|
+
const isDigits = (s) => /^\d+$/.test(s);
|
|
31
|
+
export function userAgent() {
|
|
32
|
+
const [ua0] = keys.findKey(UA_ENV);
|
|
33
|
+
const ua = (ua0 || "").trim();
|
|
34
|
+
if (!ua || ua.toLowerCase().includes("github"))
|
|
35
|
+
return DEFAULT_UA;
|
|
36
|
+
return ua;
|
|
37
|
+
}
|
|
38
|
+
function client(pack) {
|
|
39
|
+
return gr.clientFor(pack, undefined, { userAgent: userAgent() });
|
|
40
|
+
}
|
|
41
|
+
function checkError(_status, body) {
|
|
42
|
+
const head = body.subarray(0, 300);
|
|
43
|
+
const h = head.toString("latin1");
|
|
44
|
+
if (h.slice(0, 1) === "{" && (h.includes('"errorType"') || h.includes('"errorMessage"'))) {
|
|
45
|
+
return "EDGAR search is temporarily failing (" + head.toString("utf8").slice(0, 160) + "); try again in a minute";
|
|
46
|
+
}
|
|
47
|
+
if (h.trimStart().slice(0, 1) === "<" && body.subarray(0, 2000).toString("latin1").includes("Request Rate Threshold")) {
|
|
48
|
+
return "SEC refused the request (rate threshold / undeclared automated tool). Set SEC_USER_AGENT to " +
|
|
49
|
+
"'Your Name your.email@example.org' and keep under 10 requests a second";
|
|
50
|
+
}
|
|
51
|
+
return null;
|
|
52
|
+
}
|
|
53
|
+
function pad(cik) {
|
|
54
|
+
const s = pyStr(cik).replace(/\D/g, "");
|
|
55
|
+
if (!s)
|
|
56
|
+
throw new DataError(`not a CIK: ${pyRepr(cik)}`, "bad_request");
|
|
57
|
+
return s.padStart(10, "0");
|
|
58
|
+
}
|
|
59
|
+
function pyRepr(v) {
|
|
60
|
+
if (v === null || v === undefined)
|
|
61
|
+
return "None";
|
|
62
|
+
if (typeof v === "string")
|
|
63
|
+
return v.includes("'") && !v.includes('"') ? `"${v}"` : `'${v.replace(/\\/g, "\\\\").replace(/'/g, "\\'")}'`;
|
|
64
|
+
return pyStr(v);
|
|
65
|
+
}
|
|
66
|
+
async function lookup(c, text, limit = 10) {
|
|
67
|
+
const data = await c.getJson(EFTS, { keysTyped: text.trim() });
|
|
68
|
+
const out = [];
|
|
69
|
+
for (const h of ((get(data, "hits") || {}).hits || []).slice(0, limit)) {
|
|
70
|
+
const src = get(h, "_source") || {};
|
|
71
|
+
const cik = pyStr(get(h, "_id") || "");
|
|
72
|
+
if (!isDigits(cik))
|
|
73
|
+
continue;
|
|
74
|
+
out.push({ cik: cik.padStart(10, "0"), name: pyStr(get(src, "entity") || "").replace(/\s*\([^)]*\)\s*$/, "").trim(),
|
|
75
|
+
tickers: get(src, "tickers") || "", entity: get(src, "entity") || "" });
|
|
76
|
+
}
|
|
77
|
+
return out;
|
|
78
|
+
}
|
|
79
|
+
async function resolveCik(c, params) {
|
|
80
|
+
if (params.cik)
|
|
81
|
+
return pad(params.cik);
|
|
82
|
+
const t = pyStr(params.ticker || "").trim();
|
|
83
|
+
if (/^\d{1,10}$/.test(t))
|
|
84
|
+
return pad(t);
|
|
85
|
+
const hits = await lookup(c, t);
|
|
86
|
+
const want = t.toUpperCase();
|
|
87
|
+
const exact = hits.filter((h) => pyStr(h.tickers).split(",").map((x) => x.trim().toUpperCase()).includes(want));
|
|
88
|
+
if (exact.length)
|
|
89
|
+
return exact[0].cik;
|
|
90
|
+
const named = hits.filter((h) => String(h.name).toUpperCase() === want);
|
|
91
|
+
if (named.length)
|
|
92
|
+
return named[0].cik;
|
|
93
|
+
throw new DataError(`no SEC registrant has the ticker or exact name ${pyRepr(t)}. Candidates: ` +
|
|
94
|
+
hits.slice(0, 5).map((h) => `${h.entity} CIK ${h.cik}`).join("; ") + ". Put the right one in params.cik.", "bad_request");
|
|
95
|
+
}
|
|
96
|
+
function split(v) {
|
|
97
|
+
if (v === null || v === undefined || v === "")
|
|
98
|
+
return [];
|
|
99
|
+
return (Array.isArray(v) ? v : pyStr(v).split(",")).filter((x) => pyStr(x).trim()).map((x) => pyStr(x).trim());
|
|
100
|
+
}
|
|
101
|
+
const truthy = (v) => ["true", "1", "yes"].includes(pstr(v).toLowerCase());
|
|
102
|
+
const DURATIONS = { annual: [350, 380], quarter: [80, 100] };
|
|
103
|
+
/** date.fromisoformat for YYYY-MM-DD (null when it is not one). */
|
|
104
|
+
function isoDay(s) {
|
|
105
|
+
if (typeof s !== "string")
|
|
106
|
+
return null;
|
|
107
|
+
const m = /^(\d{4})-(\d{2})-(\d{2})$/.exec(s);
|
|
108
|
+
if (!m)
|
|
109
|
+
return null;
|
|
110
|
+
const [y, mo, d] = [Number(m[1]), Number(m[2]), Number(m[3])];
|
|
111
|
+
const t = Date.UTC(y, mo - 1, d);
|
|
112
|
+
const dt = new Date(t);
|
|
113
|
+
if (y < 1 || dt.getUTCFullYear() !== y || dt.getUTCMonth() !== mo - 1 || dt.getUTCDate() !== d)
|
|
114
|
+
return null;
|
|
115
|
+
return Math.round(t / 86400000);
|
|
116
|
+
}
|
|
117
|
+
/** Length of a duration fact in days (end - start + 1); "" for instant facts (no start). */
|
|
118
|
+
export function days(start, end) {
|
|
119
|
+
const a = isoDay(start), b = isoDay(end);
|
|
120
|
+
return a === null || b === null ? "" : b - a + 1;
|
|
121
|
+
}
|
|
122
|
+
/** A ratio unit is keyed 'USD/shares' in company_concept and company_facts but written 'USD-per-shares'
|
|
123
|
+
* in the frames URL (SEC's API doc; verified 2026-10-22). Accept either spelling and send the one the endpoint uses. */
|
|
124
|
+
export function unitFor(endpoint, unit) {
|
|
125
|
+
if (!unit)
|
|
126
|
+
return unit;
|
|
127
|
+
const u = pyStr(unit);
|
|
128
|
+
return endpoint === "frames" ? u.replaceAll("/", "-per-") : u.replaceAll("-per-", "/");
|
|
129
|
+
}
|
|
130
|
+
/** Two facts of about the same period (end dates and lengths within a week: 52/53-week years). */
|
|
131
|
+
function near(a, b) {
|
|
132
|
+
const ea = isoDay(a.end), eb = isoDay(b.end);
|
|
133
|
+
if (ea === null || eb === null)
|
|
134
|
+
return a.end === b.end;
|
|
135
|
+
const da = a.period_days, db = b.period_days;
|
|
136
|
+
return Math.abs(ea - eb) <= 7 && ((da === "" && db === "") || (da !== "" && db !== "" && Math.abs(Number(da) - Number(db)) <= 7));
|
|
137
|
+
}
|
|
138
|
+
/** A fact's period class: instant, annual or quarter (null: any other length, e.g. a 6- or 9-month YTD). */
|
|
139
|
+
function length(d) {
|
|
140
|
+
if (d === "")
|
|
141
|
+
return "instant";
|
|
142
|
+
const n = Number(d);
|
|
143
|
+
return Object.entries(DURATIONS).find(([, [lo, hi]]) => lo <= n && n <= hi)?.[0] ?? null;
|
|
144
|
+
}
|
|
145
|
+
const cmp = (a, b) => (a < b ? -1 : a > b ? 1 : 0);
|
|
146
|
+
function cmpTuple(a, b) {
|
|
147
|
+
for (let i = 0; i < Math.min(a.length, b.length); i++) {
|
|
148
|
+
const c = cmp(a[i], b[i]);
|
|
149
|
+
if (c)
|
|
150
|
+
return c;
|
|
151
|
+
}
|
|
152
|
+
return a.length - b.length;
|
|
153
|
+
}
|
|
154
|
+
/** frames_only: one value per period, periods that do not overlap (see the Python adapter's notes): a period with no
|
|
155
|
+
* framed fact keeps its latest-filed fact when its length is one the series has. Returns [rows, restored, skipped]. */
|
|
156
|
+
export function onePerPeriod(rows, duration) {
|
|
157
|
+
const framed = rows.filter((r) => r.frame);
|
|
158
|
+
const kinds = new Set(framed.map((r) => length(r.period_days)));
|
|
159
|
+
if (duration)
|
|
160
|
+
kinds.add(duration);
|
|
161
|
+
const groups = new Map();
|
|
162
|
+
for (const r of rows) {
|
|
163
|
+
if (r.frame)
|
|
164
|
+
continue;
|
|
165
|
+
const k = JSON.stringify([r.unit, r.start, r.end]);
|
|
166
|
+
if (!groups.has(k))
|
|
167
|
+
groups.set(k, []);
|
|
168
|
+
groups.get(k).push(r);
|
|
169
|
+
}
|
|
170
|
+
const maxFiled = (g) => g.map((r) => pstr(r.filed)).reduce((m, x) => (x > m ? x : m));
|
|
171
|
+
const ordered = [...groups.values()].sort((a, b) => cmp(maxFiled(b), maxFiled(a)));
|
|
172
|
+
const extra = [];
|
|
173
|
+
let skipped = 0;
|
|
174
|
+
for (const g of ordered) {
|
|
175
|
+
let best = g[0];
|
|
176
|
+
for (const r of g.slice(1))
|
|
177
|
+
if (cmpTuple([pstr(r.filed), pstr(r.accn)], [pstr(best.filed), pstr(best.accn)]) > 0)
|
|
178
|
+
best = r;
|
|
179
|
+
if ([...framed, ...extra].some((f) => f.unit === best.unit && near(f, best)))
|
|
180
|
+
continue;
|
|
181
|
+
const L = length(best.period_days);
|
|
182
|
+
if (L === null || !kinds.has(L)) {
|
|
183
|
+
skipped++;
|
|
184
|
+
continue;
|
|
185
|
+
}
|
|
186
|
+
extra.push(best);
|
|
187
|
+
}
|
|
188
|
+
const out = [...framed, ...extra];
|
|
189
|
+
out.sort((a, b) => cmpTuple([pstr(a.tag), pstr(a.unit), pstr(a.end), pstr(a.start)], [pstr(b.tag), pstr(b.unit), pstr(b.end), pstr(b.start)]));
|
|
190
|
+
return [out, extra.length, skipped];
|
|
191
|
+
}
|
|
192
|
+
function factRows(cik, entity, taxonomy, tag, concept, params, notes = null, name = "") {
|
|
193
|
+
const forms = split(params.forms), unit = unitFor("company_concept", params.unit);
|
|
194
|
+
let rows = [];
|
|
195
|
+
for (const [u, obs] of Object.entries(get(concept, "units") || {})) {
|
|
196
|
+
if (unit && u !== unit)
|
|
197
|
+
continue;
|
|
198
|
+
for (const o of obs) {
|
|
199
|
+
if (forms.length && !forms.some((f) => pyStr(get(o, "form", "")).startsWith(f)))
|
|
200
|
+
continue;
|
|
201
|
+
const d = days(get(o, "start"), get(o, "end"));
|
|
202
|
+
const want = params.duration;
|
|
203
|
+
if (want && !(d !== "" && DURATIONS[want][0] <= d && d <= DURATIONS[want][1]))
|
|
204
|
+
continue;
|
|
205
|
+
rows.push({ cik, entity_name: entity, taxonomy, tag, label: get(concept, "label") || "", unit: u,
|
|
206
|
+
start: get(o, "start", ""), end: get(o, "end", ""), period_days: d, val: get(o, "val"), fy: get(o, "fy", ""),
|
|
207
|
+
fp: get(o, "fp", ""), form: get(o, "form", ""), filed: get(o, "filed", ""), accn: get(o, "accn", ""),
|
|
208
|
+
frame: get(o, "frame", "") });
|
|
209
|
+
}
|
|
210
|
+
}
|
|
211
|
+
if (truthy(params.frames_only)) {
|
|
212
|
+
let restored, skipped;
|
|
213
|
+
[rows, restored, skipped] = onePerPeriod(rows, params.duration);
|
|
214
|
+
if ((restored || skipped) && notes !== null) {
|
|
215
|
+
notes.push(`${name}: ${tag}: ${restored} period(s) with no SEC frame were restored from their latest-filed ` +
|
|
216
|
+
`fact (empty frame column); ${skipped} unframed fact period(s) of another length (e.g. ` +
|
|
217
|
+
"year-to-date) were skipped because they overlap the series. Label periods by end date.");
|
|
218
|
+
}
|
|
219
|
+
}
|
|
220
|
+
return rows;
|
|
221
|
+
}
|
|
222
|
+
function filings(cik, cols, profile) {
|
|
223
|
+
const ks = Object.keys(cols);
|
|
224
|
+
const n = Math.max(0, ...Object.values(cols).filter(Array.isArray).map((v) => v.length));
|
|
225
|
+
const rows = [];
|
|
226
|
+
const num = String(parseInt(cik, 10));
|
|
227
|
+
for (let i = 0; i < n; i++) {
|
|
228
|
+
const r = {};
|
|
229
|
+
for (const k of ks)
|
|
230
|
+
r[k] = Array.isArray(cols[k]) && i < cols[k].length ? cols[k][i] : "";
|
|
231
|
+
const acc = pyStr(get(r, "accessionNumber", ""));
|
|
232
|
+
const doc = r.primaryDocument || "";
|
|
233
|
+
r.url = acc && doc ? `${ARCHIVES}/${num}/${acc.replaceAll("-", "")}/${pyStr(doc)}` : "";
|
|
234
|
+
r.index_url = acc ? `${ARCHIVES}/${num}/${acc.replaceAll("-", "")}/${acc}-index.htm` : "";
|
|
235
|
+
rows.push({ ...profile, ...r });
|
|
236
|
+
}
|
|
237
|
+
return rows;
|
|
238
|
+
}
|
|
239
|
+
function eftsRows(data) {
|
|
240
|
+
const rows = [];
|
|
241
|
+
for (const h of (get(data, "hits") || {}).hits || []) {
|
|
242
|
+
const s = get(h, "_source") || {};
|
|
243
|
+
const id = pyStr(get(h, "_id", ""));
|
|
244
|
+
const adsh = get(s, "adsh") || id.split(":")[0];
|
|
245
|
+
const fname = id.includes(":") ? id.slice(id.indexOf(":") + 1) : "";
|
|
246
|
+
const ciks = get(s, "ciks") || [];
|
|
247
|
+
const first = ciks.length && isDigits(pyStr(ciks[0])) ? String(parseInt(pyStr(ciks[0]), 10)) : "";
|
|
248
|
+
rows.push({ adsh, form: get(s, "form", ""), file_date: get(s, "file_date", ""), period_ending: get(s, "period_ending") || "",
|
|
249
|
+
file_type: get(s, "file_type") || "", file_description: get(s, "file_description") || "",
|
|
250
|
+
display_names: (get(s, "display_names") || []).join("; "), ciks: ciks.join("; "),
|
|
251
|
+
sics: (get(s, "sics") || []).join("; "), biz_states: (get(s, "biz_states") || []).join("; "),
|
|
252
|
+
items: (get(s, "items") || []).join("; "),
|
|
253
|
+
url: first && fname ? `${ARCHIVES}/${first}/${pyStr(adsh).replaceAll("-", "")}/${fname}` : "" });
|
|
254
|
+
}
|
|
255
|
+
return rows;
|
|
256
|
+
}
|
|
257
|
+
async function eftsAll(c, q, limit) {
|
|
258
|
+
let rows = [];
|
|
259
|
+
let start = 0;
|
|
260
|
+
let total = null;
|
|
261
|
+
while (rows.length < limit && start < 10000) {
|
|
262
|
+
const data = await c.getJson(EFTS, start ? { ...q, from: start } : q);
|
|
263
|
+
const t = (get(data, "hits") || {}).total || {};
|
|
264
|
+
total = t && typeof t === "object" && !Array.isArray(t) ? get(t, "value") : t;
|
|
265
|
+
const got = eftsRows(data);
|
|
266
|
+
rows = rows.concat(got);
|
|
267
|
+
if (got.length < 100)
|
|
268
|
+
break;
|
|
269
|
+
start += got.length;
|
|
270
|
+
}
|
|
271
|
+
return [rows.slice(0, limit), total];
|
|
272
|
+
}
|
|
273
|
+
function checkSpec(spec) {
|
|
274
|
+
const probs = [];
|
|
275
|
+
for (const r of spec.requests || []) {
|
|
276
|
+
const p = r.params || {}, n = pyRepr(r.name), ep = r.endpoint;
|
|
277
|
+
if (ep && CO_EPS.includes(ep) && !(p.cik || p.ticker))
|
|
278
|
+
probs.push(`request ${n}: ${ep} needs params.cik or params.ticker`);
|
|
279
|
+
if (ep === "frames" && p.period && !/^CY\d{4}(Q[1-4]I?)?$/.test(pyStr(p.period))) {
|
|
280
|
+
probs.push(`request ${n}: period must look like CY2023, CY2023Q1 or CY2023Q4I`);
|
|
281
|
+
}
|
|
282
|
+
if (p.duration && !(p.duration in DURATIONS))
|
|
283
|
+
probs.push(`request ${n}: duration must be annual or quarter`);
|
|
284
|
+
}
|
|
285
|
+
return probs;
|
|
286
|
+
}
|
|
287
|
+
const noNone = (rows) => rows.map((row) => Object.fromEntries(Object.entries(row).map(([k, v]) => [k, v === null || v === undefined ? "" : v])));
|
|
288
|
+
async function fetch(spec, pack, _route) {
|
|
289
|
+
const c = client(pack);
|
|
290
|
+
const tables = {};
|
|
291
|
+
const notes = [];
|
|
292
|
+
const miss = new gr.Misses();
|
|
293
|
+
for (const r of spec.requests) {
|
|
294
|
+
const [ep, params, probs] = gr.resolve(pack, r);
|
|
295
|
+
if (probs.length)
|
|
296
|
+
throw new DataError(probs.join("; "), "bad_request");
|
|
297
|
+
const P = params;
|
|
298
|
+
const kind = r.endpoint, name = r.name;
|
|
299
|
+
const limit = Number(r.max_rows || ep.max_rows || 100000);
|
|
300
|
+
let rows;
|
|
301
|
+
try {
|
|
302
|
+
if (kind === "company_search")
|
|
303
|
+
rows = await lookup(c, pyStr(P.text), 20);
|
|
304
|
+
else if (kind === "submissions") {
|
|
305
|
+
const cik = await resolveCik(c, P);
|
|
306
|
+
const d = await c.getJson(`/submissions/CIK${cik}.json`);
|
|
307
|
+
const prof = { cik, entity_name: get(d, "name", ""), sic: get(d, "sic", ""), sic_description: get(d, "sicDescription", ""),
|
|
308
|
+
tickers: (get(d, "tickers") || []).join("; ") };
|
|
309
|
+
rows = filings(cik, (get(d, "filings") || {}).recent || {}, prof);
|
|
310
|
+
const older = (get(d, "filings") || {}).files || [];
|
|
311
|
+
if (truthy(P.all)) {
|
|
312
|
+
for (const f of older)
|
|
313
|
+
rows = rows.concat(filings(cik, await c.getJson(`/submissions/${f.name}`), prof));
|
|
314
|
+
}
|
|
315
|
+
else if (older.length) {
|
|
316
|
+
notes.push(`${name}: older filings are in ${older.length} more file(s); set params.all=true to include them.`);
|
|
317
|
+
}
|
|
318
|
+
const forms = split(P.forms), since = P.since;
|
|
319
|
+
if (forms.length)
|
|
320
|
+
rows = rows.filter((x) => forms.includes(x.form));
|
|
321
|
+
if (since)
|
|
322
|
+
rows = rows.filter((x) => pyStr(get(x, "filingDate", "")) >= since);
|
|
323
|
+
}
|
|
324
|
+
else if (kind === "company_concept") {
|
|
325
|
+
const cik = await resolveCik(c, P);
|
|
326
|
+
const tax = P.taxonomy || "us-gaap";
|
|
327
|
+
const d = await c.getJson(`/api/xbrl/companyconcept/CIK${cik}/${tax}/${P.tag}.json`);
|
|
328
|
+
rows = factRows(cik, get(d, "entityName", ""), tax, get(d, "tag", P.tag), d, P, notes, name);
|
|
329
|
+
}
|
|
330
|
+
else if (kind === "company_facts") {
|
|
331
|
+
const cik = await resolveCik(c, P);
|
|
332
|
+
const d = await c.getJson(`/api/xbrl/companyfacts/CIK${cik}.json`);
|
|
333
|
+
const tags = new Set(split(P.tags)), taxOnly = P.taxonomy;
|
|
334
|
+
rows = [];
|
|
335
|
+
for (const [tax, concepts] of Object.entries(get(d, "facts") || {})) {
|
|
336
|
+
if (taxOnly && tax !== taxOnly)
|
|
337
|
+
continue;
|
|
338
|
+
for (const [tag, concept] of Object.entries(concepts)) {
|
|
339
|
+
if (tags.size && !tags.has(tag))
|
|
340
|
+
continue;
|
|
341
|
+
rows = rows.concat(factRows(cik, get(d, "entityName", ""), tax, tag, concept, P, notes, name));
|
|
342
|
+
}
|
|
343
|
+
}
|
|
344
|
+
const got = new Set(rows.map((x) => x.tag));
|
|
345
|
+
const missing = [...tags].filter((t) => !got.has(t)).sort(cmp);
|
|
346
|
+
if (missing.length)
|
|
347
|
+
notes.push(`${name}: not reported by this company (or filtered out): ${missing.join(", ")}`);
|
|
348
|
+
}
|
|
349
|
+
else if (kind === "frames") {
|
|
350
|
+
const tax = P.taxonomy || "us-gaap", unit = unitFor("frames", P.unit || "USD");
|
|
351
|
+
const d = await c.getJson(`/api/xbrl/frames/${tax}/${P.tag}/${unit}/${P.period}.json`);
|
|
352
|
+
const base = { taxonomy: tax, tag: get(d, "tag", P.tag), unit: get(d, "uom", unit), period: get(d, "ccp", P.period) };
|
|
353
|
+
rows = (get(d, "data") || []).map((x) => ({ ...base, ...x }));
|
|
354
|
+
}
|
|
355
|
+
else if (kind === "full_text_search") {
|
|
356
|
+
const q = Object.fromEntries(["q", "forms", "startdt", "enddt", "ciks"].filter((k) => P[k]).map((k) => [k, P[k]]));
|
|
357
|
+
let total;
|
|
358
|
+
[rows, total] = await eftsAll(c, q, limit);
|
|
359
|
+
if (total && total > rows.length) {
|
|
360
|
+
notes.push(`${name}: ${fmt(rows.length)} of ${fmt(Number(total))}${total >= 10000 ? "+" : ""} matching documents; ` +
|
|
361
|
+
"narrow the dates or forms (the index returns at most 10,000).");
|
|
362
|
+
}
|
|
363
|
+
}
|
|
364
|
+
else if (kind === "insider_filings") {
|
|
365
|
+
const cik = await resolveCik(c, P);
|
|
366
|
+
const q = { forms: P.forms || "4", ciks: cik };
|
|
367
|
+
for (const k of ["startdt", "enddt"])
|
|
368
|
+
if (P[k])
|
|
369
|
+
q[k] = P[k];
|
|
370
|
+
const [docs] = await eftsAll(c, q, limit);
|
|
371
|
+
rows = [];
|
|
372
|
+
const num = String(parseInt(cik, 10));
|
|
373
|
+
for (const x of docs) {
|
|
374
|
+
const cks = String(x.ciks).split("; "), names = String(x.display_names).split("; ");
|
|
375
|
+
const j = cks.findIndex((v) => v !== cik);
|
|
376
|
+
const i = j < 0 ? null : j;
|
|
377
|
+
rows.push({ issuer_cik: cik, form: x.form, file_date: x.file_date, period_ending: x.period_ending,
|
|
378
|
+
insider: i !== null && i < names.length ? names[i].replace(/\s*\(CIK \d+\)\s*$/, "").trim() : "",
|
|
379
|
+
insider_cik: i !== null ? cks[i] : "", adsh: x.adsh,
|
|
380
|
+
index_url: `${ARCHIVES}/${num}/${pyStr(x.adsh).replaceAll("-", "")}/${x.adsh}-index.htm` });
|
|
381
|
+
}
|
|
382
|
+
rows.sort((a, b) => cmp(pyStr(b.file_date), pyStr(a.file_date)));
|
|
383
|
+
}
|
|
384
|
+
else
|
|
385
|
+
throw new DataError(`unknown endpoint ${pyRepr(kind ?? null)}`, "bad_request");
|
|
386
|
+
}
|
|
387
|
+
catch (e) {
|
|
388
|
+
if (!(e instanceof DataError))
|
|
389
|
+
throw e;
|
|
390
|
+
if (e.kind !== "not_found")
|
|
391
|
+
throw new DataError(`request ${pyRepr(name)} (${kind}): ${e.message}`, e.kind, e.status);
|
|
392
|
+
miss.notFound(r, tables, notes); // one unknown tag or CIK must not stop the other requests
|
|
393
|
+
continue;
|
|
394
|
+
}
|
|
395
|
+
if (rows.length > limit) {
|
|
396
|
+
notes.push(`${name}: stopped at ${fmt(limit)} of ${fmt(rows.length)} rows (max_rows).`);
|
|
397
|
+
rows = rows.slice(0, limit);
|
|
398
|
+
}
|
|
399
|
+
if (kind === "company_search" && !rows.length) { // no match is an answer, not a spec error: keep the others
|
|
400
|
+
notes.push(`${name}: no SEC filer matched ${pyRepr(P.text)} (EDGAR company search); kept as an empty ` +
|
|
401
|
+
"table. Try a shorter or former name or the ticker; a company that files nothing with the " +
|
|
402
|
+
"SEC (private, or foreign without U.S. listings) has no record.");
|
|
403
|
+
}
|
|
404
|
+
else
|
|
405
|
+
miss.checkEmpty(r, rows);
|
|
406
|
+
tables[name] = noNone(rows);
|
|
407
|
+
}
|
|
408
|
+
miss.raiseIfAny("SEC has no such tag for that company or no such CIK (tags are case-sensitive). " +
|
|
409
|
+
"To see which of several tags a company reports, ask company_facts with \"tags\": it notes the " +
|
|
410
|
+
"unreported ones instead of failing", "check the tag (case-sensitive), unit, forms filter or period (see source.md)");
|
|
411
|
+
return [tables, notes];
|
|
412
|
+
}
|
|
413
|
+
// ---------------------------------------------------------------------- manual route
|
|
414
|
+
/** data.sec.gov and efts JSON links; a browser sends its own User-Agent, which SEC accepts. */
|
|
415
|
+
function manualItems(spec, _pack) {
|
|
416
|
+
const items = [];
|
|
417
|
+
for (const r of spec.requests || []) {
|
|
418
|
+
const p = r.params || {}, kind = r.endpoint, name = r.name;
|
|
419
|
+
let cik = null;
|
|
420
|
+
if (p.cik || /^\d{1,10}$/.test(pyStr(p.ticker || "")))
|
|
421
|
+
cik = pad(p.cik || p.ticker);
|
|
422
|
+
let url = null, note = "";
|
|
423
|
+
const tax = p.taxonomy || "us-gaap";
|
|
424
|
+
if (kind === "submissions" && cik)
|
|
425
|
+
url = `https://data.sec.gov/submissions/CIK${cik}.json`;
|
|
426
|
+
else if (kind === "company_concept" && cik && p.tag)
|
|
427
|
+
url = `https://data.sec.gov/api/xbrl/companyconcept/CIK${cik}/${tax}/${p.tag}.json`;
|
|
428
|
+
else if (kind === "company_facts" && cik)
|
|
429
|
+
url = `https://data.sec.gov/api/xbrl/companyfacts/CIK${cik}.json`;
|
|
430
|
+
else if (kind === "frames" && p.tag && p.period) {
|
|
431
|
+
url = `https://data.sec.gov/api/xbrl/frames/${tax}/${p.tag}/${unitFor("frames", p.unit || "USD")}/${p.period}.json`;
|
|
432
|
+
}
|
|
433
|
+
else if (kind === "full_text_search" || kind === "company_search" || kind === "insider_filings") {
|
|
434
|
+
const q = kind === "company_search" ? { keysTyped: get(p, "text", "") }
|
|
435
|
+
: Object.fromEntries(["q", "forms", "startdt", "enddt", "ciks"].filter((k) => p[k]).map((k) => [k, p[k]]));
|
|
436
|
+
if (kind === "insider_filings" && cik)
|
|
437
|
+
Object.assign(q, { forms: p.forms || "4", ciks: cik });
|
|
438
|
+
url = EFTS + "?" + pyUrlencode(q);
|
|
439
|
+
note = "first 100 hits; add &from=100, &from=200 ... for more";
|
|
440
|
+
}
|
|
441
|
+
if (kind && CO_EPS.includes(kind) && !cik) {
|
|
442
|
+
note = "look up the CIK first (https://www.sec.gov/edgar/searchedgar/companysearch) and put it in params.cik";
|
|
443
|
+
}
|
|
444
|
+
if (url)
|
|
445
|
+
items.push({ name: `${name}#1`, request: name, url, filename: `${name}.json`, needs_key: false, note });
|
|
446
|
+
}
|
|
447
|
+
return items;
|
|
448
|
+
}
|
|
449
|
+
function parseUpload(pack, req, files) {
|
|
450
|
+
const [, params] = gr.resolve(pack, req);
|
|
451
|
+
const P = params;
|
|
452
|
+
const kind = req.endpoint;
|
|
453
|
+
let rows = [];
|
|
454
|
+
for (const f of [...files].sort(cmp)) {
|
|
455
|
+
const d = parsePyJson(fs.readFileSync(f, "utf8").replace(/^\ufeff/, ""));
|
|
456
|
+
if (kind === "submissions") {
|
|
457
|
+
const cik = pad(get(d, "cik") || P.cik);
|
|
458
|
+
const prof = { cik, entity_name: get(d, "name", ""), sic: get(d, "sic", ""), sic_description: get(d, "sicDescription", ""),
|
|
459
|
+
tickers: (get(d, "tickers") || []).join("; ") };
|
|
460
|
+
const recent = "filings" in d ? (get(d, "filings") || {}).recent : d;
|
|
461
|
+
rows = rows.concat(filings(cik, recent || {}, prof));
|
|
462
|
+
}
|
|
463
|
+
else if (kind === "company_concept") {
|
|
464
|
+
rows = rows.concat(factRows(pad(get(d, "cik")), get(d, "entityName", ""), get(d, "taxonomy", ""), get(d, "tag", ""), d, P));
|
|
465
|
+
}
|
|
466
|
+
else if (kind === "company_facts") {
|
|
467
|
+
const tags = new Set(split(P.tags));
|
|
468
|
+
for (const [tax, concepts] of Object.entries(get(d, "facts") || {})) {
|
|
469
|
+
for (const [tag, concept] of Object.entries(concepts)) {
|
|
470
|
+
if (!tags.size || tags.has(tag))
|
|
471
|
+
rows = rows.concat(factRows(pad(get(d, "cik")), get(d, "entityName", ""), tax, tag, concept, P));
|
|
472
|
+
}
|
|
473
|
+
}
|
|
474
|
+
}
|
|
475
|
+
else if (kind === "frames") {
|
|
476
|
+
const base = { taxonomy: get(d, "taxonomy", ""), tag: get(d, "tag", ""), unit: get(d, "uom", ""), period: get(d, "ccp", "") };
|
|
477
|
+
rows = rows.concat((get(d, "data") || []).map((x) => ({ ...base, ...x })));
|
|
478
|
+
}
|
|
479
|
+
else if (kind === "company_search") {
|
|
480
|
+
rows = rows.concat(((get(d, "hits") || {}).hits || []).map((h) => ({ cik: pyStr(get(h, "_id", "")).padStart(10, "0"),
|
|
481
|
+
entity: get(get(h, "_source") || {}, "entity", ""), tickers: get(get(h, "_source") || {}, "tickers", "") })));
|
|
482
|
+
}
|
|
483
|
+
else
|
|
484
|
+
rows = rows.concat(eftsRows(d));
|
|
485
|
+
}
|
|
486
|
+
return noNone(rows);
|
|
487
|
+
}
|
|
488
|
+
/** Common XBRL concepts (endpoints.json "concepts") plus the endpoint descriptions. */
|
|
489
|
+
function search(query, pack, limit = 20) {
|
|
490
|
+
const words = (query.toLowerCase().match(/[a-z0-9]+/g) || []).filter((w) => w.length > 1);
|
|
491
|
+
const hits = [];
|
|
492
|
+
for (const [tag, desc] of Object.entries(pack.endpoints?.concepts || {})) {
|
|
493
|
+
const text = `${tag} ${desc}`.toLowerCase();
|
|
494
|
+
const s = words.reduce((n, w) => n + text.split(w).length - 1, 0);
|
|
495
|
+
if (s)
|
|
496
|
+
hits.push([s, { tag, description: desc }]);
|
|
497
|
+
}
|
|
498
|
+
const out = [...hits].sort((a, b) => b[0] - a[0]).map(([, h]) => h).concat(gr.searchCatalog(pack, query, limit));
|
|
499
|
+
return out.slice(0, limit);
|
|
500
|
+
}
|
|
501
|
+
const adapter = { checkError, checkSpec, fetch, manualItems, parseUpload, search, userAgent, unitFor, onePerPeriod, days,
|
|
502
|
+
DEFAULT_UA };
|
|
503
|
+
export default adapter;
|
|
504
|
+
//# sourceMappingURL=sec.js.map
|