orgnote-api 0.0.6 → 0.0.8

package/dist/generated/api/base.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Org Note API
+ * List of methods for work with Org Note.
+ *
+ * The version of the OpenAPI document: 0.0.1
+ * Contact: artawower@protonmail.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from './configuration';
+import type { AxiosInstance, AxiosRequestConfig } from 'axios';
+export declare const BASE_PATH: string;
+/**
+ *
+ * @export
+ */
+export declare const COLLECTION_FORMATS: {
+    csv: string;
+    ssv: string;
+    tsv: string;
+    pipes: string;
+};
+/**
+ *
+ * @export
+ * @interface RequestArgs
+ */
+export interface RequestArgs {
+    url: string;
+    options: AxiosRequestConfig;
+}
+/**
+ *
+ * @export
+ * @class BaseAPI
+ */
+export declare class BaseAPI {
+    protected basePath: string;
+    protected axios: AxiosInstance;
+    protected configuration: Configuration | undefined;
+    constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
+}
+/**
+ *
+ * @export
+ * @class RequiredError
+ * @extends {Error}
+ */
+export declare class RequiredError extends Error {
+    field: string;
+    constructor(field: string, msg?: string);
+}

package/dist/generated/api/common.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Org Note API
+ * List of methods for work with Org Note.
+ *
+ * The version of the OpenAPI document: 0.0.1
+ * Contact: artawower@protonmail.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from "./configuration";
+import type { RequestArgs } from "./base";
+import type { AxiosInstance, AxiosResponse } from 'axios';
+/**
+ *
+ * @export
+ */
+export declare const DUMMY_BASE_URL = "https://example.com";
+/**
+ *
+ * @throws {RequiredError}
+ * @export
+ */
+export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
+/**
+ *
+ * @export
+ */
+export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
+/**
+ *
+ * @export
+ */
+export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
+/**
+ *
+ * @export
+ */
+export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
+/**
+ *
+ * @export
+ */
+export declare const toPathString: (url: URL) => string;
+/**
+ *
+ * @export
+ */
+export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T, any>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;

package/dist/generated/api/configuration.d.ts

@@ -0,0 +1,83 @@
+/**
+ * Org Note API
+ * List of methods for work with Org Note.
+ *
+ * The version of the OpenAPI document: 0.0.1
+ * Contact: artawower@protonmail.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface ConfigurationParameters {
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    username?: string;
+    password?: string;
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    basePath?: string;
+    baseOptions?: any;
+    formDataCtor?: new () => any;
+}
+export declare class Configuration {
+    /**
+     * parameter for apiKey security
+     * @param name security name
+     * @memberof Configuration
+     */
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    username?: string;
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    password?: string;
+    /**
+     * parameter for oauth2 security
+     * @param name security name
+     * @param scopes oauth2 scope
+     * @memberof Configuration
+     */
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    /**
+     * override base path
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    basePath?: string;
+    /**
+     * base options for axios calls
+     *
+     * @type {any}
+     * @memberof Configuration
+     */
+    baseOptions?: any;
+    /**
+     * The FormData constructor that will be used to create multipart form data
+     * requests. You can inject this here so that execution environments that
+     * do not support the FormData class can still run the generated client.
+     *
+     * @type {new () => FormData}
+     */
+    formDataCtor?: new () => any;
+    constructor(param?: ConfigurationParameters);
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    isJsonMime(mime: string): boolean;
+}

package/dist/generated/api/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Org Note API
+ * List of methods for work with Org Note.
+ *
+ * The version of the OpenAPI document: 0.0.1
+ * Contact: artawower@protonmail.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export * from "./api";
+export * from "./configuration";

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './api';
+export * from './models';

package/dist/models/command.d.ts

