feat(env): multiple environments, browser entry point

bin/yahoo-finance.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
-const yahooFinance = require('../api/index.js');
-const moduleNames = Object.keys(yahooFinance);
+const yahooFinance = require('../api/index-node.js').default;
+const moduleNames = Object.keys(yahooFinance).filter(n => !n.startsWith('_'));
 
 const node = process.argv[0];
 const script = process.argv[1];

package.json

@@ -2,8 +2,9 @@
   "name": "yahoo-finance2",
   "version": "0.0.1",
   "description": "JS API for Yahoo Finance",
-  "main": "api/index.js",
-  "types": "api/index.d.ts",
+  "main": "api/index-node.js",
+  "types": "api/index-node.d.ts",
+  "browser": "api/index-browser.js",
   "repository": "https://github.com/gadicc/node-yahoo-finance2",
   "author": "Gadi Cohen <[email protected]>",
   "license": "MIT",

src/env-browser.ts

@@ -0,0 +1,6 @@
+// @ts-nocheck
+
+export default {
+  fetch,
+  URLSearchParams,
+}

src/env-node.ts

@@ -0,0 +1,7 @@
+const { URLSearchParams } = require('url');
+const fetch = require('node-fetch');
+
+export default {
+  fetch,
+  URLSearchParams,
+}

src/index-browser.ts

@@ -0,0 +1,6 @@
+import yahooFinance from './index-common';
+import browserEnvironment from './env-browser';
+
+yahooFinance._env = browserEnvironment;
+
+export default yahooFinance;

src/index.ts → src/index-common.ts

@@ -1,16 +1,16 @@
+// libs
+import yahooFinanceFetch from './lib/yahooFinanceFetch';
+
+// modules
 import autoc from './modules/autoc';
 import historical from './modules/historical';
 import quoteSummary from './modules/quoteSummary';
 import search from './modules/search';
 
 export default {
-  autoc,
-  historical,
-  quoteSummary,
-  search,
-}
+  _env: {},
+  _fetch: yahooFinanceFetch,
 
