@auto-engineer/server-generator-apollo-emmett 1.78.0 → 1.80.0

package/ketchup-plan.md

@@ -1,8 +1,7 @@
-# Ketchup Plan: Fix query resolver collection name casing mismatch
+# Ketchup Plan: Slim ReadModel API — add findOne, remove redundant methods
 
 ## TODO
 
 ## DONE
 
-- [x] Burst 1: Add regression test + fix EJS template to use projectionName for collection name (5df3ae89)
-- [x] Burst 2: Remove unused projectionType from scaffoldFromSchema template locals
+- [x] Burst 1: Slim ReadModel to find + findOne, update EJS template API docs, update all inline snapshots

package/package.json

@@ -32,8 +32,8 @@
     "uuid": "^11.0.0",
     "web-streams-polyfill": "^4.1.0",
     "zod": "^3.22.4",
-    "@auto-engineer/message-bus": "1.78.0",
-    "@auto-engineer/narrative": "1.78.0"
+    "@auto-engineer/narrative": "1.80.0",
+    "@auto-engineer/message-bus": "1.80.0"
   },
   "publishConfig": {
     "access": "public"
@@ -44,9 +44,9 @@
     "typescript": "^5.8.3",
     "vitest": "^3.2.4",
     "tsx": "^4.19.2",
-    "@auto-engineer/cli": "1.78.0"
+    "@auto-engineer/cli": "1.80.0"
   },
