tinacms 0.67.2 → 0.68.0

package/CHANGELOG.md

@@ -1,5 +1,191 @@
 # tinacms
 
+## 0.68.0
+
+### Minor Changes
+
+- 6a6f137ae: # Simplify GraphQL API
+
+  ## `schema` must be supplied to the `<TinaCMS>` component
+
+  Previously the `.tina/schema.ts` was only used by the Tina CLI to generate the GraphQL API. However it's now required as a prop to `<TinaCMS>`. This allows you to provide runtime logic in the `ui` property of field definitions. See the documentation on "Extending Tina" for examples.
+
+  ## The GraphQL API has been simplified
+
+  ### `get<collection name>` is now just the collection name
+
+  ```graphql
+  # old
+  {
+    getPostDocument(relativePath: $relativePath) { ... }
+  }
+
+  # new
+  {
+    post(relativePath: $relativePath) { ... }
+  }
+  ```
+
+  ### `get<collection name>List` is now `<collection name>Connection`
+
+  The use of the term `connection` is due to our adherence the the [relay cursor spec](https://relay.dev/graphql/connections.htm). We may offer a simplified list field in a future release
+
+  ```graphql
+  # old
+  {
+    getPostList { ... }
+  }
+
+  # new
+  {
+    postConnection { ... }
+  }
+  ```
+
+  ### `getCollection` and `getCollections` are now `collection` and `collections`
+
+  ```graphql
+  # old
+  {
+    getCollection(collection: "post") {...}
+  }
+  {
+    getCollections {...}
+  }
+
+  # new
+  {
+    collection(collection: "post") {...}
+  }
+  {
+    collections {...}
+  }
+  ```
+
+  ### No more `data` property
+
+  The `data` property was previously where all field definitions could be found. This has been moved on level up:
+
+  ```graphql
+  # old
+  {
+    getPostDocument(relativePath: $relativePath) {
+      data {
+        title
+      }
+    }
+  }
+
+  # new
+  {
+    post(relativePath: $relativePath) {
+      title
+    }
+  }
+  ```
+
+  #### The type for documents no longer includes "Document" at the end
+
+  ```graphql
+  # old
+  {
+    getPostDocument(relativePath: $relativePath) {
+      data {
+        author {
+          ... on AuthorDocument {
+            data {
+              name
+            }
+          }
+        }
+      }
+    }
+  }
+
+  # new
+  {
+    post(relativePath: $relativePath) {
+      author {
+        ... on Author {
+          name
+        }
+      }
+    }
+  }
+  ```
+
+  ### Meta fields are now underscored
+
+  Aside from `id`, other metadata is now underscored:
+
+  ```graphql
+  # old
+  {
+    getPostDocument(relativePath: $relativePath) {
+      sys {
+        relativePath
+      }
+      values
+    }
+  }
+
+  # new
+  {
+    post(relativePath: $relativePath) {
+      _sys {
+        relativePath
+      }
+      _values
+    }
+  }
+  ```
+
+  ### `dataJSON` is gone
+
+  This is identical to `_values`
+
+  ### `form` is gone
+
+  `form` was used internally to generate forms for the given document, however that's now handled by providing your `schema` to `<TinaCMS>`.
+
+  ### `getDocumentList` is gone
+
+  It's no longer possible to query all documents at once, you can query for collection documents via the `collection` query:
+
+  ```graphql
+  {
+    collection {
+      documents {
+        edges {
+          node {...}
+        }
+      }
+    }
+  }
+  ```
+
+### Patch Changes
+
+- Updated dependencies [6a6f137ae]
+  - @tinacms/toolkit@0.56.23
+
+## 0.67.4
+
+### Patch Changes
+
+- 168f6cc6e: Update delete modal header
+- 2a6060138: Fix url parsing issue when a branch name contained a `/`
+- 3af3d6787: Fix issues with finding the template for multitemplate collections
+- Updated dependencies [bf5fe0074]
+  - @tinacms/toolkit@0.56.22
+
+## 0.67.3
+
+### Patch Changes
+
+- Updated dependencies [d37562999]
+  - @tinacms/toolkit@0.56.21
+
 ## 0.67.2
 
 ### Patch Changes

package/dist/admin/api.d.ts

@@ -11,7 +11,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 import type { TinaCMS } from '@tinacms/toolkit';
-import type { Collection, DocumentForm, GetDocumentFields } from './types';
+import type { Collection, DocumentForm } from './types';
 export declare class TinaAdminApi {
     api: {
         request: (query: string, { variables }: {
@@ -19,22 +19,18 @@ export declare class TinaAdminApi {
         }) => any;
         isAuthenticated: () => boolean;
     };
+    schema: any;
     constructor(cms: TinaCMS);
     isAuthenticated(): Promise<boolean>;
-    fetchCollections(): Promise<{
-        getCollections: Collection[];
-    }>;
+    fetchCollections(): Promise<Collection[]>;
     deleteDocument({ collection, relativePath, }: {
         collection: string;
         relativePath: string;
     }): Promise<void>;
-    fetchCollection(collectionName: string, includeDocuments: boolean): Promise<{
-        getCollection: Collection;
-    }>;
+    fetchCollection(collectionName: string, includeDocuments: boolean): Promise<Collection>;
     fetchDocument(collectionName: string, relativePath: string): Promise<{
-        getDocument: DocumentForm;
+        document: DocumentForm;
     }>;
-    fetchDocumentFields(): Promise<GetDocumentFields>;
     createDocument(collectionName: string, relativePath: string, params: Object): Promise<any>;
     updateDocument(collectionName: string, relativePath: string, params: Object): Promise<any>;
 }

package/dist/admin/types.d.ts

@@ -17,7 +17,7 @@ export interface Template {
 }
 export interface DocumentNode {
     node: {
-        sys: {
+        _sys: {
             template: string;
             breadcrumbs: string[];
             path: string;
@@ -29,21 +29,10 @@ export interface DocumentNode {
     };
 }
 export interface DocumentForm {
-    form: {
-        label: string;
-        name: string;
-        fields: Object[];
-        mutationInfo: {
-            path: string[];
-            string: string;
-            includeCollection: boolean;
-            includeTemplate: boolean;
-        };
-    };
-    values: Object;
+    _values: Object;
 }
 export interface DocumentSys {
-    sys: {
+    _sys: {
         template: string;
         breadcrumbs: string[];
         path: string;
@@ -56,6 +45,7 @@ export interface DocumentSys {
 export interface Collection {
     label: string;
     name: string;
+    slug: string;
     format?: string;
     templates?: Template[];
     documents?: {
@@ -63,10 +53,3 @@ export interface Collection {
         edges?: DocumentNode[];
     };
 }
-export interface GetDocumentFields {
-    [collectionName: string]: {
-        collection: Object;
-        templates?: Object[];
-        fields?: Object[];
-    };
-}

package/dist/hooks/formify/formify-utils.d.ts

@@ -85,5 +85,6 @@ export declare function buildPath({ fieldNode, type, parentTypename, path, }: {
 }): BlueprintPath[];
 export declare const metaFields: G.SelectionNode[];
 export declare const getRelativeBlueprint: (path: BlueprintPath[]) => string;
+export declare const isSysField: (fieldNode: G.FieldNode) => boolean;
 export declare const getBlueprintId: (path: BlueprintPath[]) => string;
 export declare const getFieldAliasForBlueprint: (path: BlueprintPath[]) => string;

package/dist/hooks/formify/formify.d.ts

@@ -12,7 +12,6 @@ limitations under the License.
 */
 import * as G from 'graphql';
 import type { DocumentBlueprint } from './types';
-export declare const DATA_NODE_NAME = "data";
 export declare const formify: ({ schema, query, getOptimizedQuery, }: {
     schema: G.GraphQLSchema;
     query: string;

package/dist/hooks/formify/types.d.ts

@@ -12,7 +12,7 @@ limitations under the License.
 */
 /// <reference types="react" />
 import type * as G from 'graphql';
-import type { Form, Field } from '@tinacms/toolkit';
+import type { Form } from '@tinacms/toolkit';
 export declare type Action = {
     type: 'start';
     value: {
@@ -58,20 +58,12 @@ export declare type FormifiedDocumentNode = {
     id: string;
     _internalSys: {
         path: string;
+        relativePath: string;
         collection: {
             name: any;
         };
     };
-    form: {
-        mutationInfo: {
-            string: string;
-            includeCollection?: boolean;
-            includeTemplate?: boolean;
-        };
-        label: string;
-        fields: Field[];
-    };
-    values: object;
+    _values: object;
 };
 export declare type ChangeMutation = {
     type: 'change';

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

@@ -10,9 +10,9 @@ 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 { AnyField, Form } from '@tinacms/toolkit';
+import { Form } from '@tinacms/toolkit';
 import type { FormOptions, TinaCMS } from '@tinacms/toolkit';
-export declare function useGraphqlFormsUnstable<T extends object>({ variables, onSubmit, query, formify, eventList, }: {
+export declare function useGraphqlForms<T extends object>({ variables, onSubmit, query, formify, eventList, }: {
     query: string;
     variables: object;
     onSubmit?: (args: onSubmitArgs) => void;
@@ -24,12 +24,6 @@ export declare function useGraphqlFormsUnstable<T extends object>({ variables, o
      */
     eventList?: [];
 }): [T, Boolean];
-export declare function useGraphqlForms<T extends object>({ variables, onSubmit, formify, query, }: {
-    query: string;
-    variables: object;
-    onSubmit?: (args: onSubmitArgs) => void;
-    formify?: formifyCallback;
-}): [T, Boolean];
 export declare const transformDocumentIntoMutationRequestPayload: (document: {
     [key: string]: unknown;
     _collection: string;
@@ -39,8 +33,8 @@ export declare const transformDocumentIntoMutationRequestPayload: (document: {
     includeCollection?: boolean;
     includeTemplate?: boolean;
 }) => any;
-export declare const generateFormCreatorsUnstable: (cms: TinaCMS, showInSidebar?: boolean) => {
-    createForm: (formConfig: any) => Form<any, AnyField>;
+export declare const generateFormCreators: (cms: TinaCMS, showInSidebar?: boolean) => {
+    createForm: (formConfig: any) => Form<any, import("@tinacms/toolkit").AnyField>;
     createGlobalForm: GlobalFormCreator;
 };
 declare type FormCreator = (formConfig: FormOptions<any>) => Form;

package/dist/index.d.ts

@@ -14,7 +14,7 @@ export * from './client';
 export * from './auth';
 export * from './utils';
 export * from './tina-cms';
-export { useGraphqlForms, useGraphqlFormsUnstable, } from './hooks/use-graphql-forms';
+export { useGraphqlForms } from './hooks/use-graphql-forms';
 export { useDocumentCreatorPlugin } from './hooks/use-content-creator';
 export * from '@tinacms/toolkit';
 export { TinaAdmin } from './admin';