@mongosh/shell-bson 1.0.1

package/lib/shell-bson.js

@@ -0,0 +1,213 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.constructShellBson = constructShellBson;
+const errors_1 = require("@mongosh/errors");
+const helpers_1 = require("./helpers");
+const crypto_1 = require("crypto");
+function constructShellBson({ bsonLibrary: bson, printWarning, assignMetadata, constructHelp, }) {
+    const bsonNames = [
+        'Binary',
+        'Code',
+        'DBRef',
+        'Decimal128',
+        'Double',
+        'Int32',
+        'Long',
+        'MaxKey',
+        'MinKey',
+        'ObjectId',
+        'Timestamp',
+        'BSONSymbol',
+        'BSONRegExp',
+    ];
+    const helps = {};
+    for (const className of bsonNames) {
+        if (!(className in bson)) {
+            throw new errors_1.MongoshInternalError(`${className} does not exist in provided BSON package.`);
+        }
+        const help = constructHelp?.(className);
+        helps[className] = help;
+        if (!('prototype' in bson[className]))
+            continue;
+        assignMetadata?.(bson[className].prototype, {
+            help: help,
+            ...(className === 'BSONSymbol'
+                ? { deprecated: true, maxVersion: '1.6.0' }
+                : {}),
+        });
+    }
+    const bsonPkg = {
+        DBRef: (0, helpers_1.assignAll)(function DBRef(namespace, oid, db, fields) {
+            (0, helpers_1.assertArgsDefinedType)([namespace, oid, db], ['string', true, [undefined, 'string'], [undefined, 'object']], 'DBRef');
+            return new bson.DBRef(namespace, oid, db, fields);
+        }, (0, helpers_1.pickWithExactKeyMatch)(bson.DBRef, ['prototype'])),
+        bsonsize: function bsonsize(object) {
+            (0, helpers_1.assertArgsDefinedType)([object], ['object'], 'bsonsize');
+            return bson.calculateObjectSize(object);
+        },
+        MaxKey: (0, helpers_1.assignAll)(function MaxKey() {
+            return new bson.MaxKey();
+        }, (0, helpers_1.pickWithExactKeyMatch)(bson.MaxKey, ['prototype']), { toBSON: () => new bson.MaxKey() }),
+        MinKey: (0, helpers_1.assignAll)(function MinKey() {
+            return new bson.MinKey();
+        }, (0, helpers_1.pickWithExactKeyMatch)(bson.MinKey, ['prototype']), { toBSON: () => new bson.MinKey() }),
+        ObjectId: (0, helpers_1.assignAll)(function ObjectId(id) {
+            (0, helpers_1.assertArgsDefinedType)([id], [[undefined, 'string', 'number', 'object']], 'ObjectId');
+            return new bson.ObjectId(id);
+        }, (0, helpers_1.pickWithExactKeyMatch)(bson.ObjectId, ['prototype', 'cacheHexString', 'generate', 'createFromTime', 'createFromHexString', 'createFromBase64', 'isValid'])),
+        Timestamp: (0, helpers_1.assignAll)(function Timestamp(t, i) {
+            (0, helpers_1.assertArgsDefinedType)([t, i], [
+                ['number', 'object', undefined],
+                [undefined, 'number'],
+            ], 'Timestamp');
+            if (typeof t === 'object' && t !== null && 't' in t && 'i' in t) {
+                return new bson.Timestamp(t);
+            }
+            else if (i !== undefined || typeof t === 'number') {
+                return new bson.Timestamp({ t: t, i: i ?? 0 });
+            }
+            return new bson.Timestamp(t);
+        }, (0, helpers_1.pickWithExactKeyMatch)(bson.Timestamp, ['prototype', 'fromInt', 'fromNumber', 'fromBits', 'fromString', 'MAX_VALUE'])),
+        Code: (0, helpers_1.assignAll)(function Code(c = '', s) {
+            (0, helpers_1.assertArgsDefinedType)([c, s], [
+                [undefined, 'string', 'function'],
+                [undefined, 'object'],
+            ], 'Code');
+            return new bson.Code(c, s);
+        }, (0, helpers_1.pickWithExactKeyMatch)(bson.Code, ['prototype'])),
+        NumberDecimal: (0, helpers_1.assignAll)(function NumberDecimal(s = '0') {
+            (0, helpers_1.assertArgsDefinedType)([s], [['string', 'number', 'bson:Long', 'bson:Int32', 'bson:Decimal128']], 'NumberDecimal');
+            if (typeof s === 'number') {
+                printWarning('NumberDecimal: specifying a number as argument is deprecated and may lead to loss of precision, pass a string instead');
+            }
+            return bson.Decimal128.fromString(`${s}`);
+        }, { prototype: bson.Decimal128.prototype }),
+        NumberInt: (0, helpers_1.assignAll)(function NumberInt(v = '0') {
+            v ?? (v = '0');
+            (0, helpers_1.assertArgsDefinedType)([v], [['string', 'number', 'bson:Long', 'bson:Int32']], 'NumberInt');
+            return new bson.Int32(parseInt(`${v}`, 10));
+        }, { prototype: bson.Int32.prototype }),
+        NumberLong: (0, helpers_1.assignAll)(function NumberLong(s = '0') {
+            s ?? (s = '0');
+            (0, helpers_1.assertArgsDefinedType)([s], [['string', 'number', 'bson:Long', 'bson:Int32']], 'NumberLong');
+            if (typeof s === 'number') {
+                printWarning('NumberLong: specifying a number as argument is deprecated and may lead to loss of precision, pass a string instead');
+                return bson.Long.fromNumber(s);
+            }
+            return bson.Long.fromString(`${s}`);
+        }, { prototype: bson.Long.prototype }),
+        ISODate: function ISODate(input) {
+            if (input === undefined)
+                return new Date();
+            if (typeof input !== 'string')
+                return new Date(input);
+            const isoDateRegex = /^(?<Y>\d{4})-?(?<M>\d{2})-?(?<D>\d{2})([T ](?<h>\d{2})(:?(?<m>\d{2})(:?((?<s>\d{2})(\.(?<ms>\d+))?))?)?(?<tz>Z|([+-])(\d{2}):?(\d{2})?)?)?$/;
+            const match = isoDateRegex.exec(input);
+            if (match !== null && match.groups !== undefined) {
+                const { Y, M, D, h, m, s, ms, tz } = match.groups;
+                const normalized = `${Y}-${M}-${D}T${h || '00'}:${m || '00'}:${s || '00'}.${ms || '000'}${tz || 'Z'}`;
+                const date = new Date(normalized);
+                if (date.getTime() >= -62167219200000 &&
+                    date.getTime() <= 253402300799999) {
+                    return date;
+                }
+            }
+            throw new errors_1.MongoshInvalidInputError(`${JSON.stringify(input)} is not a valid ISODate`, errors_1.CommonErrors.InvalidArgument);
+        },
+        BinData: (0, helpers_1.assignAll)(function BinData(subtype, b64string) {
+            (0, helpers_1.assertArgsDefinedType)([subtype, b64string], ['number', 'string'], 'BinData');
+            const buffer = Buffer.from(b64string, 'base64');
+            return new bson.Binary(buffer, subtype);
+        }, { prototype: bson.Binary.prototype }),
+        HexData: (0, helpers_1.assignAll)(function HexData(subtype, hexstr) {
+            (0, helpers_1.assertArgsDefinedType)([subtype, hexstr], ['number', 'string'], 'HexData');
+            const buffer = Buffer.from(hexstr, 'hex');
+            return new bson.Binary(buffer, subtype);
+        }, { prototype: bson.Binary.prototype }),
+        UUID: (0, helpers_1.assignAll)(function UUID(hexstr) {
+            if (hexstr === undefined) {
+                const uuid = (0, crypto_1.randomBytes)(16);
+                uuid[6] = (uuid[6] & 0x0f) | 0x40;
+                uuid[8] = (uuid[8] & 0x3f) | 0x80;
+                hexstr = uuid.toString('hex');
+            }
+            (0, helpers_1.assertArgsDefinedType)([hexstr], ['string'], 'UUID');
+            const buffer = Buffer.from(hexstr.replace(/-/g, ''), 'hex');
+            return new bson.Binary(buffer, bson.Binary.SUBTYPE_UUID);
+        }, { prototype: bson.Binary.prototype }),
+        MD5: (0, helpers_1.assignAll)(function MD5(hexstr) {
+            (0, helpers_1.assertArgsDefinedType)([hexstr], ['string'], 'MD5');
+            const buffer = Buffer.from(hexstr, 'hex');
+            return new bson.Binary(buffer, bson.Binary.SUBTYPE_MD5);
+        }, { prototype: bson.Binary.prototype }),
+        Decimal128: (0, helpers_1.assignAll)((0, helpers_1.functionCtorWithoutProps)(bson.Decimal128), (0, helpers_1.pickWithExactKeyMatch)(bson.Decimal128, [
+            'prototype',
+            'fromString',
+            'fromStringWithRounding',
+        ])),
+        BSONSymbol: (0, helpers_1.assignAll)((0, helpers_1.functionCtorWithoutProps)(bson.BSONSymbol), (0, helpers_1.pickWithExactKeyMatch)(bson.BSONSymbol, ['prototype'])),
+        Int32: (0, helpers_1.assignAll)((0, helpers_1.functionCtorWithoutProps)(bson.Int32), (0, helpers_1.pickWithExactKeyMatch)(bson.Int32, ['prototype', 'fromString'])),
+        Long: (0, helpers_1.assignAll)((0, helpers_1.functionCtorWithoutProps)(bson.Long), (0, helpers_1.pickWithExactKeyMatch)(bson.Long, [
+            'prototype',
+            'fromValue',
+            'isLong',
+            'fromBytesBE',
+            'fromBytesLE',
+            'fromBytes',
+            'fromString',
+            'fromStringStrict',
+            'fromBigInt',
+            'fromNumber',
+            'fromInt',
+            'fromBits',
+            'MIN_VALUE',
+            'MAX_VALUE',
+            'NEG_ONE',
+            'UONE',
+            'ONE',
+            'UZERO',
+            'ZERO',
+            'MAX_UNSIGNED_VALUE',
+            'TWO_PWR_24',
+        ])),
+        Binary: (0, helpers_1.assignAll)((0, helpers_1.functionCtorWithoutProps)(bson.Binary), (0, helpers_1.pickWithExactKeyMatch)(bson.Binary, [
+            'prototype',
+            'createFromBase64',
+            'createFromHexString',
+            'fromInt8Array',
+            'fromFloat32Array',
+            'fromPackedBits',
+            'fromBits',
+            'BUFFER_SIZE',
+            'SUBTYPE_DEFAULT',
+            'SUBTYPE_FUNCTION',
+            'SUBTYPE_BYTE_ARRAY',
+            'SUBTYPE_UUID_OLD',
+            'SUBTYPE_UUID',
+            'SUBTYPE_MD5',
+            'SUBTYPE_ENCRYPTED',
+            'SUBTYPE_COLUMN',
+            'SUBTYPE_SENSITIVE',
+            'SUBTYPE_VECTOR',
+            'SUBTYPE_USER_DEFINED',
+            'VECTOR_TYPE',
+        ])),
+        Double: (0, helpers_1.assignAll)((0, helpers_1.functionCtorWithoutProps)(bson.Double), (0, helpers_1.pickWithExactKeyMatch)(bson.Double, ['prototype', 'fromString'])),
+        BSONRegExp: (0, helpers_1.assignAll)((0, helpers_1.functionCtorWithoutProps)(bson.BSONRegExp), (0, helpers_1.pickWithExactKeyMatch)(bson.BSONRegExp, ['prototype', 'parseOptions'])),
+        EJSON: (0, helpers_1.pickWithExactKeyMatch)(bson.EJSON, [
+            'parse',
+            'serialize',
+            'stringify',
+            'deserialize',
+        ]),
+    };
+    for (const className of Object.keys(bsonPkg)) {
+        const help = helps[className] ?? constructHelp?.(className);
+        if (!help)
+            continue;
+        bsonPkg[className].help = () => help;
+        Object.setPrototypeOf(bsonPkg[className].help, help);
+    }
+    return bsonPkg;
+}
+//# sourceMappingURL=shell-bson.js.map

