@rivascva/dt-idl 1.0.7

package/ts/services/dt-market-service.ts

@@ -0,0 +1,366 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+
+export interface paths {
+  "/stocks/{symbol}": {
+    /** @description Gets the full quote for the given stock symbol */
+    get: operations["getStock"];
+  };
+  "/stocks/{symbol}/history": {
+    /** @description Gets the price history chart for the given stock symbol */
+    get: operations["getStockHistory"];
+  };
+  "/stocks/by-symbols/{symbols}": {
+    /** @description Gets the simple quotes for the given stock symbols */
+    get: operations["getStocksBySymbols"];
+  };
+  "/stocks/by-exchange/{exchange}": {
+    /** @description Gets the simple quotes for the given stock exchange */
+    get: operations["getStocksByExchange"];
+  };
+  "/stocks/search": {
+    /** @description Gets the simple quotes that fuzzy match the search query */
+    get: operations["searchStocks"];
+  };
+  "/news": {
+    /** @description Gets the latest news articles */
+    get: operations["getNews"];
+  };
+  "/news/by-symbols/{symbols}": {
+    /** @description Gets the latest stock news articles for the given stock symbols */
+    get: operations["getNewsBySymbols"];
+  };
+}
+
+export type webhooks = Record<string, never>;
+
+export interface components {
+  schemas: {
+    /** @description A simple stock quote */
+    SimpleQuote: {
+      /** @example AAPL */
+      symbol: string;
+      /** @example Apple Inc */
+      name: string;
+      /**
+       * Format: double
+       * @example 182.25
+       */
+      price: number;
+      /**
+       * Format: double
+       * @example 1.25
+       */
+      percentChange: number;
+    };
+    /** @description A full stock quote */
+    FullQuote: components["schemas"]["SimpleQuote"] & {
+      /**
+       * Format: double
+       * @example 180.75
+       */
+      previousClose: number;
+      /**
+       * Format: double
+       * @example 180.75
+       */
+      open: number;
+      /**
+       * Format: double
+       * @example 178.25
+       */
+      dayLow: number;
+      /**
+       * Format: double
+       * @example 185.75
+       */
+      dayHigh: number;
+      /**
+       * Format: double
+       * @example 165.25
+       */
+      weekLow52: number;
+      /**
+       * Format: double
+       * @example 192.75
+       */
+      weekHigh52: number;
+      /**
+       * Format: int64
+       * @example 164000000
+       */
+      volume: number;
+      /**
+       * Format: int64
+       * @example 62000000
+       */
+      averageVolume: number;
+      /**
+       * Format: int64
+       * @example 28000000000
+       */
+      marketCap: number;
+      /**
+       * Format: double
+       * @example 28.25
+       */
+      pe: number;
+      /**
+       * Format: double
+       * @example 6.75
+       */
+      eps: number;
+      /** @example Apple designs and manufactures smartphones. */
+      description: string;
+      /** @example Timothy Cook */
+      ceo: string;
+      /** @example Technology */
+      sector: string;
+      /** @example Consumer Electronics */
+      industry: string;
+      /** @example Cupertino */
+      city: string;
+      /** @example California */
+      state: string;
+      /** @example USA */
+      country: string;
+    };
+    /** @description A stock history chart entry */
+    HistoryChartEntry: {
+      /** @example "2024-12-24T02:30:00.000Z" */
+      date: string;
+      /**
+       * Format: double
+       * @example 175.25
+       */
+      open: number;
+      /**
+       * Format: double
+       * @example 172.75
+       */
+      low: number;
+      /**
+       * Format: double
+       * @example 185.25
+       */
+      high: number;
+      /**
+       * Format: double
+       * @example 180.75
+       */
+      close: number;
+    };
+    /** @description A news article */
+    NewsArticle: {
+      /** @example Apple Watches Recalled */
+      title: string;
+      /** @example Apple Watches are being recalled worldwide */
+      description: string;
+      /**
+       * Format: int64
+       * @example 1709500000000
+       */
+      date: number;
+      /** @example https://news.com/articles/abc */
+      link: string;
+      /** @example https://news.com/articles/abc/image.png */
+      thumbnail: string;
+    };
+    /** @description A stock news article */
+    StockNewsArticle: components["schemas"]["NewsArticle"] & {
+      /** @example AAPL */
+      symbol: string;
+    };
+    /** @description A generic error */
+    Error: {
+      /**
+       * Format: int64
+       * @example 500
+       */
+      status: number;
+      /** @example ERROR */
+      code: components["schemas"]["ErrorCode"];
+      /** @example Error */
+      message: string;
+    };
+    /** @enum {string} */
+    ErrorCode: "ERROR";
+    /** @enum {string} */
+    HistoryTimeframe: "MIN5" | "MIN15" | "MIN30" | "HOUR1" | "HOUR4" | "DAY1";
+  };
+  responses: {
+    /** @description The resource was not found */
+    NotFound: {
+      content: {
+        "application/json": components["schemas"]["Error"];
+      };
+    };
+    /** @description There was an internal server error */
+    InternalServerError: {
+      content: {
+        "application/json": components["schemas"]["Error"];
+      };
+    };
+  };
+  parameters: never;
+  requestBodies: never;
+  headers: never;
+  pathItems: never;
+}
+
+export type $defs = Record<string, never>;
+
+export type external = Record<string, never>;
+
+export interface operations {
+
+  /** @description Gets the full quote for the given stock symbol */
+  getStock: {
+    parameters: {
+      path: {
+        /** @description The stock symbol */
+        symbol: string;
+      };
+    };
+    responses: {
+      /** @description Success */
+      200: {
+        content: {
+          "application/json": components["schemas"]["FullQuote"];
+        };
+      };
+      404: components["responses"]["NotFound"];
+      500: components["responses"]["InternalServerError"];
+    };
+  };
+  /** @description Gets the price history chart for the given stock symbol */
+  getStockHistory: {
+    parameters: {
+      query: {
+        /** @description The stock history timeframe */
+        timeframe: components["schemas"]["HistoryTimeframe"];
+        /** @description The stock history from date */
+        from: string;
+        /** @description The stock history to date */
+        to: string;
+      };
+      path: {
+        /** @description The stock symbol */
+        symbol: string;
+      };
+    };
+    responses: {
+      /** @description Success */
+      200: {
+        content: {
+          "application/json": components["schemas"]["HistoryChartEntry"][];
+        };
+      };
+      404: components["responses"]["NotFound"];
+      500: components["responses"]["InternalServerError"];
+    };
+  };
+  /** @description Gets the simple quotes for the given stock symbols */
+  getStocksBySymbols: {
+    parameters: {
+      path: {
+        /** @description The stock symbols */
+        symbols: string;
+      };
+    };
+    responses: {
+      /** @description Success */
+      200: {
+        content: {
+          "application/json": components["schemas"]["SimpleQuote"][];
+        };
+      };
+      404: components["responses"]["NotFound"];
+      500: components["responses"]["InternalServerError"];
+    };
+  };
+  /** @description Gets the simple quotes for the given stock exchange */
+  getStocksByExchange: {
+    parameters: {
+      path: {
+        /** @description The stock exchange */
+        exchange: string;
+      };
+    };
+    responses: {
+      /** @description Success */
+      200: {
+        content: {
+          "application/json": components["schemas"]["SimpleQuote"][];
+        };
+      };
+      404: components["responses"]["NotFound"];
+      500: components["responses"]["InternalServerError"];
+    };
+  };
+  /** @description Gets the simple quotes that fuzzy match the search query */
+  searchStocks: {
+    parameters: {
+      query: {
+        /** @description The search query */
+        query: string;
+        /** @description The maximum number of search results */
+        limit?: number;
+      };
+    };
+    responses: {
+      /** @description Success */
+      200: {
+        content: {
+          "application/json": components["schemas"]["SimpleQuote"][];
+        };
+      };
+      404: components["responses"]["NotFound"];
+      500: components["responses"]["InternalServerError"];
+    };
+  };
+  /** @description Gets the latest news articles */
+  getNews: {
+    parameters: {
+      query?: {
+        /** @description The maximum number of articles */
+        limit?: number;
+      };
+    };
+    responses: {
+      /** @description Success */
+      200: {
+        content: {
+          "application/json": components["schemas"]["NewsArticle"][];
+        };
+      };
+      500: components["responses"]["InternalServerError"];
+    };
+  };
+  /** @description Gets the latest stock news articles for the given stock symbols */
+  getNewsBySymbols: {
+    parameters: {
+      query?: {
+        /** @description The maximum number of articles */
+        limit?: number;
+      };
+      path: {
+        /** @description The stock symbols */
+        symbols: string;
+      };
+    };
+    responses: {
+      /** @description Success */
+      200: {
+        content: {
+          "application/json": components["schemas"]["StockNewsArticle"][];
+        };
+      };
+      404: components["responses"]["NotFound"];
+      500: components["responses"]["InternalServerError"];
+    };
+  };
+}

