orgnote-api 0.10.2 → 0.10.4

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

@@ -6,7 +6,8 @@ exports[`Should decrypt note content via password 1`] = `
 #+TITLE: Hello worlld
 
 * Hello?",
-  "encrypted": "gpgPassword",
+  "encrypted": false,
+  "encryptionType": "gpgPassword",
   "id": "id",
   "meta": {
     "headings": [
@@ -27,7 +28,8 @@ exports[`Should decrypt note via provided keys 1`] = `
 #+TITLE: Hello worlld
 
 * Hello?",
-  "encrypted": "gpgKeys",
+  "encrypted": false,
+  "encryptionType": "gpgKeys",
   "id": "id",
   "meta": {
     "headings": [
@@ -49,7 +51,8 @@ exports[`Should encrypt note content via password 1`] = `
     "id": "1",
     "name": "John Doe",
   },
-  "encrypted": "gpgPassword",
+  "encrypted": true,
+  "encryptionType": "gpgPassword",
   "id": "id",
   "meta": {
     "id": undefined,
@@ -65,7 +68,8 @@ exports[`Should encrypt note via keys 1`] = `
     "id": "1",
     "name": "John Doe",
   },
-  "encrypted": "gpgKeys",
+  "encrypted": true,
+  "encryptionType": "gpgKeys",
   "id": "id",
   "meta": {
     "id": undefined,
@@ -81,7 +85,7 @@ exports[`Should encrypt note with empty encrypted property 1`] = `
     "id": "1",
     "name": "John Doe",
   },
-  "encrypted": "gpgPassword",
+  "encrypted": true,
   "id": "id",
   "meta": {
     "id": undefined,
@@ -101,7 +105,7 @@ exports[`Should not decrypt note without provided encrypted type 1`] = `
 #+TITLE: Hello worlld
 
 * Hello?",
-  "encrypted": undefined,
+  "encrypted": false,
   "id": "id",
   "meta": {
     "description": "Awesome description",
@@ -123,7 +127,8 @@ exports[`Should not encrypt public note 1`] = `
 #+TITLE: Hello worlld
 
 * Hello?",
-  "encrypted": "gpgPassword",
+  "encrypted": false,
+  "encryptionType": "gpgPassword",
   "id": "id",
   "meta": {
     "description": "Awesome description",
@@ -133,3 +138,48 @@ exports[`Should not encrypt public note 1`] = `
   },
 }
 `;
+
+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__/note-encryption.spec.ts

@@ -16,7 +16,7 @@ test('Should encrypt note content via password', async () => {
 
   const note: Note = {
     id: 'id',
-    encrypted: 'gpgPassword',
+    encryptionType: 'gpgPassword',
     meta: {
       title: 'My note title',
       images: [],
@@ -46,7 +46,7 @@ test('Should encrypt note content via password', async () => {
 test('Should decrypt note content via password', async () => {
   const note: Note = {
     id: 'id',
-    encrypted: 'gpgPassword',
+    encryptionType: 'gpgPassword',
     meta: {
       title: 'My note title',
       images: [],
@@ -79,7 +79,7 @@ test('Should encrypt note via keys', async () => {
 
   const note: Note = {
     id: 'id',
-    encrypted: 'gpgKeys',
+    encryptionType: 'gpgKeys',
     meta: {
       title: 'My note title for encryption via keys',
       images: [],
@@ -111,7 +111,7 @@ test('Should encrypt note via keys', async () => {
 test('Should decrypt note via provided keys', async () => {
   const note: Note = {
     id: 'id',
-    encrypted: 'gpgKeys',
+    encryptionType: 'gpgKeys',
     meta: {
       title: 'My note title for decryption via keys',
       images: [],
@@ -169,7 +169,7 @@ test('Should not encrypt public note', async () => {
 
   const note: Note = {
     id: 'id',
-    encrypted: 'gpgPassword',
+    encryptionType: 'gpgPassword',
     meta: {
       title: 'My note title',
       images: [],
@@ -271,6 +271,7 @@ test('Should decrypt note and note meta', async () => {
   const note: Note = {
     id: 'id',
     meta: { ...meta },
+    encryptionType: 'gpgPassword',
     content: `#+TITLE: My note title
 #+DESCRIPTION: Awesome description
 #+PUBLISHED: false
@@ -293,3 +294,53 @@ Hello world`,
 
   expect(meta).toEqual(decryptedNote.meta);
 });
+
+test('Should set not encrypted status when params type does not provided', async () => {
+  const note: Note = {
+    id: 'id',
+    encryptionType: 'gpgKeys',
+    meta: {
+      title: 'My note title for decryption via keys',
+      images: [],
+      published: false,
+      description: 'Awesome description',
+    },
+    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-----`,
+  };
+
+  const decryptedNote = await decryptNote(note, {
+    type: 'disabled',
+  });
+
+  expect(decryptedNote).toMatchSnapshot();
+});

