Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(NODE-6044): add detailed types for SearchIndexDescription #4052

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/collection.ts
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ import {
CreateSearchIndexesOperation,
type SearchIndexDescription
} from './operations/search_indexes/create';
import type { SearchIndexDefinition } from './operations/search_indexes/definition';
import { DropSearchIndexOperation } from './operations/search_indexes/drop';
import { UpdateSearchIndexOperation } from './operations/search_indexes/update';
import {
Expand Down Expand Up @@ -1133,7 +1134,7 @@ export class Collection<TSchema extends Document = Document> {
*
* @remarks Only available when used against a 7.0+ Atlas cluster.
*/
async updateSearchIndex(name: string, definition: Document): Promise<void> {
async updateSearchIndex(name: string, definition: SearchIndexDefinition): Promise<void> {
return executeOperation(
this.client,
new UpdateSearchIndexOperation(this as TODO_NODE_3286, name, definition)
Expand Down
59 changes: 59 additions & 0 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -483,6 +483,65 @@ export type { RemoveUserOptions } from './operations/remove_user';
export type { RenameOptions } from './operations/rename';
export type { RunCommandOptions } from './operations/run_command';
export type { SearchIndexDescription } from './operations/search_indexes/create';
export type {
AsciiFoldingTokenFilter,
AutocompleteFieldMapping,
BooleanFieldMapping,
CharacterFilter,
CustomAnalyzer,
DaitchMokotoffSoundexTokenFilter,
DateFacetFieldMapping,
DateFieldMapping,
DocumentFieldMapping,
EdgeGramTokenFilter,
EdgeGramTokenizer,
EmbeddedDocumentFieldMapping,
EnglishPossessiveTokenFilter,
FieldMapping,
FlattenGraphTokenFilter,
GeoFieldMapping,
HtmlStripCharFilter,
IcuFoldingTokenFilter,
IcuNormalizeCharFilter,
IcuNormalizerTokenFilter,
KeywordTokenizer,
KnnVectorFieldMapping,
KStemmingTokenFilter,
LengthTokenFilter,
LowercaseTokenFilter,
MappingCharFilter,
NgramTokenFilter,
NGramTokenizer,
NumberFacetFieldMapping,
NumberFieldMapping,
ObjectIdFieldMapping,
PersianCharFilter,
PorterStemmingTokenFilter,
RegexCaptureGroupTokenizer,
RegexSplitTokenizer,
RegexTokenFilter,
ReverseTokenFilter,
SearchIndexDefinition,
ShingleTokenFilter,
SnowballStemmingTokenFilter,
SpanishPluralStemming,
StandardTokenizer,
StempelTokenFilter,
StopwordTokenFilter,
StoredSourceDefinition,
StoredSourceExcludeDefinition,
StoredSourceIncludeDefinition,
StringFacetFieldMapping,
StringFieldMapping,
SynonymMappingDefinition,
TokenFieldMapping,
TokenFilter,
Tokenizer,
TrimTokenFilter,
UaxUrlEmailTokenizer,
WhitespaceTokenizer,
WordDelimiterGraphTokenFilter
} from './operations/search_indexes/definition';
export type { SetProfilingLevelOptions } from './operations/set_profiling_level';
export type { DbStatsOptions } from './operations/stats';
export type {
Expand Down
5 changes: 2 additions & 3 deletions src/operations/search_indexes/create.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
import type { Document } from 'bson';

import type { Collection } from '../../collection';
import type { Server } from '../../sdam/server';
import type { ClientSession } from '../../sessions';
import { AbstractOperation } from '../operation';
import type { SearchIndexDefinition } from './definition';

/**
* @public
Expand All @@ -13,7 +12,7 @@ export interface SearchIndexDescription {
name?: string;

/** The index definition. */
definition: Document;
definition: SearchIndexDefinition;
}

/** @internal */
Expand Down