weseek__growi/apps/app/src/server/interfaces/search.ts

/* eslint-disable camelcase */
import { SearchDelegatorName } from '~/interfaces/named-query';
import { ISearchResult } from '~/interfaces/search';


export type QueryTerms = {
  match: string[],
  not_match: string[],
  phrase: string[],
  not_phrase: string[],
  prefix: string[],
  not_prefix: string[],
  tag: string[],
  not_tag: string[],
}

export type ParsedQuery = { queryString: string, terms: QueryTerms, delegatorName?: string }

export interface SearchQueryParser {
  parseSearchQuery(queryString: string, nqName: string | null): Promise<ParsedQuery>
}

export interface SearchResolver {
  resolve(parsedQuery: ParsedQuery): Promise<[SearchDelegator, SearchableData | null]>
}

export interface SearchDelegator<T = unknown, KEY extends AllTermsKey = AllTermsKey, QTERMS = QueryTerms> {
  name?: SearchDelegatorName
  search(data: SearchableData | null, user, userGroups, option): Promise<ISearchResult<T>>
  isTermsNormalized(terms: Partial<QueryTerms>): terms is Partial<QTERMS>,
  validateTerms(terms: QueryTerms): UnavailableTermsKey<KEY>[],
}

export type SearchableData<T = Partial<QueryTerms>> = {
  queryString: string
  terms: T
}

export type UpdateOrInsertPagesOpts = {
  shouldEmitProgress?: boolean
  invokeGarbageCollection?: boolean
}

// Terms Key types
export type AllTermsKey = keyof QueryTerms;
export type UnavailableTermsKey<K extends AllTermsKey> = Exclude<AllTermsKey, K>;
export type ESTermsKey = 'match' | 'not_match' | 'phrase' | 'not_phrase' | 'prefix' | 'not_prefix' | 'tag' | 'not_tag';
export type MongoTermsKey = 'match' | 'not_match' | 'prefix' | 'not_prefix';

// Query Terms types
export type ESQueryTerms = Pick<QueryTerms, ESTermsKey>;
export type MongoQueryTerms = Pick<QueryTerms, MongoTermsKey>;