@mongodb-js/mql-typescript 0.2.0

package/dist/testGenerator/test-generator.js

@@ -0,0 +1,211 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TestGenerator = void 0;
+const path_1 = __importDefault(require("path"));
+const generator_1 = require("../generator");
+const fs = __importStar(require("fs/promises"));
+const metaschema_1 = require("../metaschema");
+const utils_1 = require("../utils");
+const unsupported_aggregations_1 = require("./unsupported-aggregations");
+const bson = __importStar(require("bson"));
+class TestGenerator extends generator_1.GeneratorBase {
+    schemaBsonTypeToTS(type) {
+        switch (type) {
+            case 'Binary':
+                return 'bson.Binary';
+            case 'Boolean':
+                return 'boolean';
+            case 'Code':
+                return 'bson.Code';
+            case 'CodeWScope':
+                return 'bson.Code';
+            case 'Date':
+                return 'Date';
+            case 'Decimal128':
+                return 'bson.Decimal128';
+            case 'Double':
+                return 'bson.Double | number';
+            case 'Int32':
+                return 'bson.Int32 | number';
+            case 'Long':
+            case 'Int64':
+                return 'bson.Long';
+            case 'MaxKey':
+                return 'bson.MaxKey';
+            case 'MinKey':
+                return 'bson.MinKey';
+            case 'Null':
+                return 'null';
+            case 'ObjectId':
+                return 'bson.ObjectId';
+            case 'BSONRegExp':
+                return 'bson.BSONRegExp';
+            case 'String':
+                return 'string';
+            case 'BSONSymbol':
+                return 'bson.BSONSymbol';
+            case 'Timestamp':
+                return `bson.Timestamp`;
+            case 'Undefined':
+                return `undefined`;
+            case 'Number':
+                return 'number';
+            default:
+                throw new Error(`Unknown BSON type: ${type}`);
+        }
+    }
+    simplifiedTypesToTS(types) {
+        const mappedTypes = [];
+        for (const type of types) {
+            if (type.bsonType === 'Document' && 'fields' in type) {
+                mappedTypes.push(this.simplifiedSchemaToTS(type.fields));
+            }
+            else if (type.bsonType === 'Array' && 'types' in type) {
+                mappedTypes.push(`Array<${this.simplifiedTypesToTS(type.types)}>`);
+            }
+            else {
+                mappedTypes.push(this.schemaBsonTypeToTS(type.bsonType));
+            }
+        }
+        return mappedTypes.join(' | ');
+    }
+    simplifiedSchemaToTS(schema) {
+        let result = '{\n';
+        for (const [key, value] of Object.entries(schema)) {
+            result += `'${key}': ${this.simplifiedTypesToTS(value.types)};\n`;
+        }
+        result += '}\n';
+        return result;
+    }
+    stageToTS(stage) {
+        switch (typeof stage) {
+            case 'object': {
+                if (stage === null) {
+                    return 'null';
+                }
+                if (Array.isArray(stage)) {
+                    return `[${stage.map((s) => this.stageToTS(s)).join(', ')}]`;
+                }
+                if (stage instanceof bson.Binary) {
+                    return `bson.Binary.createFromBase64('${stage.toString('base64')}', ${stage.sub_type})`;
+                }
+                if (stage instanceof bson.ObjectId) {
+                    return `bson.ObjectId.createFromHexString('${stage.toHexString()}')`;
+                }
+                if (stage instanceof bson.Long) {
+                    return `new bson.Long('${stage.toString()}')`;
+                }
+                if (stage instanceof Date) {
+                    return `new Date('${stage.toISOString()}')`;
+                }
+                if (stage instanceof bson.BSONRegExp) {
+                    return `new bson.BSONRegExp('${stage.pattern}', '${stage.options}')`;
+                }
+                if ('$code' in stage && typeof stage.$code === 'string') {
+                    return JSON.stringify((0, utils_1.removeNewlines)(stage.$code));
+                }
+                let result = '{';
+                for (const [key, value] of Object.entries(stage)) {
+                    result += `${JSON.stringify(key)}: ${this.stageToTS(value)},`;
+                }
+                result += '}';
+                return result;
+            }
+            case 'undefined':
+                return 'undefined';
+            default:
+                return JSON.stringify(stage);
+        }
+    }
+    emitTestBody(category, operator, test) {
+        if (!test.pipeline) {
+            this.emit(`// TODO: No pipeline found for ${operator}.${test.name}\n`);
+            return;
+        }
+        if (!test.schema || typeof test.schema === 'string') {
+            this.emit(`// TODO: no schema found for ${operator}.${test.name}${test.schema ? `: ${test.schema}` : ''}\n`);
+            return;
+        }
+        const collectionName = Object.keys(test.schema)[0];
+        const schema = test.schema[collectionName];
+        this.emit(`type ${collectionName} = ${this.simplifiedSchemaToTS(schema)}\n`);
+        this.emit(`const aggregation: schema.Pipeline<${collectionName}> = [\n`);
+        for (let i = 0; i < test.pipeline.length; i++) {
+            const stage = test.pipeline[i];
+            const unsupportedStage = unsupported_aggregations_1.unsupportedAggregations[category]?.[operator]?.[test.name];
+            const isUnsupportedStage = unsupportedStage && i >= unsupportedStage.stage;
+            if (isUnsupportedStage) {
+                this.emitComment(`This stage is unsupported by the static type system, so we're casting it to 'any' (${unsupportedStage.comment ?? 'it may involve a projected field'}).`);
+            }
+            this.emit(this.stageToTS(stage));
+            if (isUnsupportedStage) {
+                this.emit(' as any');
+            }
+            this.emit(',\n');
+        }
+        this.emit('];\n');
+    }
+    async generateImpl(yamlFiles) {
+        for await (const file of yamlFiles) {
+            const namespace = `${(0, utils_1.capitalize)(file.category)}Operators`;
+            const basePath = path_1.default.resolve(__dirname, '..', '..', 'tests', file.category);
+            await fs.mkdir(basePath, { recursive: true });
+            for await (const operator of file.operators()) {
+                const parsed = metaschema_1.Operator.parse(operator.yaml);
+                const operatorName = parsed.name.replace(/^\$/, '');
+                const filePath = path_1.default.join(basePath, `${operatorName}.spec.ts`);
+                await this.emitToFile(filePath);
+                this.emit('/* eslint-disable @typescript-eslint/no-unused-vars */\n');
+                this.emit('/* eslint-disable filename-rules/match */\n');
+                this.emit('/* eslint-disable @typescript-eslint/consistent-type-imports */\n');
+                this.emit("import type * as schema from '../../out/schema';\n");
+                this.emit("import * as bson from 'bson';\n\n");
+                let i = 0;
+                for (const test of parsed.tests ?? []) {
+                    this.emitComment(test.name ?? `Test ${namespace}.${parsed.name}`, test.link);
+                    this.emit(`function test${i++}() {\n`);
+                    this.emitTestBody(file.category, operatorName, test);
+                    this.emit('}\n\n');
+                }
+            }
+        }
+    }
+}
+exports.TestGenerator = TestGenerator;
+//# sourceMappingURL=test-generator.js.map

