orgnote-api 0.0.19 → 0.0.21

package/README.org

@@ -33,7 +33,7 @@ You can find all available methods here. They are currently undocumented.
 - [[https://github.com/artawower/orgnote][OrgNote entrypoint]]
 - [[https://org-note.com/][Official website]]
 - [[https://github.com/Artawower/orgnote-client][Org Note client]]
-- [[./EXTENSIONS.org][List of extensions]] 
+- [[https://github.com/Artawower/orgnote-extensions][Repository with collection of extensions]] 
 - [[https://github.com/Artawower/org-mode-ast][Typescript abstract syntax tree for org mode.]] 
 
 * Extension structure
@@ -84,8 +84,8 @@ with =ExtensionManifest=
 * Extensions example
 /Themes/
 - [[https://github.com/Artawower/orgnote-atom-one-dark][Atom One Dark theme (pure js)]]
-/UI/ (WIP)
-- Colorful Headlines (typescript + API package)
+/UI/ 
+- [[https://github.com/Artawower/orgnote-colorful-headlines][Colorful Headlines (typescript + API package)]]
 
 * Contribute guide
 Any contribution is very much appreciated! Please read the [[./CONTRIBUTE.org][style guide]] before contributing to avoid misunderstandings!

package/api.ts

@@ -1,5 +1,22 @@
-import { Command , CSSVariable, ThemeVariable, Note  } from './models';
+import {
+  Command,
+  CSSVariable,
+  ThemeVariable,
+  Note,
+  InlineEmbeddedWidget,
+  MultilineEmbeddedWidget,
+  OrgLineClass,
+} from './models';
 import type { NavigationFailure } from 'vue-router';
+import { WidgetType } from './models/widget-type';
+import type { Component } from 'vue';
+import { EmbeddedWidget } from './models';
+import { WidgetBuilder } from './models';
+
+export type WidgetMeta =
+  | ({ type: WidgetType.Inline } & InlineEmbeddedWidget)
+  | ({ type: WidgetType.Multiline } & MultilineEmbeddedWidget)
+  | ({ type: WidgetType.LineClass } & OrgLineClass);
 
 export interface OrgNoteApi {
   [key: string]: unknown;
@@ -30,12 +47,13 @@ export interface OrgNoteApi {
   currentNote: {
     get: () => Note;
   };
-  // hooks: {
-  //   add: () => void;
-  // };
   editor: {
     widgets: {
-      add: () => void;
+      add: (...widgetMeta: WidgetMeta[]) => void;
+      createWidgetBuilder: (
+        cmp: Component,
+        props?: { [key: string]: unknown }
+      ) => WidgetBuilder;
     };
   };
   commands: {
@@ -50,21 +68,21 @@ 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[];
-  }
+  };
 }

package/index.ts

@@ -1,2 +1,4 @@
 export * from './api';
 export * from './models';
+import type * as ast from 'org-mode-ast';
+export { ast };

package/models/extension.ts

@@ -11,7 +11,7 @@ export interface ExtensionManifest {
   description?: string;
   keywords?: string[];
   // Repository url
-  sourceType: 'git' | 'file';
+  sourceType: 'git' | 'file' | 'builtin';
   /* Default value is README.org */
   readmeFilePath?: string;
   /* WIP */

package/models/index.ts

@@ -5,3 +5,4 @@ export * from './extension';
 export * from './theme-variables';
 export * from './widget';
 export * from './modal';
+export * from './widget-type';

package/models/widget-type.ts

@@ -0,0 +1,5 @@
+export enum WidgetType {
+  Multiline = 'multiline',
+  Inline = 'inline',
+  LineClass = 'line-class',
+}

package/models/widget.ts

@@ -54,3 +54,6 @@ export type EmbeddedWidgetBuilder = (
   wrap: HTMLElement,
   dynamicProps?: { [key: string]: unknown }
 ) => EmbeddedWidget;
+
+export type OrgLineClass = { class: string | ((orgNode: OrgNode) => string) };
+export type OrgLineClasses = { [key in NodeType]?: OrgLineClass };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "orgnote-api",
-  "version": "0.0.19",
+  "version": "0.0.21",
   "description": "Official API for creating extensions for OrgNote app",
   "type": "module",
   "main": "./index.ts",
@@ -22,13 +22,7 @@
     ".": "./index.ts",
     "./remote-api": "./remote-api/index.ts"
   },
-  "keywords": [
-    "orgnote",
-    "org-mode",
-    "org-roam",
-    "api",
-    "extensions"
-  ],
+  "keywords": ["orgnote", "org-mode", "org-roam", "api", "extensions"],
   "author": "darkawower <app.orgnote@gmail.com> (https://org-note.com)",
   "license": "GPL-3.0-or-later",
   "bugs": {
@@ -39,6 +33,7 @@
     "axios": "1.6.7",
     "codemirror": "6.0.1",
     "org-mode-ast": "0.11.2",
+    "vue": "^3.4.15",
     "vue-router": "4.2.5"
   },
   "devDependencies": {