@dalmore/api-contracts 1.0.0 → 1.0.2

package/contracts/clients/auth/index.ts

@@ -1,8 +1,10 @@
 import { initContract } from '@ts-rest/core';
 import {
+  AccessTokenResponse,
   BadRequestError,
   ClientAuthSuccessResponse,
   InternalError,
+  IRegisterClientIssuerBodyZod,
   RegisterBodyInvestors,
   UnauthorizedError,
 } from '../../../common/types';
@@ -12,7 +14,7 @@ const c = initContract();
 export const authContract = c.router(
   {
     registerInvestor: {
-      summary: 'Register investor with email',
+      summary: 'Register investor with email (API Key Auth)',
       method: 'POST',
       path: 'register/investor',
       metadata: {
@@ -26,6 +28,21 @@ export const authContract = c.router(
         500: InternalError,
       },
     },
+    registerIssuer: {
+      summary: 'Register issuer with email (API Key Auth)',
+      method: 'POST',
+      path: 'register/issuer',
+      metadata: {
+        auth: true,
+      },
+      body: IRegisterClientIssuerBodyZod,
+      responses: {
+        201: AccessTokenResponse,
+        400: BadRequestError,
+        401: UnauthorizedError,
+        500: InternalError,
+      },
+    },
   },
   {
     pathPrefix: 'auth/',

package/contracts/clients/index.ts

@@ -14,6 +14,7 @@ import { filesPublicContract } from './files-public';
 import { secureRequestContract } from './secure-requests';
 import { aicContract } from './aic';
 import { authContract } from './auth';
+import { sitesContract } from './sites';
 
 const c = initContract();
 
@@ -34,6 +35,7 @@ export const clientsContract = c.router(
     legalEntities: legalEntityContract,
     offerings: offeringsContract,
     secureRequests: secureRequestContract,
+    sites: sitesContract,
     trades: tradesContract,
   },
   {

package/contracts/clients/offerings/index.ts

@@ -13,7 +13,8 @@ import {
   OfferingSummaryFiltersZod,
   PaginatedOfferingSummaryResponseZod,
   PaginationOptionsZod,
-  PatchOffering,
+  PatchIssuerOffering,
+  PostIssuerOffering,
   UnauthorizedError,
 } from '../../../common/types';
 
@@ -83,7 +84,7 @@ export const offeringsContract = c.router(
       pathParams: z.object({
         id: offeringIdSchema,
       }),
-      body: PatchOffering,
+      body: PatchIssuerOffering,
       responses: {
         201: IOffering,
         400: BadRequestError,
@@ -100,7 +101,7 @@ export const offeringsContract = c.router(
       metadata: {
         auth: true,
       },
-      body: PatchOffering,
+      body: PostIssuerOffering,
       responses: {
         201: IOffering,
         400: BadRequestError,

package/contracts/clients/sites/index.ts

@@ -0,0 +1,56 @@
+import { initContract } from '@ts-rest/core';
+import {
+  ForbiddenError,
+  NotFoundError,
+  PaginationOptionsZod,
+  UnauthorizedError,
+} from '../../../common/types';
+import {
+  SitesFiltersZod,
+  SitesIncludeQuery,
+  SitesPaginated,
+  SitesParamSchema,
+  SiteZod,
+} from '../../../common/types/site.types';
+
+const c = initContract();
+
+export const sitesContract = c.router(
+  {
+    getSite: {
+      summary: 'get site by id',
+      method: 'GET',
+      path: '/:id',
+      pathParams: SitesParamSchema,
+      metadata: {
+        auth: true,
+      },
+      query: SitesIncludeQuery.merge(SitesFiltersZod),
+      responses: {
+        200: SiteZod,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        404: NotFoundError,
+      },
+    },
+    getSites: {
+      summary: 'query sites by url',
+      method: 'GET',
+      path: '/',
+      metadata: {
+        auth: true,
+      },
+      query:
+        PaginationOptionsZod.merge(SitesFiltersZod).merge(SitesIncludeQuery),
+      responses: {
+        200: SitesPaginated,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        404: NotFoundError,
+      },
+    },
+  },
+  {
+    pathPrefix: 'sites',
+  },
+);

package/contracts/compliance/account-managers/index.ts

@@ -10,6 +10,7 @@ import {
   UnauthorizedError,
 } from '../../../common/types';
 import {
+  AccountManagerDeleteQuery,
   AccountManagerDeleteResponse,
   accountManagerIdSchema,
   AccountManagersIncludeQuery,
@@ -122,6 +123,7 @@ export const accountManagersContract = c.router(
       pathParams: z.object({
         id: accountManagerIdSchema,
       }),
+      query: AccountManagerDeleteQuery,
       responses: {
         201: AccountManagerDeleteResponse,
         400: BadRequestError,

package/contracts/compliance/accounts/index.ts

@@ -15,7 +15,7 @@ import {
   IPaginatedAccountsSummaryResponse,
   UpdateAccountIssuersStatusZod,
   UpdateAccountStatusReponse,
-  PatchAccountZod,
+  CompliancePatchAccountZod,
   AccountSortZod,
   BadRequestError,
 } from '../../../common/types';
@@ -63,6 +63,7 @@ export const accountsContract = c.router(
         401: UnauthorizedError,
         403: ForbiddenError,
         404: NotFoundError,
+        500: InternalError,
       },
     },
     // Admin
@@ -81,6 +82,7 @@ export const accountsContract = c.router(
         200: IPaginatedAccount,
         401: UnauthorizedError,
         403: ForbiddenError,
+        500: InternalError,
       },
     },
     updateAccountAdmin: {
@@ -93,7 +95,7 @@ export const accountsContract = c.router(
       pathParams: z.object({
         id: accountIdSchema,
       }),
-      body: PatchAccountZod,
+      body: CompliancePatchAccountZod,
       responses: {
         200: AccountZod,
         404: NotFoundError,

package/contracts/compliance/bonus-tiers/index.ts

@@ -0,0 +1,55 @@
+import { initContract } from '@ts-rest/core';
+import {
+  BadRequestError,
+  ForbiddenError,
+  InternalError,
+  UnauthorizedError,
+} from '../../../common/types';
+import {
+  CompliancePostBonusTierZod,
+  EstimateBonusTierCalculationResponseZod,
+  EstimateBonusTierCalculationZod,
+  IBonusTierList,
+} from '../../../common/types/bonus-tier.types';
+
+const c = initContract();
+
+export const bonusTiersContract = c.router(
+  {
+    estimateCalculation: {
+      summary: 'Estimate bonus tier calculation',
+      method: 'POST',
+      path: '/estimate-calculation',
+      metadata: {
+        auth: true,
+      },
+      body: EstimateBonusTierCalculationZod,
+      responses: {
+        200: EstimateBonusTierCalculationResponseZod,
+        400: BadRequestError,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        500: InternalError,
+      },
+    },
+    postBonusTier: {
+      summary: 'Create a new bonus tier',
+      method: 'POST',
+      path: '/',
+      metadata: {
+        auth: true,
+      },
+      body: CompliancePostBonusTierZod,
+      responses: {
+        201: IBonusTierList,
+        400: BadRequestError,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        500: InternalError,
+      },
+    },
+  },
+  {
+    pathPrefix: 'bonus-tiers',
+  },
+);

package/contracts/compliance/index.ts

@@ -66,6 +66,7 @@ import { defaultThemeConfigsContract } from './default-theme-configs';
 import { aicContract } from './aic';
 import { stateMachineContract } from './state-machine';
 import { offeringReportsContract } from './offering-reports';
+import { bonusTiersContract } from './bonus-tiers';
 
 const c = initContract();
 
@@ -80,6 +81,7 @@ export const complianceContract = c.router(
     auth: authContract,
     aic: aicContract,
     batchJobs: batchJobsContract,
+    bonusTiers: bonusTiersContract,
     checklist: checkListContract,
     checklistItems: checkListItemsContract,
     coveredPersons: coveredPersonsContract,

package/contracts/compliance/investor-accounts/index.ts

@@ -6,6 +6,7 @@ import {
   InternalError,
   NotFoundError,
   PaginationOptionsZod,
+  tradeIdSchema,
   UnauthorizedError,
 } from '../../../common/types';
 import { z } from 'zod';
@@ -89,6 +90,9 @@ export const investorAccountsContract = c.router(
       pathParams: z.object({
         id: investorAccountIdSchema,
       }),
+      query: z.object({
+        tradeId: tradeIdSchema.optional(),
+      }),
       responses: {
         200: IInvestorAccountSummary,
         401: UnauthorizedError,

package/contracts/issuers/accounts/index.ts

@@ -13,6 +13,7 @@ import {
   PatchAccountZod,
   PatchIssuerOnboardingStep,
   IssuerOnboardingStepZod,
+  InternalError,
 } from '../../../common/types';
 import { z } from 'zod';
 
@@ -35,6 +36,7 @@ export const accountsContract = c.router(
         200: IPaginatedAccount,
         401: UnauthorizedError,
         403: ForbiddenError,
+        500: InternalError,
       },
     },
     getAccount: {
@@ -53,6 +55,7 @@ export const accountsContract = c.router(
         401: UnauthorizedError,
         403: ForbiddenError,
         404: NotFoundError,
+        500: InternalError,
       },
     },
     patchOnboardingStep: {
@@ -68,6 +71,7 @@ export const accountsContract = c.router(
         401: UnauthorizedError,
         403: ForbiddenError,
         404: NotFoundError,
+        500: InternalError,
       },
     },
     patchAccount: {
@@ -83,6 +87,7 @@ export const accountsContract = c.router(
         401: UnauthorizedError,
         403: ForbiddenError,
         404: NotFoundError,
+        500: InternalError,
       },
     },
   },

package/contracts/issuers/bonus-tiers/index.ts

@@ -8,6 +8,8 @@ import {
 import {
   EstimateBonusTierCalculationResponseZod,
   EstimateBonusTierCalculationZod,
+  IBonusTierList,
+  PostBonusTierZod,
 } from '../../../common/types/bonus-tier.types';
 
 const c = initContract();
@@ -30,6 +32,22 @@ export const bonusTiersContract = c.router(
         500: InternalError,
       },
     },
+    postBonusTier: {
+      summary: 'Create a new bonus tier',
+      method: 'POST',
+      path: '/',
+      metadata: {
+        auth: true,
+      },
+      body: PostBonusTierZod,
+      responses: {
+        201: IBonusTierList,
+        400: BadRequestError,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        500: InternalError,
+      },
+    },
   },
   {
     pathPrefix: 'bonus-tiers',

package/contracts/issuers/investor-accounts/index.ts

@@ -6,6 +6,7 @@ import {
   InternalError,
   NotFoundError,
   PaginationOptionsZod,
+  tradeIdSchema,
   UnauthorizedError,
 } from '../../../common/types';
 import { z } from 'zod';
@@ -19,6 +20,7 @@ import {
   GetInvestorAccountDetailsQuery,
   RegisteredInvestorUserFiltersZod,
   IPaginatedRegisteredInvestorUserZod,
+  IInvestorAccountSummary,
 } from '../../../common/types/investor-account.types';
 
 const c = initContract();
@@ -119,6 +121,26 @@ export const investorAccountsContract = c.router(
         404: NotFoundError,
       },
     },
+    getInvestorAccountSummary: {
+      summary: 'Get investor account summary',
+      method: 'GET',
+      path: '/:id/summary',
+      metadata: {
+        auth: true,
+      },
+      pathParams: z.object({
+        id: investorAccountIdSchema,
+      }),
+      query: z.object({
+        tradeId: tradeIdSchema.optional(),
+      }),
+      responses: {
+        200: IInvestorAccountSummary,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        404: NotFoundError,
+      },
+    },
   },
   {
     pathPrefix: 'investor-accounts',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dalmore/api-contracts",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Type-safe API contracts for Dalmore Client Portal",
   "main": "./contracts/index.ts",
   "types": "./contracts/index.ts",
@@ -40,6 +40,10 @@
     "./types/*": {
       "types": "./common/types/*.ts",
       "default": "./common/types/*.ts"
+    },
+    "./helpers": {
+      "types": "./common/helpers/index.ts",
+      "default": "./common/helpers/index.ts"
     }
   },
   "files": [
@@ -55,13 +59,19 @@
   ],
   "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",
+    "@nestjs/common": "^11.0.0",
     "@ts-rest/core": "^3.52.1",
+    "libphonenumber-js": "^1.12.0",
+    "neverthrow": "^8.0.0",
     "typeid-js": "^1.2.0",
     "zod": "^3.24.4"
   },
@@ -69,6 +79,6 @@
     "typescript": "^5.8.3"
   },
   "engines": {
-    "node": ">=22.15.0 <23.0.0"
+    "node": ">=24.0.0 <25.0.0"
   }
 }

package/common/types/reminder-config.types.ts

@@ -1,40 +0,0 @@
-import { Job } from 'bullmq';
-import { QueryRunner } from 'typeorm';
-import { Site } from '../../sites/entities/site.entity';
-import { ProcessTradeCancellationReminderDto } from '../../workers/dto.worker';
-
-export enum ReminderType {
-  DAILY = 'daily',
-  CUMULATIVE = 'cumulative',
-  WARNING = 'warning',
-  CANCEL = 'cancel',
-  SKIP = 'skip', // for days with no action
-}
-
-export interface ReminderConfig {
-  day: number;
-  type: ReminderType;
-  daysLeft?: number; // for warning type
-  createTask?: boolean; // for daily type
-  priority?: 'low' | 'medium' | 'high' | 'urgent';
-}
-
-export interface ReminderTemplate {
-  subject: (params: ReminderTemplateParams) => string;
-  description: (params: ReminderTemplateParams) => string;
-}
-
-export interface ReminderTemplateParams {
-  day: number;
-  offeringName: string;
-  daysLeft?: number;
-  userName: string;
-  tradeStatus: string;
-}
-
-export interface ReminderContext {
-  queryRunner: QueryRunner;
-  job: Job<ProcessTradeCancellationReminderDto>;
-  site: Site;
-  logContext: any;
-}