AfO Register

src/afo-register/application/AfoRegisterService.test.ts

@@ -0,0 +1,41 @@
+import { testDelegation, TestData } from 'test-support/utils'
+import AfoRegisterRepository from 'afo-register/infrastructure/AfoRegisterRepository'
+import AfoRegisterRecord from 'afo-register/domain/Record'
+import { stringify } from 'query-string'
+import ApiClient from 'http/ApiClient'
+
+jest.mock('http/ApiClient')
+const apiClient = new (ApiClient as jest.Mock<jest.Mocked<ApiClient>>)()
+
+const afoRegisterRepository = new AfoRegisterRepository(apiClient)
+
+const resultStub = {
+  afoNumber: 'AfO 1',
+  page: '2',
+  text: 'some text',
+  textNumber: '5',
+  discussedBy: '',
+  discussedByNotes: '',
+  linesDiscussed: '',
+}
+
+const query = { afoNumber: resultStub.afoNumber, page: resultStub.page }
+const entry = new AfoRegisterRecord(resultStub)
+
+const testData: TestData<AfoRegisterRepository>[] = [
+  new TestData(
+    'search',
+    [
+      stringify({
+        afoNumber: 'AfO 1',
+        page: '2',
+      }),
+    ],
+    apiClient.fetchJson,
+    [entry],
+    [`/afo-register?${stringify(query)}`, false],
+    Promise.resolve([resultStub])
+  ),
+]
+describe('afoRegisterService', () =>
+  testDelegation(afoRegisterRepository, testData))

src/afo-register/application/AfoRegisterService.ts

@@ -0,0 +1,40 @@
+import Promise from 'bluebird'
+import AfoRegisterRecord, {
+  AfoRegisterRecordSuggestion,
+} from 'afo-register/domain/Record'
+import AfoRegisterRepository from 'afo-register/infrastructure/AfoRegisterRepository'
+import FragmentService from 'fragmentarium/application/FragmentService'
+
+export interface afoRegisterSearch {
+  search(query: string): Promise<readonly AfoRegisterRecord[]>
+  searchSuggestions(
+    query: string
+  ): Promise<readonly AfoRegisterRecordSuggestion[]>
+}
+
+export default class AfoRegisterService implements afoRegisterSearch {
+  private readonly afoRegisterRepository: AfoRegisterRepository
+
+  constructor(afoRegisterRepository: AfoRegisterRepository) {
+    this.afoRegisterRepository = afoRegisterRepository
+  }
+
+  search(
+    query: string,
+    fragmentService?: FragmentService
+  ): Promise<readonly AfoRegisterRecord[]> {
+    return this.afoRegisterRepository.search(query, fragmentService)
+  }
+
+  searchTextsAndNumbers(
+    query: readonly string[]
+  ): Promise<readonly AfoRegisterRecord[]> {
+    return this.afoRegisterRepository.searchTextsAndNumbers(query)
+  }
+
+  searchSuggestions(
+    query: string
+  ): Promise<readonly AfoRegisterRecordSuggestion[]> {
+    return this.afoRegisterRepository.searchSuggestions(query)
+  }
+}

src/afo-register/domain/Record.test.ts

@@ -0,0 +1,48 @@
+import AfoRegisterRecord from 'afo-register/domain/Record'
+
+describe('AfoRegisterRecord', () => {
+  const mockRecord = {
+    afoNumber: '123',
+    page: '456',
+    text: 'Sample text',
+    textNumber: '789',
+    linesDiscussed: 'Some lines',
+    discussedBy: 'John Doe',
+    discussedByNotes: 'Notes by John',
+    fragmentNumbers: ['BM777'],
+  }
+
+  describe('constructor', () => {
+    describe('constructor', () => {
+      it('should initialize properties correctly', () => {
+        const record = new AfoRegisterRecord(mockRecord)
+        expect(record.afoNumber).toEqual('123')
+        expect(record.page).toEqual('456')
+        expect(record.text).toEqual('Sample text')
+        expect(record.textNumber).toEqual('789')
+        expect(record.linesDiscussed).toEqual('Some lines')
+        expect(record.discussedBy).toEqual('John Doe')
+        expect(record.discussedByNotes).toEqual('Notes by John')
+      })
+    })
+  })
+
+  describe('Converts to Markdown string', () => {
+    it('Returns the correct markdown string with fragments', () => {
+      const record = new AfoRegisterRecord(mockRecord)
+      const result = record.toMarkdownString()
+      expect(result).toEqual(
+        'Sample text 789 ([BM777](/fragmentarium/BM777)), Some lines: John Doe Notes by John<small class="text-black-50 ml-3">[123, 456]</small>'
+      )
+    })
+
+    it('Handles sup tags correctly', () => {
+      const recordWithSup = new AfoRegisterRecord({
+        ...mockRecord,
+        text: 'Sample^text^',
+      })
+      const result = recordWithSup.toMarkdownString()
+      expect(result).toContain('<sup>text</sup>')
+    })
+  })
+})

