expose the mql types in mongodb-ts-autocomplete

lerouxb · lerouxb · commit d7112f2e4894 · 2025-06-09T15:17:33.000+01:00
diff --git a/packages/mongodb-ts-autocomplete/package.json b/packages/mongodb-ts-autocomplete/package.json
@@ -61,6 +61,7 @@
     "@mongodb-js/prettier-config-devtools": "^1.0.1",
     "@mongodb-js/tsconfig-devtools": "^1.0.2",
     "@mongosh/shell-api": "^3.11.0",
+    "@mongodb-js/mql-typescript": "^0.1.0",
     "@types/chai": "^4.2.21",
     "@types/mocha": "^9.1.1",
     "@types/node": "^22.15.30",
diff --git a/packages/mongodb-ts-autocomplete/scripts/extract-types.ts b/packages/mongodb-ts-autocomplete/scripts/extract-types.ts
@@ -16,7 +16,12 @@ async function loadSources(sources: Record<string, string>) {
 async function run() {
   const input: Record<string, string> = {
     '/bson.ts': path.join(require.resolve('bson'), '..', '..', 'bson.d.ts'),
-    '/mql.ts': path.join(__dirname, '..', 'src', 'fixtures', 'mql.ts'),
+    '/mongodb.ts': path.join(
+      require.resolve('mongodb'),
+      '..',
+      '..',
+      'mongodb.d.ts',
+    ),
   };
   const files = await loadSources(input);
   const code = `
diff --git a/packages/mongodb-ts-autocomplete/src/autocompleter.spec.ts b/packages/mongodb-ts-autocomplete/src/autocompleter.spec.ts
@@ -152,7 +152,7 @@ describe('MongoDBAutocompleter', function () {
   // TODO: We need MONGOSH-2170 so that we can use the generated MQL types via
   // the Shell API to autocomplete fields in
   // ServerSchema[databaseName][collectionName].schema
-  it.skip('completes a collection field name in a query', async function () {
+  it.only('completes a collection field name in a query', async function () {
     const completions = await autocompleter.autocomplete('db.foo.find({ fo');
 
     expect(
@@ -198,6 +198,7 @@ describe('MongoDBAutocompleter', function () {
       expect(code).to.equal(`
 import * as ShellAPI from '/shell-api.ts';
 import * as bson from '/bson.ts';
+import * as mql from '/mql.ts';
 
 export type ServerSchema = {
   ${JSON.stringify(databaseName)}: {
diff --git a/packages/mongodb-ts-autocomplete/src/autocompleter.ts b/packages/mongodb-ts-autocomplete/src/autocompleter.ts
@@ -2,6 +2,7 @@ import Autocompleter from '@mongodb-js/ts-autocomplete';
 import type { AutoCompletion } from '@mongodb-js/ts-autocomplete';
 import autocompleteTypes from './fixtures/autocomplete-types';
 import { api as ShellApiText } from '@mongosh/shell-api/api';
+import { schema as MQLText } from '@mongodb-js/mql-typescript/schema';
 import { replaceImports } from './utils';
 
 import type { JSONSchema } from 'mongodb-schema';
@@ -164,6 +165,7 @@ export class MongoDBAutocompleter {
     this.autocompleter.updateCode({
       ...autocompleteTypes,
       '/shell-api.ts': replaceImports(ShellApiText),
+      '/mql.ts': replaceImports(MQLText),
     });
   }
 
@@ -178,6 +180,7 @@ export class MongoDBAutocompleter {
     return `
 import * as ShellAPI from '/shell-api.ts';
 import * as bson from '/bson.ts';
+import * as mql from '/mql.ts';
 
 export type ServerSchema = ${this.connectionSchemas[
       connectionId
diff --git a/packages/mongodb-ts-autocomplete/src/utils.ts b/packages/mongodb-ts-autocomplete/src/utils.ts
@@ -1,5 +1,7 @@
 export function replaceImports(code: string) {
   // This just makes it possible to work on mql.ts because then the
   // IDE finds the import.
-  return code.replace(/'bson'/g, "'/bson.ts'");
+  return code
+    .replace(/'bson'/g, "'/bson.ts'")
+    .replace(/'mongodb'/g, "'/mongodb.ts'");
 }
diff --git a/packages/mql-typescript/out/schema-export.d.ts b/packages/mql-typescript/out/schema-export.d.ts
@@ -0,0 +1 @@
+export declare const schema;
diff --git a/packages/mql-typescript/package.json b/packages/mql-typescript/package.json
@@ -27,11 +27,17 @@
   },
   "license": "Apache-2.0",
   "main": "dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
-    "require": "./dist/index.js",
-    "import": "./dist/.esm-wrapper.mjs"
+    ".": {
+      "default": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./schema": {
+      "default": "./out/schema-export.js",
+      "types": "./out/schema-export.d.ts"
+    }
   },
-  "types": "./dist/index.d.ts",
   "scripts": {
     "bootstrap": "npm run compile",
     "prepublishOnly": "npm run compile",
diff --git a/packages/mql-typescript/src/schema-generator.ts b/packages/mql-typescript/src/schema-generator.ts
@@ -21,6 +21,12 @@ export class SchemaGenerator extends GeneratorBase {
     'out',
     'schema-export.js',
   );
+  private schemaExportDefinitionFile = path.resolve(
+    __dirname,
+    '..',
+    'out',
+    'schema-export.d.ts',
+  );
 
   private toTypeName(type: string): string {
     return this.trivialTypeMappings[type as ArgType] ?? capitalize(type);
@@ -589,5 +595,11 @@ export class SchemaGenerator extends GeneratorBase {
         .replace(/\n/g, '\\n'), // Escape newlines
     );
     this.emit("'\n");
+
+    await fs.writeFile(
+      this.schemaExportDefinitionFile,
+      'export declare const schema;',
+      'utf8',
+    );
   }
 }
diff --git a/packages/ts-autocomplete/src/index.ts b/packages/ts-autocomplete/src/index.ts
@@ -169,6 +169,10 @@ function filterDiagnostics(diagnostics: ts.Diagnostic[]): {
       delete result.text;
     }
 
+    if (result.fileName === '/mql.ts') {
+      delete result.text;
+    }
+
     return result;
   });
 }

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,7 @@`
`1`	`1`	`export function replaceImports(code: string) {`
`2`	`2`	`// This just makes it possible to work on mql.ts because then the`
`3`	`3`	`// IDE finds the import.`
`4`		`- return code.replace(/'bson'/g, "'/bson.ts'");`
	`4`	`+ return code`
	`5`	`+ .replace(/'bson'/g, "'/bson.ts'")`
	`6`	`+ .replace(/'mongodb'/g, "'/mongodb.ts'");`
`5`	`7`	`}`
Original file line number	Diff line number	Diff line change
`@@ -169,6 +169,10 @@ function filterDiagnostics(diagnostics: ts.Diagnostic[]): {`
`169`	`169`	`delete result.text;`
`170`	`170`	`}`
`171`	`171`
	`172`	`+ if (result.fileName === '/mql.ts') {`
	`173`	`+ delete result.text;`
	`174`	`+ }`
	`175`	`+`
`172`	`176`	`return result;`
`173`	`177`	`});`
`174`	`178`	`}`