package/ts/services/dt-trade-service.ts

@@ -0,0 +1,309 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+
+export interface paths {
+  "/users": {
+    /** @description Gets all users */
+    get: operations["getUsers"];
+    /** @description Adds a new user */
+    post: operations["addUser"];
+  };
+  "/users/{userId}": {
+    /** @description Gets a user */
+    get: operations["getUser"];
+    /** @description Updates an existing user */
+    put: operations["updateUser"];
+  };
+  "/users/{userId}/portfolios": {
+    /** @description Gets all portfolios of a user */
+    get: operations["getUserPortfolios"];
+  };
+  "/orders": {
+    /** @description Add a new order */
+    post: operations["addOrder"];
+  };
+}
+
+export type webhooks = Record<string, never>;
+
+export interface components {
+  schemas: {
+    /** @description A user payload */
+    UserPayload: {
+      /** @example sam.smith@example.com */
+      email: string;
+      /** @example Sam Smith */
+      name: string;
+    };
+    /** @description A user */
+    User: components["schemas"]["UserPayload"] & {
+      /** @example 123456 */
+      id: string;
+      /**
+       * Format: int64
+       * @example 1713398544000
+       */
+      dateCreated: number;
+      /**
+       * Format: int64
+       * @example 1713398544000
+       */
+      dateUpdated: number;
+    };
+    /** @description A trading portfolio */
+    Portfolio: {
+      /** @example 123456 */
+      id: string;
+      /** @example 123456 */
+      userId: string;
+      /** @example PERSONAL */
+      type: components["schemas"]["PortfolioType"];
+      /**
+       * Format: double
+       * @example 10500.25
+       */
+      cash: number;
+      holdings: components["schemas"]["Holding"][];
+      /**
+       * Format: int64
+       * @example 1713398544000
+       */
+      dateCreated: number;
+      /**
+       * Format: int64
+       * @example 1713398544000
+       */
+      dateUpdated: number;
+    };
+    /** @description An active stock holding */
+    Holding: {
+      /** @example 123456 */
+      id: string;
+      /** @example AAPL */
+      symbol: string;
+      /**
+       * Format: double
+       * @example 182.25
+       */
+      averagePrice: number;
+      /**
+       * Format: int64
+       * @example 10
+       */
+      quantity: number;
+      /**
+       * Format: int64
+       * @example 1713398544000
+       */
+      dateCreated: number;
+      /**
+       * Format: int64
+       * @example 1713398544000
+       */
+      dateUpdated: number;
+    };
+    /** @description A trade order payload */
+    OrderPayload: {
+      /** @example 123456 */
+      portfolioId: string;
+      /** @example BUY */
+      type: components["schemas"]["OrderType"];
+      /** @example AAPL */
+      symbol: string;
+      /**
+       * Format: double
+       * @example 182.25
+       */
+      targetPrice: number;
+      /**
+       * Format: int64
+       * @example 10
+       */
+      quantity: number;
+    };
+    /** @description A trade order */
+    Order: components["schemas"]["OrderPayload"] & {
+      /** @example 123456 */
+      id: string;
+      /**
+       * Format: double
+       * @example 182.25
+       */
+      actualPrice: number;
+      /**
+       * Format: int64
+       * @example 1713398544000
+       */
+      dateCreated: number;
+    };
+    /** @description A generic error */
+    Error: {
+      /**
+       * Format: int64
+       * @example 500
+       */
+      status: number;
+      /** @example ERROR */
+      code: components["schemas"]["ErrorCode"];
+      /** @example Error */
+      message: string;
+    };
+    /** @enum {string} */
+    ErrorCode: "ERROR" | "NOT_ENOUGH_CASH" | "NOT_ENOUGH_SHARES" | "REQS_NOT_MET";
+    /** @enum {string} */
+    PortfolioType: "PERSONAL" | "COMPETITIVE";
+    /** @enum {string} */
+    OrderType: "BUY_MARKET" | "BUY_LIMIT" | "BUY_STOP" | "SELL_MARKET" | "SELL_LIMIT" | "SELL_STOP";
+  };
+  responses: {
+    /** @description The resource was not found */
+    NotFound: {
+      content: {
+        "application/json": components["schemas"]["Error"];
+      };
+    };
+    /** @description Invalid request payload */
+    BadRequest: {
+      content: {
+        "application/json": components["schemas"]["Error"];
+      };
+    };
+    /** @description There was an internal server error */
+    InternalServerError: {
+      content: {
+        "application/json": components["schemas"]["Error"];
+      };
+    };
+  };
+  parameters: never;
+  requestBodies: never;
+  headers: never;
+  pathItems: never;
+}
+
+export type $defs = Record<string, never>;
+
+export type external = Record<string, never>;
+
+export interface operations {
+
+  /** @description Gets all users */
+  getUsers: {
+    responses: {
+      /** @description Success */
+      200: {
+        content: {
+          "application/json": components["schemas"]["User"][];
+        };
+      };
+      404: components["responses"]["NotFound"];
+      500: components["responses"]["InternalServerError"];
+    };
+  };
+  /** @description Adds a new user */
+  addUser: {
+    /** @description The request body to add a user */
+    requestBody: {
+      content: {
+        "application/json": components["schemas"]["UserPayload"];
+      };
+    };
+    responses: {
+      /** @description Added */
+      201: {
+        content: {
+          "application/json": components["schemas"]["User"];
+        };
+      };
+      400: components["responses"]["BadRequest"];
+      500: components["responses"]["InternalServerError"];
+    };
+  };
+  /** @description Gets a user */
+  getUser: {
+    parameters: {
+      path: {
+        /** @description The user id */
+        userId: string;
+      };
+    };
+    responses: {
+      /** @description Success */
+      200: {
+        content: {
+          "application/json": components["schemas"]["User"];
+        };
+      };
+      404: components["responses"]["NotFound"];
+      500: components["responses"]["InternalServerError"];
+    };
+  };
+  /** @description Updates an existing user */
+  updateUser: {
+    parameters: {
+      path: {
+        /** @description The user id */
+        userId: string;
+      };
+    };
+    /** @description The request body to updated a user */
+    requestBody: {
+      content: {
+        "application/json": components["schemas"]["UserPayload"];
+      };
+    };
+    responses: {
+      /** @description Success */
+      200: {
+        content: {
+          "application/json": components["schemas"]["User"];
+        };
+      };
+      400: components["responses"]["BadRequest"];
+      404: components["responses"]["NotFound"];
+      500: components["responses"]["InternalServerError"];
+    };
+  };
+  /** @description Gets all portfolios of a user */
+  getUserPortfolios: {
+    parameters: {
+      path: {
+        /** @description The user id */
+        userId: string;
+      };
+    };
+    responses: {
+      /** @description Success */
+      200: {
+        content: {
+          "application/json": components["schemas"]["Portfolio"][];
+        };
+      };
+      404: components["responses"]["NotFound"];
+      500: components["responses"]["InternalServerError"];
+    };
+  };
+  /** @description Add a new order */
+  addOrder: {
+    /** @description The request body to add an order */
+    requestBody: {
+      content: {
+        "application/json": components["schemas"]["OrderPayload"];
+      };
+    };
+    responses: {
+      /** @description Added */
+      201: {
+        content: {
+          "application/json": components["schemas"]["Order"];
+        };
+      };
+      400: components["responses"]["BadRequest"];
+      404: components["responses"]["NotFound"];
+      500: components["responses"]["InternalServerError"];
+    };
+  };
+}

package/ts/types/index.ts

@@ -0,0 +1 @@
+export * from './types';

package/ts/types/types.ts

@@ -0,0 +1,11 @@
+import { components as MarketServiceComponents } from '@ts/services/dt-market-service';
+import { components as TradeServiceComponents } from '@ts/services/dt-trade-service';
+
+// Market Service Types
+export type SimpleQuotes = MarketServiceComponents['schemas']['SimpleQuote'];
+export type FullQuotes = MarketServiceComponents['schemas']['FullQuote'];
+export type MarketServiceError = MarketServiceComponents['schemas']['Error'];
+
+// Trade Service Types
+export type User = TradeServiceComponents['schemas']['User'];
+export type TradeSErviceError = TradeServiceComponents['schemas']['Error'];

package/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "Node10",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "noUncheckedIndexedAccess": true,
+    "baseUrl": ".",
+    "paths": {
+      "@ts/*": [
+        "ts/*"
+      ]
+    }
+  },
+  "include": [
+    "ts/**/*",
+    "rollup.config.ts"
+  ]
+}