@tinacms/graphql 0.0.0-20240507230056 → 0.0.0-20240603083347

package/dist/builder/index.d.ts

@@ -134,6 +134,20 @@ export declare class Builder {
      * @param collections
      */
     buildDeleteCollectionDocumentMutation: (collections: Collection<true>[]) => Promise<FieldDefinitionNode>;
+    /**
+     * ```graphql
+     * # ex.
+     * {
+     *   createFolder(folderName: $folderName, params: $params) {
+     *     id
+     *     data {...}
+     *   }
+     * }
+     * ```
+     *
+     * @param collections
+     */
+    buildCreateCollectionFolderMutation: () => Promise<FieldDefinitionNode>;
     /**
      * ```graphql
      * # ex.

package/dist/database/index.d.ts

@@ -127,7 +127,7 @@ export declare class Database {
     getSchema: (level?: Level, existingSchema?: Schema) => Promise<TinaSchema>;
     getIndexDefinitions: (level?: Level) => Promise<Record<string, Record<string, IndexDefinition>>>;
     documentExists: (fullpath: unknown) => Promise<boolean>;
-    query: (queryOptions: QueryOptions, hydrator: any, cache?: Record<string, any>) => Promise<{
+    query: (queryOptions: QueryOptions, hydrator: any) => Promise<{
         edges: {
             node: any;
             cursor: string;

package/dist/index.js

@@ -1685,6 +1685,25 @@ var Builder = class {
         type: astBuilder.TYPES.MultiCollectionDocument
       });
     };
+    this.buildCreateCollectionFolderMutation = async () => {
+      return astBuilder.FieldDefinition({
+        name: "createFolder",
+        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.collectionDocument = async (collection) => {
       const name = NAMER.queryName([collection.name]);
       const type = await this._buildCollectionDocumentType(collection);
@@ -3095,6 +3114,9 @@ var _buildSchema = async (builder, tinaSchema) => {
   mutationTypeDefinitionFields.push(
     await builder.buildCreateCollectionDocumentMutation(collections)
   );
+  mutationTypeDefinitionFields.push(
+    await builder.buildCreateCollectionFolderMutation()
+  );
   await sequential(collections, async (collection) => {
     queryTypeDefinitionFields.push(await builder.collectionDocument(collection));
     if (collection.isAuthCollection) {
@@ -4353,7 +4375,7 @@ var makeIndexOpsForDocument = (filepath, collection, indexDefinitions, data, opT
           type: opType,
           key: filepath,
           sublevel: indexSublevel,
-          value: opType === "put" ? data : void 0
+          value: opType === "put" ? {} : void 0
         });
       } else {
         if (indexedValue) {
@@ -4361,7 +4383,7 @@ var makeIndexOpsForDocument = (filepath, collection, indexDefinitions, data, opT
             type: opType,
             key: `${indexedValue}${INDEX_KEY_FIELD_SEPARATOR}${filepath}`,
             sublevel: indexSublevel,
-            value: opType === "put" ? data : void 0
+            value: opType === "put" ? {} : void 0
           });
         }
       }
@@ -4390,9 +4412,7 @@ var stringEscaper = makeStringEscaper(
 );
 
 // src/resolver/index.ts
-var queryCache;
 var createResolver = (args) => {
-  queryCache = {};
   return new Resolver(args);
 };
 var resolveFieldData = async ({ namespace, ...field }, rawData, accumulator, tinaSchema, config, isAudit) => {
@@ -4614,10 +4634,7 @@ var Resolver = class {
           `fullPath must be of type string for getDocumentOrDirectory request`
         );
       }
-      let rawData = queryCache[fullPath];
-      if (!rawData) {
-        rawData = await this.getRaw(fullPath);
-      }
+      const rawData = await this.getRaw(fullPath);
       if (rawData["__folderBasename"]) {
         return {
           __typename: "Folder",
@@ -4882,6 +4899,7 @@ var Resolver = class {
       isMutation,
       isCreation,
       isDeletion,
+      isFolderCreation,
       isAddPendingDocument,
       isCollectionSpecific,
       isUpdateName
@@ -4905,7 +4923,10 @@ var Resolver = class {
         (yup3) => yup3.object({ relativePath: yup3.string().required() })
       );
       const collection = await this.tinaSchema.getCollection(collectionLookup);
-      const realPath = import_path3.default.join(collection == null ? void 0 : collection.path, args.relativePath);
+      let realPath = import_path3.default.join(collection == null ? void 0 : collection.path, args.relativePath);
+      if (isFolderCreation) {
+        realPath = `${realPath}/.gitkeep`;
+      }
       const alreadyExists = await this.database.documentExists(realPath);
       if (isMutation) {
         if (isCreation) {
@@ -4918,6 +4939,16 @@ var Resolver = class {
             args,
             isAddPendingDocument
           });
+        } else if (isFolderCreation) {
+          if (alreadyExists === true) {
+            throw new Error(`Unable to add folder, ${realPath} already exists`);
+          }
+          await this.database.put(
+            realPath,
+            { _is_tina_folder_placeholder: true },
+            collection.name
+          );
+          return this.getDocument(realPath);
         }
         if (!alreadyExists) {
           if (isDeletion) {
@@ -5054,8 +5085,7 @@ var Resolver = class {
       };
       const result = await this.database.query(
         queryOptions,
-        hydrator ? hydrator : this.getDocumentOrDirectory,
-        queryCache
+        hydrator ? hydrator : this.getDocumentOrDirectory
       );
       const edges = result.edges;
       const pageInfo = result.pageInfo;
@@ -5481,7 +5511,8 @@ var resolve = async ({
                 NAMER.documentQueryName(),
                 "createDocument",
                 "updateDocument",
-                "deleteDocument"
+                "deleteDocument",
+                "createFolder"
               ].includes(info.fieldName)) {
                 const result2 = await resolver.resolveDocument({
                   args,
@@ -5489,6 +5520,7 @@ var resolve = async ({
                   isMutation,
                   isCreation,
                   isDeletion: info.fieldName === "deleteDocument",
+                  isFolderCreation: info.fieldName === "createFolder",
                   isUpdateName: Boolean((_a2 = args == null ? void 0 : args.params) == null ? void 0 : _a2.relativePath),
                   isAddPendingDocument: false,
                   isCollectionSpecific: false
@@ -5832,6 +5864,7 @@ var Database = class {
     this.put = async (filepath, data, collectionName) => {
       var _a, _b;
       await this.initLevel();
+      const isGitKeep = filepath.endsWith(".gitkeep");
       try {
         if (SYSTEM_FILES.includes(filepath)) {
           throw new Error(`Unexpected put for config file ${filepath}`);
@@ -5860,11 +5893,7 @@ var Database = class {
               );
             }
           }
-          const stringifiedFile = await this.stringifyFile(
-            filepath,
-            dataFields,
-            collection
-          );
+          const stringifiedFile = isGitKeep ? "" : await this.stringifyFile(filepath, dataFields, collection);
           if (!(collection == null ? void 0 : collection.isDetached)) {
             if (this.bridge) {
               await this.bridge.put(normalizedPath, stringifiedFile);
@@ -6132,7 +6161,7 @@ var Database = class {
       }
       return true;
     };
-    this.query = async (queryOptions, hydrator, cache = {}) => {
+    this.query = async (queryOptions, hydrator) => {
       var _a;
       await this.initLevel();
       const {
@@ -6228,7 +6257,6 @@ var Database = class {
           }
           break;
         }
-        cache[filepath] = { ...value, _collection: collection.name };
         startKey = startKey || key || "";
         endKey = key || "";
         edges = [...edges, { cursor: key, path: filepath }];

package/dist/index.mjs

@@ -1622,6 +1622,25 @@ var Builder = class {
         type: astBuilder.TYPES.MultiCollectionDocument
       });
     };
+    this.buildCreateCollectionFolderMutation = async () => {
+      return astBuilder.FieldDefinition({
+        name: "createFolder",
+        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.collectionDocument = async (collection) => {
       const name = NAMER.queryName([collection.name]);
       const type = await this._buildCollectionDocumentType(collection);
@@ -3027,6 +3046,9 @@ var _buildSchema = async (builder, tinaSchema) => {
   mutationTypeDefinitionFields.push(
     await builder.buildCreateCollectionDocumentMutation(collections)
   );
+  mutationTypeDefinitionFields.push(
+    await builder.buildCreateCollectionFolderMutation()
+  );
   await sequential(collections, async (collection) => {
     queryTypeDefinitionFields.push(await builder.collectionDocument(collection));
     if (collection.isAuthCollection) {
@@ -4282,7 +4304,7 @@ var makeIndexOpsForDocument = (filepath, collection, indexDefinitions, data, opT
           type: opType,
           key: filepath,
           sublevel: indexSublevel,
-          value: opType === "put" ? data : void 0
+          value: opType === "put" ? {} : void 0
         });
       } else {
         if (indexedValue) {
@@ -4290,7 +4312,7 @@ var makeIndexOpsForDocument = (filepath, collection, indexDefinitions, data, opT
             type: opType,
             key: `${indexedValue}${INDEX_KEY_FIELD_SEPARATOR}${filepath}`,
             sublevel: indexSublevel,
-            value: opType === "put" ? data : void 0
+            value: opType === "put" ? {} : void 0
           });
         }
       }
@@ -4319,9 +4341,7 @@ var stringEscaper = makeStringEscaper(
 );
 
 // src/resolver/index.ts
-var queryCache;
 var createResolver = (args) => {
-  queryCache = {};
   return new Resolver(args);
 };
 var resolveFieldData = async ({ namespace, ...field }, rawData, accumulator, tinaSchema, config, isAudit) => {
@@ -4542,10 +4562,7 @@ var Resolver = class {
           `fullPath must be of type string for getDocumentOrDirectory request`
         );
       }
-      let rawData = queryCache[fullPath];
-      if (!rawData) {
-        rawData = await this.getRaw(fullPath);
-      }
+      const rawData = await this.getRaw(fullPath);
       if (rawData["__folderBasename"]) {
         return {
           __typename: "Folder",
@@ -4809,6 +4826,7 @@ var Resolver = class {
       isMutation,
       isCreation,
       isDeletion,
+      isFolderCreation,
       isAddPendingDocument,
       isCollectionSpecific,
       isUpdateName
@@ -4832,7 +4850,10 @@ var Resolver = class {
         (yup3) => yup3.object({ relativePath: yup3.string().required() })
       );
       const collection = await this.tinaSchema.getCollection(collectionLookup);
-      const realPath = path3.join(collection?.path, args.relativePath);
+      let realPath = path3.join(collection?.path, args.relativePath);
+      if (isFolderCreation) {
+        realPath = `${realPath}/.gitkeep`;
+      }
       const alreadyExists = await this.database.documentExists(realPath);
       if (isMutation) {
         if (isCreation) {
@@ -4845,6 +4866,16 @@ var Resolver = class {
             args,
             isAddPendingDocument
           });
+        } else if (isFolderCreation) {
+          if (alreadyExists === true) {
+            throw new Error(`Unable to add folder, ${realPath} already exists`);
+          }
+          await this.database.put(
+            realPath,
+            { _is_tina_folder_placeholder: true },
+            collection.name
+          );
+          return this.getDocument(realPath);
         }
         if (!alreadyExists) {
           if (isDeletion) {
@@ -4981,8 +5012,7 @@ var Resolver = class {
       };
       const result = await this.database.query(
         queryOptions,
-        hydrator ? hydrator : this.getDocumentOrDirectory,
-        queryCache
+        hydrator ? hydrator : this.getDocumentOrDirectory
       );
       const edges = result.edges;
       const pageInfo = result.pageInfo;
@@ -5403,7 +5433,8 @@ var resolve = async ({
                 NAMER.documentQueryName(),
                 "createDocument",
                 "updateDocument",
-                "deleteDocument"
+                "deleteDocument",
+                "createFolder"
               ].includes(info.fieldName)) {
                 const result2 = await resolver.resolveDocument({
                   args,
@@ -5411,6 +5442,7 @@ var resolve = async ({
                   isMutation,
                   isCreation,
                   isDeletion: info.fieldName === "deleteDocument",
+                  isFolderCreation: info.fieldName === "createFolder",
                   isUpdateName: Boolean(args?.params?.relativePath),
                   isAddPendingDocument: false,
                   isCollectionSpecific: false
@@ -5753,6 +5785,7 @@ var Database = class {
     };
     this.put = async (filepath, data, collectionName) => {
       await this.initLevel();
+      const isGitKeep = filepath.endsWith(".gitkeep");
       try {
         if (SYSTEM_FILES.includes(filepath)) {
           throw new Error(`Unexpected put for config file ${filepath}`);
@@ -5781,11 +5814,7 @@ var Database = class {
               );
             }
           }
-          const stringifiedFile = await this.stringifyFile(
-            filepath,
-            dataFields,
-            collection
-          );
+          const stringifiedFile = isGitKeep ? "" : await this.stringifyFile(filepath, dataFields, collection);
           if (!collection?.isDetached) {
             if (this.bridge) {
               await this.bridge.put(normalizedPath, stringifiedFile);
@@ -6053,7 +6082,7 @@ var Database = class {
       }
       return true;
     };
-    this.query = async (queryOptions, hydrator, cache = {}) => {
+    this.query = async (queryOptions, hydrator) => {
       await this.initLevel();
       const {
         first,
@@ -6148,7 +6177,6 @@ var Database = class {
           }
           break;
         }
-        cache[filepath] = { ...value, _collection: collection.name };
         startKey = startKey || key || "";
         endKey = key || "";
         edges = [...edges, { cursor: key, path: filepath }];

package/dist/resolver/index.d.ts

@@ -52,7 +52,9 @@ export declare class Resolver {
     constructor(init: ResolverConfig);
     resolveCollection: (args: any, collectionName: string, hasDocuments?: boolean) => Promise<{
         fields: TinaField<true>[];
-        templates?: undefined;
+        templates?: undefined; /**
+         * createDocument, create<Collection>Document
+         */
         label?: string;
         name: string;
         path: string;
@@ -66,6 +68,9 @@ export declare class Resolver {
         ui?: import("@tinacms/schema-tools").UICollection<any, any, any>;
         defaultItem?: import("@tinacms/schema-tools").DefaultItem<Record<string, any>>;
         frontmatterFormat?: "json" | "yaml" | "toml";
+        /**
+         * For generic functions (like `createDocument()` and `updateDocument()`), `collection` is the top key of the `params`
+         */
         frontmatterDelimiters?: string | [string, string];
         match?: {
             include?: string;
@@ -94,6 +99,9 @@ export declare class Resolver {
         ui?: import("@tinacms/schema-tools").UICollection<any, any, any>;
         defaultItem?: import("@tinacms/schema-tools").DefaultItem<Record<string, any>>;
         frontmatterFormat?: "json" | "yaml" | "toml";
+        /**
+         * For generic functions (like `createDocument()` and `updateDocument()`), `collection` is the top key of the `params`
+         */
         frontmatterDelimiters?: string | [string, string];
         match?: {
             include?: string;
@@ -237,12 +245,13 @@ export declare class Resolver {
      * values are not eliminated from Tina when new values are saved
      */
     resolveLegacyValues: (oldDoc: any, collection: Collection<true>) => {};
-    resolveDocument: ({ args, collection: collectionName, isMutation, isCreation, isDeletion, isAddPendingDocument, isCollectionSpecific, isUpdateName, }: {
+    resolveDocument: ({ args, collection: collectionName, isMutation, isCreation, isDeletion, isFolderCreation, isAddPendingDocument, isCollectionSpecific, isUpdateName, }: {
         args: unknown;
         collection?: string;
         isMutation: boolean;
         isCreation?: boolean;
         isDeletion?: boolean;
+        isFolderCreation?: boolean;
         isAddPendingDocument?: boolean;
         isCollectionSpecific?: boolean;
         isUpdateName?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tinacms/graphql",
-  "version": "0.0.0-20240507230056",
+  "version": "0.0.0-20240603083347",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "typings": "dist/index.d.ts",
@@ -24,8 +24,8 @@
   },
   "dependencies": {
     "@iarna/toml": "^2.2.5",
-    "@tinacms/mdx": "1.3.24",
-    "@tinacms/schema-tools": "1.4.15",
+    "@tinacms/mdx": "0.0.0-20240603083347",
+    "@tinacms/schema-tools": "0.0.0-20240603083347",
     "abstract-level": "^1.0.3",
     "body-parser": "^1.19.0",
     "cors": "^2.8.5",
@@ -58,8 +58,8 @@
     "directory": "packages/tina-graphql"
   },
   "devDependencies": {
-    "@tinacms/schema-tools": "1.4.15",
-    "@tinacms/scripts": "1.1.3",
+    "@tinacms/schema-tools": "0.0.0-20240603083347",
+    "@tinacms/scripts": "0.0.0-20240603083347",
     "@types/cors": "^2.8.7",
     "@types/estree": "^0.0.50",
     "@types/express": "^4.17.8",