@nauth-toolkit/core 0.1.13 → 0.1.17

package/dist/index.d.ts

@@ -1,10 +1,44 @@
+/**
+ * Main authentication service
+ * Handles signup, login, logout, password management, and user operations
+ */
 export * from './services/auth.service';
+/**
+ * Multi-Factor Authentication service
+ * Manages MFA setup, verification, and device management
+ */
 export * from './services/mfa.service';
+/**
+ * Social authentication service
+ * Complete API for OAuth authentication, social account linking, and management
+ */
 export * from './services/social-auth.service';
+/**
+ * Email verification service
+ * Handles email verification codes and verification workflows
+ */
 export * from './services/email-verification.service';
+/**
+ * Phone verification service
+ * Handles SMS verification codes and phone verification workflows
+ */
 export * from './services/phone-verification.service';
+/**
+ * Client information service
+ * Provides access to request context (IP, user agent, device token, session ID)
+ */
 export * from './services/client-info.service';
+/**
+ * Authentication audit service
+ * Logs and queries authentication events for security monitoring
+ *
+ * Note: Only query methods are available in the public API.
+ * Event recording is handled internally by the framework.
+ */
 export { AuthAuditService } from './services/auth-audit.service';
+/**
+ * CSRF Protection Service
+ */
 export { CsrfService } from './services/csrf.service';
 export * from './dto';
 export { NAuthException, getHttpStatusForErrorCode } from './exceptions/nauth.exception';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAUA,cAAc,yBAAyB,CAAC;AAMxC,cAAc,wBAAwB,CAAC;AAMvC,cAAc,gCAAgC,CAAC;AAM/C,cAAc,uCAAuC,CAAC;AAMtD,cAAc,uCAAuC,CAAC;AAMtD,cAAc,gCAAgC,CAAC;AAS/C,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAKjE,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAgBtD,cAAc,OAAO,CAAC;AAGtB,OAAO,EAAE,cAAc,EAAE,yBAAyB,EAAE,MAAM,8BAA8B,CAAC;AACzF,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,kBAAkB,EAAE,MAAM,oCAAoC,CAAC;AACxE,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAG9G,cAAc,cAAc,CAAC;AAE7B,YAAY,EAAE,UAAU,IAAI,WAAW,EAAE,MAAM,oCAAoC,CAAC;AAGpF,OAAO,EAAE,gBAAgB,EAAE,KAAK,WAAW,IAAI,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAE3G,YAAY,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAGjE,cAAc,YAAY,CAAC;AAG3B,cAAc,WAAW,CAAC;AAG1B,cAAc,aAAa,CAAC;AAG5B,cAAc,SAAS,CAAC;AAGxB,cAAc,iCAAiC,CAAC;AAOhD,cAAc,aAAa,CAAC;AAG5B,cAAc,uBAAuB,CAAC;AAGtC,cAAc,YAAY,CAAC;AAG3B,cAAc,4BAA4B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAMA;;;GAGG;AACH,cAAc,yBAAyB,CAAC;AAExC;;;GAGG;AACH,cAAc,wBAAwB,CAAC;AAEvC;;;GAGG;AACH,cAAc,gCAAgC,CAAC;AAE/C;;;GAGG;AACH,cAAc,uCAAuC,CAAC;AAEtD;;;GAGG;AACH,cAAc,uCAAuC,CAAC;AAEtD;;;GAGG;AACH,cAAc,gCAAgC,CAAC;AAE/C;;;;;;GAMG;AACH,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAEjE;;GAEG;AACH,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAgBtD,cAAc,OAAO,CAAC;AAGtB,OAAO,EAAE,cAAc,EAAE,yBAAyB,EAAE,MAAM,8BAA8B,CAAC;AACzF,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,kBAAkB,EAAE,MAAM,oCAAoC,CAAC;AACxE,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAG9G,cAAc,cAAc,CAAC;AAE7B,YAAY,EAAE,UAAU,IAAI,WAAW,EAAE,MAAM,oCAAoC,CAAC;AAGpF,OAAO,EAAE,gBAAgB,EAAE,KAAK,WAAW,IAAI,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAE3G,YAAY,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAGjE,cAAc,YAAY,CAAC;AAG3B,cAAc,WAAW,CAAC;AAG1B,cAAc,aAAa,CAAC;AAG5B,cAAc,SAAS,CAAC;AAGxB,cAAc,iCAAiC,CAAC;AAOhD,cAAc,aAAa,CAAC;AAG5B,cAAc,uBAAuB,CAAC;AAGtC,cAAc,YAAY,CAAC;AAG3B,cAAc,4BAA4B,CAAC"}

