autumnnote 2.4.0 → 2.5.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "autumnnote",
-  "version": "2.4.0",
-  "description": "WYSIWYG rich-text editor built with vanilla JavaScript — zero dependencies, no jQuery. Dark mode, @mention, markdown shortcuts, bubble toolbar. React and Vue 3 wrappers included.",
+  "version": "2.5.0",
+  "description": "WYSIWYG rich-text editor built with vanilla JavaScript \u2014 zero dependencies, no jQuery. Dark mode, @mention, markdown shortcuts, bubble toolbar. React and Vue\u00a03 wrappers included.",
   "type": "module",
   "main": "dist/autumnnote.cjs",
   "module": "dist/autumnnote.es.js",
@@ -17,12 +17,17 @@
       "types": "./types/i18n/*.d.ts",
       "import": "./src/js/i18n/*.js"
     },
-    "./dist/autumnnote.css": "./dist/autumnnote.css"
+    "./dist/autumnnote.css": "./dist/autumnnote.css",
+    "./core": {
+      "types": "./types/core-entry.d.ts",
+      "import": "./dist/autumnnote.core.es.js"
+    }
   },
   "sideEffects": [
     "*.css",
     "*.scss",
     "./src/js/index.js",
+    "./src/js/core.js",
     "./src/js/index.umd.js",
     "./src/js/i18n/all.js"
   ],