src/afo-register/domain/Record.ts

@@ -0,0 +1,94 @@
+import produce, { Draft, immerable } from 'immer'
+
+interface RecordData {
+  readonly afoNumber: string
+  readonly page: string
+  readonly text: string
+  readonly textNumber: string
+  readonly linesDiscussed?: string
+  readonly discussedBy?: string
+  readonly discussedByNotes?: string
+  readonly fragmentNumbers?: string[]
+}
+
+export class AfoRegisterRecordSuggestion {
+  [immerable] = true
+
+  readonly text: string
+  readonly textNumbers: string[]
+
+  constructor({
+    text,
+    textNumbers,
+  }: {
+    readonly text: string
+    readonly textNumbers: string[]
+  }) {
+    this.text = text
+    this.textNumbers = textNumbers
+  }
+}
+
+export default class AfoRegisterRecord {
+  [immerable] = true
+
+  readonly afoNumber: string
+  readonly page: string
+  readonly text: string
+  readonly textNumber: string
+  readonly linesDiscussed?: string
+  readonly discussedBy?: string
+  readonly discussedByNotes?: string
+  readonly fragmentNumbers?: string[]
+
+  constructor({
+    afoNumber,
+    page,
+    text,
+    textNumber,
+    linesDiscussed,
+    discussedBy,
+    discussedByNotes,
+    fragmentNumbers,
+  }: RecordData) {
+    this.afoNumber = afoNumber
+    this.page = page
+    this.text = text
+    this.textNumber = textNumber
+    this.linesDiscussed = linesDiscussed
+    this.discussedBy = discussedBy
+    this.discussedByNotes = discussedByNotes
+    this.fragmentNumbers = fragmentNumbers
+  }
+
+  toMarkdownString(): string {
+    let result = this.text + (this.textNumber ? ' ' + this.textNumber : '')
+    if (this.fragmentNumbers && this.fragmentNumbers.length > 0) {
+      result += ` (${this.fragmentsToMarkdownString()})`
+    }
+    if (this.linesDiscussed) result += ', ' + this.linesDiscussed
+    if (this.discussedBy) result += ': ' + this.discussedBy
+    if (this.discussedByNotes) result += ' ' + this.discussedByNotes
+    result += `<small class="text-black-50 ml-3">${`[${this.afoNumber}, ${this.page}]`}</small>`
+    result = result.replace(/\^([^^]+)\^/g, '<sup>$1</sup>')
+    return result
+  }
+
+  private fragmentsToMarkdownString(): string {
+    if (!this.fragmentNumbers) {
+      return ''
+    }
+    return this.fragmentNumbers
+      .map(
+        (fragmentNumber) =>
+          `[${fragmentNumber}](/fragmentarium/${fragmentNumber})`
+      )
+      .join(', ')
+  }
+
+  setFragmentNumbers(fragmentNumbers: string[]): AfoRegisterRecord {
+    return produce(this, (draft: Draft<AfoRegisterRecord>) => {
+      draft.fragmentNumbers = fragmentNumbers
+    })
+  }
+}

src/afo-register/infrastructure/AfoRegisterRepository.test.ts

