orgnote-api 0.12.2 → 0.12.3

package/api.ts

@@ -0,0 +1,119 @@
+import {
+  Command,
+  CSSVariable,
+  ThemeVariable,
+  Note,
+  InlineEmbeddedWidget,
+  MultilineEmbeddedWidget,
+  OrgLineClass,
+  WidgetBuilder,
+  CommandPreview,
+  OrgNoteEncryption,
+  Modal,
+} from './models';
+import type { NavigationFailure } from 'vue-router';
+import { WidgetType } from './models/widget-type';
+import type { Component } from 'vue';
+import { NodeType } from 'org-mode-ast';
+import { EditorExtension } from './models/editor';
+
+type WithNodeType<T> = { nodeType: NodeType } & T;
+
+export type WidgetMeta =
+  | ({ type: WidgetType.Inline } & WithNodeType<InlineEmbeddedWidget>)
+  | ({ type: WidgetType.Multiline } & WithNodeType<MultilineEmbeddedWidget>)
+  | ({ type: WidgetType.LineClass } & WithNodeType<OrgLineClass>);
+
+export interface OrgNoteApi {
+  [key: string]: unknown;
+  getExtension?<T>(config: string): T;
+
+  system: {
+    reload: (params?: { verbose: boolean }) => Promise<void>;
+    setNewFilesAvailable: (status?: boolean) => void;
+  };
+  navigation: {
+    openNote: (id: string) => Promise<void | NavigationFailure>;
+    editNote: (id: string) => Promise<void | NavigationFailure>;
+  };
+  ui: {
+    applyTheme: (theme: { [key in ThemeVariable]: string | number }) => void;
+    applyCssVariables: (styles: {
+      [key in CSSVariable]: string | number;
+    }) => void;
+    setThemeByMode: (themeName?: string) => void;
+    setDarkTheme: (themeName?: string) => void;
+    setLightTheme: (themeName?: string) => void;
+    applyStyles: (scopeName: string, styles: string) => void;
+    removeStyles: (scopeName: string) => void;
+    resetTheme: () => void;
+    openModal: (modal: Modal) => void;
+  };
+  interaction: {
+    confirm: (title: string, message: string) => Promise<boolean>;
+  };
+  currentNote: {
+    get: () => Note;
+  };
+  editor: {
+    extensions: {
+      add: (...extension: EditorExtension[]) => void;
+      remove: (...extension: EditorExtension[]) => void;
+    };
+    widgets: {
+      add: (...widgetMeta: WidgetMeta[]) => void;
+      createWidgetBuilder: (
+        cmp: Component,
+        props?: { [key: string]: unknown }
+      ) => WidgetBuilder;
+    };
+  };
+  // Available only on mobile apps
+  fileSystem: {
+    readPath: () => Promise<string>;
+  };
+  commands: {
+    add(...commands: Command[]): void;
+    remove(...commands: Command[]): void;
+    get(name: string): Command;
+    getAll(): Command[];
+    addCommandToSidebar(...commands: CommandPreview[]): void;
+    removeCommandFromSidebar(...commands: CommandPreview[]): void;
+    addCommandToEditorPanel(...commands: CommandPreview[]): void;
+    removeCommandFromEditorPanel(...commands: CommandPreview[]): void;
+  };
+  configuration: () => OrgNoteConfig;
+}
+
+// TODO: master move model to the backend service
+export interface OrgNoteConfig {
+  editor: {
+    showSpecialSymbols: boolean;
+    showPropertyDrawer: boolean;
+  };
+  developer: {
+    developerMode: boolean;
+    maximumLogsCount: number;
+  };
+  completion: {
+    showGroup: boolean;
+    defaultCompletionLimit: number;
+  };
+  system: {
+    language: string;
+  };
+  synchronization: {
+    type: 'none' | 'api' | 'filesystem';
+    path?: string;
+  };
+  ui: {
+    showUserProfiles: boolean;
+    theme: 'light' | 'dark' | 'auto';
+    darkThemeName?: string;
+    lightThemeName?: string;
+  };
+  extensions: {
+    sources: string[];
+  };
+  encryption: OrgNoteEncryption;
+}

package/encryption/__tests__/__snapshots__/note-encryption.spec.ts.snap

