@discomedia/utils 1.0.5 → 1.0.7

package/dist/types-frontend/polygon.d.ts

@@ -0,0 +1,126 @@
+/**********************************************************************************
+ * Polygon.io calls
+ **********************************************************************************/
+import { PolygonQuote, PolygonPriceData, PolygonGroupedDailyResponse, PolygonTickerInfo, PolygonDailyOpenClose, PolygonTradesResponse } from './types';
+/**
+ * Fetches general information about a stock ticker.
+ * @param {string} symbol - The stock ticker symbol to fetch information for.
+ * @param {Object} [options] - Optional parameters.
+ * @param {string} [options.apiKey] - The API key to use for the request.
+ * @returns {Promise<PolygonTickerInfo | null>} The ticker information or null if not found.
+ */
+export declare const fetchTickerInfo: (symbol: string, options?: {
+    apiKey?: string;
+}) => Promise<PolygonTickerInfo | null>;
+/**
+ * Fetches the last trade for a given stock ticker.
+ * @param {string} symbol - The stock ticker symbol to fetch the last trade for.
+ * @param {Object} [options] - Optional parameters.
+ * @param {string} [options.apiKey] - The API key to use for the request.
+ * @returns {Promise<PolygonQuote>} The last trade information.
+ */
+export declare const fetchLastTrade: (symbol: string, options?: {
+    apiKey?: string;
+}) => Promise<PolygonQuote>;
+/**
+ * Fetches price data for a given stock ticker.
+ * @param {Object} params - The parameters for fetching price data.
+ * @param {string} params.ticker - The stock ticker symbol.
+ * @param {number} params.start - The start timestamp for fetching price data.
+ * @param {number} [params.end] - The end timestamp for fetching price data.
+ * @param {number} params.multiplier - The multiplier for the price data.
+ * @param {string} params.timespan - The timespan for the price data.
+ * @param {number} [params.limit] - The maximum number of price data points to fetch.
+ * @param {Object} [options] - Optional parameters.
+ * @param {string} [options.apiKey] - The API key to use for the request.
+ * @returns {Promise<PolygonPriceData[]>} The fetched price data.
+ */
+export declare const fetchPrices: (params: {
+    ticker: string;
+    start: number;
+    end?: number;
+    multiplier: number;
+    timespan: string;
+    limit?: number;
+}, options?: {
+    apiKey?: string;
+}) => Promise<PolygonPriceData[]>;
+/**
+ * Analyzes the price data for a given stock.
+ * @param {PolygonPriceData[]} priceData - The price data to analyze.
+ * @returns {string} The analysis report.
+ */
+export declare function analysePolygonPriceData(priceData: PolygonPriceData[]): string;
+/**
+ * Fetches grouped daily price data for a specific date.
+ * @param {string} date - The date to fetch grouped daily data for.
+ * @param {Object} [options] - Optional parameters.
+ * @param {string} [options.apiKey] - The API key to use for the request.
+ * @param {boolean} [options.adjusted] - Whether to adjust the data.
+ * @param {boolean} [options.includeOTC] - Whether to include OTC data.
+ * @returns {Promise<PolygonGroupedDailyResponse>} The grouped daily response.
+ */
+export declare const fetchGroupedDaily: (date: string, options?: {
+    apiKey?: string;
+    adjusted?: boolean;
+    includeOTC?: boolean;
+}) => Promise<PolygonGroupedDailyResponse>;
+/**
+ * Formats the price data into a readable string.
+ * @param {PolygonPriceData[]} priceData - The price data to format.
+ * @returns {string} The formatted price data.
+ */
+export declare function formatPriceData(priceData: PolygonPriceData[]): string;
+export declare const fetchDailyOpenClose: (
+/**
+ * Fetches the daily open and close data for a given stock ticker.
+ * @param {string} symbol - The stock ticker symbol to fetch data for.
+ * @param {Date} [date=new Date()] - The date to fetch data for.
+ * @param {Object} [options] - Optional parameters.
+ * @param {string} [options.apiKey] - The API key to use for the request.
+ * @param {boolean} [options.adjusted] - Whether to adjust the data.
+ * @returns {Promise<PolygonDailyOpenClose>} The daily open and close data.
+ */
+symbol: string, date?: Date, options?: {
+    apiKey?: string;
+    adjusted?: boolean;
+}) => Promise<PolygonDailyOpenClose>;
+/**
+ * Gets the previous close price for a given stock ticker.
+ * @param {string} symbol - The stock ticker symbol to fetch the previous close for.
+ * @param {Date} [referenceDate] - The reference date to use for fetching the previous close.
+ * @returns {Promise<{ close: number; date: Date }>} The previous close price and date.
+ */
+export declare function getPreviousClose(symbol: string, referenceDate?: Date, options?: {
+    apiKey?: string;
+}): Promise<{
+    close: number;
+    date: Date;
+}>;
+/**
+ * Fetches trade data for a given stock ticker.
+ * @param {string} symbol - The stock ticker symbol to fetch trades for.
+ * @param {Object} [options] - Optional parameters.
+ * @param {string} [options.apiKey] - The API key to use for the request.
+ * @param {string | number} [options.timestamp] - The timestamp for fetching trades.
+ * @param {string | number} [options.timestampgt] - Greater than timestamp for fetching trades.
+ * @param {string | number} [options.timestampgte] - Greater than or equal to timestamp for fetching trades.
+ * @param {string | number} [options.timestamplt] - Less than timestamp for fetching trades.
+ * @param {string | number} [options.timestamplte] - Less than or equal to timestamp for fetching trades.
+ * @param {'asc' | 'desc'} [options.order] - The order of the trades.
+ * @param {number} [options.limit] - The maximum number of trades to fetch.
+ * @param {string} [options.sort] - The sort order for the trades.
+ * @returns {Promise<PolygonTradesResponse>} The fetched trades response.
+ */
+export declare const fetchTrades: (symbol: string, options?: {
+    apiKey?: string;
+    timestamp?: string | number;
+    timestampgt?: string | number;
+    timestampgte?: string | number;
+    timestamplt?: string | number;
+    timestamplte?: string | number;
+    order?: "asc" | "desc";
+    limit?: number;
+    sort?: string;
+}) => Promise<PolygonTradesResponse>;
+//# sourceMappingURL=polygon.d.ts.map

