orgnote-api 0.17.0 → 0.17.2

package/dist/models/completion.d.ts

@@ -0,0 +1,22 @@
+export interface CompletionCandidate<T = unknown> {
+    icon?: string | (() => string);
+    group?: string;
+    title?: string | (() => string);
+    description?: string | (() => string);
+    command: string;
+    data: T;
+    commandHandler?: (data: T) => void;
+}
+export interface CompletionSearchResult<T = unknown> {
+    total?: number;
+    result: CompletionCandidate<T>[];
+}
+export type CandidateGetterFn<T = unknown> = (filter: string, limit?: number, offset?: number) => CompletionSearchResult<T> | Promise<CompletionSearchResult<T>>;
+export interface CompletionConfigs<T = unknown> {
+    searchAutocompletions?: string[];
+    itemsGetter: CandidateGetterFn<T>;
+    placeholder?: string;
+    itemHeight?: string;
+    searchText?: string;
+    onClicked?: (candidate: CompletionCandidate<T>) => void;
+}

package/dist/models/completion.js

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

package/dist/models/default-commands.d.ts

@@ -0,0 +1,30 @@
+export declare enum DefaultCommands {
+    REPORT_BUG = "report bug",
+    OPEN_DEBUG_INFO = "open debug info",
+    SHOW_LOGS = "show logs",
+    TOGGLE_SIDEBAR = "toggle sidebar",
+    TOGGLE_FILE_MANAGER = "toggle file manager",
+    CREATE_NOTE = "create note",
+    PROJECT_INFO = "project info",
+    SEARCH = "search",
+    TOGGLE_COMMANDS = "toggle commands",
+    RESTORE_COMPLETION = "restore last completion",
+    EXIT_COMMAND_EXECUTOR = "exit command executor",
+    NEXT_CANDIDATE = "next candidate",
+    PREV_CANDIDATE = "previous candidate",
+    EXECUTE_CANDIDATE = "execute candidate",
+    SETTINGS = "settings",
+    RESET_THEME = "reset theme",
+    TOGGLE_DARK_MODE = "toggle dark mode",
+    TOGGLE_DEBUG_MODE = "toggle debug mode",
+    SELECT_THEME = "select theme",
+    OPEN_MY_NOTES = "my notes",
+    OPEN_DASHBOARD = "dashboard",
+    OPEN_PUBLIC_NOTE_LIST = "public note list",
+    OPEN_NOTE_EDITOR = "edit mode",
+    OPEN_NOTE_VIEWER = "view mode",
+    OPEN_GRAPH = "graph",
+    OPEN_EXTENSIONS = "extensions",
+    SELECT_FILE_PATH = "select file path",
+    PICK_SYNC_DIR = "pick sync dir"
+}

package/dist/models/default-commands.js

