# orgnote-api

> Official API for creating extensions for OrgNote app

Latest version **0.67.2** (published 2026-09-17) · GPL-3.0-or-later license · 0 weekly downloads

## Install

```sh
npm install orgnote-api
pnpm add orgnote-api
yarn add orgnote-api
bun add orgnote-api
```

## Health

**Score 75/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score.

Warnings: low downloads; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.67.2 |
| Published | 2026-09-17 |
| First published | 2024-02-03 |
| Weekly downloads | 0 |
| License | GPL-3.0-or-later |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 10 |
| Unpacked size | 691.7 KB |
| Known vulnerabilities | 0 (+31 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 11 |
| Author | darkawower |
| Maintainers | darkawower |
| Keywords | orgnote, org-mode, org-roam, api, extensions |

## Links

- npm: https://www.npmjs.com/package/orgnote-api
- Repository: https://github.com/Artawower/orgnote-api
- Homepage: https://github.com/artawower/orgnote-api#readme
- Issues: https://github.com/artawower/orgnote-api/issues
- npm.io page: https://npm.io/package/orgnote-api

## Dependencies (10)

- [axios](https://npm.io/package/axios.md) 1.8.4
- [openpgp](https://npm.io/package/openpgp.md) 6.3.0
- [date-fns](https://npm.io/package/date-fns.md) 2.30.0
- [picomatch](https://npm.io/package/picomatch.md) 4.0.4
- [smol-toml](https://npm.io/package/smol-toml.md) 1.5.2
- [neverthrow](https://npm.io/package/neverthrow.md) ^8.2.0
- [orgnote-api](https://npm.io/package/orgnote-api.md) 0.67.0
- [partysocket](https://npm.io/package/partysocket.md) 1.1.6
- [org-mode-ast](https://npm.io/package/org-mode-ast.md) 0.13.5
- [diff-match-patch](https://npm.io/package/diff-match-patch.md) ^1.0.5

## Recent versions

- 0.67.2 (latest) — 2026-09-17
- 0.8.3-beta.2 (beta) — 2024-05-04
- 0.67.1 — 2026-08-26
- 0.67.0 — 2026-08-25
- 0.66.0 — 2026-08-20
- 0.65.0 — 2026-08-14
- 0.64.12 — 2026-08-10
- 0.64.11 — 2026-08-09
- 0.64.9 — 2026-08-02
- 0.64.8 — 2026-08-01
- 0.64.7 — 2026-08-01
- 0.64.5 — 2026-07-29
- 0.64.4 — 2026-07-26
- 0.64.3 — 2026-07-26
- 0.64.2 — 2026-07-25
- … 220 more at https://npm.io/package/orgnote-api/versions

## README

# Table of Contents

1.  [Introduction](#orgc594aa4)
2.  [Connected links](#orgc85c296)
3.  [Extension structure](#org995dbfb)
    1.  [Folder structure](#orgbf00b5e)
    2.  [Extension entrypoint](#org6167fba)
    3.  [Extension manifest](#org76005de)
    4.  [Extension API](#org222bab3)
4.  [Publish to official repository](#org1e5d376)
5.  [Extensions example](#org3022e0a)
6.  [🍩 Contribute guide](#org576c632)

<div align='center'>

<img src='./images/image.png' width='256px' height='256px'>

</div>

&nbsp;

<div align='center'>

<span class='badge-buymeacoffee'>

<a href='https://www.paypal.me/darkawower' title='Paypal' target='_blank'><img src='https://img.shields.io/badge/paypal-donate-blue.svg' alt='Buy Me A Coffee donate button' /></a>

</span>

<span class='badge-patreon'>

<a href='https://patreon.com/artawower' target='_blank' title='Donate to this project using Patreon'><img src='https://img.shields.io/badge/patreon-donate-orange.svg' alt='Patreon donate button' /></a>

</span>

<a href="https://wakatime.com/badge/github/Artawower/orgnote-api"><img src="https://wakatime.com/badge/github/Artawower/orgnote-api.svg" alt="wakatime"></a>

</div>

<div align='center'>

<a href="https://twitter.com/org_note" target="_blank"><img src="https://img.shields.io/twitter/follow/org_note" alt="Twitter link" /></a>

<a href="https://emacs.ch/@orgnote" target="_blank"><img alt="Mastodon Follow" src="https://img.shields.io/mastodon/follow/113090697216193319?domain=https%3A%2F%2Ffosstodon.org&style=social"></a>

<a href="https://discord.com/invite/SFpUb2vSDm" target="_blank"><img src="https://img.shields.io/discord/1161751315324604417" alt="Discord"></a>

<a href="https://www.youtube.com/@OrgNote" target="_blank"><img alt="YouTube Channel Views" src="https://img.shields.io/youtube/channel/views/UCN14DUE5umdrlEm7odW3gOw"></a>

</div>

<div align='center'>

<a href="https://play.google.com/store/apps/details?id=org.note.app" target="_blank">

<img src="./images/google-play.svg" width="140px" height="auto">

</a>

</div>


<a id="orgc594aa4"></a>

# Introduction

This is API for [OrgNote](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.


<a id="orgc85c296"></a>

# Connected links

-   [Built-in extensions](https://github.com/Artawower/orgnote-client/tree/master/src/components/extensions)
-   [Type definition for existing extension API](https://github.com/Artawower/orgnote-api/blob/master/src/api.ts#L24)
-   [OrgNote entrypoint](https://github.com/artawower/orgnote)
-   [Official website](https://org-note.com/)
-   [Org Note client](https://github.com/Artawower/orgnote-client)
-   [Repository with collection of extensions](https://github.com/Artawower/orgnote-extensions)
-   [Typescript abstract syntax tree for org mode.](https://github.com/Artawower/org-mode-ast)


<a id="org995dbfb"></a>

# Extension structure


<a id="orgbf00b5e"></a>

## Folder structure

**Compiled extension should be placed in the `index.js` file or `/dist/index.js` file in the public GIT repository**


<a id="org6167fba"></a>

## Extension entrypoint

Each extension should **export an object by default** with the following structure:

    interface Extension {
      [key: string]: unknown;
    
      onMounted: (api: OrgNoteApi) => Promise<void>;
      onUnmounted?: (api: OrgNoteApi) => Promise<void>;
    }

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


<a id="org76005de"></a>

## Extension manifest

Also, each extension should export manifest const:

    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;
    }


<a id="org222bab3"></a>

## Extension API


<a id="org1e5d376"></a>

# Publish to official repository

OrgNote has an official [repository](https://github.com/Artawower/orgnote-extensions) for user-based extensions. You can easily add new `recipes/<package>.json`
with `ExtensionManifest`


<a id="org3022e0a"></a>

# Extensions example

*Themes*

-   [Atom One Dark theme (pure js)](https://github.com/Artawower/orgnote-atom-one-dark)

*UI* 

-   [Colorful Headlines (typescript + API package)](https://github.com/Artawower/orgnote-colorful-headlines)


<a id="org576c632"></a>

# 🍩 Contribute guide

Any contribution is very much appreciated! Please read the [style guide](https://github.com/Artawower/orgnote/wiki/Contribution-guide) before contributing to avoid misunderstandings!
I would also appreciate it if you would consider becoming my [patron](https://www.patreon.com/artawower)

---
_Source: https://npm.io/package/orgnote-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._