package/lib/shell-bson.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shell-bson.js","sourceRoot":"","sources":["../src/shell-bson.ts"],"names":[],"mappings":";;AAgGA,gDA8VC;AA7bD,4CAIyB;AACzB,uCAKmB;AACnB,mCAAqC;AAoFrC,SAAgB,kBAAkB,CAGhC,EACA,WAAW,EAAE,IAAI,EACjB,YAAY,EACZ,cAAc,EACd,aAAa,GACmB;IAChC,MAAM,SAAS,GAAyC;QACtD,QAAQ;QACR,MAAM;QACN,OAAO;QACP,YAAY;QACZ,QAAQ;QACR,OAAO;QACP,MAAM;QACN,QAAQ;QACR,QAAQ;QACR,UAAU;QACV,WAAW;QACX,YAAY;QACZ,YAAY;KACb,CAAC;IAEF,MAAM,KAAK,GAA+C,EAAE,CAAC;IAC7D,KAAK,MAAM,SAAS,IAAI,SAAS,EAAE,CAAC;QAClC,IAAI,CAAC,CAAC,SAAS,IAAI,IAAI,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,6BAAoB,CAC5B,GAAG,SAAS,2CAA2C,CACxD,CAAC;QACJ,CAAC;QACD,MAAM,IAAI,GAAG,aAAa,EAAE,CAAC,SAAS,CAAC,CAAC;QACxC,KAAK,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;QACxB,IAAI,CAAC,CAAC,WAAW,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC;YAAE,SAAS;QAChD,cAAc,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,SAAS,EAAE;YAC1C,IAAI,EAAE,IAAI;YAEV,GAAG,CAAC,SAAS,KAAK,YAAY;gBAC5B,CAAC,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE;gBAC3C,CAAC,CAAC,EAAE,CAAC;SACR,CAAC,CAAC;IACL,CAAC;IAED,MAAM,OAAO,GAA6B;QACxC,KAAK,EAAE,IAAA,mBAAS,EAAC,SAAS,KAAK,CAC7B,SAAiB,EACjB,GAAQ,EACR,EAAW,EACX,MAAiB;YAEjB,IAAA,+BAAqB,EACnB,CAAC,SAAS,EAAE,GAAG,EAAE,EAAE,CAAC,EACpB,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,SAAS,EAAE,QAAQ,CAAC,EAAE,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,EAC9D,OAAO,CACR,CAAC;YACF,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;QACpD,CAAC,EACD,IAAA,+BAAqB,EAAC,IAAI,CAAC,KAAK,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;QAEjD,QAAQ,EAAE,SAAS,QAAQ,CAAC,MAAW;YACrC,IAAA,+BAAqB,EAAC,CAAC,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,UAAU,CAAC,CAAC;YACxD,OAAO,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;QAC1C,CAAC;QAED,MAAM,EAAE,IAAA,mBAAS,EACf,SAAS,MAAM;YACb,OAAO,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QAC3B,CAAC,EACD,IAAA,+BAAqB,EAAC,IAAI,CAAC,MAAM,EAAE,CAAC,WAAW,CAAC,CAAC,EACjD,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE,EAAE,CACpC;QACD,MAAM,EAAE,IAAA,mBAAS,EACf,SAAS,MAAM;YACb,OAAO,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QAC3B,CAAC,EACD,IAAA,+BAAqB,EAAC,IAAI,CAAC,MAAM,EAAE,CAAC,WAAW,CAAC,CAAC,EACjD,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE,EAAE,CACpC;QACD,QAAQ,EAAE,IAAA,mBAAS,EAAC,SAAS,QAAQ,CACnC,EAA8D;YAE9D,IAAA,+BAAqB,EACnB,CAAC,EAAE,CAAC,EACJ,CAAC,CAAC,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,EAC3C,UAAU,CACX,CAAC;YACF,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QAC/B,CAAC,EACD,IAAA,+BAAqB,EAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,WAAW,EAAE,gBAAgB,EAAE,UAAU,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,SAAS,CAAC,CAAC,CAAC;QAC1J,SAAS,EAAE,IAAA,mBAAS,EAAC,SAAS,SAAS,CACrC,CAAkE,EAClE,CAAU;YAEV,IAAA,+BAAqB,EACnB,CAAC,CAAC,EAAE,CAAC,CAAC,EACN;gBACE,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,CAAC;gBAC/B,CAAC,SAAS,EAAE,QAAQ,CAAC;aACtB,EACD,WAAW,CACZ,CAAC;YAIF,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,IAAI,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,EAAE,CAAC;gBAChE,OAAO,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YAC/B,CAAC;iBAAM,IAAI,CAAC,KAAK,SAAS,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;gBACpD,OAAO,IAAI,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,CAAW,EAAE,CAAC,EAAE,CAAC,IAAK,CAAY,EAAE,CAAC,CAAC;YACvE,CAAC;YACD,OAAO,IAAI,IAAI,CAAC,SAAS,CAAC,CAA+B,CAAC,CAAC;QAC7D,CAAC,EACD,IAAA,+BAAqB,EAAC,IAAI,CAAC,SAAS,EAAE,CAAC,WAAW,EAAE,SAAS,EAAE,YAAY,EAAE,UAAU,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC,CAAC;QACrH,IAAI,EAAE,IAAA,mBAAS,EAAC,SAAS,IAAI,CAC3B,IAAuB,EAAE,EACzB,CAAO;YAEP,IAAA,+BAAqB,EACnB,CAAC,CAAC,EAAE,CAAC,CAAC,EACN;gBACE,CAAC,SAAS,EAAE,QAAQ,EAAE,UAAU,CAAC;gBACjC,CAAC,SAAS,EAAE,QAAQ,CAAC;aACtB,EACD,MAAM,CACP,CAAC;YACF,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC7B,CAAC,EACD,IAAA,+BAAqB,EAAC,IAAI,CAAC,IAAI,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;QAChD,aAAa,EAAE,IAAA,mBAAS,EACtB,SAAS,aAAa,CAAC,CAAC,GAAG,GAAG;YAC5B,IAAA,+BAAqB,EACnB,CAAC,CAAC,CAAC,EACH,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,YAAY,EAAE,iBAAiB,CAAC,CAAC,EACpE,eAAe,CAChB,CAAC;YACF,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;gBAC1B,YAAY,CACV,uHAAuH,CACxH,CAAC;YACJ,CAAC;YACD,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC5C,CAAC,EACD,EAAE,SAAS,EAAE,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,CACzC;QACD,SAAS,EAAE,IAAA,mBAAS,EAClB,SAAS,SAAS,CAAC,CAAC,GAAG,GAAG;YACxB,CAAC,KAAD,CAAC,GAAK,GAAG,EAAC;YACV,IAAA,+BAAqB,EACnB,CAAC,CAAC,CAAC,EACH,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC,EACjD,WAAW,CACZ,CAAC;YACF,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;QAC9C,CAAC,EACD,EAAE,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,CACpC;QACD,UAAU,EAAE,IAAA,mBAAS,EACnB,SAAS,UAAU,CACjB,IAAqB,GAAG;YAExB,CAAC,KAAD,CAAC,GAAK,GAAG,EAAC;YACV,IAAA,+BAAqB,EACnB,CAAC,CAAC,CAAC,EACH,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC,EACjD,YAAY,CACb,CAAC;YACF,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;gBAC1B,YAAY,CACV,oHAAoH,CACrH,CAAC;gBACF,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;YACjC,CAAC;YACD,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACtC,CAAC,EACD,EAAE,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CACnC;QACD,OAAO,EAAE,SAAS,OAAO,CACvB,KAA0C;YAE1C,IAAI,KAAK,KAAK,SAAS;gBAAE,OAAO,IAAI,IAAI,EAAE,CAAC;YAC3C,IAAI,OAAO,KAAK,KAAK,QAAQ;gBAAE,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC;YACtD,MAAM,YAAY,GAChB,6IAA6I,CAAC;YAChJ,MAAM,KAAK,GAAG,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACvC,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;gBAGjD,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,GAAG,KAAK,CAAC,MAAM,CAAC;gBAClD,MAAM,UAAU,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,IAAI,IACzD,CAAC,IAAI,IACP,IAAI,EAAE,IAAI,KAAK,GAAG,EAAE,IAAI,GAAG,EAAE,CAAC;gBAC9B,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC;gBAElC,IACE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,cAAc;oBACjC,IAAI,CAAC,OAAO,EAAE,IAAI,eAAe,EACjC,CAAC;oBACD,OAAO,IAAI,CAAC;gBACd,CAAC;YACH,CAAC;YACD,MAAM,IAAI,iCAAwB,CAChC,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,yBAAyB,EACjD,qBAAY,CAAC,eAAe,CAC7B,CAAC;QACJ,CAAC;QACD,OAAO,EAAE,IAAA,mBAAS,EAChB,SAAS,OAAO,CAAC,OAAe,EAAE,SAAiB;YAEjD,IAAA,+BAAqB,EACnB,CAAC,OAAO,EAAE,SAAS,CAAC,EACpB,CAAC,QAAQ,EAAE,QAAQ,CAAC,EACpB,SAAS,CACV,CAAC;YACF,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;YAChD,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAC1C,CAAC,EACD,EAAE,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CACrC;QACD,OAAO,EAAE,IAAA,mBAAS,EAChB,SAAS,OAAO,CAAC,OAAe,EAAE,MAAc;YAC9C,IAAA,+BAAqB,EACnB,CAAC,OAAO,EAAE,MAAM,CAAC,EACjB,CAAC,QAAQ,EAAE,QAAQ,CAAC,EACpB,SAAS,CACV,CAAC;YACF,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;YAC1C,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAC1C,CAAC,EACD,EAAE,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CACrC;QACD,IAAI,EAAE,IAAA,mBAAS,EACb,SAAS,IAAI,CAAC,MAAe;YAC3B,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBAEzB,MAAM,IAAI,GAAG,IAAA,oBAAW,EAAC,EAAE,CAAC,CAAC;gBAC7B,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;gBAClC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;gBAClC,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAChC,CAAC;YACD,IAAA,+BAAqB,EAAC,CAAC,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAC;YAGpD,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAE,MAAiB,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;YACxE,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAC3D,CAAC,EACD,EAAE,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CACrC;QACD,GAAG,EAAE,IAAA,mBAAS,EACZ,SAAS,GAAG,CAAC,MAAc;YACzB,IAAA,+BAAqB,EAAC,CAAC,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC,CAAC;YACnD,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;YAC1C,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAC1D,CAAC,EACD,EAAE,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CACrC;QAED,UAAU,EAAE,IAAA,mBAAS,EACnB,IAAA,kCAAwB,EAAC,IAAI,CAAC,UAAU,CAAC,EACzC,IAAA,+BAAqB,EAAC,IAAI,CAAC,UAAU,EAAE;YACrC,WAAW;YACX,YAAY;YACZ,wBAAwB;SACzB,CAAC,CACH;QACD,UAAU,EAAE,IAAA,mBAAS,EACnB,IAAA,kCAAwB,EAAC,IAAI,CAAC,UAAU,CAAC,EACzC,IAAA,+BAAqB,EAAC,IAAI,CAAC,UAAU,EAAE,CAAC,WAAW,CAAC,CAAC,CACtD;QACD,KAAK,EAAE,IAAA,mBAAS,EACd,IAAA,kCAAwB,EAAC,IAAI,CAAC,KAAK,CAAC,EACpC,IAAA,+BAAqB,EAAC,IAAI,CAAC,KAAK,EAAE,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC,CAC/D;QACD,IAAI,EAAE,IAAA,mBAAS,EACb,IAAA,kCAAwB,EAAC,IAAI,CAAC,IAAI,CAAC,EACnC,IAAA,+BAAqB,EACnB,IAAI,CAAC,IAA6C,EAClD;YACE,WAAW;YACX,WAAW;YACX,QAAQ;YACR,aAAa;YACb,aAAa;YACb,WAAW;YACX,YAAY;YACZ,kBAAkB;YAClB,YAAY;YACZ,YAAY;YACZ,SAAS;YACT,UAAU;YACV,WAAW;YACX,WAAW;YACX,SAAS;YACT,MAAM;YACN,KAAK;YACL,OAAO;YACP,MAAM;YACN,oBAAoB;YACpB,YAAY;SACb,CACF,CACF;QACD,MAAM,EAAE,IAAA,mBAAS,EACf,IAAA,kCAAwB,EAAC,IAAI,CAAC,MAAM,CAAC,EACrC,IAAA,+BAAqB,EAAC,IAAI,CAAC,MAAM,EAAE;YACjC,WAAW;YACX,kBAAkB;YAClB,qBAAqB;YACrB,eAAe;YACf,kBAAkB;YAClB,gBAAgB;YAChB,UAAU;YACV,aAAa;YACb,iBAAiB;YACjB,kBAAkB;YAClB,oBAAoB;YACpB,kBAAkB;YAClB,cAAc;YACd,aAAa;YACb,mBAAmB;YACnB,gBAAgB;YAChB,mBAAmB;YACnB,gBAAgB;YAChB,sBAAsB;YACtB,aAAa;SACd,CAAC,CACH;QACD,MAAM,EAAE,IAAA,mBAAS,EACf,IAAA,kCAAwB,EAAC,IAAI,CAAC,MAAM,CAAC,EACrC,IAAA,+BAAqB,EAAC,IAAI,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC,CAChE;QACD,UAAU,EAAE,IAAA,mBAAS,EACnB,IAAA,kCAAwB,EAAC,IAAI,CAAC,UAAU,CAAC,EACzC,IAAA,+BAAqB,EAAC,IAAI,CAAC,UAAU,EAAE,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC,CACtE;QAED,KAAK,EAAE,IAAA,+BAAqB,EAAC,IAAI,CAAC,KAAK,EAAE;YACvC,OAAO;YACP,WAAW;YACX,WAAW;YACX,aAAa;SACd,CAAC;KACH,CAAC;IAEF,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAwB,EAAE,CAAC;QACpE,MAAM,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,aAAa,EAAE,CAAC,SAAS,CAAC,CAAC;QAC5D,IAAI,CAAC,IAAI;YAAE,SAAS;QACpB,OAAO,CAAC,SAAS,CAAC,CAAC,IAAI,GAAG,GAAS,EAAE,CAAC,IAAI,CAAC;QAC3C,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACvD,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@mongosh/shell-bson",
+  "version": "1.0.1",
+  "description": "mongosh-style BSON handling",
+  "homepage": "https://github.com/mongodb-js/mongosh/tree/main/packages/shell-bson#readme",
+  "license": "Apache-2.0",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=14.15.1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mongodb-js/mongosh.git"
+  },
+  "scripts": {
+    "check": "npm run lint && npm run depcheck",
+    "depcheck": "depcheck",
+    "compile": "tsc -p tsconfig.json",
+    "eslint": "eslint",
+    "lint": "npm run eslint . && npm run prettier -- --check .",
+    "prepublish": "npm run compile",
+    "test": "mocha --timeout 15000 -r ts-node/register --reporter \"../../configs/mocha-config-mongosh/reporter.ts\" \"./src/*.spec.ts\"",
+    "test-ci": "node ../../scripts/run-if-package-requested.js npm test",
+    "test-coverage": "nyc --no-clean --cwd ../.. --reporter=none npm run test",
+    "test-ci-coverage": "nyc --no-clean --cwd ../.. --reporter=none npm run test-ci",
+    "prettier": "prettier",
+    "reformat": "npm run prettier -- --write . && npm run eslint -- --fix"
+  },
+  "bugs": {
+    "url": "https://github.com/mongodb-js/mongosh/issues"
+  },
+  "mongosh": {
+    "unitTestsOnly": true
+  },
+  "dependencies": {
+    "@mongosh/errors": "^2.4.4"
+  },
+  "peerDependencies": {
+    "bson": "^6.10.4"
+  },
+  "devDependencies": {
+    "@mongodb-js/eslint-config-mongosh": "^1.0.0",
+    "@mongodb-js/prettier-config-devtools": "^1.0.1",
+    "@mongodb-js/tsconfig-mongosh": "^1.0.0",
+    "bson": "^6.10.4",
+    "depcheck": "^1.4.7",
+    "eslint": "^7.25.0",
+    "prettier": "^2.8.8"
+  },
+  "gitHead": "9f0183e375c5422a0e1ced87c9a620384180abf7"
+}

