@mongosh/autocomplete 2.0.1 → 2.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/lib/index.d.ts +58 -2
  2. package/package.json +4 -4
package/lib/index.d.ts CHANGED
@@ -130,6 +130,12 @@ export declare const BASE_COMPLETIONS: ({
130
130
  readonly score: 1;
131
131
  readonly meta: "accumulator";
132
132
  readonly version: "5.2.0";
133
+ } | {
134
+ readonly name: "$median";
135
+ readonly value: "$median";
136
+ readonly score: 1;
137
+ readonly meta: "accumulator";
138
+ readonly version: "7.0.0";
133
139
  } | {
134
140
  readonly name: "$min";
135
141
  readonly value: "$min";
@@ -143,6 +149,12 @@ export declare const BASE_COMPLETIONS: ({
143
149
  readonly score: 1;
144
150
  readonly meta: "accumulator";
145
151
  readonly version: "5.2.0";
152
+ } | {
153
+ readonly name: "$percentile";
154
+ readonly value: "$percentile";
155
+ readonly score: 1;
156
+ readonly meta: "accumulator";
157
+ readonly version: "7.0.0";
146
158
  } | {
147
159
  readonly name: "$push";
148
160
  readonly value: "$push";
@@ -1687,7 +1699,7 @@ export declare const BASE_COMPLETIONS: ({
1687
1699
  readonly apiVersions: readonly [];
1688
1700
  readonly namespaces: readonly ["coll"];
1689
1701
  readonly description: "Performs a full-text search on the specified field(s).";
1690
- readonly comment: "/**\n * index: The name of the Search index.\n * text: Analyzed search, with required fields of query and path, the analyzed field(s) to search.\n * term: Un-analyzed search.\n * compound: Combines ops.\n * span: Find in text field regions.\n * exists: Test for presence of a field.\n * near: Find near number or date.\n * range: Find in numeric or date range.\n */\n";
1702
+ readonly comment: "/**\n * index: The name of the Search index.\n * text: Analyzed search, with required fields of query and path, the analyzed field(s) to search.\n * compound: Combines ops.\n * span: Find in text field regions.\n * exists: Test for presence of a field.\n * near: Find near number or date.\n * range: Find in numeric or date range.\n */\n";
1691
1703
  readonly snippet: "{\n index: '${1:string}',\n text: {\n query: '${2:string}',\n path: '${3:string}'\n }\n}";
1692
1704
  } | {
1693
1705
  readonly name: "$searchMeta";
@@ -1705,6 +1717,22 @@ export declare const BASE_COMPLETIONS: ({
1705
1717
  readonly description: "Performs a full-text search on the specified field(s) and gets back only the generated search meta data from a query.";
1706
1718
  readonly comment: "/**\n * index: The name of the Search index.\n * count: The count of the results.\n * facet: {\n * operator: Analyzed search, with required fields of query and path, can either be replaced with the name of a valid operator.\n * facets: {\n * stringFacet: Narrows search results based on unique string values, with required fields of type and path.\n * numberFacet: Narrows search results by breaking them up into separate ranges of numbers, with required fields of type, path, and boundaries.\n * dateFacet: Narrows search results by breaking them up into separate ranges of dates, with required fields of type, path, and boundaries.\n * }\n * }\n */\n";
1707
1719
  readonly snippet: "{\n index: ${1:string},\n facet: {\n operator: {\n text: {\n query: ${2:string},\n path: ${3:string}\n }\n },\n facets: {\n ${4:stringFacet}: {\n type: ${5:string},\n path: ${6:string},\n numBuckets: ${7:integer}\n },\n numberFacet: {\n type: 'number',\n path: ${8:string},\n boundaries: [${9:lowerbound}, ${10:upperbound}, ...],\n default: ${11:string}\n }\n }\n }\n}";
1720
+ } | {
1721
+ readonly name: "$vectorSearch";
1722
+ readonly value: "$vectorSearch";
1723
+ readonly label: "$vectorSearch";
1724
+ readonly outputStage: false;
1725
+ readonly fullScan: false;
1726
+ readonly firstStage: true;
1727
+ readonly score: 1;
1728
+ readonly env: readonly ["atlas"];
1729
+ readonly meta: "stage";
1730
+ readonly version: "7.0.2";
1731
+ readonly apiVersions: readonly [];
1732
+ readonly namespaces: readonly ["coll"];
1733
+ readonly description: "Performs a kNN search on a vector in the specified field or fields. The field that you want to search must be covered by an Atlas Search index of type `vectorEmbedding`.";
1734
+ readonly comment: "/**\n * queryVector: Array of numbers of BSON types `int` or `double` that represent the query vector. The array size must match the number of vector dimensions specified in the index for the field. (Required)\n * path: The field to search. (Required)\n * numCandidates: Number of nearest neighbors to use during the search. You can specify a number higher than the number of documents to return (`limit`) to increase accuracy. (Required)\n * index: Name of the Atlas Search index to use. (Required)\n * limit: Number (of type `int` only) of documents to return in the results. (Required)\n * filter: Any MongoDB Query Language (MQL) match expression that compares an indexed field with a boolean, number (not decimals), or string to use as a prefilter. (Optional)\n */\n";
1735
+ readonly snippet: "{\n queryVector: [${1:dimension1}, ${2:dimension2}, ...],\n path: ${3:string},\n numCandidates: ${4:numCandidates},\n index: ${5:string},\n limit: ${6:limit},\n filter: {${7:expression}}\n}";
1708
1736
  } | {
1709
1737
  readonly name: "$set";
1710
1738
  readonly value: "$set";
@@ -1998,6 +2026,12 @@ export declare const MATCH_COMPLETIONS: ({
1998
2026
  readonly score: 1;
1999
2027
  readonly meta: "accumulator";
2000
2028
  readonly version: "5.2.0";
2029
+ } | {
2030
+ readonly name: "$median";
2031
+ readonly value: "$median";
2032
+ readonly score: 1;
2033
+ readonly meta: "accumulator";
2034
+ readonly version: "7.0.0";
2001
2035
  } | {
2002
2036
  readonly name: "$min";
2003
2037
  readonly value: "$min";
@@ -2011,6 +2045,12 @@ export declare const MATCH_COMPLETIONS: ({
2011
2045
  readonly score: 1;
2012
2046
  readonly meta: "accumulator";
2013
2047
  readonly version: "5.2.0";
2048
+ } | {
2049
+ readonly name: "$percentile";
2050
+ readonly value: "$percentile";
2051
+ readonly score: 1;
2052
+ readonly meta: "accumulator";
2053
+ readonly version: "7.0.0";
2014
2054
  } | {
2015
2055
  readonly name: "$push";
2016
2056
  readonly value: "$push";
@@ -3555,7 +3595,7 @@ export declare const MATCH_COMPLETIONS: ({
3555
3595
  readonly apiVersions: readonly [];
3556
3596
  readonly namespaces: readonly ["coll"];
3557
3597
  readonly description: "Performs a full-text search on the specified field(s).";
3558
- readonly comment: "/**\n * index: The name of the Search index.\n * text: Analyzed search, with required fields of query and path, the analyzed field(s) to search.\n * term: Un-analyzed search.\n * compound: Combines ops.\n * span: Find in text field regions.\n * exists: Test for presence of a field.\n * near: Find near number or date.\n * range: Find in numeric or date range.\n */\n";
3598
+ readonly comment: "/**\n * index: The name of the Search index.\n * text: Analyzed search, with required fields of query and path, the analyzed field(s) to search.\n * compound: Combines ops.\n * span: Find in text field regions.\n * exists: Test for presence of a field.\n * near: Find near number or date.\n * range: Find in numeric or date range.\n */\n";
3559
3599
  readonly snippet: "{\n index: '${1:string}',\n text: {\n query: '${2:string}',\n path: '${3:string}'\n }\n}";
3560
3600
  } | {
3561
3601
  readonly name: "$searchMeta";
@@ -3573,6 +3613,22 @@ export declare const MATCH_COMPLETIONS: ({
3573
3613
  readonly description: "Performs a full-text search on the specified field(s) and gets back only the generated search meta data from a query.";
3574
3614
  readonly comment: "/**\n * index: The name of the Search index.\n * count: The count of the results.\n * facet: {\n * operator: Analyzed search, with required fields of query and path, can either be replaced with the name of a valid operator.\n * facets: {\n * stringFacet: Narrows search results based on unique string values, with required fields of type and path.\n * numberFacet: Narrows search results by breaking them up into separate ranges of numbers, with required fields of type, path, and boundaries.\n * dateFacet: Narrows search results by breaking them up into separate ranges of dates, with required fields of type, path, and boundaries.\n * }\n * }\n */\n";
3575
3615
  readonly snippet: "{\n index: ${1:string},\n facet: {\n operator: {\n text: {\n query: ${2:string},\n path: ${3:string}\n }\n },\n facets: {\n ${4:stringFacet}: {\n type: ${5:string},\n path: ${6:string},\n numBuckets: ${7:integer}\n },\n numberFacet: {\n type: 'number',\n path: ${8:string},\n boundaries: [${9:lowerbound}, ${10:upperbound}, ...],\n default: ${11:string}\n }\n }\n }\n}";
3616
+ } | {
3617
+ readonly name: "$vectorSearch";
3618
+ readonly value: "$vectorSearch";
3619
+ readonly label: "$vectorSearch";
3620
+ readonly outputStage: false;
3621
+ readonly fullScan: false;
3622
+ readonly firstStage: true;
3623
+ readonly score: 1;
3624
+ readonly env: readonly ["atlas"];
3625
+ readonly meta: "stage";
3626
+ readonly version: "7.0.2";
3627
+ readonly apiVersions: readonly [];
3628
+ readonly namespaces: readonly ["coll"];
3629
+ readonly description: "Performs a kNN search on a vector in the specified field or fields. The field that you want to search must be covered by an Atlas Search index of type `vectorEmbedding`.";
3630
+ readonly comment: "/**\n * queryVector: Array of numbers of BSON types `int` or `double` that represent the query vector. The array size must match the number of vector dimensions specified in the index for the field. (Required)\n * path: The field to search. (Required)\n * numCandidates: Number of nearest neighbors to use during the search. You can specify a number higher than the number of documents to return (`limit`) to increase accuracy. (Required)\n * index: Name of the Atlas Search index to use. (Required)\n * limit: Number (of type `int` only) of documents to return in the results. (Required)\n * filter: Any MongoDB Query Language (MQL) match expression that compares an indexed field with a boolean, number (not decimals), or string to use as a prefilter. (Optional)\n */\n";
3631
+ readonly snippet: "{\n queryVector: [${1:dimension1}, ${2:dimension2}, ...],\n path: ${3:string},\n numCandidates: ${4:numCandidates},\n index: ${5:string},\n limit: ${6:limit},\n filter: {${7:expression}}\n}";
3576
3632
  } | {
3577
3633
  readonly name: "$set";
3578
3634
  readonly value: "$set";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mongosh/autocomplete",
3
- "version": "2.0.1",
3
+ "version": "2.0.2",
4
4
  "description": "MongoDB Shell Autocomplete Package",
5
5
  "homepage": "https://github.com/mongodb-js/mongosh",
6
6
  "license": "Apache-2.0",
@@ -43,9 +43,9 @@
43
43
  "prettier": "^2.8.8"
44
44
  },
45
45
  "dependencies": {
46
- "@mongodb-js/mongodb-constants": "^0.2.2",
47
- "@mongosh/shell-api": "2.0.1",
46
+ "@mongodb-js/mongodb-constants": "^0.7.1",
47
+ "@mongosh/shell-api": "2.0.2",
48
48
  "semver": "^7.5.4"
49
49
  },
50
- "gitHead": "225d4603f0d43d500a8847beaa980e906e9a35be"
50
+ "gitHead": "5737e60cdbcd551f6a355b38fc9b5b6cc19ac5a4"
51
51
  }