package/dist/types-frontend/polygon.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"polygon.d.ts","sourceRoot":"","sources":["../../src/polygon.ts"],"names":[],"mappings":"AAAA;;oFAEoF;AAGpF,OAAO,EACL,YAAY,EACZ,gBAAgB,EAChB,2BAA2B,EAE3B,iBAAiB,EACjB,qBAAqB,EACrB,qBAAqB,EAEtB,MAAM,SAAS,CAAC;AAYjB;;;;;;GAMG;AAEH,eAAO,MAAM,eAAe,GAC1B,QAAQ,MAAM,EACd,UAAU;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,KAC5B,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAoFlC,CAAC;AAGF;;;;;;GAMG;AAEH,eAAO,MAAM,cAAc,GAAU,QAAQ,MAAM,EAAE,UAAU;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,KAAG,OAAO,CAAC,YAAY,CAkDxG,CAAC;AAGF;;;;;;;;;;;;GAYG;AAEH,eAAO,MAAM,WAAW,GACtB,QAAQ;IACN,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,EACD,UAAU;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,KAC5B,OAAO,CAAC,gBAAgB,EAAE,CAiF5B,CAAC;AAEF;;;;GAIG;AAEH,wBAAgB,uBAAuB,CAAC,SAAS,EAAE,gBAAgB,EAAE,GAAG,MAAM,CAsC7E;AAID;;;;;;;;GAQG;AAEH,eAAO,MAAM,iBAAiB,GAC5B,MAAM,MAAM,EACZ,UAAU;IACR,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,KACA,OAAO,CAAC,2BAA2B,CA6DrC,CAAC;AAEF;;;;GAIG;AAEH,wBAAgB,eAAe,CAAC,SAAS,EAAE,gBAAgB,EAAE,GAAG,MAAM,CAkBrE;AAED,eAAO,MAAM,mBAAmB;AAC9B;;;;;;;;GAQG;AAEH,QAAQ,MAAM,EACd,OAAM,IAAiB,EACvB,UAAU;IACR,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,KACA,OAAO,CAAC,qBAAqB,CAsB/B,CAAC;AAIF;;;;;GAKG;AAEH,wBAAsB,gBAAgB,CACpC,MAAM,EAAE,MAAM,EACd,aAAa,CAAC,EAAE,IAAI,EACpB,OAAO,CAAC,EAAE;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,GAC5B,OAAO,CAAC;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,IAAI,CAAA;CAAE,CAAC,CAUxC;AAED;;;;;;;;;;;;;;GAcG;AAEH,eAAO,MAAM,WAAW,GACtB,QAAQ,MAAM,EACd,UAAU;IACR,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC9B,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC/B,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC9B,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC/B,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IACvB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,KACA,OAAO,CAAC,qBAAqB,CAuD/B,CAAC"}

