@documentdb-js/operator-registry 0.8.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+    MIT License
+
+    Copyright (c) Microsoft Corporation. All rights reserved.
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE

package/README.md

@@ -0,0 +1,92 @@
+# @documentdb-js/operator-registry
+
+[DocumentDB](https://documentdb.io/) is an open-source document database built on PostgreSQL, with native BSON support, rich indexing, and vector search. It uses the MongoDB-compatible wire protocol, runs locally with Docker, and is MIT licensed.
+
+This package is a reference catalog of operators, aggregation stages, accumulators, update operators, BSON type constructors, and system variables supported by DocumentDB. Each entry includes a description, code snippet, documentation link, and filterable meta-tags — making it easy to build context-aware autocompletion, reference panels, and documentation tooling.
+
+> **Pre-1.0 notice** — The API may change between minor versions until `1.0.0` is released.
+> If you depend on this package and need stability guarantees sooner, please
+> [open an issue](https://github.com/microsoft/vscode-documentdb/issues) and let us know.
+
+## Features
+
+- `OperatorEntry` objects with value, description, snippet, documentation link, and type metadata
+- Meta-tag based filtering (`getFilteredCompletions()`) for context-aware autocompletion
+- Convenience presets for common completion contexts (filter bar, aggregation pipeline, etc.)
+- Documentation URL generation (`getDocLink()`)
+
+## Installation
+
+```bash
+npm install @documentdb-js/operator-registry
+```
+
+## Usage
+
+```typescript
+import {
+  getFilteredCompletions,
+  getAllCompletions,
+  FILTER_COMPLETION_META,
+  STAGE_COMPLETION_META,
+} from '@documentdb-js/operator-registry';
+
+// Get operators for a filter/query context
+const filterOps = getFilteredCompletions({ meta: FILTER_COMPLETION_META });
+
+// Get operators for a specific BSON type
+const stringOps = getFilteredCompletions({
+  meta: FILTER_COMPLETION_META,
+  bsonTypes: ['string'],
+});
+
+// Get all stage names
+const stages = getFilteredCompletions({ meta: STAGE_COMPLETION_META });
+```
+
+## Data Source
+
+All operator data is derived from the official DocumentDB documentation:
+
+- **Compatibility reference:** [DocumentDB Query Language Compatibility](https://learn.microsoft.com/en-us/azure/documentdb/compatibility-query-language) — lists every operator with its support status across DocumentDB versions 5.0–8.0.
+- **Per-operator docs:** [DocumentDB Operators](https://learn.microsoft.com/en-us/azure/documentdb/operators/) — individual pages with descriptions and syntax for each operator.
+- **Source repository:** [MicrosoftDocs/azure-databases-docs](https://github.com/MicrosoftDocs/azure-databases-docs) — the GitHub repo containing the raw Markdown source for all documentation pages above (under `articles/documentdb/`).
+
+### Scraper
+
+The operator data is sourced from the official DocumentDB documentation. To re-scrape:
+
+```bash
+npm run scrape --workspace=@documentdb-js/operator-registry
+```
+
+The scraper:
+
+1. **Verifies** upstream doc structure (early fail-fast)
+2. **Extracts** all operators from the [compatibility page](https://learn.microsoft.com/en-us/azure/documentdb/compatibility-query-language)
+3. **Fetches** per-operator documentation (descriptions, syntax) with a global file index fallback for operators filed in unexpected directories
+4. **Generates** `resources/scraped/operator-reference.md` in a structured heading format (`### $operator` with description, syntax, and doc link)
+
+The dump serves as the authoritative reference for the TypeScript implementation. A Jest test (`src/operatorReference.test.ts`) validates that the implementation matches the dump.
+
+## Structure
+
+| File                                        | Purpose                                      |
+| ------------------------------------------- | -------------------------------------------- |
+| `src/types.ts`                              | `OperatorEntry` interface and `MetaTag` type |
+| `src/metaTags.ts`                           | Meta tag constants and completion presets    |
+| `src/docLinks.ts`                           | Documentation URL generation                 |
+| `src/getFilteredCompletions.ts`             | Primary consumer API: filter by meta tags    |
+| `src/index.ts`                              | Barrel exports for all public API            |
+| `resources/scraped/operator-reference.md`   | Auto-generated scraped operator dump         |
+| `resources/overrides/operator-overrides.md` | Hand-maintained overrides                    |
+| `resources/overrides/operator-snippets.md`  | Snippet templates per category               |
+| `scripts/scrape-operator-docs.ts`           | Scraper script                               |
+
+## Origin
+
+This package was developed while building features for the [DocumentDB VS Code extension](https://github.com/microsoft/vscode-documentdb), which remains the primary consumer. The package is designed to be useful in any tooling that needs structured DocumentDB operator metadata.
+
+## License
+
+[MIT](LICENSE.md)

package/dist/accumulators.d.ts

@@ -0,0 +1,2 @@
+export declare function loadAccumulators(): void;
+//# sourceMappingURL=accumulators.d.ts.map

package/dist/accumulators.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"accumulators.d.ts","sourceRoot":"","sources":["../src/accumulators.ts"],"names":[],"mappings":"AAuLA,wBAAgB,gBAAgB,IAAI,IAAI,CAEvC"}

package/dist/accumulators.js

@@ -0,0 +1,177 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadAccumulators = loadAccumulators;
+// AUTO-GENERATED — DO NOT EDIT BY HAND
+//
+// Generated by: npm run generate  (scripts/generate-from-reference.ts)
+// Sources:      resources/scraped/operator-reference.md
+//               resources/overrides/operator-overrides.md
+//               resources/overrides/operator-snippets.md
+//
+// To change operator data, edit the overrides/snippets files and re-run the generator.
+const docLinks_1 = require("./docLinks");
+const getFilteredCompletions_1 = require("./getFilteredCompletions");
+const metaTags_1 = require("./metaTags");
+// ---------------------------------------------------------------------------
+// Accumulators ($group, $bucket, $bucketAuto, $setWindowFields)
+// ---------------------------------------------------------------------------
+const groupAccumulators = [
+    {
+        value: '$addToSet',
+        meta: metaTags_1.META_ACCUMULATOR,
+        description: "The addToSet operator adds elements to an array if they don't already exist, while ensuring uniqueness of elements within the set.",
+        snippet: '{ $addToSet: "${1:\\$field}" }',
+        link: 'https://learn.microsoft.com/en-us/azure/documentdb/operators/array-update/$addtoset', // inferred from another category
+    },
+    {
+        value: '$avg',
+        meta: metaTags_1.META_ACCUMULATOR,
+        description: 'Computes the average of numeric values for documents in a group, bucket, or window.',
+        snippet: '{ $avg: "${1:\\$field}" }',
+        link: (0, docLinks_1.getDocLink)('$avg', metaTags_1.META_ACCUMULATOR),
+    },
+    {
+        value: '$bottom',
+        meta: metaTags_1.META_ACCUMULATOR,
+        description: "The $bottom operator returns the last document from the query's result set sorted by one or more fields",
+        snippet: '{ $bottom: { sortBy: { ${1:field}: ${2:1} }, output: "${3:\\$field}" } }',
+        link: (0, docLinks_1.getDocLink)('$bottom', metaTags_1.META_ACCUMULATOR),
+    },
+    {
+        value: '$bottomN',
+        meta: metaTags_1.META_ACCUMULATOR,
+        description: 'The $bottomN operator returns the last N documents from the result sorted by one or more fields',
+        snippet: '{ $bottomN: { n: ${1:number}, sortBy: { ${2:field}: ${3:1} }, output: "${4:\\$field}" } }',
+        link: (0, docLinks_1.getDocLink)('$bottomN', metaTags_1.META_ACCUMULATOR),
+    },
+    {
+        value: '$count',
+        meta: metaTags_1.META_ACCUMULATOR,
+        description: 'The `$count` operator is used to count the number of documents that match a query filtering criteria.',
+        snippet: '{ $count: {} }',
+        link: (0, docLinks_1.getDocLink)('$count', metaTags_1.META_ACCUMULATOR),
+    },
+    {
+        value: '$first',
+        meta: metaTags_1.META_ACCUMULATOR,
+        description: "The $first operator returns the first value in a group according to the group's sorting order.",
+        snippet: '{ $first: "${1:\\$field}" }',
+        link: (0, docLinks_1.getDocLink)('$first', metaTags_1.META_ACCUMULATOR),
+    },
+    {
+        value: '$firstN',
+        meta: metaTags_1.META_ACCUMULATOR,
+        description: 'The $firstN operator sorts documents on one or more fields specified by the query and returns the first N document matching the filtering criteria',
+        snippet: '{ $firstN: { input: "${1:\\$field}", n: ${2:number} } }',
+        link: (0, docLinks_1.getDocLink)('$firstN', metaTags_1.META_ACCUMULATOR),
+    },
+    {
+        value: '$last',
+        meta: metaTags_1.META_ACCUMULATOR,
+        description: 'The $last operator returns the last document from the result sorted by one or more fields',
+        snippet: '{ $last: "${1:\\$field}" }',
+        link: (0, docLinks_1.getDocLink)('$last', metaTags_1.META_ACCUMULATOR),
+    },
+    {
+        value: '$lastN',
+        meta: metaTags_1.META_ACCUMULATOR,
+        description: 'The $lastN accumulator operator returns the last N values in a group of documents.',
+        snippet: '{ $lastN: { input: "${1:\\$field}", n: ${2:number} } }',
+        link: (0, docLinks_1.getDocLink)('$lastN', metaTags_1.META_ACCUMULATOR),
+    },
+    {
+        value: '$max',
+        meta: metaTags_1.META_ACCUMULATOR,
+        description: 'The $max operator returns the maximum value from a set of input values.',
+        snippet: '{ $max: "${1:\\$field}" }',
+        link: (0, docLinks_1.getDocLink)('$max', metaTags_1.META_ACCUMULATOR),
+    },
+    {
+        value: '$maxN',
+        meta: metaTags_1.META_ACCUMULATOR,
+        description: 'Retrieves the top N values based on a specified filtering criteria',
+        snippet: '{ $maxN: { input: "${1:\\$field}", n: ${2:number} } }',
+        link: (0, docLinks_1.getDocLink)('$maxN', metaTags_1.META_ACCUMULATOR),
+    },
+    {
+        value: '$median',
+        meta: metaTags_1.META_ACCUMULATOR,
+        description: 'The $median operator calculates the median value of a numeric field in a group of documents.',
+        snippet: '{ $median: { input: "${1:\\$field}", method: "approximate" } }',
+        link: (0, docLinks_1.getDocLink)('$median', metaTags_1.META_ACCUMULATOR),
+    },
+    {
+        value: '$mergeObjects',
+        meta: metaTags_1.META_ACCUMULATOR,
+        description: 'The $mergeObjects operator merges multiple documents into a single document',
+        snippet: '{ $mergeObjects: "${1:\\$field}" }',
+        link: 'https://learn.microsoft.com/en-us/azure/documentdb/operators/object-expression/$mergeobjects', // inferred from another category
+    },
+    {
+        value: '$min',
+        meta: metaTags_1.META_ACCUMULATOR,
+        description: 'Retrieves the minimum value for a specified field',
+        snippet: '{ $min: "${1:\\$field}" }',
+        link: (0, docLinks_1.getDocLink)('$min', metaTags_1.META_ACCUMULATOR),
+    },
+    {
+        value: '$percentile',
+        meta: metaTags_1.META_ACCUMULATOR,
+        description: 'The $percentile operator calculates the percentile of numerical values that match a filtering criteria',
+        snippet: '{ $percentile: { input: "${1:\\$field}", p: [${2:0.5}], method: "approximate" } }',
+        link: (0, docLinks_1.getDocLink)('$percentile', metaTags_1.META_ACCUMULATOR),
+    },
+    {
+        value: '$push',
+        meta: metaTags_1.META_ACCUMULATOR,
+        description: 'The $push operator adds a specified value to an array within a document.',
+        snippet: '{ $push: "${1:\\$field}" }',
+        link: 'https://learn.microsoft.com/en-us/azure/documentdb/operators/array-update/$push', // inferred from another category
+    },
+    {
+        value: '$stdDevPop',
+        meta: metaTags_1.META_ACCUMULATOR,
+        description: 'The $stddevpop operator calculates the standard deviation of the specified values',
+        snippet: '{ $stdDevPop: "${1:\\$field}" }',
+        link: (0, docLinks_1.getDocLink)('$stdDevPop', metaTags_1.META_ACCUMULATOR),
+    },
+    {
+        value: '$stdDevSamp',
+        meta: metaTags_1.META_ACCUMULATOR,
+        description: 'The $stddevsamp operator calculates the standard deviation of a specified sample of values and not the entire population',
+        snippet: '{ $stdDevSamp: "${1:\\$field}" }',
+        link: (0, docLinks_1.getDocLink)('$stdDevSamp', metaTags_1.META_ACCUMULATOR),
+    },
+    {
+        value: '$sum',
+        meta: metaTags_1.META_ACCUMULATOR,
+        description: 'The $sum operator calculates the sum of the values of a field based on a filtering criteria',
+        snippet: '{ $sum: "${1:\\$field}" }',
+        link: (0, docLinks_1.getDocLink)('$sum', metaTags_1.META_ACCUMULATOR),
+    },
+    {
+        value: '$top',
+        meta: metaTags_1.META_ACCUMULATOR,
+        description: 'The $top operator returns the first document from the result set sorted by one or more fields',
+        snippet: '{ $top: { sortBy: { ${1:field}: ${2:1} }, output: "${3:\\$field}" } }',
+        link: (0, docLinks_1.getDocLink)('$top', metaTags_1.META_ACCUMULATOR),
+    },
+    {
+        value: '$topN',
+        meta: metaTags_1.META_ACCUMULATOR,
+        description: 'The $topN operator returns the first N documents from the result sorted by one or more fields',
+        snippet: '{ $topN: { n: ${1:number}, sortBy: { ${2:field}: ${3:1} }, output: "${4:\\$field}" } }',
+        link: (0, docLinks_1.getDocLink)('$topN', metaTags_1.META_ACCUMULATOR),
+    },
+];
+// ---------------------------------------------------------------------------
+// Registration
+// ---------------------------------------------------------------------------
+function loadAccumulators() {
+    (0, getFilteredCompletions_1.registerOperators)([...groupAccumulators]);
+}
+//# sourceMappingURL=accumulators.js.map

package/dist/accumulators.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"accumulators.js","sourceRoot":"","sources":["../src/accumulators.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;AAoLhG,4CAEC;AApLD,uCAAuC;AACvC,EAAE;AACF,uEAAuE;AACvE,wDAAwD;AACxD,0DAA0D;AAC1D,yDAAyD;AACzD,EAAE;AACF,uFAAuF;AAEvF,yCAAwC;AACxC,qEAA6D;AAC7D,yCAA8C;AAG9C,8EAA8E;AAC9E,gEAAgE;AAChE,8EAA8E;AAE9E,MAAM,iBAAiB,GAA6B;IAChD;QACI,KAAK,EAAE,WAAW;QAClB,IAAI,EAAE,2BAAgB;QACtB,WAAW,EACP,oIAAoI;QACxI,OAAO,EAAE,gCAAgC;QACzC,IAAI,EAAE,qFAAqF,EAAE,iCAAiC;KACjI;IACD;QACI,KAAK,EAAE,MAAM;QACb,IAAI,EAAE,2BAAgB;QACtB,WAAW,EAAE,qFAAqF;QAClG,OAAO,EAAE,2BAA2B;QACpC,IAAI,EAAE,IAAA,qBAAU,EAAC,MAAM,EAAE,2BAAgB,CAAC;KAC7C;IACD;QACI,KAAK,EAAE,SAAS;QAChB,IAAI,EAAE,2BAAgB;QACtB,WAAW,EACP,yGAAyG;QAC7G,OAAO,EAAE,0EAA0E;QACnF,IAAI,EAAE,IAAA,qBAAU,EAAC,SAAS,EAAE,2BAAgB,CAAC;KAChD;IACD;QACI,KAAK,EAAE,UAAU;QACjB,IAAI,EAAE,2BAAgB;QACtB,WAAW,EAAE,iGAAiG;QAC9G,OAAO,EAAE,2FAA2F;QACpG,IAAI,EAAE,IAAA,qBAAU,EAAC,UAAU,EAAE,2BAAgB,CAAC;KACjD;IACD;QACI,KAAK,EAAE,QAAQ;QACf,IAAI,EAAE,2BAAgB;QACtB,WAAW,EACP,uGAAuG;QAC3G,OAAO,EAAE,gBAAgB;QACzB,IAAI,EAAE,IAAA,qBAAU,EAAC,QAAQ,EAAE,2BAAgB,CAAC;KAC/C;IACD;QACI,KAAK,EAAE,QAAQ;QACf,IAAI,EAAE,2BAAgB;QACtB,WAAW,EAAE,gGAAgG;QAC7G,OAAO,EAAE,6BAA6B;QACtC,IAAI,EAAE,IAAA,qBAAU,EAAC,QAAQ,EAAE,2BAAgB,CAAC;KAC/C;IACD;QACI,KAAK,EAAE,SAAS;QAChB,IAAI,EAAE,2BAAgB;QACtB,WAAW,EACP,oJAAoJ;QACxJ,OAAO,EAAE,yDAAyD;QAClE,IAAI,EAAE,IAAA,qBAAU,EAAC,SAAS,EAAE,2BAAgB,CAAC;KAChD;IACD;QACI,KAAK,EAAE,OAAO;QACd,IAAI,EAAE,2BAAgB;QACtB,WAAW,EAAE,2FAA2F;QACxG,OAAO,EAAE,4BAA4B;QACrC,IAAI,EAAE,IAAA,qBAAU,EAAC,OAAO,EAAE,2BAAgB,CAAC;KAC9C;IACD;QACI,KAAK,EAAE,QAAQ;QACf,IAAI,EAAE,2BAAgB;QACtB,WAAW,EAAE,oFAAoF;QACjG,OAAO,EAAE,wDAAwD;QACjE,IAAI,EAAE,IAAA,qBAAU,EAAC,QAAQ,EAAE,2BAAgB,CAAC;KAC/C;IACD;QACI,KAAK,EAAE,MAAM;QACb,IAAI,EAAE,2BAAgB;QACtB,WAAW,EAAE,yEAAyE;QACtF,OAAO,EAAE,2BAA2B;QACpC,IAAI,EAAE,IAAA,qBAAU,EAAC,MAAM,EAAE,2BAAgB,CAAC;KAC7C;IACD;QACI,KAAK,EAAE,OAAO;QACd,IAAI,EAAE,2BAAgB;QACtB,WAAW,EAAE,oEAAoE;QACjF,OAAO,EAAE,uDAAuD;QAChE,IAAI,EAAE,IAAA,qBAAU,EAAC,OAAO,EAAE,2BAAgB,CAAC;KAC9C;IACD;QACI,KAAK,EAAE,SAAS;QAChB,IAAI,EAAE,2BAAgB;QACtB,WAAW,EAAE,8FAA8F;QAC3G,OAAO,EAAE,gEAAgE;QACzE,IAAI,EAAE,IAAA,qBAAU,EAAC,SAAS,EAAE,2BAAgB,CAAC;KAChD;IACD;QACI,KAAK,EAAE,eAAe;QACtB,IAAI,EAAE,2BAAgB;QACtB,WAAW,EAAE,6EAA6E;QAC1F,OAAO,EAAE,oCAAoC;QAC7C,IAAI,EAAE,8FAA8F,EAAE,iCAAiC;KAC1I;IACD;QACI,KAAK,EAAE,MAAM;QACb,IAAI,EAAE,2BAAgB;QACtB,WAAW,EAAE,mDAAmD;QAChE,OAAO,EAAE,2BAA2B;QACpC,IAAI,EAAE,IAAA,qBAAU,EAAC,MAAM,EAAE,2BAAgB,CAAC;KAC7C;IACD;QACI,KAAK,EAAE,aAAa;QACpB,IAAI,EAAE,2BAAgB;QACtB,WAAW,EACP,wGAAwG;QAC5G,OAAO,EAAE,mFAAmF;QAC5F,IAAI,EAAE,IAAA,qBAAU,EAAC,aAAa,EAAE,2BAAgB,CAAC;KACpD;IACD;QACI,KAAK,EAAE,OAAO;QACd,IAAI,EAAE,2BAAgB;QACtB,WAAW,EAAE,0EAA0E;QACvF,OAAO,EAAE,4BAA4B;QACrC,IAAI,EAAE,iFAAiF,EAAE,iCAAiC;KAC7H;IACD;QACI,KAAK,EAAE,YAAY;QACnB,IAAI,EAAE,2BAAgB;QACtB,WAAW,EAAE,mFAAmF;QAChG,OAAO,EAAE,iCAAiC;QAC1C,IAAI,EAAE,IAAA,qBAAU,EAAC,YAAY,EAAE,2BAAgB,CAAC;KACnD;IACD;QACI,KAAK,EAAE,aAAa;QACpB,IAAI,EAAE,2BAAgB;QACtB,WAAW,EACP,0HAA0H;QAC9H,OAAO,EAAE,kCAAkC;QAC3C,IAAI,EAAE,IAAA,qBAAU,EAAC,aAAa,EAAE,2BAAgB,CAAC;KACpD;IACD;QACI,KAAK,EAAE,MAAM;QACb,IAAI,EAAE,2BAAgB;QACtB,WAAW,EAAE,6FAA6F;QAC1G,OAAO,EAAE,2BAA2B;QACpC,IAAI,EAAE,IAAA,qBAAU,EAAC,MAAM,EAAE,2BAAgB,CAAC;KAC7C;IACD;QACI,KAAK,EAAE,MAAM;QACb,IAAI,EAAE,2BAAgB;QACtB,WAAW,EAAE,+FAA+F;QAC5G,OAAO,EAAE,uEAAuE;QAChF,IAAI,EAAE,IAAA,qBAAU,EAAC,MAAM,EAAE,2BAAgB,CAAC;KAC7C;IACD;QACI,KAAK,EAAE,OAAO;QACd,IAAI,EAAE,2BAAgB;QACtB,WAAW,EAAE,+FAA+F;QAC5G,OAAO,EAAE,wFAAwF;QACjG,IAAI,EAAE,IAAA,qBAAU,EAAC,OAAO,EAAE,2BAAgB,CAAC;KAC9C;CACJ,CAAC;AAEF,8EAA8E;AAC9E,eAAe;AACf,8EAA8E;AAE9E,SAAgB,gBAAgB;IAC5B,IAAA,0CAAiB,EAAC,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC;AAC9C,CAAC"}

package/dist/bsonConstructors.d.ts

@@ -0,0 +1,2 @@
+export declare function loadBsonConstructors(): void;
+//# sourceMappingURL=bsonConstructors.d.ts.map

package/dist/bsonConstructors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bsonConstructors.d.ts","sourceRoot":"","sources":["../src/bsonConstructors.ts"],"names":[],"mappings":"AAgFA,wBAAgB,oBAAoB,IAAI,IAAI,CAE3C"}

package/dist/bsonConstructors.js

@@ -0,0 +1,81 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadBsonConstructors = loadBsonConstructors;
+const getFilteredCompletions_1 = require("./getFilteredCompletions");
+const metaTags_1 = require("./metaTags");
+// ---------------------------------------------------------------------------
+// BSON Constructor Functions
+// ---------------------------------------------------------------------------
+const bsonConstructors = [
+    {
+        value: 'ObjectId',
+        meta: metaTags_1.META_BSON,
+        description: 'Creates a new ObjectId value, a 12-byte unique identifier.',
+        snippet: 'ObjectId("${1:hex}")',
+    },
+    {
+        value: 'ISODate',
+        meta: metaTags_1.META_BSON,
+        description: 'Creates a date object from an ISO 8601 date string.',
+        snippet: 'ISODate("${1:2025-01-01T00:00:00Z}")',
+    },
+    {
+        value: 'NumberLong',
+        meta: metaTags_1.META_BSON,
+        description: 'Creates a 64-bit integer (long) value.',
+        snippet: 'NumberLong(${1:value})',
+    },
+    {
+        value: 'NumberInt',
+        meta: metaTags_1.META_BSON,
+        description: 'Creates a 32-bit integer value.',
+        snippet: 'NumberInt(${1:value})',
+    },
+    {
+        value: 'NumberDecimal',
+        meta: metaTags_1.META_BSON,
+        description: 'Creates a 128-bit decimal value for high-precision calculations.',
+        snippet: 'NumberDecimal("${1:value}")',
+    },
+    {
+        value: 'BinData',
+        meta: metaTags_1.META_BSON,
+        description: 'Creates a binary data value with a specified subtype.',
+        snippet: 'BinData(${1:subtype}, "${2:base64}")',
+    },
+    {
+        value: 'UUID',
+        meta: metaTags_1.META_BSON,
+        description: 'Creates a UUID (Universally Unique Identifier) value.',
+        snippet: 'UUID("${1:uuid}")',
+    },
+    {
+        value: 'Timestamp',
+        meta: metaTags_1.META_BSON,
+        description: 'Creates a BSON timestamp value for internal replication use.',
+        snippet: 'Timestamp(${1:seconds}, ${2:increment})',
+    },
+    {
+        value: 'MinKey',
+        meta: metaTags_1.META_BSON,
+        description: 'Represents the lowest possible BSON value, comparing less than all other types.',
+        snippet: 'MinKey()',
+    },
+    {
+        value: 'MaxKey',
+        meta: metaTags_1.META_BSON,
+        description: 'Represents the highest possible BSON value, comparing greater than all other types.',
+        snippet: 'MaxKey()',
+    },
+];
+// ---------------------------------------------------------------------------
+// Registration
+// ---------------------------------------------------------------------------
+function loadBsonConstructors() {
+    (0, getFilteredCompletions_1.registerOperators)(bsonConstructors);
+}
+//# sourceMappingURL=bsonConstructors.js.map

package/dist/bsonConstructors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bsonConstructors.js","sourceRoot":"","sources":["../src/bsonConstructors.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;AA6EhG,oDAEC;AA7ED,qEAA6D;AAC7D,yCAAuC;AAGvC,8EAA8E;AAC9E,6BAA6B;AAC7B,8EAA8E;AAE9E,MAAM,gBAAgB,GAA6B;IAC/C;QACI,KAAK,EAAE,UAAU;QACjB,IAAI,EAAE,oBAAS;QACf,WAAW,EAAE,4DAA4D;QACzE,OAAO,EAAE,sBAAsB;KAClC;IACD;QACI,KAAK,EAAE,SAAS;QAChB,IAAI,EAAE,oBAAS;QACf,WAAW,EAAE,qDAAqD;QAClE,OAAO,EAAE,sCAAsC;KAClD;IACD;QACI,KAAK,EAAE,YAAY;QACnB,IAAI,EAAE,oBAAS;QACf,WAAW,EAAE,wCAAwC;QACrD,OAAO,EAAE,wBAAwB;KACpC;IACD;QACI,KAAK,EAAE,WAAW;QAClB,IAAI,EAAE,oBAAS;QACf,WAAW,EAAE,iCAAiC;QAC9C,OAAO,EAAE,uBAAuB;KACnC;IACD;QACI,KAAK,EAAE,eAAe;QACtB,IAAI,EAAE,oBAAS;QACf,WAAW,EAAE,kEAAkE;QAC/E,OAAO,EAAE,6BAA6B;KACzC;IACD;QACI,KAAK,EAAE,SAAS;QAChB,IAAI,EAAE,oBAAS;QACf,WAAW,EAAE,uDAAuD;QACpE,OAAO,EAAE,sCAAsC;KAClD;IACD;QACI,KAAK,EAAE,MAAM;QACb,IAAI,EAAE,oBAAS;QACf,WAAW,EAAE,uDAAuD;QACpE,OAAO,EAAE,mBAAmB;KAC/B;IACD;QACI,KAAK,EAAE,WAAW;QAClB,IAAI,EAAE,oBAAS;QACf,WAAW,EAAE,8DAA8D;QAC3E,OAAO,EAAE,yCAAyC;KACrD;IACD;QACI,KAAK,EAAE,QAAQ;QACf,IAAI,EAAE,oBAAS;QACf,WAAW,EAAE,iFAAiF;QAC9F,OAAO,EAAE,UAAU;KACtB;IACD;QACI,KAAK,EAAE,QAAQ;QACf,IAAI,EAAE,oBAAS;QACf,WAAW,EAAE,qFAAqF;QAClG,OAAO,EAAE,UAAU;KACtB;CACJ,CAAC;AAEF,8EAA8E;AAC9E,eAAe;AACf,8EAA8E;AAE9E,SAAgB,oBAAoB;IAChC,IAAA,0CAAiB,EAAC,gBAAgB,CAAC,CAAC;AACxC,CAAC"}

package/dist/docLinks.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Generates a documentation URL for a DocumentDB operator.
+ *
+ * @param operatorValue - the operator name, e.g. "$bucket", "$gt"
+ * @param meta - the meta tag, e.g. "stage", "query:comparison"
+ * @returns URL string or undefined if no mapping exists for the meta tag
+ */
+export declare function getDocLink(operatorValue: string, meta: string): string | undefined;
+/**
+ * Returns the base URL for the DocumentDB operators documentation.
+ */
+export declare function getDocBase(): string;
+//# sourceMappingURL=docLinks.d.ts.map

package/dist/docLinks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"docLinks.d.ts","sourceRoot":"","sources":["../src/docLinks.ts"],"names":[],"mappings":"AAqDA;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,aAAa,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CASlF;AAED;;GAEG;AACH,wBAAgB,UAAU,IAAI,MAAM,CAEnC"}

package/dist/docLinks.js

@@ -0,0 +1,76 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDocLink = getDocLink;
+exports.getDocBase = getDocBase;
+/**
+ * URL generation helpers for DocumentDB documentation pages.
+ *
+ * Each operator has a documentation page at:
+ *   https://learn.microsoft.com/en-us/azure/documentdb/operators/{category}/{operatorName}
+ */
+const DOC_BASE = 'https://learn.microsoft.com/en-us/azure/documentdb/operators';
+/**
+ * Maps meta tag prefixes to the docs directory name used in the
+ * DocumentDB documentation URL path.
+ */
+const META_TO_DOC_DIR = {
+    'query:comparison': 'comparison-query',
+    'query:logical': 'logical-query',
+    'query:element': 'element-query',
+    'query:evaluation': 'evaluation-query',
+    'query:array': 'array-query',
+    'query:bitwise': 'bitwise-query',
+    'query:geospatial': 'geospatial',
+    'query:projection': 'projection',
+    'query:misc': 'miscellaneous-query',
+    'update:field': 'field-update',
+    'update:array': 'array-update',
+    'update:bitwise': 'bitwise-update',
+    stage: 'aggregation',
+    accumulator: 'accumulators',
+    'expr:arith': 'arithmetic-expression',
+    'expr:array': 'array-expression',
+    'expr:bool': 'boolean-expression',
+    'expr:comparison': 'comparison-expression',
+    'expr:conditional': 'conditional-expression',
+    'expr:date': 'date-expression',
+    'expr:object': 'object-expression',
+    'expr:set': 'set-expression',
+    'expr:string': 'string-expression',
+    'expr:trig': 'trigonometry-expression',
+    'expr:type': 'aggregation/type-expression',
+    'expr:datasize': 'data-size',
+    'expr:timestamp': 'timestamp-expression',
+    'expr:bitwise': 'bitwise',
+    'expr:literal': 'literal-expression',
+    'expr:misc': 'miscellaneous',
+    'expr:variable': 'variable-expression',
+    window: 'window-operators',
+};
+/**
+ * Generates a documentation URL for a DocumentDB operator.
+ *
+ * @param operatorValue - the operator name, e.g. "$bucket", "$gt"
+ * @param meta - the meta tag, e.g. "stage", "query:comparison"
+ * @returns URL string or undefined if no mapping exists for the meta tag
+ */
+function getDocLink(operatorValue, meta) {
+    const dir = META_TO_DOC_DIR[meta];
+    if (!dir) {
+        return undefined;
+    }
+    // Operator names in URLs keep their $ prefix and are lowercased
+    const name = operatorValue.toLowerCase();
+    return `${DOC_BASE}/${dir}/${name}`;
+}
+/**
+ * Returns the base URL for the DocumentDB operators documentation.
+ */
+function getDocBase() {
+    return DOC_BASE;
+}
+//# sourceMappingURL=docLinks.js.map

package/dist/docLinks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"docLinks.js","sourceRoot":"","sources":["../src/docLinks.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;AAyDhG,gCASC;AAKD,gCAEC;AAvED;;;;;GAKG;AAEH,MAAM,QAAQ,GAAG,8DAA8D,CAAC;AAEhF;;;GAGG;AACH,MAAM,eAAe,GAA2B;IAC5C,kBAAkB,EAAE,kBAAkB;IACtC,eAAe,EAAE,eAAe;IAChC,eAAe,EAAE,eAAe;IAChC,kBAAkB,EAAE,kBAAkB;IACtC,aAAa,EAAE,aAAa;IAC5B,eAAe,EAAE,eAAe;IAChC,kBAAkB,EAAE,YAAY;IAChC,kBAAkB,EAAE,YAAY;IAChC,YAAY,EAAE,qBAAqB;IACnC,cAAc,EAAE,cAAc;IAC9B,cAAc,EAAE,cAAc;IAC9B,gBAAgB,EAAE,gBAAgB;IAClC,KAAK,EAAE,aAAa;IACpB,WAAW,EAAE,cAAc;IAC3B,YAAY,EAAE,uBAAuB;IACrC,YAAY,EAAE,kBAAkB;IAChC,WAAW,EAAE,oBAAoB;IACjC,iBAAiB,EAAE,uBAAuB;IAC1C,kBAAkB,EAAE,wBAAwB;IAC5C,WAAW,EAAE,iBAAiB;IAC9B,aAAa,EAAE,mBAAmB;IAClC,UAAU,EAAE,gBAAgB;IAC5B,aAAa,EAAE,mBAAmB;IAClC,WAAW,EAAE,yBAAyB;IACtC,WAAW,EAAE,6BAA6B;IAC1C,eAAe,EAAE,WAAW;IAC5B,gBAAgB,EAAE,sBAAsB;IACxC,cAAc,EAAE,SAAS;IACzB,cAAc,EAAE,oBAAoB;IACpC,WAAW,EAAE,eAAe;IAC5B,eAAe,EAAE,qBAAqB;IACtC,MAAM,EAAE,kBAAkB;CAC7B,CAAC;AAEF;;;;;;GAMG;AACH,SAAgB,UAAU,CAAC,aAAqB,EAAE,IAAY;IAC1D,MAAM,GAAG,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;IAClC,IAAI,CAAC,GAAG,EAAE,CAAC;QACP,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,gEAAgE;IAChE,MAAM,IAAI,GAAG,aAAa,CAAC,WAAW,EAAE,CAAC;IACzC,OAAO,GAAG,QAAQ,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;AACxC,CAAC;AAED;;GAEG;AACH,SAAgB,UAAU;IACtB,OAAO,QAAQ,CAAC;AACpB,CAAC"}

package/dist/docLinks.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=docLinks.test.d.ts.map

package/dist/docLinks.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"docLinks.test.d.ts","sourceRoot":"","sources":["../src/docLinks.test.ts"],"names":[],"mappings":""}

package/dist/docLinks.test.js

@@ -0,0 +1,67 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Unit tests for docLinks.ts — URL generation for DocumentDB operator docs.
+ */
+const index_1 = require("./index");
+describe('docLinks', () => {
+    test('getDocBase returns the expected base URL', () => {
+        expect((0, index_1.getDocBase)()).toBe('https://learn.microsoft.com/en-us/azure/documentdb/operators');
+    });
+    describe('getDocLink', () => {
+        test('generates correct URL for comparison query operator', () => {
+            const link = (0, index_1.getDocLink)('$eq', 'query:comparison');
+            expect(link).toBe('https://learn.microsoft.com/en-us/azure/documentdb/operators/comparison-query/$eq');
+        });
+        test('generates correct URL for aggregation stage', () => {
+            const link = (0, index_1.getDocLink)('$match', 'stage');
+            expect(link).toBe('https://learn.microsoft.com/en-us/azure/documentdb/operators/aggregation/$match');
+        });
+        test('generates correct URL for accumulator', () => {
+            const link = (0, index_1.getDocLink)('$sum', 'accumulator');
+            expect(link).toBe('https://learn.microsoft.com/en-us/azure/documentdb/operators/accumulators/$sum');
+        });
+        test('generates correct URL for field update operator', () => {
+            const link = (0, index_1.getDocLink)('$set', 'update:field');
+            expect(link).toBe('https://learn.microsoft.com/en-us/azure/documentdb/operators/field-update/$set');
+        });
+        test('generates correct URL for array expression operator', () => {
+            const link = (0, index_1.getDocLink)('$filter', 'expr:array');
+            expect(link).toBe('https://learn.microsoft.com/en-us/azure/documentdb/operators/array-expression/$filter');
+        });
+        test('generates correct URL for type expression operator (nested dir)', () => {
+            const link = (0, index_1.getDocLink)('$convert', 'expr:type');
+            expect(link).toBe('https://learn.microsoft.com/en-us/azure/documentdb/operators/aggregation/type-expression/$convert');
+        });
+        test('generates correct URL for window operator', () => {
+            const link = (0, index_1.getDocLink)('$rank', 'window');
+            expect(link).toBe('https://learn.microsoft.com/en-us/azure/documentdb/operators/window-operators/$rank');
+        });
+        test('lowercases operator names in URLs', () => {
+            const link = (0, index_1.getDocLink)('$AddFields', 'stage');
+            expect(link).toBe('https://learn.microsoft.com/en-us/azure/documentdb/operators/aggregation/$addfields');
+        });
+        test('returns undefined for unknown meta tag', () => {
+            expect((0, index_1.getDocLink)('$eq', 'unknown:tag')).toBeUndefined();
+        });
+        test('returns undefined for BSON meta tag (no docs directory)', () => {
+            expect((0, index_1.getDocLink)('ObjectId', 'bson')).toBeUndefined();
+        });
+        test('returns undefined for variable meta tag (no docs directory)', () => {
+            expect((0, index_1.getDocLink)('$$NOW', 'variable')).toBeUndefined();
+        });
+        test('generates correct URL for boolean expression operator', () => {
+            const link = (0, index_1.getDocLink)('$and', 'expr:bool');
+            expect(link).toBe('https://learn.microsoft.com/en-us/azure/documentdb/operators/boolean-expression/$and');
+        });
+        test('generates correct URL for comparison expression operator', () => {
+            const link = (0, index_1.getDocLink)('$eq', 'expr:comparison');
+            expect(link).toBe('https://learn.microsoft.com/en-us/azure/documentdb/operators/comparison-expression/$eq');
+        });
+    });
+});
+//# sourceMappingURL=docLinks.test.js.map

package/dist/docLinks.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"docLinks.test.js","sourceRoot":"","sources":["../src/docLinks.test.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;AAEhG;;GAEG;AAEH,mCAAiD;AAEjD,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;IACtB,IAAI,CAAC,0CAA0C,EAAE,GAAG,EAAE;QAClD,MAAM,CAAC,IAAA,kBAAU,GAAE,CAAC,CAAC,IAAI,CAAC,8DAA8D,CAAC,CAAC;IAC9F,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;QACxB,IAAI,CAAC,qDAAqD,EAAE,GAAG,EAAE;YAC7D,MAAM,IAAI,GAAG,IAAA,kBAAU,EAAC,KAAK,EAAE,kBAAkB,CAAC,CAAC;YACnD,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,mFAAmF,CAAC,CAAC;QAC3G,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,6CAA6C,EAAE,GAAG,EAAE;YACrD,MAAM,IAAI,GAAG,IAAA,kBAAU,EAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YAC3C,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,iFAAiF,CAAC,CAAC;QACzG,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,uCAAuC,EAAE,GAAG,EAAE;YAC/C,MAAM,IAAI,GAAG,IAAA,kBAAU,EAAC,MAAM,EAAE,aAAa,CAAC,CAAC;YAC/C,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,gFAAgF,CAAC,CAAC;QACxG,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,iDAAiD,EAAE,GAAG,EAAE;YACzD,MAAM,IAAI,GAAG,IAAA,kBAAU,EAAC,MAAM,EAAE,cAAc,CAAC,CAAC;YAChD,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,gFAAgF,CAAC,CAAC;QACxG,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,qDAAqD,EAAE,GAAG,EAAE;YAC7D,MAAM,IAAI,GAAG,IAAA,kBAAU,EAAC,SAAS,EAAE,YAAY,CAAC,CAAC;YACjD,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,uFAAuF,CAAC,CAAC;QAC/G,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,iEAAiE,EAAE,GAAG,EAAE;YACzE,MAAM,IAAI,GAAG,IAAA,kBAAU,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC;YACjD,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CACb,mGAAmG,CACtG,CAAC;QACN,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,2CAA2C,EAAE,GAAG,EAAE;YACnD,MAAM,IAAI,GAAG,IAAA,kBAAU,EAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;YAC3C,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,qFAAqF,CAAC,CAAC;QAC7G,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,mCAAmC,EAAE,GAAG,EAAE;YAC3C,MAAM,IAAI,GAAG,IAAA,kBAAU,EAAC,YAAY,EAAE,OAAO,CAAC,CAAC;YAC/C,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,qFAAqF,CAAC,CAAC;QAC7G,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,wCAAwC,EAAE,GAAG,EAAE;YAChD,MAAM,CAAC,IAAA,kBAAU,EAAC,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;QAC7D,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,yDAAyD,EAAE,GAAG,EAAE;YACjE,MAAM,CAAC,IAAA,kBAAU,EAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;QAC3D,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,6DAA6D,EAAE,GAAG,EAAE;YACrE,MAAM,CAAC,IAAA,kBAAU,EAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;QAC5D,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,uDAAuD,EAAE,GAAG,EAAE;YAC/D,MAAM,IAAI,GAAG,IAAA,kBAAU,EAAC,MAAM,EAAE,WAAW,CAAC,CAAC;YAC7C,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,sFAAsF,CAAC,CAAC;QAC9G,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,0DAA0D,EAAE,GAAG,EAAE;YAClE,MAAM,IAAI,GAAG,IAAA,kBAAU,EAAC,KAAK,EAAE,iBAAiB,CAAC,CAAC;YAClD,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,wFAAwF,CAAC,CAAC;QAChH,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/dist/expressionOperators.d.ts

@@ -0,0 +1,2 @@
+export declare function loadExpressionOperators(): void;
+//# sourceMappingURL=expressionOperators.d.ts.map

package/dist/expressionOperators.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"expressionOperators.d.ts","sourceRoot":"","sources":["../src/expressionOperators.ts"],"names":[],"mappings":"AAwoCA,wBAAgB,uBAAuB,IAAI,IAAI,CAoB9C"}