@nest-boot/auth 7.9.2 → 7.9.4

package/dist/auth.transaction-context.d.ts

@@ -1,11 +1,30 @@
-type LowercaseLetter = "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z";
-type ValidChar = LowercaseLetter | "_";
-type IsValidSnakeCase<S extends string> = S extends `${infer First}${infer Rest}` ? First extends ValidChar ? IsValidSnakeCase<Rest> : false : true;
-type SnakeCase<S extends string> = S extends "" ? never : S extends `_${string}` | `${string}_` ? never : S extends `${string}__${string}` ? never : IsValidSnakeCase<S> extends true ? S : never;
+/** Union of all lowercase letter characters (a–z). */
+export type LowercaseLetter = "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z";
+/** Characters allowed in snake_case identifiers (lowercase letters and underscore). */
+export type ValidChar = LowercaseLetter | "_";
+/** Recursively validates that a string contains only valid snake_case characters. */
+export type IsValidSnakeCase<S extends string> = S extends `${infer First}${infer Rest}` ? First extends ValidChar ? IsValidSnakeCase<Rest> : false : true;
+/** Ensures a string literal is a valid snake_case identifier. */
+export type SnakeCase<S extends string> = S extends "" ? never : S extends `_${string}` | `${string}_` ? never : S extends `${string}__${string}` ? never : IsValidSnakeCase<S> extends true ? S : never;
+/**
+ * Stores key-value pairs for PostgreSQL transaction-level auth context.
+ *
+ * @remarks
+ * Values set here are emitted as `set_config('auth.<key>', '<value>', true)` SQL
+ * statements, enabling row-level security policies to access auth state.
+ */
 export declare class AuthTransactionContext {
+    /** Internal storage for transaction context key-value pairs. @internal */
     private readonly ctx;
+    /**
+     * Sets a snake_case key-value pair in the transaction context.
+     * @param key - Must be a valid snake_case string
+     * @param value - The string value to associate with the key
+     * @returns This instance for chaining
+     */
     set<S extends string>(key: SnakeCase<S>, value: string): this;
+    /** Returns all stored key-value pairs as an array of `[key, value]` tuples. */
     entries(): [string, string][];
+    /** Generates a SQL statement that sets all stored values as PostgreSQL transaction-local config variables. */
     toSQL(): string;
 }
-export {};

package/dist/auth.transaction-context.js

