address: update FakerFieldMapping to use MongoDBFieldType and improve type safety

Author: ncarbon

packages/compass-collection/src/components/mock-data-generator-modal/faker-schema-editor-screen.tsx

@@ -13,6 +13,7 @@ import React from 'react';
 import FieldSelector from './schema-field-selector';
 import FakerMappingSelector from './faker-mapping-selector';
 import type { FakerSchema, MockDataGeneratorState } from './types';
+import type { MongoDBFieldType } from '../../schema-analysis-types';
 
 const containerStyles = css({
   display: 'flex',
@@ -75,7 +76,7 @@ const FakerSchemaEditorContent = ({
         ...fakerSchemaFormValues,
         [activeField]: {
           ...currentMapping,
-          mongoType: newJsonType,
+          mongoType: newJsonType as MongoDBFieldType,
         },
       });
       resetIsSchemaConfirmed();

packages/compass-collection/src/components/mock-data-generator-modal/script-generation-utils.spec.ts

@@ -1,9 +1,7 @@
 import { expect } from 'chai';
 import { faker } from '@faker-js/faker/locale/en';
-import {
-  generateScript,
-  type FakerFieldMapping,
-} from './script-generation-utils';
+import { generateScript } from './script-generation-utils';
+import type { FakerFieldMapping } from './types';
 
 /**
  * Helper function to test that generated document code is executable

packages/compass-collection/src/components/mock-data-generator-modal/script-generation-utils.ts

@@ -1,17 +1,11 @@
 import type { MongoDBFieldType } from '../../schema-analysis-types';
+import type { FakerFieldMapping } from './types';
 
 export type FakerArg = string | number | boolean | { json: string };
 
 const DEFAULT_ARRAY_LENGTH = 3;
 const INDENT_SIZE = 2;
 
-export interface FakerFieldMapping {
-  mongoType: MongoDBFieldType;
-  fakerMethod: string;
-  fakerArgs: FakerArg[];
-  probability?: number; // 0.0 - 1.0 frequency of field (defaults to 1.0)
-}
-
 // Array length configuration for different array types
 export type ArrayLengthMap = {
   [fieldName: string]:

packages/compass-collection/src/components/mock-data-generator-modal/types.ts

@@ -1,4 +1,6 @@
 import type { MockDataSchemaResponse } from '@mongodb-js/compass-generative-ai';
+import type { MongoDBFieldType } from '../../schema-analysis-types';
+import type { FakerArg } from './script-generation-utils';
 
 export enum MockDataGeneratorStep {
   SCHEMA_CONFIRMATION = 'SCHEMA_CONFIRMATION',
@@ -37,11 +39,11 @@ export type MockDataGeneratorState =
 
 export type FakerSchemaMapping = MockDataSchemaResponse['fields'][number];
 
-export type FakerFieldMapping = {
-  mongoType: string;
+export interface FakerFieldMapping {
+  mongoType: MongoDBFieldType;
   fakerMethod: string;
-  fakerArgs: any[];
-  probability: number;
-};
+  fakerArgs: FakerArg[];
+  probability?: number; // 0.0 - 1.0 frequency of field (defaults to 1.0)
+}
 
 export type FakerSchema = Record<string, FakerFieldMapping>;

packages/compass-collection/src/modules/collection-tab.ts

@@ -27,6 +27,7 @@ import {
   type SchemaAnalysisError,
   type SchemaAnalysisState,
   type FieldInfo,
+  MongoDBFieldType,
 } from '../schema-analysis-types';
 import { calculateSchemaDepth } from '../calculate-schema-depth';
 import {
@@ -708,7 +709,10 @@ function transformFakerSchemaToObject(
 
   for (const field of fakerSchema) {
     const { fieldPath, ...fieldMapping } = field;
-    result[fieldPath] = fieldMapping;
+    result[fieldPath] = {
+      ...fieldMapping,
+      mongoType: fieldMapping.mongoType as MongoDBFieldType,
+    };
   }
 
   return result;