@mongosh/service-provider-core 3.3.7 → 3.6.0

package/lib/admin.d.ts

@@ -1,8 +1,9 @@
 import type ShellAuthOptions from './shell-auth-options';
 import type { MongoClientOptions, ReadConcern, ReadPreference, WriteConcern, Document, CreateCollectionOptions, ClientSession, DbOptions, ClientSessionOptions, ListDatabasesOptions, AutoEncryptionOptions, Collection } from './all-transport-types';
-import type { bson as BSON, ConnectionExtraInfo } from './index';
+import type { ConnectionExtraInfo } from './index';
 import type { ReplPlatform } from './platform';
 import type { AWSEncryptionKeyOptions, AzureEncryptionKeyOptions, ClientEncryption as MongoCryptClientEncryption, ClientEncryptionDataKeyProvider, GCPEncryptionKeyOptions, ClientEncryption, ClientEncryptionOptions } from './all-fle-types';
+import type { BSON } from '@mongosh/shell-bson';
 export interface CreateEncryptedCollectionOptions {
     provider: ClientEncryptionDataKeyProvider;
     createCollectionOptions: Omit<CreateCollectionOptions, 'encryptedFields'> & {
@@ -26,7 +27,7 @@ export interface ConnectionInfo {
 export default interface Admin {
     platform: ReplPlatform;
     initialDb: string;
-    bsonLibrary: typeof BSON;
+    bsonLibrary: BSON;
     listDatabases(database: string, options?: ListDatabasesOptions): Promise<Document>;
     getNewConnection(uri: string, options: MongoClientOptions): Promise<any>;
     getURI(): string | undefined;

package/lib/all-transport-types.d.ts

@@ -1 +1 @@
-export type { AggregateOptions, AggregationCursor, AnyBulkWriteOperation, AnyClientBulkWriteModel, Batch, BulkWriteOptions, BulkWriteResult, ClientBulkWriteResult, ClientBulkWriteOptions, ChangeStream, ChangeStreamOptions, ClientSession, CollationOptions, Collection, CommandOperationOptions, CountDocumentsOptions, CountOptions, CreateCollectionOptions, CreateIndexesOptions, ClientSessionOptions, ClusterTime, FindCursor, CursorFlag, RunCommandCursor, Db, DbOptions, DeleteOptions, DeleteResult, DistinctOptions, Document, DropCollectionOptions, DropDatabaseOptions, EstimatedDocumentCountOptions, ExplainOptions, ExplainVerbosityLike, FindOneAndDeleteOptions, FindOneAndUpdateOptions, FindOneAndReplaceOptions, FindOperators, FindOptions, HedgeOptions, IndexDescription, InsertManyResult, InsertOneOptions, InsertOneResult, ListCollectionsOptions, ListDatabasesOptions, ListIndexesOptions, MongoClientOptions, OrderedBulkOperation, ReadConcern, ReadConcernLike, ReadConcernLevel, ReadPreference, ReadPreferenceLike, ReadPreferenceFromOptions, ReadPreferenceMode, RenameOptions, ReplaceOptions, ResumeToken, RunCommandOptions, SearchIndexDescription, ServerSessionId, TagSet, TransactionOptions, UpdateOptions, UpdateResult, UnorderedBulkOperation, WriteConcern, ObjectId as ObjectIdType, Timestamp as TimestampType, Binary as BinaryType, TopologyDescription, TopologyType, ServerType, AutoEncryptionOptions, ServerApi, ServerApiVersion, MongoClient, } from 'mongodb';
+export type { AggregateOptions, AggregationCursor, AnyBulkWriteOperation, AnyClientBulkWriteModel, Batch, BulkWriteOptions, BulkWriteResult, ClientBulkWriteResult, ClientBulkWriteOptions, ChangeStream, ChangeStreamOptions, ClientSession, CollationOptions, Collection, CommandOperationOptions, CountDocumentsOptions, CountOptions, CreateCollectionOptions, CreateIndexesOptions, ClientSessionOptions, ClusterTime, FindCursor, CursorFlag, RunCommandCursor, Db, DbOptions, DeleteOptions, DeleteResult, DistinctOptions, Document, DropCollectionOptions, DropDatabaseOptions, EstimatedDocumentCountOptions, ExplainOptions, ExplainVerbosityLike, FindOneAndDeleteOptions, FindOneAndUpdateOptions, FindOneAndReplaceOptions, FindOperators, FindOptions, HedgeOptions, IndexDescription, InsertManyResult, InsertOneOptions, InsertOneResult, ListCollectionsOptions, ListDatabasesOptions, ListIndexesOptions, MongoClientOptions, OrderedBulkOperation, ReadConcern, ReadConcernLike, ReadConcernLevel, ReadPreference, ReadPreferenceLike, ReadPreferenceFromOptions, ReadPreferenceMode, RenameOptions, ReplaceOptions, ResumeToken, RunCommandOptions, SearchIndexDescription, ServerSessionId, TagSet, TransactionOptions, UpdateOptions, UpdateResult, UnorderedBulkOperation, WriteConcern, ObjectId as ObjectIdType, Timestamp as TimestampType, Binary as BinaryType, TopologyType, ServerType, AutoEncryptionOptions, ServerApi, ServerApiVersion, MongoClient, } from 'mongodb';

package/lib/cursors.d.ts

@@ -1,5 +1,5 @@
 import type { CollationOptions, CountOptions, CursorFlag, Document, ExplainVerbosityLike, ReadConcernLike, ReadPreferenceLike, ResumeToken } from './all-transport-types';
-interface ServiceProviderBaseCursor<TSchema = Document> {
+export interface ServiceProviderBaseCursor<TSchema = Document> {
     close(): Promise<void>;
     hasNext(): Promise<boolean>;
     next(): Promise<TSchema | null>;
@@ -45,4 +45,3 @@ export interface ServiceProviderChangeStream<TSchema = Document> extends Service
     next(): Promise<TSchema>;
     readonly resumeToken: ResumeToken;
 }
-export {};

package/lib/index.d.ts

@@ -3,12 +3,11 @@ import ServiceProvider, { ServiceProviderCore } from './service-provider';
 import getConnectExtraInfo, { ConnectionExtraInfo } from './connect-info';
 import type { ReplPlatform } from './platform';
 declare const DEFAULT_DB = "test";
-import { bsonStringifiers } from './printable-bson';
 import ShellAuthOptions from './shell-auth-options';
 export * from './all-transport-types';
 export * from './all-fle-types';
 export { MapReduceOptions, FinalizeFunction } from './map-reduce-options';
+export { TopologyDescription, ServerDescription } from './readable';
 export { CreateEncryptedCollectionOptions, CheckMetadataConsistencyOptions, ConnectionInfo, } from './admin';
-export { bson } from './bson-export';
-export { ServiceProviderAbstractCursor, ServiceProviderAggregationCursor, ServiceProviderFindCursor, ServiceProviderRunCommandCursor, ServiceProviderChangeStream, } from './cursors';
-export { ServiceProvider, ShellAuthOptions, getConnectExtraInfo, ReplPlatform, DEFAULT_DB, ServiceProviderCore, bsonStringifiers, ConnectionExtraInfo, };
+export { ServiceProviderAbstractCursor, ServiceProviderAggregationCursor, ServiceProviderBaseCursor, ServiceProviderFindCursor, ServiceProviderRunCommandCursor, ServiceProviderChangeStream, } from './cursors';
+export { ServiceProvider, ShellAuthOptions, getConnectExtraInfo, ReplPlatform, DEFAULT_DB, ServiceProviderCore, ConnectionExtraInfo, };

package/lib/index.js

@@ -17,7 +17,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.bsonStringifiers = exports.ServiceProviderCore = exports.DEFAULT_DB = exports.getConnectExtraInfo = exports.bson = void 0;
+exports.ServiceProviderCore = exports.DEFAULT_DB = exports.getConnectExtraInfo = void 0;
 require("./textencoder-polyfill");
 const service_provider_1 = require("./service-provider");
 Object.defineProperty(exports, "ServiceProviderCore", { enumerable: true, get: function () { return service_provider_1.ServiceProviderCore; } });
@@ -25,10 +25,6 @@ const connect_info_1 = __importDefault(require("./connect-info"));
 exports.getConnectExtraInfo = connect_info_1.default;
 const DEFAULT_DB = 'test';
 exports.DEFAULT_DB = DEFAULT_DB;
-const printable_bson_1 = require("./printable-bson");
-Object.defineProperty(exports, "bsonStringifiers", { enumerable: true, get: function () { return printable_bson_1.bsonStringifiers; } });
 __exportStar(require("./all-transport-types"), exports);
 __exportStar(require("./all-fle-types"), exports);
-var bson_export_1 = require("./bson-export");
-Object.defineProperty(exports, "bson", { enumerable: true, get: function () { return bson_export_1.bson; } });
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,kCAAgC;AAChC,yDAA0E;AAiCxE,oGAjCwB,sCAAmB,OAiCxB;AAhCrB,kEAA0E;AA6BxE,8BA7BK,sBAAmB,CA6BL;AA3BrB,MAAM,UAAU,GAAG,MAAM,CAAC;AA6BxB,gCAAU;AA5BZ,qDAAoD;AA8BlD,iGA9BO,iCAAgB,OA8BP;AA5BlB,wDAAsC;AACtC,kDAAgC;AAUhC,6CAAqC;AAA5B,mGAAA,IAAI,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,kCAAgC;AAChC,yDAA0E;AAiCxE,oGAjCwB,sCAAmB,OAiCxB;AAhCrB,kEAA0E;AA6BxE,8BA7BK,sBAAmB,CA6BL;AA3BrB,MAAM,UAAU,GAAG,MAAM,CAAC;AA6BxB,gCAAU;AA3BZ,wDAAsC;AACtC,kDAAgC"}

package/lib/readable.d.ts

@@ -1,6 +1,15 @@
-import type { Document, AggregateOptions, CountOptions, CountDocumentsOptions, DistinctOptions, EstimatedDocumentCountOptions, FindOptions, ListCollectionsOptions, ListIndexesOptions, DbOptions, ReadPreferenceFromOptions, ReadPreferenceLike } from './all-transport-types';
+import type { Document, AggregateOptions, CountOptions, CountDocumentsOptions, DistinctOptions, EstimatedDocumentCountOptions, FindOptions, ListCollectionsOptions, ListIndexesOptions, DbOptions, ReadPreferenceFromOptions, ReadPreferenceLike, TopologyType, ServerType } from './all-transport-types';
 import type { ChangeStreamOptions } from './all-transport-types';
 import type { ServiceProviderAggregationCursor, ServiceProviderChangeStream, ServiceProviderFindCursor } from './cursors';
+export interface ServerDescription {
+    type?: ServerType;
+    setName?: string | null;
+}
+export interface TopologyDescription {
+    type?: TopologyType;
+    setName?: string | null;
+    servers?: Map<string, ServerDescription>;
+}
 export default interface Readable {
     aggregate(database: string, collection: string, pipeline: Document[], options?: AggregateOptions, dbOptions?: DbOptions): ServiceProviderAggregationCursor;
     aggregateDb(database: string, pipeline: Document[], options?: AggregateOptions, dbOptions?: DbOptions): ServiceProviderAggregationCursor;
@@ -9,7 +18,7 @@ export default interface Readable {
     distinct(database: string, collection: string, fieldName: string, filter?: Document, options?: DistinctOptions, dbOptions?: DbOptions): Promise<Document>;
     estimatedDocumentCount(database: string, collection: string, options?: EstimatedDocumentCountOptions, dbOptions?: DbOptions): Promise<number>;
     find(database: string, collection: string, filter?: Document, options?: FindOptions, dbOptions?: DbOptions): ServiceProviderFindCursor;
-    getTopology(): any;
+    getTopologyDescription(): TopologyDescription | undefined;
     getIndexes(database: string, collection: string, options: ListIndexesOptions, dbOptions?: DbOptions): Promise<Document[]>;
     listCollections(database: string, filter?: Document, options?: ListCollectionsOptions, dbOptions?: DbOptions): Promise<Document[]>;
     readPreferenceFromOptions(options?: Omit<ReadPreferenceFromOptions, 'session'>): ReadPreferenceLike | undefined;

package/lib/service-provider.d.ts

@@ -2,10 +2,10 @@ import type Admin from './admin';
 import type Closable from './closable';
 import type Readable from './readable';
 import type Writable from './writable';
-import type { bson as BSON } from './index';
+import type { BSON } from '@mongosh/shell-bson';
 export default interface ServiceProvider extends Readable, Writable, Closable, Admin {
 }
 export declare class ServiceProviderCore {
-    bsonLibrary: typeof BSON;
-    constructor(bsonLibrary?: typeof BSON);
+    bsonLibrary: BSON;
+    constructor(bsonLibrary?: BSON);
 }

package/lib/service-provider.js

@@ -2,13 +2,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ServiceProviderCore = void 0;
 const errors_1 = require("@mongosh/errors");
-const printable_bson_1 = require("./printable-bson");
+const shell_bson_1 = require("@mongosh/shell-bson");
 class ServiceProviderCore {
     constructor(bsonLibrary) {
         if (bsonLibrary === undefined) {
             throw new errors_1.MongoshInternalError('BSON Library is undefined.');
         }
-        (0, printable_bson_1.makePrintableBson)(bsonLibrary);
+        (0, shell_bson_1.makePrintableBson)(bsonLibrary);
         this.bsonLibrary = bsonLibrary;
     }
 }

package/lib/service-provider.js.map

@@ -1 +1 @@
-{"version":3,"file":"service-provider.js","sourceRoot":"","sources":["../src/service-provider.ts"],"names":[],"mappings":";;;AAAA,4CAAuD;AAGvD,qDAAqD;AAcrD,MAAa,mBAAmB;IAE9B,YAAY,WAAyB;QACnC,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC9B,MAAM,IAAI,6BAAoB,CAAC,4BAA4B,CAAC,CAAC;QAC/D,CAAC;QACD,IAAA,kCAAiB,EAAC,WAAW,CAAC,CAAC;QAC/B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,CAAC;CACF;AATD,kDASC"}
+{"version":3,"file":"service-provider.js","sourceRoot":"","sources":["../src/service-provider.ts"],"names":[],"mappings":";;;AAAA,4CAAuD;AAKvD,oDAAwD;AAYxD,MAAa,mBAAmB;IAE9B,YAAY,WAAkB;QAC5B,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC9B,MAAM,IAAI,6BAAoB,CAAC,4BAA4B,CAAC,CAAC;QAC/D,CAAC;QACD,IAAA,8BAAiB,EAAC,WAAW,CAAC,CAAC;QAC/B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,CAAC;CACF;AATD,kDASC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mongosh/service-provider-core",
-  "version": "3.3.7",
+  "version": "3.6.0",
   "description": "MongoDB Shell Core Service Provider Package",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -37,10 +37,11 @@
   },
   "dependencies": {
     "@mongosh/errors": "2.4.4",
+    "@mongosh/shell-bson": "1.0.1",
     "bson": "^6.10.4",
-    "mongodb": "^6.18.0",
+    "mongodb": "^6.19.0",
     "mongodb-build-info": "^1.7.2",
-    "mongodb-connection-string-url": "^3.0.1"
+    "mongodb-connection-string-url": "^3.0.2"
   },
   "devDependencies": {
     "@mongodb-js/eslint-config-mongosh": "^1.0.0",
@@ -50,5 +51,5 @@
     "eslint": "^7.25.0",
     "prettier": "^2.8.8"
   },
-  "gitHead": "535ab3f767e2a27c05a6be6a299e0285eebfcc9e"
+  "gitHead": "9f0183e375c5422a0e1ced87c9a620384180abf7"
 }

package/src/admin.ts

@@ -13,7 +13,7 @@ import type {
   AutoEncryptionOptions,
   Collection,
 } from './all-transport-types';
-import type { bson as BSON, ConnectionExtraInfo } from './index';
+import type { ConnectionExtraInfo } from './index';
 import type { ReplPlatform } from './platform';
 import type {
   AWSEncryptionKeyOptions,
@@ -24,6 +24,7 @@ import type {
   ClientEncryption,
   ClientEncryptionOptions,
 } from './all-fle-types';
+import type { BSON } from '@mongosh/shell-bson';
 
 export interface CreateEncryptedCollectionOptions {
   provider: ClientEncryptionDataKeyProvider;
@@ -63,7 +64,7 @@ export default interface Admin {
   /**
    * The BSON package
    */
-  bsonLibrary: typeof BSON;
+  bsonLibrary: BSON;
 
   /**
    * list databases.

package/src/all-transport-types.ts

@@ -71,7 +71,6 @@ export type {
   ObjectId as ObjectIdType,
   Timestamp as TimestampType,
   Binary as BinaryType,
-  TopologyDescription,
   TopologyType,
   ServerType,
   AutoEncryptionOptions,

package/src/cursors.ts

@@ -9,7 +9,7 @@ import type {
   ResumeToken,
 } from './all-transport-types';
 
-interface ServiceProviderBaseCursor<TSchema = Document> {
+export interface ServiceProviderBaseCursor<TSchema = Document> {
   close(): Promise<void>;
   hasNext(): Promise<boolean>;
   next(): Promise<TSchema | null>;

package/src/index.ts

@@ -3,24 +3,24 @@ import ServiceProvider, { ServiceProviderCore } from './service-provider';
 import getConnectExtraInfo, { ConnectionExtraInfo } from './connect-info';
 import type { ReplPlatform } from './platform';
 const DEFAULT_DB = 'test';
-import { bsonStringifiers } from './printable-bson';
 import ShellAuthOptions from './shell-auth-options';
 export * from './all-transport-types';
 export * from './all-fle-types';
 
 export { MapReduceOptions, FinalizeFunction } from './map-reduce-options';
 
+export { TopologyDescription, ServerDescription } from './readable';
+
 export {
   CreateEncryptedCollectionOptions,
   CheckMetadataConsistencyOptions,
   ConnectionInfo,
 } from './admin';
 
-export { bson } from './bson-export';
-
 export {
   ServiceProviderAbstractCursor,
   ServiceProviderAggregationCursor,
+  ServiceProviderBaseCursor,
   ServiceProviderFindCursor,
   ServiceProviderRunCommandCursor,
   ServiceProviderChangeStream,
@@ -33,6 +33,5 @@ export {
   ReplPlatform,
   DEFAULT_DB,
   ServiceProviderCore,
-  bsonStringifiers,
   ConnectionExtraInfo,
 };

package/src/readable.ts

@@ -11,6 +11,8 @@ import type {
   DbOptions,
   ReadPreferenceFromOptions,
   ReadPreferenceLike,
+  TopologyType,
+  ServerType,
 } from './all-transport-types';
 import type { ChangeStreamOptions } from './all-transport-types';
 import type {
@@ -19,6 +21,17 @@ import type {
   ServiceProviderFindCursor,
 } from './cursors';
 
+// These are trimmed-down versions of the MongoDB driver types
+export interface ServerDescription {
+  type?: ServerType;
+  setName?: string | null;
+}
+export interface TopologyDescription {
+  type?: TopologyType;
+  setName?: string | null;
+  servers?: Map<string, ServerDescription>;
+}
+
 /**
  * Interface for read operations in the CRUD specification.
  */
@@ -160,7 +173,7 @@ export default interface Readable {
   /**
    * Get currently known topology information.
    */
-  getTopology(): any;
+  getTopologyDescription(): TopologyDescription | undefined;
 
   /**
    * Returns an array that holds a list of documents that identify and

package/src/service-provider.ts

@@ -1,10 +1,10 @@
 import { MongoshInternalError } from '@mongosh/errors';
 import type Admin from './admin';
 import type Closable from './closable';
-import { makePrintableBson } from './printable-bson';
 import type Readable from './readable';
 import type Writable from './writable';
-import type { bson as BSON } from './index';
+import { makePrintableBson } from '@mongosh/shell-bson';
+import type { BSON } from '@mongosh/shell-bson';
 
 /**
  * Interface for all service providers.
@@ -16,8 +16,8 @@ export default interface ServiceProvider
     Admin {}
 
 export class ServiceProviderCore {
-  public bsonLibrary: typeof BSON;
-  constructor(bsonLibrary?: typeof BSON) {
+  public bsonLibrary: BSON;
+  constructor(bsonLibrary?: BSON) {
     if (bsonLibrary === undefined) {
       throw new MongoshInternalError('BSON Library is undefined.');
     }

package/lib/bson-export.d.ts

@@ -1,23 +0,0 @@
-import { ObjectId, DBRef, MaxKey, MinKey, Timestamp, BSONSymbol, Code, Decimal128, Int32, Long, Binary, calculateObjectSize, Double, BSONRegExp } from 'bson';
-export declare const bson: {
-    ObjectId: typeof ObjectId;
-    DBRef: typeof DBRef;
-    MaxKey: typeof MaxKey;
-    MinKey: typeof MinKey;
-    Timestamp: typeof Timestamp;
-    BSONSymbol: typeof BSONSymbol;
-    Code: typeof Code;
-    Decimal128: typeof Decimal128;
-    Int32: typeof Int32;
-    Long: typeof Long;
-    Binary: typeof Binary;
-    calculateObjectSize: typeof calculateObjectSize;
-    Double: typeof Double;
-    EJSON: {
-        parse: (text: string, options?: import("bson").EJSONOptions) => any;
-        stringify: (value: any, replacer?: (number | string)[] | ((this: any, key: string, value: any) => any) | import("bson").EJSONOptions, space?: string | number, options?: import("bson").EJSONOptions) => string;
-        serialize: (value: any, options?: import("bson").EJSONOptions) => import("bson").Document;
-        deserialize: (ejson: import("bson").Document, options?: import("bson").EJSONOptions) => any;
-    };
-    BSONRegExp: typeof BSONRegExp;
-};

package/lib/bson-export.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.bson = void 0;
-const bson_1 = require("bson");
-exports.bson = {
-    ObjectId: bson_1.ObjectId,
-    DBRef: bson_1.DBRef,
-    MaxKey: bson_1.MaxKey,
-    MinKey: bson_1.MinKey,
-    Timestamp: bson_1.Timestamp,
-    BSONSymbol: bson_1.BSONSymbol,
-    Code: bson_1.Code,
-    Decimal128: bson_1.Decimal128,
-    Int32: bson_1.Int32,
-    Long: bson_1.Long,
-    Binary: bson_1.Binary,
-    calculateObjectSize: bson_1.calculateObjectSize,
-    Double: bson_1.Double,
-    EJSON: bson_1.EJSON,
-    BSONRegExp: bson_1.BSONRegExp,
-};
-//# sourceMappingURL=bson-export.js.map

package/lib/bson-export.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"bson-export.js","sourceRoot":"","sources":["../src/bson-export.ts"],"names":[],"mappings":";;;AAAA,+BAgBc;AAED,QAAA,IAAI,GAAG;IAClB,QAAQ,EAAR,eAAQ;IACR,KAAK,EAAL,YAAK;IACL,MAAM,EAAN,aAAM;IACN,MAAM,EAAN,aAAM;IACN,SAAS,EAAT,gBAAS;IACT,UAAU,EAAV,iBAAU;IACV,IAAI,EAAJ,WAAI;IACJ,UAAU,EAAV,iBAAU;IACV,KAAK,EAAL,YAAK;IACL,IAAI,EAAJ,WAAI;IACJ,MAAM,EAAN,aAAM;IACN,mBAAmB,EAAnB,0BAAmB;IACnB,MAAM,EAAN,aAAM;IACN,KAAK,EAAL,YAAK;IACL,UAAU,EAAV,iBAAU;CACX,CAAC"}

package/lib/printable-bson.d.ts

@@ -1,6 +0,0 @@
-import { bson as BSON } from './bson-export';
-import type { CustomInspectFunction } from 'util';
-type BSONClassKey = (typeof BSON)[Exclude<keyof typeof BSON, 'EJSON' | 'calculateObjectSize'>]['prototype']['_bsontype'];
-export declare const bsonStringifiers: Record<BSONClassKey | 'ObjectID', CustomInspectFunction>;
-export declare function makePrintableBson(bson?: typeof BSON): void;
-export {};

package/lib/printable-bson.js

@@ -1,95 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.bsonStringifiers = void 0;
-exports.makePrintableBson = makePrintableBson;
-const bson_export_1 = require("./bson-export");
-const util_1 = require("util");
-const inspectCustom = Symbol.for('nodejs.util.inspect.custom');
-function removeNewFromInspectResult(str) {
-    return str.replace(/^(\s*)(new )/, '$1');
-}
-function removeTypedArrayPrefixFromInspectResult(str) {
-    return str.replace(/^\s*\S+\s*\(\d+\)\s*/, '');
-}
-function makeClasslessInspect(className) {
-    const originalInspect = bson_export_1.bson[className].prototype.inspect;
-    return function (...args) {
-        return removeNewFromInspectResult(originalInspect.apply(this, args));
-    };
-}
-const binaryInspect = makeClasslessInspect('Binary');
-const binaryVectorInspect = function (depth, options) {
-    switch (this.buffer[0]) {
-        case bson_export_1.bson.Binary.VECTOR_TYPE.Int8:
-            return `Binary.fromInt8Array(new Int8Array(${removeTypedArrayPrefixFromInspectResult((0, util_1.inspect)(this.toInt8Array(), {
-                depth,
-                ...options,
-                maxArrayLength: util_1.inspect.defaultOptions.maxArrayLength,
-            }))}))`;
-        case bson_export_1.bson.Binary.VECTOR_TYPE.Float32:
-            return `Binary.fromFloat32Array(new Float32Array(${removeTypedArrayPrefixFromInspectResult((0, util_1.inspect)(this.toFloat32Array(), {
-                depth,
-                ...options,
-                maxArrayLength: util_1.inspect.defaultOptions.maxArrayLength,
-            }))}))`;
-        case bson_export_1.bson.Binary.VECTOR_TYPE.PackedBit: {
-            const paddingInfo = this.buffer[1] === 0 ? '' : `, ${this.buffer[1]}`;
-            return `Binary.fromPackedBits(new Uint8Array(${removeTypedArrayPrefixFromInspectResult((0, util_1.inspect)(this.toPackedBits(), {
-                depth,
-                ...options,
-                maxArrayLength: util_1.inspect.defaultOptions.maxArrayLength,
-            }))})${paddingInfo})`;
-        }
-        default:
-            return binaryInspect.call(this, depth, options);
-    }
-};
-exports.bsonStringifiers = {
-    ObjectId: makeClasslessInspect('ObjectId'),
-    ObjectID: makeClasslessInspect('ObjectId'),
-    DBRef: makeClasslessInspect('DBRef'),
-    MaxKey: makeClasslessInspect('MaxKey'),
-    MinKey: makeClasslessInspect('MinKey'),
-    Timestamp: makeClasslessInspect('Timestamp'),
-    BSONSymbol: makeClasslessInspect('BSONSymbol'),
-    Code: makeClasslessInspect('Code'),
-    Decimal128: makeClasslessInspect('Decimal128'),
-    Int32: makeClasslessInspect('Int32'),
-    Long: makeClasslessInspect('Long'),
-    Double: makeClasslessInspect('Double'),
-    BSONRegExp: makeClasslessInspect('BSONRegExp'),
-    Binary: function (...args) {
-        const hexString = this.toString('hex');
-        switch (this.sub_type) {
-            case bson_export_1.bson.Binary.SUBTYPE_VECTOR:
-                return binaryVectorInspect.apply(this, args);
-            case bson_export_1.bson.Binary.SUBTYPE_MD5:
-                return `MD5('${hexString}')`;
-            case bson_export_1.bson.Binary.SUBTYPE_UUID:
-                if (hexString.length === 32) {
-                    const asUUID = /^(.{8})(.{4})(.{4})(.{4})(.{12})$/
-                        .exec(hexString)
-                        .slice(1, 6)
-                        .join('-');
-                    return `UUID('${asUUID}')`;
-                }
-            default:
-                return binaryInspect.apply(this, args);
-        }
-    },
-};
-function makePrintableBson(bson) {
-    if (!bson) {
-        bson = bson_export_1.bson;
-    }
-    for (const [key, stringifier] of Object.entries(exports.bsonStringifiers)) {
-        if (!(key in bson)) {
-            continue;
-        }
-        const cls = bson[key];
-        for (const key of [inspectCustom, 'inspect']) {
-            cls.prototype[key] = stringifier;
-        }
-    }
-}
-//# sourceMappingURL=printable-bson.js.map

package/lib/printable-bson.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"printable-bson.js","sourceRoot":"","sources":["../src/printable-bson.ts"],"names":[],"mappings":";;;AAgIA,8CAcC;AA9ID,+CAA6C;AAE7C,+BAA8C;AAC9C,MAAM,aAAa,GAAG,MAAM,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;AAO/D,SAAS,0BAA0B,CAAC,GAAW;IAC7C,OAAO,GAAG,CAAC,OAAO,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;AAC3C,CAAC;AAID,SAAS,uCAAuC,CAAC,GAAW;IAC1D,OAAO,GAAG,CAAC,OAAO,CAAC,sBAAsB,EAAE,EAAE,CAAC,CAAC;AACjD,CAAC;AAKD,SAAS,oBAAoB,CAC3B,SAAY;IAEZ,MAAM,eAAe,GAAG,kBAAI,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC;IAC1D,OAAO,UAEL,GAAG,IAAwC;QAE3C,OAAO,0BAA0B,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;IACvE,CAAiC,CAAC;AACpC,CAAC;AAED,MAAM,aAAa,GAAG,oBAAoB,CAAC,QAAQ,CAAC,CAAC;AAErD,MAAM,mBAAmB,GAAG,UAE1B,KAAa,EACb,OAA+B;IAE/B,QAAQ,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;QACvB,KAAK,kBAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI;YAC/B,OAAO,sCAAsC,uCAAuC,CAClF,IAAA,cAAW,EAAC,IAAI,CAAC,WAAW,EAAE,EAAE;gBAC9B,KAAK;gBACL,GAAG,OAAO;gBAEV,cAAc,EAAE,cAAW,CAAC,cAAc,CAAC,cAAc;aAC1D,CAAC,CACH,IAAI,CAAC;QACR,KAAK,kBAAI,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO;YAClC,OAAO,4CAA4C,uCAAuC,CACxF,IAAA,cAAW,EAAC,IAAI,CAAC,cAAc,EAAE,EAAE;gBACjC,KAAK;gBACL,GAAG,OAAO;gBAEV,cAAc,EAAE,cAAW,CAAC,cAAc,CAAC,cAAc;aAC1D,CAAC,CACH,IAAI,CAAC;QACR,KAAK,kBAAI,CAAC,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC;YACvC,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;YACtE,OAAO,wCAAwC,uCAAuC,CACpF,IAAA,cAAW,EAAC,IAAI,CAAC,YAAY,EAAE,EAAE;gBAC/B,KAAK;gBACL,GAAG,OAAO;gBAEV,cAAc,EAAE,cAAW,CAAC,cAAc,CAAC,cAAc;aAC1D,CAAC,CACH,IAAI,WAAW,GAAG,CAAC;QACtB,CAAC;QACD;YACE,OAAO,aAAa,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;AACH,CAAiC,CAAC;AAErB,QAAA,gBAAgB,GAGzB;IACF,QAAQ,EAAE,oBAAoB,CAAC,UAAU,CAAC;IAC1C,QAAQ,EAAE,oBAAoB,CAAC,UAAU,CAAC;IAC1C,KAAK,EAAE,oBAAoB,CAAC,OAAO,CAAC;IACpC,MAAM,EAAE,oBAAoB,CAAC,QAAQ,CAAC;IACtC,MAAM,EAAE,oBAAoB,CAAC,QAAQ,CAAC;IACtC,SAAS,EAAE,oBAAoB,CAAC,WAAW,CAAC;IAC5C,UAAU,EAAE,oBAAoB,CAAC,YAAY,CAAC;IAC9C,IAAI,EAAE,oBAAoB,CAAC,MAAM,CAAC;IAClC,UAAU,EAAE,oBAAoB,CAAC,YAAY,CAAC;IAC9C,KAAK,EAAE,oBAAoB,CAAC,OAAO,CAAC;IACpC,IAAI,EAAE,oBAAoB,CAAC,MAAM,CAAC;IAClC,MAAM,EAAE,oBAAoB,CAAC,QAAQ,CAAC;IACtC,UAAU,EAAE,oBAAoB,CAAC,YAAY,CAAC;IAC9C,MAAM,EAAE,UAEN,GAAG,IAAuC;QAE1C,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAEvC,QAAQ,IAAI,CAAC,QAAQ,EAAE,CAAC;YACtB,KAAK,kBAAI,CAAC,MAAM,CAAC,cAAc;gBAC7B,OAAO,mBAAmB,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAC/C,KAAK,kBAAI,CAAC,MAAM,CAAC,WAAW;gBAC1B,OAAO,QAAQ,SAAS,IAAI,CAAC;YAC/B,KAAK,kBAAI,CAAC,MAAM,CAAC,YAAY;gBAC3B,IAAI,SAAS,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;oBAG5B,MAAM,MAAM,GAAG,mCAAmC;yBAC/C,IAAI,CAAC,SAAS,CAAE;yBAChB,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;yBACX,IAAI,CAAC,GAAG,CAAC,CAAC;oBACb,OAAO,SAAS,MAAM,IAAI,CAAC;gBAC7B,CAAC;YAGH;gBACE,OAAO,aAAa,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC3C,CAAC;IACH,CAAiC;CAClC,CAAC;AAOF,SAAgB,iBAAiB,CAAC,IAAkB;IAClD,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,IAAI,GAAG,kBAAI,CAAC;IACd,CAAC;IAED,KAAK,MAAM,CAAC,GAAG,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,wBAAgB,CAAC,EAAE,CAAC;QAClE,IAAI,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC,EAAE,CAAC;YACnB,SAAS;QACX,CAAC;QACD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAwB,CAAC,CAAC;QAC3C,KAAK,MAAM,GAAG,IAAI,CAAC,aAAa,EAAE,SAAS,CAAC,EAAE,CAAC;YAC5C,GAAW,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC;QAC5C,CAAC;IACH,CAAC;AACH,CAAC"}

package/src/bson-export.ts

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

package/src/printable-bson.spec.ts

@@ -1,137 +0,0 @@
-import { expect } from 'chai';
-import { bson } from './index';
-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)");
-  });
-});

package/src/printable-bson.ts

@@ -1,143 +0,0 @@
-import { bson as BSON } from './bson-export';
-import type { InspectOptionsStylized, CustomInspectFunction } from 'util';
-import { inspect as utilInspect } from 'util';
-const inspectCustom = Symbol.for('nodejs.util.inspect.custom');
-type BSONClassKey = (typeof BSON)[Exclude<
-  keyof typeof BSON,
-  'EJSON' | 'calculateObjectSize'
->]['prototype']['_bsontype'];
-
-// Turn e.g. 'new Double(...)' into 'Double(...)' but preserve possible leading whitespace
-function removeNewFromInspectResult(str: string): string {
-  return str.replace(/^(\s*)(new )/, '$1');
-}
-
-/** Typed array such as Int8Array have a format like 'Int8Array(3) [1, 2, 3]'
- *  and we want to remove the prefix and keep just the array contents. */
-function removeTypedArrayPrefixFromInspectResult(str: string): string {
-  return str.replace(/^\s*\S+\s*\(\d+\)\s*/, '');
-}
-
-// Create a Node.js-util-inspect() style custom inspect function that
-// strips 'new ' from inspect results but otherwise uses the Node.js
-// driver's bson library's inspect functions.
-function makeClasslessInspect<K extends BSONClassKey>(
-  className: K
-): CustomInspectFunction {
-  const originalInspect = BSON[className].prototype.inspect;
-  return function (
-    this: (typeof BSON)[typeof className]['prototype'],
-    ...args: Parameters<typeof originalInspect>
-  ) {
-    return removeNewFromInspectResult(originalInspect.apply(this, args));
-  } satisfies CustomInspectFunction;
-}
-
-const binaryInspect = makeClasslessInspect('Binary');
-
-const binaryVectorInspect = function (
-  this: typeof BSON.Binary.prototype,
-  depth: number,
-  options: InspectOptionsStylized
-): string {
-  switch (this.buffer[0]) {
-    case BSON.Binary.VECTOR_TYPE.Int8:
-      return `Binary.fromInt8Array(new Int8Array(${removeTypedArrayPrefixFromInspectResult(
-        utilInspect(this.toInt8Array(), {
-          depth,
-          ...options,
-          // These arrays can be very large, so would prefer to use the default options instead.
-          maxArrayLength: utilInspect.defaultOptions.maxArrayLength,
-        })
-      )}))`;
-    case BSON.Binary.VECTOR_TYPE.Float32:
-      return `Binary.fromFloat32Array(new Float32Array(${removeTypedArrayPrefixFromInspectResult(
-        utilInspect(this.toFloat32Array(), {
-          depth,
-          ...options,
-          // These arrays can be very large, so would prefer to use the default options instead.
-          maxArrayLength: utilInspect.defaultOptions.maxArrayLength,
-        })
-      )}))`;
-    case BSON.Binary.VECTOR_TYPE.PackedBit: {
-      const paddingInfo = this.buffer[1] === 0 ? '' : `, ${this.buffer[1]}`;
-      return `Binary.fromPackedBits(new Uint8Array(${removeTypedArrayPrefixFromInspectResult(
-        utilInspect(this.toPackedBits(), {
-          depth,
-          ...options,
-          // These arrays can be very large, so would prefer to use the default options instead.
-          maxArrayLength: utilInspect.defaultOptions.maxArrayLength,
-        })
-      )})${paddingInfo})`;
-    }
-    default:
-      return binaryInspect.call(this, depth, options);
-  }
-} satisfies CustomInspectFunction;
-
-export const bsonStringifiers: Record<
-  BSONClassKey | 'ObjectID',
-  CustomInspectFunction
-> = {
-  ObjectId: makeClasslessInspect('ObjectId'),
-  ObjectID: makeClasslessInspect('ObjectId'),
-  DBRef: makeClasslessInspect('DBRef'),
-  MaxKey: makeClasslessInspect('MaxKey'),
-  MinKey: makeClasslessInspect('MinKey'),
-  Timestamp: makeClasslessInspect('Timestamp'),
-  BSONSymbol: makeClasslessInspect('BSONSymbol'),
-  Code: makeClasslessInspect('Code'),
-  Decimal128: makeClasslessInspect('Decimal128'),
-  Int32: makeClasslessInspect('Int32'),
-  Long: makeClasslessInspect('Long'),
-  Double: makeClasslessInspect('Double'),
-  BSONRegExp: makeClasslessInspect('BSONRegExp'),
-  Binary: function (
-    this: typeof BSON.Binary.prototype,
-    ...args: Parameters<CustomInspectFunction>
-  ): string {
-    const hexString = this.toString('hex');
-
-    switch (this.sub_type) {
-      case BSON.Binary.SUBTYPE_VECTOR:
-        return binaryVectorInspect.apply(this, args);
-      case BSON.Binary.SUBTYPE_MD5:
-        return `MD5('${hexString}')`;
-      case BSON.Binary.SUBTYPE_UUID:
-        if (hexString.length === 32) {
-          // Format '0123456789abcdef0123456789abcdef' into
-          // '01234567-89ab-cdef-0123-456789abcdef'.
-          const asUUID = /^(.{8})(.{4})(.{4})(.{4})(.{12})$/
-            .exec(hexString)!
-            .slice(1, 6)
-            .join('-');
-          return `UUID('${asUUID}')`;
-        }
-      // In case somebody did something weird and used an UUID with a
-      // non-standard length, fall through.
-      default:
-        return binaryInspect.apply(this, args);
-    }
-  } satisfies CustomInspectFunction,
-};
-
-/**
- * This method modifies the BSON class passed in as argument. This is required so that
- * we can have the driver return our BSON classes without having to write our own serializer.
- * @param {Object} bson
- */
-export function makePrintableBson(bson?: typeof BSON): void {
-  if (!bson) {
-    bson = BSON;
-  }
-
-  for (const [key, stringifier] of Object.entries(bsonStringifiers)) {
-    if (!(key in bson)) {
-      continue;
-    }
-    const cls = bson[key as keyof typeof BSON];
-    for (const key of [inspectCustom, 'inspect']) {
-      (cls as any).prototype[key] = stringifier;
-    }
-  }
-}