bson 6.1.0 → 6.2.0

package/bson.d.ts

@@ -68,7 +68,7 @@ export declare class Binary extends BSONValue {
     /** Creates an Binary instance from a base64 string */
     static createFromBase64(base64: string, subType?: number): Binary;
     /* Excluded from this release type: fromExtendedJSON */
-    inspect(): string;
+    inspect(depth?: number, options?: unknown, inspect?: InspectFn): string;
 }
 
 /** @public */
@@ -187,7 +187,7 @@ export declare class BSONRegExp extends BSONValue {
     static parseOptions(options?: string): string;
     /* Excluded from this release type: toExtendedJSON */
     /* Excluded from this release type: fromExtendedJSON */
-    inspect(): string;
+    inspect(depth?: number, options?: unknown, inspect?: InspectFn): string;
 }
 
 /** @public */
@@ -232,10 +232,10 @@ export declare class BSONSymbol extends BSONValue {
     /** Access the wrapped string value. */
     valueOf(): string;
     toString(): string;
-    inspect(): string;
     toJSON(): string;
     /* Excluded from this release type: toExtendedJSON */
     /* Excluded from this release type: fromExtendedJSON */
+    inspect(depth?: number, options?: unknown, inspect?: InspectFn): string;
 }
 
 /** @public */
@@ -275,8 +275,12 @@ export declare type BSONType = (typeof BSONType)[keyof typeof BSONType];
 export declare abstract class BSONValue {
     /** @public */
     abstract get _bsontype(): string;
-    /** @public */
-    abstract inspect(): string;
+    /**
+     * @public
+     * Prints a human-readable string of BSON value information
+     * If invoked manually without node.js.inspect function, this will default to a modified JSON.stringify
+     */
+    abstract inspect(depth?: number, options?: unknown, inspect?: InspectFn): string;
     /* Excluded from this release type: toExtendedJSON */
 }
 
@@ -321,7 +325,7 @@ export declare class Code extends BSONValue {
     };
     /* Excluded from this release type: toExtendedJSON */
     /* Excluded from this release type: fromExtendedJSON */
-    inspect(): string;
+    inspect(depth?: number, options?: unknown, inspect?: InspectFn): string;
 }
 
 /** @public */
@@ -352,7 +356,7 @@ export declare class DBRef extends BSONValue {
     toJSON(): DBRefLike & Document;
     /* Excluded from this release type: toExtendedJSON */
     /* Excluded from this release type: fromExtendedJSON */
-    inspect(): string;
+    inspect(depth?: number, options?: unknown, inspect?: InspectFn): string;
 }
 
 /** @public */
@@ -406,7 +410,7 @@ export declare class Decimal128 extends BSONValue {
     toJSON(): Decimal128Extended;
     /* Excluded from this release type: toExtendedJSON */
     /* Excluded from this release type: fromExtendedJSON */
-    inspect(): string;
+    inspect(depth?: number, options?: unknown, inspect?: InspectFn): string;
 }
 
 /** @public */
@@ -529,7 +533,7 @@ export declare class Double extends BSONValue {
     toString(radix?: number): string;
     /* Excluded from this release type: toExtendedJSON */
     /* Excluded from this release type: fromExtendedJSON */
-    inspect(): string;
+    inspect(depth?: number, options?: unknown, inspect?: InspectFn): string;
 }
 
 /** @public */
@@ -579,6 +583,8 @@ export declare type EJSONOptions = {
  */
 declare function EJSONserialize(value: any, options?: EJSONOptions): Document;
 
+declare type InspectFn = (x: unknown, options?: unknown) => string;
+
 /**
  * A class representation of a BSON Int32 type.
  * @public
@@ -603,7 +609,7 @@ export declare class Int32 extends BSONValue {
     toJSON(): number;
     /* Excluded from this release type: toExtendedJSON */
     /* Excluded from this release type: fromExtendedJSON */
-    inspect(): string;
+    inspect(depth?: number, options?: unknown, inspect?: InspectFn): string;
 }
 
 /** @public */
@@ -926,7 +932,7 @@ export declare class Long extends BSONValue {
     static fromExtendedJSON(doc: {
         $numberLong: string;
     }, options?: EJSONOptions): number | Long | bigint;
-    inspect(): string;
+    inspect(depth?: number, options?: unknown, inspect?: InspectFn): string;
 }
 
 /** @public */
