@ones-editor/editor 2.6.8 → 2.7.0

package/@ones-editor/server-tools/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@ones-editor/server-tools",
+  "version": "1.0.0",
+  "scripts": {
+    "build:dev": "webpack --mode development --devtool source-map",
+    "build": "webpack --mode production"
+  },
+  "devDependencies": {
+    "css-loader": "^6.7.1",
+    "null-loader": "^4.0.1",
+    "sass-loader": "^13.1.0",
+    "style-loader": "^3.3.1",
+    "ts-loader": "^9.4.1",
+    "ts-node": "^10.9.1",
+    "tsc": "^2.0.4",
+    "typescript": "^5.0.4",
+    "webpack": "^5.88.0",
+    "webpack-cli": "^4.9.1",
+    "webpack-node-externals": "^3.0.0"
+  },
+  "types": "src/index.d.ts"
+}

package/@ones-editor/server-tools/src/fake-browser.d.ts

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

package/@ones-editor/server-tools/src/from-markdown/index.d.ts

@@ -0,0 +1 @@
+export declare function docFromMarkdownFile(mdPath: string): Promise<import("../utils/editor-doc").EditorDoc>;

package/@ones-editor/server-tools/src/index.d.ts

@@ -0,0 +1,2 @@
+import './fake-browser';
+import './tools';

package/@ones-editor/server-tools/src/to-markdown/blocks/code.d.ts

@@ -0,0 +1,3 @@
+import { DocBlock, DocObject } from '../../../../../@ones-editor/core';
+import { Converters } from '../types';
+export default function toMarkdown(converters: Converters, block: DocBlock, doc: DocObject): string;

package/@ones-editor/server-tools/src/to-markdown/blocks/index.d.ts

@@ -0,0 +1,12 @@
+import TextConverter from './text';
+import CodeConverter from './code';
+import ListConverter from './list';
+import TableConverter from './table';
+import EmbedConverter from '../embeds';
+export declare function getBlocks(): {
+    text: typeof TextConverter;
+    code: typeof CodeConverter;
+    list: typeof ListConverter;
+    table: typeof TableConverter;
+    embed: typeof EmbedConverter;
+};

package/@ones-editor/server-tools/src/to-markdown/blocks/list.d.ts

@@ -0,0 +1,14 @@
+import { BlockPath, DocBlock, DocBlockText, DocObject } from '../../../../../@ones-editor/core';
+import { Converters } from '../types';
+export type ListBlockType = 'ordered' | 'unordered' | 'checked' | 'unchecked' | 'text-only';
+export interface DocListBlock extends DocBlock {
+    text: DocBlockText;
+    level?: number;
+    start: number;
+    ordered: boolean;
+    groupId: string;
+    checkbox?: 'checked' | 'unchecked';
+    textOnly?: boolean;
+    viewAsMindmap?: boolean;
+}
+export default function toMarkdown(converters: Converters, block: DocBlock, doc: DocObject, path: BlockPath): string;

package/@ones-editor/server-tools/src/to-markdown/blocks/table.d.ts

@@ -0,0 +1,3 @@
+import { DocBlock, DocObject, BlockPath } from '../../../../../@ones-editor/core';
+import { Converters } from '../types';
+export default function toMarkdown(converters: Converters, blockData: DocBlock, doc: DocObject, path: BlockPath): string;

package/@ones-editor/server-tools/src/to-markdown/blocks/text.d.ts

@@ -0,0 +1,4 @@
+import { DocBlock, DocObject } from '../../../../../@ones-editor/core';
+import { Converters } from '../types';
+export declare function textBlockToMarkdown(converters: Converters, blockData: DocBlock, doc: DocObject): string;
+export default function toMarkdown(converters: Converters, block: DocBlock, doc: DocObject): string;

package/@ones-editor/server-tools/src/to-markdown/boxes/br.d.ts

@@ -0,0 +1 @@
+export default function convertToMarkdown(): string;

package/@ones-editor/server-tools/src/to-markdown/boxes/date.d.ts

@@ -0,0 +1,2 @@
+import { DocBox } from '../../../../../@ones-editor/core';
+export default function convertToMarkdown(converters: unknown, boxData: DocBox): string;

package/@ones-editor/server-tools/src/to-markdown/boxes/file.d.ts

