ticker-cli 1.0.0

package/src/services/indicators.ts

@@ -0,0 +1,188 @@
+import { sma, ema, rsi, macd, bb } from "indicatorts";
+import type { ChartResultArrayQuote } from "yahoo-finance2/modules/chart";
+import type { IndicatorDataPoint, IndicatorResult } from "../types";
+/**
+ * Indicator configuration options
+ */
+export interface IndicatorConfig {
+  period?: number;
+  length?: number;
+  fast?: number;
+  slow?: number;
+  signal?: number;
+  short?: number;
+  long?: number;
+  stddev?: number;
+}
+
+/**
+ * Indicator service for calculating technical indicators
+ */
+export class IndicatorService {
+  /**
+   * Calculate Simple Moving Average (SMA)
+   */
+  calculateSMA(
+    data: ChartResultArrayQuote[],
+    config: IndicatorConfig = {},
+  ): IndicatorResult {
+    const period = config.period ?? config.length ?? 20;
+    const closes = data.map((d) => d.close!);
+
+    const smaValues = sma(closes, { period });
+
+    return {
+      symbol: "",
+      indicator: "SMA",
+      config: { length: period },
+      data: this.alignIndicatorData(data, smaValues),
+    };
+  }
+
+  /**
+   * Calculate Exponential Moving Average (EMA)
+   */
+  calculateEMA(
+    data: ChartResultArrayQuote[],
+    config: IndicatorConfig = {},
+  ): IndicatorResult {
+    const period = config.period ?? config.length ?? 20;
+    const closes = data.map((d) => d.close!);
+
+    const emaValues = ema(closes, { period });
+
+    return {
+      symbol: "",
+      indicator: "EMA",
+      config: { length: period },
+      data: this.alignIndicatorData(data, emaValues),
+    };
+  }
+
+  /**
+   * Calculate Relative Strength Index (RSI)
+   */
+  calculateRSI(
+    data: ChartResultArrayQuote[],
+    config: IndicatorConfig = {},
+  ): IndicatorResult {
+    const period = config.period ?? config.length ?? 14;
+    const closes = data.map((d) => d.close!);
+
+    const rsiValues = rsi(closes, { period });
+
+    return {
+      symbol: "",
+      indicator: "RSI",
+      config: { length: period },
+      data: this.alignIndicatorData(data, rsiValues),
+    };
+  }
+
+  /**
+   * Calculate MACD (Moving Average Convergence Divergence)
+   */
+  calculateMACD(
+    data: ChartResultArrayQuote[],
+    config: IndicatorConfig = {},
+  ): IndicatorResult {
+    const fast = config.fast ?? config.short ?? 12;
+    const slow = config.slow ?? config.long ?? 26;
+    const signal = config.signal ?? 9;
+    const closes = data.map((d) => d.close!);
+
+    const macdResult = macd(closes, { fast, slow, signal });
+
+    const indicatorData: IndicatorDataPoint[] = data.map((d, i) => ({
+      date: d.date,
+      macd: macdResult.macdLine[i],
+      signal: macdResult.signalLine[i],
+      histogram:
+        macdResult.macdLine[i] !== undefined &&
+        macdResult.signalLine[i] !== undefined
+          ? macdResult.macdLine[i]! - macdResult.signalLine[i]!
+          : undefined,
+    }));
+
+    return {
+      symbol: "",
+      indicator: "MACD",
+      config: { short: fast, long: slow, signal },
+      data: indicatorData,
+    };
+  }
+
+  /**
+   * Calculate Bollinger Bands
+   */
+  calculateBollingerBands(
+    data: ChartResultArrayQuote[],
+    config: IndicatorConfig = {},
+  ): IndicatorResult {
+    const period = config.period ?? config.length ?? 20;
+    const closes = data.map((d) => d.close!);
+
+    const bbResult = bb(closes, { period });
+
+    const indicatorData: IndicatorDataPoint[] = data.map((d, i) => ({
+      date: d.date,
+      upper: bbResult.upper[i],
+      middle: bbResult.middle[i],
+      lower: bbResult.lower[i],
+    }));
+
+    return {
+      symbol: "",
+      indicator: "BollingerBands",
+      config: { length: period },
+      data: indicatorData,
+    };
+  }
+
+  /**
+   * Calculate indicator by name
+   */
+  calculate(
+    indicator: string,
+    data: ChartResultArrayQuote[],
+    config: IndicatorConfig = {},
+  ): IndicatorResult {
+    switch (indicator.toLowerCase()) {
+      case "sma":
+        return this.calculateSMA(data, config);
+      case "ema":
+        return this.calculateEMA(data, config);
+      case "rsi":
+        return this.calculateRSI(data, config);
+      case "macd":
+        return this.calculateMACD(data, config);
+      case "bb":
+      case "bollinger":
+      case "bollingerbands":
+        return this.calculateBollingerBands(data, config);
+      default:
+        throw new Error(`Unknown indicator: ${indicator}`);
+    }
+  }
+
+  /**
+   * Align indicator values with dates
+   * Indicators often have undefined values at the start
+   */
+  private alignIndicatorData(
+    data: ChartResultArrayQuote[],
+    values: number[],
+  ): IndicatorDataPoint[] {
+    return data.map((d, i) => ({
+      date: d.date,
+      value: values[i],
+    }));
+  }
+}
+
+/**
+ * Create an IndicatorService instance
+ */
+export function createIndicatorService(): IndicatorService {
+  return new IndicatorService();
+}

