ideal-auth 0.6.0 → 0.6.1

package/dist/auth-instance.d.ts

@@ -7,7 +7,7 @@ interface AuthInstanceDeps<TUser extends AnyUser> {
     rememberMaxAge: number;
     cookieOptions: ConfigurableCookieOptions;
     resolveUser?: (id: string) => Promise<TUser | null | undefined>;
-    sessionFields?: (keyof TUser & string)[];
+    sessionFields?: readonly (keyof TUser & string)[];
     hash?: HashInstance;
     resolveUserByCredentials?: (credentials: Record<string, any>) => Promise<AnyUser | null | undefined>;
     credentialKey: string;

package/dist/auth.d.ts

@@ -1,5 +1,13 @@
-import type { AnyUser, AuthInstance, AuthConfigWithResolveUser, AuthConfigWithSessionFields } from './types';
-/** Database-backed: `user()` returns `TUser` (the safe type from `resolveUser`). */
-export declare function createAuth<TUser extends AnyUser>(config: AuthConfigWithResolveUser<TUser>): () => AuthInstance<TUser>;
-/** Cookie-backed: `user()` returns only `id` + the declared `sessionFields`. */
-export declare function createAuth<TUser extends AnyUser, K extends keyof TUser & string>(config: AuthConfigWithSessionFields<TUser, K>): () => AuthInstance<TUser, Pick<TUser, 'id' | K>>;
+import type { AnyUser, AuthInstance, AuthConfig } from './types';
+/**
+ * Create an auth factory.
+ *
+ * @example
+ * // resolveUser — user() returns SafeUser
+ * createAuth<SafeUser>({ resolveUser: ... })
+ *
+ * // sessionFields — user() returns Pick<DbUser, 'id' | 'email' | 'name'>
+ * const sessionFields = ['email', 'name'] as const;
+ * createAuth<DbUser, (typeof sessionFields)[number]>({ sessionFields, ... })
+ */
+export declare function createAuth<TUser extends AnyUser, K extends keyof TUser & string = keyof TUser & string>(config: AuthConfig<TUser>): () => AuthInstance<TUser, Pick<TUser, 'id' | K>>;

package/dist/auth.js

@@ -4,6 +4,17 @@ const SESSION_DEFAULTS = {
     maxAge: 60 * 60 * 24 * 7, // 7 days
     rememberMaxAge: 60 * 60 * 24 * 30, // 30 days
 };
+/**
+ * Create an auth factory.
+ *
+ * @example
+ * // resolveUser — user() returns SafeUser
+ * createAuth<SafeUser>({ resolveUser: ... })
+ *
+ * // sessionFields — user() returns Pick<DbUser, 'id' | 'email' | 'name'>
+ * const sessionFields = ['email', 'name'] as const;
+ * createAuth<DbUser, (typeof sessionFields)[number]>({ sessionFields, ... })
+ */
 export function createAuth(config) {
     if (!config.secret || config.secret.length < 32) {
         throw new Error('secret must be at least 32 characters');

package/dist/types.d.ts

@@ -72,7 +72,7 @@ export interface AuthConfigWithResolveUser<TUser extends AnyUser> extends AuthCo
 export interface AuthConfigWithSessionFields<TUser extends AnyUser, K extends keyof TUser & string = keyof TUser & string> extends AuthConfigBase<TUser> {
     /** Cannot use `resolveUser` together with `sessionFields`. */
     resolveUser?: never;
-    sessionFields: K[];
+    sessionFields: readonly K[];
 }
 export type AuthConfig<TUser extends AnyUser = AnyUser> = AuthConfigWithResolveUser<TUser> | AuthConfigWithSessionFields<TUser>;
 export interface HashConfig {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ideal-auth",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "description": "Auth primitives for the JS ecosystem. Zero framework dependencies.",
   "scripts": {
     "build": "tsc",

package/skills/ideal-auth/SKILL.md

@@ -126,13 +126,17 @@ const user = await auth().user(); // Type: SafeUser | null
 
 **Cookie-backed (`sessionFields`):** Cookie stores user ID + declared fields. `user()` returns `Pick<TUser, 'id' | K>` — password excluded from the type.
 
+Define fields once as `const` and derive the type with `(typeof sessionFields)[number]`:
+
 ```typescript
 type DbUser = { id: string; email: string; name: string; role: string; password: string };
 
-const auth = createAuth<DbUser>({
+const sessionFields = ['email', 'name', 'role'] as const;
+
+const auth = createAuth<DbUser, (typeof sessionFields)[number]>({
   secret: process.env.IDEAL_AUTH_SECRET!,
   cookie: createCookieBridge(),
-  sessionFields: ['email', 'name', 'role'],
+  sessionFields,
   resolveUserByCredentials: async (creds) => db.user.findFirst({ where: { email: creds.email } }),
   hash,
 });