@molecule/app-auth 1.8.2 → 2.0.0

package/dist/utilities.d.ts

@@ -3,9 +3,16 @@
  *
  * These delegate to the bonded auth client retrieved via `getClient()`.
  *
+ * Every wrapper that hands back a profile takes the profile type as a type
+ * argument — `login<SessionUser>(…)`, `register<TExtra, SessionUser>(…)` — so an
+ * app that bonded a client with its own profile reads that profile from the
+ * result. Without it the default, `UserProfile`, applies: its `id: string` is
+ * the contract of the default configuration, not a value the client invents for
+ * a custom one.
+ *
  * @module
  */
-import type { AuthResult, LoginCredentials, RegisterData, RegisterExtraShape, UserProfile } from './types.js';
+import type { AuthProfileConstraint, AuthResult, LoginCredentials, RegisterData, RegisterExtraShape, UserProfile } from './types.js';
 /**
  * Checks if the current user is authenticated.
  *
@@ -14,16 +21,24 @@ import type { AuthResult, LoginCredentials, RegisterData, RegisterExtraShape, Us
 export declare const isAuthenticated: () => boolean;
 /**
  * Returns the current user profile, or `null` if not authenticated.
+ *
+ * @template T - The user profile the bonded client returns: a JSON object type
+ *   of named fields (see {@link AuthProfileConstraint}), including an app
+ *   profile with no `id`. Defaults to {@link UserProfile}; name it at the call.
  * @returns The user profile, or `null` if not authenticated.
  */
-export declare const getUser: <T extends UserProfile = UserProfile>() => T | null;
+export declare const getUser: <T extends AuthProfileConstraint<T> = UserProfile>() => T | null;
 /**
  * Logs in with the given credentials (email/username + password).
  *
+ * @template T - The user profile the bonded client returns. Pass the app's own
+ *   profile when the client was created with one
+ *   (`createJWTAuthClient<SessionUser>`), so `result.user` is typed for the
+ *   pages; defaults to {@link UserProfile}.
  * @param credentials - Email/username and password.
  * @returns The auth result containing tokens and user profile.
  */
-export declare const login: (credentials: LoginCredentials) => Promise<AuthResult>;
+export declare const login: <T extends AuthProfileConstraint<T> = UserProfile>(credentials: LoginCredentials) => Promise<AuthResult<T>>;
 /**
  * Logs out the current user, clearing tokens and session state.
  * @returns A promise that resolves when logout completes.
@@ -32,10 +47,17 @@ export declare const logout: () => Promise<void>;
 /**
  * Registers a new user account.
  *
+ * The registration extra fields stay the FIRST type argument, exactly as before
+ * (`register<{ username: string }>(data)` keeps compiling); the profile is the
+ * second one (`register<{ username: string }, SessionUser>(data)`).
+ *
  * @template TExtra - The app's own registration fields, at the top level
  *   (`{ username: string }` for a RealWorld-shaped API); defaults to none.
+ * @template T - The user profile the bonded client returns. Pass the app's own
+ *   profile when the client was created with one; defaults to
+ *   {@link UserProfile}.
  * @param data - Registration data (email, password, and any `TExtra` fields).
  * @returns The auth result containing tokens and user profile.
  */
-export declare const register: <TExtra extends RegisterExtraShape<TExtra> = Record<never, never>>(data: RegisterData<TExtra>) => Promise<AuthResult>;
+export declare const register: <TExtra extends RegisterExtraShape<TExtra> = Record<never, never>, T extends AuthProfileConstraint<T> = UserProfile>(data: RegisterData<TExtra>) => Promise<AuthResult<T>>;
 //# sourceMappingURL=utilities.d.ts.map

