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

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

@@ -0,0 +1,273 @@
+import { z } from 'zod';
+import { TwoFactorMethod } from './sms.types';
+export declare const validPhoneNumberBody: z.ZodObject<{
+    countryCode: z.ZodString;
+    phoneNumber: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodNullable<z.ZodString>, {
+        isOk: () => boolean;
+        isErr: () => boolean;
+        value?: any;
+        error?: any;
+    } | import("neverthrow").Ok<null, never>, string | null>, {
+        isOk: () => boolean;
+        isErr: () => boolean;
+        value?: any;
+        error?: any;
+    } | import("neverthrow").Ok<null, never>, string | null>, any, string | null>;
+}, "strip", z.ZodTypeAny, {
+    countryCode: string;
+    phoneNumber?: any;
+}, {
+    phoneNumber: string | null;
+    countryCode: string;
+}>;
+export type validPhoneNumberBody = z.infer<typeof validPhoneNumberBody>;
+export declare const validPhoneNumberResponse: z.ZodObject<{
+    countryCallingCode: z.ZodString;
+    country: z.ZodString;
+    nationalNumber: z.ZodString;
+    number: z.ZodString;
+    formatNational: z.ZodString;
+    formatInternational: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    number: string;
+    countryCallingCode: string;
+    country: string;
+    nationalNumber: string;
+    formatNational: string;
+    formatInternational: string;
+}, {
+    number: string;
+    countryCallingCode: string;
+    country: string;
+    nationalNumber: string;
+    formatNational: string;
+    formatInternational: string;
+}>;
+export type validPhoneNumberResponse = z.infer<typeof validPhoneNumberResponse>;
+export declare const userSettingsZod: z.ZodObject<{
+    id: z.ZodString;
+    __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]>>;
+} & {
+    userLoginId: z.ZodString;
+    twoFactorMethod: z.ZodNativeEnum<typeof TwoFactorMethod>;
+    totpSecret: z.ZodNullable<z.ZodString>;
+    totpTemporarySecret: z.ZodNullable<z.ZodString>;
+    recoveryCodes: z.ZodNullable<z.ZodArray<z.ZodString, "many">>;
+    phoneData: z.ZodNullable<z.ZodObject<{
+        countryCallingCode: z.ZodString;
+        country: z.ZodString;
+        nationalNumber: z.ZodString;
+        number: z.ZodString;
+        formatNational: z.ZodString;
+        formatInternational: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        number: string;
+        countryCallingCode: string;
+        country: string;
+        nationalNumber: string;
+        formatNational: string;
+        formatInternational: string;
+    }, {
+        number: string;
+        countryCallingCode: string;
+        country: string;
+        nationalNumber: string;
+        formatNational: string;
+        formatInternational: string;
+    }>>;
+    phoneVerified: z.ZodBoolean;
+    smsVerificationCode: z.ZodNullable<z.ZodString>;
+    smsCodeExpiresAt: z.ZodNullable<z.ZodDate>;
+    emailVerified: z.ZodBoolean;
+    emailVerificationCode: z.ZodNullable<z.ZodString>;
+    emailCodeExpiresAt: z.ZodNullable<z.ZodDate>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    createdAt: string | Date;
+    updatedAt: string | Date;
+    deletedAt: string | Date | null;
+    userLoginId: string;
+    twoFactorMethod: TwoFactorMethod;
+    phoneData: {
+        number: string;
+        countryCallingCode: string;
+        country: string;
+        nationalNumber: string;
+        formatNational: string;
+        formatInternational: string;
+    } | null;
+    phoneVerified: boolean;
+    emailVerified: boolean;
+    totpSecret: string | null;
+    totpTemporarySecret: string | null;
+    recoveryCodes: string[] | null;
+    smsVerificationCode: string | null;
+    smsCodeExpiresAt: Date | null;
+    emailVerificationCode: string | null;
+    emailCodeExpiresAt: Date | null;
+    __entity?: string | undefined;
+}, {
+    id: string;
+    createdAt: string | Date;
+    updatedAt: string | Date;
+    deletedAt: string | Date | null;
+    userLoginId: string;
+    twoFactorMethod: TwoFactorMethod;
+    phoneData: {
+        number: string;
+        countryCallingCode: string;
+        country: string;
+        nationalNumber: string;
+        formatNational: string;
+        formatInternational: string;
+    } | null;
+    phoneVerified: boolean;
+    emailVerified: boolean;
+    totpSecret: string | null;
+    totpTemporarySecret: string | null;
+    recoveryCodes: string[] | null;
+    smsVerificationCode: string | null;
+    smsCodeExpiresAt: Date | null;
+    emailVerificationCode: string | null;
+    emailCodeExpiresAt: Date | null;
+    __entity?: string | undefined;
+}>;
+export type userSettingsZod = z.infer<typeof userSettingsZod>;
+export declare const setupPhoneNumberBody: z.ZodObject<{
+    countryCode: z.ZodString;
+    phoneNumber: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodNullable<z.ZodString>, {
+        isOk: () => boolean;
+        isErr: () => boolean;
+        value?: any;
+        error?: any;
+    } | import("neverthrow").Ok<null, never>, string | null>, {
+        isOk: () => boolean;
+        isErr: () => boolean;
+        value?: any;
+        error?: any;
+    } | import("neverthrow").Ok<null, never>, string | null>, any, string | null>;
+}, "strip", z.ZodTypeAny, {
+    countryCode: string;
+    phoneNumber?: any;
+}, {
+    phoneNumber: string | null;
+    countryCode: string;
+}>;
+export type setupPhoneNumberBody = z.infer<typeof setupPhoneNumberBody>;
+export declare const setupPhoneNumberResponse: z.ZodObject<{
+    success: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    success: boolean;
+}, {
+    success: boolean;
+}>;
+export type setupPhoneNumberResponse = z.infer<typeof setupPhoneNumberResponse>;
+export declare const verifyPhoneNumberBody: z.ZodObject<{
+    code: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    code: string;
+}, {
+    code: string;
+}>;
+export type verifyPhoneNumberBody = z.infer<typeof verifyPhoneNumberBody>;
+export declare const verifyPhoneNumberResponse: z.ZodObject<{
+    success: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    success: boolean;
+}, {
+    success: boolean;
+}>;
+export type verifyPhoneNumberResponse = z.infer<typeof verifyPhoneNumberResponse>;
+export declare const sendVerificationCodeBody: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+export type sendVerificationCodeBody = z.infer<typeof sendVerificationCodeBody>;
+export declare const sendVerificationCodeResponse: z.ZodObject<{
+    success: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    success: boolean;
+}, {
+    success: boolean;
+}>;
+export type sendVerificationCodeResponse = z.infer<typeof sendVerificationCodeResponse>;
+export declare const disableTwoFactorBody: z.ZodObject<{
+    userLoginId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    userLoginId: string;
+}, {
+    userLoginId: string;
+}>;
+export type disableTwoFactorBody = z.infer<typeof disableTwoFactorBody>;
+export declare const disableTwoFactorResponse: z.ZodObject<{
+    success: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    success: boolean;
+}, {
+    success: boolean;
+}>;
+export type disableTwoFactorResponse = z.infer<typeof disableTwoFactorResponse>;
+export declare const setupTwoFactorResponse: z.ZodObject<{
+    secret: z.ZodString;
+    qrCodeUrl: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    secret: string;
+    qrCodeUrl?: string | undefined;
+}, {
+    secret: string;
+    qrCodeUrl?: string | undefined;
+}>;
+export type setupTwoFactorResponse = z.infer<typeof setupTwoFactorResponse>;
+export declare const verifyTwoFactorBody: z.ZodObject<{
+    token: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    token: string;
+}, {
+    token: string;
+}>;
+export type verifyTwoFactorBody = z.infer<typeof verifyTwoFactorBody>;
+export declare const verifyTwoFactorResponse: z.ZodObject<{
+    recoveryCodes: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    recoveryCodes: string[];
+}, {
+    recoveryCodes: string[];
+}>;
+export type verifyTwoFactorResponse = z.infer<typeof verifyTwoFactorResponse>;
+export declare const changeTwoFactorMethodBody: z.ZodObject<{
+    twoFactorMethod: z.ZodNativeEnum<typeof TwoFactorMethod>;
+}, "strip", z.ZodTypeAny, {
+    twoFactorMethod: TwoFactorMethod;
+}, {
+    twoFactorMethod: TwoFactorMethod;
+}>;
+export type changeTwoFactorMethodBody = z.infer<typeof changeTwoFactorMethodBody>;
+export declare const sendEmailVerificationBody: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+export type sendEmailVerificationBody = z.infer<typeof sendEmailVerificationBody>;
+export declare const sendEmailVerificationResponse: z.ZodObject<{
+    success: z.ZodBoolean;
+    expiresAt: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    success: boolean;
+    expiresAt: string;
+}, {
+    success: boolean;
+    expiresAt: string;
+}>;
+export type sendEmailVerificationResponse = z.infer<typeof sendEmailVerificationResponse>;
+export declare const verifyEmailBody: z.ZodObject<{
+    code: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    code: string;
+}, {
+    code: string;
+}>;
+export type verifyEmailBody = z.infer<typeof verifyEmailBody>;
+export declare const verifyEmailResponse: z.ZodObject<{
+    success: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    success: boolean;
+}, {
+    success: boolean;
+}>;
+export type verifyEmailResponse = z.infer<typeof verifyEmailResponse>;

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

