@ackplus/nest-auth-contracts 1.1.29

package/README.md

@@ -0,0 +1,25 @@
+# @ackplus/nest-auth-contracts
+
+Shared interfaces, types, and DTOs for `@ackplus/nest-auth` ecosystem.
+
+## Usage
+
+This package is used as a dependency in projects that need to interact with `nest-auth` APIs but don't need the full NestJS module (e.g., client SDKs, other microservices).
+
+### Installation
+
+```bash
+npm install @ackplus/nest-auth-contracts
+# or
+pnpm add @ackplus/nest-auth-contracts
+```
+
+### Importing Types
+
+```typescript
+import { 
+  IEmailCredentials, 
+  INestAuthUser,
+  ILoginRequest 
+} from '@ackplus/nest-auth-contracts';
+```

package/dist/index.cjs

@@ -0,0 +1,45 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  NestAuthMFAMethodEnum: () => NestAuthMFAMethodEnum,
+  NestAuthOTPTypeEnum: () => NestAuthOTPTypeEnum
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/auth.ts
+var NestAuthOTPTypeEnum = /* @__PURE__ */ ((NestAuthOTPTypeEnum2) => {
+  NestAuthOTPTypeEnum2["PASSWORD_RESET"] = "password_reset";
+  NestAuthOTPTypeEnum2["VERIFICATION"] = "verification";
+  NestAuthOTPTypeEnum2["MFA"] = "mfa";
+  return NestAuthOTPTypeEnum2;
+})(NestAuthOTPTypeEnum || {});
+var NestAuthMFAMethodEnum = /* @__PURE__ */ ((NestAuthMFAMethodEnum2) => {
+  NestAuthMFAMethodEnum2["EMAIL"] = "email";
+  NestAuthMFAMethodEnum2["SMS"] = "sms";
+  NestAuthMFAMethodEnum2["TOTP"] = "totp";
+  return NestAuthMFAMethodEnum2;
+})(NestAuthMFAMethodEnum || {});
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  NestAuthMFAMethodEnum,
+  NestAuthOTPTypeEnum
+});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/auth.ts"],"sourcesContent":["/**\n * @libs/auth-s - Shared authentication s\n */\n\n// Auth s (from auth.ts)\nexport {\n    NestAuthMFAMethodEnum,\n    NestAuthOTPTypeEnum,\n    IEmailCredentials,\n    IPhoneCredentials,\n    ISocialCredentials,\n    ILoginCredentials,\n    ILoginRequest,\n    ISignupRequest,\n    IRefreshRequest,\n    ITokenPair,\n    IAuthResponse,\n    IAuthUser,\n    IAuthSession,\n    IMessageResponse,\n    IAuthCookieResponse,\n    IAuthSuccessResponse,\n    IUserResponse,\n    ITokensResponse,\n    // Entities\n    INestAuthIdentity,\n    INestAuthSession,\n    INestAuthAccessKey,\n    INestAuthOTP,\n} from './auth';\n\n// MFA (from mfa.ts)\nexport {\n    IVerify2faRequest,\n    IVerify2faResponse,\n    ISendMfaCodeRequest,\n    IToggleMfaRequest,\n    IVerifyTotpSetupRequest,\n    IMfaDevice,\n    IMfaStatusResponse,\n    IMfaCodeResponse,\n    ITotpSetupResponse,\n    // Entities\n    INestAuthMFASecret,\n    INestAuthTrustedDevice,\n} from './mfa';\n\n// Password\nexport {\n    IForgotPasswordRequest,\n    IResetPasswordRequest,\n    IResetPasswordWithTokenRequest,\n    IChangePasswordRequest,\n    IVerifyForgotPasswordOtpRequest,\n    IVerifyOtpResponse,\n} from './password';\n\n// Verification\nexport {\n    IVerifyEmailRequest,\n    IResendVerificationRequest,\n    ISendEmailVerificationRequest,\n    ISessionVerifyResponse,\n} from './verification';\n\n// Admin\nexport {\n    IInitializeAdminRequest,\n    IInitializeAdminResponse,\n    IAdminUser,\n} from './admin';\n\n// Config\nexport {\n    IEmailAuthConfig,\n    IPhoneAuthConfig,\n    IProfileFieldOption,\n    IProfileField,\n    IRegistrationConfig,\n    IMfaConfig,\n    ITenantOption,\n    ITenantsConfig,\n    ISsoProviderConfig,\n    ISsoConfig,\n    IUiConfig,\n    IClientConfigResponse,\n} from './config';\n\n// User & Role (from user.ts)\nexport {\n    INestAuthUser,\n    INestAuthRole,\n    INestAuthPermission,\n} from './user';\n\n// Tenant (from tenant.ts)\nexport {\n    INestAuthTenant,\n} from './tenant';\n\n","/**\n * Auth Types\n * Contains: Login/Signup/Token types + Auth Entities (Session, Identity, AccessKey, OTP)\n */\n\n// OTP Type Enum\nexport enum NestAuthOTPTypeEnum {\n    PASSWORD_RESET = 'password_reset',\n    VERIFICATION = 'verification',\n    MFA = 'mfa',\n}\n\n// MFA Method Enum (Needed for AuthResponse and others)\nexport enum NestAuthMFAMethodEnum {\n    EMAIL = 'email',\n    SMS = 'sms',\n    TOTP = 'totp',\n}\n\n// --- Entity Interfaces ---\n\nexport interface INestAuthIdentity {\n    id: string;\n    provider: string;\n    providerId: string;\n    metadata?: Record<string, any>;\n    userId: string;\n    createdAt: Date;\n    updatedAt: Date;\n}\n\nexport interface INestAuthSession {\n    id: string;\n    userId: string;\n    data?: any;\n    refreshToken?: string;\n    expiresAt?: Date;\n    userAgent?: string;\n    deviceName?: string;\n    ipAddress?: string;\n    lastActive?: Date;\n    createdAt?: Date;\n    updatedAt?: Date;\n}\n\nexport interface INestAuthAccessKey {\n    id: string;\n    name: string;\n    publicKey: string;\n    privateKey: string;\n    description?: string;\n    isActive: boolean;\n    expiresAt?: Date;\n    lastUsedAt?: Date;\n    userId: string;\n    createdAt: Date;\n    updatedAt: Date;\n}\n\nexport interface INestAuthOTP {\n    id: string;\n    userId: string;\n    code: string;\n    type: NestAuthOTPTypeEnum;\n    expiresAt: Date;\n    used: boolean;\n    createdAt: Date;\n    updatedAt: Date;\n}\n\n// --- Request/Response Interfaces ---\n\nexport interface IEmailCredentials {\n    email: string;\n    password: string;\n}\n\nexport interface IPhoneCredentials {\n    phone: string;\n    password: string;\n}\n\nexport interface ISocialCredentials {\n    token: string;\n}\n\nexport type ILoginCredentials = IEmailCredentials | IPhoneCredentials | ISocialCredentials | Record<string, any>;\n\nexport interface ILoginRequest {\n    providerName?: 'email' | 'phone' | 'google' | 'facebook' | 'apple' | 'github' | string;\n    credentials: ILoginCredentials;\n    tenantId?: string;\n    createUserIfNotExists?: boolean;\n}\n\nexport interface ISignupRequest {\n    email?: string;\n    phone?: string;\n    password: string;\n    tenantId?: string;\n    [key: string]: any;\n}\n\nexport interface IRefreshRequest {\n    refreshToken?: string;\n}\n\nexport interface ITokenPair {\n    accessToken: string;\n    refreshToken: string;\n}\n\nexport interface IAuthUser {\n    id: string;\n    email?: string;\n    phone?: string;\n    isVerified?: boolean;\n    isMfaEnabled?: boolean;\n    roles?: string[];\n    permissions?: string[];\n    metadata?: Record<string, any>;\n    tenantId?: string;\n}\n\nexport interface IAuthResponse extends ITokenPair {\n    message?: string;\n    isRequiresMfa?: boolean;\n    mfaMethods?: NestAuthMFAMethodEnum[];\n    defaultMfaMethod?: NestAuthMFAMethodEnum;\n    user?: IAuthUser;\n}\n\nexport interface IAuthSession {\n    id: string;\n    userId: string;\n    expiresAt: string;\n    createdAt: string;\n}\n\nexport interface IMessageResponse {\n    message: string;\n}\n\nexport interface IAuthCookieResponse {\n    message: string;\n    isRequiresMfa?: boolean;\n}\n\nexport interface IAuthSuccessResponse {\n    message: string;\n    isRequiresMfa?: boolean;\n}\n\nexport interface IUserResponse {\n    id: string;\n    email?: string;\n    phone?: string;\n    isVerified?: boolean;\n    metadata?: Record<string, any>;\n}\n\nexport interface ITokensResponse {\n    accessToken: string;\n    refreshToken: string;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACMO,IAAK,sBAAL,kBAAKA,yBAAL;AACH,EAAAA,qBAAA,oBAAiB;AACjB,EAAAA,qBAAA,kBAAe;AACf,EAAAA,qBAAA,SAAM;AAHE,SAAAA;AAAA,GAAA;AAOL,IAAK,wBAAL,kBAAKC,2BAAL;AACH,EAAAA,uBAAA,WAAQ;AACR,EAAAA,uBAAA,SAAM;AACN,EAAAA,uBAAA,UAAO;AAHC,SAAAA;AAAA,GAAA;","names":["NestAuthOTPTypeEnum","NestAuthMFAMethodEnum"]}

