orgnote-api 0.40.29 → 0.40.32

package/api.d.ts

@@ -1,4 +1,4 @@
-import { InlineEmbeddedWidget, MultilineEmbeddedWidget, OrgLineClass, SyncStoreDefinition, FileReaderStoreDefinition, CommandsStoreDefinition, CommandsGroupStoreDefinition, ModalStoreDefinition, SettingsStoreDefinition, SettingsUiStoreDefinition, MultipleUploadParams, UploadParams, CompletionStoreDefinition, PaneStoreDefinition, LayoutStoreDefinition, FileManagerStoreDefinition, UseScreenDetection, NotificationsStoreDefinition, BufferStoreDefinition, Repositories, LogStoreDefinition, UseSystemInfo, ContextMenuStoreDefinition, QueueStoreDefinition, FileGuardStoreDefinition, FileWatcherStoreDefinition, BuildOrgNoteUrl, AuthStoreDefinition } from './models/index.js';
+import { InlineEmbeddedWidget, MultilineEmbeddedWidget, OrgLineClass, SyncStoreDefinition, FileReaderStoreDefinition, CommandsStoreDefinition, CommandsGroupStoreDefinition, ModalStoreDefinition, SettingsStoreDefinition, SettingsUiStoreDefinition, MultipleUploadParams, UploadParams, CompletionStoreDefinition, PaneStoreDefinition, LayoutStoreDefinition, FileManagerStoreDefinition, UseScreenDetection, NotificationsStoreDefinition, BufferStoreDefinition, Repositories, LogStoreDefinition, UseSystemInfo, ContextMenuStoreDefinition, QueueStoreDefinition, FileGuardStoreDefinition, FileWatcherStoreDefinition, BuildOrgNoteUrl, AuthStoreDefinition, FileSearchStoreDefinition, FileMetaStoreDefinition } from './models/index.js';
 import { WebSocketClient } from './websocket/client.js';
 import { WidgetType } from './models/widget-type.js';
 import { NodeType } from 'org-mode-ast';
