@dalmore/api-contracts 0.0.0-dev.0800e07

package/contracts/clients/trades/index.js

@@ -0,0 +1,156 @@
+import { initContract } from '@ts-rest/core';
+import { BadRequestError, ForbiddenError, InternalError, NotFoundError, PaginationOptionsZod, UnauthorizedError, } from '../../../common/types/index.js';
+import { InvestorsTradeResponse, IPaginatedTrade, IssuersTradeFiltersZod, PatchTradeStatus, PostTradeBody, tradeIdOrTidSchema, TradesIncludeQuery, TradeZod, PostAttachSubdocBody, PutAttachSubdocBody, PatchSubdocSignatureBody, AttachSubdocResponse, } from '../../../common/types/trade.types.js';
+import { z } from 'zod';
+import { PostTradeLineItem, TradeLineItemQuery, TradeLineItemResponse, } from '../../../common/types/trade-line-item.types.js';
+const c = initContract();
+export const tradesContract = c.router({
+    getTrade: {
+        summary: 'Get trade by id - id could be either the entity id or tid',
+        method: 'GET',
+        path: '/:id',
+        metadata: {
+            auth: true,
+        },
+        query: z
+            .object({})
+            .merge(IssuersTradeFiltersZod)
+            .merge(TradesIncludeQuery),
+        pathParams: z.object({
+            id: tradeIdOrTidSchema,
+        }),
+        responses: {
+            200: TradeZod,
+            401: UnauthorizedError,
+            403: ForbiddenError,
+            404: NotFoundError,
+        },
+    },
+    getTrades: {
+        summary: 'Get trades',
+        method: 'GET',
+        path: '',
+        metadata: {
+            auth: true,
+        },
+        query: PaginationOptionsZod.merge(IssuersTradeFiltersZod).merge(TradesIncludeQuery),
+        responses: {
+            200: IPaginatedTrade,
+            401: UnauthorizedError,
+            403: ForbiddenError,
+        },
+    },
+    createTrades: {
+        summary: 'Create Trades',
+        method: 'POST',
+        path: '/',
+        metadata: {
+            auth: true,
+        },
+        body: PostTradeBody,
+        responses: {
+            201: InvestorsTradeResponse,
+            401: UnauthorizedError,
+            403: ForbiddenError,
+        },
+    },
+    postLineItem: {
+        summary: 'Create a Line Item',
+        method: 'POST',
+        path: '/line-items',
+        metadata: {
+            auth: true,
+        },
+        query: TradeLineItemQuery,
+        body: PostTradeLineItem,
+        responses: {
+            201: TradeLineItemResponse,
+            401: UnauthorizedError,
+            403: ForbiddenError,
+            400: BadRequestError,
+            500: InternalError,
+        },
+    },
+    patchTradeStatus: {
+        summary: 'Patch a trade status',
+        method: 'PATCH',
+        path: '/:id',
+        pathParams: z.object({
+            id: tradeIdOrTidSchema,
+        }),
+        metadata: {
+            auth: true,
+        },
+        body: PatchTradeStatus,
+        responses: {
+            201: TradeZod,
+            401: UnauthorizedError,
+            403: ForbiddenError,
+            400: BadRequestError,
+            500: InternalError,
+        },
+    },
+    postAttachSubdoc: {
+        summary: 'Attach subdoc to trade',
+        method: 'POST',
+        path: '/:id/attach-subdoc',
+        pathParams: z.object({
+            id: tradeIdOrTidSchema,
+        }),
+        metadata: {
+            auth: true,
+        },
+        body: PostAttachSubdocBody,
+        responses: {
+            200: AttachSubdocResponse,
+            400: BadRequestError,
+            401: UnauthorizedError,
+            403: ForbiddenError,
+            404: NotFoundError,
+            500: InternalError,
+        },
+    },
+    putAttachSubdoc: {
+        summary: 'Update attached subdoc for trade',
+        method: 'PUT',
+        path: '/:id/attach-subdoc',
+        pathParams: z.object({
+            id: tradeIdOrTidSchema,
+        }),
+        metadata: {
+            auth: true,
+        },
+        body: PutAttachSubdocBody,
+        responses: {
+            200: AttachSubdocResponse,
+            400: BadRequestError,
+            401: UnauthorizedError,
+            403: ForbiddenError,
+            404: NotFoundError,
+            500: InternalError,
+        },
+    },
+    patchSubdocSign: {
+        summary: 'Update subdoc signature statuses for trade',
+        method: 'PATCH',
+        path: '/:id/sign',
+        pathParams: z.object({
+            id: tradeIdOrTidSchema,
+        }),
+        metadata: {
+            auth: true,
+        },
+        body: PatchSubdocSignatureBody,
+        responses: {
+            200: AttachSubdocResponse,
+            400: BadRequestError,
+            401: UnauthorizedError,
+            403: ForbiddenError,
+            404: NotFoundError,
+            500: InternalError,
+        },
+    },
+}, {
+    pathPrefix: 'trades',
+});
+//# sourceMappingURL=index.js.map