package/src/bson-export.ts

@@ -0,0 +1,51 @@
+import type {
+  ObjectId,
+  DBRef,
+  MaxKey,
+  MinKey,
+  Timestamp,
+  BSONSymbol,
+  Code,
+  Decimal128,
+  Int32,
+  Long,
+  Binary,
+  calculateObjectSize,
+  Double,
+  EJSON,
+  BSONRegExp,
+} from 'bson';
+export type {
+  ObjectId,
+  DBRef,
+  MaxKey,
+  MinKey,
+  Timestamp,
+  BSONSymbol,
+  Code,
+  Decimal128,
+  Int32,
+  Long,
+  Binary,
+  Double,
+  EJSON,
+  BSONRegExp,
+  calculateObjectSize,
+};
+export type BSON = {
+  ObjectId: typeof ObjectId;
+  DBRef: typeof DBRef;
+  MaxKey: typeof MaxKey;
+  MinKey: typeof MinKey;
+  Timestamp: typeof Timestamp;
+  Code: typeof Code;
+  Decimal128: typeof Decimal128;
+  Int32: typeof Int32;
+  Long: typeof Long;
+  Binary: typeof Binary;
+  Double: typeof Double;
+  EJSON: typeof EJSON;
+  BSONRegExp: typeof BSONRegExp;
+  BSONSymbol: typeof BSONSymbol;
+  calculateObjectSize: typeof calculateObjectSize;
+};

