orgnote-api 0.20.1 → 0.40.0

package/api.d.ts

@@ -1,10 +1,29 @@
-import { Command, CSSVariable, ThemeVariable, Note, InlineEmbeddedWidget, MultilineEmbeddedWidget, OrgLineClass, FileSystem, WidgetBuilder, CommandPreview, OrgNoteEncryption, Modal, SyncStoreDefinition, FilesStoreDefinition, FileOpenerStoreDefinition, FileManageStoreDefinition } from './models/index.js';
-import type { NavigationFailure } from 'vue-router';
+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 { WebSocketClient } from './websocket/client.js';
 import { WidgetType } from './models/widget-type.js';
-import type { Component } from 'vue';
 import { NodeType } from 'org-mode-ast';
-import { EditorExtension } from './models/editor.js';
-import { AuthStoreDefinition } from './models/auth-store.js';
+import { ExtensionStoreDefinition } from './models/extension-store.js';
+import { FileSystemStoreDefinition } from './models/file-system-store.js';
+import { EncryptionStoreDefinition } from './models/encryption-store.js';
+import { PlatformSpecificFn } from './models/platform-specific.js';
+import { PlatformDetection, PlatformMatch } from './models/platform-detection.js';
+import { UseSplashScreen } from './models/splash-screen.js';
+import { GetCssVar, GetCssTheme, GetNumericCssVar, GetCssProperty, GetCssNumericProperty, ApplyCSSVariables, ResetCSSVariables, ApplyScopedStyles, RemoveScopedStyles } from './models/css-utils.js';
+import { ThemeStoreDefinition } from './models/theme-store.js';
+import { UseBackgroundSettings } from './models/ui-store.js';
+import { SidebarStoreDefinition } from './models/sidebar-store.js';
+import { Logger } from './models/logger.js';
+import type { QVueGlobals } from 'quasar';
+import { ToolbarStoreDefinition } from './models/toolbar-store.js';
+import type { App } from 'vue';
+import { UseConfirmationModal } from './models/confirmation-modal.js';
+import { FileSystemManagerStoreDefinition } from './models/file-system-manager-store.js';
+import { ConfigStoreDefinition } from './models/config-store.js';
+import { Router } from 'vue-router';
+import { CronStoreDefinition } from './models/cron-store.js';
+import { GitStoreDefinition } from './models/git-store.js';
+import { ExtensionRegistryStoreDefinition } from './models/extension-registry-store.js';
+import { parseToml, stringifyToml } from './utils/index.js';
 type WithNodeType<T> = {
     nodeType: NodeType;
 } & T;
@@ -15,104 +34,80 @@ export type WidgetMeta = ({
 } & WithNodeType<MultilineEmbeddedWidget>) | ({
     type: WidgetType.LineClass;
 } & WithNodeType<OrgLineClass>);
+export type Infrastructure = Repositories & {
+    websocket: WebSocketClient;
+};
 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;
