@tinacms/mdx 0.0.0-00d7b85-20251222014449

package/dist/next/tests/mdx-blocks-rich-text-children-with-an-empty-object-value/index.test.d.ts

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

package/dist/next/tests/mdx-table-like-field/field.d.ts

@@ -0,0 +1,2 @@
+import { RichTextField } from '@tinacms/schema-tools';
+export declare const field: RichTextField;

package/dist/next/tests/mdx-table-like-field/index.test.d.ts

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

package/dist/next/tests/mdx-unregistered-component/field.d.ts

@@ -0,0 +1,2 @@
+import { RichTextField } from '@tinacms/schema-tools';
+export declare const field: RichTextField;

package/dist/next/tests/mdx-unregistered-component/index.test.d.ts

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

package/dist/next/tests/slatejson/field.d.ts

@@ -0,0 +1,2 @@
+import { RichTextField } from '@tinacms/schema-tools';
+export declare const field: RichTextField;

package/dist/next/tests/slatejson/index.test.d.ts

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

package/dist/next/tests/unrecognized-shortcodes/field.d.ts

@@ -0,0 +1,2 @@
+import { RichTextField } from '@tinacms/schema-tools';
+export declare const field: RichTextField;

package/dist/next/tests/unrecognized-shortcodes/index.test.d.ts

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

package/dist/next/tests/util.d.ts

@@ -0,0 +1,5 @@
+export declare function removePosition(tree: any): any;
+export declare const print: (tree: object) => string;
+export declare const nodePath: (dir: string) => string;
+export declare const mdPath: (dir: string) => string;
+export declare const jsonPath: (dir: string) => string;

package/dist/next/tests/wordpress-style/field.d.ts

@@ -0,0 +1,2 @@
+import { RichTextField } from '@tinacms/schema-tools';
+export declare const field: RichTextField;

package/dist/next/tests/wordpress-style/index.test.d.ts

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

package/dist/next/tests/wordpress-style-2/field.d.ts

@@ -0,0 +1,2 @@
+import { RichTextField } from '@tinacms/schema-tools';
+export declare const field: RichTextField;

package/dist/next/tests/wordpress-style-2/index.test.d.ts

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

package/dist/next/tests/wordpress-style-2-block-with-children/field.d.ts

@@ -0,0 +1,2 @@
+import { RichTextField } from '@tinacms/schema-tools';
+export declare const field: RichTextField;

package/dist/next/tests/wordpress-style-2-block-with-children/index.test.d.ts

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

package/dist/next/tests/wordpress-style-2-with-children/field.d.ts

@@ -0,0 +1,2 @@
+import { RichTextField } from '@tinacms/schema-tools';
+export declare const field: RichTextField;

package/dist/next/tests/wordpress-style-2-with-children/index.test.d.ts

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

package/dist/next/util.d.ts

@@ -0,0 +1,3 @@
+import type { RichTextField } from '@tinacms/schema-tools';
+import type { Pattern } from './shortcodes';
+export declare const getFieldPatterns: (field: RichTextField) => Pattern[];

package/dist/parse/acorn.d.ts

@@ -0,0 +1,4 @@
+import type { MdxJsxAttribute, MdxJsxExpressionAttribute } from 'mdast-util-mdx-jsx';
+import type { TinaField } from '@tinacms/schema-tools';
+export declare const extractAttributes: (attributes: (MdxJsxAttribute | MdxJsxExpressionAttribute)[], fields: TinaField[], imageCallback: (image: string) => string) => Record<string, unknown>;
+export declare const trimFragments: (string: string) => string;

package/dist/parse/acorn.test.d.ts

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

package/dist/parse/index.d.ts

