@dalmore/api-contracts 1.0.0 → 1.0.1

package/common/types/investor-account.types.ts

@@ -27,7 +27,7 @@ import {
 } from './common.types';
 import { accountIdSchema } from './account.types';
 import { SaStatus, tradeIdSchema, TradeZod } from './trade.types';
-import { LegalEntityZod } from './legal-entity.types';
+import { legalEntityIdSchema, LegalEntityZod } from './legal-entity.types';
 import { extendZodWithOpenApi } from '@anatine/zod-openapi';
 import { offeringIdSchema } from './offering.types';
 import { userIdSchema, UserZod } from './user.types';
@@ -97,6 +97,7 @@ export const IInvestorAccountSummary = z.object({
   totalPending: z.number(),
   concentrationLiquidNetWorth: z.number(),
   concentrationTotalNetWorth: z.number(),
+  postTradeConcentration: z.number().optional(),
 });
 
 export type IInvestorAccountSummary = z.infer<typeof IInvestorAccountSummary>;
@@ -159,24 +160,33 @@ export const InvestorAccountsFiltersZod = z.object({
   amlStatus: z.nativeEnum(AMLStatus).optional(),
   aicStatus: z.nativeEnum(AicStatus).optional(),
   offeringId: z.lazy(() => offeringIdSchema).optional(),
-  regAQualified: z
-    .string()
-    .optional()
-    .refine((v) => !v || v === 'true' || v === 'false', {
-      message: 'regAQualified must be a boolean string',
-    }),
-  regCfQualified: z
-    .string()
-    .optional()
-    .refine((v) => !v || v === 'true' || v === 'false', {
-      message: 'regCfQualified must be a boolean string',
-    }),
-  regDQualified: z
-    .string()
-    .optional()
-    .refine((v) => !v || v === 'true' || v === 'false', {
-      message: 'regDQualified must be a boolean string',
-    }),
+  regAQualified: z.preprocess(
+    (val) =>
+      val === 'true' || val === '1'
+        ? true
+        : val === 'false' || val === '0'
+          ? false
+          : val,
+    z.boolean().optional(),
+  ),
+  regCfQualified: z.preprocess(
+    (val) =>
+      val === 'true' || val === '1'
+        ? true
+        : val === 'false' || val === '0'
+          ? false
+          : val,
+    z.boolean().optional(),
+  ),
+  regDQualified: z.preprocess(
+    (val) =>
+      val === 'true' || val === '1'
+        ? true
+        : val === 'false' || val === '0'
+          ? false
+          : val,
+    z.boolean().optional(),
+  ),
   email: z.string().optional(),
   accountId: accountIdSchema.optional(),
   userType: z.nativeEnum(UserType).optional(),
@@ -222,24 +232,33 @@ export const IssuerInvestorAccountsFiltersZod = z.object({
   amlStatus: z.nativeEnum(AMLStatus).optional(),
   aicStatus: z.nativeEnum(AicStatus).optional(),
   offeringId: z.lazy(() => offeringIdSchema).optional(),
-  regAQualified: z
-    .string()
-    .optional()
-    .refine((v) => !v || v === 'true' || v === 'false', {
-      message: 'regAQualified must be a boolean string',
-    }),
-  regCfQualified: z
-    .string()
-    .optional()
-    .refine((v) => !v || v === 'true' || v === 'false', {
-      message: 'regCfQualified must be a boolean string',
-    }),
-  regDQualified: z
-    .string()
-    .optional()
-    .refine((v) => !v || v === 'true' || v === 'false', {
-      message: 'regDQualified must be a boolean string',
-    }),
+  regAQualified: z.preprocess(
+    (val) =>
+      val === 'true' || val === '1'
+        ? true
+        : val === 'false' || val === '0'
+          ? false
+          : val,
+    z.boolean().optional(),
+  ),
+  regCfQualified: z.preprocess(
+    (val) =>
+      val === 'true' || val === '1'
+        ? true
+        : val === 'false' || val === '0'
+          ? false
+          : val,
+    z.boolean().optional(),
+  ),
+  regDQualified: z.preprocess(
+    (val) =>
+      val === 'true' || val === '1'
+        ? true
+        : val === 'false' || val === '0'
+          ? false
+          : val,
+    z.boolean().optional(),
+  ),
   email: z.string().optional(),
   startDate: dateSchema.optional(),
   endDate: dateSchema.optional(),
@@ -248,37 +267,42 @@ export const IssuerInvestorAccountsFiltersZod = z.object({
 
 export const InvestorAccountsFilters = z.object({
   investorAccountType: z.nativeEnum(InvestorAccountType).optional(),
-  regAQualified: z
-    .string()
-    .optional()
-    .refine((v) => !v || v === 'true' || v === 'false', {
-      message: 'regAQualified must be a boolean string',
-    }),
-  regCfQualified: z
-    .string()
-    .optional()
-    .refine((v) => !v || v === 'true' || v === 'false', {
-      message: 'regCfQualified must be a boolean string',
-    }),
-  regDQualified: z
-    .string()
-    .optional()
-    .refine((v) => !v || v === 'true' || v === 'false', {
-      message: 'regDQualified must be a boolean string',
-    }),
-  withPortfolio: z
-    .string()
-    .optional()
-    .refine((v) => !v || v === 'true' || v === 'false', {
-      message: 'withPortfolio should be boolean',
-    })
-    .transform((withPortfolio) =>
-      withPortfolio === 'true'
+  regAQualified: z.preprocess(
+    (val) =>
+      val === 'true' || val === '1'
         ? true
-        : withPortfolio === 'false'
+        : val === 'false' || val === '0'
           ? false
-          : undefined,
-    ),
+          : val,
+    z.boolean().optional(),
+  ),
+  regCfQualified: z.preprocess(
+    (val) =>
+      val === 'true' || val === '1'
+        ? true
+        : val === 'false' || val === '0'
+          ? false
+          : val,
+    z.boolean().optional(),
+  ),
+  regDQualified: z.preprocess(
+    (val) =>
+      val === 'true' || val === '1'
+        ? true
+        : val === 'false' || val === '0'
+          ? false
+          : val,
+    z.boolean().optional(),
+  ),
+  withPortfolio: z.preprocess(
+    (val) =>
+      val === 'true' || val === '1'
+        ? true
+        : val === 'false' || val === '0'
+          ? false
+          : val,
+    z.boolean().optional(),
+  ),
 });
 
 export const InvestorAccountExportFilters =
@@ -373,6 +397,42 @@ export type IPaginatedRegisteredInvestorUserZod = z.infer<
   typeof IPaginatedRegisteredInvestorUserZod
 >;
 
+/**
+ * Schema for raw query result from queryRegisteredInvestorUsers
+ * Matches the structure returned by getRawMany() with JSON aggregations.
+ * PostgreSQL/TypeORM automatically parses JSON fields, so they come as arrays.
+ */
+const IndividualAggregationZod = z.object({
+  id: z.lazy(() => individualIdSchema),
+  phone: z.lazy(() => PhoneZodSchema),
+  firstName: z.string().nullable(),
+  lastName: z.string().nullable(),
+});
+
+const LegalEntityAggregationZod = z.object({
+  id: z.lazy(() => legalEntityIdSchema),
+  phone: z.lazy(() => PhoneZodSchema),
+  name: z.string().nullable(),
+});
+
+export const RegisteredInvestorUserRawZod = z.object({
+  id: z.lazy(() => userIdSchema),
+  name: z.string(),
+  email: z.string().email(),
+  investorAccountType: z.nativeEnum(InvestorAccountType).nullable(),
+  numberOfTrades: z.coerce.number().default(0),
+  invested: z.coerce.number().default(0),
+  createdAt: z.coerce.date(),
+  type: z.nativeEnum(UserType).nullable(),
+  investorAccountId: z.string().nullable(),
+  individuals: z.array(IndividualAggregationZod),
+  legalEntities: z.array(LegalEntityAggregationZod),
+});
+
+export type RegisteredInvestorUserRawZod = z.infer<
+  typeof RegisteredInvestorUserRawZod
+>;
+
 export const RegisteredInvestorUserFiltersZod = z.object({
   search: z.string().optional().openapi({ example: 'John Doe' }),
   startDate: dateSchema.optional().openapi({ example: 'MM/DD/YYYY' }),
@@ -1166,3 +1226,14 @@ export const INVESTOR_ACCOUNT_FIELDS_MAP = {
     ],
   },
 };
+
+export const ExportRegisteredInvestorUsersFiltersZod = z.object({
+  search: z.string().optional(),
+  startDate: dateSchema.optional(),
+  endDate: dateSchema.optional(),
+  userType: z.nativeEnum(UserType).optional(),
+});
+
+export type ExportRegisteredInvestorUsersFiltersZod = z.infer<
+  typeof ExportRegisteredInvestorUsersFiltersZod
+>;

package/common/types/phone.type.ts

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { normalizePhoneNumber } from '../helpers';
+import { normalizePhoneNumber } from './contract-helpers';
 import { CountryCodes } from './countries.types';
 import { CountryCode } from 'libphonenumber-js';
 import { ok } from 'neverthrow';

package/common/types/secondary-trade.types.ts

@@ -56,6 +56,7 @@ export const SecondaryTradeFiltersZod = z.object({
   complianceReview: z.nativeEnum(ComplianceReview).optional(),
 });
 
+export type SecondaryTradeFiltersZod = z.infer<typeof SecondaryTradeFiltersZod>;
 export const ExportSecondaryTradesResponse = z.object({
   message: z.string(),
 });
@@ -85,3 +86,10 @@ export const IPaginatedSecondaryTradeSummaryResponse = z.object({
 export type IPaginatedSecondaryTradeSummaryResponse = z.infer<
   typeof IPaginatedSecondaryTradeSummaryResponse
 >;
+
+export const CountResultZod = z.array(
+  z.object({
+    count: z.string(),
+  }),
+);
+export type CountResultZod = z.infer<typeof CountResultZod>;

package/common/types/trade.types.ts

@@ -30,7 +30,12 @@ import {
   paymentMethodIdSchema,
   PaymentMethodType,
 } from './payment-methods.types';
-import { investorAccountIdSchema } from './investor-account.types';
+import {
+  investorAccountIdSchema,
+  InvestorAccountExportFilters,
+  ComplianceInvestorAccountExportFilters,
+  RegisteredInvestorUserRawZod,
+} from './investor-account.types';
 import {
   tradeLineItemIdSchema,
   TradeLineItemZod,
@@ -40,6 +45,16 @@ import { TransactionZod } from './transaction.types';
 import { accountIdSchema } from './account.types';
 import { userIdSchema } from './user.types';
 import { issuerIdSchema } from './issuer.types';
+import {
+  GetSecondaryCustomerFiltersZod,
+  SecondaryCustomer,
+} from './secondary-customer.types';
+import {
+  SecondaryTrade,
+  SecondaryTradeFiltersZod,
+} from './secondary-trade.types';
+import { InvestorAccount } from '../../investor-accounts/entities/investor-account.entity';
+import { Trade } from '../../trades/entities/trade.entity';
 
 extendZodWithOpenApi(z);
 export const CheckResultsSchema = z.object({
@@ -107,6 +122,12 @@ export enum TradeSystemLogType {
   KYC_CHECK = 'KYC Check',
   AML_CHECK = 'AML Check',
   AIC_CHECK = 'AIC Check',
+  USER_AGE_CHECK = 'User Age Check',
+  KYC_NAME_CHECK = 'KYC Name Check',
+  AML_NAME_CHECK = 'AML Name Check',
+  AIC_NAME_CHECK = 'AIC Name Check',
+  KYC_DOB_CHECK = 'KYC DOB Check',
+  AIC_SSN_CHECK = 'AIC SSN Check',
   // Data Integrity Checks For Imported Trades
   SHARES_CHECK = 'Shares Check',
   PRICE_PER_UNIT_CHECK = 'Price Per Unit Check',
@@ -447,6 +468,7 @@ export const ExportTradesQuery = PaginationOptionsZod.merge(TradeFiltersZod)
       .optional()
       .default(TradeExportType.PAGE),
   });
+export type ExportTradesQuery = z.infer<typeof ExportTradesQuery>;
 
 const tradesColumn = z.enum([
   'id',
@@ -847,3 +869,61 @@ export const NON_CANCELABLE_COMPLIANCE_REVIEW_STATUSES = [
   ComplianceReview.REJECTED,
   ComplianceReview.CANCELLED,
 ];
+
+/**
+ * Filter type for Investor Account exports in workers
+ * Extends the base InvestorAccountExportFilters with additional optional fields needed for bulk exports
+ */
+export type WorkerInvestorAccountExportFilters = Partial<
+  (InvestorAccountExportFilters | ComplianceInvestorAccountExportFilters) & {
+    isRegisteredUsersExport: boolean | null;
+    search: string | null;
+    startDate: Date | null;
+    endDate: Date | null;
+    userType: string | null;
+    accountId: string | null;
+  }
+>;
+/**
+ * Filter type for Trade exports
+ * Extends IssuersTradeFiltersZod with accountId
+ */
+export type TradeExportFilters = Partial<
+  IssuersTradeFiltersZod & {
+    accountId: string | null;
+  }
+>;
+
+/**
+ * Filter type for Compliance Trade exports
+ */
+export type ComplianceTradeExportFilters = Partial<ExportTradesQuery>;
+
+/**
+ * Filter type for Secondary Customer exports
+ */
+export type SecondaryCustomerExportFilters =
+  Partial<GetSecondaryCustomerFiltersZod>;
+
+/**
+ * Filter type for Secondary Trade exports
+ */
+export type SecondaryTradeExportFilters = Partial<SecondaryTradeFiltersZod>;
+
+/**
+ * Combined filter type for all bulk export types
+ * Used in the ExportBulkDataDto
+ */
+export type BulkExportFilters =
+  | WorkerInvestorAccountExportFilters
+  | TradeExportFilters
+  | ComplianceTradeExportFilters
+  | SecondaryCustomerExportFilters
+  | SecondaryTradeExportFilters;
+
+export type BulkExportResponse =
+  | InvestorAccount[]
+  | RegisteredInvestorUserRawZod[]
+  | Trade[]
+  | SecondaryCustomer[]
+  | SecondaryTrade[];

package/common/types/user.types.ts

@@ -157,6 +157,7 @@ export const UserZod = IBaseEntity.extend({
   onboarding: z.string().nullable(),
   account: AccountWithoutUsersZod.optional(),
   active: z.boolean(),
+  status: z.nativeEnum(UserStatus),
   userLogin: IBaseEntity.extend({
     firstName: z.string(),
     lastName: z.string(),
@@ -284,6 +285,7 @@ export const UsersSummaryFilterZod = z.object({
   portalType: z.nativeEnum(PortalType).optional(),
   search: z.string().trim().max(50).optional(),
   selectRole: z.nativeEnum(UserRole).optional(),
+  status: z.nativeEnum(UserStatus).optional(),
 });
 export type UsersSummaryFilterZod = z.infer<typeof UsersSummaryFilterZod>;
 

package/contracts/clients/accounts/index.ts

@@ -9,6 +9,7 @@ import {
   AccountsIncludeQuery,
   AccountZod,
   accountIdSchema,
+  InternalError,
 } from '../../../common/types';
 import { z } from 'zod';
 
@@ -32,6 +33,7 @@ export const accountsContract = c.router(
         401: UnauthorizedError,
         403: ForbiddenError,
         404: NotFoundError,
+        500: InternalError,
       },
     },
     getAccounts: {
@@ -49,6 +51,7 @@ export const accountsContract = c.router(
         200: IPaginatedAccount,
         401: UnauthorizedError,
         403: ForbiddenError,
+        500: InternalError,
       },
     },
   },

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',
+  },
+);