package/dist/types-frontend/technical-analysis.d.ts

@@ -0,0 +1,90 @@
+import { PolygonPriceData } from './types';
+import { BollingerBandsData, BollingerBandsParams } from './types';
+/**
+ * Calculates Bollinger Bands for a given set of price data.
+ * Bollinger Bands consist of a middle band (SMA) and two outer bands
+ * that are standard deviations away from the middle band.
+ *
+ * @param priceData - An array of price data objects containing closing prices.
+ * @param params - An object containing optional parameters for the calculation.
+ * @param params.period - The number of periods to use for the SMA (default is 20).
+ * @param params.standardDeviations - The number of standard deviations for the outer bands (default is 2).
+ * @returns An array of BollingerBandsData objects containing the calculated bands.
+ */
+export declare function calculateBollingerBands(priceData: PolygonPriceData[], { period, standardDeviations }?: BollingerBandsParams): BollingerBandsData[];
+import { EMAParams } from './types';
+/**
+ * Calculates the Exponential Moving Average (EMA) for a given set of price data.
+ * The EMA gives more weight to recent prices, making it more responsive to new information.
+ *
+ * @param priceData - An array of price data objects containing closing prices.
+ * @param params - An object containing optional parameters for the calculation.
+ * @param params.period - The number of periods to use for the EMA (default is 20).
+ * @param params.period2 - An optional second period for a second EMA (default is 9).
+ * @returns An array of EMAData objects containing the calculated EMA values.
+ */
+export declare function calculateEMA(priceData: PolygonPriceData[], { period, period2 }?: EMAParams): EMAData[];
+import { FibonacciData, FibonacciParams } from './types';
+/**
+ * Calculates Fibonacci retracement and extension levels based on price data.
+ * Fibonacci levels are used to identify potential support and resistance levels.
+ *
+ * @param priceData - An array of price data objects containing high and low prices.
+ * @param params - An object containing optional parameters for the calculation.
+ * @param params.lookbackPeriod - The number of periods to look back for swing high/low (default is 20).
+ * @param params.retracementLevels - An array of retracement levels to calculate (default is [0.236, 0.382, 0.5, 0.618, 0.786]).
+ * @param params.extensionLevels - An array of extension levels to calculate (default is [1.272, 1.618, 2.618]).
+ * @param params.reverseDirection - A boolean indicating if the trend is reversed (default is false).
+ * @returns An array of FibonacciData objects containing the calculated levels.
+ */
+export declare function calculateFibonacciLevels(priceData: PolygonPriceData[], { lookbackPeriod, retracementLevels, extensionLevels, reverseDirection, }?: FibonacciParams): FibonacciData[];
+import { MACDData, MACDParams, EMAData } from './types';
+/**
+ * Calculates the Moving Average Convergence Divergence (MACD) for a given set of price data.
+ * MACD is a trend-following momentum indicator that shows the relationship between two EMAs.
+ *
+ * @param priceData - An array of price data objects containing closing prices.
+ * @param params - An object containing optional parameters for the calculation.
+ * @param params.shortPeriod - The short EMA period (default is 12).
+ * @param params.longPeriod - The long EMA period (default is 26).
+ * @param params.signalPeriod - The signal line period (default is 9).
+ * @returns An array of MACDData objects containing the calculated MACD values.
+ */
+export declare function calculateMACD(priceData: PolygonPriceData[], { shortPeriod, longPeriod, signalPeriod }?: MACDParams): MACDData[];
+import { RSIData, RSIParams } from './types';
+/**
+ * Calculates the Relative Strength Index (RSI) for a given set of price data.
+ * RSI is a momentum oscillator that measures the speed and change of price movements.
+ *
+ * @param priceData - An array of price data objects containing closing prices.
+ * @param params - An object containing optional parameters for the calculation.
+ * @param params.period - The number of periods to use for the RSI (default is 14).
+ * @returns An array of RSIData objects containing the calculated RSI values.
+ */
+export declare function calculateRSI(priceData: PolygonPriceData[], { period }?: RSIParams): RSIData[];
+import { StochData, StochasticParams } from './types';
+/**
+ * Calculates the Stochastic Oscillator for a given set of price data.
+ * The Stochastic Oscillator compares a particular closing price of a security to a range of its prices over a certain period of time.
+ *
+ * @param priceData - An array of price data objects containing high, low, and closing prices.
+ * @param params - An object containing optional parameters for the calculation.
+ * @param params.lookbackPeriod - The number of periods to look back for the calculation of %K (default is 5).
+ * @param params.signalPeriod - The number of periods for the %D signal line (default is 3).
+ * @param params.smoothingFactor - The smoothing factor for %K (default is 3).
+ * @returns An array of StochData objects containing the calculated %K and %D values.
+ */
+export declare function calculateStochasticOscillator(priceData: PolygonPriceData[], { lookbackPeriod, signalPeriod, smoothingFactor }?: StochasticParams): StochData[];
+import { SupportResistanceData, SupportResistanceParams } from './types';
+/**
+ * Calculates support and resistance levels based on price data.
+ * Support and resistance levels are price levels at which a stock tends to stop and reverse.
+ *
+ * @param priceData - An array of price data objects containing high, low, and closing prices.
+ * @param params - An object containing optional parameters for the calculation.
+ * @param params.maxLevels - The maximum number of support/resistance levels to return (default is 5).
+ * @param params.lookbackPeriod - The number of periods to look back for pivot points (default is 10).
+ * @returns An array of SupportResistanceData objects containing the calculated levels.
+ */
+export declare function calculateSupportAndResistance(priceData: PolygonPriceData[], { maxLevels, lookbackPeriod }?: SupportResistanceParams): SupportResistanceData[];
+//# sourceMappingURL=technical-analysis.d.ts.map

