cosa 7.1.3 → 9.0.0

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2023 Losant IoT, Inc.
+Copyright (c) 2024 Losant IoT, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,6 +1,6 @@
 # Cosa
 
-[![Build Status](https://travis-ci.com/Losant/cosa.svg?branch=master)](https://travis-ci.com/Losant/cosa) [![npm version](https://badge.fury.io/js/cosa.svg)](https://badge.fury.io/js/cosa)
+![Build Status](https://github.com/Losant/cosa/actions/workflows/test.yml/badge.svg?branch=master) [![npm version](https://badge.fury.io/js/cosa.svg)](https://badge.fury.io/js/cosa)
 
 Simplified object modeling for MongoDB
 
@@ -17,7 +17,7 @@ yarn add cosa
 First define a model:
 
 ```javascript
-const { Model } = require('cosa');
+import { Model } from 'cosa';
 
 const UserModel = Model.define({
   name: 'UserModel',

package/lib/array.js

@@ -1,5 +1,5 @@
-const clone = require('clone');
-const Immutable = require('./immutable');
+import clone from 'clone';
+import Immutable from './immutable.js';
 
 /**
  * Immutable handler used to wrap a javascript array.
@@ -9,7 +9,7 @@ const Immutable = require('./immutable');
  * @param {object} options - Optional settings
  * @returns {undefined} no return value
  */
-module.exports = function(data, builder, options) {
+export default function(data, builder, options) {
   builder.type = 'Array';
 
   builder.defineProperty('length', data.length);
@@ -73,4 +73,4 @@ module.exports = function(data, builder, options) {
     const newArr = clone(data);
     return Immutable.create(newArr.reverse(), options);
   });
-};
+}

package/lib/bson-objectId.js

@@ -1,12 +1,13 @@
 /**
- * Immutable handler used to wrap bson ObjectID.
- * @name ImmutableBSONObjectID
+ * Immutable handler used to wrap bson ObjectId.
+ * @name ImmutableBSONObjectId
  * @param {object} data - the object id
  * @param {object} builder - the immutable handler to wrapper the object id.
  * @returns {undefined} - this adds methods on to the builder.
  */
-module.exports = function(data, builder) {
-  builder.type = 'bson.ObjectID';
+
+export default function(data, builder) {
+  builder.type = 'bson.ObjectId';
 
   builder.defineMethod('toString', function() {
     return data.toString();
@@ -31,4 +32,4 @@ module.exports = function(data, builder) {
   builder.defineProperty('id', function() {
     return data.id;
   });
-};
+}

package/lib/cursor.js

@@ -1,4 +1,4 @@
-const { times } = require('omnibelt');
+import { times } from 'omnibelt';
 /**
  * Wrapper around MongoDB Cursor to convert results to Models.
  * @class
@@ -15,16 +15,11 @@ class Cursor {
    * Iterates over cursor and executes the iterator for each model returned.
    * @param {function} iterator - a function that will be called for each doc
    * @returns {Promise} - resolves when list is exhausted.
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/classes/findcursor.html#foreach}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/classes/FindCursor.html#forEach}
    */
   async forEach(iterator) {
-    return new Promise((resolve, reject) => {
-      this._cursor.forEach(
-        (doc) => { return iterator(this._factory(doc)); },
-        (err) => {
-          if (err) { return reject(err); }
-          return resolve();
-        });
+    return this._cursor.forEach((doc) => {
+      return iterator(this._factory(doc));
     });
   }
 
@@ -64,7 +59,7 @@ class Cursor {
    * @param {boolean} applySkipLimit - the number of docs to skip over in the count
    * @param {object} options - mongo cursor count options
    * @returns {number} the count of items in the list
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/classes/findcursor.html#count}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/classes/FindCursor.html#count}
    */
   count(applySkipLimit, options) {
     return this._cursor.count(applySkipLimit, options);
@@ -73,7 +68,7 @@ class Cursor {
   /**
    * Close the underlying MongoDB cursor.
    * @returns {boolean} `true` if cursor is successfully closed
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/classes/findcursor.html#close}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/classes/FindCursor.html#close-1}
    */
   close() {
     return this._cursor.close();
@@ -82,7 +77,7 @@ class Cursor {
   /**
    * Returns `true` if the cursor is closed.
    * @returns {boolean} `true` if the cursor is closed.
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/classes/findcursor.html#close}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/classes/FindCursor.html#closed}
    */
   isClosed() {
     return this._cursor.closed;
@@ -92,7 +87,7 @@ class Cursor {
    * Sets the cursor query filter.
    * @param {object} filter - The filter object used for the cursor.
    * @returns {Cursor} the cursor instance
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/classes/findcursor.html#filter}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/classes/FindCursor.html#filter}
    */
   filter(filter) {
     this._cursor.filter(filter);
@@ -103,7 +98,7 @@ class Cursor {
    * Sets the cursor limit.
    * @param {number} limit - A number to limit the cursor by.
    * @returns {Cursor} the cursor instance
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/classes/findcursor.html#limit}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/classes/FindCursor.html#limit}
    */
   limit(limit) {
     this._cursor.limit(limit);
@@ -114,7 +109,7 @@ class Cursor {
    * Maps cursor results using the provided function.
    * @param {function} transform - A function that will be called by each document in the cursor.
    * @returns {Cursor} the cursor instance
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/classes/findcursor.html#map}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/classes/FindCursor.html#map}
    */
   map(transform) {
     return this._cursor.map((doc) => {
@@ -126,7 +121,7 @@ class Cursor {
    * Sets the cursor max.
    * @param {number} max - Specify a $max value to specify the exclusive upper bound for a specific index in order to constrain the results of find().
    * @returns {Cursor} the cursor instance
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/classes/findcursor.html#max}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/classes/FindCursor.html#max}
    */
   max(max) {
     this._cursor.max(max);
@@ -137,7 +132,7 @@ class Cursor {
    * Sets the cursor min.
    * @param {number} min - Specify a $min value to specify the inclusive lower bound for a specific index in order to constrain the results of find().
    * @returns {Cursor} the cursor instance
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/classes/findcursor.html#min}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/classes/FindCursor.html#min}
    */
   min(min) {
     this._cursor.min(min);
@@ -147,7 +142,7 @@ class Cursor {
   /**
    * Get the next available document from the cursor.
    * @returns {Promise} - resolves with the next document from the cursor.
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/classes/findcursor.html#next}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/classes/FindCursor.html#next}
    */
   async next() {
     const doc = await this._cursor.next();
@@ -158,7 +153,7 @@ class Cursor {
    * Like `Cursor.forEach` but guarantees non-parallel execution of iterator.
    * @param {function} iterator - the function that will be called by each document serially.
    * @returns {Promise} - resolves when each item in the cursor has been passed to the iterator function
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/classes/findcursor.html#forEach}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/classes/FindCursor.html#forEach}
    */
   serialForEach(iterator) {
     const itemWrapper = async () => {
@@ -174,7 +169,7 @@ class Cursor {
    * Sets the cursor skip.
    * @param {number} value - The skip for the cursor query.
    * @returns {Cursor} the cursor instance
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/classes/findcursor.html#skip}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/classes/FindCursor.html#skip}
    */
   skip(value) {
     this._cursor.skip(value);
@@ -186,7 +181,7 @@ class Cursor {
    * @param {string|Array} sortOrList The key or keys set for the sort.
    * @param {number} direction - `1` or `-1` for ascending or descending
    * @returns {Cursor} the cursor instance
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/classes/findcursor.html#sort}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/classes/FindCursor.html#sort}
    */
   sort(sortOrList, direction) {
     this._cursor.sort(sortOrList, direction);
@@ -196,11 +191,11 @@ class Cursor {
   /**
    * Returns the cursor results as an array.
    * @returns {Promise} that resolves into an array from the cursor
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/classes/findcursor.html#toArray}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/classes/FindCursor.html#toArray}
    */
   async toArray() {
     return this._cursor.map((doc) => { return this._factory(doc); }).toArray();
   }
 }
 
-module.exports = Cursor;
+export default Cursor;

package/lib/date.js

@@ -1,4 +1,4 @@
-const Immutable = require('./immutable');
+import Immutable from './immutable.js';
 
 /**
  * Immutable handler used to wrap javascript Dates.
@@ -8,7 +8,7 @@ const Immutable = require('./immutable');
  * @param {object} options - Optional settings
  * @returns {undefined} no return value
  */
-module.exports = function(data, builder, options) {
+export default function(data, builder, options) {
   builder.type = 'Date';
 
   builder.defineMethod('mutate', function(cb) {
@@ -40,4 +40,4 @@ module.exports = function(data, builder, options) {
     });
   });
 
-};
+}

package/lib/db.js

@@ -1,11 +1,10 @@
-const debug = require('debug')('cosa:db');
-const { ObjectId } = require('bson');
-const { EventEmitter } = require('events');
-const { MongoClient } = require('mongodb');
-const {
+import _debug from 'debug';
+import { EventEmitter } from 'events';
+import { MongoClient, ObjectId } from 'mongodb';
+import {
   curry, split, last, pipe, clamp, isPlainObject, isNilOrEmpty
-} = require('omnibelt');
-const Immutable = require('./immutable');
+} from 'omnibelt';
+import Immutable from './immutable.js';
 const RESULT_FIELDS = [ 'insertedId', 'insertedCount', 'insertedIds', 'matchedCount', 'modifiedCount', 'upsertedCount', 'upsertedId', 'deletedCount', 'upsertedIds' ];
 const getDbName = (uri) => {
   let name = pipe(split('/'), last)(uri);
@@ -14,6 +13,7 @@ const getDbName = (uri) => {
   }
   return name;
 };
+const debug = _debug('cosa:db');
 
 const normalizeResult = (r) => {
   const result = {
@@ -141,7 +141,7 @@ class Database extends EventEmitter {
    * @param {string} name - Collection name.
    * @param {object} [options] - Optional collection settings.
    * @returns {Promise} resolves with the connection
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/classes/db.html#collection}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/classes/Db.html#collection}
    */
   async collection(name, options) {
     if (this._connectionStatus === 'connected') {
@@ -184,14 +184,14 @@ class Database extends EventEmitter {
    * @param {number} [options.maxTimeMS] - maximum amount of time (in ms) this cursor is allowed to live
    * @param {object} [options.session] - Mongo session or Cosa Mongo session wrapper
    * @returns {Cursor} returns Cursor object
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/classes/findcursor.html}
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#find}
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#findOne}
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#count}
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/interfaces/findoptions.html#readpreference}
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/interfaces/findoptions.html#batchsize}
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/interfaces/findoptions.html#nocursortimeout}
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/interfaces/findoptions.html#maxtimems}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/classes/Collection.html}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/classes/Collection.html#find}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/classes/Collection.html#findOne}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/classes/Collection.html#count}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/interfaces/FindOptions.html#readPreference}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/interfaces/FindOptions.html#batchSize}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/interfaces/FindOptions.html#noCursorTimeout}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/interfaces/FindOptions.html#maxTimeMS}
    */
   async find(collectionName, query, options = {}) {
     query = deserialize(query);
@@ -254,9 +254,9 @@ class Database extends EventEmitter {
    * @param {object} [options.writeConcern] - the write concern
    * @param {object} [options.session] - Mongo session or Cosa Mongo session wrapper
    * @returns {Promise} resolves with an object with results, and ops as keys
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#insertmany}
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#insertOne}
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/interfaces/insertoneoptions.html#writeconcern}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/classes/Collection.html#insertMany}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/classes/Collection.html#insertOne}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/interfaces/BulkWriteOptions.html#writeConcern}
    */
   async insert(collectionName, docs, { writeConcern, session } = {}) {
     docs = deserialize(docs);
@@ -265,7 +265,6 @@ class Database extends EventEmitter {
       writeConcern,
       session: session?.mongoSession || session
     });
-
     if (Array.isArray(docs)) {
       docs.forEach((doc, i) => {
         doc._id = results.insertedIds[`${i}`];
@@ -289,9 +288,9 @@ class Database extends EventEmitter {
    * @param {object} [options.writeConcern] - the write concern options
    * @param {object} [options.session] - Mongo session or Cosa Mongo session wrapper
    * @returns {Promise} resolves with an object with results, and ops as keys
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#updateMany}
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#updateOne}
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/interfaces/updateoptions.html#writeconcern}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/classes/Collection.html#updateMany}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/classes/Collection.html#updateOne}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/interfaces/BulkWriteOptions.html#writeConcern}
    */
   async update(collectionName, query, update, options = {}) {
     query = deserialize(query);
@@ -313,9 +312,9 @@ class Database extends EventEmitter {
    * @param {object} [options.writeConcern] - the write concern options
    * @param {object} [options.session] - Mongo session or Cosa Mongo session wrapper
    * @returns {Promise} resolves with an object with results, and ops as keys
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#deleteMany}
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#deleteOne}
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/interfaces/deleteoptions.html#writeconcern}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/classes/Collection.html#deleteMany}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/classes/Collection.html#deleteOne}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/interfaces/DeleteOptions.html#writeConcern}
    */
   async remove(collectionName, query, options = {}) {
     query = deserialize(query);
@@ -336,10 +335,10 @@ class Database extends EventEmitter {
    * @param {number} [options.maxTimeMS] - maximum amount of time (in ms) this cursor is allowed to live
    * @param {object} [options.session] - Mongo session or Cosa Mongo session wrapper
    * @returns {Promise} resolves with the result of the aggregation from mongo
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#aggregate}
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/interfaces/aggregateoptions.html#readpreference}
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/interfaces/aggregateoptions.html#batchsize}
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/interfaces/aggregateoptions.html#maxtimems}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/classes/Collection.html#aggregate}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/interfaces/AggregateOptions.html#readPreference}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/interfaces/AggregateOptions.html#batchSize}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/interfaces/AggregateOptions.html#maxTimeMS}
    */
   async aggregate(collectionName, pipeline, options = {}) {
     pipeline = deserialize(pipeline);
@@ -362,9 +361,9 @@ class Database extends EventEmitter {
    * @param {number} [options.maxTimeMS] - maximum amount of time (in ms) this cursor is allowed to live
    * @param {object} [options.session] - Mongo session or Cosa Mongo session wrapper
    * @returns {Promise} resolves with the result of the distinct query from mongo
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#distinct}
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/interfaces/commandoperationoptions.html#readpreference}
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/interfaces/commandoperationoptions.html#maxtimems}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/classes/Collection.html#distinct}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/interfaces/CommandOperationOptions.html#readPreference}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/interfaces/CommandOperationOptions.html#maxTimeMS}
    */
   async distinct(collectionName, key, query, options = {}) {
     query = deserialize(query);
@@ -385,8 +384,8 @@ class Database extends EventEmitter {
    * @param {object} [options.writeConcern] - the write concern options
    * @param {object} [options.session] - Mongo session or Cosa Mongo session wrapper
    * @returns {Promise} resolves with the result of the distinct query from mongo
-   * @see {@link http://mongodb.github.io/node-mongodb-native/3.0/api/Collection.html#replace}
-   * @see {@link https://mongodb.github.io/node-mongodb-native/4.0/interfaces/replaceoptions.html#writeconcern}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/classes/Collection.html#replaceOne}
+   * @see {@link https://mongodb.github.io/node-mongodb-native/6.3/interfaces/ReplaceOptions.html#writeConcern}
    */
   async replace(collectionName, query, replace, { writeConcern, session } = {}) {
     const collection = await this.collection(collectionName);
@@ -403,4 +402,4 @@ class Database extends EventEmitter {
 
 }
 
-module.exports = new Database();
+export default new Database();

package/lib/defined-object.js

@@ -1,4 +1,4 @@
-const Immutable = require('./immutable');
+import Immutable from './immutable.js';
 
 /**
  * Immutable handler used to create an immutable object based on definition
@@ -13,7 +13,7 @@ const Immutable = require('./immutable');
  * @param {object} [options.definition.methods] - Describes the methods of the immutable object.
  * @returns {undefined} no return value
  */
-module.exports = function(data, builder, options) {
+export default function(data, builder, options) {
 
   if (options.definition) {
     const definition = options.definition;
@@ -55,4 +55,4 @@ module.exports = function(data, builder, options) {
     }
   }
 
-};
+}

package/lib/errors.js

@@ -1,5 +1,5 @@
-const TypedError = require('error/typed');
-const WrappedError = require('error/wrapped');
+import TypedError from 'error/typed.js';
+import WrappedError from 'error/wrapped.js';
 
 // http response code reference:
 // 400 BAD REQUEST              401 UNAUTHORIZED                    402 PAYMENT REQUIRED
@@ -16,7 +16,7 @@ const WrappedError = require('error/wrapped');
  * Custom errors.
  * @namespace errors
  */
-module.exports = {
+export default {
 
   /**
    * Error used when an action results in a conflict between documents.

package/lib/immutable.js

@@ -1,4 +1,4 @@
-const clone = require('clone');
+import clone from 'clone';
 
 const IMMUTABLE_TYPES = [ 'function', 'string', 'boolean', 'number', 'undefined' ];
 
@@ -107,9 +107,9 @@ Immutable = {
         if (typeHandler.type === '*' || typeof data === typeHandler.type) {
           return typeHandler.handler(data, builder, options);
         }
-        if (typeHandler.type.toLowerCase() === 'array' && Array.isArray(data)) {
+        if (typeHandler.type === 'array' && Array.isArray(data)) {
           return typeHandler.handler(data, builder, options);
-        } else if (typeHandler.type.toLowerCase() === 'objectid' && data._bsontype === 'ObjectID') {
+        } else if (typeHandler.type === 'objectId' && data._bsontype === 'ObjectId') {
           return typeHandler.handler(data, builder, options);
         }
       } else if ('function' === typeof typeHandler.type && data instanceof typeHandler.type) {
@@ -125,4 +125,4 @@ Immutable = {
   }
 };
 
-module.exports = Immutable;
+export default Immutable;

package/lib/index.js

@@ -1,34 +1,29 @@
-const debug = require('debug')('cosa');
-const Model = require('./model');
-const Immutable = require('./immutable');
+import _debug from 'debug';
+import _db from './db.js';
+
+const debug = _debug('cosa');
 
 /**
  * Main module that provides access to library classes and functions.
  * @module cosa
  */
-module.exports = {
-
-  Model: Model,
-
-  Immutable: Immutable,
-
-  /**
-   * Database connection instance.
-   * @see {@link Database}
-   */
-  db: require('./db'),
-
-  /**
-   * Initialize cosa and connect to the database. Explicitly calling the
-   * function is not needed if `process.env.COSA_DB_URI` is properly set.
-   * @param {string} [uri] - URI to the database. If no URI is provided, the value
-   *    of `process.env.COSA_DB_URI` is used. See
-   *    https://docs.mongodb.com/manual/reference/connection-string/ for
-   *    information on the URI format.
-   * @returns {Promise} db.init promise
-   */
-  init: function(uri) {
-    debug('initializing cosa');
-    module.exports.db.init(uri || process.env.COSA_DB_URI);
-  }
+export { default as Model } from './model.js';
+export { default as Immutable } from './immutable.js';
+/**
+ * Database connection instance.
+ * @see {@link Database}
+ */
+export const db = _db;
+/**
+ * Initialize cosa and connect to the database. Explicitly calling the
+ * function is not needed if `process.env.COSA_DB_URI` is properly set.
+ * @param {string} [uri] - URI to the database. If no URI is provided, the value
+ *    of `process.env.COSA_DB_URI` is used. See
+ *    https://docs.mongodb.com/manual/reference/connection-string/ for
+ *    information on the URI format.
+ * @returns {Promise} db.init promise
+ */
+export const init = function(uri) {
+  debug('initializing cosa');
+  return db.init(uri || process.env.COSA_DB_URI);
 };

package/lib/model.js

@@ -1,27 +1,34 @@
-const joi = require('joi');
-const etag = require('etag');
-const debug = require('debug')('cosa:model');
-const objectPath = require('object-path');
-const clone = require('clone');
-const { EJSON } = require('bson');
-const Cursor = require('./cursor');
-const errors = require('./errors');
-const { ObjectId } = require('bson');
-const {
+import joi from 'joi';
+import etag from 'etag';
+import _debug from 'debug';
+const debug = _debug('cosa:model');
+import objectPath from 'object-path';
+import clone from 'clone';
+import { ObjectId, BSON } from 'mongodb';
+import Cursor from './cursor.js';
+import errors from './errors.js';
+import {
   pathEq, complement, pick, omit, has, isEmpty, isPlainObject
-} = require('omnibelt');
-const { buildPropertySchema } = require('./utils');
-const Immutable = require('./immutable');
-Immutable.use(require('./defined-object'));
-Immutable.use('array', require('./array'));
-Immutable.use(Date, require('./date'));
-Immutable.use('objectid', require('./bson-objectId'));
-Immutable.use(require('./object'));
+} from 'omnibelt';
+import { buildPropertySchema } from './utils.js';
+import Immutable from './immutable.js';
+import definedObject from './defined-object.js';
+import immutableArray from './array.js';
+import immutableDate from './date.js';
+import immutableBSONObjectId from './bson-objectId.js';
+import immutableObject from './object.js';
+
+const { EJSON } = BSON;
+Immutable.use(definedObject);
+Immutable.use('array', immutableArray);
+Immutable.use(Date, immutableDate);
+Immutable.use('objectId', immutableBSONObjectId);
+Immutable.use(immutableObject);
 
 const isNotVirtual = complement(pathEq('virtual', [ 'type' ]));
 const removeMeta = omit(['__modified', '__original']);
 
-const db = require('./db');
+import db from './db.js';
 // functions that are defined later on.
 let _serialize, _extend;
 
@@ -368,7 +375,6 @@ const _create = (data, definition) => {
     const result = await db.find(collection, query, options);
     return _create(result, definition);
   };
-
   return Immutable.create(data, { definition });
 };
 
@@ -397,7 +403,7 @@ const define = (definition) => {
   }
 
   definition.properties._id = {
-    type: 'objectid'
+    type: 'objectId'
   };
 
   definition.properties._etag = {
@@ -547,6 +553,6 @@ _extend = (definition, superDef) => {
   return define(newDef);
 };
 
-module.exports = {
+export default {
   define
 };

package/lib/object.js

@@ -1,4 +1,4 @@
-const Immutable = require('./immutable');
+import Immutable from './immutable.js';
 
 const addProp = function(name, builder, data) {
   if (builder.props[name]) { return; }
@@ -17,10 +17,10 @@ const addProp = function(name, builder, data) {
  * @param {object} builder - Builder instance
  * @returns {undefined} no return value
  */
-module.exports = function(data, builder) {
+export default function(data, builder) {
   for (const p in data) {
     if (Object.prototype.hasOwnProperty.call(data, p)) {
       addProp(p, builder, data);
     }
   }
-};
+}

package/lib/session.js

@@ -1,7 +1,7 @@
-const db = require('./db');
-const { forEachSerialP } = require('omnibelt');
+import db from './db.js';
+import { forEachSerialP } from 'omnibelt';
 
-const createSession = async () => {
+export const createSession = async () => {
   const afterCommits = [];
   const afterAborts = [];
   if (!db._client) {
@@ -48,7 +48,3 @@ const createSession = async () => {
     afterAborts
   };
 };
-
-module.exports = {
-  createSession
-};

package/lib/utils.js

@@ -1,8 +1,9 @@
-const joi = require('joi');
-const { ObjectId } = require('bson');
-const buildPropertySchema = (name, propertyDef) => { // eslint-disable-line complexity
+import joi from 'joi';
+import { ObjectId } from 'mongodb';
+
+export const buildPropertySchema = (name, propertyDef) => { // eslint-disable-line complexity
   let schema = null;
-  switch ((propertyDef.type || 'any').trim().toLowerCase()) {
+  switch ((propertyDef.type || 'any').trim()) {
     case 'array':
       schema = joi.array();
       if ('undefined' !== typeof propertyDef.items) {
@@ -65,7 +66,7 @@ const buildPropertySchema = (name, propertyDef) => { // eslint-disable-line comp
       if (propertyDef.uppercase) { schema = schema.uppercase(); }
       if (propertyDef.trim) { schema = schema.trim(); }
       break;
-    case 'objectid':
+    case 'objectId':
       schema = joi.object().instance(ObjectId);
       break;
     case 'any':
@@ -105,8 +106,3 @@ const buildPropertySchema = (name, propertyDef) => { // eslint-disable-line comp
   if ('undefined' !== typeof propertyDef.default) { schema = schema.default(propertyDef.default); }
   return schema;
 };
-
-module.exports = {
-  buildPropertySchema
-};
-

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "cosa",
-  "version": "7.1.3",
+  "version": "9.0.0",
   "description": "Cosa Models for MongoDB",
   "main": "lib/index.js",
+  "type": "module",
   "engines": {
-    "node": ">=14",
+    "node": ">=18",
     "yarn": ">=1.2.1"
   },
   "scripts": {
@@ -15,8 +16,7 @@
     "reinstall": "rm -rf node_modules && yarn install",
     "test": "NODE_ENV='test' COSA_DB_URI='mongodb://localhost:27017/test' mocha",
     "test-debug": "yarn test --debug-brk",
-    "doc": "documentation build lib/index.js -f md --github > API.md",
-    "prepare": "husky install"
+    "doc": "documentation build lib/index.js -f md --github > API.md"
   },
   "author": "Losant <hello@losant.com>",
   "license": "MIT",
@@ -35,29 +35,28 @@
     "lib"
   ],
   "dependencies": {
-    "bson": "~4.7.2",
     "clone": "^2.1.2",
-    "debug": "^4.3.4",
+    "debug": "^4.3.6",
     "error": "^7.0.2",
     "etag": "^1.8.1",
-    "joi": "^17.9.2",
-    "mongodb": "~4.17.1",
+    "joi": "^17.13.3",
+    "mongodb": "~6.8.0",
     "object-path": "^0.11.8",
-    "omnibelt": "^3.1.2"
+    "omnibelt": "^4.0.0"
   },
   "devDependencies": {
     "@losant/eslint-config-losant": "^1.6.1",
-    "husky": "^8.0.3",
-    "lint-staged": "~15.0.2",
-    "chai": "^4.3.10",
-    "chai-as-promised": "^7.1.1",
+    "husky": "^9.1.5",
+    "lint-staged": "~15.2.9",
+    "chai": "^5.1.1",
+    "chai-as-promised": "^8.0.0",
     "chai-datetime": "^1.8.0",
     "documentation": "^14.0.2",
-    "mocha": "^10.2.0",
+    "mocha": "^10.7.3",
     "string-template": "^1.0.0"
   },
   "eslintConfig": {
-    "extends": "@losant/eslint-config-losant/env/node"
+    "extends": "@losant/eslint-config-losant/env/esm"
   },
   "mocha": {
     "require": "chai",