orgnote-api 0.18.1 → 0.18.2

package/api.d.ts

@@ -1,9 +1,10 @@
-import { Command, CSSVariable, ThemeVariable, Note, InlineEmbeddedWidget, MultilineEmbeddedWidget, OrgLineClass, WidgetBuilder, CommandPreview, OrgNoteEncryption, Modal } from './models/index.js';
+import { Command, CSSVariable, ThemeVariable, Note, InlineEmbeddedWidget, MultilineEmbeddedWidget, OrgLineClass, FileSystem, WidgetBuilder, CommandPreview, OrgNoteEncryption, Modal, SyncStoreDefinition, FilesStoreDefinition, FileOpenerStoreDefinition, FileManageStoreDefinition } from './models/index.js';
 import type { NavigationFailure } from 'vue-router';
 import { WidgetType } from './models/widget-type.js';
 import type { Component } from 'vue';
 import { NodeType } from 'org-mode-ast';
 import { EditorExtension } from './models/editor.js';
+import { AuthStoreDefinition } from './models/auth-store.js';
 type WithNodeType<T> = {
     nodeType: NodeType;
 } & T;
@@ -60,8 +61,13 @@ export interface OrgNoteApi {
             }) => WidgetBuilder;
         };
     };
-    fileSystem: {
-        readPath: () => Promise<string>;
+    core: {
+        useFileSystem: () => FileSystem;
+        useSyncStore: SyncStoreDefinition;
+        useFilesStore: FilesStoreDefinition;
+        useFileOpenerStore: FileOpenerStoreDefinition;
+        useFileManagerStore: FileManageStoreDefinition;
+        useAuthStore: AuthStoreDefinition;
     };
     commands: {
         add(...commands: Command[]): void;

package/mappers/orgnode-to-note.js

@@ -4,8 +4,8 @@ export function orgnodeToNote(orgnode, fileInfo) {
         id: orgnode.meta.id,
         meta: orgnode.meta,
         filePath: splitPath(fileInfo.path),
-        touchedAt: new Date(fileInfo.atime).toISOString(),
+        touchedAt: fileInfo.atime && new Date(fileInfo.atime).toISOString(),
         updatedAt: new Date(Math.max(fileInfo.mtime, fileInfo.ctime)).toISOString(),
-        createdAt: new Date(fileInfo.ctime).toISOString(),
+        createdAt: fileInfo.ctime && new Date(fileInfo.ctime).toISOString(),
     };
 }

package/models/auth-store.d.ts

@@ -0,0 +1,21 @@
+import type { Ref } from 'vue';
+import { Store } from './store.js';
+import { PersonalInfo } from './user.js';
+import { OAuthProvider } from './oauth-provider.js';
+export interface AuthStore {
+    token: Ref<string>;
+    user: Ref<PersonalInfo>;
+    provider: Ref<OAuthProvider>;
+    auth: (params: {
+        provider: string;
+        environment?: string;
+        redirectUrl?: string;
+    }) => Promise<void>;
+    authViaGithub: (redirectUrl: string) => Promise<void>;
+    logout: () => Promise<void>;
+    verifyUser: () => Promise<void>;
+    authUser: (u: PersonalInfo, token: string) => Promise<void>;
+    subscribe: (token: string, email?: string) => Promise<void>;
+    removeUserAccount: () => Promise<void>;
+}
+export type AuthStoreDefinition = Store<AuthStore>;

package/models/auth-store.js

@@ -0,0 +1 @@
+export {};

package/models/default-commands.d.ts

@@ -26,5 +26,6 @@ export declare enum DefaultCommands {
     OPEN_GRAPH = "graph",
     OPEN_EXTENSIONS = "extensions",
     SELECT_FILE_PATH = "select file path",
-    PICK_SYNC_DIR = "pick sync dir"
+    PICK_SYNC_DIR = "pick sync dir",
+    SYNC_FILES = "sync files"
 }

package/models/default-commands.js

@@ -38,4 +38,6 @@ export var DefaultCommands;
     // Native mobile specific
     DefaultCommands["SELECT_FILE_PATH"] = "select file path";
     DefaultCommands["PICK_SYNC_DIR"] = "pick sync dir";
+    // File sync
+    DefaultCommands["SYNC_FILES"] = "sync files";
 })(DefaultCommands || (DefaultCommands = {}));