package/dist/index.d.cts

@@ -0,0 +1,392 @@
+declare enum NestAuthOTPTypeEnum {
+    PASSWORD_RESET = "password_reset",
+    VERIFICATION = "verification",
+    MFA = "mfa"
+}
+declare enum NestAuthMFAMethodEnum {
+    EMAIL = "email",
+    SMS = "sms",
+    TOTP = "totp"
+}
+interface INestAuthIdentity {
+    id: string;
+    provider: string;
+    providerId: string;
+    metadata?: Record<string, any>;
+    userId: string;
+    createdAt: Date;
+    updatedAt: Date;
+}
+interface INestAuthSession {
+    id: string;
+    userId: string;
+    data?: any;
+    refreshToken?: string;
+    expiresAt?: Date;
+    userAgent?: string;
+    deviceName?: string;
+    ipAddress?: string;
+    lastActive?: Date;
+    createdAt?: Date;
+    updatedAt?: Date;
+}
+interface INestAuthAccessKey {
+    id: string;
+    name: string;
+    publicKey: string;
+    privateKey: string;
+    description?: string;
+    isActive: boolean;
+    expiresAt?: Date;
+    lastUsedAt?: Date;
+    userId: string;
+    createdAt: Date;
+    updatedAt: Date;
+}
+interface INestAuthOTP {
+    id: string;
+    userId: string;
+    code: string;
+    type: NestAuthOTPTypeEnum;
+    expiresAt: Date;
+    used: boolean;
+    createdAt: Date;
+    updatedAt: Date;
+}
+interface IEmailCredentials {
+    email: string;
+    password: string;
+}
+interface IPhoneCredentials {
+    phone: string;
+    password: string;
+}
+interface ISocialCredentials {
+    token: string;
+}
+type ILoginCredentials = IEmailCredentials | IPhoneCredentials | ISocialCredentials | Record<string, any>;
+interface ILoginRequest {
+    providerName?: 'email' | 'phone' | 'google' | 'facebook' | 'apple' | 'github' | string;
+    credentials: ILoginCredentials;
+    tenantId?: string;
+    createUserIfNotExists?: boolean;
+}
+interface ISignupRequest {
+    email?: string;
+    phone?: string;
+    password: string;
+    tenantId?: string;
+    [key: string]: any;
+}
+interface IRefreshRequest {
+    refreshToken?: string;
+}
+interface ITokenPair {
+    accessToken: string;
+    refreshToken: string;
+}
+interface IAuthUser {
+    id: string;
+    email?: string;
+    phone?: string;
+    isVerified?: boolean;
+    isMfaEnabled?: boolean;
+    roles?: string[];
+    permissions?: string[];
+    metadata?: Record<string, any>;
+    tenantId?: string;
+}
+interface IAuthResponse extends ITokenPair {
+    message?: string;
+    isRequiresMfa?: boolean;
+    mfaMethods?: NestAuthMFAMethodEnum[];
+    defaultMfaMethod?: NestAuthMFAMethodEnum;
+    user?: IAuthUser;
+}
+interface IAuthSession {
+    id: string;
+    userId: string;
+    expiresAt: string;
+    createdAt: string;
+}
+interface IMessageResponse {
+    message: string;
+}
+interface IAuthCookieResponse {
+    message: string;
+    isRequiresMfa?: boolean;
+}
+interface IAuthSuccessResponse {
+    message: string;
+    isRequiresMfa?: boolean;
+}
+interface IUserResponse {
+    id: string;
+    email?: string;
+    phone?: string;
+    isVerified?: boolean;
+    metadata?: Record<string, any>;
+}
+interface ITokensResponse {
+    accessToken: string;
+    refreshToken: string;
+}
+
+interface INestAuthMFASecret {
+    id: string;
+    userId: string;
+    secret: string;
+    verified: boolean;
+    deviceName?: string;
+    lastUsedAt?: Date;
+    createdAt: Date;
+    updatedAt: Date;
+}
+interface INestAuthTrustedDevice {
+    id: string;
+    userId: string;
+    token: string;
+    userAgent?: string;
+    ipAddress?: string;
+    expiresAt: Date;
+    lastUsedAt?: Date;
+    createdAt: Date;
+}
+interface IVerify2faRequest {
+    otp: string;
+    method?: NestAuthMFAMethodEnum;
+    trustDevice?: boolean;
+}
+interface IVerify2faResponse {
+    accessToken: string;
+    refreshToken: string;
+    message?: string;
+    trustToken?: string;
+}
+interface ISendMfaCodeRequest {
+    method: NestAuthMFAMethodEnum;
+}
+interface IToggleMfaRequest {
+    enabled: boolean;
+}
+interface IVerifyTotpSetupRequest {
+    otp: string;
+    secret: string;
+}
+interface IMfaDevice {
+    id: string;
+    deviceName: string;
+    method: NestAuthMFAMethodEnum;
+    lastUsedAt?: Date | string | null;
+    verified: boolean;
+    createdAt?: Date | string | null;
+}
+interface IMfaStatusResponse {
+    isEnabled: boolean;
+    verifiedMethods: NestAuthMFAMethodEnum[];
+    configuredMethods: NestAuthMFAMethodEnum[];
+    allowUserToggle: boolean;
+    allowMethodSelection: boolean;
+    totpDevices: IMfaDevice[];
+    hasRecoveryCode: boolean;
+}
+interface IMfaCodeResponse {
+    code: string;
+    expiresAt: Date | string;
+    used: boolean;
+    warning?: string;
+}
+interface ITotpSetupResponse {
+    secret: string;
+    qrCode: string;
+    otpAuthUrl: string;
+}
+
+interface IForgotPasswordRequest {
+    email?: string;
+    phone?: string;
+}
+interface IResetPasswordRequest {
+    otp: string;
+    newPassword: string;
+}
+interface IResetPasswordWithTokenRequest {
+    token: string;
+    newPassword: string;
+}
+interface IChangePasswordRequest {
+    currentPassword: string;
+    newPassword: string;
+}
+interface IVerifyForgotPasswordOtpRequest {
+    email?: string;
+    phone?: string;
+    otp: string;
+    tenantId?: string;
+}
+interface IVerifyOtpResponse {
+    message: string;
+    resetToken?: string;
+    token?: string;
+}
+
+interface IVerifyEmailRequest {
+    otp: string;
+}
+interface IResendVerificationRequest {
+    email?: string;
+}
+interface ISendEmailVerificationRequest {
+    tenantId?: string;
+}
+interface ISessionVerifyResponse {
+    valid: boolean;
+    userId?: string;
+    expiresAt?: string;
+}
+
+interface IInitializeAdminRequest {
+    email: string;
+    password: string;
+    secretKey?: string;
+    tenantId?: string;
+    metadata?: Record<string, any>;
+}
+interface IInitializeAdminResponse {
+    message: string;
+    user: IUserResponse;
+    role: string;
+}
+interface IAdminUser {
+    id: string;
+    email: string;
+    name?: string;
+    passwordHash: string;
+    metadata?: Record<string, any>;
+    lastLoginAt?: Date;
+    createdAt: Date;
+    updatedAt: Date;
+}
+
+interface IEmailAuthConfig {
+    enabled: boolean;
+}
+interface IPhoneAuthConfig {
+    enabled: boolean;
+}
+interface IProfileFieldOption {
+    label: string;
+    value: string;
+}
+interface IProfileField {
+    id: string;
+    label: string;
+    required?: boolean;
+    type?: 'text' | 'email' | 'phone' | 'select' | 'checkbox' | 'password';
+    placeholder?: string;
+    options?: IProfileFieldOption[];
+}
+interface IRegistrationConfig {
+    enabled: boolean;
+    requireInvitation?: boolean;
+    collectProfileFields?: IProfileField[];
+}
+interface IMfaConfig {
+    enabled: boolean;
+    methods?: NestAuthMFAMethodEnum[];
+    allowUserToggle?: boolean;
+    allowMethodSelection?: boolean;
+}
+interface ITenantOption {
+    id: string;
+    name: string;
+    slug: string;
+    isActive: boolean;
+    metadata?: Record<string, any>;
+}
+interface ITenantsConfig {
+    mode: 'single' | 'multi';
+    defaultTenantId: string | null;
+    options?: ITenantOption[];
+}
+interface ISsoProviderConfig {
+    id: string;
+    name: string;
+    logoUrl?: string;
+    authorizationUrl?: string;
+    clientId?: string;
+    hint?: string;
+}
+interface ISsoConfig {
+    enabled: boolean;
+    providers?: ISsoProviderConfig[];
+}
+interface IUiConfig {
+    brandName?: string;
+    brandColor?: string;
+    logoUrl?: string;
+    backgroundImageUrl?: string;
+}
+interface IClientConfigResponse {
+    emailAuth: IEmailAuthConfig;
+    phoneAuth: IPhoneAuthConfig;
+    registration: IRegistrationConfig;
+    mfa: IMfaConfig;
+    tenants: ITenantsConfig;
+    sso: ISsoConfig;
+    ui?: IUiConfig;
+}
+
+interface INestAuthUser {
+    id: string;
+    email?: string;
+    emailVerifiedAt?: Date;
+    phone?: string;
+    phoneVerifiedAt?: Date;
+    passwordHash?: string;
+    isVerified: boolean;
+    isActive: boolean;
+    metadata?: Record<string, any>;
+    tenantId?: string;
+    isMfaEnabled: boolean;
+    mfaRecoveryCode?: string;
+    emailTenant?: string;
+    phoneTenant?: string;
+    createdAt: Date;
+    updatedAt: Date;
+}
+interface INestAuthRole {
+    id: string;
+    name: string;
+    guard: string;
+    tenantId?: string;
+    isSystem: boolean;
+    isActive: boolean;
+    permissions: string[];
+    createdAt: Date;
+    updatedAt: Date;
+}
+interface INestAuthPermission {
+    id: string;
+    name: string;
+    guard: string;
+    description?: string;
+    category?: string;
+    metadata?: Record<string, any>;
+    createdAt: Date;
+    updatedAt: Date;
+}
+
+interface INestAuthTenant {
+    id: string;
+    name: string;
+    slug: string;
+    domain?: string;
+    description?: string;
+    metadata?: Record<string, any>;
+    isActive: boolean;
+    createdAt: Date;
+    updatedAt: Date;
+}
+
+export { type IAdminUser, type IAuthCookieResponse, type IAuthResponse, type IAuthSession, type IAuthSuccessResponse, type IAuthUser, type IChangePasswordRequest, type IClientConfigResponse, type IEmailAuthConfig, type IEmailCredentials, type IForgotPasswordRequest, type IInitializeAdminRequest, type IInitializeAdminResponse, type ILoginCredentials, type ILoginRequest, type IMessageResponse, type IMfaCodeResponse, type IMfaConfig, type IMfaDevice, type IMfaStatusResponse, type INestAuthAccessKey, type INestAuthIdentity, type INestAuthMFASecret, type INestAuthOTP, type INestAuthPermission, type INestAuthRole, type INestAuthSession, type INestAuthTenant, type INestAuthTrustedDevice, type INestAuthUser, type IPhoneAuthConfig, type IPhoneCredentials, type IProfileField, type IProfileFieldOption, type IRefreshRequest, type IRegistrationConfig, type IResendVerificationRequest, type IResetPasswordRequest, type IResetPasswordWithTokenRequest, type ISendEmailVerificationRequest, type ISendMfaCodeRequest, type ISessionVerifyResponse, type ISignupRequest, type ISocialCredentials, type ISsoConfig, type ISsoProviderConfig, type ITenantOption, type ITenantsConfig, type IToggleMfaRequest, type ITokenPair, type ITokensResponse, type ITotpSetupResponse, type IUiConfig, type IUserResponse, type IVerify2faRequest, type IVerify2faResponse, type IVerifyEmailRequest, type IVerifyForgotPasswordOtpRequest, type IVerifyOtpResponse, type IVerifyTotpSetupRequest, NestAuthMFAMethodEnum, NestAuthOTPTypeEnum };