package/dist/testGenerator/test-generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-generator.js","sourceRoot":"","sources":["../../src/testGenerator/test-generator.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,gDAAwB;AAExB,4CAA6C;AAC7C,gDAAkC;AAClC,8CAAyC;AACzC,oCAAsD;AAMtD,yEAAqE;AACrE,2CAA6B;AAM7B,MAAa,aAAc,SAAQ,yBAAa;IACtC,kBAAkB,CAAC,IAAoB;QAC7C,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,QAAQ;gBACX,OAAO,aAAa,CAAC;YACvB,KAAK,SAAS;gBACZ,OAAO,SAAS,CAAC;YACnB,KAAK,MAAM;gBACT,OAAO,WAAW,CAAC;YACrB,KAAK,YAAY;gBACf,OAAO,WAAW,CAAC;YACrB,KAAK,MAAM;gBACT,OAAO,MAAM,CAAC;YAChB,KAAK,YAAY;gBACf,OAAO,iBAAiB,CAAC;YAC3B,KAAK,QAAQ;gBACX,OAAO,sBAAsB,CAAC;YAChC,KAAK,OAAO;gBACV,OAAO,qBAAqB,CAAC;YAC/B,KAAK,MAAM,CAAC;YACZ,KAAK,OAAO;gBACV,OAAO,WAAW,CAAC;YACrB,KAAK,QAAQ;gBACX,OAAO,aAAa,CAAC;YACvB,KAAK,QAAQ;gBACX,OAAO,aAAa,CAAC;YACvB,KAAK,MAAM;gBACT,OAAO,MAAM,CAAC;YAChB,KAAK,UAAU;gBACb,OAAO,eAAe,CAAC;YACzB,KAAK,YAAY;gBACf,OAAO,iBAAiB,CAAC;YAC3B,KAAK,QAAQ;gBACX,OAAO,QAAQ,CAAC;YAClB,KAAK,YAAY;gBACf,OAAO,iBAAiB,CAAC;YAC3B,KAAK,WAAW;gBACd,OAAO,gBAAgB,CAAC;YAC1B,KAAK,WAAW;gBACd,OAAO,WAAW,CAAC;YACrB,KAAK,QAAQ;gBACX,OAAO,QAAQ,CAAC;YAClB;gBACE,MAAM,IAAI,KAAK,CAAC,sBAAsB,IAAI,EAAE,CAAC,CAAC;QAClD,CAAC;IACH,CAAC;IAEO,mBAAmB,CAAC,KAA6B;QACvD,MAAM,WAAW,GAAG,EAAE,CAAC;QACvB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,IAAI,IAAI,CAAC,QAAQ,KAAK,UAAU,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;gBACrD,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;YAC3D,CAAC;iBAAM,IAAI,IAAI,CAAC,QAAQ,KAAK,OAAO,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;gBACxD,WAAW,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACrE,CAAC;iBAAM,CAAC;gBACN,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;YAC3D,CAAC;QACH,CAAC;QAED,OAAO,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC;IAEO,oBAAoB,CAAC,MAAwB;QACnD,IAAI,MAAM,GAAG,KAAK,CAAC;QACnB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAClD,MAAM,IAAI,IAAI,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC;QACpE,CAAC;QACD,MAAM,IAAI,KAAK,CAAC;QAChB,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,SAAS,CAAC,KAAc;QAC9B,QAAQ,OAAO,KAAK,EAAE,CAAC;YACrB,KAAK,QAAQ,CAAC,CAAC,CAAC;gBACd,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;oBACnB,OAAO,MAAM,CAAC;gBAChB,CAAC;gBAED,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBACzB,OAAO,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;gBAC/D,CAAC;gBAED,IAAI,KAAK,YAAY,IAAI,CAAC,MAAM,EAAE,CAAC;oBACjC,OAAO,iCAAiC,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,QAAQ,GAAG,CAAC;gBAC1F,CAAC;gBAED,IAAI,KAAK,YAAY,IAAI,CAAC,QAAQ,EAAE,CAAC;oBACnC,OAAO,sCAAsC,KAAK,CAAC,WAAW,EAAE,IAAI,CAAC;gBACvE,CAAC;gBAED,IAAI,KAAK,YAAY,IAAI,CAAC,IAAI,EAAE,CAAC;oBAC/B,OAAO,kBAAkB,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC;gBAChD,CAAC;gBAED,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;oBAC1B,OAAO,aAAa,KAAK,CAAC,WAAW,EAAE,IAAI,CAAC;gBAC9C,CAAC;gBAED,IAAI,KAAK,YAAY,IAAI,CAAC,UAAU,EAAE,CAAC;oBACrC,OAAO,wBAAwB,KAAK,CAAC,OAAO,OAAO,KAAK,CAAC,OAAO,IAAI,CAAC;gBACvE,CAAC;gBAED,IAAI,OAAO,IAAI,KAAK,IAAI,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;oBACxD,OAAO,IAAI,CAAC,SAAS,CAAC,IAAA,sBAAc,EAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;gBACrD,CAAC;gBAED,IAAI,MAAM,GAAG,GAAG,CAAC;gBACjB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBACjD,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC;gBAChE,CAAC;gBACD,MAAM,IAAI,GAAG,CAAC;gBACd,OAAO,MAAM,CAAC;YAChB,CAAC;YACD,KAAK,WAAW;gBACd,OAAO,WAAW,CAAC;YACrB;gBACE,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACjC,CAAC;IACH,CAAC;IAEO,YAAY,CAClB,QAAgB,EAChB,QAAgB,EAChB,IAAc;QAEd,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,IAAI,CAAC,IAAI,CAAC,kCAAkC,QAAQ,IAAI,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC;YACvE,OAAO;QACT,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;YACpD,IAAI,CAAC,IAAI,CACP,gCAAgC,QAAQ,IAAI,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,CAClG,CAAC;YACF,OAAO;QACT,CAAC;QAED,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QACnD,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAqB,CAAC;QAE/D,IAAI,CAAC,IAAI,CACP,QAAQ,cAAc,MAAM,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,IAAI,CAClE,CAAC;QAEF,IAAI,CAAC,IAAI,CAAC,sCAAsC,cAAc,SAAS,CAAC,CAAC;QAEzE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC9C,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;YAI/B,MAAM,gBAAgB,GACpB,kDAAuB,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC7D,MAAM,kBAAkB,GACtB,gBAAgB,IAAI,CAAC,IAAI,gBAAgB,CAAC,KAAK,CAAC;YAElD,IAAI,kBAAkB,EAAE,CAAC;gBACvB,IAAI,CAAC,WAAW,CACd,sFAAsF,gBAAgB,CAAC,OAAO,IAAI,kCAAkC,IAAI,CACzJ,CAAC;YACJ,CAAC;YAED,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;YAEjC,IAAI,kBAAkB,EAAE,CAAC;gBACvB,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACvB,CAAC;YACD,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACnB,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACpB,CAAC;IAEkB,KAAK,CAAC,YAAY,CAAC,SAAoB;QACxD,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,SAAS,EAAE,CAAC;YACnC,MAAM,SAAS,GAAG,GAAG,IAAA,kBAAU,EAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC;YAE1D,MAAM,QAAQ,GAAG,cAAI,CAAC,OAAO,CAC3B,SAAS,EACT,IAAI,EACJ,IAAI,EACJ,OAAO,EACP,IAAI,CAAC,QAAQ,CACd,CAAC;YACF,MAAM,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAE9C,IAAI,KAAK,EAAE,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC;gBAC9C,MAAM,MAAM,GAAG,qBAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBAE7C,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;gBAEpD,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,YAAY,UAAU,CAAC,CAAC;gBAChE,MAAM,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;gBAEhC,IAAI,CAAC,IAAI,CAAC,0DAA0D,CAAC,CAAC;gBACtE,IAAI,CAAC,IAAI,CAAC,6CAA6C,CAAC,CAAC;gBACzD,IAAI,CAAC,IAAI,CACP,mEAAmE,CACpE,CAAC;gBACF,IAAI,CAAC,IAAI,CAAC,oDAAoD,CAAC,CAAC;gBAChE,IAAI,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;gBAE/C,IAAI,CAAC,GAAG,CAAC,CAAC;gBACV,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,KAAK,IAAI,EAAE,EAAE,CAAC;oBACtC,IAAI,CAAC,WAAW,CACd,IAAI,CAAC,IAAI,IAAI,QAAQ,SAAS,IAAI,MAAM,CAAC,IAAI,EAAE,EAC/C,IAAI,CAAC,IAAI,CACV,CAAC;oBAEF,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAAE,QAAQ,CAAC,CAAC;oBAEvC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC;oBAErD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACrB,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;CACF;AA1ND,sCA0NC"}

