@moraya/core 0.1.0

package/dist/types.d.ts

@@ -0,0 +1,107 @@
+/**
+ * Dependency-injection interfaces for `@moraya/core`.
+ *
+ * These 4 interfaces are the **only** boundary between the core package
+ * (host-agnostic, pure ESM) and the consumer environment (Tauri / browser /
+ * mobile WebView). All Tauri / DOM-specific APIs that previously lived inside
+ * the editor source are now accessed through these injected implementations.
+ *
+ * See iteration spec: `moraya/docs/iterations/v0.60.0-pre-shared-markdown-core.md` §3.3.
+ */
+/**
+ * Loads local / remote media as a URL usable in `img.src` / `video.src` / etc.
+ * Typically returns blob: URLs for local files (cached by the implementation).
+ */
+interface MediaResolver {
+    /** Read a local image file by absolute path; return a blob: URL (implementation caches internally). */
+    loadLocalImage(absolutePath: string): Promise<string>;
+    /** Read a local audio/video file by absolute path; return a blob: URL. */
+    loadLocalMedia(absolutePath: string): Promise<string>;
+    /**
+     * Fetch a remote media URL.
+     * Browser implementations may return the original URL directly.
+     * Tauri implementations proxy through plugin-http to bypass WKWebView mixed-content.
+     */
+    loadRemoteMedia(url: string): Promise<string>;
+}
+/** Opens an external link (browser = `window.open`; Tauri = plugin-opener; mobile = bridge). */
+interface LinkOpener {
+    open(url: string): void;
+}
+/**
+ * Custom code-block renderer plugin (WaveDrom / D2 / Excalidraw, etc.).
+ * Loaded dynamically via {@link RendererRegistry}.
+ */
+interface RendererPluginModule {
+    /**
+     * Render `source` into `container` (async supported).
+     * The caller guarantees `container` is already mounted in the DOM.
+     * The implementation must clear any old content of `container` before rendering.
+     *
+     * Error propagation: if this method throws or rejects, the core captures the error
+     * inside the NodeView (no rethrow) and inserts a fallback DOM:
+     *   `<div class="renderer-error" data-language="${lang}" data-error="${msg}">[Renderer ${lang} failed]</div>`
+     * Roundtrip preservation: the serializer reads the original fenced source from
+     * `node.attrs.source` (NOT from the fallback DOM), so the fenced code block
+     * round-trips byte-stably even if rendering fails.
+     */
+    render(source: string, container: HTMLElement, options?: {
+        theme?: string;
+        baseUrl?: string;
+    }): void | Promise<void>;
+    /**
+     * Destroy the rendered content within `container` (optional).
+     * Called from NodeView.destroy() to free canvas / SVG / event listeners.
+     *
+     * Error propagation: if this method throws, the core catches and `console.warn`s
+     * (does not report to Sentry, does not rethrow). This is a cleanup path; throwing
+     * here would block NodeView destruction and cause memory leaks.
+     */
+    destroy?(container: HTMLElement): void;
+}
+/** Code-block custom renderer registry. Implemented by consumers (Moraya desktop / Web). */
+interface RendererRegistry {
+    /** Whether a renderer is registered for the given language identifier. */
+    has(language: string): boolean;
+    /** Asynchronously load the renderer module (consumer handles CDN / local import). */
+    load(language: string): Promise<RendererPluginModule>;
+    /**
+     * Snapshot of currently registered renderer versions (language → version string).
+     * Used by code-block-view to invalidate cached renders when versions change.
+     */
+    readonly versions: Readonly<Record<string, string>>;
+}
+/**
+ * Platform behavior parameters (carries the editor-props-plugin DI from §F2.6).
+ * Desktop injects Tauri / OS truth; Web uses browser detection; mobile bridges fill.
+ */
+interface Platform {
+    /**
+     * Absolute path of the currently open document (used for relative-image-path
+     * resolution). Returns `null` when no document is open.
+     */
+    getCurrentFilePath: () => string | null;
+    /**
+     * Whether the user is on macOS. Affects Option-key handling, Cmd vs Ctrl,
+     * emoji popup behavior, etc.
+     */
+    isMacOS: boolean;
+}
+/** SchemaConfig (re-exported from schema.ts for convenience). */
+interface SchemaConfig {
+    mediaResolver: MediaResolver;
+    rendererRegistry?: RendererRegistry;
+    linkOpener?: LinkOpener;
+}
+/**
+ * Internal symbol-tagged null MediaResolver used by core for parseMarkdown /
+ * serializeMarkdown internal fallback. Consumers must NOT pass this to
+ * createSchema(); doing so throws with a descriptive error.
+ */
+declare const NULL_MEDIA_RESOLVER_SENTINEL: unique symbol;
+interface NullMediaResolver extends MediaResolver {
+    readonly [NULL_MEDIA_RESOLVER_SENTINEL]: true;
+}
+declare function isNullMediaResolver(r: MediaResolver): r is NullMediaResolver;
+
+export { type LinkOpener, type MediaResolver, NULL_MEDIA_RESOLVER_SENTINEL, type NullMediaResolver, type Platform, type RendererPluginModule, type RendererRegistry, type SchemaConfig, isNullMediaResolver };