package/dist/index.js

@@ -1,4 +1,9 @@
 "use strict";
+// ============================================================================
+// Public Services API
+// ============================================================================
+// These are the services that consumer applications should use directly.
+// For internal services needed by framework adapters, see ./internal.ts
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -15,17 +20,65 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.authConfigSchema = exports.MFADeviceMethods = exports.MFAMethod = exports.AuthAuditEventType = exports.AuthErrorCode = exports.getHttpStatusForErrorCode = exports.NAuthException = exports.CsrfService = exports.AuthAuditService = void 0;
+/**
+ * Main authentication service
+ * Handles signup, login, logout, password management, and user operations
+ */
 __exportStar(require("./services/auth.service"), exports);
+/**
+ * Multi-Factor Authentication service
+ * Manages MFA setup, verification, and device management
+ */
 __exportStar(require("./services/mfa.service"), exports);
+/**
+ * Social authentication service
+ * Complete API for OAuth authentication, social account linking, and management
+ */
 __exportStar(require("./services/social-auth.service"), exports);
+/**
+ * Email verification service
+ * Handles email verification codes and verification workflows
+ */
 __exportStar(require("./services/email-verification.service"), exports);
+/**
+ * Phone verification service
+ * Handles SMS verification codes and phone verification workflows
+ */
 __exportStar(require("./services/phone-verification.service"), exports);
+/**
+ * Client information service
+ * Provides access to request context (IP, user agent, device token, session ID)
+ */
 __exportStar(require("./services/client-info.service"), exports);
+/**
+ * Authentication audit service
+ * Logs and queries authentication events for security monitoring
+ *
+ * Note: Only query methods are available in the public API.
+ * Event recording is handled internally by the framework.
+ */
 var auth_audit_service_1 = require("./services/auth-audit.service");
 Object.defineProperty(exports, "AuthAuditService", { enumerable: true, get: function () { return auth_audit_service_1.AuthAuditService; } });
+/**
+ * CSRF Protection Service
+ */
 var csrf_service_1 = require("./services/csrf.service");
 Object.defineProperty(exports, "CsrfService", { enumerable: true, get: function () { return csrf_service_1.CsrfService; } });
+// ============================================================================
+// Internal Services - NOT EXPORTED
+// ============================================================================
+// Internal services are NOT exported from this file. They are only available
+// via '@nauth-toolkit/core/internal' for framework adapter development.
+//
+// Consumer applications should use the public services above (AuthService,
+// MFAService, etc.) which provide high-level APIs and automatically manage
+// internal services like password hashing, JWT tokens, and sessions.
+// ============================================================================
+// DTOs, Exceptions, Interfaces, Entities, Storage, and Utilities
+// ============================================================================
+// DTOs (Core only - feature DTOs moved to feature packages)
 __exportStar(require("./dto"), exports);
+// Exceptions & Error Handling
 var nauth_exception_1 = require("./exceptions/nauth.exception");
 Object.defineProperty(exports, "NAuthException", { enumerable: true, get: function () { return nauth_exception_1.NAuthException; } });
 Object.defineProperty(exports, "getHttpStatusForErrorCode", { enumerable: true, get: function () { return nauth_exception_1.getHttpStatusForErrorCode; } });
