@tinacms/graphql 0.59.10 → 0.59.11

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # tina-graphql
 
+## 0.59.11
+
+### Patch Changes
+
+- 4da32454b: Modify database to write config json files without whitespace to reduce file sizes
+- 921709a7e: Adds validation to the schema instead of only using typescript types
+- 558cc4368: Make schema init platform-aware and refactor database put requests
+- 06666d39f: Link to MDX documentation when unregistered component error occurs
+- 3e2d9e43a: Adds new GraphQL `deleteDocument` mutation and logic
+- Updated dependencies [a2906d6fe]
+- Updated dependencies [3e2d9e43a]
+  - @tinacms/datalayer@0.1.1
+
 ## 0.59.10
 
 ### Patch Changes

package/dist/builder/index.d.ts

@@ -138,6 +138,20 @@ export declare class Builder {
      * @param collections
      */
     buildUpdateCollectionDocumentMutation: (collections: TinaCloudCollectionEnriched[]) => Promise<import("graphql").FieldDefinitionNode>;
+    /**
+     * ```graphql
+     * # ex.
+     * {
+     *   deleteDocument(relativePath: $relativePath, params: $params) {
+     *     id
+     *     data {...}
+     *   }
+     * }
+     * ```
+     *
+     * @param collections
+     */
+    buildDeleteCollectionDocumentMutation: (collections: TinaCloudCollectionEnriched[]) => Promise<import("graphql").FieldDefinitionNode>;
     /**
      * ```graphql
      * # ex.

package/dist/database/bridge/index.d.ts

@@ -15,6 +15,7 @@ export interface Bridge {
     glob(pattern: string): Promise<string[]>;
     get(filepath: string): Promise<string>;
     put(filepath: string, data: string): Promise<void>;
+    delete(filepath: string): Promise<void>;
     /**
      * Whether this bridge supports the ability to build the schema.
      */

package/dist/database/index.d.ts

@@ -40,13 +40,15 @@ export declare class Database {
     private _graphql;
     private _tinaSchema;
     constructor(config: CreateDatabase);
+    private collectionForPath;
+    private partitionPathsByCollection;
     get: <T extends object>(filepath: string) => Promise<T>;
     addPendingDocument: (filepath: string, data: {
         [key: string]: unknown;
     }) => Promise<void>;
     put: (filepath: string, data: {
         [key: string]: unknown;
-    }) => Promise<boolean>;
+    }, collection?: string) => Promise<boolean>;
     stringifyFile: (filepath: string, data: {
         [key: string]: unknown;
     }) => Promise<{
@@ -84,7 +86,9 @@ export declare class Database {
         graphQLSchema: DocumentNode;
         tinaSchema: TinaSchema;
     }) => Promise<void>;
+    deleteContentByPaths: (documentPaths: string[]) => Promise<void>;
     indexContentByPaths: (documentPaths: string[]) => Promise<void>;
+    delete: (filepath: string) => Promise<void>;
     _indexAllContent: () => Promise<void>;
     addToLookupMap: (lookup: LookupMapType) => Promise<void>;
 }

package/dist/index.js

@@ -11398,7 +11398,12 @@ var Builder = class {
           documentsType
         ]
       });
-      return astBuilder.FieldDefinition({ type, name: name2, args, required: true });
+      return astBuilder.FieldDefinition({
+        type,
+        name: name2,
+        args,
+        required: true
+      });
     };
     this.buildMultiCollectionDefinition = async (collections) => {
       const name2 = "getCollections";
@@ -11539,6 +11544,25 @@ var Builder = class {
         type: astBuilder.TYPES.MultiCollectionDocument
       });
     };