@@ -0,0 +1,64 @@
+/**
+
+
+
+*/
+import type { RichTextType } from '@tinacms/schema-tools';
+import type * as Plate from './plate';
+import { RichTextParseError } from './remarkToPlate';
+/**
+ * ### Convert the MDXAST into an API-friendly format
+ *
+ * When we parse with Remark + MDX we get an AST which has a ton of JS capabilities, meaning
+ * we could pass this back into a JS runtime and evaluate it. Ex.
+ *
+ * ```mdx
+ * ## Hello world! The time and date is: {(new Date().toLocaleString())}
+ * ```
+ *
+ * However, as an intentional constraint we don't want this information as part of our API, as
+ * we don't intend to support the true JS runtime properties of MDX. Rather, we're using MDX for
+ * it's expressive syntax and it's advanced tooling with how it parses JSX inside Markdown.
+ *
+ * Parsing here does 2 things:
+ *
+ * #### Remove non-literal uses of JSX
+ * Things like <MyComponent myProp={() => alert("HI")} /> are not supported and will be ignored
+ *
+ * #### Convert remark nodes to slate-compatible nodes
+ *
+ * A remark node might look like this:
+ * ```js
+ * {
+ *   type: "heading",
+ *   depth: 1
+ *   children: [{type: 'text', value: 'Hello'}]
+ * }
+ * ```
+ * A slate-compatible node would be:
+ * ```js
+ * {
+ *   type: "heading_one",
+ *   children: [{type: 'text', text: 'Hello'}]
+ * }
+ * ```
+ * It's not a huge difference, but in general slate does better with less layers of indirection.
+ *
+ * While it may be desirable to ultimately serve a remark AST shape as part of the API response,
+ * it's currently much easier to only support the shape that works with Slate. This is ok for now for 2
+ * reasons.
+ *
+ * 1. Us providing the `TinaMarkdown` component on the frontend abstracts away an work the developer
+ * would need to do, so it doesn't really matter what shape the response is as long as the external API
+ * doesn't change
+ *
+ * 2. We don't need to do any client-side parsing. Since TinaMarkdown and the slate editor work with the same
+ * format we can just allow Tina to do it's thing and update the form value with no additional work.
+ */
+export declare const markdownToAst: (value: string, field: RichTextType) => import("mdast").Root;
+export declare const mdxToAst: (value: string) => import("mdast").Root;
+export declare const MDX_PARSE_ERROR_MSG = "TinaCMS supports a stricter version of markdown and a subset of MDX. https://tina.io/docs/r/what-is-markdown";
+export declare const MDX_PARSE_ERROR_MSG_HTML = "TinaCMS supports a stricter version of markdown and a subset of MDX. <a href=\"https://tina.io/docs/r/what-is-markdown\" target=\"_blank\" rel=\"noopener noreferrer\">Learn More</a>";
+export declare const parseMDX: (value: string, field: RichTextType, imageCallback: (s: string) => string) => Plate.RootElement;
+export declare const invalidMarkdown: (e: RichTextParseError, value: string) => Plate.RootElement;
+export declare const replaceAll: (string: string, target: string, value: string) => string;

package/dist/parse/mdx.d.ts

@@ -0,0 +1,13 @@
+/**
+
+
+
+*/
+import type { MdxJsxTextElement, MdxJsxFlowElement } from 'mdast-util-mdx-jsx';
+import type { RichTextType } from '@tinacms/schema-tools';
+import type * as Plate from './plate';
+import { ContainerDirective } from 'mdast-util-directive';
+import { LeafDirective } from 'mdast-util-directive/lib';
+export declare function mdxJsxElement(node: MdxJsxTextElement, field: RichTextType, imageCallback: (url: string) => string): Plate.MdxInlineElement;
+export declare function mdxJsxElement(node: MdxJsxFlowElement, field: RichTextType, imageCallback: (url: string) => string): Plate.MdxBlockElement;
+export declare const directiveElement: (node: ContainerDirective | LeafDirective, field: RichTextType, imageCallback: (url: string) => string, raw?: string) => Plate.BlockElement | Plate.ParagraphElement;

package/dist/parse/parseShortcode.d.ts

@@ -0,0 +1,7 @@
+/**
+
+
+
+*/
+import { RichTextTemplate } from '@tinacms/schema-tools';
+export declare function parseShortcode(preprocessedString: string, template: RichTextTemplate): string;

package/dist/parse/parseShortcode.test.d.ts

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

package/dist/parse/plate.d.ts