package/models/file-cache.d.ts

@@ -0,0 +1,12 @@
+export interface FileCache {
+    fileName: string;
+    filePath: string;
+    fileExtension: string;
+    updatedAt?: Date;
+    createdAt?: Date;
+    touchedAt?: Date;
+    size: number;
+    backlinksPaths?: string[];
+    deletedAt?: Date;
+    uploaded?: boolean;
+}

package/models/file-cache.js

@@ -0,0 +1 @@
+export {};

package/models/file-manager-store.d.ts

@@ -0,0 +1,14 @@
+import type { Ref } from 'vue';
+import { Store } from './store.js';
+import { FileNode } from './file-tree.js';
+export interface FileManagerStore {
+    fileTree: Ref<FileNode[]>;
+    renameFile: (fileNode: FileNode, newName: string) => Promise<void>;
+    deleteFile: (fileNode: FileNode) => Promise<void>;
+    updateFileManager: () => void;
+    createFolder: (name?: string) => Promise<void>;
+    editedFileItem: Ref<FileNode>;
+    stopEdit: () => void;
+    expandedNodes: Ref<string[]>;
+}
+export type FileManageStoreDefinition = Store<FileManagerStore>;

package/models/file-manager-store.js

@@ -0,0 +1 @@
+export {};

package/models/file-opener-store.d.ts

@@ -0,0 +1,5 @@
+import { Store } from './store.js';
+export interface FileOpenerStore {
+    openFile: (path: string[]) => Promise<void>;
+}
+export type FileOpenerStoreDefinition = Store<FileOpenerStore>;

package/models/file-opener-store.js

@@ -0,0 +1 @@
+export {};

package/models/file-path.d.ts

@@ -0,0 +1,4 @@
+export interface FilePathInfo {
+    filePath: string[];
+    id: string;
+}

package/models/file-path.js

@@ -0,0 +1 @@
+export {};

package/models/file-system.d.ts

