ci: Bump version to 0.9.29 [skip ci]

docs/adr/0027-standardized-naming-convention-for-ai-and-database-types.md

@@ -0,0 +1,41 @@
+# ADR-027: Standardized Naming Convention for AI and Database Types
+
+**Date**: 2026-01-05
+
+**Status**: Accepted
+
+## Context
+
+The application codebase primarily follows the standard TypeScript convention of `camelCase` for variable and property names. However, the PostgreSQL database uses `snake_case` for column names. Additionally, the AI prompts are designed to extract data that maps directly to these database columns.
+
+Attempting to enforce `camelCase` strictly across the entire stack created friction and ambiguity, particularly in the background processing pipeline where data moves from the AI model directly to the database. Developers were unsure whether to transform keys immediately upon receipt (adding overhead) or keep them as-is.
+
+## Decision
+
+We will adopt a hybrid naming convention strategy to explicitly distinguish between internal application state and external/persisted data formats.
+
+1. **Database and AI Types (`snake_case`)**:
+   Interfaces, Type definitions, and Zod schemas that represent raw database rows or direct AI responses **MUST** use `snake_case`.
+   - *Examples*: `AiFlyerDataSchema`, `ExtractedFlyerItemSchema`, `FlyerInsert`.
+   - *Reasoning*: This avoids unnecessary mapping layers when inserting data into the database or parsing AI output. It serves as a visual cue that the data is "raw", "external", or destined for persistence.
+
+2. **Internal Application Logic (`camelCase`)**:
+   Variables, function arguments, and processed data structures used within the application logic (Service layer, UI components, utility functions) **MUST** use `camelCase`.
+   - *Reasoning*: This adheres to standard JavaScript/TypeScript practices and maintains consistency with the rest of the ecosystem (React, etc.).
+
+3. **Boundary Handling**:
+   - For background jobs that primarily move data from AI to DB, preserving `snake_case` is preferred to minimize transformation logic.
+   - For API responses sent to the frontend, data should generally be transformed to `camelCase` unless it is a direct dump of a database entity for a specific administrative view.
+
+## Consequences
+
+### Positive
+
+- **Visual Distinction**: It is immediately obvious whether a variable holds raw data (`price_in_cents`) or processed application state (`priceInCents`).
+- **Efficiency**: Reduces boilerplate code for mapping keys (e.g., `price_in_cents: data.priceInCents`) when performing bulk inserts or updates.
+- **Simplicity**: AI prompts can request JSON keys that match the database schema 1:1, reducing the risk of mapping errors.
+
+### Negative
+
+- **Context Switching**: Developers must be mindful of the casing context.
+- **Linter Configuration**: May require specific overrides or `// eslint-disable-next-line` comments if the linter is configured to strictly enforce `camelCase` everywhere.

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "flyer-crawler",
-  "version": "0.9.28",
+  "version": "0.9.29",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "flyer-crawler",
-      "version": "0.9.28",
+      "version": "0.9.29",
       "dependencies": {
         "@bull-board/api": "^6.14.2",
         "@bull-board/express": "^6.14.2",

package.json

@@ -1,7 +1,7 @@
 {
   "name": "flyer-crawler",
   "private": true,
-  "version": "0.9.28",
+  "version": "0.9.29",
   "type": "module",
   "scripts": {
     "dev": "concurrently \"npm:start:dev\" \"vite\"",

src/services/aiService.server.ts

@@ -73,14 +73,7 @@ interface IAiClient {
  * This type is intentionally loose to accommodate potential null/undefined values
  * from the AI before they are cleaned and normalized.
  */
-export type RawFlyerItem = {
-  item: string | null;
-  price_display: string | null | undefined;
-  price_in_cents: number | null | undefined;
-  quantity: string | null | undefined;
-  category_name: string | null | undefined;
-  master_item_id?: number | null | undefined;
-};
+export type RawFlyerItem = z.infer<typeof ExtractedFlyerItemSchema>;
 
 export class DuplicateFlyerError extends FlyerProcessingError {
   constructor(message: string, public flyerId: number) {

src/services/flyerDataTransformer.test.ts

@@ -60,7 +60,6 @@ describe('FlyerDataTransformer', () => {
       },
       needsReview: false,
     };
-    const imagePaths = [{ path: '/uploads/flyer-page-1.jpg', mimetype: 'image/jpeg' }];
     const originalFileName = 'my-flyer.pdf';
     const checksum = 'checksum-abc-123';
     const userId = 'user-xyz-456';
@@ -69,8 +68,9 @@ describe('FlyerDataTransformer', () => {
     // Act
     const { flyerData, itemsForDb } = await transformer.transform(
       aiResult,
-      imagePaths,
       originalFileName,
+      'flyer-page-1.jpg',
+      'icon-flyer-page-1.webp',
       checksum,
       userId,
       mockLogger,
@@ -121,12 +121,6 @@ describe('FlyerDataTransformer', () => {
       }),
     );
 
-    // 3. Check that generateFlyerIcon was called correctly
-    expect(generateFlyerIcon).toHaveBeenCalledWith(
-      '/uploads/flyer-page-1.jpg',
-      '/uploads/icons',
-      mockLogger,
-    );
   });
 
   it('should handle missing optional data gracefully', async () => {
@@ -141,7 +135,6 @@ describe('FlyerDataTransformer', () => {
       },
       needsReview: true,
     };
-    const imagePaths = [{ path: '/uploads/another.png', mimetype: 'image/png' }];
     const originalFileName = 'another.png';
     const checksum = 'checksum-def-456';
     // No userId provided
@@ -151,8 +144,9 @@ describe('FlyerDataTransformer', () => {
     // Act
     const { flyerData, itemsForDb } = await transformer.transform(
       aiResult,
-      imagePaths,
       originalFileName,
+      'another.png',
+      'icon-another.webp',
       checksum,
       undefined,
       mockLogger,
@@ -219,13 +213,13 @@ describe('FlyerDataTransformer', () => {
       },
       needsReview: false,
     };
-    const imagePaths = [{ path: '/uploads/flyer-page-1.jpg', mimetype: 'image/jpeg' }];
 
     // Act
     const { itemsForDb } = await transformer.transform(
       aiResult,
-      imagePaths,
       'file.pdf',
+      'flyer-page-1.jpg',
+      'icon-flyer-page-1.webp',
       'checksum',
       'user-1',
       mockLogger,
@@ -262,7 +256,6 @@ describe('FlyerDataTransformer', () => {
       },
       needsReview: false,
     };
-    const imagePaths = [{ path: '/uploads/flyer-page-1.jpg', mimetype: 'image/jpeg' }];
     const baseUrl = undefined; // Explicitly pass undefined for this test
 
     // The fallback logic uses process.env.PORT || 3000.
@@ -272,8 +265,9 @@ describe('FlyerDataTransformer', () => {
     // Act
     const { flyerData } = await transformer.transform(
       aiResult,
-      imagePaths,
       'my-flyer.pdf',
+      'flyer-page-1.jpg',
+      'icon-flyer-page-1.webp',
       'checksum-abc-123',
       'user-xyz-456',
       mockLogger,
@@ -315,13 +309,13 @@ describe('FlyerDataTransformer', () => {
         },
         needsReview: false,
       };
-      const imagePaths = [{ path: '/uploads/flyer-page-1.jpg', mimetype: 'image/jpeg' }];
 
       // Act
       const { itemsForDb } = await transformer.transform(
         aiResult,
-        imagePaths,
         'file.pdf',
+        'flyer-page-1.jpg',
+        'icon-flyer-page-1.webp',
         'checksum',
         'user-1',
         mockLogger,
@@ -353,13 +347,13 @@ describe('FlyerDataTransformer', () => {
         },
         needsReview: false,
       };
-      const imagePaths = [{ path: '/uploads/flyer-page-1.jpg', mimetype: 'image/jpeg' }];
 
       // Act
       const { itemsForDb } = await transformer.transform(
         aiResult,
-        imagePaths,
         'file.pdf',
+        'flyer-page-1.jpg',
+        'icon-flyer-page-1.webp',
         'checksum',
         'user-1',
         mockLogger,
@@ -391,13 +385,13 @@ describe('FlyerDataTransformer', () => {
         },
         needsReview: false,
       };
-      const imagePaths = [{ path: '/uploads/flyer-page-1.jpg', mimetype: 'image/jpeg' }];
 
       // Act
       const { itemsForDb } = await transformer.transform(
         aiResult,
-        imagePaths,
         'file.pdf',
+        'flyer-page-1.jpg',
+        'icon-flyer-page-1.webp',
         'checksum',
         'user-1',
         mockLogger,
@@ -432,13 +426,13 @@ describe('FlyerDataTransformer', () => {
       },
       needsReview: false,
     };
-    const imagePaths = [{ path: '/uploads/flyer-page-1.jpg', mimetype: 'image/jpeg' }];
 
     // Act
     const { itemsForDb } = await transformer.transform(
       aiResult,
-      imagePaths,
       'file.pdf',
+        'flyer-page-1.jpg',
+        'icon-flyer-page-1.webp',
       'checksum',
       'user-1',
       mockLogger,
@@ -469,13 +463,13 @@ describe('FlyerDataTransformer', () => {
         },
         needsReview: false, // Key part of this test
       };
-      const imagePaths = [{ path: '/uploads/flyer-page-1.jpg', mimetype: 'image/jpeg' }];
 
       // Act
       const { flyerData } = await transformer.transform(
         aiResult,
-        imagePaths,
         'file.pdf',
+        'flyer-page-1.jpg',
+        'icon-flyer-page-1.webp',
         'checksum',
         'user-1',
         mockLogger,
@@ -498,13 +492,13 @@ describe('FlyerDataTransformer', () => {
         },
         needsReview: true, // Key part of this test
       };
-      const imagePaths = [{ path: '/uploads/flyer-page-1.jpg', mimetype: 'image/jpeg' }];
 
       // Act
       const { flyerData } = await transformer.transform(
         aiResult,
-        imagePaths,
         'file.pdf',
+        'flyer-page-1.jpg',
+        'icon-flyer-page-1.webp',
         'checksum',
         'user-1',
         mockLogger,

src/types/ai.ts

@@ -10,6 +10,8 @@ export const requiredString = (message: string) =>
 // --- Zod Schemas for AI Response Validation ---
 // These schemas define the expected structure of data returned by the AI.
 // They are used for validation and type inference across multiple services.
+// Note: These schemas use snake_case to match the database columns and AI prompt instructions,
+// distinguishing them from internal camelCase application variables.
 
 export const ExtractedFlyerItemSchema = z.object({
   item: z.string().nullish(),