@tinacms/mdx 0.0.0-20220718181631

package/dist/parse/acorn.d.ts

@@ -0,0 +1,21 @@
+/**
+
+Copyright 2021 Forestry.io Holdings, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+*/
+import type { MdxJsxAttribute } from 'mdast-util-mdx-jsx';
+import type { TinaFieldBase } from '@tinacms/schema-tools';
+export declare const extractAttributes: (attributes: MdxJsxAttribute[], fields: TinaFieldBase[], imageCallback: (image: string) => string) => Record<string, unknown>;
+export declare const extractAttribute: (attribute: MdxJsxAttribute, field: TinaFieldBase, imageCallback: (image: string) => string) => string | number | bigint | boolean | RegExp | Record<string, unknown> | (string | number | bigint | boolean | RegExp | null | undefined)[] | Record<string, unknown>[] | null | undefined;

package/dist/parse/index.d.ts

@@ -0,0 +1,69 @@
+/**
+
+Copyright 2021 Forestry.io Holdings, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+*/
+import type { RichTypeInner } from '@tinacms/schema-tools';
+/**
+ * ### 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 valuse with no additional work.
+ */
+export declare const markdownToAst: (value: string, skipMDX: boolean, field: RichTypeInner) => import("mdast").Root | undefined;
+export declare const parseMDX: (value: string, field: RichTypeInner, imageCallback: (s: string) => string, skipMDX?: boolean | undefined) => import("./plate").RootElement;

package/dist/parse/mdx.d.ts

@@ -0,0 +1,22 @@
+/**
+
+Copyright 2021 Forestry.io Holdings, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+*/
+import type { MdxJsxTextElement, MdxJsxFlowElement } from 'mdast-util-mdx-jsx';
+import type { RichTypeInner } from '@tinacms/schema-tools';
+import type * as Plate from './plate';
+export declare function mdxJsxElement(node: MdxJsxTextElement, field: RichTypeInner, imageCallback: (url: string) => string): Plate.MdxInlineElement;
+export declare function mdxJsxElement(node: MdxJsxFlowElement, field: RichTypeInner, imageCallback: (url: string) => string): Plate.MdxBlockElement;

package/dist/parse/plate-spec.d.ts

@@ -0,0 +1,19 @@
+/**
+
+Copyright 2021 Forestry.io Holdings, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+*/
+import { RootElement } from './plate';
+export declare const root: RootElement;

package/dist/parse/plate.d.ts

@@ -0,0 +1,109 @@
+/**
+
+Copyright 2021 Forestry.io Holdings, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+*/
+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';
+    children: InlineElement[];
+};
+export declare type MdxBlockElement = {
+    type: 'mdxJsxFlowElement';
+    name: string | null;
+    props: Record<string, unknown>;
+    children: [EmptyTextElement];
+};
+export declare type HrElement = {
+    type: 'hr';
+    children: [EmptyTextElement];
+};
+export declare type HTMLElement = {
+    type: 'html';
+    value: string;
+    children: [EmptyTextElement];
+};
+export declare type CodeBlockElement = {
+    type: 'code_block';
+    lang?: string;
+    value: string;
+    children: [EmptyTextElement];
+};
+export declare type BlockquoteElement = {
+    type: 'blockquote';
+    children: InlineElement[];
+};
+export declare type ListItemContentElement = {
+    type: 'lic';
+    children: LicElement[];
+};
+export declare type ListItemChildrenElement = ListItemContentElement | UnorderedListElement | OrderedListElement;
+export declare type ListItemElement = {
+    type: 'li';
+    children: ListItemChildrenElement[];
+};
+export declare type UnorderedListElement = {
+    type: 'ul';
+    children: ListItemElement[];
+};
+export declare type OrderedListElement = {
+    type: 'ol';
+    children: ListItemElement[];
+};
+export declare type List = OrderedListElement | UnorderedListElement;
+export declare type BlockElement = HeadingElement | ParagraphElement | CodeBlockElement | BlockquoteElement | MdxBlockElement | HTMLElement | UnorderedListElement | OrderedListElement | ListItemElement | HrElement;
+export declare type MdxInlineElement = {
+    type: 'mdxJsxTextElement';
+    name: string | null;
+    props: Record<string, unknown>;
+    children: [EmptyTextElement];
+};
+export declare type EmptyTextElement = {
+    type: 'text';
+    text: '';
+};
+export declare type TextElement = {
+    type: 'text';
+    text: string;
+    bold?: boolean;
+    italic?: boolean;
+    code?: boolean;
+};
+export declare type ImageElement = {
+    type: 'img';
+    url: string;
+    alt?: string;
+    caption?: string | null;
+    children: [EmptyTextElement];
+};
+export declare type LinkElement = {
+    type: 'a';
+    url: string;
+    title?: string | null;
+    children: InlineElement[];
+};
+export declare type BreakElement = {
+    type: 'break';
+    children: [EmptyTextElement];
+};
+export declare type LicElement = InlineElement;
+export declare type InlineElement = TextElement | MdxInlineElement | BreakElement | LinkElement | ImageElement;

