/* * Bundle: MeiliSearch * Project: MeiliSearch - Javascript API * Author: Quentin de Quelen * Copyright: 2019, MeiliSearch */ import { Index } from "../indexes"; import { KeyCreation, Config, IndexOptions, IndexObject, Key, Health, Stats, Version, ErrorStatusCode, TokenSearchRules, TokenOptions, TasksQuery, WaitOptions, KeyUpdate, IndexesQuery, IndexesResults, KeysQuery, KeysResults, TasksResults, EnqueuedTaskObject, SwapIndexesParams, CancelTasksQuery, DeleteTasksQuery, MultiSearchParams, MultiSearchResponse, SearchResponse, FederatedMultiSearchParams, } from "../types"; import { HttpRequests } from "../http-requests"; import { TaskClient, Task } from "../task"; import { EnqueuedTask } from "../enqueued-task"; class Client { config: Config; httpRequest: HttpRequests; tasks: TaskClient; /** * Creates new MeiliSearch instance * * @param config - Configuration object */ constructor(config: Config) { this.config = config; this.httpRequest = new HttpRequests(config); this.tasks = new TaskClient(config); } /** * Return an Index instance * * @param indexUid - The index UID * @returns Instance of Index */ index = Record>( indexUid: string, ): Index { return new Index(this.config, indexUid); } /** * Gather information about an index by calling MeiliSearch and return an * Index instance with the gathered information * * @param indexUid - The index UID * @returns Promise returning Index instance */ async getIndex = Record>( indexUid: string, ): Promise> { return new Index(this.config, indexUid).fetchInfo(); } /** * Gather information about an index by calling MeiliSearch and return the raw * JSON response * * @param indexUid - The index UID * @returns Promise returning index information */ async getRawIndex(indexUid: string): Promise { return new Index(this.config, indexUid).getRawInfo(); } /** * Get all the indexes as Index instances. * * @param parameters - Parameters to browse the indexes * @returns Promise returning array of raw index information */ async getIndexes( parameters: IndexesQuery = {}, ): Promise> { const rawIndexes = await this.getRawIndexes(parameters); const indexes: Index[] = rawIndexes.results.map( (index) => new Index(this.config, index.uid, index.primaryKey), ); return { ...rawIndexes, results: indexes }; } /** * Get all the indexes in their raw value (no Index instances). * * @param parameters - Parameters to browse the indexes * @returns Promise returning array of raw index information */ async getRawIndexes( parameters: IndexesQuery = {}, ): Promise> { const url = `indexes`; return await this.httpRequest.get>( url, parameters, ); } /** * Create a new index * * @param uid - The index UID * @param options - Index options * @returns Promise returning Index instance */ async createIndex( uid: string, options: IndexOptions = {}, ): Promise { return await Index.create(uid, options, this.config); } /** * Update an index * * @param uid - The index UID * @param options - Index options to update * @returns Promise returning Index instance after updating */ async updateIndex( uid: string, options: IndexOptions = {}, ): Promise { return await new Index(this.config, uid).update(options); } /** * Delete an index * * @param uid - The index UID * @returns Promise which resolves when index is deleted successfully */ async deleteIndex(uid: string): Promise { return await new Index(this.config, uid).delete(); } /** * Deletes an index if it already exists. * * @param uid - The index UID * @returns Promise which resolves to true when index exists and is deleted * successfully, otherwise false if it does not exist */ async deleteIndexIfExists(uid: string): Promise { try { await this.deleteIndex(uid); return true; } catch (e: any) { if (e.code === ErrorStatusCode.INDEX_NOT_FOUND) { return false; } throw e; } } /** * Swaps a list of index tuples. * * @param params - List of indexes tuples to swap. * @returns Promise returning object of the enqueued task */ async swapIndexes(params: SwapIndexesParams): Promise { const url = "/swap-indexes"; return await this.httpRequest.post(url, params); } /// /// Multi Search /// /** * Perform multiple search queries. * * It is possible to make multiple search queries on the same index or on * different ones * * @example * * ```ts * client.multiSearch({ * queries: [ * { indexUid: "movies", q: "wonder" }, * { indexUid: "books", q: "flower" }, * ], * }); * ``` * * @param queries - Search queries * @param config - Additional request configuration options * @returns Promise containing the search responses */ multiSearch = Record>( queries: MultiSearchParams, config?: Partial, ): Promise>; multiSearch = Record>( queries: FederatedMultiSearchParams, config?: Partial, ): Promise>; async multiSearch = Record>( queries: MultiSearchParams | FederatedMultiSearchParams, config?: Partial, ): Promise | SearchResponse> { const url = `multi-search`; return await this.httpRequest.post(url, queries, undefined, config); } /// /// TASKS /// /** * Get the list of all client tasks * * @param parameters - Parameters to browse the tasks * @returns Promise returning all tasks */ async getTasks(parameters: TasksQuery = {}): Promise { return await this.tasks.getTasks(parameters); } /** * Get one task on the client scope * * @param taskUid - Task identifier * @returns Promise returning a task */ async getTask(taskUid: number): Promise { return await this.tasks.getTask(taskUid); } /** * Wait for multiple tasks to be finished. * * @param taskUids - Tasks identifier * @param waitOptions - Options on timeout and interval * @returns Promise returning an array of tasks */ async waitForTasks( taskUids: number[], { timeOutMs = 5000, intervalMs = 50 }: WaitOptions = {}, ): Promise { return await this.tasks.waitForTasks(taskUids, { timeOutMs, intervalMs, }); } /** * Wait for a task to be finished. * * @param taskUid - Task identifier * @param waitOptions - Options on timeout and interval * @returns Promise returning an array of tasks */ async waitForTask( taskUid: number, { timeOutMs = 5000, intervalMs = 50 }: WaitOptions = {}, ): Promise { return await this.tasks.waitForTask(taskUid, { timeOutMs, intervalMs, }); } /** * Cancel a list of enqueued or processing tasks. * * @param parameters - Parameters to filter the tasks. * @returns Promise containing an EnqueuedTask */ async cancelTasks(parameters: CancelTasksQuery): Promise { return await this.tasks.cancelTasks(parameters); } /** * Delete a list of tasks. * * @param parameters - Parameters to filter the tasks. * @returns Promise containing an EnqueuedTask */ async deleteTasks(parameters: DeleteTasksQuery = {}): Promise { return await this.tasks.deleteTasks(parameters); } /// /// KEYS /// /** * Get all API keys * * @param parameters - Parameters to browse the indexes * @returns Promise returning an object with keys */ async getKeys(parameters: KeysQuery = {}): Promise { const url = `keys`; const keys = await this.httpRequest.get(url, parameters); keys.results = keys.results.map((key) => ({ ...key, createdAt: new Date(key.createdAt), updatedAt: new Date(key.updatedAt), })); return keys; } /** * Get one API key * * @param keyOrUid - Key or uid of the API key * @returns Promise returning a key */ async getKey(keyOrUid: string): Promise { const url = `keys/${keyOrUid}`; return await this.httpRequest.get(url); } /** * Create one API key * * @param options - Key options * @returns Promise returning a key */ async createKey(options: KeyCreation): Promise { const url = `keys`; return await this.httpRequest.post(url, options); } /** * Update one API key * * @param keyOrUid - Key * @param options - Key options * @returns Promise returning a key */ async updateKey(keyOrUid: string, options: KeyUpdate): Promise { const url = `keys/${keyOrUid}`; return await this.httpRequest.patch(url, options); } /** * Delete one API key * * @param keyOrUid - Key * @returns */ async deleteKey(keyOrUid: string): Promise { const url = `keys/${keyOrUid}`; return await this.httpRequest.delete(url); } /// /// HEALTH /// /** * Checks if the server is healthy, otherwise an error will be thrown. * * @returns Promise returning an object with health details */ async health(): Promise { const url = `health`; return await this.httpRequest.get(url); } /** * Checks if the server is healthy, return true or false. * * @returns Promise returning a boolean */ async isHealthy(): Promise { try { const url = `health`; await this.httpRequest.get(url); return true; } catch { return false; } } /// /// STATS /// /** * Get the stats of all the database * * @returns Promise returning object of all the stats */ async getStats(): Promise { const url = `stats`; return await this.httpRequest.get(url); } /// /// VERSION /// /** * Get the version of MeiliSearch * * @returns Promise returning object with version details */ async getVersion(): Promise { const url = `version`; return await this.httpRequest.get(url); } /// /// DUMPS /// /** * Creates a dump * * @returns Promise returning object of the enqueued task */ async createDump(): Promise { const url = `dumps`; const task = await this.httpRequest.post( url, ); return new EnqueuedTask(task); } /// /// SNAPSHOTS /// /** * Creates a snapshot * * @returns Promise returning object of the enqueued task */ async createSnapshot(): Promise { const url = `snapshots`; const task = await this.httpRequest.post( url, ); return new EnqueuedTask(task); } /// /// TOKENS /// /** * Generate a tenant token * * @param apiKeyUid - The uid of the api key used as issuer of the token. * @param searchRules - Search rules that are applied to every search. * @param options - Token options to customize some aspect of the token. * @returns The token in JWT format. */ generateTenantToken( _apiKeyUid: string, _searchRules: TokenSearchRules, _options?: TokenOptions, ): Promise { const error = new Error(); error.message = `Meilisearch: failed to generate a tenant token. Generation of a token only works in a node environment \n ${error.stack}.`; return Promise.reject(error); } } export { Client };