@tinacms/mdx 1.0.1 → 1.0.3

package/dist/index.d.ts

@@ -17,5 +17,6 @@ limitations under the License.
 */
 import { parseMDX } from './parse';
 import { stringifyMDX } from './stringify';
+export * from './parse/plate';
 export { parseMDX };
 export { stringifyMDX };

package/dist/parse/plate.d.ts

@@ -15,39 +15,62 @@ See the License for the specific language governing permissions and
 limitations under the License.
 
 */
-import { Position } from './remarkToPlate';
+/**
+ * @group _MiscellaneousElement
+ */
 export declare type RootElement = {
     type: 'root';
     children: BlockElement[];
 };
-export declare type HeadingElement = {
-    type: 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6';
-    children: InlineElement[];
-};
-export declare type ParagraphElement = {
-    type: 'p';
+/**
+ * @group BlockElement
+ */
+export declare type BlockquoteElement = {
+    type: 'blockquote';
     children: InlineElement[];
 };
-export declare type MdxBlockElement = {
-    type: 'mdxJsxFlowElement';
-    name: string | null;
-    props: Record<string, unknown>;
+/**
+ * @group BlockElement
+ */
+export declare type CodeBlockElement = {
+    type: 'code_block';
+    lang?: string;
+    value: string;
     children: [EmptyTextElement];
 };
+/**
+ * @group BlockElement
+ */
+export declare type HeadingElement = {
+    type: 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6';
+    children: InlineElement[];
+};
+/**
+ * @group BlockElement
+ */
 export declare type HrElement = {
     type: 'hr';
     children: [EmptyTextElement];
 };
+/**
+ * @group BlockElement
+ */
 export declare type HTMLElement = {
     type: 'html';
     value: string;
     children: [EmptyTextElement];
 };
+/**
+ * @group InlineElement
+ */
 export declare type HTMLInlineElement = {
     type: 'html_inline';
     value: string;
     children: [EmptyTextElement];
 };
+/**
+ * @group BlockElement
+ */
 export declare type InvalidMarkdownElement = {
     type: 'invalid_markdown';
     value: string;
@@ -55,45 +78,85 @@ export declare type InvalidMarkdownElement = {
     position?: Position;
     children: [EmptyTextElement];
 };
-export declare type CodeBlockElement = {
-    type: 'code_block';
-    lang?: string;
-    value: string;
-    children: [EmptyTextElement];
-};
-export declare type BlockquoteElement = {
-    type: 'blockquote';
-    children: InlineElement[];
-};
+/**
+ * @group ListElements
+ */
+export declare type List = OrderedListElement | UnorderedListElement;
+/**
+ * @group ListElements
+ */
 export declare type ListItemContentElement = {
     type: 'lic';
     children: LicElement[];
 };
+/**
+ * @group ListElements
+ */
 export declare type ListItemChildrenElement = ListItemContentElement | UnorderedListElement | OrderedListElement;
+/**
+ * @group BlockElement
+ */
 export declare type ListItemElement = {
     type: 'li';
     children: ListItemChildrenElement[];
 };
+/**
+ * @group BlockElement
+ */
 export declare type UnorderedListElement = {
     type: 'ul';
     children: ListItemElement[];
 };
+/**
+ * @group BlockElement
+ */
+export declare type MdxBlockElement = {
+    type: 'mdxJsxFlowElement';
+    name: string | null;
+    props: Record<string, unknown>;
+    children: [EmptyTextElement];
+};
+/**
+ * @group BlockElement
+ */
 export declare type OrderedListElement = {
     type: 'ol';
     children: ListItemElement[];
 };
-export declare type List = OrderedListElement | UnorderedListElement;
-export declare type BlockElement = HeadingElement | ParagraphElement | CodeBlockElement | BlockquoteElement | MdxBlockElement | HTMLElement | ImageElement | UnorderedListElement | OrderedListElement | ListItemElement | HrElement | InvalidMarkdownElement;
+/**
+ * @group BlockElement
+ */
+export declare type ParagraphElement = {
+    type: 'p';
+    children: InlineElement[];
+};
+/**
+ * @group BlockElement
+ */
+export declare type BlockElement = BlockquoteElement | CodeBlockElement | HeadingElement | HrElement | HTMLElement | ImageElement | InvalidMarkdownElement | ListItemElement | MdxBlockElement | ParagraphElement | OrderedListElement | UnorderedListElement;
+/**
+ * @group InlineElement
+ */
 export declare type MdxInlineElement = {
     type: 'mdxJsxTextElement';
     name: string | null;
     props: Record<string, unknown>;
     children: [EmptyTextElement];
 };
+/**
+ * @remarks
+ * Used specifically to denote no children, used by
+ * the frontend rich-text editor for void nodes
+ *
+ * @group MiscellaneousElement
+ */
 export declare type EmptyTextElement = {
     type: 'text';
     text: '';
 };
+/**
+ * @group InlineElement
+ */
 export declare type TextElement = {
     type: 'text';
     text: string;
@@ -101,6 +164,12 @@ export declare type TextElement = {
     italic?: boolean;
     code?: boolean;
 };
+/**
+ * @remarks
+ * It may be beneficial to treat this as a block element
+ *
+ * @group InlineElement
+ */
 export declare type ImageElement = {
     type: 'img';
     url: string;
@@ -108,15 +177,50 @@ export declare type ImageElement = {
     caption?: string | null;
     children: [EmptyTextElement];
 };
+/**
+ * @group InlineElement
+ */
 export declare type LinkElement = {
     type: 'a';
     url: string;
     title?: string | null;
     children: InlineElement[];
 };
+/**
+ * @group InlineElement
+ */
 export declare type BreakElement = {
     type: 'break';
     children: [EmptyTextElement];
 };
+/**
+ * @group ListElements
+ */
 export declare type LicElement = InlineElement;
+/**
+ * @group InlineElement
+ */
 export declare type InlineElement = TextElement | MdxInlineElement | BreakElement | LinkElement | ImageElement | HTMLInlineElement;
+/**
+ * @remarks
+ * Positional information for error reporting
+ *
+ * @group _MiscellaneousElement
+ */
+export declare type Position = {
+    start: PositionItem;
+    end: PositionItem;
+};
+/**
+ * @remarks
+ * Positional information for error reporting
+ *
+ * @group _MiscellaneousElement
+ */
+export declare type PositionItem = {
+    line?: number | null;
+    column?: number | null;
+    offset?: number | null;
+    _index?: number | null;
+    _bufferIndex?: number | null;
+};

package/dist/parse/remarkToPlate.d.ts

@@ -19,6 +19,7 @@ import type * as Md from 'mdast';
 import type * as Plate from './plate';
 import type { RichTypeInner } from '@tinacms/schema-tools';
 import type { MdxJsxTextElement, MdxJsxFlowElement } from 'mdast-util-mdx-jsx';
+export type { Position, PositionItem } from './plate';
 declare module 'mdast' {
     interface StaticPhrasingContentMap {
         mdxJsxTextElement: MdxJsxTextElement;
@@ -34,18 +35,7 @@ declare module 'mdast' {
     }
 }
 export declare const remarkToSlate: (root: Md.Root | MdxJsxFlowElement | MdxJsxTextElement, field: RichTypeInner, imageCallback: (url: string) => string) => Plate.RootElement;
-export declare type PositionItem = {
-    line?: number | null;
-    column?: number | null;
-    offset?: number | null;
-    _index?: number | null;
-    _bufferIndex?: number | null;
-};
-export declare type Position = {
-    start: PositionItem;
-    end: PositionItem;
-};
 export declare class RichTextParseError extends Error {
-    position?: Position;
-    constructor(message: string, position?: Position);
+    position?: Plate.Position;
+    constructor(message: string, position?: Plate.Position);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tinacms/mdx",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "typings": "dist/index.d.ts",
   "main": "dist/index.js",
   "module": "dist/index.es.js",
@@ -19,14 +19,17 @@
     ]
   },
   "dependencies": {
-    "@tinacms/schema-tools": "1.0.1",
+    "@tinacms/schema-tools": "1.0.3",
     "acorn": "^8.7.1",
+    "concat-md": "^0.5.0",
     "lodash-es": "^4.17.21",
     "mdast-util-mdx-jsx": "^2.0.1",
     "mdast-util-to-markdown": "^1.3.0",
     "prettier": "^2.7.1",
     "remark": "^14.0.2",
     "remark-mdx": "^2.1.2",
+    "typedoc": "^0.23.21",
+    "typedoc-plugin-markdown": "^3.13.6",
     "unist-util-visit": "^4.1.0",
     "vfile": "^4.2.0"
   },
@@ -71,7 +74,7 @@
   "scripts": {
     "types": "yarn tsc",
     "build": "tinacms-scripts build",
-    "docs": "yarn typedoc",
+    "docs": "typedoc --plugin typedoc-plugin-markdown src/parse/plate.ts --theme markdown && concat-md --decrease-title-levels --dir-name-as-title docs > spec.md",
     "serve": "yarn nodemon dist/server.js",
     "test": "vitest",
     "coverage": "vitest run --coverage",