@@ -1,10 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AuthTransactionContext = void 0;
+/**
+ * Stores key-value pairs for PostgreSQL transaction-level auth context.
+ *
+ * @remarks
+ * Values set here are emitted as `set_config('auth.<key>', '<value>', true)` SQL
+ * statements, enabling row-level security policies to access auth state.
+ */
 class AuthTransactionContext {
     constructor() {
+        /** Internal storage for transaction context key-value pairs. @internal */
         this.ctx = new Map();
     }
+    /**
+     * Sets a snake_case key-value pair in the transaction context.
+     * @param key - Must be a valid snake_case string
+     * @param value - The string value to associate with the key
+     * @returns This instance for chaining
+     */
     set(key, value) {
         if (!/^[a-z]+(_[a-z]+)*$/.test(key)) {
             throw new Error(`Key must only contain lowercase letters and underscores, cannot start/end with underscore, and cannot have consecutive underscores: ${key}`);
@@ -12,9 +26,11 @@ class AuthTransactionContext {
         this.ctx.set(key, value);
         return this;
     }
+    /** Returns all stored key-value pairs as an array of `[key, value]` tuples. */
     entries() {
         return Array.from(this.ctx.entries());
     }
+    /** Generates a SQL statement that sets all stored values as PostgreSQL transaction-local config variables. */
     toSQL() {
         return /* SQL */ `SELECT ${Array.from(this.ctx.entries())
             .map(([key, value]) => {

package/dist/auth.transaction-context.js.map

@@ -1 +1 @@
-{"version":3,"file":"auth.transaction-context.js","sourceRoot":"","sources":["../src/auth.transaction-context.ts"],"names":[],"mappings":";;;AA+CA,MAAa,sBAAsB;IAAnC;QACmB,QAAG,GAAG,IAAI,GAAG,EAAkB,CAAC;IAwBnD,CAAC;IAtBC,GAAG,CAAmB,GAAiB,EAAE,KAAa;QACpD,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;YACpC,MAAM,IAAI,KAAK,CACb,uIAAuI,GAAG,EAAE,CAC7I,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO;QACL,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;IACxC,CAAC;IAED,KAAK;QACH,OAAO,SAAS,CAAC,UAAU,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;aACtD,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YACpB,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAC/C,OAAO,SAAS,CAAC,oBAAoB,GAAG,OAAO,YAAY,UAAU,CAAC;QACxE,CAAC,CAAC;aACD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;IAClB,CAAC;CACF;AAzBD,wDAyBC"}
+{"version":3,"file":"auth.transaction-context.js","sourceRoot":"","sources":["../src/auth.transaction-context.ts"],"names":[],"mappings":";;;AAmDA;;;;;;GAMG;AACH,MAAa,sBAAsB;IAAnC;QACE,0EAA0E;QACzD,QAAG,GAAG,IAAI,GAAG,EAAkB,CAAC;IAgCnD,CAAC;IA9BC;;;;;OAKG;IACH,GAAG,CAAmB,GAAiB,EAAE,KAAa;QACpD,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;YACpC,MAAM,IAAI,KAAK,CACb,uIAAuI,GAAG,EAAE,CAC7I,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,+EAA+E;IAC/E,OAAO;QACL,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;IACxC,CAAC;IAED,8GAA8G;IAC9G,KAAK;QACH,OAAO,SAAS,CAAC,UAAU,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;aACtD,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YACpB,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAC/C,OAAO,SAAS,CAAC,oBAAoB,GAAG,OAAO,YAAY,UAAU,CAAC;QACxE,CAAC,CAAC;aACD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;IAClB,CAAC;CACF;AAlCD,wDAkCC"}

package/dist/decorators/current-session.decorator.d.ts

@@ -1 +1,2 @@
+/** Parameter decorator that injects the current {@link BaseSession} from the request context. */
 export declare const CurrentSession: (...dataOrPipes: any[]) => ParameterDecorator;

package/dist/decorators/current-session.decorator.js

@@ -4,5 +4,6 @@ exports.CurrentSession = void 0;
 const request_context_1 = require("@nest-boot/request-context");
 const common_1 = require("@nestjs/common");
 const session_entity_1 = require("../entities/session.entity");
+/** Parameter decorator that injects the current {@link BaseSession} from the request context. */
 exports.CurrentSession = (0, common_1.createParamDecorator)(() => request_context_1.RequestContext.get(session_entity_1.BaseSession));
 //# sourceMappingURL=current-session.decorator.js.map

package/dist/decorators/current-session.decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"current-session.decorator.js","sourceRoot":"","sources":["../../src/decorators/current-session.decorator.ts"],"names":[],"mappings":";;;AAAA,gEAA4D;AAC5D,2CAAsD;AAEtD,+DAAyD;AAE5C,QAAA,cAAc,GAAG,IAAA,6BAAoB,EAAC,GAAG,EAAE,CACtD,gCAAc,CAAC,GAAG,CAAC,4BAAW,CAAC,CAChC,CAAC"}
+{"version":3,"file":"current-session.decorator.js","sourceRoot":"","sources":["../../src/decorators/current-session.decorator.ts"],"names":[],"mappings":";;;AAAA,gEAA4D;AAC5D,2CAAsD;AAEtD,+DAAyD;AAEzD,iGAAiG;AACpF,QAAA,cAAc,GAAG,IAAA,6BAAoB,EAAC,GAAG,EAAE,CACtD,gCAAc,CAAC,GAAG,CAAC,4BAAW,CAAC,CAChC,CAAC"}

package/dist/decorators/current-user.decorator.d.ts

@@ -1 +1,2 @@
+/** Parameter decorator that injects the current {@link BaseUser} from the request context. */
 export declare const CurrentUser: (...dataOrPipes: any[]) => ParameterDecorator;

package/dist/decorators/current-user.decorator.js

@@ -4,5 +4,6 @@ exports.CurrentUser = void 0;
 const request_context_1 = require("@nest-boot/request-context");
 const common_1 = require("@nestjs/common");
 const user_entity_1 = require("../entities/user.entity");
+/** Parameter decorator that injects the current {@link BaseUser} from the request context. */
 exports.CurrentUser = (0, common_1.createParamDecorator)(() => request_context_1.RequestContext.get(user_entity_1.BaseUser));
 //# sourceMappingURL=current-user.decorator.js.map

package/dist/decorators/current-user.decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"current-user.decorator.js","sourceRoot":"","sources":["../../src/decorators/current-user.decorator.ts"],"names":[],"mappings":";;;AAAA,gEAA4D;AAC5D,2CAAsD;AAEtD,yDAAmD;AAEtC,QAAA,WAAW,GAAG,IAAA,6BAAoB,EAAC,GAAG,EAAE,CACnD,gCAAc,CAAC,GAAG,CAAC,sBAAQ,CAAC,CAC7B,CAAC"}
+{"version":3,"file":"current-user.decorator.js","sourceRoot":"","sources":["../../src/decorators/current-user.decorator.ts"],"names":[],"mappings":";;;AAAA,gEAA4D;AAC5D,2CAAsD;AAEtD,yDAAmD;AAEnD,8FAA8F;AACjF,QAAA,WAAW,GAAG,IAAA,6BAAoB,EAAC,GAAG,EAAE,CACnD,gCAAc,CAAC,GAAG,CAAC,sBAAQ,CAAC,CAC7B,CAAC"}

package/dist/decorators/public.decorator.d.ts

@@ -1,2 +1,3 @@
 import { IS_PUBLIC_KEY } from "../auth.constants";
+/** Decorator that marks a route as public, bypassing the {@link AuthGuard}. */
 export declare const Public: (value?: boolean) => import("@nestjs/common").CustomDecorator<typeof IS_PUBLIC_KEY>;

package/dist/decorators/public.decorator.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Public = void 0;
 const common_1 = require("@nestjs/common");
 const auth_constants_1 = require("../auth.constants");
+/** Decorator that marks a route as public, bypassing the {@link AuthGuard}. */
 const Public = (value = true) => (0, common_1.SetMetadata)(auth_constants_1.IS_PUBLIC_KEY, value);
 exports.Public = Public;
 //# sourceMappingURL=public.decorator.js.map

package/dist/decorators/public.decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"public.decorator.js","sourceRoot":"","sources":["../../src/decorators/public.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAA6C;AAE7C,sDAAkD;AAE3C,MAAM,MAAM,GAAG,CAAC,KAAK,GAAG,IAAI,EAAE,EAAE,CAAC,IAAA,oBAAW,EAAC,8BAAa,EAAE,KAAK,CAAC,CAAC;AAA7D,QAAA,MAAM,UAAuD"}
+{"version":3,"file":"public.decorator.js","sourceRoot":"","sources":["../../src/decorators/public.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAA6C;AAE7C,sDAAkD;AAElD,+EAA+E;AACxE,MAAM,MAAM,GAAG,CAAC,KAAK,GAAG,IAAI,EAAE,EAAE,CAAC,IAAA,oBAAW,EAAC,8BAAa,EAAE,KAAK,CAAC,CAAC;AAA7D,QAAA,MAAM,UAAuD"}

package/dist/entities/account.entity.d.ts

@@ -1,16 +1,36 @@
 import { BaseEntity, Opt } from "@mikro-orm/core";
+/**
+ * Abstract base entity for OAuth/credential account records.
+ *
+ * @remarks
+ * Maps to the better-auth `account` model. Each account links a provider
+ * (e.g. Google, GitHub, credentials) to a {@link BaseUser}.
+ */
 export declare abstract class BaseAccount extends BaseEntity {
+    /** Primary key (UUID v4, auto-generated). */
     id: Opt<string>;
+    /** Provider-scoped account identifier. */
     accountId: string;
+    /** Authentication provider identifier (e.g. `"google"`, `"credential"`). */
     providerId: string;
+    /** Foreign key referencing the owning {@link BaseUser}. */
     userId: string;
+    /** OAuth access token, if available. */
     accessToken?: Opt<string>;
+    /** OAuth refresh token, if available. */
     refreshToken?: Opt<string>;
+    /** OpenID Connect ID token, if available. */
     idToken?: Opt<string>;
+    /** Expiration timestamp of the access token. */
     accessTokenExpiresAt?: Opt<Date>;
+    /** Expiration timestamp of the refresh token. */
     refreshTokenExpiresAt?: Opt<Date>;
+    /** OAuth scopes granted to this account. */
     scope?: Opt<string>;
+    /** Hashed password for credential-based accounts. */
     password?: Opt<string>;
+    /** Timestamp when the account was created. */
     createdAt: Opt<Date>;
+    /** Timestamp of the last update. */
     updatedAt: Opt<Date>;
 }

package/dist/entities/account.entity.js

@@ -12,11 +12,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseAccount = void 0;
 const core_1 = require("@mikro-orm/core");
 const crypto_1 = require("crypto");
+/**
+ * Abstract base entity for OAuth/credential account records.
+ *
+ * @remarks
+ * Maps to the better-auth `account` model. Each account links a provider
+ * (e.g. Google, GitHub, credentials) to a {@link BaseUser}.
+ */
 let BaseAccount = class BaseAccount extends core_1.BaseEntity {
     constructor() {
         super(...arguments);
+        /** Primary key (UUID v4, auto-generated). */
         this.id = (0, crypto_1.randomUUID)();
+        /** Timestamp when the account was created. */
         this.createdAt = new Date();
+        /** Timestamp of the last update. */
         this.updatedAt = new Date();
     }
 };

package/dist/entities/account.entity.js.map

@@ -1 +1 @@
-{"version":3,"file":"account.entity.js","sourceRoot":"","sources":["../../src/entities/account.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,0CASyB;AACzB,mCAAoC;AAG7B,IAAe,WAAW,GAA1B,MAAe,WAAY,SAAQ,iBAAU;IAA7C;;QAEL,OAAE,GAAgB,IAAA,mBAAU,GAAE,CAAC;QAqC/B,cAAS,GAAc,IAAI,IAAI,EAAE,CAAC;QAOlC,cAAS,GAAc,IAAI,IAAI,EAAE,CAAC;IACpC,CAAC;CAAA,CAAA;AA/CqB,kCAAW;AAE/B;IADC,IAAA,iBAAU,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,CAAC;;uCACE;AAG/B;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,CAAC;;8CACR;AAGnB;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,CAAC;;+CACP;AAOpB;IALC,IAAA,gBAAS,EAAC,GAAG,EAAE,CAAC,MAAM,EAAE;QACvB,SAAS,EAAE,SAAS;QACpB,OAAO,EAAE,IAAI;QACb,OAAO,EAAE,CAAC,cAAO,CAAC,MAAM,CAAC;KAC1B,CAAC;;2CACc;AAGhB;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;gDACjB;AAG1B;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;iDAChB;AAG3B;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;4CACrB;AAGtB;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;yDACd;AAGjC;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;0DACb;AAGlC;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;0CACvB;AAGpB;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;6CACpB;AAGvB;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC;;8CAClB;AAOlC;IALC,IAAA,eAAQ,EAAC;QACR,IAAI,EAAE,QAAC,CAAC,QAAQ;QAChB,UAAU,EAAE,OAAO;QACnB,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE;KAC3B,CAAC;;8CACgC;sBA9Cd,WAAW;IADhC,IAAA,aAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;GACL,WAAW,CA+ChC"}
+{"version":3,"file":"account.entity.js","sourceRoot":"","sources":["../../src/entities/account.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,0CASyB;AACzB,mCAAoC;AAEpC;;;;;;GAMG;AAEI,IAAe,WAAW,GAA1B,MAAe,WAAY,SAAQ,iBAAU;IAA7C;;QACL,6CAA6C;QAE7C,OAAE,GAAgB,IAAA,mBAAU,GAAE,CAAC;QA8C/B,8CAA8C;QAE9C,cAAS,GAAc,IAAI,IAAI,EAAE,CAAC;QAElC,oCAAoC;QAMpC,cAAS,GAAc,IAAI,IAAI,EAAE,CAAC;IACpC,CAAC;CAAA,CAAA;AA5DqB,kCAAW;AAG/B;IADC,IAAA,iBAAU,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,CAAC;;uCACE;AAI/B;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,CAAC;;8CACR;AAInB;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,CAAC;;+CACP;AAQpB;IALC,IAAA,gBAAS,EAAC,GAAG,EAAE,CAAC,MAAM,EAAE;QACvB,SAAS,EAAE,SAAS;QACpB,OAAO,EAAE,IAAI;QACb,OAAO,EAAE,CAAC,cAAO,CAAC,MAAM,CAAC;KAC1B,CAAC;;2CACc;AAIhB;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;gDACjB;AAI1B;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;iDAChB;AAI3B;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;4CACrB;AAItB;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;yDACd;AAIjC;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;0DACb;AAIlC;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;0CACvB;AAIpB;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;6CACpB;AAIvB;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC;;8CAClB;AAQlC;IALC,IAAA,eAAQ,EAAC;QACR,IAAI,EAAE,QAAC,CAAC,QAAQ;QAChB,UAAU,EAAE,OAAO;QACnB,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE;KAC3B,CAAC;;8CACgC;sBA3Dd,WAAW;IADhC,IAAA,aAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;GACL,WAAW,CA4DhC"}

package/dist/entities/session.entity.d.ts

@@ -1,11 +1,26 @@
 import { BaseEntity, Opt } from "@mikro-orm/core";
+/**
+ * Abstract base entity for user session records.
+ *
+ * @remarks
+ * Maps to the better-auth `session` model. Each session is tied to a
+ * {@link BaseUser} and identified by a unique token.
+ */
 export declare class BaseSession extends BaseEntity {
+    /** Primary key (UUID v4, auto-generated). */
     id: Opt<string>;
+    /** Unique session token used for authentication. */
     token: string;
+    /** Foreign key referencing the owning {@link BaseUser}. */
     userId: string;
+    /** Timestamp when the session expires. */
     expiresAt: Date;
+    /** IP address of the client that created or last used this session. */
     ipAddress?: Opt<string>;
+    /** User-Agent header from the client that created or last used this session. */
     userAgent?: Opt<string>;
+    /** Timestamp when the session was created. */
     createdAt: Opt<Date>;
+    /** Timestamp of the last update. */
     updatedAt: Opt<Date>;
 }

package/dist/entities/session.entity.js

@@ -12,11 +12,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseSession = void 0;
 const core_1 = require("@mikro-orm/core");
 const crypto_1 = require("crypto");
+/**
+ * Abstract base entity for user session records.
+ *
+ * @remarks
+ * Maps to the better-auth `session` model. Each session is tied to a
+ * {@link BaseUser} and identified by a unique token.
+ */
 let BaseSession = class BaseSession extends core_1.BaseEntity {
     constructor() {
         super(...arguments);
+        /** Primary key (UUID v4, auto-generated). */
         this.id = (0, crypto_1.randomUUID)();
+        /** Timestamp when the session was created. */
         this.createdAt = new Date();
+        /** Timestamp of the last update. */
         this.updatedAt = new Date();
     }
 };

package/dist/entities/session.entity.js.map

@@ -1 +1 @@
-{"version":3,"file":"session.entity.js","sourceRoot":"","sources":["../../src/entities/session.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,0CAUyB;AACzB,mCAAoC;AAG7B,IAAM,WAAW,GAAjB,MAAM,WAAY,SAAQ,iBAAU;IAApC;;QAEL,OAAE,GAAgB,IAAA,mBAAU,GAAE,CAAC;QAuB/B,cAAS,GAAc,IAAI,IAAI,EAAE,CAAC;QAOlC,cAAS,GAAc,IAAI,IAAI,EAAE,CAAC;IACpC,CAAC;CAAA,CAAA;AAjCY,kCAAW;AAEtB;IADC,IAAA,iBAAU,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,CAAC;;uCACE;AAI/B;IAFC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,CAAC;IAC1B,IAAA,aAAM,GAAE;;0CACM;AAOf;IALC,IAAA,gBAAS,EAAC,GAAG,EAAE,CAAC,MAAM,EAAE;QACvB,SAAS,EAAE,SAAS;QACpB,OAAO,EAAE,IAAI;QACb,OAAO,EAAE,CAAC,cAAO,CAAC,MAAM,CAAC;KAC1B,CAAC;;2CACc;AAGhB;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,QAAQ,EAAE,CAAC;8BACnB,IAAI;8CAAC;AAGjB;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;8CACnB;AAGxB;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;8CACnB;AAGxB;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC;;8CAClB;AAOlC;IALC,IAAA,eAAQ,EAAC;QACR,IAAI,EAAE,QAAC,CAAC,QAAQ;QAChB,UAAU,EAAE,OAAO;QACnB,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE;KAC3B,CAAC;;8CACgC;sBAhCvB,WAAW;IADvB,IAAA,aAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;GACd,WAAW,CAiCvB"}
+{"version":3,"file":"session.entity.js","sourceRoot":"","sources":["../../src/entities/session.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,0CAUyB;AACzB,mCAAoC;AAEpC;;;;;;GAMG;AAEI,IAAM,WAAW,GAAjB,MAAM,WAAY,SAAQ,iBAAU;IAApC;;QACL,6CAA6C;QAE7C,OAAE,GAAgB,IAAA,mBAAU,GAAE,CAAC;QA2B/B,8CAA8C;QAE9C,cAAS,GAAc,IAAI,IAAI,EAAE,CAAC;QAElC,oCAAoC;QAMpC,cAAS,GAAc,IAAI,IAAI,EAAE,CAAC;IACpC,CAAC;CAAA,CAAA;AAzCY,kCAAW;AAGtB;IADC,IAAA,iBAAU,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,CAAC;;uCACE;AAK/B;IAFC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,CAAC;IAC1B,IAAA,aAAM,GAAE;;0CACM;AAQf;IALC,IAAA,gBAAS,EAAC,GAAG,EAAE,CAAC,MAAM,EAAE;QACvB,SAAS,EAAE,SAAS;QACpB,OAAO,EAAE,IAAI;QACb,OAAO,EAAE,CAAC,cAAO,CAAC,MAAM,CAAC;KAC1B,CAAC;;2CACc;AAIhB;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,QAAQ,EAAE,CAAC;8BACnB,IAAI;8CAAC;AAIjB;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;8CACnB;AAIxB;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;8CACnB;AAIxB;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC;;8CAClB;AAQlC;IALC,IAAA,eAAQ,EAAC;QACR,IAAI,EAAE,QAAC,CAAC,QAAQ;QAChB,UAAU,EAAE,OAAO;QACnB,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE;KAC3B,CAAC;;8CACgC;sBAxCvB,WAAW;IADvB,IAAA,aAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;GACd,WAAW,CAyCvB"}

package/dist/entities/user.entity.d.ts

@@ -1,10 +1,24 @@
 import { BaseEntity, Opt } from "@mikro-orm/core";
+/**
+ * Abstract base entity for user records.
+ *
+ * @remarks
+ * Maps to the better-auth `user` model. Provides core identity fields
+ * such as name, email, and avatar, intended to be extended by the application.
+ */
 export declare class BaseUser extends BaseEntity {
+    /** Primary key (UUID v4, auto-generated). */
     id: Opt<string>;
+    /** Display name of the user. */
     name: string;
+    /** Unique email address of the user. */
     email: string;
+    /** Whether the email address has been verified. */
     emailVerified: boolean;
+    /** URL of the user's avatar image. */
     image?: Opt<string>;
+    /** Timestamp when the user was created. */
     createdAt: Opt<Date>;
+    /** Timestamp of the last update. */
     updatedAt: Opt<Date>;
 }

package/dist/entities/user.entity.js

@@ -12,11 +12,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseUser = void 0;
 const core_1 = require("@mikro-orm/core");
 const crypto_1 = require("crypto");
+/**
+ * Abstract base entity for user records.
+ *
+ * @remarks
+ * Maps to the better-auth `user` model. Provides core identity fields
+ * such as name, email, and avatar, intended to be extended by the application.
+ */
 let BaseUser = class BaseUser extends core_1.BaseEntity {
     constructor() {
         super(...arguments);
+        /** Primary key (UUID v4, auto-generated). */
         this.id = (0, crypto_1.randomUUID)();
+        /** Timestamp when the user was created. */
         this.createdAt = new Date();
+        /** Timestamp of the last update. */
         this.updatedAt = new Date();
     }
 };

package/dist/entities/user.entity.js.map

@@ -1 +1 @@
-{"version":3,"file":"user.entity.js","sourceRoot":"","sources":["../../src/entities/user.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,0CAQyB;AACzB,mCAAoC;AAG7B,IAAM,QAAQ,GAAd,MAAM,QAAS,SAAQ,iBAAU;IAAjC;;QAEL,OAAE,GAAgB,IAAA,mBAAU,GAAE,CAAC;QAgB/B,cAAS,GAAc,IAAI,IAAI,EAAE,CAAC;QAOlC,cAAS,GAAc,IAAI,IAAI,EAAE,CAAC;IACpC,CAAC;CAAA,CAAA;AA1BY,4BAAQ;AAEnB;IADC,IAAA,iBAAU,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,CAAC;;oCACE;AAG/B;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,CAAC;;sCACb;AAId;IAFC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,CAAC;IAC1B,IAAA,aAAM,GAAE;;uCACM;AAGf;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;;+CACtB;AAGxB;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;uCACvB;AAGpB;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC;;2CAClB;AAOlC;IALC,IAAA,eAAQ,EAAC;QACR,IAAI,EAAE,QAAC,CAAC,QAAQ;QAChB,UAAU,EAAE,OAAO;QACnB,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE;KAC3B,CAAC;;2CACgC;mBAzBvB,QAAQ;IADpB,IAAA,aAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;GACd,QAAQ,CA0BpB"}
+{"version":3,"file":"user.entity.js","sourceRoot":"","sources":["../../src/entities/user.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,0CAQyB;AACzB,mCAAoC;AAEpC;;;;;;GAMG;AAEI,IAAM,QAAQ,GAAd,MAAM,QAAS,SAAQ,iBAAU;IAAjC;;QACL,6CAA6C;QAE7C,OAAE,GAAgB,IAAA,mBAAU,GAAE,CAAC;QAmB/B,2CAA2C;QAE3C,cAAS,GAAc,IAAI,IAAI,EAAE,CAAC;QAElC,oCAAoC;QAMpC,cAAS,GAAc,IAAI,IAAI,EAAE,CAAC;IACpC,CAAC;CAAA,CAAA;AAjCY,4BAAQ;AAGnB;IADC,IAAA,iBAAU,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,CAAC;;oCACE;AAI/B;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,CAAC;;sCACb;AAKd;IAFC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,CAAC;IAC1B,IAAA,aAAM,GAAE;;uCACM;AAIf;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;;+CACtB;AAIxB;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;uCACvB;AAIpB;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC;;2CAClB;AAQlC;IALC,IAAA,eAAQ,EAAC;QACR,IAAI,EAAE,QAAC,CAAC,QAAQ;QAChB,UAAU,EAAE,OAAO;QACnB,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE;KAC3B,CAAC;;2CACgC;mBAhCvB,QAAQ;IADpB,IAAA,aAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;GACd,QAAQ,CAiCpB"}

package/dist/entities/verification.entity.d.ts

@@ -1,9 +1,22 @@
 import { BaseEntity, Opt } from "@mikro-orm/core";
+/**
+ * Abstract base entity for verification records.
+ *
+ * @remarks
+ * Used for email verification tokens, password reset tokens, and similar
+ * time-limited verification flows managed by better-auth.
+ */
 export declare abstract class BaseVerification extends BaseEntity {
+    /** Primary key (UUID v4, auto-generated). */
     id: Opt<string>;
+    /** Identifier associated with this verification (e.g. email address). */
     identifier: string;
+    /** Verification token value. */
     value: string;
+    /** Timestamp when this verification expires. */
     expiresAt: Date;
+    /** Timestamp when the verification was created. */
     createdAt: Opt<Date>;
+    /** Timestamp of the last update. */
     updatedAt: Opt<Date>;
 }

package/dist/entities/verification.entity.js

@@ -12,11 +12,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseVerification = void 0;
 const core_1 = require("@mikro-orm/core");
 const crypto_1 = require("crypto");
+/**
+ * Abstract base entity for verification records.
+ *
+ * @remarks
+ * Used for email verification tokens, password reset tokens, and similar
+ * time-limited verification flows managed by better-auth.
+ */
 let BaseVerification = class BaseVerification extends core_1.BaseEntity {
     constructor() {
         super(...arguments);
+        /** Primary key (UUID v4, auto-generated). */
         this.id = (0, crypto_1.randomUUID)();
+        /** Timestamp when the verification was created. */
         this.createdAt = new Date();
+        /** Timestamp of the last update. */
         this.updatedAt = new Date();
     }
 };

package/dist/entities/verification.entity.js.map

@@ -1 +1 @@
-{"version":3,"file":"verification.entity.js","sourceRoot":"","sources":["../../src/entities/verification.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,0CAOyB;AACzB,mCAAoC;AAG7B,IAAe,gBAAgB,GAA/B,MAAe,gBAAiB,SAAQ,iBAAU;IAAlD;;QAEL,OAAE,GAAgB,IAAA,mBAAU,GAAE,CAAC;QAY/B,cAAS,GAAc,IAAI,IAAI,EAAE,CAAC;QAOlC,cAAS,GAAc,IAAI,IAAI,EAAE,CAAC;IACpC,CAAC;CAAA,CAAA;AAtBqB,4CAAgB;AAEpC;IADC,IAAA,iBAAU,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,CAAC;;4CACE;AAG/B;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,CAAC;;oDACP;AAGpB;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,CAAC;;+CACZ;AAGf;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,QAAQ,EAAE,CAAC;8BACnB,IAAI;mDAAC;AAGjB;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC;;mDAClB;AAOlC;IALC,IAAA,eAAQ,EAAC;QACR,IAAI,EAAE,QAAC,CAAC,QAAQ;QAChB,UAAU,EAAE,OAAO;QACnB,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE;KAC3B,CAAC;;mDACgC;2BArBd,gBAAgB;IADrC,IAAA,aAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;GACL,gBAAgB,CAsBrC"}
+{"version":3,"file":"verification.entity.js","sourceRoot":"","sources":["../../src/entities/verification.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,0CAOyB;AACzB,mCAAoC;AAEpC;;;;;;GAMG;AAEI,IAAe,gBAAgB,GAA/B,MAAe,gBAAiB,SAAQ,iBAAU;IAAlD;;QACL,6CAA6C;QAE7C,OAAE,GAAgB,IAAA,mBAAU,GAAE,CAAC;QAc/B,mDAAmD;QAEnD,cAAS,GAAc,IAAI,IAAI,EAAE,CAAC;QAElC,oCAAoC;QAMpC,cAAS,GAAc,IAAI,IAAI,EAAE,CAAC;IACpC,CAAC;CAAA,CAAA;AA5BqB,4CAAgB;AAGpC;IADC,IAAA,iBAAU,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,CAAC;;4CACE;AAI/B;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,CAAC;;oDACP;AAIpB;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,CAAC;;+CACZ;AAIf;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,QAAQ,EAAE,CAAC;8BACnB,IAAI;mDAAC;AAIjB;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC;;mDAClB;AAQlC;IALC,IAAA,eAAQ,EAAC;QACR,IAAI,EAAE,QAAC,CAAC,QAAQ;QAChB,UAAU,EAAE,OAAO;QACnB,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE;KAC3B,CAAC;;mDACgC;2BA3Bd,gBAAgB;IADrC,IAAA,aAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;GACL,gBAAgB,CA4BrC"}