orgnote-api 0.0.17 → 0.0.20

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

@@ -0,0 +1,87 @@
+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';
+
+export type WidgetMeta =
+  | ({ type: WidgetType.Inline } & InlineEmbeddedWidget)
+  | ({ type: WidgetType.Multiline } & MultilineEmbeddedWidget)
+  | ({ type: WidgetType.LineClass } & OrgLineClass);
+
+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: (...widgetMeta: WidgetMeta[]) => void;
+      createEmbeddedWidget: (
+        cmp: Component,
+        props: { [key: string]: unknown }
+      ) => EmbeddedWidget;
+    };
+  };
+  commands: {
+    add(...commands: Command[]): void;
+    // delete(...commands: Command[]): void;
+    // update(...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[];
+  };
+}

package/index.ts

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

package/models/command.ts

@@ -0,0 +1,30 @@
+export const DEFAULT_KEYBINDING_GROUP = 'default';
+
+export type CommandGroup =
+  | 'settings'
+  | 'editor'
+  | 'global'
+  | 'note-detail'
+  | 'completion'
+  | string;
+
+export interface CommandHandlerParams {
+  event?: KeyboardEvent;
+  data?: unknown;
+  [key: string]: unknown;
+}
+
+export interface Command {
+  // TODO: add support for multiple key sequences
+  keySequence?: string | string[];
+  description?: string;
+  command?: string;
+  title?: string | (() => string);
+  icon?: string | (() => string);
+  /* Where is this command available, default value is global */
+  group?: CommandGroup;
+  allowOnInput?: boolean;
+  ignorePrompt?: boolean;
+  /* arguments depend on the current scope */
+  handler: (params?: CommandHandlerParams) => unknown | Promise<unknown>;
+}

package/models/completion.ts

@@ -0,0 +1,30 @@
+export interface CompletionCandidate<T = unknown> {
+  icon?: string | (() => string);
+  group?: string;
+  title?: string | (() => string);
+  description?: string;
+  command: string;
+  data: T;
+  /* Command handler could be used instead of command string */
+  commandHandler?: (data: T) => void;
+}
+
+export interface CompletionSearchResult<T = unknown> {
+  total?: number;
+  result: CompletionCandidate<T>[];
+}
+
+export type CandidateGetterFn<T = unknown> = (
+  filter: string,
+  limit?: number,
+  offset?: number
+) => CompletionSearchResult<T> | Promise<CompletionSearchResult<T>>;
+
+export interface CompletionConfigs<T = unknown> {
+  searchAutocompletions?: string[];
+  itemsGetter: CandidateGetterFn<T>;
+  placeholder?: string;
+  itemHeight?: string;
+  searchText?: string;
+  onClicked?: (candidate: CompletionCandidate<T>) => void;
+}

package/models/extension.ts

@@ -0,0 +1,45 @@
+import { OrgNoteApi } from '../api';
+
+export interface ExtensionManifest {
+  /* Should be unique in the extension repo */
+  name: string;
+  version: string;
+  category: 'theme' | 'extension' | 'language pack' | 'other';
+  /* OrgNote api semver, 0.13.4 for example */
+  apiVersion?: string;
+  author?: string;
+  description?: string;
+  keywords?: string[];
+  // Repository url
+  sourceType: 'git' | 'file' | 'builtin';
+  /* Default value is README.org */
+  readmeFilePath?: string;
+  /* WIP */
+  permissions?: Array<'files' | 'personal info' | '*' | 'third party'>;
+  reloadRequired?: boolean;
+  sourceUrl?: string;
+  sponsor?: string[];
+  development?: boolean;
+  icon?: string;
+}
+
+export interface Extension {
+  [key: string]: unknown;
+
+  onMounted: (api: OrgNoteApi) => Promise<void>;
+  onUnmounted?: (api: OrgNoteApi) => Promise<void>;
+}
+
+export interface ExtensionMeta {
+  manifest: ExtensionManifest;
+  uploaded?: boolean;
+  active?: boolean;
+}
+
+export interface StoredExtension extends ExtensionMeta {
+  module?: string;
+}
+
+export interface ActiveExtension extends ExtensionMeta {
+  module: Extension;
+}

package/models/index.ts

