@documentdb-js/shell-api-types 0.8.0

package/dist/types.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Shell API method entry describing a single method available on a
+ * DocumentDB shell object (database, collection, or cursor).
+ */
+export interface ShellMethodEntry {
+    /** The method name as it appears in code (e.g., 'find', 'insertOne'). */
+    readonly name: string;
+    /** The shell object this method belongs to. */
+    readonly target: 'database' | 'collection' | 'findCursor' | 'aggregationCursor' | 'global';
+    /** The underlying server command(s) this method maps to. */
+    readonly serverCommands: readonly string[];
+    /**
+     * Whether this method is shell-only (no direct server command).
+     * Shell-only methods are utility functions that don't send a command
+     * to the server (e.g., cursor iteration helpers, display functions).
+     */
+    readonly shellOnly: boolean;
+    /** Brief description of what the method does. */
+    readonly description: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAKA;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC7B,yEAAyE;IACzE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,+CAA+C;IAC/C,QAAQ,CAAC,MAAM,EAAE,UAAU,GAAG,YAAY,GAAG,YAAY,GAAG,mBAAmB,GAAG,QAAQ,CAAC;IAC3F,4DAA4D;IAC5D,QAAQ,CAAC,cAAc,EAAE,SAAS,MAAM,EAAE,CAAC;IAC3C;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,iDAAiD;IACjD,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAChC"}

package/dist/types.js

@@ -0,0 +1,7 @@
+"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 });
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";AAAA;;;gGAGgG"}

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@documentdb-js/shell-api-types",
+  "version": "0.8.0",
+  "description": "TypeScript type definitions and method-to-command registry for the DocumentDB shell API",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "typeDefs"
+  ],
+  "scripts": {
+    "build": "tsc -p . && tsc -p tsconfig.scripts.json --noEmit",
+    "clean": "rimraf dist tsconfig.tsbuildinfo",
+    "test": "jest --config jest.config.js",
+    "prettier-fix": "prettier -w \"(scripts|src)/**/*.@(js|ts|jsx|tsx|json|md)\" \"./*.@(js|ts|jsx|tsx|json|md)\"",
+    "verify": "ts-node scripts/verify-compatibility.ts"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/microsoft/vscode-documentdb",
+    "directory": "packages/documentdb-js-shell-api-types"
+  },
+  "license": "MIT"
+}

package/typeDefs/README.md

@@ -0,0 +1,62 @@
+# DocumentDB Shell API Type Definitions
+
+## About this file
+
+`documentdb-shell-api.d.ts` provides TypeScript type definitions for the
+DocumentDB query playground IntelliSense experience. It declares the shell API surface
+available in `.documentdb.js` query playground files, enabling autocompletion, hover
+documentation, and signature help via VS Code's built-in TypeScript language
+service.
+
+## How the API surface was determined
+
+DocumentDB uses the MongoDB wire protocol for compatibility. As stated in the
+[official compatibility documentation](https://learn.microsoft.com/en-us/azure/documentdb/compatibility-query-language):
+
+> "Client-side wrapper functions, such as `deleteMany()` and `updateMany()`,
+> internally invoke the corresponding server commands (`delete()` and
+> `update()`). Any function that relies on supported server commands is
+> compatible with Azure DocumentDB."
+
+The methods included in this file were **manually selected** to provide a
+productive query playground editing experience. The selection criteria:
+
+1. **Server command support**: Each method maps to a server-side command listed
+   as supported (✅) in the DocumentDB compatibility matrix. For example,
+   `collection.find()` maps to the `find` command, `collection.insertOne()` maps
+   to `insert`, `collection.updateOne()` maps to `update`, etc.
+
+2. **Common usage patterns**: Methods were chosen based on the most common
+   operations users perform in the query playground environment — querying,
+   inserting, updating, deleting, indexing, and aggregation.
+
+3. **Deliberately excluded**: Methods that map to unsupported or not-applicable
+   server commands were omitted. For instance, `mapReduce()` (deprecated),
+   replication commands, and certain sharding operations that are managed by the
+   Azure platform are not included.
+
+## Reference documentation
+
+The following DocumentDB compatibility pages were used as the source of
+truth for determining supported operations:
+
+- **MQL compatibility (operators, commands, indexes)**:
+  https://learn.microsoft.com/en-us/azure/documentdb/compatibility-query-language
+- **Feature compatibility**:
+  https://learn.microsoft.com/en-us/azure/documentdb/compatibility-features
+- **MQL commands reference**:
+  https://learn.microsoft.com/en-us/azure/documentdb/commands/
+- **MQL operators reference**:
+  https://learn.microsoft.com/en-us/azure/documentdb/operators/
+
+## JSDoc content
+
+All JSDoc descriptions in the `.d.ts` file are **original writing** authored for
+this extension. They describe the same operations using our own wording and
+DocumentDB terminology.
+
+## Maintenance
+
+When DocumentDB adds support for new operations or deprecates existing
+ones, this file should be updated to match. Refer to the compatibility pages
+listed above for the current support matrix.