package/dist/parse/remarkToPlate.d.ts

@@ -0,0 +1,36 @@
+/**
+
+Copyright 2021 Forestry.io Holdings, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+*/
+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';
+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, field: RichTypeInner, imageCallback: (url: string) => string) => Plate.RootElement;

package/dist/stringify/acorn.d.ts

@@ -0,0 +1,12 @@
+import type { RichTypeInner } from '@tinacms/schema-tools';
+import type { MdxJsxAttribute } from 'mdast-util-mdx-jsx';
+import type * as Plate from '../parse/plate';
+import type * as Md from 'mdast';
+export declare const stringifyPropsInline: (element: Plate.MdxInlineElement, field: RichTypeInner, imageCallback: (url: string) => string) => {
+    attributes: MdxJsxAttribute[];
+    children: Md.PhrasingContent[];
+};
+export declare const stringifyProps: (element: Plate.MdxBlockElement, parentField: RichTypeInner, flatten: boolean, imageCallback: (url: string) => string) => {
+    attributes: MdxJsxAttribute[];
+    children: Md.BlockContent[];
+};

package/dist/stringify/index.d.ts

@@ -0,0 +1,25 @@
+/**
+
+Copyright 2021 Forestry.io Holdings, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+*/
+import type { RichTypeInner } from '@tinacms/schema-tools';
+import type * as Md from 'mdast';
+import type * as Plate from '../parse/plate';
+export declare const stringifyMDX: (value: Plate.RootElement, field: RichTypeInner, imageCallback: (url: string) => string) => string;
+export declare const rootElement: (content: Plate.RootElement, field: RichTypeInner, imageCallback: (url: string) => string) => Md.Root;
+export declare const blockElement: (content: Plate.BlockElement, field: RichTypeInner, imageCallback: (url: string) => string) => Md.Content | null;
+export declare type Marks = 'strong' | 'emphasis' | 'inlineCode';
+export declare const getMarks: (content: Plate.InlineElement) => Marks[];

package/dist/stringify/marks.d.ts

@@ -0,0 +1,25 @@
+/**
+
+Copyright 2021 Forestry.io Holdings, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+*/
+import type * as Md from 'mdast';
+import type * as Plate from '../parse/plate';
+import type { RichTypeInner } from '@tinacms/schema-tools';
+declare type InlineElementWithCallback = Plate.InlineElement & {
+    linkifyTextNode?: (arg: Md.Text) => Md.Link;
+};
+export declare const eat: (c: InlineElementWithCallback[], field: RichTypeInner, imageCallback: (url: string) => string) => Md.PhrasingContent[];
+export {};

package/dist/stringify/mdx.d.ts

