orgnote-api 0.40.27 → 0.40.29

package/api.d.ts

@@ -14,6 +14,7 @@ import { GetCssVar, GetCssTheme, GetNumericCssVar, GetCssProperty, GetCssNumeric
 import { ThemeStoreDefinition } from './models/theme-store.js';
 import { UseBackgroundSettings } from './models/ui-store.js';
 import { SidebarStoreDefinition } from './models/sidebar-store.js';
+import { RightPanelStoreDefinition } from './models/right-panel-store.js';
 import { Logger } from './models/logger.js';
 import type { QVueGlobals } from 'quasar';
 import { ToolbarStoreDefinition } from './models/toolbar-store.js';
@@ -102,6 +103,7 @@ export interface OrgNoteApi {
         useSplashScreen: UseSplashScreen;
         useBackgroundSettings: UseBackgroundSettings;
         useSidebar: SidebarStoreDefinition;
+        useRightPanel: RightPanelStoreDefinition;
         useToolbar: ToolbarStoreDefinition;
         useModal: ModalStoreDefinition;
         useSettingsUi: SettingsUiStoreDefinition;

package/constants/i18n-keys.d.ts

@@ -164,6 +164,11 @@ export declare const I18N: {
     TOGGLE_FILE_MANAGER: DefaultCommands.TOGGLE_FILE_MANAGER;
     CREATE_NOTE: DefaultCommands.CREATE_NOTE;
     PROJECT_INFO: DefaultCommands.PROJECT_INFO;
+    TOGGLE_RIGHT_PANEL: DefaultCommands.TOGGLE_RIGHT_PANEL;
+    OPEN_BACKLINKS: DefaultCommands.OPEN_BACKLINKS;
+    OPEN_OUTLINE: DefaultCommands.OPEN_OUTLINE;
+    OPEN_LOCAL_GRAPH: DefaultCommands.OPEN_LOCAL_GRAPH;
+    TOGGLE_AST_DEBUGGER: DefaultCommands.TOGGLE_AST_DEBUGGER;
     SEARCH: DefaultCommands.SEARCH;
     TOGGLE_COMMANDS: DefaultCommands.TOGGLE_COMMANDS;
     RESTORE_COMPLETION: DefaultCommands.RESTORE_COMPLETION;

package/models/active-editor-context.d.ts

@@ -0,0 +1,8 @@
+import type { OrgNode } from 'org-mode-ast';
+import type { EditorView } from '@codemirror/view';
+export interface ActiveEditorContext {
+    orgNode: OrgNode | null;
+    cursorPosition: number;
+    editorViewGetter: () => EditorView | undefined;
+    filePath?: string;
+}

package/models/active-editor-context.js

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

package/models/default-commands.d.ts

@@ -7,6 +7,11 @@ export declare enum DefaultCommands {
     TOGGLE_FILE_MANAGER = "toggle file manager",
     CREATE_NOTE = "create note",
     PROJECT_INFO = "project info",
+    TOGGLE_RIGHT_PANEL = "toggle right panel",
+    OPEN_BACKLINKS = "open backlinks",
+    OPEN_OUTLINE = "open outline",
+    OPEN_LOCAL_GRAPH = "open local graph",
+    TOGGLE_AST_DEBUGGER = "toggle ast debugger",
     SEARCH = "search",
     TOGGLE_COMMANDS = "toggle commands",
     RESTORE_COMPLETION = "restore last completion",

package/models/default-commands.js

@@ -14,6 +14,12 @@ export var DefaultCommands;
     DefaultCommands["TOGGLE_FILE_MANAGER"] = "toggle file manager";
     DefaultCommands["CREATE_NOTE"] = "create note";
     DefaultCommands["PROJECT_INFO"] = "project info";
+    // Right panel
+    DefaultCommands["TOGGLE_RIGHT_PANEL"] = "toggle right panel";
+    DefaultCommands["OPEN_BACKLINKS"] = "open backlinks";
+    DefaultCommands["OPEN_OUTLINE"] = "open outline";
+    DefaultCommands["OPEN_LOCAL_GRAPH"] = "open local graph";
+    DefaultCommands["TOGGLE_AST_DEBUGGER"] = "toggle ast debugger";
     // Completion commands
     DefaultCommands["SEARCH"] = "search";
     DefaultCommands["TOGGLE_COMMANDS"] = "toggle commands";

package/models/editor-store.d.ts

@@ -3,14 +3,19 @@ import type { InlineEmbeddedWidgets, MultilineEmbeddedWidgets, OrgLineClasses }
 import type { EditorExtension } from './editor.js';
 import type { WidgetMeta } from '../api.js';
 import type { StoreDefinition } from './store.js';
+import type { ActiveEditorContext } from './active-editor-context.js';
 export interface EditorStore {
     inlineWidgets: ComputedRef<InlineEmbeddedWidgets>;
     multilineWidgets: ComputedRef<MultilineEmbeddedWidgets>;
     lineClasses: ComputedRef<OrgLineClasses>;
     extensions: ShallowRef<EditorExtension[]>;
+    activeContext: ShallowRef<ActiveEditorContext | null>;
     addWidgets: (...widgets: WidgetMeta[]) => void;
     removeWidget: (widgetId: string) => void;
     addExtensions: (...extensions: EditorExtension[]) => void;
     removeExtensions: (...extensions: EditorExtension[]) => void;
+    setActiveContext: (ctx: ActiveEditorContext) => void;
+    updateActiveContext: (ctx: Partial<ActiveEditorContext>) => void;
+    clearActiveContext: () => void;
 }
 export type EditorStoreDefinition = StoreDefinition<EditorStore>;

package/models/index.d.ts

@@ -7,6 +7,7 @@ export * from './widget.js';
 export * from './modal.js';
 export * from './widget-type.js';
 export * from './editor.js';
+export * from './active-editor-context.js';
 export * from './default-commands.js';
 export * from './encryption.js';
 export * from './file-system.js';
@@ -53,6 +54,8 @@ export * from './settings-store.js';
 export * from './encryption-store.js';
 export * from './ui-store.js';
 export * from './sidebar-store.js';
+export * from './panel.js';
+export * from './right-panel-store.js';
 export * from './toolbar-store.js';
 export * from './modal-store.js';
 export * from './settings-ui-store.js';

package/models/index.js

@@ -7,6 +7,7 @@ export * from "./widget.js";
 export * from "./modal.js";
 export * from "./widget-type.js";
 export * from "./editor.js";
+export * from "./active-editor-context.js";
 export * from "./default-commands.js";
 export * from "./encryption.js";
 export * from "./file-system.js";
@@ -55,6 +56,8 @@ export * from "./settings-store.js";
 export * from "./encryption-store.js";
 export * from "./ui-store.js";
 export * from "./sidebar-store.js";
+export * from "./panel.js";
+export * from "./right-panel-store.js";
 export * from "./toolbar-store.js";
 export * from "./modal-store.js";
 export * from "./settings-ui-store.js";

package/models/layout-store.d.ts

@@ -1,6 +1,6 @@
 import { ShallowRef } from 'vue';
 import { StoreDefinition } from './store.js';
-import { LayoutNode, DropDirection as SplitDirection } from './layout.js';
+import { LayoutNode, DropDirection as SplitDirection, PanePosition } from './layout.js';
 import { LayoutSnapshot } from './pane.js';
 export interface LayoutStore {
     layout: ShallowRef<LayoutNode | undefined>;
@@ -13,5 +13,6 @@ export interface LayoutStore {
     restoreLayout: () => Promise<void>;
     getLayoutSnapshot: () => LayoutSnapshot | undefined;
     restoreLayoutSnapshot: (snapshot: LayoutSnapshot) => Promise<void>;
+    getPanePosition: (paneId: string) => PanePosition | undefined;
 }
 export type LayoutStoreDefinition = StoreDefinition<LayoutStore>;

package/models/layout.d.ts

@@ -1,6 +1,12 @@
 export type LayoutOrientation = 'horizontal' | 'vertical';
 export type DropZone = 'left' | 'right' | 'top' | 'bottom' | 'center';
 export type DropDirection = 'left' | 'right' | 'top' | 'bottom';
+export type HorizontalPosition = 'left' | 'right' | 'center';
+export type VerticalPosition = 'top' | 'bottom' | 'center';
+export interface PanePosition {
+    horizontal: HorizontalPosition;
+    vertical: VerticalPosition;
+}
 export type LayoutNode = LayoutPaneNode | LayoutSplitNode;
 export interface LayoutPaneNode {
     type: 'pane';

package/models/panel.d.ts

@@ -0,0 +1,16 @@
+import type { Ref, ShallowRef } from 'vue';
+import type { VueComponent } from './vue-component.js';
+import type { ComponentConfig } from './sidebar-store.js';
+import type { CommandName } from './command.js';
+export interface Panel {
+    opened: Ref<boolean>;
+    component: ShallowRef<VueComponent | undefined>;
+    componentConfig: ShallowRef<ComponentConfig<VueComponent> | undefined>;
+    commands: Ref<CommandName[]>;
+    close: () => void;
+    open: () => void;
+    toggle: () => void;
+    openComponent: <T extends VueComponent>(cmp: T, config?: ComponentConfig<T>) => void;
+    addCommand: (command: CommandName) => void;
+    removeCommand: (command: CommandName) => void;
+}

package/models/panel.js

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

package/models/right-panel-store.d.ts

@@ -0,0 +1,8 @@
+import type { Ref } from 'vue';
+import type { StoreDefinition } from './store.js';
+import type { Panel } from './panel.js';
+export interface RightPanelStore extends Panel {
+    width: Ref<number>;
+    setWidth: (width: number) => void;
+}
+export type RightPanelStoreDefinition = StoreDefinition<RightPanelStore>;

package/models/right-panel-store.js

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

package/models/sidebar-store.d.ts

@@ -1,22 +1,13 @@
 import type { ExtractPropTypes, Ref } from 'vue';
-import { StoreDefinition } from './store.js';
-import type { ShallowRef } from 'vue';
+import type { StoreDefinition } from './store.js';
 import type { VueComponent } from './vue-component.js';
-import { CommandName } from './command.js';
+import type { Panel } from './panel.js';
+import type { CommandName } from './command.js';
 export type ComponentConfig<T extends VueComponent> = {
     componentProps?: ExtractPropTypes<T>;
 };
-export interface SidebarStore {
-    opened: Ref<boolean>;
-    component: ShallowRef<VueComponent | undefined>;
-    componentConfig: ShallowRef<ComponentConfig<VueComponent> | undefined>;
-    close: () => void;
-    open: () => void;
-    openComponent: <T extends VueComponent>(cmp: T, config?: ComponentConfig<T>) => void;
+export interface SidebarStore extends Panel {
     toggle: (cmp?: VueComponent) => void;
-    commands: Ref<CommandName[]>;
     footerCommands: Ref<CommandName[]>;
-    addCommand: (command: CommandName) => void;
-    removeCommand: (command: CommandName) => void;
 }
 export type SidebarStoreDefinition = StoreDefinition<SidebarStore>;

package/package.json

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