@@ -34,7 +39,7 @@
   ],
   "scripts": {
     "dev": "vite",
-    "build": "vite build && vite build --config vite.umd.config.js && vite build --config vite.cdn.config.js && node scripts/create-cjs-alias.mjs",
+    "build": "vite build && vite build --config vite.umd.config.js && vite build --config vite.cdn.config.js && vite build --config vite.core.config.js && node scripts/create-cjs-alias.mjs",
     "build:demo": "vite build --config vite.demo.config.js",
     "preview": "vite preview",
     "prepublishOnly": "npm run build",
@@ -51,7 +56,8 @@
     "build:wrappers": "pnpm --filter autumnnote-react build && pnpm --filter autumnnote-vue build",
     "check:bundle": "node scripts/check-bundle-size.mjs",
     "check:package": "node scripts/check-package-files.mjs",
-    "check": "pnpm lint && pnpm typecheck && pnpm test:coverage && pnpm build && pnpm test:wrappers && pnpm check:bundle && pnpm check:package && pnpm build:demo && pnpm build:wrappers"
+    "check": "pnpm lint && pnpm typecheck && pnpm test:coverage && pnpm build && pnpm test:wrappers && pnpm check:bundle && pnpm check:package && pnpm build:demo && pnpm build:wrappers",
+    "build:core": "vite build --config vite.core.config.js"
   },
   "keywords": [
     "wysiwyg",

package/types/core/detectLang.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Heuristic programming-language detection for code snippets.
+ *
+ * Every rule that matches adds weight to its language and the highest total
+ * wins; the winner must also clear a minimum score and beat the runner-up by a
+ * margin. A snippet that could be two things returns null rather than being
+ * guessed at, and prose is never reported as code.
+ */
+
+/** Every language `detectLang()` can return, as Prism language ids. */
+export declare const SUPPORTED_LANGS: readonly string[];
+
+/**
+ * Detects the language of a code snippet.
+ *
+ * Only the first few kilobytes are examined — a language is identifiable from
+ * its opening lines, and bounding the input keeps the cost independent of file
+ * size.
+ *
+ * @param code Snippet to inspect.
+ * @returns A Prism language id from {@link SUPPORTED_LANGS}, or null when the
+ *   evidence is too weak or too evenly split to commit to an answer.
+ */
+export declare function detectLang(code: string | null | undefined): string | null;

package/types/core/markdown.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Bidirectional HTML ↔ Markdown conversion.
+ *
+ * Exposed on the package entry point so the conversion can run without an
+ * editor instance — a server, a build step, or a test — since the editor's
+ * `getMarkdown()` / `setMarkdown()` need a live DOM.
+ *
+ * `markdownToHTML()` output is NOT sanitised. Anything that will be inserted
+ * into a document must be passed through `sanitiseHTML()` first.
+ */
+
+/**
+ * Converts a Markdown string to HTML.
+ *
+ * Handles ATX and setext headings, fenced code (backtick and tilde, any fence
+ * length, indented) and four-space indented code, blockquotes, ordered and
+ * unordered lists including task lists and code blocks nested in items, GFM
+ * tables with or without outer pipes and with column alignment, links and
+ * images with titles, reference links, footnotes, autolinks, character
+ * references, YAML frontmatter, and a leading UTF-8 byte-order mark.
+ *
+ * @param text Markdown source. A leading BOM is stripped; CRLF is normalised.
+ * @returns HTML. Pass through `sanitiseHTML()` before inserting it anywhere.
+ */
+export declare function markdownToHTML(text: string | null | undefined): string;
+
+/**
+ * Converts an HTML string to Markdown.
+ *
+ * Markdown syntax appearing in ordinary prose is backslash-escaped, so text
+ * round-trips as text rather than being re-read as formatting. Code spans and
+ * code blocks are emitted literally, with line breaks read from `<br>` as well
+ * as newlines — which is how `contenteditable` stores them.
+ *
+ * @param html HTML source.
+ * @returns Markdown.
+ */
+export declare function htmlToMarkdown(html: string | null | undefined): string;
+
+/**
+ * Reports whether a string looks like Markdown.
+ *
+ * Used to decide whether pasted plain text should be converted. Deliberately
+ * conservative: a bare URL or a parenthetical aside is prose, and a link alone
+ * is too weak a signal without a second marker.
+ *
+ * @param rawText Text to inspect. A leading BOM is ignored.
+ */
+export declare function isMarkdown(rawText: string | null | undefined): boolean;

package/types/core-entry.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Type surface for `autumnnote/core`.
+ *
+ * Identical to the default entry: the difference is which modules are
+ * installed, not which API exists. Toolbar buttons whose module is absent still
+ * render, and invoking one logs a warning and does nothing.
+ */
+export * from './index.js';
+export { default } from './index.js';

package/types/index.d.ts

@@ -105,9 +105,37 @@ export interface AsnOptions {
   /** Callback fired when the word limit is reached. */
   onWordLimitReached?: (context: Context) => void;
   /** Custom image upload handler. */
-  onImageUpload?: (files: File[]) => void;
+  /**
+   * Handles files dropped, pasted, or picked in the image dialog.
+   *
+   * Return the uploaded URL — or a promise of it — and the editor inserts a
+   * dimmed placeholder previewing the local file straight away, then swaps in
+   * the real URL when the promise settles. A rejection marks the placeholder
+   * failed and fires `imageError` with a `retry()` for that file.
+   *
+   * Returning `undefined` keeps the original contract: nothing is inserted and
+   * the handler is responsible for placing the image itself.
+   *
+   * Distinct from `imageProcessor`, which transforms a file and must resolve to
+   * a **data URL**; this one uploads and resolves to any URL the sanitiser
+   * accepts.
+   */
+  onImageUpload?: (
+    files: File[],
+    helpers: {
+      context: Context;
+      /** Reports progress for one file as a 0–1 ratio, for the placeholder's bar. */
+      setProgress: (file: File, ratio: number) => void;
+    },
+  ) => void | string | string[] | Promise<void | string | string[]>;
   /** Callback when an image upload error occurs. */
-  onImageError?: (error: { file?: File; message: string; error?: unknown }) => void;
+  onImageError?: (error: {
+    file?: File;
+    message: string;
+    error?: unknown;
+    /** Present when an upload failed: re-runs the handler for that one file. */
+    retry?: () => void;
+  }) => void;
   /** Stick the toolbar to the viewport top when scrolling. */
   stickyToolbar?: boolean;
   /** Top offset in px for sticky toolbar (e.g. height of a fixed nav bar). */
@@ -446,6 +474,8 @@ export * from './core/key.js';
 export * from './core/lists.js';
 export * from './core/env.js';
 export * from './core/sanitise.js';
+export * from './core/markdown.js';
+export * from './core/detectLang.js';
 
 // ---------------------------------------------------------------------------
 // Context — per-instance editor hub