@@ -0,0 +1,41 @@
+/*
+ * This are default commands. It's not a complete list
+ * Some of the commands are dynamically generated or
+ * can be added by user extensions.
+ */
+export var DefaultCommands;
+(function (DefaultCommands) {
+    // Global commands
+    DefaultCommands["REPORT_BUG"] = "report bug";
+    DefaultCommands["OPEN_DEBUG_INFO"] = "open debug info";
+    DefaultCommands["SHOW_LOGS"] = "show logs";
+    DefaultCommands["TOGGLE_SIDEBAR"] = "toggle sidebar";
+    DefaultCommands["TOGGLE_FILE_MANAGER"] = "toggle file manager";
+    DefaultCommands["CREATE_NOTE"] = "create note";
+    DefaultCommands["PROJECT_INFO"] = "project info";
+    // Completion commands
+    DefaultCommands["SEARCH"] = "search";
+    DefaultCommands["TOGGLE_COMMANDS"] = "toggle commands";
+    DefaultCommands["RESTORE_COMPLETION"] = "restore last completion";
+    DefaultCommands["EXIT_COMMAND_EXECUTOR"] = "exit command executor";
+    DefaultCommands["NEXT_CANDIDATE"] = "next candidate";
+    DefaultCommands["PREV_CANDIDATE"] = "previous candidate";
+    DefaultCommands["EXECUTE_CANDIDATE"] = "execute candidate";
+    // Settings
+    DefaultCommands["SETTINGS"] = "settings";
+    DefaultCommands["RESET_THEME"] = "reset theme";
+    DefaultCommands["TOGGLE_DARK_MODE"] = "toggle dark mode";
+    DefaultCommands["TOGGLE_DEBUG_MODE"] = "toggle debug mode";
+    DefaultCommands["SELECT_THEME"] = "select theme";
+    // Routing
+    DefaultCommands["OPEN_MY_NOTES"] = "my notes";
+    DefaultCommands["OPEN_DASHBOARD"] = "dashboard";
+    DefaultCommands["OPEN_PUBLIC_NOTE_LIST"] = "public note list";
+    DefaultCommands["OPEN_NOTE_EDITOR"] = "edit mode";
+    DefaultCommands["OPEN_NOTE_VIEWER"] = "view mode";
+    DefaultCommands["OPEN_GRAPH"] = "graph";
+    DefaultCommands["OPEN_EXTENSIONS"] = "extensions";
+    // Native mobile specific
+    DefaultCommands["SELECT_FILE_PATH"] = "select file path";
+    DefaultCommands["PICK_SYNC_DIR"] = "pick sync dir";
+})(DefaultCommands || (DefaultCommands = {}));

package/dist/models/editor.d.ts

@@ -0,0 +1,23 @@
+import type { OrgNode } from 'org-mode-ast';
+import type { Component } from 'vue';
+import type { EditorView } from '@codemirror/view';
+import type { Extension } from '@codemirror/state';
+import { InlineEmbeddedWidget } from './widget';
+interface DynamicComponent {
+    mount: (cmp: Component, wrap: Element, props?: {
+        [key: string]: unknown;
+    }) => {
+        destroy: () => void;
+        refresh: (...args: unknown[]) => void;
+    };
+}
+export interface EditorExtensionParams {
+    orgNodeGetter: () => OrgNode;
+    readonly: boolean;
+    showSpecialSymbols?: boolean;
+    dynamicComponent: DynamicComponent;
+    foldWidget?: InlineEmbeddedWidget;
+    editorViewGetter: () => EditorView;
+}
+export type EditorExtension = (params: EditorExtensionParams) => Extension;
+export {};

package/dist/models/editor.js

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

package/dist/models/encryption.d.ts

@@ -0,0 +1,31 @@
+import type { ModelsPublicNoteEncryptionTypeEnum } from '../remote-api';
+export type EcnryptionFormat = 'binary' | 'armored';
+export interface BaseOrgNoteEncryption {
+    format?: 'binary' | 'armored';
+}
+export interface BaseOrgNoteDecryption {
+    format?: 'utf8' | 'binary';
+}
+export interface OrgNoteGpgEncryption {
+    type: typeof ModelsPublicNoteEncryptionTypeEnum.GpgKeys;
+    privateKey: string;
+    publicKey?: string;
+    privateKeyPassphrase?: string;
+}
+export interface OrgNotePasswordEncryption {
+    type: typeof ModelsPublicNoteEncryptionTypeEnum.GpgPassword;
+    password: string;
+}
+export interface OrgNoteDisabledEncryption {
+    type: typeof ModelsPublicNoteEncryptionTypeEnum.Disabled;
+}
+export type OrgNoteEncryption = OrgNoteGpgEncryption | OrgNotePasswordEncryption | OrgNoteDisabledEncryption;
+export type EncryptionData = {
+    content: string;
+};
+export type WithEncryptionContent<T extends OrgNoteEncryption = OrgNoteEncryption> = T & EncryptionData & BaseOrgNoteEncryption;
+export type DecriptionData = {
+    content: string | Uint8Array;
+};
+export type WithDecryptionContent<T extends OrgNoteEncryption = OrgNoteEncryption> = T & DecriptionData & BaseOrgNoteDecryption;
+export type WithNoteDecryptionContent<T extends OrgNoteEncryption = OrgNoteEncryption> = T & DecriptionData;