@@ -0,0 +1,240 @@
+/**
+
+
+
+*/
+/**
+ * @group _MiscellaneousElement
+ */
+export type RootElement = {
+    type: 'root';
+    children: BlockElement[];
+};
+/**
+ * @group BlockElement
+ */
+export type BlockquoteElement = {
+    type: 'blockquote';
+    children: InlineElement[];
+};
+export type CodeLineElement = {
+    type: 'code_line';
+    children: {
+        text: string;
+    }[];
+};
+export type CodeBlockElement = {
+    type: 'code_block';
+    lang?: string;
+    value?: string;
+    children: CodeLineElement[];
+};
+/**
+ * @group BlockElement
+ */
+export type HeadingElement = {
+    type: 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6';
+    children: InlineElement[];
+};
+/**
+ * @group BlockElement
+ */
+export type HrElement = {
+    type: 'hr';
+    children: [EmptyTextElement];
+};
+/**
+ * @group BlockElement
+ */
+export type HTMLElement = {
+    type: 'html';
+    value: string;
+    children: [EmptyTextElement];
+};
+/**
+ * @group InlineElement
+ */
+export type HTMLInlineElement = {
+    type: 'html_inline';
+    value: string;
+    children: [EmptyTextElement];
+};
+/**
+ * @group BlockElement
+ */
+export type InvalidMarkdownElement = {
+    type: 'invalid_markdown';
+    value: string;
+    message: string;
+    position?: Position;
+    children: [EmptyTextElement];
+};
+/**
+ * @group ListElements
+ */
+export type List = OrderedListElement | UnorderedListElement;
+/**
+ * @group ListElements
+ */
+export type ListItemContentElement = {
+    type: 'lic';
+    children: LicElement[];
+};
+/**
+ * @group ListElements
+ */
+export type ListItemChildrenElement = ListItemContentElement | UnorderedListElement | OrderedListElement;
+/**
+ * @group BlockElement
+ */
+export type ListItemElement = {
+    type: 'li';
+    children: ListItemChildrenElement[];
+};
+/**
+ * @group BlockElement
+ */
+export type UnorderedListElement = {
+    type: 'ul';
+    children: ListItemElement[];
+};
+/**
+ * @group BlockElement
+ */
+export type MdxBlockElement = {
+    type: 'mdxJsxFlowElement';
+    name: string | null;
+    props: Record<string, unknown>;
+    children: [EmptyTextElement];
+};
+/**
+ * @group BlockElement
+ */
+export type OrderedListElement = {
+    type: 'ol';
+    children: ListItemElement[];
+};
+/**
+ * @group BlockElement
+ */
+export type ParagraphElement = {
+    type: 'p';
+    children: InlineElement[];
+};
+/**
+ * @group BlockElement
+ */
+export type TableCellElement = {
+    type: 'td';
+    children: ParagraphElement[];
+};
+/**
+ * @group BlockElement
+ */
+export type TableRowElement = {
+    type: 'tr';
+    children: TableCellElement[];
+};
+/**
+ * @group BlockElement
+ */
+export type TableElement = {
+    type: 'table';
+    children: TableRowElement[];
+    props: Record<string, unknown>;
+};
+/**
+ * @group BlockElement
+ */
+export type BlockElement = BlockquoteElement | CodeBlockElement | HeadingElement | HrElement | HTMLElement | ImageElement | InvalidMarkdownElement | ListItemElement | MdxBlockElement | ParagraphElement | OrderedListElement | UnorderedListElement | TableCellElement | TableRowElement | TableElement;
+/**
+ * @group InlineElement
+ */
+export 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 type EmptyTextElement = {
+    type: 'text';
+    text: '';
+};
+/**
+ * @group InlineElement
+ */
+export type TextElement = {
+    type: 'text';
+    text: string;
+    bold?: boolean;
+    italic?: boolean;
+    code?: boolean;
+    strikethrough?: boolean;
+};
+/**
+ * @remarks
+ * It may be beneficial to treat this as a block element
+ *
+ * @group InlineElement
+ */
+export type ImageElement = {
+    type: 'img';
+    url: string;
+    alt?: string;
+    caption?: string | null;
+    children: [EmptyTextElement];
+};
+/**
+ * @group InlineElement
+ */
+export type LinkElement = {
+    type: 'a';
+    url: string;
+    title?: string | null;
+    children: InlineElement[];
+};
+/**
+ * @group InlineElement
+ */
+export type BreakElement = {
+    type: 'break';
+    children: [EmptyTextElement];
+};
+/**
+ * @group ListElements
+ */
+export type LicElement = InlineElement;
+/**
+ * @group InlineElement
+ */
+export type InlineElement = TextElement | MdxInlineElement | BreakElement | LinkElement | ImageElement | HTMLInlineElement;
+/**
+ * @remarks
+ * Positional information for error reporting
+ *
+ * @group _MiscellaneousElement
+ */
+export type Position = {
+    start: PositionItem;
+    end: PositionItem;
+};
+/**
+ * @remarks
+ * Positional information for error reporting
+ *
+ * @group _MiscellaneousElement
+ */
+export type PositionItem = {
+    line?: number | null;
+    column?: number | null;
+    offset?: number | null;
+    _index?: number | null;
+    _bufferIndex?: number | null;
+};