-        };
-    };
+    infrastructure: Infrastructure;
     core: {
-        useFileSystem: () => FileSystem;
-        useSyncStore: SyncStoreDefinition;
-        useFilesStore: FilesStoreDefinition;
-        useFileOpenerStore: FileOpenerStoreDefinition;
-        useFileManagerStore: FileManageStoreDefinition;
-        useAuthStore: AuthStoreDefinition;
-    };
-    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;
-}
-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';
-    };
-    vault: {
-        type: 'inmemory' | 'filesystem';
-        path?: string;
+        useCommands: CommandsStoreDefinition;
+        useCommandsGroup: CommandsGroupStoreDefinition;
+        useExtensions: ExtensionStoreDefinition;
+        useFileSystem: FileSystemStoreDefinition;
+        useFileWatcher: FileWatcherStoreDefinition;
+        useEncryption: EncryptionStoreDefinition;
+        useSettings: SettingsStoreDefinition;
+        useConfig: ConfigStoreDefinition;
+        useQuasar: () => QVueGlobals;
+        useCompletion: CompletionStoreDefinition;
+        usePane: PaneStoreDefinition;
+        useLayout: LayoutStoreDefinition;
+        useFileSystemManager: FileSystemManagerStoreDefinition;
+        useFileManager: FileManagerStoreDefinition;
+        useFileReader: FileReaderStoreDefinition;
+        useNotifications: NotificationsStoreDefinition;
+        useBuffers: BufferStoreDefinition;
+        useSystemInfo: UseSystemInfo;
+        useLog: LogStoreDefinition;
+        useQueue: QueueStoreDefinition;
+        useCron: CronStoreDefinition;
+        useGit: GitStoreDefinition;
+        useExtensionRegistry: ExtensionRegistryStoreDefinition;
+        useFileGuard: FileGuardStoreDefinition;
+        useAuth: AuthStoreDefinition;
+        useSync: SyncStoreDefinition;
+        app: App;
+    };
+    utils: {
+        platform: PlatformDetection;
+        platformMatch: PlatformMatch;
+        clientOnly: PlatformSpecificFn;
+        mobileOnly: PlatformSpecificFn;
+        androidOnly: PlatformSpecificFn;
+        desktopOnly: PlatformSpecificFn;
+        serverOnly: PlatformSpecificFn;
+        getCssVar: GetCssVar;
+        getCssTheme: GetCssTheme;
+        getNumericCssVar: GetNumericCssVar;
+        getCssProperty: GetCssProperty;
+        getCssNumericProperty: GetCssNumericProperty;
+        applyCSSVariables: ApplyCSSVariables<string>;
+        resetCSSVariables: ResetCSSVariables<string>;
+        applyScopedStyles: ApplyScopedStyles;
+        removeScopedStyles: RemoveScopedStyles;
+        copyToClipboard: (text: string) => Promise<void>;
+        uploadFiles: (params: MultipleUploadParams) => Promise<FileList>;
+        uploadFile: (params?: UploadParams) => Promise<File | undefined>;
+        logger: Logger;
+        parseToml: typeof parseToml;
+        stringifyToml: typeof stringifyToml;
+        buildOrgNoteUrl: BuildOrgNoteUrl;
     };
     ui: {
-        showUserProfiles: boolean;
-        theme: 'light' | 'dark' | 'auto';
-        darkThemeName?: string;
-        lightThemeName?: string;
-    };
-    extensions: {
-        sources: string[];
+        useSplashScreen: UseSplashScreen;
+        useBackgroundSettings: UseBackgroundSettings;
+        useSidebar: SidebarStoreDefinition;
+        useToolbar: ToolbarStoreDefinition;
+        useModal: ModalStoreDefinition;
+        useSettingsUi: SettingsUiStoreDefinition;
+        useConfirmationModal: UseConfirmationModal;
+        useScreenDetection: UseScreenDetection;
+        useContextMenu: ContextMenuStoreDefinition;
+        useTheme: ThemeStoreDefinition;
+    };
+    vue: {
+        router: Router;
     };
-    encryption: OrgNoteEncryption;
 }
 export {};

package/constants/{command-groups.contant.d.ts → command-groups.d.ts}

@@ -3,5 +3,6 @@ export declare const EDITOR_COMMAND_GROUP = "editor";
 export declare const GLOBAL_COMMAND_GROUP = "global";
 export declare const NOTE_DETAIL_COMMAND_GROUP = "note-detail";
 export declare const COMPLETION_COMMAND_GROUP = "completion";
-export declare const COMMAND_GROUPS: readonly ["settings", "editor", "global", "note-detail", "completion"];
+export declare const TABS_COMMAND_GROUP = "tabs";
+export declare const COMMAND_GROUPS: readonly ["settings", "editor", "global", "note-detail", "completion", "tabs"];
 export declare const DEFAULT_KEYBINDING_GROUP = "default";