@@ -0,0 +1,11 @@
+import { DocBox } from '../../../../../@ones-editor/core';
+interface FileData {
+    src: string;
+    fileName: string;
+    fileSize: number;
+    fileType: string;
+}
+export interface FileBoxData extends DocBox, FileData {
+}
+export default function convertToMarkdown(converters: unknown, boxData: DocBox): string;
+export {};

package/@ones-editor/server-tools/src/to-markdown/boxes/image.d.ts

@@ -0,0 +1,5 @@
+import { DocBox } from '../../../../../@ones-editor/core';
+export interface ImageBoxData extends DocBox {
+    src: string;
+}
+export default function convertToMarkdown(converters: unknown, boxData: DocBox): string;

package/@ones-editor/server-tools/src/to-markdown/boxes/index.d.ts

@@ -0,0 +1,18 @@
+import FileBoxToMarkdown from './file';
+import BrBoxToMarkdown from './br';
+import MathjaxBoxToMarkdown from './mathjax';
+import MentionBoxToMarkdown from './mention';
+import TaskLinkBoxToMarkdown from './task-link';
+import KnownLinkBoxToMarkdown from './known-link';
+import DateBoxToMarkdown from './date';
+import ImageBoxToMarkdown from './image';
+export declare function getBoxes(): {
+    br: typeof BrBoxToMarkdown;
+    file: typeof FileBoxToMarkdown;
+    math: typeof MathjaxBoxToMarkdown;
+    mention: typeof MentionBoxToMarkdown;
+    date: typeof DateBoxToMarkdown;
+    'task-link': typeof TaskLinkBoxToMarkdown;
+    'known-link': typeof KnownLinkBoxToMarkdown;
+    image: typeof ImageBoxToMarkdown;
+};

package/@ones-editor/server-tools/src/to-markdown/boxes/known-link.d.ts

@@ -0,0 +1,11 @@
+import type { DocBox } from '../../../../../@ones-editor/core';
+export interface KnownLinkBoxData extends DocBox {
+    linkType: 'wiki' | 'task';
+}
+export interface KnownWikiLinkBoxData extends KnownLinkBoxData {
+    linkType: 'wiki';
+    spaceUuid: string;
+    pageUuid: string;
+    query?: Record<string, string>;
+}
+export default function convertToMarkdown(converters: unknown, boxData: DocBox): string;

package/@ones-editor/server-tools/src/to-markdown/boxes/mathjax.d.ts

@@ -0,0 +1,2 @@
+import { DocBox } from '../../../../../@ones-editor/core';
+export default function convertToMarkdown(converters: unknown, boxData: DocBox): string;

package/@ones-editor/server-tools/src/to-markdown/boxes/mention.d.ts

@@ -0,0 +1,7 @@
+import { DocBox } from '../../../../../@ones-editor/core';
+export interface MentionBoxData extends DocBox {
+    iconUrl: string;
+    text: string;
+    mentionId: string;
+}
+export default function convertToMarkdown(converters: unknown, boxData: DocBox): string;

package/@ones-editor/server-tools/src/to-markdown/boxes/task-link.d.ts

@@ -0,0 +1,2 @@
+import { DocBox } from '../../../../../@ones-editor/core';
+export default function convertToMarkdown(converters: unknown, boxData: DocBox): string;

package/@ones-editor/server-tools/src/to-markdown/convert-block.d.ts

@@ -0,0 +1,3 @@
+import { BlockPath, DocBlock, DocObject } from '../../../../@ones-editor/core';
+import { Converters } from './types';
+export declare function convertBlock(converters: Converters, blockData: DocBlock, doc: DocObject, path: BlockPath): string;

package/@ones-editor/server-tools/src/to-markdown/convert-box.d.ts

@@ -0,0 +1,3 @@
+import { DocBox, DocObject } from '../../../../@ones-editor/core';
+import { Converters } from './types';
+export declare function convertBox(converters: Converters, boxData: DocBox, doc: DocObject): string;

package/@ones-editor/server-tools/src/to-markdown/embeds/drawio.d.ts

@@ -0,0 +1,2 @@
+import { DocEmbedBlock } from '../../../../../@ones-editor/core';
+export default function convertToMarkdown(converters: unknown, blockData: DocEmbedBlock): string;