package/src/helpers.ts

@@ -0,0 +1,123 @@
+import { MongoshInvalidInputError, CommonErrors } from '@mongosh/errors';
+
+// Create a copy of a class so that it's constructible without `new`, i.e.
+// class A {}; B = functionCtor(A);
+// A() // throws
+// B() // does not throw, returns instance of A
+export function functionCtorWithoutProps<
+  T extends Function & { new (...args: any): any }
+>(
+  ClassCtor: T
+): {
+  new (...args: ConstructorParameters<T>): InstanceType<T>;
+  (...args: ConstructorParameters<T>): InstanceType<T>;
+} {
+  function fnCtor(...args: any[]) {
+    if (new.target) {
+      return Reflect.construct(ClassCtor, args, new.target);
+    }
+    return new ClassCtor(...args);
+  }
+  Object.setPrototypeOf(fnCtor, Object.getPrototypeOf(ClassCtor));
+  const nameDescriptor = Object.getOwnPropertyDescriptor(ClassCtor, 'name');
+  if (nameDescriptor) {
+    Object.defineProperty(fnCtor, 'name', nameDescriptor);
+  }
+  return fnCtor as any;
+}
+
+export function assignAll<T extends {}, U extends {}>(t: T, u: U): T & U;
+export function assignAll<T extends {}, U extends {}, V extends {}>(
+  t: T,
+  u: U,
+  v: V
+): T & U & V;
+export function assignAll<
+  T extends {},
+  U extends {},
+  V extends {},
+  W extends {}
+>(t: T, u: U, v: V, w: W): T & U & V & W;
+export function assignAll(target: {}, ...sources: {}[]): any {
+  const newDescriptorList = [];
+  for (const source of sources) {
+    newDescriptorList.push(
+      ...Object.entries(Object.getOwnPropertyDescriptors(source))
+    );
+  }
+  const newDescriptorMap = Object.fromEntries(newDescriptorList);
+  for (const key of Object.getOwnPropertyNames(newDescriptorMap)) {
+    if (Object.getOwnPropertyDescriptor(target, key)?.configurable === false) {
+      // e.g. .prototype can be written to but not re-defined
+      (target as any)[key] = newDescriptorMap[key].value;
+      delete newDescriptorMap[key];
+    }
+  }
+  Object.defineProperties(target, newDescriptorMap);
+
+  return target;
+}
+
+// pick() but account for descriptor properties and ensure that the set of passed
+// keys matches the public properties of O exactly
+export function pickWithExactKeyMatch<
+  K extends string,
+  O extends Record<K, unknown>
+>(o: Record<string, never> extends Omit<O, K> ? O : never, keys: K[]): O {
+  return Object.create(
+    Object.getPrototypeOf(o),
+    Object.fromEntries(
+      Object.entries(Object.getOwnPropertyDescriptors(o)).filter(([k]) =>
+        (keys as string[]).includes(k)
+      )
+    )
+  );
+}
+
+function getAssertCaller(caller?: string): string {
+  return caller ? ` (${caller})` : '';
+}
+
+// NB: Duplicate of the one in packages/shell-api/src/helpers.ts
+export function assertArgsDefinedType(
+  args: any[],
+  expectedTypes: Array<true | string | Array<string | undefined>>,
+  func?: string
+): void {
+  args.forEach((arg, i) => {
+    const expected = expectedTypes[i];
+    if (arg === undefined) {
+      if (
+        expected !== true &&
+        Array.isArray(expected) &&
+        expected.includes(undefined)
+      ) {
+        return;
+      }
+      throw new MongoshInvalidInputError(
+        `Missing required argument at position ${i}${getAssertCaller(func)}`,
+        CommonErrors.InvalidArgument
+      );
+    } else if (expected === true) {
+      return;
+    }
+
+    const expectedTypesList: Array<string | undefined> =
+      typeof expected === 'string' ? [expected] : expected;
+    const isExpectedTypeof = expectedTypesList.includes(typeof arg);
+    const isExpectedBson = expectedTypesList.includes(`bson:${arg?._bsontype}`);
+
+    if (!isExpectedTypeof && !isExpectedBson) {
+      const expectedMsg = expectedTypesList
+        .filter((e) => e !== undefined)
+        .map((e) => e?.replace(/^bson:/, ''))
+        .join(' or ');
+      throw new MongoshInvalidInputError(
+        `Argument at position ${i} must be of type ${expectedMsg}, got ${typeof arg} instead${getAssertCaller(
+          func
+        )}`,
+        CommonErrors.InvalidArgument
+      );
+    }
+  });
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+export type * from './bson-export';
+export { constructShellBson, type ShellBson } from './shell-bson';
+export { makePrintableBson, makeBsonStringifiers } from './printable-bson';

package/src/printable-bson.spec.ts

@@ -0,0 +1,137 @@
+import { expect } from 'chai';
+import * as bson from 'bson';
+import { inspect } from 'util';
+import { makePrintableBson } from './printable-bson';
+
+describe('BSON printers', function () {
+  before('make BSON objects printable', function () {
+    makePrintableBson(bson);
+  });
+
+  it('formats ObjectIds correctly', function () {
+    expect(inspect(new bson.ObjectId('5fa5694f88211043b23c7f11'))).to.equal(
+      "ObjectId('5fa5694f88211043b23c7f11')"
+    );
+  });
+
+  it('formats DBRefs correctly', function () {
+    expect(
+      inspect(
+        new bson.DBRef('a', new bson.ObjectId('5f16b8bebe434dc98cdfc9cb'), 'db')
+      )
+    ).to.equal("DBRef('a', ObjectId('5f16b8bebe434dc98cdfc9cb'), 'db')");
+    expect(inspect(new bson.DBRef('a', 'foo' as any, 'db'))).to.equal(
+      "DBRef('a', 'foo', 'db')"
+    );
+    expect(inspect(new bson.DBRef('a', { x: 1 } as any, 'db'))).to.equal(
+      "DBRef('a', { x: 1 }, 'db')"
+    );
+  });
+
+  it('formats MinKey and MaxKey correctly', function () {
+    expect(inspect(new bson.MinKey())).to.equal('MinKey()');
+    expect(inspect(new bson.MaxKey())).to.equal('MaxKey()');
+  });
+
+  it('formats NumberInt correctly', function () {
+    expect(inspect(new bson.Int32(32))).to.equal('Int32(32)');
+  });
+
+  it('formats NumberLong correctly', function () {
+    expect(inspect(bson.Long.fromString('64'))).to.equal("Long('64')");
+  });
+
+  it('formats unsigned NumberLong correctly', function () {
+    expect(inspect(bson.Long.fromString('64', true))).to.equal(
+      "Long('64', true)"
+    );
+  });
+
+  it('formats NumberDecimal correctly', function () {
+    expect(inspect(bson.Decimal128.fromString('1'))).to.equal(
+      "Decimal128('1')"
+    );
+  });
+
+  it('formats Timestamp correctly', function () {
+    expect(inspect(new bson.Timestamp(new bson.Long(100, 1)))).to.equal(
+      'Timestamp({ t: 1, i: 100 })'
+    );
+  });
+
+  it('formats Symbol correctly', function () {
+    expect(inspect(new bson.BSONSymbol('abc'))).to.equal("BSONSymbol('abc')");
+  });
+
+  it('formats Code correctly', function () {
+    expect(inspect(new bson.Code('abc'))).to.equal("Code('abc')");
+  });
+
+  it('formats BSONRegExp correctly', function () {
+    expect(inspect(new bson.BSONRegExp('(?-i)AA_', 'im'))).to.equal(
+      "BSONRegExp('(?-i)AA_', 'im')"
+    );
+  });
+
+  it('formats UUIDs correctly', function () {
+    expect(
+      inspect(
+        new bson.Binary(
+          Buffer.from('0123456789abcdef0123456789abcdef', 'hex'),
+          4
+        )
+      )
+    ).to.equal("UUID('01234567-89ab-cdef-0123-456789abcdef')");
+  });
+
+  it('formats MD5s correctly', function () {
+    expect(
+      inspect(
+        new bson.Binary(
+          Buffer.from('0123456789abcdef0123456789abcdef', 'hex'),
+          5
+        )
+      )
+    ).to.equal("MD5('0123456789abcdef0123456789abcdef')");
+  });
+
+  describe('with Vector types', function () {
+    it('formats Int8Array correctly', function () {
+      expect(
+        inspect(bson.Binary.fromInt8Array(new Int8Array([1, 2, 3])))
+      ).to.equal('Binary.fromInt8Array(new Int8Array([ 1, 2, 3 ]))');
+    });
+
+    it('formats PackedBits correctly', function () {
+      expect(
+        inspect(bson.Binary.fromPackedBits(new Uint8Array([1, 2, 3])))
+      ).to.equal('Binary.fromPackedBits(new Uint8Array([ 1, 2, 3 ]))');
+    });
+
+    it('formats PackedBits correctly with padding', function () {
+      expect(
+        inspect(bson.Binary.fromPackedBits(new Uint8Array([1, 2, 3]), 7))
+      ).to.equal('Binary.fromPackedBits(new Uint8Array([ 1, 2, 3 ]), 7)');
+    });
+
+    it('formats Float32Array correctly', function () {
+      expect(
+        inspect(
+          bson.Binary.fromFloat32Array(
+            new Float32Array([1.1111, 2.2222, 3.3333])
+          ),
+          { compact: true }
+        )
+      ).matches(
+        // Precision is lost because of float handling, so we use regex to match
+        /Binary.fromFloat32Array\(new Float32Array\(\[ 1\.1\d*, 2\.2\d*, 3\.3\d* \]\)\)/
+      );
+    });
+  });
+
+  it('formats any other value with the new format using createfromBase64', function () {
+    expect(
+      inspect(bson.Binary.createFromBase64('SGVsbG8sIFdvcmxkIQo='))
+    ).to.equal("Binary.createFromBase64('SGVsbG8sIFdvcmxkIQo=', 0)");
+  });
+});