@rivascva/dt-idl 1.1.29 → 1.1.31

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

@@ -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"];

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.29",
+  "version": "1.1.31",
   "description": "Dream Trade - Interface Definition Language",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",

package/services/dt-trade-service.yaml

@@ -199,9 +199,16 @@ 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
 
     UpdateUserPayload:
       description: Payload to update an existing user

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"];