@@ -0,0 +1,8 @@
+export * from './note';
+export * from './command';
+export * from './completion';
+export * from './extension';
+export * from './theme-variables';
+export * from './widget';
+export * from './modal';
+export * from './widget-type';

package/models/modal.ts

@@ -0,0 +1,4 @@
+export interface ModalConfig {
+  closable?: boolean;
+  title?: string;
+}

package/models/note.ts

@@ -0,0 +1,24 @@
+import type { ModelsPublicNote, ModelsPublicUser } from '../remote-api';
+
+export interface NotesFilter {
+  searchText?: string;
+  userId?: string;
+  limit?: number;
+  offset?: number;
+}
+
+export interface NotePreview {
+  id: ModelsPublicNote['id'];
+  meta: ModelsPublicNote['meta'];
+  createdAt: ModelsPublicNote['createdAt'];
+  updatedAt: ModelsPublicNote['updatedAt'];
+  filePath: ModelsPublicNote['filePath'];
+  isMy: ModelsPublicNote['isMy'];
+  author?: ModelsPublicUser;
+  bookmarked?: boolean;
+}
+
+export interface Note extends ModelsPublicNote {
+  deleted?: Date;
+  bookmarked?: boolean;
+}

package/models/theme-variables.ts

@@ -0,0 +1,194 @@
+/**
+* This file is generated by the script `collect-css-variables.js`.
+* Do not edit it manually.
+**/
+
+export enum ThemeVariable {
+	red = 'red',
+	orange = 'orange',
+	green = 'green',
+	teal = 'teal',
+	yellow = 'yellow',
+	blue = 'blue',
+	darkBlue = 'darkBlue',
+	magenta = 'magenta',
+	violet = 'violet',
+	cyan = 'cyan',
+	darkCyan = 'darkCyan',
+	white = 'white',
+	bg = 'bg',
+	bgAlt = 'bgAlt',
+	bgAlt2 = 'bgAlt2',
+	fg = 'fg',
+	fgAlt = 'fgAlt',
+	base0 = 'base0',
+	base1 = 'base1',
+	base2 = 'base2',
+	base3 = 'base3',
+	base4 = 'base4',
+	base5 = 'base5',
+	base6 = 'base6',
+	base7 = 'base7',
+	base8 = 'base8',
+}
+
+export enum CSSVariable {
+	bg = 'bg',
+	fg = 'fg',
+	dur = 'dur',
+	easyTableHeaderBackgroundColor = 'easyTableHeaderBackgroundColor',
+	easyTableHeaderFontColor = 'easyTableHeaderFontColor',
+	easyTableBodyRowBackgroundColor = 'easyTableBodyRowBackgroundColor',
+	easyTableBodyRowFontColor = 'easyTableBodyRowFontColor',
+	easyTableBodyRowHoverBackgroundColor = 'easyTableBodyRowHoverBackgroundColor',
+	easyTableFooterBackgroundColor = 'easyTableFooterBackgroundColor',
+	easyTableFooterFontColor = 'easyTableFooterFontColor',
+	easyTableBodyRowHoverFontColor = 'easyTableBodyRowHoverFontColor',
+	easyTableRowBorder = 'easyTableRowBorder',
+	easyTableBorder = 'easyTableBorder',
+	easyTableMessageFontColor = 'easyTableMessageFontColor',
+	btnFlatSize = 'btnFlatSize',
+	btnFlatBorder = 'btnFlatBorder',
+	btnFlatBorderRadius = 'btnFlatBorderRadius',
+	btnFlatBoxShadow = 'btnFlatBoxShadow',
+	btnMainColor = 'btnMainColor',
+	btnSocialSize = 'btnSocialSize',
+	btnSocialBackground = 'btnSocialBackground',
+	checkboxColor = 'checkboxColor',
+	editorFontFamily = 'editorFontFamily',
+	flexGapMd = 'flexGapMd',
+	flexGapSm = 'flexGapSm',
+	inlineCodeBackground = 'inlineCodeBackground',
+	inlineCodeFontColor = 'inlineCodeFontColor',
+	scrollBarWidth = 'scrollBarWidth',
+	scrollBarColor = 'scrollBarColor',
+	fontSizeSm = 'fontSizeSm',
+	fontSizeMd = 'fontSizeMd',
+	fontSizeLg = 'fontSizeLg',
+	headlineMargin = 'headlineMargin',
+	paragraphFontSize = 'paragraphFontSize',
+	mainFontFamily = 'mainFontFamily',
+	editorFontFamilyMain = 'editorFontFamilyMain',
+	paragraphFontFamily = 'paragraphFontFamily',
+	headlineFontFamily = 'headlineFontFamily',
+	codeFontFamily = 'codeFontFamily',
+	descriptionFontFamily = 'descriptionFontFamily',
+	descriptionFontSize = 'descriptionFontSize',
+	descriptionFontStyle = 'descriptionFontStyle',
+	descriptionFontColor = 'descriptionFontColor',
+	descriptionPadding = 'descriptionPadding',
+	codeFontSize = 'codeFontSize',
+	headlineFontWeight = 'headlineFontWeight',
+	fontColorAction = 'fontColorAction',
+	fontSm = 'fontSm',
+	fontMd = 'fontMd',
+	fontLg = 'fontLg',
+	ulFontSize = 'ulFontSize',
+	ulLineHeight = 'ulLineHeight',
+	ulFontFamily = 'ulFontFamily',
+	topBarHeight = 'topBarHeight',
+	contentMaxWidth = 'contentMaxWidth',
+	modelineHeight = 'modelineHeight',
+	modelinePadding = 'modelinePadding',
+	modelineBackground = 'modelineBackground',
+	cardBackgroundColor = 'cardBackgroundColor',
+	shadowMain = 'shadowMain',
+	sidebarWidth = 'sidebarWidth',
+	actionPaneOpenedWidth = 'actionPaneOpenedWidth',
+	footerHeight = 'footerHeight',
+	publicPreviewImageWidth = 'publicPreviewImageWidth',
+	publicPreviewImageHeight = 'publicPreviewImageHeight',
+	publicPreviewMaxHeight = 'publicPreviewMaxHeight',
+	completionItemMinHeight = 'completionItemMinHeight',
+	completionItemPadding = 'completionItemPadding',
+	completionItemMargin = 'completionItemMargin',
+	completionItemHoverBackground = 'completionItemHoverBackground',
+	completionItemHoverColor = 'completionItemHoverColor',
+	completionFloatTop = 'completionFloatTop',
+	completionBorderRadius = 'completionBorderRadius',
+	completionWidth = 'completionWidth',
+	completionMaxWidth = 'completionMaxWidth',
+	completionBorder = 'completionBorder',
+	completionBoxShadow = 'completionBoxShadow',
+	completionInputHeight = 'completionInputHeight',
+	completionContainerMargin = 'completionContainerMargin',
+	menuPadding = 'menuPadding',
+	fileUploaderBorderWidth = 'fileUploaderBorderWidth',
+	fileUploaderBorderStyle = 'fileUploaderBorderStyle',
+	fileUploaderBorderColor = 'fileUploaderBorderColor',
+	fileUploaderBg = 'fileUploaderBg',
+	fileUploaderOpacity = 'fileUploaderOpacity',
+	notePreviewLinkMaxWidth = 'notePreviewLinkMaxWidth',
+	notePreviewLinkHeight = 'notePreviewLinkHeight',
+	btnActionShadow = 'btnActionShadow',
+	btnActionBorder = 'btnActionBorder',
+	btnActionBorderColor = 'btnActionBorderColor',
+	btnActionPadding = 'btnActionPadding',
+	btnActionRadius = 'btnActionRadius',
+	btnActionFireColor = 'btnActionFireColor',
+	btnActionFireBorderColor = 'btnActionFireBorderColor',
+	btnActionMd = 'btnActionMd',
+	btnActionSm = 'btnActionSm',
+	btnActionLg = 'btnActionLg',
+	btnActionColor = 'btnActionColor',
+	btnActionBg = 'btnActionBg',
+	miniBufferBackground = 'miniBufferBackground',
+	miniBufferFontColor = 'miniBufferFontColor',
+	miniBufferBorderTop = 'miniBufferBorderTop',
+	miniBufferMaxHeight = 'miniBufferMaxHeight',
+	tagHoverBackground = 'tagHoverBackground',
+	tagHoverColor = 'tagHoverColor',
+	toolbarBorderTop = 'toolbarBorderTop',
+	toolbarHoverColor = 'toolbarHoverColor',
+	headerbarHeight = 'headerbarHeight',
+	headerbarBorderRadius = 'headerbarBorderRadius',
+	headerbarBackgroundColor = 'headerbarBackgroundColor',
+	headerbarColor = 'headerbarColor',
+	headerbarBorder = 'headerbarBorder',
+	fileItemBgHover = 'fileItemBgHover',
+	fileItemColorHover = 'fileItemColorHover',
+	fileItemHeight = 'fileItemHeight',
+	iconBtnColor = 'iconBtnColor',
+	iconBtnHoverColor = 'iconBtnHoverColor',
+	modalMaxHeight = 'modalMaxHeight',
+	modalMaxWidth = 'modalMaxWidth',
+	modalPadding = 'modalPadding',
+	blockPaddingSm = 'blockPaddingSm',
+	blockPaddingMd = 'blockPaddingMd',
+	blockPaddingLg = 'blockPaddingLg',
+	blockMarginMd = 'blockMarginMd',
+	blockMarginSm = 'blockMarginSm',
+	blockBorderRadiusMd = 'blockBorderRadiusMd',
+	blockBorderRadiusSm = 'blockBorderRadiusSm',
+	itemDefaultRadius = 'itemDefaultRadius',
+	searchIcnSize = 'searchIcnSize',
+	gapMd = 'gapMd',
+	gapSm = 'gapSm',
+	gapXs = 'gapXs',
+	srcBlockHeaderPaddingY = 'srcBlockHeaderPaddingY',
+	srcBlockFooterPaddingY = 'srcBlockFooterPaddingY',
+	srcBlockPaddingX = 'srcBlockPaddingX',
+	srcBlockPaddingY = 'srcBlockPaddingY',
+	srcBlockMarginY = 'srcBlockMarginY',
+	pagePadding = 'pagePadding',
+	editorLineHeight = 'editorLineHeight',
+	editorHeadlineLineHeight = 'editorHeadlineLineHeight',
+	editorDefaultLineHeight = 'editorDefaultLineHeight',
+	editorPaddingBottom = 'editorPaddingBottom',
+	editorCursorColor = 'editorCursorColor',
+	editorSelectionBgColor = 'editorSelectionBgColor',
+	editorSelectionColor = 'editorSelectionColor',
+	editorGutterColor = 'editorGutterColor',
+	editorGutterHoverColor = 'editorGutterHoverColor',
+	editorFoldPlaceholderColor = 'editorFoldPlaceholderColor',
+	editorActiveLineBgColor = 'editorActiveLineBgColor',
+	editorCaretColor = 'editorCaretColor',
+	orgListItemBulletMarginLeft = 'orgListItemBulletMarginLeft',
+	devicePaddingBottom = 'devicePaddingBottom',
+	graphNodeColor = 'graphNodeColor',
+	graphEdgeColor = 'graphEdgeColor',
+	graphActiveColor = 'graphActiveColor',
+	inputHeight = 'inputHeight',
+	inputLgHeight = 'inputLgHeight',
+	borderMain = 'borderMain',
+}

