@xylabs/mongo 4.13.15 → 4.13.16

package/README.md

@@ -1,63 +1,54 @@
-[![logo][]](https://xylabs.com)
-
 # @xylabs/mongo
 
+[![logo][]](https://xylabs.com)
+
+[![main-build][]][main-build-link]
 [![npm-badge][]][npm-link]
 [![npm-downloads-badge][]][npm-link]
 [![jsdelivr-badge][]][jsdelivr-link]
 [![npm-license-badge][]](LICENSE)
+[![codacy-badge][]][codacy-link]
+[![codeclimate-badge][]][codeclimate-link]
+[![snyk-badge][]][snyk-link]
 [![socket-badge][]][socket-link]
 
-> XY Labs Logger Helpers
-
-## Table of Contents
-
--   [Description](#description)
--   [Install](#install)
--   [Maintainers](#maintainers)
--   [License](#license)
--   [Credits](#credits)
-
-## Description
+Version: 4.13.15
 
-Various Mongo helper functions
+Base functionality used throughout XYO TypeScript/JavaScript libraries that access Mongo DB
 
-## Install
-
-Using npm:
-
-```sh
-npm i --save @xylabs/mongo
-```
+## Documentation
 
-Using yarn:
+Coming Soon!
 
-```sh
-yarn add @xylabs/mongo
-```
-
-## Documentation
-[Developer Reference](https://xylabs.github.io/sdk-js)
+Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
 
 ## Maintainers
 
 -   [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
--   [Joel Carter](https://github.com/JoelBCarter)
 -   [Matt Jones](https://github.com/jonesmac)
+-   [Joel Carter](https://github.com/JoelBCarter)
 -   [Jordan Trouw](https://github.com/jordantrouw)
 
 ## License
 
-See the [LICENSE](LICENSE) file for license details
+> See the [LICENSE](LICENSE) file for license details
 
 ## Credits
 
-[Made with 🔥and ❄️ by XY Labs](https://xylabs.com)
+[Made with 🔥 and ❄️ by XYLabs](https://xylabs.com)
 
 [logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
 
+[main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
+[main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
 [npm-badge]: https://img.shields.io/npm/v/@xylabs/mongo.svg
 [npm-link]: https://www.npmjs.com/package/@xylabs/mongo
+[codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
+[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade
+[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
+[codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability
+[snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
+[snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json
 
 [npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/mongo
 [npm-license-badge]: https://img.shields.io/npm/l/@xylabs/mongo

package/dist/browser/index.d.ts

@@ -1,46 +1,4 @@
-import * as mongodb from 'mongodb';
-import { Document, Filter, DeleteResult, FindCursor, WithId, OptionalUnlessRequiredId, BulkWriteOptions, InsertOneOptions, ReplaceOptions, UpdateFilter, Collection, MongoClient } from 'mongodb';
-
-interface BaseMongoSdkPublicConfig {
-    closeDelay?: number;
-    collection: string;
-    maxPoolSize?: number;
-}
-interface BaseMongoSdkPrivateConfig {
-    dbConnectionString?: string;
-    dbDomain?: string;
-    dbName?: string;
-    dbPassword?: string;
-    dbUserName?: string;
-}
-type BaseMongoSdkConfig = BaseMongoSdkPublicConfig & BaseMongoSdkPrivateConfig;
-
-declare class BaseMongoSdk<T extends Document> {
-    config: BaseMongoSdkConfig;
-    constructor(config: BaseMongoSdkConfig);
-    get uri(): string;
-    deleteMany(filter: Filter<T>): Promise<DeleteResult>;
-    deleteOne(filter: Filter<T>): Promise<DeleteResult>;
-    find(filter: Filter<T>): Promise<FindCursor<WithId<T>>>;
-    findOne(filter: Filter<T>): Promise<WithId<T> | null>;
-    insertMany(items: OptionalUnlessRequiredId<T>[], options?: BulkWriteOptions): Promise<mongodb.InsertManyResult<T>>;
-    insertOne(item: OptionalUnlessRequiredId<T>, options?: InsertOneOptions): Promise<mongodb.InsertOneResult<T>>;
-    replaceOne(filter: Filter<T>, item: OptionalUnlessRequiredId<T>, options?: ReplaceOptions): Promise<mongodb.UpdateResult<T>>;
-    updateOne(filter: Filter<T>, fields: UpdateFilter<T>): Promise<mongodb.UpdateResult<T>>;
-    upsertOne(filter: Filter<T>, fields: UpdateFilter<T>): Promise<mongodb.UpdateResult<T>>;
-    useCollection<R>(func: (collection: Collection<T>) => Promise<R> | R): Promise<R>;
-    useMongo<R>(func: (client: MongoClient) => Promise<R> | R): Promise<R>;
-}
-
-declare class MongoClientWrapper {
-    static readonly clients: Map<string, MongoClientWrapper>;
-    private client;
-    constructor(uri: string, maxPoolSize?: number, closeDelay?: number);
-    static get(uri: string, poolSize?: number, closeDelay?: number): MongoClientWrapper;
-    connect(): Promise<MongoClient>;
-    disconnect(): Promise<number>;
-    initiateClose(): Promise<void>;
-}
-
-export { BaseMongoSdk, MongoClientWrapper };
-export type { BaseMongoSdkConfig, BaseMongoSdkPrivateConfig, BaseMongoSdkPublicConfig };
+export * from './Base.js';
+export * from './Config.js';
+export * from './Wrapper.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/browser/spec/Base.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Base.spec.d.ts.map

package/dist/browser/spec/Base.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Base.spec.d.ts","sourceRoot":"","sources":["../../../src/spec/Base.spec.ts"],"names":[],"mappings":""}

package/dist/browser/spec/Wrapper.spec.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Starts a heap profiler session.
+ * @param type 'sampling' or 'snapshot'
+ * @param outPath Output directory (default: './heap-profiles')
+ */
+export declare function startHeapProfile(type?: 'sampling' | 'snapshot', outPath?: string): Promise<void>;
+/**
+ * Stops the heap profiler and writes the output to file.
+ * @param fileName Optional output filename
+ * @param outPath Output directory (default: './heap-profiles')
+ * @returns Full path to the heap profile file
+ */
+export declare function stopHeapProfile(fileName?: string, outPath?: string): Promise<string>;
+//# sourceMappingURL=Wrapper.spec.d.ts.map

package/dist/browser/spec/Wrapper.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Wrapper.spec.d.ts","sourceRoot":"","sources":["../../../src/spec/Wrapper.spec.ts"],"names":[],"mappings":"AAqBA;;;;GAIG;AACH,wBAAsB,gBAAgB,CACpC,IAAI,GAAE,UAAU,GAAG,UAAuB,EAC1C,OAAO,GAAE,MAA0B,GAClC,OAAO,CAAC,IAAI,CAAC,CAcf;AAED;;;;;GAKG;AACH,wBAAsB,eAAe,CACnC,QAAQ,CAAC,EAAE,MAAM,EACjB,OAAO,GAAE,MAA0B,GAClC,OAAO,CAAC,MAAM,CAAC,CAmBjB"}

package/dist/neutral/index.d.ts

@@ -1,46 +1,4 @@
-import * as mongodb from 'mongodb';
-import { Document, Filter, DeleteResult, FindCursor, WithId, OptionalUnlessRequiredId, BulkWriteOptions, InsertOneOptions, ReplaceOptions, UpdateFilter, Collection, MongoClient } from 'mongodb';
-
-interface BaseMongoSdkPublicConfig {
-    closeDelay?: number;
-    collection: string;
-    maxPoolSize?: number;
-}
-interface BaseMongoSdkPrivateConfig {
-    dbConnectionString?: string;
-    dbDomain?: string;
-    dbName?: string;
-    dbPassword?: string;
-    dbUserName?: string;
-}
-type BaseMongoSdkConfig = BaseMongoSdkPublicConfig & BaseMongoSdkPrivateConfig;
-
-declare class BaseMongoSdk<T extends Document> {
-    config: BaseMongoSdkConfig;
-    constructor(config: BaseMongoSdkConfig);
-    get uri(): string;
-    deleteMany(filter: Filter<T>): Promise<DeleteResult>;
-    deleteOne(filter: Filter<T>): Promise<DeleteResult>;
-    find(filter: Filter<T>): Promise<FindCursor<WithId<T>>>;
-    findOne(filter: Filter<T>): Promise<WithId<T> | null>;
-    insertMany(items: OptionalUnlessRequiredId<T>[], options?: BulkWriteOptions): Promise<mongodb.InsertManyResult<T>>;
-    insertOne(item: OptionalUnlessRequiredId<T>, options?: InsertOneOptions): Promise<mongodb.InsertOneResult<T>>;
-    replaceOne(filter: Filter<T>, item: OptionalUnlessRequiredId<T>, options?: ReplaceOptions): Promise<mongodb.UpdateResult<T>>;
-    updateOne(filter: Filter<T>, fields: UpdateFilter<T>): Promise<mongodb.UpdateResult<T>>;
-    upsertOne(filter: Filter<T>, fields: UpdateFilter<T>): Promise<mongodb.UpdateResult<T>>;
-    useCollection<R>(func: (collection: Collection<T>) => Promise<R> | R): Promise<R>;
-    useMongo<R>(func: (client: MongoClient) => Promise<R> | R): Promise<R>;
-}
-
-declare class MongoClientWrapper {
-    static readonly clients: Map<string, MongoClientWrapper>;
-    private client;
-    constructor(uri: string, maxPoolSize?: number, closeDelay?: number);
-    static get(uri: string, poolSize?: number, closeDelay?: number): MongoClientWrapper;
-    connect(): Promise<MongoClient>;
-    disconnect(): Promise<number>;
-    initiateClose(): Promise<void>;
-}
-
-export { BaseMongoSdk, MongoClientWrapper };
-export type { BaseMongoSdkConfig, BaseMongoSdkPrivateConfig, BaseMongoSdkPublicConfig };
+export * from './Base.js';
+export * from './Config.js';
+export * from './Wrapper.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/neutral/spec/Base.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Base.spec.d.ts.map

package/dist/neutral/spec/Base.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Base.spec.d.ts","sourceRoot":"","sources":["../../../src/spec/Base.spec.ts"],"names":[],"mappings":""}

package/dist/neutral/spec/Wrapper.spec.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Starts a heap profiler session.
+ * @param type 'sampling' or 'snapshot'
+ * @param outPath Output directory (default: './heap-profiles')
+ */
+export declare function startHeapProfile(type?: 'sampling' | 'snapshot', outPath?: string): Promise<void>;
+/**
+ * Stops the heap profiler and writes the output to file.
+ * @param fileName Optional output filename
+ * @param outPath Output directory (default: './heap-profiles')
+ * @returns Full path to the heap profile file
+ */
+export declare function stopHeapProfile(fileName?: string, outPath?: string): Promise<string>;
+//# sourceMappingURL=Wrapper.spec.d.ts.map

package/dist/neutral/spec/Wrapper.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Wrapper.spec.d.ts","sourceRoot":"","sources":["../../../src/spec/Wrapper.spec.ts"],"names":[],"mappings":"AAqBA;;;;GAIG;AACH,wBAAsB,gBAAgB,CACpC,IAAI,GAAE,UAAU,GAAG,UAAuB,EAC1C,OAAO,GAAE,MAA0B,GAClC,OAAO,CAAC,IAAI,CAAC,CAcf;AAED;;;;;GAKG;AACH,wBAAsB,eAAe,CACnC,QAAQ,CAAC,EAAE,MAAM,EACjB,OAAO,GAAE,MAA0B,GAClC,OAAO,CAAC,MAAM,CAAC,CAmBjB"}

package/dist/node/index.d.ts

@@ -1,46 +1,4 @@
-import * as mongodb from 'mongodb';
-import { Document, Filter, DeleteResult, FindCursor, WithId, OptionalUnlessRequiredId, BulkWriteOptions, InsertOneOptions, ReplaceOptions, UpdateFilter, Collection, MongoClient } from 'mongodb';
-
-interface BaseMongoSdkPublicConfig {
-    closeDelay?: number;
-    collection: string;
-    maxPoolSize?: number;
-}
-interface BaseMongoSdkPrivateConfig {
-    dbConnectionString?: string;
-    dbDomain?: string;
-    dbName?: string;
-    dbPassword?: string;
-    dbUserName?: string;
-}
-type BaseMongoSdkConfig = BaseMongoSdkPublicConfig & BaseMongoSdkPrivateConfig;
-
-declare class BaseMongoSdk<T extends Document> {
-    config: BaseMongoSdkConfig;
-    constructor(config: BaseMongoSdkConfig);
-    get uri(): string;
-    deleteMany(filter: Filter<T>): Promise<DeleteResult>;
-    deleteOne(filter: Filter<T>): Promise<DeleteResult>;
-    find(filter: Filter<T>): Promise<FindCursor<WithId<T>>>;
-    findOne(filter: Filter<T>): Promise<WithId<T> | null>;
-    insertMany(items: OptionalUnlessRequiredId<T>[], options?: BulkWriteOptions): Promise<mongodb.InsertManyResult<T>>;
-    insertOne(item: OptionalUnlessRequiredId<T>, options?: InsertOneOptions): Promise<mongodb.InsertOneResult<T>>;
-    replaceOne(filter: Filter<T>, item: OptionalUnlessRequiredId<T>, options?: ReplaceOptions): Promise<mongodb.UpdateResult<T>>;
-    updateOne(filter: Filter<T>, fields: UpdateFilter<T>): Promise<mongodb.UpdateResult<T>>;
-    upsertOne(filter: Filter<T>, fields: UpdateFilter<T>): Promise<mongodb.UpdateResult<T>>;
-    useCollection<R>(func: (collection: Collection<T>) => Promise<R> | R): Promise<R>;
-    useMongo<R>(func: (client: MongoClient) => Promise<R> | R): Promise<R>;
-}
-
-declare class MongoClientWrapper {
-    static readonly clients: Map<string, MongoClientWrapper>;
-    private client;
-    constructor(uri: string, maxPoolSize?: number, closeDelay?: number);
-    static get(uri: string, poolSize?: number, closeDelay?: number): MongoClientWrapper;
-    connect(): Promise<MongoClient>;
-    disconnect(): Promise<number>;
-    initiateClose(): Promise<void>;
-}
-
-export { BaseMongoSdk, MongoClientWrapper };
-export type { BaseMongoSdkConfig, BaseMongoSdkPrivateConfig, BaseMongoSdkPublicConfig };
+export * from './Base.js';
+export * from './Config.js';
+export * from './Wrapper.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/node/spec/Base.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Base.spec.d.ts.map

package/dist/node/spec/Base.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Base.spec.d.ts","sourceRoot":"","sources":["../../../src/spec/Base.spec.ts"],"names":[],"mappings":""}

package/dist/node/spec/Wrapper.spec.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Starts a heap profiler session.
+ * @param type 'sampling' or 'snapshot'
+ * @param outPath Output directory (default: './heap-profiles')
+ */
+export declare function startHeapProfile(type?: 'sampling' | 'snapshot', outPath?: string): Promise<void>;
+/**
+ * Stops the heap profiler and writes the output to file.
+ * @param fileName Optional output filename
+ * @param outPath Output directory (default: './heap-profiles')
+ * @returns Full path to the heap profile file
+ */
+export declare function stopHeapProfile(fileName?: string, outPath?: string): Promise<string>;
+//# sourceMappingURL=Wrapper.spec.d.ts.map

package/dist/node/spec/Wrapper.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Wrapper.spec.d.ts","sourceRoot":"","sources":["../../../src/spec/Wrapper.spec.ts"],"names":[],"mappings":"AAqBA;;;;GAIG;AACH,wBAAsB,gBAAgB,CACpC,IAAI,GAAE,UAAU,GAAG,UAAuB,EAC1C,OAAO,GAAE,MAA0B,GAClC,OAAO,CAAC,IAAI,CAAC,CAcf;AAED;;;;;GAKG;AACH,wBAAsB,eAAe,CACnC,QAAQ,CAAC,EAAE,MAAM,EACjB,OAAO,GAAE,MAA0B,GAClC,OAAO,CAAC,MAAM,CAAC,CAmBjB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/mongo",
-  "version": "4.13.15",
+  "version": "4.13.16",
   "description": "Base functionality used throughout XYO TypeScript/JavaScript libraries that access Mongo DB",
   "keywords": [
     "mongo",
@@ -40,12 +40,12 @@
   "module": "dist/node/index.mjs",
   "types": "dist/node/index.d.ts",
   "dependencies": {
-    "@xylabs/assert": "^4.13.15",
+    "@xylabs/assert": "^4.13.16",
     "mongodb": "~6.17.0"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.20",
-    "@xylabs/tsconfig": "^7.0.0-rc.20",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.27",
+    "@xylabs/tsconfig": "^7.0.0-rc.27",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },

package/build/browser/index.d.ts

@@ -1,4 +0,0 @@
-export * from './Base.js';
-export * from './Config.js';
-export * from './Wrapper.js';
-//# sourceMappingURL=index.d.ts.map

package/build/neutral/index.d.ts

@@ -1,4 +0,0 @@
-export * from './Base.js';
-export * from './Config.js';
-export * from './Wrapper.js';
-//# sourceMappingURL=index.d.ts.map

package/build/node/index.d.ts

@@ -1,4 +0,0 @@
-export * from './Base.js';
-export * from './Config.js';
-export * from './Wrapper.js';
-//# sourceMappingURL=index.d.ts.map