orgnote-api 0.8.4 → 0.10.1

package/api.ts

@@ -68,6 +68,10 @@ export interface OrgNoteApi {
       ) => WidgetBuilder;
     };
   };
+  // Available only on mobile apps
+  fileSystem: {
+    readPath: () => Promise<string>;
+  };
   commands: {
     add(...commands: Command[]): void;
     remove(...commands: Command[]): void;

package/encryption/note-encryption.ts

@@ -1,4 +1,7 @@
-import { ModelsPublicNote, ModelsPublicNoteEncryptedEnum } from '../remote-api';
+import {
+  ModelsPublicNote,
+  ModelsPublicNoteEncryptionTypeEnum,
+} from '../remote-api';
 
 import {
   decryptViaKeys,
@@ -9,10 +12,12 @@ import {
 import { OrgNoteEncryption } from '../models/encryption';
 import { parse, withMetaInfo } from 'org-mode-ast';
 
-export type NoteEncryptedType = `${ModelsPublicNote['encrypted']}`;
+export type NoteEncryptionType = `${ModelsPublicNote['encryptionType']}`;
+
 export interface AbstractEncryptedNote {
   content: string;
-  encrypted?: NoteEncryptedType;
+  encryptionType?: NoteEncryptionType;
+  encrypted?: boolean;
   meta: {
     [key: string]: any;
     published?: boolean;
@@ -24,7 +29,7 @@ export async function encryptNote<T extends AbstractEncryptedNote>(
 ): Promise<T> {
   if (
     !encryptionParams.type ||
-    encryptionParams.type === ModelsPublicNoteEncryptedEnum.Disabled ||
+    encryptionParams.type === ModelsPublicNoteEncryptionTypeEnum.Disabled ||
     note.meta.published
   ) {
     return note;
@@ -32,7 +37,7 @@ export async function encryptNote<T extends AbstractEncryptedNote>(
 
   note.meta = { id: note.meta.id, published: note.meta.published };
 
-  if (encryptionParams.type === ModelsPublicNoteEncryptedEnum.GpgKeys) {
+  if (encryptionParams.type === ModelsPublicNoteEncryptionTypeEnum.GpgKeys) {
     return await encryptNoteViaKeys(
       note,
       encryptionParams.publicKey,
@@ -50,7 +55,7 @@ export async function encryptNoteViaPassword<T extends AbstractEncryptedNote>(
   return {
     ...note,
     content,
-    encrypted: ModelsPublicNoteEncryptedEnum.GpgPassword,
+    encrypted: ModelsPublicNoteEncryptionTypeEnum.GpgPassword,
   };
 }
 
@@ -70,7 +75,7 @@ export async function encryptNoteViaKeys<T extends AbstractEncryptedNote>(
   return {
     ...note,
     content,
-    encrypted: ModelsPublicNoteEncryptedEnum.GpgKeys,
+    encrypted: ModelsPublicNoteEncryptionTypeEnum.GpgKeys,
   };
 }
 
@@ -82,12 +87,12 @@ export async function decryptNote<T extends AbstractEncryptedNote>(
     note.meta.published ||
     !note.encrypted ||
     !encryptionParams.type ||
-    encryptionParams.type === ModelsPublicNoteEncryptedEnum.Disabled
+    encryptionParams.type === ModelsPublicNoteEncryptionTypeEnum.Disabled
   ) {
     return note;
   }
   const decryptedNote =
-    encryptionParams.type === ModelsPublicNoteEncryptedEnum.GpgKeys
+    encryptionParams.type === ModelsPublicNoteEncryptionTypeEnum.GpgKeys
       ? await decryptNoteViaKeys(
           note,
           encryptionParams.privateKey,
@@ -111,7 +116,7 @@ export async function decryptNoteViaPassword<T extends AbstractEncryptedNote>(
   return {
     ...note,
     content,
-    encrypted: ModelsPublicNoteEncryptedEnum.GpgPassword,
+    encrypted: ModelsPublicNoteEncryptionTypeEnum.GpgPassword,
   };
 }
 
@@ -128,6 +133,6 @@ export async function decryptNoteViaKeys<T extends AbstractEncryptedNote>(
   return {
     ...note,
     content,
-    encrypted: ModelsPublicNoteEncryptedEnum.GpgKeys,
+    encrypted: ModelsPublicNoteEncryptionTypeEnum.GpgKeys,
   };
 }

package/index.ts

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

package/models/command.ts

@@ -30,6 +30,7 @@ export interface CommandMeta<T = any> extends Partial<CommandPreview> {
   group?: CommandGroup;
   allowOnInput?: boolean;
   ignorePrompt?: boolean;
+  interactive?: boolean;
   /* When command is system command, it will not be shown for users */
   system?: boolean;
   available?: () => boolean;

package/models/default-commands.ts

@@ -37,4 +37,8 @@ export enum DefaultCommands {
   OPEN_NOTE_VIEWER = 'view mode',
   OPEN_GRAPH = 'graph',
   OPEN_EXTENSIONS = 'extensions',
+
+  // Native mobile specific
+  SELECT_FILE_PATH = 'select file path',
+  PICK_SYNC_DIR = 'pick sync dir',
 }

package/models/encryption.ts

@@ -1,19 +1,19 @@
-import type { ModelsPublicNoteEncryptedEnum } from '../remote-api';
+import type { ModelsPublicNoteEncryptionTypeEnum } from '../remote-api';
 
 export interface OrgNoteGpgEncryption {
-  type: typeof ModelsPublicNoteEncryptedEnum.GpgKeys;
+  type: typeof ModelsPublicNoteEncryptionTypeEnum.GpgKeys;
   privateKey: string;
   publicKey: string;
   privateKeyPassphrase?: string;
 }
 
 export interface OrgNotePasswordEncryption {
-  type: typeof ModelsPublicNoteEncryptedEnum.GpgPassword;
+  type: typeof ModelsPublicNoteEncryptionTypeEnum.GpgPassword;
   password: string;
 }
 
 export interface OrgNoteDisabledEncryption {
-  type: typeof ModelsPublicNoteEncryptedEnum.Disabled;
+  type: typeof ModelsPublicNoteEncryptionTypeEnum.Disabled;
 }
 
 export type OrgNoteEncryption =

package/models/note.ts

@@ -16,9 +16,11 @@ export interface NotePreview {
   isMy: ModelsPublicNote['isMy'];
   author?: ModelsPublicUser;
   bookmarked?: boolean;
+  contentEncrypted?: boolean;
 }
 
 export interface Note extends ModelsPublicNote {
   deleted?: Date;
   bookmarked?: boolean;
+  contentEncrypted?: boolean;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "orgnote-api",
-  "version": "0.8.4",
+  "version": "0.10.1",
   "description": "Official API for creating extensions for OrgNote app",
   "type": "module",
   "main": "./index.ts",
@@ -22,7 +22,8 @@
     "api.ts",
     "remote-api/**",
     "models/**",
-    "encryption/**"
+    "encryption/**",
+    "tools/**"
   ],
   "exports": {
     ".": "./index.ts",
@@ -37,6 +38,7 @@
   },
   "homepage": "https://github.com/artawower/orgnote-api#readme",
   "dependencies": {
+    "@capacitor/filesystem": "6.0.0",
     "@codemirror/state": "6.4.1",
     "@codemirror/view": "6.26.3",
     "axios": "1.6.7",
@@ -47,6 +49,7 @@
   },
   "devDependencies": {
     "@openapitools/openapi-generator-cli": "2.9.0",
+    "@types/node": "20.13.0",
     "typescript": "^5.3.3",
     "vitest": "^1.5.0"
   }

package/remote-api/api.ts

@@ -59,7 +59,7 @@ export interface HandlersCreatingNote {
      * @type {string}
      * @memberof HandlersCreatingNote
      */
-    'encrypted'?: HandlersCreatingNoteEncryptedEnum;
+    'encryptionType'?: HandlersCreatingNoteEncryptionTypeEnum;
     /**
      * 
      * @type {Array<string>}
@@ -92,12 +92,12 @@ export interface HandlersCreatingNote {
     'updatedAt'?: string;
 }
 
-export const HandlersCreatingNoteEncryptedEnum = {
+export const HandlersCreatingNoteEncryptionTypeEnum = {
     Gpg: 'gpg',
     Password: 'password'
 } as const;
 
-export type HandlersCreatingNoteEncryptedEnum = typeof HandlersCreatingNoteEncryptedEnum[keyof typeof HandlersCreatingNoteEncryptedEnum];
+export type HandlersCreatingNoteEncryptionTypeEnum = typeof HandlersCreatingNoteEncryptionTypeEnum[keyof typeof HandlersCreatingNoteEncryptionTypeEnum];
 
 /**
  * 
@@ -616,7 +616,7 @@ export interface ModelsPublicNote {
      * @type {string}
      * @memberof ModelsPublicNote
      */
-    'encrypted'?: ModelsPublicNoteEncryptedEnum;
+    'encryptionType'?: ModelsPublicNoteEncryptionTypeEnum;
     /**
      * 
      * @type {Array<string>}
@@ -661,13 +661,13 @@ export interface ModelsPublicNote {
     'updatedAt'?: string;
 }
 
-export const ModelsPublicNoteEncryptedEnum = {
+export const ModelsPublicNoteEncryptionTypeEnum = {
     GpgKeys: 'gpgKeys',
     GpgPassword: 'gpgPassword',
     Disabled: 'disabled'
 } as const;
 
-export type ModelsPublicNoteEncryptedEnum = typeof ModelsPublicNoteEncryptedEnum[keyof typeof ModelsPublicNoteEncryptedEnum];
+export type ModelsPublicNoteEncryptionTypeEnum = typeof ModelsPublicNoteEncryptionTypeEnum[keyof typeof ModelsPublicNoteEncryptionTypeEnum];
 
 /**
  * 

package/tools/index.ts

@@ -0,0 +1 @@
+export * from './mock-server';

package/tools/mock-server.ts

@@ -0,0 +1,16 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+export const mockServer = <T extends (...params: any[]) => any>(
+  fn?: T,
+  defaultValue?: ReturnType<T>
+) => {
+  if (!fn) {
+    return (() => {}) as () => ReturnType<T>;
+  }
+  return (...params: Parameters<T>): ReturnType<T> => {
+    if (process.env.CLIENT) {
+      return fn(...params);
+    }
+    return defaultValue;
+  };
+};