@rivascva/dt-idl 1.1.31 → 1.1.35

package/dist/index.esm.js

@@ -487,8 +487,10 @@ function mergeHeaders(...allHeaders) {
 
 const createMarketServiceClient = (options) => createClient(options);
 const createTradeServiceClient = (options) => createClient(options);
+const createAppServiceClient = (options) => createClient(options);
 
 const isMarketServiceError = (error) => typeof error === 'object';
 const isTradeServiceError = (error) => typeof error === 'object';
+const isAppServiceError = (error) => typeof error === 'object';
 
-export { createMarketServiceClient, createTradeServiceClient, isMarketServiceError, isTradeServiceError };
+export { createAppServiceClient, createMarketServiceClient, createTradeServiceClient, isAppServiceError, isMarketServiceError, isTradeServiceError };

package/package.json

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

package/redocly.yaml

@@ -7,3 +7,7 @@ apis:
     root: ./services/dt-trade-service.yaml
     x-openapi-ts:
       output: ./ts/services/dt-trade-service.ts
+  dt-app-service@v1:
+    root: ./services/dt-app-service.yaml
+    x-openapi-ts:
+      output: ./ts/services/dt-app-service.ts

package/services/dt-app-service.yaml

@@ -0,0 +1,210 @@
+openapi: 3.0.0
+
+info:
+  version: 1.0.0
+  title: Dream Trade App Service
+  description: Support the client applications.
+
+servers:
+  - url: http://localhost:8084/v1
+
+paths:
+  /users:
+    get:
+      description: Gets all users
+      operationId: getUsers
+      tags:
+        - Users
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/User'
+        404:
+          $ref: '#/components/responses/NotFound'
+        500:
+          $ref: '#/components/responses/InternalServerError'
+    post:
+      description: Adds a new user
+      operationId: addUser
+      tags:
+        - Users
+      requestBody:
+        description: The request body to add a user
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/AddUserPayload'
+      responses:
+        201:
+          description: Added
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/User'
+        400:
+          $ref: '#/components/responses/BadRequest'
+        500:
+          $ref: '#/components/responses/InternalServerError'
+
+  /users/{userId}:
+    get:
+      description: Gets a user
+      operationId: getUser
+      tags:
+        - Users
+      parameters:
+        - in: path
+          name: userId
+          description: The user id
+          required: true
+          schema:
+            type: string
+            example: 123456
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                type: object
+                $ref: '#/components/schemas/User'
+        404:
+          $ref: '#/components/responses/NotFound'
+        500:
+          $ref: '#/components/responses/InternalServerError'
+    put:
+      description: Updates an existing user
+      operationId: updateUser
+      tags:
+        - Users
+      parameters:
+        - in: path
+          name: userId
+          description: The user id
+          required: true
+          schema:
+            type: string
+            example: 123456
+      requestBody:
+        description: The request body to updated a user
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/UpdateUserPayload'
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/User'
+        400:
+          $ref: '#/components/responses/BadRequest'
+        404:
+          $ref: '#/components/responses/NotFound'
+        500:
+          $ref: '#/components/responses/InternalServerError'
+
+components:
+  schemas:
+    AddUserPayload:
+      description: Payload to add a new user
+      properties:
+        email:
+          type: string
+          example: sam.smith@example.com
+        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
+      allOf:
+        - $ref: '#/components/schemas/AddUserPayload'
+
+    User:
+      description: A user
+      allOf:
+        - $ref: '#/components/schemas/AddUserPayload'
+        - type: object
+          properties:
+            id:
+              type: string
+              example: 123456
+            dateCreated:
+              type: integer
+              format: int64
+              example: 1713398544000
+            dateUpdated:
+              type: integer
+              format: int64
+              example: 1713398544000
+          required:
+            - id
+            - dateCreated
+            - dateUpdated
+
+    Error:
+      description: A generic error
+      properties:
+        status:
+          type: integer
+          format: int64
+          example: 500
+        code:
+          $ref: '#/components/schemas/ErrorCode'
+          example: ERROR
+        message:
+          type: string
+          example: Error
+      required:
+        - status
+        - code
+        - message
+
+    ErrorCode:
+      type: string
+      enum:
+        - ERROR
+
+  responses:
+    NoContent:
+      description: No content
+
+    NotFound:
+      description: The resource was not found
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Error'
+
+    BadRequest:
+      description: Invalid request payload
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Error'
+
+    InternalServerError:
+      description: There was an internal server error
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Error'

package/services/dt-trade-service.yaml

@@ -140,6 +140,61 @@ paths:
         500:
           $ref: '#/components/responses/InternalServerError'
 
+  /portfolios:
+    post:
+      description: Adds a new portfolio
+      operationId: addPortfolio
+      tags:
+        - Portfolios
+      requestBody:
+        description: The request body to add a portfolio
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/AddPortfolioPayload'
+      responses:
+        201:
+          description: Added
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Portfolio'
+        400:
+          $ref: '#/components/responses/BadRequest'
+        404:
+          $ref: '#/components/responses/NotFound'
+        500:
+          $ref: '#/components/responses/InternalServerError'
+
+  /portfolios/by-user/{userId}:
+    get:
+      description: Gets the portfolios for the given user
+      operationId: getPortfoliosByUser
+      tags:
+        - Portfolios
+      parameters:
+        - in: path
+          name: userId
+          description: The user id
+          required: true
+          schema:
+            type: string
+            example: 123456
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/Portfolio'
+        404:
+          $ref: '#/components/responses/NotFound'
+        500:
+          $ref: '#/components/responses/InternalServerError'
+
   /orders:
     post:
       description: Adds a new order
@@ -166,18 +221,21 @@ paths:
           $ref: '#/components/responses/NotFound'
         500:
           $ref: '#/components/responses/InternalServerError'
+
+  /orders/{orderId}:
     delete:
       description: Deletes an existing order
       operationId: deleteOrder
       tags:
         - Orders
-      requestBody:
-        description: The request body to delete an existing order
-        required: true
-        content:
-          application/json:
-            schema:
-              $ref: '#/components/schemas/DeleteOrderPayload'
+      parameters:
+        - in: path
+          name: orderId
+          description: The order id
+          required: true
+          schema:
+            type: string
+            example: 123456
       responses:
         204:
           $ref: '#/components/responses/NoContent'
@@ -237,12 +295,9 @@ components:
             - dateCreated
             - dateUpdated
 
-    Portfolio:
-      description: A trading portfolio
+    AddPortfolioPayload:
+      description: Payload to add a new portfolio
       properties:
-        id:
-          type: string
-          example: 123456
         userId:
           type: string
           example: 123456
@@ -253,31 +308,42 @@ components:
           type: number
           format: double
           example: 10500.25
-        holdings:
-          type: array
-          items:
-            $ref: '#/components/schemas/Holding'
-        orders:
-          type: array
-          items:
-            $ref: '#/components/schemas/Order'
-        dateCreated:
-          type: integer
-          format: int64
-          example: 1713398544000
-        dateUpdated:
-          type: integer
-          format: int64
-          example: 1713398544000
       required:
-        - id
         - userId
         - type
         - cash
-        - holdings
-        - orders
-        - dateCreated
-        - dateUpdated
+
+    Portfolio:
+      description: A trading portfolio
+      allOf:
+        - $ref: '#/components/schemas/AddPortfolioPayload'
+        - type: object
+          properties:
+            id:
+              type: string
+              example: 123456
+            holdings:
+              type: array
+              items:
+                $ref: '#/components/schemas/Holding'
+            orders:
+              type: array
+              items:
+                $ref: '#/components/schemas/Order'
+            dateCreated:
+              type: integer
+              format: int64
+              example: 1713398544000
+            dateUpdated:
+              type: integer
+              format: int64
+              example: 1713398544000
+          required:
+            - id
+            - holdings
+            - orders
+            - dateCreated
+            - dateUpdated
 
     Holding:
       description: A stock holding
@@ -339,15 +405,6 @@ components:
         - targetPrice
         - shares
 
-    DeleteOrderPayload:
-      description: Payload to delete an existing order
-      properties:
-        id:
-          type: string
-          example: 123456
-      required:
-        - id
-
     Order:
       description: An order
       allOf:

package/ts/clients/clients.ts

@@ -2,9 +2,13 @@ import createClient, { ClientOptions } from 'openapi-fetch';
 
 import { paths as MarketServicePaths } from '@ts/services/dt-market-service';
 import { paths as TradeServicePaths } from '@ts/services/dt-trade-service';
+import { paths as AppServicePaths } from '@ts/services/dt-app-service';
 
 export const createMarketServiceClient = (options: ClientOptions) =>
   createClient<MarketServicePaths>(options);
 
 export const createTradeServiceClient = (options: ClientOptions) =>
   createClient<TradeServicePaths>(options);
+
+export const createAppServiceClient = (options: ClientOptions) =>
+  createClient<AppServicePaths>(options);

package/ts/clients/errors.ts

@@ -1,7 +1,10 @@
-import { MarketServiceError, TradeServiceError } from '@ts/types';
+import { MarketServiceError, TradeServiceError, AppServiceError } from '@ts/types';
 
 export const isMarketServiceError = (error: unknown): error is MarketServiceError =>
   typeof error === 'object';
 
 export const isTradeServiceError = (error: unknown): error is TradeServiceError =>
   typeof error === 'object';
+
+export const isAppServiceError = (error: unknown): error is AppServiceError =>
+  typeof error === 'object';

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

@@ -0,0 +1,238 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+export interface paths {
+    "/users": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description Gets all users */
+        get: operations["getUsers"];
+        put?: never;
+        /** @description Adds a new user */
+        post: operations["addUser"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/users/{userId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description Gets a user */
+        get: operations["getUser"];
+        /** @description Updates an existing user */
+        put: operations["updateUser"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        /** @description Payload to add a new user */
+        AddUserPayload: {
+            /** @example sam.smith@example.com */
+            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"];
+        /** @description A user */
+        User: components["schemas"]["AddUserPayload"] & {
+            /** @example 123456 */
+            id: string;
+            /**
+             * Format: int64
+             * @example 1713398544000
+             */
+            dateCreated: number;
+            /**
+             * Format: int64
+             * @example 1713398544000
+             */
+            dateUpdated: 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";
+    };
+    responses: {
+        /** @description No content */
+        NoContent: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content?: never;
+        };
+        /** @description The resource was not found */
+        NotFound: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["Error"];
+            };
+        };
+        /** @description Invalid request payload */
+        BadRequest: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["Error"];
+            };
+        };
+        /** @description There was an internal server error */
+        InternalServerError: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["Error"];
+            };
+        };
+    };
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export interface operations {
+    getUsers: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Success */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["User"][];
+                };
+            };
+            404: components["responses"]["NotFound"];
+            500: components["responses"]["InternalServerError"];
+        };
+    };
+    addUser: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description The request body to add a user */
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["AddUserPayload"];
+            };
+        };
+        responses: {
+            /** @description Added */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["User"];
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            500: components["responses"]["InternalServerError"];
+        };
+    };
+    getUser: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The user id */
+                userId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Success */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["User"];
+                };
+            };
+            404: components["responses"]["NotFound"];
+            500: components["responses"]["InternalServerError"];
+        };
+    };
+    updateUser: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The user id */
+                userId: string;
+            };
+            cookie?: never;
+        };
+        /** @description The request body to updated a user */
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["UpdateUserPayload"];
+            };
+        };
+        responses: {
+            /** @description Success */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["User"];
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            404: components["responses"]["NotFound"];
+            500: components["responses"]["InternalServerError"];
+        };
+    };
+}