package/dist/parse/remarkToPlate.d.ts

@@ -0,0 +1,31 @@
+/**
+
+
+
+*/
+import type { RichTextType } from '@tinacms/schema-tools';
+import type * as Md from 'mdast';
+import type { ContainerDirective } from 'mdast-util-directive';
+import type { MdxJsxFlowElement, MdxJsxTextElement } from 'mdast-util-mdx-jsx';
+import type * as Plate from './plate';
+export type { Position, PositionItem } from './plate';
+declare module 'mdast' {
+    interface StaticPhrasingContentMap {
+        mdxJsxTextElement: MdxJsxTextElement;
+    }
+    interface PhrasingContentMap {
+        mdxJsxTextElement: MdxJsxTextElement;
+    }
+    interface BlockContentMap {
+        mdxJsxFlowElement: MdxJsxFlowElement;
+    }
+    interface ContentMap {
+        mdxJsxFlowElement: MdxJsxFlowElement;
+    }
+}
+export declare const remarkToSlate: (root: Md.Root | MdxJsxFlowElement | MdxJsxTextElement | ContainerDirective, field: RichTextType, imageCallback: (url: string) => string, raw?: string, skipMDXProcess?: boolean) => Plate.RootElement;
+export declare class RichTextParseError extends Error {
+    position?: Plate.Position;
+    constructor(message: string, position?: Plate.Position);
+}
+export declare const sanitizeUrl: (url: string | undefined) => string;

package/dist/parse/remarkToPlate.test.d.ts

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

package/dist/stringify/acorn.d.ts

@@ -0,0 +1,21 @@
+import type { RichTextField } from '@tinacms/schema-tools';
+import type * as Md from 'mdast';
+import type { MdxJsxAttribute } from 'mdast-util-mdx-jsx';
+import * as Plate from '../parse/plate';
+export declare const stringifyPropsInline: (element: Plate.MdxInlineElement, field: RichTextField, imageCallback: (url: string) => string) => {
+    attributes: MdxJsxAttribute[];
+    children: Md.PhrasingContent[];
+};
+export declare function stringifyProps(element: Plate.MdxInlineElement, parentField: RichTextField, flatten: boolean, imageCallback: (url: string) => string): {
+    attributes: MdxJsxAttribute[];
+    children: Md.PhrasingContent[];
+    useDirective: boolean;
+    directiveType: string;
+};
+export declare function stringifyProps(element: Plate.MdxBlockElement, parentField: RichTextField, flatten: boolean, imageCallback: (url: string) => string): {
+    attributes: MdxJsxAttribute[];
+    children: Md.BlockContent[];
+    useDirective: boolean;
+    directiveType: string;
+};
+export declare function assertShape<T>(value: unknown, callback: (item: any) => boolean, errorMessage?: string): asserts value is T;

package/dist/stringify/index.d.ts

@@ -0,0 +1,32 @@
+import type { RichTextType } from '@tinacms/schema-tools';
+import type * as Md from 'mdast';
+import { MdxJsxFlowElement, MdxJsxTextElement } from 'mdast-util-mdx-jsx';
+import type * as Plate from '../parse/plate';
+declare module 'mdast' {
+    interface StaticPhrasingContentMap {
+        mdxJsxTextElement: MdxJsxTextElement;
+    }
+    interface PhrasingContentMap {
+        mdxJsxTextElement: MdxJsxTextElement;
+    }
+    interface BlockContentMap {
+        mdxJsxFlowElement: MdxJsxFlowElement;
+    }
+    interface ContentMap {
+        mdxJsxFlowElement: MdxJsxFlowElement;
+    }
+}
+export declare const serializeMDX: (value: Plate.RootElement, field: RichTextType, imageCallback: (url: string) => string) => string | Plate.RootElement | undefined;
+export type Pattern = {
+    start: string;
+    end: string;
+    name: string;
+    templateName: string;
+    type: 'block' | 'leaf';
+};
+export declare const toTinaMarkdown: (tree: Md.Root, field: RichTextType) => string;
+export declare const rootElement: (content: Plate.RootElement, field: RichTextType, imageCallback: (url: string) => string) => Md.Root;
+export declare function codeLinesToString(content: Plate.CodeBlockElement): string;
+export declare const blockElement: (content: Plate.BlockElement, field: RichTextType, imageCallback: (url: string) => string) => Md.Content | null;
+export type Marks = 'strong' | 'emphasis' | 'inlineCode' | 'delete';
+export declare const getMarks: (content: Plate.InlineElement) => Marks[];