package/dist/testGenerator/unsupported-aggregations.d.ts

@@ -0,0 +1,11 @@
+export declare const unsupportedAggregations: {
+    [category: string]: {
+        [operator: string]: {
+            [test: string]: {
+                stage: number;
+                comment?: string;
+            };
+        };
+    };
+};
+//# sourceMappingURL=unsupported-aggregations.d.ts.map

package/dist/testGenerator/unsupported-aggregations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unsupported-aggregations.d.ts","sourceRoot":"","sources":["../../src/testGenerator/unsupported-aggregations.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,uBAAuB,EAAE;IACpC,CAAC,QAAQ,EAAE,MAAM,GAAG;QAClB,CAAC,QAAQ,EAAE,MAAM,GAAG;YAClB,CAAC,IAAI,EAAE,MAAM,GAAG;gBAAE,KAAK,EAAE,MAAM,CAAC;gBAAC,OAAO,CAAC,EAAE,MAAM,CAAA;aAAE,CAAC;SACrD,CAAC;KACH,CAAC;CAmQH,CAAC"}

package/dist/testGenerator/unsupported-aggregations.js

@@ -0,0 +1,254 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.unsupportedAggregations = void 0;
+const nestedFieldsExplanation = 'this test accesses nested fields, which is not currently supported';
+exports.unsupportedAggregations = {
+    accumulator: {
+        derivative: {
+            Example: { stage: 1 },
+        },
+    },
+    expression: {
+        arrayToObject: {
+            ['$objectToArray and $arrayToObject Example']: { stage: 1 },
+        },
+        convert: {
+            Example: { stage: 1 },
+        },
+        dateDiff: {
+            'Elapsed Time': { stage: 1 },
+        },
+        dateSubtract: {
+            'Filter by Relative Dates': { stage: 1 },
+        },
+        let: {
+            Example: {
+                stage: 0,
+                comment: '$multiply references a variable that is not available statically',
+            },
+        },
+        map: {
+            'Add to Each Element of an Array': {
+                stage: 0,
+                comment: '$map references the variable names defined in the `as` field, which is not available statically',
+            },
+            'Truncate Each Array Element': {
+                stage: 0,
+                comment: '$map references the variable names defined in the `as` field, which is not available statically',
+            },
+            'Convert Celsius Temperatures to Fahrenheit': {
+                stage: 0,
+                comment: '$map references the variable names defined in the `as` field, which is not available statically',
+            },
+        },
+        objectToArray: {
+            '$objectToArray to Sum Nested Fields': { stage: 1 },
+        },
+        pow: {
+            Example: {
+                stage: 0,
+                comment: nestedFieldsExplanation,
+            },
+        },
+        reduce: {
+            Multiplication: { stage: 1 },
+            'Computing a Multiple Reductions': {
+                stage: 0,
+                comment: nestedFieldsExplanation,
+            },
+        },
+        regexFindAll: {
+            'Use Captured Groupings to Parse User Name': { stage: 1 },
+        },
+        setIntersection: {
+            'Retrieve Documents for Roles Granted to the Current User': {
+                stage: 0,
+                comment: nestedFieldsExplanation,
+            },
+        },
+        split: {
+            Example: { stage: 1 },
+        },
+        sqrt: {
+            Example: { stage: 0, comment: nestedFieldsExplanation },
+        },
+        stdDevPop: {
+            'Use in $project Stage': { stage: 0, comment: nestedFieldsExplanation },
+        },
+        toBool: {
+            Example: { stage: 1 },
+        },
+        zip: {
+            'Filtering and Preserving Indexes': {
+                stage: 0,
+                comment: nestedFieldsExplanation,
+            },
+        },
+    },
+    query: {
+        eq: {
+            'Field in Embedded Document Equals a Value': {
+                stage: 0,
+                comment: nestedFieldsExplanation,
+            },
+        },
+        type: {
+            'Querying by MinKey and MaxKey': {
+                stage: 0,
+                comment: nestedFieldsExplanation,
+            },
+        },
+    },
+    search: {
+        embeddedDocument: {
+            'Query for Matching Embedded Documents Only': {
+                stage: 2,
+                comment: nestedFieldsExplanation,
+            },
+            Basic: {
+                stage: 0,
+                comment: nestedFieldsExplanation,
+            },
+            Facet: {
+                stage: 0,
+                comment: nestedFieldsExplanation,
+            },
+            ['Query and Sort']: {
+                stage: 0,
+                comment: nestedFieldsExplanation,
+            },
+        },
+        facet: {
+            Facet: {
+                stage: 2,
+                comment: 'this uses $$SEARCH_META, which is a synthetic field not available statically',
+            },
+        },
+        geoShape: {
+            Disjoint: {
+                stage: 0,
+                comment: nestedFieldsExplanation,
+            },
+            Intersect: {
+                stage: 0,
+                comment: nestedFieldsExplanation,
+            },
+            Within: {
+                stage: 0,
+                comment: nestedFieldsExplanation,
+            },
+        },
+        exists: {
+            Embedded: {
+                stage: 0,
+                comment: nestedFieldsExplanation,
+            },
+        },
+        geoWithin: {
+            box: {
+                stage: 0,
+                comment: nestedFieldsExplanation,
+            },
+            circle: {
+                stage: 0,
+                comment: nestedFieldsExplanation,
+            },
+            geometry: {
+                stage: 0,
+                comment: nestedFieldsExplanation,
+            },
+        },
+        near: {
+            ['GeoJSON Point']: {
+                stage: 0,
+                comment: nestedFieldsExplanation,
+            },
+            Compound: {
+                stage: 0,
+                comment: nestedFieldsExplanation,
+            },
+        },
+    },
+    stage: {
+        addFields: {
+            'Using Two $addFields Stages': {
+                stage: 1,
+            },
+        },
+        bucket: {
+            'Bucket by Year and Filter by Bucket Results': {
+                stage: 1,
+                comment: 'the output field of the $bucket stage generates new fields that are not available statically',
+            },
+        },
+        currentOp: {
+            'Inactive Sessions': {
+                stage: 1,
+                comment: '$currentOp emits new fields that are not available statically',
+            },
+            'Sampled Queries': {
+                stage: 1,
+                comment: '$currentOp emits new fields that are not available statically',
+            },
+        },
+        group: {
+            'Group by Item Having': {
+                stage: 1,
+            },
+            'Group Documents by author': {
+                stage: 1,
+            },
+        },
+        planCacheStats: {
+            'Find Cache Entry Details for a Query Hash': {
+                stage: 1,
+                comment: '$planCacheStats emits new fields that are not available statically',
+            },
+        },
+        replaceRoot: {
+            'with a Document Nested in an Array': {
+                stage: 1,
+                comment: nestedFieldsExplanation,
+            },
+        },
+        replaceWith: {
+            'a Document Nested in an Array': {
+                stage: 1,
+                comment: nestedFieldsExplanation,
+            },
+        },
+        search: {
+            Example: {
+                stage: 3,
+                comment: '$search emits new fields that are not available statically, such as $$SEARCH_META',
+            },
+            'Number Search and Sort': {
+                stage: 0,
+                comment: nestedFieldsExplanation,
+            },
+            'Return Stored Source Fields': {
+                stage: 1,
+                comment: nestedFieldsExplanation,
+            },
+        },
+        set: {
+            'Using Two $set Stages': {
+                stage: 1,
+                comment: 'second $set stage references fields created in the first',
+            },
+        },
+        unset: {
+            'Remove Embedded Fields': {
+                stage: 0,
+                comment: nestedFieldsExplanation,
+            },
+        },
+        unwind: {
+            'Unwind Embedded Arrays': {
+                stage: 1,
+                comment: nestedFieldsExplanation,
+            },
+        },
+    },
+};
+//# sourceMappingURL=unsupported-aggregations.js.map

