tinacms 0.60.2 → 0.63.0

package/CHANGELOG.md

@@ -1,5 +1,68 @@
 # tinacms
 
+## 0.63.0
+
+### Minor Changes
+
+- 3897ec5d9: Replace `branch`, `clientId`, `isLocalClient` props with single `apiURL`. When working locally, this should be `http://localhost:4001/graphql`. For Tina Cloud, use `https://content.tinajs.io/content/<my-client-id>/github/<my-branch>`
+
+  ```tsx
+  // _app.tsx
+  // ...
+  <TinaCMS apiURL={process.env.NEXT_PUBLIC_TINA_API_URL} {...pageProps}>
+    {livePageProps => <Component {...livePageProps} />}
+  </TinaCMS>
+  ```
+
+  DEPRECATION NOTICE: `branch`, `clientId`, `isLocalClient` props will be deprecated in the future
+
+### Patch Changes
+
+- 96e4a77e2: Fixed types
+- b5c22503a: Changes messaging on login page for TinaAdmin when in local-mode
+- Updated dependencies [60f939f34]
+  - @tinacms/toolkit@0.56.6
+
+## 0.62.0
+
+### Minor Changes
+
+- 70da62fe8: deprecated the use of `getStaticPropsForTina`
+
+### Patch Changes
+
+- 0afa75df1: 2342 - [TinaAdmin] Truncates the `filename` column for the Document List View
+- 7dafce89d: Fixed issue where content creator was invalid
+- 3de8c6165: Enabled branch creation in branch switcher
+- fee183f8f: add "switch to default branch" recover option to error boundary
+- 5c070a83f: feat: Add UI banner for when in localMode
+- Updated dependencies [ddf81a4fd]
+- Updated dependencies [20260a82d]
+- Updated dependencies [0370147fb]
+- Updated dependencies [3de8c6165]
+- Updated dependencies [2eaad97bf]
+- Updated dependencies [5c070a83f]
+  - @tinacms/toolkit@0.56.5
+
+## 0.61.1
+
+### Patch Changes
+
+- Updated dependencies [2c7718636]
+  - @tinacms/toolkit@0.56.4
+
+## 0.61.0
+
+### Minor Changes
+
+- 229feda1d: add .nvmrc file for setting preferred node version
+
+## 0.60.3
+
+### Patch Changes
+
+- 4adaf15af: Fix types which weren't included in previous patch
+
 ## 0.60.2
 
 ### Patch Changes

package/README.md

@@ -1,289 +1,4 @@
-> Heads up - if you haven't already done so, read through the [CLI documentation](https://tina.io/docs/tina-cloud/cli/) to make sure you have a GraphQL server running locally.
+# TinaCMS
+> The Fastest Way to Edit Next.js Content
 
