@lapismd/mira-editor 0.0.1

package/dist/toolbar-model.test.js

@@ -0,0 +1,46 @@
+import { describe, expect, it } from "vitest";
+import { isMiraEditMode, markdownActionForMiraToolbarItem, miraEditorToolbarItemLabels, miraViewToggleLabel, resolveMiraModeAfterSplit, resolveMiraViewModeMenuItems, resolveMiraViewToggleMode, templateForMiraToolbarItem, } from "./toolbar-model";
+describe("toolbar model", () => {
+    it("resolves view menu items for edit and preview modes", () => {
+        expect(resolveMiraViewModeMenuItems({
+            mode: "live-preview",
+            modeOptions: ["source", "live-preview", "preview", "split"],
+            resolvedDefaultEditMode: "live-preview",
+        })).toEqual([
+            { mode: "preview", label: "Reading view", checked: false },
+            { mode: "source", label: "Source mode", checked: false },
+        ]);
+        expect(resolveMiraViewModeMenuItems({
+            mode: "preview",
+            modeOptions: ["source", "live-preview", "preview", "split"],
+            resolvedDefaultEditMode: "live-preview",
+        })).toEqual([
+            { mode: "live-preview", label: "Live edit", checked: false },
+            { mode: "source", label: "Source mode", checked: false },
+        ]);
+    });
+    it("resolves split fallback and view toggle behavior", () => {
+        expect(resolveMiraModeAfterSplit({
+            lastNonSplitMode: "source",
+            modeOptions: ["source", "live-preview", "preview", "split"],
+            resolvedDefaultEditMode: "live-preview",
+        })).toBe("source");
+        expect(resolveMiraViewToggleMode("preview", "live-preview")).toBe("live-preview");
+        expect(resolveMiraViewToggleMode("live-preview", "live-preview")).toBe("preview");
+        expect(miraViewToggleLabel("preview")).toBe("Edit");
+    });
+    it("exposes labels and templates for framework renderers", () => {
+        expect(isMiraEditMode("source")).toBe(true);
+        expect(miraEditorToolbarItemLabels.bold).toBe("Bold");
+        expect(miraEditorToolbarItemLabels.strikethrough).toBe("Strikethrough");
+        expect(miraEditorToolbarItemLabels.inlineCode).toBe("Inline code");
+        expect(miraEditorToolbarItemLabels.numberedList).toBe("Numbered list");
+        expect(templateForMiraToolbarItem("bold")).toBe("**strong**");
+        expect(templateForMiraToolbarItem("strikethrough")).toBe("~~strikethrough~~");
+        expect(templateForMiraToolbarItem("inlineCode")).toBe("`code`");
+        expect(templateForMiraToolbarItem("numberedList")).toBe("1. List item");
+        expect(markdownActionForMiraToolbarItem("bold")).toBe("bold");
+        expect(markdownActionForMiraToolbarItem("code")).toBeNull();
+        expect(templateForMiraToolbarItem("gridTable")).toContain("+========+");
+    });
+});

package/dist/types.d.ts

