insite-db

library2.4.0jsnpmunverified

MongoDB adapter for inSite framework (v2.4.0) — provides connection management, collection lifecycle (create/ensure), Change Streams with listener API, JSON Schema validation, and index creation. Requires Node >=20 and mongodb driver v6+. Differentiators: integrates with inSite ecosystem, auto-replaces localhost with 127.0.0.1, supports masking sensitive fields in logs. Released under MIT.

database

npm install insite-db

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · INSITE-DB

insite-db

databasejavascriptv2.4.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

connect

✓ import { connect } from 'insite-db'

✗ const { connect } = require('insite-db')

ESM-only; does not export CommonJS wrapper.

Collections

✓ import { Collections } from 'insite-db'

✗ import Collections from 'insite-db'

Named export, not default.

newObjectIdString

✓ import { newObjectIdString } from 'insite-db'

✗ import newObjectIdString from 'insite-db'

Named export, not default.

Options type

✓ import type { Options } from 'insite-db'

✗ import { Options } from 'insite-db'

TypeScript project; prefer type import for types.

Connects to MongoDB, ensures a 'users' collection with schema and unique index on email.

import { connect } from 'insite-db'; const { client, db, collections } = await connect({ url: process.env.MONGO_URL ?? 'mongodb://127.0.0.1:27017', name: 'myapp' }); const users = await collections.ensure('users', { schema: { bsonType: 'object', required: ['email'], properties: { email: { bsonType: 'string' } } }, indexes: [[{ email: 1 }, { unique: true }]] }); console.log('Connected to DB:', db.databaseName); await client.close();

Debug

Known issues

gotchaConnect replaces 'localhost' with '127.0.0.1' in provided URL, which may cause IPv4 vs IPv6 issues.

fix

Use '127.0.0.1' directly in URL to avoid unexpected rewrites.

affects: >=2.0.0

breakingESM-only since v2; require() will throw Module not found error.

fix

Use ES module imports: import { connect } from 'insite-db'.

affects: >=2.0.0

deprecatedOption 'watch: false' returns plain Collection without Change Stream methods; watch is true by default.

fix

Set watch: true (or omit) for enhanced collection with change stream listeners.

affects: >=1.0.0

gotchaNODE_ENV=development logs all change stream events unless 'quiet: true' is set; may expose sensitive data if masking env vars not configured.

fix

Set LOGS_MASK_SENSITIVE, LOGS_MASK_PII, LOGS_MASK_SKIP environment variables to mask fields.

affects: >=1.0.0

Errors

Common errors & fixes

Error: Cannot find module 'insite-db'

Package not installed or node_modules path issue.

fix

Run: npm install insite-db

TypeError: connect is not a function

Using require() instead of import in ESM-only package.

fix

Change to: import { connect } from 'insite-db'

MongoParseError: option useUnifiedTopology is not supported

Older mongodb driver options passed incorrectly.

fix

Remove deprecated options; insite-db uses modern driver defaults.

Upgrade

Version history

2.4.0latest on npm

Audit

Dependencies

mongodbrequiredPeer dependency; provides MongoClient and driver types

Agent activity

9 hits · last 30 days

node

Amazon

Resources

githubhttps://github.com/nesvet/insite ↗

packageinsite-db ↗

homepagehttps://github.com/nesvet/insite#readme ↗