+    this.buildDeleteCollectionDocumentMutation = async (collections) => {
+      return astBuilder.FieldDefinition({
+        name: "deleteDocument",
+        args: [
+          astBuilder.InputValueDefinition({
+            name: "collection",
+            required: false,
+            type: astBuilder.TYPES.String
+          }),
+          astBuilder.InputValueDefinition({
+            name: "relativePath",
+            required: true,
+            type: astBuilder.TYPES.String
+          })
+        ],
+        required: true,
+        type: astBuilder.TYPES.MultiCollectionDocument
+      });
+    };
     this.multiCollectionDocumentList = async (collections) => {
       return this._buildMultiCollectionDocumentListDefinition({
         fieldName: "getDocumentList",
@@ -12101,7 +12125,7 @@ var Builder = class {
             fields: await sequential(collections, async (collection2) => {
               return astBuilder.InputValueDefinition({
                 name: collection2.name,
-                type: await this._filterCollectionDocumentType(collection2)
+                type: NAMER.dataFilterTypeName(collection2.namespace)
               });
             })
           })
@@ -12389,7 +12413,7 @@ var validateField = async (field) => {
 
 // pnp:/home/runner/work/tinacms/tinacms/packages/@tinacms/graphql/package.json
 var name = "@tinacms/graphql";
-var version = "0.59.10";
+var version = "0.59.11";
 var main = "dist/index.js";
 var typings = "dist/index.d.ts";
 var files = [
@@ -12790,6 +12814,7 @@ var _buildSchema = async (builder, tinaSchema) => {
   queryTypeDefinitionFields.push(await builder.multiCollectionDocument(collections));
   mutationTypeDefinitionFields.push(await builder.addMultiCollectionDocumentMutation());
   mutationTypeDefinitionFields.push(await builder.buildUpdateCollectionDocumentMutation(collections));
+  mutationTypeDefinitionFields.push(await builder.buildDeleteCollectionDocumentMutation(collections));
   mutationTypeDefinitionFields.push(await builder.buildCreateCollectionDocumentMutation(collections));
   queryTypeDefinitionFields.push(await builder.multiCollectionDocumentList(collections));
   queryTypeDefinitionFields.push(await builder.multiCollectionDocumentFields());
@@ -20147,7 +20172,7 @@ var parseMDXInner = (tree, field) => {
     if (!template) {
       if ((0, import_lodash4.isNull)(node.name)) {
       } else {
-        throw new Error(`Found unregistered JSX or HTML: <${node.name}>. Please ensure all structured elements have been registered with your schema.`);
+        throw new Error(`Found unregistered JSX or HTML: <${node.name}>. Please ensure all structured elements have been registered with your schema. https://tina.io/docs/editing/mdx/`);
       }
     }
     if (node.children.length > 0) {
@@ -22469,6 +22494,12 @@ var Resolver = class {
         throw e;
       }
     };
+    this.deleteDocument = async (fullPath) => {
+      if (typeof fullPath !== "string") {
+        throw new Error(`fullPath must be of type string for getDocument request`);
+      }
+      await this.database.delete(fullPath);
+    };
     this.getDocumentFields = async () => {
       try {
         const response = {};
@@ -22593,7 +22624,7 @@ var Resolver = class {
         return this.getDocument(realPath);
       }
       const params = this.buildObjectMutations(args.params[collection.name], collection);
-      await this.database.put(realPath, params);
+      await this.database.put(realPath, params, collection.name);
       return this.getDocument(realPath);
     };
     this.updateResolveDocument = async ({
@@ -22610,7 +22641,7 @@ var Resolver = class {
           case "object":
             if (params2) {
               const values = this.buildFieldMutations(params2, templateInfo.template);
-              await this.database.put(realPath, values);
+              await this.database.put(realPath, values, collection.name);
             }
             break;
           case "union":
@@ -22623,14 +22654,14 @@ var Resolver = class {
                 const values = __spreadProps(__spreadValues({}, this.buildFieldMutations(templateParams, template)), {
                   _template: lastItem(template.namespace)
                 });
-                await this.database.put(realPath, values);
+                await this.database.put(realPath, values, collection.name);
               }
             });
         }
         return this.getDocument(realPath);
       }
       const params = this.buildObjectMutations(isCollectionSpecific ? args.params : args.params[collection.name], collection);
-      await this.database.put(realPath, params);
+      await this.database.put(realPath, params, collection.name);
       return this.getDocument(realPath);
     };
     this.resolveDocument = async ({
@@ -22638,6 +22669,7 @@ var Resolver = class {
       collection: collectionName,
       isMutation,
       isCreation,
+      isDeletion,
       isAddPendingDocument,
       isCollectionSpecific
     }) => {
@@ -22665,6 +22697,14 @@ var Resolver = class {
             isAddPendingDocument
           });
         }
+        if (isDeletion) {
+          if (!alreadyExists) {
+            throw new Error(`Unable to delete document, ${realPath} does not exist`);
+          }
+          const doc = await this.getDocument(realPath);
+          await this.deleteDocument(realPath);
+          return doc;
+        }
         if (alreadyExists === false) {
           throw new Error(`Unable to update document, ${realPath} does not exist`);
         }
@@ -23190,12 +23230,18 @@ var resolve = async ({
                 isAddPendingDocument: true
               });
             }
-            if (["getDocument", "createDocument", "updateDocument"].includes(info.fieldName)) {
+            if ([
+              "getDocument",
+              "createDocument",
+              "updateDocument",
+              "deleteDocument"
+            ].includes(info.fieldName)) {
               const result2 = await resolver2.resolveDocument({
                 args,
                 collection: args.collection,
                 isMutation,
                 isCreation,
+                isDeletion: info.fieldName === "deleteDocument",
                 isAddPendingDocument: false,
                 isCollectionSpecific: false
               });
@@ -23568,6 +23614,11 @@ var GENERATED_FOLDER = import_path4.default.join(".tina", "__generated__");
 var Database = class {
   constructor(config) {
     this.config = config;
+    this.collectionForPath = async (filepath) => {
+      const tinaSchema = await this.getSchema();
+      const collection = tinaSchema.schema.collections.find((collection2) => filepath.startsWith(collection2.path));
+      return collection;
+    };
     this.get = async (filepath) => {
       if (SYSTEM_FILES.includes(filepath)) {
         throw new Error(`Unexpected get for config file ${filepath}`);
@@ -23607,8 +23658,7 @@ var Database = class {
     };
     this.addPendingDocument = async (filepath, data) => {
       const { stringifiedFile, payload, keepTemplateKey } = await this.stringifyFile(filepath, data);
-      const tinaSchema = await this.getSchema();
-      const collection = tinaSchema.schema.collections.find((collection2) => filepath.startsWith(collection2.path));
+      const collection = await this.collectionForPath(filepath);
       let collectionIndexDefinitions;
       if (collection) {
         const indexDefinitions = await this.getIndexDefinitions();
@@ -23619,20 +23669,18 @@ var Database = class {
       }
       await this.store.put(filepath, payload, {
         keepTemplateKey,
-        collection: collection.name,
+        collection: collection == null ? void 0 : collection.name,
         indexDefinitions: collectionIndexDefinitions
       });
     };
-    this.put = async (filepath, data) => {
+    this.put = async (filepath, data, collection) => {
       if (SYSTEM_FILES.includes(filepath)) {
         throw new Error(`Unexpected put for config file ${filepath}`);
       } else {
-        const tinaSchema = await this.getSchema();
-        const collection = tinaSchema.schema.collections.find((collection2) => filepath.startsWith(collection2.path));
         let collectionIndexDefinitions;
         if (collection) {
           const indexDefinitions = await this.getIndexDefinitions();
-          collectionIndexDefinitions = indexDefinitions == null ? void 0 : indexDefinitions[collection.name];
+          collectionIndexDefinitions = indexDefinitions == null ? void 0 : indexDefinitions[collection];
         }
         const { stringifiedFile, payload, keepTemplateKey } = await this.stringifyFile(filepath, data);
         if (this.store.supportsSeeding()) {
@@ -23640,7 +23688,7 @@ var Database = class {
         }
         await this.store.put(filepath, payload, {
           keepTemplateKey,
-          collection: collection.name,
+          collection,
           indexDefinitions: collectionIndexDefinitions
         });
       }
@@ -23839,8 +23887,8 @@ var Database = class {
       tinaSchema
     }) => {
       if (this.bridge.supportsBuilding()) {
-        await this.bridge.putConfig(import_path4.default.join(GENERATED_FOLDER, `_graphql.json`), JSON.stringify(graphQLSchema, null, 2));
-        await this.bridge.putConfig(import_path4.default.join(GENERATED_FOLDER, `_schema.json`), JSON.stringify(tinaSchema.schema, null, 2));
+        await this.bridge.putConfig(import_path4.default.join(GENERATED_FOLDER, `_graphql.json`), JSON.stringify(graphQLSchema));
+        await this.bridge.putConfig(import_path4.default.join(GENERATED_FOLDER, `_schema.json`), JSON.stringify(tinaSchema.schema));
       }
     };
     this.indexContent = async ({
@@ -23860,28 +23908,34 @@ var Database = class {
         }
       }
     };
-    this.indexContentByPaths = async (documentPaths) => {
-      const pathsByCollection = {};
-      const nonCollectionPaths = [];
-      const collections = {};
-      const tinaSchema = await this.getSchema();
-      for (const documentPath of documentPaths) {
-        const collection = tinaSchema.schema.collections.find((collection2) => documentPath.startsWith(collection2.path));
-        if (collection) {
-          if (!pathsByCollection[collection.name]) {
-            pathsByCollection[collection.name] = [];
-          }
-          collections[collection.name] = collection;
-          pathsByCollection[collection.name].push(documentPath);
-        } else {
-          nonCollectionPaths.push(documentPath);
-        }
+    this.deleteContentByPaths = async (documentPaths) => {
+      const { pathsByCollection, nonCollectionPaths, collections } = await this.partitionPathsByCollection(documentPaths);
+      for (const collection of Object.keys(pathsByCollection)) {
+        await _deleteIndexContent(this, pathsByCollection[collection], collections[collection]);
       }
+      await _deleteIndexContent(this, nonCollectionPaths, null);
+    };
+    this.indexContentByPaths = async (documentPaths) => {
+      const { pathsByCollection, nonCollectionPaths, collections } = await this.partitionPathsByCollection(documentPaths);
       for (const collection of Object.keys(pathsByCollection)) {
         await _indexContent(this, pathsByCollection[collection], collections[collection]);
       }
       await _indexContent(this, nonCollectionPaths);
     };
+    this.delete = async (filepath) => {
+      const tinaSchema = await this.getSchema();
+      const collection = tinaSchema.schema.collections.find((collection2) => filepath.startsWith(collection2.path));
+      let collectionIndexDefinitions;
+      if (collection) {
+        const indexDefinitions = await this.getIndexDefinitions();
+        collectionIndexDefinitions = indexDefinitions == null ? void 0 : indexDefinitions[collection.name];
+      }
+      await this.store.delete(filepath, {
+        collection: collection.name,
+        indexDefinitions: collectionIndexDefinitions
+      });
+      await this.bridge.delete(filepath);
+    };
     this._indexAllContent = async () => {
       const tinaSchema = await this.getSchema();
       await sequential(tinaSchema.getCollections(), async (collection) => {
@@ -23900,11 +23954,29 @@ var Database = class {
       const updatedLookup = __spreadProps(__spreadValues({}, lookupMap), {
         [lookup.type]: lookup
       });
-      await this.bridge.putConfig(lookupPath, JSON.stringify(updatedLookup, null, 2));
+      await this.bridge.putConfig(lookupPath, JSON.stringify(updatedLookup));
     };
     this.bridge = config.bridge;
     this.store = config.store;
   }
+  async partitionPathsByCollection(documentPaths) {
+    const pathsByCollection = {};
+    const nonCollectionPaths = [];
+    const collections = {};
+    for (const documentPath of documentPaths) {
+      const collection = await this.collectionForPath(documentPath);
+      if (collection) {
+        if (!pathsByCollection[collection.name]) {
+          pathsByCollection[collection.name] = [];
+        }
+        collections[collection.name] = collection;
+        pathsByCollection[collection.name].push(documentPath);
+      } else {
+        nonCollectionPaths.push(documentPath);
+      }
+    }
+    return { pathsByCollection, nonCollectionPaths, collections };
+  }
 };
 function hasOwnProperty2(obj, prop) {
   return obj.hasOwnProperty(prop);
@@ -23934,6 +24006,23 @@ var _indexContent = async (database, documentPaths, collection) => {
     }
   });
 };
+var _deleteIndexContent = async (database, documentPaths, collection) => {
+  let deleteOptions = void 0;
+  if (collection) {
+    const indexDefinitions = await database.getIndexDefinitions();
+    const collectionIndexDefinitions = indexDefinitions == null ? void 0 : indexDefinitions[collection.name];
+    if (!collectionIndexDefinitions) {
+      throw new Error(`No indexDefinitions for collection ${collection.name}`);
+    }
+    deleteOptions = {
+      collection: collection.name,
+      indexDefinitions: collectionIndexDefinitions
+    };
+  }
+  await sequential(documentPaths, async (filepath) => {
+    database.store.delete(filepath, deleteOptions);
+  });
+};
 
 // pnp:/home/runner/work/tinacms/tinacms/packages/@tinacms/graphql/src/index.ts
 var buildSchema = async (rootPath, database) => {

package/dist/resolver/filter-utils.d.ts

@@ -1,15 +1,15 @@
 /**
- 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.
- */
+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 { ReferenceTypeInner, TinaFieldInner } from '../types';
 import type { FilterCondition } from '@tinacms/datalayer';
 export declare type ReferenceResolver = (filter: Record<string, object>, fieldDefinition: ReferenceTypeInner) => Promise<{

package/dist/resolver/index.d.ts

@@ -90,6 +90,7 @@ export declare class Resolver {
             fields: unknown[];
         };
     }>;
+    deleteDocument: (fullPath: unknown) => Promise<void>;
     getDocumentFields: () => Promise<{}>;
     buildObjectMutations: (fieldValue: any, field: Collectable) => {
         [key: string]: unknown;
@@ -169,11 +170,12 @@ export declare class Resolver {
             fields: unknown[];
         };
     }>;
-    resolveDocument: ({ args, collection: collectionName, isMutation, isCreation, isAddPendingDocument, isCollectionSpecific, }: {
+    resolveDocument: ({ args, collection: collectionName, isMutation, isCreation, isDeletion, isAddPendingDocument, isCollectionSpecific, }: {
         args: unknown;
         collection?: string;
         isMutation: boolean;
         isCreation?: boolean;
+        isDeletion?: boolean;
         isAddPendingDocument?: boolean;
         isCollectionSpecific?: boolean;
     }) => Promise<{

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tinacms/graphql",
-  "version": "0.59.10",
+  "version": "0.59.11",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "files": [
@@ -46,7 +46,7 @@
   },
   "dependencies": {
     "@graphql-tools/relay-operation-optimizer": "^6.4.1",
-    "@tinacms/datalayer": "0.1.0",
+    "@tinacms/datalayer": "0.1.1",
     "body-parser": "^1.19.0",
     "cors": "^2.8.5",
     "dataloader": "^2.0.0",
@@ -96,7 +96,7 @@
     "directory": "packages/tina-graphql"
   },
   "devDependencies": {
-    "@tinacms/datalayer": "0.1.0",
+    "@tinacms/datalayer": "0.1.1",
     "@tinacms/scripts": "0.50.7",
     "@types/cors": "^2.8.7",
     "@types/estree": "^0.0.50",