-For a real-world example of how this is being used checkout the [Tina Cloud Starter](https://github.com/tinacms/tina-cloud-starter).
-
-## Getting started
-
-Npm:
-
-```bash
-npm install --save-dev tinacms
-```
-
-Yarn:
-
-```bash
-yarn add --dev tinacms
-```
-
-## The TinaCMS API Client
-
-This package exports a class which acts as [TinaCMS external API](https://tina.io/docs/apis/) for the Tina Content API. This is a headless GraphQL API that's serverd via Tina Cloud or locally from within the Tina CLI.
-
-```ts
-import { Client, LocalClient } from "tinacms";
-const client = new Client({
-  organizationId: "the ID you get from Tina Cloud",
-  clientId: "the client ID you get from Tina Cloud",
-  branch: "main",
-  tokenStorage: "LOCAL_STORAGE" | "MEMORY" | "CUSTOM",
-});
-
-// For a simpler setup while working locally you can instantiate the LocalClient as a convenience
-const client = new LocalClient();
-```
-
-The `Client` does a few things:
-
-- Manages auth with Tina Cloud
-- Provides a `request` function for working with the GraphQL API
-
-Start by initializing the `LocalClient` - which automatically connects with your locally-running GraphQL server. From there, you can make GraphQL requests:
-
-### `client.request`
-
-```ts
-const client = new LocalClient();
-
-await client.request(
-  (gql) => gql`#graphql
-query BlogPostQuery($relativePath: String!) {
-  {
-    getPostsDocument(relativePath: "") {
-      data {
-        title
-      }
-    }
-  }
-}
-`,
-  { variables: { relativePath: "hello-world.md" } }
-);
-```
-
-> This API currently doesn't support filtering and sorting "list" queries. We have plans to tackle that in upcoming cycles.
-
-## `useGraphQLForms`
-
-While GraphQL is a great tool, using it with Tina can be difficult. GraphQL can query across multiple nodes, but since each document would require its own Tina form it could be difficult to sync the data with your query with all of the forms you'd need to build. The Tina GraphQL server knows all about your content schema so we're actually able to build forms automatically by inspecting your query. To see this in action, pass your query into the `useGraphqlForms` hook:
-
-```tsx
-import { useGraphqlForms } from 'tinacms'
-
-const query = gql => gql`#graphql
-  query BlogPostQuery($relativePath: String!) {
-    {
-      getPostsDocument(relativePath: $relativePath) {
-        data {
-          title
-        }
-      }
-    }
-  }
-`
-
-const MyPage = (props) => {
-  const [payload, isLoading] = useGraphqlForms<PostQueryResponseType>({
-    query,
-    variables: { relativePath: `${props.filename}.md` },
-  });
-
-  isLoading ? <div>Loading...</div> : <MyComponent {...payload}>
-}
-```
-
-If Tina is enabled you can see a form for the `getPostsDocument` request. If you query for multiple documents, you should see multiple forms:
-
-```tsx
-const query = (gql) => gql`#graphql
-  query BlogPostQuery($relativePath: String!) {
-    {
-      # this generates a Tina Form
-      getSiteNavsDocument(relativePath: "site-nav.md") {
-        data {
-          items {
-            title
-            link
-          }
-        }
-      }
-      # this generates a separate Tina Form
-      getPostsDocument(relativePath: $relativePath) {
-        data {
-          title
-        }
-      }
-    }
-  }
-`;
-```
-
-### Formify
-
-If you'd like to control the output of those forms, tap into the `formify` callback:
-
-##### Form customization:
-
-```tsx
-import { useGraphqlForms } from "tinacms";
-import { useCMS } from "tinacms";
-
-const [payload, isLoading] = useGraphqlForms({
-  query,
-  formify: ({ formConfig, createForm, createGlobalForm, skip }) => {
-    if (formConfig.id === "getSiteNavsDocument") {
-      return createGlobalForm(formConfig);
-    }
-
-    return createForm(formConfig);
-  },
-  variables: { relativePath: `${props.filename}.md` },
-});
-
-// or to skip the nav from creating a form altogether:
-const [payload, isLoading] = useGraphqlForms({
-  query,
-  formify: ({ formConfig, createForm, skip }) => {
-    if (formConfig.id === "getSiteNavsDocument") {
-      return skip();
-    }
-
-    return createForm(formConfig);
-  },
-  variables: { relativePath: `${props.filename}.md` },
-});
-```
-
-##### Field customization:
-
-Since your forms are built automatically, `formify` can also be used to customize fields:
-
-```tsx
-const [payload, isLoading] = useGraphqlForms({
-  query,
-  formify: ({ formConfig, createForm, skip }) => {
-    return createForm({
-      ...formConfig,
-      fields: formConfig.fields.map((field) => {
-        if (field.name === "title") {
-          // replace `text` with `textarea`
-          field.component = "textarea";
-        }
-        return field;
-      }),
-    });
-  },
-  variables: { relativePath: `${props.filename}.md` },
-});
-```
-
-## `useDocumentCreatorPlugin`
-
-This hook allows your editors to safely create new pages. Note that you'll be responsible for redirecting the user after a new document has been created. To use this:
-
-```tsx
-import { useDocumentCreatorPlugin } from "tinacms";
-
-// args is of type:
-// {
-//   collection: {
-//     slug: string;
-//   };
-//   relativePath: string;
-//   breadcrumbs: string[];
-//   path: string;
-// }
-useDocumentCreatorPlugin((args) => window.location.assign(buildMyRouter(args)));
-```
-
-### Customizing the content creator options
-
-To prevent editors from creating documents from certain collections, provide a filter function:
-
-```tsx
-// options are of type:
-// {
-//   label: string;
-//   value: string;
-// }[]
-useDocumentCreatorPlugin(null, (options) =>
-  options.filter((option) => option.name !== "post")
-);
-```
-
-## Authentication with Tina Cloud
-
-While this package comes with low-level APIs for authentication with Tina Cloud, the easiest way to get started is to use the `TinaCloudAuthWall` component, which prevents children from rendering until a valid session has been established with Tina Cloud.
-
-### `TinaCloudAuthWall`
-
-```tsx
-import { TinaCloudAuthWall, Client } from "tinacms";
-
-const TinaWrapper = ({ children }) => {
-  const cms = React.useMemo(() => {
-    return new TinaCMS({
-      apis: {
-        tina: new Client({
-          // config
-        })
-      },
-      ...
-    });
-  }, []);
-
-  return <TinaCloudAuthWall cms={cms}>{children}</TinaCloudAuthWall>;
-};
-```
-
-Props for TinaCloudAuthWall
-
-| Prop                         | Description                                                                                                                                                                                                                                                                                            |
-| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `cms`                        | An instance of a [CMS](http://localhost:3000/docs/cms/#cms-configuration)                                                                                                                                                                                                                              |
-| `getModalActions` (optional) | A function that returns a list of actions / buttons that will be rendered to the model. Each button has name, action, and can be primary or not. The name is the text that will be displayed. The action is a function that will be run when the button is clicked. See example below for more details |
-
-```tsx
-return (
-  <TinaCloudAuthWall
-    cms={cms}
-    getModalActions={({ closeModal }) => {
-      return [
-        {
-          action: async () => {
-            //  use your own state to get in and out of edit mode
-            closeModal();
-          },
-          name: "close",
-          primary: false,
-        },
-      ];
-    }}
-  >
-    <Component {...pageProps} />
-  </TinaCloudAuthWall>
-);
-```
-
-> Note: when using the LocalClient, TinaCloudAuthWall won't display a login screen, there is no authentication for the local GraphQL server.
-
-### Authenticating without TinaCloudAuthWall
-
-You can also authenticate with the `Client` directly:
-
-```ts
-const client = new Client({
-  // config
-});
-
-const EditSiteButton = () => {
-  const cms = useCMS();
-  const onClick = async () => {
-    await client.authenticate().then((token) => {
-      cms.enable();
-    });
-  };
-
-  return <button onClick={onClick}>Edit This Site</button>;
-};
-```
+[Checkout the docs](https://tina.io/docs/setup-overview/) for information on how to get started

package/dist/client/index.d.ts

@@ -42,6 +42,7 @@ export declare class Client {
     private options;
     events: EventBus;
     constructor({ tokenStorage, ...options }: ServerOptions);
+    get isLocalMode(): boolean;
     setBranch(branchName: string): void;
     addPendingContent: (props: any) => Promise<unknown>;
     getSchema: () => Promise<GraphQLSchema>;

package/dist/edit-state.d.ts

@@ -1 +1,20 @@
-export * from "../src/edit-state"
+/**
+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 { isEditing, setEditing, useEditState } from '@tinacms/sharedctx';
+import React from 'react';
+export { isEditing, setEditing, useEditState };
+export declare const TinaEditProvider: ({ showEditButton, ...props }: {
+    showEditButton?: boolean;
+    children: React.ReactNode;
+    editMode: React.ReactNode;
+}) => JSX.Element;

package/dist/index.d.ts

@@ -1 +1,23 @@
-export * from "../src/index"
+/**
+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 * from './client';
+export * from './auth';
+export * from './utils';
+export * from './tina-cms';
+export { useGraphqlForms } from './hooks/use-graphql-forms';
+export { useDocumentCreatorPlugin } from './hooks/use-content-creator';
+export * from '@tinacms/toolkit';
+export { TinaAdmin } from './admin';
+export { RouteMappingPlugin } from './admin/plugins/route-mapping';
+import { TinaCMSProvider2 } from './tina-cms';
+export default TinaCMSProvider2;

package/dist/index.es.js

@@ -39,6 +39,7 @@ import styled from "styled-components";
 import * as yup from "yup";
 import { setEditing, useEditState } from "@tinacms/sharedctx";
 import { getIn, setIn } from "final-form";
+import UrlPattern from "url-pattern";
 import { NavLink, useLocation, useParams, Link, useNavigate, BrowserRouter, Routes, Route } from "react-router-dom";
 import { Menu, Transition } from "@headlessui/react";
 function popupWindow(url, title, window2, w, h) {
@@ -374,6 +375,11 @@ function assertIsUnionType(type) {
     throw new Error(`Expected an instance of GraphQLUnionType for type ${type.name}`);
   }
 }
+const captureBranchName = /^refs\/heads\/(.*)/;
+const parseRefForBranchName = (ref) => {
+  const matches = ref.match(captureBranchName);
+  return matches[1];
+};
 class Client {
   constructor(_a) {
     var _b = _a, { tokenStorage = "MEMORY" } = _b, options = __objRest(_b, ["tokenStorage"]);
@@ -464,6 +470,9 @@ mutation addPendingDocumentMutation(
         break;
     }
   }
+  get isLocalMode() {
+    return this.contentApiUrl.includes("localhost");
+  }
   setBranch(branchName) {
     var _a, _b, _c;
     const encodedBranch = encodeURIComponent(branchName);
@@ -591,15 +600,15 @@ mutation addPendingDocumentMutation(
     try {
       const res = await this.fetchWithToken(url, {
         method: "POST",
-        body: {
+        body: JSON.stringify({
           baseBranch,
           branchName
-        },
+        }),
         headers: {
           "Content-Type": "application/json"
         }
       });
-      return JSON.stringify(res);
+      return await res.json().then((r) => parseRefForBranchName(r.data.ref));
     } catch (error) {
       console.error("There was an error creating a new branch.", error);
       return null;
@@ -1370,7 +1379,7 @@ const useDocumentCreatorPlugin = (args) => {
       }));
     };
     run();
-  }, [cms, values == null ? void 0 : values.collection]);
+  }, [cms]);
   React.useEffect(() => {
     if (plugin) {
       cms.plugins.add(plugin);
@@ -1382,6 +1391,18 @@ const useDocumentCreatorPlugin = (args) => {
     };
   }, [plugin]);
 };
+const errorButtonStyles = {
+  background: "#eb6337",
+  padding: "12px 18px",
+  cursor: "pointer",
+  borderRadius: "50px",
+  textTransform: "uppercase",
+  letterSpacing: "2px",
+  fontWeight: "bold",
+  border: "none",
+  color: "white",
+  margin: "1rem 0"
+};
 const SetupHooks = (props) => {
   const cms = useCMS();
   const [payload, isLoading] = useGraphqlForms({
@@ -1411,6 +1432,8 @@ class ErrorBoundary extends React.Component {
     return { hasError: true, message: error.message };
   }
   render() {
+    const branchData = window.localStorage.getItem("tinacms-current-branch");
+    const hasBranchData = branchData && branchData.length > 0;
     if (this.state.hasError && !this.state.pageRefresh) {
       return /* @__PURE__ */ React.createElement("div", {
         style: {
@@ -1431,25 +1454,21 @@ class ErrorBoundary extends React.Component {
         }
       }, /* @__PURE__ */ React.createElement("h3", {
         style: { color: "#eb6337" }
-      }, "TinaCMS Render Error"), /* @__PURE__ */ React.createElement("p", null, "Tina caught an error while updating the page:"), /* @__PURE__ */ React.createElement("pre", null, this.state.message), /* @__PURE__ */ React.createElement("br", null), /* @__PURE__ */ React.createElement("p", null, `If you've just updated the form, undo your most recent changes and click "refresh". If after a few refreshes, you're still encountering this error. There is a bigger issue with the site. Please reach out to your site admin.`), /* @__PURE__ */ React.createElement("div", {
-        style: { padding: "10px 0" }
-      }, /* @__PURE__ */ React.createElement("button", {
-        style: {
-          background: "#eb6337",
-          padding: "12px 18px",
-          cursor: "pointer",
-          borderRadius: "50px",
-          textTransform: "uppercase",
-          letterSpacing: "2px",
-          fontWeight: "bold",
-          border: "none",
-          color: "white"
-        },
+      }, "TinaCMS Render Error"), /* @__PURE__ */ React.createElement("p", null, "Tina caught an error while updating the page:"), /* @__PURE__ */ React.createElement("pre", {
+        style: { marginTop: "1rem", overflowX: "auto" }
+      }, this.state.message), /* @__PURE__ */ React.createElement("br", null), /* @__PURE__ */ React.createElement("p", null, `If you've just updated the form, undo your most recent changes and click "refresh". If after a few refreshes, you're still encountering this error. There is a bigger issue with the site. Please reach out to your site admin.`), /* @__PURE__ */ React.createElement("button", {
+        style: errorButtonStyles,
         onClick: () => {
           this.setState({ pageRefresh: true });
           setTimeout(() => this.setState({ hasError: false, pageRefresh: false }), 3e3);
         }
-      }, "Refresh"))));
+      }, "Refresh"), hasBranchData && /* @__PURE__ */ React.createElement(React.Fragment, null, /* @__PURE__ */ React.createElement("p", null, `If you're using the branch switcher, you may currently be on a "stale" branch that has been deleted or whose content is not compatible with the latest version of the site's layout. Click the button below to switch back to the default branch for this deployment.`), /* @__PURE__ */ React.createElement("button", {
+        style: errorButtonStyles,
+        onClick: () => {
+          window.localStorage.removeItem("tinacms-current-branch");
+          window.location.reload();
+        }
+      }, "Switch to default branch"))));
     }
     if (this.state.pageRefresh) {
       return /* @__PURE__ */ React.createElement(Loader, null, "Let's try that again.");
@@ -1457,20 +1476,29 @@ class ErrorBoundary extends React.Component {
     return this.props.children;
   }
 }
