tinacms 0.0.0-9db4961-20250328182422 → 0.0.0-9e33054-20250728033205

package/dist/internalClient/index.d.ts

@@ -1,10 +1,10 @@
-import { TokenObject } from '../auth/authenticate';
 import { BranchData, EventBus } from '@tinacms/toolkit';
 import { DocumentNode, GraphQLSchema } from 'graphql';
+import { TokenObject } from '../auth/authenticate';
+import { AuthProvider, Schema, TinaSchema } from '@tinacms/schema-tools';
+import { SearchClient } from '@tinacms/search/dist/index-client';
 import gql from 'graphql-tag';
-import { TinaSchema, Schema, AuthProvider } from '@tinacms/schema-tools';
 import { TinaCloudProject } from './types';
-import { SearchClient } from '@tinacms/search/dist/index-client';
 export * from './authProvider';
 export type OnLoginFunc = (args: {
     token?: TokenObject;
@@ -141,6 +141,26 @@ export declare class Client {
     }[]>;
     usingProtectedBranch(): boolean;
     createBranch({ baseBranch, branchName }: BranchData): Promise<string>;
+    getLatestVersion(): Promise<LatestVersionResponse>;
+    /**
+     * Initiate and poll for the results of an editorial workflow operation
+     *
+     * @param options Editorial workflow options
+     * @returns Object with branch and PR info when complete
+     */
+    executeEditorialWorkflow(options: {
+        branchName: string;
+        baseBranch: string;
+        prTitle?: string;
+        graphQLContentOp?: {
+            query: string;
+            variables: Record<string, unknown>;
+        };
+        onStatusUpdate?: (status: {
+            status: string;
+            message?: string;
+        }) => void;
+    }): Promise<any>;
 }
 export declare const DEFAULT_LOCAL_TINA_GQL_SERVER_URL = "http://localhost:4001/graphql";
 export declare class LocalClient extends Client {
@@ -185,3 +205,8 @@ export declare class LocalSearchClient implements SearchClient {
     put(docs: any[]): Promise<any>;
     supportsClientSideIndexing(): boolean;
 }
+export type PackageVersionInfo = {
+    version: string;
+    publishedAt: string;
+};
+export type LatestVersionResponse = Record<string, PackageVersionInfo>;

package/dist/react.d.ts

@@ -1 +1,41 @@
-export * from "../src/react"
+export declare function useTina<T extends object>(props: {
+    query: string;
+    variables: object;
+    data: T;
+    experimental___selectFormByFormId?: () => string | false | undefined;
+}): {
+    data: T;
+    isClient: boolean;
+};
+export declare function useEditState(): {
+    edit: boolean;
+};
+/**
+ * Grab the field name for the given attribute
+ * to signal to Tina which DOM element the field
+ * is working with.
+ */
+/**
+ * Generate a field identifier for Tina to associate DOM elements with form fields.
+ * Format: "queryId---path.to.field" or "queryId---path.to.array.index"
+ */
+export declare const tinaField: <T extends {
+    _content_source?: {
+        queryId: string;
+        path: (number | string)[];
+    };
+} | Record<string, unknown> | null | undefined>(object: T, property?: keyof Omit<NonNullable<T>, "__typename" | "_sys">, index?: number) => string;
+/**
+ * FIX: This function is updated to be more robust. It explicitly checks for
+ * `null` and `String` objects to prevent them from being processed as
+ * iterable objects, which is the root cause of the "Objects are not valid
+ * as a React child" error.
+ */
+export declare const addMetadata: <T extends object>(id: string, obj: T, path?: (string | number)[]) => T;
+/**
+ * This is a pretty rudimentary approach to hashing the query and variables to
+ * ensure we treat multiple queries on the page uniquely. It's possible
+ * that we would have collisions, and I'm not sure of the likeliness but seems
+ * like it'd be rare.
+ */
+export declare const hashFromQuery: (input: string) => string;

package/dist/react.js

@@ -11,17 +11,23 @@
       () => hashFromQuery(stringifiedQuery),
       [stringifiedQuery]
     );
-    const [data, setData] = React.useState(props.data);
+    const processedData = React.useMemo(() => {
+      if (props.data) {
+        const dataCopy = JSON.parse(JSON.stringify(props.data));
+        return addMetadata(id, dataCopy, []);
+      }
+    }, [props.data, id]);
+    const [data, setData] = React.useState(processedData);
     const [isClient, setIsClient] = React.useState(false);
     const [quickEditEnabled, setQuickEditEnabled] = React.useState(false);
     const [isInTinaIframe, setIsInTinaIframe] = React.useState(false);
     React.useEffect(() => {
       setIsClient(true);
-      setData(props.data);
+      setData(processedData);
       parent.postMessage({
         type: "url-changed"
       });
-    }, [id]);
+    }, [id, processedData]);
     React.useEffect(() => {
       if (quickEditEnabled) {
         let mouseDownHandler = function(e) {
@@ -113,12 +119,18 @@
     React.useEffect(() => {
       const { experimental___selectFormByFormId, ...rest } = props;
       parent.postMessage({ type: "open", ...rest, id }, window.location.origin);
-      window.addEventListener("message", (event) => {
+      const handleMessage = (event) => {
         if (event.data.type === "quickEditEnabled") {
           setQuickEditEnabled(event.data.value);
         }
         if (event.data.id === id && event.data.type === "updateData") {
-          setData(event.data.data);
+          const rawData = event.data.data;
+          const newlyProcessedData = addMetadata(
+            id,
+            JSON.parse(JSON.stringify(rawData)),
+            []
+          );
+          setData(newlyProcessedData);
           setIsInTinaIframe(true);
           const anyTinaField = document.querySelector("[data-tina-field]");
           if (anyTinaField) {
@@ -133,8 +145,10 @@
             );
           }
         }
-      });
+      };
+      window.addEventListener("message", handleMessage);
       return () => {
+        window.removeEventListener("message", handleMessage);
         parent.postMessage({ type: "close", id }, window.location.origin);
       };
     }, [id, setQuickEditEnabled]);
@@ -156,59 +170,53 @@
     return { edit };
   }
   const tinaField = (object, property, index) => {
-    var _a, _b, _c;
-    if (!object) {
+    const contentSource = object == null ? void 0 : object._content_source;
+    if (!contentSource) {
       return "";
     }
-    if (object._content_source) {
-      if (!property) {
-        return [
-          (_a = object._content_source) == null ? void 0 : _a.queryId,
-          object._content_source.path.join(".")
-        ].join("---");
-      }
-      if (typeof index === "number") {
-        return [
-          (_b = object._content_source) == null ? void 0 : _b.queryId,
-          [...object._content_source.path, property, index].join(".")
-        ].join("---");
-      }
-      return [
-        (_c = object._content_source) == null ? void 0 : _c.queryId,
-        [...object._content_source.path, property].join(".")
-      ].join("---");
+    const { queryId, path } = contentSource;
+    if (!property) {
+      return `${queryId}---${path.join(".")}`;
     }
-    return "";
+    const fullPath = typeof index === "number" ? [...path, property, index] : [...path, property];
+    return `${queryId}---${fullPath.join(".")}`;
   };
-  const addMetadata = (id, object, path) => {
-    Object.entries(object).forEach(([key, value]) => {
-      if (Array.isArray(value)) {
-        value.forEach((item, index) => {
-          if (isScalarOrUndefined(item)) {
-            return;
-          }
-          if (Array.isArray(item)) {
-            return;
-          }
-          const itemObject = item;
-          addMetadata(id, itemObject, [...path, key, index]);
-        });
+  const addMetadata = (id, obj, path = []) => {
+    if (obj === null) {
+      return obj;
+    }
+    if (isScalarOrUndefined(obj)) {
+      return obj;
+    }
+    if (obj instanceof String) {
+      return obj.valueOf();
+    }
+    if (Array.isArray(obj)) {
+      return obj.map(
+        (item, index) => addMetadata(id, item, [...path, index])
+      );
+    }
+    const transformedObj = {};
+    for (const [key, value] of Object.entries(obj)) {
+      const currentPath = [...path, key];
+      if ([
+        "__typename",
+        "_sys",
+        "_internalSys",
+        "_values",
+        "_internalValues",
+        "_content_source",
+        "_tina_metadata"
+      ].includes(key)) {
+        transformedObj[key] = value;
       } else {
-        if (isScalarOrUndefined(value)) {
-          return;
-        }
-        const itemObject = value;
-        addMetadata(id, itemObject, [...path, key]);
+        transformedObj[key] = addMetadata(id, value, currentPath);
       }
-    });
-    if ((object == null ? void 0 : object.type) === "root") {
-      return;
     }
-    object._content_source = {
-      queryId: id,
-      path
-    };
-    return object;
+    if (transformedObj && typeof transformedObj === "object" && "type" in transformedObj && transformedObj.type === "root") {
+      return transformedObj;
+    }
+    return { ...transformedObj, _content_source: { queryId: id, path } };
   };
   function isScalarOrUndefined(value) {
     const type = typeof value;

package/dist/react.mjs

@@ -8,17 +8,23 @@ function useTina(props) {
     () => hashFromQuery(stringifiedQuery),
     [stringifiedQuery]
   );
-  const [data, setData] = React.useState(props.data);
+  const processedData = React.useMemo(() => {
+    if (props.data) {
+      const dataCopy = JSON.parse(JSON.stringify(props.data));
+      return addMetadata(id, dataCopy, []);
+    }
+  }, [props.data, id]);
+  const [data, setData] = React.useState(processedData);
   const [isClient, setIsClient] = React.useState(false);
   const [quickEditEnabled, setQuickEditEnabled] = React.useState(false);
   const [isInTinaIframe, setIsInTinaIframe] = React.useState(false);
   React.useEffect(() => {
     setIsClient(true);
-    setData(props.data);
+    setData(processedData);
     parent.postMessage({
       type: "url-changed"
     });
-  }, [id]);
+  }, [id, processedData]);
   React.useEffect(() => {
     if (quickEditEnabled) {
       let mouseDownHandler = function(e) {
@@ -110,12 +116,18 @@ function useTina(props) {
   React.useEffect(() => {
     const { experimental___selectFormByFormId, ...rest } = props;
     parent.postMessage({ type: "open", ...rest, id }, window.location.origin);
-    window.addEventListener("message", (event) => {
+    const handleMessage = (event) => {
       if (event.data.type === "quickEditEnabled") {
         setQuickEditEnabled(event.data.value);
       }
       if (event.data.id === id && event.data.type === "updateData") {
-        setData(event.data.data);
+        const rawData = event.data.data;
+        const newlyProcessedData = addMetadata(
+          id,
+          JSON.parse(JSON.stringify(rawData)),
+          []
+        );
+        setData(newlyProcessedData);
         setIsInTinaIframe(true);
         const anyTinaField = document.querySelector("[data-tina-field]");
         if (anyTinaField) {
@@ -130,8 +142,10 @@ function useTina(props) {
           );
         }
       }
-    });
+    };
+    window.addEventListener("message", handleMessage);
     return () => {
+      window.removeEventListener("message", handleMessage);
       parent.postMessage({ type: "close", id }, window.location.origin);
     };
   }, [id, setQuickEditEnabled]);
@@ -153,59 +167,53 @@ function useEditState() {
   return { edit };
 }
 const tinaField = (object, property, index) => {
-  var _a, _b, _c;
-  if (!object) {
+  const contentSource = object == null ? void 0 : object._content_source;
+  if (!contentSource) {
     return "";
   }
-  if (object._content_source) {
-    if (!property) {
-      return [
-        (_a = object._content_source) == null ? void 0 : _a.queryId,
-        object._content_source.path.join(".")
-      ].join("---");
-    }
-    if (typeof index === "number") {
-      return [
-        (_b = object._content_source) == null ? void 0 : _b.queryId,
-        [...object._content_source.path, property, index].join(".")
-      ].join("---");
-    }
-    return [
-      (_c = object._content_source) == null ? void 0 : _c.queryId,
-      [...object._content_source.path, property].join(".")
-    ].join("---");
+  const { queryId, path } = contentSource;
+  if (!property) {
+    return `${queryId}---${path.join(".")}`;
   }
-  return "";
+  const fullPath = typeof index === "number" ? [...path, property, index] : [...path, property];
+  return `${queryId}---${fullPath.join(".")}`;
 };
-const addMetadata = (id, object, path) => {
-  Object.entries(object).forEach(([key, value]) => {
-    if (Array.isArray(value)) {
-      value.forEach((item, index) => {
-        if (isScalarOrUndefined(item)) {
-          return;
-        }
-        if (Array.isArray(item)) {
-          return;
-        }
-        const itemObject = item;
-        addMetadata(id, itemObject, [...path, key, index]);
-      });
+const addMetadata = (id, obj, path = []) => {
+  if (obj === null) {
+    return obj;
+  }
+  if (isScalarOrUndefined(obj)) {
+    return obj;
+  }
+  if (obj instanceof String) {
+    return obj.valueOf();
+  }
+  if (Array.isArray(obj)) {
+    return obj.map(
+      (item, index) => addMetadata(id, item, [...path, index])
+    );
+  }
+  const transformedObj = {};
+  for (const [key, value] of Object.entries(obj)) {
+    const currentPath = [...path, key];
+    if ([
+      "__typename",
+      "_sys",
+      "_internalSys",
+      "_values",
+      "_internalValues",
+      "_content_source",
+      "_tina_metadata"
+    ].includes(key)) {
+      transformedObj[key] = value;
     } else {
-      if (isScalarOrUndefined(value)) {
-        return;
-      }
-      const itemObject = value;
-      addMetadata(id, itemObject, [...path, key]);
+      transformedObj[key] = addMetadata(id, value, currentPath);
     }
-  });
-  if ((object == null ? void 0 : object.type) === "root") {
-    return;
   }
-  object._content_source = {
-    queryId: id,
-    path
-  };
-  return object;
+  if (transformedObj && typeof transformedObj === "object" && "type" in transformedObj && transformedObj.type === "root") {
+    return transformedObj;
+  }
+  return { ...transformedObj, _content_source: { queryId: id, path } };
 };
 function isScalarOrUndefined(value) {
   const type = typeof value;

package/dist/rich-text/index.d.ts

@@ -1 +1,142 @@
-export * from "../../src/rich-text/index"
+/**
+
+*/
+import React from 'react';
+type BaseComponents = {
+    h1?: {
+        children: JSX.Element;
+    };
+    h2?: {
+        children: JSX.Element;
+    };
+    h3?: {
+        children: JSX.Element;
+    };
+    h4?: {
+        children: JSX.Element;
+    };
+    h5?: {
+        children: JSX.Element;
+    };
+    h6?: {
+        children: JSX.Element;
+    };
+    p?: {
+        children: JSX.Element;
+    };
+    a?: {
+        url: string;
+        children: JSX.Element;
+    };
+    italic?: {
+        children: JSX.Element;
+    };
+    bold?: {
+        children: JSX.Element;
+    };
+    strikethrough?: {
+        children: JSX.Element;
+    };
+    underline?: {
+        children: JSX.Element;
+    };
+    code?: {
+        children: JSX.Element;
+    };
+    text?: {
+        children: string;
+    };
+    ul?: {
+        children: JSX.Element;
+    };
+    ol?: {
+        children: JSX.Element;
+    };
+    li?: {
+        children: JSX.Element;
+    };
+    lic?: {
+        children: JSX.Element;
+    };
+    block_quote?: {
+        children: JSX.Element;
+    };
+    code_block?: {
+        lang?: string;
+        value: string;
+    };
+    mermaid?: {
+        value: string;
+    };
+    img?: {
+        url: string;
+        caption?: string;
+        alt?: string;
+    };
+    hr?: {};
+    break?: {};
+    maybe_mdx?: {
+        children: JSX.Element;
+    };
+    html?: {
+        value: string;
+    };
+    html_inline?: {
+        value: string;
+    };
+    table?: {
+        align?: ('left' | 'right' | 'center')[];
+        tableRows: {
+            tableCells: {
+                value: TinaMarkdownContent;
+            }[];
+        }[];
+    };
+    component_missing?: {
+        name: string;
+    };
+};
+type BaseComponentSignature = {
+    [BK in keyof BaseComponents]: (props: BaseComponents[BK]) => JSX.Element;
+};
+/**
+ * Define the allowed components and their props
+ * ```ts
+ * const components:
+ * Components<{
+ *  BlockQuote: {
+ *      children: TinaMarkdownContent;
+ *      authorName: string;
+ *    };
+ *  }> = {
+ *    BlockQuote: (props: {
+ *      children: TinaMarkdownContent;
+ *      authorName: string;
+ *    }) => {
+ *      return (
+ *        <div>
+ *          <blockquote>
+ *            <TinaMarkdown content={props.children} />
+ *            {props.authorName}
+ *          </blockquote>
+ *        </div>
+ *      );
+ *    }
+ *  }
+ * }
+ * ```
+ */
+export type Components<ComponentAndProps extends object> = {
+    [K in keyof ComponentAndProps]: (props: ComponentAndProps[K]) => JSX.Element;
+} & BaseComponentSignature;
+export type TinaMarkdownContent = {
+    type: string;
+    children: TinaMarkdownContent[];
+};
+export declare const TinaMarkdown: <CustomComponents extends {
+    [key: string]: object;
+} = any>({ content, components, }: {
+    content: TinaMarkdownContent | TinaMarkdownContent[];
+    components?: Components<{}> | Components<{ [BK in keyof CustomComponents]: (props: CustomComponents[BK]) => JSX.Element; }>;
+}) => React.JSX.Element;
+export {};

package/dist/rich-text/index.js

@@ -117,17 +117,23 @@
           // @ts-ignore FIXME: TinaMarkdownContent needs to be a union of all possible node types
           /* @__PURE__ */ React.createElement("a", { href: child.url }, /* @__PURE__ */ React.createElement(TinaMarkdown, { components, content: children }))
         );
-      case "mermaid":
       case "code_block": {
-        const value = child.value;
+        let codeString = "";
+        if (Array.isArray(child.children)) {
+          codeString = child.children.map(
+            (line) => Array.isArray(line.children) ? line.children.map((t) => t.text).join("") : ""
+          ).join("\n");
+        } else if (typeof child.value === "string") {
+          codeString = child.value;
+        }
         if (components[child.type]) {
           const Component2 = components[child.type];
           return (
             // @ts-ignore FIXME: TinaMarkdownContent needs to be a union of all possible node types
-            /* @__PURE__ */ React.createElement(Component2, { ...props })
+            /* @__PURE__ */ React.createElement(Component2, { ...props, value: codeString })
           );
         }
-        return /* @__PURE__ */ React.createElement("pre", null, /* @__PURE__ */ React.createElement("code", null, value));
+        return /* @__PURE__ */ React.createElement("pre", null, /* @__PURE__ */ React.createElement("code", null, codeString));
       }
       case "hr":
         if (components[child.type]) {

package/dist/rich-text/index.mjs

@@ -114,17 +114,23 @@ const Node = ({ components, child }) => {
         // @ts-ignore FIXME: TinaMarkdownContent needs to be a union of all possible node types
         /* @__PURE__ */ React.createElement("a", { href: child.url }, /* @__PURE__ */ React.createElement(TinaMarkdown, { components, content: children }))
       );
-    case "mermaid":
     case "code_block": {
-      const value = child.value;
+      let codeString = "";
+      if (Array.isArray(child.children)) {
+        codeString = child.children.map(
+          (line) => Array.isArray(line.children) ? line.children.map((t) => t.text).join("") : ""
+        ).join("\n");
+      } else if (typeof child.value === "string") {
+        codeString = child.value;
+      }
       if (components[child.type]) {
         const Component2 = components[child.type];
         return (
           // @ts-ignore FIXME: TinaMarkdownContent needs to be a union of all possible node types
-          /* @__PURE__ */ React.createElement(Component2, { ...props })
+          /* @__PURE__ */ React.createElement(Component2, { ...props, value: codeString })
         );
       }
-      return /* @__PURE__ */ React.createElement("pre", null, /* @__PURE__ */ React.createElement("code", null, value));
+      return /* @__PURE__ */ React.createElement("pre", null, /* @__PURE__ */ React.createElement("code", null, codeString));
     }
     case "hr":
       if (components[child.type]) {

package/dist/rich-text/prism.d.ts

@@ -1 +1,10 @@
-export * from "../../src/rich-text/prism"
+/**
+
+*/
+import React from 'react';
+import { themes } from 'prism-react-renderer';
+export declare const Prism: (props: {
+    value: string;
+    lang?: string;
+    theme?: keyof typeof themes;
+}) => React.JSX.Element;

package/dist/rich-text/prism.js

@@ -7,7 +7,7 @@
       prismReactRenderer.Highlight,
       {
         theme: prismReactRenderer.themes[props.theme || "github"],
-        code: props.value,
+        code: props.value || "",
         language: props.lang || ""
       },
       ({ className, style, tokens, getLineProps, getTokenProps }) => /* @__PURE__ */ React.createElement("pre", { className, style }, tokens.map((line, i) => /* @__PURE__ */ React.createElement("div", { ...getLineProps({ line, key: i }) }, line.map((token, key) => /* @__PURE__ */ React.createElement("span", { ...getTokenProps({ token, key }) })))))

package/dist/rich-text/prism.mjs

@@ -5,7 +5,7 @@ const Prism = (props) => {
     Highlight,
     {
       theme: themes[props.theme || "github"],
-      code: props.value,
+      code: props.value || "",
       language: props.lang || ""
     },
     ({ className, style, tokens, getLineProps, getTokenProps }) => /* @__PURE__ */ React.createElement("pre", { className, style }, tokens.map((line, i) => /* @__PURE__ */ React.createElement("div", { ...getLineProps({ line, key: i }) }, line.map((token, key) => /* @__PURE__ */ React.createElement("span", { ...getTokenProps({ token, key }) })))))