@@ -0,0 +1,18 @@
+export declare const DEFAULT_KEYBINDING_GROUP = "default";
+export type CommandGroup = 'settings' | 'editor' | 'global' | 'note-detail' | 'completion' | string;
+export interface CommandHandlerParams {
+    event?: KeyboardEvent;
+    data?: unknown;
+    [key: string]: unknown;
+}
+export interface Command {
+    keySequence?: string | string[];
+    description?: string;
+    command?: string;
+    title?: string | (() => string);
+    icon?: string | (() => string);
+    group?: CommandGroup;
+    allowOnInput?: boolean;
+    ignorePrompt?: boolean;
+    handler: (params?: CommandHandlerParams) => unknown | Promise<unknown>;
+}

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;
+    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/extension.d.ts

@@ -0,0 +1,34 @@
+import { OrgNoteApi } from 'src/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';
+    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/index.d.ts

@@ -0,0 +1,6 @@
+export * from './note';
+export * from './command';
+export * from './completion';
+export * from './extension';
+export * from './theme-variables';
+export * from './widget';

package/dist/models/modal.d.ts

@@ -0,0 +1,4 @@
+export interface ModalConfig {
+    closable?: boolean;
+    title?: string;
+}

package/dist/models/note.d.ts

@@ -0,0 +1,21 @@
+import type { ModelsPublicNote, ModelsPublicUser } from '../generated/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;
+}
+export interface Note extends ModelsPublicNote {
+    deleted?: Date;
+    bookmarked?: boolean;
+}

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

@@ -0,0 +1,183 @@
+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",
+    fg = "fg",
+    fgAlt = "fgAlt",
+    base0 = "base0",
+    base1 = "base1",
+    base2 = "base2",
+    base3 = "base3",
+    base4 = "base4",
+    base5 = "base5",
+    base6 = "base6",
+    base7 = "base7",
+    base8 = "base8",
+    bgAlt2 = "bgAlt2"
+}
+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",
+    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",
+    blockPaddingMd = "blockPaddingMd",
+    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"
+}

package/dist/models/widget.d.ts

@@ -0,0 +1,45 @@
+import type { ChangeSpec } from '@codemirror/state';
+import type { EditorView } from 'codemirror';
+import type { NodeType, OrgNode } from 'org-mode-ast';
+export type EmbeddedWidget = {
+    destroy: () => void;
+    refresh?: (...args: unknown[]) => void;
+};
+export interface WidgetBuilderParams {
+    wrap: HTMLElement;
+    orgNode: OrgNode;
+    rootNodeSrc: () => OrgNode;
+    onUpdateFn?: (newVal: string) => void;
+    editorView: EditorView;
+    readonly?: boolean;
+}
+export type WidgetBuilder = (params: WidgetBuilderParams) => EmbeddedWidget;
+export interface CommonEmbeddedWidget {
+    satisfied?: (orgNode: OrgNode) => boolean;
+    widgetBuilder?: WidgetBuilder;
+    viewUpdater?: (orgNode: OrgNode, newVal: string) => ViewUpdateSchema;
+    ignoreEvent?: boolean;
+    showRangeOffset?: [number, number];
+}
+export interface MultilineEmbeddedWidget extends CommonEmbeddedWidget {
+    widgetBuilder: WidgetBuilder;
+    suppressEdit?: boolean;
+}
+export type MultilineEmbeddedWidgets = {
+    [key in NodeType]?: MultilineEmbeddedWidget;
+};
+export type ViewUpdateSchema = ChangeSpec;
+export interface InlineEmbeddedWidget extends CommonEmbeddedWidget {
+    classBuilder?: (orgNode: OrgNode) => string;
+    decorationType: 'mark' | 'widget' | 'replace' | 'line';
+    ignoreEditing?: boolean;
+    side?: number;
+    wrapComponent?: string;
+    inclusive?: boolean;
+}
+export type InlineEmbeddedWidgets = {
+    [key in NodeType]?: InlineEmbeddedWidget;
+};
+export type EmbeddedWidgetBuilder = (wrap: HTMLElement, dynamicProps?: {
+    [key: string]: unknown;
+}) => EmbeddedWidget;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "orgnote-api",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "description": "Official API for creating extensions for OrgNote app",
   "type": "module",
   "main": "dist/index.ts",