package/dist/testGenerator/unsupported-aggregations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"unsupported-aggregations.js","sourceRoot":"","sources":["../../src/testGenerator/unsupported-aggregations.ts"],"names":[],"mappings":";;;AAAA,MAAM,uBAAuB,GAC3B,oEAAoE,CAAC;AAE1D,QAAA,uBAAuB,GAMhC;IACF,WAAW,EAAE;QACX,UAAU,EAAE;YACV,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE;SACtB;KACF;IACD,UAAU,EAAE;QACV,aAAa,EAAE;YACb,CAAC,2CAA2C,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE;SAC5D;QACD,OAAO,EAAE;YACP,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE;SACtB;QACD,QAAQ,EAAE;YACR,cAAc,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE;SAC7B;QACD,YAAY,EAAE;YACZ,0BAA0B,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE;SACzC;QACD,GAAG,EAAE;YACH,OAAO,EAAE;gBACP,KAAK,EAAE,CAAC;gBACR,OAAO,EACL,kEAAkE;aACrE;SACF;QACD,GAAG,EAAE;YACH,iCAAiC,EAAE;gBACjC,KAAK,EAAE,CAAC;gBACR,OAAO,EACL,iGAAiG;aACpG;YACD,6BAA6B,EAAE;gBAC7B,KAAK,EAAE,CAAC;gBACR,OAAO,EACL,iGAAiG;aACpG;YACD,4CAA4C,EAAE;gBAC5C,KAAK,EAAE,CAAC;gBACR,OAAO,EACL,iGAAiG;aACpG;SACF;QACD,aAAa,EAAE;YACb,qCAAqC,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE;SACpD;QACD,GAAG,EAAE;YACH,OAAO,EAAE;gBACP,KAAK,EAAE,CAAC;gBACR,OAAO,EAAE,uBAAuB;aACjC;SACF;QACD,MAAM,EAAE;YACN,cAAc,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE;YAC5B,iCAAiC,EAAE;gBACjC,KAAK,EAAE,CAAC;gBACR,OAAO,EAAE,uBAAuB;aACjC;SACF;QACD,YAAY,EAAE;YACZ,2CAA2C,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE;SAC1D;QACD,eAAe,EAAE;YACf,0DAA0D,EAAE;gBAC1D,KAAK,EAAE,CAAC;gBACR,OAAO,EAAE,uBAAuB;aACjC;SACF;QACD,KAAK,EAAE;YACL,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE;SACtB;QACD,IAAI,EAAE;YACJ,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,uBAAuB,EAAE;SACxD;QACD,SAAS,EAAE;YACT,uBAAuB,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,uBAAuB,EAAE;SACxE;QACD,MAAM,EAAE;YACN,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE;SACtB;QACD,GAAG,EAAE;YACH,kCAAkC,EAAE;gBAClC,KAAK,EAAE,CAAC;gBACR,OAAO,EAAE,uBAAuB;aACjC;SACF;KACF;IACD,KAAK,EAAE;QACL,EAAE,EAAE;YACF,2CAA2C,EAAE;gBAC3C,KAAK,EAAE,CAAC;gBACR,OAAO,EAAE,uBAAuB;aACjC;SACF;QACD,IAAI,EAAE;YACJ,+BAA+B,EAAE;gBAC/B,KAAK,EAAE,CAAC;gBACR,OAAO,EAAE,uBAAuB;aACjC;SACF;KACF;IACD,MAAM,EAAE;QACN,gBAAgB,EAAE;YAChB,4CAA4C,EAAE;gBAC5C,KAAK,EAAE,CAAC;gBACR,OAAO,EAAE,uBAAuB;aACjC;YACD,KAAK,EAAE;gBACL,KAAK,EAAE,CAAC;gBACR,OAAO,EAAE,uBAAuB;aACjC;YACD,KAAK,EAAE;gBACL,KAAK,EAAE,CAAC;gBACR,OAAO,EAAE,uBAAuB;aACjC;YACD,CAAC,gBAAgB,CAAC,EAAE;gBAClB,KAAK,EAAE,CAAC;gBACR,OAAO,EAAE,uBAAuB;aACjC;SACF;QACD,KAAK,EAAE;YACL,KAAK,EAAE;gBACL,KAAK,EAAE,CAAC;gBACR,OAAO,EACL,8EAA8E;aACjF;SACF;QACD,QAAQ,EAAE;YACR,QAAQ,EAAE;gBACR,KAAK,EAAE,CAAC;gBACR,OAAO,EAAE,uBAAuB;aACjC;YACD,SAAS,EAAE;gBACT,KAAK,EAAE,CAAC;gBACR,OAAO,EAAE,uBAAuB;aACjC;YACD,MAAM,EAAE;gBACN,KAAK,EAAE,CAAC;gBACR,OAAO,EAAE,uBAAuB;aACjC;SACF;QACD,MAAM,EAAE;YACN,QAAQ,EAAE;gBACR,KAAK,EAAE,CAAC;gBACR,OAAO,EAAE,uBAAuB;aACjC;SACF;QACD,SAAS,EAAE;YACT,GAAG,EAAE;gBACH,KAAK,EAAE,CAAC;gBACR,OAAO,EAAE,uBAAuB;aACjC;YACD,MAAM,EAAE;gBACN,KAAK,EAAE,CAAC;gBACR,OAAO,EAAE,uBAAuB;aACjC;YACD,QAAQ,EAAE;gBACR,KAAK,EAAE,CAAC;gBACR,OAAO,EAAE,uBAAuB;aACjC;SACF;QACD,IAAI,EAAE;YACJ,CAAC,eAAe,CAAC,EAAE;gBACjB,KAAK,EAAE,CAAC;gBACR,OAAO,EAAE,uBAAuB;aACjC;YACD,QAAQ,EAAE;gBACR,KAAK,EAAE,CAAC;gBACR,OAAO,EAAE,uBAAuB;aACjC;SACF;KACF;IACD,KAAK,EAAE;QACL,SAAS,EAAE;YACT,6BAA6B,EAAE;gBAC7B,KAAK,EAAE,CAAC;aACT;SACF;QACD,MAAM,EAAE;YACN,6CAA6C,EAAE;gBAC7C,KAAK,EAAE,CAAC;gBACR,OAAO,EACL,8FAA8F;aACjG;SACF;QACD,SAAS,EAAE;YACT,mBAAmB,EAAE;gBACnB,KAAK,EAAE,CAAC;gBACR,OAAO,EACL,+DAA+D;aAClE;YACD,iBAAiB,EAAE;gBACjB,KAAK,EAAE,CAAC;gBACR,OAAO,EACL,+DAA+D;aAClE;SACF;QACD,KAAK,EAAE;YACL,sBAAsB,EAAE;gBACtB,KAAK,EAAE,CAAC;aACT;YACD,2BAA2B,EAAE;gBAC3B,KAAK,EAAE,CAAC;aACT;SACF;QACD,cAAc,EAAE;YACd,2CAA2C,EAAE;gBAC3C,KAAK,EAAE,CAAC;gBACR,OAAO,EACL,oEAAoE;aACvE;SACF;QACD,WAAW,EAAE;YACX,oCAAoC,EAAE;gBACpC,KAAK,EAAE,CAAC;gBACR,OAAO,EAAE,uBAAuB;aACjC;SACF;QACD,WAAW,EAAE;YACX,+BAA+B,EAAE;gBAC/B,KAAK,EAAE,CAAC;gBACR,OAAO,EAAE,uBAAuB;aACjC;SACF;QACD,MAAM,EAAE;YACN,OAAO,EAAE;gBACP,KAAK,EAAE,CAAC;gBACR,OAAO,EACL,mFAAmF;aACtF;YACD,wBAAwB,EAAE;gBACxB,KAAK,EAAE,CAAC;gBACR,OAAO,EAAE,uBAAuB;aACjC;YACD,6BAA6B,EAAE;gBAC7B,KAAK,EAAE,CAAC;gBACR,OAAO,EAAE,uBAAuB;aACjC;SACF;QACD,GAAG,EAAE;YACH,uBAAuB,EAAE;gBACvB,KAAK,EAAE,CAAC;gBACR,OAAO,EAAE,0DAA0D;aACpE;SACF;QACD,KAAK,EAAE;YACL,wBAAwB,EAAE;gBACxB,KAAK,EAAE,CAAC;gBACR,OAAO,EAAE,uBAAuB;aACjC;SACF;QACD,MAAM,EAAE;YACN,wBAAwB,EAAE;gBACxB,KAAK,EAAE,CAAC;gBACR,OAAO,EAAE,uBAAuB;aACjC;SACF;KACF;CACF,CAAC"}

