npm - @metamask-previews/seedless-onboarding-controller - Versions diffs - 9.0.0-preview-84c63ff0e → 9.0.0-preview-2d89a26 - Mend

@metamask-previews/seedless-onboarding-controller 9.0.0-preview-84c63ff0e → 9.0.0-preview-2d89a26

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

package/dist/SeedlessOnboardingController-method-action-types.cjs CHANGED Viewed

@@ -1,6 +1,6 @@
 "use strict";
 /**
- * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * This file is auto generated.
  * Do not edit manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/SeedlessOnboardingController-method-action-types.cjs.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"SeedlessOnboardingController-method-action-types.cjs","sourceRoot":"","sources":["../src/SeedlessOnboardingController-method-action-types.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*\n This file is auto generated by `scripts/generate-method-action-types.ts`.\n * Do not edit manually.\n /\n\nimport type { SeedlessOnboardingController } from './SeedlessOnboardingController';\n\nexport type SeedlessOnboardingControllerFetchMetadataAccessCredsAction = {\n type: `SeedlessOnboardingController:fetchMetadataAccessCreds`;\n handler: SeedlessOnboardingController['fetchMetadataAccessCreds'];\n};\n\n/\n Gets the node details for the TOPRF operations.\n * This function can be called to get the node endpoints, indexes and pubkeys and cache them locally.\n /\nexport type SeedlessOnboardingControllerPreloadToprfNodeDetailsAction = {\n type: `SeedlessOnboardingController:preloadToprfNodeDetails`;\n handler: SeedlessOnboardingController['preloadToprfNodeDetails'];\n};\n\n/\n Authenticate OAuth user using the seedless onboarding flow\n * and determine if the user is already registered or not.\n \n @param params - The parameters for authenticate OAuth user.\n * @param params.idTokens - The ID token(s) issued by OAuth verification service. Currently this array only contains a single idToken which is verified by all the nodes, in future we are considering to issue a unique idToken for each node.\n * @param params.authConnection - The social login provider.\n * @param params.authConnectionId - OAuth authConnectionId from dashboard\n * @param params.userId - user email or id from Social login\n * @param params.groupedAuthConnectionId - Optional grouped authConnectionId to be used for the authenticate request.\n * @param params.socialLoginEmail - The user email from Social login.\n * @param params.refreshToken - Refresh token issued during OAuth login. Written to state when provided.\n * @param params.revokeToken - revoke token for revoking refresh token and get new refresh token and new revoke token.\n * @param params.accessToken - Access token for pairing with profile sync auth service and to access other services.\n * @param params.metadataAccessToken - Metadata access token for accessing the metadata service before the vault is created or unlocked.\n * @param params.skipLock - Optional flag to skip acquiring the controller lock. (to prevent deadlock in case the caller already acquired the lock)\n * @returns A promise that resolves to the authentication result.\n /\nexport type SeedlessOnboardingControllerAuthenticateAction = {\n type: `SeedlessOnboardingController:authenticate`;\n handler: SeedlessOnboardingController['authenticate'];\n};\n\n/\n Create a new TOPRF encryption key using given password and backups the provided seed phrase.\n \n @param password - The password used to create new wallet and seedphrase\n * @param seedPhrase - The initial seed phrase (Mnemonic) created together with the wallet.\n * @param keyringId - The keyring id of the backup seed phrase\n * @returns A promise that resolves to the encrypted seed phrase and the encryption key.\n /\nexport type SeedlessOnboardingControllerCreateToprfKeyAndBackupSeedPhraseAction =\n {\n type: `SeedlessOnboardingController:createToprfKeyAndBackupSeedPhrase`;\n handler: SeedlessOnboardingController['createToprfKeyAndBackupSeedPhrase'];\n };\n\n/\n encrypt and add a new secret data to the metadata store.\n \n @param data - The data to add.\n * @param type - The type of the secret data.\n * @param options - Optional options object, which includes optional data to be added to the metadata store.\n * @param options.keyringId - The keyring id of the backup keyring (SRP).\n * @returns A promise that resolves to the success of the operation.\n /\nexport type SeedlessOnboardingControllerAddNewSecretDataAction = {\n type: `SeedlessOnboardingController:addNewSecretData`;\n handler: SeedlessOnboardingController['addNewSecretData'];\n};\n\n/\n Fetches all encrypted secret data and metadata for user's account from the metadata store.\n \n Decrypts the secret data and returns the decrypted secret data using the recovered encryption key from the password.\n \n @param password - The optional password used to create new wallet. If not provided, `cached Encryption Key` will be used.\n * @returns A promise that resolves to the secret data.\n /\nexport type SeedlessOnboardingControllerFetchAllSecretDataAction = {\n type: `SeedlessOnboardingController:fetchAllSecretData`;\n handler: SeedlessOnboardingController['fetchAllSecretData'];\n};\n\n/\n Update the password of the seedless onboarding flow.\n \n Changing password will also update the encryption key, metadata store and the vault with new encrypted values.\n \n @param newPassword - The new password to update.\n * @param oldPassword - The old password to verify.\n * @returns A promise that resolves to the success of the operation.\n /\nexport type SeedlessOnboardingControllerChangePasswordAction = {\n type: `SeedlessOnboardingController:changePassword`;\n handler: SeedlessOnboardingController['changePassword'];\n};\n\n/\n Update the backup metadata state for the given secret data.\n \n @param secretData - The data to backup, can be a single backup or array of backups.\n * @param secretData.keyringId - The keyring id associated with the backup secret data.\n * @param secretData.data - The secret data to update the backup metadata state.\n /\nexport type SeedlessOnboardingControllerUpdateBackupMetadataStateAction = {\n type: `SeedlessOnboardingController:updateBackupMetadataState`;\n handler: SeedlessOnboardingController['updateBackupMetadataState'];\n};\n\n/\n Verify the password validity by decrypting the vault.\n \n @param password - The password to verify.\n * @param options - Optional options object.\n * @param options.skipLock - Whether to skip the lock acquisition. (to prevent deadlock in case the caller already acquired the lock)\n * @returns A promise that resolves to the success of the operation.\n * @throws {Error} If the password is invalid or the vault is not initialized.\n /\nexport type SeedlessOnboardingControllerVerifyVaultPasswordAction = {\n type: `SeedlessOnboardingController:verifyVaultPassword`;\n handler: SeedlessOnboardingController['verifyVaultPassword'];\n};\n\n/\n Get backup state of the given secret data, from the controller state.\n \n If the given secret data is not backed up and not found in the state, it will return `undefined`.\n \n @param data - The data to get the backup state of.\n * @param type - The type of the secret data.\n * @returns The backup state of the given secret data.\n /\nexport type SeedlessOnboardingControllerGetSecretDataBackupStateAction = {\n type: `SeedlessOnboardingController:getSecretDataBackupState`;\n handler: SeedlessOnboardingController['getSecretDataBackupState'];\n};\n\n/\n Submit the password to the controller, verify the password validity and unlock the controller.\n \n This method will be used especially when user unlock the wallet.\n * The provided password will be verified against the encrypted vault, encryption key will be derived and saved in the controller state.\n \n This operation is useful when user performs some actions that requires the user password/encryption key. e.g. add new srp backup\n \n @param password - The password to submit.\n * @returns A promise that resolves to the success of the operation.\n /\nexport type SeedlessOnboardingControllerSubmitPasswordAction = {\n type: `SeedlessOnboardingController:submitPassword`;\n handler: SeedlessOnboardingController['submitPassword'];\n};\n\n/\n Set the controller to locked state, and deallocate the secrets (vault encryption key and salt).\n \n When the controller is locked, the user will not be able to perform any operations on the controller/vault.\n \n @returns A promise that resolves to the success of the operation.\n /\nexport type SeedlessOnboardingControllerSetLockedAction = {\n type: `SeedlessOnboardingController:setLocked`;\n handler: SeedlessOnboardingController['setLocked'];\n};\n\n/\n Sync the latest global password to the controller.\n * reset vault with latest globalPassword,\n * persist the latest global password authPubKey\n \n @param params - The parameters for syncing the latest global password.\n * @param params.globalPassword - The latest global password.\n * @returns A promise that resolves to the success of the operation.\n /\nexport type SeedlessOnboardingControllerSyncLatestGlobalPasswordAction = {\n type: `SeedlessOnboardingController:syncLatestGlobalPassword`;\n handler: SeedlessOnboardingController['syncLatestGlobalPassword'];\n};\n\n/\n @description Unlock the controller with the latest global password.\n \n @param params - The parameters for unlocking the controller.\n * @param params.maxKeyChainLength - The maximum chain length of the pwd encryption keys.\n * @param params.globalPassword - The latest global password.\n * @returns A promise that resolves to the success of the operation.\n /\nexport type SeedlessOnboardingControllerSubmitGlobalPasswordAction = {\n type: `SeedlessOnboardingController:submitGlobalPassword`;\n handler: SeedlessOnboardingController['submitGlobalPassword'];\n};\n\n/\n @description Check if the current password is outdated compare to the global password.\n \n @param options - Optional options object.\n * @param options.globalAuthPubKey - The global auth public key to compare with the current auth public key.\n * If not provided, the global auth public key will be fetched from the backend.\n * @param options.skipCache - If true, bypass the cache and force a fresh check.\n * @param options.skipLock - Whether to skip the lock acquisition. (to prevent deadlock in case the caller already acquired the lock)\n * @returns A promise that resolves to true if the password is outdated, false otherwise.\n /\nexport type SeedlessOnboardingControllerCheckIsPasswordOutdatedAction = {\n type: `SeedlessOnboardingController:checkIsPasswordOutdated`;\n handler: SeedlessOnboardingController['checkIsPasswordOutdated'];\n};\n\n/\n Check if the user is authenticated with the seedless onboarding flow by checking the token values in the state.\n \n This method will check the `accessToken` and `revokeToken` in the state, besides the social login authentication details.\n * If both are present, the user is authenticated.\n * If either is missing, the user is not authenticated.\n \n This method is useful when we want to check if the state has valid authenticated user details to perform vault creations.\n \n @returns True if the user is authenticated, false otherwise.\n /\nexport type SeedlessOnboardingControllerGetIsUserAuthenticatedAction = {\n type: `SeedlessOnboardingController:getIsUserAuthenticated`;\n handler: SeedlessOnboardingController['getIsUserAuthenticated'];\n};\n\n/\n Clears the current state of the SeedlessOnboardingController.\n /\nexport type SeedlessOnboardingControllerClearStateAction = {\n type: `SeedlessOnboardingController:clearState`;\n handler: SeedlessOnboardingController['clearState'];\n};\n\n/\n Store the keyring encryption key in state, encrypted under the current\n * encryption key.\n \n @param keyringEncryptionKey - The keyring encryption key.\n /\nexport type SeedlessOnboardingControllerStoreKeyringEncryptionKeyAction = {\n type: `SeedlessOnboardingController:storeKeyringEncryptionKey`;\n handler: SeedlessOnboardingController['storeKeyringEncryptionKey'];\n};\n\n/\n Load the keyring encryption key from state, decrypted under the current\n * encryption key.\n \n @returns The keyring encryption key.\n /\nexport type SeedlessOnboardingControllerLoadKeyringEncryptionKeyAction = {\n type: `SeedlessOnboardingController:loadKeyringEncryptionKey`;\n handler: SeedlessOnboardingController['loadKeyringEncryptionKey'];\n};\n\n/\n Refresh expired nodeAuthTokens, accessToken, and metadataAccessToken using\n * the stored refresh token.\n \n Concurrent callers share a single in-flight HTTP request — if a refresh is\n * already in-progress the returned promise resolves when that request settles\n * rather than firing a duplicate request with the same token.\n \n @returns A promise that resolves when the tokens have been refreshed.\n /\nexport type SeedlessOnboardingControllerRefreshAuthTokensAction = {\n type: `SeedlessOnboardingController:refreshAuthTokens`;\n handler: SeedlessOnboardingController['refreshAuthTokens'];\n};\n\n/\n Rotate the refresh token — fetch a new refresh/revoke token pair from the\n * auth service and persist the new revoke token in the vault.\n \n This method should be called after a successful JWT refresh.\n \n @returns A Promise that resolves to void.\n /\nexport type SeedlessOnboardingControllerRotateRefreshTokenAction = {\n type: `SeedlessOnboardingController:rotateRefreshToken`;\n handler: SeedlessOnboardingController['rotateRefreshToken'];\n};\n\n/\n Revoke all pending refresh tokens.\n \n This method is to be called after user is authenticated.\n \n @returns A Promise that resolves to void.\n /\nexport type SeedlessOnboardingControllerRevokePendingRefreshTokensAction = {\n type: `SeedlessOnboardingController:revokePendingRefreshTokens`;\n handler: SeedlessOnboardingController['revokePendingRefreshTokens'];\n};\n\n/\n Get the access token from the state.\n \n If the tokens are expired, the method will refresh them and return the new access token.\n \n @returns The access token.\n /\nexport type SeedlessOnboardingControllerGetAccessTokenAction = {\n type: `SeedlessOnboardingController:getAccessToken`;\n handler: SeedlessOnboardingController['getAccessToken'];\n};\n\n/\n Check if the current node auth token is expired.\n \n @returns True if the current node auth token is expired, false otherwise.\n /\nexport type SeedlessOnboardingControllerCheckNodeAuthTokenExpiredAction = {\n type: `SeedlessOnboardingController:checkNodeAuthTokenExpired`;\n handler: SeedlessOnboardingController['checkNodeAuthTokenExpired'];\n};\n\n/\n Check if the current metadata access token should be refreshed.\n * Returns true when the token is expired or when less than 10% of its\n * lifetime remains (proactive refresh).\n \n @returns True if the metadata access token should be refreshed, false otherwise.\n /\nexport type SeedlessOnboardingControllerCheckMetadataAccessTokenExpiredAction =\n {\n type: `SeedlessOnboardingController:checkMetadataAccessTokenExpired`;\n handler: SeedlessOnboardingController['checkMetadataAccessTokenExpired'];\n };\n\n/\n Check if the current access token should be refreshed.\n * Returns true when the token is expired or when less than 10% of its\n * lifetime remains (proactive refresh).\n * When the vault is locked, the access token is not accessible, so we return false.\n \n @returns True if the access token should be refreshed, false otherwise.\n /\nexport type SeedlessOnboardingControllerCheckAccessTokenExpiredAction = {\n type: `SeedlessOnboardingController:checkAccessTokenExpired`;\n handler: SeedlessOnboardingController['checkAccessTokenExpired'];\n};\n\n/\n Union of all SeedlessOnboardingController action types.\n */\nexport type SeedlessOnboardingControllerMethodActions =\n \| SeedlessOnboardingControllerFetchMetadataAccessCredsAction\n \| SeedlessOnboardingControllerPreloadToprfNodeDetailsAction\n \| SeedlessOnboardingControllerAuthenticateAction\n \| SeedlessOnboardingControllerCreateToprfKeyAndBackupSeedPhraseAction\n \| SeedlessOnboardingControllerAddNewSecretDataAction\n \| SeedlessOnboardingControllerFetchAllSecretDataAction\n \| SeedlessOnboardingControllerChangePasswordAction\n \| SeedlessOnboardingControllerUpdateBackupMetadataStateAction\n \| SeedlessOnboardingControllerVerifyVaultPasswordAction\n \| SeedlessOnboardingControllerGetSecretDataBackupStateAction\n \| SeedlessOnboardingControllerSubmitPasswordAction\n \| SeedlessOnboardingControllerSetLockedAction\n \| SeedlessOnboardingControllerSyncLatestGlobalPasswordAction\n \| SeedlessOnboardingControllerSubmitGlobalPasswordAction\n \| SeedlessOnboardingControllerCheckIsPasswordOutdatedAction\n \| SeedlessOnboardingControllerGetIsUserAuthenticatedAction\n \| SeedlessOnboardingControllerClearStateAction\n \| SeedlessOnboardingControllerStoreKeyringEncryptionKeyAction\n \| SeedlessOnboardingControllerLoadKeyringEncryptionKeyAction\n \| SeedlessOnboardingControllerRefreshAuthTokensAction\n \| SeedlessOnboardingControllerRotateRefreshTokenAction\n \| SeedlessOnboardingControllerRevokePendingRefreshTokensAction\n \| SeedlessOnboardingControllerGetAccessTokenAction\n \| SeedlessOnboardingControllerCheckNodeAuthTokenExpiredAction\n \| SeedlessOnboardingControllerCheckMetadataAccessTokenExpiredAction\n \| SeedlessOnboardingControllerCheckAccessTokenExpiredAction;\n"]}