package/contracts/clients/trades/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EACL,eAAe,EACf,cAAc,EACd,aAAa,EACb,aAAa,EACb,oBAAoB,EACpB,iBAAiB,GAClB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,sBAAsB,EACtB,eAAe,EACf,sBAAsB,EACtB,gBAAgB,EAChB,aAAa,EACb,kBAAkB,EAClB,kBAAkB,EAClB,QAAQ,EACR,oBAAoB,EACpB,mBAAmB,EACnB,wBAAwB,EACxB,oBAAoB,GACrB,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAClB,qBAAqB,GACtB,MAAM,6CAA6C,CAAC;AAErD,MAAM,CAAC,GAAG,YAAY,EAAE,CAAC;AAEzB,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CACpC;IACE,QAAQ,EAAE;QACR,OAAO,EAAE,2DAA2D;QACpE,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,MAAM;QACZ,QAAQ,EAAE;YACR,IAAI,EAAE,IAAI;SACX;QACD,KAAK,EAAE,CAAC;aACL,MAAM,CAAC,EAAE,CAAC;aACV,KAAK,CAAC,sBAAsB,CAAC;aAC7B,KAAK,CAAC,kBAAkB,CAAC;QAC5B,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;YACnB,EAAE,EAAE,kBAAkB;SACvB,CAAC;QACF,SAAS,EAAE;YACT,GAAG,EAAE,QAAQ;YACb,GAAG,EAAE,iBAAiB;YACtB,GAAG,EAAE,cAAc;YACnB,GAAG,EAAE,aAAa;SACnB;KACF;IACD,SAAS,EAAE;QACT,OAAO,EAAE,YAAY;QACrB,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,EAAE;QACR,QAAQ,EAAE;YACR,IAAI,EAAE,IAAI;SACX;QACD,KAAK,EAAE,oBAAoB,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC,KAAK,CAC7D,kBAAkB,CACnB;QACD,SAAS,EAAE;YACT,GAAG,EAAE,eAAe;YACpB,GAAG,EAAE,iBAAiB;YACtB,GAAG,EAAE,cAAc;SACpB;KACF;IACD,YAAY,EAAE;QACZ,OAAO,EAAE,eAAe;QACxB,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,GAAG;QACT,QAAQ,EAAE;YACR,IAAI,EAAE,IAAI;SACX;QACD,IAAI,EAAE,aAAa;QACnB,SAAS,EAAE;YACT,GAAG,EAAE,sBAAsB;YAC3B,GAAG,EAAE,iBAAiB;YACtB,GAAG,EAAE,cAAc;SACpB;KACF;IACD,YAAY,EAAE;QACZ,OAAO,EAAE,oBAAoB;QAC7B,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,aAAa;QACnB,QAAQ,EAAE;YACR,IAAI,EAAE,IAAI;SACX;QACD,KAAK,EAAE,kBAAkB;QACzB,IAAI,EAAE,iBAAiB;QACvB,SAAS,EAAE;YACT,GAAG,EAAE,qBAAqB;YAC1B,GAAG,EAAE,iBAAiB;YACtB,GAAG,EAAE,cAAc;YACnB,GAAG,EAAE,eAAe;YACpB,GAAG,EAAE,aAAa;SACnB;KACF;IACD,gBAAgB,EAAE;QAChB,OAAO,EAAE,sBAAsB;QAC/B,MAAM,EAAE,OAAO;QACf,IAAI,EAAE,MAAM;QACZ,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;YACnB,EAAE,EAAE,kBAAkB;SACvB,CAAC;QACF,QAAQ,EAAE;YACR,IAAI,EAAE,IAAI;SACX;QACD,IAAI,EAAE,gBAAgB;QACtB,SAAS,EAAE;YACT,GAAG,EAAE,QAAQ;YACb,GAAG,EAAE,iBAAiB;YACtB,GAAG,EAAE,cAAc;YACnB,GAAG,EAAE,eAAe;YACpB,GAAG,EAAE,aAAa;SACnB;KACF;IACD,gBAAgB,EAAE;QAChB,OAAO,EAAE,wBAAwB;QACjC,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,oBAAoB;QAC1B,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;YACnB,EAAE,EAAE,kBAAkB;SACvB,CAAC;QACF,QAAQ,EAAE;YACR,IAAI,EAAE,IAAI;SACX;QACD,IAAI,EAAE,oBAAoB;QAC1B,SAAS,EAAE;YACT,GAAG,EAAE,oBAAoB;YACzB,GAAG,EAAE,eAAe;YACpB,GAAG,EAAE,iBAAiB;YACtB,GAAG,EAAE,cAAc;YACnB,GAAG,EAAE,aAAa;YAClB,GAAG,EAAE,aAAa;SACnB;KACF;IACD,eAAe,EAAE;QACf,OAAO,EAAE,kCAAkC;QAC3C,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,oBAAoB;QAC1B,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;YACnB,EAAE,EAAE,kBAAkB;SACvB,CAAC;QACF,QAAQ,EAAE;YACR,IAAI,EAAE,IAAI;SACX;QACD,IAAI,EAAE,mBAAmB;QACzB,SAAS,EAAE;YACT,GAAG,EAAE,oBAAoB;YACzB,GAAG,EAAE,eAAe;YACpB,GAAG,EAAE,iBAAiB;YACtB,GAAG,EAAE,cAAc;YACnB,GAAG,EAAE,aAAa;YAClB,GAAG,EAAE,aAAa;SACnB;KACF;IACD,eAAe,EAAE;QACf,OAAO,EAAE,4CAA4C;QACrD,MAAM,EAAE,OAAO;QACf,IAAI,EAAE,WAAW;QACjB,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;YACnB,EAAE,EAAE,kBAAkB;SACvB,CAAC;QACF,QAAQ,EAAE;YACR,IAAI,EAAE,IAAI;SACX;QACD,IAAI,EAAE,wBAAwB;QAC9B,SAAS,EAAE;YACT,GAAG,EAAE,oBAAoB;YACzB,GAAG,EAAE,eAAe;YACpB,GAAG,EAAE,iBAAiB;YACtB,GAAG,EAAE,cAAc;YACnB,GAAG,EAAE,aAAa;YAClB,GAAG,EAAE,aAAa;SACnB;KACF;CACF,EACD;IACE,UAAU,EAAE,QAAQ;CACrB,CACF,CAAC"}

