orgnote-api 0.19.4 → 0.19.7

package/README.md

@@ -1,16 +1,16 @@
 
 # Table of Contents
 
-1.  [Introduction](#orged65399)
-2.  [Connected links](#orgc368352)
-3.  [Extension structure](#org1370386)
-    1.  [Folder structure](#org6a7f73b)
-    2.  [Extension entrypoint](#orge2d0f79)
-    3.  [Extension manifest](#org1e76d43)
-    4.  [Extension API](#orgbb09389)
-4.  [Publish to official repository](#orgdd94657)
-5.  [Extensions example](#orgf459c20)
-6.  [Contribute guide](#org383a272)
+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'>
 
@@ -34,14 +34,34 @@
 
 </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>
+<a href="https://wakatime.com/badge/github/Artawower/orgnote-api"><img src="https://wakatime.com/badge/github/Artawower/orgnote-api.svg" alt="wakatime"></a>
 
-<a href='https://github.com/artawower/orgnote-api/actions/workflows/melpazoid.yml/badge.svg'><img src='https://github.com/artawower/orgnote-api/actions/workflows/melpazoid.yml/badge.svg' alt='ci' /></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="orged65399"></a>
+<a id="orgc594aa4"></a>
 
 # Introduction
 
@@ -52,7 +72,7 @@ This is API for [OrgNote](https://github.com/artawower/orgnote) extensions.
 You can find all available methods here. They are currently undocumented.
 
 
-<a id="orgc368352"></a>
+<a id="orgc85c296"></a>
 
 # Connected links
 
@@ -65,19 +85,19 @@ You can find all available methods here. They are currently undocumented.
 -   [Typescript abstract syntax tree for org mode.](https://github.com/Artawower/org-mode-ast)
 
 
-<a id="org1370386"></a>
+<a id="org995dbfb"></a>
 
 # Extension structure
 
 
-<a id="org6a7f73b"></a>
+<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="orge2d0f79"></a>
+<a id="org6167fba"></a>
 
 ## Extension entrypoint
 
@@ -93,7 +113,7 @@ Each extension should **export an object by default** with the following structu
 You can find available methods of `OrgNoteApi` [here](https://github.com/Artawower/orgnote-api/blob/master/src/api.ts#L24)
 
 
-<a id="org1e76d43"></a>
+<a id="org76005de"></a>
 
 ## Extension manifest
 
@@ -123,12 +143,12 @@ Also, each extension should export manifest const:
     }
 
 
-<a id="orgbb09389"></a>
+<a id="org222bab3"></a>
 
 ## Extension API
 
 
-<a id="orgdd94657"></a>
+<a id="org1e5d376"></a>
 
 # Publish to official repository
 
@@ -136,7 +156,7 @@ OrgNote has an official [repository](https://github.com/Artawower/orgnote-extens
 with `ExtensionManifest`
 
 
-<a id="orgf459c20"></a>
+<a id="org3022e0a"></a>
 
 # Extensions example
 
@@ -149,10 +169,10 @@ with `ExtensionManifest`
 -   [Colorful Headlines (typescript + API package)](https://github.com/Artawower/orgnote-colorful-headlines)
 
 
-<a id="org383a272"></a>
+<a id="org576c632"></a>
 
-# Contribute guide
+# 🍩 Contribute guide
 
-Any contribution is very much appreciated! Please read the [style guide](./CONTRIBUTE.md) before contributing to avoid misunderstandings!
+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)
 

package/constants/command-groups.contant.d.ts

@@ -0,0 +1,7 @@
+export declare const SETTINGS_COMMAND_GROUP = "settings";
+export declare const EDITOR_COMMAND_GROUP = "editor";
+export declare const GLOBAL_COMMAND_GROUP = "global";
+export declare const NOTE_DETAIL_COMMAND_GROUP = "note-detail";
+export declare const COMPLETION_COMMAND_GROUP = "completion";
+export declare const COMMAND_GROUPS: readonly ["settings", "editor", "global", "note-detail", "completion"];
+export declare const DEFAULT_KEYBINDING_GROUP = "default";

package/constants/command-groups.contant.js

@@ -0,0 +1,13 @@
+export const SETTINGS_COMMAND_GROUP = 'settings';
+export const EDITOR_COMMAND_GROUP = 'editor';
+export const GLOBAL_COMMAND_GROUP = 'global';
+export const NOTE_DETAIL_COMMAND_GROUP = 'note-detail';
+export const COMPLETION_COMMAND_GROUP = 'completion';
+export const COMMAND_GROUPS = [
+    SETTINGS_COMMAND_GROUP,
+    EDITOR_COMMAND_GROUP,
+    GLOBAL_COMMAND_GROUP,
+    NOTE_DETAIL_COMMAND_GROUP,
+    COMPLETION_COMMAND_GROUP,
+];
+export const DEFAULT_KEYBINDING_GROUP = 'default';

package/encryption/__tests__/encryption.spec.js

@@ -329,7 +329,7 @@ KeknNUbrK5etSQFysC2pNdVkQ/HGG4uPnjR+6dppQ7kdJDjwRmw1WcYNlQ==
 -----END PGP MESSAGE-----
 `;
     try {
-        const decryptedMessage = await decrypt({
+        await decrypt({
             content: armoredContent,
             type: 'gpgPassword',
             format: 'utf8',

package/encryption/__tests__/note-encryption.spec.js

@@ -355,6 +355,7 @@ test('Should encrypt note to binary format', async () => {
     });
     expect(encryptedNoteText).toBeInstanceOf(Uint8Array);
     expect(encryptedNote).toMatchSnapshot();
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     const [_, decryptedNoteText] = await decryptNote(encryptedNote, {
         content: encryptedNoteText,
         type: 'gpgPassword',

package/encryption/encryption.js

@@ -27,6 +27,7 @@ export const decryptViaKeys = withCustomErrors(_decryptViaKeys);
 export const encrypt = async (encryptionParams) => {
     if (!encryptionParams.type ||
         encryptionParams.type === ModelsPublicNoteEncryptionTypeEnum.Disabled) {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         return encryptionParams.content;
     }
     const res = (encryptionParams.type ===
@@ -38,6 +39,7 @@ export const encrypt = async (encryptionParams) => {
 export const decrypt = async (decryptionParams) => {
     if (!decryptionParams.type ||
         decryptionParams.type === ModelsPublicNoteEncryptionTypeEnum.Disabled) {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         return decryptionParams.content;
     }
     const decryptedNote = (decryptionParams.type ===
@@ -52,6 +54,7 @@ async function _encryptViaPassword({ content, password, format = 'binary', }) {
     });
     const encryptedMessage = await _encrypt({
         message,
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         format: format,
         passwords: [password],
     });
@@ -73,6 +76,7 @@ export async function _encryptViaKeys({ content, publicKey: armoredPublicKey, pr
         : encryptedPrivateKey;
     const encryptedMessage = await _encrypt({
         message,
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         format: format,
         encryptionKeys: publicKey,
         signingKeys: privateKey,

package/models/command.d.ts

@@ -1,9 +1,10 @@
 import { DefaultCommands } from './default-commands.js';
-export declare const DEFAULT_KEYBINDING_GROUP = "default";
-export type CommandGroup = 'settings' | 'editor' | 'global' | 'note-detail' | 'completion' | string;
+import { COMMAND_GROUPS } from '../constants/command-groups.contant.js';
+export type CommandGroup = (typeof COMMAND_GROUPS)[number] | (string & Record<never, never>);
 export interface CommandHandlerParams<T = any> {
     event?: KeyboardEvent;
     data?: T;
+    meta: CommandMeta<T>;
     [key: string]: unknown;
 }
 export interface CommandPreview {
@@ -23,6 +24,6 @@ export interface CommandMeta<T = any> extends Partial<CommandPreview> {
         [key: string]: T;
     };
 }
-export interface Command<T = any> extends CommandMeta<T> {
-    handler: (params?: CommandHandlerParams) => unknown | Promise<unknown>;
+export interface Command<T = any, R = unknown> extends CommandMeta<T> {
+    handler: (params?: CommandHandlerParams<T>) => R | Promise<R>;
 }

package/models/command.js

@@ -1 +1 @@
-export const DEFAULT_KEYBINDING_GROUP = 'default';
+export {};

package/models/file-system.d.ts

@@ -27,4 +27,5 @@ export interface FileSystem {
     isDirExist: (path: string) => Promise<boolean>;
     isFileExist: (path: string) => Promise<boolean>;
     utimeSync: (path: string, atime?: string | number | Date, mtime?: string | number | Date) => Promise<void>;
+    init?: <T = unknown>(params?: T) => Promise<void>;
 }

package/models/modal.d.ts

@@ -1,5 +1,5 @@
 import { VueComponent } from './vue-component.js';
-export interface ModalConfig<T = any> {
+export interface ModalConfig<T = unknown> {
     closable?: boolean;
     title?: string;
     modalProps?: T;

package/models/vue-component.d.ts

@@ -1,3 +1,3 @@
 export type VueComponent = {
     __name: string;
-} & any;
+} & Record<string, unknown>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "orgnote-api",
-  "version": "0.19.4",
+  "version": "0.19.7",
   "description": "Official API for creating extensions for OrgNote app",
   "type": "module",
   "main": "./index.js",
@@ -9,6 +9,7 @@
     "test": "vitest",
     "build": "npm run clear && tspc --project tsconfig.json",
     "clear": "rm -rf dist",
+    "lint": "eslint -c ./eslint.config.js \"./src*/**/*.{ts,js,cjs,mjs}\"",
     "codegen:api": "openapi-generator-cli generate",
     "codegen:css-doc": "node collect-css-variables.cjs --docs",
     "codegen:css-types": "node collect-css-variables.cjs --types",
@@ -50,13 +51,17 @@
     "vue-router": "4.2.5"
   },
   "devDependencies": {
+    "@eslint/js": "9.17.0",
     "@openapitools/openapi-generator-cli": "2.13.4",
     "@types/node": "20.13.0",
+    "eslint": "9.17.0",
     "fix-esm-import-path": "1.10.0",
+    "globals": "15.14.0",
     "ts-patch": "3.2.1",
-    "typescript": "^5.3.3",
+    "typescript": "5.3.3",
+    "typescript-eslint": "8.18.1",
     "typescript-transform-paths": "3.5.1",
     "typescript-transformer-esm": "1.1.0",
-    "vitest": "^1.5.0"
+    "vitest": "1.5.0"
   }
 }

package/tools/__tests__/find-files-diff.spec.js

@@ -11,7 +11,9 @@ function cleanFiles() {
     try {
         rmdirSync(testFilesFolder, { recursive: true });
     }
-    catch (e) { }
+    catch {
+        return;
+    }
 }
 function createTestFile(content, fileName, updated) {
     const filePath = join(testFilesFolder, fileName);

package/tools/__tests__/find-note-files-diff.spec.js

@@ -17,7 +17,9 @@ function cleanFiles() {
     try {
         rmSync(testFilesFolder, { recursive: true });
     }
-    catch (e) { }
+    catch {
+        return;
+    }
 }
 function createTestFile(filePath, updated, content) {
     writeFileSync(filePath, content);

package/tools/extend-notes-files-diff.d.ts

@@ -1,3 +0,0 @@
-import { HandlersSyncNotesRequest } from "../remote-api/index.js";
-import { NoteChanges, FileSystem } from '../models/index.js';
-export declare function extendNotesFilesDiff(changes: NoteChanges, readFile: FileSystem['readFile']): Promise<HandlersSyncNotesRequest>;

package/tools/extend-notes-files-diff.js

@@ -1,21 +0,0 @@
-import { isOrgGpgFile } from "./is-org-file.js";
-export async function extendNotesFilesDiff(changes, readFile) {
-    const upsertedNotesFromLastSync = [
-        ...changes.updated,
-        ...changes.created,
-    ];
-    const notesFromLastSync = [];
-    for (const nc of upsertedNotesFromLastSync) {
-        const encrypted = isOrgGpgFile(nc.filePath);
-    }
-    const noteIdsFromLastSync = new Set(notesFromLastSync.map((n) => n.id));
-    const deletedNotesIdsWithoutRename = changes.deleted.reduce((acc, nc) => {
-        if (!noteIdsFromLastSync.has(nc.id)) {
-            acc.push(nc.id);
-        }
-        return acc;
-    }, []);
-    return {
-        deletedNotesIds: deletedNotesIdsWithoutRename,
-    };
-}