package/constants/{command-groups.contant.js → command-groups.js}

@@ -3,11 +3,13 @@ export const EDITOR_COMMAND_GROUP = 'editor';
 export const GLOBAL_COMMAND_GROUP = 'global';
 export const NOTE_DETAIL_COMMAND_GROUP = 'note-detail';
 export const COMPLETION_COMMAND_GROUP = 'completion';
+export const TABS_COMMAND_GROUP = 'tabs';
 export const COMMAND_GROUPS = [
     SETTINGS_COMMAND_GROUP,
     EDITOR_COMMAND_GROUP,
     GLOBAL_COMMAND_GROUP,
     NOTE_DETAIL_COMMAND_GROUP,
     COMPLETION_COMMAND_GROUP,
+    TABS_COMMAND_GROUP,
 ];
 export const DEFAULT_KEYBINDING_GROUP = 'default';

package/constants/extension-errors.d.ts

@@ -0,0 +1,9 @@
+export declare class ExtensionMissingDefaultExportError extends Error {
+    constructor();
+}
+export declare class ExtensionInvalidManifestError extends Error {
+    constructor();
+}
+export declare class ExtensionParsingError extends Error {
+    constructor(fileName: string, options?: ErrorOptions);
+}

package/constants/extension-errors.js

@@ -0,0 +1,18 @@
+export class ExtensionMissingDefaultExportError extends Error {
+    constructor() {
+        super('Extension must have a default export with onMounted handler');
+        this.name = 'ExtensionMissingDefaultExportError';
+    }
+}
+export class ExtensionInvalidManifestError extends Error {
+    constructor() {
+        super('Extension must export a manifest object');
+        this.name = 'ExtensionInvalidManifestError';
+    }
+}
+export class ExtensionParsingError extends Error {
+    constructor(fileName, options) {
+        super(`Failed to parse extension "${fileName}"`, options);
+        this.name = 'ExtensionParsingError';
+    }
+}

package/constants/file-guard-errors.d.ts

@@ -0,0 +1,8 @@
+import type { ValidationError } from '../models/file-guard.js';
+export declare class FileReadOnlyError extends Error {
+    constructor(path: string, reason?: string);
+}
+export declare class FileValidationError extends Error {
+    readonly errors: ValidationError[];
+    constructor(path: string, errors: ValidationError[]);
+}

package/constants/file-guard-errors.js

@@ -0,0 +1,18 @@
+export class FileReadOnlyError extends Error {
+    constructor(path, reason) {
+        const message = reason
+            ? `Cannot write to read-only file: ${path}. Reason: ${reason}`
+            : `Cannot write to read-only file: ${path}`;
+        super(message);
+        this.name = 'FileReadOnlyError';
+    }
+}
+export class FileValidationError extends Error {
+    errors;
+    constructor(path, errors) {
+        const message = `Validation failed for: ${path}`;
+        super(message);
+        this.name = 'FileValidationError';
+        this.errors = errors;
+    }
+}

package/constants/git-errors.d.ts

@@ -0,0 +1,9 @@
+export declare class GitFileNotFoundError extends Error {
+    constructor(path: string);
+}
+export declare class GitRepoNotFoundError extends Error {
+    constructor(url: string);
+}
+export declare class GitNetworkError extends Error {
+    constructor(message: string);
+}

package/constants/git-errors.js

@@ -0,0 +1,18 @@
+export class GitFileNotFoundError extends Error {
+    constructor(path) {
+        super(`Git file not found: ${path}`);
+        this.name = 'GitFileNotFoundError';
+    }
+}
+export class GitRepoNotFoundError extends Error {
+    constructor(url) {
+        super(`Git repository not found: ${url}`);
+        this.name = 'GitRepoNotFoundError';
+    }
+}
+export class GitNetworkError extends Error {
+    constructor(message) {
+        super(`Git network error: ${message}`);
+        this.name = 'GitNetworkError';
+    }
+}