Expose scripture parsing to GQL query as an adhoc util (#3174)

Author: CarsonF

src/components/scripture/dto/scripture-collection.dto.ts

@@ -0,0 +1,7 @@
+import { ObjectType } from '@nestjs/graphql';
+import { Range, Verse } from '@seedcompany/scripture';
+
+@ObjectType()
+export class ScriptureCollection {
+  verses: ReadonlyArray<Range<Verse>>;
+}

src/components/scripture/scripture-collection.resolver.ts

@@ -0,0 +1,49 @@
+import {
+  Args,
+  Float,
+  Int,
+  Parent,
+  Query,
+  ResolveField,
+  Resolver,
+} from '@nestjs/graphql';
+import { labelOfVerseRanges, parseScripture } from '@seedcompany/scripture';
+import { ScriptureRange } from './dto';
+import { ScriptureCollection } from './dto/scripture-collection.dto';
+import { getTotalVerseEquivalents } from './verse-equivalents';
+
+@Resolver(ScriptureCollection)
+export class ScriptureCollectionResolver {
+  @Query(() => ScriptureCollection)
+  parseScripture(
+    @Args({ name: 'text', type: () => [String] }) text: readonly string[],
+  ): ScriptureCollection {
+    const verses = text.flatMap(parseScripture);
+    return { verses };
+  }
+
+  @ResolveField(() => [ScriptureRange])
+  ranges(@Parent() { verses }: ScriptureCollection): readonly ScriptureRange[] {
+    return verses.map((v) => ScriptureRange.fromVerses(v));
+  }
+
+  @ResolveField(() => String)
+  label(@Parent() { verses }: ScriptureCollection): string {
+    return labelOfVerseRanges(verses);
+  }
+
+  @ResolveField(() => Int, {
+    description: 'The total number of verses in this scripture collection',
+  })
+  totalVerses(@Parent() { verses }: ScriptureCollection): number {
+    return ScriptureRange.totalVerses(...verses);
+  }
+
+  @ResolveField(() => Float, {
+    description:
+      'The total number of verse equivalents in this scripture collection',
+  })
+  totalVerseEquivalents(@Parent() { verses }: ScriptureCollection): number {
+    return getTotalVerseEquivalents(...verses);
+  }
+}

src/components/scripture/scripture-range.resolver.ts

@@ -1,7 +1,8 @@
-import { Int, Parent, ResolveField, Resolver } from '@nestjs/graphql';
+import { Float, Int, Parent, ResolveField, Resolver } from '@nestjs/graphql';
 import { labelOfVerseRange } from '@seedcompany/scripture';
 import { stripIndent } from 'common-tags';
 import { ScriptureRange } from './dto';
+import { getTotalVerseEquivalents } from './verse-equivalents';
 
 @Resolver(ScriptureRange)
 export class ScriptureRangeResolver {
@@ -32,4 +33,11 @@ export class ScriptureRangeResolver {
     const verseRange = ScriptureRange.fromReferences(range);
     return verseRange.end - verseRange.start + 1;
   }
+  @ResolveField(() => Float, {
+    description:
+      'The total number of verse equivalents in this scripture range',
+  })
+  totalVerseEquivalents(@Parent() range: ScriptureRange): number {
+    return getTotalVerseEquivalents(range);
+  }
 }

src/components/scripture/scripture.module.ts

@@ -1,11 +1,13 @@
 import { Module } from '@nestjs/common';
+import { ScriptureCollectionResolver } from './scripture-collection.resolver';
 import { ScriptureRangeResolver } from './scripture-range.resolver';
 import { ScriptureReferenceRepository } from './scripture-reference.repository';
 import { ScriptureReferenceResolver } from './scripture-reference.resolver';
 import { ScriptureReferenceService } from './scripture-reference.service';
 
 @Module({
   providers: [
+    ScriptureCollectionResolver,
     ScriptureReferenceResolver,
     ScriptureRangeResolver,
     ScriptureReferenceService,

src/components/scripture/verse-equivalents.ts

@@ -1,11 +1,16 @@
-import { Book, mergeVerseRanges, Verse } from '@seedcompany/scripture';
+import {
+  Book,
+  mergeVerseRanges,
+  Verse,
+  VerseLike,
+} from '@seedcompany/scripture';
 import { sum } from 'lodash';
 import { Range } from '~/common';
 import { difficultyFactorOfBook } from './book-difficulty-factor';
 import { ScriptureRange, UnspecifiedScripturePortion } from './dto';
 
 export const getTotalVerseEquivalents = (
-  ...refs: readonly ScriptureRange[]
+  ...refs: ReadonlyArray<Range<VerseLike>>
 ) => {
   const verses = mergeVerseRanges(refs)
     .flatMap((range) => [...splitRangeByBook(range)])