package/models/widget-type.ts

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

package/models/widget.ts

@@ -0,0 +1,59 @@
+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;
+
+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.17",
+  "version": "0.0.20",
   "description": "Official API for creating extensions for OrgNote app",
   "type": "module",
   "main": "./index.ts",
@@ -11,7 +11,7 @@
     "codegen:api": "openapi-generator-cli generate",
     "codegen:css-doc": "node collect-css-variables.cjs --docs",
     "codegen:css-types": "node collect-css-variables.cjs --types",
-    "prepublish": "mv -rf ./src/* . && rm -rf ./src"
+    "prepublish": "mv -f ./src/* . && rm -rf ./src"
   },
   "repository": {
     "type": "git",
@@ -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": {

package/remote-api/.gitignore

@@ -0,0 +1,4 @@
+wwwroot/*.js
+node_modules
+typings
+dist

package/remote-api/.npmignore

@@ -0,0 +1 @@
+# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm

package/remote-api/.openapi-generator/FILES

@@ -0,0 +1,9 @@
+.gitignore
+.npmignore
+.openapi-generator-ignore
+api.ts
+base.ts
+common.ts
+configuration.ts
+git_push.sh
+index.ts

package/remote-api/.openapi-generator/VERSION

@@ -0,0 +1 @@
+6.4.0

package/remote-api/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md