@tinacms/graphql 0.0.0-d524599-20241117111320 → 0.0.0-d7c745e-20250102002342

package/dist/index.js

@@ -17,6 +17,10 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
   isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
   mod
 ));
@@ -130,6 +134,15 @@ var SysFieldDefinition = {
   selectionSet: {
     kind: "SelectionSet",
     selections: [
+      // {
+      //   kind: 'Field' as const,
+      //   name: {
+      //     kind: 'Name' as const,
+      //     value: 'title',
+      //   },
+      //   arguments: [],
+      //   directives: [],
+      // },
       {
         kind: "Field",
         name: {
@@ -197,6 +210,10 @@ var SysFieldDefinition = {
   }
 };
 var astBuilder = {
+  /**
+   * `FormFieldBuilder` acts as a shortcut to building an entire `ObjectTypeDefinition`, we use this
+   * because all Tina field objects share a common set of fields ('name', 'label', 'component')
+   */
   FormFieldBuilder: ({
     name,
     additionalFields
@@ -420,6 +437,8 @@ var astBuilder = {
       kind: "Name",
       value: name
     },
+    // @ts-ignore FIXME; this is being handled properly but we're lying to
+    // ts and then fixing it in the `extractInlineTypes` function
     fields
   }),
   UnionTypeDefinition: ({
@@ -432,6 +451,8 @@ var astBuilder = {
       value: name
     },
     directives: [],
+    // @ts-ignore FIXME; this is being handled properly but we're lying to
+    // ts and then fixing it in the `extractInlineTypes` function
     types: types.map((name2) => ({
       kind: "NamedType",
       name: {
@@ -528,8 +549,11 @@ var astBuilder = {
         string: "String",
         boolean: "Boolean",
         number: "Float",
+        // FIXME - needs to be float or int
         datetime: "String",
+        // FIXME
         image: "String",
+        // FIXME
         text: "String"
       };
       return scalars[type];
@@ -1028,8 +1052,7 @@ var astBuilder = {
   }
 };
 var capitalize = (s) => {
-  if (typeof s !== "string")
-    return "";
+  if (typeof s !== "string") return "";
   return s.charAt(0).toUpperCase() + s.slice(1);
 };
 var extractInlineTypes = (item) => {
@@ -1485,6 +1508,19 @@ var Builder = class {
     this.addToLookupMap = (lookup) => {
       this.lookupMap[lookup.type] = lookup;
     };
+    /**
+     * ```graphql
+     * # ex.
+     * {
+     *   getCollection(collection: $collection) {
+     *     name
+     *     documents {...}
+     *   }
+     * }
+     * ```
+     *
+     * @param collections
+     */
     this.buildCollectionDefinition = async (collections) => {
       const name = "collection";
       const typeName = "Collection";
@@ -1555,6 +1591,19 @@ var Builder = class {
         required: true
       });
     };
+    /**
+     * ```graphql
+     * # ex.
+     * {
+     *   getCollections {
+     *     name
+     *     documents {...}
+     *   }
+     * }
+     * ```
+     *
+     * @param collections
+     */
     this.buildMultiCollectionDefinition = async (collections) => {
       const name = "collections";
       const typeName = "Collection";
@@ -1565,6 +1614,17 @@ var Builder = class {
         required: true
       });
     };
+    /**
+     * ```graphql
+     * # ex.
+     * {
+     *   node(id: $id) {
+     *     id
+     *     data {...}
+     *   }
+     * }
+     * ```
+     */
     this.multiNodeDocument = async () => {
       const name = "node";
       const args = [
@@ -1585,6 +1645,19 @@ var Builder = class {
         required: true
       });
     };
+    /**
+     * ```graphql
+     * # ex.
+     * {
+     *   getDocument(collection: $collection, relativePath: $relativePath) {
+     *     id
+     *     data {...}
+     *   }
+     * }
+     * ```
+     *
+     * @param collections
+     */
     this.multiCollectionDocument = async (collections) => {
       const name = "document";
       const args = [
@@ -1610,6 +1683,19 @@ var Builder = class {
         required: true
       });
     };
+    /**
+     * ```graphql
+     * # ex.
+     * {
+     *   addPendingDocument(collection: $collection, relativePath: $relativePath, params: $params) {
+     *     id
+     *     data {...}
+     *   }
+     * }
+     * ```
+     *
+     * @param collections
+     */
     this.addMultiCollectionDocumentMutation = async () => {
       return astBuilder.FieldDefinition({
         name: "addPendingDocument",
@@ -1634,6 +1720,19 @@ var Builder = class {
         type: astBuilder.TYPES.MultiCollectionDocument
       });
     };
+    /**
+     * ```graphql
+     * # ex.
+     * {
+     *   createDocument(relativePath: $relativePath, params: $params) {
+     *     id
+     *     data {...}
+     *   }
+     * }
+     * ```
+     *
+     * @param collections
+     */
     this.buildCreateCollectionDocumentMutation = async (collections) => {
       return astBuilder.FieldDefinition({
         name: "createDocument",
@@ -1661,6 +1760,19 @@ var Builder = class {
         type: astBuilder.TYPES.MultiCollectionDocument
       });
     };
+    /**
+     * ```graphql
+     * # ex.
+     * {
+     *   updateDocument(relativePath: $relativePath, params: $params) {
+     *     id
+     *     data {...}
+     *   }
+     * }
+     * ```
+     *
+     * @param collections
+     */
     this.buildUpdateCollectionDocumentMutation = async (collections) => {
       return astBuilder.FieldDefinition({
         name: "updateDocument",
@@ -1688,6 +1800,19 @@ var Builder = class {
         type: astBuilder.TYPES.MultiCollectionDocument
       });
     };
+    /**
+     * ```graphql
+     * # ex.
+     * {
+     *   deleteDocument(relativePath: $relativePath, params: $params) {
+     *     id
+     *     data {...}
+     *   }
+     * }
+     * ```
+     *
+     * @param collections
+     */
     this.buildDeleteCollectionDocumentMutation = async (collections) => {
       return astBuilder.FieldDefinition({
         name: "deleteDocument",
@@ -1707,6 +1832,19 @@ var Builder = class {
         type: astBuilder.TYPES.MultiCollectionDocument
       });
     };
+    /**
+     * ```graphql
+     * # ex.
+     * {
+     *   createFolder(folderName: $folderName, params: $params) {
+     *     id
+     *     data {...}
+     *   }
+     * }
+     * ```
+     *
+     * @param collections
+     */
     this.buildCreateCollectionFolderMutation = async () => {
       return astBuilder.FieldDefinition({
         name: "createFolder",
@@ -1726,6 +1864,19 @@ var Builder = class {
         type: astBuilder.TYPES.MultiCollectionDocument
       });
     };
+    /**
+     * ```graphql
+     * # ex.
+     * {
+     *   getPostDocument(relativePath: $relativePath) {
+     *     id
+     *     data {...}
+     *   }
+     * }
+     * ```
+     *
+     * @param collection
+     */
     this.collectionDocument = async (collection) => {
       const name = NAMER.queryName([collection.name]);
       const type = await this._buildCollectionDocumentType(collection);
@@ -1786,6 +1937,20 @@ var Builder = class {
       const args = [];
       return astBuilder.FieldDefinition({ type, name, args, required: false });
     };
+    /**
+     * Turns a collection into a fragment that gets updated on build. This fragment does not resolve references
+     * ```graphql
+     * # ex.
+     * fragment AuthorsParts on Authors {
+     *   name
+     *   avatar
+     *   ...
+     * }
+     * ```
+     *
+     * @public
+     * @param collection a Tina Cloud collection
+     */
     this.collectionFragment = async (collection) => {
       const name = NAMER.dataTypeName(collection.namespace);
       const fragmentName = NAMER.fragmentName(collection.namespace);
@@ -1799,6 +1964,20 @@ var Builder = class {
         selections: filterSelections(selections)
       });
     };
+    /**
+     * Given a collection this function returns its selections set. For example for Post this would return
+     *
+     * "
+     * body
+     * title
+     * ... on Author {
+     *   name
+     *   heroImg
+     * }
+     *
+     * But in the AST format
+     *
+     * */
     this._getCollectionFragmentSelections = async (collection, depth) => {
       var _a;
       const selections = [];
@@ -1882,9 +2061,9 @@ var Builder = class {
               ]
             });
           }
+        // TODO: Should we throw here?
         case "reference":
-          if (depth >= this.maxDepth)
-            return false;
+          if (depth >= this.maxDepth) return false;
           if (!("collections" in field)) {
             return false;
           }
@@ -1916,6 +2095,7 @@ var Builder = class {
             name: field.name,
             selections: [
               ...selections,
+              // This is ... on Document { id }
               {
                 kind: "InlineFragment",
                 typeCondition: {
@@ -1946,6 +2126,19 @@ var Builder = class {
           });
       }
     };
+    /**
+     * ```graphql
+     * # ex.
+     * mutation {
+     *   updatePostDocument(relativePath: $relativePath, params: $params) {
+     *     id
+     *     data {...}
+     *   }
+     * }
+     * ```
+     *
+     * @param collection
+     */
     this.updateCollectionDocumentMutation = async (collection) => {
       return astBuilder.FieldDefinition({
         type: await this._buildCollectionDocumentType(collection),
@@ -1965,6 +2158,19 @@ var Builder = class {
         ]
       });
     };
+    /**
+     * ```graphql
+     * # ex.
+     * mutation {
+     *   createPostDocument(relativePath: $relativePath, params: $params) {
+     *     id
+     *     data {...}
+     *   }
+     * }
+     * ```
+     *
+     * @param collection
+     */
     this.createCollectionDocumentMutation = async (collection) => {
       return astBuilder.FieldDefinition({
         type: await this._buildCollectionDocumentType(collection),
@@ -1984,6 +2190,22 @@ var Builder = class {
         ]
       });
     };
+    /**
+     * ```graphql
+     * # ex.
+     * {
+     *   getPostList(first: 10) {
+     *     edges {
+     *       node {
+     *         id
+     *       }
+     *     }
+     *   }
+     * }
+     * ```
+     *
+     * @param collection
+     */
     this.collectionDocumentList = async (collection) => {
       const connectionName = NAMER.referenceConnectionType(collection.namespace);
       this.addToLookupMap({
@@ -1999,6 +2221,10 @@ var Builder = class {
         collection
       });
     };
+    /**
+     * GraphQL type definitions which remain unchanged regardless
+     * of the supplied Tina schema. Ex. "node" interface
+     */
     this.buildStaticDefinitions = () => staticDefinitions;
     this._buildCollectionDocumentType = async (collection, suffix = "", extraFields = [], extraInterfaces = []) => {
       const documentTypeName = NAMER.documentTypeName(collection.namespace);
@@ -2503,6 +2729,7 @@ var Builder = class {
             name: NAMER.dataFilterTypeName(namespace),
             fields: await sequential(collections, async (collection2) => {
               return astBuilder.InputValueDefinition({
+                // @ts-ignore
                 name: collection2.name,
                 type: NAMER.dataFilterTypeName(collection2.namespace)
               });
@@ -2692,7 +2919,8 @@ Visit https://tina.io/docs/errors/ui-not-supported/ for more information
       });
     };
     var _a, _b, _c, _d;
-    this.maxDepth = (_d = (_c = (_b = (_a = config == null ? void 0 : config.tinaSchema.schema) == null ? void 0 : _a.config) == null ? void 0 : _b.client) == null ? void 0 : _c.referenceDepth) != null ? _d : 2;
+    this.maxDepth = // @ts-ignore
+    (_d = (_c = (_b = (_a = config == null ? void 0 : config.tinaSchema.schema) == null ? void 0 : _a.config) == null ? void 0 : _b.client) == null ? void 0 : _c.referenceDepth) != null ? _d : 2;
     this.tinaSchema = config.tinaSchema;
     this.lookupMap = {};
   }
@@ -2703,8 +2931,7 @@ Visit https://tina.io/docs/errors/ui-not-supported/ for more information
       selections.push(field);
     });
     const filteredSelections = filterSelections(selections);
-    if (!filteredSelections.length)
-      return false;
+    if (!filteredSelections.length) return false;
     return astBuilder.InlineFragmentDefinition({
       selections: filteredSelections,
       name: NAMER.dataTypeName(template.namespace)
@@ -2785,6 +3012,7 @@ var validationCollectionsPathAndMatch = (collections) => {
   }).map((x) => `${x.path}${x.format || "md"}`);
   if (noMatchCollections.length !== new Set(noMatchCollections).size) {
     throw new Error(
+      // TODO: add a link to the docs
       "Two collections without match can not have the same `path`. Please make the `path` unique or add a matches property to the collection."
     );
   }
@@ -2896,7 +3124,7 @@ var validateField = async (field) => {
 // package.json
 var package_default = {
   name: "@tinacms/graphql",
-  version: "1.5.7",
+  version: "1.5.9",
   main: "dist/index.js",
   module: "dist/index.mjs",
   typings: "dist/index.d.ts",
@@ -3053,6 +3281,7 @@ var _buildFragments = async (builder, tinaSchema) => {
   const fragDoc = {
     kind: "Document",
     definitions: (0, import_lodash3.default)(
+      // @ts-ignore
       extractInlineTypes(fragmentDefinitionsFields),
       (node) => node.name.value
     )
@@ -3076,6 +3305,7 @@ var _buildQueries = async (builder, tinaSchema) => {
         fragName,
         queryName: queryListName,
         filterType: queryFilterTypeName,
+        // look for flag to see if the data layer is enabled
         dataLayer: Boolean(
           (_c = (_b = (_a = tinaSchema.config) == null ? void 0 : _a.meta) == null ? void 0 : _b.flags) == null ? void 0 : _c.find((x) => x === "experimentalData")
         )
@@ -3085,6 +3315,7 @@ var _buildQueries = async (builder, tinaSchema) => {
   const queryDoc = {
     kind: "Document",
     definitions: (0, import_lodash3.default)(
+      // @ts-ignore
       extractInlineTypes(operationsDefinitions),
       (node) => node.name.value
     )
@@ -3173,6 +3404,7 @@ var _buildSchema = async (builder, tinaSchema) => {
   return {
     kind: "Document",
     definitions: (0, import_lodash3.default)(
+      // @ts-ignore
       extractInlineTypes(definitions),
       (node) => node.name.value
     )
@@ -3377,8 +3609,7 @@ var resolveMediaCloudToRelative = (value, config = { useRelativeMedia: true }, s
       }
       if (Array.isArray(value)) {
         return value.map((v) => {
-          if (!v || typeof v !== "string")
-            return v;
+          if (!v || typeof v !== "string") return v;
           const cleanMediaRoot = cleanUpSlashes(
             schema.config.media.tina.mediaRoot
           );
@@ -3406,8 +3637,7 @@ var resolveMediaRelativeToCloud = (value, config = { useRelativeMedia: true }, s
       }
       if (Array.isArray(value)) {
         return value.map((v) => {
-          if (!v || typeof v !== "string")
-            return v;
+          if (!v || typeof v !== "string") return v;
           const strippedValue = v.replace(cleanMediaRoot, "");
           return `https://${config.assetsHost}/${config.clientId}${strippedValue}`;
         });
@@ -3426,8 +3656,7 @@ var cleanUpSlashes = (path7) => {
 };
 var hasTinaMediaConfig = (schema) => {
   var _a, _b, _c, _d, _e, _f, _g, _h;
-  if (!((_b = (_a = schema.config) == null ? void 0 : _a.media) == null ? void 0 : _b.tina))
-    return false;
+  if (!((_b = (_a = schema.config) == null ? void 0 : _a.media) == null ? void 0 : _b.tina)) return false;
   if (typeof ((_e = (_d = (_c = schema.config) == null ? void 0 : _c.media) == null ? void 0 : _d.tina) == null ? void 0 : _e.publicFolder) !== "string" && typeof ((_h = (_g = (_f = schema.config) == null ? void 0 : _f.media) == null ? void 0 : _g.tina) == null ? void 0 : _h.mediaRoot) !== "string")
     return false;
   return true;
@@ -3471,6 +3700,7 @@ var LevelProxyHandler = {
     } else if (property === "sublevel") {
       return (...args) => {
         return new Proxy(
+          // eslint-disable-next-line prefer-spread
           target[property].apply(target, args),
           LevelProxyHandler
         );
@@ -4349,6 +4579,7 @@ var makeFolderOpsForCollection = (folderTree, collection, indexDefinitions, opTy
           result.push({
             type: opType,
             key: `${collection.path}/${subFolderKey}.${collection.format}`,
+            // replace the root with the collection path
             sublevel: indexSublevel,
             value: {}
           });
@@ -4464,6 +4695,7 @@ var resolveFieldData = async ({ namespace, ...field }, rawData, accumulator, tin
     case "password":
       accumulator[field.name] = {
         value: void 0,
+        // never resolve the password hash
         passwordChangeRequired: (_a = value["passwordChangeRequired"]) != null ? _a : false
       };
       break;
@@ -4658,6 +4890,7 @@ var Resolver = class {
       const collection = this.tinaSchema.getCollection(collectionName);
       const extraFields = {};
       return {
+        // return the collection and hasDocuments to resolve documents at a lower level
         documents: { collection, hasDocuments },
         ...collection,
         ...extraFields
@@ -4744,7 +4977,9 @@ var Resolver = class {
           );
         } else {
           return this.buildFieldMutations(
+            // @ts-ignore FIXME Argument of type 'string | object' is not assignable to parameter of type '{ [fieldName: string]: string | object | (string | object)[]; }'
             fieldValue,
+            //@ts-ignore
             objectTemplate,
             existingData
           );
@@ -4756,6 +4991,7 @@ var Resolver = class {
             fieldValue.map(async (item) => {
               if (typeof item === "string") {
                 throw new Error(
+                  //@ts-ignore
                   `Expected object for template value for field ${field.name}`
                 );
               }
@@ -4764,16 +5000,19 @@ var Resolver = class {
               });
               const [templateName] = Object.entries(item)[0];
               const template = templates.find(
+                //@ts-ignore
                 (template2) => template2.name === templateName
               );
               if (!template) {
                 throw new Error(`Expected to find template ${templateName}`);
               }
               return {
+                // @ts-ignore FIXME Argument of type 'unknown' is not assignable to parameter of type '{ [fieldName: string]: string | { [key: string]: unknown; } | (string | { [key: string]: unknown; })[]; }'
                 ...await this.buildFieldMutations(
                   item[template.name],
                   template
                 ),
+                //@ts-ignore
                 _template: template.name
               };
             })
@@ -4781,6 +5020,7 @@ var Resolver = class {
         } else {
           if (typeof fieldValue === "string") {
             throw new Error(
+              //@ts-ignore
               `Expected object for template value for field ${field.name}`
             );
           }
@@ -4789,16 +5029,19 @@ var Resolver = class {
           });
           const [templateName] = Object.entries(fieldValue)[0];
           const template = templates.find(
+            //@ts-ignore
             (template2) => template2.name === templateName
           );
           if (!template) {
             throw new Error(`Expected to find template ${templateName}`);
           }
           return {
+            // @ts-ignore FIXME Argument of type 'unknown' is not assignable to parameter of type '{ [fieldName: string]: string | { [key: string]: unknown; } | (string | { [key: string]: unknown; })[]; }'
             ...await this.buildFieldMutations(
               fieldValue[template.name],
               template
             ),
+            //@ts-ignore
             _template: template.name
           };
         }
@@ -4838,6 +5081,7 @@ var Resolver = class {
         return this.getDocument(realPath);
       }
       const params = await this.buildObjectMutations(
+        // @ts-ignore
         args.params[collection.name],
         collection
       );
@@ -4883,6 +5127,7 @@ var Resolver = class {
                 const values = {
                   ...oldDoc,
                   ...await this.buildFieldMutations(
+                    // @ts-ignore FIXME: failing on unknown, which we don't need to know because it's recursive
                     templateParams,
                     template,
                     doc == null ? void 0 : doc._rawData
@@ -4896,6 +5141,7 @@ var Resolver = class {
         return this.getDocument(realPath);
       }
       const params = await this.buildObjectMutations(
+        //@ts-ignore
         isCollectionSpecific ? args.params : args.params[collection.name],
         collection,
         doc == null ? void 0 : doc._rawData
@@ -4903,6 +5149,10 @@ var Resolver = class {
       await this.database.put(realPath, { ...oldDoc, ...params }, collection.name);
       return this.getDocument(realPath);
     };
+    /**
+     * Returns top-level fields which are not defined in the collection, so their
+     * values are not eliminated from Tina when new values are saved
+     */
     this.resolveLegacyValues = (oldDoc, collection) => {
       const legacyValues = {};
       Object.entries(oldDoc).forEach(([key, value]) => {
@@ -5109,6 +5359,7 @@ var Resolver = class {
           },
           collection: referencedCollection,
           hydrator: (path7) => path7
+          // just return the path
         }
       );
       const { edges } = resolvedCollectionConnection;
@@ -5176,6 +5427,12 @@ var Resolver = class {
         }
       };
     };
+    /**
+     * Checks if a document has references to it
+     * @param id  The id of the document to check for references
+     * @param c The collection to check for references
+     * @returns true if the document has references, false otherwise
+     */
     this.hasReferences = async (id, c) => {
       let count = 0;
       const deepRefs = this.tinaSchema.findReferences(c.name);
@@ -5210,6 +5467,12 @@ var Resolver = class {
       }
       return false;
     };
+    /**
+     * Finds references to a document
+     * @param id the id of the document to find references to
+     * @param c the collection to find references in
+     * @returns references to the document in the form of a map of collection names to a list of fields that reference the document
+     */
     this.findReferences = async (id, c) => {
       const references = {};
       const deepRefs = this.tinaSchema.findReferences(c.name);
@@ -5337,6 +5600,27 @@ var Resolver = class {
       }
       return accum;
     };
+    /**
+     * A mutation looks nearly identical between updateDocument:
+     * ```graphql
+     * updateDocument(collection: $collection,relativePath: $path, params: {
+     *   post: {
+     *     title: "Hello, World"
+     *   }
+     * })`
+     * ```
+     * and `updatePostDocument`:
+     * ```graphql
+     * updatePostDocument(relativePath: $path, params: {
+     *   title: "Hello, World"
+     * })
+     * ```
+     * The problem here is that we don't know whether the payload came from `updateDocument`
+     * or `updatePostDocument` (we could, but for now it's easier not to pipe those details through),
+     * But we do know that when given a `args.collection` value, we can assume that
+     * this was a `updateDocument` request, and thus - should grab the data
+     * from the corresponding field name in the key
+     */
     this.buildParams = (args) => {
       try {
         assertShape(
@@ -5437,7 +5721,10 @@ var resolve = async ({
     const graphQLSchema = (0, import_graphql5.buildASTSchema)(graphQLSchemaAst);
     const tinaConfig = await database.getTinaSchema();
     const tinaSchema = await createSchema({
+      // TODO: please update all the types to import from @tinacms/schema-tools
+      // @ts-ignore
       schema: tinaConfig,
+      // @ts-ignore
       flags: (_a = tinaConfig == null ? void 0 : tinaConfig.meta) == null ? void 0 : _a.flags
     });
     const resolver = createResolver({
@@ -5454,8 +5741,7 @@ var resolve = async ({
         database
       },
       typeResolver: async (source, _args, info) => {
-        if (source.__typename)
-          return source.__typename;
+        if (source.__typename) return source.__typename;
         const namedType = (0, import_graphql5.getNamedType)(info.returnType).toString();
         const lookup = await database.getLookup(namedType);
         if (lookup.resolveType === "unionData") {
@@ -5607,11 +5893,13 @@ var resolve = async ({
             (0, import_lodash4.default)(
               params,
               userField.path.slice(1),
+              // remove _rawData from users path
               users.map((u) => {
                 if (user[idFieldName] === u[idFieldName]) {
                   return user;
                 }
                 return {
+                  // don't overwrite other users' passwords
                   ...u,
                   [passwordFieldName]: {
                     ...u[passwordFieldName],
@@ -5634,6 +5922,9 @@ var resolve = async ({
           }
           const isCreation = lookup[info.fieldName] === "create";
           switch (lookup.resolveType) {
+            /**
+             * `node(id: $id)`
+             */
             case "nodeDocument":
               assertShape(
                 args,
@@ -5665,6 +5956,7 @@ var resolve = async ({
                   collection: args.collection,
                   isMutation,
                   isCreation,
+                  // Right now this is the only case for deletion
                   isDeletion: info.fieldName === "deleteDocument",
                   isFolderCreation: info.fieldName === "createFolder",
                   isUpdateName: Boolean((_a2 = args == null ? void 0 : args.params) == null ? void 0 : _a2.relativePath),
@@ -5674,6 +5966,9 @@ var resolve = async ({
                 return result;
               }
               return value;
+            /**
+             * eg `getMovieDocument.data.actors`
+             */
             case "multiCollectionDocumentList":
               if (Array.isArray(value)) {
                 return {
@@ -5685,7 +5980,15 @@ var resolve = async ({
               }
               if (info.fieldName === "documents" && (value == null ? void 0 : value.collection) && (value == null ? void 0 : value.hasDocuments)) {
                 let filter = args.filter;
-                if (typeof (args == null ? void 0 : args.filter) !== "undefined" && (args == null ? void 0 : args.filter) !== null && typeof ((_b = value == null ? void 0 : value.collection) == null ? void 0 : _b.name) === "string" && Object.keys(args.filter).includes((_c = value == null ? void 0 : value.collection) == null ? void 0 : _c.name) && typeof args.filter[(_d = value == null ? void 0 : value.collection) == null ? void 0 : _d.name] !== "undefined") {
+                if (
+                  // 1. Make sure that the filter exists
+                  typeof (args == null ? void 0 : args.filter) !== "undefined" && (args == null ? void 0 : args.filter) !== null && // 2. Make sure that the collection name exists
+                  // @ts-ignore
+                  typeof ((_b = value == null ? void 0 : value.collection) == null ? void 0 : _b.name) === "string" && // 3. Make sure that the collection name is in the filter and is not undefined
+                  // @ts-ignore
+                  Object.keys(args.filter).includes((_c = value == null ? void 0 : value.collection) == null ? void 0 : _c.name) && // @ts-ignore
+                  typeof args.filter[(_d = value == null ? void 0 : value.collection) == null ? void 0 : _d.name] !== "undefined"
+                ) {
                   filter = args.filter[value.collection.name];
                 }
                 return resolver.resolveCollectionConnection({
@@ -5693,12 +5996,20 @@ var resolve = async ({
                     ...args,
                     filter
                   },
+                  // @ts-ignore
                   collection: value.collection
                 });
               }
               throw new Error(
                 `Expected an array for result of ${info.fieldName} at ${info.path}`
               );
+            /**
+             * Collections-specific getter
+             * eg. `getPostDocument`/`createPostDocument`/`updatePostDocument`
+             *
+             * if coming from a query result
+             * the field will be `node`
+             */
             case "collectionDocument": {
               if (value) {
                 return value;
@@ -5713,11 +6024,32 @@ var resolve = async ({
               });
               return result;
             }
+            /**
+             * Collections-specific list getter
+             * eg. `getPageList`
+             */
             case "collectionDocumentList":
               return resolver.resolveCollectionConnection({
                 args,
                 collection: tinaSchema.getCollection(lookup.collection)
               });
+            /**
+             * A polymorphic data set, it can be from a document's data
+             * of any nested object which can be one of many shapes
+             *
+             * ```graphql
+             * getPostDocument(relativePath: $relativePath) {
+             *   data {...} <- this part
+             * }
+             * ```
+             * ```graphql
+             * getBlockDocument(relativePath: $relativePath) {
+             *   data {
+             *     blocks {...} <- or this part
+             *   }
+             * }
+             * ```
+             */
             case "unionData":
               if (!value) {
                 if (args.relativePath) {
@@ -5782,8 +6114,7 @@ var TinaLevelClient = class extends import_many_level.ManyLevelGuest {
     this.port = port || 9e3;
   }
   openConnection() {
-    if (this._connected)
-      return;
+    if (this._connected) return;
     const socket = (0, import_net.connect)(this.port);
     (0, import_readable_stream.pipeline)(socket, this.createRpcStream(), socket, () => {
       this._connected = false;
@@ -5964,6 +6295,7 @@ var Database = class {
             "put",
             level
           ),
+          // folder indices
           ...makeIndexOpsForDocument(
             normalizedPath,
             `${collection == null ? void 0 : collection.name}_${folderKey}`,
@@ -5986,6 +6318,7 @@ var Database = class {
             "del",
             level
           ),
+          // folder indices
           ...makeIndexOpsForDocument(
             normalizedPath,
             `${collection == null ? void 0 : collection.name}_${folderKey}`,
@@ -6080,6 +6413,7 @@ var Database = class {
                 "put",
                 level
               ),
+              // folder indices
               ...makeIndexOpsForDocument(
                 normalizedPath,
                 `${collection == null ? void 0 : collection.name}_${folderKey}`,
@@ -6102,6 +6436,7 @@ var Database = class {
                 "del",
                 level
               ),
+              // folder indices
               ...makeIndexOpsForDocument(
                 normalizedPath,
                 `${collection == null ? void 0 : collection.name}_${folderKey}`,
@@ -6179,6 +6514,7 @@ var Database = class {
         aliasedData,
         extension,
         writeTemplateKey,
+        //templateInfo.type === 'union',
         {
           frontmatterFormat: collection == null ? void 0 : collection.frontmatterFormat,
           frontmatterDelimiters: collection == null ? void 0 : collection.frontmatterDelimiters
@@ -6217,6 +6553,7 @@ var Database = class {
         SUBLEVEL_OPTIONS
       ).get(graphqlPath);
     };
+    //TODO - is there a reason why the database fetches some config with "bridge.get", and some with "store.get"?
     this.getGraphQLSchemaFromBridge = async () => {
       if (!this.bridge) {
         throw new Error(`No bridge configured`);
@@ -6263,6 +6600,7 @@ var Database = class {
             for (const collection of collections) {
               const indexDefinitions = {
                 [DEFAULT_COLLECTION_SORT_KEY]: { fields: [] }
+                // provide a default sort key which is the file sort
               };
               if (collection.fields) {
                 for (const field of collection.fields) {
@@ -6587,12 +6925,12 @@ var Database = class {
       if (collection == null ? void 0 : collection.isDetached) {
         level = this.appLevel.sublevel(collection == null ? void 0 : collection.name, SUBLEVEL_OPTIONS);
       }
-      const itemKey = (0, import_schema_tools3.normalizePath)(filepath);
+      const normalizedPath = (0, import_schema_tools3.normalizePath)(filepath);
       const rootSublevel = level.sublevel(
         CONTENT_ROOT_PREFIX,
         SUBLEVEL_OPTIONS
       );
-      const item = await rootSublevel.get(itemKey);
+      const item = await rootSublevel.get(normalizedPath);
       if (item) {
         const folderTreeBuilder = new FolderTreeBuilder();
         const folderKey = folderTreeBuilder.update(
@@ -6601,15 +6939,16 @@ var Database = class {
         );
         await this.contentLevel.batch([
           ...makeIndexOpsForDocument(
-            filepath,
+            normalizedPath,
             collection.name,
             collectionIndexDefinitions,
             item,
             "del",
             level
           ),
+          // folder indices
           ...makeIndexOpsForDocument(
-            filepath,
+            normalizedPath,
             `${collection.name}_${folderKey}`,
             collectionIndexDefinitions,
             item,
@@ -6618,17 +6957,17 @@ var Database = class {
           ),
           {
             type: "del",
-            key: itemKey,
+            key: normalizedPath,
             sublevel: rootSublevel
           }
         ]);
       }
       if (!(collection == null ? void 0 : collection.isDetached)) {
         if (this.bridge) {
-          await this.bridge.delete((0, import_schema_tools3.normalizePath)(filepath));
+          await this.bridge.delete(normalizedPath);
         }
         try {
-          await this.onDelete((0, import_schema_tools3.normalizePath)(filepath));
+          await this.onDelete(normalizedPath);
         } catch (e) {
           throw new import_graphql6.GraphQLError(
             `Error running onDelete hook for ${filepath}: ${e}`,
@@ -6762,6 +7101,9 @@ var Database = class {
       info: templateInfo
     };
   }
+  /**
+   * Clears the internal cache of the tinaSchema and the lookup file. This allows the state to be reset
+   */
   clearCache() {
     this.tinaSchema = null;
     this._lookup = null;
@@ -6858,6 +7200,7 @@ var _indexContent = async (database, level, documentPaths, enqueueOps, collectio
             "put",
             level
           ),
+          // folder indexes
           ...makeIndexOpsForDocument(
             normalizedPath,
             `${collection == null ? void 0 : collection.name}_${folderKey}`,
@@ -6943,6 +7286,7 @@ var _deleteIndexContent = async (database, documentPaths, enqueueOps, collection
           "del",
           database.contentLevel
         ),
+        // folder indexes
         ...makeIndexOpsForDocument(
           itemKey,
           `${collection == null ? void 0 : collection.name}_${folderKey}`,
@@ -7158,17 +7502,26 @@ var IsomorphicBridge = class {
   getAuthor() {
     return {
       ...this.author,
-      timestamp: Math.round(new Date().getTime() / 1e3),
+      timestamp: Math.round((/* @__PURE__ */ new Date()).getTime() / 1e3),
       timezoneOffset: 0
     };
   }
   getCommitter() {
     return {
       ...this.committer,
-      timestamp: Math.round(new Date().getTime() / 1e3),
+      timestamp: Math.round((/* @__PURE__ */ new Date()).getTime() / 1e3),
       timezoneOffset: 0
     };
   }
+  /**
+   * Recursively populate paths matching `pattern` for the given `entry`
+   *
+   * @param pattern - pattern to filter paths by
+   * @param entry - TreeEntry to start building list from
+   * @param path - base path
+   * @param results
+   * @private
+   */
   async listEntries({
     pattern,
     entry,
@@ -7201,6 +7554,15 @@ var IsomorphicBridge = class {
       });
     }
   }
+  /**
+   * For the specified path, returns an object with an array containing the parts of the path (pathParts)
+   * and an array containing the WalkerEntry objects for the path parts (pathEntries). Any null elements in the
+   * pathEntries are placeholders for non-existent entries.
+   *
+   * @param path - path being resolved
+   * @param ref - ref to resolve path entries for
+   * @private
+   */
   async resolvePathEntries(path7, ref) {
     let pathParts = path7.split("/");
     const result = await import_isomorphic_git2.default.walk({
@@ -7231,6 +7593,17 @@ var IsomorphicBridge = class {
     }
     return { pathParts, pathEntries };
   }
+  /**
+   * Updates tree entry and associated parent tree entries
+   *
+   * @param existingOid - the existing OID
+   * @param updatedOid - the updated OID
+   * @param path - the path of the entry being updated
+   * @param type - the type of the entry being updated (blob or tree)
+   * @param pathEntries - parent path entries
+   * @param pathParts - parent path parts
+   * @private
+   */
   async updateTreeHierarchy(existingOid, updatedOid, path7, type, pathEntries, pathParts) {
     const lastIdx = pathEntries.length - 1;
     const parentEntry = pathEntries[lastIdx];
@@ -7286,6 +7659,13 @@ var IsomorphicBridge = class {
       );
     }
   }
+  /**
+   * Creates a commit for the specified tree and updates the specified ref to point to the commit
+   *
+   * @param treeSha - sha of the new tree
+   * @param ref - the ref that should be updated
+   * @private
+   */
   async commitTree(treeSha, ref) {
     const commitSha = await import_isomorphic_git2.default.writeCommit({
       ...this.isomorphicConfig,
@@ -7298,6 +7678,7 @@ var IsomorphicBridge = class {
           })
         ],
         message: this.commitMessage,
+        // TODO these should be configurable
         author: this.getAuthor(),
         committer: this.getCommitter()
       }
@@ -7536,5 +7917,5 @@ var buildSchema = async (config, flags) => {
   transformDocument,
   transformDocumentIntoPayload
 });
-//! Replaces _.flattenDeep()
 //! Replaces _.get()
+//! Replaces _.flattenDeep()