@dalmore/api-contracts 0.0.0-dev.d070175 → 0.0.0-dev.d10f798

package/common/types/auth.types.js

@@ -0,0 +1,279 @@
+import { z } from 'zod';
+import { extendZodWithOpenApi } from '@anatine/zod-openapi';
+import { accountIdSchema } from './account.types.js';
+import { PasswordSchema } from './password.type.js';
+import { inviteIdSchema } from './invite.types.js';
+import { PortalType, ManagedByType, UserRole, createUrlSchema, EmailSchema, } from './common.types.js';
+import { TypeID } from 'typeid-js';
+import { TwoFactorMethod } from './sms.types.js';
+import { PhoneZodSchema } from './phone.type.js';
+extendZodWithOpenApi(z);
+export const userLoginIdSchema = z.string().refine((value) => {
+    try {
+        const tid = TypeID.fromString(value);
+        return tid.getType() === 'user_login';
+    }
+    catch {
+        return false;
+    }
+}, {
+    message: 'Invalid user ID format. Must be a valid TypeID with "user_login" prefix.',
+});
+export var AuthProvider;
+(function (AuthProvider) {
+    AuthProvider["EMAIL"] = "email";
+})(AuthProvider || (AuthProvider = {}));
+const isBase64 = (v) => {
+    if (v.length % 4 !== 0) {
+        return false;
+    }
+    try {
+        return btoa(atob(v)) === v;
+    }
+    catch (err) {
+        return false;
+    }
+};
+const BaseAuthBody = z.object({
+    firstName: z
+        .string()
+        .min(2, 'firstName is less than 2 characters')
+        .max(20, 'firstName is more than 20 characters')
+        .openapi({
+        example: 'Neil',
+    }),
+    lastName: z
+        .string()
+        .min(2, 'lastName is less than 2 characters')
+        .max(20, 'lastName is more than 20 characters')
+        .openapi({
+        example: 'Armstrong',
+    }),
+    email: EmailSchema,
+    password: PasswordSchema,
+});
+export const IRegisterBodyZod = BaseAuthBody.extend({
+    code: z
+        .string()
+        .refine(isBase64, {
+        message: 'Must be a valid base64 encoded string',
+    })
+        .openapi({
+        example: 'eyJpdiI6InhhTFIyVG9ETnhnUzQ1QzUyNzRJenc9PSIsI',
+    }),
+});
+export const IChangePasswordBodyZod = z
+    .object({
+    currentPassword: z.string().min(6).openapi({
+        example: 'Secretpassword6#',
+    }),
+    newPassword: PasswordSchema,
+    newPasswordConfirm: PasswordSchema,
+})
+    .refine((data) => data.currentPassword !== data.newPassword, {
+    message: 'New password must be different from current password',
+    path: ['newPassword'],
+})
+    .refine((data) => data.newPassword === data.newPasswordConfirm, {
+    message: 'Password confirmation does not match new password',
+    path: ['newPasswordConfirm'],
+});
+export const LoginBody = z.object({
+    email: EmailSchema,
+    password: z.string().openapi({
+        example: 'Secretpassword6#',
+    }),
+    rememberMe: z.boolean().optional().default(false).openapi({
+        example: true,
+    }),
+    twoFactorMethod: z.nativeEnum(TwoFactorMethod).optional().openapi({
+        example: 'SMS',
+    }),
+});
+export const LoginBody2FA = z.object({
+    token: z.string().min(6).max(14).openapi({
+        example: 'neil@dalmoregroup.com',
+    }),
+    temporaryToken: z.string().min(1).openapi({
+        example: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9',
+    }),
+    rememberMe: z.boolean().optional().default(false).openapi({
+        example: true,
+    }),
+});
+export const LoginBodyInvestors = LoginBody.extend({
+    site: z.string().openapi({ site: 'example.com' }),
+});
+export const LoginBodyIssuers = LoginBody.extend({
+    accountId: accountIdSchema.openapi({
+        accountId: 'account_00041061050r3gg28a1c60t3gf',
+    }),
+});
+export const SelectAccountIssuers = LoginBody;
+export const SelectAccountIssuersResponse = z.object({
+    invites: z.array(z.object({
+        id: inviteIdSchema.openapi({
+            example: 'invite_00041061050r3gg28a1c60t3gf',
+        }),
+        name: z.string().openapi({ example: 'Example Account' }),
+        accountId: accountIdSchema.nullable().openapi({
+            example: 'account_00041061050r3gg28a1c60t3gf',
+        }),
+        role: z
+            .nativeEnum(UserRole)
+            .nullable()
+            .openapi({ example: UserRole.MARKETER }),
+    })),
+    accounts: z.array(z.object({
+        id: accountIdSchema.openapi({
+            example: 'account_00041061050r3gg28a1c60t3gf',
+        }),
+        name: z.string().openapi({ example: 'Example Account' }),
+        firstName: z.string().openapi({ example: 'John' }),
+        lastName: z.string().openapi({ example: 'Doe' }),
+    })),
+});
+export const SwitchAccountIssuersBody = z.object({
+    accountId: z.lazy(() => accountIdSchema),
+});
+export const AccessTokenResponse = z.object({
+    accessToken: z.string().optional().openapi({
+        example: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9',
+    }),
+    requiresTwoFactor: z.boolean().optional().openapi({
+        example: true,
+    }),
+    temporaryToken: z.string().optional().openapi({
+        example: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9',
+    }),
+    requiresTwoFactorSetup: z.boolean().optional().openapi({
+        example: true,
+    }),
+    twoFactorMethod: z.nativeEnum(TwoFactorMethod).optional().openapi({
+        example: 'SMS',
+    }),
+});
+// Base schema for issuer registration (shared fields without refinements)
+const BaseRegisterIssuerFields = BaseAuthBody.extend({
+    confirmPassword: PasswordSchema,
+    accountName: z
+        .string()
+        .min(1)
+        .max(150)
+        .openapi({
+        example: 'Example Account',
+    })
+        .nullable()
+        .optional(),
+    accountType: z
+        .nativeEnum(ManagedByType)
+        .optional()
+        .default(ManagedByType.DALMORE)
+        .openapi({
+        example: ManagedByType.DALMORE,
+    }),
+});
+// Full issuer registration schema with code (for invite-based registration)
+export const IRegisterIssuerBodyZod = BaseRegisterIssuerFields.extend({
+    code: z
+        .string()
+        .refine(isBase64, {
+        message: 'Must be a valid base64 encoded string',
+    })
+        .optional()
+        .openapi({
+        example: 'eyJpdiI6InhhTFIyVG9ETnhnUzQ1QzUyNzRJenc9PSIsI',
+    }),
+})
+    .refine((data) => data.password === data.confirmPassword, {
+    message: 'Passwords do not match',
+    path: ['confirmPassword'],
+})
+    .refine((data) => {
+    // If code is not provided, accountName must be present and not empty/null
+    if (!data.code || data.code.length === 0) {
+        return (data.accountName !== null &&
+            data.accountName !== undefined &&
+            data.accountName !== '');
+    }
+    // If code is provided, accountName is not required
+    return true;
+}, {
+    message: 'Account name is required if code is not provided',
+    path: ['accountName'],
+});
+// Client issuer registration schema without code (for API key registration)
+export const IRegisterClientIssuerBodyZod = BaseRegisterIssuerFields.refine((data) => data.password === data.confirmPassword, {
+    message: 'Passwords do not match',
+    path: ['confirmPassword'],
+}).refine((data) => {
+    // For client registration, accountName is always required
+    return (data.accountName !== null &&
+        data.accountName !== undefined &&
+        data.accountName !== '');
+}, {
+    message: 'Account name is required',
+    path: ['accountName'],
+});
+// Investors are a special case in which they require phone number at the time of registration
+// The phone number provided here is NOT validated and will still need to go thru the regular 2FA setup process
+export const RegisterBodyInvestors = BaseAuthBody.extend({
+    confirmPassword: PasswordSchema,
+    phoneNumber: PhoneZodSchema.openapi({ example: '+12124567890' }).optional(),
+    site: z
+        .string()
+        .min(2, 'site is less than 2 characters')
+        .max(253, 'site is more than 253 characters')
+        .openapi({
+        example: 'func.co',
+    }),
+}).refine((data) => data.password === data.confirmPassword, {
+    message: 'Passwords do not match',
+    path: ['confirmPassword'],
+});
+export const ResetPasswordVerifyBody = z.object({
+    email: EmailSchema,
+    code: z.string().length(6, 'code is not 6 characters').openapi({
+        example: '123456',
+    }),
+});
+export const ResetPasswordVerifyResponse = z.object({
+    valid: z.boolean(),
+});
+export const ResetPasswordBody = z.object({
+    email: EmailSchema,
+    code: z.string().length(6, 'code is not 6 characters').openapi({
+        example: '123456',
+    }),
+    password: PasswordSchema,
+});
+export const AuthSuccessResponse = z.object({
+    success: z.boolean(),
+});
+export const ClientAuthSuccessResponse = z.object({
+    userId: z.string().openapi({ example: 'user_01je6ht4b8fbmttkzh2hs82xqp' }),
+});
+export const AdminForgotPasswordRequestZod = z.object({
+    email: EmailSchema,
+    portal: z.nativeEnum(PortalType),
+});
+export const InvestorForgotPasswordRequestZod = z.object({
+    email: EmailSchema,
+    url: createUrlSchema({ strict: true }),
+});
+// Define paths that should be accessible EVEN with twoFactorPending
+export const twoFactorPendingAllowedPaths = [
+    '/auth/login',
+    '/auth/register',
+    '/user-settings/valid-phone-number',
+    '/user-settings/setup-phone-number',
+    '/user-settings/verify-phone-number',
+    '/user-settings/send-verification-code',
+    '/user-settings/setup-authenticator',
+    '/user-settings/verify-authenticator',
+];
+export const restrictedUserAllowedPathsAndMethods = [
+    { path: '/users/me', method: 'GET' },
+    { path: '/auth/login', method: 'POST' },
+];
+//# sourceMappingURL=auth.types.js.map