package/dist/models/encryption.js

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

package/dist/models/extension.d.ts

@@ -0,0 +1,34 @@
+import { OrgNoteApi } from '../api';
+export interface ExtensionManifest {
+    name: string;
+    version: string;
+    category: 'theme' | 'extension' | 'language pack' | 'other';
+    apiVersion?: string;
+    author?: string;
+    description?: string;
+    keywords?: string[];
+    sourceType: 'git' | 'file' | 'builtin';
+    readmeFilePath?: string;
+    permissions?: Array<'files' | 'personal info' | '*' | 'third party'>;
+    reloadRequired?: boolean;
+    sourceUrl?: string;
+    sponsor?: string[];
+    development?: boolean;
+    icon?: string;
+}
+export interface Extension {
+    [key: string]: unknown;
+    onMounted: (api: OrgNoteApi) => Promise<void>;
+    onUnmounted?: (api: OrgNoteApi) => Promise<void>;
+}
+export interface ExtensionMeta {
+    manifest: ExtensionManifest;
+    uploaded?: boolean;
+    active?: boolean;
+}
+export interface StoredExtension extends ExtensionMeta {
+    module?: string;
+}
+export interface ActiveExtension extends ExtensionMeta {
+    module: Extension;
+}

package/dist/models/extension.js

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

package/dist/models/file-system.d.ts

@@ -0,0 +1,23 @@
+/// <reference types="node" />
+export interface FileInfo {
+    name: string;
+    path: string;
+    type: 'directory' | 'file';
+    size: number;
+    atime?: number;
+    ctime?: number;
+    mtime: number;
+    uri?: string;
+}
+export interface FileSystem {
+    readFile: <T extends 'utf8'>(path: string, encoding?: T) => Promise<T extends 'utf8' ? string : Uint8Array>;
+    writeFile: (path: string, content: string | Uint8Array, encoding?: BufferEncoding) => Promise<void>;
+    readDir: (path: string) => Promise<FileInfo[]>;
+    fileInfo: (path: string) => Promise<FileInfo>;
+    rename: (path: string, newPath: string) => Promise<void>;
+    deleteFile: (path: string) => Promise<void>;
+    rmdir: (path: string) => Promise<void>;
+    mkdir: (path: string) => Promise<void>;
+    isDirExist: (path: string) => Promise<boolean>;
+    isFileExist: (path: string) => Promise<boolean>;
+}

package/dist/models/file-system.js

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

package/{models/index.ts → dist/models/index.d.ts}

@@ -9,3 +9,5 @@ export * from './widget-type';
 export * from './editor';
 export * from './default-commands';
 export * from './encryption';
+export * from './file-system';
+export * from './sync';

package/dist/models/index.js

@@ -0,0 +1,13 @@
+export * from './note';
+export * from './command';
+export * from './completion';
+export * from './extension';
+export * from './theme-variables';
+export * from './widget';
+export * from './modal';
+export * from './widget-type';
+export * from './editor';
+export * from './default-commands';
+export * from './encryption';
+export * from './file-system';
+export * from './sync';

package/dist/models/modal.d.ts

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

package/dist/models/modal.js

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

package/dist/models/note.d.ts

