internal: incomplete vault systems behind feature flag (#2340)

packages/services/src/Domain/Vaults/VaultServiceInterface.ts

@@ -0,0 +1,47 @@
+import {
+  DecryptedItemInterface,
+  KeySystemIdentifier,
+  KeySystemRootKeyStorageMode,
+  VaultListingInterface,
+} from '@standardnotes/models'
+import { AbstractService } from '../Service/AbstractService'
+import { VaultServiceEvent, VaultServiceEventPayload } from './VaultServiceEvent'
+import { ChangeVaultOptionsDTO } from './ChangeVaultOptionsDTO'
+
+export interface VaultServiceInterface
+  extends AbstractService<VaultServiceEvent, VaultServiceEventPayload[VaultServiceEvent]> {
+  createRandomizedVault(dto: {
+    name: string
+    description?: string
+    storagePreference: KeySystemRootKeyStorageMode
+  }): Promise<VaultListingInterface>
+  createUserInputtedPasswordVault(dto: {
+    name: string
+    description?: string
+    userInputtedPassword: string
+    storagePreference: KeySystemRootKeyStorageMode
+  }): Promise<VaultListingInterface>
+
+  getVaults(): VaultListingInterface[]
+  getVault(dto: { keySystemIdentifier: KeySystemIdentifier }): VaultListingInterface | undefined
+  getLockedvaults(): VaultListingInterface[]
+  deleteVault(vault: VaultListingInterface): Promise<boolean>
+
+  moveItemToVault(
+    vault: VaultListingInterface,
+    item: DecryptedItemInterface,
+  ): Promise<DecryptedItemInterface | undefined>
+  removeItemFromVault(item: DecryptedItemInterface): Promise<DecryptedItemInterface>
+  isItemInVault(item: DecryptedItemInterface): boolean
+  getItemVault(item: DecryptedItemInterface): VaultListingInterface | undefined
+
+  changeVaultNameAndDescription(
+    vault: VaultListingInterface,
+    params: { name: string; description: string },
+  ): Promise<VaultListingInterface>
+  rotateVaultRootKey(vault: VaultListingInterface): Promise<void>
+  changeVaultOptions(dto: ChangeVaultOptionsDTO): Promise<void>
+
+  isVaultLocked(vault: VaultListingInterface): boolean
+  unlockNonPersistentVault(vault: VaultListingInterface, password: string): Promise<boolean>
+}