package/dist/stringify/marks.d.ts

@@ -0,0 +1,13 @@
+/**
+
+
+
+*/
+import type * as Md from 'mdast';
+import type * as Plate from '../parse/plate';
+import type { RichTextType } from '@tinacms/schema-tools';
+type InlineElementWithCallback = Plate.InlineElement & {
+    linkifyTextNode?: (arg: Md.Text) => Md.Link;
+};
+export declare const eat: (c: InlineElementWithCallback[], field: RichTextType, imageCallback: (url: string) => string) => Md.PhrasingContent[];
+export {};

package/dist/stringify/stringifyShortcode.d.ts

@@ -0,0 +1,7 @@
+/**
+
+
+
+*/
+import { RichTextTemplate } from '@tinacms/schema-tools';
+export declare function stringifyShortcode(preprocessedString: string, template: RichTextTemplate): string;

package/dist/stringify/stringifyShortcode.test.d.ts

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

package/package.json

@@ -0,0 +1,92 @@
+{
+  "name": "@tinacms/mdx",
+  "version": "0.0.0-00d7b85-20251222014449",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "browser": "dist/index.browser.js",
+  "files": [
+    "package.json",
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "browser": "./dist/index.browser.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "license": "Apache-2.0",
+  "buildConfig": {
+    "entryPoints": [
+      {
+        "name": "src/index.ts",
+        "target": "node",
+        "bundleDeps": true
+      }
+    ]
+  },
+  "dependencies": {
+    "acorn": "8.8.2",
+    "ccount": "2.0.1",
+    "estree-util-is-identifier-name": "2.1.0",
+    "mdast-util-compact": "4.1.1",
+    "mdast-util-directive": "2.2.4",
+    "mdast-util-from-markdown": "1.3.0",
+    "mdast-util-gfm": "2.0.2",
+    "mdast-util-mdx-jsx": "2.1.2",
+    "mdast-util-to-markdown": "1.5.0",
+    "micromark-extension-gfm": "2.0.3",
+    "micromark-factory-mdx-expression": "1.0.7",
+    "micromark-factory-space": "1.0.0",
+    "micromark-factory-whitespace": "1.0.0",
+    "micromark-util-character": "1.1.0",
+    "micromark-util-symbol": "1.0.1",
+    "micromark-util-types": "1.0.2",
+    "parse-entities": "4.0.1",
+    "prettier": "^2.8.8",
+    "remark": "14.0.2",
+    "remark-gfm": "^2.0.0",
+    "remark-mdx": "2.3.0",
+    "stringify-entities": "4.0.3",
+    "typedoc": "^0.26.11",
+    "unist-util-source": "4.0.2",
+    "unist-util-stringify-position": "3.0.3",
+    "unist-util-visit": "4.1.2",
+    "uvu": "0.5.6",
+    "vfile-message": "3.1.4",
+    "@tinacms/schema-tools": "0.0.0-00d7b85-20251222014449"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  },
+  "repository": {
+    "url": "https://github.com/tinacms/tinacms.git",
+    "directory": "packages/tina-graphql"
+  },
+  "devDependencies": {
+    "@types/estree": "1.0.0",
+    "@types/mdast": "^3.0.15",
+    "@types/node": "^22.13.1",
+    "@types/prettier": "^2.7.3",
+    "@types/unist": "^2.0.11",
+    "c8": "^7.14.0",
+    "concat-md": "^0.5.1",
+    "jest-file-snapshot": "^0.5.0",
+    "ts-node": "^10.9.2",
+    "typedoc-plugin-markdown": "^3.17.1",
+    "typescript": "^5.7.3",
+    "vite": "^4.5.9",
+    "vitest": "^0.32.4",
+    "@tinacms/scripts": "1.4.2"
+  },
+  "scripts": {
+    "types": "tsc",
+    "build": "tinacms-scripts build",
+    "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": "nodemon dist/server.js",
+    "test": "vitest run",
+    "coverage": "vitest run --coverage",
+    "test-watch": "vitest"
+  }
+}