@mongodb-js/mongodb-constants 0.7.0 → 0.7.2

package/dist/.esm-wrapper.mjs

@@ -6,6 +6,7 @@ export const ADL = mod.ADL;
 export const ANY_COLLECTION_NAMESPACE = mod.ANY_COLLECTION_NAMESPACE;
 export const ANY_NAMESPACE = mod.ANY_NAMESPACE;
 export const ATLAS = mod.ATLAS;
+export const ATLAS_SEARCH_TEMPLATES = mod.ATLAS_SEARCH_TEMPLATES;
 export const BSON_TYPES = mod.BSON_TYPES;
 export const BSON_TYPE_ALIASES = mod.BSON_TYPE_ALIASES;
 export const COLLECTION = mod.COLLECTION;

package/dist/atlas-search-templates.d.ts

@@ -0,0 +1,7 @@
+export type SearchTemplate = {
+    name: string;
+    snippet: string;
+    version: string;
+};
+export declare const ATLAS_SEARCH_TEMPLATES: SearchTemplate[];
+//# sourceMappingURL=atlas-search-templates.d.ts.map

package/dist/atlas-search-templates.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"atlas-search-templates.d.ts","sourceRoot":"","sources":["../src/atlas-search-templates.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,eAAO,MAAM,sBAAsB,EAAE,cAAc,EA+GlD,CAAC"}

package/dist/atlas-search-templates.js

@@ -0,0 +1,120 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ATLAS_SEARCH_TEMPLATES = void 0;
+const dedent_1 = __importDefault(require("dedent"));
+exports.ATLAS_SEARCH_TEMPLATES = [
+    {
+        name: 'Dynamic field mappings',
+        snippet: (0, dedent_1.default) `{
+            "mappings": {
+              "dynamic": true
+            }
+        }`,
+        version: '4.4.0',
+    },
+    {
+        name: 'Static field mappings',
+        snippet: (0, dedent_1.default) `{
+            "mappings": {
+              "dynamic": false,
+              "fields": {
+                \${1:<string field name>}: {
+                    "type": "string"
+                },
+                \${2:<number field name>}: {
+                    "type": "number"
+                },
+                \${3:<date field name>}: {
+                    "type": "date"
+                },
+                \${4:<geo field name>}: {
+                    "type": "geo"
+                },
+              } 
+            }
+        }`,
+        version: '4.4.0',
+    },
+    {
+        name: 'Text field mappings',
+        snippet: (0, dedent_1.default) `{
+            "mappings": {
+              "dynamic": true,
+              "fields": {
+                \${1:<string field name>}: [
+                  {
+                    // Enables text queries
+                    "type": "string"
+                  },
+                  {
+                    // Enables autocomplete queries
+                    "type": "autocomplete"
+                    
+                  },
+                  {
+                    // Enables sorting
+                    "type": "token"
+                  }
+                ]  
+              } 
+            }
+          }`,
+        version: '4.4.0',
+    },
+    {
+        name: 'Facet field mappings',
+        snippet: (0, dedent_1.default) `{
+            "mappings": {
+              "dynamic": true,
+              "fields": {
+                \${1:<number field name for faceting>}: [
+                  {
+                    "type": "numberFacet"
+                  },
+                  {
+                    "type": "number"
+                  },
+                ],
+                \${2:<date field name for faceting>}: [
+                  {
+                     "type": "dateFacet"
+                  }
+                  {
+                     "type": "date"
+                  }
+                ],
+                \${3:<string field name for faceting>}: [
+                  {
+                    "type": "stringFacet"
+                  },
+                  {
+                    "type": "string",
+                    "analyzer": "lucene.keyword"
+                  },
+                ],
+              } 
+            }
+          }`,
+        version: '4.4.0',
+    },
+    {
+        name: 'Vector Embedding field mapping',
+        snippet: (0, dedent_1.default) `{
+            "mappings": {
+              "dynamic": true,
+              "fields": {
+                \${1:<vector embedding field name>}: [
+                  {
+                    "type": "vectorEmbedding"
+                  }      
+                ]    
+              } 
+            }
+        }`,
+        version: '4.4.0',
+    },
+];
+//# sourceMappingURL=atlas-search-templates.js.map

