orgnote-api 0.40.24 → 0.40.26

package/api.d.ts

@@ -3,6 +3,8 @@ import { WebSocketClient } from './websocket/client.js';
 import { WidgetType } from './models/widget-type.js';
 import { NodeType } from 'org-mode-ast';
 import { ExtensionStoreDefinition } from './models/extension-store.js';
+import { EditorStoreDefinition } from './models/editor-store.js';
+import { BabelStoreDefinition } from './models/babel-store.js';
 import { FileSystemStoreDefinition } from './models/file-system-store.js';
 import { EncryptionStoreDefinition } from './models/encryption-store.js';
 import { PlatformSpecificFn } from './models/platform-specific.js';
@@ -67,6 +69,8 @@ export interface OrgNoteApi {
         useFileGuard: FileGuardStoreDefinition;
         useAuth: AuthStoreDefinition;
         useSync: SyncStoreDefinition;
+        useEditor: EditorStoreDefinition;
+        useBabel: BabelStoreDefinition;
         app: App;
     };
     utils: {

package/constants/i18n-keys.d.ts

@@ -135,6 +135,8 @@ export declare enum i18n {
     CONFIRM_CLEAR_LOGS = "confirm clear logs",
     SYSTEM_INFO = "system info",
     FILE_DELETED_EXTERNALLY = "file was deleted externally",
+    IMAGE_LOAD_FAILED = "failed to load image",
+    IMAGE_NOT_FOUND = "image not found",
     USED_SPACE = "used space",
     STORAGE = "storage",
     AUTHENTICATION_STATUS = "authentication status",
@@ -212,7 +214,6 @@ export declare const I18N: {
     CONFIRM_FILE_DELETION: DefaultCommands.CONFIRM_FILE_DELETION;
     NEW_FILE_PATH: DefaultCommands.NEW_FILE_PATH;
     OPEN_NOTE: DefaultCommands.OPEN_NOTE;
-    OPEN_CODE_EDITOR: DefaultCommands.OPEN_CODE_EDITOR;
     TABS: DefaultCommands.TABS;
     SHOW_TAB_SWITCHER: DefaultCommands.SHOW_TAB_SWITCHER;
     CLOSE_TAB: DefaultCommands.CLOSE_TAB;
@@ -361,6 +362,8 @@ export declare const I18N: {
     CONFIRM_CLEAR_LOGS: i18n.CONFIRM_CLEAR_LOGS;
     SYSTEM_INFO: i18n.SYSTEM_INFO;
     FILE_DELETED_EXTERNALLY: i18n.FILE_DELETED_EXTERNALLY;
+    IMAGE_LOAD_FAILED: i18n.IMAGE_LOAD_FAILED;
+    IMAGE_NOT_FOUND: i18n.IMAGE_NOT_FOUND;
     USED_SPACE: i18n.USED_SPACE;
     STORAGE: i18n.STORAGE;
     AUTHENTICATION_STATUS: i18n.AUTHENTICATION_STATUS;

package/constants/i18n-keys.js

@@ -139,6 +139,9 @@ export var i18n;
     i18n["SYSTEM_INFO"] = "system info";
     // Buffer
     i18n["FILE_DELETED_EXTERNALLY"] = "file was deleted externally";
+    // Images
+    i18n["IMAGE_LOAD_FAILED"] = "failed to load image";
+    i18n["IMAGE_NOT_FOUND"] = "image not found";
     // Subscription limits
     i18n["USED_SPACE"] = "used space";
     i18n["STORAGE"] = "storage";

package/constants/route-names.d.ts

@@ -8,6 +8,7 @@ export declare enum RouteNames {
     UserGraph = "UserGraph",
     EditNote = "EditNote",
     EditCode = "EditCode",
+    File = "File",
     SettingsPage = "SettingsPage",
     SystemSettings = "SystemSettings",
     ExtensionsSettings = "ExtensionsSettings",

package/constants/route-names.js

@@ -9,6 +9,7 @@ export var RouteNames;
     RouteNames["UserGraph"] = "UserGraph";
     RouteNames["EditNote"] = "EditNote";
     RouteNames["EditCode"] = "EditCode";
+    RouteNames["File"] = "File";
     RouteNames["SettingsPage"] = "SettingsPage";
     RouteNames["SystemSettings"] = "SystemSettings";
     RouteNames["ExtensionsSettings"] = "ExtensionsSettings";

package/models/babel-store.d.ts

@@ -0,0 +1,13 @@
+import type { Ref } from 'vue';
+import type { StoreDefinition } from './store.js';
+export interface OrgBabel {
+    executor: (code: string) => Promise<string> | string;
+    languages?: string[];
+}
+export interface BabelStore {
+    orgBabels: Ref<Record<string, OrgBabel>>;
+    register: (babel: OrgBabel) => void;
+    unregister: (languages: string[]) => void;
+    execute: (lang: string, code: string) => Promise<string>;
+}
+export type BabelStoreDefinition = StoreDefinition<BabelStore>;

package/models/babel-store.js

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

package/models/buffer.d.ts

@@ -11,7 +11,10 @@ export interface BufferGuard {
 export interface Buffer<T = unknown> {
     path: string;
     title: string;
-    content: string;
+    rawContent: Uint8Array;
+    readonly text: string;
+    readonly base64: string;
+    setText: (value: string) => void;
     isSaving: boolean;
     isLoading: boolean;
     encryptionStatus?: boolean;

package/models/config-store.d.ts

@@ -1,6 +1,6 @@
 import type { Ref, UnwrapNestedRefs } from 'vue';
-import { OrgNoteConfig } from './orgnote-config.js';
-import { StoreDefinition } from './store.js';
+import type { OrgNoteConfig } from './orgnote-config.js';
+import type { StoreDefinition } from './store.js';
 export interface ConfigStore {
     config: UnwrapNestedRefs<OrgNoteConfig>;
     configErrors: Ref<string[]>;

package/models/default-commands.d.ts

@@ -58,7 +58,6 @@ export declare enum DefaultCommands {
     CONFIRM_FILE_DELETION = "are you sure you want to delete file?",
     NEW_FILE_PATH = "new file path",
     OPEN_NOTE = "open note",
-    OPEN_CODE_EDITOR = "open code editor",
     TABS = "show tabs",
     SHOW_TAB_SWITCHER = "show tab switcher",
     CLOSE_TAB = "close tab",

package/models/default-commands.js

@@ -72,7 +72,6 @@ export var DefaultCommands;
     DefaultCommands["NEW_FILE_PATH"] = "new file path";
     // Notes commands
     DefaultCommands["OPEN_NOTE"] = "open note";
-    DefaultCommands["OPEN_CODE_EDITOR"] = "open code editor";
     // Windows & buffers
     DefaultCommands["TABS"] = "show tabs";
     DefaultCommands["SHOW_TAB_SWITCHER"] = "show tab switcher";

package/models/editor-store.d.ts

@@ -0,0 +1,16 @@
+import type { ComputedRef, ShallowRef } from 'vue';
+import type { InlineEmbeddedWidgets, MultilineEmbeddedWidgets, OrgLineClasses } from './widget.js';
+import type { EditorExtension } from './editor.js';
+import type { WidgetMeta } from '../api.js';
+import type { StoreDefinition } from './store.js';
+export interface EditorStore {
+    inlineWidgets: ComputedRef<InlineEmbeddedWidgets>;
+    multilineWidgets: ComputedRef<MultilineEmbeddedWidgets>;
+    lineClasses: ComputedRef<OrgLineClasses>;
+    extensions: ShallowRef<EditorExtension[]>;
+    addWidgets: (...widgets: WidgetMeta[]) => void;
+    removeWidget: (widgetId: string) => void;
+    addExtensions: (...extensions: EditorExtension[]) => void;
+    removeExtensions: (...extensions: EditorExtension[]) => void;
+}
+export type EditorStoreDefinition = StoreDefinition<EditorStore>;

package/models/editor-store.js

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

package/models/editor.d.ts

@@ -12,12 +12,12 @@ interface DynamicComponent {
     };
 }
 export interface EditorExtensionParams {
-    orgNodeGetter: () => OrgNode;
+    orgNodeGetter: () => OrgNode | null;
     readonly: boolean;
     showSpecialSymbols?: boolean;
     dynamicComponent: DynamicComponent;
     foldWidget?: InlineEmbeddedWidget;
-    editorViewGetter: () => EditorView;
+    editorViewGetter: () => EditorView | undefined;
 }
 export type EditorExtension = (params: EditorExtensionParams) => Extension;
 export {};

package/models/extension.d.ts

@@ -12,6 +12,9 @@ declare const GIT_SOURCE_SCHEMA: import("valibot").ObjectSchema<{
 declare const LOCAL_SOURCE_SCHEMA: import("valibot").ObjectSchema<{
     readonly type: import("valibot").LiteralSchema<"local", undefined>;
 }, undefined>;
+declare const BUILTIN_SOURCE_SCHEMA: import("valibot").ObjectSchema<{
+    readonly type: import("valibot").LiteralSchema<"builtin", undefined>;
+}, undefined>;
 declare const SOURCE_SCHEMA: import("valibot").UnionSchema<[import("valibot").ObjectSchema<{
     readonly type: import("valibot").LiteralSchema<"git", undefined>;
     readonly repo: import("valibot").StringSchema<undefined>;
@@ -19,6 +22,8 @@ declare const SOURCE_SCHEMA: import("valibot").UnionSchema<[import("valibot").Ob
     readonly tag: import("valibot").OptionalSchema<import("valibot").StringSchema<undefined>, undefined>;
 }, undefined>, import("valibot").ObjectSchema<{
     readonly type: import("valibot").LiteralSchema<"local", undefined>;
+}, undefined>, import("valibot").ObjectSchema<{
+    readonly type: import("valibot").LiteralSchema<"builtin", undefined>;
 }, undefined>], undefined>;
 declare const COMMAND_SCHEMA: import("valibot").ObjectSchema<{
     readonly id: import("valibot").StringSchema<undefined>;
@@ -41,6 +46,8 @@ export declare const EXTENSION_MANIFEST_SCHEMA: import("valibot").ObjectSchema<{
         readonly tag: import("valibot").OptionalSchema<import("valibot").StringSchema<undefined>, undefined>;
     }, undefined>, import("valibot").ObjectSchema<{
         readonly type: import("valibot").LiteralSchema<"local", undefined>;
+    }, undefined>, import("valibot").ObjectSchema<{
+        readonly type: import("valibot").LiteralSchema<"builtin", undefined>;
     }, undefined>], undefined>;
     readonly author: import("valibot").OptionalSchema<import("valibot").StringSchema<undefined>, undefined>;
     readonly description: import("valibot").OptionalSchema<import("valibot").StringSchema<undefined>, undefined>;
@@ -81,6 +88,7 @@ export type ExtensionCategory = InferOutput<typeof CATEGORY_SCHEMA>;
 export type ExtensionSourceInfo = InferOutput<typeof SOURCE_SCHEMA>;
 export type GitSource = InferOutput<typeof GIT_SOURCE_SCHEMA>;
 export type LocalSource = InferOutput<typeof LOCAL_SOURCE_SCHEMA>;
+export type BuiltinSource = InferOutput<typeof BUILTIN_SOURCE_SCHEMA>;
 export type ExtensionCommand = InferOutput<typeof COMMAND_SCHEMA>;
 export type ExtensionKeybinding = InferOutput<typeof KEYBINDING_SCHEMA>;
 export type ExtensionPlatform = InferOutput<typeof PLATFORM_SCHEMA>;

package/models/extension.js

@@ -41,7 +41,10 @@ const GIT_SOURCE_SCHEMA = object({
 const LOCAL_SOURCE_SCHEMA = object({
     type: literal('local'),
 });
-const SOURCE_SCHEMA = union([GIT_SOURCE_SCHEMA, LOCAL_SOURCE_SCHEMA]);
+const BUILTIN_SOURCE_SCHEMA = object({
+    type: literal('builtin'),
+});
+const SOURCE_SCHEMA = union([GIT_SOURCE_SCHEMA, LOCAL_SOURCE_SCHEMA, BUILTIN_SOURCE_SCHEMA]);
 const COMMAND_SCHEMA = object({
     id: string(),
     title: string(),

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

@@ -1,7 +1,22 @@
-import { StoreDefinition } from './store.js';
+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 {
-    addReader: (readerMatch: string, reader: (path: string) => Promise<void>) => void;
-    addReaders: (readers: Record<string, (path: string) => Promise<void>>) => void;
+    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>;

package/models/index.d.ts

@@ -61,6 +61,8 @@ export * from './panes-store.js';
 export * from './layout-store.js';
 export * from './file-system-manager-store.js';
 export * from './config-store.js';
+export * from './editor-store.js';
+export * from './babel-store.js';
 export * from './notifications-store.js';
 export * from './notification-config.js';
 export * from './buffer-store.js';

package/models/index.js

@@ -63,6 +63,8 @@ export * from "./panes-store.js";
 export * from "./layout-store.js";
 export * from "./file-system-manager-store.js";
 export * from "./config-store.js";
+export * from "./editor-store.js";
+export * from "./babel-store.js";
 export * from "./notifications-store.js";
 export * from "./notification-config.js";
 export * from "./buffer-store.js";

package/models/orgnote-config.d.ts

@@ -34,6 +34,9 @@ export declare const ORG_NOTE_CONFIG_SCHEMA: import("valibot").SchemaWithPipe<re
         readonly persistantPanesSaveDelay: import("valibot").NumberSchema<undefined>;
         readonly dropZoneEdgeRatio: import("valibot").NumberSchema<undefined>;
     }, undefined>;
+    readonly fileReaders: import("valibot").OptionalSchema<import("valibot").ObjectSchema<{
+        readonly preferredReaders: import("valibot").OptionalSchema<import("valibot").ObjectWithRestSchema<{}, import("valibot").StringSchema<undefined>, undefined>, undefined>;
+    }, undefined>, undefined>;
     readonly extensions: import("valibot").ObjectSchema<{
         readonly sources: import("valibot").ArraySchema<import("valibot").StringSchema<undefined>, undefined>;
     }, undefined>;

package/models/orgnote-config.js

@@ -35,6 +35,9 @@ export const ORG_NOTE_CONFIG_SCHEMA = pipe(objectWithRest({
         persistantPanesSaveDelay: number(),
         dropZoneEdgeRatio: number(),
     }),
+    fileReaders: optional(object({
+        preferredReaders: optional(objectWithRest({}, string())),
+    })),
     extensions: object({
         sources: array(string()),
     }),

package/models/widget.d.ts

@@ -1,32 +1,41 @@
 import type { ChangeSpec } from '@codemirror/state';
-import { EditorView } from '@codemirror/view';
+import type { EditorView } from '@codemirror/view';
 import type { NodeType, OrgNode } from 'org-mode-ast';
+import type { Component } from 'vue';
 export type EmbeddedWidget = {
     destroy: () => void;
     refresh?: (...args: unknown[]) => void;
 };
-export interface WidgetBuilderParams {
+export interface WidgetBuilderParams<TEditorView = EditorView> {
     wrap: HTMLElement;
     orgNode: OrgNode;
-    rootNodeSrc: () => OrgNode;
+    orgNodeGetter?: () => OrgNode;
+    rootNodeSrc: () => OrgNode | null;
     onUpdateFn?: (newVal: string) => void;
-    editorView: EditorView;
+    onEditMode?: () => void;
+    editorView: TEditorView;
     readonly?: boolean;
+    suppressEdit?: boolean;
 }
 export type WidgetBuilder = (params: WidgetBuilderParams) => EmbeddedWidget;
 export interface CommonEmbeddedWidget {
+    id: string;
     satisfied?: (orgNode: OrgNode) => boolean;
     widgetBuilder?: WidgetBuilder;
+    component?: Component;
+    componentProps?: Record<string, unknown>;
     viewUpdater?: (orgNode: OrgNode, newVal: string) => ViewUpdateSchema;
     ignoreEvent?: boolean;
     showRangeOffset?: [number, number];
+    priority?: number;
 }
 export interface MultilineEmbeddedWidget extends CommonEmbeddedWidget {
-    widgetBuilder: WidgetBuilder;
+    widgetBuilder?: WidgetBuilder;
+    component?: Component;
     suppressEdit?: boolean;
 }
 export type MultilineEmbeddedWidgets = {
-    [key in NodeType]?: MultilineEmbeddedWidget;
+    [key in NodeType]?: MultilineEmbeddedWidget[];
 };
 export type ViewUpdateSchema = ChangeSpec;
 export interface InlineEmbeddedWidget extends CommonEmbeddedWidget {
@@ -38,14 +47,13 @@ export interface InlineEmbeddedWidget extends CommonEmbeddedWidget {
     inclusive?: boolean;
 }
 export type InlineEmbeddedWidgets = {
-    [key in NodeType]?: InlineEmbeddedWidget;
+    [key in NodeType]?: InlineEmbeddedWidget[];
 };
-export type EmbeddedWidgetBuilder = (wrap: HTMLElement, dynamicProps?: {
-    [key: string]: unknown;
-}) => EmbeddedWidget;
-export type OrgLineClass = {
+export interface OrgLineClass {
+    id: string;
     class: string | ((orgNode: OrgNode) => string);
-};
+    priority?: number;
+}
 export type OrgLineClasses = {
-    [key in NodeType]?: OrgLineClass;
+    [key in NodeType]?: OrgLineClass[];
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "orgnote-api",
-  "version": "0.40.24",
+  "version": "0.40.26",
   "description": "Official API for creating extensions for OrgNote app",
   "type": "module",
   "main": "./index.js",
@@ -67,8 +67,8 @@
   },
   "peerDependencies": {
     "@capacitor/filesystem": ">=6.0.0",
-    "@codemirror/state": ">=6.0.0",
-    "@codemirror/view": ">=6.0.0",
+    "@codemirror/state": "6.5.3",
+    "@codemirror/view": "6.39.5",
     "@faker-js/faker": ">=9.0.0",
     "pinia": ">=2.0.0",
     "quasar": ">=2.0.0",

package/utils/binary.d.ts

@@ -0,0 +1,4 @@
+export declare const uint8ArrayToBase64: (bytes: Uint8Array) => string;
+export declare const base64ToUint8Array: (base64: string) => Uint8Array;
+export declare const textToUint8Array: (text: string) => Uint8Array;
+export declare const uint8ArrayToText: (bytes: Uint8Array) => string;

package/utils/binary.js

@@ -0,0 +1,17 @@
+export const uint8ArrayToBase64 = (bytes) => {
+    let binary = '';
+    for (let i = 0; i < bytes.length; i++) {
+        binary += String.fromCharCode(bytes[i]);
+    }
+    return btoa(binary);
+};
+export const base64ToUint8Array = (base64) => {
+    const binary = atob(base64);
+    const bytes = new Uint8Array(binary.length);
+    for (let i = 0; i < binary.length; i++) {
+        bytes[i] = binary.charCodeAt(i);
+    }
+    return bytes;
+};
+export const textToUint8Array = (text) => new TextEncoder().encode(text);
+export const uint8ArrayToText = (bytes) => new TextDecoder().decode(bytes);

package/utils/index.d.ts

@@ -11,3 +11,4 @@ export * from './to-absolute-path.js';
 export * from './to-error.js';
 export * from './auth-state.js';
 export * from './nullable-guards.js';
+export * from './binary.js';

package/utils/index.js

@@ -11,3 +11,4 @@ export * from "./to-absolute-path.js";
 export * from "./to-error.js";
 export * from "./auth-state.js";
 export * from "./nullable-guards.js";
+export * from "./binary.js";