@@ -10,7 +10,7 @@ export interface FileInfo {
     uri?: string;
 }
 export interface FileSystem {
-    readFile: <T extends 'utf8'>(path: string, encoding?: T) => Promise<T extends 'utf8' ? string : Uint8Array>;
+    readFile: <T extends 'utf8' | 'binary' = 'utf8', R = T extends 'utf8' ? string : Uint8Array>(path: string, encoding?: T) => Promise<R>;
     writeFile: (path: string, content: string | Uint8Array, encoding?: BufferEncoding) => Promise<void>;
     readDir: (path: string) => Promise<FileInfo[]>;
     fileInfo: (path: string) => Promise<FileInfo>;
@@ -20,4 +20,5 @@ export interface FileSystem {
     mkdir: (path: string) => Promise<void>;
     isDirExist: (path: string) => Promise<boolean>;
     isFileExist: (path: string) => Promise<boolean>;
+    utimeSync: (path: string, atime?: string | number | Date, mtime?: string | number | Date) => Promise<void>;
 }

package/models/file-tree.d.ts

@@ -0,0 +1,12 @@
+export interface FileNode {
+    name: string;
+    id?: string;
+    filePath: string[];
+    type: 'file' | 'directory';
+    meta?: {
+        color?: string;
+        icon?: string;
+        [key: string]: unknown;
+    };
+    children?: FileNode[];
+}

package/models/file-tree.js

@@ -0,0 +1 @@
+export {};

package/models/files-store.d.ts

@@ -0,0 +1,6 @@
+import { Store } from './store.js';
+export interface FilesStore {
+    getBlobUrl: (filePath: string) => Promise<string>;
+    uploadMediaFile: (path?: string) => Promise<string>;
+}
+export type FilesStoreDefinition = Store<FilesStore>;

package/models/files-store.js

@@ -0,0 +1 @@
+export {};

package/models/index.d.ts

@@ -11,3 +11,14 @@ export * from './default-commands.js';
 export * from './encryption.js';
 export * from './file-system.js';
 export * from './sync.js';
+export * from './file-cache.js';
+export * from './file-path.js';
+export * from './file-tree.js';
+export * from './user.js';
+export * from './oauth-provider.js';
+export * from './sync-store.js';
+export * from './files-store.js';
+export * from './file-opener-store.js';
+export * from './file-manager-store.js';
+export * from './auth-store.js';
+export * from './repositories.js';

package/models/index.js

@@ -11,3 +11,16 @@ export * from "./default-commands.js";
 export * from "./encryption.js";
 export * from "./file-system.js";
 export * from "./sync.js";
+export * from "./file-cache.js";
+export * from "./file-path.js";
+export * from "./file-tree.js";
+export * from "./user.js";
+export * from "./oauth-provider.js";
+// Stores
+export * from "./sync-store.js";
+export * from "./files-store.js";
+export * from "./file-opener-store.js";
+export * from "./file-manager-store.js";
+export * from "./auth-store.js";
+// Repositories
+export * from "./repositories.js";

package/models/oauth-provider.d.ts

@@ -0,0 +1 @@
+export type OAuthProvider = 'github' | 'google';

package/models/oauth-provider.js

@@ -0,0 +1 @@
+export {};

package/models/repositories.d.ts

@@ -0,0 +1,70 @@
+import { ExtensionMeta, StoredExtension } from './extension.js';
+import { FileCache } from './file-cache.js';
+import { FilePathInfo } from './file-path.js';
+import { Note, NotePreview } from './note.js';
+export interface ExtensionRepository {
+    getMeta(): Promise<ExtensionMeta[]>;
+    getActiveExtensions(): Promise<StoredExtension[]>;
+    setActiveStatus(extensionName: string, active: boolean): Promise<void>;
+    activateExtension(extensionName: string): Promise<void>;
+    deactivateExtension(extensionName: string): Promise<void>;
+    upsertExtensions(extensions: StoredExtension[]): Promise<void>;
+    getExtension(extensionName: string): Promise<StoredExtension>;
+    getExtensionBySource(source: string): Promise<StoredExtension>;
+    deleteBySource(source: string): Promise<void>;
+    delete(extensionName: string): Promise<void>;
+}
+export interface FileRepository {
+    upsert(file: FileCache): Promise<void>;
+    bulkUpsert(file: FileCache[]): Promise<void>;
+    update(filePath: string, file: Partial<FileCache>): Promise<void>;
+    delete(filePath: string): Promise<void>;
+    markAsDelete(filePath: string, deletedAt?: Date): Promise<void>;
+    clear(): Promise<void>;
+    getFirstUnuploaded(): Promise<FileCache>;
+    search(text: string): Promise<FileCache[]>;
+    getByPath(path: string): Promise<FileCache>;
+    getAll(): Promise<FileCache[]>;
+    getFilesAfterUpdateTime(updatedTime?: Date): Promise<FileCache[]>;
+    count(updatedTime?: Date): Promise<number>;
+}
+export interface NoteRepository {
+    getNotesAfterUpdateTime(updatedTime?: string): Promise<Note[]>;
+    getDeletedNotes(): Promise<Note[]>;
+    saveNotes(notes: Note[]): Promise<void>;
+    putNote(note: Note): Promise<void>;
+    getById(id: string): Promise<Note>;
+    getByPath(path: string[]): Promise<Note>;
+    getNotePreviews(options?: {
+        limit?: number;
+        offset?: number;
+        searchText?: string;
+        tags?: string[];
+        bookmarked?: boolean;
+    }): Promise<NotePreview[]>;
+    deleteNotes(noteIds: string[]): Promise<void>;
+    markAsDeleted(noteIds: string[]): Promise<void>;
+    bulkPartialUpdate(updates: {
+        id: string;
+        changes: Partial<Note>;
+    }[]): Promise<void>;
+    count(searchText?: string, tags?: string[]): Promise<number>;
+    getFilePaths(): Promise<FilePathInfo[]>;
+    touchNote(noteId: string): Promise<void>;
+    getTagsStatistic(): Promise<{
+        tag: string;
+        count: number;
+    }[]>;
+    addBookmark(noteId: string): Promise<void>;
+    deleteBookmark(noteId: string): Promise<void>;
+    modify(modifyCallback: (note: Note, ref: {
+        value: Note;
+    }) => void): Promise<void>;
+    getIds(filterCb?: (n: Note) => boolean): Promise<string[]>;
+    clear(): Promise<void>;
+}
+export interface Repositories {
+    notes: NoteRepository;
+    files: FileRepository;
+    extensions: ExtensionRepository;
+}

package/models/repositories.js

@@ -0,0 +1 @@
+export {};

package/models/store.d.ts

@@ -0,0 +1,2 @@
+import type { defineStore } from 'pinia';
+export type Store<T> = ReturnType<typeof defineStore<string, T>>;

package/models/store.js

@@ -0,0 +1 @@
+export {};

package/models/sync-store.d.ts

@@ -0,0 +1,10 @@
+import type { Ref } from 'vue';
+import { Store } from './store.js';
+export interface SyncStore {
+    markToSync: () => Promise<void>;
+    sync: () => Promise<void>;
+    forceResync: () => Promise<void>;
+    lastSyncTime: Ref<string>;
+    reset: () => void;
+}
+export type SyncStoreDefinition = Store<SyncStore>;

package/models/sync-store.js

@@ -0,0 +1 @@
+export {};

package/models/user.d.ts

@@ -0,0 +1,7 @@
+import { ModelsPublicUser, ModelsUserPersonalInfo } from "../remote-api/index.js";
+export interface User extends ModelsPublicUser {
+    isAnonymous?: boolean;
+}
+export interface PersonalInfo extends ModelsUserPersonalInfo {
+    isAnonymous?: boolean;
+}

package/models/user.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "orgnote-api",
-  "version": "0.18.1",
+  "version": "0.18.2",
   "description": "Official API for creating extensions for OrgNote app",
   "type": "module",
   "main": "./index.js",
@@ -45,7 +45,7 @@
     "axios": "1.7.3",
     "openpgp": "5.11.1",
     "org-mode-ast": "0.11.7",
-    "orgnote-api": "0.16.0",
+    "pinia": "2.1.7",
     "vue": "3.4.15",
     "vue-router": "4.2.5"
   },

