@xyo-network/module-abstract-mongodb 5.3.25 → 5.3.27

package/README.md

@@ -1,23 +1,482 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/module-abstract-mongodb
 
-[![logo][]](https://xyo.network)
+[![npm][npm-badge]][npm-link]
+[![license][license-badge]][license-link]
+
+> Primary SDK for using XYO Protocol 2.0
+
+## Install
+
+Using npm:
 
-Version: 5.0.2
+```sh
+npm install {{name}}
+```
 
-Primary SDK for using XYO Protocol 2.0
+Using yarn:
 
-## Documentation
+```sh
+yarn add {{name}}
+```
 
-[TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__module-abstract-mongodb)
+Using pnpm:
+
+```sh
+pnpm add {{name}}
+```
+
+Using bun:
+
+```sh
+bun add {{name}}
+```
 
-Part of [sdk-xyo-client-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)
 
 ## License
 
-> See the [LICENSE](LICENSE) file for license details
+See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
+
+## Reference
+
+### packages
+
+  ### modules
+
+    ### packages
+
+      ### module
+
+        ### packages
+
+          ### mongodb
+
+            ### packages
+
+              ### abstract
+
+                ### .temp-typedoc
+
+                  ### functions
+
+                    ### <a id="MongoDBModuleMixin"></a>MongoDBModuleMixin
+
+[**@xyo-network/module-abstract-mongodb**](#../README)
+
+***
+
+```ts
+function MongoDBModuleMixin<TParams, TModule>(ModuleBase): {
+(...args): MongoModuleBase<TParams>;
+  labels: MongoDBStorageClassLabels;
+  prototype: MongoModuleBase<any, any>;
+} & TModule;
+```
+
+## Type Parameters
+
+### TParams
+
+`TParams` *extends* `MongoDBModuleParams` = `MongoDBModuleParams`
+
+### TModule
+
+`TModule` *extends* `AnyAbstractModule`\<`TParams`\> = `AnyAbstractModule`\<`TParams`\>
+
+## Parameters
+
+### ModuleBase
+
+`TModule`
+
+## Returns
+
+\{
+(...`args`): `MongoModuleBase`\<`TParams`\>;
+  `labels`: `MongoDBStorageClassLabels`;
+  `prototype`: `MongoModuleBase`\<`any`, `any`\>;
+\} & `TModule`
+
+                    ### <a id="MongoDBModuleMixinV2"></a>MongoDBModuleMixinV2
+
+[**@xyo-network/module-abstract-mongodb**](#../README)
+
+***
+
+```ts
+function MongoDBModuleMixinV2<TParams, TModule>(ModuleBase): {
+(...args): MongoModuleBase<TParams>;
+  labels: MongoDBStorageClassLabels;
+  prototype: MongoModuleBase<any, any>;
+} & TModule;
+```
+
+## Type Parameters
+
+### TParams
+
+`TParams` *extends* `MongoDBModuleParamsV2`\<`AnyConfigSchema`\<`MongoDBModuleConfigV2`\>\> = `MongoDBModuleParamsV2`\<`AnyConfigSchema`\<`MongoDBModuleConfigV2`\>\>
+
+### TModule
+
+`TModule` *extends* `AnyAbstractModule`\<`TParams`\> = `AnyAbstractModule`\<`TParams`\>
+
+## Parameters
+
+### ModuleBase
+
+`TModule`
+
+## Returns
+
+\{
+(...`args`): `MongoModuleBase`\<`TParams`\>;
+  `labels`: `MongoDBStorageClassLabels`;
+  `prototype`: `MongoModuleBase`\<`any`, `any`\>;
+\} & `TModule`
+
+                    ### <a id="fromDbProperty"></a>fromDbProperty
+
+[**@xyo-network/module-abstract-mongodb**](#../README)
+
+***
+
+```ts
+function fromDbProperty(value): string;
+```
+
+## Parameters
+
+### value
+
+`string`
+
+## Returns
+
+`string`
+
+                    ### <a id="getBaseMongoSdk"></a>getBaseMongoSdk
+
+[**@xyo-network/module-abstract-mongodb**](#../README)
+
+***
+
+```ts
+function getBaseMongoSdk<T>(collection): BaseMongoSdk<T>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `Document`
+
+## Parameters
+
+### collection
+
+`string`
+
+## Returns
+
+`BaseMongoSdk`\<`T`\>
+
+                    ### <a id="getBaseMongoSdkPrivateConfig"></a>getBaseMongoSdkPrivateConfig
+
+[**@xyo-network/module-abstract-mongodb**](#../README)
+
+***
+
+```ts
+function getBaseMongoSdkPrivateConfig(): BaseMongoSdkPrivateConfig;
+```
+
+## Returns
+
+`BaseMongoSdkPrivateConfig`
+
+                    ### <a id="getMongoDBConfig"></a>getMongoDBConfig
+
+[**@xyo-network/module-abstract-mongodb**](#../README)
+
+***
+
+```ts
+function getMongoDBConfig(): MongoEnv;
+```
+
+## Returns
+
+[`MongoEnv`](#../type-aliases/MongoEnv)
+
+                    ### <a id="hasMongoDBConfig"></a>hasMongoDBConfig
+
+[**@xyo-network/module-abstract-mongodb**](#../README)
+
+***
+
+```ts
+function hasMongoDBConfig(): boolean;
+```
+
+## Returns
+
+`boolean`
+
+                    ### <a id="toDbProperty"></a>toDbProperty
+
+[**@xyo-network/module-abstract-mongodb**](#../README)
+
+***
+
+```ts
+function toDbProperty(value): string;
+```
+
+## Parameters
+
+### value
+
+`string`
+
+## Returns
+
+`string`
+
+                  ### type-aliases
+
+                    ### <a id="CollectionIndexFunction"></a>CollectionIndexFunction
+
+[**@xyo-network/module-abstract-mongodb**](#../README)
+
+***
+
+```ts
+type CollectionIndexFunction = (collectionName) => IndexDescription[];
+```
+
+## Parameters
+
+### collectionName
+
+`string`
+
+## Returns
+
+`IndexDescription`[]
+
+                    ### <a id="IndexDescription"></a>IndexDescription
+
+[**@xyo-network/module-abstract-mongodb**](#../README)
+
+***
+
+```ts
+type IndexDescription = object;
+```
+
+Description of index(es) to be created on a store
+
+## Properties
+
+### key
+
+```ts
+key: 
+  | {
+[key: string]: IndexDirection;
+}
+| Map<string, IndexDirection>;
+```
+
+The key(s) to index
+
+***
+
+### name?
+
+```ts
+optional name?: string;
+```
+
+The name of the index
+
+***
+
+### unique?
+
+```ts
+optional unique?: boolean;
+```
+
+If true, the index must enforce uniqueness on the key
+
+                    ### <a id="IndexDirection"></a>IndexDirection
+
+[**@xyo-network/module-abstract-mongodb**](#../README)
+
+***
+
+```ts
+type IndexDirection = -1 | 1;
+```
+
+The index direction (1 for ascending, -1 for descending)
+
+                    ### <a id="MongoDbConnectionStringEnvVar"></a>MongoDbConnectionStringEnvVar
+
+[**@xyo-network/module-abstract-mongodb**](#../README)
+
+***
+
+```ts
+type MongoDbConnectionStringEnvVar = "MONGO_CONNECTION_STRING";
+```
+
+                    ### <a id="MongoDbEnvVars"></a>MongoDbEnvVars
+
+[**@xyo-network/module-abstract-mongodb**](#../README)
+
+***
+
+```ts
+type MongoDbEnvVars = "MONGO_DATABASE" | "MONGO_DOMAIN" | "MONGO_PASSWORD" | "MONGO_USERNAME";
+```
+
+                    ### <a id="MongoEnv"></a>MongoEnv
+
+[**@xyo-network/module-abstract-mongodb**](#../README)
+
+***
+
+```ts
+type MongoEnv = Record<
+  | MongoDbEnvVars
+| MongoDbConnectionStringEnvVar, string | undefined>;
+```
+
+                  ### variables
+
+                    ### <a id="COLLECTIONS"></a>COLLECTIONS
+
+[**@xyo-network/module-abstract-mongodb**](#../README)
+
+***
+
+```ts
+const COLLECTIONS: object;
+```
+
+## Type Declaration
+
+### AddressInfo
+
+```ts
+AddressInfo: "address_info";
+```
+
+### ArchivistStats
+
+```ts
+ArchivistStats: "archivist_stats";
+```
+
+### BoundWitnesses
+
+```ts
+BoundWitnesses: "bound_witnesses";
+```
+
+### Payloads
+
+```ts
+Payloads: "payloads";
+```
+
+### Thumbnails
+
+```ts
+Thumbnails: "thumbnails";
+```
+
+### Users
+
+```ts
+Users: "users";
+```
+
+                    ### <a id="DATABASES"></a>DATABASES
+
+[**@xyo-network/module-abstract-mongodb**](#../README)
+
+***
+
+```ts
+const DATABASES: object;
+```
+
+## Type Declaration
+
+### Archivist
+
+```ts
+Archivist: "archivist";
+```
+
+                    ### <a id="DefaultAggregateTimeoutMs"></a>DefaultAggregateTimeoutMs
+
+[**@xyo-network/module-abstract-mongodb**](#../README)
+
+***
+
+```ts
+const DefaultAggregateTimeoutMs: 10000 = 10_000;
+```
+
+                    ### <a id="DefaultLimit"></a>DefaultLimit
+
+[**@xyo-network/module-abstract-mongodb**](#../README)
+
+***
+
+```ts
+const DefaultLimit: 20 = 20;
+```
+
+                    ### <a id="DefaultMaxTimeMS"></a>DefaultMaxTimeMS
+
+[**@xyo-network/module-abstract-mongodb**](#../README)
+
+***
+
+```ts
+const DefaultMaxTimeMS: 2000 = 2000;
+```
+
+                    ### <a id="DefaultOrder"></a>DefaultOrder
+
+[**@xyo-network/module-abstract-mongodb**](#../README)
+
+***
+
+```ts
+const DefaultOrder: "desc" = 'desc';
+```
+
+                    ### <a id="escapeChar"></a>escapeChar
+
+[**@xyo-network/module-abstract-mongodb**](#../README)
+
+***
 
-## Credits
+```ts
+const escapeChar: "#" = '#';
+```
 
-[Made with 🔥 and ❄️ by XYO](https://xyo.network)
 
-[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[npm-badge]: https://img.shields.io/npm/v/@xyo-network/module-abstract-mongodb.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/module-abstract-mongodb
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/module-abstract-mongodb.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/module-abstract-mongodb",
-  "version": "5.3.25",
+  "version": "5.3.27",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -21,7 +21,6 @@
   "type": "module",
   "exports": {
     ".": {
-      "browser": {},
       "node": {
         "types": "./dist/node/index.d.ts",
         "default": "./dist/node/index.mjs"
@@ -29,8 +28,6 @@
     },
     "./package.json": "./package.json"
   },
-  "module": "dist/node/index.mjs",
-  "types": "dist/node/index.d.ts",
   "files": [
     "dist",
     "!**/*.bench.*",
@@ -39,38 +36,30 @@
     "README.md"
   ],
   "dependencies": {
-    "@xyo-network/module-model": "~5.3.25",
-    "@xyo-network/module-model-mongodb": "~5.3.25",
-    "@xyo-network/payload-mongodb": "~5.3.25"
+    "@xyo-network/module-model": "~5.3.27",
+    "@xyo-network/module-model-mongodb": "~5.3.27",
+    "@xyo-network/payload-mongodb": "~5.3.27"
   },
   "devDependencies": {
     "@opentelemetry/api": "^1.9.1",
-    "@types/node": "^25.5.0",
-    "@xylabs/mongo": "^5.0.93",
-    "@xylabs/sdk-js": "^5.0.93",
-    "@xylabs/ts-scripts-common": "~7.6.16",
-    "@xylabs/ts-scripts-pnpm": "~7.6.16",
-    "@xylabs/tsconfig": "~7.6.16",
-    "acorn": "^8.16.0",
+    "@xylabs/mongo": "^5.0.94",
+    "@xylabs/sdk-js": "^5.0.94",
+    "@xylabs/ts-scripts-common": "~7.7.15",
+    "@xylabs/ts-scripts-pnpm": "~7.7.15",
+    "@xylabs/tsconfig": "~7.7.15",
     "axios": "^1.14.0",
-    "esbuild": "^0.28.0",
     "mongodb": "~7.1.1",
     "tslib": "~2.8.1",
     "typescript": "~5.9.3",
     "zod": "^4.3.6",
-    "@xyo-network/module-model": "~5.3.25",
-    "@xyo-network/module-model-mongodb": "~5.3.25",
-    "@xyo-network/payload-mongodb": "~5.3.25"
+    "@xyo-network/module-model": "~5.3.27",
+    "@xyo-network/module-model-mongodb": "~5.3.27",
+    "@xyo-network/payload-mongodb": "~5.3.27"
   },
   "peerDependencies": {
     "@xylabs/mongo": "^5",
     "@xylabs/sdk-js": "^5",
-    "mongodb": "^6 || ^7",
-    "tslib": "^2.8.1",
-    "zod": "^4"
-  },
-  "engines": {
-    "node": ">=16"
+    "mongodb": "^6 || ^7"
   },
   "publishConfig": {
     "access": "public"