package/common/types/auth.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.types.js","sourceRoot":"","sources":["auth.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EACL,UAAU,EACV,aAAa,EACb,QAAQ,EACR,eAAe,EACf,WAAW,GACZ,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,oBAAoB,CAAC,CAAC,CAAC,CAAC;AAExB,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,MAAM,CAChD,CAAC,KAAK,EAAE,EAAE;IACR,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QACrC,OAAO,GAAG,CAAC,OAAO,EAAE,KAAK,YAAY,CAAC;IACxC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC,EACD;IACE,OAAO,EACL,0EAA0E;CAC7E,CACF,CAAC;AAEF,MAAM,CAAN,IAAY,YAEX;AAFD,WAAY,YAAY;IACtB,+BAAe,CAAA;AACjB,CAAC,EAFW,YAAY,KAAZ,YAAY,QAEvB;AAED,MAAM,QAAQ,GAAG,CAAC,CAAS,EAAE,EAAE;IAC7B,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IAC7B,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5B,SAAS,EAAE,CAAC;SACT,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,EAAE,qCAAqC,CAAC;SAC7C,GAAG,CAAC,EAAE,EAAE,sCAAsC,CAAC;SAC/C,OAAO,CAAC;QACP,OAAO,EAAE,MAAM;KAChB,CAAC;IACJ,QAAQ,EAAE,CAAC;SACR,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,EAAE,oCAAoC,CAAC;SAC5C,GAAG,CAAC,EAAE,EAAE,qCAAqC,CAAC;SAC9C,OAAO,CAAC;QACP,OAAO,EAAE,WAAW;KACrB,CAAC;IACJ,KAAK,EAAE,WAAW;IAClB,QAAQ,EAAE,cAAc;CACzB,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,gBAAgB,GAAG,YAAY,CAAC,MAAM,CAAC;IAClD,IAAI,EAAE,CAAC;SACJ,MAAM,EAAE;SACR,MAAM,CAAC,QAAQ,EAAE;QAChB,OAAO,EAAE,uCAAuC;KACjD,CAAC;SACD,OAAO,CAAC;QACP,OAAO,EAAE,+CAA+C;KACzD,CAAC;CACL,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC;KACpC,MAAM,CAAC;IACN,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;QACzC,OAAO,EAAE,kBAAkB;KAC5B,CAAC;IACF,WAAW,EAAE,cAAc;IAC3B,kBAAkB,EAAE,cAAc;CACnC,CAAC;KACD,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,eAAe,KAAK,IAAI,CAAC,WAAW,EAAE;IAC3D,OAAO,EAAE,sDAAsD;IAC/D,IAAI,EAAE,CAAC,aAAa,CAAC;CACtB,CAAC;KACD,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,KAAK,IAAI,CAAC,kBAAkB,EAAE;IAC9D,OAAO,EAAE,mDAAmD;IAC5D,IAAI,EAAE,CAAC,oBAAoB,CAAC;CAC7B,CAAC,CAAC;AAEL,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC;IAChC,KAAK,EAAE,WAAW;IAClB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC;QAC3B,OAAO,EAAE,kBAAkB;KAC5B,CAAC;IACF,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;QACxD,OAAO,EAAE,IAAI;KACd,CAAC;IACF,eAAe,EAAE,CAAC,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC;QAChE,OAAO,EAAE,KAAK;KACf,CAAC;CACH,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;IACnC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC;QACvC,OAAO,EAAE,uBAAuB;KACjC,CAAC;IACF,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;QACxC,OAAO,EAAE,sCAAsC;KAChD,CAAC;IACF,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;QACxD,OAAO,EAAE,IAAI;KACd,CAAC;CACH,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,kBAAkB,GAAG,SAAS,CAAC,MAAM,CAAC;IACjD,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC;CAClD,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,gBAAgB,GAAG,SAAS,CAAC,MAAM,CAAC;IAC/C,SAAS,EAAE,eAAe,CAAC,OAAO,CAAC;QACjC,SAAS,EAAE,oCAAoC;KAChD,CAAC;CACH,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,oBAAoB,GAAG,SAAS,CAAC;AAG9C,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAAC;IACnD,OAAO,EAAE,CAAC,CAAC,KAAK,CACd,CAAC,CAAC,MAAM,CAAC;QACP,EAAE,EAAE,cAAc,CAAC,OAAO,CAAC;YACzB,OAAO,EAAE,mCAAmC;SAC7C,CAAC;QACF,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC;QACxD,SAAS,EAAE,eAAe,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC;YAC5C,OAAO,EAAE,oCAAoC;SAC9C,CAAC;QACF,IAAI,EAAE,CAAC;aACJ,UAAU,CAAC,QAAQ,CAAC;aACpB,QAAQ,EAAE;aACV,OAAO,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,QAAQ,EAAE,CAAC;KAC3C,CAAC,CACH;IACD,QAAQ,EAAE,CAAC,CAAC,KAAK,CACf,CAAC,CAAC,MAAM,CAAC;QACP,EAAE,EAAE,eAAe,CAAC,OAAO,CAAC;YAC1B,OAAO,EAAE,oCAAoC;SAC9C,CAAC;QACF,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC;QACxD,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;QAClD,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;KACjD,CAAC,CACH;CACF,CAAC,CAAC;AAKH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/C,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,eAAe,CAAC;CACzC,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC;QACzC,OAAO,EAAE,sCAAsC;KAChD,CAAC;IACF,iBAAiB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC;QAChD,OAAO,EAAE,IAAI;KACd,CAAC;IACF,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC;QAC5C,OAAO,EAAE,sCAAsC;KAChD,CAAC;IACF,sBAAsB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC;QACrD,OAAO,EAAE,IAAI;KACd,CAAC;IACF,eAAe,EAAE,CAAC,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC;QAChE,OAAO,EAAE,KAAK;KACf,CAAC;CACH,CAAC,CAAC;AAGH,0EAA0E;AAC1E,MAAM,wBAAwB,GAAG,YAAY,CAAC,MAAM,CAAC;IACnD,eAAe,EAAE,cAAc;IAC/B,WAAW,EAAE,CAAC;SACX,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,CAAC;SACN,GAAG,CAAC,GAAG,CAAC;SACR,OAAO,CAAC;QACP,OAAO,EAAE,iBAAiB;KAC3B,CAAC;SACD,QAAQ,EAAE;SACV,QAAQ,EAAE;IACb,WAAW,EAAE,CAAC;SACX,UAAU,CAAC,aAAa,CAAC;SACzB,QAAQ,EAAE;SACV,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC;SAC9B,OAAO,CAAC;QACP,OAAO,EAAE,aAAa,CAAC,OAAO;KAC/B,CAAC;CACL,CAAC,CAAC;AAEH,4EAA4E;AAC5E,MAAM,CAAC,MAAM,sBAAsB,GAAG,wBAAwB,CAAC,MAAM,CAAC;IACpE,IAAI,EAAE,CAAC;SACJ,MAAM,EAAE;SACR,MAAM,CAAC,QAAQ,EAAE;QAChB,OAAO,EAAE,uCAAuC;KACjD,CAAC;SACD,QAAQ,EAAE;SACV,OAAO,CAAC;QACP,OAAO,EAAE,+CAA+C;KACzD,CAAC;CACL,CAAC;KACC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,eAAe,EAAE;IACxD,OAAO,EAAE,wBAAwB;IACjC,IAAI,EAAE,CAAC,iBAAiB,CAAC;CAC1B,CAAC;KACD,MAAM,CACL,CAAC,IAAI,EAAE,EAAE;IACP,0EAA0E;IAC1E,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzC,OAAO,CACL,IAAI,CAAC,WAAW,KAAK,IAAI;YACzB,IAAI,CAAC,WAAW,KAAK,SAAS;YAC9B,IAAI,CAAC,WAAW,KAAK,EAAE,CACxB,CAAC;IACJ,CAAC;IACD,mDAAmD;IACnD,OAAO,IAAI,CAAC;AACd,CAAC,EACD;IACE,OAAO,EAAE,kDAAkD;IAC3D,IAAI,EAAE,CAAC,aAAa,CAAC;CACtB,CACF,CAAC;AAEJ,4EAA4E;AAC5E,MAAM,CAAC,MAAM,4BAA4B,GAAG,wBAAwB,CAAC,MAAM,CACzE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,eAAe,EAChD;IACE,OAAO,EAAE,wBAAwB;IACjC,IAAI,EAAE,CAAC,iBAAiB,CAAC;CAC1B,CACF,CAAC,MAAM,CACN,CAAC,IAAI,EAAE,EAAE;IACP,0DAA0D;IAC1D,OAAO,CACL,IAAI,CAAC,WAAW,KAAK,IAAI;QACzB,IAAI,CAAC,WAAW,KAAK,SAAS;QAC9B,IAAI,CAAC,WAAW,KAAK,EAAE,CACxB,CAAC;AACJ,CAAC,EACD;IACE,OAAO,EAAE,0BAA0B;IACnC,IAAI,EAAE,CAAC,aAAa,CAAC;CACtB,CACF,CAAC;AAEF,8FAA8F;AAC9F,+GAA+G;AAC/G,MAAM,CAAC,MAAM,qBAAqB,GAAG,YAAY,CAAC,MAAM,CAAC;IACvD,eAAe,EAAE,cAAc;IAC/B,WAAW,EAAE,cAAc,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC3E,IAAI,EAAE,CAAC;SACJ,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,EAAE,gCAAgC,CAAC;SACxC,GAAG,CAAC,GAAG,EAAE,kCAAkC,CAAC;SAC5C,OAAO,CAAC;QACP,OAAO,EAAE,SAAS;KACnB,CAAC;CACL,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,eAAe,EAAE;IAC1D,OAAO,EAAE,wBAAwB;IACjC,IAAI,EAAE,CAAC,iBAAiB,CAAC;CAC1B,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,KAAK,EAAE,WAAW;IAClB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,0BAA0B,CAAC,CAAC,OAAO,CAAC;QAC7D,OAAO,EAAE,QAAQ;KAClB,CAAC;CACH,CAAC,CAAC;AAKH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE;CACnB,CAAC,CAAC;AAMH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,KAAK,EAAE,WAAW;IAClB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,0BAA0B,CAAC,CAAC,OAAO,CAAC;QAC7D,OAAO,EAAE,QAAQ;KAClB,CAAC;IACF,QAAQ,EAAE,cAAc;CACzB,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;CACrB,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,iCAAiC,EAAE,CAAC;CAC3E,CAAC,CAAC;AAMH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAC,MAAM,CAAC;IACpD,KAAK,EAAE,WAAW;IAClB,MAAM,EAAE,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC;CACjC,CAAC,CAAC;AAKH,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAAC,CAAC,MAAM,CAAC;IACvD,KAAK,EAAE,WAAW;IAClB,GAAG,EAAE,eAAe,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;CACvC,CAAC,CAAC;AAKH,oEAAoE;AACpE,MAAM,CAAC,MAAM,4BAA4B,GAAG;IAC1C,aAAa;IACb,gBAAgB;IAChB,mCAAmC;IACnC,mCAAmC;IACnC,oCAAoC;IACpC,uCAAuC;IACvC,oCAAoC;IACpC,qCAAqC;CACtC,CAAC;AAEF,MAAM,CAAC,MAAM,oCAAoC,GAAG;IAClD,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE;IACpC,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE;CACxC,CAAC"}