package/dist/types-frontend/technical-analysis.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"technical-analysis.d.ts","sourceRoot":"","sources":["../../src/technical-analysis.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAGnE;;;;;;;;;;GAUG;AACH,wBAAgB,uBAAuB,CACrC,SAAS,EAAE,gBAAgB,EAAE,EAC7B,EAAE,MAAW,EAAE,kBAAsB,EAAE,GAAE,oBAAyB,GACjE,kBAAkB,EAAE,CAsCtB;AAED,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEpC;;;;;;;;;GASG;AACH,wBAAgB,YAAY,CAAC,SAAS,EAAE,gBAAgB,EAAE,EAAE,EAAE,MAAW,EAAE,OAAW,EAAE,GAAE,SAAc,GAAG,OAAO,EAAE,CA+DnH;AAED,OAAO,EAAE,aAAa,EAAE,eAAe,EAAkB,MAAM,SAAS,CAAC;AAEzE;;;;;;;;;;;GAWG;AACH,wBAAgB,wBAAwB,CACtC,SAAS,EAAE,gBAAgB,EAAE,EAC7B,EACE,cAAmB,EACnB,iBAAqD,EACrD,eAAuC,EACvC,gBAAwB,GACzB,GAAE,eAAoB,GACtB,aAAa,EAAE,CAuDjB;AAED,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAExD;;;;;;;;;;GAUG;AACH,wBAAgB,aAAa,CAC3B,SAAS,EAAE,gBAAgB,EAAE,EAC7B,EAAE,WAAgB,EAAE,UAAe,EAAE,YAAgB,EAAE,GAAE,UAAe,GACvE,QAAQ,EAAE,CAyDZ;AAED,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAE7C;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAAC,SAAS,EAAE,gBAAgB,EAAE,EAAE,EAAE,MAAW,EAAE,GAAE,SAAc,GAAG,OAAO,EAAE,CA2DtG;AAED,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAEtD;;;;;;;;;;GAUG;AACH,wBAAgB,6BAA6B,CAC3C,SAAS,EAAE,gBAAgB,EAAE,EAC7B,EAAE,cAAkB,EAAE,YAAgB,EAAE,eAAmB,EAAE,GAAE,gBAAqB,GACnF,SAAS,EAAE,CA8Cb;AAED,OAAO,EAAE,qBAAqB,EAAE,uBAAuB,EAA0B,MAAM,SAAS,CAAC;AAEjG;;;;;;;;;GASG;AACH,wBAAgB,6BAA6B,CAC3C,SAAS,EAAE,gBAAgB,EAAE,EAC7B,EAAE,SAAa,EAAE,cAAmB,EAAE,GAAE,uBAA4B,GACnE,qBAAqB,EAAE,CA8GzB"}

package/dist/types-frontend/test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=test.d.ts.map

package/dist/types-frontend/test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test.d.ts","sourceRoot":"","sources":["../../src/test.ts"],"names":[],"mappings":""}

package/dist/types-frontend/testing/market-time-refactor-test.d.ts

@@ -0,0 +1 @@
+//# sourceMappingURL=market-time-refactor-test.d.ts.map

package/dist/types-frontend/testing/market-time-refactor-test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"market-time-refactor-test.d.ts","sourceRoot":"","sources":["../../../src/testing/market-time-refactor-test.ts"],"names":[],"mappings":""}