orgnote-api 0.0.11 → 0.0.13

package/src/models/widget.ts

@@ -0,0 +1,56 @@
+import type { ChangeSpec } from '@codemirror/state';
+import type { EditorView } from 'codemirror';
+import type { NodeType, OrgNode } from 'org-mode-ast';
+
+export type EmbeddedWidget = {
+  destroy: () => void;
+  refresh?: (...args: unknown[]) => void;
+};
+
+export interface WidgetBuilderParams {
+  wrap: HTMLElement;
+  orgNode: OrgNode;
+  rootNodeSrc: () => OrgNode;
+  onUpdateFn?: (newVal: string) => void;
+  editorView: EditorView;
+  readonly?: boolean;
+}
+
+export type WidgetBuilder = (params: WidgetBuilderParams) => EmbeddedWidget;
+
+export interface CommonEmbeddedWidget {
+  satisfied?: (orgNode: OrgNode) => boolean;
+  widgetBuilder?: WidgetBuilder;
+  viewUpdater?: (orgNode: OrgNode, newVal: string) => ViewUpdateSchema;
+  ignoreEvent?: boolean;
+  showRangeOffset?: [number, number];
+}
+
+export interface MultilineEmbeddedWidget extends CommonEmbeddedWidget {
+  widgetBuilder: WidgetBuilder;
+  suppressEdit?: boolean;
+}
+
+export type MultilineEmbeddedWidgets = {
+  [key in NodeType]?: MultilineEmbeddedWidget;
+};
+
+export type ViewUpdateSchema = ChangeSpec;
+
+export interface InlineEmbeddedWidget extends CommonEmbeddedWidget {
+  classBuilder?: (orgNode: OrgNode) => string;
+  decorationType: 'mark' | 'widget' | 'replace' | 'line';
+  ignoreEditing?: boolean;
+  side?: number;
+  wrapComponent?: string;
+  inclusive?: boolean;
+}
+
+export type InlineEmbeddedWidgets = {
+  [key in NodeType]?: InlineEmbeddedWidget;
+};
+
+export type EmbeddedWidgetBuilder = (
+  wrap: HTMLElement,
+  dynamicProps?: { [key: string]: unknown }
+) => EmbeddedWidget;

package/dist/api.d.ts

@@ -1,66 +0,0 @@
-import { Command, CSSVariable, ThemeVariable, Note } from './models';
-import type { NavigationFailure } from 'vue-router';
-export interface OrgNoteApi {
-    [key: string]: unknown;
-    getExtension?<T>(config: string): T;
-    system: {
-        reload: (params?: {
-            verbose: boolean;
-        }) => Promise<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;
-    };
-    interaction: {
-        confirm: (title: string, message: string) => Promise<boolean>;
-    };
-    currentNote: {
-        get: () => Note;
-    };
-    editor: {
-        widgets: {
-            add: () => void;
-        };
-    };
-    commands: {
-        add(...commands: Command[]): void;
-    };
-    configuration: () => OrgNoteConfig;
-}
-export interface OrgNoteConfig {
-    editor: {
-        showSpecialSymbols: boolean;
-        showPropertyDrawer: boolean;
-    };
-    common: {
-        developerMode: boolean;
-        maximumLogsCount: number;
-    };
-    completion: {
-        showGroup: boolean;
-        defaultCompletionLimit: number;
-    };
-    ui: {
-        theme: 'light' | 'dark';
-        darkThemeName?: string;
-        lightThemeName?: string;
-    };
-    extensions: {
-        sources: string[];
-    };
-}