package/encryption/note-encryption.ts

@@ -11,6 +11,7 @@ import {
 } from './encryption';
 import { OrgNoteEncryption } from '../models/encryption';
 import { parse, withMetaInfo } from 'org-mode-ast';
+import { isGpgEncrypted } from '..';
 
 export type NoteEncryptionType = `${ModelsPublicNote['encryptionType']}`;
 
@@ -27,6 +28,7 @@ export async function encryptNote<T extends AbstractEncryptedNote>(
   note: T,
   encryptionParams: OrgNoteEncryption
 ): Promise<T> {
+  note.encrypted = false;
   if (
     !encryptionParams.type ||
     encryptionParams.type === ModelsPublicNoteEncryptionTypeEnum.Disabled ||
@@ -37,15 +39,18 @@ export async function encryptNote<T extends AbstractEncryptedNote>(
 
   note.meta = { id: note.meta.id, published: note.meta.published };
 
-  if (encryptionParams.type === ModelsPublicNoteEncryptionTypeEnum.GpgKeys) {
-    return await encryptNoteViaKeys(
-      note,
-      encryptionParams.publicKey,
-      encryptionParams.privateKey,
-      encryptionParams.privateKeyPassphrase
-    );
-  }
-  return await encryptNoteViaPassword(note, encryptionParams.password);
+  const encryptedNote =
+    encryptionParams.type === ModelsPublicNoteEncryptionTypeEnum.GpgKeys
+      ? await encryptNoteViaKeys(
+          note,
+          encryptionParams.publicKey,
+          encryptionParams.privateKey,
+          encryptionParams.privateKeyPassphrase
+        )
+      : await encryptNoteViaPassword(note, encryptionParams.password);
+
+  encryptedNote.encrypted = true;
+  return encryptedNote;
 }
 export async function encryptNoteViaPassword<T extends AbstractEncryptedNote>(
   note: T,
@@ -89,8 +94,10 @@ export async function decryptNote<T extends AbstractEncryptedNote>(
     !encryptionParams.type ||
     encryptionParams.type === ModelsPublicNoteEncryptionTypeEnum.Disabled
   ) {
+    note.encrypted = isGpgEncrypted(note.content);
     return note;
   }
+  note.encrypted = true;
   const decryptedNote =
     encryptionParams.type === ModelsPublicNoteEncryptionTypeEnum.GpgKeys
       ? await decryptNoteViaKeys(
@@ -104,6 +111,7 @@ export async function decryptNote<T extends AbstractEncryptedNote>(
 
   return {
     ...decryptedNote,
+    encrypted: false,
     meta: parsed.meta,
   };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "orgnote-api",
-  "version": "0.10.2",
+  "version": "0.10.4",
   "description": "Official API for creating extensions for OrgNote app",
   "type": "module",
   "main": "./index.ts",

package/tools/__tests__/is-gpg-encrypted.spec.ts

@@ -0,0 +1,44 @@
+import { expect, test } from 'vitest';
+import { isGpgEncrypted } from '../is-gpg-encrypted';
+
+test('Should return true if the content is gpg encrypted', () => {
+  const 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-----`;
+
+  expect(isGpgEncrypted(content)).toBe(true);
+});
+
+test('Should return false if the content is not gpg encrypted', () => {
+  const content = `Hello World!`;
+
+  expect(isGpgEncrypted(content)).toBe(false);
+});

package/tools/index.ts

@@ -1 +1,2 @@
 export * from './mock-server';
+export * from './is-gpg-encrypted';

package/tools/is-gpg-encrypted.ts

@@ -0,0 +1,3 @@
+export function isGpgEncrypted(text: string): boolean {
+  return text.startsWith('-----BEGIN PGP MESSAGE-----');
+}