package/dist/types.js

@@ -0,0 +1,10 @@
+// src/types.ts
+var NULL_MEDIA_RESOLVER_SENTINEL = /* @__PURE__ */ Symbol("@moraya/core:null-media-resolver");
+function isNullMediaResolver(r) {
+  return r[NULL_MEDIA_RESOLVER_SENTINEL] === true;
+}
+export {
+  NULL_MEDIA_RESOLVER_SENTINEL,
+  isNullMediaResolver
+};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/types.ts"],"sourcesContent":["/**\n * Dependency-injection interfaces for `@moraya/core`.\n *\n * These 4 interfaces are the **only** boundary between the core package\n * (host-agnostic, pure ESM) and the consumer environment (Tauri / browser /\n * mobile WebView). All Tauri / DOM-specific APIs that previously lived inside\n * the editor source are now accessed through these injected implementations.\n *\n * See iteration spec: `moraya/docs/iterations/v0.60.0-pre-shared-markdown-core.md` §3.3.\n */\n\n/**\n * Loads local / remote media as a URL usable in `img.src` / `video.src` / etc.\n * Typically returns blob: URLs for local files (cached by the implementation).\n */\nexport interface MediaResolver {\n  /** Read a local image file by absolute path; return a blob: URL (implementation caches internally). */\n  loadLocalImage(absolutePath: string): Promise<string>\n\n  /** Read a local audio/video file by absolute path; return a blob: URL. */\n  loadLocalMedia(absolutePath: string): Promise<string>\n\n  /**\n   * Fetch a remote media URL.\n   * Browser implementations may return the original URL directly.\n   * Tauri implementations proxy through plugin-http to bypass WKWebView mixed-content.\n   */\n  loadRemoteMedia(url: string): Promise<string>\n}\n\n/** Opens an external link (browser = `window.open`; Tauri = plugin-opener; mobile = bridge). */\nexport interface LinkOpener {\n  open(url: string): void\n}\n\n/**\n * Custom code-block renderer plugin (WaveDrom / D2 / Excalidraw, etc.).\n * Loaded dynamically via {@link RendererRegistry}.\n */\nexport interface RendererPluginModule {\n  /**\n   * Render `source` into `container` (async supported).\n   * The caller guarantees `container` is already mounted in the DOM.\n   * The implementation must clear any old content of `container` before rendering.\n   *\n   * Error propagation: if this method throws or rejects, the core captures the error\n   * inside the NodeView (no rethrow) and inserts a fallback DOM:\n   *   `<div class=\"renderer-error\" data-language=\"${lang}\" data-error=\"${msg}\">[Renderer ${lang} failed]</div>`\n   * Roundtrip preservation: the serializer reads the original fenced source from\n   * `node.attrs.source` (NOT from the fallback DOM), so the fenced code block\n   * round-trips byte-stably even if rendering fails.\n   */\n  render(\n    source: string,\n    container: HTMLElement,\n    options?: { theme?: string; baseUrl?: string }\n  ): void | Promise<void>\n\n  /**\n   * Destroy the rendered content within `container` (optional).\n   * Called from NodeView.destroy() to free canvas / SVG / event listeners.\n   *\n   * Error propagation: if this method throws, the core catches and `console.warn`s\n   * (does not report to Sentry, does not rethrow). This is a cleanup path; throwing\n   * here would block NodeView destruction and cause memory leaks.\n   */\n  destroy?(container: HTMLElement): void\n}\n\n/** Code-block custom renderer registry. Implemented by consumers (Moraya desktop / Web). */\nexport interface RendererRegistry {\n  /** Whether a renderer is registered for the given language identifier. */\n  has(language: string): boolean\n\n  /** Asynchronously load the renderer module (consumer handles CDN / local import). */\n  load(language: string): Promise<RendererPluginModule>\n\n  /**\n   * Snapshot of currently registered renderer versions (language → version string).\n   * Used by code-block-view to invalidate cached renders when versions change.\n   */\n  readonly versions: Readonly<Record<string, string>>\n}\n\n/**\n * Platform behavior parameters (carries the editor-props-plugin DI from §F2.6).\n * Desktop injects Tauri / OS truth; Web uses browser detection; mobile bridges fill.\n */\nexport interface Platform {\n  /**\n   * Absolute path of the currently open document (used for relative-image-path\n   * resolution). Returns `null` when no document is open.\n   */\n  getCurrentFilePath: () => string | null\n\n  /**\n   * Whether the user is on macOS. Affects Option-key handling, Cmd vs Ctrl,\n   * emoji popup behavior, etc.\n   */\n  isMacOS: boolean\n}\n\n/** SchemaConfig (re-exported from schema.ts for convenience). */\nexport interface SchemaConfig {\n  mediaResolver: MediaResolver\n  rendererRegistry?: RendererRegistry\n  linkOpener?: LinkOpener\n}\n\n// ===== Internal sentinel for misuse detection (v0.60.0-pre §6.1.1) =====\n\n/**\n * Internal symbol-tagged null MediaResolver used by core for parseMarkdown /\n * serializeMarkdown internal fallback. Consumers must NOT pass this to\n * createSchema(); doing so throws with a descriptive error.\n */\nexport const NULL_MEDIA_RESOLVER_SENTINEL = Symbol('@moraya/core:null-media-resolver')\n\nexport interface NullMediaResolver extends MediaResolver {\n  readonly [NULL_MEDIA_RESOLVER_SENTINEL]: true\n}\n\nexport function isNullMediaResolver(r: MediaResolver): r is NullMediaResolver {\n  return (r as NullMediaResolver)[NULL_MEDIA_RESOLVER_SENTINEL] === true\n}\n"],"mappings":";AAoHO,IAAM,+BAA+B,uBAAO,kCAAkC;AAM9E,SAAS,oBAAoB,GAA0C;AAC5E,SAAQ,EAAwB,4BAA4B,MAAM;AACpE;","names":[]}

