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

package/common/types/user-setting.types.ts

@@ -1,133 +0,0 @@
-import { z } from 'zod';
-import { extendZodWithOpenApi } from '@anatine/zod-openapi';
-import { PhoneNumberData, TwoFactorMethod } from './sms.types';
-import { IBaseEntity } from './entity.types';
-import { PhoneZodSchema } from './phone.type';
-
-extendZodWithOpenApi(z);
-
-export const validPhoneNumberBody = z.object({
-  countryCode: z.string().length(2),
-  phoneNumber: PhoneZodSchema,
-});
-export type validPhoneNumberBody = z.infer<typeof validPhoneNumberBody>;
-
-export const validPhoneNumberResponse = PhoneNumberData;
-export type validPhoneNumberResponse = z.infer<typeof validPhoneNumberResponse>;
-
-export const userSettingsZod = IBaseEntity.extend({
-  userLoginId: z.string(),
-  twoFactorMethod: z.nativeEnum(TwoFactorMethod),
-  totpSecret: z.string().nullable(),
-  totpTemporarySecret: z.string().nullable(),
-  recoveryCodes: z.array(z.string()).nullable(),
-  phoneData: PhoneNumberData.nullable(),
-  phoneVerified: z.boolean(),
-  smsVerificationCode: z.string().nullable(),
-  smsCodeExpiresAt: z.date().nullable(),
-  emailVerified: z.boolean(),
-  emailVerificationCode: z.string().nullable(),
-  emailCodeExpiresAt: z.date().nullable(),
-});
-export type userSettingsZod = z.infer<typeof userSettingsZod>;
-
-export const setupPhoneNumberBody = z.object({
-  countryCode: z.string().length(2),
-  phoneNumber: PhoneZodSchema,
-});
-export type setupPhoneNumberBody = z.infer<typeof setupPhoneNumberBody>;
-
-export const setupPhoneNumberResponse = z.object({
-  success: z.boolean(),
-});
-export type setupPhoneNumberResponse = z.infer<typeof setupPhoneNumberResponse>;
-
-export const verifyPhoneNumberBody = z.object({
-  code: z.string(),
-});
-export type verifyPhoneNumberBody = z.infer<typeof verifyPhoneNumberBody>;
-
-export const verifyPhoneNumberResponse = z.object({
-  success: z.boolean(),
-});
-export type verifyPhoneNumberResponse = z.infer<
-  typeof verifyPhoneNumberResponse
->;
-
-export const sendVerificationCodeBody = z.object({});
-export type sendVerificationCodeBody = z.infer<typeof sendVerificationCodeBody>;
-
-export const sendVerificationCodeResponse = z.object({
-  success: z.boolean(),
-});
-export type sendVerificationCodeResponse = z.infer<
-  typeof sendVerificationCodeResponse
->;
-
-export const disableTwoFactorBody = z.object({
-  userLoginId: z.string(),
-});
-export type disableTwoFactorBody = z.infer<typeof disableTwoFactorBody>;
-
-export const disableTwoFactorResponse = z.object({
-  success: z.boolean(),
-});
-export type disableTwoFactorResponse = z.infer<typeof disableTwoFactorResponse>;
-
-export const setupTwoFactorResponse = z.object({
-  secret: z.string().openapi({
-    example: 'JBSWY3DPEHPK3PXP',
-  }),
-  qrCodeUrl: z.string().optional().openapi({
-    example: 'https://www.dalmoregroup.com/chl=otpauth://totp/DalmoreGroup',
-  }),
-});
-export type setupTwoFactorResponse = z.infer<typeof setupTwoFactorResponse>;
-
-export const verifyTwoFactorBody = z.object({
-  token: z.string().length(6).openapi({
-    example: '123456',
-  }),
-});
-export type verifyTwoFactorBody = z.infer<typeof verifyTwoFactorBody>;
-
-export const verifyTwoFactorResponse = z.object({
-  recoveryCodes: z.array(z.string()).openapi({
-    example: ['XXXX-XXXX-XXXX', 'XXXX-XXXX-XXXX'],
-  }),
-});
-export type verifyTwoFactorResponse = z.infer<typeof verifyTwoFactorResponse>;
-
-export const changeTwoFactorMethodBody = z.object({
-  twoFactorMethod: z.nativeEnum(TwoFactorMethod),
-});
-export type changeTwoFactorMethodBody = z.infer<
-  typeof changeTwoFactorMethodBody
->;
-
-export const sendEmailVerificationBody = z.object({});
-export type sendEmailVerificationBody = z.infer<
-  typeof sendEmailVerificationBody
->;
-
-export const sendEmailVerificationResponse = z.object({
-  success: z.boolean(),
-  expiresAt: z.string().openapi({
-    example: '2023-12-25T15:30:00Z',
-  }),
-});
-export type sendEmailVerificationResponse = z.infer<
-  typeof sendEmailVerificationResponse
->;
-
-export const verifyEmailBody = z.object({
-  code: z.string().length(6).openapi({
-    example: '123456',
-  }),
-});
-export type verifyEmailBody = z.infer<typeof verifyEmailBody>;
-
-export const verifyEmailResponse = z.object({
-  success: z.boolean(),
-});
-export type verifyEmailResponse = z.infer<typeof verifyEmailResponse>;