@@ -0,0 +1,85 @@
+import { z } from 'zod';
+import { extendZodWithOpenApi } from '@anatine/zod-openapi';
+import { PhoneNumberData, TwoFactorMethod } from './sms.types.js';
+import { IBaseEntity } from './entity.types.js';
+import { PhoneZodSchema } from './phone.type.js';
+extendZodWithOpenApi(z);
+export const validPhoneNumberBody = z.object({
+    countryCode: z.string().length(2),
+    phoneNumber: PhoneZodSchema,
+});
+export const validPhoneNumberResponse = PhoneNumberData;
+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 const setupPhoneNumberBody = z.object({
+    countryCode: z.string().length(2),
+    phoneNumber: PhoneZodSchema,
+});
+export const setupPhoneNumberResponse = z.object({
+    success: z.boolean(),
+});
+export const verifyPhoneNumberBody = z.object({
+    code: z.string(),
+});
+export const verifyPhoneNumberResponse = z.object({
+    success: z.boolean(),
+});
+export const sendVerificationCodeBody = z.object({});
+export const sendVerificationCodeResponse = z.object({
+    success: z.boolean(),
+});
+export const disableTwoFactorBody = z.object({
+    userLoginId: z.string(),
+});
+export const disableTwoFactorResponse = z.object({
+    success: z.boolean(),
+});
+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 const verifyTwoFactorBody = z.object({
+    token: z.string().length(6).openapi({
+        example: '123456',
+    }),
+});
+export const verifyTwoFactorResponse = z.object({
+    recoveryCodes: z.array(z.string()).openapi({
+        example: ['XXXX-XXXX-XXXX', 'XXXX-XXXX-XXXX'],
+    }),
+});
+export const changeTwoFactorMethodBody = z.object({
+    twoFactorMethod: z.nativeEnum(TwoFactorMethod),
+});
+export const sendEmailVerificationBody = z.object({});
+export const sendEmailVerificationResponse = z.object({
+    success: z.boolean(),
+    expiresAt: z.string().openapi({
+        example: '2023-12-25T15:30:00Z',
+    }),
+});
+export const verifyEmailBody = z.object({
+    code: z.string().length(6).openapi({
+        example: '123456',
+    }),
+});
+export const verifyEmailResponse = z.object({
+    success: z.boolean(),
+});
+//# sourceMappingURL=user-setting.types.js.map