-  "version": "1.78.0",
+  "version": "1.80.0",
   "scripts": {
     "generate:server": "tsx src/cli/index.ts",
     "build": "tsc && tsx ../../scripts/fix-esm-imports.ts && rm -rf dist/src/codegen/templates && mkdir -p dist/src/codegen && cp -r src/codegen/templates dist/src/codegen/templates && cp src/server.ts dist/src && cp -r src/utils dist/src && cp -r src/domain dist/src",

package/src/codegen/templates/query/projection.specs.ts

@@ -377,15 +377,12 @@ describe('projection.ts.ejs', () => {
         ): Promise<Wishlist[]> {
           const model = new ReadModel<Wishlist>(ctx.database, 'WishlistProjection');
 
-          // ## IMPLEMENTATION INSTRUCTIONS ##
-          // You can query the projection using the ReadModel API:
-          // - model.getAll() — fetch all documents
-          // - model.getById(id) — fetch a single document by ID (default key: 'id')
-          // - model.find(filterFn) — filter documents using a predicate
-          // - model.first(filterFn) — fetch the first document matching a predicate
+          // ReadModel API:
+          // - model.find(filterFn?)  → T[]       returns all matches (or all documents if no filter)
+          // - model.findOne(filterFn) → T | null  returns the first match
           //
-          // Example below uses \\\`.find()\\\` to filter
-          // change the logic for the query as needed to meet the requirements for the current slice.
+          // The scaffolded code below uses find() returning an array.
+          // If this query should return a single item, switch to findOne().
 
           return model.find((item) => {
             if (sessionId !== undefined && item.sessionId !== sessionId) return false;

package/src/codegen/templates/query/query.resolver.specs.ts

@@ -104,15 +104,12 @@ describe('query.resolver.ts.ejs', () => {
         ): Promise<AvailableListings[]> {
           const model = new ReadModel<AvailableListings>(ctx.database, 'AvailablePropertiesProjection');
 
-          // ## IMPLEMENTATION INSTRUCTIONS ##
-          // You can query the projection using the ReadModel API:
-          // - model.getAll() — fetch all documents
-          // - model.getById(id) — fetch a single document by ID (default key: 'id')
-          // - model.find(filterFn) — filter documents using a predicate
-          // - model.first(filterFn) — fetch the first document matching a predicate
+          // ReadModel API:
+          // - model.find(filterFn?)  → T[]       returns all matches (or all documents if no filter)
+          // - model.findOne(filterFn) → T | null  returns the first match
           //
-          // Example below uses \\\`.find()\\\` to filter
-          // change the logic for the query as needed to meet the requirements for the current slice.
+          // The scaffolded code below uses find() returning an array.
+          // If this query should return a single item, switch to findOne().
 
           return model.find((item) => {
             if (location !== undefined && item.location !== location) return false;
@@ -235,15 +232,12 @@ describe('query.resolver.ts.ejs', () => {
         ): Promise<SuggestedItems[]> {
           const model = new ReadModel<SuggestedItems>(ctx.database, 'SuggestedItemsProjection');
 
-          // ## IMPLEMENTATION INSTRUCTIONS ##
-          // You can query the projection using the ReadModel API:
-          // - model.getAll() — fetch all documents
-          // - model.getById(id) — fetch a single document by ID (default key: 'id')
-          // - model.find(filterFn) — filter documents using a predicate
-          // - model.first(filterFn) — fetch the first document matching a predicate
+          // ReadModel API:
+          // - model.find(filterFn?)  → T[]       returns all matches (or all documents if no filter)
+          // - model.findOne(filterFn) → T | null  returns the first match
           //
-          // Example below uses \\\`.find()\\\` to filter
-          // change the logic for the query as needed to meet the requirements for the current slice.
+          // The scaffolded code below uses find() returning an array.
+          // If this query should return a single item, switch to findOne().
 
           return model.find((item) => {
             if (sessionId !== undefined && item.sessionId !== sessionId) return false;
@@ -411,15 +405,12 @@ describe('query.resolver.ts.ejs', () => {
         ): Promise<QuestionnaireProgress[]> {
           const model = new ReadModel<QuestionnaireProgress>(ctx.database, 'Questionnaires');
 
-          // ## IMPLEMENTATION INSTRUCTIONS ##
-          // You can query the projection using the ReadModel API:
-          // - model.getAll() — fetch all documents
-          // - model.getById(id) — fetch a single document by ID (default key: 'id')
-          // - model.find(filterFn) — filter documents using a predicate
-          // - model.first(filterFn) — fetch the first document matching a predicate
+          // ReadModel API:
+          // - model.find(filterFn?)  → T[]       returns all matches (or all documents if no filter)
+          // - model.findOne(filterFn) → T | null  returns the first match
           //
-          // Example below uses \\\`.find()\\\` to filter
-          // change the logic for the query as needed to meet the requirements for the current slice.
+          // The scaffolded code below uses find() returning an array.
+          // If this query should return a single item, switch to findOne().
 
           return model.find((item) => {
             if (participantId !== undefined && item.participantId !== participantId) return false;
@@ -936,15 +927,12 @@ describe('query.resolver.ts.ejs', () => {
         ): Promise<RecipeMatchesRecipes[]> {
           const model = new ReadModel<RecipeMatchesRecipes>(ctx.database, 'RecipeMatchesProjection');
 
-          // ## IMPLEMENTATION INSTRUCTIONS ##
-          // You can query the projection using the ReadModel API:
-          // - model.getAll() — fetch all documents
-          // - model.getById(id) — fetch a single document by ID (default key: 'id')
-          // - model.find(filterFn) — filter documents using a predicate
-          // - model.first(filterFn) — fetch the first document matching a predicate
+          // ReadModel API:
+          // - model.find(filterFn?)  → T[]       returns all matches (or all documents if no filter)
+          // - model.findOne(filterFn) → T | null  returns the first match
           //
-          // Example below uses \\\`.find()\\\` to filter
-          // change the logic for the query as needed to meet the requirements for the current slice.
+          // The scaffolded code below uses find() returning an array.
+          // If this query should return a single item, switch to findOne().
 
           return model.find((item) => {
             if (pantryId !== undefined && item.pantryId !== pantryId) return false;
@@ -1181,15 +1169,12 @@ describe('query.resolver.ts.ejs', () => {
         ): Promise<RecipeMatchesRecipes[]> {
           const model = new ReadModel<RecipeMatchesRecipes>(ctx.database, 'RecipeMatchesProjection');
 
-          // ## IMPLEMENTATION INSTRUCTIONS ##
-          // You can query the projection using the ReadModel API:
-          // - model.getAll() — fetch all documents
-          // - model.getById(id) — fetch a single document by ID (default key: 'id')
-          // - model.find(filterFn) — filter documents using a predicate
-          // - model.first(filterFn) — fetch the first document matching a predicate
+          // ReadModel API:
+          // - model.find(filterFn?)  → T[]       returns all matches (or all documents if no filter)
+          // - model.findOne(filterFn) → T | null  returns the first match
           //
-          // Example below uses \\\`.find()\\\` to filter
-          // change the logic for the query as needed to meet the requirements for the current slice.
+          // The scaffolded code below uses find() returning an array.
+          // If this query should return a single item, switch to findOne().
 
           return model.find((item) => {
             if (pantryId !== undefined && item.pantryId !== pantryId) return false;

package/src/codegen/templates/query/query.resolver.ts.ejs

@@ -156,15 +156,12 @@ async <%= queryName %>(
 ): Promise<<%= viewType %>[]> {
 const model = new ReadModel<<%= viewType %>>(ctx.database, '<%= collectionName %>');
 
-// ## IMPLEMENTATION INSTRUCTIONS ##
-// You can query the projection using the ReadModel API:
-// - model.getAll() — fetch all documents
-// - model.getById(id) — fetch a single document by ID (default key: 'id')
-// - model.find(filterFn) — filter documents using a predicate
-// - model.first(filterFn) — fetch the first document matching a predicate
+// ReadModel API:
+// - model.find(filterFn?)  → T[]       returns all matches (or all documents if no filter)
+// - model.findOne(filterFn) → T | null  returns the first match
 //
-// Example below uses \`.find()\` to filter
-// change the logic for the query as needed to meet the requirements for the current slice.
+// The scaffolded code below uses find() returning an array.
+// If this query should return a single item, switch to findOne().
 
 return model.find((<%= hasArgs ? 'item' : '_item' %>) => {
 <% if (parsedRequest?.args?.length) {

package/src/domain/shared/ReadModel.ts

@@ -7,20 +7,11 @@ export class ReadModel<T extends Record<string, unknown>> {
     this.collection = database.collection<T>(collectionName);
   }
 
-  async getAll(): Promise<T[]> {
-    return this.collection.find();
-  }
-
-  async getById(id: string, idField: keyof T = 'id' as keyof T): Promise<T | null> {
-    return this.collection.findOne((doc) => doc[idField] === id);
-  }
-
-  async find(filterFn: (item: T) => boolean): Promise<T[]> {
+  async find(filterFn?: (item: T) => boolean): Promise<T[]> {
     return this.collection.find(filterFn);
   }
 
-  async first(filterFn: (item: T) => boolean): Promise<T | null> {
-    const all = await this.collection.find(filterFn);
-    return all[0] ?? null;
+  async findOne(filterFn: (item: T) => boolean): Promise<T | null> {
+    return this.collection.findOne(filterFn);
   }
 }