orgnote-api 0.41.0 → 0.41.2

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, UseKeyboardState, NotificationsStoreDefinition, BufferStoreDefinition, BufferProviderStoreDefinition, Repositories, LogStoreDefinition, UseSystemInfo, ContextMenuStoreDefinition, QueueStoreDefinition, FileGuardStoreDefinition, FileWatcherStoreDefinition, BuildOrgNoteUrl, AuthStoreDefinition, FileSearchStoreDefinition, FileMetaStoreDefinition, FontStoreDefinition } from './models/index.js';
+import { InlineEmbeddedWidget, MultilineEmbeddedWidget, OrgLineClass, SyncStoreDefinition, BufferViewerStoreDefinition, CommandsStoreDefinition, CommandsGroupStoreDefinition, ModalStoreDefinition, SettingsStoreDefinition, SettingsUiStoreDefinition, MultipleUploadParams, UploadParams, CompletionStoreDefinition, PaneStoreDefinition, LayoutStoreDefinition, FileManagerStoreDefinition, UseScreenDetection, UseKeyboardState, NotificationsStoreDefinition, BufferStoreDefinition, BufferProviderStoreDefinition, Repositories, LogStoreDefinition, UseSystemInfo, ContextMenuStoreDefinition, QueueStoreDefinition, FileGuardStoreDefinition, FileWatcherStoreDefinition, BuildOrgNoteUrl, AuthStoreDefinition, FileSearchStoreDefinition, FileMetaStoreDefinition, FontStoreDefinition, EmbeddedBufferStoreDefinition } from './models/index.js';
 import { WebSocketClient } from './websocket/client.js';
 import { WidgetType } from './models/widget-type.js';
 import { NodeType } from 'org-mode-ast';