package/dist/index.d.ts

@@ -0,0 +1,392 @@
+declare enum NestAuthOTPTypeEnum {
+    PASSWORD_RESET = "password_reset",
+    VERIFICATION = "verification",
+    MFA = "mfa"
+}
+declare enum NestAuthMFAMethodEnum {
+    EMAIL = "email",
+    SMS = "sms",
+    TOTP = "totp"
+}
+interface INestAuthIdentity {
+    id: string;
+    provider: string;
+    providerId: string;
+    metadata?: Record<string, any>;
+    userId: string;
+    createdAt: Date;
+    updatedAt: Date;
+}
+interface INestAuthSession {
+    id: string;
+    userId: string;
+    data?: any;
+    refreshToken?: string;
+    expiresAt?: Date;
+    userAgent?: string;
+    deviceName?: string;
+    ipAddress?: string;
+    lastActive?: Date;
+    createdAt?: Date;
+    updatedAt?: Date;
+}
+interface INestAuthAccessKey {
+    id: string;
+    name: string;
+    publicKey: string;
+    privateKey: string;
+    description?: string;
+    isActive: boolean;
+    expiresAt?: Date;
+    lastUsedAt?: Date;
+    userId: string;
+    createdAt: Date;
+    updatedAt: Date;
+}
+interface INestAuthOTP {
+    id: string;
+    userId: string;
+    code: string;
+    type: NestAuthOTPTypeEnum;
+    expiresAt: Date;
+    used: boolean;
+    createdAt: Date;
+    updatedAt: Date;
+}
+interface IEmailCredentials {
+    email: string;
+    password: string;
+}
+interface IPhoneCredentials {
+    phone: string;
+    password: string;
+}
+interface ISocialCredentials {
+    token: string;
+}
+type ILoginCredentials = IEmailCredentials | IPhoneCredentials | ISocialCredentials | Record<string, any>;
+interface ILoginRequest {
+    providerName?: 'email' | 'phone' | 'google' | 'facebook' | 'apple' | 'github' | string;
+    credentials: ILoginCredentials;
+    tenantId?: string;
+    createUserIfNotExists?: boolean;
+}
+interface ISignupRequest {
+    email?: string;
+    phone?: string;
+    password: string;
+    tenantId?: string;
+    [key: string]: any;
+}
+interface IRefreshRequest {
+    refreshToken?: string;
+}
+interface ITokenPair {
+    accessToken: string;
+    refreshToken: string;
+}
+interface IAuthUser {
+    id: string;
+    email?: string;
+    phone?: string;
+    isVerified?: boolean;
+    isMfaEnabled?: boolean;
+    roles?: string[];
+    permissions?: string[];
+    metadata?: Record<string, any>;
+    tenantId?: string;
+}
+interface IAuthResponse extends ITokenPair {
+    message?: string;
+    isRequiresMfa?: boolean;
+    mfaMethods?: NestAuthMFAMethodEnum[];
+    defaultMfaMethod?: NestAuthMFAMethodEnum;
+    user?: IAuthUser;
+}
+interface IAuthSession {
+    id: string;
+    userId: string;
+    expiresAt: string;
+    createdAt: string;
+}
+interface IMessageResponse {
+    message: string;
+}
+interface IAuthCookieResponse {
+    message: string;
+    isRequiresMfa?: boolean;
+}
+interface IAuthSuccessResponse {
+    message: string;
+    isRequiresMfa?: boolean;
+}
+interface IUserResponse {
+    id: string;
+    email?: string;
+    phone?: string;
+    isVerified?: boolean;
+    metadata?: Record<string, any>;
+}
+interface ITokensResponse {
+    accessToken: string;
+    refreshToken: string;
+}
+
+interface INestAuthMFASecret {
+    id: string;
+    userId: string;
+    secret: string;
+    verified: boolean;
+    deviceName?: string;
+    lastUsedAt?: Date;
+    createdAt: Date;
+    updatedAt: Date;
+}
+interface INestAuthTrustedDevice {
+    id: string;
+    userId: string;
+    token: string;
+    userAgent?: string;
+    ipAddress?: string;
+    expiresAt: Date;
+    lastUsedAt?: Date;
+    createdAt: Date;
+}
+interface IVerify2faRequest {
+    otp: string;
+    method?: NestAuthMFAMethodEnum;
+    trustDevice?: boolean;
+}
+interface IVerify2faResponse {
+    accessToken: string;
+    refreshToken: string;
+    message?: string;
+    trustToken?: string;
+}
+interface ISendMfaCodeRequest {
+    method: NestAuthMFAMethodEnum;
+}
+interface IToggleMfaRequest {
+    enabled: boolean;
+}
+interface IVerifyTotpSetupRequest {
+    otp: string;
+    secret: string;
+}
+interface IMfaDevice {
+    id: string;
+    deviceName: string;
+    method: NestAuthMFAMethodEnum;
+    lastUsedAt?: Date | string | null;
+    verified: boolean;
+    createdAt?: Date | string | null;
+}
+interface IMfaStatusResponse {
+    isEnabled: boolean;
+    verifiedMethods: NestAuthMFAMethodEnum[];
+    configuredMethods: NestAuthMFAMethodEnum[];
+    allowUserToggle: boolean;
+    allowMethodSelection: boolean;
+    totpDevices: IMfaDevice[];
+    hasRecoveryCode: boolean;
+}
+interface IMfaCodeResponse {
+    code: string;
+    expiresAt: Date | string;
+    used: boolean;
+    warning?: string;
+}
+interface ITotpSetupResponse {
+    secret: string;
+    qrCode: string;
+    otpAuthUrl: string;
+}
+
+interface IForgotPasswordRequest {
+    email?: string;
+    phone?: string;
+}
+interface IResetPasswordRequest {
+    otp: string;
+    newPassword: string;
+}
+interface IResetPasswordWithTokenRequest {
+    token: string;
+    newPassword: string;
+}
+interface IChangePasswordRequest {
+    currentPassword: string;
+    newPassword: string;
+}
+interface IVerifyForgotPasswordOtpRequest {
+    email?: string;
+    phone?: string;
+    otp: string;
+    tenantId?: string;
+}
+interface IVerifyOtpResponse {
+    message: string;
+    resetToken?: string;
+    token?: string;
+}
+
+interface IVerifyEmailRequest {
+    otp: string;
+}
+interface IResendVerificationRequest {
+    email?: string;
+}
+interface ISendEmailVerificationRequest {
+    tenantId?: string;
+}
+interface ISessionVerifyResponse {
+    valid: boolean;
+    userId?: string;
+    expiresAt?: string;
+}
+
+interface IInitializeAdminRequest {
+    email: string;
+    password: string;
+    secretKey?: string;
+    tenantId?: string;
+    metadata?: Record<string, any>;
+}
+interface IInitializeAdminResponse {
+    message: string;
+    user: IUserResponse;
+    role: string;
+}
+interface IAdminUser {
+    id: string;
+    email: string;
+    name?: string;
+    passwordHash: string;
+    metadata?: Record<string, any>;
+    lastLoginAt?: Date;
+    createdAt: Date;
+    updatedAt: Date;
+}
+
+interface IEmailAuthConfig {
+    enabled: boolean;
+}
+interface IPhoneAuthConfig {
+    enabled: boolean;
+}
+interface IProfileFieldOption {
+    label: string;
+    value: string;
+}
+interface IProfileField {
+    id: string;
+    label: string;
+    required?: boolean;
+    type?: 'text' | 'email' | 'phone' | 'select' | 'checkbox' | 'password';
+    placeholder?: string;
+    options?: IProfileFieldOption[];
+}
+interface IRegistrationConfig {
+    enabled: boolean;
+    requireInvitation?: boolean;
+    collectProfileFields?: IProfileField[];
+}
+interface IMfaConfig {
+    enabled: boolean;
+    methods?: NestAuthMFAMethodEnum[];
+    allowUserToggle?: boolean;
+    allowMethodSelection?: boolean;
+}
+interface ITenantOption {
+    id: string;
+    name: string;
+    slug: string;
+    isActive: boolean;
+    metadata?: Record<string, any>;
+}
+interface ITenantsConfig {
+    mode: 'single' | 'multi';
+    defaultTenantId: string | null;
+    options?: ITenantOption[];
+}
+interface ISsoProviderConfig {
+    id: string;
+    name: string;
+    logoUrl?: string;
+    authorizationUrl?: string;
+    clientId?: string;
+    hint?: string;
+}
+interface ISsoConfig {
+    enabled: boolean;
+    providers?: ISsoProviderConfig[];
+}
+interface IUiConfig {
+    brandName?: string;
+    brandColor?: string;
+    logoUrl?: string;
+    backgroundImageUrl?: string;
+}
+interface IClientConfigResponse {
+    emailAuth: IEmailAuthConfig;
+    phoneAuth: IPhoneAuthConfig;
+    registration: IRegistrationConfig;
+    mfa: IMfaConfig;
+    tenants: ITenantsConfig;
+    sso: ISsoConfig;
+    ui?: IUiConfig;
+}
+
+interface INestAuthUser {
+    id: string;
+    email?: string;
+    emailVerifiedAt?: Date;
+    phone?: string;
+    phoneVerifiedAt?: Date;
+    passwordHash?: string;
+    isVerified: boolean;
+    isActive: boolean;
+    metadata?: Record<string, any>;
+    tenantId?: string;
+    isMfaEnabled: boolean;
+    mfaRecoveryCode?: string;
+    emailTenant?: string;
+    phoneTenant?: string;
+    createdAt: Date;
+    updatedAt: Date;
+}
+interface INestAuthRole {
+    id: string;
+    name: string;
+    guard: string;
+    tenantId?: string;
+    isSystem: boolean;
+    isActive: boolean;
+    permissions: string[];
+    createdAt: Date;
+    updatedAt: Date;
+}
+interface INestAuthPermission {
+    id: string;
+    name: string;
+    guard: string;
+    description?: string;
+    category?: string;
+    metadata?: Record<string, any>;
+    createdAt: Date;
+    updatedAt: Date;
+}
+
+interface INestAuthTenant {
+    id: string;
+    name: string;
+    slug: string;
+    domain?: string;
+    description?: string;
+    metadata?: Record<string, any>;
+    isActive: boolean;
+    createdAt: Date;
+    updatedAt: Date;
+}
+
+export { type IAdminUser, type IAuthCookieResponse, type IAuthResponse, type IAuthSession, type IAuthSuccessResponse, type IAuthUser, type IChangePasswordRequest, type IClientConfigResponse, type IEmailAuthConfig, type IEmailCredentials, type IForgotPasswordRequest, type IInitializeAdminRequest, type IInitializeAdminResponse, type ILoginCredentials, type ILoginRequest, type IMessageResponse, type IMfaCodeResponse, type IMfaConfig, type IMfaDevice, type IMfaStatusResponse, type INestAuthAccessKey, type INestAuthIdentity, type INestAuthMFASecret, type INestAuthOTP, type INestAuthPermission, type INestAuthRole, type INestAuthSession, type INestAuthTenant, type INestAuthTrustedDevice, type INestAuthUser, type IPhoneAuthConfig, type IPhoneCredentials, type IProfileField, type IProfileFieldOption, type IRefreshRequest, type IRegistrationConfig, type IResendVerificationRequest, type IResetPasswordRequest, type IResetPasswordWithTokenRequest, type ISendEmailVerificationRequest, type ISendMfaCodeRequest, type ISessionVerifyResponse, type ISignupRequest, type ISocialCredentials, type ISsoConfig, type ISsoProviderConfig, type ITenantOption, type ITenantsConfig, type IToggleMfaRequest, type ITokenPair, type ITokensResponse, type ITotpSetupResponse, type IUiConfig, type IUserResponse, type IVerify2faRequest, type IVerify2faResponse, type IVerifyEmailRequest, type IVerifyForgotPasswordOtpRequest, type IVerifyOtpResponse, type IVerifyTotpSetupRequest, NestAuthMFAMethodEnum, NestAuthOTPTypeEnum };

