@loginid/websdk3 1.1.1 → 1.3.0

package/dist/index.d.cts

@@ -49,6 +49,40 @@ declare abstract class BaseHttpRequest {
     abstract request<T>(options: ApiRequestOptions): CancelablePromise<T>;
 }
 
+type AuthCode = {
+    /**
+     * Generated code
+     */
+    code: string;
+    /**
+     * Expiration time of the code
+     */
+    expiresAt: string;
+};
+
+type UserLogin = {
+    /**
+     * Username
+     */
+    username: string;
+    /**
+     * Username type
+     */
+    usernameType: 'email' | 'phone';
+};
+
+type AuthCodeRequestSMSRequestBody = {
+    user: UserLogin;
+};
+
+type AuthCodeVerifyRequestBody = {
+    /**
+     * Authentication code
+     */
+    authCode: string;
+    user: UserLogin;
+};
+
 type AuthenticatorAssertionResponse = {
     /**
      * This attribute contains the authenticator data returned by the authenticator.
@@ -137,6 +171,10 @@ type PublicKeyCredentialRequestOptions = {
 
 type AuthInit = {
     assertionOptions: PublicKeyCredentialRequestOptions;
+    /**
+     * List of fallback methods (in priority order) available to this client.
+     */
+    fallbackOptions?: Array<'otp:client' | 'otp:email' | 'otp:sms'>;
     /**
      * An opaque object containing session data.
      */
@@ -202,28 +240,25 @@ type DeviceInfo = {
     screenWidth?: number;
 };
 
-type User = {
-    /**
-     * Display Name
-     */
-    displayName?: string;
+type AuthInitRequestBody = {
+    app: Application;
+    deviceInfo: DeviceInfo;
+    user?: UserLogin;
+};
+
+type CodeResult = {
     /**
-     * Username
+     * Generated code
      */
-    username: string;
+    code: string;
     /**
-     * Username type
+     * Expiration time of the code
      */
-    usernameType: 'email' | 'phone';
-};
-
-type AuthInitRequestBody = {
-    app: Application;
-    deviceInfo: DeviceInfo;
-    user?: User;
+    expiresAt: string;
 };
 
 type JWT = {
+    code?: CodeResult;
     /**
      * JWT access token
      */
@@ -253,6 +288,95 @@ declare class AuthService {
          */
         userAgent?: string;
     }): CancelablePromise<AuthInit>;
+    /**
+     * Request OTP code by an authenticated user
+     * An authenticated user can request an authentication code directly using this
+     * method. The code can be used for authentication from another device.
+     * @returns AuthCode OK response.
+     * @throws ApiError
+     */
+    authAuthCodeRequest({ authorization, }: {
+        /**
+         * JWT Authorization header
+         */
+        authorization?: string;
+    }): CancelablePromise<AuthCode>;
+    /**
+     * Request OTP code to be sent via email.
+     * Send authentication code to the provided email. The SMS will only be sent
+     * if the email address is known to the application, however, this method will
+     * return success regardless.
+     * @returns void
+     * @throws ApiError
+     */
+    authAuthCodeRequestEmail({ requestBody, }: {
+        requestBody: AuthCodeRequestSMSRequestBody;
+    }): CancelablePromise<void>;
+    /**
+     * Request OTP code to be sent via SMS.
+     * Send authentication code to the provided phone number. The SMS will only be
+     * sent if the phone is registered with the application, however, it will return
+     * success regardless.
+     * @returns void
+     * @throws ApiError
+     */
+    authAuthCodeRequestSms({ requestBody, }: {
+        requestBody: AuthCodeRequestSMSRequestBody;
+    }): CancelablePromise<void>;
+    /**
+     * Verify authentication code and return JWT access token with appropriate scopes
+     * @returns JWT OK response.
+     * @throws ApiError
+     */
+    authAuthCodeVerify({ requestBody, }: {
+        requestBody: AuthCodeVerifyRequestBody;
+    }): CancelablePromise<JWT>;
+}
+
+type GrantCreateRequestBody = {
+    /**
+     * List of requested grants
+     */
+    grants: Array<'passkey:read' | 'passkey:write' | 'profile:read' | 'profile:write' | 'self:write'>;
+    /**
+     * User identifier
+     */
+    username?: string;
+};
+
+type GrantCreateResponseBody = {
+    /**
+     * Base64 encoded authorization token
+     */
+    token: string;
+};
+
+type TokenVerifyRequestBody = {
+    /**
+     * JWT access token
+     */
+    jwtAccess: string;
+};
+
+declare class MgmtService {
+    readonly httpRequest: BaseHttpRequest;
+    constructor(httpRequest: BaseHttpRequest);
+    /**
+     * Create an authorization token with requested scopes
+     * @returns GrantCreateResponseBody OK response.
+     * @throws ApiError
+     */
+    mgmtGrantCreate({ requestBody, }: {
+        requestBody: GrantCreateRequestBody;
+    }): CancelablePromise<GrantCreateResponseBody>;
+    /**
+     * Validate JWT Access Token
+     * @returns void
+     * @throws ApiError
+     */
+    mgmtTokenVerify({ requestBody, }: {
+        requestBody: TokenVerifyRequestBody;
+    }): CancelablePromise<void>;
 }
 
 type Passkey = {
@@ -291,8 +415,11 @@ declare class PasskeysService {
      * @returns PasskeyCollection OK response.
      * @throws ApiError
      */
-    passkeysPasskeysList({ authorization }: {
-        authorization: string;
+    passkeysPasskeysList({ authorization, }: {
+        /**
+         * JWT Authorization header
+         */
+        authorization?: string;
     }): CancelablePromise<PasskeyCollection>;
     /**
      * Delete passkey
@@ -304,20 +431,134 @@ declare class PasskeysService {
          * Internal passkey identifier
          */
         id: string;
-        authorization: string;
+        /**
+         * JWT Authorization header
+         */
+        authorization?: string;
     }): CancelablePromise<void>;
     /**
      * Rename passkey
      * @returns void
      * @throws ApiError
      */
-    passkeysPasskeyRename({ id, requestBody, authorization }: {
+    passkeysPasskeyRename({ id, requestBody, authorization, }: {
         /**
          * Internal passkey identifier
          */
         id: string;
         requestBody: PasskeyRenameRequestBody;
-        authorization: string;
+        /**
+         * JWT Authorization header
+         */
+        authorization?: string;
+    }): CancelablePromise<void>;
+}
+
+type ProfileEmailUpdateRequestBody = {
+    /**
+     * Email address
+     */
+    email: string;
+    /**
+     * Whether to update the email address immediately or send an authorization code
+     * to verify.
+     */
+    requestVerification?: boolean;
+};
+
+type ProfilePhoneUpdateRequestBody = {
+    /**
+     * Whether the user consents to receiving SMS messages on this number. The phone
+     * will not be used for sending messages if no consent is provided.
+     */
+    messagingConsent?: boolean;
+    /**
+     * Phone number
+     */
+    phoneNumber: string;
+    /**
+     * Whether to update the phone number immediately or send an authorization code
+     * to verify. This method will fail if verification is requested but no consent
+     * is provided.
+     */
+    requestVerification?: boolean;
+};
+
+type ProfilePhoneVerifyRequestBody = {
+    /**
+     * Verification code
+     */
+    authCode: string;
+    /**
+     * Username associated with the code
+     */
+    username: string;
+};
+
+declare class ProfileService {
+    readonly httpRequest: BaseHttpRequest;
+    constructor(httpRequest: BaseHttpRequest);
+    /**
+     * Delete a user profile and all associated passkey
+     * @returns void
+     * @throws ApiError
+     */
+    profileProfileDelete({ id, }: {
+        /**
+         * Internal user identifier
+         */
+        id: string;
+    }): CancelablePromise<void>;
+    /**
+     * Update profile email address
+     * @returns void
+     * @throws ApiError
+     */
+    profileProfileEmailUpdate({ id, requestBody, }: {
+        /**
+         * Internal user identifier
+         */
+        id: string;
+        requestBody: ProfileEmailUpdateRequestBody;
+    }): CancelablePromise<void>;
+    /**
+     * Delete phone from the profile
+     * @returns void
+     * @throws ApiError
+     */
+    profileProfilePhoneDelete({ id, }: {
+        /**
+         * Internal user identifier
+         */
+        id: string;
+    }): CancelablePromise<void>;
+    /**
+     * Update the profile phone number
+     * @returns void
+     * @throws ApiError
+     */
+    profileProfilePhoneUpdate({ id, requestBody, }: {
+        /**
+         * Internal user identifier
+         */
+        id: string;
+        requestBody: ProfilePhoneUpdateRequestBody;
+    }): CancelablePromise<void>;
+    /**
+     * Verify phone number with received authorization code
+     * @returns void
+     * @throws ApiError
+     */
+    profileProfileEmailVerify({ requestBody, }: {
+        requestBody: ProfilePhoneVerifyRequestBody;
+    }): CancelablePromise<void>;
+    /**
+     * Verify phone number with received authorization code
+     * @returns void
+     * @throws ApiError
+     */
+    profileProfilePhoneVerify({ requestBody, }: {
+        requestBody: ProfilePhoneVerifyRequestBody;
     }): CancelablePromise<void>;
 }
 
@@ -467,18 +708,33 @@ type RegInit = {
     session: string;
 };
 
+type User = {
+    /**
+     * Display Name
+     */
+    displayName?: string;
+    /**
+     * Username
+     */
+    username: string;
+    /**
+     * Username type
+     */
+    usernameType: 'email' | 'phone';
+};
+
 type RegInitRequestBody = {
     app: Application;
     deviceInfo: DeviceInfo;
     /**
-     * Set of authentication factors:
-     * - Single factor: Username (i.e. email or phone) + FIDO2 credential;
-     * - Two factor: Username + password + FIDO2 credential;
-     * - Passwordless: FIDO2 discoverable credentials;
-     * - Passwordless + MFA: FIDO2 discoverable credentials + PIN;
+     * An opaque object containing user data. It is used in place of "user" attribute
+     * for creating passkeys for pre-authorized users ("user" attribute is ignored if
+     * session is present). The value of this attribute is generated by this service
+     * and require backend integration for obtaining it. This value is time sensitive
+     * and has rather short expiry.
      */
-    mfa?: Array<'fido2' | 'email' | 'phone' | 'password' | 'pin'>;
-    user: User;
+    session?: string;
+    user?: User;
 };
 
 declare class RegService {
@@ -497,35 +753,19 @@ declare class RegService {
      * @returns RegInit OK response.
      * @throws ApiError
      */
-    regRegInit({ requestBody, userAgent, }: {
+    regRegInit({ requestBody, userAgent, authorization, }: {
         requestBody: RegInitRequestBody;
         /**
          * Raw user-agent header as set by a browser
          */
         userAgent?: string;
+        /**
+         * JWT Authorization header
+         */
+        authorization?: string;
     }): CancelablePromise<RegInit>;
 }
 
-type TokenVerifyRequestBody = {
-    /**
-     * JWT access token
-     */
-    jwtAccess: string;
-};
-
-declare class TokenService {
-    readonly httpRequest: BaseHttpRequest;
-    constructor(httpRequest: BaseHttpRequest);
-    /**
-     * Validate JWT Access Token
-     * @returns void
-     * @throws ApiError
-     */
-    tokenTokenVerify({ requestBody, }: {
-        requestBody: TokenVerifyRequestBody;
-    }): CancelablePromise<void>;
-}
-
 type TxComplete = {
     authCred?: Passkey;
     /**
@@ -657,9 +897,10 @@ declare class VersionService {
 type HttpRequestConstructor = new (config: OpenAPIConfig) => BaseHttpRequest;
 declare class LoginIDService {
     readonly auth: AuthService;
+    readonly mgmt: MgmtService;
     readonly passkeys: PasskeysService;
+    readonly profile: ProfileService;
     readonly reg: RegService;
-    readonly token: TokenService;
     readonly tx: TxService;
     readonly version: VersionService;
     readonly request: BaseHttpRequest;
@@ -685,7 +926,6 @@ declare class ApiError extends Error {
 
 type UsernameType = User['usernameType'];
 type DeviceInfoRequestBody = DeviceInfo;
-type MFA = RegInitRequestBody['mfa'];
 type Transports = CreationResult['transports'];
 interface LoginIDConfig {
     baseUrl: string;
@@ -696,14 +936,25 @@ interface PasskeyOptions {
     displayName?: string;
     usernameType?: UsernameType;
 }
+interface PasskeyManagementOptions {
+    token?: string;
+}
+interface ListPasskeysOptions extends PasskeyManagementOptions {
+}
+interface RenamePasskeyOptions extends PasskeyManagementOptions {
+}
+interface DeletePasskeyOptions extends PasskeyManagementOptions {
+}
 interface AuthenticateWithPasskeysOptions extends PasskeyOptions {
     autoFill?: boolean;
     abortSignal?: AbortSignal;
 }
 interface RegisterWithPasskeyOptions extends PasskeyOptions {
-    mfa?: MFA;
+    session?: string;
 }
-interface ConfirmTransactionOptions extends Partial<Pick<TxInitRequestBody, 'txType'>> {
+interface ConfirmTransactionOptions extends PasskeyOptions {
+    txType?: string;
+    nonce?: string;
 }
 interface PasskeyResult {
     jwtAccess: string;
@@ -727,13 +978,38 @@ declare class LoginIDBase {
      * @param {LoginIDConfig} config Configuration object for LoginID API, including the base URL.
      */
     constructor(config: LoginIDConfig);
+    getToken(options: PasskeyOptions): string;
+    /**
+     *
+     * @returns {string} The name of the cookie
+     */
+    getJwtCookieName(): string;
+    /**
+     * Set jwt token to localstorage
+     * @param {string} jwt Configuration object for LoginID API, including the base URL.
+     */
+    setJwtCookie(jwt: string): void;
+    /**
+     * Retrieves the JWT access token.
+     * @returns {string | undefined} The JWT access token.
+     */
+    getJwtCookie(): string | undefined;
+    /**
+       * checks if the user is logged in.
+       * @returns {boolean}
+       */
+    isLoggedIn(): boolean;
+    /**
+       * deletes the jwt cookie.
+       * @returns {boolean}
+       */
+    signout(): void;
 }
 
 /**
  * Extends LoginIDBase to support creation, registration, and authentication of passkeys.
  */
 declare class Passkeys extends LoginIDBase {
-    private jwtAccess;
     /**
      * Initializes a new Passkeys instance with the provided configuration.
      * @param {LoginIDConfig} config Configuration object for LoginID.
@@ -766,6 +1042,36 @@ declare class Passkeys extends LoginIDBase {
      * @returns {Promise<any>} Result of the authentication operation.
      */
     authenticateWithPasskey(username?: string, options?: AuthenticateWithPasskeysOptions): Promise<PasskeyResult>;
+    /**
+     * Generates a code with passkey.
+     * @param {string} username Username to authenticate.
+     * @param {AuthenticateWithPasskeysOptions} options Additional authentication options.
+     * @returns {Promise<AuthCode>} Code and expiry.
+     */
+    generateCodeWithPasskey(username: string, options?: AuthenticateWithPasskeysOptions): Promise<AuthCode>;
+    /**
+     * Authenticate with a code.
+     * @param {string} username Username to authenticate.
+     * @param {string} code code to authenticate.
+     * @param {AuthenticateWithPasskeysOptions} options Additional authentication options.
+     * @returns {Promise<any>} Result of the authentication operation.
+     */
+    authenticateWithCode(username: string, code: string, options?: AuthenticateWithPasskeysOptions): Promise<JWT>;
+    /**
+     * Add passkey
+     * @param username Username to authenticate.
+     * @param options Additional authentication options.
+     * @returns {Promise<PasskeyResult>} Result of the add passkey operation.
+     */
+    addPasskey(username: string, options?: PasskeyOptions): Promise<PasskeyResult>;
+    /**
+     * Add passkey with code
+     * @param username Username to authenticate.
+     * @param code Code to authenticate.
+     * @param options Additional authentication options.
+     * @returns @returns {Promise<PasskeyResult>} Result of the add passkey with code operation.
+     */
+    addPasskeyWithCode(username: string, code: string, options?: PasskeyOptions): Promise<PasskeyResult>;
     /**
      * Confirms a transaction using a passkey.
      *
@@ -782,12 +1088,7 @@ declare class Passkeys extends LoginIDBase {
      * @returns {Promise<any>} A promise that resolves with the result of the transaction confirmation operation.
      * The result includes details about the transaction's details and includes a new JWT access token.
      */
-    confirmTransaction(username: string, txPayload: string, nonce: string, options?: ConfirmTransactionOptions): Promise<TxComplete>;
-    /**
-     * Retrieves the JWT access token.
-     * @returns {string} The JWT access token.
-     */
-    getJWTAccess(): string;
+    confirmTransaction(username: string, txPayload: string, options?: ConfirmTransactionOptions): Promise<TxComplete>;
 }
 
 /**
@@ -804,7 +1105,7 @@ declare class PasskeyManager extends LoginIDBase {
      * @param {string} authToken Authorization token to authenticate the request.
      * @returns {Promise<PasskeysPasskeyResponseCollection>} A collection of passkeys.
      */
-    listPasskeys(authToken: string): Promise<PasskeyCollection>;
+    listPasskeys(options?: ListPasskeysOptions): Promise<PasskeyCollection>;
     /**
      * Renames a specified passkey.
      * @param {string} authToken Authorization token to authenticate the request.
@@ -812,14 +1113,14 @@ declare class PasskeyManager extends LoginIDBase {
      * @param {string} name The new name for the passkey.
      * @returns {Promise<null>} A promise that resolves to null upon successful completion.
      */
-    renamePasskey(authToken: string, id: string, name: string): Promise<null>;
+    renamePasskey(id: string, name: string, options?: RenamePasskeyOptions): Promise<null>;
     /**
      * Deletes a specified passkey.
      * @param {string} authToken Authorization token to authenticate the request.
      * @param {string} id The ID of the passkey to delete.
      * @returns {Promise<null>} A promise that resolves to null upon successful deletion.
      */
-    deletePasskey(authToken: string, id: string): Promise<null>;
+    deletePasskey(id: string, options?: DeletePasskeyOptions): Promise<null>;
 }
 
 interface LoginIDWebSDK extends Passkeys, PasskeyManager {
@@ -878,4 +1179,4 @@ interface DoesDeviceSupportPasskeysResponse {
  */
 declare function doesDeviceSupportPasskeys(): Promise<DoesDeviceSupportPasskeysResponse>;
 
-export { ApiError, type AuthenticateWithPasskeysOptions, type ConfirmTransactionOptions, type DeviceInfoRequestBody, type DoesDeviceSupportPasskeysResponse, type LoginIDConfig, LoginIDWebSDK, type MFA, PasskeyError, type PasskeyOptions, type PasskeyResult, type RegisterWithPasskeyOptions, type Transports, type UsernameType, createPasskeyCredential, LoginIDWebSDK as default, doesDeviceSupportPasskeys, getPasskeyCredential, isConditionalUIAvailable, isPlatformAuthenticatorAvailable };
+export { ApiError, type AuthenticateWithPasskeysOptions, type ConfirmTransactionOptions, type DeletePasskeyOptions, type DeviceInfoRequestBody, type DoesDeviceSupportPasskeysResponse, type ListPasskeysOptions, type LoginIDConfig, LoginIDWebSDK, PasskeyError, type PasskeyManagementOptions, type PasskeyOptions, type PasskeyResult, type RegisterWithPasskeyOptions, type RenamePasskeyOptions, type Transports, type UsernameType, createPasskeyCredential, LoginIDWebSDK as default, doesDeviceSupportPasskeys, getPasskeyCredential, isConditionalUIAvailable, isPlatformAuthenticatorAvailable };