package/common/types/user-setting.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-setting.types.js","sourceRoot":"","sources":["user-setting.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,eAAe,EAAE,MAAM,aAAa,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,oBAAoB,CAAC,CAAC,CAAC,CAAC;AAExB,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3C,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IACjC,WAAW,EAAE,cAAc;CAC5B,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,wBAAwB,GAAG,eAAe,CAAC;AAGxD,MAAM,CAAC,MAAM,eAAe,GAAG,WAAW,CAAC,MAAM,CAAC;IAChD,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,eAAe,EAAE,CAAC,CAAC,UAAU,CAAC,eAAe,CAAC;IAC9C,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1C,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC7C,SAAS,EAAE,eAAe,CAAC,QAAQ,EAAE;IACrC,aAAa,EAAE,CAAC,CAAC,OAAO,EAAE;IAC1B,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1C,gBAAgB,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IACrC,aAAa,EAAE,CAAC,CAAC,OAAO,EAAE;IAC1B,qBAAqB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5C,kBAAkB,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;CACxC,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3C,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IACjC,WAAW,EAAE,cAAc;CAC5B,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/C,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;CACrB,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;CACjB,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;CACrB,CAAC,CAAC;AAKH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;AAGrD,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAAC;IACnD,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;CACrB,CAAC,CAAC;AAKH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3C,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;CACxB,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/C,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;CACrB,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7C,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC;QACzB,OAAO,EAAE,kBAAkB;KAC5B,CAAC;IACF,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC;QACvC,OAAO,EAAE,8DAA8D;KACxE,CAAC;CACH,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;QAClC,OAAO,EAAE,QAAQ;KAClB,CAAC;CACH,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC;QACzC,OAAO,EAAE,CAAC,gBAAgB,EAAE,gBAAgB,CAAC;KAC9C,CAAC;CACH,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,eAAe,EAAE,CAAC,CAAC,UAAU,CAAC,eAAe,CAAC;CAC/C,CAAC,CAAC;AAKH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;AAKtD,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAC,MAAM,CAAC;IACpD,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;IACpB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC;QAC5B,OAAO,EAAE,sBAAsB;KAChC,CAAC;CACH,CAAC,CAAC;AAKH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;QACjC,OAAO,EAAE,QAAQ;KAClB,CAAC;CACH,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;CACrB,CAAC,CAAC"}