package/contracts/clients/transactions/index.d.ts

@@ -0,0 +1,88 @@
+export declare const clientsTransactionsContract: {
+    postTransaction: {
+        method: "POST";
+        metadata: {
+            auth: boolean;
+        };
+        body: import("zod").ZodObject<{
+            tid: import("zod").ZodString;
+            tradeId: import("zod").ZodLazy<import("zod").ZodEffects<import("zod").ZodString, string, string>>;
+            name: import("zod").ZodString;
+            chargedAt: import("zod").ZodEffects<import("zod").ZodEffects<import("zod").ZodNullable<import("zod").ZodString>, string | null, string | null>, Date | null, string | null>;
+            amount: import("zod").ZodEffects<import("zod").ZodNumber, number, number>;
+        } & {
+            userId: import("zod").ZodLazy<import("zod").ZodEffects<import("zod").ZodString, string, string>>;
+        }, "strip", import("zod").ZodTypeAny, {
+            name: string;
+            tid: string;
+            userId: string;
+            amount: number;
+            tradeId: string;
+            chargedAt: Date | null;
+        }, {
+            name: string;
+            tid: string;
+            userId: string;
+            amount: number;
+            tradeId: string;
+            chargedAt: string | null;
+        }>;
+        summary: "Create a transaction";
+        path: "transactions";
+        responses: {
+            201: any;
+            400: import("zod").ZodObject<{
+                status: import("zod").ZodNumber;
+                message: import("zod").ZodString;
+                errors: import("zod").ZodArray<import("zod").ZodString, "many">;
+            }, "strip", import("zod").ZodTypeAny, {
+                message: string;
+                status: number;
+                errors: string[];
+            }, {
+                message: string;
+                status: number;
+                errors: string[];
+            }>;
+            401: import("zod").ZodObject<{
+                status: import("zod").ZodNumber;
+                message: import("zod").ZodString;
+                errors: import("zod").ZodArray<import("zod").ZodString, "many">;
+            }, "strip", import("zod").ZodTypeAny, {
+                message: string;
+                status: number;
+                errors: string[];
+            }, {
+                message: string;
+                status: number;
+                errors: string[];
+            }>;
+            404: import("zod").ZodObject<{
+                status: import("zod").ZodNumber;
+                message: import("zod").ZodString;
+                errors: import("zod").ZodArray<import("zod").ZodString, "many">;
+            }, "strip", import("zod").ZodTypeAny, {
+                message: string;
+                status: number;
+                errors: string[];
+            }, {
+                message: string;
+                status: number;
+                errors: string[];
+            }>;
+            500: import("zod").ZodObject<{
+                status: import("zod").ZodNumber;
+                message: import("zod").ZodString;
+                errors: import("zod").ZodArray<import("zod").ZodString, "many">;
+            }, "strip", import("zod").ZodTypeAny, {
+                message: string;
+                status: number;
+                errors: string[];
+            }, {
+                message: string;
+                status: number;
+                errors: string[];
+            }>;
+        };
+    };
+};