package/package.json

@@ -0,0 +1,121 @@
+{
+  "name": "@moraya/core",
+  "version": "0.1.0",
+  "description": "Shared markdown editor core for Moraya desktop and Moraya Web. ProseMirror schema, markdown-it parser, prosemirror-markdown serializer, plugins, and editor lifecycle factories. Pure ESM, host-agnostic, dependency-injected.",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./schema": {
+      "import": "./dist/schema.js",
+      "types": "./dist/schema.d.ts"
+    },
+    "./markdown": {
+      "import": "./dist/markdown.js",
+      "types": "./dist/markdown.d.ts"
+    },
+    "./commands": {
+      "import": "./dist/commands.js",
+      "types": "./dist/commands.d.ts"
+    },
+    "./doc-cache": {
+      "import": "./dist/doc-cache.js",
+      "types": "./dist/doc-cache.d.ts"
+    },
+    "./types": {
+      "import": "./dist/types.js",
+      "types": "./dist/types.d.ts"
+    },
+    "./style": "./dist/style.css",
+    "./plugins/*": {
+      "import": "./dist/plugins/*.js",
+      "types": "./dist/plugins/*.d.ts"
+    },
+    "./adapters/*": {
+      "import": "./dist/adapters/*.js",
+      "types": "./dist/adapters/*.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/zouwei/moraya-core.git"
+  },
+  "license": "PolyForm-Internal-Use-1.0.0",
+  "sideEffects": [
+    "./dist/style.css"
+  ],
+  "peerDependencies": {
+    "highlight.js": "^11.11.0",
+    "katex": "^0.16.28",
+    "markdown-it": "^14.0.0",
+    "markdown-it-deflist": "^3.0.0",
+    "markdown-it-texmath": "^1.0.0",
+    "mermaid": "^11.0.0",
+    "node-emoji": "^2.0.0",
+    "prosemirror-commands": "^1.7.0",
+    "prosemirror-dropcursor": "^1.8.0",
+    "prosemirror-history": "^1.5.0",
+    "prosemirror-inputrules": "^1.5.0",
+    "prosemirror-keymap": "^1.2.0",
+    "prosemirror-markdown": "^1.13.0",
+    "prosemirror-model": "^1.20.0",
+    "prosemirror-schema-list": "^1.5.0",
+    "prosemirror-state": "^1.4.0",
+    "prosemirror-tables": "^1.8.0",
+    "prosemirror-view": "^1.33.0"
+  },
+  "peerDependenciesMeta": {
+    "mermaid": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@types/markdown-it": "^14.1.2",
+    "@types/node": "^20.0.0",
+    "happy-dom": "^20.9.0",
+    "highlight.js": "^11.11.1",
+    "katex": "^0.16.28",
+    "markdown-it": "^14.1.1",
+    "markdown-it-deflist": "^3.0.0",
+    "markdown-it-texmath": "^1.0.0",
+    "node-emoji": "^2.2.0",
+    "prosemirror-commands": "^1.7.1",
+    "prosemirror-dropcursor": "^1.8.2",
+    "prosemirror-history": "^1.5.0",
+    "prosemirror-inputrules": "^1.5.1",
+    "prosemirror-keymap": "^1.2.3",
+    "prosemirror-markdown": "^1.13.4",
+    "prosemirror-model": "^1.25.4",
+    "prosemirror-schema-list": "^1.5.1",
+    "prosemirror-state": "^1.4.4",
+    "prosemirror-tables": "^1.8.5",
+    "prosemirror-view": "^1.41.6",
+    "tsup": "^8.3.0",
+    "typescript": "~5.6.2",
+    "vitest": "^2.1.0"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "eslint src --ext .ts"
+  }
+}