@@ -72,6 +72,8 @@ export interface OrgNoteApi {
         useSync: SyncStoreDefinition;
         useEditor: EditorStoreDefinition;
         useBabel: BabelStoreDefinition;
+        useFileSearch: FileSearchStoreDefinition;
+        useFileMeta: FileMetaStoreDefinition;
         app: App;
     };
     utils: {

package/constants/i18n-keys.d.ts

@@ -153,7 +153,9 @@ export declare enum i18n {
     AUTH_INVALID_CALLBACK_PARAMS = "invalid authentication callback parameters",
     AUTH_REMOVE_ACCOUNT_DESCRIPTION = "permanently delete your account",
     AUTH_GROUP = "auth",
-    TABS_COUNT = "tabsCount"
+    TABS_COUNT = "tabsCount",
+    TOC_NO_ACTIVE_DOCUMENT = "no active document",
+    TOC_NO_HEADLINES_FOUND = "no headlines found"
 }
 export declare const I18N: {
     REPORT_BUG: DefaultCommands.REPORT_BUG;
@@ -241,6 +243,7 @@ export declare const I18N: {
     LOGIN: DefaultCommands.LOGIN;
     LOGOUT: DefaultCommands.LOGOUT;
     REMOVE_ACCOUNT: DefaultCommands.REMOVE_ACCOUNT;
+    INIT_SEARCH_INDEX: DefaultCommands.INIT_SEARCH_INDEX;
     LOADING: i18n.LOADING;
     LOADING_MESSAGE_1: i18n.LOADING_MESSAGE_1;
     LOADING_MESSAGE_2: i18n.LOADING_MESSAGE_2;
@@ -387,5 +390,7 @@ export declare const I18N: {
     AUTH_REMOVE_ACCOUNT_DESCRIPTION: i18n.AUTH_REMOVE_ACCOUNT_DESCRIPTION;
     AUTH_GROUP: i18n.AUTH_GROUP;
     TABS_COUNT: i18n.TABS_COUNT;
+    TOC_NO_ACTIVE_DOCUMENT: i18n.TOC_NO_ACTIVE_DOCUMENT;
+    TOC_NO_HEADLINES_FOUND: i18n.TOC_NO_HEADLINES_FOUND;
 };
 export type I18N = i18n | DefaultCommands;

package/constants/i18n-keys.js

@@ -162,6 +162,9 @@ export var i18n;
     i18n["AUTH_GROUP"] = "auth";
     // Tabs
     i18n["TABS_COUNT"] = "tabsCount";
+    // TOC
+    i18n["TOC_NO_ACTIVE_DOCUMENT"] = "no active document";
+    i18n["TOC_NO_HEADLINES_FOUND"] = "no headlines found";
 })(i18n || (i18n = {}));
 export const I18N = {
     ...i18n,

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

@@ -8,13 +8,6 @@ const testNote = {
         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';
@@ -27,9 +20,7 @@ test('Should encrypt note via keys', async () => {
         format: 'armored',
     });
     expect(encryptedNoteText.startsWith('-----BEGIN PGP MESSAGE-----')).toBe(true);
-    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';
@@ -41,15 +32,14 @@ test('Should decrypt note via keys', async () => {
         privateKeyPassphrase,
         format: 'armored',
     });
-    const [decryptedNote, decryptedText] = await decryptNote({ ...testNote, encrypted: true }, {
+    const [decryptedNote, decryptedText] = await decryptNote(testNote, {
         content: encryptedNoteText,
         type: EncryptionType.GpgKeys,
         publicKey: armoredPublicKey,
         privateKey: armoredPrivateKey,
         privateKeyPassphrase,
     });
-    expect(decryptedNote.encrypted).toBe(false);
     expect(decryptedNote.id).toBe(testNote.id);
-    expect(decryptedNote.meta.title).toBe('Test note');
+    expect(decryptedNote.meta?.title).toBe('Test note');
     expect(decryptedText).toBe(noteText);
 });

package/mappers/index.d.ts

@@ -1 +1 @@
-export * from './orgnode-to-note.js';
+export * from './orgnode-to-file-meta.js';

package/mappers/index.js

@@ -1 +1 @@
-export * from "./orgnode-to-note.js";
+export * from "./orgnode-to-file-meta.js";

package/mappers/orgnode-to-file-meta.d.ts

@@ -0,0 +1,3 @@
+import { OrgNode } from 'org-mode-ast';
+import { DiskFile, FileMeta } from "../models/index.js";
+export declare function orgnodeToFileMeta(orgnode: OrgNode, fileInfo: DiskFile): FileMeta;

package/mappers/{orgnode-to-note.js → orgnode-to-file-meta.js}

@@ -1,9 +1,10 @@
 import { splitPath } from "../utils/index.js";
-export function orgnodeToNoteInfo(orgnode, fileInfo, isMy) {
+export function orgnodeToFileMeta(orgnode, fileInfo) {
     return {
-        id: orgnode.meta.id,
-        isMy,
-        meta: orgnode.meta,
+        id: orgnode.meta.id ?? '',
+        title: orgnode.meta.title,
+        description: orgnode.meta.description,
+        tags: orgnode.meta.fileTags,
         filePath: splitPath(fileInfo.path),
         touchedAt: fileInfo.atime && new Date(fileInfo.atime).toISOString(),
         updatedAt: new Date(Math.max(fileInfo.mtime, fileInfo.ctime)).toISOString(),

package/models/default-commands.d.ts

@@ -83,5 +83,6 @@ export declare enum DefaultCommands {
     OPEN_EXTENSIONS_MANAGER = "open extensions manager",
     LOGIN = "login",
     LOGOUT = "logout",
-    REMOVE_ACCOUNT = "remove account"
+    REMOVE_ACCOUNT = "remove account",
+    INIT_SEARCH_INDEX = "init search index"
 }

package/models/default-commands.js

@@ -105,4 +105,6 @@ export var DefaultCommands;
     DefaultCommands["LOGIN"] = "login";
     DefaultCommands["LOGOUT"] = "logout";
     DefaultCommands["REMOVE_ACCOUNT"] = "remove account";
+    // Search
+    DefaultCommands["INIT_SEARCH_INDEX"] = "init search index";
 })(DefaultCommands || (DefaultCommands = {}));

package/models/encryption-store.d.ts

@@ -1,10 +1,7 @@
 import { BaseOrgNoteEncryption, OrgNoteEncryption, BaseOrgNoteDecryption } from './encryption.js';
-import { NoteInfo } from './note.js';
 import { StoreDefinition } from './store.js';
 export interface EncryptionStore {
     encrypt: (text: string, format?: BaseOrgNoteEncryption['format'], encryptionConfig?: OrgNoteEncryption) => Promise<string>;
     decrypt: (content: string | Uint8Array, format?: BaseOrgNoteDecryption['format'], encryptionConfig?: OrgNoteEncryption) => Promise<string>;
-    encryptNote: (noteInfo: NoteInfo, noteText: string) => Promise<[NoteInfo, string]>;
-    decryptNote: (noteInfo: NoteInfo, noteText: string) => Promise<[NoteInfo, string | Uint8Array]>;
 }
 export type EncryptionStoreDefinition = StoreDefinition<EncryptionStore>;

package/models/file-meta-store.d.ts

@@ -0,0 +1,26 @@
+import type { FileMeta } from './file-meta.js';
+import type { StoreDefinition } from './store.js';
+export interface FileMetaStore {
+    getById(id: string): Promise<FileMeta | undefined>;
+    getByIds(ids: string[]): Promise<FileMeta[]>;
+    getByPath(filePath: string[]): Promise<FileMeta | undefined>;
+    getAll(options?: {
+        limit?: number;
+        offset?: number;
+        tags?: string[];
+    }): Promise<FileMeta[]>;
+    count(tags?: string[]): Promise<number>;
+    getTagsStats(): Promise<{
+        tag: string;
+        count: number;
+    }[]>;
+    save(meta: FileMeta): Promise<void>;
+    saveBulk(metas: FileMeta[]): Promise<void>;
+    delete(target: {
+        id: string;
+    } | {
+        path: string[];
+    }): Promise<void>;
+    clear(): Promise<void>;
+}
+export type FileMetaStoreDefinition = StoreDefinition<FileMetaStore>;

package/models/file-meta.d.ts

@@ -0,0 +1,18 @@
+export interface FileMetaFilter {
+    limit?: number;
+    offset?: number;
+    tags?: string[];
+}
+export interface FileMeta {
+    id: string;
+    filePath: string[];
+    title?: string;
+    description?: string;
+    tags?: string[];
+    links?: string[];
+    backlinks?: string[];
+    createdAt?: string;
+    updatedAt?: string;
+    touchedAt?: string;
+    deletedAt?: string;
+}

package/models/file-meta.js

@@ -0,0 +1 @@
+export {};

package/models/file-search-store.d.ts

@@ -0,0 +1,35 @@
+import type { Ref, ComputedRef } from 'vue';
+import type { FileMeta } from './file-meta.js';
+import type { StoreDefinition } from './store.js';
+export interface FileSearchResult {
+    files: FileMeta[];
+    total: number;
+    query: string;
+    searchedAt: number;
+}
+export interface FileIndexStats {
+    indexed: number;
+    total: number;
+}
+export interface FileSearchStore {
+    isSearching: Ref<boolean>;
+    isIndexing: Ref<boolean>;
+    lastSearchResult: Ref<FileSearchResult | null>;
+    indexStats: ComputedRef<FileIndexStats>;
+    search(query: string, options?: {
+        limit?: number;
+        offset?: number;
+    }): Promise<FileMeta[]>;
+    indexFile(filePath: string): Promise<void>;
+    indexFiles(): Promise<void>;
+    processFile(filePath: string): Promise<void>;
+    removeFile(target: {
+        id: string;
+    } | {
+        path: string[];
+    }): Promise<void>;
+    loadIndex(): Promise<boolean>;
+    saveIndex(): Promise<void>;
+    clearIndex(): Promise<void>;
+}
+export type FileSearchStoreDefinition = StoreDefinition<FileSearchStore>;

package/models/file-search-store.js

@@ -0,0 +1 @@
+export {};

package/models/index.d.ts

@@ -1,4 +1,4 @@
-export * from './note.js';
+export * from './file-meta.js';
 export * from './command.js';
 export * from './completion.js';
 export * from './extension.js';
@@ -76,6 +76,8 @@ export * from './cron-store.js';
 export * from './git-store.js';
 export * from './extension-registry-store.js';
 export * from './theme-store.js';
+export * from './file-search-store.js';
+export * from './file-meta-store.js';
 export * from './style-variant.js';
 export * from './style-size.js';
 export * from './repositories.js';

package/models/index.js

@@ -1,4 +1,4 @@
-export * from "./note.js";
+export * from "./file-meta.js";
 export * from "./command.js";
 export * from "./completion.js";
 export * from "./extension.js";
@@ -78,6 +78,8 @@ export * from "./cron-store.js";
 export * from "./git-store.js";
 export * from "./extension-registry-store.js";
 export * from "./theme-store.js";
+export * from "./file-search-store.js";
+export * from "./file-meta-store.js";
 // UI
 export * from "./style-variant.js";
 export * from "./style-size.js";

package/models/repositories.d.ts

@@ -1,9 +1,7 @@
 import { ExtensionSource } from './extension.js';
-import { FileInfo } from './file-info.js';
-import { FilePathInfo } from './file-path.js';
+import { FileMeta } from './file-meta.js';
 import { LayoutSnapshotRepository } from './layout-snapshot-repository.js';
 import { LoggerRepository } from './log-repository.js';
-import { NoteInfo } from './note.js';
 import { QueueTask } from './queue-task.js';
 export interface ExtensionSourceRepository {
     get(extensionName: string): Promise<ExtensionSource | undefined>;
@@ -15,52 +13,23 @@ export interface ExtensionSourceRepository {
     deleteBySource(source: string): Promise<void>;
     clear(): Promise<void>;
 }
-export interface FileInfoRepository {
-    upsert(file: FileInfo): Promise<void>;
-    bulkUpsert(file: FileInfo[]): Promise<void>;
-    update(filePath: string, file: Partial<FileInfo>): Promise<void>;
-    delete(filePath: string): Promise<void>;
-    markAsDelete(filePath: string, deletedAt?: Date): Promise<void>;
-    clear(): Promise<void>;
-    search(text: string): Promise<FileInfo[]>;
-    getByPath(path: string): Promise<FileInfo | undefined>;
-    getAll(): Promise<FileInfo[]>;
-    getFilesAfterUpdateTime(updatedTime?: Date): Promise<FileInfo[]>;
-    count(updatedTime?: Date): Promise<number>;
-}
-export interface NoteInfoRepository {
-    getNotesAfterUpdateTime(updatedTime?: string): Promise<NoteInfo[]>;
-    getDeletedNotes(): Promise<NoteInfo[]>;
-    saveNotes(notes: NoteInfo[]): Promise<void>;
-    putNote(note: NoteInfo): Promise<void>;
-    getById(id: string): Promise<NoteInfo | undefined>;
-    getByPath(path: string[]): Promise<NoteInfo | undefined>;
-    getNotesInfo(options?: {
+export interface FileRepository {
+    getById(id: string): Promise<FileMeta | undefined>;
+    getByIds(ids: string[]): Promise<FileMeta[]>;
+    getByPath(filePath: string[]): Promise<FileMeta | undefined>;
+    getAll(options?: {
         limit?: number;
         offset?: number;
-        searchText?: string;
         tags?: string[];
-        bookmarked?: boolean;
-    }): Promise<NoteInfo[]>;
-    deleteNotes(noteIds: string[]): Promise<void>;
-    markAsDeleted(noteIds: string[]): Promise<void>;
-    bulkPartialUpdate(updates: {
-        id: string;
-        changes: Partial<NoteInfo>;
-    }[]): Promise<void>;
-    count(searchText?: string, tags?: string[]): Promise<number>;
-    getFilePaths(): Promise<FilePathInfo[]>;
-    touchNote(noteId: string): Promise<void>;
-    getTagsStatistic(): Promise<{
+    }): Promise<FileMeta[]>;
+    save(meta: FileMeta): Promise<void>;
+    saveBulk(metas: FileMeta[]): Promise<void>;
+    delete(id: string): Promise<void>;
+    count(tags?: string[]): Promise<number>;
+    getTagsStats(): Promise<{
         tag: string;
         count: number;
     }[]>;
-    addBookmark(noteId: string): Promise<void>;
-    deleteBookmark(noteId: string): Promise<void>;
-    modify(modifyCallback: (note: NoteInfo, ref: {
-        value: NoteInfo;
-    }) => void): Promise<void>;
-    getIds(filterCb?: (n: NoteInfo) => boolean): Promise<string[]>;
     clear(): Promise<void>;
 }
 export interface QueueRepository {
@@ -80,11 +49,17 @@ export interface QueueRepository {
     clear(queueId: string): Promise<void>;
     setStatus: (id: string, status: string) => Promise<void>;
 }
+export interface KeyValueRepository {
+    get(key: string): Promise<string | undefined>;
+    set(key: string, value: string): Promise<void>;
+    delete(key: string): Promise<void>;
+    clear(): Promise<void>;
+}
 export interface Repositories {
     logRepository: LoggerRepository;
-    fileInfoRepository: FileInfoRepository;
-    noteInfoRepository: NoteInfoRepository;
     layoutSnapshotRepository: LayoutSnapshotRepository;
     queueRepository: QueueRepository;
     extensionSourceRepository: ExtensionSourceRepository;
+    keyValueRepository: KeyValueRepository;
+    fileRepository: FileRepository;
 }

package/models/user.d.ts

@@ -1,4 +1,11 @@
 import { ModelsUserPersonalInfo } from "../remote-api/index.js";
-import { PublicUser } from './note.js';
+export interface PublicUser {
+    id?: string;
+    name?: string;
+    nickName?: string;
+    avatarUrl?: string;
+    email?: string;
+    profileUrl?: string;
+}
 export type User = PublicUser;
 export type PersonalInfo = ModelsUserPersonalInfo;

package/package.json

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

package/mappers/orgnode-to-note.d.ts

@@ -1,3 +0,0 @@
-import { OrgNode } from 'org-mode-ast';
-import { DiskFile, NoteInfo } from "../models/index.js";
-export declare function orgnodeToNoteInfo(orgnode: OrgNode, fileInfo: DiskFile, isMy?: boolean): NoteInfo;

package/models/note.d.ts

@@ -1,40 +0,0 @@
-import type { EncryptionType } from './encryption.js';
-export interface NotesFilter {
-    searchText?: string;
-    userId?: string;
-    limit?: number;
-    offset?: number;
-}
-export interface NoteMeta {
-    id?: string;
-    title?: string;
-    description?: string;
-    fileTags?: string[];
-    previewImg?: string;
-    published?: boolean;
-    startup?: string;
-    images?: string[];
-    connectedNotes?: Record<string, string>;
-}
-export interface PublicUser {
-    id?: string;
-    name?: string;
-    nickName?: string;
-    avatarUrl?: string;
-    email?: string;
-    profileUrl?: string;
-}
-export interface NoteInfo {
-    id?: string;
-    meta: NoteMeta;
-    createdAt?: string;
-    encryptionType?: EncryptionType;
-    updatedAt?: string;
-    touchedAt?: string;
-    deletedAt?: string;
-    filePath?: string[];
-    isMy?: boolean;
-    author?: PublicUser;
-    bookmarked?: boolean;
-    encrypted?: boolean;
-}