[Bitwarden] Add lock vault command (#6627)

* feat: implement lock-vault command

* feat: add custom icon to lock-vault command

* refactor: extract constant for vault lock messages

* chore: update changelog

* refactor: rename function

* refactor: call showToast instead of modifying existing one

extensions/bitwarden/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Bitwarden Changelog
 
+## [New Command] - 2023-05-18
+
+- Add Lock Vault command
+
 ## [Fix] - 2023-05-16
 
 - Fixed Generate Password (Quick) command not copying password before pasting

extensions/bitwarden/package.json

@@ -159,6 +159,14 @@
           ]
         }
       ]
+    },
+    {
+      "name": "lock-vault",
+      "title": "Lock Vault",
+      "subtitle": "Bitwarden",
+      "description": "Lock your bitwarden vault",
+      "icon": "lock-vault.png",
+      "mode": "no-view"
     }
   ],
   "preferences": [

extensions/bitwarden/src/components/searchVault/actions/CommonActions.tsx

@@ -1,4 +1,5 @@
 import { Action, Color, Icon, showToast, Toast } from "@raycast/api";
+import { VAULT_LOCK_MESSAGES } from "~/constants/general";
 import { useBitwarden } from "~/context/bitwarden";
 import { useVault } from "~/context/vault";
 
@@ -8,7 +9,7 @@ function SearchCommonActions() {
 
   const handleLockVault = async () => {
     const toast = await showToast(Toast.Style.Animated, "Locking Vault...", "Please wait");
-    await bitwarden.lock("Manually locked by the user");
+    await bitwarden.lock(VAULT_LOCK_MESSAGES.MANUAL);
     await toast.hide();
   };
 

extensions/bitwarden/src/constants/general.ts

@@ -13,3 +13,8 @@ export const LOCAL_STORAGE_KEY = {
   LAST_ACTIVITY_TIME: "lastActivityTime",
   VAULT_LOCK_REASON: "vaultLockReason",
 };
+
+export const VAULT_LOCK_MESSAGES = {
+  TIMEOUT: "Vault timed out due to inactivity",
+  MANUAL: "Manually locked by the user",
+};

extensions/bitwarden/src/context/session/session.tsx

@@ -3,7 +3,7 @@ import { createContext, PropsWithChildren, useContext, useMemo } from "react";
 import UnlockForm from "~/components/UnlockForm";
 import { useBitwarden } from "~/context/bitwarden";
 import { useSessionReducer } from "~/context/session/reducer";
-import { getSavedSession, Storage } from "~/context/session/utils";
+import { getSavedSession, SessionStorage } from "~/context/session/utils";
 import { Cache } from "~/utils/cache";
 import { captureException } from "~/utils/development";
 import { VaultIsLockedError } from "~/utils/errors";
@@ -53,17 +53,17 @@ export function SessionProvider(props: SessionProviderProps) {
 
   async function handleUnlock(password: string, token: string) {
     const passwordHash = await hashMasterPasswordForReprompting(password);
-    await Storage.saveSession(token, passwordHash);
+    await SessionStorage.saveSession(token, passwordHash);
     dispatch({ type: "unlock", token, passwordHash });
   }
 
   async function handleLock(reason?: string) {
-    await Storage.clearSession();
+    await SessionStorage.clearSession();
     dispatch({ type: "lock", lockReason: reason });
   }
 
   async function handleLogout() {
-    await Storage.clearSession();
+    await SessionStorage.clearSession();
     Cache.clear();
     dispatch({ type: "logout" });
   }

extensions/bitwarden/src/context/session/utils.ts

@@ -1,10 +1,10 @@
 import { getPreferenceValues, LocalStorage } from "@raycast/api";
-import { LOCAL_STORAGE_KEY } from "~/constants/general";
+import { LOCAL_STORAGE_KEY, VAULT_LOCK_MESSAGES } from "~/constants/general";
 import { VAULT_TIMEOUT } from "~/constants/preferences";
 import { Preferences } from "~/types/preferences";
 import { SessionState } from "~/types/session";
 
-export const Storage = {
+export const SessionStorage = {
   getSavedSession: () => {
     return Promise.all([
       LocalStorage.getItem<string>(LOCAL_STORAGE_KEY.SESSION_TOKEN),
@@ -34,10 +34,8 @@ export type SavedSessionState = {
   lockReason?: string;
 };
 
-const VAULT_TIMEOUT_MESSAGE = "Vault timed out due to inactivity";
-
 export async function getSavedSession(): Promise<SavedSessionState> {
-  const [token, passwordHash, lastActivityTimeString] = await Storage.getSavedSession();
+  const [token, passwordHash, lastActivityTimeString] = await SessionStorage.getSavedSession();
   if (!token || !passwordHash) return { shouldLockVault: true };
 
   const loadedState: SavedSessionState = { token, passwordHash };
@@ -50,7 +48,7 @@ export async function getSavedSession(): Promise<SavedSessionState> {
 
   const timeElapseSinceLastPasswordEnter = Date.now() - lastActivityTime.getTime();
   if (vaultTimeoutMs === VAULT_TIMEOUT.IMMEDIATELY || timeElapseSinceLastPasswordEnter >= vaultTimeoutMs) {
-    return { ...loadedState, shouldLockVault: true, lockReason: VAULT_TIMEOUT_MESSAGE };
+    return { ...loadedState, shouldLockVault: true, lockReason: VAULT_LOCK_MESSAGES.TIMEOUT };
   }
 
   return { ...loadedState, shouldLockVault: false };

extensions/bitwarden/src/lock-vault.tsx

@@ -0,0 +1,25 @@
+import { showToast, Toast } from "@raycast/api";
+import { Bitwarden } from "~/api/bitwarden";
+import { VAULT_LOCK_MESSAGES } from "~/constants/general";
+import { SessionStorage } from "~/context/session/utils";
+
+async function lockVaultCommand() {
+  try {
+    await showToast(Toast.Style.Animated, "Locking vault...", "Please wait");
+    const [token] = await SessionStorage.getSavedSession();
+    if (!token) {
+      await showToast(Toast.Style.Failure, "No session found", "Already locked or not logged in");
+      return;
+    }
+
+    const bitwarden = await new Bitwarden().initialize();
+    await bitwarden.withSession(token).lock(VAULT_LOCK_MESSAGES.MANUAL);
+    await SessionStorage.clearSession();
+
+    await showToast(Toast.Style.Success, "Vault successfully locked");
+  } catch (error) {
+    await showToast(Toast.Style.Failure, "Failed to lock vault");
+  }
+}
+
+export default lockVaultCommand;