@@ -0,0 +1,185 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`Should decrypt note content via password 1`] = `
+{
+  "content": "#+ID: qweqwe
+#+TITLE: Hello worlld
+
+* Hello?",
+  "encrypted": false,
+  "encryptionType": "gpgPassword",
+  "id": "id",
+  "meta": {
+    "headings": [
+      {
+        "level": 1,
+        "title": "Hello?",
+      },
+    ],
+    "id": "qweqwe",
+    "title": "Hello worlld",
+  },
+}
+`;
+
+exports[`Should decrypt note via provided keys 1`] = `
+{
+  "content": "#+ID: qweqwe
+#+TITLE: Hello worlld
+
+* Hello?",
+  "encrypted": false,
+  "encryptionType": "gpgKeys",
+  "id": "id",
+  "meta": {
+    "headings": [
+      {
+        "level": 1,
+        "title": "Hello?",
+      },
+    ],
+    "id": "qweqwe",
+    "title": "Hello worlld",
+  },
+}
+`;
+
+exports[`Should encrypt note content via password 1`] = `
+{
+  "author": {
+    "email": "test@mail.com",
+    "id": "1",
+    "name": "John Doe",
+  },
+  "encrypted": true,
+  "encryptionType": "gpgPassword",
+  "id": "id",
+  "meta": {
+    "id": undefined,
+    "published": false,
+  },
+}
+`;
+
+exports[`Should encrypt note via keys 1`] = `
+{
+  "author": {
+    "email": "test@mail.com",
+    "id": "1",
+    "name": "John Doe",
+  },
+  "encrypted": true,
+  "encryptionType": "gpgKeys",
+  "id": "id",
+  "meta": {
+    "id": undefined,
+    "published": false,
+  },
+}
+`;
+
+exports[`Should encrypt note with empty encrypted property 1`] = `
+{
+  "author": {
+    "email": "test@mail.com",
+    "id": "1",
+    "name": "John Doe",
+  },
+  "encrypted": true,
+  "id": "id",
+  "meta": {
+    "id": undefined,
+    "published": false,
+  },
+}
+`;
+
+exports[`Should not decrypt note without provided encrypted type 1`] = `
+{
+  "author": {
+    "email": "test@mail.com",
+    "id": "1",
+    "name": "John Doe",
+  },
+  "content": "#+ID: qweqwe
+#+TITLE: Hello worlld
+
+* Hello?",
+  "encrypted": false,
+  "id": "id",
+  "meta": {
+    "description": "Awesome description",
+    "images": [],
+    "published": false,
+    "title": "My note title",
+  },
+}
+`;
+
+exports[`Should not encrypt public note 1`] = `
+{
+  "author": {
+    "email": "test@mail.com",
+    "id": "1",
+    "name": "John Doe",
+  },
+  "content": "#+ID: qweqwe
+#+TITLE: Hello worlld
+
+* Hello?",
+  "encrypted": false,
+  "encryptionType": "gpgPassword",
+  "id": "id",
+  "meta": {
+    "description": "Awesome description",
+    "images": [],
+    "published": true,
+    "title": "My note title",
+  },
+}
+`;
+
+exports[`Should set not encrypted status when params type does not provided 1`] = `
+{
+  "content": "-----BEGIN PGP MESSAGE-----
+
+wcFMA/vryg+TTn0rAQ//TBFRjKmjRQoLhSrgeH+NbsZXbxvo7Ey4k+BQ9XA5
++CMpXH9uFUxsSaI5+McUSEt32VI17HRpXQDCL9nwaWqWOanMaRe0tXXhtox2
+gfe2f/6zsge9ux+mXF2BG4z+V5T8XIOrfzxosVprdJHZHM3x7cW5USQ0t2i2
+FiOUWxSZO1899J3yICpMvhDXvTLVZuKpSNQho5PyXSeZa83eN+uYkhgt9lsk
+0KW88Nr435S6n6mVw/zpitXIgEKpkqh46mhG+1W3aC0lYx6j9lHm3bjtdb4r
+2mtZbWKwfdBggEy8qEeiUeslvKd6uWtEccomzFgJkaqWVGknLmrBdHfztRIV
+fbZhxHz+J3GFOIgXf/5+fv+zg0nTazgz1mDUfnTHw3+qcAyEJ0ADdyg9EZc+
+bKbK0GwzMDPQeM+cCRDWUTiIa1ruyEETiwMdhWUDztF8XxY2o8jXPerZ0NhG
+R8l+SvAdYQQXPfxEh9lA3thkyz/Vp72pW46lUeJHGSq/fS6KIdLHLP9Z2e1J
+aCFpNMgyAN+BaXwnbLZfz6k5hV8awbRScSWQLEg69D9b287SFDPOYW7OZikn
+CKXL7xyQ5LrWJZN9Z/UPGjy+PdEw1SBhyluW6DQ+Sz1j4K8USTLqY89EInDl
+G7AxHGujR9UkUGyUvvc71XW7jEOogiDgn1ZMoj9Y58LSweUB8vfkY3VF84Fy
+zGVvLFWnFbtnWuoQC4OOXv1F6ETdmEsSMEMWKzRLDGPyqNX7FhG3cejlEuiK
+EsT5oQhz00RECmnR8mJkGmJhzWmmeoQvaucFqhTOZjvYl9ivuEMBZ2jtkdHn
+R6UNcNZRpCbfnl7YoikqbGBgqDFYydFGHXKHDpYhcQYWJsMDUayzUiPtzmaE
+tgfTgNNqgPxkLnWA99KYNU8DH+FwgaYBuw9dwdqwcjxSbZjHhCFGUfsqM+ik
+O9gcoAwVO1usODlESU7OWuSF2tIv5DBG5rhlSyxBp4d4aWmaumTswAdojy2O
+sM70ETbg0mC8niW9lNsgJp55oFmlksvzjUIit5rBEr55rtPcJSgakPpR2yvd
+Q4XjybUmV0IdONMhk/OlqaBPtnA0RG+qTcm7oP1qH/m5zRA0ZplVQ5ylkQwr
+LwGq5JQpJkgxxgLIrUbbtzYBShXSr5c1XXR0LIRiNgtb6s1s4mt+fbyExdJF
++ceuu+/xYrW/YTuEJpHxLiZ+aNPW5g5Y7Hbqu3hp3UL/kD44cc8JjZh18spX
+p/ncojDhF2r2vhR+CndYcMkpGMV+t1pGKC8wlcFc7lb9GJASnqMGvhQmvIaG
+gO/x7UjuTZSBW+kITHHZJDqYryKUv1j0CkHxIn9tWsYOpa1giOFtXX5v0AAM
+AJR/s/beLlqwCsUdYnw1TkP/0u0ZK3RPio1nJ7S6ckPfsM7DqCWD8ILD8Cdr
+cuzQrWaE30t5PXx53xBPO+6t5wKfDL35WHWG1Irmvz9UuT7tDS3IzwtF4ijF
+PX6alTbxGnoHgZ4bG4J1wfpTNPppP1gJeVg67VqOypzdZi+SjofMWnFgRFmD
+yEN8xpFUs7A9xryVZOosp9Sfe3IbBkO99sAQ7jV4EoMYk3/GKA==
+=LjkG
+-----END PGP MESSAGE-----",
+  "encrypted": true,
+  "encryptionType": "gpgKeys",
+  "id": "id",
+  "meta": {
+    "description": "Awesome description",
+    "images": [],
+    "published": false,
+    "title": "My note title for decryption via keys",
+  },
+}
+`;

package/encryption/__tests__/encryption-keys.ts

