feat: internal to MongoDB $jsonSchema conversion COMPASS-8701 (#218)

---------

Co-authored-by: Anna Henningsen <[email protected]>

Author: paula-stacho

package.json

@@ -33,7 +33,7 @@
     ".esm-wrapper.mjs"
   ],
   "scripts": {
-    "test": "nyc mocha --timeout 5000 --colors -r ts-node/register test/*.ts",
+    "test": "nyc mocha --timeout 5000 --colors -r ts-node/register test/*.ts src/**/*.test.ts",
     "test-example-parse-from-file": "ts-node examples/parse-from-file.ts",
     "test-example-parse-schema": "ts-node examples/parse-schema.ts",
     "test-time": "ts-node ./test/time-testing.ts",

src/index.ts

@@ -18,7 +18,7 @@ import type {
   SimplifiedSchema
 } from './schema-analyzer';
 import * as schemaStats from './stats';
-import { AnyIterable, StandardJSONSchema, MongoDBJSONSchema, ExtendedJSONSchema } from './types';
+import { AnyIterable, StandardJSONSchema, MongoDBJSONSchema, ExpandedJSONSchema } from './types';
 
 /**
  * Analyze documents - schema can be retrieved in different formats.
@@ -77,7 +77,7 @@ export type {
   SimplifiedSchema,
   StandardJSONSchema,
   MongoDBJSONSchema,
-  ExtendedJSONSchema
+  ExpandedJSONSchema
 };
 
 export {

src/schema-accessor.ts

@@ -1,11 +1,11 @@
 import { Schema as InternalSchema } from './schema-analyzer';
-import convertors from './schema-convertors';
-import { ExtendedJSONSchema, MongoDBJSONSchema, StandardJSONSchema } from './types';
+import { convertors } from './schema-convertors';
+import { ExpandedJSONSchema, MongoDBJSONSchema, StandardJSONSchema } from './types';
 
 export interface SchemaAccessor {
   getStandardJsonSchema: () => Promise<StandardJSONSchema>;
   getMongoDBJsonSchema: () => Promise<MongoDBJSONSchema>;
-  getExtendedJsonSchema: () => Promise<ExtendedJSONSchema>;
+  getExpandedJSONSchema: () => Promise<ExpandedJSONSchema>;
   getInternalSchema: () => Promise<InternalSchema>;
 }
 
@@ -23,13 +23,13 @@ export class InternalSchemaBasedAccessor implements SchemaAccessor {
   private internalSchema: InternalSchema;
   private standardJSONSchema?: StandardJSONSchema;
   private mongodbJSONSchema?: MongoDBJSONSchema;
-  private extendedJSONSchema?: ExtendedJSONSchema;
+  private ExpandedJSONSchema?: ExpandedJSONSchema;
 
   constructor(internalSchema: InternalSchema) {
     this.internalSchema = internalSchema;
   }
 
-  async getInternalSchema(options?: Options): Promise<InternalSchema> {
+  async getInternalSchema(): Promise<InternalSchema> {
     return this.internalSchema;
   }
 
@@ -41,7 +41,7 @@ export class InternalSchemaBasedAccessor implements SchemaAccessor {
     return this.mongodbJSONSchema ??= await convertors.internalSchemaToMongoDB(this.internalSchema, options);
   }
 
-  async getExtendedJsonSchema(options: Options = {}): Promise<ExtendedJSONSchema> {
-    return this.extendedJSONSchema ??= await convertors.internalSchemaToExtended(this.internalSchema, options);
+  async getExpandedJSONSchema(options: Options = {}): Promise<ExpandedJSONSchema> {
+    return this.ExpandedJSONSchema ??= await convertors.internalSchemaToExpanded(this.internalSchema, options);
   }
 }

src/schema-convertors.ts

@@ -0,0 +1,9 @@
+import internalSchemaToExpanded from './internalToExpanded';
+import internalSchemaToMongoDB from './internalToMongoDB';
+import internalSchemaToStandard from './internalToStandard';
+
+export const convertors = {
+  internalSchemaToStandard,
+  internalSchemaToMongoDB,
+  internalSchemaToExpanded
+};

src/schema-convertors/index.ts

@@ -0,0 +1,12 @@
+import { InternalSchema } from '..';
+import { ExpandedJSONSchema } from '../types';
+
+export default function internalSchemaToExpanded(
+  /* eslint @typescript-eslint/no-unused-vars: 0 */
+  internalSchema: InternalSchema,
+  options: {
+    signal?: AbortSignal
+}): Promise<ExpandedJSONSchema> {
+  // TODO: COMPASS-8702
+  return Promise.resolve({} as ExpandedJSONSchema);
+}