@@ -1046,7 +1052,12 @@ export declare class ObjectId extends BSONValue {
     static isValid(id: string | number | ObjectId | ObjectIdLike | Uint8Array): boolean;
     /* Excluded from this release type: toExtendedJSON */
     /* Excluded from this release type: fromExtendedJSON */
-    inspect(): string;
+    /**
+     * Converts to a string representation of this Id.
+     *
+     * @returns return the 24 character hex string representation.
+     */
+    inspect(depth?: number, options?: unknown, inspect?: InspectFn): string;
 }
 
 /** @public */
@@ -1203,7 +1214,7 @@ export declare class Timestamp extends LongWithoutOverridesClass {
     static fromString(str: string, optRadix: number): Timestamp;
     /* Excluded from this release type: toExtendedJSON */
     /* Excluded from this release type: fromExtendedJSON */
-    inspect(): string;
+    inspect(depth?: number, options?: unknown, inspect?: InspectFn): string;
 }
 
 /** @public */
@@ -1278,7 +1289,13 @@ export declare class UUID extends Binary {
     static createFromBase64(base64: string): UUID;
     /* Excluded from this release type: bytesFromString */
     /* Excluded from this release type: isValidUUIDString */
-    inspect(): string;
+    /**
+     * Converts to a string representation of this Id.
+     *
+     * @returns return the 36 character hex string representation.
+     *
+     */
+    inspect(depth?: number, options?: unknown, inspect?: InspectFn): string;
 }
 
 /** @public */

package/lib/bson.bundle.js