@@ -0,0 +1,163 @@
+export const armoredPublicKey = `-----BEGIN PGP PUBLIC KEY BLOCK-----
+
+mQINBGYaZm0BEADfaOXr8cXcU3esPh7gBRqgdUNl/qNFVUOkfoaxMK0m2uDrI03w
+leH7LiEa7zJ1R9SJXgCA8vhGHpdiqZCCDKePCXofDeB0D52ryvgUxY6pVY2mlsgl
+lOGVeajiIMv+nNj0g1J85/8KRWz2cvvElhNOlmRJT5l7E+o2s0nDnimbzqlFtP7A
+nU6WgElHgeIdEfv+YFiEjl1UkwXV5HLh9nXCAOGl4zDwc1wD6Ed74GOncaMb6F27
+8FDggYH9qaH8rTBx3NY7Pxn1F1M71s+EL0ZzD0rKix+EDwfFcY6wOnq8Be+VzjhO
+HGKKC2YNkCYerfczL9WP0nbrP9OplYXnE0QRm2Ot+PqIoXzRPIhIUjeV0lKvAkre
+sHNTuWCFTthpLFhinKbIr3hmXYWglpa7s9byomPFo3TtP0BwY5lqhmm3Byl/vgoE
+CiagNghpxzElgOngR7LVdXwjIESp5IEqpmTd2CC6PvR9HW380ACEKSpYG72IY4ci
+/1jcb46jAsaaKgCb23Ao3qjb5Po5IZTphrN59nnEWkxrZpLqzhtZ3LLjSMCINLIY
+uowLnwliRxILbKRREescLCfnxW3v9Aa8zF6gzC91rQ5AYLHZytXyeqwf34GdZ2rQ
+xyMttVWv6MTBlVJ6JmhnzLZE+V5FVfgeOx4NZmLgDe+0gJqkFWnAFRlMXQARAQAB
+tDB0ZXN0ZXIgc2htZXN0ZXIgKEtleXMgZm9yIHRlc3QpIDx0ZXN0QGdtYWlsLmNv
+bT6JAlEEEwEIADsWIQQG1tcxsg93c1RXhrGQRZjPVtNMKAUCZhpmbQIbAwULCQgH
+AgIiAgYVCgkICwIEFgIDAQIeBwIXgAAKCRCQRZjPVtNMKG0YD/4hqPHNjY0Qx+uN
+CJdDqTr4wGjxcG6fhk9FWCJWR7/QFIU+DZ2sSB6HBFhUYxyjnGbGRnbUjKaQh0Ti
+D8p46iJGUqoWLUr7MiZPWs2Mwsrc5O9vaR4Zfy4PIDOqXSiD5eOpHg83SjV1G4Y+
+S66qFpxwLajt9MHpFPtC0O7knzBIXPQ25/oLBemVFCnD/X//x2xHA01+FF/reHJ3
+7iLF+iBd8UyNKvBtZBnOvDTCD2XEba8ARsTbcM/5+ZrcTnQL/YiaNaHiuD9fix6u
+fa35SZEUcVV+NkxTkf8JFqQlc4aDwKn+HoNxauTYjPNqIOv/Nx+YcvL7awRr5VXk
+XQPcVXu8bM4jJSvuJAF7PCCVoaVg205lzUV/YmHey1psMGRXUvB2C6FDpIR16yIE
+botadNdvYv7NKAUHdgwHqDHgiWe+KDTkDpZd6h7XikAo1MZPjobbuWr7qILOVVaP
+6+bB0TzAdszd07Lwqssmtv1XrUl03eNWnlOuZdyDqLCGRM/vUuR671QljGps2Pnu
+6fjnmpGwPmABPfQAkUwEj4tNdAdLO2UjbkLtQQggcvywJ63S3peMxivoLotZiQWO
+YqLm49iEsB4BI0qLtdW42W530f5F1Ft1St+MDMz71/hAHPOzy783Vn4B69fikTBZ
+fuJ4U9HPLOhwZHZjVjAGQv4S2/otQLkCDQRmGmZtARAAoOViMcFe/UOol8MIKM3y
+/3AaJFHgZv5+WOjs0qT4Tt/g/lPzx+pkLH0Lrg5DcmS2z/06etPBicEjG3KRcryx
+EdxIUKM8JbLJfm9Wx+RLIsgNsyKA5b6ilqiDZbYftbcdW5l3Lixl6/E1wKI//PBL
+YIDVrz306vFAvrFhKmJrCNoIgsNZYZNTu7f1AxWF2LOry2uJRUGX5BcqI0zB+Lux
+nXI1PDfcoNN9nT0xWpDP1F3uyS8yX/i6JG6npdv3JvvlmjsIr5RmWZ2r5kKt6aGT
+/gCBXG2LadFgENefUNhs3z2aixqlfW8XaMk0+EGlir3KH099ZMY77EecXdEe2MLL
+HN13ZXBHGFkwIR/2LXjp8nUmS9Kxv/69UaUQC5FmXnNh4axsT35fUI41g2FmzZ+S
+cDx+onhQ+tA7jVRp4s5+mtizdUmKDZOi+aPFMISnd5tZPdHmPCK1TRODhMTG2Bgd
+mWq6koK5f98BgCYZFCULYLbX2zLPFPqeL+yvPktmVYB7pMsPKr8HN5Gu6VHFniPW
+dpBOnlEq4iRym+sL0KmowhEVHG5aiPiaWSg2yc6xoAdQIDkATX2KqeHS0LJ5dST6
+CLkvHgKQEcUNflqPHQztxoCDOeywy5bGz88i8KWNsH9GctNL2wRY70e+aWfdCpek
+MaZkUct/HTTrBfde7QxI6F8AEQEAAYkCNgQYAQgAIBYhBAbW1zGyD3dzVFeGsZBF
+mM9W00woBQJmGmZtAhsMAAoJEJBFmM9W00woG9EQAJSz3C2RhO8jGajDjLX/ZewJ
+OuQ2tmEftRFYJLhLFfVWXAK+ZwQWzszy/AexpulL1C3NsKdjhgPoqEffsMW32vwE
+sTggej8EPHL0NLqPjK+1R7xsPm7Ezsy+mtYYstaCAY3MkYgBCzVKWIAvAJ8H1QZB
++F9rYu2iHhyiLNOsbZJc5fmSiTfsXfkgAfN2prB2bKBm7ntPAK7vX1+m5jihbqLL
+jr0DECo7rBfjyuPXrJb/PTdEc5cQ1I/RCkb0CNazHnwlG0c2vmsYY87ruilBw4zv
+MiN0CRWcqVQmuzyiNNmQt7ueM/UHJRTgid7friQtU2fL6UUrhD6H/Yb7KVVQSMgn
+0yvkUOxNYzQRFOZFRYtBopkDSiEsV62AVtaCQoteImJwgU5fESLq11oIbwi2kM2a
+VPCuOIKPBx7Ghomq6wmCvzxIgYojCJSvxt4FefOvGA4A8nJgRKc/lT8e8CV02V2d
+kOpMbrPz57R5RsQ5WNYVTtk6K6uPTkajrSVMopLJV0QQ77ksc4pujII9guprz2bK
+xZb7T0xLBBAqaTakZc1NGOwSV0hofu79DlKvLR2BB+2XhseO3iLWihpLRjJShamg
+i9M1qY7gk2elhW/+2IWifgTJfmlvNaqWCyqH/FrRyj8fw0/JUCKlNPwt9ITm9ffm
+PYl38WJh5gV98/obb+Mp
+=fslD
+-----END PGP PUBLIC KEY BLOCK-----`;
+
+export const armoredPrivateKey = `-----BEGIN PGP PRIVATE KEY BLOCK-----
+
+lQdGBGYaZm0BEADfaOXr8cXcU3esPh7gBRqgdUNl/qNFVUOkfoaxMK0m2uDrI03w
+leH7LiEa7zJ1R9SJXgCA8vhGHpdiqZCCDKePCXofDeB0D52ryvgUxY6pVY2mlsgl
+lOGVeajiIMv+nNj0g1J85/8KRWz2cvvElhNOlmRJT5l7E+o2s0nDnimbzqlFtP7A
+nU6WgElHgeIdEfv+YFiEjl1UkwXV5HLh9nXCAOGl4zDwc1wD6Ed74GOncaMb6F27
+8FDggYH9qaH8rTBx3NY7Pxn1F1M71s+EL0ZzD0rKix+EDwfFcY6wOnq8Be+VzjhO
+HGKKC2YNkCYerfczL9WP0nbrP9OplYXnE0QRm2Ot+PqIoXzRPIhIUjeV0lKvAkre
+sHNTuWCFTthpLFhinKbIr3hmXYWglpa7s9byomPFo3TtP0BwY5lqhmm3Byl/vgoE
+CiagNghpxzElgOngR7LVdXwjIESp5IEqpmTd2CC6PvR9HW380ACEKSpYG72IY4ci
+/1jcb46jAsaaKgCb23Ao3qjb5Po5IZTphrN59nnEWkxrZpLqzhtZ3LLjSMCINLIY
+uowLnwliRxILbKRREescLCfnxW3v9Aa8zF6gzC91rQ5AYLHZytXyeqwf34GdZ2rQ
+xyMttVWv6MTBlVJ6JmhnzLZE+V5FVfgeOx4NZmLgDe+0gJqkFWnAFRlMXQARAQAB
+/gcDAvr0bC9bPRGo+jrAf4ts/1ePm2DUtlSrQbWgR+fPFIAL1oj1DesaB/DGPM2R
+SQUO9inSU8Jlg7dK+YLmUQLmruqn15jsfETW1DeccLL4j+0E2Jaup9NyaOHjsIR2
+51WdEsZv4y1gMGnm+vx8Im1zcA0/CXLsPS7PFIJ9tdEKFyJ8txhtQEuzVq+IAcrq
+Gw7NjtsOC+q0BShfI+KyGABLuhvkeFB1+Nhw3r1/MzW2f+qipHMH8gFfabbTxsqU
+YIwlj3tbvXtgTNQbHUiUbHe+T19ueIXpRGs46J7b1zkoUwO8BYeHMvPCrog0iBen
+5gwDSJnZvzmrkUXQ00vDMtFiJvQmZuL+05ZagVcDvF8RPR/Qpl3EyjSf316JgfRg
+1YN3Cf3BZgtgucXRWsbknC5TYMgASNPiECcvTU4It8vgqmOtx+dKrEyr0bcJASCB
+rJlSFRsunhofdSDBSCOKoyKvgi3WUNmscpVIQo4435Z3Dj7ApTt5B93G9MDg1os0
+e00FrtrsYIhc0CiDAK4Vy60bSz6VJf5rqNHZSqGSDA45xLvbuktwU3UN4G9chTmu
+wWL+C9wbwbUhTB4rAxymD/6qCUakQzBASXyXAP3PZvvpdgyePtL+CLyWgWmmCHnB
+XTg/GbkAx3ridEa5rj7ElqIg0yHXehCj3Td/WLxL4mXIbmt+UYM4IR0QqGuuBA4s
+EwxXa7yhQWb54/93aX31kGgbl/3fZr6mMho2IzN/eawO6rM79Cq+qymFc+8nqRVf
+aWGF0F7Szi5hon8N33DOiXAX7/nD6WY3c65PiImGYKpMvFyOOMbH4KJ7/jBBeK/j
+saaVRw0u342h9tDQhOPcvUU4kdlUTF8x1t0R5jr6jy9Xu0e9GUEM/wLi1vm+6A5d
+cxFHPrsvPUembzsig76rTcm1ntHcxAmymmou2vhmZnCS3Fbx64ArQt870WEhfFD3
+Ok0E314vEMbxe1/8JvALMa4Rot/enbwkNG8Ek1xb2fyGD8GaoUP6stXEfofLEzvt
+aVmgUFUkD6qKWcZz27MYZmU1iiq6WCvPM+Fv1o6zLjOde1feKBXRS9RJNFhQ3x/W
+L/w+VIFUXqqVBvX97U7LwMbW0aTl7YrPZAxO0fJ1tH9tQbyAcGkl/XFDomgOwjez
+CjqLLVcthTTThrJKiD15fQ7pKkFNZZFnUb4c9nUvfTa366fFmJV9Rn3ykvYj2Cne
+YMRT7fTZTxayn2qa3eJKjJQ/WsWaynQn+9Pb1QgSYp3g/vBPPTH7FjptVRnDKF0r
+9GjpTaqo8Mbm3iW8T8ozT1DlKVJGHQH71kGlPd1vdWMNbjpRY27rv7OFyaF2BWvT
+javw/5VGkVOyTVSwLCnrG9sK0vkL7QacaO/DoODPluSnC7cnRrhSQQEXkT3Fv84Q
+Lwkpd7Yy0lxhQ+YXll5OUJBXNBQEDv5NKqW3R9dWuVLFWjpOVu4iCRlHsBKGU4t7
+DN3NwrRu/icZQBjZbzxN+g8+GFZ7RTa8mb13wbZHvG6R3wTcC6w9KikShDSxtNzm
+UW+zhi7gwZc1fvEKfLPVQatmYBsbhUvgaWTJ00k7GP5Wf4aJBQ7Y0VLGNxdHAGaY
+/ZBOuv1hI7SjrOKhPRCpHhIxQV9LO6X8oaBr94wBdMiduNoBAsctzuUxPqkjsRIi
+dw9gyhpj+rqq4TdqVH2POIOJ9oSAzlgz9IF7eMbWZ7vqppri9mO9RafzJQ8N8tEA
+3sBK+A8KHrxVZPXzkl+PpAiIkO7v3ErgFqVAlYTRBqZtip6l9GuuDsa0MHRlc3Rl
+ciBzaG1lc3RlciAoS2V5cyBmb3IgdGVzdCkgPHRlc3RAZ21haWwuY29tPokCUQQT
+AQgAOxYhBAbW1zGyD3dzVFeGsZBFmM9W00woBQJmGmZtAhsDBQsJCAcCAiICBhUK
+CQgLAgQWAgMBAh4HAheAAAoJEJBFmM9W00wobRgP/iGo8c2NjRDH640Il0OpOvjA
+aPFwbp+GT0VYIlZHv9AUhT4NnaxIHocEWFRjHKOcZsZGdtSMppCHROIPynjqIkZS
+qhYtSvsyJk9azYzCytzk729pHhl/Lg8gM6pdKIPl46keDzdKNXUbhj5LrqoWnHAt
+qO30wekU+0LQ7uSfMEhc9Dbn+gsF6ZUUKcP9f//HbEcDTX4UX+t4cnfuIsX6IF3x
+TI0q8G1kGc68NMIPZcRtrwBGxNtwz/n5mtxOdAv9iJo1oeK4P1+LHq59rflJkRRx
+VX42TFOR/wkWpCVzhoPAqf4eg3Fq5NiM82og6/83H5hy8vtrBGvlVeRdA9xVe7xs
+ziMlK+4kAXs8IJWhpWDbTmXNRX9iYd7LWmwwZFdS8HYLoUOkhHXrIgRui1p0129i
+/s0oBQd2DAeoMeCJZ74oNOQOll3qHteKQCjUxk+Ohtu5avuogs5VVo/r5sHRPMB2
+zN3TsvCqyya2/VetSXTd41aeU65l3IOosIZEz+9S5HrvVCWMamzY+e7p+OeakbA+
+YAE99ACRTASPi010B0s7ZSNuQu1BCCBy/LAnrdLel4zGK+gui1mJBY5ioubj2ISw
+HgEjSou11bjZbnfR/kXUW3VK34wMzPvX+EAc87PLvzdWfgHr1+KRMFl+4nhT0c8s
+6HBkdmNWMAZC/hLb+i1AnQdGBGYaZm0BEACg5WIxwV79Q6iXwwgozfL/cBokUeBm
+/n5Y6OzSpPhO3+D+U/PH6mQsfQuuDkNyZLbP/Tp608GJwSMbcpFyvLER3EhQozwl
+ssl+b1bH5EsiyA2zIoDlvqKWqINlth+1tx1bmXcuLGXr8TXAoj/88EtggNWvPfTq
+8UC+sWEqYmsI2giCw1lhk1O7t/UDFYXYs6vLa4lFQZfkFyojTMH4u7GdcjU8N9yg
+032dPTFakM/UXe7JLzJf+Lokbqel2/cm++WaOwivlGZZnavmQq3poZP+AIFcbYtp
+0WAQ159Q2GzfPZqLGqV9bxdoyTT4QaWKvcofT31kxjvsR5xd0R7Ywssc3XdlcEcY
+WTAhH/YteOnydSZL0rG//r1RpRALkWZec2HhrGxPfl9QjjWDYWbNn5JwPH6ieFD6
+0DuNVGnizn6a2LN1SYoNk6L5o8UwhKd3m1k90eY8IrVNE4OExMbYGB2ZarqSgrl/
+3wGAJhkUJQtgttfbMs8U+p4v7K8+S2ZVgHukyw8qvwc3ka7pUcWeI9Z2kE6eUSri
+JHKb6wvQqajCERUcblqI+JpZKDbJzrGgB1AgOQBNfYqp4dLQsnl1JPoIuS8eApAR
+xQ1+Wo8dDO3GgIM57LDLlsbPzyLwpY2wf0Zy00vbBFjvR75pZ90Kl6QxpmRRy38d
+NOsF917tDEjoXwARAQAB/gcDApzPfxNUMgFJ+tXp0Z1743VPjBGe3JdVlQ+H6R/m
+50bYbuTL8CxbNDsi9eqlW98gg13V3Lf5fgtyr5stXzkUNqIKF0jh/a0sLUvOq5s2
+qbUj64XwkusW5ssxCKz+eNxKZ8lzlQPKlVi/LZsk1zaoEp52RUlC+pULwFBomZTM
+/e9yHNJHlqNjuBKcEgds5wTdUeoowyTTesg8bL3Mn1PlLcW+AUo8dyT4gEUcOjJL
+WkfNGEF0ufvIJ21LX0QBI6o0YNjbt+aKMQEq1EJqMO//X6NZphh6GltziQRyRU7K
+0+8TELZmBU3shOEq0O4IPCk1xbezXjE8P61nu7MPCh+4zzQqLqPOkunHBFbW5IyV
+nvcPD1i8zCKmgdx9GASGYVwyHpecBLVWxHO8IveTturV51TyLoULooTrpoQqRJLH
+mHiVyTw5yInSw8iu07d6HcyO6tnemiO1yAqhQemoxBrIOqgp5GXYVtfbTlBtLyIY
+mqFhq5ch43jpeg03WA45xGhwUyNACjAJvsB0BKdEddDKiry2pgLRw7/oa87Y0iLg
+XsxwnjVFY4QQSZzetn5RHd3RRhMxAelOnhzJblXEg6x15MXmpQdz4yNtJ19cfi7N
+AI1B+DPzbWZmeESrgmgROMGl3g1DT0qOjBdfDfIlID58pxFTWdNlCBPI0V6upfqT
+A+JKXu7saVhmOHgKuQEjXbjxpp7xcFayJBKwCf72auD27tZLD/TRWNNZrLRFRmQ3
+HAcmVc8qNvqRfOUKTaD2tVY4eMMfdqUsRz5LAedSt1iASM1MBhnaQT4HVa7cpU9p
+cOPlsDlH1EbjeyK8ZSn4rPvEek91hyc3H2vu45Ot9sG5JpQQ0Cay7LRT6WqQhqNZ
+O7pcCEXeBbMOFi0BnOVO4YpyLXPLGJdJsJHvzg+WsQ8xC97BaqdL1qqO9OmsnS9O
+URBO6EVX0JjKZvafxOswWCJ35i0bavQ34vm5kKRZga2kC/wzw39B5wrUTwGCjki+
+dlhUiJ/F3rfHkD2bDHU3BnYoLeMksqKRvklaPnFtPuD0TcQehQEVEGjjFpxB3nwK
+V7JtQ2FddHRHsfhl3ppn3OVTEHAg2sbGS9DG/PIQd8pomZl4UovFGf8l6CzuWcXV
+ULSUM7W2Oue/G9FO20sluNru5lsMBCaPuE54dpwkmA7PUv24wb+s5l5AV9/Yp3Tk
+34Gf/pHajCD703qM5g62wvlyqEvCZD4bEj2iT7j1wVvKAtKtexjqehse/dajM45n
+D9qDWVuFsGUuwPF5RmahL9B57EeYV1Kv0mLT2eUBb/bglOPzazzov/44SXPEcE2r
+VmoGmQ6GKstXaLCYbZF/izO5MGsd+V7vcIAaYX2EpcKJ7wEgWvnGzOEifmz8paP5
+Zfoncy1gRwUaWP7hGgsoJ3us/cFfRO/BPyUbu9fEYhCWZBciQgRdB2pvzPkad17B
+XuovzzLO/NnQnc/sqsVyRBM3FwfhGwbmG27lmmMOZpRhA1ZrcX4hfiGhLPsgH5BI
+WeInbEobwYxPPYR1yRdZUfBPGCgau6Fw+YJoNuo0k3FG9ZH4jbMu+NDd1x3q7UR5
+T6x/1qqGKoEe/AeaaBdMYFmw0Uz23r3jHxER3JzwwokwwSx4dGhz170xtnK/xv6P
+rLxnaLm5W7bX/m5vosakiqvn/S1u5MF87lpgFyLWtQm6zEFmZ7cVL1LsYjuIXsd+
+u6ErPdobtJyLRWAYmwxo9JNJAj7q5YVcMfjnp8BO1W6k63Mv18QvK3KN7IiFfB72
+akr2khXz5S2JAjYEGAEIACAWIQQG1tcxsg93c1RXhrGQRZjPVtNMKAUCZhpmbQIb
+DAAKCRCQRZjPVtNMKBvREACUs9wtkYTvIxmow4y1/2XsCTrkNrZhH7URWCS4SxX1
+VlwCvmcEFs7M8vwHsabpS9QtzbCnY4YD6KhH37DFt9r8BLE4IHo/BDxy9DS6j4yv
+tUe8bD5uxM7MvprWGLLWggGNzJGIAQs1SliALwCfB9UGQfhfa2Ltoh4coizTrG2S
+XOX5kok37F35IAHzdqawdmygZu57TwCu719fpuY4oW6iy469AxAqO6wX48rj16yW
+/z03RHOXENSP0QpG9AjWsx58JRtHNr5rGGPO67opQcOM7zIjdAkVnKlUJrs8ojTZ
+kLe7njP1ByUU4Ine364kLVNny+lFK4Q+h/2G+ylVUEjIJ9Mr5FDsTWM0ERTmRUWL
+QaKZA0ohLFetgFbWgkKLXiJicIFOXxEi6tdaCG8ItpDNmlTwrjiCjwcexoaJqusJ
+gr88SIGKIwiUr8beBXnzrxgOAPJyYESnP5U/HvAldNldnZDqTG6z8+e0eUbEOVjW
+FU7ZOiurj05Go60lTKKSyVdEEO+5LHOKboyCPYLqa89mysWW+09MSwQQKmk2pGXN
+TRjsEldIaH7u/Q5Sry0dgQftl4bHjt4i1ooaS0YyUoWpoIvTNamO4JNnpYVv/tiF
+on4EyX5pbzWqlgsqh/xa0co/H8NPyVAipTT8LfSE5vX35j2Jd/FiYeYFffP6G2/j
+KQ==
+=OrI7
+-----END PGP PRIVATE KEY BLOCK-----`;
+
+export const privateKeyPassphrase = 'test';