1	+ {"version":3,"file":"SeedlessOnboardingController-method-action-types.cjs","sourceRoot":"","sources":["../src/SeedlessOnboardingController-method-action-types.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*\n This file is auto generated.\n * Do not edit manually.\n /\n\nimport type { SeedlessOnboardingController } from './SeedlessOnboardingController';\n\nexport type SeedlessOnboardingControllerFetchMetadataAccessCredsAction = {\n type: `SeedlessOnboardingController:fetchMetadataAccessCreds`;\n handler: SeedlessOnboardingController['fetchMetadataAccessCreds'];\n};\n\n/\n Gets the node details for the TOPRF operations.\n * This function can be called to get the node endpoints, indexes and pubkeys and cache them locally.\n /\nexport type SeedlessOnboardingControllerPreloadToprfNodeDetailsAction = {\n type: `SeedlessOnboardingController:preloadToprfNodeDetails`;\n handler: SeedlessOnboardingController['preloadToprfNodeDetails'];\n};\n\n/\n Authenticate OAuth user using the seedless onboarding flow\n * and determine if the user is already registered or not.\n \n @param params - The parameters for authenticate OAuth user.\n * @param params.idTokens - The ID token(s) issued by OAuth verification service. Currently this array only contains a single idToken which is verified by all the nodes, in future we are considering to issue a unique idToken for each node.\n * @param params.authConnection - The social login provider.\n * @param params.authConnectionId - OAuth authConnectionId from dashboard\n * @param params.userId - user email or id from Social login\n * @param params.groupedAuthConnectionId - Optional grouped authConnectionId to be used for the authenticate request.\n * @param params.socialLoginEmail - The user email from Social login.\n * @param params.refreshToken - Refresh token issued during OAuth login. Written to state when provided.\n * @param params.revokeToken - revoke token for revoking refresh token and get new refresh token and new revoke token.\n * @param params.accessToken - Access token for pairing with profile sync auth service and to access other services.\n * @param params.metadataAccessToken - Metadata access token for accessing the metadata service before the vault is created or unlocked.\n * @param params.skipLock - Optional flag to skip acquiring the controller lock. (to prevent deadlock in case the caller already acquired the lock)\n * @returns A promise that resolves to the authentication result.\n /\nexport type SeedlessOnboardingControllerAuthenticateAction = {\n type: `SeedlessOnboardingController:authenticate`;\n handler: SeedlessOnboardingController['authenticate'];\n};\n\n/\n Create a new TOPRF encryption key using given password and backups the provided seed phrase.\n \n @param password - The password used to create new wallet and seedphrase\n * @param seedPhrase - The initial seed phrase (Mnemonic) created together with the wallet.\n * @param keyringId - The keyring id of the backup seed phrase\n * @returns A promise that resolves to the encrypted seed phrase and the encryption key.\n /\nexport type SeedlessOnboardingControllerCreateToprfKeyAndBackupSeedPhraseAction =\n {\n type: `SeedlessOnboardingController:createToprfKeyAndBackupSeedPhrase`;\n handler: SeedlessOnboardingController['createToprfKeyAndBackupSeedPhrase'];\n };\n\n/\n encrypt and add a new secret data to the metadata store.\n \n @param data - The data to add.\n * @param type - The type of the secret data.\n * @param options - Optional options object, which includes optional data to be added to the metadata store.\n * @param options.keyringId - The keyring id of the backup keyring (SRP).\n * @returns A promise that resolves to the success of the operation.\n /\nexport type SeedlessOnboardingControllerAddNewSecretDataAction = {\n type: `SeedlessOnboardingController:addNewSecretData`;\n handler: SeedlessOnboardingController['addNewSecretData'];\n};\n\n/\n Fetches all encrypted secret data and metadata for user's account from the metadata store.\n \n Decrypts the secret data and returns the decrypted secret data using the recovered encryption key from the password.\n \n @param password - The optional password used to create new wallet. If not provided, `cached Encryption Key` will be used.\n * @returns A promise that resolves to the secret data.\n /\nexport type SeedlessOnboardingControllerFetchAllSecretDataAction = {\n type: `SeedlessOnboardingController:fetchAllSecretData`;\n handler: SeedlessOnboardingController['fetchAllSecretData'];\n};\n\n/\n Update the password of the seedless onboarding flow.\n \n Changing password will also update the encryption key, metadata store and the vault with new encrypted values.\n \n @param newPassword - The new password to update.\n * @param oldPassword - The old password to verify.\n * @returns A promise that resolves to the success of the operation.\n /\nexport type SeedlessOnboardingControllerChangePasswordAction = {\n type: `SeedlessOnboardingController:changePassword`;\n handler: SeedlessOnboardingController['changePassword'];\n};\n\n/\n Update the backup metadata state for the given secret data.\n \n @param secretData - The data to backup, can be a single backup or array of backups.\n * @param secretData.keyringId - The keyring id associated with the backup secret data.\n * @param secretData.data - The secret data to update the backup metadata state.\n /\nexport type SeedlessOnboardingControllerUpdateBackupMetadataStateAction = {\n type: `SeedlessOnboardingController:updateBackupMetadataState`;\n handler: SeedlessOnboardingController['updateBackupMetadataState'];\n};\n\n/\n Verify the password validity by decrypting the vault.\n \n @param password - The password to verify.\n * @param options - Optional options object.\n * @param options.skipLock - Whether to skip the lock acquisition. (to prevent deadlock in case the caller already acquired the lock)\n * @returns A promise that resolves to the success of the operation.\n * @throws {Error} If the password is invalid or the vault is not initialized.\n /\nexport type SeedlessOnboardingControllerVerifyVaultPasswordAction = {\n type: `SeedlessOnboardingController:verifyVaultPassword`;\n handler: SeedlessOnboardingController['verifyVaultPassword'];\n};\n\n/\n Get backup state of the given secret data, from the controller state.\n \n If the given secret data is not backed up and not found in the state, it will return `undefined`.\n \n @param data - The data to get the backup state of.\n * @param type - The type of the secret data.\n * @returns The backup state of the given secret data.\n /\nexport type SeedlessOnboardingControllerGetSecretDataBackupStateAction = {\n type: `SeedlessOnboardingController:getSecretDataBackupState`;\n handler: SeedlessOnboardingController['getSecretDataBackupState'];\n};\n\n/\n Submit the password to the controller, verify the password validity and unlock the controller.\n \n This method will be used especially when user unlock the wallet.\n * The provided password will be verified against the encrypted vault, encryption key will be derived and saved in the controller state.\n \n This operation is useful when user performs some actions that requires the user password/encryption key. e.g. add new srp backup\n \n @param password - The password to submit.\n * @returns A promise that resolves to the success of the operation.\n /\nexport type SeedlessOnboardingControllerSubmitPasswordAction = {\n type: `SeedlessOnboardingController:submitPassword`;\n handler: SeedlessOnboardingController['submitPassword'];\n};\n\n/\n Set the controller to locked state, and deallocate the secrets (vault encryption key and salt).\n \n When the controller is locked, the user will not be able to perform any operations on the controller/vault.\n \n @returns A promise that resolves to the success of the operation.\n /\nexport type SeedlessOnboardingControllerSetLockedAction = {\n type: `SeedlessOnboardingController:setLocked`;\n handler: SeedlessOnboardingController['setLocked'];\n};\n\n/\n Sync the latest global password to the controller.\n * reset vault with latest globalPassword,\n * persist the latest global password authPubKey\n \n @param params - The parameters for syncing the latest global password.\n * @param params.globalPassword - The latest global password.\n * @returns A promise that resolves to the success of the operation.\n /\nexport type SeedlessOnboardingControllerSyncLatestGlobalPasswordAction = {\n type: `SeedlessOnboardingController:syncLatestGlobalPassword`;\n handler: SeedlessOnboardingController['syncLatestGlobalPassword'];\n};\n\n/\n @description Unlock the controller with the latest global password.\n \n @param params - The parameters for unlocking the controller.\n * @param params.maxKeyChainLength - The maximum chain length of the pwd encryption keys.\n * @param params.globalPassword - The latest global password.\n * @returns A promise that resolves to the success of the operation.\n /\nexport type SeedlessOnboardingControllerSubmitGlobalPasswordAction = {\n type: `SeedlessOnboardingController:submitGlobalPassword`;\n handler: SeedlessOnboardingController['submitGlobalPassword'];\n};\n\n/\n @description Check if the current password is outdated compare to the global password.\n \n @param options - Optional options object.\n * @param options.globalAuthPubKey - The global auth public key to compare with the current auth public key.\n * If not provided, the global auth public key will be fetched from the backend.\n * @param options.skipCache - If true, bypass the cache and force a fresh check.\n * @param options.skipLock - Whether to skip the lock acquisition. (to prevent deadlock in case the caller already acquired the lock)\n * @returns A promise that resolves to true if the password is outdated, false otherwise.\n /\nexport type SeedlessOnboardingControllerCheckIsPasswordOutdatedAction = {\n type: `SeedlessOnboardingController:checkIsPasswordOutdated`;\n handler: SeedlessOnboardingController['checkIsPasswordOutdated'];\n};\n\n/\n Check if the user is authenticated with the seedless onboarding flow by checking the token values in the state.\n \n This method will check the `accessToken` and `revokeToken` in the state, besides the social login authentication details.\n * If both are present, the user is authenticated.\n * If either is missing, the user is not authenticated.\n \n This method is useful when we want to check if the state has valid authenticated user details to perform vault creations.\n \n @returns True if the user is authenticated, false otherwise.\n /\nexport type SeedlessOnboardingControllerGetIsUserAuthenticatedAction = {\n type: `SeedlessOnboardingController:getIsUserAuthenticated`;\n handler: SeedlessOnboardingController['getIsUserAuthenticated'];\n};\n\n/\n Clears the current state of the SeedlessOnboardingController.\n /\nexport type SeedlessOnboardingControllerClearStateAction = {\n type: `SeedlessOnboardingController:clearState`;\n handler: SeedlessOnboardingController['clearState'];\n};\n\n/\n Store the keyring encryption key in state, encrypted under the current\n * encryption key.\n \n @param keyringEncryptionKey - The keyring encryption key.\n /\nexport type SeedlessOnboardingControllerStoreKeyringEncryptionKeyAction = {\n type: `SeedlessOnboardingController:storeKeyringEncryptionKey`;\n handler: SeedlessOnboardingController['storeKeyringEncryptionKey'];\n};\n\n/\n Load the keyring encryption key from state, decrypted under the current\n * encryption key.\n \n @returns The keyring encryption key.\n /\nexport type SeedlessOnboardingControllerLoadKeyringEncryptionKeyAction = {\n type: `SeedlessOnboardingController:loadKeyringEncryptionKey`;\n handler: SeedlessOnboardingController['loadKeyringEncryptionKey'];\n};\n\n/\n Refresh expired nodeAuthTokens, accessToken, and metadataAccessToken using\n * the stored refresh token.\n \n Concurrent callers share a single in-flight HTTP request — if a refresh is\n * already in-progress the returned promise resolves when that request settles\n * rather than firing a duplicate request with the same token.\n \n @returns A promise that resolves when the tokens have been refreshed.\n /\nexport type SeedlessOnboardingControllerRefreshAuthTokensAction = {\n type: `SeedlessOnboardingController:refreshAuthTokens`;\n handler: SeedlessOnboardingController['refreshAuthTokens'];\n};\n\n/\n Rotate the refresh token — fetch a new refresh/revoke token pair from the\n * auth service and persist the new revoke token in the vault.\n \n This method should be called after a successful JWT refresh.\n \n @returns A Promise that resolves to void.\n /\nexport type SeedlessOnboardingControllerRotateRefreshTokenAction = {\n type: `SeedlessOnboardingController:rotateRefreshToken`;\n handler: SeedlessOnboardingController['rotateRefreshToken'];\n};\n\n/\n Revoke all pending refresh tokens.\n \n This method is to be called after user is authenticated.\n \n @returns A Promise that resolves to void.\n /\nexport type SeedlessOnboardingControllerRevokePendingRefreshTokensAction = {\n type: `SeedlessOnboardingController:revokePendingRefreshTokens`;\n handler: SeedlessOnboardingController['revokePendingRefreshTokens'];\n};\n\n/\n Get the access token from the state.\n \n If the tokens are expired, the method will refresh them and return the new access token.\n \n @returns The access token.\n /\nexport type SeedlessOnboardingControllerGetAccessTokenAction = {\n type: `SeedlessOnboardingController:getAccessToken`;\n handler: SeedlessOnboardingController['getAccessToken'];\n};\n\n/\n Check if the current node auth token is expired.\n \n @returns True if the current node auth token is expired, false otherwise.\n /\nexport type SeedlessOnboardingControllerCheckNodeAuthTokenExpiredAction = {\n type: `SeedlessOnboardingController:checkNodeAuthTokenExpired`;\n handler: SeedlessOnboardingController['checkNodeAuthTokenExpired'];\n};\n\n/\n Check if the current metadata access token should be refreshed.\n * Returns true when the token is expired or when less than 10% of its\n * lifetime remains (proactive refresh).\n \n @returns True if the metadata access token should be refreshed, false otherwise.\n /\nexport type SeedlessOnboardingControllerCheckMetadataAccessTokenExpiredAction =\n {\n type: `SeedlessOnboardingController:checkMetadataAccessTokenExpired`;\n handler: SeedlessOnboardingController['checkMetadataAccessTokenExpired'];\n };\n\n/\n Check if the current access token should be refreshed.\n * Returns true when the token is expired or when less than 10% of its\n * lifetime remains (proactive refresh).\n * When the vault is locked, the access token is not accessible, so we return false.\n \n @returns True if the access token should be refreshed, false otherwise.\n /\nexport type SeedlessOnboardingControllerCheckAccessTokenExpiredAction = {\n type: `SeedlessOnboardingController:checkAccessTokenExpired`;\n handler: SeedlessOnboardingController['checkAccessTokenExpired'];\n};\n\n/\n Union of all SeedlessOnboardingController action types.\n */\nexport type SeedlessOnboardingControllerMethodActions =\n \| SeedlessOnboardingControllerFetchMetadataAccessCredsAction\n \| SeedlessOnboardingControllerPreloadToprfNodeDetailsAction\n \| SeedlessOnboardingControllerAuthenticateAction\n \| SeedlessOnboardingControllerCreateToprfKeyAndBackupSeedPhraseAction\n \| SeedlessOnboardingControllerAddNewSecretDataAction\n \| SeedlessOnboardingControllerFetchAllSecretDataAction\n \| SeedlessOnboardingControllerChangePasswordAction\n \| SeedlessOnboardingControllerUpdateBackupMetadataStateAction\n \| SeedlessOnboardingControllerVerifyVaultPasswordAction\n \| SeedlessOnboardingControllerGetSecretDataBackupStateAction\n \| SeedlessOnboardingControllerSubmitPasswordAction\n \| SeedlessOnboardingControllerSetLockedAction\n \| SeedlessOnboardingControllerSyncLatestGlobalPasswordAction\n \| SeedlessOnboardingControllerSubmitGlobalPasswordAction\n \| SeedlessOnboardingControllerCheckIsPasswordOutdatedAction\n \| SeedlessOnboardingControllerGetIsUserAuthenticatedAction\n \| SeedlessOnboardingControllerClearStateAction\n \| SeedlessOnboardingControllerStoreKeyringEncryptionKeyAction\n \| SeedlessOnboardingControllerLoadKeyringEncryptionKeyAction\n \| SeedlessOnboardingControllerRefreshAuthTokensAction\n \| SeedlessOnboardingControllerRotateRefreshTokenAction\n \| SeedlessOnboardingControllerRevokePendingRefreshTokensAction\n \| SeedlessOnboardingControllerGetAccessTokenAction\n \| SeedlessOnboardingControllerCheckNodeAuthTokenExpiredAction\n \| SeedlessOnboardingControllerCheckMetadataAccessTokenExpiredAction\n \| SeedlessOnboardingControllerCheckAccessTokenExpiredAction;\n"]}