package/common/types/batch-jobs.types.d.ts

@@ -0,0 +1,321 @@
+import { z } from 'zod';
+import { UserRole } from './common.types';
+import { JobsOptions } from 'bullmq';
+export declare enum JobTaskType {
+    BULK_TRADE_APPROVAL = "BULK_TRADE_APPROVAL",
+    SINGLE_TRADE_APPROVAL = "SINGLE_TRADE_APPROVAL",
+    BULK_TRADE_REJECTION = "BULK_TRADE_REJECTION",
+    SINGLE_TRADE_REJECTION = "SINGLE_TRADE_REJECTION",
+    BULK_COMPLIANCE_REVIEW = "BULK_COMPLIANCE_REVIEW",
+    BULK_EXCHANGE_IMPORT = "BULK_EXCHANGE_IMPORT",
+    VALIDATE_PLACED_TRADES = "VALIDATE_PLACED_TRADES",
+    IMPORT_FUNDING_CHECK = "IMPORT_FUNDING_CHECK",
+    REG_D_TRADE_PROCESSING = "REG_D_TRADE_PROCESSING",
+    BULK_FILE_REPROCESSING = "BULK_FILE_REPROCESSING"
+}
+export declare enum BatchJobStatus {
+    PENDING = "PENDING",
+    IN_PROGRESS = "IN_PROGRESS",
+    COMPLETED = "COMPLETED",
+    FAILED = "FAILED",
+    CANCELLED = "CANCELLED",
+    KILLED = "KILLED"
+}
+export declare const batchJobIdSchema: z.ZodEffects<z.ZodString, string, string>;
+export declare const CreateBatchJobZod: z.ZodObject<{
+    jobTaskType: z.ZodNativeEnum<typeof JobTaskType>;
+    totalTasks: z.ZodNumber;
+    bullFlowId: z.ZodString;
+    userId: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
+    accountId: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
+}, "strip", z.ZodTypeAny, {
+    accountId: string;
+    userId: string;
+    jobTaskType: JobTaskType;
+    totalTasks: number;
+    bullFlowId: string;
+}, {
+    accountId: string;
+    userId: string;
+    jobTaskType: JobTaskType;
+    totalTasks: number;
+    bullFlowId: string;
+}>;
+export type CreateBatchJobZod = z.infer<typeof CreateBatchJobZod>;
+export declare const BatchJobZod: z.ZodObject<{
+    __entity: z.ZodOptional<z.ZodString>;
+    createdAt: z.ZodUnion<[z.ZodString, z.ZodDate]>;
+    updatedAt: z.ZodUnion<[z.ZodString, z.ZodDate]>;
+    deletedAt: z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodDate]>>;
+} & {
+    id: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
+    jobTaskType: z.ZodNativeEnum<typeof JobTaskType>;
+    totalTasks: z.ZodNumber;
+    bullFlowId: z.ZodString;
+    userId: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
+    accountId: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
+    status: z.ZodNativeEnum<typeof BatchJobStatus>;
+    tasksPending: z.ZodNumber;
+    tasksProcessing: z.ZodNumber;
+    tasksCompleted: z.ZodNumber;
+    tasksFailed: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    status: BatchJobStatus;
+    id: string;
+    createdAt: string | Date;
+    updatedAt: string | Date;
+    deletedAt: string | Date | null;
+    accountId: string;
+    userId: string;
+    jobTaskType: JobTaskType;
+    totalTasks: number;
+    bullFlowId: string;
+    tasksPending: number;
+    tasksProcessing: number;
+    tasksCompleted: number;
+    tasksFailed: number;
+    __entity?: string | undefined;
+}, {
+    status: BatchJobStatus;
+    id: string;
+    createdAt: string | Date;
+    updatedAt: string | Date;
+    deletedAt: string | Date | null;
+    accountId: string;
+    userId: string;
+    jobTaskType: JobTaskType;
+    totalTasks: number;
+    bullFlowId: string;
+    tasksPending: number;
+    tasksProcessing: number;
+    tasksCompleted: number;
+    tasksFailed: number;
+    __entity?: string | undefined;
+}>;
+export type BatchJobZod = z.infer<typeof BatchJobZod>;
+export declare const IPaginatedBatchJob: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        __entity: z.ZodOptional<z.ZodString>;
+        createdAt: z.ZodUnion<[z.ZodString, z.ZodDate]>;
+        updatedAt: z.ZodUnion<[z.ZodString, z.ZodDate]>;
+        deletedAt: z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodDate]>>;
+    } & {
+        id: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
+        jobTaskType: z.ZodNativeEnum<typeof JobTaskType>;
+        totalTasks: z.ZodNumber;
+        bullFlowId: z.ZodString;
+        userId: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
+        accountId: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
+        status: z.ZodNativeEnum<typeof BatchJobStatus>;
+        tasksPending: z.ZodNumber;
+        tasksProcessing: z.ZodNumber;
+        tasksCompleted: z.ZodNumber;
+        tasksFailed: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        status: BatchJobStatus;
+        id: string;
+        createdAt: string | Date;
+        updatedAt: string | Date;
+        deletedAt: string | Date | null;
+        accountId: string;
+        userId: string;
+        jobTaskType: JobTaskType;
+        totalTasks: number;
+        bullFlowId: string;
+        tasksPending: number;
+        tasksProcessing: number;
+        tasksCompleted: number;
+        tasksFailed: number;
+        __entity?: string | undefined;
+    }, {
+        status: BatchJobStatus;
+        id: string;
+        createdAt: string | Date;
+        updatedAt: string | Date;
+        deletedAt: string | Date | null;
+        accountId: string;
+        userId: string;
+        jobTaskType: JobTaskType;
+        totalTasks: number;
+        bullFlowId: string;
+        tasksPending: number;
+        tasksProcessing: number;
+        tasksCompleted: number;
+        tasksFailed: number;
+        __entity?: string | undefined;
+    }>, "many">;
+    meta: z.ZodObject<{
+        itemCount: z.ZodNumber;
+        totalItems: z.ZodOptional<z.ZodNumber>;
+        itemsPerPage: z.ZodNumber;
+        totalPages: z.ZodOptional<z.ZodNumber>;
+        currentPage: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        itemCount: number;
+        itemsPerPage: number;
+        currentPage: number;
+        totalItems?: number | undefined;
+        totalPages?: number | undefined;
+    }, {
+        itemCount: number;
+        itemsPerPage: number;
+        currentPage: number;
+        totalItems?: number | undefined;
+        totalPages?: number | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    items: {
+        status: BatchJobStatus;
+        id: string;
+        createdAt: string | Date;
+        updatedAt: string | Date;
+        deletedAt: string | Date | null;
+        accountId: string;
+        userId: string;
+        jobTaskType: JobTaskType;
+        totalTasks: number;
+        bullFlowId: string;
+        tasksPending: number;
+        tasksProcessing: number;
+        tasksCompleted: number;
+        tasksFailed: number;
+        __entity?: string | undefined;
+    }[];
+    meta: {
+        itemCount: number;
+        itemsPerPage: number;
+        currentPage: number;
+        totalItems?: number | undefined;
+        totalPages?: number | undefined;
+    };
+}, {
+    items: {
+        status: BatchJobStatus;
+        id: string;
+        createdAt: string | Date;
+        updatedAt: string | Date;
+        deletedAt: string | Date | null;
+        accountId: string;
+        userId: string;
+        jobTaskType: JobTaskType;
+        totalTasks: number;
+        bullFlowId: string;
+        tasksPending: number;
+        tasksProcessing: number;
+        tasksCompleted: number;
+        tasksFailed: number;
+        __entity?: string | undefined;
+    }[];
+    meta: {
+        itemCount: number;
+        itemsPerPage: number;
+        currentPage: number;
+        totalItems?: number | undefined;
+        totalPages?: number | undefined;
+    };
+}>;
+export type IPaginatedBatchJob = z.infer<typeof IPaginatedBatchJob>;
+export declare const BatchJobFiltersZod: z.ZodObject<{
+    search: z.ZodOptional<z.ZodString>;
+    jobTaskType: z.ZodOptional<z.ZodNativeEnum<typeof JobTaskType>>;
+    status: z.ZodOptional<z.ZodNativeEnum<typeof BatchJobStatus>>;
+    accountId: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    userId: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    from: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodNullable<z.ZodString>, string | null, string | null>, Date | null, string | null>>;
+    to: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodNullable<z.ZodString>, string | null, string | null>, Date | null, string | null>>;
+}, "strip", z.ZodTypeAny, {
+    status?: BatchJobStatus | undefined;
+    accountId?: string | undefined;
+    from?: Date | null | undefined;
+    to?: Date | null | undefined;
+    search?: string | undefined;
+    userId?: string | undefined;
+    jobTaskType?: JobTaskType | undefined;
+}, {
+    status?: BatchJobStatus | undefined;
+    accountId?: string | undefined;
+    from?: string | null | undefined;
+    to?: string | null | undefined;
+    search?: string | undefined;
+    userId?: string | undefined;
+    jobTaskType?: JobTaskType | undefined;
+}>;
+export type BatchJobFiltersZod = z.infer<typeof BatchJobFiltersZod>;
+/**
+ * @description Query parameters for including related entities
+ * @xample in contract us as -> query: z.object({}).merge(AccountsIncludeQuery),
+ */
+export declare const BatchJobsIncludeQuery: z.ZodObject<{
+    include: z.ZodEffects<z.ZodEffects<z.ZodOptional<z.ZodString>, string[], string | undefined>, string[], string | undefined>;
+}, "strip", z.ZodTypeAny, {
+    include: string[];
+}, {
+    include?: string | undefined;
+}>;
+export interface BatchJobsIncludeQuery extends z.infer<typeof BatchJobsIncludeQuery> {
+}
+export interface ChildJobConfig {
+    name: string;
+    queueName: string;
+    data: ChildJobData;
+    opts: JobsOptions;
+}
+export declare const ChildJobData: z.ZodObject<{
+    batchJobId: z.ZodString;
+    targetId: z.ZodString;
+    userId: z.ZodString;
+    userAccountId: z.ZodString;
+    userFirstName: z.ZodOptional<z.ZodString>;
+    userLastName: z.ZodOptional<z.ZodString>;
+    userRoleId: z.ZodOptional<z.ZodString>;
+    userRole: z.ZodOptional<z.ZodNativeEnum<typeof UserRole>>;
+}, "strip", z.ZodTypeAny, {
+    userId: string;
+    targetId: string;
+    batchJobId: string;
+    userAccountId: string;
+    userFirstName?: string | undefined;
+    userLastName?: string | undefined;
+    userRoleId?: string | undefined;
+    userRole?: UserRole | undefined;
+}, {
+    userId: string;
+    targetId: string;
+    batchJobId: string;
+    userAccountId: string;
+    userFirstName?: string | undefined;
+    userLastName?: string | undefined;
+    userRoleId?: string | undefined;
+    userRole?: UserRole | undefined;
+}>;
+export type ChildJobData = z.infer<typeof ChildJobData>;
+export declare const BatchJobData: z.ZodObject<{
+    taskType: z.ZodNativeEnum<typeof JobTaskType>;
+    props: z.ZodRecord<z.ZodString, z.ZodAny>;
+}, "strip", z.ZodTypeAny, {
+    taskType: JobTaskType;
+    props: Record<string, any>;
+}, {
+    taskType: JobTaskType;
+    props: Record<string, any>;
+}>;
+export type BatchJobData = z.infer<typeof BatchJobData>;
+export declare const BatchJobResult: z.ZodObject<{
+    success: z.ZodBoolean;
+    message: z.ZodString;
+    jobId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    message: string;
+    success: boolean;
+    jobId?: string | null | undefined;
+}, {
+    message: string;
+    success: boolean;
+    jobId?: string | null | undefined;
+}>;
+export type BatchJobResult = z.infer<typeof BatchJobResult>;
+export interface BatchJobConfig {
+    data: BatchJobData;
+    childConfigs: (childData: ChildJobData) => ChildJobConfig[];
+    opts: JobsOptions;
+}