@@ -0,0 +1,35 @@
+import AfoRegisterRecord from 'afo-register/domain/Record'
+import ApiClient from 'http/ApiClient'
+import AfoRegisterRepository from './AfoRegisterRepository'
+import Promise from 'bluebird'
+import { testDelegation, TestData } from 'test-support/utils'
+
+jest.mock('http/ApiClient')
+
+const apiClient = new (ApiClient as jest.Mock<jest.Mocked<ApiClient>>)()
+const afoRegisterRepository = new AfoRegisterRepository(apiClient)
+const query = '{"afoNumber": "AfO 12", "page": "321"}'
+const resultStub = {
+  afoNumber: 'AfO 12',
+  page: '321',
+  text: 'text',
+  textNumber: 'text number',
+  linesDiscussed: '',
+  discussedBy: '',
+  discussedByNotes: '',
+}
+const entry = new AfoRegisterRecord(resultStub)
+
+const testData: TestData<AfoRegisterRepository>[] = [
+  new TestData(
+    'search',
+    [query],
+    apiClient.fetchJson,
+    [entry],
+    [`/afo-register?${query}`, false],
+    Promise.resolve([resultStub])
+  ),
+]
+
+describe('AfoRegisterRepository', () =>
+  testDelegation(afoRegisterRepository, testData))

src/afo-register/infrastructure/AfoRegisterRepository.ts

@@ -0,0 +1,70 @@
+import AfoRegisterRecord, {
+  AfoRegisterRecordSuggestion,
+} from 'afo-register/domain/Record'
+import Promise from 'bluebird'
+import FragmentService from 'fragmentarium/application/FragmentService'
+import ApiClient from 'http/ApiClient'
+
+function createAfoRegisterRecord(data): AfoRegisterRecord {
+  return new AfoRegisterRecord(data)
+}
+
+function createAfoRegisterRecordSuggestion(data): AfoRegisterRecordSuggestion {
+  return new AfoRegisterRecordSuggestion(data)
+}
+
+function injectFragmentReferecesToRecord(
+  record: AfoRegisterRecord,
+  fragmentService: FragmentService
+): Promise<AfoRegisterRecord> {
+  const { text, textNumber } = record
+  return fragmentService
+    .query({ traditionalReferences: text + ' ' + textNumber })
+    .then((queryResult) => {
+      return record.setFragmentNumbers(
+        queryResult.items.map((item) => item.museumNumber)
+      )
+    })
+}
+
+export default class AfoRegisterRepository {
+  private readonly apiClient: ApiClient
+
+  constructor(apiClient: ApiClient) {
+    this.apiClient = apiClient
+  }
+
+  search(
+    query: string,
+    fragmentService?: FragmentService
+  ): Promise<AfoRegisterRecord[]> {
+    return this.apiClient
+      .fetchJson(`/afo-register?${query}`, false)
+      .then((result) => result.map(createAfoRegisterRecord))
+      .then((records) => {
+        if (fragmentService) {
+          return Promise.all(
+            records.map((record) =>
+              injectFragmentReferecesToRecord(record, fragmentService)
+            )
+          )
+        } else {
+          return records
+        }
+      })
+  }
+
+  searchTextsAndNumbers(
+    query: readonly string[]
+  ): Promise<AfoRegisterRecord[]> {
+    return this.apiClient
+      .postJson(`/afo-register/texts-numbers`, query, false)
+      .then((result) => result.map(createAfoRegisterRecord))
+  }
+
+  searchSuggestions(query: string): Promise<AfoRegisterRecordSuggestion[]> {
+    return this.apiClient
+      .fetchJson(`/afo-register/suggestions?text_query=${query}`, false)
+      .then((result) => result.map(createAfoRegisterRecordSuggestion))
+  }
+}

src/afo-register/ui/AfoRegisterDisplay.tsx

@@ -0,0 +1,38 @@
+import React from 'react'
+import AfoRegisterRecord from 'afo-register/domain/Record'
+import MarkdownAndHtmlToHtml from 'common/MarkdownAndHtmlToHtml'
+
+export function AfoRegisterRecordDisplay({
+  record,
+  index,
+}: {
+  record: AfoRegisterRecord
+  index: string | number
+}): JSX.Element {
+  return (
+    <MarkdownAndHtmlToHtml
+      key={`md-${index}`}
+      markdownAndHtml={record.toMarkdownString()}
+    />
+  )
+}
+
+export function AfoRegisterRecordsListDisplay({
+  records,
+  ...props
+}: {
+  records: readonly AfoRegisterRecord[]
+} & React.OlHTMLAttributes<HTMLOListElement>): JSX.Element {
+  if (records.length < 1) {
+    return <p>No records found</p>
+  }
+  return (
+    <ol {...props}>
+      {records.map((record, index) => (
+        <li key={`li-${index}`} className="afoRegisterRecordsList__record">
+          <AfoRegisterRecordDisplay record={record} index={index} />
+        </li>
+      ))}
+    </ol>
+  )
+}