package/src/services/yahoo.ts

@@ -0,0 +1,205 @@
+import YahooFinance from "yahoo-finance2";
+import type { PeriodPreset, IntervalType } from "../types";
+import { parseDate, getDefaultInterval } from "../utils";
+import type { QuoteResponseArray } from "yahoo-finance2/modules/quote";
+import type {
+  ChartOptions,
+  ChartResultArray,
+} from "yahoo-finance2/modules/chart";
+import type {
+  SearchOptions,
+  SearchResult,
+} from "yahoo-finance2/modules/search";
+import type {
+  OptionsOptions,
+  OptionsResult,
+} from "yahoo-finance2/modules/options";
+import type {
+  QuoteSummaryModules,
+  QuoteSummaryResult,
+} from "yahoo-finance2/modules/quoteSummary";
+import type {
+  ScreenerResult,
+  PredefinedScreenerModules,
+} from "yahoo-finance2/modules/screener";
+import type { InsightsResult } from "yahoo-finance2/modules/insights";
+import type { RecommendationsBySymbolResponseArray } from "yahoo-finance2/modules/recommendationsBySymbol";
+
+// Create a single instance of YahooFinance
+const yahooFinance = new YahooFinance({
+  suppressNotices: ["yahooSurvey"],
+});
+
+/**
+ * Yahoo Finance service wrapper
+ */
+export class YahooService {
+  /**
+   * Get stock quotes for one or more symbols
+   */
+  async getQuotes(symbols: string | string[]): Promise<QuoteResponseArray> {
+    const symbolArray = Array.isArray(symbols) ? symbols : [symbols];
+
+    return await yahooFinance.quote(symbolArray);
+  }
+
+  /**
+   * Get chart/historical data for a symbol
+   */
+  async getChart(
+    symbol: string,
+    options: {
+      period?: PeriodPreset;
+      start?: string;
+      end?: string;
+      interval?: IntervalType;
+    } = {},
+  ): Promise<ChartResultArray> {
+    const { period, start, end, interval } = options;
+
+    const chartOptions: ChartOptions = {
+      period1: new Date(),
+    };
+
+    // Calculate date range from period or use provided dates
+    if (start && end) {
+      chartOptions.period1 = parseDate(start);
+      chartOptions.period2 = parseDate(end);
+    } else {
+      // Use period to calculate period1 (period2 defaults to now)
+      const now = new Date();
+      const period1 = new Date();
+
+      const periodValue = period ?? "1mo";
+      switch (periodValue) {
+        case "1d":
+          period1.setDate(now.getDate() - 1);
+          break;
+        case "5d":
+          period1.setDate(now.getDate() - 5);
+          break;
+        case "1wk":
+          period1.setDate(now.getDate() - 7);
+          break;
+        case "1mo":
+          period1.setMonth(now.getMonth() - 1);
+          break;
+        case "3mo":
+          period1.setMonth(now.getMonth() - 3);
+          break;
+        case "6mo":
+          period1.setMonth(now.getMonth() - 6);
+          break;
+        case "1y":
+          period1.setFullYear(now.getFullYear() - 1);
+          break;
+        case "2y":
+          period1.setFullYear(now.getFullYear() - 2);
+          break;
+        case "5y":
+          period1.setFullYear(now.getFullYear() - 5);
+          break;
+      }
+
+      chartOptions.period1 = period1;
+      chartOptions.period2 = now;
+    }
+
+    chartOptions.interval = interval ?? getDefaultInterval(period ?? "1mo");
+
+    return (await yahooFinance.chart(symbol, chartOptions)) as ChartResultArray;
+  }
+
+  /**
+   * Get news for a symbol
+   */
+  async getNews(symbol: string, limit: number = 10): Promise<SearchResult> {
+    return yahooFinance.search(symbol, {
+      newsCount: limit,
+    });
+  }
+
+  /**
+   * Get insights for a symbol
+   */
+  async getInsights(symbol: string): Promise<InsightsResult> {
+    const result = await yahooFinance.insights(symbol);
+    return result;
+  }
+
+  /**
+   * Get options chain for a symbol
+   */
+  async getOptions(
+    symbol: string,
+    expirationDate?: string,
+  ): Promise<OptionsResult> {
+    const options: OptionsOptions = {};
+    if (expirationDate) {
+      options.date = parseDate(expirationDate);
+    }
+    return yahooFinance.options(symbol, options);
+  }
+
+  /**
+   * Get quote summary with specified modules
+   */
+  async getSummary(
+    symbol: string,
+    modules?: QuoteSummaryModules[],
+  ): Promise<QuoteSummaryResult> {
+    const defaultModules: QuoteSummaryModules[] = [
+      "summaryProfile",
+      "summaryDetail",
+      "defaultKeyStatistics",
+    ];
+
+    return yahooFinance.quoteSummary(symbol, {
+      modules: modules ?? defaultModules,
+    });
+  }
+
+  /**
+   * Get analyst recommendations for a symbol
+   */
+  async getRecommendations(
+    symbol: string,
+  ): Promise<RecommendationsBySymbolResponseArray> {
+    return yahooFinance.recommendationsBySymbol([symbol]);
+  }
+
+  /**
+   * Get screener results
+   */
+  async getScreener(query: PredefinedScreenerModules): Promise<ScreenerResult> {
+    return (await yahooFinance.screener(query, undefined, {
+      validateResult: false,
+    })) as ScreenerResult;
+  }
+
+  /**
+   * Search for symbols
+   */
+  async search(
+    query: string,
+    options: { includeQuotes?: boolean; includeNews?: boolean } = {},
+  ): Promise<SearchResult> {
+    const searchOptions: SearchOptions = {};
+
+    if (options.includeQuotes) {
+      searchOptions.quotesCount = 10;
+    }
+    if (options.includeNews) {
+      searchOptions.newsCount = 5;
+    }
+
+    return yahooFinance.search(query, searchOptions);
+  }
+}
+
+/**
+ * Create a YahooService instance
+ */
+export function createYahooService(): YahooService {
+  return new YahooService();
+}

