@tinacms/graphql 0.59.11 → 0.60.0

package/CHANGELOG.md

@@ -1,5 +1,169 @@
 # tina-graphql
 
+## 0.60.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 {...}
+        }
+      }
+    }
+  }
+  ```
+
 ## 0.59.11
 
 ### Patch Changes

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

@@ -147,6 +147,10 @@ export declare const NAMER: {
     dataMutationTypeName: (namespace: string[]) => string;
     updateName: (namespace: string[]) => string;
     createName: (namespace: string[]) => string;
+    documentQueryName: () => string;
+    documentConnectionQueryName: () => string;
+    collectionQueryName: () => string;
+    collectionListQueryName: () => string;
     queryName: (namespace: string[]) => string;
     generateQueryListName: (namespace: string[]) => string;
     fragmentName: (namespace: string[]) => string;

package/dist/builder/index.d.ts

@@ -11,7 +11,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 import { Database } from '../database';
-import type { ObjectTypeDefinitionNode, InlineFragmentNode } from 'graphql';
+import type { ObjectTypeDefinitionNode, InlineFragmentNode, FieldDefinitionNode } from 'graphql';
 import type { TinaCloudCollectionEnriched, Template } from '../types';
 import { TinaSchema } from '../schema';
 export declare const createBuilder: ({ database, tinaSchema, }: {
@@ -47,7 +47,7 @@ export declare class Builder {
      *
      * @param collections
      */
-    buildCollectionDefinition: (collections: TinaCloudCollectionEnriched[]) => Promise<import("graphql").FieldDefinitionNode>;
+    buildCollectionDefinition: (collections: TinaCloudCollectionEnriched[]) => Promise<FieldDefinitionNode>;
     /**
      * ```graphql
      * # ex.
@@ -61,7 +61,7 @@ export declare class Builder {
      *
      * @param collections
      */
-    buildMultiCollectionDefinition: (collections: TinaCloudCollectionEnriched[]) => Promise<import("graphql").FieldDefinitionNode>;
+    buildMultiCollectionDefinition: (collections: TinaCloudCollectionEnriched[]) => Promise<FieldDefinitionNode>;
     /**
      * ```graphql
      * # ex.
@@ -73,7 +73,7 @@ export declare class Builder {
      * }
      * ```
      */
-    multiNodeDocument: () => Promise<import("graphql").FieldDefinitionNode>;
+    multiNodeDocument: () => Promise<FieldDefinitionNode>;
     /**
      * ```graphql
      * # ex.
@@ -87,15 +87,7 @@ export declare class Builder {
      *
      * @param collections
      */
-    multiCollectionDocument: (collections: TinaCloudCollectionEnriched[]) => Promise<import("graphql").FieldDefinitionNode>;
-    /**
-     * ```graphql
-     * {
-     *    getDocumentFields()
-     * }
-     * ```
-     */
-    multiCollectionDocumentFields: () => Promise<import("graphql").FieldDefinitionNode>;
+    multiCollectionDocument: (collections: TinaCloudCollectionEnriched[]) => Promise<FieldDefinitionNode>;
     /**
      * ```graphql
      * # ex.
@@ -109,7 +101,7 @@ export declare class Builder {
      *
      * @param collections
      */
-    addMultiCollectionDocumentMutation: () => Promise<import("graphql").FieldDefinitionNode>;
+    addMultiCollectionDocumentMutation: () => Promise<FieldDefinitionNode>;
     /**
      * ```graphql
      * # ex.
@@ -123,7 +115,7 @@ export declare class Builder {
      *
      * @param collections
      */
-    buildCreateCollectionDocumentMutation: (collections: TinaCloudCollectionEnriched[]) => Promise<import("graphql").FieldDefinitionNode>;
+    buildCreateCollectionDocumentMutation: (collections: TinaCloudCollectionEnriched[]) => Promise<FieldDefinitionNode>;
     /**
      * ```graphql
      * # ex.
@@ -137,7 +129,7 @@ export declare class Builder {
      *
      * @param collections
      */
-    buildUpdateCollectionDocumentMutation: (collections: TinaCloudCollectionEnriched[]) => Promise<import("graphql").FieldDefinitionNode>;
+    buildUpdateCollectionDocumentMutation: (collections: TinaCloudCollectionEnriched[]) => Promise<FieldDefinitionNode>;
     /**
      * ```graphql
      * # ex.
@@ -151,24 +143,7 @@ export declare class Builder {
      *
      * @param collections
      */
-    buildDeleteCollectionDocumentMutation: (collections: TinaCloudCollectionEnriched[]) => Promise<import("graphql").FieldDefinitionNode>;
-    /**
-     * ```graphql
-     * # ex.
-     * {
-     *   getDocumentList(first: 10) {
-     *     edges {
-     *       node {
-     *         id
-     *       }
-     *     }
-     *   }
-     * }
-     * ```
-     *
-     * @param collections
-     */
-    multiCollectionDocumentList: (collections: TinaCloudCollectionEnriched[]) => Promise<import("graphql").FieldDefinitionNode>;
+    buildDeleteCollectionDocumentMutation: (collections: TinaCloudCollectionEnriched[]) => Promise<FieldDefinitionNode>;
     /**
      * ```graphql
      * # ex.
@@ -182,7 +157,7 @@ export declare class Builder {
      *
      * @param collection
      */
-    collectionDocument: (collection: TinaCloudCollectionEnriched) => Promise<import("graphql").FieldDefinitionNode>;
+    collectionDocument: (collection: TinaCloudCollectionEnriched) => Promise<FieldDefinitionNode>;
     /**
      * Turns a collection into a fragment that gets updated on build. This fragment does not resolve references
      * ```graphql
@@ -213,7 +188,7 @@ export declare class Builder {
      *
      * @param collection
      */
-    updateCollectionDocumentMutation: (collection: TinaCloudCollectionEnriched) => Promise<import("graphql").FieldDefinitionNode>;
+    updateCollectionDocumentMutation: (collection: TinaCloudCollectionEnriched) => Promise<FieldDefinitionNode>;
     /**
      * ```graphql
      * # ex.
@@ -227,7 +202,7 @@ export declare class Builder {
      *
      * @param collection
      */
-    createCollectionDocumentMutation: (collection: TinaCloudCollectionEnriched) => Promise<import("graphql").FieldDefinitionNode>;
+    createCollectionDocumentMutation: (collection: TinaCloudCollectionEnriched) => Promise<FieldDefinitionNode>;
     /**
      * ```graphql
      * # ex.
@@ -244,7 +219,7 @@ export declare class Builder {
      *
      * @param collection
      */
-    collectionDocumentList: (collection: TinaCloudCollectionEnriched) => Promise<import("graphql").FieldDefinitionNode>;
+    collectionDocumentList: (collection: TinaCloudCollectionEnriched) => Promise<FieldDefinitionNode>;
     /**
      * GraphQL type definitions which remain unchanged regardless
      * of the supplied Tina schema. Ex. "node" interface

package/dist/database/index.d.ts

@@ -126,6 +126,7 @@ export declare type CollectionDocumentListLookup = {
 declare type UnionDataLookup = {
     type: string;
     resolveType: 'unionData';
+    collection?: string;
     typeMap: {
         [templateName: string]: string;
     };