package/dist/utilities.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utilities.d.ts","sourceRoot":"","sources":["../src/utilities.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,KAAK,EACV,UAAU,EACV,gBAAgB,EAChB,YAAY,EACZ,kBAAkB,EAClB,WAAW,EACZ,MAAM,YAAY,CAAA;AAEnB;;;;GAIG;AACH,eAAO,MAAM,eAAe,QAAO,OAAwC,CAAA;AAE3E;;;GAGG;AACH,eAAO,MAAM,OAAO,GAAI,CAAC,SAAS,WAAW,GAAG,WAAW,OAAK,CAAC,GAAG,IAAgC,CAAA;AAEpG;;;;;GAKG;AACH,eAAO,MAAM,KAAK,GAAI,aAAa,gBAAgB,KAAG,OAAO,CAAC,UAAU,CACxC,CAAA;AAEhC;;;GAGG;AACH,eAAO,MAAM,MAAM,QAAO,OAAO,CAAC,IAAI,CAAyB,CAAA;AAE/D;;;;;;;GAOG;AACH,eAAO,MAAM,QAAQ,GAAI,MAAM,SAAS,kBAAkB,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,EACvF,MAAM,YAAY,CAAC,MAAM,CAAC,KACzB,OAAO,CAAC,UAAU,CAAoD,CAAA"}
+{"version":3,"file":"utilities.d.ts","sourceRoot":"","sources":["../src/utilities.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAGH,OAAO,KAAK,EACV,qBAAqB,EACrB,UAAU,EACV,gBAAgB,EAChB,YAAY,EACZ,kBAAkB,EAClB,WAAW,EACZ,MAAM,YAAY,CAAA;AAEnB;;;;GAIG;AACH,eAAO,MAAM,eAAe,QAAO,OAAwC,CAAA;AAE3E;;;;;;;GAOG;AACH,eAAO,MAAM,OAAO,GAAI,CAAC,SAAS,qBAAqB,CAAC,CAAC,CAAC,GAAG,WAAW,OAAK,CAAC,GAAG,IACvD,CAAA;AAE1B;;;;;;;;;GASG;AACH,eAAO,MAAM,KAAK,GAAU,CAAC,SAAS,qBAAqB,CAAC,CAAC,CAAC,GAAG,WAAW,EAC1E,aAAa,gBAAgB,KAC5B,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAsC,CAAA;AAE9D;;;GAGG;AACH,eAAO,MAAM,MAAM,QAAO,OAAO,CAAC,IAAI,CAAyB,CAAA;AAE/D;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,QAAQ,GACnB,MAAM,SAAS,kBAAkB,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,EAChE,CAAC,SAAS,qBAAqB,CAAC,CAAC,CAAC,GAAG,WAAW,EAEhD,MAAM,YAAY,CAAC,MAAM,CAAC,KACzB,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAA0C,CAAA"}

package/dist/utilities.js

@@ -3,6 +3,13 @@
  *
  * These delegate to the bonded auth client retrieved via `getClient()`.
  *
+ * Every wrapper that hands back a profile takes the profile type as a type
+ * argument — `login<SessionUser>(…)`, `register<TExtra, SessionUser>(…)` — so an
+ * app that bonded a client with its own profile reads that profile from the
+ * result. Without it the default, `UserProfile`, applies: its `id: string` is
+ * the contract of the default configuration, not a value the client invents for
+ * a custom one.
+ *
  * @module
  */
 import { getClient } from './provider.js';
@@ -14,16 +21,24 @@ import { getClient } from './provider.js';
 export const isAuthenticated = () => getClient().isAuthenticated();
 /**
  * Returns the current user profile, or `null` if not authenticated.
+ *
+ * @template T - The user profile the bonded client returns: a JSON object type
+ *   of named fields (see {@link AuthProfileConstraint}), including an app
+ *   profile with no `id`. Defaults to {@link UserProfile}; name it at the call.
  * @returns The user profile, or `null` if not authenticated.
  */
 export const getUser = () => getClient().getUser();
 /**
  * Logs in with the given credentials (email/username + password).
  *
+ * @template T - The user profile the bonded client returns. Pass the app's own
+ *   profile when the client was created with one
+ *   (`createJWTAuthClient<SessionUser>`), so `result.user` is typed for the
+ *   pages; defaults to {@link UserProfile}.
  * @param credentials - Email/username and password.
  * @returns The auth result containing tokens and user profile.
  */
-export const login = (credentials) => getClient().login(credentials);
+export const login = async (credentials) => getClient().login(credentials);
 /**
  * Logs out the current user, clearing tokens and session state.
  * @returns A promise that resolves when logout completes.
@@ -32,10 +47,17 @@ export const logout = () => getClient().logout();
 /**
  * Registers a new user account.
  *
+ * The registration extra fields stay the FIRST type argument, exactly as before
+ * (`register<{ username: string }>(data)` keeps compiling); the profile is the
+ * second one (`register<{ username: string }, SessionUser>(data)`).
+ *
  * @template TExtra - The app's own registration fields, at the top level
  *   (`{ username: string }` for a RealWorld-shaped API); defaults to none.
+ * @template T - The user profile the bonded client returns. Pass the app's own
+ *   profile when the client was created with one; defaults to
+ *   {@link UserProfile}.
  * @param data - Registration data (email, password, and any `TExtra` fields).
  * @returns The auth result containing tokens and user profile.
  */
-export const register = (data) => getClient().register(data);
+export const register = async (data) => getClient().register(data);
 //# sourceMappingURL=utilities.js.map

package/dist/utilities.js.map

@@ -1 +1 @@
-{"version":3,"file":"utilities.js","sourceRoot":"","sources":["../src/utilities.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AASzC;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,GAAY,EAAE,CAAC,SAAS,EAAE,CAAC,eAAe,EAAE,CAAA;AAE3E;;;GAGG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,GAAkD,EAAE,CAAC,SAAS,EAAK,CAAC,OAAO,EAAE,CAAA;AAEpG;;;;;GAKG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,WAA6B,EAAuB,EAAE,CAC1E,SAAS,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,CAAA;AAEhC;;;GAGG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,GAAkB,EAAE,CAAC,SAAS,EAAE,CAAC,MAAM,EAAE,CAAA;AAE/D;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CACtB,IAA0B,EACL,EAAE,CAAC,SAAS,EAAuB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA"}
+{"version":3,"file":"utilities.js","sourceRoot":"","sources":["../src/utilities.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAUzC;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,GAAY,EAAE,CAAC,SAAS,EAAE,CAAC,eAAe,EAAE,CAAA;AAE3E;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,GAA+D,EAAE,CACtF,SAAS,EAAK,CAAC,OAAO,EAAE,CAAA;AAE1B;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,KAAK,EACxB,WAA6B,EACL,EAAE,CAAC,SAAS,EAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CAAA;AAE9D;;;GAGG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,GAAkB,EAAE,CAAC,SAAS,EAAE,CAAC,MAAM,EAAE,CAAA;AAE/D;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,KAAK,EAI3B,IAA0B,EACF,EAAE,CAAC,SAAS,EAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@molecule/app-auth",
-  "version": "1.8.2",
+  "version": "2.0.0",
   "description": "Client-side authentication interface for molecule.dev",
   "type": "module",
   "main": "dist/index.js",