@@ -16,6 +16,26 @@ function isMap(d) {
 function isDate(d) {
     return Object.prototype.toString.call(d) === '[object Date]';
 }
+function defaultInspect(x, _options) {
+    return JSON.stringify(x, (k, v) => {
+        if (typeof v === 'bigint') {
+            return { $numberLong: `${v}` };
+        }
+        else if (isMap(v)) {
+            return Object.fromEntries(v);
+        }
+        return v;
+    });
+}
+function getStylizeFunction(options) {
+    const stylizeExists = options != null &&
+        typeof options === 'object' &&
+        'stylize' in options &&
+        typeof options.stylize === 'function';
+    if (stylizeExists) {
+        return options.stylize;
+    }
+}
 
 const BSON_MAJOR_VERSION = 6;
 const BSON_INT32_MAX = 0x7fffffff;
@@ -96,7 +116,7 @@ class BSONVersionError extends BSONError {
         return 'BSONVersionError';
     }
     constructor() {
-        super(`Unsupported BSON version, bson types must be from bson ${BSON_MAJOR_VERSION}.0 or later`);
+        super(`Unsupported BSON version, bson types must be from bson ${BSON_MAJOR_VERSION}.x.x`);
     }
 }
 class BSONRuntimeError extends BSONError {
@@ -303,6 +323,9 @@ class BSONValue {
     get [Symbol.for('@@mdb.bson.version')]() {
         return BSON_MAJOR_VERSION;
     }
+    [Symbol.for('nodejs.util.inspect.custom')](depth, options, inspect) {
+        return this.inspect(depth, options, inspect);
+    }
 }
 
 class Binary extends BSONValue {
@@ -453,12 +476,12 @@ class Binary extends BSONValue {
         }
         return type === BSON_BINARY_SUBTYPE_UUID_NEW ? new UUID(data) : new Binary(data, type);
     }
-    [Symbol.for('nodejs.util.inspect.custom')]() {
-        return this.inspect();
-    }
-    inspect() {
+    inspect(depth, options, inspect) {
+        inspect ??= defaultInspect;
         const base64 = ByteUtils.toBase64(this.buffer.subarray(0, this.position));
-        return `Binary.createFromBase64("${base64}", ${this.sub_type})`;
+        const base64Arg = inspect(base64, options);
+        const subTypeArg = inspect(this.sub_type, options);
+        return `Binary.createFromBase64(${base64Arg}, ${subTypeArg})`;
     }
 }
 Binary.BSON_BINARY_SUBTYPE_DEFAULT = 0;
@@ -576,11 +599,9 @@ class UUID extends Binary {
     static isValidUUIDString(representation) {
         return UUID_WITHOUT_DASHES.test(representation) || UUID_WITH_DASHES.test(representation);
     }
-    [Symbol.for('nodejs.util.inspect.custom')]() {
-        return this.inspect();
-    }
-    inspect() {
-        return `new UUID("${this.toHexString()}")`;
+    inspect(depth, options, inspect) {
+        inspect ??= defaultInspect;
+        return `new UUID(${inspect(this.toHexString(), options)})`;
     }
 }
 
@@ -608,12 +629,15 @@ class Code extends BSONValue {
     static fromExtendedJSON(doc) {
         return new Code(doc.$code, doc.$scope);
     }
-    [Symbol.for('nodejs.util.inspect.custom')]() {
-        return this.inspect();
-    }
-    inspect() {
-        const codeJson = this.toJSON();
-        return `new Code(${JSON.stringify(String(codeJson.code))}${codeJson.scope != null ? `, ${JSON.stringify(codeJson.scope)}` : ''})`;
+    inspect(depth, options, inspect) {
+        inspect ??= defaultInspect;
+        let parametersString = inspect(this.code, options);
+        const multiLineFn = parametersString.includes('\n');
+        if (this.scope != null) {
+            parametersString += `,${multiLineFn ? '\n' : ' '}${inspect(this.scope, options)}`;
+        }
+        const endingNewline = multiLineFn && this.scope === null;
+        return `new Code(${multiLineFn ? '\n' : ''}${parametersString}${endingNewline ? '\n' : ''})`;
     }
 }
 
@@ -678,12 +702,16 @@ class DBRef extends BSONValue {
         delete copy.$db;
         return new DBRef(doc.$ref, doc.$id, doc.$db, copy);
     }
-    [Symbol.for('nodejs.util.inspect.custom')]() {
-        return this.inspect();
-    }
-    inspect() {
-        const oid = this.oid === undefined || this.oid.toString === undefined ? this.oid : this.oid.toString();
-        return `new DBRef("${this.namespace}", new ObjectId("${String(oid)}")${this.db ? `, "${this.db}"` : ''})`;
+    inspect(depth, options, inspect) {
+        inspect ??= defaultInspect;
+        const args = [
+            inspect(this.namespace, options),
+            inspect(this.oid, options),
+            ...(this.db ? [inspect(this.db, options)] : []),
+            ...(Object.keys(this.fields).length > 0 ? [inspect(this.fields, options)] : [])
+        ];
+        args[1] = inspect === defaultInspect ? `new ObjectId(${args[1]})` : args[1];
+        return `new DBRef(${args.join(', ')})`;
     }
 }
 
@@ -1310,11 +1338,11 @@ class Long extends BSONValue {
         }
         return longResult;
     }
-    [Symbol.for('nodejs.util.inspect.custom')]() {
-        return this.inspect();
-    }
-    inspect() {
-        return `new Long("${this.toString()}"${this.unsigned ? ', true' : ''})`;
+    inspect(depth, options, inspect) {
+        inspect ??= defaultInspect;
+        const longVal = inspect(this.toString(), options);
+        const unsignedVal = this.unsigned ? `, ${inspect(this.unsigned, options)}` : '';
+        return `new Long(${longVal}${unsignedVal})`;
     }
 }
 Long.TWO_PWR_24 = Long.fromInt(TWO_PWR_24_DBL);
@@ -1870,11 +1898,10 @@ class Decimal128 extends BSONValue {
     static fromExtendedJSON(doc) {
         return Decimal128.fromString(doc.$numberDecimal);
     }
-    [Symbol.for('nodejs.util.inspect.custom')]() {
-        return this.inspect();
-    }
-    inspect() {
-        return `new Decimal128("${this.toString()}")`;
+    inspect(depth, options, inspect) {
+        inspect ??= defaultInspect;
+        const d128string = inspect(this.toString(), options);
+        return `new Decimal128(${d128string})`;
     }
 }
 
@@ -1913,12 +1940,9 @@ class Double extends BSONValue {
         const doubleValue = parseFloat(doc.$numberDouble);
         return options && options.relaxed ? doubleValue : new Double(doubleValue);
     }
-    [Symbol.for('nodejs.util.inspect.custom')]() {
-        return this.inspect();
-    }
-    inspect() {
-        const eJSON = this.toExtendedJSON();
-        return `new Double(${eJSON.$numberDouble})`;
+    inspect(depth, options, inspect) {
+        inspect ??= defaultInspect;
+        return `new Double(${inspect(this.value, options)})`;
     }
 }
 
@@ -1950,11 +1974,9 @@ class Int32 extends BSONValue {
     static fromExtendedJSON(doc, options) {
         return options && options.relaxed ? parseInt(doc.$numberInt, 10) : new Int32(doc.$numberInt);
     }
-    [Symbol.for('nodejs.util.inspect.custom')]() {
-        return this.inspect();
-    }
-    inspect() {
-        return `new Int32(${this.valueOf()})`;
+    inspect(depth, options, inspect) {
+        inspect ??= defaultInspect;
+        return `new Int32(${inspect(this.value, options)})`;
     }
 }
 
@@ -1968,9 +1990,6 @@ class MaxKey extends BSONValue {
     static fromExtendedJSON() {
         return new MaxKey();
     }
-    [Symbol.for('nodejs.util.inspect.custom')]() {
-        return this.inspect();
-    }
     inspect() {
         return 'new MaxKey()';
     }
@@ -1986,9 +2005,6 @@ class MinKey extends BSONValue {
     static fromExtendedJSON() {
         return new MinKey();
     }
-    [Symbol.for('nodejs.util.inspect.custom')]() {
-        return this.inspect();
-    }
     inspect() {
         return 'new MinKey()';
     }
@@ -2159,11 +2175,9 @@ class ObjectId extends BSONValue {
     static fromExtendedJSON(doc) {
         return new ObjectId(doc.$oid);
     }
-    [Symbol.for('nodejs.util.inspect.custom')]() {
-        return this.inspect();
-    }
-    inspect() {
-        return `new ObjectId("${this.toHexString()}")`;
+    inspect(depth, options, inspect) {
+        inspect ??= defaultInspect;
+        return `new ObjectId(${inspect(this.toHexString(), options)})`;
     }
 }
 ObjectId.index = Math.floor(Math.random() * 0xffffff);
@@ -2376,11 +2390,12 @@ class BSONRegExp extends BSONValue {
         }
         throw new BSONError(`Unexpected BSONRegExp EJSON object form: ${JSON.stringify(doc)}`);
     }
-    [Symbol.for('nodejs.util.inspect.custom')]() {
-        return this.inspect();
-    }
-    inspect() {
-        return `new BSONRegExp(${JSON.stringify(this.pattern)}, ${JSON.stringify(this.options)})`;
+    inspect(depth, options, inspect) {
+        const stylize = getStylizeFunction(options) ?? (v => v);
+        inspect ??= defaultInspect;
+        const pattern = stylize(inspect(this.pattern), 'regexp');
+        const flags = stylize(inspect(this.options), 'regexp');
+        return `new BSONRegExp(${pattern}, ${flags})`;
     }
 }
 
@@ -2398,9 +2413,6 @@ class BSONSymbol extends BSONValue {
     toString() {
         return this.value;
     }
-    inspect() {
-        return `new BSONSymbol(${JSON.stringify(this.value)})`;
-    }
     toJSON() {
         return this.value;
     }
@@ -2410,8 +2422,9 @@ class BSONSymbol extends BSONValue {
     static fromExtendedJSON(doc) {
         return new BSONSymbol(doc.$symbol);
     }
-    [Symbol.for('nodejs.util.inspect.custom')]() {
-        return this.inspect();
+    inspect(depth, options, inspect) {
+        inspect ??= defaultInspect;
+        return `new BSONSymbol(${inspect(this.value, options)})`;
     }
 }
 
@@ -2486,11 +2499,11 @@ class Timestamp extends LongWithoutOverridesClass {
             : doc.$timestamp.t;
         return new Timestamp({ t, i });
     }
-    [Symbol.for('nodejs.util.inspect.custom')]() {
-        return this.inspect();
-    }
-    inspect() {
-        return `new Timestamp({ t: ${this.getHighBits()}, i: ${this.getLowBits()} })`;
+    inspect(depth, options, inspect) {
+        inspect ??= defaultInspect;
+        const t = inspect(this.high >>> 0, options);
+        const i = inspect(this.low >>> 0, options);
+        return `new Timestamp({ t: ${t}, i: ${i} })`;
     }
 }
 Timestamp.MAX_VALUE = Long.MAX_UNSIGNED_VALUE;