package/dist/utils.d.ts

@@ -0,0 +1,9 @@
+export declare class StringWriter {
+    private buffer;
+    write(text: string): void;
+    toString(): string;
+}
+export declare function capitalize(str: string): string;
+export declare function removeNewlines(str: string): string;
+export declare function removeTrailingComments(str: string): string;
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,qBAAa,YAAY;IACvB,OAAO,CAAC,MAAM,CAAM;IAEb,KAAK,CAAC,IAAI,EAAE,MAAM;IAIlB,QAAQ;CAGhB;AAED,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE9C;AAED,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAElD;AAED,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE1D"}

package/dist/utils.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StringWriter = void 0;
+exports.capitalize = capitalize;
+exports.removeNewlines = removeNewlines;
+exports.removeTrailingComments = removeTrailingComments;
+class StringWriter {
+    constructor() {
+        this.buffer = '';
+    }
+    write(text) {
+        this.buffer += text;
+    }
+    toString() {
+        return this.buffer;
+    }
+}
+exports.StringWriter = StringWriter;
+function capitalize(str) {
+    return str[0].toUpperCase() + str.slice(1);
+}
+function removeNewlines(str) {
+    return str.replace(/\r?\n|\r/gm, '');
+}
+function removeTrailingComments(str) {
+    return str.replace(/\/\/.*\r?\n/gm, '');
+}
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;AAYA,gCAEC;AAED,wCAEC;AAED,wDAEC;AAtBD,MAAa,YAAY;IAAzB;QACU,WAAM,GAAG,EAAE,CAAC;IAStB,CAAC;IAPQ,KAAK,CAAC,IAAY;QACvB,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC;IACtB,CAAC;IAEM,QAAQ;QACb,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;CACF;AAVD,oCAUC;AAED,SAAgB,UAAU,CAAC,GAAW;IACpC,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAC7C,CAAC;AAED,SAAgB,cAAc,CAAC,GAAW;IACxC,OAAO,GAAG,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;AACvC,CAAC;AAED,SAAgB,sBAAsB,CAAC,GAAW;IAChD,OAAO,GAAG,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;AAC1C,CAAC"}