@@ -0,0 +1,38 @@
+/**
+
+Copyright 2021 Forestry.io Holdings, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+*/
+import type { MdxJsxTextElement, MdxJsxFlowElement, MdxJsxAttribute } from 'mdast-util-mdx-jsx';
+import type { RichTypeInner } from '@tinacms/schema-tools';
+import type * as Plate from '../parse/plate';
+import type * as Md from 'mdast';
+declare module 'mdast' {
+    interface StaticPhrasingContentMap {
+        mdxJsxTextElement: MdxJsxTextElement;
+    }
+    interface PhrasingContentMap {
+        mdxJsxTextElement: MdxJsxTextElement;
+    }
+    interface BlockContentMap {
+        mdxJsxFlowElement: MdxJsxFlowElement;
+    }
+    interface ContentMap {
+        mdxJsxFlowElement: MdxJsxFlowElement;
+    }
+}
+export declare function mdxJsxInlineElement(node: Plate.MdxInlineElement, field: RichTypeInner): MdxJsxTextElement;
+export declare function processAttributes(node: Plate.MdxInlineElement | Plate.MdxBlockElement, field: RichTypeInner): MdxJsxAttribute[];
+export declare function processBlockChildren(node: Plate.MdxBlockElement, field: RichTypeInner): Md.BlockContent[];

package/package.json

@@ -0,0 +1,89 @@
+{
+  "name": "@tinacms/mdx",
+  "version": "0.0.0-20220718181631",
+  "main": "dist/index.cjs",
+  "typings": "dist/index.d.ts",
+  "module": "./dist/index.es.js",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.es.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "package.json",
+    "dist"
+  ],
+  "license": "Apache-2.0",
+  "buildConfig": {
+    "entryPoints": [
+      {
+        "name": "src/index.ts",
+        "target": "node",
+        "bundleDeps": true
+      }
+    ]
+  },
+  "dependencies": {
+    "acorn": "^8.7.1",
+    "lodash.flatten": "^4.4.0",
+    "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",
+    "unist-util-visit": "^4.1.0",
+    "vfile": "^4.2.0"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  },
+  "repository": {
+    "url": "https://github.com/tinacms/tinacms.git",
+    "directory": "packages/tina-graphql"
+  },
+  "devDependencies": {
+    "mdast": "^3.0.0",
+    "vitest": "^0.18.0",
+    "@swc/core": "^1.2.210",
+    "@types/prettier": "^2.6.3",
+    "@swc/jest": "^0.2.21",
+    "@tinacms/datalayer": "0.2.1",
+    "@tinacms/schema-tools": "0.0.8",
+    "@tinacms/scripts": "0.50.9",
+    "@types/cors": "^2.8.7",
+    "@types/estree": "^0.0.50",
+    "@types/express": "^4.17.8",
+    "@types/fs-extra": "^9.0.2",
+    "@types/jest": "^26.0.4",
+    "@types/js-yaml": "^3.12.5",
+    "@types/lodash.flatten": "4.4.7",
+    "@types/mdast": "3.0.7",
+    "@types/node": "^14.17.34",
+    "@types/normalize-path": "^3.0.0",
+    "@types/ws": "^7.2.6",
+    "@types/yup": "^0.29.7",
+    "c8": "^7.11.3",
+    "jest": "^28.1.2",
+    "jest-diff": "^28.1.1",
+    "jest-file-snapshot": "^0.5.0",
+    "jest-matcher-utils": "^28.1.1",
+    "nodemon": "^2.0.4",
+    "ts-node": "^10.8.2",
+    "typescript": "^4.3.5"
+  },
+  "peerDependencies": {
+    "@tinacms/schema-tools": "*"
+  },
+  "scripts": {
+    "types": "yarn tsc",
+    "build": "tinacms-scripts build",
+    "docs": "yarn typedoc",
+    "serve": "yarn nodemon dist/server.js",
+    "test": "vitest",
+    "coverage": "vitest run --coverage",
+    "test-watch": "jest --watch"
+  }
+}