add error messages, prevent creating record with existing id, use referenceField with filtering

Author: odama626

examples/content/markdown/authors/Adam.md

@@ -0,0 +1,9 @@
+---
+name: Adam
+friend: Amanda
+enjoys:
+  - cats
+  - coding
+  - flatbread
+---
+

examples/content/markdown/authors/Amanda.md

@@ -0,0 +1,8 @@
+---
+name: Amanda
+enjoys:
+  - cats
+  - coding
+  - flatbread
+---
+

examples/content/markdown/authors/daes.md

@@ -6,7 +6,7 @@ enjoys:
   - cats
   - coffee
   - design
-friend: 40s3
+friend: Eva
 date_joined: 2021-04-22T16:41:59.558Z
 skills:
   sitting: 304

examples/content/markdown/authors/eva.md

@@ -8,7 +8,7 @@ enjoys:
   - mow mow
   - sleepy time
   - attention
-friend: 2a3e
+friend: Tony
 image: eva.svg
 date_joined: 2002-02-25T16:41:59.558Z
 skills:

examples/content/markdown/authors/tony.md

@@ -6,7 +6,7 @@ enjoys:
   - cats
   - tea
   - making this
-friend: 40s3
+friend: Eva
 image: tony.svg
 date_joined: 2021-02-25T16:41:59.558Z
 skills:

examples/content/markdown/authors/yoshi.md

@@ -7,7 +7,7 @@ enjoys:
   - encroaching upon personal space
   - being concerned
   - smooth jazz
-friend: ab2c
+friend: Daes
 date_joined: 2018-10-25T16:23:59.558Z
 skills:
   sitting: 10

examples/content/markdown/posts/anotha-one.md

@@ -2,8 +2,8 @@
 id: 92348fds-453fdh-59ddsd-3332-09876
 title: 'Test post A'
 authors:
-  - 40s3
-  - 2a3e
+  - Eva
+  - Tony
 rating: 84.3
 ---
 

examples/content/markdown/posts/b.md

@@ -2,8 +2,8 @@
 id: 2348fds-563fdh-59ddsd-3332-09876
 title: 'Test post B'
 authors:
-  - 1111
-  - ab2c
+  - Ushi
+  - Daes
 rating: 44
 ---
 

examples/content/markdown/posts/example-post.md

@@ -2,8 +2,8 @@
 id: sdfsdf-23423-sdfsd-23444-dfghf
 title: 'Example post of things'
 authors:
-  - 2a3e
-  - 40s3
+  - Tony
+  - Eva
 rating: 74
 ---
 

examples/content/markdown/posts/soup.md

@@ -2,8 +2,7 @@
 id: jksfd4-234fdh-5345fj-3455-09836
 title: 'Soup Reflection'
 authors:
-  - r3c6
-  - ab2c
+  - Yoshi
 rating: 96
 ---
 

examples/sveltekit/flatbread.config.js

