reportify-sdk 0.1.0

package/dist/index.mjs

@@ -0,0 +1,637 @@
+// src/stock.ts
+var StockModule = class {
+  constructor(client) {
+    this.client = client;
+  }
+  // ===========================================================================
+  // Company Information
+  // ===========================================================================
+  /**
+   * Get company overview including business description, sector, and key metrics
+   *
+   * @param symbol - Stock symbol (e.g., "US:AAPL", "HK:0700")
+   */
+  async overview(symbol) {
+    return this.client.post("/v1/stock/company-overview", {
+      symbol
+    });
+  }
+  /**
+   * Get list of major shareholders
+   *
+   * @param symbol - Stock symbol
+   */
+  async shareholders(symbol) {
+    const response = await this.client.post(
+      "/v1/stock/company-shareholders",
+      { symbol }
+    );
+    return Array.isArray(response) ? response : response.shareholders || [];
+  }
+  // ===========================================================================
+  // Financial Statements
+  // ===========================================================================
+  /**
+   * Get income statement data
+   *
+   * @param symbol - Stock symbol
+   * @param options.period - "annual" or "quarterly"
+   * @param options.limit - Number of periods to return
+   */
+  async incomeStatement(symbol, options = {}) {
+    const response = await this.client.post(
+      "/v1/stock/company-income-statement",
+      {
+        symbol,
+        period: options.period || "annual",
+        limit: options.limit || 10
+      }
+    );
+    return this.normalizeArrayResponse(response);
+  }
+  /**
+   * Get balance sheet data
+   *
+   * @param symbol - Stock symbol
+   * @param options.period - "annual" or "quarterly"
+   * @param options.limit - Number of periods to return
+   */
+  async balanceSheet(symbol, options = {}) {
+    const response = await this.client.post(
+      "/v1/stock/company-balance-sheet",
+      {
+        symbol,
+        period: options.period || "annual",
+        limit: options.limit || 10
+      }
+    );
+    return this.normalizeArrayResponse(response);
+  }
+  /**
+   * Get cash flow statement data
+   *
+   * @param symbol - Stock symbol
+   * @param options.period - "annual" or "quarterly"
+   * @param options.limit - Number of periods to return
+   */
+  async cashflowStatement(symbol, options = {}) {
+    const response = await this.client.post(
+      "/v1/stock/company-cashflow-statement",
+      {
+        symbol,
+        period: options.period || "annual",
+        limit: options.limit || 10
+      }
+    );
+    return this.normalizeArrayResponse(response);
+  }
+  /**
+   * Get revenue breakdown by segment, product, or region
+   *
+   * @param symbol - Stock symbol
+   * @param options.breakdownType - Type of breakdown
+   */
+  async revenueBreakdown(symbol, options = {}) {
+    const response = await this.client.post(
+      "/v1/stock/company-revenue-breakdown",
+      {
+        symbol,
+        breakdown_type: options.breakdownType || "segment"
+      }
+    );
+    return this.normalizeArrayResponse(response);
+  }
+  // ===========================================================================
+  // Price Data
+  // ===========================================================================
+  /**
+   * Get historical stock prices
+   *
+   * @param symbol - Stock symbol
+   * @param options - Query options
+   */
+  async prices(symbol, options = {}) {
+    const response = await this.client.post(
+      "/v1/stock/company-prices",
+      {
+        symbol,
+        start_date: options.startDate,
+        end_date: options.endDate,
+        limit: options.limit || 100
+      }
+    );
+    return this.normalizeArrayResponse(response);
+  }
+  /**
+   * Get K-line (candlestick) data
+   *
+   * @param symbol - Stock symbol
+   * @param options - Query options
+   */
+  async kline(symbol, options = {}) {
+    const response = await this.client.post(
+      "/v1/stock/kline",
+      {
+        symbol,
+        interval: options.interval || "1d",
+        adjust: options.adjust || "forward",
+        start_date: options.startDate,
+        end_date: options.endDate,
+        limit: options.limit || 100
+      }
+    );
+    return this.normalizeArrayResponse(response);
+  }
+  /**
+   * Get real-time stock quotes
+   *
+   * @param symbols - Single symbol or array of symbols
+   */
+  async quote(symbols) {
+    const symbolList = Array.isArray(symbols) ? symbols : [symbols];
+    const response = await this.client.post(
+      "/v1/stock/quote-realtime",
+      { symbols: symbolList }
+    );
+    return this.normalizeArrayResponse(response);
+  }
+  /**
+   * Get stock index prices
+   *
+   * @param symbol - Index symbol
+   * @param options - Query options
+   */
+  async indexPrices(symbol, options = {}) {
+    const response = await this.client.post(
+      "/v1/stock/index-prices",
+      {
+        symbol,
+        start_date: options.startDate,
+        end_date: options.endDate,
+        limit: options.limit || 100
+      }
+    );
+    return this.normalizeArrayResponse(response);
+  }
+  // ===========================================================================
+  // Screening and Calendar
+  // ===========================================================================
+  /**
+   * Screen stocks based on various criteria
+   */
+  async screener(options = {}) {
+    const response = await this.client.post(
+      "/v1/stock/screener",
+      {
+        market: options.market,
+        sector: options.sector,
+        min_market_cap: options.minMarketCap,
+        max_market_cap: options.maxMarketCap,
+        min_pe: options.minPe,
+        max_pe: options.maxPe,
+        limit: options.limit || 50
+      }
+    );
+    return this.normalizeArrayResponse(response);
+  }
+  /**
+   * Get earnings announcement calendar
+   */
+  async earningsCalendar(options = {}) {
+    const response = await this.client.post(
+      "/v1/stock/earnings-calendar",
+      {
+        area: options.area || "us",
+        start_date: options.startDate,
+        end_date: options.endDate,
+        symbol: options.symbol
+      }
+    );
+    return this.normalizeArrayResponse(response);
+  }
+  /**
+   * Get Hong Kong IPO calendar
+   */
+  async ipoCalendarHK(status = "Filing") {
+    const response = await this.client.post(
+      "/v1/stock/ipo-calendar-hk",
+      { status }
+    );
+    return this.normalizeArrayResponse(response);
+  }
+  // ===========================================================================
+  // Helper Methods
+  // ===========================================================================
+  normalizeArrayResponse(response) {
+    if (Array.isArray(response)) {
+      return response;
+    }
+    if ("data" in response) {
+      return response.data;
+    }
+    if ("items" in response) {
+      return response.items;
+    }
+    if ("records" in response) {
+      return response.records;
+    }
+    return [];
+  }
+};
+
+// src/timeline.ts
+var TimelineModule = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Get timeline for followed companies
+   *
+   * Returns recent content related to companies the user is following.
+   *
+   * @param options.num - Number of items to return (default: 10, max: 100)
+   */
+  async companies(options = {}) {
+    const response = await this.client.post(
+      "/v1/tools/timeline/companies",
+      { num: options.num || 10 }
+    );
+    return response.docs || [];
+  }
+  /**
+   * Get timeline for followed topics
+   *
+   * Returns recent content related to custom topics the user is following.
+   *
+   * @param options.num - Number of items to return
+   */
+  async topics(options = {}) {
+    const response = await this.client.post(
+      "/v1/tools/timeline/topics",
+      { num: options.num || 10 }
+    );
+    return response.docs || [];
+  }
+  /**
+   * Get timeline for followed professional institutes
+   *
+   * Returns recent content from research institutions, banks, etc.
+   *
+   * @param options.num - Number of items to return
+   */
+  async institutes(options = {}) {
+    const response = await this.client.post(
+      "/v1/tools/timeline/institutes",
+      { num: options.num || 10 }
+    );
+    return response.docs || [];
+  }
+  /**
+   * Get timeline for followed public media
+   *
+   * Returns recent content from public media accounts.
+   *
+   * @param options.num - Number of items to return
+   */
+  async publicMedia(options = {}) {
+    const response = await this.client.post(
+      "/v1/tools/timeline/public-media",
+      { num: options.num || 10 }
+    );
+    return response.docs || [];
+  }
+  /**
+   * Get timeline for followed social media
+   *
+   * Returns recent content from social media accounts.
+   *
+   * @param options.num - Number of items to return
+   */
+  async socialMedia(options = {}) {
+    const response = await this.client.post(
+      "/v1/tools/timeline/social-media",
+      { num: options.num || 10 }
+    );
+    return response.docs || [];
+  }
+};
+
+// src/kb.ts
+var KBModule = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Search user's knowledge base
+   *
+   * Performs semantic search across documents the user has uploaded.
+   *
+   * @param query - Search query string
+   * @param options - Search options
+   *
+   * @example
+   * ```typescript
+   * const results = await client.kb.search('quarterly revenue', { num: 5 });
+   * results.forEach(chunk => console.log(chunk.content));
+   * ```
+   */
+  async search(query, options = {}) {
+    const response = await this.client.post(
+      "/v1/tools/kb/search",
+      {
+        query,
+        folder_ids: options.folderIds,
+        doc_ids: options.docIds,
+        start_date: options.startDate,
+        end_date: options.endDate,
+        num: options.num || 10
+      }
+    );
+    return response.chunks || [];
+  }
+};
+
+// src/docs.ts
+var DocsModule = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Get document content and metadata
+   *
+   * @param docId - Document ID
+   */
+  async get(docId) {
+    return this.client.get(`/v1/docs/${docId}`);
+  }
+  /**
+   * Get document summary
+   *
+   * @param docId - Document ID
+   */
+  async summary(docId) {
+    return this.client.get(`/v1/docs/${docId}/summary`);
+  }
+  /**
+   * Get raw document content
+   *
+   * @param docId - Document ID
+   */
+  async rawContent(docId) {
+    return this.client.get(`/v1/docs/${docId}/raw-content`);
+  }
+  /**
+   * List documents with filters
+   *
+   * @param options - Filter options
+   */
+  async list(options = {}) {
+    const response = await this.client.post("/v1/docs", {
+      symbols: options.symbols,
+      categories: options.categories,
+      start_date: options.startDate,
+      end_date: options.endDate,
+      page_num: options.page || 1,
+      page_size: options.pageSize || 20
+    });
+    return {
+      items: response.docs || [],
+      total: response.total || 0,
+      page: response.page_num || 1,
+      pageSize: response.page_size || 20
+    };
+  }
+  /**
+   * Search document chunks semantically
+   *
+   * @param query - Search query string
+   * @param options - Search options
+   */
+  async searchChunks(query, options = {}) {
+    const response = await this.client.post("/v1/search/chunks", {
+      query,
+      symbols: options.symbols,
+      categories: options.categories,
+      start_date: options.startDate,
+      end_date: options.endDate,
+      num: options.num || 10
+    });
+    return response.chunks || [];
+  }
+};
+
+// src/types.ts
+var ReportifyError = class extends Error {
+  statusCode;
+  constructor(message, statusCode) {
+    super(message);
+    this.name = "ReportifyError";
+    this.statusCode = statusCode;
+  }
+};
+var AuthenticationError = class extends ReportifyError {
+  constructor(message = "Invalid or missing API key") {
+    super(message, 401);
+    this.name = "AuthenticationError";
+  }
+};
+var RateLimitError = class extends ReportifyError {
+  constructor(message = "Rate limit exceeded") {
+    super(message, 429);
+    this.name = "RateLimitError";
+  }
+};
+var NotFoundError = class extends ReportifyError {
+  constructor(message = "Resource not found") {
+    super(message, 404);
+    this.name = "NotFoundError";
+  }
+};
+var APIError = class extends ReportifyError {
+  constructor(message, statusCode) {
+    super(message, statusCode);
+    this.name = "APIError";
+  }
+};
+
+// src/client.ts
+var DEFAULT_BASE_URL = "https://api.reportify.cn";
+var DEFAULT_TIMEOUT = 3e4;
+var Reportify = class {
+  apiKey;
+  baseUrl;
+  timeout;
+  // Sub-modules
+  stock;
+  timeline;
+  kb;
+  docs;
+  constructor(config) {
+    if (!config.apiKey) {
+      throw new AuthenticationError("API key is required");
+    }
+    this.apiKey = config.apiKey;
+    this.baseUrl = (config.baseUrl || DEFAULT_BASE_URL).replace(/\/$/, "");
+    this.timeout = config.timeout || DEFAULT_TIMEOUT;
+    this.stock = new StockModule(this);
+    this.timeline = new TimelineModule(this);
+    this.kb = new KBModule(this);
+    this.docs = new DocsModule(this);
+  }
+  /**
+   * Make an HTTP request to the API
+   */
+  async request(method, path, options = {}) {
+    const url = new URL(path, this.baseUrl);
+    if (options.params) {
+      Object.entries(options.params).forEach(([key, value]) => {
+        if (value !== void 0 && value !== null) {
+          url.searchParams.set(key, String(value));
+        }
+      });
+    }
+    const controller = new AbortController();
+    const timeoutId = setTimeout(() => controller.abort(), this.timeout);
+    try {
+      const response = await fetch(url.toString(), {
+        method,
+        headers: {
+          Authorization: `Bearer ${this.apiKey}`,
+          "Content-Type": "application/json",
+          "User-Agent": "reportify-sdk-js/0.1.0"
+        },
+        body: options.body ? JSON.stringify(options.body) : void 0,
+        signal: controller.signal
+      });
+      clearTimeout(timeoutId);
+      if (response.status === 401) {
+        throw new AuthenticationError();
+      }
+      if (response.status === 429) {
+        throw new RateLimitError();
+      }
+      if (response.status === 404) {
+        throw new NotFoundError();
+      }
+      if (!response.ok) {
+        let errorMessage = response.statusText;
+        try {
+          const errorData = await response.json();
+          errorMessage = errorData.detail || errorData.message || errorMessage;
+        } catch {
+        }
+        throw new APIError(errorMessage, response.status);
+      }
+      return response.json();
+    } catch (error) {
+      clearTimeout(timeoutId);
+      if (error instanceof Error && error.name === "AbortError") {
+        throw new APIError("Request timeout", 408);
+      }
+      throw error;
+    }
+  }
+  /**
+   * Make a GET request
+   */
+  async get(path, params) {
+    return this.request("GET", path, { params });
+  }
+  /**
+   * Make a POST request
+   */
+  async post(path, body) {
+    return this.request("POST", path, { body });
+  }
+  // ===========================================================================
+  // Search Methods
+  // ===========================================================================
+  /**
+   * Search documents across all categories
+   *
+   * @param query - Search query string
+   * @param options - Search options
+   * @returns List of matching documents
+   *
+   * @example
+   * ```typescript
+   * const docs = await client.search('Tesla earnings', { num: 10 });
+   * docs.forEach(doc => console.log(doc.title));
+   * ```
+   */
+  async search(query, options = {}) {
+    const response = await this.post("/v2/search", {
+      query,
+      num: options.num || 10,
+      categories: options.categories,
+      symbols: options.symbols,
+      start_date: options.startDate,
+      end_date: options.endDate
+    });
+    return response.docs || [];
+  }
+  /**
+   * Search news articles
+   */
+  async searchNews(query, options = {}) {
+    const response = await this.post("/v2/search/news", {
+      query,
+      num: options.num || 10,
+      symbols: options.symbols,
+      start_date: options.startDate,
+      end_date: options.endDate
+    });
+    return response.docs || [];
+  }
+  /**
+   * Search research reports
+   */
+  async searchReports(query, options = {}) {
+    const response = await this.post("/v2/search/reports", {
+      query,
+      num: options.num || 10,
+      symbols: options.symbols,
+      start_date: options.startDate,
+      end_date: options.endDate
+    });
+    return response.docs || [];
+  }
+  /**
+   * Search company filings
+   */
+  async searchFilings(query, options = {}) {
+    const response = await this.post("/v2/search/filings", {
+      query,
+      num: options.num || 10,
+      symbols: options.symbols,
+      start_date: options.startDate,
+      end_date: options.endDate
+    });
+    return response.docs || [];
+  }
+  /**
+   * Search earnings call transcripts
+   */
+  async searchTranscripts(query, options = {}) {
+    const response = await this.post("/v2/search/conference-calls", {
+      query,
+      num: options.num || 10,
+      symbols: options.symbols,
+      start_date: options.startDate,
+      end_date: options.endDate
+    });
+    return response.docs || [];
+  }
+};
+export {
+  APIError,
+  AuthenticationError,
+  DocsModule,
+  KBModule,
+  NotFoundError,
+  RateLimitError,
+  Reportify,
+  ReportifyError,
+  StockModule,
+  TimelineModule
+};

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "reportify-sdk",
+  "version": "0.1.0",
+  "description": "TypeScript SDK for Reportify API - Financial data and document search",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts --clean",
+    "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
+    "lint": "eslint src/",
+    "test": "vitest run",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "reportify",
+    "finance",
+    "stock",
+    "api",
+    "sdk",
+    "financial-data"
+  ],
+  "author": "Reportify <support@reportify.cn>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/reportify/reportify-sdk-js"
+  },
+  "homepage": "https://reportify.cn",
+  "bugs": {
+    "url": "https://github.com/reportify/reportify-sdk-js/issues"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "@types/node": "^20.10.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.3.0",
+    "vitest": "^1.0.0"
+  }
+}