package/src/types/index.ts

@@ -0,0 +1,47 @@
+export interface IndicatorDataPoint {
+  date: Date;
+  value?: number;
+  macd?: number;
+  signal?: number;
+  histogram?: number;
+  upper?: number;
+  middle?: number;
+  lower?: number;
+}
+
+export interface IndicatorDataPoint {
+  date: Date;
+  value?: number;
+  macd?: number;
+  signal?: number;
+  histogram?: number;
+  upper?: number;
+  middle?: number;
+  lower?: number;
+}
+export interface IndicatorResult {
+  symbol: string;
+  indicator: string;
+  config?: Record<string, number>;
+  data: IndicatorDataPoint[];
+}
+// Period presets
+export type PeriodPreset =
+  | "1d"
+  | "5d"
+  | "1wk"
+  | "1mo"
+  | "3mo"
+  | "6mo"
+  | "1y"
+  | "2y"
+  | "5y";
+export type IntervalType =
+  | "1m"
+  | "5m"
+  | "15m"
+  | "30m"
+  | "1h"
+  | "1d"
+  | "1wk"
+  | "1mo";

package/src/utils/date.ts

@@ -0,0 +1,107 @@
+import type { PeriodPreset, IntervalType } from "../types";
+
+/**
+ * Parse a date string or return the Date object
+ */
+export function parseDate(date: string | Date): Date {
+  if (date instanceof Date) return date;
+  const parsed = new Date(date);
+  if (isNaN(parsed.getTime())) {
+    throw new Error(`Invalid date: ${date}`);
+  }
+  return parsed;
+}
+
+/**
+ * Format a date as YYYY-MM-DD
+ */
+export function formatDate(date: Date): string {
+  return date.toISOString().split("T")[0] ?? "";
+}
+
+/**
+ * Get date range for a period preset
+ */
+export function getPeriodRange(period: PeriodPreset): {
+  start: Date;
+  end: Date;
+} {
+  const end = new Date();
+  const start = new Date();
+
+  switch (period) {
+    case "1d":
+      start.setDate(end.getDate() - 1);
+      break;
+    case "5d":
+      start.setDate(end.getDate() - 5);
+      break;
+    case "1wk":
+      start.setDate(end.getDate() - 7);
+      break;
+    case "1mo":
+      start.setMonth(end.getMonth() - 1);
+      break;
+    case "3mo":
+      start.setMonth(end.getMonth() - 3);
+      break;
+    case "6mo":
+      start.setMonth(end.getMonth() - 6);
+      break;
+    case "1y":
+      start.setFullYear(end.getFullYear() - 1);
+      break;
+    case "2y":
+      start.setFullYear(end.getFullYear() - 2);
+      break;
+    case "5y":
+      start.setFullYear(end.getFullYear() - 5);
+      break;
+    default:
+      throw new Error(`Unknown period: ${period}`);
+  }
+
+  return { start, end };
+}
+
+/**
+ * Get the default interval for a period
+ */
+export function getDefaultInterval(period: PeriodPreset): IntervalType {
+  switch (period) {
+    case "1d":
+    case "5d":
+      return "15m";
+    case "1wk":
+      return "1h";
+    case "1mo":
+    case "3mo":
+      return "1d";
+    case "6mo":
+    case "1y":
+    case "2y":
+      return "1d";
+    case "5y":
+      return "1wk";
+    default:
+      return "1d";
+  }
+}
+
+/**
+ * Validate a period preset
+ */
+export function isValidPeriod(period: string): period is PeriodPreset {
+  return ["1d", "5d", "1wk", "1mo", "3mo", "6mo", "1y", "2y", "5y"].includes(
+    period,
+  );
+}
+
+/**
+ * Validate an interval type
+ */
+export function isValidInterval(interval: string): interval is IntervalType {
+  return ["1m", "5m", "15m", "30m", "1h", "1d", "1wk", "1mo"].includes(
+    interval,
+  );
+}