@@ -0,0 +1,23 @@
+import type { ModelsPublicNote, ModelsPublicUser } from '../remote-api';
+export interface NotesFilter {
+    searchText?: string;
+    userId?: string;
+    limit?: number;
+    offset?: number;
+}
+export interface NotePreview {
+    id: ModelsPublicNote['id'];
+    meta: ModelsPublicNote['meta'];
+    createdAt: ModelsPublicNote['createdAt'];
+    updatedAt: ModelsPublicNote['updatedAt'];
+    filePath: ModelsPublicNote['filePath'];
+    isMy: ModelsPublicNote['isMy'];
+    author?: ModelsPublicUser;
+    bookmarked?: boolean;
+    encrypted?: boolean;
+}
+export interface Note extends Omit<ModelsPublicNote, 'content'> {
+    deleted?: Date;
+    bookmarked?: boolean;
+    encrypted?: boolean;
+}

package/dist/models/note.js

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

package/dist/models/sync.d.ts

@@ -0,0 +1,34 @@
+import { HandlersCreatingNote } from 'src/remote-api';
+import { FileSystem } from './file-system';
+export interface Changes {
+    deleted: string[];
+    created: string[];
+    updated: string[];
+}
+export interface NoteChange {
+    filePath: string;
+    id?: string;
+}
+export interface NoteChanges {
+    deleted: NoteChange[];
+    created: NoteChange[];
+    updated: NoteChange[];
+}
+export interface FullContextNoteChanges extends Omit<NoteChanges, 'created' | 'updated'> {
+    created: HandlersCreatingNote[];
+    updated: HandlersCreatingNote[];
+}
+export interface StoredNoteInfo {
+    filePath: string[];
+    id: string;
+    updatedAt: string | Date;
+}
+export interface FileScanParams {
+    readDir: FileSystem['readDir'];
+    fileInfo: FileSystem['fileInfo'];
+    dirPath: string;
+}
+export interface SyncParams extends FileScanParams {
+    storedNotesInfo: StoredNoteInfo[];
+    lastSync?: Date;
+}

package/dist/models/sync.js

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

package/dist/models/theme-variables.d.ts