package/contracts/clients/transactions/index.js

@@ -0,0 +1,25 @@
+import { initContract } from '@ts-rest/core';
+import { BadRequestError, InternalError, NotFoundError, UnauthorizedError, } from '../../../common/types/index.js';
+import { ClientPostTransactionZod, TransactionZod, } from '../../../common/types/transaction.types.js';
+const c = initContract();
+export const clientsTransactionsContract = c.router({
+    postTransaction: {
+        summary: 'Create a transaction',
+        method: 'POST',
+        path: '',
+        metadata: {
+            auth: true,
+        },
+        body: ClientPostTransactionZod,
+        responses: {
+            201: TransactionZod,
+            400: BadRequestError,
+            401: UnauthorizedError,
+            404: NotFoundError,
+            500: InternalError,
+        },
+    },
+}, {
+    pathPrefix: 'transactions',
+});
+//# sourceMappingURL=index.js.map

package/contracts/clients/transactions/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EACL,eAAe,EACf,aAAa,EACb,aAAa,EACb,iBAAiB,GAClB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,wBAAwB,EACxB,cAAc,GACf,MAAM,yCAAyC,CAAC;AAEjD,MAAM,CAAC,GAAG,YAAY,EAAE,CAAC;AAEzB,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CACjD;IACE,eAAe,EAAE;QACf,OAAO,EAAE,sBAAsB;QAC/B,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,EAAE;QACR,QAAQ,EAAE;YACR,IAAI,EAAE,IAAI;SACX;QACD,IAAI,EAAE,wBAAwB;QAC9B,SAAS,EAAE;YACT,GAAG,EAAE,cAAc;YACnB,GAAG,EAAE,eAAe;YACpB,GAAG,EAAE,iBAAiB;YACtB,GAAG,EAAE,aAAa;YAClB,GAAG,EAAE,aAAa;SACnB;KACF;CACF,EACD;IACE,UAAU,EAAE,cAAc;CAC3B,CACF,CAAC"}

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@dalmore/api-contracts",
+  "version": "0.0.0-dev.0800e07",
+  "description": "Type-safe API contracts for Dalmore Client Portal",
+  "type": "module",
+  "main": "./index.js",
+  "types": "./index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js",
+      "default": "./index.js"
+    },
+    "./clients": {
+      "types": "./contracts/clients/index.d.ts",
+      "import": "./contracts/clients/index.js",
+      "default": "./contracts/clients/index.js"
+    },
+    "./types": {
+      "types": "./common/types/index.d.ts",
+      "import": "./common/types/index.js",
+      "default": "./common/types/index.js"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      ".": [
+        "./index.d.ts"
+      ],
+      "clients": [
+        "./contracts/clients/index.d.ts"
+      ],
+      "types": [
+        "./common/types/index.d.ts"
+      ]
+    }
+  },
+  "files": [
+    "index.ts",
+    "contracts",
+    "common"
+  ],
+  "keywords": [
+    "dalmore",
+    "api",
+    "contracts",
+    "ts-rest",
+    "typescript"
+  ],
+  "author": "Dalmore Group",
+  "license": "UNLICENSED",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/OfficialDalmoreGroup/dalmore-client-portal-api.git"
+  },
+  "peerDependencies": {
+    "@anatine/zod-openapi": "^1.14.2",
+    "@ts-rest/core": "^3.52.1",
+    "typeid-js": "^1.2.0",
+    "zod": "^3.24.4"
+  },
+  "engines": {
+    "node": ">=24.0.0 <25.0.0"
+  }
+}