package/dist/SeedlessOnboardingController-method-action-types.d.cts CHANGED Viewed

@@ -1,5 +1,5 @@
 /**
- * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * This file is auto generated.
  * Do not edit manually.
  */
 import type { SeedlessOnboardingController } from "./SeedlessOnboardingController.cjs";

package/dist/SeedlessOnboardingController-method-action-types.d.mts CHANGED Viewed

@@ -1,5 +1,5 @@
 /**
- * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * This file is auto generated.
  * Do not edit manually.
  */
 import type { SeedlessOnboardingController } from "./SeedlessOnboardingController.mjs";

package/dist/SeedlessOnboardingController-method-action-types.mjs CHANGED Viewed

@@ -1,5 +1,5 @@
 /**
- * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * This file is auto generated.
  * Do not edit manually.
  */
 export {};

package/dist/SeedlessOnboardingController-method-action-types.mjs.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"SeedlessOnboardingController-method-action-types.mjs","sourceRoot":"","sources":["../src/SeedlessOnboardingController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*\n This file is auto generated by `scripts/generate-method-action-types.ts`.\n * Do not edit manually.\n /\n\nimport type { SeedlessOnboardingController } from './SeedlessOnboardingController';\n\nexport type SeedlessOnboardingControllerFetchMetadataAccessCredsAction = {\n type: `SeedlessOnboardingController:fetchMetadataAccessCreds`;\n handler: SeedlessOnboardingController['fetchMetadataAccessCreds'];\n};\n\n/\n Gets the node details for the TOPRF operations.\n * This function can be called to get the node endpoints, indexes and pubkeys and cache them locally.\n /\nexport type SeedlessOnboardingControllerPreloadToprfNodeDetailsAction = {\n type: `SeedlessOnboardingController:preloadToprfNodeDetails`;\n handler: SeedlessOnboardingController['preloadToprfNodeDetails'];\n};\n\n/\n Authenticate OAuth user using the seedless onboarding flow\n * and determine if the user is already registered or not.\n \n @param params - The parameters for authenticate OAuth user.\n * @param params.idTokens - The ID token(s) issued by OAuth verification service. Currently this array only contains a single idToken which is verified by all the nodes, in future we are considering to issue a unique idToken for each node.\n * @param params.authConnection - The social login provider.\n * @param params.authConnectionId - OAuth authConnectionId from dashboard\n * @param params.userId - user email or id from Social login\n * @param params.groupedAuthConnectionId - Optional grouped authConnectionId to be used for the authenticate request.\n * @param params.socialLoginEmail - The user email from Social login.\n * @param params.refreshToken - Refresh token issued during OAuth login. Written to state when provided.\n * @param params.revokeToken - revoke token for revoking refresh token and get new refresh token and new revoke token.\n * @param params.accessToken - Access token for pairing with profile sync auth service and to access other services.\n * @param params.metadataAccessToken - Metadata access token for accessing the metadata service before the vault is created or unlocked.\n * @param params.skipLock - Optional flag to skip acquiring the controller lock. (to prevent deadlock in case the caller already acquired the lock)\n * @returns A promise that resolves to the authentication result.\n /\nexport type SeedlessOnboardingControllerAuthenticateAction = {\n type: `SeedlessOnboardingController:authenticate`;\n handler: SeedlessOnboardingController['authenticate'];\n};\n\n/\n Create a new TOPRF encryption key using given password and backups the provided seed phrase.\n \n @param password - The password used to create new wallet and seedphrase\n * @param seedPhrase - The initial seed phrase (Mnemonic) created together with the wallet.\n * @param keyringId - The keyring id of the backup seed phrase\n * @returns A promise that resolves to the encrypted seed phrase and the encryption key.\n /\nexport type SeedlessOnboardingControllerCreateToprfKeyAndBackupSeedPhraseAction =\n {\n type: `SeedlessOnboardingController:createToprfKeyAndBackupSeedPhrase`;\n handler: SeedlessOnboardingController['createToprfKeyAndBackupSeedPhrase'];\n };\n\n/\n encrypt and add a new secret data to the metadata store.\n \n @param data - The data to add.\n * @param type - The type of the secret data.\n * @param options - Optional options object, which includes optional data to be added to the metadata store.\n * @param options.keyringId - The keyring id of the backup keyring (SRP).\n * @returns A promise that resolves to the success of the operation.\n /\nexport type SeedlessOnboardingControllerAddNewSecretDataAction = {\n type: `SeedlessOnboardingController:addNewSecretData`;\n handler: SeedlessOnboardingController['addNewSecretData'];\n};\n\n/\n Fetches all encrypted secret data and metadata for user's account from the metadata store.\n \n Decrypts the secret data and returns the decrypted secret data using the recovered encryption key from the password.\n \n @param password - The optional password used to create new wallet. If not provided, `cached Encryption Key` will be used.\n * @returns A promise that resolves to the secret data.\n /\nexport type SeedlessOnboardingControllerFetchAllSecretDataAction = {\n type: `SeedlessOnboardingController:fetchAllSecretData`;\n handler: SeedlessOnboardingController['fetchAllSecretData'];\n};\n\n/\n Update the password of the seedless onboarding flow.\n \n Changing password will also update the encryption key, metadata store and the vault with new encrypted values.\n \n @param newPassword - The new password to update.\n * @param oldPassword - The old password to verify.\n * @returns A promise that resolves to the success of the operation.\n /\nexport type SeedlessOnboardingControllerChangePasswordAction = {\n type: `SeedlessOnboardingController:changePassword`;\n handler: SeedlessOnboardingController['changePassword'];\n};\n\n/\n Update the backup metadata state for the given secret data.\n \n @param secretData - The data to backup, can be a single backup or array of backups.\n * @param secretData.keyringId - The keyring id associated with the backup secret data.\n * @param secretData.data - The secret data to update the backup metadata state.\n /\nexport type SeedlessOnboardingControllerUpdateBackupMetadataStateAction = {\n type: `SeedlessOnboardingController:updateBackupMetadataState`;\n handler: SeedlessOnboardingController['updateBackupMetadataState'];\n};\n\n/\n Verify the password validity by decrypting the vault.\n \n @param password - The password to verify.\n * @param options - Optional options object.\n * @param options.skipLock - Whether to skip the lock acquisition. (to prevent deadlock in case the caller already acquired the lock)\n * @returns A promise that resolves to the success of the operation.\n * @throws {Error} If the password is invalid or the vault is not initialized.\n /\nexport type SeedlessOnboardingControllerVerifyVaultPasswordAction = {\n type: `SeedlessOnboardingController:verifyVaultPassword`;\n handler: SeedlessOnboardingController['verifyVaultPassword'];\n};\n\n/\n Get backup state of the given secret data, from the controller state.\n \n If the given secret data is not backed up and not found in the state, it will return `undefined`.\n \n @param data - The data to get the backup state of.\n * @param type - The type of the secret data.\n * @returns The backup state of the given secret data.\n /\nexport type SeedlessOnboardingControllerGetSecretDataBackupStateAction = {\n type: `SeedlessOnboardingController:getSecretDataBackupState`;\n handler: SeedlessOnboardingController['getSecretDataBackupState'];\n};\n\n/\n Submit the password to the controller, verify the password validity and unlock the controller.\n \n This method will be used especially when user unlock the wallet.\n * The provided password will be verified against the encrypted vault, encryption key will be derived and saved in the controller state.\n \n This operation is useful when user performs some actions that requires the user password/encryption key. e.g. add new srp backup\n \n @param password - The password to submit.\n * @returns A promise that resolves to the success of the operation.\n /\nexport type SeedlessOnboardingControllerSubmitPasswordAction = {\n type: `SeedlessOnboardingController:submitPassword`;\n handler: SeedlessOnboardingController['submitPassword'];\n};\n\n/\n Set the controller to locked state, and deallocate the secrets (vault encryption key and salt).\n \n When the controller is locked, the user will not be able to perform any operations on the controller/vault.\n \n @returns A promise that resolves to the success of the operation.\n /\nexport type SeedlessOnboardingControllerSetLockedAction = {\n type: `SeedlessOnboardingController:setLocked`;\n handler: SeedlessOnboardingController['setLocked'];\n};\n\n/\n Sync the latest global password to the controller.\n * reset vault with latest globalPassword,\n * persist the latest global password authPubKey\n \n @param params - The parameters for syncing the latest global password.\n * @param params.globalPassword - The latest global password.\n * @returns A promise that resolves to the success of the operation.\n /\nexport type SeedlessOnboardingControllerSyncLatestGlobalPasswordAction = {\n type: `SeedlessOnboardingController:syncLatestGlobalPassword`;\n handler: SeedlessOnboardingController['syncLatestGlobalPassword'];\n};\n\n/\n @description Unlock the controller with the latest global password.\n \n @param params - The parameters for unlocking the controller.\n * @param params.maxKeyChainLength - The maximum chain length of the pwd encryption keys.\n * @param params.globalPassword - The latest global password.\n * @returns A promise that resolves to the success of the operation.\n /\nexport type SeedlessOnboardingControllerSubmitGlobalPasswordAction = {\n type: `SeedlessOnboardingController:submitGlobalPassword`;\n handler: SeedlessOnboardingController['submitGlobalPassword'];\n};\n\n/\n @description Check if the current password is outdated compare to the global password.\n \n @param options - Optional options object.\n * @param options.globalAuthPubKey - The global auth public key to compare with the current auth public key.\n * If not provided, the global auth public key will be fetched from the backend.\n * @param options.skipCache - If true, bypass the cache and force a fresh check.\n * @param options.skipLock - Whether to skip the lock acquisition. (to prevent deadlock in case the caller already acquired the lock)\n * @returns A promise that resolves to true if the password is outdated, false otherwise.\n /\nexport type SeedlessOnboardingControllerCheckIsPasswordOutdatedAction = {\n type: `SeedlessOnboardingController:checkIsPasswordOutdated`;\n handler: SeedlessOnboardingController['checkIsPasswordOutdated'];\n};\n\n/\n Check if the user is authenticated with the seedless onboarding flow by checking the token values in the state.\n \n This method will check the `accessToken` and `revokeToken` in the state, besides the social login authentication details.\n * If both are present, the user is authenticated.\n * If either is missing, the user is not authenticated.\n \n This method is useful when we want to check if the state has valid authenticated user details to perform vault creations.\n \n @returns True if the user is authenticated, false otherwise.\n /\nexport type SeedlessOnboardingControllerGetIsUserAuthenticatedAction = {\n type: `SeedlessOnboardingController:getIsUserAuthenticated`;\n handler: SeedlessOnboardingController['getIsUserAuthenticated'];\n};\n\n/\n Clears the current state of the SeedlessOnboardingController.\n /\nexport type SeedlessOnboardingControllerClearStateAction = {\n type: `SeedlessOnboardingController:clearState`;\n handler: SeedlessOnboardingController['clearState'];\n};\n\n/\n Store the keyring encryption key in state, encrypted under the current\n * encryption key.\n \n @param keyringEncryptionKey - The keyring encryption key.\n /\nexport type SeedlessOnboardingControllerStoreKeyringEncryptionKeyAction = {\n type: `SeedlessOnboardingController:storeKeyringEncryptionKey`;\n handler: SeedlessOnboardingController['storeKeyringEncryptionKey'];\n};\n\n/\n Load the keyring encryption key from state, decrypted under the current\n * encryption key.\n \n @returns The keyring encryption key.\n /\nexport type SeedlessOnboardingControllerLoadKeyringEncryptionKeyAction = {\n type: `SeedlessOnboardingController:loadKeyringEncryptionKey`;\n handler: SeedlessOnboardingController['loadKeyringEncryptionKey'];\n};\n\n/\n Refresh expired nodeAuthTokens, accessToken, and metadataAccessToken using\n * the stored refresh token.\n \n Concurrent callers share a single in-flight HTTP request — if a refresh is\n * already in-progress the returned promise resolves when that request settles\n * rather than firing a duplicate request with the same token.\n \n @returns A promise that resolves when the tokens have been refreshed.\n /\nexport type SeedlessOnboardingControllerRefreshAuthTokensAction = {\n type: `SeedlessOnboardingController:refreshAuthTokens`;\n handler: SeedlessOnboardingController['refreshAuthTokens'];\n};\n\n/\n Rotate the refresh token — fetch a new refresh/revoke token pair from the\n * auth service and persist the new revoke token in the vault.\n \n This method should be called after a successful JWT refresh.\n \n @returns A Promise that resolves to void.\n /\nexport type SeedlessOnboardingControllerRotateRefreshTokenAction = {\n type: `SeedlessOnboardingController:rotateRefreshToken`;\n handler: SeedlessOnboardingController['rotateRefreshToken'];\n};\n\n/\n Revoke all pending refresh tokens.\n \n This method is to be called after user is authenticated.\n \n @returns A Promise that resolves to void.\n /\nexport type SeedlessOnboardingControllerRevokePendingRefreshTokensAction = {\n type: `SeedlessOnboardingController:revokePendingRefreshTokens`;\n handler: SeedlessOnboardingController['revokePendingRefreshTokens'];\n};\n\n/\n Get the access token from the state.\n \n If the tokens are expired, the method will refresh them and return the new access token.\n \n @returns The access token.\n /\nexport type SeedlessOnboardingControllerGetAccessTokenAction = {\n type: `SeedlessOnboardingController:getAccessToken`;\n handler: SeedlessOnboardingController['getAccessToken'];\n};\n\n/\n Check if the current node auth token is expired.\n \n @returns True if the current node auth token is expired, false otherwise.\n /\nexport type SeedlessOnboardingControllerCheckNodeAuthTokenExpiredAction = {\n type: `SeedlessOnboardingController:checkNodeAuthTokenExpired`;\n handler: SeedlessOnboardingController['checkNodeAuthTokenExpired'];\n};\n\n/\n Check if the current metadata access token should be refreshed.\n * Returns true when the token is expired or when less than 10% of its\n * lifetime remains (proactive refresh).\n \n @returns True if the metadata access token should be refreshed, false otherwise.\n /\nexport type SeedlessOnboardingControllerCheckMetadataAccessTokenExpiredAction =\n {\n type: `SeedlessOnboardingController:checkMetadataAccessTokenExpired`;\n handler: SeedlessOnboardingController['checkMetadataAccessTokenExpired'];\n };\n\n/\n Check if the current access token should be refreshed.\n * Returns true when the token is expired or when less than 10% of its\n * lifetime remains (proactive refresh).\n * When the vault is locked, the access token is not accessible, so we return false.\n \n @returns True if the access token should be refreshed, false otherwise.\n /\nexport type SeedlessOnboardingControllerCheckAccessTokenExpiredAction = {\n type: `SeedlessOnboardingController:checkAccessTokenExpired`;\n handler: SeedlessOnboardingController['checkAccessTokenExpired'];\n};\n\n/\n Union of all SeedlessOnboardingController action types.\n */\nexport type SeedlessOnboardingControllerMethodActions =\n \| SeedlessOnboardingControllerFetchMetadataAccessCredsAction\n \| SeedlessOnboardingControllerPreloadToprfNodeDetailsAction\n \| SeedlessOnboardingControllerAuthenticateAction\n \| SeedlessOnboardingControllerCreateToprfKeyAndBackupSeedPhraseAction\n \| SeedlessOnboardingControllerAddNewSecretDataAction\n \| SeedlessOnboardingControllerFetchAllSecretDataAction\n \| SeedlessOnboardingControllerChangePasswordAction\n \| SeedlessOnboardingControllerUpdateBackupMetadataStateAction\n \| SeedlessOnboardingControllerVerifyVaultPasswordAction\n \| SeedlessOnboardingControllerGetSecretDataBackupStateAction\n \| SeedlessOnboardingControllerSubmitPasswordAction\n \| SeedlessOnboardingControllerSetLockedAction\n \| SeedlessOnboardingControllerSyncLatestGlobalPasswordAction\n \| SeedlessOnboardingControllerSubmitGlobalPasswordAction\n \| SeedlessOnboardingControllerCheckIsPasswordOutdatedAction\n \| SeedlessOnboardingControllerGetIsUserAuthenticatedAction\n \| SeedlessOnboardingControllerClearStateAction\n \| SeedlessOnboardingControllerStoreKeyringEncryptionKeyAction\n \| SeedlessOnboardingControllerLoadKeyringEncryptionKeyAction\n \| SeedlessOnboardingControllerRefreshAuthTokensAction\n \| SeedlessOnboardingControllerRotateRefreshTokenAction\n \| SeedlessOnboardingControllerRevokePendingRefreshTokensAction\n \| SeedlessOnboardingControllerGetAccessTokenAction\n \| SeedlessOnboardingControllerCheckNodeAuthTokenExpiredAction\n \| SeedlessOnboardingControllerCheckMetadataAccessTokenExpiredAction\n \| SeedlessOnboardingControllerCheckAccessTokenExpiredAction;\n"]}
1	+ {"version":3,"file":"SeedlessOnboardingController-method-action-types.mjs","sourceRoot":"","sources":["../src/SeedlessOnboardingController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*\n This file is auto generated.\n * Do not edit manually.\n /\n\nimport type { SeedlessOnboardingController } from './SeedlessOnboardingController';\n\nexport type SeedlessOnboardingControllerFetchMetadataAccessCredsAction = {\n type: `SeedlessOnboardingController:fetchMetadataAccessCreds`;\n handler: SeedlessOnboardingController['fetchMetadataAccessCreds'];\n};\n\n/\n Gets the node details for the TOPRF operations.\n * This function can be called to get the node endpoints, indexes and pubkeys and cache them locally.\n /\nexport type SeedlessOnboardingControllerPreloadToprfNodeDetailsAction = {\n type: `SeedlessOnboardingController:preloadToprfNodeDetails`;\n handler: SeedlessOnboardingController['preloadToprfNodeDetails'];\n};\n\n/\n Authenticate OAuth user using the seedless onboarding flow\n * and determine if the user is already registered or not.\n \n @param params - The parameters for authenticate OAuth user.\n * @param params.idTokens - The ID token(s) issued by OAuth verification service. Currently this array only contains a single idToken which is verified by all the nodes, in future we are considering to issue a unique idToken for each node.\n * @param params.authConnection - The social login provider.\n * @param params.authConnectionId - OAuth authConnectionId from dashboard\n * @param params.userId - user email or id from Social login\n * @param params.groupedAuthConnectionId - Optional grouped authConnectionId to be used for the authenticate request.\n * @param params.socialLoginEmail - The user email from Social login.\n * @param params.refreshToken - Refresh token issued during OAuth login. Written to state when provided.\n * @param params.revokeToken - revoke token for revoking refresh token and get new refresh token and new revoke token.\n * @param params.accessToken - Access token for pairing with profile sync auth service and to access other services.\n * @param params.metadataAccessToken - Metadata access token for accessing the metadata service before the vault is created or unlocked.\n * @param params.skipLock - Optional flag to skip acquiring the controller lock. (to prevent deadlock in case the caller already acquired the lock)\n * @returns A promise that resolves to the authentication result.\n /\nexport type SeedlessOnboardingControllerAuthenticateAction = {\n type: `SeedlessOnboardingController:authenticate`;\n handler: SeedlessOnboardingController['authenticate'];\n};\n\n/\n Create a new TOPRF encryption key using given password and backups the provided seed phrase.\n \n @param password - The password used to create new wallet and seedphrase\n * @param seedPhrase - The initial seed phrase (Mnemonic) created together with the wallet.\n * @param keyringId - The keyring id of the backup seed phrase\n * @returns A promise that resolves to the encrypted seed phrase and the encryption key.\n /\nexport type SeedlessOnboardingControllerCreateToprfKeyAndBackupSeedPhraseAction =\n {\n type: `SeedlessOnboardingController:createToprfKeyAndBackupSeedPhrase`;\n handler: SeedlessOnboardingController['createToprfKeyAndBackupSeedPhrase'];\n };\n\n/\n encrypt and add a new secret data to the metadata store.\n \n @param data - The data to add.\n * @param type - The type of the secret data.\n * @param options - Optional options object, which includes optional data to be added to the metadata store.\n * @param options.keyringId - The keyring id of the backup keyring (SRP).\n * @returns A promise that resolves to the success of the operation.\n /\nexport type SeedlessOnboardingControllerAddNewSecretDataAction = {\n type: `SeedlessOnboardingController:addNewSecretData`;\n handler: SeedlessOnboardingController['addNewSecretData'];\n};\n\n/\n Fetches all encrypted secret data and metadata for user's account from the metadata store.\n \n Decrypts the secret data and returns the decrypted secret data using the recovered encryption key from the password.\n \n @param password - The optional password used to create new wallet. If not provided, `cached Encryption Key` will be used.\n * @returns A promise that resolves to the secret data.\n /\nexport type SeedlessOnboardingControllerFetchAllSecretDataAction = {\n type: `SeedlessOnboardingController:fetchAllSecretData`;\n handler: SeedlessOnboardingController['fetchAllSecretData'];\n};\n\n/\n Update the password of the seedless onboarding flow.\n \n Changing password will also update the encryption key, metadata store and the vault with new encrypted values.\n \n @param newPassword - The new password to update.\n * @param oldPassword - The old password to verify.\n * @returns A promise that resolves to the success of the operation.\n /\nexport type SeedlessOnboardingControllerChangePasswordAction = {\n type: `SeedlessOnboardingController:changePassword`;\n handler: SeedlessOnboardingController['changePassword'];\n};\n\n/\n Update the backup metadata state for the given secret data.\n \n @param secretData - The data to backup, can be a single backup or array of backups.\n * @param secretData.keyringId - The keyring id associated with the backup secret data.\n * @param secretData.data - The secret data to update the backup metadata state.\n /\nexport type SeedlessOnboardingControllerUpdateBackupMetadataStateAction = {\n type: `SeedlessOnboardingController:updateBackupMetadataState`;\n handler: SeedlessOnboardingController['updateBackupMetadataState'];\n};\n\n/\n Verify the password validity by decrypting the vault.\n \n @param password - The password to verify.\n * @param options - Optional options object.\n * @param options.skipLock - Whether to skip the lock acquisition. (to prevent deadlock in case the caller already acquired the lock)\n * @returns A promise that resolves to the success of the operation.\n * @throws {Error} If the password is invalid or the vault is not initialized.\n /\nexport type SeedlessOnboardingControllerVerifyVaultPasswordAction = {\n type: `SeedlessOnboardingController:verifyVaultPassword`;\n handler: SeedlessOnboardingController['verifyVaultPassword'];\n};\n\n/\n Get backup state of the given secret data, from the controller state.\n \n If the given secret data is not backed up and not found in the state, it will return `undefined`.\n \n @param data - The data to get the backup state of.\n * @param type - The type of the secret data.\n * @returns The backup state of the given secret data.\n /\nexport type SeedlessOnboardingControllerGetSecretDataBackupStateAction = {\n type: `SeedlessOnboardingController:getSecretDataBackupState`;\n handler: SeedlessOnboardingController['getSecretDataBackupState'];\n};\n\n/\n Submit the password to the controller, verify the password validity and unlock the controller.\n \n This method will be used especially when user unlock the wallet.\n * The provided password will be verified against the encrypted vault, encryption key will be derived and saved in the controller state.\n \n This operation is useful when user performs some actions that requires the user password/encryption key. e.g. add new srp backup\n \n @param password - The password to submit.\n * @returns A promise that resolves to the success of the operation.\n /\nexport type SeedlessOnboardingControllerSubmitPasswordAction = {\n type: `SeedlessOnboardingController:submitPassword`;\n handler: SeedlessOnboardingController['submitPassword'];\n};\n\n/\n Set the controller to locked state, and deallocate the secrets (vault encryption key and salt).\n \n When the controller is locked, the user will not be able to perform any operations on the controller/vault.\n \n @returns A promise that resolves to the success of the operation.\n /\nexport type SeedlessOnboardingControllerSetLockedAction = {\n type: `SeedlessOnboardingController:setLocked`;\n handler: SeedlessOnboardingController['setLocked'];\n};\n\n/\n Sync the latest global password to the controller.\n * reset vault with latest globalPassword,\n * persist the latest global password authPubKey\n \n @param params - The parameters for syncing the latest global password.\n * @param params.globalPassword - The latest global password.\n * @returns A promise that resolves to the success of the operation.\n /\nexport type SeedlessOnboardingControllerSyncLatestGlobalPasswordAction = {\n type: `SeedlessOnboardingController:syncLatestGlobalPassword`;\n handler: SeedlessOnboardingController['syncLatestGlobalPassword'];\n};\n\n/\n @description Unlock the controller with the latest global password.\n \n @param params - The parameters for unlocking the controller.\n * @param params.maxKeyChainLength - The maximum chain length of the pwd encryption keys.\n * @param params.globalPassword - The latest global password.\n * @returns A promise that resolves to the success of the operation.\n /\nexport type SeedlessOnboardingControllerSubmitGlobalPasswordAction = {\n type: `SeedlessOnboardingController:submitGlobalPassword`;\n handler: SeedlessOnboardingController['submitGlobalPassword'];\n};\n\n/\n @description Check if the current password is outdated compare to the global password.\n \n @param options - Optional options object.\n * @param options.globalAuthPubKey - The global auth public key to compare with the current auth public key.\n * If not provided, the global auth public key will be fetched from the backend.\n * @param options.skipCache - If true, bypass the cache and force a fresh check.\n * @param options.skipLock - Whether to skip the lock acquisition. (to prevent deadlock in case the caller already acquired the lock)\n * @returns A promise that resolves to true if the password is outdated, false otherwise.\n /\nexport type SeedlessOnboardingControllerCheckIsPasswordOutdatedAction = {\n type: `SeedlessOnboardingController:checkIsPasswordOutdated`;\n handler: SeedlessOnboardingController['checkIsPasswordOutdated'];\n};\n\n/\n Check if the user is authenticated with the seedless onboarding flow by checking the token values in the state.\n \n This method will check the `accessToken` and `revokeToken` in the state, besides the social login authentication details.\n * If both are present, the user is authenticated.\n * If either is missing, the user is not authenticated.\n \n This method is useful when we want to check if the state has valid authenticated user details to perform vault creations.\n \n @returns True if the user is authenticated, false otherwise.\n /\nexport type SeedlessOnboardingControllerGetIsUserAuthenticatedAction = {\n type: `SeedlessOnboardingController:getIsUserAuthenticated`;\n handler: SeedlessOnboardingController['getIsUserAuthenticated'];\n};\n\n/\n Clears the current state of the SeedlessOnboardingController.\n /\nexport type SeedlessOnboardingControllerClearStateAction = {\n type: `SeedlessOnboardingController:clearState`;\n handler: SeedlessOnboardingController['clearState'];\n};\n\n/\n Store the keyring encryption key in state, encrypted under the current\n * encryption key.\n \n @param keyringEncryptionKey - The keyring encryption key.\n /\nexport type SeedlessOnboardingControllerStoreKeyringEncryptionKeyAction = {\n type: `SeedlessOnboardingController:storeKeyringEncryptionKey`;\n handler: SeedlessOnboardingController['storeKeyringEncryptionKey'];\n};\n\n/\n Load the keyring encryption key from state, decrypted under the current\n * encryption key.\n \n @returns The keyring encryption key.\n /\nexport type SeedlessOnboardingControllerLoadKeyringEncryptionKeyAction = {\n type: `SeedlessOnboardingController:loadKeyringEncryptionKey`;\n handler: SeedlessOnboardingController['loadKeyringEncryptionKey'];\n};\n\n/\n Refresh expired nodeAuthTokens, accessToken, and metadataAccessToken using\n * the stored refresh token.\n \n Concurrent callers share a single in-flight HTTP request — if a refresh is\n * already in-progress the returned promise resolves when that request settles\n * rather than firing a duplicate request with the same token.\n \n @returns A promise that resolves when the tokens have been refreshed.\n /\nexport type SeedlessOnboardingControllerRefreshAuthTokensAction = {\n type: `SeedlessOnboardingController:refreshAuthTokens`;\n handler: SeedlessOnboardingController['refreshAuthTokens'];\n};\n\n/\n Rotate the refresh token — fetch a new refresh/revoke token pair from the\n * auth service and persist the new revoke token in the vault.\n \n This method should be called after a successful JWT refresh.\n \n @returns A Promise that resolves to void.\n /\nexport type SeedlessOnboardingControllerRotateRefreshTokenAction = {\n type: `SeedlessOnboardingController:rotateRefreshToken`;\n handler: SeedlessOnboardingController['rotateRefreshToken'];\n};\n\n/\n Revoke all pending refresh tokens.\n \n This method is to be called after user is authenticated.\n \n @returns A Promise that resolves to void.\n /\nexport type SeedlessOnboardingControllerRevokePendingRefreshTokensAction = {\n type: `SeedlessOnboardingController:revokePendingRefreshTokens`;\n handler: SeedlessOnboardingController['revokePendingRefreshTokens'];\n};\n\n/\n Get the access token from the state.\n \n If the tokens are expired, the method will refresh them and return the new access token.\n \n @returns The access token.\n /\nexport type SeedlessOnboardingControllerGetAccessTokenAction = {\n type: `SeedlessOnboardingController:getAccessToken`;\n handler: SeedlessOnboardingController['getAccessToken'];\n};\n\n/\n Check if the current node auth token is expired.\n \n @returns True if the current node auth token is expired, false otherwise.\n /\nexport type SeedlessOnboardingControllerCheckNodeAuthTokenExpiredAction = {\n type: `SeedlessOnboardingController:checkNodeAuthTokenExpired`;\n handler: SeedlessOnboardingController['checkNodeAuthTokenExpired'];\n};\n\n/\n Check if the current metadata access token should be refreshed.\n * Returns true when the token is expired or when less than 10% of its\n * lifetime remains (proactive refresh).\n \n @returns True if the metadata access token should be refreshed, false otherwise.\n /\nexport type SeedlessOnboardingControllerCheckMetadataAccessTokenExpiredAction =\n {\n type: `SeedlessOnboardingController:checkMetadataAccessTokenExpired`;\n handler: SeedlessOnboardingController['checkMetadataAccessTokenExpired'];\n };\n\n/\n Check if the current access token should be refreshed.\n * Returns true when the token is expired or when less than 10% of its\n * lifetime remains (proactive refresh).\n * When the vault is locked, the access token is not accessible, so we return false.\n \n @returns True if the access token should be refreshed, false otherwise.\n /\nexport type SeedlessOnboardingControllerCheckAccessTokenExpiredAction = {\n type: `SeedlessOnboardingController:checkAccessTokenExpired`;\n handler: SeedlessOnboardingController['checkAccessTokenExpired'];\n};\n\n/\n Union of all SeedlessOnboardingController action types.\n */\nexport type SeedlessOnboardingControllerMethodActions =\n \| SeedlessOnboardingControllerFetchMetadataAccessCredsAction\n \| SeedlessOnboardingControllerPreloadToprfNodeDetailsAction\n \| SeedlessOnboardingControllerAuthenticateAction\n \| SeedlessOnboardingControllerCreateToprfKeyAndBackupSeedPhraseAction\n \| SeedlessOnboardingControllerAddNewSecretDataAction\n \| SeedlessOnboardingControllerFetchAllSecretDataAction\n \| SeedlessOnboardingControllerChangePasswordAction\n \| SeedlessOnboardingControllerUpdateBackupMetadataStateAction\n \| SeedlessOnboardingControllerVerifyVaultPasswordAction\n \| SeedlessOnboardingControllerGetSecretDataBackupStateAction\n \| SeedlessOnboardingControllerSubmitPasswordAction\n \| SeedlessOnboardingControllerSetLockedAction\n \| SeedlessOnboardingControllerSyncLatestGlobalPasswordAction\n \| SeedlessOnboardingControllerSubmitGlobalPasswordAction\n \| SeedlessOnboardingControllerCheckIsPasswordOutdatedAction\n \| SeedlessOnboardingControllerGetIsUserAuthenticatedAction\n \| SeedlessOnboardingControllerClearStateAction\n \| SeedlessOnboardingControllerStoreKeyringEncryptionKeyAction\n \| SeedlessOnboardingControllerLoadKeyringEncryptionKeyAction\n \| SeedlessOnboardingControllerRefreshAuthTokensAction\n \| SeedlessOnboardingControllerRotateRefreshTokenAction\n \| SeedlessOnboardingControllerRevokePendingRefreshTokensAction\n \| SeedlessOnboardingControllerGetAccessTokenAction\n \| SeedlessOnboardingControllerCheckNodeAuthTokenExpiredAction\n \| SeedlessOnboardingControllerCheckMetadataAccessTokenExpiredAction\n \| SeedlessOnboardingControllerCheckAccessTokenExpiredAction;\n"]}

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/seedless-onboarding-controller",
-  "version": "9.0.0-preview-84c63ff0e",
+  "version": "9.0.0-preview-2d89a26",
   "description": "Backup and rehydrate SRP(s) using social login and password",
   "keywords": [
     "MetaMask",