package/dist/index.js

@@ -0,0 +1,18 @@
+// src/auth.ts
+var NestAuthOTPTypeEnum = /* @__PURE__ */ ((NestAuthOTPTypeEnum2) => {
+  NestAuthOTPTypeEnum2["PASSWORD_RESET"] = "password_reset";
+  NestAuthOTPTypeEnum2["VERIFICATION"] = "verification";
+  NestAuthOTPTypeEnum2["MFA"] = "mfa";
+  return NestAuthOTPTypeEnum2;
+})(NestAuthOTPTypeEnum || {});
+var NestAuthMFAMethodEnum = /* @__PURE__ */ ((NestAuthMFAMethodEnum2) => {
+  NestAuthMFAMethodEnum2["EMAIL"] = "email";
+  NestAuthMFAMethodEnum2["SMS"] = "sms";
+  NestAuthMFAMethodEnum2["TOTP"] = "totp";
+  return NestAuthMFAMethodEnum2;
+})(NestAuthMFAMethodEnum || {});
+export {
+  NestAuthMFAMethodEnum,
+  NestAuthOTPTypeEnum
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/auth.ts"],"sourcesContent":["/**\n * Auth Types\n * Contains: Login/Signup/Token types + Auth Entities (Session, Identity, AccessKey, OTP)\n */\n\n// OTP Type Enum\nexport enum NestAuthOTPTypeEnum {\n    PASSWORD_RESET = 'password_reset',\n    VERIFICATION = 'verification',\n    MFA = 'mfa',\n}\n\n// MFA Method Enum (Needed for AuthResponse and others)\nexport enum NestAuthMFAMethodEnum {\n    EMAIL = 'email',\n    SMS = 'sms',\n    TOTP = 'totp',\n}\n\n// --- Entity Interfaces ---\n\nexport interface INestAuthIdentity {\n    id: string;\n    provider: string;\n    providerId: string;\n    metadata?: Record<string, any>;\n    userId: string;\n    createdAt: Date;\n    updatedAt: Date;\n}\n\nexport interface INestAuthSession {\n    id: string;\n    userId: string;\n    data?: any;\n    refreshToken?: string;\n    expiresAt?: Date;\n    userAgent?: string;\n    deviceName?: string;\n    ipAddress?: string;\n    lastActive?: Date;\n    createdAt?: Date;\n    updatedAt?: Date;\n}\n\nexport interface INestAuthAccessKey {\n    id: string;\n    name: string;\n    publicKey: string;\n    privateKey: string;\n    description?: string;\n    isActive: boolean;\n    expiresAt?: Date;\n    lastUsedAt?: Date;\n    userId: string;\n    createdAt: Date;\n    updatedAt: Date;\n}\n\nexport interface INestAuthOTP {\n    id: string;\n    userId: string;\n    code: string;\n    type: NestAuthOTPTypeEnum;\n    expiresAt: Date;\n    used: boolean;\n    createdAt: Date;\n    updatedAt: Date;\n}\n\n// --- Request/Response Interfaces ---\n\nexport interface IEmailCredentials {\n    email: string;\n    password: string;\n}\n\nexport interface IPhoneCredentials {\n    phone: string;\n    password: string;\n}\n\nexport interface ISocialCredentials {\n    token: string;\n}\n\nexport type ILoginCredentials = IEmailCredentials | IPhoneCredentials | ISocialCredentials | Record<string, any>;\n\nexport interface ILoginRequest {\n    providerName?: 'email' | 'phone' | 'google' | 'facebook' | 'apple' | 'github' | string;\n    credentials: ILoginCredentials;\n    tenantId?: string;\n    createUserIfNotExists?: boolean;\n}\n\nexport interface ISignupRequest {\n    email?: string;\n    phone?: string;\n    password: string;\n    tenantId?: string;\n    [key: string]: any;\n}\n\nexport interface IRefreshRequest {\n    refreshToken?: string;\n}\n\nexport interface ITokenPair {\n    accessToken: string;\n    refreshToken: string;\n}\n\nexport interface IAuthUser {\n    id: string;\n    email?: string;\n    phone?: string;\n    isVerified?: boolean;\n    isMfaEnabled?: boolean;\n    roles?: string[];\n    permissions?: string[];\n    metadata?: Record<string, any>;\n    tenantId?: string;\n}\n\nexport interface IAuthResponse extends ITokenPair {\n    message?: string;\n    isRequiresMfa?: boolean;\n    mfaMethods?: NestAuthMFAMethodEnum[];\n    defaultMfaMethod?: NestAuthMFAMethodEnum;\n    user?: IAuthUser;\n}\n\nexport interface IAuthSession {\n    id: string;\n    userId: string;\n    expiresAt: string;\n    createdAt: string;\n}\n\nexport interface IMessageResponse {\n    message: string;\n}\n\nexport interface IAuthCookieResponse {\n    message: string;\n    isRequiresMfa?: boolean;\n}\n\nexport interface IAuthSuccessResponse {\n    message: string;\n    isRequiresMfa?: boolean;\n}\n\nexport interface IUserResponse {\n    id: string;\n    email?: string;\n    phone?: string;\n    isVerified?: boolean;\n    metadata?: Record<string, any>;\n}\n\nexport interface ITokensResponse {\n    accessToken: string;\n    refreshToken: string;\n}\n"],"mappings":";AAMO,IAAK,sBAAL,kBAAKA,yBAAL;AACH,EAAAA,qBAAA,oBAAiB;AACjB,EAAAA,qBAAA,kBAAe;AACf,EAAAA,qBAAA,SAAM;AAHE,SAAAA;AAAA,GAAA;AAOL,IAAK,wBAAL,kBAAKC,2BAAL;AACH,EAAAA,uBAAA,WAAQ;AACR,EAAAA,uBAAA,SAAM;AACN,EAAAA,uBAAA,UAAO;AAHC,SAAAA;AAAA,GAAA;","names":["NestAuthOTPTypeEnum","NestAuthMFAMethodEnum"]}

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@ackplus/nest-auth-contracts",
+  "version": "1.1.29",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "sideEffects": false,
+  "devDependencies": {
+    "typescript": "^5.0.0",
+    "tsup": "^8.3.5"
+  },
+  "scripts": {
+    "build": "tsup"
+  }
+}