tinacms 1.4.0 → 1.4.1

package/dist/hooks/use-graphql-forms.d.ts

@@ -1,17 +1,5 @@
-/**
-
-*/
 import { Form } from '@tinacms/toolkit';
 import type { FormOptions, TinaCMS } from '@tinacms/toolkit';
-export declare const transformDocumentIntoMutationRequestPayload: (document: {
-    [key: string]: unknown;
-    _collection: string;
-    __typename?: string;
-    _template: string;
-}, instructions: {
-    includeCollection?: boolean;
-    includeTemplate?: boolean;
-}) => any;
 export declare const generateFormCreators: (cms: TinaCMS, showInSidebar?: boolean, global?: boolean | {
     icon?: any;
     layout: 'fullscreen' | 'popup';

package/dist/index.es.js

@@ -58,12 +58,18 @@ const IndexStatusResponse = z.object({
   ]).optional(),
   timestamp: z.number().optional()
 });
-async function asyncPoll(fn, pollInterval = 5 * 1e3, pollTimeout = 30 * 1e3) {
+function asyncPoll(fn, pollInterval = 5 * 1e3, pollTimeout = 30 * 1e3) {
   const endTime = new Date().getTime() + pollTimeout;
+  let stop = false;
+  const cancel = () => {
+    stop = true;
+  };
   const checkCondition = (resolve, reject) => {
     Promise.resolve(fn()).then((result) => {
       const now = new Date().getTime();
-      if (result.done) {
+      if (stop) {
+        reject(new Error("AsyncPoller: cancelled"));
+      } else if (result.done) {
         resolve(result.data);
       } else if (now < endTime) {
         setTimeout(checkCondition, pollInterval, resolve, reject);
@@ -74,7 +80,7 @@ async function asyncPoll(fn, pollInterval = 5 * 1e3, pollTimeout = 30 * 1e3) {
       reject(err);
     });
   };
-  return new Promise(checkCondition);
+  return [new Promise(checkCondition), cancel];
 }
 class Client {
   constructor({ tokenStorage = "MEMORY", ...options }) {
@@ -231,6 +237,13 @@ mutation addPendingDocumentMutation(
       if (resBody.message) {
         errorMessage = `${errorMessage}, Response: ${resBody.message}`;
       }
+      errorMessage = `${errorMessage}, Please check that the following information is correct: 
+	clientId: ${this.options.clientId}
+	branch: ${this.branch}.`;
+      if (this.branch !== "main") {
+        errorMessage = `${errorMessage}
+	Note: This error can occur if the branch does not exist on GitHub or on Tina Cloud`;
+      }
       throw new Error(errorMessage);
     }
     const json = await res.json();
@@ -376,15 +389,15 @@ mutation addPendingDocumentMutation(
       return null;
     }
   }
-  async waitForIndexStatus({ ref }) {
+  waitForIndexStatus({ ref }) {
     try {
-      const result = await asyncPoll(async () => {
+      const [prom, cancel] = asyncPoll(async () => {
         try {
-          const result2 = await this.getIndexStatus({ ref });
-          if (!(result2.status === "inprogress" || result2.status === "unknown")) {
+          const result = await this.getIndexStatus({ ref });
+          if (!(result.status === "inprogress" || result.status === "unknown")) {
             return Promise.resolve({
               done: true,
-              data: result2
+              data: result
             });
           } else {
             return Promise.resolve({
@@ -395,7 +408,7 @@ mutation addPendingDocumentMutation(
           return Promise.reject(err);
         }
       }, 5e3, 9e5);
-      return result;
+      return [prom, cancel];
     } catch (error) {
       if (error.message === "AsyncPoller: reached timeout") {
         console.warn(error);
@@ -3612,42 +3625,6 @@ const RenameModal = ({
 function HiChevronRight(props) {
   return GenIcon({ "tag": "svg", "attr": { "viewBox": "0 0 20 20", "fill": "currentColor" }, "child": [{ "tag": "path", "attr": { "fillRule": "evenodd", "d": "M7.293 14.707a1 1 0 010-1.414L10.586 10 7.293 6.707a1 1 0 011.414-1.414l4 4a1 1 0 010 1.414l-4 4a1 1 0 01-1.414 0z", "clipRule": "evenodd" } }] })(props);
 }
-const transformDocumentIntoMutationRequestPayload = (document, instructions) => {
-  const { _collection, __typename, _template, ...rest } = document;
-  const params = transformParams(rest);
-  const paramsWithTemplate = instructions.includeTemplate ? { [_template]: params } : params;
-  return instructions.includeCollection ? { [_collection]: paramsWithTemplate } : paramsWithTemplate;
-};
-const transformParams = (data) => {
-  if (["string", "number", "boolean"].includes(typeof data)) {
-    return data;
-  }
-  if (Array.isArray(data)) {
-    return data.map((item) => transformParams(item));
-  }
-  try {
-    assertShape(data, (yup2) => yup2.object({ _template: yup2.string().required() }));
-    const { _template, __typename, ...rest } = data;
-    const nested = transformParams(rest);
-    return { [_template]: nested };
-  } catch (e) {
-    if (e.message === "Failed to assertShape - _template is a required field") {
-      if (!data) {
-        return [];
-      }
-      const accum = {};
-      Object.entries(data).map(([keyName, value]) => {
-        accum[keyName] = transformParams(value);
-      });
-      return accum;
-    } else {
-      if (!data) {
-        return [];
-      }
-      throw e;
-    }
-  }
-};
 function FaLock(props) {
   return GenIcon({ "tag": "svg", "attr": { "viewBox": "0 0 448 512" }, "child": [{ "tag": "path", "attr": { "d": "M400 224h-24v-72C376 68.2 307.8 0 224 0S72 68.2 72 152v72H48c-26.5 0-48 21.5-48 48v192c0 26.5 21.5 48 48 48h352c26.5 0 48-21.5 48-48V272c0-26.5-21.5-48-48-48zm-104 0H152v-72c0-39.7 32.3-72 72-72s72 32.3 72 72v72z" } }] })(props);
 }
@@ -3657,15 +3634,11 @@ function FaUnlock(props) {
 const createDocument = async (cms, collection, template, mutationInfo, values) => {
   const api = new TinaAdminApi(cms);
   const { filename, ...leftover } = values;
-  const { includeCollection, includeTemplate } = mutationInfo;
   const relativePath = `${filename}.${collection.format}`;
-  const params = transformDocumentIntoMutationRequestPayload({
+  const params = api.schema.transformPayload(collection.name, {
     _collection: collection.name,
     ...template && { _template: template.name },
     ...leftover
-  }, {
-    includeCollection,
-    includeTemplate
   });
   if (await api.isAuthenticated()) {
     await api.createDocument(collection.name, relativePath, params);
@@ -3880,11 +3853,7 @@ const GetDocument = ({
 };
 const updateDocument = async (cms, relativePath, collection, mutationInfo, values) => {
   const api = new TinaAdminApi(cms);
-  const { includeCollection, includeTemplate } = mutationInfo;
-  const params = transformDocumentIntoMutationRequestPayload(values, {
-    includeCollection,
-    includeTemplate
-  });
+  const params = api.schema.transformPayload(collection.name, values);
   if (await api.isAuthenticated()) {
     await api.updateDocument(collection.name, relativePath, params);
   } else {

package/dist/index.js

@@ -73,12 +73,18 @@
     ]).optional(),
     timestamp: zod.z.number().optional()
   });
-  async function asyncPoll(fn, pollInterval = 5 * 1e3, pollTimeout = 30 * 1e3) {
+  function asyncPoll(fn, pollInterval = 5 * 1e3, pollTimeout = 30 * 1e3) {
     const endTime = new Date().getTime() + pollTimeout;
+    let stop = false;
+    const cancel = () => {
+      stop = true;
+    };
     const checkCondition = (resolve, reject) => {
       Promise.resolve(fn()).then((result) => {
         const now = new Date().getTime();
-        if (result.done) {
+        if (stop) {
+          reject(new Error("AsyncPoller: cancelled"));
+        } else if (result.done) {
           resolve(result.data);
         } else if (now < endTime) {
           setTimeout(checkCondition, pollInterval, resolve, reject);
@@ -89,7 +95,7 @@
         reject(err);
       });
     };
-    return new Promise(checkCondition);
+    return [new Promise(checkCondition), cancel];
   }
   class Client {
     constructor({ tokenStorage = "MEMORY", ...options }) {
@@ -246,6 +252,13 @@ mutation addPendingDocumentMutation(
         if (resBody.message) {
           errorMessage = `${errorMessage}, Response: ${resBody.message}`;
         }
+        errorMessage = `${errorMessage}, Please check that the following information is correct: 
+	clientId: ${this.options.clientId}
+	branch: ${this.branch}.`;
+        if (this.branch !== "main") {
+          errorMessage = `${errorMessage}
+	Note: This error can occur if the branch does not exist on GitHub or on Tina Cloud`;
+        }
         throw new Error(errorMessage);
       }
       const json = await res.json();
@@ -391,15 +404,15 @@ mutation addPendingDocumentMutation(
         return null;
       }
     }
-    async waitForIndexStatus({ ref }) {
+    waitForIndexStatus({ ref }) {
       try {
-        const result = await asyncPoll(async () => {
+        const [prom, cancel] = asyncPoll(async () => {
           try {
-            const result2 = await this.getIndexStatus({ ref });
-            if (!(result2.status === "inprogress" || result2.status === "unknown")) {
+            const result = await this.getIndexStatus({ ref });
+            if (!(result.status === "inprogress" || result.status === "unknown")) {
               return Promise.resolve({
                 done: true,
-                data: result2
+                data: result
               });
             } else {
               return Promise.resolve({
@@ -410,7 +423,7 @@ mutation addPendingDocumentMutation(
             return Promise.reject(err);
           }
         }, 5e3, 9e5);
-        return result;
+        return [prom, cancel];
       } catch (error) {
         if (error.message === "AsyncPoller: reached timeout") {
           console.warn(error);
@@ -3627,42 +3640,6 @@ This will work when developing locally but NOT when deployed to production.
   function HiChevronRight(props) {
     return GenIcon({ "tag": "svg", "attr": { "viewBox": "0 0 20 20", "fill": "currentColor" }, "child": [{ "tag": "path", "attr": { "fillRule": "evenodd", "d": "M7.293 14.707a1 1 0 010-1.414L10.586 10 7.293 6.707a1 1 0 011.414-1.414l4 4a1 1 0 010 1.414l-4 4a1 1 0 01-1.414 0z", "clipRule": "evenodd" } }] })(props);
   }
-  const transformDocumentIntoMutationRequestPayload = (document, instructions) => {
-    const { _collection, __typename, _template, ...rest } = document;
-    const params = transformParams(rest);
-    const paramsWithTemplate = instructions.includeTemplate ? { [_template]: params } : params;
-    return instructions.includeCollection ? { [_collection]: paramsWithTemplate } : paramsWithTemplate;
-  };
-  const transformParams = (data) => {
-    if (["string", "number", "boolean"].includes(typeof data)) {
-      return data;
-    }
-    if (Array.isArray(data)) {
-      return data.map((item) => transformParams(item));
-    }
-    try {
-      assertShape(data, (yup2) => yup2.object({ _template: yup2.string().required() }));
-      const { _template, __typename, ...rest } = data;
-      const nested = transformParams(rest);
-      return { [_template]: nested };
-    } catch (e) {
-      if (e.message === "Failed to assertShape - _template is a required field") {
-        if (!data) {
-          return [];
-        }
-        const accum = {};
-        Object.entries(data).map(([keyName, value]) => {
-          accum[keyName] = transformParams(value);
-        });
-        return accum;
-      } else {
-        if (!data) {
-          return [];
-        }
-        throw e;
-      }
-    }
-  };
   function FaLock(props) {
     return GenIcon({ "tag": "svg", "attr": { "viewBox": "0 0 448 512" }, "child": [{ "tag": "path", "attr": { "d": "M400 224h-24v-72C376 68.2 307.8 0 224 0S72 68.2 72 152v72H48c-26.5 0-48 21.5-48 48v192c0 26.5 21.5 48 48 48h352c26.5 0 48-21.5 48-48V272c0-26.5-21.5-48-48-48zm-104 0H152v-72c0-39.7 32.3-72 72-72s72 32.3 72 72v72z" } }] })(props);
   }
@@ -3672,15 +3649,11 @@ This will work when developing locally but NOT when deployed to production.
   const createDocument = async (cms, collection, template, mutationInfo, values) => {
     const api = new TinaAdminApi(cms);
     const { filename, ...leftover } = values;
-    const { includeCollection, includeTemplate } = mutationInfo;
     const relativePath = `${filename}.${collection.format}`;
-    const params = transformDocumentIntoMutationRequestPayload({
+    const params = api.schema.transformPayload(collection.name, {
       _collection: collection.name,
       ...template && { _template: template.name },
       ...leftover
-    }, {
-      includeCollection,
-      includeTemplate
     });
     if (await api.isAuthenticated()) {
       await api.createDocument(collection.name, relativePath, params);
@@ -3895,11 +3868,7 @@ This will work when developing locally but NOT when deployed to production.
   };
   const updateDocument = async (cms, relativePath, collection, mutationInfo, values) => {
     const api = new TinaAdminApi(cms);
-    const { includeCollection, includeTemplate } = mutationInfo;
-    const params = transformDocumentIntoMutationRequestPayload(values, {
-      includeCollection,
-      includeTemplate
-    });
+    const params = api.schema.transformPayload(collection.name, values);
     if (await api.isAuthenticated()) {
       await api.updateDocument(collection.name, relativePath, params);
     } else {

package/dist/internalClient/index.d.ts

@@ -105,7 +105,7 @@ pollInterval?: number,
  *
  * Default 30 seconds.
  */
-pollTimeout?: number): Promise<T>;
+pollTimeout?: number): ((() => void) | Promise<T>)[];
 export declare class Client {
     onLogin?: OnLoginFunc;
     onLogout?: () => Promise<void>;
@@ -202,7 +202,9 @@ export declare class Client {
     }>;
     waitForIndexStatus({ ref }: {
         ref: string;
-    }): Promise<any>;
+    }): (Promise<any> | (() => void))[] | {
+        status: string;
+    };
     getIndexStatus({ ref }: {
         ref: string;
     }): Promise<{

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tinacms",
-  "version": "1.4.0",
+  "version": "1.4.1",
   "main": "dist/index.js",
   "module": "./dist/index.es.js",
   "exports": {
@@ -56,9 +56,9 @@
     "@headlessui/react": "^1.5.0",
     "@heroicons/react": "^1.0.4",
     "@react-hook/window-size": "^3.0.7",
-    "@tinacms/schema-tools": "1.4.0",
+    "@tinacms/schema-tools": "1.4.1",
     "@tinacms/sharedctx": "1.0.1",
-    "@tinacms/toolkit": "1.6.0",
+    "@tinacms/toolkit": "1.6.1",
     "crypto-js": "^4.0.0",
     "encoding": "0.1.13",
     "fetch-ponyfill": "^7.1.0",