at least structure the files as they will end up

Author: lerouxb

packages/mongodb-ts-autocomplete/src/autocompleter-types.ts

@@ -0,0 +1,27 @@
+import fs from 'fs';
+import path from 'path';
+
+// TODO: this file would be generated and include the typescript code as strings
+// rather than reading them from disk
+function loadFiles() {
+  return {
+    'bson.d.ts': fs.readFileSync(
+      path.join(__dirname, 'fixtures', 'bson.d.ts'),
+      'utf8'
+    ),
+    'bson-expressions.d.ts': fs.readFileSync(
+      path.join(__dirname, 'fixtures', 'bson-expressions.d.ts'),
+      'utf8'
+    ),
+    'mql.d.ts': fs.readFileSync(
+      path.join(__dirname, 'fixtures', 'mql.d.ts'),
+      'utf8'
+    ),
+    'shell-api.d.ts': fs.readFileSync(
+      path.join(__dirname, 'fixtures', 'shell-api.d.ts'),
+      'utf8'
+    ),
+  };
+}
+
+export default loadFiles;

packages/mongodb-ts-autocomplete/src/bson-expressions.ts

@@ -0,0 +1,11 @@
+// TODO: everything in here is just a very minimal stub until we can generate
+// this file from the real bson expression types we'll get in MONGOSH-2032
+
+/* eslint-disable @typescript-eslint/triple-slash-reference */
+/// <reference path="bson.d.ts" />
+
+export {}; // turns this into an "external module"
+
+declare global {
+  export function ObjectId(id: string): BSON.ObjectId;
+}

packages/mongodb-ts-autocomplete/src/fixtures/bson-expressions.d.ts

@@ -0,0 +1,14 @@
+// TODO: everything in here is just a very minimal stub until we can generate
+// this file from the real bson types
+
+export {}; // turns this into an "external module"
+
+// this has to be global otherwise the other files won't be able to use the
+// namespace
+declare global {
+  export namespace BSON {
+    export type ObjectId = {
+      toString: () => string;
+    };
+  }
+}

packages/mongodb-ts-autocomplete/src/fixtures/bson.d.ts

@@ -1,7 +1,12 @@
+// TODO: everything in here is just a very minimal stub until we can generate
+// this file from the work in MONGOSH-2030
+
 export {}; // turns this into an "external module"
 
+// this has to be global otherwise the other files won't be able to use the
+// namespace
 declare global {
-  namespace ShellAPI {
+  export namespace MQL {
     // TODO: most of these are actually MQL
     export interface Document {
       [key: string]: any;
@@ -37,23 +42,5 @@ declare global {
     };
 
     export type Pipeline<T> = Array<Match<T> | Project<T> | Lookup<T, any>>;
-
-    export interface Collection<T> {
-      find(query: Filter<T>): Cursor<T>;
-      findOne(query: Filter<T>): T;
-      aggregate(pipeline: Pipeline<T>): Cursor<T>;
-      insertOne(value: T): void;
-      insertMany(value: Array<T>): void;
-      updateOne(query: Filter<T>, modifier: Partial<T> | Pipeline<T>): void;
-      updateMany(query: Filter<T>, modifier: Partial<T> | Pipeline<T>): void;
-    }
-
-    export interface Database {
-      runCommand(cmd: string | Document, options: Document): Document;
-    }
   }
-}
-
-// NOTE: there are no globals declared yet. db and others will be generated
-// separately based on the the current database/collection/aggregation/whatever
-// that's being accessed. Those just use these types.
+}

packages/mongodb-ts-autocomplete/src/mock-shell-api.d.ts renamed to packages/mongodb-ts-autocomplete/src/fixtures/mql.d.ts

@@ -0,0 +1,34 @@
+// TODO: everything in here is just a very minimal stub until we can generate
+// this file from the work in MONGOSH-2031
+
+/* eslint-disable @typescript-eslint/triple-slash-reference */
+/// <reference path="mql.d.ts" />
+
+export {}; // turns this into an "external module"
+
+declare global {
+  namespace ShellAPI {
+    export interface Collection<T> {
+      find(query: MQL.Filter<T>): MQL.Cursor<T>;
+      findOne(query: MQL.Filter<T>): T;
+      aggregate(pipeline: MQL.Pipeline<T>): MQL.Cursor<T>;
+      insertOne(value: T): void;
+      insertMany(value: MQL.Array<T>): void;
+      updateOne(
+        query: MQL.Filter<T>,
+        modifier: Partial<T> | MQL.Pipeline<T>
+      ): void;
+      updateMany(
+        query: MQL.Filter<T>,
+        modifier: Partial<T> | MQL.Pipeline<T>
+      ): void;
+    }
+
+    export interface Database {
+      runCommand(
+        cmd: string | MQL.Document,
+        options: MQL.Document
+      ): MQL.Document;
+    }
+  }
+}

packages/mongodb-ts-autocomplete/src/fixtures/shell-api.d.ts

@@ -57,7 +57,7 @@ describe('MongoDBAutocompleter', function () {
       {
         kind: 'function',
         name: 'ObjectId',
-        type: 'ObjectId',
+        type: 'BSON.ObjectId',
       },
     ]);
   });
@@ -88,7 +88,7 @@ describe('MongoDBAutocompleter', function () {
       {
         kind: 'method',
         name: 'runCommand',
-        type: 'Document',
+        type: 'MQL.Document',
       },
     ]);
   });

packages/mongodb-ts-autocomplete/src/index.spec.ts

@@ -3,8 +3,7 @@ import type {
   AutocompleterOptions,
   AutoCompletion,
 } from '@mongodb-js/ts-autocomplete';
-import { loadShellAPI } from './shell-api';
-import { loadBSONExpressions } from './bson-expressions';
+import loadFiles from './autocompleter-types';
 
 import type { JSONSchema } from './type-export';
 import { toTypescriptTypeDefinition } from './type-export';
@@ -136,15 +135,7 @@ export default class MongoDBAutocompleter {
     this.connectionSchemas = Object.create(null);
     this.connectionSchemas;
 
-    // TODO: set the @mongodb-js/mql-typescript definitions (will this be separate or part of shell-api?)
-    // these aren't globals because they are types, so probably only make sense
-    // in combination with either the shell-api or something like a document or
-    // aggregation editor
-
-    this.autocompleter.updateCode({
-      'bson-expressions.d.ts': loadBSONExpressions(),
-    });
-    this.autocompleter.updateCode({ 'shell-api.d.ts': loadShellAPI() });
+    this.autocompleter.updateCode(loadFiles());
   }
 
   addConnection(connectionId: string): ConnectionSchema {