@@ -0,0 +1,192 @@
+/**
+* This file is generated by the script `collect-css-variables.js`.
+* Do not edit it manually.
+**/
+export declare enum ThemeVariable {
+    red = "red",
+    orange = "orange",
+    green = "green",
+    teal = "teal",
+    yellow = "yellow",
+    blue = "blue",
+    darkBlue = "darkBlue",
+    magenta = "magenta",
+    violet = "violet",
+    cyan = "cyan",
+    darkCyan = "darkCyan",
+    white = "white",
+    bg = "bg",
+    bgAlt = "bgAlt",
+    bgAlt2 = "bgAlt2",
+    fg = "fg",
+    fgAlt = "fgAlt",
+    base0 = "base0",
+    base1 = "base1",
+    base2 = "base2",
+    base3 = "base3",
+    base4 = "base4",
+    base5 = "base5",
+    base6 = "base6",
+    base7 = "base7",
+    base8 = "base8"
+}
+export declare enum CSSVariable {
+    bg = "bg",
+    fg = "fg",
+    dur = "dur",
+    easyTableHeaderBackgroundColor = "easyTableHeaderBackgroundColor",
+    easyTableHeaderFontColor = "easyTableHeaderFontColor",
+    easyTableBodyRowBackgroundColor = "easyTableBodyRowBackgroundColor",
+    easyTableBodyRowFontColor = "easyTableBodyRowFontColor",
+    easyTableBodyRowHoverBackgroundColor = "easyTableBodyRowHoverBackgroundColor",
+    easyTableFooterBackgroundColor = "easyTableFooterBackgroundColor",
+    easyTableFooterFontColor = "easyTableFooterFontColor",
+    easyTableBodyRowHoverFontColor = "easyTableBodyRowHoverFontColor",
+    easyTableRowBorder = "easyTableRowBorder",
+    easyTableBorder = "easyTableBorder",
+    easyTableMessageFontColor = "easyTableMessageFontColor",
+    btnFlatSize = "btnFlatSize",
+    btnFlatBorder = "btnFlatBorder",
+    btnFlatBorderRadius = "btnFlatBorderRadius",
+    btnFlatBoxShadow = "btnFlatBoxShadow",
+    btnMainColor = "btnMainColor",
+    btnSocialSize = "btnSocialSize",
+    btnSocialBackground = "btnSocialBackground",
+    checkboxColor = "checkboxColor",
+    editorFontFamily = "editorFontFamily",
+    flexGapMd = "flexGapMd",
+    flexGapSm = "flexGapSm",
+    inlineCodeBackground = "inlineCodeBackground",
+    inlineCodeFontColor = "inlineCodeFontColor",
+    scrollBarWidth = "scrollBarWidth",
+    scrollBarColor = "scrollBarColor",
+    fontSizeSm = "fontSizeSm",
+    fontSizeMd = "fontSizeMd",
+    fontSizeLg = "fontSizeLg",
+    headlineMargin = "headlineMargin",
+    paragraphFontSize = "paragraphFontSize",
+    mainFontFamily = "mainFontFamily",
+    editorFontFamilyMain = "editorFontFamilyMain",
+    paragraphFontFamily = "paragraphFontFamily",
+    headlineFontFamily = "headlineFontFamily",
+    codeFontFamily = "codeFontFamily",
+    descriptionFontFamily = "descriptionFontFamily",
+    descriptionFontSize = "descriptionFontSize",
+    descriptionFontStyle = "descriptionFontStyle",
+    descriptionFontColor = "descriptionFontColor",
+    descriptionPadding = "descriptionPadding",
+    codeFontSize = "codeFontSize",
+    headlineFontWeight = "headlineFontWeight",
+    fontColorAction = "fontColorAction",
+    fontSm = "fontSm",
+    fontMd = "fontMd",
+    fontLg = "fontLg",
+    ulFontSize = "ulFontSize",
+    ulLineHeight = "ulLineHeight",
+    ulFontFamily = "ulFontFamily",
+    topBarHeight = "topBarHeight",
+    contentMaxWidth = "contentMaxWidth",
+    modelineHeight = "modelineHeight",
+    modelinePadding = "modelinePadding",
+    modelineBackground = "modelineBackground",
+    cardBackgroundColor = "cardBackgroundColor",
+    shadowMain = "shadowMain",
+    sidebarWidth = "sidebarWidth",
+    actionPaneOpenedWidth = "actionPaneOpenedWidth",
+    footerHeight = "footerHeight",
+    publicPreviewImageWidth = "publicPreviewImageWidth",
+    publicPreviewImageHeight = "publicPreviewImageHeight",
+    publicPreviewMaxHeight = "publicPreviewMaxHeight",
+    completionItemMinHeight = "completionItemMinHeight",
+    completionItemPadding = "completionItemPadding",
+    completionItemMargin = "completionItemMargin",
+    completionItemHoverBackground = "completionItemHoverBackground",
+    completionItemHoverColor = "completionItemHoverColor",
+    completionFloatTop = "completionFloatTop",
+    completionBorderRadius = "completionBorderRadius",
+    completionWidth = "completionWidth",
+    completionMaxWidth = "completionMaxWidth",
+    completionBorder = "completionBorder",
+    completionBoxShadow = "completionBoxShadow",
+    completionInputHeight = "completionInputHeight",
+    completionContainerMargin = "completionContainerMargin",
+    menuPadding = "menuPadding",
+    fileUploaderBorderWidth = "fileUploaderBorderWidth",
+    fileUploaderBorderStyle = "fileUploaderBorderStyle",
+    fileUploaderBorderColor = "fileUploaderBorderColor",
+    fileUploaderBg = "fileUploaderBg",
+    fileUploaderOpacity = "fileUploaderOpacity",
+    notePreviewLinkMaxWidth = "notePreviewLinkMaxWidth",
+    notePreviewLinkHeight = "notePreviewLinkHeight",
+    btnActionShadow = "btnActionShadow",
+    btnActionBorder = "btnActionBorder",
+    btnActionBorderColor = "btnActionBorderColor",
+    btnActionPadding = "btnActionPadding",
+    btnActionRadius = "btnActionRadius",
+    btnActionFireColor = "btnActionFireColor",
+    btnActionFireBorderColor = "btnActionFireBorderColor",
+    btnActionMd = "btnActionMd",
+    btnActionSm = "btnActionSm",
+    btnActionLg = "btnActionLg",
+    btnActionColor = "btnActionColor",
+    btnActionBg = "btnActionBg",
+    miniBufferBackground = "miniBufferBackground",
+    miniBufferFontColor = "miniBufferFontColor",
+    miniBufferBorderTop = "miniBufferBorderTop",
+    miniBufferMaxHeight = "miniBufferMaxHeight",
+    tagHoverBackground = "tagHoverBackground",
+    tagHoverColor = "tagHoverColor",
+    toolbarBorderTop = "toolbarBorderTop",
+    toolbarHoverColor = "toolbarHoverColor",
+    headerbarHeight = "headerbarHeight",
+    headerbarBorderRadius = "headerbarBorderRadius",
+    headerbarBackgroundColor = "headerbarBackgroundColor",
+    headerbarColor = "headerbarColor",
+    headerbarBorder = "headerbarBorder",
+    fileItemBgHover = "fileItemBgHover",
+    fileItemColorHover = "fileItemColorHover",
+    fileItemHeight = "fileItemHeight",
+    iconBtnColor = "iconBtnColor",
+    iconBtnHoverColor = "iconBtnHoverColor",
+    modalMaxHeight = "modalMaxHeight",
+    modalMaxWidth = "modalMaxWidth",
+    modalPadding = "modalPadding",
+    blockPaddingSm = "blockPaddingSm",
+    blockPaddingMd = "blockPaddingMd",
+    blockPaddingLg = "blockPaddingLg",
+    blockMarginMd = "blockMarginMd",
+    blockMarginSm = "blockMarginSm",
+    blockBorderRadiusMd = "blockBorderRadiusMd",
+    blockBorderRadiusSm = "blockBorderRadiusSm",
+    itemDefaultRadius = "itemDefaultRadius",
+    searchIcnSize = "searchIcnSize",
+    gapMd = "gapMd",
+    gapSm = "gapSm",
+    gapXs = "gapXs",
+    srcBlockHeaderPaddingY = "srcBlockHeaderPaddingY",
+    srcBlockFooterPaddingY = "srcBlockFooterPaddingY",
+    srcBlockPaddingX = "srcBlockPaddingX",
+    srcBlockPaddingY = "srcBlockPaddingY",
+    srcBlockMarginY = "srcBlockMarginY",
+    pagePadding = "pagePadding",
+    editorLineHeight = "editorLineHeight",
+    editorHeadlineLineHeight = "editorHeadlineLineHeight",
+    editorDefaultLineHeight = "editorDefaultLineHeight",
+    editorPaddingBottom = "editorPaddingBottom",
+    editorCursorColor = "editorCursorColor",
+    editorSelectionBgColor = "editorSelectionBgColor",
+    editorSelectionColor = "editorSelectionColor",
+    editorGutterColor = "editorGutterColor",
+    editorGutterHoverColor = "editorGutterHoverColor",
+    editorFoldPlaceholderColor = "editorFoldPlaceholderColor",
+    editorActiveLineBgColor = "editorActiveLineBgColor",
+    editorCaretColor = "editorCaretColor",
+    orgListItemBulletMarginLeft = "orgListItemBulletMarginLeft",
+    devicePaddingBottom = "devicePaddingBottom",
+    graphNodeColor = "graphNodeColor",
+    graphEdgeColor = "graphEdgeColor",
+    graphActiveColor = "graphActiveColor",
+    inputHeight = "inputHeight",
+    inputLgHeight = "inputLgHeight",
+    borderMain = "borderMain"
+}