package/@ones-editor/server-tools/src/to-markdown/embeds/file-list.d.ts

@@ -0,0 +1,5 @@
+import { DocEmbedBlock } from '../../../../../@ones-editor/core';
+export interface FileListEmbedData {
+    cardUuid: string;
+}
+export default function convertToMarkdown(converters: unknown, blockData: DocEmbedBlock): string;

package/@ones-editor/server-tools/src/to-markdown/embeds/file.d.ts

@@ -0,0 +1,2 @@
+import { DocEmbedBlock } from '../../../../../@ones-editor/core';
+export default function convertToMarkdown(converters: unknown, blockData: DocEmbedBlock): string;

package/@ones-editor/server-tools/src/to-markdown/embeds/flowchart.d.ts

@@ -0,0 +1,2 @@
+import { DocEmbedBlock } from '../../../../../@ones-editor/core';
+export default function convertToMarkdown(converters: unknown, blockData: DocEmbedBlock): string;

package/@ones-editor/server-tools/src/to-markdown/embeds/hr.d.ts

@@ -0,0 +1 @@
+export default function toMarkdown(): string;

package/@ones-editor/server-tools/src/to-markdown/embeds/image.d.ts

@@ -0,0 +1,18 @@
+import { DocEmbedBlock, DocEmbedData, DocObject } from '../../../../../@ones-editor/core';
+import { Converters } from '../types';
+export interface ImageEmbedData extends DocEmbedData {
+    src: string | string[];
+    widthPercent?: number;
+    [index: string]: string | number | string[] | undefined | number[];
+}
+export interface ImageItemData {
+    src: string;
+    width: number | 'auto';
+    height: number | 'auto';
+    flex: number;
+    virtualSize: boolean;
+    downloading?: boolean;
+}
+export declare function getImages(data: ImageEmbedData): ImageItemData[];
+export declare function toImageEmbedData(images: ImageItemData[], widthPercent?: number): ImageEmbedData;
+export default function toMarkdown(converters: Converters, blockData: DocEmbedBlock, doc: DocObject): string;

package/@ones-editor/server-tools/src/to-markdown/embeds/index.d.ts

@@ -0,0 +1,3 @@
+import { DocBlock, DocObject } from '../../../../../@ones-editor/core';
+import { Converters } from '../types';
+export default function toMarkdown(converters: Converters, block: DocBlock, doc: DocObject): string;

package/@ones-editor/server-tools/src/to-markdown/embeds/mathjax.d.ts

@@ -0,0 +1,2 @@
+import { DocEmbedBlock } from '../../../../../@ones-editor/core';
+export default function convertToMarkdown(converters: unknown, blockData: DocEmbedBlock): string;

package/@ones-editor/server-tools/src/to-markdown/embeds/media.d.ts

@@ -0,0 +1,2 @@
+import { DocEmbedBlock } from '../../../../../@ones-editor/core';
+export default function convertToMarkdown(converters: unknown, blockData: DocEmbedBlock): string;

package/@ones-editor/server-tools/src/to-markdown/embeds/mermaid.d.ts

@@ -0,0 +1,2 @@
+import { DocEmbedBlock } from '../../../../../@ones-editor/core';
+export default function convertToMarkdown(converters: unknown, blockData: DocEmbedBlock): string;

package/@ones-editor/server-tools/src/to-markdown/embeds/plantuml.d.ts

@@ -0,0 +1,2 @@
+import { DocEmbedBlock } from '../../../../../@ones-editor/core';
+export default function convertToMarkdown(converters: unknown, blockData: DocEmbedBlock): string;

package/@ones-editor/server-tools/src/to-markdown/embeds/plugin.d.ts

@@ -0,0 +1,2 @@
+import { DocEmbedBlock } from '../../../../../@ones-editor/core';
+export default function convertToMarkdown(converters: unknown, blockData: DocEmbedBlock): string;

package/@ones-editor/server-tools/src/to-markdown/embeds/sub-pages.d.ts

@@ -0,0 +1,2 @@
+import { DocEmbedBlock } from '../../../../../@ones-editor/core';
+export default function convertToMarkdown(converters: unknown, blockData: DocEmbedBlock): string;