@@ -34,6 +34,7 @@ export default defineConfig({
     {
       path: 'content/markdown/authors',
       name: 'Author',
+      referenceField: 'name',
       refs: {
         friend: 'Author',
       },

packages/core/src/errors.ts

@@ -2,8 +2,7 @@ import { outdent } from './utils/outdent';
 
 export class IllegalFieldNameError extends Error {
   constructor(illegalSequence: string) {
-    super();
-    this.message = outdent`
+    super(outdent`
       The sequence "${illegalSequence}" is reserved and not allowed in field names
       Either:
         - remove all instances of "${illegalSequence}" in the names of fields in your content
@@ -13,6 +12,22 @@ export class IllegalFieldNameError extends Error {
               ...,
               fieldNameTransform: (value) => value.replaceAll("${illegalSequence}",'-')
             }
-      `;
+      `);
   }
 }
+
+export class ReferenceAlreadyExistsError<K extends Record<string, K>> extends Error {
+  constructor(
+    payload: K,
+    collectionName: string,
+    metadata: { referenceField: string; reference: string }
+  ) {
+    const payloadString = JSON.stringify(payload, null, 2);
+    super(
+      outdent`
+      Failed to create
+      ${payloadString}
+      ${collectionName} with ${metadata.referenceField} of ${metadata.reference} already exists`
+    );
+  }
+}

packages/core/src/generators/arguments.ts

@@ -17,7 +17,7 @@ export const generateArgsForAllItemQuery = (pluralType: string) => ({
  * @param pluralType plural name of the content type
  */
 export const generateArgsForManyItemQuery = (pluralType: string) => ({
-  ids: {
+  references: {
     type: '[String]',
   },
   ...skip(),
@@ -26,16 +26,6 @@ export const generateArgsForManyItemQuery = (pluralType: string) => ({
   ...sortBy(pluralType),
 });
 
-/**
- * Generates the accepted arguments for a 'single-item' query on a content type.
- *
- */
-export const generateArgsForSingleItemQuery = () => ({
-  id: {
-    type: 'String',
-  },
-});
-
 /**
  * Argument for skipping the first `n` items from the query results.
  */

packages/core/src/generators/collectionMutations.ts

@@ -1,5 +1,6 @@
 import { ObjectTypeComposer, SchemaComposer } from 'graphql-compose';
 import { get, merge } from 'lodash-es';
+import { ReferenceAlreadyExistsError } from '../errors';
 import {
   CollectionContext,
   CollectionEntry,
@@ -17,17 +18,15 @@ export interface AddCollectionMutationsArgs {
   collectionEntry: LoadedCollectionEntry;
   updateCollectionRecord: (
     collection: CollectionEntry,
-    entry: EntryNode & { _metadata: CollectionContext }
+    entry: EntryNode & { _metadata: Partial<CollectionContext> }
   ) => Promise<EntryNode>;
 }
 
 export default function addCollectionMutations(
   args: AddCollectionMutationsArgs
-) {
+): void {
   const {
     name,
-    pluralName,
-    config,
     objectComposer,
     schemaComposer,
     updateCollectionRecord,
@@ -41,27 +40,42 @@ export default function addCollectionMutations(
     // remove _metadata to prevent injection
     const { _metadata, ...update } = payload?.[name];
 
-    const targetRecord = objectComposer
-      .getResolver('findById')
-      .resolve({ args: update });
-
     // remove supplied key (might not be required)
-    delete update[targetRecord._metadata.referenceField];
-    const newRecord = merge(targetRecord, update);
+    delete update[existing._metadata.referenceField];
+    const newRecord = merge(existing, update);
 
-    await updateCollectionRecord(collectionEntry, newRecord);
+    await updateCollectionRecord(
+      collectionEntry,
+      newRecord as EntryNode & { _metadata: Partial<CollectionContext> }
+    );
 
     return newRecord;
   }
 
   async function create(source: unknown, payload: Record<string, EntryNode>) {
+    const existingRecordWithId = await objectComposer
+      .getResolver('findByReferenceField')
+      .resolve({ args: payload[name] });
+
+    if (existingRecordWithId) {
+      throw new ReferenceAlreadyExistsError(
+        payload[name],
+        name,
+        existingRecordWithId._metadata
+      );
+    }
+
     collectionEntry.creationRequiredFields.forEach((field) => {
-      if (!payload[name].hasOwnProperty(field))
+      // const
+
+      if (Object.hasOwn(payload[name], field))
         throw new Error(
           `field ${field} is required when creating a new ${name}`
         );
     });
 
+    console.log({ collectionEntry });
+
     const record = merge(payload[name], {
       _metadata: {
         referenceField: collectionEntry.referenceField ?? 'id',
@@ -87,7 +101,7 @@ export default function addCollectionMutations(
         const { _metadata, ...args } = payload?.[name];
 
         const existingRecord = objectComposer
-          .getResolver('findById')
+          .getResolver('findByReferenceField')
           .resolve({ args });
 
         if (!existingRecord)
@@ -106,8 +120,6 @@ export default function addCollectionMutations(
       args: {
         [name]: objectComposer
           .getInputTypeComposer()
-          .clone(`${name}CreateInput`)
-          .removeField('id')
           .makeFieldNonNull(collectionEntry.creationRequiredFields),
       },
       description: `Create a ${name}`,
@@ -120,7 +132,7 @@ export default function addCollectionMutations(
         const { _metadata, ...args } = payload?.[name];
 
         const existingRecord = objectComposer
-          .getResolver('findById')
+          .getResolver('findByReferenceField')
           .resolve({ args });
 
         if (existingRecord) return update(payload, existingRecord);

packages/core/src/generators/collectionQueries.ts

@@ -1,13 +1,17 @@
 import { ObjectTypeComposer, SchemaComposer } from 'graphql-compose';
 import resolveQueryArgs from '../resolvers/arguments';
 
+import { cloneDeep, get } from 'lodash-es';
 import {
   generateArgsForAllItemQuery,
   generateArgsForManyItemQuery,
-  generateArgsForSingleItemQuery,
 } from '../generators/arguments';
-import { cloneDeep } from 'lodash-es';
-import { EntryNode, LoadedFlatbreadConfig, Transformer } from '../types';
+import {
+  EntryNode,
+  LoadedCollectionEntry,
+  LoadedFlatbreadConfig,
+  Transformer,
+} from '../types';
 
 export interface AddCollectionQueriesArgs {
   name: string;
@@ -17,6 +21,7 @@ export interface AddCollectionQueriesArgs {
   schemaComposer: SchemaComposer;
   allContentNodesJSON: Record<string, any[]>;
   transformersById: Record<string, Transformer>;
+  collectionEntry: LoadedCollectionEntry;
 }
 
 export default function addCollectionQueries(args: AddCollectionQueriesArgs) {
@@ -26,36 +31,44 @@ export default function addCollectionQueries(args: AddCollectionQueriesArgs) {
     config,
     objectComposer,
     schemaComposer,
+    collectionEntry,
     allContentNodesJSON,
   } = args;
 
   const pluralTypeQueryName = 'all' + pluralName;
 
   objectComposer.addResolver({
-    name: 'findById',
+    name: 'findByReferenceField',
     type: () => objectComposer,
-    description: `Find one ${name} by its ID`,
-    args: generateArgsForSingleItemQuery(),
+    description: `Find one ${name} by its ${collectionEntry.referenceField}`,
+    args: {
+      [collectionEntry.referenceField]: objectComposer
+        .getInputTypeComposer()
+        .getField(collectionEntry.referenceField),
+    },
     resolve: (rp: Record<string, any>) =>
       cloneDeep(
         allContentNodesJSON[name].find(
-          (node: EntryNode) => node.id === rp.args.id
+          (node: EntryNode) =>
+            node[collectionEntry.referenceField] ===
+            rp.args[collectionEntry.referenceField]
         )
       ),
   });
 
   objectComposer.addResolver({
     name: 'findMany',
     type: () => [objectComposer],
-    description: `Find many ${pluralName} by their IDs`,
+    description: `Find many ${pluralName} by their ${collectionEntry.referenceField}`,
     args: generateArgsForManyItemQuery(pluralName),
     resolve: (rp: Record<string, any>) => {
-      const idsToFind = rp.args.ids ?? [];
+      const referencesToFind = rp.args.references ?? [];
       const matches =
         cloneDeep(allContentNodesJSON[name])?.filter((node: EntryNode) =>
-          idsToFind?.includes(node.id)
+          referencesToFind?.includes(get(node, collectionEntry.referenceField))
         ) ?? [];
       return resolveQueryArgs(matches, rp.args, config, {
+        collectionEntry,
         type: {
           name: name,
           pluralName: pluralName,
@@ -73,6 +86,7 @@ export default function addCollectionQueries(args: AddCollectionQueriesArgs) {
     resolve: (rp: Record<string, any>) => {
       const nodes = cloneDeep(allContentNodesJSON[name]);
       return resolveQueryArgs(nodes, rp.args, config, {
+        collectionEntry,
         type: {
           name: name,
           pluralName: pluralName,
@@ -86,7 +100,7 @@ export default function addCollectionQueries(args: AddCollectionQueriesArgs) {
     /**
      * Add find by ID to each content type
      */
-    [name]: objectComposer.getResolver('findById'),
+    [name]: objectComposer.getResolver('findByReferenceField'),
     /**
      * Add find 'many' to each content type
      */