orgnote-api 0.40.39 → 0.41.0

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, Repositories, LogStoreDefinition, UseSystemInfo, ContextMenuStoreDefinition, QueueStoreDefinition, FileGuardStoreDefinition, FileWatcherStoreDefinition, BuildOrgNoteUrl, AuthStoreDefinition, FileSearchStoreDefinition, FileMetaStoreDefinition, FontStoreDefinition } from './models/index.js';
+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 { WebSocketClient } from './websocket/client.js';
 import { WidgetType } from './models/widget-type.js';
 import { NodeType } from 'org-mode-ast';
@@ -61,6 +61,7 @@ export interface OrgNoteApi {
         useFileReader: FileReaderStoreDefinition;
         useNotifications: NotificationsStoreDefinition;
         useBuffers: BufferStoreDefinition;
+        useBufferProviders: BufferProviderStoreDefinition;
         useSystemInfo: UseSystemInfo;
         useLog: LogStoreDefinition;
         useQueue: QueueStoreDefinition;

package/constants/i18n-keys.d.ts

@@ -136,6 +136,7 @@ export declare enum i18n {
     SYSTEM_INFO = "system info",
     FONTS = "fonts",
     FILE_DELETED_EXTERNALLY = "file was deleted externally",
+    BUFFER_READONLY = "buffer is read-only",
     IMAGE_LOAD_FAILED = "failed to load image",
     IMAGE_NOT_FOUND = "image not found",
     USED_SPACE = "used space",
@@ -402,6 +403,7 @@ export declare const I18N: {
     SYSTEM_INFO: i18n.SYSTEM_INFO;
     FONTS: i18n.FONTS;
     FILE_DELETED_EXTERNALLY: i18n.FILE_DELETED_EXTERNALLY;
+    BUFFER_READONLY: i18n.BUFFER_READONLY;
     IMAGE_LOAD_FAILED: i18n.IMAGE_LOAD_FAILED;
     IMAGE_NOT_FOUND: i18n.IMAGE_NOT_FOUND;
     USED_SPACE: i18n.USED_SPACE;

package/constants/i18n-keys.js

@@ -140,6 +140,7 @@ export var i18n;
     i18n["FONTS"] = "fonts";
     // Buffer
     i18n["FILE_DELETED_EXTERNALLY"] = "file was deleted externally";
+    i18n["BUFFER_READONLY"] = "buffer is read-only";
     // Images
     i18n["IMAGE_LOAD_FAILED"] = "failed to load image";
     i18n["IMAGE_NOT_FOUND"] = "image not found";

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

@@ -0,0 +1,9 @@
+import type { BufferProvider } from './buffer-provider.js';
+import type { BufferScheme } from './buffer-uri.js';
+import type { StoreDefinition } from './store.js';
+export interface BufferProviderStore {
+    register(provider: BufferProvider): void;
+    unregister(scheme: BufferScheme): void;
+    get(scheme: BufferScheme): BufferProvider | undefined;
+}
+export type BufferProviderStoreDefinition = StoreDefinition<BufferProviderStore>;

package/models/buffer-provider-store.js

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

package/models/buffer-provider.d.ts

@@ -0,0 +1,14 @@
+import type { FileSystemChange } from './file-system.js';
+import type { BufferScheme } from './buffer-uri.js';
+export interface BufferContext {
+    title?: string;
+    icon?: string;
+    [key: string]: unknown;
+}
+export interface BufferProvider {
+    readonly scheme: BufferScheme;
+    read(path: string): Promise<Uint8Array>;
+    write?(path: string, content: Uint8Array): Promise<void>;
+    watch?(path: string, callback: (change: FileSystemChange) => void): () => void;
+    getContext?(path: string): BufferContext;
+}

package/models/buffer-provider.js

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

package/models/buffer-store.d.ts

@@ -1,13 +1,13 @@
 import type { ComputedRef, Ref } from 'vue';
-import { StoreDefinition } from './store.js';
-import { Buffer } from './buffer.js';
+import type { StoreDefinition } from './store.js';
+import type { Buffer } from './buffer.js';
 export interface BufferStore {
     buffers: Ref<Map<string, Buffer>>;
     allBuffers: ComputedRef<Buffer[]>;
-    getOrCreateBuffer: (path: string) => Promise<Buffer>;
-    releaseBuffer: (path: string) => void;
-    closeBuffer: (path: string, force?: boolean) => Promise<boolean>;
-    getBufferByPath: (path: string) => Buffer | undefined;
+    getOrCreateBuffer: (uri: string) => Promise<Buffer>;
+    releaseBuffer: (uri: string) => void;
+    closeBuffer: (uri: string, force?: boolean) => Promise<boolean>;
+    getBufferByUri: (uri: string) => Buffer | undefined;
     saveAllBuffers: () => Promise<void>;
     cleanup: () => void;
 }

package/models/buffer-uri.d.ts

@@ -0,0 +1,9 @@
+export type BuiltinBufferScheme = 'file' | 'memory' | 'shared' | 'remote' | 'embedded';
+export type BufferScheme = BuiltinBufferScheme | (string & {});
+export interface BufferUri {
+    scheme: BufferScheme;
+    path: string;
+    raw: string;
+}
+export declare const parseBufferUri: (uri: string) => BufferUri;
+export declare const buildBufferUri: (scheme: BufferScheme, path: string) => string;

package/models/buffer-uri.js

@@ -0,0 +1,18 @@
+const DEFAULT_SCHEME = 'file';
+const SCHEME_SEPARATOR = '://';
+export const parseBufferUri = (uri) => {
+    const separatorIndex = uri.indexOf(SCHEME_SEPARATOR);
+    if (separatorIndex === -1) {
+        return {
+            scheme: DEFAULT_SCHEME,
+            path: uri,
+            raw: `${DEFAULT_SCHEME}${SCHEME_SEPARATOR}${uri}`,
+        };
+    }
+    return {
+        scheme: uri.slice(0, separatorIndex),
+        path: uri.slice(separatorIndex + SCHEME_SEPARATOR.length),
+        raw: uri,
+    };
+};
+export const buildBufferUri = (scheme, path) => `${scheme}${SCHEME_SEPARATOR}${path}`;

package/models/buffer.d.ts

@@ -1,4 +1,5 @@
 import type { ValidationState } from './file-guard.js';
+import type { BufferScheme } from './buffer-uri.js';
 type BufferError = string;
 export interface BufferMetadata<T = unknown> {
     [key: string]: T;
@@ -9,6 +10,8 @@ export interface BufferGuard {
     validation?: ValidationState;
 }
 export interface Buffer<T = unknown> {
+    uri: string;
+    scheme: BufferScheme;
     path: string;
     title: string;
     rawContent: Uint8Array;

package/models/index.d.ts

@@ -26,6 +26,9 @@ export * from './file-upload.js';
 export * from './confirmation-modal.js';
 export * from './pane.js';
 export * from './buffer.js';
+export * from './buffer-uri.js';
+export * from './buffer-provider.js';
+export * from './buffer-provider-store.js';
 export * from './log.js';
 export * from './logger.js';
 export * from './layout.js';

package/models/index.js

@@ -26,6 +26,9 @@ export * from "./file-upload.js";
 export * from "./confirmation-modal.js";
 export * from "./pane.js";
 export * from "./buffer.js";
+export * from "./buffer-uri.js";
+export * from "./buffer-provider.js";
+export * from "./buffer-provider-store.js";
 export * from "./log.js";
 export * from "./logger.js";
 export * from "./layout.js";

package/package.json

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