feat: experimental 005 operator (#1753)

packages/encryption/src/Domain/Service/Encryption/EncryptionProviderInterface.ts

@@ -0,0 +1,54 @@
+import { ProtocolVersion } from '@standardnotes/common'
+import {
+  BackupFile,
+  DecryptedPayloadInterface,
+  EncryptedPayloadInterface,
+  ItemContent,
+  RootKeyInterface,
+} from '@standardnotes/models'
+import { ClientDisplayableError } from '@standardnotes/responses'
+import { SNRootKeyParams } from '../../Keys/RootKey/RootKeyParams'
+import { KeyedDecryptionSplit } from '../../Split/KeyedDecryptionSplit'
+import { KeyedEncryptionSplit } from '../../Split/KeyedEncryptionSplit'
+
+export interface EncryptionProviderInterface {
+  encryptSplitSingle(split: KeyedEncryptionSplit): Promise<EncryptedPayloadInterface>
+
+  encryptSplit(split: KeyedEncryptionSplit): Promise<EncryptedPayloadInterface[]>
+
+  decryptSplitSingle<
+    C extends ItemContent = ItemContent,
+    P extends DecryptedPayloadInterface<C> = DecryptedPayloadInterface<C>,
+  >(
+    split: KeyedDecryptionSplit,
+  ): Promise<P | EncryptedPayloadInterface>
+
+  decryptSplit<
+    C extends ItemContent = ItemContent,
+    P extends DecryptedPayloadInterface<C> = DecryptedPayloadInterface<C>,
+  >(
+    split: KeyedDecryptionSplit,
+  ): Promise<(P | EncryptedPayloadInterface)[]>
+
+  hasRootKeyEncryptionSource(): boolean
+
+  getKeyEmbeddedKeyParams(key: EncryptedPayloadInterface): SNRootKeyParams | undefined
+
+  computeRootKey(password: string, keyParams: SNRootKeyParams): Promise<RootKeyInterface>
+
+  /**
+   * @returns The versions that this library supports.
+   */
+  supportedVersions(): ProtocolVersion[]
+
+  getUserVersion(): ProtocolVersion | undefined
+
+  /**
+   * Decrypts a backup file using user-inputted password
+   * @param password - The raw user password associated with this backup file
+   */
+  decryptBackupFile(
+    file: BackupFile,
+    password?: string,
+  ): Promise<ClientDisplayableError | (EncryptedPayloadInterface | DecryptedPayloadInterface)[]>
+}