package/dist/atlas-search-templates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"atlas-search-templates.js","sourceRoot":"","sources":["../src/atlas-search-templates.ts"],"names":[],"mappings":";;;;;;AAAA,oDAA4B;AAQf,QAAA,sBAAsB,GAAqB;IACtD;QACE,IAAI,EAAE,wBAAwB;QAC9B,OAAO,EAAE,IAAA,gBAAM,EAAA;;;;UAIT;QACN,OAAO,EAAE,OAAO;KACjB;IACD;QACE,IAAI,EAAE,uBAAuB;QAC7B,OAAO,EAAE,IAAA,gBAAM,EAAA;;;;;;;;;;;;;;;;;;UAkBT;QACN,OAAO,EAAE,OAAO;KACjB;IACD;QACE,IAAI,EAAE,qBAAqB;QAC3B,OAAO,EAAE,IAAA,gBAAM,EAAA;;;;;;;;;;;;;;;;;;;;;YAqBP;QACR,OAAO,EAAE,OAAO;KACjB;IACD;QACE,IAAI,EAAE,sBAAsB;QAC5B,OAAO,EAAE,IAAA,gBAAM,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YA+BP;QACR,OAAO,EAAE,OAAO;KACjB;IACD;QACE,IAAI,EAAE,gCAAgC;QACtC,OAAO,EAAE,IAAA,gBAAM,EAAA;;;;;;;;;;;UAWT;QACN,OAAO,EAAE,OAAO;KACjB;CACF,CAAC"}

package/dist/filter.d.ts

