Initial release

Author: cyanzhong

README.md

@@ -16,7 +16,7 @@ Add `markedit-api` to your (TypeScript) project's devDependencies:
 ```json
 {
   "devDependencies": {
-    "markedit-api": "https://github.com/MarkEdit-app/MarkEdit-api#v0.0.8"
+    "markedit-api": "https://github.com/MarkEdit-app/MarkEdit-api#v0.1.0"
   }
 }
 ```
@@ -60,7 +60,7 @@ MarkEdit.addExtension(extension); // Can also add an array of extensions
 
 ## Building
 
-In your build configuration, mark used CodeMirror (and Lezer) dependencies as `external`.
+In your build configuration, mark used MarkEdit and CodeMirror dependencies as `external`.
 
 Here is an example of [vite](https://vitejs.dev/) config:
 
@@ -71,6 +71,7 @@ export default defineConfig({
   build: {
     rollupOptions: {
       external: [
+        'markedit-api',
         '@codemirror/view',
         '@codemirror/state',
         // ...
@@ -89,11 +90,13 @@ It is recommended to build as [cjs](https://commonjs.org/), building as [umd](ht
 ```
 rollupOptions: {
   external: [
+    'markedit-api',
     '@codemirror/view',
     '@codemirror/state',
   ],
   output: {
     globals: {
+      'markedit-api': 'MarkEdit',
       '@codemirror/view': 'MarkEdit.codemirror.view',
       '@codemirror/state': 'MarkEdit.codemirror.state',
     },

main.ts

@@ -0,0 +1 @@
+export const MarkEdit = {};

markedit.d.ts

@@ -9,119 +9,131 @@ import type * as lezerCommon from '@lezer/common';
 import type * as lezerHighlight from '@lezer/highlight';
 import type * as lezerLr from '@lezer/lr';
 
-declare global {
-  const MarkEdit: {
+export const MarkEdit: MarkEdit;
+
+export interface MarkEdit {
+  /**
+   * CodeMirror EditorView instance of the current editor.
+   */
+  editorView: EditorView;
+
+  /**
+   * Convenient text editing interfaces.
+   */
+  editorAPI: TextEditable;
+
+  /**
+   * CodeMirror modules used by MarkEdit.
+   */
+  codemirror: {
     /**
-     * CodeMirror EditorView instance of the current editor.
+     * The `@codemirror/view` module.
      */
-    editorView: EditorView;
+    view: typeof cmView;
 
     /**
-     * Convenient text editing interfaces.
+     * The `@codemirror/state` module.
      */
-    editorAPI: TextEditable;
+    state: typeof cmState;
 
     /**
-     * Add an extension to MarkEdit.
-     * @param extension CodeMirror extension.
+     * The `@codemirror/language` module.
      */
-    addExtension: (extension: Extension) => void;
+    language: typeof cmLanguage;
+  };
 
+  /**
+   * Lezer modules used by MarkEdit.
+   */
+  lezer: {
     /**
-     * CodeMirror modules used by MarkEdit.
+     * The `@lezer/common` module.
      */
-    codemirror: {
-      /**
-       * The `@codemirror/view` module.
-       */
-      view: typeof cmView;
-      /**
-       * The `@codemirror/state` module.
-       */
-      state: typeof cmState;
-      /**
-       * The `@codemirror/language` module.
-       */
-      language: typeof cmLanguage;
-    };
+    common: typeof lezerCommon;
 
     /**
-     * Lezer modules used by MarkEdit.
+     * The `@lezer/highlight` module.
      */
-    lezer: {
-      /**
-       * The `@lezer/common` module.
-       */
-      common: typeof lezerCommon;
-      /**
-       * The `@lezer/highlight` module.
-       */
-      highlight: typeof lezerHighlight;
-      /**
-       * The `@lezer/lr` module.
-       */
-      lr: typeof lezerLr;
-    },
-  }
+    highlight: typeof lezerHighlight;
+
+    /**
+     * The `@lezer/lr` module.
+     */
+    lr: typeof lezerLr;
+  },
+
+  /**
+   * Add an extension to MarkEdit.
+   * @param extension CodeMirror extension.
+   */
+  addExtension: (extension: Extension) => void;
 }
 
-declare interface TextEditable {
+export interface TextEditable {
   /**
    * Get text of the document.
    * @param range The range of the text. If no range is provided, the entire document is returned.
    */
   getText(range?: TextRange): string;
+
   /**
    * Set text for the document.
    * @param text The text to set.
    * @param range The range of the text. If no range is provided, the entire document is overwritten.
    */
   setText(text: string, range?: TextRange): void;
+
   /**
    * Get text selections.
    */
   getSelections(): TextRange[];
+
   /**
    * Set text selections.
    * @param ranges Text ranges to set.
    */
   setSelections(ranges: TextRange[]): void;
+
   /**
    * Get the line number (0-indexed) of given text position.
    * @param position The text position.
    */
   getLineNumber(position: number): number;
+
   /**
    * Get line range of given row (0-indexed).
    * @param row The line number.
    */
   getLineRange(row: number): TextRange;
+
   /**
    * Get number of lines.
    */
   getLineCount(): number;
+
   /**
    * Get line separator.
    */
   getLineBreak(): string;
+
   /**
    * Get CodeMirror syntax node name of given position.
    * @param position The text position.
    */
   getNodeName(position: number): string;
+
   /**
    * Undo a change.
    */
   undo(): void;
+
   /**
    * Redo a change.
    */
   redo(): void;
 }
 
-declare type TextRange = {
+export type TextRange = {
   from: number;
   to: number;
-};
-
-export { MarkEdit, TextEditable, TextRange };
+}

package.json

@@ -1,8 +1,8 @@
 {
   "name": "markedit-api",
-  "version": "0.0.8",
+  "version": "0.1.0",
   "description": "Type definitions for the latest MakrEdit API.",
-  "main": "",
+  "main": "main.ts",
   "types": "markedit.d.ts",
   "license": "MIT",
   "peerDependencies": {