Create shapes to hold pnp extraction result / problems

Author: CarsonF

src/common/xlsx.util.ts

@@ -252,9 +252,15 @@ export class Cell<TSheet extends Sheet = Sheet> {
       : undefined;
   }
 
-  toString() {
+  get fqn() {
+    return `${this.sheet.name}!${this.ref}`;
+  }
+  get ref() {
     return `${this.column.a1}${this.row.a1}`;
   }
+  toString() {
+    return this.ref;
+  }
 }
 
 abstract class Rangable<TSheet extends Sheet = Sheet> {
@@ -301,9 +307,12 @@ abstract class Rangable<TSheet extends Sheet = Sheet> {
     );
   }
 
-  toString() {
+  get ref() {
     return `${this.sheet.name}!${this.start.toString()}:${this.end.toString()}`;
   }
+  toString() {
+    return this.ref;
+  }
 }
 
 export class Range<TSheet extends Sheet = Sheet> extends Rangable<TSheet> {

src/components/pnp/extraction-result/extraction-result.dto.ts

@@ -0,0 +1,60 @@
+import { Field, InterfaceType, ObjectType } from '@nestjs/graphql';
+import { many, Many } from '@seedcompany/common';
+import { stripIndent } from 'common-tags';
+import { EnumType, makeEnum } from '~/common';
+import { InlineMarkdownScalar } from '~/common/markdown.scalar';
+import { Cell } from '~/common/xlsx.util';
+
+export type PnpProblemSeverity = EnumType<typeof PnpProblemSeverity>;
+export const PnpProblemSeverity = makeEnum({
+  name: 'PnpProblemSeverity',
+  values: ['Error', 'Warning', 'Notice'],
+});
+
+@ObjectType()
+export class PnpProblem {
+  @Field(() => PnpProblemSeverity)
+  readonly severity: PnpProblemSeverity;
+
+  @Field(() => InlineMarkdownScalar, {
+    description: 'The message describing this specific problem',
+  })
+  readonly message: string;
+
+  @Field(() => String, {
+    description: 'Sheet!A1',
+  })
+  readonly source: string;
+
+  @Field(() => [InlineMarkdownScalar], {
+    description: stripIndent`
+      Groupings for this problem.
+      Order least specific to most.
+      Formatted as human labels.
+    `,
+  })
+  readonly groups: readonly string[];
+}
+
+@InterfaceType()
+export abstract class PnpExtractionResult {
+  @Field(() => [PnpProblem])
+  readonly problems: PnpProblem[] = [];
+
+  addProblem(
+    problem: Omit<PnpProblem, 'groups' | 'source'> & {
+      groups?: Many<string>;
+      source: Cell;
+    },
+  ) {
+    this.problems.push({
+      ...problem,
+      groups: [problem.source.sheet.name, ...many(problem.groups ?? [])],
+      source: problem.source.fqn,
+    });
+  }
+}
+@ObjectType({ implements: PnpExtractionResult })
+export class PnpPlanningExtractionResult extends PnpExtractionResult {}
+@ObjectType({ implements: PnpExtractionResult })
+export class PnpProgressExtractionResult extends PnpExtractionResult {}

src/components/pnp/extraction-result/index.ts

@@ -0,0 +1 @@
+export * from './extraction-result.dto';