@@ -58,7 +58,7 @@ export interface OrgNoteApi {
         useLayout: LayoutStoreDefinition;
         useFileSystemManager: FileSystemManagerStoreDefinition;
         useFileManager: FileManagerStoreDefinition;
-        useFileReader: FileReaderStoreDefinition;
+        useBufferViewer: BufferViewerStoreDefinition;
         useNotifications: NotificationsStoreDefinition;
         useBuffers: BufferStoreDefinition;
         useBufferProviders: BufferProviderStoreDefinition;
@@ -75,6 +75,7 @@ export interface OrgNoteApi {
         useBabel: BabelStoreDefinition;
         useFileSearch: FileSearchStoreDefinition;
         useFileMeta: FileMetaStoreDefinition;
+        useEmbeddedBuffer: EmbeddedBufferStoreDefinition;
         app: App;
     };
     utils: {

package/constants/i18n-keys.d.ts

@@ -275,6 +275,7 @@ export declare const I18N: {
     EDITOR_INSERT_TAG: DefaultCommands.EDITOR_INSERT_TAG;
     EDITOR_INSERT_DATETIME: DefaultCommands.EDITOR_INSERT_DATETIME;
     EDITOR_HIDE_KEYBOARD: DefaultCommands.EDITOR_HIDE_KEYBOARD;
+    PREVIEW_NOTE: DefaultCommands.PREVIEW_NOTE;
     LOADING: i18n.LOADING;
     LOADING_MESSAGE_1: i18n.LOADING_MESSAGE_1;
     LOADING_MESSAGE_2: i18n.LOADING_MESSAGE_2;

package/constants/route-names.d.ts

@@ -9,6 +9,8 @@ export declare enum RouteNames {
     EditNote = "EditNote",
     EditCode = "EditCode",
     File = "File",
+    Remote = "Remote",
+    Embedded = "Embedded",
     SettingsPage = "SettingsPage",
     SystemSettings = "SystemSettings",
     ExtensionsSettings = "ExtensionsSettings",

package/constants/route-names.js

@@ -10,6 +10,8 @@ export var RouteNames;
     RouteNames["EditNote"] = "EditNote";
     RouteNames["EditCode"] = "EditCode";
     RouteNames["File"] = "File";
+    RouteNames["Remote"] = "Remote";
+    RouteNames["Embedded"] = "Embedded";
     RouteNames["SettingsPage"] = "SettingsPage";
     RouteNames["SystemSettings"] = "SystemSettings";
     RouteNames["ExtensionsSettings"] = "ExtensionsSettings";

package/models/buffer-viewer-store.d.ts

@@ -0,0 +1,22 @@
+import type { Component } from 'vue';
+import type { StoreDefinition } from './store.js';
+export type BufferViewerComponent = Component | (() => Promise<Component>);
+export interface ViewerMeta {
+    id: string;
+    name: string;
+    icon?: string;
+    priority?: number;
+}
+export interface BufferViewerEntry {
+    pattern: string;
+    component: BufferViewerComponent;
+    meta: ViewerMeta;
+}
+export interface BufferViewerStore {
+    register: (entry: BufferViewerEntry) => void;
+    unregister: (viewerId: string) => void;
+    getViewers: (path: string) => BufferViewerEntry[];
+    getViewer: (path: string) => BufferViewerEntry | undefined;
+    open: (uri: string) => Promise<void>;
+}
+export type BufferViewerStoreDefinition = StoreDefinition<BufferViewerStore>;

package/models/default-commands.d.ts

@@ -111,5 +111,6 @@ export declare enum DefaultCommands {
     EDITOR_INSERT_TABLE = "insert table",
     EDITOR_INSERT_TAG = "insert tag",
     EDITOR_INSERT_DATETIME = "insert datetime",
-    EDITOR_HIDE_KEYBOARD = "hide keyboard"
+    EDITOR_HIDE_KEYBOARD = "hide keyboard",
+    PREVIEW_NOTE = "preview note"
 }

package/models/default-commands.js

@@ -135,4 +135,6 @@ export var DefaultCommands;
     DefaultCommands["EDITOR_INSERT_TAG"] = "insert tag";
     DefaultCommands["EDITOR_INSERT_DATETIME"] = "insert datetime";
     DefaultCommands["EDITOR_HIDE_KEYBOARD"] = "hide keyboard";
+    // External commands
+    DefaultCommands["PREVIEW_NOTE"] = "preview note";
 })(DefaultCommands || (DefaultCommands = {}));

package/models/embedded-buffer-store.d.ts

@@ -0,0 +1,7 @@
+import type { StoreDefinition } from './store.js';
+export interface EmbeddedBufferStore {
+    create(text: string): string;
+    get(path: string): string | undefined;
+    remove(path: string): void;
+}
+export type EmbeddedBufferStoreDefinition = StoreDefinition<EmbeddedBufferStore>;

package/models/embedded-buffer-store.js

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

package/models/index.d.ts

@@ -46,7 +46,7 @@ export * from './system-info.js';
 export * from './keyboard-state.js';
 export * from './sync-store.js';
 export * from './files-store.js';
-export * from './file-opener-store.js';
+export * from './buffer-viewer-store.js';
 export * from './file-manager-store.js';
 export * from './auth-store.js';
 export * from './commands-store.js';
@@ -83,6 +83,7 @@ export * from './theme-store.js';
 export * from './font-store.js';
 export * from './file-search-store.js';
 export * from './file-meta-store.js';
+export * from './embedded-buffer-store.js';
 export * from './style-variant.js';
 export * from './style-size.js';
 export * from './repositories.js';

package/models/index.js

@@ -48,7 +48,7 @@ export * from "./keyboard-state.js";
 // Stores
 export * from "./sync-store.js";
 export * from "./files-store.js";
-export * from "./file-opener-store.js";
+export * from "./buffer-viewer-store.js";
 export * from "./file-manager-store.js";
 export * from "./auth-store.js";
 export * from "./commands-store.js";
@@ -85,6 +85,7 @@ export * from "./theme-store.js";
 export * from "./font-store.js";
 export * from "./file-search-store.js";
 export * from "./file-meta-store.js";
+export * from "./embedded-buffer-store.js";
 // UI
 export * from "./style-variant.js";
 export * from "./style-size.js";

package/package.json

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

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

@@ -1,22 +0,0 @@
-import type { Component } from 'vue';
-import type { StoreDefinition } from './store.js';
-export type FileReaderComponent = Component | (() => Promise<Component>);
-export interface ReaderMeta {
-    id: string;
-    name: string;
-    icon?: string;
-    priority?: number;
-}
-export interface FileReaderEntry {
-    pattern: string;
-    component: FileReaderComponent;
-    meta: ReaderMeta;
-}
-export interface FileReaderStore {
-    register: (entry: FileReaderEntry) => void;
-    unregister: (readerId: string) => void;
-    getReaders: (path: string) => FileReaderEntry[];
-    getReader: (path: string) => FileReaderEntry | undefined;
-    openFile: (path: string) => Promise<void>;
-}
-export type FileReaderStoreDefinition = StoreDefinition<FileReaderStore>;