-export {
   autoc,
   historical,
   quoteSummary,

src/index-node.ts

@@ -0,0 +1,6 @@
+import yahooFinance from './index-common';
+import nodeEnvironment from './env-node';
+
+yahooFinance._env = nodeEnvironment;
+
+export default yahooFinance;

src/lib/errors.js

@@ -16,9 +16,14 @@ class InvalidOptionsError extends Error {
   constructor(...args) { super(...args); this.name = 'InvalidOptionsError' }
 }
 
+class NoEnvironmentError extends Error {
+  constructor(...args) { super(...args); this.name = 'NoEnvironmentError' }
+}
+
 module.exports = {
   BadRequestError,
   HTTPError,
   FailedYahooValidationError,
   InvalidOptionsError,
+  NoEnvironmentError,
 };

src/lib/yahooFinanceFetch.js

@@ -1,25 +1,27 @@
-const { URLSearchParams} = require('url');
-const nodeFetch = require('node-fetch');
-
 const errors = require('./errors');
 const pkg = require('../../package.json');
 
 const userAgent = `${pkg.name}/${pkg.version} (+${pkg.repository})`;
 
 async function yahooFinanceFetch(urlBase, params={}, fetchOptionsOverrides={}, func='json') {
+  if (!this._env)
+    throw new errors.NoEnvironmentError("yahooFinanceFetch called without this._env set");
+
+  const { URLSearchParams, fetch } = this._env;
+
   const urlSearchParams = new URLSearchParams(params);
   const url = urlBase + '?' + urlSearchParams.toString();
 
-  const fetch = fetchOptionsOverrides.devel
+  const fetchFunc = fetchOptionsOverrides.devel
     ? require('./fetchDevel')
-    : nodeFetch;
+    : fetch;
 
   const fetchOptions = {
     "User-Agent": userAgent,
     ...fetchOptionsOverrides
   };
 
-  const res = await fetch(url, fetchOptions);
+  const res = await fetchFunc(url, fetchOptions);
   const result = await res[func]();
 
   /*

src/lib/yahooFinanceFetch.spec.js

@@ -1,8 +1,12 @@
-const yahooFinanceFetch = require('./yahooFinanceFetch');
+const _yahooFinanceFetch = require('./yahooFinanceFetch');
 const errors = require('./errors');
 
+const _env = require('../env-node').default;
+
 describe('yahooFinanceFetch', () => {
 
+  const yahooFinanceFetch = _yahooFinanceFetch.bind({ _env });
+
   it('catches errors', () => {
     const url = 'https://query2.finance.yahoo.com/v1/finance/search';
 

src/modules/autoc.spec.ts

@@ -1,10 +1,19 @@
 import autoc from './autoc';
 const { InvalidOptionsError } = require('../lib/errors');
 
+import _env from '../env-node';
+import _fetch from '../lib/yahooFinanceFetch';
+
+const yf = {
+  _env,
+  _fetch,
+  autoc
+};
+
 describe('autoc', () => {
 
   it('throws InvalidOptions on invalid options', async () => {
-    const rwo = (options:any) => autoc('symbol', options);
+    const rwo = (options:any) => yf.autoc('symbol', options);
     await expect(rwo({ invalid: true })).rejects.toThrow(InvalidOptionsError)
   });
 

src/modules/autoc.ts

@@ -1,4 +1,3 @@
-import yahooFinanceFetch from '../lib/yahooFinanceFetch';
 import validateAndCoerceTypes from '../lib/validateAndCoerceTypes';
 
 const QUERY_URL = 'https://autoc.finance.yahoo.com/autoc';
@@ -30,6 +29,7 @@ const queryOptionsDefaults = {
 };
 
 async function autoc(
+  this: { [key:string]: any, _fetch: Function },
   query: string,
   queryOptionsOverrides: AutocOptions = {},
   fetchOptions?: object
@@ -42,7 +42,7 @@ async function autoc(
     ...queryOptionsOverrides
   };
 
-  const result = await yahooFinanceFetch(QUERY_URL, queryOptions, fetchOptions);
+  const result = await this._fetch(QUERY_URL, queryOptions, fetchOptions);
 
   if (result.ResultSet) {
     validateAndCoerceTypes(result.ResultSet, QUERY_RESULT_SCHEMA_KEY);

src/modules/historical.spec.ts

@@ -1,10 +1,19 @@
 import historical from './historical';
 const { InvalidOptionsError } = require('../lib/errors');
 
+import _env from '../env-node';
+import _fetch from '../lib/yahooFinanceFetch';
+
+const yf = {
+  _env,
+  _fetch,
+  historical
+};
+
 describe('historical', () => {
 
   it('throws InvalidOptions on invalid options', async () => {
-    const rwo = (options:any) => historical('symbol', options);
+    const rwo = (options:any) => yf.historical('symbol', options);
     await expect(rwo({ invalid: true })).rejects.toThrow(InvalidOptionsError)
   });
 

src/modules/historical.ts

@@ -1,4 +1,3 @@
-import yahooFinanceFetch = require('../lib/yahooFinanceFetch');
 import validateAndCoerceTypes from '../lib/validateAndCoerceTypes';
 import csv2json from '../lib/csv2json';
 
@@ -33,6 +32,7 @@ const queryOptionsDefaults: Omit<HistoricalOptions,'period1'> = {
 };
 
 export default async function historical(
+  this: { [key:string]: any, _fetch: Function },
   symbol: string,
   queryOptionsOverrides: HistoricalOptions,
   fetchOptions?: object
@@ -57,7 +57,7 @@ export default async function historical(
   }
 
   const url = QUERY_URL + '/' + symbol;
-  const csv = await yahooFinanceFetch(url, queryOptions, fetchOptions, 'text');
+  const csv = await this._fetch(url, queryOptions, fetchOptions, 'text');
   const result = csv2json(csv);
 
   // this can't handle Dates.  let's decide where/when/how to validate.