@schibsted/account-sdk-browser 6.0.0-alpha.5 → 6.0.0-alpha.7

package/src/types/login.ts

@@ -1,5 +1,7 @@
 /**
- * Options accepted by {@link Identity#login} and related login URL helpers.
+ * Options accepted by {@link Account#login} and related login URL helpers.
+ *
+ * @group Login & Widget
  */
 export type LoginOptions = {
     /**
@@ -8,14 +10,11 @@ export type LoginOptions = {
      */
     state: string;
     /**
-     * Authentication Context Class Reference Values. If omitted, the user will be asked to
-     * authenticate using username+password. For 2FA (Two-Factor Authentication) possible values
-     * are `sms`, `otp` (one time password), `password` (will force password confirmation, even if
-     * user is already logged in), `eid`. Those values might be mixed as space-separated string.
-     * To make sure that user has authenticated with 2FA you need to verify AMR (Authentication
-     * Methods References) claim in ID token. Might also be used to ensure additional acr
-     * (sms, otp, eid) for already logged in users. Supported value is also 'otp-email' means one
-     * time password using email.
+     * Authentication Context Class Reference values. If omitted, the default account flow is used.
+     * Supported values include `password`, `otp`, `sms`, `otp-email`, `eid`, `eid-no`, `eid-se`,
+     * `eid-fi`, and `eid-dk`. Values other than `otp-email` may be combined as a space-separated
+     * string. Verify the AMR (Authentication Methods References) claim in the ID token on your
+     * backend if you need to enforce a completed authentication method.
      */
     acrValues?:
         | 'password'
@@ -81,6 +80,8 @@ export type LoginOptions = {
 /**
  * Identical to {@link LoginOptions} except that `state` may also be a (possibly async) function;
  * all other fields reuse the `LoginOptions` documentation.
+ *
+ * @group Login & Widget
  */
 export type SimplifiedLoginWidgetLoginOptions = Omit<LoginOptions, 'state'> & {
     /**
@@ -92,9 +93,11 @@ export type SimplifiedLoginWidgetLoginOptions = Omit<LoginOptions, 'state'> & {
 
 /**
  * Minimal user information used by the simplified login widget flow.
+ *
+ * @group Login & Widget
  */
 export type SimplifiedLoginData = {
-    /** Deprecated: User UUID, to be be used as `loginHint` for {@link Identity#login} */
+    /** Deprecated: User UUID used as `loginHint` for {@link Account#login}. */
     identifier: string;
     /** Human-readable user identifier */
     display_text: string;
@@ -105,7 +108,9 @@ export type SimplifiedLoginData = {
 };
 
 /**
- * Configuration options for {@link Identity#showSimplifiedLoginWidget}.
+ * Configuration options for {@link Account#showSimplifiedLoginWidget}.
+ *
+ * @group Login & Widget
  */
 export type SimplifiedLoginWidgetOptions = {
     /** expected encoding of simplified login widget. Could be utf-8 (default), iso-8859-1 or iso-8859-15 */

package/src/types/monetization.ts

@@ -4,16 +4,21 @@ import type { SessionUserId } from './session';
 /**
  * Result returned by the Session Service `/hasAccess` endpoint, describing whether the user
  * is entitled to a requested set of products/features.
- * @internal
+ *
+ * @group Access Checks
  */
 export interface HasAccessResult {
     /** Whether the user is entitled to at least one of the requested products/features. */
     entitled: boolean;
     /** How long this result stays valid, in seconds, before the cache entry expires. */
     ttl: number;
+    /** Feature ids the user is allowed to access. */
     allowedFeatures: string[];
+    /** User id the access result belongs to. */
     userId: SessionUserId;
+    /** Globally unique user id the access result belongs to. */
     uuid: string;
+    /** Signed response payload. */
     sig: string;
 }
 

package/src/types/session.ts

@@ -7,17 +7,21 @@
  *
  * Session Service historically returned numeric ids, while some integrations and tests use
  * string ids. SDK convenience methods normalize this where they promise a string.
+ *
+ * @group Session
  */
 export type SessionUserId = number | string;
 
 // Session Service object payloads.
 
 /**
- * Successful response returned from {@link Identity#hasSession}.
+ * Successful response returned from {@link Account#hasSession}.
  *
  * `result` means the has-session call itself succeeded. `result: true` means the user is
  * connected to the merchant; `result: false` means a session may exist, but the user is not
  * connected to this client.
+ *
+ * @group Session
  */
 export type SessionSuccessResponse = {
     /** Response status code. Example: 200. */
@@ -31,7 +35,7 @@ export type SessionSuccessResponse = {
      * merchants connected to this user.
      */
     result: boolean;
-    /** Connection status string. Deprecated; use `Identity.isConnected()`. Example: 'connected'. */
+    /** Connection status string. Deprecated; use `Account.isConnected()`. Example: 'connected'. */
     userStatus?: string;
     /** Cookie base domain used as the `SP_ID` cookie domain fallback. Example: 'spid.no'. */
     baseDomain?: string;
@@ -77,6 +81,8 @@ export type SessionSuccessResponse = {
 
 /**
  * Successful has-session response for a user connected to the merchant.
+ *
+ * @group Session
  */
 export type ConnectedSessionResponse = SessionSuccessResponse & {
     result: true;
@@ -84,6 +90,8 @@ export type ConnectedSessionResponse = SessionSuccessResponse & {
 
 /**
  * Connected session response that also carries a usable user id.
+ *
+ * @group Session
  */
 export type ConnectedSessionWithUserIdResponse = ConnectedSessionResponse & {
     userId: SessionUserId;
@@ -94,6 +102,8 @@ export type ConnectedSessionWithUserIdResponse = ConnectedSessionResponse & {
  *
  * API and network failures usually reject with {@link SDKError}; this shape represents a failure
  * payload when one is returned by Session Service and reaches the has-session flow.
+ *
+ * @group Session
  */
 export type SessionFailureResponse = {
     /** Failure payload returned by Session Service. Usually an object, but tests also pass strings. */
@@ -121,9 +131,16 @@ export type SessionFailureResponse = {
  *
  * This intentionally includes `{}`. Historically `hasSession()` could resolve an empty object or
  * other object payloads that callers inspected themselves, so the SDK preserves those responses.
+ *
+ * @group Session
  */
 export type UnrecognizedSessionResponse = object;
 
+/**
+ * Redirect URL returned by `hasSession()` when Session Service needs a full-page session refresh.
+ *
+ * @group Session
+ */
 export type RedirectSessionResponse = string;
 
 export type SessionObjectResponse =
@@ -135,10 +152,18 @@ export type RedirectSessionPayload = {
     redirectURL: string;
 };
 
+/**
+ * Internal shape returned by `normalizeSessionResponse()` before `hasSession()` post-processing.
+ *
+ * It includes regular Session Service object responses and redirect responses used for full-page
+ * session refresh.
+ */
 export type NormalizedSessionPayload = SessionObjectResponse | RedirectSessionPayload;
 
 /**
- * Public response union returned from {@link Identity#hasSession}.
+ * Public response union returned from {@link Account#hasSession}.
+ *
+ * @group Session
  */
 export type SessionResponse =
     | SessionSuccessResponse

package/src/version.ts

@@ -1,4 +1,4 @@
 // Version is bumped automatically by release-please. See release-please-config.json.
 
-const version = '6.0.0-alpha.5'; // x-release-please-version
+const version = '6.0.0-alpha.7'; // x-release-please-version
 export default version;