@tinacms/graphql 0.55.0 → 0.56.1

package/dist/primitives/ast-builder/index.d.ts

@@ -85,6 +85,7 @@ export declare const astBuilder: {
         ID: string;
         SystemInfo: string;
         Boolean: string;
+        JSON: string;
         Node: string;
         PageInfo: string;
         Connection: string;

package/dist/primitives/builder/index.d.ts

@@ -88,6 +88,14 @@ export declare class Builder {
      * @param collections
      */
     multiCollectionDocument: (collections: TinaCloudCollectionEnriched[]) => Promise<import("graphql").FieldDefinitionNode>;
+    /**
+     * ```graphql
+     * {
+     *    getDocumentFields()
+     * }
+     * ```
+     */
+    multiCollectionDocumentFields: () => Promise<import("graphql").FieldDefinitionNode>;
     /**
      * ```graphql
      * # ex.

package/dist/primitives/mdx/index.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 { parseMDX } from './parse';
+import { stringifyMDX } from './stringify';
+export { parseMDX };
+export { stringifyMDX };

package/dist/primitives/mdx/parse.d.ts

@@ -0,0 +1,229 @@
+/**
+
+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 { Content } from 'mdast';
+import type { RichTypeInner } from '../types';
+export declare const parseMDX: (value: string, field: RichTypeInner) => {
+    type: string;
+    children: any;
+};
+/**
+ * ### 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 parseMDXInner: (tree: any, field: RichTypeInner) => {
+    type: string;
+    children: any;
+};
+export interface NodeTypes {
+    paragraph: string;
+    block_quote: string;
+    code_block: string;
+    link: string;
+    image: string;
+    ul_list: string;
+    ol_list: string;
+    listItem: string;
+    heading: {
+        1: string;
+        2: string;
+        3: string;
+        4: string;
+        5: string;
+        6: string;
+    };
+    emphasis_mark: string;
+    strong_mark: string;
+    delete_mark: string;
+    inline_code_mark: string;
+    thematic_break: string;
+}
+export declare type SlateNodeType = {
+    type: 'heading_one';
+    children: SlateNodeType[];
+} | {
+    type: 'heading_two';
+    children: SlateNodeType[];
+} | {
+    type: 'heading_three';
+    children: SlateNodeType[];
+} | {
+    type: 'heading_four';
+    children: SlateNodeType[];
+} | {
+    type: 'heading_five';
+    children: SlateNodeType[];
+} | {
+    type: 'heading_six';
+    children: SlateNodeType[];
+} | {
+    type: 'paragraph';
+    children: SlateNodeType[];
+} | {
+    children: SlateNodeType[];
+    link: string;
+    type: 'link';
+} | {
+    type: 'block_quote';
+    children: SlateNodeType[];
+} | {
+    type: 'text';
+    text: string;
+} | {
+    type: 'mdxJsxTextElement';
+    props: object;
+    children: SlateNodeType[];
+    name: string;
+} | {
+    type: 'mdxJsxFlowElement';
+    props: object;
+    children: SlateNodeType[];
+    name: string;
+} | {
+    type: 'block_quote';
+    children: SlateNodeType[];
+} | {
+    type: 'code_block';
+    language: string;
+    value: string;
+} | {
+    type: 'image';
+    link: string;
+    caption: string;
+} | {
+    type: 'thematic_break';
+};
+declare type RecursivePartial<T> = {
+    [P in keyof T]?: RecursivePartial<T[P]>;
+};
+export interface OptionType {
+    nodeTypes?: RecursivePartial<NodeTypes>;
+    linkDestinationKey?: string;
+    imageSourceKey?: string;
+    imageCaptionKey?: string;
+}
+export interface MdastNode {
+    type?: string;
+    ordered?: boolean;
+    value?: string;
+    text?: string;
+    children?: Array<MdastNode>;
+    depth?: 1 | 2 | 3 | 4 | 5 | 6;
+    url?: string;
+    alt?: string;
+    lang?: string;
+    position?: any;
+    spread?: any;
+    checked?: any;
+    indent?: any;
+}
+declare type MdxJsxFlowElement = {
+    type: 'mdxJsxFlowElement';
+    name: string;
+    attributes: object;
+    children: MdxAstNode[];
+};
+declare type MdxJsxTextElement = {
+    type: 'mdxJsxTextElement';
+    name: string;
+    attributes: object;
+    children: MdxAstNode[];
+};
+declare type MdxAstNode = Content | MdxJsxFlowElement | MdxJsxTextElement;
+export declare const plateElements: {
+    ELEMENT_H1: string;
+    ELEMENT_H2: string;
+    ELEMENT_H3: string;
+    ELEMENT_H4: string;
+    ELEMENT_H5: string;
+    ELEMENT_H6: string;
+    ELEMENT_HR: string;
+    ELEMENT_ALIGN_CENTER: string;
+    ELEMENT_ALIGN_JUSTIFY: string;
+    ELEMENT_ALIGN_LEFT: string;
+    ELEMENT_ALIGN_RIGHT: string;
+    ELEMENT_BLOCKQUOTE: string;
+    ELEMENT_CODE_BLOCK: string;
+    ELEMENT_CODE_LINE: string;
+    ELEMENT_DEFAULT: string;
+    ELEMENT_IMAGE: string;
+    ELEMENT_LI: string;
+    ELEMENT_LIC: string;
+    ELEMENT_LINK: string;
+    ELEMENT_MEDIA_EMBED: string;
+    ELEMENT_MENTION: string;
+    ELEMENT_OL: string;
+    ELEMENT_PARAGRAPH: string;
+    ELEMENT_TABLE: string;
+    ELEMENT_TD: string;
+    ELEMENT_TH: string;
+    ELEMENT_TODO_LI: string;
+    ELEMENT_TR: string;
+    ELEMENT_UL: string;
+    MARK_ITALIC: string;
+    MARK_BOLD: string;
+    MARK_STRIKETHROUGH: string;
+    MARK_UNDERLINE: string;
+};
+export declare const defaultNodeTypes: NodeTypes;
+export default function remarkToSlate(node: MdxAstNode): any;
+export {};

package/dist/primitives/mdx/stringify.d.ts

@@ -0,0 +1,24 @@
+/**
+
+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 '../types';
+import { plateElements } from './parse';
+import type { Content } from 'mdast';
+export declare const stringifyMDX: (value: unknown, field: RichTypeInner) => string;
+export declare const stringify: (node: {
+    type: typeof plateElements;
+}, field: RichTypeInner) => Content;

package/dist/primitives/resolver/index.d.ts

@@ -12,6 +12,7 @@ limitations under the License.
 */
 import { TinaSchema } from '../schema';
 import { Database, CollectionDocumentListLookup } from '../database';
+import type { Collectable, TinaCloudCollection } from '../types';
 interface ResolverConfig {
     database: Database;
     tinaSchema: TinaSchema;
@@ -34,7 +35,7 @@ export declare class Resolver {
         label: string;
         name: string;
         path: string;
-        format?: "json" | "md" | "markdown" | "yml" | "yaml";
+        format?: "json" | "md" | "markdown" | "mdx";
         match?: string;
         documents: string[];
     } | {
@@ -51,7 +52,7 @@ export declare class Resolver {
         label: string;
         name: string;
         path: string;
-        format?: "json" | "md" | "markdown" | "yml" | "yaml";
+        format?: "json" | "md" | "markdown" | "mdx";
         match?: string;
         documents: string[];
     }>;
@@ -65,7 +66,7 @@ export declare class Resolver {
             path: string;
             relativePath: string;
             breadcrumbs: string[];
-            collection: import("../types").TinaCloudCollection<true>;
+            collection: TinaCloudCollection<true>;
             template: string | number;
         };
         data: {
@@ -86,12 +87,92 @@ export declare class Resolver {
             fields: unknown[];
         };
     }>;
-    resolveDocument: ({ value, args, collection: collectionName, isMutation, isCreation, }: {
-        value: unknown;
+    getDocumentFields: () => Promise<{}>;
+    buildObjectMutations: (fieldValue: any, field: Collectable) => {
+        [key: string]: unknown;
+    } | {
+        [key: string]: unknown;
+    }[];
+    createResolveDocument: ({ collection, realPath, args, isAddPendingDocument, }: {
+        collection: TinaCloudCollection<true>;
+        realPath: string;
+        args: unknown;
+        isAddPendingDocument: boolean;
+    }) => Promise<{
+        __typename: string;
+        id: string;
+        sys: {
+            basename: string;
+            filename: string;
+            extension: string;
+            path: string;
+            relativePath: string;
+            breadcrumbs: string[];
+            collection: TinaCloudCollection<true>;
+            template: string | number;
+        };
+        data: {
+            _collection: string;
+            _template: string;
+        };
+        values: {
+            _collection: string;
+            _template: string;
+        };
+        dataJSON: {
+            _collection: string;
+            _template: string;
+        };
+        form: {
+            label: string;
+            name: string;
+            fields: unknown[];
+        };
+    }>;
+    updateResolveDocument: ({ collection, realPath, args, isAddPendingDocument, isCollectionSpecific, }: {
+        collection: TinaCloudCollection<true>;
+        realPath: string;
+        args: unknown;
+        isAddPendingDocument: boolean;
+        isCollectionSpecific: boolean;
+    }) => Promise<{
+        __typename: string;
+        id: string;
+        sys: {
+            basename: string;
+            filename: string;
+            extension: string;
+            path: string;
+            relativePath: string;
+            breadcrumbs: string[];
+            collection: TinaCloudCollection<true>;
+            template: string | number;
+        };
+        data: {
+            _collection: string;
+            _template: string;
+        };
+        values: {
+            _collection: string;
+            _template: string;
+        };
+        dataJSON: {
+            _collection: string;
+            _template: string;
+        };
+        form: {
+            label: string;
+            name: string;
+            fields: unknown[];
+        };
+    }>;
+    resolveDocument: ({ args, collection: collectionName, isMutation, isCreation, isAddPendingDocument, isCollectionSpecific, }: {
         args: unknown;
-        collection: string;
+        collection?: string;
         isMutation: boolean;
         isCreation?: boolean;
+        isAddPendingDocument?: boolean;
+        isCollectionSpecific?: boolean;
     }) => Promise<{
         __typename: string;
         id: string;
@@ -102,7 +183,7 @@ export declare class Resolver {
             path: string;
             relativePath: string;
             breadcrumbs: string[];
-            collection: import("../types").TinaCloudCollection<true>;
+            collection: TinaCloudCollection<true>;
             template: string | number;
         };
         data: {
@@ -138,7 +219,7 @@ export declare class Resolver {
                     path: string;
                     relativePath: string;
                     breadcrumbs: string[];
-                    collection: import("../types").TinaCloudCollection<true>;
+                    collection: TinaCloudCollection<true>;
                     template: string | number;
                 };
                 data: {
@@ -177,7 +258,7 @@ export declare class Resolver {
                     path: string;
                     relativePath: string;
                     breadcrumbs: string[];
-                    collection: import("../types").TinaCloudCollection<true>;
+                    collection: TinaCloudCollection<true>;
                     template: string | number;
                 };
                 data: {

package/dist/primitives/spec/setup.d.ts

@@ -36,8 +36,12 @@ export declare const setupFixture: (rootPath: string, schema: TinaCloudSchema<fa
         [key: string]: any;
     }>;
     expectedReponse: string;
-    mutations: (false | {
-        mutation: string;
-        expectedMutation: string;
-    })[];
+    expectedReponsePath: string;
+}>;
+export declare const setupFixture2: (rootPath: string, schema: TinaCloudSchema<false>, fixture: {
+    name: string;
+    assert: 'output' | 'file';
+}) => Promise<{
+    response: string;
+    expectedResponsePath: string;
 }>;

package/dist/primitives/types.d.ts

@@ -29,7 +29,7 @@ export interface TinaCloudSchemaWithNamespace {
 export declare type TinaCloudCollection<WithNamespace extends boolean> = CollectionFields<WithNamespace> | CollectionTemplates<WithNamespace>;
 export declare type TinaCloudCollectionBase = TinaCloudCollection<false>;
 export declare type TinaCloudCollectionEnriched = TinaCloudCollection<true>;
-declare type FormatType = 'json' | 'md' | 'markdown' | 'yml' | 'yaml';
+declare type FormatType = 'json' | 'md' | 'markdown' | 'mdx';
 interface BaseCollection {
     label: string;
     name: string;
@@ -59,7 +59,7 @@ interface CollectionFieldsInner<WithNamespace extends boolean> extends BaseColle
     fields: string | TinaFieldInner<WithNamespace>[];
     templates?: undefined;
 }
-export declare type TinaFieldInner<WithNamespace extends boolean> = ScalarType<WithNamespace> | ObjectType<WithNamespace> | ReferenceType<WithNamespace>;
+export declare type TinaFieldInner<WithNamespace extends boolean> = ScalarType<WithNamespace> | ObjectType<WithNamespace> | ReferenceType<WithNamespace> | RichType<WithNamespace>;
 export declare type TinaFieldBase = TinaFieldInner<false>;
 export declare type TinaFieldEnriched = TinaFieldInner<true>;
 interface TinaField {
@@ -107,6 +107,7 @@ declare type ImageField = {
     type: 'image';
 };
 export declare type ReferenceType<WithNamespace extends boolean> = WithNamespace extends true ? ReferenceTypeWithNamespace : ReferenceTypeInner;
+export declare type RichType<WithNamespace extends boolean> = WithNamespace extends true ? RichTypeWithNamespace : RichTypeInner;
 export interface ReferenceTypeInner extends TinaField {
     type: 'reference';
     reverseLookup?: {
@@ -124,6 +125,21 @@ export interface ReferenceTypeWithNamespace extends TinaField {
     };
     namespace: string[];
 }
+export interface RichTypeWithNamespace extends TinaField {
+    type: 'rich-text';
+    namespace: string[];
+    isBody?: boolean;
+    templates?: (string | (Template<true> & {
+        inline?: boolean;
+    }))[];
+}
+export interface RichTypeInner extends TinaField {
+    type: 'rich-text';
+    isBody?: boolean;
+    templates?: (string | (Template<false> & {
+        inline?: boolean;
+    }))[];
+}
 export declare type ObjectType<WithNamespace extends boolean> = ObjectTemplates<WithNamespace> | ObjectFields<WithNamespace>;
 declare type ObjectTemplates<WithNamespace extends boolean> = WithNamespace extends true ? ObjectTemplatesWithNamespace<WithNamespace> : ObjectTemplatesInner<WithNamespace>;
 interface ObjectTemplatesInner<WithNamespace extends boolean> extends TinaField {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tinacms/graphql",
-  "version": "0.55.0",
+  "version": "0.56.1",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "files": [
@@ -12,14 +12,35 @@
     "entryPoints": [
       {
         "name": "src/index.ts",
-        "target": "node"
+        "target": "node",
+        "bundle": [
+          "mdast",
+          "mdast-util-from-markdown",
+          "mdast-util-mdx",
+          "mdast-util-mdx-expression",
+          "mdast-util-to-markdown",
+          "micromark-extension-mdxjs",
+          "rehype-format",
+          "rehype-stringify",
+          "remark",
+          "remark-frontmatter",
+          "remark-mdx",
+          "remark-parse",
+          "remark-rehype",
+          "remark-slate",
+          "remark-stringify",
+          "unified",
+          "unist-util-remove-position",
+          "unist-util-visit",
+          "vfile"
+        ]
       }
     ]
   },
   "scripts": {
     "build": "yarn tsup src/index.ts --format cjs --dts",
     "watch": "yarn tsup src/index.ts --watch --format cjs --dts",
-    "types": "yarn tsc",
+    "types": "yarn tsc --project ./tsconfig.real.json",
     "docs": "yarn typedoc",
     "serve": "yarn nodemon dist/server.js",
     "test": "jest"
@@ -29,11 +50,17 @@
     "@octokit/graphql": "^4.5.6",
     "@octokit/rest": "18.0.6",
     "@types/aws-sdk": "^2.7.0",
+    "@types/estree": "^0.0.50",
+    "@types/mdast": "^3.0.10",
+    "@types/node": "^16.9.1",
     "aws-sdk": "^2.930.0",
     "body-parser": "^1.19.0",
     "cors": "^2.8.5",
     "dataloader": "^2.0.0",
     "date-fns": "^2.21.1",
+    "esbuild": "^0.12.25",
+    "esbuild-jest": "^0.5.0",
+    "estree-walker": "^3.0.0",
     "fast-glob": "^3.2.5",
     "fs-extra": "^9.0.1",
     "graphql": "^15.3.0",
@@ -42,19 +69,28 @@
     "js-yaml": "^3.14.0",
     "lodash": "^4.17.20",
     "lru-cache": "^6.0.0",
+    "mdast": "^3.0.0",
+    "mdast-util-from-markdown": "^1.0.0",
+    "mdast-util-mdx": "^1.1.0",
+    "mdast-util-mdx-expression": "^1.1.0",
+    "mdast-util-to-markdown": "^1.2.1",
+    "micromark-extension-mdxjs": "^1.0.0",
+    "mocha": "^9.1.1",
     "normalize-path": "^3.0.0",
     "prettier": "^2.2.1",
     "rehype-format": "^3.1.0",
     "rehype-stringify": "^8.0.0",
     "remark": "^13.0.0",
     "remark-frontmatter": "^3.0.0",
-    "remark-mdx": "2.0.0-next.8",
-    "remark-parse": "^8.0.2",
+    "remark-mdx": "next",
+    "remark-parse": "^10.0.0",
     "remark-rehype": "^8.0.0",
+    "remark-slate": "^1.8.0",
     "remark-stringify": "^8.1.1",
     "tslib": "^1.11.1",
-    "unified": "^9.2.0",
+    "unified": "^10.1.0",
     "unist-util-remove-position": "^3.0.0",
+    "unist-util-visit": "^4.0.0",
     "vfile": "^4.2.0",
     "ws": "^7.3.1",
     "yup": "^0.32.9"
@@ -68,7 +104,7 @@
   },
   "devDependencies": {
     "@graphql-tools/schema": "^6.2.1",
-    "@tinacms/scripts": "0.50.2",
+    "@tinacms/scripts": "0.50.3",
     "@types/cors": "^2.8.7",
     "@types/express": "^4.17.8",
     "@types/fs-extra": "^9.0.2",
@@ -84,6 +120,7 @@
     "graphql-tools": "^6.2.1",
     "jest": "27.0.6",
     "jest-diff": "27.0.6",
+    "jest-file-snapshot": "^0.5.0",
     "jest-matcher-utils": "27.0.6",
     "nodemon": "^2.0.4",
     "ts-jest": "27.0.3",