refactor: add type safety to createUploadTemplateCSV dealing with ZodEffect type forms #995

Author: david-roper

apps/web/src/features/upload/utils.ts

@@ -20,7 +20,8 @@ const ZOD_TYPE_NAMES = [
   'ZodDate',
   'ZodEnum',
   'ZodArray',
-  'ZodObject'
+  'ZodObject',
+  'ZodEffects'
 ] as const;
 
 const INTERNAL_HEADERS = ['subjectID', 'date'];
@@ -31,7 +32,7 @@ const INTERNAL_HEADERS_SAMPLE_DATA = [MONGOLIAN_VOWEL_SEPARATOR + 'string', MONG
 
 type ZodTypeName = Extract<`${z.ZodFirstPartyTypeKind}`, (typeof ZOD_TYPE_NAMES)[number]>;
 
-type RequiredZodTypeName = Exclude<ZodTypeName, 'ZodOptional'>;
+type RequiredZodTypeName = Exclude<ZodTypeName, 'ZodEffects' | 'ZodOptional'>;
 
 type ZodTypeNameResult =
   | {
@@ -79,6 +80,14 @@ function isZodArrayDef(def: AnyZodTypeDef): def is z.ZodArrayDef {
   return def.typeName === z.ZodFirstPartyTypeKind.ZodArray;
 }
 
+function isZodEffectsDef(def: AnyZodTypeDef): def is z.ZodEffectsDef {
+  return def.typeName === z.ZodFirstPartyTypeKind.ZodEffects;
+}
+
+function isZodObjectDef(def: AnyZodTypeDef): def is z.ZodObjectDef {
+  return def.typeName === z.ZodFirstPartyTypeKind.ZodObject;
+}
+
 // TODO - fix extract set and record array functions to handle whitespace and trailing semicolon (present or included)
 
 function extractSetEntry(entry: string) {
@@ -217,7 +226,7 @@ export function interpretZodArray(
 
 export function interpretZodValue(
   entry: string,
-  zType: Exclude<ZodTypeName, 'ZodArray' | 'ZodObject' | 'ZodOptional'>,
+  zType: Exclude<ZodTypeName, 'ZodArray' | 'ZodEffects' | 'ZodObject' | 'ZodOptional'>,
   isOptional: boolean
 ): UploadOperationResult<FormTypes.FieldValue> {
   if (entry === '' && isOptional) {
@@ -245,7 +254,6 @@ export function interpretZodValue(
         return { success: true, value: parseNumber(entry) };
       }
       return { message: `Invalid number type: ${entry}`, success: false };
-    //TODO if ZodSet has a enum see if those values can be shown in template data if possible
     case 'ZodSet':
       if (entry.startsWith('SET(')) {
         const setData = extractSetEntry(entry);
@@ -327,7 +335,7 @@ function generateSampleData({
   multiKeys,
   multiValues,
   typeName
-}: Extract<ZodTypeNameResult, { success: true }>) {
+}: Extract<Exclude<ZodTypeNameResult, 'ZodEffects'>, { success: true }>) {
   switch (typeName) {
     case 'ZodBoolean':
       return formatTypeInfo('true/false', isOptional);
@@ -383,7 +391,6 @@ function generateSampleData({
       } catch {
         throw new Error('Invalid Record Array Error');
       }
-
     default:
       throw new Error(`Invalid zod schema: unexpected type name '${typeName satisfies never}'`);
   }
@@ -393,12 +400,15 @@ export function createUploadTemplateCSV(instrument: AnyUnilingualFormInstrument)
   // TODO - type validationSchema as object
   const instrumentSchema = instrument.validationSchema as z.AnyZodObject;
 
+  const instrumentSchemaDef: unknown = instrument.validationSchema._def;
+
   let shape: { [key: string]: z.ZodTypeAny } = {};
-  // TODO - include ZodEffect as a typename like our other types
-  if ((instrumentSchema._def.typeName as string) === 'ZodEffects') {
-    // @ts-expect-error - TODO - find a type safe way to call this
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
-    shape = instrumentSchema._def.schema._def.shape() as { [key: string]: z.ZodTypeAny };
+
+  if (isZodTypeDef(instrumentSchemaDef) && isZodEffectsDef(instrumentSchemaDef)) {
+    const innerSchema: unknown = instrumentSchemaDef.schema._def;
+    if (isZodTypeDef(innerSchema) && isZodObjectDef(innerSchema)) {
+      shape = innerSchema.shape() as { [key: string]: z.ZodTypeAny };
+    }
   } else {
     shape = instrumentSchema.shape as { [key: string]: z.ZodTypeAny };
   }
@@ -432,13 +442,14 @@ export async function processInstrumentCSV(
   let shape: { [key: string]: z.ZodTypeAny } = {};
   let instrumentSchemaWithInternal: z.AnyZodObject;
 
-  if ((instrumentSchema._def.typeName as string) === 'ZodEffects') {
-    // @ts-expect-error - TODO - find a type safe way to call this
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
-    instrumentSchemaWithInternal = instrumentSchema._def.schema.extend({
+  const instrumentSchemaDef: unknown = instrumentSchema._def;
+
+  if (isZodTypeDef(instrumentSchemaDef) && isZodEffectsDef(instrumentSchemaDef)) {
+    //TODO make this type safe without having to cast z.AnyZodObject
+    instrumentSchemaWithInternal = (instrumentSchemaDef.schema as z.AnyZodObject).extend({
       date: z.coerce.date(),
       subjectID: z.string()
-    }) as z.AnyZodObject;
+    });
 
     shape = instrumentSchemaWithInternal._def.shape() as { [key: string]: z.ZodTypeAny };
   } else {