orgnote-api 0.40.13 → 0.40.21

package/constants/i18n-keys.d.ts

@@ -131,6 +131,8 @@ export declare enum i18n {
     SELECT_COMMAND = "select command",
     CONFIRM_CLEAR_LOGS = "confirm clear logs",
     FILE_DELETED_EXTERNALLY = "file was deleted externally",
+    USED_SPACE = "used space",
+    STORAGE = "storage",
     AUTHENTICATION_STATUS = "authentication status",
     COMING_SOON = "coming soon",
     AUTH_IDENTIFYING = "identifying",
@@ -351,6 +353,8 @@ export declare const I18N: {
     SELECT_COMMAND: i18n.SELECT_COMMAND;
     CONFIRM_CLEAR_LOGS: i18n.CONFIRM_CLEAR_LOGS;
     FILE_DELETED_EXTERNALLY: i18n.FILE_DELETED_EXTERNALLY;
+    USED_SPACE: i18n.USED_SPACE;
+    STORAGE: i18n.STORAGE;
     AUTHENTICATION_STATUS: i18n.AUTHENTICATION_STATUS;
     COMING_SOON: i18n.COMING_SOON;
     AUTH_IDENTIFYING: i18n.AUTH_IDENTIFYING;

package/constants/i18n-keys.js

@@ -135,6 +135,9 @@ export var i18n;
     i18n["CONFIRM_CLEAR_LOGS"] = "confirm clear logs";
     // Buffer
     i18n["FILE_DELETED_EXTERNALLY"] = "file was deleted externally";
+    // Subscription limits
+    i18n["USED_SPACE"] = "used space";
+    i18n["STORAGE"] = "storage";
     // Auth
     i18n["AUTHENTICATION_STATUS"] = "authentication status";
     i18n["COMING_SOON"] = "coming soon";

package/encryption/__tests__/note-encryption.spec.js

@@ -1,46 +1,24 @@
-import { beforeEach, expect, test } from 'vitest';
+import { expect, test } from 'vitest';
 import { decryptNote, encryptNote } from "../note-encryption.js";
 import { armoredPublicKey, armoredPrivateKey, privateKeyPassphrase, } from "./encryption-keys.js";
 import { EncryptionType } from "../../models/encryption.js";
-import { faker } from '@faker-js/faker';
-beforeEach(() => {
-    faker.seed(1);
-    faker.setDefaultRefDate(new Date('2024-01-01T00:00:00.000Z'));
-});
-function generateNoteInfo(overrides = {}) {
-    return {
-        id: faker.string.uuid(),
-        meta: {
-            title: faker.lorem.sentence(),
-            images: faker.helpers.uniqueArray(() => faker.image.url(), 3),
-            published: faker.datatype.boolean(),
-            description: faker.lorem.paragraph(),
-        },
-        createdAt: faker.date.past().toISOString(),
-        updatedAt: faker.date.recent().toISOString(),
-        touchedAt: faker.date.recent().toISOString(),
-        deletedAt: faker.datatype.boolean()
-            ? faker.date.recent().toISOString()
-            : undefined,
-        filePath: faker.helpers.uniqueArray(() => faker.system.filePath(), 2),
-        isMy: faker.datatype.boolean(),
-        author: faker.datatype.boolean()
-            ? {
-                id: faker.string.uuid(),
-                name: faker.person.fullName(),
-                email: faker.internet.email(),
-            }
-            : undefined,
-        bookmarked: faker.datatype.boolean(),
-        encrypted: faker.datatype.boolean(),
-        ...overrides,
-    };
-}
+const testNote = {
+    id: 'test-note-id',
+    meta: {
+        title: 'Test note',
+        published: false,
+    },
+    createdAt: '2024-01-01T00:00:00.000Z',
+    updatedAt: '2024-01-01T00:00:00.000Z',
+    touchedAt: '2024-01-01T00:00:00.000Z',
+    filePath: ['/test/note.org'],
+    isMy: true,
+    bookmarked: false,
+    encrypted: false,
+};
 test('Should encrypt note via keys', async () => {
     const noteText = '#+title: Test note\n\nBody text';
-    const note = generateNoteInfo();
-    note.meta.published = false;
-    const [encryptedNote, encryptedNoteText] = await encryptNote(note, {
+    const [encryptedNote, encryptedNoteText] = await encryptNote(testNote, {
         content: noteText,
         type: EncryptionType.GpgKeys,
         publicKey: armoredPublicKey,
@@ -49,13 +27,13 @@ test('Should encrypt note via keys', async () => {
         format: 'armored',
     });
     expect(encryptedNoteText.startsWith('-----BEGIN PGP MESSAGE-----')).toBe(true);
-    expect(encryptedNote).toMatchSnapshot();
+    expect(encryptedNote.encrypted).toBe(true);
+    expect(encryptedNote.id).toBe(testNote.id);
+    expect(encryptedNote.meta.id).toBeUndefined();
 });
 test('Should decrypt note via keys', async () => {
     const noteText = '#+title: Test note\n\nBody text';
-    const note = generateNoteInfo();
-    note.meta.published = false;
-    const [, encryptedNoteText] = await encryptNote(note, {
+    const [, encryptedNoteText] = await encryptNote(testNote, {
         content: noteText,
         type: EncryptionType.GpgKeys,
         publicKey: armoredPublicKey,
@@ -63,12 +41,15 @@ test('Should decrypt note via keys', async () => {
         privateKeyPassphrase,
         format: 'armored',
     });
-    const decryptedNote = await decryptNote(note, {
+    const [decryptedNote, decryptedText] = await decryptNote({ ...testNote, encrypted: true }, {
         content: encryptedNoteText,
         type: EncryptionType.GpgKeys,
         publicKey: armoredPublicKey,
         privateKey: armoredPrivateKey,
         privateKeyPassphrase,
     });
-    expect(decryptedNote).toMatchSnapshot();
+    expect(decryptedNote.encrypted).toBe(false);
+    expect(decryptedNote.id).toBe(testNote.id);
+    expect(decryptedNote.meta.title).toBe('Test note');
+    expect(decryptedText).toBe(noteText);
 });

package/models/command.d.ts

@@ -2,8 +2,10 @@ import { MaybeRefOrGetter } from 'vue';
 import { COMMAND_GROUPS } from "../constants/index.js";
 import { DefaultCommands } from './default-commands.js';
 import { OrgNoteApi } from "../api.js";
+import { VueComponent } from './vue-component.js';
 export type CommandGroup = (typeof COMMAND_GROUPS)[number] | (string & Record<never, never>);
 export type CommandName = DefaultCommands | (string & {});
+export type CommandIcon = string | VueComponent;
 export interface CommandHandlerParams<T = any> {
     event?: KeyboardEvent;
     data?: T;
@@ -14,7 +16,7 @@ export interface CommandPreview {
     description?: MaybeRefOrGetter<string | undefined>;
     command?: CommandName;
     title?: MaybeRefOrGetter<string | undefined>;
-    icon?: MaybeRefOrGetter<string | undefined>;
+    icon?: MaybeRefOrGetter<CommandIcon | undefined>;
 }
 export interface CommandMeta<T = any> extends Partial<CommandPreview> {
     group?: CommandGroup;

package/models/completion.d.ts

@@ -1,6 +1,7 @@
 import { MaybeRefOrGetter } from 'vue';
+import type { CommandIcon } from './command.js';
 export interface CompletionCandidate<T = unknown> {
-    icon?: MaybeRefOrGetter<string | undefined>;
+    icon?: MaybeRefOrGetter<CommandIcon | undefined>;
     group?: MaybeRefOrGetter<string | undefined>;
     title?: MaybeRefOrGetter<string | undefined>;
     description?: MaybeRefOrGetter<string | undefined>;

package/models/encryption.d.ts

@@ -14,11 +14,11 @@ export interface BaseOrgNoteDecryption {
 }
 declare const OrgNoteGpgEncryptionSchema: import("valibot").ObjectSchema<{
     readonly type: import("valibot").LiteralSchema<"gpgKeys", undefined>;
-    readonly privateKey: import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").MetadataAction<string, {
+    readonly privateKey: import("valibot").SchemaWithPipe<readonly [import("valibot").StringSchema<undefined>, import("valibot").MetadataAction<string, {
         readonly textarea: true;
         readonly upload: true;
     }>]>;
-    readonly publicKey: import("valibot").SchemaWithPipe<[import("valibot").OptionalSchema<import("valibot").StringSchema<undefined>, undefined>, import("valibot").MetadataAction<string, {
+    readonly publicKey: import("valibot").SchemaWithPipe<readonly [import("valibot").OptionalSchema<import("valibot").StringSchema<undefined>, undefined>, import("valibot").MetadataAction<string, {
         readonly textarea: true;
         readonly upload: true;
     }>]>;
@@ -30,13 +30,13 @@ declare const OrgNotePasswordEncryptionSchema: import("valibot").ObjectSchema<{
 }, undefined>;
 export declare const OrgNoteEncryptionSchema: import("valibot").IntersectSchema<[import("valibot").ObjectSchema<{
     readonly encryptFilesByDefault: import("valibot").OptionalSchema<import("valibot").BooleanSchema<undefined>, undefined>;
-}, undefined>, import("valibot").SchemaWithPipe<[import("valibot").UnionSchema<[import("valibot").ObjectSchema<{
+}, undefined>, import("valibot").SchemaWithPipe<readonly [import("valibot").UnionSchema<[import("valibot").ObjectSchema<{
     readonly type: import("valibot").LiteralSchema<"gpgKeys", undefined>;
-    readonly privateKey: import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").MetadataAction<string, {
+    readonly privateKey: import("valibot").SchemaWithPipe<readonly [import("valibot").StringSchema<undefined>, import("valibot").MetadataAction<string, {
         readonly textarea: true;
         readonly upload: true;
     }>]>;
-    readonly publicKey: import("valibot").SchemaWithPipe<[import("valibot").OptionalSchema<import("valibot").StringSchema<undefined>, undefined>, import("valibot").MetadataAction<string, {
+    readonly publicKey: import("valibot").SchemaWithPipe<readonly [import("valibot").OptionalSchema<import("valibot").StringSchema<undefined>, undefined>, import("valibot").MetadataAction<string, {
         readonly textarea: true;
         readonly upload: true;
     }>]>;

package/models/orgnote-config.d.ts

@@ -1,5 +1,5 @@
 import { InferOutput } from 'valibot';
-export declare const ORG_NOTE_CONFIG_SCHEMA: import("valibot").SchemaWithPipe<[import("valibot").ObjectWithRestSchema<{
+export declare const ORG_NOTE_CONFIG_SCHEMA: import("valibot").SchemaWithPipe<readonly [import("valibot").ObjectWithRestSchema<{
     readonly editor: import("valibot").ObjectSchema<{
         readonly showSpecialSymbols: import("valibot").BooleanSchema<undefined>;
         readonly showPropertyDrawer: import("valibot").BooleanSchema<undefined>;
@@ -39,13 +39,13 @@ export declare const ORG_NOTE_CONFIG_SCHEMA: import("valibot").SchemaWithPipe<[i
     }, undefined>;
     readonly encryption: import("valibot").IntersectSchema<[import("valibot").ObjectSchema<{
         readonly encryptFilesByDefault: import("valibot").OptionalSchema<import("valibot").BooleanSchema<undefined>, undefined>;
-    }, undefined>, import("valibot").SchemaWithPipe<[import("valibot").UnionSchema<[import("valibot").ObjectSchema<{
+    }, undefined>, import("valibot").SchemaWithPipe<readonly [import("valibot").UnionSchema<[import("valibot").ObjectSchema<{
         readonly type: import("valibot").LiteralSchema<"gpgKeys", undefined>;
-        readonly privateKey: import("valibot").SchemaWithPipe<[import("valibot").StringSchema<undefined>, import("valibot").MetadataAction<string, {
+        readonly privateKey: import("valibot").SchemaWithPipe<readonly [import("valibot").StringSchema<undefined>, import("valibot").MetadataAction<string, {
             readonly textarea: true;
             readonly upload: true;
         }>]>;
-        readonly publicKey: import("valibot").SchemaWithPipe<[import("valibot").OptionalSchema<import("valibot").StringSchema<undefined>, undefined>, import("valibot").MetadataAction<string, {
+        readonly publicKey: import("valibot").SchemaWithPipe<readonly [import("valibot").OptionalSchema<import("valibot").StringSchema<undefined>, undefined>, import("valibot").MetadataAction<string, {
             readonly textarea: true;
             readonly upload: true;
         }>]>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "orgnote-api",
-  "version": "0.40.13",
+  "version": "0.40.21",
   "description": "Official API for creating extensions for OrgNote app",
   "type": "module",
   "main": "./index.js",
@@ -21,7 +21,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/Artawower/orgnote-api"
+    "url": "git+https://github.com/Artawower/orgnote-api.git"
   },
   "exports": {
     ".": "./index.js",