search-api-types.ts

export enum UrlParams {
  Combinator = 'combinator',
  SearchType = 'search-type',
  SelectedWords = 'selected-words',
  ExcludedWords = 'excluded-words',
  Taxon = 'taxon',
  Person = 'person',
  PublishingOrganisation = 'publishing-organisation',
  CaseSensitive = 'case-sensitive',
  DocumentType = 'document-type',
  KeywordLocation = 'keyword-location',
  LinkSearchUrl = 'link-search-url',
  PhoneNumber = 'phone-number',
  PublishingApplication = 'publishing-application',
  PublishingStatus = 'publishing-status',
  Language = 'language',
  PoliticalStatus = 'political-status',
  Government = 'government',
}

export enum SearchType {
  Keyword = 'keyword',
  Link = 'link',
  PhoneNumber = 'phone-number',
  Organisation = 'organisation',
  Taxon = 'taxon',
  Person = 'person',
  Language = 'language',
  Advanced = 'advanced',
  Results = 'results',
}

export enum Combinator {
  Any = 'any',
  All = 'all',
  NotSet = 'notset',
}

export enum KeywordLocation {
  All = 'all',
  Title = 'title',
  Description = 'description',
  BodyContent = 'bodycontent',
}

export enum PublishingStatus {
  Withdrawn = 'withdrawn',
  NotWithdrawn = 'notWithdrawn',
  All = 'all',
}

export enum PublishingApplication {
  Any = 'any',
  Whitehall = 'whitehall',
  Publisher = 'publisher',
}

export enum PoliticalStatus {
  Any = 'any',
  Political = 'political',
  NotPolitical = 'notPolitical',
}

export type SearchParams = {
  searchType: SearchType
  selectedWords: string // list of words to search
  excludedWords: string // list of words to exclude
  taxon: string // taxon to search in
  person: string // person whose pages to search
  publishingOrganisation: string // organisation to search in
  language: string // the language to search for
  documentType: string // documentTypeto search in
  linkSearchUrl: string // URL to find all pages linking to
  phoneNumber: string // the phone number to search for
  keywordLocation: KeywordLocation // what parts of the pages to search in
  combinator: Combinator // all keywords or any keywords
  publishingApplication: PublishingApplication // whitehall, publisher, both
  caseSensitive: boolean // case sensitive keyword search?
  publishingStatus: PublishingStatus // Withdrawn, not withdrawn etc.
  politicalStatus: PoliticalStatus // page is politial: true, false, null
  government: string // government that published the page.
}

// a search can return a variable number of records of any type
export type SearchResults = unknown[]

export type InitResults = {
  taxons: string[]
  people: string[]
  locales: string[]
  organisations: string[]
  documentTypes: string[]
  governments: string[]
}

export type Occurrence = {
  keyword: string[]
  occurrences: number[]
}