@rivascva/dt-idl 1.1.28 → 1.1.30

package/Makefile

@@ -1,4 +1,3 @@
-install:
-	brew install pre-commit
+pre-commit-install:
 	pre-commit install --hook-type pre-commit --config .githooks/pre-commit-config.yaml
 	pre-commit install --hook-type pre-push --config .githooks/pre-push-config.yaml

package/README.md

@@ -0,0 +1,63 @@
+# Dream Trade Interface Description Language (IDL)
+
+The API language for all Dream Trade microservices.
+
+[![NPM Version](https://img.shields.io/npm/v/@rivascva/dt-idl.svg?style=flat)](https://www.npmjs.com/package/@rivascva/dt-idl)
+
+## Setup
+
+### 1. Install `mise`
+
+- Install the `mise` CLI
+
+```bash
+brew install mise
+```
+
+- Add the `mise` activation command to your `.zshrc`
+
+```bash
+echo 'eval "$(mise activate zsh)"' >> ~/.zshrc
+```
+
+- Reload your `.zshrc` config (or restart your shell)
+
+```bash
+source ~/.zshrc
+```
+
+> Note: You can follow the official installation [docs](https://mise.jdx.dev/getting-started.html) for other options
+
+### 2. Install project dependencies
+
+- Use `mise` to install project dependencies
+
+```bash
+mise install
+```
+
+### 3. Install `pre-commit` hooks
+
+- Use the makefile `pre-commit-install` command
+
+```bash
+make pre-commit-install
+```
+
+### 4. Install `node` modules
+
+- Install all `node` modules
+
+```bash
+npm install
+```
+
+### Common Scripts
+
+- `npm run lint` - Lints all typescript files
+- `npm run check` - Checks the syntax of all typescript files
+- `npm run gen` - Generates typescript service clients
+
+### Deployments
+
+Any merge to `main` with changes to the `ts/*` directory will trigger an automatic deployment to `npm`

package/dist/index.d.ts

@@ -274,7 +274,7 @@ interface components$1 {
             country: string;
         };
         /** @description A stock history chart entry */
-        HistoryChartEntry: {
+        StockHistoryEntry: {
             /** @example 2024-12-24T02:30:00Z */
             date: string;
             /**
@@ -334,7 +334,7 @@ interface components$1 {
         /** @enum {string} */
         ErrorCode: "ERROR";
         /** @enum {string} */
-        HistoryTimeframe: "MIN5" | "MIN15" | "MIN30" | "HOUR1" | "HOUR4" | "DAY1";
+        StockHistoryTimeframe: "MIN5" | "MIN15" | "MIN30" | "HOUR1" | "HOUR4" | "DAY1";
     };
     responses: {
         /** @description The resource was not found */
@@ -391,7 +391,7 @@ interface operations$1 {
         parameters: {
             query: {
                 /** @description The stock history timeframe */
-                timeframe: components$1["schemas"]["HistoryTimeframe"];
+                timeframe: components$1["schemas"]["StockHistoryTimeframe"];
                 /** @description The stock history from date */
                 from: string;
                 /** @description The stock history to date */
@@ -412,7 +412,7 @@ interface operations$1 {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components$1["schemas"]["HistoryChartEntry"][];
+                    "application/json": components$1["schemas"]["StockHistoryEntry"][];
                 };
             };
             404: components$1["responses"]["NotFound"];
@@ -697,6 +697,10 @@ interface components {
             email: string;
             /** @example Sam Smith */
             name: string;
+            /** @example USA */
+            country: string;
+            /** @example https://www.assets.com/image.png */
+            imageUrl: string;
         };
         /** @description Payload to update an existing user */
         UpdateUserPayload: components["schemas"]["AddUserPayload"];
@@ -1079,8 +1083,8 @@ type FullQuote = MarketServiceSchemas['FullQuote'];
 type NewsArticle = MarketServiceSchemas['NewsArticle'];
 type StockNewsArticle = MarketServiceSchemas['StockNewsArticle'];
 type MarketServiceError = MarketServiceSchemas['Error'];
-type HistoryTimeframe = MarketServiceSchemas['HistoryTimeframe'];
-type HistoryChartEntry = MarketServiceSchemas['HistoryChartEntry'];
+type StockHistoryTimeframe = MarketServiceSchemas['StockHistoryTimeframe'];
+type StockHistoryEntry = MarketServiceSchemas['StockHistoryEntry'];
 type User = TradeServiceSchemas['User'];
 type Portfolio = TradeServiceSchemas['Portfolio'];
 type PortfolioType = TradeServiceSchemas['PortfolioType'];
@@ -1091,4 +1095,4 @@ type OrderType = TradeServiceSchemas['OrderType'];
 type Holding = TradeServiceSchemas['Holding'];
 type TradeServiceError = TradeServiceSchemas['Error'];
 
-export { type AddOrderPayload, type DeleteOrderPayload, type FullQuote, type HistoryChartEntry, type HistoryTimeframe, type Holding, type MarketServiceError, type NewsArticle, type Order, type OrderType, type Portfolio, type PortfolioType, type SimpleQuote, type StockNewsArticle, type TradeServiceError, type User, createMarketServiceClient, createTradeServiceClient, isMarketServiceError, isTradeServiceError };
+export { type AddOrderPayload, type DeleteOrderPayload, type FullQuote, type Holding, type MarketServiceError, type NewsArticle, type Order, type OrderType, type Portfolio, type PortfolioType, type SimpleQuote, type StockHistoryEntry, type StockHistoryTimeframe, type StockNewsArticle, type TradeServiceError, type User, createMarketServiceClient, createTradeServiceClient, isMarketServiceError, isTradeServiceError };

package/mise.toml

@@ -0,0 +1,3 @@
+[tools]
+node = "22"
+pre-commit = "4.0"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rivascva/dt-idl",
-  "version": "1.1.28",
+  "version": "1.1.30",
   "description": "Dream Trade - Interface Definition Language",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",

package/services/dt-market-service.yaml

@@ -55,7 +55,7 @@ paths:
           description: The stock history timeframe
           required: true
           schema:
-            $ref: '#/components/schemas/HistoryTimeframe'
+            $ref: '#/components/schemas/StockHistoryTimeframe'
             example: MIN5
         - in: query
           name: from
@@ -79,7 +79,7 @@ paths:
               schema:
                 type: array
                 items:
-                  $ref: '#/components/schemas/HistoryChartEntry'
+                  $ref: '#/components/schemas/StockHistoryEntry'
         404:
           $ref: '#/components/responses/NotFound'
         500:
@@ -415,7 +415,7 @@ components:
             - state
             - country
 
-    HistoryChartEntry:
+    StockHistoryEntry:
       description: A stock history chart entry
       properties:
         date:
@@ -505,7 +505,7 @@ components:
       enum:
         - ERROR
 
-    HistoryTimeframe:
+    StockHistoryTimeframe:
       type: string
       enum:
         - MIN5

package/services/dt-trade-service.yaml

@@ -199,9 +199,17 @@ components:
         name:
           type: string
           example: Sam Smith
+        country:
+          type: string
+          example: USA
+        imageUrl:
+          type: string
+          example: https://www.assets.com/image.png
       required:
         - email
         - name
+        - country
+        - imageUrl
 
     UpdateUserPayload:
       description: Payload to update an existing user

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

@@ -273,7 +273,7 @@ export interface components {
             country: string;
         };
         /** @description A stock history chart entry */
-        HistoryChartEntry: {
+        StockHistoryEntry: {
             /** @example 2024-12-24T02:30:00Z */
             date: string;
             /**
@@ -333,7 +333,7 @@ export interface components {
         /** @enum {string} */
         ErrorCode: "ERROR";
         /** @enum {string} */
-        HistoryTimeframe: "MIN5" | "MIN15" | "MIN30" | "HOUR1" | "HOUR4" | "DAY1";
+        StockHistoryTimeframe: "MIN5" | "MIN15" | "MIN30" | "HOUR1" | "HOUR4" | "DAY1";
     };
     responses: {
         /** @description The resource was not found */
@@ -391,7 +391,7 @@ export interface operations {
         parameters: {
             query: {
                 /** @description The stock history timeframe */
-                timeframe: components["schemas"]["HistoryTimeframe"];
+                timeframe: components["schemas"]["StockHistoryTimeframe"];
                 /** @description The stock history from date */
                 from: string;
                 /** @description The stock history to date */
@@ -412,7 +412,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["HistoryChartEntry"][];
+                    "application/json": components["schemas"]["StockHistoryEntry"][];
                 };
             };
             404: components["responses"]["NotFound"];

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

@@ -85,6 +85,10 @@ export interface components {
             email: string;
             /** @example Sam Smith */
             name: string;
+            /** @example USA */
+            country: string;
+            /** @example https://www.assets.com/image.png */
+            imageUrl: string;
         };
         /** @description Payload to update an existing user */
         UpdateUserPayload: components["schemas"]["AddUserPayload"];

package/ts/types/types.ts

@@ -10,8 +10,8 @@ export type FullQuote = MarketServiceSchemas['FullQuote'];
 export type NewsArticle = MarketServiceSchemas['NewsArticle'];
 export type StockNewsArticle = MarketServiceSchemas['StockNewsArticle'];
 export type MarketServiceError = MarketServiceSchemas['Error'];
-export type HistoryTimeframe = MarketServiceSchemas['HistoryTimeframe'];
-export type HistoryChartEntry = MarketServiceSchemas['HistoryChartEntry'];
+export type StockHistoryTimeframe = MarketServiceSchemas['StockHistoryTimeframe'];
+export type StockHistoryEntry = MarketServiceSchemas['StockHistoryEntry'];
 
 // Trade Service Types
 export type User = TradeServiceSchemas['User'];