package/encryption/__tests__/encryption.spec.ts

@@ -0,0 +1,165 @@
+import {
+  encryptViaKeys,
+  decryptViaKeys,
+  encryptViaPassword,
+  decryptViaPassword,
+  NoKeysProvidedError,
+  NoPasswordProvidedError,
+  IncorrectOrMissingPrivateKeyPasswordError,
+} from '../encryption';
+import { test, expect } from 'vitest';
+
+import {
+  armoredPublicKey,
+  armoredPrivateKey,
+  privateKeyPassphrase,
+} from './encryption-keys';
+
+test('Should encrypt text via keys', async () => {
+  const res = await encryptViaKeys(
+    'Hello world',
+    armoredPublicKey,
+    armoredPrivateKey,
+    privateKeyPassphrase
+  );
+
+  expect(res.startsWith('-----BEGIN PGP MESSAGE-----')).toBeTruthy();
+});
+
+test('Should decrypt via provided keys', async () => {
+  const decryptedMessage = await decryptViaKeys(
+    `-----BEGIN PGP MESSAGE-----
+
+wcFMA/vryg+TTn0rARAAhXuEjOHa856iCNVmdeIGHF+IEoeEwTc5tIcr6Lri
+V6xs//3WnwVwUlyxYrum3yCpx8t5gyWTXFfTNH08VoVqPVP45fkk1H7jdC6Q
+I+tHfn8nXZApdKQlMOku+XMXtRuqvOUQHutqHj4ka3qC+wGIPcOsy2TIoFsS
+xauk13hMggmVHOdQkMzWA1QlxDcz6lFl86SvX18uc7H62s36gHxARmOLZfBd
+nRFdnPgLKNOPGWb6QvYfvxiv03vGSsKlb0tIpwP1Ot0nyZax+yH9CJmIEni/
+rW9Wu/Ph+PRcB2L9kp/X4Opol3RwJ0lI9ilTRw9+GGFipXhCmJcjPJC7WNIg
+vg0/xVUjSmlxQQAZlC9/sefvoXjY0CP+h+djtoZsxLpN4P4iTO1reuoVD0iO
+UwT9JCUR1uDEiNXvh6AmrLlH3ceBynJcBtHXAnx1vcgtY8oKKYBjsoTeEngg
+P5w5ZXcceoPuYLe6g1YPsFECAgGF+e/QuZ9CCfUgr4o7nSteHQRShP2gXZzc
+oHKR4tiV71VVGKzv0EYhCvVt9NGkxIklft9Lq4ZOXeT9QOnJ/7gRofX2veg2
+TpBADPJ/JvBRcxGEe7KUpYb6Hjr5LRfPOBnH3NK1zMJlqgUHt4ZZSVPxfr9I
+6hWwsKxizzQ9gwEnDMciUvtX1tMF8+NiH7B0Ho4QVLfSwcEBwsGjA0yq08I/
+7jK5LGtM8T3xtIW7yZ2binWbAFL6rnbOXjtmI31m4OxCEHW4CVBAV3/lUZlT
+1eCPXEk32h39nDZHExjSeiUcGevCek5RvIvkhlnURzdZ69/BdZN5hr6LEOAe
+O3UtE9mpvyNFKK9NZsn+ckR1fxK1K4yUiX+dtLjL+x+B38EQE0gjA+ekpfUe
+dv7XD/ZAny66mAcwMn+lQozabpeEaNYIY7D8QspCvZWOS+borK/PVRJkF6pT
+ZBmKzI4mvzDTFsd7VguB7frpsb+agUvhXXAJEHWEE4ZR3vQa1sWEnmxyAdNp
+H9UFoIhGf9mSPlbBTMKEcAJmqzEIrb6z4psmmt6oYLXDR8PCxxK+g0xdrmbO
+Az//AD0eRm8XHCHpwGf8YYWrNHOidDYpgmJTy7qFUwknWS+t3NlkU3CsCR+j
+i9Km3edjOwPpJtgI0LeRRqXs3eUhLQARC5nFePbRWnFSXPBuFxBVZyL9AYrS
+KQn4dM1p4eTtsiEu1NaTzRtQNZAFHcJpZ8qAL67LHoNdFe/atpCdlyV3yur9
+RvAA3cB7cj7wab3beX+cTqxdhpGePZh0TrNd3liV69FtbnYfeDrtUYIL1jfT
+EJN3l+qpveimyX655RrgFX3DNGrVbbhpx+FDF9Ky9kqb2BJBTFKoCBxbf0dS
+sniNAsC/t/k6ErG8NKNQsNh1aeN6plXnxeVi1vv6SvO2mwZRVvDNT1hg9Cyc
+UO1Pw43TRLO50HgR9+ERNXL491TJA0aCj14oXwsm0Dtg6EOltX0GUDwcPjv6
+6QMreKTATPLytbhCdPO+JOzObsptU/IlsQQWlMz8yKXwqyuN8z8SOaddJIHR
+YQ==
+=f4F1
+-----END PGP MESSAGE-----
+`,
+    armoredPrivateKey,
+    privateKeyPassphrase
+  );
+  expect(decryptedMessage).toEqual('Hello world');
+});
+
+test('Should encrypt via password', async () => {
+  const password = 'test';
+  const res = await encryptViaPassword('Hello world', password);
+
+  expect(res.startsWith('-----BEGIN PGP MESSAGE-----')).toBeTruthy();
+});
+
+test('Should decrypt via password', async () => {
+  const password = 'test';
+  const encryptedMsg = `-----BEGIN PGP MESSAGE-----
+
+wy4ECQMI6KFWGqyVV+DgYl0qUEeTe1kAdjkoR4FxFJxx+6QiOP+sZ6h7bn//
+aGW80jwBXEQ7uTjT8akpOKiH7BIuhEUZIXh+vDveG0Uwf63s2dIklznAEo+E
+5iO5mEqoXWXg6nAvNxciA56dKuI=
+=B4Tc
+-----END PGP MESSAGE-----
+`;
+
+  expect(await decryptViaPassword(encryptedMsg, password)).toEqual(
+    'Hello world'
+  );
+});
+
+test('Should raise incorrect or missing private key error', async () => {
+  const encryptedMsg = `-----BEGIN PGP MESSAGE-----
+
+wcFMA/vryg+TTn0rARAAhXuEjOHa856iCNVmdeIGHF+IEoeEwTc5tIcr6Lri
+V6xs//3WnwVwUlyxYrum3yCpx8t5gyWTXFfTNH08VoVqPVP45fkk1H7jdC6Q
+I+tHfn8nXZApdKQlMOku+XMXtRuqvOUQHutqHj4ka3qC+wGIPcOsy2TIoFsS
+xauk13hMggmVHOdQkMzWA1QlxDcz6lFl86SvX18uc7H62s36gHxARmOLZfBd
+nRFdnPgLKNOPGWb6QvYfvxiv03vGSsKlb0tIpwP1Ot0nyZax+yH9CJmIEni/
+rW9Wu/Ph+PRcB2L9kp/X4Opol3RwJ0lI9ilTRw9+GGFipXhCmJcjPJC7WNIg
+vg0/xVUjSmlxQQAZlC9/sefvoXjY0CP+h+djtoZsxLpN4P4iTO1reuoVD0iO
+UwT9JCUR1uDEiNXvh6AmrLlH3ceBynJcBtHXAnx1vcgtY8oKKYBjsoTeEngg
+P5w5ZXcceoPuYLe6g1YPsFECAgGF+e/QuZ9CCfUgr4o7nSteHQRShP2gXZzc
+oHKR4tiV71VVGKzv0EYhCvVt9NGkxIklft9Lq4ZOXeT9QOnJ/7gRofX2veg2
+TpBADPJ/JvBRcxGEe7KUpYb6Hjr5LRfPOBnH3NK1zMJlqgUHt4ZZSVPxfr9I
+6hWwsKxizzQ9gwEnDMciUvtX1tMF8+NiH7B0Ho4QVLfSwcEBwsGjA0yq08I/
+7jK5LGtM8T3xtIW7yZ2binWbAFL6rnbOXjtmI31m4OxCEHW4CVBAV3/lUZlT
+1eCPXEk32h39nDZHExjSeiUcGevCek5RvIvkhlnURzdZ69/BdZN5hr6LEOAe
+O3UtE9mpvyNFKK9NZsn+ckR1fxK1K4yUiX+dtLjL+x+B38EQE0gjA+ekpfUe
+dv7XD/ZAny66mAcwMn+lQozabpeEaNYIY7D8QspCvZWOS+borK/PVRJkF6pT
+ZBmKzI4mvzDTFsd7VguB7frpsb+agUvhXXAJEHWEE4ZR3vQa1sWEnmxyAdNp
+H9UFoIhGf9mSPlbBTMKEcAJmqzEIrb6z4psmmt6oYLXDR8PCxxK+g0xdrmbO
+Az//AD0eRm8XHCHpwGf8YYWrNHOidDYpgmJTy7qFUwknWS+t3NlkU3CsCR+j
+i9Km3edjOwPpJtgI0LeRRqXs3eUhLQARC5nFePbRWnFSXPBuFxBVZyL9AYrS
+KQn4dM1p4eTtsiEu1NaTzRtQNZAFHcJpZ8qAL67LHoNdFe/atpCdlyV3yur9
+RvAA3cB7cj7wab3beX+cTqxdhpGePZh0TrNd3liV69FtbnYfeDrtUYIL1jfT
+EJN3l+qpveimyX655RrgFX3DNGrVbbhpx+FDF9Ky9kqb2BJBTFKoCBxbf0dS
+sniNAsC/t/k6ErG8NKNQsNh1aeN6plXnxeVi1vv6SvO2mwZRVvDNT1hg9Cyc
+UO1Pw43TRLO50HgR9+ERNXL491TJA0aCj14oXwsm0Dtg6EOltX0GUDwcPjv6
+6QMreKTATPLytbhCdPO+JOzObsptU/IlsQQWlMz8yKXwqyuN8z8SOaddJIHR
+YQ==
+=f4F1
+-----END PGP MESSAGE-----`;
+
+  try {
+    await decryptViaPassword(encryptedMsg, 'password');
+  } catch (e) {
+    expect(e).toBeInstanceOf(NoKeysProvidedError);
+  }
+});
+
+test('Should raise IncorrectOrMissingPrivateKeyPasswordError error when incorrect armored key provided', async () => {
+  const password = 'test';
+  const encryptedMsg = `-----BEGIN PGP MESSAGE-----
+
+wy4ECQMI6KFWGqyVV+DgYl0qUEeTe1kAdjkoR4FxFJxx+6QiOP+sZ6h7bn//
+aGW80jwBXEQ7uTjT8akpOKiH7BIuhEUZIXh+vDveG0Uwf63s2dIklznAEo+E
+5iO5mEqoXWXg6nAvNxciA56dKuI=
+=B4Tc
+-----END PGP MESSAGE-----
+`;
+
+  try {
+    await decryptViaKeys(encryptedMsg, armoredPublicKey, privateKeyPassphrase);
+  } catch (e) {
+    expect(e).toBeInstanceOf(IncorrectOrMissingPrivateKeyPasswordError);
+  }
+});
+
+test('Should raise NoPasswordProvidedError error when try to use keys instead of password', async () => {
+  const encryptedMsg = `-----BEGIN PGP MESSAGE-----
+
+wy4ECQMI6KFWGqyVV+DgYl0qUEeTe1kAdjkoR4FxFJxx+6QiOP+sZ6h7bn//
+aGW80jwBXEQ7uTjT8akpOKiH7BIuhEUZIXh+vDveG0Uwf63s2dIklznAEo+E
+5iO5mEqoXWXg6nAvNxciA56dKuI=
+=B4Tc
+-----END PGP MESSAGE-----
+`;
+
+  try {
+    await decryptViaKeys(encryptedMsg, armoredPrivateKey, privateKeyPassphrase);
+  } catch (e) {
+    expect(e).toBeInstanceOf(NoPasswordProvidedError);
+  }
+});