orgnote-api 0.12.1 → 0.12.2

package/models/command.ts

@@ -1,45 +0,0 @@
-import { DefaultCommands } from './default-commands';
-
-export const DEFAULT_KEYBINDING_GROUP = 'default';
-
-export type CommandGroup =
-  | 'settings'
-  | 'editor'
-  | 'global'
-  | 'note-detail'
-  | 'completion'
-  | string;
-
-export interface CommandHandlerParams<T = any> {
-  event?: KeyboardEvent;
-  data?: T;
-  [key: string]: unknown;
-}
-
-export interface CommandPreview {
-  description?: string;
-  command?: DefaultCommands | string;
-  title?: string | (() => string);
-  icon?: string | (() => string);
-}
-
-export interface CommandMeta<T = any> extends Partial<CommandPreview> {
-  // TODO: add support for multiple key sequences
-  keySequence?: string | string[];
-  /* Where is this command available, default value is global */
-  group?: CommandGroup;
-  allowOnInput?: boolean;
-  ignorePrompt?: boolean;
-  interactive?: boolean;
-  /* When command is system command, it will not be shown for users */
-  system?: boolean;
-  available?: () => boolean;
-  context?: {
-    [key: string]: T;
-  };
-}
-
-export interface Command<T = any> extends CommandMeta<T> {
-  /* arguments depend on the current scope */
-  handler: (params?: CommandHandlerParams) => unknown | Promise<unknown>;
-}

package/models/completion.ts

@@ -1,30 +0,0 @@
-export interface CompletionCandidate<T = unknown> {
-  icon?: string | (() => string);
-  group?: string;
-  title?: string | (() => string);
-  description?: string | (() => string);
-  command: string;
-  data: T;
-  /* Command handler could be used instead of command string */
-  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/models/default-commands.ts

@@ -1,44 +0,0 @@
-/*
- * 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 enum DefaultCommands {
-  // Global commands
-  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',
-
-  // Completion commands
-  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 = 'settings',
-  RESET_THEME = 'reset theme',
-  TOGGLE_DARK_MODE = 'toggle dark mode',
-  TOGGLE_DEBUG_MODE = 'toggle debug mode',
-  SELECT_THEME = 'select theme',
-
-  // Routing
-  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',
-
-  // Native mobile specific
-  SELECT_FILE_PATH = 'select file path',
-  PICK_SYNC_DIR = 'pick sync dir',
-}

package/models/editor.ts

@@ -1,27 +0,0 @@
-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;

package/models/encryption.ts

@@ -1,22 +0,0 @@
-import type { ModelsPublicNoteEncryptionTypeEnum } from '../remote-api';
-
-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;

package/models/extension.ts

@@ -1,45 +0,0 @@
-import { OrgNoteApi } from '../api';
-
-export interface ExtensionManifest {
-  /* Should be unique in the extension repo */
-  name: string;
-  version: string;
-  category: 'theme' | 'extension' | 'language pack' | 'other';
-  /* OrgNote api semver, 0.13.4 for example */
-  apiVersion?: string;
-  author?: string;
-  description?: string;
-  keywords?: string[];
-  // Repository url
-  sourceType: 'git' | 'file' | 'builtin';
-  /* Default value is README.org */
-  readmeFilePath?: string;
-  /* WIP */
-  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/models/index.ts

@@ -1,11 +0,0 @@
-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';

package/models/modal.ts

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

package/models/note.ts

@@ -1,26 +0,0 @@
-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 ModelsPublicNote {
-  deleted?: Date;
-  bookmarked?: boolean;
-  encrypted?: boolean;
-}

package/models/theme-variables.ts

@@ -1,194 +0,0 @@
-/**
-* This file is generated by the script `collect-css-variables.js`.
-* Do not edit it manually.
-**/
-
-export 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 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',
-}

package/models/vue-component.ts

@@ -1,3 +0,0 @@
-export type VueComponent = {
-  __name: string;
-} & any;

package/models/widget-type.ts

@@ -1,5 +0,0 @@
-export enum WidgetType {
-  Multiline = 'multiline',
-  Inline = 'inline',
-  LineClass = 'line-class',
-}

package/models/widget.ts

@@ -1,59 +0,0 @@
-import type { ChangeSpec } from '@codemirror/state';
-import { EditorView } from '@codemirror/view';
-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;
-
-export type OrgLineClass = { class: string | ((orgNode: OrgNode) => string) };
-export type OrgLineClasses = { [key in NodeType]?: OrgLineClass };

package/remote-api/.gitignore

@@ -1,4 +0,0 @@
-wwwroot/*.js
-node_modules
-typings
-dist

package/remote-api/.npmignore

@@ -1 +0,0 @@
-# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm

package/remote-api/.openapi-generator/FILES

@@ -1,8 +0,0 @@
-.gitignore
-.npmignore
-api.ts
-base.ts
-common.ts
-configuration.ts
-git_push.sh
-index.ts

package/remote-api/.openapi-generator/VERSION

@@ -1 +0,0 @@
-7.7.0

package/remote-api/.openapi-generator-ignore

@@ -1,23 +0,0 @@
-# OpenAPI Generator Ignore
-# Generated by openapi-generator https://github.com/openapitools/openapi-generator
-
-# Use this file to prevent files from being overwritten by the generator.
-# The patterns follow closely to .gitignore or .dockerignore.
-
-# As an example, the C# client generator defines ApiClient.cs.
-# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
-#ApiClient.cs
-
-# You can match any string of characters against a directory, file or extension with a single asterisk (*):
-#foo/*/qux
-# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
-
-# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
-#foo/**/qux
-# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
-
-# You can also negate patterns with an exclamation (!).
-# For example, you can ignore all files in a docs folder with the file extension .md:
-#docs/*.md
-# Then explicitly reverse the ignore rule for a single file:
-#!docs/README.md