@@ -2073,8 +2073,8 @@ declare const ALL_CONSTANTS: ({
     readonly apiVersions: readonly [];
     readonly namespaces: readonly ["coll"];
     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`.";
-    readonly comment: "/**\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 * index: Name of the Atlas Search index to use. If omitted, defaults to `default`. (Optional)\n * limit: Number (of type `int` only) of documents to return in the results. (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 * path: The field to search. (Required)\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 */\n";
-    readonly snippet: "{\n  queryVector: [${1:dimension1}, ${2:dimension2}, ...],\n  path: ${3:string},\n  numCandidates: ${4:numCandidates},\n  limit: ${5:limit},\n  index: ${6:string},\n  filter: {}\n}";
+    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";
+    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}";
 } | {
     readonly name: "$set";
     readonly value: "$set";

package/dist/index.d.ts

@@ -11,4 +11,5 @@ export * from './stage-operators';
 export * from './system-variables';
 export { getFilteredCompletions, wrapField } from './filter';
 export type { Completion, FilterOptions as CompletionFilterOptions, } from './filter';
+export * from './atlas-search-templates';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC;AACpC,cAAc,cAAc,CAAC;AAC7B,cAAc,wBAAwB,CAAC;AACvC,cAAc,OAAO,CAAC;AACtB,cAAc,wBAAwB,CAAC;AACvC,cAAc,eAAe,CAAC;AAC9B,cAAc,MAAM,CAAC;AACrB,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,OAAO,EAAE,sBAAsB,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAC7D,YAAY,EACV,UAAU,EACV,aAAa,IAAI,uBAAuB,GACzC,MAAM,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC;AACpC,cAAc,cAAc,CAAC;AAC7B,cAAc,wBAAwB,CAAC;AACvC,cAAc,OAAO,CAAC;AACtB,cAAc,wBAAwB,CAAC;AACvC,cAAc,eAAe,CAAC;AAC9B,cAAc,MAAM,CAAC;AACrB,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,OAAO,EAAE,sBAAsB,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAC7D,YAAY,EACV,UAAU,EACV,aAAa,IAAI,uBAAuB,GACzC,MAAM,UAAU,CAAC;AAClB,cAAc,0BAA0B,CAAC"}

package/dist/index.js

@@ -29,4 +29,5 @@ __exportStar(require("./system-variables"), exports);
 var filter_1 = require("./filter");
 Object.defineProperty(exports, "getFilteredCompletions", { enumerable: true, get: function () { return filter_1.getFilteredCompletions; } });
 Object.defineProperty(exports, "wrapField", { enumerable: true, get: function () { return filter_1.wrapField; } });
+__exportStar(require("./atlas-search-templates"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,iDAA+B;AAC/B,sDAAoC;AACpC,+CAA6B;AAC7B,yDAAuC;AACvC,wCAAsB;AACtB,yDAAuC;AACvC,gDAA8B;AAC9B,uCAAqB;AACrB,oDAAkC;AAClC,oDAAkC;AAClC,qDAAmC;AACnC,mCAA6D;AAApD,gHAAA,sBAAsB,OAAA;AAAE,mGAAA,SAAS,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,iDAA+B;AAC/B,sDAAoC;AACpC,+CAA6B;AAC7B,yDAAuC;AACvC,wCAAsB;AACtB,yDAAuC;AACvC,gDAA8B;AAC9B,uCAAqB;AACrB,oDAAkC;AAClC,oDAAkC;AAClC,qDAAmC;AACnC,mCAA6D;AAApD,gHAAA,sBAAsB,OAAA;AAAE,mGAAA,SAAS,OAAA;AAK1C,2DAAyC"}

package/dist/stage-operators.d.ts

@@ -444,8 +444,8 @@ declare const STAGE_OPERATORS: readonly [{
     readonly apiVersions: readonly [];
     readonly namespaces: readonly ["coll"];
     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`.";
-    readonly comment: "/**\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 * index: Name of the Atlas Search index to use. If omitted, defaults to `default`. (Optional)\n * limit: Number (of type `int` only) of documents to return in the results. (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 * path: The field to search. (Required)\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 */\n";
-    readonly snippet: "{\n  queryVector: [${1:dimension1}, ${2:dimension2}, ...],\n  path: ${3:string},\n  numCandidates: ${4:numCandidates},\n  limit: ${5:limit},\n  index: ${6:string},\n  filter: {}\n}";
+    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";
+    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}";
 }, {
     readonly name: "$set";
     readonly value: "$set";
@@ -800,8 +800,8 @@ declare const REQUIRED_AS_FIRST_STAGE: ({
     readonly apiVersions: readonly [];
     readonly namespaces: readonly ["coll"];
     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`.";
-    readonly comment: "/**\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 * index: Name of the Atlas Search index to use. If omitted, defaults to `default`. (Optional)\n * limit: Number (of type `int` only) of documents to return in the results. (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 * path: The field to search. (Required)\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 */\n";
-    readonly snippet: "{\n  queryVector: [${1:dimension1}, ${2:dimension2}, ...],\n  path: ${3:string},\n  numCandidates: ${4:numCandidates},\n  limit: ${5:limit},\n  index: ${6:string},\n  filter: {}\n}";
+    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";
+    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}";
 } | {
     readonly name: "$changeStream";
     readonly value: "$changeStream";

package/dist/stage-operators.js

@@ -778,21 +778,21 @@ const STAGE_OPERATORS = [
         namespaces: [ns_1.COLLECTION],
         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`.',
         comment: `/**
- * 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)
- * index: Name of the Atlas Search index to use. If omitted, defaults to \`default\`. (Optional)
- * limit: Number (of type \`int\` only) of documents to return in the results. (Required)
- * 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)
+ * 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)
  * path: The field to search. (Required)
- * 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)
+ * 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)
+ * index: Name of the Atlas Search index to use. (Required)
+ * limit: Number (of type \`int\` only) of documents to return in the results. (Required)
+ * 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)
  */
 `,
         snippet: `{
   queryVector: [\${1:dimension1}, \${2:dimension2}, ...],
   path: \${3:string},
   numCandidates: \${4:numCandidates},
-  limit: \${5:limit},
-  index: \${6:string},
-  filter: {}
+  index: \${5:string},
+  limit: \${6:limit},
+  filter: {\${7:expression}}
 }`,
     },
     {

package/package.json

@@ -13,7 +13,7 @@
     "email": "compass@mongodb.com"
   },
   "homepage": "https://github.com/mongodb-js/devtools-shared",
-  "version": "0.7.0",
+  "version": "0.7.2",
   "repository": {
     "type": "git",
     "url": "https://github.com/mongodb-js/devtools-shared.git"
@@ -66,7 +66,8 @@
     "typescript": "^5.0.4"
   },
   "dependencies": {
+    "dedent": "^1.5.1",
     "semver": "^7.5.4"
   },
-  "gitHead": "ec0dbea4c882e191ebed5bc69298776b5ae9a924"
+  "gitHead": "665d291d3d63746a5d9d13f951f6229fe9f308dc"
 }