package/package.json

@@ -0,0 +1,89 @@
+{
+  "name": "@mongodb-js/mql-typescript",
+  "description": "TS definitions for the MongoDB aggregation API",
+  "author": {
+    "name": "MongoDB Inc",
+    "email": "compass@mongodb.com"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "bugs": {
+    "url": "https://jira.mongodb.org/projects/COMPASS/issues",
+    "email": "compass@mongodb.com"
+  },
+  "homepage": "https://github.com/mongodb-js/devtools-shared",
+  "version": "0.2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mongodb-js/devtools-shared.git"
+  },
+  "files": [
+    "dist",
+    "bin"
+  ],
+  "bin": {
+    "mql-typescript": "bin/runner.js"
+  },
+  "license": "Apache-2.0",
+  "main": "dist/index.js",
+  "exports": {
+    "./schema": {
+      "types": "./dist/schema/schema.d.ts"
+    }
+  },
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "bootstrap": "npm run compile",
+    "prepublishOnly": "npm run compile",
+    "compile": "tsc -p tsconfig.json && gen-esm-wrapper . ./dist/.esm-wrapper.mjs",
+    "typecheck": "tsc --noEmit",
+    "eslint": "eslint",
+    "prettier": "prettier",
+    "lint": "npm run eslint . && npm run prettier -- --check .",
+    "depcheck": "depcheck",
+    "check": "npm run typecheck && npm run lint && npm run depcheck",
+    "check-ci": "npm run check",
+    "test": "tsc --noEmit tests/**/*.ts",
+    "reformat": "npm run prettier -- --write .",
+    "extract-metaschema": "json-refs resolve mongo-php-library/generator/config/schema.json | json-schema-to-zod -n Operator -o src/metaschema.ts && npm run prettier -- --write src/metaschema.ts",
+    "pregenerate-schema": "npm run extract-metaschema",
+    "generate-schema": "ts-node src/cli.ts schema",
+    "postgenerate-schema": "npm run prettier -- --write out/*",
+    "pregenerate-tests": "npm run extract-metaschema",
+    "generate-tests": "ts-node src/cli.ts tests",
+    "postgenerate-tests": "npm run prettier -- --write tests/**/*.ts",
+    "pregenerate-driver-schema": "npm run extract-metaschema",
+    "generate-driver-schema": "ts-node src/cli.ts driver-schema",
+    "postgenerate-driver-schema": "yamlfix -c mongo-php-library/generator/config/.yamlfix.toml mongo-php-library/generator/config",
+    "format-generated-files": "npm run postgenerate-schema && npm run postgenerate-tests && npm run postgenerate-driver-schema"
+  },
+  "devDependencies": {
+    "@mongodb-js/eslint-config-devtools": "0.9.11",
+    "@mongodb-js/prettier-config-devtools": "^1.0.2",
+    "@mongodb-js/shell-bson-parser": "^1.3.0",
+    "@mongodb-js/tsconfig-devtools": "^1.0.3",
+    "@types/chai": "^4.2.21",
+    "@types/js-yaml": "^4.0.9",
+    "@types/jsdom": "^21.1.7",
+    "@types/node": "^22.15.30",
+    "depcheck": "^1.4.7",
+    "eslint": "^7.25.0",
+    "gen-esm-wrapper": "^1.1.3",
+    "js-yaml": "^4.1.0",
+    "jsdom": "^24.1.3",
+    "json-refs": "^3.0.15",
+    "json-schema-to-zod": "^2.6.0",
+    "mongodb-schema": "^12.6.2",
+    "prettier": "^3.5.3",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.0.4",
+    "yargs": "^17.7.2",
+    "zod": "^3.24.2"
+  },
+  "dependencies": {
+    "bson": "^6.10.3",
+    "mongodb": "^6.9.0"
+  },
+  "gitHead": "005f6263e3a329d916f6936c9adcf35db47cfe9f"
+}