@ckeditor/ckeditor5-markdown-gfm 36.0.1 → 37.0.0-alpha.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-markdown-gfm",
-  "version": "36.0.1",
+  "version": "37.0.0-alpha.1",
   "description": "GitHub Flavored Markdown data processor for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -12,21 +12,21 @@
   ],
   "main": "src/index.js",
   "dependencies": {
-    "ckeditor5": "^36.0.1",
+    "ckeditor5": "^37.0.0-alpha.1",
     "marked": "4.0.12",
     "turndown": "^6.0.0",
     "turndown-plugin-gfm": "^1.0.2"
   },
   "devDependencies": {
-    "@ckeditor/ckeditor5-basic-styles": "^36.0.1",
-    "@ckeditor/ckeditor5-code-block": "^36.0.1",
-    "@ckeditor/ckeditor5-core": "^36.0.1",
-    "@ckeditor/ckeditor5-dev-utils": "^32.0.0",
-    "@ckeditor/ckeditor5-editor-classic": "^36.0.1",
-    "@ckeditor/ckeditor5-engine": "^36.0.1",
-    "@ckeditor/ckeditor5-list": "^36.0.1",
-    "@ckeditor/ckeditor5-table": "^36.0.1",
-    "@ckeditor/ckeditor5-theme-lark": "^36.0.1",
+    "@ckeditor/ckeditor5-basic-styles": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-code-block": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-core": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-dev-utils": "^35.0.0",
+    "@ckeditor/ckeditor5-editor-classic": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-engine": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-list": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-table": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-theme-lark": "^37.0.0-alpha.1",
     "@types/marked": "^4.0.8",
     "typescript": "^4.8.4",
     "webpack": "^5.58.1",
@@ -61,8 +61,9 @@
     "block-elements"
   ],
   "scripts": {
-    "build": "tsc -p ./tsconfig.release.json",
+    "build": "tsc -p ./tsconfig.json",
     "postversion": "npm run build",
     "dll:build": "webpack"
-  }
+  },
+  "types": "src/index.d.ts"
 }

package/src/augmentation.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import type { Markdown } from './index';
+declare module '@ckeditor/ckeditor5-core' {
+    interface PluginsMap {
+        [Markdown.pluginName]: Markdown;
+    }
+}

package/src/augmentation.js

@@ -0,0 +1,5 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+export {};

package/src/gfmdataprocessor.d.ts

@@ -0,0 +1,62 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module markdown-gfm/gfmdataprocessor
+ */
+import { type DataProcessor, type ViewDocument, type ViewDocumentFragment, type MatcherPattern } from 'ckeditor5/src/engine';
+/**
+ * This data processor implementation uses GitHub Flavored Markdown as input/output data.
+ *
+ * See the {@glink features/markdown Markdown output} guide to learn more on how to enable it.
+ */
+export default class GFMDataProcessor implements DataProcessor {
+    /**
+     * HTML data processor used to process HTML produced by the Markdown-to-HTML converter and the other way.
+     */
+    private _htmlDP;
+    /**
+     * Creates a new instance of the Markdown data processor class.
+     */
+    constructor(document: ViewDocument);
+    /**
+     * Keeps the specified element in the output as HTML. This is useful if the editor contains
+     * features producing HTML that is not a part of the Markdown standard.
+     *
+     * By default, all HTML tags are removed.
+     *
+     * @param element The element name to be kept.
+     */
+    keepHtml(element: keyof HTMLElementTagNameMap): void;
+    /**
+     * Converts the provided Markdown string to a view tree.
+     *
+     * @param data A Markdown string.
+     * @returns The converted view element.
+     */
+    toView(data: string): ViewDocumentFragment;
+    /**
+     * Converts the provided {@link module:engine/view/documentfragment~DocumentFragment} to data format — in this
+     * case to a Markdown string.
+     *
+     * @returns Markdown string.
+     */
+    toData(viewFragment: ViewDocumentFragment): string;
+    /**
+     * Registers a {@link module:engine/view/matcher~MatcherPattern} for view elements whose content should be treated as raw data
+     * and not processed during the conversion from Markdown to view elements.
+     *
+     * The raw data can be later accessed by a
+     * {@link module:engine/view/element~Element#getCustomProperty custom property of a view element} called `"$rawContent"`.
+     *
+     * @param pattern The pattern matching all view elements whose content should
+     * be treated as raw data.
+     */
+    registerRawContentMatcher(pattern: MatcherPattern): void;
+    /**
+     * This method does not have any effect on the data processor result. It exists for compatibility with the
+     * {@link module:engine/dataprocessor/dataprocessor~DataProcessor `DataProcessor` interface}.
+     */
+    useFillerType(): void;
+}

package/src/html2markdown/html2markdown.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+declare const turndownService: any;
+/**
+ * Parses HTML to a markdown.
+ */
+export default function html2markdown(html: string): string;
+export { turndownService };

package/src/html2markdown/html2markdown.js

@@ -3,7 +3,7 @@
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 /**
- * @module markdown-gfm/html2markdown
+ * @module markdown-gfm/html2markdown/html2markdown
  */
 /* eslint-disable @typescript-eslint/ban-ts-comment */
 // Importing types for this package is problematic, so it's omitted.

package/src/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module markdown-gfm
+ */
+export { default as Markdown } from './markdown';
+import './augmentation';

package/src/index.js

@@ -6,3 +6,4 @@
  * @module markdown-gfm
  */
 export { default as Markdown } from './markdown';
+import './augmentation';

package/src/markdown.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module markdown-gfm/markdown
+ */
+import { Plugin, type Editor } from 'ckeditor5/src/core';
+/**
+ * The GitHub Flavored Markdown (GFM) plugin.
+ *
+ * For a detailed overview, check the {@glink features/markdown Markdown feature} guide.
+ */
+export default class Markdown extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): 'Markdown';
+}

package/src/markdown.js

@@ -10,7 +10,7 @@ import GFMDataProcessor from './gfmdataprocessor';
 /**
  * The GitHub Flavored Markdown (GFM) plugin.
  *
- * For a detailed overview, check the {@glink features/markdown Markdown feature documentation}.
+ * For a detailed overview, check the {@glink features/markdown Markdown feature} guide.
  */
 export default class Markdown extends Plugin {
     /**

package/src/markdown2html/markdown2html.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module markdown-gfm/markdown2html/markdown2html
+ */
+import { marked } from 'marked';
+/**
+ * Parses markdown string to an HTML.
+ */
+export default function markdown2html(markdown: string): string;
+export { marked };

package/src/markdown2html/markdown2html.js

@@ -3,7 +3,7 @@
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 /**
- * @module markdown-gfm/markdown2html
+ * @module markdown-gfm/markdown2html/markdown2html
  */
 import { marked } from 'marked';
 // Overrides.