package/src/utils/index.ts

@@ -0,0 +1,9 @@
+export { OutputFormatter, createFormatter } from "./output";
+export {
+  parseDate,
+  formatDate,
+  getPeriodRange,
+  getDefaultInterval,
+  isValidPeriod,
+  isValidInterval,
+} from "./date";

package/src/utils/output.ts

@@ -0,0 +1,40 @@
+import type { ChartResultArrayQuote } from "yahoo-finance2/modules/chart";
+import type { IndicatorDataPoint } from "../types";
+
+/**
+ * Output formatter for JSON and table formats
+ */
+export class OutputFormatter {
+  private useTable: boolean;
+  private pretty: boolean;
+
+  constructor(options: { table?: boolean; pretty?: boolean } = {}) {
+    this.useTable = options.table ?? false;
+    this.pretty = options.pretty ?? true;
+  }
+
+  /**
+   * Format any data based on output settings
+   */
+  format(data: unknown): string {
+    return this.formatJson(data);
+  }
+
+  /**
+   * Format as JSON string
+   */
+  private formatJson(data: unknown): string {
+    return JSON.stringify(data, null, this.pretty ? 2 : 0);
+  }
+
+  // TODO format as table
+}
+
+/**
+ * Create an output formatter with options
+ */
+export function createFormatter(
+  options: { table?: boolean; pretty?: boolean } = {},
+): OutputFormatter {
+  return new OutputFormatter(options);
+}

package/tsconfig.json

@@ -0,0 +1,29 @@
+{
+  "compilerOptions": {
+    // Environment setup & latest features
+    "lib": ["ESNext"],
+    "target": "ESNext",
+    "module": "Preserve",
+    "moduleDetection": "force",
+    "jsx": "react-jsx",
+    "allowJs": true,
+
+    // Bundler mode
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "noEmit": true,
+
+    // Best practices
+    "strict": true,
+    "skipLibCheck": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedIndexedAccess": true,
+    "noImplicitOverride": true,
+
+    // Some stricter flags (disabled by default)
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "noPropertyAccessFromIndexSignature": false
+  }
+}