"use strict"; var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { if (k2 === undefined) k2 = k; var desc = Object.getOwnPropertyDescriptor(m, k); if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { desc = { enumerable: true, get: function() { return m[k]; } }; } Object.defineProperty(o, k2, desc); }) : (function(o, m, k, k2) { if (k2 === undefined) k2 = k; o[k2] = m[k]; })); var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) { Object.defineProperty(o, "default", { enumerable: true, value: v }); }) : function(o, v) { o["default"] = v; }); var __importStar = (this && this.__importStar) || (function () { var ownKeys = function(o) { ownKeys = Object.getOwnPropertyNames || function (o) { var ar = []; for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k; return ar; }; return ownKeys(o); }; return function (mod) { if (mod && mod.__esModule) return mod; var result = {}; if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); __setModuleDefault(result, mod); return result; }; })(); var __importDefault = (this && this.__importDefault) || function (mod) { return (mod && mod.__esModule) ? mod : { "default": mod }; }; Object.defineProperty(exports, "__esModule", { value: true }); /** * @module moduleExec */ const validateAndCoerceTypes_js_1 = __importStar(require("./validateAndCoerceTypes.js")); const csv2json_js_1 = __importDefault(require("./csv2json.js")); /** * Executes a module with the given options. * * 1. **Query Stage** * 1. Validate user-supplied module params, e.g. { period: '1d' } * 1. Merge query params: (module defaults, user-supplied overrides, etc) * 1. Call `transformWith` func if provided. * * 1. Call `lib/yahooFinanceFetch.ts` with the above. * * 1. **Result Stage** * 1. Call `transformWith` func if provided. * 1. Validate the result and coerce types. * * @param this - The context of the module execution. * @param opts - The options for the module execution. * @returns A promise that resolves to the result of the module execution. * It will be validated according to the requested schema but the calling * module should cast to the correct type. */ async function moduleExec(opts) { const queryOpts = opts.query; const moduleOpts = opts.moduleOptions; const moduleName = opts.moduleName; const resultOpts = opts.result; if (!queryOpts.definitions) { throw new Error("no definitions in queryOpts: " + JSON.stringify(queryOpts)); } if (!resultOpts.definitions) { throw new Error("no definitions in resultOpts: " + JSON.stringify(resultOpts)); } if (queryOpts.assertSymbol) { const symbol = queryOpts.assertSymbol; if (typeof symbol !== "string") { throw new Error(`yahooFinance.${moduleName}() expects a single string symbol as its ` + `query, not a(n) ${typeof symbol}: ${JSON.stringify(symbol)}`); } } // TODO XXX, allow this to be reversed if (this._opts.validation?.allowAdditionalProps === false) { (0, validateAndCoerceTypes_js_1.disallowAdditionalProps)(resultOpts.definitions); } const validateOptions = !moduleOpts || moduleOpts.validateOptions === undefined || moduleOpts.validateOptions === true; // Check that query options passed by the user are valid for this module try { (0, validateAndCoerceTypes_js_1.default)({ source: moduleName, type: "options", object: queryOpts.overrides ?? {}, definitions: queryOpts.definitions, schemaOrSchemaKey: queryOpts.schemaKey, options: this._opts.validation, logger: this._opts.logger, logObj: this._logObj, versionCheck: this._opts.versionCheck, }); } catch (error) { if (validateOptions) throw error; } let queryOptions = { ...queryOpts.defaults, // Module defaults e.g. { period: '1wk', lang: 'en' } ...queryOpts.runtime, // Runtime params e.g. { q: query } ...queryOpts.overrides, // User supplied options that override above }; /* * Called with the merged (defaults,runtime,overrides) before running * the query. Useful to transform options we allow but not Yahoo, e.g. * allow a "2020-01-01" date but transform this to a UNIX epoch. */ if (queryOpts.transformWith) { queryOptions = queryOpts.transformWith(queryOptions); } // this._fetch is lib/yahooFinanceFetch let result = await this._fetch(queryOpts.url, queryOptions, moduleOpts, queryOpts.fetchType, queryOpts.needsCrumb); if (queryOpts.fetchType === "csv") result = (0, csv2json_js_1.default)(result); /* * Mutate the Yahoo result *before* validating and coercion. Mostly used * to e.g. throw if no (resault.returnField) and return result.returnField. */ if (opts.result.transformWith) result = opts.result.transformWith(result); const validateResult = !moduleOpts || moduleOpts.validateResult === undefined || moduleOpts.validateResult === true; const validationOpts = { ...this._opts.validation, // Set logErrors=false if validateResult=false logErrors: validateResult ? this._opts.validation.logErrors : false, }; /* * Validate the returned result (after transforming, above) and coerce types. * * The coersion works as follows: if we're expecting a "Date" type, but Yahoo * gives us { raw: 1231421524, fmt: "2020-01-01" }, we'll return that as * `new Date(1231421524 * 1000)`. * * Beyond that, ensures that user won't process unexpected data, in two * cases: * * a) Missing required properties or unexpected additional properties * b) A total new change in format that we really have no idea what to do * with, e.g. a new kind of Date that we've never seen before and * * The idea is that if you receive a result, it's safe to use / store in * database, etc. Otherwise you'll receive an error. */ try { (0, validateAndCoerceTypes_js_1.default)({ source: moduleName, type: "result", object: result, definitions: resultOpts.definitions, schemaOrSchemaKey: resultOpts.schemaKey, options: validationOpts, logger: this._opts.logger, logObj: this._logObj, versionCheck: this._opts.versionCheck, }); } catch (error) { if (validateResult) throw error; } return result; } exports.default = moduleExec;