@documentdb-js/schema-analyzer 0.8.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+    MIT License
+
+    Copyright (c) Microsoft Corporation. All rights reserved.
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE

package/README.md

@@ -0,0 +1,50 @@
+# @documentdb-js/schema-analyzer
+
+[DocumentDB](https://documentdb.io/) is an open-source document database built on PostgreSQL, with native BSON support, rich indexing, and vector search. It uses the MongoDB-compatible wire protocol, runs locally with Docker, and is MIT licensed.
+
+This package is an incremental JSON Schema analyzer for DocumentDB and MongoDB API documents. Processes documents one at a time (or in batches) and produces an extended JSON Schema with statistical metadata — field occurrence counts, BSON type distributions, min/max values, and array length stats.
+
+> **Pre-1.0 notice** — The API may change between minor versions until `1.0.0` is released.
+> If you depend on this package and need stability guarantees sooner, please
+> [open an issue](https://github.com/microsoft/vscode-documentdb/issues) and let us know.
+
+## Features
+
+- **Incremental analysis** — add documents one at a time or in batches; the schema updates in place.
+- **BSON type awareness** — recognizes BSON types defined by the MongoDB API (`ObjectId`, `Decimal128`, `Binary`, `UUID`, etc.) and annotates them with `x-bsonType`.
+- **Statistical extensions** — tracks field occurrence (`x-occurrence`), type frequency (`x-typeOccurrence`), min/max values, string lengths, array sizes, and document counts (`x-documentsInspected`).
+- **Known fields extraction** — derives a flat list of known field paths with their types and occurrence probabilities, useful for autocomplete and UI rendering.
+- **Version tracking & caching** — a monotonic version counter enables efficient cache invalidation for derived data like `getKnownFields()`.
+
+## Installation
+
+```bash
+npm install @documentdb-js/schema-analyzer
+```
+
+Requires `mongodb` ≥ 6.0.0 as a peer dependency.
+
+## Usage
+
+```typescript
+import { SchemaAnalyzer } from '@documentdb-js/schema-analyzer';
+
+// Create an analyzer and feed it documents
+const analyzer = new SchemaAnalyzer();
+analyzer.addDocument(doc1);
+analyzer.addDocuments([doc2, doc3, doc4]);
+
+// Get the JSON Schema with statistical extensions
+const schema = analyzer.getSchema();
+
+// Get a flat list of known fields (cached, version-aware)
+const fields = analyzer.getKnownFields();
+```
+
+## Origin
+
+This package was developed while building features for the [DocumentDB VS Code extension](https://github.com/microsoft/vscode-documentdb), which remains the primary consumer. The analyzer is designed to work with any JSON/BSON documents and can be used independently in other tooling.
+
+## License
+
+[MIT](LICENSE.md)

package/dist/BSONTypes.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Represents the different data types that can be stored in a DocumentDB API / MongoDB API document.
+ * The string representation is case-sensitive and should match the MongoDB API documentation.
+ * https://www.mongodb.com/docs/manual/reference/bson-types/
+ */
+export declare enum BSONTypes {
+    String = "string",
+    Number = "number",
+    Int32 = "int32",
+    Double = "double",
+    Decimal128 = "decimal128",
+    Long = "long",
+    Boolean = "boolean",
+    Object = "object",
+    Array = "array",
+    Null = "null",
+    Undefined = "undefined",
+    Date = "date",
+    RegExp = "regexp",
+    Binary = "binary",
+    ObjectId = "objectid",
+    Symbol = "symbol",
+    Timestamp = "timestamp",
+    UUID = "uuid",
+    UUID_LEGACY = "uuid-legacy",// old UUID subtype, used in some legacy data
+    MinKey = "minkey",
+    MaxKey = "maxkey",
+    DBRef = "dbref",
+    Code = "code",
+    CodeWithScope = "codewithscope",
+    Map = "map",
+    _UNKNOWN_ = "_unknown_"
+}
+export declare namespace BSONTypes {
+    function toDisplayString(type: BSONTypes): string;
+    function toString(type: BSONTypes): string;
+    /**
+     * Converts a MongoDB API data type to a case-sensitive JSON data type
+     * @param type The MongoDB API data type
+     * @returns A corresponding JSON data type (please note: it's case sensitive)
+     */
+    function toJSONType(type: BSONTypes): string;
+    /**
+     * Accepts a value from a MongoDB API `Document` object and returns the inferred type.
+     * @param value The value of a field in a MongoDB API `Document` object
+     * @returns
+     */
+    function inferType(value: unknown): BSONTypes;
+}
+//# sourceMappingURL=BSONTypes.d.ts.map

package/dist/BSONTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BSONTypes.d.ts","sourceRoot":"","sources":["../src/BSONTypes.ts"],"names":[],"mappings":"AAqBA;;;;GAIG;AACH,oBAAY,SAAS;IACjB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,UAAU,eAAe;IACzB,IAAI,SAAS;IACb,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,IAAI,SAAS;IACb,SAAS,cAAc;IACvB,IAAI,SAAS;IACb,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,SAAS,cAAc;IACvB,IAAI,SAAS;IACb,WAAW,gBAAgB,CAAE,6CAA6C;IAC1E,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,IAAI,SAAS;IACb,aAAa,kBAAkB;IAC/B,GAAG,QAAQ;IAEX,SAAS,cAAc;CAC1B;AAED,yBAAiB,SAAS,CAAC;IA8BvB,SAAgB,eAAe,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,CAEvD;IAED,SAAgB,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,CAEhD;IAED;;;;OAIG;IACH,SAAgB,UAAU,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,CAyClD;IAED;;;;OAIG;IACH,SAAgB,SAAS,CAAC,KAAK,EAAE,OAAO,GAAG,SAAS,CAkDnD;CACJ"}

package/dist/BSONTypes.js

@@ -0,0 +1,196 @@
+"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 });
+exports.BSONTypes = void 0;
+const mongodb_1 = require("mongodb");
+/**
+ * Represents the different data types that can be stored in a DocumentDB API / MongoDB API document.
+ * The string representation is case-sensitive and should match the MongoDB API documentation.
+ * https://www.mongodb.com/docs/manual/reference/bson-types/
+ */
+var BSONTypes;
+(function (BSONTypes) {
+    BSONTypes["String"] = "string";
+    BSONTypes["Number"] = "number";
+    BSONTypes["Int32"] = "int32";
+    BSONTypes["Double"] = "double";
+    BSONTypes["Decimal128"] = "decimal128";
+    BSONTypes["Long"] = "long";
+    BSONTypes["Boolean"] = "boolean";
+    BSONTypes["Object"] = "object";
+    BSONTypes["Array"] = "array";
+    BSONTypes["Null"] = "null";
+    BSONTypes["Undefined"] = "undefined";
+    BSONTypes["Date"] = "date";
+    BSONTypes["RegExp"] = "regexp";
+    BSONTypes["Binary"] = "binary";
+    BSONTypes["ObjectId"] = "objectid";
+    BSONTypes["Symbol"] = "symbol";
+    BSONTypes["Timestamp"] = "timestamp";
+    BSONTypes["UUID"] = "uuid";
+    BSONTypes["UUID_LEGACY"] = "uuid-legacy";
+    BSONTypes["MinKey"] = "minkey";
+    BSONTypes["MaxKey"] = "maxkey";
+    BSONTypes["DBRef"] = "dbref";
+    BSONTypes["Code"] = "code";
+    BSONTypes["CodeWithScope"] = "codewithscope";
+    BSONTypes["Map"] = "map";
+    // Add any deprecated types if necessary
+    BSONTypes["_UNKNOWN_"] = "_unknown_";
+})(BSONTypes || (exports.BSONTypes = BSONTypes = {}));
+(function (BSONTypes) {
+    const displayStringMap = {
+        [BSONTypes.String]: 'String',
+        [BSONTypes.Number]: 'Number',
+        [BSONTypes.Int32]: 'Int32',
+        [BSONTypes.Double]: 'Double',
+        [BSONTypes.Decimal128]: 'Decimal128',
+        [BSONTypes.Long]: 'Long',
+        [BSONTypes.Boolean]: 'Boolean',
+        [BSONTypes.Object]: 'Object',
+        [BSONTypes.Array]: 'Array',
+        [BSONTypes.Null]: 'Null',
+        [BSONTypes.Undefined]: 'Undefined',
+        [BSONTypes.Date]: 'Date',
+        [BSONTypes.RegExp]: 'RegExp',
+        [BSONTypes.Binary]: 'Binary',
+        [BSONTypes.ObjectId]: 'ObjectId',
+        [BSONTypes.Symbol]: 'Symbol',
+        [BSONTypes.Timestamp]: 'Timestamp',
+        [BSONTypes.MinKey]: 'MinKey',
+        [BSONTypes.MaxKey]: 'MaxKey',
+        [BSONTypes.DBRef]: 'DBRef',
+        [BSONTypes.Code]: 'Code',
+        [BSONTypes.CodeWithScope]: 'CodeWithScope',
+        [BSONTypes.Map]: 'Map',
+        [BSONTypes._UNKNOWN_]: 'Unknown',
+        [BSONTypes.UUID]: 'UUID',
+        [BSONTypes.UUID_LEGACY]: 'UUID (Legacy)',
+    };
+    function toDisplayString(type) {
+        return displayStringMap[type] || 'Unknown';
+    }
+    BSONTypes.toDisplayString = toDisplayString;
+    function toString(type) {
+        return type;
+    }
+    BSONTypes.toString = toString;
+    /**
+     * Converts a MongoDB API data type to a case-sensitive JSON data type
+     * @param type The MongoDB API data type
+     * @returns A corresponding JSON data type (please note: it's case sensitive)
+     */
+    function toJSONType(type) {
+        switch (type) {
+            case BSONTypes.String:
+            case BSONTypes.Symbol:
+            case BSONTypes.Date:
+            case BSONTypes.Timestamp:
+            case BSONTypes.ObjectId:
+            case BSONTypes.RegExp:
+            case BSONTypes.Binary:
+            case BSONTypes.Code:
+            case BSONTypes.UUID:
+            case BSONTypes.UUID_LEGACY:
+                return 'string';
+            case BSONTypes.Boolean:
+                return 'boolean';
+            case BSONTypes.Int32:
+            case BSONTypes.Long:
+            case BSONTypes.Double:
+            case BSONTypes.Decimal128:
+                return 'number';
+            case BSONTypes.Object:
+            case BSONTypes.Map:
+            case BSONTypes.DBRef:
+            case BSONTypes.CodeWithScope:
+                return 'object';
+            case BSONTypes.Array:
+                return 'array';
+            case BSONTypes.Null:
+            case BSONTypes.Undefined:
+            case BSONTypes.MinKey:
+            case BSONTypes.MaxKey:
+                return 'null';
+            default:
+                return 'string'; // Default to string for unknown types
+        }
+    }
+    BSONTypes.toJSONType = toJSONType;
+    /**
+     * Accepts a value from a MongoDB API `Document` object and returns the inferred type.
+     * @param value The value of a field in a MongoDB API `Document` object
+     * @returns
+     */
+    function inferType(value) {
+        if (value === null)
+            return BSONTypes.Null;
+        if (value === undefined)
+            return BSONTypes.Undefined;
+        switch (typeof value) {
+            case 'string':
+                return BSONTypes.String;
+            case 'number':
+                return BSONTypes.Double; // JavaScript numbers are doubles
+            case 'boolean':
+                return BSONTypes.Boolean;
+            case 'object':
+                if (Array.isArray(value)) {
+                    return BSONTypes.Array;
+                }
+                // Check for common BSON types first
+                if (value instanceof mongodb_1.ObjectId)
+                    return BSONTypes.ObjectId;
+                if (value instanceof mongodb_1.Int32)
+                    return BSONTypes.Int32;
+                if (value instanceof mongodb_1.Double)
+                    return BSONTypes.Double;
+                if (value instanceof Date)
+                    return BSONTypes.Date;
+                if (value instanceof mongodb_1.Timestamp)
+                    return BSONTypes.Timestamp;
+                // Less common types
+                if (value instanceof mongodb_1.Decimal128)
+                    return BSONTypes.Decimal128;
+                if (value instanceof mongodb_1.Long)
+                    return BSONTypes.Long;
+                if (value instanceof mongodb_1.MinKey)
+                    return BSONTypes.MinKey;
+                if (value instanceof mongodb_1.MaxKey)
+                    return BSONTypes.MaxKey;
+                if (value instanceof mongodb_1.BSONSymbol)
+                    return BSONTypes.Symbol;
+                if (value instanceof mongodb_1.DBRef)
+                    return BSONTypes.DBRef;
+                if (value instanceof Map)
+                    return BSONTypes.Map;
+                if (value instanceof mongodb_1.UUID && value.sub_type === mongodb_1.Binary.SUBTYPE_UUID)
+                    return BSONTypes.UUID;
+                if (value instanceof mongodb_1.UUID && value.sub_type === mongodb_1.Binary.SUBTYPE_UUID_OLD)
+                    return BSONTypes.UUID_LEGACY;
+                if (value instanceof Buffer || value instanceof mongodb_1.Binary)
+                    return BSONTypes.Binary;
+                if (value instanceof RegExp)
+                    return BSONTypes.RegExp;
+                if (value instanceof mongodb_1.Code) {
+                    if (value.scope) {
+                        return BSONTypes.CodeWithScope;
+                    }
+                    else {
+                        return BSONTypes.Code;
+                    }
+                }
+                // Default to Object if none of the above match
+                return BSONTypes.Object;
+            default:
+                // This should never happen, but if it does, we'll catch it here
+                // TODO: add telemetry somewhere to know when it happens (not here, this could get hit too often)
+                return BSONTypes._UNKNOWN_;
+        }
+    }
+    BSONTypes.inferType = inferType;
+})(BSONTypes || (exports.BSONTypes = BSONTypes = {}));
+//# sourceMappingURL=BSONTypes.js.map

package/dist/BSONTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BSONTypes.js","sourceRoot":"","sources":["../src/BSONTypes.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAEhG,qCAciB;AAEjB;;;;GAIG;AACH,IAAY,SA4BX;AA5BD,WAAY,SAAS;IACjB,8BAAiB,CAAA;IACjB,8BAAiB,CAAA;IACjB,4BAAe,CAAA;IACf,8BAAiB,CAAA;IACjB,sCAAyB,CAAA;IACzB,0BAAa,CAAA;IACb,gCAAmB,CAAA;IACnB,8BAAiB,CAAA;IACjB,4BAAe,CAAA;IACf,0BAAa,CAAA;IACb,oCAAuB,CAAA;IACvB,0BAAa,CAAA;IACb,8BAAiB,CAAA;IACjB,8BAAiB,CAAA;IACjB,kCAAqB,CAAA;IACrB,8BAAiB,CAAA;IACjB,oCAAuB,CAAA;IACvB,0BAAa,CAAA;IACb,wCAA2B,CAAA;IAC3B,8BAAiB,CAAA;IACjB,8BAAiB,CAAA;IACjB,4BAAe,CAAA;IACf,0BAAa,CAAA;IACb,4CAA+B,CAAA;IAC/B,wBAAW,CAAA;IACX,wCAAwC;IACxC,oCAAuB,CAAA;AAC3B,CAAC,EA5BW,SAAS,yBAAT,SAAS,QA4BpB;AAED,WAAiB,SAAS;IACtB,MAAM,gBAAgB,GAA8B;QAChD,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,QAAQ;QAC5B,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,QAAQ;QAC5B,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,OAAO;QAC1B,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,QAAQ;QAC5B,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,YAAY;QACpC,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,MAAM;QACxB,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,SAAS;QAC9B,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,QAAQ;QAC5B,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,OAAO;QAC1B,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,MAAM;QACxB,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,WAAW;QAClC,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,MAAM;QACxB,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,QAAQ;QAC5B,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,QAAQ;QAC5B,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,UAAU;QAChC,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,QAAQ;QAC5B,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,WAAW;QAClC,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,QAAQ;QAC5B,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,QAAQ;QAC5B,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,OAAO;QAC1B,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,MAAM;QACxB,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,eAAe;QAC1C,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,KAAK;QACtB,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,SAAS;QAChC,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,MAAM;QACxB,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,eAAe;KAC3C,CAAC;IAEF,SAAgB,eAAe,CAAC,IAAe;QAC3C,OAAO,gBAAgB,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC;IAC/C,CAAC;IAFe,yBAAe,kBAE9B,CAAA;IAED,SAAgB,QAAQ,CAAC,IAAe;QACpC,OAAO,IAAI,CAAC;IAChB,CAAC;IAFe,kBAAQ,WAEvB,CAAA;IAED;;;;OAIG;IACH,SAAgB,UAAU,CAAC,IAAe;QACtC,QAAQ,IAAI,EAAE,CAAC;YACX,KAAK,SAAS,CAAC,MAAM,CAAC;YACtB,KAAK,SAAS,CAAC,MAAM,CAAC;YACtB,KAAK,SAAS,CAAC,IAAI,CAAC;YACpB,KAAK,SAAS,CAAC,SAAS,CAAC;YACzB,KAAK,SAAS,CAAC,QAAQ,CAAC;YACxB,KAAK,SAAS,CAAC,MAAM,CAAC;YACtB,KAAK,SAAS,CAAC,MAAM,CAAC;YACtB,KAAK,SAAS,CAAC,IAAI,CAAC;YACpB,KAAK,SAAS,CAAC,IAAI,CAAC;YACpB,KAAK,SAAS,CAAC,WAAW;gBACtB,OAAO,QAAQ,CAAC;YAEpB,KAAK,SAAS,CAAC,OAAO;gBAClB,OAAO,SAAS,CAAC;YAErB,KAAK,SAAS,CAAC,KAAK,CAAC;YACrB,KAAK,SAAS,CAAC,IAAI,CAAC;YACpB,KAAK,SAAS,CAAC,MAAM,CAAC;YACtB,KAAK,SAAS,CAAC,UAAU;gBACrB,OAAO,QAAQ,CAAC;YAEpB,KAAK,SAAS,CAAC,MAAM,CAAC;YACtB,KAAK,SAAS,CAAC,GAAG,CAAC;YACnB,KAAK,SAAS,CAAC,KAAK,CAAC;YACrB,KAAK,SAAS,CAAC,aAAa;gBACxB,OAAO,QAAQ,CAAC;YAEpB,KAAK,SAAS,CAAC,KAAK;gBAChB,OAAO,OAAO,CAAC;YAEnB,KAAK,SAAS,CAAC,IAAI,CAAC;YACpB,KAAK,SAAS,CAAC,SAAS,CAAC;YACzB,KAAK,SAAS,CAAC,MAAM,CAAC;YACtB,KAAK,SAAS,CAAC,MAAM;gBACjB,OAAO,MAAM,CAAC;YAElB;gBACI,OAAO,QAAQ,CAAC,CAAC,sCAAsC;QAC/D,CAAC;IACL,CAAC;IAzCe,oBAAU,aAyCzB,CAAA;IAED;;;;OAIG;IACH,SAAgB,SAAS,CAAC,KAAc;QACpC,IAAI,KAAK,KAAK,IAAI;YAAE,OAAO,SAAS,CAAC,IAAI,CAAC;QAC1C,IAAI,KAAK,KAAK,SAAS;YAAE,OAAO,SAAS,CAAC,SAAS,CAAC;QAEpD,QAAQ,OAAO,KAAK,EAAE,CAAC;YACnB,KAAK,QAAQ;gBACT,OAAO,SAAS,CAAC,MAAM,CAAC;YAC5B,KAAK,QAAQ;gBACT,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,iCAAiC;YAC9D,KAAK,SAAS;gBACV,OAAO,SAAS,CAAC,OAAO,CAAC;YAC7B,KAAK,QAAQ;gBACT,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBACvB,OAAO,SAAS,CAAC,KAAK,CAAC;gBAC3B,CAAC;gBAED,oCAAoC;gBACpC,IAAI,KAAK,YAAY,kBAAQ;oBAAE,OAAO,SAAS,CAAC,QAAQ,CAAC;gBACzD,IAAI,KAAK,YAAY,eAAK;oBAAE,OAAO,SAAS,CAAC,KAAK,CAAC;gBACnD,IAAI,KAAK,YAAY,gBAAM;oBAAE,OAAO,SAAS,CAAC,MAAM,CAAC;gBACrD,IAAI,KAAK,YAAY,IAAI;oBAAE,OAAO,SAAS,CAAC,IAAI,CAAC;gBACjD,IAAI,KAAK,YAAY,mBAAS;oBAAE,OAAO,SAAS,CAAC,SAAS,CAAC;gBAE3D,oBAAoB;gBACpB,IAAI,KAAK,YAAY,oBAAU;oBAAE,OAAO,SAAS,CAAC,UAAU,CAAC;gBAC7D,IAAI,KAAK,YAAY,cAAI;oBAAE,OAAO,SAAS,CAAC,IAAI,CAAC;gBACjD,IAAI,KAAK,YAAY,gBAAM;oBAAE,OAAO,SAAS,CAAC,MAAM,CAAC;gBACrD,IAAI,KAAK,YAAY,gBAAM;oBAAE,OAAO,SAAS,CAAC,MAAM,CAAC;gBACrD,IAAI,KAAK,YAAY,oBAAU;oBAAE,OAAO,SAAS,CAAC,MAAM,CAAC;gBACzD,IAAI,KAAK,YAAY,eAAK;oBAAE,OAAO,SAAS,CAAC,KAAK,CAAC;gBACnD,IAAI,KAAK,YAAY,GAAG;oBAAE,OAAO,SAAS,CAAC,GAAG,CAAC;gBAC/C,IAAI,KAAK,YAAY,cAAI,IAAI,KAAK,CAAC,QAAQ,KAAK,gBAAM,CAAC,YAAY;oBAAE,OAAO,SAAS,CAAC,IAAI,CAAC;gBAC3F,IAAI,KAAK,YAAY,cAAI,IAAI,KAAK,CAAC,QAAQ,KAAK,gBAAM,CAAC,gBAAgB;oBAAE,OAAO,SAAS,CAAC,WAAW,CAAC;gBACtG,IAAI,KAAK,YAAY,MAAM,IAAI,KAAK,YAAY,gBAAM;oBAAE,OAAO,SAAS,CAAC,MAAM,CAAC;gBAChF,IAAI,KAAK,YAAY,MAAM;oBAAE,OAAO,SAAS,CAAC,MAAM,CAAC;gBACrD,IAAI,KAAK,YAAY,cAAI,EAAE,CAAC;oBACxB,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;wBACd,OAAO,SAAS,CAAC,aAAa,CAAC;oBACnC,CAAC;yBAAM,CAAC;wBACJ,OAAO,SAAS,CAAC,IAAI,CAAC;oBAC1B,CAAC;gBACL,CAAC;gBAED,+CAA+C;gBAC/C,OAAO,SAAS,CAAC,MAAM,CAAC;YAC5B;gBACI,gEAAgE;gBAChE,iGAAiG;gBACjG,OAAO,SAAS,CAAC,SAAS,CAAC;QACnC,CAAC;IACL,CAAC;IAlDe,mBAAS,YAkDxB,CAAA;AACL,CAAC,EA9IgB,SAAS,yBAAT,SAAS,QA8IzB"}

package/dist/JSONSchema.d.ts

@@ -0,0 +1,75 @@
+/**
+ * We're not using the full JSON schema spec, so we're defining a subset of it here.
+ * There is @types/json-schema available, but their support ends at JSON Schema draft-07,
+ * there is another one with vscode-json-languageservice, but then it'd be harder to
+ * extract our code to a separate and independend package in the future.
+ *
+ * Rather than working with an older version of the spec, we're defining a subset of the
+ * spec that we need to work with here.
+ *
+ * The purpose of this JSON schema is to:
+ * 1. Provide input to Monaco
+ * 2. Extract statistical information from the user data
+ * 3. Discover data for different levels of the structure-tree used in the table view
+ */
+export type JSONSchemaRef = JSONSchema | boolean;
+export interface JSONSchema {
+    id?: string;
+    $id?: string;
+    $schema?: string;
+    type?: string | string[];
+    title?: string;
+    description?: string;
+    definitions?: {
+        [name: string]: JSONSchema;
+    };
+    properties?: JSONSchemaMap;
+    patternProperties?: JSONSchemaMap;
+    additionalProperties?: JSONSchemaRef;
+    minProperties?: number;
+    maxProperties?: number;
+    dependencies?: JSONSchemaMap | {
+        [prop: string]: string[];
+    };
+    items?: JSONSchemaRef | JSONSchemaRef[];
+    required?: string[];
+    $ref?: string;
+    anyOf?: JSONSchemaRef[];
+    allOf?: JSONSchemaRef[];
+    oneOf?: JSONSchemaRef[];
+    not?: JSONSchemaRef;
+    enum?: undefined[];
+    format?: string;
+    const?: undefined;
+    contains?: JSONSchemaRef;
+    propertyNames?: JSONSchemaRef;
+    examples?: undefined[];
+    $comment?: string;
+    $defs?: {
+        [name: string]: JSONSchema;
+    };
+    markdownEnumDescriptions?: string[];
+    markdownDescription?: string;
+    doNotSuggest?: boolean;
+    suggestSortText?: string;
+    'x-documentsInspected'?: number;
+    'x-occurrence'?: number;
+    'x-bsonType'?: string;
+    'x-typeOccurrence'?: number;
+    'x-minValue'?: number;
+    'x-maxValue'?: number;
+    'x-minLength'?: number;
+    'x-maxLength'?: number;
+    'x-minDate'?: number;
+    'x-maxDate'?: number;
+    'x-trueCount'?: number;
+    'x-falseCount'?: number;
+    'x-minItems'?: number;
+    'x-maxItems'?: number;
+    'x-minProperties'?: number;
+    'x-maxProperties'?: number;
+}
+export interface JSONSchemaMap {
+    [name: string]: JSONSchemaRef;
+}
+//# sourceMappingURL=JSONSchema.d.ts.map

package/dist/JSONSchema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"JSONSchema.d.ts","sourceRoot":"","sources":["../src/JSONSchema.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;GAaG;AAEH,MAAM,MAAM,aAAa,GAAG,UAAU,GAAG,OAAO,CAAC;AACjD,MAAM,WAAW,UAAU;IACvB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACzB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE;QACV,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,CAAC;KAC9B,CAAC;IAGF,UAAU,CAAC,EAAE,aAAa,CAAC;IAC3B,iBAAiB,CAAC,EAAE,aAAa,CAAC;IAClC,oBAAoB,CAAC,EAAE,aAAa,CAAC;IACrC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EACP,aAAa,GACb;QACI,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;KAC5B,CAAC;IACR,KAAK,CAAC,EAAE,aAAa,GAAG,aAAa,EAAE,CAAC;IACxC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;IACxB,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;IACxB,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;IACxB,GAAG,CAAC,EAAE,aAAa,CAAC;IACpB,IAAI,CAAC,EAAE,SAAS,EAAE,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,QAAQ,CAAC,EAAE,SAAS,EAAE,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE;QACJ,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,CAAC;KAC9B,CAAC;IAGF,wBAAwB,CAAC,EAAE,MAAM,EAAE,CAAC;IACpC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,eAAe,CAAC,EAAE,MAAM,CAAC;IAGzB,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,cAAc,CAAC,EAAE,MAAM,CAAC;IAGxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC9B;AACD,MAAM,WAAW,aAAa;IAC1B,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,CAAC;CACjC"}

package/dist/JSONSchema.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=JSONSchema.js.map

package/dist/JSONSchema.js.map

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

package/dist/SchemaAnalyzer.d.ts

@@ -0,0 +1,71 @@
+import { type Document, type WithId } from 'mongodb';
+import { type JSONSchema } from './JSONSchema';
+import { type FieldEntry } from './getKnownFields';
+/**
+ * Incremental schema analyzer for documents from the MongoDB API / DocumentDB API.
+ *
+ * Analyzes documents one at a time (or in batches) and builds a cumulative
+ * JSON Schema with statistical extensions (x-occurrence, x-bsonType, etc.).
+ *
+ * The output schema follows JSON Schema draft-07 with custom x- extensions.
+ */
+export declare class SchemaAnalyzer {
+    private _schema;
+    private _version;
+    private _knownFieldsCache;
+    private _knownFieldsCacheVersion;
+    /**
+     * A monotonically increasing version counter. Incremented on every mutation
+     * (addDocument, addDocuments, reset). Adapters can store this value alongside
+     * their cached derived data and recompute only when it changes.
+     */
+    get version(): number;
+    /**
+     * Adds a single document to the accumulated schema.
+     * This is the primary incremental API — call once per document.
+     */
+    addDocument(document: WithId<Document>): void;
+    /**
+     * Adds multiple documents to the accumulated schema.
+     * Convenience method equivalent to calling addDocument() for each.
+     * Increments version once for the entire batch — not per document.
+     */
+    addDocuments(documents: ReadonlyArray<WithId<Document>>): void;
+    /**
+     * Returns the current accumulated JSON Schema.
+     * The returned object is a live reference (not a copy) — do not mutate externally.
+     */
+    getSchema(): JSONSchema;
+    /**
+     * Returns the number of documents analyzed so far.
+     */
+    getDocumentCount(): number;
+    /**
+     * Resets the analyzer to its initial empty state.
+     */
+    reset(): void;
+    /**
+     * Creates a deep copy of this analyzer, including all accumulated schema data.
+     * Useful for aggregation stage branching where each stage needs its own schema state.
+     * The clone starts with version 0, independent from the original.
+     */
+    clone(): SchemaAnalyzer;
+    /**
+     * Returns the cached list of known fields (all nesting levels, sorted).
+     * Recomputed only when the schema version has changed since the last call.
+     */
+    getKnownFields(): FieldEntry[];
+    /**
+     * Creates a SchemaAnalyzer from a single document.
+     * Equivalent to creating an instance and calling addDocument() once.
+     */
+    static fromDocument(document: WithId<Document>): SchemaAnalyzer;
+    /**
+     * Creates a SchemaAnalyzer from multiple documents.
+     * Equivalent to creating an instance and calling addDocuments().
+     */
+    static fromDocuments(documents: ReadonlyArray<WithId<Document>>): SchemaAnalyzer;
+}
+export declare function getPropertyNamesAtLevel(jsonSchema: JSONSchema, path: string[]): string[];
+export declare function buildFullPaths(path: string[], propertyNames: string[]): string[];
+//# sourceMappingURL=SchemaAnalyzer.d.ts.map

package/dist/SchemaAnalyzer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaAnalyzer.d.ts","sourceRoot":"","sources":["../src/SchemaAnalyzer.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,MAAM,EAAE,MAAM,SAAS,CAAC;AAGrD,OAAO,EAAE,KAAK,UAAU,EAAsB,MAAM,cAAc,CAAC;AACnE,OAAO,EAAE,KAAK,UAAU,EAA8C,MAAM,kBAAkB,CAAC;AAE/F;;;;;;;GAOG;AACH,qBAAa,cAAc;IACvB,OAAO,CAAC,OAAO,CAAkB;IACjC,OAAO,CAAC,QAAQ,CAAa;IAC7B,OAAO,CAAC,iBAAiB,CAA6B;IACtD,OAAO,CAAC,wBAAwB,CAAc;IAE9C;;;;OAIG;IACH,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED;;;OAGG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAI;IAK7C;;;;OAIG;IACH,YAAY,CAAC,SAAS,EAAE,aAAa,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,IAAI;IAO9D;;;OAGG;IACH,SAAS,IAAI,UAAU;IAIvB;;OAEG;IACH,gBAAgB,IAAI,MAAM;IAI1B;;OAEG;IACH,KAAK,IAAI,IAAI;IAKb;;;;OAIG;IACH,KAAK,IAAI,cAAc;IAMvB;;;OAGG;IACH,cAAc,IAAI,UAAU,EAAE;IAQ9B;;;OAGG;IACH,MAAM,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,GAAG,cAAc;IAM/D;;;OAGG;IACH,MAAM,CAAC,aAAa,CAAC,SAAS,EAAE,aAAa,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,cAAc;CAKnF;AA4bD,wBAAgB,uBAAuB,CAAC,UAAU,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CAiBxF;AAED,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CAEhF"}