Orgnote-api NPM

:PROPERTIES: :ID: orgnote-api :END:

#+html: #+html: #+html: #+html:

#+TITLE: ✨ OrgNote API

#+html: #+html: #+html: #+html: #+html: #+html: #+html: #+html: #+html: #+html:

Introduction This is API for [https://github.com/artawower/orgnote] extensions.

Warning This API is not stable yet, so it can be changed in the future.

You can find all available methods here. They are currently undocumented.

Connected links

[https://github.com/Artawower/orgnote-client/tree/master/src/components/extensions]
[https://github.com/Artawower/orgnote-api/blob/master/src/api.ts#L24]
[https://github.com/artawower/orgnote]
[https://org-note.com/]
[https://github.com/Artawower/orgnote-client]
[https://github.com/Artawower/orgnote-extensions]
[https://github.com/Artawower/org-mode-ast]

Extension structure Folder structure Compiled extension should be placed in the =index.js= file or =/dist/index.js= file in the public GIT repository Extension entrypoint

Each extension should export an object by default with the following structure: #+BEGIN_SRC typescript interface Extension {

onMounted: (api: OrgNoteApi) => Promise; onUnmounted?: (api: OrgNoteApi) => Promise; } #+END_SRC

You can find available methods of =OrgNoteApi= [https://github.com/Artawower/orgnote-api/blob/master/src/api.ts#L24]

Extension manifest Also, each extension should export manifest const: #+BEGIN_SRC typescript 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; } #+END_SRC Extension API