package/tools/__tests__/parent-folder.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/tools/__tests__/parent-folder.spec.js

@@ -0,0 +1,14 @@
+import { test, expect } from 'vitest';
+import { getParentDir } from "../get-parent-dir.js";
+test('Should return correct parent dirs', () => {
+    expect(getParentDir('some/path/to/file')).toBe('some/path/to');
+    expect(getParentDir('another/path/to/dir/')).toBe('another/path/to');
+    expect(getParentDir(['root', 'folder', 'subfolder'])).toBe('root/folder');
+    expect(getParentDir('single')).toBe('');
+    expect(getParentDir('/file')).toBe('');
+    expect(getParentDir(['/'])).toBe('');
+    expect(getParentDir('file')).toBe('');
+});
+test('Should not return parent dir when file at the root', () => {
+    expect(getParentDir('')).toBe('');
+});

package/tools/get-file-name.d.ts

@@ -1,2 +1,3 @@
 export declare const getFileName: (path: string) => string;
 export declare const getFileNameWithoutExtension: (path: string) => string;
+export declare const getFileExtension: (path: string) => string;

package/tools/get-file-name.js

@@ -4,3 +4,6 @@ export const getFileName = (path) => {
 export const getFileNameWithoutExtension = (path) => {
     return getFileName(path).split('.').shift();
 };
+export const getFileExtension = (path) => {
+    return getFileName(path).split('.').pop();
+};

package/tools/get-parent-dir.d.ts

@@ -0,0 +1 @@
+export declare function getParentDir(path: string | string[]): string;

package/tools/get-parent-dir.js

@@ -0,0 +1,7 @@
+import { splitPath } from "./split-path.js";
+export function getParentDir(path) {
+    if (typeof path === 'string') {
+        path = splitPath(path);
+    }
+    return path.slice(0, -1).join('/');
+}

package/tools/index.d.ts

@@ -6,3 +6,4 @@ export * from './get-file-name.js';
 export * from './find-notes-files-diff.js';
 export * from './join-path.js';
 export * from './split-path.js';
+export * from './get-parent-dir.js';

package/tools/index.js

@@ -6,3 +6,4 @@ export * from "./get-file-name.js";
 export * from "./find-notes-files-diff.js";
 export * from "./join-path.js";
 export * from "./split-path.js";
+export * from "./get-parent-dir.js";