fix: improve error message for schema problems W-20495414

messages/importApi.md

@@ -20,7 +20,7 @@ Data plan file %s did not validate against the schema. Errors: %s.
 
 - Make sure you're importing a plan definition file.
 
-- Get help with the import plan schema by running "sf data import beta tree --help".
+- Get help with the import plan schema by running "sf data import tree --help".
 
 # error.NonStringFiles
 

src/api/data/tree/importPlan.ts

@@ -37,9 +37,8 @@ Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-data', 'importApi');
 
 // the "new" type for these.  We're ignoring saveRefs/resolveRefs
-export type EnrichedPlanPart = Partial<DataPlanPart> & {
+export type EnrichedPlanPart = DataPlanPart & {
   filePath: string;
-  sobject: string;
   records: SObjectTreeInput[];
 };
 /** an accumulator for api results.  Fingerprints exist to break recursion */
@@ -51,6 +50,7 @@ type ResultsSoFar = {
 const TREE_API_LIMIT = 200;
 
 const refRegex = (object: string): RegExp => new RegExp(`^@${object}Ref\\d+$`);
+
 export const importFromPlan = async (conn: Connection, planFilePath: string): Promise<ImportStatus> => {
   const resolvedPlanPath = path.resolve(process.cwd(), planFilePath);
   const logger = Logger.childFromRoot('data:import:tree:importFromPlan');
@@ -197,7 +197,7 @@ export function validatePlanContents(
   if (parseResults.error) {
     throw messages.createError('error.InvalidDataImport', [
       planPath,
-      parseResults.error.issues.map((e) => e.message).join('\n'),
+      parseResults.error.issues.map((e) => JSON.stringify(e, null, 2)).join('\n'),
     ]);
   }
   const parsedPlans: DataImportPlanArray = parseResults.data;

src/types.ts

@@ -62,7 +62,7 @@ export type SObjectTreeInput = Omit<BasicRecord, 'attributes'> & {
 };
 export type DataPlanPart = {
   sobject: string;
-  files: Array<string | (DataPlanPart & { file: string })>;
+  files: string[];
 };
 
 export type SObjectTreeFileContents = {