@@ -36,16 +89,30 @@ Object.defineProperty(exports, "AuthAuditEventType", { enumerable: true, get: fu
 var mfa_method_enum_1 = require("./enums/mfa-method.enum");
 Object.defineProperty(exports, "MFAMethod", { enumerable: true, get: function () { return mfa_method_enum_1.MFAMethod; } });
 Object.defineProperty(exports, "MFADeviceMethods", { enumerable: true, get: function () { return mfa_method_enum_1.MFADeviceMethods; } });
+// Interfaces (All interfaces stay in core for contracts)
 __exportStar(require("./interfaces"), exports);
+// Zod Schemas (Runtime validation)
 var auth_config_schema_1 = require("./schemas/auth-config.schema");
 Object.defineProperty(exports, "authConfigSchema", { enumerable: true, get: function () { return auth_config_schema_1.authConfigSchema; } });
+// Base Entity Classes (Database-agnostic entities)
 __exportStar(require("./entities"), exports);
+// Storage
 __exportStar(require("./storage"), exports);
+// Templates (Shared base templates)
 __exportStar(require("./templates"), exports);
+// Utilities
 __exportStar(require("./utils"), exports);
+// Validators
 __exportStar(require("./validators/template.validator"), exports);
+// ============================================================================
+// Platform Agnostic Components (New Architecture)
+// ============================================================================
+// Bootstrap
 __exportStar(require("./bootstrap"), exports);
+// Platform Interfaces
 __exportStar(require("./platform/interfaces"), exports);
+// Adapters
 __exportStar(require("./adapters"), exports);
+// Storage Factories
 __exportStar(require("./adapters/storage.factory"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAUA,0DAAwC;AAMxC,yDAAuC;AAMvC,iEAA+C;AAM/C,wEAAsD;AAMtD,wEAAsD;AAMtD,iEAA+C;AAS/C,oEAAiE;AAAxD,sHAAA,gBAAgB,OAAA;AAKzB,wDAAsD;AAA7C,2GAAA,WAAW,OAAA;AAgBpB,wCAAsB;AAGtB,gEAAyF;AAAhF,iHAAA,cAAc,OAAA;AAAE,4HAAA,yBAAyB,OAAA;AAClD,6DAAyD;AAAhD,iHAAA,aAAa,OAAA;AACtB,iFAAwE;AAA/D,gIAAA,kBAAkB,OAAA;AAC3B,2DAA8G;AAArG,4GAAA,SAAS,OAAA;AAA0C,mHAAA,gBAAgB,OAAA;AAG5E,+CAA6B;AAK7B,mEAA2G;AAAlG,sHAAA,gBAAgB,OAAA;AAKzB,6CAA2B;AAG3B,4CAA0B;AAG1B,8CAA4B;AAG5B,0CAAwB;AAGxB,kEAAgD;AAOhD,8CAA4B;AAG5B,wDAAsC;AAGtC,6CAA2B;AAG3B,6DAA2C"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,+EAA+E;AAC/E,sBAAsB;AACtB,+EAA+E;AAC/E,yEAAyE;AACzE,wEAAwE;;;;;;;;;;;;;;;;;AAExE;;;GAGG;AACH,0DAAwC;AAExC;;;GAGG;AACH,yDAAuC;AAEvC;;;GAGG;AACH,iEAA+C;AAE/C;;;GAGG;AACH,wEAAsD;AAEtD;;;GAGG;AACH,wEAAsD;AAEtD;;;GAGG;AACH,iEAA+C;AAE/C;;;;;;GAMG;AACH,oEAAiE;AAAxD,sHAAA,gBAAgB,OAAA;AAEzB;;GAEG;AACH,wDAAsD;AAA7C,2GAAA,WAAW,OAAA;AAEpB,+EAA+E;AAC/E,mCAAmC;AACnC,+EAA+E;AAC/E,6EAA6E;AAC7E,wEAAwE;AACxE,EAAE;AACF,2EAA2E;AAC3E,2EAA2E;AAC3E,qEAAqE;AAErE,+EAA+E;AAC/E,iEAAiE;AACjE,+EAA+E;AAC/E,4DAA4D;AAC5D,wCAAsB;AAEtB,8BAA8B;AAC9B,gEAAyF;AAAhF,iHAAA,cAAc,OAAA;AAAE,4HAAA,yBAAyB,OAAA;AAClD,6DAAyD;AAAhD,iHAAA,aAAa,OAAA;AACtB,iFAAwE;AAA/D,gIAAA,kBAAkB,OAAA;AAC3B,2DAA8G;AAArG,4GAAA,SAAS,OAAA;AAA0C,mHAAA,gBAAgB,OAAA;AAE5E,yDAAyD;AACzD,+CAA6B;AAI7B,mCAAmC;AACnC,mEAA2G;AAAlG,sHAAA,gBAAgB,OAAA;AAIzB,mDAAmD;AACnD,6CAA2B;AAE3B,UAAU;AACV,4CAA0B;AAE1B,oCAAoC;AACpC,8CAA4B;AAE5B,YAAY;AACZ,0CAAwB;AAExB,aAAa;AACb,kEAAgD;AAEhD,+EAA+E;AAC/E,kDAAkD;AAClD,+EAA+E;AAE/E,YAAY;AACZ,8CAA4B;AAE5B,sBAAsB;AACtB,wDAAsC;AAEtC,WAAW;AACX,6CAA2B;AAE3B,oBAAoB;AACpB,6DAA2C"}

package/dist/interfaces/client-info.interface.d.ts

@@ -1,16 +1,74 @@
+/**
+ * Client information extracted from HTTP request
+ *
+ * This interface represents metadata about the client making the request,
+ * automatically extracted by nauth-toolkit interceptors.
+ */
 export interface ClientInfo {
+    /**
+     * Client IP address (extracted from X-Forwarded-For, CF-Connecting-IP, etc.)
+     * Automatically handles proxies and load balancers
+     */
     ipAddress: string;
+    /**
+     * User agent string from the request
+     */
     userAgent: string;
+    /**
+     * Device token for trusted device feature
+     *
+     * Extracted from:
+     * - Cookie: `nauth_device_token` (web - httpOnly cookie)
+     * - Header: `X-Device-Token` (mobile - from secure storage)
+     *
+     * This token is server-generated and stored securely by clients.
+     * Used to identify trusted devices for MFA bypass.
+     */
     deviceToken?: string;
+    /**
+     * Optional device name (if provided by client)
+     */
     deviceName?: string;
+    /**
+     * Optional device type (if provided by client)
+     */
     deviceType?: 'mobile' | 'desktop' | 'tablet';
+    /**
+     * Optional IP country (from geolocation, if available)
+     */
     ipCountry?: string;
+    /**
+     * Optional IP city (from geolocation, if available)
+     */
     ipCity?: string;
+    /**
+     * Optional IP latitude (from geolocation, if available)
+     * Used for impossible travel detection
+     */
     ipLatitude?: number;
+    /**
+     * Optional IP longitude (from geolocation, if available)
+     * Used for impossible travel detection
+     */
     ipLongitude?: number;
+    /**
+     * Platform extracted from user agent (e.g., "iOS", "Android", "Windows", "macOS")
+     */
     platform?: string;
+    /**
+     * Browser extracted from user agent (e.g., "Chrome", "Safari", "Firefox")
+     */
     browser?: string;
+    /**
+     * Current session ID (if available from authenticated request)
+     * Extracted from JWT token payload after authentication
+     */
     sessionId?: number;
+    /**
+     * Current user ID (if available from authenticated request)
+     * Extracted from JWT token payload (sub claim) after authentication
+     * Used to identify who performed an action (e.g., for audit trails)
+     */
     userId?: number;
 }
 //# sourceMappingURL=client-info.interface.d.ts.map

package/dist/interfaces/client-info.interface.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client-info.interface.d.ts","sourceRoot":"","sources":["../../src/interfaces/client-info.interface.ts"],"names":[],"mappings":"AAMA,MAAM,WAAW,UAAU;IAKzB,SAAS,EAAE,MAAM,CAAC;IAKlB,SAAS,EAAE,MAAM,CAAC;IAYlB,WAAW,CAAC,EAAE,MAAM,CAAC;IAKrB,UAAU,CAAC,EAAE,MAAM,CAAC;IAKpB,UAAU,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;IAK7C,SAAS,CAAC,EAAE,MAAM,CAAC;IAKnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAMhB,UAAU,CAAC,EAAE,MAAM,CAAC;IAMpB,WAAW,CAAC,EAAE,MAAM,CAAC;IAKrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAKlB,OAAO,CAAC,EAAE,MAAM,CAAC;IAMjB,SAAS,CAAC,EAAE,MAAM,CAAC;IAOnB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}
+{"version":3,"file":"client-info.interface.d.ts","sourceRoot":"","sources":["../../src/interfaces/client-info.interface.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,WAAW,UAAU;IACzB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;;;;;OASG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;IAE7C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}