+const parseURL = (url) => {
+  if (url.includes("localhost")) {
+    return { branch: null, isLocalClient: true, clientId: null };
+  }
+  const tinaHost = "content.tinajs.io";
+  const params = new URL(url);
+  const pattern = new UrlPattern("/content/:clientId/github/:branch");
+  const result = pattern.match(params.pathname);
+  if (params.host !== tinaHost) {
+    throw new Error(`The only supported hosts are ${tinaHost} or localhost, but received ${params.host}.`);
+  }
+  return __spreadProps(__spreadValues({}, result), {
+    isLocalClient: false
+  });
+};
 const TinaCMSProvider2 = (_c) => {
   var _d = _c, {
     children,
-    branch,
-    clientId,
-    isLocalClient,
     cmsCallback,
     mediaStore,
     tinaioConfig
   } = _d, props = __objRest(_d, [
     "children",
-    "branch",
-    "clientId",
-    "isLocalClient",
     "cmsCallback",
     "mediaStore",
     "tinaioConfig"
@@ -1478,6 +1506,14 @@ const TinaCMSProvider2 = (_c) => {
   if (typeof props.query === "string") {
     props.query;
   }
+  if (!props.apiURL && !((props == null ? void 0 : props.clientId) || (props == null ? void 0 : props.isLocalClient))) {
+    throw new Error(`apiURL is a required field`);
+  }
+  const { branch, clientId, isLocalClient } = props.apiURL ? parseURL(props.apiURL) : {
+    branch: props.branch,
+    clientId: props.clientId,
+    isLocalClient: props.isLocalClient
+  };
   return /* @__PURE__ */ React.createElement(TinaCloudProvider, {
     branch,
     clientId,
@@ -1619,10 +1655,10 @@ const staticRequest = async ({
   if (!is_server()) {
     console.warn(`Whoops! Looks like you are using \`staticRequest\` in the browser to fetch data.
 
-The local server is not available outside of \`getStaticProps\` or \`getStaticPaths\` functions. 
+The local server is not available outside of \`getStaticProps\` or \`getStaticPaths\` functions.
 This function should only be called on the server at build time.
 
-This will work when developing locally but NOT when deployed to production. 
+This will work when developing locally but NOT when deployed to production.
 `);
   }
   return client.request(query, { variables });
@@ -1766,7 +1802,7 @@ const AuthTemplate = ({
   return /* @__PURE__ */ React.createElement("div", {
     className: "h-screen w-full bg-gradient-to-b from-blue-900 to-gray-900 flex items-center justify-center px-4 py-6"
   }, /* @__PURE__ */ React.createElement("div", {
-    className: "bg-white rounded-lg overflow-hidden shadow-lg w-full max-w-md"
+    className: "bg-white rounded-lg overflow-hidden shadow-lg w-full max-w-lg"
   }, /* @__PURE__ */ React.createElement("div", {
     className: "px-5 py-4 border-b border-gray-150"
   }, /* @__PURE__ */ React.createElement("h2", {
@@ -1791,9 +1827,7 @@ const AuthTemplate = ({
 const LoginPage = () => {
   const { setEdit } = useEditState();
   const login = () => setEdit(true);
-  return /* @__PURE__ */ React.createElement(AuthTemplate, {
-    message: "Please log in to Tina Cloud to access your content."
-  }, /* @__PURE__ */ React.createElement("a", {
+  return /* @__PURE__ */ React.createElement(AuthTemplate, null, /* @__PURE__ */ React.createElement("a", {
     href: "/",
     className: "flex-1 text-center inline-flex justify-center items-center px-8 py-3 shadow-sm text-sm leading-4 font-medium rounded-full text-gray-600 border border-gray-150 hover:opacity-80 hover:bg-gray-50 focus:outline-none focus:shadow-outline-blue  transition duration-150 ease-out"
   }, /* @__PURE__ */ React.createElement(MdOutlineArrowBack, {
@@ -1805,7 +1839,7 @@ const LoginPage = () => {
     style: { background: "#0084FF" }
   }, /* @__PURE__ */ React.createElement(BiLogIn, {
     className: "w-6 h-auto mr-1.5 opacity-80"
-  }), " Log in"));
+  }), " Enter edit-mode"));
 };
 const logout = () => {
   setEditing(false);
@@ -1973,11 +2007,11 @@ const CollectionListPage = () => {
           className: "block text-xs mb-0.5 text-gray-400 uppercase"
         }, "Filename"), /* @__PURE__ */ React.createElement(Link, {
           to: `${location2.pathname}/${document2.node.sys.filename}`,
-          className: "h-5 leading-5 block"
+          className: "h-5 leading-5 flex max-w-xs"
         }, /* @__PURE__ */ React.createElement("span", {
-          className: "leading-5 font-medium text-base overflow-ellipsis overflow-hidden whitespace-nowrap text-gray-700"
+          className: "flex-shrink-1 leading-5 font-medium text-base overflow-ellipsis overflow-hidden whitespace-nowrap text-gray-700"
         }, document2.node.sys.filename), /* @__PURE__ */ React.createElement("span", {
-          className: "leading-5 text-base font-medium text-gray-300"
+          className: "flex-shrink-0 leading-5 text-base font-medium text-gray-300"
         }, document2.node.sys.extension))), /* @__PURE__ */ React.createElement("td", {
           className: "px-5 py-3 whitespace-nowrap"
         }, /* @__PURE__ */ React.createElement("span", {