@dalmore/api-contracts 0.0.0-dev.d6badc9 → 0.0.0-dev.e6235a7

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

@@ -6,6 +6,7 @@ import { PhoneZodSchema } from './phone.type';
 import {
   AccountContactType,
   AccountZod,
+  EmailSchema,
   IPaginationMeta,
 } from './common.types';
 import { IBaseEntity } from './entity.types';
@@ -60,7 +61,7 @@ export const PatchAccountContactZod = z.object({
     .openapi({ example: 'Mr' }),
   firstName: z.string().min(1).max(150).openapi({ example: 'John' }),
   lastName: z.string().min(1).max(150).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()
     .openapi({ example: '+12124567890' }),

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

@@ -4,7 +4,7 @@ import { TypeID } from 'typeid-js';
 import { IBaseEntity } from './entity.types';
 import { PhoneNumberData } from './sms.types';
 import { userIdSchema, UserZod } from './user.types';
-import { IPaginationMeta } from './common.types';
+import { EmailSchema, IPaginationMeta } from './common.types';
 import { PhoneZodSchema } from './phone.type';
 
 extendZodWithOpenApi(z);
@@ -68,7 +68,7 @@ export type IAccountManagerZod = z.infer<typeof IAccountManagerZod>;
 export const PostAccountManagerZod = 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,
   phone: PhoneZodSchema.nullable()
     .optional()
     .openapi({ example: '+12124567890' }),
@@ -80,11 +80,7 @@ export type PostAccountManagerZod = z.infer<typeof PostAccountManagerZod>;
 export const PatchAccountManagerZod = z.object({
   firstName: z.string().min(1).max(255).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()
     .openapi({ example: '+12124567890' }),

package/common/types/auth.types.ts

@@ -8,6 +8,7 @@ import {
   ManagedByType,
   UserRole,
   createUrlSchema,
+  EmailSchema,
 } from './common.types';
 import { TypeID } from 'typeid-js';
 import { TwoFactorMethod } from './sms.types';
@@ -60,13 +61,7 @@ const BaseAuthBody = z.object({
     .openapi({
       example: 'Armstrong',
     }),
-  email: z
-    .string()
-    .email()
-    .transform((val) => val.toLowerCase())
-    .openapi({
-      example: 'neil@dalmoregroup.com',
-    }),
+  email: EmailSchema,
   password: PasswordSchema,
 });
 
@@ -99,13 +94,7 @@ export const IChangePasswordBodyZod = z
   });
 
 export const LoginBody = z.object({
-  email: z
-    .string()
-    .email()
-    .transform((val) => val.toLowerCase())
-    .openapi({
-      example: 'neil@dalmoregroup.com',
-    }),
+  email: EmailSchema,
   password: z.string().openapi({
     example: 'Secretpassword6#',
   }),
@@ -297,7 +286,7 @@ export const RegisterBodyInvestors = BaseAuthBody.extend({
 });
 
 export const ResetPasswordVerifyBody = z.object({
-  email: z.string().email(),
+  email: EmailSchema,
   code: z.string().length(6, 'code is not 6 characters').openapi({
     example: '123456',
   }),
@@ -315,7 +304,7 @@ export type ResetPasswordVerifyResponseType = z.infer<
 >;
 
 export const ResetPasswordBody = z.object({
-  email: z.string().email(),
+  email: EmailSchema,
   code: z.string().length(6, 'code is not 6 characters').openapi({
     example: '123456',
   }),
@@ -337,7 +326,7 @@ export type ClientAuthSuccessResponse = z.infer<
 >;
 
 export const AdminForgotPasswordRequestZod = z.object({
-  email: z.string().email(),
+  email: EmailSchema,
   portal: z.nativeEnum(PortalType),
 });
 export type AdminForgotPasswordRequestZod = z.infer<
@@ -345,7 +334,7 @@ export type AdminForgotPasswordRequestZod = z.infer<
 >;
 
 export const InvestorForgotPasswordRequestZod = z.object({
-  email: z.string().email(),
+  email: EmailSchema,
   url: createUrlSchema({ strict: true }),
 });
 export type InvestorForgotPasswordRequestZod = z.infer<

package/common/types/common.types.ts

@@ -1528,3 +1528,19 @@ export const StringToBooleanSchema = z.preprocess(
   z.boolean(),
 );
 export type StringToBooleanSchema = z.infer<typeof StringToBooleanSchema>;
+
+/**
+ * Reusable email schema that validates email format, transforms to lowercase,
+ * and includes OpenAPI metadata.
+ *
+ * @example
+ * EmailSchema.parse('John.Doe@EXAMPLE.COM'); // returns 'john.doe@example.com'
+ * EmailSchema.optional().parse(undefined); // returns undefined
+ */
+export const EmailSchema = z
+  .string()
+  .email()
+  .transform((val) => val.toLowerCase())
+  .openapi({
+    example: 'neil@dalmoregroup.com',
+  });

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

@@ -1,7 +1,11 @@
 import { z } from 'zod';
 import { extendZodWithOpenApi } from '@anatine/zod-openapi';
 import { TypeID } from 'typeid-js';
-import { BaseContactUsOptions, createUrlSchema } from './common.types';
+import {
+  BaseContactUsOptions,
+  createUrlSchema,
+  EmailSchema,
+} from './common.types';
 extendZodWithOpenApi(z);
 
 export const contactUsIdSchema = z.string().refine(
@@ -55,7 +59,7 @@ export const InvestorPostContactUsZod = PostContactUsZod.extend({
 export type InvestorPostContactUsZod = z.infer<typeof InvestorPostContactUsZod>;
 
 export const PublicInvestorContactUsZod = PostContactUsZod.extend({
-  email: z.string().email().openapi({ example: 'email@example.com' }),
+  email: EmailSchema,
   firstName: z.string().min(1).max(100).openapi({ example: 'John' }),
   lastName: z.string().min(1).max(100).openapi({ example: 'Doe' }),
   contactOption: z.nativeEnum(InvestorContactOptions).openapi({

package/common/types/covered-person.types.ts

@@ -6,6 +6,7 @@ import {
   ComplianceReview,
   CoveredPersonsRoleType,
   CoveredPersonsStatus,
+  EmailSchema,
   IDType,
   IPaginationMeta,
 } from './common.types';
@@ -137,7 +138,7 @@ export const PatchCoveredPersonsZod = z
       .openapi({ example: CoveredPersonsRoleType.ACCOUNTING }),
 
     ownership: z.number().min(0).max(100).openapi({ example: 15 }).optional(),
-    email: z.string().nullable().optional(),
+    email: EmailSchema.nullable().optional(),
     idType: z
       .nativeEnum(IDType)
       .optional()

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

@@ -1,6 +1,6 @@
 import { extendZodWithOpenApi } from '@anatine/zod-openapi';
 import { z } from 'zod';
-import { AccountZod, IPaginationMeta } from './common.types';
+import { AccountZod, EmailSchema, IPaginationMeta } from './common.types';
 import { IBaseEntity } from './entity.types';
 import { TypeID } from 'typeid-js';
 import { accountIdSchema } from './account.types';
@@ -43,7 +43,7 @@ export const PostEscrowAccount = z.object({
   accountNumber: z.string().optional().nullable(),
   routingNumber: z.string().min(9).max(9).optional().nullable(),
   agentName: z.string().min(2).max(50),
-  agentEmail: z.string().email(),
+  agentEmail: EmailSchema,
 });
 
 export type PostEscrowAccount = z.infer<typeof PostEscrowAccount>;
@@ -65,7 +65,7 @@ export const PatchEscrowAccount = z.object({
   accountNumber: z.string().min(10).max(18).optional().nullable().optional(),
   routingNumber: z.string().min(9).max(9).optional().nullable().optional(),
   agentName: z.string().min(2).max(50).optional(),
-  agentEmail: z.string().email().optional(),
+  agentEmail: EmailSchema.optional(),
 });
 
 export type PatchEscrowAccount = z.infer<typeof PatchEscrowAccount>;

package/common/types/individuals.types.ts

@@ -16,6 +16,7 @@ import {
   EmploymentStatus,
   SourceOfIncome,
   AMLProvider,
+  EmailSchema,
 } from './common.types';
 import { IBaseEntity } from './entity.types';
 import { IInvestorAccount } from './investor-account.types';
@@ -288,7 +289,7 @@ export const PostIndividualBodySchema = z
       .string()
       .length(3, 'currencyCode must be 3 digits')
       .optional(),
-    email: z.string().email().optional(),
+    email: EmailSchema.optional(),
     role: z.nativeEnum(IndividualRole),
     phone: PhoneZodSchema.openapi({ example: '+12124567890' }).optional(),
     ownership: z.coerce
@@ -387,7 +388,7 @@ export const UpdateIndividualBodySchema = z
       .length(3, 'currencyCode must be 3 digits')
       .optional(),
     phone: PhoneZodSchema.openapi({ example: '+12124567890' }).optional(),
-    email: z.string().email().optional(),
+    email: EmailSchema.optional(),
     ownership: z.coerce
       .number()
       .min(0, 'Ownership is less than 0')

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

@@ -24,6 +24,7 @@ import {
   SortBy,
   SortOrder,
   AMLProvider,
+  EmailSchema,
 } from './common.types';
 import { accountIdSchema } from './account.types';
 import { SaStatus, tradeIdSchema, TradeZod } from './trade.types';
@@ -131,7 +132,7 @@ export type PostClientInvestorAccountBody = z.infer<
 
 export const UpdateInvestorAccountBodySchema = z.object({
   name: z.string().optional(),
-  email: z.string().email().optional(),
+  email: EmailSchema.optional(),
 });
 export type UpdateInvestorAccountBody = z.infer<
   typeof UpdateInvestorAccountBodySchema

package/common/types/invite.types.ts

@@ -3,7 +3,9 @@ import {
   AccountZod,
   IPaginationMeta,
   IssuerRole,
+  PortalType,
   UserRole,
+  EmailSchema,
 } from './common.types';
 import { extendZodWithOpenApi } from '@anatine/zod-openapi';
 import { TypeID } from 'typeid-js';
@@ -48,7 +50,7 @@ export const InviteWithUrl = InviteWithoutSecretZod.extend({
 export type InviteWithUrl = z.infer<typeof InviteWithUrl>;
 
 export const PostIssuerInviteZod = z.object({
-  email: z.string().email(),
+  email: EmailSchema,
   role: z.nativeEnum(IssuerRole),
 });
 
@@ -131,3 +133,27 @@ export const PatchInviteForComplianceZod = PatchInviteRoleZod.extend({
 export type PatchInviteForComplianceZod = z.infer<
   typeof PatchInviteForComplianceZod
 >;
+
+export const PostInviteZod = z.object({
+  email: EmailSchema,
+  role: z.nativeEnum(UserRole).openapi({
+    example: UserRole.ADMIN,
+  }),
+  accountId: z.string().optional().openapi({
+    example: 'account_01j5y5ghx5fg68d663j1fvy2x7',
+  }),
+  portalType: z.nativeEnum(PortalType).optional().openapi({
+    example: PortalType.ISSUER,
+  }),
+});
+
+export type PostInviteZod = z.infer<typeof PostInviteZod>;
+
+export const CompliancePostInviteZod = z.object({
+  email: EmailSchema,
+  role: z.nativeEnum(UserRole).openapi({
+    example: UserRole.ADMIN,
+  }),
+});
+
+export type CompliancePostInviteZod = z.infer<typeof CompliancePostInviteZod>;

package/common/types/legal-entity.types.ts

@@ -2,6 +2,7 @@ import { z } from 'zod';
 import { IBaseEntity } from './entity.types';
 import {
   dateSchema,
+  EmailSchema,
   IPaginationMeta,
   KYBStatus,
   SanctionsStatus,
@@ -138,7 +139,7 @@ export const PostLegalEntitySchema = z
     investorAccountId: investorAccountIdSchema,
     name: CompanyNameSchema,
     ein: EINSchema,
-    email: z.string().email().optional(),
+    email: EmailSchema.optional(),
     companyType: CompanyTypeSchema.optional(),
     phone: PhoneZodSchema.openapi({ example: '+12124567890' }).optional(),
     dateOfIncorporation: z.lazy(() => dateSchema).optional(),
@@ -153,7 +154,7 @@ export const UpdateLegalEntitySchema = z
     id: legalEntityIdSchema.optional(),
     name: CompanyNameSchema.optional(),
     ein: EINSchema,
-    email: z.string().email().optional(),
+    email: EmailSchema.optional(),
     companyType: CompanyTypeSchema.optional(),
     phone: PhoneZodSchema.openapi({ example: '+12124567890' }).optional(),
     dateOfIncorporation: z.lazy(() => dateSchema).optional(),

package/common/types/site-settings.types.ts

@@ -3,6 +3,7 @@ import { z } from 'zod';
 import { fileIdSchema } from './file.types';
 import {
   AccountZod,
+  EmailSchema,
   HexCodeColorSchema,
   IPaginationMeta,
   SubdomainSchema,
@@ -462,7 +463,7 @@ export const GetSenderEmailZod = z.object({
 export type GetSenderEmailZod = z.infer<typeof GetSenderEmailZod>;
 
 export const PatchSenderEmailZod = z.object({
-  senderEmail: z.string().email().openapi({ example: 'example@example.com' }),
+  senderEmail: EmailSchema,
 });
 export type PatchSenderEmailZod = z.infer<typeof PatchSenderEmailZod>;
 

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

@@ -11,6 +11,7 @@ import {
   StringToBooleanSchema,
   UserRole,
   UserType,
+  EmailSchema,
 } from './common.types';
 import { dateOrString, IBaseEntity } from './entity.types';
 import { PhoneZodSchema } from './phone.type';
@@ -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({

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/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,

package/contracts/issuers/auth/index.ts

@@ -13,6 +13,7 @@ import {
   SelectAccountIssuersResponse,
   SwitchAccountIssuersBody,
   UnauthorizedError,
+  EmailSchema,
 } from '../../../common/types';
 import { z } from 'zod';
 
@@ -78,7 +79,7 @@ export const authContract = c.router(
       method: 'POST',
       path: 'forgot-password',
       body: z.object({
-        email: z.string().email(),
+        email: EmailSchema,
       }),
       responses: {
         200: z.string(),
@@ -92,7 +93,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: {
@@ -108,7 +109,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/issuers/disbursements/index.ts

@@ -117,23 +117,6 @@ export const disbursementsContract = c.router(
       },
     },
 
-    getDisbursement: {
-      summary: 'Get disbursement by id',
-      method: 'GET',
-      path: '/:id',
-      metadata: {
-        auth: true,
-      },
-      query: z.object({}).merge(DisbursementsIncludeQuery),
-      pathParams: z.object({ id: disbursementIdSchema }),
-      responses: {
-        200: DisbursementZod,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        404: NotFoundError,
-        500: InternalError,
-      },
-    },
     reviewDisbursements: {
       summary: 'Review Disbursements',
       method: 'POST',
@@ -182,6 +165,23 @@ export const disbursementsContract = c.router(
         500: InternalError,
       },
     },
+    getDisbursement: {
+      summary: 'Get disbursement by id',
+      method: 'GET',
+      path: '/:id',
+      metadata: {
+        auth: true,
+      },
+      query: z.object({}).merge(DisbursementsIncludeQuery),
+      pathParams: z.object({ id: disbursementIdSchema }),
+      responses: {
+        200: DisbursementZod,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
   },
   {
     pathPrefix: 'disbursements',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dalmore/api-contracts",
-  "version": "0.0.0-dev.d6badc9",
+  "version": "0.0.0-dev.e6235a7",
   "description": "Type-safe API contracts for Dalmore Client Portal",
   "main": "./contracts/index.ts",
   "types": "./contracts/index.ts",