Merge pull request #560 from cmu-delphi/sgratzl/js-client2

sgratzl · web-flow · commit 2e8aa8d207a3 · 2021-05-27T19:13:05.000+02:00
add all endpoints to JS client
diff --git a/.gitignore b/.gitignore
@@ -5,4 +5,5 @@ __pycache__/
 /.env
 *.db
 /build
-/node_modules
+/node_modules
+.mypy_cache
diff --git a/docs/api/client_libraries.md b/docs/api/client_libraries.md
@@ -24,7 +24,7 @@ For anyone looking for COVIDCast data, please visit our [COVIDCast Libraries](co
 <script src="delphi_epidata.js"></script>
 <!-- Fetch data -->
 <script>
-  EpidataAsync.covidcast('fb-survey', 'smoothed_cli', 'day', 'county', [20200401, Epidata.range(20200405, 20200414)], '06001').then((res) => {
+  EpidataAsync.covidcast('fb-survey', 'smoothed_cli', 'day', 'county', [20200401, EpidataAsync.range(20200405, 20200414)], '06001').then((res) => {
     console.log(res.result, res.message, res.epidata != null ? res.epidata.length : 0);
   });
 </script>
diff --git a/docs/api/flusurv.md b/docs/api/flusurv.md
@@ -115,7 +115,7 @@ The following samples show how to import the library and fetch CA FluView Clinic
 <script src="delphi_epidata.js"></script>
 <!-- Fetch data -->
 <script>
-  EpidataAsync.flusurv(['ca'], [201940, Epidata.range(202001, 202010)]).then((res) => {
+  EpidataAsync.flusurv('ca', [201940, Epidata.range(202001, 202010)]).then((res) => {
     console.log(res.result, res.message, res.epidata != null ? res.epidata.length : 0);
   });
 </script>
diff --git a/docs/api/fluview.md b/docs/api/fluview.md
@@ -131,7 +131,7 @@ The following samples show how to import the library and fetch national FluView
 <script src="delphi_epidata.js"></script>
 <!-- Fetch data -->
 <script>
-  EpidataAsync.fluview(['nat'], [201440, Epidata.range(201501, 201510)]).then((res) => {
+  EpidataAsync.fluview('nat', [201440, EpidataAsync.range(201501, 201510)]).then((res) => {
     console.log(res.result, res.message, res.epidata != null ? res.epidata.length : 0);
   });
 </script>
diff --git a/docs/api/fluview_clinical.md b/docs/api/fluview_clinical.md
@@ -104,7 +104,7 @@ The following samples show how to import the library and fetch national FluView
 <script src="delphi_epidata.js"></script>
 <!-- Fetch data -->
 <script>
-  EpidataAsync.fluview_clinical(['nat'], [201940, Epidata.range(202001, 202010)]).then((res) => {
+  EpidataAsync.fluview_clinical('nat', [201940, EpidataAsync.range(202001, 202010)]).then((res) => {
     console.log(res.result, res.message, res.epidata != null ? res.epidata.length : 0);
   });
 </script>
diff --git a/docs/api/gft.md b/docs/api/gft.md
@@ -79,7 +79,7 @@ The following samples show how to import the library and fetch Google Flu Trends
 <script src="delphi_epidata.js"></script>
 <!-- Fetch data -->
 <script>
-  EpidataAsync.gft(['nat'], [201440, Epidata.range(201501, 201510)]).then((res) => {
+  EpidataAsync.gft('nat', [201440, EpidataAsync.range(201501, 201510)]).then((res) => {
     console.log(res.result, res.message, res.epidata != null ? res.epidata.length : 0);
   });
 </script>
diff --git a/docs/api/nidss_dengue.md b/docs/api/nidss_dengue.md
@@ -79,7 +79,7 @@ The following samples show how to import the library and fetch national NIDSS De
 <script src="delphi_epidata.js"></script>
 <!-- Fetch data -->
 <script>
-  EpidataAsync.nidss_dengue(['nationwide'], [201440, Epidata.range(201501, 201510)]).then((res) => {
+  EpidataAsync.nidss_dengue('nationwide', [201440, EpidataAsync.range(201501, 201510)]).then((res) => {
     console.log(res.result, res.message, res.epidata != null ? res.epidata.length : 0);
   });
 </script>
diff --git a/docs/api/nidss_flu.md b/docs/api/nidss_flu.md
@@ -100,7 +100,7 @@ The following samples show how to import the library and fetch national NIDSS Fl
 <script src="delphi_epidata.js"></script>
 <!-- Fetch data -->
 <script>
-  EpidataAsync.nidss_flu(['nationwide'], [201440, Epidata.range(201501, 201510)]).then((res) => {
+  EpidataAsync.nidss_flu('nationwide', [201440, EpidataAsync.range(201501, 201510)]).then((res) => {
     console.log(res.result, res.message, res.epidata != null ? res.epidata.length : 0);
   });;
 </script>
diff --git a/docs/api/nowcast.md b/docs/api/nowcast.md
@@ -83,7 +83,7 @@ The following samples show how to import the library and fetch national ILI Near
 <script src="delphi_epidata.js"></script>
 <!-- Fetch data -->
 <script>
-  EpidataAsync.nowcast(['nat'], [201940, Epidata.range(202001, 202010)]).then((res) => {
+  EpidataAsync.nowcast('nat', [201940, EpidataAsync.range(202001, 202010)]).then((res) => {
     console.log(res.result, res.message, res.epidata != null ? res.epidata.length : 0);
   });
 </script>
diff --git a/docs/api/sensors.md b/docs/api/sensors.md
@@ -100,7 +100,7 @@ The following samples show how to import the library and fetch national Delphi's
 <script src="delphi_epidata.js"></script>
 <!-- Fetch data -->
 <script>
-  EpidataAsync.sensors(['nat'], ['sar3'], [201940, Epidata.range(202001, 202010)]).then((res) => {
+  EpidataAsync.sensors('nat', 'sar3', [201940, EpidataAsync.range(202001, 202010)]).then((res) => {
     console.log(res.result, res.message, res.epidata != null ? res.epidata.length : 0);
   });
 </script>
diff --git a/docs/api/wiki.md b/docs/api/wiki.md
@@ -120,7 +120,7 @@ epiweeks `201940` and `202001-202010` (11 weeks total) for hours 0 and 12 in Eng
 <script src="delphi_epidata.js"></script>
 <!-- Fetch data -->
 <script>
-  EpidataAsync.wiki(['influenza'], null, [201940, Epidata.range(202001, 202010)], [0, 12]).then((res) => {
+  EpidataAsync.wiki('influenza', null, [201940, Epidata.EpidataAsync(202001, 202010)], [0, 12]).then((res) => {
     console.log(res.result, res.message, res.epidata != null ? res.epidata.length : 0);
   });
 </script>
diff --git a/src/client/delphi_epidata.d.ts b/src/client/delphi_epidata.d.ts
@@ -15,62 +15,78 @@ declare module 'delphi_epidata' {
 
     export interface EpidataFunctions {
         readonly BASE_URL: string;
-        withURL(baseUrl?: string): EpidataFunctions;
+        range(this: void, from: string | number, to: string | number): EpiRange;
+        withURL(this: void, baseUrl?: string): EpidataFunctions;
 
+        afhsb(callback: EpiDataCallback, auth: string, locations: StringParam, epiweeks: EpiRangeParam, flu_types: StringParam): Promise<EpiDataResponse>;
+        cdc(callback: EpiDataCallback, auth: string, epiweeks: EpiRangeParam, locations: StringParam): Promise<EpiDataResponse>;
+        covid_hosp_facility(callback: EpiDataCallback, hospital_pks: StringParam, collection_weeks: EpiRangeParam, publication_dates: EpiRangeParam): Promise<EpiDataResponse>;
+        covid_hosp_facility_lookup(callback: EpiDataCallback, state?: string, ccn?: string, city?: string, zip?: string, fips_code?: string): Promise<EpiDataResponse>;
+        // alias to covid_hosp_state_timeseries
+        covid_hosp(callback: EpiDataCallback, states: StringParam, dates: EpiRangeParam, issues: EpiRangeParam): Promise<EpiDataResponse>;
+        covid_hosp_state_timeseries(callback: EpiDataCallback, states: StringParam, dates: EpiRangeParam, issues: EpiRangeParam): Promise<EpiDataResponse>;
+        covidcast_meta(callback: EpiDataCallback): Promise<EpiDataResponse>;
+        covidcast_nowcast(callback: EpiDataCallback, data_source: string, signals: string, time_type: 'day' | 'week', geo_type: string, time_values: EpiRangeParam, as_of?: number, issues?: EpiRangeParam, format?: 'json' | 'tree' | 'classic' | 'csv'): Promise<EpiDataResponse>;
+        covidcast(callback: EpiDataCallback, data_source: string, signals: string, time_type: 'day' | 'week', geo_type: string, time_values: EpiRangeParam, as_of?: number, issues?: EpiRangeParam, format?: 'json' | 'tree' | 'classic' | 'csv'): Promise<EpiDataResponse>;
         fluview(callback: EpiDataCallback, regions: StringParam, epiweeks: EpiRangeParam, issues?: EpiRangeParam, lag?: number, auth?: string): Promise<EpiDataResponse>;
-        fluview_meta(callback: EpiDataCallback): Promise<EpiDataResponse>;
         fluview_clinical(callback: EpiDataCallback, regions: StringParam, epiweeks: EpiRangeParam, issues?: EpiRangeParam, lag?: number): Promise<EpiDataResponse>;
+        fluview_meta(callback: EpiDataCallback): Promise<EpiDataResponse>;
         flusurv(callback: EpiDataCallback, locations: StringParam, epiweeks: EpiRangeParam, issues?: EpiRangeParam, lag?: number): Promise<EpiDataResponse>;
         gft(callback: EpiDataCallback, locations: StringParam, epiweeks: EpiRangeParam): Promise<EpiDataResponse>;
         ght(callback: EpiDataCallback, auth: string, locations: StringParam, epiweeks: EpiRangeParam, query: string): Promise<EpiDataResponse>;
-        cdc(callback: EpiDataCallback, auth: string, epiweeks: EpiRangeParam, locations: StringParam): Promise<EpiDataResponse>;
-        quidel(callback: EpiDataCallback, auth: string, epiweeks: EpiRangeParam, locations: StringParam): Promise<EpiDataResponse>;
-        norostat(callback: EpiDataCallback, auth: string, location: string, epiweeks: EpiRangeParam): Promise<EpiDataResponse>;
-        meta_norostat(callback: EpiDataCallback, auth: string): Promise<EpiDataResponse>;
-        afhsb(callback: EpiDataCallback, auth: string, locations: StringParam, epiweeks: EpiRangeParam, flu_types: StringParam): Promise<EpiDataResponse>;
+        kcdc_ili(callback: EpiDataCallback, regions: StringParam, epiweeks: EpiRangeParam, issues?: EpiRangeParam, lag?: number): Promise<EpiDataResponse>;
         meta_afhsb(callback: EpiDataCallback, auth: string): Promise<EpiDataResponse>;
-        nidss_flu(callback: EpiDataCallback, regions: StringParam, epiweeks: EpiRangeParam, issues?: EpiRangeParam, lag?: number): Promise<EpiDataResponse>;
+        meta_norostat(callback: EpiDataCallback, auth: string): Promise<EpiDataResponse>;
+        meta(callback: EpiDataCallback): Promise<EpiDataResponse>;
         nidss_dengue(callback: EpiDataCallback, locations: StringParam, epiweeks: EpiRangeParam): Promise<EpiDataResponse>;
+        nidss_flu(callback: EpiDataCallback, regions: StringParam, epiweeks: EpiRangeParam, issues?: EpiRangeParam, lag?: number): Promise<EpiDataResponse>;
+        norostat(callback: EpiDataCallback, auth: string, location: string, epiweeks: EpiRangeParam): Promise<EpiDataResponse>;
+        nowcast(callback: EpiDataCallback, locations: StringParam, epiweeks: EpiRangeParam): Promise<EpiDataResponse>;
+        paho_dengue(callback: EpiDataCallback, regions: StringParam, epiweeks: EpiRangeParam, issues?: EpiRangeParam, lag?: number): Promise<EpiDataResponse>;
+        quidel(callback: EpiDataCallback, auth: string, epiweeks: EpiRangeParam, locations: StringParam): Promise<EpiDataResponse>;
         delphi(callback: EpiDataCallback, system: string, epiweek: string | number): Promise<EpiDataResponse>;
         sensors(callback: EpiDataCallback, auth: string, names: StringParam, locations: StringParam, epiweeks: EpiRangeParam): Promise<EpiDataResponse>;
-        nowcast(callback: EpiDataCallback, locations: StringParam, epiweeks: EpiRangeParam): Promise<EpiDataResponse>;
-        meta(callback: EpiDataCallback): Promise<EpiDataResponse>;
-        covidcast(callback: EpiDataCallback, data_source: string, signals: string, time_type: 'day' | 'week', geo_type: string, time_values: EpiRangeParam, as_of?: number, issues?: EpiRangeParam, format?: 'json' | 'tree' | 'classic' | 'csv'): Promise<EpiDataResponse>;
-        covidcast_meta(callback: EpiDataCallback): Promise<EpiDataResponse>;
-        covid_hosp(callback: EpiDataCallback, states: StringParam, dates: EpiRangeParam, issues: EpiRangeParam): Promise<EpiDataResponse>;
-        covid_hosp_facility(callback: EpiDataCallback, hospital_pks: StringParam, collection_weeks: EpiRangeParam, publication_dates: EpiRangeParam): Promise<EpiDataResponse>;
-        covid_hosp_facility_lookup(callback: EpiDataCallback, state?: string, ccn?: string, city?: string, zip?: string, fips_code?: string): Promise<EpiDataResponse>;
+        twitter(callback: EpiDataCallback, auth: string, locations: StringParam, dates?: EpiRangeParam, epiweeks?: EpiRangeParam): Promise<EpiDataResponse>;
+        wiki(callback: EpiDataCallback, articles: StringParam, dates?: EpiRangeParam,  epiweeks: EpiRangeParam, language?: string = 'en'): Promise<EpiDataResponse>;
     }
 
     export const Epidata: EpidataFunctions;
 
     export interface EpidataAsyncFunctions {
         readonly BASE_URL: string;
-        withURL(baseUrl?: string): EpidataAsyncFunctions;
+        range(this: void, from: string | number, to: string | number): EpiRange;
+        withURL(this: void, baseUrl?: string): EpidataAsyncFunctions;
 
+        afhsb(auth: string, locations: StringParam, epiweeks: EpiRangeParam, flu_types: StringParam): Promise<EpiDataResponse>;
+        cdc(auth: string, epiweeks: EpiRangeParam, locations: StringParam): Promise<EpiDataResponse>;
+        covid_hosp_facility(hospital_pks: StringParam, collection_weeks: EpiRangeParam, publication_dates: EpiRangeParam): Promise<EpiDataResponse>;
+        covid_hosp_facility_lookup(state?: string, ccn?: string, city?: string, zip?: string, fips_code?: string): Promise<EpiDataResponse>;
+        // alias to covid_hosp_state_timeseries
+        covid_hosp(states: StringParam, dates: EpiRangeParam, issues: EpiRangeParam): Promise<EpiDataResponse>;
+        covid_hosp_state_timeseries(states: StringParam, dates: EpiRangeParam, issues: EpiRangeParam): Promise<EpiDataResponse>;
+        covidcast_meta(callback: EpiDataCallback): Promise<EpiDataResponse>;
+        covidcast_nowcast(data_source: string, signals: string, time_type: 'day' | 'week', geo_type: string, time_values: EpiRangeParam, as_of?: number, issues?: EpiRangeParam, format?: 'json' | 'tree' | 'classic' | 'csv'): Promise<EpiDataResponse>;
+        covidcast(data_source: string, signals: string, time_type: 'day' | 'week', geo_type: string, time_values: EpiRangeParam, as_of?: number, issues?: EpiRangeParam, format?: 'json' | 'tree' | 'classic' | 'csv'): Promise<EpiDataResponse>;
         fluview(regions: StringParam, epiweeks: EpiRangeParam, issues?: EpiRangeParam, lag?: number, auth?: string): Promise<EpiDataResponse>;
-        fluview_meta(): Promise<EpiDataResponse>;
         fluview_clinical(regions: StringParam, epiweeks: EpiRangeParam, issues?: EpiRangeParam, lag?: number): Promise<EpiDataResponse>;
+        fluview_meta(callback: EpiDataCallback): Promise<EpiDataResponse>;
         flusurv(locations: StringParam, epiweeks: EpiRangeParam, issues?: EpiRangeParam, lag?: number): Promise<EpiDataResponse>;
         gft(locations: StringParam, epiweeks: EpiRangeParam): Promise<EpiDataResponse>;
         ght(auth: string, locations: StringParam, epiweeks: EpiRangeParam, query: string): Promise<EpiDataResponse>;
-        cdc(auth: string, epiweeks: EpiRangeParam, locations: StringParam): Promise<EpiDataResponse>;
-        quidel(auth: string, epiweeks: EpiRangeParam, locations: StringParam): Promise<EpiDataResponse>;
-        norostat(auth: string, location: string, epiweeks: EpiRangeParam): Promise<EpiDataResponse>;
-        meta_norostat(auth: string): Promise<EpiDataResponse>;
-        afhsb(auth: string, locations: StringParam, epiweeks: EpiRangeParam, flu_types: StringParam): Promise<EpiDataResponse>;
+        kcdc_ili(regions: StringParam, epiweeks: EpiRangeParam, issues?: EpiRangeParam, lag?: number): Promise<EpiDataResponse>;
         meta_afhsb(auth: string): Promise<EpiDataResponse>;
-        nidss_flu(regions: StringParam, epiweeks: EpiRangeParam, issues?: EpiRangeParam, lag?: number): Promise<EpiDataResponse>;
+        meta_norostat(auth: string): Promise<EpiDataResponse>;
+        meta(callback: EpiDataCallback): Promise<EpiDataResponse>;
         nidss_dengue(locations: StringParam, epiweeks: EpiRangeParam): Promise<EpiDataResponse>;
+        nidss_flu(regions: StringParam, epiweeks: EpiRangeParam, issues?: EpiRangeParam, lag?: number): Promise<EpiDataResponse>;
+        norostat(auth: string, location: string, epiweeks: EpiRangeParam): Promise<EpiDataResponse>;
+        nowcast(locations: StringParam, epiweeks: EpiRangeParam): Promise<EpiDataResponse>;
+        paho_dengue(regions: StringParam, epiweeks: EpiRangeParam, issues?: EpiRangeParam, lag?: number): Promise<EpiDataResponse>;
+        quidel(auth: string, epiweeks: EpiRangeParam, locations: StringParam): Promise<EpiDataResponse>;
         delphi(system: string, epiweek: string | number): Promise<EpiDataResponse>;
         sensors(auth: string, names: StringParam, locations: StringParam, epiweeks: EpiRangeParam): Promise<EpiDataResponse>;
-        nowcast(locations: StringParam, epiweeks: EpiRangeParam): Promise<EpiDataResponse>;
-        meta(): Promise<EpiDataResponse>;
-        covidcast(data_source: string, signals: string, time_type: 'day' | 'week', geo_type: string, time_values: EpiRangeParam, as_of?: number, issues?: EpiRangeParam, format?: 'json' | 'tree' | 'classic' | 'csv'): Promise<EpiDataResponse>;
-        covidcast_meta(): Promise<EpiDataResponse>;
-        covid_hosp(states: StringParam, dates: EpiRangeParam, issues: EpiRangeParam): Promise<EpiDataResponse>;
-        covid_hosp_facility(hospital_pks: StringParam, collection_weeks: EpiRangeParam, publication_dates: EpiRangeParam): Promise<EpiDataResponse>;
-        covid_hosp_facility_lookup(state?: string, ccn?: string, city?: string, zip?: string, fips_code?: string): Promise<EpiDataResponse>;
+        twitter(auth: string, locations: StringParam, dates?: EpiRangeParam, epiweeks?: EpiRangeParam): Promise<EpiDataResponse>;
+        wiki(articles: StringParam, dates?: EpiRangeParam, epiweeks: EpiRangeParam, language?: string = 'en'): Promise<EpiDataResponse>;
     }
 
     export const EpidataAsync: EpidataAsyncFunctions;
diff --git a/src/client/delphi_epidata.js b/src/client/delphi_epidata.js
diff --git a/src/server/endpoints/wiki.py b/src/server/endpoints/wiki.py