package/@ones-editor/server-tools/src/to-markdown/embeds/task-list.d.ts

@@ -0,0 +1,7 @@
+import { DocEmbedBlock } from '../../../../../@ones-editor/core';
+export interface TaskListNextEmbedData {
+    title?: string;
+    cardUuid?: string;
+    height?: number;
+}
+export default function convertToMarkdown(converters: unknown, blockData: DocEmbedBlock): string;

package/@ones-editor/server-tools/src/to-markdown/embeds/toc.d.ts

@@ -0,0 +1,2 @@
+import { DocEmbedBlock } from '../../../../../@ones-editor/core';
+export default function convertToMarkdown(converters: unknown, blockData: DocEmbedBlock): string;

package/@ones-editor/server-tools/src/to-markdown/embeds/webpage.d.ts

@@ -0,0 +1,5 @@
+import { DocEmbedBlock, DocEmbedData } from '../../../../../@ones-editor/core';
+export interface WebPageEmbedData extends DocEmbedData {
+    src: string;
+}
+export default function convertToMarkdown(converters: unknown, blockData: DocEmbedBlock): string;

package/@ones-editor/server-tools/src/to-markdown/embeds/xmind.d.ts

@@ -0,0 +1,8 @@
+import { DocEmbedBlock } from '../../../../../@ones-editor/core';
+export interface XmindEmbedData {
+    thumbnail: string;
+    xmindFile: string;
+    draftId?: string;
+    height?: number;
+}
+export default function convertToMarkdown(converters: unknown, blockData: DocEmbedBlock): string;

package/@ones-editor/server-tools/src/to-markdown/index.d.ts

@@ -0,0 +1 @@
+export declare function docFileToMarkdown(path: string): Promise<string>;

package/@ones-editor/server-tools/src/to-markdown/types.d.ts

@@ -0,0 +1,7 @@
+import { BlockPath, DocBlock, DocBox, DocObject } from '../../../../@ones-editor/core';
+export type BlockConverter = (converters: Converters, blockData: DocBlock, doc: DocObject, path: BlockPath) => string;
+export type BoxConverter = (converters: Converters, boxData: DocBox, doc: DocObject) => string;
+export interface Converters {
+    blocks: Map<string, BlockConverter>;
+    boxes: Map<string, BoxConverter>;
+}

package/@ones-editor/server-tools/src/tools.d.ts

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

package/@ones-editor/server-tools/src/utils/editor-doc.d.ts

@@ -0,0 +1,22 @@
+import { DocBlock, DocComment, DocObject } from '../../../../@ones-editor/core';
+export type BlocksType = DocBlock[];
+export type CommentsType = {
+    [index: string]: DocComment;
+};
+export type MetaType = {
+    [index: string]: unknown;
+};
+export type AllBlocksType = {
+    [index: string]: BlocksType;
+};
+export type EditorDocBase = {
+    blocks: BlocksType;
+    comments: CommentsType;
+    meta: MetaType;
+};
+export type EditorDoc = EditorDocBase & {
+    [index: string]: BlocksType | unknown;
+};
+export declare function isValidEditorDoc(json: any): boolean;
+export declare function editorDoc2DocObject(doc: EditorDoc): DocObject;
+export declare function docObject2EditorDoc(doc: DocObject): EditorDoc;

package/@ones-editor/server-tools/src/utils/is-binary.d.ts

@@ -0,0 +1,14 @@
+/// <reference types="node" />
+export interface EncodingOpts {
+    /** Defaults to 24 */
+    chunkLength?: number;
+    /** If not provided, will check the start, beginning, and end */
+    chunkBegin?: number;
+}
+/**
+ * Get the encoding of a buffer.
+ * Checks the start, middle, and end of the buffer for characters that are unrecognized within UTF8 encoding.
+ * History has shown that inspection at all three locations is necessary.
+ * @returns Will be `null` if `buffer` was not provided. Otherwise will be either `'utf8'` or `'binary'`
+ */
+export declare function getEncoding(buffer: Buffer | null, opts?: EncodingOpts): 'utf8' | 'binary' | null;

package/@ones-editor/server-tools/src/utils/object.d.ts

@@ -0,0 +1 @@
+export declare function objectToBase64(obj: Record<string, unknown>): string;