@vsaas/loopback-connector-mongodb 10.0.0

package/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) IBM Corp. 2012,2017. All Rights Reserved.
+Node module: loopback-connector-mongodb
+This project is licensed under the MIT License, full text below.
+
+--------
+
+MIT license
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,182 @@
+# @vsaas/loopback-connector-mongodb
+
+Maintained MongoDB connector fork for LoopBack 3.
+
+This fork stays focused on practical LB3 compatibility while simplifying the codebase:
+
+- runtime moved to TypeScript
+- modern build and test tooling (`tsdown`, `vitest`, `oxlint`)
+- English-only messages
+- legacy repo assets removed (`intl`, docs site, benchmarks, examples, old CI files)
+- MongoDB driver kept on the `5.x` line to remain compatible with MongoDB Server `4.2`
+
+## Install
+
+```bash
+npm install @vsaas/loopback-connector-mongodb
+```
+
+## Why `mongodb@5.x`
+
+This fork intentionally stays on `mongodb@5.9.2`.
+
+That keeps the connector on a conservative driver line that still works with MongoDB Server `4.2`, while avoiding the larger behavior and runtime changes introduced by newer major driver lines.
+
+## LoopBack 3 datasource example
+
+```json
+{
+  "db": {
+    "name": "db",
+    "connector": "@vsaas/loopback-connector-mongodb",
+    "host": "127.0.0.1",
+    "port": 27017,
+    "database": "app",
+    "user": "app",
+    "password": "secret",
+    "authSource": "admin"
+  }
+}
+```
+
+You can also use a full connection string:
+
+```json
+{
+  "db": {
+    "name": "db",
+    "connector": "@vsaas/loopback-connector-mongodb",
+    "url": "mongodb://app:secret@127.0.0.1:27017/app?authSource=admin"
+  }
+}
+```
+
+## Supported connector settings
+
+- `allowExtendedOperators`
+- `authSource`
+- `collation`
+- `database`
+- `disableDefaultSort`
+- `enableGeoIndexing`
+- `host`
+- `lazyConnect`
+- `password`
+- `port`
+- `protocol`
+- `strictObjectIDCoercion`
+- `url`
+- `user`
+
+The connector also forwards common MongoDB driver options such as:
+
+- `connectTimeoutMS`
+- `serverSelectionTimeoutMS`
+- `socketTimeoutMS`
+- `readPreference`
+- `replicaSet`
+- `retryWrites`
+- `writeConcern`
+
+## Notes
+
+- `enableGeoIndexing: true` is required for indexed `near` queries on `GeoPoint`.
+- Default ids use MongoDB `ObjectId`.
+- Custom collection names are supported via model settings:
+
+```js
+{
+  mongodb: {
+    collection: 'CustomCollection';
+  }
+}
+```
+
+- Custom field names are supported for non-id properties:
+
+```js
+{
+  title: {
+    type: String,
+    mongodb: { fieldName: 'custom_title' }
+  }
+}
+```
+
+LoopBack still must keep the primary key stored as `_id`; custom field names for the id property are not supported.
+
+## ObjectId handling
+
+You can enforce ObjectId coercion in two common ways.
+
+Per model:
+
+```js
+{
+  options: {
+    strictObjectIDCoercion: true;
+  }
+}
+```
+
+Per property:
+
+```js
+{
+  id: {
+    type: 'String',
+    id: true,
+    mongodb: { dataType: 'ObjectId' }
+  }
+}
+```
+
+## Update operators
+
+Set `allowExtendedOperators: true` in the datasource to allow MongoDB update operators like:
+
+- `$set`
+- `$unset`
+- `$inc`
+- `$max`
+- `$min`
+- `$mul`
+- `$rename`
+- `$push`
+- `$pull`
+
+Example:
+
+```js
+Product.updateAll({ category: 'furniture' }, { $max: { price: 100 } }, cb);
+```
+
+## Security
+
+The connector removes `$where` and `mapReduce` from filters by default before sending them to MongoDB.
+
+If you really need them for trusted internal code, pass:
+
+```js
+{
+  disableSanitization: true;
+}
+```
+
+## Development
+
+Local test defaults:
+
+```bash
+npm test
+npm run lint
+npm run typecheck
+```
+
+Test connection settings come from:
+
+- `MONGODB_HOST`
+- `MONGODB_PORT`
+- `MONGODB_DATABASE`
+
+If they are not set, the suite uses `localhost:27017`.