package/common/types/user.types.ts

@@ -1,304 +0,0 @@
-import { z } from 'zod';
-import { extendZodWithOpenApi } from '@anatine/zod-openapi';
-import {
-  AccountStatus,
-  AccountWithoutUsersZod,
-  IPaginationMeta,
-  IssuerRole,
-  ManagedByType,
-  OfferingType,
-  PortalType,
-  StringToBooleanSchema,
-  UserRole,
-  UserType,
-  EmailSchema,
-} from './common.types';
-import { dateOrString, IBaseEntity } from './entity.types';
-import { PhoneZodSchema } from './phone.type';
-import { IInvestorAccount } from './investor-account.types';
-import { TradeZod } from './trade.types';
-import { PasswordSchema } from './password.type';
-import { accountIdSchema } from './account.types';
-import { TypeID } from 'typeid-js';
-import { issuerIdSchema } from './issuer.types';
-import { PhoneNumberData, TwoFactorMethod } from './sms.types';
-import { IAccountManagerZod } from './account-manager.types';
-import { IAccountContact } from './account-contact.types';
-extendZodWithOpenApi(z);
-
-export enum OnboardingType {
-  START = 'START',
-  CHECKOUT = 'CHECKOUT',
-  COMPLETE = 'COMPLETE',
-}
-
-export const userIdSchema = z.string().refine(
-  (value) => {
-    try {
-      const tid = TypeID.fromString(value);
-      return tid.getType() === 'user';
-    } catch {
-      return false;
-    }
-  },
-  {
-    message:
-      'Invalid user ID format. Must be a valid TypeID with "user" prefix.',
-  },
-);
-
-export const UserDeleteResponse = z.object({
-  message: z.string(),
-});
-export type UserDeleteResponse = z.infer<typeof UserDeleteResponse>;
-
-export const UserRestoreResponse = z.object({
-  message: z.string(),
-});
-export type UserRestoreResponse = z.infer<typeof UserRestoreResponse>;
-
-export const GetMeResponse = IBaseEntity.extend({
-  accountId: z.string().nullable(),
-  accountName: z.string().nullable(),
-  firstName: z.string(),
-  lastName: z.string(),
-  email: z.string().email(),
-  provider: z.string(),
-  active: z.boolean(),
-  locked: z.boolean(),
-  lastLoginAt: dateOrString.nullable(),
-  loginCount: z.number(),
-  role: z.string(),
-  roleId: z.string(),
-  type: z.string(),
-  onboarding: z.string().nullable(),
-  investorAccounts: z.array(z.lazy(() => IInvestorAccount)).optional(),
-  cart: z
-    .lazy(() => TradeZod)
-    .optional()
-    .nullable(),
-  investorOnboarding: z.nativeEnum(OnboardingType).optional().nullable(),
-  investorRegistrationFlow: z
-    .array(z.nativeEnum(OfferingType))
-    .optional()
-    .nullable(),
-  withPersonaThemeId: z.string().nullable().optional(),
-  paymentCustomerId: z.string().nullable().optional(),
-  userLoginId: z.string().nullable(),
-  userSettings: z
-    .object({
-      twoFactorMethod: z.nativeEnum(TwoFactorMethod).nullable(),
-      phoneData: PhoneNumberData.nullable(),
-      phoneVerified: z.boolean(),
-      emailVerified: z.boolean(),
-      twoFactorEnabled: z.boolean(),
-    })
-    .optional(),
-  managedBy: z.nativeEnum(ManagedByType).optional(),
-  userType: z.nativeEnum(UserType).optional(),
-  offeringSetup: z.boolean().optional(),
-  investorPortalSetup: z.boolean().optional(),
-  paymentMethodSetup: z.boolean().optional(),
-  accountContactsSetup: z.boolean().optional(),
-  accountSettings: z
-    .array(
-      z.object({
-        productPrimaries: z.boolean(),
-        productSecondaries: z.boolean(),
-        featureDisbursements: z.boolean(),
-      }),
-    )
-    .optional(),
-  account: z
-    .object({
-      id: accountIdSchema,
-      name: z.string().nullable(),
-      status: z.lazy(() => z.nativeEnum(AccountStatus)),
-      managedBy: z.nativeEnum(ManagedByType).optional(),
-      offeringSetup: z.boolean().optional(),
-      investorPortalSetup: z.boolean().optional(),
-      paymentMethodSetup: z.boolean().optional(),
-      accountContactsSetup: z.boolean().optional(),
-      accountSettings: z
-        .array(
-          z.object({
-            productPrimaries: z.boolean(),
-            productSecondaries: z.boolean(),
-            featureDisbursements: z.boolean(),
-          }),
-        )
-        .optional(),
-      accountManager: z
-        .lazy(() => IAccountManagerZod)
-        .nullable()
-        .optional(),
-      accountContacts: z.array(z.lazy(() => IAccountContact)).optional(),
-    })
-    .optional(),
-});
-
-export type GetMeResponse = z.infer<typeof GetMeResponse>;
-
-export const UserUpdateZod = z.object({
-  firstName: z.string().optional(),
-  lastName: z.string().optional(),
-});
-
-export const UserMeUpdateZod = z.object({
-  firstName: z.string().optional(),
-  lastName: z.string().optional(),
-  password: z.string().min(6).optional(),
-  email: EmailSchema.optional(),
-});
-
-export const UserZod = IBaseEntity.extend({
-  userLoginId: z.string().nullable(),
-  roleId: z.string().nullable(),
-  inviteId: z.string().nullable(),
-  accountId: z.string().nullable(),
-  onboarding: z.string().nullable(),
-  account: AccountWithoutUsersZod.optional(),
-  active: z.boolean(),
-  locked: z.boolean(),
-  userLogin: IBaseEntity.extend({
-    firstName: z.string(),
-    lastName: z.string(),
-    email: z.string().email(),
-    provider: z.string(),
-    lastLoginAt: dateOrString.nullable(),
-    loginCount: z.number(),
-  }),
-});
-export type UserZod = z.infer<typeof UserZod>;
-
-export const IPaginatedUser = z.object({
-  items: z.array(UserZod),
-  meta: IPaginationMeta,
-});
-
-export const UserFiltersZod = z.object({
-  accountId: accountIdSchema.optional(),
-  search: z.string().max(50).optional(),
-  role: z.nativeEnum(UserRole).optional(),
-  portal: z.string().optional(),
-  locked: StringToBooleanSchema.optional(),
-  active: StringToBooleanSchema.optional(),
-  twoFactorEnabled: StringToBooleanSchema.optional(),
-});
-
-const usersInclude = z.enum(['account', 'role']);
-
-/**
- * @description Query parameters for including related entities
- * @xample in contract us as -> query: z.object({}).merge(UsersIncludeQuery),
- */
-export const UsersIncludeQuery = z.object({
-  include: z
-    .string()
-    .optional()
-    .transform((str) => (str ? str.split(',') : []))
-    .refine(
-      (includes) =>
-        includes.every((include) =>
-          usersInclude.options.includes(include as any),
-        ),
-      {
-        message: `Invalid include option provided. Valid options are: ${usersInclude.options.join(',')}`,
-      },
-    )
-    .openapi({
-      example: `${usersInclude.options.join(',')}`,
-    }),
-});
-export interface UsersIncludeQuery extends z.infer<typeof UsersIncludeQuery> {}
-
-export const InvestorsUserMeUpdateZod = z.object({
-  firstName: z
-    .string()
-    .min(2, 'firstName is less than 2 characters')
-    .max(20, 'firstName is more than 2 characters')
-    .openapi({
-      example: 'Neil',
-    })
-    .optional(),
-  lastName: z
-    .string()
-    .min(2, 'lastName is less than 2 characters')
-    .max(20, 'lastName is more than 2 characters')
-    .openapi({
-      example: 'Armstrong',
-    })
-    .optional(),
-  password: PasswordSchema.optional(),
-  phone: PhoneZodSchema.optional(),
-});
-
-export const IssuersUsersFiltersZod = UserFiltersZod.omit({
-  portal: true,
-  accountId: true,
-}).extend({
-  role: z.nativeEnum(IssuerRole).optional(),
-});
-export type IssuersUsersFilters = z.infer<typeof IssuersUsersFiltersZod>;
-
-export const IssuersActiveStatusUpdateZod = z.object({
-  active: z.boolean(),
-});
-
-export type IssuersActiveStatusUpdateZod = z.infer<
-  typeof IssuersActiveStatusUpdateZod
->;
-
-export const IssuerUsersStatusUpdateResponse = z.object({
-  message: z.string(),
-});
-
-export type IssuerUsersStatusUpdateResponse = z.infer<
-  typeof IssuerUsersStatusUpdateResponse
->;
-
-export const UpdateLockedStatus = z.object({
-  locked: z.boolean(),
-});
-
-export type UpdateLockedStatus = z.infer<typeof UpdateLockedStatus>;
-
-export const UsersSummaryFilterZod = z.object({
-  accountId: accountIdSchema.optional(),
-  issuerId: z.lazy(() => issuerIdSchema).optional(),
-  portalType: z.nativeEnum(PortalType).optional(),
-  search: z.string().trim().max(50).optional(),
-  selectRole: z.nativeEnum(UserRole).optional(),
-  locked: StringToBooleanSchema.optional(),
-});
-export type UsersSummaryFilterZod = z.infer<typeof UsersSummaryFilterZod>;
-
-export const UsersSummaryZod = z.object({
-  accountId: accountIdSchema,
-  issuerId: z.lazy(() => issuerIdSchema),
-  issuer: z.string(),
-  name: z.string(),
-  email: z.string(),
-  role: z.nativeEnum(UserRole),
-  portalType: z.string(),
-  loginCount: z.number().int(),
-  lastLogin: z.date(),
-  locked: z.boolean(),
-});
-export type UsersSummaryZod = z.infer<typeof UsersSummaryZod>;
-
-export const IPaginatedUsersSummaryResponse = z.object({
-  items: z.array(UsersSummaryZod),
-  meta: IPaginationMeta,
-});
-export type IPaginatedUsersSummaryResponse = z.infer<
-  typeof IPaginatedUsersSummaryResponse
->;
-
-export const UpdateUserRoleZod = z.object({
-  role: z.nativeEnum(UserRole).openapi({ example: UserRole.VIEWER }),
-  userId: userIdSchema
-    .optional()
-    .openapi({ example: 'user_01jjsdrx1seqfse7z4z47sgdp5' }),
-});
-export type UpdateUserRoleZod = z.infer<typeof UpdateUserRoleZod>;