@tinacms/mdx 2.2.3 → 2.3.0

package/dist/parse/index.d.ts

@@ -3,7 +3,7 @@
 
 
 */
-import type { RichTextType } from '@tinacms/schema-tools';
+import type { RichTextField } from '@tinacms/schema-tools';
 import type * as Plate from './plate';
 import { RichTextParseError } from './remarkToPlate';
 /**
@@ -55,10 +55,10 @@ import { RichTextParseError } from './remarkToPlate';
  * 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 markdownToAst: (value: string, field: RichTextField) => 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 parseMDX: (value: string, field: RichTextField, 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

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

package/dist/parse/remarkToPlate.d.ts

@@ -3,7 +3,7 @@
 
 
 */
-import type { RichTextType } from '@tinacms/schema-tools';
+import type { RichTextField } 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';
@@ -24,7 +24,7 @@ declare module 'mdast' {
         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 const remarkToSlate: (root: Md.Root | MdxJsxFlowElement | MdxJsxTextElement | ContainerDirective, field: RichTextField, 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);

package/dist/stringify/index.d.ts

@@ -1,4 +1,4 @@
-import type { RichTextType } from '@tinacms/schema-tools';
+import type { RichTextField } 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';
@@ -16,7 +16,7 @@ declare module 'mdast' {
         mdxJsxFlowElement: MdxJsxFlowElement;
     }
 }
-export declare const serializeMDX: (value: Plate.RootElement, field: RichTextType, imageCallback: (url: string) => string) => string | Plate.RootElement | undefined;
+export declare const serializeMDX: (value: Plate.RootElement, field: RichTextField, imageCallback: (url: string) => string) => string | Plate.RootElement | undefined;
 export type Pattern = {
     start: string;
     end: string;
@@ -24,9 +24,9 @@ export type Pattern = {
     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 const toTinaMarkdown: (tree: Md.Root, field: RichTextField) => string;
+export declare const rootElement: (content: Plate.RootElement, field: RichTextField, 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 declare const blockElement: (content: Plate.BlockElement, field: RichTextField, imageCallback: (url: string) => string) => Md.Content | null;
 export type Marks = 'strong' | 'emphasis' | 'inlineCode' | 'delete' | 'highlight';
 export declare const getMarks: (content: Plate.InlineElement) => Marks[];

package/dist/stringify/marks.d.ts

@@ -3,11 +3,11 @@
 
 
 */
-import type { RichTextType } from '@tinacms/schema-tools';
+import type { RichTextField } from '@tinacms/schema-tools';
 import type * as Md from 'mdast';
 import type * as Plate from '../parse/plate';
 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 declare const eat: (c: InlineElementWithCallback[], field: RichTextField, imageCallback: (url: string) => string) => Md.PhrasingContent[];
 export {};

package/dist/stringify/print-object-literal.corpus.d.ts

@@ -0,0 +1,12 @@
+/**
+ * The differential corpus for `printObjectLiteral`. Every case is
+ * deterministic, so the expected output of each one is recorded in
+ * `__snapshots__/print-object-literal.txt` by `pnpm snapshot:print-object-literal`.
+ * Append new cases; never reorder or rename existing ones.
+ */
+export type Case = {
+    name: string;
+    value: unknown;
+};
+export declare const corpus: Case[];
+export declare const MINIMUM_CORPUS = 5000;

package/dist/stringify/print-object-literal.d.ts

@@ -0,0 +1 @@
+export declare const printObjectLiteral: (value: unknown) => string;

package/dist/stringify/print-object-literal.snapshot.d.ts

@@ -0,0 +1,12 @@
+/**
+ * One record per corpus case, in corpus order. Blank lines separate records;
+ * neither a `JSON.stringify` input nor a printed object literal contains one.
+ */
+export type SnapshotRecord = {
+    index: number;
+    name: string;
+    input: string;
+    expected: string;
+};
+export declare const formatSnapshot: (records: SnapshotRecord[]) => string;
+export declare const parseSnapshot: (text: string) => SnapshotRecord[];

package/dist/stringify/print-object-literal.test.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tinacms/mdx",
-  "version": "2.2.3",
+  "version": "2.3.0",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -34,7 +34,9 @@
   "dependencies": {
     "acorn": "^8.16.0",
     "ccount": "2.0.1",
+    "emoji-regex": "9.2.2",
     "estree-util-is-identifier-name": "2.1.0",
+    "esutils": "2.0.3",
     "mdast-util-compact": "4.1.1",
     "mdast-util-directive": "2.2.4",
     "mdast-util-from-markdown": "1.3.0",
@@ -49,7 +51,6 @@
     "micromark-util-symbol": "1.0.1",
     "micromark-util-types": "1.1.0",
     "parse-entities": "4.0.1",
-    "prettier": "^2.8.8",
     "remark": "14.0.2",
     "remark-gfm": "^2.0.0",
     "remark-mdx": "2.3.0",
@@ -58,7 +59,7 @@
     "unist-util-stringify-position": "3.0.3",
     "unist-util-visit": "4.1.2",
     "vfile-message": "3.1.4",
-    "@tinacms/schema-tools": "^2.10.0"
+    "@tinacms/schema-tools": "^2.10.1"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org"
@@ -69,9 +70,9 @@
   },
   "devDependencies": {
     "@types/estree": "1.0.0",
+    "@types/esutils": "^2.0.2",
     "@types/mdast": "^3.0.15",
     "@types/node": "^22.13.1",
-    "@types/prettier": "^2.7.3",
     "@types/unist": "^2.0.11",
     "c8": "^7.14.0",
     "jest-file-snapshot": "^0.5.0",
@@ -86,6 +87,7 @@
     "build": "tinacms-scripts build",
     "serve": "nodemon dist/server.js",
     "test": "vitest run",
+    "snapshot:print-object-literal": "node --experimental-strip-types scripts/generate-print-object-literal-snapshot.mjs",
     "coverage": "vitest run --coverage",
     "test-watch": "vitest"
   }