@dalmore/api-contracts 0.0.0-dev.0fb0042 → 0.0.0-dev.15e31bc

package/common/types/trade.types.ts

@@ -22,12 +22,13 @@ import {
   AccountStatus,
   SavedQuery,
 } from './common.types';
-import { offeringIdSchema } from './offering.types';
+import { IOffering, offeringIdSchema } from './offering.types';
 import { IBaseEntity } from './entity.types';
 import { extendZodWithOpenApi } from '@anatine/zod-openapi';
 import { TypeID } from 'typeid-js';
 import {
   paymentMethodIdSchema,
+  PaymentMethodResponse,
   PaymentMethodType,
 } from './payment-methods.types';
 import {
@@ -35,11 +36,12 @@ import {
   InvestorAccountExportFilters,
   ComplianceInvestorAccountExportFilters,
   RegisteredInvestorUserRawZod,
+  IInvestorAccount,
 } from './investor-account.types';
 import {
   tradeLineItemIdSchema,
   TradeLineItemZod,
-} from './trade-line-item.type';
+} from './trade-line-item.types';
 import { TradeAdjustmentZod } from './trade-adjustment.type';
 import { TransactionZod } from './transaction.types';
 import { accountIdSchema } from './account.types';
@@ -132,6 +134,7 @@ export const CheckResultsSchema = z.object({
 export type CheckResults = z.infer<typeof CheckResultsSchema>;
 
 export const TradeIdPrefix = 'trade';
+export const TradeSnapshotIdPrefix = 'trade_snapshot';
 
 export const tradeIdSchema = z.string().refine(
   (value) => {
@@ -170,6 +173,21 @@ export const tradeIdOrTidSchema = z.union([
     .openapi({ example: 'tid_00041061050r3gg28a1c60t3gf' }),
 ]);
 
+export const tradeSnapshotIdSchema = z.string().refine(
+  (value) => {
+    try {
+      const tid = TypeID.fromString(value);
+      return tid.getType() === TradeSnapshotIdPrefix;
+    } catch {
+      return false;
+    }
+  },
+  {
+    message:
+      'Invalid trade snapshot ID format. Must be a valid TypeID with "trade_snapshot" prefix. ex: trade_snapshot_00041061050r3gg28a1c60t3gf',
+  },
+);
+
 export enum SaStatus {
   PENDING = BaseStatus.PENDING,
   SIGNED = BaseStatus.SIGNED,
@@ -274,9 +292,21 @@ export type TradeBalanceResultZod = z.infer<typeof TradeBalanceResultZod>;
 
 export const TradeZod = IBaseEntity.extend({
   investorAccountId: z.lazy(() => investorAccountIdSchema.nullable()),
+  investorAccount: z
+    .lazy(() => IInvestorAccount)
+    .optional()
+    .nullable(),
+  offering: z
+    .lazy(() => IOffering)
+    .optional()
+    .nullable(),
   accountId: accountIdSchema.nullable(),
   offeringId: z.lazy(() => offeringIdSchema.nullable()),
   paymentMethodId: z.lazy(() => paymentMethodIdSchema).nullable(),
+  paymentMethod: z
+    .lazy(() => PaymentMethodResponse)
+    .optional()
+    .nullable(),
   userId: z.lazy(() => userIdSchema.nullable()),
   tradeNumber: z.string(),
   ip: z.string().nullable(),
@@ -342,6 +372,21 @@ export const TradeZod = IBaseEntity.extend({
 });
 export type TradeZod = z.infer<typeof TradeZod>;
 
+export enum SnapshotEvent {
+  COMPLIANCE_APPROVED = 'COMPLIANCE_APPROVED',
+  COMPLIANCE_REJECTED = 'COMPLIANCE_REJECTED',
+  CANCELLED = 'CANCELLED',
+  PLACED = 'PLACED',
+  SETTLED = 'SETTLED',
+}
+
+export const GetTradeSnapshotEventsResponse = z.object({
+  events: z.array(z.nativeEnum(SnapshotEvent)),
+});
+export type GetTradeSnapshotEventsResponse = z.infer<
+  typeof GetTradeSnapshotEventsResponse
+>;
+
 export const IPaginatedTrade = z.object({
   items: z.array(TradeZod),
   meta: IPaginationMeta,
@@ -424,6 +469,7 @@ export const TradeFiltersZod = z.object({
     .openapi({
       example: 'issuer_01jfw4q6qef30s6fpqtsxw94ya',
     }),
+  snapshotEvent: z.nativeEnum(SnapshotEvent).optional(),
   offeringType: z.nativeEnum(OfferingType).optional(),
   managedBy: z.nativeEnum(ManagedByType).optional(),
   platform: z.nativeEnum(Platforms).optional(),

package/common/types/trusted-contact.types.ts

@@ -2,7 +2,11 @@ import { extendZodWithOpenApi } from '@anatine/zod-openapi';
 import { TypeID } from 'typeid-js';
 import { z } from 'zod';
 import { IBaseEntity } from './entity.types';
-import { IPaginationMeta, TrustedContactRelationship } from './common.types';
+import {
+  EmailSchema,
+  IPaginationMeta,
+  TrustedContactRelationship,
+} from './common.types';
 import { PhoneZodSchema } from './phone.type';
 import { AddressSchema } from './address.types';
 import { investorAccountIdSchema } from './investor-account.types';
@@ -68,7 +72,7 @@ export const PostTrustedContactZod = z
   .object({
     firstName: z.string().min(1).max(255).openapi({ example: 'John' }),
     lastName: z.string().min(1).max(255).openapi({ example: 'Doe' }),
-    email: z.string().email().openapi({ example: 'john.doe@example.com' }),
+    email: EmailSchema.openapi({ example: 'john.doe@example.com' }),
     phone: PhoneZodSchema.nullable().optional(),
     relationship: z
       .nativeEnum(TrustedContactRelationship)
@@ -92,11 +96,7 @@ export const PatchTrustedContactZod = z
       .optional()
       .openapi({ example: 'John' }),
     lastName: z.string().min(1).max(255).optional().openapi({ example: 'Doe' }),
-    email: z
-      .string()
-      .email()
-      .optional()
-      .openapi({ example: 'john.doe@example.com' }),
+    email: EmailSchema.optional(),
     phone: PhoneZodSchema.nullable().optional(),
     relationship: z.nativeEnum(TrustedContactRelationship).optional().openapi({
       example: TrustedContactRelationship.CHILD,

package/common/types/user.types.ts

@@ -8,9 +8,10 @@ import {
   ManagedByType,
   OfferingType,
   PortalType,
+  StringToBooleanSchema,
   UserRole,
-  UserStatus,
   UserType,
+  EmailSchema,
 } from './common.types';
 import { dateOrString, IBaseEntity } from './entity.types';
 import { PhoneZodSchema } from './phone.type';
@@ -64,7 +65,7 @@ export const GetMeResponse = IBaseEntity.extend({
   email: z.string().email(),
   provider: z.string(),
   active: z.boolean(),
-  status: z.lazy(() => z.nativeEnum(UserStatus)),
+  locked: z.boolean(),
   lastLoginAt: dateOrString.nullable(),
   loginCount: z.number(),
   role: z.string(),
@@ -147,11 +148,7 @@ export const UserMeUpdateZod = z.object({
   firstName: z.string().optional(),
   lastName: z.string().optional(),
   password: z.string().min(6).optional(),
-  email: z
-    .string()
-    .email()
-    .transform((val) => val.toLowerCase())
-    .optional(),
+  email: EmailSchema.optional(),
 });
 
 export const UserZod = IBaseEntity.extend({
@@ -162,7 +159,7 @@ export const UserZod = IBaseEntity.extend({
   onboarding: z.string().nullable(),
   account: AccountWithoutUsersZod.optional(),
   active: z.boolean(),
-  status: z.nativeEnum(UserStatus),
+  locked: z.boolean(),
   userLogin: IBaseEntity.extend({
     firstName: z.string(),
     lastName: z.string(),
@@ -184,27 +181,9 @@ export const UserFiltersZod = z.object({
   search: z.string().max(50).optional(),
   role: z.nativeEnum(UserRole).optional(),
   portal: z.string().optional(),
-  status: z.nativeEnum(UserStatus).optional(),
-  active: z
-    .string()
-    .optional()
-    .refine((v) => !v || v === 'true' || v === 'false', {
-      message: 'active must be a boolean string',
-    })
-    .transform((v) => {
-      if (!v) return undefined;
-      return v === 'true';
-    }),
-  twoFactorEnabled: z
-    .string()
-    .optional()
-    .refine((v) => !v || v === 'true' || v === 'false', {
-      message: 'twoFactorEnabled must be a boolean string',
-    })
-    .transform((v) => {
-      if (!v) return undefined;
-      return v === 'true';
-    }),
+  locked: StringToBooleanSchema.optional(),
+  active: StringToBooleanSchema.optional(),
+  twoFactorEnabled: StringToBooleanSchema.optional(),
 });
 
 const usersInclude = z.enum(['account', 'role']);
@@ -279,7 +258,7 @@ export type IssuerUsersStatusUpdateResponse = z.infer<
 >;
 
 export const UpdateLockedStatus = z.object({
-  status: z.nativeEnum(UserStatus),
+  locked: z.boolean(),
 });
 
 export type UpdateLockedStatus = z.infer<typeof UpdateLockedStatus>;
@@ -290,7 +269,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(),
+  locked: StringToBooleanSchema.optional(),
 });
 export type UsersSummaryFilterZod = z.infer<typeof UsersSummaryFilterZod>;
 
@@ -304,7 +283,7 @@ export const UsersSummaryZod = z.object({
   portalType: z.string(),
   loginCount: z.number().int(),
   lastLogin: z.date(),
-  status: z.nativeEnum(UserStatus),
+  locked: z.boolean(),
 });
 export type UsersSummaryZod = z.infer<typeof UsersSummaryZod>;
 

package/contracts/clients/trade-line-items/index.ts

@@ -14,7 +14,7 @@ import {
   TradeLineItemQuery,
   TradeLineItemResponse,
   TradeLineItemUpdate,
-} from '../../../common/types/trade-line-item.type';
+} from '../../../common/types/trade-line-item.types';
 
 const c = initContract();
 

package/contracts/clients/trades/index.ts

@@ -26,7 +26,7 @@ import {
   PostTradeLineItem,
   TradeLineItemQuery,
   TradeLineItemResponse,
-} from '../../../common/types/trade-line-item.type';
+} from '../../../common/types/trade-line-item.types';
 
 const c = initContract();
 

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

@@ -0,0 +1,59 @@
+import { initContract } from '@ts-rest/core';
+import { z } from 'zod';
+import {
+  accountSettingIdSchema,
+  AccountSettingsFilters,
+  AccountSettingsIncludeQuery,
+  IAccountSettingZod,
+  IPaginatedAccountSetting,
+} from '../../../common/types/account-setting.types';
+import {
+  InternalError,
+  NotFoundError,
+  PaginationOptionsZod,
+  UnauthorizedError,
+} from '../../../common/types';
+
+const c = initContract();
+
+export const accountSettingsContract = c.router(
+  {
+    getAccountSettings: {
+      summary: 'Get account settings',
+      method: 'GET',
+      path: '',
+      metadata: {
+        auth: true,
+      },
+      query: PaginationOptionsZod.merge(AccountSettingsFilters).merge(
+        AccountSettingsIncludeQuery,
+      ),
+      responses: {
+        200: IPaginatedAccountSetting,
+        401: UnauthorizedError,
+        500: InternalError,
+      },
+    },
+    getAccountSetting: {
+      summary: 'Get account setting by id',
+      method: 'GET',
+      path: '/:id',
+      metadata: {
+        auth: true,
+      },
+      pathParams: z.object({
+        id: accountSettingIdSchema,
+      }),
+      query: z.object({}).merge(AccountSettingsIncludeQuery),
+      responses: {
+        200: IAccountSettingZod,
+        401: UnauthorizedError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
+  },
+  {
+    pathPrefix: 'account-settings',
+  },
+);

package/contracts/compliance/auth/index.ts

@@ -10,6 +10,7 @@ import {
   LoginBody2FA,
   NotFoundError,
   UnauthorizedError,
+  EmailSchema,
 } from '../../../common/types';
 import { z } from 'zod';
 
@@ -49,7 +50,7 @@ export const authContract = c.router(
       method: 'POST',
       path: 'forgot-password',
       body: z.object({
-        email: z.string().email(),
+        email: EmailSchema,
       }),
       responses: {
         200: null,
@@ -75,7 +76,7 @@ export const authContract = c.router(
       method: 'POST',
       path: 'reset-password/verify',
       body: z.object({
-        email: z.string().email(),
+        email: EmailSchema,
         code: z.string(),
       }),
       responses: {
@@ -90,7 +91,7 @@ export const authContract = c.router(
       method: 'POST',
       path: 'reset-password',
       body: z.object({
-        email: z.string().email(),
+        email: EmailSchema,
         code: z.string(),
         password: z.string().min(6),
       }),

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

@@ -6,10 +6,12 @@ import {
   UnauthorizedError,
 } from '../../../common/types';
 import {
+  ComplianceEstimateBonusTierCalculationZod,
   CompliancePostBonusTierZod,
   EstimateBonusTierCalculationResponseZod,
-  EstimateBonusTierCalculationZod,
   IBonusTierList,
+  PurchaseCalculationResponseZod,
+  PurchaseCalculationZod,
 } from '../../../common/types/bonus-tier.types';
 
 const c = initContract();
@@ -23,7 +25,7 @@ export const bonusTiersContract = c.router(
       metadata: {
         auth: true,
       },
-      body: EstimateBonusTierCalculationZod,
+      body: ComplianceEstimateBonusTierCalculationZod,
       responses: {
         200: EstimateBonusTierCalculationResponseZod,
         400: BadRequestError,
@@ -32,6 +34,23 @@ export const bonusTiersContract = c.router(
         500: InternalError,
       },
     },
+    purchaseCalculation: {
+      summary:
+        '[ADMIN] Calculate the bonus shares that would be awarded for a trade',
+      method: 'POST',
+      path: '/purchase-calculation',
+      metadata: {
+        auth: true,
+      },
+      body: PurchaseCalculationZod,
+      responses: {
+        200: PurchaseCalculationResponseZod,
+        400: BadRequestError,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        500: InternalError,
+      },
+    },
     postBonusTier: {
       summary: 'Create a new bonus tier',
       method: 'POST',

package/contracts/compliance/index.ts

@@ -1,6 +1,7 @@
 import { accountsContract } from './accounts';
 import { accountContactsContract } from './account-contacts';
 import { accountManagersContract } from './account-managers';
+import { accountSettingsContract } from './account-settings';
 import { activitiesContract } from './activities';
 import { apiKeysContract } from './api-keys';
 import { assetsContract } from './assets';
@@ -31,6 +32,7 @@ import { kycsContract } from './kyc';
 import { legalEntitiesContract } from './legal-entities';
 import { loginHistoriesContract } from './login-histories';
 import { notesContract } from './notes';
+import { notificationChannelsContract } from './notification-channels';
 import { offeringsContract } from './offerings';
 import { pagesContract } from './pages';
 import { paymentMethodsContract } from './payment-methods';
@@ -75,6 +77,7 @@ export const complianceContract = c.router(
     accounts: accountsContract,
     accountContacts: accountContactsContract,
     accountManagers: accountManagersContract,
+    accountSettings: accountSettingsContract,
     activities: activitiesContract,
     apiKeys: apiKeysContract,
     assets: assetsContract,
@@ -112,6 +115,7 @@ export const complianceContract = c.router(
     legalEntities: legalEntitiesContract,
     loginHistories: loginHistoriesContract,
     notes: notesContract,
+    notificationChannels: notificationChannelsContract,
     offerings: offeringsContract,
     pages: pagesContract,
     paymentMethods: paymentMethodsContract,

package/contracts/compliance/invites/index.ts

@@ -1,6 +1,7 @@
 import { initContract } from '@ts-rest/core';
 import {
   BadRequestError,
+  CompliancePostInviteZod,
   ForbiddenError,
   InternalError,
   inviteIdSchema,
@@ -10,9 +11,8 @@ import {
   NotFoundError,
   PaginationOptionsZod,
   PatchInviteForComplianceZod,
-  PortalType,
+  PostInviteZod,
   UnauthorizedError,
-  UserRole,
 } from '../../../common/types';
 import { z } from 'zod';
 
@@ -42,12 +42,7 @@ export const invitesContract = c.router(
       metadata: {
         auth: true,
       },
-      body: z.object({
-        email: z.string().email(),
-        role: z.nativeEnum(UserRole),
-        accountId: z.string().optional(),
-        portalType: z.nativeEnum(PortalType).optional(),
-      }),
+      body: PostInviteZod,
       responses: {
         201: InviteWithUrl,
         400: BadRequestError,
@@ -62,10 +57,7 @@ export const invitesContract = c.router(
       metadata: {
         auth: true,
       },
-      body: z.object({
-        email: z.string().email(),
-        role: z.nativeEnum(UserRole),
-      }),
+      body: CompliancePostInviteZod,
       responses: {
         201: InviteWithUrl,
         400: BadRequestError,