@@ -0,0 +1,88 @@
+import type { MiraEditorSelection, MiraMarkdownActionId } from "@lapismd/mira/core";
+import type { MiraAssetResolver, MiraCommand, MiraExtension, MiraFileAdapter, MiraImageConfig, MiraLinkResolver, MiraMarkdownAuthoringConfig, MiraMode, MiraColorMode, MiraTheme, MiraTemplateSelection } from "@lapismd/mira/extensions";
+import type { MiraEditorFeatureConfigs, MiraEditorToolbarAction, MiraEditorToolbarActionContext, MiraEditorToolbarDefinition, MiraEditorEditMode, MiraFeatureFlags } from "./features";
+import type { MiraFrontmatterConfig, MiraOutlineVariant } from "@lapismd/mira";
+export type { MiraEditorEditMode } from "./features";
+export type { MiraFrontmatterConfig, MiraOutlineVariant } from "@lapismd/mira";
+export type MiraEditorProps = {
+    value?: string;
+    mode?: MiraMode;
+    defaultEditMode?: MiraEditorEditMode;
+    readonly?: boolean;
+    placeholder?: string;
+    lineWrapping?: boolean;
+    spellcheck?: boolean;
+    indentGuides?: boolean;
+    indentWithTabs?: boolean;
+    indentWidth?: number;
+    theme?: MiraTheme;
+    colorMode?: MiraColorMode;
+    sourcePath?: string;
+    class?: string;
+    editorClass?: string;
+    features?: MiraFeatureFlags;
+    featureConfigs?: MiraEditorFeatureConfigs;
+    toolbarActions?: MiraEditorToolbarAction[];
+    toolbars?: MiraEditorToolbarDefinition[];
+    extensions?: MiraExtension[];
+    linkResolver?: MiraLinkResolver;
+    assetResolver?: MiraAssetResolver;
+    fileAdapter?: MiraFileAdapter;
+    imageConfig?: MiraImageConfig;
+    authoring?: MiraMarkdownAuthoringConfig;
+    frontmatterOpen?: boolean;
+    frontmatterConfig?: MiraFrontmatterConfig;
+    headingIds?: boolean;
+    headingIdPrefix?: string;
+    htmlPolicy?: "trusted" | "safe";
+    emoji?: boolean;
+    outline?: boolean;
+    outlineVariant?: MiraOutlineVariant;
+    onChange?: (value: string) => void;
+    onModeChange?: (mode: MiraMode) => void;
+    onReadonlyChange?: (readonly: boolean) => void;
+    onIndentGuidesChange?: (enabled: boolean) => void;
+    onIndentWidthChange?: (width: number) => void;
+    onIndentWithTabsChange?: (enabled: boolean) => void;
+    onFrontmatterChange?: (nextYaml: string, nextValue: string) => void;
+};
+export type MiraEditorToolbarProps = {
+    value?: string;
+    mode?: MiraMode;
+    defaultEditMode?: MiraEditorEditMode;
+    readonly?: boolean;
+    class?: string;
+    features?: MiraFeatureFlags;
+    featureConfigs?: MiraEditorFeatureConfigs;
+    toolbarActions?: MiraEditorToolbarAction[];
+    toolbars?: MiraEditorToolbarDefinition[];
+    modeOptions?: MiraMode[];
+    showModeSwitch?: boolean;
+    indentGuides?: boolean;
+    indentWithTabs?: boolean;
+    indentWidth?: number;
+    context?: MiraEditorToolbarActionContext;
+    onModeChange?: (mode: MiraMode) => void;
+    onInsertMarkdown?: (markdown: string) => void;
+    onInsertImage?: () => void;
+    onIndentGuidesChange?: (enabled: boolean) => void;
+    onIndentWidthChange?: (width: number) => void;
+    onIndentWithTabsChange?: (enabled: boolean) => void;
+};
+export type MiraEditorHandle = {
+    applyMarkdownAction: (action: MiraMarkdownActionId) => boolean;
+    executeCommand: (commandId: string) => boolean;
+    focus: () => void;
+    getCommands: () => readonly MiraCommand[];
+    getMarkdown: () => string;
+    getMode: () => MiraMode;
+    getSelection: () => MiraEditorSelection | null;
+    insertImage: () => void;
+    insertMarkdown: (markdown: string, selection?: MiraTemplateSelection) => void;
+    isCommandEnabled: (commandId: string) => boolean;
+    setMarkdown: (markdown: string) => void;
+    setMode: (mode: MiraMode) => void;
+    setReadonly: (readonly: boolean) => void;
+    setSelection: (selection: MiraEditorSelection) => void;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mBAAmB,EACnB,oBAAoB,EACrB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EACV,iBAAiB,EACjB,WAAW,EACX,aAAa,EACb,eAAe,EACf,eAAe,EACf,gBAAgB,EAChB,2BAA2B,EAC3B,QAAQ,EACR,aAAa,EACb,SAAS,EACT,qBAAqB,EACtB,MAAM,0BAA0B,CAAC;AAClC,OAAO,KAAK,EACV,wBAAwB,EACxB,uBAAuB,EACvB,8BAA8B,EAC9B,2BAA2B,EAC3B,kBAAkB,EAClB,gBAAgB,EACjB,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAE/E,YAAY,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AACrD,YAAY,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAE/E,MAAM,MAAM,eAAe,GAAG;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,eAAe,CAAC,EAAE,kBAAkB,CAAC;IACrC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAC5B,cAAc,CAAC,EAAE,wBAAwB,CAAC;IAC1C,cAAc,CAAC,EAAE,uBAAuB,EAAE,CAAC;IAC3C,QAAQ,CAAC,EAAE,2BAA2B,EAAE,CAAC;IACzC,UAAU,CAAC,EAAE,aAAa,EAAE,CAAC;IAC7B,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC,aAAa,CAAC,EAAE,iBAAiB,CAAC;IAClC,WAAW,CAAC,EAAE,eAAe,CAAC;IAC9B,WAAW,CAAC,EAAE,eAAe,CAAC;IAC9B,SAAS,CAAC,EAAE,2BAA2B,CAAC;IACxC,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,iBAAiB,CAAC,EAAE,qBAAqB,CAAC;IAC1C,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,UAAU,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC;IAChC,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,cAAc,CAAC,EAAE,kBAAkB,CAAC;IACpC,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACnC,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,IAAI,CAAC;IACxC,gBAAgB,CAAC,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,IAAI,CAAC;IAC/C,oBAAoB,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;IAClD,mBAAmB,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAC9C,sBAAsB,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;IACpD,mBAAmB,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,KAAK,IAAI,CAAC;CACrE,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,eAAe,CAAC,EAAE,kBAAkB,CAAC;IACrC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAC5B,cAAc,CAAC,EAAE,wBAAwB,CAAC;IAC1C,cAAc,CAAC,EAAE,uBAAuB,EAAE,CAAC;IAC3C,QAAQ,CAAC,EAAE,2BAA2B,EAAE,CAAC;IACzC,WAAW,CAAC,EAAE,QAAQ,EAAE,CAAC;IACzB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,8BAA8B,CAAC;IACzC,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,IAAI,CAAC;IACxC,gBAAgB,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;IAC9C,aAAa,CAAC,EAAE,MAAM,IAAI,CAAC;IAC3B,oBAAoB,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;IAClD,mBAAmB,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAC9C,sBAAsB,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;CACrD,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,mBAAmB,EAAE,CAAC,MAAM,EAAE,oBAAoB,KAAK,OAAO,CAAC;IAC/D,cAAc,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,OAAO,CAAC;IAC/C,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,WAAW,EAAE,MAAM,SAAS,WAAW,EAAE,CAAC;IAC1C,WAAW,EAAE,MAAM,MAAM,CAAC;IAC1B,OAAO,EAAE,MAAM,QAAQ,CAAC;IACxB,YAAY,EAAE,MAAM,mBAAmB,GAAG,IAAI,CAAC;IAC/C,WAAW,EAAE,MAAM,IAAI,CAAC;IACxB,cAAc,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,qBAAqB,KAAK,IAAI,CAAC;IAC9E,gBAAgB,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,OAAO,CAAC;IACjD,WAAW,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;IACxC,OAAO,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,IAAI,CAAC;IAClC,WAAW,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,IAAI,CAAC;IACzC,YAAY,EAAE,CAAC,SAAS,EAAE,mBAAmB,KAAK,IAAI,CAAC;CACxD,CAAC"}

package/dist/types.js

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

package/dist/version.d.ts

@@ -0,0 +1,3 @@
+/** The version of the shipped `@lapismd/mira-editor` package. */
+export declare const MIRA_EDITOR_VERSION = "0.0.1";
+//# sourceMappingURL=version.d.ts.map

package/dist/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAAA,iEAAiE;AACjE,eAAO,MAAM,mBAAmB,UAAU,CAAC"}

package/dist/version.js

@@ -0,0 +1,2 @@
+/** The version of the shipped `@lapismd/mira-editor` package. */
+export const MIRA_EDITOR_VERSION = "0.0.1";

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@lapismd/mira-editor",
+  "version": "0.0.1",
+  "description": "Batteries-included Svelte Markdown editor, toolbar, features, and default styling for Mira.",
+  "author": "Steve Juma <help@lapis.md>",
+  "license": "AGPL-3.0-or-later",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lapismd/mira-mde.git",
+    "directory": "packages/mira-editor"
+  },
+  "type": "module",
+  "sideEffects": [
+    "*.css"
+  ],
+  "svelte": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "CHANGELOG.md",
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "svelte": "./dist/index.js",
+      "import": "./dist/index.js"
+    },
+    "./styles.css": "./dist/styles.css"
+  },
+  "dependencies": {
+    "@lucide/svelte": "^0.525.0",
+    "@lapismd/mira": "~0.0.1",
+    "@lapismd/mira-plugin-mermaid": "~0.0.1"
+  },
+  "peerDependencies": {
+    "svelte": "^5.0.0"
+  },
+  "devDependencies": {
+    "@sveltejs/vite-plugin-svelte": "^6.2.1",
+    "svelte": "^5.46.1",
+    "vitest": "^4.1.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "scripts": {
+    "build": "svelte-package --input src --output dist && publint",
+    "check": "pnpm check:format && pnpm check:svelte && pnpm check:types",
+    "check:format": "prettier --ignore-path ../../.prettierignore . --check",
+    "check:types": "tsc -p tsconfig.json --noEmit",
+    "check:svelte": "svelte-check --tsconfig tsconfig.json --fail-on-warnings",
+    "lint": "eslint src --ext .ts",
+    "test": "vitest run"
+  }
+}